context.cpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2019-2026 Jochem Rutgers
 *
 * SPDX-License-Identifier: MPL-2.0
 */
 
#include <libzth/macros.h>
 
#ifdef ZTH_OS_MAC
#  define _XOPEN_SOURCE
#endif
 
#include <libzth/context.h>
#include <libzth/context/context.h>
#include <libzth/worker.h>
 
 
 
// context functions
 
namespace zth {
 
int context_init() noexcept
{
        zth_dbg(context, "[%s] Initialize", currentWorker().id_str());
        return Context::init();
}
 
void context_deinit() noexcept
{
        zth_dbg(context, "[%s] Deinit", currentWorker().id_str());
        Context::deinit();
}
 
int context_create(Context*& context, ContextAttr const& attr) noexcept
{
        try {
                context = new Context(attr);
        } catch(std::bad_alloc const&) {
                zth_dbg(context, "[%s] Cannot create context; %s", currentWorker().id_str(),
                        err(ENOMEM).c_str());
                return ENOMEM;
        } catch(...) {
                // Should not be thrown by new...
                return EAGAIN;
        }
 
        int res = context->create();
        if(res) {
                delete context;
                context = nullptr;
                zth_dbg(context, "[%s] Cannot create context; %s", currentWorker().id_str(),
                        err(res).c_str());
                return res;
        }
 
        if(likely(attr.stackSize > 0)) {
#ifdef ZTH_CONTEXT_WINFIBER
                zth_dbg(context, "[%s] New context %p", currentWorker().id_str(), context);
#else
                Context::Stack const& stack = context->stackUsable();
                zth_dbg(context, "[%s] New context %p with stack: %p-%p", currentWorker().id_str(),
                        context, stack.p, stack.p + stack.size - 1U);
#endif
        }
 
        return 0;
}
 
void context_destroy(Context* context) noexcept
{
        if(!context)
                return;
 
        context->destroy();
        delete context;
        // NOLINTNEXTLINE(clang-analyzer-cplusplus.NewDelete)
        zth_dbg(context, "[%s] Deleted context %p", currentWorker().id_str(), context);
}
 
void context_switch(Context* from, Context* to) noexcept
{
        zth_assert(from);
        zth_assert(to);
 
#ifdef ZTH_ENABLE_ASAN
        zth_assert(to->alive());
        void* fake_stack = nullptr;
        __sanitizer_start_switch_fiber(
                from->alive() ? &fake_stack : nullptr, to->stackUsable().p, to->stackUsable().size);
#endif
 
        // cppcheck-suppress nullPointerRedundantCheck
        from->context_switch(*to);
 
#ifdef ZTH_ENABLE_ASAN
        __sanitizer_finish_switch_fiber(fake_stack, nullptr, nullptr);
#endif
 
        // Got back from somewhere else.
        from->stackGuard();
}
 
size_t context_stack_usage(Context* context) noexcept
{
        if(!Config::EnableStackWaterMark || !context)
                return 0;
 
        Fiber* f = currentWorker().currentFiber();
        void* guard = nullptr;
 
        if(f && f->context() == context) {
                // Guards may be in place on the current stack. Disable it
                // while iterating it.
                guard = context->stackGuard(nullptr);
        }
 
        size_t res = stack_watermark_maxused(context->stackUsable().p);
 
        // cppcheck-suppress knownConditionTrueFalse
        if(guard)
                context->stackGuard(guard);
 
        return res;
}
 
} // namespace zth
 
void context_entry(zth::Context* context) noexcept
{
#ifdef ZTH_ENABLE_ASAN
        __sanitizer_finish_switch_fiber(nullptr, nullptr, nullptr);
#endif
 
        zth_assert(context);
 
        // Go execute the fiber.
        // cppcheck-suppress nullPointerRedundantCheck
        context->stackGuard();
 
        try {
                // cppcheck-suppress nullPointerRedundantCheck
                context->attr().entry(context->attr().arg);
        } catch(...) {
                zth_dbg(context, "[%s] Uncaught exception in fiber", zth::currentWorker().id_str());
        }
 
        // Fiber has quit. Switch to another one.
        context->die();
        zth::yield();
 
        // We should never get here, otherwise the fiber wasn't dead...
        zth_abort("Returned to finished context");
}
 
 
 
