make asIndex method closer to PyNumber_AsSsize_t by passing in the error type in case of overflow

timfel · timfel · commit fd8706a80af9 · 2019-12-20T15:00:52.000+01:00
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/PythonAbstractObject.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/PythonAbstractObject.java
@@ -709,12 +709,13 @@ public final boolean canBeIndex(@Exclusive @Cached HasInheritedAttributeNode.Dyn
     }
 
     @ExportMessage
-    public int asIndexWithState(ThreadState state,
+    public int asIndexWithState(LazyPythonClass type, ThreadState state,
                     @Exclusive @Cached("createBinaryProfile()") ConditionProfile wasPInt,
                     @Exclusive @Cached("createBinaryProfile()") ConditionProfile gotState,
                     @Exclusive @Cached("createBinaryProfile()") ConditionProfile noIndex,
                     @Exclusive @Cached LookupInheritedAttributeNode.Dynamic lookupIndex,
                     @Exclusive @Cached BranchProfile overflow,
+                    @Exclusive @Cached("createBinaryProfile()") ConditionProfile ignoreOverflow,
                     @Exclusive @Cached PRaiseNode raise,
                     @Exclusive @Cached CallNode callNode,
                     @Exclusive @Cached CastToJavaLongNode castToLong) {
@@ -725,21 +726,34 @@ public int asIndexWithState(ThreadState state,
         } else {
             Object indexAttr = lookupIndex.execute(this, __INDEX__);
             if (noIndex.profile(indexAttr == PNone.NO_VALUE)) {
-                throw raise.raise(PythonBuiltinClassType.TypeError, "'%p' object cannot be interpreted as an integer", this);
+                throw raise.raiseIntegerInterpretationError(this);
             }
             if (gotState.profile(state == null)) {
                 result = callNode.execute(indexAttr, this);
             } else {
                 result = callNode.execute(PArguments.frameForCall(state), indexAttr, this);
             }
         }
+        long longResult;
         try {
-            return PInt.intValueExact(castToLong.execute(result));
+            longResult = castToLong.execute(result); // this is a lossy cast
         } catch (CastToJavaLongNode.CannotCastException e) {
             throw raise.raise(PythonBuiltinClassType.TypeError, "__index__ returned non-int (type %p)", result);
+        }
+        try {
+            return PInt.intValueExact(longResult);
         } catch (ArithmeticException e) {
             overflow.enter();
-            throw raise.raise(PythonBuiltinClassType.OverflowError, "cannot fit '%p' into an index-sized integer", result);
+            if (ignoreOverflow.profile(type != null)) {
+                throw raise.raiseIndexError(type, result);
+            } else {
+                // If no error-handling desired then the default clipping is done as in CPython.
+                if (longResult < 0) {
+                    return Integer.MIN_VALUE;
+                } else {
+                    return Integer.MAX_VALUE;
+                }
+            }
         }
     }
 
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/common/IndexNodes.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/common/IndexNodes.java
@@ -213,7 +213,7 @@ int doLongOvf(long index, int length, String errorMessage,
             try {
                 return doLong(index, length, errorMessage, negativeIndexProfile, boundsCheckNode);
             } catch (ArithmeticException e) {
-                throw raiseNode.raiseIndexError();
+                throw raiseNode.raiseIndexError(PythonBuiltinClassType.IndexError, index);
             }
         }
 
@@ -233,7 +233,7 @@ int doPIntOvf(PInt index, int length, String errorMessage,
             try {
                 return doPInt(index, length, errorMessage, negativeIndexProfile, boundsCheckNode);
             } catch (ArithmeticException e) {
-                throw raiseNode.raiseIndexError();
+                throw raiseNode.raiseIndexError(PythonBuiltinClassType.IndexError, index);
             }
         }
 
@@ -272,7 +272,7 @@ int doLongOvf(long index, int length, String errorMessage,
             try {
                 return doLong(index, length, errorMessage, negativeIndexProfile);
             } catch (ArithmeticException e) {
-                throw raiseNode.raiseIndexError();
+                throw raiseNode.raiseIndexError(PythonBuiltinClassType.IndexError, index);
             }
         }
 
@@ -290,7 +290,7 @@ int doPIntOvf(PInt index, int length, String errorMessage,
             try {
                 return doPInt(index, length, errorMessage, negativeIndexProfile);
             } catch (ArithmeticException e) {
-                throw raiseNode.raiseIndexError();
+                throw raiseNode.raiseIndexError(PythonBuiltinClassType.IndexError, index);
             }
         }
     }
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/object/DefaultPythonBooleanExports.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/object/DefaultPythonBooleanExports.java
@@ -53,7 +53,7 @@ static boolean canBeIndex(@SuppressWarnings("unused") Boolean value) {
     }
 
     @ExportMessage
