名前空間
変種
操作

std::atomic

提供: cppreference.com
< cpp‎ | atomic
 
 
 
 
ヘッダ <atomic> で定義
template< class T >
struct atomic;
(1) (C++11およびそれ以降)
template< class T >
struct atomic<T*>;
(2) (C++11およびそれ以降)
ヘッダ <memory> で定義
template<class T>
struct atomic<std::shared_ptr<T>>;
(3) (C++20およびそれ以降)
template<class T>
struct atomic<std::weak_ptr<T>>;
(4) (C++20およびそれ以降)

std::atomic テンプレートの各実体化および完全特殊化はアトミック型を定義します。 あるスレッドがアトミックオブジェクトに書き込んでいる間に他のスレッドがそれを読み込んだ場合、その動作は well-defined となります (データ競合の詳細はメモリモデルを参照してください)。

さらに、アトミックオブジェクトへのアクセスはスレッド間の同期を確立し、 std::memory_order によって指定された非アトミックメモリアクセスを順序付けることができます。

std::atomic はコピー可能でもムーブ可能でもありません。

目次

[編集] 特殊化

[編集] プライマリテンプレート

std::atomic のプライマリテンプレートは任意の TriviallyCopyable な型 T に対して実体化できます。

struct Counters { int a; int b; }; // ユーザ定義のトリビアルにコピー可能な型
std::atomic<Counters> cnt;         // そのユーザ定義型に対する特殊化

std::atomic<bool> はプライマリテンプレートを使用します。 これは標準レイアウト構造体であることが保証されます。

[編集] 部分特殊化

標準ライブラリは以下の型に対してプライマリテンプレートが持たない追加の性質を持つ std::atomic テンプレートの部分特殊化を提供します。

2) すべてのポインタ型に対する部分特殊化 std::atomic<T*>。 これらの特殊化は標準レイアウト、トリビアルなデフォルトコンストラクタおよびトリビアルなデストラクタを持ちます。 また、すべてのアトミック型に対して提供される演算に加えて、ポインタ型に適した fetch_add, fetch_sub などのアトミック算術演算も追加的にサポートされます。

3-4) std::shared_ptr および std::weak_ptr に対して部分特殊化 std::atomic<std::shared_ptr<T>> および std::atomic<std::weak_ptr<T>> が提供されます。

詳細は std::atomic<std::shared_ptr> および std::atomic<std::weak_ptr> を参照してください。

(C++20およびそれ以降)

[編集] 整数型に対する特殊化

以下の整数型のいずれかに対して実体化した場合、 std::atomicfetch_add, fetch_sub, fetch_and, fetch_or, fetch_xor などの整数型に適した追加のアトミック演算を提供します。

  • 文字型: char, char16_t, char32_t, wchar_t
  • 標準の符号付き整数型: signed char, short, int, long, long long
  • 標準の符号なし整数型: unsigned char, unsigned short, unsigned int, unsigned long, unsigned long long
  • ヘッダ <cstdint> の typedef によって必要とされるあらゆる追加の整数型

さらに、結果の特殊化 std::atomic<整数型> は標準レイアウト、トリビアルなデフォルトコンストラクタおよびトリビアルなデストラクタを持ちます。 符号付き整数型は2の補数を使用して定義され、未定義の結果は発生しません。

浮動小数点型に対する特殊化

浮動小数点型 float, double, long double のいずれかに対して実体化した場合、 std::atomicfetch_add, fetch_sub のような浮動小数点型に適した追加のアトミック演算を提供します。

さらに、結果の特殊化 std::atomic<浮動小数点型> は標準レイアウト、トリビアルなコンストラクタおよびトリビアルなデストラクタを持ちます。

結果がその浮動小数点型で表現できない場合であっても、いかなる演算も未定義動作を発生することはありません。 有効な浮動小数点環境は呼び出し元スレッドの浮動小数点環境と異なる場合があります。

(C++20およびそれ以降)

[編集] 型エイリアス

bool および上記のすべての整数型に対する型エイリアスが以下のように提供されます。

