std::atomic_flag_wait_explicit(C++20)

namespace std {
  void atomic_flag_wait_explicit(const volatile atomic_flag* object,
                                 bool old,
                                 memory_order order) noexcept;  // (1) C++20
  void atomic_flag_wait_explicit(const atomic_flag* object,
                                 bool old,
                                 memory_order order) noexcept;  // (2) C++20
}

概要

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

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

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

効果

以下のステップを順に繰り返し実行する：
- 式atomic_flag_test_explicit(object, order) != 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_explicit(&state_, std::memory_order::acquire)) {
      std::atomic_flag_wait_explicit(&state_, true, std::memory_order::relaxed);
    }
  }

  void unlock() noexcept {
    std::atomic_flag_clear_explicit(&state_, std::memory_order::release);
    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();
}

出力例

std::atomic_flag_wait_explicit(C++20)

概要

効果

戻り値

例外

備考

例

出力例

バージョン

言語

処理系

参照