Add JDK Flight Recorder support for Java native images

Co-authored-by: Andrew Dinn <adinn@redhat.com>
Co-authored-by: Roman Kennke <rkennke@redhat.com>
Co-authored-by: Josh Matsuoka <jmatsuok@redhat.com>
Co-authored-by: Tako Schotanus <tschotan@redhat.com>
Co-authored-by: Simon Tooke <stooke@redhat.com>

Author: 6 people

substratevm/JFR.md

@@ -0,0 +1,43 @@
+## JFR Implementation Notes
+
+Implementation is based off of jdk/jdk commit rev
+
+d2816784605b
+
+## JDK Matrix
+
+This branch builds with:
+labsjdk-ce-11.0.9-jvmci-20.3-b06
+
+Tarballs can be found at:
+https://github.com/graalvm/labs-openjdk-11/releases
+
+For example:
+https://github.com/graalvm/labs-openjdk-11/releases/download/jvmci-20.3-b06/labsjdk-ce-11.0.9+10-jvmci-20.3-b06-linux-amd64.tar.gz
+
+## Testing the JFR code
+
+Clone the graalvm-jfr-tests repo somewhere to be used in the -cp argument. Use a JDK 11 to compile into class files.
+
+```
+javac /path/to/graalvm-jfr-tests/flat/EventCommit.java
+
+
+mx clean
+mx build
+mx native-image --allow-incomplete-classpath "-J-XX:FlightRecorderOptions=retransform=false" --no-fallback -ea -cp /path/to/graalvm-jfr-tests/flat/ EventCommit
+```
+
+See `/tmp` for a `my-recording...` jfr file
+
+## Logging
+
+The JFR implementation supports log levels via runtime flag:
+```
+-XX:FlightRecorderLogging=<value>
+```
+
+Values include:
+```
+trace, debug, info, warning, error
+```

substratevm/mx.substratevm/suite.py

@@ -581,6 +581,24 @@
             "spotbugs": "false",
         },
 
+        "com.oracle.svm.core.jdk.jfr.test": {
+            "subDir": "src",
+            "sourceDirs": ["src"],
+            "dependencies": [
+                "com.oracle.svm.core",
+                "mx:JUNIT",
+                "sdk:GRAAL_SDK",
+            ],
+            "checkstyle": "com.oracle.svm.core",
+            "workingSets": "SVM_CORE",
+            "annotationProcessors": [
+                "compiler:GRAAL_PROCESSOR",
+            ],
+            "javaCompliance": "8+",
+            "spotbugs": "false",
+        },
+
+
         "com.oracle.svm.test.jdk11": {
             "subDir": "src",
             "sourceDirs": ["src"],
@@ -1193,11 +1211,13 @@
             "com.oracle.svm.test.jdk11",
             "com.oracle.svm.configure.test",
             "com.oracle.svm.graal.test",
+            "com.oracle.svm.core.jdk.jfr.test",
           ],
           "distDependencies": [
             "mx:JUNIT_TOOL",
             "sdk:GRAAL_SDK",
             "SVM_CONFIGURE",
+            "SVM_CORE",
           ],
           "testDistribution" : True,
         },

substratevm/src/com.oracle.svm.core.jdk.jfr.test/src/com/oracle/svm/core/jdk/jfr/test/JfrOptionsTest.java

