[GR-57160] Refactorings around TypeSnippets and StrengthenGraphs.

PullRequest: graal/19435

Author: rmosaner

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/core/common/GraalOptions.java

@@ -336,4 +336,12 @@ public final class GraalOptions {
     @Option(help = "Optimize integer division operation by using various mathematical foundations to "
                     + " express it in faster, equivalent, arithmetic.", type = OptionType.Debug)
     public static final OptionKey<Boolean> OptimizeDiv = new OptionKey<>(true);
+
+    @Option(help = "If the probability that a type check will hit one of the profiled types (up to " +
+                   "TypeCheckMaxHints) is below this value, the type check will be compiled without profiling info.", type = OptionType.Debug)
+    public static final OptionKey<Double> TypeCheckMinProfileHitProbability = new OptionKey<>(0.5);
+
+    @Option(help = "The maximum number of profiled types that will be used when compiling a profiled type check. " +
+                    "Note that TypeCheckMinProfileHitProbability also influences whether profiling info is used in compiled type checks.", type = OptionType.Debug)
+    public static final OptionKey<Integer> TypeCheckMaxHints = new OptionKey<>(2);
 }

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/hotspot/replacements/HotspotSnippetsOptions.java

@@ -26,23 +26,14 @@
 
 import jdk.graal.compiler.options.EnumOptionKey;
 import jdk.graal.compiler.options.Option;
-import jdk.graal.compiler.options.OptionType;
 import jdk.graal.compiler.options.OptionKey;
