std::lock_guard

ヘッダ `<mutex>` で定義
template< class Mutex > class lock_guard;		(C++11以降)

クラスlock_guardは、スコープブロックの期間中ミューテックスを所有するための便利なRAIIスタイルのメカニズムを提供するミューテックスラッパーです。

lock_guardオブジェクトが作成されると、与えられたミューテックスの所有権を取得しようとします。lock_guardオブジェクトが作成されたスコープから制御が離れると、lock_guardは破棄され、ミューテックスは解放されます。

lock_guardクラスはコピーできません。

(コンストラクタ)	`lock_guard`を構築し、オプションで指定されたミューテックスをロックします。 (public メンバ関数) [編集]
(デストラクタ)	`lock_guard`オブジェクトを破棄し、基礎となるミューテックスをアンロックします。 (public メンバ関数) [編集]
operator= [削除]	コピー代入不可 (public メンバ関数) [編集]

[編集] 注釈

初心者に多い間違いは、lock_guard変数に名前を「つけ忘れる」ことです。例えば、std::lock_guard(mtx); (これはmtxという名前のlock_guard変数をデフォルト構築します) や std::lock_guard{mtx}; (これはprvalueオブジェクトを構築し、すぐに破棄されます) のようにすると、実際にはスコープの残りの期間ミューテックスを保持するロックを構築しないことになります。

std::scoped_lockは、デッドロック回避アルゴリズムを使用して複数のミューテックスをロックする機能を提供する、lock_guardの代替手段です。

(C++17以降)

[編集] 例

2つのスレッドによるvolatile変数の安全なインクリメントと安全でないインクリメントを示します。

このコードを実行

#include <iostream>
#include <mutex>
#include <string_view>
#include <syncstream>
#include <thread>
 
volatile int g_i = 0;
std::mutex g_i_mutex;  // protects g_i
 
void safe_increment(int iterations)
{
    const std::lock_guard<std::mutex> lock(g_i_mutex);
    while (iterations-- > 0)
        g_i = g_i + 1;
    std::cout << "thread #" << std::this_thread::get_id() << ", g_i: " << g_i << '\n';
 
    // g_i_mutex is automatically released when lock goes out of scope
}
 
void unsafe_increment(int iterations)
{
    while (iterations-- > 0)
        g_i = g_i + 1;
    std::osyncstream(std::cout) << "thread #" << std::this_thread::get_id()
                                << ", g_i: " << g_i << '\n';
}
 
int main()
{
    auto test = [](std::string_view fun_name, auto fun)
    {
        g_i = 0;
        std::cout << fun_name << ":\nbefore, g_i: " << g_i << '\n';
        {
            std::jthread t1(fun, 1'000'000);
            std::jthread t2(fun, 1'000'000);
        }
        std::cout << "after, g_i: " << g_i << "\n\n";
    };
    test("safe_increment", safe_increment);
    test("unsafe_increment", unsafe_increment);
}

実行結果の例

safe_increment:
before, g_i: 0
thread #140121493231360, g_i: 1000000
thread #140121484838656, g_i: 2000000
after, g_i: 2000000
 
unsafe_increment:
before, g_i: 0
thread #140121484838656, g_i: 1028945
thread #140121493231360, g_i: 1034337
after, g_i: 1034337

[編集] 欠陥報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 2981	C++17	`lock_guard<Mutex>`からの冗長な推論ガイドが提供されました。	削除

[編集] 関連項目

unique_lock (C++11)	ムーブ可能なミューテックス所有権ラッパーを実装する (クラステンプレート) [編集]
scoped_lock (C++17)	デッドロックを回避する、複数のミューテックス用のRAIIラッパー (クラステンプレート) [編集]

コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ

cppreference.com

名前空間

変種

表示

操作

std::lock_guard

目次

[編集] テンプレートパラメータ

[編集] メンバ型

[編集] メンバ関数

[編集] 注釈

[編集] 例

[編集] 欠陥報告

[編集] 関連項目

ナビゲーション

ツールボックス

メンバ型	定義
`mutex_type`	Mutex