🍒 11134 - Abort bootstrap JDK tool tests

dd-java-agent/src/main/java/datadog/trace/bootstrap/AgentBootstrap.java

@@ -216,41 +216,74 @@ private static boolean alreadyInitialized() {
     return false;
   }
 
+  /**
+   * Returns {@code true} if the JVM is running a JDK diagnostic/development tool rather than a user
+   * application, in which case the agent should abort early.
+   *
+   * <p><b>How to discover new entries when a tool is missed:</b>
+   *
+   * <ol>
+   *   <li>Build a minimal javaagent JAR whose {@code premain} prints {@code
+   *       System.getProperty("jdk.module.main")} and {@code System.getProperty("sun.java.command")}
+   *       then calls {@code System.exit(0)}.
+   *   <li>For <b>JDK 9+ tools</b>, inject it via {@code JAVA_TOOL_OPTIONS}:
+   *       <pre>JAVA_TOOL_OPTIONS="-javaagent:/path/to/agent.jar" $JAVA_HOME/bin/&lt;tool&gt;</pre>
+   *       The value of {@code jdk.module.main} is the module name to add to the first switch.
+   *   <li>For <b>JDK 8 tools</b> (or non-modular IBM/OpenJ9 tools), inject the same way; the value
+   *       of {@code sun.java.command} (up to the first space) is the main-class name to add to the
+   *       second switch.
+   * </ol>
+   *
+   * <p>Native binaries (e.g. {@code jitserver}, {@code asprof}) report both properties as {@code
+   * null} and are automatically ignored — no switch entry needed for them.
+   */
   static boolean isJdkTool() {
     String moduleMain = SystemProperties.get("jdk.module.main");
-    if (null != moduleMain && !moduleMain.isEmpty() && moduleMain.charAt(0) == 'j') {
-      switch (moduleMain) {
-        case "java.base": // keytool
-        case "java.corba":
-        case "java.desktop":
-        case "java.rmi":
-        case "java.scripting":
-        case "java.security.jgss":
-        case "jdk.aot":
-        case "jdk.compiler":
-        case "jdk.dev":
-        case "jdk.hotspot.agent":
-        case "jdk.httpserver":
-        case "jdk.jartool":
-        case "jdk.javadoc":
-        case "jdk.jcmd":
-        case "jdk.jconsole":
-        case "jdk.jdeps":
-        case "jdk.jdi":
-        case "jdk.jfr":
-        case "jdk.jlink":
-        case "jdk.jpackage":
-        case "jdk.jshell":
-        case "jdk.jstatd":
-        case "jdk.jvmstat.rmi":
-        case "jdk.pack":
-        case "jdk.pack200":
-        case "jdk.policytool":
-        case "jdk.rmic":
-        case "jdk.scripting.nashorn.shell":
-        case "jdk.xml.bind":
-        case "jdk.xml.ws":
-          return true;
+    if (null != moduleMain && !moduleMain.isEmpty()) {
+      char firstChar = moduleMain.charAt(0);
+      if (firstChar == 'j') {
+        // Standard JDK 9+ module-based tools (module names start with 'java.' or 'jdk.')
+        switch (moduleMain) {
+          case "java.base": // keytool
+          case "java.corba":
+          case "java.desktop":
+          case "java.rmi":
+          case "java.scripting":
+          case "java.security.jgss":
+          case "jdk.aot":
+          case "jdk.compiler":
+          case "jdk.dev":
+          case "jdk.hotspot.agent":
+          case "jdk.httpserver":
+          case "jdk.jartool":
+          case "jdk.javadoc":
+          case "jdk.jcmd":
+          case "jdk.jconsole":
+          case "jdk.jdeps":
+          case "jdk.jdi":
+          case "jdk.jfr":
+          case "jdk.jlink":
+          case "jdk.jpackage":
+          case "jdk.jshell":
+          case "jdk.jstatd":
+          case "jdk.jvmstat.rmi":
+          case "jdk.pack":
+          case "jdk.pack200":
+          case "jdk.policytool":
+          case "jdk.rmic":
+          case "jdk.scripting.nashorn.shell":
+          case "jdk.xml.bind":
+          case "jdk.xml.ws":
+            return true;
+        }
+      } else if (firstChar == 'o') {
+        // OpenJ9 / Semeru 11+ module-based tools (module names start with 'openj9.')
+        switch (moduleMain) {
+          case "openj9.dtfj": // jextract, jpackcore
+          case "openj9.dtfjview": // jdmpview
+          case "openj9.traceformat": // traceformat
+            return true;
+        }
       }
     }
     // Handles JDK 8 tools (IBM J9 and standard JDK 8 vendors)
@@ -267,9 +300,18 @@ static boolean isJdkTool() {
         case "com.ibm.security.krb5.internal.tools.Klist": // klist
         case "com.ibm.security.krb5.internal.tools.Ktab": // ktab
         case "com.ibm.jvm.dtfjview.DTFJView": // jdmpview
+        case "com.ibm.jvm.j9.dump.extract.Main": // jextract
+        case "com.ibm.gsk.ikeyman.Ikeyman": // ikeyman
         case "com.ibm.gsk.ikeyman.ikeycmd": // ikeycmd
         case "com.ibm.CosNaming.TransientNameServer": // tnameserv
         case "com.ibm.idl.toJavaPortable.Compile": // idlj
+        // OpenJ9 / Semeru 8 specific tool main classes (OpenJ9 reimplementation of HotSpot tools)
+        case "openj9.tools.attach.diagnostics.tools.Jcmd": // jcmd
+        case "openj9.tools.attach.diagnostics.tools.Jps": // jps
+        case "openj9.tools.attach.diagnostics.tools.Jstat": // jstat
+        case "openj9.tools.attach.diagnostics.tools.Jmap": // jmap
+        case "openj9.tools.attach.diagnostics.tools.Jstack": // jstack
+        case "com.ibm.jvm.TraceFormat": // traceformat
         // Standard JDK 8 tool main classes (shared by IBM J9 and Oracle/OpenJDK 8)
         case "sun.tools.jar.Main": // jar
         case "com.sun.tools.javac.Main": // javac
@@ -292,6 +334,7 @@ static boolean isJdkTool() {
         case "com.sun.tools.internal.xjc.Driver": // xjc
         case "com.sun.tools.internal.jxc.SchemaGenerator": // schemagen
         case "com.sun.tools.script.shell.Main": // jrunscript
+        case "jdk.nashorn.tools.Shell": // jjs (Nashorn JS shell, JDK 8)
         case "sun.tools.jconsole.JConsole": // jconsole
         case "sun.applet.Main": // appletviewer
         case "com.sun.corba.se.impl.naming.cosnaming.TransientNameServer": // tnameserv
@@ -310,6 +353,8 @@ static boolean isJdkTool() {
         case "jdk.jfr.internal.tool.Main": // jfr, backported to OpenJDK 8 in 8u262 (JEP 328
         // backport, July 2020)
         case "sun.jvm.hotspot.jdi.SADebugServer": // jsadebugd
+        case "sun.jvm.hotspot.HSDB": // hsdb (HotSpot SA GUI debugger, JDK 8)
+        case "sun.jvm.hotspot.CLHSDB": // clhsdb (HotSpot SA command-line debugger, JDK 8)
           return true;
       }
     }

dd-java-agent/src/test/java/datadog/trace/bootstrap/AgentBootstrapAbortOnJdkToolTest.java

@@ -0,0 +1,149 @@
+package datadog.trace.bootstrap;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+class AgentBootstrapAbortOnJdkToolTest {
+
+  private String savedModuleMain;
+  private String savedJavaCommand;
+
+  @BeforeEach
+  void saveAndClearProperties() {
+    savedModuleMain = System.clearProperty("jdk.module.main");
+    savedJavaCommand = System.clearProperty("sun.java.command");
+  }
+
+  @AfterEach
+  void restoreProperties() {
+    restoreProperty("jdk.module.main", savedModuleMain);
+    restoreProperty("sun.java.command", savedJavaCommand);
+  }
+
+  private static void restoreProperty(String key, String previousValue) {
+    if (previousValue == null) {
+      System.clearProperty(key);
+    } else {
+      System.setProperty(key, previousValue);
+    }
+  }
+
+  @Test
+  void notAJdkToolWhenNoPropertiesSet() {
+    assertFalse(AgentBootstrap.isJdkTool());
+  }
+
+  @Test
+  void notAJdkToolWhenCommandIsNotAKnownTool() {
+    System.setProperty("sun.java.command", "com.example.MyApplication");
+    assertFalse(AgentBootstrap.isJdkTool());
+  }
+
+  @Test
+  void notAJdkToolWhenModuleMainIsNotAKnownTool() {
+    System.setProperty("jdk.module.main", "com.example.myapp");
+    assertFalse(AgentBootstrap.isJdkTool());
+  }
+
+  @ParameterizedTest
+  @ValueSource(
+      strings = {
+        // Standard JDK 9+ module-based tools
+        "java.base", // keytool
+        "jdk.compiler", // javac
+        "jdk.jartool", // jar
+        "jdk.javadoc", // javadoc
+        "jdk.jcmd", // jcmd
+        "jdk.jconsole", // jconsole
+        "jdk.jshell", // jshell
+        "jdk.jfr", // jfr (JDK 9+)
+        // OpenJ9 / Semeru 11+ module-based tools
+        "openj9.dtfj", // jextract, jpackcore
+        "openj9.dtfjview", // jdmpview
+        "openj9.traceformat", // traceformat
+      })
+  void isJdkToolByModuleMain(String moduleMain) {
+    System.setProperty("jdk.module.main", moduleMain);
+    assertTrue(AgentBootstrap.isJdkTool());
+  }
+
+  @ParameterizedTest
+  @ValueSource(
+      strings = {
+        // IBM J9 JDK 8 specific tool main classes
+        "com.ibm.crypto.tools.KeyTool", // keytool
+        "com.ibm.security.krb5.internal.tools.Kinit", // kinit
+        "com.ibm.security.krb5.internal.tools.Klist", // klist
+        "com.ibm.security.krb5.internal.tools.Ktab", // ktab
+        "com.ibm.jvm.dtfjview.DTFJView", // jdmpview
+        "com.ibm.jvm.j9.dump.extract.Main", // jextract
+        "com.ibm.gsk.ikeyman.Ikeyman", // ikeyman
+        "com.ibm.gsk.ikeyman.ikeycmd", // ikeycmd
+        "com.ibm.CosNaming.TransientNameServer", // tnameserv
+        "com.ibm.idl.toJavaPortable.Compile", // idlj
+        // OpenJ9 / Semeru 8 specific tool main classes (OpenJ9 reimplementation of HotSpot tools)
+        "openj9.tools.attach.diagnostics.tools.Jcmd", // jcmd
+        "openj9.tools.attach.diagnostics.tools.Jps", // jps
+        "openj9.tools.attach.diagnostics.tools.Jstat", // jstat
+        "openj9.tools.attach.diagnostics.tools.Jmap", // jmap
+        "openj9.tools.attach.diagnostics.tools.Jstack", // jstack
+        "com.ibm.jvm.TraceFormat", // traceformat
+        // Standard JDK 8 tool main classes (Corretto 8 / OpenJDK 8)
+        "sun.tools.jar.Main", // jar
+        "com.sun.tools.javac.Main", // javac
+        "com.sun.tools.javadoc.Main", // javadoc
+        "com.sun.tools.javap.Main", // javap
+        "com.sun.tools.javah.Main", // javah
+        "sun.security.tools.keytool.Main", // keytool
+        "sun.security.tools.jarsigner.Main", // jarsigner
+        "sun.security.tools.policytool.PolicyTool", // policytool
+        "com.sun.tools.example.debug.tty.TTY", // jdb
+        "com.sun.tools.jdeps.Main", // jdeps
+        "sun.rmi.rmic.Main", // rmic
+        "sun.rmi.registry.RegistryImpl", // rmiregistry
+        "sun.rmi.server.Activation", // rmid
+        "com.sun.tools.extcheck.Main", // extcheck
+        "sun.tools.serialver.SerialVer", // serialver
+        "sun.tools.native2ascii.Main", // native2ascii
+        "com.sun.tools.internal.ws.WsGen", // wsgen
+        "com.sun.tools.internal.ws.WsImport", // wsimport
+        "com.sun.tools.internal.xjc.Driver", // xjc
+        "com.sun.tools.internal.jxc.SchemaGenerator", // schemagen
+        "com.sun.tools.script.shell.Main", // jrunscript
+        "sun.tools.jconsole.JConsole", // jconsole
+        "sun.applet.Main", // appletviewer
+        "com.sun.corba.se.impl.naming.cosnaming.TransientNameServer", // tnameserv
+        "com.sun.tools.corba.se.idl.toJavaPortable.Compile", // idlj
+        "com.sun.corba.se.impl.activation.ORBD", // orbd
+        "com.sun.corba.se.impl.activation.ServerTool", // servertool
+        "sun.tools.jps.Jps", // jps
+        "sun.tools.jstack.JStack", // jstack
+        "sun.tools.jmap.JMap", // jmap
+        "sun.tools.jinfo.JInfo", // jinfo
+        "com.sun.tools.hat.Main", // jhat
+        "sun.tools.jstat.Jstat", // jstat
+        "sun.tools.jstatd.Jstatd", // jstatd
+        "sun.tools.jcmd.JCmd", // jcmd
+        "jdk.jfr.internal.tool.Main", // jfr (OpenJDK 8u262+ backport)
+        "sun.jvm.hotspot.jdi.SADebugServer", // jsadebugd
+        "jdk.nashorn.tools.Shell", // jjs (Nashorn JS shell, JDK 8)
+        "sun.jvm.hotspot.HSDB", // hsdb (HotSpot SA GUI debugger, JDK 8)
+        "sun.jvm.hotspot.CLHSDB", // clhsdb (HotSpot SA command-line debugger, JDK 8)
+      })
+  void isJdkToolByCommand(String mainClass) {
+    System.setProperty("sun.java.command", mainClass);
+    assertTrue(AgentBootstrap.isJdkTool());
+  }
+
+  @Test
+  void isJdkToolWhenCommandIncludesArguments() {
+    System.setProperty("sun.java.command", "com.ibm.crypto.tools.KeyTool -list -v");
+    assertTrue(AgentBootstrap.isJdkTool());
+  }
+}

dd-smoke-tests/jdk-tool-abort/build.gradle

@@ -0,0 +1,6 @@
+apply from: "$rootDir/gradle/java.gradle"
+description = 'JDK Tool Abort Smoke Tests'
+
+dependencies {
+  testImplementation project(':dd-smoke-tests')
+}