命名空间
变体
操作

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

来自 cppreference.cn
< cpp‎ | memory‎ | shared ptr
 
 
内存管理库
(仅为阐述目的*)
未初始化内存算法
(C++17)
(C++17)
(C++17)
受约束的未初始化
内存算法
C 库

分配器
内存资源
垃圾回收支持
(C++11)(直到 C++23)
(C++11)(直到 C++23)
(C++11)(直到 C++23)
(C++11)(直到 C++23)
(C++11)(直到 C++23)
(C++11)(直到 C++23)
未初始化存储
(直到 C++20*)
(直到 C++20*)
显式生命周期管理
 
 
定义于头文件 <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 一样,如果 mostd::memory_order_releasestd::memory_order_acq_rel,则行为未定义。
4) 等价于 atomic_store_explicit(p, r, std::memory_order_seq_cst)
5) 以原子方式将共享指针 r 存储到 p 指向的共享指针中,如同 通过 p->swap(r)
与非特化的 std::atomic_store_explicit 一样,如果 mostd::memory_order_acquirestd::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) 比较 pexpected 指向的共享指针。
  • 如果它们等价(存储相同的指针值,并且要么共享同一对象的所有权,要么都为空),则使用 success 指定的内存顺序约束将 desired 赋值给 *p,并返回 true
  • 如果它们不等价,则使用 failure 指定的内存顺序约束将 *p 赋值给 *expected,并返回 false
atomic_compare_exchange_weak_explicit 可能发生伪失败。
如果 expected 是空指针,或者 failurestd::memory_order_releasestd::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_ptratomic_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++ 标准。

DR 应用于 已发布行为 正确行为
LWG 2172 C++11 expected 可以是空指针 在这种情况下,行为未定义
LWG 2980 C++11 空的 shared_ptr 永远不等价 如果它们存储相同的指针值则等价

[编辑] 参见

检查原子类型的操作是否是无锁的
(函数模板) [编辑]
使用非原子参数原子地替换原子对象的值
(函数模板) [编辑]
原子地获取存储在原子对象中的值
(函数模板) [编辑]
使用非原子参数原子地替换原子对象的值,并返回原子的旧值
(函数模板) [编辑]
原子地将原子对象的值与非原子参数进行比较,如果相等则执行原子交换,否则执行原子加载
(函数模板) [编辑]