async.h

Go to the documentation of this file.

#ifndef ZTH_ASYNC_H
#define ZTH_ASYNC_H
/*
 * SPDX-FileCopyrightText: 2019-2026 Jochem Rutgers
 *
 * SPDX-License-Identifier: MPL-2.0
 */
 
#include <libzth/macros.h>
 
#include <libzth/fiber.h>
 
#ifdef __cplusplus
 
#  include <libzth/allocator.h>
#  include <libzth/config.h>
#  include <libzth/exception.h>
#  include <libzth/sync.h>
#  include <libzth/util.h>
#  include <libzth/worker.h>
 
#  if __cplusplus >= 201103L
#    include <initializer_list>
#    include <tuple>
#    include <type_traits>
#  endif
 
#  if __cplusplus < 201103L
#    undef ZTH_TYPEDFIBER98
// Always use C++98-compatible TypedFiber implementation.
#    define ZTH_TYPEDFIBER98 1
#  elif !defined(ZTH_TYPEDFIBER98)
// By default only use C++11 TypedFiber implementation, but this can be
// overridden for testing purposes.
#    define ZTH_TYPEDFIBER98 0
#  endif
 
namespace zth {
 
 
 
// Typed fiber base class and manipulators
//
 
template <typename R>
class TypedFiber : public Fiber {
        ZTH_CLASS_NEW_DELETE(TypedFiber)
public:
        typedef R Return;
        typedef Future<Return> Future_type;
 
        constexpr TypedFiber()
                : Fiber(&entry, this)
        {}
 
        virtual ~TypedFiber() noexcept override is_default
 
        void registerFuture(Future_type* future)
        {
                m_future.reset(future);
                zth_dbg(sync, "[%s] Registered to %s", future->id_str(), id_str());
 
                if(state() == Fiber::Dead) {
                        // Fiber already dead, set the future now.
#  ifdef ZTH_FUTURE_EXCEPTION
                        setFuture(std::make_exception_ptr(fiber_already_dead()));
#  else
                        setFuture();
#  endif
                }
        }
 
        Future_type* future() const
        {
                return m_future;
        }
 
        SharedPointer<Future_type> const& withFuture()
        {
                if(!m_future.get()) {
                        registerFuture(
                                !Config::NamedSynchronizer
                                        ? new Future_type()
                                        : new Future_type(
                                                  format("Future of %s", this->name().c_str())
                                                          .c_str()));
                }
 
                return m_future;
        }
 
        operator SharedPointer<Future_type> const&()
        {
                return withFuture();
        }
 
        operator SharedReference<Future_type>()
        {
                return withFuture();
        }
 
protected:
        static void entry(void* that)
        {
                if(unlikely(!that))
                        return;
 
                TypedFiber& f = *static_cast<TypedFiber*>(that);
 
#  ifdef ZTH_FUTURE_EXCEPTION
                try {
#  endif // ZTH_FUTURE_EXCEPTION
                        f.entry_();
#  ifdef ZTH_FUTURE_EXCEPTION
                } catch(...) {
                        f.setFuture(std::current_exception());
                }
#  endif // ZTH_FUTURE_EXCEPTION
        }
 
        virtual void entry_() = 0;
 
        template <typename T>
        void setFuture(T const& r)
        {
                if(m_future.get())
                        m_future->set(r);
        }
 
        void setFuture()
        {
                if(m_future.get())
                        m_future->set();
        }
 
#  ifdef ZTH_FUTURE_EXCEPTION
        void setFuture(std::exception_ptr exception)
        {
                if(m_future.get())
                        m_future->set(std::move(exception));
        }
#  endif // ZTH_FUTURE_EXCEPTION
private:
        SharedPointer<Future_type> m_future;
};
 
struct FiberManipulator {};
 
struct setStackSize : public FiberManipulator {
        size_t stack;
 
        constexpr explicit setStackSize(size_t s) noexcept
                : stack(s)
        {}
};
 
template <typename R>
TypedFiber<R>& operator<<(TypedFiber<R>& fiber, setStackSize const& m)
{
        if(m.stack) {
                int res = fiber.setStackSize(m.stack);
                if(res)
                        zth_throw(errno_exception(res));
        }
 
        return fiber;
}
 
struct setName : public FiberManipulator {
#  if __cplusplus >= 201103L
        explicit setName(char const* n)
                : name(n ? std::string{n} : std::string{})
        {}
 
        explicit setName(string const& n)
                : name(n)
        {}
        explicit setName(string&& n)
                : name(std::move(n))
        {}
#  else  // Pre C++11
        explicit setName(char const* n)
                : name(n)
        {}
 
        explicit setName(string const& n)
                : name(n.c_str())
        {}
#  endif // Pre C++11
 
#  if __cplusplus >= 201103L
        string name;
#  else
        char const* name;
#  endif
};
 
template <typename R>
TypedFiber<R>& operator<<(TypedFiber<R>& fiber, setName const& m)
{
        fiber.setName(m.name);
        return fiber;
}
 
#  if __cplusplus >= 201103L
template <typename R>
TypedFiber<R>& operator<<(TypedFiber<R>& fiber, setName&& m)
{
        fiber.setName(std::move(m.name));
        return fiber;
}
#  endif // C++11
 
struct passOnExit : public FiberManipulator {
public:
        constexpr explicit passOnExit(Gate& g) noexcept
                : gate(g)
        {}
 
        static void atExit(Fiber& UNUSED_PAR(f), void* g) noexcept
        {
                static_cast<Gate*>(g)->pass();
        }
 
