【Unityゆるふわアドカレ2019】UniEnumExtensionで500倍速の列挙型を扱おう【Mono.Cecil】

今日は私の誕生日なので24歳学生としては初投稿です。

この記事は[Unityゆるふわサマーアドベントカレンダー 2019](https://qiita.com/nkjzm/items/7c933bb5c772a0b75512)の19日目の記事です。
前々日17日の記事は [@nanaki_pg](https://twitter.com/nanaki_pg) さんの「[Oculusの加速度センサを使ったVR空間での移動](https://qiita.com/nanaki_pg/items/ba7fcf572cc74de41d65)」でした！
前日18日の記事は @mao_ さんの「」でした！
翌日20日の記事は [@kingyo222](https://twitter.com/kingyo222) さんの「[Unity：UI Elements でいくつかサンプル書いたよ！](https://www.fast-system.jp/unity-ui-elements-samples/)」です！
翌々日21日の記事は @yKimisaki さんの「[UIElementsでもUniRxを使いたい](https://qiita.com/yKimisaki/items/c45e9cc7d2c01199a0c3)」です！

#はじめに

[UniEnumExtension](https://pcysl5edgo.booth.pm/items/1515035)は[Booth](https://pcysl5edgo.booth.pm/items/1515035)と[GitHub](https://github.com/pCYSl5EDgo/UniEnumExtension)上で公開されているエディタ拡張のアセットです。

「UniEnumExtension」を導入することで列挙型のToStringを元々のソースコードを一切書き換えずに概ね500倍から100倍以上高速化出来ます。

#バージョン情報など

 - UniEnumExtension version 0.1.1
 - Unity2018.4, 2019.2で動作確認

#導入方法

##Gitを既にインストールしている場合

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/256047/ccd4f84d-bb0d-fd54-74fe-cea78afd9391.png)

まず初めに新規プロジェクトを作成します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/256047/9e11adfe-e138-653d-26b0-12c0a9115c22.png)

Packagesフォルダには初期時点でAnalystic LibraryやPackage Manager UIなどが含まれていますね。

次にコマンドプロンプトやターミナルなどを起動してください。
対象プロジェクト以下のPackagesフォルダに移動してください。

**git clone https://github.com/pCYSl5EDgo/UniEnumExtension**
とコマンドを入力してください。

以下のような表示になるはずです。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/256047/53e1a564-4e75-b8da-c79c-5485e5f8df2d.png)

Unityエディタに戻って見てみましょう。新たにUniEnumExtensionとMono.Cecilが増えたはずです。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/256047/a290fd42-c739-5d29-d555-19cc43fa68f9.png)

以上でインストールは終了です。 **簡単ですね！**

##Boothから購入した場合

ダウンロードしたzipファイルをその場に解凍します。
UniEnumExtension.unitypackageファイルが出てきますので、それをプロジェクトにドラッグ＆ドロップなどでインポートしてください。
LICENSE-jpはつまり開発者は全員エディタ拡張として１PCにつき１つ購入して使用することと譲渡や再頒布の禁止などを定めているものです。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/256047/9479eb2b-611f-0b36-d56f-41df58f1862c.png)

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/256047/4b7e5c66-814c-d86a-59d3-abb39256b6c5.png)

Assets/Plugins/UniEnumExtensionInstallerはGitHubからUniEnumExtensionをインストールするためだけのインストーラーです。
Packages/UniEnumExtensionを確認できたならば削除して構いません。

#使い方

特に何もせずとも列挙型の性能が良くなります。

……というのでは解説が寂しいのでもうちょっと具体的に。 メニューのWindow/UniEnumExtensionをクリックすると以下のようなウィンドウが開きます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/256047/efe1d33a-20c2-aca4-ba8f-13a8f890cb5a.png)

&quot;ProcessRewriteToString All Assemblies&quot;にチェックが入っていますが、このチェックがあることで全Playerビルドに含まれるasmdefが処理対象となります。
チェックを外してみましょう。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/256047/17413519-6c9c-a4bc-b1fe-fc4812e6d8c4.png)

UniEnumExtensionは処理対象の数に比例してコンパイル時間を長くします。列挙型が含まれないアセンブリを対象外に指定すれば処理時間は短くなります。
手元で計測した所1アセンブリあたり0.05~0.2秒ほど処理時間が掛かっていました。

