[GR-52250] Fix host inlining of Float comparison operations.

PullRequest: graalpython/3210

Author: steve-s

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/bytes/ByteArrayBuiltins.java

@@ -109,6 +109,7 @@
 import com.oracle.graal.python.runtime.sequence.storage.ByteSequenceStorage;
 import com.oracle.graal.python.runtime.sequence.storage.SequenceStorage;
 import com.oracle.graal.python.util.ComparisonOp;
+import com.oracle.truffle.api.HostCompilerDirectives.InliningCutoff;
 import com.oracle.truffle.api.dsl.Bind;
 import com.oracle.truffle.api.dsl.Cached;
 import com.oracle.truffle.api.dsl.Cached.Exclusive;
@@ -867,6 +868,7 @@ static boolean cmp(Node inliningTarget, PByteArray self, PBytesLike other, Compa
         }
 
         @Specialization(guards = {"check.execute(inliningTarget, self)", "acquireLib.hasBuffer(other)"}, limit = "3")
+        @InliningCutoff
         static Object cmp(VirtualFrame frame, Node inliningTarget, Object self, Object other, ComparisonOp op,
                         @Cached("createFor(this)") IndirectCallData indirectCallData,
                         @SuppressWarnings("unused") @Exclusive @Cached PyByteArrayCheckNode check,
@@ -893,6 +895,7 @@ static Object cmp(VirtualFrame frame, Node inliningTarget, Object self, Object o
         }
 
         @Specialization(guards = "!check.execute(inliningTarget, self)")
+        @InliningCutoff
         @SuppressWarnings("unused")
         static Object error(VirtualFrame frame, Node inliningTarget, Object self, Object other, ComparisonOp op,
                         @Shared @Cached PyByteArrayCheckNode check,

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/common/SequenceStorageNodes.java

@@ -1720,6 +1720,7 @@ static byte[] doGenericLenCached(Node inliningTarget, SequenceStorage s,
         }
 
         @Specialization(replaces = "doGenericLenCached")
+        @InliningCutoff
         static byte[] doGeneric(Node inliningTarget, SequenceStorage s,
                         @Shared("getItemNode") @Cached GetItemScalarNode getItemNode,
                         @Shared @Cached CastToJavaByteNode castToByteNode) {

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/floats/FloatBuiltins.java

@@ -86,6 +86,7 @@
 import com.oracle.graal.python.builtins.objects.PNotImplemented;
 import com.oracle.graal.python.builtins.objects.common.FormatNodeBase;
 import com.oracle.graal.python.builtins.objects.floats.FloatBuiltinsClinicProviders.FormatNodeClinicProviderGen;
+import com.oracle.graal.python.builtins.objects.floats.FloatUtils.PFloatUnboxing;
 import com.oracle.graal.python.builtins.objects.ints.PInt;
 import com.oracle.graal.python.builtins.objects.tuple.PTuple;
 import com.oracle.graal.python.lib.PyFloatCheckNode;
@@ -106,6 +107,7 @@
 import com.oracle.graal.python.nodes.truffle.PythonArithmeticTypes;
 import com.oracle.graal.python.nodes.util.CannotCastException;
 import com.oracle.graal.python.nodes.util.CastToJavaDoubleNode;
+import com.oracle.graal.python.runtime.exception.PException;
 import com.oracle.graal.python.runtime.exception.PythonErrorType;
 import com.oracle.graal.python.runtime.formatting.FloatFormatter;
 import com.oracle.graal.python.runtime.formatting.InternalFormat;
@@ -147,10 +149,15 @@ private static double castToDoubleChecked(Node inliningTarget, Object obj, CastT
         try {
             return cast.execute(inliningTarget, obj);
         } catch (CannotCastException e) {
-            throw PRaiseNode.getUncached().raise(TypeError, ErrorMessages.DESCRIPTOR_REQUIRES_S_OBJ_RECEIVED_P, "float", obj);
+            throw raiseWrongSelf(obj);
         }
     }
 
+    @InliningCutoff
+    private static PException raiseWrongSelf(Object obj) {
+        throw PRaiseNode.getUncached().raise(TypeError, ErrorMessages.DESCRIPTOR_REQUIRES_S_OBJ_RECEIVED_P, "float", obj);
+    }
+
     @GenerateCached(false)
     abstract static class AbstractNumericUnaryBuiltin extends PythonUnaryBuiltinNode {
         protected abstract Object op(double num);
@@ -733,6 +740,7 @@ private static BigInteger toBigInteger(double d) {
 
     @GenerateInline
     @GenerateCached(false)
+    @TypeSystemReference(PFloatUnboxing.class)
     public abstract static class ComparisonHelperNode extends Node {
 
         @FunctionalInterface
@@ -753,6 +761,7 @@ static boolean doDI(double a, int b, Op op) {
         }
 
         @Specialization(guards = "check.execute(inliningTarget, bObj)", replaces = "doDD", limit = "1")
+        @InliningCutoff
         static boolean doOO(Node inliningTarget, Object aObj, Object bObj, Op op,
                         @SuppressWarnings("unused") @Cached PyFloatCheckNode check,
                         @Exclusive @Cached CastToJavaDoubleNode cast) {
@@ -762,13 +771,15 @@ static boolean doOO(Node inliningTarget, Object aObj, Object bObj, Op op,
         }
 
         @Specialization(replaces = "doDI")
+        @InliningCutoff
         static boolean doOI(Node inliningTarget, Object aObj, int b, Op op,
                         @Shared @Cached CastToJavaDoubleNode cast) {
             double a = castToDoubleChecked(inliningTarget, aObj, cast);
             return op.compute(a, b);
         }
 
         @Specialization
+        @InliningCutoff
         static boolean doOL(Node inliningTarget, Object aObj, long b, Op op,
                         @Exclusive @Cached CastToJavaDoubleNode cast,
                         @Cached InlinedConditionProfile longFitsToDoubleProfile) {
@@ -777,13 +788,15 @@ static boolean doOL(Node inliningTarget, Object aObj, long b, Op op,
         }
 
         @Specialization
+        @InliningCutoff
         static boolean doOPInt(Node inliningTarget, Object aObj, PInt b, Op op,
                         @Shared @Cached CastToJavaDoubleNode cast) {
             double a = castToDoubleChecked(inliningTarget, aObj, cast);
             return op.compute(compareDoubleToLargeInt(a, b), 0.0);
         }
 
         @Specialization
+        @InliningCutoff
         static boolean doOB(Node inliningTarget, Object aObj, boolean b, Op op,
                         @Shared @Cached CastToJavaDoubleNode cast) {
             double a = castToDoubleChecked(inliningTarget, aObj, cast);

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/floats/FloatUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, 2024, 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
@@ -44,6 +44,8 @@
 
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
 import com.oracle.truffle.api.CompilerDirectives.ValueType;
+import com.oracle.truffle.api.dsl.ImplicitCast;
+import com.oracle.truffle.api.dsl.TypeSystem;
 
 /**
  * Contains helper methods for parsing float numbers in float() and complex() constructors.
@@ -241,4 +243,18 @@ public static double parseValidString(String substr) {
         }
         return d;
     }
+
+    /**
+     * Unboxes {@link PFloat}. Use only in situations where this is correct behavior.
+     */
+    @TypeSystem
+    public static class PFloatUnboxing {
+        @ImplicitCast
+        public static double PFloatToDouble(PFloat value) {
+            // NOTE: That's correct because we just use it in arithmetic operations where CPython
+            // also access the value ('f_val') directly. So, even if the object is subclassed, it
+            // is ignored.
+            return value.getValue();
+        }
+    }
 }

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/lib/PyFloatCheckNode.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2023, 2024, 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
@@ -44,6 +44,7 @@
 import com.oracle.graal.python.builtins.objects.cext.PythonAbstractNativeObject;
 import com.oracle.graal.python.builtins.objects.floats.PFloat;
 import com.oracle.graal.python.nodes.object.BuiltinClassProfiles.IsBuiltinObjectProfile;
+import com.oracle.truffle.api.HostCompilerDirectives.InliningCutoff;
 import com.oracle.truffle.api.dsl.Cached;
 import com.oracle.truffle.api.dsl.Fallback;
 import com.oracle.truffle.api.dsl.GenerateCached;
@@ -73,6 +74,7 @@ static boolean doPFloat(@SuppressWarnings("unused") PFloat obj) {
     }
 
     @Specialization
+    @InliningCutoff
     static boolean doNative(PythonAbstractNativeObject object,
                     @Cached(inline = false) IsBuiltinObjectProfile check) {
         return check.profileObjectCached(object, PythonBuiltinClassType.PFloat);

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/util/CastToJavaByteNode.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2024, 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
@@ -47,6 +47,7 @@
 import com.oracle.graal.python.nodes.PNodeWithContext;
 import com.oracle.graal.python.nodes.PRaiseNode;
 import com.oracle.graal.python.util.OverflowException;
+import com.oracle.truffle.api.HostCompilerDirectives.InliningCutoff;
 import com.oracle.truffle.api.dsl.Cached;
 import com.oracle.truffle.api.dsl.Cached.Shared;
 import com.oracle.truffle.api.dsl.GenerateCached;
@@ -91,6 +92,7 @@ static byte fromPInt(PInt x) {
     }
 
     @Specialization(replaces = "fromInt")
+    @InliningCutoff
     static byte fromIntErr(Node inliningTarget, int x,
                     @Shared("raiseNode") @Cached PRaiseNode.Lazy raiseNode) {
         try {
@@ -101,6 +103,7 @@ static byte fromIntErr(Node inliningTarget, int x,
     }
 
     @Specialization(replaces = "fromLong")
+    @InliningCutoff
     static byte fromLongErr(Node inliningTarget, long x,
                     @Shared("raiseNode") @Cached PRaiseNode.Lazy raiseNode) {
         try {
@@ -111,6 +114,7 @@ static byte fromLongErr(Node inliningTarget, long x,
     }
 
     @Specialization(replaces = "fromPInt")
+    @InliningCutoff
     static byte fromPIntErr(Node inliningTarget, PInt x,
                     @Shared("raiseNode") @Cached PRaiseNode.Lazy raiseNode) {
         try {

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/util/CastToJavaDoubleNode.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2024, 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
@@ -52,6 +52,7 @@
 import com.oracle.graal.python.nodes.object.GetClassNode.GetPythonObjectClassNode;
 import com.oracle.graal.python.nodes.truffle.PythonArithmeticTypes;
 import com.oracle.truffle.api.CompilerDirectives;
+import com.oracle.truffle.api.HostCompilerDirectives.InliningCutoff;
 import com.oracle.truffle.api.dsl.Cached;
 import com.oracle.truffle.api.dsl.GenerateCached;
 import com.oracle.truffle.api.dsl.GenerateInline;
@@ -114,6 +115,7 @@ static double doPBCT(@SuppressWarnings("unused") PythonBuiltinClassType object)
     }
 
     @Specialization
+    @InliningCutoff
     static double doNativeObject(Node inliningTarget, PythonAbstractNativeObject x,
                     @Cached GetPythonObjectClassNode getClassNode,
                     @Cached(inline = false) IsSubtypeNode isSubtypeNode,
@@ -144,6 +146,7 @@ public static Double doInterop(Object obj,
     }
 
     @Specialization(guards = "!isNumber(obj)")
+    @InliningCutoff
     static double doGeneric(Object obj,
                     @CachedLibrary(limit = "3") InteropLibrary interopLibrary) {
         Double d = doInterop(obj, interopLibrary);