[GR-63033] [GR-63361] Add specialized filter primitive flow for constant y operand

PullRequest: graal/20286

Author: d-kozak

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/PointsToAnalysis.java

@@ -647,6 +647,27 @@ public boolean finish() throws InterruptedException {
         }
     }
 
+    @Override
+    public void afterAnalysis() {
+        /*
+         * Only verify in the context-insensitive configuration as context-sensitive analysis is not
+         * compatible with predicates.
+         */
+        assert !PointstoOptions.AnalysisContextSensitivity.getValue(options).equals("insens") || validateFixedPointState();
+    }
+
+    /**
+     * This method checks that the typeflow graph is in a valid state when a fixed point is reached.
+     * The goal of this check is to detect cases where the analysis did not propagate all updates
+     * correctly (e.g. due to a concurrency bug) and provide concrete localized counter-examples to
+     * ease the debugging of such issues.
+     * <p/>
+     * As these checks can be expensive, this method should be executed only if asserts are enabled.
+     */
+    public boolean validateFixedPointState() {
+        return universe.getMethods().parallelStream().allMatch(m -> m.validateFixedPointState(this));
+    }
+
     @SuppressWarnings("try")
     public boolean doTypeflow() throws InterruptedException {
         boolean didSomeWork;

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

@@ -69,8 +69,11 @@ protected void onInputSaturated(PointsToAnalysis bb, TypeFlow<?> input) {
         }
     }
 
+    /**
+     * Filters the incoming type state using the declared type.
+     */
     @Override
