最終更新日時(UTC): 2025年01月22日 04時39分19秒
yoh が更新

履歴 編集

function
<atomic>

# std::atomic::wait(C++20)

    void
      wait(T old,
           memory_order order = memory_order::seq_cst
           ) const volatile noexcept;                 // (1) C++20

    void
      wait(T old,
           memory_order order = memory_order::seq_cst
           ) const noexcept;                          // (2) C++20
    constexpr void
      wait(T old,
           memory_order order = memory_order::seq_cst
           ) const noexcept;                          // (2) C++26

## 概要

起床されるまで待機する。

この関数は、ブロッキング同期を行うための機能であり、ビジーループによるポーリングよりもエネルギー消費が低く効率的な待機を実現できる。アトミック操作版の`std::condition_variable`であると言える。

この関数によってブロッキング待機をしたら、対応する起床関数である`notify_one()`、`notify_all()`によってブロッキング待機を解除できる。

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

- (1) :
  - C++20 : `atomic<T>::is_always_lock_free`が`true`であること

## 事前条件

`order`が以下のメモリオーダーではないこと：

- `memory_order_release`
- `memory_order_acq_rel`

## 効果

- 以下のステップを順に繰り返し実行する：
  - `load(order)`によって現在の値を読み込み、`old`と値を比較する
  - 現在の値と`old`が等しくなければ、関数を`return`する
  - アトミック起床操作が呼ばれてアンロックされるまで、この関数の実行をブロックする
    - ただし、起床操作が呼ばれていなくても、アンロックされる場合がある (spuriously unblock)

## 戻り値

なし

## 例外

投げない

## 備考

- Windowsでは`WaitOnAddress()`関数、POSIXでは`futex()`関数が実装に使われる

## 例

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

    class my_mutex {
      std::atomic<bool> state_{false}; // false:unlock, true:lock
    public:
      void lock() noexcept {
        while (state_.exchange(true) == true) {
          state_.wait(true);
        }
      }

      void unlock() noexcept {
        state_.store(false);
        state_.notify_one();
      }
    };

    my_mutex mut;
    void print(int x) {
      mut.lock();
      std::cout << x << std::endl;
      mut.unlock();
    }

    int main()
    {
      std::thread t1 {[] {
        for (int i = 0; i < 5; ++i) {
          print(i);
        }
      }};
      std::thread t2 {[] {
        for (int i = 5; i < 10; ++i) {
          print(i);
        }
      }};

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

### 出力例

    0
    5
    1
    6
    2
    7
    3
    8
    4
    9

## バージョン

### 言語

- C++20

### 処理系

- Clang: 9.0 ❌
- GCC: 9.2 ❌
- Visual C++: 2019 Update 3 ❌

## 関連項目

- C++20 ほとんどの`volatile`を非推奨化

## 参照

- P0514R4 Efficient concurrent waiting for C++20
- ogiroux/atomic_wait - Sample implementation of C++20 atomic_wait/notify
- P1831R1 Deprecating `volatile`: library
  - C++20での、`volatile`版への制約追加
- P3309R3 `constexpr atomic` and `atomic_ref`
  - C++26で`constexpr`に対応した