Class / Function / Type

std::
Header file

<>
Other / All

最終更新日時(UTC): 2024年12月23日 07時58分47秒
Akira Takahashi が更新

function

std::atomic_ref::compare_exchange_weak

bool
  compare_exchange_weak(T& expected,
                        T desired,
                        memory_order success,
                        memory_order failure
                        ) const noexcept;     // (1) C++20
constexpr bool
  compare_exchange_weak(value_type& expected,
                        value_type desired,
                        memory_order success,
                        memory_order failure
                        ) const noexcept;     // (1) C++26

bool
  compare_exchange_weak(T& expected,
                        T desired,
                        memory_order order = memory_order_seq_cst
                        ) const noexcept;     // (2) C++20
constexpr bool
  compare_exchange_weak(value_type& expected,
                        value_type desired,
                        memory_order order = memory_order_seq_cst
                        ) const noexcept;     // (2) C++26

概要

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

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

事前条件

(1) : failureがmemory_order_release, memory_order_acq_relではないこと

効果

*thisが参照する値を現在の値であるとして。

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

(1) : バイト等値比較がtrueの場合はsuccessメモリオーダー、falseの場合はfailureメモリオーダーに従って、アトミックに値の置き換えが行われる
(2) : アトミックな値置き換えでは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()
{
  {
    int value = 3;
    std::atomic_ref<int> x{value};

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

    std::cout << std::boolalpha << result << " " << value << " " << expected << std::endl;
  }
  {
    int value = 3;
    std::atomic_ref<int> x{value};

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

    std::cout << std::boolalpha << result << " " << value << " " << expected << std::endl;
  }
}

 
#include <iostream>
#include <atomic>
​
int main()
{
  {
    int value = 3;
    std::atomic_ref<int> x{value};
​
    // x == expectedなので、xは2に置き換えられる
    int expected = 3;
    bool result = x.compare_exchange_weak(expected, 2);
​
    std::cout << std::boolalpha << result << " " << value << " " << expected << std::endl;
  }
  {
    int value = 3;
    std::atomic_ref<int> x{value};

出力

true 2 3
false 3 3

競合を回避しながら値を更新する例

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

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

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

  // アトミックな値の上書き
  void atomic_store(int new_value) {
    std::atomic_ref<int> r{value_};
    // 変更前の値に依存しない場合は、Spurious Failureを回避するためのwhile文のみ必要となる
    int expected = r.load();
    while (!r.compare_exchange_weak(expected, new_value)) {}
  }

  // 非アトミックな値の取得
  int get() const {
    return value_;
  }
};

int main()
{
  my_integer x;

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

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

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

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

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

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

// アトミックな値の上書き
  void atomic_store(int new_value) {
    std::atomic_ref<int> r{value_};
    // 変更前の値に依存しない場合は、Spurious Failureを回避するためのwhile文のみ必要となる
    int expected = r.load();
    while (!r.compare_exchange_weak(expected, new_value)) {}
  }

// 非アトミックな値の取得
  int get() const {
    return value_;
  }
};

int main()
{
  my_integer x;

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

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

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

    // while (!current.compare_exchange_weak(expected, desired));
 
#include <iostream>
#include <atomic>
#include <thread>
​
class my_integer {
  int value_ = 0;
public:
  // std::atomic_ref<int>::fetch_add(1)相当
  void atomic_increment() {
    std::atomic_ref<int> r{value_};
    int expected = r.load();
    int desired;
    do {
      desired = expected + 1;
    }
    // 他のスレッドによってrの値が書き換わっている可能性があるため、
    // r != expectedだったらexpected = rに更新する。
    // r == expectedだったらその値に+1して値更新する。

出力

バージョン

言語

C++20

処理系

Clang: 9.0 ❌
GCC: 10.1 ✅
Visual C++: ??

参照

P3323R1 cv-qualified types in atomic and atomic_ref
- C++26でCV修飾されたテンプレート引数を受け取れるようになった
P3309R3 constexpr atomic and atomic_ref
- C++26でconstexprに対応した

Class / Function / Type

Header file

Other / All

std::atomic_ref::compare_exchange_weak

概要

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

事前条件

効果

戻り値

例外

備考

例

基本的な使い方

出力

競合を回避しながら値を更新する例

出力

バージョン

言語

処理系

参照