Symbols

[アーティクル]
04/25/2024

シンボルは、デバッグや他の診断ツールに役立ちます。シンボルファイルの内容は、言語、コンパイラ、およびプラットフォームによって異なります。大まかに言うと、シンボルはソースコードとコンパイラによって生成されたバイナリとの間のマッピングです。これらのマッピングは、Visual Studio や Visual Studio Code などのツールによって、ソースの行番号の情報またはローカル変数名を解決するために使用されます。

シンボルに関する Windows のドキュメントには、Windows のシンボルに関する詳細な情報が含まれていますが、多くの概念は他のプラットフォームにも当てはまります。

.NET のポータブル PDB 形式の詳細情報

.NET Core では、新しいシンボルファイル (PDB) 形式であるポータブル PDB が導入されました。 Windows 専用である従来の PDB とは異なり、ポータブル PDB はすべてのプラットフォームで作成および読み取りできます。

PDB とは

PDB ファイルは、コンパイラによって生成される補助ファイルであり、他のツール (特にデバッガー) に、メインの実行可能ファイルの内容、およびその生成方法に関する情報を提供します。たとえば、デバッガーによって PDB が読み取られ、foo.cs の 12 行目が実行可能ファイルの適切な場所にマップされて、ブレークポイントを設定できるようになります。 Windows PDB 形式はかなり長い時間が経過しており、さらに古い他のネイティブデバッグシンボル形式から進化したものです。最初は、ネイティブ (C/C++) プログラム用の形式でした。 .NET Framework の最初のリリースで、Windows PDB 形式は .NET をサポートするように拡張されました。

ポータブル PDB 形式は .NET Core で導入され、.NET を対象とする場合に既定で使われます。 .NET Framework を対象とする場合、プロジェクトファイルで <DebugType>portable</DebugType> を指定することでポータブル PDB シンボルを有効にできます。ポータブル PDB 形式は ECMA-335 メタデータ形式に基づいています。詳細については、「Portable PDB v1.0:書式指定。診断ツールは、System.Reflection.Metadata ライブラリを使ってポータブル PDB ファイルを読み取ることができます (例については、System.Reflection.Metadata.Document を参照)。

シナリオに適した PDB 形式を使用する

ポータブル PDB も Windows PDB も、どこでもサポートされているわけではありません。どの形式を使うかを決定するには、プロジェクトがどこで使われデバッグされるかを考慮します。両方の形式で使用およびデバッグできるようにしたいプロジェクトがある場合は、異なるビルド構成を使用して、プロジェクトを 2 回ビルドし、両方の種類のコンシューマーをサポートできます。

移植可能 PDB のサポート

ポータブル PDB は、どのオペレーティングシステムでも読み取ることができ、マネージドコードに推奨されるシンボル形式です。ただし、サポートされていないレガシツールやアプリケーションが多数あります。

.NET Framework 4.7.1 以前を対象とするアプリケーション: 行番号に戻るマッピングが含まれるスタックトレースの出力 (ASP.NET のエラーページなど)。メソッドの名前は影響を受けません。ソースファイル名と行番号のみがサポートされていません。
ildasm や .NET Reflector などの .NET 逆コンパイラを使う場合、ソース行マッピングやローカルパラメーター名は表示されません。
DIA の最新バージョンと、シンボルの読み取りに DIA を使うツール (WinDBG など) ではポータブル PDB をサポートしていますが、以前のバージョンではサポートされていません。
以前のバージョンのプロファイラーでは、ポータブル PDB がサポートされていない場合があります。

ポータブル PDB をサポートしていないツールでポータブル PDB を使うには、ポータブル PDB と Windows PDB の間で変換を行う Pdb2Pdb を使うことができます。

Windows PDB のサポート

Windows PDB の書き込みまたは読み取りは、Windows 上でのみ可能です。マネージドコードへの Windows PDB の使用は廃止されており、レガシツールでのみ必要です。一部の新しいコンパイラ機能はポータブル PDB にのみ実装されているため、Windows PDB ではなくポータブル PDB を使うことをお勧めします。

次の方法で共有