        Gate& gate;
};
 
static inline Fiber& operator<<(Fiber& fiber, passOnExit const& m)
{
        fiber.atExit(&passOnExit::atExit, static_cast<void*>(&m.gate));
        return fiber;
}
 
template <typename R>
TypedFiber<R>& operator<<(TypedFiber<R>& fiber, passOnExit const& m)
{
        static_cast<Fiber&>(fiber) << m;
        return fiber;
}
 
struct asFuture : public FiberManipulator {};
 
template <typename R>
SharedReference<typename TypedFiber<R>::Future_type>
operator<<(TypedFiber<R>& fiber, asFuture const&)
{
        return fiber.withFuture();
}
 
 
 
// Actual TypedFiber implementations
//
// The TypedFiberX classes hold the actual entry point and arguments for the fiber.  For Pre-C++11,
// up to 3 arguments are supported. For C++11 and later, arbitrary arguments are supported.
//
 
#  if ZTH_TYPEDFIBER98
template <typename R>
class TypedFiber0 final : public TypedFiber<R> {
        ZTH_CLASS_NEW_DELETE(TypedFiber0)
public:
        typedef TypedFiber<R> base;
        typedef R (*Function)();
 
        explicit TypedFiber0(Function function)
                : m_function(function)
        {}
 
        virtual ~TypedFiber0() final is_default
 
protected:
        virtual void entry_() final
        {
                this->setFuture(m_function());
        }
 
private:
        Function m_function;
};
 
template <>
class TypedFiber0<void> final : public TypedFiber<void> {
        ZTH_CLASS_NEW_DELETE(TypedFiber0)
public:
        typedef TypedFiber<void> base;
        typedef void (*Function)();
 
        explicit TypedFiber0(Function func)
                : m_function(func)
        {}
 
        virtual ~TypedFiber0() noexcept final is_default
 
protected:
        virtual void entry_() final
        {
                m_function();
                this->setFuture();
        }
 
private:
        Function m_function;
};
 
template <typename R, typename A1>
class TypedFiber1 final : public TypedFiber<R> {
        ZTH_CLASS_NEW_DELETE(TypedFiber1)
public:
        typedef TypedFiber<R> base;
        typedef R (*Function)(A1);
 
        TypedFiber1(Function func, A1 a1)
                : m_function(func)
                , m_a1(a1)
        {}
 
        virtual ~TypedFiber1() noexcept final is_default
 
protected:
        virtual void entry_() final
        {
                this->setFuture(m_function(m_a1));
        }
 
private:
        Function m_function;
        A1 m_a1;
};
 
template <typename A1>
class TypedFiber1<void, A1> final : public TypedFiber<void> {
        ZTH_CLASS_NEW_DELETE(TypedFiber1)
public:
        typedef TypedFiber<void> base;
        typedef void (*Function)(A1);
 
        // cppcheck-suppress uninitMemberVar
        TypedFiber1(Function func, A1 a1)
                : m_function(func)
                , m_a1(a1)
        {}
 
        virtual ~TypedFiber1() noexcept final is_default
 
protected:
        virtual void entry_() final
        {
                m_function(m_a1);
                this->setFuture();
        }
 
private:
        Function m_function;
        A1 m_a1;
};
 
template <typename R, typename A1, typename A2>
class TypedFiber2 final : public TypedFiber<R> {
        ZTH_CLASS_NEW_DELETE(TypedFiber2)
public:
        typedef TypedFiber<R> base;
        typedef R (*Function)(A1, A2);
 
        TypedFiber2(Function func, A1 a1, A2 a2)
                : m_function(func)
                , m_a1(a1)
                , m_a2(a2)
        {}
 
        virtual ~TypedFiber2() noexcept final is_default
 
protected:
        virtual void entry_() final
        {
                this->setFuture(m_function(m_a1, m_a2));
        }
 
private:
        Function m_function;
        A1 m_a1;
        A2 m_a2;
};
 
template <typename A1, typename A2>
class TypedFiber2<void, A1, A2> final : public TypedFiber<void> {
        ZTH_CLASS_NEW_DELETE(TypedFiber2)
public:
        typedef TypedFiber<void> base;
        typedef void (*Function)(A1, A2);
 
        // cppcheck-suppress uninitMemberVar
        TypedFiber2(Function func, A1 a1, A2 a2)
                : m_function(func)
                , m_a1(a1)
                , m_a2(a2)
        {}
 
        virtual ~TypedFiber2() noexcept final is_default
 
protected:
        virtual void entry_() final
        {
                m_function(m_a1, m_a2);
                this->setFuture();
        }
 
private:
        Function m_function;
        A1 m_a1;
        A2 m_a2;
};
 
template <typename R, typename A1, typename A2, typename A3>
class TypedFiber3 final : public TypedFiber<R> {
        ZTH_CLASS_NEW_DELETE(TypedFiber3)
public:
        typedef TypedFiber<R> base;
        typedef R (*Function)(A1, A2, A3);
 
        TypedFiber3(Function func, A1 a1, A2 a2, A3 a3)
                : m_function(func)
                , m_a1(a1)
                , m_a2(a2)
                , m_a3(a3)
        {}
 
