Lock クラス

公開: 2024-04-04更新: 2024-04-04

今日は、 .NET 9 で Lock クラスというのが入る予定で、それに伴って C# コンパイラーにも対応が必要そうという話。

一応雰囲気的には C# 13 に入りそう。

任意のオブジェクトを lock

C# はなぜか任意のオブジェクトインスタンスを使って排他制御ができます。ロックを掛けるために以下のようなコードを書くことになります。

class MultiThreadCode
{
    private readonly object _syncObj = new object();

    public void Run()
    {
        lock (_syncObj)
        {
            // いろんなスレッドから同時に呼ばれるコード。
        }
    }
}

Java からの習慣(= 1995年頃の発想)ですかね。 Java の synchronized ブロックも同じ仕様のはず。

本来の思想としては「lock() の () 内には同時に操作されるとまずいリソースを書く」という感じのはず。そういわれると、lock (任意のオブジェクト) に正当性があるように感じます。

class Resource;

class MultiThreadCode
{
    private readonly Resource _someResource = new();

    public void Run()
    {
        lock (_someResource)
        {
            // _someResource に対する操作をする。
            // _someResource を同時に操作されると困るんだから、「_someResource を lock」。
        }
    }
}

ですがまあ、実際のところこんなにきれいに lock (x) { x に対する操作 } になることはなく、大体は先ほどのように「lock のためだけに1個追加で object _syncObj みたいなフィールドを用意」みたいなことになります。

これがめんどくさく… とはいえ、面倒だからといって以下のようなことはしてはいけないとされています。

class MultiThreadCode
{
    public void Run()
    {
        // ✖
        // 任意のオブジェクトでロックできるということは、this でも行ける！
        lock (this)
        {
            // いろんなスレッドから同時に呼ばれるコード。
        }
    }

    public static void StaticRun()
    {
        // ✖
        // 静的メソッド内では this がない…
        // そうだ、Type 型もオブジェクトじゃん！
        lock (typeof(MultiThreadCode))
        {
            // いろんなスレッドから同時に呼ばれるコード。
        }
    }
}

「外に漏れるインスタンスでロックを取ってはいけない」というお作法があるからです。以下のようなコードを書かれる可能性があって困ります。

var x = new MultiThreadCode();

// ここの lock と、MultiThreadCode.Run 内の lock (this) が同じオブジェクトをロックする。
// 意図しない挙動のはず。
lock (x)
{
}

class MultiThreadCode
{
    public void Run()
    {
        lock (this)
        {
            // いろんなスレッドから同時に呼ばれるコード。
        }
    }
}

さらにいうと、外に漏れてダメなら以下のようなコードもダメになると。

var x = new MultiThreadCode();

// ここの lock と、MultiThreadCode.Run 内の lock (_items) が同じオブジェクトをロックする。
lock (x.Items)
{
}

class MultiThreadCode
{
    // private だから一見外に漏れてない。
    private readonly List<int> _items = [];

    public void Run()
    {
        lock (_items)
        {
            // _items に Add/Remove とかしたり。
        }
    }

    // List としては公開していないものの、
    // インスタンス自体は _items そのままなので…
    public IEnumerable<int> Items => _items;
}

なのでまあ、元の話の戻りますが、結局は「_items とは別に object _syncObj = new(); を用意」みたいなことになります。

.NET のオブジェクトヘッダー

「任意のオブジェクトに対して lock を掛けれるという仕様は意外とオーバーヘッドが大きい」という話題があったりします。なので、「ロック専用のクラスがあった方がいい」という話も。

Add first class System.Threading.Lock type

ここにこんな説明があります:

Locking on any class has overhead from the dual role of the syncblock as both lock field and hashcode et al.

(任意のクラスに対するロック操作は、ロック用の値とハッシュ値とか、syncblock に複数の役割を持たせていることによるオーバーヘッドを持つ。)

syncblock が何かという話は以下の英語の記事がわかりやすそう。

Object header get complicated

