JVM CPU Profiler 技术原理及源码深度解析

阅读数:1116 2019 年 10 月 15 日 08:00

JVM CPU Profiler技术原理及源码深度解析

引言

研发人员在遇到线上报警或需要优化系统性能时,常常需要分析程序运行行为和性能瓶颈。Profiling 技术是一种在应用运行时收集程序相关信息的动态分析手段,常用的 JVM Profiler 可以从多个方面对程序进行动态分析,如 CPU、Memory、Thread、Classes、GC 等,其中 CPU Profiling 的应用最为广泛。

CPU Profiling 经常被用于分析代码的执行热点,如“哪个方法占用 CPU 的执行时间最长”、“每个方法占用 CPU 的比例是多少”等等,通过 CPU Profiling 得到上述相关信息后,研发人员就可以轻松针对热点瓶颈进行分析和性能优化,进而突破性能瓶颈,大幅提升系统的吞吐量。

CPU Profiler 简介

社区实现的 JVM Profiler 很多,比如已经商用且功能强大的 JProfiler ,也有免费开源的产品,如 JVM-Profiler ,功能各有所长。我们日常使用的 Intellij IDEA 最新版内部也集成了一个简单好用的 Profiler,详细的介绍参见官方 Blog

在用 IDEA 打开需要诊断的 Java 项目后,在“Preferences -> Build, Execution, Deployment -> Java Profiler”界面添加一个“CPU Profiler”,然后回到项目,单击右上角的“Run with Profiler”启动项目并开始 CPU Profiling 过程。一定时间后(推荐 5min),在 Profiler 界面点击“Stop Profiling and Show Results”,即可看到 Profiling 的结果,包含火焰图和调用树,如下图所示:

JVM CPU Profiler技术原理及源码深度解析

Intellij IDEA - 性能火焰图

JVM CPU Profiler技术原理及源码深度解析

Intellij IDEA - 调用堆栈树

火焰图是根据调用栈的样本集生成的可视化性能分析图,《如何读懂火焰图?》一文对火焰图进行了不错的讲解,大家可以参考一下。简而言之,看火焰图时我们需要关注“平顶”,因为那里就是我们程序的 CPU 热点。调用树是另一种可视化分析的手段,与火焰图一样,也是根据同一份样本集而生成,按需选择即可。

这里要说明一下,因为我们没有在项目中引入任何依赖,仅仅是“Run with Profiler”,Profiler 就能获取我们程序运行时的信息。这个功能其实是通过 JVM Agent 实现的,为了更好地帮助大家系统性的了解它,我们在这里先对 JVM Agent 做个简单的介绍。

JVM Agent 简介

JVM Agent 是一个按一定规则编写的特殊程序库,可以在启动阶段通过命令行参数传递给 JVM,作为一个伴生库与目标 JVM 运行在同一个进程中。在 Agent 中可以通过固定的接口获取 JVM 进程内的相关信息。Agent 既可以是用 C/C++/Rust 编写的 JVMTI Agent,也可以是用 Java 编写的 Java Agent。

执行 Java 命令,我们可以看到 Agent 相关的命令行参数:

复制代码
-agentlib:< 库名 >[=< 选项 >]
加载本机代理库 < 库名 >, 例如 -agentlib:jdwp
另请参阅 -agentlib:jdwp=help
-agentpath:< 路径名 >[=< 选项 >]
按完整路径名加载本机代理库
-javaagent:<jar 路径 >[=< 选项 >]
加载 Java 编程语言代理, 请参阅 java.lang.instrument

JVMTI Agent

JVMTI(JVM Tool Interface)是 JVM 提供的一套标准的 C/C++ 编程接口,是实现 Debugger、Profiler、Monitor、Thread Analyser 等工具的统一基础,在主流 Java 虚拟机中都有实现。

当我们要基于 JVMTI 实现一个 Agent 时,需要实现如下入口函数:

复制代码
// $JAVA_HOME/include/jvmti.h
JNIEXPORT jint JNICALL Agent_OnLoad(JavaVM *vm, char *options, void *reserved);

使用 C/C++ 实现该函数,并将代码编译为动态连接库( Linux 上是.so ),通过 -agentpath 参数将库的完整路径传递给 Java 进程,JVM 就会在启动阶段的合适时机执行该函数。在函数内部,我们可以通过 JavaVM 指针参数拿到 JNI 和 JVMTI 的函数指针表,这样我们就拥有了与 JVM 进行各种复杂交互的能力。

更多 JVMTI 相关的细节可以参考官方文档

Java Agent

