デバッガーエンジンの基本

[アーティクル]
03/27/2024

このドキュメントでは、デバッガーエンジンを使用する方法と、WinDbg、KD、CDB、および NTSD で実行される拡張機能を記述する方法について説明します。これらのデバッガー拡張機能は、Microsoft Windows でユーザーモードまたはカーネルモードのデバッグを実行するときに使用できます。

デバッガーエンジン

デバッガーエンジンには、Microsoft Windows のユーザーモードとカーネルモードでデバッグターゲットを調べて操作するためのインターフェイスが用意されています。

デバッガーエンジンは、ターゲットの取得、ブレークポイントの設定、イベントの監視、シンボルのクエリ、メモリの読み取りと書き込み、ターゲット内のスレッドとプロセスの制御を行うことができます。

デバッガーエンジンを使用して、デバッガー拡張機能ライブラリとスタンドアロンアプリケーションの両方を記述できます。このようなアプリケーションは デバッガーエンジンアプリケーションです。 デバッガー エンジンのすべての機能を使用するデバッガーエンジンアプリケーションは、デバッガーです。たとえば、WinDbg、CDB、NTSD、KD はデバッガーです。デバッガーエンジンは、その機能のコアを提供します。

デバッガーエンジン API は、ヘッダーファイル dbgeng.h のプロトタイプによって指定されます。

不完全なドキュメント

これは暫定的なドキュメントであり、現在は不完全です。

ここにまだ記載されていないデバッガーとデバッガーエンジンに関連する多くの概念については、このドキュメントの「デバッグ手法」セクションを参照してください。

デバッガーエンジン API の現在文書化されていない機能の一部を取得するには、Execute メソッドを使用して個々のデバッガーコマンドを実行します。

拡張機能

拡張 DLL を作成して構築することで、独自のデバッグコマンドを作成できます。たとえば、複雑なデータ構造を表示する拡張コマンドを記述できます。

デバッガー拡張 DLL には 3 つの異なるタイプがあります。

DbgEng 拡張機能 DLLs これらは、dbgeng.h ヘッダーファイル内のプロトタイプに基づいています。この種類の各 DLL は、DbgEng 拡張コマンドをエクスポートできます。これらの拡張機能コマンドはデバッガーエンジン API を使用し、WdbgExts API を使用することもできます。
EngExtCpp 拡張機能 DLLs これらは、engextcpp.h および dbgeng.h ヘッダーファイルのプロトタイプに基づいています。この種類の各 DLL は、DbgEng 拡張コマンドをエクスポートできます。これらの拡張コマンドでは、デバッガーエンジン API と EngExtCpp 拡張フレームワークの両方が使用され、WdbgExts API を使用することもできます。
WdbgExts 拡張 DLLs これらは、wdbgexts.h ヘッダーファイル内のプロトタイプに基づいています。この種類の各 DLL は、1 つ以上の WdbgExts 拡張コマンドをエクスポートします。これらの拡張コマンドでは、WdbgExts API のみを使用します。

DbgEng API を使用して、拡張機能またはスタンドアロンアプリケーションを作成できます。 WdbgExts API には、デバッガエンジン API の機能のサブセットが含まれており、拡張機能によってのみ使用できます。

すべてのデバッガー拡張機能は、ビルドユーティリティを使用してコンパイルおよびビルドする必要があります。ビルドユーティリティは、Windows Driver Kit (WDK) に含まれています。

カスタムインストールを実行し、SDK コンポーネントとそのすべてのサブコンポーネントを選択した場合、拡張コードサンプルは Debugging Tools for Windows パッケージの一部としてインストールされます。これらは、Debugging Tools for Windows インストールディレクトリの sdk\samples サブディレクトリにあります。

新しいデバッガー拡張機能を記述する最も簡単な方法は、サンプル拡張機能を調査することです。各サンプル拡張機能には、ビルドユーティリティで使用するメイクファイルとソースファイルが含まれています。どちらの種類の拡張機能もサンプルで表されます。

カスタム分析デバッガー拡張機能の作成

分析拡張機能プラグインを記述することにより、!analyze デバッガーコマンドの機能を拡張できます。分析拡張機能プラグインを提供することにより、独自のコンポーネントまたはアプリケーションに固有の方法でバグチェックまたは例外の分析に参加できます。分析拡張機能プラグインを記述するときは、プラグインを呼び出す状況を記述するメタデータファイルも記述します。 !analyze を実行すると、適切な分析拡張機能プラグインが検索、読み込み、実行されます。詳細については、「カスタム分析デバッガー拡張機能の作成」を参照してください。

DML を使用したデバッガー出力のカスタマイズ

DML を使用してデバッガーの出力をカスタマイズできます。詳細については、「DML を使用したデバッガー出力のカスタマイズ」を参照してください。

JavaScript を使用してデバッガーの機能を拡張する

JavaScript を使用して、デバッガーオブジェクトを理解し、デバッガーの機能を拡張およびカスタマイズするスクリプトを作成します。 JavaScript プロバイダーは、スクリプト言語をデバッガーの内部オブジェクトモデルに橋渡しします。 JavaScript デバッガースクリプトプロバイダーでは、デバッガーで JavaScript を使用できます。詳細については、「JavaScript デバッガースクリプト」を参照してください。

デバッガーエンジンの基本