+import jdk.graal.compiler.options.OptionType;
 
 /**
  * Options related to HotSpot snippets in this package.
  */
 public class HotspotSnippetsOptions {
-
     // @formatter:off
-    @Option(help = "If the probability that a type check will hit one the profiled types (up to " +
-                   "TypeCheckMaxHints) is below this value, the type check will be compiled without profiling info", type = OptionType.Debug)
-    public static final OptionKey<Double> TypeCheckMinProfileHitProbability = new OptionKey<>(0.5);
-
-    @Option(help = "The maximum number of profiled types that will be used when compiling a profiled type check. " +
-                    "Note that TypeCheckMinProfileHitProbability also influences whether profiling info is used in compiled type checks.", type = OptionType.Debug)
-    public static final OptionKey<Integer> TypeCheckMaxHints = new OptionKey<>(2);
-
     @Option(help = "Use a VM runtime call to load and clear the exception object from the thread at the start of a compiled exception handler.", type = OptionType.Debug)
     public static final OptionKey<Boolean> LoadExceptionObjectInVM = new OptionKey<>(false);
 

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/hotspot/replacements/InstanceOfSnippets.java

@@ -24,13 +24,13 @@
  */
 package jdk.graal.compiler.hotspot.replacements;
 
+import static jdk.graal.compiler.core.common.GraalOptions.TypeCheckMaxHints;
+import static jdk.graal.compiler.core.common.GraalOptions.TypeCheckMinProfileHitProbability;
 import static jdk.graal.compiler.hotspot.replacements.HotSpotReplacementsUtil.OPTIMIZING_PRIMARY_SUPERS_LOCATION;
 import static jdk.graal.compiler.hotspot.replacements.HotSpotReplacementsUtil.PRIMARY_SUPERS_LOCATION;
 import static jdk.graal.compiler.hotspot.replacements.HotSpotReplacementsUtil.SECONDARY_SUPER_CACHE_LOCATION;
 import static jdk.graal.compiler.hotspot.replacements.HotSpotReplacementsUtil.loadHubIntrinsic;
 import static jdk.graal.compiler.hotspot.replacements.HotSpotReplacementsUtil.loadHubOrNullIntrinsic;
-import static jdk.graal.compiler.hotspot.replacements.HotspotSnippetsOptions.TypeCheckMaxHints;
-import static jdk.graal.compiler.hotspot.replacements.HotspotSnippetsOptions.TypeCheckMinProfileHitProbability;
 import static jdk.graal.compiler.hotspot.replacements.TypeCheckSnippetUtils.checkSecondarySubType;
 import static jdk.graal.compiler.hotspot.replacements.TypeCheckSnippetUtils.checkUnknownSubType;
 import static jdk.graal.compiler.hotspot.replacements.TypeCheckSnippetUtils.createHints;

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/nodes/java/InstanceOfNode.java

@@ -30,6 +30,7 @@
 
 import java.util.Objects;
 
+import jdk.graal.compiler.core.common.NativeImageSupport;
 import jdk.graal.compiler.core.common.type.ObjectStamp;
 import jdk.graal.compiler.core.common.type.Stamp;
 import jdk.graal.compiler.core.common.type.StampFactory;
@@ -83,7 +84,7 @@ protected InstanceOfNode(NodeClass<? extends InstanceOfNode> c, ObjectStamp chec
         this.checkedStamp = checkedStamp;
         this.profile = profile;
         this.anchor = anchor;
-        assert (profile == null) || (anchor != null) : "profiles must be anchored";
+        assert NativeImageSupport.inBuildtimeCode() || (profile == null) || (anchor != null) : "profiles must be anchored";
         assert checkedStamp != null;
         assert type() != null;
     }
@@ -213,7 +214,7 @@ public void setProfile(JavaTypeProfile typeProfile, AnchoringNode anchor) {
         this.profile = typeProfile;
         updateUsagesInterface(this.anchor, anchor);
         this.anchor = anchor;
-        assert (profile == null) || (anchor != null) : "profiles must be anchored";
+        assert NativeImageSupport.inBuildtimeCode() || (profile == null) || (anchor != null) : "profiles must be anchored";
     }
 
     public AnchoringNode getAnchor() {

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/results/StrengthenGraphs.java

@@ -190,7 +190,7 @@ public boolean equals(Object obj) {
     private final StrengthenGraphsCounters afterCounters;
 
     /** Used to avoid aggressive optimizations for open type world analysis. */
-    private final boolean isClosedTypeWorld;
+    protected final boolean isClosedTypeWorld;
 
     public StrengthenGraphs(BigBang bb, Universe converter) {
         this.bb = bb;
@@ -515,6 +515,8 @@ public void simplify(Node n, SimplifierTool tool) {
                     AnalysisError.guarantee(node != replacement, "The new stamp needs to be different from the old stamp");
                     node.replaceAndDelete(replacement);
                     tool.addToWorkList(replacement);
+                } else {
+                    maybeAssignInstanceOfProfiles(node);
                 }
 
             } else if (n instanceof ClassIsAssignableFromNode node) {
@@ -1176,6 +1178,11 @@ private Stamp strengthenStamp(Stamp s) {
         }
     }
 
+    @SuppressWarnings("unused")
+    protected void maybeAssignInstanceOfProfiles(InstanceOfNode iof) {
+        // placeholder
+    }
+
     private static String getQualifiedName(StructuredGraph graph) {
         return ((AnalysisMethod) graph.method()).getQualifiedName();
     }

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/graal/snippets/OpenTypeWorldSnippets.java

@@ -62,7 +62,7 @@
 /**
  * GR-51603 Once this snippet logic reaches a steady-state merge with {@link TypeSnippets}.
  */
-public final class OpenTypeWorldSnippets extends SubstrateTemplates implements Snippets {
+public class OpenTypeWorldSnippets extends SubstrateTemplates implements Snippets {
 
     @Snippet
     protected static SubstrateIntrinsics.Any typeEqualitySnippet(
@@ -156,7 +156,7 @@ protected static SubstrateIntrinsics.Any classIsAssignableFromSnippet(
     }
 
     @DuplicatedInNativeCode
-    private static SubstrateIntrinsics.Any classTypeCheck(
+    protected static SubstrateIntrinsics.Any classTypeCheck(
                     int typeID,
                     int typeIDDepth,
                     DynamicHub checkedHub,
@@ -179,7 +179,7 @@ private static SubstrateIntrinsics.Any classTypeCheck(
     }
 
     @DuplicatedInNativeCode
-    private static SubstrateIntrinsics.Any interfaceTypeCheck(
+    protected static SubstrateIntrinsics.Any interfaceTypeCheck(
                     int typeID,
                     DynamicHub checkedHub,
                     SubstrateIntrinsics.Any trueValue,
@@ -200,27 +200,25 @@ private static SubstrateIntrinsics.Any interfaceTypeCheck(
         return falseValue;
     }
 
-    @SuppressWarnings("unused")
-    public static void registerLowerings(OptionValues options, Providers providers, Map<Class<? extends Node>, NodeLoweringProvider<?>> lowerings) {
-        new OpenTypeWorldSnippets(options, providers, lowerings);
+    public void registerLowerings(Map<Class<? extends Node>, NodeLoweringProvider<?>> lowerings, Providers providers) {
+        lowerings.put(InstanceOfNode.class, new InstanceOfLowering(options, providers));
+        lowerings.put(InstanceOfDynamicNode.class, new InstanceOfDynamicLowering(options, providers));
+        lowerings.put(ClassIsAssignableFromNode.class, new ClassIsAssignableFromLowering(options, providers));
     }
 
     final SnippetTemplate.SnippetInfo instanceOf;
     final SnippetTemplate.SnippetInfo instanceOfDynamic;
     final SnippetTemplate.SnippetInfo typeEquality;
     final SnippetTemplate.SnippetInfo assignableTypeCheck;
 
-    private OpenTypeWorldSnippets(OptionValues options, Providers providers, Map<Class<? extends Node>, NodeLoweringProvider<?>> lowerings) {
+    @SuppressWarnings("this-escape")
+    protected OpenTypeWorldSnippets(OptionValues options, Providers providers) {
         super(options, providers);
 
         this.instanceOf = snippet(providers, OpenTypeWorldSnippets.class, "instanceOfSnippet");
         this.instanceOfDynamic = snippet(providers, OpenTypeWorldSnippets.class, "instanceOfDynamicSnippet");
         this.typeEquality = snippet(providers, OpenTypeWorldSnippets.class, "typeEqualitySnippet");
         this.assignableTypeCheck = snippet(providers, OpenTypeWorldSnippets.class, "classIsAssignableFromSnippet");
-
-        lowerings.put(InstanceOfNode.class, new InstanceOfLowering(options, providers));
-        lowerings.put(InstanceOfDynamicNode.class, new InstanceOfDynamicLowering(options, providers));
-        lowerings.put(ClassIsAssignableFromNode.class, new ClassIsAssignableFromLowering(options, providers));
     }
 
     protected class InstanceOfLowering extends InstanceOfSnippetsTemplates implements NodeLoweringProvider<FloatingNode> {
@@ -244,26 +242,30 @@ protected SnippetTemplate.Arguments makeArguments(InstanceOfUsageReplacer replac
             SharedType type = (SharedType) typeReference.getType();
             DynamicHub hub = type.getHub();
 
+            SnippetTemplate.Arguments args;
             if (typeReference.isExact()) {
-                SnippetTemplate.Arguments args = new SnippetTemplate.Arguments(typeEquality, node.graph().getGuardsStage(), tool.getLoweringStage());
+                args = new SnippetTemplate.Arguments(typeEquality, node.graph().getGuardsStage(), tool.getLoweringStage());
                 args.add("object", node.getValue());
                 args.add("trueValue", replacer.trueValue);
                 args.add("falseValue", replacer.falseValue);
                 args.add("allowsNull", node.allowsNull());
                 args.add("exactType", hub);
-                return args;
-
             } else {
-                assert type.getSingleImplementor() == null : "Canonicalization of InstanceOfNode produces exact type for single implementor";
-                SnippetTemplate.Arguments args = new SnippetTemplate.Arguments(instanceOf, node.graph().getGuardsStage(), tool.getLoweringStage());
-                args.add("object", node.getValue());
-                args.add("trueValue", replacer.trueValue);
-                args.add("falseValue", replacer.falseValue);
-                args.add("allowsNull", node.allowsNull());
-                args.add("typeID", hub.getTypeID());
-                args.add("typeIDDepth", hub.getTypeIDDepth());
-                return args;
+                args = makeArgumentsForInexactType(replacer, tool, node, type, hub);
             }
+            return args;
+        }
+
+        protected SnippetTemplate.Arguments makeArgumentsForInexactType(InstanceOfUsageReplacer replacer, LoweringTool tool, InstanceOfNode node, SharedType type, DynamicHub hub) {
+            assert type.getSingleImplementor() == null : "Canonicalization of InstanceOfNode produces exact type for single implementor";
+            SnippetTemplate.Arguments args = new SnippetTemplate.Arguments(instanceOf, node.graph().getGuardsStage(), tool.getLoweringStage());
+            args.add("object", node.getValue());
+            args.add("trueValue", replacer.trueValue);
+            args.add("falseValue", replacer.falseValue);
+            args.add("allowsNull", node.allowsNull());
+            args.add("typeID", hub.getTypeID());
+            args.add("typeIDDepth", hub.getTypeIDDepth());
+            return args;
         }
     }
 

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/graal/snippets/SubstrateIntrinsics.java

@@ -24,22 +24,22 @@
  */
 package com.oracle.svm.core.graal.snippets;
 
+import org.graalvm.word.Pointer;
+
+import com.oracle.svm.core.hub.DynamicHub;
+
 import jdk.graal.compiler.core.common.spi.ForeignCallDescriptor;
 import jdk.graal.compiler.graph.Node.ConstantNodeParameter;
 import jdk.graal.compiler.graph.Node.NodeIntrinsic;
 import jdk.graal.compiler.nodes.BreakpointNode;
 import jdk.graal.compiler.nodes.extended.ForeignCallNode;
 import jdk.graal.compiler.nodes.extended.LoadHubNode;
 import jdk.graal.compiler.nodes.extended.LoadHubOrNullNode;
-import org.graalvm.word.Pointer;
-
-import com.oracle.svm.core.hub.DynamicHub;
-
 import jdk.vm.ci.meta.SpeculationLog.SpeculationReason;
 
 public class SubstrateIntrinsics {
 
-    protected interface Any {
+    public interface Any {
     }
 
     @NodeIntrinsic(LoadHubNode.class)

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/graal/snippets/TypeCheckFeature.java

@@ -0,0 +1,50 @@
+/*
+ * 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.graal.snippets;
+
+import java.util.Map;
+
+import com.oracle.svm.core.SubstrateOptions;
+import com.oracle.svm.core.feature.AutomaticallyRegisteredFeature;
+import com.oracle.svm.core.feature.InternalFeature;
+import com.oracle.svm.core.graal.meta.RuntimeConfiguration;
+
+import jdk.graal.compiler.graph.Node;
+import jdk.graal.compiler.options.OptionValues;
+import jdk.graal.compiler.phases.util.Providers;
+
+@AutomaticallyRegisteredFeature
+public class TypeCheckFeature implements InternalFeature {
+
+    @Override
+    public void registerLowerings(RuntimeConfiguration runtimeConfig, OptionValues options, Providers providers, Map<Class<? extends Node>, NodeLoweringProvider<?>> lowerings, boolean hosted) {
+        if (SubstrateOptions.useClosedTypeWorldHubLayout()) {
+            new TypeSnippets(options, providers).registerLowerings(lowerings, providers);
+        } else {
+            new OpenTypeWorldSnippets(options, providers).registerLowerings(lowerings, providers);
+            OpenTypeWorldDispatchTableSnippets.registerLowerings(options, providers, lowerings);
+        }
+    }
+}