        virtual ~TypedFiber3() noexcept final is_default
 
protected:
        virtual void entry_() final
        {
                this->setFuture(m_function(m_a1, m_a2, m_a3));
        }
 
private:
        Function m_function;
        A1 m_a1;
        A2 m_a2;
        A3 m_a3;
};
 
template <typename A1, typename A2, typename A3>
class TypedFiber3<void, A1, A2, A3> final : public TypedFiber<void> {
        ZTH_CLASS_NEW_DELETE(TypedFiber3)
public:
        typedef TypedFiber<void> base;
        typedef void (*Function)(A1, A2, A3);
 
        // cppcheck-suppress uninitMemberVar
        TypedFiber3(Function func, A1 a1, A2 a2, A3 a3)
                : m_function(func)
                , m_a1(a1)
                , m_a2(a2)
                , m_a3(a3)
        {}
 
        virtual ~TypedFiber3() noexcept final is_default
 
protected:
        virtual void entry_() final
        {
                m_function(m_a1, m_a2, m_a3);
                this->setFuture();
        }
 
private:
        Function m_function;
        A1 m_a1;
        A2 m_a2;
        A3 m_a3;
};
#  endif // ZTH_TYPEDFIBER98
 
#  if __cplusplus >= 201103L
// Always try to move the argument, unless it's an lvalue reference.
template <typename T, typename std::enable_if<!std::is_lvalue_reference<T>::value, int>::type = 0>
static constexpr T&& move_or_ref(T& t) noexcept
{
        return std::move(t);
}
 
template <typename T, typename std::enable_if<std::is_lvalue_reference<T>::value, int>::type = 0>
static constexpr T move_or_ref(T t) noexcept
{
        return t;
}
 
template <typename F, typename R, typename Args>
class TypedFiberN final : public TypedFiber<R> {
        ZTH_CLASS_NEW_DELETE(TypedFiberN)
public:
        using base = TypedFiber<R>;
        using Function = F;
 
        template <typename F_, typename... Args_>
        TypedFiberN(F_&& func, Args_&&... args)
                : m_function{std::forward<F_>(func)}
                , m_args{std::forward<Args_>(args)...}
        {}
 
        virtual ~TypedFiberN() final = default;
 
protected:
        virtual void entry_() final
        {
                entry__(typename SequenceGenerator<std::tuple_size<Args>::value>::type());
        }
 
private:
        template <size_t... S>
        void entry__(Sequence<S...>)
        {
                this->setFuture(m_function(
                        move_or_ref<typename std::tuple_element<S, Args>::type>(
                                std::get<S>(m_args))...));
        }
 
private:
        Function m_function;
        Args m_args;
};
 
template <typename F, typename Args>
class TypedFiberN<F, void, Args> final : public TypedFiber<void> {
        ZTH_CLASS_NEW_DELETE(TypedFiberN)
public:
        using base = TypedFiber<void>;
        using Function = F;
 
        template <typename F_, typename... Args_>
        TypedFiberN(F_&& func, Args_&&... args)
                : m_function{std::forward<F_>(func)}
                , m_args{std::forward<Args_>(args)...}
        {}
 
