std::counting_semaphore, std::binary_semaphore

 

C++

言語

標準ライブラリヘッダ

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

名前付き要件

言語サポートライブラリ

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

診断ライブラリ

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

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ(C++20)

アルゴリズムライブラリ

数値演算ライブラリ

ローカライゼーションライブラリ

入出力ライブラリ

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

正規表現ライブラリ(C++11)

アトミック操作ライブラリ(C++11)

スレッドサポートライブラリ(C++11)

技術仕様書

 

スレッドサポートライブラリ

スレッド
thread (C++11)
jthread (C++20)
stop_token (C++20)
stop_source (C++20)
stop_callback (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)
相互排他
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_guard (C++11) scoped_lock (C++17) unique_lock (C++11) shared_lock (C++14) defer_lock_ttry_to_lock_tadopt_lock_t (C++11)(C++11)(C++11)	lock (C++11) try_lock (C++11) defer_locktry_to_lockadopt_lock (C++11)(C++11)(C++11) once_flag (C++11) call_once (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)
フューチャー
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)

 

std::counting_semaphore

メンバ関数

counting_semaphore::counting_semaphore

counting_semaphore::~counting_semaphore

操作

counting_semaphore::release

counting_semaphore::acquire

counting_semaphore::try_acquire

counting_semaphore::try_acquire_for

counting_semaphore::try_acquire_until

定数

counting_semaphore::max

 

ヘッダ <semaphore> で定義
template<std::ptrdiff_t LeastMaxValue =/* implementation-defined */> class counting_semaphore;	(1)	(C++20以上)
using binary_semaphore = std::counting_semaphore<1>;	(2)	(C++20以上)

1)counting_semaphore は共有リソースへのアクセスを制御できる軽量な同期プリミティブです。 std::mutex と異なり、 counting_semaphore は同じリソースに対する複数の (少なくとも LeastMaxValue 個の) 並行アクセスを許可できます。 LeastMaxValue が負の場合、プログラムは ill-formed です。

2)binary_semaphore は LeastMaxValue が 1 の std::counting_semaphore のエイリアスです。 処理系は std::counting_semaphore のデフォルトの実装よりも効率良く binary_semaphore を実装しても構いません。

counting_semaphore はコンストラクタによって初期化されるカウンタを内部に持ちます。 このカウンタは acquire() およびその関連メソッドの呼び出しによってデクリメントされ、 release() の呼び出しによってインクリメントされます。 カウンタがゼロのときは、 acquire() はカウンタがインクリメントされるまでブロックしますが、 try_acquire() はブロックしません。 try_acquire_for() および try_acquire_until() はカウンタがインクリメントされるかタイムアウトが満了するまでブロックします。

std::condition_variable の wait() と同様に、 counting_semaphore の try_acquire() はスプリアスに失敗することがあります。

テンプレートクラス std::counting_semaphore は DefaultConstructible でも CopyConstructible でも MoveConstructible でも CopyAssignable でも MoveAssignable でもありません。

メンバ関数

コンストラクタ	counting_semaphore を構築します (パブリックメンバ関数)
デストラクタ	counting_semaphore を破棄します (パブリックメンバ関数)
operator= [削除]	counting_semaphore は代入可能ではありません (パブリックメンバ関数)
操作
release	内部カウンタをインクリメントし、取得側スレッドのブロックを解除します (パブリックメンバ関数)
acquire	内部カウンタをデクリメントします。 できない場合はできるまでブロックします (パブリックメンバ関数)
try_acquire	ブロックせずに内部カウンタのデクリメントを試みます (パブリックメンバ関数)
try_acquire_for	内部カウンタのデクリメントを試みます。 指定した時間ブロックします (パブリックメンバ関数)
try_acquire_until	内部カウンタのデクリメントを試みます。 指定した時点までブロックします (パブリックメンバ関数)
定数
max [静的]	内部カウンタの可能な最大値を返します (パブリック静的メンバ関数)

ノート

その名前が示すように、 LeastMaxValue は最小の最大値であり、実際の最大値ではありません。 そのため、 max() は LeastMaxValue より大きな値を返すことがあります。

std::mutex と異なり、 counting_semaphore はスレッドに紐付きません。 例えば、セマフォを取得するスレッドとセマフォを解放するスレッドが違っても構いません。 counting_semaphore のすべての操作は並行的に行うことができ、特定のスレッドといかなる関係も持ちません。 ただし、デストラクタを並行的に実行することはできません (構築と異なるスレッドで実行することはできます)。

セマフォは相互排他だけでなく通知のためにもよく使用されます。 この場合、セマフォは ​0​ で初期化し、送信側が release(n) を呼んで通知するまで受信側が acquire() を試みてブロックします。 この点に関してセマフォは std::condition_variable の代替品と考えることができます (しばしば性能がより良いです)。