Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/atomic/atomic is lock free"

From cppreference.com
< cpp‎ | atomic
(LWG 3249)
Line 30: Line 30:
 
{{dcl end}}
 
{{dcl end}}
  
−
@1@ Determines if the atomic object pointed to by {{tt|obj}} is implemented lock-free, as if by calling {{c|obj->is_lock_free()}}. In any given program execution, the result of the lock-free query is the same for all pointers of the same type.{{mark unreviewed dr|LWG}}<!-- LWG 1146 & N2992 -->
+
@1@ Determines if the atomic object pointed to by {{tt|obj}} is implemented lock-free, as if by calling {{c|obj->is_lock_free()}}. In any given program execution, the result of the lock-free query is the same for all atomic objects of the same type.{{mark unreviewed dr|LWG}}<!-- LWG 1146 & N2992 -->
  
 
@2,3@ Expands to an integer constant expression with value
 
@2,3@ Expands to an integer constant expression with value
Line 44: Line 44:
 
===Return value===
 
===Return value===
 
{{c|true}} if {{c|*obj}} is a lock-free atomic, {{c|false}} otherwise.
 
{{c|true}} if {{c|*obj}} is a lock-free atomic, {{c|false}} otherwise.
−
 
−
 
  
 
===Notes===
 
===Notes===
Line 75: Line 73:
 
std::atomic<B> is lock free? true
 
std::atomic<B> is lock free? true
 
}}
 
}}
 +
 +
===Defect reports===
 +
{{dr list begin}}
 +
{{dr list item|wg=lwg|dr=3249|std=C++11|before={{tt|atomic_is_lock_free}} was specified via pointers, which was<br>ambiguous and might accept invalid pointer values|after=specified via atomic objects}}
 +
{{dr list end}}
  
 
===See also===
 
===See also===
 
{{dsc begin}}
 
{{dsc begin}}
−
{{dsc inc | cpp/atomic/atomic/dsc is_lock_free | mem=std::atomic<T>}}
+
{{dsc inc | cpp/atomic/atomic/dsc is_lock_free}}
 
{{dsc tfun | cpp/memory/shared_ptr/atomic | title=std::atomic_is_lock_free{{dsc small|(std::shared_ptr)}} | specializes atomic operations for {{lc|std::shared_ptr}} }}
 
{{dsc tfun | cpp/memory/shared_ptr/atomic | title=std::atomic_is_lock_free{{dsc small|(std::shared_ptr)}} | specializes atomic operations for {{lc|std::shared_ptr}} }}
 
{{dsc inc | cpp/atomic/dsc atomic_flag}}
 
{{dsc inc | cpp/atomic/dsc atomic_flag}}
Line 86: Line 89:
 
{{dsc end}}
 
{{dsc end}}
  
−
[[de:cpp/atomic/atomic is lock free]]
+
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}
−
[[es:cpp/atomic/atomic is lock free]]
+
−
[[fr:cpp/atomic/atomic is lock free]]
+
−
[[it:cpp/atomic/atomic is lock free]]
+
−
[[ja:cpp/atomic/atomic is lock free]]
+
−
[[pt:cpp/atomic/atomic is lock free]]
+
−
[[ru:cpp/atomic/atomic is lock free]]
+
−
[[zh:cpp/atomic/atomic is lock free]]
+

Revision as of 00:34, 25 November 2020

 
C++
 
Atomic operations library
Types
(C++11)
(C++20)
Functions
(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++11)(C++11)
atomic_is_lock_free
(C++11)
(C++20)(C++20)
(C++20)
(C++20)
Atomic flags
(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++20)(C++20)
(C++20)(C++20)
(C++20)
(C++20)
Initialization
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
Memory ordering
(C++11)
(C++11)
(C++11)
(C++11)
 
Defined in header <atomic>
(1) (since C++11)
template< class T >
bool atomic_is_lock_free( const volatile std::atomic<T>* obj ) noexcept;
template< class T >
bool atomic_is_lock_free( const std::atomic<T>* obj ) noexcept;
#define ATOMIC_BOOL_LOCK_FREE     /* unspecified */

#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 */
 (2) (since C++11)
#define ATOMIC_CHAR8_T_LOCK_FREE     /* unspecified */
 (3) (since C++20)
1) Determines if the atomic object pointed to by obj is implemented lock-free, as if by calling obj->is_lock_free(). In any given program execution, the result of the lock-free query is the same for all atomic objects of the same type.
2,3) Expands to an integer constant expression with value
  • ​0​ for the built-in atomic types that are never lock-free
  • 1 for the built-in atomic types that are sometimes lock-free
  • 2 for the built-in atomic types that are always lock-free.

Contents

Parameters

obj - pointer to the atomic object to examine

Return value

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

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: for example, if only some subarchitectures support lock-free atomic access for a given type (such as the CMPXCHG16B instruction on x86-64), whether atomics are lock-free may not be known until runtime.

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.

Example

Run this code
#include <iostream>
#include <utility>
#include <atomic>
 
struct A { int a[100]; };
struct B { int x, y; };
int main()
{
    std::atomic<A> a;
    std::atomic<B> b;
    std::cout << std::boolalpha
              << "std::atomic<A> is lock free? "
              << std::atomic_is_lock_free(&a) << '\n'
              << "std::atomic<B> is lock free? "
              << std::atomic_is_lock_free(&b) << '\n';
}

Possible output: 

std::atomic<A> is lock free? false
std::atomic<B> is lock free? true

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR Applied to Behavior as published Correct behavior
LWG 3249 C++11 atomic_is_lock_free was specified via pointers, which was
ambiguous and might accept invalid pointer values 		specified via atomic objects

See also

 checks if the atomic object is lock-free
(public member function of std::atomic<T>) [edit]
specializes atomic operations for std::shared_ptr
(function template)
(C++11)
 the lock-free boolean atomic type
(class) [edit]
[static] (C++17)
 indicates that the type is always lock-free
(public static member constant of std::atomic<T>) [edit]
C documentation for atomic_is_lock_free
C documentation for ATOMIC_*_LOCK_FREE
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/atomic/atomic_is_lock_free&oldid=124409"