[GR-23353] Create and use CastToJavaUnsignedLongNode

otethal · otethal · commit 87abd3a31991 · 2020-09-09T07:22:39.000Z
PullRequest: graalpython/1260
diff --git a/graalpython/com.oracle.graal.python.test/src/com/oracle/graal/python/nodes/util/CastToJavaUnsignedLongNodeTests.java b/graalpython/com.oracle.graal.python.test/src/com/oracle/graal/python/nodes/util/CastToJavaUnsignedLongNodeTests.java
@@ -0,0 +1,173 @@
+/*
+ * 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.
+ */
+package com.oracle.graal.python.nodes.util;
+
+import com.oracle.graal.python.builtins.PythonBuiltinClassType;
+import com.oracle.graal.python.builtins.objects.ints.PInt;
+import com.oracle.graal.python.nodes.object.IsBuiltinClassProfile;
+import com.oracle.graal.python.runtime.exception.PException;
+import com.oracle.graal.python.runtime.object.PythonObjectFactory;
+import com.oracle.graal.python.test.PythonTests;
+import com.oracle.truffle.api.Truffle;
+import com.oracle.truffle.api.frame.VirtualFrame;
+import com.oracle.truffle.api.nodes.RootNode;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.math.BigInteger;
+
+import static com.oracle.graal.python.runtime.exception.PythonErrorType.OverflowError;
+import static com.oracle.graal.python.runtime.exception.PythonErrorType.TypeError;
+
+public class CastToJavaUnsignedLongNodeTests {
+    private static PythonObjectFactory factory = PythonObjectFactory.getUncached();
+
+    @Before
+    public void setUp() {
+        PythonTests.enterContext();
+    }
+
+    @Test
+    public void positiveInt() {
+        Assert.assertEquals(0, castInt(0));
+        Assert.assertEquals(16, castInt(16));
+        Assert.assertEquals(Integer.MAX_VALUE, castInt(Integer.MAX_VALUE));
+        Assert.assertEquals(42, castObject(42));
+    }
+
+    @Test
+    public void negativeInt() {
+        expect(OverflowError, () -> castInt(-1));
+        expect(OverflowError, () -> castInt(Integer.MIN_VALUE));
+    }
+
+    @Test
+    public void positiveLong() {
+        Assert.assertEquals(0, castLong(0L));
+        Assert.assertEquals(0x80000000L, castLong(0x80000000L));
+        Assert.assertEquals(Long.MAX_VALUE, castLong(Long.MAX_VALUE));
+        Assert.assertEquals(1234567890123L, castLong(1234567890123L));
+    }
+
+    @Test
+    public void negativeLong() {
+        expect(OverflowError, () -> castLong(-1L));
+        expect(OverflowError, () -> castLong(Long.MIN_VALUE));
+    }
+
+    @Test
+    public void positiveBigInt() {
+        Assert.assertEquals(0, castObject(makePInt(0)));
+        Assert.assertEquals(1234567890123L, castObject(makePInt(1234567890123L)));
+        Assert.assertEquals(Long.MAX_VALUE, castObject(makePInt(Long.MAX_VALUE)));
+        Assert.assertEquals(0x8000000000000000L, castObject(makePInt("8000000000000000")));
+        Assert.assertEquals(0xFFFFFFFFFFFFFFFFL, castObject(makePInt("FFFFFFFFFFFFFFFF")));
+    }
+
+    @Test
+    public void negativeBigInt() {
+        expect(OverflowError, () -> castObject(makePInt(-1)));
+        expect(OverflowError, () -> castObject(makePInt("-10000000000000000")));
+    }
+
+    @Test
+    public void largeBigInt() {
+        expect(OverflowError, () -> castObject(makePInt("10000000000000000")));
+        expect(OverflowError, () -> castObject(makePInt("10000000000000001")));
+    }
+
+    @Test
+    public void nonInteger() {
+        expect(TypeError, () -> castObject("123"));
+        expect(TypeError, () -> castObject(2.7));
+    }
+
+    private static PInt makePInt(long l) {
+        return factory.createInt(BigInteger.valueOf(l));
+    }
+
+    private static PInt makePInt(String hexString) {
+        return factory.createInt(new BigInteger(hexString, 16));
+    }
+
+    private static void expect(PythonBuiltinClassType errorType, Runnable test) {
+        try {
+            test.run();
+            Assert.fail("Expected " + errorType.getName());
+        } catch (PException e) {
+            e.expect(errorType, IsBuiltinClassProfile.getUncached());
+        }
+    }
+
+    private static long castInt(int arg) {
+        return (Long) Truffle.getRuntime().createCallTarget(new RootNode(null) {
+            @Child private CastToJavaUnsignedLongNode castNode = CastToJavaUnsignedLongNode.create();
+
+            @Override
+            public Object execute(VirtualFrame frame) {
+                return castNode.execute(arg);
+            }
+        }).call();
+    }
+
+    private static long castLong(long arg) {
+        return (Long) Truffle.getRuntime().createCallTarget(new RootNode(null) {
+            @Child private CastToJavaUnsignedLongNode castNode = CastToJavaUnsignedLongNode.create();
+
+            @Override
+            public Object execute(VirtualFrame frame) {
+                return castNode.execute(arg);
+            }
+        }).call();
+    }
+
+    private static long castObject(Object arg) {
+        return (Long) Truffle.getRuntime().createCallTarget(new RootNode(null) {
+            @Child private CastToJavaUnsignedLongNode castNode = CastToJavaUnsignedLongNode.create();
+
+            @Override
+            public Object execute(VirtualFrame frame) {
+                return castNode.execute(arg);
+            }
+        }).call();
+    }
+}
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/random/RandomBuiltins.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/random/RandomBuiltins.java
@@ -65,6 +65,7 @@
 import com.oracle.graal.python.nodes.function.builtins.PythonBinaryClinicBuiltinNode;
 import com.oracle.graal.python.nodes.function.builtins.clinic.ArgumentClinicProvider;
 import com.oracle.graal.python.nodes.truffle.PythonArithmeticTypes;
