JVM^TM Tool Interface

JVM Tool Interfaceとは

アーキテクチャ

エージェントの作成

#include <jvmti.h>
    

エージェントの配備

静的リンク・エージェント(導入されたバージョン: 1.2.3)

エージェントのコマンド行オプション

-agentlib:<agent-lib-name>=<options>

-agentlib:の後の名前は、ロードするライブラリの名前です。 ライブラリの検索(その完全名と場所の両方)は、プラットフォーム固有の方法で進行します。 通常、<agent-lib-name>はオペレーティング・システム固有のファイル名に展開されます。 <options>は、起動時にエージェントに渡されます。 たとえば、オプション-agentlib:foo=opt1,opt2が指定されている場合、VMは、Windows^TMの下のシステムPATHから共有ライブラリfoo.dll、またはLinux^TMの下のLD_LIBRARY_PATHからlibfoo.soをロードしようとします。 エージェントのライブラリが実行可能ファイルに静的にリンクされている場合、実際のロード・タスクは発生しません。

-agentpath:<path-to-agent>=<options>

-agentpath: の後ろには、ライブラリをロードする絶対パスを指定します。 ライブラリ名の展開は行われません。 <options>は、起動時にエージェントに渡されます。 たとえば、オプション-agentpath:c:\myLibs\foo.dll=opt1,opt2が指定された場合、VMは、共有ライブラリc:\myLibs\foo.dllをロードしようとします。 エージェントのライブラリが実行可能ファイルに静的にリンクされている場合、実際のロード・タスクは発生しません。

エージェントの起動

エージェントの起動(OnLoad段階)

JNIEXPORT jint JNICALL
Agent_OnLoad(JavaVM *vm, char *options, void *reserved)

JNIEXPORT jint JNICALL
Agent_OnLoad_L(JavaVM *vm, char *options, void *reserved)

• システム・プロパティは、VMの起動で使用される前に設定できる
• すべての権限を使用できる(ただし、VMを構成する権限はこのときしか使用できない。詳細は「権限関数」セクションを参照)
• バイト・コードが実行されていない
• クラスがロードされていない
• オブジェクトが作成されていない

原理の説明: 早い段階での起動が必要なのは、エージェントが目的の権限(その多くはVMの初期化前に設定する必要がある)を設定できるようにするためです。 JVMDIでは-Xdebugコマンド行オプションによって、非常に粗粒度の権限制御機能が提供されていました。 JVMPI実装では、様々なテクニックを使用して単一の「JVMPIオン」スイッチが提供されます。 必要な権限とパフォーマンスへの影響のバランスを取るために必要な、細粒度の制御機能を提供できる適度なコマンド行オプションはありません。 また、早い段階での起動は、エージェントが実行環境を制御できるようにする(ファイル・システムやシステム・プロパティを変更して機能をインストールできるようにする)ためにも必要です。

エージェントの起動(ライブ段階)

JNIEXPORT jint JNICALL
Agent_OnAttach(JavaVM* vm, char *options, void *reserved)

JNIEXPORT jint JNICALL
Agent_OnAttach_L(JavaVM* vm, char *options, void *reserved)

エージェントの停止

JNIEXPORT void JNICALL
Agent_OnUnload(JavaVM *vm)

JNIEXPORT void JNICALL
Agent_OnUnload_L(JavaVM *vm)

JAVA_TOOL_OPTIONS

• 一重引用符の組('')に囲まれた、一重引用符を除くすべての文字は引用として囲まれる。
• 一重引用符の組の内部にある二重引用符には、特殊な意味はない。
• 二重引用符の組("")に囲まれた、二重引用符を除くすべての文字は引用として囲まれる。
• 二重引用符の組の内部にある一重引用符には、特殊な意味はない。
• 変数内の任意の場所を引用符で囲むことができる。
• 引用符で囲まれた空白文字には、特殊な意味はない。その他の文字と同様にオプションに含めることができ、区切り文字として機能しない。
• 引用符の組自体はオプションに含まれない。

環境

• イベント・コールバック
• 有効なイベントのセット
• 権限
• メモリーの割り当て/割当て解除フック

バイト・コード・インストゥルメンテーション

• 静的インストゥルメンテーション: クラス・ファイルは、たとえばインストゥルメンテーションを追加する目的で変更された*.classファイルを含む複製ディレクトリを作成するなどの方法で、VMにロードされる前に計測されます。 この方法はきわめて不自然であり、一般に、ロードされるクラス・ファイルの出所をエージェント側で知ることはできません。
• ロード時のインストゥルメンテーション: クラス・ファイルがVMにロードされるとき、クラス・ファイルのrawバイトは、インストゥルメンテーション用としてエージェントに送信されます。 クラスのロードによって発生したClassFileLoadHookイベントが、この機能を提供します。 このメカニズムは効率がよく、1回かぎりのインストゥルメンテーションに完全にアクセスできます。
• 動的インストゥルメンテーション: すでにロード済であり、場合によっては実行されている可能性もあるクラスが、変更されます。 このオプション機能は、RetransformClasses関数を呼び出すことでトリガーされるClassFileLoadHookイベントによって提供されます。 クラスは複数回変更できるほか、元の状態に戻すこともできます。 このメカニズムを使えば、実行中に変化するインストゥルメンテーションを実現できます。

      public Object() {
        MyProfiler.allocationTracker(this);
      }
    

      static boolean trackAllocations = false;

      public Object() {
        if (trackAllocations) {
          MyProfiler.allocationTracker(this);
        }
      }
    

バイトコード・モジュール内のコードのインスツルメンテーション