        virtual ~TypedFiberN() final = default;
 
protected:
        virtual void entry_() final
        {
                entry__(typename SequenceGenerator<std::tuple_size<Args>::value>::type());
        }
 
private:
        template <size_t... S>
        void entry__(Sequence<S...>)
        {
                m_function(
                        move_or_ref<typename std::tuple_element<S, Args>::type>(
                                std::get<S>(m_args))...);
                this->setFuture();
        }
 
private:
        Function m_function;
        Args m_args;
};
#  endif // C++11
 
 
 
// Define TypedFiberType to extract function type information to pick the right TypedFiberX class.
//
 
template <typename F>
struct remove_function_cvref {
        typedef F type;
};
 
#  define REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_(P, PArgs, suffix, ...) \
          template <typename R, ##__VA_ARGS__>                          \
          struct remove_function_cvref<R P PArgs suffix> {              \
                  typedef R(type) PArgs;                                \
          };
 
#  if ZTH_TYPEDFIBER98
#    define REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A0(P, suffix) \
            REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_(P, (), suffix)
#    define REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A1(P, suffix) \
            REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_(P, (A1), suffix, typename A1)
#    define REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A2(P, suffix) \
            REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_(P, (A1, A2), suffix, typename A1, typename A2)
#    define REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A3(P, suffix) \
            REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_(             \
                    P, (A1, A2, A3), suffix, typename A1, typename A2, typename A3)
 
#    define REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A(P, suffix)  \
            REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A0(P, suffix) \
            REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A1(P, suffix) \
            REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A2(P, suffix) \
            REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A3(P, suffix)
#  else
#    define REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A(P, suffix)
#  endif // ZTH_TYPEDFIBER98
 
#  if __cplusplus >= 201103L
#    define REMOVE_FUNCTION_CVREF_SPECIALIZATIONS(P, suffix)   \
            REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A(P, suffix) \
            REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_(P, (Args...), suffix, typename... Args)
#  else
#    define REMOVE_FUNCTION_CVREF_SPECIALIZATIONS(P, suffix) \
            REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A(P, suffix)
#  endif // C++11
 
REMOVE_FUNCTION_CVREF_SPECIALIZATIONS(, )
REMOVE_FUNCTION_CVREF_SPECIALIZATIONS((*), )
REMOVE_FUNCTION_CVREF_SPECIALIZATIONS((*&), )
REMOVE_FUNCTION_CVREF_SPECIALIZATIONS((&), )
 
#  if defined(__cpp_noexcept_function_type) && __cpp_noexcept_function_type >= 201510
REMOVE_FUNCTION_CVREF_SPECIALIZATIONS(, noexcept)
REMOVE_FUNCTION_CVREF_SPECIALIZATIONS((*), noexcept)
REMOVE_FUNCTION_CVREF_SPECIALIZATIONS((*&), noexcept)
REMOVE_FUNCTION_CVREF_SPECIALIZATIONS((&), noexcept)
#  endif // __cpp_noexcept_function_type
 
#  undef REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_
#  undef REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A0
#  undef REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A1
#  undef REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A2
#  undef REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A3
#  undef REMOVE_FUNCTION_CVREF_SPECIALIZATIONS_A
#  undef REMOVE_FUNCTION_CVREF_SPECIALIZATIONS
 
#  define REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_(PArgs, cvref, ...) \
          template <typename R, typename C, ##__VA_ARGS__>                 \
          struct remove_function_cvref<R(C::*) PArgs cvref> {              \
                  typedef R(type) PArgs;                                   \
          };
 
#  if ZTH_TYPEDFIBER98
#    define REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A0(cvref) \
            REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_((), cvref)
#    define REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A1(cvref) \
            REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_((A1), cvref, typename A1)
#    define REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A2(cvref) \
            REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_((A1, A2), cvref, typename A1, typename A2)
#    define REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A3(cvref) \
            REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_(         \
                    (A1, A2, A3), cvref, typename A1, typename A2, typename A3)
#    define REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A(cvref)  \
            REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A0(cvref) \
            REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A1(cvref) \
            REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A2(cvref) \
            REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A3(cvref)
#  else
#    define REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A(cvref)
#  endif // ZTH_TYPEDFIBER98
 
#  if __cplusplus >= 201103L
#    define REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS(cvref)   \
            REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A(cvref) \
            REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_((Args...), cvref, typename... Args)
#  else
#    define REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS(cvref) \
            REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A(cvref)
#  endif // C++11
 
#  define REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_CV(...)               \
          REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS(__VA_ARGS__)          \
          REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS(const __VA_ARGS__)    \
          REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS(volatile __VA_ARGS__) \
          REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS(const volatile __VA_ARGS__)
 
REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_CV()
#  if __cplusplus >= 201103L
REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_CV(&)
REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_CV(&&)
 
#    if defined(__cpp_noexcept_function_type) && __cpp_noexcept_function_type >= 201510
REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_CV(noexcept)
REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_CV(& noexcept)
REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_CV(&& noexcept)
#    endif // __cpp_noexcept_function_type
#  endif   // C++11
 
#  undef REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_
#  undef REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A0
#  undef REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A1
#  undef REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A2
#  undef REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A3
#  undef REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_A
#  undef REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS
#  undef REMOVE_FUNCTION_CVREF_MEMBER_SPECIALIZATIONS_CV
 
#  if __cplusplus >= 201103L
template <typename T>
struct functor_operator_type {};
 
template <typename R, typename... Args>
struct functor_operator_type<R(Args...)> {
        using return_type = R;
        using args_type = std::tuple<Args...>;
};
 
// Extract function type from functor's operator().
template <typename F>
struct functor_traits {
        using functor_type = typename std::decay<F>::type;
 
private:
        using functor_operator_type_ = functor_operator_type<
                typename remove_function_cvref<decltype(&functor_type::operator())>::type>;
 
public:
        using return_type = typename functor_operator_type_::return_type;
        using args_type = typename functor_operator_type_::args_type;
};
 
// Extract function type from function pointer.
template <typename R, typename... Args>
struct functor_traits<R (*)(Args...)> {
public:
        using functor_type = R (*)(Args...);
        using return_type = R;
        using args_type = std::tuple<Args...>;
};
 
template <typename R, typename... Args>
struct functor_traits<R (*&)(Args...)> {
public:
        using functor_type = R (*)(Args...);
        using return_type = R;
        using args_type = std::tuple<Args...>;
};
 
// Extract function type from function reference.
template <typename R, typename... Args>
struct functor_traits<R (&)(Args...)> {
public:
        using functor_type = R (&)(Args...);
        using return_type = R;
        using args_type = std::tuple<Args...>;
};
 
// Extract function type from function type.
template <typename R, typename... Args>
struct functor_traits<R(Args...)> {
public:
        using functor_type = R (*)(Args...);
        using return_type = R;
        using args_type = std::tuple<Args...>;
};
 
// Extract fiber function type information.
template <typename F>
struct TypedFiberType {
        using traitsType = functor_traits<F>;
        using returnType = typename traitsType::return_type;
        using fiberType = TypedFiberN<F, returnType, typename traitsType::args_type>;
 
