atomic_flag_test_and_set, atomic_flag_test_and_set_explicit

 

C

Compiler support

Language

Headers

Type support

Program utilities

Variadic function support

Error handling

Dynamic memory management

Strings library

Algorithms

Numerics

Date and time utilities

Input/output support

Localization support

Concurrency support (C11)

Technical Specifications

Symbol index

 

Concurrency support library

Threads thrd_create thrd_equal thrd_current    thrd_sleep thrd_yield thrd_exit thrd_detach thrd_join thrd_successthrd_timedoutthrd_busythrd_nomemthrd_error    Atomic operations atomic_init ATOMIC_VAR_INIT (until C23) ATOMIC_***_LOCK_FREE atomic_is_lock_free atomic_store atomic_load atomic_exchange atomic_compare_exchange atomic_fetch_add atomic_fetch_sub atomic_fetch_or atomic_fetch_xor atomic_fetch_and

Atomic flags atomic_flag ATOMIC_FLAG_INIT atomic_flag_test_and_set atomic_flag_clear Memory ordering memory_order kill_dependency atomic_thread_fence atomic_signal_fence Mutual exclusion mtx_init mtx_lock mtx_timedlock mtx_trylock call_once mtx_unlock mtx_destroy mtx_plainmtx_recursivemtx_timed Condition variables cnd_init cnd_signal cnd_broadcast cnd_wait cnd_timedwait cnd_destroy Thread-local storage thread_local TSS_DTOR_ITERATIONS    tss_create tss_get tss_set tss_delete

 

Defined in header <stdatomic.h>
_Bool atomic_flag_test_and_set( volatile atomic_flag* obj );	(1)	(since C11)
_Bool atomic_flag_test_and_set_explicit( volatile atomic_flag* obj, memory_order order );	(2)	(since C11)

Atomically changes the state of a atomic_flag pointed to by obj to set (true) and returns the previous value. The first version orders memory accesses according to memory_order_seq_cst, the second version orders memory accesses according to order.

The argument is pointer to a volatile atomic flag to accept addresses of both non-volatile and volatile (e.g. memory-mapped I/O) atomic flags.

Parameters

obj	-	pointer to the atomic flag object to modify
order	-	the memory synchronization ordering for this operation: all values are permitted

Return value

The previous value held by the atomic flag pointed to by obj.

References

• C17 standard (ISO/IEC 9899:2018):

• 7.17.8.1 The atomic_flag_test_and_set functions (p: 209)

• C11 standard (ISO/IEC 9899:2011):

• 7.17.8.1 The atomic_flag_test_and_set functions (p: 285-286)

See also

atomic_flag_clearatomic_flag_clear_explicit (C11)	sets an atomic_flag to false (function)
C++ documentation for atomic_flag_test_and_set, atomic_flag_test_and_set_explicit