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

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持（基本类型、RTTI） 库功能特性测试宏 (C++20) 动态内存管理 程序工具 协程支持 (C++20) 变参数函数 is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) 调试支持 is_debugger_present (C++26) breakpoint_if_debugging (C++26) breakpoint (C++26) 三路比较 three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)    is_eqis_ltis_lteq (C++20)(C++20)(C++20) is_neqis_gtis_gteq (C++20)(C++20)(C++20)

通用工具 日期和时间 函数对象 格式化库 (C++20) bitset hash (C++11) 关系运算符 (C++20 中弃用) rel_ops::operator!=rel_ops::operator>     rel_ops::operator<=rel_ops::operator>= 整数比较函数 cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)    cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) 交换与类型运算 swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) 常用词汇类型 pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

动态内存管理

未初始化内存算法 uninitialized_copy uninitialized_fill uninitialized_move (C++17) uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) destroy (C++17) destroy_at (C++17) voidify (C++20) uninitialized_copy_n (C++11) uninitialized_fill_n uninitialized_move_n (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17) destroy_n (C++17) construct_at (C++20) 受约束的未初始化内存算法 ranges::uninitialized_copy (C++20) ranges::uninitialized_fill (C++20) ranges::uninitialized_move (C++20) ranges::construct_at (C++20) ranges::destroy (C++20) ranges::destroy_n (C++20) ranges::destroy_at (C++20) ranges::uninitialized_copy_n (C++20) ranges::uninitialized_fill_n (C++20) ranges::uninitialized_move_n (C++20) ranges::uninitialized_default_construct (C++20) ranges::uninitialized_value_construct (C++20) ranges::uninitialized_default_construct_n (C++20)   ranges::uninitialized_value_construct_n (C++20) 分配器 allocator allocator_traits (C++11) allocation_result (C++23) allocator_arg (C++11) uses_allocator (C++11) uses_allocator_construction_args (C++20) make_obj_using_allocator (C++20) uninitialized_construct_using_allocator (C++20) scoped_allocator_adaptor (C++11) pmr::polymorphic_allocator (C++17) 内存资源 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) 垃圾收集器支持 declare_reachable (C++11)(C++23 前) undeclare_reachable (C++11)(C++23 前) declare_no_pointers (C++11)(C++23 前) undeclare_no_pointers (C++11)(C++23 前) pointer_safety (C++11)(C++23 前) get_pointer_safety (C++11)(C++23 前) 未初始化存储 raw_storage_iterator (C++20 前*) get_temporary_buffer (C++20 前*) return_temporary_buffer (C++20 前*) 显式生存期管理 start_lifetime_asstart_lifetime_as_array (C++23)(C++23)

智能指针 unique_ptr (C++11) shared_ptr (C++11) weak_ptr (C++11) auto_ptr (C++17 前*) owner_less (C++11) owner_less<void> (C++17) owner_hash (C++26) owner_equal (C++26) enable_shared_from_this (C++11) bad_weak_ptr (C++11) default_delete (C++11) out_ptr_t (C++23) inout_ptr_t (C++23) 低层内存管理 operator new operator new[] operator delete operator delete[] get_new_handler (C++11) set_new_handler launder (C++17) bad_alloc bad_array_new_length (C++11) nothrow_t align_val_t (C++17) destroying_delete_t (C++20) new_handler nothrow 杂项 pointer_traits (C++11) to_address (C++20) addressof (C++11) align (C++11) assume_aligned (C++20) C 库 malloc calloc realloc    aligned_alloc (C++17) free

 

std::shared_ptr

成员函数

shared_ptr::shared_ptr

shared_ptr::~shared_ptr

shared_ptr::operator=

修改器

shared_ptr::reset

shared_ptr::swap

观察器

shared_ptr::get

shared_ptr::operator*shared_ptr::operator->

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

shared_ptr::use_count

shared_ptr::unique (C++20 前*)

shared_ptr::operator bool

shared_ptr::owner_before

shared_ptr::owner_hash (C++26)

shared_ptr::owner_equal (C++26)

非成员函数

swap(std::shared_ptr)

make_sharedmake_shared_for_overwrite (C++20)

allocate_sharedallocate_shared_for_overwrite (C++20)

static_pointer_castdynamic_pointer_castconst_pointer_castreinterpret_pointer_cast (C++17)

get_deleter

operator==operator!=operator<operator<=operator>operator>=operator<=> (C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20)

operator<<

atomic_xxx 函数 (C++26 前*)

辅助类

atomic<std::shared_ptr> (C++20)

hash<std::shared_ptr>

推导指引(C++17)

 