修正UTF-8の文字列エンコーディング

仕様のコンテキスト

• 「スレッド」はJavaプログラミング言語のスレッドを意味する。
• 「スタック・フレーム」はJava仮想マシンのスタック・フレームを意味する。
• 「クラス」はJavaプログラミング言語のクラスを意味する。
• 「ヒープ」はJava仮想マシンのヒープを意味する。
• 「モニター」はJavaプログラミング言語のオブジェクト・モニターを意味する。

関数

関数のアクセス

jvmtiEnv *jvmti;
...
jvmtiError err = (*jvmti)->GetLoadedClasses(jvmti, &class_count, &classes);
    

jvmtiEnv *jvmti;
...
jvmtiError err = jvmti->GetLoadedClasses(&class_count, &classes);
    

jvmtiEnv *jvmti;
...
(*jvm)->GetEnv(jvm, &jvmti, JVMTI_VERSION_1_0);
    

関数の戻り値

JNIオブジェクト参照の管理

関数呼出しの必要条件

例外と関数

関数の索引

• メモリー管理
  • Allocate
  • Deallocate
• スレッド
  • スレッド状態の取得
  • 現在のスレッドの取得
  • すべてのスレッドの取得
  • スレッドの中断
  • スレッド・リストの中断
  • すべての仮想スレッドの一時停止
  • スレッドの再開
  • スレッド・リストの再開
  • すべての仮想スレッドを再開
  • スレッドの停止
  • スレッドの割り込み
  • スレッド情報の取得
  • 所有モニター情報の取得
  • 所有モニターのスタックの深さ情報の取得
  • 現在競合しているモニターの取得
  • エージェント・スレッドの実行
  • スレッド・ローカルな記憶領域の設定
  • スレッド・ローカルな記憶領域の取得
• スレッド・グループ
  • トップ・レベルのスレッド・グループの取得
  • スレッド・グループ情報の取得
  • 子スレッド・グループの取得
• スタック・フレーム
  • スタック・トレースの取得
  • すべてのスタック・トレースの取得
  • スレッド・リストのスタック・トレースの取得
  • フレーム・カウントの取得
  • フレームのポップ
  • フレームの位置の取得
  • フレームのポップの通知
• 早期復帰の強制
  • 早期復帰の強制 - オブジェクト型
  • 早期復帰の強制 - 整数型
  • 早期復帰の強制 - 長整数型
  • 早期復帰の強制 - 浮動小数点数型
  • 早期復帰の強制 - 倍精度浮動小数点数型
  • 早期復帰の強制 - void型
• ヒープ
  • 参照の追跡
  • ヒープ内での反復
  • タグの取得
  • タグの設定
  • タグを使ったオブジェクトの取得
  • ガベージ・コレクションの強制
• ヒープ (1.0)
  • オブジェクトから到達可能なオブジェクトの反復
  • 到達可能なオブジェクトの反復
  • ヒープの反復
  • クラスのインスタンスの反復
• 局所変数
  • 局所変数の取得 - オブジェクト型
  • 局所インスタンスの取得
  • 局所変数の取得 - 整数型
  • 局所変数の取得 - 長整数型
  • 局所変数の取得 - 浮動小数点数型
  • 局所変数の取得 - 倍精度浮動小数点数型
  • 局所変数の設定 - オブジェクト型
  • 局所変数の設定 - 整数型
  • 局所変数の設定 - 長整数型
  • 局所変数の設定 - 浮動小数点数型
  • 局所変数の設定 - 倍精度浮動小数点数型
• ブレークポイント
  • ブレークポイントの設定
  • ブレークポイントのクリア
• 監視されるフィールド
  • フィールド・アクセスの監視の設定
  • フィールド・アクセスの監視のクリア
  • フィールド変更の監視の設定
  • フィールド変更の監視のクリア
• Module
  • すべてのモジュールを取得
  • 名前付きモジュールを取得
  • モジュールの読み込みを追加
  • モジュールのエクスポートを追加
  • モジュールのオープンの追加
  • モジュール使用を追加
  • モジュール提供を追加
  • 変更可能モジュールか
• クラス
  • ロード済みクラスの取得
  • クラス・ローダー・クラスの取得
  • クラスのシグニチャの取得
  • クラスのステータスの取得
  • ソース・ファイル名の取得
  • クラスの修飾子の取得
  • クラスのメソッドの取得
  • クラスのフィールドの取得
  • 実装されたインタフェースの取得
  • クラス・バージョン番号の取得
  • 定数プールの取得
  • インタフェースかどうかの検査
  • 配列クラスかどうかの検査
  • 変更可能クラスかどうかの検査
  • クラス・ローダーの取得
  • ソース・デバッグ拡張機能の取得
  • クラスの再変換
  • クラスの再定義
• オブジェクト
  • オブジェクト・サイズの取得
  • オブジェクトのハッシュ・コードの取得
  • オブジェクトのモニターの利用情報を取得
• フィールド
  • フィールドの名前とシグニチャの取得
  • フィールドの宣言クラスの取得
  • フィールドの修飾子の取得
  • 合成フィールドかどうかの検査
• メソッド
  • メソッドの名前とシグニチャの取得
  • メソッドの宣言クラスの取得
  • メソッドの修飾子の取得
  • 局所変数の取得
  • 引数のサイズの取得
  • 行番号テーブルの取得
  • メソッドの配置位置の取得
  • 局所変数テーブルの取得
  • バイト・コードの取得
  • ネイティブ・メソッドかどうかの検査
  • 合成メソッドかどうかの検査
  • 廃棄されたメソッドかどうかの検査
  • ネイティブ・メソッド接頭辞の設定
  • 複数のネイティブ・メソッド接頭辞の設定
