[GR-38490] Query performance counters via Polyglot Native API.

PullRequest: graal/12384

Author: christianhaeubl

sdk/src/org.graalvm.nativeimage/snapshot.sigtest

@@ -818,6 +818,7 @@ meth public static byte toCBoolean(boolean)
 meth public static java.lang.String toJavaString(org.graalvm.nativeimage.c.type.CCharPointer)
 meth public static java.lang.String toJavaString(org.graalvm.nativeimage.c.type.CCharPointer,org.graalvm.word.UnsignedWord)
 meth public static java.lang.String toJavaString(org.graalvm.nativeimage.c.type.CCharPointer,org.graalvm.word.UnsignedWord,java.nio.charset.Charset)
+meth public static java.lang.String utf8ToJavaString(org.graalvm.nativeimage.c.type.CCharPointer)
 meth public static java.nio.ByteBuffer asByteBuffer(org.graalvm.word.PointerBase,int)
 meth public static org.graalvm.nativeimage.c.type.CTypeConversion$CCharPointerHolder toCBytes(byte[])
 meth public static org.graalvm.nativeimage.c.type.CTypeConversion$CCharPointerHolder toCString(java.lang.CharSequence)

sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/c/type/CTypeConversion.java

@@ -167,6 +167,18 @@ public static String toJavaString(CCharPointer cString, UnsignedWord length, Cha
         return ImageSingletons.lookup(CTypeConversionSupport.class).toJavaString(cString, length, charset);
     }
 