        // Compatibility
        struct NoArg {};
        typedef NoArg a1Type;
        typedef NoArg a2Type;
        typedef NoArg a3Type;
};
#  else  // Pre C++11
template <typename F>
struct TypedFiberType {};
#  endif // Pre C++11
 
#  if ZTH_TYPEDFIBER98
#    define ZTH_TYPEDFIBERTYPE_SPECIALIZATION(P)                         \
            template <typename R>                                        \
            struct TypedFiberType<R P()> {                               \
                    struct NoArg {};                                     \
                    typedef R returnType;                                \
                    typedef TypedFiber0<R> fiberType;                    \
                    typedef NoArg a1Type;                                \
                    typedef NoArg a2Type;                                \
                    typedef NoArg a3Type;                                \
            };                                                           \
                                                                         \
            template <typename R, typename A1>                           \
            struct TypedFiberType<R P(A1)> {                             \
                    struct NoArg {};                                     \
                    typedef R returnType;                                \
                    typedef TypedFiber1<R, A1> fiberType;                \
                    typedef A1 a1Type;                                   \
                    typedef NoArg a2Type;                                \
                    typedef NoArg a3Type;                                \
            };                                                           \
                                                                         \
            template <typename R, typename A1, typename A2>              \
            struct TypedFiberType<R P(A1, A2)> {                         \
                    struct NoArg {};                                     \
                    typedef R returnType;                                \
                    typedef TypedFiber2<R, A1, A2> fiberType;            \
                    typedef A1 a1Type;                                   \
                    typedef A2 a2Type;                                   \
                    typedef NoArg a3Type;                                \
            };                                                           \
                                                                         \
            template <typename R, typename A1, typename A2, typename A3> \
            struct TypedFiberType<R P(A1, A2, A3)> {                     \
                    struct NoArg {};                                     \
                    typedef R returnType;                                \
                    typedef TypedFiber3<R, A1, A2, A3> fiberType;        \
                    typedef A1 a1Type;                                   \
                    typedef A2 a2Type;                                   \
                    typedef A3 a3Type;                                   \
            };
 
ZTH_TYPEDFIBERTYPE_SPECIALIZATION()
ZTH_TYPEDFIBERTYPE_SPECIALIZATION((*))
ZTH_TYPEDFIBERTYPE_SPECIALIZATION((*&))
ZTH_TYPEDFIBERTYPE_SPECIALIZATION((&))
 
#    undef ZTH_TYPEDFIBERTYPE_SPECIALIZATION
#  endif // ZTH_TYPEDFIBER98
 
 
 
// Define a TypedFiberFactory. It holds the entry function and creates fibers when the arguments are
// passed. The entry function and name are stored in the factory, the arguments are passed directly
// to the new fiber (managed by TypedFiberX).
//
 
template <typename F>
struct function_type_helper {
        typedef F type;
};
 
#  if ZTH_TYPEDFIBER98
#    define FUNCTION_TYPE_HELPER_SPECIALIZATION(P)                       \
            template <typename R>                                        \
            struct function_type_helper<R P()> {                         \
                    typedef R (*type)();                                 \
            };                                                           \
                                                                         \
            template <typename R, typename A1>                           \
            struct function_type_helper<R P(A1)> {                       \
                    typedef R (*type)(A1);                               \
            };                                                           \
                                                                         \
            template <typename R, typename A1, typename A2>              \
            struct function_type_helper<R P(A1, A2)> {                   \
                    typedef R (*type)(A1, A2);                           \
            };                                                           \
                                                                         \
            template <typename R, typename A1, typename A2, typename A3> \
            struct function_type_helper<R P(A1, A2, A3)> {               \
                    typedef R (*type)(A1, A2, A3);                       \
            };
 
FUNCTION_TYPE_HELPER_SPECIALIZATION()
FUNCTION_TYPE_HELPER_SPECIALIZATION((*))
FUNCTION_TYPE_HELPER_SPECIALIZATION((*&))
FUNCTION_TYPE_HELPER_SPECIALIZATION((&))
 
#    undef FUNCTION_TYPE_HELPER_SPECIALIZATION
#  endif // ZTH_TYPEDFIBER98
 
#  if __cplusplus >= 201103L
template <typename R, typename... Args>
struct function_type_helper<R(Args...)> {
        using type = R (*)(Args...);
};
 
template <typename R, typename... Args>
struct function_type_helper<R (*)(Args...)> {
        using type = R (*)(Args...);
};
 
template <typename R, typename... Args>
struct function_type_helper<R (*&)(Args...)> {
        using type = R (*)(Args...);
};
 
template <typename R, typename... Args>
struct function_type_helper<R (&)(Args...)> {
        using type = R (*)(Args...);
};
#  endif // C++11
 
template <typename F>
struct fiber_type;
 
template <typename F>
class TypedFiberFactory {
public:
        typedef typename function_type_helper<F>::type Function;
        typedef typename TypedFiberType<Function>::returnType Return;
        typedef typename TypedFiberType<Function>::fiberType TypedFiber_type;
        typedef SharedReference<typename TypedFiber_type::Future_type> Future;
 
        constexpr TypedFiberFactory(Function function, char const* name) noexcept
                : m_function(function)
                , m_name(name)
        {}
 
#  if __cplusplus >= 201103L
        template <typename F_>
        constexpr TypedFiberFactory(F_&& function, char const* name) noexcept
                : m_function{std::forward<F_>(function)}
                , m_name{name}
        {}
#  endif // C++11
 
#  if ZTH_TYPEDFIBER98
        typedef typename TypedFiberType<Function>::a1Type A1;
        typedef typename TypedFiberType<Function>::a2Type A2;
        typedef typename TypedFiberType<Function>::a3Type A3;
 
        fiber_type<Function> operator()() const
        {
                return polish(*new TypedFiber_type(m_function));
        }
 
        fiber_type<Function> operator()(A1 a1) const
        {
                return polish(*new TypedFiber_type(m_function, a1));
        }
 
        fiber_type<Function> operator()(A1 a1, A2 a2) const
        {
                return polish(*new TypedFiber_type(m_function, a1, a2));
        }
 
