次の方法で共有

プロファイリングの概要

  • [アーティクル]

プロファイラーは、別のアプリケーションの実行を監視するツールです。 共通言語ランタイム (CLR: Common Language Runtime) プロファイラーは、プロファイル API を使用して CLR とのメッセージの送受信を行う関数で構成されるダイナミック リンク ライブラリ (DLL: Dynamic Link Library) です。 プロファイラー DLL は、実行時に CLR によって読み込まれます。

従来のプロファイリング ツールは、アプリケーションの実行を測定することに重点を置いていました。 その主な役割は、各関数の実行にかかる時間やアプリケーションのメモリ使用状況を一定期間にわたって測定することでした。 プロファイル API は、コード カバレッジ ユーティリティや高度なデバッグ支援ツールなど、より幅広い診断ツールを対象にしています。 これらの用途には、いずれも診断的な性質があります。 プロファイル API は、アプリケーションの実行を測定するだけでなく、監視も行います。 そのため、プロファイル API をアプリケーション自体が使用することは避ける必要があります。また、アプリケーションの実行がプロファイラーに依存したり、プロファイラーの影響を受けたりしないようにする必要もあります。

CLR アプリケーションのプロファイリングには、通常のコンパイル済みマシン語コードのプロファイリングよりも多くのサポートが必要です。 これは、CLR には、アプリケーションの実行メイン、ガベージ コレクション、マネージド例外処理、コードの Just-In-Time (JIT) コンパイル (共通の中間言語の変換、または CIL、コードをネイティブ コンピューター コードに変換する) などの概念が導入されているためです。 通常のプロファイリング機構では、これらの機能に関する有益な情報を見つけたり、提供したりすることはできません。 プロファイル API は、CLR およびプロファイリングされたアプリケーションのパフォーマンスに大きな影響を与えることなく、この欠落した情報を効率的に提供します。

実行時に行われる JIT コンパイルは、プロファイリングを行ううえで絶好のタイミングとなります。 プロファイリング API を使用すると、プロファイラーは、JIT コンパイル前にルーチンのメモリ内 CIL コード ストリームを変更できます。 この方法により、プロファイラーは、さらに詳細な調査が必要な特定のルーチンに動的にインストルメンテーション コードを追加できます。 この方法は従来のシナリオでも可能ですが、プロファイル API を使用する CLR の方が、実装はずっと簡単です。

プロファイル API

通常、プロファイル API は、"コード プロファイラー" を作成するために使用します。コード プロファイラーとは、マネージド アプリケーションの実行を監視するプログラムです。

プロファイル API は、プロファイラー DLL によって使用されます。プロファイラー DLL は、プロファイリング対象アプリケーションと同じプロセスに読み込まれます。 プロファイラー DLL は、コールバック インターフェイス (.NET Framework Version 1.0 および 1.1 の ICorProfilerCallback、Version 2.0 以降の ICorProfilerCallback2) を実装します。 CLR は、このインターフェイス内のメソッドを呼び出して、プロファイリングされたプロセスのイベントをプロファイラーに通知します。 プロファイラーをランタイムにコールバックするには、ICorProfilerInfo インターフェイスおよび ICorProfilerInfo2 インターフェイスのメソッドを使用して、プロファイリングされたアプリケーションの状態に関する情報を取得します。

Note

プロファイリングされたアプリケーションと同じプロセスで実行するのは、プロファイラー ソリューションのデータ収集の部分だけにしてください。 ユーザー インターフェイスとデータ分析は、すべて別のプロセスで実行する必要があります。

次の図は、プロファイラー DLL がプロファイリング対象アプリケーションおよび CLR とやり取りする方法を示しています。

プロファイリング アーキテクチャを示すスクリーンショット。

通知インターフェイス

ICorProfilerCallback および ICorProfilerCallback2 は、通知インターフェイスと見なすことができます。 これらのインターフェイスは、ClassLoadStarted、ClassLoadFinished、JITCompilationStarted などのメソッドで構成されます。 クラスのロードまたはアンロード、関数のコンパイルなどを行うたびに、プロファイラーの ICorProfilerCallback インターフェイスまたは ICorProfilerCallback2 インターフェイスの対応するメソッドが呼び出されます。