#なぜこのアセットが必要なのか？

[Enums.NET](https://github.com/TylerBrinkley/Enums.NET/blob/master/README.md)に詳しいです。

 - ToStringなどでもリフレクションが走り、キャッシュが効いたり効かなかったりメソッドに依ってまちまち
 - System.Enumのメソッドは殆どが非ジェネリックであり、無駄なtypeof()が必要
  - 第２引数がobject型を要求したりするのでボクシング・アンボクシングが常に生じる
  - 戻り値の型がT[]ではなくArrayなのでキャスティング必須

さて、Enums.NETはEnumsNET名前空間とEnums静的クラスを定義することこれら問題を打破しました。
その結果、列挙型のToStringにおいて標準に比較して45倍の高速化を達成しました。
これは素晴らしいことです。

**UniEnumExtensionは標準に対して300~500倍の高速化を達成しています。**
これはMono.Cecilによる静的IL解析によりポストコンパイル時にボクシングの生じるメソッド呼び出しや仮想メソッド呼びなどを定数に置換したり、高速でアロケーションの少ない非仮想メソッド呼び出しに置換することで実現されています。

**また、全然違う機能ですが、Burst Job内でforeachが使えます！**

##いかなる場合に高速化が行われているのか

 - 処理対象のアセンブリに含まれる列挙型に対するToString呼び出し全て[1^]
 - Enum.IsDefined(typeof(具体的な型名), 定数 | 文字列型の変数) は定数埋め込みあるいは高速な関数呼び出しに置換されます[2^]
  - 特に第２引数が定数である時、真偽値の定数埋め込みに置換されます
 - Enum.GetValues(typeof(具体的な型名))は高速な配列新規生成と初期化に置換されます
 - HasFlag(Enum)で生じる2回のボクシングと仮想メソッド呼び出しは0回のボクシングと具象メソッド呼び出しまたは定数埋め込みに置換されます
 - 処理対象アセンブリに含まれる列挙型にIEquatable&lt;列挙型&gt;を実装させることでSystem.Collections.DictionaryのTKeyに指定した時の動作が高速になる場合があります

#高度なトピック

Packages/UniEnumExtension/BuildPlayer/EnumExtensionPostBuildPlayerScriptDll.csとPackages/UniEnumExtension/UI/Program.csを御覧ください。

<details><summary>EnumExtensionPostBuildPlayerScriptDll.cs は MonoビルドやIL2CPPビルド時にポストプロセスIL編集を行います。</summary><div>[UnityEditor.Build.IPostBuildPlayerScriptDLLs](https://docs.unity3d.com/ja/2018.4/ScriptReference/Build.IPostBuildPlayerScriptDLLs.OnPostBuildPlayerScriptDLLs.html)を実装したクラスはビルド時にいつの間にかインスタンス化され、コールバックが呼ばれます。コールバックのタイミングはビルドに使われる全C#ファイルがコンパイルされてDLLが出揃った時です。

```csharp
public void OnPostBuildPlayerScriptDLLs(BuildReport report)
{
    step[0] = BeginBuildStep.Invoke(report, uniEnumExtension);
    try
    {
        Implement(report);
    }
    finally
    {
        EndBuildStep.Invoke(report, step);
    }
}
```
コールバック内では特に必要は無いですが、[UnityEditor.Build.Reporting.BuildReport](https://docs.unity3d.com/ja/2018.4/ScriptReference/Build.Reporting.BuildReport.html)のinternalなAPIであるBegin/EndBuildStepを使っています。
公式リファレンス内に説明がないので具体的な働きは不明ですが、おそらくビルド時間やエラーハンドリングする際の情報量が増えるのでしょう。

```csharp
private void Implement(BuildReport report)
{
    string[] guidArray = AssetDatabase.FindAssets("t:" + nameof(ProgramStatus));
    ProgramStatus programStatus = AssetDatabase.LoadAssetAtPath<ProgramStatus>(AssetDatabase.GUIDToAssetPath(guidArray[0]));
    programStatus.Initialize();
    IEnumerable<string> targetNames = programStatus.Enables.Zip(programStatus.OutputPaths, (enable, outputPath) => (enable, Path.GetFileName(outputPath))).ToArray();
    IEnumerable<string> assemblyPaths = report.files.Where(buildFile =>
    {
        if (buildFile.role != "ManagedLibrary")
        {
            return false;
        }
        if (string.IsNullOrWhiteSpace(buildFile.path)) return false;
        string buildName = Path.GetFileName(buildFile.path);
        return targetNames.All(pair => pair.Item2 != buildName) || targetNames.First(pair => pair.Item2 == buildName).Item1;
    }).Select(buildFile => buildFile.path);
    string directoryName = Path.GetDirectoryName(report.files[0].path);
    Debug.Log(directoryName);
    using (var extender = new EnumExtender(searchDirectory: new string[1] { directoryName }))
    {
        extender.Extend(assemblyPaths);
    }
}
```
シングルトンな設定ファイルなScriptableObjectを読み込みます。
その後BuildReportのfilesプロパティでDLLやPDBファイル一覧を得られます。
その内、roleがManagedLibraryなもので設定上処理対象なDLLのみをIEnumerable&lt;string&gt; assemblyPathsに取り出します。
これをEnumExtenderのインスタンスのExtendメソッドに渡せばIL書き換えがそのアセンブリ群に対して行われます。
EnumExtenderのコンストラクタにはアセンブリの参照を解決するためのディレクトリ名を与えます。
アセンブリの参照解決って？という方は[Mono.Cecil入門](https://qiita.com/pCYSl5EDgo/items/4146989d08e169dde81d)を御覧ください。</div></details>

##高レベルAPI
using(EnumExtender extender = new EnumExtender(string[] searchDirectory))
    extender.Extend(IEnumerable&lt;string&gt; assemblyPaths);

が高レベルAPIとして露出されています。
assemblyPathsでパスを指定するとよしなに色々処理します。

##低レベルAPI
EnumExtenderにはもう１つコンストラクタがあります。

**public EnumExtender(IModuleProcessor[] moduleProcessorCollection, ITypeProcessor[] typeProcessorCollection, IMethodProcessor[] methodProcessorCollection, string[] searchDirectories)**

UniEnumExtension.IModuleProcessor, UniEnumExtension.ITypeProcessor, UniEnumExtension.IMethodProcessorはモジュール（アセンブリ）、型、メソッドに対して処理を行うインターフェースです。
コンストラクタからIL処理を登録するのですね。

上述3インターフェースは公開されていますので独自にポストコンパイル時にフックしてEnumExtenderを実行すると良いでしょう。
注意点としては、EnumExtenderは必ずDisposeしてください。DisposeすることでILの書き込みが完了します。

EnumExtenderはUniEnumExtension.IExtenderを実装していますのでその段階からすげ替えるのも良いかもしれませんね。

```csharp
public interface IExtender : IDisposable
{
    void Extend(IEnumerable<string> assemblyPaths);
}
public interface IModuleProcessor : IProcessor
{
    void Process(ModuleDefinition moduleDefinition);
}
public interface ITypeProcessor : IProcessor
{
    void Process(ModuleDefinition systemModuleDefinition, TypeDefinition typeDefinition);
}
public interface IMethodProcessor : IProcessor
{
    bool ShouldProcess(TypeDefinition typeDefinition);
    void Process(ModuleDefinition systemModuleDefinition, MethodDefinition methodDefinition);
}
```

#感想
Mono.Cecilでポストコンパイル時constexprをする可能性を感じられました。
readonlyフィールドが実現してILレベルでもなんらかの形で表現出来たならば本当にconstexprが出来ると思います。

機能追加の要望などがありましたら、[私のTwitterにDM](https://twitter.com/pCYSl5EDgo)または[GitHubでIssueを立ててください](https://github.com/pCYSl5EDgo/UniEnumExtension)。

[1^]:処理対象外のアセンブリに所属する列挙型、一例を挙げるならばUnity.Collections.Allocatorなども処理対象アセンブリ内で非ジェネリックに明示的にToStringを行う場合は高速化される。
[2^]:typeof演算子内に記入する型名はジェネリクス型ではない具体的な型名でなくてはならない。