atomic_flag_wait_explicit.md

atomic_flag_wait_explicit

• atomic[meta header]
• std[meta namespace]
• function[meta id-type]
• cpp20[meta cpp]

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[color ff0000]
• std::atomic_flag_test_and_set_explicit[link atomic_flag_test_and_set.md]
• std::atomic_flag_clear_explicit[link atomic_flag_clear.md]
• std::atomic_flag_notify_one[link /reference/atomic/atomic_flag_notify_one.md]
• ATOMIC_FLAG_INIT[link /reference/atomic/atomic_flag_init.md]
• std::memory_order[link /reference/atomic/memory_order.md]

出力例

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