[GR-20464] Use CallSpecial nodes in library message implementations

PullRequest: graalpython/782

Author: timfel

.gitignore

@@ -66,3 +66,5 @@ Python3.g4.stamp
 /graalpython/include/*
 /graalpython/com.oracle.graal.python.test/src/tests/cpyext/As_FileDescriptor_Testfile
 /.*.csv*
+/graal_dumps
+*.jfr

ci.jsonnet

@@ -1 +1 @@
-{ overlay: "3bc2cb30863e4ed818ce72065a64774bc44e9281" }
+{ overlay: "0804360960e04fffe3fc4ed87c6b5f8b65641c78" }

graalpython/benchmarks/src/micro/dict-getitem.py

@@ -0,0 +1,59 @@
+# Copyright (c) 2020, 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.
+
+class sub_int(int):
+    pass
+
+
+def getitem(d, num):
+    for t in range(num):
+        item = d.get(num)
+        item2 = d.get(sub_int(num))
+
+    return item, item2
+
+
+def measure(num):
+    d = {x: x**x for x in range(1000)}
+    last_items = getitem(d, num)  # 1000000
+    print("Last items ", last_items)
+
+
+def __benchmark__(num=1000000):
+    measure(num)

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/Builtin.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2019, Oracle and/or its affiliates.
+ * Copyright (c) 2017, 2020, Oracle and/or its affiliates.
  * Copyright (c) 2013, Regents of the University of California
  *
  * All rights reserved.
@@ -63,6 +63,13 @@
 
     boolean isStaticmethod() default false;
 
+    /**
+     * Most built-ins don't ever need the frame or they should be able to deal with receiving a
+     * {@code null} frame. This should be set to {@code true} for those builtins that do need a full
+     * frame.
+     */
+    boolean needsFrame() default false;
+
     /**
      * By default the caller frame bit is set on-demand, but for some builtins it might be useful to
      * always force passing the caller frame.

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/PythonBuiltinClassType.java

@@ -28,8 +28,10 @@
 import java.util.HashSet;
 
 import com.oracle.graal.python.PythonLanguage;
+import com.oracle.graal.python.builtins.objects.function.PArguments.ThreadState;
 import com.oracle.graal.python.builtins.objects.object.PythonObjectLibrary;
 import com.oracle.graal.python.builtins.objects.type.LazyPythonClass;
+import com.oracle.graal.python.builtins.objects.type.PythonBuiltinClass;
 import com.oracle.graal.python.nodes.BuiltinNames;
 import com.oracle.graal.python.runtime.PythonContext;
 import com.oracle.truffle.api.CompilerAsserts;
@@ -469,4 +471,15 @@ static long hash(PythonBuiltinClassType type,
     static LazyPythonClass getLazyPythonClass(@SuppressWarnings("unused") PythonBuiltinClassType type) {
         return PythonClass;
     }
+
+    @ExportMessage
+    static int equalsInternal(PythonBuiltinClassType self, Object other, @SuppressWarnings("unused") ThreadState state) {
+        if (self == other) {
+            return 1;
+        } else if (other instanceof PythonBuiltinClass) {
+            return self == ((PythonBuiltinClass) other).getType() ? 1 : 0;
+        } else {
+            return 0;
+        }
+    }
 }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2019, Oracle and/or its affiliates.
+ * Copyright (c) 2017, 2020, Oracle and/or its affiliates.
  * Copyright (c) 2013, Regents of the University of California
  *
  * All rights reserved.
@@ -1454,43 +1454,18 @@ protected final PythonObjectFactory factory() {
     @Builtin(name = BOOL, minNumOfPositionalArgs = 1, maxNumOfPositionalArgs = 2, constructsClass = PythonBuiltinClassType.Boolean, base = PythonBuiltinClassType.PInt)
     @GenerateNodeFactory
     @SuppressWarnings("unused")
+    @ReportPolymorphism
     public abstract static class BoolNode extends PythonBinaryBuiltinNode {
-
-        @Specialization
-        public boolean boolB(Object cls, boolean arg) {
-            return arg;
-        }
-
-        @Specialization
-        public boolean boolI(Object cls, int arg) {
-            return arg != 0;
-        }
-
-        @Specialization
-        public boolean boolD(Object cls, double arg) {
-            return arg != 0.0;
-        }
-
-        @Specialization
-        public boolean boolS(Object cls, String arg) {
-            return !arg.isEmpty();
-        }
-
-        @Specialization
-        public boolean boolN(Object cls, PNone arg) {
-            return false;
-        }
-
-        @Specialization
+        @Specialization(limit = "getCallSiteInlineCacheMaxDepth()")
         public boolean bool(VirtualFrame frame, Object cls, Object obj,
-                        @Cached("create(__BOOL__)") LookupAndCallUnaryNode callNode) {
-            try {
-                return callNode.executeBoolean(frame, obj);
-            } catch (UnexpectedResultException ex) {
-                throw raise(PythonErrorType.TypeError, "__bool__ should return bool, returned %p", ex.getResult());
+                        @Cached("createBinaryProfile()") ConditionProfile hasFrame,
+                        @CachedLibrary("obj") PythonObjectLibrary lib) {
+            if (hasFrame.profile(frame != null)) {
+                return lib.isTrueWithState(obj, PArguments.getThreadState(frame));
+            } else {
+                return lib.isTrue(obj);
             }
         }
-
     }
 
     // list([iterable])

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

@@ -147,7 +147,7 @@
 import com.oracle.graal.python.nodes.control.GetNextNode;
 import com.oracle.graal.python.nodes.expression.BinaryArithmetic;
 import com.oracle.graal.python.nodes.expression.BinaryComparisonNode;
-import com.oracle.graal.python.nodes.expression.CastToBooleanNode;
+import com.oracle.graal.python.nodes.expression.CoerceToBooleanNode;
 import com.oracle.graal.python.nodes.expression.IsExpressionNode;
 import com.oracle.graal.python.nodes.expression.TernaryArithmetic;
 import com.oracle.graal.python.nodes.frame.MaterializeFrameNode;
@@ -304,12 +304,18 @@ String doPI(PInt x) {
 
         @Specialization(replaces = {"doL", "doD", "doPI"})
         String doO(VirtualFrame frame, Object x,
+                        @Cached("createBinaryProfile()") ConditionProfile hasFrame,
                         @Cached IsSubtypeNode isSubtype,
                         @CachedLibrary(limit = "getCallSiteInlineCacheMaxDepth()") PythonObjectLibrary lib,
                         @Cached BranchProfile isInt,
                         @Cached BranchProfile isLong,
                         @Cached BranchProfile isPInt) {
-            Object index = lib.asIndexWithState(x, PArguments.getThreadState(frame));
+            Object index;
+            if (hasFrame.profile(frame != null)) {
+                index = lib.asIndexWithState(x, PArguments.getThreadState(frame));
+            } else {
+                index = lib.asIndex(x);
+            }
             if (isSubtype.execute(lib.getLazyPythonClass(index), PythonBuiltinClassType.PInt)) {
                 if (index instanceof Boolean || index instanceof Integer) {
                     isInt.enter();
@@ -1045,7 +1051,7 @@ private long getId(PythonObject obj) {
     public abstract static class IsInstanceNode extends PythonBinaryBuiltinNode {
         @Child private GetClassNode getClassNode = GetClassNode.create();
         @Child private LookupAndCallBinaryNode instanceCheckNode = LookupAndCallBinaryNode.create(__INSTANCECHECK__);
-        @Child private CastToBooleanNode castToBooleanNode = CastToBooleanNode.createIfTrueNode();
+        @Child private CoerceToBooleanNode castToBooleanNode = CoerceToBooleanNode.createIfTrueNode();
         @Child private TypeBuiltins.InstanceCheckNode typeInstanceCheckNode = TypeBuiltins.InstanceCheckNode.create();
         @Child private SequenceStorageNodes.LenNode lenNode;
         @Child private GetObjectArrayNode getObjectArrayNode;
@@ -1122,7 +1128,7 @@ private Object[] getArray(PTuple tuple) {
     @GenerateNodeFactory
     public abstract static class IsSubClassNode extends PythonBinaryBuiltinNode {
         @Child private LookupAndCallBinaryNode subclassCheckNode = LookupAndCallBinaryNode.create(__SUBCLASSCHECK__);
-        @Child private CastToBooleanNode castToBooleanNode = CastToBooleanNode.createIfTrueNode();
+        @Child private CoerceToBooleanNode castToBooleanNode = CoerceToBooleanNode.createIfTrueNode();
         @Child private IsSubtypeNode isSubtypeNode = IsSubtypeNode.create();
         @Child private SequenceStorageNodes.LenNode lenNode;
         @Child private GetObjectArrayNode getObjectArrayNode;
@@ -1209,8 +1215,13 @@ public Object iter(Object callable, Object sentinel) {
     public abstract static class LenNode extends PythonUnaryBuiltinNode {
         @Specialization(limit = "getCallSiteInlineCacheMaxDepth()")
         public int len(VirtualFrame frame, Object obj,
+                        @Cached("createBinaryProfile()") ConditionProfile hasFrame,
                         @CachedLibrary("obj") PythonObjectLibrary lib) {
-            return lib.lengthWithState(obj, PArguments.getThreadState(frame));
+            if (hasFrame.profile(frame != null)) {
+                return lib.lengthWithState(obj, PArguments.getThreadState(frame));
+            } else {
+                return lib.length(obj);
+            }
         }
     }
 
@@ -1272,7 +1283,7 @@ Object minmaxSequenceWithKey(VirtualFrame frame, PythonObject arg1, @SuppressWar
         Object minmaxBinary(VirtualFrame frame, Object arg1, Object[] args, @SuppressWarnings("unused") PNone keywordArg,
                         @Cached("createComparison()") BinaryComparisonNode compare,
                         @Cached("createBinaryProfile()") ConditionProfile moreThanTwo,
-                        @Shared("castToBooleanNode") @Cached("createIfTrueNode()") CastToBooleanNode castToBooleanNode) {
+                        @Shared("castToBooleanNode") @Cached("createIfTrueNode()") CoerceToBooleanNode castToBooleanNode) {
             return minmaxBinaryWithKey(frame, arg1, args, null, compare, null, moreThanTwo, castToBooleanNode);
         }
 
@@ -1281,7 +1292,7 @@ Object minmaxBinaryWithKey(VirtualFrame frame, Object arg1, Object[] args, Pytho
                         @Cached("createComparison()") BinaryComparisonNode compare,
                         @Cached CallNode keyCall,
                         @Cached("createBinaryProfile()") ConditionProfile moreThanTwo,
-                        @Shared("castToBooleanNode") @Cached("createIfTrueNode()") CastToBooleanNode castToBooleanNode) {
+                        @Shared("castToBooleanNode") @Cached("createIfTrueNode()") CoerceToBooleanNode castToBooleanNode) {
             Object currentValue = arg1;
             Object currentKey = applyKeyFunction(frame, keywordArg, keyCall, currentValue);
             Object nextValue = args[0];
@@ -1454,7 +1465,7 @@ PNone printAllGiven(VirtualFrame frame, Object[] values, String sep, String end,
         PNone printGeneric(VirtualFrame frame, Object[] values, Object sepIn, Object endIn, Object fileIn, Object flushIn,
                         @Cached CastToJavaStringNode castSep,
                         @Cached CastToJavaStringNode castEnd,
-                        @Cached("createIfTrueNode()") CastToBooleanNode castFlush,
+                        @Cached("createIfTrueNode()") CoerceToBooleanNode castFlush,
                         @Cached PRaiseNode raiseNode) {
             String sep = sepIn instanceof PNone ? DEFAULT_SEPARATOR : castSep.execute(sepIn);
             if (sep == null) {
@@ -1919,7 +1930,7 @@ public static GlobalsNode create() {
         }
     }
 
-    @Builtin(name = "locals", minNumOfPositionalArgs = 0)
+    @Builtin(name = "locals", minNumOfPositionalArgs = 0, needsFrame = true)
     @GenerateNodeFactory
     abstract static class LocalsNode extends PythonBuiltinNode {
 

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

@@ -68,7 +68,7 @@
 import com.oracle.graal.python.builtins.objects.common.SequenceStorageNodes.GetInternalByteArrayNode;
 import com.oracle.graal.python.builtins.objects.common.SequenceStorageNodesFactory.GetInternalByteArrayNodeGen;
 import com.oracle.graal.python.builtins.objects.tuple.PTuple;
-import com.oracle.graal.python.nodes.expression.CastToBooleanNode;
+import com.oracle.graal.python.nodes.expression.CoerceToBooleanNode;
 import com.oracle.graal.python.nodes.function.PythonBuiltinBaseNode;
 import com.oracle.graal.python.nodes.function.PythonBuiltinNode;
 import com.oracle.graal.python.nodes.function.builtins.PythonBinaryBuiltinNode;
@@ -506,7 +506,7 @@ private Object[] encodeString(String self, String errors) {
     abstract static class CodecsDecodeNode extends EncodeBaseNode {
         @Child private GetInternalByteArrayNode toByteArrayNode;
         @Child private CastToJavaStringNode castEncodingToStringNode;
-        @Child private CastToBooleanNode castToBooleanNode;
+        @Child private CoerceToBooleanNode castToBooleanNode;
 
         @Specialization
         Object decode(VirtualFrame frame, PIBytesLike bytes, @SuppressWarnings("unused") PNone encoding, @SuppressWarnings("unused") PNone errors, Object finalData) {
@@ -583,7 +583,7 @@ private boolean castToBoolean(VirtualFrame frame, Object object) {
             }
             if (castToBooleanNode == null) {
                 CompilerDirectives.transferToInterpreterAndInvalidate();
-                castToBooleanNode = insert(CastToBooleanNode.createIfTrueNode());
+                castToBooleanNode = insert(CoerceToBooleanNode.createIfTrueNode());
             }
             return castToBooleanNode.executeBoolean(frame, object);
         }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2020, 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
@@ -50,7 +50,7 @@
 import com.oracle.graal.python.builtins.objects.code.PCode;
 import com.oracle.graal.python.nodes.SpecialMethodNames;
 import com.oracle.graal.python.nodes.call.special.LookupAndCallBinaryNode;
-import com.oracle.graal.python.nodes.expression.CastToBooleanNode;
+import com.oracle.graal.python.nodes.expression.CoerceToBooleanNode;
 import com.oracle.graal.python.nodes.function.PythonBuiltinBaseNode;
 import com.oracle.graal.python.nodes.function.builtins.PythonUnaryBuiltinNode;
 import com.oracle.truffle.api.dsl.Cached;
@@ -74,7 +74,7 @@ abstract static class GetCodeGlobalVarsNode extends PythonUnaryBuiltinNode {
         @Specialization
         protected Object get(VirtualFrame frame, PCode code,
                         @Cached GlobalsNode globalsNode,
-                        @Cached("createIfTrueNode()") CastToBooleanNode isTrue,
+                        @Cached("createIfTrueNode()") CoerceToBooleanNode isTrue,
                         @Cached("create(__CONTAINS__)") LookupAndCallBinaryNode containsNode) {
             Object[] varNames = code.getGlobalAndBuiltinVarNames();
             if (varNames != null) {

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

@@ -1233,11 +1233,18 @@ int gcd(@SuppressWarnings("unused") PInt x, @SuppressWarnings("unused") double y
 
         @Specialization(guards = "!isNumber(x) || !isNumber(y)")
         Object gcd(VirtualFrame frame, Object x, Object y,
+                        @Cached("createBinaryProfile()") ConditionProfile hasFrame,
                         @CachedLibrary(limit = "2") PythonObjectLibrary lib,
                         @Cached("create()") GcdNode recursiveNode) {
-            ThreadState threadState = PArguments.getThreadState(frame);
-            Object xValue = lib.asIndexWithState(x, threadState);
-            Object yValue = lib.asIndexWithState(y, threadState);
+            Object xValue, yValue;
+            if (hasFrame.profile(frame != null)) {
+                ThreadState threadState = PArguments.getThreadState(frame);
+                xValue = lib.asIndexWithState(x, threadState);
+                yValue = lib.asIndexWithState(y, threadState);
+            } else {
+                xValue = lib.asIndex(x);
+                yValue = lib.asIndex(y);
+            }
             return recursiveNode.execute(frame, xValue, yValue);
         }