Last touches to the premain PR

Author: vjovanov

substratevm/CHANGELOG.md

@@ -3,7 +3,8 @@
 This changelog summarizes major changes to GraalVM Native Image.
 
 ## GraalVM for JDK 24 (Internal Version 24.2.0)
-* Together with Alibaba, we added java agent support for native image as experimental feature. 
+* (GR-55708) (Alibaba contribution) Support for running premain of java agents at runtime as an experimental feature. At build time, `-H:PremainClasses= option` is used to set the premain classes.
+At runtime, premain runtime options are set along with main class' arguments in the format of `-XX-premain:[class]:[options]`.
 * (GR-54476): Issue a deprecation warning on first use of a legacy `graal.` prefix (see GR-49960 in [Compiler changelog](../compiler/CHANGELOG.md)).
   The warning is planned to be replaced by an error in GraalVM for JDK 25.
 * (GR-48384) Added a GDB Python script (`gdb-debughelpers.py`) to improve the Native Image debugging experience.
@@ -96,7 +97,7 @@ This changelog summarizes major changes to GraalVM Native Image.
 * (GR-42467) The search path for `System.loadLibrary()` by default includes the directory containing the native image.
 * (GR-44216) Native Image is now shipped as part of the GraalVM JDK and thus no longer needs to be installed via `gu install native-image`.
 * (GR-44105) A warning is displayed when trying to generate debug info on macOS since that is not supported. It is now an error to use `-H:+StripDebugInfo` on macOS or `-H:-StripDebugInfo` on Windows since those values are not supported.
-* (GR-43966) Remove analysis options -H:AnalysisStatisticsFile and -H:ImageBuildStatisticsFile. Output files are now written to fixed subdirectories relative to image location (reports/image_build_statistics.json). 
+* (GR-43966) Remove analysis options -H:AnalysisStatisticsFile and -H:ImageBuildStatisticsFile. Output files are now written to fixed subdirectories relative to image location (reports/image_build_statistics.json).
 * (GR-38414) BellSoft implemented the `MemoryPoolMXBean` for the serial and epsilon GCs.
 * (GR-40641) Dynamic linking of AWT libraries on Linux.
 * (GR-40463) Red Hat added experimental support for JMX, which can be enabled with the `--enable-monitoring` option (e.g. `--enable-monitoring=jmxclient,jmxserver`).

substratevm/ci/ci.jsonnet

@@ -122,7 +122,7 @@
       // but since we support JDK 21 anyways, there is not good reason to do so.
       "linux:amd64:jdk21": gate + t("30:00"),
     }),
