Collect type flows that need initialization.

Author: cstancu

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/flow/AbstractStaticInvokeTypeFlow.java

@@ -47,6 +47,11 @@ public void initFlow(PointsToAnalysis bb) {
         bb.postFlow(this);
     }
 
+    @Override
+    public boolean needsInitialization() {
+        return true;
+    }
+
     @Override
     public String toString() {
         return "StaticInvoke<" + targetMethod.format("%h.%n") + ">" + ":" + getState();

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/flow/CallSiteSensitiveMethodTypeFlow.java

@@ -25,6 +25,7 @@
 package com.oracle.graal.pointsto.flow;
 
 import java.util.Collection;
+import java.util.List;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 
@@ -81,7 +82,7 @@ public MethodFlowsGraphInfo addContext(PointsToAnalysis bb, AnalysisContext call
     }
 
     @Override
-    protected void initFlowsGraph(PointsToAnalysis bb) {
+    protected void initFlowsGraph(PointsToAnalysis bb, List<TypeFlow<?>> postInitFlows) {
         // nothing to do, cloning does all the initialization
     }
 

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/flow/ConstantTypeFlow.java

@@ -66,6 +66,11 @@ public void initFlow(PointsToAnalysis bb) {
         addState(bb, constantState);
     }
 
+    @Override
+    public boolean needsInitialization() {
+        return true;
+    }
+
     @Override
     public String toString() {
         return "ConstantFlow<" + getState() + ">";

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/flow/DynamicNewInstanceTypeFlow.java

@@ -70,6 +70,11 @@ public void initFlow(PointsToAnalysis bb) {
         this.newTypeFlow.addObserver(bb, this);
     }
 
+    @Override
+    public boolean needsInitialization() {
+        return true;
+    }
+
     @Override
     public void onObservedUpdate(PointsToAnalysis bb) {
         /* The state of the new type provider has changed. */

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/flow/LoadFieldTypeFlow.java

@@ -74,6 +74,11 @@ public void initFlow(PointsToAnalysis bb) {
             fieldFlow.addUse(bb, this);
         }
 
+        @Override
+        public boolean needsInitialization() {
+            return true;
+        }
+
         @Override
         public String toString() {
             return "LoadStaticFieldTypeFlow<" + getState() + ">";

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/flow/MethodFlowsGraph.java

@@ -111,16 +111,6 @@ public <T extends TypeFlow<?>> T lookupCloneOf(@SuppressWarnings("unused") Point
         return original;
     }
 
-    public void init(final PointsToAnalysis bb) {
-        for (TypeFlow<?> flow : flows()) {
-            /*
-             * Run initialization code for corner case type flows. This can be used to add link from
-             * 'outside' into the graph.
-             */
-            flow.initFlow(bb);
-        }
-    }
-
     protected static boolean nonCloneableFlow(TypeFlow<?> flow) {
         /*
          * References to field flows and to array elements flows are not part of the method itself;

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/flow/MethodFlowsGraphClone.java

@@ -120,12 +120,6 @@ private <V extends TypeFlow<?>> List<V> lookupClonesOf(PointsToAnalysis bb, List
         return result;
     }
 
-    @Override
-    public void init(final PointsToAnalysis bb) {
-        // the cloning mechanism does all the initialization
-        throw AnalysisError.shouldNotReachHere();
-    }
-
     @Override
     @SuppressWarnings("unchecked")
     public <T extends TypeFlow<?>> T lookupCloneOf(PointsToAnalysis bb, T original) {
@@ -175,7 +169,9 @@ void linkCloneFlows(final PointsToAnalysis bb) {
              * Run initialization code for corner case type flows. This can be used to add link from
              * 'outside' into the graph.
              */
-            clone.initFlow(bb);
+            if (clone.needsInitialization()) {
+                clone.initFlow(bb);
+            }
 
             /* Link all 'internal' observers. */
             for (TypeFlow<?> originalObserver : original.getObservers()) {

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/flow/MethodTypeFlow.java

@@ -39,6 +39,7 @@
 import org.graalvm.compiler.nodes.ValueNode;
 
 import com.oracle.graal.pointsto.PointsToAnalysis;
+import com.oracle.graal.pointsto.flow.builder.TypeFlowGraphBuilder;
 import com.oracle.graal.pointsto.meta.AnalysisMethod;
 import com.oracle.graal.pointsto.meta.PointsToAnalysisMethod;
 import com.oracle.graal.pointsto.typestate.TypeState;
@@ -173,7 +174,7 @@ private synchronized void createFlowsGraph(PointsToAnalysis bb, InvokeTypeFlow r
                 flowsGraph = builder.flowsGraph;
                 assert flowsGraph != null;
 
-                initFlowsGraph(bb);
+                initFlowsGraph(bb, builder.postInitFlows);
             } catch (Throwable t) {
                 /* Wrap all other errors as parsing errors. */
                 throw AnalysisError.parsingError(method, t);
@@ -202,8 +203,18 @@ private static int computeReturnedParameterIndex(StructuredGraph graph) {
         }
     }
 
-    protected void initFlowsGraph(PointsToAnalysis bb) {
-        flowsGraph.init(bb);
+    /**
+     * Run type flow initialization. This will trigger state propagation from source flows, link
+     * static load/store field flows, publish unsafe load/store flows, etc. The flows that need
+     * initialization are collected by {@link TypeFlowGraphBuilder#build()}. Their initialization
+     * needs to be triggered only after the graph is fully materialized such that lazily constructed
+     * type flows (like InovkeTypeFlow.actualReturn) can observe the type state that other flows may
+     * generate on initialization.
+     */
+    protected void initFlowsGraph(PointsToAnalysis bb, List<TypeFlow<?>> postInitFlows) {
+        for (TypeFlow<?> flow : postInitFlows) {
+            flow.initFlow(bb);
+        }
     }
 
     public Collection<MethodFlowsGraph> getFlows() {
@@ -320,7 +331,7 @@ public synchronized boolean updateFlowsGraph(PointsToAnalysis bb, MethodFlowsGra
 
             flowsGraph.updateInternalState(newGraphKind);
 
-            initFlowsGraph(bb);
+            initFlowsGraph(bb, builder.postInitFlows);
 
             if (registerAsImplementationInvoked) {
                 if (parsingReason == null) {

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/flow/MethodTypeFlowBuilder.java

@@ -161,6 +161,7 @@ public class MethodTypeFlowBuilder {
     private final boolean newFlowsGraph;
 
     protected final TypeFlowGraphBuilder typeFlowGraphBuilder;
+    protected List<TypeFlow<?>> postInitFlows = List.of();
 
     public MethodTypeFlowBuilder(PointsToAnalysis bb, PointsToAnalysisMethod method, MethodFlowsGraph flowsGraph, GraphKind graphKind) {
         this.bb = bb;
@@ -555,8 +556,8 @@ private void createTypeFlow() {
         // Propagate the type flows through the method's graph
         new NodeIterator(graph.start(), typeFlows).apply();
 
-        /* Prune the method graph. Eliminate nodes with no uses. */
-        typeFlowGraphBuilder.build();
+        /* Prune the method graph. Eliminate nodes with no uses. Collect flows that need init. */
+        postInitFlows = typeFlowGraphBuilder.build();
 
         /*
          * Make sure that all existing InstanceOfNodes are registered even when only used as an

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/flow/NewInstanceTypeFlow.java

@@ -74,6 +74,11 @@ public void initFlow(PointsToAnalysis bb) {
         }
     }
 
+    @Override
+    public boolean needsInitialization() {
+        return true;
+    }
+
     NewInstanceTypeFlow(PointsToAnalysis bb, NewInstanceTypeFlow original, MethodFlowsGraph methodFlows) {
         super(original, methodFlows, original.createCloneState(bb, methodFlows));
     }