// Stack functions
 
namespace zth {
 
#define ZTH_STACK_WATERMARKER ((uint64_t)0x5a7468574de2889eULL) // Some nice UTF-8 text.
 
static void stack_watermark_align(void*& stack, size_t*& sizeptr, size_t* size = nullptr) noexcept
{
        if(!stack)
                return;
 
        uintptr_t stack_ = reinterpret_cast<uintptr_t>(stack);
 
        // Align to size_t
        stack_ = (stack_ + sizeof(size_t) - 1U) & ~(uintptr_t)(sizeof(size_t) - 1U);
        // The stack size is stored here.
        sizeptr = reinterpret_cast<size_t*>(stack_); // NOLINT
 
        // Reduce stack to store the size.
        stack_ += sizeof(size_t);
        if(size)
                // Reduce remaining stack size.
                *size -= stack_ - (uintptr_t)stack; // NOLINT
 
        stack = reinterpret_cast<void*>(stack_); // NOLINT
}
 
void stack_watermark_init(void* stack, size_t size) noexcept
{
        if(!Config::EnableStackWaterMark || !stack || !size)
                return;
 
        // Most likely, but growing up stack is not implemented here (yet?)
        zth_assert(Context::stackGrowsDown(&size));
 
        size_t* sizeptr = nullptr;
        stack_watermark_align(stack, sizeptr, &size);
        *sizeptr = size;
 
        for(size_t i = 0; i * sizeof(uint64_t) <= size - sizeof(uint64_t); i++)
                static_cast<uint64_t*>(stack)[i] = ZTH_STACK_WATERMARKER;
}
 
size_t stack_watermark_size(void* stack) noexcept
{
        if(!Config::EnableStackWaterMark || !stack)
                return 0;
 
        size_t* sizeptr = nullptr;
        stack_watermark_align(stack, sizeptr);
        return *sizeptr;
}
 
size_t stack_watermark_maxused(void* stack) noexcept
{
        if(!Config::EnableStackWaterMark || !stack)
                return 0;
 
        size_t* sizeptr = nullptr;
        stack_watermark_align(stack, sizeptr);
        size_t size = *sizeptr;
 
        size_t unused = 0;
 
#ifdef ZTH_USE_VALGRIND
        VALGRIND_DISABLE_ADDR_ERROR_REPORTING_IN_RANGE(stack, size); // NOLINT
#endif
 
        for(uint64_t* s = static_cast<uint64_t*>(stack);
            unused < size / sizeof(uint64_t) && *s == ZTH_STACK_WATERMARKER; unused++, s++)
                ;
 
#ifdef ZTH_USE_VALGRIND
        VALGRIND_ENABLE_ADDR_ERROR_REPORTING_IN_RANGE(stack, size); // NOLINT
#endif
 
        return size - unused * sizeof(uint64_t);
}
 
size_t stack_watermark_remaining(void* stack) noexcept
{
        return stack_watermark_size(stack) - stack_watermark_maxused(stack);
}
 
} // namespace zth
 
#ifdef ZTH_STACK_SWITCH
void* zth_stack_switch(void* stack, size_t size, void* (*f)(void*) noexcept, void* arg) noexcept
{
        zth::Worker* worker = zth::Worker::instance();
 
        if(!worker) {
noswitch:
                return f(arg);
        }
 
        zth::Fiber* fiber = worker->currentFiber();
        if(!fiber)
                goto noswitch;
 
        zth::Context* context = fiber->context();
        if(!context)
                goto noswitch;
 
        return context->stack_switch(stack, size, f, arg);
}
#endif // ZTH_STACK_SWITCH