Inside FastEnum
7 likes4,849 views
Event : .NET Conf in Tokyo 2019 Date : 2019/10/27 .NET Core 3.0 がリリースされさらなるパフォーマンスチューニングが行われましたが、Enum は依然として遅いままです。FastEnum はその苦痛を緩和する世界最速の Enum Utility ライブラリです。 このドキュメントでは FastEnum の中で使われているテクニックや .NET Core 標準が遅い理由などについて解説し、速いコードを書くための一助となるようにします。
![System.Enum とほぼ同様の使用感
var values = FastEnum.GetValues<Fruits>();
var values = Enum.GetValues(typeof(Fruits)) as Fruits[];
var names = FastEnum.GetNames<Fruits>();
var names = Enum.GetNames(typeof(Fruits));
var parse = FastEnum.Parse<Fruits>("Apple");
var parse = Enum.Parse<Fruits>("Apple");
var defined = FastEnum.IsDefined(Fruits.Lemon);
var defined = Enum.IsDefined(typeof(Fruits), Fruits.Lemon);](https://image.slidesharecdn.com/insidefastenum-191027074406/85/Inside-FastEnum-15-320.jpg)
![フィールドに複数の名前を付けられる
[EnumMember] だと AllowMultiple = false なので不便
Grani 社内で使われていた便利機能のひとつ
Label 属性
// インデックス指定で取得できる
var a = Fruits.Apple.GetLabel(0); // 🍎
var b = Fruits.Apple.GetLabel(1); // りんご
// こんな定義があったとして
public enum Fruits
{
[Label("🍎", 0)]
[Label(“りんご", 1)]
Apple,
}](https://image.slidesharecdn.com/insidefastenum-191027074406/85/Inside-FastEnum-17-320.jpg)
![RuntimeType.GenericCache を使ってる
そこまでは良いのだけど、キャッシュの持ち方がよくない
ulong[] / string[] を持つだけで、それ以上のトリックがない
都度 Reflection している箇所も
Enum.GetName / Enum.IsDefined などなど
キャッシュとは何だったのか...
中途半端なキャッシュ](https://image.slidesharecdn.com/insidefastenum-191027074406/85/Inside-FastEnum-19-320.jpg)
![Static Type Caching
public static class FastEnum
{
public static IReadOnlyList<T> GetValues<T>()
where T : struct, Enum
=> Cache<T>.Values; // キャッシュを直接参照
// 静的 Generics 型のフィールドにキャッシュを持つ
private static class Cache<T>
where T : struct, Enum
{
public static readonly T[] Values;
static Cache()
=> Values = (T[])Enum.GetValues(typeof(T));
}
}
T 型ごとに
別の型扱い](https://image.slidesharecdn.com/insidefastenum-191027074406/85/Inside-FastEnum-24-320.jpg)
![[Flags] な列挙型を Parse する機能
カンマが入っているかどうかを算出するコストが大きい
滅多に使わない機能を落として大多数を救う方が理に適っている
カンマ区切り文字列は非サポート
// こんな定義があるとき
[Flags]
enum Fruits
{
Apple = 1,
Lemon = 2,
Melon = 4,
}
// System.Enum はカンマ区切り文字を Parse できる
var value = Enum.Parse<Fruits>("Apple, Melon");
Console.WriteLine((int)value); // 5](https://image.slidesharecdn.com/insidefastenum-191027074406/85/Inside-FastEnum-27-320.jpg)
![“123”, “Apple” をどう判別/解析するか
「1 文字目が数字か +/-」の場合は値で解析する
Parse<T>(“value/name”); の最適化
public static bool TryParse<T>(string value, out T result)
where T : struct, Enum
{
// フィールド名は数字/特殊記号で始められない仕様を利用
return IsNumeric(value[0])
? TryParseByValue(value, out result)
: TryParseByName(value, out result);
static bool IsNumeric(char c)
=> char.IsDigit(c) || c == '-' || c == '+';
}](https://image.slidesharecdn.com/insidefastenum-191027074406/85/Inside-FastEnum-29-320.jpg)
![FastEnum が唯一勝てなかったメソッド
引数が Enum なので呼び出すだけで box 化して超遅そうだが…
自作したものより 200 倍以上高速でアロケーションもない
// 特殊な最適化がかかってる (たぶん
[Intrinsic]
public bool HasFlag(Enum flag)
{}
Enum.HasFlag の脅威的性能](https://image.slidesharecdn.com/insidefastenum-191027074406/85/Inside-FastEnum-36-320.jpg)
![ReadOnlyCollection は foreach が超遅い
Struct Enumerator を利用した配列の読み取り専用 wrapper で解決
https://ufcpp.net/blog/2018/12/howtoenumerate/
ReadOnlyArray
public sealed class ReadOnlyArray<T> : IReadOnlyList<T>
{
private readonly T[] source;
public ReadOnlyArray(T[] source) => this.source = source;
public Enumerator GetEnumerator() => new Enumerator(this.source);
public struct Enumerator : IEnumerator<T> { /* 省略 */ }
// 以下略...
}](https://image.slidesharecdn.com/insidefastenum-191027074406/85/Inside-FastEnum-37-320.jpg)
Inside FastEnum
- 1. .NET Conf in Tokyo 2019 鈴木 孝明 Inside FastEnum
- 2. Name 鈴木 孝明 a.k.a @xin9le Work Application Engineer Award Microsoft MVP for Developer Technologies Web Site https://xin9le.net About
- 3. Remote Worker @福井 空港がない 陸の孤島 台風 19 号 北陸新幹線 復旧感謝！
- 4. 速さは正義
- 8. .NET Core is SUPER fast !!
- 10. 超絶長編記事も公開
- 12. Enum is too slow…
- 14. The world fastest Enum (FastEnum) https://github.com/xin9le/FastEnum
- 15. System.Enum とほぼ同様の使用感 var values = FastEnum.GetValues<Fruits>(); var values = Enum.GetValues(typeof(Fruits)) as Fruits[]; var names = FastEnum.GetNames<Fruits>(); var names = Enum.GetNames(typeof(Fruits)); var parse = FastEnum.Parse<Fruits>("Apple"); var parse = Enum.Parse<Fruits>("Apple"); var defined = FastEnum.IsDefined(Fruits.Lemon); var defined = Enum.IsDefined(typeof(Fruits), Fruits.Lemon);
- 16. フィールドの値/名前などを一纏めに 値/名前のペアって案外使うのに、ペアを作る処理は地味に面倒 Member<T> // フィールド情報 public sealed class Member<T> where T : struct, Enum { public T Value { get; } public string Name { get; } public FieldInfo FieldInfo { get; } public EnumMemberAttribute EnumMemberAttribute { get; } } // 超高速で簡単な取得 var xs = FastEnum.GetMembers<Fruits>(); var x1 = FastEnum.GetMember(Fruits.Apple); var x2 = Fruits.Apple.ToMember();
- 17. フィールドに複数の名前を付けられる [EnumMember] だと AllowMultiple = false なので不便 Grani 社内で使われていた便利機能のひとつ Label 属性 // インデックス指定で取得できる var a = Fruits.Apple.GetLabel(0); // 🍎 var b = Fruits.Apple.GetLabel(1); // りんご // こんな定義があったとして public enum Fruits { [Label("🍎", 0)] [Label(“りんご", 1)] Apple, }
- 18. 速くなったと言われる .NET Core 3.0 なのに、なぜ！ Why standard enum is slow?
- 19. RuntimeType.GenericCache を使ってる そこまでは良いのだけど、キャッシュの持ち方がよくない ulong[] / string[] を持つだけで、それ以上のトリックがない 都度 Reflection している箇所も Enum.GetName / Enum.IsDefined などなど キャッシュとは何だったのか... 中途半端なキャッシュ
- 20. ほぼ必ず object 型を経由する Non Generics な Array とか Enum.ToObject とかを普通に使う ulong で持っていたものを有効活用しないとか超クール Parse<T> / TryParse<T>はまとも System.Enum で Generics 版が使えるときは積極的に使う ※ .NET Core に限る ※ .NET Framework の実装は残念過ぎる Box / Unbox の雨霰
- 21. .NET Core is SUPER fast ??
- 23. 高速化のアプローチとちょっとした工夫 Why FastEnum is fast?
- 24. Static Type Caching public static class FastEnum { public static IReadOnlyList<T> GetValues<T>() where T : struct, Enum => Cache<T>.Values; // キャッシュを直接参照 // 静的 Generics 型のフィールドにキャッシュを持つ private static class Cache<T> where T : struct, Enum { public static readonly T[] Values; static Cache() => Values = (T[])Enum.GetValues(typeof(T)); } } T 型ごとに 別の型扱い
- 25. 呼び出しコスト ≒ 0 型をキーにした辞書から Lookup するよりもずっと速い BenchmarkDotNet が「計測できない」と音を上げるレベル 静的コンストラクタで事前計算 静的コンストラクタはスレッドセーフが保証されている ロックフリーにできるので、呼び出しコスト低減に大きく寄与 Static Type Caching
- 26. Non Generics API は box 化を避けられない Generics API だけでも大抵のケースに耐えられる Generics API のみをサポート // .NET Core (Box 化する) var a = Enum.GetValues(typeof(Fruits)); var b = Enum.GetName(typeof(Fruits), Fruits.Banana); var c = (Fruits)Enum.Parse(typeof(Fruits), "Apple"); var d = Enum.IsDefined(typeof(Fruits), Fruits.Lemon); // FastEnum (一切 Box 化しない) var a = FastEnum.GetValues<Fruits>(); var b = FastEnum.GetName(Fruits.Banana); var c = FastEnum.Parse<Fruits>("Apple"); var d = FastEnum.IsDefined(Fruits.Lemon);
- 27. [Flags] な列挙型を Parse する機能 カンマが入っているかどうかを算出するコストが大きい 滅多に使わない機能を落として大多数を救う方が理に適っている カンマ区切り文字列は非サポート // こんな定義があるとき [Flags] enum Fruits { Apple = 1, Lemon = 2, Melon = 4, } // System.Enum はカンマ区切り文字を Parse できる var value = Enum.Parse<Fruits>("Apple, Melon"); Console.WriteLine((int)value); // 5
- 28. 列挙型の値の連続性を利用 値が連続しているなら最大/最小範囲に入っているかを比較 辞書の ContainsKey をするより範囲チェックの方が何倍も高速 IsDefined<T>(value); の最適化 // 連続した値の列挙型 enum Fruits { Apple = 1, Lemon, // 2 Melon, // 3 Banana, // 4 } // こんな感じのイメージで判定すると速い // 連続しているかどうかは事前に判定してキャッシュ public static bool IsDefined<T>(T value) where T : struct, Enum => IsContinuous ? MinValue <= value && value <= MaxValue : Values.ContainsKey(value);
- 29. “123”, “Apple” をどう判別/解析するか 「1 文字目が数字か +/-」の場合は値で解析する Parse<T>(“value/name”); の最適化 public static bool TryParse<T>(string value, out T result) where T : struct, Enum { // フィールド名は数字/特殊記号で始められない仕様を利用 return IsNumeric(value[0]) ? TryParseByValue(value, out result) : TryParseByName(value, out result); static bool IsNumeric(char c) => char.IsDigit(c) || c == '-' || c == '+'; }
- 30. string.Equals(OrdinalIgnoreCase) が最速 StringComparison.InvariantCultureIgnoreCase より 4 倍速い 大小無視の文字列比較
- 31. キーの特殊化で EqualityComparer を廃止 GetHashCode(); と Equals(); を直呼び出しにするハック http://engineering.grani.jp/entry/2017/07/28/145035 温もりティ溢れる手作り辞書 // 正味たった 2 行だけの違い // 最終的にこの差がベンチマークに効いてくる var hash = EqualityComparer<int>.Default.GetHashCode(key); var hash = key.GetHashCode(); // faster if (EqualityComparer<TKey>.Default.Equals(next.Key, key)) if (next.Key == key) // faster
- 32. 他にもある細々したテクニックとかポイント Other tips and tricks
- 33. 列挙型を等値/大小で比較する // 具象型の場合はできるけれど... public static void Compare(Fruits left, Fruits right) { var a = left == right; // OK var b = left <= right; // OK } // Enum 制約をしていても Generics 型だとできない！ public static void Compare<T>(T left, T right) where T : struct, Enum { var a = left == right; // コンパイルエラー var b = left <= right; // コンパイルエラー var c = EqualityComparer<T>.Default.Equals(left, right); // OK } なんとか 解決したい
- 34. System.Runtime.CompilerServices.Unsafe unsafe オプションを使わずに unsafe なことをする悪い子😈 Unsafe.As を使った強制型変換 public static void Compare<T>(T left, T right) where T : struct, Enum { // ref を使った型変換 = 同一メモリ領域を別の型として参照 ref var l = ref Unsafe.As<T, int>(ref left); ref var r = ref Unsafe.As<T, int>(ref right); var a = l == r; // OK var b = l <= r; // OK }
- 35. UnderlyingType の TryParse に委譲 同一メモリ領域を参照した強制型変換なので、できちゃう😈 Unsafe.As のちょっとズルい使い方 internal sealed class Int32Operation<T> : IUnderlyingOperation<T> where T : struct, Enum { public bool TryParse(string text, out T result) { // x に書き込めば result にも書き込まれたことになる result = default; ref var x = ref Unsafe.As<T, int>(ref result); return int.TryParse(text, out x); } }
- 36. FastEnum が唯一勝てなかったメソッド 引数が Enum なので呼び出すだけで box 化して超遅そうだが… 自作したものより 200 倍以上高速でアロケーションもない // 特殊な最適化がかかってる (たぶん [Intrinsic] public bool HasFlag(Enum flag) {} Enum.HasFlag の脅威的性能
- 37. ReadOnlyCollection は foreach が超遅い Struct Enumerator を利用した配列の読み取り専用 wrapper で解決 https://ufcpp.net/blog/2018/12/howtoenumerate/ ReadOnlyArray public sealed class ReadOnlyArray<T> : IReadOnlyList<T> { private readonly T[] source; public ReadOnlyArray(T[] source) => this.source = source; public Enumerator GetEnumerator() => new Enumerator(this.source); public struct Enumerator : IEnumerator<T> { /* 省略 */ } // 以下略... }
- 39. 速さは正義 ちょっとした工夫で案外メチャクチャ速くなる！ 速いコードを書くひとつの参考になれば幸いです 本当は FastEnum は存在しない方が良い 標準が速ければ最高だし、そうあってほしい .NET Core 頑張れ FastEnum is SUPER fast !!
- 40. Enjoy high performance programming using C#!! Thank you