• rawモニター
  • rawモニターの作成
  • rawモニターの破棄
  • rawモニターの開始
  • rawモニターの終了
  • rawモニターの待機
  • rawモニターの通知
  • rawモニターの通知(すべて)
• JNI関数の遮断
  • JNI関数テーブルの設定
  • JNI関数テーブルの取得
• イベント管理
  • イベント・コールバックの設定
  • イベント通知モードの設定
  • イベントの生成
• 拡張機能メカニズム
  • 拡張関数の取得
  • 拡張イベントの取得
  • 拡張イベント・コールバックの設定
• 権限
  • 潜在的な権限の取得
  • 権限の追加
  • 権限の放棄
  • 権限の取得
• タイマー
  • 現在のスレッドのCPUタイマー情報を取得
  • 現在のスレッドのCPU時間を取得
  • スレッドのCPUタイマー情報を取得
  • スレッドのCPU時間を取得
  • タイマー情報の取得
  • 時間の取得
  • 使用可能なプロセッサの取得
• クラス・ローダー検索
  • ブートストラップ・クラス・ローダー検索の追加
  • システム・クラス・ローダー検索の追加
• システム・プロパティ
  • システム・プロパティの取得
  • システム・プロパティの取得
  • システム・プロパティの設定
• 全般
  • 段階の取得
  • 環境の破棄
  • 環境ローカル記憶領域の設定
  • 環境ローカル記憶領域の取得
  • バージョン番号の取得
  • エラー名の取得
  • 冗長フラグの設定
  • JLocation形式の取得
• ヒープ・モニタリング
  • ヒープ・サンプリング間隔の設定

メモリー管理

• Allocate
• Deallocate

Allocate

jvmtiError
Allocate(jvmtiEnv* env,
            jlong size,
            unsigned char** mem_ptr)

Deallocate

jvmtiError
Deallocate(jvmtiEnv* env,
            unsigned char* mem)

スレッド

• スレッド状態の取得
• 現在のスレッドの取得
• すべてのスレッドの取得
• スレッドの中断
• スレッド・リストの中断
• すべての仮想スレッドの一時停止
• スレッドの再開
• スレッド・リストの再開
• すべての仮想スレッドを再開
• スレッドの停止
• スレッドの割り込み
• スレッド情報の取得
• 所有モニター情報の取得
• 所有モニターのスタックの深さ情報の取得
• 現在競合しているモニターの取得
• エージェント・スレッドの実行
• スレッド・ローカルな記憶領域の設定
• スレッド・ローカルな記憶領域の取得

• エージェント起動関数

• jvmtiThreadInfo - スレッド情報構造体
• jvmtiMonitorStackDepthInfo - モニター・スタック深さ情報構造体

• スレッド状態のフラグ
• java.lang.Thread.State変換マスク
• スレッド優先順位定数

スレッド状態の取得

jvmtiError
GetThreadState(jvmtiEnv* env,
            jthread thread,
            jint* thread_state_ptr)

• 活動状態か
  • 活動状態ではない。
    • なぜ活動状態ではないか
      • 新規であるため。
      • 終了したため(JVMTI_THREAD_STATE_TERMINATED)
  • 活動状態(JVMTI_THREAD_STATE_ALIVE)
    • 中断したか
      • 中断した(JVMTI_THREAD_STATE_SUSPENDED)
      • 中断していない
    • 割り込みか
      • 割り込み(JVMTI_THREAD_STATE_INTERRUPTED)
      • 割込みでない。
    • ネイティブ・コード内か
      • ネイティブ・コード内(JVMTI_THREAD_STATE_IN_NATIVE)
      • Javaプログラミング言語コード内
    • どの活動状態か
      • 実行可能状態(JVMTI_THREAD_STATE_RUNNABLE)
      • ロックされている(JVMTI_THREAD_STATE_BLOCKED_ON_MONITOR_ENTER)
      • 待機中(JVMTI_THREAD_STATE_WAITING)
        • 待機時間は
          • 未定義(JVMTI_THREAD_STATE_WAITING_INDEFINITELY)
          • 定義されている(JVMTI_THREAD_STATE_WAITING_WITH_TIMEOUT)
        • 待機理由は
          • Object.wait (JVMTI_THREAD_STATE_IN_OBJECT_WAIT)
          • LockSupport.park (JVMTI_THREAD_STATE_PARKED)
          • スリープ中(JVMTI_THREAD_STATE_SLEEPING)

スレッド状態のフラグ

