[GR-7776] [GR-8823] [GR-9063] [GR-9179] Implement new instrumentation features.

PullRequest: fastr/1462

com.oracle.truffle.r.parser/src/com/oracle/truffle/r/parser/DefaultRParserFactory.java

@@ -62,6 +62,26 @@ public class DefaultRParserFactory extends RParserFactory {
             }
         }
 
+        @Override
+        public List<T> statements(Source source, Source fullSource, int startLine, RCodeBuilder<T> builder, TruffleRLanguage language) throws ParseException {
+            try {
+                try {
+                    RContext context = language.getContextReference().get();
+                    RParser<T> parser = new RParser<>(source, fullSource, startLine, builder, language, context.sourceCache);
+                    return parser.script();
+                } catch (IllegalArgumentException e) {
+                    // the lexer will wrap exceptions in IllegalArgumentExceptions
+                    if (e.getCause() instanceof RecognitionException) {
+                        throw (RecognitionException) e.getCause();
+                    } else {
+                        throw e;
+                    }
+                }
+            } catch (RecognitionException e) {
+                throw handleRecognitionException(source, e);
+            }
+        }
+
         @Override
         public RootCallTarget rootFunction(Source source, String name, RCodeBuilder<T> builder, TruffleRLanguage language) throws ParseException {
             RContext context = language.getContextReference().get();

com.oracle.truffle.r.parser/src/com/oracle/truffle/r/parser/ParserGeneration.java

@@ -98,6 +98,7 @@ public class ParserGeneration {
         "allow everything but newlines in %<ident>% operators",
         "allow strings in :: and :::",
         "use file for interactive single-line source",
-        ":: and ::: do not set argument names"
+        ":: and ::: do not set argument names",
+        "refactored: use file for interactive single-line source"
     };
 }

com.oracle.truffle.r.parser/src/com/oracle/truffle/r/parser/R.g

@@ -75,90 +75,25 @@ import com.oracle.truffle.r.runtime.RError;
     private TruffleRLanguage language;
     private int fileStartOffset = 0;
     private Map<String, Source> sourceCache;
-    
-    /**
-     * Always use this constructor to initialize the R specific fields.
-     */
+
     public RParser(Source source, RCodeBuilder<T> builder, TruffleRLanguage language, Map<String, Source> sourceCache) {
         super(new CommonTokenStream(new RLexer(new ANTLRStringStream(source.getCharacters().toString()))));
         assert source != null && builder != null;
         this.initialSource = source;
         this.builder = builder;
         this.language = language;
-        this.sourceCache = sourceCache;
-        if (source.getURI() != null && source.getName().contains("#")) {
-        	this.source = createFullSource(source);
-        } else {
-        	this.source = source;
-        }
+        this.source = source;
     }
