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 // This deliberately lacks a `const _ = !0`, so that users can use
14 // `from_bits_truncate` to extract the `SocketFlags` from a flags
15 // value that also includes a `SocketType`.
16 }
17}
18
19/// `FUTEX_*` operations for use with the futex syscall wrappers.
20#[derive(Debug, Copy, Clone, Eq, PartialEq)]
21#[repr(u32)]
22pub(crate) enum Operation {
23 /// `FUTEX_WAIT`
24 Wait = linux_raw_sys::general::FUTEX_WAIT,
25 /// `FUTEX_WAKE`
26 Wake = linux_raw_sys::general::FUTEX_WAKE,
27 /// `FUTEX_FD`
28 Fd = linux_raw_sys::general::FUTEX_FD,
29 /// `FUTEX_REQUEUE`
30 Requeue = linux_raw_sys::general::FUTEX_REQUEUE,
31 /// `FUTEX_CMP_REQUEUE`
32 CmpRequeue = linux_raw_sys::general::FUTEX_CMP_REQUEUE,
33 /// `FUTEX_WAKE_OP`
34 WakeOp = linux_raw_sys::general::FUTEX_WAKE_OP,
35 /// `FUTEX_LOCK_PI`
36 LockPi = linux_raw_sys::general::FUTEX_LOCK_PI,
37 /// `FUTEX_UNLOCK_PI`
38 UnlockPi = linux_raw_sys::general::FUTEX_UNLOCK_PI,
39 /// `FUTEX_TRYLOCK_PI`
40 TrylockPi = linux_raw_sys::general::FUTEX_TRYLOCK_PI,
41 /// `FUTEX_WAIT_BITSET`
42 WaitBitset = linux_raw_sys::general::FUTEX_WAIT_BITSET,
43 /// `FUTEX_WAKE_BITSET`
44 WakeBitset = linux_raw_sys::general::FUTEX_WAKE_BITSET,
45 /// `FUTEX_WAIT_REQUEUE_PI`
46 WaitRequeuePi = linux_raw_sys::general::FUTEX_WAIT_REQUEUE_PI,
47 /// `FUTEX_CMP_REQUEUE_PI`
48 CmpRequeuePi = linux_raw_sys::general::FUTEX_CMP_REQUEUE_PI,
49 /// `FUTEX_LOCK_PI2`
50 LockPi2 = linux_raw_sys::general::FUTEX_LOCK_PI2,
51}
52
53/// `FUTEX_*` operations for use with the [`futex`] function.
54///
55/// [`futex`]: fn@crate::thread::futex
56// TODO: Deprecate this now that we have a new typed API.
57/*
58#[deprecated(
59 since = "0.38.35",
60 note = "
61 The `futex` function and `FutexOperation` enum are deprecated. There are
62 individual functions available to perform futex operations with improved
63 type safety. See the `rustix::thread::futex` module."
64)]
65*/
66#[derive(Debug, Copy, Clone, Eq, PartialEq)]
67#[repr(u32)]
68pub enum FutexOperation {
69 /// `FUTEX_WAIT`
70 Wait = linux_raw_sys::general::FUTEX_WAIT,
71 /// `FUTEX_WAKE`
72 Wake = linux_raw_sys::general::FUTEX_WAKE,
73 /// `FUTEX_FD`
74 Fd = linux_raw_sys::general::FUTEX_FD,
75 /// `FUTEX_REQUEUE`
76 Requeue = linux_raw_sys::general::FUTEX_REQUEUE,
77 /// `FUTEX_CMP_REQUEUE`
78 CmpRequeue = linux_raw_sys::general::FUTEX_CMP_REQUEUE,
79 /// `FUTEX_WAKE_OP`
80 WakeOp = linux_raw_sys::general::FUTEX_WAKE_OP,
81 /// `FUTEX_LOCK_PI`
82 LockPi = linux_raw_sys::general::FUTEX_LOCK_PI,
83 /// `FUTEX_UNLOCK_PI`
84 UnlockPi = linux_raw_sys::general::FUTEX_UNLOCK_PI,
85 /// `FUTEX_TRYLOCK_PI`
86 TrylockPi = linux_raw_sys::general::FUTEX_TRYLOCK_PI,
87 /// `FUTEX_WAIT_BITSET`
88 WaitBitset = linux_raw_sys::general::FUTEX_WAIT_BITSET,
89}
90
91/// `FUTEX_WAITERS`
92pub const WAITERS: u32 = linux_raw_sys::general::FUTEX_WAITERS;
93
94/// `FUTEX_OWNER_DIED`
95pub const OWNER_DIED: u32 = linux_raw_sys::general::FUTEX_OWNER_DIED;
96