命名空间
变体
操作

std::atomic<std::shared_ptr>

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

分配器
(C++11)
(C++23)
(C++11)
(C++11)
(C++20)
(C++20)
(C++20) 
(C++11)
(C++17)
内存资源
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
垃圾回收支持
(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*)
(直到 C++20*)
显式生命周期管理
(C++23)(C++23)
 
std::shared_ptr
成员函数
修改器
观察器
(C++17)
(直到 C++20*)
(C++26)
(C++26)
非成员函数
(C++20)
(C++20)
(C++17)
(直到 C++20)(直到 C++20)(直到 C++20)(直到 C++20)(直到 C++20)(C++20)
函数 (直到 C++26*)
辅助类
atomic<std::shared_ptr>
(C++20)
推导指引(C++17)
 
定义于头文件 <memory>
template< class T >
struct std::atomic<std::shared_ptr<T>>;
 (自 C++20 起)

std::atomic 的 std::shared_ptr<T> 的部分模板特化允许用户以原子方式操作 shared_ptr 对象。

如果多个执行线程在没有同步的情况下访问同一个 std::shared_ptr 对象，并且任何此类访问使用了 shared_ptr 的非 const 成员函数，则会发生数据竞争，除非所有此类访问都通过 std::atomic<std::shared_ptr> 的实例执行（或者，自 C++20 起已弃用，通过用于原子访问 std::shared_ptr 的 独立函数）。

关联的 use_count 增量保证是原子操作的一部分。关联的 use_count 减量在原子操作之后排序，但不要求是原子操作的一部分，除非在失败的 CAS 中覆盖 expected 时的 use_count 更改。任何关联的删除和释放都在原子更新步骤之后排序，并且不是原子操作的一部分。

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

类型 T 可以是不完整类型。

内容

[编辑] 成员类型

成员类型 定义
value_type std::shared_ptr<T>

[编辑] 成员函数

此特化也提供了所有非特化的 std::atomic 函数，并且没有额外的成员函数。

atomic<shared_ptr<T>>::atomic

constexpr atomic() noexcept = default;
 (1)
constexpr atomic( std::nullptr_t ) noexcept : atomic() {}
 (2)
atomic( std::shared_ptr<T> desired ) noexcept;
 (3)
atomic( const atomic& ) = delete;
 (4)
1,2) 将底层 shared_ptr<T> 初始化为 null 值。
3) 将底层 shared_ptr<T> 初始化为 desired 的副本。与任何 std::atomic 类型一样，初始化不是原子操作。
4) 原子类型不可复制/移动构造。

atomic<shared_ptr<T>>::operator=

void operator=( const atomic& ) = delete;
 (1)
void operator=( std::shared_ptr<T> desired ) noexcept;
 (2)
void operator=( std::nullptr_t ) noexcept;
 (3)
1) 原子类型不可复制/移动赋值。
2) 值赋值，等效于 store(desired)。
3) 将原子共享指针重置为 null 指针值。等效于 store(nullptr);。

atomic<shared_ptr<T>>::is_lock_free

bool is_lock_free() const noexcept;

如果对此类型的所有对象执行的原子操作都是无锁的，则返回 true，否则返回 false。

atomic<shared_ptr<T>>::store

void store( std::shared_ptr<T> desired,
            std::memory_order order = std::memory_order_seq_cst ) noexcept;

原子地将 *this 的值替换为 desired 的值，如同通过 p.swap(desired)，其中 p 是底层 std::shared_ptr<T>。内存根据 order 排序。如果 order 是 std::memory_order_consume、std::memory_order_acquire 或 std::memory_order_acq_rel，则行为未定义。

atomic<shared_ptr<T>>::load

原子地返回底层共享指针的副本。内存根据 order 排序。如果 order 是 std::memory_order_release 或 std::memory_order_acq_rel，则行为未定义。

atomic<shared_ptr<T>>::operator std::shared_ptr<T>

operator std::shared_ptr<T>() const noexcept;

等效于 return load();。

atomic<shared_ptr<T>>::exchange

std::shared_ptr<T> exchange( std::shared_ptr<T> desired,
                             std::memory_order order = std::memory_order_seq_cst ) noexcept;

原子地将底层 std::shared_ptr 替换为 desired，如同通过 p.swap(desired)，其中 p 是底层 std::shared_ptr，并返回在交换之前 p 立即拥有的值的副本。内存根据 order 排序。这是一个原子读-修改-写操作。

atomic<shared_ptr<T>>::compare_exchange_weak, compare_exchange_strong