定数	値	説明
JVMTI_THREAD_STATE_ALIVE	0x0001	スレッドは活動状態。 スレッドが新規(起動していない)または終了した場合は、0。
JVMTI_THREAD_STATE_TERMINATED	0x0002	スレッドは実行を完了した。
JVMTI_THREAD_STATE_RUNNABLE	0x0004	スレッドは実行可能。
JVMTI_THREAD_STATE_BLOCKED_ON_MONITOR_ENTER	0x0400	スレッドは同期ブロック/メソッドの入力を待機しています。または、Object.wait()の後は、同期ブロック/メソッドの再入力を待機しています。
JVMTI_THREAD_STATE_WAITING	0x0080	スレッドは待機中。
JVMTI_THREAD_STATE_WAITING_INDEFINITELY	0x0010	スレッドはタイム・アウトなしで待機中。 たとえば、Object.wait()。
JVMTI_THREAD_STATE_WAITING_WITH_TIMEOUT	0x0020	スレッドは、指定された最大待機時間で待機中。 たとえば、Object.wait(long)。
JVMTI_THREAD_STATE_SLEEPING	0x0040	スレッドがスリープしています -- Thread.sleep。
JVMTI_THREAD_STATE_IN_OBJECT_WAIT	0x0100	スレッドはオブジェクト・モニターを待機中 - Object.wait。
JVMTI_THREAD_STATE_PARKED	0x0200	スレッドは一時停止中。LockSupport.park、LockSupport.parkUtil、およびLockSupport.parkNanos。 Thread.sleepでスリープ中の仮想スレッドは、JVMTI_THREAD_STATE_SLEEPINGの代わりにこの状態フラグを設定できます。
JVMTI_THREAD_STATE_SUSPENDED	0x100000	スレッドは中断関数 (SuspendThreadなど)によって中断されます。 このビットが設定されている場合、他のビットはスレッドの中断前の状態を表します。
JVMTI_THREAD_STATE_INTERRUPTED	0x200000	スレッド割込みが発生した。
JVMTI_THREAD_STATE_IN_NATIVE	0x400000	スレッドはネイティブ・コード内にある。つまり、VMまたはJavaプログラミング言語コードに呼び戻されなかったネイティブ・メソッドが実行中。 このフラグは、VMでコンパイルされたJavaプログラミング言語コードの実行中、VMコードの実行中、VMサポート・コードの実行中は設定されない。 JNIおよびJVM TI関数などのネイティブVMインタフェース関数は、VMコードとして実装することも可能。
JVMTI_THREAD_STATE_VENDOR_1	0x10000000	VMベンダーが定義する。
JVMTI_THREAD_STATE_VENDOR_2	0x20000000	VMベンダーが定義する。
JVMTI_THREAD_STATE_VENDOR_3	0x40000000	VMベンダーが定義する。

java.lang.Thread.State変換マスク

定数	値	説明
JVMTI_JAVA_LANG_THREAD_STATE_MASK	JVMTI_THREAD_STATE_TERMINATED | JVMTI_THREAD_STATE_ALIVE | JVMTI_THREAD_STATE_RUNNABLE | JVMTI_THREAD_STATE_BLOCKED_ON_MONITOR_ENTER | JVMTI_THREAD_STATE_WAITING | JVMTI_THREAD_STATE_WAITING_INDEFINITELY | JVMTI_THREAD_STATE_WAITING_WITH_TIMEOUT	比較前に、この値で状態をマスクする
JVMTI_JAVA_LANG_THREAD_STATE_NEW	0	java.lang.Thread.State.NEW
JVMTI_JAVA_LANG_THREAD_STATE_TERMINATED	JVMTI_THREAD_STATE_TERMINATED	java.lang.Thread.State.TERMINATED
JVMTI_JAVA_LANG_THREAD_STATE_RUNNABLE	JVMTI_THREAD_STATE_ALIVE | JVMTI_THREAD_STATE_RUNNABLE	java.lang.Thread.State.RUNNABLE
JVMTI_JAVA_LANG_THREAD_STATE_BLOCKED	JVMTI_THREAD_STATE_ALIVE | JVMTI_THREAD_STATE_BLOCKED_ON_MONITOR_ENTER	java.lang.Thread.State.BLOCKED
JVMTI_JAVA_LANG_THREAD_STATE_WAITING	JVMTI_THREAD_STATE_ALIVE | JVMTI_THREAD_STATE_WAITING | JVMTI_THREAD_STATE_WAITING_INDEFINITELY	java.lang.Thread.State.WAITING
JVMTI_JAVA_LANG_THREAD_STATE_TIMED_WAITING	JVMTI_THREAD_STATE_ALIVE | JVMTI_THREAD_STATE_WAITING | JVMTI_THREAD_STATE_WAITING_WITH_TIMEOUT	java.lang.Thread.State.TIMED_WAITING

• JVMTI_THREAD_STATE_RUNNABLE
• JVMTI_THREAD_STATE_BLOCKED_ON_MONITOR_ENTER
• JVMTI_THREAD_STATE_WAITING

• JVMTI_THREAD_STATE_WAITING_INDEFINITELY
• JVMTI_THREAD_STATE_WAITING_WITH_TIMEOUT

• JVMTI_THREAD_STATE_IN_OBJECT_WAIT
• JVMTI_THREAD_STATE_PARKED
• JVMTI_THREAD_STATE_SLEEPING

