Skip to content

Latest commit

 

History

History
137 lines (107 loc) · 3.87 KB

atomic_wait_explicit.md

File metadata and controls

137 lines (107 loc) · 3.87 KB

atomic_wait_explicit

  • atomic[meta header]
  • std[meta namespace]
  • function[meta id-type]
  • cpp20[meta cpp]
namespace std {
  template<class T>
  void atomic_wait(const volatile atomic<T>* object,
                   typename atomic<T>::value_type old,
                   memory_order order);                 // (1) C++20

  template<class T>
  void atomic_wait(const atomic<T>* object,
                   typename atomic<T>::value_type old,
                   memory_order order);                 // (2) C++20
}

概要

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

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

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

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

  • (1) : atomic<T>::is_always_lock_freetrueであること

効果

  • 以下のステップを順に繰り返し実行する:
    • atomic_load_explicit(object, 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 (std::atomic_exchange_explicit(&state_, true, std::memory_order::acquire) == true) {
      std::atomic_wait_explicit(&state_, true, std::memory_order::relaxed);
    }
  }

  void unlock() noexcept {
    std::atomic_store_explicit(&state_, false, std::memory_order::release);
    std::atomic_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_wait_explicit[color ff0000]
  • std::atomic_exchange_explicit[link atomic_exchange_explicit.md]
  • std::atomic_store_explicit[link atomic_store_explicit.md]
  • std::atomic_notify_one[link atomic_notify_one.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時点で実装なし)

関連項目

参照