std::atomic_is_lock_free, ATOMIC_xxx_LOCK_FREE

 

C++

言語

標準ライブラリヘッダ

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

名前付き要件

言語サポートライブラリ

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

診断ライブラリ

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

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ (C++20)

アルゴリズムライブラリ

数値演算ライブラリ

ローカライゼーションライブラリ

入出力ライブラリ

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

正規表現ライブラリ (C++11)

アトミック操作ライブラリ (C++11)

スレッドサポートライブラリ (C++11)

技術仕様書

 

アトミック操作ライブラリ

型

atomic (C++11)

atomic_ref (C++20)

関数

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)

atomic_fetch_addatomic_fetch_add_explicit (C++11)(C++11)

atomic_fetch_subatomic_fetch_sub_explicit (C++11)(C++11)

atomic_fetch_andatomic_fetch_and_explicit (C++11)(C++11)

atomic_fetch_oratomic_fetch_or_explicit (C++11)(C++11)

atomic_fetch_xoratomic_fetch_xor_explicit (C++11)(C++11)

atomic_is_lock_free (C++11)

atomic_waitatomic_wait_explicit (C++20)(C++20)

atomic_notify_one (C++20)

atomic_notify_all (C++20)

アトミックフラグ

atomic_flag (C++11)

atomic_flag_test_and_setatomic_flag_test_and_set_explicit (C++11)(C++11)

atomic_flag_clearatomic_flag_clear_explicit (C++11)(C++11)

atomic_flag_testatomic_flag_test_explicit (C++20)(C++20)

atomic_flag_waitatomic_flag_wait_explicit (C++20)(C++20)

atomic_flag_notify_one (C++20)

atomic_flag_notify_all (C++20)

初期化

atomic_init (C++11)(C++20で非推奨)

ATOMIC_VAR_INIT (C++11)(C++20で非推奨)

ATOMIC_FLAG_INIT (C++11)(C++20で非推奨)

メモリ順序

memory_order (C++11)

kill_dependency (C++11)

atomic_thread_fence (C++11)

atomic_signal_fence (C++11)

 

<tbody> </tbody> <tbody class="t-dcl-rev t-dcl-rev-num t-dcl-rev-notes t-since-cxx11 "> </tbody><tbody> </tbody>

ヘッダ <atomic> で定義
	(1)	(C++11以上)
template< class T > bool atomic_is_lock_free( const volatile std::atomic<T>* obj ) noexcept;
template< class T > bool atomic_is_lock_free( const std::atomic<T>* obj ) noexcept;
#define ATOMIC_BOOL_LOCK_FREE /* unspecified */ #define ATOMIC_CHAR_LOCK_FREE /* unspecified */ #define ATOMIC_CHAR16_T_LOCK_FREE /* unspecified */ #define ATOMIC_CHAR32_T_LOCK_FREE /* unspecified */ #define ATOMIC_WCHAR_T_LOCK_FREE /* unspecified */ #define ATOMIC_SHORT_LOCK_FREE /* unspecified */ #define ATOMIC_INT_LOCK_FREE /* unspecified */ #define ATOMIC_LONG_LOCK_FREE /* unspecified */ #define ATOMIC_LLONG_LOCK_FREE /* unspecified */ #define ATOMIC_POINTER_LOCK_FREE /* unspecified */	(2)	(C++11以上)
#define ATOMIC_CHAR8_T_LOCK_FREE /* unspecified */	(3)	(C++20以上)

1) obj->is_lock_free() を呼び出したかのように、 obj が指すアトミックオブジェクトがロックフリーに実装されているかどうか調べます。 任意の与えられたプログラム実行において、同じ型のポインタの対するロックフリーの問い合わせ結果はすべて同じになります。

2,3) 以下の値を持つ整数定数式に展開されます。

• 決してロックフリーにならない組み込みアトミック型に対しては値 0
• 時々ロックフリーになることがある組み込みアトミック型に対しては値 1
• 常にロックフリーである組み込みアトミック型に対しては値 2

引数

obj

-

調べるアトミックオブジェクトを指すポインタ

戻り値

*obj がロックフリーなアトミックオブジェクトであれば true、そうでなければ false。

ノート

std::atomic_flag を除くすべてのアトミック型は、 CPU のロックフリーなアトミック命令ではなく、ミューテックスや他のロック操作を使って実装されることがあります。 アトミック型は時々ロックフリーになることが許されています。 例えば、与えられた型に対するロックフリーアクセスを一部のサブアーキテクチャしかサポートしない場合 (x86-64 の CMPXCHG16B 命令など)、アトミックがロックフリーかどうかは実行時まで判明しないことがあります。

C++ 標準は、ロックフリーなアトミック操作はアドレスフリーでもある、つまり、共有メモリを用いたプロセス間通信にも使えることを推奨しています (が、要求はしていません)。

例

Run this code

#include <iostream>
#include <utility>
#include <atomic>

struct A { int a[100]; };
struct B { int x, y; };
int main()
{
    std::atomic<A> a;
    std::atomic<B> b;
    std::cout << std::boolalpha
              << "std::atomic<A> is lock free? "
              << std::atomic_is_lock_free(&a) << '\n'
              << "std::atomic<B> is lock free? "
              << std::atomic_is_lock_free(&b) << '\n';
}

出力例:

std::atomic<A> is lock free? false
std::atomic<B> is lock free? true

関連項目

is_lock_free	アトミックオブジェクトがロックフリーかどうか調べます (std::atomic<T>のパブリックメンバ関数)
std::atomic_is_lock_free(std::shared_ptr)	std::shared_ptr に対するアトミック操作の特殊化 (関数テンプレート)
atomic_flag (C++11)	ロックフリーなアトミックブーリアン型 (クラス)
is_always_lock_free [静的] (C++17)	型が常にロックフリーであることを表します (std::atomic<T>のパブリック静的メンバ定数)
atomic_is_lock_free の C言語リファレンス
ATOMIC_*_LOCK_FREE の C言語リファレンス