在标头 <memory> 定义
template< class T > bool atomic_is_lock_free( const std::shared_ptr<T>* p );	(1)	(C++11 起) (C++20 中弃用) (C++26 中移除)
template< class T > std::shared_ptr<T> atomic_load( const std::shared_ptr<T>* p );	(2)	(C++11 起) (C++20 中弃用) (C++26 中移除)
template< class T > std::shared_ptr<T> atomic_load_explicit     ( const std::shared_ptr<T>* p, std::memory_order mo );	(3)	(C++11 起) (C++20 中弃用) (C++26 中移除)
template< class T > void atomic_store( std::shared_ptr<T>* p, std::shared_ptr<T> r );	(4)	(C++11 起) (C++20 中弃用) (C++26 中移除)
template< class T > void atomic_store_explicit     ( std::shared_ptr<T>* p, std::shared_ptr<T> r,       std::memory_order mo );	(5)	(C++11 起) (C++20 中弃用) (C++26 中移除)
template< class T > std::shared_ptr<T> atomic_exchange     ( std::shared_ptr<T>* p, std::shared_ptr<T> r );	(6)	(C++11 起) (C++20 中弃用) (C++26 中移除)
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)	(C++11 起) (C++20 中弃用) (C++26 中移除)
template< class T > bool atomic_compare_exchange_weak     ( std::shared_ptr<T>* p, std::shared_ptr<T>* expected,       std::shared_ptr<T> desired );	(8)	(C++11 起) (C++20 中弃用) (C++26 中移除)
template< class T > bool atomic_compare_exchange_strong     ( std::shared_ptr<T>* p, std::shared_ptr<T>* expected,       std::shared_ptr<T> desired );	(9)	(C++11 起) (C++20 中弃用) (C++26 中移除)
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)	(C++11 起) (C++20 中弃用) (C++26 中移除)
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)	(C++11 起) (C++20 中弃用) (C++26 中移除)

如果多个执行线程无同步地访问同一 std::shared_ptr 对象，而其中由任何访问使用了 shared_ptr 的非 const 成员函数，那么就会发生数据竞争，除非所有这种访问都通过这些作为对应原子访问函数（std::atomic_load、std::atomic_store 等）重载的函数进行。

注意 shared_ptr 的控制块是线程安全的：多个线程能同时用可改操作访问不同的 std::shared_ptr 对象，如 operator= 或 reset，即使这些实例都是副本，并内部共享同一控制块也是如此。

1) 确定到 p 指向的共享指针的原子访问是否无锁。

2) 等价于 atomic_load_explicit(p, std::memory_order_seq_cst)。

3) 返回 p 指向的共享指针。

与未特化的 std::atomic_load_explicit 相同，如果 mo 是 std::memory_order_release 或 std::memory_order_acq_rel，那么行为未定义。

4) 等价于 atomic_store_explicit(p, r, std::memory_order_seq_cst)。

5) 将共享指针 r 原子地存储到 p 指向的共享指针，等价于 p->swap(r)。

与未特化的 std::atomic_load_explicit 相同，如果 mo 是 std::memory_order_release 或 std::memory_order_acq_rel，那么行为未定义。

6) 等价于 atomic_exchange_explicit(p, r, std::memory_order_seq_cst)。

7) 将共享指针 r 原子地存储到 p 指向的共享指针，并返回 p 先前指向的值。等价于 p->swap(r) 并返回交换后 r 的副本。

8) 等价于

atomic_compare_exchange_weak_explicit
    (p, expected, desired, std::memory_order_seq_cst,
                           std::memory_order_seq_cst)。

9) 等价于

atomic_compare_exchange_strong_explicit
    (p, expected, desired, std::memory_order_seq_cst,
                           std::memory_order_seq_cst)。

10,11) 比较 p 和 expected 指向的共享指针。

• 如果它们等价（存储同一指针值，共享同一对象的所有权或均为空），那么用 success 指定的内存定序制约将 desired 赋给 *p 并返回 true。
• 如果它们不等价，那么用 failure 指定的内存定序制约将 *p 赋给 *expected 并返回 false。

atomic_compare_exchange_weak_explicit 可能会虚假地失败。

如果 exptected 是空指针，或者 failure 是 std::memory_order_release 或 std::memory_order_acq_rel，那么行为未定义。

如果 p 是空指针，那么这些函数的行为均未定义。

参数

p, expected	-	指向 std::shared_ptr 的指针
r, desired	-	一个 std::shared_ptr
mo, success, failure	-	std::memory_order 类型的内存定序选择符

异常

这些函数不会抛出异常。

返回值

1) 在原子访问使用无锁指令时返回 true。

2,3) 被指向的共享指针的副本。

4,5) （无）

6,7) 先前被指向的共享指针的副本

8-11) 在共享指针等价并进行了交换时返回 true，否则返回 false。

注解

这些函数典型地利用互斥体实现，互斥体存储于一个全局散列表中，其中以指针值为键。

并发 TS 提供原子智能指针类 atomic_shared_ptr 和 atomic_weak_ptr 作为使用这些函数的替代品。

这些函数被弃用，取代者是 std::atomic 模板的特化：std::atomic<std::shared_ptr> 和 std::atomic<std::weak_ptr>。	(C++20 起) (C++26 前)
这些函数被删除，取代者是 std::atomic 模板的特化：std::atomic<std::shared_ptr> 和 std::atomic<std::weak_ptr>。	(C++26 起)

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告	应用于	出版时的行为	正确行为
LWG 2980	C++11	空的 shared_ptr 决不等价	在它们存储同一指针值的情况下等价

参阅

atomic_is_lock_free (C++11)	检查该原子类型的操作是否是免锁的 (函数模板)
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)	原子地比较原子对象和非原子实参的值，相等时进行原子交换，不相等时进行原子加载 (函数模板)