blob: 4737787b878ec0fd21cb930a475dfd5083d04b99 [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 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000020#define MEDIUM_VALUE(x) (Py_SIZE(x) < 0 ? -(sdigit)(x)->ob_digit[0] : \
21 (Py_SIZE(x) == 0 ? (sdigit)0 : \
22 (sdigit)(x)->ob_digit[0]))
Facundo Batista6e6f59b2008-07-24 18:57:11 +000023#define ABS(x) ((x) < 0 ? -(x) : (x))
24
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
33int quick_int_allocs, quick_neg_int_allocs;
34#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{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000039 PyObject *v = (PyObject*)(small_ints + ival + NSMALLNEGINTS);
40 Py_INCREF(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +000041#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000042 if (ival >= 0)
43 quick_int_allocs++;
44 else
45 quick_neg_int_allocs++;
Guido van Rossumddefaf32007-01-14 03:31:43 +000046#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000047 return v;
Guido van Rossumddefaf32007-01-14 03:31:43 +000048}
49#define CHECK_SMALL_INT(ival) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000050 do if (-NSMALLNEGINTS <= ival && ival < NSMALLPOSINTS) { \
51 return get_small_int((sdigit)ival); \
52 } while(0)
Guido van Rossumddefaf32007-01-14 03:31:43 +000053
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000054static PyLongObject *
Facundo Batista6e6f59b2008-07-24 18:57:11 +000055maybe_small_long(PyLongObject *v)
56{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000057 if (v && ABS(Py_SIZE(v)) <= 1) {
58 sdigit ival = MEDIUM_VALUE(v);
59 if (-NSMALLNEGINTS <= ival && ival < NSMALLPOSINTS) {
60 Py_DECREF(v);
61 return (PyLongObject *)get_small_int(ival);
62 }
63 }
64 return v;
Facundo Batista6e6f59b2008-07-24 18:57:11 +000065}
Guido van Rossumddefaf32007-01-14 03:31:43 +000066#else
67#define CHECK_SMALL_INT(ival)
Facundo Batista6e6f59b2008-07-24 18:57:11 +000068#define maybe_small_long(val) (val)
Guido van Rossumddefaf32007-01-14 03:31:43 +000069#endif
70
Guido van Rossumddefaf32007-01-14 03:31:43 +000071/* If a freshly-allocated long is already shared, it must
72 be a small integer, so negating it must go to PyLong_FromLong */
73#define NEGATE(x) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000074 do if (Py_REFCNT(x) == 1) Py_SIZE(x) = -Py_SIZE(x); \
75 else { PyObject* tmp=PyLong_FromLong(-MEDIUM_VALUE(x)); \
76 Py_DECREF(x); (x) = (PyLongObject*)tmp; } \
77 while(0)
Tim Peters5af4e6c2002-08-12 02:31:19 +000078/* For long multiplication, use the O(N**2) school algorithm unless
79 * both operands contain more than KARATSUBA_CUTOFF digits (this
80 * being an internal Python long digit, in base BASE).
81 */
Tim Peters0973b992004-08-29 22:16:50 +000082#define KARATSUBA_CUTOFF 70
83#define KARATSUBA_SQUARE_CUTOFF (2 * KARATSUBA_CUTOFF)
Tim Peters5af4e6c2002-08-12 02:31:19 +000084
Tim Peters47e52ee2004-08-30 02:44:38 +000085/* For exponentiation, use the binary left-to-right algorithm
86 * unless the exponent contains more than FIVEARY_CUTOFF digits.
87 * In that case, do 5 bits at a time. The potential drawback is that
88 * a table of 2**5 intermediate results is computed.
89 */
90#define FIVEARY_CUTOFF 8
91
Tim Peters5af4e6c2002-08-12 02:31:19 +000092#undef MIN
93#undef MAX
94#define MAX(x, y) ((x) < (y) ? (y) : (x))
95#define MIN(x, y) ((x) > (y) ? (y) : (x))
96
Mark Dickinsoncdd01d22010-05-10 21:37:34 +000097#define SIGCHECK(PyTryBlock) \
98 do { \
99 if (PyErr_CheckSignals()) PyTryBlock \
100 } while(0)
Guido van Rossum23d6f0e1991-05-14 12:06:49 +0000101
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000102/* Normalize (remove leading zeros from) a long int object.
103 Doesn't attempt to free the storage--in most cases, due to the nature
104 of the algorithms used, this could save at most be one word anyway. */
105
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000106static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000107long_normalize(register PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000108{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000109 Py_ssize_t j = ABS(Py_SIZE(v));
110 Py_ssize_t i = j;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 while (i > 0 && v->ob_digit[i-1] == 0)
113 --i;
114 if (i != j)
115 Py_SIZE(v) = (Py_SIZE(v) < 0) ? -(i) : i;
116 return v;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000117}
118
119/* Allocate a new long int object with size digits.
120 Return NULL and set exception if we run out of memory. */
121
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000122#define MAX_LONG_DIGITS \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000123 ((PY_SSIZE_T_MAX - offsetof(PyLongObject, ob_digit))/sizeof(digit))
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000124
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000125PyLongObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000126_PyLong_New(Py_ssize_t size)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000127{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000128 PyLongObject *result;
129 /* Number of bytes needed is: offsetof(PyLongObject, ob_digit) +
130 sizeof(digit)*size. Previous incarnations of this code used
131 sizeof(PyVarObject) instead of the offsetof, but this risks being
132 incorrect in the presence of padding between the PyVarObject header
133 and the digits. */
134 if (size > (Py_ssize_t)MAX_LONG_DIGITS) {
135 PyErr_SetString(PyExc_OverflowError,
136 "too many digits in integer");
137 return NULL;
138 }
139 result = PyObject_MALLOC(offsetof(PyLongObject, ob_digit) +
140 size*sizeof(digit));
141 if (!result) {
142 PyErr_NoMemory();
143 return NULL;
144 }
145 return (PyLongObject*)PyObject_INIT_VAR(result, &PyLong_Type, size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000146}
147
Tim Peters64b5ce32001-09-10 20:52:51 +0000148PyObject *
149_PyLong_Copy(PyLongObject *src)
150{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000151 PyLongObject *result;
152 Py_ssize_t i;
Tim Peters64b5ce32001-09-10 20:52:51 +0000153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000154 assert(src != NULL);
155 i = Py_SIZE(src);
156 if (i < 0)
157 i = -(i);
158 if (i < 2) {
159 sdigit ival = src->ob_digit[0];
160 if (Py_SIZE(src) < 0)
161 ival = -ival;
162 CHECK_SMALL_INT(ival);
163 }
164 result = _PyLong_New(i);
165 if (result != NULL) {
166 Py_SIZE(result) = Py_SIZE(src);
167 while (--i >= 0)
168 result->ob_digit[i] = src->ob_digit[i];
169 }
170 return (PyObject *)result;
Tim Peters64b5ce32001-09-10 20:52:51 +0000171}
172
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000173/* Create a new long int object from a C long int */
174
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000175PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000176PyLong_FromLong(long ival)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000177{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000178 PyLongObject *v;
179 unsigned long abs_ival;
180 unsigned long t; /* unsigned so >> doesn't propagate sign bit */
181 int ndigits = 0;
182 int sign = 1;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000184 CHECK_SMALL_INT(ival);
Tim Petersce9de2f2001-06-14 04:56:19 +0000185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 if (ival < 0) {
187 /* negate: can't write this as abs_ival = -ival since that
188 invokes undefined behaviour when ival is LONG_MIN */
189 abs_ival = 0U-(unsigned long)ival;
190 sign = -1;
191 }
192 else {
193 abs_ival = (unsigned long)ival;
194 }
Tim Petersce9de2f2001-06-14 04:56:19 +0000195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000196 /* Fast path for single-digit ints */
197 if (!(abs_ival >> PyLong_SHIFT)) {
198 v = _PyLong_New(1);
199 if (v) {
200 Py_SIZE(v) = sign;
201 v->ob_digit[0] = Py_SAFE_DOWNCAST(
202 abs_ival, unsigned long, digit);
203 }
204 return (PyObject*)v;
205 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000206
Mark Dickinson249b8982009-04-27 19:41:00 +0000207#if PyLong_SHIFT==15
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000208 /* 2 digits */
209 if (!(abs_ival >> 2*PyLong_SHIFT)) {
210 v = _PyLong_New(2);
211 if (v) {
212 Py_SIZE(v) = 2*sign;
213 v->ob_digit[0] = Py_SAFE_DOWNCAST(
214 abs_ival & PyLong_MASK, unsigned long, digit);
215 v->ob_digit[1] = Py_SAFE_DOWNCAST(
216 abs_ival >> PyLong_SHIFT, unsigned long, digit);
217 }
218 return (PyObject*)v;
219 }
Mark Dickinsonbd792642009-03-18 20:06:12 +0000220#endif
Guido van Rossumddefaf32007-01-14 03:31:43 +0000221
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000222 /* Larger numbers: loop to determine number of digits */
223 t = abs_ival;
224 while (t) {
225 ++ndigits;
226 t >>= PyLong_SHIFT;
227 }
228 v = _PyLong_New(ndigits);
229 if (v != NULL) {
230 digit *p = v->ob_digit;
231 Py_SIZE(v) = ndigits*sign;
232 t = abs_ival;
233 while (t) {
234 *p++ = Py_SAFE_DOWNCAST(
235 t & PyLong_MASK, unsigned long, digit);
236 t >>= PyLong_SHIFT;
237 }
238 }
239 return (PyObject *)v;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000240}
241
Guido van Rossum53756b11997-01-03 17:14:46 +0000242/* Create a new long int object from a C unsigned long int */
243
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000244PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000245PyLong_FromUnsignedLong(unsigned long ival)
Guido van Rossum53756b11997-01-03 17:14:46 +0000246{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000247 PyLongObject *v;
248 unsigned long t;
249 int ndigits = 0;
Tim Petersce9de2f2001-06-14 04:56:19 +0000250
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000251 if (ival < PyLong_BASE)
252 return PyLong_FromLong(ival);
253 /* Count the number of Python digits. */
254 t = (unsigned long)ival;
255 while (t) {
256 ++ndigits;
257 t >>= PyLong_SHIFT;
258 }
259 v = _PyLong_New(ndigits);
260 if (v != NULL) {
261 digit *p = v->ob_digit;
262 Py_SIZE(v) = ndigits;
263 while (ival) {
264 *p++ = (digit)(ival & PyLong_MASK);
265 ival >>= PyLong_SHIFT;
266 }
267 }
268 return (PyObject *)v;
Guido van Rossum53756b11997-01-03 17:14:46 +0000269}
270
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000271/* Create a new long int object from a C double */
272
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000273PyObject *
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000274PyLong_FromDouble(double dval)
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000275{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000276 PyLongObject *v;
277 double frac;
278 int i, ndig, expo, neg;
279 neg = 0;
280 if (Py_IS_INFINITY(dval)) {
281 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson22b20182010-05-10 21:27:53 +0000282 "cannot convert float infinity to integer");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000283 return NULL;
284 }
285 if (Py_IS_NAN(dval)) {
286 PyErr_SetString(PyExc_ValueError,
Mark Dickinson22b20182010-05-10 21:27:53 +0000287 "cannot convert float NaN to integer");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000288 return NULL;
289 }
290 if (dval < 0.0) {
291 neg = 1;
292 dval = -dval;
293 }
294 frac = frexp(dval, &expo); /* dval = frac*2**expo; 0.0 <= frac < 1.0 */
295 if (expo <= 0)
296 return PyLong_FromLong(0L);
297 ndig = (expo-1) / PyLong_SHIFT + 1; /* Number of 'digits' in result */
298 v = _PyLong_New(ndig);
299 if (v == NULL)
300 return NULL;
301 frac = ldexp(frac, (expo-1) % PyLong_SHIFT + 1);
302 for (i = ndig; --i >= 0; ) {
303 digit bits = (digit)frac;
304 v->ob_digit[i] = bits;
305 frac = frac - (double)bits;
306 frac = ldexp(frac, PyLong_SHIFT);
307 }
308 if (neg)
309 Py_SIZE(v) = -(Py_SIZE(v));
310 return (PyObject *)v;
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000311}
312
Thomas Wouters89f507f2006-12-13 04:49:30 +0000313/* Checking for overflow in PyLong_AsLong is a PITA since C doesn't define
314 * anything about what happens when a signed integer operation overflows,
315 * and some compilers think they're doing you a favor by being "clever"
316 * then. The bit pattern for the largest postive signed long is
317 * (unsigned long)LONG_MAX, and for the smallest negative signed long
318 * it is abs(LONG_MIN), which we could write -(unsigned long)LONG_MIN.
319 * However, some other compilers warn about applying unary minus to an
320 * unsigned operand. Hence the weird "0-".
321 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000322#define PY_ABS_LONG_MIN (0-(unsigned long)LONG_MIN)
323#define PY_ABS_SSIZE_T_MIN (0-(size_t)PY_SSIZE_T_MIN)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000324
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000325/* Get a C long int from a long int object.
326 Returns -1 and sets an error condition if overflow occurs. */
327
328long
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000329PyLong_AsLongAndOverflow(PyObject *vv, int *overflow)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000330{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000331 /* This version by Tim Peters */
332 register PyLongObject *v;
333 unsigned long x, prev;
334 long res;
335 Py_ssize_t i;
336 int sign;
337 int do_decref = 0; /* if nb_int was called */
Guido van Rossumf7531811998-05-26 14:33:37 +0000338
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 *overflow = 0;
340 if (vv == NULL) {
341 PyErr_BadInternalCall();
342 return -1;
343 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000344
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000345 if (!PyLong_Check(vv)) {
346 PyNumberMethods *nb;
347 nb = vv->ob_type->tp_as_number;
348 if (nb == NULL || nb->nb_int == NULL) {
349 PyErr_SetString(PyExc_TypeError,
350 "an integer is required");
351 return -1;
352 }
353 vv = (*nb->nb_int) (vv);
354 if (vv == NULL)
355 return -1;
356 do_decref = 1;
357 if (!PyLong_Check(vv)) {
358 Py_DECREF(vv);
359 PyErr_SetString(PyExc_TypeError,
360 "nb_int should return int object");
361 return -1;
362 }
363 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000365 res = -1;
366 v = (PyLongObject *)vv;
367 i = Py_SIZE(v);
Guido van Rossumf7531811998-05-26 14:33:37 +0000368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 switch (i) {
370 case -1:
371 res = -(sdigit)v->ob_digit[0];
372 break;
373 case 0:
374 res = 0;
375 break;
376 case 1:
377 res = v->ob_digit[0];
378 break;
379 default:
380 sign = 1;
381 x = 0;
382 if (i < 0) {
383 sign = -1;
384 i = -(i);
385 }
386 while (--i >= 0) {
387 prev = x;
388 x = (x << PyLong_SHIFT) | v->ob_digit[i];
389 if ((x >> PyLong_SHIFT) != prev) {
390 *overflow = sign;
391 goto exit;
392 }
393 }
394 /* Haven't lost any bits, but casting to long requires extra
395 * care (see comment above).
396 */
397 if (x <= (unsigned long)LONG_MAX) {
398 res = (long)x * sign;
399 }
400 else if (sign < 0 && x == PY_ABS_LONG_MIN) {
401 res = LONG_MIN;
402 }
403 else {
404 *overflow = sign;
405 /* res is already set to -1 */
406 }
407 }
Mark Dickinson22b20182010-05-10 21:27:53 +0000408 exit:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 if (do_decref) {
410 Py_DECREF(vv);
411 }
412 return res;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000413}
414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000415long
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000416PyLong_AsLong(PyObject *obj)
417{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000418 int overflow;
419 long result = PyLong_AsLongAndOverflow(obj, &overflow);
420 if (overflow) {
421 /* XXX: could be cute and give a different
422 message for overflow == -1 */
423 PyErr_SetString(PyExc_OverflowError,
424 "Python int too large to convert to C long");
425 }
426 return result;
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000427}
428
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000429/* Get a Py_ssize_t from a long int object.
430 Returns -1 and sets an error condition if overflow occurs. */
431
432Py_ssize_t
Guido van Rossumddefaf32007-01-14 03:31:43 +0000433PyLong_AsSsize_t(PyObject *vv) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000434 register PyLongObject *v;
435 size_t x, prev;
436 Py_ssize_t i;
437 int sign;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000439 if (vv == NULL) {
440 PyErr_BadInternalCall();
441 return -1;
442 }
443 if (!PyLong_Check(vv)) {
444 PyErr_SetString(PyExc_TypeError, "an integer is required");
445 return -1;
446 }
Mark Dickinsond59b4162010-03-13 11:34:40 +0000447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000448 v = (PyLongObject *)vv;
449 i = Py_SIZE(v);
450 switch (i) {
451 case -1: return -(sdigit)v->ob_digit[0];
452 case 0: return 0;
453 case 1: return v->ob_digit[0];
454 }
455 sign = 1;
456 x = 0;
457 if (i < 0) {
458 sign = -1;
459 i = -(i);
460 }
461 while (--i >= 0) {
462 prev = x;
463 x = (x << PyLong_SHIFT) | v->ob_digit[i];
464 if ((x >> PyLong_SHIFT) != prev)
465 goto overflow;
466 }
467 /* Haven't lost any bits, but casting to a signed type requires
468 * extra care (see comment above).
469 */
470 if (x <= (size_t)PY_SSIZE_T_MAX) {
471 return (Py_ssize_t)x * sign;
472 }
473 else if (sign < 0 && x == PY_ABS_SSIZE_T_MIN) {
474 return PY_SSIZE_T_MIN;
475 }
476 /* else overflow */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000477
Mark Dickinson22b20182010-05-10 21:27:53 +0000478 overflow:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000479 PyErr_SetString(PyExc_OverflowError,
480 "Python int too large to convert to C ssize_t");
481 return -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000482}
483
Guido van Rossumd8c80482002-08-13 00:24:58 +0000484/* Get a C unsigned long int from a long int object.
Guido van Rossum53756b11997-01-03 17:14:46 +0000485 Returns -1 and sets an error condition if overflow occurs. */
486
487unsigned long
Tim Peters9f688bf2000-07-07 15:53:28 +0000488PyLong_AsUnsignedLong(PyObject *vv)
Guido van Rossum53756b11997-01-03 17:14:46 +0000489{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000490 register PyLongObject *v;
491 unsigned long x, prev;
492 Py_ssize_t i;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000494 if (vv == NULL) {
495 PyErr_BadInternalCall();
496 return (unsigned long)-1;
497 }
498 if (!PyLong_Check(vv)) {
499 PyErr_SetString(PyExc_TypeError, "an integer is required");
500 return (unsigned long)-1;
501 }
Mark Dickinsond59b4162010-03-13 11:34:40 +0000502
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000503 v = (PyLongObject *)vv;
504 i = Py_SIZE(v);
505 x = 0;
506 if (i < 0) {
507 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson22b20182010-05-10 21:27:53 +0000508 "can't convert negative value to unsigned int");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000509 return (unsigned long) -1;
510 }
511 switch (i) {
512 case 0: return 0;
513 case 1: return v->ob_digit[0];
514 }
515 while (--i >= 0) {
516 prev = x;
517 x = (x << PyLong_SHIFT) | v->ob_digit[i];
518 if ((x >> PyLong_SHIFT) != prev) {
519 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson22b20182010-05-10 21:27:53 +0000520 "python int too large to convert "
521 "to C unsigned long");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000522 return (unsigned long) -1;
523 }
524 }
525 return x;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000526}
527
528/* Get a C unsigned long int from a long int object.
529 Returns -1 and sets an error condition if overflow occurs. */
530
531size_t
532PyLong_AsSize_t(PyObject *vv)
533{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000534 register PyLongObject *v;
535 size_t x, prev;
536 Py_ssize_t i;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 if (vv == NULL) {
539 PyErr_BadInternalCall();
540 return (size_t) -1;
541 }
542 if (!PyLong_Check(vv)) {
543 PyErr_SetString(PyExc_TypeError, "an integer is required");
544 return (size_t)-1;
545 }
Mark Dickinsond59b4162010-03-13 11:34:40 +0000546
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000547 v = (PyLongObject *)vv;
548 i = Py_SIZE(v);
549 x = 0;
550 if (i < 0) {
551 PyErr_SetString(PyExc_OverflowError,
552 "can't convert negative value to size_t");
553 return (size_t) -1;
554 }
555 switch (i) {
556 case 0: return 0;
557 case 1: return v->ob_digit[0];
558 }
559 while (--i >= 0) {
560 prev = x;
561 x = (x << PyLong_SHIFT) | v->ob_digit[i];
562 if ((x >> PyLong_SHIFT) != prev) {
563 PyErr_SetString(PyExc_OverflowError,
564 "Python int too large to convert to C size_t");
565 return (unsigned long) -1;
566 }
567 }
568 return x;
Guido van Rossum53756b11997-01-03 17:14:46 +0000569}
570
Thomas Hellera4ea6032003-04-17 18:55:45 +0000571/* Get a C unsigned long int from a long int object, ignoring the high bits.
572 Returns -1 and sets an error condition if an error occurs. */
573
Guido van Rossumddefaf32007-01-14 03:31:43 +0000574static unsigned long
575_PyLong_AsUnsignedLongMask(PyObject *vv)
Thomas Hellera4ea6032003-04-17 18:55:45 +0000576{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000577 register PyLongObject *v;
578 unsigned long x;
579 Py_ssize_t i;
580 int sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +0000581
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000582 if (vv == NULL || !PyLong_Check(vv)) {
583 PyErr_BadInternalCall();
584 return (unsigned long) -1;
585 }
586 v = (PyLongObject *)vv;
587 i = Py_SIZE(v);
588 switch (i) {
589 case 0: return 0;
590 case 1: return v->ob_digit[0];
591 }
592 sign = 1;
593 x = 0;
594 if (i < 0) {
595 sign = -1;
596 i = -i;
597 }
598 while (--i >= 0) {
599 x = (x << PyLong_SHIFT) | v->ob_digit[i];
600 }
601 return x * sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +0000602}
603
Guido van Rossumddefaf32007-01-14 03:31:43 +0000604unsigned long
605PyLong_AsUnsignedLongMask(register PyObject *op)
606{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000607 PyNumberMethods *nb;
608 PyLongObject *lo;
609 unsigned long val;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000611 if (op && PyLong_Check(op))
612 return _PyLong_AsUnsignedLongMask(op);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000613
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000614 if (op == NULL || (nb = op->ob_type->tp_as_number) == NULL ||
615 nb->nb_int == NULL) {
616 PyErr_SetString(PyExc_TypeError, "an integer is required");
617 return (unsigned long)-1;
618 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000619
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000620 lo = (PyLongObject*) (*nb->nb_int) (op);
621 if (lo == NULL)
622 return (unsigned long)-1;
623 if (PyLong_Check(lo)) {
624 val = _PyLong_AsUnsignedLongMask((PyObject *)lo);
625 Py_DECREF(lo);
626 if (PyErr_Occurred())
627 return (unsigned long)-1;
628 return val;
629 }
630 else
631 {
632 Py_DECREF(lo);
633 PyErr_SetString(PyExc_TypeError,
634 "nb_int should return int object");
635 return (unsigned long)-1;
636 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000637}
638
Tim Peters5b8132f2003-01-31 15:52:05 +0000639int
640_PyLong_Sign(PyObject *vv)
641{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000642 PyLongObject *v = (PyLongObject *)vv;
Tim Peters5b8132f2003-01-31 15:52:05 +0000643
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000644 assert(v != NULL);
645 assert(PyLong_Check(v));
Tim Peters5b8132f2003-01-31 15:52:05 +0000646
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000647 return Py_SIZE(v) == 0 ? 0 : (Py_SIZE(v) < 0 ? -1 : 1);
Tim Peters5b8132f2003-01-31 15:52:05 +0000648}
649
Tim Petersbaefd9e2003-01-28 20:37:45 +0000650size_t
651_PyLong_NumBits(PyObject *vv)
652{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000653 PyLongObject *v = (PyLongObject *)vv;
654 size_t result = 0;
655 Py_ssize_t ndigits;
Tim Petersbaefd9e2003-01-28 20:37:45 +0000656
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000657 assert(v != NULL);
658 assert(PyLong_Check(v));
659 ndigits = ABS(Py_SIZE(v));
660 assert(ndigits == 0 || v->ob_digit[ndigits - 1] != 0);
661 if (ndigits > 0) {
662 digit msd = v->ob_digit[ndigits - 1];
Tim Petersbaefd9e2003-01-28 20:37:45 +0000663
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000664 result = (ndigits - 1) * PyLong_SHIFT;
665 if (result / PyLong_SHIFT != (size_t)(ndigits - 1))
666 goto Overflow;
667 do {
668 ++result;
669 if (result == 0)
670 goto Overflow;
671 msd >>= 1;
672 } while (msd);
673 }
674 return result;
Tim Petersbaefd9e2003-01-28 20:37:45 +0000675
Mark Dickinson22b20182010-05-10 21:27:53 +0000676 Overflow:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000677 PyErr_SetString(PyExc_OverflowError, "int has too many bits "
678 "to express in a platform size_t");
679 return (size_t)-1;
Tim Petersbaefd9e2003-01-28 20:37:45 +0000680}
681
Tim Peters2a9b3672001-06-11 21:23:58 +0000682PyObject *
683_PyLong_FromByteArray(const unsigned char* bytes, size_t n,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000684 int little_endian, int is_signed)
Tim Peters2a9b3672001-06-11 21:23:58 +0000685{
Mark Dickinson22b20182010-05-10 21:27:53 +0000686 const unsigned char* pstartbyte; /* LSB of bytes */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 int incr; /* direction to move pstartbyte */
688 const unsigned char* pendbyte; /* MSB of bytes */
689 size_t numsignificantbytes; /* number of bytes that matter */
690 Py_ssize_t ndigits; /* number of Python long digits */
691 PyLongObject* v; /* result */
692 Py_ssize_t idigit = 0; /* next free index in v->ob_digit */
Tim Peters2a9b3672001-06-11 21:23:58 +0000693
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000694 if (n == 0)
695 return PyLong_FromLong(0L);
Tim Peters2a9b3672001-06-11 21:23:58 +0000696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 if (little_endian) {
698 pstartbyte = bytes;
699 pendbyte = bytes + n - 1;
700 incr = 1;
701 }
702 else {
703 pstartbyte = bytes + n - 1;
704 pendbyte = bytes;
705 incr = -1;
706 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000707
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000708 if (is_signed)
709 is_signed = *pendbyte >= 0x80;
Tim Peters2a9b3672001-06-11 21:23:58 +0000710
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 /* Compute numsignificantbytes. This consists of finding the most
712 significant byte. Leading 0 bytes are insignficant if the number
713 is positive, and leading 0xff bytes if negative. */
714 {
715 size_t i;
716 const unsigned char* p = pendbyte;
717 const int pincr = -incr; /* search MSB to LSB */
718 const unsigned char insignficant = is_signed ? 0xff : 0x00;
Tim Peters2a9b3672001-06-11 21:23:58 +0000719
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000720 for (i = 0; i < n; ++i, p += pincr) {
721 if (*p != insignficant)
722 break;
723 }
724 numsignificantbytes = n - i;
725 /* 2's-comp is a bit tricky here, e.g. 0xff00 == -0x0100, so
726 actually has 2 significant bytes. OTOH, 0xff0001 ==
727 -0x00ffff, so we wouldn't *need* to bump it there; but we
728 do for 0xffff = -0x0001. To be safe without bothering to
729 check every case, bump it regardless. */
730 if (is_signed && numsignificantbytes < n)
731 ++numsignificantbytes;
732 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 /* How many Python long digits do we need? We have
735 8*numsignificantbytes bits, and each Python long digit has
736 PyLong_SHIFT bits, so it's the ceiling of the quotient. */
737 /* catch overflow before it happens */
738 if (numsignificantbytes > (PY_SSIZE_T_MAX - PyLong_SHIFT) / 8) {
739 PyErr_SetString(PyExc_OverflowError,
740 "byte array too long to convert to int");
741 return NULL;
742 }
743 ndigits = (numsignificantbytes * 8 + PyLong_SHIFT - 1) / PyLong_SHIFT;
744 v = _PyLong_New(ndigits);
745 if (v == NULL)
746 return NULL;
Tim Peters2a9b3672001-06-11 21:23:58 +0000747
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000748 /* Copy the bits over. The tricky parts are computing 2's-comp on
749 the fly for signed numbers, and dealing with the mismatch between
750 8-bit bytes and (probably) 15-bit Python digits.*/
751 {
752 size_t i;
753 twodigits carry = 1; /* for 2's-comp calculation */
754 twodigits accum = 0; /* sliding register */
755 unsigned int accumbits = 0; /* number of bits in accum */
756 const unsigned char* p = pstartbyte;
Tim Peters2a9b3672001-06-11 21:23:58 +0000757
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000758 for (i = 0; i < numsignificantbytes; ++i, p += incr) {
759 twodigits thisbyte = *p;
760 /* Compute correction for 2's comp, if needed. */
761 if (is_signed) {
762 thisbyte = (0xff ^ thisbyte) + carry;
763 carry = thisbyte >> 8;
764 thisbyte &= 0xff;
765 }
766 /* Because we're going LSB to MSB, thisbyte is
767 more significant than what's already in accum,
768 so needs to be prepended to accum. */
769 accum |= (twodigits)thisbyte << accumbits;
770 accumbits += 8;
771 if (accumbits >= PyLong_SHIFT) {
772 /* There's enough to fill a Python digit. */
773 assert(idigit < ndigits);
Mark Dickinson22b20182010-05-10 21:27:53 +0000774 v->ob_digit[idigit] = (digit)(accum & PyLong_MASK);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000775 ++idigit;
776 accum >>= PyLong_SHIFT;
777 accumbits -= PyLong_SHIFT;
778 assert(accumbits < PyLong_SHIFT);
779 }
780 }
781 assert(accumbits < PyLong_SHIFT);
782 if (accumbits) {
783 assert(idigit < ndigits);
784 v->ob_digit[idigit] = (digit)accum;
785 ++idigit;
786 }
787 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000788
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000789 Py_SIZE(v) = is_signed ? -idigit : idigit;
790 return (PyObject *)long_normalize(v);
Tim Peters2a9b3672001-06-11 21:23:58 +0000791}
792
793int
794_PyLong_AsByteArray(PyLongObject* v,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000795 unsigned char* bytes, size_t n,
796 int little_endian, int is_signed)
Tim Peters2a9b3672001-06-11 21:23:58 +0000797{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000798 Py_ssize_t i; /* index into v->ob_digit */
Mark Dickinson22b20182010-05-10 21:27:53 +0000799 Py_ssize_t ndigits; /* |v->ob_size| */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000800 twodigits accum; /* sliding register */
Mark Dickinson22b20182010-05-10 21:27:53 +0000801 unsigned int accumbits; /* # bits in accum */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000802 int do_twos_comp; /* store 2's-comp? is_signed and v < 0 */
803 digit carry; /* for computing 2's-comp */
804 size_t j; /* # bytes filled */
805 unsigned char* p; /* pointer to next byte in bytes */
806 int pincr; /* direction to move p */
Tim Peters2a9b3672001-06-11 21:23:58 +0000807
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 assert(v != NULL && PyLong_Check(v));
Tim Peters2a9b3672001-06-11 21:23:58 +0000809
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000810 if (Py_SIZE(v) < 0) {
811 ndigits = -(Py_SIZE(v));
812 if (!is_signed) {
813 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson22b20182010-05-10 21:27:53 +0000814 "can't convert negative int to unsigned");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000815 return -1;
816 }
817 do_twos_comp = 1;
818 }
819 else {
820 ndigits = Py_SIZE(v);
821 do_twos_comp = 0;
822 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000823
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 if (little_endian) {
825 p = bytes;
826 pincr = 1;
827 }
828 else {
829 p = bytes + n - 1;
830 pincr = -1;
831 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000832
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000833 /* Copy over all the Python digits.
834 It's crucial that every Python digit except for the MSD contribute
835 exactly PyLong_SHIFT bits to the total, so first assert that the long is
836 normalized. */
837 assert(ndigits == 0 || v->ob_digit[ndigits - 1] != 0);
838 j = 0;
839 accum = 0;
840 accumbits = 0;
841 carry = do_twos_comp ? 1 : 0;
842 for (i = 0; i < ndigits; ++i) {
843 digit thisdigit = v->ob_digit[i];
844 if (do_twos_comp) {
845 thisdigit = (thisdigit ^ PyLong_MASK) + carry;
846 carry = thisdigit >> PyLong_SHIFT;
847 thisdigit &= PyLong_MASK;
848 }
849 /* Because we're going LSB to MSB, thisdigit is more
850 significant than what's already in accum, so needs to be
851 prepended to accum. */
852 accum |= (twodigits)thisdigit << accumbits;
Tim Peters8bc84b42001-06-12 19:17:03 +0000853
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000854 /* The most-significant digit may be (probably is) at least
855 partly empty. */
856 if (i == ndigits - 1) {
857 /* Count # of sign bits -- they needn't be stored,
858 * although for signed conversion we need later to
859 * make sure at least one sign bit gets stored. */
Mark Dickinson22b20182010-05-10 21:27:53 +0000860 digit s = do_twos_comp ? thisdigit ^ PyLong_MASK : thisdigit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 while (s != 0) {
862 s >>= 1;
863 accumbits++;
864 }
865 }
866 else
867 accumbits += PyLong_SHIFT;
Tim Peters8bc84b42001-06-12 19:17:03 +0000868
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 /* Store as many bytes as possible. */
870 while (accumbits >= 8) {
871 if (j >= n)
872 goto Overflow;
873 ++j;
874 *p = (unsigned char)(accum & 0xff);
875 p += pincr;
876 accumbits -= 8;
877 accum >>= 8;
878 }
879 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000880
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 /* Store the straggler (if any). */
882 assert(accumbits < 8);
883 assert(carry == 0); /* else do_twos_comp and *every* digit was 0 */
884 if (accumbits > 0) {
885 if (j >= n)
886 goto Overflow;
887 ++j;
888 if (do_twos_comp) {
889 /* Fill leading bits of the byte with sign bits
890 (appropriately pretending that the long had an
891 infinite supply of sign bits). */
892 accum |= (~(twodigits)0) << accumbits;
893 }
894 *p = (unsigned char)(accum & 0xff);
895 p += pincr;
896 }
897 else if (j == n && n > 0 && is_signed) {
898 /* The main loop filled the byte array exactly, so the code
899 just above didn't get to ensure there's a sign bit, and the
900 loop below wouldn't add one either. Make sure a sign bit
901 exists. */
902 unsigned char msb = *(p - pincr);
903 int sign_bit_set = msb >= 0x80;
904 assert(accumbits == 0);
905 if (sign_bit_set == do_twos_comp)
906 return 0;
907 else
908 goto Overflow;
909 }
Tim Peters05607ad2001-06-13 21:01:27 +0000910
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000911 /* Fill remaining bytes with copies of the sign bit. */
912 {
913 unsigned char signbyte = do_twos_comp ? 0xffU : 0U;
914 for ( ; j < n; ++j, p += pincr)
915 *p = signbyte;
916 }
Tim Peters05607ad2001-06-13 21:01:27 +0000917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 return 0;
Tim Peters2a9b3672001-06-11 21:23:58 +0000919
Mark Dickinson22b20182010-05-10 21:27:53 +0000920 Overflow:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000921 PyErr_SetString(PyExc_OverflowError, "int too big to convert");
922 return -1;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000923
Tim Peters2a9b3672001-06-11 21:23:58 +0000924}
925
Guido van Rossum78694d91998-09-18 14:14:13 +0000926/* Create a new long (or int) object from a C pointer */
927
928PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000929PyLong_FromVoidPtr(void *p)
Guido van Rossum78694d91998-09-18 14:14:13 +0000930{
Tim Peters70128a12001-06-16 08:48:40 +0000931#ifndef HAVE_LONG_LONG
932# error "PyLong_FromVoidPtr: sizeof(void*) > sizeof(long), but no long long"
933#endif
934#if SIZEOF_LONG_LONG < SIZEOF_VOID_P
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000935# error "PyLong_FromVoidPtr: sizeof(PY_LONG_LONG) < sizeof(void*)"
Tim Peters70128a12001-06-16 08:48:40 +0000936#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000937 /* special-case null pointer */
938 if (!p)
939 return PyLong_FromLong(0);
940 return PyLong_FromUnsignedLongLong((unsigned PY_LONG_LONG)(Py_uintptr_t)p);
Tim Peters70128a12001-06-16 08:48:40 +0000941
Guido van Rossum78694d91998-09-18 14:14:13 +0000942}
943
944/* Get a C pointer from a long object (or an int object in some cases) */
945
946void *
Tim Peters9f688bf2000-07-07 15:53:28 +0000947PyLong_AsVoidPtr(PyObject *vv)
Guido van Rossum78694d91998-09-18 14:14:13 +0000948{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 /* This function will allow int or long objects. If vv is neither,
950 then the PyLong_AsLong*() functions will raise the exception:
951 PyExc_SystemError, "bad argument to internal function"
952 */
Tim Peters70128a12001-06-16 08:48:40 +0000953#if SIZEOF_VOID_P <= SIZEOF_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000954 long x;
Guido van Rossum78694d91998-09-18 14:14:13 +0000955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 if (PyLong_Check(vv) && _PyLong_Sign(vv) < 0)
957 x = PyLong_AsLong(vv);
958 else
959 x = PyLong_AsUnsignedLong(vv);
Guido van Rossum78694d91998-09-18 14:14:13 +0000960#else
Tim Peters70128a12001-06-16 08:48:40 +0000961
962#ifndef HAVE_LONG_LONG
963# error "PyLong_AsVoidPtr: sizeof(void*) > sizeof(long), but no long long"
964#endif
965#if SIZEOF_LONG_LONG < SIZEOF_VOID_P
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000966# error "PyLong_AsVoidPtr: sizeof(PY_LONG_LONG) < sizeof(void*)"
Tim Peters70128a12001-06-16 08:48:40 +0000967#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 PY_LONG_LONG x;
Guido van Rossum78694d91998-09-18 14:14:13 +0000969
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 if (PyLong_Check(vv) && _PyLong_Sign(vv) < 0)
971 x = PyLong_AsLongLong(vv);
972 else
973 x = PyLong_AsUnsignedLongLong(vv);
Tim Peters70128a12001-06-16 08:48:40 +0000974
975#endif /* SIZEOF_VOID_P <= SIZEOF_LONG */
Guido van Rossum78694d91998-09-18 14:14:13 +0000976
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000977 if (x == -1 && PyErr_Occurred())
978 return NULL;
979 return (void *)x;
Guido van Rossum78694d91998-09-18 14:14:13 +0000980}
981
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000982#ifdef HAVE_LONG_LONG
Tim Petersd1a7da62001-06-13 00:35:57 +0000983
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000984/* Initial PY_LONG_LONG support by Chris Herborth (chrish@qnx.com), later
Tim Petersd1a7da62001-06-13 00:35:57 +0000985 * rewritten to use the newer PyLong_{As,From}ByteArray API.
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000986 */
987
Tim Peterscf37dfc2001-06-14 18:42:50 +0000988#define IS_LITTLE_ENDIAN (int)*(unsigned char*)&one
Mark Dickinson22b20182010-05-10 21:27:53 +0000989#define PY_ABS_LLONG_MIN (0-(unsigned PY_LONG_LONG)PY_LLONG_MIN)
Tim Petersd1a7da62001-06-13 00:35:57 +0000990
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000991/* Create a new long int object from a C PY_LONG_LONG int. */
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000992
993PyObject *
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000994PyLong_FromLongLong(PY_LONG_LONG ival)
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000995{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000996 PyLongObject *v;
997 unsigned PY_LONG_LONG abs_ival;
998 unsigned PY_LONG_LONG t; /* unsigned so >> doesn't propagate sign bit */
999 int ndigits = 0;
1000 int negative = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001001
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001002 CHECK_SMALL_INT(ival);
1003 if (ival < 0) {
1004 /* avoid signed overflow on negation; see comments
1005 in PyLong_FromLong above. */
1006 abs_ival = (unsigned PY_LONG_LONG)(-1-ival) + 1;
1007 negative = 1;
1008 }
1009 else {
1010 abs_ival = (unsigned PY_LONG_LONG)ival;
1011 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001012
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001013 /* Count the number of Python digits.
1014 We used to pick 5 ("big enough for anything"), but that's a
1015 waste of time and space given that 5*15 = 75 bits are rarely
1016 needed. */
1017 t = abs_ival;
1018 while (t) {
1019 ++ndigits;
1020 t >>= PyLong_SHIFT;
1021 }
1022 v = _PyLong_New(ndigits);
1023 if (v != NULL) {
1024 digit *p = v->ob_digit;
1025 Py_SIZE(v) = negative ? -ndigits : ndigits;
1026 t = abs_ival;
1027 while (t) {
1028 *p++ = (digit)(t & PyLong_MASK);
1029 t >>= PyLong_SHIFT;
1030 }
1031 }
1032 return (PyObject *)v;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001033}
1034
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001035/* Create a new long int object from a C unsigned PY_LONG_LONG int. */
Tim Petersd1a7da62001-06-13 00:35:57 +00001036
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001037PyObject *
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001038PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG ival)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001039{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001040 PyLongObject *v;
1041 unsigned PY_LONG_LONG t;
1042 int ndigits = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001043
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001044 if (ival < PyLong_BASE)
1045 return PyLong_FromLong((long)ival);
1046 /* Count the number of Python digits. */
1047 t = (unsigned PY_LONG_LONG)ival;
1048 while (t) {
1049 ++ndigits;
1050 t >>= PyLong_SHIFT;
1051 }
1052 v = _PyLong_New(ndigits);
1053 if (v != NULL) {
1054 digit *p = v->ob_digit;
1055 Py_SIZE(v) = ndigits;
1056 while (ival) {
1057 *p++ = (digit)(ival & PyLong_MASK);
1058 ival >>= PyLong_SHIFT;
1059 }
1060 }
1061 return (PyObject *)v;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001062}
1063
Martin v. Löwis18e16552006-02-15 17:27:45 +00001064/* Create a new long int object from a C Py_ssize_t. */
1065
1066PyObject *
Guido van Rossumddefaf32007-01-14 03:31:43 +00001067PyLong_FromSsize_t(Py_ssize_t ival)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001068{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001069 PyLongObject *v;
1070 size_t abs_ival;
1071 size_t t; /* unsigned so >> doesn't propagate sign bit */
1072 int ndigits = 0;
1073 int negative = 0;
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001074
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001075 CHECK_SMALL_INT(ival);
1076 if (ival < 0) {
1077 /* avoid signed overflow when ival = SIZE_T_MIN */
1078 abs_ival = (size_t)(-1-ival)+1;
1079 negative = 1;
1080 }
1081 else {
1082 abs_ival = (size_t)ival;
1083 }
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001084
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001085 /* Count the number of Python digits. */
1086 t = abs_ival;
1087 while (t) {
1088 ++ndigits;
1089 t >>= PyLong_SHIFT;
1090 }
1091 v = _PyLong_New(ndigits);
1092 if (v != NULL) {
1093 digit *p = v->ob_digit;
1094 Py_SIZE(v) = negative ? -ndigits : ndigits;
1095 t = abs_ival;
1096 while (t) {
1097 *p++ = (digit)(t & PyLong_MASK);
1098 t >>= PyLong_SHIFT;
1099 }
1100 }
1101 return (PyObject *)v;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001102}
1103
1104/* Create a new long int object from a C size_t. */
1105
1106PyObject *
Guido van Rossumddefaf32007-01-14 03:31:43 +00001107PyLong_FromSize_t(size_t ival)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001108{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001109 PyLongObject *v;
1110 size_t t;
1111 int ndigits = 0;
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001112
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001113 if (ival < PyLong_BASE)
1114 return PyLong_FromLong((long)ival);
1115 /* Count the number of Python digits. */
1116 t = ival;
1117 while (t) {
1118 ++ndigits;
1119 t >>= PyLong_SHIFT;
1120 }
1121 v = _PyLong_New(ndigits);
1122 if (v != NULL) {
1123 digit *p = v->ob_digit;
1124 Py_SIZE(v) = ndigits;
1125 while (ival) {
1126 *p++ = (digit)(ival & PyLong_MASK);
1127 ival >>= PyLong_SHIFT;
1128 }
1129 }
1130 return (PyObject *)v;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001131}
1132
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001133/* Get a C PY_LONG_LONG int from a long int object.
Tim Petersd1a7da62001-06-13 00:35:57 +00001134 Return -1 and set an error if overflow occurs. */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001135
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001136PY_LONG_LONG
Tim Peters9f688bf2000-07-07 15:53:28 +00001137PyLong_AsLongLong(PyObject *vv)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001138{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001139 PyLongObject *v;
1140 PY_LONG_LONG bytes;
1141 int one = 1;
1142 int res;
Tim Petersd1a7da62001-06-13 00:35:57 +00001143
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001144 if (vv == NULL) {
1145 PyErr_BadInternalCall();
1146 return -1;
1147 }
1148 if (!PyLong_Check(vv)) {
1149 PyNumberMethods *nb;
1150 PyObject *io;
1151 if ((nb = vv->ob_type->tp_as_number) == NULL ||
1152 nb->nb_int == NULL) {
1153 PyErr_SetString(PyExc_TypeError, "an integer is required");
1154 return -1;
1155 }
1156 io = (*nb->nb_int) (vv);
1157 if (io == NULL)
1158 return -1;
1159 if (PyLong_Check(io)) {
1160 bytes = PyLong_AsLongLong(io);
1161 Py_DECREF(io);
1162 return bytes;
1163 }
1164 Py_DECREF(io);
1165 PyErr_SetString(PyExc_TypeError, "integer conversion failed");
1166 return -1;
1167 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001169 v = (PyLongObject*)vv;
1170 switch(Py_SIZE(v)) {
1171 case -1: return -(sdigit)v->ob_digit[0];
1172 case 0: return 0;
1173 case 1: return v->ob_digit[0];
1174 }
Mark Dickinson22b20182010-05-10 21:27:53 +00001175 res = _PyLong_AsByteArray((PyLongObject *)vv, (unsigned char *)&bytes,
1176 SIZEOF_LONG_LONG, IS_LITTLE_ENDIAN, 1);
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001177
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001178 /* Plan 9 can't handle PY_LONG_LONG in ? : expressions */
1179 if (res < 0)
1180 return (PY_LONG_LONG)-1;
1181 else
1182 return bytes;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001183}
1184
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001185/* Get a C unsigned PY_LONG_LONG int from a long int object.
Tim Petersd1a7da62001-06-13 00:35:57 +00001186 Return -1 and set an error if overflow occurs. */
1187
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001188unsigned PY_LONG_LONG
Tim Peters9f688bf2000-07-07 15:53:28 +00001189PyLong_AsUnsignedLongLong(PyObject *vv)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001190{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001191 PyLongObject *v;
1192 unsigned PY_LONG_LONG bytes;
1193 int one = 1;
1194 int res;
Tim Petersd1a7da62001-06-13 00:35:57 +00001195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001196 if (vv == NULL || !PyLong_Check(vv)) {
1197 PyErr_BadInternalCall();
1198 return (unsigned PY_LONG_LONG)-1;
1199 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001200
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001201 v = (PyLongObject*)vv;
1202 switch(Py_SIZE(v)) {
1203 case 0: return 0;
1204 case 1: return v->ob_digit[0];
1205 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00001206
Mark Dickinson22b20182010-05-10 21:27:53 +00001207 res = _PyLong_AsByteArray((PyLongObject *)vv, (unsigned char *)&bytes,
1208 SIZEOF_LONG_LONG, IS_LITTLE_ENDIAN, 0);
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 /* Plan 9 can't handle PY_LONG_LONG in ? : expressions */
1211 if (res < 0)
1212 return (unsigned PY_LONG_LONG)res;
1213 else
1214 return bytes;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001215}
Tim Petersd1a7da62001-06-13 00:35:57 +00001216
Thomas Hellera4ea6032003-04-17 18:55:45 +00001217/* Get a C unsigned long int from a long int object, ignoring the high bits.
1218 Returns -1 and sets an error condition if an error occurs. */
1219
Guido van Rossumddefaf32007-01-14 03:31:43 +00001220static unsigned PY_LONG_LONG
1221_PyLong_AsUnsignedLongLongMask(PyObject *vv)
Thomas Hellera4ea6032003-04-17 18:55:45 +00001222{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 register PyLongObject *v;
1224 unsigned PY_LONG_LONG x;
1225 Py_ssize_t i;
1226 int sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +00001227
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001228 if (vv == NULL || !PyLong_Check(vv)) {
1229 PyErr_BadInternalCall();
1230 return (unsigned long) -1;
1231 }
1232 v = (PyLongObject *)vv;
1233 switch(Py_SIZE(v)) {
1234 case 0: return 0;
1235 case 1: return v->ob_digit[0];
1236 }
1237 i = Py_SIZE(v);
1238 sign = 1;
1239 x = 0;
1240 if (i < 0) {
1241 sign = -1;
1242 i = -i;
1243 }
1244 while (--i >= 0) {
1245 x = (x << PyLong_SHIFT) | v->ob_digit[i];
1246 }
1247 return x * sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +00001248}
Guido van Rossumddefaf32007-01-14 03:31:43 +00001249
1250unsigned PY_LONG_LONG
1251PyLong_AsUnsignedLongLongMask(register PyObject *op)
1252{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001253 PyNumberMethods *nb;
1254 PyLongObject *lo;
1255 unsigned PY_LONG_LONG val;
Guido van Rossumddefaf32007-01-14 03:31:43 +00001256
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001257 if (op && PyLong_Check(op))
1258 return _PyLong_AsUnsignedLongLongMask(op);
Guido van Rossumddefaf32007-01-14 03:31:43 +00001259
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001260 if (op == NULL || (nb = op->ob_type->tp_as_number) == NULL ||
1261 nb->nb_int == NULL) {
1262 PyErr_SetString(PyExc_TypeError, "an integer is required");
1263 return (unsigned PY_LONG_LONG)-1;
1264 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00001265
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001266 lo = (PyLongObject*) (*nb->nb_int) (op);
1267 if (lo == NULL)
1268 return (unsigned PY_LONG_LONG)-1;
1269 if (PyLong_Check(lo)) {
1270 val = _PyLong_AsUnsignedLongLongMask((PyObject *)lo);
1271 Py_DECREF(lo);
1272 if (PyErr_Occurred())
1273 return (unsigned PY_LONG_LONG)-1;
1274 return val;
1275 }
1276 else
1277 {
1278 Py_DECREF(lo);
1279 PyErr_SetString(PyExc_TypeError,
1280 "nb_int should return int object");
1281 return (unsigned PY_LONG_LONG)-1;
1282 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00001283}
Tim Petersd1a7da62001-06-13 00:35:57 +00001284#undef IS_LITTLE_ENDIAN
1285
Mark Dickinson93f562c2010-01-30 10:30:15 +00001286/* Get a C long long int from a Python long or Python int object.
1287 On overflow, returns -1 and sets *overflow to 1 or -1 depending
1288 on the sign of the result. Otherwise *overflow is 0.
1289
1290 For other errors (e.g., type error), returns -1 and sets an error
1291 condition.
1292*/
1293
1294PY_LONG_LONG
1295PyLong_AsLongLongAndOverflow(PyObject *vv, int *overflow)
1296{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001297 /* This version by Tim Peters */
1298 register PyLongObject *v;
1299 unsigned PY_LONG_LONG x, prev;
1300 PY_LONG_LONG res;
1301 Py_ssize_t i;
1302 int sign;
1303 int do_decref = 0; /* if nb_int was called */
Mark Dickinson93f562c2010-01-30 10:30:15 +00001304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001305 *overflow = 0;
1306 if (vv == NULL) {
1307 PyErr_BadInternalCall();
1308 return -1;
1309 }
Mark Dickinson93f562c2010-01-30 10:30:15 +00001310
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001311 if (!PyLong_Check(vv)) {
1312 PyNumberMethods *nb;
1313 nb = vv->ob_type->tp_as_number;
1314 if (nb == NULL || nb->nb_int == NULL) {
1315 PyErr_SetString(PyExc_TypeError,
1316 "an integer is required");
1317 return -1;
1318 }
1319 vv = (*nb->nb_int) (vv);
1320 if (vv == NULL)
1321 return -1;
1322 do_decref = 1;
1323 if (!PyLong_Check(vv)) {
1324 Py_DECREF(vv);
1325 PyErr_SetString(PyExc_TypeError,
1326 "nb_int should return int object");
1327 return -1;
1328 }
1329 }
Mark Dickinson93f562c2010-01-30 10:30:15 +00001330
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001331 res = -1;
1332 v = (PyLongObject *)vv;
1333 i = Py_SIZE(v);
Mark Dickinson93f562c2010-01-30 10:30:15 +00001334
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001335 switch (i) {
1336 case -1:
1337 res = -(sdigit)v->ob_digit[0];
1338 break;
1339 case 0:
1340 res = 0;
1341 break;
1342 case 1:
1343 res = v->ob_digit[0];
1344 break;
1345 default:
1346 sign = 1;
1347 x = 0;
1348 if (i < 0) {
1349 sign = -1;
1350 i = -(i);
1351 }
1352 while (--i >= 0) {
1353 prev = x;
1354 x = (x << PyLong_SHIFT) + v->ob_digit[i];
1355 if ((x >> PyLong_SHIFT) != prev) {
1356 *overflow = sign;
1357 goto exit;
1358 }
1359 }
1360 /* Haven't lost any bits, but casting to long requires extra
1361 * care (see comment above).
1362 */
1363 if (x <= (unsigned PY_LONG_LONG)PY_LLONG_MAX) {
1364 res = (PY_LONG_LONG)x * sign;
1365 }
1366 else if (sign < 0 && x == PY_ABS_LLONG_MIN) {
1367 res = PY_LLONG_MIN;
1368 }
1369 else {
1370 *overflow = sign;
1371 /* res is already set to -1 */
1372 }
1373 }
Mark Dickinson22b20182010-05-10 21:27:53 +00001374 exit:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001375 if (do_decref) {
1376 Py_DECREF(vv);
1377 }
1378 return res;
Mark Dickinson93f562c2010-01-30 10:30:15 +00001379}
1380
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001381#endif /* HAVE_LONG_LONG */
1382
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00001383#define CHECK_BINOP(v,w) \
1384 do { \
1385 if (!PyLong_Check(v) || !PyLong_Check(w)) { \
1386 Py_INCREF(Py_NotImplemented); \
1387 return Py_NotImplemented; \
1388 } \
1389 } while(0)
Neil Schemenauerba872e22001-01-04 01:46:03 +00001390
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001391/* bits_in_digit(d) returns the unique integer k such that 2**(k-1) <= d <
1392 2**k if d is nonzero, else 0. */
1393
1394static const unsigned char BitLengthTable[32] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001395 0, 1, 2, 2, 3, 3, 3, 3, 4, 4, 4, 4, 4, 4, 4, 4,
1396 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001397};
1398
1399static int
1400bits_in_digit(digit d)
1401{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 int d_bits = 0;
1403 while (d >= 32) {
1404 d_bits += 6;
1405 d >>= 6;
1406 }
1407 d_bits += (int)BitLengthTable[d];
1408 return d_bits;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001409}
1410
Tim Peters877a2122002-08-12 05:09:36 +00001411/* x[0:m] and y[0:n] are digit vectors, LSD first, m >= n required. x[0:n]
1412 * is modified in place, by adding y to it. Carries are propagated as far as
1413 * x[m-1], and the remaining carry (0 or 1) is returned.
1414 */
1415static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001416v_iadd(digit *x, Py_ssize_t m, digit *y, Py_ssize_t n)
Tim Peters877a2122002-08-12 05:09:36 +00001417{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001418 Py_ssize_t i;
1419 digit carry = 0;
Tim Peters877a2122002-08-12 05:09:36 +00001420
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 assert(m >= n);
1422 for (i = 0; i < n; ++i) {
1423 carry += x[i] + y[i];
1424 x[i] = carry & PyLong_MASK;
1425 carry >>= PyLong_SHIFT;
1426 assert((carry & 1) == carry);
1427 }
1428 for (; carry && i < m; ++i) {
1429 carry += x[i];
1430 x[i] = carry & PyLong_MASK;
1431 carry >>= PyLong_SHIFT;
1432 assert((carry & 1) == carry);
1433 }
1434 return carry;
Tim Peters877a2122002-08-12 05:09:36 +00001435}
1436
1437/* x[0:m] and y[0:n] are digit vectors, LSD first, m >= n required. x[0:n]
1438 * is modified in place, by subtracting y from it. Borrows are propagated as
1439 * far as x[m-1], and the remaining borrow (0 or 1) is returned.
1440 */
1441static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001442v_isub(digit *x, Py_ssize_t m, digit *y, Py_ssize_t n)
Tim Peters877a2122002-08-12 05:09:36 +00001443{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001444 Py_ssize_t i;
1445 digit borrow = 0;
Tim Peters877a2122002-08-12 05:09:36 +00001446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001447 assert(m >= n);
1448 for (i = 0; i < n; ++i) {
1449 borrow = x[i] - y[i] - borrow;
1450 x[i] = borrow & PyLong_MASK;
1451 borrow >>= PyLong_SHIFT;
1452 borrow &= 1; /* keep only 1 sign bit */
1453 }
1454 for (; borrow && i < m; ++i) {
1455 borrow = x[i] - borrow;
1456 x[i] = borrow & PyLong_MASK;
1457 borrow >>= PyLong_SHIFT;
1458 borrow &= 1;
1459 }
1460 return borrow;
Tim Peters877a2122002-08-12 05:09:36 +00001461}
Neil Schemenauerba872e22001-01-04 01:46:03 +00001462
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001463/* Shift digit vector a[0:m] d bits left, with 0 <= d < PyLong_SHIFT. Put
1464 * result in z[0:m], and return the d bits shifted out of the top.
1465 */
1466static digit
1467v_lshift(digit *z, digit *a, Py_ssize_t m, int d)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001468{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 Py_ssize_t i;
1470 digit carry = 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001471
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001472 assert(0 <= d && d < PyLong_SHIFT);
1473 for (i=0; i < m; i++) {
1474 twodigits acc = (twodigits)a[i] << d | carry;
1475 z[i] = (digit)acc & PyLong_MASK;
1476 carry = (digit)(acc >> PyLong_SHIFT);
1477 }
1478 return carry;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001479}
1480
1481/* Shift digit vector a[0:m] d bits right, with 0 <= d < PyLong_SHIFT. Put
1482 * result in z[0:m], and return the d bits shifted out of the bottom.
1483 */
1484static digit
1485v_rshift(digit *z, digit *a, Py_ssize_t m, int d)
1486{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001487 Py_ssize_t i;
1488 digit carry = 0;
1489 digit mask = ((digit)1 << d) - 1U;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 assert(0 <= d && d < PyLong_SHIFT);
1492 for (i=m; i-- > 0;) {
1493 twodigits acc = (twodigits)carry << PyLong_SHIFT | a[i];
1494 carry = (digit)acc & mask;
1495 z[i] = (digit)(acc >> d);
1496 }
1497 return carry;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001498}
1499
Tim Peters212e6142001-07-14 12:23:19 +00001500/* Divide long pin, w/ size digits, by non-zero digit n, storing quotient
1501 in pout, and returning the remainder. pin and pout point at the LSD.
1502 It's OK for pin == pout on entry, which saves oodles of mallocs/frees in
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001503 _PyLong_Format, but that should be done with great care since longs are
Tim Peters212e6142001-07-14 12:23:19 +00001504 immutable. */
1505
1506static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001507inplace_divrem1(digit *pout, digit *pin, Py_ssize_t size, digit n)
Tim Peters212e6142001-07-14 12:23:19 +00001508{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001509 twodigits rem = 0;
Tim Peters212e6142001-07-14 12:23:19 +00001510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001511 assert(n > 0 && n <= PyLong_MASK);
1512 pin += size;
1513 pout += size;
1514 while (--size >= 0) {
1515 digit hi;
1516 rem = (rem << PyLong_SHIFT) | *--pin;
1517 *--pout = hi = (digit)(rem / n);
1518 rem -= (twodigits)hi * n;
1519 }
1520 return (digit)rem;
Tim Peters212e6142001-07-14 12:23:19 +00001521}
1522
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001523/* Divide a long integer by a digit, returning both the quotient
1524 (as function result) and the remainder (through *prem).
1525 The sign of a is ignored; n should not be zero. */
1526
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001527static PyLongObject *
Tim Peters212e6142001-07-14 12:23:19 +00001528divrem1(PyLongObject *a, digit n, digit *prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001529{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001530 const Py_ssize_t size = ABS(Py_SIZE(a));
1531 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001533 assert(n > 0 && n <= PyLong_MASK);
1534 z = _PyLong_New(size);
1535 if (z == NULL)
1536 return NULL;
1537 *prem = inplace_divrem1(z->ob_digit, a->ob_digit, size, n);
1538 return long_normalize(z);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001539}
1540
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001541/* Convert a long integer to a base 10 string. Returns a new non-shared
1542 string. (Return value is non-shared so that callers can modify the
1543 returned value if necessary.) */
1544
1545static PyObject *
1546long_to_decimal_string(PyObject *aa)
1547{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 PyLongObject *scratch, *a;
1549 PyObject *str;
1550 Py_ssize_t size, strlen, size_a, i, j;
1551 digit *pout, *pin, rem, tenpow;
1552 Py_UNICODE *p;
1553 int negative;
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001554
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001555 a = (PyLongObject *)aa;
1556 if (a == NULL || !PyLong_Check(a)) {
1557 PyErr_BadInternalCall();
1558 return NULL;
1559 }
1560 size_a = ABS(Py_SIZE(a));
1561 negative = Py_SIZE(a) < 0;
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001562
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001563 /* quick and dirty upper bound for the number of digits
1564 required to express a in base _PyLong_DECIMAL_BASE:
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001565
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001566 #digits = 1 + floor(log2(a) / log2(_PyLong_DECIMAL_BASE))
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001567
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001568 But log2(a) < size_a * PyLong_SHIFT, and
1569 log2(_PyLong_DECIMAL_BASE) = log2(10) * _PyLong_DECIMAL_SHIFT
1570 > 3 * _PyLong_DECIMAL_SHIFT
1571 */
1572 if (size_a > PY_SSIZE_T_MAX / PyLong_SHIFT) {
1573 PyErr_SetString(PyExc_OverflowError,
1574 "long is too large to format");
1575 return NULL;
1576 }
1577 /* the expression size_a * PyLong_SHIFT is now safe from overflow */
1578 size = 1 + size_a * PyLong_SHIFT / (3 * _PyLong_DECIMAL_SHIFT);
1579 scratch = _PyLong_New(size);
1580 if (scratch == NULL)
1581 return NULL;
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001583 /* convert array of base _PyLong_BASE digits in pin to an array of
1584 base _PyLong_DECIMAL_BASE digits in pout, following Knuth (TAOCP,
1585 Volume 2 (3rd edn), section 4.4, Method 1b). */
1586 pin = a->ob_digit;
1587 pout = scratch->ob_digit;
1588 size = 0;
1589 for (i = size_a; --i >= 0; ) {
1590 digit hi = pin[i];
1591 for (j = 0; j < size; j++) {
1592 twodigits z = (twodigits)pout[j] << PyLong_SHIFT | hi;
1593 hi = (digit)(z / _PyLong_DECIMAL_BASE);
1594 pout[j] = (digit)(z - (twodigits)hi *
1595 _PyLong_DECIMAL_BASE);
1596 }
1597 while (hi) {
1598 pout[size++] = hi % _PyLong_DECIMAL_BASE;
1599 hi /= _PyLong_DECIMAL_BASE;
1600 }
1601 /* check for keyboard interrupt */
1602 SIGCHECK({
Mark Dickinson22b20182010-05-10 21:27:53 +00001603 Py_DECREF(scratch);
1604 return NULL;
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00001605 });
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001606 }
1607 /* pout should have at least one digit, so that the case when a = 0
1608 works correctly */
1609 if (size == 0)
1610 pout[size++] = 0;
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001611
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 /* calculate exact length of output string, and allocate */
1613 strlen = negative + 1 + (size - 1) * _PyLong_DECIMAL_SHIFT;
1614 tenpow = 10;
1615 rem = pout[size-1];
1616 while (rem >= tenpow) {
1617 tenpow *= 10;
1618 strlen++;
1619 }
1620 str = PyUnicode_FromUnicode(NULL, strlen);
1621 if (str == NULL) {
1622 Py_DECREF(scratch);
1623 return NULL;
1624 }
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001625
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001626 /* fill the string right-to-left */
1627 p = PyUnicode_AS_UNICODE(str) + strlen;
1628 *p = '\0';
1629 /* pout[0] through pout[size-2] contribute exactly
1630 _PyLong_DECIMAL_SHIFT digits each */
1631 for (i=0; i < size - 1; i++) {
1632 rem = pout[i];
1633 for (j = 0; j < _PyLong_DECIMAL_SHIFT; j++) {
1634 *--p = '0' + rem % 10;
1635 rem /= 10;
1636 }
1637 }
1638 /* pout[size-1]: always produce at least one decimal digit */
1639 rem = pout[i];
1640 do {
1641 *--p = '0' + rem % 10;
1642 rem /= 10;
1643 } while (rem != 0);
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 /* and sign */
1646 if (negative)
1647 *--p = '-';
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001648
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001649 /* check we've counted correctly */
1650 assert(p == PyUnicode_AS_UNICODE(str));
1651 Py_DECREF(scratch);
1652 return (PyObject *)str;
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001653}
1654
Mark Dickinsoncd068122009-09-18 14:53:08 +00001655/* Convert a long int object to a string, using a given conversion base,
1656 which should be one of 2, 8, 10 or 16. Return a string object.
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001657 If base is 2, 8 or 16, add the proper prefix '0b', '0o' or '0x'. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001658
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001659PyObject *
1660_PyLong_Format(PyObject *aa, int base)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001661{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 register PyLongObject *a = (PyLongObject *)aa;
1663 PyObject *str;
1664 Py_ssize_t i, sz;
1665 Py_ssize_t size_a;
1666 Py_UNICODE *p, sign = '\0';
1667 int bits;
Guido van Rossume32e0141992-01-19 16:31:05 +00001668
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001669 assert(base == 2 || base == 8 || base == 10 || base == 16);
1670 if (base == 10)
1671 return long_to_decimal_string((PyObject *)a);
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001672
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 if (a == NULL || !PyLong_Check(a)) {
1674 PyErr_BadInternalCall();
1675 return NULL;
1676 }
1677 size_a = ABS(Py_SIZE(a));
Tim Peters5af4e6c2002-08-12 02:31:19 +00001678
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001679 /* Compute a rough upper bound for the length of the string */
1680 switch (base) {
1681 case 16:
1682 bits = 4;
1683 break;
1684 case 8:
1685 bits = 3;
1686 break;
1687 case 2:
1688 bits = 1;
1689 break;
1690 default:
1691 assert(0); /* shouldn't ever get here */
1692 bits = 0; /* to silence gcc warning */
1693 }
1694 /* compute length of output string: allow 2 characters for prefix and
1695 1 for possible '-' sign. */
1696 if (size_a > (PY_SSIZE_T_MAX - 3) / PyLong_SHIFT) {
1697 PyErr_SetString(PyExc_OverflowError,
1698 "int is too large to format");
1699 return NULL;
1700 }
1701 /* now size_a * PyLong_SHIFT + 3 <= PY_SSIZE_T_MAX, so the RHS below
1702 is safe from overflow */
1703 sz = 3 + (size_a * PyLong_SHIFT + (bits - 1)) / bits;
1704 assert(sz >= 0);
1705 str = PyUnicode_FromUnicode(NULL, sz);
1706 if (str == NULL)
1707 return NULL;
1708 p = PyUnicode_AS_UNICODE(str) + sz;
1709 *p = '\0';
1710 if (Py_SIZE(a) < 0)
1711 sign = '-';
Tim Peters5af4e6c2002-08-12 02:31:19 +00001712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001713 if (Py_SIZE(a) == 0) {
1714 *--p = '0';
1715 }
1716 else {
1717 /* JRH: special case for power-of-2 bases */
1718 twodigits accum = 0;
1719 int accumbits = 0; /* # of bits in accum */
1720 for (i = 0; i < size_a; ++i) {
1721 accum |= (twodigits)a->ob_digit[i] << accumbits;
1722 accumbits += PyLong_SHIFT;
1723 assert(accumbits >= bits);
1724 do {
1725 Py_UNICODE cdigit;
1726 cdigit = (Py_UNICODE)(accum & (base - 1));
1727 cdigit += (cdigit < 10) ? '0' : 'a'-10;
1728 assert(p > PyUnicode_AS_UNICODE(str));
1729 *--p = cdigit;
1730 accumbits -= bits;
1731 accum >>= bits;
1732 } while (i < size_a-1 ? accumbits >= bits : accum > 0);
1733 }
1734 }
Mark Dickinson8accd6b2009-09-17 19:39:12 +00001735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001736 if (base == 16)
1737 *--p = 'x';
1738 else if (base == 8)
1739 *--p = 'o';
1740 else /* (base == 2) */
1741 *--p = 'b';
1742 *--p = '0';
1743 if (sign)
1744 *--p = sign;
1745 if (p != PyUnicode_AS_UNICODE(str)) {
1746 Py_UNICODE *q = PyUnicode_AS_UNICODE(str);
1747 assert(p > q);
1748 do {
1749 } while ((*q++ = *p++) != '\0');
1750 q--;
1751 if (PyUnicode_Resize(&str,(Py_ssize_t) (q -
1752 PyUnicode_AS_UNICODE(str)))) {
1753 Py_DECREF(str);
1754 return NULL;
1755 }
1756 }
1757 return (PyObject *)str;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001758}
1759
Thomas Wouters477c8d52006-05-27 19:21:47 +00001760/* Table of digit values for 8-bit string -> integer conversion.
1761 * '0' maps to 0, ..., '9' maps to 9.
1762 * 'a' and 'A' map to 10, ..., 'z' and 'Z' map to 35.
1763 * All other indices map to 37.
1764 * Note that when converting a base B string, a char c is a legitimate
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001765 * base B digit iff _PyLong_DigitValue[Py_CHARPyLong_MASK(c)] < B.
Thomas Wouters477c8d52006-05-27 19:21:47 +00001766 */
Raymond Hettinger35631532009-01-09 03:58:09 +00001767unsigned char _PyLong_DigitValue[256] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001768 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1769 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1770 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1771 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 37, 37, 37, 37, 37, 37,
1772 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1773 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1774 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1775 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1776 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1777 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1778 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1779 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1780 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1781 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1782 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1783 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001784};
1785
1786/* *str points to the first digit in a string of base `base` digits. base
Tim Petersbf2674b2003-02-02 07:51:32 +00001787 * is a power of 2 (2, 4, 8, 16, or 32). *str is set to point to the first
1788 * non-digit (which may be *str!). A normalized long is returned.
1789 * The point to this routine is that it takes time linear in the number of
1790 * string characters.
1791 */
1792static PyLongObject *
1793long_from_binary_base(char **str, int base)
1794{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001795 char *p = *str;
1796 char *start = p;
1797 int bits_per_char;
1798 Py_ssize_t n;
1799 PyLongObject *z;
1800 twodigits accum;
1801 int bits_in_accum;
1802 digit *pdigit;
Tim Petersbf2674b2003-02-02 07:51:32 +00001803
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001804 assert(base >= 2 && base <= 32 && (base & (base - 1)) == 0);
1805 n = base;
1806 for (bits_per_char = -1; n; ++bits_per_char)
1807 n >>= 1;
1808 /* n <- total # of bits needed, while setting p to end-of-string */
1809 while (_PyLong_DigitValue[Py_CHARMASK(*p)] < base)
1810 ++p;
1811 *str = p;
1812 /* n <- # of Python digits needed, = ceiling(n/PyLong_SHIFT). */
1813 n = (p - start) * bits_per_char + PyLong_SHIFT - 1;
1814 if (n / bits_per_char < p - start) {
1815 PyErr_SetString(PyExc_ValueError,
1816 "int string too large to convert");
1817 return NULL;
1818 }
1819 n = n / PyLong_SHIFT;
1820 z = _PyLong_New(n);
1821 if (z == NULL)
1822 return NULL;
1823 /* Read string from right, and fill in long from left; i.e.,
1824 * from least to most significant in both.
1825 */
1826 accum = 0;
1827 bits_in_accum = 0;
1828 pdigit = z->ob_digit;
1829 while (--p >= start) {
1830 int k = (int)_PyLong_DigitValue[Py_CHARMASK(*p)];
1831 assert(k >= 0 && k < base);
1832 accum |= (twodigits)k << bits_in_accum;
1833 bits_in_accum += bits_per_char;
1834 if (bits_in_accum >= PyLong_SHIFT) {
1835 *pdigit++ = (digit)(accum & PyLong_MASK);
1836 assert(pdigit - z->ob_digit <= n);
1837 accum >>= PyLong_SHIFT;
1838 bits_in_accum -= PyLong_SHIFT;
1839 assert(bits_in_accum < PyLong_SHIFT);
1840 }
1841 }
1842 if (bits_in_accum) {
1843 assert(bits_in_accum <= PyLong_SHIFT);
1844 *pdigit++ = (digit)accum;
1845 assert(pdigit - z->ob_digit <= n);
1846 }
1847 while (pdigit - z->ob_digit < n)
1848 *pdigit++ = 0;
1849 return long_normalize(z);
Tim Petersbf2674b2003-02-02 07:51:32 +00001850}
1851
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001852PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00001853PyLong_FromString(char *str, char **pend, int base)
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001854{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001855 int sign = 1, error_if_nonzero = 0;
1856 char *start, *orig_str = str;
1857 PyLongObject *z = NULL;
1858 PyObject *strobj;
1859 Py_ssize_t slen;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001860
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001861 if ((base != 0 && base < 2) || base > 36) {
1862 PyErr_SetString(PyExc_ValueError,
1863 "int() arg 2 must be >= 2 and <= 36");
1864 return NULL;
1865 }
1866 while (*str != '\0' && isspace(Py_CHARMASK(*str)))
1867 str++;
1868 if (*str == '+')
1869 ++str;
1870 else if (*str == '-') {
1871 ++str;
1872 sign = -1;
1873 }
1874 if (base == 0) {
1875 if (str[0] != '0')
1876 base = 10;
1877 else if (str[1] == 'x' || str[1] == 'X')
1878 base = 16;
1879 else if (str[1] == 'o' || str[1] == 'O')
1880 base = 8;
1881 else if (str[1] == 'b' || str[1] == 'B')
1882 base = 2;
1883 else {
1884 /* "old" (C-style) octal literal, now invalid.
1885 it might still be zero though */
1886 error_if_nonzero = 1;
1887 base = 10;
1888 }
1889 }
1890 if (str[0] == '0' &&
1891 ((base == 16 && (str[1] == 'x' || str[1] == 'X')) ||
1892 (base == 8 && (str[1] == 'o' || str[1] == 'O')) ||
1893 (base == 2 && (str[1] == 'b' || str[1] == 'B'))))
1894 str += 2;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001895
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001896 start = str;
1897 if ((base & (base - 1)) == 0)
1898 z = long_from_binary_base(&str, base);
1899 else {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001900/***
1901Binary bases can be converted in time linear in the number of digits, because
1902Python's representation base is binary. Other bases (including decimal!) use
1903the simple quadratic-time algorithm below, complicated by some speed tricks.
Tim Peters5af4e6c2002-08-12 02:31:19 +00001904
Thomas Wouters477c8d52006-05-27 19:21:47 +00001905First some math: the largest integer that can be expressed in N base-B digits
1906is B**N-1. Consequently, if we have an N-digit input in base B, the worst-
1907case number of Python digits needed to hold it is the smallest integer n s.t.
1908
1909 BASE**n-1 >= B**N-1 [or, adding 1 to both sides]
1910 BASE**n >= B**N [taking logs to base BASE]
1911 n >= log(B**N)/log(BASE) = N * log(B)/log(BASE)
1912
1913The static array log_base_BASE[base] == log(base)/log(BASE) so we can compute
1914this quickly. A Python long with that much space is reserved near the start,
1915and the result is computed into it.
1916
1917The input string is actually treated as being in base base**i (i.e., i digits
1918are processed at a time), where two more static arrays hold:
1919
1920 convwidth_base[base] = the largest integer i such that base**i <= BASE
1921 convmultmax_base[base] = base ** convwidth_base[base]
1922
1923The first of these is the largest i such that i consecutive input digits
1924must fit in a single Python digit. The second is effectively the input
1925base we're really using.
1926
1927Viewing the input as a sequence <c0, c1, ..., c_n-1> of digits in base
1928convmultmax_base[base], the result is "simply"
1929
1930 (((c0*B + c1)*B + c2)*B + c3)*B + ... ))) + c_n-1
1931
1932where B = convmultmax_base[base].
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001933
1934Error analysis: as above, the number of Python digits `n` needed is worst-
1935case
1936
1937 n >= N * log(B)/log(BASE)
1938
1939where `N` is the number of input digits in base `B`. This is computed via
1940
1941 size_z = (Py_ssize_t)((scan - str) * log_base_BASE[base]) + 1;
1942
1943below. Two numeric concerns are how much space this can waste, and whether
1944the computed result can be too small. To be concrete, assume BASE = 2**15,
1945which is the default (and it's unlikely anyone changes that).
1946
1947Waste isn't a problem: provided the first input digit isn't 0, the difference
1948between the worst-case input with N digits and the smallest input with N
1949digits is about a factor of B, but B is small compared to BASE so at most
1950one allocated Python digit can remain unused on that count. If
1951N*log(B)/log(BASE) is mathematically an exact integer, then truncating that
1952and adding 1 returns a result 1 larger than necessary. However, that can't
1953happen: whenever B is a power of 2, long_from_binary_base() is called
1954instead, and it's impossible for B**i to be an integer power of 2**15 when
1955B is not a power of 2 (i.e., it's impossible for N*log(B)/log(BASE) to be
1956an exact integer when B is not a power of 2, since B**i has a prime factor
1957other than 2 in that case, but (2**15)**j's only prime factor is 2).
1958
1959The computed result can be too small if the true value of N*log(B)/log(BASE)
1960is a little bit larger than an exact integer, but due to roundoff errors (in
1961computing log(B), log(BASE), their quotient, and/or multiplying that by N)
1962yields a numeric result a little less than that integer. Unfortunately, "how
1963close can a transcendental function get to an integer over some range?"
1964questions are generally theoretically intractable. Computer analysis via
1965continued fractions is practical: expand log(B)/log(BASE) via continued
1966fractions, giving a sequence i/j of "the best" rational approximations. Then
1967j*log(B)/log(BASE) is approximately equal to (the integer) i. This shows that
1968we can get very close to being in trouble, but very rarely. For example,
196976573 is a denominator in one of the continued-fraction approximations to
1970log(10)/log(2**15), and indeed:
1971
1972 >>> log(10)/log(2**15)*76573
1973 16958.000000654003
1974
1975is very close to an integer. If we were working with IEEE single-precision,
1976rounding errors could kill us. Finding worst cases in IEEE double-precision
1977requires better-than-double-precision log() functions, and Tim didn't bother.
1978Instead the code checks to see whether the allocated space is enough as each
1979new Python digit is added, and copies the whole thing to a larger long if not.
1980This should happen extremely rarely, and in fact I don't have a test case
1981that triggers it(!). Instead the code was tested by artificially allocating
1982just 1 digit at the start, so that the copying code was exercised for every
1983digit beyond the first.
Thomas Wouters477c8d52006-05-27 19:21:47 +00001984***/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001985 register twodigits c; /* current input character */
1986 Py_ssize_t size_z;
1987 int i;
1988 int convwidth;
1989 twodigits convmultmax, convmult;
1990 digit *pz, *pzstop;
1991 char* scan;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001992
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001993 static double log_base_BASE[37] = {0.0e0,};
1994 static int convwidth_base[37] = {0,};
1995 static twodigits convmultmax_base[37] = {0,};
Thomas Wouters477c8d52006-05-27 19:21:47 +00001996
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001997 if (log_base_BASE[base] == 0.0) {
1998 twodigits convmax = base;
1999 int i = 1;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002000
Mark Dickinson22b20182010-05-10 21:27:53 +00002001 log_base_BASE[base] = (log((double)base) /
2002 log((double)PyLong_BASE));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002003 for (;;) {
2004 twodigits next = convmax * base;
2005 if (next > PyLong_BASE)
2006 break;
2007 convmax = next;
2008 ++i;
2009 }
2010 convmultmax_base[base] = convmax;
2011 assert(i > 0);
2012 convwidth_base[base] = i;
2013 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002014
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002015 /* Find length of the string of numeric characters. */
2016 scan = str;
2017 while (_PyLong_DigitValue[Py_CHARMASK(*scan)] < base)
2018 ++scan;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002019
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002020 /* Create a long object that can contain the largest possible
2021 * integer with this base and length. Note that there's no
2022 * need to initialize z->ob_digit -- no slot is read up before
2023 * being stored into.
2024 */
2025 size_z = (Py_ssize_t)((scan - str) * log_base_BASE[base]) + 1;
2026 /* Uncomment next line to test exceedingly rare copy code */
2027 /* size_z = 1; */
2028 assert(size_z > 0);
2029 z = _PyLong_New(size_z);
2030 if (z == NULL)
2031 return NULL;
2032 Py_SIZE(z) = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002033
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002034 /* `convwidth` consecutive input digits are treated as a single
2035 * digit in base `convmultmax`.
2036 */
2037 convwidth = convwidth_base[base];
2038 convmultmax = convmultmax_base[base];
Thomas Wouters477c8d52006-05-27 19:21:47 +00002039
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002040 /* Work ;-) */
2041 while (str < scan) {
2042 /* grab up to convwidth digits from the input string */
2043 c = (digit)_PyLong_DigitValue[Py_CHARMASK(*str++)];
2044 for (i = 1; i < convwidth && str != scan; ++i, ++str) {
2045 c = (twodigits)(c * base +
Mark Dickinson22b20182010-05-10 21:27:53 +00002046 (int)_PyLong_DigitValue[Py_CHARMASK(*str)]);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002047 assert(c < PyLong_BASE);
2048 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002049
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002050 convmult = convmultmax;
2051 /* Calculate the shift only if we couldn't get
2052 * convwidth digits.
2053 */
2054 if (i != convwidth) {
2055 convmult = base;
2056 for ( ; i > 1; --i)
2057 convmult *= base;
2058 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002060 /* Multiply z by convmult, and add c. */
2061 pz = z->ob_digit;
2062 pzstop = pz + Py_SIZE(z);
2063 for (; pz < pzstop; ++pz) {
2064 c += (twodigits)*pz * convmult;
2065 *pz = (digit)(c & PyLong_MASK);
2066 c >>= PyLong_SHIFT;
2067 }
2068 /* carry off the current end? */
2069 if (c) {
2070 assert(c < PyLong_BASE);
2071 if (Py_SIZE(z) < size_z) {
2072 *pz = (digit)c;
2073 ++Py_SIZE(z);
2074 }
2075 else {
2076 PyLongObject *tmp;
2077 /* Extremely rare. Get more space. */
2078 assert(Py_SIZE(z) == size_z);
2079 tmp = _PyLong_New(size_z + 1);
2080 if (tmp == NULL) {
2081 Py_DECREF(z);
2082 return NULL;
2083 }
2084 memcpy(tmp->ob_digit,
2085 z->ob_digit,
2086 sizeof(digit) * size_z);
2087 Py_DECREF(z);
2088 z = tmp;
2089 z->ob_digit[size_z] = (digit)c;
2090 ++size_z;
2091 }
2092 }
2093 }
2094 }
2095 if (z == NULL)
2096 return NULL;
2097 if (error_if_nonzero) {
2098 /* reset the base to 0, else the exception message
2099 doesn't make too much sense */
2100 base = 0;
2101 if (Py_SIZE(z) != 0)
2102 goto onError;
2103 /* there might still be other problems, therefore base
2104 remains zero here for the same reason */
2105 }
2106 if (str == start)
2107 goto onError;
2108 if (sign < 0)
2109 Py_SIZE(z) = -(Py_SIZE(z));
2110 while (*str && isspace(Py_CHARMASK(*str)))
2111 str++;
2112 if (*str != '\0')
2113 goto onError;
2114 if (pend)
2115 *pend = str;
2116 long_normalize(z);
2117 return (PyObject *) maybe_small_long(z);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002118
Mark Dickinson22b20182010-05-10 21:27:53 +00002119 onError:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002120 Py_XDECREF(z);
2121 slen = strlen(orig_str) < 200 ? strlen(orig_str) : 200;
2122 strobj = PyUnicode_FromStringAndSize(orig_str, slen);
2123 if (strobj == NULL)
2124 return NULL;
2125 PyErr_Format(PyExc_ValueError,
2126 "invalid literal for int() with base %d: %R",
2127 base, strobj);
2128 Py_DECREF(strobj);
2129 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +00002130}
2131
2132PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002133PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base)
Guido van Rossum9e896b32000-04-05 20:11:21 +00002134{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002135 PyObject *result;
Alexander Belopolsky942af5a2010-12-04 03:38:46 +00002136 PyObject *asciidig;
2137 char *buffer, *end;
2138 Py_ssize_t i, buflen;
2139 Py_UNICODE *ptr;
Guido van Rossum9e896b32000-04-05 20:11:21 +00002140
Alexander Belopolsky942af5a2010-12-04 03:38:46 +00002141 asciidig = PyUnicode_TransformDecimalToASCII(u, length);
2142 if (asciidig == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002143 return NULL;
Alexander Belopolsky942af5a2010-12-04 03:38:46 +00002144 /* Replace non-ASCII whitespace with ' ' */
2145 ptr = PyUnicode_AS_UNICODE(asciidig);
2146 for (i = 0; i < length; i++) {
Mark Dickinsonc9fb3c62010-12-04 11:06:25 +00002147 Py_UNICODE ch = ptr[i];
2148 if (ch > 127 && Py_UNICODE_ISSPACE(ch))
2149 ptr[i] = ' ';
Alexander Belopolsky942af5a2010-12-04 03:38:46 +00002150 }
2151 buffer = _PyUnicode_AsStringAndSize(asciidig, &buflen);
2152 if (buffer == NULL) {
2153 Py_DECREF(asciidig);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002154 return NULL;
2155 }
Alexander Belopolsky942af5a2010-12-04 03:38:46 +00002156 result = PyLong_FromString(buffer, &end, base);
2157 if (result != NULL && end != buffer + buflen) {
2158 PyErr_SetString(PyExc_ValueError,
2159 "null byte in argument for int()");
2160 Py_DECREF(result);
2161 result = NULL;
2162 }
2163 Py_DECREF(asciidig);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002164 return result;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002165}
2166
Tim Peters9f688bf2000-07-07 15:53:28 +00002167/* forward */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002168static PyLongObject *x_divrem
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002169 (PyLongObject *, PyLongObject *, PyLongObject **);
Guido van Rossumb43daf72007-08-01 18:08:08 +00002170static PyObject *long_long(PyObject *v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002171
2172/* Long division with remainder, top-level routine */
2173
Guido van Rossume32e0141992-01-19 16:31:05 +00002174static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002175long_divrem(PyLongObject *a, PyLongObject *b,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002176 PyLongObject **pdiv, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002177{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002178 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
2179 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002180
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002181 if (size_b == 0) {
2182 PyErr_SetString(PyExc_ZeroDivisionError,
2183 "integer division or modulo by zero");
2184 return -1;
2185 }
2186 if (size_a < size_b ||
2187 (size_a == size_b &&
2188 a->ob_digit[size_a-1] < b->ob_digit[size_b-1])) {
2189 /* |a| < |b|. */
2190 *pdiv = (PyLongObject*)PyLong_FromLong(0);
2191 if (*pdiv == NULL)
2192 return -1;
2193 Py_INCREF(a);
2194 *prem = (PyLongObject *) a;
2195 return 0;
2196 }
2197 if (size_b == 1) {
2198 digit rem = 0;
2199 z = divrem1(a, b->ob_digit[0], &rem);
2200 if (z == NULL)
2201 return -1;
2202 *prem = (PyLongObject *) PyLong_FromLong((long)rem);
2203 if (*prem == NULL) {
2204 Py_DECREF(z);
2205 return -1;
2206 }
2207 }
2208 else {
2209 z = x_divrem(a, b, prem);
2210 if (z == NULL)
2211 return -1;
2212 }
2213 /* Set the signs.
2214 The quotient z has the sign of a*b;
2215 the remainder r has the sign of a,
2216 so a = b*z + r. */
2217 if ((Py_SIZE(a) < 0) != (Py_SIZE(b) < 0))
2218 NEGATE(z);
2219 if (Py_SIZE(a) < 0 && Py_SIZE(*prem) != 0)
2220 NEGATE(*prem);
2221 *pdiv = maybe_small_long(z);
2222 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002223}
2224
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002225/* Unsigned long division with remainder -- the algorithm. The arguments v1
2226 and w1 should satisfy 2 <= ABS(Py_SIZE(w1)) <= ABS(Py_SIZE(v1)). */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002227
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002228static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002229x_divrem(PyLongObject *v1, PyLongObject *w1, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002230{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002231 PyLongObject *v, *w, *a;
2232 Py_ssize_t i, k, size_v, size_w;
2233 int d;
2234 digit wm1, wm2, carry, q, r, vtop, *v0, *vk, *w0, *ak;
2235 twodigits vv;
2236 sdigit zhi;
2237 stwodigits z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002238
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002239 /* We follow Knuth [The Art of Computer Programming, Vol. 2 (3rd
2240 edn.), section 4.3.1, Algorithm D], except that we don't explicitly
2241 handle the special case when the initial estimate q for a quotient
2242 digit is >= PyLong_BASE: the max value for q is PyLong_BASE+1, and
2243 that won't overflow a digit. */
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002245 /* allocate space; w will also be used to hold the final remainder */
2246 size_v = ABS(Py_SIZE(v1));
2247 size_w = ABS(Py_SIZE(w1));
2248 assert(size_v >= size_w && size_w >= 2); /* Assert checks by div() */
2249 v = _PyLong_New(size_v+1);
2250 if (v == NULL) {
2251 *prem = NULL;
2252 return NULL;
2253 }
2254 w = _PyLong_New(size_w);
2255 if (w == NULL) {
2256 Py_DECREF(v);
2257 *prem = NULL;
2258 return NULL;
2259 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002260
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002261 /* normalize: shift w1 left so that its top digit is >= PyLong_BASE/2.
2262 shift v1 left by the same amount. Results go into w and v. */
2263 d = PyLong_SHIFT - bits_in_digit(w1->ob_digit[size_w-1]);
2264 carry = v_lshift(w->ob_digit, w1->ob_digit, size_w, d);
2265 assert(carry == 0);
2266 carry = v_lshift(v->ob_digit, v1->ob_digit, size_v, d);
2267 if (carry != 0 || v->ob_digit[size_v-1] >= w->ob_digit[size_w-1]) {
2268 v->ob_digit[size_v] = carry;
2269 size_v++;
2270 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002272 /* Now v->ob_digit[size_v-1] < w->ob_digit[size_w-1], so quotient has
2273 at most (and usually exactly) k = size_v - size_w digits. */
2274 k = size_v - size_w;
2275 assert(k >= 0);
2276 a = _PyLong_New(k);
2277 if (a == NULL) {
2278 Py_DECREF(w);
2279 Py_DECREF(v);
2280 *prem = NULL;
2281 return NULL;
2282 }
2283 v0 = v->ob_digit;
2284 w0 = w->ob_digit;
2285 wm1 = w0[size_w-1];
2286 wm2 = w0[size_w-2];
2287 for (vk = v0+k, ak = a->ob_digit + k; vk-- > v0;) {
2288 /* inner loop: divide vk[0:size_w+1] by w0[0:size_w], giving
2289 single-digit quotient q, remainder in vk[0:size_w]. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002290
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002291 SIGCHECK({
Mark Dickinson22b20182010-05-10 21:27:53 +00002292 Py_DECREF(a);
2293 Py_DECREF(w);
2294 Py_DECREF(v);
2295 *prem = NULL;
2296 return NULL;
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00002297 });
Tim Peters5af4e6c2002-08-12 02:31:19 +00002298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002299 /* estimate quotient digit q; may overestimate by 1 (rare) */
2300 vtop = vk[size_w];
2301 assert(vtop <= wm1);
2302 vv = ((twodigits)vtop << PyLong_SHIFT) | vk[size_w-1];
2303 q = (digit)(vv / wm1);
2304 r = (digit)(vv - (twodigits)wm1 * q); /* r = vv % wm1 */
2305 while ((twodigits)wm2 * q > (((twodigits)r << PyLong_SHIFT)
2306 | vk[size_w-2])) {
2307 --q;
2308 r += wm1;
2309 if (r >= PyLong_BASE)
2310 break;
2311 }
2312 assert(q <= PyLong_BASE);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002313
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002314 /* subtract q*w0[0:size_w] from vk[0:size_w+1] */
2315 zhi = 0;
2316 for (i = 0; i < size_w; ++i) {
2317 /* invariants: -PyLong_BASE <= -q <= zhi <= 0;
2318 -PyLong_BASE * q <= z < PyLong_BASE */
2319 z = (sdigit)vk[i] + zhi -
2320 (stwodigits)q * (stwodigits)w0[i];
2321 vk[i] = (digit)z & PyLong_MASK;
2322 zhi = (sdigit)Py_ARITHMETIC_RIGHT_SHIFT(stwodigits,
Mark Dickinson22b20182010-05-10 21:27:53 +00002323 z, PyLong_SHIFT);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002324 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002325
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002326 /* add w back if q was too large (this branch taken rarely) */
2327 assert((sdigit)vtop + zhi == -1 || (sdigit)vtop + zhi == 0);
2328 if ((sdigit)vtop + zhi < 0) {
2329 carry = 0;
2330 for (i = 0; i < size_w; ++i) {
2331 carry += vk[i] + w0[i];
2332 vk[i] = carry & PyLong_MASK;
2333 carry >>= PyLong_SHIFT;
2334 }
2335 --q;
2336 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002337
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002338 /* store quotient digit */
2339 assert(q < PyLong_BASE);
2340 *--ak = q;
2341 }
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002342
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002343 /* unshift remainder; we reuse w to store the result */
2344 carry = v_rshift(w0, v0, size_w, d);
2345 assert(carry==0);
2346 Py_DECREF(v);
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002348 *prem = long_normalize(w);
2349 return long_normalize(a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002350}
2351
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002352/* For a nonzero PyLong a, express a in the form x * 2**e, with 0.5 <=
2353 abs(x) < 1.0 and e >= 0; return x and put e in *e. Here x is
2354 rounded to DBL_MANT_DIG significant bits using round-half-to-even.
2355 If a == 0, return 0.0 and set *e = 0. If the resulting exponent
2356 e is larger than PY_SSIZE_T_MAX, raise OverflowError and return
2357 -1.0. */
2358
2359/* attempt to define 2.0**DBL_MANT_DIG as a compile-time constant */
2360#if DBL_MANT_DIG == 53
2361#define EXP2_DBL_MANT_DIG 9007199254740992.0
2362#else
2363#define EXP2_DBL_MANT_DIG (ldexp(1.0, DBL_MANT_DIG))
2364#endif
2365
2366double
2367_PyLong_Frexp(PyLongObject *a, Py_ssize_t *e)
2368{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002369 Py_ssize_t a_size, a_bits, shift_digits, shift_bits, x_size;
2370 /* See below for why x_digits is always large enough. */
2371 digit rem, x_digits[2 + (DBL_MANT_DIG + 1) / PyLong_SHIFT];
2372 double dx;
2373 /* Correction term for round-half-to-even rounding. For a digit x,
2374 "x + half_even_correction[x & 7]" gives x rounded to the nearest
2375 multiple of 4, rounding ties to a multiple of 8. */
2376 static const int half_even_correction[8] = {0, -1, -2, 1, 0, -1, 2, 1};
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002377
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002378 a_size = ABS(Py_SIZE(a));
2379 if (a_size == 0) {
2380 /* Special case for 0: significand 0.0, exponent 0. */
2381 *e = 0;
2382 return 0.0;
2383 }
2384 a_bits = bits_in_digit(a->ob_digit[a_size-1]);
2385 /* The following is an overflow-free version of the check
2386 "if ((a_size - 1) * PyLong_SHIFT + a_bits > PY_SSIZE_T_MAX) ..." */
2387 if (a_size >= (PY_SSIZE_T_MAX - 1) / PyLong_SHIFT + 1 &&
2388 (a_size > (PY_SSIZE_T_MAX - 1) / PyLong_SHIFT + 1 ||
2389 a_bits > (PY_SSIZE_T_MAX - 1) % PyLong_SHIFT + 1))
Mark Dickinson22b20182010-05-10 21:27:53 +00002390 goto overflow;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002391 a_bits = (a_size - 1) * PyLong_SHIFT + a_bits;
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002392
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002393 /* Shift the first DBL_MANT_DIG + 2 bits of a into x_digits[0:x_size]
2394 (shifting left if a_bits <= DBL_MANT_DIG + 2).
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002395
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002396 Number of digits needed for result: write // for floor division.
2397 Then if shifting left, we end up using
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002398
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002399 1 + a_size + (DBL_MANT_DIG + 2 - a_bits) // PyLong_SHIFT
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002400
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002401 digits. If shifting right, we use
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002403 a_size - (a_bits - DBL_MANT_DIG - 2) // PyLong_SHIFT
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002404
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002405 digits. Using a_size = 1 + (a_bits - 1) // PyLong_SHIFT along with
2406 the inequalities
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002407
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002408 m // PyLong_SHIFT + n // PyLong_SHIFT <= (m + n) // PyLong_SHIFT
2409 m // PyLong_SHIFT - n // PyLong_SHIFT <=
2410 1 + (m - n - 1) // PyLong_SHIFT,
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002412 valid for any integers m and n, we find that x_size satisfies
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002413
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002414 x_size <= 2 + (DBL_MANT_DIG + 1) // PyLong_SHIFT
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002415
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002416 in both cases.
2417 */
2418 if (a_bits <= DBL_MANT_DIG + 2) {
2419 shift_digits = (DBL_MANT_DIG + 2 - a_bits) / PyLong_SHIFT;
2420 shift_bits = (DBL_MANT_DIG + 2 - a_bits) % PyLong_SHIFT;
2421 x_size = 0;
2422 while (x_size < shift_digits)
2423 x_digits[x_size++] = 0;
2424 rem = v_lshift(x_digits + x_size, a->ob_digit, a_size,
2425 (int)shift_bits);
2426 x_size += a_size;
2427 x_digits[x_size++] = rem;
2428 }
2429 else {
2430 shift_digits = (a_bits - DBL_MANT_DIG - 2) / PyLong_SHIFT;
2431 shift_bits = (a_bits - DBL_MANT_DIG - 2) % PyLong_SHIFT;
2432 rem = v_rshift(x_digits, a->ob_digit + shift_digits,
2433 a_size - shift_digits, (int)shift_bits);
2434 x_size = a_size - shift_digits;
2435 /* For correct rounding below, we need the least significant
2436 bit of x to be 'sticky' for this shift: if any of the bits
2437 shifted out was nonzero, we set the least significant bit
2438 of x. */
2439 if (rem)
2440 x_digits[0] |= 1;
2441 else
2442 while (shift_digits > 0)
2443 if (a->ob_digit[--shift_digits]) {
2444 x_digits[0] |= 1;
2445 break;
2446 }
2447 }
Mark Dickinson22b20182010-05-10 21:27:53 +00002448 assert(1 <= x_size &&
2449 x_size <= (Py_ssize_t)(sizeof(x_digits)/sizeof(digit)));
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002450
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002451 /* Round, and convert to double. */
2452 x_digits[0] += half_even_correction[x_digits[0] & 7];
2453 dx = x_digits[--x_size];
2454 while (x_size > 0)
2455 dx = dx * PyLong_BASE + x_digits[--x_size];
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002456
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002457 /* Rescale; make correction if result is 1.0. */
2458 dx /= 4.0 * EXP2_DBL_MANT_DIG;
2459 if (dx == 1.0) {
2460 if (a_bits == PY_SSIZE_T_MAX)
2461 goto overflow;
2462 dx = 0.5;
2463 a_bits += 1;
2464 }
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 *e = a_bits;
2467 return Py_SIZE(a) < 0 ? -dx : dx;
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002468
2469 overflow:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002470 /* exponent > PY_SSIZE_T_MAX */
2471 PyErr_SetString(PyExc_OverflowError,
2472 "huge integer: number of bits overflows a Py_ssize_t");
2473 *e = 0;
2474 return -1.0;
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002475}
2476
2477/* Get a C double from a long int object. Rounds to the nearest double,
2478 using the round-half-to-even rule in the case of a tie. */
2479
2480double
2481PyLong_AsDouble(PyObject *v)
2482{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002483 Py_ssize_t exponent;
2484 double x;
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002486 if (v == NULL || !PyLong_Check(v)) {
2487 PyErr_BadInternalCall();
2488 return -1.0;
2489 }
2490 x = _PyLong_Frexp((PyLongObject *)v, &exponent);
2491 if ((x == -1.0 && PyErr_Occurred()) || exponent > DBL_MAX_EXP) {
2492 PyErr_SetString(PyExc_OverflowError,
2493 "long int too large to convert to float");
2494 return -1.0;
2495 }
2496 return ldexp(x, (int)exponent);
Mark Dickinson6ecd9e52010-01-02 15:33:56 +00002497}
2498
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002499/* Methods */
2500
2501static void
Tim Peters9f688bf2000-07-07 15:53:28 +00002502long_dealloc(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002503{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002504 Py_TYPE(v)->tp_free(v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002505}
2506
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002507static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002508long_compare(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002509{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002510 Py_ssize_t sign;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002511
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002512 if (Py_SIZE(a) != Py_SIZE(b)) {
2513 sign = Py_SIZE(a) - Py_SIZE(b);
2514 }
2515 else {
2516 Py_ssize_t i = ABS(Py_SIZE(a));
2517 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2518 ;
2519 if (i < 0)
2520 sign = 0;
2521 else {
2522 sign = (sdigit)a->ob_digit[i] - (sdigit)b->ob_digit[i];
2523 if (Py_SIZE(a) < 0)
2524 sign = -sign;
2525 }
2526 }
2527 return sign < 0 ? -1 : sign > 0 ? 1 : 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002528}
2529
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002530#define TEST_COND(cond) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002531 ((cond) ? Py_True : Py_False)
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002532
Guido van Rossum47b9ff62006-08-24 00:41:19 +00002533static PyObject *
2534long_richcompare(PyObject *self, PyObject *other, int op)
2535{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002536 int result;
2537 PyObject *v;
2538 CHECK_BINOP(self, other);
2539 if (self == other)
2540 result = 0;
2541 else
2542 result = long_compare((PyLongObject*)self, (PyLongObject*)other);
2543 /* Convert the return value to a Boolean */
2544 switch (op) {
2545 case Py_EQ:
2546 v = TEST_COND(result == 0);
2547 break;
2548 case Py_NE:
2549 v = TEST_COND(result != 0);
2550 break;
2551 case Py_LE:
2552 v = TEST_COND(result <= 0);
2553 break;
2554 case Py_GE:
2555 v = TEST_COND(result >= 0);
2556 break;
2557 case Py_LT:
2558 v = TEST_COND(result == -1);
2559 break;
2560 case Py_GT:
2561 v = TEST_COND(result == 1);
2562 break;
2563 default:
2564 PyErr_BadArgument();
2565 return NULL;
2566 }
2567 Py_INCREF(v);
2568 return v;
Guido van Rossum47b9ff62006-08-24 00:41:19 +00002569}
2570
Benjamin Peterson8f67d082010-10-17 20:54:53 +00002571static Py_hash_t
Tim Peters9f688bf2000-07-07 15:53:28 +00002572long_hash(PyLongObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +00002573{
Benjamin Peterson8035bc52010-10-23 16:20:50 +00002574 Py_uhash_t x;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002575 Py_ssize_t i;
2576 int sign;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002578 i = Py_SIZE(v);
2579 switch(i) {
2580 case -1: return v->ob_digit[0]==1 ? -2 : -(sdigit)v->ob_digit[0];
2581 case 0: return 0;
2582 case 1: return v->ob_digit[0];
2583 }
2584 sign = 1;
2585 x = 0;
2586 if (i < 0) {
2587 sign = -1;
2588 i = -(i);
2589 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002590 while (--i >= 0) {
Mark Dickinsondc787d22010-05-23 13:33:13 +00002591 /* Here x is a quantity in the range [0, _PyHASH_MODULUS); we
2592 want to compute x * 2**PyLong_SHIFT + v->ob_digit[i] modulo
2593 _PyHASH_MODULUS.
2594
2595 The computation of x * 2**PyLong_SHIFT % _PyHASH_MODULUS
2596 amounts to a rotation of the bits of x. To see this, write
2597
2598 x * 2**PyLong_SHIFT = y * 2**_PyHASH_BITS + z
2599
2600 where y = x >> (_PyHASH_BITS - PyLong_SHIFT) gives the top
2601 PyLong_SHIFT bits of x (those that are shifted out of the
2602 original _PyHASH_BITS bits, and z = (x << PyLong_SHIFT) &
2603 _PyHASH_MODULUS gives the bottom _PyHASH_BITS - PyLong_SHIFT
2604 bits of x, shifted up. Then since 2**_PyHASH_BITS is
2605 congruent to 1 modulo _PyHASH_MODULUS, y*2**_PyHASH_BITS is
2606 congruent to y modulo _PyHASH_MODULUS. So
2607
2608 x * 2**PyLong_SHIFT = y + z (mod _PyHASH_MODULUS).
2609
2610 The right-hand side is just the result of rotating the
2611 _PyHASH_BITS bits of x left by PyLong_SHIFT places; since
2612 not all _PyHASH_BITS bits of x are 1s, the same is true
2613 after rotation, so 0 <= y+z < _PyHASH_MODULUS and y + z is
2614 the reduction of x*2**PyLong_SHIFT modulo
2615 _PyHASH_MODULUS. */
2616 x = ((x << PyLong_SHIFT) & _PyHASH_MODULUS) |
2617 (x >> (_PyHASH_BITS - PyLong_SHIFT));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002618 x += v->ob_digit[i];
Mark Dickinsondc787d22010-05-23 13:33:13 +00002619 if (x >= _PyHASH_MODULUS)
2620 x -= _PyHASH_MODULUS;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002621 }
2622 x = x * sign;
Benjamin Peterson8035bc52010-10-23 16:20:50 +00002623 if (x == (Py_uhash_t)-1)
2624 x = (Py_uhash_t)-2;
Benjamin Peterson8f67d082010-10-17 20:54:53 +00002625 return (Py_hash_t)x;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002626}
2627
2628
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002629/* Add the absolute values of two long integers. */
2630
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002631static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002632x_add(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002633{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002634 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
2635 PyLongObject *z;
2636 Py_ssize_t i;
2637 digit carry = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002638
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002639 /* Ensure a is the larger of the two: */
2640 if (size_a < size_b) {
2641 { PyLongObject *temp = a; a = b; b = temp; }
2642 { Py_ssize_t size_temp = size_a;
Mark Dickinson22b20182010-05-10 21:27:53 +00002643 size_a = size_b;
2644 size_b = size_temp; }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002645 }
2646 z = _PyLong_New(size_a+1);
2647 if (z == NULL)
2648 return NULL;
2649 for (i = 0; i < size_b; ++i) {
2650 carry += a->ob_digit[i] + b->ob_digit[i];
2651 z->ob_digit[i] = carry & PyLong_MASK;
2652 carry >>= PyLong_SHIFT;
2653 }
2654 for (; i < size_a; ++i) {
2655 carry += a->ob_digit[i];
2656 z->ob_digit[i] = carry & PyLong_MASK;
2657 carry >>= PyLong_SHIFT;
2658 }
2659 z->ob_digit[i] = carry;
2660 return long_normalize(z);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002661}
2662
2663/* Subtract the absolute values of two integers. */
2664
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002665static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002666x_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002667{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002668 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
2669 PyLongObject *z;
2670 Py_ssize_t i;
2671 int sign = 1;
2672 digit borrow = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002674 /* Ensure a is the larger of the two: */
2675 if (size_a < size_b) {
2676 sign = -1;
2677 { PyLongObject *temp = a; a = b; b = temp; }
2678 { Py_ssize_t size_temp = size_a;
Mark Dickinson22b20182010-05-10 21:27:53 +00002679 size_a = size_b;
2680 size_b = size_temp; }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002681 }
2682 else if (size_a == size_b) {
2683 /* Find highest digit where a and b differ: */
2684 i = size_a;
2685 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2686 ;
2687 if (i < 0)
2688 return (PyLongObject *)PyLong_FromLong(0);
2689 if (a->ob_digit[i] < b->ob_digit[i]) {
2690 sign = -1;
2691 { PyLongObject *temp = a; a = b; b = temp; }
2692 }
2693 size_a = size_b = i+1;
2694 }
2695 z = _PyLong_New(size_a);
2696 if (z == NULL)
2697 return NULL;
2698 for (i = 0; i < size_b; ++i) {
2699 /* The following assumes unsigned arithmetic
2700 works module 2**N for some N>PyLong_SHIFT. */
2701 borrow = a->ob_digit[i] - b->ob_digit[i] - borrow;
2702 z->ob_digit[i] = borrow & PyLong_MASK;
2703 borrow >>= PyLong_SHIFT;
2704 borrow &= 1; /* Keep only one sign bit */
2705 }
2706 for (; i < size_a; ++i) {
2707 borrow = a->ob_digit[i] - borrow;
2708 z->ob_digit[i] = borrow & PyLong_MASK;
2709 borrow >>= PyLong_SHIFT;
2710 borrow &= 1; /* Keep only one sign bit */
2711 }
2712 assert(borrow == 0);
2713 if (sign < 0)
2714 NEGATE(z);
2715 return long_normalize(z);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002716}
2717
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002718static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002719long_add(PyLongObject *a, PyLongObject *b)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002720{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002721 PyLongObject *z;
Tim Peters69c2de32001-09-11 22:31:33 +00002722
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002723 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00002724
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002725 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
2726 PyObject *result = PyLong_FromLong(MEDIUM_VALUE(a) +
2727 MEDIUM_VALUE(b));
2728 return result;
2729 }
2730 if (Py_SIZE(a) < 0) {
2731 if (Py_SIZE(b) < 0) {
2732 z = x_add(a, b);
2733 if (z != NULL && Py_SIZE(z) != 0)
2734 Py_SIZE(z) = -(Py_SIZE(z));
2735 }
2736 else
2737 z = x_sub(b, a);
2738 }
2739 else {
2740 if (Py_SIZE(b) < 0)
2741 z = x_sub(a, b);
2742 else
2743 z = x_add(a, b);
2744 }
2745 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002746}
2747
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002748static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002749long_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002750{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002751 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002752
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002753 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00002754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002755 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
2756 PyObject* r;
2757 r = PyLong_FromLong(MEDIUM_VALUE(a)-MEDIUM_VALUE(b));
2758 return r;
2759 }
2760 if (Py_SIZE(a) < 0) {
2761 if (Py_SIZE(b) < 0)
2762 z = x_sub(a, b);
2763 else
2764 z = x_add(a, b);
2765 if (z != NULL && Py_SIZE(z) != 0)
2766 Py_SIZE(z) = -(Py_SIZE(z));
2767 }
2768 else {
2769 if (Py_SIZE(b) < 0)
2770 z = x_add(a, b);
2771 else
2772 z = x_sub(a, b);
2773 }
2774 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002775}
2776
Tim Peters5af4e6c2002-08-12 02:31:19 +00002777/* Grade school multiplication, ignoring the signs.
2778 * Returns the absolute value of the product, or NULL if error.
2779 */
2780static PyLongObject *
2781x_mul(PyLongObject *a, PyLongObject *b)
Neil Schemenauerba872e22001-01-04 01:46:03 +00002782{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002783 PyLongObject *z;
2784 Py_ssize_t size_a = ABS(Py_SIZE(a));
2785 Py_ssize_t size_b = ABS(Py_SIZE(b));
2786 Py_ssize_t i;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002787
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002788 z = _PyLong_New(size_a + size_b);
2789 if (z == NULL)
2790 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002791
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002792 memset(z->ob_digit, 0, Py_SIZE(z) * sizeof(digit));
2793 if (a == b) {
2794 /* Efficient squaring per HAC, Algorithm 14.16:
2795 * http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf
2796 * Gives slightly less than a 2x speedup when a == b,
2797 * via exploiting that each entry in the multiplication
2798 * pyramid appears twice (except for the size_a squares).
2799 */
2800 for (i = 0; i < size_a; ++i) {
2801 twodigits carry;
2802 twodigits f = a->ob_digit[i];
2803 digit *pz = z->ob_digit + (i << 1);
2804 digit *pa = a->ob_digit + i + 1;
2805 digit *paend = a->ob_digit + size_a;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002806
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002807 SIGCHECK({
Mark Dickinson22b20182010-05-10 21:27:53 +00002808 Py_DECREF(z);
2809 return NULL;
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00002810 });
Tim Peters0973b992004-08-29 22:16:50 +00002811
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002812 carry = *pz + f * f;
2813 *pz++ = (digit)(carry & PyLong_MASK);
2814 carry >>= PyLong_SHIFT;
2815 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002816
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002817 /* Now f is added in twice in each column of the
2818 * pyramid it appears. Same as adding f<<1 once.
2819 */
2820 f <<= 1;
2821 while (pa < paend) {
2822 carry += *pz + *pa++ * f;
2823 *pz++ = (digit)(carry & PyLong_MASK);
2824 carry >>= PyLong_SHIFT;
2825 assert(carry <= (PyLong_MASK << 1));
2826 }
2827 if (carry) {
2828 carry += *pz;
2829 *pz++ = (digit)(carry & PyLong_MASK);
2830 carry >>= PyLong_SHIFT;
2831 }
2832 if (carry)
2833 *pz += (digit)(carry & PyLong_MASK);
2834 assert((carry >> PyLong_SHIFT) == 0);
2835 }
2836 }
2837 else { /* a is not the same as b -- gradeschool long mult */
2838 for (i = 0; i < size_a; ++i) {
2839 twodigits carry = 0;
2840 twodigits f = a->ob_digit[i];
2841 digit *pz = z->ob_digit + i;
2842 digit *pb = b->ob_digit;
2843 digit *pbend = b->ob_digit + size_b;
Tim Peters0973b992004-08-29 22:16:50 +00002844
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002845 SIGCHECK({
Mark Dickinson22b20182010-05-10 21:27:53 +00002846 Py_DECREF(z);
2847 return NULL;
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00002848 });
Tim Peters0973b992004-08-29 22:16:50 +00002849
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002850 while (pb < pbend) {
2851 carry += *pz + *pb++ * f;
2852 *pz++ = (digit)(carry & PyLong_MASK);
2853 carry >>= PyLong_SHIFT;
2854 assert(carry <= PyLong_MASK);
2855 }
2856 if (carry)
2857 *pz += (digit)(carry & PyLong_MASK);
2858 assert((carry >> PyLong_SHIFT) == 0);
2859 }
2860 }
2861 return long_normalize(z);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002862}
2863
2864/* A helper for Karatsuba multiplication (k_mul).
2865 Takes a long "n" and an integer "size" representing the place to
2866 split, and sets low and high such that abs(n) == (high << size) + low,
2867 viewing the shift as being by digits. The sign bit is ignored, and
2868 the return values are >= 0.
2869 Returns 0 on success, -1 on failure.
2870*/
2871static int
Mark Dickinson22b20182010-05-10 21:27:53 +00002872kmul_split(PyLongObject *n,
2873 Py_ssize_t size,
2874 PyLongObject **high,
2875 PyLongObject **low)
Tim Peters5af4e6c2002-08-12 02:31:19 +00002876{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002877 PyLongObject *hi, *lo;
2878 Py_ssize_t size_lo, size_hi;
2879 const Py_ssize_t size_n = ABS(Py_SIZE(n));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002880
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002881 size_lo = MIN(size_n, size);
2882 size_hi = size_n - size_lo;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002884 if ((hi = _PyLong_New(size_hi)) == NULL)
2885 return -1;
2886 if ((lo = _PyLong_New(size_lo)) == NULL) {
2887 Py_DECREF(hi);
2888 return -1;
2889 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002890
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002891 memcpy(lo->ob_digit, n->ob_digit, size_lo * sizeof(digit));
2892 memcpy(hi->ob_digit, n->ob_digit + size_lo, size_hi * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002893
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002894 *high = long_normalize(hi);
2895 *low = long_normalize(lo);
2896 return 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002897}
2898
Tim Peters60004642002-08-12 22:01:34 +00002899static PyLongObject *k_lopsided_mul(PyLongObject *a, PyLongObject *b);
2900
Tim Peters5af4e6c2002-08-12 02:31:19 +00002901/* Karatsuba multiplication. Ignores the input signs, and returns the
2902 * absolute value of the product (or NULL if error).
2903 * See Knuth Vol. 2 Chapter 4.3.3 (Pp. 294-295).
2904 */
2905static PyLongObject *
2906k_mul(PyLongObject *a, PyLongObject *b)
2907{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002908 Py_ssize_t asize = ABS(Py_SIZE(a));
2909 Py_ssize_t bsize = ABS(Py_SIZE(b));
2910 PyLongObject *ah = NULL;
2911 PyLongObject *al = NULL;
2912 PyLongObject *bh = NULL;
2913 PyLongObject *bl = NULL;
2914 PyLongObject *ret = NULL;
2915 PyLongObject *t1, *t2, *t3;
2916 Py_ssize_t shift; /* the number of digits we split off */
2917 Py_ssize_t i;
Tim Peters738eda72002-08-12 15:08:20 +00002918
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002919 /* (ah*X+al)(bh*X+bl) = ah*bh*X*X + (ah*bl + al*bh)*X + al*bl
2920 * Let k = (ah+al)*(bh+bl) = ah*bl + al*bh + ah*bh + al*bl
2921 * Then the original product is
2922 * ah*bh*X*X + (k - ah*bh - al*bl)*X + al*bl
2923 * By picking X to be a power of 2, "*X" is just shifting, and it's
2924 * been reduced to 3 multiplies on numbers half the size.
2925 */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002927 /* We want to split based on the larger number; fiddle so that b
2928 * is largest.
2929 */
2930 if (asize > bsize) {
2931 t1 = a;
2932 a = b;
2933 b = t1;
Tim Peters738eda72002-08-12 15:08:20 +00002934
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002935 i = asize;
2936 asize = bsize;
2937 bsize = i;
2938 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002939
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002940 /* Use gradeschool math when either number is too small. */
2941 i = a == b ? KARATSUBA_SQUARE_CUTOFF : KARATSUBA_CUTOFF;
2942 if (asize <= i) {
2943 if (asize == 0)
2944 return (PyLongObject *)PyLong_FromLong(0);
2945 else
2946 return x_mul(a, b);
2947 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002948
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002949 /* If a is small compared to b, splitting on b gives a degenerate
2950 * case with ah==0, and Karatsuba may be (even much) less efficient
2951 * than "grade school" then. However, we can still win, by viewing
2952 * b as a string of "big digits", each of width a->ob_size. That
2953 * leads to a sequence of balanced calls to k_mul.
2954 */
2955 if (2 * asize <= bsize)
2956 return k_lopsided_mul(a, b);
Tim Peters60004642002-08-12 22:01:34 +00002957
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002958 /* Split a & b into hi & lo pieces. */
2959 shift = bsize >> 1;
2960 if (kmul_split(a, shift, &ah, &al) < 0) goto fail;
2961 assert(Py_SIZE(ah) > 0); /* the split isn't degenerate */
Tim Petersd6974a52002-08-13 20:37:51 +00002962
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002963 if (a == b) {
2964 bh = ah;
2965 bl = al;
2966 Py_INCREF(bh);
2967 Py_INCREF(bl);
2968 }
2969 else if (kmul_split(b, shift, &bh, &bl) < 0) goto fail;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002970
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002971 /* The plan:
2972 * 1. Allocate result space (asize + bsize digits: that's always
2973 * enough).
2974 * 2. Compute ah*bh, and copy into result at 2*shift.
2975 * 3. Compute al*bl, and copy into result at 0. Note that this
2976 * can't overlap with #2.
2977 * 4. Subtract al*bl from the result, starting at shift. This may
2978 * underflow (borrow out of the high digit), but we don't care:
2979 * we're effectively doing unsigned arithmetic mod
2980 * BASE**(sizea + sizeb), and so long as the *final* result fits,
2981 * borrows and carries out of the high digit can be ignored.
2982 * 5. Subtract ah*bh from the result, starting at shift.
2983 * 6. Compute (ah+al)*(bh+bl), and add it into the result starting
2984 * at shift.
2985 */
Tim Petersd64c1de2002-08-12 17:36:03 +00002986
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002987 /* 1. Allocate result space. */
2988 ret = _PyLong_New(asize + bsize);
2989 if (ret == NULL) goto fail;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002990#ifdef Py_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002991 /* Fill with trash, to catch reference to uninitialized digits. */
2992 memset(ret->ob_digit, 0xDF, Py_SIZE(ret) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002993#endif
Tim Peters44121a62002-08-12 06:17:58 +00002994
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002995 /* 2. t1 <- ah*bh, and copy into high digits of result. */
2996 if ((t1 = k_mul(ah, bh)) == NULL) goto fail;
2997 assert(Py_SIZE(t1) >= 0);
2998 assert(2*shift + Py_SIZE(t1) <= Py_SIZE(ret));
2999 memcpy(ret->ob_digit + 2*shift, t1->ob_digit,
3000 Py_SIZE(t1) * sizeof(digit));
Tim Peters738eda72002-08-12 15:08:20 +00003001
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003002 /* Zero-out the digits higher than the ah*bh copy. */
3003 i = Py_SIZE(ret) - 2*shift - Py_SIZE(t1);
3004 if (i)
3005 memset(ret->ob_digit + 2*shift + Py_SIZE(t1), 0,
3006 i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003007
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003008 /* 3. t2 <- al*bl, and copy into the low digits. */
3009 if ((t2 = k_mul(al, bl)) == NULL) {
3010 Py_DECREF(t1);
3011 goto fail;
3012 }
3013 assert(Py_SIZE(t2) >= 0);
3014 assert(Py_SIZE(t2) <= 2*shift); /* no overlap with high digits */
3015 memcpy(ret->ob_digit, t2->ob_digit, Py_SIZE(t2) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003017 /* Zero out remaining digits. */
3018 i = 2*shift - Py_SIZE(t2); /* number of uninitialized digits */
3019 if (i)
3020 memset(ret->ob_digit + Py_SIZE(t2), 0, i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00003021
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003022 /* 4 & 5. Subtract ah*bh (t1) and al*bl (t2). We do al*bl first
3023 * because it's fresher in cache.
3024 */
3025 i = Py_SIZE(ret) - shift; /* # digits after shift */
3026 (void)v_isub(ret->ob_digit + shift, i, t2->ob_digit, Py_SIZE(t2));
3027 Py_DECREF(t2);
Tim Peters738eda72002-08-12 15:08:20 +00003028
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003029 (void)v_isub(ret->ob_digit + shift, i, t1->ob_digit, Py_SIZE(t1));
3030 Py_DECREF(t1);
Tim Peters738eda72002-08-12 15:08:20 +00003031
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003032 /* 6. t3 <- (ah+al)(bh+bl), and add into result. */
3033 if ((t1 = x_add(ah, al)) == NULL) goto fail;
3034 Py_DECREF(ah);
3035 Py_DECREF(al);
3036 ah = al = NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003037
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003038 if (a == b) {
3039 t2 = t1;
3040 Py_INCREF(t2);
3041 }
3042 else if ((t2 = x_add(bh, bl)) == NULL) {
3043 Py_DECREF(t1);
3044 goto fail;
3045 }
3046 Py_DECREF(bh);
3047 Py_DECREF(bl);
3048 bh = bl = NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003049
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003050 t3 = k_mul(t1, t2);
3051 Py_DECREF(t1);
3052 Py_DECREF(t2);
3053 if (t3 == NULL) goto fail;
3054 assert(Py_SIZE(t3) >= 0);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003055
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003056 /* Add t3. It's not obvious why we can't run out of room here.
3057 * See the (*) comment after this function.
3058 */
3059 (void)v_iadd(ret->ob_digit + shift, i, t3->ob_digit, Py_SIZE(t3));
3060 Py_DECREF(t3);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003061
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003062 return long_normalize(ret);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003063
Mark Dickinson22b20182010-05-10 21:27:53 +00003064 fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003065 Py_XDECREF(ret);
3066 Py_XDECREF(ah);
3067 Py_XDECREF(al);
3068 Py_XDECREF(bh);
3069 Py_XDECREF(bl);
3070 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003071}
3072
Tim Petersd6974a52002-08-13 20:37:51 +00003073/* (*) Why adding t3 can't "run out of room" above.
3074
Tim Petersab86c2b2002-08-15 20:06:00 +00003075Let f(x) mean the floor of x and c(x) mean the ceiling of x. Some facts
3076to start with:
Tim Petersd6974a52002-08-13 20:37:51 +00003077
Tim Petersab86c2b2002-08-15 20:06:00 +000030781. For any integer i, i = c(i/2) + f(i/2). In particular,
3079 bsize = c(bsize/2) + f(bsize/2).
30802. shift = f(bsize/2)
30813. asize <= bsize
30824. Since we call k_lopsided_mul if asize*2 <= bsize, asize*2 > bsize in this
3083 routine, so asize > bsize/2 >= f(bsize/2) in this routine.
Tim Petersd6974a52002-08-13 20:37:51 +00003084
Tim Petersab86c2b2002-08-15 20:06:00 +00003085We allocated asize + bsize result digits, and add t3 into them at an offset
3086of shift. This leaves asize+bsize-shift allocated digit positions for t3
3087to fit into, = (by #1 and #2) asize + f(bsize/2) + c(bsize/2) - f(bsize/2) =
3088asize + c(bsize/2) available digit positions.
Tim Petersd6974a52002-08-13 20:37:51 +00003089
Tim Petersab86c2b2002-08-15 20:06:00 +00003090bh has c(bsize/2) digits, and bl at most f(size/2) digits. So bh+hl has
3091at most c(bsize/2) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00003092
Tim Petersab86c2b2002-08-15 20:06:00 +00003093If asize == bsize, ah has c(bsize/2) digits, else ah has at most f(bsize/2)
3094digits, and al has at most f(bsize/2) digits in any case. So ah+al has at
3095most (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00003096
Tim Petersab86c2b2002-08-15 20:06:00 +00003097The product (ah+al)*(bh+bl) therefore has at most
Tim Petersd6974a52002-08-13 20:37:51 +00003098
Tim Petersab86c2b2002-08-15 20:06:00 +00003099 c(bsize/2) + (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits
Tim Petersd6974a52002-08-13 20:37:51 +00003100
Tim Petersab86c2b2002-08-15 20:06:00 +00003101and we have asize + c(bsize/2) available digit positions. We need to show
3102this is always enough. An instance of c(bsize/2) cancels out in both, so
3103the question reduces to whether asize digits is enough to hold
3104(asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits. If asize < bsize,
3105then we're asking whether asize digits >= f(bsize/2) digits + 2 bits. By #4,
3106asize 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 +00003107digit is enough to hold 2 bits. This is so since PyLong_SHIFT=15 >= 2. If
Tim Petersab86c2b2002-08-15 20:06:00 +00003108asize == bsize, then we're asking whether bsize digits is enough to hold
Tim Peterse417de02002-08-15 20:10:45 +00003109c(bsize/2) digits + 2 bits, or equivalently (by #1) whether f(bsize/2) digits
3110is enough to hold 2 bits. This is so if bsize >= 2, which holds because
3111bsize >= KARATSUBA_CUTOFF >= 2.
Tim Peters8e966ee2002-08-14 16:36:23 +00003112
Tim Peters48d52c02002-08-14 17:07:32 +00003113Note that since there's always enough room for (ah+al)*(bh+bl), and that's
3114clearly >= each of ah*bh and al*bl, there's always enough room to subtract
3115ah*bh and al*bl too.
Tim Petersd6974a52002-08-13 20:37:51 +00003116*/
3117
Tim Peters60004642002-08-12 22:01:34 +00003118/* b has at least twice the digits of a, and a is big enough that Karatsuba
3119 * would pay off *if* the inputs had balanced sizes. View b as a sequence
3120 * of slices, each with a->ob_size digits, and multiply the slices by a,
3121 * one at a time. This gives k_mul balanced inputs to work with, and is
3122 * also cache-friendly (we compute one double-width slice of the result
3123 * at a time, then move on, never bactracking except for the helpful
3124 * single-width slice overlap between successive partial sums).
3125 */
3126static PyLongObject *
3127k_lopsided_mul(PyLongObject *a, PyLongObject *b)
3128{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003129 const Py_ssize_t asize = ABS(Py_SIZE(a));
3130 Py_ssize_t bsize = ABS(Py_SIZE(b));
3131 Py_ssize_t nbdone; /* # of b digits already multiplied */
3132 PyLongObject *ret;
3133 PyLongObject *bslice = NULL;
Tim Peters60004642002-08-12 22:01:34 +00003134
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003135 assert(asize > KARATSUBA_CUTOFF);
3136 assert(2 * asize <= bsize);
Tim Peters60004642002-08-12 22:01:34 +00003137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003138 /* Allocate result space, and zero it out. */
3139 ret = _PyLong_New(asize + bsize);
3140 if (ret == NULL)
3141 return NULL;
3142 memset(ret->ob_digit, 0, Py_SIZE(ret) * sizeof(digit));
Tim Peters60004642002-08-12 22:01:34 +00003143
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003144 /* Successive slices of b are copied into bslice. */
3145 bslice = _PyLong_New(asize);
3146 if (bslice == NULL)
3147 goto fail;
Tim Peters60004642002-08-12 22:01:34 +00003148
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003149 nbdone = 0;
3150 while (bsize > 0) {
3151 PyLongObject *product;
3152 const Py_ssize_t nbtouse = MIN(bsize, asize);
Tim Peters60004642002-08-12 22:01:34 +00003153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003154 /* Multiply the next slice of b by a. */
3155 memcpy(bslice->ob_digit, b->ob_digit + nbdone,
3156 nbtouse * sizeof(digit));
3157 Py_SIZE(bslice) = nbtouse;
3158 product = k_mul(a, bslice);
3159 if (product == NULL)
3160 goto fail;
Tim Peters60004642002-08-12 22:01:34 +00003161
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003162 /* Add into result. */
3163 (void)v_iadd(ret->ob_digit + nbdone, Py_SIZE(ret) - nbdone,
3164 product->ob_digit, Py_SIZE(product));
3165 Py_DECREF(product);
Tim Peters60004642002-08-12 22:01:34 +00003166
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003167 bsize -= nbtouse;
3168 nbdone += nbtouse;
3169 }
Tim Peters60004642002-08-12 22:01:34 +00003170
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003171 Py_DECREF(bslice);
3172 return long_normalize(ret);
Tim Peters60004642002-08-12 22:01:34 +00003173
Mark Dickinson22b20182010-05-10 21:27:53 +00003174 fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003175 Py_DECREF(ret);
3176 Py_XDECREF(bslice);
3177 return NULL;
Tim Peters60004642002-08-12 22:01:34 +00003178}
Tim Peters5af4e6c2002-08-12 02:31:19 +00003179
3180static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003181long_mul(PyLongObject *a, PyLongObject *b)
Tim Peters5af4e6c2002-08-12 02:31:19 +00003182{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003183 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003184
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003185 CHECK_BINOP(a, b);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003186
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003187 /* fast path for single-digit multiplication */
3188 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
3189 stwodigits v = (stwodigits)(MEDIUM_VALUE(a)) * MEDIUM_VALUE(b);
Mark Dickinsonbd792642009-03-18 20:06:12 +00003190#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003191 return PyLong_FromLongLong((PY_LONG_LONG)v);
Mark Dickinsonbd792642009-03-18 20:06:12 +00003192#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003193 /* if we don't have long long then we're almost certainly
3194 using 15-bit digits, so v will fit in a long. In the
3195 unlikely event that we're using 30-bit digits on a platform
3196 without long long, a large v will just cause us to fall
3197 through to the general multiplication code below. */
3198 if (v >= LONG_MIN && v <= LONG_MAX)
3199 return PyLong_FromLong((long)v);
Mark Dickinsonbd792642009-03-18 20:06:12 +00003200#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003201 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00003202
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003203 z = k_mul(a, b);
3204 /* Negate if exactly one of the inputs is negative. */
3205 if (((Py_SIZE(a) ^ Py_SIZE(b)) < 0) && z)
3206 NEGATE(z);
3207 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003208}
3209
Guido van Rossume32e0141992-01-19 16:31:05 +00003210/* The / and % operators are now defined in terms of divmod().
3211 The expression a mod b has the value a - b*floor(a/b).
3212 The long_divrem function gives the remainder after division of
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003213 |a| by |b|, with the sign of a. This is also expressed
3214 as a - b*trunc(a/b), if trunc truncates towards zero.
3215 Some examples:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003216 a b a rem b a mod b
3217 13 10 3 3
3218 -13 10 -3 7
3219 13 -10 3 -7
3220 -13 -10 -3 -3
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003221 So, to get from rem to mod, we have to add b if a and b
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003222 have different signs. We then subtract one from the 'div'
3223 part of the outcome to keep the invariant intact. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003224
Tim Peters47e52ee2004-08-30 02:44:38 +00003225/* Compute
3226 * *pdiv, *pmod = divmod(v, w)
3227 * NULL can be passed for pdiv or pmod, in which case that part of
3228 * the result is simply thrown away. The caller owns a reference to
3229 * each of these it requests (does not pass NULL for).
3230 */
Guido van Rossume32e0141992-01-19 16:31:05 +00003231static int
Tim Peters5af4e6c2002-08-12 02:31:19 +00003232l_divmod(PyLongObject *v, PyLongObject *w,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003233 PyLongObject **pdiv, PyLongObject **pmod)
Guido van Rossume32e0141992-01-19 16:31:05 +00003234{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003235 PyLongObject *div, *mod;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003236
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003237 if (long_divrem(v, w, &div, &mod) < 0)
3238 return -1;
3239 if ((Py_SIZE(mod) < 0 && Py_SIZE(w) > 0) ||
3240 (Py_SIZE(mod) > 0 && Py_SIZE(w) < 0)) {
3241 PyLongObject *temp;
3242 PyLongObject *one;
3243 temp = (PyLongObject *) long_add(mod, w);
3244 Py_DECREF(mod);
3245 mod = temp;
3246 if (mod == NULL) {
3247 Py_DECREF(div);
3248 return -1;
3249 }
3250 one = (PyLongObject *) PyLong_FromLong(1L);
3251 if (one == NULL ||
3252 (temp = (PyLongObject *) long_sub(div, one)) == NULL) {
3253 Py_DECREF(mod);
3254 Py_DECREF(div);
3255 Py_XDECREF(one);
3256 return -1;
3257 }
3258 Py_DECREF(one);
3259 Py_DECREF(div);
3260 div = temp;
3261 }
3262 if (pdiv != NULL)
3263 *pdiv = div;
3264 else
3265 Py_DECREF(div);
Tim Peters47e52ee2004-08-30 02:44:38 +00003266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003267 if (pmod != NULL)
3268 *pmod = mod;
3269 else
3270 Py_DECREF(mod);
Tim Peters47e52ee2004-08-30 02:44:38 +00003271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003272 return 0;
Guido van Rossume32e0141992-01-19 16:31:05 +00003273}
3274
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003275static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003276long_div(PyObject *a, PyObject *b)
Guido van Rossume32e0141992-01-19 16:31:05 +00003277{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003278 PyLongObject *div;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003279
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003280 CHECK_BINOP(a, b);
3281 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, &div, NULL) < 0)
3282 div = NULL;
3283 return (PyObject *)div;
Guido van Rossume32e0141992-01-19 16:31:05 +00003284}
3285
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003286/* PyLong/PyLong -> float, with correctly rounded result. */
3287
3288#define MANT_DIG_DIGITS (DBL_MANT_DIG / PyLong_SHIFT)
3289#define MANT_DIG_BITS (DBL_MANT_DIG % PyLong_SHIFT)
3290
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003291static PyObject *
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003292long_true_divide(PyObject *v, PyObject *w)
Tim Peters20dab9f2001-09-04 05:31:47 +00003293{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003294 PyLongObject *a, *b, *x;
3295 Py_ssize_t a_size, b_size, shift, extra_bits, diff, x_size, x_bits;
3296 digit mask, low;
3297 int inexact, negate, a_is_small, b_is_small;
3298 double dx, result;
Tim Peterse2a60002001-09-04 06:17:36 +00003299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003300 CHECK_BINOP(v, w);
3301 a = (PyLongObject *)v;
3302 b = (PyLongObject *)w;
Tim Peterse2a60002001-09-04 06:17:36 +00003303
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003304 /*
3305 Method in a nutshell:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003307 0. reduce to case a, b > 0; filter out obvious underflow/overflow
3308 1. choose a suitable integer 'shift'
3309 2. use integer arithmetic to compute x = floor(2**-shift*a/b)
3310 3. adjust x for correct rounding
3311 4. convert x to a double dx with the same value
3312 5. return ldexp(dx, shift).
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003313
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003314 In more detail:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003315
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003316 0. For any a, a/0 raises ZeroDivisionError; for nonzero b, 0/b
3317 returns either 0.0 or -0.0, depending on the sign of b. For a and
3318 b both nonzero, ignore signs of a and b, and add the sign back in
3319 at the end. Now write a_bits and b_bits for the bit lengths of a
3320 and b respectively (that is, a_bits = 1 + floor(log_2(a)); likewise
3321 for b). Then
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003323 2**(a_bits - b_bits - 1) < a/b < 2**(a_bits - b_bits + 1).
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003324
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003325 So if a_bits - b_bits > DBL_MAX_EXP then a/b > 2**DBL_MAX_EXP and
3326 so overflows. Similarly, if a_bits - b_bits < DBL_MIN_EXP -
3327 DBL_MANT_DIG - 1 then a/b underflows to 0. With these cases out of
3328 the way, we can assume that
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003329
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003330 DBL_MIN_EXP - DBL_MANT_DIG - 1 <= a_bits - b_bits <= DBL_MAX_EXP.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003331
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003332 1. The integer 'shift' is chosen so that x has the right number of
3333 bits for a double, plus two or three extra bits that will be used
3334 in the rounding decisions. Writing a_bits and b_bits for the
3335 number of significant bits in a and b respectively, a
3336 straightforward formula for shift is:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003337
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003338 shift = a_bits - b_bits - DBL_MANT_DIG - 2
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003340 This is fine in the usual case, but if a/b is smaller than the
3341 smallest normal float then it can lead to double rounding on an
3342 IEEE 754 platform, giving incorrectly rounded results. So we
3343 adjust the formula slightly. The actual formula used is:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003344
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003345 shift = MAX(a_bits - b_bits, DBL_MIN_EXP) - DBL_MANT_DIG - 2
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003347 2. The quantity x is computed by first shifting a (left -shift bits
3348 if shift <= 0, right shift bits if shift > 0) and then dividing by
3349 b. For both the shift and the division, we keep track of whether
3350 the result is inexact, in a flag 'inexact'; this information is
3351 needed at the rounding stage.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003352
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003353 With the choice of shift above, together with our assumption that
3354 a_bits - b_bits >= DBL_MIN_EXP - DBL_MANT_DIG - 1, it follows
3355 that x >= 1.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003356
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003357 3. Now x * 2**shift <= a/b < (x+1) * 2**shift. We want to replace
3358 this with an exactly representable float of the form
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003360 round(x/2**extra_bits) * 2**(extra_bits+shift).
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003361
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003362 For float representability, we need x/2**extra_bits <
3363 2**DBL_MANT_DIG and extra_bits + shift >= DBL_MIN_EXP -
3364 DBL_MANT_DIG. This translates to the condition:
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003365
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003366 extra_bits >= MAX(x_bits, DBL_MIN_EXP - shift) - DBL_MANT_DIG
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003367
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003368 To round, we just modify the bottom digit of x in-place; this can
3369 end up giving a digit with value > PyLONG_MASK, but that's not a
3370 problem since digits can hold values up to 2*PyLONG_MASK+1.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003372 With the original choices for shift above, extra_bits will always
3373 be 2 or 3. Then rounding under the round-half-to-even rule, we
3374 round up iff the most significant of the extra bits is 1, and
3375 either: (a) the computation of x in step 2 had an inexact result,
3376 or (b) at least one other of the extra bits is 1, or (c) the least
3377 significant bit of x (above those to be rounded) is 1.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003379 4. Conversion to a double is straightforward; all floating-point
3380 operations involved in the conversion are exact, so there's no
3381 danger of rounding errors.
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003382
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003383 5. Use ldexp(x, shift) to compute x*2**shift, the final result.
3384 The result will always be exactly representable as a double, except
3385 in the case that it overflows. To avoid dependence on the exact
3386 behaviour of ldexp on overflow, we check for overflow before
3387 applying ldexp. The result of ldexp is adjusted for sign before
3388 returning.
3389 */
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003390
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003391 /* Reduce to case where a and b are both positive. */
3392 a_size = ABS(Py_SIZE(a));
3393 b_size = ABS(Py_SIZE(b));
3394 negate = (Py_SIZE(a) < 0) ^ (Py_SIZE(b) < 0);
3395 if (b_size == 0) {
3396 PyErr_SetString(PyExc_ZeroDivisionError,
3397 "division by zero");
3398 goto error;
3399 }
3400 if (a_size == 0)
3401 goto underflow_or_zero;
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003403 /* Fast path for a and b small (exactly representable in a double).
3404 Relies on floating-point division being correctly rounded; results
3405 may be subject to double rounding on x86 machines that operate with
3406 the x87 FPU set to 64-bit precision. */
3407 a_is_small = a_size <= MANT_DIG_DIGITS ||
3408 (a_size == MANT_DIG_DIGITS+1 &&
3409 a->ob_digit[MANT_DIG_DIGITS] >> MANT_DIG_BITS == 0);
3410 b_is_small = b_size <= MANT_DIG_DIGITS ||
3411 (b_size == MANT_DIG_DIGITS+1 &&
3412 b->ob_digit[MANT_DIG_DIGITS] >> MANT_DIG_BITS == 0);
3413 if (a_is_small && b_is_small) {
3414 double da, db;
3415 da = a->ob_digit[--a_size];
3416 while (a_size > 0)
3417 da = da * PyLong_BASE + a->ob_digit[--a_size];
3418 db = b->ob_digit[--b_size];
3419 while (b_size > 0)
3420 db = db * PyLong_BASE + b->ob_digit[--b_size];
3421 result = da / db;
3422 goto success;
3423 }
Tim Peterse2a60002001-09-04 06:17:36 +00003424
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003425 /* Catch obvious cases of underflow and overflow */
3426 diff = a_size - b_size;
3427 if (diff > PY_SSIZE_T_MAX/PyLong_SHIFT - 1)
3428 /* Extreme overflow */
3429 goto overflow;
3430 else if (diff < 1 - PY_SSIZE_T_MAX/PyLong_SHIFT)
3431 /* Extreme underflow */
3432 goto underflow_or_zero;
3433 /* Next line is now safe from overflowing a Py_ssize_t */
3434 diff = diff * PyLong_SHIFT + bits_in_digit(a->ob_digit[a_size - 1]) -
3435 bits_in_digit(b->ob_digit[b_size - 1]);
3436 /* Now diff = a_bits - b_bits. */
3437 if (diff > DBL_MAX_EXP)
3438 goto overflow;
3439 else if (diff < DBL_MIN_EXP - DBL_MANT_DIG - 1)
3440 goto underflow_or_zero;
Tim Peterse2a60002001-09-04 06:17:36 +00003441
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003442 /* Choose value for shift; see comments for step 1 above. */
3443 shift = MAX(diff, DBL_MIN_EXP) - DBL_MANT_DIG - 2;
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003445 inexact = 0;
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003447 /* x = abs(a * 2**-shift) */
3448 if (shift <= 0) {
3449 Py_ssize_t i, shift_digits = -shift / PyLong_SHIFT;
3450 digit rem;
3451 /* x = a << -shift */
3452 if (a_size >= PY_SSIZE_T_MAX - 1 - shift_digits) {
3453 /* In practice, it's probably impossible to end up
3454 here. Both a and b would have to be enormous,
3455 using close to SIZE_T_MAX bytes of memory each. */
3456 PyErr_SetString(PyExc_OverflowError,
Mark Dickinson22b20182010-05-10 21:27:53 +00003457 "intermediate overflow during division");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003458 goto error;
3459 }
3460 x = _PyLong_New(a_size + shift_digits + 1);
3461 if (x == NULL)
3462 goto error;
3463 for (i = 0; i < shift_digits; i++)
3464 x->ob_digit[i] = 0;
3465 rem = v_lshift(x->ob_digit + shift_digits, a->ob_digit,
3466 a_size, -shift % PyLong_SHIFT);
3467 x->ob_digit[a_size + shift_digits] = rem;
3468 }
3469 else {
3470 Py_ssize_t shift_digits = shift / PyLong_SHIFT;
3471 digit rem;
3472 /* x = a >> shift */
3473 assert(a_size >= shift_digits);
3474 x = _PyLong_New(a_size - shift_digits);
3475 if (x == NULL)
3476 goto error;
3477 rem = v_rshift(x->ob_digit, a->ob_digit + shift_digits,
3478 a_size - shift_digits, shift % PyLong_SHIFT);
3479 /* set inexact if any of the bits shifted out is nonzero */
3480 if (rem)
3481 inexact = 1;
3482 while (!inexact && shift_digits > 0)
3483 if (a->ob_digit[--shift_digits])
3484 inexact = 1;
3485 }
3486 long_normalize(x);
3487 x_size = Py_SIZE(x);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003489 /* x //= b. If the remainder is nonzero, set inexact. We own the only
3490 reference to x, so it's safe to modify it in-place. */
3491 if (b_size == 1) {
3492 digit rem = inplace_divrem1(x->ob_digit, x->ob_digit, x_size,
3493 b->ob_digit[0]);
3494 long_normalize(x);
3495 if (rem)
3496 inexact = 1;
3497 }
3498 else {
3499 PyLongObject *div, *rem;
3500 div = x_divrem(x, b, &rem);
3501 Py_DECREF(x);
3502 x = div;
3503 if (x == NULL)
3504 goto error;
3505 if (Py_SIZE(rem))
3506 inexact = 1;
3507 Py_DECREF(rem);
3508 }
3509 x_size = ABS(Py_SIZE(x));
3510 assert(x_size > 0); /* result of division is never zero */
3511 x_bits = (x_size-1)*PyLong_SHIFT+bits_in_digit(x->ob_digit[x_size-1]);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003513 /* The number of extra bits that have to be rounded away. */
3514 extra_bits = MAX(x_bits, DBL_MIN_EXP - shift) - DBL_MANT_DIG;
3515 assert(extra_bits == 2 || extra_bits == 3);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003516
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003517 /* Round by directly modifying the low digit of x. */
3518 mask = (digit)1 << (extra_bits - 1);
3519 low = x->ob_digit[0] | inexact;
3520 if (low & mask && low & (3*mask-1))
3521 low += mask;
3522 x->ob_digit[0] = low & ~(mask-1U);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003523
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003524 /* Convert x to a double dx; the conversion is exact. */
3525 dx = x->ob_digit[--x_size];
3526 while (x_size > 0)
3527 dx = dx * PyLong_BASE + x->ob_digit[--x_size];
3528 Py_DECREF(x);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003529
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003530 /* Check whether ldexp result will overflow a double. */
3531 if (shift + x_bits >= DBL_MAX_EXP &&
3532 (shift + x_bits > DBL_MAX_EXP || dx == ldexp(1.0, (int)x_bits)))
3533 goto overflow;
3534 result = ldexp(dx, (int)shift);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003535
3536 success:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003537 return PyFloat_FromDouble(negate ? -result : result);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003538
3539 underflow_or_zero:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003540 return PyFloat_FromDouble(negate ? -0.0 : 0.0);
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003541
3542 overflow:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003543 PyErr_SetString(PyExc_OverflowError,
3544 "integer division result too large for a float");
Mark Dickinsoncbb62742009-12-27 15:09:50 +00003545 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003546 return NULL;
Tim Peters20dab9f2001-09-04 05:31:47 +00003547}
3548
3549static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003550long_mod(PyObject *a, PyObject *b)
Guido van Rossume32e0141992-01-19 16:31:05 +00003551{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003552 PyLongObject *mod;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003553
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003554 CHECK_BINOP(a, b);
3555
3556 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, NULL, &mod) < 0)
3557 mod = NULL;
3558 return (PyObject *)mod;
Guido van Rossume32e0141992-01-19 16:31:05 +00003559}
3560
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003561static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003562long_divmod(PyObject *a, PyObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003563{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003564 PyLongObject *div, *mod;
3565 PyObject *z;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003567 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003569 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, &div, &mod) < 0) {
3570 return NULL;
3571 }
3572 z = PyTuple_New(2);
3573 if (z != NULL) {
3574 PyTuple_SetItem(z, 0, (PyObject *) div);
3575 PyTuple_SetItem(z, 1, (PyObject *) mod);
3576 }
3577 else {
3578 Py_DECREF(div);
3579 Py_DECREF(mod);
3580 }
3581 return z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003582}
3583
Tim Peters47e52ee2004-08-30 02:44:38 +00003584/* pow(v, w, x) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003585static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003586long_pow(PyObject *v, PyObject *w, PyObject *x)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003587{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003588 PyLongObject *a, *b, *c; /* a,b,c = v,w,x */
3589 int negativeOutput = 0; /* if x<0 return negative output */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003590
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003591 PyLongObject *z = NULL; /* accumulated result */
3592 Py_ssize_t i, j, k; /* counters */
3593 PyLongObject *temp = NULL;
Tim Peters47e52ee2004-08-30 02:44:38 +00003594
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003595 /* 5-ary values. If the exponent is large enough, table is
3596 * precomputed so that table[i] == a**i % c for i in range(32).
3597 */
3598 PyLongObject *table[32] = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
3599 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0};
Tim Peters47e52ee2004-08-30 02:44:38 +00003600
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003601 /* a, b, c = v, w, x */
3602 CHECK_BINOP(v, w);
3603 a = (PyLongObject*)v; Py_INCREF(a);
3604 b = (PyLongObject*)w; Py_INCREF(b);
3605 if (PyLong_Check(x)) {
3606 c = (PyLongObject *)x;
3607 Py_INCREF(x);
3608 }
3609 else if (x == Py_None)
3610 c = NULL;
3611 else {
3612 Py_DECREF(a);
3613 Py_DECREF(b);
3614 Py_INCREF(Py_NotImplemented);
3615 return Py_NotImplemented;
3616 }
Tim Peters4c483c42001-09-05 06:24:58 +00003617
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003618 if (Py_SIZE(b) < 0) { /* if exponent is negative */
3619 if (c) {
3620 PyErr_SetString(PyExc_TypeError, "pow() 2nd argument "
Mark Dickinson22b20182010-05-10 21:27:53 +00003621 "cannot be negative when 3rd argument specified");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003622 goto Error;
3623 }
3624 else {
3625 /* else return a float. This works because we know
3626 that this calls float_pow() which converts its
3627 arguments to double. */
3628 Py_DECREF(a);
3629 Py_DECREF(b);
3630 return PyFloat_Type.tp_as_number->nb_power(v, w, x);
3631 }
3632 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003633
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003634 if (c) {
3635 /* if modulus == 0:
3636 raise ValueError() */
3637 if (Py_SIZE(c) == 0) {
3638 PyErr_SetString(PyExc_ValueError,
3639 "pow() 3rd argument cannot be 0");
3640 goto Error;
3641 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003642
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003643 /* if modulus < 0:
3644 negativeOutput = True
3645 modulus = -modulus */
3646 if (Py_SIZE(c) < 0) {
3647 negativeOutput = 1;
3648 temp = (PyLongObject *)_PyLong_Copy(c);
3649 if (temp == NULL)
3650 goto Error;
3651 Py_DECREF(c);
3652 c = temp;
3653 temp = NULL;
3654 NEGATE(c);
3655 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003656
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003657 /* if modulus == 1:
3658 return 0 */
3659 if ((Py_SIZE(c) == 1) && (c->ob_digit[0] == 1)) {
3660 z = (PyLongObject *)PyLong_FromLong(0L);
3661 goto Done;
3662 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003663
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003664 /* if base < 0:
3665 base = base % modulus
3666 Having the base positive just makes things easier. */
3667 if (Py_SIZE(a) < 0) {
3668 if (l_divmod(a, c, NULL, &temp) < 0)
3669 goto Error;
3670 Py_DECREF(a);
3671 a = temp;
3672 temp = NULL;
3673 }
3674 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003675
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003676 /* At this point a, b, and c are guaranteed non-negative UNLESS
3677 c is NULL, in which case a may be negative. */
Tim Peters47e52ee2004-08-30 02:44:38 +00003678
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003679 z = (PyLongObject *)PyLong_FromLong(1L);
3680 if (z == NULL)
3681 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00003682
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003683 /* Perform a modular reduction, X = X % c, but leave X alone if c
3684 * is NULL.
3685 */
3686#define REDUCE(X) \
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00003687 do { \
3688 if (c != NULL) { \
3689 if (l_divmod(X, c, NULL, &temp) < 0) \
3690 goto Error; \
3691 Py_XDECREF(X); \
3692 X = temp; \
3693 temp = NULL; \
3694 } \
3695 } while(0)
Tim Peters47e52ee2004-08-30 02:44:38 +00003696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003697 /* Multiply two values, then reduce the result:
3698 result = X*Y % c. If c is NULL, skip the mod. */
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00003699#define MULT(X, Y, result) \
3700 do { \
3701 temp = (PyLongObject *)long_mul(X, Y); \
3702 if (temp == NULL) \
3703 goto Error; \
3704 Py_XDECREF(result); \
3705 result = temp; \
3706 temp = NULL; \
3707 REDUCE(result); \
3708 } while(0)
Tim Peters47e52ee2004-08-30 02:44:38 +00003709
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003710 if (Py_SIZE(b) <= FIVEARY_CUTOFF) {
3711 /* Left-to-right binary exponentiation (HAC Algorithm 14.79) */
3712 /* http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf */
3713 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
3714 digit bi = b->ob_digit[i];
Tim Peters47e52ee2004-08-30 02:44:38 +00003715
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003716 for (j = (digit)1 << (PyLong_SHIFT-1); j != 0; j >>= 1) {
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00003717 MULT(z, z, z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003718 if (bi & j)
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00003719 MULT(z, a, z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003720 }
3721 }
3722 }
3723 else {
3724 /* Left-to-right 5-ary exponentiation (HAC Algorithm 14.82) */
3725 Py_INCREF(z); /* still holds 1L */
3726 table[0] = z;
3727 for (i = 1; i < 32; ++i)
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00003728 MULT(table[i-1], a, table[i]);
Tim Peters47e52ee2004-08-30 02:44:38 +00003729
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003730 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
3731 const digit bi = b->ob_digit[i];
Tim Peters47e52ee2004-08-30 02:44:38 +00003732
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003733 for (j = PyLong_SHIFT - 5; j >= 0; j -= 5) {
3734 const int index = (bi >> j) & 0x1f;
3735 for (k = 0; k < 5; ++k)
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00003736 MULT(z, z, z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003737 if (index)
Mark Dickinsoncdd01d22010-05-10 21:37:34 +00003738 MULT(z, table[index], z);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003739 }
3740 }
3741 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003742
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003743 if (negativeOutput && (Py_SIZE(z) != 0)) {
3744 temp = (PyLongObject *)long_sub(z, c);
3745 if (temp == NULL)
3746 goto Error;
3747 Py_DECREF(z);
3748 z = temp;
3749 temp = NULL;
3750 }
3751 goto Done;
Tim Peters47e52ee2004-08-30 02:44:38 +00003752
Mark Dickinson22b20182010-05-10 21:27:53 +00003753 Error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003754 if (z != NULL) {
3755 Py_DECREF(z);
3756 z = NULL;
3757 }
3758 /* fall through */
Mark Dickinson22b20182010-05-10 21:27:53 +00003759 Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003760 if (Py_SIZE(b) > FIVEARY_CUTOFF) {
3761 for (i = 0; i < 32; ++i)
3762 Py_XDECREF(table[i]);
3763 }
3764 Py_DECREF(a);
3765 Py_DECREF(b);
3766 Py_XDECREF(c);
3767 Py_XDECREF(temp);
3768 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003769}
3770
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003771static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003772long_invert(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003773{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003774 /* Implement ~x as -(x+1) */
3775 PyLongObject *x;
3776 PyLongObject *w;
3777 if (ABS(Py_SIZE(v)) <=1)
3778 return PyLong_FromLong(-(MEDIUM_VALUE(v)+1));
3779 w = (PyLongObject *)PyLong_FromLong(1L);
3780 if (w == NULL)
3781 return NULL;
3782 x = (PyLongObject *) long_add(v, w);
3783 Py_DECREF(w);
3784 if (x == NULL)
3785 return NULL;
3786 Py_SIZE(x) = -(Py_SIZE(x));
3787 return (PyObject *)maybe_small_long(x);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003788}
3789
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003790static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003791long_neg(PyLongObject *v)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003792{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003793 PyLongObject *z;
3794 if (ABS(Py_SIZE(v)) <= 1)
3795 return PyLong_FromLong(-MEDIUM_VALUE(v));
3796 z = (PyLongObject *)_PyLong_Copy(v);
3797 if (z != NULL)
3798 Py_SIZE(z) = -(Py_SIZE(v));
3799 return (PyObject *)z;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003800}
3801
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003802static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003803long_abs(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003804{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003805 if (Py_SIZE(v) < 0)
3806 return long_neg(v);
3807 else
3808 return long_long((PyObject *)v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003809}
3810
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003811static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00003812long_bool(PyLongObject *v)
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003813{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003814 return Py_SIZE(v) != 0;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003815}
3816
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003817static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003818long_rshift(PyLongObject *a, PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003819{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003820 PyLongObject *z = NULL;
3821 Py_ssize_t shiftby, newsize, wordshift, loshift, hishift, i, j;
3822 digit lomask, himask;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003823
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003824 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003825
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003826 if (Py_SIZE(a) < 0) {
3827 /* Right shifting negative numbers is harder */
3828 PyLongObject *a1, *a2;
3829 a1 = (PyLongObject *) long_invert(a);
3830 if (a1 == NULL)
3831 goto rshift_error;
3832 a2 = (PyLongObject *) long_rshift(a1, b);
3833 Py_DECREF(a1);
3834 if (a2 == NULL)
3835 goto rshift_error;
3836 z = (PyLongObject *) long_invert(a2);
3837 Py_DECREF(a2);
3838 }
3839 else {
3840 shiftby = PyLong_AsSsize_t((PyObject *)b);
3841 if (shiftby == -1L && PyErr_Occurred())
3842 goto rshift_error;
3843 if (shiftby < 0) {
3844 PyErr_SetString(PyExc_ValueError,
3845 "negative shift count");
3846 goto rshift_error;
3847 }
3848 wordshift = shiftby / PyLong_SHIFT;
3849 newsize = ABS(Py_SIZE(a)) - wordshift;
3850 if (newsize <= 0)
3851 return PyLong_FromLong(0);
3852 loshift = shiftby % PyLong_SHIFT;
3853 hishift = PyLong_SHIFT - loshift;
3854 lomask = ((digit)1 << hishift) - 1;
3855 himask = PyLong_MASK ^ lomask;
3856 z = _PyLong_New(newsize);
3857 if (z == NULL)
3858 goto rshift_error;
3859 if (Py_SIZE(a) < 0)
3860 Py_SIZE(z) = -(Py_SIZE(z));
3861 for (i = 0, j = wordshift; i < newsize; i++, j++) {
3862 z->ob_digit[i] = (a->ob_digit[j] >> loshift) & lomask;
3863 if (i+1 < newsize)
Mark Dickinson22b20182010-05-10 21:27:53 +00003864 z->ob_digit[i] |= (a->ob_digit[j+1] << hishift) & himask;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003865 }
3866 z = long_normalize(z);
3867 }
Mark Dickinson22b20182010-05-10 21:27:53 +00003868 rshift_error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003869 return (PyObject *) maybe_small_long(z);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003870
Guido van Rossumc6913e71991-11-19 20:26:46 +00003871}
3872
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003873static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003874long_lshift(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003875{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003876 /* This version due to Tim Peters */
3877 PyLongObject *a = (PyLongObject*)v;
3878 PyLongObject *b = (PyLongObject*)w;
3879 PyLongObject *z = NULL;
3880 Py_ssize_t shiftby, oldsize, newsize, wordshift, remshift, i, j;
3881 twodigits accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003882
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003883 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003884
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003885 shiftby = PyLong_AsSsize_t((PyObject *)b);
3886 if (shiftby == -1L && PyErr_Occurred())
3887 goto lshift_error;
3888 if (shiftby < 0) {
3889 PyErr_SetString(PyExc_ValueError, "negative shift count");
3890 goto lshift_error;
3891 }
3892 /* wordshift, remshift = divmod(shiftby, PyLong_SHIFT) */
3893 wordshift = shiftby / PyLong_SHIFT;
3894 remshift = shiftby - wordshift * PyLong_SHIFT;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003895
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003896 oldsize = ABS(Py_SIZE(a));
3897 newsize = oldsize + wordshift;
3898 if (remshift)
3899 ++newsize;
3900 z = _PyLong_New(newsize);
3901 if (z == NULL)
3902 goto lshift_error;
3903 if (Py_SIZE(a) < 0)
3904 NEGATE(z);
3905 for (i = 0; i < wordshift; i++)
3906 z->ob_digit[i] = 0;
3907 accum = 0;
3908 for (i = wordshift, j = 0; j < oldsize; i++, j++) {
3909 accum |= (twodigits)a->ob_digit[j] << remshift;
3910 z->ob_digit[i] = (digit)(accum & PyLong_MASK);
3911 accum >>= PyLong_SHIFT;
3912 }
3913 if (remshift)
3914 z->ob_digit[newsize-1] = (digit)accum;
3915 else
3916 assert(!accum);
3917 z = long_normalize(z);
Mark Dickinson22b20182010-05-10 21:27:53 +00003918 lshift_error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003919 return (PyObject *) maybe_small_long(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003920}
3921
Mark Dickinson27a87a22009-10-25 20:43:34 +00003922/* Compute two's complement of digit vector a[0:m], writing result to
3923 z[0:m]. The digit vector a need not be normalized, but should not
3924 be entirely zero. a and z may point to the same digit vector. */
3925
3926static void
3927v_complement(digit *z, digit *a, Py_ssize_t m)
3928{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003929 Py_ssize_t i;
3930 digit carry = 1;
3931 for (i = 0; i < m; ++i) {
3932 carry += a[i] ^ PyLong_MASK;
3933 z[i] = carry & PyLong_MASK;
3934 carry >>= PyLong_SHIFT;
3935 }
3936 assert(carry == 0);
Mark Dickinson27a87a22009-10-25 20:43:34 +00003937}
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003938
3939/* Bitwise and/xor/or operations */
3940
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003941static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003942long_bitwise(PyLongObject *a,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003943 int op, /* '&', '|', '^' */
Mark Dickinson22b20182010-05-10 21:27:53 +00003944 PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003945{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003946 int nega, negb, negz;
3947 Py_ssize_t size_a, size_b, size_z, i;
3948 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003949
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003950 /* Bitwise operations for negative numbers operate as though
3951 on a two's complement representation. So convert arguments
3952 from sign-magnitude to two's complement, and convert the
3953 result back to sign-magnitude at the end. */
Mark Dickinson27a87a22009-10-25 20:43:34 +00003954
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003955 /* If a is negative, replace it by its two's complement. */
3956 size_a = ABS(Py_SIZE(a));
3957 nega = Py_SIZE(a) < 0;
3958 if (nega) {
3959 z = _PyLong_New(size_a);
3960 if (z == NULL)
3961 return NULL;
3962 v_complement(z->ob_digit, a->ob_digit, size_a);
3963 a = z;
3964 }
3965 else
3966 /* Keep reference count consistent. */
3967 Py_INCREF(a);
Mark Dickinson27a87a22009-10-25 20:43:34 +00003968
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003969 /* Same for b. */
3970 size_b = ABS(Py_SIZE(b));
3971 negb = Py_SIZE(b) < 0;
3972 if (negb) {
3973 z = _PyLong_New(size_b);
3974 if (z == NULL) {
3975 Py_DECREF(a);
3976 return NULL;
3977 }
3978 v_complement(z->ob_digit, b->ob_digit, size_b);
3979 b = z;
3980 }
3981 else
3982 Py_INCREF(b);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003983
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003984 /* Swap a and b if necessary to ensure size_a >= size_b. */
3985 if (size_a < size_b) {
3986 z = a; a = b; b = z;
3987 size_z = size_a; size_a = size_b; size_b = size_z;
3988 negz = nega; nega = negb; negb = negz;
3989 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003990
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003991 /* JRH: The original logic here was to allocate the result value (z)
3992 as the longer of the two operands. However, there are some cases
3993 where the result is guaranteed to be shorter than that: AND of two
3994 positives, OR of two negatives: use the shorter number. AND with
3995 mixed signs: use the positive number. OR with mixed signs: use the
3996 negative number.
3997 */
3998 switch (op) {
3999 case '^':
4000 negz = nega ^ negb;
4001 size_z = size_a;
4002 break;
4003 case '&':
4004 negz = nega & negb;
4005 size_z = negb ? size_a : size_b;
4006 break;
4007 case '|':
4008 negz = nega | negb;
4009 size_z = negb ? size_b : size_a;
4010 break;
4011 default:
4012 PyErr_BadArgument();
4013 return NULL;
4014 }
Guido van Rossumbd3a5271998-08-11 15:04:47 +00004015
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004016 /* We allow an extra digit if z is negative, to make sure that
4017 the final two's complement of z doesn't overflow. */
4018 z = _PyLong_New(size_z + negz);
4019 if (z == NULL) {
4020 Py_DECREF(a);
4021 Py_DECREF(b);
4022 return NULL;
4023 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00004024
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004025 /* Compute digits for overlap of a and b. */
4026 switch(op) {
4027 case '&':
4028 for (i = 0; i < size_b; ++i)
4029 z->ob_digit[i] = a->ob_digit[i] & b->ob_digit[i];
4030 break;
4031 case '|':
4032 for (i = 0; i < size_b; ++i)
4033 z->ob_digit[i] = a->ob_digit[i] | b->ob_digit[i];
4034 break;
4035 case '^':
4036 for (i = 0; i < size_b; ++i)
4037 z->ob_digit[i] = a->ob_digit[i] ^ b->ob_digit[i];
4038 break;
4039 default:
4040 PyErr_BadArgument();
4041 return NULL;
4042 }
Mark Dickinson27a87a22009-10-25 20:43:34 +00004043
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004044 /* Copy any remaining digits of a, inverting if necessary. */
4045 if (op == '^' && negb)
4046 for (; i < size_z; ++i)
4047 z->ob_digit[i] = a->ob_digit[i] ^ PyLong_MASK;
4048 else if (i < size_z)
4049 memcpy(&z->ob_digit[i], &a->ob_digit[i],
4050 (size_z-i)*sizeof(digit));
Mark Dickinson27a87a22009-10-25 20:43:34 +00004051
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004052 /* Complement result if negative. */
4053 if (negz) {
4054 Py_SIZE(z) = -(Py_SIZE(z));
4055 z->ob_digit[size_z] = PyLong_MASK;
4056 v_complement(z->ob_digit, z->ob_digit, size_z+1);
4057 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00004058
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004059 Py_DECREF(a);
4060 Py_DECREF(b);
4061 return (PyObject *)maybe_small_long(long_normalize(z));
Guido van Rossumc6913e71991-11-19 20:26:46 +00004062}
4063
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004064static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00004065long_and(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004066{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004067 PyObject *c;
4068 CHECK_BINOP(a, b);
4069 c = long_bitwise((PyLongObject*)a, '&', (PyLongObject*)b);
4070 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00004071}
4072
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004073static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00004074long_xor(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004075{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004076 PyObject *c;
4077 CHECK_BINOP(a, b);
4078 c = long_bitwise((PyLongObject*)a, '^', (PyLongObject*)b);
4079 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00004080}
4081
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004082static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00004083long_or(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00004084{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004085 PyObject *c;
4086 CHECK_BINOP(a, b);
4087 c = long_bitwise((PyLongObject*)a, '|', (PyLongObject*)b);
4088 return c;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00004089}
4090
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004091static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00004092long_long(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004093{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004094 if (PyLong_CheckExact(v))
4095 Py_INCREF(v);
4096 else
4097 v = _PyLong_Copy((PyLongObject *)v);
4098 return v;
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004099}
4100
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004101static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00004102long_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004103{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004104 double result;
4105 result = PyLong_AsDouble(v);
4106 if (result == -1.0 && PyErr_Occurred())
4107 return NULL;
4108 return PyFloat_FromDouble(result);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004109}
4110
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004111static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +00004112long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00004113
Tim Peters6d6c1a32001-08-02 04:15:00 +00004114static PyObject *
4115long_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
4116{
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004117 PyObject *obase = NULL, *x = NULL;
4118 long base;
4119 int overflow;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004120 static char *kwlist[] = {"x", "base", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +00004121
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004122 if (type != &PyLong_Type)
4123 return long_subtype_new(type, args, kwds); /* Wimp out */
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004124 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OO:int", kwlist,
4125 &x, &obase))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004126 return NULL;
4127 if (x == NULL)
4128 return PyLong_FromLong(0L);
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004129 if (obase == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004130 return PyNumber_Long(x);
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004131
4132 base = PyLong_AsLongAndOverflow(obase, &overflow);
4133 if (base == -1 && PyErr_Occurred())
4134 return NULL;
4135 if (overflow || (base != 0 && base < 2) || base > 36) {
4136 PyErr_SetString(PyExc_ValueError,
4137 "int() arg 2 must be >= 2 and <= 36");
4138 return NULL;
4139 }
4140
4141 if (PyUnicode_Check(x))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004142 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(x),
4143 PyUnicode_GET_SIZE(x),
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004144 (int)base);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004145 else if (PyByteArray_Check(x) || PyBytes_Check(x)) {
4146 /* Since PyLong_FromString doesn't have a length parameter,
4147 * check here for possible NULs in the string. */
4148 char *string;
4149 Py_ssize_t size = Py_SIZE(x);
4150 if (PyByteArray_Check(x))
4151 string = PyByteArray_AS_STRING(x);
4152 else
4153 string = PyBytes_AS_STRING(x);
4154 if (strlen(string) != (size_t)size) {
4155 /* We only see this if there's a null byte in x,
4156 x is a bytes or buffer, *and* a base is given. */
4157 PyErr_Format(PyExc_ValueError,
Mark Dickinson22b20182010-05-10 21:27:53 +00004158 "invalid literal for int() with base %d: %R",
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004159 (int)base, x);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004160 return NULL;
4161 }
Mark Dickinsonf9a5a8e2010-05-26 20:07:58 +00004162 return PyLong_FromString(string, NULL, (int)base);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004163 }
4164 else {
4165 PyErr_SetString(PyExc_TypeError,
Mark Dickinson22b20182010-05-10 21:27:53 +00004166 "int() can't convert non-string with explicit base");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004167 return NULL;
4168 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004169}
4170
Guido van Rossumbef14172001-08-29 15:47:46 +00004171/* Wimpy, slow approach to tp_new calls for subtypes of long:
4172 first create a regular long from whatever arguments we got,
4173 then allocate a subtype instance and initialize it from
4174 the regular long. The regular long is then thrown away.
4175*/
4176static PyObject *
4177long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
4178{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004179 PyLongObject *tmp, *newobj;
4180 Py_ssize_t i, n;
Guido van Rossumbef14172001-08-29 15:47:46 +00004181
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004182 assert(PyType_IsSubtype(type, &PyLong_Type));
4183 tmp = (PyLongObject *)long_new(&PyLong_Type, args, kwds);
4184 if (tmp == NULL)
4185 return NULL;
4186 assert(PyLong_CheckExact(tmp));
4187 n = Py_SIZE(tmp);
4188 if (n < 0)
4189 n = -n;
4190 newobj = (PyLongObject *)type->tp_alloc(type, n);
4191 if (newobj == NULL) {
4192 Py_DECREF(tmp);
4193 return NULL;
4194 }
4195 assert(PyLong_Check(newobj));
4196 Py_SIZE(newobj) = Py_SIZE(tmp);
4197 for (i = 0; i < n; i++)
4198 newobj->ob_digit[i] = tmp->ob_digit[i];
4199 Py_DECREF(tmp);
4200 return (PyObject *)newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00004201}
4202
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004203static PyObject *
4204long_getnewargs(PyLongObject *v)
4205{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004206 return Py_BuildValue("(N)", _PyLong_Copy(v));
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004207}
4208
Guido van Rossumb43daf72007-08-01 18:08:08 +00004209static PyObject *
Mark Dickinson6bf19002009-05-02 17:57:52 +00004210long_get0(PyLongObject *v, void *context) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004211 return PyLong_FromLong(0L);
Mark Dickinson6bf19002009-05-02 17:57:52 +00004212}
4213
4214static PyObject *
4215long_get1(PyLongObject *v, void *context) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004216 return PyLong_FromLong(1L);
Guido van Rossumb43daf72007-08-01 18:08:08 +00004217}
4218
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004219static PyObject *
Eric Smith8c663262007-08-25 02:26:07 +00004220long__format__(PyObject *self, PyObject *args)
4221{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004222 PyObject *format_spec;
Eric Smith4a7d76d2008-05-30 18:10:19 +00004223
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004224 if (!PyArg_ParseTuple(args, "U:__format__", &format_spec))
4225 return NULL;
4226 return _PyLong_FormatAdvanced(self,
4227 PyUnicode_AS_UNICODE(format_spec),
4228 PyUnicode_GET_SIZE(format_spec));
Eric Smith8c663262007-08-25 02:26:07 +00004229}
4230
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004231/* Return a pair (q, r) such that a = b * q + r, and
4232 abs(r) <= abs(b)/2, with equality possible only if q is even.
4233 In other words, q == a / b, rounded to the nearest integer using
4234 round-half-to-even. */
4235
4236PyObject *
Mark Dickinsonfa68a612010-06-07 18:47:09 +00004237_PyLong_DivmodNear(PyObject *a, PyObject *b)
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004238{
4239 PyLongObject *quo = NULL, *rem = NULL;
4240 PyObject *one = NULL, *twice_rem, *result, *temp;
4241 int cmp, quo_is_odd, quo_is_neg;
4242
4243 /* Equivalent Python code:
4244
4245 def divmod_near(a, b):
4246 q, r = divmod(a, b)
4247 # round up if either r / b > 0.5, or r / b == 0.5 and q is odd.
4248 # The expression r / b > 0.5 is equivalent to 2 * r > b if b is
4249 # positive, 2 * r < b if b negative.
4250 greater_than_half = 2*r > b if b > 0 else 2*r < b
4251 exactly_half = 2*r == b
4252 if greater_than_half or exactly_half and q % 2 == 1:
4253 q += 1
4254 r -= b
4255 return q, r
4256
4257 */
4258 if (!PyLong_Check(a) || !PyLong_Check(b)) {
4259 PyErr_SetString(PyExc_TypeError,
4260 "non-integer arguments in division");
4261 return NULL;
4262 }
4263
4264 /* Do a and b have different signs? If so, quotient is negative. */
4265 quo_is_neg = (Py_SIZE(a) < 0) != (Py_SIZE(b) < 0);
4266
4267 one = PyLong_FromLong(1L);
4268 if (one == NULL)
4269 return NULL;
4270
4271 if (long_divrem((PyLongObject*)a, (PyLongObject*)b, &quo, &rem) < 0)
4272 goto error;
4273
4274 /* compare twice the remainder with the divisor, to see
4275 if we need to adjust the quotient and remainder */
4276 twice_rem = long_lshift((PyObject *)rem, one);
4277 if (twice_rem == NULL)
4278 goto error;
4279 if (quo_is_neg) {
4280 temp = long_neg((PyLongObject*)twice_rem);
4281 Py_DECREF(twice_rem);
4282 twice_rem = temp;
4283 if (twice_rem == NULL)
4284 goto error;
4285 }
4286 cmp = long_compare((PyLongObject *)twice_rem, (PyLongObject *)b);
4287 Py_DECREF(twice_rem);
4288
4289 quo_is_odd = Py_SIZE(quo) != 0 && ((quo->ob_digit[0] & 1) != 0);
4290 if ((Py_SIZE(b) < 0 ? cmp < 0 : cmp > 0) || (cmp == 0 && quo_is_odd)) {
4291 /* fix up quotient */
4292 if (quo_is_neg)
4293 temp = long_sub(quo, (PyLongObject *)one);
4294 else
4295 temp = long_add(quo, (PyLongObject *)one);
4296 Py_DECREF(quo);
4297 quo = (PyLongObject *)temp;
4298 if (quo == NULL)
4299 goto error;
4300 /* and remainder */
4301 if (quo_is_neg)
4302 temp = long_add(rem, (PyLongObject *)b);
4303 else
4304 temp = long_sub(rem, (PyLongObject *)b);
4305 Py_DECREF(rem);
4306 rem = (PyLongObject *)temp;
4307 if (rem == NULL)
4308 goto error;
4309 }
4310
4311 result = PyTuple_New(2);
4312 if (result == NULL)
4313 goto error;
4314
4315 /* PyTuple_SET_ITEM steals references */
4316 PyTuple_SET_ITEM(result, 0, (PyObject *)quo);
4317 PyTuple_SET_ITEM(result, 1, (PyObject *)rem);
4318 Py_DECREF(one);
4319 return result;
4320
4321 error:
4322 Py_XDECREF(quo);
4323 Py_XDECREF(rem);
4324 Py_XDECREF(one);
4325 return NULL;
4326}
4327
Eric Smith8c663262007-08-25 02:26:07 +00004328static PyObject *
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004329long_round(PyObject *self, PyObject *args)
4330{
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004331 PyObject *o_ndigits=NULL, *temp, *result, *ndigits;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004332
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004333 /* To round an integer m to the nearest 10**n (n positive), we make use of
4334 * the divmod_near operation, defined by:
4335 *
4336 * divmod_near(a, b) = (q, r)
4337 *
4338 * where q is the nearest integer to the quotient a / b (the
4339 * nearest even integer in the case of a tie) and r == a - q * b.
4340 * Hence q * b = a - r is the nearest multiple of b to a,
4341 * preferring even multiples in the case of a tie.
4342 *
4343 * So the nearest multiple of 10**n to m is:
4344 *
4345 * m - divmod_near(m, 10**n)[1].
4346 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004347 if (!PyArg_ParseTuple(args, "|O", &o_ndigits))
4348 return NULL;
4349 if (o_ndigits == NULL)
4350 return long_long(self);
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004351
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004352 ndigits = PyNumber_Index(o_ndigits);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004353 if (ndigits == NULL)
4354 return NULL;
Mark Dickinson1124e712009-01-28 21:25:58 +00004355
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004356 /* if ndigits >= 0 then no rounding is necessary; return self unchanged */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004357 if (Py_SIZE(ndigits) >= 0) {
4358 Py_DECREF(ndigits);
4359 return long_long(self);
4360 }
Mark Dickinson1124e712009-01-28 21:25:58 +00004361
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004362 /* result = self - divmod_near(self, 10 ** -ndigits)[1] */
4363 temp = long_neg((PyLongObject*)ndigits);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004364 Py_DECREF(ndigits);
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004365 ndigits = temp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004366 if (ndigits == NULL)
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004367 return NULL;
Mark Dickinson1124e712009-01-28 21:25:58 +00004368
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004369 result = PyLong_FromLong(10L);
4370 if (result == NULL) {
4371 Py_DECREF(ndigits);
4372 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004373 }
Mark Dickinson1124e712009-01-28 21:25:58 +00004374
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004375 temp = long_pow(result, ndigits, Py_None);
4376 Py_DECREF(ndigits);
4377 Py_DECREF(result);
4378 result = temp;
4379 if (result == NULL)
4380 return NULL;
4381
Mark Dickinsonfa68a612010-06-07 18:47:09 +00004382 temp = _PyLong_DivmodNear(self, result);
Mark Dickinson7f1bf802010-05-26 16:02:59 +00004383 Py_DECREF(result);
4384 result = temp;
4385 if (result == NULL)
4386 return NULL;
4387
4388 temp = long_sub((PyLongObject *)self,
4389 (PyLongObject *)PyTuple_GET_ITEM(result, 1));
4390 Py_DECREF(result);
4391 result = temp;
4392
4393 return result;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004394}
4395
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004396static PyObject *
4397long_sizeof(PyLongObject *v)
4398{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004399 Py_ssize_t res;
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004400
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004401 res = offsetof(PyLongObject, ob_digit) + ABS(Py_SIZE(v))*sizeof(digit);
4402 return PyLong_FromSsize_t(res);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004403}
4404
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004405static PyObject *
4406long_bit_length(PyLongObject *v)
4407{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004408 PyLongObject *result, *x, *y;
4409 Py_ssize_t ndigits, msd_bits = 0;
4410 digit msd;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004412 assert(v != NULL);
4413 assert(PyLong_Check(v));
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004415 ndigits = ABS(Py_SIZE(v));
4416 if (ndigits == 0)
4417 return PyLong_FromLong(0);
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004419 msd = v->ob_digit[ndigits-1];
4420 while (msd >= 32) {
4421 msd_bits += 6;
4422 msd >>= 6;
4423 }
4424 msd_bits += (long)(BitLengthTable[msd]);
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004425
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004426 if (ndigits <= PY_SSIZE_T_MAX/PyLong_SHIFT)
4427 return PyLong_FromSsize_t((ndigits-1)*PyLong_SHIFT + msd_bits);
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004428
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004429 /* expression above may overflow; use Python integers instead */
4430 result = (PyLongObject *)PyLong_FromSsize_t(ndigits - 1);
4431 if (result == NULL)
4432 return NULL;
4433 x = (PyLongObject *)PyLong_FromLong(PyLong_SHIFT);
4434 if (x == NULL)
4435 goto error;
4436 y = (PyLongObject *)long_mul(result, x);
4437 Py_DECREF(x);
4438 if (y == NULL)
4439 goto error;
4440 Py_DECREF(result);
4441 result = y;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004442
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004443 x = (PyLongObject *)PyLong_FromLong((long)msd_bits);
4444 if (x == NULL)
4445 goto error;
4446 y = (PyLongObject *)long_add(result, x);
4447 Py_DECREF(x);
4448 if (y == NULL)
4449 goto error;
4450 Py_DECREF(result);
4451 result = y;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004452
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004453 return (PyObject *)result;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004454
Mark Dickinson22b20182010-05-10 21:27:53 +00004455 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004456 Py_DECREF(result);
4457 return NULL;
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004458}
4459
4460PyDoc_STRVAR(long_bit_length_doc,
4461"int.bit_length() -> int\n\
4462\n\
4463Number of bits necessary to represent self in binary.\n\
4464>>> bin(37)\n\
4465'0b100101'\n\
4466>>> (37).bit_length()\n\
44676");
4468
Christian Heimes53876d92008-04-19 00:31:39 +00004469#if 0
4470static PyObject *
4471long_is_finite(PyObject *v)
4472{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004473 Py_RETURN_TRUE;
Christian Heimes53876d92008-04-19 00:31:39 +00004474}
4475#endif
4476
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004477
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004478static PyObject *
4479long_to_bytes(PyLongObject *v, PyObject *args, PyObject *kwds)
4480{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004481 PyObject *byteorder_str;
4482 PyObject *is_signed_obj = NULL;
4483 Py_ssize_t length;
4484 int little_endian;
4485 int is_signed;
4486 PyObject *bytes;
4487 static char *kwlist[] = {"length", "byteorder", "signed", NULL};
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004489 if (!PyArg_ParseTupleAndKeywords(args, kwds, "nU|O:to_bytes", kwlist,
4490 &length, &byteorder_str,
4491 &is_signed_obj))
4492 return NULL;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004494 if (args != NULL && Py_SIZE(args) > 2) {
4495 PyErr_SetString(PyExc_TypeError,
4496 "'signed' is a keyword-only argument");
4497 return NULL;
4498 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004499
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004500 if (!PyUnicode_CompareWithASCIIString(byteorder_str, "little"))
4501 little_endian = 1;
4502 else if (!PyUnicode_CompareWithASCIIString(byteorder_str, "big"))
4503 little_endian = 0;
4504 else {
4505 PyErr_SetString(PyExc_ValueError,
4506 "byteorder must be either 'little' or 'big'");
4507 return NULL;
4508 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004510 if (is_signed_obj != NULL) {
4511 int cmp = PyObject_IsTrue(is_signed_obj);
4512 if (cmp < 0)
4513 return NULL;
4514 is_signed = cmp ? 1 : 0;
4515 }
4516 else {
4517 /* If the signed argument was omitted, use False as the
4518 default. */
4519 is_signed = 0;
4520 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004522 if (length < 0) {
4523 PyErr_SetString(PyExc_ValueError,
4524 "length argument must be non-negative");
4525 return NULL;
4526 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004528 bytes = PyBytes_FromStringAndSize(NULL, length);
4529 if (bytes == NULL)
4530 return NULL;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004532 if (_PyLong_AsByteArray(v, (unsigned char *)PyBytes_AS_STRING(bytes),
4533 length, little_endian, is_signed) < 0) {
4534 Py_DECREF(bytes);
4535 return NULL;
4536 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004538 return bytes;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004539}
4540
Mark Dickinson078c2532010-01-30 18:06:17 +00004541PyDoc_STRVAR(long_to_bytes_doc,
4542"int.to_bytes(length, byteorder, *, signed=False) -> bytes\n\
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004543\n\
Mark Dickinson078c2532010-01-30 18:06:17 +00004544Return an array of bytes representing an integer.\n\
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004545\n\
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004546The integer is represented using length bytes. An OverflowError is\n\
Mark Dickinson078c2532010-01-30 18:06:17 +00004547raised if the integer is not representable with the given number of\n\
4548bytes.\n\
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004549\n\
4550The byteorder argument determines the byte order used to represent the\n\
4551integer. If byteorder is 'big', the most significant byte is at the\n\
4552beginning of the byte array. If byteorder is 'little', the most\n\
4553significant byte is at the end of the byte array. To request the native\n\
4554byte order of the host system, use `sys.byteorder' as the byte order value.\n\
4555\n\
Mark Dickinson078c2532010-01-30 18:06:17 +00004556The signed keyword-only argument determines whether two's complement is\n\
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004557used to represent the integer. If signed is False and a negative integer\n\
Mark Dickinson078c2532010-01-30 18:06:17 +00004558is given, an OverflowError is raised.");
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004559
4560static PyObject *
4561long_from_bytes(PyTypeObject *type, PyObject *args, PyObject *kwds)
4562{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004563 PyObject *byteorder_str;
4564 PyObject *is_signed_obj = NULL;
4565 int little_endian;
4566 int is_signed;
4567 PyObject *obj;
4568 PyObject *bytes;
4569 PyObject *long_obj;
4570 static char *kwlist[] = {"bytes", "byteorder", "signed", NULL};
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004571
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004572 if (!PyArg_ParseTupleAndKeywords(args, kwds, "OU|O:from_bytes", kwlist,
4573 &obj, &byteorder_str,
4574 &is_signed_obj))
4575 return NULL;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004576
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004577 if (args != NULL && Py_SIZE(args) > 2) {
4578 PyErr_SetString(PyExc_TypeError,
4579 "'signed' is a keyword-only argument");
4580 return NULL;
4581 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004583 if (!PyUnicode_CompareWithASCIIString(byteorder_str, "little"))
4584 little_endian = 1;
4585 else if (!PyUnicode_CompareWithASCIIString(byteorder_str, "big"))
4586 little_endian = 0;
4587 else {
4588 PyErr_SetString(PyExc_ValueError,
4589 "byteorder must be either 'little' or 'big'");
4590 return NULL;
4591 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004593 if (is_signed_obj != NULL) {
4594 int cmp = PyObject_IsTrue(is_signed_obj);
4595 if (cmp < 0)
4596 return NULL;
4597 is_signed = cmp ? 1 : 0;
4598 }
4599 else {
4600 /* If the signed argument was omitted, use False as the
4601 default. */
4602 is_signed = 0;
4603 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004605 bytes = PyObject_Bytes(obj);
4606 if (bytes == NULL)
4607 return NULL;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004609 long_obj = _PyLong_FromByteArray(
4610 (unsigned char *)PyBytes_AS_STRING(bytes), Py_SIZE(bytes),
4611 little_endian, is_signed);
4612 Py_DECREF(bytes);
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004613
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004614 /* If from_bytes() was used on subclass, allocate new subclass
4615 * instance, initialize it with decoded long value and return it.
4616 */
4617 if (type != &PyLong_Type && PyType_IsSubtype(type, &PyLong_Type)) {
4618 PyLongObject *newobj;
4619 int i;
4620 Py_ssize_t n = ABS(Py_SIZE(long_obj));
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004621
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004622 newobj = (PyLongObject *)type->tp_alloc(type, n);
4623 if (newobj == NULL) {
4624 Py_DECREF(long_obj);
4625 return NULL;
4626 }
4627 assert(PyLong_Check(newobj));
4628 Py_SIZE(newobj) = Py_SIZE(long_obj);
4629 for (i = 0; i < n; i++) {
4630 newobj->ob_digit[i] =
4631 ((PyLongObject *)long_obj)->ob_digit[i];
4632 }
4633 Py_DECREF(long_obj);
4634 return (PyObject *)newobj;
4635 }
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004636
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004637 return long_obj;
Alexandre Vassalottic36c3782010-01-09 20:35:09 +00004638}
4639
Mark Dickinson078c2532010-01-30 18:06:17 +00004640PyDoc_STRVAR(long_from_bytes_doc,
4641"int.from_bytes(bytes, byteorder, *, signed=False) -> int\n\
4642\n\
4643Return the integer represented by the given array of bytes.\n\
4644\n\
4645The bytes argument must either support the buffer protocol or be an\n\
4646iterable object producing bytes. Bytes and bytearray are examples of\n\
4647built-in objects that support the buffer protocol.\n\
4648\n\
4649The byteorder argument determines the byte order used to represent the\n\
4650integer. If byteorder is 'big', the most significant byte is at the\n\
4651beginning of the byte array. If byteorder is 'little', the most\n\
4652significant byte is at the end of the byte array. To request the native\n\
4653byte order of the host system, use `sys.byteorder' as the byte order value.\n\
4654\n\
4655The signed keyword-only argument indicates whether two's complement is\n\
4656used to represent the integer.");
4657
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004658static PyMethodDef long_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004659 {"conjugate", (PyCFunction)long_long, METH_NOARGS,
4660 "Returns self, the complex conjugate of any int."},
4661 {"bit_length", (PyCFunction)long_bit_length, METH_NOARGS,
4662 long_bit_length_doc},
Christian Heimes53876d92008-04-19 00:31:39 +00004663#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004664 {"is_finite", (PyCFunction)long_is_finite, METH_NOARGS,
4665 "Returns always True."},
Christian Heimes53876d92008-04-19 00:31:39 +00004666#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004667 {"to_bytes", (PyCFunction)long_to_bytes,
4668 METH_VARARGS|METH_KEYWORDS, long_to_bytes_doc},
4669 {"from_bytes", (PyCFunction)long_from_bytes,
4670 METH_VARARGS|METH_KEYWORDS|METH_CLASS, long_from_bytes_doc},
4671 {"__trunc__", (PyCFunction)long_long, METH_NOARGS,
4672 "Truncating an Integral returns itself."},
4673 {"__floor__", (PyCFunction)long_long, METH_NOARGS,
4674 "Flooring an Integral returns itself."},
4675 {"__ceil__", (PyCFunction)long_long, METH_NOARGS,
4676 "Ceiling of an Integral returns itself."},
4677 {"__round__", (PyCFunction)long_round, METH_VARARGS,
4678 "Rounding an Integral returns itself.\n"
4679 "Rounding with an ndigits argument also returns an integer."},
4680 {"__getnewargs__", (PyCFunction)long_getnewargs, METH_NOARGS},
4681 {"__format__", (PyCFunction)long__format__, METH_VARARGS},
4682 {"__sizeof__", (PyCFunction)long_sizeof, METH_NOARGS,
4683 "Returns size in memory, in bytes"},
4684 {NULL, NULL} /* sentinel */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004685};
4686
Guido van Rossumb43daf72007-08-01 18:08:08 +00004687static PyGetSetDef long_getset[] = {
Mark Dickinson6bf19002009-05-02 17:57:52 +00004688 {"real",
Guido van Rossumb43daf72007-08-01 18:08:08 +00004689 (getter)long_long, (setter)NULL,
4690 "the real part of a complex number",
4691 NULL},
Mark Dickinson6bf19002009-05-02 17:57:52 +00004692 {"imag",
4693 (getter)long_get0, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00004694 "the imaginary part of a complex number",
Mark Dickinson6bf19002009-05-02 17:57:52 +00004695 NULL},
4696 {"numerator",
Guido van Rossumb43daf72007-08-01 18:08:08 +00004697 (getter)long_long, (setter)NULL,
4698 "the numerator of a rational number in lowest terms",
4699 NULL},
Mark Dickinson6bf19002009-05-02 17:57:52 +00004700 {"denominator",
4701 (getter)long_get1, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00004702 "the denominator of a rational number in lowest terms",
Mark Dickinson6bf19002009-05-02 17:57:52 +00004703 NULL},
Guido van Rossumb43daf72007-08-01 18:08:08 +00004704 {NULL} /* Sentinel */
4705};
4706
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004707PyDoc_STRVAR(long_doc,
Guido van Rossumddefaf32007-01-14 03:31:43 +00004708"int(x[, base]) -> integer\n\
Tim Peters6d6c1a32001-08-02 04:15:00 +00004709\n\
Guido van Rossumddefaf32007-01-14 03:31:43 +00004710Convert a string or number to an integer, if possible. A floating\n\
Tim Peters6d6c1a32001-08-02 04:15:00 +00004711point argument will be truncated towards zero (this does not include a\n\
4712string representation of a floating point number!) When converting a\n\
4713string, use the optional base. It is an error to supply a base when\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004714converting a non-string.");
Tim Peters6d6c1a32001-08-02 04:15:00 +00004715
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004716static PyNumberMethods long_as_number = {
Mark Dickinson22b20182010-05-10 21:27:53 +00004717 (binaryfunc)long_add, /*nb_add*/
4718 (binaryfunc)long_sub, /*nb_subtract*/
4719 (binaryfunc)long_mul, /*nb_multiply*/
4720 long_mod, /*nb_remainder*/
4721 long_divmod, /*nb_divmod*/
4722 long_pow, /*nb_power*/
4723 (unaryfunc)long_neg, /*nb_negative*/
4724 (unaryfunc)long_long, /*tp_positive*/
4725 (unaryfunc)long_abs, /*tp_absolute*/
4726 (inquiry)long_bool, /*tp_bool*/
4727 (unaryfunc)long_invert, /*nb_invert*/
4728 long_lshift, /*nb_lshift*/
4729 (binaryfunc)long_rshift, /*nb_rshift*/
4730 long_and, /*nb_and*/
4731 long_xor, /*nb_xor*/
4732 long_or, /*nb_or*/
4733 long_long, /*nb_int*/
4734 0, /*nb_reserved*/
4735 long_float, /*nb_float*/
4736 0, /* nb_inplace_add */
4737 0, /* nb_inplace_subtract */
4738 0, /* nb_inplace_multiply */
4739 0, /* nb_inplace_remainder */
4740 0, /* nb_inplace_power */
4741 0, /* nb_inplace_lshift */
4742 0, /* nb_inplace_rshift */
4743 0, /* nb_inplace_and */
4744 0, /* nb_inplace_xor */
4745 0, /* nb_inplace_or */
4746 long_div, /* nb_floor_divide */
4747 long_true_divide, /* nb_true_divide */
4748 0, /* nb_inplace_floor_divide */
4749 0, /* nb_inplace_true_divide */
4750 long_long, /* nb_index */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004751};
4752
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004753PyTypeObject PyLong_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004754 PyVarObject_HEAD_INIT(&PyType_Type, 0)
4755 "int", /* tp_name */
4756 offsetof(PyLongObject, ob_digit), /* tp_basicsize */
4757 sizeof(digit), /* tp_itemsize */
4758 long_dealloc, /* tp_dealloc */
4759 0, /* tp_print */
4760 0, /* tp_getattr */
4761 0, /* tp_setattr */
4762 0, /* tp_reserved */
4763 long_to_decimal_string, /* tp_repr */
4764 &long_as_number, /* tp_as_number */
4765 0, /* tp_as_sequence */
4766 0, /* tp_as_mapping */
4767 (hashfunc)long_hash, /* tp_hash */
4768 0, /* tp_call */
4769 long_to_decimal_string, /* tp_str */
4770 PyObject_GenericGetAttr, /* tp_getattro */
4771 0, /* tp_setattro */
4772 0, /* tp_as_buffer */
4773 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
4774 Py_TPFLAGS_LONG_SUBCLASS, /* tp_flags */
4775 long_doc, /* tp_doc */
4776 0, /* tp_traverse */
4777 0, /* tp_clear */
4778 long_richcompare, /* tp_richcompare */
4779 0, /* tp_weaklistoffset */
4780 0, /* tp_iter */
4781 0, /* tp_iternext */
4782 long_methods, /* tp_methods */
4783 0, /* tp_members */
4784 long_getset, /* tp_getset */
4785 0, /* tp_base */
4786 0, /* tp_dict */
4787 0, /* tp_descr_get */
4788 0, /* tp_descr_set */
4789 0, /* tp_dictoffset */
4790 0, /* tp_init */
4791 0, /* tp_alloc */
4792 long_new, /* tp_new */
4793 PyObject_Del, /* tp_free */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004794};
Guido van Rossumddefaf32007-01-14 03:31:43 +00004795
Mark Dickinsonbd792642009-03-18 20:06:12 +00004796static PyTypeObject Int_InfoType;
4797
4798PyDoc_STRVAR(int_info__doc__,
4799"sys.int_info\n\
4800\n\
4801A struct sequence that holds information about Python's\n\
4802internal representation of integers. The attributes are read only.");
4803
4804static PyStructSequence_Field int_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004805 {"bits_per_digit", "size of a digit in bits"},
Mark Dickinson22b20182010-05-10 21:27:53 +00004806 {"sizeof_digit", "size in bytes of the C type used to represent a digit"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004807 {NULL, NULL}
Mark Dickinsonbd792642009-03-18 20:06:12 +00004808};
4809
4810static PyStructSequence_Desc int_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004811 "sys.int_info", /* name */
4812 int_info__doc__, /* doc */
4813 int_info_fields, /* fields */
4814 2 /* number of fields */
Mark Dickinsonbd792642009-03-18 20:06:12 +00004815};
4816
4817PyObject *
4818PyLong_GetInfo(void)
4819{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004820 PyObject* int_info;
4821 int field = 0;
4822 int_info = PyStructSequence_New(&Int_InfoType);
4823 if (int_info == NULL)
4824 return NULL;
4825 PyStructSequence_SET_ITEM(int_info, field++,
4826 PyLong_FromLong(PyLong_SHIFT));
4827 PyStructSequence_SET_ITEM(int_info, field++,
4828 PyLong_FromLong(sizeof(digit)));
4829 if (PyErr_Occurred()) {
4830 Py_CLEAR(int_info);
4831 return NULL;
4832 }
4833 return int_info;
Mark Dickinsonbd792642009-03-18 20:06:12 +00004834}
4835
Guido van Rossumddefaf32007-01-14 03:31:43 +00004836int
4837_PyLong_Init(void)
4838{
4839#if NSMALLNEGINTS + NSMALLPOSINTS > 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004840 int ival, size;
4841 PyLongObject *v = small_ints;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004842
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004843 for (ival = -NSMALLNEGINTS; ival < NSMALLPOSINTS; ival++, v++) {
4844 size = (ival < 0) ? -1 : ((ival == 0) ? 0 : 1);
4845 if (Py_TYPE(v) == &PyLong_Type) {
4846 /* The element is already initialized, most likely
4847 * the Python interpreter was initialized before.
4848 */
4849 Py_ssize_t refcnt;
4850 PyObject* op = (PyObject*)v;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004851
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004852 refcnt = Py_REFCNT(op) < 0 ? 0 : Py_REFCNT(op);
4853 _Py_NewReference(op);
4854 /* _Py_NewReference sets the ref count to 1 but
4855 * the ref count might be larger. Set the refcnt
4856 * to the original refcnt + 1 */
4857 Py_REFCNT(op) = refcnt + 1;
4858 assert(Py_SIZE(op) == size);
4859 assert(v->ob_digit[0] == abs(ival));
4860 }
4861 else {
4862 PyObject_INIT(v, &PyLong_Type);
4863 }
4864 Py_SIZE(v) = size;
4865 v->ob_digit[0] = abs(ival);
4866 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00004867#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004868 /* initialize int_info */
4869 if (Int_InfoType.tp_name == 0)
4870 PyStructSequence_InitType(&Int_InfoType, &int_info_desc);
Mark Dickinsonbd792642009-03-18 20:06:12 +00004871
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004872 return 1;
Guido van Rossumddefaf32007-01-14 03:31:43 +00004873}
4874
4875void
4876PyLong_Fini(void)
4877{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004878 /* Integers are currently statically allocated. Py_DECREF is not
4879 needed, but Python must forget about the reference or multiple
4880 reinitializations will fail. */
Guido van Rossumddefaf32007-01-14 03:31:43 +00004881#if NSMALLNEGINTS + NSMALLPOSINTS > 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004882 int i;
4883 PyLongObject *v = small_ints;
4884 for (i = 0; i < NSMALLNEGINTS + NSMALLPOSINTS; i++, v++) {
4885 _Py_DEC_REFTOTAL;
4886 _Py_ForgetReference((PyObject*)v);
4887 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00004888#endif
4889}