Skip to content

Latest commit

 

History

History
44 lines (37 loc) · 2.65 KB

README.md

File metadata and controls

44 lines (37 loc) · 2.65 KB

rustix-futex-sync

Linux futex-based synchronization

Github Actions CI Status zulip chat crates.io page docs.rs docs

Linux futex-based implementations of Mutex, RwLock, Condvar, Once, and OnceLock, as well as RawMutex, RawRwLock, and RawCondvar, derived from the futex code in std, factored out to a standalone no_std crate using rustix to do the futex and lock_api to provide most of the public Mutex and RwLock API.

lock_api does not support poisoning, so support for poisoning is omitted.

In this library, Condvar, RawCondvar, RawMutex, and Once are guaranteed to be repr(transparent) wrappers around a single AtomicU32. RawRwLock is guaranteed to be a repr(C) wrapper around two AtomicU32s. The contents of these AtomicU32s are not documented, except that all these types' const fn new() and INIT are guaranteed to initialize them to all zeros.

These types use the FUTEX_PRIVATE_FLAG flag so they don't work for synchronizing in memory shared between multiple processes. Enabling the "shm" feature enables the shm module, which contains shared-memory versions of all the main types.