在很多场景下,我们没有必要必须使用 C/C++ 来开发 JVMTI Agent,因为成本高且不易维护。JVM 自身基于 JVMTI 封装了一套 Java 的Instrument API接口,允许使用 Java 语言开发 Java Agent(只是一个 jar 包),大大降低了 Agent 的开发成本。社区开源的产品如 Greys Arthas JVM-Sandbox JVM-Profiler 等都是纯 Java 编写的,也是以 Java Agent 形式来运行。

在 Java Agent 中,我们需要在 jar 包的 MANIFEST.MF 中将Premain-Class指定为一个入口类,并在该入口类中实现如下方法:

复制代码
public static void premain(String args, Instrumentation ins) {
// implement
}

这样打包出来的 jar 就是一个 Java Agent,可以通过 -javaagent 参数将 jar 传递给 Java 进程伴随启动,JVM 同样会在启动阶段的合适时机执行该方法。

在该方法内部,参数Instrumentation接口提供了Retransform Classes的能力,我们利用该接口就可以对宿主进程的 Class 进行修改,实现方法耗时统计、故障注入、Trace 等功能。Instrumentation 接口提供的能力较为单一,仅与 Class 字节码操作相关,但由于我们现在已经处于宿主进程环境内,就可以利用 JMX 直接获取宿主进程的内存、线程、锁等信息。无论是 Instrument API 还是 JMX,它们内部仍是统一基于 JVMTI 来实现

更多 Instrument API 相关的细节可以参考官方文档

CPU Profiler 原理解析

在了解完 Profiler 如何以 Agent 的形式执行后,我们可以开始尝试构造一个简单的 CPU Profiler。但在此之前,还有必要了解下 CPU Profiling 技术的两种实现方式及其区别。

Sampling vs Instrumentation

使用过 JProfiler 的同学应该都知道,JProfiler 的 CPU Profiling 功能提供了两种方式选项: SamplingInstrumentation,它们也是实现 CPU Profiler 的两种手段。

Sampling 方式顾名思义,基于对 StackTrace 的“采样”进行实现,核心原理如下:

  1. 引入 Profiler 依赖,或直接利用 Agent 技术注入目标 JVM 进程并启动 Profiler。
  2. 启动一个采样定时器,以固定的采样频率每隔一段时间(毫秒级)对所有线程的调用栈进行 Dump。
  3. 汇总并统计每次调用栈的 Dump 结果,在一定时间内采到足够的样本后,导出统计结果,内容是每个方法被采样到的次数及方法的调用关系。

Instrumentation 则是利用 Instrument API,对所有必要的 Class 进行字节码增强,在进入每个方法前进行埋点,方法执行结束后统计本次方法执行耗时,最终进行汇总。二者都能得到想要的结果,那么它们有什么区别呢?或者说,孰优孰劣?

Instrumentation 方式对几乎所有方法添加了额外的 AOP 逻辑,这会导致对线上服务造成巨额的性能影响,但其优势是:绝对精准的方法调用次数、调用时间统计

Sampling 方式基于无侵入的额外线程对所有线程的调用栈快照进行固定频率抽样,相对前者来说它的性能开销很低。但由于它基于“采样”的模式,以及 JVM 固有的只能在安全点(Safe Point)进行采样的“缺陷”,会导致统计结果存在一定的偏差。譬如说:某些方法执行时间极短,但执行频率很高,真实占用了大量的 CPU Time,但 Sampling Profiler 的采样周期不能无限调小,这会导致性能开销骤增,所以会导致大量的样本调用栈中并不存在刚才提到的”高频小方法“,进而导致最终结果无法反映真实的 CPU 热点。更多 Sampling 相关的问题可以参考《 Why (Most) Sampling Java Profilers Are Fucking Terrible 》。

具体到“孰优孰劣”的问题层面,这两种实现技术并没有非常明显的高下之判,只有在分场景讨论下才有意义。Sampling 由于低开销的特性,更适合用在 CPU 密集型的应用中,以及不可接受大量性能开销的线上服务中。而 Instrumentation 则更适合用在 I/O 密集的应用中、对性能开销不敏感以及确实需要精确统计的场景中。社区的 Profiler 更多的是基于 Sampling 来实现,本文也是基于 Sampling 来进行讲解。

基于 Java Agent + JMX 实现

一个最简单的 Sampling CPU Profiler 可以用 Java Agent + JMX 方式来实现。以 Java Agent 为入口,进入目标 JVM 进程后开启一个 ScheduledExecutorService,定时利用 JMX 的 threadMXBean.dumpAllThreads() 来导出所有线程的 StackTrace,最终汇总并导出即可。

Uber 的 JVM-Profiler 实现原理也是如此,关键部分代码如下:

