Up Top

Serviceability 機能 ： JVMTI ： (おまけ) JPLIS(java agent) の処理

概要(Summary)

JPLIS 機能は, libinstrument.so という JVMTI agent, 及び sun.instrument.InstrumentationImpl という Java クラスによって実現されている. ユーザーが指定した java agent の呼び出しは libinstrument.so の 2つの callback から行われる

• VMInit 用の callback (eventHandlerVMInit())

  ここから java agent の "premain()" メソッドが呼び出される.

• ClassFileLoadHook 用の callback (eventHandlerClassFileLoadHook())

  ここから java agent の "transform()" メソッドが呼び出される.

処理の流れは以下のようになる.

1. まず, 初期化時に Arguments::parse_each_vm_init_arg() 関数の中で "-javaagent:" オプションが認識される.

   この際に Arguments::add_init_agent() が呼び出され, _agentList に "instrument" が追加される.

   (これは普通の JVMTI エージェントとほぼ同様 (See: here for details))

2. Threads::create_vm_init_agents() 中で, libinstrument.so が JVMTI agent としてダイナミックロードされる.

   (これは普通の JVMTI エージェントとほぼ同様 (See: here for details))

3. 各 "-javaagent:" オプションについて, Agent_OnLoad() が 1回ずつ呼ばれる.

   この中でコマンドラインオプションの情報が詳細にパースされ, _JPLISAgent::mAgentClassName と _JPLISAgent::mOptionsString に格納される.

   さらに, Agent_OnLoad() (の中で呼ばれる initializeJPLISAgent()) によって VMInit 用の callback である eventHandlerVMInit() が登録される.

4. VMInit 時のコールバック処理で eventHandlerVMInit() が呼び出される.

   この中で ClassFileLoadHook 用の callback である eventHandlerClassFileLoadHook() が登録される.

   また, ユーザーが指定した java agent の premain() メソッドの呼び出しも行われる.

5. クラスファイルがロードされると, ClassFileLoadHook 時のコールバック処理で eventHandlerClassFileLoadHook() が呼び出される. (See: here for details)

   この中で, ユーザーが指定した java agent の transform() メソッドの呼び出しが行われる.

備考(Notes)

関連するソースコード, 及びビルド用の Makefile は以下のディレクトリにある.

• jdk/src/share/instrument
• jdk/make/java/instrument/Makefile

処理の流れ (概要)(Execution Flows : Summary)

Agent_OnLoad() での処理

Agent_OnLoad()
-> createNewJPLISAgent()
   -> allocateJPLISAgent()
      -> allocate()
   -> initializeJPLISAgent()
-> parseArgumentTail()
-> readAttributes()
-> getAttribute()
-> appendClassPath()
-> ...
-> recordCommandLineData()

VMInit コールバックでの処理

eventHandlerVMInit()
-> processJavaStart()
   -> createInstrumentationImpl()
   -> setLivePhaseEventHandlers()
   -> startJavaAgent()
      -> invokeJavaAgentMainMethod()
         -> jni_CallVoidMethod()
            -> (See: here for details)
               -> sun.instrument.InstrumentationImpl.loadClassAndCallPremain()
                  -> sun.instrument.InstrumentationImpl.loadClassAndStartAgent()
                     -> java.lang.Class.getDeclaredMethod()   (<= premain() メソッドの取得)
                     -> java.lang.reflect.Method.invoke()
                        -> (ユーザーが指定した java agent の premain() メソッドが呼び出される)
   -> deallocateCommandLineData()

ClassFileLoadHook コールバックでの処理

eventHandlerClassFileLoadHook()
-> transformClassFile()
   -> jni_CallObjectMethod()
      -> (See: here for details)
         -> sun.instrument.InstrumentationImpl.transform()
            -> sun.instrument.TransformerManager.transform()
               -> (ユーザーが指定した java agent の transform() メソッドが呼び出される)

java.lang.instrument.Instrumentation クラスの処理

java.lang.instrument.Instrumentation.addTransformer() の処理

sun.instrument.InstrumentationImpl.addTransformer(ClassFileTransformer transformer)
-> sun.instrument.InstrumentationImpl.addTransformer(ClassFileTransformer transformer, boolean canRetransform)
   -> sun.instrument.TransformerManager.addTransformer()

処理の流れ (詳細)(Execution Flows : Details)

Agent_OnLoad()

(#Under Construction) See: here for details

createNewJPLISAgent()

(#Under Construction)

initializeJPLISAgent()

(#Under Construction)

...

This document is available under the GNU GENERAL PUBLIC LICENSE Version 2.