[GR-40033] Implement JFR MonitorWaitEvent.

PullRequest: graal/12324

Author: christianhaeubl

substratevm/CHANGELOG.md

@@ -4,14 +4,14 @@ 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) (GR-39649) Red Hat added support for the JFR events `JavaMonitorEnter` and `ThreadSleep`.
+* (GR-39390) (GR-39649) (GR-40033) Red Hat added support for the JFR events `JavaMonitorEnter`, `JavaMonitorWait`, and `ThreadSleep`.
 * (GR-39497) Add `-H:BuildOutputJSONFile=<file.json>` option for [JSON build output](https://github.com/oracle/graal/edit/master/docs/reference-manual/native-image/BuildOutput.md#machine-readable-build-output). Please feel free to provide feedback so that we can stabilize the schema/API.
 
 ## Version 22.2.0
 * (GR-20653) Re-enable the usage of all CPU features for JIT compilation on AMD64.
 * (GR-38413) Add support for `-XX:+ExitOnOutOfMemoryError`.
 * (GR-37606) Add support for URLs and short descriptions to `Feature`. This info is shown as part of the build output.
-* (GR-38965) Heap dumps are now supported in Community Edition. 
+* (GR-38965) Heap dumps are now supported in Community Edition.
 * (GR-38951) Add `-XX:+DumpHeapAndExit` option to dump the initial heap of a native executable.
 * (GR-37582) Run image-builder on module-path per default. Opt-out with env setting `USE_NATIVE_IMAGE_JAVA_PLATFORM_MODULE_SYSTEM=false`.
 * (GR-38660) Expose -H:Name=<outfile> as API option -o <outfile>

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

@@ -55,7 +55,8 @@ public enum JfrEvent {
     SafepointEnd("jdk.SafepointEnd"),
     ExecuteVMOperation("jdk.ExecuteVMOperation"),
     JavaMonitorEnter("jdk.JavaMonitorEnter"),
-    ThreadSleep("jdk.ThreadSleep");
+    ThreadSleep("jdk.ThreadSleep"),
+    JavaMonitorWait("jdk.JavaMonitorWait");
 
     private final long id;
 

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

@@ -0,0 +1,64 @@
+/*
+ * 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.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;
+import org.graalvm.compiler.word.Word;
+import com.oracle.svm.core.jfr.HasJfrSupport;
+
+public class JavaMonitorWaitEvent {
+    public static void emit(long startTicks, Object obj, long notifier, long timeout, boolean timedOut) {
+        if (HasJfrSupport.get()) {
+            emit0(startTicks, obj, notifier, timeout, timedOut);
+        }
+    }
+
+    @Uninterruptible(reason = "Accesses a JFR buffer.")
+    private static void emit0(long startTicks, Object obj, long notifier, long timeout, boolean timedOut) {
+        if (SubstrateJVM.isRecording() && SubstrateJVM.get().isEnabled(JfrEvent.JavaMonitorWait)) {
+            JfrNativeEventWriterData data = org.graalvm.nativeimage.StackValue.get(JfrNativeEventWriterData.class);
+            JfrNativeEventWriterDataAccess.initializeThreadLocalNativeBuffer(data);
+            JfrNativeEventWriter.beginSmallEvent(data, JfrEvent.JavaMonitorWait);
+            JfrNativeEventWriter.putLong(data, startTicks);
+            JfrNativeEventWriter.putLong(data, JfrTicks.elapsedTicks() - startTicks);
+            JfrNativeEventWriter.putEventThread(data);
+            JfrNativeEventWriter.putLong(data, SubstrateJVM.get().getStackTraceId(JfrEvent.JavaMonitorWait, 0));
+            JfrNativeEventWriter.putClass(data, obj.getClass());
+            JfrNativeEventWriter.putLong(data, notifier);
+            JfrNativeEventWriter.putLong(data, timeout);
+            JfrNativeEventWriter.putBoolean(data, timedOut);
+            JfrNativeEventWriter.putLong(data, Word.objectToUntrackedPointer(obj).rawValue());
+            JfrNativeEventWriter.endSmallEvent(data);
+        }
+    }
+}

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

@@ -29,15 +29,15 @@
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.locks.LockSupport;
 
-import org.graalvm.compiler.serviceprovider.JavaVersionUtil;
+import org.graalvm.nativeimage.CurrentIsolate;
 
-import com.oracle.svm.core.SubstrateUtil;
 import com.oracle.svm.core.annotate.Alias;
 import com.oracle.svm.core.annotate.TargetClass;
 import com.oracle.svm.core.annotate.TargetElement;
 import com.oracle.svm.core.annotate.Uninterruptible;
-import com.oracle.svm.core.jdk.JDK11OrEarlier;
-import com.oracle.svm.core.jdk.JDK17OrLater;
+import com.oracle.svm.core.jfr.JfrTicks;
+import com.oracle.svm.core.jfr.SubstrateJVM;
+import com.oracle.svm.core.jfr.events.JavaMonitorWaitEvent;
 
 import jdk.internal.misc.Unsafe;
 
@@ -114,6 +114,7 @@ static final class ExclusiveNode extends Node {
     // see AbstractQueuedSynchronizer.ConditionNode
     static final class ConditionNode extends Node {
         ConditionNode nextWaiter;
+        long notifierJfrTid;
 
         // see AbstractQueuedSynchronizer.ConditionNode.isReleasable()
         public boolean isReleasable() {
@@ -364,6 +365,7 @@ private void doSignal(ConditionNode first, boolean all) {
                     lastWaiter = null;
                 }
                 if ((first.getAndUnsetStatus(COND) & COND) != 0) {
+                    first.notifierJfrTid = SubstrateJVM.getThreadId(CurrentIsolate.getCurrentThread());
                     enqueue(first);
                     if (!all) {
                         break;
@@ -451,8 +453,10 @@ private void unlinkCancelledWaiters(ConditionNode node) {
 
         // see AbstractQueuedSynchronizer.ConditionObject.await()
         @SuppressWarnings("all")
-        public void await() throws InterruptedException {
+        public void await(Object obj) throws InterruptedException {
+            long startTicks = JfrTicks.elapsedTicks();
             if (Thread.interrupted()) {
+                JavaMonitorWaitEvent.emit(startTicks, obj, 0, 0L, false);
                 throw new InterruptedException();
             }
             ConditionNode node = new ConditionNode();
@@ -473,6 +477,8 @@ public void await() throws InterruptedException {
             }
             setCurrentBlocker(null);
             node.clearStatus();
+            // waiting is done, emit wait event
+            JavaMonitorWaitEvent.emit(startTicks, obj, node.notifierJfrTid, 0L, false);
             acquire(node, savedState);
             if (interrupted) {
                 if (cancelled) {
@@ -485,9 +491,11 @@ public void await() throws InterruptedException {
 
         // see AbstractQueuedSynchronizer.ConditionObject.await(long, TimeUnit)
         @SuppressWarnings("all")
-        public boolean await(long time, TimeUnit unit) throws InterruptedException {
+        public boolean await(Object obj, long time, TimeUnit unit) throws InterruptedException {
+            long startTicks = JfrTicks.elapsedTicks();
             long nanosTimeout = unit.toNanos(time);
             if (Thread.interrupted()) {
+                JavaMonitorWaitEvent.emit(startTicks, obj, 0, 0L, false);
                 throw new InterruptedException();
             }
             ConditionNode node = new ConditionNode();
@@ -506,6 +514,8 @@ public boolean await(long time, TimeUnit unit) throws InterruptedException {
                 }
             }
             node.clearStatus();
+            // waiting is done, emit wait event
+            JavaMonitorWaitEvent.emit(startTicks, obj, node.notifierJfrTid, time, cancelled);
             acquire(node, savedState);
             if (cancelled) {
                 unlinkCancelledWaiters(node);
@@ -525,31 +535,19 @@ static void setCurrentBlocker(JavaMonitorConditionObject condition) {
         }
     }
 
+    @SuppressWarnings("deprecation")
     static boolean compareAndSetReference(Object object, long offset, Node expected, Node newValue) {
-        Target_jdk_internal_misc_Unsafe u = SubstrateUtil.cast(U, Target_jdk_internal_misc_Unsafe.class);
-        if (JavaVersionUtil.JAVA_SPEC >= 17) {
-            return u.compareAndSetReference(object, offset, expected, newValue);
-        } else {
-            return u.compareAndSetObject(object, offset, expected, newValue);
-        }
+        return U.compareAndSetObject(object, offset, expected, newValue);
     }
 
+    @SuppressWarnings("deprecation")
     static boolean weakCompareAndSetReference(Object object, long offset, Node expected, Node newValue) {
-        Target_jdk_internal_misc_Unsafe u = SubstrateUtil.cast(U, Target_jdk_internal_misc_Unsafe.class);
-        if (JavaVersionUtil.JAVA_SPEC >= 17) {
-            return u.weakCompareAndSetReference(object, offset, expected, newValue);
-        } else {
-            return u.weakCompareAndSetObject(object, offset, expected, newValue);
-        }
+        return U.weakCompareAndSetObject(object, offset, expected, newValue);
     }
 
+    @SuppressWarnings("deprecation")
     static void putReference(Object object, long offset, Node p) {
-        Target_jdk_internal_misc_Unsafe u = SubstrateUtil.cast(U, Target_jdk_internal_misc_Unsafe.class);
-        if (JavaVersionUtil.JAVA_SPEC >= 17) {
-            u.putReference(object, offset, p);
-        } else {
-            u.putObject(object, offset, p);
-        }
+        U.putObject(object, offset, p);
     }
 
     // Unsafe
@@ -565,30 +563,3 @@ final class Target_java_util_concurrent_locks_LockSupport {
     @TargetElement(onlyWith = com.oracle.svm.core.jdk.JDK17OrLater.class)
     public static native void setCurrentBlocker(Object blocker);
 }
-
-@TargetClass(value = Unsafe.class)
-final class Target_jdk_internal_misc_Unsafe {
-    @Alias
-    @TargetElement(onlyWith = JDK17OrLater.class)
-    public native boolean compareAndSetReference(Object o, long offset, Object expected, Object x);
-
-    @Alias
-    @TargetElement(onlyWith = JDK11OrEarlier.class)
-    public native boolean compareAndSetObject(Object o, long offset, Object expected, Object x);
-
-    @Alias
-    @TargetElement(onlyWith = JDK17OrLater.class)
-    public native boolean weakCompareAndSetReference(Object o, long offset, Object expected, Object x);
-
-    @Alias
-    @TargetElement(onlyWith = JDK11OrEarlier.class)
-    public native boolean weakCompareAndSetObject(Object o, long offset, Object expected, Object x);
-
-    @Alias
-    @TargetElement(onlyWith = JDK17OrLater.class)
-    public native void putReference(Object o, long offset, Object x);
-
-    @Alias
-    @TargetElement(onlyWith = JDK11OrEarlier.class)
-    public native void putObject(Object o, long offset, Object x);
-}

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

@@ -331,9 +331,9 @@ protected void doWait(Object obj, long timeoutMillis) throws InterruptedExceptio
         JavaMonitor lock = ensureLocked(obj);
         JavaMonitorConditionObject condition = lock.getOrCreateCondition(true);
         if (timeoutMillis == 0L) {
-            condition.await();
+            condition.await(obj);
         } else {
-            condition.await(timeoutMillis, TimeUnit.MILLISECONDS);
+            condition.await(obj, timeoutMillis, TimeUnit.MILLISECONDS);
         }
     }