2020-02-04 11:06:23 -08:00
|
|
|
// Copyright 2020 yuzu Emulator Project
|
|
|
|
// Licensed under GPLv2 or any later version
|
|
|
|
// Refer to the license.txt file included.
|
|
|
|
|
2020-02-05 11:48:20 -08:00
|
|
|
#include "common/assert.h"
|
2020-02-04 11:06:23 -08:00
|
|
|
#include "common/fiber.h"
|
2020-02-10 10:21:23 -08:00
|
|
|
#if defined(_WIN32) || defined(WIN32)
|
2020-02-05 10:13:16 -08:00
|
|
|
#include <windows.h>
|
|
|
|
#else
|
|
|
|
#include <boost/context/detail/fcontext.hpp>
|
|
|
|
#endif
|
2020-02-04 11:06:23 -08:00
|
|
|
|
|
|
|
namespace Common {
|
|
|
|
|
2020-02-27 12:32:47 -08:00
|
|
|
constexpr std::size_t default_stack_size = 256 * 1024; // 256kb
|
|
|
|
|
2020-02-10 10:21:23 -08:00
|
|
|
#if defined(_WIN32) || defined(WIN32)
|
2020-02-04 11:06:23 -08:00
|
|
|
|
|
|
|
struct Fiber::FiberImpl {
|
|
|
|
LPVOID handle = nullptr;
|
2020-02-27 12:32:47 -08:00
|
|
|
LPVOID rewind_handle = nullptr;
|
2020-02-04 11:06:23 -08:00
|
|
|
};
|
|
|
|
|
2020-05-13 10:49:36 -07:00
|
|
|
void Fiber::Start() {
|
2020-02-05 11:48:20 -08:00
|
|
|
ASSERT(previous_fiber != nullptr);
|
|
|
|
previous_fiber->guard.unlock();
|
|
|
|
previous_fiber.reset();
|
2020-02-04 11:06:23 -08:00
|
|
|
entry_point(start_parameter);
|
2020-02-05 11:48:20 -08:00
|
|
|
UNREACHABLE();
|
2020-02-04 11:06:23 -08:00
|
|
|
}
|
|
|
|
|
2020-05-13 10:49:36 -07:00
|
|
|
void Fiber::OnRewind() {
|
2020-02-27 12:32:47 -08:00
|
|
|
ASSERT(impl->handle != nullptr);
|
|
|
|
DeleteFiber(impl->handle);
|
|
|
|
impl->handle = impl->rewind_handle;
|
|
|
|
impl->rewind_handle = nullptr;
|
|
|
|
rewind_point(rewind_parameter);
|
|
|
|
UNREACHABLE();
|
|
|
|
}
|
|
|
|
|
2020-05-13 10:49:36 -07:00
|
|
|
void Fiber::FiberStartFunc(void* fiber_parameter) {
|
2020-02-10 09:33:13 -08:00
|
|
|
auto fiber = static_cast<Fiber*>(fiber_parameter);
|
2020-05-13 10:49:36 -07:00
|
|
|
fiber->Start();
|
2020-02-04 11:06:23 -08:00
|
|
|
}
|
|
|
|
|
2020-05-13 10:49:36 -07:00
|
|
|
void Fiber::RewindStartFunc(void* fiber_parameter) {
|
2020-02-27 12:32:47 -08:00
|
|
|
auto fiber = static_cast<Fiber*>(fiber_parameter);
|
2020-05-13 10:49:36 -07:00
|
|
|
fiber->OnRewind();
|
2020-02-27 12:32:47 -08:00
|
|
|
}
|
|
|
|
|
2020-02-04 11:06:23 -08:00
|
|
|
Fiber::Fiber(std::function<void(void*)>&& entry_point_func, void* start_parameter)
|
2020-02-10 10:45:08 -08:00
|
|
|
: entry_point{std::move(entry_point_func)}, start_parameter{start_parameter} {
|
2020-02-04 11:06:23 -08:00
|
|
|
impl = std::make_unique<FiberImpl>();
|
2020-02-27 12:32:47 -08:00
|
|
|
impl->handle = CreateFiber(default_stack_size, &FiberStartFunc, this);
|
2020-02-04 11:06:23 -08:00
|
|
|
}
|
|
|
|
|
2020-06-27 15:20:06 -07:00
|
|
|
Fiber::Fiber() : impl{std::make_unique<FiberImpl>()} {}
|
2020-02-04 11:06:23 -08:00
|
|
|
|
|
|
|
Fiber::~Fiber() {
|
2020-05-13 10:49:36 -07:00
|
|
|
if (released) {
|
|
|
|
return;
|
|
|
|
}
|
2020-02-04 11:06:23 -08:00
|
|
|
// Make sure the Fiber is not being used
|
2020-05-13 10:49:36 -07:00
|
|
|
const bool locked = guard.try_lock();
|
2020-02-05 11:48:20 -08:00
|
|
|
ASSERT_MSG(locked, "Destroying a fiber that's still running");
|
|
|
|
if (locked) {
|
|
|
|
guard.unlock();
|
|
|
|
}
|
2020-02-04 11:06:23 -08:00
|
|
|
DeleteFiber(impl->handle);
|
|
|
|
}
|
|
|
|
|
|
|
|
void Fiber::Exit() {
|
2020-02-05 11:48:20 -08:00
|
|
|
ASSERT_MSG(is_thread_fiber, "Exitting non main thread fiber");
|
2020-02-04 11:06:23 -08:00
|
|
|
if (!is_thread_fiber) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
ConvertFiberToThread();
|
|
|
|
guard.unlock();
|
2020-05-13 10:49:36 -07:00
|
|
|
released = true;
|
2020-02-04 11:06:23 -08:00
|
|
|
}
|
|
|
|
|
2020-02-27 12:32:47 -08:00
|
|
|
void Fiber::SetRewindPoint(std::function<void(void*)>&& rewind_func, void* start_parameter) {
|
|
|
|
rewind_point = std::move(rewind_func);
|
|
|
|
rewind_parameter = start_parameter;
|
|
|
|
}
|
|
|
|
|
|
|
|
void Fiber::Rewind() {
|
|
|
|
ASSERT(rewind_point);
|
|
|
|
ASSERT(impl->rewind_handle == nullptr);
|
|
|
|
impl->rewind_handle = CreateFiber(default_stack_size, &RewindStartFunc, this);
|
|
|
|
SwitchToFiber(impl->rewind_handle);
|
|
|
|
}
|
|
|
|
|
2020-10-27 21:42:41 -07:00
|
|
|
void Fiber::YieldTo(std::shared_ptr<Fiber> from, std::shared_ptr<Fiber> to) {
|
2020-02-05 11:48:20 -08:00
|
|
|
ASSERT_MSG(from != nullptr, "Yielding fiber is null!");
|
|
|
|
ASSERT_MSG(to != nullptr, "Next fiber is null!");
|
2020-02-04 11:06:23 -08:00
|
|
|
to->guard.lock();
|
|
|
|
to->previous_fiber = from;
|
|
|
|
SwitchToFiber(to->impl->handle);
|
2020-05-13 10:49:36 -07:00
|
|
|
ASSERT(from->previous_fiber != nullptr);
|
|
|
|
from->previous_fiber->guard.unlock();
|
|
|
|
from->previous_fiber.reset();
|
2020-02-04 11:06:23 -08:00
|
|
|
}
|
|
|
|
|
|
|
|
std::shared_ptr<Fiber> Fiber::ThreadToFiber() {
|
|
|
|
std::shared_ptr<Fiber> fiber = std::shared_ptr<Fiber>{new Fiber()};
|
|
|
|
fiber->guard.lock();
|
2020-05-13 10:49:36 -07:00
|
|
|
fiber->impl->handle = ConvertThreadToFiber(nullptr);
|
2020-02-04 11:06:23 -08:00
|
|
|
fiber->is_thread_fiber = true;
|
|
|
|
return fiber;
|
|
|
|
}
|
|
|
|
|
|
|
|
#else
|
|
|
|
|
2020-02-26 10:39:27 -08:00
|
|
|
struct Fiber::FiberImpl {
|
|
|
|
alignas(64) std::array<u8, default_stack_size> stack;
|
2020-04-01 06:19:10 -07:00
|
|
|
alignas(64) std::array<u8, default_stack_size> rewind_stack;
|
2020-06-27 15:20:06 -07:00
|
|
|
u8* stack_limit;
|
2020-04-01 06:19:10 -07:00
|
|
|
u8* rewind_stack_limit;
|
2020-02-05 10:13:16 -08:00
|
|
|
boost::context::detail::fcontext_t context;
|
2020-04-01 06:19:10 -07:00
|
|
|
boost::context::detail::fcontext_t rewind_context;
|
2020-02-04 11:06:23 -08:00
|
|
|
};
|
|
|
|
|
2020-05-13 10:49:36 -07:00
|
|
|
void Fiber::Start(boost::context::detail::transfer_t& transfer) {
|
2020-02-05 11:48:20 -08:00
|
|
|
ASSERT(previous_fiber != nullptr);
|
|
|
|
previous_fiber->impl->context = transfer.fctx;
|
|
|
|
previous_fiber->guard.unlock();
|
|
|
|
previous_fiber.reset();
|
2020-02-04 11:06:23 -08:00
|
|
|
entry_point(start_parameter);
|
2020-02-05 11:48:20 -08:00
|
|
|
UNREACHABLE();
|
2020-02-04 11:06:23 -08:00
|
|
|
}
|
|
|
|
|
2020-05-13 10:49:36 -07:00
|
|
|
void Fiber::OnRewind([[maybe_unused]] boost::context::detail::transfer_t& transfer) {
|
2020-04-01 06:19:10 -07:00
|
|
|
ASSERT(impl->context != nullptr);
|
|
|
|
impl->context = impl->rewind_context;
|
|
|
|
impl->rewind_context = nullptr;
|
|
|
|
u8* tmp = impl->stack_limit;
|
|
|
|
impl->stack_limit = impl->rewind_stack_limit;
|
|
|
|
impl->rewind_stack_limit = tmp;
|
|
|
|
rewind_point(rewind_parameter);
|
|
|
|
UNREACHABLE();
|
|
|
|
}
|
|
|
|
|
2020-02-10 09:33:13 -08:00
|
|
|
void Fiber::FiberStartFunc(boost::context::detail::transfer_t transfer) {
|
|
|
|
auto fiber = static_cast<Fiber*>(transfer.data);
|
2020-05-13 10:49:36 -07:00
|
|
|
fiber->Start(transfer);
|
2020-02-04 11:06:23 -08:00
|
|
|
}
|
|
|
|
|
2020-04-01 06:19:10 -07:00
|
|
|
void Fiber::RewindStartFunc(boost::context::detail::transfer_t transfer) {
|
|
|
|
auto fiber = static_cast<Fiber*>(transfer.data);
|
2020-05-13 10:49:36 -07:00
|
|
|
fiber->OnRewind(transfer);
|
2020-04-01 06:19:10 -07:00
|
|
|
}
|
|
|
|
|
2020-02-04 11:06:23 -08:00
|
|
|
Fiber::Fiber(std::function<void(void*)>&& entry_point_func, void* start_parameter)
|
2020-05-13 10:49:36 -07:00
|
|
|
: entry_point{std::move(entry_point_func)}, start_parameter{start_parameter} {
|
2020-02-04 11:06:23 -08:00
|
|
|
impl = std::make_unique<FiberImpl>();
|
2020-04-01 06:19:10 -07:00
|
|
|
impl->stack_limit = impl->stack.data();
|
|
|
|
impl->rewind_stack_limit = impl->rewind_stack.data();
|
|
|
|
u8* stack_base = impl->stack_limit + default_stack_size;
|
2020-02-26 10:39:27 -08:00
|
|
|
impl->context =
|
2020-02-26 13:34:23 -08:00
|
|
|
boost::context::detail::make_fcontext(stack_base, impl->stack.size(), FiberStartFunc);
|
2020-02-04 11:06:23 -08:00
|
|
|
}
|
|
|
|
|
2020-04-01 06:19:10 -07:00
|
|
|
void Fiber::SetRewindPoint(std::function<void(void*)>&& rewind_func, void* start_parameter) {
|
|
|
|
rewind_point = std::move(rewind_func);
|
|
|
|
rewind_parameter = start_parameter;
|
|
|
|
}
|
|
|
|
|
2020-06-27 15:20:06 -07:00
|
|
|
Fiber::Fiber() : impl{std::make_unique<FiberImpl>()} {}
|
2020-02-04 11:06:23 -08:00
|
|
|
|
|
|
|
Fiber::~Fiber() {
|
2020-05-13 10:49:36 -07:00
|
|
|
if (released) {
|
|
|
|
return;
|
|
|
|
}
|
2020-02-04 11:06:23 -08:00
|
|
|
// Make sure the Fiber is not being used
|
2020-05-13 10:49:36 -07:00
|
|
|
const bool locked = guard.try_lock();
|
2020-02-05 11:48:20 -08:00
|
|
|
ASSERT_MSG(locked, "Destroying a fiber that's still running");
|
|
|
|
if (locked) {
|
|
|
|
guard.unlock();
|
|
|
|
}
|
2020-02-04 11:06:23 -08:00
|
|
|
}
|
|
|
|
|
|
|
|
void Fiber::Exit() {
|
2020-05-13 10:49:36 -07:00
|
|
|
|
2020-02-05 11:48:20 -08:00
|
|
|
ASSERT_MSG(is_thread_fiber, "Exitting non main thread fiber");
|
2020-02-04 11:06:23 -08:00
|
|
|
if (!is_thread_fiber) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
guard.unlock();
|
2020-05-13 10:49:36 -07:00
|
|
|
released = true;
|
2020-02-04 11:06:23 -08:00
|
|
|
}
|
|
|
|
|
2020-04-01 06:19:10 -07:00
|
|
|
void Fiber::Rewind() {
|
|
|
|
ASSERT(rewind_point);
|
|
|
|
ASSERT(impl->rewind_context == nullptr);
|
|
|
|
u8* stack_base = impl->rewind_stack_limit + default_stack_size;
|
|
|
|
impl->rewind_context =
|
|
|
|
boost::context::detail::make_fcontext(stack_base, impl->stack.size(), RewindStartFunc);
|
|
|
|
boost::context::detail::jump_fcontext(impl->rewind_context, this);
|
|
|
|
}
|
|
|
|
|
2020-10-27 21:42:41 -07:00
|
|
|
void Fiber::YieldTo(std::shared_ptr<Fiber> from, std::shared_ptr<Fiber> to) {
|
2020-02-05 11:48:20 -08:00
|
|
|
ASSERT_MSG(from != nullptr, "Yielding fiber is null!");
|
|
|
|
ASSERT_MSG(to != nullptr, "Next fiber is null!");
|
2020-02-04 11:06:23 -08:00
|
|
|
to->guard.lock();
|
|
|
|
to->previous_fiber = from;
|
2020-02-26 10:39:27 -08:00
|
|
|
auto transfer = boost::context::detail::jump_fcontext(to->impl->context, to.get());
|
2020-05-13 10:49:36 -07:00
|
|
|
ASSERT(from->previous_fiber != nullptr);
|
|
|
|
from->previous_fiber->impl->context = transfer.fctx;
|
|
|
|
from->previous_fiber->guard.unlock();
|
|
|
|
from->previous_fiber.reset();
|
2020-02-04 11:06:23 -08:00
|
|
|
}
|
|
|
|
|
|
|
|
std::shared_ptr<Fiber> Fiber::ThreadToFiber() {
|
|
|
|
std::shared_ptr<Fiber> fiber = std::shared_ptr<Fiber>{new Fiber()};
|
2020-02-05 10:13:16 -08:00
|
|
|
fiber->guard.lock();
|
2020-02-04 11:06:23 -08:00
|
|
|
fiber->is_thread_fiber = true;
|
|
|
|
return fiber;
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|
|
|
|
} // namespace Common
|