Module `libc/stdatomic`

libc/stdatomic

Stability: unstable — a raw C binding, not a Yo design. `std/sync/atomic` is the public surface (`std/sync/once` also reaches in for its state flag), and what is bound here is shaped by C rather than chosen: the C11 atomic operations are GENERIC MACROS, and a `c_include` binding is keyed by C symbol name, so each macro can have exactly one Yo binding — which is why `atomic_fetch_*_explicit` appears for `i32` only and every other type runs a compare-exchange loop in `std/sync/atomic` instead (docs/en-US/THREAD_SAFETY.md). The memory-order enumerators are bound as plain `int`s. Freezing would mean freezing that per-type binding asymmetry, which is a workaround, not a design. — stable modules only change additively; this one may still change.

C11 <stdatomic.h> — atomic operations and types.

Stability

unstable — a raw C binding, not a Yo design. std/sync/atomic is the public surface (std/sync/once also reaches in for its state flag), and what is bound here is shaped by C rather than chosen: the C11 atomic operations are GENERIC MACROS, and a c_include binding is keyed by C symbol name, so each macro can have exactly one Yo binding — which is why atomic_fetch_*_explicit appears for i32 only and every other type runs a compare-exchange loop in std/sync/atomic instead (docs/en-US/THREAD_SAFETY.md). The memory-order enumerators are bound as plain ints. Freezing would mean freezing that per-type binding asymmetry, which is a workaround, not a design.

Types

atomic_bool type-alias

atomic_bool

Trait Implementations

atomic_char type-alias

atomic_char

Trait Implementations

atomic_schar type-alias

atomic_schar

Trait Implementations

atomic_uchar type-alias

atomic_uchar

Trait Implementations

atomic_short type-alias

atomic_short

Trait Implementations

atomic_ushort type-alias

atomic_ushort

Trait Implementations

atomic_int type-alias

atomic_int

Trait Implementations

atomic_uint type-alias

atomic_uint

Trait Implementations

atomic_long type-alias

atomic_long

Trait Implementations

atomic_ulong type-alias

atomic_ulong

Trait Implementations

atomic_llong type-alias

atomic_llong

Trait Implementations

atomic_ullong type-alias

atomic_ullong

Trait Implementations

atomic_char16_t type-alias

atomic_char16_t

Trait Implementations

atomic_char32_t type-alias

atomic_char32_t

Trait Implementations

atomic_wchar_t type-alias

atomic_wchar_t

Trait Implementations

atomic_int_least8_t type-alias

atomic_int_least8_t

Trait Implementations

atomic_uint_least8_t type-alias

atomic_uint_least8_t

Trait Implementations

atomic_int_least16_t type-alias

atomic_int_least16_t

Trait Implementations

atomic_uint_least16_t type-alias

atomic_uint_least16_t

Trait Implementations

atomic_int_least32_t type-alias

atomic_int_least32_t

Trait Implementations

atomic_uint_least32_t type-alias

atomic_uint_least32_t

Trait Implementations

atomic_int_least64_t type-alias

atomic_int_least64_t

Trait Implementations

atomic_uint_least64_t type-alias

atomic_uint_least64_t

Trait Implementations

atomic_int_fast8_t type-alias

atomic_int_fast8_t

Trait Implementations

atomic_uint_fast8_t type-alias

atomic_uint_fast8_t

Trait Implementations

atomic_int_fast16_t type-alias

atomic_int_fast16_t

Trait Implementations

atomic_uint_fast16_t type-alias

atomic_uint_fast16_t

Trait Implementations

atomic_int_fast32_t type-alias

atomic_int_fast32_t

Trait Implementations

atomic_uint_fast32_t type-alias

atomic_uint_fast32_t

Trait Implementations

atomic_int_fast64_t type-alias

atomic_int_fast64_t

Trait Implementations

atomic_uint_fast64_t type-alias

atomic_uint_fast64_t

Trait Implementations

atomic_intptr_t type-alias

atomic_intptr_t

Trait Implementations

atomic_uintptr_t type-alias

atomic_uintptr_t

Trait Implementations

atomic_size_t type-alias

atomic_size_t

Trait Implementations

atomic_ptrdiff_t type-alias

atomic_ptrdiff_t

Trait Implementations

atomic_intmax_t type-alias

atomic_intmax_t

Trait Implementations

atomic_uintmax_t type-alias

atomic_uintmax_t

Trait Implementations

memory_order type-alias