@@ -0,0 +1,140 @@
+/*
+ * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, Red Hat Inc. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.oracle.svm.core.jdk.jfr.test;
+
+import org.graalvm.collections.EconomicMap;
+import org.junit.Assert;
+import org.junit.Test;
+
+import com.oracle.svm.core.jdk.jfr.JfrOptions;
+
+public class JfrOptionsTest {
+
+    // Taken from GlobalDefinitions.hpp
+    private static final long K = 1024;
+    private static final long M = K*K;
+    private static final long G = M*K;
+
+    @Test
+    public void testBasicOptions() {
+        JfrOptions.StartFlightRecordingOption.update(EconomicMap.create(), "dumponexit=true");
+        Assert.assertEquals(JfrOptions.getDumpOnExit(), true);
+    }
+
+    @Test
+    public void testValidMemoryOptions() {
+        JfrOptions.StartFlightRecordingOption.update(EconomicMap.create(), "memorysize=256m," +
+                "globalbuffersize=128m,globalbuffercount=2,threadbuffersize=8k");
+        Assert.assertEquals(JfrOptions.getGlobalBufferSize(), 128 * M);
+        Assert.assertEquals(JfrOptions.getMemorySize(), 256*M);
+        Assert.assertEquals(JfrOptions.getGlobalBufferCount(), 2);
+    }
+
+    @Test
+    public void testInvalidMemoryOptions() {
+        try {
+            JfrOptions.StartFlightRecordingOption.update(EconomicMap.create(), "memorysize=1k");
+        } catch (IllegalArgumentException e) {
+            // Pass
+            return;
+        }
+        Assert.fail();
+    }
+
+    @Test
+    public void testBadInput() {
+        try {
+            JfrOptions.StartFlightRecordingOption.update(EconomicMap.create(), "memorysize=thisShouldFail");
+        } catch (Exception e) {
+            // Pass
+            return;
+        }
+        Assert.fail();
+    }
+
+    @Test
+    public void testTimeOptions() {
+        JfrOptions.StartFlightRecordingOption.update(EconomicMap.create(),"delay=10s,maxage=1h,duration=2m");
+        Assert.assertEquals(10, JfrOptions.getRecordingDelay());
+        Assert.assertEquals(360, JfrOptions.getMaxAge());
+        Assert.assertEquals(120, JfrOptions.getDuration());
+    }
+
+    @Test
+    public void testMaxStackDepth() {
+        try {
+            JfrOptions.StartFlightRecordingOption.update(EconomicMap.create(),"stackdepth=9000");
+        } catch (Exception e) {
+            // Pass
+            return;
+        }
+        Assert.fail();
+    }
+
+    @Test
+    public void testNegativeStackDepth() {
+        try {
+            JfrOptions.StartFlightRecordingOption.update(EconomicMap.create(),"stackdepth=-10");
+        } catch (Exception e) {
+            // Pass
+            return;
+        }
+        Assert.fail();
+    }
+
+    @Test
+    public void testAllArguments() {
+        JfrOptions.StartFlightRecordingOption.update(EconomicMap.create(),
+                "maxchunksize=1k,globalbuffersize=1m,memorysize=2m,retransform=true," +
+                        "stackdepth=10,sampleprotection=true,samplethreads=true,old-object-queue-size=100," +
+                        "numglobalbuffers=2,threadbuffersize=4k,repository=/path/to/repository,dumponexit=false," +
+                        "name=recording,settings=/path/to/settings,delay=10s,duration=1m,disk=true,maxage=1h," +
+                        "maxsize=10k,path-to-gc-roots=true");
+        Assert.assertEquals(1*K, JfrOptions.getMaxChunkSize());
+        Assert.assertEquals(1*M, JfrOptions.getGlobalBufferSize());
+        Assert.assertEquals(2, JfrOptions.getGlobalBufferCount());
+        Assert.assertEquals(2*M, JfrOptions.getMemorySize());
+        Assert.assertEquals(true, JfrOptions.isRetransformEnabled());
+        Assert.assertEquals(10, JfrOptions.getStackDepth());
+        Assert.assertEquals(true, JfrOptions.isSampleProtectionEnabled());
+        Assert.assertEquals(true, JfrOptions.isSampleThreadsEnabled());
+        Assert.assertEquals(100, JfrOptions.getObjectQueueSize());
+        Assert.assertEquals(2, JfrOptions.getGlobalBufferCount());
+        Assert.assertEquals(4*K, JfrOptions.getThreadBufferSize());
+        Assert.assertEquals("/path/to/repository", JfrOptions.getRepositoryLocation());
+        Assert.assertEquals(false, JfrOptions.getDumpOnExit());
+        Assert.assertEquals("recording", JfrOptions.getRecordingName());
+        Assert.assertEquals("/path/to/settings", JfrOptions.getRecordingSettingsFile());
+        Assert.assertEquals(10, JfrOptions.getRecordingDelay());
+        Assert.assertEquals(60, JfrOptions.getDuration());
+        Assert.assertEquals(true, JfrOptions.isPersistedToDisk());
+        Assert.assertEquals(360, JfrOptions.getMaxAge());
+        Assert.assertEquals(10*K, JfrOptions.getMaxRecordingSize());
+        Assert.assertEquals(true, JfrOptions.trackPathToGcRoots());
+    }
+
+}

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/jfr/JavaJfrUtils.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, Red Hat Inc. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.oracle.svm.core.jdk.jfr;
+
+public class JavaJfrUtils {
+    public static boolean isJFRClass(Class<?> clazz) {
+
+        if (clazz.isInterface()) {
+            return false;
+        }
+
+        Class<?> targetClass = clazz;
+        String targetClassName = targetClass.getCanonicalName();
+
+        // a bit convoluted but needed to avoid referencing classes by name so we don't need to open internal
+        // jfr packages
+
+        while (targetClassName != null && !targetClassName.equals("java.lang.Object")) {
+            if (targetClassName.equals("jdk.internal.event.Event") ||
+                targetClassName.equals("jdk.jfr.internal.handlers.EventHandler")) {
+                return true;
+            }
+
+            targetClass = targetClass.getSuperclass();
+            targetClassName = targetClass.getCanonicalName();
+        }
+
+        return false;
+    }
+
+}

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/jfr/Jfr.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, Red Hat Inc. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.oracle.svm.core.jdk.jfr;
+
+import com.oracle.svm.core.jdk.jfr.recorder.JfrRecorder;
+import com.oracle.svm.core.jdk.jfr.support.JfrThreadLocal;
+
+public class Jfr {
+
+    public static boolean isEnabled() {
+        return JfrRecorder.isEnabled();
+    }
+
+    public static boolean isDisabled() {
+        return JfrRecorder.isDisabled();
+    }
+
+    public static boolean isRecording() {
+        return JfrRecorder.isRecording();
+    }
+
+    public static void excludeThread(Thread t) {
+        JfrThreadLocal.excludeThread(t);
+    }
+
+}

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/jfr/JfrAvailability.java

@@ -0,0 +1,15 @@
+package com.oracle.svm.core.jdk.jfr;
+
+import java.util.function.BooleanSupplier;
+
+import org.graalvm.compiler.serviceprovider.JavaVersionUtil;
+
+public class JfrAvailability {
+    public static boolean withJfr = false;
+    public static class WithJfr implements BooleanSupplier {
+        @Override
+        public boolean getAsBoolean() {
+            return JavaVersionUtil.JAVA_SPEC >= 11 && withJfr;
+        }
+    }
+}