[GR-13225] [GR-10752] Implement PEP 553 breakpoint() message

PullRequest: graalpython/391

Author: timfel

ci.jsonnet

@@ -127,7 +127,7 @@
 
   local labsjdk8Mixin = {
     downloads +: {
-      JAVA_HOME: utils.download("labsjdk", "8u172-jvmci-0.48"),
+      JAVA_HOME: utils.download("labsjdk", "8u192-jvmci-0.54"),
       EXTRA_JAVA_HOMES : { pathlist: [utils.download("oraclejdk", "11+20")] },
     },
     environment +: {

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

@@ -55,7 +55,8 @@
 import static com.oracle.graal.python.nodes.BuiltinNames.ROUND;
 import static com.oracle.graal.python.nodes.BuiltinNames.SETATTR;
 import static com.oracle.graal.python.nodes.BuiltinNames.SUM;
-import static com.oracle.graal.python.nodes.BuiltinNames.__BREAKPOINT__;
+import static com.oracle.graal.python.nodes.BuiltinNames.BREAKPOINT;
+import static com.oracle.graal.python.nodes.BuiltinNames.BREAKPOINTHOOK;
 import static com.oracle.graal.python.nodes.BuiltinNames.__BUILTIN__;
 import static com.oracle.graal.python.nodes.BuiltinNames.__DEBUG__;
 import static com.oracle.graal.python.nodes.BuiltinNames.__DUMP_TRUFFLE_AST__;
@@ -93,6 +94,7 @@
 import com.oracle.graal.python.builtins.objects.bytes.PBytes;
 import com.oracle.graal.python.builtins.objects.code.PCode;
 import com.oracle.graal.python.builtins.objects.common.HashingCollectionNodes;
+import com.oracle.graal.python.builtins.objects.common.HashingStorageNodes;
 import com.oracle.graal.python.builtins.objects.common.PHashingCollection;
 import com.oracle.graal.python.builtins.objects.common.SequenceNodes;
 import com.oracle.graal.python.builtins.objects.common.SequenceStorageNodes;
@@ -168,6 +170,7 @@
 import com.oracle.truffle.api.CompilerDirectives;
 import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
+import com.oracle.truffle.api.debug.Debugger;
 import com.oracle.truffle.api.Truffle;
 import com.oracle.truffle.api.dsl.Cached;
 import com.oracle.truffle.api.dsl.Fallback;
@@ -1501,12 +1504,33 @@ public Object setAttr(Object object, Object key, Object value,
         }
     }
 
-    @Builtin(name = __BREAKPOINT__, fixedNumOfPositionalArgs = 0)
+    @Builtin(name = BREAKPOINT, takesVarArgs = true, takesVarKeywordArgs = true)
     @GenerateNodeFactory
     public abstract static class BreakPointNode extends PythonBuiltinNode {
+        @Child HashingStorageNodes.GetItemNode getSysModuleNode;
+        @Child ReadAttributeFromObjectNode getBreakpointhookNode;
+        @Child CallNode callNode;
+
         @Specialization
-        public Object doIt() {
-            return PNone.NONE;
+        public Object doIt(VirtualFrame frame, Object[] args, PKeyword[] kwargs) {
+            if (Debugger.find(getContext().getEnv()).getSessionCount() > 0) {
+                // we already have a Truffle debugger attached, it'll stop here
+                return PNone.NONE;
+            } else {
+                if (getSysModuleNode == null) {
+                    CompilerDirectives.transferToInterpreterAndInvalidate();
+                    getSysModuleNode = insert(HashingStorageNodes.GetItemNode.create());
+                    getBreakpointhookNode = insert(ReadAttributeFromObjectNode.create());
+                    callNode = insert(CallNode.create());
+                }
+                PDict sysModules = getContext().getSysModules();
+                Object sysModule = getSysModuleNode.execute(sysModules.getDictStorage(), "sys");
+                Object breakpointhook = getBreakpointhookNode.execute(sysModule, BREAKPOINTHOOK);
+                if (breakpointhook == PNone.NO_VALUE) {
+                    throw raise(PythonBuiltinClassType.RuntimeError, "lost sys.breakpointhook");
+                }
+                return callNode.execute(frame, breakpointhook, args, kwargs);
+            }
         }
     }
 

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/BuiltinNames.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
@@ -45,17 +45,18 @@ public abstract class BuiltinNames {
     public static final String SELF = "self";
 
     // graalpython internals
-    public static final String __BREAKPOINT__ = "__breakpoint__";
     public static final String __BUILTINS_PATCHES__ = "__builtins_patches__";
 
     // cpython internals
+    public static final String BREAKPOINT = "breakpoint";
     public static final String MODULE = "module";
     public static final String __BUILD_CLASS__ = "__build_class__";
     public static final String __MAIN__ = "__main__";
     public static final String __BUILTINS__ = "__builtins__";
     public static final String __DEBUG__ = "__debug__";
 
     // sys
+    public static final String BREAKPOINTHOOK = "breakpointhook";
     public static final String EXCEPTHOOK = "excepthook";
     public static final String LAST_TYPE = "last_type";
     public static final String LAST_VALUE = "last_value";

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/call/PythonCallNode.java

@@ -272,6 +272,6 @@ private static boolean isCall(Class<?> tag) {
     }
 
     private boolean isBreakpoint(Class<?> tag) {
-        return tag == DebuggerTags.AlwaysHalt.class && calleeName.equals(BuiltinNames.__BREAKPOINT__);
+        return tag == DebuggerTags.AlwaysHalt.class && calleeName.equals(BuiltinNames.BREAKPOINT);
     }
 }

graalpython/lib-graalpython/sys.py

@@ -175,6 +175,32 @@ def __print_traceback__(typ, value, tb):
 del make_excepthook
 
 
+@__builtin__
+def breakpointhook(*args, **kws):
+    import importlib, os, warnings
+    hookname = os.getenv('PYTHONBREAKPOINT')
+    if hookname is None or len(hookname) == 0:
+        warnings.warn('Graal Python cannot run pdb, yet, consider using `--inspect` on the commandline', RuntimeWarning)
+        hookname = 'pdb.set_trace'
+    elif hookname == '0':
+        return None
+    modname, dot, funcname = hookname.rpartition('.')
+    if dot == '':
+        modname = 'builtins'
+    try:
+        module = importlib.import_module(modname)
+        hook = getattr(module, funcname)
+    except:
+        warnings.warn(
+            'Ignoring unimportable $PYTHONBREAKPOINT: {}'.format(
+                hookname),
+            RuntimeWarning)
+    return hook(*args, **kws)
+
+
+__breakpointhook__ = breakpointhook
+
+
 @__builtin__
 def getrecursionlimit():
     return 1000