#atomic #wait #cross-platform #futex #thread #wake #operations

no-std atomic-wait

Cross-platform atomic wait and wake (aka futex) functionality

5 releases (3 stable)

1.1.0 Jan 2, 2023
1.0.1 Sep 27, 2022
0.2.0 Sep 25, 2022
0.1.0 Sep 16, 2022

#210 in Concurrency

Download history 605/week @ 2023-11-23 813/week @ 2023-11-30 721/week @ 2023-12-07 808/week @ 2023-12-14 656/week @ 2023-12-21 561/week @ 2023-12-28 922/week @ 2024-01-04 917/week @ 2024-01-11 987/week @ 2024-01-18 982/week @ 2024-01-25 1029/week @ 2024-02-01 1103/week @ 2024-02-08 903/week @ 2024-02-15 893/week @ 2024-02-22 917/week @ 2024-02-29 798/week @ 2024-03-07

3,677 downloads per month
Used in 8 crates

BSD-2-Clause

10KB
151 lines

Cross platform atomic wait and wake (aka futex) functionality.

This crate only supports functionality that's available on all of Linux, FreeBSD, Windows, and macOS. That is:

  • Only AtomicU32 is supported. (Linux currently only supports 32-bit futexes.)
  • Only the "wait", "wake one", and "wake all" operations are supported. (Linux supports more operations, but Windows and macOS don't.)
  • No timeouts. (macOS doesn't have a stable/public API for timeouts.)
  • The wake operations don't return the number of threads woken up. (Only Linux supports this.)

Supported platforms: Linux 2.6.22+, FreeBSD 11+, Windows 8+, Windows Server 2012+, macOS 11+, iOS 14+, watchOS 7+.

Usage

use std::sync::atomic::AtomicU32;
use atomic_wait::{wait, wake_one, wake_all};

let a = AtomicU32::new(0);

wait(&a, 1); // If the value is 1, wait.

wake_one(&a); // Wake one waiting thread.

wake_all(&a); // Wake all waiting threads.

Implementation

On Linux, this uses the SYS_futex syscall.

On FreeBSD, this uses the _umtx_op syscall.

On Windows, this uses the WaitOnAddress and WakeByAddress APIs.

On macOS (and iOS and watchOS), this uses libc++, making use of the same (ABI-stable) functions behind C++20's atomic_wait and atomic_notify functions.

Dependencies

~0–13MB
~96K SLoC