最終更新日時(UTC):
が更新

履歴 編集

function
<atomic>

std::atomic::compare_exchange_strong(C++11)

bool compare_exchange_strong(T& expected,
                             T desired,
                             memory_order success,
                             memory_order failure
                             ) volatile noexcept;  // (1)
bool compare_exchange_strong(T& expected,
                             T desired,
                             memory_order success,
                             memory_order failure
                             ) noexcept;           // (2)

bool compare_exchange_strong(T& expected,
                             T desired,
                             memory_order order = memory_order_seq_cst
                             ) volatile noexcept;  // (3)
bool compare_exchange_strong(T& expected,
                             T desired,
                             memory_order order = memory_order_seq_cst
                             ) noexcept;           // (4)

概要

強い比較で値を入れ替える。

  • (1), (2) : 現在の値とexpectedが等値である場合に、successメモリオーダーで現在の値をdesiredで置き換え、そうでなければfailureメモリオーダーでexpectedを現在の値で置き換える
  • (3), (4) : 現在の値とexpectedが等値である場合に、現在の値をdesiredで置き換え、そうでなければexpectedを現在の値で置き換える。どちらの値置き換えの場合でもorderメモリオーダーが使用される

要件

効果

現在の値とexpectedをバイトレベルで等値比較を行い、trueである場合は現在の値をdesiredで置き換え、falseである場合はexpectedを現在の値で置き換える。

  • (1), (2) : バイト等値比較がtrueの場合はsuccessメモリオーダー、falseの場合はfailureメモリオーダーに従って、アトミックに値の置き換えが行われる
  • (3), (4) : アトミックな値置き換えではorderメモリオーダーが使用される

戻り値

この関数を呼び出す前の*thisが保持する値とexpectedの等値比較の結果が返される。等値であればtrue、そうでなければfalseが返る。

例外

投げない

備考

この関数は、値が交換可能な場合はCAS (compare-and-swap) 操作が常に成功する。

compare_exchange_weak()はより弱い命令であり、交換可能な場合でもCAS操作が失敗する可能性がある。

通常、CAS操作は、CASが成功するまでループさせる。

しかし、もしCAS操作でSpurious Failureが発生しなければループさせる必要が無くなるといった状況であれば、compare_exchange_strong()を使うことで効率良くCASを行うことができる。

逆に言えば、そのような状況でないなら常にループでcompare_exchange_weak()を利用すれば良い。

基本的な使い方

#include <iostream>
#include <atomic>

int main()
{
  {
    std::atomic<int> x(3);

    // x == expectedなので、xは2に置き換えられる
    int expected = 3;
    bool result = x.compare_exchange_strong(expected, 2);

    std::cout << std::boolalpha << result << " " << x.load() << " " << expected << std::endl;
  }
  {
    std::atomic<int> x(3);

    // x != expectedなので、expectedがxの値で置き換えられる
    int expected = 1;
    bool result = x.compare_exchange_strong(expected, 2);

    std::cout << std::boolalpha << result << " " << x.load() << " " << expected << std::endl;
  }
}

出力

true 2 3
false 3 3

フラグのオン・オフをする例

#include <iostream>
#include <atomic>
#include <thread>

class my_atomic_flag {
  std::atomic<bool> value_{false};
public:
  void set() {
    // 値がfalseだったらtrueにする。
    // falseでなかったら (true) 、そのまま
    bool expected = false;
    value_.compare_exchange_strong(expected, true);
  }

  bool load() const {
    return value_.load();
  }
};

int main()
{
  my_atomic_flag x;

  // いずれかのスレッドの処理がおわったら (成功したら) フラグをオンにする
  std::thread t1 {[&x] {
    x.set();
  }};
  std::thread t2 {[&x] {
    x.set();
  }};

  t1.join();
  t2.join();

  std::cout << std::boolalpha << x.load() << std::endl;
}

出力

true

バージョン

言語

  • C++11

処理系

参照