std::atomic<T>::is_lock_free
From cppreference.com
C++
Feature test macros (C++20)
Concepts library (C++20)
Metaprogramming library (C++11)
Ranges library (C++20)
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Concurrency support library
(C++11)
(C++20)
(C++11)
(C++11)
(C++20)
(C++26)
(C++26)
(C++20)
(C++26)
(C++20)
(C++26)
(C++26)
(C++26)
(C++26)
(C++26)
(C++26)
(C++11)
(C++11)
(C++17)
(C++11)
(C++14)
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)(C++11)(C++11)(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++20)(C++20)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++26)
(C++26)
(C++26)
(C++11)
(C++20)
(C++11)
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
(C++11)
(C++11)
(C++11)(deprecated in C++26)
(C++11)
(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++26)(C++26)
(C++26)(C++26)
(C++11)
(C++20)(C++20)
(C++20)
(C++20)
(C++11)(C++11)
(C++11)(C++11)
(C++20)(C++20)
(C++20)(C++20)
(C++20)
(C++20)
std::atomic
atomic::is_lock_free
(C++20)
(C++20)
(C++20)
(C++17)
(C++26)
(C++26)
bool is_lock_free() const noexcept;
(1)
(since C++11)
bool is_lock_free() const volatile noexcept;
(2)
(since C++11)
Checks whether the atomic operations on all objects of this type are lock-free.
Contents
[edit] Parameters
(none)
[edit] Return value
true if the atomic operations on the objects of this type are lock-free, false otherwise.
[edit] 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.
The C++ standard recommends (but does not require) that lock-free atomic operations are also address-free, that is, suitable for communication between processes using shared memory.
[edit] Example
Run this code
#include <atomic> #include <iostream> #include <utility> struct A { int a[100]; }; struct B { int x, y; }; int main() { std::cout << std::boolalpha << "std::atomic<A> is lock free? " << std::atomic <A>{}.is_lock_free() << '\n' << "std::atomic<B> is lock free? " << std::atomic <B>{}.is_lock_free() << '\n'; }
Possible output:
std::atomic<A> is lock free? false std::atomic<B> is lock free? true