什么是 WhiteBox API

WhiteBox API 是 HotSpot VM 自带的白盒测试工具，将内部的很多核心机制的 API 暴露出来，用于白盒测试 JVM，压测 JVM 特性，以及辅助学习理解 JVM 并调优参数。WhiteBox API 是 Java 7 引入的，目前 Java 8 LTS 以及 Java 11 LTS（其实是 Java 9+ 以后的所有版本，这里只关心 LTS 版本，Java 9 引入了模块化所以 WhiteBox API 有所变化）都是有的。但是默认这个 API 并没有编译在 JDK 之中，但是他的实现是编译在了 JDK 里面了。所以如果想用这个 API，需要用户自己编译需要的 API，并加入 Java 的 BootClassPath 并启用 WhiteBox API。

WhiteBox API 如何实现的

WhiteBox API 是一个 Java 类，位于 JDK 的测试包中，默认没有编译进标准发行版的 JDK 中。

test/lib/sun/hotspot/WhiteBox.java

1package sun.hotspot;
2public class WhiteBox {
3  //仅举两个例子，省略其他 api 以及代码
4  // Force Young GC
5  public native void youngGC();
6  // Force Full GC
7  public native void fullGC();
8}

可以看出，其实里面的所有 API 都是 JNI 调用，具体实现是：

src/hotspot/share/prims/whitebox.cpp

1WB_ENTRY(void, WB_FullGC(JNIEnv* env, jobject o))
2  Universe::heap()->soft_ref_policy()->set_should_clear_all_soft_refs(true);
3  Universe::heap()->collect(GCCause::_wb_full_gc);
4#if INCLUDE_G1GC
5  if (UseG1GC) {
6    // Needs to be cleared explicitly for G1
7    Universe::heap()->soft_ref_policy()->set_should_clear_all_soft_refs(false);
8  }
9#endif // INCLUDE_G1GC
10WB_END
11
12WB_ENTRY(void, WB_YoungGC(JNIEnv* env, jobject o))
13  Universe::heap()->collect(GCCause::_wb_young_gc);
14WB_END
15
16{CC"youngGC",  CC"()V",                             (void*)&WB_YoungGC },
17{CC"fullGC",   CC"()V",                             (void*)&WB_FullGC },
18
19//省略其他代码

可以看出，JNI 调用实现直接调用了底层 JVM 的相关接口，相当于把 JVM 的一些关键机制暴露出来，用于白盒测试。但是如之前所说，JDK 发行版没有包括 test 下的测试代码，也就是 WhiteBox API 所在的 jar 包并没有打进默认的 JDK 中。这就需要我们自己编译一下这个代码。

什么是 BootClassPath

Java 内有三种不同的类加载器：应用类加载器（application classloader），扩展类加载器（extension classloader）还有根类加载器（bootstrap classloader）

应用类加载器，加载我们classpath目录下的所有类文件
扩展类加载器，加载标准 Java 类库扩展的类，就是你的jre目录下的/lib/ext目录下的所有类
根类加载器（bootstrap classloader），扫描 BootClassPath 下的标准 Java 类库的类加载器。标准 Java 类库限制了一些包路径的类，必须通过根类加载器加载。

对于 WhiteBox API，由于是他的包为sun.hotspot，普通的类加载器是不能加载这个包路径的类的，需要通过根类加载器加载。

怎么指定 BootClassPath

在 Java 8，通过 -Xbootclasspath: 或者 -Xbootclasspath/p:指定，例如：

1-Xbootclasspath:/home/project/whitebox.jar
2-Xbootclasspath/p:/home/project/whitebox.jar

在 Java 9 之后的版本，这两个参数已经过期了，需要改成-Xbootclasspath/a:，例如：

-Xbootclasspath/a:/home/project/whitebox.jar

否则会报错-Xbootclasspath is no longer a supported option.

这里对应的 JDK 源码是： src/hotspot/share/runtime/arguments.cpp

1// -bootclasspath:
2} else if (match_option(option, "-Xbootclasspath:", &tail)) {
3    jio_fprintf(defaultStream::output_stream(),
4      "-Xbootclasspath is no longer a supported option.\n");
5    return JNI_EINVAL;
6// -bootclasspath/a:
7} else if (match_option(option, "-Xbootclasspath/a:", &tail)) {
8  //将参数添加到 bootclasspath 中
9  Arguments::append_sysclasspath(tail);
10// -bootclasspath/p:
11} else if (match_option(option, "-Xbootclasspath/p:", &tail)) {
12    jio_fprintf(defaultStream::output_stream(),
13      "-Xbootclasspath/p is no longer a supported option.\n");
14    return JNI_EINVAL;
15}

使用 WhiteBox API

1. 编译 WhiteBox API

将https://github.com/openjdk/jdk/tree/master/test/lib路径下的sun目录取出，编译成一个 jar 包，名字假设是 whitebox.jar

2. 编写测试程序

将 whitebox.jar 添加到你的项目依赖，之后写代码

1public static void main(String[] args) throws Exception {
2        WhiteBox whiteBox = WhiteBox.getWhiteBox();
3        //获取 ReservedCodeCacheSize 这个 JVM flag 的值
4        Long reservedCodeCacheSize = whiteBox.getUintxVMFlag("ReservedCodeCacheSize");
5        System.out.println(reservedCodeCacheSize);
6        //打印堆内存各项指标
7        whiteBox.printHeapSizes();
8        //执行full GC
9        whiteBox.fullGC();
10        
11        //保持进程不退出，保证日志打印完整
12        Thread.currentThread().join();
13}

3. 启动程序查看效果

使用启动参数 -Xbootclasspath/a:/home/project/whitebox.jar -XX:+UnlockDiagnosticVMOptions -XX:+WhiteBoxAPI -Xlog:gc 启动程序。其中前三个 Flag 表示启用 WhiteBox API，最后一个表示打印 GC info 级别的日志到控制台。

我的输出：

1[0.025s][info][gc] Using G1
2251658240
3Minimum heap 8388608 Initial heap 268435456 Maximum heap 4276092928 Space alignment 2097152 Heap alignment 2097152
4[0.899s][info][gc] GC(0) Pause Full (WhiteBox Initiated Full GC) 5M->0M(20M) 45.183ms

WhiteBox API 的使用场景

JDK 框架源码在测试的时候，需要用 WhiteBox API 进行测试
压测 JVM 的时候，需要模拟一些场景，需要用 WhiteBox API 执行一些底层操作，例如强制 full GC。比较有名的就是 jcstress 对 JVM 进行压测就用到了 WhiteBox API
一些性能极限场景，需要用到 WhiteAPI 进行模拟，压测
学习 JVM 原理的时候会用到。

最后，在我的系列专栏通过 JFR 与日志深入探索 JVM中，也会经常用到 WhiteBox API 模拟各种 JFR 事件，帮助大家更好的理解 JVM 底层原理和性能瓶颈定位，JVM 调优等等，欢迎大家订阅关注~

JVM 相关