复制代码
// com/uber/profiling/profilers/StacktraceCollectorProfiler.java
/*
* StacktraceCollectorProfiler 等同于文中所述 CpuProfiler,仅命名偏好不同而已
* jvm-profiler 的 CpuProfiler 指代的是 CpuLoad 指标的 Profiler
*/
// 实现了 Profiler 接口,外部由统一的 ScheduledExecutorService 对所有 Profiler 定时执行
@Override
public void profile() {
ThreadInfo[] threadInfos = threadMXBean.dumpAllThreads(false, false);
// ...
for (ThreadInfo threadInfo : threadInfos) {
String threadName = threadInfo.getThreadName();
// ...
StackTraceElement[] stackTraceElements = threadInfo.getStackTrace();
// ...
for (int i = stackTraceElements.length - 1; i >= 0; i--) {
StackTraceElement stackTraceElement = stackTraceElements[i];
// ...
}
// ...
}
}

Uber 提供的定时器默认 Interval 是 100ms,对于 CPU Profiler 来说,这略显粗糙。但由于 dumpAllThreads() 的执行开销不容小觑,Interval 不宜设置的过小,所以该方法的 CPU Profiling 结果会存在不小的误差。

JVM-Profiler 的优点在于支持多种指标的 Profiling(StackTrace、CPUBusy、Memory、I/O、Method),且支持将 Profiling 结果通过 Kafka 上报回中心 Server 进行分析,也即支持集群诊断。

基于 JVMTI + GetStackTrace 实现

使用 Java 实现 Profiler 相对较简单,但也存在一些问题,譬如说 Java Agent 代码与业务代码共享 AppClassLoader,被 JVM 直接加载的 agent.jar 如果引入了第三方依赖,可能会对业务 Class 造成污染。截止发稿时,JVM-Profiler 都存在这个问题,它引入了 Kafka-Client、http-Client、Jackson 等组件,如果与业务代码中的组件版本发生冲突,可能会引发未知错误。Greys/Arthas/JVM-Sandbox 的解决方式是分离入口与核心代码,使用定制的 ClassLoader 加载核心代码,避免影响业务代码。

在更底层的 C/C++ 层面,我们可以直接对接 JVMTI 接口,使用原生 C API 对 JVM 进行操作,功能更丰富更强大,但开发效率偏低。基于上节同样的原理开发 CPU Profiler,使用 JVMTI 需要进行如下这些步骤:

  1. 编写 Agent_OnLoad(),在入口通过 JNI 的 JavaVM* 指针的 GetEnv() 函数拿到 JVMTI 的 jvmtiEnv 指针:
复制代码
// agent.c
JNIEXPORT jint JNICALL Agent_OnLoad(JavaVM *vm, char *options, void *reserved) {
jvmtiEnv *jvmti;
(*vm)->GetEnv((void **)&jvmti, JVMTI_VERSION_1_0);
// ...
return JNI_OK;
}
  1. 开启一个线程定时循环,定时使用 jvmtiEnv 指针配合调用如下几个 JVMTI 函数:
复制代码
// 获取所有线程的 jthread
jvmtiError GetAllThreads(jvmtiEnv *env, jint *threads_count_ptr, jthread **threads_ptr);
// 根据 jthread 获取该线程信息(name、daemon、priority...)
jvmtiError GetThreadInfo(jvmtiEnv *env, jthread thread, jvmtiThreadInfo* info_ptr);
// 根据 jthread 获取该线程调用栈
jvmtiError GetStackTrace(jvmtiEnv *env,
jthread thread,
jint start_depth,
jint max_frame_count,
jvmtiFrameInfo *frame_buffer,
jint *count_ptr);

主逻辑大致是:首先调用 GetAllThreads() 获取所有线程的“句柄”jthread,然后遍历根据 jthread 调用 GetThreadInfo() 获取线程信息,按线程名过滤掉不需要的线程后,继续遍历根据 jthread 调用 GetStackTrace() 获取线程的调用栈。

  1. 在 Buffer 中保存每一次的采样结果,最终生成必要的统计数据即可。

按如上步骤即可实现基于 JVMTI 的 CPU Profiler。但需要说明的是,即便是基于原生 JVMTI 接口使用 GetStackTrace() 的方式获取调用栈,也存在与 JMX 相同的问题——只能在安全点(Safe Point)进行采样

SafePoint Bias 问题

基于 Sampling 的 CPU Profiler 通过采集程序在不同时间点的调用栈样本来近似地推算出热点方法,因此,从理论上来讲 Sampling CPU Profiler 必须遵循以下两个原则:

  1. 样本必须足够多。
  2. 程序中所有正在运行的代码点都必须以相同的概率被 Profiler 采样。

