AddressSanitizer のクラウドまたは分散テスト

[アーティクル]
06/16/2023

AddressSanitizer エラーが発生したときにその場所でデバッグする必要はありません。エラーが発生した場合に AddressSanitizer 固有のすべてのコンテキストを格納するクラッシュダンプを作成するように、ランタイムを構成します。その後、そのクラッシュダンプを別の PC に送信してデバッグします。クラウドまたは分散テストで AddressSanitizer を実行するときには、オフラインデバッグによって時間を大幅に節約できます。障害が発生したテストまたは運用のインフラストラクチャでダンプを作成し、それを後から開発者 PC でデバッグすることができます。

Visual Studio デバッガーは、正確に診断された AddressSanitizer エラーを提供します。テストを再実行したり、膨大なデータセットをコピーしたり、失われたデータを検出したり、オフラインになったテストマシンを見つけたりする必要はなく、これらのバグを表示できます。必要なのは、クラッシュダンプを読み込むことだけです。

次の環境変数を設定することで、AddressSanitizer 障害時にクラッシュダンプが作成されます。

set ASAN_SAVE_DUMPS=MyFileName.dmp

Note

Visual Studio 名前付け規則に従うために、ファイル名にはサフィックス .dmp が必要です。

このダンプファイルは、後から別のマシンで Visual Studio を使用して表示できます。

Visual Studio は、元のソースコードのコンテキストでエラー情報を表示できます。 Visual Studio がこれを行うには、デバッグシンボルとインデックス付きソースコードが必要です。最適なデバッグエクスペリエンスを得るには、それらのバイナリを生成するために使用された EXE、PDB、ソースコードが一致している必要があります。

ソースとシンボルの格納の詳細については、「ソースとシンボル」セクションを参照してください。実装の詳細ときめ細かい制御については、デバッガー統合に関するページを参照してください。

例 - ビルド、テスト、分析

A、B、C の 3 つのマシンを考えます。ビルドはマシン B で行われ、テストはマシン C で実行され、障害はマシン A で分析されます。エラーは、ソースコード内のソース行と列の番号に対して報告されます。呼び出し履歴と共に、そのソースコードの正確なバージョンを使用して生成された PDB ファイル内のシンボルのセットを表示できます。

.dmp ファイルの作成に至るまでのローカルシナリオまたは分散シナリオと、その AddressSanitizer ダンプファイルをオフラインで表示するための手順を次に示します。

ローカルに .dmp を生成する

ビルド
実行可能ファイルをテストします
生成された .dmp ファイルをビルドディレクトリにコピーします
.dmp ファイルを同じディレクトリにあるペアの .pdb と共に開きます

分散システムで .dmp を生成する

ソースインデックス付けデータブロックのために PDB のビルドと後処理を行います
(.exe、.pdb) のアトミックペアをテストマシンにコピーし、テストを実行します
(.pdb、.dmp) のアトミックペアをバグ報告データベースに書き込みます
Visual Studio は、.dmp ファイルを同じディレクトリにあるペアの .pdb と共に開きます

Note

分析に使用する Visual Studio 2019 マシンは、インデックス付きソースが格納されている GitHub または内部 \\Machine\share にアクセスできる必要があります。

AddressSanitizer .dmp ファイルを表示する

デバッガー IDE が PDB ファイルとソースファイルを検出できることを確認します。
Visual Studio を開き、[コードなしで続行] を選択します。次に、[ファイル]>[開く]>[ファイル] を選択して、[ファイルを開く] ダイアログを開きます。ファイル名のサフィックスが .dmp である必要があります。

シンボルとソースへの IDE アクセスを有効にするには、ここに示す画面からもう 1 つの手順が必要です。
シンボルパスを設定し、[Debug with Native Only] (ネイティブのみを使用してデバッグ) を選択します。

このスクリーンショットは、最終的に読み込まれたダンプファイルを示しています。ソースと AddressSanitizer メタデータが読み込まれています。

Screenshot of the debugger showing source files and AddressSanitizer metadata.

ソースとシンボル

クライアントは、ソースサーバーを使用して、アプリケーションのビルドに使用されたソースファイルの正確なバージョンを取得できます。実行可能ファイルまたは DLL のソースコードは、時間の経過と共に、またバージョンごとに、変更される可能性があります。それを使用して、アプリケーションの特定のバージョンをビルドしたのと同じソースコードを確認できます。

PDB ファイルを使用して EXE をデバッグするときに、デバッガーは、埋め込みソースサーバーデータブロックを使用して、ソース管理から適切なファイルを取得できます。 /Zi コンパイラオプションによって PDB に自動的に入力された完全修飾名に対応するファイルが読み込まれます。

ソースサーバーを使用するには、pdbstr.exe を使用して srcsrv データブロックを PDB ファイルに書き込むことにより、アプリケーションの "ソースインデックス付け" を行う必要があります。詳細については、ソースサーバーとソースインデックス付けに関するページのデータブロックに関するセクションを参照してください。ソースのインデックス付けとシンボルの発行を行う手順と、デバッガーのシンボルとソースコードを指定する方法も、役に立ちます。

外部ドキュメントについては、以下を参照してください。