[GR-39390] Add support for JFR monitor enter events.

PullRequest: graal/12073

Author: christianhaeubl

substratevm/CHANGELOG.md

@@ -4,6 +4,7 @@ This changelog summarizes major changes to GraalVM Native Image.
 
 ## Version 22.3.0
 * (GR-35721) Remove old build output style and the `-H:±BuildOutputUseNewStyle` option.
+* (GR-39390) Red Hat added support for the JFR event `JavaMonitorEnter`.
 
 ## Version 22.2.0
 * (GR-20653) Re-enable the usage of all CPU features for JIT compilation on AMD64.

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/allocationprofile/AllocationSite.java

@@ -26,12 +26,14 @@
 
 import java.text.DecimalFormat;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.Comparator;
 import java.util.List;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 import java.util.concurrent.atomic.AtomicReference;
 
+import com.oracle.svm.core.jdk.RuntimeFeature;
 import org.graalvm.compiler.options.Option;
 import org.graalvm.nativeimage.hosted.Feature;
 
@@ -212,6 +214,11 @@ public static void dumpProfilingResults(final Log log) {
 
 @AutomaticFeature
 class AllocationProfilingFeature implements Feature {
+    @Override
+    public List<Class<? extends Feature>> getRequiredFeatures() {
+        return Collections.singletonList(RuntimeFeature.class);
+    }
+
     @Override
     public void afterRegistration(AfterRegistrationAccess access) {
         if (AllocationSite.Options.AllocationProfiling.getValue()) {

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jfr/JfrEvent.java

@@ -53,7 +53,8 @@ public enum JfrEvent {
     GCPhasePauseLevel4Event("jdk.GCPhasePauseLevel4"),
     SafepointBegin("jdk.SafepointBegin"),
     SafepointEnd("jdk.SafepointEnd"),
-    ExecuteVMOperation("jdk.ExecuteVMOperation");
+    ExecuteVMOperation("jdk.ExecuteVMOperation"),
+    JavaMonitorEnter("jdk.JavaMonitorEnter");
 
     private final long id;
 

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jfr/JfrNativeEventWriter.java

@@ -216,7 +216,7 @@ public static void putThread(JfrNativeEventWriterData data, IsolateThread isolat
         if (isolateThread.isNull()) {
             putLong(data, 0L);
         } else {
-            long threadId = SubstrateJVM.get().getThreadId(isolateThread);
+            long threadId = SubstrateJVM.getThreadId(isolateThread);
             putLong(data, threadId);
         }
     }

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jfr/JfrThreadLocal.java

@@ -167,7 +167,7 @@ public Target_jdk_jfr_internal_EventWriter newEventWriter() {
         long startPos = buffer.getPos().rawValue();
         long maxPos = JfrBufferAccess.getDataEnd(buffer).rawValue();
         long addressOfPos = JfrBufferAccess.getAddressOfPos(buffer).rawValue();
-        long jfrThreadId = SubstrateJVM.get().getThreadId(CurrentIsolate.getCurrentThread());
+        long jfrThreadId = SubstrateJVM.getThreadId(CurrentIsolate.getCurrentThread());
         Target_jdk_jfr_internal_EventWriter result = new Target_jdk_jfr_internal_EventWriter(startPos, maxPos, addressOfPos, jfrThreadId, true);
         javaEventWriter.set(result);
 

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jfr/SubstrateJVM.java

@@ -255,15 +255,21 @@ public long getStackTraceId(int skipCount) {
     }
 
     /** See {@link JVM#getThreadId}. */
-    public long getThreadId(Thread thread) {
-        return thread.getId();
+    public static long getThreadId(Thread thread) {
+        if (HasJfrSupport.get()) {
+            return thread.getId();
+        }
+        return 0;
     }
 
     @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
-    public long getThreadId(IsolateThread isolateThread) {
-        long threadId = threadLocal.getTraceId(isolateThread);
-        VMError.guarantee(threadId > 0);
-        return threadId;
+    public static long getThreadId(IsolateThread isolateThread) {
+        if (HasJfrSupport.get()) {
+            long threadId = get().threadLocal.getTraceId(isolateThread);
+            VMError.guarantee(threadId > 0);
+            return threadId;
+        }
+        return 0;
     }
 
     /** See {@link JVM#storeMetadataDescriptor}. */

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jfr/Target_jdk_jfr_internal_JVM.java

@@ -136,7 +136,7 @@ public long getStackTraceId(int skipCount) {
     /** See {@link JVM#getThreadId}. */
     @Substitute
     public long getThreadId(Thread t) {
-        return SubstrateJVM.get().getThreadId(t);
+        return SubstrateJVM.getThreadId(t);
     }
 
     /** See {@link JVM#getTicksFrequency}. */

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jfr/events/JavaMonitorEnterEvent.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2022, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2022, 2022, 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.jfr.events;
+
+import com.oracle.svm.core.jfr.HasJfrSupport;
+import org.graalvm.nativeimage.StackValue;
+
+import com.oracle.svm.core.annotate.Uninterruptible;
+import com.oracle.svm.core.jfr.JfrEvent;
+import com.oracle.svm.core.jfr.JfrNativeEventWriter;
+import com.oracle.svm.core.jfr.JfrNativeEventWriterData;
+import com.oracle.svm.core.jfr.JfrNativeEventWriterDataAccess;
+import com.oracle.svm.core.jfr.JfrTicks;
+import com.oracle.svm.core.jfr.SubstrateJVM;
+
+public class JavaMonitorEnterEvent {
+    public static void emit(Object obj, long previousOwnerTid, long startTicks) {
+        if (HasJfrSupport.get()) {
+            emit0(obj, previousOwnerTid, startTicks);
+        }
+    }
+
+    @Uninterruptible(reason = "Accesses a JFR buffer.")
+    public static void emit0(Object obj, long previousOwnerTid, long startTicks) {
+        if (SubstrateJVM.isRecording() && SubstrateJVM.get().isEnabled(JfrEvent.JavaMonitorEnter)) {
+            JfrNativeEventWriterData data = StackValue.get(JfrNativeEventWriterData.class);
+            JfrNativeEventWriterDataAccess.initializeThreadLocalNativeBuffer(data);
+
+            JfrNativeEventWriter.beginSmallEvent(data, JfrEvent.JavaMonitorEnter);
+            JfrNativeEventWriter.putLong(data, startTicks);
+            JfrNativeEventWriter.putLong(data, JfrTicks.elapsedTicks() - startTicks);
+            JfrNativeEventWriter.putEventThread(data);
+            JfrNativeEventWriter.putLong(data, SubstrateJVM.get().getStackTraceId(JfrEvent.JavaMonitorEnter.getId(), 0));
+            JfrNativeEventWriter.putClass(data, obj.getClass());
+            JfrNativeEventWriter.putLong(data, previousOwnerTid);
+            JfrNativeEventWriter.putLong(data, org.graalvm.compiler.word.Word.objectToUntrackedPointer(obj).rawValue());
+            JfrNativeEventWriter.endSmallEvent(data);
+
+        }
+    }
+}

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/monitor/JavaMonitor.java

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2022, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2022, 2022, 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.monitor;
+
+import java.util.concurrent.locks.ReentrantLock;
+
+import org.graalvm.nativeimage.CurrentIsolate;
+
+import com.oracle.svm.core.SubstrateUtil;
+import com.oracle.svm.core.jfr.JfrTicks;
+import com.oracle.svm.core.jfr.SubstrateJVM;
+import com.oracle.svm.core.jfr.events.JavaMonitorEnterEvent;
+
+public class JavaMonitor extends ReentrantLock {
+    private static final long serialVersionUID = 3921577070627519721L;
+
+    private long latestJfrTid;
+
+    public JavaMonitor() {
+        Target_java_util_concurrent_locks_ReentrantLock lock = SubstrateUtil.cast(this, Target_java_util_concurrent_locks_ReentrantLock.class);
+        Target_java_util_concurrent_locks_ReentrantLock_NonfairSync sync = SubstrateUtil.cast(lock.sync, Target_java_util_concurrent_locks_ReentrantLock_NonfairSync.class);
+        sync.objectMonitorCondition = SubstrateUtil.cast(MultiThreadedMonitorSupport.MONITOR_WITHOUT_CONDITION, Target_java_util_concurrent_locks_AbstractQueuedSynchronizer_ConditionObject.class);
+        latestJfrTid = 0;
+    }
+
+    /**
+     * Creates a new {@link ReentrantLock} that is locked by the provided thread. This requires
+     * patching of internal state, since there is no public API in {@link ReentrantLock} to do that
+     * (for a good reason, because it is a highly unusual operation).
+     */
+    public static JavaMonitor newLockedMonitorForThread(Thread thread, int recursionDepth) {
+        JavaMonitor result = new JavaMonitor();
+        for (int i = 0; i < recursionDepth; i++) {
+            result.lock();
+        }
+
+        result.latestJfrTid = SubstrateJVM.getThreadId(thread);
+        Target_java_util_concurrent_locks_ReentrantLock lock = SubstrateUtil.cast(result, Target_java_util_concurrent_locks_ReentrantLock.class);
+        Target_java_util_concurrent_locks_AbstractOwnableSynchronizer sync = SubstrateUtil.cast(lock.sync, Target_java_util_concurrent_locks_AbstractOwnableSynchronizer.class);
+
+        assert sync.exclusiveOwnerThread == Thread.currentThread() : "Must be locked by current thread";
+        sync.exclusiveOwnerThread = thread;
+
+        return result;
+    }
+
+    public void monitorEnter(Object obj) {
+        if (!tryLock()) {
+            long startTicks = JfrTicks.elapsedTicks();
+            lock();
+            JavaMonitorEnterEvent.emit(obj, latestJfrTid, startTicks);
+        }
+
+        latestJfrTid = SubstrateJVM.getThreadId(CurrentIsolate.getCurrentThread());
+    }
+}