-    
-    private Source createFullSource(Source original) {
-	    String originalName = original.getName();
 
-	    // check if source name is like 'path/to/source.R#45-54'
-	    int hash_idx = originalName.lastIndexOf("#");
-	    if (hash_idx == -1) {
-	        return original;
-	    }
-
-	    String fileName = originalName.substring(0, hash_idx);
-	    String lineRange = originalName.substring(hash_idx + 1);
-
-	    try {
-	        // check for line range, e.g. '45-54'
-	        int startLine = -1;
-	        int endLine = -1;
-	        int dashIdx = lineRange.indexOf('-');
-	        if (dashIdx != -1) {
-	            startLine = Integer.parseInt(lineRange.substring(0, dashIdx));
-	            endLine = Integer.parseInt(lineRange.substring(dashIdx + 1));
-	        } else {
-	            startLine = Integer.parseInt(lineRange);
-	            endLine = startLine;
-	        }
-	        File f = new File(fileName);
-	        Source fullSource;
-	        String canonicalName;
-	        try {
-	            canonicalName = f.getAbsoluteFile().getCanonicalPath();
-	            fullSource = sourceCache != null ? sourceCache.get(canonicalName) : null;
-	        } catch(IOException e) {
-	            // ignore an freshly load file
-	            fullSource = null;
-	            canonicalName = null;
-	        }
-            if(fullSource == null) {
-    	        Builder<IOException, RuntimeException, RuntimeException> newBuilder = Source.newBuilder(f);
-    	        if (original.isInteractive()) {
-    	            newBuilder.interactive();
-    	        }
-    	        fullSource = newBuilder.build();
-    	        
-    	        if (sourceCache != null && canonicalName != null) {
-    	        	sourceCache.put(canonicalName, fullSource);
-    	        }
-            }
-
-	        // verify to avoid accidentally matching file names
-	        for (int i = 0; i < endLine - startLine + 1; i++) {
-	            if (!original.getCharacters(i + 1).equals(fullSource.getCharacters(startLine + i))) {
-	                return original;
-	            }
-	        }
-
-	        fileStartOffset = -fullSource.getLineStartOffset(startLine);
-	        return fullSource;
-	    } catch (NumberFormatException e) {
-	        // invalid line number
-	    } catch (IllegalArgumentException e) {
-            // file name is accidentally named in the expected scheme
-	    } catch (IOException e) {
-	    } catch (RuntimeException e) {
-	    	assert rethrow(e);
-	    }
-	    return original;
-	}
+    public RParser(Source source, Source fullSource, int startLine, RCodeBuilder<T> builder, TruffleRLanguage language, Map<String, Source> sourceCache) {
+        super(new CommonTokenStream(new RLexer(new ANTLRStringStream(source.getCharacters().toString()))));
+        assert source != null && builder != null;
+        this.initialSource = source;
+        this.builder = builder;
+        this.language = language;
+        this.source = fullSource;
+        fileStartOffset = -fullSource.getLineStartOffset(startLine);
+    }
         
     private <T extends Throwable> boolean rethrow(T e) throws T {
     	throw e;

com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/RParserFactory.java

 /*
- * Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2018, 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
@@ -37,6 +37,8 @@ public abstract class RParserFactory {
     public interface Parser<T> {
         List<T> script(Source source, RCodeBuilder<T> builder, TruffleRLanguage language) throws ParseException;
 
+        List<T> statements(Source source, Source fullSource, int startLine, RCodeBuilder<T> builder, TruffleRLanguage language) throws ParseException;
+
         RootCallTarget rootFunction(Source source, String name, RCodeBuilder<T> builder, TruffleRLanguage language) throws ParseException;
 
         boolean isRecognitionException(Throwable t);

com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/RootBodyNode.java

+/*
+ * Copyright (c) 2018, 2018, 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.
+ *
+ * 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.truffle.r.runtime;
+
+import com.oracle.truffle.api.frame.VirtualFrame;
+import com.oracle.truffle.api.instrumentation.ProbeNode;
+import com.oracle.truffle.api.instrumentation.StandardTags.RootTag;
+import com.oracle.truffle.api.instrumentation.Tag;
+import com.oracle.truffle.r.runtime.nodes.RInstrumentableNode;
+import com.oracle.truffle.r.runtime.nodes.RNode;
+import com.oracle.truffle.r.runtime.nodes.instrumentation.RRootBodyNodeWrapper;
+
+/**
+ * Marks a node that represents the body of a {@link com.oracle.truffle.api.nodes.RootNode}, such
+ * nodes are tagged with {@link com.oracle.truffle.api.instrumentation.StandardTags.RootTag} and
+ * should inherit {@link RNode}.
+ *
+ * The {@link RootBodyNode} task is to save the arguments from frame's arguments array to the local
+ * variables and then invoke the actual body statement accessible via {@link #getBody()}.
+ */
+public interface RootBodyNode extends RInstrumentableNode {
+    RNode getBody();
+
+    Object visibleExecute(VirtualFrame frame);
+
+    @Override
+    default boolean isInstrumentable() {
+        return true;
+    }
+
+    @Override
+    default boolean hasTag(Class<? extends Tag> tag) {
+        return tag == RootTag.class;
+    }
+
+    @Override
+    default WrapperNode createWrapper(ProbeNode probe) {
+        return new RRootBodyNodeWrapper(this, probe);
+    }
+}

com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/RootWithBody.java

 /*
- * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2018, 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
@@ -22,12 +22,16 @@
  */
 package com.oracle.truffle.r.runtime;
 
-import com.oracle.truffle.r.runtime.nodes.RNode;
+import com.oracle.truffle.r.runtime.nodes.RSyntaxNode;
 
 /**
- * Used for testing.
+ * Used to allow access to the body field for testing purposes.
  */
 public interface RootWithBody {
 
-    RNode getBody();
+    /**
+     * Should return the real body, i.e. what is wrapped by {@link RootBodyNode}.
+     */
+    RSyntaxNode getBody();
+
 }

com.oracle.truffle.r.runtime/src/com/oracle/truffle/r/runtime/nodes/instrumentation/RRootBodyNodeWrapper.java

+/*
+ * Copyright (c) 2018, 2018, 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.
+ *
+ * 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.truffle.r.runtime.nodes.instrumentation;
+
+import com.oracle.truffle.api.frame.VirtualFrame;
+import com.oracle.truffle.api.instrumentation.InstrumentableNode;
+import com.oracle.truffle.api.instrumentation.ProbeNode;
+import com.oracle.truffle.api.nodes.Node;
+import com.oracle.truffle.api.nodes.NodeCost;
+import com.oracle.truffle.api.nodes.NodeInfo;
+import com.oracle.truffle.api.source.SourceSection;
+import com.oracle.truffle.r.runtime.RootBodyNode;
+import com.oracle.truffle.r.runtime.nodes.RNode;
+
+@NodeInfo(cost = NodeCost.NONE)
+public final class RRootBodyNodeWrapper extends Node implements RootBodyNode, InstrumentableNode.WrapperNode {
+    @Child private RootBodyNode delegate;
+    @Child private ProbeNode probeNode;
+
+    public RRootBodyNodeWrapper(RootBodyNode delegate, ProbeNode probeNode) {
+        assert delegate != null;
+        assert !(delegate instanceof RRootBodyNodeWrapper);
+        this.delegate = delegate;
+        this.probeNode = probeNode;
+    }
+
+    @Override
+    public Node getDelegateNode() {
+        return (Node) delegate;
+    }
+
+    @Override
+    public ProbeNode getProbeNode() {
+        return probeNode;
+    }
+
+    @Override
+    public Object visibleExecute(VirtualFrame frame) {
+        Object returnValue;
+        for (;;) {
+            boolean wasOnReturnExecuted = false;
+            try {
+                probeNode.onEnter(frame);
+                returnValue = delegate.visibleExecute(frame);
+                wasOnReturnExecuted = true;
+                probeNode.onReturnValue(frame, returnValue);
+                break;
+            } catch (Throwable t) {
+                Object result = probeNode.onReturnExceptionalOrUnwind(frame, t, wasOnReturnExecuted);
+                if (result == ProbeNode.UNWIND_ACTION_REENTER) {
+                    continue;
+                } else if (result != null) {
+                    returnValue = result;
+                    break;
+                }
+                throw t;
+            }
+        }
+        return returnValue;
+    }
+
+    @Override
+    public RNode getBody() {
+        return delegate.getBody();
+    }
+
+    @Override
+    public SourceSection getSourceSection() {
+        return ((Node) delegate).getSourceSection();
+    }
+}

com.oracle.truffle.r.test/src/com/oracle/truffle/r/test/tck/FastRDebugTest.java

@@ -39,7 +39,6 @@ import java.util.concurrent.atomic.AtomicInteger;
 import org.junit.After;
 import org.junit.Assert;
 import org.junit.Before;
-import org.junit.Ignore;
 import org.junit.Test;
 
 import com.oracle.truffle.api.debug.Breakpoint;
@@ -498,7 +497,6 @@ public class FastRDebugTest {
     }
 
     @Test
-    @Ignore
     public void testReenterArgumentsAndValues() throws Throwable {
         // Test that after a re-enter, arguments are kept and variables are cleared.
         final Source source = sourceFromText("" +
@@ -719,7 +717,7 @@ public class FastRDebugTest {
             }
             assertNotNull("identifier \"" + expectedIdentifier + "\" not found", value);
             String valueStr = value.as(String.class);
-            assertEquals(expectedValueStr, valueStr);
+            assertEquals(line + ": " + code + "; identifier: '" + expectedIdentifier + "'", expectedValueStr, valueStr);
         }
 
         if (!run.isEmpty()) {

mx.fastr/suite.py

@@ -231,6 +231,7 @@ suite = {
       "sourceDirs" : ["src"],
       "dependencies" : [
         "sdk:GRAAL_SDK",
+        "sdk:LAUNCHER_COMMON",
         "truffle:JLINE",
       ],
       "checkstyle" : "com.oracle.truffle.r.runtime",