Separate ir tree generation from semantic checking (#59176)

This change creates a new phase to generate an ir tree once semantic checking is complete. The phase 
depends on the decorations generated during semantic checking against the user tree. Separation of 
the phases in this fashion will allow us to not generate an ir tree in the future when it's not necessary 
for features such as auto-completion or initial stored script compilation.

While the change is long, the majority follows the pattern of removing the ir tree generation from each 
user tree node and instead adding it the UserTreeToIRTreeVisitor along with some new decorations to 
support this.

Author: jdconrad

modules/lang-painless/src/main/java/org/elasticsearch/painless/Compiler.java

@@ -24,6 +24,7 @@
 import org.elasticsearch.painless.ir.ClassNode;
 import org.elasticsearch.painless.lookup.PainlessLookup;
 import org.elasticsearch.painless.node.SClass;
+import org.elasticsearch.painless.phase.UserTreeToIRTreeVisitor;
 import org.elasticsearch.painless.spi.Whitelist;
 import org.elasticsearch.painless.symbol.ScriptScope;
 import org.objectweb.asm.util.Printer;
@@ -211,7 +212,8 @@ ScriptScope compile(Loader loader, String name, String source, CompilerSettings
         ScriptClassInfo scriptClassInfo = new ScriptClassInfo(painlessLookup, scriptClass);
         SClass root = Walker.buildPainlessTree(scriptClassInfo, scriptName, source, settings);
         ScriptScope scriptScope = new ScriptScope(painlessLookup, settings, scriptClassInfo, scriptName, source, root.getIdentifier() + 1);
-        ClassNode classNode = root.analyze(scriptScope);
+        root.analyze(scriptScope);
+        ClassNode classNode = (ClassNode)new UserTreeToIRTreeVisitor().visitClass(root, scriptScope);
         DefBootstrapInjectionPhase.phase(classNode);
         ScriptInjectionPhase.phase(scriptScope, classNode);
         byte[] bytes = classNode.write();
@@ -241,7 +243,8 @@ byte[] compile(String name, String source, CompilerSettings settings, Printer de
         ScriptClassInfo scriptClassInfo = new ScriptClassInfo(painlessLookup, scriptClass);
         SClass root = Walker.buildPainlessTree(scriptClassInfo, scriptName, source, settings);
         ScriptScope scriptScope = new ScriptScope(painlessLookup, settings, scriptClassInfo, scriptName, source, root.getIdentifier() + 1);
-        ClassNode classNode = root.analyze(scriptScope);
+        root.analyze(scriptScope);
+        ClassNode classNode = (ClassNode)new UserTreeToIRTreeVisitor().visitClass(root, scriptScope);
         classNode.setDebugStream(debugStream);
         DefBootstrapInjectionPhase.phase(classNode);
         ScriptInjectionPhase.phase(scriptScope, classNode);

modules/lang-painless/src/main/java/org/elasticsearch/painless/antlr/Walker.java

@@ -113,8 +113,8 @@
 import org.elasticsearch.painless.node.AStatement;
 import org.elasticsearch.painless.node.EAssignment;
 import org.elasticsearch.painless.node.EBinary;
-import org.elasticsearch.painless.node.EBool;
-import org.elasticsearch.painless.node.EBoolean;
+import org.elasticsearch.painless.node.EBooleanComp;
+import org.elasticsearch.painless.node.EBooleanConstant;
 import org.elasticsearch.painless.node.EBrace;
 import org.elasticsearch.painless.node.ECall;
 import org.elasticsearch.painless.node.ECallLocal;
@@ -634,7 +634,7 @@ public ANode visitBool(BoolContext ctx) {
             throw location(ctx).createError(new IllegalStateException("illegal tree structure"));
         }
 
-        return new EBool(nextIdentifier(), location(ctx), left, right, operation);
+        return new EBooleanComp(nextIdentifier(), location(ctx), left, right, operation);
     }
 
     @Override
@@ -842,12 +842,12 @@ public ANode visitNumeric(NumericContext ctx) {
 
     @Override
     public ANode visitTrue(TrueContext ctx) {
-        return new EBoolean(nextIdentifier(), location(ctx), true);
+        return new EBooleanConstant(nextIdentifier(), location(ctx), true);
     }
 
     @Override
     public ANode visitFalse(FalseContext ctx) {
-        return new EBoolean(nextIdentifier(), location(ctx), false);
+        return new EBooleanConstant(nextIdentifier(), location(ctx), false);
     }
 
     @Override

modules/lang-painless/src/main/java/org/elasticsearch/painless/ir/ClassNode.java

@@ -24,8 +24,8 @@
 import org.elasticsearch.painless.MethodWriter;
 import org.elasticsearch.painless.ScriptClassInfo;
 import org.elasticsearch.painless.phase.IRTreeVisitor;
-import org.elasticsearch.painless.symbol.WriteScope;
 import org.elasticsearch.painless.symbol.ScriptScope;
+import org.elasticsearch.painless.symbol.WriteScope;
 import org.objectweb.asm.ClassVisitor;
 import org.objectweb.asm.Opcodes;
 import org.objectweb.asm.Type;

modules/lang-painless/src/main/java/org/elasticsearch/painless/ir/InstanceofNode.java

@@ -22,50 +22,28 @@
 import org.elasticsearch.painless.ClassWriter;
 import org.elasticsearch.painless.MethodWriter;
 import org.elasticsearch.painless.lookup.PainlessLookupUtility;
+import org.elasticsearch.painless.lookup.def;
 import org.elasticsearch.painless.phase.IRTreeVisitor;
 import org.elasticsearch.painless.symbol.WriteScope;
-import org.objectweb.asm.Type;
 
 public class InstanceofNode extends UnaryNode {
 
     /* ---- begin node data ---- */
-
+    
     private Class<?> instanceType;
-    private Class<?> resolvedType;
-    private boolean isPrimitiveResult;
 
     public void setInstanceType(Class<?> instanceType) {
         this.instanceType = instanceType;
     }
-    
+
     public Class<?> getInstanceType() {
         return instanceType;
     }
-    
+
     public String getInstanceCanonicalTypeName() {
         return PainlessLookupUtility.typeToCanonicalTypeName(instanceType);
     }
 
-    public void setResolvedType(Class<?> resolvedType) {
-        this.resolvedType = resolvedType;
-    }
-
-    public Class<?> getResolvedType() {
-        return resolvedType;
-    }
-
-    public String getResolvedCanonicalTypeName() {
-        return PainlessLookupUtility.typeToCanonicalTypeName(resolvedType);
-    }
-    
-    public void setPrimitiveResult(boolean isPrimitiveResult) {
-        this.isPrimitiveResult = isPrimitiveResult;
-    }
-
-    public boolean isPrimitiveResult() {
-        return isPrimitiveResult;
-    }
-
     /* ---- end node data, begin visitor ---- */
 
     @Override
@@ -79,15 +57,15 @@ public <Input, Output> Output visit(IRTreeVisitor<Input, Output> irTreeVisitor,
     protected void write(ClassWriter classWriter, MethodWriter methodWriter, WriteScope writeScope) {
         getChildNode().write(classWriter, methodWriter, writeScope);
 
-        // primitive types
-        if (isPrimitiveResult) {
-            // discard child's result result
+        if (instanceType == def.class) {
+            methodWriter.writePop(MethodWriter.getType(getExpressionType()).getSize());
+            methodWriter.push(true);
+        } else if (getChildNode().getExpressionType().isPrimitive()) {
             methodWriter.writePop(MethodWriter.getType(getExpressionType()).getSize());
-            // push our result: its' a primitive so it cannot be null
-            methodWriter.push(resolvedType.isAssignableFrom(instanceType));
+            methodWriter.push(PainlessLookupUtility.typeToBoxedType(instanceType).isAssignableFrom(
+                    PainlessLookupUtility.typeToBoxedType(getChildNode().getExpressionType())));
         } else {
-            // ordinary instanceof
-            methodWriter.instanceOf(Type.getType(resolvedType));
+            methodWriter.instanceOf(MethodWriter.getType(PainlessLookupUtility.typeToBoxedType(instanceType)));
         }
     }
 }

modules/lang-painless/src/main/java/org/elasticsearch/painless/node/AExpression.java

@@ -21,11 +21,9 @@
 
 import org.elasticsearch.painless.AnalyzerCaster;
 import org.elasticsearch.painless.Location;
-import org.elasticsearch.painless.ir.CastNode;
-import org.elasticsearch.painless.ir.ClassNode;
-import org.elasticsearch.painless.ir.ExpressionNode;
 import org.elasticsearch.painless.lookup.PainlessCast;
 import org.elasticsearch.painless.symbol.Decorations.Explicit;
+import org.elasticsearch.painless.symbol.Decorations.ExpressionPainlessCast;
 import org.elasticsearch.painless.symbol.Decorations.Internal;
 import org.elasticsearch.painless.symbol.Decorations.PartialCanonicalTypeName;
 import org.elasticsearch.painless.symbol.Decorations.StaticType;
@@ -38,14 +36,6 @@
  */
 public abstract class AExpression extends ANode {
 
-    public static class Output {
-
-        /**
-         * The {@link ExpressionNode}(s) generated from this expression.
-         */
-        ExpressionNode expressionNode = null;
-    }
-
     /**
      * Standard constructor with location used for error tracking.
      */
@@ -56,16 +46,16 @@ public static class Output {
     /**
      * Checks for errors and collects data for the writing phase.
      */
-    Output analyze(ClassNode classNode, SemanticScope semanticScope) {
+    void analyze(SemanticScope semanticScope) {
         throw new UnsupportedOperationException();
     }
 
     /**
      * Checks for errors and collects data for the writing phase. Adds additional, common
      * error checking for conditions related to static types and partially constructed static types.
      */
-    static Output analyze(AExpression expression, ClassNode classNode, SemanticScope semanticScope) {
-        Output output = expression.analyze(classNode, semanticScope);
+    static void analyze(AExpression expression, SemanticScope semanticScope) {
+        expression.analyze(semanticScope);
 
         if (semanticScope.hasDecoration(expression, PartialCanonicalTypeName.class)) {
             throw expression.createError(new IllegalArgumentException("cannot resolve symbol " +
@@ -80,8 +70,6 @@ static Output analyze(AExpression expression, ClassNode classNode, SemanticScope
         if (semanticScope.hasDecoration(expression, ValueType.class) == false) {
             throw expression.createError(new IllegalStateException("value required: instead found no value"));
         }
-
-        return output;
     }
 
     // TODO: move this somewhere more appropriate
@@ -91,20 +79,12 @@ public PainlessCast cast(SemanticScope semanticScope) {
         boolean isExplicitCast = semanticScope.getCondition(this, Explicit.class);
         boolean isInternalCast = semanticScope.getCondition(this, Internal.class);
 
-        return AnalyzerCaster.getLegalCast(getLocation(), valueType, targetType, isExplicitCast, isInternalCast);
-    }
+        PainlessCast painlessCast = AnalyzerCaster.getLegalCast(getLocation(), valueType, targetType, isExplicitCast, isInternalCast);
 
-    static ExpressionNode cast(ExpressionNode expressionNode, PainlessCast painlessCast) {
-        if (painlessCast == null) {
-            return expressionNode;
+        if (painlessCast != null) {
+            semanticScope.putDecoration(this, new ExpressionPainlessCast(painlessCast));
         }
 
-        CastNode castNode = new CastNode();
-        castNode.setLocation(expressionNode.getLocation());
-        castNode.setExpressionType(painlessCast.targetType);
-        castNode.setCast(painlessCast);
-        castNode.setChildNode(expressionNode);
-
-        return castNode;
+        return painlessCast;
     }
 }

modules/lang-painless/src/main/java/org/elasticsearch/painless/node/AStatement.java

@@ -20,23 +20,13 @@
 package org.elasticsearch.painless.node;
 
 import org.elasticsearch.painless.Location;
-import org.elasticsearch.painless.ir.ClassNode;
-import org.elasticsearch.painless.ir.StatementNode;
 import org.elasticsearch.painless.symbol.SemanticScope;
 
 /**
  * The superclass for all S* (statement) nodes.
  */
 public abstract class AStatement extends ANode {
 
-    public static class Output {
-
-        /**
-         * The {@link StatementNode}(s) generated from this expression.
-         */
-        StatementNode statementNode = null;
-    }
-
     /**
      * Standard constructor with location used for error tracking.
      */
@@ -47,7 +37,7 @@ public static class Output {
     /**
      * Checks for errors and collects data for the writing phase.
      */
-    Output analyze(ClassNode classNode, SemanticScope semanticScope) {
+    void analyze(SemanticScope semanticScope) {
         throw new UnsupportedOperationException();
     }
 }