.NET でのイメージのデバッグの簡略化
Note
この記事は .NET Framework に固有のものです。 .NET 6 以降のバージョンを含めて、.NET の新しい実装には適用されません。
アンマネージ コードをコンパイルするときは、IDE スイッチまたはコマンド ライン オプションを使用して、デバッグ用の実行可能イメージを構成できます。 たとえば、Visual C++ で /Zi コマンド ライン オプションを使用すると、デバッグ シンボル ファイル (拡張子 .pdb) が生成されます。 同様に、/Od コマンド ライン オプションを使用すると、コンパイラは最適化処理を無効にします。 出力されるコードの処理速度は低下しますが、デバッグは簡単になるため、デバッグ時にはこれらのオプションを指定することをお勧めします。
.NET Framework マネージド コードをコンパイルすると、Visual C++、Visual Basic、C# などのコンパイラにより、ソース プログラムがコンパイルされて共通中間言語 (CIL) が生成されます。 その後、実行される直前に、CIL により JIT コンパイルされて、ネイティブなマシン語コードが生成されます。 アンマネージ コードでは、IDE スイッチまたはコマンド ライン オプションを設定することにより、デバッグ用の実行可能イメージを構成できます。 ほとんど同じ方法で、デバッグ用の JIT コンパイルを構成することもできます。
このような目的で JIT を構成する場合、次の 2 つの要素が関係してきます。
開発者は、JIT コンパイラに対し、追跡情報を生成するように要求できます。 追跡情報を生成すると、デバッガーは、CIL のチェインをマシン語コードの対応部分に対応させたり、ローカル変数と関数の引数が格納される位置を追跡したりできるようになります。 .NET Framework バージョン 2.0 以降では、JIT コンパイラは常に追跡情報を生成します。そのため、要求する必要がありません。
開発者は、JIT コンパイラに対し、出力するマシン語コードを最適化しないように要求できます。
通常、指定した IDE スイッチまたはコマンド ライン オプション (/Od など) に基づいて、CIL を生成するコンパイラにより、これらの JIT コンパイラ オプションが適切に設定されます。
場合によっては、JIT コンパイラが生成するマシン語コードをデバッグしやすくするために、JIT コンパイラの動作の変更が必要となることがあります。 たとえば、製品版またはコントロールを最適化するために JIT 追跡情報の生成が必要となる場合などです。 このような場合は、初期化 (.ini) ファイルを使用します。
たとえば、MyApp.exe というアセンブリをデバッグする場合は、MyApp.exe と同じフォルダー内に MyApp.ini というテキスト ファイルを作成します。このファイルには、次の 3 行を記述します。
[.NET Framework Debugging Control]
GenerateTrackingInfo=1
AllowOptimize=0
各オプションの値として、0 または 1 を設定できます。記述しなかったオプションの値は、既定値の 0 に設定されます。 GenerateTrackingInfo を 1 に設定し、AllowOptimize を 0 に設定すると、デバッグが最も簡単になります。
.NET Framework 2.0 以降では、JIT コンパイラが GenerateTrackingInfo の値に関係なく常に追跡情報を生成しますが、AllowOptimize の値は引き続き効力を持ちます。 Ngen.exe (Native Image Generator) を使用して最適化を行わずにネイティブ イメージをプリコンパイルする場合は、AllowOptimize=0 が記述された .ini ファイルが、Ngen.exe 実行時にターゲット フォルダー内に存在している必要があります。 最適化を行わずにアセンブリをプリコンパイルした場合は、プリコンパイルされたコードを NGen.exe の /uninstall オプションを使用して削除したうえで、Ngen.exe を再度実行してコードを最適化してプリコンパイルする必要があります。 .ini ファイルがフォルダーにない場合は、Ngen.exe が既定でコードを最適化してプリコンパイルします。
アセンブリの設定は、System.Diagnostics.DebuggableAttribute によって制御されます。 DebuggableAttribute には、2 つのフィールドがあり、それぞれにより、JIT コンパイラが最適化処理を実行するかどうか、および追跡情報を生成するかどうかが制御されます。 .NET Framework 2.0 以降のバージョンでは、JIT コンパイラにより常に追跡情報が生成されます。
製品版をビルドする場合、コンパイラでは DebuggableAttribute のどちらのフィールドも設定されません。 既定で、JIT コンパイラにより最高のパフォーマンスが実現され、コンピューター コードのデバッグは最も困難になります。 JIT 追跡を有効にすると、パフォーマンスが多少低下します。最適化処理を無効にすると、パフォーマンスは大幅に低下します。
DebuggableAttribute は、アセンブリに含まれる個々のモジュールではなく、アセンブリ全体に適用されます。 そのため開発ツールでは、アセンブリが既に作成されている場合は、カスタム属性をアセンブリのメタデータ トークン、または System.Runtime.CompilerServices.AssemblyAttributesGoHere というクラスに追加できる必要があります。 次に、ALink ツールによって、これらの DebuggableAttribute 属性は、各モジュールからこれらのモジュールが構成の一部となるアセンブリへと昇格されます。 競合がある場合、ALink 操作は失敗します。
Note
.NET Framework Version 1.0 では、/clr および /Zi コンパイラ オプションを指定すると、Microsoft Visual C++ コンパイラによって DebuggableAttribute が追加されます。 .NET Framework Version 1.1 では、DebuggableAttribute をコードに手動で追加するか、 /ASSEMBLYDEBUG リンカー オプションを使用する必要があります。
関連項目
.NET