summaryrefslogtreecommitdiffstats
path: root/vendor/parking_lot_core-0.8.6/src/thread_parker/mod.rs
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/parking_lot_core-0.8.6/src/thread_parker/mod.rs')
-rw-r--r--vendor/parking_lot_core-0.8.6/src/thread_parker/mod.rs85
1 files changed, 85 insertions, 0 deletions
diff --git a/vendor/parking_lot_core-0.8.6/src/thread_parker/mod.rs b/vendor/parking_lot_core-0.8.6/src/thread_parker/mod.rs
new file mode 100644
index 000000000..a7e4bb69c
--- /dev/null
+++ b/vendor/parking_lot_core-0.8.6/src/thread_parker/mod.rs
@@ -0,0 +1,85 @@
+use cfg_if::cfg_if;
+use instant::Instant;
+
+/// Trait for the platform thread parker implementation.
+///
+/// All unsafe methods are unsafe because the Unix thread parker is based on
+/// pthread mutexes and condvars. Those primitives must not be moved and used
+/// from any other memory address than the one they were located at when they
+/// were initialized. As such, it's UB to call any unsafe method on
+/// `ThreadParkerT` if the implementing instance has moved since the last
+/// call to any of the unsafe methods.
+pub trait ThreadParkerT {
+ type UnparkHandle: UnparkHandleT;
+
+ const IS_CHEAP_TO_CONSTRUCT: bool;
+
+ fn new() -> Self;
+
+ /// Prepares the parker. This should be called before adding it to the queue.
+ unsafe fn prepare_park(&self);
+
+ /// Checks if the park timed out. This should be called while holding the
+ /// queue lock after park_until has returned false.
+ unsafe fn timed_out(&self) -> bool;
+
+ /// Parks the thread until it is unparked. This should be called after it has
+ /// been added to the queue, after unlocking the queue.
+ unsafe fn park(&self);
+
+ /// Parks the thread until it is unparked or the timeout is reached. This
+ /// should be called after it has been added to the queue, after unlocking
+ /// the queue. Returns true if we were unparked and false if we timed out.
+ unsafe fn park_until(&self, timeout: Instant) -> bool;
+
+ /// Locks the parker to prevent the target thread from exiting. This is
+ /// necessary to ensure that thread-local ThreadData objects remain valid.
+ /// This should be called while holding the queue lock.
+ unsafe fn unpark_lock(&self) -> Self::UnparkHandle;
+}
+
+/// Handle for a thread that is about to be unparked. We need to mark the thread
+/// as unparked while holding the queue lock, but we delay the actual unparking
+/// until after the queue lock is released.
+pub trait UnparkHandleT {
+ /// Wakes up the parked thread. This should be called after the queue lock is
+ /// released to avoid blocking the queue for too long.
+ ///
+ /// This method is unsafe for the same reason as the unsafe methods in
+ /// `ThreadParkerT`.
+ unsafe fn unpark(self);
+}
+
+cfg_if! {
+ if #[cfg(any(target_os = "linux", target_os = "android"))] {
+ #[path = "linux.rs"]
+ mod imp;
+ } else if #[cfg(unix)] {
+ #[path = "unix.rs"]
+ mod imp;
+ } else if #[cfg(windows)] {
+ #[path = "windows/mod.rs"]
+ mod imp;
+ } else if #[cfg(target_os = "redox")] {
+ #[path = "redox.rs"]
+ mod imp;
+ } else if #[cfg(all(target_env = "sgx", target_vendor = "fortanix"))] {
+ #[path = "sgx.rs"]
+ mod imp;
+ } else if #[cfg(all(
+ feature = "nightly",
+ target_arch = "wasm32",
+ target_feature = "atomics"
+ ))] {
+ #[path = "wasm_atomic.rs"]
+ mod imp;
+ } else if #[cfg(target_arch = "wasm32")] {
+ #[path = "wasm.rs"]
+ mod imp;
+ } else {
+ #[path = "generic.rs"]
+ mod imp;
+ }
+}
+
+pub use self::imp::{thread_yield, ThreadParker, UnparkHandle};