Common/Fiber: Address Feedback and Correct Memory leaks.

This commit is contained in:
Fernando Sahmkow 2020-05-13 13:49:36 -04:00
parent b6655aa2e4
commit e77ee67bfa
2 changed files with 41 additions and 34 deletions

View file

@ -21,7 +21,7 @@ struct Fiber::FiberImpl {
LPVOID rewind_handle = nullptr; LPVOID rewind_handle = nullptr;
}; };
void Fiber::start() { void Fiber::Start() {
ASSERT(previous_fiber != nullptr); ASSERT(previous_fiber != nullptr);
previous_fiber->guard.unlock(); previous_fiber->guard.unlock();
previous_fiber.reset(); previous_fiber.reset();
@ -29,7 +29,7 @@ void Fiber::start() {
UNREACHABLE(); UNREACHABLE();
} }
void Fiber::onRewind() { void Fiber::OnRewind() {
ASSERT(impl->handle != nullptr); ASSERT(impl->handle != nullptr);
DeleteFiber(impl->handle); DeleteFiber(impl->handle);
impl->handle = impl->rewind_handle; impl->handle = impl->rewind_handle;
@ -38,14 +38,14 @@ void Fiber::onRewind() {
UNREACHABLE(); UNREACHABLE();
} }
void __stdcall Fiber::FiberStartFunc(void* fiber_parameter) { void Fiber::FiberStartFunc(void* fiber_parameter) {
auto fiber = static_cast<Fiber*>(fiber_parameter); auto fiber = static_cast<Fiber*>(fiber_parameter);
fiber->start(); fiber->Start();
} }
void __stdcall Fiber::RewindStartFunc(void* fiber_parameter) { void Fiber::RewindStartFunc(void* fiber_parameter) {
auto fiber = static_cast<Fiber*>(fiber_parameter); auto fiber = static_cast<Fiber*>(fiber_parameter);
fiber->onRewind(); fiber->OnRewind();
} }
Fiber::Fiber(std::function<void(void*)>&& entry_point_func, void* start_parameter) Fiber::Fiber(std::function<void(void*)>&& entry_point_func, void* start_parameter)
@ -59,8 +59,11 @@ Fiber::Fiber() {
} }
Fiber::~Fiber() { Fiber::~Fiber() {
if (released) {
return;
}
// Make sure the Fiber is not being used // Make sure the Fiber is not being used
bool locked = guard.try_lock(); const bool locked = guard.try_lock();
ASSERT_MSG(locked, "Destroying a fiber that's still running"); ASSERT_MSG(locked, "Destroying a fiber that's still running");
if (locked) { if (locked) {
guard.unlock(); guard.unlock();
@ -75,6 +78,7 @@ void Fiber::Exit() {
} }
ConvertFiberToThread(); ConvertFiberToThread();
guard.unlock(); guard.unlock();
released = true;
} }
void Fiber::SetRewindPoint(std::function<void(void*)>&& rewind_func, void* start_parameter) { void Fiber::SetRewindPoint(std::function<void(void*)>&& rewind_func, void* start_parameter) {
@ -89,22 +93,21 @@ void Fiber::Rewind() {
SwitchToFiber(impl->rewind_handle); SwitchToFiber(impl->rewind_handle);
} }
void Fiber::YieldTo(std::shared_ptr<Fiber> from, std::shared_ptr<Fiber> to) { void Fiber::YieldTo(std::shared_ptr<Fiber>& from, std::shared_ptr<Fiber>& to) {
ASSERT_MSG(from != nullptr, "Yielding fiber is null!"); ASSERT_MSG(from != nullptr, "Yielding fiber is null!");
ASSERT_MSG(to != nullptr, "Next fiber is null!"); ASSERT_MSG(to != nullptr, "Next fiber is null!");
to->guard.lock(); to->guard.lock();
to->previous_fiber = from; to->previous_fiber = from;
SwitchToFiber(to->impl->handle); SwitchToFiber(to->impl->handle);
auto previous_fiber = from->previous_fiber; ASSERT(from->previous_fiber != nullptr);
ASSERT(previous_fiber != nullptr); from->previous_fiber->guard.unlock();
previous_fiber->guard.unlock(); from->previous_fiber.reset();
previous_fiber.reset();
} }
std::shared_ptr<Fiber> Fiber::ThreadToFiber() { std::shared_ptr<Fiber> Fiber::ThreadToFiber() {
std::shared_ptr<Fiber> fiber = std::shared_ptr<Fiber>{new Fiber()}; std::shared_ptr<Fiber> fiber = std::shared_ptr<Fiber>{new Fiber()};
fiber->guard.lock(); fiber->guard.lock();
fiber->impl->handle = ConvertThreadToFiber(NULL); fiber->impl->handle = ConvertThreadToFiber(nullptr);
fiber->is_thread_fiber = true; fiber->is_thread_fiber = true;
return fiber; return fiber;
} }
@ -120,7 +123,7 @@ struct Fiber::FiberImpl {
boost::context::detail::fcontext_t rewind_context; boost::context::detail::fcontext_t rewind_context;
}; };
void Fiber::start(boost::context::detail::transfer_t& transfer) { void Fiber::Start(boost::context::detail::transfer_t& transfer) {
ASSERT(previous_fiber != nullptr); ASSERT(previous_fiber != nullptr);
previous_fiber->impl->context = transfer.fctx; previous_fiber->impl->context = transfer.fctx;
previous_fiber->guard.unlock(); previous_fiber->guard.unlock();
@ -129,7 +132,7 @@ void Fiber::start(boost::context::detail::transfer_t& transfer) {
UNREACHABLE(); UNREACHABLE();
} }
void Fiber::onRewind(boost::context::detail::transfer_t& [[maybe_unused]] transfer) { void Fiber::OnRewind([[maybe_unused]] boost::context::detail::transfer_t& transfer) {
ASSERT(impl->context != nullptr); ASSERT(impl->context != nullptr);
impl->context = impl->rewind_context; impl->context = impl->rewind_context;
impl->rewind_context = nullptr; impl->rewind_context = nullptr;
@ -142,17 +145,16 @@ void Fiber::onRewind(boost::context::detail::transfer_t& [[maybe_unused]] transf
void Fiber::FiberStartFunc(boost::context::detail::transfer_t transfer) { void Fiber::FiberStartFunc(boost::context::detail::transfer_t transfer) {
auto fiber = static_cast<Fiber*>(transfer.data); auto fiber = static_cast<Fiber*>(transfer.data);
fiber->start(transfer); fiber->Start(transfer);
} }
void Fiber::RewindStartFunc(boost::context::detail::transfer_t transfer) { void Fiber::RewindStartFunc(boost::context::detail::transfer_t transfer) {
auto fiber = static_cast<Fiber*>(transfer.data); auto fiber = static_cast<Fiber*>(transfer.data);
fiber->onRewind(transfer); fiber->OnRewind(transfer);
} }
Fiber::Fiber(std::function<void(void*)>&& entry_point_func, void* start_parameter) Fiber::Fiber(std::function<void(void*)>&& entry_point_func, void* start_parameter)
: guard{}, entry_point{std::move(entry_point_func)}, start_parameter{start_parameter}, : entry_point{std::move(entry_point_func)}, start_parameter{start_parameter} {
previous_fiber{} {
impl = std::make_unique<FiberImpl>(); impl = std::make_unique<FiberImpl>();
impl->stack_limit = impl->stack.data(); impl->stack_limit = impl->stack.data();
impl->rewind_stack_limit = impl->rewind_stack.data(); impl->rewind_stack_limit = impl->rewind_stack.data();
@ -171,8 +173,11 @@ Fiber::Fiber() {
} }
Fiber::~Fiber() { Fiber::~Fiber() {
if (released) {
return;
}
// Make sure the Fiber is not being used // Make sure the Fiber is not being used
bool locked = guard.try_lock(); const bool locked = guard.try_lock();
ASSERT_MSG(locked, "Destroying a fiber that's still running"); ASSERT_MSG(locked, "Destroying a fiber that's still running");
if (locked) { if (locked) {
guard.unlock(); guard.unlock();
@ -180,11 +185,13 @@ Fiber::~Fiber() {
} }
void Fiber::Exit() { void Fiber::Exit() {
ASSERT_MSG(is_thread_fiber, "Exitting non main thread fiber"); ASSERT_MSG(is_thread_fiber, "Exitting non main thread fiber");
if (!is_thread_fiber) { if (!is_thread_fiber) {
return; return;
} }
guard.unlock(); guard.unlock();
released = true;
} }
void Fiber::Rewind() { void Fiber::Rewind() {
@ -196,17 +203,16 @@ void Fiber::Rewind() {
boost::context::detail::jump_fcontext(impl->rewind_context, this); boost::context::detail::jump_fcontext(impl->rewind_context, this);
} }
void Fiber::YieldTo(std::shared_ptr<Fiber> from, std::shared_ptr<Fiber> to) { void Fiber::YieldTo(std::shared_ptr<Fiber>& from, std::shared_ptr<Fiber>& to) {
ASSERT_MSG(from != nullptr, "Yielding fiber is null!"); ASSERT_MSG(from != nullptr, "Yielding fiber is null!");
ASSERT_MSG(to != nullptr, "Next fiber is null!"); ASSERT_MSG(to != nullptr, "Next fiber is null!");
to->guard.lock(); to->guard.lock();
to->previous_fiber = from; to->previous_fiber = from;
auto transfer = boost::context::detail::jump_fcontext(to->impl->context, to.get()); auto transfer = boost::context::detail::jump_fcontext(to->impl->context, to.get());
auto previous_fiber = from->previous_fiber; ASSERT(from->previous_fiber != nullptr);
ASSERT(previous_fiber != nullptr); from->previous_fiber->impl->context = transfer.fctx;
previous_fiber->impl->context = transfer.fctx; from->previous_fiber->guard.unlock();
previous_fiber->guard.unlock(); from->previous_fiber.reset();
previous_fiber.reset();
} }
std::shared_ptr<Fiber> Fiber::ThreadToFiber() { std::shared_ptr<Fiber> Fiber::ThreadToFiber() {

View file

@ -46,7 +46,7 @@ public:
/// Yields control from Fiber 'from' to Fiber 'to' /// Yields control from Fiber 'from' to Fiber 'to'
/// Fiber 'from' must be the currently running fiber. /// Fiber 'from' must be the currently running fiber.
static void YieldTo(std::shared_ptr<Fiber> from, std::shared_ptr<Fiber> to); static void YieldTo(std::shared_ptr<Fiber>& from, std::shared_ptr<Fiber>& to);
static std::shared_ptr<Fiber> ThreadToFiber(); static std::shared_ptr<Fiber> ThreadToFiber();
void SetRewindPoint(std::function<void(void*)>&& rewind_func, void* start_parameter); void SetRewindPoint(std::function<void(void*)>&& rewind_func, void* start_parameter);
@ -65,13 +65,13 @@ private:
Fiber(); Fiber();
#if defined(_WIN32) || defined(WIN32) #if defined(_WIN32) || defined(WIN32)
void onRewind(); void OnRewind();
void start(); void Start();
static void FiberStartFunc(void* fiber_parameter); static void FiberStartFunc(void* fiber_parameter);
static void RewindStartFunc(void* fiber_parameter); static void RewindStartFunc(void* fiber_parameter);
#else #else
void onRewind(boost::context::detail::transfer_t& transfer); void OnRewind(boost::context::detail::transfer_t& transfer);
void start(boost::context::detail::transfer_t& transfer); void Start(boost::context::detail::transfer_t& transfer);
static void FiberStartFunc(boost::context::detail::transfer_t transfer); static void FiberStartFunc(boost::context::detail::transfer_t transfer);
static void RewindStartFunc(boost::context::detail::transfer_t transfer); static void RewindStartFunc(boost::context::detail::transfer_t transfer);
#endif #endif
@ -79,13 +79,14 @@ private:
struct FiberImpl; struct FiberImpl;
SpinLock guard{}; SpinLock guard{};
std::function<void(void*)> entry_point{}; std::function<void(void*)> entry_point;
std::function<void(void*)> rewind_point{}; std::function<void(void*)> rewind_point;
void* rewind_parameter{}; void* rewind_parameter{};
void* start_parameter{}; void* start_parameter{};
std::shared_ptr<Fiber> previous_fiber{}; std::shared_ptr<Fiber> previous_fiber;
std::unique_ptr<FiberImpl> impl; std::unique_ptr<FiberImpl> impl;
bool is_thread_fiber{}; bool is_thread_fiber{};
bool released{};
}; };
} // namespace Common } // namespace Common