memory_order

atomic_flag type-alias

atomic_flag

Functions

atomic_init function

fn(obj : *(atomic_bool), value : bool) -> unit

Parameters

Name	Type	Notes
`obj`	*(atomic_bool)
`value`	bool

Returns: unit

atomic_load function

fn(obj : *(atomic_bool)) -> bool

Parameters

Name	Type	Notes
`obj`	*(atomic_bool)

Returns: bool

atomic_load_explicit function

fn(obj : *(atomic_bool), order : memory_order) -> bool

Parameters

Name	Type	Notes
`obj`	*(atomic_bool)
`order`	memory_order

Returns: bool

atomic_store function

fn(obj : *(atomic_bool), desired : bool) -> unit

Parameters

Name	Type	Notes
`obj`	*(atomic_bool)
`desired`	bool

Returns: unit

atomic_store_explicit function

fn(obj : *(atomic_bool), desired : bool, order : memory_order) -> unit

Parameters

Name	Type	Notes
`obj`	*(atomic_bool)
`desired`	bool
`order`	memory_order

Returns: unit

atomic_exchange function

fn(obj : *(atomic_bool), desired : bool) -> bool

Parameters

Name	Type	Notes
`obj`	*(atomic_bool)
`desired`	bool

Returns: bool

atomic_exchange_explicit function

fn(obj : *(atomic_bool), desired : bool, order : memory_order) -> bool

Parameters

Name	Type	Notes
`obj`	*(atomic_bool)
`desired`	bool
`order`	memory_order

Returns: bool

atomic_compare_exchange_strong function

fn(obj : *(atomic_bool), expected : *(bool), desired : bool) -> bool

Parameters

Name	Type	Notes
`obj`	*(atomic_bool)
`expected`	*(bool)
`desired`	bool

Returns: bool

atomic_compare_exchange_strong_explicit function

fn(obj : *(atomic_bool), expected : *(bool), desired : bool, success : memory_order, failure : memory_order) -> bool

Parameters

Name	Type	Notes
`obj`	*(atomic_bool)
`expected`	*(bool)
`desired`	bool
`success`	memory_order
`failure`	memory_order

Returns: bool

atomic_compare_exchange_weak function

fn(obj : *(atomic_bool), expected : *(bool), desired : bool) -> bool

Parameters

Name	Type	Notes
`obj`	*(atomic_bool)
`expected`	*(bool)
`desired`	bool

Returns: bool

atomic_compare_exchange_weak_explicit function

fn(obj : *(atomic_bool), expected : *(bool), desired : bool, success : memory_order, failure : memory_order) -> bool

Parameters

Name	Type	Notes
`obj`	*(atomic_bool)
`expected`	*(bool)
`desired`	bool
`success`	memory_order
`failure`	memory_order

Returns: bool

atomic_fetch_add function

fn(obj : *(atomic_int), arg : int) -> int

Parameters

Name	Type	Notes
`obj`	*(atomic_int)
`arg`	int

Returns: int

atomic_fetch_add_explicit function

fn(obj : *(atomic_int), arg : int, order : memory_order) -> int

Parameters

Name	Type	Notes
`obj`	*(atomic_int)
`arg`	int
`order`	memory_order

Returns: int

atomic_fetch_sub function

fn(obj : *(atomic_int), arg : int) -> int

Parameters

Name	Type	Notes
`obj`	*(atomic_int)
`arg`	int

Returns: int

atomic_fetch_sub_explicit function

fn(obj : *(atomic_int), arg : int, order : memory_order) -> int

Parameters

Name	Type	Notes
`obj`	*(atomic_int)
`arg`	int
`order`	memory_order

Returns: int

atomic_fetch_or function

fn(obj : *(atomic_int), arg : int) -> int

Parameters

Name	Type	Notes
`obj`	*(atomic_int)
`arg`	int

Returns: int

atomic_fetch_or_explicit function

fn(obj : *(atomic_int), arg : int, order : memory_order) -> int

Parameters

Name	Type	Notes
`obj`	*(atomic_int)
`arg`	int
`order`	memory_order

Returns: int

atomic_fetch_xor function

fn(obj : *(atomic_int), arg : int) -> int

Parameters

Name	Type	Notes
`obj`	*(atomic_int)
`arg`	int

Returns: int

atomic_fetch_xor_explicit function

fn(obj : *(atomic_int), arg : int, order : memory_order) -> int

Parameters