如果只能在安全点采样,就违背了第二条原则。因为我们只能采集到位于安全点时刻的调用栈快照,意味着某些代码可能永远没有机会被采样,即使它真实耗费了大量的 CPU 执行时间,这种现象被称为“SafePoint Bias”。

上文我们提到,基于 JMX 与基于 JVMTI 的 Profiler 实现都存在 SafePoint Bias,但一个值得了解的细节是:单独来说,JVMTI 的 GetStackTrace() 函数并不需要在 Caller 的安全点执行,但当调用 GetStackTrace() 获取其他线程的调用栈时,必须等待,直到目标线程进入安全点;而且,GetStackTrace() 仅能通过单独的线程同步定时调用,不能在 UNIX 信号处理器的 Handler 中被异步调用。综合来说,GetStackTrace() 存在与 JMX 一样的 SafePoint Bias。更多安全点相关的知识可以参考《 Safepoints: Meaning, Side Effects and Overheads 》。

那么,如何避免 SafePoint Bias?社区提供了一种 Hack 思路——AsyncGetCallTrace。

基于 JVMTI + AsyncGetCallTrace 实现

如上节所述,假如我们拥有一个函数可以获取当前线程的调用栈且不受安全点干扰,另外它还支持在 UNIX 信号处理器中被异步调用,那么我们只需注册一个 UNIX 信号处理器,在 Handler 中调用该函数获取当前线程的调用栈即可。由于 UNIX 信号会被发送给进程的随机一线程进行处理,因此最终信号会均匀分布在所有线程上,也就均匀获取了所有线程的调用栈样本。

OracleJDK/OpenJDK 内部提供了这么一个函数——AsyncGetCallTrace,它的原型如下:

复制代码
// 栈帧
typedef struct {
jint lineno;
jmethodID method_id;
} AGCT_CallFrame;
// 调用栈
typedef struct {
JNIEnv *env;
jint num_frames;
AGCT_CallFrame *frames;
} AGCT_CallTrace;
// 根据 ucontext 将调用栈填充进 trace 指针
void AsyncGetCallTrace(AGCT_CallTrace *trace, jint depth, void *ucontext);

通过原型可以看到,该函数的使用方式非常简洁,直接通过 ucontext 就能获取到完整的 Java 调用栈。

顾名思义,AsyncGetCallTrace 是“async”的,不受安全点影响,这样的话采样就可能发生在任何时间,包括 Native 代码执行期间、GC 期间等,在这时我们是无法获取 Java 调用栈的,AGCT_CallTrace 的 num_frames 字段正常情况下标识了获取到的调用栈深度,但在如前所述的异常情况下它就表示为负数,最常见的 -2 代表此刻正在 GC

由于 AsyncGetCallTrace 非标准 JVMTI 函数,因此我们无法在 jvmti.h 中找到该函数声明,且由于其目标文件也早已链接进 JVM 二进制文件中,所以无法通过简单的声明来获取该函数的地址,这需要通过一些 Trick 方式来解决。简单说,Agent 最终是作为动态链接库加载到目标 JVM 进程的地址空间中,因此可以在 Agent_OnLoad 内通过 glibc 提供的dlsym()函数拿到当前地址空间(即目标 JVM 进程地址空间)名为“AsyncGetCallTrace”的符号地址。这样就拿到了该函数的指针,按照上述原型进行类型转换后,就可以正常调用了。

通过 AsyncGetCallTrace 实现 CPU Profiler 的大致流程:

  1. 编写 Agent_OnLoad(),在入口拿到 jvmtiEnv 和 AsyncGetCallTrace 指针,获取 AsyncGetCallTrace 方式如下:
复制代码
typedef void (*AsyncGetCallTrace)(AGCT_CallTrace *traces, jint depth, void *ucontext);
// ...
AsyncGetCallTrace agct_ptr = (AsyncGetCallTrace)dlsym(RTLD_DEFAULT, "AsyncGetCallTrace");
if (agct_ptr == NULL) {
void *libjvm = dlopen("libjvm.so", RTLD_NOW);
if (!libjvm) {
// 处理 dlerror()...
}
agct_ptr = (AsyncGetCallTrace)dlsym(libjvm, "AsyncGetCallTrace");
}
  1. 在 OnLoad 阶段,我们还需要做一件事,即注册 OnClassLoad 和 OnClassPrepare 这两个 Hook,原因是 jmethodID 是延迟分配的,使用 AGCT 获取 Traces 依赖预先分配好的数据。我们在 OnClassPrepare 的 CallBack 中尝试获取该 Class 的所有 Methods,这样就使 JVMTI 提前分配了所有方法的 jmethodID,如下所示:
复制代码
void JNICALL OnClassLoad(jvmtiEnv *jvmti, JNIEnv* jni, jthread thread, jclass klass) {}
void JNICALL OnClassPrepare(jvmtiEnv *jvmti, JNIEnv *jni, jthread thread, jclass klass) {
jint method_count;
jmethodID *methods;
jvmti->GetClassMethods(klass, &method_count, &methods);
delete [] methods;
}
// ...
jvmtiEventCallbacks callbacks = {0};
callbacks.ClassLoad = OnClassLoad;
callbacks.ClassPrepare = OnClassPrepare;
jvmti->SetEventCallbacks(&callbacks, sizeof(callbacks));
jvmti->SetEventNotificationMode(JVMTI_ENABLE, JVMTI_EVENT_CLASS_LOAD, NULL);
jvmti->SetEventNotificationMode(JVMTI_ENABLE, JVMTI_EVENT_CLASS_PREPARE, NULL);
  1. 利用 SIGPROF 信号来进行定时采样:
复制代码
// 这里信号 handler 传进来的的 ucontext 即 AsyncGetCallTrace 需要的 ucontext
void signal_handler(int signo, siginfo_t *siginfo, void *ucontext) {
// 使用 AsyncCallTrace 进行采样,注意处理 num_frames 为负的异常情况
}
// ...
// 注册 SIGPROF 信号的 handler
struct sigaction sa;
sigemptyset(&sa.sa_mask);
sa.sa_sigaction = signal_handler;
sa.sa_flags = SA_RESTART | SA_SIGINFO;
sigaction(SIGPROF, &sa, NULL);
// 定时产生 SIGPROF 信号
// interval 是 nanoseconds 表示的采样间隔,AsyncGetCallTrace 相对于同步采样来说可以适当高频一些
long sec = interval / 1000000000;
long usec = (interval % 1000000000) / 1000;
struct itimerval tv = {{sec, usec}, {sec, usec}};
setitimer(ITIMER_PROF, &tv, NULL);
  1. 在 Buffer 中保存每一次的采样结果,最终生成必要的统计数据即可。

按如上步骤即可实现基于 AsyncGetCallTrace 的 CPU Profiler,这是社区中目前性能开销最低、相对效率最高的 CPU Profiler 实现方式,在 Linux 环境下结合 perf_events 还能做到同时采样 Java 栈与 Native 栈,也就能同时分析 Native 代码中存在的性能热点。该方式的典型开源实现有 Async-Profiler Honest-Profiler ,Async-Profiler 实现质量较高,感兴趣的话建议大家阅读参考源码。有趣的是,IntelliJ IDEA 内置的 Java Profiler,其实就是 Async-Profiler 的包装。更多关于 AsyncGetCallTrace 的内容,大家可以参考《 The Pros and Cons of AsyncGetCallTrace Profilers 》。

生成性能火焰图

现在我们拥有了采样调用栈的能力,但是调用栈样本集是以二维数组的数据结构形式存在于内存中的,如何将其转换为可视化的火焰图呢?

火焰图通常是一个 svg 文件,部分优秀项目可以根据文本文件自动生成火焰图文件,仅对文本文件的格式有一定要求。 FlameGraph 项目的核心只是一个 Perl 脚本,可以根据我们提供的调用栈文本生成相应的火焰图 svg 文件。调用栈的文本格式相当简单,如下所示:

复制代码
base_func;func1;func2;func3 10
base_func;funca;funcb 15

将我们采样到的调用栈样本集进行整合后,需输出如上所示的文本格式。每一行代表一“类“调用栈,空格左边是调用栈的方法名排列,以分号分割,左栈底右栈顶,空格右边是该样本出现的次数。

将样本文件交给 flamegraph.pl 脚本执行,就能输出相应的火焰图了:

复制代码
$ flamegraph.pl stacktraces.txt > stacktraces.svg

效果如下图所示:

JVM CPU Profiler技术原理及源码深度解析

通过 flamegraph.pl 生成的火焰图

HotSpot 的 Dynamic Attach 机制解析

到目前为止,我们已经了解了 CPU Profiler 完整的工作原理,然而使用过 JProfiler/Arthas 的同学可能会有疑问,很多情况下可以直接对线上运行中的服务进行 Profling,并不需要在 Java 进程的启动参数添加 Agent 参数,这是通过什么手段做到的?答案是Dynamic Attach

JDK 在 1.6 以后提供了 Attach API,允许向运行中的 JVM 进程添加 Agent,这项手段被广泛使用在各种 Profiler 和字节码增强工具中,其官方简介如下:

This is a Sun extension that allows a tool to ‘attach’ to another process running Java code and launch a JVM TI agent or a java.lang.instrument agent in that process.

总的来说,Dynamic Attach 是 HotSpot 提供的一种特殊能力,它允许一个进程向另一个运行中的 JVM 进程发送一些命令并执行,命令并不限于加载 Agent,还包括 Dump 内存、Dump 线程等等。

通过 sun.tools 进行 Attach

Attach 虽然是 HotSpot 提供的能力,但 JDK 在 Java 层面也对其做了封装。

前文已经提到,对于 Java Agent 来说,PreMain 方法在 Agent 作为启动参数运行的时候执行,其实我们还可以额外实现一个 AgentMain 方法,并在 MANIFEST.MF 中将Agent-Class指定为该 Class:

复制代码
public static void agentmain(String args, Instrumentation ins) {
// implement
}

这样打包出来的 jar,既可以作为 -javaagent 参数启动,也可以被 Attach 到运行中的目标 JVM 进程。JDK 已经封装了简单的 API 让我们直接 Attach 一个 Java Agent,下面以 Arthas 中的代码进行演示:

复制代码
// com/taobao/arthas/core/Arthas.java
import com.sun.tools.attach.VirtualMachine;
import com.sun.tools.attach.VirtualMachineDescriptor;
// ...
private void attachAgent(Configure configure) throws Exception {
VirtualMachineDescriptor virtualMachineDescriptor = null;
// 拿到所有 JVM 进程,找出目标进程
for (VirtualMachineDescriptor descriptor : VirtualMachine.list()) {
String pid = descriptor.id();
if (pid.equals(Integer.toString(configure.getJavaPid()))) {
virtualMachineDescriptor = descriptor;
}
}
VirtualMachine virtualMachine = null;
try {
// 针对某个 JVM 进程调用 VirtualMachine.attach() 方法,拿到 VirtualMachine 实例
if (null == virtualMachineDescriptor) {
virtualMachine = VirtualMachine.attach("" + configure.getJavaPid());
} else {
virtualMachine = VirtualMachine.attach(virtualMachineDescriptor);
}
// ...
// 调用 VirtualMachine#loadAgent(),将 arthasAgentPath 指定的 jar attach 到目标 JVM 进程中
// 第二个参数为 attach 参数,即 agentmain 的首个 String 参数 args
virtualMachine.loadAgent(arthasAgentPath, configure.getArthasCore() + ";" + configure.toString());
} finally {
if (null != virtualMachine) {
// 调用 VirtualMachine#detach() 释放
virtualMachine.detach();
}
}
}

直接对 HotSpot 进行 Attach

sun.tools 封装的 API 足够简单易用,但只能使用 Java 编写,也只能用在 Java Agent 上,因此有些时候我们必须手工对 JVM 进程直接进行 Attach。对于 JVMTI,除了 Agent_OnLoad() 之外,我们还需实现一个 Agent_OnAttach() 函数,当将 JVMTI Agent Attach 到目标进程时,从该函数开始执行:

复制代码
// $JAVA_HOME/include/jvmti.h
JNIEXPORT jint JNICALL Agent_OnAttach(JavaVM *vm, char *options, void *reserved);

下面我们以 Async-Profiler 中的 jattach 源码为线索,探究一下如何利用 Attach 机制给运行中的 JVM 进程发送命令。jattach 是 Async-Profiler 提供的一个 Driver,使用方式比较直观:

复制代码
Usage:
jattach <pid> <cmd> [args ...]
Args:
<pid> 目标 JVM 进程的进程 ID
<cmd> 要执行的命令
<args> 命令参数

使用方式如:

复制代码
$ jattach 1234 load /absolute/path/to/agent/libagent.so true

执行上述命令,libagent.so 就被加载到 ID 为 1234 的 JVM 进程中并开始执行 Agent_OnAttach 函数了。有一点需要注意,执行 Attach 的进程 euid 及 egid,与被 Attach 的目标 JVM 进程必须相同。接下来开始分析 jattach 源码。

如下所示的 Main 函数描述了一次 Attach 的整体流程:

复制代码
// async-profiler/src/jattach/jattach.c
int main(int argc, char** argv) {
// 解析命令行参数
// 检查 euid 与 egid
// ...
if (!check_socket(nspid) && !start_attach_mechanism(pid, nspid)) {
perror("Could not start attach mechanism");
return 1;
}
int fd = connect_socket(nspid);
if (fd == -1) {
perror("Could not connect to socket");
return 1;
}
printf("Connected to remote JVM\n");
if (!write_command(fd, argc - 2, argv + 2)) {
perror("Error writing to socket");
close(fd);
return 1;
}
printf("Response code = ");
fflush(stdout);
int result = read_response(fd);
close(fd);
return result;
}

