blob: 3f9837fc93588337c8a35533b72661d7a86c0861 [file] [log] [blame]
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001/* Long (arbitrary precision) integer object implementation */
2
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003/* XXX The functional organization of this file is terrible */
4
Guido van Rossumc0b618a1997-05-02 03:12:38 +00005#include "Python.h"
Guido van Rossumedcc38a1991-05-05 20:09:44 +00006#include "longintrepr.h"
Guido van Rossumc0b618a1997-05-02 03:12:38 +00007
Mark Dickinsonc6300392009-04-20 21:38:00 +00008#include <float.h>
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00009#include <ctype.h>
Mark Dickinson5a74bf62009-02-15 11:04:38 +000010#include <stddef.h>
Guido van Rossumedcc38a1991-05-05 20:09:44 +000011
Guido van Rossumddefaf32007-01-14 03:31:43 +000012#ifndef NSMALLPOSINTS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000013#define NSMALLPOSINTS 257
Guido van Rossumddefaf32007-01-14 03:31:43 +000014#endif
15#ifndef NSMALLNEGINTS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000016#define NSMALLNEGINTS 5
Guido van Rossumddefaf32007-01-14 03:31:43 +000017#endif
Facundo Batista6e6f59b2008-07-24 18:57:11 +000018
Mark Dickinsone4416742009-02-15 15:14:57 +000019/* convert a PyLong of size 1, 0 or -1 to an sdigit */
Victor Stinner08a80b12013-07-17 22:33:42 +020020#define MEDIUM_VALUE(x) (assert(-1 <= Py_SIZE(x) && Py_SIZE(x) <= 1), \
21 Py_SIZE(x) < 0 ? -(sdigit)(x)->ob_digit[0] : \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000022 (Py_SIZE(x) == 0 ? (sdigit)0 : \
23 (sdigit)(x)->ob_digit[0]))
Facundo Batista6e6f59b2008-07-24 18:57:11 +000024
Guido van Rossumddefaf32007-01-14 03:31:43 +000025#if NSMALLNEGINTS + NSMALLPOSINTS > 0
26/* Small integers are preallocated in this array so that they
27 can be shared.
28 The integers that are preallocated are those in the range
29 -NSMALLNEGINTS (inclusive) to NSMALLPOSINTS (not inclusive).
30*/
31static PyLongObject small_ints[NSMALLNEGINTS + NSMALLPOSINTS];
32#ifdef COUNT_ALLOCS
Mark Dickinsonc286e582012-09-20 21:29:28 +010033Py_ssize_t quick_int_allocs, quick_neg_int_allocs;
Guido van Rossumddefaf32007-01-14 03:31:43 +000034#endif
35
Guido van Rossum7eaf8222007-06-18 17:58:50 +000036static PyObject *
Mark Dickinsone4416742009-02-15 15:14:57 +000037get_small_int(sdigit ival)
Guido van Rossumddefaf32007-01-14 03:31:43 +000038{
Benjamin Peterson45c9dce2014-03-14 21:53:51 -050039 PyObject *v;
Benjamin Peterson041c38a2014-03-14 21:47:23 -050040 assert(-NSMALLNEGINTS <= ival && ival < NSMALLPOSINTS);
Benjamin Peterson45c9dce2014-03-14 21:53:51 -050041 v = (PyObject *)&small_ints[ival + NSMALLNEGINTS];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000042 Py_INCREF(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +000043#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000044 if (ival >= 0)
45 quick_int_allocs++;
46 else
47 quick_neg_int_allocs++;
Guido van Rossumddefaf32007-01-14 03:31:43 +000048#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000049 return v;
Guido van Rossumddefaf32007-01-14 03:31:43 +000050}
51#define CHECK_SMALL_INT(ival) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000052 do if (-NSMALLNEGINTS <= ival && ival < NSMALLPOSINTS) { \
53 return get_small_int((sdigit)ival); \
54 } while(0)
Guido van Rossumddefaf32007-01-14 03:31:43 +000055
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000056static PyLongObject *
Facundo Batista6e6f59b2008-07-24 18:57:11 +000057maybe_small_long(PyLongObject *v)
58{
Victor Stinner45e8e2f2014-05-14 17:24:35 +020059 if (v && Py_ABS(Py_SIZE(v)) <= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000060 sdigit ival = MEDIUM_VALUE(v);
61 if (-NSMALLNEGINTS <= ival && ival < NSMALLPOSINTS) {
62 Py_DECREF(v);
63 return (PyLongObject *)get_small_int(ival);
64 }
65 }
66 return v;
Facundo Batista6e6f59b2008-07-24 18:57:11 +000067}
Guido van Rossumddefaf32007-01-14 03:31:43 +000068#else
69#define CHECK_SMALL_INT(ival)
Facundo Batista6e6f59b2008-07-24 18:57:11 +000070#define maybe_small_long(val) (val)
Guido van Rossumddefaf32007-01-14 03:31:43 +000071#endif
72
Serhiy Storchaka95949422013-08-27 19:40:23 +030073/* If a freshly-allocated int is already shared, it must
Guido van Rossumddefaf32007-01-14 03:31:43 +000074 be a small integer, so negating it must go to PyLong_FromLong */
Victor Stinner8aed6f12013-07-17 22:31:17 +020075Py_LOCAL_INLINE(void)
76_PyLong_Negate(PyLongObject **x_p)
77{
78 PyLongObject *x;
79
80 x = (PyLongObject *)*x_p;
81 if (Py_REFCNT(x) == 1) {
82 Py_SIZE(x) = -Py_SIZE(x);
83 return;
84 }
85
86 *x_p = (PyLongObject *)PyLong_FromLong(-MEDIUM_VALUE(x));
87 Py_DECREF(x);
88}
89
Serhiy Storchaka95949422013-08-27 19:40:23 +030090/* For int multiplication, use the O(N**2) school algorithm unless
Tim Peters5af4e6c2002-08-12 02:31:19 +000091 * both operands contain more than KARATSUBA_CUTOFF digits (this
Serhiy Storchaka95949422013-08-27 19:40:23 +030092 * being an internal Python int digit, in base BASE).
Tim Peters5af4e6c2002-08-12 02:31:19 +000093 */
Tim Peters0973b992004-08-29 22:16:50 +000094#define KARATSUBA_CUTOFF 70
95#define KARATSUBA_SQUARE_CUTOFF (2 * KARATSUBA_CUTOFF)
Tim Peters5af4e6c2002-08-12 02:31:19 +000096
Tim Peters47e52ee2004-08-30 02:44:38 +000097/* For exponentiation, use the binary left-to-right algorithm
98 * unless the exponent contains more than FIVEARY_CUTOFF digits.
99 * In that case, do 5 bits at a time. The potential drawback is that
100 * a table of 2**5 intermediate results is computed.
101 */
102#define FIVEARY_CUTOFF 8
103
Mark Dickinsoncdd01d22010-05-10 21:37:34 +0000104#define SIGCHECK(PyTryBlock) \
105 do { \
106 if (PyErr_CheckSignals()) PyTryBlock \
107 } while(0)
Guido van Rossum23d6f0e1991-05-14 12:06:49 +0000108
Serhiy Storchaka95949422013-08-27 19:40:23 +0300109/* Normalize (remove leading zeros from) an int object.
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000110 Doesn't attempt to free the storage--in most cases, due to the nature
111 of the algorithms used, this could save at most be one word anyway. */
112
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000113static PyLongObject *
Antoine Pitrou9ed5f272013-08-13 20:18:52 +0200114long_normalize(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000115{
Victor Stinner45e8e2f2014-05-14 17:24:35 +0200116 Py_ssize_t j = Py_ABS(Py_SIZE(v));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000117 Py_ssize_t i = j;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000118
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000119 while (i > 0 && v->ob_digit[i-1] == 0)
120 --i;
121 if (i != j)
122 Py_SIZE(v) = (Py_SIZE(v) < 0) ? -(i) : i;
123 return v;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000124}
125
Serhiy Storchaka31a65542013-12-11 21:07:54 +0200126/* _PyLong_FromNbInt: Convert the given object to a PyLongObject
127 using the nb_int slot, if available. Raise TypeError if either the
128 nb_int slot is not available or the result of the call to nb_int
129 returns something not of type int.
130*/
131PyLongObject *
132_PyLong_FromNbInt(PyObject *integral)
133{
134 PyNumberMethods *nb;
135 PyObject *result;
136
137 /* Fast path for the case that we already have an int. */
138 if (PyLong_CheckExact(integral)) {
139 Py_INCREF(integral);
140 return (PyLongObject *)integral;
141 }
142
143 nb = Py_TYPE(integral)->tp_as_number;
144 if (nb == NULL || nb->nb_int == NULL) {
145 PyErr_Format(PyExc_TypeError,
146 "an integer is required (got type %.200s)",
147 Py_TYPE(integral)->tp_name);
148 return NULL;
149 }
150
151 /* Convert using the nb_int slot, which should return something
152 of exact type int. */
153 result = nb->nb_int(integral);
154 if (!result || PyLong_CheckExact(result))
155 return (PyLongObject *)result;
156 if (!PyLong_Check(result)) {
157 PyErr_Format(PyExc_TypeError,
158 "__int__ returned non-int (type %.200s)",
159 result->ob_type->tp_name);
160 Py_DECREF(result);
161 return NULL;
162 }
163 /* Issue #17576: warn if 'result' not of exact type int. */
164 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
165 "__int__ returned non-int (type %.200s). "
166 "The ability to return an instance of a strict subclass of int "
167 "is deprecated, and may be removed in a future version of Python.",
168 result->ob_type->tp_name)) {
169 Py_DECREF(result);
170 return NULL;
171 }
172 return (PyLongObject *)result;
173}
174
175
Serhiy Storchaka95949422013-08-27 19:40:23 +0300176/* Allocate a new int object with size digits.
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000177 Return NULL and set exception if we run out of memory. */
178
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000179#define MAX_LONG_DIGITS \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000180 ((PY_SSIZE_T_MAX - offsetof(PyLongObject, ob_digit))/sizeof(digit))
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000181
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000182PyLongObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000183_PyLong_New(Py_ssize_t size)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000184{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000185 PyLongObject *result;
186 /* Number of bytes needed is: offsetof(PyLongObject, ob_digit) +
187 sizeof(digit)*size. Previous incarnations of this code used
188 sizeof(PyVarObject) instead of the offsetof, but this risks being
189 incorrect in the presence of padding between the PyVarObject header
190 and the digits. */
191 if (size > (Py_ssize_t)MAX_LONG_DIGITS) {
192 PyErr_SetString(PyExc_OverflowError,
193 "too many digits in integer");
194 return NULL;
195 }
196 result = PyObject_MALLOC(offsetof(PyLongObject, ob_digit) +
197 size*sizeof(digit));
198 if (!result) {
199 PyErr_NoMemory();
200 return NULL;
201 }
202 return (PyLongObject*)PyObject_INIT_VAR(result, &PyLong_Type, size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000203}
204
Tim Peters64b5ce32001-09-10 20:52:51 +0000205PyObject *
206_PyLong_Copy(PyLongObject *src)
207{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000208 PyLongObject *result;
209 Py_ssize_t i;
Tim Peters64b5ce32001-09-10 20:52:51 +0000210
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000211 assert(src != NULL);
212 i = Py_SIZE(src);
213 if (i < 0)
214 i = -(i);
215 if (i < 2) {
Mark Dickinsonbcc17ee2012-04-20 21:42:49 +0100216 sdigit ival = MEDIUM_VALUE(src);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000217 CHECK_SMALL_INT(ival);
218 }
219 result = _PyLong_New(i);
220 if (result != NULL) {
221 Py_SIZE(result) = Py_SIZE(src);
222 while (--i >= 0)
223 result->ob_digit[i] = src->ob_digit[i];
224 }
225 return (PyObject *)result;
Tim Peters64b5ce32001-09-10 20:52:51 +0000226}
227
Serhiy Storchaka95949422013-08-27 19:40:23 +0300228/* Create a new int object from a C long int */
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000229
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000230PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000231PyLong_FromLong(long ival)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000232{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000233 PyLongObject *v;
234 unsigned long abs_ival;
235 unsigned long t; /* unsigned so >> doesn't propagate sign bit */
236 int ndigits = 0;
237 int sign = 1;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000238
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000239 CHECK_SMALL_INT(ival);
Tim Petersce9de2f2001-06-14 04:56:19 +0000240
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000241 if (ival < 0) {
242 /* negate: can't write this as abs_ival = -ival since that
243 invokes undefined behaviour when ival is LONG_MIN */
244 abs_ival = 0U-(unsigned long)ival;
245 sign = -1;
246 }
247 else {
248 abs_ival = (unsigned long)ival;
249 }
Tim Petersce9de2f2001-06-14 04:56:19 +0000250
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000251 /* Fast path for single-digit ints */
252 if (!(abs_ival >> PyLong_SHIFT)) {
253 v = _PyLong_New(1);
254 if (v) {
255 Py_SIZE(v) = sign;
256 v->ob_digit[0] = Py_SAFE_DOWNCAST(
257 abs_ival, unsigned long, digit);
258 }
259 return (PyObject*)v;
260 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000261
Mark Dickinson249b8982009-04-27 19:41:00 +0000262#if PyLong_SHIFT==15
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000263 /* 2 digits */
264 if (!(abs_ival >> 2*PyLong_SHIFT)) {
265 v = _PyLong_New(2);
266 if (v) {
267 Py_SIZE(v) = 2*sign;
268 v->ob_digit[0] = Py_SAFE_DOWNCAST(
269 abs_ival & PyLong_MASK, unsigned long, digit);
270 v->ob_digit[1] = Py_SAFE_DOWNCAST(
271 abs_ival >> PyLong_SHIFT, unsigned long, digit);
272 }
273 return (PyObject*)v;
274 }
Mark Dickinsonbd792642009-03-18 20:06:12 +0000275#endif
Guido van Rossumddefaf32007-01-14 03:31:43 +0000276
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000277 /* Larger numbers: loop to determine number of digits */
278 t = abs_ival;
279 while (t) {
280 ++ndigits;
281 t >>= PyLong_SHIFT;
282 }
283 v = _PyLong_New(ndigits);
284 if (v != NULL) {
285 digit *p = v->ob_digit;
286 Py_SIZE(v) = ndigits*sign;
287 t = abs_ival;
288 while (t) {
289 *p++ = Py_SAFE_DOWNCAST(
290 t & PyLong_MASK, unsigned long, digit);
291 t >>= PyLong_SHIFT;
292 }
293 }
294 return (PyObject *)v;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000295}
296
Serhiy Storchaka95949422013-08-27 19:40:23 +0300297/* Create a new int object from a C unsigned long int */
Guido van Rossum53756b11997-01-03 17:14:46 +0000298
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000299PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000300PyLong_FromUnsignedLong(unsigned long ival)
Guido van Rossum53756b11997-01-03 17:14:46 +0000301{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000302 PyLongObject *v;
303 unsigned long t;
304 int ndigits = 0;
Tim Petersce9de2f2001-06-14 04:56:19 +0000305
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000306 if (ival < PyLong_BASE)
307 return PyLong_FromLong(ival);
308 /* Count the number of Python digits. */
309 t = (unsigned long)ival;
310 while (t) {
311 ++ndigits;
312 t >>= PyLong_SHIFT;
313 }
314 v = _PyLong_New(ndigits);
315 if (v != NULL) {
316 digit *p = v->ob_digit;
317 Py_SIZE(v) = ndigits;
318 while (ival) {
319 *p++ = (digit)(ival & PyLong_MASK);
320 ival >>= PyLong_SHIFT;
321 }
322 }
323 return (PyObject *)v;
Guido van Rossum53756b11997-01-03 17:14:46 +0000324}
325
Serhiy Storchaka95949422013-08-27 19:40:23 +0300326/* Create a new int object from a C double */
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000327
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000328PyObject *
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000329PyLong_FromDouble(double dval)
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000330{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000331 PyLongObject *v;
332 double frac;
333 int i, ndig, expo, neg;
334 neg = 0;
335 if (Py_IS_INFINITY(dval)) {
336 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson22b20182010-05-10 21:27:53 +0000337 "cannot convert float infinity to integer");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000338 return NULL;
339 }
340 if (Py_IS_NAN(dval)) {
341 PyErr_SetString(PyExc_ValueError,
Mark Dickinson22b20182010-05-10 21:27:53 +0000342 "cannot convert float NaN to integer");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 return NULL;
344 }
345 if (dval < 0.0) {
346 neg = 1;
347 dval = -dval;
348 }
349 frac = frexp(dval, &expo); /* dval = frac*2**expo; 0.0 <= frac < 1.0 */
350 if (expo <= 0)
351 return PyLong_FromLong(0L);
352 ndig = (expo-1) / PyLong_SHIFT + 1; /* Number of 'digits' in result */
353 v = _PyLong_New(ndig);
354 if (v == NULL)
355 return NULL;
356 frac = ldexp(frac, (expo-1) % PyLong_SHIFT + 1);
357 for (i = ndig; --i >= 0; ) {
358 digit bits = (digit)frac;
359 v->ob_digit[i] = bits;
360 frac = frac - (double)bits;
361 frac = ldexp(frac, PyLong_SHIFT);
362 }
363 if (neg)
364 Py_SIZE(v) = -(Py_SIZE(v));
365 return (PyObject *)v;
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000366}
367
Thomas Wouters89f507f2006-12-13 04:49:30 +0000368/* Checking for overflow in PyLong_AsLong is a PITA since C doesn't define
369 * anything about what happens when a signed integer operation overflows,
370 * and some compilers think they're doing you a favor by being "clever"
371 * then. The bit pattern for the largest postive signed long is
372 * (unsigned long)LONG_MAX, and for the smallest negative signed long
373 * it is abs(LONG_MIN), which we could write -(unsigned long)LONG_MIN.
374 * However, some other compilers warn about applying unary minus to an
375 * unsigned operand. Hence the weird "0-".
376 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377#define PY_ABS_LONG_MIN (0-(unsigned long)LONG_MIN)
378#define PY_ABS_SSIZE_T_MIN (0-(size_t)PY_SSIZE_T_MIN)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000379
Serhiy Storchaka95949422013-08-27 19:40:23 +0300380/* Get a C long int from an int object or any object that has an __int__
Mark Dickinson8d48b432011-10-23 20:47:14 +0100381 method.
382
383 On overflow, return -1 and set *overflow to 1 or -1 depending on the sign of
384 the result. Otherwise *overflow is 0.
385
386 For other errors (e.g., TypeError), return -1 and set an error condition.
387 In this case *overflow will be 0.
388*/
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000389
390long
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000391PyLong_AsLongAndOverflow(PyObject *vv, int *overflow)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000392{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000393 /* This version by Tim Peters */
Antoine Pitrou9ed5f272013-08-13 20:18:52 +0200394 PyLongObject *v;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000395 unsigned long x, prev;
396 long res;
397 Py_ssize_t i;
398 int sign;
399 int do_decref = 0; /* if nb_int was called */
Guido van Rossumf7531811998-05-26 14:33:37 +0000400
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000401 *overflow = 0;
402 if (vv == NULL) {
403 PyErr_BadInternalCall();
404 return -1;
405 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000406
Serhiy Storchaka31a65542013-12-11 21:07:54 +0200407 if (PyLong_Check(vv)) {
408 v = (PyLongObject *)vv;
409 }
410 else {
411 v = _PyLong_FromNbInt(vv);
412 if (v == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000413 return -1;
414 do_decref = 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000415 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000416
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000417 res = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000418 i = Py_SIZE(v);
Guido van Rossumf7531811998-05-26 14:33:37 +0000419
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 switch (i) {
421 case -1:
422 res = -(sdigit)v->ob_digit[0];
423 break;
424 case 0:
425 res = 0;
426 break;
427 case 1:
428 res = v->ob_digit[0];
429 break;
430 default:
431 sign = 1;
432 x = 0;
433 if (i < 0) {
434 sign = -1;
435 i = -(i);
436 }
437 while (--i >= 0) {
438 prev = x;
439 x = (x << PyLong_SHIFT) | v->ob_digit[i];
440 if ((x >> PyLong_SHIFT) != prev) {
441 *overflow = sign;
442 goto exit;
443 }
444 }
445 /* Haven't lost any bits, but casting to long requires extra
446 * care (see comment above).
447 */
448 if (x <= (unsigned long)LONG_MAX) {
449 res = (long)x * sign;
450 }
451 else if (sign < 0 && x == PY_ABS_LONG_MIN) {
452 res = LONG_MIN;
453 }
454 else {
455 *overflow = sign;
456 /* res is already set to -1 */
457 }
458 }
Mark Dickinson22b20182010-05-10 21:27:53 +0000459 exit:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000460 if (do_decref) {
Serhiy Storchaka31a65542013-12-11 21:07:54 +0200461 Py_DECREF(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000462 }
463 return res;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000464}
465
Serhiy Storchaka95949422013-08-27 19:40:23 +0300466/* Get a C long int from an int object or any object that has an __int__
Mark Dickinson8d48b432011-10-23 20:47:14 +0100467 method. Return -1 and set an error if overflow occurs. */
468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000469long
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000470PyLong_AsLong(PyObject *obj)
471{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000472 int overflow;
473 long result = PyLong_AsLongAndOverflow(obj, &overflow);
474 if (overflow) {
475 /* XXX: could be cute and give a different
476 message for overflow == -1 */
477 PyErr_SetString(PyExc_OverflowError,
478 "Python int too large to convert to C long");
479 }
480 return result;
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000481}
482
Serhiy Storchaka95949422013-08-27 19:40:23 +0300483/* Get a C int from an int object or any object that has an __int__
Serhiy Storchaka78980432013-01-15 01:12:17 +0200484 method. Return -1 and set an error if overflow occurs. */
485
486int
487_PyLong_AsInt(PyObject *obj)
488{
489 int overflow;
490 long result = PyLong_AsLongAndOverflow(obj, &overflow);
491 if (overflow || result > INT_MAX || result < INT_MIN) {
492 /* XXX: could be cute and give a different
493 message for overflow == -1 */
494 PyErr_SetString(PyExc_OverflowError,
495 "Python int too large to convert to C int");
496 return -1;
497 }
498 return (int)result;
499}
500
Serhiy Storchaka95949422013-08-27 19:40:23 +0300501/* Get a Py_ssize_t from an int object.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000502 Returns -1 and sets an error condition if overflow occurs. */
503
504Py_ssize_t
Guido van Rossumddefaf32007-01-14 03:31:43 +0000505PyLong_AsSsize_t(PyObject *vv) {
Antoine Pitrou9ed5f272013-08-13 20:18:52 +0200506 PyLongObject *v;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 size_t x, prev;
508 Py_ssize_t i;
509 int sign;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511 if (vv == NULL) {
512 PyErr_BadInternalCall();
513 return -1;
514 }
515 if (!PyLong_Check(vv)) {
516 PyErr_SetString(PyExc_TypeError, "an integer is required");
517 return -1;
518 }
Mark Dickinsond59b4162010-03-13 11:34:40 +0000519
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000520 v = (PyLongObject *)vv;
521 i = Py_SIZE(v);
522 switch (i) {
523 case -1: return -(sdigit)v->ob_digit[0];
524 case 0: return 0;
525 case 1: return v->ob_digit[0];
526 }
527 sign = 1;
528 x = 0;
529 if (i < 0) {
530 sign = -1;
531 i = -(i);
532 }
533 while (--i >= 0) {
534 prev = x;
535 x = (x << PyLong_SHIFT) | v->ob_digit[i];
536 if ((x >> PyLong_SHIFT) != prev)
537 goto overflow;
538 }
539 /* Haven't lost any bits, but casting to a signed type requires
540 * extra care (see comment above).
541 */
542 if (x <= (size_t)PY_SSIZE_T_MAX) {
543 return (Py_ssize_t)x * sign;
544 }
545 else if (sign < 0 && x == PY_ABS_SSIZE_T_MIN) {
546 return PY_SSIZE_T_MIN;
547 }
548 /* else overflow */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000549
Mark Dickinson22b20182010-05-10 21:27:53 +0000550 overflow:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000551 PyErr_SetString(PyExc_OverflowError,
552 "Python int too large to convert to C ssize_t");
553 return -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000554}
555
Serhiy Storchaka95949422013-08-27 19:40:23 +0300556/* Get a C unsigned long int from an int object.
Guido van Rossum53756b11997-01-03 17:14:46 +0000557 Returns -1 and sets an error condition if overflow occurs. */
558
559unsigned long
Tim Peters9f688bf2000-07-07 15:53:28 +0000560PyLong_AsUnsignedLong(PyObject *vv)
Guido van Rossum53756b11997-01-03 17:14:46 +0000561{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +0200562 PyLongObject *v;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000563 unsigned long x, prev;
564 Py_ssize_t i;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000565
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000566 if (vv == NULL) {
567 PyErr_BadInternalCall();
568 return (unsigned long)-1;
569 }
570 if (!PyLong_Check(vv)) {
571 PyErr_SetString(PyExc_TypeError, "an integer is required");
572 return (unsigned long)-1;
573 }
Mark Dickinsond59b4162010-03-13 11:34:40 +0000574
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000575 v = (PyLongObject *)vv;
576 i = Py_SIZE(v);
577 x = 0;
578 if (i < 0) {
579 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson22b20182010-05-10 21:27:53 +0000580 "can't convert negative value to unsigned int");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000581 return (unsigned long) -1;
582 }
583 switch (i) {
584 case 0: return 0;
585 case 1: return v->ob_digit[0];
586 }
587 while (--i >= 0) {
588 prev = x;
589 x = (x << PyLong_SHIFT) | v->ob_digit[i];
590 if ((x >> PyLong_SHIFT) != prev) {
591 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson02515f72013-08-03 12:08:22 +0100592 "Python int too large to convert "
Mark Dickinson22b20182010-05-10 21:27:53 +0000593 "to C unsigned long");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000594 return (unsigned long) -1;
595 }
596 }
597 return x;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000598}
599
Serhiy Storchaka95949422013-08-27 19:40:23 +0300600/* Get a C size_t from an int object. Returns (size_t)-1 and sets
Stefan Krahb77c6c62011-09-12 16:22:47 +0200601 an error condition if overflow occurs. */
Guido van Rossumddefaf32007-01-14 03:31:43 +0000602
603size_t
604PyLong_AsSize_t(PyObject *vv)
605{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +0200606 PyLongObject *v;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000607 size_t x, prev;
608 Py_ssize_t i;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000609
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000610 if (vv == NULL) {
611 PyErr_BadInternalCall();
612 return (size_t) -1;
613 }
614 if (!PyLong_Check(vv)) {
615 PyErr_SetString(PyExc_TypeError, "an integer is required");
616 return (size_t)-1;
617 }
Mark Dickinsond59b4162010-03-13 11:34:40 +0000618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 v = (PyLongObject *)vv;
620 i = Py_SIZE(v);
621 x = 0;
622 if (i < 0) {
623 PyErr_SetString(PyExc_OverflowError,
624 "can't convert negative value to size_t");
625 return (size_t) -1;
626 }
627 switch (i) {
628 case 0: return 0;
629 case 1: return v->ob_digit[0];
630 }
631 while (--i >= 0) {
632 prev = x;
633 x = (x << PyLong_SHIFT) | v->ob_digit[i];
634 if ((x >> PyLong_SHIFT) != prev) {
635 PyErr_SetString(PyExc_OverflowError,
636 "Python int too large to convert to C size_t");
Stefan Krahb77c6c62011-09-12 16:22:47 +0200637 return (size_t) -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000638 }
639 }
640 return x;
Guido van Rossum53756b11997-01-03 17:14:46 +0000641}
642
Serhiy Storchaka95949422013-08-27 19:40:23 +0300643/* Get a C unsigned long int from an int object, ignoring the high bits.
Thomas Hellera4ea6032003-04-17 18:55:45 +0000644 Returns -1 and sets an error condition if an error occurs. */
645
Guido van Rossumddefaf32007-01-14 03:31:43 +0000646static unsigned long
647_PyLong_AsUnsignedLongMask(PyObject *vv)
Thomas Hellera4ea6032003-04-17 18:55:45 +0000648{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +0200649 PyLongObject *v;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000650 unsigned long x;
651 Py_ssize_t i;
652 int sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +0000653
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000654 if (vv == NULL || !PyLong_Check(vv)) {
655 PyErr_BadInternalCall();
656 return (unsigned long) -1;
657 }
658 v = (PyLongObject *)vv;
659 i = Py_SIZE(v);
660 switch (i) {
661 case 0: return 0;
662 case 1: return v->ob_digit[0];
663 }
664 sign = 1;
665 x = 0;
666 if (i < 0) {
667 sign = -1;
668 i = -i;
669 }
670 while (--i >= 0) {
671 x = (x << PyLong_SHIFT) | v->ob_digit[i];
672 }
673 return x * sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +0000674}
675
Guido van Rossumddefaf32007-01-14 03:31:43 +0000676unsigned long
Antoine Pitrou9ed5f272013-08-13 20:18:52 +0200677PyLong_AsUnsignedLongMask(PyObject *op)
Guido van Rossumddefaf32007-01-14 03:31:43 +0000678{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000679 PyLongObject *lo;
680 unsigned long val;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000681
Serhiy Storchaka31a65542013-12-11 21:07:54 +0200682 if (op == NULL) {
683 PyErr_BadInternalCall();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000684 return (unsigned long)-1;
685 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000686
Serhiy Storchaka31a65542013-12-11 21:07:54 +0200687 if (PyLong_Check(op)) {
688 return _PyLong_AsUnsignedLongMask(op);
689 }
690
691 lo = _PyLong_FromNbInt(op);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000692 if (lo == NULL)
693 return (unsigned long)-1;
Serhiy Storchaka31a65542013-12-11 21:07:54 +0200694
695 val = _PyLong_AsUnsignedLongMask((PyObject *)lo);
696 Py_DECREF(lo);
697 return val;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000698}
699
Tim Peters5b8132f2003-01-31 15:52:05 +0000700int
701_PyLong_Sign(PyObject *vv)
702{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000703 PyLongObject *v = (PyLongObject *)vv;
Tim Peters5b8132f2003-01-31 15:52:05 +0000704
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000705 assert(v != NULL);
706 assert(PyLong_Check(v));
Tim Peters5b8132f2003-01-31 15:52:05 +0000707
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000708 return Py_SIZE(v) == 0 ? 0 : (Py_SIZE(v) < 0 ? -1 : 1);
Tim Peters5b8132f2003-01-31 15:52:05 +0000709}
710
Tim Petersbaefd9e2003-01-28 20:37:45 +0000711size_t
712_PyLong_NumBits(PyObject *vv)
713{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000714 PyLongObject *v = (PyLongObject *)vv;
715 size_t result = 0;
716 Py_ssize_t ndigits;
Tim Petersbaefd9e2003-01-28 20:37:45 +0000717
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 assert(v != NULL);
719 assert(PyLong_Check(v));
Victor Stinner45e8e2f2014-05-14 17:24:35 +0200720 ndigits = Py_ABS(Py_SIZE(v));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000721 assert(ndigits == 0 || v->ob_digit[ndigits - 1] != 0);
722 if (ndigits > 0) {
723 digit msd = v->ob_digit[ndigits - 1];
Mark Dickinsonfc9adb62012-10-06 18:50:02 +0100724 if ((size_t)(ndigits - 1) > PY_SIZE_MAX / (size_t)PyLong_SHIFT)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000725 goto Overflow;
Mark Dickinsonfc9adb62012-10-06 18:50:02 +0100726 result = (size_t)(ndigits - 1) * (size_t)PyLong_SHIFT;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000727 do {
728 ++result;
729 if (result == 0)
730 goto Overflow;
731 msd >>= 1;
732 } while (msd);
733 }
734 return result;
Tim Petersbaefd9e2003-01-28 20:37:45 +0000735
Mark Dickinson22b20182010-05-10 21:27:53 +0000736 Overflow:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000737 PyErr_SetString(PyExc_OverflowError, "int has too many bits "
738 "to express in a platform size_t");
739 return (size_t)-1;
Tim Petersbaefd9e2003-01-28 20:37:45 +0000740}
741
Tim Peters2a9b3672001-06-11 21:23:58 +0000742PyObject *
743_PyLong_FromByteArray(const unsigned char* bytes, size_t n,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 int little_endian, int is_signed)
Tim Peters2a9b3672001-06-11 21:23:58 +0000745{
Mark Dickinson22b20182010-05-10 21:27:53 +0000746 const unsigned char* pstartbyte; /* LSB of bytes */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 int incr; /* direction to move pstartbyte */
748 const unsigned char* pendbyte; /* MSB of bytes */
749 size_t numsignificantbytes; /* number of bytes that matter */
Serhiy Storchaka95949422013-08-27 19:40:23 +0300750 Py_ssize_t ndigits; /* number of Python int digits */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000751 PyLongObject* v; /* result */
752 Py_ssize_t idigit = 0; /* next free index in v->ob_digit */
Tim Peters2a9b3672001-06-11 21:23:58 +0000753
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000754 if (n == 0)
755 return PyLong_FromLong(0L);
Tim Peters2a9b3672001-06-11 21:23:58 +0000756
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000757 if (little_endian) {
758 pstartbyte = bytes;
759 pendbyte = bytes + n - 1;
760 incr = 1;
761 }
762 else {
763 pstartbyte = bytes + n - 1;
764 pendbyte = bytes;
765 incr = -1;
766 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000767
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000768 if (is_signed)
769 is_signed = *pendbyte >= 0x80;
Tim Peters2a9b3672001-06-11 21:23:58 +0000770
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 /* Compute numsignificantbytes. This consists of finding the most
Ezio Melotti13925002011-03-16 11:05:33 +0200772 significant byte. Leading 0 bytes are insignificant if the number
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000773 is positive, and leading 0xff bytes if negative. */
774 {
775 size_t i;
776 const unsigned char* p = pendbyte;
777 const int pincr = -incr; /* search MSB to LSB */
778 const unsigned char insignficant = is_signed ? 0xff : 0x00;
Tim Peters2a9b3672001-06-11 21:23:58 +0000779
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000780 for (i = 0; i < n; ++i, p += pincr) {
781 if (*p != insignficant)
782 break;
783 }
784 numsignificantbytes = n - i;
785 /* 2's-comp is a bit tricky here, e.g. 0xff00 == -0x0100, so
786 actually has 2 significant bytes. OTOH, 0xff0001 ==
787 -0x00ffff, so we wouldn't *need* to bump it there; but we
788 do for 0xffff = -0x0001. To be safe without bothering to
789 check every case, bump it regardless. */
790 if (is_signed && numsignificantbytes < n)
791 ++numsignificantbytes;
792 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000793
Serhiy Storchaka95949422013-08-27 19:40:23 +0300794 /* How many Python int digits do we need? We have
795 8*numsignificantbytes bits, and each Python int digit has
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000796 PyLong_SHIFT bits, so it's the ceiling of the quotient. */
797 /* catch overflow before it happens */
798 if (numsignificantbytes > (PY_SSIZE_T_MAX - PyLong_SHIFT) / 8) {
799 PyErr_SetString(PyExc_OverflowError,
800 "byte array too long to convert to int");
801 return NULL;
802 }
803 ndigits = (numsignificantbytes * 8 + PyLong_SHIFT - 1) / PyLong_SHIFT;
804 v = _PyLong_New(ndigits);
805 if (v == NULL)
806 return NULL;
Tim Peters2a9b3672001-06-11 21:23:58 +0000807
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 /* Copy the bits over. The tricky parts are computing 2's-comp on
809 the fly for signed numbers, and dealing with the mismatch between
810 8-bit bytes and (probably) 15-bit Python digits.*/
811 {
812 size_t i;
813 twodigits carry = 1; /* for 2's-comp calculation */
814 twodigits accum = 0; /* sliding register */
815 unsigned int accumbits = 0; /* number of bits in accum */
816 const unsigned char* p = pstartbyte;
Tim Peters2a9b3672001-06-11 21:23:58 +0000817
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000818 for (i = 0; i < numsignificantbytes; ++i, p += incr) {
819 twodigits thisbyte = *p;
820 /* Compute correction for 2's comp, if needed. */
821 if (is_signed) {
822 thisbyte = (0xff ^ thisbyte) + carry;
823 carry = thisbyte >> 8;
824 thisbyte &= 0xff;
825 }
826 /* Because we're going LSB to MSB, thisbyte is
827 more significant than what's already in accum,
828 so needs to be prepended to accum. */
829 accum |= (twodigits)thisbyte << accumbits;
830 accumbits += 8;
831 if (accumbits >= PyLong_SHIFT) {
832 /* There's enough to fill a Python digit. */
833 assert(idigit < ndigits);
Mark Dickinson22b20182010-05-10 21:27:53 +0000834 v->ob_digit[idigit] = (digit)(accum & PyLong_MASK);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000835 ++idigit;
836 accum >>= PyLong_SHIFT;
837 accumbits -= PyLong_SHIFT;
838 assert(accumbits < PyLong_SHIFT);
839 }
840 }
841 assert(accumbits < PyLong_SHIFT);
842 if (accumbits) {
843 assert(idigit < ndigits);
844 v->ob_digit[idigit] = (digit)accum;
845 ++idigit;
846 }
847 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000848
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000849 Py_SIZE(v) = is_signed ? -idigit : idigit;
850 return (PyObject *)long_normalize(v);
Tim Peters2a9b3672001-06-11 21:23:58 +0000851}
852
853int
854_PyLong_AsByteArray(PyLongObject* v,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000855 unsigned char* bytes, size_t n,
856 int little_endian, int is_signed)
Tim Peters2a9b3672001-06-11 21:23:58 +0000857{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000858 Py_ssize_t i; /* index into v->ob_digit */
Mark Dickinson22b20182010-05-10 21:27:53 +0000859 Py_ssize_t ndigits; /* |v->ob_size| */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000860 twodigits accum; /* sliding register */
Mark Dickinson22b20182010-05-10 21:27:53 +0000861 unsigned int accumbits; /* # bits in accum */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000862 int do_twos_comp; /* store 2's-comp? is_signed and v < 0 */
863 digit carry; /* for computing 2's-comp */
864 size_t j; /* # bytes filled */
865 unsigned char* p; /* pointer to next byte in bytes */
866 int pincr; /* direction to move p */
Tim Peters2a9b3672001-06-11 21:23:58 +0000867
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000868 assert(v != NULL && PyLong_Check(v));
Tim Peters2a9b3672001-06-11 21:23:58 +0000869
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 if (Py_SIZE(v) < 0) {
871 ndigits = -(Py_SIZE(v));
872 if (!is_signed) {
873 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson22b20182010-05-10 21:27:53 +0000874 "can't convert negative int to unsigned");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000875 return -1;
876 }
877 do_twos_comp = 1;
878 }
879 else {
880 ndigits = Py_SIZE(v);
881 do_twos_comp = 0;
882 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 if (little_endian) {
885 p = bytes;
886 pincr = 1;
887 }
888 else {
889 p = bytes + n - 1;
890 pincr = -1;
891 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000892
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000893 /* Copy over all the Python digits.
894 It's crucial that every Python digit except for the MSD contribute
Serhiy Storchaka95949422013-08-27 19:40:23 +0300895 exactly PyLong_SHIFT bits to the total, so first assert that the int is
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000896 normalized. */
897 assert(ndigits == 0 || v->ob_digit[ndigits - 1] != 0);
898 j = 0;
899 accum = 0;
900 accumbits = 0;
901 carry = do_twos_comp ? 1 : 0;
902 for (i = 0; i < ndigits; ++i) {
903 digit thisdigit = v->ob_digit[i];
904 if (do_twos_comp) {
905 thisdigit = (thisdigit ^ PyLong_MASK) + carry;
906 carry = thisdigit >> PyLong_SHIFT;
907 thisdigit &= PyLong_MASK;
908 }
909 /* Because we're going LSB to MSB, thisdigit is more
910 significant than what's already in accum, so needs to be
911 prepended to accum. */
912 accum |= (twodigits)thisdigit << accumbits;
Tim Peters8bc84b42001-06-12 19:17:03 +0000913
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000914 /* The most-significant digit may be (probably is) at least
915 partly empty. */
916 if (i == ndigits - 1) {
917 /* Count # of sign bits -- they needn't be stored,
918 * although for signed conversion we need later to
919 * make sure at least one sign bit gets stored. */
Mark Dickinson22b20182010-05-10 21:27:53 +0000920 digit s = do_twos_comp ? thisdigit ^ PyLong_MASK : thisdigit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000921 while (s != 0) {
922 s >>= 1;
923 accumbits++;
924 }
925 }
926 else
927 accumbits += PyLong_SHIFT;
Tim Peters8bc84b42001-06-12 19:17:03 +0000928
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000929 /* Store as many bytes as possible. */
930 while (accumbits >= 8) {
931 if (j >= n)
932 goto Overflow;
933 ++j;
934 *p = (unsigned char)(accum & 0xff);
935 p += pincr;
936 accumbits -= 8;
937 accum >>= 8;
938 }
939 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000940
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000941 /* Store the straggler (if any). */
942 assert(accumbits < 8);
943 assert(carry == 0); /* else do_twos_comp and *every* digit was 0 */
944 if (accumbits > 0) {
945 if (j >= n)
946 goto Overflow;
947 ++j;
948 if (do_twos_comp) {
949 /* Fill leading bits of the byte with sign bits
Serhiy Storchaka95949422013-08-27 19:40:23 +0300950 (appropriately pretending that the int had an
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 infinite supply of sign bits). */
952 accum |= (~(twodigits)0) << accumbits;
953 }
954 *p = (unsigned char)(accum & 0xff);
955 p += pincr;
956 }
957 else if (j == n && n > 0 && is_signed) {
958 /* The main loop filled the byte array exactly, so the code
959 just above didn't get to ensure there's a sign bit, and the
960 loop below wouldn't add one either. Make sure a sign bit
961 exists. */
962 unsigned char msb = *(p - pincr);
963 int sign_bit_set = msb >= 0x80;
964 assert(accumbits == 0);
965 if (sign_bit_set == do_twos_comp)
966 return 0;
967 else
968 goto Overflow;
969 }
Tim Peters05607ad2001-06-13 21:01:27 +0000970
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971 /* Fill remaining bytes with copies of the sign bit. */
972 {
973 unsigned char signbyte = do_twos_comp ? 0xffU : 0U;
974 for ( ; j < n; ++j, p += pincr)
975 *p = signbyte;
976 }
Tim Peters05607ad2001-06-13 21:01:27 +0000977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 return 0;
Tim Peters2a9b3672001-06-11 21:23:58 +0000979
Mark Dickinson22b20182010-05-10 21:27:53 +0000980 Overflow:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000981 PyErr_SetString(PyExc_OverflowError, "int too big to convert");
982 return -1;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000983
Tim Peters2a9b3672001-06-11 21:23:58 +0000984}
985
Serhiy Storchaka95949422013-08-27 19:40:23 +0300986/* Create a new int object from a C pointer */
Guido van Rossum78694d91998-09-18 14:14:13 +0000987
988PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000989PyLong_FromVoidPtr(void *p)
Guido van Rossum78694d91998-09-18 14:14:13 +0000990{
Mark Dickinson91044792012-10-18 19:21:43 +0100991#if SIZEOF_VOID_P <= SIZEOF_LONG
Mark Dickinson91044792012-10-18 19:21:43 +0100992 return PyLong_FromUnsignedLong((unsigned long)(Py_uintptr_t)p);
993#else
994
Tim Peters70128a12001-06-16 08:48:40 +0000995#ifndef HAVE_LONG_LONG
996# error "PyLong_FromVoidPtr: sizeof(void*) > sizeof(long), but no long long"
997#endif
998#if SIZEOF_LONG_LONG < SIZEOF_VOID_P
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000999# error "PyLong_FromVoidPtr: sizeof(PY_LONG_LONG) < sizeof(void*)"
Tim Peters70128a12001-06-16 08:48:40 +00001000#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001001 return PyLong_FromUnsignedLongLong((unsigned PY_LONG_LONG)(Py_uintptr_t)p);
Mark Dickinson91044792012-10-18 19:21:43 +01001002#endif /* SIZEOF_VOID_P <= SIZEOF_LONG */
Tim Peters70128a12001-06-16 08:48:40 +00001003
Guido van Rossum78694d91998-09-18 14:14:13 +00001004}
1005
Serhiy Storchaka95949422013-08-27 19:40:23 +03001006/* Get a C pointer from an int object. */
Guido van Rossum78694d91998-09-18 14:14:13 +00001007
1008void *
Tim Peters9f688bf2000-07-07 15:53:28 +00001009PyLong_AsVoidPtr(PyObject *vv)
Guido van Rossum78694d91998-09-18 14:14:13 +00001010{
Tim Peters70128a12001-06-16 08:48:40 +00001011#if SIZEOF_VOID_P <= SIZEOF_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001012 long x;
Guido van Rossum78694d91998-09-18 14:14:13 +00001013
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 if (PyLong_Check(vv) && _PyLong_Sign(vv) < 0)
1015 x = PyLong_AsLong(vv);
1016 else
1017 x = PyLong_AsUnsignedLong(vv);
Guido van Rossum78694d91998-09-18 14:14:13 +00001018#else
Tim Peters70128a12001-06-16 08:48:40 +00001019
1020#ifndef HAVE_LONG_LONG
1021# error "PyLong_AsVoidPtr: sizeof(void*) > sizeof(long), but no long long"
1022#endif
1023#if SIZEOF_LONG_LONG < SIZEOF_VOID_P
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001024# error "PyLong_AsVoidPtr: sizeof(PY_LONG_LONG) < sizeof(void*)"
Tim Peters70128a12001-06-16 08:48:40 +00001025#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001026 PY_LONG_LONG x;
Guido van Rossum78694d91998-09-18 14:14:13 +00001027
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001028 if (PyLong_Check(vv) && _PyLong_Sign(vv) < 0)
1029 x = PyLong_AsLongLong(vv);
1030 else
1031 x = PyLong_AsUnsignedLongLong(vv);
Tim Peters70128a12001-06-16 08:48:40 +00001032
1033#endif /* SIZEOF_VOID_P <= SIZEOF_LONG */
Guido van Rossum78694d91998-09-18 14:14:13 +00001034
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001035 if (x == -1 && PyErr_Occurred())
1036 return NULL;
1037 return (void *)x;
Guido van Rossum78694d91998-09-18 14:14:13 +00001038}
1039
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001040#ifdef HAVE_LONG_LONG
Tim Petersd1a7da62001-06-13 00:35:57 +00001041
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001042/* Initial PY_LONG_LONG support by Chris Herborth (chrish@qnx.com), later
Tim Petersd1a7da62001-06-13 00:35:57 +00001043 * rewritten to use the newer PyLong_{As,From}ByteArray API.
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001044 */
1045
Mark Dickinson22b20182010-05-10 21:27:53 +00001046#define PY_ABS_LLONG_MIN (0-(unsigned PY_LONG_LONG)PY_LLONG_MIN)
Tim Petersd1a7da62001-06-13 00:35:57 +00001047
Serhiy Storchaka95949422013-08-27 19:40:23 +03001048/* Create a new int object from a C PY_LONG_LONG int. */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001049
1050PyObject *
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001051PyLong_FromLongLong(PY_LONG_LONG ival)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001052{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 PyLongObject *v;
1054 unsigned PY_LONG_LONG abs_ival;
1055 unsigned PY_LONG_LONG t; /* unsigned so >> doesn't propagate sign bit */
1056 int ndigits = 0;
1057 int negative = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001058
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001059 CHECK_SMALL_INT(ival);
1060 if (ival < 0) {
1061 /* avoid signed overflow on negation; see comments
1062 in PyLong_FromLong above. */
1063 abs_ival = (unsigned PY_LONG_LONG)(-1-ival) + 1;
1064 negative = 1;
1065 }
1066 else {
1067 abs_ival = (unsigned PY_LONG_LONG)ival;
1068 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001069
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 /* Count the number of Python digits.
1071 We used to pick 5 ("big enough for anything"), but that's a
1072 waste of time and space given that 5*15 = 75 bits are rarely
1073 needed. */
1074 t = abs_ival;
1075 while (t) {
1076 ++ndigits;
1077 t >>= PyLong_SHIFT;
1078 }
1079 v = _PyLong_New(ndigits);
1080 if (v != NULL) {
1081 digit *p = v->ob_digit;
1082 Py_SIZE(v) = negative ? -ndigits : ndigits;
1083 t = abs_ival;
1084 while (t) {
1085 *p++ = (digit)(t & PyLong_MASK);
1086 t >>= PyLong_SHIFT;
1087 }
1088 }
1089 return (PyObject *)v;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001090}
1091
Serhiy Storchaka95949422013-08-27 19:40:23 +03001092/* Create a new int object from a C unsigned PY_LONG_LONG int. */
Tim Petersd1a7da62001-06-13 00:35:57 +00001093
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001094PyObject *
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001095PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG ival)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001096{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001097 PyLongObject *v;
1098 unsigned PY_LONG_LONG t;
1099 int ndigits = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001101 if (ival < PyLong_BASE)
1102 return PyLong_FromLong((long)ival);
1103 /* Count the number of Python digits. */
1104 t = (unsigned PY_LONG_LONG)ival;
1105 while (t) {
1106 ++ndigits;
1107 t >>= PyLong_SHIFT;
1108 }
1109 v = _PyLong_New(ndigits);
1110 if (v != NULL) {
1111 digit *p = v->ob_digit;
1112 Py_SIZE(v) = ndigits;
1113 while (ival) {
1114 *p++ = (digit)(ival & PyLong_MASK);
1115 ival >>= PyLong_SHIFT;
1116 }
1117 }
1118 return (PyObject *)v;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001119}
1120
Serhiy Storchaka95949422013-08-27 19:40:23 +03001121/* Create a new int object from a C Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001122
1123PyObject *
Guido van Rossumddefaf32007-01-14 03:31:43 +00001124PyLong_FromSsize_t(Py_ssize_t ival)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001125{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001126 PyLongObject *v;
1127 size_t abs_ival;
1128 size_t t; /* unsigned so >> doesn't propagate sign bit */
1129 int ndigits = 0;
1130 int negative = 0;
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001131
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001132 CHECK_SMALL_INT(ival);
1133 if (ival < 0) {
1134 /* avoid signed overflow when ival = SIZE_T_MIN */
1135 abs_ival = (size_t)(-1-ival)+1;
1136 negative = 1;
1137 }
1138 else {
1139 abs_ival = (size_t)ival;
1140 }
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001141
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001142 /* Count the number of Python digits. */
1143 t = abs_ival;
1144 while (t) {
1145 ++ndigits;
1146 t >>= PyLong_SHIFT;
1147 }
1148 v = _PyLong_New(ndigits);
1149 if (v != NULL) {
1150 digit *p = v->ob_digit;
1151 Py_SIZE(v) = negative ? -ndigits : ndigits;
1152 t = abs_ival;
1153 while (t) {
1154 *p++ = (digit)(t & PyLong_MASK);
1155 t >>= PyLong_SHIFT;
1156 }
1157 }
1158 return (PyObject *)v;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001159}
1160
Serhiy Storchaka95949422013-08-27 19:40:23 +03001161/* Create a new int object from a C size_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001162
1163PyObject *
Guido van Rossumddefaf32007-01-14 03:31:43 +00001164PyLong_FromSize_t(size_t ival)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001165{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 PyLongObject *v;
1167 size_t t;
1168 int ndigits = 0;
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001169
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001170 if (ival < PyLong_BASE)
1171 return PyLong_FromLong((long)ival);
1172 /* Count the number of Python digits. */
1173 t = ival;
1174 while (t) {
1175 ++ndigits;
1176 t >>= PyLong_SHIFT;
1177 }
1178 v = _PyLong_New(ndigits);
1179 if (v != NULL) {
1180 digit *p = v->ob_digit;
1181 Py_SIZE(v) = ndigits;
1182 while (ival) {
1183 *p++ = (digit)(ival & PyLong_MASK);
1184 ival >>= PyLong_SHIFT;
1185 }
1186 }
1187 return (PyObject *)v;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001188}
1189
Serhiy Storchaka95949422013-08-27 19:40:23 +03001190/* Get a C long long int from an int object or any object that has an
Mark Dickinson8d48b432011-10-23 20:47:14 +01001191 __int__ method. Return -1 and set an error if overflow occurs. */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001192
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001193PY_LONG_LONG
Tim Peters9f688bf2000-07-07 15:53:28 +00001194PyLong_AsLongLong(PyObject *vv)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001195{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001196 PyLongObject *v;
1197 PY_LONG_LONG bytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 int res;
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001199 int do_decref = 0; /* if nb_int was called */
Tim Petersd1a7da62001-06-13 00:35:57 +00001200
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001201 if (vv == NULL) {
1202 PyErr_BadInternalCall();
1203 return -1;
1204 }
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001205
1206 if (PyLong_Check(vv)) {
1207 v = (PyLongObject *)vv;
1208 }
1209 else {
1210 v = _PyLong_FromNbInt(vv);
1211 if (v == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001212 return -1;
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001213 do_decref = 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001214 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001215
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001216 res = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001217 switch(Py_SIZE(v)) {
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001218 case -1:
1219 bytes = -(sdigit)v->ob_digit[0];
1220 break;
1221 case 0:
1222 bytes = 0;
1223 break;
1224 case 1:
1225 bytes = v->ob_digit[0];
1226 break;
1227 default:
1228 res = _PyLong_AsByteArray((PyLongObject *)v, (unsigned char *)&bytes,
Serhiy Storchakac4f32122013-12-11 21:26:36 +02001229 SIZEOF_LONG_LONG, PY_LITTLE_ENDIAN, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001230 }
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001231 if (do_decref) {
1232 Py_DECREF(v);
1233 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001235 /* Plan 9 can't handle PY_LONG_LONG in ? : expressions */
1236 if (res < 0)
1237 return (PY_LONG_LONG)-1;
1238 else
1239 return bytes;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001240}
1241
Serhiy Storchaka95949422013-08-27 19:40:23 +03001242/* Get a C unsigned PY_LONG_LONG int from an int object.
Tim Petersd1a7da62001-06-13 00:35:57 +00001243 Return -1 and set an error if overflow occurs. */
1244
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001245unsigned PY_LONG_LONG
Tim Peters9f688bf2000-07-07 15:53:28 +00001246PyLong_AsUnsignedLongLong(PyObject *vv)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001247{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 PyLongObject *v;
1249 unsigned PY_LONG_LONG bytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001250 int res;
Tim Petersd1a7da62001-06-13 00:35:57 +00001251
Nadeem Vawda3d5881e2011-09-07 21:40:26 +02001252 if (vv == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001253 PyErr_BadInternalCall();
1254 return (unsigned PY_LONG_LONG)-1;
1255 }
Nadeem Vawda3d5881e2011-09-07 21:40:26 +02001256 if (!PyLong_Check(vv)) {
1257 PyErr_SetString(PyExc_TypeError, "an integer is required");
1258 return (unsigned PY_LONG_LONG)-1;
1259 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001260
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001261 v = (PyLongObject*)vv;
1262 switch(Py_SIZE(v)) {
1263 case 0: return 0;
1264 case 1: return v->ob_digit[0];
1265 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00001266
Mark Dickinson22b20182010-05-10 21:27:53 +00001267 res = _PyLong_AsByteArray((PyLongObject *)vv, (unsigned char *)&bytes,
Christian Heimes743e0cd2012-10-17 23:52:17 +02001268 SIZEOF_LONG_LONG, PY_LITTLE_ENDIAN, 0);
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001269
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001270 /* Plan 9 can't handle PY_LONG_LONG in ? : expressions */
1271 if (res < 0)
1272 return (unsigned PY_LONG_LONG)res;
1273 else
1274 return bytes;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001275}
Tim Petersd1a7da62001-06-13 00:35:57 +00001276
Serhiy Storchaka95949422013-08-27 19:40:23 +03001277/* Get a C unsigned long int from an int object, ignoring the high bits.
Thomas Hellera4ea6032003-04-17 18:55:45 +00001278 Returns -1 and sets an error condition if an error occurs. */
1279
Guido van Rossumddefaf32007-01-14 03:31:43 +00001280static unsigned PY_LONG_LONG
1281_PyLong_AsUnsignedLongLongMask(PyObject *vv)
Thomas Hellera4ea6032003-04-17 18:55:45 +00001282{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001283 PyLongObject *v;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001284 unsigned PY_LONG_LONG x;
1285 Py_ssize_t i;
1286 int sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +00001287
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001288 if (vv == NULL || !PyLong_Check(vv)) {
1289 PyErr_BadInternalCall();
1290 return (unsigned long) -1;
1291 }
1292 v = (PyLongObject *)vv;
1293 switch(Py_SIZE(v)) {
1294 case 0: return 0;
1295 case 1: return v->ob_digit[0];
1296 }
1297 i = Py_SIZE(v);
1298 sign = 1;
1299 x = 0;
1300 if (i < 0) {
1301 sign = -1;
1302 i = -i;
1303 }
1304 while (--i >= 0) {
1305 x = (x << PyLong_SHIFT) | v->ob_digit[i];
1306 }
1307 return x * sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +00001308}
Guido van Rossumddefaf32007-01-14 03:31:43 +00001309
1310unsigned PY_LONG_LONG
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001311PyLong_AsUnsignedLongLongMask(PyObject *op)
Guido van Rossumddefaf32007-01-14 03:31:43 +00001312{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001313 PyLongObject *lo;
1314 unsigned PY_LONG_LONG val;
Guido van Rossumddefaf32007-01-14 03:31:43 +00001315
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001316 if (op == NULL) {
1317 PyErr_BadInternalCall();
1318 return (unsigned long)-1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001319 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00001320
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001321 if (PyLong_Check(op)) {
1322 return _PyLong_AsUnsignedLongLongMask(op);
1323 }
1324
1325 lo = _PyLong_FromNbInt(op);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001326 if (lo == NULL)
1327 return (unsigned PY_LONG_LONG)-1;
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001328
1329 val = _PyLong_AsUnsignedLongLongMask((PyObject *)lo);
1330 Py_DECREF(lo);
1331 return val;
Guido van Rossumddefaf32007-01-14 03:31:43 +00001332}
Tim Petersd1a7da62001-06-13 00:35:57 +00001333
Serhiy Storchaka95949422013-08-27 19:40:23 +03001334/* Get a C long long int from an int object or any object that has an
Mark Dickinson8d48b432011-10-23 20:47:14 +01001335 __int__ method.
Mark Dickinson93f562c2010-01-30 10:30:15 +00001336
Mark Dickinson8d48b432011-10-23 20:47:14 +01001337 On overflow, return -1 and set *overflow to 1 or -1 depending on the sign of
1338 the result. Otherwise *overflow is 0.
1339
1340 For other errors (e.g., TypeError), return -1 and set an error condition.
1341 In this case *overflow will be 0.
Mark Dickinson93f562c2010-01-30 10:30:15 +00001342*/
1343
1344PY_LONG_LONG
1345PyLong_AsLongLongAndOverflow(PyObject *vv, int *overflow)
1346{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 /* This version by Tim Peters */
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001348 PyLongObject *v;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 unsigned PY_LONG_LONG x, prev;
1350 PY_LONG_LONG res;
1351 Py_ssize_t i;
1352 int sign;
1353 int do_decref = 0; /* if nb_int was called */
Mark Dickinson93f562c2010-01-30 10:30:15 +00001354
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001355 *overflow = 0;
1356 if (vv == NULL) {
1357 PyErr_BadInternalCall();
1358 return -1;
1359 }
Mark Dickinson93f562c2010-01-30 10:30:15 +00001360
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001361 if (PyLong_Check(vv)) {
1362 v = (PyLongObject *)vv;
1363 }
1364 else {
1365 v = _PyLong_FromNbInt(vv);
1366 if (v == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001367 return -1;
1368 do_decref = 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001369 }
Mark Dickinson93f562c2010-01-30 10:30:15 +00001370
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001371 res = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 i = Py_SIZE(v);
Mark Dickinson93f562c2010-01-30 10:30:15 +00001373
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001374 switch (i) {
1375 case -1:
1376 res = -(sdigit)v->ob_digit[0];
1377 break;
1378 case 0:
1379 res = 0;
1380 break;
1381 case 1:
1382 res = v->ob_digit[0];
1383 break;
1384 default:
1385 sign = 1;
1386 x = 0;
1387 if (i < 0) {
1388 sign = -1;
1389 i = -(i);
1390 }
1391 while (--i >= 0) {
1392 prev = x;
1393 x = (x << PyLong_SHIFT) + v->ob_digit[i];
1394 if ((x >> PyLong_SHIFT) != prev) {
1395 *overflow = sign;
1396 goto exit;
1397 }
1398 }
1399 /* Haven't lost any bits, but casting to long requires extra
1400 * care (see comment above).
1401 */
1402 if (x <= (unsigned PY_LONG_LONG)PY_LLONG_MAX) {
1403 res = (PY_LONG_LONG)x * sign;
1404 }
1405 else if (sign < 0 && x == PY_ABS_LLONG_MIN) {
1406 res = PY_LLONG_MIN;
1407 }
1408 else {
1409 *overflow = sign;
1410 /* res is already set to -1 */
1411 }
1412 }
Mark Dickinson22b20182010-05-10 21:27:53 +00001413 exit:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 if (do_decref) {
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001415 Py_DECREF(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001416 }
1417 return res;
Mark Dickinson93f562c2010-01-30 10:30:15 +00001418}
1419
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001420#endif /* HAVE_LONG_LONG */
1421
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00001422#define CHECK_BINOP(v,w) \
1423 do { \
Brian Curtindfc80e32011-08-10 20:28:54 -05001424 if (!PyLong_Check(v) || !PyLong_Check(w)) \
1425 Py_RETURN_NOTIMPLEMENTED; \
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00001426 } while(0)
Neil Schemenauerba872e22001-01-04 01:46:03 +00001427
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001428/* bits_in_digit(d) returns the unique integer k such that 2**(k-1) <= d <
1429 2**k if d is nonzero, else 0. */
1430
1431static const unsigned char BitLengthTable[32] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 0, 1, 2, 2, 3, 3, 3, 3, 4, 4, 4, 4, 4, 4, 4, 4,
1433 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001434};
1435
1436static int
1437bits_in_digit(digit d)
1438{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001439 int d_bits = 0;
1440 while (d >= 32) {
1441 d_bits += 6;
1442 d >>= 6;
1443 }
1444 d_bits += (int)BitLengthTable[d];
1445 return d_bits;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001446}
1447
Tim Peters877a2122002-08-12 05:09:36 +00001448/* x[0:m] and y[0:n] are digit vectors, LSD first, m >= n required. x[0:n]
1449 * is modified in place, by adding y to it. Carries are propagated as far as
1450 * x[m-1], and the remaining carry (0 or 1) is returned.
1451 */
1452static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001453v_iadd(digit *x, Py_ssize_t m, digit *y, Py_ssize_t n)
Tim Peters877a2122002-08-12 05:09:36 +00001454{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 Py_ssize_t i;
1456 digit carry = 0;
Tim Peters877a2122002-08-12 05:09:36 +00001457
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 assert(m >= n);
1459 for (i = 0; i < n; ++i) {
1460 carry += x[i] + y[i];
1461 x[i] = carry & PyLong_MASK;
1462 carry >>= PyLong_SHIFT;
1463 assert((carry & 1) == carry);
1464 }
1465 for (; carry && i < m; ++i) {
1466 carry += x[i];
1467 x[i] = carry & PyLong_MASK;
1468 carry >>= PyLong_SHIFT;
1469 assert((carry & 1) == carry);
1470 }
1471 return carry;
Tim Peters877a2122002-08-12 05:09:36 +00001472}
1473
1474/* x[0:m] and y[0:n] are digit vectors, LSD first, m >= n required. x[0:n]
1475 * is modified in place, by subtracting y from it. Borrows are propagated as
1476 * far as x[m-1], and the remaining borrow (0 or 1) is returned.
1477 */
1478static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001479v_isub(digit *x, Py_ssize_t m, digit *y, Py_ssize_t n)
Tim Peters877a2122002-08-12 05:09:36 +00001480{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001481 Py_ssize_t i;
1482 digit borrow = 0;
Tim Peters877a2122002-08-12 05:09:36 +00001483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001484 assert(m >= n);
1485 for (i = 0; i < n; ++i) {
1486 borrow = x[i] - y[i] - borrow;
1487 x[i] = borrow & PyLong_MASK;
1488 borrow >>= PyLong_SHIFT;
1489 borrow &= 1; /* keep only 1 sign bit */
1490 }
1491 for (; borrow && i < m; ++i) {
1492 borrow = x[i] - borrow;
1493 x[i] = borrow & PyLong_MASK;
1494 borrow >>= PyLong_SHIFT;
1495 borrow &= 1;
1496 }
1497 return borrow;
Tim Peters877a2122002-08-12 05:09:36 +00001498}
Neil Schemenauerba872e22001-01-04 01:46:03 +00001499
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001500/* Shift digit vector a[0:m] d bits left, with 0 <= d < PyLong_SHIFT. Put
1501 * result in z[0:m], and return the d bits shifted out of the top.
1502 */
1503static digit
1504v_lshift(digit *z, digit *a, Py_ssize_t m, int d)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001505{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001506 Py_ssize_t i;
1507 digit carry = 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001508
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001509 assert(0 <= d && d < PyLong_SHIFT);
1510 for (i=0; i < m; i++) {
1511 twodigits acc = (twodigits)a[i] << d | carry;
1512 z[i] = (digit)acc & PyLong_MASK;
1513 carry = (digit)(acc >> PyLong_SHIFT);
1514 }
1515 return carry;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001516}
1517
1518/* Shift digit vector a[0:m] d bits right, with 0 <= d < PyLong_SHIFT. Put
1519 * result in z[0:m], and return the d bits shifted out of the bottom.
1520 */
1521static digit
1522v_rshift(digit *z, digit *a, Py_ssize_t m, int d)
1523{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001524 Py_ssize_t i;
1525 digit carry = 0;
1526 digit mask = ((digit)1 << d) - 1U;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001528 assert(0 <= d && d < PyLong_SHIFT);
1529 for (i=m; i-- > 0;) {
1530 twodigits acc = (twodigits)carry << PyLong_SHIFT | a[i];
1531 carry = (digit)acc & mask;
1532 z[i] = (digit)(acc >> d);
1533 }
1534 return carry;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001535}
1536
Tim Peters212e6142001-07-14 12:23:19 +00001537/* Divide long pin, w/ size digits, by non-zero digit n, storing quotient
1538 in pout, and returning the remainder. pin and pout point at the LSD.
1539 It's OK for pin == pout on entry, which saves oodles of mallocs/frees in
Serhiy Storchaka95949422013-08-27 19:40:23 +03001540 _PyLong_Format, but that should be done with great care since ints are
Tim Peters212e6142001-07-14 12:23:19 +00001541 immutable. */
1542
1543static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001544inplace_divrem1(digit *pout, digit *pin, Py_ssize_t size, digit n)
Tim Peters212e6142001-07-14 12:23:19 +00001545{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001546 twodigits rem = 0;
Tim Peters212e6142001-07-14 12:23:19 +00001547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 assert(n > 0 && n <= PyLong_MASK);
1549 pin += size;
1550 pout += size;
1551 while (--size >= 0) {
1552 digit hi;
1553 rem = (rem << PyLong_SHIFT) | *--pin;
1554 *--pout = hi = (digit)(rem / n);
1555 rem -= (twodigits)hi * n;
1556 }
1557 return (digit)rem;
Tim Peters212e6142001-07-14 12:23:19 +00001558}
1559
Serhiy Storchaka95949422013-08-27 19:40:23 +03001560/* Divide an integer by a digit, returning both the quotient
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001561 (as function result) and the remainder (through *prem).
1562 The sign of a is ignored; n should not be zero. */
1563
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001564static PyLongObject *
Tim Peters212e6142001-07-14 12:23:19 +00001565divrem1(PyLongObject *a, digit n, digit *prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001566{
Victor Stinner45e8e2f2014-05-14 17:24:35 +02001567 const Py_ssize_t size = Py_ABS(Py_SIZE(a));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001568 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001570 assert(n > 0 && n <= PyLong_MASK);
1571 z = _PyLong_New(size);
1572 if (z == NULL)
1573 return NULL;
1574 *prem = inplace_divrem1(z->ob_digit, a->ob_digit, size, n);
1575 return long_normalize(z);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001576}
1577
Serhiy Storchaka95949422013-08-27 19:40:23 +03001578/* Convert an integer to a base 10 string. Returns a new non-shared
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001579 string. (Return value is non-shared so that callers can modify the
1580 returned value if necessary.) */
1581
Victor Stinnerd3f08822012-05-29 12:57:52 +02001582static int
1583long_to_decimal_string_internal(PyObject *aa,
1584 PyObject **p_output,
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001585 _PyUnicodeWriter *writer,
1586 _PyBytesWriter *bytes_writer,
1587 char **bytes_str)
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001588{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 PyLongObject *scratch, *a;
Victor Stinner1285e5c2015-10-14 12:10:20 +02001590 PyObject *str = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 Py_ssize_t size, strlen, size_a, i, j;
1592 digit *pout, *pin, rem, tenpow;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001593 int negative;
Victor Stinnerd3f08822012-05-29 12:57:52 +02001594 enum PyUnicode_Kind kind;
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001595
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 a = (PyLongObject *)aa;
1597 if (a == NULL || !PyLong_Check(a)) {
1598 PyErr_BadInternalCall();
Victor Stinnerd3f08822012-05-29 12:57:52 +02001599 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 }
Victor Stinner45e8e2f2014-05-14 17:24:35 +02001601 size_a = Py_ABS(Py_SIZE(a));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 negative = Py_SIZE(a) < 0;
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 /* quick and dirty upper bound for the number of digits
1605 required to express a in base _PyLong_DECIMAL_BASE:
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001606
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 #digits = 1 + floor(log2(a) / log2(_PyLong_DECIMAL_BASE))
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001609 But log2(a) < size_a * PyLong_SHIFT, and
1610 log2(_PyLong_DECIMAL_BASE) = log2(10) * _PyLong_DECIMAL_SHIFT
1611 > 3 * _PyLong_DECIMAL_SHIFT
1612 */
1613 if (size_a > PY_SSIZE_T_MAX / PyLong_SHIFT) {
1614 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson02515f72013-08-03 12:08:22 +01001615 "int too large to format");
Victor Stinnerd3f08822012-05-29 12:57:52 +02001616 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001617 }
1618 /* the expression size_a * PyLong_SHIFT is now safe from overflow */
1619 size = 1 + size_a * PyLong_SHIFT / (3 * _PyLong_DECIMAL_SHIFT);
1620 scratch = _PyLong_New(size);
1621 if (scratch == NULL)
Victor Stinnerd3f08822012-05-29 12:57:52 +02001622 return -1;
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001623
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 /* convert array of base _PyLong_BASE digits in pin to an array of
1625 base _PyLong_DECIMAL_BASE digits in pout, following Knuth (TAOCP,
1626 Volume 2 (3rd edn), section 4.4, Method 1b). */
1627 pin = a->ob_digit;
1628 pout = scratch->ob_digit;
1629 size = 0;
1630 for (i = size_a; --i >= 0; ) {
1631 digit hi = pin[i];
1632 for (j = 0; j < size; j++) {
1633 twodigits z = (twodigits)pout[j] << PyLong_SHIFT | hi;
1634 hi = (digit)(z / _PyLong_DECIMAL_BASE);
1635 pout[j] = (digit)(z - (twodigits)hi *
1636 _PyLong_DECIMAL_BASE);
1637 }
1638 while (hi) {
1639 pout[size++] = hi % _PyLong_DECIMAL_BASE;
1640 hi /= _PyLong_DECIMAL_BASE;
1641 }
1642 /* check for keyboard interrupt */
1643 SIGCHECK({
Mark Dickinson22b20182010-05-10 21:27:53 +00001644 Py_DECREF(scratch);
Victor Stinnerd3f08822012-05-29 12:57:52 +02001645 return -1;
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00001646 });
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001647 }
1648 /* pout should have at least one digit, so that the case when a = 0
1649 works correctly */
1650 if (size == 0)
1651 pout[size++] = 0;
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001652
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001653 /* calculate exact length of output string, and allocate */
1654 strlen = negative + 1 + (size - 1) * _PyLong_DECIMAL_SHIFT;
1655 tenpow = 10;
1656 rem = pout[size-1];
1657 while (rem >= tenpow) {
1658 tenpow *= 10;
1659 strlen++;
1660 }
Victor Stinnerd3f08822012-05-29 12:57:52 +02001661 if (writer) {
Christian Heimes110ac162012-09-10 02:51:27 +02001662 if (_PyUnicodeWriter_Prepare(writer, strlen, '9') == -1) {
1663 Py_DECREF(scratch);
Victor Stinnerd3f08822012-05-29 12:57:52 +02001664 return -1;
Christian Heimes110ac162012-09-10 02:51:27 +02001665 }
Victor Stinnerd3f08822012-05-29 12:57:52 +02001666 kind = writer->kind;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001667 }
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001668 else if (bytes_writer) {
1669 *bytes_str = _PyBytesWriter_Prepare(bytes_writer, *bytes_str, strlen);
1670 if (*bytes_str == NULL) {
1671 Py_DECREF(scratch);
1672 return -1;
1673 }
1674 }
Victor Stinnerd3f08822012-05-29 12:57:52 +02001675 else {
1676 str = PyUnicode_New(strlen, '9');
1677 if (str == NULL) {
1678 Py_DECREF(scratch);
1679 return -1;
1680 }
1681 kind = PyUnicode_KIND(str);
1682 }
1683
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001684#define WRITE_DIGITS(p) \
Victor Stinnerd3f08822012-05-29 12:57:52 +02001685 do { \
Victor Stinnerd3f08822012-05-29 12:57:52 +02001686 /* pout[0] through pout[size-2] contribute exactly \
1687 _PyLong_DECIMAL_SHIFT digits each */ \
1688 for (i=0; i < size - 1; i++) { \
1689 rem = pout[i]; \
1690 for (j = 0; j < _PyLong_DECIMAL_SHIFT; j++) { \
1691 *--p = '0' + rem % 10; \
1692 rem /= 10; \
1693 } \
1694 } \
1695 /* pout[size-1]: always produce at least one decimal digit */ \
1696 rem = pout[i]; \
1697 do { \
1698 *--p = '0' + rem % 10; \
1699 rem /= 10; \
1700 } while (rem != 0); \
1701 \
1702 /* and sign */ \
1703 if (negative) \
1704 *--p = '-'; \
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001705 } while (0)
1706
1707#define WRITE_UNICODE_DIGITS(TYPE) \
1708 do { \
1709 if (writer) \
1710 p = (TYPE*)PyUnicode_DATA(writer->buffer) + writer->pos + strlen; \
1711 else \
1712 p = (TYPE*)PyUnicode_DATA(str) + strlen; \
1713 \
1714 WRITE_DIGITS(p); \
Victor Stinnerd3f08822012-05-29 12:57:52 +02001715 \
1716 /* check we've counted correctly */ \
1717 if (writer) \
1718 assert(p == ((TYPE*)PyUnicode_DATA(writer->buffer) + writer->pos)); \
1719 else \
1720 assert(p == (TYPE*)PyUnicode_DATA(str)); \
1721 } while (0)
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001722
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001723 /* fill the string right-to-left */
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001724 if (bytes_writer) {
1725 char *p = *bytes_str + strlen;
1726 WRITE_DIGITS(p);
1727 assert(p == *bytes_str);
1728 }
1729 else if (kind == PyUnicode_1BYTE_KIND) {
Victor Stinnerd3f08822012-05-29 12:57:52 +02001730 Py_UCS1 *p;
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001731 WRITE_UNICODE_DIGITS(Py_UCS1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001732 }
Victor Stinnerd3f08822012-05-29 12:57:52 +02001733 else if (kind == PyUnicode_2BYTE_KIND) {
1734 Py_UCS2 *p;
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001735 WRITE_UNICODE_DIGITS(Py_UCS2);
Victor Stinnerd3f08822012-05-29 12:57:52 +02001736 }
1737 else {
Victor Stinnerd3f08822012-05-29 12:57:52 +02001738 Py_UCS4 *p;
Victor Stinnere577ab32012-05-29 18:51:10 +02001739 assert (kind == PyUnicode_4BYTE_KIND);
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001740 WRITE_UNICODE_DIGITS(Py_UCS4);
Victor Stinnerd3f08822012-05-29 12:57:52 +02001741 }
1742#undef WRITE_DIGITS
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001743#undef WRITE_UNICODE_DIGITS
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001744
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001745 Py_DECREF(scratch);
Victor Stinnerd3f08822012-05-29 12:57:52 +02001746 if (writer) {
1747 writer->pos += strlen;
1748 }
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001749 else if (bytes_writer) {
1750 (*bytes_str) += strlen;
1751 }
Victor Stinnerd3f08822012-05-29 12:57:52 +02001752 else {
1753 assert(_PyUnicode_CheckConsistency(str, 1));
1754 *p_output = (PyObject *)str;
1755 }
1756 return 0;
1757}
1758
1759static PyObject *
1760long_to_decimal_string(PyObject *aa)
1761{
1762 PyObject *v;
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001763 if (long_to_decimal_string_internal(aa, &v, NULL, NULL, NULL) == -1)
Victor Stinnerd3f08822012-05-29 12:57:52 +02001764 return NULL;
1765 return v;
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001766}
1767
Serhiy Storchaka95949422013-08-27 19:40:23 +03001768/* Convert an int object to a string, using a given conversion base,
Victor Stinnerd3f08822012-05-29 12:57:52 +02001769 which should be one of 2, 8 or 16. Return a string object.
1770 If base is 2, 8 or 16, add the proper prefix '0b', '0o' or '0x'
1771 if alternate is nonzero. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001772
Victor Stinnerd3f08822012-05-29 12:57:52 +02001773static int
1774long_format_binary(PyObject *aa, int base, int alternate,
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001775 PyObject **p_output, _PyUnicodeWriter *writer,
1776 _PyBytesWriter *bytes_writer, char **bytes_str)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001777{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001778 PyLongObject *a = (PyLongObject *)aa;
Victor Stinner1285e5c2015-10-14 12:10:20 +02001779 PyObject *v = NULL;
Mark Dickinsone2846542012-04-20 21:21:24 +01001780 Py_ssize_t sz;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001781 Py_ssize_t size_a;
Victor Stinnerd3f08822012-05-29 12:57:52 +02001782 enum PyUnicode_Kind kind;
Mark Dickinsone2846542012-04-20 21:21:24 +01001783 int negative;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001784 int bits;
Guido van Rossume32e0141992-01-19 16:31:05 +00001785
Victor Stinnerd3f08822012-05-29 12:57:52 +02001786 assert(base == 2 || base == 8 || base == 16);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001787 if (a == NULL || !PyLong_Check(a)) {
1788 PyErr_BadInternalCall();
Victor Stinnerd3f08822012-05-29 12:57:52 +02001789 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001790 }
Victor Stinner45e8e2f2014-05-14 17:24:35 +02001791 size_a = Py_ABS(Py_SIZE(a));
Mark Dickinsone2846542012-04-20 21:21:24 +01001792 negative = Py_SIZE(a) < 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001793
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 /* Compute a rough upper bound for the length of the string */
1795 switch (base) {
1796 case 16:
1797 bits = 4;
1798 break;
1799 case 8:
1800 bits = 3;
1801 break;
1802 case 2:
1803 bits = 1;
1804 break;
1805 default:
1806 assert(0); /* shouldn't ever get here */
1807 bits = 0; /* to silence gcc warning */
1808 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00001809
Mark Dickinsone2846542012-04-20 21:21:24 +01001810 /* Compute exact length 'sz' of output string. */
1811 if (size_a == 0) {
Victor Stinnerd3f08822012-05-29 12:57:52 +02001812 sz = 1;
Mark Dickinsone2846542012-04-20 21:21:24 +01001813 }
1814 else {
1815 Py_ssize_t size_a_in_bits;
1816 /* Ensure overflow doesn't occur during computation of sz. */
1817 if (size_a > (PY_SSIZE_T_MAX - 3) / PyLong_SHIFT) {
1818 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson02515f72013-08-03 12:08:22 +01001819 "int too large to format");
Victor Stinnerd3f08822012-05-29 12:57:52 +02001820 return -1;
Mark Dickinsone2846542012-04-20 21:21:24 +01001821 }
1822 size_a_in_bits = (size_a - 1) * PyLong_SHIFT +
1823 bits_in_digit(a->ob_digit[size_a - 1]);
Victor Stinnerd3f08822012-05-29 12:57:52 +02001824 /* Allow 1 character for a '-' sign. */
1825 sz = negative + (size_a_in_bits + (bits - 1)) / bits;
1826 }
1827 if (alternate) {
1828 /* 2 characters for prefix */
1829 sz += 2;
Mark Dickinsone2846542012-04-20 21:21:24 +01001830 }
1831
Victor Stinnerd3f08822012-05-29 12:57:52 +02001832 if (writer) {
1833 if (_PyUnicodeWriter_Prepare(writer, sz, 'x') == -1)
1834 return -1;
1835 kind = writer->kind;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001836 }
Victor Stinner199c9a62015-10-14 09:47:23 +02001837 else if (bytes_writer) {
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001838 *bytes_str = _PyBytesWriter_Prepare(bytes_writer, *bytes_str, sz);
1839 if (*bytes_str == NULL)
1840 return -1;
1841 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001842 else {
Victor Stinnerd3f08822012-05-29 12:57:52 +02001843 v = PyUnicode_New(sz, 'x');
1844 if (v == NULL)
1845 return -1;
1846 kind = PyUnicode_KIND(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001847 }
Mark Dickinson8accd6b2009-09-17 19:39:12 +00001848
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001849#define WRITE_DIGITS(p) \
Victor Stinnerd3f08822012-05-29 12:57:52 +02001850 do { \
Victor Stinnerd3f08822012-05-29 12:57:52 +02001851 if (size_a == 0) { \
1852 *--p = '0'; \
1853 } \
1854 else { \
1855 /* JRH: special case for power-of-2 bases */ \
1856 twodigits accum = 0; \
1857 int accumbits = 0; /* # of bits in accum */ \
1858 Py_ssize_t i; \
1859 for (i = 0; i < size_a; ++i) { \
1860 accum |= (twodigits)a->ob_digit[i] << accumbits; \
1861 accumbits += PyLong_SHIFT; \
1862 assert(accumbits >= bits); \
1863 do { \
1864 char cdigit; \
1865 cdigit = (char)(accum & (base - 1)); \
1866 cdigit += (cdigit < 10) ? '0' : 'a'-10; \
1867 *--p = cdigit; \
1868 accumbits -= bits; \
1869 accum >>= bits; \
1870 } while (i < size_a-1 ? accumbits >= bits : accum > 0); \
1871 } \
1872 } \
1873 \
1874 if (alternate) { \
1875 if (base == 16) \
1876 *--p = 'x'; \
1877 else if (base == 8) \
1878 *--p = 'o'; \
1879 else /* (base == 2) */ \
1880 *--p = 'b'; \
1881 *--p = '0'; \
1882 } \
1883 if (negative) \
1884 *--p = '-'; \
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001885 } while (0)
1886
1887#define WRITE_UNICODE_DIGITS(TYPE) \
1888 do { \
1889 if (writer) \
1890 p = (TYPE*)PyUnicode_DATA(writer->buffer) + writer->pos + sz; \
1891 else \
1892 p = (TYPE*)PyUnicode_DATA(v) + sz; \
1893 \
1894 WRITE_DIGITS(p); \
1895 \
Victor Stinnerd3f08822012-05-29 12:57:52 +02001896 if (writer) \
1897 assert(p == ((TYPE*)PyUnicode_DATA(writer->buffer) + writer->pos)); \
1898 else \
1899 assert(p == (TYPE*)PyUnicode_DATA(v)); \
1900 } while (0)
1901
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001902 if (bytes_writer) {
1903 char *p = *bytes_str + sz;
1904 WRITE_DIGITS(p);
1905 assert(p == *bytes_str);
1906 }
1907 else if (kind == PyUnicode_1BYTE_KIND) {
Victor Stinnerd3f08822012-05-29 12:57:52 +02001908 Py_UCS1 *p;
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001909 WRITE_UNICODE_DIGITS(Py_UCS1);
Victor Stinnerd3f08822012-05-29 12:57:52 +02001910 }
1911 else if (kind == PyUnicode_2BYTE_KIND) {
1912 Py_UCS2 *p;
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001913 WRITE_UNICODE_DIGITS(Py_UCS2);
Victor Stinnerd3f08822012-05-29 12:57:52 +02001914 }
1915 else {
Victor Stinnerd3f08822012-05-29 12:57:52 +02001916 Py_UCS4 *p;
Victor Stinnere577ab32012-05-29 18:51:10 +02001917 assert (kind == PyUnicode_4BYTE_KIND);
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001918 WRITE_UNICODE_DIGITS(Py_UCS4);
Victor Stinnerd3f08822012-05-29 12:57:52 +02001919 }
1920#undef WRITE_DIGITS
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001921#undef WRITE_UNICODE_DIGITS
Victor Stinnerd3f08822012-05-29 12:57:52 +02001922
1923 if (writer) {
1924 writer->pos += sz;
1925 }
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001926 else if (bytes_writer) {
1927 (*bytes_str) += sz;
1928 }
Victor Stinnerd3f08822012-05-29 12:57:52 +02001929 else {
1930 assert(_PyUnicode_CheckConsistency(v, 1));
1931 *p_output = v;
1932 }
1933 return 0;
1934}
1935
1936PyObject *
1937_PyLong_Format(PyObject *obj, int base)
1938{
1939 PyObject *str;
1940 int err;
1941 if (base == 10)
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001942 err = long_to_decimal_string_internal(obj, &str, NULL, NULL, NULL);
Victor Stinnerd3f08822012-05-29 12:57:52 +02001943 else
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001944 err = long_format_binary(obj, base, 1, &str, NULL, NULL, NULL);
Victor Stinnerd3f08822012-05-29 12:57:52 +02001945 if (err == -1)
1946 return NULL;
1947 return str;
1948}
1949
1950int
1951_PyLong_FormatWriter(_PyUnicodeWriter *writer,
1952 PyObject *obj,
1953 int base, int alternate)
1954{
1955 if (base == 10)
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001956 return long_to_decimal_string_internal(obj, NULL, writer,
1957 NULL, NULL);
Victor Stinnerd3f08822012-05-29 12:57:52 +02001958 else
Victor Stinnerbe75b8c2015-10-09 22:43:24 +02001959 return long_format_binary(obj, base, alternate, NULL, writer,
1960 NULL, NULL);
1961}
1962
1963char*
1964_PyLong_FormatBytesWriter(_PyBytesWriter *writer, char *str,
1965 PyObject *obj,
1966 int base, int alternate)
1967{
1968 char *str2;
1969 int res;
1970 str2 = str;
1971 if (base == 10)
1972 res = long_to_decimal_string_internal(obj, NULL, NULL,
1973 writer, &str2);
1974 else
1975 res = long_format_binary(obj, base, alternate, NULL, NULL,
1976 writer, &str2);
1977 if (res < 0)
1978 return NULL;
1979 assert(str2 != NULL);
1980 return str2;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001981}
1982
Thomas Wouters477c8d52006-05-27 19:21:47 +00001983/* Table of digit values for 8-bit string -> integer conversion.
1984 * '0' maps to 0, ..., '9' maps to 9.
1985 * 'a' and 'A' map to 10, ..., 'z' and 'Z' map to 35.
1986 * All other indices map to 37.
1987 * Note that when converting a base B string, a char c is a legitimate
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001988 * base B digit iff _PyLong_DigitValue[Py_CHARPyLong_MASK(c)] < B.
Thomas Wouters477c8d52006-05-27 19:21:47 +00001989 */
Raymond Hettinger35631532009-01-09 03:58:09 +00001990unsigned char _PyLong_DigitValue[256] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001991 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1992 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1993 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1994 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 37, 37, 37, 37, 37, 37,
1995 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1996 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1997 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1998 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1999 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
2000 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
2001 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
2002 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
2003 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
2004 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
2005 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
2006 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
Thomas Wouters477c8d52006-05-27 19:21:47 +00002007};
2008
2009/* *str points to the first digit in a string of base `base` digits. base
Tim Petersbf2674b2003-02-02 07:51:32 +00002010 * is a power of 2 (2, 4, 8, 16, or 32). *str is set to point to the first
Serhiy Storchaka95949422013-08-27 19:40:23 +03002011 * non-digit (which may be *str!). A normalized int is returned.
Tim Petersbf2674b2003-02-02 07:51:32 +00002012 * The point to this routine is that it takes time linear in the number of
2013 * string characters.
2014 */
2015static PyLongObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +03002016long_from_binary_base(const char **str, int base)
Tim Petersbf2674b2003-02-02 07:51:32 +00002017{
Serhiy Storchakac6792272013-10-19 21:03:34 +03002018 const char *p = *str;
2019 const char *start = p;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002020 int bits_per_char;
2021 Py_ssize_t n;
2022 PyLongObject *z;
2023 twodigits accum;
2024 int bits_in_accum;
2025 digit *pdigit;
Tim Petersbf2674b2003-02-02 07:51:32 +00002026
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002027 assert(base >= 2 && base <= 32 && (base & (base - 1)) == 0);
2028 n = base;
2029 for (bits_per_char = -1; n; ++bits_per_char)
2030 n >>= 1;
2031 /* n <- total # of bits needed, while setting p to end-of-string */
2032 while (_PyLong_DigitValue[Py_CHARMASK(*p)] < base)
2033 ++p;
2034 *str = p;
2035 /* n <- # of Python digits needed, = ceiling(n/PyLong_SHIFT). */
2036 n = (p - start) * bits_per_char + PyLong_SHIFT - 1;
2037 if (n / bits_per_char < p - start) {
2038 PyErr_SetString(PyExc_ValueError,
2039 "int string too large to convert");
2040 return NULL;
2041 }
2042 n = n / PyLong_SHIFT;
2043 z = _PyLong_New(n);
2044 if (z == NULL)
2045 return NULL;
Serhiy Storchaka95949422013-08-27 19:40:23 +03002046 /* Read string from right, and fill in int from left; i.e.,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002047 * from least to most significant in both.
2048 */
2049 accum = 0;
2050 bits_in_accum = 0;
2051 pdigit = z->ob_digit;
2052 while (--p >= start) {
2053 int k = (int)_PyLong_DigitValue[Py_CHARMASK(*p)];
2054 assert(k >= 0 && k < base);
2055 accum |= (twodigits)k << bits_in_accum;
2056 bits_in_accum += bits_per_char;
2057 if (bits_in_accum >= PyLong_SHIFT) {
2058 *pdigit++ = (digit)(accum & PyLong_MASK);
2059 assert(pdigit - z->ob_digit <= n);
2060 accum >>= PyLong_SHIFT;
2061 bits_in_accum -= PyLong_SHIFT;
2062 assert(bits_in_accum < PyLong_SHIFT);
2063 }
2064 }
2065 if (bits_in_accum) {
2066 assert(bits_in_accum <= PyLong_SHIFT);
2067 *pdigit++ = (digit)accum;
2068 assert(pdigit - z->ob_digit <= n);
2069 }
2070 while (pdigit - z->ob_digit < n)
2071 *pdigit++ = 0;
2072 return long_normalize(z);
Tim Petersbf2674b2003-02-02 07:51:32 +00002073}
2074
Serhiy Storchaka95949422013-08-27 19:40:23 +03002075/* Parses an int from a bytestring. Leading and trailing whitespace will be
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03002076 * ignored.
2077 *
2078 * If successful, a PyLong object will be returned and 'pend' will be pointing
2079 * to the first unused byte unless it's NULL.
2080 *
2081 * If unsuccessful, NULL will be returned.
2082 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002083PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +03002084PyLong_FromString(const char *str, char **pend, int base)
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002085{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002086 int sign = 1, error_if_nonzero = 0;
Serhiy Storchakac6792272013-10-19 21:03:34 +03002087 const char *start, *orig_str = str;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002088 PyLongObject *z = NULL;
2089 PyObject *strobj;
2090 Py_ssize_t slen;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002091
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002092 if ((base != 0 && base < 2) || base > 36) {
2093 PyErr_SetString(PyExc_ValueError,
2094 "int() arg 2 must be >= 2 and <= 36");
2095 return NULL;
2096 }
Antoine Pitrou4de74572013-02-09 23:11:27 +01002097 while (*str != '\0' && Py_ISSPACE(Py_CHARMASK(*str)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002098 str++;
2099 if (*str == '+')
2100 ++str;
2101 else if (*str == '-') {
2102 ++str;
2103 sign = -1;
2104 }
2105 if (base == 0) {
2106 if (str[0] != '0')
2107 base = 10;
2108 else if (str[1] == 'x' || str[1] == 'X')
2109 base = 16;
2110 else if (str[1] == 'o' || str[1] == 'O')
2111 base = 8;
2112 else if (str[1] == 'b' || str[1] == 'B')
2113 base = 2;
2114 else {
2115 /* "old" (C-style) octal literal, now invalid.
2116 it might still be zero though */
2117 error_if_nonzero = 1;
2118 base = 10;
2119 }
2120 }
2121 if (str[0] == '0' &&
2122 ((base == 16 && (str[1] == 'x' || str[1] == 'X')) ||
2123 (base == 8 && (str[1] == 'o' || str[1] == 'O')) ||
2124 (base == 2 && (str[1] == 'b' || str[1] == 'B'))))
2125 str += 2;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002127 start = str;
2128 if ((base & (base - 1)) == 0)
2129 z = long_from_binary_base(&str, base);
2130 else {
Thomas Wouters477c8d52006-05-27 19:21:47 +00002131/***
2132Binary bases can be converted in time linear in the number of digits, because
2133Python's representation base is binary. Other bases (including decimal!) use
2134the simple quadratic-time algorithm below, complicated by some speed tricks.
Tim Peters5af4e6c2002-08-12 02:31:19 +00002135
Thomas Wouters477c8d52006-05-27 19:21:47 +00002136First some math: the largest integer that can be expressed in N base-B digits
2137is B**N-1. Consequently, if we have an N-digit input in base B, the worst-
2138case number of Python digits needed to hold it is the smallest integer n s.t.
2139
2140 BASE**n-1 >= B**N-1 [or, adding 1 to both sides]
2141 BASE**n >= B**N [taking logs to base BASE]
2142 n >= log(B**N)/log(BASE) = N * log(B)/log(BASE)
2143
2144The static array log_base_BASE[base] == log(base)/log(BASE) so we can compute
Serhiy Storchaka95949422013-08-27 19:40:23 +03002145this quickly. A Python int with that much space is reserved near the start,
Thomas Wouters477c8d52006-05-27 19:21:47 +00002146and the result is computed into it.
2147
2148The input string is actually treated as being in base base**i (i.e., i digits
2149are processed at a time), where two more static arrays hold:
2150
2151 convwidth_base[base] = the largest integer i such that base**i <= BASE
2152 convmultmax_base[base] = base ** convwidth_base[base]
2153
2154The first of these is the largest i such that i consecutive input digits
2155must fit in a single Python digit. The second is effectively the input
2156base we're really using.
2157
2158Viewing the input as a sequence <c0, c1, ..., c_n-1> of digits in base
2159convmultmax_base[base], the result is "simply"
2160
2161 (((c0*B + c1)*B + c2)*B + c3)*B + ... ))) + c_n-1
2162
2163where B = convmultmax_base[base].
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002164
2165Error analysis: as above, the number of Python digits `n` needed is worst-
2166case
2167
2168 n >= N * log(B)/log(BASE)
2169
2170where `N` is the number of input digits in base `B`. This is computed via
2171
2172 size_z = (Py_ssize_t)((scan - str) * log_base_BASE[base]) + 1;
2173
2174below. Two numeric concerns are how much space this can waste, and whether
2175the computed result can be too small. To be concrete, assume BASE = 2**15,
2176which is the default (and it's unlikely anyone changes that).
2177
2178Waste isn't a problem: provided the first input digit isn't 0, the difference
2179between the worst-case input with N digits and the smallest input with N
2180digits is about a factor of B, but B is small compared to BASE so at most
2181one allocated Python digit can remain unused on that count. If
2182N*log(B)/log(BASE) is mathematically an exact integer, then truncating that
2183and adding 1 returns a result 1 larger than necessary. However, that can't
2184happen: whenever B is a power of 2, long_from_binary_base() is called
2185instead, and it's impossible for B**i to be an integer power of 2**15 when
2186B is not a power of 2 (i.e., it's impossible for N*log(B)/log(BASE) to be
2187an exact integer when B is not a power of 2, since B**i has a prime factor
2188other than 2 in that case, but (2**15)**j's only prime factor is 2).
2189
2190The computed result can be too small if the true value of N*log(B)/log(BASE)
2191is a little bit larger than an exact integer, but due to roundoff errors (in
2192computing log(B), log(BASE), their quotient, and/or multiplying that by N)
2193yields a numeric result a little less than that integer. Unfortunately, "how
2194close can a transcendental function get to an integer over some range?"
2195questions are generally theoretically intractable. Computer analysis via
2196continued fractions is practical: expand log(B)/log(BASE) via continued
2197fractions, giving a sequence i/j of "the best" rational approximations. Then
2198j*log(B)/log(BASE) is approximately equal to (the integer) i. This shows that
2199we can get very close to being in trouble, but very rarely. For example,
220076573 is a denominator in one of the continued-fraction approximations to
2201log(10)/log(2**15), and indeed:
2202
2203 >>> log(10)/log(2**15)*76573
2204 16958.000000654003
2205
2206is very close to an integer. If we were working with IEEE single-precision,
2207rounding errors could kill us. Finding worst cases in IEEE double-precision
2208requires better-than-double-precision log() functions, and Tim didn't bother.
2209Instead the code checks to see whether the allocated space is enough as each
Serhiy Storchaka95949422013-08-27 19:40:23 +03002210new Python digit is added, and copies the whole thing to a larger int if not.
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002211This should happen extremely rarely, and in fact I don't have a test case
2212that triggers it(!). Instead the code was tested by artificially allocating
2213just 1 digit at the start, so that the copying code was exercised for every
2214digit beyond the first.
Thomas Wouters477c8d52006-05-27 19:21:47 +00002215***/
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002216 twodigits c; /* current input character */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002217 Py_ssize_t size_z;
2218 int i;
2219 int convwidth;
2220 twodigits convmultmax, convmult;
2221 digit *pz, *pzstop;
Serhiy Storchakac6792272013-10-19 21:03:34 +03002222 const char* scan;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002223
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002224 static double log_base_BASE[37] = {0.0e0,};
2225 static int convwidth_base[37] = {0,};
2226 static twodigits convmultmax_base[37] = {0,};
Thomas Wouters477c8d52006-05-27 19:21:47 +00002227
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002228 if (log_base_BASE[base] == 0.0) {
2229 twodigits convmax = base;
2230 int i = 1;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002231
Mark Dickinson22b20182010-05-10 21:27:53 +00002232 log_base_BASE[base] = (log((double)base) /
2233 log((double)PyLong_BASE));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002234 for (;;) {
2235 twodigits next = convmax * base;
2236 if (next > PyLong_BASE)
2237 break;
2238 convmax = next;
2239 ++i;
2240 }
2241 convmultmax_base[base] = convmax;
2242 assert(i > 0);
2243 convwidth_base[base] = i;
2244 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002245
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002246 /* Find length of the string of numeric characters. */
2247 scan = str;
2248 while (_PyLong_DigitValue[Py_CHARMASK(*scan)] < base)
2249 ++scan;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002250
Serhiy Storchaka95949422013-08-27 19:40:23 +03002251 /* Create an int object that can contain the largest possible
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002252 * integer with this base and length. Note that there's no
2253 * need to initialize z->ob_digit -- no slot is read up before
2254 * being stored into.
2255 */
2256 size_z = (Py_ssize_t)((scan - str) * log_base_BASE[base]) + 1;
2257 /* Uncomment next line to test exceedingly rare copy code */
2258 /* size_z = 1; */
2259 assert(size_z > 0);
2260 z = _PyLong_New(size_z);
2261 if (z == NULL)
2262 return NULL;
2263 Py_SIZE(z) = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002264
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002265 /* `convwidth` consecutive input digits are treated as a single
2266 * digit in base `convmultmax`.
2267 */
2268 convwidth = convwidth_base[base];
2269 convmultmax = convmultmax_base[base];
Thomas Wouters477c8d52006-05-27 19:21:47 +00002270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002271 /* Work ;-) */
2272 while (str < scan) {
2273 /* grab up to convwidth digits from the input string */
2274 c = (digit)_PyLong_DigitValue[Py_CHARMASK(*str++)];
2275 for (i = 1; i < convwidth && str != scan; ++i, ++str) {
2276 c = (twodigits)(c * base +
Mark Dickinson22b20182010-05-10 21:27:53 +00002277 (int)_PyLong_DigitValue[Py_CHARMASK(*str)]);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002278 assert(c < PyLong_BASE);
2279 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002280
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002281 convmult = convmultmax;
2282 /* Calculate the shift only if we couldn't get
2283 * convwidth digits.
2284 */
2285 if (i != convwidth) {
2286 convmult = base;
2287 for ( ; i > 1; --i)
2288 convmult *= base;
2289 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002290
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002291 /* Multiply z by convmult, and add c. */
2292 pz = z->ob_digit;
2293 pzstop = pz + Py_SIZE(z);
2294 for (; pz < pzstop; ++pz) {
2295 c += (twodigits)*pz * convmult;
2296 *pz = (digit)(c & PyLong_MASK);
2297 c >>= PyLong_SHIFT;
2298 }
2299 /* carry off the current end? */
2300 if (c) {
2301 assert(c < PyLong_BASE);
2302 if (Py_SIZE(z) < size_z) {
2303 *pz = (digit)c;
2304 ++Py_SIZE(z);
2305 }
2306 else {
2307 PyLongObject *tmp;
2308 /* Extremely rare. Get more space. */
2309 assert(Py_SIZE(z) == size_z);
2310 tmp = _PyLong_New(size_z + 1);
2311 if (tmp == NULL) {
2312 Py_DECREF(z);
2313 return NULL;
2314 }
2315 memcpy(tmp->ob_digit,
2316 z->ob_digit,
2317 sizeof(digit) * size_z);
2318 Py_DECREF(z);
2319 z = tmp;
2320 z->ob_digit[size_z] = (digit)c;
2321 ++size_z;
2322 }
2323 }
2324 }
2325 }
2326 if (z == NULL)
2327 return NULL;
2328 if (error_if_nonzero) {
2329 /* reset the base to 0, else the exception message
2330 doesn't make too much sense */
2331 base = 0;
2332 if (Py_SIZE(z) != 0)
2333 goto onError;
2334 /* there might still be other problems, therefore base
2335 remains zero here for the same reason */
2336 }
2337 if (str == start)
2338 goto onError;
2339 if (sign < 0)
2340 Py_SIZE(z) = -(Py_SIZE(z));
Antoine Pitrou4de74572013-02-09 23:11:27 +01002341 while (*str && Py_ISSPACE(Py_CHARMASK(*str)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002342 str++;
2343 if (*str != '\0')
2344 goto onError;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002345 long_normalize(z);
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03002346 z = maybe_small_long(z);
2347 if (z == NULL)
2348 return NULL;
2349 if (pend != NULL)
Serhiy Storchakac6792272013-10-19 21:03:34 +03002350 *pend = (char *)str;
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03002351 return (PyObject *) z;
Guido van Rossum9e896b32000-04-05 20:11:21 +00002352
Mark Dickinson22b20182010-05-10 21:27:53 +00002353 onError:
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03002354 if (pend != NULL)
Serhiy Storchakac6792272013-10-19 21:03:34 +03002355 *pend = (char *)str;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002356 Py_XDECREF(z);
2357 slen = strlen(orig_str) < 200 ? strlen(orig_str) : 200;
2358 strobj = PyUnicode_FromStringAndSize(orig_str, slen);
2359 if (strobj == NULL)
2360 return NULL;
2361 PyErr_Format(PyExc_ValueError,
Serhiy Storchaka579ddc22013-08-03 21:14:05 +03002362 "invalid literal for int() with base %d: %.200R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002363 base, strobj);
2364 Py_DECREF(strobj);
2365 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +00002366}
2367
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03002368/* Since PyLong_FromString doesn't have a length parameter,
2369 * check here for possible NULs in the string.
2370 *
2371 * Reports an invalid literal as a bytes object.
2372 */
2373PyObject *
2374_PyLong_FromBytes(const char *s, Py_ssize_t len, int base)
2375{
2376 PyObject *result, *strobj;
2377 char *end = NULL;
2378
Serhiy Storchaka20b39b22014-09-28 11:27:24 +03002379 result = PyLong_FromString(s, &end, base);
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03002380 if (end == NULL || (result != NULL && end == s + len))
2381 return result;
2382 Py_XDECREF(result);
2383 strobj = PyBytes_FromStringAndSize(s, Py_MIN(len, 200));
2384 if (strobj != NULL) {
2385 PyErr_Format(PyExc_ValueError,
Serhiy Storchaka579ddc22013-08-03 21:14:05 +03002386 "invalid literal for int() with base %d: %.200R",
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03002387 base, strobj);
2388 Py_DECREF(strobj);
2389 }
2390 return NULL;
2391}
2392
Guido van Rossum9e896b32000-04-05 20:11:21 +00002393PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002394PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base)
Guido van Rossum9e896b32000-04-05 20:11:21 +00002395{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002396 PyObject *v, *unicode = PyUnicode_FromUnicode(u, length);
2397 if (unicode == NULL)
2398 return NULL;
2399 v = PyLong_FromUnicodeObject(unicode, base);
2400 Py_DECREF(unicode);
2401 return v;
2402}
2403
2404PyObject *
2405PyLong_FromUnicodeObject(PyObject *u, int base)
2406{
Serhiy Storchaka579ddc22013-08-03 21:14:05 +03002407 PyObject *result, *asciidig;
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03002408 char *buffer, *end = NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002409 Py_ssize_t buflen;
Guido van Rossum9e896b32000-04-05 20:11:21 +00002410
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002411 asciidig = _PyUnicode_TransformDecimalAndSpaceToASCII(u);
Alexander Belopolsky942af5a2010-12-04 03:38:46 +00002412 if (asciidig == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002413 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002414 buffer = PyUnicode_AsUTF8AndSize(asciidig, &buflen);
Alexander Belopolsky942af5a2010-12-04 03:38:46 +00002415 if (buffer == NULL) {
2416 Py_DECREF(asciidig);
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03002417 if (!PyErr_ExceptionMatches(PyExc_UnicodeEncodeError))
2418 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002419 }
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03002420 else {
2421 result = PyLong_FromString(buffer, &end, base);
2422 if (end == NULL || (result != NULL && end == buffer + buflen)) {
2423 Py_DECREF(asciidig);
2424 return result;
2425 }
2426 Py_DECREF(asciidig);
2427 Py_XDECREF(result);
Alexander Belopolsky942af5a2010-12-04 03:38:46 +00002428 }
Serhiy Storchaka579ddc22013-08-03 21:14:05 +03002429 PyErr_Format(PyExc_ValueError,
2430 "invalid literal for int() with base %d: %.200R",
2431 base, u);
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03002432 return NULL;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002433}
2434
Tim Peters9f688bf2000-07-07 15:53:28 +00002435/* forward */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002436static PyLongObject *x_divrem
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002437 (PyLongObject *, PyLongObject *, PyLongObject **);
Guido van Rossumb43daf72007-08-01 18:08:08 +00002438static PyObject *long_long(PyObject *v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002439
Serhiy Storchaka95949422013-08-27 19:40:23 +03002440/* Int division with remainder, top-level routine */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002441
Guido van Rossume32e0141992-01-19 16:31:05 +00002442static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002443long_divrem(PyLongObject *a, PyLongObject *b,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 PyLongObject **pdiv, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002445{
Victor Stinner45e8e2f2014-05-14 17:24:35 +02002446 Py_ssize_t size_a = Py_ABS(Py_SIZE(a)), size_b = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002447 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002448
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002449 if (size_b == 0) {
2450 PyErr_SetString(PyExc_ZeroDivisionError,
2451 "integer division or modulo by zero");
2452 return -1;
2453 }
2454 if (size_a < size_b ||
2455 (size_a == size_b &&
2456 a->ob_digit[size_a-1] < b->ob_digit[size_b-1])) {
2457 /* |a| < |b|. */
2458 *pdiv = (PyLongObject*)PyLong_FromLong(0);
2459 if (*pdiv == NULL)
2460 return -1;
2461 Py_INCREF(a);
2462 *prem = (PyLongObject *) a;
2463 return 0;
2464 }
2465 if (size_b == 1) {
2466 digit rem = 0;
2467 z = divrem1(a, b->ob_digit[0], &rem);
2468 if (z == NULL)
2469 return -1;
2470 *prem = (PyLongObject *) PyLong_FromLong((long)rem);
2471 if (*prem == NULL) {
2472 Py_DECREF(z);
2473 return -1;
2474 }
2475 }
2476 else {
2477 z = x_divrem(a, b, prem);
2478 if (z == NULL)
2479 return -1;
2480 }
2481 /* Set the signs.
2482 The quotient z has the sign of a*b;
2483 the remainder r has the sign of a,
2484 so a = b*z + r. */
Victor Stinner8aed6f12013-07-17 22:31:17 +02002485 if ((Py_SIZE(a) < 0) != (Py_SIZE(b) < 0)) {
2486 _PyLong_Negate(&z);
2487 if (z == NULL) {
2488 Py_CLEAR(*prem);
2489 return -1;
2490 }
2491 }
2492 if (Py_SIZE(a) < 0 && Py_SIZE(*prem) != 0) {
2493 _PyLong_Negate(prem);
2494 if (*prem == NULL) {
2495 Py_DECREF(z);
2496 Py_CLEAR(*prem);
2497 return -1;
2498 }
2499 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002500 *pdiv = maybe_small_long(z);
2501 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002502}
2503
Serhiy Storchaka95949422013-08-27 19:40:23 +03002504/* Unsigned int division with remainder -- the algorithm. The arguments v1
Victor Stinner45e8e2f2014-05-14 17:24:35 +02002505 and w1 should satisfy 2 <= Py_ABS(Py_SIZE(w1)) <= Py_ABS(Py_SIZE(v1)). */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002506
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002507static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002508x_divrem(PyLongObject *v1, PyLongObject *w1, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002509{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002510 PyLongObject *v, *w, *a;
2511 Py_ssize_t i, k, size_v, size_w;
2512 int d;
2513 digit wm1, wm2, carry, q, r, vtop, *v0, *vk, *w0, *ak;
2514 twodigits vv;
2515 sdigit zhi;
2516 stwodigits z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002517
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002518 /* We follow Knuth [The Art of Computer Programming, Vol. 2 (3rd
2519 edn.), section 4.3.1, Algorithm D], except that we don't explicitly
2520 handle the special case when the initial estimate q for a quotient
2521 digit is >= PyLong_BASE: the max value for q is PyLong_BASE+1, and
2522 that won't overflow a digit. */
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002523
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002524 /* allocate space; w will also be used to hold the final remainder */
Victor Stinner45e8e2f2014-05-14 17:24:35 +02002525 size_v = Py_ABS(Py_SIZE(v1));
2526 size_w = Py_ABS(Py_SIZE(w1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002527 assert(size_v >= size_w && size_w >= 2); /* Assert checks by div() */
2528 v = _PyLong_New(size_v+1);
2529 if (v == NULL) {
2530 *prem = NULL;
2531 return NULL;
2532 }
2533 w = _PyLong_New(size_w);
2534 if (w == NULL) {
2535 Py_DECREF(v);
2536 *prem = NULL;
2537 return NULL;
2538 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002539
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002540 /* normalize: shift w1 left so that its top digit is >= PyLong_BASE/2.
2541 shift v1 left by the same amount. Results go into w and v. */
2542 d = PyLong_SHIFT - bits_in_digit(w1->ob_digit[size_w-1]);
2543 carry = v_lshift(w->ob_digit, w1->ob_digit, size_w, d);
2544 assert(carry == 0);
2545 carry = v_lshift(v->ob_digit, v1->ob_digit, size_v, d);
2546 if (carry != 0 || v->ob_digit[size_v-1] >= w->ob_digit[size_w-1]) {
2547 v->ob_digit[size_v] = carry;
2548 size_v++;
2549 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002550
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002551 /* Now v->ob_digit[size_v-1] < w->ob_digit[size_w-1], so quotient has
2552 at most (and usually exactly) k = size_v - size_w digits. */
2553 k = size_v - size_w;
2554 assert(k >= 0);
2555 a = _PyLong_New(k);
2556 if (a == NULL) {
2557 Py_DECREF(w);
2558 Py_DECREF(v);
2559 *prem = NULL;
2560 return NULL;
2561 }
2562 v0 = v->ob_digit;
2563 w0 = w->ob_digit;
2564 wm1 = w0[size_w-1];
2565 wm2 = w0[size_w-2];
2566 for (vk = v0+k, ak = a->ob_digit + k; vk-- > v0;) {
2567 /* inner loop: divide vk[0:size_w+1] by w0[0:size_w], giving
2568 single-digit quotient q, remainder in vk[0:size_w]. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002570 SIGCHECK({
Mark Dickinson22b20182010-05-10 21:27:53 +00002571 Py_DECREF(a);
2572 Py_DECREF(w);
2573 Py_DECREF(v);
2574 *prem = NULL;
2575 return NULL;
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00002576 });
Tim Peters5af4e6c2002-08-12 02:31:19 +00002577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002578 /* estimate quotient digit q; may overestimate by 1 (rare) */
2579 vtop = vk[size_w];
2580 assert(vtop <= wm1);
2581 vv = ((twodigits)vtop << PyLong_SHIFT) | vk[size_w-1];
2582 q = (digit)(vv / wm1);
2583 r = (digit)(vv - (twodigits)wm1 * q); /* r = vv % wm1 */
2584 while ((twodigits)wm2 * q > (((twodigits)r << PyLong_SHIFT)
2585 | vk[size_w-2])) {
2586 --q;
2587 r += wm1;
2588 if (r >= PyLong_BASE)
2589 break;
2590 }
2591 assert(q <= PyLong_BASE);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002593 /* subtract q*w0[0:size_w] from vk[0:size_w+1] */
2594 zhi = 0;
2595 for (i = 0; i < size_w; ++i) {
2596 /* invariants: -PyLong_BASE <= -q <= zhi <= 0;
2597 -PyLong_BASE * q <= z < PyLong_BASE */
2598 z = (sdigit)vk[i] + zhi -
2599 (stwodigits)q * (stwodigits)w0[i];
2600 vk[i] = (digit)z & PyLong_MASK;
2601 zhi = (sdigit)Py_ARITHMETIC_RIGHT_SHIFT(stwodigits,
Mark Dickinson22b20182010-05-10 21:27:53 +00002602 z, PyLong_SHIFT);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002603 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002605 /* add w back if q was too large (this branch taken rarely) */
2606 assert((sdigit)vtop + zhi == -1 || (sdigit)vtop + zhi == 0);
2607 if ((sdigit)vtop + zhi < 0) {
2608 carry = 0;
2609 for (i = 0; i < size_w; ++i) {
2610 carry += vk[i] + w0[i];
2611 vk[i] = carry & PyLong_MASK;
2612 carry >>= PyLong_SHIFT;
2613 }
2614 --q;
2615 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002617 /* store quotient digit */
2618 assert(q < PyLong_BASE);
2619 *--ak = q;
2620 }
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002621
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002622 /* unshift remainder; we reuse w to store the result */
2623 carry = v_rshift(w0, v0, size_w, d);
2624 assert(carry==0);
2625 Py_DECREF(v);
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002627 *prem = long_normalize(w);
2628 return long_normalize(a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002629}
2630
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002631/* For a nonzero PyLong a, express a in the form x * 2**e, with 0.5 <=
2632 abs(x) < 1.0 and e >= 0; return x and put e in *e. Here x is
2633 rounded to DBL_MANT_DIG significant bits using round-half-to-even.
2634 If a == 0, return 0.0 and set *e = 0. If the resulting exponent
2635 e is larger than PY_SSIZE_T_MAX, raise OverflowError and return
2636 -1.0. */
2637
2638/* attempt to define 2.0**DBL_MANT_DIG as a compile-time constant */
2639#if DBL_MANT_DIG == 53
2640#define EXP2_DBL_MANT_DIG 9007199254740992.0
2641#else
2642#define EXP2_DBL_MANT_DIG (ldexp(1.0, DBL_MANT_DIG))
2643#endif
2644
2645double
2646_PyLong_Frexp(PyLongObject *a, Py_ssize_t *e)
2647{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002648 Py_ssize_t a_size, a_bits, shift_digits, shift_bits, x_size;
2649 /* See below for why x_digits is always large enough. */
2650 digit rem, x_digits[2 + (DBL_MANT_DIG + 1) / PyLong_SHIFT];
2651 double dx;
2652 /* Correction term for round-half-to-even rounding. For a digit x,
2653 "x + half_even_correction[x & 7]" gives x rounded to the nearest
2654 multiple of 4, rounding ties to a multiple of 8. */
2655 static const int half_even_correction[8] = {0, -1, -2, 1, 0, -1, 2, 1};
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002656
Victor Stinner45e8e2f2014-05-14 17:24:35 +02002657 a_size = Py_ABS(Py_SIZE(a));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002658 if (a_size == 0) {
2659 /* Special case for 0: significand 0.0, exponent 0. */
2660 *e = 0;
2661 return 0.0;
2662 }
2663 a_bits = bits_in_digit(a->ob_digit[a_size-1]);
2664 /* The following is an overflow-free version of the check
2665 "if ((a_size - 1) * PyLong_SHIFT + a_bits > PY_SSIZE_T_MAX) ..." */
2666 if (a_size >= (PY_SSIZE_T_MAX - 1) / PyLong_SHIFT + 1 &&
2667 (a_size > (PY_SSIZE_T_MAX - 1) / PyLong_SHIFT + 1 ||
2668 a_bits > (PY_SSIZE_T_MAX - 1) % PyLong_SHIFT + 1))
Mark Dickinson22b20182010-05-10 21:27:53 +00002669 goto overflow;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002670 a_bits = (a_size - 1) * PyLong_SHIFT + a_bits;
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002671
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 /* Shift the first DBL_MANT_DIG + 2 bits of a into x_digits[0:x_size]
2673 (shifting left if a_bits <= DBL_MANT_DIG + 2).
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002675 Number of digits needed for result: write // for floor division.
2676 Then if shifting left, we end up using
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002677
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002678 1 + a_size + (DBL_MANT_DIG + 2 - a_bits) // PyLong_SHIFT
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002679
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002680 digits. If shifting right, we use
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002682 a_size - (a_bits - DBL_MANT_DIG - 2) // PyLong_SHIFT
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002683
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002684 digits. Using a_size = 1 + (a_bits - 1) // PyLong_SHIFT along with
2685 the inequalities
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002687 m // PyLong_SHIFT + n // PyLong_SHIFT <= (m + n) // PyLong_SHIFT
2688 m // PyLong_SHIFT - n // PyLong_SHIFT <=
2689 1 + (m - n - 1) // PyLong_SHIFT,
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002691 valid for any integers m and n, we find that x_size satisfies
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002693 x_size <= 2 + (DBL_MANT_DIG + 1) // PyLong_SHIFT
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002694
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002695 in both cases.
2696 */
2697 if (a_bits <= DBL_MANT_DIG + 2) {
2698 shift_digits = (DBL_MANT_DIG + 2 - a_bits) / PyLong_SHIFT;
2699 shift_bits = (DBL_MANT_DIG + 2 - a_bits) % PyLong_SHIFT;
2700 x_size = 0;
2701 while (x_size < shift_digits)
2702 x_digits[x_size++] = 0;
2703 rem = v_lshift(x_digits + x_size, a->ob_digit, a_size,
2704 (int)shift_bits);
2705 x_size += a_size;
2706 x_digits[x_size++] = rem;
2707 }
2708 else {
2709 shift_digits = (a_bits - DBL_MANT_DIG - 2) / PyLong_SHIFT;
2710 shift_bits = (a_bits - DBL_MANT_DIG - 2) % PyLong_SHIFT;
2711 rem = v_rshift(x_digits, a->ob_digit + shift_digits,
2712 a_size - shift_digits, (int)shift_bits);
2713 x_size = a_size - shift_digits;
2714 /* For correct rounding below, we need the least significant
2715 bit of x to be 'sticky' for this shift: if any of the bits
2716 shifted out was nonzero, we set the least significant bit
2717 of x. */
2718 if (rem)
2719 x_digits[0] |= 1;
2720 else
2721 while (shift_digits > 0)
2722 if (a->ob_digit[--shift_digits]) {
2723 x_digits[0] |= 1;
2724 break;
2725 }
2726 }
Victor Stinner63941882011-09-29 00:42:28 +02002727 assert(1 <= x_size && x_size <= (Py_ssize_t)Py_ARRAY_LENGTH(x_digits));
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002728
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002729 /* Round, and convert to double. */
2730 x_digits[0] += half_even_correction[x_digits[0] & 7];
2731 dx = x_digits[--x_size];
2732 while (x_size > 0)
2733 dx = dx * PyLong_BASE + x_digits[--x_size];
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002734
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002735 /* Rescale; make correction if result is 1.0. */
2736 dx /= 4.0 * EXP2_DBL_MANT_DIG;
2737 if (dx == 1.0) {
2738 if (a_bits == PY_SSIZE_T_MAX)
2739 goto overflow;
2740 dx = 0.5;
2741 a_bits += 1;
2742 }
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002743
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002744 *e = a_bits;
2745 return Py_SIZE(a) < 0 ? -dx : dx;
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002746
2747 overflow:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002748 /* exponent > PY_SSIZE_T_MAX */
2749 PyErr_SetString(PyExc_OverflowError,
2750 "huge integer: number of bits overflows a Py_ssize_t");
2751 *e = 0;
2752 return -1.0;
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002753}
2754
Serhiy Storchaka95949422013-08-27 19:40:23 +03002755/* Get a C double from an int object. Rounds to the nearest double,
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002756 using the round-half-to-even rule in the case of a tie. */
2757
2758double
2759PyLong_AsDouble(PyObject *v)
2760{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002761 Py_ssize_t exponent;
2762 double x;
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002763
Nadeem Vawda3d5881e2011-09-07 21:40:26 +02002764 if (v == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002765 PyErr_BadInternalCall();
2766 return -1.0;
2767 }
Nadeem Vawda3d5881e2011-09-07 21:40:26 +02002768 if (!PyLong_Check(v)) {
2769 PyErr_SetString(PyExc_TypeError, "an integer is required");
2770 return -1.0;
2771 }
Yury Selivanov186c30b2016-02-05 19:40:01 -05002772 if (Py_ABS(Py_SIZE(v)) <= 1) {
Yury Selivanova0fcaca2016-02-06 12:21:33 -05002773 /* Fast path; single digit long (31 bits) will cast safely
2774 to double. This improves performance of FP/long operations
2775 by 20%.
Yury Selivanov186c30b2016-02-05 19:40:01 -05002776 */
2777 return (double)MEDIUM_VALUE((PyLongObject *)v);
2778 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002779 x = _PyLong_Frexp((PyLongObject *)v, &exponent);
2780 if ((x == -1.0 && PyErr_Occurred()) || exponent > DBL_MAX_EXP) {
2781 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson02515f72013-08-03 12:08:22 +01002782 "int too large to convert to float");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002783 return -1.0;
2784 }
2785 return ldexp(x, (int)exponent);
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002786}
2787
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002788/* Methods */
2789
2790static void
Tim Peters9f688bf2000-07-07 15:53:28 +00002791long_dealloc(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002792{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002793 Py_TYPE(v)->tp_free(v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002794}
2795
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002796static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002797long_compare(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002798{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002799 Py_ssize_t sign;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002800
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002801 if (Py_SIZE(a) != Py_SIZE(b)) {
2802 sign = Py_SIZE(a) - Py_SIZE(b);
2803 }
2804 else {
Victor Stinner45e8e2f2014-05-14 17:24:35 +02002805 Py_ssize_t i = Py_ABS(Py_SIZE(a));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002806 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2807 ;
2808 if (i < 0)
2809 sign = 0;
2810 else {
2811 sign = (sdigit)a->ob_digit[i] - (sdigit)b->ob_digit[i];
2812 if (Py_SIZE(a) < 0)
2813 sign = -sign;
2814 }
2815 }
2816 return sign < 0 ? -1 : sign > 0 ? 1 : 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002817}
2818
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002819#define TEST_COND(cond) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002820 ((cond) ? Py_True : Py_False)
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002821
Guido van Rossum47b9ff62006-08-24 00:41:19 +00002822static PyObject *
2823long_richcompare(PyObject *self, PyObject *other, int op)
2824{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002825 int result;
2826 PyObject *v;
2827 CHECK_BINOP(self, other);
2828 if (self == other)
2829 result = 0;
2830 else
2831 result = long_compare((PyLongObject*)self, (PyLongObject*)other);
2832 /* Convert the return value to a Boolean */
2833 switch (op) {
2834 case Py_EQ:
2835 v = TEST_COND(result == 0);
2836 break;
2837 case Py_NE:
2838 v = TEST_COND(result != 0);
2839 break;
2840 case Py_LE:
2841 v = TEST_COND(result <= 0);
2842 break;
2843 case Py_GE:
2844 v = TEST_COND(result >= 0);
2845 break;
2846 case Py_LT:
2847 v = TEST_COND(result == -1);
2848 break;
2849 case Py_GT:
2850 v = TEST_COND(result == 1);
2851 break;
2852 default:
2853 PyErr_BadArgument();
2854 return NULL;
2855 }
2856 Py_INCREF(v);
2857 return v;
Guido van Rossum47b9ff62006-08-24 00:41:19 +00002858}
2859
Benjamin Peterson8f67d082010-10-17 20:54:53 +00002860static Py_hash_t
Tim Peters9f688bf2000-07-07 15:53:28 +00002861long_hash(PyLongObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +00002862{
Benjamin Peterson8035bc52010-10-23 16:20:50 +00002863 Py_uhash_t x;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002864 Py_ssize_t i;
2865 int sign;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002866
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002867 i = Py_SIZE(v);
2868 switch(i) {
2869 case -1: return v->ob_digit[0]==1 ? -2 : -(sdigit)v->ob_digit[0];
2870 case 0: return 0;
2871 case 1: return v->ob_digit[0];
2872 }
2873 sign = 1;
2874 x = 0;
2875 if (i < 0) {
2876 sign = -1;
2877 i = -(i);
2878 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002879 while (--i >= 0) {
Mark Dickinsondc787d22010-05-23 13:33:13 +00002880 /* Here x is a quantity in the range [0, _PyHASH_MODULUS); we
2881 want to compute x * 2**PyLong_SHIFT + v->ob_digit[i] modulo
2882 _PyHASH_MODULUS.
2883
2884 The computation of x * 2**PyLong_SHIFT % _PyHASH_MODULUS
2885 amounts to a rotation of the bits of x. To see this, write
2886
2887 x * 2**PyLong_SHIFT = y * 2**_PyHASH_BITS + z
2888
2889 where y = x >> (_PyHASH_BITS - PyLong_SHIFT) gives the top
2890 PyLong_SHIFT bits of x (those that are shifted out of the
2891 original _PyHASH_BITS bits, and z = (x << PyLong_SHIFT) &
2892 _PyHASH_MODULUS gives the bottom _PyHASH_BITS - PyLong_SHIFT
2893 bits of x, shifted up. Then since 2**_PyHASH_BITS is
2894 congruent to 1 modulo _PyHASH_MODULUS, y*2**_PyHASH_BITS is
2895 congruent to y modulo _PyHASH_MODULUS. So
2896
2897 x * 2**PyLong_SHIFT = y + z (mod _PyHASH_MODULUS).
2898
2899 The right-hand side is just the result of rotating the
2900 _PyHASH_BITS bits of x left by PyLong_SHIFT places; since
2901 not all _PyHASH_BITS bits of x are 1s, the same is true
2902 after rotation, so 0 <= y+z < _PyHASH_MODULUS and y + z is
2903 the reduction of x*2**PyLong_SHIFT modulo
2904 _PyHASH_MODULUS. */
2905 x = ((x << PyLong_SHIFT) & _PyHASH_MODULUS) |
2906 (x >> (_PyHASH_BITS - PyLong_SHIFT));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002907 x += v->ob_digit[i];
Mark Dickinsondc787d22010-05-23 13:33:13 +00002908 if (x >= _PyHASH_MODULUS)
2909 x -= _PyHASH_MODULUS;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002910 }
2911 x = x * sign;
Benjamin Peterson8035bc52010-10-23 16:20:50 +00002912 if (x == (Py_uhash_t)-1)
2913 x = (Py_uhash_t)-2;
Benjamin Peterson8f67d082010-10-17 20:54:53 +00002914 return (Py_hash_t)x;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002915}
2916
2917
Serhiy Storchaka95949422013-08-27 19:40:23 +03002918/* Add the absolute values of two integers. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002919
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002920static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002921x_add(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002922{
Victor Stinner45e8e2f2014-05-14 17:24:35 +02002923 Py_ssize_t size_a = Py_ABS(Py_SIZE(a)), size_b = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002924 PyLongObject *z;
2925 Py_ssize_t i;
2926 digit carry = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002927
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002928 /* Ensure a is the larger of the two: */
2929 if (size_a < size_b) {
2930 { PyLongObject *temp = a; a = b; b = temp; }
2931 { Py_ssize_t size_temp = size_a;
Mark Dickinson22b20182010-05-10 21:27:53 +00002932 size_a = size_b;
2933 size_b = size_temp; }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002934 }
2935 z = _PyLong_New(size_a+1);
2936 if (z == NULL)
2937 return NULL;
2938 for (i = 0; i < size_b; ++i) {
2939 carry += a->ob_digit[i] + b->ob_digit[i];
2940 z->ob_digit[i] = carry & PyLong_MASK;
2941 carry >>= PyLong_SHIFT;
2942 }
2943 for (; i < size_a; ++i) {
2944 carry += a->ob_digit[i];
2945 z->ob_digit[i] = carry & PyLong_MASK;
2946 carry >>= PyLong_SHIFT;
2947 }
2948 z->ob_digit[i] = carry;
2949 return long_normalize(z);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002950}
2951
2952/* Subtract the absolute values of two integers. */
2953
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002954static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002955x_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002956{
Victor Stinner45e8e2f2014-05-14 17:24:35 +02002957 Py_ssize_t size_a = Py_ABS(Py_SIZE(a)), size_b = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002958 PyLongObject *z;
2959 Py_ssize_t i;
2960 int sign = 1;
2961 digit borrow = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002962
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002963 /* Ensure a is the larger of the two: */
2964 if (size_a < size_b) {
2965 sign = -1;
2966 { PyLongObject *temp = a; a = b; b = temp; }
2967 { Py_ssize_t size_temp = size_a;
Mark Dickinson22b20182010-05-10 21:27:53 +00002968 size_a = size_b;
2969 size_b = size_temp; }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002970 }
2971 else if (size_a == size_b) {
2972 /* Find highest digit where a and b differ: */
2973 i = size_a;
2974 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2975 ;
2976 if (i < 0)
2977 return (PyLongObject *)PyLong_FromLong(0);
2978 if (a->ob_digit[i] < b->ob_digit[i]) {
2979 sign = -1;
2980 { PyLongObject *temp = a; a = b; b = temp; }
2981 }
2982 size_a = size_b = i+1;
2983 }
2984 z = _PyLong_New(size_a);
2985 if (z == NULL)
2986 return NULL;
2987 for (i = 0; i < size_b; ++i) {
2988 /* The following assumes unsigned arithmetic
2989 works module 2**N for some N>PyLong_SHIFT. */
2990 borrow = a->ob_digit[i] - b->ob_digit[i] - borrow;
2991 z->ob_digit[i] = borrow & PyLong_MASK;
2992 borrow >>= PyLong_SHIFT;
2993 borrow &= 1; /* Keep only one sign bit */
2994 }
2995 for (; i < size_a; ++i) {
2996 borrow = a->ob_digit[i] - borrow;
2997 z->ob_digit[i] = borrow & PyLong_MASK;
2998 borrow >>= PyLong_SHIFT;
2999 borrow &= 1; /* Keep only one sign bit */
3000 }
3001 assert(borrow == 0);
Victor Stinner8aed6f12013-07-17 22:31:17 +02003002 if (sign < 0) {
3003 _PyLong_Negate(&z);
3004 if (z == NULL)
3005 return NULL;
3006 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003007 return long_normalize(z);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003008}
3009
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003010static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003011long_add(PyLongObject *a, PyLongObject *b)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003012{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003013 PyLongObject *z;
Tim Peters69c2de32001-09-11 22:31:33 +00003014
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003015 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003016
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003017 if (Py_ABS(Py_SIZE(a)) <= 1 && Py_ABS(Py_SIZE(b)) <= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003018 PyObject *result = PyLong_FromLong(MEDIUM_VALUE(a) +
3019 MEDIUM_VALUE(b));
3020 return result;
3021 }
3022 if (Py_SIZE(a) < 0) {
3023 if (Py_SIZE(b) < 0) {
3024 z = x_add(a, b);
3025 if (z != NULL && Py_SIZE(z) != 0)
3026 Py_SIZE(z) = -(Py_SIZE(z));
3027 }
3028 else
3029 z = x_sub(b, a);
3030 }
3031 else {
3032 if (Py_SIZE(b) < 0)
3033 z = x_sub(a, b);
3034 else
3035 z = x_add(a, b);
3036 }
3037 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003038}
3039
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003040static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003041long_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003042{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003043 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003044
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003045 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003046
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003047 if (Py_ABS(Py_SIZE(a)) <= 1 && Py_ABS(Py_SIZE(b)) <= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003048 PyObject* r;
3049 r = PyLong_FromLong(MEDIUM_VALUE(a)-MEDIUM_VALUE(b));
3050 return r;
3051 }
3052 if (Py_SIZE(a) < 0) {
3053 if (Py_SIZE(b) < 0)
3054 z = x_sub(a, b);
3055 else
3056 z = x_add(a, b);
3057 if (z != NULL && Py_SIZE(z) != 0)
3058 Py_SIZE(z) = -(Py_SIZE(z));
3059 }
3060 else {
3061 if (Py_SIZE(b) < 0)
3062 z = x_add(a, b);
3063 else
3064 z = x_sub(a, b);
3065 }
3066 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003067}
3068
Tim Peters5af4e6c2002-08-12 02:31:19 +00003069/* Grade school multiplication, ignoring the signs.
3070 * Returns the absolute value of the product, or NULL if error.
3071 */
3072static PyLongObject *
3073x_mul(PyLongObject *a, PyLongObject *b)
Neil Schemenauerba872e22001-01-04 01:46:03 +00003074{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003075 PyLongObject *z;
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003076 Py_ssize_t size_a = Py_ABS(Py_SIZE(a));
3077 Py_ssize_t size_b = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003078 Py_ssize_t i;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003079
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003080 z = _PyLong_New(size_a + size_b);
3081 if (z == NULL)
3082 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003084 memset(z->ob_digit, 0, Py_SIZE(z) * sizeof(digit));
3085 if (a == b) {
3086 /* Efficient squaring per HAC, Algorithm 14.16:
3087 * http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf
3088 * Gives slightly less than a 2x speedup when a == b,
3089 * via exploiting that each entry in the multiplication
3090 * pyramid appears twice (except for the size_a squares).
3091 */
3092 for (i = 0; i < size_a; ++i) {
3093 twodigits carry;
3094 twodigits f = a->ob_digit[i];
3095 digit *pz = z->ob_digit + (i << 1);
3096 digit *pa = a->ob_digit + i + 1;
3097 digit *paend = a->ob_digit + size_a;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003098
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003099 SIGCHECK({
Mark Dickinson22b20182010-05-10 21:27:53 +00003100 Py_DECREF(z);
3101 return NULL;
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00003102 });
Tim Peters0973b992004-08-29 22:16:50 +00003103
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003104 carry = *pz + f * f;
3105 *pz++ = (digit)(carry & PyLong_MASK);
3106 carry >>= PyLong_SHIFT;
3107 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00003108
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003109 /* Now f is added in twice in each column of the
3110 * pyramid it appears. Same as adding f<<1 once.
3111 */
3112 f <<= 1;
3113 while (pa < paend) {
3114 carry += *pz + *pa++ * f;
3115 *pz++ = (digit)(carry & PyLong_MASK);
3116 carry >>= PyLong_SHIFT;
3117 assert(carry <= (PyLong_MASK << 1));
3118 }
3119 if (carry) {
3120 carry += *pz;
3121 *pz++ = (digit)(carry & PyLong_MASK);
3122 carry >>= PyLong_SHIFT;
3123 }
3124 if (carry)
3125 *pz += (digit)(carry & PyLong_MASK);
3126 assert((carry >> PyLong_SHIFT) == 0);
3127 }
3128 }
Serhiy Storchaka95949422013-08-27 19:40:23 +03003129 else { /* a is not the same as b -- gradeschool int mult */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003130 for (i = 0; i < size_a; ++i) {
3131 twodigits carry = 0;
3132 twodigits f = a->ob_digit[i];
3133 digit *pz = z->ob_digit + i;
3134 digit *pb = b->ob_digit;
3135 digit *pbend = b->ob_digit + size_b;
Tim Peters0973b992004-08-29 22:16:50 +00003136
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003137 SIGCHECK({
Mark Dickinson22b20182010-05-10 21:27:53 +00003138 Py_DECREF(z);
3139 return NULL;
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00003140 });
Tim Peters0973b992004-08-29 22:16:50 +00003141
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003142 while (pb < pbend) {
3143 carry += *pz + *pb++ * f;
3144 *pz++ = (digit)(carry & PyLong_MASK);
3145 carry >>= PyLong_SHIFT;
3146 assert(carry <= PyLong_MASK);
3147 }
3148 if (carry)
3149 *pz += (digit)(carry & PyLong_MASK);
3150 assert((carry >> PyLong_SHIFT) == 0);
3151 }
3152 }
3153 return long_normalize(z);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003154}
3155
3156/* A helper for Karatsuba multiplication (k_mul).
Serhiy Storchaka95949422013-08-27 19:40:23 +03003157 Takes an int "n" and an integer "size" representing the place to
Tim Peters5af4e6c2002-08-12 02:31:19 +00003158 split, and sets low and high such that abs(n) == (high << size) + low,
3159 viewing the shift as being by digits. The sign bit is ignored, and
3160 the return values are >= 0.
3161 Returns 0 on success, -1 on failure.
3162*/
3163static int
Mark Dickinson22b20182010-05-10 21:27:53 +00003164kmul_split(PyLongObject *n,
3165 Py_ssize_t size,
3166 PyLongObject **high,
3167 PyLongObject **low)
Tim Peters5af4e6c2002-08-12 02:31:19 +00003168{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003169 PyLongObject *hi, *lo;
3170 Py_ssize_t size_lo, size_hi;
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003171 const Py_ssize_t size_n = Py_ABS(Py_SIZE(n));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003172
Victor Stinner640c35c2013-06-04 23:14:37 +02003173 size_lo = Py_MIN(size_n, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003174 size_hi = size_n - size_lo;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003176 if ((hi = _PyLong_New(size_hi)) == NULL)
3177 return -1;
3178 if ((lo = _PyLong_New(size_lo)) == NULL) {
3179 Py_DECREF(hi);
3180 return -1;
3181 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003182
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003183 memcpy(lo->ob_digit, n->ob_digit, size_lo * sizeof(digit));
3184 memcpy(hi->ob_digit, n->ob_digit + size_lo, size_hi * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003186 *high = long_normalize(hi);
3187 *low = long_normalize(lo);
3188 return 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003189}
3190
Tim Peters60004642002-08-12 22:01:34 +00003191static PyLongObject *k_lopsided_mul(PyLongObject *a, PyLongObject *b);
3192
Tim Peters5af4e6c2002-08-12 02:31:19 +00003193/* Karatsuba multiplication. Ignores the input signs, and returns the
3194 * absolute value of the product (or NULL if error).
3195 * See Knuth Vol. 2 Chapter 4.3.3 (Pp. 294-295).
3196 */
3197static PyLongObject *
3198k_mul(PyLongObject *a, PyLongObject *b)
3199{
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003200 Py_ssize_t asize = Py_ABS(Py_SIZE(a));
3201 Py_ssize_t bsize = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003202 PyLongObject *ah = NULL;
3203 PyLongObject *al = NULL;
3204 PyLongObject *bh = NULL;
3205 PyLongObject *bl = NULL;
3206 PyLongObject *ret = NULL;
3207 PyLongObject *t1, *t2, *t3;
3208 Py_ssize_t shift; /* the number of digits we split off */
3209 Py_ssize_t i;
Tim Peters738eda72002-08-12 15:08:20 +00003210
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003211 /* (ah*X+al)(bh*X+bl) = ah*bh*X*X + (ah*bl + al*bh)*X + al*bl
3212 * Let k = (ah+al)*(bh+bl) = ah*bl + al*bh + ah*bh + al*bl
3213 * Then the original product is
3214 * ah*bh*X*X + (k - ah*bh - al*bl)*X + al*bl
3215 * By picking X to be a power of 2, "*X" is just shifting, and it's
3216 * been reduced to 3 multiplies on numbers half the size.
3217 */
Tim Peters5af4e6c2002-08-12 02:31:19 +00003218
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003219 /* We want to split based on the larger number; fiddle so that b
3220 * is largest.
3221 */
3222 if (asize > bsize) {
3223 t1 = a;
3224 a = b;
3225 b = t1;
Tim Peters738eda72002-08-12 15:08:20 +00003226
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003227 i = asize;
3228 asize = bsize;
3229 bsize = i;
3230 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003231
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003232 /* Use gradeschool math when either number is too small. */
3233 i = a == b ? KARATSUBA_SQUARE_CUTOFF : KARATSUBA_CUTOFF;
3234 if (asize <= i) {
3235 if (asize == 0)
3236 return (PyLongObject *)PyLong_FromLong(0);
3237 else
3238 return x_mul(a, b);
3239 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003240
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003241 /* If a is small compared to b, splitting on b gives a degenerate
3242 * case with ah==0, and Karatsuba may be (even much) less efficient
3243 * than "grade school" then. However, we can still win, by viewing
3244 * b as a string of "big digits", each of width a->ob_size. That
3245 * leads to a sequence of balanced calls to k_mul.
3246 */
3247 if (2 * asize <= bsize)
3248 return k_lopsided_mul(a, b);
Tim Peters60004642002-08-12 22:01:34 +00003249
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003250 /* Split a & b into hi & lo pieces. */
3251 shift = bsize >> 1;
3252 if (kmul_split(a, shift, &ah, &al) < 0) goto fail;
3253 assert(Py_SIZE(ah) > 0); /* the split isn't degenerate */
Tim Petersd6974a52002-08-13 20:37:51 +00003254
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003255 if (a == b) {
3256 bh = ah;
3257 bl = al;
3258 Py_INCREF(bh);
3259 Py_INCREF(bl);
3260 }
3261 else if (kmul_split(b, shift, &bh, &bl) < 0) goto fail;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003262
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003263 /* The plan:
3264 * 1. Allocate result space (asize + bsize digits: that's always
3265 * enough).
3266 * 2. Compute ah*bh, and copy into result at 2*shift.
3267 * 3. Compute al*bl, and copy into result at 0. Note that this
3268 * can't overlap with #2.
3269 * 4. Subtract al*bl from the result, starting at shift. This may
3270 * underflow (borrow out of the high digit), but we don't care:
3271 * we're effectively doing unsigned arithmetic mod
3272 * BASE**(sizea + sizeb), and so long as the *final* result fits,
3273 * borrows and carries out of the high digit can be ignored.
3274 * 5. Subtract ah*bh from the result, starting at shift.
3275 * 6. Compute (ah+al)*(bh+bl), and add it into the result starting
3276 * at shift.
3277 */
Tim Petersd64c1de2002-08-12 17:36:03 +00003278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003279 /* 1. Allocate result space. */
3280 ret = _PyLong_New(asize + bsize);
3281 if (ret == NULL) goto fail;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003282#ifdef Py_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003283 /* Fill with trash, to catch reference to uninitialized digits. */
3284 memset(ret->ob_digit, 0xDF, Py_SIZE(ret) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003285#endif
Tim Peters44121a62002-08-12 06:17:58 +00003286
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003287 /* 2. t1 <- ah*bh, and copy into high digits of result. */
3288 if ((t1 = k_mul(ah, bh)) == NULL) goto fail;
3289 assert(Py_SIZE(t1) >= 0);
3290 assert(2*shift + Py_SIZE(t1) <= Py_SIZE(ret));
3291 memcpy(ret->ob_digit + 2*shift, t1->ob_digit,
3292 Py_SIZE(t1) * sizeof(digit));
Tim Peters738eda72002-08-12 15:08:20 +00003293
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003294 /* Zero-out the digits higher than the ah*bh copy. */
3295 i = Py_SIZE(ret) - 2*shift - Py_SIZE(t1);
3296 if (i)
3297 memset(ret->ob_digit + 2*shift + Py_SIZE(t1), 0,
3298 i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003300 /* 3. t2 <- al*bl, and copy into the low digits. */
3301 if ((t2 = k_mul(al, bl)) == NULL) {
3302 Py_DECREF(t1);
3303 goto fail;
3304 }
3305 assert(Py_SIZE(t2) >= 0);
3306 assert(Py_SIZE(t2) <= 2*shift); /* no overlap with high digits */
3307 memcpy(ret->ob_digit, t2->ob_digit, Py_SIZE(t2) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003309 /* Zero out remaining digits. */
3310 i = 2*shift - Py_SIZE(t2); /* number of uninitialized digits */
3311 if (i)
3312 memset(ret->ob_digit + Py_SIZE(t2), 0, i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003313
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003314 /* 4 & 5. Subtract ah*bh (t1) and al*bl (t2). We do al*bl first
3315 * because it's fresher in cache.
3316 */
3317 i = Py_SIZE(ret) - shift; /* # digits after shift */
3318 (void)v_isub(ret->ob_digit + shift, i, t2->ob_digit, Py_SIZE(t2));
3319 Py_DECREF(t2);
Tim Peters738eda72002-08-12 15:08:20 +00003320
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003321 (void)v_isub(ret->ob_digit + shift, i, t1->ob_digit, Py_SIZE(t1));
3322 Py_DECREF(t1);
Tim Peters738eda72002-08-12 15:08:20 +00003323
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003324 /* 6. t3 <- (ah+al)(bh+bl), and add into result. */
3325 if ((t1 = x_add(ah, al)) == NULL) goto fail;
3326 Py_DECREF(ah);
3327 Py_DECREF(al);
3328 ah = al = NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003329
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003330 if (a == b) {
3331 t2 = t1;
3332 Py_INCREF(t2);
3333 }
3334 else if ((t2 = x_add(bh, bl)) == NULL) {
3335 Py_DECREF(t1);
3336 goto fail;
3337 }
3338 Py_DECREF(bh);
3339 Py_DECREF(bl);
3340 bh = bl = NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003341
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003342 t3 = k_mul(t1, t2);
3343 Py_DECREF(t1);
3344 Py_DECREF(t2);
3345 if (t3 == NULL) goto fail;
3346 assert(Py_SIZE(t3) >= 0);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003348 /* Add t3. It's not obvious why we can't run out of room here.
3349 * See the (*) comment after this function.
3350 */
3351 (void)v_iadd(ret->ob_digit + shift, i, t3->ob_digit, Py_SIZE(t3));
3352 Py_DECREF(t3);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003353
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003354 return long_normalize(ret);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003355
Mark Dickinson22b20182010-05-10 21:27:53 +00003356 fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003357 Py_XDECREF(ret);
3358 Py_XDECREF(ah);
3359 Py_XDECREF(al);
3360 Py_XDECREF(bh);
3361 Py_XDECREF(bl);
3362 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003363}
3364
Tim Petersd6974a52002-08-13 20:37:51 +00003365/* (*) Why adding t3 can't "run out of room" above.
3366
Tim Petersab86c2b2002-08-15 20:06:00 +00003367Let f(x) mean the floor of x and c(x) mean the ceiling of x. Some facts
3368to start with:
Tim Petersd6974a52002-08-13 20:37:51 +00003369
Tim Petersab86c2b2002-08-15 20:06:00 +000033701. For any integer i, i = c(i/2) + f(i/2). In particular,
3371 bsize = c(bsize/2) + f(bsize/2).
33722. shift = f(bsize/2)
33733. asize <= bsize
33744. Since we call k_lopsided_mul if asize*2 <= bsize, asize*2 > bsize in this
3375 routine, so asize > bsize/2 >= f(bsize/2) in this routine.
Tim Petersd6974a52002-08-13 20:37:51 +00003376
Tim Petersab86c2b2002-08-15 20:06:00 +00003377We allocated asize + bsize result digits, and add t3 into them at an offset
3378of shift. This leaves asize+bsize-shift allocated digit positions for t3
3379to fit into, = (by #1 and #2) asize + f(bsize/2) + c(bsize/2) - f(bsize/2) =
3380asize + c(bsize/2) available digit positions.
Tim Petersd6974a52002-08-13 20:37:51 +00003381
Tim Petersab86c2b2002-08-15 20:06:00 +00003382bh has c(bsize/2) digits, and bl at most f(size/2) digits. So bh+hl has
3383at most c(bsize/2) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00003384
Tim Petersab86c2b2002-08-15 20:06:00 +00003385If asize == bsize, ah has c(bsize/2) digits, else ah has at most f(bsize/2)
3386digits, and al has at most f(bsize/2) digits in any case. So ah+al has at
3387most (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00003388
Tim Petersab86c2b2002-08-15 20:06:00 +00003389The product (ah+al)*(bh+bl) therefore has at most
Tim Petersd6974a52002-08-13 20:37:51 +00003390
Tim Petersab86c2b2002-08-15 20:06:00 +00003391 c(bsize/2) + (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits
Tim Petersd6974a52002-08-13 20:37:51 +00003392
Tim Petersab86c2b2002-08-15 20:06:00 +00003393and we have asize + c(bsize/2) available digit positions. We need to show
3394this is always enough. An instance of c(bsize/2) cancels out in both, so
3395the question reduces to whether asize digits is enough to hold
3396(asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits. If asize < bsize,
3397then we're asking whether asize digits >= f(bsize/2) digits + 2 bits. By #4,
3398asize is at least f(bsize/2)+1 digits, so this in turn reduces to whether 1
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003399digit is enough to hold 2 bits. This is so since PyLong_SHIFT=15 >= 2. If
Tim Petersab86c2b2002-08-15 20:06:00 +00003400asize == bsize, then we're asking whether bsize digits is enough to hold
Tim Peterse417de02002-08-15 20:10:45 +00003401c(bsize/2) digits + 2 bits, or equivalently (by #1) whether f(bsize/2) digits
3402is enough to hold 2 bits. This is so if bsize >= 2, which holds because
3403bsize >= KARATSUBA_CUTOFF >= 2.
Tim Peters8e966ee2002-08-14 16:36:23 +00003404
Tim Peters48d52c02002-08-14 17:07:32 +00003405Note that since there's always enough room for (ah+al)*(bh+bl), and that's
3406clearly >= each of ah*bh and al*bl, there's always enough room to subtract
3407ah*bh and al*bl too.
Tim Petersd6974a52002-08-13 20:37:51 +00003408*/
3409
Tim Peters60004642002-08-12 22:01:34 +00003410/* b has at least twice the digits of a, and a is big enough that Karatsuba
3411 * would pay off *if* the inputs had balanced sizes. View b as a sequence
3412 * of slices, each with a->ob_size digits, and multiply the slices by a,
3413 * one at a time. This gives k_mul balanced inputs to work with, and is
3414 * also cache-friendly (we compute one double-width slice of the result
Ezio Melotti42da6632011-03-15 05:18:48 +02003415 * at a time, then move on, never backtracking except for the helpful
Tim Peters60004642002-08-12 22:01:34 +00003416 * single-width slice overlap between successive partial sums).
3417 */
3418static PyLongObject *
3419k_lopsided_mul(PyLongObject *a, PyLongObject *b)
3420{
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003421 const Py_ssize_t asize = Py_ABS(Py_SIZE(a));
3422 Py_ssize_t bsize = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003423 Py_ssize_t nbdone; /* # of b digits already multiplied */
3424 PyLongObject *ret;
3425 PyLongObject *bslice = NULL;
Tim Peters60004642002-08-12 22:01:34 +00003426
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003427 assert(asize > KARATSUBA_CUTOFF);
3428 assert(2 * asize <= bsize);
Tim Peters60004642002-08-12 22:01:34 +00003429
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003430 /* Allocate result space, and zero it out. */
3431 ret = _PyLong_New(asize + bsize);
3432 if (ret == NULL)
3433 return NULL;
3434 memset(ret->ob_digit, 0, Py_SIZE(ret) * sizeof(digit));
Tim Peters60004642002-08-12 22:01:34 +00003435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003436 /* Successive slices of b are copied into bslice. */
3437 bslice = _PyLong_New(asize);
3438 if (bslice == NULL)
3439 goto fail;
Tim Peters60004642002-08-12 22:01:34 +00003440
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003441 nbdone = 0;
3442 while (bsize > 0) {
3443 PyLongObject *product;
Victor Stinner640c35c2013-06-04 23:14:37 +02003444 const Py_ssize_t nbtouse = Py_MIN(bsize, asize);
Tim Peters60004642002-08-12 22:01:34 +00003445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003446 /* Multiply the next slice of b by a. */
3447 memcpy(bslice->ob_digit, b->ob_digit + nbdone,
3448 nbtouse * sizeof(digit));
3449 Py_SIZE(bslice) = nbtouse;
3450 product = k_mul(a, bslice);
3451 if (product == NULL)
3452 goto fail;
Tim Peters60004642002-08-12 22:01:34 +00003453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003454 /* Add into result. */
3455 (void)v_iadd(ret->ob_digit + nbdone, Py_SIZE(ret) - nbdone,
3456 product->ob_digit, Py_SIZE(product));
3457 Py_DECREF(product);
Tim Peters60004642002-08-12 22:01:34 +00003458
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003459 bsize -= nbtouse;
3460 nbdone += nbtouse;
3461 }
Tim Peters60004642002-08-12 22:01:34 +00003462
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003463 Py_DECREF(bslice);
3464 return long_normalize(ret);
Tim Peters60004642002-08-12 22:01:34 +00003465
Mark Dickinson22b20182010-05-10 21:27:53 +00003466 fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003467 Py_DECREF(ret);
3468 Py_XDECREF(bslice);
3469 return NULL;
Tim Peters60004642002-08-12 22:01:34 +00003470}
Tim Peters5af4e6c2002-08-12 02:31:19 +00003471
3472static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003473long_mul(PyLongObject *a, PyLongObject *b)
Tim Peters5af4e6c2002-08-12 02:31:19 +00003474{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003475 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003476
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003477 CHECK_BINOP(a, b);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003478
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003479 /* fast path for single-digit multiplication */
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003480 if (Py_ABS(Py_SIZE(a)) <= 1 && Py_ABS(Py_SIZE(b)) <= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003481 stwodigits v = (stwodigits)(MEDIUM_VALUE(a)) * MEDIUM_VALUE(b);
Mark Dickinsonbd792642009-03-18 20:06:12 +00003482#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003483 return PyLong_FromLongLong((PY_LONG_LONG)v);
Mark Dickinsonbd792642009-03-18 20:06:12 +00003484#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003485 /* if we don't have long long then we're almost certainly
3486 using 15-bit digits, so v will fit in a long. In the
3487 unlikely event that we're using 30-bit digits on a platform
3488 without long long, a large v will just cause us to fall
3489 through to the general multiplication code below. */
3490 if (v >= LONG_MIN && v <= LONG_MAX)
3491 return PyLong_FromLong((long)v);
Mark Dickinsonbd792642009-03-18 20:06:12 +00003492#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003493 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00003494
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003495 z = k_mul(a, b);
3496 /* Negate if exactly one of the inputs is negative. */
Victor Stinner8aed6f12013-07-17 22:31:17 +02003497 if (((Py_SIZE(a) ^ Py_SIZE(b)) < 0) && z) {
3498 _PyLong_Negate(&z);
3499 if (z == NULL)
3500 return NULL;
3501 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003502 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003503}
3504
Yury Selivanove0b23092016-02-11 10:26:27 -05003505/* Fast modulo division for single-digit longs. */
3506static PyObject *
3507fast_mod(PyLongObject *a, PyLongObject *b)
3508{
3509 sdigit left = a->ob_digit[0];
3510 sdigit right = b->ob_digit[0];
3511 sdigit mod;
3512
3513 assert(Py_ABS(Py_SIZE(a)) == 1);
3514 assert(Py_ABS(Py_SIZE(b)) == 1);
3515
3516 if (Py_SIZE(a) == Py_SIZE(b)) {
3517 /* 'a' and 'b' have the same sign. */
3518 mod = left % right;
3519 }
3520 else {
3521 /* Either 'a' or 'b' is negative. */
3522 mod = right - 1 - (left - 1) % right;
3523 }
3524
3525 return PyLong_FromLong(mod * Py_SIZE(b));
3526}
3527
3528/* Fast floor division for single-digit longs. */
3529static PyObject *
3530fast_floor_div(PyLongObject *a, PyLongObject *b)
3531{
3532 sdigit left = a->ob_digit[0];
3533 sdigit right = b->ob_digit[0];
3534 sdigit div;
3535
3536 assert(Py_ABS(Py_SIZE(a)) == 1);
3537 assert(Py_ABS(Py_SIZE(b)) == 1);
3538
3539 if (Py_SIZE(a) == Py_SIZE(b)) {
3540 /* 'a' and 'b' have the same sign. */
3541 div = left / right;
3542 }
3543 else {
3544 /* Either 'a' or 'b' is negative. */
3545 div = -1 - (left - 1) / right;
3546 }
3547
3548 return PyLong_FromLong(div);
3549}
3550
Guido van Rossume32e0141992-01-19 16:31:05 +00003551/* The / and % operators are now defined in terms of divmod().
3552 The expression a mod b has the value a - b*floor(a/b).
3553 The long_divrem function gives the remainder after division of
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003554 |a| by |b|, with the sign of a. This is also expressed
3555 as a - b*trunc(a/b), if trunc truncates towards zero.
3556 Some examples:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003557 a b a rem b a mod b
3558 13 10 3 3
3559 -13 10 -3 7
3560 13 -10 3 -7
3561 -13 -10 -3 -3
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003562 So, to get from rem to mod, we have to add b if a and b
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003563 have different signs. We then subtract one from the 'div'
3564 part of the outcome to keep the invariant intact. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003565
Tim Peters47e52ee2004-08-30 02:44:38 +00003566/* Compute
3567 * *pdiv, *pmod = divmod(v, w)
3568 * NULL can be passed for pdiv or pmod, in which case that part of
3569 * the result is simply thrown away. The caller owns a reference to
3570 * each of these it requests (does not pass NULL for).
3571 */
Guido van Rossume32e0141992-01-19 16:31:05 +00003572static int
Tim Peters5af4e6c2002-08-12 02:31:19 +00003573l_divmod(PyLongObject *v, PyLongObject *w,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003574 PyLongObject **pdiv, PyLongObject **pmod)
Guido van Rossume32e0141992-01-19 16:31:05 +00003575{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003576 PyLongObject *div, *mod;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003577
Yury Selivanove0b23092016-02-11 10:26:27 -05003578 if (Py_ABS(Py_SIZE(v)) == 1 && Py_ABS(Py_SIZE(w)) == 1) {
3579 /* Fast path for single-digit longs */
3580 div = NULL;
3581 if (pdiv != NULL) {
3582 div = (PyLongObject *)fast_floor_div(v, w);
3583 if (div == NULL) {
3584 return -1;
3585 }
3586 }
3587 if (pmod != NULL) {
3588 mod = (PyLongObject *)fast_mod(v, w);
3589 if (mod == NULL) {
3590 Py_XDECREF(div);
3591 return -1;
3592 }
3593 *pmod = mod;
3594 }
3595 if (pdiv != NULL) {
3596 /* We only want to set `*pdiv` when `*pmod` is
3597 set successfully. */
3598 *pdiv = div;
3599 }
3600 return 0;
3601 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003602 if (long_divrem(v, w, &div, &mod) < 0)
3603 return -1;
3604 if ((Py_SIZE(mod) < 0 && Py_SIZE(w) > 0) ||
3605 (Py_SIZE(mod) > 0 && Py_SIZE(w) < 0)) {
3606 PyLongObject *temp;
3607 PyLongObject *one;
3608 temp = (PyLongObject *) long_add(mod, w);
3609 Py_DECREF(mod);
3610 mod = temp;
3611 if (mod == NULL) {
3612 Py_DECREF(div);
3613 return -1;
3614 }
3615 one = (PyLongObject *) PyLong_FromLong(1L);
3616 if (one == NULL ||
3617 (temp = (PyLongObject *) long_sub(div, one)) == NULL) {
3618 Py_DECREF(mod);
3619 Py_DECREF(div);
3620 Py_XDECREF(one);
3621 return -1;
3622 }
3623 Py_DECREF(one);
3624 Py_DECREF(div);
3625 div = temp;
3626 }
3627 if (pdiv != NULL)
3628 *pdiv = div;
3629 else
3630 Py_DECREF(div);
Tim Peters47e52ee2004-08-30 02:44:38 +00003631
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003632 if (pmod != NULL)
3633 *pmod = mod;
3634 else
3635 Py_DECREF(mod);
Tim Peters47e52ee2004-08-30 02:44:38 +00003636
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003637 return 0;
Guido van Rossume32e0141992-01-19 16:31:05 +00003638}
3639
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003640static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003641long_div(PyObject *a, PyObject *b)
Guido van Rossume32e0141992-01-19 16:31:05 +00003642{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003643 PyLongObject *div;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003645 CHECK_BINOP(a, b);
Yury Selivanove0b23092016-02-11 10:26:27 -05003646
3647 if (Py_ABS(Py_SIZE(a)) == 1 && Py_ABS(Py_SIZE(b)) == 1) {
3648 return fast_floor_div((PyLongObject*)a, (PyLongObject*)b);
3649 }
3650
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003651 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, &div, NULL) < 0)
3652 div = NULL;
3653 return (PyObject *)div;
Guido van Rossume32e0141992-01-19 16:31:05 +00003654}
3655
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003656/* PyLong/PyLong -> float, with correctly rounded result. */
3657
3658#define MANT_DIG_DIGITS (DBL_MANT_DIG / PyLong_SHIFT)
3659#define MANT_DIG_BITS (DBL_MANT_DIG % PyLong_SHIFT)
3660
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003661static PyObject *
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003662long_true_divide(PyObject *v, PyObject *w)
Tim Peters20dab9f2001-09-04 05:31:47 +00003663{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003664 PyLongObject *a, *b, *x;
3665 Py_ssize_t a_size, b_size, shift, extra_bits, diff, x_size, x_bits;
3666 digit mask, low;
3667 int inexact, negate, a_is_small, b_is_small;
3668 double dx, result;
Tim Peterse2a60002001-09-04 06:17:36 +00003669
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003670 CHECK_BINOP(v, w);
3671 a = (PyLongObject *)v;
3672 b = (PyLongObject *)w;
Tim Peterse2a60002001-09-04 06:17:36 +00003673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003674 /*
3675 Method in a nutshell:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003677 0. reduce to case a, b > 0; filter out obvious underflow/overflow
3678 1. choose a suitable integer 'shift'
3679 2. use integer arithmetic to compute x = floor(2**-shift*a/b)
3680 3. adjust x for correct rounding
3681 4. convert x to a double dx with the same value
3682 5. return ldexp(dx, shift).
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003683
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003684 In more detail:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003685
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003686 0. For any a, a/0 raises ZeroDivisionError; for nonzero b, 0/b
3687 returns either 0.0 or -0.0, depending on the sign of b. For a and
3688 b both nonzero, ignore signs of a and b, and add the sign back in
3689 at the end. Now write a_bits and b_bits for the bit lengths of a
3690 and b respectively (that is, a_bits = 1 + floor(log_2(a)); likewise
3691 for b). Then
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003693 2**(a_bits - b_bits - 1) < a/b < 2**(a_bits - b_bits + 1).
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003694
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003695 So if a_bits - b_bits > DBL_MAX_EXP then a/b > 2**DBL_MAX_EXP and
3696 so overflows. Similarly, if a_bits - b_bits < DBL_MIN_EXP -
3697 DBL_MANT_DIG - 1 then a/b underflows to 0. With these cases out of
3698 the way, we can assume that
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003699
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003700 DBL_MIN_EXP - DBL_MANT_DIG - 1 <= a_bits - b_bits <= DBL_MAX_EXP.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003701
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003702 1. The integer 'shift' is chosen so that x has the right number of
3703 bits for a double, plus two or three extra bits that will be used
3704 in the rounding decisions. Writing a_bits and b_bits for the
3705 number of significant bits in a and b respectively, a
3706 straightforward formula for shift is:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003707
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003708 shift = a_bits - b_bits - DBL_MANT_DIG - 2
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003709
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003710 This is fine in the usual case, but if a/b is smaller than the
3711 smallest normal float then it can lead to double rounding on an
3712 IEEE 754 platform, giving incorrectly rounded results. So we
3713 adjust the formula slightly. The actual formula used is:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003714
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003715 shift = MAX(a_bits - b_bits, DBL_MIN_EXP) - DBL_MANT_DIG - 2
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003716
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003717 2. The quantity x is computed by first shifting a (left -shift bits
3718 if shift <= 0, right shift bits if shift > 0) and then dividing by
3719 b. For both the shift and the division, we keep track of whether
3720 the result is inexact, in a flag 'inexact'; this information is
3721 needed at the rounding stage.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003722
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003723 With the choice of shift above, together with our assumption that
3724 a_bits - b_bits >= DBL_MIN_EXP - DBL_MANT_DIG - 1, it follows
3725 that x >= 1.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003726
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003727 3. Now x * 2**shift <= a/b < (x+1) * 2**shift. We want to replace
3728 this with an exactly representable float of the form
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003729
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003730 round(x/2**extra_bits) * 2**(extra_bits+shift).
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003731
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003732 For float representability, we need x/2**extra_bits <
3733 2**DBL_MANT_DIG and extra_bits + shift >= DBL_MIN_EXP -
3734 DBL_MANT_DIG. This translates to the condition:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003736 extra_bits >= MAX(x_bits, DBL_MIN_EXP - shift) - DBL_MANT_DIG
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003737
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003738 To round, we just modify the bottom digit of x in-place; this can
3739 end up giving a digit with value > PyLONG_MASK, but that's not a
3740 problem since digits can hold values up to 2*PyLONG_MASK+1.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003741
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003742 With the original choices for shift above, extra_bits will always
3743 be 2 or 3. Then rounding under the round-half-to-even rule, we
3744 round up iff the most significant of the extra bits is 1, and
3745 either: (a) the computation of x in step 2 had an inexact result,
3746 or (b) at least one other of the extra bits is 1, or (c) the least
3747 significant bit of x (above those to be rounded) is 1.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003748
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003749 4. Conversion to a double is straightforward; all floating-point
3750 operations involved in the conversion are exact, so there's no
3751 danger of rounding errors.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003752
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003753 5. Use ldexp(x, shift) to compute x*2**shift, the final result.
3754 The result will always be exactly representable as a double, except
3755 in the case that it overflows. To avoid dependence on the exact
3756 behaviour of ldexp on overflow, we check for overflow before
3757 applying ldexp. The result of ldexp is adjusted for sign before
3758 returning.
3759 */
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003760
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003761 /* Reduce to case where a and b are both positive. */
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003762 a_size = Py_ABS(Py_SIZE(a));
3763 b_size = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003764 negate = (Py_SIZE(a) < 0) ^ (Py_SIZE(b) < 0);
3765 if (b_size == 0) {
3766 PyErr_SetString(PyExc_ZeroDivisionError,
3767 "division by zero");
3768 goto error;
3769 }
3770 if (a_size == 0)
3771 goto underflow_or_zero;
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003772
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003773 /* Fast path for a and b small (exactly representable in a double).
3774 Relies on floating-point division being correctly rounded; results
3775 may be subject to double rounding on x86 machines that operate with
3776 the x87 FPU set to 64-bit precision. */
3777 a_is_small = a_size <= MANT_DIG_DIGITS ||
3778 (a_size == MANT_DIG_DIGITS+1 &&
3779 a->ob_digit[MANT_DIG_DIGITS] >> MANT_DIG_BITS == 0);
3780 b_is_small = b_size <= MANT_DIG_DIGITS ||
3781 (b_size == MANT_DIG_DIGITS+1 &&
3782 b->ob_digit[MANT_DIG_DIGITS] >> MANT_DIG_BITS == 0);
3783 if (a_is_small && b_is_small) {
3784 double da, db;
3785 da = a->ob_digit[--a_size];
3786 while (a_size > 0)
3787 da = da * PyLong_BASE + a->ob_digit[--a_size];
3788 db = b->ob_digit[--b_size];
3789 while (b_size > 0)
3790 db = db * PyLong_BASE + b->ob_digit[--b_size];
3791 result = da / db;
3792 goto success;
3793 }
Tim Peterse2a60002001-09-04 06:17:36 +00003794
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003795 /* Catch obvious cases of underflow and overflow */
3796 diff = a_size - b_size;
3797 if (diff > PY_SSIZE_T_MAX/PyLong_SHIFT - 1)
3798 /* Extreme overflow */
3799 goto overflow;
3800 else if (diff < 1 - PY_SSIZE_T_MAX/PyLong_SHIFT)
3801 /* Extreme underflow */
3802 goto underflow_or_zero;
3803 /* Next line is now safe from overflowing a Py_ssize_t */
3804 diff = diff * PyLong_SHIFT + bits_in_digit(a->ob_digit[a_size - 1]) -
3805 bits_in_digit(b->ob_digit[b_size - 1]);
3806 /* Now diff = a_bits - b_bits. */
3807 if (diff > DBL_MAX_EXP)
3808 goto overflow;
3809 else if (diff < DBL_MIN_EXP - DBL_MANT_DIG - 1)
3810 goto underflow_or_zero;
Tim Peterse2a60002001-09-04 06:17:36 +00003811
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003812 /* Choose value for shift; see comments for step 1 above. */
Victor Stinner640c35c2013-06-04 23:14:37 +02003813 shift = Py_MAX(diff, DBL_MIN_EXP) - DBL_MANT_DIG - 2;
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003814
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003815 inexact = 0;
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003816
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003817 /* x = abs(a * 2**-shift) */
3818 if (shift <= 0) {
3819 Py_ssize_t i, shift_digits = -shift / PyLong_SHIFT;
3820 digit rem;
3821 /* x = a << -shift */
3822 if (a_size >= PY_SSIZE_T_MAX - 1 - shift_digits) {
3823 /* In practice, it's probably impossible to end up
3824 here. Both a and b would have to be enormous,
3825 using close to SIZE_T_MAX bytes of memory each. */
3826 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson22b20182010-05-10 21:27:53 +00003827 "intermediate overflow during division");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003828 goto error;
3829 }
3830 x = _PyLong_New(a_size + shift_digits + 1);
3831 if (x == NULL)
3832 goto error;
3833 for (i = 0; i < shift_digits; i++)
3834 x->ob_digit[i] = 0;
3835 rem = v_lshift(x->ob_digit + shift_digits, a->ob_digit,
3836 a_size, -shift % PyLong_SHIFT);
3837 x->ob_digit[a_size + shift_digits] = rem;
3838 }
3839 else {
3840 Py_ssize_t shift_digits = shift / PyLong_SHIFT;
3841 digit rem;
3842 /* x = a >> shift */
3843 assert(a_size >= shift_digits);
3844 x = _PyLong_New(a_size - shift_digits);
3845 if (x == NULL)
3846 goto error;
3847 rem = v_rshift(x->ob_digit, a->ob_digit + shift_digits,
3848 a_size - shift_digits, shift % PyLong_SHIFT);
3849 /* set inexact if any of the bits shifted out is nonzero */
3850 if (rem)
3851 inexact = 1;
3852 while (!inexact && shift_digits > 0)
3853 if (a->ob_digit[--shift_digits])
3854 inexact = 1;
3855 }
3856 long_normalize(x);
3857 x_size = Py_SIZE(x);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003858
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003859 /* x //= b. If the remainder is nonzero, set inexact. We own the only
3860 reference to x, so it's safe to modify it in-place. */
3861 if (b_size == 1) {
3862 digit rem = inplace_divrem1(x->ob_digit, x->ob_digit, x_size,
3863 b->ob_digit[0]);
3864 long_normalize(x);
3865 if (rem)
3866 inexact = 1;
3867 }
3868 else {
3869 PyLongObject *div, *rem;
3870 div = x_divrem(x, b, &rem);
3871 Py_DECREF(x);
3872 x = div;
3873 if (x == NULL)
3874 goto error;
3875 if (Py_SIZE(rem))
3876 inexact = 1;
3877 Py_DECREF(rem);
3878 }
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003879 x_size = Py_ABS(Py_SIZE(x));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003880 assert(x_size > 0); /* result of division is never zero */
3881 x_bits = (x_size-1)*PyLong_SHIFT+bits_in_digit(x->ob_digit[x_size-1]);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003882
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003883 /* The number of extra bits that have to be rounded away. */
Victor Stinner640c35c2013-06-04 23:14:37 +02003884 extra_bits = Py_MAX(x_bits, DBL_MIN_EXP - shift) - DBL_MANT_DIG;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003885 assert(extra_bits == 2 || extra_bits == 3);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003886
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003887 /* Round by directly modifying the low digit of x. */
3888 mask = (digit)1 << (extra_bits - 1);
3889 low = x->ob_digit[0] | inexact;
3890 if (low & mask && low & (3*mask-1))
3891 low += mask;
3892 x->ob_digit[0] = low & ~(mask-1U);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003893
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003894 /* Convert x to a double dx; the conversion is exact. */
3895 dx = x->ob_digit[--x_size];
3896 while (x_size > 0)
3897 dx = dx * PyLong_BASE + x->ob_digit[--x_size];
3898 Py_DECREF(x);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003899
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003900 /* Check whether ldexp result will overflow a double. */
3901 if (shift + x_bits >= DBL_MAX_EXP &&
3902 (shift + x_bits > DBL_MAX_EXP || dx == ldexp(1.0, (int)x_bits)))
3903 goto overflow;
3904 result = ldexp(dx, (int)shift);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003905
3906 success:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003907 return PyFloat_FromDouble(negate ? -result : result);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003908
3909 underflow_or_zero:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003910 return PyFloat_FromDouble(negate ? -0.0 : 0.0);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003911
3912 overflow:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003913 PyErr_SetString(PyExc_OverflowError,
3914 "integer division result too large for a float");
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003915 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003916 return NULL;
Tim Peters20dab9f2001-09-04 05:31:47 +00003917}
3918
3919static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003920long_mod(PyObject *a, PyObject *b)
Guido van Rossume32e0141992-01-19 16:31:05 +00003921{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003922 PyLongObject *mod;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003923
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003924 CHECK_BINOP(a, b);
3925
Yury Selivanove0b23092016-02-11 10:26:27 -05003926 if (Py_ABS(Py_SIZE(a)) == 1 && Py_ABS(Py_SIZE(b)) == 1) {
3927 return fast_mod((PyLongObject*)a, (PyLongObject*)b);
3928 }
3929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003930 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, NULL, &mod) < 0)
3931 mod = NULL;
3932 return (PyObject *)mod;
Guido van Rossume32e0141992-01-19 16:31:05 +00003933}
3934
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003935static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003936long_divmod(PyObject *a, PyObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003937{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003938 PyLongObject *div, *mod;
3939 PyObject *z;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003940
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003941 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003942
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003943 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, &div, &mod) < 0) {
3944 return NULL;
3945 }
3946 z = PyTuple_New(2);
3947 if (z != NULL) {
3948 PyTuple_SetItem(z, 0, (PyObject *) div);
3949 PyTuple_SetItem(z, 1, (PyObject *) mod);
3950 }
3951 else {
3952 Py_DECREF(div);
3953 Py_DECREF(mod);
3954 }
3955 return z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003956}
3957
Tim Peters47e52ee2004-08-30 02:44:38 +00003958/* pow(v, w, x) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003959static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003960long_pow(PyObject *v, PyObject *w, PyObject *x)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003961{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003962 PyLongObject *a, *b, *c; /* a,b,c = v,w,x */
3963 int negativeOutput = 0; /* if x<0 return negative output */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003964
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003965 PyLongObject *z = NULL; /* accumulated result */
3966 Py_ssize_t i, j, k; /* counters */
3967 PyLongObject *temp = NULL;
Tim Peters47e52ee2004-08-30 02:44:38 +00003968
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003969 /* 5-ary values. If the exponent is large enough, table is
3970 * precomputed so that table[i] == a**i % c for i in range(32).
3971 */
3972 PyLongObject *table[32] = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
3973 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0};
Tim Peters47e52ee2004-08-30 02:44:38 +00003974
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003975 /* a, b, c = v, w, x */
3976 CHECK_BINOP(v, w);
3977 a = (PyLongObject*)v; Py_INCREF(a);
3978 b = (PyLongObject*)w; Py_INCREF(b);
3979 if (PyLong_Check(x)) {
3980 c = (PyLongObject *)x;
3981 Py_INCREF(x);
3982 }
3983 else if (x == Py_None)
3984 c = NULL;
3985 else {
3986 Py_DECREF(a);
3987 Py_DECREF(b);
Brian Curtindfc80e32011-08-10 20:28:54 -05003988 Py_RETURN_NOTIMPLEMENTED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003989 }
Tim Peters4c483c42001-09-05 06:24:58 +00003990
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003991 if (Py_SIZE(b) < 0) { /* if exponent is negative */
3992 if (c) {
Mark Dickinson0c346d82014-04-11 14:34:40 -04003993 PyErr_SetString(PyExc_ValueError, "pow() 2nd argument "
Mark Dickinson22b20182010-05-10 21:27:53 +00003994 "cannot be negative when 3rd argument specified");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003995 goto Error;
3996 }
3997 else {
3998 /* else return a float. This works because we know
3999 that this calls float_pow() which converts its
4000 arguments to double. */
4001 Py_DECREF(a);
4002 Py_DECREF(b);
4003 return PyFloat_Type.tp_as_number->nb_power(v, w, x);
4004 }
4005 }
Tim Peters47e52ee2004-08-30 02:44:38 +00004006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004007 if (c) {
4008 /* if modulus == 0:
4009 raise ValueError() */
4010 if (Py_SIZE(c) == 0) {
4011 PyErr_SetString(PyExc_ValueError,
4012 "pow() 3rd argument cannot be 0");
4013 goto Error;
4014 }
Tim Peters47e52ee2004-08-30 02:44:38 +00004015
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004016 /* if modulus < 0:
4017 negativeOutput = True
4018 modulus = -modulus */
4019 if (Py_SIZE(c) < 0) {
4020 negativeOutput = 1;
4021 temp = (PyLongObject *)_PyLong_Copy(c);
4022 if (temp == NULL)
4023 goto Error;
4024 Py_DECREF(c);
4025 c = temp;
4026 temp = NULL;
Victor Stinner8aed6f12013-07-17 22:31:17 +02004027 _PyLong_Negate(&c);
4028 if (c == NULL)
4029 goto Error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004030 }
Tim Peters47e52ee2004-08-30 02:44:38 +00004031
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004032 /* if modulus == 1:
4033 return 0 */
4034 if ((Py_SIZE(c) == 1) && (c->ob_digit[0] == 1)) {
4035 z = (PyLongObject *)PyLong_FromLong(0L);
4036 goto Done;
4037 }
Tim Peters47e52ee2004-08-30 02:44:38 +00004038
Tim Peters81a93152013-10-05 16:53:52 -05004039 /* Reduce base by modulus in some cases:
4040 1. If base < 0. Forcing the base non-negative makes things easier.
4041 2. If base is obviously larger than the modulus. The "small
4042 exponent" case later can multiply directly by base repeatedly,
4043 while the "large exponent" case multiplies directly by base 31
4044 times. It can be unboundedly faster to multiply by
4045 base % modulus instead.
4046 We could _always_ do this reduction, but l_divmod() isn't cheap,
4047 so we only do it when it buys something. */
4048 if (Py_SIZE(a) < 0 || Py_SIZE(a) > Py_SIZE(c)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004049 if (l_divmod(a, c, NULL, &temp) < 0)
4050 goto Error;
4051 Py_DECREF(a);
4052 a = temp;
4053 temp = NULL;
4054 }
4055 }
Tim Peters47e52ee2004-08-30 02:44:38 +00004056
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004057 /* At this point a, b, and c are guaranteed non-negative UNLESS
4058 c is NULL, in which case a may be negative. */
Tim Peters47e52ee2004-08-30 02:44:38 +00004059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004060 z = (PyLongObject *)PyLong_FromLong(1L);
4061 if (z == NULL)
4062 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00004063
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004064 /* Perform a modular reduction, X = X % c, but leave X alone if c
4065 * is NULL.
4066 */
4067#define REDUCE(X) \
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00004068 do { \
4069 if (c != NULL) { \
4070 if (l_divmod(X, c, NULL, &temp) < 0) \
4071 goto Error; \
4072 Py_XDECREF(X); \
4073 X = temp; \
4074 temp = NULL; \
4075 } \
4076 } while(0)
Tim Peters47e52ee2004-08-30 02:44:38 +00004077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004078 /* Multiply two values, then reduce the result:
4079 result = X*Y % c. If c is NULL, skip the mod. */
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00004080#define MULT(X, Y, result) \
4081 do { \
4082 temp = (PyLongObject *)long_mul(X, Y); \
4083 if (temp == NULL) \
4084 goto Error; \
4085 Py_XDECREF(result); \
4086 result = temp; \
4087 temp = NULL; \
4088 REDUCE(result); \
4089 } while(0)
Tim Peters47e52ee2004-08-30 02:44:38 +00004090
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004091 if (Py_SIZE(b) <= FIVEARY_CUTOFF) {
4092 /* Left-to-right binary exponentiation (HAC Algorithm 14.79) */
4093 /* http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf */
4094 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
4095 digit bi = b->ob_digit[i];
Tim Peters47e52ee2004-08-30 02:44:38 +00004096
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004097 for (j = (digit)1 << (PyLong_SHIFT-1); j != 0; j >>= 1) {
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00004098 MULT(z, z, z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004099 if (bi & j)
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00004100 MULT(z, a, z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004101 }
4102 }
4103 }
4104 else {
4105 /* Left-to-right 5-ary exponentiation (HAC Algorithm 14.82) */
4106 Py_INCREF(z); /* still holds 1L */
4107 table[0] = z;
4108 for (i = 1; i < 32; ++i)
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00004109 MULT(table[i-1], a, table[i]);
Tim Peters47e52ee2004-08-30 02:44:38 +00004110
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004111 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
4112 const digit bi = b->ob_digit[i];
Tim Peters47e52ee2004-08-30 02:44:38 +00004113
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004114 for (j = PyLong_SHIFT - 5; j >= 0; j -= 5) {
4115 const int index = (bi >> j) & 0x1f;
4116 for (k = 0; k < 5; ++k)
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00004117 MULT(z, z, z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004118 if (index)
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00004119 MULT(z, table[index], z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004120 }
4121 }
4122 }
Tim Peters47e52ee2004-08-30 02:44:38 +00004123
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004124 if (negativeOutput && (Py_SIZE(z) != 0)) {
4125 temp = (PyLongObject *)long_sub(z, c);
4126 if (temp == NULL)
4127 goto Error;
4128 Py_DECREF(z);
4129 z = temp;
4130 temp = NULL;
4131 }
4132 goto Done;
Tim Peters47e52ee2004-08-30 02:44:38 +00004133
Mark Dickinson22b20182010-05-10 21:27:53 +00004134 Error:
Victor Stinner8aed6f12013-07-17 22:31:17 +02004135 Py_CLEAR(z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004136 /* fall through */
Mark Dickinson22b20182010-05-10 21:27:53 +00004137 Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004138 if (Py_SIZE(b) > FIVEARY_CUTOFF) {
4139 for (i = 0; i < 32; ++i)
4140 Py_XDECREF(table[i]);
4141 }
4142 Py_DECREF(a);
4143 Py_DECREF(b);
4144 Py_XDECREF(c);
4145 Py_XDECREF(temp);
4146 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004147}
4148
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004149static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00004150long_invert(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004151{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004152 /* Implement ~x as -(x+1) */
4153 PyLongObject *x;
4154 PyLongObject *w;
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004155 if (Py_ABS(Py_SIZE(v)) <=1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004156 return PyLong_FromLong(-(MEDIUM_VALUE(v)+1));
4157 w = (PyLongObject *)PyLong_FromLong(1L);
4158 if (w == NULL)
4159 return NULL;
4160 x = (PyLongObject *) long_add(v, w);
4161 Py_DECREF(w);
4162 if (x == NULL)
4163 return NULL;
4164 Py_SIZE(x) = -(Py_SIZE(x));
4165 return (PyObject *)maybe_small_long(x);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004166}
4167
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004168static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00004169long_neg(PyLongObject *v)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004170{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004171 PyLongObject *z;
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004172 if (Py_ABS(Py_SIZE(v)) <= 1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004173 return PyLong_FromLong(-MEDIUM_VALUE(v));
4174 z = (PyLongObject *)_PyLong_Copy(v);
4175 if (z != NULL)
4176 Py_SIZE(z) = -(Py_SIZE(v));
4177 return (PyObject *)z;
Guido van Rossumc6913e71991-11-19 20:26:46 +00004178}
4179
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004180static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00004181long_abs(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004182{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004183 if (Py_SIZE(v) < 0)
4184 return long_neg(v);
4185 else
4186 return long_long((PyObject *)v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004187}
4188
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00004189static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00004190long_bool(PyLongObject *v)
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00004191{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004192 return Py_SIZE(v) != 0;
Guido van Rossumc6913e71991-11-19 20:26:46 +00004193}
4194
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004195static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00004196long_rshift(PyLongObject *a, PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004197{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004198 PyLongObject *z = NULL;
4199 Py_ssize_t shiftby, newsize, wordshift, loshift, hishift, i, j;
4200 digit lomask, himask;
Tim Peters5af4e6c2002-08-12 02:31:19 +00004201
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004202 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00004203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004204 if (Py_SIZE(a) < 0) {
4205 /* Right shifting negative numbers is harder */
4206 PyLongObject *a1, *a2;
4207 a1 = (PyLongObject *) long_invert(a);
4208 if (a1 == NULL)
4209 goto rshift_error;
4210 a2 = (PyLongObject *) long_rshift(a1, b);
4211 Py_DECREF(a1);
4212 if (a2 == NULL)
4213 goto rshift_error;
4214 z = (PyLongObject *) long_invert(a2);
4215 Py_DECREF(a2);
4216 }
4217 else {
4218 shiftby = PyLong_AsSsize_t((PyObject *)b);
4219 if (shiftby == -1L && PyErr_Occurred())
4220 goto rshift_error;
4221 if (shiftby < 0) {
4222 PyErr_SetString(PyExc_ValueError,
4223 "negative shift count");
4224 goto rshift_error;
4225 }
4226 wordshift = shiftby / PyLong_SHIFT;
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004227 newsize = Py_ABS(Py_SIZE(a)) - wordshift;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004228 if (newsize <= 0)
4229 return PyLong_FromLong(0);
4230 loshift = shiftby % PyLong_SHIFT;
4231 hishift = PyLong_SHIFT - loshift;
4232 lomask = ((digit)1 << hishift) - 1;
4233 himask = PyLong_MASK ^ lomask;
4234 z = _PyLong_New(newsize);
4235 if (z == NULL)
4236 goto rshift_error;
4237 if (Py_SIZE(a) < 0)
4238 Py_SIZE(z) = -(Py_SIZE(z));
4239 for (i = 0, j = wordshift; i < newsize; i++, j++) {
4240 z->ob_digit[i] = (a->ob_digit[j] >> loshift) & lomask;
4241 if (i+1 < newsize)
Mark Dickinson22b20182010-05-10 21:27:53 +00004242 z->ob_digit[i] |= (a->ob_digit[j+1] << hishift) & himask;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004243 }
4244 z = long_normalize(z);
4245 }
Mark Dickinson22b20182010-05-10 21:27:53 +00004246 rshift_error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004247 return (PyObject *) maybe_small_long(z);
Neil Schemenauerba872e22001-01-04 01:46:03 +00004248
Guido van Rossumc6913e71991-11-19 20:26:46 +00004249}
4250
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004251static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00004252long_lshift(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004253{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004254 /* This version due to Tim Peters */
4255 PyLongObject *a = (PyLongObject*)v;
4256 PyLongObject *b = (PyLongObject*)w;
4257 PyLongObject *z = NULL;
4258 Py_ssize_t shiftby, oldsize, newsize, wordshift, remshift, i, j;
4259 twodigits accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00004260
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004261 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00004262
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004263 shiftby = PyLong_AsSsize_t((PyObject *)b);
4264 if (shiftby == -1L && PyErr_Occurred())
Victor Stinner8aed6f12013-07-17 22:31:17 +02004265 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004266 if (shiftby < 0) {
4267 PyErr_SetString(PyExc_ValueError, "negative shift count");
Victor Stinner8aed6f12013-07-17 22:31:17 +02004268 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004269 }
4270 /* wordshift, remshift = divmod(shiftby, PyLong_SHIFT) */
4271 wordshift = shiftby / PyLong_SHIFT;
4272 remshift = shiftby - wordshift * PyLong_SHIFT;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00004273
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004274 oldsize = Py_ABS(Py_SIZE(a));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004275 newsize = oldsize + wordshift;
4276 if (remshift)
4277 ++newsize;
4278 z = _PyLong_New(newsize);
4279 if (z == NULL)
Victor Stinner8aed6f12013-07-17 22:31:17 +02004280 return NULL;
4281 if (Py_SIZE(a) < 0) {
4282 assert(Py_REFCNT(z) == 1);
4283 Py_SIZE(z) = -Py_SIZE(z);
4284 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004285 for (i = 0; i < wordshift; i++)
4286 z->ob_digit[i] = 0;
4287 accum = 0;
4288 for (i = wordshift, j = 0; j < oldsize; i++, j++) {
4289 accum |= (twodigits)a->ob_digit[j] << remshift;
4290 z->ob_digit[i] = (digit)(accum & PyLong_MASK);
4291 accum >>= PyLong_SHIFT;
4292 }
4293 if (remshift)
4294 z->ob_digit[newsize-1] = (digit)accum;
4295 else
4296 assert(!accum);
4297 z = long_normalize(z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004298 return (PyObject *) maybe_small_long(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00004299}
4300
Mark Dickinson27a87a22009-10-25 20:43:34 +00004301/* Compute two's complement of digit vector a[0:m], writing result to
4302 z[0:m]. The digit vector a need not be normalized, but should not
4303 be entirely zero. a and z may point to the same digit vector. */
4304
4305static void
4306v_complement(digit *z, digit *a, Py_ssize_t m)
4307{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004308 Py_ssize_t i;
4309 digit carry = 1;
4310 for (i = 0; i < m; ++i) {
4311 carry += a[i] ^ PyLong_MASK;
4312 z[i] = carry & PyLong_MASK;
4313 carry >>= PyLong_SHIFT;
4314 }
4315 assert(carry == 0);
Mark Dickinson27a87a22009-10-25 20:43:34 +00004316}
Guido van Rossum4c260ff1992-01-14 18:36:43 +00004317
4318/* Bitwise and/xor/or operations */
4319
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004320static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00004321long_bitwise(PyLongObject *a,
Benjamin Peterson513762f2012-12-26 16:43:33 -06004322 char op, /* '&', '|', '^' */
Mark Dickinson22b20182010-05-10 21:27:53 +00004323 PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004324{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004325 int nega, negb, negz;
4326 Py_ssize_t size_a, size_b, size_z, i;
4327 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00004328
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004329 /* Bitwise operations for negative numbers operate as though
4330 on a two's complement representation. So convert arguments
4331 from sign-magnitude to two's complement, and convert the
4332 result back to sign-magnitude at the end. */
Mark Dickinson27a87a22009-10-25 20:43:34 +00004333
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004334 /* If a is negative, replace it by its two's complement. */
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004335 size_a = Py_ABS(Py_SIZE(a));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004336 nega = Py_SIZE(a) < 0;
4337 if (nega) {
4338 z = _PyLong_New(size_a);
4339 if (z == NULL)
4340 return NULL;
4341 v_complement(z->ob_digit, a->ob_digit, size_a);
4342 a = z;
4343 }
4344 else
4345 /* Keep reference count consistent. */
4346 Py_INCREF(a);
Mark Dickinson27a87a22009-10-25 20:43:34 +00004347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004348 /* Same for b. */
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004349 size_b = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004350 negb = Py_SIZE(b) < 0;
4351 if (negb) {
4352 z = _PyLong_New(size_b);
4353 if (z == NULL) {
4354 Py_DECREF(a);
4355 return NULL;
4356 }
4357 v_complement(z->ob_digit, b->ob_digit, size_b);
4358 b = z;
4359 }
4360 else
4361 Py_INCREF(b);
Tim Peters5af4e6c2002-08-12 02:31:19 +00004362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004363 /* Swap a and b if necessary to ensure size_a >= size_b. */
4364 if (size_a < size_b) {
4365 z = a; a = b; b = z;
4366 size_z = size_a; size_a = size_b; size_b = size_z;
4367 negz = nega; nega = negb; negb = negz;
4368 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00004369
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004370 /* JRH: The original logic here was to allocate the result value (z)
4371 as the longer of the two operands. However, there are some cases
4372 where the result is guaranteed to be shorter than that: AND of two
4373 positives, OR of two negatives: use the shorter number. AND with
4374 mixed signs: use the positive number. OR with mixed signs: use the
4375 negative number.
4376 */
4377 switch (op) {
4378 case '^':
4379 negz = nega ^ negb;
4380 size_z = size_a;
4381 break;
4382 case '&':
4383 negz = nega & negb;
4384 size_z = negb ? size_a : size_b;
4385 break;
4386 case '|':
4387 negz = nega | negb;
4388 size_z = negb ? size_b : size_a;
4389 break;
4390 default:
4391 PyErr_BadArgument();
4392 return NULL;
4393 }
Guido van Rossumbd3a5271998-08-11 15:04:47 +00004394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004395 /* We allow an extra digit if z is negative, to make sure that
4396 the final two's complement of z doesn't overflow. */
4397 z = _PyLong_New(size_z + negz);
4398 if (z == NULL) {
4399 Py_DECREF(a);
4400 Py_DECREF(b);
4401 return NULL;
4402 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00004403
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004404 /* Compute digits for overlap of a and b. */
4405 switch(op) {
4406 case '&':
4407 for (i = 0; i < size_b; ++i)
4408 z->ob_digit[i] = a->ob_digit[i] & b->ob_digit[i];
4409 break;
4410 case '|':
4411 for (i = 0; i < size_b; ++i)
4412 z->ob_digit[i] = a->ob_digit[i] | b->ob_digit[i];
4413 break;
4414 case '^':
4415 for (i = 0; i < size_b; ++i)
4416 z->ob_digit[i] = a->ob_digit[i] ^ b->ob_digit[i];
4417 break;
4418 default:
4419 PyErr_BadArgument();
4420 return NULL;
4421 }
Mark Dickinson27a87a22009-10-25 20:43:34 +00004422
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004423 /* Copy any remaining digits of a, inverting if necessary. */
4424 if (op == '^' && negb)
4425 for (; i < size_z; ++i)
4426 z->ob_digit[i] = a->ob_digit[i] ^ PyLong_MASK;
4427 else if (i < size_z)
4428 memcpy(&z->ob_digit[i], &a->ob_digit[i],
4429 (size_z-i)*sizeof(digit));
Mark Dickinson27a87a22009-10-25 20:43:34 +00004430
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004431 /* Complement result if negative. */
4432 if (negz) {
4433 Py_SIZE(z) = -(Py_SIZE(z));
4434 z->ob_digit[size_z] = PyLong_MASK;
4435 v_complement(z->ob_digit, z->ob_digit, size_z+1);
4436 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00004437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004438 Py_DECREF(a);
4439 Py_DECREF(b);
4440 return (PyObject *)maybe_small_long(long_normalize(z));
Guido van Rossumc6913e71991-11-19 20:26:46 +00004441}
4442
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004443static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00004444long_and(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004445{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004446 PyObject *c;
4447 CHECK_BINOP(a, b);
4448 c = long_bitwise((PyLongObject*)a, '&', (PyLongObject*)b);
4449 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00004450}
4451
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004452static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00004453long_xor(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004454{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004455 PyObject *c;
4456 CHECK_BINOP(a, b);
4457 c = long_bitwise((PyLongObject*)a, '^', (PyLongObject*)b);
4458 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00004459}
4460
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004461static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00004462long_or(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004463{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004464 PyObject *c;
4465 CHECK_BINOP(a, b);
4466 c = long_bitwise((PyLongObject*)a, '|', (PyLongObject*)b);
4467 return c;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00004468}
4469
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004470static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00004471long_long(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004472{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004473 if (PyLong_CheckExact(v))
4474 Py_INCREF(v);
4475 else
4476 v = _PyLong_Copy((PyLongObject *)v);
4477 return v;
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004478}
4479
Serhiy Storchaka48e47aa2015-05-13 00:19:51 +03004480PyObject *
4481_PyLong_GCD(PyObject *aarg, PyObject *barg)
4482{
4483 PyLongObject *a, *b, *c = NULL, *d = NULL, *r;
4484 stwodigits x, y, q, s, t, c_carry, d_carry;
4485 stwodigits A, B, C, D, T;
4486 int nbits, k;
4487 Py_ssize_t size_a, size_b, alloc_a, alloc_b;
4488 digit *a_digit, *b_digit, *c_digit, *d_digit, *a_end, *b_end;
4489
4490 a = (PyLongObject *)aarg;
4491 b = (PyLongObject *)barg;
4492 size_a = Py_SIZE(a);
4493 size_b = Py_SIZE(b);
4494 if (-2 <= size_a && size_a <= 2 && -2 <= size_b && size_b <= 2) {
4495 Py_INCREF(a);
4496 Py_INCREF(b);
4497 goto simple;
4498 }
4499
4500 /* Initial reduction: make sure that 0 <= b <= a. */
4501 a = (PyLongObject *)long_abs(a);
4502 if (a == NULL)
4503 return NULL;
4504 b = (PyLongObject *)long_abs(b);
4505 if (b == NULL) {
4506 Py_DECREF(a);
4507 return NULL;
4508 }
4509 if (long_compare(a, b) < 0) {
4510 r = a;
4511 a = b;
4512 b = r;
4513 }
4514 /* We now own references to a and b */
4515
4516 alloc_a = Py_SIZE(a);
4517 alloc_b = Py_SIZE(b);
4518 /* reduce until a fits into 2 digits */
4519 while ((size_a = Py_SIZE(a)) > 2) {
4520 nbits = bits_in_digit(a->ob_digit[size_a-1]);
4521 /* extract top 2*PyLong_SHIFT bits of a into x, along with
4522 corresponding bits of b into y */
4523 size_b = Py_SIZE(b);
4524 assert(size_b <= size_a);
4525 if (size_b == 0) {
4526 if (size_a < alloc_a) {
4527 r = (PyLongObject *)_PyLong_Copy(a);
4528 Py_DECREF(a);
4529 }
4530 else
4531 r = a;
4532 Py_DECREF(b);
4533 Py_XDECREF(c);
4534 Py_XDECREF(d);
4535 return (PyObject *)r;
4536 }
4537 x = (((twodigits)a->ob_digit[size_a-1] << (2*PyLong_SHIFT-nbits)) |
4538 ((twodigits)a->ob_digit[size_a-2] << (PyLong_SHIFT-nbits)) |
4539 (a->ob_digit[size_a-3] >> nbits));
4540
4541 y = ((size_b >= size_a - 2 ? b->ob_digit[size_a-3] >> nbits : 0) |
4542 (size_b >= size_a - 1 ? (twodigits)b->ob_digit[size_a-2] << (PyLong_SHIFT-nbits) : 0) |
4543 (size_b >= size_a ? (twodigits)b->ob_digit[size_a-1] << (2*PyLong_SHIFT-nbits) : 0));
4544
4545 /* inner loop of Lehmer's algorithm; A, B, C, D never grow
4546 larger than PyLong_MASK during the algorithm. */
4547 A = 1; B = 0; C = 0; D = 1;
4548 for (k=0;; k++) {
4549 if (y-C == 0)
4550 break;
4551 q = (x+(A-1))/(y-C);
4552 s = B+q*D;
4553 t = x-q*y;
4554 if (s > t)
4555 break;
4556 x = y; y = t;
4557 t = A+q*C; A = D; B = C; C = s; D = t;
4558 }
4559
4560 if (k == 0) {
4561 /* no progress; do a Euclidean step */
4562 if (l_divmod(a, b, NULL, &r) < 0)
4563 goto error;
4564 Py_DECREF(a);
4565 a = b;
4566 b = r;
4567 alloc_a = alloc_b;
4568 alloc_b = Py_SIZE(b);
4569 continue;
4570 }
4571
4572 /*
4573 a, b = A*b-B*a, D*a-C*b if k is odd
4574 a, b = A*a-B*b, D*b-C*a if k is even
4575 */
4576 if (k&1) {
4577 T = -A; A = -B; B = T;
4578 T = -C; C = -D; D = T;
4579 }
4580 if (c != NULL)
4581 Py_SIZE(c) = size_a;
4582 else if (Py_REFCNT(a) == 1) {
4583 Py_INCREF(a);
4584 c = a;
4585 }
4586 else {
4587 alloc_a = size_a;
4588 c = _PyLong_New(size_a);
4589 if (c == NULL)
4590 goto error;
4591 }
4592
4593 if (d != NULL)
4594 Py_SIZE(d) = size_a;
4595 else if (Py_REFCNT(b) == 1 && size_a <= alloc_b) {
4596 Py_INCREF(b);
4597 d = b;
4598 Py_SIZE(d) = size_a;
4599 }
4600 else {
4601 alloc_b = size_a;
4602 d = _PyLong_New(size_a);
4603 if (d == NULL)
4604 goto error;
4605 }
4606 a_end = a->ob_digit + size_a;
4607 b_end = b->ob_digit + size_b;
4608
4609 /* compute new a and new b in parallel */
4610 a_digit = a->ob_digit;
4611 b_digit = b->ob_digit;
4612 c_digit = c->ob_digit;
4613 d_digit = d->ob_digit;
4614 c_carry = 0;
4615 d_carry = 0;
4616 while (b_digit < b_end) {
4617 c_carry += (A * *a_digit) - (B * *b_digit);
4618 d_carry += (D * *b_digit++) - (C * *a_digit++);
4619 *c_digit++ = (digit)(c_carry & PyLong_MASK);
4620 *d_digit++ = (digit)(d_carry & PyLong_MASK);
4621 c_carry >>= PyLong_SHIFT;
4622 d_carry >>= PyLong_SHIFT;
4623 }
4624 while (a_digit < a_end) {
4625 c_carry += A * *a_digit;
4626 d_carry -= C * *a_digit++;
4627 *c_digit++ = (digit)(c_carry & PyLong_MASK);
4628 *d_digit++ = (digit)(d_carry & PyLong_MASK);
4629 c_carry >>= PyLong_SHIFT;
4630 d_carry >>= PyLong_SHIFT;
4631 }
4632 assert(c_carry == 0);
4633 assert(d_carry == 0);
4634
4635 Py_INCREF(c);
4636 Py_INCREF(d);
4637 Py_DECREF(a);
4638 Py_DECREF(b);
4639 a = long_normalize(c);
4640 b = long_normalize(d);
4641 }
4642 Py_XDECREF(c);
4643 Py_XDECREF(d);
4644
4645simple:
4646 assert(Py_REFCNT(a) > 0);
4647 assert(Py_REFCNT(b) > 0);
Victor Stinner5783fd22015-09-19 13:39:03 +02004648/* Issue #24999: use two shifts instead of ">> 2*PyLong_SHIFT" to avoid
4649 undefined behaviour when LONG_MAX type is smaller than 60 bits */
4650#if LONG_MAX >> PyLong_SHIFT >> PyLong_SHIFT
Serhiy Storchaka48e47aa2015-05-13 00:19:51 +03004651 /* a fits into a long, so b must too */
4652 x = PyLong_AsLong((PyObject *)a);
4653 y = PyLong_AsLong((PyObject *)b);
Victor Stinner5783fd22015-09-19 13:39:03 +02004654#elif defined(PY_LONG_LONG) && PY_LLONG_MAX >> PyLong_SHIFT >> PyLong_SHIFT
Serhiy Storchaka48e47aa2015-05-13 00:19:51 +03004655 x = PyLong_AsLongLong((PyObject *)a);
4656 y = PyLong_AsLongLong((PyObject *)b);
4657#else
4658# error "_PyLong_GCD"
4659#endif
4660 x = Py_ABS(x);
4661 y = Py_ABS(y);
4662 Py_DECREF(a);
4663 Py_DECREF(b);
4664
4665 /* usual Euclidean algorithm for longs */
4666 while (y != 0) {
4667 t = y;
4668 y = x % y;
4669 x = t;
4670 }
Victor Stinner5783fd22015-09-19 13:39:03 +02004671#if LONG_MAX >> PyLong_SHIFT >> PyLong_SHIFT
Serhiy Storchaka48e47aa2015-05-13 00:19:51 +03004672 return PyLong_FromLong(x);
Victor Stinner5783fd22015-09-19 13:39:03 +02004673#elif defined(PY_LONG_LONG) && PY_LLONG_MAX >> PyLong_SHIFT >> PyLong_SHIFT
Serhiy Storchaka48e47aa2015-05-13 00:19:51 +03004674 return PyLong_FromLongLong(x);
4675#else
4676# error "_PyLong_GCD"
4677#endif
4678
4679error:
4680 Py_DECREF(a);
4681 Py_DECREF(b);
4682 Py_XDECREF(c);
4683 Py_XDECREF(d);
4684 return NULL;
4685}
4686
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004687static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00004688long_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004689{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004690 double result;
4691 result = PyLong_AsDouble(v);
4692 if (result == -1.0 && PyErr_Occurred())
4693 return NULL;
4694 return PyFloat_FromDouble(result);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004695}
4696
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004697static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +00004698long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004699
Tim Peters6d6c1a32001-08-02 04:15:00 +00004700static PyObject *
4701long_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
4702{
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004703 PyObject *obase = NULL, *x = NULL;
Gregory P. Smitha689e522012-12-25 22:38:32 -08004704 Py_ssize_t base;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004705 static char *kwlist[] = {"x", "base", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +00004706
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004707 if (type != &PyLong_Type)
4708 return long_subtype_new(type, args, kwds); /* Wimp out */
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004709 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OO:int", kwlist,
4710 &x, &obase))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004711 return NULL;
Serhiy Storchaka0b386d52012-12-28 09:42:11 +02004712 if (x == NULL) {
4713 if (obase != NULL) {
4714 PyErr_SetString(PyExc_TypeError,
4715 "int() missing string argument");
4716 return NULL;
4717 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004718 return PyLong_FromLong(0L);
Serhiy Storchaka0b386d52012-12-28 09:42:11 +02004719 }
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004720 if (obase == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004721 return PyNumber_Long(x);
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004722
Gregory P. Smitha689e522012-12-25 22:38:32 -08004723 base = PyNumber_AsSsize_t(obase, NULL);
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004724 if (base == -1 && PyErr_Occurred())
4725 return NULL;
Gregory P. Smitha689e522012-12-25 22:38:32 -08004726 if ((base != 0 && base < 2) || base > 36) {
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004727 PyErr_SetString(PyExc_ValueError,
Serhiy Storchaka0b386d52012-12-28 09:42:11 +02004728 "int() base must be >= 2 and <= 36");
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004729 return NULL;
4730 }
4731
4732 if (PyUnicode_Check(x))
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004733 return PyLong_FromUnicodeObject(x, (int)base);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004734 else if (PyByteArray_Check(x) || PyBytes_Check(x)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004735 char *string;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004736 if (PyByteArray_Check(x))
4737 string = PyByteArray_AS_STRING(x);
4738 else
4739 string = PyBytes_AS_STRING(x);
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03004740 return _PyLong_FromBytes(string, Py_SIZE(x), (int)base);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004741 }
4742 else {
4743 PyErr_SetString(PyExc_TypeError,
Mark Dickinson22b20182010-05-10 21:27:53 +00004744 "int() can't convert non-string with explicit base");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004745 return NULL;
4746 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004747}
4748
Serhiy Storchaka95949422013-08-27 19:40:23 +03004749/* Wimpy, slow approach to tp_new calls for subtypes of int:
4750 first create a regular int from whatever arguments we got,
Guido van Rossumbef14172001-08-29 15:47:46 +00004751 then allocate a subtype instance and initialize it from
Serhiy Storchaka95949422013-08-27 19:40:23 +03004752 the regular int. The regular int is then thrown away.
Guido van Rossumbef14172001-08-29 15:47:46 +00004753*/
4754static PyObject *
4755long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
4756{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004757 PyLongObject *tmp, *newobj;
4758 Py_ssize_t i, n;
Guido van Rossumbef14172001-08-29 15:47:46 +00004759
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004760 assert(PyType_IsSubtype(type, &PyLong_Type));
4761 tmp = (PyLongObject *)long_new(&PyLong_Type, args, kwds);
4762 if (tmp == NULL)
4763 return NULL;
Serhiy Storchaka15095802015-11-25 15:47:01 +02004764 assert(PyLong_Check(tmp));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004765 n = Py_SIZE(tmp);
4766 if (n < 0)
4767 n = -n;
4768 newobj = (PyLongObject *)type->tp_alloc(type, n);
4769 if (newobj == NULL) {
4770 Py_DECREF(tmp);
4771 return NULL;
4772 }
4773 assert(PyLong_Check(newobj));
4774 Py_SIZE(newobj) = Py_SIZE(tmp);
4775 for (i = 0; i < n; i++)
4776 newobj->ob_digit[i] = tmp->ob_digit[i];
4777 Py_DECREF(tmp);
4778 return (PyObject *)newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00004779}
4780
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004781static PyObject *
4782long_getnewargs(PyLongObject *v)
4783{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004784 return Py_BuildValue("(N)", _PyLong_Copy(v));
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004785}
4786
Guido van Rossumb43daf72007-08-01 18:08:08 +00004787static PyObject *
Mark Dickinson6bf19002009-05-02 17:57:52 +00004788long_get0(PyLongObject *v, void *context) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004789 return PyLong_FromLong(0L);
Mark Dickinson6bf19002009-05-02 17:57:52 +00004790}
4791
4792static PyObject *
4793long_get1(PyLongObject *v, void *context) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004794 return PyLong_FromLong(1L);
Guido van Rossumb43daf72007-08-01 18:08:08 +00004795}
4796
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004797static PyObject *
Eric Smith8c663262007-08-25 02:26:07 +00004798long__format__(PyObject *self, PyObject *args)
4799{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004800 PyObject *format_spec;
Victor Stinnerd3f08822012-05-29 12:57:52 +02004801 _PyUnicodeWriter writer;
4802 int ret;
Eric Smith4a7d76d2008-05-30 18:10:19 +00004803
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004804 if (!PyArg_ParseTuple(args, "U:__format__", &format_spec))
4805 return NULL;
Victor Stinnerd3f08822012-05-29 12:57:52 +02004806
Victor Stinner8f674cc2013-04-17 23:02:17 +02004807 _PyUnicodeWriter_Init(&writer);
Victor Stinnerd3f08822012-05-29 12:57:52 +02004808 ret = _PyLong_FormatAdvancedWriter(
4809 &writer,
4810 self,
4811 format_spec, 0, PyUnicode_GET_LENGTH(format_spec));
4812 if (ret == -1) {
4813 _PyUnicodeWriter_Dealloc(&writer);
4814 return NULL;
4815 }
4816 return _PyUnicodeWriter_Finish(&writer);
Eric Smith8c663262007-08-25 02:26:07 +00004817}
4818
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004819/* Return a pair (q, r) such that a = b * q + r, and
4820 abs(r) <= abs(b)/2, with equality possible only if q is even.
4821 In other words, q == a / b, rounded to the nearest integer using
4822 round-half-to-even. */
4823
4824PyObject *
Mark Dickinsonfa68a612010-06-07 18:47:09 +00004825_PyLong_DivmodNear(PyObject *a, PyObject *b)
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004826{
4827 PyLongObject *quo = NULL, *rem = NULL;
4828 PyObject *one = NULL, *twice_rem, *result, *temp;
4829 int cmp, quo_is_odd, quo_is_neg;
4830
4831 /* Equivalent Python code:
4832
4833 def divmod_near(a, b):
4834 q, r = divmod(a, b)
4835 # round up if either r / b > 0.5, or r / b == 0.5 and q is odd.
4836 # The expression r / b > 0.5 is equivalent to 2 * r > b if b is
4837 # positive, 2 * r < b if b negative.
4838 greater_than_half = 2*r > b if b > 0 else 2*r < b
4839 exactly_half = 2*r == b
4840 if greater_than_half or exactly_half and q % 2 == 1:
4841 q += 1
4842 r -= b
4843 return q, r
4844
4845 */
4846 if (!PyLong_Check(a) || !PyLong_Check(b)) {
4847 PyErr_SetString(PyExc_TypeError,
4848 "non-integer arguments in division");
4849 return NULL;
4850 }
4851
4852 /* Do a and b have different signs? If so, quotient is negative. */
4853 quo_is_neg = (Py_SIZE(a) < 0) != (Py_SIZE(b) < 0);
4854
4855 one = PyLong_FromLong(1L);
4856 if (one == NULL)
4857 return NULL;
4858
4859 if (long_divrem((PyLongObject*)a, (PyLongObject*)b, &quo, &rem) < 0)
4860 goto error;
4861
4862 /* compare twice the remainder with the divisor, to see
4863 if we need to adjust the quotient and remainder */
4864 twice_rem = long_lshift((PyObject *)rem, one);
4865 if (twice_rem == NULL)
4866 goto error;
4867 if (quo_is_neg) {
4868 temp = long_neg((PyLongObject*)twice_rem);
4869 Py_DECREF(twice_rem);
4870 twice_rem = temp;
4871 if (twice_rem == NULL)
4872 goto error;
4873 }
4874 cmp = long_compare((PyLongObject *)twice_rem, (PyLongObject *)b);
4875 Py_DECREF(twice_rem);
4876
4877 quo_is_odd = Py_SIZE(quo) != 0 && ((quo->ob_digit[0] & 1) != 0);
4878 if ((Py_SIZE(b) < 0 ? cmp < 0 : cmp > 0) || (cmp == 0 && quo_is_odd)) {
4879 /* fix up quotient */
4880 if (quo_is_neg)
4881 temp = long_sub(quo, (PyLongObject *)one);
4882 else
4883 temp = long_add(quo, (PyLongObject *)one);
4884 Py_DECREF(quo);
4885 quo = (PyLongObject *)temp;
4886 if (quo == NULL)
4887 goto error;
4888 /* and remainder */
4889 if (quo_is_neg)
4890 temp = long_add(rem, (PyLongObject *)b);
4891 else
4892 temp = long_sub(rem, (PyLongObject *)b);
4893 Py_DECREF(rem);
4894 rem = (PyLongObject *)temp;
4895 if (rem == NULL)
4896 goto error;
4897 }
4898
4899 result = PyTuple_New(2);
4900 if (result == NULL)
4901 goto error;
4902
4903 /* PyTuple_SET_ITEM steals references */
4904 PyTuple_SET_ITEM(result, 0, (PyObject *)quo);
4905 PyTuple_SET_ITEM(result, 1, (PyObject *)rem);
4906 Py_DECREF(one);
4907 return result;
4908
4909 error:
4910 Py_XDECREF(quo);
4911 Py_XDECREF(rem);
4912 Py_XDECREF(one);
4913 return NULL;
4914}
4915
Eric Smith8c663262007-08-25 02:26:07 +00004916static PyObject *
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004917long_round(PyObject *self, PyObject *args)
4918{
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004919 PyObject *o_ndigits=NULL, *temp, *result, *ndigits;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004920
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004921 /* To round an integer m to the nearest 10**n (n positive), we make use of
4922 * the divmod_near operation, defined by:
4923 *
4924 * divmod_near(a, b) = (q, r)
4925 *
4926 * where q is the nearest integer to the quotient a / b (the
4927 * nearest even integer in the case of a tie) and r == a - q * b.
4928 * Hence q * b = a - r is the nearest multiple of b to a,
4929 * preferring even multiples in the case of a tie.
4930 *
4931 * So the nearest multiple of 10**n to m is:
4932 *
4933 * m - divmod_near(m, 10**n)[1].
4934 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004935 if (!PyArg_ParseTuple(args, "|O", &o_ndigits))
4936 return NULL;
4937 if (o_ndigits == NULL)
4938 return long_long(self);
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004939
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004940 ndigits = PyNumber_Index(o_ndigits);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004941 if (ndigits == NULL)
4942 return NULL;
Mark Dickinson1124e712009-01-28 21:25:58 +00004943
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004944 /* if ndigits >= 0 then no rounding is necessary; return self unchanged */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004945 if (Py_SIZE(ndigits) >= 0) {
4946 Py_DECREF(ndigits);
4947 return long_long(self);
4948 }
Mark Dickinson1124e712009-01-28 21:25:58 +00004949
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004950 /* result = self - divmod_near(self, 10 ** -ndigits)[1] */
4951 temp = long_neg((PyLongObject*)ndigits);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004952 Py_DECREF(ndigits);
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004953 ndigits = temp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004954 if (ndigits == NULL)
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004955 return NULL;
Mark Dickinson1124e712009-01-28 21:25:58 +00004956
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004957 result = PyLong_FromLong(10L);
4958 if (result == NULL) {
4959 Py_DECREF(ndigits);
4960 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004961 }
Mark Dickinson1124e712009-01-28 21:25:58 +00004962
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004963 temp = long_pow(result, ndigits, Py_None);
4964 Py_DECREF(ndigits);
4965 Py_DECREF(result);
4966 result = temp;
4967 if (result == NULL)
4968 return NULL;
4969
Mark Dickinsonfa68a612010-06-07 18:47:09 +00004970 temp = _PyLong_DivmodNear(self, result);
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004971 Py_DECREF(result);
4972 result = temp;
4973 if (result == NULL)
4974 return NULL;
4975
4976 temp = long_sub((PyLongObject *)self,
4977 (PyLongObject *)PyTuple_GET_ITEM(result, 1));
4978 Py_DECREF(result);
4979 result = temp;
4980
4981 return result;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004982}
4983
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004984static PyObject *
4985long_sizeof(PyLongObject *v)
4986{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004987 Py_ssize_t res;
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004988
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004989 res = offsetof(PyLongObject, ob_digit) + Py_ABS(Py_SIZE(v))*sizeof(digit);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004990 return PyLong_FromSsize_t(res);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004991}
4992
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004993static PyObject *
4994long_bit_length(PyLongObject *v)
4995{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004996 PyLongObject *result, *x, *y;
4997 Py_ssize_t ndigits, msd_bits = 0;
4998 digit msd;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004999
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005000 assert(v != NULL);
5001 assert(PyLong_Check(v));
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00005002
Victor Stinner45e8e2f2014-05-14 17:24:35 +02005003 ndigits = Py_ABS(Py_SIZE(v));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005004 if (ndigits == 0)
5005 return PyLong_FromLong(0);
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00005006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005007 msd = v->ob_digit[ndigits-1];
5008 while (msd >= 32) {
5009 msd_bits += 6;
5010 msd >>= 6;
5011 }
5012 msd_bits += (long)(BitLengthTable[msd]);
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00005013
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005014 if (ndigits <= PY_SSIZE_T_MAX/PyLong_SHIFT)
5015 return PyLong_FromSsize_t((ndigits-1)*PyLong_SHIFT + msd_bits);
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00005016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005017 /* expression above may overflow; use Python integers instead */
5018 result = (PyLongObject *)PyLong_FromSsize_t(ndigits - 1);
5019 if (result == NULL)
5020 return NULL;
5021 x = (PyLongObject *)PyLong_FromLong(PyLong_SHIFT);
5022 if (x == NULL)
5023 goto error;
5024 y = (PyLongObject *)long_mul(result, x);
5025 Py_DECREF(x);
5026 if (y == NULL)
5027 goto error;
5028 Py_DECREF(result);
5029 result = y;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00005030
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005031 x = (PyLongObject *)PyLong_FromLong((long)msd_bits);
5032 if (x == NULL)
5033 goto error;
5034 y = (PyLongObject *)long_add(result, x);
5035 Py_DECREF(x);
5036 if (y == NULL)
5037 goto error;
5038 Py_DECREF(result);
5039 result = y;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00005040
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005041 return (PyObject *)result;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00005042
Mark Dickinson22b20182010-05-10 21:27:53 +00005043 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005044 Py_DECREF(result);
5045 return NULL;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00005046}
5047
5048PyDoc_STRVAR(long_bit_length_doc,
5049"int.bit_length() -> int\n\
5050\n\
5051Number of bits necessary to represent self in binary.\n\
5052>>> bin(37)\n\
5053'0b100101'\n\
5054>>> (37).bit_length()\n\
50556");
5056
Christian Heimes53876d92008-04-19 00:31:39 +00005057#if 0
5058static PyObject *
5059long_is_finite(PyObject *v)
5060{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005061 Py_RETURN_TRUE;
Christian Heimes53876d92008-04-19 00:31:39 +00005062}
5063#endif
5064
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005065
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005066static PyObject *
5067long_to_bytes(PyLongObject *v, PyObject *args, PyObject *kwds)
5068{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005069 PyObject *byteorder_str;
5070 PyObject *is_signed_obj = NULL;
5071 Py_ssize_t length;
5072 int little_endian;
5073 int is_signed;
5074 PyObject *bytes;
5075 static char *kwlist[] = {"length", "byteorder", "signed", NULL};
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005076
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005077 if (!PyArg_ParseTupleAndKeywords(args, kwds, "nU|O:to_bytes", kwlist,
5078 &length, &byteorder_str,
5079 &is_signed_obj))
5080 return NULL;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005081
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005082 if (args != NULL && Py_SIZE(args) > 2) {
5083 PyErr_SetString(PyExc_TypeError,
5084 "'signed' is a keyword-only argument");
5085 return NULL;
5086 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005087
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005088 if (!PyUnicode_CompareWithASCIIString(byteorder_str, "little"))
5089 little_endian = 1;
5090 else if (!PyUnicode_CompareWithASCIIString(byteorder_str, "big"))
5091 little_endian = 0;
5092 else {
5093 PyErr_SetString(PyExc_ValueError,
5094 "byteorder must be either 'little' or 'big'");
5095 return NULL;
5096 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005097
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005098 if (is_signed_obj != NULL) {
5099 int cmp = PyObject_IsTrue(is_signed_obj);
5100 if (cmp < 0)
5101 return NULL;
5102 is_signed = cmp ? 1 : 0;
5103 }
5104 else {
5105 /* If the signed argument was omitted, use False as the
5106 default. */
5107 is_signed = 0;
5108 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005109
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005110 if (length < 0) {
5111 PyErr_SetString(PyExc_ValueError,
5112 "length argument must be non-negative");
5113 return NULL;
5114 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005116 bytes = PyBytes_FromStringAndSize(NULL, length);
5117 if (bytes == NULL)
5118 return NULL;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005119
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005120 if (_PyLong_AsByteArray(v, (unsigned char *)PyBytes_AS_STRING(bytes),
5121 length, little_endian, is_signed) < 0) {
5122 Py_DECREF(bytes);
5123 return NULL;
5124 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005125
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005126 return bytes;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005127}
5128
Mark Dickinson078c2532010-01-30 18:06:17 +00005129PyDoc_STRVAR(long_to_bytes_doc,
5130"int.to_bytes(length, byteorder, *, signed=False) -> bytes\n\
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005131\n\
Mark Dickinson078c2532010-01-30 18:06:17 +00005132Return an array of bytes representing an integer.\n\
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005133\n\
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005134The integer is represented using length bytes. An OverflowError is\n\
Mark Dickinson078c2532010-01-30 18:06:17 +00005135raised if the integer is not representable with the given number of\n\
5136bytes.\n\
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005137\n\
5138The byteorder argument determines the byte order used to represent the\n\
5139integer. If byteorder is 'big', the most significant byte is at the\n\
5140beginning of the byte array. If byteorder is 'little', the most\n\
5141significant byte is at the end of the byte array. To request the native\n\
5142byte order of the host system, use `sys.byteorder' as the byte order value.\n\
5143\n\
Mark Dickinson078c2532010-01-30 18:06:17 +00005144The signed keyword-only argument determines whether two's complement is\n\
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005145used to represent the integer. If signed is False and a negative integer\n\
Mark Dickinson078c2532010-01-30 18:06:17 +00005146is given, an OverflowError is raised.");
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005147
5148static PyObject *
5149long_from_bytes(PyTypeObject *type, PyObject *args, PyObject *kwds)
5150{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005151 PyObject *byteorder_str;
5152 PyObject *is_signed_obj = NULL;
5153 int little_endian;
5154 int is_signed;
5155 PyObject *obj;
5156 PyObject *bytes;
5157 PyObject *long_obj;
5158 static char *kwlist[] = {"bytes", "byteorder", "signed", NULL};
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005159
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005160 if (!PyArg_ParseTupleAndKeywords(args, kwds, "OU|O:from_bytes", kwlist,
5161 &obj, &byteorder_str,
5162 &is_signed_obj))
5163 return NULL;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005164
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005165 if (args != NULL && Py_SIZE(args) > 2) {
5166 PyErr_SetString(PyExc_TypeError,
5167 "'signed' is a keyword-only argument");
5168 return NULL;
5169 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005170
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005171 if (!PyUnicode_CompareWithASCIIString(byteorder_str, "little"))
5172 little_endian = 1;
5173 else if (!PyUnicode_CompareWithASCIIString(byteorder_str, "big"))
5174 little_endian = 0;
5175 else {
5176 PyErr_SetString(PyExc_ValueError,
5177 "byteorder must be either 'little' or 'big'");
5178 return NULL;
5179 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005180
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005181 if (is_signed_obj != NULL) {
5182 int cmp = PyObject_IsTrue(is_signed_obj);
5183 if (cmp < 0)
5184 return NULL;
5185 is_signed = cmp ? 1 : 0;
5186 }
5187 else {
5188 /* If the signed argument was omitted, use False as the
5189 default. */
5190 is_signed = 0;
5191 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005193 bytes = PyObject_Bytes(obj);
5194 if (bytes == NULL)
5195 return NULL;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005196
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005197 long_obj = _PyLong_FromByteArray(
5198 (unsigned char *)PyBytes_AS_STRING(bytes), Py_SIZE(bytes),
5199 little_endian, is_signed);
5200 Py_DECREF(bytes);
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005201
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005202 /* If from_bytes() was used on subclass, allocate new subclass
Serhiy Storchaka95949422013-08-27 19:40:23 +03005203 * instance, initialize it with decoded int value and return it.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005204 */
5205 if (type != &PyLong_Type && PyType_IsSubtype(type, &PyLong_Type)) {
5206 PyLongObject *newobj;
5207 int i;
Victor Stinner45e8e2f2014-05-14 17:24:35 +02005208 Py_ssize_t n = Py_ABS(Py_SIZE(long_obj));
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005210 newobj = (PyLongObject *)type->tp_alloc(type, n);
5211 if (newobj == NULL) {
5212 Py_DECREF(long_obj);
5213 return NULL;
5214 }
5215 assert(PyLong_Check(newobj));
5216 Py_SIZE(newobj) = Py_SIZE(long_obj);
5217 for (i = 0; i < n; i++) {
5218 newobj->ob_digit[i] =
5219 ((PyLongObject *)long_obj)->ob_digit[i];
5220 }
5221 Py_DECREF(long_obj);
5222 return (PyObject *)newobj;
5223 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005225 return long_obj;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005226}
5227
Mark Dickinson078c2532010-01-30 18:06:17 +00005228PyDoc_STRVAR(long_from_bytes_doc,
5229"int.from_bytes(bytes, byteorder, *, signed=False) -> int\n\
5230\n\
5231Return the integer represented by the given array of bytes.\n\
5232\n\
R David Murray861470c2014-10-05 11:47:01 -04005233The bytes argument must be a bytes-like object (e.g. bytes or bytearray).\n\
Mark Dickinson078c2532010-01-30 18:06:17 +00005234\n\
5235The byteorder argument determines the byte order used to represent the\n\
5236integer. If byteorder is 'big', the most significant byte is at the\n\
5237beginning of the byte array. If byteorder is 'little', the most\n\
5238significant byte is at the end of the byte array. To request the native\n\
5239byte order of the host system, use `sys.byteorder' as the byte order value.\n\
5240\n\
5241The signed keyword-only argument indicates whether two's complement is\n\
5242used to represent the integer.");
5243
Guido van Rossum5d9113d2003-01-29 17:58:45 +00005244static PyMethodDef long_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005245 {"conjugate", (PyCFunction)long_long, METH_NOARGS,
5246 "Returns self, the complex conjugate of any int."},
5247 {"bit_length", (PyCFunction)long_bit_length, METH_NOARGS,
5248 long_bit_length_doc},
Christian Heimes53876d92008-04-19 00:31:39 +00005249#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005250 {"is_finite", (PyCFunction)long_is_finite, METH_NOARGS,
5251 "Returns always True."},
Christian Heimes53876d92008-04-19 00:31:39 +00005252#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005253 {"to_bytes", (PyCFunction)long_to_bytes,
5254 METH_VARARGS|METH_KEYWORDS, long_to_bytes_doc},
5255 {"from_bytes", (PyCFunction)long_from_bytes,
5256 METH_VARARGS|METH_KEYWORDS|METH_CLASS, long_from_bytes_doc},
5257 {"__trunc__", (PyCFunction)long_long, METH_NOARGS,
5258 "Truncating an Integral returns itself."},
5259 {"__floor__", (PyCFunction)long_long, METH_NOARGS,
5260 "Flooring an Integral returns itself."},
5261 {"__ceil__", (PyCFunction)long_long, METH_NOARGS,
5262 "Ceiling of an Integral returns itself."},
5263 {"__round__", (PyCFunction)long_round, METH_VARARGS,
5264 "Rounding an Integral returns itself.\n"
5265 "Rounding with an ndigits argument also returns an integer."},
5266 {"__getnewargs__", (PyCFunction)long_getnewargs, METH_NOARGS},
5267 {"__format__", (PyCFunction)long__format__, METH_VARARGS},
5268 {"__sizeof__", (PyCFunction)long_sizeof, METH_NOARGS,
5269 "Returns size in memory, in bytes"},
5270 {NULL, NULL} /* sentinel */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00005271};
5272
Guido van Rossumb43daf72007-08-01 18:08:08 +00005273static PyGetSetDef long_getset[] = {
Mark Dickinson6bf19002009-05-02 17:57:52 +00005274 {"real",
Guido van Rossumb43daf72007-08-01 18:08:08 +00005275 (getter)long_long, (setter)NULL,
5276 "the real part of a complex number",
5277 NULL},
Mark Dickinson6bf19002009-05-02 17:57:52 +00005278 {"imag",
5279 (getter)long_get0, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00005280 "the imaginary part of a complex number",
Mark Dickinson6bf19002009-05-02 17:57:52 +00005281 NULL},
5282 {"numerator",
Guido van Rossumb43daf72007-08-01 18:08:08 +00005283 (getter)long_long, (setter)NULL,
5284 "the numerator of a rational number in lowest terms",
5285 NULL},
Mark Dickinson6bf19002009-05-02 17:57:52 +00005286 {"denominator",
5287 (getter)long_get1, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00005288 "the denominator of a rational number in lowest terms",
Mark Dickinson6bf19002009-05-02 17:57:52 +00005289 NULL},
Guido van Rossumb43daf72007-08-01 18:08:08 +00005290 {NULL} /* Sentinel */
5291};
5292
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005293PyDoc_STRVAR(long_doc,
Chris Jerdonek83fe2e12012-10-07 14:48:36 -07005294"int(x=0) -> integer\n\
5295int(x, base=10) -> integer\n\
Tim Peters6d6c1a32001-08-02 04:15:00 +00005296\n\
Chris Jerdonek83fe2e12012-10-07 14:48:36 -07005297Convert a number or string to an integer, or return 0 if no arguments\n\
5298are given. If x is a number, return x.__int__(). For floating point\n\
5299numbers, this truncates towards zero.\n\
5300\n\
5301If x is not a number or if base is given, then x must be a string,\n\
5302bytes, or bytearray instance representing an integer literal in the\n\
5303given base. The literal can be preceded by '+' or '-' and be surrounded\n\
5304by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.\n\
5305Base 0 means to interpret the base from the string as an integer literal.\n\
5306>>> int('0b100', base=0)\n\
53074");
Tim Peters6d6c1a32001-08-02 04:15:00 +00005308
Guido van Rossumc0b618a1997-05-02 03:12:38 +00005309static PyNumberMethods long_as_number = {
Mark Dickinson22b20182010-05-10 21:27:53 +00005310 (binaryfunc)long_add, /*nb_add*/
5311 (binaryfunc)long_sub, /*nb_subtract*/
5312 (binaryfunc)long_mul, /*nb_multiply*/
5313 long_mod, /*nb_remainder*/
5314 long_divmod, /*nb_divmod*/
5315 long_pow, /*nb_power*/
5316 (unaryfunc)long_neg, /*nb_negative*/
5317 (unaryfunc)long_long, /*tp_positive*/
5318 (unaryfunc)long_abs, /*tp_absolute*/
5319 (inquiry)long_bool, /*tp_bool*/
5320 (unaryfunc)long_invert, /*nb_invert*/
5321 long_lshift, /*nb_lshift*/
5322 (binaryfunc)long_rshift, /*nb_rshift*/
5323 long_and, /*nb_and*/
5324 long_xor, /*nb_xor*/
5325 long_or, /*nb_or*/
5326 long_long, /*nb_int*/
5327 0, /*nb_reserved*/
5328 long_float, /*nb_float*/
5329 0, /* nb_inplace_add */
5330 0, /* nb_inplace_subtract */
5331 0, /* nb_inplace_multiply */
5332 0, /* nb_inplace_remainder */
5333 0, /* nb_inplace_power */
5334 0, /* nb_inplace_lshift */
5335 0, /* nb_inplace_rshift */
5336 0, /* nb_inplace_and */
5337 0, /* nb_inplace_xor */
5338 0, /* nb_inplace_or */
5339 long_div, /* nb_floor_divide */
5340 long_true_divide, /* nb_true_divide */
5341 0, /* nb_inplace_floor_divide */
5342 0, /* nb_inplace_true_divide */
5343 long_long, /* nb_index */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00005344};
5345
Guido van Rossumc0b618a1997-05-02 03:12:38 +00005346PyTypeObject PyLong_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005347 PyVarObject_HEAD_INIT(&PyType_Type, 0)
5348 "int", /* tp_name */
5349 offsetof(PyLongObject, ob_digit), /* tp_basicsize */
5350 sizeof(digit), /* tp_itemsize */
5351 long_dealloc, /* tp_dealloc */
5352 0, /* tp_print */
5353 0, /* tp_getattr */
5354 0, /* tp_setattr */
5355 0, /* tp_reserved */
5356 long_to_decimal_string, /* tp_repr */
5357 &long_as_number, /* tp_as_number */
5358 0, /* tp_as_sequence */
5359 0, /* tp_as_mapping */
5360 (hashfunc)long_hash, /* tp_hash */
5361 0, /* tp_call */
5362 long_to_decimal_string, /* tp_str */
5363 PyObject_GenericGetAttr, /* tp_getattro */
5364 0, /* tp_setattro */
5365 0, /* tp_as_buffer */
5366 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
5367 Py_TPFLAGS_LONG_SUBCLASS, /* tp_flags */
5368 long_doc, /* tp_doc */
5369 0, /* tp_traverse */
5370 0, /* tp_clear */
5371 long_richcompare, /* tp_richcompare */
5372 0, /* tp_weaklistoffset */
5373 0, /* tp_iter */
5374 0, /* tp_iternext */
5375 long_methods, /* tp_methods */
5376 0, /* tp_members */
5377 long_getset, /* tp_getset */
5378 0, /* tp_base */
5379 0, /* tp_dict */
5380 0, /* tp_descr_get */
5381 0, /* tp_descr_set */
5382 0, /* tp_dictoffset */
5383 0, /* tp_init */
5384 0, /* tp_alloc */
5385 long_new, /* tp_new */
5386 PyObject_Del, /* tp_free */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00005387};
Guido van Rossumddefaf32007-01-14 03:31:43 +00005388
Mark Dickinsonbd792642009-03-18 20:06:12 +00005389static PyTypeObject Int_InfoType;
5390
5391PyDoc_STRVAR(int_info__doc__,
5392"sys.int_info\n\
5393\n\
5394A struct sequence that holds information about Python's\n\
5395internal representation of integers. The attributes are read only.");
5396
5397static PyStructSequence_Field int_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005398 {"bits_per_digit", "size of a digit in bits"},
Mark Dickinson22b20182010-05-10 21:27:53 +00005399 {"sizeof_digit", "size in bytes of the C type used to represent a digit"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005400 {NULL, NULL}
Mark Dickinsonbd792642009-03-18 20:06:12 +00005401};
5402
5403static PyStructSequence_Desc int_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005404 "sys.int_info", /* name */
5405 int_info__doc__, /* doc */
5406 int_info_fields, /* fields */
5407 2 /* number of fields */
Mark Dickinsonbd792642009-03-18 20:06:12 +00005408};
5409
5410PyObject *
5411PyLong_GetInfo(void)
5412{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005413 PyObject* int_info;
5414 int field = 0;
5415 int_info = PyStructSequence_New(&Int_InfoType);
5416 if (int_info == NULL)
5417 return NULL;
5418 PyStructSequence_SET_ITEM(int_info, field++,
5419 PyLong_FromLong(PyLong_SHIFT));
5420 PyStructSequence_SET_ITEM(int_info, field++,
5421 PyLong_FromLong(sizeof(digit)));
5422 if (PyErr_Occurred()) {
5423 Py_CLEAR(int_info);
5424 return NULL;
5425 }
5426 return int_info;
Mark Dickinsonbd792642009-03-18 20:06:12 +00005427}
5428
Guido van Rossumddefaf32007-01-14 03:31:43 +00005429int
5430_PyLong_Init(void)
5431{
5432#if NSMALLNEGINTS + NSMALLPOSINTS > 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005433 int ival, size;
5434 PyLongObject *v = small_ints;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00005435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005436 for (ival = -NSMALLNEGINTS; ival < NSMALLPOSINTS; ival++, v++) {
5437 size = (ival < 0) ? -1 : ((ival == 0) ? 0 : 1);
5438 if (Py_TYPE(v) == &PyLong_Type) {
5439 /* The element is already initialized, most likely
5440 * the Python interpreter was initialized before.
5441 */
5442 Py_ssize_t refcnt;
5443 PyObject* op = (PyObject*)v;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00005444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005445 refcnt = Py_REFCNT(op) < 0 ? 0 : Py_REFCNT(op);
5446 _Py_NewReference(op);
5447 /* _Py_NewReference sets the ref count to 1 but
5448 * the ref count might be larger. Set the refcnt
5449 * to the original refcnt + 1 */
5450 Py_REFCNT(op) = refcnt + 1;
5451 assert(Py_SIZE(op) == size);
Victor Stinner12174a52014-08-15 23:17:38 +02005452 assert(v->ob_digit[0] == (digit)abs(ival));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005453 }
5454 else {
Christian Heimesd3afe782013-12-04 09:27:47 +01005455 (void)PyObject_INIT(v, &PyLong_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005456 }
5457 Py_SIZE(v) = size;
Victor Stinner12174a52014-08-15 23:17:38 +02005458 v->ob_digit[0] = (digit)abs(ival);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005459 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00005460#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005461 /* initialize int_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02005462 if (Int_InfoType.tp_name == NULL) {
5463 if (PyStructSequence_InitType2(&Int_InfoType, &int_info_desc) < 0)
5464 return 0;
5465 }
Mark Dickinsonbd792642009-03-18 20:06:12 +00005466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005467 return 1;
Guido van Rossumddefaf32007-01-14 03:31:43 +00005468}
5469
5470void
5471PyLong_Fini(void)
5472{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005473 /* Integers are currently statically allocated. Py_DECREF is not
5474 needed, but Python must forget about the reference or multiple
5475 reinitializations will fail. */
Guido van Rossumddefaf32007-01-14 03:31:43 +00005476#if NSMALLNEGINTS + NSMALLPOSINTS > 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005477 int i;
5478 PyLongObject *v = small_ints;
5479 for (i = 0; i < NSMALLNEGINTS + NSMALLPOSINTS; i++, v++) {
5480 _Py_DEC_REFTOTAL;
5481 _Py_ForgetReference((PyObject*)v);
5482 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00005483#endif
5484}