NGenとネイティブイメージ
NGen(Native Image Generator)は、.NET Frameworkのマネージドアセンブリをプロセッサー固有の機械語へ事前コンパイルし、ネイティブイメージキャッシュへ登録する仕組みです。ネイティブイメージが利用できる場合、共通言語ランタイム(CLR)はアプリケーションの実行時にILをJITコンパイルする処理を減らせるため、主に起動時間の短縮が期待できます。
NGenが対象とするのは.NET Frameworkです。現在の.NET(旧称.NET Core)で使用されるReadyToRunやCrossgen2とは別の仕組みです。
NGenの仕組み
.NET Frameworkのアセンブリには、通常、CPUが直接実行する機械語ではなくILが格納されています。CLRはメソッドが初めて呼び出されたときにJITコンパイラーでILを機械語へ変換します。
NGenを使用すると、この変換をあらかじめ実行して、生成した機械語をネイティブイメージキャッシュへ保存できます。アプリケーションの起動時に、CLRがアセンブリ、依存関係、実行環境に適合するネイティブイメージを見つけると、そのイメージを使用します。
ネイティブイメージは元のアセンブリを置き換えるものではありません。CLRは実行時のアセンブリのバインドや型情報などに元のアセンブリを引き続き使用します。また、アセンブリや依存関係、.NET Frameworkが更新されると、以前に生成したネイティブイメージを利用できなくなる場合があります。その場合は新しい環境に合わせてネイティブイメージを再生成します。
NGenによって常に実行速度が向上するわけではありません。事前コンパイルはJITコンパイラーが実行時に利用できる情報を使えない場合があり、ネイティブイメージはディスクや仮想アドレス空間も使用します。一般的には、JITコンパイルの比率が高く、起動時間が重要なデスクトップアプリケーションで効果を確認したうえで利用するとよいでしょう。
AnyCPUのアセンブリをNGenで処理する場合
元のアセンブリがAnyCPUでも、NGenで生成するネイティブイメージはCPUアーキテクチャ固有です。AnyCPUのILは実行するプロセスに合わせて機械語へ変換できますが、変換後の機械語をx86とx64で共用することはできません。
.NET Framework 4.xでは、使用するngen.exeによって生成対象が異なります。
%windir%\Microsoft.NET\Framework\v4.0.30319\ngen.exe:x86用のネイティブイメージを生成します。%windir%\Microsoft.NET\Framework64\v4.0.30319\ngen.exe:x64用のネイティブイメージを生成します。
AnyCPUのDLLは、読み込むプロセスが32ビットならx86用、64ビットならx64用のネイティブイメージを使用します。AnyCPUのEXEでは、OSや「32ビットを優先」設定などによってプロセスのビット数が決まります。対応する有効なイメージがない場合は、通常どおりJITコンパイルへフォールバックします。
したがって、同じAnyCPUのアセンブリをx86とx64の両方のプロセスで使用し、どちらでもNGenの効果を得たい場合は、64ビット版Windows上で両方のngen.exeを使ってそれぞれ生成します。一方だけを実行しても、もう一方のアーキテクチャ用のイメージまで生成されるわけではありません。
アプリケーション開発者がNGenの利用を検討する場合の注意点
自分のアセンブリにNGenを適用する場合も、「事前コンパイルすれば速くなるかもしれない」という理由だけで対象を増やすのではなく、実際のアプリケーションで効果を測定して判断することがおすすめです。MicrosoftのNGenのドキュメントでも、主要な配布・実行シナリオでの慎重な性能測定が必要とされています。
NGenは、実行時に行うコンパイルの一部をインストール時や更新後へ移す仕組みです。アプリケーション本体や依存アセンブリ、.NET Frameworkが更新されると再生成が必要になる場合があり、Windows Updateやアプリケーションのインストール・更新に伴う処理時間や、その後のバックグラウンド負荷が増えることがあります。生成したイメージのディスク使用量に加え、配布後も登録・更新・アンインストールを管理する保守コストが生じます。
採用前には、次のような点を確認するとよいでしょう。
- 起動時間の改善幅:NGenの有無で、起動から実際に操作可能になるまでの時間を比較します。再起動後などのコールドスタートと、ファイルがキャッシュされた状態での再起動を分け、複数回測定すると評価しやすくなります。
- 実際のボトルネック:起動時間の主因がディスクI/Oやネットワーク待ちであれば、JITコンパイルを減らしても十分な改善が得られない可能性があります。
- 更新時の負担:初回インストールだけでなく、アプリケーションや依存関係の更新後の再生成にかかる時間と負荷も評価します。更新頻度が高いアセンブリでは、継続的なコストにも注意が必要です。
- 配布・保守の対応範囲:必要なx86/x64用イメージの生成、管理者権限での登録、更新・削除、失敗時の調査をインストーラーなどで扱えるか確認します。
すべてのアセンブリへ一律に適用するよりも、起動時のJITコンパイルの負担が大きく、実測で効果を確認できた対象に絞る方法が考えられます。起動時間などの改善が、インストール・更新時間や保守の負担を上回る場合に選択するとよいでしょう。
ネイティブイメージの格納先
NGenが生成したネイティブイメージは、元のアセンブリとは別に、コンピューター全体で管理されるネイティブイメージキャッシュへ保存されます。x86/x64環境での代表的な格納先は次のとおりです。%windir%はWindowsのインストール先で、通常はC:\Windowsです。
| .NET Frameworkの世代 | 対象 | 格納先 |
|---|---|---|
| 2.0~3.5 | 32ビット(x86) | %windir%\assembly\NativeImages_v2.0.50727_32 |
| 2.0~3.5 | 64ビット(x64) | %windir%\assembly\NativeImages_v2.0.50727_64 |
| 4.x | 32ビット(x86) | %windir%\assembly\NativeImages_v4.0.30319_32 |
| 4.x | 64ビット(x64) | %windir%\assembly\NativeImages_v4.0.30319_64 |
.NET Framework 3.0/3.5はCLR 2.0を使用するため、キャッシュのフォルダー名もv2.0.50727です。同様に、.NET Framework 4.8/4.8.1でもv4.0.30319が使われます。利用している.NET FrameworkやCPUアーキテクチャによって、存在するフォルダーは異なります。
各フォルダーの下には、アセンブリ名や生成されたイメージの識別子ごとのサブフォルダーがあり、System.Xml.ni.dllのような*.ni.dllや*.ni.exeという名前のファイルが格納されます。
GACとの違い
グローバルアセンブリキャッシュ(GAC)は、共有するマネージドアセンブリを登録する場所です。一方、ネイティブイメージキャッシュは、アセンブリから事前コンパイルした結果を保存する場所であり、GACそのものではありません。GACに登録されていないアプリケーションのアセンブリも、NGenの対象にできます。
.NET Framework 2.0~3.5では、GACとネイティブイメージキャッシュはどちらも%windir%\assembly配下にありますが、別のサブフォルダーで管理されます。.NET Framework 4以降ではGACが%windir%\Microsoft.NET\assembly配下へ移った一方、ネイティブイメージキャッシュは引き続き%windir%\assembly\NativeImages_v4.0.30319_*配下にあります。
キャッシュ内のファイルを直接削除・置換すると、NGenが管理する状態との整合性を損なうおそれがあります。削除や再生成にはngen.exeを使用し、フォルダーを直接操作しないでください。
ネイティブイメージを生成する処理
インストーラーはngen.exeへ処理を登録し、ネイティブイメージの生成を後から実行させることができます。.NET Framework 4.5以降をWindows 8以降で使用する場合、この保留された処理はWindowsのタスクスケジューラに登録されたNative Image Taskによって実行されます。
64ビット版Windowsでは、32ビット用と64ビット用に次のタスクが登録されます。
.NET Framework NGEN v4.0.30319.NET Framework NGEN v4.0.30319 64
タスクは通常、コンピューターがアイドル状態のときに起動し、保留されている生成や更新を処理して終了します。処理中はngentask.exeが動作します。古いWindowsでは、タスクの代わりに.NET Framework Optimization Service(mscorsvw.exe)が同様の処理を行います。
ネイティブイメージを強制的に再生成する方法
生成済みのネイティブイメージの破損が疑われる場合や、更新プログラムの適用後・アプリケーションのインストール後などに、以前の生成結果や現在の有効・無効の判定にかかわらず新しいネイティブイメージを生成し直したい場合は、ngen update /forceによる強制再生成が調査や切り分けの選択肢になります。これは、NGenへ登録済みのアセンブリを対象とする処理であり、未登録のアプリケーションを新たに登録するものではありません。
次の例は、/queueを組み合わせて強制再生成を予約するものです。管理者権限のコマンドプロンプトで実行します。
32ビット版Windowsでは、次のコマンドを実行します。
%windir%\Microsoft.NET\Framework\v4.0.30319\ngen.exe update /force /queue
64ビット版Windowsでは、32ビット用と64ビット用の両方を実行します。それぞれ別のネイティブイメージキャッシュが対象になります。
%windir%\Microsoft.NET\Framework\v4.0.30319\ngen.exe update /force /queue
%windir%\Microsoft.NET\Framework64\v4.0.30319\ngen.exe update /force /queue
強制再生成は、日常的なメンテナンスや、更新・インストールのたびに実行することを勧めるものではありません。通常の更新処理やアイドル時の自動処理で問題がなければ、そちらに任せるとよいでしょう。強制再生成自体にも負荷がかかり、更新後の高負荷を常に短時間で解消したり、破損が疑われる状況を必ず修復したりできるわけではありません。
なお、Microsoftのサポート記事Installing updates for the Microsoft .NET Framework 4 can take longer than expected in some scenariosでもupdate /force /queueを利用するシナリオが紹介されています。
/force、/queue、executeQueuedItemsの違い
/forceは「何を再生成するか」、/queueは「いつ生成するか」を変更します。組み合わせることはできますが、役割は異なります。
| コマンド | 再生成の対象 | 実行のタイミング |
|---|---|---|
ngen update | 無効になったネイティブイメージを更新する | その場で同期的に処理する |
ngen update /force | 以前の生成結果にかかわらず、強制的に再生成する | その場で同期的に処理する |
ngen update /queue | 無効になったネイティブイメージの更新を予約する | キューに登録し、生成は後から行う |
ngen update /force /queue | 強制的な再生成を予約する | キューに登録し、生成は後から行う |
ngen executeQueuedItems | すでにキューへ登録されている生成・更新処理を実行する | アイドル状態を待たず、その場で同期的に処理する |
/forceがないupdateは、有効な既存イメージまで一律に作り直すものではありません。一方、/forceを付けると再生成の対象が増え、CPUやディスクへの負荷、処理時間が増える可能性があります。
update /queueで予約される更新は優先度3となり、通常はアイドル時に実行されます。/queueを付けない場合は、その場で更新処理を行い、コマンドの終了まで待ちます。/forceを付けるだけではバックグラウンド実行にはなりません。
executeQueuedItemsは/forceの代わりにはなりません。既存のキューを処理するアクションであり、それ自体がキャッシュ全体の強制再生成を予約するわけではないためです。引数を省略すると、すべての優先度の保留中の処理が対象になります。なお、正式な構文はngen executeQueuedItemsで、/executeQueuedItemsというオプションではありません。
更新プログラムのインストール後にPCが遅くなる理由
.NET Frameworkや共有アセンブリが更新されると、それらに依存する既存のネイティブイメージが無効になる場合があります。更新後は、無効になったイメージを新しいバイナリに合わせて再生成する処理がキューへ登録されます。
ネイティブイメージの生成ではCPU、ディスクI/O、メモリを使用します。多くのアセンブリが更新対象になると、Windows Updateの完了後や再起動後に一時的な負荷として見えることがあります。Microsoftの.NET Blogでも、.NET Frameworkのインストール時とWindows Updateによるサービス更新時に最適化処理が動作し、完了までPCが遅く感じられる場合があると説明されています。
通常は処理が完了するまで待つとよいでしょう。タスクやサービスを強制終了するとキューに処理が残り、次回のアイドル時などに再開されます。負荷が長時間継続する場合は、タスクスケジューラやイベントログで同じ処理が繰り返し失敗していないか確認します。所要時間は更新対象のアセンブリ数やシステムの性能に依存しますので一概には言えませんが、数時間程度かかることもありますので気長に待ちましょう。優先度は低く設定されているため、コンピューターのCPU使用率が高くても通常の使用中に大きな影響はあまりないはずです。
ngentask.exeがクラッシュした場合
NGenはアプリケーションを実行するための唯一のコンパイル手段ではありません。有効なネイティブイメージを使用できないメソッドは、通常どおりCLRのJITコンパイラーによって実行時にコンパイルされます。そのため、ngentask.exeのクラッシュが一度記録されただけで、.NET Frameworkアプリケーションに起動失敗や機能障害が発生していなければ、直ちに対処が必要になる可能性は低いと考えられます。
ただし、次の状況では無視せずに調査した方がよいでしょう。
ngentask.exeのクラッシュが繰り返し記録される- 同じ時刻に.NET RuntimeやWindows Error Reportingのエラーが記録される
- .NET Frameworkアプリケーションの起動が著しく遅い状況が継続する
繰り返し失敗する場合やWindows Error Reportingのエラーが記録される場合は、イベントログに記録された例外コードと障害モジュールを確認したり、クラッシュダンプを解析するなどして原因を特定することも検討が必要かもしれません。アプリケーションの起動が遅い場合は、Process MonitorやWindows Performance Analyzerなどのツールを使用し、ネイティブイメージを使用できずJITコンパイルが必要となっていることがボトルネックになっていないか確認するとよいでしょう。
ngen.logとngen.old.logの確認
NGenの処理結果や失敗の詳細は、ngen.logに記録されます。ngen.old.logはログのローテーションに伴って残された以前のログです。直近の処理だけでなく、その前の経緯を調べたい場合は両方を確認します。ただし、過去の処理がすべて保存されているとは限りません。
.NET Framework 4.xでは、通常、次のフォルダーにあります。ネイティブイメージキャッシュそのものとは別の場所です。
| 対象 | ログのあるフォルダー |
|---|---|
| 32ビット用NGen | %windir%\Microsoft.NET\Framework\v4.0.30319 |
| 64ビット用NGen | %windir%\Microsoft.NET\Framework64\v4.0.30319 |
.NET Framework 2.0~3.5のNGenを調べる場合は、対応するv2.0.50727フォルダーを確認します。調査対象の.NET Frameworkとアーキテクチャを合わせ、事象が発生した時刻、対象アセンブリ、エラー内容を照合するとよいでしょう。
失敗の記録が多い場合の考え方
ログに多数の失敗が記録されていても、その件数だけでアプリケーションや.NET Frameworkが壊れているとは判断できません。たとえば、利用していないオプション機能の依存アセンブリが見つからないなど、実際に使用する機能には影響しない記録が含まれる場合があります。
ネイティブイメージを生成できなくても、元のILアセンブリと実行時に必要な依存関係が正常であれば、通常はJITコンパイルで動作します。アプリケーションの起動・機能・性能に問題がなく、NGenの負荷も継続していなければ、ログの失敗をすべて解消しようと過度に心配する必要はありません。失敗記録だけを理由に、強制再生成や.NET Frameworkの修復を繰り返すことはおすすめしません。
一方、次のような状況では、ログを手掛かりに調査するとよいでしょう。
- 同じアセンブリの生成失敗が繰り返され、CPUやディスクへの負荷が長時間続く
- 起動時間が明らかに悪化し、期待したネイティブイメージが使用されていない
- 実際に使用する機能で、アセンブリの読み込みエラーやクラッシュが起きている
ネイティブイメージの読み込みを無効にする方法
すべてのネイティブイメージを対象にする場合
.NET Frameworkでは、環境変数COMPlus_ZapDisableを1に設定してから対象アプリケーションを起動すると、NGenで生成されたネイティブイメージを使用せず、JITコンパイルで実行させることができます。ネイティブイメージの使用有無で挙動を比較したい場合や、デバッグ時の切り分けに利用できます。
システム全体の環境変数を変更するのではなく、調査用に開いたコマンドプロンプト内だけで設定する方法がおすすめです。次の例では、C:\Apps\MyApp.exeを調査対象の実行ファイルに置き換えます。
set "COMPlus_ZapDisable=1"
"C:\Apps\MyApp.exe"
環境変数は、そのコマンドプロンプトから起動したプロセスと、そこから起動される子プロセスに継承されます。すでに起動しているアプリケーションには適用されないため、対象を終了してから起動し直します。既存プロセスに処理を引き渡すアプリケーションでは、その既存プロセスも終了しておく必要があります。
比較を終えたら対象アプリケーションを終了し、次のコマンドで設定を解除してから再起動します。調査用のコマンドプロンプトを閉じても、そのプロンプト内の設定は破棄されますが、すでに起動したアプリケーションの設定は変わりません。
set "COMPlus_ZapDisable="
この設定は実行時の読み込みを抑止するものです。キャッシュ内のネイティブイメージは削除されず、Native Image TaskやOptimization Serviceによる生成処理も停止しません。更新後のNGenのCPU負荷を止めるための設定とは区別するとよいでしょう。
JITコンパイルが増えるため、起動時間やCPU使用量などの性能が変わる可能性があります。恒久的な無効化ではなく、影響を確認しながら調査対象に限定して使用すると安心です。
特定のアセンブリだけを対象にする場合
対象のアセンブリが分かっている場合は、COMPLUS_DisableNativeImageLoadList環境変数で、そのアセンブリだけネイティブイメージの読み込みを抑止できます。Microsoftの.NET Framework 4.6でWCFのXML SOAPメッセージ送信が遅くなる問題のサポート記事では、System.Runtime.Serializationを対象にした設定が紹介されています。
set "COMPLUS_DisableNativeImageLoadList=System.Runtime.Serialization"
"C:\Apps\MyApp.exe"
値には、.dllなどの拡張子を除いたアセンブリの単純名を指定します。複数指定する場合は、MicrosoftのRyuJITのトラブルシューティング資料で説明されているように、セミコロン(;)で区切ります。たとえば、System.Runtime.SerializationとSystem.Xmlを対象にする場合は次のようになります。
set "COMPLUS_DisableNativeImageLoadList=System.Runtime.Serialization;System.Xml"
設定してから対象アプリケーションを起動し直します。環境変数の継承範囲や既存プロセスへの注意点は、前述のCOMPlus_ZapDisableと同じです。COMPlus_ZapDisable=1も設定されていると全体の抑止になるため、アセンブリ単位で比較する際はそちらを解除しておきます。調査後は対象アプリケーションを終了し、次のコマンドで設定を解除してから再起動します。
set "COMPLUS_DisableNativeImageLoadList="
アプリケーション構成ファイルで指定する方法
環境変数の代わりに、対象のMyApp.exe.configなどの<configuration>内にある<runtime>へ<disableNativeImageLoad>を追加する方法もあります。複数のアセンブリを対象にする場合は、<assemblyIdentity>を複数記述します。
<configuration>
<runtime>
<disableNativeImageLoad>
<assemblyIdentity name="System.Runtime.Serialization" />
<assemblyIdentity name="System.Xml" />
</disableNativeImageLoad>
</runtime>
</configuration>
既存の構成ファイルがある場合は全体を置き換えず、既存の<configuration>と<runtime>へ設定を統合します。調査後は追加した<disableNativeImageLoad>を削除し、アプリケーションを再起動します。
同資料には、HKEY_CURRENT_USER\SOFTWARE\Microsoft\.NETFrameworkまたはHKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFrameworkの文字列値(REG_SZ)DisableNativeImageLoadListに、同じセミコロン区切りの値を設定する方法も記載されています。ただし、レジストリ設定は対象アプリケーション以外にも影響し得るため、切り分けにはプロセス単位の環境変数やアプリケーション構成ファイルを使う方が影響範囲を限定できます。
WCFのサポート記事は、.NET Framework 4.6の特定の性能問題に対し、読み込み抑止に加えてCOMPLUS_useLegacyJit=1で旧JITへ切り替える回避策を紹介しています。ネイティブイメージを使うかどうかとどのJITを使うかは別の設定です。読み込み抑止だけを比較したい場合に、旧JITへの切り替えまで一律に追加する必要はありません。記事の回避策を適用する場合は、対象の.NET Frameworkのバージョンや実行環境も確認するとよいでしょう。
アセンブリ単位の設定も、キャッシュの削除やNGenの生成処理の停止は行いません。原因となるアセンブリを特定できている場合は、全体を無効にするよりも対象を絞った設定が適しています。
ネイティブイメージが読み込まれているか確認する方法
*.ni.dllや*.ni.exeというファイル名は、NGenのネイティブイメージを見分ける手掛かりになります。対象プロセスが読み込んだファイルの名前とフルパスを調べ、前述のネイティブイメージキャッシュから読み込まれているかを確認するとよいでしょう。
Process Explorerで確認する
- Process Explorerで対象プロセスを選択します。
- 下部ペインを表示し、DLL表示モードに切り替えます。
- 一覧の名前とパスを確認し、
System.Xml.ni.dllなどのファイルがNativeImages_v2.0.50727_*やNativeImages_v4.0.30319_*配下から読み込まれているかを調べます。
Process ExplorerのDLL表示モードでは、DLLに加えてメモリマップされたファイルも確認できます。単にファイルハンドルが開かれているだけの状態とは区別して確認します。
Process Monitorで確認する
Process Monitorでは、対象アプリケーションの起動前から記録し、対象のプロセスIDとLoad Image操作で絞り込む方法があります。*.ni.dllや*.ni.exeへの成功したLoad Imageイベントとそのパスは、ネイティブイメージが読み込まれたことを確認する手掛かりになります。ファイルを探したり開いたりする操作だけでは、実際にイメージとして読み込まれたとは判断できません。
ディスク上にネイティブイメージが存在することや、ngen displayに表示されることは、特定のプロセスで実際に使われている証拠ではありません。また、ネイティブイメージが読み込まれていても、すべてのメソッドでJITコンパイルが不要になるとは限りません。逆に一覧に見当たらない場合も、確認時点では対象アセンブリがまだ読み込まれていない可能性があるため、対象の機能を実行したうえで確認するとよいでしょう。
状態を確認するコマンド
ngen.exeのdisplayアクションでは、ネイティブイメージキャッシュに登録されているイメージを確認できます。queue statusでは、Native Image Serviceのキューの状態を確認できます。コマンドは対象となる.NET FrameworkとCPUアーキテクチャに対応したDeveloper Command Promptなどから、管理者権限で実行します。
ngen display
ngen queue status
保留中の処理を直ちに実行するexecuteQueuedItemsも用意されていますが、実行中は負荷が高くなる可能性があります。通常はアイドル時の自動処理に任せ、障害調査などで完了を待つ必要がある場合に使用するとよいでしょう。
ngen executeQueuedItems
参考資料
- Ngen.exe (Native Image Generator) - .NET Framework | Microsoft Learn
- Improving startup performance with NGen | Microsoft Learn
- Process Explorer | Microsoft Learn
- Process Monitor | Microsoft Learn
- Installing updates for the Microsoft .NET Framework 4 can take longer than expected in some scenarios | Microsoft Support
- JIT Optimization and Debugging | Microsoft Learn
- Performance issue when you use WCF to send XML SOAP messages in the .NET Framework 4.6 | Microsoft Support
- .NET Framework - Troubleshooting RyuJIT | microsoft/dotnet
- Wondering why mscorsvw.exe has high CPU usage? You can speed it up. | .NET Blog
- Handling GAC and NGEN Operations after Reboot | Visual Studio Setup
- .NET Framework Repair Tool | Microsoft Learn