忽略掉命令行参数解析与检查 euid 和 egid 的过程。jattach 首先调用了 check_socket 函数进行了“socket 检查?”,check_socket 源码如下:

复制代码
// async-profiler/src/jattach/jattach.c
// Check if remote JVM has already opened socket for Dynamic Attach
static int check_socket(int pid) {
char path[MAX_PATH];
snprintf(path, MAX_PATH, "%s/.java_pid%d", get_temp_directory(), pid); // get_temp_directory() 在 Linux 下固定返回 "/tmp"
struct stat stats;
return stat(path, &stats) == 0 && S_ISSOCK(stats.st_mode);
}

我们知道,UNIX 操作系统提供了一种基于文件的 Socket 接口,称为“UNIX Socket”(一种常用的进程间通信方式)。在该函数中使用 S_ISSOCK 宏来判断该文件是否被绑定到了 UNIX Socket,如此看来,“/tmp/.java_pid<pid>

”文件很有可能就是外部进程与 JVM 进程间通信的桥梁。

查阅官方文档,得到如下描述:

The attach listener thread then communicates with the source JVM in an OS dependent manner:

  • On Solaris, the Doors IPC mechanism is used. The door is attached to a file in the file system so that clients can access it.
  • On Linux, a Unix domain socket is used. This socket is bound to a file in the filesystem so that clients can access it.
  • On Windows, the created thread is given the name of a pipe which is served by the client. The result of the operations are written to this pipe by the target JVM.

证明了我们的猜想是正确的。目前为止 check_socket 函数的作用很容易理解了:判断外部进程与目标 JVM 进程之间是否已经建立了 UNIX Socket 连接

回到 Main 函数,在使用 check_socket 确定连接尚未建立后,紧接着调用 start_attach_mechanism 函数,函数名很直观地描述了它的作用,源码如下:

复制代码
// async-profiler/src/jattach/jattach.c
// Force remote JVM to start Attach listener.
// HotSpot will start Attach listener in response to SIGQUIT if it sees .attach_pid file
static int start_attach_mechanism(int pid, int nspid) {
char path[MAX_PATH];
snprintf(path, MAX_PATH, "/proc/%d/cwd/.attach_pid%d", nspid, nspid);
int fd = creat(path, 0660);
if (fd == -1 || (close(fd) == 0 && !check_file_owner(path))) {
// Failed to create attach trigger in current directory. Retry in /tmp
snprintf(path, MAX_PATH, "%s/.attach_pid%d", get_temp_directory(), nspid);
fd = creat(path, 0660);
if (fd == -1) {
return 0;
}
close(fd);
}
// We have to still use the host namespace pid here for the kill() call
kill(pid, SIGQUIT);
// Start with 20 ms sleep and increment delay each iteration
struct timespec ts = {0, 20000000};
int result;
do {
nanosleep(&ts, NULL);
result = check_socket(nspid);
} while (!result && (ts.tv_nsec += 20000000) < 300000000);
unlink(path);
return result;
}

start_attach_mechanism 函数首先创建了一个名为“/tmp/.attach_pid<pid>”的空文件,然后向目标 JVM 进程发送了一个SIGQUIT信号,这个信号似乎触发了 JVM 的某种机制?紧接着,start_attach_mechanism 函数开始陷入了一种等待,每 20ms 调用一次 check_socket 函数检查连接是否被建立,如果等了 300ms 还没有成功就放弃。函数的最后调用 Unlink 删掉.attach_pid 文件并返回。

如此看来,HotSpot 似乎提供了一种特殊的机制,只要给它发送一个 SIGQUIT 信号,并预先准备好.attach_pid 文件,HotSpot 会主动创建一个地址为“/tmp/.java_pid”的 UNIX Socket,接下来主动 Connect 这个地址即可建立连接执行命令。

查阅文档,得到如下描述:

Dynamic attach has an attach listener thread in the target JVM. This is a thread that is started when the first attach request occurs. On Linux and Solaris, the client creates a file named .attach_pid(pid) and sends a SIGQUIT to the target JVM process. The existence of this file causes the SIGQUIT handler in HotSpot to start the attach listener thread. On Windows, the client uses the Win32 CreateRemoteThread function to create a new thread in the target process.

这样一来就很明确了,在 Linux 上我们只需创建一个“/tmp/.attach_pid”文件,并向目标 JVM 进程发送一个 SIGQUIT 信号,HotSpot 就会开始监听“/tmp/.java_pid”地址上的 UNIX Socket,接收并执行相关 Attach 的命令*。至于为什么一定要创建.attach_pid 文件才可以触发 Attach Listener 的创建,经查阅资料,我们得到了两种说法:一是 JVM 不止接收从外部 Attach 进程发送的 SIGQUIT 信号,必须配合外部进程创建的外部文件才能确定这是一次 Attach 请求;二是为了安全。

