プロファイル環境の設定

[アーティクル]
08/09/2011

メモ
.NET Framework Version 4 では、プロファイル機能が大幅に変更されています。プロファイル環境の設定に影響する変更点については、「.NET Framework 4 でのプロファイル」を参照してください。

マネージプロセス (アプリケーションまたはサービス) は、起動されると、共通言語ランタイム (CLR: Common Language Runtime) を読み込みます。 CLR は、初期化されると、プロファイラーに接続する必要があるかどうかを決定するために、次の 2 つの環境変数を評価します。

COR_ENABLE_PROFILING: この環境変数が存在し、1 に設定されている場合にのみ、CLR はプロファイラーに接続します。
COR_PROFILER: COR_ENABLE_PROFILING のチェックに合格した場合、CLR はこの CLSID または ProgID (あらかじめレジストリに格納されている) を持つプロファイラーに接続します。 COR_PROFILER 環境変数は文字列として定義されます。以下に 2 つの例を示します。
```
set COR_PROFILER={32E2F4DA-1BEA-47ea-88F9-C5DAF691C94A}
set COR_PROFILER="MyProfiler"
```

CLR アプリケーションのプロファイリングを行うには、COR_ENABLE_PROFILING 環境変数および COR_PROFILER 環境変数を設定してから、アプリケーションを実行する必要があります。また、プロファイラー DLL が登録済みであることも確認してください。

メモ
.NET Framework 4 以降では、プロファイラーを登録する必要はありません。プロファイラーを COM コンポーネントとして登録せずに起動する方法については、「登録不要のプロファイラーの起動とアタッチ」を参照してください。

メモ
.NET Framework Version 2.0、3.0、および 3.5 のプロファイラーを .NET Framework 4 以降のバージョンで使用するには、COMPLUS_ProfAPI_ProfilerCompatibilitySetting 環境変数を設定する必要があります。この変数の詳細については、「プロファイラーの互換性の設定」を参照してください。

環境変数名のスコープ

COR_ENABLE_PROFILING 環境変数と COR_PROFILER 環境変数をどのように設定するかによって、これらの変数が影響を及ぼすスコープが決定します。これらの変数は、次のいずれかの方法で設定できます。

ICorDebug::CreateProcess 呼び出し内で設定した変数は、その時点で実行しているアプリケーションにのみ適用されます (そのアプリケーションから起動されて環境を継承する他のアプリケーションにも適用されます)。
コマンドプロンプトウィンドウで設定した変数は、そのウィンドウから起動したすべてのアプリケーションに適用されます。
ユーザーレベルで設定した変数は、Windows エクスプローラーを使用して起動するすべてのアプリケーションに適用されます。変数を設定した後にコマンドプロンプトウィンドウを開くと、それらの環境設定が表示されます。そのウィンドウから起動するアプリケーションにも同じ設定が適用されます。ユーザーレベルで環境変数を設定するには、[マイコンピューター] を右クリックし、[プロパティ] をクリックします。[詳細設定] タブをクリックし、[環境変数] をクリックして、[ユーザー環境変数] の一覧に変数を追加します。
コンピューターレベルで設定した変数は、そのコンピューターで起動するすべてのアプリケーションに適用されます。そのコンピューターでコマンドプロンプトウィンドウを開くと、それらの環境設定が表示されます。そのウィンドウから起動するアプリケーションにも同じ設定が適用されます。つまり、そのコンピューター上のすべてのマネージプロセスがプロファイラーと共に起動します。コンピューターレベルで環境変数を設定するには、[マイコンピューター] を右クリックし、[プロパティ] をクリックします。[詳細設定] タブをクリックし、[環境変数] をクリックします。[システム環境変数] の一覧に変数を追加し、コンピューターを再起動します。再起動後、変数はシステム全体で試用できるようになります。

Windows サービスのプロファイリングを行う場合は、環境変数を設定した後、コンピューターを再起動してプロファイラー DLL を登録する必要があります。これらの考慮事項の詳細については、「Windows サービスのプロファイリング」を参照してください。

その他の考慮事項

