rustix/backend/linux_raw/thread/
futex.rs

1bitflags::bitflags! {
2    /// `FUTEX_*` flags for use with the functions in [`futex`].
3    ///
4    /// [`futex`]: mod@crate::thread::futex
5    #[repr(transparent)]
6    #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
7    pub struct Flags: u32 {
8        /// `FUTEX_PRIVATE_FLAG`
9        const PRIVATE = linux_raw_sys::general::FUTEX_PRIVATE_FLAG;
10        /// `FUTEX_CLOCK_REALTIME`
11        const CLOCK_REALTIME = linux_raw_sys::general::FUTEX_CLOCK_REALTIME;
12
13        /// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
14        const _ = !0;
15    }
16}
17
18bitflags::bitflags! {
19    /// `FUTEX2_*` flags for use with the functions in [`Waitv`].
20    ///
21    /// Not to be confused with [`WaitvFlags`], which is passed as an argument
22    /// to the `waitv` function.
23    ///
24    /// [`Waitv`]: crate::thread::futex::Waitv
25    /// [`WaitvFlags`]: crate::thread::futex::WaitvFlags
26    #[repr(transparent)]
27    #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
28    pub struct WaitFlags: u32 {
29        /// `FUTEX_U8`
30        const SIZE_U8 = linux_raw_sys::general::FUTEX2_SIZE_U8;
31        /// `FUTEX_U16`
32        const SIZE_U16 = linux_raw_sys::general::FUTEX2_SIZE_U16;
33        /// `FUTEX_U32`
34        const SIZE_U32 = linux_raw_sys::general::FUTEX2_SIZE_U32;
35        /// `FUTEX_U64`
36        const SIZE_U64 = linux_raw_sys::general::FUTEX2_SIZE_U64;
37        /// `FUTEX_SIZE_MASK`
38        const SIZE_MASK = linux_raw_sys::general::FUTEX2_SIZE_MASK;
39
40        /// `FUTEX2_NUMA`
41        const NUMA = linux_raw_sys::general::FUTEX2_NUMA;
42
43        /// `FUTEX2_PRIVATE`
44        const PRIVATE = linux_raw_sys::general::FUTEX2_PRIVATE;
45
46        /// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
47        const _ = !0;
48    }
49}
50
51/// `FUTEX_*` operations for use with the futex syscall wrappers.
52#[derive(Debug, Copy, Clone, Eq, PartialEq)]
53#[repr(u32)]
54pub(crate) enum Operation {
55    /// `FUTEX_WAIT`
56    Wait = linux_raw_sys::general::FUTEX_WAIT,
57    /// `FUTEX_WAKE`
58    Wake = linux_raw_sys::general::FUTEX_WAKE,
59    /// `FUTEX_FD`
60    Fd = linux_raw_sys::general::FUTEX_FD,
61    /// `FUTEX_REQUEUE`
62    Requeue = linux_raw_sys::general::FUTEX_REQUEUE,
63    /// `FUTEX_CMP_REQUEUE`
64    CmpRequeue = linux_raw_sys::general::FUTEX_CMP_REQUEUE,
65    /// `FUTEX_WAKE_OP`
66    WakeOp = linux_raw_sys::general::FUTEX_WAKE_OP,
67    /// `FUTEX_LOCK_PI`
68    LockPi = linux_raw_sys::general::FUTEX_LOCK_PI,
69    /// `FUTEX_UNLOCK_PI`
70    UnlockPi = linux_raw_sys::general::FUTEX_UNLOCK_PI,
71    /// `FUTEX_TRYLOCK_PI`
72    TrylockPi = linux_raw_sys::general::FUTEX_TRYLOCK_PI,
73    /// `FUTEX_WAIT_BITSET`
74    WaitBitset = linux_raw_sys::general::FUTEX_WAIT_BITSET,
75    /// `FUTEX_WAKE_BITSET`
76    WakeBitset = linux_raw_sys::general::FUTEX_WAKE_BITSET,
77    /// `FUTEX_WAIT_REQUEUE_PI`
78    WaitRequeuePi = linux_raw_sys::general::FUTEX_WAIT_REQUEUE_PI,
79    /// `FUTEX_CMP_REQUEUE_PI`
80    CmpRequeuePi = linux_raw_sys::general::FUTEX_CMP_REQUEUE_PI,
81    /// `FUTEX_LOCK_PI2`
82    LockPi2 = linux_raw_sys::general::FUTEX_LOCK_PI2,
83}
84
85/// `FUTEX_WAITERS`
86pub const WAITERS: u32 = linux_raw_sys::general::FUTEX_WAITERS;
87
88/// `FUTEX_OWNER_DIED`
89pub const OWNER_DIED: u32 = linux_raw_sys::general::FUTEX_OWNER_DIED;
rustix/backend/linux_raw/thread/futex.rs

rustix/backend/linux_raw/thread/
futex.rs