型エイリアス 定義
std::atomic_bool std::atomic<bool>
std::atomic_char std::atomic<char>
std::atomic_schar std::atomic<signed char>
std::atomic_uchar std::atomic<unsigned char>
std::atomic_short std::atomic<short>
std::atomic_ushort std::atomic<unsigned short>
std::atomic_int std::atomic<int>
std::atomic_uint std::atomic<unsigned int>
std::atomic_long std::atomic<long>
std::atomic_ulong std::atomic<unsigned long>
std::atomic_llong std::atomic<long long>
std::atomic_ullong std::atomic<unsigned long long>
std::atomic_char16_t std::atomic<char16_t>
std::atomic_char32_t std::atomic<char32_t>
std::atomic_wchar_t std::atomic<wchar_t>
std::atomic_int8_t std::atomic<std::int8_t>
std::atomic_uint8_t std::atomic<std::uint8_t>
std::atomic_int16_t std::atomic<std::int16_t>
std::atomic_uint16_t std::atomic<std::uint16_t>
std::atomic_int32_t std::atomic<std::int32_t>
std::atomic_uint32_t std::atomic<std::uint32_t>
std::atomic_int64_t std::atomic<std::int64_t>
std::atomic_uint64_t std::atomic<std::uint64_t>
std::atomic_int_least8_t std::atomic<std::int_least8_t>
std::atomic_uint_least8_t std::atomic<std::uint_least8_t>
std::atomic_int_least16_t std::atomic<std::int_least16_t>
std::atomic_uint_least16_t std::atomic<std::uint_least16_t>
std::atomic_int_least32_t std::atomic<std::int_least32_t>
std::atomic_uint_least32_t std::atomic<std::uint_least32_t>
std::atomic_int_least64_t std::atomic<std::int_least64_t>
std::atomic_uint_least64_t std::atomic<std::uint_least64_t>
std::atomic_int_fast8_t std::atomic<std::int_fast8_t>
std::atomic_uint_fast8_t std::atomic<std::uint_fast8_t>
std::atomic_int_fast16_t std::atomic<std::int_fast16_t>
std::atomic_uint_fast16_t std::atomic<std::uint_fast16_t>
std::atomic_int_fast32_t std::atomic<std::int_fast32_t>
std::atomic_uint_fast32_t std::atomic<std::uint_fast32_t>
std::atomic_int_fast64_t std::atomic<std::int_fast64_t>
std::atomic_uint_fast64_t std::atomic<std::uint_fast64_t>
std::atomic_intptr_t std::atomic<std::intptr_t>
std::atomic_uintptr_t std::atomic<std::uintptr_t>
std::atomic_size_t std::atomic<std::size_t>
std::atomic_ptrdiff_t std::atomic<std::ptrdiff_t>
std::atomic_intmax_t std::atomic<std::intmax_t>
std::atomic_uintmax_t std::atomic<std::uintmax_t>

ノート: std::atomic_intN_t, std::atomic_uintN_t, std::atomic_intptr_t, atomic_uintptr_t は、それぞれ std::intN_t, std::uintN_t, std::intptr_t, std::uintptr_t が定義されている場合に限り定義されます。

[編集] メンバ型

メンバ型 定義
value_type 下記参照
difference_type value_type (特殊化 atomic<整数型> および atomic<浮動小数点型> (C++20およびそれ以降) に対してのみ)
std::ptrdiff_t (特殊化 atomic<T*> に対してのみ)

すべての std::atomic<X> (特殊化されているかどうかに関わらず) に対して、 std::atomic<X>::value_typeX です。

difference_typeatomic のプライマリテンプレートおよび std::shared_ptr, std::weak_ptr に対する部分特殊化では定義されません。

[編集] メンバ関数

アトミックオブジェクトを構築します
(パブリックメンバ関数) [edit]
アトミックオブジェクトに値を格納します
(パブリックメンバ関数) [edit]
アトミックオブジェクトがロックフリーかどうか調べます
(パブリックメンバ関数) [edit]
アトミックオブジェクトの値を非アトミック引数でアトミックに置き換えます
(パブリックメンバ関数) [edit]
アトミックオブジェクトの値をアトミックに取得します
(パブリックメンバ関数) [edit]
アトミックオブジェクトから値を読み込みます
(パブリックメンバ関数) [edit]
アトミックオブジェクトの値をアトミックに置き換え、以前保持されていた値を取得します
(パブリックメンバ関数) [edit]
アトミックに、アトミックオブジェクトの値を非アトミック引数と比較し、等しければ交換を行い、等しくなければ読み込みます
(パブリックメンバ関数) [edit]

定数

[static] (C++17)
型が常にロックフリーであることを表します
(パブリック静的メンバ定数) [edit]

[編集] 特殊化メンバ関数

アトミックオブジェクトに格納されている値に引数の値をアトミックに加算し、以前保持されていた値を取得します
(パブリックメンバ関数) [edit]
アトミックオブジェクトに格納されている値から引数の値をアトミックに減算し、以前保持されていた値を取得します
(パブリックメンバ関数) [edit]
アトミックオブジェクトの値と引数の値のビット単位の論理積をアトミックに行い、以前保持されていた値を取得します
(パブリックメンバ関数) [edit]
アトミックオブジェクトの値と引数の値のビット単位の論理和をアトミックに行い、以前保持されていた値を取得します
(パブリックメンバ関数) [edit]
アトミックオブジェクトの値と引数の値の排他的論理和をアトミックに行い、以前保持されていた値を取得します
(パブリックメンバ関数) [edit]
アトミック値を1つインクリメントまたはデクリメントします
(パブリックメンバ関数) [edit]
アトミック値に対して加算、減算、ビット単位の論理積、論理和、排他的論理和を行います
(パブリックメンバ関数) [edit]

[編集] ノート

std::atomic のすべてのメンバ関数に対して、同等な非メンバ関数が存在します。 これらの非メンバ関数は std::atomic の特殊化でないけれどもアトミック性を保証できる型に対して追加のオーバーロードを提供する場合があります。 そのような型は標準ライブラリでは std::shared_ptr<T> だけです。

[編集] 欠陥報告

以下の動作変更欠陥報告は以前に発行された C++ 標準に遡って適用されました。

DR 適用先 発行時の動作 正しい動作
LWG 2441 C++11 added specializations for the (オプション) fixed width integer types
P0558R1 C++11 specification was substantially rewritten to resolve numerous issues
in particular, member typedefs value_type and difference_type are added

[編集] 関連項目

ロックフリーなアトミックブーリアン型
(クラス) [edit]