bool compare_exchange_strong( std::shared_ptr<T>& expected, std::shared_ptr<T> desired,
                              std::memory_order success, std::memory_order failure ) noexcept;
 (1)
bool compare_exchange_weak( std::shared_ptr<T>& expected, std::shared_ptr<T> desired,
                            std::memory_order success, std::memory_order failure ) noexcept;
 (2)
bool compare_exchange_strong( std::shared_ptr<T>& expected, std::shared_ptr<T> desired,
                              std::memory_order order = std::memory_order_seq_cst ) noexcept;
 (3)
bool compare_exchange_weak( std::shared_ptr<T>& expected, std::shared_ptr<T> desired,
                            std::memory_order order = std::memory_order_seq_cst ) noexcept;
 (4)
1) 如果底层 std::shared_ptr 存储的 T* 与 expected 相同，并且与之共享所有权，或者如果底层和 expected 都为空，则从 desired 赋值到底层 std::shared_ptr，返回 true，并根据 success 对内存排序；否则，从底层 std::shared_ptr 赋值到 expected，返回 false，并根据 failure 对内存排序。如果 failure 是 std::memory_order_release 或 std::memory_order_acq_rel，则行为未定义。在成功时，操作是 *this 上的原子读-修改-写操作，并且在原子更新后不访问 expected。在失败时，操作是 *this 上的原子加载操作，并且 expected 使用从原子对象读取的现有值进行更新。对 expected 的 use_count 的此更新是此原子操作的一部分，尽管不要求写入本身（以及任何后续的释放/销毁）是原子操作的一部分。
2) 与 (1) 相同，但也可能出现伪失败。
3) 等效于：return compare_exchange_strong(expected, desired, order, fail_order);，其中 fail_order 与 order 相同，但 std::memory_order_acq_rel 被替换为 std::memory_order_acquire，std::memory_order_release 被替换为 std::memory_order_relaxed。
4) 等效于：return compare_exchange_weak(expected, desired, order, fail_order);，其中 fail_order 与 order 相同，但 std::memory_order_acq_rel 被替换为 std::memory_order_acquire，std::memory_order_release 被替换为 std::memory_order_relaxed。

atomic<shared_ptr<T>>::wait

void wait( std::shared_ptr<T> old,
           std::memory_order order = std::memory_order_seq_cst ) const noexcept;

执行原子等待操作。

将 load(order) 与 old 进行比较，如果它们等效，则阻塞，直到 *this 被 notify_one() 或 notify_all() 通知。重复此操作，直到 load(order) 更改。即使底层实现会虚假地解除阻塞，此函数也保证仅在值已更改时才返回。

内存根据 order 排序。如果 order 是 std::memory_order_release 或 std::memory_order_acq_rel，则行为未定义。

注意：如果两个 shared_ptr 存储相同的指针并且共享所有权或都为空，则它们是等效的。

atomic<shared_ptr<T>>::notify_one

void notify_one() noexcept;

执行原子通知操作。

如果存在线程阻塞在 *this 上的原子等待操作（即 wait()）中，则解除阻塞至少一个此类线程；否则，不执行任何操作。

atomic<shared_ptr<T>>::notify_all

void notify_all() noexcept;

执行原子通知操作。

解除阻塞所有阻塞在 *this 上的原子等待操作（即 wait()）中的线程（如果有）；否则，不执行任何操作。

[编辑] 成员常量

此特化也提供了唯一的标准 std::atomic 成员常量 is_always_lock_free。

atomic<shared_ptr<T>>::is_always_lock_free

static constexpr bool is_always_lock_free = /*实现定义*/;

[编辑] 注释

特性测试 宏 值 Std 特性
__cpp_lib_atomic_shared_ptr 201711L (C++20) std::atomic<std::shared_ptr>

[编辑] 示例

本节不完整
原因：没有示例

[编辑] 缺陷报告

以下行为变更缺陷报告已追溯应用于先前发布的 C++ 标准。

DR 应用于 已发布行为 正确行为
LWG 3661 C++20 atomic<shared_ptr<T>> 无法从 nullptr 常量初始化 使其可常量初始化
LWG 3893 C++20 LWG3661 使 atomic<shared_ptr<T>> 不可从 nullptr_t 赋值 恢复可赋值性

[编辑] 参见

(C++11)
 atomic 类模板以及 bool、整数、浮点、(自 C++20 起) 和指针类型的特化
(类模板) [编辑]
已从“https://cppreference.cn/mwiki/index.php?title=cpp/memory/shared_ptr/atomic2&oldid=155417”检索