继续看 jattach 的源码,果不其然,它调用了 connect_socket 函数对“/tmp/.java_pid”进行连接,connect_socket 源码如下:

复制代码
// async-profiler/src/jattach/jattach.c
// Connect to UNIX domain socket created by JVM for Dynamic Attach
static int connect_socket(int pid) {
int fd = socket(PF_UNIX, SOCK_STREAM, 0);
if (fd == -1) {
return -1;
}
struct sockaddr_un addr;
addr.sun_family = AF_UNIX;
snprintf(addr.sun_path, sizeof(addr.sun_path), "%s/.java_pid%d", get_temp_directory(), pid);
if (connect(fd, (struct sockaddr*)&addr, sizeof(addr)) == -1) {
close(fd);
return -1;
}
return fd;
}

一个很普通的 Socket 创建函数,返回 Socket 文件描述符。

回到 Main 函数,主流程紧接着调用 write_command 函数向该 Socket 写入了从命令行传进来的参数,并且调用 read_response 函数接收从目标 JVM 进程返回的数据。两个很常见的 Socket 读写函数,源码如下:

复制代码
// async-profiler/src/jattach/jattach.c
// Send command with arguments to socket
static int write_command(int fd, int argc, char** argv) {
// Protocol version
if (write(fd, "1", 2) <= 0) {
return 0;
}
int i;
for (i = 0; i < 4; i++) {
const char* arg = i < argc ? argv[i] : "";
if (write(fd, arg, strlen(arg) + 1) <= 0) {
return 0;
}
}
return 1;
}
// Mirror response from remote JVM to stdout
static int read_response(int fd) {
char buf[8192];
ssize_t bytes = read(fd, buf, sizeof(buf) - 1);
if (bytes <= 0) {
perror("Error reading response");
return 1;
}
// First line of response is the command result code
buf[bytes] = 0;
int result = atoi(buf);
do {
fwrite(buf, 1, bytes, stdout);
bytes = read(fd, buf, sizeof(buf));
} while (bytes > 0);
return result;
}

浏览 write_command 函数就可知外部进程与目标 JVM 进程之间发送的数据格式相当简单,基本如下所示:

复制代码
<PROTOCOL VERSION>\0<COMMAND>\0<ARG1>\0<ARG2>\0<ARG3>\0

以先前我们使用的 Load 命令为例,发送给 HotSpot 时格式如下:

复制代码
1\0load\0/absolute/path/to/agent/libagent.so\0true\0\0

至此,我们已经了解了如何手工对 JVM 进程直接进行 Attach。

Attach 补充介绍

Load 命令仅仅是 HotSpot 所支持的诸多命令中的一种,用于动态加载基于 JVMTI 的 Agent,完整的命令表如下所示:

复制代码
static AttachOperationFunctionInfo funcs[] = {
{ "agentProperties", get_agent_properties },
{ "datadump", data_dump },
{ "dumpheap", dump_heap },
{ "load", JvmtiExport::load_agent_library },
{ "properties", get_system_properties },
{ "threaddump", thread_dump },
{ "inspectheap", heap_inspection },
{ "setflag", set_flag },
{ "printflag", print_flag },
{ "jcmd", jcmd },
{ NULL, NULL }
};

读者可以尝试下 threaddump 命令,然后对相同的进程进行 jstack,对比观察输出,其实是完全相同的,其它命令大家可以自行进行探索。

总结

总的来说,善用各类 Profiler 是提升性能优化效率的一把利器,了解 Profiler 本身的实现原理更能帮助我们避免对工具的各种误用。CPU Profiler 所依赖的 Attach、JVMTI、Instrumentation、JMX 等皆是 JVM 平台比较通用的技术,在此基础上,我们去实现 Memory Profiler、Thread Profiler、GC Analyzer 等工具也没有想象中那么神秘和复杂了。

参考资料

作者介绍

业祥、继东,美团基础架构部 / 服务框架组工程师。

本文转载自公众号美团技术团队(ID:meituantech)

原文链接

https://mp.weixin.qq.com/s?__biz=MjM5NjQ5MTI5OA==&mid=2651750821&idx=1&sn=3876eb1ea3963d568a35235a72550e62&chksm=bd1258e88a65d1fed4fc4248398af17537281ca11f90a5808bcb9e2079d0272f3d59cd659c94&scene=27#wechat_redirect

评论

发布