プロファイラークラスは ICorProfilerCallback インターフェイスと ICorProfilerCallback2 インターフェイスを実装します。 .NET Framework Version 2.0 では、プロファイラーは ICorProfilerCallback2 を実装する必要があります。実装していない場合、ICorProfilerCallback2 は読み込まれません。
一度に 1 つのプロファイラーのみが、指定された環境でプロセスのプロファイリングを行うことができます。 2 つの異なるプロファイラーを別々の環境に登録することはできますが、各プロファイラーは別々のプロセスのプロファイリングを行う必要があります。プロファイラーは、インプロセス COM サーバー DLL として実装する必要があります。この DLL は、プロファイリング対象プロセスと同じアドレス領域にマップされます。つまり、プロファイラーはインプロセスで実行されます。 .NET Framework では、これ以外の種類の COM サーバーはサポートしていません。たとえば、プロファイラーがリモートコンピューターからアプリケーションを監視する場合は、各コンピューターにコレクターエージェントを実装する必要があります。実装したエージェントは、結果をまとめて中央のデータ収集用コンピューターに送信します。
プロファイラーはインプロセスでインスタンス化される COM オブジェクトであるため、プロファイリングされる各アプリケーションに専用のプロファイラーのコピーが存在します。したがって、単一のプロファイラーインスタンスが複数のアプリケーションからのデータを処理する必要はありません。ただし、プロファイラーのログコードに、他のプロファイリング対象アプリケーションからのログファイルの上書きを回避するロジックを追加する必要があります。

プロファイラーの初期化

両方の環境変数のチェックに合格すると、CLR は COM CoCreateInstance 関数と同様の方法でプロファイルのインスタンスを作成します。このプロファイルについては、CoCreateInstance の直接呼び出しによる読み込みは行われません。そのため、スレッド処理モデルの設定が必要な CoInitialize の呼び出しが回避されます。 CLR は、次にプロファイラー内で ICorProfilerCallback::Initialize メソッドを呼び出します。このメソッドのシグネチャは次のとおりです。

HRESULT Initialize(IUnknown *pICorProfilerInfoUnk)

プロファイラーは、pICorProfilerInfoUnk に ICorProfilerInfo インターフェイスポインターまたは ICorProfilerInfo2 インターフェイスポインターを照会して保存し、後でプロファイリングを行うときに詳細情報を要求できるようにします。

イベント通知の設定

プロファイラーは、次に ICorProfilerInfo::SetEventMask メソッドを呼び出して、確認する通知のカテゴリを指定します。たとえば、関数の Enter および Leave の通知とガベージコレクションの通知のみを確認する場合は、次のように指定します。

ICorProfilerInfo* pInfo;
pICorProfilerInfoUnk->QueryInterface(IID_ICorProfilerInfo, (void**)&pInfo);
pInfo->SetEventMask(COR_PRF_MONITOR_ENTERLEAVE | COR_PRF_MONITOR_GC)

通知マスクをこのように設定することによって、プロファイラーで受け取る通知を制限できます。この方法は、単純なプロファイラーまたは特別な目的を持つプロファイラーを作成するときに役立ちます。また、プロファイラーが無視するだけの通知を送信するのに消費される CPU 時間が削減されます。

特定のプロファイラーイベントは変更できません。つまり、これらのイベントが ICorProfilerCallback::Initialize コールバックで設定されるとすぐに、イベントはオフにできなくなり、新しいイベントをオンにすることもできません。変更できないイベントを変更しようとすると、失敗を表す HRESULT が ICorProfilerInfo::SetEventMask から返されます。

Windows サービスのプロファイリング

Windows サービスのプロファイリングは、共通言語ランタイムアプリケーションのプロファイリングと同様です。どちらのプロファイリング操作も環境変数で有効にできます。 Windows サービスはオペレーティングシステムの起動時に開始されるため、前の環境変数をあらかじめ作成し、必要な値を設定しておく必要があります。さらに、プロファイル DLL を事前にシステムに登録しておく必要もあります。

環境変数 COR_ENABLE_PROFILING と COR_PROFILER を設定し、プロファイラー DLL を登録したら、これらの変更が Windows サービスで検出されるようにするために、ターゲットコンピューターを再起動してください。

これらの変更を行うと、プロファイリングがシステム全体で有効になります。以降に実行するすべてのマネージアプリケーションがプロファイルされるのを避けるには、ターゲットコンピューターを再起動した後で、システム環境変数を削除します。

この方法では、すべての CLR プロセスもプロファイリングの対象になります。プロファイラーは、現在のプロセスがプロファイリングの対象であるかどうかを検出するロジックを ICorProfilerCallback::Initialize コールバックに追加する必要があります。プロファイリングの対象ではない場合、プロファイラーは、初期化を実行せずにコールバックからエラーを返すことができます。

参照

概念

プロファイリングの概要

次の方法で共有