std::atomic_...<std::shared_ptr>

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Utilities library

Type support (basic types, RTTI, type traits)

Dynamic memory management

Error handling

Program utilities

Variadic functions

Date and time

Function objects

initializer_list (C++11)

bitset

hash (C++11)

Relational operators

rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>=

Optional and any

optional (C++17)

any (C++17)

Pairs and tuples

pair

tuple (C++11)

apply (C++17)

piecewise_construct_t (C++11)

piecewise_construct (C++11)

integer_sequence (C++14)

Swap, forward and move

swap

exchange (C++14)

forward (C++11)

move (C++11)

move_if_noexcept (C++11)

Type operations

declval (C++11)

as_const (C++17)

 

Dynamic memory management

Smart pointers unique_ptr (C++11) shared_ptr (C++11) weak_ptr (C++11) auto_ptr (until C++17) owner_less (C++11) enable_shared_from_this (C++11) bad_weak_ptr (C++11) default_delete (C++11) Allocators allocator allocator_traits (C++11) allocator_arg_t (C++11) allocator_arg (C++11) uses_allocator (C++11) scoped_allocator_adaptor (C++11) pmr::polymorphic_allocator (C++17) Memory resources pmr::memory_resource (C++17) pmr::get_default_resource (C++17) pmr::set_default_resource (C++17) pmr::new_delete_resource (C++17) pmr::null_memory_resource (C++17) pmr::synchronized_pool_resource (C++17) pmr::unsynchronized_pool_resource (C++17) pmr::monotonic_buffer_resource (C++17) pmr::pool_options (C++17)

Uninitialized storage uninitialized_copy uninitialized_copy_n (C++11) uninitialized_fill uninitialized_fill_n raw_storage_iterator get_temporary_buffer return_temporary_buffer Garbage collection support declare_reachable (C++11) undeclare_reachable (C++11) declare_no_pointers (C++11) undeclare_no_pointers (C++11) pointer_safety (C++11) get_pointer_safety (C++11) Miscellaneous pointer_traits (C++11) addressof (C++11) align (C++11) C Library malloc calloc realloc free Low level memory management

 

std::shared_ptr

Member functions

shared_ptr::shared_ptr

shared_ptr::~shared_ptr

shared_ptr::operator=

Modifiers

shared_ptr::reset

shared_ptr::swap

Observers

shared_ptr::get

shared_ptr::operator*shared_ptr::operator->

shared_ptr::operator[] (C++17)

shared_ptr::use_count

shared_ptr::unique

shared_ptr::operator bool

shared_ptr::owner_before

Non-member functions

std::swap

make_shared

allocate_shared

static_pointer_castdynamic_pointer_castconst_pointer_castreinterpret_pointer_cast (C++17)

get_deleter

operator==operator|=operator<operator<=operator>operator>=

operator<<

atomic_is_lock_freeatomic_loadatomic_load_explicitatomic_storeatomic_store_explicitatomic_exchangeatomic_exchange_explicitatomic_compare_exchange_weakatomic_compare_exchange_strongatomic_compare_exchange_weak_explicitatomic_compare_exchange_strong_explicit

std::hash

 

template< class T > bool atomic_is_lock_free( const std::shared_ptr<T>* p );	(1)	(since C++11)
template< class T > std::shared_ptr<T> atomic_load( const std::shared_ptr<T>* p );	(2)	(since C++11)
template< class T > std::shared_ptr<T> atomic_load_explicit( const std::shared_ptr<T>* p,                                          std::memory_order mo );	(3)	(since C++11)
template< class T > void atomic_store( std::shared_ptr<T>* p,                    std::shared_ptr<T> r );	(4)	(since C++11)
template< class T > void atomic_store_explicit( std::shared_ptr<T>* p,                             std::shared_ptr<T> r,                             std::memory_order mo);	(5)	(since C++11)
template< class T > std::shared_ptr<T> atomic_exchange( std::shared_ptr<T>* p,                                     std::shared_ptr<T> r);	(6)	(since C++11)
template<class T> std::shared_ptr<T> atomic_exchange_explicit( std::shared_ptr<T>* p,                                              std::shared_ptr<T> r,                                              std::memory_order mo);	(7)	(since C++11)
template< class T > bool atomic_compare_exchange_weak( std::shared_ptr<T>* p,                                    std::shared_ptr<T>* expected,                                    std::shared_ptr<T> desired);	(8)	(since C++11)
template<class T> bool atomic_compare_exchange_strong( std::shared_ptr<T>* p,                                      std::shared_ptr<T>* expected,                                      std::shared_ptr<T> desired);	(9)	(since C++11)
template< class T > bool atomic_compare_exchange_strong_explicit( std::shared_ptr<T>* p,                                               std::shared_ptr<T>* expected,                                               std::shared_ptr<T> desired,                                               std::memory_order success,                                               std::memory_order failure);	(10)	(since C++11)
template< class T > bool atomic_compare_exchange_weak_explicit( std::shared_ptr<T>* p,                                             std::shared_ptr<T>* expected,                                             std::shared_ptr<T> desired,                                             std::memory_order success,                                             std::memory_order failure);	(11)	(since C++11)

