std::atomic<std::shared_ptr>

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

記憶體管理庫

voidify (僅作說明*) 未初始化記憶體演算法 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) 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) C 庫 malloc calloc realloc aligned_alloc (C++17) free

分配器 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) is_sufficiently_aligned (C++26)

 

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之前已棄用，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<=> (until C++20)(until C++20)(until C++20)(until C++20)(until C++20)(C++20)

operator<<

atomic_xxx 函式 (C++20中已棄用，C++26中移除*)

輔助類

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

hash<std::shared_ptr>

推導指南(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 的控制塊是執行緒安全的：可以使用可變操作（例如 operator= 或 reset）同時由多個執行緒訪問不同的非原子 std::shared_ptr 物件，即使這些例項是副本，並且內部共享同一個控制塊。

型別 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

std::shared_ptr<T> load( std::memory_order order = std::memory_order_seq_cst ) const noexcept;

原子性地返回底層共享指標的副本。記憶體按 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<T> 替換為 desired，如同透過 p.swap(desired)，其中 p 是底層 std::shared_ptr<T>，並返回 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 相同的 T* 並與其共享所有權，或者如果底層和 expected 都為空，則將 desired 賦值給底層 std::shared_ptr<T>，返回 true，並根據 success 排序記憶體；否則將底層 std::shared_ptr<T> 賦值給 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;

執行原子通知操作。

如果存在被原子等待操作（即 wait()）阻塞在 *this 上的執行緒，則至少解除阻塞一個這樣的執行緒；否則不執行任何操作。

atomic<shared_ptr<T>>::notify_all

void notify_all() noexcept;

執行原子通知操作。

解除阻塞所有被原子等待操作（即 wait()）阻塞在 *this 上的執行緒（如果存在）；否則不執行任何操作。

成員常量

此特化也提供了唯一的標準 std::atomic 成員常量 is_always_lock_free。

atomic<shared_ptr<T>>::is_always_lock_free

static constexpr bool is_always_lock_free = /*implementation-defined*/;

備註

特性測試宏	值	標準	特性
__cpp_lib_atomic_shared_ptr	201711L	(C++20)	std::atomic<std::shared_ptr>

缺陷報告

下列更改行為的缺陷報告追溯地應用於以前出版的 C++ 標準。

缺陷報告	應用於	釋出時的行為	正確的行為
LWG 3661	C++20	atomic<shared_ptr<T>> 不能從 nullptr 常量初始化	已改為可常量初始化
LWG 3893	C++20	LWG3661 使得 atomic<shared_ptr<T>> 不能從 nullptr_t 賦值	賦值能力已恢復

參閱

atomic (C++11)

atomic 類模板和針對 bool、整型、浮點型(C++20 起) 和指標型別的特化 (類模板)