You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

391 lines
21 KiB
Markdown

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# Android JVM TI机制详解内含福利彩蛋
你好,我是孙鹏飞。
在专栏[卡顿优化](http://time.geekbang.org/column/article/73277)的分析中绍文提到可以利用JVM TI机制获得更加非常丰富的顿现场信息包括内存申请、线程创建、类加载、GC信息等。
JVM TI机制究竟是什么它为什么如此的强大怎么样将它应用到我们的工作中今天我们一起来解开它神秘的面纱。
## JVM TI介绍
JVM TI全名是[Java Virtual Machine Tool Interface](https://docs.oracle.com/javase/7/docs/platform/jvmti/jvmti.html#SpecificationIntro)是开发虚拟机监控工具使用的编程接口它可以监控JVM内部事件的执行也可以控制JVM的某些行为可以实现调试、监控、线程分析、覆盖率分析工具等。
JVM TI属于[Java Platform Debugger Architecture](https://docs.oracle.com/javase/7/docs/technotes/guides/jpda/architecture.html)中的一员在Debugger Architecture上JVM TI可以算作一个back-end通过JDWP和front-end JDI去做交互。需要注意的是Android内的JDWP并不是基于JVM TI开发的。
从Java SE 5开始Java平台调试体系就使用JVM TI替代了之前的JVMPI和JVMDI。如果你对这部分背景还不熟悉强烈推荐先阅读下面这几篇文章
* [深入 Java 调试体系:第 1 部分JPDA 体系概览](https://www.ibm.com/developerworks/cn/java/j-lo-jpda1/index.html)
* [深入 Java 调试体系:第 2 部分JVMTI 和 Agent 实现](https://www.ibm.com/developerworks/cn/java/j-lo-jpda2/index.html)
* [深入 Java 调试体系:第 3 部分JDWP 协议及实现](https://www.ibm.com/developerworks/cn/java/j-lo-jpda3/index.html)
* [深入 Java 调试体系:第 4 部分Java 调试接口JDI](https://www.ibm.com/developerworks/cn/java/j-lo-jpda4/index.html)
虽然Java已经使用了JVM TI很多年但从源码上看在Android 8.0才[集成](http://androidxref.com/8.0.0_r4/xref/art/runtime/openjdkjvmti/)了JVM TI v1.2主要是需要在Runtime中支持修改内存中的Dex和监控全局的事件。有了JVM TI的支持我们可以实现很多调试工具没有实现的功能或者定制我们自己的Debug工具来获取我们关心的数据。
现阶段已经有工具使用JVM TI技术比如Android Studio的Profilo工具和Linkedin的[dexmaker-mockito-inline](https://github.com/linkedin/dexmaker/tree/master/dexmaker-mockito-inline)工具。Android Studio使用JVM TI机制实现了实时的内存监控对象分配切片、GC事件、Memory Alloc Diff功能非常强大dexmaker使用该机制实现Mock final methods和static methods。
**1\. JVM TI支持的功能**
在介绍JVM TI的实现原理之前我们先来看一下JVM TI提供了什么功能我们可以利用这些功能做些什么
**线程相关事件 -> 监控线程创建堆栈、锁信息**
* ThreadStart :线程在执行方法前产生线程启动事件。
* ThreadEnd线程结束事件。
* MonitorWaitwait方法调用后。
* MonitorWaitedwait方法完成等待。
* MonitorContendedEnter当线程试图获取一个已经被其他线程持有的对象锁时。
* MonitorContendedEntered当线程获取到对象锁继续执行时。
**类加载准备事件 -> 监控类加载**
* ClassFileLoadHook在类加载之前触发。
* ClassLoad某个类首次被加载。
* ClassPrepare某个类的准备阶段完成。
**异常事件 -> 监控异常信息**
* Exception有异常抛出的时候。
* ExceptionCatch当捕获到一个异常时候。
**调试相关**
* SingleStep步进事件可以实现相当细粒度的字节码执行序列这个功能可以探查多线程下的字节码执行序列。
* Breakpoint当线程执行到一个带断点的位置断点可以通过JVMTI SetBreakpoint方法来设置。
**方法执行**
* FramePop当方法执行到retrun指令或者出现异常时候产生手动调用NofityFramePop JVM TI函数也可产生该事件。
* MethodEntry当开始执行一个Java方法的时候。
* MethodExit当方法执行完成后产生异常退出时。
* FieldAccess当访问了设置了观察点的属性时产生事件观察点使用SetFieldAccessWatch函数设置。
* FieldModification当设置了观察点的属性值被修改后观察点使用SetFieldModificationWatch设置。
**GC -> 监控GC事件与时间**
* GarbageCollectionStartGC启动时。
* GarbageCollectionFinishGC结束后。
**对象事件 -> 监控内存分配**
* ObjectFreeGC释放一个对象时。
* VMObjectAlloc虚拟机分配一个对象的时候。
**其他**
* NativeMethodBind在首次调用本地方法时或者调用JNI RegisterNatives的时候产生该事件通过该回调可以将一个JNI调用切换到指定的方法上。
通过上面的事件描述可以大概了解到JVM TI支持什么功能详细的回调函数参数可以从JVM TI[规范文档](https://docs.oracle.com/javase/7/docs/platform/jvmti/jvmti.html)里获取到,**我们可以通过这些功能实们定制的性能监控、数据采集、行为修改等工具。**
**2\. JVM TI实现原理**
JVM TI Agent的启动需要虚拟机的支持我们的Agent和虚拟机运行在同一个进程中虚拟机通过dlopen打开我们的Agent动态链接库然后通过Agent\_OnAttach方法来调用我们定义的初始化逻辑。
JVM TI的原理其实很简单以VmObjectAlloc事件为例当我们通过SetEventNotificationMode函数设置JVMTI\_EVENT\_VM\_OBJECT\_ALLOC回调的时候最终会调用到art::Runtime::Current() -> GetHeap() -> SetAllocationListener(listener);
在这个方法中listener是JVM TI实现的一个虚拟机提供的art::gc::AllocationListener回调当虚拟机分配对象内存的时候会调用该回调源码可见[heap-inl.h#194](http://androidxref.com/9.0.0_r3/xref/art/runtime/gc/heap-inl.h#194)同时在该回调函数里也会调用我们之前设置的callback方法这样事件和相关的数据就会透传到我们的Agent里来实现完成事件的监听。
类似atrace和StrictModeJVM TI的每个事件都需要在源码中埋点支持。感兴趣的同学可以挑选一些事件在源码中进一步跟踪。
## JVM TI Agent开发
JVM TI Agent程序使用C/C++语言开发也可以使用其他支持C语言调用语言开发比如Rust。
JVM TI所涉及的常量、函数、事件、数据类型都定义在jvmti.h文件中我们需要下载该文件到项目中引用使用你可以从Android项目里下载它的[头文件](http://androidxref.com/9.0.0_r3/xref/art/openjdkjvmti/include/)。
JVM TI Agent的产出是一个so文件在Android里通过系统提供的[Debug.attachJvmtiAgent](https://developer.android.com/reference/kotlin/android/os/Debug#attachJvmtiAgent%28kotlin.String%2C+kotlin.String%2C+java.lang.ClassLoader%29)方法来启动一个JVM TI Agent程序。
```
static fun attachJvmtiAgent(library: String, options: String?, classLoader: ClassLoader?): Unit
```
library是so文件的绝对地址。需要注意的是API Level为28而且需要应用开启了[android:debuggable](https://developer.android.com/guide/topics/manifest/application-element#debug)才可以使用,**不过我们可以通过强制开启debug来在release版里启动JVM TI功能**。
Android下的JVM TI Agent在被虚拟机加载后会及时调用Agent\_OnAttach方法这个方法可以当作是Agent程序的main函数所以我们需要在程序里实现下面的函数。
```
extern "C" JNIEXPORT jint JNICALL Agent_OnAttach(JavaVM *vm, char *options,void *reserved)
```
你可以在这个方法里进行初始化操作。
通过JavaVM::GetEnv函数拿到jvmtiEnv\*环境指针Environment Pointer通过该指针可以访问JVM TI提供的函数。
```
jvmtiEnv *jvmti_env;jint result = vm->GetEnv((void **) &jvmti_env, JVMTI_VERSION_1_2);
```
通过AddCapabilities函数来开启需要的功能也可以通过下面的方法开启所有的功能不过开启所有的功能对虚拟机的性能有所影响。
```
void SetAllCapabilities(jvmtiEnv *jvmti) {
jvmtiCapabilities caps;
jvmtiError error;
error = jvmti->GetPotentialCapabilities(&caps);
error = jvmti->AddCapabilities(&caps);
}
```
GetPotentialCapabilities函数可以获取当前环境支持的功能集合通过jvmtiCapabilities结构体返回该结构体里标明了支持的所有功能可以通过[jvmti.h](http://androidxref.com/9.0.0_r3/xref/art/openjdkjvmti/include/jvmti.h#712)来查看,大概内容如下。
```
typedef struct {
unsigned int can_tag_objects : 1;
unsigned int can_generate_field_modification_events : 1;
unsigned int can_generate_field_access_events : 1;
unsigned int can_get_bytecodes : 1;
unsigned int can_get_synthetic_attribute : 1;
unsigned int can_get_owned_monitor_info : 1;
......
} jvmtiCapabilities;
```
然后通过AddCapabilities方法来启动需要的功能如果需要单独添加功能则可以通过如下方法。
```
jvmtiCapabilities caps;
memset(&caps, 0, sizeof(caps));
caps.can_tag_objects = 1;
```
到此JVM TI的初始化操作就已经完成了。
所有的函数和数据结构类型说明可以在[这里](https://docs.oracle.com/javase/7/docs/platform/jvmti/jvmti.html)找到。下面我来介绍一些常用的功能和函数。
**1\. JVM TI事件监控**
JVM TI的一大功能就是可以收到虚拟机执行时候的各种事件通知。
首先通过SetEventCallbacks方法来设置目标事件的回调函数如果callbacks传入nullptr则清除掉所有的回调函数。
```
jvmtiEventCallbacks callbacks;
memset(&callbacks, 0, sizeof(callbacks));
callbacks.GarbageCollectionStart = &GCStartCallback;
callbacks.GarbageCollectionFinish = &GCFinishCallback;
int error = jvmti_env->SetEventCallbacks(&callbacks, sizeof(callbacks));
```
设置了回调函数后如果要收到目标事件的话需要通过SetEventNotificationMode这个函数有个需要注意的地方是event\_thread如果参数event\_thread参数为nullptr则会全局启用改目标事件回调否则只在指定的线程内生效比如很多时候对于一些事件我们只关心主线程。
```
jvmtiError SetEventNotificationMode(jvmtiEventMode mode,
jvmtiEvent event_type,
jthread event_thread,
...);
typedef enum {
JVMTI_ENABLE = 1,//开启
JVMTI_DISABLE = 0 .//关闭
} jvmtiEventMode;
```
以上面的GC事件为例上面设置了GC事件的回调函数如果想要在回调方法里接收到事件则需要使用SetEventNotificationMode开启事件需要说明的是SetEventNotificationMode和SetEventCallbacks方法调用没有先后顺序。
```
jvmti->SetEventNotificationMode(JVMTI_ENABLE, JVMTI_EVENT_GARBAGE_COLLECTION_START, nullptr);
jvmti->SetEventNotificationMode(JVMTI_ENABLE, JVMTI_EVENT_GARBAGE_COLLECTION_FINISH, nullptr);
```
通过上面的步骤就可以在虚拟机产生GC事件后在回调函数里获取到对应的函数了这个Sample需要注意的是在gc callback里禁止使用JNI和JVM TI函数因为虚拟机处于停止状态。
```
void GCStartCallback(jvmtiEnv *jvmti) {
LOGI("==========触发 GCStart=======");
}
void GCFinishCallback(jvmtiEnv *jvmti) {
LOGI("==========触发 GCFinish=======");
}
```
Sample效果如下。
```
com.dodola.jvmti I/jvmti: ==========触发 GCStart=======
com.dodola.jvmti I/jvmti: ==========触发 GCFinish=======
```
**2\. JVM TI字节码增强**
JVM TI可以在虚拟机运行的状态下对字节码进行修改可以通过下面三种方式修改字节码。
* Static在虚拟机加载Class文件之前对字节码修改。该方式一般不采用。
* Load-Time在虚拟机加载某个Class时可以通过JVM TI回调拿到该类的字节码会触发ClassFileLoadHook回调函数该方法由于ClassLoader机制只会触发一次由于我们Attach Agent的时候经常是在虚拟机执行一段时间之后所以并不能修改已经加载的Class比如Object所以需要根据Class的加载时机选择该方法。
* Dynamic对于已经载入的Class文件也可以通过JVM TI机制修改当系统调用函数RetransformClasses时会触发ClassFileLoadHook此时可以对字节码进行修改该方法最为实用。
传统的JVM操作的是Java BytecodeAndroid里的字节码操作的是[Dalvik Bytecode](https://source.android.com/devices/tech/dalvik/dalvik-bytecode)Dalvik Bytecode是寄存器实现的操作起来相对JavaBytecode来说要相对容易一些可以不用处理本地变量和操作数栈的交互。
使用这个功能需要开启JVM TI字节码增强功能。
```
jvmtiCapabilities.can_generate_all_class_hook_events=1 //开启 class hook 功能标记
jvmtiCapabilities.can_retransform_any_class=1 //开启对任意类进行 retransform 操作
```
然后注册ClassFileLoadHook事件回调。
```
jvmtiEventCallbacks callbacks;s
callbacks.ClassFileLoadHook = &ClassTransform;
```
这里说明一下ClassFileLoadHook的函数原型后面会讲解如何重新修改现有字节码。
```
static void ClassTransform(
jvmtiEnv *jvmti_env,//jvmtiEnv 环境指针
JNIEnv *env,//jniEnv 环境指针
jclass classBeingRedefined,//被重新定义的class 信息
jobject loader,//加载该 class 的 classloader如果该项为 nullptr 则说明是 BootClassLoader 加载的
const char *name,//目标类的限定名
jobject protectionDomain,//载入类的保护域
jint classDataLen,//class 字节码的长度
const unsigned char *classData,//class 字节码的数据
jint *newClassDataLen,//新的类数据的长度
unsigned char **newClassData) //新类的字节码数据
```
然后开启事件完整的初始化逻辑可参考Sample中的代码。
```
SetEventNotificationMode(JVMTI_ENABLE, JVMTI_EVENT_CLASS_FILE_LOAD_HOOK, NULL)
```
下面以Sample代码作为示例来讲解如何在Activity类的onCreate方法中插入一行日志调用代码。
通过上面的步骤后就可以在虚拟机第一次加载类的时候和在调用RetransformClasses或者RedefineClasses时在ClassFileLoadHook回调方法里会接收到事件回调。我们目标类是Activity它在启动应用的时候就已经触发了类加载的过程由于这个Sample开启事件的时机很靠后所以此时并不会收到加载Activity类的事件回调所以需要调用RetransformClasses来触发事件回调这个方法用于对已经载入的类进行修改传入一个要修改类的Class数组和数组长度。
```
jvmtiError RetransformClasses(jint class_count, const jclass* classes)
```
调用该方法后会在ClassFileLoadHook设置的回调也就是上面的ClassTran sform方法中接收到回调在这个回调方法中我们通过字节码处理工具来修改原始类的字节码。
类的修改会触发虚拟机使用新的方法旧的方法将不再被调用如果有一个方法正在栈帧上则这个方法会继续运行旧的方法的字节码。RetransformClasses 的修改不会导致类的初始化,也就是不会重新调用方法,类的静态变量的值和实例变量的值不会产生变化,但目标类的断点会失效。
处理类有一些限制我们可以改变方法的实现和属性但不能添加删除重命名方法不能改变方法签名、参数、修饰符不能改变类的继承关系如果产生上面的行为会导致修改失败。修改之后会触发类的校验而且如果虚拟机里有多个相同的Class 我们需要注意一下取到的Class需要是当前生效的Class按照ClassLoader加载机制也就是说优先使用提前加载的类。
Sample中实现的效果是在Activity.onCreate方法中增加一行日志输出。
修改前:
```
protected void onCreate(@Nullable Bundle savedInstanceState) {
.......
}
```
修改后:
```
protected void onCreate(@Nullable Bundle savedInstanceState) {
com.dodola.jvmtilib.JVMTIHelper.printEnter(this,"....");
....
}
```
我使用的Dalvik字节码修改库是Android系统源码里提供的一套修改框架[dexter](http://androidxref.com/9.0.0_r3/xref/tools/dexter/),虽然使用起来十分灵活但比较繁琐,也可以使用[dexmaker](https://github.com/linkedin/dexmaker)框架来实现。本例还是使用dexter框架使用C++开发可以直接读取classdata然后进行操作可以类比到ASM框架。下面的代码是核心的操作代码完整的代码参考本期Sample。
```
ir::Type* stringT = b.GetType("Ljava/lang/String;");
ir::Type* jvmtiHelperT=b.GetType("Lcom/dodola/jvmtilib/JVMTIHelper;");
lir::Instruction *fi = *(c.instructions.begin());
VReg* v0 = c.Alloc<VReg>(0);
addInstr(c, fi, OP_CONST_STRING,
{v0, c.Alloc<String>(methodDesc, methodDesc->orig_index)});
addCall(b, c, fi, OP_INVOKE_STATIC, jvmtiHelperT, "printEnter", voidT, {stringT}, {0});
c.Assemble();
```
必须通过JVM TI函数Allocate为要修改的类数据分配内存将new\_class\_data指向修改后的类bytecode数组将new\_class\_data\_len置为修改后的类bytecode数组的长度。若是不修改类文件则不设置new\_class\_data即可。若是加载了多个JVM TI Agent都启用了该事件则设置的new\_class\_data会成为下一个JVM TI Agent的class\_data。
此时我们生成的onCreate方法里已经加上了我们添加的日志方法调用。开启新的Activity会使用新的类字节码执行同时会使用ClassLoader加载我们注入的com.dodola.jvmtilib.JVMTIHelper类。我在前面说过Activity是使用BootClassLoader进行加载的然而我们的类明显不在BootClassLoader里此时就会产生Crash。
```
java.lang.NoClassDefFoundError: Class not found using the boot class loader; no stack trace available
```
所以需要想办法将JVMTIHelper类添加到BootClassLoader里这里可以使用JVM TI提供的AddToBootstrapClassLoaderSearch方法来添加Dex或者APK到Class搜索目录里。Sample里是将 getPackageCodePath添加进去就可以了。
## 总结
今天我主要讲解了JVM TI的概念和原理以及它可以实现的功能。通过JVM TI可以完成很多平时可能需要很多“黑科技”才可以获取到的数据比如[Thread Park Start/Finish](https://android-review.googlesource.com/c/platform/art/+/822440)事件、获取一个锁的waiters等。
可能在Android圈里了解JVM TI的人不多对它的研究还没有非常深入。目前JVM TI的功能已经十分强大后续的Android版本也会进一步增加更多的功能支持这样它可以做的事情将会越来越多。我相信在未来它将会是本地自动化测试甚至是线上远程诊断的一大“杀器”。
在本期的[Sample](https://github.com/AndroidAdvanceWithGeektime/JVMTI_Sample)里,我们提供了一些简单的用法,你可以在这个基础之上完成扩展,实现自己想要的功能。
## 相关资料
1.[深入 Java 调试体系:第 1 部分JPDA 体系概览](https://www.ibm.com/developerworks/cn/java/j-lo-jpda1/index.html)
2.[深入 Java 调试体系:第 2 部分JVMTI 和 Agent 实现](https://www.ibm.com/developerworks/cn/java/j-lo-jpda2/index.html)
3.[深入 Java 调试体系:第 3 部分JDWP 协议及实现](https://www.ibm.com/developerworks/cn/java/j-lo-jpda3/index.html)
4.[深入 Java 调试体系:第 4 部分Java 调试接口JDI](https://www.ibm.com/developerworks/cn/java/j-lo-jpda4/index.html)
5.JVM TI官方文档[https://docs.oracle.com/javase/7/docs/platform/jvmti/jvmti.html](https://docs.oracle.com/javase/7/docs/platform/jvmti/jvmti.html)
6.源码是最好的资料:[http://androidxref.com/9.0.0\_r3/xref/art/openjdkjvmti/](http://androidxref.com/9.0.0_r3/xref/art/openjdkjvmti/)
## 福利彩蛋
根据专栏导读里我们约定的,我和绍文会选出一些认真提交作业完成练习的同学,送出一份“学习加油礼包”。专栏更新到现在,很多同学留下了自己的思考和总结,我们选出了@Owen、@志伟、@许圣明、@小洁、@SunnyBird送出“[极客时间周历](time://mall?url=http%3A%2F%2Fh5.youzan.com%2Fv2%2Fgoods%2F2fwl2bk2x20js)”一份,希望更多同学可以加入到学习和讨论中来,与我们一起进步。
![](https://static001.geekbang.org/resource/image/c9/ce/c91eaa4425b74b8c5d8a044e0332f8ce.png)
@Owen学习总结:[https://github.com/devzhan/Breakpad](https://github.com/devzhan/Breakpad)
@许圣明、@小洁、@SunnyBird 通过Pull Requests提交了练习作业[https://github.com/AndroidAdvanceWithGeektime/Chapter04/pulls](https://github.com/AndroidAdvanceWithGeektime/Chapter04/pulls)。
极客时间小助手会在24小时内与获奖用户取得联系注意查看短信哦