If multiple threads of execution access the same std::shared_ptr object without synchronization and any of those accesses uses a non-const member function of shared_ptr then a data race will occur unless all such access is performed through these functions, which are overloads of the corresponding atomic access functions (std::atomic_load, std::atomic_store, etc.)

Note that the control block of a shared_ptr is thread-safe: different std::shared_ptr objects can be accessed using mutable operations, such as operator= or reset, simultaneously by multiple threads, even when these instances are copies, and share the same control block internally.

1) Determines whether atomic access to the shared pointer pointed-to by p is lock-free.

2) Equivalent to atomic_load_explicit(p, std::memory_order_seq_cst)

3) Returns the shared pointer pointed-to by p. As with the non-specialized std::atomic_load_explicit, mo cannot be std::memory_order_release or std::memory_order_acq_rel

4) Equivalent to atomic_store_explicit(p, r, memory_order_seq_cst)

5) Stores the shared pointer r in the shared pointer pointed-to by p atomically, effectively executing p->swap(r). As with the non-specialized std::atomic_store_explicit, mo cannot be std::memory_order_acquire or std::memory_order_acq_rel.

6) Equivalent to atomic_exchange_explicit(p, r, memory_order_seq_cst)

7) Stores the shared pointer r in the shared pointer pointed to by p and returns the value formerly pointed-to by p, atomically. Effectively executes p->swap(r) and returns a copy of r after the swap.

8) Equivalent to atomic_compare_exchange_weak_explicit(p, expected, desired, std::memory_order_seq_cst, std::memory_order_seq_cst)

9) Equivalent to atomic_compare_exchange_strong_explicit(p, expected, desired, std::memory_order_seq_cst, std::memory_order_seq_cst)

10) Compares the shared pointers pointed-to by p and expected. If they are equivalent (share ownership of the same pointer and refer to the same pointer), assigns desired into *p using the memory ordering constraints specified by success and returns true. If they are not equivalent, assigns *p into *expected using the memory ordering constraints specified by failure and returns false.

11) Same as 10), but may fail spuriously.

All these functions invoke undefined behavior if p is a null pointer.

Parameters

p, expected	-	a pointer to a std::shared_ptr
r, desired	-	a std::shared_ptr
mo, success, failure	-	memory ordering selectors of type std::memory_order

Exceptions

These functions do not throw exceptions.

Return value

1) true if atomic access is implemented using lock-free instructions

2,3) A copy of the pointed-to shared pointer.

4,5) (none)

6,7) A copy of the formerly pointed-to shared pointer

8,9,10,11) true if the shared pointers were equivalent and the exchange was performed, false otherwise.

Notes

The Concurrency TS offers atomic smart pointer classes atomic_shared_ptr and atomic_weak_ptr as a replacement for the use of these functions.

See also

atomic_is_lock_free (C++11)	checks if the atomic type's operations are lock-free (function template)
atomic_storeatomic_store_explicit (C++11)(C++11)	atomically replaces the value of the atomic object with a non-atomic argument (function template)
atomic_loadatomic_load_explicit (C++11)(C++11)	atomically obtains the value stored in an atomic object (function template)
atomic_exchangeatomic_exchange_explicit (C++11)(C++11)	atomically replaces the value of the atomic object with non-atomic argument and returns the old value of the atomic (function template)
atomic_compare_exchange_weakatomic_compare_exchange_weak_explicitatomic_compare_exchange_strongatomic_compare_exchange_strong_explicit (C++11)(C++11)(C++11)(C++11)	atomically compares the value of the atomic object with non-atomic argument and performs atomic exchange if equal or atomic load if not (function template)