たとえば、プロファイラーは、FunctionEnter2 および FunctionLeave2 という 2 つの通知関数を使用して、コードのパフォーマンスを測定することができます。 この場合は、各通知のタイムスタンプを記録し、結果を累積して、アプリケーションの実行時に CPU またはウォール クロック時間を最も多く使用した関数を示す一覧を出力します。

情報取得インターフェイス

プロファイリングにおけるその他の主要インターフェイスには、ICorProfilerInfo や ICorProfilerInfo2 があります。 プロファイラーは、分析に役立つ追加情報を取得する必要がある場合に、これらのインターフェイスを呼び出します。 たとえば、CLR から FunctionEnter2 関数が呼び出されるときは、必ず関数識別子が渡されます。 プロファイラーは、ICorProfilerInfo2::GetFunctionInfo2 メソッドを呼び出すことで、関数の親クラスや名前など、その関数についての詳細情報を取得できます。

サポートされている機能

プロファイル API は、共通言語ランタイムで発生するさまざまなイベントとアクションについての情報を提供します。 この情報を使用して、プロセスの内部動作を監視し、.NET Framework アプリケーションのパフォーマンスを分析できます。

プロファイル API は、CLR で発生する以下のアクションとイベントについての情報を取得します。

  • CLR のスタートアップ イベントとシャットダウン イベント。

  • アプリケーション ドメインの作成イベントとシャットダウン イベント。

  • アセンブリの読み込みイベントとアンロード イベント。

  • モジュールの読み込みイベントとアンロード イベント。

  • COM vtable の作成イベントと破棄イベント。

  • Just-In-Time (JIT) コンパイル イベントとコード ピッチ イベント。

  • クラスの読み込みイベントとアンロード イベント。

  • スレッドの作成イベントと破棄イベント。

  • 関数の開始イベントと終了イベント。

  • 例外。

  • マネージド コードとアンマネージド コードの実行の切り替え。

  • 異なるランタイム コンテキスト間の切り替え。

  • ランタイムの中断に関する情報。

  • ランタイムのメモリ ヒープとガベージ コレクションのアクティビティに関する情報。

プロファイル API は、任意の (非マネージ) COM 互換言語から呼び出すことができます。

API は、CPU とメモリの消費に関しては効率的です。 プロファイルを実行しても、誤った結果をもたらすほどの大きい変化がプロファイリング対象のアプリケーションで発生することはありません。

プロファイル API は、サンプリング プロファイラーと非サンプリング プロファイラーの両方に役立ちます。 "サンプリング プロファイラー" は、一定のクロック刻み (たとえば 5 ミリ秒間隔) でプロファイルを検査します。 "非サンプリング プロファイラー" は、イベントの原因になったスレッドで同期的にイベントの通知を受け取ります。

サポートされていない機能

プロファイル API は、以下の機能をサポートしていません。

  • 従来の Win32 メソッドを使用してプロファイリングする必要があるアンマネージ コード。 ただし、CLR プロファイラーには、マネージド コードとアンマネージド コードの境界を判定するための遷移イベントが含まれます。

  • アスペクト指向プログラミングなどの目的で自身のコードを変更する自動変更アプリケーション。

  • 範囲チェック (プロファイル API がこの情報を提供しないため)。 CLR には、すべてのマネージド コードの範囲チェックのための組み込みサポートが用意されています。

  • リモート プロファイル。次の理由によりサポートされません。

    • リモート プロファイルは実行時間が長くなります。 プロファイル インターフェイスを使用するときは、プロファイリングの結果が必要以上に影響を受けないように、実行時間を最小限にする必要があります。 実行パフォーマンスを監視するときには、これが特に重要です。 ただし、メモリの使用状況を監視するため、またはスタック フレームやオブジェクトなどについてのランタイム情報を取得するためにプロファイル インターフェイスを使用するときは、リモート プロファイルは制約になりません。

    • CLR コード プロファイラーは、プロファイリング対象のアプリケーションが実行しているローカル コンピューターのランタイムに、1 つ以上のコールバック インターフェイスを登録する必要があります。 これにより、リモート コード プロファイラーの作成が制限されます。

通知スレッド

