[GR-64193] Vector API runtime compilation support

PullRequest: graal/20544

Author: gergo-

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/core/common/spi/JavaConstantFieldProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2025, 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
@@ -174,6 +174,27 @@ protected boolean isSyntheticEnumSwitchMap(ResolvedJavaField field) {
     private final ResolvedJavaField stringHashField;
 
     protected boolean isWellKnownImplicitStableField(ResolvedJavaField field) {
+        if (isArray(field) && field.isFinal() && field.getName().equals("cache")) {
+            ResolvedJavaType type = field.getDeclaringClass();
+            String typeName = type.getName();
+            if (typeName.equals("Ljdk/incubator/vector/VectorOperators$ImplCache;")) {
+                return true;
+            }
+        }
+        if (field.getName().equals("dummyVector")) {
+            ResolvedJavaType type = field.getDeclaringClass();
+            String typeName = type.getName();
+            if (typeName.equals("Ljdk/incubator/vector/AbstractSpecies;")) {
+                return true;
+            }
+        }
+        if (field.getName().equals("asIntegral") || field.getName().equals("asFloating")) {
+            ResolvedJavaType type = field.getDeclaringClass();
+            String typeName = type.getName();
+            if (typeName.equals("Ljdk/incubator/vector/LaneType;")) {
+                return true;
+            }
+        }
         return field.equals(stringValueField);
     }
 }

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/replacements/nodes/MacroNode.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2025, 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
@@ -24,9 +24,11 @@
  */
 package jdk.graal.compiler.replacements.nodes;
 
-import static jdk.vm.ci.code.BytecodeFrame.isPlaceholderBci;
 import static jdk.graal.compiler.nodeinfo.NodeCycles.CYCLES_UNKNOWN;
 import static jdk.graal.compiler.nodeinfo.NodeSize.SIZE_UNKNOWN;
+import static jdk.vm.ci.code.BytecodeFrame.isPlaceholderBci;
+
+import org.graalvm.word.LocationIdentity;
 
 import jdk.graal.compiler.core.common.type.ObjectStamp;
 import jdk.graal.compiler.core.common.type.StampPair;
@@ -47,8 +49,6 @@
 import jdk.graal.compiler.nodes.ValueNode;
 import jdk.graal.compiler.nodes.graphbuilderconf.GraphBuilderContext;
 import jdk.graal.compiler.nodes.java.MethodCallTargetNode;
-import org.graalvm.word.LocationIdentity;
-
 import jdk.vm.ci.meta.JavaKind;
 import jdk.vm.ci.meta.ResolvedJavaMethod;
 
@@ -243,6 +243,15 @@ public final boolean hasSideEffect() {
         return true;
     }
 