• JVMTI_THREAD_STATE_SUSPENDED
• JVMTI_THREAD_STATE_INTERRUPTED
• JVMTI_THREAD_STATE_IN_NATIVE

            JVMTI_THREAD_STATE_ALIVE + JVMTI_THREAD_STATE_BLOCKED_ON_MONITOR_ENTER
        

            0
        

            JVMTI_THREAD_STATE_ALIVE + JVMTI_THREAD_STATE_WAITING +
                JVMTI_THREAD_STATE_WAITING_WITH_TIMEOUT +
                JVMTI_THREAD_STATE_MONITOR_WAITING
        

            JVMTI_THREAD_STATE_ALIVE + JVMTI_THREAD_STATE_RUNNABLE + JVMTI_THREAD_STATE_SUSPENDED
        

        jint state;
        jvmtiError err;

        err = (*jvmti)->GetThreadState(jvmti, thread, &state);
        if (err == JVMTI_ERROR_NONE) {
           if (state & JVMTI_THREAD_STATE_SLEEPING) {  ...
        

           if (state & JVMTI_THREAD_STATE_WAITING) {  ...
        

           if ((state & (JVMTI_THREAD_STATE_ALIVE | JVMTI_THREAD_STATE_TERMINATED)) == 0)  {  ...
        

           if (state & JVMTI_THREAD_STATE_IN_OBJECT_WAIT)  {
             if (state & JVMTI_THREAD_STATE_WAITING_WITH_TIMEOUT)  {
               printf("in Object.wait(long timeout)\n");
             } else {
               printf("in Object.wait()\n");
             }
           }
        

            err = (*jvmti)->GetThreadState(jvmti, thread, &state);
            abortOnError(err);
            switch (state & JVMTI_JAVA_LANG_THREAD_STATE_MASK) {
            case JVMTI_JAVA_LANG_THREAD_STATE_NEW:
              return "NEW";
            case JVMTI_JAVA_LANG_THREAD_STATE_TERMINATED:
              return "TERMINATED";
            case JVMTI_JAVA_LANG_THREAD_STATE_RUNNABLE:
              return "RUNNABLE";
            case JVMTI_JAVA_LANG_THREAD_STATE_BLOCKED:
              return "BLOCKED";
            case JVMTI_JAVA_LANG_THREAD_STATE_WAITING:
              return "WAITING";
            case JVMTI_JAVA_LANG_THREAD_STATE_TIMED_WAITING:
              return "TIMED_WAITING";
            }
        

現在のスレッドの取得

jvmtiError
GetCurrentThread(jvmtiEnv* env,
            jthread* thread_ptr)

すべてのスレッドの取得

jvmtiError
GetAllThreads(jvmtiEnv* env,
            jint* threads_count_ptr,
            jthread** threads_ptr)

スレッドの中断

jvmtiError
SuspendThread(jvmtiEnv* env,
            jthread thread)

スレッド・リストの中断

jvmtiError
SuspendThreadList(jvmtiEnv* env,
            jint request_count,
            const jthread* request_list,
            jvmtiError* results)

すべての仮想スレッドの一時停止

jvmtiError
SuspendAllVirtualThreads(jvmtiEnv* env,
            jint except_count,
            const jthread* except_list)

スレッドの再開

jvmtiError
ResumeThread(jvmtiEnv* env,
            jthread thread)

スレッド・リストの再開

jvmtiError
ResumeThreadList(jvmtiEnv* env,
            jint request_count,
            const jthread* request_list,
            jvmtiError* results)

すべての仮想スレッドを再開

jvmtiError
ResumeAllVirtualThreads(jvmtiEnv* env,
            jint except_count,
            const jthread* except_list)

スレッドの停止

jvmtiError
StopThread(jvmtiEnv* env,
            jthread thread,
            jobject exception)

スレッドの割込み

jvmtiError
InterruptThread(jvmtiEnv* env,
            jthread thread)

スレッド情報の取得

typedef struct {
    char* name;
    jint priority;
    jboolean is_daemon;
    jthreadGroup thread_group;
    jobject context_class_loader;
} jvmtiThreadInfo;

jvmtiError
GetThreadInfo(jvmtiEnv* env,
            jthread thread,
            jvmtiThreadInfo* info_ptr)

所有モニター情報の取得

jvmtiError
GetOwnedMonitorInfo(jvmtiEnv* env,
            jthread thread,
            jint* owned_monitor_count_ptr,
            jobject** owned_monitors_ptr)

所有モニターのスタックの深さ情報の取得

typedef struct {
    jobject monitor;
    jint stack_depth;
} jvmtiMonitorStackDepthInfo;

jvmtiError
GetOwnedMonitorStackDepthInfo(jvmtiEnv* env,
            jthread thread,
            jint* monitor_info_count_ptr,
            jvmtiMonitorStackDepthInfo** monitor_info_ptr)

現在競合しているモニターの取得

jvmtiError
GetCurrentContendedMonitor(jvmtiEnv* env,
            jthread thread,
            jobject* monitor_ptr)

エージェント起動関数

エージェント・スレッドの実行

jvmtiError
RunAgentThread(jvmtiEnv* env,
            jthread thread,
            jvmtiStartFunction proc,
            const void* arg,
            jint priority)

スレッド優先順位定数

定数	値	説明
JVMTI_THREAD_MIN_PRIORITY	1	いちばん低い優先順位
JVMTI_THREAD_NORM_PRIORITY	5	中間の優先順位
JVMTI_THREAD_MAX_PRIORITY	10	いちばん高い優先順位

スレッド・ローカルな記憶領域の設定

jvmtiError
SetThreadLocalStorage(jvmtiEnv* env,
            jthread thread,
            const void* data)

スレッド・ローカルな記憶領域の取得

jvmtiError
GetThreadLocalStorage(jvmtiEnv* env,
            jthread thread,
            void** data_ptr)

スレッド・グループ

• トップ・レベルのスレッド・グループの取得
• スレッド・グループ情報の取得
• 子スレッド・グループの取得

• jvmtiThreadGroupInfo - スレッド・グループ情報構造体

トップ・レベルのスレッド・グループの取得

jvmtiError
GetTopThreadGroups(jvmtiEnv* env,
            jint* group_count_ptr,
            jthreadGroup** groups_ptr)

スレッド・グループ情報の取得

typedef struct {
    jthreadGroup parent;
    char* name;
    jint max_priority;
    jboolean is_daemon;
} jvmtiThreadGroupInfo;

jvmtiError
GetThreadGroupInfo(jvmtiEnv* env,
            jthreadGroup group,
            jvmtiThreadGroupInfo* info_ptr)

子スレッド・グループの取得

jvmtiError
GetThreadGroupChildren(jvmtiEnv* env,
            jthreadGroup group,
            jint* thread_count_ptr,
            jthread** threads_ptr,
            jint* group_count_ptr,
            jthreadGroup** groups_ptr)

スタック・フレーム

• スタック・トレースの取得
• すべてのスタック・トレースの取得
• スレッド・リストのスタック・トレースの取得
• フレーム・カウントの取得
• フレームのポップ
• フレームの位置の取得
• フレームのポップの通知

• jvmtiFrameInfo - スタック・フレーム情報構造体
• jvmtiStackInfo - スタック情報構造体

スタック・フレーム情報構造体

typedef struct {
    jmethodID method;
    jlocation location;
} jvmtiFrameInfo;

jvmtiFrameInfo - スタック・フレーム情報構造体

フィールド	型	説明
method	jmethodID	このフレーム内で実行されているメソッド。
location	jlocation	このフレーム内で実行されている命令のインデックス。フレームがネイティブ・メソッドを実行している場合は-1。

スタック情報構造体

typedef struct {
    jthread thread;
    jint state;
    jvmtiFrameInfo* frame_buffer;
    jint frame_count;
} jvmtiStackInfo;

jvmtiStackInfo - スタック情報構造体

フィールド	型	説明
thread	jthread	戻ったとき、トレースされたスレッド。
state	jint	戻ったとき、スレッドの状態。 GetThreadStateを参照。
frame_buffer	jvmtiFrameInfo *	戻ったとき、このエージェントによって割り当てられたバッファに、スタック・フレーム情報が入っている。
frame_count	jint	戻ったとき、レコード数がframe_bufferに入っている。 これはmin(max_frame_count, stackDepth)になる。

スタック・トレースの取得

jvmtiError
GetStackTrace(jvmtiEnv* env,
            jthread thread,
            jint start_depth,
            jint max_frame_count,
            jvmtiFrameInfo* frame_buffer,
            jint* count_ptr)

jvmtiFrameInfo frames[5];
jint count;
jvmtiError err;

err = (*jvmti)->GetStackTrace(jvmti, aThread, 0, 5,
                               frames, &count);
if (err == JVMTI_ERROR_NONE && count >= 1) {
   char *methodName;
   err = (*jvmti)->GetMethodName(jvmti, frames[0].method,
                       &methodName, NULL, NULL);
   if (err == JVMTI_ERROR_NONE) {
      printf("Executing method: %s", methodName);
   }
}
        

すべてのスタック・トレースの取得

jvmtiError
GetAllStackTraces(jvmtiEnv* env,
            jint max_frame_count,
            jvmtiStackInfo** stack_info_ptr,
            jint* thread_count_ptr)

jvmtiStackInfo *stack_info;
jint thread_count;
int ti;
jvmtiError err;

err = (*jvmti)->GetAllStackTraces(jvmti, MAX_FRAMES, &stack_info, &thread_count);
if (err != JVMTI_ERROR_NONE) {
   ...
}
for (ti = 0; ti < thread_count; ++ti) {
   jvmtiStackInfo *infop = &stack_info[ti];
   jthread thread = infop->thread;
   jint state = infop->state;
   jvmtiFrameInfo *frames = infop->frame_buffer;
   int fi;

   myThreadAndStatePrinter(thread, state);
   for (fi = 0; fi < infop->frame_count; fi++) {
      myFramePrinter(frames[fi].method, frames[fi].location);
   }
}
/* this one Deallocate call frees all data allocated by GetAllStackTraces */
err = (*jvmti)->Deallocate(jvmti, stack_info);
        

スレッド・リストのスタック・トレースの取得

jvmtiError
GetThreadListStackTraces(jvmtiEnv* env,
            jint thread_count,
            const jthread* thread_list,
            jint max_frame_count,
            jvmtiStackInfo** stack_info_ptr)

フレーム・カウントの取得

jvmtiError
GetFrameCount(jvmtiEnv* env,
            jthread thread,
            jint* count_ptr)

フレームのポップ

jvmtiError
PopFrame(jvmtiEnv* env,
            jthread thread)

• 現在のフレームが破棄され、以前のフレームが現在のフレームになる
• オペランド・スタックは回復します。引数が再度追加され、呼出しがinvokestaticではなかった場合、objectrefも再度追加されます。
• Java仮想マシンのPCが呼出し命令の操作コード(opcode)へ回復する

• イベントを通じてスレッドを中断する(ステップ、ブレークポイントなど)
• PopFrameを呼び出す
• スレッドを再開する

フレームの位置の取得

jvmtiError
GetFrameLocation(jvmtiEnv* env,
            jthread thread,
            jint depth,
            jmethodID* method_ptr,
            jlocation* location_ptr)

フレームのポップの通知

jvmtiError
NotifyFramePop(jvmtiEnv* env,
            jthread thread,
            jint depth)

早期復帰の強制

• 早期復帰の強制 - オブジェクト型
• 早期復帰の強制 - 整数型
• 早期復帰の強制 - 長整数型
• 早期復帰の強制 - 浮動小数点数型
• 早期復帰の強制 - 倍精度浮動小数点数型
• 早期復帰の強制 - void型

早期復帰の強制 - オブジェクト型

jvmtiError
ForceEarlyReturnObject(jvmtiEnv* env,
            jthread thread,
            jobject value)

早期復帰の強制 - 整数型

jvmtiError
ForceEarlyReturnInt(jvmtiEnv* env,
            jthread thread,
            jint value)

早期復帰の強制 - 長整数型

jvmtiError
ForceEarlyReturnLong(jvmtiEnv* env,
            jthread thread,
            jlong value)

早期復帰の強制 - 浮動小数点数型

jvmtiError
ForceEarlyReturnFloat(jvmtiEnv* env,
            jthread thread,
            jfloat value)

早期復帰の強制 - 倍精度浮動小数点数型

jvmtiError
ForceEarlyReturnDouble(jvmtiEnv* env,
            jthread thread,
            jdouble value)

早期復帰の強制 - void型

jvmtiError
ForceEarlyReturnVoid(jvmtiEnv* env,
            jthread thread)

ヒープ

• 参照の追跡
• ヒープ内での反復
• タグの取得
• タグの設定
• タグを使ったオブジェクトの取得
• ガベージ・コレクションの強制

• ヒープ反復コールバック
• ヒープ参照コールバック
• プリミティブ・フィールド・コールバック
• 配列プリミティブ値コールバック
• 文字列プリミティブ値コールバック
• 将来使用するために予約されたコールバック

• jvmtiHeapReferenceKind - ヒープ参照の列挙
• jvmtiPrimitiveType - プリミティブ型の列挙
• jvmtiHeapReferenceInfoField - フィールド参照用の参照情報構造体
• jvmtiHeapReferenceInfoArray - 配列参照用の参照情報構造体
• jvmtiHeapReferenceInfoConstantPool - 定数プール参照用の参照情報構造体
• jvmtiHeapReferenceInfoStackLocal - 局所変数参照用の参照情報構造体
• jvmtiHeapReferenceInfoJniLocal - JNIローカル参照用の参照情報構造体
• jvmtiHeapReferenceInfoReserved - その他の参照用の参照情報構造体
• jvmtiHeapReferenceInfo - 参照情報構造体
• jvmtiHeapCallbacks - ヒープ・コールバック関数構造体

• ヒープ・フィルタ・フラグ
• ヒープ・ビジット制御フラグ

オブジェクトのタグ

ヒープ・コールバック関数

ヒープ・フィルタ・フラグ

定数	値	説明
JVMTI_HEAP_FILTER_TAGGED	0x4	タグ付きのオブジェクトをフィルタ・リングする。 タグの付いたオブジェクトが除外される。
JVMTI_HEAP_FILTER_UNTAGGED	0x8	タグなしのオブジェクトをフィルタ・リングする。 タグの付いていないオブジェクトが除外される。
JVMTI_HEAP_FILTER_CLASS_TAGGED	0x10	タグ付きのクラスを持つオブジェクトをフィルタ・リングする。 タグの付いたクラスのオブジェクトが除外される。
JVMTI_HEAP_FILTER_CLASS_UNTAGGED	0x20	タグなしのクラスを持つオブジェクトをフィルタ・リングする。 タグの付いていないクラスのオブジェクトが除外される。

ヒープ・ビジット制御フラグ

定数	値	説明
JVMTI_VISIT_OBJECTS	0x100	あるオブジェクトをビジットする際にこのコールバックがFollowReferencesによって起動されたものであった場合、そのオブジェクトの参照をトラバースする。 それ以外の場合は無視される。
JVMTI_VISIT_ABORT	0x8000	反復処理を中止。 ほかのすべてのビットを無視する。

ヒープ参照の列挙(jvmtiHeapReferenceKind)

定数	値	説明
JVMTI_HEAP_REFERENCE_CLASS	1	オブジェクトからそのクラスへの参照。
JVMTI_HEAP_REFERENCE_FIELD	2	オブジェクトから、そのオブジェクトのいずれかのインスタンス・フィールド値への参照。
JVMTI_HEAP_REFERENCE_ARRAY_ELEMENT	3	配列から、その配列のいずれかの要素への参照。
JVMTI_HEAP_REFERENCE_CLASS_LOADER	4	クラスからそのクラス・ローダーへの参照。
JVMTI_HEAP_REFERENCE_SIGNERS	5	クラスからその署名者の配列への参照。
JVMTI_HEAP_REFERENCE_PROTECTION_DOMAIN	6	クラスからその保護ドメインへの参照。
JVMTI_HEAP_REFERENCE_INTERFACE	7	クラスから、そのクラスのいずれかのインタフェースへの参照。 ノート: インタフェースは定数プール参照経由で定義されるため、参照されたインタフェースは参照の種類がJVMTI_HEAP_REFERENCE_CONSTANT_POOLで報告される可能性もある。
JVMTI_HEAP_REFERENCE_STATIC_FIELD	8	クラスからそのいずれかのstaticフィールド値への参照。
JVMTI_HEAP_REFERENCE_CONSTANT_POOL	9	クラスから定数プール内の解決済みエントリへの参照。
JVMTI_HEAP_REFERENCE_SUPERCLASS	10	クラスからそのスーパー・クラスへの参照。 スーパークラスがjava.lang.Objectの場合、コールバックは送信されません。 ノート: ロードされたクラスは定数プール参照経由でスーパー・クラスを定義するため、参照されたスーパー・クラスは参照の種類がJVMTI_HEAP_REFERENCE_CONSTANT_POOLで報告される可能性もある。
JVMTI_HEAP_REFERENCE_JNI_GLOBAL	21	ヒープ・ルート参照: JNIグローバル参照。
JVMTI_HEAP_REFERENCE_SYSTEM_CLASS	22	ヒープ・ルート参照: システム・クラス。
JVMTI_HEAP_REFERENCE_MONITOR	23	ヒープ・ルート参照: モニター。
JVMTI_HEAP_REFERENCE_STACK_LOCAL	24	スレッド・スタックのローカル変数。
JVMTI_HEAP_REFERENCE_JNI_LOCAL	25	JNIローカル参照。
JVMTI_HEAP_REFERENCE_THREAD	26	ヒープ・ルート参照: スレッド。
JVMTI_HEAP_REFERENCE_OTHER	27	ヒープ・ルート参照: ほかのヒープ・ルート参照。

プリミティブ型の列挙(jvmtiPrimitiveType)

定数	値	説明
JVMTI_PRIMITIVE_TYPE_BOOLEAN	90	「Z」- Javaプログラミング言語のboolean - JNIのjboolean
JVMTI_PRIMITIVE_TYPE_BYTE	66	「B」- Javaプログラミング言語のbyte - JNIのjbyte
JVMTI_PRIMITIVE_TYPE_CHAR	67	「C」- Javaプログラミング言語のchar - JNIのjchar
JVMTI_PRIMITIVE_TYPE_SHORT	83	「S」- Javaプログラミング言語のshort - JNIのjshort
JVMTI_PRIMITIVE_TYPE_INT	73	「I」- Javaプログラミング言語のint - JNIのjint
JVMTI_PRIMITIVE_TYPE_LONG	74	「J」- Javaプログラミング言語のlong - JNIのjlong
JVMTI_PRIMITIVE_TYPE_FLOAT	70	「F」- Javaプログラミング言語のfloat - JNIのjfloat
JVMTI_PRIMITIVE_TYPE_DOUBLE	68	「D」- Javaプログラミング言語のdouble - JNIのjdouble

フィールド参照用の参照情報構造体

typedef struct {
    jint index;
} jvmtiHeapReferenceInfoField;

jvmtiHeapReferenceInfoField - フィールド参照用の参照情報構造体

フィールド	型	説明
index	jint	JVMTI_HEAP_REFERENCE_FIELDの場合、参照側オブジェクトはクラスまたはインタフェースではありません。 この場合、indexは、参照側オブジェクトのクラスに含まれるフィールドのインデックスです。 以降、このクラスをCと呼びます。 JVMTI_HEAP_REFERENCE_STATIC_FIELDの場合、参照側オブジェクトは、クラス(以降Cと呼ぶ)とインタフェース(以降Iと呼ぶ)のいずれかになります。 この場合、indexは、そのクラスまたはインタフェースに含まれるフィールドのインデックスです。 参照側オブジェクトがインタフェースでない場合、フィールドのインデックスは次のようにして決定されます。 Cとそのスーパー・クラスに含まれるすべてのフィールドのリストが作成されます。このリストは、java.lang.Object内のすべてのフィールドで始まり、C内のすべてのフィールドで終わります。 このリスト内で、指定されたクラスのフィールドがGetClassFieldsから返された順番に並べられます。 このリスト内のフィールドに、インデックスn、n+1、... が順に割り当てられます。nは、Cによって実装されたすべてのインタフェースに含まれるフィールドのカウント数です。 Cは、そのスーパークラスが直接実装しているすべてのインタフェースと、それらのインタフェースのすべてのスーパーインタフェースを実装しています。 参照側オブジェクトがインタフェースである場合、フィールドのインデックスは次のようにして決定されます。 I内で直接宣言されているフィールドのリストが作成されます。 このリスト内のフィールドがGetClassFieldsから返された順番に並べられます。 このリスト内のフィールドに、インデックスn、n+1、... が順に割り当てられます。nは、Iのすべてのスーパー・インタフェースに含まれるフィールドのカウント数です。 この計算には、フィールド修飾子(static、public、privateなど)の種類にかかわらず、すべてのフィールドが含まれます。 たとえば、次のようなクラスとインタフェースが指定されているとします。 interface I0 { int p = 0; } interface I1 extends I0 { int x = 1; } interface I2 extends I0 { int y = 2; } class C1 implements I1 { public static int a = 3; private int b = 4; } class C2 extends C1 implements I2 { static int q = 5; final int r = 6; } C1で呼び出されたGetClassFieldsから、C1のフィールドa、bがこの順番で返され、C2のフィールドq、rがこの順番で返されるものとします。 クラスC1のインスタンスのフィールド・インデックスは、次のようになります。 フィールド 索引 説明 a 2 C1が実装するインタフェース内のフィールドのカウント数は2 (n=2)です。つまり、I0のpとI1のxです。 b 3 後続のインデックス。 クラスC1も同じフィールド・インデックスを持ちます。 クラスC2のインスタンスのフィールド・インデックスは、次のようになります。 フィールド 索引 説明 a 3 C2が実装するインタフェース内のフィールドのカウント数は3 (n=3)です。つまり、I0のp、I1のx、I2のy (C2のインタフェース)です。 I0のフィールドpが含まれるのは、一度のみです。 b 4 「a」に続くインデックス。 q 5 「b」に続くインデックス。 r 6 「q」に続くインデックス。 クラスC2も同じフィールド・インデックスを持ちます。 上記のフィールド「a」のように、同じフィールドが、参照側オブジェクトごとに異なるインデックスを持つ可能性があります。 また、コールバックからすべてのフィールド・インデックスが可視になるわけではありませんが、ここでは説明のためにすべてのインデックスを示しています。 インタフェースI1も同じフィールド・インデックスを持ちます。 フィールド 索引 説明 x 1 I1のスーパー・インタフェース内のフィールドのカウント数は1 (n=1)です。つまり、I0のpです。