std::atomic_is_lock_free, ATOMIC_xxx_LOCK_FREE

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Atomic operations library

Types

atomic (C++11)

atomic_ref (C++20)

Functions

atomic_storeatomic_store_explicit (C++11)(C++11)

atomic_loadatomic_load_explicit (C++11)(C++11)

atomic_exchangeatomic_exchange_explicit (C++11)(C++11)

atomic_compare_exchange_weakatomic_compare_exchange_weak_explicitatomic_compare_exchange_strongatomic_compare_exchange_strong_explicit (C++11)(C++11)(C++11)(C++11)

atomic_fetch_addatomic_fetch_add_explicit (C++11)(C++11)

atomic_fetch_subatomic_fetch_sub_explicit (C++11)(C++11)

atomic_fetch_andatomic_fetch_and_explicit (C++11)(C++11)

atomic_fetch_oratomic_fetch_or_explicit (C++11)(C++11)

atomic_fetch_xoratomic_fetch_xor_explicit (C++11)(C++11)

atomic_is_lock_free (C++11)

atomic_waitatomic_wait_explicit (C++20)(C++20)

atomic_notify_one (C++20)

atomic_notify_all (C++20)

Atomic flags

atomic_flag (C++11)

atomic_flag_test_and_setatomic_flag_test_and_set_explicit (C++11)(C++11)

atomic_flag_clearatomic_flag_clear_explicit (C++11)(C++11)

atomic_flag_testatomic_flag_test_explicit (C++20)(C++20)

atomic_flag_waitatomic_flag_wait_explicit (C++20)(C++20)

atomic_flag_notify_one (C++20)

atomic_flag_notify_all (C++20)

Initialization

atomic_init (C++11)(deprecated in C++20)

ATOMIC_VAR_INIT (C++11)(deprecated in C++20)

ATOMIC_FLAG_INIT (C++11)(deprecated in C++20)

Memory ordering

memory_order (C++11)

kill_dependency (C++11)

atomic_thread_fence (C++11)

atomic_signal_fence (C++11)

 

Defined in header <atomic>
template< class Atomic > bool atomic_is_lock_free(const volatile Atomic* obj)	(1)	(since C++11)
template< class Atomic > bool atomic_is_lock_free(const Atomic* obj)	(2)	(since C++11)
#define ATOMIC_CHAR_LOCK_FREE     /* unspecified */ #define ATOMIC_CHAR16_T_LOCK_FREE /* unspecified */ #define ATOMIC_CHAR32_T_LOCK_FREE /* unspecified */ #define ATOMIC_WCHAR_T_LOCK_FREE  /* unspecified */ #define ATOMIC_SHORT_LOCK_FREE    /* unspecified */ #define ATOMIC_INT_LOCK_FREE      /* unspecified */ #define ATOMIC_LONG_LOCK_FREE     /* unspecified */ #define ATOMIC_LLONG_LOCK_FREE    /* unspecified */ #define ATOMIC_POINTER_LOCK_FREE  /* unspecified */	(3)	(since C++11)

1-2) Determines if the atomic object pointed to by obj is implemented lock-free, as if by calling obj->is_lock_free()

3) Expands to an integer constant expression with value ​0​ for the built-in atomic types that are never lock-free, to 1 for the built-in atomic types that are sometimes lock-free, and to 2 for the built-in atomic types that are always lock-free.

Notes

All atomic types except for std::atomic_flag may be implemented using mutexes or other locking operations, rather than using the lock-free atomic CPU instructions. Atomic types are also allowed to be sometimes lock-free, e.g. if only aligned memory accesses are naturally atomic on a given architecture, misaligned objects of the same type have to use locks. If the type is sometimes lock-free, then the function (1-2) or its member function equivalent has to be used to determine if the particular instance is lock-free.

Parameters

obj

-

pointer to the atomic object to examine

Return value

true if *obj is a lock-free atomic, false otherwise.

Exceptions

noexcept specification:  

noexcept

  

See also

is_lock_free	checks if the atomic object is lock-free (public member function of std::atomic<T>)
std::atomic_is_lock_free(std::shared_ptr)	specializes atomic operations for std::shared_ptr (function template)
atomic_flag (C++11)	the lock-free boolean atomic type (class)