ここの図を見ての通り、27ビット目の値によって、下位ビットをハッシュ値として使うか、ロック用に使うか分岐させています。

ところがまあ、これのせいで分岐予測をミスりまくって、結構ペナルティになるみたいです。言われてみればそりゃそう。 GetHashCode と lock だったら GetHashCode の方が圧倒的に利用頻度高いでしょうから。いざ lock しようとすると分岐予測当たらないのもしょうがなく。

(あと、lock 中のオブジェクトに対して override してない object.GetHashCode を呼ぶと遅くなります。)

で、ここで、前節の「どうせロック専用のインスタンスを作ることが多い」話と合わせると、「だったらロック専用の Lock クラスを作って private readonly Lock _syncObj = new(); しようよ」ということになったりします。

System.Threading.Lock クラス

ということで、 .NET 9 では Lock クラス(System.Threading 名前空間)を追加するみたいです。現状 (.NET 9 Preview 1 とか Preview 2 時点)では、プレビュー扱いで RequiresPreviewFeatures 属性が付いていますが、一応今でも実装が入っています。

C# の lock ステートメントをどうするかはいったん置いておいて(後述)、以下のような使い方を想定しているクラスです。

using System.Runtime.Versioning;

// 今のペースなら、.NET 9 正式リリースまでには外れる気はする。
[module: RequiresPreviewFeatures]

class MultiThreadCode
{
    private readonly Lock _syncObj = new();

    public void Run()
    {
        // C# コンパイラーに手を入れないとしたらこんな使い方に。
        // lock じゃなくて using。
        using (_syncObj.EnterScope())
        {
            // いろんなスレッドから同時に呼ばれるコード。
        }
    }
}

Lock クラスが何をやっているかというと、おおむね「lock が内部で使っている C++ コード(AwareLock)を C# に移植」です。本当に、「オブジェクトヘッダーの syncblock を使うのが高コスト」を避けるためのクラスという感じです。

lock ステートメントで Lock インスタンス

ここで問題になるのが、じゃあ、Lock インスタンスに対して lock ステートメントを使うとどうなるの？というお話。「Lock の時には lock (x) じゃなくて using (x.EnterScope()) にしようね」とか言われても割と困るかと思います。知らなきゃ確実に lock (x) と書くでしょうし、知ってたって lock (x) をやらかす自信があります。

なので、C# 言語のレベルでも何らかの対処は必要だろうという話になります。 (おそらくその辺りが RequiresPreviewFeatures 属性付きになっている理由。)

Lock object

検討段階では「lock (x) すると警告を出すみたいなのだけでもいいかもしれない」なんて話もありましたが、まあ、「lock (x) と書いたらコンパイラーが using (x.EnterScope()) に置き換える」路線で行くことになりました。

この実装、 Visual Studio 17.10.0 Preview 2.0 (3週間くらい前)の時点で入ってるみたいです。以下のコードを書いて、ILSpy とかでコンパイル結果の中身を覗くと using (_syncObj.EnterScope()) に置き換わっています。

class MultiThreadCode
{
    private readonly Lock _syncObj = new();

    public void Run()
    {
        // C# コンパイラーが特殊対応することになったので、lock で OK に。
        lock (_syncObj)
        {
            // いろんなスレッドから同時に呼ばれるコード。
        }
    }
}

ちなみに、現状は Lock クラス専用です。珍しくパターンベースでなく、Lock でないと認識せず。まあ、需要がないんでしょうね。

// これは現状、既存の lock (Monitor.TryEnter を使ったコード)になる。 
lock (new MyLock())
{
}

// System.Threading.Lock と同じパターンのメソッド持ちの自作クラス。
class MyLock
{
    public Scope EnterScope() => default;

    public ref struct Scope
    {
        public void Dispose() { }
    }
}

Lock クラス

任意のオブジェクトを lock

.NET のオブジェクト ヘッダー

System.Threading.Lock クラス

lock ステートメントで Lock インスタンス

.NET のオブジェクトヘッダー