+    /**
+     * Returns {@code true} if the lowered version of the macro, or the fallback invoke, can
+     * deoptimize in any way or throw any implicit or explicit exception. Such nodes should be
+     * represented as {@link MacroWithExceptionNode} in SVM runtime compilations.
+     */
+    public boolean canDeoptimizeOrThrow() {
+        return true;
+    }
+
     /**
      * Returns {@link LocationIdentity#any()}. This node needs to kill any location because it might
      * get {@linkplain MacroInvokable#replaceWithInvoke() replaced with an invoke} and

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/code/FrameInfoQueryResult.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2025, 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
@@ -26,7 +26,6 @@
 
 import static com.oracle.svm.core.Uninterruptible.CALLED_FROM_UNINTERRUPTIBLE_CODE;
 
-import jdk.graal.compiler.word.Word;
 import org.graalvm.nativeimage.c.function.CodePointer;
 
 import com.oracle.svm.core.CalleeSavedRegisters;
@@ -40,6 +39,7 @@
 
 import jdk.graal.compiler.core.common.SuppressFBWarnings;
 import jdk.graal.compiler.nodes.FrameState;
+import jdk.graal.compiler.word.Word;
 import jdk.vm.ci.code.Register;
 import jdk.vm.ci.code.StackSlot;
 import jdk.vm.ci.code.VirtualObject;
@@ -105,7 +105,7 @@ public enum ValueType {
         }
     }
 
-    public static class ValueInfo {
+    public static final class ValueInfo {
         protected ValueType type;
         protected JavaKind kind;
         protected boolean isCompressedReference; // for JavaKind.Object
@@ -159,6 +159,23 @@ public long getData() {
         public JavaConstant getValue() {
             return value;
         }
+
+        /**
+         * Copy {@code this} value info, with all fields unchanged except for the {@link #getKind()}
+         * replaced by the given {@code kind} and the {@link #getData()} adjusted (not replaced!) by
+         * the given {@code offset}. This is used to access element information for special compound
+         * objects like Vector API values.
+         */
+        public ValueInfo copyForElement(JavaKind javaKind, int offset) {
+            ValueInfo copy = new ValueInfo();
+            copy.type = type;
+            copy.kind = javaKind;
+            copy.isCompressedReference = isCompressedReference;
+            copy.isEliminatedMonitor = isEliminatedMonitor;
+            copy.data = data + offset;
+            copy.value = value;
+            return copy;
+        }
     }
 
     protected FrameInfoQueryResult caller;

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/deopt/DeoptState.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2024, 2025, 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
@@ -24,6 +24,17 @@
  */
 package com.oracle.svm.core.deopt;
 
+import static com.oracle.svm.core.deopt.Deoptimizer.fatalDeoptimizationError;
+
+import java.lang.reflect.Array;
+
+import org.graalvm.nativeimage.CurrentIsolate;
+import org.graalvm.nativeimage.ImageSingletons;
+import org.graalvm.nativeimage.IsolateThread;
+import org.graalvm.word.Pointer;
+import org.graalvm.word.SignedWord;
+import org.graalvm.word.UnsignedWord;
+
 import com.oracle.svm.core.ReservedRegisters;
 import com.oracle.svm.core.code.FrameInfoQueryResult;
 import com.oracle.svm.core.config.ConfigurationValues;
@@ -32,20 +43,12 @@
 import com.oracle.svm.core.hub.DynamicHub;
 import com.oracle.svm.core.hub.LayoutEncoding;
 import com.oracle.svm.core.meta.SubstrateObjectConstant;
-import jdk.internal.misc.Unsafe;
+
 import jdk.graal.compiler.core.common.util.TypeConversion;
 import jdk.graal.compiler.word.Word;
+import jdk.internal.misc.Unsafe;
 import jdk.vm.ci.meta.JavaConstant;
 import jdk.vm.ci.meta.JavaKind;
