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

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

メモリ管理ライブラリ

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まで*)

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_store_explicit と同様に、mo が std::memory_order_acquire または 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 は意図しない失敗をする可能性があります。

expected がヌルポインタである場合、または 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。

備考

これらの関数は通常、ポインタ値をキーとして使用するグローバルハッシュテーブルに格納されたミューテックスを使用して実装されます。

Concurrency 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++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 2172	C++11	expected がヌルポインタである可能性がある	この場合、動作は未定義である
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)	アトミックオブジェクトの値と非アトミックな引数をアトミックに比較し、等しければアトミック交換を、そうでなければアトミックロードを実行する (関数テンプレート)