通常は、イベントを生成するスレッドが通知も実行します。 このような通知 (たとえば FunctionEnter や FunctionLeave) では、ThreadID が明示的に指定されることはありません。 また、プロファイラーでは、グローバル ストレージに分析ブロックのインデックスを作成するのではなく、影響を受けるスレッドの ThreadID を基に、スレッド ローカル ストレージを使用して分析ブロックを格納および更新する方法を採用する場合があります。

これらのコールバックはシリアル化されないことに注意してください。 ユーザーは、スレッド セーフなデータ構造を作成すると共に、必要に応じてプロファイラー コードをロックして、複数のスレッドからの並行アクセスを防ぐことで、コードを保護する必要があります。 そのため、状況によっては、通常とは異なるシーケンスでコールバックを受け取る場合があります。 たとえば、マネージド アプリケーションで、まったく同じコードを実行する 2 つのスレッドを生成するとします。 この場合、何らかの関数について、一方のスレッドから ICorProfilerCallback::JITCompilationStarted イベントを受け取った後、ICorProfilerCallback::JITCompilationFinishedコールバックを受け取る前に、他のスレッドから FunctionEnter コールバックを受け取ることがあり得ます。 この場合、ユーザーは、まだ完全に Just-In-Time (JIT) コンパイルが行われていない可能性がある関数についての FunctionEnter コールバックを受け取ります。

セキュリティ

プロファイラーの DLL は、共通言語ランタイムの実行エンジンの一部として動作するアンマネージ DLL です。 そのため、プロファイラー DLL のコードは、マネージド コード アクセス セキュリティの制限を受けません。 プロファイラー DLL に対する唯一の制限は、プロファイリング対象のアプリケーションを実行しているユーザーに適用されるオペレーティング システムの制限です。

プロファイラーを作成するときは、セキュリティ関連の問題が発生しないように、適切な予防措置を講じる必要があります。 たとえば、インストール時には、プロファイラー DLL をアクセス制御リスト (ACL: Access Control List) に追加して、悪意のあるユーザーが DLL を変更できないようにします。

コード プロファイラーでのマネージド コードとアンマネージド コードの結合

プロファイラーが正しく記述されていないと、循環参照が発生し、予期しない動作が引き起こされることがあります。

CLR プロファイル API をレビューすると、マネージド コンポーネントとアンマネージド コンポーネントの両方を使用してプロファイラーを作成し、COM 相互運用機能や間接呼び出しを通して互いを呼び出すことができるような印象を受けるかもしれません。

これは設計上は可能ですが、プロファイル API はマネージド コンポーネントをサポートしていません。 CLR プロファイラーは完全にアンマネージにする必要があります。 CLR プロファイラーでマネージド コードとアンマネージド コードを組み合わせようとすると、アクセス違反、プログラム エラー、またはデッドロックが発生する可能性があります。 プロファイラーのマネージド コンポーネントからアンマネージド コンポーネントに対してイベントが生成され、そのイベントでマネージド コンポーネントが再度呼び出されて、循環参照が発生することになります。

CLR プロファイラーがマネージド コードを安全に呼び出すことができる唯一の場所は、メソッドの共通中間言語 (CIL) 本文にあります。 CIL 本文を変更する場合は、ICorProfilerCallback4 インターフェイスで JIT 再コンパイル メソッドを使用することをお勧めします。

以前のインストルメンテーション メソッドを使用して CIL を変更することもできます。 関数の Just-In-Time (JIT) コンパイルが完了する前に、プロファイラーはメソッドの CIL 本文にマネージド呼び出しを挿入し、JIT コンパイルできます (ICorProfilerInfo::GetILFunctionBody メソッドを参照)。 この方法で、マネージド コードの選択的インストルメンテーションや、JIT に関する統計およびパフォーマンス データの収集を行うことができます。

または、コード プロファイラーは、アンマネージ コードを呼び出すすべてのマネージド関数の CIL 本文にネイティブ フックを挿入できます。 この方法は、インストルメンテーションやカバレッジに使用できます。 たとえば、コード プロファイラーでは、各 CIL ブロックの後にインストルメンテーション フックを挿入して、ブロックが確実に実行されるようにすることができます。 メソッドの CIL 本体の変更は非常に繊細な操作であり、考慮すべき多くの要因があります。

