今日も小ネタというかC# 7ネタというか、C# 7に合わせて1個ライブラリ書いたというか。

勢いで、こんなライブラリ1個作ってしまいました。 C# 7向けです(半分くらいはC# 5.0でも使えるものですが)。

• ContextFreeTask

ということで、C# 7の機能の1つについて説明。 C# 7で以下のような機能が入ります。

• 非同期メソッドの戻り値に任意の型を使えるように

ほぼ、ValueTaskのために入った機能なんですが、まあ、せっかくなので他でも使ってみようというのが今日の話。

同期コンテキスト

C#に限らずいろんなプログラミング言語で、非同期処理の後にメイン スレッドに戻ってこないといけないという制約があったりします。 特に、GUIプログラムの開発環境だとたいてい、UIがらみのクラスはメイン スレッド(UI末ラッド)からしか触れないとかそういう制約があります。

こういう、「メイン スレッドに戻らないといけない」とか、その場その場にある文脈を同期コンテキストと言います。 C#でawaitを使って非同期処理をする場合、 awaitした時点で同期コンテキストを持っていたら、 それを拾って元のコンテキストに戻ってくるようになっています。

同期コンテキストに関する説明、参考URLを探そうとしたものの… 意外とこの時期、真面目に自分のサイトを更新してなくて「書きかけ」ばっかり… 一番真面目に書いてあるのが@ITで書いたSilverlightの記事という… (XamarinとかASP.NET Coreあたりで書き直したい気もしつつ。)

• 避けて通れない「非同期処理」を克服しよう
• [雑記] GUI と非同期処理

とにかく、C#には同期コンテキストってものがあって、通常、awaitするとそのコンテキスト拾って、スレッド プールからメイン スレッドとかに自動的に戻ってきてくれる仕組みが入っています。

コンテキスト拾いすぎ

とはいえ、これはアプリのレイヤーのためにある機能であって、 逆に、ライブラリの中でコンテキストを拾っちゃうとまずかったりします。 意図しないタイミングでメイン スレッドを止めてしまって、デッドロックを起こしたりします。

ということで、ライブラリ作者は、同期コンテキストを拾わないようにするために、以下のようなコードを書くことを強要されます。

// ConfigureAwait で同期コンテキストを拾うかどうか設定できる
// 引数を false にすると拾わない
await FAsync().ConfigureAwait(false);

ライブラリを書く側の人は毎度毎度、これで苦労します。 正直に言って結構うざい…

コンテキストを拾わない Task

ってことで作ったのが ContextFreeTask。 コンテキストを拾わないTaskです。

冒頭の通り、C# 7では非同期メソッドの戻り値の型を任意に変えれるようになったので、自作してみました。

// Task の代わりに ContextFreeTask を非同期メソッドの戻り値にできる
// この中にある await は同期コンテキストを一切拾わない
private async ContextFreeTask FAsync()
{
    // この時点でどんなコンテキストで動いていようと…
    await Task.Delay(100);
    // コンテキストは拾われないので、元のコンテキストには戻らない
    await Task.Delay(100);
    // 同上、戻らない
}

private async Task GAsync()
{
    // ContextFreeTask に対する await もできる
    // この await も同期コンテキストを拾わない

    await FAsync();
    // コンテキストは拾われない
}

概ね、以下のコードと同じ挙動になります。

private async ContextFreeTask FAsync()
{
    await Task.Delay(100).ConfigureAwait(false);
    await Task.Delay(100).ConfigureAwait(false);
}

private async Task GAsync()
{
    await FAsync().ConfigureAwait(false);
}

戻り値があるとき用、すなわち、Task<TResult> の代わりの ContextFreeTask<T> もあります。

private async ContextFreeTask<string> HAsync(int n)
{
    await Task.Delay(100);
    return n.ToString();
}

中身

Task 1個だけ持つ薄いラッパー構造体で、 ほとんどの処理はTaskや、そのawaiter、async method builderへの丸投げです。 その手前にConfigureAwait(false)やSetSynchronizationContext(null);を挟んでいるだけ。

public struct ContextFreeTask<T>
{
    public Task<T> Task { get; }
}

public struct ContextFreeTaskAwaiter : ICriticalNotifyCompletion
{
    private readonly Task _value;
    public void OnCompleted(Action continuation) => _value.ConfigureAwait(false).GetAwaiter().OnCompleted(continuation);
}

public struct AsyncContextFreeTaskMethodBuilder
{
    private AsyncTaskMethodBuilder _methodBuilder;

    public void AwaitOnCompleted<TAwaiter, TStateMachine>(ref TAwaiter awaiter, ref TStateMachine stateMachine)
        where TAwaiter : INotifyCompletion
        where TStateMachine : IAsyncStateMachine
    {
        SynchronizationContext.SetSynchronizationContext(null);
        _methodBuilder.AwaitOnCompleted(ref awaiter, ref stateMachine);
    }
}

やってみて

とりあえず小ネタというか、単にライブラリ紹介だったわけですが…

まあ、この、任意の型を非同期メソッドの戻り値に使える機能、 「C# 7の新機能紹介」でもどう取り扱うかは結構悩みまして。 何せ、実用例がほんとに少ない。 なので、どうしても「ほぼ ValueTask 専用です」的な書き口に。 (ValueTask だけで十分価値は高いんですが。)

一応小ネタっぽい話もすると、この機能、C#チームからも

We estimate that in the eventual C# ecosystem maybe 5 people will write tasklike types that get mainstream adoption.

我々の見積もりでは、最終的に C# エコシステム内において、たぶんせいぜい5人くらいが、メインストリームに採用される tasklike 型を書くことになるだろう。

とか言われています(参考: C# LDM notes from 2016.08.24)。 せいぜい5人。

たぶん確実に使われそうなのとしては、

• 主目的たるValueTask
• WinRTのIAsyncOperationとの相互運用
• Rx

の3つは確定。 残りせいぜい2個ですか。

まあ、ContextFreeTaskも、作ったはいいけど、大々的に使うかどうかはちょっと悩ましかったり。 誤用(逆に使うとまずいアプリのレイヤーで使われたり。ライブラリでも、publicなところで使ってしまうと、アプリ側でコンテキストを拾い損ねる事態になりそう)がちょっと怖そうですし。