std::atomic_flag

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

並行性サポートライブラリ

スレッド thread (C++11) jthread (C++20) hardware_destructive_interference_sizehardware_constructive_interference_size (C++17)(C++17) this_thread 名前空間 get_id (C++11) yield (C++11) sleep_for (C++11) sleep_until (C++11) 協調的なキャンセル stop_token (C++20) inplace_stop_token (C++26) never_stop_token (C++26) stop_source (C++20) inplace_stop_source (C++26)   stop_callback (C++20) inplace_stop_callback (C++26) stop_callback_for_t (C++26) stoppable_token (C++26) unstoppable_token (C++26) stoppable-source (C++26) stoppable-callback-for (C++26)   排他制御 mutex (C++11) recursive_mutex (C++11) shared_mutex (C++17) timed_mutex (C++11) recursive_timed_mutex (C++11) shared_timed_mutex (C++14) 汎用ロック管理 lock (C++11) lock_guard (C++11) scoped_lock (C++17) unique_lock (C++11) shared_lock (C++14) once_flag (C++11) call_once (C++11) try_lock (C++11) defer_locktry_to_lockadopt_lockdefer_lock_ttry_to_lock_tadopt_lock_t (C++11)(C++11)(C++11)(C++11)(C++11)(C++11) 条件変数 condition_variable (C++11) condition_variable_any (C++11) notify_all_at_thread_exit (C++11) cv_status (C++11) セマフォ counting_semaphorebinary_semaphore (C++20)(C++20) ラッチとバリア latch (C++20) barrier (C++20) future promise (C++11) future (C++11) shared_future (C++11) packaged_task (C++11) async (C++11) launch (C++11) future_status (C++11) future_error (C++11) future_category (C++11) future_errc (C++11) 安全なメモリ解放 (Safe Reclamation) rcu_obj_base (C++26) rcu_domain (C++26) rcu_default_domain (C++26) rcu_synchronize (C++26) rcu_barrier (C++26) rcu_retire (C++26) ハザードポインタ hazard_pointer_obj_base (C++26) hazard_pointer (C++26) make_hazard_pointer (C++26)

アトミック型 atomic (C++11) atomic_ref (C++20) atomic_flag (C++11) アトミック型の初期化 atomic_init (C++11)(C++20で非推奨) ATOMIC_VAR_INIT (C++11)(C++20で非推奨) ATOMIC_FLAG_INIT (C++11) メモリオーダー memory_order (C++11) kill_dependency (C++11)(C++26で非推奨) atomic_thread_fence (C++11) atomic_signal_fence (C++11) アトミック操作のためのフリー関数 atomic_storeatomic_store_explicit (C++11)(C++11) atomic_loadatomic_load_explicit (C++11)(C++11) atomic_exchangeatomic_exchange_explicit (C++11)(C++11) atomic_compare_exchange_weakatomic_compare_exchange_weak_explicitatomic_compare_exchange_strongatomic_compare_exchange_strong_explicit (C++11)(C++11)(C++11)(C++11) atomic_fetch_addatomic_fetch_add_explicit (C++11)(C++11) atomic_fetch_subatomic_fetch_sub_explicit (C++11)(C++11) atomic_fetch_andatomic_fetch_and_explicit (C++11)(C++11) atomic_fetch_oratomic_fetch_or_explicit (C++11)(C++11) atomic_fetch_xoratomic_fetch_xor_explicit (C++11)(C++11) atomic_fetch_maxatomic_fetch_max_explicit (C++26)(C++26) atomic_fetch_minatomic_fetch_min_explicit (C++26)(C++26) atomic_is_lock_free (C++11) atomic_waitatomic_wait_explicit (C++20)(C++20) atomic_notify_one (C++20) atomic_notify_all (C++20) アトミックフラグのためのフリー関数 atomic_flag_test_and_setatomic_flag_test_and_set_explicit (C++11)(C++11) atomic_flag_clearatomic_flag_clear_explicit (C++11)(C++11) atomic_flag_testatomic_flag_test_explicit (C++20)(C++20) atomic_flag_waitatomic_flag_wait_explicit (C++20)(C++20) atomic_flag_notify_one (C++20) atomic_flag_notify_all (C++20)

 

std::atomic_flag

メンバ関数

atomic_flag::atomic_flag

atomic_flag::operator=

atomic_flag::clear

atomic_flag::test_and_set

atomic_flag::test (C++20)

