blob: d05de8bf07a0421abe7fdede6cb380724e32f717 [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 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002772 x = _PyLong_Frexp((PyLongObject *)v, &exponent);
2773 if ((x == -1.0 && PyErr_Occurred()) || exponent > DBL_MAX_EXP) {
2774 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson02515f72013-08-03 12:08:22 +01002775 "int too large to convert to float");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002776 return -1.0;
2777 }
2778 return ldexp(x, (int)exponent);
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002779}
2780
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002781/* Methods */
2782
2783static void
Tim Peters9f688bf2000-07-07 15:53:28 +00002784long_dealloc(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002785{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002786 Py_TYPE(v)->tp_free(v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002787}
2788
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002789static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002790long_compare(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002791{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002792 Py_ssize_t sign;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002793
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002794 if (Py_SIZE(a) != Py_SIZE(b)) {
2795 sign = Py_SIZE(a) - Py_SIZE(b);
2796 }
2797 else {
Victor Stinner45e8e2f2014-05-14 17:24:35 +02002798 Py_ssize_t i = Py_ABS(Py_SIZE(a));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002799 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2800 ;
2801 if (i < 0)
2802 sign = 0;
2803 else {
2804 sign = (sdigit)a->ob_digit[i] - (sdigit)b->ob_digit[i];
2805 if (Py_SIZE(a) < 0)
2806 sign = -sign;
2807 }
2808 }
2809 return sign < 0 ? -1 : sign > 0 ? 1 : 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002810}
2811
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002812#define TEST_COND(cond) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002813 ((cond) ? Py_True : Py_False)
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002814
Guido van Rossum47b9ff62006-08-24 00:41:19 +00002815static PyObject *
2816long_richcompare(PyObject *self, PyObject *other, int op)
2817{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002818 int result;
2819 PyObject *v;
2820 CHECK_BINOP(self, other);
2821 if (self == other)
2822 result = 0;
2823 else
2824 result = long_compare((PyLongObject*)self, (PyLongObject*)other);
2825 /* Convert the return value to a Boolean */
2826 switch (op) {
2827 case Py_EQ:
2828 v = TEST_COND(result == 0);
2829 break;
2830 case Py_NE:
2831 v = TEST_COND(result != 0);
2832 break;
2833 case Py_LE:
2834 v = TEST_COND(result <= 0);
2835 break;
2836 case Py_GE:
2837 v = TEST_COND(result >= 0);
2838 break;
2839 case Py_LT:
2840 v = TEST_COND(result == -1);
2841 break;
2842 case Py_GT:
2843 v = TEST_COND(result == 1);
2844 break;
2845 default:
2846 PyErr_BadArgument();
2847 return NULL;
2848 }
2849 Py_INCREF(v);
2850 return v;
Guido van Rossum47b9ff62006-08-24 00:41:19 +00002851}
2852
Benjamin Peterson8f67d082010-10-17 20:54:53 +00002853static Py_hash_t
Tim Peters9f688bf2000-07-07 15:53:28 +00002854long_hash(PyLongObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +00002855{
Benjamin Peterson8035bc52010-10-23 16:20:50 +00002856 Py_uhash_t x;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002857 Py_ssize_t i;
2858 int sign;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002859
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002860 i = Py_SIZE(v);
2861 switch(i) {
2862 case -1: return v->ob_digit[0]==1 ? -2 : -(sdigit)v->ob_digit[0];
2863 case 0: return 0;
2864 case 1: return v->ob_digit[0];
2865 }
2866 sign = 1;
2867 x = 0;
2868 if (i < 0) {
2869 sign = -1;
2870 i = -(i);
2871 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002872 while (--i >= 0) {
Mark Dickinsondc787d22010-05-23 13:33:13 +00002873 /* Here x is a quantity in the range [0, _PyHASH_MODULUS); we
2874 want to compute x * 2**PyLong_SHIFT + v->ob_digit[i] modulo
2875 _PyHASH_MODULUS.
2876
2877 The computation of x * 2**PyLong_SHIFT % _PyHASH_MODULUS
2878 amounts to a rotation of the bits of x. To see this, write
2879
2880 x * 2**PyLong_SHIFT = y * 2**_PyHASH_BITS + z
2881
2882 where y = x >> (_PyHASH_BITS - PyLong_SHIFT) gives the top
2883 PyLong_SHIFT bits of x (those that are shifted out of the
2884 original _PyHASH_BITS bits, and z = (x << PyLong_SHIFT) &
2885 _PyHASH_MODULUS gives the bottom _PyHASH_BITS - PyLong_SHIFT
2886 bits of x, shifted up. Then since 2**_PyHASH_BITS is
2887 congruent to 1 modulo _PyHASH_MODULUS, y*2**_PyHASH_BITS is
2888 congruent to y modulo _PyHASH_MODULUS. So
2889
2890 x * 2**PyLong_SHIFT = y + z (mod _PyHASH_MODULUS).
2891
2892 The right-hand side is just the result of rotating the
2893 _PyHASH_BITS bits of x left by PyLong_SHIFT places; since
2894 not all _PyHASH_BITS bits of x are 1s, the same is true
2895 after rotation, so 0 <= y+z < _PyHASH_MODULUS and y + z is
2896 the reduction of x*2**PyLong_SHIFT modulo
2897 _PyHASH_MODULUS. */
2898 x = ((x << PyLong_SHIFT) & _PyHASH_MODULUS) |
2899 (x >> (_PyHASH_BITS - PyLong_SHIFT));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002900 x += v->ob_digit[i];
Mark Dickinsondc787d22010-05-23 13:33:13 +00002901 if (x >= _PyHASH_MODULUS)
2902 x -= _PyHASH_MODULUS;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002903 }
2904 x = x * sign;
Benjamin Peterson8035bc52010-10-23 16:20:50 +00002905 if (x == (Py_uhash_t)-1)
2906 x = (Py_uhash_t)-2;
Benjamin Peterson8f67d082010-10-17 20:54:53 +00002907 return (Py_hash_t)x;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002908}
2909
2910
Serhiy Storchaka95949422013-08-27 19:40:23 +03002911/* Add the absolute values of two integers. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002912
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002913static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002914x_add(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002915{
Victor Stinner45e8e2f2014-05-14 17:24:35 +02002916 Py_ssize_t size_a = Py_ABS(Py_SIZE(a)), size_b = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002917 PyLongObject *z;
2918 Py_ssize_t i;
2919 digit carry = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002921 /* Ensure a is the larger of the two: */
2922 if (size_a < size_b) {
2923 { PyLongObject *temp = a; a = b; b = temp; }
2924 { Py_ssize_t size_temp = size_a;
Mark Dickinson22b20182010-05-10 21:27:53 +00002925 size_a = size_b;
2926 size_b = size_temp; }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002927 }
2928 z = _PyLong_New(size_a+1);
2929 if (z == NULL)
2930 return NULL;
2931 for (i = 0; i < size_b; ++i) {
2932 carry += a->ob_digit[i] + b->ob_digit[i];
2933 z->ob_digit[i] = carry & PyLong_MASK;
2934 carry >>= PyLong_SHIFT;
2935 }
2936 for (; i < size_a; ++i) {
2937 carry += a->ob_digit[i];
2938 z->ob_digit[i] = carry & PyLong_MASK;
2939 carry >>= PyLong_SHIFT;
2940 }
2941 z->ob_digit[i] = carry;
2942 return long_normalize(z);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002943}
2944
2945/* Subtract the absolute values of two integers. */
2946
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002947static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002948x_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002949{
Victor Stinner45e8e2f2014-05-14 17:24:35 +02002950 Py_ssize_t size_a = Py_ABS(Py_SIZE(a)), size_b = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002951 PyLongObject *z;
2952 Py_ssize_t i;
2953 int sign = 1;
2954 digit borrow = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002956 /* Ensure a is the larger of the two: */
2957 if (size_a < size_b) {
2958 sign = -1;
2959 { PyLongObject *temp = a; a = b; b = temp; }
2960 { Py_ssize_t size_temp = size_a;
Mark Dickinson22b20182010-05-10 21:27:53 +00002961 size_a = size_b;
2962 size_b = size_temp; }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002963 }
2964 else if (size_a == size_b) {
2965 /* Find highest digit where a and b differ: */
2966 i = size_a;
2967 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2968 ;
2969 if (i < 0)
2970 return (PyLongObject *)PyLong_FromLong(0);
2971 if (a->ob_digit[i] < b->ob_digit[i]) {
2972 sign = -1;
2973 { PyLongObject *temp = a; a = b; b = temp; }
2974 }
2975 size_a = size_b = i+1;
2976 }
2977 z = _PyLong_New(size_a);
2978 if (z == NULL)
2979 return NULL;
2980 for (i = 0; i < size_b; ++i) {
2981 /* The following assumes unsigned arithmetic
2982 works module 2**N for some N>PyLong_SHIFT. */
2983 borrow = a->ob_digit[i] - b->ob_digit[i] - borrow;
2984 z->ob_digit[i] = borrow & PyLong_MASK;
2985 borrow >>= PyLong_SHIFT;
2986 borrow &= 1; /* Keep only one sign bit */
2987 }
2988 for (; i < size_a; ++i) {
2989 borrow = a->ob_digit[i] - borrow;
2990 z->ob_digit[i] = borrow & PyLong_MASK;
2991 borrow >>= PyLong_SHIFT;
2992 borrow &= 1; /* Keep only one sign bit */
2993 }
2994 assert(borrow == 0);
Victor Stinner8aed6f12013-07-17 22:31:17 +02002995 if (sign < 0) {
2996 _PyLong_Negate(&z);
2997 if (z == NULL)
2998 return NULL;
2999 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003000 return long_normalize(z);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003001}
3002
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003003static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003004long_add(PyLongObject *a, PyLongObject *b)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003005{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003006 PyLongObject *z;
Tim Peters69c2de32001-09-11 22:31:33 +00003007
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003008 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003009
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003010 if (Py_ABS(Py_SIZE(a)) <= 1 && Py_ABS(Py_SIZE(b)) <= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003011 PyObject *result = PyLong_FromLong(MEDIUM_VALUE(a) +
3012 MEDIUM_VALUE(b));
3013 return result;
3014 }
3015 if (Py_SIZE(a) < 0) {
3016 if (Py_SIZE(b) < 0) {
3017 z = x_add(a, b);
3018 if (z != NULL && Py_SIZE(z) != 0)
3019 Py_SIZE(z) = -(Py_SIZE(z));
3020 }
3021 else
3022 z = x_sub(b, a);
3023 }
3024 else {
3025 if (Py_SIZE(b) < 0)
3026 z = x_sub(a, b);
3027 else
3028 z = x_add(a, b);
3029 }
3030 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003031}
3032
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003033static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003034long_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003035{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003036 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003037
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003038 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003039
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003040 if (Py_ABS(Py_SIZE(a)) <= 1 && Py_ABS(Py_SIZE(b)) <= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003041 PyObject* r;
3042 r = PyLong_FromLong(MEDIUM_VALUE(a)-MEDIUM_VALUE(b));
3043 return r;
3044 }
3045 if (Py_SIZE(a) < 0) {
3046 if (Py_SIZE(b) < 0)
3047 z = x_sub(a, b);
3048 else
3049 z = x_add(a, b);
3050 if (z != NULL && Py_SIZE(z) != 0)
3051 Py_SIZE(z) = -(Py_SIZE(z));
3052 }
3053 else {
3054 if (Py_SIZE(b) < 0)
3055 z = x_add(a, b);
3056 else
3057 z = x_sub(a, b);
3058 }
3059 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003060}
3061
Tim Peters5af4e6c2002-08-12 02:31:19 +00003062/* Grade school multiplication, ignoring the signs.
3063 * Returns the absolute value of the product, or NULL if error.
3064 */
3065static PyLongObject *
3066x_mul(PyLongObject *a, PyLongObject *b)
Neil Schemenauerba872e22001-01-04 01:46:03 +00003067{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003068 PyLongObject *z;
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003069 Py_ssize_t size_a = Py_ABS(Py_SIZE(a));
3070 Py_ssize_t size_b = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003071 Py_ssize_t i;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003072
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003073 z = _PyLong_New(size_a + size_b);
3074 if (z == NULL)
3075 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003076
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003077 memset(z->ob_digit, 0, Py_SIZE(z) * sizeof(digit));
3078 if (a == b) {
3079 /* Efficient squaring per HAC, Algorithm 14.16:
3080 * http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf
3081 * Gives slightly less than a 2x speedup when a == b,
3082 * via exploiting that each entry in the multiplication
3083 * pyramid appears twice (except for the size_a squares).
3084 */
3085 for (i = 0; i < size_a; ++i) {
3086 twodigits carry;
3087 twodigits f = a->ob_digit[i];
3088 digit *pz = z->ob_digit + (i << 1);
3089 digit *pa = a->ob_digit + i + 1;
3090 digit *paend = a->ob_digit + size_a;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003091
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003092 SIGCHECK({
Mark Dickinson22b20182010-05-10 21:27:53 +00003093 Py_DECREF(z);
3094 return NULL;
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00003095 });
Tim Peters0973b992004-08-29 22:16:50 +00003096
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003097 carry = *pz + f * f;
3098 *pz++ = (digit)(carry & PyLong_MASK);
3099 carry >>= PyLong_SHIFT;
3100 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00003101
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003102 /* Now f is added in twice in each column of the
3103 * pyramid it appears. Same as adding f<<1 once.
3104 */
3105 f <<= 1;
3106 while (pa < paend) {
3107 carry += *pz + *pa++ * f;
3108 *pz++ = (digit)(carry & PyLong_MASK);
3109 carry >>= PyLong_SHIFT;
3110 assert(carry <= (PyLong_MASK << 1));
3111 }
3112 if (carry) {
3113 carry += *pz;
3114 *pz++ = (digit)(carry & PyLong_MASK);
3115 carry >>= PyLong_SHIFT;
3116 }
3117 if (carry)
3118 *pz += (digit)(carry & PyLong_MASK);
3119 assert((carry >> PyLong_SHIFT) == 0);
3120 }
3121 }
Serhiy Storchaka95949422013-08-27 19:40:23 +03003122 else { /* a is not the same as b -- gradeschool int mult */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003123 for (i = 0; i < size_a; ++i) {
3124 twodigits carry = 0;
3125 twodigits f = a->ob_digit[i];
3126 digit *pz = z->ob_digit + i;
3127 digit *pb = b->ob_digit;
3128 digit *pbend = b->ob_digit + size_b;
Tim Peters0973b992004-08-29 22:16:50 +00003129
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003130 SIGCHECK({
Mark Dickinson22b20182010-05-10 21:27:53 +00003131 Py_DECREF(z);
3132 return NULL;
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00003133 });
Tim Peters0973b992004-08-29 22:16:50 +00003134
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003135 while (pb < pbend) {
3136 carry += *pz + *pb++ * f;
3137 *pz++ = (digit)(carry & PyLong_MASK);
3138 carry >>= PyLong_SHIFT;
3139 assert(carry <= PyLong_MASK);
3140 }
3141 if (carry)
3142 *pz += (digit)(carry & PyLong_MASK);
3143 assert((carry >> PyLong_SHIFT) == 0);
3144 }
3145 }
3146 return long_normalize(z);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003147}
3148
3149/* A helper for Karatsuba multiplication (k_mul).
Serhiy Storchaka95949422013-08-27 19:40:23 +03003150 Takes an int "n" and an integer "size" representing the place to
Tim Peters5af4e6c2002-08-12 02:31:19 +00003151 split, and sets low and high such that abs(n) == (high << size) + low,
3152 viewing the shift as being by digits. The sign bit is ignored, and
3153 the return values are >= 0.
3154 Returns 0 on success, -1 on failure.
3155*/
3156static int
Mark Dickinson22b20182010-05-10 21:27:53 +00003157kmul_split(PyLongObject *n,
3158 Py_ssize_t size,
3159 PyLongObject **high,
3160 PyLongObject **low)
Tim Peters5af4e6c2002-08-12 02:31:19 +00003161{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003162 PyLongObject *hi, *lo;
3163 Py_ssize_t size_lo, size_hi;
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003164 const Py_ssize_t size_n = Py_ABS(Py_SIZE(n));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003165
Victor Stinner640c35c2013-06-04 23:14:37 +02003166 size_lo = Py_MIN(size_n, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003167 size_hi = size_n - size_lo;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003169 if ((hi = _PyLong_New(size_hi)) == NULL)
3170 return -1;
3171 if ((lo = _PyLong_New(size_lo)) == NULL) {
3172 Py_DECREF(hi);
3173 return -1;
3174 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003176 memcpy(lo->ob_digit, n->ob_digit, size_lo * sizeof(digit));
3177 memcpy(hi->ob_digit, n->ob_digit + size_lo, size_hi * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003178
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003179 *high = long_normalize(hi);
3180 *low = long_normalize(lo);
3181 return 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003182}
3183
Tim Peters60004642002-08-12 22:01:34 +00003184static PyLongObject *k_lopsided_mul(PyLongObject *a, PyLongObject *b);
3185
Tim Peters5af4e6c2002-08-12 02:31:19 +00003186/* Karatsuba multiplication. Ignores the input signs, and returns the
3187 * absolute value of the product (or NULL if error).
3188 * See Knuth Vol. 2 Chapter 4.3.3 (Pp. 294-295).
3189 */
3190static PyLongObject *
3191k_mul(PyLongObject *a, PyLongObject *b)
3192{
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003193 Py_ssize_t asize = Py_ABS(Py_SIZE(a));
3194 Py_ssize_t bsize = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003195 PyLongObject *ah = NULL;
3196 PyLongObject *al = NULL;
3197 PyLongObject *bh = NULL;
3198 PyLongObject *bl = NULL;
3199 PyLongObject *ret = NULL;
3200 PyLongObject *t1, *t2, *t3;
3201 Py_ssize_t shift; /* the number of digits we split off */
3202 Py_ssize_t i;
Tim Peters738eda72002-08-12 15:08:20 +00003203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003204 /* (ah*X+al)(bh*X+bl) = ah*bh*X*X + (ah*bl + al*bh)*X + al*bl
3205 * Let k = (ah+al)*(bh+bl) = ah*bl + al*bh + ah*bh + al*bl
3206 * Then the original product is
3207 * ah*bh*X*X + (k - ah*bh - al*bl)*X + al*bl
3208 * By picking X to be a power of 2, "*X" is just shifting, and it's
3209 * been reduced to 3 multiplies on numbers half the size.
3210 */
Tim Peters5af4e6c2002-08-12 02:31:19 +00003211
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003212 /* We want to split based on the larger number; fiddle so that b
3213 * is largest.
3214 */
3215 if (asize > bsize) {
3216 t1 = a;
3217 a = b;
3218 b = t1;
Tim Peters738eda72002-08-12 15:08:20 +00003219
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003220 i = asize;
3221 asize = bsize;
3222 bsize = i;
3223 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003225 /* Use gradeschool math when either number is too small. */
3226 i = a == b ? KARATSUBA_SQUARE_CUTOFF : KARATSUBA_CUTOFF;
3227 if (asize <= i) {
3228 if (asize == 0)
3229 return (PyLongObject *)PyLong_FromLong(0);
3230 else
3231 return x_mul(a, b);
3232 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003233
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003234 /* If a is small compared to b, splitting on b gives a degenerate
3235 * case with ah==0, and Karatsuba may be (even much) less efficient
3236 * than "grade school" then. However, we can still win, by viewing
3237 * b as a string of "big digits", each of width a->ob_size. That
3238 * leads to a sequence of balanced calls to k_mul.
3239 */
3240 if (2 * asize <= bsize)
3241 return k_lopsided_mul(a, b);
Tim Peters60004642002-08-12 22:01:34 +00003242
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003243 /* Split a & b into hi & lo pieces. */
3244 shift = bsize >> 1;
3245 if (kmul_split(a, shift, &ah, &al) < 0) goto fail;
3246 assert(Py_SIZE(ah) > 0); /* the split isn't degenerate */
Tim Petersd6974a52002-08-13 20:37:51 +00003247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003248 if (a == b) {
3249 bh = ah;
3250 bl = al;
3251 Py_INCREF(bh);
3252 Py_INCREF(bl);
3253 }
3254 else if (kmul_split(b, shift, &bh, &bl) < 0) goto fail;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003255
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003256 /* The plan:
3257 * 1. Allocate result space (asize + bsize digits: that's always
3258 * enough).
3259 * 2. Compute ah*bh, and copy into result at 2*shift.
3260 * 3. Compute al*bl, and copy into result at 0. Note that this
3261 * can't overlap with #2.
3262 * 4. Subtract al*bl from the result, starting at shift. This may
3263 * underflow (borrow out of the high digit), but we don't care:
3264 * we're effectively doing unsigned arithmetic mod
3265 * BASE**(sizea + sizeb), and so long as the *final* result fits,
3266 * borrows and carries out of the high digit can be ignored.
3267 * 5. Subtract ah*bh from the result, starting at shift.
3268 * 6. Compute (ah+al)*(bh+bl), and add it into the result starting
3269 * at shift.
3270 */
Tim Petersd64c1de2002-08-12 17:36:03 +00003271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003272 /* 1. Allocate result space. */
3273 ret = _PyLong_New(asize + bsize);
3274 if (ret == NULL) goto fail;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003275#ifdef Py_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003276 /* Fill with trash, to catch reference to uninitialized digits. */
3277 memset(ret->ob_digit, 0xDF, Py_SIZE(ret) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003278#endif
Tim Peters44121a62002-08-12 06:17:58 +00003279
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003280 /* 2. t1 <- ah*bh, and copy into high digits of result. */
3281 if ((t1 = k_mul(ah, bh)) == NULL) goto fail;
3282 assert(Py_SIZE(t1) >= 0);
3283 assert(2*shift + Py_SIZE(t1) <= Py_SIZE(ret));
3284 memcpy(ret->ob_digit + 2*shift, t1->ob_digit,
3285 Py_SIZE(t1) * sizeof(digit));
Tim Peters738eda72002-08-12 15:08:20 +00003286
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003287 /* Zero-out the digits higher than the ah*bh copy. */
3288 i = Py_SIZE(ret) - 2*shift - Py_SIZE(t1);
3289 if (i)
3290 memset(ret->ob_digit + 2*shift + Py_SIZE(t1), 0,
3291 i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003292
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003293 /* 3. t2 <- al*bl, and copy into the low digits. */
3294 if ((t2 = k_mul(al, bl)) == NULL) {
3295 Py_DECREF(t1);
3296 goto fail;
3297 }
3298 assert(Py_SIZE(t2) >= 0);
3299 assert(Py_SIZE(t2) <= 2*shift); /* no overlap with high digits */
3300 memcpy(ret->ob_digit, t2->ob_digit, Py_SIZE(t2) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003301
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003302 /* Zero out remaining digits. */
3303 i = 2*shift - Py_SIZE(t2); /* number of uninitialized digits */
3304 if (i)
3305 memset(ret->ob_digit + Py_SIZE(t2), 0, i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003307 /* 4 & 5. Subtract ah*bh (t1) and al*bl (t2). We do al*bl first
3308 * because it's fresher in cache.
3309 */
3310 i = Py_SIZE(ret) - shift; /* # digits after shift */
3311 (void)v_isub(ret->ob_digit + shift, i, t2->ob_digit, Py_SIZE(t2));
3312 Py_DECREF(t2);
Tim Peters738eda72002-08-12 15:08:20 +00003313
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003314 (void)v_isub(ret->ob_digit + shift, i, t1->ob_digit, Py_SIZE(t1));
3315 Py_DECREF(t1);
Tim Peters738eda72002-08-12 15:08:20 +00003316
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003317 /* 6. t3 <- (ah+al)(bh+bl), and add into result. */
3318 if ((t1 = x_add(ah, al)) == NULL) goto fail;
3319 Py_DECREF(ah);
3320 Py_DECREF(al);
3321 ah = al = NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003323 if (a == b) {
3324 t2 = t1;
3325 Py_INCREF(t2);
3326 }
3327 else if ((t2 = x_add(bh, bl)) == NULL) {
3328 Py_DECREF(t1);
3329 goto fail;
3330 }
3331 Py_DECREF(bh);
3332 Py_DECREF(bl);
3333 bh = bl = NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003334
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003335 t3 = k_mul(t1, t2);
3336 Py_DECREF(t1);
3337 Py_DECREF(t2);
3338 if (t3 == NULL) goto fail;
3339 assert(Py_SIZE(t3) >= 0);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003341 /* Add t3. It's not obvious why we can't run out of room here.
3342 * See the (*) comment after this function.
3343 */
3344 (void)v_iadd(ret->ob_digit + shift, i, t3->ob_digit, Py_SIZE(t3));
3345 Py_DECREF(t3);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003347 return long_normalize(ret);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003348
Mark Dickinson22b20182010-05-10 21:27:53 +00003349 fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003350 Py_XDECREF(ret);
3351 Py_XDECREF(ah);
3352 Py_XDECREF(al);
3353 Py_XDECREF(bh);
3354 Py_XDECREF(bl);
3355 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003356}
3357
Tim Petersd6974a52002-08-13 20:37:51 +00003358/* (*) Why adding t3 can't "run out of room" above.
3359
Tim Petersab86c2b2002-08-15 20:06:00 +00003360Let f(x) mean the floor of x and c(x) mean the ceiling of x. Some facts
3361to start with:
Tim Petersd6974a52002-08-13 20:37:51 +00003362
Tim Petersab86c2b2002-08-15 20:06:00 +000033631. For any integer i, i = c(i/2) + f(i/2). In particular,
3364 bsize = c(bsize/2) + f(bsize/2).
33652. shift = f(bsize/2)
33663. asize <= bsize
33674. Since we call k_lopsided_mul if asize*2 <= bsize, asize*2 > bsize in this
3368 routine, so asize > bsize/2 >= f(bsize/2) in this routine.
Tim Petersd6974a52002-08-13 20:37:51 +00003369
Tim Petersab86c2b2002-08-15 20:06:00 +00003370We allocated asize + bsize result digits, and add t3 into them at an offset
3371of shift. This leaves asize+bsize-shift allocated digit positions for t3
3372to fit into, = (by #1 and #2) asize + f(bsize/2) + c(bsize/2) - f(bsize/2) =
3373asize + c(bsize/2) available digit positions.
Tim Petersd6974a52002-08-13 20:37:51 +00003374
Tim Petersab86c2b2002-08-15 20:06:00 +00003375bh has c(bsize/2) digits, and bl at most f(size/2) digits. So bh+hl has
3376at most c(bsize/2) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00003377
Tim Petersab86c2b2002-08-15 20:06:00 +00003378If asize == bsize, ah has c(bsize/2) digits, else ah has at most f(bsize/2)
3379digits, and al has at most f(bsize/2) digits in any case. So ah+al has at
3380most (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00003381
Tim Petersab86c2b2002-08-15 20:06:00 +00003382The product (ah+al)*(bh+bl) therefore has at most
Tim Petersd6974a52002-08-13 20:37:51 +00003383
Tim Petersab86c2b2002-08-15 20:06:00 +00003384 c(bsize/2) + (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits
Tim Petersd6974a52002-08-13 20:37:51 +00003385
Tim Petersab86c2b2002-08-15 20:06:00 +00003386and we have asize + c(bsize/2) available digit positions. We need to show
3387this is always enough. An instance of c(bsize/2) cancels out in both, so
3388the question reduces to whether asize digits is enough to hold
3389(asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits. If asize < bsize,
3390then we're asking whether asize digits >= f(bsize/2) digits + 2 bits. By #4,
3391asize 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 +00003392digit is enough to hold 2 bits. This is so since PyLong_SHIFT=15 >= 2. If
Tim Petersab86c2b2002-08-15 20:06:00 +00003393asize == bsize, then we're asking whether bsize digits is enough to hold
Tim Peterse417de02002-08-15 20:10:45 +00003394c(bsize/2) digits + 2 bits, or equivalently (by #1) whether f(bsize/2) digits
3395is enough to hold 2 bits. This is so if bsize >= 2, which holds because
3396bsize >= KARATSUBA_CUTOFF >= 2.
Tim Peters8e966ee2002-08-14 16:36:23 +00003397
Tim Peters48d52c02002-08-14 17:07:32 +00003398Note that since there's always enough room for (ah+al)*(bh+bl), and that's
3399clearly >= each of ah*bh and al*bl, there's always enough room to subtract
3400ah*bh and al*bl too.
Tim Petersd6974a52002-08-13 20:37:51 +00003401*/
3402
Tim Peters60004642002-08-12 22:01:34 +00003403/* b has at least twice the digits of a, and a is big enough that Karatsuba
3404 * would pay off *if* the inputs had balanced sizes. View b as a sequence
3405 * of slices, each with a->ob_size digits, and multiply the slices by a,
3406 * one at a time. This gives k_mul balanced inputs to work with, and is
3407 * also cache-friendly (we compute one double-width slice of the result
Ezio Melotti42da6632011-03-15 05:18:48 +02003408 * at a time, then move on, never backtracking except for the helpful
Tim Peters60004642002-08-12 22:01:34 +00003409 * single-width slice overlap between successive partial sums).
3410 */
3411static PyLongObject *
3412k_lopsided_mul(PyLongObject *a, PyLongObject *b)
3413{
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003414 const Py_ssize_t asize = Py_ABS(Py_SIZE(a));
3415 Py_ssize_t bsize = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003416 Py_ssize_t nbdone; /* # of b digits already multiplied */
3417 PyLongObject *ret;
3418 PyLongObject *bslice = NULL;
Tim Peters60004642002-08-12 22:01:34 +00003419
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003420 assert(asize > KARATSUBA_CUTOFF);
3421 assert(2 * asize <= bsize);
Tim Peters60004642002-08-12 22:01:34 +00003422
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003423 /* Allocate result space, and zero it out. */
3424 ret = _PyLong_New(asize + bsize);
3425 if (ret == NULL)
3426 return NULL;
3427 memset(ret->ob_digit, 0, Py_SIZE(ret) * sizeof(digit));
Tim Peters60004642002-08-12 22:01:34 +00003428
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003429 /* Successive slices of b are copied into bslice. */
3430 bslice = _PyLong_New(asize);
3431 if (bslice == NULL)
3432 goto fail;
Tim Peters60004642002-08-12 22:01:34 +00003433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003434 nbdone = 0;
3435 while (bsize > 0) {
3436 PyLongObject *product;
Victor Stinner640c35c2013-06-04 23:14:37 +02003437 const Py_ssize_t nbtouse = Py_MIN(bsize, asize);
Tim Peters60004642002-08-12 22:01:34 +00003438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003439 /* Multiply the next slice of b by a. */
3440 memcpy(bslice->ob_digit, b->ob_digit + nbdone,
3441 nbtouse * sizeof(digit));
3442 Py_SIZE(bslice) = nbtouse;
3443 product = k_mul(a, bslice);
3444 if (product == NULL)
3445 goto fail;
Tim Peters60004642002-08-12 22:01:34 +00003446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003447 /* Add into result. */
3448 (void)v_iadd(ret->ob_digit + nbdone, Py_SIZE(ret) - nbdone,
3449 product->ob_digit, Py_SIZE(product));
3450 Py_DECREF(product);
Tim Peters60004642002-08-12 22:01:34 +00003451
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003452 bsize -= nbtouse;
3453 nbdone += nbtouse;
3454 }
Tim Peters60004642002-08-12 22:01:34 +00003455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003456 Py_DECREF(bslice);
3457 return long_normalize(ret);
Tim Peters60004642002-08-12 22:01:34 +00003458
Mark Dickinson22b20182010-05-10 21:27:53 +00003459 fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003460 Py_DECREF(ret);
3461 Py_XDECREF(bslice);
3462 return NULL;
Tim Peters60004642002-08-12 22:01:34 +00003463}
Tim Peters5af4e6c2002-08-12 02:31:19 +00003464
3465static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003466long_mul(PyLongObject *a, PyLongObject *b)
Tim Peters5af4e6c2002-08-12 02:31:19 +00003467{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003468 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003469
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003470 CHECK_BINOP(a, b);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003471
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003472 /* fast path for single-digit multiplication */
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003473 if (Py_ABS(Py_SIZE(a)) <= 1 && Py_ABS(Py_SIZE(b)) <= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003474 stwodigits v = (stwodigits)(MEDIUM_VALUE(a)) * MEDIUM_VALUE(b);
Mark Dickinsonbd792642009-03-18 20:06:12 +00003475#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003476 return PyLong_FromLongLong((PY_LONG_LONG)v);
Mark Dickinsonbd792642009-03-18 20:06:12 +00003477#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003478 /* if we don't have long long then we're almost certainly
3479 using 15-bit digits, so v will fit in a long. In the
3480 unlikely event that we're using 30-bit digits on a platform
3481 without long long, a large v will just cause us to fall
3482 through to the general multiplication code below. */
3483 if (v >= LONG_MIN && v <= LONG_MAX)
3484 return PyLong_FromLong((long)v);
Mark Dickinsonbd792642009-03-18 20:06:12 +00003485#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003486 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00003487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003488 z = k_mul(a, b);
3489 /* Negate if exactly one of the inputs is negative. */
Victor Stinner8aed6f12013-07-17 22:31:17 +02003490 if (((Py_SIZE(a) ^ Py_SIZE(b)) < 0) && z) {
3491 _PyLong_Negate(&z);
3492 if (z == NULL)
3493 return NULL;
3494 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003495 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003496}
3497
Guido van Rossume32e0141992-01-19 16:31:05 +00003498/* The / and % operators are now defined in terms of divmod().
3499 The expression a mod b has the value a - b*floor(a/b).
3500 The long_divrem function gives the remainder after division of
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003501 |a| by |b|, with the sign of a. This is also expressed
3502 as a - b*trunc(a/b), if trunc truncates towards zero.
3503 Some examples:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003504 a b a rem b a mod b
3505 13 10 3 3
3506 -13 10 -3 7
3507 13 -10 3 -7
3508 -13 -10 -3 -3
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003509 So, to get from rem to mod, we have to add b if a and b
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003510 have different signs. We then subtract one from the 'div'
3511 part of the outcome to keep the invariant intact. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003512
Tim Peters47e52ee2004-08-30 02:44:38 +00003513/* Compute
3514 * *pdiv, *pmod = divmod(v, w)
3515 * NULL can be passed for pdiv or pmod, in which case that part of
3516 * the result is simply thrown away. The caller owns a reference to
3517 * each of these it requests (does not pass NULL for).
3518 */
Guido van Rossume32e0141992-01-19 16:31:05 +00003519static int
Tim Peters5af4e6c2002-08-12 02:31:19 +00003520l_divmod(PyLongObject *v, PyLongObject *w,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003521 PyLongObject **pdiv, PyLongObject **pmod)
Guido van Rossume32e0141992-01-19 16:31:05 +00003522{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003523 PyLongObject *div, *mod;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003525 if (long_divrem(v, w, &div, &mod) < 0)
3526 return -1;
3527 if ((Py_SIZE(mod) < 0 && Py_SIZE(w) > 0) ||
3528 (Py_SIZE(mod) > 0 && Py_SIZE(w) < 0)) {
3529 PyLongObject *temp;
3530 PyLongObject *one;
3531 temp = (PyLongObject *) long_add(mod, w);
3532 Py_DECREF(mod);
3533 mod = temp;
3534 if (mod == NULL) {
3535 Py_DECREF(div);
3536 return -1;
3537 }
3538 one = (PyLongObject *) PyLong_FromLong(1L);
3539 if (one == NULL ||
3540 (temp = (PyLongObject *) long_sub(div, one)) == NULL) {
3541 Py_DECREF(mod);
3542 Py_DECREF(div);
3543 Py_XDECREF(one);
3544 return -1;
3545 }
3546 Py_DECREF(one);
3547 Py_DECREF(div);
3548 div = temp;
3549 }
3550 if (pdiv != NULL)
3551 *pdiv = div;
3552 else
3553 Py_DECREF(div);
Tim Peters47e52ee2004-08-30 02:44:38 +00003554
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003555 if (pmod != NULL)
3556 *pmod = mod;
3557 else
3558 Py_DECREF(mod);
Tim Peters47e52ee2004-08-30 02:44:38 +00003559
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003560 return 0;
Guido van Rossume32e0141992-01-19 16:31:05 +00003561}
3562
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003563static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003564long_div(PyObject *a, PyObject *b)
Guido van Rossume32e0141992-01-19 16:31:05 +00003565{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003566 PyLongObject *div;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003567
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003568 CHECK_BINOP(a, b);
3569 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, &div, NULL) < 0)
3570 div = NULL;
3571 return (PyObject *)div;
Guido van Rossume32e0141992-01-19 16:31:05 +00003572}
3573
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003574/* PyLong/PyLong -> float, with correctly rounded result. */
3575
3576#define MANT_DIG_DIGITS (DBL_MANT_DIG / PyLong_SHIFT)
3577#define MANT_DIG_BITS (DBL_MANT_DIG % PyLong_SHIFT)
3578
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003579static PyObject *
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003580long_true_divide(PyObject *v, PyObject *w)
Tim Peters20dab9f2001-09-04 05:31:47 +00003581{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003582 PyLongObject *a, *b, *x;
3583 Py_ssize_t a_size, b_size, shift, extra_bits, diff, x_size, x_bits;
3584 digit mask, low;
3585 int inexact, negate, a_is_small, b_is_small;
3586 double dx, result;
Tim Peterse2a60002001-09-04 06:17:36 +00003587
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003588 CHECK_BINOP(v, w);
3589 a = (PyLongObject *)v;
3590 b = (PyLongObject *)w;
Tim Peterse2a60002001-09-04 06:17:36 +00003591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003592 /*
3593 Method in a nutshell:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003594
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003595 0. reduce to case a, b > 0; filter out obvious underflow/overflow
3596 1. choose a suitable integer 'shift'
3597 2. use integer arithmetic to compute x = floor(2**-shift*a/b)
3598 3. adjust x for correct rounding
3599 4. convert x to a double dx with the same value
3600 5. return ldexp(dx, shift).
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003601
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003602 In more detail:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003604 0. For any a, a/0 raises ZeroDivisionError; for nonzero b, 0/b
3605 returns either 0.0 or -0.0, depending on the sign of b. For a and
3606 b both nonzero, ignore signs of a and b, and add the sign back in
3607 at the end. Now write a_bits and b_bits for the bit lengths of a
3608 and b respectively (that is, a_bits = 1 + floor(log_2(a)); likewise
3609 for b). Then
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003611 2**(a_bits - b_bits - 1) < a/b < 2**(a_bits - b_bits + 1).
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003612
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003613 So if a_bits - b_bits > DBL_MAX_EXP then a/b > 2**DBL_MAX_EXP and
3614 so overflows. Similarly, if a_bits - b_bits < DBL_MIN_EXP -
3615 DBL_MANT_DIG - 1 then a/b underflows to 0. With these cases out of
3616 the way, we can assume that
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003617
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003618 DBL_MIN_EXP - DBL_MANT_DIG - 1 <= a_bits - b_bits <= DBL_MAX_EXP.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003619
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003620 1. The integer 'shift' is chosen so that x has the right number of
3621 bits for a double, plus two or three extra bits that will be used
3622 in the rounding decisions. Writing a_bits and b_bits for the
3623 number of significant bits in a and b respectively, a
3624 straightforward formula for shift is:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003625
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003626 shift = a_bits - b_bits - DBL_MANT_DIG - 2
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003628 This is fine in the usual case, but if a/b is smaller than the
3629 smallest normal float then it can lead to double rounding on an
3630 IEEE 754 platform, giving incorrectly rounded results. So we
3631 adjust the formula slightly. The actual formula used is:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003632
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003633 shift = MAX(a_bits - b_bits, DBL_MIN_EXP) - DBL_MANT_DIG - 2
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003634
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003635 2. The quantity x is computed by first shifting a (left -shift bits
3636 if shift <= 0, right shift bits if shift > 0) and then dividing by
3637 b. For both the shift and the division, we keep track of whether
3638 the result is inexact, in a flag 'inexact'; this information is
3639 needed at the rounding stage.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003640
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003641 With the choice of shift above, together with our assumption that
3642 a_bits - b_bits >= DBL_MIN_EXP - DBL_MANT_DIG - 1, it follows
3643 that x >= 1.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003645 3. Now x * 2**shift <= a/b < (x+1) * 2**shift. We want to replace
3646 this with an exactly representable float of the form
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003648 round(x/2**extra_bits) * 2**(extra_bits+shift).
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003649
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003650 For float representability, we need x/2**extra_bits <
3651 2**DBL_MANT_DIG and extra_bits + shift >= DBL_MIN_EXP -
3652 DBL_MANT_DIG. This translates to the condition:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003653
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003654 extra_bits >= MAX(x_bits, DBL_MIN_EXP - shift) - DBL_MANT_DIG
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003655
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003656 To round, we just modify the bottom digit of x in-place; this can
3657 end up giving a digit with value > PyLONG_MASK, but that's not a
3658 problem since digits can hold values up to 2*PyLONG_MASK+1.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003659
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003660 With the original choices for shift above, extra_bits will always
3661 be 2 or 3. Then rounding under the round-half-to-even rule, we
3662 round up iff the most significant of the extra bits is 1, and
3663 either: (a) the computation of x in step 2 had an inexact result,
3664 or (b) at least one other of the extra bits is 1, or (c) the least
3665 significant bit of x (above those to be rounded) is 1.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003666
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003667 4. Conversion to a double is straightforward; all floating-point
3668 operations involved in the conversion are exact, so there's no
3669 danger of rounding errors.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003671 5. Use ldexp(x, shift) to compute x*2**shift, the final result.
3672 The result will always be exactly representable as a double, except
3673 in the case that it overflows. To avoid dependence on the exact
3674 behaviour of ldexp on overflow, we check for overflow before
3675 applying ldexp. The result of ldexp is adjusted for sign before
3676 returning.
3677 */
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003678
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003679 /* Reduce to case where a and b are both positive. */
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003680 a_size = Py_ABS(Py_SIZE(a));
3681 b_size = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003682 negate = (Py_SIZE(a) < 0) ^ (Py_SIZE(b) < 0);
3683 if (b_size == 0) {
3684 PyErr_SetString(PyExc_ZeroDivisionError,
3685 "division by zero");
3686 goto error;
3687 }
3688 if (a_size == 0)
3689 goto underflow_or_zero;
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003691 /* Fast path for a and b small (exactly representable in a double).
3692 Relies on floating-point division being correctly rounded; results
3693 may be subject to double rounding on x86 machines that operate with
3694 the x87 FPU set to 64-bit precision. */
3695 a_is_small = a_size <= MANT_DIG_DIGITS ||
3696 (a_size == MANT_DIG_DIGITS+1 &&
3697 a->ob_digit[MANT_DIG_DIGITS] >> MANT_DIG_BITS == 0);
3698 b_is_small = b_size <= MANT_DIG_DIGITS ||
3699 (b_size == MANT_DIG_DIGITS+1 &&
3700 b->ob_digit[MANT_DIG_DIGITS] >> MANT_DIG_BITS == 0);
3701 if (a_is_small && b_is_small) {
3702 double da, db;
3703 da = a->ob_digit[--a_size];
3704 while (a_size > 0)
3705 da = da * PyLong_BASE + a->ob_digit[--a_size];
3706 db = b->ob_digit[--b_size];
3707 while (b_size > 0)
3708 db = db * PyLong_BASE + b->ob_digit[--b_size];
3709 result = da / db;
3710 goto success;
3711 }
Tim Peterse2a60002001-09-04 06:17:36 +00003712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003713 /* Catch obvious cases of underflow and overflow */
3714 diff = a_size - b_size;
3715 if (diff > PY_SSIZE_T_MAX/PyLong_SHIFT - 1)
3716 /* Extreme overflow */
3717 goto overflow;
3718 else if (diff < 1 - PY_SSIZE_T_MAX/PyLong_SHIFT)
3719 /* Extreme underflow */
3720 goto underflow_or_zero;
3721 /* Next line is now safe from overflowing a Py_ssize_t */
3722 diff = diff * PyLong_SHIFT + bits_in_digit(a->ob_digit[a_size - 1]) -
3723 bits_in_digit(b->ob_digit[b_size - 1]);
3724 /* Now diff = a_bits - b_bits. */
3725 if (diff > DBL_MAX_EXP)
3726 goto overflow;
3727 else if (diff < DBL_MIN_EXP - DBL_MANT_DIG - 1)
3728 goto underflow_or_zero;
Tim Peterse2a60002001-09-04 06:17:36 +00003729
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003730 /* Choose value for shift; see comments for step 1 above. */
Victor Stinner640c35c2013-06-04 23:14:37 +02003731 shift = Py_MAX(diff, DBL_MIN_EXP) - DBL_MANT_DIG - 2;
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003732
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003733 inexact = 0;
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003734
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003735 /* x = abs(a * 2**-shift) */
3736 if (shift <= 0) {
3737 Py_ssize_t i, shift_digits = -shift / PyLong_SHIFT;
3738 digit rem;
3739 /* x = a << -shift */
3740 if (a_size >= PY_SSIZE_T_MAX - 1 - shift_digits) {
3741 /* In practice, it's probably impossible to end up
3742 here. Both a and b would have to be enormous,
3743 using close to SIZE_T_MAX bytes of memory each. */
3744 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson22b20182010-05-10 21:27:53 +00003745 "intermediate overflow during division");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003746 goto error;
3747 }
3748 x = _PyLong_New(a_size + shift_digits + 1);
3749 if (x == NULL)
3750 goto error;
3751 for (i = 0; i < shift_digits; i++)
3752 x->ob_digit[i] = 0;
3753 rem = v_lshift(x->ob_digit + shift_digits, a->ob_digit,
3754 a_size, -shift % PyLong_SHIFT);
3755 x->ob_digit[a_size + shift_digits] = rem;
3756 }
3757 else {
3758 Py_ssize_t shift_digits = shift / PyLong_SHIFT;
3759 digit rem;
3760 /* x = a >> shift */
3761 assert(a_size >= shift_digits);
3762 x = _PyLong_New(a_size - shift_digits);
3763 if (x == NULL)
3764 goto error;
3765 rem = v_rshift(x->ob_digit, a->ob_digit + shift_digits,
3766 a_size - shift_digits, shift % PyLong_SHIFT);
3767 /* set inexact if any of the bits shifted out is nonzero */
3768 if (rem)
3769 inexact = 1;
3770 while (!inexact && shift_digits > 0)
3771 if (a->ob_digit[--shift_digits])
3772 inexact = 1;
3773 }
3774 long_normalize(x);
3775 x_size = Py_SIZE(x);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003777 /* x //= b. If the remainder is nonzero, set inexact. We own the only
3778 reference to x, so it's safe to modify it in-place. */
3779 if (b_size == 1) {
3780 digit rem = inplace_divrem1(x->ob_digit, x->ob_digit, x_size,
3781 b->ob_digit[0]);
3782 long_normalize(x);
3783 if (rem)
3784 inexact = 1;
3785 }
3786 else {
3787 PyLongObject *div, *rem;
3788 div = x_divrem(x, b, &rem);
3789 Py_DECREF(x);
3790 x = div;
3791 if (x == NULL)
3792 goto error;
3793 if (Py_SIZE(rem))
3794 inexact = 1;
3795 Py_DECREF(rem);
3796 }
Victor Stinner45e8e2f2014-05-14 17:24:35 +02003797 x_size = Py_ABS(Py_SIZE(x));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003798 assert(x_size > 0); /* result of division is never zero */
3799 x_bits = (x_size-1)*PyLong_SHIFT+bits_in_digit(x->ob_digit[x_size-1]);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003800
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003801 /* The number of extra bits that have to be rounded away. */
Victor Stinner640c35c2013-06-04 23:14:37 +02003802 extra_bits = Py_MAX(x_bits, DBL_MIN_EXP - shift) - DBL_MANT_DIG;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003803 assert(extra_bits == 2 || extra_bits == 3);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003804
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003805 /* Round by directly modifying the low digit of x. */
3806 mask = (digit)1 << (extra_bits - 1);
3807 low = x->ob_digit[0] | inexact;
3808 if (low & mask && low & (3*mask-1))
3809 low += mask;
3810 x->ob_digit[0] = low & ~(mask-1U);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003811
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003812 /* Convert x to a double dx; the conversion is exact. */
3813 dx = x->ob_digit[--x_size];
3814 while (x_size > 0)
3815 dx = dx * PyLong_BASE + x->ob_digit[--x_size];
3816 Py_DECREF(x);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003817
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003818 /* Check whether ldexp result will overflow a double. */
3819 if (shift + x_bits >= DBL_MAX_EXP &&
3820 (shift + x_bits > DBL_MAX_EXP || dx == ldexp(1.0, (int)x_bits)))
3821 goto overflow;
3822 result = ldexp(dx, (int)shift);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003823
3824 success:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003825 return PyFloat_FromDouble(negate ? -result : result);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003826
3827 underflow_or_zero:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003828 return PyFloat_FromDouble(negate ? -0.0 : 0.0);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003829
3830 overflow:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003831 PyErr_SetString(PyExc_OverflowError,
3832 "integer division result too large for a float");
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003833 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003834 return NULL;
Tim Peters20dab9f2001-09-04 05:31:47 +00003835}
3836
3837static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003838long_mod(PyObject *a, PyObject *b)
Guido van Rossume32e0141992-01-19 16:31:05 +00003839{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003840 PyLongObject *mod;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003841
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003842 CHECK_BINOP(a, b);
3843
3844 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, NULL, &mod) < 0)
3845 mod = NULL;
3846 return (PyObject *)mod;
Guido van Rossume32e0141992-01-19 16:31:05 +00003847}
3848
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003849static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003850long_divmod(PyObject *a, PyObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003851{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003852 PyLongObject *div, *mod;
3853 PyObject *z;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003854
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003855 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003856
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003857 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, &div, &mod) < 0) {
3858 return NULL;
3859 }
3860 z = PyTuple_New(2);
3861 if (z != NULL) {
3862 PyTuple_SetItem(z, 0, (PyObject *) div);
3863 PyTuple_SetItem(z, 1, (PyObject *) mod);
3864 }
3865 else {
3866 Py_DECREF(div);
3867 Py_DECREF(mod);
3868 }
3869 return z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003870}
3871
Tim Peters47e52ee2004-08-30 02:44:38 +00003872/* pow(v, w, x) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003873static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003874long_pow(PyObject *v, PyObject *w, PyObject *x)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003875{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003876 PyLongObject *a, *b, *c; /* a,b,c = v,w,x */
3877 int negativeOutput = 0; /* if x<0 return negative output */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003878
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003879 PyLongObject *z = NULL; /* accumulated result */
3880 Py_ssize_t i, j, k; /* counters */
3881 PyLongObject *temp = NULL;
Tim Peters47e52ee2004-08-30 02:44:38 +00003882
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003883 /* 5-ary values. If the exponent is large enough, table is
3884 * precomputed so that table[i] == a**i % c for i in range(32).
3885 */
3886 PyLongObject *table[32] = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
3887 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0};
Tim Peters47e52ee2004-08-30 02:44:38 +00003888
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003889 /* a, b, c = v, w, x */
3890 CHECK_BINOP(v, w);
3891 a = (PyLongObject*)v; Py_INCREF(a);
3892 b = (PyLongObject*)w; Py_INCREF(b);
3893 if (PyLong_Check(x)) {
3894 c = (PyLongObject *)x;
3895 Py_INCREF(x);
3896 }
3897 else if (x == Py_None)
3898 c = NULL;
3899 else {
3900 Py_DECREF(a);
3901 Py_DECREF(b);
Brian Curtindfc80e32011-08-10 20:28:54 -05003902 Py_RETURN_NOTIMPLEMENTED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003903 }
Tim Peters4c483c42001-09-05 06:24:58 +00003904
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003905 if (Py_SIZE(b) < 0) { /* if exponent is negative */
3906 if (c) {
Mark Dickinson0c346d82014-04-11 14:34:40 -04003907 PyErr_SetString(PyExc_ValueError, "pow() 2nd argument "
Mark Dickinson22b20182010-05-10 21:27:53 +00003908 "cannot be negative when 3rd argument specified");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003909 goto Error;
3910 }
3911 else {
3912 /* else return a float. This works because we know
3913 that this calls float_pow() which converts its
3914 arguments to double. */
3915 Py_DECREF(a);
3916 Py_DECREF(b);
3917 return PyFloat_Type.tp_as_number->nb_power(v, w, x);
3918 }
3919 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003921 if (c) {
3922 /* if modulus == 0:
3923 raise ValueError() */
3924 if (Py_SIZE(c) == 0) {
3925 PyErr_SetString(PyExc_ValueError,
3926 "pow() 3rd argument cannot be 0");
3927 goto Error;
3928 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003930 /* if modulus < 0:
3931 negativeOutput = True
3932 modulus = -modulus */
3933 if (Py_SIZE(c) < 0) {
3934 negativeOutput = 1;
3935 temp = (PyLongObject *)_PyLong_Copy(c);
3936 if (temp == NULL)
3937 goto Error;
3938 Py_DECREF(c);
3939 c = temp;
3940 temp = NULL;
Victor Stinner8aed6f12013-07-17 22:31:17 +02003941 _PyLong_Negate(&c);
3942 if (c == NULL)
3943 goto Error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003944 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003945
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003946 /* if modulus == 1:
3947 return 0 */
3948 if ((Py_SIZE(c) == 1) && (c->ob_digit[0] == 1)) {
3949 z = (PyLongObject *)PyLong_FromLong(0L);
3950 goto Done;
3951 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003952
Tim Peters81a93152013-10-05 16:53:52 -05003953 /* Reduce base by modulus in some cases:
3954 1. If base < 0. Forcing the base non-negative makes things easier.
3955 2. If base is obviously larger than the modulus. The "small
3956 exponent" case later can multiply directly by base repeatedly,
3957 while the "large exponent" case multiplies directly by base 31
3958 times. It can be unboundedly faster to multiply by
3959 base % modulus instead.
3960 We could _always_ do this reduction, but l_divmod() isn't cheap,
3961 so we only do it when it buys something. */
3962 if (Py_SIZE(a) < 0 || Py_SIZE(a) > Py_SIZE(c)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003963 if (l_divmod(a, c, NULL, &temp) < 0)
3964 goto Error;
3965 Py_DECREF(a);
3966 a = temp;
3967 temp = NULL;
3968 }
3969 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003970
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003971 /* At this point a, b, and c are guaranteed non-negative UNLESS
3972 c is NULL, in which case a may be negative. */
Tim Peters47e52ee2004-08-30 02:44:38 +00003973
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003974 z = (PyLongObject *)PyLong_FromLong(1L);
3975 if (z == NULL)
3976 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00003977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003978 /* Perform a modular reduction, X = X % c, but leave X alone if c
3979 * is NULL.
3980 */
3981#define REDUCE(X) \
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00003982 do { \
3983 if (c != NULL) { \
3984 if (l_divmod(X, c, NULL, &temp) < 0) \
3985 goto Error; \
3986 Py_XDECREF(X); \
3987 X = temp; \
3988 temp = NULL; \
3989 } \
3990 } while(0)
Tim Peters47e52ee2004-08-30 02:44:38 +00003991
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003992 /* Multiply two values, then reduce the result:
3993 result = X*Y % c. If c is NULL, skip the mod. */
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00003994#define MULT(X, Y, result) \
3995 do { \
3996 temp = (PyLongObject *)long_mul(X, Y); \
3997 if (temp == NULL) \
3998 goto Error; \
3999 Py_XDECREF(result); \
4000 result = temp; \
4001 temp = NULL; \
4002 REDUCE(result); \
4003 } while(0)
Tim Peters47e52ee2004-08-30 02:44:38 +00004004
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004005 if (Py_SIZE(b) <= FIVEARY_CUTOFF) {
4006 /* Left-to-right binary exponentiation (HAC Algorithm 14.79) */
4007 /* http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf */
4008 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
4009 digit bi = b->ob_digit[i];
Tim Peters47e52ee2004-08-30 02:44:38 +00004010
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004011 for (j = (digit)1 << (PyLong_SHIFT-1); j != 0; j >>= 1) {
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00004012 MULT(z, z, z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004013 if (bi & j)
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00004014 MULT(z, a, z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004015 }
4016 }
4017 }
4018 else {
4019 /* Left-to-right 5-ary exponentiation (HAC Algorithm 14.82) */
4020 Py_INCREF(z); /* still holds 1L */
4021 table[0] = z;
4022 for (i = 1; i < 32; ++i)
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00004023 MULT(table[i-1], a, table[i]);
Tim Peters47e52ee2004-08-30 02:44:38 +00004024
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004025 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
4026 const digit bi = b->ob_digit[i];
Tim Peters47e52ee2004-08-30 02:44:38 +00004027
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004028 for (j = PyLong_SHIFT - 5; j >= 0; j -= 5) {
4029 const int index = (bi >> j) & 0x1f;
4030 for (k = 0; k < 5; ++k)
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00004031 MULT(z, z, z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004032 if (index)
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00004033 MULT(z, table[index], z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004034 }
4035 }
4036 }
Tim Peters47e52ee2004-08-30 02:44:38 +00004037
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004038 if (negativeOutput && (Py_SIZE(z) != 0)) {
4039 temp = (PyLongObject *)long_sub(z, c);
4040 if (temp == NULL)
4041 goto Error;
4042 Py_DECREF(z);
4043 z = temp;
4044 temp = NULL;
4045 }
4046 goto Done;
Tim Peters47e52ee2004-08-30 02:44:38 +00004047
Mark Dickinson22b20182010-05-10 21:27:53 +00004048 Error:
Victor Stinner8aed6f12013-07-17 22:31:17 +02004049 Py_CLEAR(z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004050 /* fall through */
Mark Dickinson22b20182010-05-10 21:27:53 +00004051 Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004052 if (Py_SIZE(b) > FIVEARY_CUTOFF) {
4053 for (i = 0; i < 32; ++i)
4054 Py_XDECREF(table[i]);
4055 }
4056 Py_DECREF(a);
4057 Py_DECREF(b);
4058 Py_XDECREF(c);
4059 Py_XDECREF(temp);
4060 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004061}
4062
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004063static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00004064long_invert(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004065{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004066 /* Implement ~x as -(x+1) */
4067 PyLongObject *x;
4068 PyLongObject *w;
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004069 if (Py_ABS(Py_SIZE(v)) <=1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004070 return PyLong_FromLong(-(MEDIUM_VALUE(v)+1));
4071 w = (PyLongObject *)PyLong_FromLong(1L);
4072 if (w == NULL)
4073 return NULL;
4074 x = (PyLongObject *) long_add(v, w);
4075 Py_DECREF(w);
4076 if (x == NULL)
4077 return NULL;
4078 Py_SIZE(x) = -(Py_SIZE(x));
4079 return (PyObject *)maybe_small_long(x);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004080}
4081
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004082static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00004083long_neg(PyLongObject *v)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004084{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004085 PyLongObject *z;
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004086 if (Py_ABS(Py_SIZE(v)) <= 1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004087 return PyLong_FromLong(-MEDIUM_VALUE(v));
4088 z = (PyLongObject *)_PyLong_Copy(v);
4089 if (z != NULL)
4090 Py_SIZE(z) = -(Py_SIZE(v));
4091 return (PyObject *)z;
Guido van Rossumc6913e71991-11-19 20:26:46 +00004092}
4093
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004094static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00004095long_abs(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004096{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004097 if (Py_SIZE(v) < 0)
4098 return long_neg(v);
4099 else
4100 return long_long((PyObject *)v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004101}
4102
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00004103static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00004104long_bool(PyLongObject *v)
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00004105{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004106 return Py_SIZE(v) != 0;
Guido van Rossumc6913e71991-11-19 20:26:46 +00004107}
4108
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004109static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00004110long_rshift(PyLongObject *a, PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004111{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004112 PyLongObject *z = NULL;
4113 Py_ssize_t shiftby, newsize, wordshift, loshift, hishift, i, j;
4114 digit lomask, himask;
Tim Peters5af4e6c2002-08-12 02:31:19 +00004115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004116 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00004117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004118 if (Py_SIZE(a) < 0) {
4119 /* Right shifting negative numbers is harder */
4120 PyLongObject *a1, *a2;
4121 a1 = (PyLongObject *) long_invert(a);
4122 if (a1 == NULL)
4123 goto rshift_error;
4124 a2 = (PyLongObject *) long_rshift(a1, b);
4125 Py_DECREF(a1);
4126 if (a2 == NULL)
4127 goto rshift_error;
4128 z = (PyLongObject *) long_invert(a2);
4129 Py_DECREF(a2);
4130 }
4131 else {
4132 shiftby = PyLong_AsSsize_t((PyObject *)b);
4133 if (shiftby == -1L && PyErr_Occurred())
4134 goto rshift_error;
4135 if (shiftby < 0) {
4136 PyErr_SetString(PyExc_ValueError,
4137 "negative shift count");
4138 goto rshift_error;
4139 }
4140 wordshift = shiftby / PyLong_SHIFT;
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004141 newsize = Py_ABS(Py_SIZE(a)) - wordshift;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004142 if (newsize <= 0)
4143 return PyLong_FromLong(0);
4144 loshift = shiftby % PyLong_SHIFT;
4145 hishift = PyLong_SHIFT - loshift;
4146 lomask = ((digit)1 << hishift) - 1;
4147 himask = PyLong_MASK ^ lomask;
4148 z = _PyLong_New(newsize);
4149 if (z == NULL)
4150 goto rshift_error;
4151 if (Py_SIZE(a) < 0)
4152 Py_SIZE(z) = -(Py_SIZE(z));
4153 for (i = 0, j = wordshift; i < newsize; i++, j++) {
4154 z->ob_digit[i] = (a->ob_digit[j] >> loshift) & lomask;
4155 if (i+1 < newsize)
Mark Dickinson22b20182010-05-10 21:27:53 +00004156 z->ob_digit[i] |= (a->ob_digit[j+1] << hishift) & himask;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004157 }
4158 z = long_normalize(z);
4159 }
Mark Dickinson22b20182010-05-10 21:27:53 +00004160 rshift_error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004161 return (PyObject *) maybe_small_long(z);
Neil Schemenauerba872e22001-01-04 01:46:03 +00004162
Guido van Rossumc6913e71991-11-19 20:26:46 +00004163}
4164
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004165static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00004166long_lshift(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004167{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004168 /* This version due to Tim Peters */
4169 PyLongObject *a = (PyLongObject*)v;
4170 PyLongObject *b = (PyLongObject*)w;
4171 PyLongObject *z = NULL;
4172 Py_ssize_t shiftby, oldsize, newsize, wordshift, remshift, i, j;
4173 twodigits accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00004174
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004175 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00004176
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004177 shiftby = PyLong_AsSsize_t((PyObject *)b);
4178 if (shiftby == -1L && PyErr_Occurred())
Victor Stinner8aed6f12013-07-17 22:31:17 +02004179 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004180 if (shiftby < 0) {
4181 PyErr_SetString(PyExc_ValueError, "negative shift count");
Victor Stinner8aed6f12013-07-17 22:31:17 +02004182 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004183 }
4184 /* wordshift, remshift = divmod(shiftby, PyLong_SHIFT) */
4185 wordshift = shiftby / PyLong_SHIFT;
4186 remshift = shiftby - wordshift * PyLong_SHIFT;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00004187
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004188 oldsize = Py_ABS(Py_SIZE(a));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004189 newsize = oldsize + wordshift;
4190 if (remshift)
4191 ++newsize;
4192 z = _PyLong_New(newsize);
4193 if (z == NULL)
Victor Stinner8aed6f12013-07-17 22:31:17 +02004194 return NULL;
4195 if (Py_SIZE(a) < 0) {
4196 assert(Py_REFCNT(z) == 1);
4197 Py_SIZE(z) = -Py_SIZE(z);
4198 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004199 for (i = 0; i < wordshift; i++)
4200 z->ob_digit[i] = 0;
4201 accum = 0;
4202 for (i = wordshift, j = 0; j < oldsize; i++, j++) {
4203 accum |= (twodigits)a->ob_digit[j] << remshift;
4204 z->ob_digit[i] = (digit)(accum & PyLong_MASK);
4205 accum >>= PyLong_SHIFT;
4206 }
4207 if (remshift)
4208 z->ob_digit[newsize-1] = (digit)accum;
4209 else
4210 assert(!accum);
4211 z = long_normalize(z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004212 return (PyObject *) maybe_small_long(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00004213}
4214
Mark Dickinson27a87a22009-10-25 20:43:34 +00004215/* Compute two's complement of digit vector a[0:m], writing result to
4216 z[0:m]. The digit vector a need not be normalized, but should not
4217 be entirely zero. a and z may point to the same digit vector. */
4218
4219static void
4220v_complement(digit *z, digit *a, Py_ssize_t m)
4221{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004222 Py_ssize_t i;
4223 digit carry = 1;
4224 for (i = 0; i < m; ++i) {
4225 carry += a[i] ^ PyLong_MASK;
4226 z[i] = carry & PyLong_MASK;
4227 carry >>= PyLong_SHIFT;
4228 }
4229 assert(carry == 0);
Mark Dickinson27a87a22009-10-25 20:43:34 +00004230}
Guido van Rossum4c260ff1992-01-14 18:36:43 +00004231
4232/* Bitwise and/xor/or operations */
4233
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004234static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00004235long_bitwise(PyLongObject *a,
Benjamin Peterson513762f2012-12-26 16:43:33 -06004236 char op, /* '&', '|', '^' */
Mark Dickinson22b20182010-05-10 21:27:53 +00004237 PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004238{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004239 int nega, negb, negz;
4240 Py_ssize_t size_a, size_b, size_z, i;
4241 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00004242
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004243 /* Bitwise operations for negative numbers operate as though
4244 on a two's complement representation. So convert arguments
4245 from sign-magnitude to two's complement, and convert the
4246 result back to sign-magnitude at the end. */
Mark Dickinson27a87a22009-10-25 20:43:34 +00004247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004248 /* If a is negative, replace it by its two's complement. */
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004249 size_a = Py_ABS(Py_SIZE(a));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004250 nega = Py_SIZE(a) < 0;
4251 if (nega) {
4252 z = _PyLong_New(size_a);
4253 if (z == NULL)
4254 return NULL;
4255 v_complement(z->ob_digit, a->ob_digit, size_a);
4256 a = z;
4257 }
4258 else
4259 /* Keep reference count consistent. */
4260 Py_INCREF(a);
Mark Dickinson27a87a22009-10-25 20:43:34 +00004261
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004262 /* Same for b. */
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004263 size_b = Py_ABS(Py_SIZE(b));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004264 negb = Py_SIZE(b) < 0;
4265 if (negb) {
4266 z = _PyLong_New(size_b);
4267 if (z == NULL) {
4268 Py_DECREF(a);
4269 return NULL;
4270 }
4271 v_complement(z->ob_digit, b->ob_digit, size_b);
4272 b = z;
4273 }
4274 else
4275 Py_INCREF(b);
Tim Peters5af4e6c2002-08-12 02:31:19 +00004276
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004277 /* Swap a and b if necessary to ensure size_a >= size_b. */
4278 if (size_a < size_b) {
4279 z = a; a = b; b = z;
4280 size_z = size_a; size_a = size_b; size_b = size_z;
4281 negz = nega; nega = negb; negb = negz;
4282 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00004283
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004284 /* JRH: The original logic here was to allocate the result value (z)
4285 as the longer of the two operands. However, there are some cases
4286 where the result is guaranteed to be shorter than that: AND of two
4287 positives, OR of two negatives: use the shorter number. AND with
4288 mixed signs: use the positive number. OR with mixed signs: use the
4289 negative number.
4290 */
4291 switch (op) {
4292 case '^':
4293 negz = nega ^ negb;
4294 size_z = size_a;
4295 break;
4296 case '&':
4297 negz = nega & negb;
4298 size_z = negb ? size_a : size_b;
4299 break;
4300 case '|':
4301 negz = nega | negb;
4302 size_z = negb ? size_b : size_a;
4303 break;
4304 default:
4305 PyErr_BadArgument();
4306 return NULL;
4307 }
Guido van Rossumbd3a5271998-08-11 15:04:47 +00004308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004309 /* We allow an extra digit if z is negative, to make sure that
4310 the final two's complement of z doesn't overflow. */
4311 z = _PyLong_New(size_z + negz);
4312 if (z == NULL) {
4313 Py_DECREF(a);
4314 Py_DECREF(b);
4315 return NULL;
4316 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00004317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004318 /* Compute digits for overlap of a and b. */
4319 switch(op) {
4320 case '&':
4321 for (i = 0; i < size_b; ++i)
4322 z->ob_digit[i] = a->ob_digit[i] & b->ob_digit[i];
4323 break;
4324 case '|':
4325 for (i = 0; i < size_b; ++i)
4326 z->ob_digit[i] = a->ob_digit[i] | b->ob_digit[i];
4327 break;
4328 case '^':
4329 for (i = 0; i < size_b; ++i)
4330 z->ob_digit[i] = a->ob_digit[i] ^ b->ob_digit[i];
4331 break;
4332 default:
4333 PyErr_BadArgument();
4334 return NULL;
4335 }
Mark Dickinson27a87a22009-10-25 20:43:34 +00004336
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004337 /* Copy any remaining digits of a, inverting if necessary. */
4338 if (op == '^' && negb)
4339 for (; i < size_z; ++i)
4340 z->ob_digit[i] = a->ob_digit[i] ^ PyLong_MASK;
4341 else if (i < size_z)
4342 memcpy(&z->ob_digit[i], &a->ob_digit[i],
4343 (size_z-i)*sizeof(digit));
Mark Dickinson27a87a22009-10-25 20:43:34 +00004344
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004345 /* Complement result if negative. */
4346 if (negz) {
4347 Py_SIZE(z) = -(Py_SIZE(z));
4348 z->ob_digit[size_z] = PyLong_MASK;
4349 v_complement(z->ob_digit, z->ob_digit, size_z+1);
4350 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00004351
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004352 Py_DECREF(a);
4353 Py_DECREF(b);
4354 return (PyObject *)maybe_small_long(long_normalize(z));
Guido van Rossumc6913e71991-11-19 20:26:46 +00004355}
4356
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004357static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00004358long_and(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004359{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004360 PyObject *c;
4361 CHECK_BINOP(a, b);
4362 c = long_bitwise((PyLongObject*)a, '&', (PyLongObject*)b);
4363 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00004364}
4365
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004366static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00004367long_xor(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004368{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004369 PyObject *c;
4370 CHECK_BINOP(a, b);
4371 c = long_bitwise((PyLongObject*)a, '^', (PyLongObject*)b);
4372 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00004373}
4374
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004375static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00004376long_or(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004377{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004378 PyObject *c;
4379 CHECK_BINOP(a, b);
4380 c = long_bitwise((PyLongObject*)a, '|', (PyLongObject*)b);
4381 return c;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00004382}
4383
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004384static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00004385long_long(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004386{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004387 if (PyLong_CheckExact(v))
4388 Py_INCREF(v);
4389 else
4390 v = _PyLong_Copy((PyLongObject *)v);
4391 return v;
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004392}
4393
Serhiy Storchaka48e47aa2015-05-13 00:19:51 +03004394PyObject *
4395_PyLong_GCD(PyObject *aarg, PyObject *barg)
4396{
4397 PyLongObject *a, *b, *c = NULL, *d = NULL, *r;
4398 stwodigits x, y, q, s, t, c_carry, d_carry;
4399 stwodigits A, B, C, D, T;
4400 int nbits, k;
4401 Py_ssize_t size_a, size_b, alloc_a, alloc_b;
4402 digit *a_digit, *b_digit, *c_digit, *d_digit, *a_end, *b_end;
4403
4404 a = (PyLongObject *)aarg;
4405 b = (PyLongObject *)barg;
4406 size_a = Py_SIZE(a);
4407 size_b = Py_SIZE(b);
4408 if (-2 <= size_a && size_a <= 2 && -2 <= size_b && size_b <= 2) {
4409 Py_INCREF(a);
4410 Py_INCREF(b);
4411 goto simple;
4412 }
4413
4414 /* Initial reduction: make sure that 0 <= b <= a. */
4415 a = (PyLongObject *)long_abs(a);
4416 if (a == NULL)
4417 return NULL;
4418 b = (PyLongObject *)long_abs(b);
4419 if (b == NULL) {
4420 Py_DECREF(a);
4421 return NULL;
4422 }
4423 if (long_compare(a, b) < 0) {
4424 r = a;
4425 a = b;
4426 b = r;
4427 }
4428 /* We now own references to a and b */
4429
4430 alloc_a = Py_SIZE(a);
4431 alloc_b = Py_SIZE(b);
4432 /* reduce until a fits into 2 digits */
4433 while ((size_a = Py_SIZE(a)) > 2) {
4434 nbits = bits_in_digit(a->ob_digit[size_a-1]);
4435 /* extract top 2*PyLong_SHIFT bits of a into x, along with
4436 corresponding bits of b into y */
4437 size_b = Py_SIZE(b);
4438 assert(size_b <= size_a);
4439 if (size_b == 0) {
4440 if (size_a < alloc_a) {
4441 r = (PyLongObject *)_PyLong_Copy(a);
4442 Py_DECREF(a);
4443 }
4444 else
4445 r = a;
4446 Py_DECREF(b);
4447 Py_XDECREF(c);
4448 Py_XDECREF(d);
4449 return (PyObject *)r;
4450 }
4451 x = (((twodigits)a->ob_digit[size_a-1] << (2*PyLong_SHIFT-nbits)) |
4452 ((twodigits)a->ob_digit[size_a-2] << (PyLong_SHIFT-nbits)) |
4453 (a->ob_digit[size_a-3] >> nbits));
4454
4455 y = ((size_b >= size_a - 2 ? b->ob_digit[size_a-3] >> nbits : 0) |
4456 (size_b >= size_a - 1 ? (twodigits)b->ob_digit[size_a-2] << (PyLong_SHIFT-nbits) : 0) |
4457 (size_b >= size_a ? (twodigits)b->ob_digit[size_a-1] << (2*PyLong_SHIFT-nbits) : 0));
4458
4459 /* inner loop of Lehmer's algorithm; A, B, C, D never grow
4460 larger than PyLong_MASK during the algorithm. */
4461 A = 1; B = 0; C = 0; D = 1;
4462 for (k=0;; k++) {
4463 if (y-C == 0)
4464 break;
4465 q = (x+(A-1))/(y-C);
4466 s = B+q*D;
4467 t = x-q*y;
4468 if (s > t)
4469 break;
4470 x = y; y = t;
4471 t = A+q*C; A = D; B = C; C = s; D = t;
4472 }
4473
4474 if (k == 0) {
4475 /* no progress; do a Euclidean step */
4476 if (l_divmod(a, b, NULL, &r) < 0)
4477 goto error;
4478 Py_DECREF(a);
4479 a = b;
4480 b = r;
4481 alloc_a = alloc_b;
4482 alloc_b = Py_SIZE(b);
4483 continue;
4484 }
4485
4486 /*
4487 a, b = A*b-B*a, D*a-C*b if k is odd
4488 a, b = A*a-B*b, D*b-C*a if k is even
4489 */
4490 if (k&1) {
4491 T = -A; A = -B; B = T;
4492 T = -C; C = -D; D = T;
4493 }
4494 if (c != NULL)
4495 Py_SIZE(c) = size_a;
4496 else if (Py_REFCNT(a) == 1) {
4497 Py_INCREF(a);
4498 c = a;
4499 }
4500 else {
4501 alloc_a = size_a;
4502 c = _PyLong_New(size_a);
4503 if (c == NULL)
4504 goto error;
4505 }
4506
4507 if (d != NULL)
4508 Py_SIZE(d) = size_a;
4509 else if (Py_REFCNT(b) == 1 && size_a <= alloc_b) {
4510 Py_INCREF(b);
4511 d = b;
4512 Py_SIZE(d) = size_a;
4513 }
4514 else {
4515 alloc_b = size_a;
4516 d = _PyLong_New(size_a);
4517 if (d == NULL)
4518 goto error;
4519 }
4520 a_end = a->ob_digit + size_a;
4521 b_end = b->ob_digit + size_b;
4522
4523 /* compute new a and new b in parallel */
4524 a_digit = a->ob_digit;
4525 b_digit = b->ob_digit;
4526 c_digit = c->ob_digit;
4527 d_digit = d->ob_digit;
4528 c_carry = 0;
4529 d_carry = 0;
4530 while (b_digit < b_end) {
4531 c_carry += (A * *a_digit) - (B * *b_digit);
4532 d_carry += (D * *b_digit++) - (C * *a_digit++);
4533 *c_digit++ = (digit)(c_carry & PyLong_MASK);
4534 *d_digit++ = (digit)(d_carry & PyLong_MASK);
4535 c_carry >>= PyLong_SHIFT;
4536 d_carry >>= PyLong_SHIFT;
4537 }
4538 while (a_digit < a_end) {
4539 c_carry += A * *a_digit;
4540 d_carry -= C * *a_digit++;
4541 *c_digit++ = (digit)(c_carry & PyLong_MASK);
4542 *d_digit++ = (digit)(d_carry & PyLong_MASK);
4543 c_carry >>= PyLong_SHIFT;
4544 d_carry >>= PyLong_SHIFT;
4545 }
4546 assert(c_carry == 0);
4547 assert(d_carry == 0);
4548
4549 Py_INCREF(c);
4550 Py_INCREF(d);
4551 Py_DECREF(a);
4552 Py_DECREF(b);
4553 a = long_normalize(c);
4554 b = long_normalize(d);
4555 }
4556 Py_XDECREF(c);
4557 Py_XDECREF(d);
4558
4559simple:
4560 assert(Py_REFCNT(a) > 0);
4561 assert(Py_REFCNT(b) > 0);
Victor Stinner5783fd22015-09-19 13:39:03 +02004562/* Issue #24999: use two shifts instead of ">> 2*PyLong_SHIFT" to avoid
4563 undefined behaviour when LONG_MAX type is smaller than 60 bits */
4564#if LONG_MAX >> PyLong_SHIFT >> PyLong_SHIFT
Serhiy Storchaka48e47aa2015-05-13 00:19:51 +03004565 /* a fits into a long, so b must too */
4566 x = PyLong_AsLong((PyObject *)a);
4567 y = PyLong_AsLong((PyObject *)b);
Victor Stinner5783fd22015-09-19 13:39:03 +02004568#elif defined(PY_LONG_LONG) && PY_LLONG_MAX >> PyLong_SHIFT >> PyLong_SHIFT
Serhiy Storchaka48e47aa2015-05-13 00:19:51 +03004569 x = PyLong_AsLongLong((PyObject *)a);
4570 y = PyLong_AsLongLong((PyObject *)b);
4571#else
4572# error "_PyLong_GCD"
4573#endif
4574 x = Py_ABS(x);
4575 y = Py_ABS(y);
4576 Py_DECREF(a);
4577 Py_DECREF(b);
4578
4579 /* usual Euclidean algorithm for longs */
4580 while (y != 0) {
4581 t = y;
4582 y = x % y;
4583 x = t;
4584 }
Victor Stinner5783fd22015-09-19 13:39:03 +02004585#if LONG_MAX >> PyLong_SHIFT >> PyLong_SHIFT
Serhiy Storchaka48e47aa2015-05-13 00:19:51 +03004586 return PyLong_FromLong(x);
Victor Stinner5783fd22015-09-19 13:39:03 +02004587#elif defined(PY_LONG_LONG) && PY_LLONG_MAX >> PyLong_SHIFT >> PyLong_SHIFT
Serhiy Storchaka48e47aa2015-05-13 00:19:51 +03004588 return PyLong_FromLongLong(x);
4589#else
4590# error "_PyLong_GCD"
4591#endif
4592
4593error:
4594 Py_DECREF(a);
4595 Py_DECREF(b);
4596 Py_XDECREF(c);
4597 Py_XDECREF(d);
4598 return NULL;
4599}
4600
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004601static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00004602long_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004603{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004604 double result;
4605 result = PyLong_AsDouble(v);
4606 if (result == -1.0 && PyErr_Occurred())
4607 return NULL;
4608 return PyFloat_FromDouble(result);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004609}
4610
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004611static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +00004612long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004613
Tim Peters6d6c1a32001-08-02 04:15:00 +00004614static PyObject *
4615long_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
4616{
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004617 PyObject *obase = NULL, *x = NULL;
Gregory P. Smitha689e522012-12-25 22:38:32 -08004618 Py_ssize_t base;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004619 static char *kwlist[] = {"x", "base", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +00004620
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004621 if (type != &PyLong_Type)
4622 return long_subtype_new(type, args, kwds); /* Wimp out */
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004623 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OO:int", kwlist,
4624 &x, &obase))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004625 return NULL;
Serhiy Storchaka0b386d52012-12-28 09:42:11 +02004626 if (x == NULL) {
4627 if (obase != NULL) {
4628 PyErr_SetString(PyExc_TypeError,
4629 "int() missing string argument");
4630 return NULL;
4631 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004632 return PyLong_FromLong(0L);
Serhiy Storchaka0b386d52012-12-28 09:42:11 +02004633 }
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004634 if (obase == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004635 return PyNumber_Long(x);
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004636
Gregory P. Smitha689e522012-12-25 22:38:32 -08004637 base = PyNumber_AsSsize_t(obase, NULL);
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004638 if (base == -1 && PyErr_Occurred())
4639 return NULL;
Gregory P. Smitha689e522012-12-25 22:38:32 -08004640 if ((base != 0 && base < 2) || base > 36) {
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004641 PyErr_SetString(PyExc_ValueError,
Serhiy Storchaka0b386d52012-12-28 09:42:11 +02004642 "int() base must be >= 2 and <= 36");
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004643 return NULL;
4644 }
4645
4646 if (PyUnicode_Check(x))
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004647 return PyLong_FromUnicodeObject(x, (int)base);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004648 else if (PyByteArray_Check(x) || PyBytes_Check(x)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004649 char *string;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004650 if (PyByteArray_Check(x))
4651 string = PyByteArray_AS_STRING(x);
4652 else
4653 string = PyBytes_AS_STRING(x);
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03004654 return _PyLong_FromBytes(string, Py_SIZE(x), (int)base);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004655 }
4656 else {
4657 PyErr_SetString(PyExc_TypeError,
Mark Dickinson22b20182010-05-10 21:27:53 +00004658 "int() can't convert non-string with explicit base");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004659 return NULL;
4660 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004661}
4662
Serhiy Storchaka95949422013-08-27 19:40:23 +03004663/* Wimpy, slow approach to tp_new calls for subtypes of int:
4664 first create a regular int from whatever arguments we got,
Guido van Rossumbef14172001-08-29 15:47:46 +00004665 then allocate a subtype instance and initialize it from
Serhiy Storchaka95949422013-08-27 19:40:23 +03004666 the regular int. The regular int is then thrown away.
Guido van Rossumbef14172001-08-29 15:47:46 +00004667*/
4668static PyObject *
4669long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
4670{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004671 PyLongObject *tmp, *newobj;
4672 Py_ssize_t i, n;
Guido van Rossumbef14172001-08-29 15:47:46 +00004673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004674 assert(PyType_IsSubtype(type, &PyLong_Type));
4675 tmp = (PyLongObject *)long_new(&PyLong_Type, args, kwds);
4676 if (tmp == NULL)
4677 return NULL;
Serhiy Storchaka15095802015-11-25 15:47:01 +02004678 assert(PyLong_Check(tmp));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004679 n = Py_SIZE(tmp);
4680 if (n < 0)
4681 n = -n;
4682 newobj = (PyLongObject *)type->tp_alloc(type, n);
4683 if (newobj == NULL) {
4684 Py_DECREF(tmp);
4685 return NULL;
4686 }
4687 assert(PyLong_Check(newobj));
4688 Py_SIZE(newobj) = Py_SIZE(tmp);
4689 for (i = 0; i < n; i++)
4690 newobj->ob_digit[i] = tmp->ob_digit[i];
4691 Py_DECREF(tmp);
4692 return (PyObject *)newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00004693}
4694
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004695static PyObject *
4696long_getnewargs(PyLongObject *v)
4697{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004698 return Py_BuildValue("(N)", _PyLong_Copy(v));
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004699}
4700
Guido van Rossumb43daf72007-08-01 18:08:08 +00004701static PyObject *
Mark Dickinson6bf19002009-05-02 17:57:52 +00004702long_get0(PyLongObject *v, void *context) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004703 return PyLong_FromLong(0L);
Mark Dickinson6bf19002009-05-02 17:57:52 +00004704}
4705
4706static PyObject *
4707long_get1(PyLongObject *v, void *context) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004708 return PyLong_FromLong(1L);
Guido van Rossumb43daf72007-08-01 18:08:08 +00004709}
4710
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004711static PyObject *
Eric Smith8c663262007-08-25 02:26:07 +00004712long__format__(PyObject *self, PyObject *args)
4713{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004714 PyObject *format_spec;
Victor Stinnerd3f08822012-05-29 12:57:52 +02004715 _PyUnicodeWriter writer;
4716 int ret;
Eric Smith4a7d76d2008-05-30 18:10:19 +00004717
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004718 if (!PyArg_ParseTuple(args, "U:__format__", &format_spec))
4719 return NULL;
Victor Stinnerd3f08822012-05-29 12:57:52 +02004720
Victor Stinner8f674cc2013-04-17 23:02:17 +02004721 _PyUnicodeWriter_Init(&writer);
Victor Stinnerd3f08822012-05-29 12:57:52 +02004722 ret = _PyLong_FormatAdvancedWriter(
4723 &writer,
4724 self,
4725 format_spec, 0, PyUnicode_GET_LENGTH(format_spec));
4726 if (ret == -1) {
4727 _PyUnicodeWriter_Dealloc(&writer);
4728 return NULL;
4729 }
4730 return _PyUnicodeWriter_Finish(&writer);
Eric Smith8c663262007-08-25 02:26:07 +00004731}
4732
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004733/* Return a pair (q, r) such that a = b * q + r, and
4734 abs(r) <= abs(b)/2, with equality possible only if q is even.
4735 In other words, q == a / b, rounded to the nearest integer using
4736 round-half-to-even. */
4737
4738PyObject *
Mark Dickinsonfa68a612010-06-07 18:47:09 +00004739_PyLong_DivmodNear(PyObject *a, PyObject *b)
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004740{
4741 PyLongObject *quo = NULL, *rem = NULL;
4742 PyObject *one = NULL, *twice_rem, *result, *temp;
4743 int cmp, quo_is_odd, quo_is_neg;
4744
4745 /* Equivalent Python code:
4746
4747 def divmod_near(a, b):
4748 q, r = divmod(a, b)
4749 # round up if either r / b > 0.5, or r / b == 0.5 and q is odd.
4750 # The expression r / b > 0.5 is equivalent to 2 * r > b if b is
4751 # positive, 2 * r < b if b negative.
4752 greater_than_half = 2*r > b if b > 0 else 2*r < b
4753 exactly_half = 2*r == b
4754 if greater_than_half or exactly_half and q % 2 == 1:
4755 q += 1
4756 r -= b
4757 return q, r
4758
4759 */
4760 if (!PyLong_Check(a) || !PyLong_Check(b)) {
4761 PyErr_SetString(PyExc_TypeError,
4762 "non-integer arguments in division");
4763 return NULL;
4764 }
4765
4766 /* Do a and b have different signs? If so, quotient is negative. */
4767 quo_is_neg = (Py_SIZE(a) < 0) != (Py_SIZE(b) < 0);
4768
4769 one = PyLong_FromLong(1L);
4770 if (one == NULL)
4771 return NULL;
4772
4773 if (long_divrem((PyLongObject*)a, (PyLongObject*)b, &quo, &rem) < 0)
4774 goto error;
4775
4776 /* compare twice the remainder with the divisor, to see
4777 if we need to adjust the quotient and remainder */
4778 twice_rem = long_lshift((PyObject *)rem, one);
4779 if (twice_rem == NULL)
4780 goto error;
4781 if (quo_is_neg) {
4782 temp = long_neg((PyLongObject*)twice_rem);
4783 Py_DECREF(twice_rem);
4784 twice_rem = temp;
4785 if (twice_rem == NULL)
4786 goto error;
4787 }
4788 cmp = long_compare((PyLongObject *)twice_rem, (PyLongObject *)b);
4789 Py_DECREF(twice_rem);
4790
4791 quo_is_odd = Py_SIZE(quo) != 0 && ((quo->ob_digit[0] & 1) != 0);
4792 if ((Py_SIZE(b) < 0 ? cmp < 0 : cmp > 0) || (cmp == 0 && quo_is_odd)) {
4793 /* fix up quotient */
4794 if (quo_is_neg)
4795 temp = long_sub(quo, (PyLongObject *)one);
4796 else
4797 temp = long_add(quo, (PyLongObject *)one);
4798 Py_DECREF(quo);
4799 quo = (PyLongObject *)temp;
4800 if (quo == NULL)
4801 goto error;
4802 /* and remainder */
4803 if (quo_is_neg)
4804 temp = long_add(rem, (PyLongObject *)b);
4805 else
4806 temp = long_sub(rem, (PyLongObject *)b);
4807 Py_DECREF(rem);
4808 rem = (PyLongObject *)temp;
4809 if (rem == NULL)
4810 goto error;
4811 }
4812
4813 result = PyTuple_New(2);
4814 if (result == NULL)
4815 goto error;
4816
4817 /* PyTuple_SET_ITEM steals references */
4818 PyTuple_SET_ITEM(result, 0, (PyObject *)quo);
4819 PyTuple_SET_ITEM(result, 1, (PyObject *)rem);
4820 Py_DECREF(one);
4821 return result;
4822
4823 error:
4824 Py_XDECREF(quo);
4825 Py_XDECREF(rem);
4826 Py_XDECREF(one);
4827 return NULL;
4828}
4829
Eric Smith8c663262007-08-25 02:26:07 +00004830static PyObject *
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004831long_round(PyObject *self, PyObject *args)
4832{
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004833 PyObject *o_ndigits=NULL, *temp, *result, *ndigits;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004834
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004835 /* To round an integer m to the nearest 10**n (n positive), we make use of
4836 * the divmod_near operation, defined by:
4837 *
4838 * divmod_near(a, b) = (q, r)
4839 *
4840 * where q is the nearest integer to the quotient a / b (the
4841 * nearest even integer in the case of a tie) and r == a - q * b.
4842 * Hence q * b = a - r is the nearest multiple of b to a,
4843 * preferring even multiples in the case of a tie.
4844 *
4845 * So the nearest multiple of 10**n to m is:
4846 *
4847 * m - divmod_near(m, 10**n)[1].
4848 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004849 if (!PyArg_ParseTuple(args, "|O", &o_ndigits))
4850 return NULL;
4851 if (o_ndigits == NULL)
4852 return long_long(self);
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004853
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004854 ndigits = PyNumber_Index(o_ndigits);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004855 if (ndigits == NULL)
4856 return NULL;
Mark Dickinson1124e712009-01-28 21:25:58 +00004857
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004858 /* if ndigits >= 0 then no rounding is necessary; return self unchanged */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004859 if (Py_SIZE(ndigits) >= 0) {
4860 Py_DECREF(ndigits);
4861 return long_long(self);
4862 }
Mark Dickinson1124e712009-01-28 21:25:58 +00004863
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004864 /* result = self - divmod_near(self, 10 ** -ndigits)[1] */
4865 temp = long_neg((PyLongObject*)ndigits);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004866 Py_DECREF(ndigits);
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004867 ndigits = temp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004868 if (ndigits == NULL)
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004869 return NULL;
Mark Dickinson1124e712009-01-28 21:25:58 +00004870
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004871 result = PyLong_FromLong(10L);
4872 if (result == NULL) {
4873 Py_DECREF(ndigits);
4874 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004875 }
Mark Dickinson1124e712009-01-28 21:25:58 +00004876
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004877 temp = long_pow(result, ndigits, Py_None);
4878 Py_DECREF(ndigits);
4879 Py_DECREF(result);
4880 result = temp;
4881 if (result == NULL)
4882 return NULL;
4883
Mark Dickinsonfa68a612010-06-07 18:47:09 +00004884 temp = _PyLong_DivmodNear(self, result);
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004885 Py_DECREF(result);
4886 result = temp;
4887 if (result == NULL)
4888 return NULL;
4889
4890 temp = long_sub((PyLongObject *)self,
4891 (PyLongObject *)PyTuple_GET_ITEM(result, 1));
4892 Py_DECREF(result);
4893 result = temp;
4894
4895 return result;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004896}
4897
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004898static PyObject *
4899long_sizeof(PyLongObject *v)
4900{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004901 Py_ssize_t res;
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004902
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004903 res = offsetof(PyLongObject, ob_digit) + Py_ABS(Py_SIZE(v))*sizeof(digit);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004904 return PyLong_FromSsize_t(res);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004905}
4906
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004907static PyObject *
4908long_bit_length(PyLongObject *v)
4909{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004910 PyLongObject *result, *x, *y;
4911 Py_ssize_t ndigits, msd_bits = 0;
4912 digit msd;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004913
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004914 assert(v != NULL);
4915 assert(PyLong_Check(v));
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004916
Victor Stinner45e8e2f2014-05-14 17:24:35 +02004917 ndigits = Py_ABS(Py_SIZE(v));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004918 if (ndigits == 0)
4919 return PyLong_FromLong(0);
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004921 msd = v->ob_digit[ndigits-1];
4922 while (msd >= 32) {
4923 msd_bits += 6;
4924 msd >>= 6;
4925 }
4926 msd_bits += (long)(BitLengthTable[msd]);
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004927
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004928 if (ndigits <= PY_SSIZE_T_MAX/PyLong_SHIFT)
4929 return PyLong_FromSsize_t((ndigits-1)*PyLong_SHIFT + msd_bits);
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004931 /* expression above may overflow; use Python integers instead */
4932 result = (PyLongObject *)PyLong_FromSsize_t(ndigits - 1);
4933 if (result == NULL)
4934 return NULL;
4935 x = (PyLongObject *)PyLong_FromLong(PyLong_SHIFT);
4936 if (x == NULL)
4937 goto error;
4938 y = (PyLongObject *)long_mul(result, x);
4939 Py_DECREF(x);
4940 if (y == NULL)
4941 goto error;
4942 Py_DECREF(result);
4943 result = y;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004944
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004945 x = (PyLongObject *)PyLong_FromLong((long)msd_bits);
4946 if (x == NULL)
4947 goto error;
4948 y = (PyLongObject *)long_add(result, x);
4949 Py_DECREF(x);
4950 if (y == NULL)
4951 goto error;
4952 Py_DECREF(result);
4953 result = y;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004954
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004955 return (PyObject *)result;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004956
Mark Dickinson22b20182010-05-10 21:27:53 +00004957 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004958 Py_DECREF(result);
4959 return NULL;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004960}
4961
4962PyDoc_STRVAR(long_bit_length_doc,
4963"int.bit_length() -> int\n\
4964\n\
4965Number of bits necessary to represent self in binary.\n\
4966>>> bin(37)\n\
4967'0b100101'\n\
4968>>> (37).bit_length()\n\
49696");
4970
Christian Heimes53876d92008-04-19 00:31:39 +00004971#if 0
4972static PyObject *
4973long_is_finite(PyObject *v)
4974{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004975 Py_RETURN_TRUE;
Christian Heimes53876d92008-04-19 00:31:39 +00004976}
4977#endif
4978
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004979
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004980static PyObject *
4981long_to_bytes(PyLongObject *v, PyObject *args, PyObject *kwds)
4982{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004983 PyObject *byteorder_str;
4984 PyObject *is_signed_obj = NULL;
4985 Py_ssize_t length;
4986 int little_endian;
4987 int is_signed;
4988 PyObject *bytes;
4989 static char *kwlist[] = {"length", "byteorder", "signed", NULL};
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004990
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004991 if (!PyArg_ParseTupleAndKeywords(args, kwds, "nU|O:to_bytes", kwlist,
4992 &length, &byteorder_str,
4993 &is_signed_obj))
4994 return NULL;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004995
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004996 if (args != NULL && Py_SIZE(args) > 2) {
4997 PyErr_SetString(PyExc_TypeError,
4998 "'signed' is a keyword-only argument");
4999 return NULL;
5000 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005001
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005002 if (!PyUnicode_CompareWithASCIIString(byteorder_str, "little"))
5003 little_endian = 1;
5004 else if (!PyUnicode_CompareWithASCIIString(byteorder_str, "big"))
5005 little_endian = 0;
5006 else {
5007 PyErr_SetString(PyExc_ValueError,
5008 "byteorder must be either 'little' or 'big'");
5009 return NULL;
5010 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005011
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005012 if (is_signed_obj != NULL) {
5013 int cmp = PyObject_IsTrue(is_signed_obj);
5014 if (cmp < 0)
5015 return NULL;
5016 is_signed = cmp ? 1 : 0;
5017 }
5018 else {
5019 /* If the signed argument was omitted, use False as the
5020 default. */
5021 is_signed = 0;
5022 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005023
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005024 if (length < 0) {
5025 PyErr_SetString(PyExc_ValueError,
5026 "length argument must be non-negative");
5027 return NULL;
5028 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005029
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005030 bytes = PyBytes_FromStringAndSize(NULL, length);
5031 if (bytes == NULL)
5032 return NULL;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005033
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005034 if (_PyLong_AsByteArray(v, (unsigned char *)PyBytes_AS_STRING(bytes),
5035 length, little_endian, is_signed) < 0) {
5036 Py_DECREF(bytes);
5037 return NULL;
5038 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005039
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005040 return bytes;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005041}
5042
Mark Dickinson078c2532010-01-30 18:06:17 +00005043PyDoc_STRVAR(long_to_bytes_doc,
5044"int.to_bytes(length, byteorder, *, signed=False) -> bytes\n\
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005045\n\
Mark Dickinson078c2532010-01-30 18:06:17 +00005046Return an array of bytes representing an integer.\n\
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005047\n\
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005048The integer is represented using length bytes. An OverflowError is\n\
Mark Dickinson078c2532010-01-30 18:06:17 +00005049raised if the integer is not representable with the given number of\n\
5050bytes.\n\
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005051\n\
5052The byteorder argument determines the byte order used to represent the\n\
5053integer. If byteorder is 'big', the most significant byte is at the\n\
5054beginning of the byte array. If byteorder is 'little', the most\n\
5055significant byte is at the end of the byte array. To request the native\n\
5056byte order of the host system, use `sys.byteorder' as the byte order value.\n\
5057\n\
Mark Dickinson078c2532010-01-30 18:06:17 +00005058The signed keyword-only argument determines whether two's complement is\n\
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005059used to represent the integer. If signed is False and a negative integer\n\
Mark Dickinson078c2532010-01-30 18:06:17 +00005060is given, an OverflowError is raised.");
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005061
5062static PyObject *
5063long_from_bytes(PyTypeObject *type, PyObject *args, PyObject *kwds)
5064{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005065 PyObject *byteorder_str;
5066 PyObject *is_signed_obj = NULL;
5067 int little_endian;
5068 int is_signed;
5069 PyObject *obj;
5070 PyObject *bytes;
5071 PyObject *long_obj;
5072 static char *kwlist[] = {"bytes", "byteorder", "signed", NULL};
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005073
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005074 if (!PyArg_ParseTupleAndKeywords(args, kwds, "OU|O:from_bytes", kwlist,
5075 &obj, &byteorder_str,
5076 &is_signed_obj))
5077 return NULL;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005078
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005079 if (args != NULL && Py_SIZE(args) > 2) {
5080 PyErr_SetString(PyExc_TypeError,
5081 "'signed' is a keyword-only argument");
5082 return NULL;
5083 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005084
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005085 if (!PyUnicode_CompareWithASCIIString(byteorder_str, "little"))
5086 little_endian = 1;
5087 else if (!PyUnicode_CompareWithASCIIString(byteorder_str, "big"))
5088 little_endian = 0;
5089 else {
5090 PyErr_SetString(PyExc_ValueError,
5091 "byteorder must be either 'little' or 'big'");
5092 return NULL;
5093 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005094
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005095 if (is_signed_obj != NULL) {
5096 int cmp = PyObject_IsTrue(is_signed_obj);
5097 if (cmp < 0)
5098 return NULL;
5099 is_signed = cmp ? 1 : 0;
5100 }
5101 else {
5102 /* If the signed argument was omitted, use False as the
5103 default. */
5104 is_signed = 0;
5105 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005106
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005107 bytes = PyObject_Bytes(obj);
5108 if (bytes == NULL)
5109 return NULL;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005110
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005111 long_obj = _PyLong_FromByteArray(
5112 (unsigned char *)PyBytes_AS_STRING(bytes), Py_SIZE(bytes),
5113 little_endian, is_signed);
5114 Py_DECREF(bytes);
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005116 /* If from_bytes() was used on subclass, allocate new subclass
Serhiy Storchaka95949422013-08-27 19:40:23 +03005117 * instance, initialize it with decoded int value and return it.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005118 */
5119 if (type != &PyLong_Type && PyType_IsSubtype(type, &PyLong_Type)) {
5120 PyLongObject *newobj;
5121 int i;
Victor Stinner45e8e2f2014-05-14 17:24:35 +02005122 Py_ssize_t n = Py_ABS(Py_SIZE(long_obj));
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005123
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005124 newobj = (PyLongObject *)type->tp_alloc(type, n);
5125 if (newobj == NULL) {
5126 Py_DECREF(long_obj);
5127 return NULL;
5128 }
5129 assert(PyLong_Check(newobj));
5130 Py_SIZE(newobj) = Py_SIZE(long_obj);
5131 for (i = 0; i < n; i++) {
5132 newobj->ob_digit[i] =
5133 ((PyLongObject *)long_obj)->ob_digit[i];
5134 }
5135 Py_DECREF(long_obj);
5136 return (PyObject *)newobj;
5137 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005139 return long_obj;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00005140}
5141
Mark Dickinson078c2532010-01-30 18:06:17 +00005142PyDoc_STRVAR(long_from_bytes_doc,
5143"int.from_bytes(bytes, byteorder, *, signed=False) -> int\n\
5144\n\
5145Return the integer represented by the given array of bytes.\n\
5146\n\
R David Murray861470c2014-10-05 11:47:01 -04005147The bytes argument must be a bytes-like object (e.g. bytes or bytearray).\n\
Mark Dickinson078c2532010-01-30 18:06:17 +00005148\n\
5149The byteorder argument determines the byte order used to represent the\n\
5150integer. If byteorder is 'big', the most significant byte is at the\n\
5151beginning of the byte array. If byteorder is 'little', the most\n\
5152significant byte is at the end of the byte array. To request the native\n\
5153byte order of the host system, use `sys.byteorder' as the byte order value.\n\
5154\n\
5155The signed keyword-only argument indicates whether two's complement is\n\
5156used to represent the integer.");
5157
Guido van Rossum5d9113d2003-01-29 17:58:45 +00005158static PyMethodDef long_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005159 {"conjugate", (PyCFunction)long_long, METH_NOARGS,
5160 "Returns self, the complex conjugate of any int."},
5161 {"bit_length", (PyCFunction)long_bit_length, METH_NOARGS,
5162 long_bit_length_doc},
Christian Heimes53876d92008-04-19 00:31:39 +00005163#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005164 {"is_finite", (PyCFunction)long_is_finite, METH_NOARGS,
5165 "Returns always True."},
Christian Heimes53876d92008-04-19 00:31:39 +00005166#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005167 {"to_bytes", (PyCFunction)long_to_bytes,
5168 METH_VARARGS|METH_KEYWORDS, long_to_bytes_doc},
5169 {"from_bytes", (PyCFunction)long_from_bytes,
5170 METH_VARARGS|METH_KEYWORDS|METH_CLASS, long_from_bytes_doc},
5171 {"__trunc__", (PyCFunction)long_long, METH_NOARGS,
5172 "Truncating an Integral returns itself."},
5173 {"__floor__", (PyCFunction)long_long, METH_NOARGS,
5174 "Flooring an Integral returns itself."},
5175 {"__ceil__", (PyCFunction)long_long, METH_NOARGS,
5176 "Ceiling of an Integral returns itself."},
5177 {"__round__", (PyCFunction)long_round, METH_VARARGS,
5178 "Rounding an Integral returns itself.\n"
5179 "Rounding with an ndigits argument also returns an integer."},
5180 {"__getnewargs__", (PyCFunction)long_getnewargs, METH_NOARGS},
5181 {"__format__", (PyCFunction)long__format__, METH_VARARGS},
5182 {"__sizeof__", (PyCFunction)long_sizeof, METH_NOARGS,
5183 "Returns size in memory, in bytes"},
5184 {NULL, NULL} /* sentinel */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00005185};
5186
Guido van Rossumb43daf72007-08-01 18:08:08 +00005187static PyGetSetDef long_getset[] = {
Mark Dickinson6bf19002009-05-02 17:57:52 +00005188 {"real",
Guido van Rossumb43daf72007-08-01 18:08:08 +00005189 (getter)long_long, (setter)NULL,
5190 "the real part of a complex number",
5191 NULL},
Mark Dickinson6bf19002009-05-02 17:57:52 +00005192 {"imag",
5193 (getter)long_get0, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00005194 "the imaginary part of a complex number",
Mark Dickinson6bf19002009-05-02 17:57:52 +00005195 NULL},
5196 {"numerator",
Guido van Rossumb43daf72007-08-01 18:08:08 +00005197 (getter)long_long, (setter)NULL,
5198 "the numerator of a rational number in lowest terms",
5199 NULL},
Mark Dickinson6bf19002009-05-02 17:57:52 +00005200 {"denominator",
5201 (getter)long_get1, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00005202 "the denominator of a rational number in lowest terms",
Mark Dickinson6bf19002009-05-02 17:57:52 +00005203 NULL},
Guido van Rossumb43daf72007-08-01 18:08:08 +00005204 {NULL} /* Sentinel */
5205};
5206
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005207PyDoc_STRVAR(long_doc,
Chris Jerdonek83fe2e12012-10-07 14:48:36 -07005208"int(x=0) -> integer\n\
5209int(x, base=10) -> integer\n\
Tim Peters6d6c1a32001-08-02 04:15:00 +00005210\n\
Chris Jerdonek83fe2e12012-10-07 14:48:36 -07005211Convert a number or string to an integer, or return 0 if no arguments\n\
5212are given. If x is a number, return x.__int__(). For floating point\n\
5213numbers, this truncates towards zero.\n\
5214\n\
5215If x is not a number or if base is given, then x must be a string,\n\
5216bytes, or bytearray instance representing an integer literal in the\n\
5217given base. The literal can be preceded by '+' or '-' and be surrounded\n\
5218by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.\n\
5219Base 0 means to interpret the base from the string as an integer literal.\n\
5220>>> int('0b100', base=0)\n\
52214");
Tim Peters6d6c1a32001-08-02 04:15:00 +00005222
Guido van Rossumc0b618a1997-05-02 03:12:38 +00005223static PyNumberMethods long_as_number = {
Mark Dickinson22b20182010-05-10 21:27:53 +00005224 (binaryfunc)long_add, /*nb_add*/
5225 (binaryfunc)long_sub, /*nb_subtract*/
5226 (binaryfunc)long_mul, /*nb_multiply*/
5227 long_mod, /*nb_remainder*/
5228 long_divmod, /*nb_divmod*/
5229 long_pow, /*nb_power*/
5230 (unaryfunc)long_neg, /*nb_negative*/
5231 (unaryfunc)long_long, /*tp_positive*/
5232 (unaryfunc)long_abs, /*tp_absolute*/
5233 (inquiry)long_bool, /*tp_bool*/
5234 (unaryfunc)long_invert, /*nb_invert*/
5235 long_lshift, /*nb_lshift*/
5236 (binaryfunc)long_rshift, /*nb_rshift*/
5237 long_and, /*nb_and*/
5238 long_xor, /*nb_xor*/
5239 long_or, /*nb_or*/
5240 long_long, /*nb_int*/
5241 0, /*nb_reserved*/
5242 long_float, /*nb_float*/
5243 0, /* nb_inplace_add */
5244 0, /* nb_inplace_subtract */
5245 0, /* nb_inplace_multiply */
5246 0, /* nb_inplace_remainder */
5247 0, /* nb_inplace_power */
5248 0, /* nb_inplace_lshift */
5249 0, /* nb_inplace_rshift */
5250 0, /* nb_inplace_and */
5251 0, /* nb_inplace_xor */
5252 0, /* nb_inplace_or */
5253 long_div, /* nb_floor_divide */
5254 long_true_divide, /* nb_true_divide */
5255 0, /* nb_inplace_floor_divide */
5256 0, /* nb_inplace_true_divide */
5257 long_long, /* nb_index */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00005258};
5259
Guido van Rossumc0b618a1997-05-02 03:12:38 +00005260PyTypeObject PyLong_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005261 PyVarObject_HEAD_INIT(&PyType_Type, 0)
5262 "int", /* tp_name */
5263 offsetof(PyLongObject, ob_digit), /* tp_basicsize */
5264 sizeof(digit), /* tp_itemsize */
5265 long_dealloc, /* tp_dealloc */
5266 0, /* tp_print */
5267 0, /* tp_getattr */
5268 0, /* tp_setattr */
5269 0, /* tp_reserved */
5270 long_to_decimal_string, /* tp_repr */
5271 &long_as_number, /* tp_as_number */
5272 0, /* tp_as_sequence */
5273 0, /* tp_as_mapping */
5274 (hashfunc)long_hash, /* tp_hash */
5275 0, /* tp_call */
5276 long_to_decimal_string, /* tp_str */
5277 PyObject_GenericGetAttr, /* tp_getattro */
5278 0, /* tp_setattro */
5279 0, /* tp_as_buffer */
5280 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
5281 Py_TPFLAGS_LONG_SUBCLASS, /* tp_flags */
5282 long_doc, /* tp_doc */
5283 0, /* tp_traverse */
5284 0, /* tp_clear */
5285 long_richcompare, /* tp_richcompare */
5286 0, /* tp_weaklistoffset */
5287 0, /* tp_iter */
5288 0, /* tp_iternext */
5289 long_methods, /* tp_methods */
5290 0, /* tp_members */
5291 long_getset, /* tp_getset */
5292 0, /* tp_base */
5293 0, /* tp_dict */
5294 0, /* tp_descr_get */
5295 0, /* tp_descr_set */
5296 0, /* tp_dictoffset */
5297 0, /* tp_init */
5298 0, /* tp_alloc */
5299 long_new, /* tp_new */
5300 PyObject_Del, /* tp_free */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00005301};
Guido van Rossumddefaf32007-01-14 03:31:43 +00005302
Mark Dickinsonbd792642009-03-18 20:06:12 +00005303static PyTypeObject Int_InfoType;
5304
5305PyDoc_STRVAR(int_info__doc__,
5306"sys.int_info\n\
5307\n\
5308A struct sequence that holds information about Python's\n\
5309internal representation of integers. The attributes are read only.");
5310
5311static PyStructSequence_Field int_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005312 {"bits_per_digit", "size of a digit in bits"},
Mark Dickinson22b20182010-05-10 21:27:53 +00005313 {"sizeof_digit", "size in bytes of the C type used to represent a digit"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005314 {NULL, NULL}
Mark Dickinsonbd792642009-03-18 20:06:12 +00005315};
5316
5317static PyStructSequence_Desc int_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005318 "sys.int_info", /* name */
5319 int_info__doc__, /* doc */
5320 int_info_fields, /* fields */
5321 2 /* number of fields */
Mark Dickinsonbd792642009-03-18 20:06:12 +00005322};
5323
5324PyObject *
5325PyLong_GetInfo(void)
5326{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005327 PyObject* int_info;
5328 int field = 0;
5329 int_info = PyStructSequence_New(&Int_InfoType);
5330 if (int_info == NULL)
5331 return NULL;
5332 PyStructSequence_SET_ITEM(int_info, field++,
5333 PyLong_FromLong(PyLong_SHIFT));
5334 PyStructSequence_SET_ITEM(int_info, field++,
5335 PyLong_FromLong(sizeof(digit)));
5336 if (PyErr_Occurred()) {
5337 Py_CLEAR(int_info);
5338 return NULL;
5339 }
5340 return int_info;
Mark Dickinsonbd792642009-03-18 20:06:12 +00005341}
5342
Guido van Rossumddefaf32007-01-14 03:31:43 +00005343int
5344_PyLong_Init(void)
5345{
5346#if NSMALLNEGINTS + NSMALLPOSINTS > 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005347 int ival, size;
5348 PyLongObject *v = small_ints;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00005349
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005350 for (ival = -NSMALLNEGINTS; ival < NSMALLPOSINTS; ival++, v++) {
5351 size = (ival < 0) ? -1 : ((ival == 0) ? 0 : 1);
5352 if (Py_TYPE(v) == &PyLong_Type) {
5353 /* The element is already initialized, most likely
5354 * the Python interpreter was initialized before.
5355 */
5356 Py_ssize_t refcnt;
5357 PyObject* op = (PyObject*)v;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00005358
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005359 refcnt = Py_REFCNT(op) < 0 ? 0 : Py_REFCNT(op);
5360 _Py_NewReference(op);
5361 /* _Py_NewReference sets the ref count to 1 but
5362 * the ref count might be larger. Set the refcnt
5363 * to the original refcnt + 1 */
5364 Py_REFCNT(op) = refcnt + 1;
5365 assert(Py_SIZE(op) == size);
Victor Stinner12174a52014-08-15 23:17:38 +02005366 assert(v->ob_digit[0] == (digit)abs(ival));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005367 }
5368 else {
Christian Heimesd3afe782013-12-04 09:27:47 +01005369 (void)PyObject_INIT(v, &PyLong_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005370 }
5371 Py_SIZE(v) = size;
Victor Stinner12174a52014-08-15 23:17:38 +02005372 v->ob_digit[0] = (digit)abs(ival);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005373 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00005374#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005375 /* initialize int_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02005376 if (Int_InfoType.tp_name == NULL) {
5377 if (PyStructSequence_InitType2(&Int_InfoType, &int_info_desc) < 0)
5378 return 0;
5379 }
Mark Dickinsonbd792642009-03-18 20:06:12 +00005380
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005381 return 1;
Guido van Rossumddefaf32007-01-14 03:31:43 +00005382}
5383
5384void
5385PyLong_Fini(void)
5386{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005387 /* Integers are currently statically allocated. Py_DECREF is not
5388 needed, but Python must forget about the reference or multiple
5389 reinitializations will fail. */
Guido van Rossumddefaf32007-01-14 03:31:43 +00005390#if NSMALLNEGINTS + NSMALLPOSINTS > 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005391 int i;
5392 PyLongObject *v = small_ints;
5393 for (i = 0; i < NSMALLNEGINTS + NSMALLPOSINTS; i++, v++) {
5394 _Py_DEC_REFTOTAL;
5395 _Py_ForgetReference((PyObject*)v);
5396 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00005397#endif
5398}