-import org.graalvm.nativeimage.CurrentIsolate;
-import org.graalvm.nativeimage.IsolateThread;
-import org.graalvm.word.Pointer;
-import org.graalvm.word.SignedWord;
-import org.graalvm.word.UnsignedWord;
-
-import java.lang.reflect.Array;
-
-import static com.oracle.svm.core.deopt.Deoptimizer.fatalDeoptimizationError;
 
 public class DeoptState {
 
@@ -162,6 +165,16 @@ private Object materializeObject(int virtualObjectId, FrameInfoQueryResult sourc
         materializedObjects[virtualObjectId] = obj;
         Deoptimizer.maybeTestGC();
 
+        if (ImageSingletons.contains(VectorAPIDeoptimizationSupport.class)) {
+            VectorAPIDeoptimizationSupport deoptSupport = ImageSingletons.lookup(VectorAPIDeoptimizationSupport.class);
+            Object payloadArray = deoptSupport.materializePayload(this, hub, encodings[curIdx], sourceFrame);
+            if (payloadArray != null) {
+                JavaConstant arrayConstant = SubstrateObjectConstant.forObject(payloadArray, ReferenceAccess.singleton().haveCompressedReferences());
+                Deoptimizer.writeValueInMaterializedObj(obj, curOffset, arrayConstant, sourceFrame);
+                return obj;
+            }
+        }
+
         while (curIdx < encodings.length) {
             FrameInfoQueryResult.ValueInfo value = encodings[curIdx];
             JavaKind kind = value.getKind();

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/deopt/VectorAPIDeoptimizationSupport.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2025, 2025, 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.deopt;
+
+import org.graalvm.word.UnsignedWord;
+
+import com.oracle.svm.core.code.FrameInfoQueryResult;
+import com.oracle.svm.core.hub.DynamicHub;
+import com.oracle.svm.core.util.VMError;
+
+import jdk.vm.ci.meta.JavaConstant;
+
+/**
+ * Support for deoptimization with virtual Vector API objects in the state. This class is a
+ * placeholder until GR-59869 is done.
+ */
+public abstract class VectorAPIDeoptimizationSupport {
+
+    /**
+     * If the {@code hub} refers to a Vector API vector, materialize its payload array. That is,
+     * allocate a primitive array of the appropriate element type and length for the Vector API
+     * value. Read the vector's entries from the stack and store them in the array.
+     *
+     * @param deoptState state for accessing values on the stack
+     * @param hub the hub of the object to be materialized
+     * @param vectorEncoding describes the location of the vector on the stack
+     * @param sourceFrame the source frame containing the vector
+     * @return a materialized primitive array if the object to be materialized is a Vector API
+     *         vector; {@code null} otherwise
+     */
+    public Object materializePayload(DeoptState deoptState, DynamicHub hub, FrameInfoQueryResult.ValueInfo vectorEncoding, FrameInfoQueryResult sourceFrame) {
+        throw VMError.intentionallyUnimplemented();
+    }
+
+    protected static JavaConstant readValue(DeoptState deoptState, FrameInfoQueryResult.ValueInfo valueInfo, FrameInfoQueryResult sourceFrame) {
+        return deoptState.readValue(valueInfo, sourceFrame);
+    }
+
+    protected static void writeValueInMaterializedObj(Object materializedObj, UnsignedWord offsetInObj, JavaConstant constant, FrameInfoQueryResult frameInfo) {
+        Deoptimizer.writeValueInMaterializedObj(materializedObj, offsetInObj, constant, frameInfo);
+    }
+}

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/Target_jdk_internal_vm_vector_VectorSupport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2023, 2025, 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
@@ -60,6 +60,18 @@ private static final class Target_jdk_incubator_vector_VectorOperators_Conversio
          * their hot path callers and their callees are all @ForceInline.
          */
 
+        @AnnotateOriginal
+        @AlwaysInline("Vector API performance")
+        native char kind();
+
+        @AnnotateOriginal
+        @AlwaysInline("Vector API performance")
+        native Target_jdk_incubator_vector_LaneType domain();
+
+        @AnnotateOriginal
+        @AlwaysInline("Vector API performance")
+        native Target_jdk_incubator_vector_LaneType range();
+
         @AnnotateOriginal
         @AlwaysInline("Vector API performance")
         private static native Target_jdk_incubator_vector_VectorOperators_ConversionImpl<?, ?> ofCopy(Target_jdk_incubator_vector_LaneType dom);

substratevm/src/com.oracle.svm.graal/src/com/oracle/svm/graal/hosted/runtimecompilation/RuntimeCompiledMethodSupport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2023, 2025, 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
@@ -486,7 +486,8 @@ public static class ConvertMacroNodes extends Phase {
         @Override
         protected void run(StructuredGraph graph) {
             for (Node n : graph.getNodes().snapshot()) {
-                VMError.guarantee(!(n instanceof MacroNode), "DeoptTarget Methods do not support Macro Nodes: method %s, node %s", graph.method(), n);
+                VMError.guarantee(!(n instanceof MacroNode macro && macro.canDeoptimizeOrThrow()), "DeoptTarget Methods do not support Macro Nodes that may deopt or throw: method %s, node %s",
+                                graph.method(), n);
 
                 if (n instanceof MacroWithExceptionNode macro) {
                     macro.replaceWithInvoke();