std::atomic_exchange, std::atomic_exchange_explicit

 

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)

 

ヘッダ <atomic> で定義
	(1)	(C++11以上)
template<class T > T atomic_exchange(std::atomic<T>* obj,                    typenamestd::atomic<T>::value_type desr )noexcept;
template<class T > T atomic_exchange(volatilestd::atomic<T>* obj,                    typenamestd::atomic<T>::value_type desr )noexcept;
			(2)	(C++11以上)
template<class T > T atomic_exchange_explicit(std::atomic<T>* obj,                             typenamestd::atomic<T>::value_type desr,                             std::memory_order order )noexcept;
template<class T > T atomic_exchange_explicit(volatilestd::atomic<T>* obj,                             typenamestd::atomic<T>::value_type desr,                             std::memory_order order )noexcept;

1)obj->exchange(desr) によって行われたかのように、 obj の指す値を desr の値でアトミックに置き換え、 obj がそれまで保持していた値を返します。

2)obj->exchange(desr, order) によって行われたかのように、 obj の指す値を desr の値でアトミックに置き換え、 obj がそれまで保持していた値を返します。

引数

obj	-	変更するアトミックオブジェクトを指すポインタ
desr	-	アトミックオブジェクトに格納する値
order	-	この操作に対するメモリ同期順序付け。 すべての値が指定できます。

戻り値

obj の指すアトミックオブジェクトがそれまで保持していた値。

例

std::atomic_flag_test_and_set と同様に、アトミックな交換操作を使用してユーザ空間でスピンロックを実装できます。

Run this code

#include <thread>#include <vector>#include <iostream>#include <atomic>   std::atomic<bool> lock(false);// holds true when locked// holds false when unlocked   void f(int n){for(int cnt =0; cnt <100;++cnt){while(std::atomic_exchange_explicit(&lock, true, std::memory_order_acquire));// spin until acquiredstd::cout<<"Output from thread "<< n <<'\n';std::atomic_store_explicit(&lock, false, std::memory_order_release);}}int main(){std::vector<std::thread> v;for(int n =0; n <10;++n){ v.emplace_back(f, n);}for(auto& t : v){ t.join();}}

出力:

Output from thread 2 Output from thread 6 Output from thread 7 ...<exactly 1000 lines>...

欠陥報告

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

DR	適用先	発行時の動作	正しい動作
P0558R1	C++11	exact type match required because T is deduced from multiple arguments	T is deduced from the atomic argument only

関連項目

exchange	アトミックオブジェクトの値をアトミックに置き換え、以前保持されていた値を取得します (std::atomic<T>のパブリックメンバ関数)
atomic_compare_exchange_weakatomic_compare_exchange_weak_explicitatomic_compare_exchange_strongatomic_compare_exchange_strong_explicit (C++11)(C++11)(C++11)(C++11)	アトミックに、アトミックオブジェクトの値を非アトミック引数と比較し、等しければ交換を行い、等しくなければ読み込みます (関数テンプレート)

std::atomic_exchange(std::shared_ptr)std::atomic_exchange_explicit(std::shared_ptr) (C++20で非推奨)	アトミック操作の std::shared_ptr に対する特殊化 (関数テンプレート)
atomic_exchange, atomic_exchange_explicit の C言語リファレンス