Name	Type	Notes
`obj`	*(atomic_int)
`arg`	int
`order`	memory_order

Returns: int

atomic_fetch_and function

fn(obj : *(atomic_int), arg : int) -> int

Parameters

Name	Type	Notes
`obj`	*(atomic_int)
`arg`	int

Returns: int

atomic_fetch_and_explicit function

fn(obj : *(atomic_int), arg : int, order : memory_order) -> int

Parameters

Name	Type	Notes
`obj`	*(atomic_int)
`arg`	int
`order`	memory_order

Returns: int

atomic_load_ptr function

fn(obj : *(*(void))) -> *(void)

Parameters

Name	Type	Notes
`obj`	((void))

Returns: *(void)

atomic_store_ptr function

fn(obj : *(*(void)), desired : *(void)) -> unit

Parameters

Name	Type	Notes
`obj`	((void))
`desired`	*(void)

Returns: unit

atomic_exchange_ptr function

fn(obj : *(*(void)), desired : *(void)) -> *(void)

Parameters

Name	Type	Notes
`obj`	((void))
`desired`	*(void)

Returns: *(void)

atomic_compare_exchange_strong_ptr function

fn(obj : *(*(void)), expected : *(*(void)), desired : *(void)) -> bool

Parameters

Name	Type	Notes
`obj`	((void))
`expected`	((void))
`desired`	*(void)

Returns: bool

atomic_compare_exchange_weak_ptr function

fn(obj : *(*(void)), expected : *(*(void)), desired : *(void)) -> bool

Parameters

Name	Type	Notes
`obj`	((void))
`expected`	((void))
`desired`	*(void)

Returns: bool

atomic_flag_test_and_set function

fn(obj : *(atomic_flag)) -> bool

Parameters

Name	Type	Notes
`obj`	*(atomic_flag)

Returns: bool

atomic_flag_test_and_set_explicit function

fn(obj : *(atomic_flag), order : memory_order) -> bool

Parameters

Name	Type	Notes
`obj`	*(atomic_flag)
`order`	memory_order

Returns: bool

atomic_flag_clear function

fn(obj : *(atomic_flag)) -> unit

Parameters

Name	Type	Notes
`obj`	*(atomic_flag)

Returns: unit

atomic_flag_clear_explicit function

fn(obj : *(atomic_flag), order : memory_order) -> unit

Parameters

Name	Type	Notes
`obj`	*(atomic_flag)
`order`	memory_order

Returns: unit

atomic_thread_fence function

fn(order : memory_order) -> unit

Parameters

Name	Type	Notes
`order`	memory_order

Returns: unit

atomic_signal_fence function

fn(order : memory_order) -> unit

Parameters

Name	Type	Notes
`order`	memory_order

Returns: unit

atomic_is_lock_free function

fn(obj : *(atomic_bool)) -> bool

Parameters

Name	Type	Notes
`obj`	*(atomic_bool)

Returns: bool

kill_dependency function

fn(y : i32) -> i32

Parameters

Name	Type	Notes
`y`	i32

Returns: i32

Constants

memory_order_relaxed constant memory_order

Value: <unknown: memory_order>

memory_order_consume constant memory_order

Value: <unknown: memory_order>

memory_order_acquire constant memory_order

Value: <unknown: memory_order>

memory_order_release constant memory_order

Value: <unknown: memory_order>

memory_order_acq_rel constant memory_order

Value: <unknown: memory_order>

memory_order_seq_cst constant memory_order

Value: <unknown: memory_order>

ATOMIC_BOOL_LOCK_FREE constant i32

Value: <unknown: i32>

ATOMIC_CHAR_LOCK_FREE constant i32

Value: <unknown: i32>

ATOMIC_CHAR16_T_LOCK_FREE constant i32

Value: <unknown: i32>

ATOMIC_CHAR32_T_LOCK_FREE constant i32

Value: <unknown: i32>

ATOMIC_WCHAR_T_LOCK_FREE constant i32

Value: <unknown: i32>

ATOMIC_SHORT_LOCK_FREE constant i32

Value: <unknown: i32>

ATOMIC_INT_LOCK_FREE constant i32

Value: <unknown: i32>

ATOMIC_LONG_LOCK_FREE constant i32

Value: <unknown: i32>

ATOMIC_LLONG_LOCK_FREE constant i32

Value: <unknown: i32>

ATOMIC_POINTER_LOCK_FREE constant i32

Value: <unknown: i32>