+import com.oracle.graal.python.nodes.util.CastToJavaUnsignedLongNode;
 import com.oracle.graal.python.runtime.exception.PythonErrorType;
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
 import com.oracle.truffle.api.dsl.Cached;
@@ -76,7 +77,6 @@
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.library.CachedLibrary;
 
-import static com.oracle.graal.python.runtime.exception.PythonErrorType.OverflowError;
 import static com.oracle.graal.python.runtime.exception.PythonErrorType.TypeError;
 import static com.oracle.graal.python.runtime.exception.PythonErrorType.ValueError;
 
@@ -165,20 +165,17 @@ public abstract static class SetStateNode extends PythonBuiltinNode {
         @Specialization
         PNone setstate(PRandom random, PTuple tuple,
                         @Cached GetObjectArrayNode getObjectArrayNode,
-                        @CachedLibrary(limit = "3") PythonObjectLibrary lib) {
+                        @Cached CastToJavaUnsignedLongNode castNode) {
             Object[] arr = getObjectArrayNode.execute(tuple);
             if (arr.length != PRandom.N + 1) {
                 throw raise(PythonErrorType.ValueError, ErrorMessages.STATE_VECTOR_INVALID);
             }
             int[] state = new int[PRandom.N];
             for (int i = 0; i < PRandom.N; ++i) {
-                long l = lib.asJavaLong(arr[i]);
-                if (l < 0 || l > 0xFFFFFFFFL) {
-                    throw raise(OverflowError, ErrorMessages.PYTHON_INT_TOO_LARGE_TO_CONV_TO, "C unsigned long");
-                }
+                long l = castNode.execute(arr[i]);
                 state[i] = (int) l;
             }
-            long index = lib.asJavaLong(arr[PRandom.N]);
+            long index = castNode.execute(arr[PRandom.N]);
             if (index < 0 || index > PRandom.N) {
                 throw raise(PythonErrorType.ValueError, ErrorMessages.STATE_VECTOR_INVALID);
             }
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/util/CastToJavaUnsignedLongNode.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/util/CastToJavaUnsignedLongNode.java
@@ -0,0 +1,127 @@
+/*
+ * 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.
+ */
+package com.oracle.graal.python.nodes.util;
+
+import com.oracle.graal.python.builtins.objects.ints.PInt;
+import com.oracle.graal.python.nodes.ErrorMessages;
+import com.oracle.graal.python.nodes.PNodeWithContext;
+import com.oracle.graal.python.nodes.PRaiseNode;
+import com.oracle.graal.python.nodes.truffle.PythonArithmeticTypes;
+import com.oracle.truffle.api.CompilerDirectives;
+import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
+import com.oracle.truffle.api.dsl.Fallback;
+import com.oracle.truffle.api.dsl.Specialization;
+import com.oracle.truffle.api.dsl.TypeSystemReference;
+
+import java.math.BigInteger;
+
+import static com.oracle.graal.python.runtime.exception.PythonErrorType.OverflowError;
+import static com.oracle.graal.python.runtime.exception.PythonErrorType.TypeError;
+
+/**
+ * Casts a Python {@code int} to Java {@code long}. This method follows the semantics of CPython's
+ * function {@code PyLong_AsUnsignedLong}:
+ * <ul>
+ * <li>raises {@code TypeError} if the argument is not an int</li>
+ * <li>raises {@code OverflowError} if the argument is negative</li>
+ * <li>raises {@code OverflowError} if the argument is greater than or equal to 2^64</li>
+ * </ul>
+ * Note that since Java {@code long} is signed, the values in the between 2^63 and 2^64-1 are
+ * returned as negative numbers.
+ */
+@TypeSystemReference(PythonArithmeticTypes.class)
+public abstract class CastToJavaUnsignedLongNode extends PNodeWithContext {
+
+    @Child private PRaiseNode raiseNode;
+
+    public static CastToJavaUnsignedLongNode create() {
+        return CastToJavaUnsignedLongNodeGen.create();
+    }
+
+    public abstract long execute(int x);
+
+    public abstract long execute(long x);
+
+    public abstract long execute(Object x);
+
+    @Specialization
+    long toUnsignedLong(long x) {
+        checkNegative(x < 0);
+        return x;
+    }
+
+    @Specialization
+    long toUnsignedLong(PInt x) {
+        checkNegative(x.isNegative());
+        return convertBigInt(x.getValue());
+    }
+
+    @Fallback
+    long doUnsupported(@SuppressWarnings("unused") Object x) {
+        throw getRaiseNode().raise(TypeError, ErrorMessages.INTEGER_IS_REQUIRED);
+    }
+
+    private void checkNegative(boolean negative) {
+        if (negative) {
+            throw getRaiseNode().raise(OverflowError, ErrorMessages.CANNOT_CONVERT_NEGATIVE_VALUE_TO_UNSIGNED_INT);
+        }
+    }
+
+    @TruffleBoundary
+    private long convertBigInt(BigInteger bi) {
+        if (bi.bitLength() > 64) {
+            throw getRaiseNode().raise(OverflowError, ErrorMessages.PYTHON_INT_TOO_LARGE_TO_CONV_TO, "unsigned long");
+        }
+        return bi.longValue();
+    }
+
+    private PRaiseNode getRaiseNode() {
+        if (raiseNode == null) {
+            CompilerDirectives.transferToInterpreterAndInvalidate();
+            if (isAdoptable()) {
+                raiseNode = insert(PRaiseNode.create());
+            } else {
+                raiseNode = PRaiseNode.getUncached();
+            }
+        }
+        return raiseNode;
+    }
+}
