[GR-9307] Wrap the body of FunctionRootNode and ModuleRootNode in a node that has the RootTag, so restarting with clearing the frame works

Author: timfel

graalpython/com.oracle.graal.python.test/src/com/oracle/graal/python/test/grammar/TestParserTranslator.java

@@ -86,6 +86,7 @@
 import com.oracle.graal.python.nodes.frame.WriteNode;
 import com.oracle.graal.python.nodes.function.FunctionDefinitionNode;
 import com.oracle.graal.python.nodes.function.GeneratorExpressionNode;
+import com.oracle.graal.python.nodes.function.InnerRootNode;
 import com.oracle.graal.python.nodes.generator.DictConcatNode;
 import com.oracle.graal.python.nodes.literal.BooleanLiteralNode;
 import com.oracle.graal.python.nodes.literal.ComplexLiteralNode;
@@ -155,6 +156,8 @@ private Node unpackModuleBodyWrappers(Node n) {
             if (((WriteLocalVariableNode) n).getIdentifier().equals(FrameSlotIDs.RETURN_SLOT_ID)) {
                 actual = ((WriteLocalVariableNode) n).getRhs();
             }
+        } else if (n instanceof InnerRootNode) {
+            actual = n.getChildren().iterator().next();
         }
         if (actual == n) {
             return n;

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/code/PCode.java

@@ -204,7 +204,7 @@ private static String extractName(RootNode rootNode) {
         if (rootNode instanceof ModuleRootNode) {
             name = rootNode.getName();
         } else if (rootNode instanceof FunctionRootNode) {
-            name = ((FunctionRootNode) rootNode).getFunctionName();
+            name = ((FunctionRootNode) rootNode).getName();
         } else {
             name = rootNode.getName();
         }

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/ModuleRootNode.java

@@ -28,6 +28,7 @@
 import com.oracle.graal.python.PythonLanguage;
 import com.oracle.graal.python.nodes.expression.ExpressionNode;
 import com.oracle.graal.python.nodes.frame.WriteGlobalNode;
+import com.oracle.graal.python.nodes.function.InnerRootNode;
 import com.oracle.truffle.api.CompilerAsserts;
 import com.oracle.truffle.api.CompilerDirectives;
 import com.oracle.truffle.api.frame.FrameDescriptor;
@@ -49,7 +50,7 @@ public ModuleRootNode(PythonLanguage language, String name, String doc, Expressi
         super(language, descriptor, freeVarSlots);
         this.name = "<module '" + name + "'>";
         this.doc = doc;
-        this.body = file;
+        this.body = new InnerRootNode(this, file);
     }
 
     private WriteGlobalNode getWriteModuleDoc() {
@@ -62,15 +63,15 @@ private WriteGlobalNode getWriteModuleDoc() {
 
     @Override
     public Object execute(VirtualFrame frame) {
+        return body.execute(frame);
+    }
+
+    @Override
+    public void initializeFrame(VirtualFrame frame) {
         addClosureCellsToLocals(frame);
         if (doc != null) {
             getWriteModuleDoc().doWrite(frame, doc);
         }
-        return body.execute(frame);
-    }
-
-    public ExpressionNode getBody() {
-        return body;
     }
 
     @Override
@@ -84,10 +85,6 @@ public String getName() {
         return name;
     }
 
-    public String getDoc() {
-        return doc;
-    }
-
     @Override
     public SourceSection getSourceSection() {
         return body.getSourceSection();

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/NodeFactory.java

@@ -134,18 +134,15 @@ public <T> T duplicate(Node orig, Class<T> clazz) {
     }
 
     public ModuleRootNode createModuleRoot(String name, String doc, ExpressionNode file, FrameDescriptor fd) {
-        file.markAsRoot();
         return new ModuleRootNode(language, name, doc, file, fd, null);
     }
 
     public FunctionRootNode createFunctionRoot(SourceSection sourceSection, String functionName, boolean isGenerator, FrameDescriptor frameDescriptor, ExpressionNode body,
                     ExecutionCellSlots cellSlots) {
-        body.markAsRoot();
         return new FunctionRootNode(language, sourceSection, functionName, isGenerator, frameDescriptor, body, cellSlots);
     }
 
     public ClassBodyRootNode createClassBodyRoot(SourceSection sourceSection, String functionName, FrameDescriptor frameDescriptor, ExpressionNode body, ExecutionCellSlots cellSlots) {
-        body.markAsRoot();
         return new ClassBodyRootNode(language, sourceSection, functionName, frameDescriptor, body, cellSlots);
     }
 

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/PClosureRootNode.java

@@ -47,6 +47,7 @@
 import com.oracle.truffle.api.frame.Frame;
 import com.oracle.truffle.api.frame.FrameDescriptor;
 import com.oracle.truffle.api.frame.FrameSlot;
+import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.nodes.ExplodeLoop;
 
 public abstract class PClosureRootNode extends PRootNode {
@@ -89,6 +90,8 @@ public boolean hasFreeVars() {
         return freeVarSlots != null && freeVarSlots.length > 0;
     }
 
+    public abstract void initializeFrame(VirtualFrame frame);
+
     public String[] getFreeVars() {
         if (freeVarSlots != null) {
             String[] freeVars = new String[freeVarSlots.length];

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/PNode.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2018, Oracle and/or its affiliates.
+ * Copyright (c) 2017, 2019, Oracle and/or its affiliates.
  * Copyright (c) 2013, Regents of the University of California
  *
  * All rights reserved.
@@ -32,18 +32,13 @@
 import com.oracle.truffle.api.dsl.ImportStatic;
 import com.oracle.truffle.api.dsl.TypeSystemReference;
 import com.oracle.truffle.api.instrumentation.InstrumentableNode;
-import com.oracle.truffle.api.instrumentation.StandardTags;
-import com.oracle.truffle.api.instrumentation.Tag;
 import com.oracle.truffle.api.source.SourceSection;
 
 @TypeSystemReference(PythonTypes.class)
 @ImportStatic({PGuards.class, PythonOptions.class, SpecialMethodNames.class, SpecialAttributeNames.class, BuiltinNames.class})
 public abstract class PNode extends PNodeWithContext implements InstrumentableNode {
-
     public static final PNode[] EMPTY_ARRAY = new PNode[0];
-
     @CompilationFinal private SourceSection sourceSection;
-    @CompilationFinal private boolean isRoot = false;
 
     @Override
     public String toString() {
@@ -68,19 +63,7 @@ public void assignSourceSection(SourceSection source) {
         this.sourceSection = source;
     }
 
-    public boolean hasTag(Class<? extends Tag> tag) {
-        return isRoot && tag == StandardTags.RootTag.class;
-    }
-
     public boolean isInstrumentable() {
         return getSourceSection() != null;
     }
-
-    public void markAsRoot() {
-        isRoot = true;
-    }
-
-    public boolean isRoot() {
-        return isRoot;
-    }
 }

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/function/FunctionRootNode.java

@@ -73,23 +73,11 @@ public FunctionRootNode(PythonLanguage language, SourceSection sourceSection, St
         assert sourceSection != null;
         this.functionName = functionName;
         this.isGenerator = isGenerator;
-        this.body = NodeUtil.cloneNode(body);
+        this.body = new InnerRootNode(this, NodeUtil.cloneNode(body));
         this.uninitializedBody = NodeUtil.cloneNode(body);
         this.generatorFrameProfile = isGenerator ? ValueProfile.createClassProfile() : null;
     }
 
-    public String getFunctionName() {
-        return functionName;
-    }
-
-    public ExpressionNode getBody() {
-        return body;
-    }
-
-    public ExpressionNode getUninitializedBody() {
-        return uninitializedBody;
-    }
-
     @Override
     public String getName() {
         return functionName;
@@ -145,7 +133,6 @@ public Object execute(VirtualFrame frame) {
         if (CompilerDirectives.inInterpreter() || CompilerDirectives.inCompilationRoot()) {
             contextRef.get().triggerAsyncActions();
         }
-        initClosureAndCellVars(frame);
         return body.execute(frame);
     }
 
@@ -167,4 +154,9 @@ public boolean isRewritten() {
     public void setRewritten() {
         this.isRewritten = true;
     }
+
+    @Override
+    public void initializeFrame(VirtualFrame frame) {
+        initClosureAndCellVars(frame);
+    }
 }

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/function/InnerRootNode.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * The Universal Permissive License (UPL), Version 1.0
+ *
+ * Subject to the condition set forth below, permission is hereby granted to any
+ * person obtaining a copy of this software, associated documentation and/or
+ * data (collectively the "Software"), free of charge and under any and all
+ * copyright rights in the Software, and any and all patent rights owned or
+ * freely licensable by each licensor hereunder covering either (i) the
+ * unmodified Software as contributed to or provided by such licensor, or (ii)
+ * the Larger Works (as defined below), to deal in both
+ *
+ * (a) the Software, and
+ *
+ * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+ * one is included with the Software each a "Larger Work" to which the Software
+ * is contributed by such licensors),
+ *
+ * without restriction, including without limitation the rights to copy, create
+ * derivative works of, display, perform, and distribute the Software and make,
+ * use, sell, offer for sale, import, export, have made, and have sold the
+ * Software and the Larger Work(s), and to sublicense the foregoing rights on
+ * either these or other terms.
+ *
+ * This license is subject to the following condition:
+ *
+ * The above copyright notice and either this complete permission notice or at a
+ * minimum a reference to the UPL must be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package com.oracle.graal.python.nodes.function;
+
+import com.oracle.graal.python.nodes.PClosureRootNode;
+import com.oracle.graal.python.nodes.expression.ExpressionNode;
+import com.oracle.truffle.api.frame.VirtualFrame;
+import com.oracle.truffle.api.instrumentation.StandardTags;
+import com.oracle.truffle.api.instrumentation.Tag;
+
+/**
+ * The sole purpose of this class is to handle the pre-amble of the root node, so that frame
+ * restarting works when instrumented.
+ */
+public class InnerRootNode extends ExpressionNode {
+    @Child private ExpressionNode body;
+    private final PClosureRootNode root;
+
+    public InnerRootNode(PClosureRootNode functionRootNode, ExpressionNode body) {
+        this.body = body;
+        this.assignSourceSection(body.getSourceSection());
+        this.root = functionRootNode;
+    }
+
+    @Override
+    public Object execute(VirtualFrame frame) {
+        root.initializeFrame(frame);
+        return body.execute(frame);
+    }
+
+    @Override
+    public boolean hasTag(Class<? extends Tag> tag) {
+        return StandardTags.RootTag.class == tag;
+    }
+
+    @Override
+    public boolean hasSideEffectAsAnExpression() {
+        return true;
+    }
+}

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/generator/GeneratorFunctionRootNode.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2019, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * The Universal Permissive License (UPL), Version 1.0
@@ -87,4 +87,9 @@ public RootNode getFunctionRootNode() {
     public String getName() {
         return name;
     }
+
+    @Override
+    public void initializeFrame(VirtualFrame frame) {
+        // nothing to do
+    }
 }

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/parser/GeneratorTranslator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2018, Oracle and/or its affiliates.
+ * Copyright (c) 2017, 2019, Oracle and/or its affiliates.
  * Copyright (c) 2013, Regents of the University of California
  *
  * All rights reserved.
@@ -46,6 +46,7 @@
 import com.oracle.graal.python.nodes.frame.WriteNode;
 import com.oracle.graal.python.nodes.function.FunctionRootNode;
 import com.oracle.graal.python.nodes.function.GeneratorExpressionNode;
+import com.oracle.graal.python.nodes.function.InnerRootNode;
 import com.oracle.graal.python.nodes.generator.AbstractYieldNode;
 import com.oracle.graal.python.nodes.generator.GeneratorBlockNode;
 import com.oracle.graal.python.nodes.generator.GeneratorControlNode;
@@ -316,6 +317,10 @@ private void replaceControl(PNode node) {
 
         } else if (node instanceof StatementNode) {
             // do nothing for now
+
+        } else if (node instanceof InnerRootNode) {
+            // nothing to do
+
         } else {
             replaceYieldExpression(node);
         }