[GR-40630] Support profile module.

PullRequest: graalpython/2418

Author: tomasstupka

docs/user/Tooling.md

@@ -39,7 +39,7 @@ For example, it does not currently track calls, only line counts and called func
 The `_lsprof` built-in module has been implemented using the GraalVM `cpusampler` tool.
 Not all profiling features are currently supported, but basic profiling works:
 ```shell
-graalpy -m cProfile -s sort -m ginstall --help
+graalpy -m cProfile -s calls -m ginstall --help
 ```
 
 The interactive exploration of a stats output file also works:
@@ -50,3 +50,24 @@ ginstall.profile%
 callers
 [...]
 ```
+
+The profile module works as well:
+```shell
+graalpy -m profile -s calls -m ginstall --help
+```
+or
+```shell
+>>> import profile
+>>> profile.run('l = []; l.append(1)')
+         5 function calls in 0.002 seconds
+
+   Ordered by: standard name
+
+   ncalls  tottime  percall  cumtime  percall filename:lineno(function)
+        1    0.000    0.000    0.000    0.000 :0(_setprofile)
+        1    0.000    0.000    0.000    0.000 :0(append)
+        1    0.000    0.000    0.001    0.001 :0(exec)
+        1    0.000    0.000    0.000    0.000 <string>:1(<module>)
+        1    0.001    0.001    0.002    0.002 profile:0(l = []; l.append(1))
+        0    0.000             0.000          profile:0(profiler)
+```

graalpython/com.oracle.graal.python.test/src/com/oracle/graal/python/test/runtime/ProfileTests.java

@@ -0,0 +1,96 @@
+/*
+ * Copyright (c) 2022, 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.test.runtime;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import com.oracle.graal.python.test.PythonTests;
+
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+
+import static org.junit.Assert.assertEquals;
+
+public class ProfileTests {
+
+    @Before
+    public void ensureBytecode() {
+        PythonTests.skipOnLegacyASTInterpreter();
+    }
+
+    @Test
+    public void profileYield() {
+        String source = "import sys\n" +
+                        "def f(frame, event, arg): print(frame, event, arg)\n" +
+                        "def fg(): yield 42\n" +
+                        "g = fg()\n" +
+                        "sys.setprofile(f)\n" +
+                        "for i in g: pass";
+        assertPrints("fg> call None\n" +
+                        "fg> return 42\n" +
+                        "fg> call None\n" +
+                        "fg> return None\n" +
+                        "<module>> return None\n", source);
+    }
+
+    @Test
+    public void profileException() {
+        String source = "import sys\n" +
+                        "def f(frame, event, arg): print(frame, event, arg)\n" +
+                        "sys.setprofile(f)\n" +
+                        "try:\n" +
+                        "  max(0)\n" +
+                        "except Exception:\n" +
+                        "  pass\n";
+        assertPrints("<module>> c_call <built-in function max>\n" +
+                        "<module>> c_exception <built-in function max>\n" +
+                        "<module>> return None\n", source);
+    }
+
+    private static void assertPrints(String expected, String code) {
+        final ByteArrayOutputStream byteArray = new ByteArrayOutputStream();
+        final PrintStream printStream = new PrintStream(byteArray);
+        PythonTests.runScript(new String[0], code, printStream, System.err);
+        String result = byteArray.toString().replaceAll("\r\n", "\n");
+        assertEquals(expected, result.replaceAll(".*code ", ""));
+    }
+}

graalpython/com.oracle.graal.python.test/src/tests/unittest_tags/test_profile.txt

@@ -0,0 +1,6 @@
+*graalpython.lib-python.3.test.test_profile.ProfileTest.test_calling_conventions
+*graalpython.lib-python.3.test.test_profile.ProfileTest.test_cprofile
+*graalpython.lib-python.3.test.test_profile.ProfileTest.test_run
+*graalpython.lib-python.3.test.test_profile.ProfileTest.test_run_profile_as_module
+*graalpython.lib-python.3.test.test_profile.ProfileTest.test_runctx
+*graalpython.lib-python.3.test.test_profile.TestMain.test_main

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/PythonLanguage.java

@@ -213,10 +213,10 @@ public final class PythonLanguage extends TruffleLanguage<PythonContext> {
     private static final LanguageReference<PythonLanguage> REFERENCE = LanguageReference.create(PythonLanguage.class);
 
     /**
-     * This assumption will be valid if no context set a trace function at any point. Calling
-     * sys.settrace(None) will not invalidate it
+     * This assumption will be valid if no context set a trace or profile function at any point.
+     * Calling sys.settrace(None) or sys.setprofile(None) will not invalidate it
      */
-    public final Assumption noTracingAssumption = Assumption.create("No tracing function was set");
+    public final Assumption noTracingOrProfilingAssumption = Assumption.create("No tracing function was set");
 
     @CompilationFinal private boolean singleContext = true;
 

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/LsprofModuleBuiltins.java

@@ -41,6 +41,7 @@
 package com.oracle.graal.python.builtins.modules;
 
 import static com.oracle.graal.python.nodes.SpecialMethodNames.J___INIT__;
+import static com.oracle.graal.python.util.PythonUtils.toTruffleStringUncached;
 
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -320,7 +321,7 @@ private static Object[] getProfilerEntry(ProfilerNode<Payload> node, double avgS
             int selfHitCount = node.getPayload().getSelfHitCount();
             long hitCount = (long) otherHitCount + selfHitCount;
             Object[] profilerEntry = new Object[]{
-                            rootName,
+                            toTruffleStringUncached(rootName),
                             hitCount,
                             0,
                             otherHitCount * avgSampleTime,

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/SysModuleBuiltins.java

@@ -539,6 +539,7 @@ public void postInitialize0(Python3Core core) {
 
         if (context.getOption(PythonOptions.EnableBytecodeInterpreter)) {
             sys.setAttribute(tsLiteral("settrace"), sys.getAttribute(tsLiteral("_settrace")));
+            sys.setAttribute(tsLiteral("setprofile"), sys.getAttribute(tsLiteral("_setprofile")));
         }
 
         TruffleString coreHome = context.getCoreHome();
@@ -1010,6 +1011,27 @@ Object settrace(Object function) {
         }
     }
 
+    @Builtin(name = "_setprofile", minNumOfPositionalArgs = 1, parameterNames = {
+                    "function"}, doc = "Set the profiling function.  It will be called on each function call\nand return.  See the profiler chapter in the library manual.")
+    @GenerateNodeFactory
+    abstract static class SetProfile extends PythonBuiltinNode {
+        @Specialization
+        Object settrace(Object function) {
+            PythonContext ctx = getContext();
+            if (!ctx.getOption(PythonOptions.EnableBytecodeInterpreter)) {
+                throw raise(NotImplementedError, ErrorMessages.SETPROFILE_NOT_IMPLEMENTED);
+            }
+            PythonLanguage language = getLanguage();
+            PythonContext.PythonThreadState state = ctx.getThreadState(language);
+            if (function == PNone.NONE) {
+                state.setProfileFun(null, language);
+            } else {
+                state.setProfileFun(function, language);
+            }
+            return PNone.NONE;
+        }
+    }
+
     @Builtin(name = "gettrace")
     @GenerateNodeFactory
     abstract static class GetTrace extends PythonBuiltinNode {
@@ -1023,6 +1045,18 @@ Object gettrace() {
         }
     }
 
+    @Builtin(name = "getprofile")
+    @GenerateNodeFactory
+    abstract static class GetProfile extends PythonBuiltinNode {
+        @Specialization
+        Object getProfile() {
+            PythonContext ctx = getContext();
+            PythonContext.PythonThreadState state = ctx.getThreadState(getLanguage());
+            Object trace = state.getProfileFun();
+            return trace == null ? PNone.NONE : trace;
+        }
+    }
+
     @Builtin(name = J_UNRAISABLEHOOK, minNumOfPositionalArgs = 2, maxNumOfPositionalArgs = 2, declaresExplicitSelf = true, doc = "unraisablehook($module, unraisable, /)\n" +
                     "--\n" +
                     "\n" +

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

@@ -1457,6 +1457,7 @@ public abstract class ErrorMessages {
     public static final TruffleString HPY_DEBUG_MODE_NOT_AVAILABLE = tsLiteral("HPy debug mode is not available");
 
     public static final TruffleString SETTRACE_NOT_IMPLEMENTED = tsLiteral("sys.settrace is only implemented for the bytecode interpreter.");
+    public static final TruffleString SETPROFILE_NOT_IMPLEMENTED = tsLiteral("sys.setprofile is only implemented for the bytecode interpreter.");
     public static final TruffleString ATTRIBUTE_VALUE_MUST_BE_BOOL = tsLiteral("attribute value type must be bool");
     public static final TruffleString HPY_UNEXPECTED_HPY_NULL = tsLiteral("unexpected HPy_NULL");
     public static final TruffleString TOKEN_ALREADY_USED = tsLiteral("%s has already been used once");