yuzu/src/common/fiber.h

66 lines
2 KiB
C++
Raw Normal View History

// SPDX-FileCopyrightText: Copyright 2020 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
2020-02-04 14:06:23 -05:00
#pragma once
#include <functional>
#include <memory>
namespace boost::context::detail {
2020-02-10 12:33:13 -05:00
struct transfer_t;
}
2020-02-04 14:06:23 -05:00
namespace Common {
/**
* Fiber class
* a fiber is a userspace thread with it's own context. They can be used to
* implement coroutines, emulated threading systems and certain asynchronous
* patterns.
*
* This class implements fibers at a low level, thus allowing greater freedom
* to implement such patterns. This fiber class is 'threadsafe' only one fiber
* can be running at a time and threads will be locked while trying to yield to
* a running fiber until it yields. WARNING exchanging two running fibers between
* threads will cause a deadlock. In order to prevent a deadlock, each thread should
* have an intermediary fiber, you switch to the intermediary fiber of the current
* thread and then from it switch to the expected fiber. This way you can exchange
* 2 fibers within 2 different threads.
*/
2020-02-04 14:06:23 -05:00
class Fiber {
public:
Fiber(std::function<void()>&& entry_point_func);
2020-02-04 14:06:23 -05:00
~Fiber();
Fiber(const Fiber&) = delete;
Fiber& operator=(const Fiber&) = delete;
Fiber(Fiber&&) = default;
Fiber& operator=(Fiber&&) = default;
2020-02-04 14:06:23 -05:00
/// Yields control from Fiber 'from' to Fiber 'to'
/// Fiber 'from' must be the currently running fiber.
static void YieldTo(std::weak_ptr<Fiber> weak_from, Fiber& to);
[[nodiscard]] static std::shared_ptr<Fiber> ThreadToFiber();
2020-02-04 14:06:23 -05:00
void SetRewindPoint(std::function<void()>&& rewind_func);
2020-02-27 15:32:47 -05:00
void Rewind();
2020-02-04 14:06:23 -05:00
/// Only call from main thread's fiber
void Exit();
private:
Fiber();
void OnRewind(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 RewindStartFunc(boost::context::detail::transfer_t transfer);
2020-02-04 14:06:23 -05:00
struct FiberImpl;
std::unique_ptr<FiberImpl> impl;
};
} // namespace Common