-    "basics": mxgate("build,helloworld,native_unittests,truffle_unittests,debuginfotest,hellomodule") + maven + jsonschema + platform_spec(no_jobs) + platform_spec({
+    "basics": mxgate("build,helloworld,native_unittests,truffle_unittests,debuginfotest,hellomodule,java_agent") + maven + jsonschema + platform_spec(no_jobs) + platform_spec({
       "linux:amd64:jdk-latest": gate + gdb("10.2") + t("55:00"),
       "windows:amd64:jdk-latest": gate + t("1:30:00"),
     }) + variants({

substratevm/mx.substratevm/mx_substratevm.py

@@ -210,6 +210,7 @@ def __getattr__(self, name):
     'truffle_unittests',
     'check_libcontainer_annotations',
     'check_libcontainer_namespace',
+    'java_agent'
 ])
 
 def vm_native_image_path(config=None):
@@ -510,6 +511,9 @@ def help_stdout_check(output):
             except SchemaError as e:
                 mx.abort(f'JSON schema not valid: {e}')
 
+    with Task('java agent tests', tasks, tags=[GraalTags.java_agent]) as t:
+        if t:
+            java_agent_test(args.extra_image_builder_arguments)
 
 def native_unittests_task(extra_build_args=None):
     if mx.is_windows():
@@ -1730,64 +1734,42 @@ def cinterfacetutorial(args):
 
 
 @mx.command(suite.name, 'javaagenttest', 'Runs tests for java agent with native image')
-def agenttest(args):
-    def build_and_test_agent_image(native_image, args):
+def java_agent_test(args):
+    def build_and_run(args, binary_path, native_image, agents, agents_arg):
+        test_cp = os.pathsep.join([classpath('com.oracle.svm.test')] + agents)
+        native_agent_premain_options = ['-XXpremain:com.oracle.svm.test.javaagent.agent1.TestJavaAgent1:test.agent1=true', '-XXpremain:com.oracle.svm.test.javaagent.agent2.TestJavaAgent2:test.agent2=true']
+        image_args = ['-cp', test_cp, '-J-ea', '-J-esa', '-H:+ReportExceptionStackTraces', '-H:Class=com.oracle.svm.test.javaagent.AgentTest']
+        native_image(image_args + svm_experimental_options(['-H:PremainClasses=' + agents_arg]) + ['-o', binary_path] + args)
+        mx.run([binary_path] + native_agent_premain_options)
+
+    def build_and_test_java_agent_image(native_image, args):
         args = [] if args is None else args
         build_dir = join(svmbuild_dir(), 'javaagenttest')
 
         # clean / create output directory
         if exists(build_dir):
             mx.rmtree(build_dir)
         mx_util.ensure_dir_exists(build_dir)
-        test_build_output = mx.dependency('com.oracle.svm.test').classpath_repr()
-
-        # create agent jar file
-        agent1 = join(build_dir, 'testagent1.jar')
-        mx.run([mx.get_jdk().jar, 'cmf', join(test_build_output, 'resources','agent1', 'MANIFEST.MF'),
-                agent1,
-                join('com', 'oracle', 'svm', 'test', 'agent', 'Agent.class'),
-                join('com', 'oracle', 'svm', 'test', 'agent', 'Agent$DemoTransformer.class'),
-                join('com', 'oracle', 'svm', 'test', 'agent', 'AgentPremainHelper.class')],
-               cwd = test_build_output)
-
-        agent2 = join(build_dir, 'testagent2.jar')
-        mx.run([mx.get_jdk().jar, 'cmf', join(test_build_output, 'resources','agent2', 'MANIFEST.MF'),
-                agent2,
-                join('com', 'oracle', 'svm', 'test', 'agent', 'Agent2.class'),
-                join('com', 'oracle', 'svm', 'test', 'agent', 'AgentPremainHelper.class')],
-               cwd = test_build_output)
-
-        # build test with agent
-        test_cp = os.pathsep.join([classpath('com.oracle.svm.test'), agent1, agent2])
-
-
-        nativeagent_premain_options=['-XXpremain:com.oracle.svm.test.agent.Agent:test.agent=true',
-                                     '-XXpremain:com.oracle.svm.test.agent.Agent2:test.agent2=true']
-
-        binary_path = join(build_dir, 'agenttest1')
-        native_image([
-                         '-cp', test_cp,
-                         '-J-ea', '-J-esa',
-                         '-o', binary_path,
-                         '-H:+ReportExceptionStackTraces',
-                         '-H:PremainClasses=com.oracle.svm.test.agent.Agent,com.oracle.svm.test.agent.Agent2',
-                         '-H:Class=com.oracle.svm.test.agent.AgentTest',
-                     ]  + args)
-        mx.run([binary_path] + nativeagent_premain_options)
-
-        # Switch the premain sequence of agent1 and agent2
-        binary_path = join(build_dir, 'agenttest2')
-        native_image([
-                         '-cp', test_cp,
-                         '-J-ea', '-J-esa',
-                         '-o', binary_path,
-                         '-H:+ReportExceptionStackTraces',
-                         '-H:PremainClasses=com.oracle.svm.test.agent.Agent2,com.oracle.svm.test.agent.Agent',
-                         '-H:Class=com.oracle.svm.test.agent.AgentTest',
-                     ]  + args)
-        mx.run([binary_path] + nativeagent_premain_options)
-
-    native_image_context_run(build_and_test_agent_image, args)
+        with mx.TempDir() as tmp_dir:
+            test_classpath = mx.dependency('com.oracle.svm.test').classpath_repr()
+            # Create agent jar files
+            # Note: we are not using MX here to avoid polluting the suite.py and requiring extra build flags
+            mx.log("Building agent jars from " + test_classpath)
+            agents = []
+            for i in range(1, 2):
+                agent = join(tmp_dir, "testagent%d.jar" % (i))
+                agent_test_classpath = join(test_classpath, 'com', 'oracle', 'svm', 'test', 'javaagent', 'agent' + str(i))
+                class_list = [join(test_classpath, 'com', 'oracle', 'svm', 'test', 'javaagent', 'agent' + str(i), f) for f in os.listdir(agent_test_classpath) if os.path.isfile(os.path.join(agent_test_classpath, f)) and f.endswith(".class")]
+                mx.run([mx.get_jdk().jar, 'cmf', join(test_classpath, 'resources', 'javaagent' + str(i), 'MANIFEST.MF'), agent] + class_list, cwd = tmp_dir)
+                agents.append(agent)
+
+            mx.log("Building images with different agent orders ")
+            build_and_run(args, join(tmp_dir, 'agenttest1'), native_image, agents,'com.oracle.svm.test.javaagent.agent1.TestJavaAgent1,com.oracle.svm.test.javaagent.agent2.TestJavaAgent2')
+
+            # Switch the premain sequence of agent1 and agent2
+            build_and_run(args, join(tmp_dir, 'agenttest2'), native_image, agents, 'com.oracle.svm.test.javaagent.agent2.TestJavaAgent2,com.oracle.svm.test.javaagent.agent1.TestJavaAgent1')
+
+    native_image_context_run(build_and_test_java_agent_image, args)
 
 @mx.command(suite.name, 'clinittest', 'Runs the ')
 def clinittest(args):

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/PreMainSupport.java

@@ -100,9 +100,9 @@ public class PreMainSupport {
     record PremainMethod(String className, Method method, Object[] args) {
     }
 
-    private Map<String, String> premainOptions = new HashMap<>();
+    private final Map<String, String> premainOptions = new HashMap<>();
     // Order matters
-    private List<PremainMethod> premainMethods = new ArrayList<>();
+    private final List<PremainMethod> premainMethods = new ArrayList<>();
 
     @Platforms({Platform.HOSTED_ONLY.class})
     public void registerPremainMethod(String className, Method executable, Object... args) {
@@ -120,8 +120,10 @@ public void registerPremainMethod(String className, Method executable, Object...
      * @return arguments for main class
      */
     public String[] retrievePremainArgs(String[] args) {
+        if (args == null) {
+            return null;
+        }
         List<String> mainArgs = new ArrayList<>();
-
         for (String arg : args) {
             if (arg.startsWith(PREMAIN_OPTION_PREFIX)) {
                 String premainOptionKeyValue = arg.substring(PREMAIN_OPTION_PREFIX.length());
@@ -147,10 +149,11 @@ public void invokePremain() {
                 // premain method must be static
                 premainMethod.method.invoke(null, args);
             } catch (Throwable t) {
+                Throwable cause = t;
                 if (t instanceof InvocationTargetException) {
-                    t = t.getCause();
+                    cause = t.getCause();
                 }
-                VMError.shouldNotReachHere("Fail to execute " + premainMethod.className + ".premain", t);
+                VMError.shouldNotReachHere("Fail to execute " + premainMethod.className + ".premain", cause);
             }
         }
     }

substratevm/src/com.oracle.svm.test/src/com/oracle/svm/test/agent/AgentPremainHelper.java renamed to substratevm/src/com.oracle.svm.test/src/com/oracle/svm/test/javaagent/AgentPremainHelper.java

@@ -24,7 +24,7 @@
  * questions.
  */
 
-package com.oracle.svm.test.agent;
+package com.oracle.svm.test.javaagent;
 
 public class AgentPremainHelper {
     public static void load(Class<?> agentClass) {

substratevm/src/com.oracle.svm.test/src/com/oracle/svm/test/agent/AgentTest.java renamed to substratevm/src/com.oracle.svm.test/src/com/oracle/svm/test/javaagent/AgentTest.java

@@ -24,8 +24,10 @@
  * questions.
  */
 
-package com.oracle.svm.test.agent;
+package com.oracle.svm.test.javaagent;
 
+import com.oracle.svm.test.javaagent.agent1.TestJavaAgent1;
+import com.oracle.svm.test.javaagent.agent2.TestJavaAgent2;
 import org.junit.Assert;
 
 public class AgentTest {
@@ -35,7 +37,7 @@ private static void testPremain() {
     }
 
     private static void testAgentOptions() {
-        Assert.assertEquals("true", System.getProperty("test.agent"));
+        Assert.assertEquals("true", System.getProperty("test.agent1"));
         Assert.assertEquals("true", System.getProperty("test.agent2"));
     }
 
@@ -44,8 +46,8 @@ private static void testPremainSequence() {
         String second = AgentPremainHelper.getSecond();
         Assert.assertNotNull(first);
         if (second != null) {
-            String agentName = Agent.class.getName();
-            String agent2Name = Agent2.class.getName();
+            String agentName = TestJavaAgent1.class.getName();
+            String agent2Name = TestJavaAgent2.class.getName();
 
             if (first.equals(agentName)) {
                 Assert.assertEquals(agent2Name, second);

substratevm/src/com.oracle.svm.test/src/com/oracle/svm/test/agent/Agent.java renamed to substratevm/src/com.oracle.svm.test/src/com/oracle/svm/test/javaagent/agent1/TestJavaAgent1.java

@@ -23,8 +23,9 @@
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */
-package com.oracle.svm.test.agent;
+package com.oracle.svm.test.javaagent.agent1;
 
+import com.oracle.svm.test.javaagent.AgentPremainHelper;
 import org.graalvm.nativeimage.ImageInfo;
 import org.junit.Assert;
 
@@ -34,16 +35,16 @@
 import java.util.Collections;
 import java.util.Set;
 
-public class Agent {
+public class TestJavaAgent1 {
     public static void premain(
                     String agentArgs, Instrumentation inst) {
         AgentPremainHelper.parseOptions(agentArgs);
         System.setProperty("instrument.enable", "true");
         if (!ImageInfo.inImageRuntimeCode()) {
-            DemoTransformer dt = new DemoTransformer("com.oracle.svm.test.agent.AgentTest");
+            DemoTransformer dt = new DemoTransformer("com.oracle.svm.test.javaagent.TestJavaAgent1");
             inst.addTransformer(dt, true);
         } else {
-            AgentPremainHelper.load(Agent.class);
+            AgentPremainHelper.load(TestJavaAgent1.class);
             /**
              * Test {@code inst} is {@link NativeImageNoOpRuntimeInstrumentation} and behaves as
              * defined.
@@ -59,7 +60,7 @@ public static void premain(
             Assert.assertTrue(allClasses.length > 0);
             Class<?> currentAgentClassFromAllLoaded = null;
             for (Class<?> c : allClasses) {
-                if (c.equals(Agent.class)) {
+                if (c.equals(TestJavaAgent1.class)) {
                     currentAgentClassFromAllLoaded = c;
                 }
             }
@@ -118,7 +119,7 @@ public static void premain(
             Assert.assertEquals(-1, inst.getObjectSize(null));
             Assert.assertEquals(false, inst.isNativeMethodPrefixSupported());
 
-            Module currentModule = Agent.class.getModule();
+            Module currentModule = TestJavaAgent1.class.getModule();
             Assert.assertEquals(true, inst.isModifiableModule(currentModule));
 
             // redefineModule only does checks, no actual actions.

substratevm/src/com.oracle.svm.test/src/com/oracle/svm/test/agent/Agent2.java renamed to substratevm/src/com.oracle.svm.test/src/com/oracle/svm/test/javaagent/agent2/TestJavaAgent2.java

@@ -24,18 +24,19 @@
  * questions.
  */
 
-package com.oracle.svm.test.agent;
+package com.oracle.svm.test.javaagent.agent2;
 
+import com.oracle.svm.test.javaagent.AgentPremainHelper;
 import org.graalvm.nativeimage.ImageInfo;
 
-public class Agent2 {
+public class TestJavaAgent2 {
     public static void premain(String agentArgs) {
         AgentPremainHelper.parseOptions(agentArgs);
         System.setProperty("instrument.enable", "true");
         if (!ImageInfo.inImageRuntimeCode()) {
             // do class transformation
         } else {
-            AgentPremainHelper.load(Agent2.class);
+            AgentPremainHelper.load(TestJavaAgent2.class);
         }
     }
 }