diff options
Diffstat (limited to 'src/common/fiber.h')
| -rw-r--r-- | src/common/fiber.h | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/src/common/fiber.h b/src/common/fiber.h new file mode 100644 index 000000000..dafc1100e --- /dev/null +++ b/src/common/fiber.h | |||
| @@ -0,0 +1,92 @@ | |||
| 1 | // Copyright 2020 yuzu Emulator Project | ||
| 2 | // Licensed under GPLv2 or any later version | ||
| 3 | // Refer to the license.txt file included. | ||
| 4 | |||
| 5 | #pragma once | ||
| 6 | |||
| 7 | #include <functional> | ||
| 8 | #include <memory> | ||
| 9 | |||
| 10 | #include "common/common_types.h" | ||
| 11 | #include "common/spin_lock.h" | ||
| 12 | |||
| 13 | #if !defined(_WIN32) && !defined(WIN32) | ||
| 14 | namespace boost::context::detail { | ||
| 15 | struct transfer_t; | ||
| 16 | } | ||
| 17 | #endif | ||
| 18 | |||
| 19 | namespace Common { | ||
| 20 | |||
| 21 | /** | ||
| 22 | * Fiber class | ||
| 23 | * a fiber is a userspace thread with it's own context. They can be used to | ||
| 24 | * implement coroutines, emulated threading systems and certain asynchronous | ||
| 25 | * patterns. | ||
| 26 | * | ||
| 27 | * This class implements fibers at a low level, thus allowing greater freedom | ||
| 28 | * to implement such patterns. This fiber class is 'threadsafe' only one fiber | ||
| 29 | * can be running at a time and threads will be locked while trying to yield to | ||
| 30 | * a running fiber until it yields. WARNING exchanging two running fibers between | ||
| 31 | * threads will cause a deadlock. In order to prevent a deadlock, each thread should | ||
| 32 | * have an intermediary fiber, you switch to the intermediary fiber of the current | ||
| 33 | * thread and then from it switch to the expected fiber. This way you can exchange | ||
| 34 | * 2 fibers within 2 different threads. | ||
| 35 | */ | ||
| 36 | class Fiber { | ||
| 37 | public: | ||
| 38 | Fiber(std::function<void(void*)>&& entry_point_func, void* start_parameter); | ||
| 39 | ~Fiber(); | ||
| 40 | |||
| 41 | Fiber(const Fiber&) = delete; | ||
| 42 | Fiber& operator=(const Fiber&) = delete; | ||
| 43 | |||
| 44 | Fiber(Fiber&&) = default; | ||
| 45 | Fiber& operator=(Fiber&&) = default; | ||
| 46 | |||
| 47 | /// Yields control from Fiber 'from' to Fiber 'to' | ||
| 48 | /// Fiber 'from' must be the currently running fiber. | ||
| 49 | static void YieldTo(std::shared_ptr<Fiber>& from, std::shared_ptr<Fiber>& to); | ||
| 50 | static std::shared_ptr<Fiber> ThreadToFiber(); | ||
| 51 | |||
| 52 | void SetRewindPoint(std::function<void(void*)>&& rewind_func, void* start_parameter); | ||
| 53 | |||
| 54 | void Rewind(); | ||
| 55 | |||
| 56 | /// Only call from main thread's fiber | ||
| 57 | void Exit(); | ||
| 58 | |||
| 59 | /// Changes the start parameter of the fiber. Has no effect if the fiber already started | ||
| 60 | void SetStartParameter(void* new_parameter) { | ||
| 61 | start_parameter = new_parameter; | ||
| 62 | } | ||
| 63 | |||
| 64 | private: | ||
| 65 | Fiber(); | ||
| 66 | |||
| 67 | #if defined(_WIN32) || defined(WIN32) | ||
| 68 | void OnRewind(); | ||
| 69 | void Start(); | ||
| 70 | static void FiberStartFunc(void* fiber_parameter); | ||
| 71 | static void RewindStartFunc(void* fiber_parameter); | ||
| 72 | #else | ||
| 73 | void OnRewind(boost::context::detail::transfer_t& transfer); | ||
| 74 | void Start(boost::context::detail::transfer_t& transfer); | ||
| 75 | static void FiberStartFunc(boost::context::detail::transfer_t transfer); | ||
| 76 | static void RewindStartFunc(boost::context::detail::transfer_t transfer); | ||
| 77 | #endif | ||
| 78 | |||
| 79 | struct FiberImpl; | ||
| 80 | |||
| 81 | SpinLock guard{}; | ||
| 82 | std::function<void(void*)> entry_point; | ||
| 83 | std::function<void(void*)> rewind_point; | ||
| 84 | void* rewind_parameter{}; | ||
| 85 | void* start_parameter{}; | ||
| 86 | std::shared_ptr<Fiber> previous_fiber; | ||
| 87 | std::unique_ptr<FiberImpl> impl; | ||
| 88 | bool is_thread_fiber{}; | ||
| 89 | bool released{}; | ||
| 90 | }; | ||
| 91 | |||
| 92 | } // namespace Common | ||