atomic_flag::wait (C++20)

atomic_flag::notify_one (C++20)

atomic_flag::notify_all (C++20)

 

ヘッダー <atomic> で定義
class atomic_flag;		(C++11以降)

std::atomic_flagはアトミックな真偽値型である。std::atomicの全ての特殊化とは異なり、ロックフリーであることが保証されている。std::atomic<bool>とは異なり、std::atomic_flagはloadやstore操作を提供しない。

メンバ関数

(コンストラクタ)	atomic_flagを構築する (public member function)
operator= [削除]	代入演算子（削除） (public member function)
clear	フラグをアトミックにfalseに設定する (public member function)
test_and_set	フラグをアトミックにtrueに設定し、以前の値を取得する (public member function)
test (C++20)	フラグの値をアトミックに返す (public member function)
wait (C++20)	通知されるまで、かつアトミックな値が変更されるまでスレッドをブロックする (public member function)
notify_one (C++20)	アトミックオブジェクトを待機しているスレッドを少なくとも1つ通知する (public member function)
notify_all (C++20)	アトミックオブジェクトを待機してブロックされている全てのスレッドに通知する (public member function)

例

スピンロックミューテックスのデモは、atomic_flagを使ってユーザースペースで実装できる。スピンロックミューテックスは、実際には極めて疑わしいことに注意すること。

このコードを実行

#include <atomic>
#include <iostream>
#include <mutex>
#include <thread>
#include <vector>
 
class mutex
{
    std::atomic_flag m_{};
 
  public:
    void lock() noexcept
    {
        while (m_.test_and_set(std::memory_order_acquire))
#if defined(__cpp_lib_atomic_wait) && __cpp_lib_atomic_wait >= 201907L
            // Since C++20, locks can be acquired only after notification in the unlock,
            // avoiding any unnecessary spinning.
            // Note that even though wait guarantees it returns only after the value has
            // changed, the lock is acquired after the next condition check.
            m_.wait(true, std::memory_order_relaxed)
#endif
                ;
    }
    bool try_lock() noexcept
    {
        return !m_.test_and_set(std::memory_order_acquire);
    }
    void unlock() noexcept
    {
        m_.clear(std::memory_order_release);
#if defined(__cpp_lib_atomic_wait) && __cpp_lib_atomic_wait >= 201907L
        m_.notify_one();
#endif
    }
};
 
static mutex m;
 
static int out{};
 
void f(std::size_t n)
{
    for (std::size_t cnt{}; cnt < 40; ++cnt)
    {
        std::lock_guard lock{m};
        std::cout << n << ((++out % 40) == 0 ? '\n' : ' ');
    }
}
 
int main()
{
    std::vector<std::thread> v;
    for (std::size_t n{}; n < 10; ++n)
        v.emplace_back(f, n);
    for (auto &t : v)
        t.join();
}

実行結果の例

0 1 1 2 0 1 3 2 3 2 0 1 2 3 2 3 0 1 3 2 0 1 2 3 2 3 0 3 2 3 2 3 2 3 1 2 3 0 1 3
2 3 2 0 1 2 3 0 1 2 3 2 0 1 2 3 0 1 2 3 2 3 2 3 2 0 1 2 3 2 3 0 1 3 2 3 0 2 1 1
1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0 3 2 0 2 3 2 3 2 3 2 3 2 3 0 3
2 3 0 3 0 3 2 3 0 3 2 3 2 3 0 2 3 0 3 2 0 2 2 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4
5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5
6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 6
7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7
8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8
9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9

関連項目

atomic_flag_test_and_setatomic_flag_test_and_set_explicit (C++11)(C++11)	フラグをアトミックにtrueに設定し、以前の値を返す (function)
atomic_flag_clearatomic_flag_clear_explicit (C++11)(C++11)	フラグの値をアトミックにfalseに設定する (function)
atomic_flag_waitatomic_flag_wait_explicit (C++20)(C++20)	通知されるまで、かつフラグが変更されるまでスレッドをブロックする (function)
atomic_flag_notify_one (C++20)	atomic_flag_waitでブロックされているスレッドに通知する (function)
atomic_flag_notify_all (C++20)	atomic_flag_waitでブロックされている全てのスレッドに通知する (function)
ATOMIC_FLAG_INIT (C++11)	std::atomic_flagをfalseに初期化する (macro constant)
Cのドキュメント atomic_flagについて