「Unsafe クラス(保証外)」ではわざわざ動作保証のない相当に邪悪なコードを紹介しました。
とはいえ、別に Unsafeクラスを使った瞬間に動作保証がなくなるわけではありません。
単に、開発者の裁量に任されるというだけで、正しく使えば問題は起こしません。
例えば、Unsafe.Asメソッドは型チェックをせずに型を強制変換するメソッドですが、
最初から(Asメソッドよりも前に予めチェックして)型がわかっているなら何も問題ありません。
Union 型
例として、「A または B のどちらか」を表す型を作ってみましょう。
単なる例にそんなに凝っても仕方がないので、今回は「string または char[]」で作ります。
is 演算子実装
素直に実装すると以下のようになります。
using System;
public readonly struct StringOrCharArray
{
private readonly object _value;
public StringOrCharArray(string s) => _value = s;
public StringOrCharArray(char[] array) => _value = array;
public ReadOnlySpan<char> Span
=> _value is string s ? s.AsSpan() :
_value is char[] a ? a.AsSpan() :
default;
}
見てほしいのはSpanプロパティの部分です。
この中で使っているis演算は、
実際のところ、以下のような as + null チェックと等価です。
var s = _value as string;
if (s != null) ...
で、as 演算子は IL 的には isinst 命令になってます。
isinst 命令は要は実行時型情報を調べる命令です。 実行時型情報と言っても、動的コード生成をしない(単に型を調べるだけ)ならそこまで高コストではありません。 なので、動的コード生成みたいに「静的なコードに比べて2桁遅い」みたいな事態にはなりません。
型弁別用の enum 値
しかし、今日は「ちょっとのコスト」も避けようという話なので、 この isinst 命令を消すことを考えます。
object 型のフィールドに加えて、型弁別用の enum 値を別途持ってみることにします。
ただ、素直な実装をしてしまうと「コスト避け」の試みは失敗します。
using System;
public readonly struct StringOrCharArray
{
public Discriminator Type { get; }
private readonly object _value;
public StringOrCharArray(string s) => (Type, _value) = (Discriminator.String, s);
public StringOrCharArray(char[] array) => (Type, _value) = (Discriminator.CharArray, array);
public ReadOnlySpan<char> Span
{
get
{
// せっかく Type を見て switch してるのに…
switch (Type)
{
default: return default;
// この2行のキャストが余計。
case Discriminator.String: return ((string)_value).AsSpan();
case Discriminator.CharArray: return ((char[])_value).AsSpan();
}
}
}
}
enum 値を見て switch していますが、分岐の先で結局キャストしています。 キャストの方は caltclass 命令になるんですが、 この命令は内部的に isinst 命令と大差ないみたいで、実行時間もほとんど同じです。
これがこのクラスの失敗理由で、 「せっかく事前に enum 値で型を判定してるのに、castclass 命令で改めて型チェックをしてて、単に2重の負担がかかってるだけ」 という状態になっています。 結果的に、先ほどの is 演算子実装よりもちょっとだけよりも遅くなります。
Unsafe 実装
ということで、Unsafe。
先ほどの Span プロパティを以下のように書き換えます。
using System;
using System.Runtime.CompilerServices;
public readonly struct StringOrCharArray
{
// 先ほどと同じところは割愛
public ReadOnlySpan<char> Span
{
get
{
// せっかく Type を見て switch してるんだから
switch (Type)
{
default: return default;
// キャストを Unsafe.As で置き換えれば高速。
case Discriminator.String: return Unsafe.As<object, string>(ref Unsafe.AsRef(_value)).AsSpan();
case Discriminator.CharArray: return Unsafe.As<object, char[]>(ref Unsafe.AsRef(_value)).AsSpan();
}
}
}
}
Unsafe.Asメソッドは型チェックをすっとばしてるので高速です。
名前通り unsafe ではありますが、今回の場合、事前に enum 値で型を調べているので問題は起こしません。
この実装であれば、当初目的である isinst 命令を避けることができます。 前述の通り桁違いな速度差が出るわけではないんですが、 元の is 演算子実装より数割程度速くなります。
ベンチマーク: DiscriminatedUnion
フィールドが増えてる
今回の例では、型チェックの負担は減りますが、
代わりにフィールドが1つ増えています。
構造体サイズも倍になってしまい、コピーのコストが発生してしまいます。
(Spanプロパティのアクセスよりも、変数のコピーの頻度が圧倒的に多い場合、むしろ遅くなる可能性があります。)
ということで使いどころには注意が必要です。
ただ、実装によってはこのコストは避けれます。
例えば、標準ライブラリ中のMemory<T>構造体(System名前空間)は以下のような構造になっています。
public readonly struct Memory<T>
{
private readonly object _object;
private readonly int _index;
private readonly int _length;
}
Memory構造体は、以下のような前提で、フィールドを増やさずに isinst 命令を避けたりしています。
_index(配列の開始インデックス)も_length(そこから何要素抜き出すか)も、負にはならない- 負にならないのなら、最上位ビットが 1 になることはあり得ない
- その最上位ビットを、型弁別用に使う