5. compare_exchange_weak

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

履歴 編集

function
<atomic>

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

bool compare_exchange_weak(T& expected,
                           T desired,
                           memory_order success,
                           memory_order failure
                           ) volatile noexcept;  // (1) C++11
bool compare_exchange_weak(T& expected,
                           T desired,
                           memory_order success,
                           memory_order failure
                           ) noexcept;           // (2) C++11

bool compare_exchange_weak(T& expected,
                           T desired,
                           memory_order order = memory_order_seq_cst
                           ) volatile noexcept;  // (3) C++11
bool compare_exchange_weak(T& expected,
                           T desired,
                           memory_order order = memory_order_seq_cst
                           ) noexcept;           // (4) C++11

概要

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

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

テンプレートパラメータ制約

  • (1), (3) :
    • C++20 : atomic<T>::is_always_lock_freeがtrueであること

事前条件

効果

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

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

戻り値

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

例外

投げない

備考

この関数は、値が交換可能な場合でもCAS (compare-and-swap) 操作が失敗する可能性がある (Spurious Failure)。

compare_exchange_strong()はより強い命令であり、交換可能な場合はCAS操作が常に成功する。

アーキテクチャによっては、この関数はcompare_exchange_strong()と等価だが、PowerPCやARMなどLL/SC命令を提供するアーキテクチャの場合、この関数はハードウェアの“弱いLL/SC命令”にて実装されうる。wikipedia:en:Load-link/store-conditional, wikipedia:Load-Link/Store-Conditional などを参照のこと。

通常、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_weak(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_weak(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_integer {
  std::atomic<int> value_{0};
public:
  // std::atomic<int>::fetch_add(1)相当
  void increment() {
    int expected = value_.load();
    int desired;
    do {
      desired = expected + 1;
    }
    // 他のスレッドによってvalue_の値が書き換わっている可能性があるため、
    // value_ != expectedだったらexpected = value_に更新する。
    // value_ == expectedだったらその値に+1して値更新する。
    // 変更前の値に依存して変更後の値が必要な場合に、このようなdo/whileループが必要となる
    while (!value_.compare_exchange_weak(expected, desired));

    // 変更前の値に依存した値更新のパターンは、以下のようになる：
    // expected = current.load();
    // do {
    //   desired = function(expected); // expectedに何らかの変換を行う
    // }
    // while (!current.compare_exchange_weak(expected, desired));
  }

  // 値の上書き
  void store(int new_value) {
    // 変更前の値に依存しない場合は、Spurious Failureを回避するためのwhile文のみ必要となる
    int expected = value_.load();
    while (!value_.compare_exchange_weak(expected, new_value)) {}
  }

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

int main()
{
  my_atomic_integer x;

  // 複数スレッドでインクリメントを呼んでも、
  // 最終的に全てのインクリメントが処理された値になる
  std::thread t1 {[&x] {
    x.increment();
  }};
  std::thread t2 {[&x] {
    x.increment();
  }};

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

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

出力

2

バージョン

言語

  • C++11

処理系

関連項目

参照