+    /**
+     * Decodes a UTF-8 encoded, 0 terminated C {@code char*} to a Java string.
+     *
+     * @param utf8String the pointer to a UTF-8 encoded, 0 terminated C string
+     * @return a Java string
+     *
+     * @since 22.3
+     */
+    public static String utf8ToJavaString(CCharPointer utf8String) {
+        return ImageSingletons.lookup(CTypeConversionSupport.class).utf8ToJavaString(utf8String);
+    }
+
     /**
      * Converts a Java boolean into a C int containing boolean values.
      *

sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/impl/CTypeConversionSupport.java

@@ -62,6 +62,8 @@ public interface CTypeConversionSupport {
 
     String toJavaString(CCharPointer cString, UnsignedWord length, Charset charset);
 
+    String utf8ToJavaString(CCharPointer utf8String);
+
     CCharPointerHolder toCBytes(byte[] bytes);
 
     ByteBuffer asByteBuffer(PointerBase address, int size);

substratevm/src/com.oracle.svm.core.genscavenge/src/com/oracle/svm/core/genscavenge/GCImpl.java

@@ -1225,7 +1225,7 @@ private static class CollectionVMOperation extends NativeVMOperation {
 
         @Override
         @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
-        protected boolean isGC() {
+        public boolean isGC() {
             return true;
         }
 

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/c/CTypeConversionSupportImpl.java

@@ -26,6 +26,7 @@
 
 import java.nio.ByteBuffer;
 import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 
 import com.oracle.svm.core.jdk.Target_java_nio_DirectByteBuffer;
@@ -85,6 +86,16 @@ public String toJavaString(CCharPointer cString, UnsignedWord length, Charset ch
         }
     }
 
+    @Override
+    public String utf8ToJavaString(CCharPointer utf8String) {
+        if (utf8String.isNull()) {
+            return null;
+        } else {
+            // UTF-8 does not break zero-terminated strings.
+            return toJavaStringWithCharset(utf8String, SubstrateUtil.strlen(utf8String), StandardCharsets.UTF_8);
+        }
+    }
+
     private static String toJavaStringWithCharset(CCharPointer cString, UnsignedWord length, Charset charset) {
         byte[] bytes = new byte[(int) length.rawValue()];
         for (int i = 0; i < bytes.length; i++) {

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jvmstat/PerfDataSupport.java

@@ -29,6 +29,7 @@
 import org.graalvm.nativeimage.ImageSingletons;
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platforms;
+import org.graalvm.nativeimage.c.type.CLongPointer;
 import org.graalvm.nativeimage.hosted.Feature;
 
 import com.oracle.svm.core.annotate.AutomaticFeature;
@@ -45,6 +46,8 @@ public interface PerfDataSupport {
     ByteBuffer createLong(String name, int variability, int units, long value);
 
     ByteBuffer createByteArray(String name, int variability, int units, byte[] value, int maxLength);
+
+    CLongPointer getLong(String name);
 }
 
 class NoPerfDataSupport implements PerfDataSupport {
@@ -81,6 +84,11 @@ public ByteBuffer createLong(String name, int variability, int units, long value
     public ByteBuffer createByteArray(String name, int variability, int units, byte[] value, int maxLength) {
         throw new IllegalArgumentException("Performance data is not supported.");
     }
+
+    @Override
+    public CLongPointer getLong(String name) {
+        throw new IllegalArgumentException("Performance data is not supported.");
+    }
 }
 
 @AutomaticFeature

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/thread/VMOperation.java

@@ -63,7 +63,7 @@ public final String getName() {
     }
 
     @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
-    protected boolean isGC() {
+    public boolean isGC() {
         return false;
     }
 

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/thread/VMOperationControl.java

@@ -255,6 +255,8 @@ void setInProgress(VMOperation operation, IsolateThread queueingThread, IsolateT
         inProgress.executingThread = executingThread;
         inProgress.operation = operation;
         inProgress.queueingThread = queueingThread;
+
+        VMOperationListenerSupport.get().vmOperationChanged(operation);
     }
 
     void enqueue(JavaVMOperation operation) {

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/thread/VMOperationListener.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2020, 2020, Oracle and/or its affiliates. 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.thread;
+
+import com.oracle.svm.core.annotate.Uninterruptible;
+
+public interface VMOperationListener {
+    @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
+    void vmOperationChanged(VMOperation operation);
+}

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/thread/VMOperationListenerFeature.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2020, 2020, Oracle and/or its affiliates. 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.thread;
+
+import org.graalvm.nativeimage.ImageSingletons;
+import org.graalvm.nativeimage.hosted.Feature;
+
+import com.oracle.svm.core.annotate.AutomaticFeature;
+
+@AutomaticFeature
+public class VMOperationListenerFeature implements Feature {
+    @Override
+    public void afterRegistration(AfterRegistrationAccess access) {
+        ImageSingletons.add(VMOperationListenerSupport.class, new VMOperationListenerSupport());
+    }
+}

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/thread/VMOperationListenerSupport.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2020, 2020, Oracle and/or its affiliates. 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.thread;
+
+import java.util.Arrays;
+
+import org.graalvm.compiler.api.replacements.Fold;
+import org.graalvm.nativeimage.ImageSingletons;
+import org.graalvm.nativeimage.Platform;
+import org.graalvm.nativeimage.Platforms;
+
+import com.oracle.svm.core.annotate.Uninterruptible;
+
+public class VMOperationListenerSupport {
+    private VMOperationListener[] listeners;
+
+    @Platforms(Platform.HOSTED_ONLY.class)
+    public VMOperationListenerSupport() {
+        listeners = new VMOperationListener[0];
+    }
+
+    @Platforms(Platform.HOSTED_ONLY.class)
+    public synchronized void register(VMOperationListener listener) {
+        assert listener != null;
+        int oldLength = listeners.length;
+        // We expect a very small number of listeners, so only increase the size by 1.
+        listeners = Arrays.copyOf(listeners, oldLength + 1);
+        listeners[oldLength] = listener;
+    }
+
+    @Fold
+    public static VMOperationListenerSupport get() {
+        return ImageSingletons.lookup(VMOperationListenerSupport.class);
+    }
+
+    @Uninterruptible(reason = "Force that all listeners are uninterruptible.")
+    public void vmOperationChanged(VMOperation operation) {
+        for (int i = 0; i < listeners.length; i++) {
+            listeners[i].vmOperationChanged(operation);
+        }
+    }
+}

substratevm/src/org.graalvm.polyglot.nativeapi/src/org/graalvm/polyglot/nativeapi/PolyglotNativeAPI.java

@@ -73,6 +73,7 @@
 import org.graalvm.polyglot.nativeapi.types.CInt16Pointer;
 import org.graalvm.polyglot.nativeapi.types.CInt32Pointer;
 import org.graalvm.polyglot.nativeapi.types.CInt64Pointer;
+import org.graalvm.polyglot.nativeapi.types.CInt64PointerPointer;
 import org.graalvm.polyglot.nativeapi.types.CInt8Pointer;
 import org.graalvm.polyglot.nativeapi.types.CUnsignedBytePointer;
 import org.graalvm.polyglot.nativeapi.types.CUnsignedIntPointer;
@@ -111,6 +112,7 @@
 import com.oracle.svm.core.c.CUnsigned;
 import com.oracle.svm.core.handles.ObjectHandlesImpl;
 import com.oracle.svm.core.handles.ThreadLocalHandles;
+import com.oracle.svm.core.jvmstat.PerfDataSupport;
 import com.oracle.svm.core.thread.ThreadingSupportImpl;
 import com.oracle.svm.core.threadlocal.FastThreadLocalFactory;
 import com.oracle.svm.core.threadlocal.FastThreadLocalObject;
@@ -335,7 +337,7 @@ public static PolyglotStatus poly_context_builder_engine(PolyglotIsolateThread t
     public static PolyglotStatus poly_context_builder_option(PolyglotIsolateThread thread, PolyglotContextBuilder context_builder, @CConst CCharPointer key_utf8, @CConst CCharPointer value_utf8) {
         resetErrorState();
         Context.Builder contextBuilder = fetchHandle(context_builder);
-        contextBuilder.option(CTypeConversion.toJavaString(key_utf8), CTypeConversion.toJavaString(value_utf8));
+        contextBuilder.option(CTypeConversion.utf8ToJavaString(key_utf8), CTypeConversion.utf8ToJavaString(value_utf8));
         return poly_ok;
     }
 
@@ -533,8 +535,8 @@ public static PolyglotStatus poly_context_eval(PolyglotIsolateThread thread, Pol
         resetErrorState();
         Context c = fetchHandle(context);
         String languageName = CTypeConversion.toJavaString(language_id);
-        String jName = CTypeConversion.toJavaString(name_utf8);
-        String jCode = CTypeConversion.toJavaString(source_utf8);
+        String jName = CTypeConversion.utf8ToJavaString(name_utf8);
+        String jCode = CTypeConversion.utf8ToJavaString(source_utf8);
 
         Source sourceCode = Source.newBuilder(languageName, jCode, jName).build();
         Value evalResult = c.eval(sourceCode);
@@ -663,7 +665,7 @@ public static PolyglotStatus poly_value_execute(PolyglotIsolateThread thread, Po
     public static PolyglotStatus poly_value_get_member(PolyglotIsolateThread thread, PolyglotValue value, @CConst CCharPointer utf8_identifier, PolyglotValuePointer result) {
         resetErrorState();
         Value jObject = fetchHandle(value);
-        result.write(createHandle(jObject.getMember(CTypeConversion.toJavaString(utf8_identifier))));
+        result.write(createHandle(jObject.getMember(CTypeConversion.utf8ToJavaString(utf8_identifier))));
         return poly_ok;
     }
 
@@ -680,7 +682,7 @@ public static PolyglotStatus poly_value_put_member(PolyglotIsolateThread thread,
         resetErrorState();
         Value jObject = fetchHandle(value);
         Value jMember = fetchHandle(member);
-        jObject.putMember(CTypeConversion.toJavaString(utf8_identifier), jMember);
+        jObject.putMember(CTypeConversion.utf8ToJavaString(utf8_identifier), jMember);
         return poly_ok;
     }
 
@@ -696,7 +698,7 @@ public static PolyglotStatus poly_value_put_member(PolyglotIsolateThread thread,
     public static PolyglotStatus poly_value_has_member(PolyglotIsolateThread thread, PolyglotValue value, @CConst CCharPointer utf8_identifier, CBoolPointer result) {
         resetErrorState();
         Value jObject = fetchHandle(value);
-        result.write(CTypeConversion.toCBoolean(jObject.hasMember(CTypeConversion.toJavaString(utf8_identifier))));
+        result.write(CTypeConversion.toCBoolean(jObject.hasMember(CTypeConversion.utf8ToJavaString(utf8_identifier))));
         return poly_ok;
     }
 
@@ -1603,7 +1605,7 @@ public static PolyglotStatus poly_get_callback_info(PolyglotIsolateThread thread
     @CEntryPoint(name = "poly_throw_exception", exceptionHandler = ExceptionHandler.class, documentation = {
                     "Raises an exception in a C callback.",
                     "",
-                    "Invocation of this method does not interrupt control-flow so it is neccesarry to return from a function after ",
+                    "Invocation of this method does not interrupt control-flow so it is necessary to return from a function after ",
                     "the exception has been raised. If this method is called multiple times only the last exception will be thrown in",
                     "in the guest language.",
                     "",
@@ -1612,7 +1614,7 @@ public static PolyglotStatus poly_get_callback_info(PolyglotIsolateThread thread
     })
     public static PolyglotStatus poly_throw_exception(PolyglotIsolateThread thread, @CConst CCharPointer utf8_message) {
         resetErrorState();
-        exceptionsTL.set(new CallbackException(CTypeConversion.toJavaString(utf8_message)));
+        exceptionsTL.set(new CallbackException(CTypeConversion.utf8ToJavaString(utf8_message)));
         return poly_ok;
     }
 
@@ -1864,6 +1866,22 @@ private static class PolyglotCallbackInfoInternal {
         }
     }
 
+    @CEntryPoint(name = "poly_perf_data_get_address_of_int64_t", exceptionHandler = ExceptionHandler.class, documentation = {
+                    "Gets the address of the int64_t value for a performance data entry of type long. Performance data support must be enabled.",
+                    "",
+                    " @param utf8_key UTF8-encoded, 0 terminated key that identifies the performance data entry.",
+                    " @param result a pointer to which the address of the int64_t value will be written.",
+                    " @return poly_ok if everything went ok, otherwise an error occurred.",
+                    " @since 22.3",
+    })
+    public static PolyglotStatus poly_perf_data_get_address_of_int64_t(PolyglotIsolateThread thread, CCharPointer utf8Key, CInt64PointerPointer result) {
+        resetErrorState();
+        String key = CTypeConversion.utf8ToJavaString(utf8Key);
+        CInt64Pointer ptr = (CInt64Pointer) ImageSingletons.lookup(PerfDataSupport.class).getLong(key);
+        result.write(ptr);
+        return poly_ok;
+    }
+
     private static void writeString(String valueString, CCharPointer buffer, UnsignedWord length, SizeTPointer result, Charset charset) {
         UnsignedWord stringLength = WordFactory.unsigned(valueString.getBytes(charset).length);
         if (buffer.isNull()) {