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

履歴 編集

function
<atomic>

# std::atomic_flag_wait(C++20)

    namespace std {
      void
        atomic_flag_wait(
          const volatile atomic_flag* object,
          bool old) noexcept;        // (1) C++20

      void
        atomic_flag_wait(
          const atomic_flag* object,
          bool old) noexcept;        // (2) C++20
      constexpr void
        atomic_flag_wait(
          const atomic_flag* object,
          bool old) noexcept;        // (2) C++26
    }

## 概要

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

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

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

## 効果

- 以下のステップを順に繰り返し実行する：
  - 式`atomic_flag_test(object) != old`を評価する
  - 比較結果が`true`に評価された場合、関数を`return`する
  - アトミック起床操作が呼ばれてアンロックされるまで、この関数の実行をブロックする
    - ただし、起床操作が呼ばれていなくても、アンロックされる場合がある (spuriously unblock)

## 戻り値

なし

## 例外

投げない

## 備考

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

## 例

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

    class my_mutex {
      std::atomic_flag state_ = ATOMIC_FLAG_INIT; // clear:unlock, set:lock
    public:
      void lock() noexcept {
        while (std::atomic_flag_test_and_set(&state_)) {
          std::atomic_flag_wait(&state_, true);
        }
      }

      void unlock() noexcept {
        std::atomic_flag_clear(&state_);
        std::atomic_flag_notify_one(&state_);
      }
    };

    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 ❌

## 参照

- P0514R4 Efficient concurrent waiting for C++20
- ogiroux/atomic_wait - Sample implementation of C++20 atomic_wait/notify
- P1135R6 The C++20 Synchronization Library
- P3309R3 `constexpr atomic` and `atomic_ref`
  - C++26で`constexpr`に対応した