        fiber_type<Function> operator()(A1 a1, A2 a2, A3 a3) const
        {
                return polish(*new TypedFiber_type(m_function, a1, a2, a3));
        }
#  endif // ZTH_TYPEDFIBER98
 
#  if __cplusplus >= 201103L
        template <typename... Args>
        fiber_type<Function> operator()(Args&&... args) const
        {
                return polish(*new TypedFiber_type{m_function, std::forward<Args>(args)...});
        }
#  endif // C++11
 
protected:
        TypedFiber_type& polish(TypedFiber_type& fiber) const
        {
                if(unlikely(m_name))
                        fiber.setName(m_name);
 
                currentWorker().hatch(fiber);
                return fiber;
        }
 
private:
        Function m_function;
        char const* m_name;
};
 
 
 
// Provide a zth::fiber_type<F> API to get fiber information.
//
 
template <typename F>
struct fiber_type {
        typedef TypedFiberFactory<typename function_type_helper<F>::type> factory;
        typedef typename factory::Function function;
        typedef typename factory::Future future;
        typedef fiber_type<function> fiber;
 
        typedef typename factory::TypedFiber_type TypedFiber_type;
        SharedPointer<TypedFiber_type> _fiber;
 
        // cppcheck-suppress noExplicitConstructor
        fiber_type(TypedFiber_type& f) noexcept
                : _fiber(&f)
        {}
 
        typename TypedFiber_type::Return operator*()
        {
                future f = _fiber->withFuture();
                f.get().wait();
                return *f;
        }
 
        typename TypedFiber_type::Return operator->()
        {
                future f = _fiber->withFuture();
                f.get().wait();
                return *f;
        }
 
        TypedFiber_type& getFiber() const noexcept
        {
                return *_fiber;
        }
 
        operator TypedFiber_type&() const noexcept
        {
                return getFiber();
        }
 
        operator Fiber&() const noexcept
        {
                return getFiber();
        }
 
        future getFuture() const noexcept
        {
                return _fiber->withFuture();
        }
 
        operator future() const noexcept
        {
                return getFuture();
        }
 
        zth_fiber_t handle() const noexcept
        {
                return getFiber().handle();
        }
 
        void kill() noexcept
        {
                _fiber->kill();
        }
 
        void cancel()
        {
                _fiber->cancel();
        }
 
        template <typename Manipulator>
        fiber& operator<<(Manipulator const& m) LREF_QUALIFIED
        {
                *_fiber << m;
                return *this;
        }
 
        template <typename Manipulator>
        fiber const& operator<<(Manipulator const& m) const
        {
                *_fiber << m;
                return *this;
        }
 
#  if __cplusplus >= 201103L
        template <typename Manipulator>
        fiber&& operator<<(Manipulator const& m) &&
        {
                *_fiber << m;
                return std::move(*this);
        }
#  endif // C++11
 
        future operator<<(asFuture const&)
        {
                return *_fiber << asFuture();
        }
};
 
 
 
// zth::factory() and zth::fiber() functions
//
 
namespace impl {
static inline char const* fiber_name(char const* name)
{
        return (zth_config(EnableDebugPrint) || Config::EnablePerfEvent
                || Config::EnableStackWaterMark)
                       ? name
                       : nullptr;
}
} // namespace impl
 
#  if __cplusplus >= 201103L
template <typename F>
typename fiber_type<F>::factory factory(F&& f, char const* name = nullptr)
{
        return typename fiber_type<F>::factory(std::forward<F>(f), impl::fiber_name(name));
}
 
template <typename F>
typename fiber_type<F>::factory factory(F const& f, char const* name = nullptr)
{
        return typename fiber_type<F>::factory(f, impl::fiber_name(name));
}
#  else  // Pre-C++11
template <typename F>
typename fiber_type<F>::factory factory(F f, char const* name = nullptr)
{
        return typename fiber_type<F>::factory(f, impl::fiber_name(name));
}
#  endif // Pre-C++11
 
#  if ZTH_TYPEDFIBER98
template <typename F>
typename fiber_type<F>::fiber fiber(F f)
{
        return factory<F>(f)();
}
 
template <typename F>
typename fiber_type<F>::fiber fiber(F f, typename fiber_type<F>::factory::A1 a1)
{
        return factory<F>(f)(a1);
}
 
template <typename F>
typename fiber_type<F>::fiber
fiber(F f, typename fiber_type<F>::factory::A1 a1, typename fiber_type<F>::factory::A2 a2)
{
        return factory<F>(f)(a1, a2);
}
 
template <typename F>
typename fiber_type<F>::fiber
fiber(F f, typename fiber_type<F>::factory::A1 a1, typename fiber_type<F>::factory::A2 a2,
      typename fiber_type<F>::factory::A3 a3)
{
        return factory<F>(f)(a1, a2, a3);
}
#  endif // ZTH_TYPEDFIBER98
 
#  if __cplusplus >= 201103L
template <typename F, typename... Args>
typename fiber_type<F>::fiber fiber(F&& f, Args&&... args)
{
        return factory<F>(std::forward<F>(f))(std::forward<Args>(args)...);
}
#  endif // C++11
 
 
 
// Simplify fiber future type access
//
 
namespace impl {
template <typename F>
struct is_function_ {
        enum { value = 0 };
};
 
#  if ZTH_TYPEDFIBER98
template <typename R>
struct is_function_<R()> {
        enum { value = 1 };
};
template <typename R, typename A1>
struct is_function_<R(A1)> {
        enum { value = 1 };
};
template <typename R, typename A1, typename A2>
struct is_function_<R(A1, A2)> {
        enum { value = 1 };
};
template <typename R, typename A1, typename A2, typename A3>
struct is_function_<R(A1, A2, A3)> {
        enum { value = 1 };
};
#  endif // ZTH_TYPEDFIBER98
 
#  if __cplusplus >= 201103L
template <typename T, typename... Args>
struct is_function_<T(Args...)> {
        enum { value = 1 };
};
#  endif // C++11
} // namespace impl
 
template <typename T>
struct is_function {
        enum { value = impl::is_function_<typename remove_function_cvref<T>::type>::value };
};
 
template <typename T>
struct has_call_operator {
        typedef char yes;
        typedef long no;
 
