命名空间
变体
操作

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

来自 cppreference.cn
< cpp‎ | 内存‎ | 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_loadstd::atomic_store 等)的重载。

请注意,shared_ptr 的控制块是线程安全的:可以使用可变操作(例如 operator=reset)同时由多个线程访问不同的 std::shared_ptr 对象,即使这些实例是副本,并且内部共享相同的控制块。

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++ 标准。

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

[编辑] 另请参阅

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