-    static int asIndex(Boolean value) {
+    static int asIndex(Boolean value, @SuppressWarnings("unused") LazyPythonClass errorType) {
         return value ? 1 : 0;
     }
 
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/object/DefaultPythonIntegerExports.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/object/DefaultPythonIntegerExports.java
@@ -58,7 +58,7 @@ static boolean canBeIndex(@SuppressWarnings("unused") Integer value) {
     }
 
     @ExportMessage
-    static int asIndex(Integer value) {
+    static int asIndex(Integer value, @SuppressWarnings("unused") LazyPythonClass errorType) {
         return value;
     }
 
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/object/DefaultPythonLongExports.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/object/DefaultPythonLongExports.java
@@ -64,17 +64,17 @@ static boolean canBeIndex(@SuppressWarnings("unused") Long value) {
     @ExportMessage
     static class AsIndex {
         @Specialization(rewriteOn = ArithmeticException.class)
-        static int noOverflow(Long self) {
+        static int noOverflow(Long self, @SuppressWarnings("unused") LazyPythonClass type) {
             return PInt.intValueExact(self);
         }
 
         @Specialization(replaces = "noOverflow")
-        static int withOverflow(Long self,
+        static int withOverflow(Long self, LazyPythonClass type,
                         @Cached PRaiseNode raise) {
             try {
                 return PInt.intValueExact(self);
             } catch (ArithmeticException e) {
-                throw raise.raise(PythonBuiltinClassType.OverflowError, "cannot fit '%p' into an index-sized integer", self);
+                throw raise.raiseIndexError(type, self);
             }
         }
     }
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/object/DefaultPythonStringExports.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/object/DefaultPythonStringExports.java
@@ -42,9 +42,7 @@
 
 import com.oracle.graal.python.builtins.PythonBuiltinClassType;
 import com.oracle.graal.python.builtins.objects.type.LazyPythonClass;
-import com.oracle.graal.python.nodes.PRaiseNode;
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
-import com.oracle.truffle.api.dsl.Cached;
 import com.oracle.truffle.api.library.ExportLibrary;
 import com.oracle.truffle.api.library.ExportMessage;
 
@@ -86,10 +84,4 @@ static byte[] getBufferBytes(String str) {
     static long hash(String self) {
         return self.hashCode();
     }
-
-    @ExportMessage
-    static int asIndex(String self,
-                    @Cached PRaiseNode raise) {
-        throw raise.raise(PythonBuiltinClassType.TypeError, "'%p' object cannot be interpreted as an integer", self);
-    }
 }
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/object/PythonObjectLibrary.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/object/PythonObjectLibrary.java
@@ -238,23 +238,32 @@ public boolean canBeIndex(Object receiver) {
      * </ol>
      * @return <code>-1</code> if the cast fails or overflows the <code>int</code> range
      */
-    public int asIndexWithState(Object receiver, ThreadState threadState) {
+    public int asIndexWithState(Object receiver, LazyPythonClass errorType, ThreadState threadState) {
         if (threadState == null) {
-            throw new AbstractMethodError();
+            throw PRaiseNode.getUncached().raiseIntegerInterpretationError(receiver);
         }
-        return asIndex(receiver);
+        return asIndex(receiver, errorType);
     }
 
     /**
-     * Coerces the receiver into an index-sized integer, using the same
-     * mechanism as {@code PyNumber_AsSsize_t}:
-     * <ol>
-     * <li> Call <code>__index__</code> (resp. <code>PyNumber_Index</code>)
-     * <li> Do a hard cast to long as per <code>PyLong_AsSsize_t</code>
-     * </ol>
+     * @see #asIndexWithState(Object, LazyPythonClass, ThreadState)
+     */
+    public final int asIndexWithState(Object receiver, ThreadState threadState) {
+        return asIndexWithState(receiver, PythonBuiltinClassType.OverflowError, threadState);
+    }
+
+    /**
+     * @see #asIndexWithState(Object, LazyPythonClass, ThreadState)
+     */
+    public int asIndex(Object receiver, LazyPythonClass errorClass) {
+        return asIndexWithState(receiver, errorClass, null);
+    }
+
+    /**
+     * @see #asIndexWithState(Object, LazyPythonClass, ThreadState)
      */
-    public int asIndex(Object receiver) {
-        return asIndexWithState(receiver, null);
+    public final int asIndex(Object receiver) {
+        return asIndex(receiver, PythonBuiltinClassType.OverflowError);
     }
 
     /**
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/PRaiseNode.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/PRaiseNode.java
@@ -49,7 +49,6 @@
 import com.oracle.graal.python.builtins.objects.type.PythonManagedClass;
 import com.oracle.graal.python.nodes.attributes.WriteAttributeToDynamicObjectNode;
 import com.oracle.graal.python.runtime.exception.PException;
-import com.oracle.graal.python.runtime.exception.PythonErrorType;
 import com.oracle.graal.python.runtime.object.PythonObjectFactory;
 import com.oracle.truffle.api.Assumption;
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
@@ -77,8 +76,12 @@ public final PException raise(PythonBuiltinClassType type, Exception e) {
         throw execute(type, PNone.NO_VALUE, getMessage(e), new Object[0]);
     }
 
-    public final PException raiseIndexError() {
-        return raise(PythonErrorType.IndexError, "cannot fit 'int' into an index-sized integer");
+    public final PException raiseIndexError(LazyPythonClass type, Object result) {
+        return execute(type, PNone.NO_VALUE, "cannot fit '%p' into an index-sized integer", new Object[] { result });
+    }
+
+    public final PException raiseIntegerInterpretationError(Object result) {
+        return raise(PythonBuiltinClassType.TypeError, "'%p' object cannot be interpreted as an integer", result);
     }
 
     public final PException raise(LazyPythonClass exceptionType) {

Original file line number	Diff line number	Diff line change
`@@ -213,7 +213,7 @@ int doLongOvf(long index, int length, String errorMessage,`
`213`	`213`	`try {`
`214`	`214`	`return doLong(index, length, errorMessage, negativeIndexProfile, boundsCheckNode);`
`215`	`215`	`} catch (ArithmeticException e) {`
`216`		`- throw raiseNode.raiseIndexError();`
	`216`	`+ throw raiseNode.raiseIndexError(PythonBuiltinClassType.IndexError, index);`
`217`	`217`	`}`
`218`	`218`	`}`
`219`	`219`
`@@ -233,7 +233,7 @@ int doPIntOvf(PInt index, int length, String errorMessage,`
`233`	`233`	`try {`
`234`	`234`	`return doPInt(index, length, errorMessage, negativeIndexProfile, boundsCheckNode);`
`235`	`235`	`} catch (ArithmeticException e) {`
`236`		`- throw raiseNode.raiseIndexError();`
	`236`	`+ throw raiseNode.raiseIndexError(PythonBuiltinClassType.IndexError, index);`
`237`	`237`	`}`
`238`	`238`	`}`
`239`	`239`
`@@ -272,7 +272,7 @@ int doLongOvf(long index, int length, String errorMessage,`
`272`	`272`	`try {`
`273`	`273`	`return doLong(index, length, errorMessage, negativeIndexProfile);`
`274`	`274`	`} catch (ArithmeticException e) {`
`275`		`- throw raiseNode.raiseIndexError();`
	`275`	`+ throw raiseNode.raiseIndexError(PythonBuiltinClassType.IndexError, index);`
`276`	`276`	`}`
`277`	`277`	`}`
`278`	`278`
`@@ -290,7 +290,7 @@ int doPIntOvf(PInt index, int length, String errorMessage,`
`290`	`290`	`try {`
`291`	`291`	`return doPInt(index, length, errorMessage, negativeIndexProfile);`
`292`	`292`	`} catch (ArithmeticException e) {`
`293`		`- throw raiseNode.raiseIndexError();`
	`293`	`+ throw raiseNode.raiseIndexError(PythonBuiltinClassType.IndexError, index);`
`294`	`294`	`}`
`295`	`295`	`}`
`296`	`296`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ static boolean canBeIndex(@SuppressWarnings("unused") Boolean value) {`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`@ExportMessage`
`56`		`- static int asIndex(Boolean value) {`
	`56`	`+ static int asIndex(Boolean value, @SuppressWarnings("unused") LazyPythonClass errorType) {`
`57`	`57`	`return value ? 1 : 0;`
`58`	`58`	`}`
`59`	`59`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ static boolean canBeIndex(@SuppressWarnings("unused") Integer value) {`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`@ExportMessage`
`61`		`- static int asIndex(Integer value) {`
	`61`	`+ static int asIndex(Integer value, @SuppressWarnings("unused") LazyPythonClass errorType) {`
`62`	`62`	`return value;`
`63`	`63`	`}`
`64`	`64`
Original file line number	Diff line number	Diff line change
`@@ -64,17 +64,17 @@ static boolean canBeIndex(@SuppressWarnings("unused") Long value) {`
`64`	`64`	`@ExportMessage`
`65`	`65`	`static class AsIndex {`
`66`	`66`	`@Specialization(rewriteOn = ArithmeticException.class)`
`67`		`- static int noOverflow(Long self) {`
	`67`	`+ static int noOverflow(Long self, @SuppressWarnings("unused") LazyPythonClass type) {`
`68`	`68`	`return PInt.intValueExact(self);`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`@Specialization(replaces = "noOverflow")`
`72`		`- static int withOverflow(Long self,`
	`72`	`+ static int withOverflow(Long self, LazyPythonClass type,`
`73`	`73`	`@Cached PRaiseNode raise) {`
`74`	`74`	`try {`
`75`	`75`	`return PInt.intValueExact(self);`
`76`	`76`	`} catch (ArithmeticException e) {`
`77`		`- throw raise.raise(PythonBuiltinClassType.OverflowError, "cannot fit '%p' into an index-sized integer", self);`
	`77`	`+ throw raise.raiseIndexError(type, self);`
`78`	`78`	`}`
`79`	`79`	`}`
`80`	`80`	`}`