        template <typename C>
        static yes test(decltype(&C::operator())*);
 
        template <typename>
        static no test(...);
 
        enum { value = sizeof(test<T>(nullptr)) == sizeof(yes) };
};
 
template <typename T>
struct is_callable {
        enum { value = is_function<T>::value || has_call_operator<T>::value };
};
 
namespace impl {
 
template <
        typename T, bool =
#  if __cplusplus >= 201103L
                            is_callable<T>::value
#  else
                            is_function<T>::value
#  endif // C++11
        >
struct fiber_future_helper {
        typedef typename fiber_type<T>::future type;
};
 
template <typename T>
struct fiber_future_helper<T, false> {
        typedef SharedReference<Future<T> > type;
};
 
} // namespace impl
 
template <typename T = void>
struct fiber_future : public impl::fiber_future_helper<T>::type {
        typedef typename impl::fiber_future_helper<T>::type future_type;
        typedef future_type base;
        typedef typename future_type::type return_type;
 
        template <typename F>
        // cppcheck-suppress noExplicitConstructor
        fiber_future(F& f) noexcept
                : base(static_cast<future_type const&>(f))
        {}
 
        template <typename F>
        // cppcheck-suppress noExplicitConstructor
        fiber_future(F const& f) noexcept
                : base(static_cast<future_type const&>(f))
        {}
};
 
#  if __cplusplus >= 201703L
// Deduction guides for fiber_future.
template <typename F>
fiber_future(F&) -> fiber_future<typename F::factory::Return>;
 
template <typename F>
fiber_future(F const&) -> fiber_future<typename F::factory::Return>;
#  endif // C++17
 
 
 
// Simple join
//
 
// cppcheck-suppress constParameterReference
static inline void joinable(Fiber& f, Gate& g, Hook<Gate&>& UNUSED_PAR(join)) noexcept
{
        f << passOnExit(g);
}
 
template <typename F>
static inline void
joinable(typename fiber_type<F>::fiber const& f, Gate& g, Hook<Gate&>& UNUSED_PAR(join)) noexcept
{
        f << passOnExit(g);
}
 
template <typename T>
static inline void joinable(Future<T>& f, Gate& UNUSED_PAR(g), Hook<Gate&>& join) noexcept
{
        struct impl {
                static void cb(Gate& g_, void* f_) noexcept
                {
                        Future<T>* f = static_cast<Future<T>*>(f_);
                        f->wait();
                        f->unused();
                        g_.pass();
                }
        };
 
        f.used();
        join.add(&impl::cb, static_cast<void*>(&f));
}
 
template <typename T>
static inline void
joinable(SharedReference<Future<T> > const& f, Gate& g, Hook<Gate&>& join) noexcept
{
        joinable(f.get(), g, join);
}
 
class joiner {
        ZTH_CLASS_NOCOPY(joiner)
public:
        joiner() noexcept
                : m_gate(1)
        {}
 
#  if ZTH_TYPEDFIBER98
        template <typename J0>
        explicit joiner(J0& j0)
                : m_gate(2)
        {
                joinable(j0, m_gate, m_join);
        }
 
        template <typename J0>
        explicit joiner(J0 const& j0)
                : m_gate(2)
        {
                joinable(j0, m_gate, m_join);
        }
 
        template <typename J0, typename J1>
        explicit joiner(J0& j0, J1& j1)
                : m_gate(3)
        {
                joinable(j0, m_gate, m_join);
                joinable(j1, m_gate, m_join);
        }
 
        template <typename J0, typename J1>
        explicit joiner(J0 const& j0, J1 const& j1)
                : m_gate(3)
        {
                joinable(j0, m_gate, m_join);
                joinable(j1, m_gate, m_join);
        }
 
        template <typename J0, typename J1, typename J2>
        explicit joiner(J0& j0, J1& j1, J2& j2)
                : m_gate(4)
        {
                joinable(j0, m_gate, m_join);
                joinable(j1, m_gate, m_join);
                joinable(j2, m_gate, m_join);
        }
 
        template <typename J0, typename J1, typename J2>
        explicit joiner(J0 const& j0, J1 const& j1, J2 const& j2)
                : m_gate(4)
        {
                joinable(j0, m_gate, m_join);
                joinable(j1, m_gate, m_join);
                joinable(j2, m_gate, m_join);
        }
 
        template <typename J0, typename J1, typename J2, typename J3>
        explicit joiner(J0& j0, J1& j1, J2& j2, J3& j3)
                : m_gate(5)
        {
                joinable(j0, m_gate, m_join);
                joinable(j1, m_gate, m_join);
                joinable(j2, m_gate, m_join);
                joinable(j3, m_gate, m_join);
        }
 