-    public TypeState filter(PointsToAnalysis bb, TypeState update) {
+    protected TypeState processInputState(PointsToAnalysis bb, TypeState update) {
         if (declaredType.equals(bb.getObjectType())) {
             /* No need to filter. */
             return update;

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

@@ -57,8 +57,14 @@ public TypeFlow<BytecodePosition> copy(PointsToAnalysis bb, MethodFlowsGraph met
         return new BooleanInstanceOfCheckTypeFlow(methodFlows, this);
     }
 
+    /**
+     * Creates a primitive type state that corresponds to the result of a type check of the incoming
+     * value.
+     * 
+     * @return can be either empty, true, false, or any.
+     */
     @Override
-    public TypeState filter(PointsToAnalysis bb, TypeState update) {
+    protected TypeState processInputState(PointsToAnalysis bb, TypeState update) {
         TypeState canBeTrue;
         TypeState canBeFalse;
         if (isExact) {

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

@@ -48,8 +48,14 @@ public TypeFlow<BytecodePosition> copy(PointsToAnalysis bb, MethodFlowsGraph met
         return new BooleanNullCheckTypeFlow(methodFlows, this);
     }
 
+    /**
+     * Creates a primitive type state that corresponds to the result of a null check of the incoming
+     * value.
+     *
+     * @return can be either empty, true, false, or any.
+     */
     @Override
-    public TypeState filter(PointsToAnalysis bb, TypeState newState) {
+    protected TypeState processInputState(PointsToAnalysis bb, TypeState newState) {
         var hasNull = newState.canBeNull();
         var hasTypes = newState.typesCount() > 0;
         return convertToBoolean(bb, hasNull, hasTypes);

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

@@ -62,26 +62,22 @@ public TypeFlow<BytecodePosition> copy(PointsToAnalysis bb, MethodFlowsGraph met
         return new BooleanPrimitiveCheckTypeFlow(bb, methodFlows, this);
     }
 
-    @Override
-    public boolean addState(PointsToAnalysis bb, TypeState add) {
-        return super.addState(bb, eval(bb));
-    }
-
     @Override
     protected void onInputSaturated(PointsToAnalysis bb, TypeFlow<?> input) {
         /*
          * If an input saturated, it does not mean that the condition has to always saturate as
          * well, e.g. Any == {5} will return {5}.
          */
-        super.addState(bb, eval(bb));
+        addState(bb, TypeState.forEmpty());
     }
 
     /**
-     * Compares the type states of left and right.
+     * Computes new type state of this flow by comparing the type states of left and right.
      *
      * @return can be either empty, true, false, or any.
      */
-    public TypeState eval(PointsToAnalysis bb) {
+    @Override
+    protected TypeState processInputState(PointsToAnalysis bb, TypeState newState) {
         var leftState = left.getOutputState(bb);
         var rightState = right.getOutputState(bb);
         if (leftState.isEmpty() || rightState.isEmpty()) {

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

@@ -74,25 +74,24 @@ protected void onInputSaturated(PointsToAnalysis bb, TypeFlow<?> input) {
          * GR-58387: This could stop the propagation of saturation, so it can be problematic for
          * open-world analysis.
          */
-        super.addState(bb, eval(bb));
+        addState(bb, TypeState.forEmpty());
     }
 
     @Override
     public void onObservedUpdate(PointsToAnalysis bb) {
-        super.addState(bb, eval(bb));
+        addState(bb, TypeState.forEmpty());
     }
 
     @Override
     public void onObservedSaturated(PointsToAnalysis bb, TypeFlow<?> observed) {
-        super.addState(bb, eval(bb));
+        addState(bb, TypeState.forEmpty());
     }
 
+    /**
+     * Depending on the state of the condition, return none, one, or both of the true/false inputs.
+     */
     @Override
-    public boolean addState(PointsToAnalysis bb, TypeState add) {
-        return super.addState(bb, eval(bb));
-    }
-
-    private TypeState eval(PointsToAnalysis bb) {
+    protected TypeState processInputState(PointsToAnalysis bb, TypeState newState) {
         TypeState trueState = trueValue.getOutputState(bb);
         TypeState falseState = falseValue.getOutputState(bb);
         if (condition.isSaturated()) {

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

@@ -44,8 +44,11 @@ public FieldFilterTypeFlow(AnalysisField field) {
         super(field, field.getType());
     }
 
+    /**
+     * Filter the incoming type state based on the declared type.
+     */
     @Override
-    public TypeState filter(PointsToAnalysis bb, TypeState update) {
+    protected TypeState processInputState(PointsToAnalysis bb, TypeState update) {
         if (isPrimitiveFlow) {
             if (!update.isPrimitive()) {
                 /*

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

@@ -72,8 +72,11 @@ public TypeFlow<BytecodePosition> copy(PointsToAnalysis bb, MethodFlowsGraph met
         return new FilterTypeFlow(methodFlows, this);
     }
 
+    /**
+     * Filter the incoming type state using the checked type.
+     */
     @Override
-    public TypeState filter(PointsToAnalysis bb, TypeState update) {
+    protected TypeState processInputState(PointsToAnalysis bb, TypeState update) {
         TypeState result;
         if (isExact) {
             /*

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

@@ -52,8 +52,11 @@ public TypeFlow<BytecodePosition> copy(PointsToAnalysis bb, MethodFlowsGraph met
         return new FormalParamTypeFlow(this, methodFlows);
     }
 
+    /**
+     * Filters the incoming type state using the declared type.
+     */
     @Override
-    public TypeState filter(PointsToAnalysis bb, TypeState newState) {
+    protected TypeState processInputState(PointsToAnalysis bb, TypeState newState) {
         /*
          * If the type flow constraints are relaxed filter the incoming value using the parameter's
          * declared type.

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

@@ -48,8 +48,11 @@ public FormalReceiverTypeFlow copy(PointsToAnalysis bb, MethodFlowsGraph methodF
         return new FormalReceiverTypeFlow(this, methodFlows);
     }
 
+    /**
+     * Filters the incoming type state using the declared type.
+     */
     @Override
-    public TypeState filter(PointsToAnalysis bb, TypeState newState) {
+    protected TypeState processInputState(PointsToAnalysis bb, TypeState newState) {
         /*
          * If the type flow constraints are relaxed filter the incoming value using the receiver's
          * declared type.