アンマネージ コードのプロファイリング

共通言語ランタイム (CLR: Common Language Runtime) には、アンマネージ コードのプロファイリングについて最小限のサポートが用意されています。 次の機能があります。

  • スタック チェーンの列挙。 この機能を使用すると、コード プロファイラーはマネージド コードとアンマネージド コードの境界を特定できます。

  • スタック チェーンがマネージド コードまたはネイティブ コードに対応するかどうかの判定。

.NET Framework Versions 1.0 および 1.1 では、これらのメソッドは CLR デバッグ API のインプロセス サブセットを通して使用することができます。 これらは CorDebug.idl ファイルに定義されています。

.NET Framework 2.0 以降では、この機能に ICorProfilerInfo2::DoStackSnapshot メソッドを使用できます。

COM の使用

プロファイリングのインターフェイスは COM インターフェイスとして定義されますが、共通言語ランタイム (CLR: Common Language Runtime) は、これらのインターフェイスを使用するための COM の初期化を行いません。 その理由は、マネージド アプリケーションが目的のスレッド処理モデルを指定できるようになる前に、CoInitialize 関数によってスレッド処理モデルが設定されることを避けるためです。 同様に、プロファイラーでも、プロファイリング対象アプリケーションと互換性のないスレッド処理モデルが選択されてアプリケーション エラーが発生する可能性を避けるために、CoInitialize を呼び出さないようにする必要があります。

呼び出し履歴

プロファイル API には、呼び出し履歴を呼び出す 2 とおりの方法が用意されています。スタック スナップショットによる方法では呼び出し履歴を少ない頻度で収集でき、シャドウ スタックによる方法では呼び出し履歴を常時追跡します。

スタック スナップショット

スタック スナップショットは、ある特定の時点でのスレッドのスタックのトレースです。 プロファイル API はスタックでのマネージド関数のトレースをサポートしますが、アンマネージド 関数のトレースはプロファイラー独自のスタック ウォーカーで処理する必要があります。

プロファイラーでマネージド スタックを走査するようにプログラミングする方法の詳細については、このドキュメント セットの ICorProfilerInfo2::DoStackSnapshot メソッド、および「.NET Framework 2.0 におけるプロファイラー スタック ウォーク: その基本と発展」を参照してください。

シャドウ スタック

スナップショット方式を頻繁に使用すると、すぐにパフォーマンスの問題につながる可能性があります。 スタック トレースを頻繁に実行する必要がある場合は、代わりにプロファイラーで FunctionEnter2、FunctionLeave2、FunctionTailcall2、および ICorProfilerCallback2 の各例外コールバックを使用して、シャドウ スタックを作成する必要があります。 シャドウ スタックは常に最新であり、スタック スナップショットが必要なときいつでも簡単にストレージにコピーできます。

シャドウ スタックでは、関数の引数、戻り値、およびジェネリックなインスタンス化に関する情報を取得できます。 この情報は、シャドウ スタックを通してのみ使用でき、制御が関数に渡されたときに取得できます。 ただし、後から関数の実行中にこの情報を使用することはできません。

コールバックとスタックの深さ

プロファイラー コールバックはスタックが非常に制約された環境で発行される場合があり、プロファイラー コールバックでスタック オーバーフローが発生すると、プロセスが直ちに終了することになります。 プロファイラーは、コールバックへの応答で使用するスタックを可能な限り少なくする必要があります。 スタック オーバーフローに対して耐性のあるプロセスでプロファイラーを使用する場合は、プロファイラー自体もスタック オーバーフローを発生させないようにする必要があります。

Title 説明
プロファイル環境の設定 プロファイラーを初期化し、イベント通知を設定して、Windows サービスをプロファイリングする方法について説明します。
プロファイリングのインターフェイス プロファイル API で使用されるアンマネージ インターフェイスについて説明します。
グローバル静的関数のプロファイル プロファイル API で使用されるアンマネージ グローバル静的関数について説明します。
列挙体のプロファイリング プロファイル API で使用されるアンマネージ列挙体について説明します。
構造体のプロファイリング プロファイル API で使用されるアンマネージ構造体について説明します。