        template <typename J0, typename J1, typename J2, typename J3>
        explicit joiner(J0 const& j0, J1 const& j1, J2 const& j2, J3 const& j3)
                : m_gate(5)
        {
                joinable(j0, m_gate, m_join);
                joinable(j1, m_gate, m_join);
                joinable(j2, m_gate, m_join);
                joinable(j3, m_gate, m_join);
        }
 
        template <typename J0, typename J1, typename J2, typename J3, typename J4>
        explicit joiner(J0& j0, J1& j1, J2& j2, J3& j3, J4& j4)
                : m_gate(6)
        {
                joinable(j0, m_gate, m_join);
                joinable(j1, m_gate, m_join);
                joinable(j2, m_gate, m_join);
                joinable(j3, m_gate, m_join);
                joinable(j4, m_gate, m_join);
        }
 
        template <typename J0, typename J1, typename J2, typename J3, typename J4>
        explicit joiner(J0 const& j0, J1 const& j1, J2 const& j2, J3 const& j3, J4 const& j4)
                : m_gate(6)
        {
                joinable(j0, m_gate, m_join);
                joinable(j1, m_gate, m_join);
                joinable(j2, m_gate, m_join);
                joinable(j3, m_gate, m_join);
                joinable(j4, m_gate, m_join);
        }
#  endif // ZTH_TYPEDFIBER98
 
#  if __cplusplus >= 201103L
        template <typename... J>
        explicit joiner(J&&... j)
                : m_gate{sizeof...(j) + 1U}
        {
                using dummy = int[];
                (void)dummy{0, (joinable(std::forward<J>(j), m_gate, m_join), 0)...};
        }
#  endif // C++11
 
        ~joiner()
        {
                m_join.once(m_gate);
                m_gate.wait();
        }
 
private:
        Gate m_gate;
        Hook<Gate&> m_join;
};
 
#  if ZTH_TYPEDFIBER98
template <typename J0>
static inline void join(J0& j0)
{
        joiner jn(j0);
}
 
template <typename J0, typename J1>
static inline void join(J0& j0, J1& j1)
{
        joiner jn(j0, j1);
}
 
template <typename J0, typename J1, typename J2>
static inline void join(J0& j0, J1& j1, J2& j2)
{
        joiner jn(j0, j1, j2);
}
 
template <typename J0, typename J1, typename J2, typename J3>
static inline void join(J0& j0, J1& j1, J2& j2, J3& j3)
{
        joiner jn(j0, j1, j2, j3);
}
 
template <typename J0, typename J1, typename J2, typename J3, typename J4>
static inline void join(J0& j0, J1& j1, J2& j2, J3& j3, J4& j4)
{
        joiner jn(j0, j1, j2, j3, j4);
}
#  endif
 
#  if __cplusplus >= 201103L
template <typename... J>
static inline void join(J&&... j)
{
        joiner jn{std::forward<J>(j)...};
}
#  endif
 
 
 
// zth_async macros
//
 
namespace fibered {}
 
} // namespace zth
 
#  define zth_fiber_declare_1(f)                                     \
          namespace zth {                                            \
          namespace fibered {                                        \
          extern ::zth::fiber_type<decltype(&::f)>::factory const f; \
          }                                                          \
          }
 
#  define zth_fiber_declare(...) FOREACH(zth_fiber_declare_1, ##__VA_ARGS__)
 
#  define zth_fiber_define_1(storage, f)                                                     \
          namespace zth {                                                                    \
          namespace fibered {                                                                \
          ZTH_DEPRECATED("Use zth::fiber(f, args...) instead")                               \
          storage ::zth::fiber_type<decltype(&::f)>::factory const                           \
                  f(&::f, ::zth::Config::SupportDebugPrint || ::zth::Config::EnablePerfEvent \
                                  ? ZTH_STRINGIFY(f) "()"                                    \
                                  : nullptr); /* NOLINT */                                   \
          }                                                                                  \
          }                                                                                  \
          typedef ::zth::fiber_type<decltype(&::f)>::future f##_future;
#  define zth_fiber_define_extern_1(f) zth_fiber_define_1(extern, f)
#  define zth_fiber_define_static_1(f) zth_fiber_define_1(static constexpr, f)
 
#  define zth_fiber_define(...) FOREACH(zth_fiber_define_extern_1, ##__VA_ARGS__)
 
#  define zth_fiber(...) FOREACH(zth_fiber_define_static_1, ##__VA_ARGS__)
 
#  define zth_async ::zth::fibered::
 
 
 
// C API
//
 
EXTERN_C ZTH_EXPORT ZTH_INLINE int zth_fiber_create(
        zth_fiber_t* h, void (*f)(void*), void* arg = nullptr, size_t stack = 0,
        char const* name = nullptr) noexcept
{
        if(h)
                h->p = nullptr;
 
        try {
                zth::fiber_type<void(void*)>::fiber fib = zth::factory(f, name)(arg);
                fib << zth::setStackSize(stack);
                if(h)
                        *h = fib.handle();
        } catch(std::bad_alloc const&) {
                return ENOMEM;
        } catch(zth::errno_exception const& e) {
#  ifdef __cpp_exceptions
                return e.code;
#  endif
        } catch(...) {
                return EAGAIN;
        }
 
        return 0;
}
#else // !__cplusplus
 
#  include <stddef.h>
 
ZTH_EXPORT int
zth_fiber_create(zth_fiber_t* h, void (*f)(void*), void* arg, size_t stack, char const* name);
 
#endif // !__cplusplus
#endif // ZTH_ASYNC_H