blob: e56602e9477114eb87197efc68066754e19f32e9 [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"
Mark Dickinsonbd792642009-03-18 20:06:12 +00007#include "structseq.h"
Guido van Rossumc0b618a1997-05-02 03:12:38 +00008
Mark Dickinsonc6300392009-04-20 21:38:00 +00009#include <float.h>
Guido van Rossumeb1fafc1994-08-29 12:47:19 +000010#include <ctype.h>
Mark Dickinson5a74bf62009-02-15 11:04:38 +000011#include <stddef.h>
Guido van Rossumedcc38a1991-05-05 20:09:44 +000012
Guido van Rossumddefaf32007-01-14 03:31:43 +000013#ifndef NSMALLPOSINTS
14#define NSMALLPOSINTS 257
15#endif
16#ifndef NSMALLNEGINTS
17#define NSMALLNEGINTS 5
18#endif
Facundo Batista6e6f59b2008-07-24 18:57:11 +000019
Mark Dickinsone4416742009-02-15 15:14:57 +000020/* convert a PyLong of size 1, 0 or -1 to an sdigit */
21#define MEDIUM_VALUE(x) (Py_SIZE(x) < 0 ? -(sdigit)(x)->ob_digit[0] : \
22 (Py_SIZE(x) == 0 ? (sdigit)0 : \
23 (sdigit)(x)->ob_digit[0]))
Facundo Batista6e6f59b2008-07-24 18:57:11 +000024#define ABS(x) ((x) < 0 ? -(x) : (x))
25
Guido van Rossumddefaf32007-01-14 03:31:43 +000026#if NSMALLNEGINTS + NSMALLPOSINTS > 0
27/* Small integers are preallocated in this array so that they
28 can be shared.
29 The integers that are preallocated are those in the range
30 -NSMALLNEGINTS (inclusive) to NSMALLPOSINTS (not inclusive).
31*/
32static PyLongObject small_ints[NSMALLNEGINTS + NSMALLPOSINTS];
33#ifdef COUNT_ALLOCS
34int quick_int_allocs, quick_neg_int_allocs;
35#endif
36
Guido van Rossum7eaf8222007-06-18 17:58:50 +000037static PyObject *
Mark Dickinsone4416742009-02-15 15:14:57 +000038get_small_int(sdigit ival)
Guido van Rossumddefaf32007-01-14 03:31:43 +000039{
40 PyObject *v = (PyObject*)(small_ints + ival + NSMALLNEGINTS);
41 Py_INCREF(v);
42#ifdef COUNT_ALLOCS
43 if (ival >= 0)
44 quick_int_allocs++;
45 else
46 quick_neg_int_allocs++;
47#endif
48 return v;
49}
50#define CHECK_SMALL_INT(ival) \
51 do if (-NSMALLNEGINTS <= ival && ival < NSMALLPOSINTS) { \
Mark Dickinson0d4785b2009-02-15 17:27:41 +000052 return get_small_int((sdigit)ival); \
Guido van Rossumddefaf32007-01-14 03:31:43 +000053 } while(0)
54
Facundo Batista6e6f59b2008-07-24 18:57:11 +000055static PyLongObject *
56maybe_small_long(PyLongObject *v)
57{
58 if (v && ABS(Py_SIZE(v)) <= 1) {
Mark Dickinsone4416742009-02-15 15:14:57 +000059 sdigit ival = MEDIUM_VALUE(v);
Facundo Batista6e6f59b2008-07-24 18:57:11 +000060 if (-NSMALLNEGINTS <= ival && ival < NSMALLPOSINTS) {
61 Py_DECREF(v);
62 return (PyLongObject *)get_small_int(ival);
63 }
64 }
65 return v;
66}
Guido van Rossumddefaf32007-01-14 03:31:43 +000067#else
68#define CHECK_SMALL_INT(ival)
Facundo Batista6e6f59b2008-07-24 18:57:11 +000069#define maybe_small_long(val) (val)
Guido van Rossumddefaf32007-01-14 03:31:43 +000070#endif
71
Guido van Rossumddefaf32007-01-14 03:31:43 +000072/* If a freshly-allocated long is already shared, it must
73 be a small integer, so negating it must go to PyLong_FromLong */
74#define NEGATE(x) \
Christian Heimes90aa7642007-12-19 02:45:37 +000075 do if (Py_REFCNT(x) == 1) Py_SIZE(x) = -Py_SIZE(x); \
Christian Heimes217cfd12007-12-02 14:31:20 +000076 else { PyObject* tmp=PyLong_FromLong(-MEDIUM_VALUE(x)); \
Guido van Rossumddefaf32007-01-14 03:31:43 +000077 Py_DECREF(x); (x) = (PyLongObject*)tmp; } \
78 while(0)
Tim Peters5af4e6c2002-08-12 02:31:19 +000079/* For long multiplication, use the O(N**2) school algorithm unless
80 * both operands contain more than KARATSUBA_CUTOFF digits (this
81 * being an internal Python long digit, in base BASE).
82 */
Tim Peters0973b992004-08-29 22:16:50 +000083#define KARATSUBA_CUTOFF 70
84#define KARATSUBA_SQUARE_CUTOFF (2 * KARATSUBA_CUTOFF)
Tim Peters5af4e6c2002-08-12 02:31:19 +000085
Tim Peters47e52ee2004-08-30 02:44:38 +000086/* For exponentiation, use the binary left-to-right algorithm
87 * unless the exponent contains more than FIVEARY_CUTOFF digits.
88 * In that case, do 5 bits at a time. The potential drawback is that
89 * a table of 2**5 intermediate results is computed.
90 */
91#define FIVEARY_CUTOFF 8
92
Tim Peters5af4e6c2002-08-12 02:31:19 +000093#undef MIN
94#undef MAX
95#define MAX(x, y) ((x) < (y) ? (y) : (x))
96#define MIN(x, y) ((x) > (y) ? (y) : (x))
97
Guido van Rossumc0b618a1997-05-02 03:12:38 +000098#define SIGCHECK(PyTryBlock) \
Skip Montanarod581d772002-09-03 20:10:45 +000099 if (--_Py_Ticker < 0) { \
100 _Py_Ticker = _Py_CheckInterval; \
Thomas Wouters477c8d52006-05-27 19:21:47 +0000101 if (PyErr_CheckSignals()) PyTryBlock \
Guido van Rossum23d6f0e1991-05-14 12:06:49 +0000102 }
103
Mark Dickinsonc6300392009-04-20 21:38:00 +0000104/* forward declaration */
105static int bits_in_digit(digit d);
106
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000107/* Normalize (remove leading zeros from) a long int object.
108 Doesn't attempt to free the storage--in most cases, due to the nature
109 of the algorithms used, this could save at most be one word anyway. */
110
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000111static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000112long_normalize(register PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000113{
Christian Heimes90aa7642007-12-19 02:45:37 +0000114 Py_ssize_t j = ABS(Py_SIZE(v));
Martin v. Löwis18e16552006-02-15 17:27:45 +0000115 Py_ssize_t i = j;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000116
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000117 while (i > 0 && v->ob_digit[i-1] == 0)
118 --i;
119 if (i != j)
Christian Heimes90aa7642007-12-19 02:45:37 +0000120 Py_SIZE(v) = (Py_SIZE(v) < 0) ? -(i) : i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000121 return v;
122}
123
124/* Allocate a new long int object with size digits.
125 Return NULL and set exception if we run out of memory. */
126
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000127#define MAX_LONG_DIGITS \
128 ((PY_SSIZE_T_MAX - offsetof(PyLongObject, ob_digit))/sizeof(digit))
129
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000130PyLongObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000131_PyLong_New(Py_ssize_t size)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000132{
Guido van Rossumddefaf32007-01-14 03:31:43 +0000133 PyLongObject *result;
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000134 /* Number of bytes needed is: offsetof(PyLongObject, ob_digit) +
135 sizeof(digit)*size. Previous incarnations of this code used
136 sizeof(PyVarObject) instead of the offsetof, but this risks being
137 incorrect in the presence of padding between the PyVarObject header
138 and the digits. */
Mark Dickinsone4416742009-02-15 15:14:57 +0000139 if (size > (Py_ssize_t)MAX_LONG_DIGITS) {
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000140 PyErr_SetString(PyExc_OverflowError,
141 "too many digits in integer");
142 return NULL;
143 }
144 result = PyObject_MALLOC(offsetof(PyLongObject, ob_digit) +
Guido van Rossumddefaf32007-01-14 03:31:43 +0000145 size*sizeof(digit));
146 if (!result) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000147 PyErr_NoMemory();
148 return NULL;
149 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000150 return (PyLongObject*)PyObject_INIT_VAR(result, &PyLong_Type, size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000151}
152
Tim Peters64b5ce32001-09-10 20:52:51 +0000153PyObject *
154_PyLong_Copy(PyLongObject *src)
155{
156 PyLongObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000157 Py_ssize_t i;
Tim Peters64b5ce32001-09-10 20:52:51 +0000158
159 assert(src != NULL);
Christian Heimes90aa7642007-12-19 02:45:37 +0000160 i = Py_SIZE(src);
Tim Peters64b5ce32001-09-10 20:52:51 +0000161 if (i < 0)
162 i = -(i);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000163 if (i < 2) {
Mark Dickinsone4416742009-02-15 15:14:57 +0000164 sdigit ival = src->ob_digit[0];
Christian Heimes90aa7642007-12-19 02:45:37 +0000165 if (Py_SIZE(src) < 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +0000166 ival = -ival;
167 CHECK_SMALL_INT(ival);
168 }
Tim Peters64b5ce32001-09-10 20:52:51 +0000169 result = _PyLong_New(i);
170 if (result != NULL) {
Christian Heimes90aa7642007-12-19 02:45:37 +0000171 Py_SIZE(result) = Py_SIZE(src);
Tim Peters64b5ce32001-09-10 20:52:51 +0000172 while (--i >= 0)
173 result->ob_digit[i] = src->ob_digit[i];
174 }
175 return (PyObject *)result;
176}
177
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000178/* Create a new long int object from a C long int */
179
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000180PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000181PyLong_FromLong(long ival)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000182{
Tim Petersce9de2f2001-06-14 04:56:19 +0000183 PyLongObject *v;
Mark Dickinsond4624c32009-01-24 15:02:35 +0000184 unsigned long abs_ival;
Tim Petersce9de2f2001-06-14 04:56:19 +0000185 unsigned long t; /* unsigned so >> doesn't propagate sign bit */
186 int ndigits = 0;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000187 int sign = 1;
188
189 CHECK_SMALL_INT(ival);
Tim Petersce9de2f2001-06-14 04:56:19 +0000190
191 if (ival < 0) {
Mark Dickinsond4624c32009-01-24 15:02:35 +0000192 /* negate: can't write this as abs_ival = -ival since that
193 invokes undefined behaviour when ival is LONG_MIN */
194 abs_ival = 0U-(unsigned long)ival;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000195 sign = -1;
Tim Petersce9de2f2001-06-14 04:56:19 +0000196 }
Christian Heimesdae2a892008-04-19 00:55:37 +0000197 else {
198 abs_ival = (unsigned long)ival;
199 }
Tim Petersce9de2f2001-06-14 04:56:19 +0000200
Mark Dickinsond4624c32009-01-24 15:02:35 +0000201 /* Fast path for single-digit ints */
202 if (!(abs_ival >> PyLong_SHIFT)) {
Guido van Rossumddefaf32007-01-14 03:31:43 +0000203 v = _PyLong_New(1);
204 if (v) {
Christian Heimes90aa7642007-12-19 02:45:37 +0000205 Py_SIZE(v) = sign;
Mark Dickinsond4624c32009-01-24 15:02:35 +0000206 v->ob_digit[0] = Py_SAFE_DOWNCAST(
207 abs_ival, unsigned long, digit);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000208 }
209 return (PyObject*)v;
210 }
211
Mark Dickinson249b8982009-04-27 19:41:00 +0000212#if PyLong_SHIFT==15
Guido van Rossumddefaf32007-01-14 03:31:43 +0000213 /* 2 digits */
Mark Dickinsond4624c32009-01-24 15:02:35 +0000214 if (!(abs_ival >> 2*PyLong_SHIFT)) {
Guido van Rossumddefaf32007-01-14 03:31:43 +0000215 v = _PyLong_New(2);
216 if (v) {
Christian Heimes90aa7642007-12-19 02:45:37 +0000217 Py_SIZE(v) = 2*sign;
Mark Dickinsond4624c32009-01-24 15:02:35 +0000218 v->ob_digit[0] = Py_SAFE_DOWNCAST(
219 abs_ival & PyLong_MASK, unsigned long, digit);
220 v->ob_digit[1] = Py_SAFE_DOWNCAST(
221 abs_ival >> PyLong_SHIFT, unsigned long, digit);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000222 }
223 return (PyObject*)v;
224 }
Mark Dickinsonbd792642009-03-18 20:06:12 +0000225#endif
Guido van Rossumddefaf32007-01-14 03:31:43 +0000226
227 /* Larger numbers: loop to determine number of digits */
Christian Heimesdae2a892008-04-19 00:55:37 +0000228 t = abs_ival;
Tim Petersce9de2f2001-06-14 04:56:19 +0000229 while (t) {
230 ++ndigits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000231 t >>= PyLong_SHIFT;
Tim Petersce9de2f2001-06-14 04:56:19 +0000232 }
233 v = _PyLong_New(ndigits);
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000234 if (v != NULL) {
Tim Petersce9de2f2001-06-14 04:56:19 +0000235 digit *p = v->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +0000236 Py_SIZE(v) = ndigits*sign;
Christian Heimesdae2a892008-04-19 00:55:37 +0000237 t = abs_ival;
Tim Petersce9de2f2001-06-14 04:56:19 +0000238 while (t) {
Mark Dickinsond4624c32009-01-24 15:02:35 +0000239 *p++ = Py_SAFE_DOWNCAST(
240 t & PyLong_MASK, unsigned long, digit);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000241 t >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000242 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000243 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000244 return (PyObject *)v;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000245}
246
Guido van Rossum53756b11997-01-03 17:14:46 +0000247/* Create a new long int object from a C unsigned long int */
248
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000249PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +0000250PyLong_FromUnsignedLong(unsigned long ival)
Guido van Rossum53756b11997-01-03 17:14:46 +0000251{
Tim Petersce9de2f2001-06-14 04:56:19 +0000252 PyLongObject *v;
253 unsigned long t;
254 int ndigits = 0;
255
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000256 if (ival < PyLong_BASE)
Guido van Rossumddefaf32007-01-14 03:31:43 +0000257 return PyLong_FromLong(ival);
Tim Petersce9de2f2001-06-14 04:56:19 +0000258 /* Count the number of Python digits. */
259 t = (unsigned long)ival;
260 while (t) {
261 ++ndigits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000262 t >>= PyLong_SHIFT;
Tim Petersce9de2f2001-06-14 04:56:19 +0000263 }
264 v = _PyLong_New(ndigits);
Guido van Rossum53756b11997-01-03 17:14:46 +0000265 if (v != NULL) {
Tim Petersce9de2f2001-06-14 04:56:19 +0000266 digit *p = v->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +0000267 Py_SIZE(v) = ndigits;
Tim Petersce9de2f2001-06-14 04:56:19 +0000268 while (ival) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000269 *p++ = (digit)(ival & PyLong_MASK);
270 ival >>= PyLong_SHIFT;
Guido van Rossum53756b11997-01-03 17:14:46 +0000271 }
Guido van Rossum53756b11997-01-03 17:14:46 +0000272 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000273 return (PyObject *)v;
Guido van Rossum53756b11997-01-03 17:14:46 +0000274}
275
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000276/* Create a new long int object from a C double */
277
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000278PyObject *
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000279PyLong_FromDouble(double dval)
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000280{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000281 PyLongObject *v;
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000282 double frac;
283 int i, ndig, expo, neg;
284 neg = 0;
Tim Peters39dce292000-08-15 03:34:48 +0000285 if (Py_IS_INFINITY(dval)) {
Guido van Rossum1a23c241999-09-27 17:11:52 +0000286 PyErr_SetString(PyExc_OverflowError,
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000287 "cannot convert float infinity to integer");
Guido van Rossum1a23c241999-09-27 17:11:52 +0000288 return NULL;
289 }
Christian Heimesa34706f2008-01-04 03:06:10 +0000290 if (Py_IS_NAN(dval)) {
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000291 PyErr_SetString(PyExc_ValueError,
292 "cannot convert float NaN to integer");
Christian Heimes386cd1e2008-01-15 02:01:20 +0000293 return NULL;
Christian Heimesa34706f2008-01-04 03:06:10 +0000294 }
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000295 if (dval < 0.0) {
296 neg = 1;
297 dval = -dval;
298 }
299 frac = frexp(dval, &expo); /* dval = frac*2**expo; 0.0 <= frac < 1.0 */
300 if (expo <= 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000301 return PyLong_FromLong(0L);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000302 ndig = (expo-1) / PyLong_SHIFT + 1; /* Number of 'digits' in result */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000303 v = _PyLong_New(ndig);
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000304 if (v == NULL)
305 return NULL;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000306 frac = ldexp(frac, (expo-1) % PyLong_SHIFT + 1);
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000307 for (i = ndig; --i >= 0; ) {
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000308 digit bits = (digit)frac;
309 v->ob_digit[i] = bits;
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000310 frac = frac - (double)bits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000311 frac = ldexp(frac, PyLong_SHIFT);
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000312 }
313 if (neg)
Christian Heimes90aa7642007-12-19 02:45:37 +0000314 Py_SIZE(v) = -(Py_SIZE(v));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000315 return (PyObject *)v;
Guido van Rossum149e9ea1991-06-03 10:58:24 +0000316}
317
Thomas Wouters89f507f2006-12-13 04:49:30 +0000318/* Checking for overflow in PyLong_AsLong is a PITA since C doesn't define
319 * anything about what happens when a signed integer operation overflows,
320 * and some compilers think they're doing you a favor by being "clever"
321 * then. The bit pattern for the largest postive signed long is
322 * (unsigned long)LONG_MAX, and for the smallest negative signed long
323 * it is abs(LONG_MIN), which we could write -(unsigned long)LONG_MIN.
324 * However, some other compilers warn about applying unary minus to an
325 * unsigned operand. Hence the weird "0-".
326 */
327#define PY_ABS_LONG_MIN (0-(unsigned long)LONG_MIN)
328#define PY_ABS_SSIZE_T_MIN (0-(size_t)PY_SSIZE_T_MIN)
329
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000330/* Get a C long int from a long int object.
331 Returns -1 and sets an error condition if overflow occurs. */
332
333long
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000334PyLong_AsLongAndOverflow(PyObject *vv, int *overflow)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000335{
Guido van Rossumf7531811998-05-26 14:33:37 +0000336 /* This version by Tim Peters */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000337 register PyLongObject *v;
Guido van Rossumf7531811998-05-26 14:33:37 +0000338 unsigned long x, prev;
Georg Brandl61c31b02007-02-26 14:46:30 +0000339 long res;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000340 Py_ssize_t i;
341 int sign;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000342 int do_decref = 0; /* if nb_int was called */
Guido van Rossumf7531811998-05-26 14:33:37 +0000343
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000344 *overflow = 0;
Guido van Rossumddefaf32007-01-14 03:31:43 +0000345 if (vv == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000346 PyErr_BadInternalCall();
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000347 return -1;
348 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000349
350 if (!PyLong_Check(vv)) {
351 PyNumberMethods *nb;
352 if ((nb = vv->ob_type->tp_as_number) == NULL ||
353 nb->nb_int == NULL) {
354 PyErr_SetString(PyExc_TypeError, "an integer is required");
355 return -1;
356 }
357 vv = (*nb->nb_int) (vv);
358 if (vv == NULL)
359 return -1;
360 do_decref = 1;
361 if (!PyLong_Check(vv)) {
362 Py_DECREF(vv);
363 PyErr_SetString(PyExc_TypeError,
364 "nb_int should return int object");
365 return -1;
366 }
367 }
368
Georg Brandl61c31b02007-02-26 14:46:30 +0000369 res = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000370 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000371 i = Py_SIZE(v);
Guido van Rossumf7531811998-05-26 14:33:37 +0000372
Georg Brandl61c31b02007-02-26 14:46:30 +0000373 switch (i) {
374 case -1:
Mark Dickinson0d4785b2009-02-15 17:27:41 +0000375 res = -(sdigit)v->ob_digit[0];
Georg Brandl61c31b02007-02-26 14:46:30 +0000376 break;
377 case 0:
378 res = 0;
379 break;
380 case 1:
381 res = v->ob_digit[0];
382 break;
383 default:
384 sign = 1;
385 x = 0;
386 if (i < 0) {
387 sign = -1;
388 i = -(i);
389 }
390 while (--i >= 0) {
391 prev = x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000392 x = (x << PyLong_SHIFT) + v->ob_digit[i];
393 if ((x >> PyLong_SHIFT) != prev) {
Christian Heimes90aa7642007-12-19 02:45:37 +0000394 *overflow = Py_SIZE(v) > 0 ? 1 : -1;
Georg Brandl61c31b02007-02-26 14:46:30 +0000395 goto exit;
396 }
397 }
398 /* Haven't lost any bits, but casting to long requires extra care
399 * (see comment above).
400 */
401 if (x <= (unsigned long)LONG_MAX) {
402 res = (long)x * sign;
403 }
404 else if (sign < 0 && x == PY_ABS_LONG_MIN) {
405 res = LONG_MIN;
406 }
407 else {
Christian Heimes90aa7642007-12-19 02:45:37 +0000408 *overflow = Py_SIZE(v) > 0 ? 1 : -1;
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000409 /* res is already set to -1 */
Georg Brandl61c31b02007-02-26 14:46:30 +0000410 }
411 }
412 exit:
Guido van Rossumddefaf32007-01-14 03:31:43 +0000413 if (do_decref) {
414 Py_DECREF(vv);
415 }
Georg Brandl61c31b02007-02-26 14:46:30 +0000416 return res;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000417}
418
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000419long
420PyLong_AsLong(PyObject *obj)
421{
422 int overflow;
423 long result = PyLong_AsLongAndOverflow(obj, &overflow);
424 if (overflow) {
425 /* XXX: could be cute and give a different
426 message for overflow == -1 */
427 PyErr_SetString(PyExc_OverflowError,
428 "Python int too large to convert to C long");
429 }
430 return result;
431}
432
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000433/* Get a Py_ssize_t from a long int object.
434 Returns -1 and sets an error condition if overflow occurs. */
435
436Py_ssize_t
Guido van Rossumddefaf32007-01-14 03:31:43 +0000437PyLong_AsSsize_t(PyObject *vv) {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000438 register PyLongObject *v;
439 size_t x, prev;
440 Py_ssize_t i;
441 int sign;
442
443 if (vv == NULL || !PyLong_Check(vv)) {
444 PyErr_BadInternalCall();
445 return -1;
446 }
447 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000448 i = Py_SIZE(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000449 switch (i) {
Mark Dickinson0d4785b2009-02-15 17:27:41 +0000450 case -1: return -(sdigit)v->ob_digit[0];
Guido van Rossumddefaf32007-01-14 03:31:43 +0000451 case 0: return 0;
452 case 1: return v->ob_digit[0];
453 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000454 sign = 1;
455 x = 0;
456 if (i < 0) {
457 sign = -1;
458 i = -(i);
459 }
460 while (--i >= 0) {
461 prev = x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000462 x = (x << PyLong_SHIFT) + v->ob_digit[i];
463 if ((x >> PyLong_SHIFT) != prev)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000464 goto overflow;
465 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000466 /* Haven't lost any bits, but casting to a signed type requires
467 * extra care (see comment above).
Martin v. Löwis18e16552006-02-15 17:27:45 +0000468 */
Thomas Wouters89f507f2006-12-13 04:49:30 +0000469 if (x <= (size_t)PY_SSIZE_T_MAX) {
470 return (Py_ssize_t)x * sign;
471 }
472 else if (sign < 0 && x == PY_ABS_SSIZE_T_MIN) {
473 return PY_SSIZE_T_MIN;
474 }
475 /* else overflow */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000476
477 overflow:
478 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum523d4f92007-01-15 00:31:49 +0000479 "Python int too large to convert to C ssize_t");
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000480 return -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000481}
482
Guido van Rossumd8c80482002-08-13 00:24:58 +0000483/* Get a C unsigned long int from a long int object.
Guido van Rossum53756b11997-01-03 17:14:46 +0000484 Returns -1 and sets an error condition if overflow occurs. */
485
486unsigned long
Tim Peters9f688bf2000-07-07 15:53:28 +0000487PyLong_AsUnsignedLong(PyObject *vv)
Guido van Rossum53756b11997-01-03 17:14:46 +0000488{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000489 register PyLongObject *v;
Guido van Rossum53756b11997-01-03 17:14:46 +0000490 unsigned long x, prev;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000491 Py_ssize_t i;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000492
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000493 if (vv == NULL || !PyLong_Check(vv)) {
494 PyErr_BadInternalCall();
Guido van Rossum53756b11997-01-03 17:14:46 +0000495 return (unsigned long) -1;
496 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000497 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000498 i = Py_SIZE(v);
Guido van Rossum53756b11997-01-03 17:14:46 +0000499 x = 0;
500 if (i < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000501 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumddefaf32007-01-14 03:31:43 +0000502 "can't convert negative value to unsigned int");
Guido van Rossum53756b11997-01-03 17:14:46 +0000503 return (unsigned long) -1;
504 }
Guido van Rossumddefaf32007-01-14 03:31:43 +0000505 switch (i) {
506 case 0: return 0;
507 case 1: return v->ob_digit[0];
508 }
Guido van Rossum53756b11997-01-03 17:14:46 +0000509 while (--i >= 0) {
510 prev = x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000511 x = (x << PyLong_SHIFT) + v->ob_digit[i];
512 if ((x >> PyLong_SHIFT) != prev) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000513 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum523d4f92007-01-15 00:31:49 +0000514 "python int too large to convert to C unsigned long");
Guido van Rossumddefaf32007-01-14 03:31:43 +0000515 return (unsigned long) -1;
516 }
517 }
518 return x;
519}
520
521/* Get a C unsigned long int from a long int object.
522 Returns -1 and sets an error condition if overflow occurs. */
523
524size_t
525PyLong_AsSize_t(PyObject *vv)
526{
527 register PyLongObject *v;
528 size_t x, prev;
529 Py_ssize_t i;
530
531 if (vv == NULL || !PyLong_Check(vv)) {
532 PyErr_BadInternalCall();
533 return (unsigned long) -1;
534 }
535 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000536 i = Py_SIZE(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000537 x = 0;
538 if (i < 0) {
539 PyErr_SetString(PyExc_OverflowError,
540 "can't convert negative value to size_t");
541 return (size_t) -1;
542 }
543 switch (i) {
544 case 0: return 0;
545 case 1: return v->ob_digit[0];
546 }
547 while (--i >= 0) {
548 prev = x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000549 x = (x << PyLong_SHIFT) + v->ob_digit[i];
550 if ((x >> PyLong_SHIFT) != prev) {
Guido van Rossumddefaf32007-01-14 03:31:43 +0000551 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum523d4f92007-01-15 00:31:49 +0000552 "Python int too large to convert to C size_t");
Guido van Rossum53756b11997-01-03 17:14:46 +0000553 return (unsigned long) -1;
554 }
555 }
556 return x;
557}
558
Thomas Hellera4ea6032003-04-17 18:55:45 +0000559/* Get a C unsigned long int from a long int object, ignoring the high bits.
560 Returns -1 and sets an error condition if an error occurs. */
561
Guido van Rossumddefaf32007-01-14 03:31:43 +0000562static unsigned long
563_PyLong_AsUnsignedLongMask(PyObject *vv)
Thomas Hellera4ea6032003-04-17 18:55:45 +0000564{
565 register PyLongObject *v;
566 unsigned long x;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000567 Py_ssize_t i;
568 int sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +0000569
570 if (vv == NULL || !PyLong_Check(vv)) {
571 PyErr_BadInternalCall();
572 return (unsigned long) -1;
573 }
574 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000575 i = Py_SIZE(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +0000576 switch (i) {
577 case 0: return 0;
578 case 1: return v->ob_digit[0];
579 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000580 sign = 1;
581 x = 0;
582 if (i < 0) {
583 sign = -1;
584 i = -i;
585 }
586 while (--i >= 0) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000587 x = (x << PyLong_SHIFT) + v->ob_digit[i];
Thomas Hellera4ea6032003-04-17 18:55:45 +0000588 }
589 return x * sign;
590}
591
Guido van Rossumddefaf32007-01-14 03:31:43 +0000592unsigned long
593PyLong_AsUnsignedLongMask(register PyObject *op)
594{
595 PyNumberMethods *nb;
596 PyLongObject *lo;
597 unsigned long val;
598
599 if (op && PyLong_Check(op))
600 return _PyLong_AsUnsignedLongMask(op);
601
602 if (op == NULL || (nb = op->ob_type->tp_as_number) == NULL ||
603 nb->nb_int == NULL) {
604 PyErr_SetString(PyExc_TypeError, "an integer is required");
605 return (unsigned long)-1;
606 }
607
608 lo = (PyLongObject*) (*nb->nb_int) (op);
609 if (lo == NULL)
610 return (unsigned long)-1;
611 if (PyLong_Check(lo)) {
612 val = _PyLong_AsUnsignedLongMask((PyObject *)lo);
613 Py_DECREF(lo);
614 if (PyErr_Occurred())
615 return (unsigned long)-1;
616 return val;
617 }
618 else
619 {
620 Py_DECREF(lo);
621 PyErr_SetString(PyExc_TypeError,
622 "nb_int should return int object");
623 return (unsigned long)-1;
624 }
625}
626
Tim Peters5b8132f2003-01-31 15:52:05 +0000627int
628_PyLong_Sign(PyObject *vv)
629{
630 PyLongObject *v = (PyLongObject *)vv;
Tim Peters5b8132f2003-01-31 15:52:05 +0000631
632 assert(v != NULL);
633 assert(PyLong_Check(v));
Tim Peters5b8132f2003-01-31 15:52:05 +0000634
Christian Heimes90aa7642007-12-19 02:45:37 +0000635 return Py_SIZE(v) == 0 ? 0 : (Py_SIZE(v) < 0 ? -1 : 1);
Tim Peters5b8132f2003-01-31 15:52:05 +0000636}
637
Tim Petersbaefd9e2003-01-28 20:37:45 +0000638size_t
639_PyLong_NumBits(PyObject *vv)
640{
641 PyLongObject *v = (PyLongObject *)vv;
Tim Peters5b8132f2003-01-31 15:52:05 +0000642 size_t result = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000643 Py_ssize_t ndigits;
Tim Petersbaefd9e2003-01-28 20:37:45 +0000644
645 assert(v != NULL);
646 assert(PyLong_Check(v));
Christian Heimes90aa7642007-12-19 02:45:37 +0000647 ndigits = ABS(Py_SIZE(v));
Tim Petersbaefd9e2003-01-28 20:37:45 +0000648 assert(ndigits == 0 || v->ob_digit[ndigits - 1] != 0);
649 if (ndigits > 0) {
Tim Petersbaefd9e2003-01-28 20:37:45 +0000650 digit msd = v->ob_digit[ndigits - 1];
651
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000652 result = (ndigits - 1) * PyLong_SHIFT;
653 if (result / PyLong_SHIFT != (size_t)(ndigits - 1))
Tim Petersbaefd9e2003-01-28 20:37:45 +0000654 goto Overflow;
655 do {
656 ++result;
657 if (result == 0)
658 goto Overflow;
659 msd >>= 1;
660 } while (msd);
661 }
662 return result;
663
664Overflow:
Guido van Rossumddefaf32007-01-14 03:31:43 +0000665 PyErr_SetString(PyExc_OverflowError, "int has too many bits "
Tim Petersbaefd9e2003-01-28 20:37:45 +0000666 "to express in a platform size_t");
667 return (size_t)-1;
668}
669
Tim Peters2a9b3672001-06-11 21:23:58 +0000670PyObject *
671_PyLong_FromByteArray(const unsigned char* bytes, size_t n,
672 int little_endian, int is_signed)
673{
674 const unsigned char* pstartbyte;/* LSB of bytes */
675 int incr; /* direction to move pstartbyte */
676 const unsigned char* pendbyte; /* MSB of bytes */
677 size_t numsignificantbytes; /* number of bytes that matter */
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000678 Py_ssize_t ndigits; /* number of Python long digits */
Tim Peters2a9b3672001-06-11 21:23:58 +0000679 PyLongObject* v; /* result */
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000680 Py_ssize_t idigit = 0; /* next free index in v->ob_digit */
Tim Peters2a9b3672001-06-11 21:23:58 +0000681
682 if (n == 0)
683 return PyLong_FromLong(0L);
684
685 if (little_endian) {
686 pstartbyte = bytes;
687 pendbyte = bytes + n - 1;
688 incr = 1;
689 }
690 else {
691 pstartbyte = bytes + n - 1;
692 pendbyte = bytes;
693 incr = -1;
694 }
695
696 if (is_signed)
697 is_signed = *pendbyte >= 0x80;
698
699 /* Compute numsignificantbytes. This consists of finding the most
700 significant byte. Leading 0 bytes are insignficant if the number
701 is positive, and leading 0xff bytes if negative. */
702 {
703 size_t i;
704 const unsigned char* p = pendbyte;
705 const int pincr = -incr; /* search MSB to LSB */
706 const unsigned char insignficant = is_signed ? 0xff : 0x00;
707
708 for (i = 0; i < n; ++i, p += pincr) {
709 if (*p != insignficant)
710 break;
711 }
712 numsignificantbytes = n - i;
713 /* 2's-comp is a bit tricky here, e.g. 0xff00 == -0x0100, so
714 actually has 2 significant bytes. OTOH, 0xff0001 ==
715 -0x00ffff, so we wouldn't *need* to bump it there; but we
716 do for 0xffff = -0x0001. To be safe without bothering to
717 check every case, bump it regardless. */
718 if (is_signed && numsignificantbytes < n)
719 ++numsignificantbytes;
720 }
721
722 /* How many Python long digits do we need? We have
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000723 8*numsignificantbytes bits, and each Python long digit has
724 PyLong_SHIFT bits, so it's the ceiling of the quotient. */
725 /* catch overflow before it happens */
726 if (numsignificantbytes > (PY_SSIZE_T_MAX - PyLong_SHIFT) / 8) {
727 PyErr_SetString(PyExc_OverflowError,
728 "byte array too long to convert to int");
729 return NULL;
730 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000731 ndigits = (numsignificantbytes * 8 + PyLong_SHIFT - 1) / PyLong_SHIFT;
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000732 v = _PyLong_New(ndigits);
Tim Peters2a9b3672001-06-11 21:23:58 +0000733 if (v == NULL)
734 return NULL;
735
736 /* Copy the bits over. The tricky parts are computing 2's-comp on
737 the fly for signed numbers, and dealing with the mismatch between
738 8-bit bytes and (probably) 15-bit Python digits.*/
739 {
740 size_t i;
Tim Petersf251d062001-06-13 21:09:15 +0000741 twodigits carry = 1; /* for 2's-comp calculation */
Tim Peters2a9b3672001-06-11 21:23:58 +0000742 twodigits accum = 0; /* sliding register */
743 unsigned int accumbits = 0; /* number of bits in accum */
744 const unsigned char* p = pstartbyte;
745
746 for (i = 0; i < numsignificantbytes; ++i, p += incr) {
Tim Peters8bc84b42001-06-12 19:17:03 +0000747 twodigits thisbyte = *p;
Tim Peters2a9b3672001-06-11 21:23:58 +0000748 /* Compute correction for 2's comp, if needed. */
749 if (is_signed) {
750 thisbyte = (0xff ^ thisbyte) + carry;
751 carry = thisbyte >> 8;
752 thisbyte &= 0xff;
753 }
754 /* Because we're going LSB to MSB, thisbyte is
755 more significant than what's already in accum,
756 so needs to be prepended to accum. */
Mark Dickinson17e55872009-01-24 15:56:57 +0000757 accum |= (twodigits)thisbyte << accumbits;
Tim Peters2a9b3672001-06-11 21:23:58 +0000758 accumbits += 8;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000759 if (accumbits >= PyLong_SHIFT) {
Tim Peters2a9b3672001-06-11 21:23:58 +0000760 /* There's enough to fill a Python digit. */
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000761 assert(idigit < ndigits);
762 v->ob_digit[idigit] = (digit)(accum &
763 PyLong_MASK);
Tim Peters2a9b3672001-06-11 21:23:58 +0000764 ++idigit;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000765 accum >>= PyLong_SHIFT;
766 accumbits -= PyLong_SHIFT;
767 assert(accumbits < PyLong_SHIFT);
Tim Peters2a9b3672001-06-11 21:23:58 +0000768 }
769 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000770 assert(accumbits < PyLong_SHIFT);
Tim Peters2a9b3672001-06-11 21:23:58 +0000771 if (accumbits) {
Mark Dickinson5a74bf62009-02-15 11:04:38 +0000772 assert(idigit < ndigits);
Tim Peters2a9b3672001-06-11 21:23:58 +0000773 v->ob_digit[idigit] = (digit)accum;
774 ++idigit;
775 }
776 }
777
Christian Heimes90aa7642007-12-19 02:45:37 +0000778 Py_SIZE(v) = is_signed ? -idigit : idigit;
Tim Peters2a9b3672001-06-11 21:23:58 +0000779 return (PyObject *)long_normalize(v);
780}
781
782int
783_PyLong_AsByteArray(PyLongObject* v,
784 unsigned char* bytes, size_t n,
785 int little_endian, int is_signed)
786{
Mark Dickinson17e55872009-01-24 15:56:57 +0000787 Py_ssize_t i; /* index into v->ob_digit */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000788 Py_ssize_t ndigits; /* |v->ob_size| */
Tim Peters2a9b3672001-06-11 21:23:58 +0000789 twodigits accum; /* sliding register */
790 unsigned int accumbits; /* # bits in accum */
791 int do_twos_comp; /* store 2's-comp? is_signed and v < 0 */
Mark Dickinson1e2d8702009-01-25 22:25:06 +0000792 digit carry; /* for computing 2's-comp */
Tim Peters2a9b3672001-06-11 21:23:58 +0000793 size_t j; /* # bytes filled */
794 unsigned char* p; /* pointer to next byte in bytes */
795 int pincr; /* direction to move p */
796
797 assert(v != NULL && PyLong_Check(v));
798
Christian Heimes90aa7642007-12-19 02:45:37 +0000799 if (Py_SIZE(v) < 0) {
800 ndigits = -(Py_SIZE(v));
Tim Peters2a9b3672001-06-11 21:23:58 +0000801 if (!is_signed) {
Mark Dickinson21776072009-02-10 16:13:25 +0000802 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumddefaf32007-01-14 03:31:43 +0000803 "can't convert negative int to unsigned");
Tim Peters2a9b3672001-06-11 21:23:58 +0000804 return -1;
805 }
806 do_twos_comp = 1;
807 }
808 else {
Christian Heimes90aa7642007-12-19 02:45:37 +0000809 ndigits = Py_SIZE(v);
Tim Peters2a9b3672001-06-11 21:23:58 +0000810 do_twos_comp = 0;
811 }
812
813 if (little_endian) {
814 p = bytes;
815 pincr = 1;
816 }
817 else {
818 p = bytes + n - 1;
819 pincr = -1;
820 }
821
Tim Peters898cf852001-06-13 20:50:08 +0000822 /* Copy over all the Python digits.
823 It's crucial that every Python digit except for the MSD contribute
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000824 exactly PyLong_SHIFT bits to the total, so first assert that the long is
Tim Peters898cf852001-06-13 20:50:08 +0000825 normalized. */
826 assert(ndigits == 0 || v->ob_digit[ndigits - 1] != 0);
Tim Peters2a9b3672001-06-11 21:23:58 +0000827 j = 0;
828 accum = 0;
829 accumbits = 0;
830 carry = do_twos_comp ? 1 : 0;
831 for (i = 0; i < ndigits; ++i) {
Mark Dickinson17e55872009-01-24 15:56:57 +0000832 digit thisdigit = v->ob_digit[i];
Tim Peters2a9b3672001-06-11 21:23:58 +0000833 if (do_twos_comp) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000834 thisdigit = (thisdigit ^ PyLong_MASK) + carry;
835 carry = thisdigit >> PyLong_SHIFT;
836 thisdigit &= PyLong_MASK;
Tim Peters2a9b3672001-06-11 21:23:58 +0000837 }
Tim Peters8bc84b42001-06-12 19:17:03 +0000838 /* Because we're going LSB to MSB, thisdigit is more
839 significant than what's already in accum, so needs to be
840 prepended to accum. */
Mark Dickinson17e55872009-01-24 15:56:57 +0000841 accum |= (twodigits)thisdigit << accumbits;
Tim Peters8bc84b42001-06-12 19:17:03 +0000842
Tim Petersede05092001-06-14 08:53:38 +0000843 /* The most-significant digit may be (probably is) at least
844 partly empty. */
Tim Peters8bc84b42001-06-12 19:17:03 +0000845 if (i == ndigits - 1) {
Tim Petersede05092001-06-14 08:53:38 +0000846 /* Count # of sign bits -- they needn't be stored,
847 * although for signed conversion we need later to
Mark Dickinson17e55872009-01-24 15:56:57 +0000848 * make sure at least one sign bit gets stored. */
849 digit s = do_twos_comp ? thisdigit ^ PyLong_MASK :
850 thisdigit;
851 while (s != 0) {
852 s >>= 1;
853 accumbits++;
Tim Peters7a3bfc32001-06-12 01:22:22 +0000854 }
Tim Peters7a3bfc32001-06-12 01:22:22 +0000855 }
Mark Dickinson17e55872009-01-24 15:56:57 +0000856 else
857 accumbits += PyLong_SHIFT;
Tim Peters8bc84b42001-06-12 19:17:03 +0000858
Tim Peters2a9b3672001-06-11 21:23:58 +0000859 /* Store as many bytes as possible. */
Tim Peters7a3bfc32001-06-12 01:22:22 +0000860 while (accumbits >= 8) {
Tim Peters2a9b3672001-06-11 21:23:58 +0000861 if (j >= n)
862 goto Overflow;
863 ++j;
864 *p = (unsigned char)(accum & 0xff);
865 p += pincr;
866 accumbits -= 8;
867 accum >>= 8;
Tim Peters7a3bfc32001-06-12 01:22:22 +0000868 }
Tim Peters2a9b3672001-06-11 21:23:58 +0000869 }
870
871 /* Store the straggler (if any). */
872 assert(accumbits < 8);
873 assert(carry == 0); /* else do_twos_comp and *every* digit was 0 */
Tim Peters7a3bfc32001-06-12 01:22:22 +0000874 if (accumbits > 0) {
Tim Peters2a9b3672001-06-11 21:23:58 +0000875 if (j >= n)
876 goto Overflow;
877 ++j;
878 if (do_twos_comp) {
879 /* Fill leading bits of the byte with sign bits
880 (appropriately pretending that the long had an
881 infinite supply of sign bits). */
882 accum |= (~(twodigits)0) << accumbits;
883 }
884 *p = (unsigned char)(accum & 0xff);
885 p += pincr;
886 }
Tim Peters05607ad2001-06-13 21:01:27 +0000887 else if (j == n && n > 0 && is_signed) {
888 /* The main loop filled the byte array exactly, so the code
889 just above didn't get to ensure there's a sign bit, and the
890 loop below wouldn't add one either. Make sure a sign bit
891 exists. */
Tim Peters2a9b3672001-06-11 21:23:58 +0000892 unsigned char msb = *(p - pincr);
Tim Peters05607ad2001-06-13 21:01:27 +0000893 int sign_bit_set = msb >= 0x80;
894 assert(accumbits == 0);
895 if (sign_bit_set == do_twos_comp)
896 return 0;
897 else
Tim Peters2a9b3672001-06-11 21:23:58 +0000898 goto Overflow;
899 }
Tim Peters05607ad2001-06-13 21:01:27 +0000900
901 /* Fill remaining bytes with copies of the sign bit. */
902 {
903 unsigned char signbyte = do_twos_comp ? 0xffU : 0U;
904 for ( ; j < n; ++j, p += pincr)
905 *p = signbyte;
906 }
907
Tim Peters2a9b3672001-06-11 21:23:58 +0000908 return 0;
909
910Overflow:
Guido van Rossumddefaf32007-01-14 03:31:43 +0000911 PyErr_SetString(PyExc_OverflowError, "int too big to convert");
Tim Peters2a9b3672001-06-11 21:23:58 +0000912 return -1;
Tim Peters5af4e6c2002-08-12 02:31:19 +0000913
Tim Peters2a9b3672001-06-11 21:23:58 +0000914}
915
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000916double
917_PyLong_AsScaledDouble(PyObject *vv, int *exponent)
918{
919/* NBITS_WANTED should be > the number of bits in a double's precision,
920 but small enough so that 2**NBITS_WANTED is within the normal double
921 range. nbitsneeded is set to 1 less than that because the most-significant
922 Python digit contains at least 1 significant bit, but we don't want to
923 bother counting them (catering to the worst case cheaply).
924
925 57 is one more than VAX-D double precision; I (Tim) don't know of a double
926 format with more precision than that; it's 1 larger so that we add in at
927 least one round bit to stand in for the ignored least-significant bits.
928*/
929#define NBITS_WANTED 57
930 PyLongObject *v;
931 double x;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000932 const double multiplier = (double)(1L << PyLong_SHIFT);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000933 Py_ssize_t i;
934 int sign;
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000935 int nbitsneeded;
936
937 if (vv == NULL || !PyLong_Check(vv)) {
938 PyErr_BadInternalCall();
939 return -1;
940 }
941 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +0000942 i = Py_SIZE(v);
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000943 sign = 1;
944 if (i < 0) {
945 sign = -1;
946 i = -(i);
947 }
948 else if (i == 0) {
949 *exponent = 0;
950 return 0.0;
951 }
952 --i;
953 x = (double)v->ob_digit[i];
954 nbitsneeded = NBITS_WANTED - 1;
955 /* Invariant: i Python digits remain unaccounted for. */
956 while (i > 0 && nbitsneeded > 0) {
957 --i;
958 x = x * multiplier + (double)v->ob_digit[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000959 nbitsneeded -= PyLong_SHIFT;
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000960 }
961 /* There are i digits we didn't shift in. Pretending they're all
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000962 zeroes, the true value is x * 2**(i*PyLong_SHIFT). */
Tim Petersa1c1b0f2001-09-04 02:50:49 +0000963 *exponent = i;
964 assert(x > 0.0);
965 return x * sign;
966#undef NBITS_WANTED
967}
968
Mark Dickinsonc6300392009-04-20 21:38:00 +0000969/* Get a C double from a long int object. Rounds to the nearest double,
970 using the round-half-to-even rule in the case of a tie. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000971
972double
Tim Peters9f688bf2000-07-07 15:53:28 +0000973PyLong_AsDouble(PyObject *vv)
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000974{
Mark Dickinsonc6300392009-04-20 21:38:00 +0000975 PyLongObject *v = (PyLongObject *)vv;
976 Py_ssize_t rnd_digit, rnd_bit, m, n;
977 digit lsb, *d;
978 int round_up = 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +0000979 double x;
Tim Peters9fffa3e2001-09-04 05:14:19 +0000980
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000981 if (vv == NULL || !PyLong_Check(vv)) {
982 PyErr_BadInternalCall();
Tim Peters9fffa3e2001-09-04 05:14:19 +0000983 return -1.0;
Mark Dickinsonc6300392009-04-20 21:38:00 +0000984 }
Tim Peters9fffa3e2001-09-04 05:14:19 +0000985
Mark Dickinsonc6300392009-04-20 21:38:00 +0000986 /* Notes on the method: for simplicity, assume v is positive and >=
987 2**DBL_MANT_DIG. (For negative v we just ignore the sign until the
988 end; for small v no rounding is necessary.) Write n for the number
989 of bits in v, so that 2**(n-1) <= v < 2**n, and n > DBL_MANT_DIG.
990
991 Some terminology: the *rounding bit* of v is the 1st bit of v that
992 will be rounded away (bit n - DBL_MANT_DIG - 1); the *parity bit*
993 is the bit immediately above. The round-half-to-even rule says
994 that we round up if the rounding bit is set, unless v is exactly
995 halfway between two floats and the parity bit is zero.
996
997 Write d[0] ... d[m] for the digits of v, least to most significant.
998 Let rnd_bit be the index of the rounding bit, and rnd_digit the
999 index of the PyLong digit containing the rounding bit. Then the
1000 bits of the digit d[rnd_digit] look something like:
1001
1002 rounding bit
1003 |
1004 v
1005 msb -> sssssrttttttttt <- lsb
1006 ^
1007 |
1008 parity bit
1009
1010 where 's' represents a 'significant bit' that will be included in
1011 the mantissa of the result, 'r' is the rounding bit, and 't'
1012 represents a 'trailing bit' following the rounding bit. Note that
1013 if the rounding bit is at the top of d[rnd_digit] then the parity
1014 bit will be the lsb of d[rnd_digit+1]. If we set
1015
1016 lsb = 1 << (rnd_bit % PyLong_SHIFT)
1017
1018 then d[rnd_digit] & (PyLong_BASE - 2*lsb) selects just the
1019 significant bits of d[rnd_digit], d[rnd_digit] & (lsb-1) gets the
1020 trailing bits, and d[rnd_digit] & lsb gives the rounding bit.
1021
1022 We initialize the double x to the integer given by digits
1023 d[rnd_digit:m-1], but with the rounding bit and trailing bits of
1024 d[rnd_digit] masked out. So the value of x comes from the top
1025 DBL_MANT_DIG bits of v, multiplied by 2*lsb. Note that in the loop
1026 that produces x, all floating-point operations are exact (assuming
1027 that FLT_RADIX==2). Now if we're rounding down, the value we want
1028 to return is simply
1029
1030 x * 2**(PyLong_SHIFT * rnd_digit).
1031
1032 and if we're rounding up, it's
1033
1034 (x + 2*lsb) * 2**(PyLong_SHIFT * rnd_digit).
1035
1036 Under the round-half-to-even rule, we round up if, and only
1037 if, the rounding bit is set *and* at least one of the
1038 following three conditions is satisfied:
1039
1040 (1) the parity bit is set, or
1041 (2) at least one of the trailing bits of d[rnd_digit] is set, or
1042 (3) at least one of the digits d[i], 0 <= i < rnd_digit
1043 is nonzero.
1044
1045 Finally, we have to worry about overflow. If v >= 2**DBL_MAX_EXP,
1046 or equivalently n > DBL_MAX_EXP, then overflow occurs. If v <
1047 2**DBL_MAX_EXP then we're usually safe, but there's a corner case
1048 to consider: if v is very close to 2**DBL_MAX_EXP then it's
1049 possible that v is rounded up to exactly 2**DBL_MAX_EXP, and then
1050 again overflow occurs.
1051 */
1052
1053 if (Py_SIZE(v) == 0)
1054 return 0.0;
1055 m = ABS(Py_SIZE(v)) - 1;
1056 d = v->ob_digit;
1057 assert(d[m]); /* v should be normalized */
1058
1059 /* fast path for case where 0 < abs(v) < 2**DBL_MANT_DIG */
1060 if (m < DBL_MANT_DIG / PyLong_SHIFT ||
1061 (m == DBL_MANT_DIG / PyLong_SHIFT &&
1062 d[m] < (digit)1 << DBL_MANT_DIG%PyLong_SHIFT)) {
1063 x = d[m];
1064 while (--m >= 0)
1065 x = x*PyLong_BASE + d[m];
1066 return Py_SIZE(v) < 0 ? -x : x;
1067 }
1068
1069 /* if m is huge then overflow immediately; otherwise, compute the
1070 number of bits n in v. The condition below implies n (= #bits) >=
1071 m * PyLong_SHIFT + 1 > DBL_MAX_EXP, hence v >= 2**DBL_MAX_EXP. */
1072 if (m > (DBL_MAX_EXP-1)/PyLong_SHIFT)
1073 goto overflow;
1074 n = m * PyLong_SHIFT + bits_in_digit(d[m]);
1075 if (n > DBL_MAX_EXP)
1076 goto overflow;
1077
1078 /* find location of rounding bit */
1079 assert(n > DBL_MANT_DIG); /* dealt with |v| < 2**DBL_MANT_DIG above */
1080 rnd_bit = n - DBL_MANT_DIG - 1;
1081 rnd_digit = rnd_bit/PyLong_SHIFT;
1082 lsb = (digit)1 << (rnd_bit%PyLong_SHIFT);
1083
1084 /* Get top DBL_MANT_DIG bits of v. Assumes PyLong_SHIFT <
1085 DBL_MANT_DIG, so we'll need bits from at least 2 digits of v. */
1086 x = d[m];
1087 assert(m > rnd_digit);
1088 while (--m > rnd_digit)
1089 x = x*PyLong_BASE + d[m];
1090 x = x*PyLong_BASE + (d[m] & (PyLong_BASE-2*lsb));
1091
1092 /* decide whether to round up, using round-half-to-even */
1093 assert(m == rnd_digit);
1094 if (d[m] & lsb) { /* if (rounding bit is set) */
1095 digit parity_bit;
1096 if (lsb == PyLong_BASE/2)
1097 parity_bit = d[m+1] & 1;
1098 else
1099 parity_bit = d[m] & 2*lsb;
1100 if (parity_bit)
1101 round_up = 1;
1102 else if (d[m] & (lsb-1))
1103 round_up = 1;
1104 else {
1105 while (--m >= 0) {
1106 if (d[m]) {
1107 round_up = 1;
1108 break;
1109 }
1110 }
1111 }
1112 }
1113
1114 /* and round up if necessary */
1115 if (round_up) {
1116 x += 2*lsb;
1117 if (n == DBL_MAX_EXP &&
1118 x == ldexp((double)(2*lsb), DBL_MANT_DIG)) {
1119 /* overflow corner case */
1120 goto overflow;
1121 }
1122 }
1123
1124 /* shift, adjust for sign, and return */
1125 x = ldexp(x, rnd_digit*PyLong_SHIFT);
1126 return Py_SIZE(v) < 0 ? -x : x;
1127
1128 overflow:
Tim Peters9fffa3e2001-09-04 05:14:19 +00001129 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum523d4f92007-01-15 00:31:49 +00001130 "Python int too large to convert to C double");
Tim Peters9fffa3e2001-09-04 05:14:19 +00001131 return -1.0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001132}
1133
Guido van Rossum78694d91998-09-18 14:14:13 +00001134/* Create a new long (or int) object from a C pointer */
1135
1136PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00001137PyLong_FromVoidPtr(void *p)
Guido van Rossum78694d91998-09-18 14:14:13 +00001138{
Tim Peters70128a12001-06-16 08:48:40 +00001139#ifndef HAVE_LONG_LONG
1140# error "PyLong_FromVoidPtr: sizeof(void*) > sizeof(long), but no long long"
1141#endif
1142#if SIZEOF_LONG_LONG < SIZEOF_VOID_P
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001143# error "PyLong_FromVoidPtr: sizeof(PY_LONG_LONG) < sizeof(void*)"
Tim Peters70128a12001-06-16 08:48:40 +00001144#endif
Guido van Rossumddefaf32007-01-14 03:31:43 +00001145 /* special-case null pointer */
1146 if (!p)
Christian Heimes217cfd12007-12-02 14:31:20 +00001147 return PyLong_FromLong(0);
Guido van Rossumddefaf32007-01-14 03:31:43 +00001148 return PyLong_FromUnsignedLongLong((unsigned PY_LONG_LONG)(Py_uintptr_t)p);
Tim Peters70128a12001-06-16 08:48:40 +00001149
Guido van Rossum78694d91998-09-18 14:14:13 +00001150}
1151
1152/* Get a C pointer from a long object (or an int object in some cases) */
1153
1154void *
Tim Peters9f688bf2000-07-07 15:53:28 +00001155PyLong_AsVoidPtr(PyObject *vv)
Guido van Rossum78694d91998-09-18 14:14:13 +00001156{
1157 /* This function will allow int or long objects. If vv is neither,
1158 then the PyLong_AsLong*() functions will raise the exception:
1159 PyExc_SystemError, "bad argument to internal function"
1160 */
Tim Peters70128a12001-06-16 08:48:40 +00001161#if SIZEOF_VOID_P <= SIZEOF_LONG
Guido van Rossum78694d91998-09-18 14:14:13 +00001162 long x;
1163
Guido van Rossumddefaf32007-01-14 03:31:43 +00001164 if (PyLong_Check(vv) && _PyLong_Sign(vv) < 0)
Guido van Rossum78694d91998-09-18 14:14:13 +00001165 x = PyLong_AsLong(vv);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001166 else
1167 x = PyLong_AsUnsignedLong(vv);
Guido van Rossum78694d91998-09-18 14:14:13 +00001168#else
Tim Peters70128a12001-06-16 08:48:40 +00001169
1170#ifndef HAVE_LONG_LONG
1171# error "PyLong_AsVoidPtr: sizeof(void*) > sizeof(long), but no long long"
1172#endif
1173#if SIZEOF_LONG_LONG < SIZEOF_VOID_P
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001174# error "PyLong_AsVoidPtr: sizeof(PY_LONG_LONG) < sizeof(void*)"
Tim Peters70128a12001-06-16 08:48:40 +00001175#endif
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001176 PY_LONG_LONG x;
Guido van Rossum78694d91998-09-18 14:14:13 +00001177
Guido van Rossumddefaf32007-01-14 03:31:43 +00001178 if (PyLong_Check(vv) && _PyLong_Sign(vv) < 0)
Guido van Rossum78694d91998-09-18 14:14:13 +00001179 x = PyLong_AsLongLong(vv);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001180 else
1181 x = PyLong_AsUnsignedLongLong(vv);
Tim Peters70128a12001-06-16 08:48:40 +00001182
1183#endif /* SIZEOF_VOID_P <= SIZEOF_LONG */
Guido van Rossum78694d91998-09-18 14:14:13 +00001184
1185 if (x == -1 && PyErr_Occurred())
1186 return NULL;
1187 return (void *)x;
1188}
1189
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001190#ifdef HAVE_LONG_LONG
Tim Petersd1a7da62001-06-13 00:35:57 +00001191
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001192/* Initial PY_LONG_LONG support by Chris Herborth (chrish@qnx.com), later
Tim Petersd1a7da62001-06-13 00:35:57 +00001193 * rewritten to use the newer PyLong_{As,From}ByteArray API.
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001194 */
1195
Tim Peterscf37dfc2001-06-14 18:42:50 +00001196#define IS_LITTLE_ENDIAN (int)*(unsigned char*)&one
Tim Petersd1a7da62001-06-13 00:35:57 +00001197
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001198/* Create a new long int object from a C PY_LONG_LONG int. */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001199
1200PyObject *
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001201PyLong_FromLongLong(PY_LONG_LONG ival)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001202{
Thomas Wouters477c8d52006-05-27 19:21:47 +00001203 PyLongObject *v;
Christian Heimesdae2a892008-04-19 00:55:37 +00001204 unsigned PY_LONG_LONG abs_ival;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001205 unsigned PY_LONG_LONG t; /* unsigned so >> doesn't propagate sign bit */
1206 int ndigits = 0;
1207 int negative = 0;
1208
Guido van Rossumddefaf32007-01-14 03:31:43 +00001209 CHECK_SMALL_INT(ival);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001210 if (ival < 0) {
Christian Heimesdae2a892008-04-19 00:55:37 +00001211 /* avoid signed overflow on negation; see comments
1212 in PyLong_FromLong above. */
1213 abs_ival = (unsigned PY_LONG_LONG)(-1-ival) + 1;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001214 negative = 1;
1215 }
Christian Heimesdae2a892008-04-19 00:55:37 +00001216 else {
1217 abs_ival = (unsigned PY_LONG_LONG)ival;
1218 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001219
1220 /* Count the number of Python digits.
1221 We used to pick 5 ("big enough for anything"), but that's a
1222 waste of time and space given that 5*15 = 75 bits are rarely
1223 needed. */
Christian Heimesdae2a892008-04-19 00:55:37 +00001224 t = abs_ival;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001225 while (t) {
1226 ++ndigits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001227 t >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001228 }
1229 v = _PyLong_New(ndigits);
1230 if (v != NULL) {
1231 digit *p = v->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +00001232 Py_SIZE(v) = negative ? -ndigits : ndigits;
Christian Heimesdae2a892008-04-19 00:55:37 +00001233 t = abs_ival;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001234 while (t) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001235 *p++ = (digit)(t & PyLong_MASK);
1236 t >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001237 }
1238 }
1239 return (PyObject *)v;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001240}
1241
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001242/* Create a new long int object from a C unsigned PY_LONG_LONG int. */
Tim Petersd1a7da62001-06-13 00:35:57 +00001243
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001244PyObject *
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001245PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG ival)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001246{
Thomas Wouters477c8d52006-05-27 19:21:47 +00001247 PyLongObject *v;
1248 unsigned PY_LONG_LONG t;
1249 int ndigits = 0;
1250
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001251 if (ival < PyLong_BASE)
Mark Dickinson50b2b6e2008-12-05 17:14:29 +00001252 return PyLong_FromLong((long)ival);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001253 /* Count the number of Python digits. */
1254 t = (unsigned PY_LONG_LONG)ival;
1255 while (t) {
1256 ++ndigits;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001257 t >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001258 }
1259 v = _PyLong_New(ndigits);
1260 if (v != NULL) {
1261 digit *p = v->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +00001262 Py_SIZE(v) = ndigits;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001263 while (ival) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001264 *p++ = (digit)(ival & PyLong_MASK);
1265 ival >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001266 }
1267 }
1268 return (PyObject *)v;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001269}
1270
Martin v. Löwis18e16552006-02-15 17:27:45 +00001271/* Create a new long int object from a C Py_ssize_t. */
1272
1273PyObject *
Guido van Rossumddefaf32007-01-14 03:31:43 +00001274PyLong_FromSsize_t(Py_ssize_t ival)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001275{
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001276 PyLongObject *v;
1277 size_t abs_ival;
1278 size_t t; /* unsigned so >> doesn't propagate sign bit */
1279 int ndigits = 0;
1280 int negative = 0;
1281
1282 CHECK_SMALL_INT(ival);
1283 if (ival < 0) {
1284 /* avoid signed overflow when ival = SIZE_T_MIN */
1285 abs_ival = (size_t)(-1-ival)+1;
1286 negative = 1;
1287 }
1288 else {
1289 abs_ival = (size_t)ival;
1290 }
1291
1292 /* Count the number of Python digits. */
1293 t = abs_ival;
1294 while (t) {
1295 ++ndigits;
1296 t >>= PyLong_SHIFT;
1297 }
1298 v = _PyLong_New(ndigits);
1299 if (v != NULL) {
1300 digit *p = v->ob_digit;
1301 Py_SIZE(v) = negative ? -ndigits : ndigits;
1302 t = abs_ival;
1303 while (t) {
1304 *p++ = (digit)(t & PyLong_MASK);
1305 t >>= PyLong_SHIFT;
1306 }
1307 }
1308 return (PyObject *)v;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001309}
1310
1311/* Create a new long int object from a C size_t. */
1312
1313PyObject *
Guido van Rossumddefaf32007-01-14 03:31:43 +00001314PyLong_FromSize_t(size_t ival)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001315{
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001316 PyLongObject *v;
1317 size_t t;
1318 int ndigits = 0;
1319
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001320 if (ival < PyLong_BASE)
Guido van Rossumddefaf32007-01-14 03:31:43 +00001321 return PyLong_FromLong(ival);
Mark Dickinson7ab6be22008-04-15 21:42:42 +00001322 /* Count the number of Python digits. */
1323 t = ival;
1324 while (t) {
1325 ++ndigits;
1326 t >>= PyLong_SHIFT;
1327 }
1328 v = _PyLong_New(ndigits);
1329 if (v != NULL) {
1330 digit *p = v->ob_digit;
1331 Py_SIZE(v) = ndigits;
1332 while (ival) {
1333 *p++ = (digit)(ival & PyLong_MASK);
1334 ival >>= PyLong_SHIFT;
1335 }
1336 }
1337 return (PyObject *)v;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001338}
1339
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001340/* Get a C PY_LONG_LONG int from a long int object.
Tim Petersd1a7da62001-06-13 00:35:57 +00001341 Return -1 and set an error if overflow occurs. */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001342
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001343PY_LONG_LONG
Tim Peters9f688bf2000-07-07 15:53:28 +00001344PyLong_AsLongLong(PyObject *vv)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001345{
Guido van Rossumddefaf32007-01-14 03:31:43 +00001346 PyLongObject *v;
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001347 PY_LONG_LONG bytes;
Tim Petersd1a7da62001-06-13 00:35:57 +00001348 int one = 1;
1349 int res;
1350
Tim Petersd38b1c72001-09-30 05:09:37 +00001351 if (vv == NULL) {
1352 PyErr_BadInternalCall();
1353 return -1;
1354 }
1355 if (!PyLong_Check(vv)) {
Martin v. Löwis6ce7ed22005-03-03 12:26:35 +00001356 PyNumberMethods *nb;
1357 PyObject *io;
Martin v. Löwis6ce7ed22005-03-03 12:26:35 +00001358 if ((nb = vv->ob_type->tp_as_number) == NULL ||
1359 nb->nb_int == NULL) {
1360 PyErr_SetString(PyExc_TypeError, "an integer is required");
1361 return -1;
1362 }
1363 io = (*nb->nb_int) (vv);
1364 if (io == NULL)
1365 return -1;
Martin v. Löwis6ce7ed22005-03-03 12:26:35 +00001366 if (PyLong_Check(io)) {
1367 bytes = PyLong_AsLongLong(io);
1368 Py_DECREF(io);
1369 return bytes;
1370 }
1371 Py_DECREF(io);
1372 PyErr_SetString(PyExc_TypeError, "integer conversion failed");
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001373 return -1;
1374 }
1375
Guido van Rossumddefaf32007-01-14 03:31:43 +00001376 v = (PyLongObject*)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +00001377 switch(Py_SIZE(v)) {
Mark Dickinson0d4785b2009-02-15 17:27:41 +00001378 case -1: return -(sdigit)v->ob_digit[0];
Guido van Rossumddefaf32007-01-14 03:31:43 +00001379 case 0: return 0;
1380 case 1: return v->ob_digit[0];
1381 }
Tim Petersd1a7da62001-06-13 00:35:57 +00001382 res = _PyLong_AsByteArray(
1383 (PyLongObject *)vv, (unsigned char *)&bytes,
1384 SIZEOF_LONG_LONG, IS_LITTLE_ENDIAN, 1);
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001385
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001386 /* Plan 9 can't handle PY_LONG_LONG in ? : expressions */
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001387 if (res < 0)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001388 return (PY_LONG_LONG)-1;
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001389 else
1390 return bytes;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001391}
1392
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001393/* Get a C unsigned PY_LONG_LONG int from a long int object.
Tim Petersd1a7da62001-06-13 00:35:57 +00001394 Return -1 and set an error if overflow occurs. */
1395
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001396unsigned PY_LONG_LONG
Tim Peters9f688bf2000-07-07 15:53:28 +00001397PyLong_AsUnsignedLongLong(PyObject *vv)
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001398{
Guido van Rossumddefaf32007-01-14 03:31:43 +00001399 PyLongObject *v;
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001400 unsigned PY_LONG_LONG bytes;
Tim Petersd1a7da62001-06-13 00:35:57 +00001401 int one = 1;
1402 int res;
1403
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001404 if (vv == NULL || !PyLong_Check(vv)) {
1405 PyErr_BadInternalCall();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001406 return (unsigned PY_LONG_LONG)-1;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001407 }
1408
Guido van Rossumddefaf32007-01-14 03:31:43 +00001409 v = (PyLongObject*)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +00001410 switch(Py_SIZE(v)) {
Guido van Rossumddefaf32007-01-14 03:31:43 +00001411 case 0: return 0;
1412 case 1: return v->ob_digit[0];
1413 }
1414
Tim Petersd1a7da62001-06-13 00:35:57 +00001415 res = _PyLong_AsByteArray(
1416 (PyLongObject *)vv, (unsigned char *)&bytes,
1417 SIZEOF_LONG_LONG, IS_LITTLE_ENDIAN, 0);
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001418
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001419 /* Plan 9 can't handle PY_LONG_LONG in ? : expressions */
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001420 if (res < 0)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +00001421 return (unsigned PY_LONG_LONG)res;
Martin v. Löwisc8bb9eb2002-03-09 12:02:59 +00001422 else
1423 return bytes;
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001424}
Tim Petersd1a7da62001-06-13 00:35:57 +00001425
Thomas Hellera4ea6032003-04-17 18:55:45 +00001426/* Get a C unsigned long int from a long int object, ignoring the high bits.
1427 Returns -1 and sets an error condition if an error occurs. */
1428
Guido van Rossumddefaf32007-01-14 03:31:43 +00001429static unsigned PY_LONG_LONG
1430_PyLong_AsUnsignedLongLongMask(PyObject *vv)
Thomas Hellera4ea6032003-04-17 18:55:45 +00001431{
1432 register PyLongObject *v;
1433 unsigned PY_LONG_LONG x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001434 Py_ssize_t i;
1435 int sign;
Thomas Hellera4ea6032003-04-17 18:55:45 +00001436
1437 if (vv == NULL || !PyLong_Check(vv)) {
1438 PyErr_BadInternalCall();
1439 return (unsigned long) -1;
1440 }
1441 v = (PyLongObject *)vv;
Christian Heimes90aa7642007-12-19 02:45:37 +00001442 switch(Py_SIZE(v)) {
Guido van Rossumddefaf32007-01-14 03:31:43 +00001443 case 0: return 0;
1444 case 1: return v->ob_digit[0];
1445 }
Christian Heimes90aa7642007-12-19 02:45:37 +00001446 i = Py_SIZE(v);
Thomas Hellera4ea6032003-04-17 18:55:45 +00001447 sign = 1;
1448 x = 0;
1449 if (i < 0) {
1450 sign = -1;
1451 i = -i;
1452 }
1453 while (--i >= 0) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001454 x = (x << PyLong_SHIFT) + v->ob_digit[i];
Thomas Hellera4ea6032003-04-17 18:55:45 +00001455 }
1456 return x * sign;
1457}
Guido van Rossumddefaf32007-01-14 03:31:43 +00001458
1459unsigned PY_LONG_LONG
1460PyLong_AsUnsignedLongLongMask(register PyObject *op)
1461{
1462 PyNumberMethods *nb;
1463 PyLongObject *lo;
1464 unsigned PY_LONG_LONG val;
1465
1466 if (op && PyLong_Check(op))
1467 return _PyLong_AsUnsignedLongLongMask(op);
1468
1469 if (op == NULL || (nb = op->ob_type->tp_as_number) == NULL ||
1470 nb->nb_int == NULL) {
1471 PyErr_SetString(PyExc_TypeError, "an integer is required");
1472 return (unsigned PY_LONG_LONG)-1;
1473 }
1474
1475 lo = (PyLongObject*) (*nb->nb_int) (op);
1476 if (lo == NULL)
1477 return (unsigned PY_LONG_LONG)-1;
1478 if (PyLong_Check(lo)) {
1479 val = _PyLong_AsUnsignedLongLongMask((PyObject *)lo);
1480 Py_DECREF(lo);
1481 if (PyErr_Occurred())
1482 return (unsigned PY_LONG_LONG)-1;
1483 return val;
1484 }
1485 else
1486 {
1487 Py_DECREF(lo);
1488 PyErr_SetString(PyExc_TypeError,
1489 "nb_int should return int object");
1490 return (unsigned PY_LONG_LONG)-1;
1491 }
1492}
Tim Petersd1a7da62001-06-13 00:35:57 +00001493#undef IS_LITTLE_ENDIAN
1494
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001495#endif /* HAVE_LONG_LONG */
1496
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00001497#define CHECK_BINOP(v,w) \
1498 if (!PyLong_Check(v) || !PyLong_Check(w)) { \
Neil Schemenauerba872e22001-01-04 01:46:03 +00001499 Py_INCREF(Py_NotImplemented); \
1500 return Py_NotImplemented; \
1501 }
1502
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001503/* bits_in_digit(d) returns the unique integer k such that 2**(k-1) <= d <
1504 2**k if d is nonzero, else 0. */
1505
1506static const unsigned char BitLengthTable[32] = {
1507 0, 1, 2, 2, 3, 3, 3, 3, 4, 4, 4, 4, 4, 4, 4, 4,
1508 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5
1509};
1510
1511static int
1512bits_in_digit(digit d)
1513{
1514 int d_bits = 0;
1515 while (d >= 32) {
1516 d_bits += 6;
1517 d >>= 6;
1518 }
1519 d_bits += (int)BitLengthTable[d];
1520 return d_bits;
1521}
1522
Tim Peters877a2122002-08-12 05:09:36 +00001523/* x[0:m] and y[0:n] are digit vectors, LSD first, m >= n required. x[0:n]
1524 * is modified in place, by adding y to it. Carries are propagated as far as
1525 * x[m-1], and the remaining carry (0 or 1) is returned.
1526 */
1527static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001528v_iadd(digit *x, Py_ssize_t m, digit *y, Py_ssize_t n)
Tim Peters877a2122002-08-12 05:09:36 +00001529{
Mark Dickinson17e55872009-01-24 15:56:57 +00001530 Py_ssize_t i;
Tim Peters877a2122002-08-12 05:09:36 +00001531 digit carry = 0;
1532
1533 assert(m >= n);
1534 for (i = 0; i < n; ++i) {
1535 carry += x[i] + y[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001536 x[i] = carry & PyLong_MASK;
1537 carry >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001538 assert((carry & 1) == carry);
1539 }
1540 for (; carry && i < m; ++i) {
1541 carry += x[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001542 x[i] = carry & PyLong_MASK;
1543 carry >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001544 assert((carry & 1) == carry);
1545 }
1546 return carry;
1547}
1548
1549/* x[0:m] and y[0:n] are digit vectors, LSD first, m >= n required. x[0:n]
1550 * is modified in place, by subtracting y from it. Borrows are propagated as
1551 * far as x[m-1], and the remaining borrow (0 or 1) is returned.
1552 */
1553static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001554v_isub(digit *x, Py_ssize_t m, digit *y, Py_ssize_t n)
Tim Peters877a2122002-08-12 05:09:36 +00001555{
Mark Dickinson17e55872009-01-24 15:56:57 +00001556 Py_ssize_t i;
Tim Peters877a2122002-08-12 05:09:36 +00001557 digit borrow = 0;
1558
1559 assert(m >= n);
1560 for (i = 0; i < n; ++i) {
1561 borrow = x[i] - y[i] - borrow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001562 x[i] = borrow & PyLong_MASK;
1563 borrow >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001564 borrow &= 1; /* keep only 1 sign bit */
1565 }
1566 for (; borrow && i < m; ++i) {
1567 borrow = x[i] - borrow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001568 x[i] = borrow & PyLong_MASK;
1569 borrow >>= PyLong_SHIFT;
Tim Peters877a2122002-08-12 05:09:36 +00001570 borrow &= 1;
1571 }
1572 return borrow;
1573}
Neil Schemenauerba872e22001-01-04 01:46:03 +00001574
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001575/* Shift digit vector a[0:m] d bits left, with 0 <= d < PyLong_SHIFT. Put
1576 * result in z[0:m], and return the d bits shifted out of the top.
1577 */
1578static digit
1579v_lshift(digit *z, digit *a, Py_ssize_t m, int d)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001580{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001581 Py_ssize_t i;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001582 digit carry = 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001583
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001584 assert(0 <= d && d < PyLong_SHIFT);
1585 for (i=0; i < m; i++) {
1586 twodigits acc = (twodigits)a[i] << d | carry;
1587 z[i] = (digit)acc & PyLong_MASK;
1588 carry = (digit)(acc >> PyLong_SHIFT);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001589 }
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00001590 return carry;
1591}
1592
1593/* Shift digit vector a[0:m] d bits right, with 0 <= d < PyLong_SHIFT. Put
1594 * result in z[0:m], and return the d bits shifted out of the bottom.
1595 */
1596static digit
1597v_rshift(digit *z, digit *a, Py_ssize_t m, int d)
1598{
1599 Py_ssize_t i;
1600 digit carry = 0;
1601 digit mask = ((digit)1 << d) - 1U;
1602
1603 assert(0 <= d && d < PyLong_SHIFT);
1604 for (i=m; i-- > 0;) {
1605 twodigits acc = (twodigits)carry << PyLong_SHIFT | a[i];
1606 carry = (digit)acc & mask;
1607 z[i] = (digit)(acc >> d);
1608 }
1609 return carry;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001610}
1611
Tim Peters212e6142001-07-14 12:23:19 +00001612/* Divide long pin, w/ size digits, by non-zero digit n, storing quotient
1613 in pout, and returning the remainder. pin and pout point at the LSD.
1614 It's OK for pin == pout on entry, which saves oodles of mallocs/frees in
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001615 _PyLong_Format, but that should be done with great care since longs are
Tim Peters212e6142001-07-14 12:23:19 +00001616 immutable. */
1617
1618static digit
Martin v. Löwis18e16552006-02-15 17:27:45 +00001619inplace_divrem1(digit *pout, digit *pin, Py_ssize_t size, digit n)
Tim Peters212e6142001-07-14 12:23:19 +00001620{
1621 twodigits rem = 0;
1622
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001623 assert(n > 0 && n <= PyLong_MASK);
Tim Peters212e6142001-07-14 12:23:19 +00001624 pin += size;
1625 pout += size;
1626 while (--size >= 0) {
1627 digit hi;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001628 rem = (rem << PyLong_SHIFT) + *--pin;
Tim Peters212e6142001-07-14 12:23:19 +00001629 *--pout = hi = (digit)(rem / n);
Mark Dickinson17e55872009-01-24 15:56:57 +00001630 rem -= (twodigits)hi * n;
Tim Peters212e6142001-07-14 12:23:19 +00001631 }
1632 return (digit)rem;
1633}
1634
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001635/* Divide a long integer by a digit, returning both the quotient
1636 (as function result) and the remainder (through *prem).
1637 The sign of a is ignored; n should not be zero. */
1638
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001639static PyLongObject *
Tim Peters212e6142001-07-14 12:23:19 +00001640divrem1(PyLongObject *a, digit n, digit *prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001641{
Christian Heimes90aa7642007-12-19 02:45:37 +00001642 const Py_ssize_t size = ABS(Py_SIZE(a));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001643 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001644
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001645 assert(n > 0 && n <= PyLong_MASK);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001646 z = _PyLong_New(size);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001647 if (z == NULL)
1648 return NULL;
Tim Peters212e6142001-07-14 12:23:19 +00001649 *prem = inplace_divrem1(z->ob_digit, a->ob_digit, size, n);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001650 return long_normalize(z);
1651}
1652
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001653/* Convert a long integer to a base 10 string. Returns a new non-shared
1654 string. (Return value is non-shared so that callers can modify the
1655 returned value if necessary.) */
1656
1657static PyObject *
1658long_to_decimal_string(PyObject *aa)
1659{
1660 PyLongObject *scratch, *a;
1661 PyObject *str;
1662 Py_ssize_t size, strlen, size_a, i, j;
1663 digit *pout, *pin, rem, tenpow;
1664 Py_UNICODE *p;
1665 int negative;
1666
1667 a = (PyLongObject *)aa;
1668 if (a == NULL || !PyLong_Check(a)) {
1669 PyErr_BadInternalCall();
1670 return NULL;
1671 }
1672 size_a = ABS(Py_SIZE(a));
1673 negative = Py_SIZE(a) < 0;
1674
1675 /* quick and dirty upper bound for the number of digits
1676 required to express a in base _PyLong_DECIMAL_BASE:
1677
1678 #digits = 1 + floor(log2(a) / log2(_PyLong_DECIMAL_BASE))
1679
1680 But log2(a) < size_a * PyLong_SHIFT, and
1681 log2(_PyLong_DECIMAL_BASE) = log2(10) * _PyLong_DECIMAL_SHIFT
1682 > 3 * _PyLong_DECIMAL_SHIFT
1683 */
1684 if (size_a > PY_SSIZE_T_MAX / PyLong_SHIFT) {
1685 PyErr_SetString(PyExc_OverflowError,
1686 "long is too large to format");
1687 return NULL;
1688 }
1689 /* the expression size_a * PyLong_SHIFT is now safe from overflow */
1690 size = 1 + size_a * PyLong_SHIFT / (3 * _PyLong_DECIMAL_SHIFT);
1691 scratch = _PyLong_New(size);
1692 if (scratch == NULL)
1693 return NULL;
1694
1695 /* convert array of base _PyLong_BASE digits in pin to an array of
1696 base _PyLong_DECIMAL_BASE digits in pout, following Knuth (TAOCP,
1697 Volume 2 (3rd edn), section 4.4, Method 1b). */
1698 pin = a->ob_digit;
1699 pout = scratch->ob_digit;
1700 size = 0;
1701 for (i = size_a; --i >= 0; ) {
1702 digit hi = pin[i];
1703 for (j = 0; j < size; j++) {
1704 twodigits z = (twodigits)pout[j] << PyLong_SHIFT | hi;
1705 hi = z / _PyLong_DECIMAL_BASE;
1706 pout[j] = z - (twodigits)hi * _PyLong_DECIMAL_BASE;
1707 }
1708 while (hi) {
1709 pout[size++] = hi % _PyLong_DECIMAL_BASE;
1710 hi /= _PyLong_DECIMAL_BASE;
1711 }
1712 /* check for keyboard interrupt */
1713 SIGCHECK({
1714 Py_DECREF(scratch);
1715 return NULL;
1716 })
1717 }
1718 /* pout should have at least one digit, so that the case when a = 0
1719 works correctly */
1720 if (size == 0)
1721 pout[size++] = 0;
1722
1723 /* calculate exact length of output string, and allocate */
1724 strlen = negative + 1 + (size - 1) * _PyLong_DECIMAL_SHIFT;
1725 tenpow = 10;
1726 rem = pout[size-1];
1727 while (rem >= tenpow) {
1728 tenpow *= 10;
1729 strlen++;
1730 }
1731 str = PyUnicode_FromUnicode(NULL, strlen);
1732 if (str == NULL) {
1733 Py_DECREF(scratch);
1734 return NULL;
1735 }
1736
1737 /* fill the string right-to-left */
1738 p = PyUnicode_AS_UNICODE(str) + strlen;
1739 *p = '\0';
1740 /* pout[0] through pout[size-2] contribute exactly
1741 _PyLong_DECIMAL_SHIFT digits each */
1742 for (i=0; i < size - 1; i++) {
1743 rem = pout[i];
1744 for (j = 0; j < _PyLong_DECIMAL_SHIFT; j++) {
1745 *--p = '0' + rem % 10;
1746 rem /= 10;
1747 }
1748 }
1749 /* pout[size-1]: always produce at least one decimal digit */
1750 rem = pout[i];
1751 do {
1752 *--p = '0' + rem % 10;
1753 rem /= 10;
1754 } while (rem != 0);
1755
1756 /* and sign */
1757 if (negative)
1758 *--p = '-';
1759
1760 /* check we've counted correctly */
1761 assert(p == PyUnicode_AS_UNICODE(str));
1762 Py_DECREF(scratch);
1763 return (PyObject *)str;
1764}
1765
Mark Dickinsoncd068122009-09-18 14:53:08 +00001766/* Convert a long int object to a string, using a given conversion base,
1767 which should be one of 2, 8, 10 or 16. Return a string object.
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001768 If base is 2, 8 or 16, add the proper prefix '0b', '0o' or '0x'. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001769
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001770PyObject *
1771_PyLong_Format(PyObject *aa, int base)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001772{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001773 register PyLongObject *a = (PyLongObject *)aa;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001774 PyObject *str;
Mark Dickinson659c7b12009-09-13 12:06:08 +00001775 Py_ssize_t i, sz;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001776 Py_ssize_t size_a;
Mark Dickinsoncd068122009-09-18 14:53:08 +00001777 Py_UNICODE *p, sign = '\0';
Mark Dickinson8accd6b2009-09-17 19:39:12 +00001778 int bits;
Guido van Rossume32e0141992-01-19 16:31:05 +00001779
Mark Dickinsoncd068122009-09-18 14:53:08 +00001780 assert(base == 2 || base == 8 || base == 10 || base == 16);
Mark Dickinson0a1efd02009-09-16 21:23:34 +00001781 if (base == 10)
1782 return long_to_decimal_string((PyObject *)a);
1783
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001784 if (a == NULL || !PyLong_Check(a)) {
1785 PyErr_BadInternalCall();
Guido van Rossume32e0141992-01-19 16:31:05 +00001786 return NULL;
1787 }
Christian Heimes90aa7642007-12-19 02:45:37 +00001788 size_a = ABS(Py_SIZE(a));
Tim Peters5af4e6c2002-08-12 02:31:19 +00001789
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001790 /* Compute a rough upper bound for the length of the string */
Mark Dickinsoncd068122009-09-18 14:53:08 +00001791 switch (base) {
1792 case 16:
1793 bits = 4;
1794 break;
1795 case 8:
1796 bits = 3;
1797 break;
1798 case 2:
1799 bits = 1;
1800 break;
1801 default:
1802 assert(0); /* shouldn't ever get here */
1803 bits = 0; /* to silence gcc warning */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001804 }
Mark Dickinsoncd068122009-09-18 14:53:08 +00001805 /* compute length of output string: allow 2 characters for prefix and
1806 1 for possible '-' sign. */
1807 if (size_a > (PY_SSIZE_T_MAX - 3) / PyLong_SHIFT) {
Thomas Wouters89f507f2006-12-13 04:49:30 +00001808 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001809 "int is too large to format");
Thomas Wouters89f507f2006-12-13 04:49:30 +00001810 return NULL;
1811 }
Mark Dickinsoncd068122009-09-18 14:53:08 +00001812 /* now size_a * PyLong_SHIFT + 3 <= PY_SSIZE_T_MAX, so the RHS below
1813 is safe from overflow */
1814 sz = 3 + (size_a * PyLong_SHIFT + (bits - 1)) / bits;
Mark Dickinson659c7b12009-09-13 12:06:08 +00001815 assert(sz >= 0);
Walter Dörwald1ab83302007-05-18 17:15:44 +00001816 str = PyUnicode_FromUnicode(NULL, sz);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001817 if (str == NULL)
1818 return NULL;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001819 p = PyUnicode_AS_UNICODE(str) + sz;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001820 *p = '\0';
Mark Dickinson8accd6b2009-09-17 19:39:12 +00001821 if (Py_SIZE(a) < 0)
1822 sign = '-';
Tim Peters5af4e6c2002-08-12 02:31:19 +00001823
Christian Heimes90aa7642007-12-19 02:45:37 +00001824 if (Py_SIZE(a) == 0) {
Guido van Rossumbd3a5271998-08-11 15:04:47 +00001825 *--p = '0';
1826 }
Mark Dickinsoncd068122009-09-18 14:53:08 +00001827 else {
Mark Dickinson8accd6b2009-09-17 19:39:12 +00001828 /* JRH: special case for power-of-2 bases */
1829 twodigits accum = 0;
1830 int accumbits = 0; /* # of bits in accum */
Mark Dickinson8accd6b2009-09-17 19:39:12 +00001831 for (i = 0; i < size_a; ++i) {
1832 accum |= (twodigits)a->ob_digit[i] << accumbits;
1833 accumbits += PyLong_SHIFT;
Mark Dickinsoncd068122009-09-18 14:53:08 +00001834 assert(accumbits >= bits);
Mark Dickinson8accd6b2009-09-17 19:39:12 +00001835 do {
Mark Dickinsoncd068122009-09-18 14:53:08 +00001836 Py_UNICODE cdigit = accum & (base - 1);
Mark Dickinson8accd6b2009-09-17 19:39:12 +00001837 cdigit += (cdigit < 10) ? '0' : 'a'-10;
1838 assert(p > PyUnicode_AS_UNICODE(str));
1839 *--p = cdigit;
Mark Dickinsoncd068122009-09-18 14:53:08 +00001840 accumbits -= bits;
1841 accum >>= bits;
1842 } while (i < size_a-1 ? accumbits >= bits : accum > 0);
Mark Dickinson8accd6b2009-09-17 19:39:12 +00001843 }
1844 }
Mark Dickinson8accd6b2009-09-17 19:39:12 +00001845
Mark Dickinsoncd068122009-09-18 14:53:08 +00001846 if (base == 16)
Guido van Rossum3d3037d1991-10-24 14:55:57 +00001847 *--p = 'x';
Mark Dickinsoncd068122009-09-18 14:53:08 +00001848 else if (base == 8)
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001849 *--p = 'o';
Mark Dickinsoncd068122009-09-18 14:53:08 +00001850 else /* (base == 2) */
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001851 *--p = 'b';
Mark Dickinsoncd068122009-09-18 14:53:08 +00001852 *--p = '0';
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001853 if (sign)
1854 *--p = sign;
Walter Dörwald1ab83302007-05-18 17:15:44 +00001855 if (p != PyUnicode_AS_UNICODE(str)) {
1856 Py_UNICODE *q = PyUnicode_AS_UNICODE(str);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001857 assert(p > q);
1858 do {
1859 } while ((*q++ = *p++) != '\0');
Guido van Rossumc7ec9c91991-05-28 21:58:16 +00001860 q--;
Mark Dickinson659c7b12009-09-13 12:06:08 +00001861 if (PyUnicode_Resize(&str,(Py_ssize_t) (q -
1862 PyUnicode_AS_UNICODE(str)))) {
Walter Dörwald1ab83302007-05-18 17:15:44 +00001863 Py_DECREF(str);
1864 return NULL;
1865 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001866 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001867 return (PyObject *)str;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001868}
1869
Thomas Wouters477c8d52006-05-27 19:21:47 +00001870/* Table of digit values for 8-bit string -> integer conversion.
1871 * '0' maps to 0, ..., '9' maps to 9.
1872 * 'a' and 'A' map to 10, ..., 'z' and 'Z' map to 35.
1873 * All other indices map to 37.
1874 * Note that when converting a base B string, a char c is a legitimate
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001875 * base B digit iff _PyLong_DigitValue[Py_CHARPyLong_MASK(c)] < B.
Thomas Wouters477c8d52006-05-27 19:21:47 +00001876 */
Raymond Hettinger35631532009-01-09 03:58:09 +00001877unsigned char _PyLong_DigitValue[256] = {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001878 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1879 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1880 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1881 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 37, 37, 37, 37, 37, 37,
1882 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1883 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1884 37, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
1885 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 37, 37, 37, 37,
1886 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1887 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1888 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1889 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1890 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1891 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1892 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1893 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37,
1894};
1895
1896/* *str points to the first digit in a string of base `base` digits. base
Tim Petersbf2674b2003-02-02 07:51:32 +00001897 * is a power of 2 (2, 4, 8, 16, or 32). *str is set to point to the first
1898 * non-digit (which may be *str!). A normalized long is returned.
1899 * The point to this routine is that it takes time linear in the number of
1900 * string characters.
1901 */
1902static PyLongObject *
1903long_from_binary_base(char **str, int base)
1904{
1905 char *p = *str;
1906 char *start = p;
1907 int bits_per_char;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001908 Py_ssize_t n;
Tim Petersbf2674b2003-02-02 07:51:32 +00001909 PyLongObject *z;
1910 twodigits accum;
1911 int bits_in_accum;
1912 digit *pdigit;
1913
1914 assert(base >= 2 && base <= 32 && (base & (base - 1)) == 0);
1915 n = base;
1916 for (bits_per_char = -1; n; ++bits_per_char)
1917 n >>= 1;
1918 /* n <- total # of bits needed, while setting p to end-of-string */
Christian Heimesbbe741d2008-03-28 10:53:29 +00001919 while (_PyLong_DigitValue[Py_CHARMASK(*p)] < base)
Tim Petersbf2674b2003-02-02 07:51:32 +00001920 ++p;
Tim Petersbf2674b2003-02-02 07:51:32 +00001921 *str = p;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001922 /* n <- # of Python digits needed, = ceiling(n/PyLong_SHIFT). */
1923 n = (p - start) * bits_per_char + PyLong_SHIFT - 1;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001924 if (n / bits_per_char < p - start) {
Tim Peters1a3b19a2003-02-02 17:33:53 +00001925 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001926 "int string too large to convert");
Tim Peters1a3b19a2003-02-02 17:33:53 +00001927 return NULL;
1928 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001929 n = n / PyLong_SHIFT;
Tim Petersbf2674b2003-02-02 07:51:32 +00001930 z = _PyLong_New(n);
1931 if (z == NULL)
1932 return NULL;
1933 /* Read string from right, and fill in long from left; i.e.,
1934 * from least to most significant in both.
1935 */
1936 accum = 0;
1937 bits_in_accum = 0;
1938 pdigit = z->ob_digit;
1939 while (--p >= start) {
Raymond Hettinger35631532009-01-09 03:58:09 +00001940 int k = (int)_PyLong_DigitValue[Py_CHARMASK(*p)];
Tim Petersc7bc0b92003-05-05 20:39:43 +00001941 assert(k >= 0 && k < base);
Mark Dickinson17e55872009-01-24 15:56:57 +00001942 accum |= (twodigits)k << bits_in_accum;
Tim Petersbf2674b2003-02-02 07:51:32 +00001943 bits_in_accum += bits_per_char;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001944 if (bits_in_accum >= PyLong_SHIFT) {
1945 *pdigit++ = (digit)(accum & PyLong_MASK);
Mark Dickinson17e55872009-01-24 15:56:57 +00001946 assert(pdigit - z->ob_digit <= n);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001947 accum >>= PyLong_SHIFT;
1948 bits_in_accum -= PyLong_SHIFT;
1949 assert(bits_in_accum < PyLong_SHIFT);
Tim Petersbf2674b2003-02-02 07:51:32 +00001950 }
1951 }
1952 if (bits_in_accum) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001953 assert(bits_in_accum <= PyLong_SHIFT);
Tim Petersbf2674b2003-02-02 07:51:32 +00001954 *pdigit++ = (digit)accum;
Mark Dickinson17e55872009-01-24 15:56:57 +00001955 assert(pdigit - z->ob_digit <= n);
Tim Petersbf2674b2003-02-02 07:51:32 +00001956 }
1957 while (pdigit - z->ob_digit < n)
1958 *pdigit++ = 0;
1959 return long_normalize(z);
1960}
1961
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001962PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00001963PyLong_FromString(char *str, char **pend, int base)
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001964{
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001965 int sign = 1, error_if_nonzero = 0;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001966 char *start, *orig_str = str;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001967 PyLongObject *z = NULL;
Guido van Rossum25236212007-08-22 23:28:23 +00001968 PyObject *strobj;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001969 Py_ssize_t slen;
Tim Peters5af4e6c2002-08-12 02:31:19 +00001970
Guido van Rossum472c04f1996-12-05 21:57:21 +00001971 if ((base != 0 && base < 2) || base > 36) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001972 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001973 "int() arg 2 must be >= 2 and <= 36");
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001974 return NULL;
1975 }
Guido van Rossum9fa2c111995-02-10 17:00:37 +00001976 while (*str != '\0' && isspace(Py_CHARMASK(*str)))
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00001977 str++;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001978 if (*str == '+')
1979 ++str;
1980 else if (*str == '-') {
1981 ++str;
1982 sign = -1;
1983 }
1984 if (base == 0) {
1985 if (str[0] != '0')
1986 base = 10;
1987 else if (str[1] == 'x' || str[1] == 'X')
1988 base = 16;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001989 else if (str[1] == 'o' || str[1] == 'O')
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001990 base = 8;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001991 else if (str[1] == 'b' || str[1] == 'B')
1992 base = 2;
1993 else {
1994 /* "old" (C-style) octal literal, now invalid.
1995 it might still be zero though */
1996 error_if_nonzero = 1;
1997 base = 10;
1998 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00001999 }
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002000 if (str[0] == '0' &&
2001 ((base == 16 && (str[1] == 'x' || str[1] == 'X')) ||
2002 (base == 8 && (str[1] == 'o' || str[1] == 'O')) ||
2003 (base == 2 && (str[1] == 'b' || str[1] == 'B'))))
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002004 str += 2;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002005
Guido van Rossume6762971998-06-22 03:54:46 +00002006 start = str;
Tim Petersbf2674b2003-02-02 07:51:32 +00002007 if ((base & (base - 1)) == 0)
2008 z = long_from_binary_base(&str, base);
2009 else {
Thomas Wouters477c8d52006-05-27 19:21:47 +00002010/***
2011Binary bases can be converted in time linear in the number of digits, because
2012Python's representation base is binary. Other bases (including decimal!) use
2013the simple quadratic-time algorithm below, complicated by some speed tricks.
Tim Peters5af4e6c2002-08-12 02:31:19 +00002014
Thomas Wouters477c8d52006-05-27 19:21:47 +00002015First some math: the largest integer that can be expressed in N base-B digits
2016is B**N-1. Consequently, if we have an N-digit input in base B, the worst-
2017case number of Python digits needed to hold it is the smallest integer n s.t.
2018
2019 BASE**n-1 >= B**N-1 [or, adding 1 to both sides]
2020 BASE**n >= B**N [taking logs to base BASE]
2021 n >= log(B**N)/log(BASE) = N * log(B)/log(BASE)
2022
2023The static array log_base_BASE[base] == log(base)/log(BASE) so we can compute
2024this quickly. A Python long with that much space is reserved near the start,
2025and the result is computed into it.
2026
2027The input string is actually treated as being in base base**i (i.e., i digits
2028are processed at a time), where two more static arrays hold:
2029
2030 convwidth_base[base] = the largest integer i such that base**i <= BASE
2031 convmultmax_base[base] = base ** convwidth_base[base]
2032
2033The first of these is the largest i such that i consecutive input digits
2034must fit in a single Python digit. The second is effectively the input
2035base we're really using.
2036
2037Viewing the input as a sequence <c0, c1, ..., c_n-1> of digits in base
2038convmultmax_base[base], the result is "simply"
2039
2040 (((c0*B + c1)*B + c2)*B + c3)*B + ... ))) + c_n-1
2041
2042where B = convmultmax_base[base].
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002043
2044Error analysis: as above, the number of Python digits `n` needed is worst-
2045case
2046
2047 n >= N * log(B)/log(BASE)
2048
2049where `N` is the number of input digits in base `B`. This is computed via
2050
2051 size_z = (Py_ssize_t)((scan - str) * log_base_BASE[base]) + 1;
2052
2053below. Two numeric concerns are how much space this can waste, and whether
2054the computed result can be too small. To be concrete, assume BASE = 2**15,
2055which is the default (and it's unlikely anyone changes that).
2056
2057Waste isn't a problem: provided the first input digit isn't 0, the difference
2058between the worst-case input with N digits and the smallest input with N
2059digits is about a factor of B, but B is small compared to BASE so at most
2060one allocated Python digit can remain unused on that count. If
2061N*log(B)/log(BASE) is mathematically an exact integer, then truncating that
2062and adding 1 returns a result 1 larger than necessary. However, that can't
2063happen: whenever B is a power of 2, long_from_binary_base() is called
2064instead, and it's impossible for B**i to be an integer power of 2**15 when
2065B is not a power of 2 (i.e., it's impossible for N*log(B)/log(BASE) to be
2066an exact integer when B is not a power of 2, since B**i has a prime factor
2067other than 2 in that case, but (2**15)**j's only prime factor is 2).
2068
2069The computed result can be too small if the true value of N*log(B)/log(BASE)
2070is a little bit larger than an exact integer, but due to roundoff errors (in
2071computing log(B), log(BASE), their quotient, and/or multiplying that by N)
2072yields a numeric result a little less than that integer. Unfortunately, "how
2073close can a transcendental function get to an integer over some range?"
2074questions are generally theoretically intractable. Computer analysis via
2075continued fractions is practical: expand log(B)/log(BASE) via continued
2076fractions, giving a sequence i/j of "the best" rational approximations. Then
2077j*log(B)/log(BASE) is approximately equal to (the integer) i. This shows that
2078we can get very close to being in trouble, but very rarely. For example,
207976573 is a denominator in one of the continued-fraction approximations to
2080log(10)/log(2**15), and indeed:
2081
2082 >>> log(10)/log(2**15)*76573
2083 16958.000000654003
2084
2085is very close to an integer. If we were working with IEEE single-precision,
2086rounding errors could kill us. Finding worst cases in IEEE double-precision
2087requires better-than-double-precision log() functions, and Tim didn't bother.
2088Instead the code checks to see whether the allocated space is enough as each
2089new Python digit is added, and copies the whole thing to a larger long if not.
2090This should happen extremely rarely, and in fact I don't have a test case
2091that triggers it(!). Instead the code was tested by artificially allocating
2092just 1 digit at the start, so that the copying code was exercised for every
2093digit beyond the first.
Thomas Wouters477c8d52006-05-27 19:21:47 +00002094***/
2095 register twodigits c; /* current input character */
2096 Py_ssize_t size_z;
2097 int i;
2098 int convwidth;
2099 twodigits convmultmax, convmult;
2100 digit *pz, *pzstop;
2101 char* scan;
2102
2103 static double log_base_BASE[37] = {0.0e0,};
2104 static int convwidth_base[37] = {0,};
2105 static twodigits convmultmax_base[37] = {0,};
2106
2107 if (log_base_BASE[base] == 0.0) {
2108 twodigits convmax = base;
2109 int i = 1;
2110
2111 log_base_BASE[base] = log((double)base) /
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002112 log((double)PyLong_BASE);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002113 for (;;) {
2114 twodigits next = convmax * base;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002115 if (next > PyLong_BASE)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002116 break;
2117 convmax = next;
2118 ++i;
2119 }
2120 convmultmax_base[base] = convmax;
2121 assert(i > 0);
2122 convwidth_base[base] = i;
2123 }
2124
2125 /* Find length of the string of numeric characters. */
2126 scan = str;
Christian Heimesbbe741d2008-03-28 10:53:29 +00002127 while (_PyLong_DigitValue[Py_CHARMASK(*scan)] < base)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002128 ++scan;
2129
2130 /* Create a long object that can contain the largest possible
2131 * integer with this base and length. Note that there's no
2132 * need to initialize z->ob_digit -- no slot is read up before
2133 * being stored into.
2134 */
2135 size_z = (Py_ssize_t)((scan - str) * log_base_BASE[base]) + 1;
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002136 /* Uncomment next line to test exceedingly rare copy code */
2137 /* size_z = 1; */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002138 assert(size_z > 0);
2139 z = _PyLong_New(size_z);
2140 if (z == NULL)
2141 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00002142 Py_SIZE(z) = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002143
2144 /* `convwidth` consecutive input digits are treated as a single
2145 * digit in base `convmultmax`.
2146 */
2147 convwidth = convwidth_base[base];
2148 convmultmax = convmultmax_base[base];
2149
2150 /* Work ;-) */
2151 while (str < scan) {
2152 /* grab up to convwidth digits from the input string */
Christian Heimesbbe741d2008-03-28 10:53:29 +00002153 c = (digit)_PyLong_DigitValue[Py_CHARMASK(*str++)];
Thomas Wouters477c8d52006-05-27 19:21:47 +00002154 for (i = 1; i < convwidth && str != scan; ++i, ++str) {
2155 c = (twodigits)(c * base +
Raymond Hettinger35631532009-01-09 03:58:09 +00002156 (int)_PyLong_DigitValue[Py_CHARMASK(*str)]);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002157 assert(c < PyLong_BASE);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002158 }
2159
2160 convmult = convmultmax;
2161 /* Calculate the shift only if we couldn't get
2162 * convwidth digits.
2163 */
2164 if (i != convwidth) {
2165 convmult = base;
2166 for ( ; i > 1; --i)
2167 convmult *= base;
2168 }
2169
2170 /* Multiply z by convmult, and add c. */
2171 pz = z->ob_digit;
Christian Heimes90aa7642007-12-19 02:45:37 +00002172 pzstop = pz + Py_SIZE(z);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002173 for (; pz < pzstop; ++pz) {
2174 c += (twodigits)*pz * convmult;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002175 *pz = (digit)(c & PyLong_MASK);
2176 c >>= PyLong_SHIFT;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002177 }
2178 /* carry off the current end? */
2179 if (c) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002180 assert(c < PyLong_BASE);
Christian Heimes90aa7642007-12-19 02:45:37 +00002181 if (Py_SIZE(z) < size_z) {
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002182 *pz = (digit)c;
Christian Heimes90aa7642007-12-19 02:45:37 +00002183 ++Py_SIZE(z);
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002184 }
2185 else {
2186 PyLongObject *tmp;
2187 /* Extremely rare. Get more space. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002188 assert(Py_SIZE(z) == size_z);
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002189 tmp = _PyLong_New(size_z + 1);
2190 if (tmp == NULL) {
2191 Py_DECREF(z);
2192 return NULL;
2193 }
2194 memcpy(tmp->ob_digit,
2195 z->ob_digit,
2196 sizeof(digit) * size_z);
2197 Py_DECREF(z);
2198 z = tmp;
2199 z->ob_digit[size_z] = (digit)c;
2200 ++size_z;
2201 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002202 }
Tim Petersbf2674b2003-02-02 07:51:32 +00002203 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002204 }
Guido van Rossumac6a37a1998-08-04 15:04:06 +00002205 if (z == NULL)
2206 return NULL;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002207 if (error_if_nonzero) {
2208 /* reset the base to 0, else the exception message
2209 doesn't make too much sense */
2210 base = 0;
Christian Heimes90aa7642007-12-19 02:45:37 +00002211 if (Py_SIZE(z) != 0)
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002212 goto onError;
2213 /* there might still be other problems, therefore base
2214 remains zero here for the same reason */
2215 }
Guido van Rossum9e896b32000-04-05 20:11:21 +00002216 if (str == start)
2217 goto onError;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002218 if (sign < 0)
Christian Heimes90aa7642007-12-19 02:45:37 +00002219 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossum9e896b32000-04-05 20:11:21 +00002220 while (*str && isspace(Py_CHARMASK(*str)))
2221 str++;
2222 if (*str != '\0')
2223 goto onError;
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002224 if (pend)
2225 *pend = str;
Martin v. Löwis029656f2008-06-30 04:06:08 +00002226 long_normalize(z);
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002227 return (PyObject *) maybe_small_long(z);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002228
2229 onError:
Guido van Rossum9e896b32000-04-05 20:11:21 +00002230 Py_XDECREF(z);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002231 slen = strlen(orig_str) < 200 ? strlen(orig_str) : 200;
Guido van Rossum25236212007-08-22 23:28:23 +00002232 strobj = PyUnicode_FromStringAndSize(orig_str, slen);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002233 if (strobj == NULL)
2234 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002235 PyErr_Format(PyExc_ValueError,
Guido van Rossum25236212007-08-22 23:28:23 +00002236 "invalid literal for int() with base %d: %R",
2237 base, strobj);
2238 Py_DECREF(strobj);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002239 return NULL;
2240}
2241
2242PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002243PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base)
Guido van Rossum9e896b32000-04-05 20:11:21 +00002244{
Walter Dörwald07e14762002-11-06 16:15:14 +00002245 PyObject *result;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002246 char *buffer = (char *)PyMem_MALLOC(length+1);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002247
Walter Dörwald07e14762002-11-06 16:15:14 +00002248 if (buffer == NULL)
2249 return NULL;
2250
2251 if (PyUnicode_EncodeDecimal(u, length, buffer, NULL)) {
2252 PyMem_FREE(buffer);
Guido van Rossum9e896b32000-04-05 20:11:21 +00002253 return NULL;
2254 }
Walter Dörwald07e14762002-11-06 16:15:14 +00002255 result = PyLong_FromString(buffer, NULL, base);
2256 PyMem_FREE(buffer);
2257 return result;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002258}
2259
Tim Peters9f688bf2000-07-07 15:53:28 +00002260/* forward */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002261static PyLongObject *x_divrem
Tim Peters9f688bf2000-07-07 15:53:28 +00002262 (PyLongObject *, PyLongObject *, PyLongObject **);
Guido van Rossumb43daf72007-08-01 18:08:08 +00002263static PyObject *long_long(PyObject *v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002264
2265/* Long division with remainder, top-level routine */
2266
Guido van Rossume32e0141992-01-19 16:31:05 +00002267static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002268long_divrem(PyLongObject *a, PyLongObject *b,
2269 PyLongObject **pdiv, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002270{
Christian Heimes90aa7642007-12-19 02:45:37 +00002271 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002272 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002273
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002274 if (size_b == 0) {
Guido van Rossumbd3a5271998-08-11 15:04:47 +00002275 PyErr_SetString(PyExc_ZeroDivisionError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00002276 "integer division or modulo by zero");
Guido van Rossume32e0141992-01-19 16:31:05 +00002277 return -1;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002278 }
2279 if (size_a < size_b ||
Guido van Rossum472c04f1996-12-05 21:57:21 +00002280 (size_a == size_b &&
2281 a->ob_digit[size_a-1] < b->ob_digit[size_b-1])) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002282 /* |a| < |b|. */
Guido van Rossumddefaf32007-01-14 03:31:43 +00002283 *pdiv = (PyLongObject*)PyLong_FromLong(0);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002284 if (*pdiv == NULL)
2285 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002286 Py_INCREF(a);
2287 *prem = (PyLongObject *) a;
Guido van Rossume32e0141992-01-19 16:31:05 +00002288 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002289 }
2290 if (size_b == 1) {
2291 digit rem = 0;
2292 z = divrem1(a, b->ob_digit[0], &rem);
Guido van Rossume32e0141992-01-19 16:31:05 +00002293 if (z == NULL)
2294 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002295 *prem = (PyLongObject *) PyLong_FromLong((long)rem);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002296 if (*prem == NULL) {
2297 Py_DECREF(z);
2298 return -1;
2299 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002300 }
Guido van Rossume32e0141992-01-19 16:31:05 +00002301 else {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002302 z = x_divrem(a, b, prem);
Guido van Rossume32e0141992-01-19 16:31:05 +00002303 if (z == NULL)
2304 return -1;
2305 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002306 /* Set the signs.
2307 The quotient z has the sign of a*b;
2308 the remainder r has the sign of a,
2309 so a = b*z + r. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002310 if ((Py_SIZE(a) < 0) != (Py_SIZE(b) < 0))
Guido van Rossumddefaf32007-01-14 03:31:43 +00002311 NEGATE(z);
Christian Heimes90aa7642007-12-19 02:45:37 +00002312 if (Py_SIZE(a) < 0 && Py_SIZE(*prem) != 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00002313 NEGATE(*prem);
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002314 *pdiv = maybe_small_long(z);
Guido van Rossume32e0141992-01-19 16:31:05 +00002315 return 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002316}
2317
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002318/* Unsigned long division with remainder -- the algorithm. The arguments v1
2319 and w1 should satisfy 2 <= ABS(Py_SIZE(w1)) <= ABS(Py_SIZE(v1)). */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002320
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002321static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002322x_divrem(PyLongObject *v1, PyLongObject *w1, PyLongObject **prem)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002323{
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002324 PyLongObject *v, *w, *a;
2325 Py_ssize_t i, k, size_v, size_w;
2326 int d;
2327 digit wm1, wm2, carry, q, r, vtop, *v0, *vk, *w0, *ak;
2328 twodigits vv;
2329 sdigit zhi;
2330 stwodigits z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002331
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002332 /* We follow Knuth [The Art of Computer Programming, Vol. 2 (3rd
2333 edn.), section 4.3.1, Algorithm D], except that we don't explicitly
2334 handle the special case when the initial estimate q for a quotient
2335 digit is >= PyLong_BASE: the max value for q is PyLong_BASE+1, and
2336 that won't overflow a digit. */
2337
2338 /* allocate space; w will also be used to hold the final remainder */
2339 size_v = ABS(Py_SIZE(v1));
2340 size_w = ABS(Py_SIZE(w1));
2341 assert(size_v >= size_w && size_w >= 2); /* Assert checks by div() */
2342 v = _PyLong_New(size_v+1);
2343 if (v == NULL) {
2344 *prem = NULL;
2345 return NULL;
2346 }
2347 w = _PyLong_New(size_w);
2348 if (w == NULL) {
2349 Py_DECREF(v);
2350 *prem = NULL;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002351 return NULL;
2352 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002353
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002354 /* normalize: shift w1 left so that its top digit is >= PyLong_BASE/2.
2355 shift v1 left by the same amount. Results go into w and v. */
2356 d = PyLong_SHIFT - bits_in_digit(w1->ob_digit[size_w-1]);
2357 carry = v_lshift(w->ob_digit, w1->ob_digit, size_w, d);
2358 assert(carry == 0);
2359 carry = v_lshift(v->ob_digit, v1->ob_digit, size_v, d);
2360 if (carry != 0 || v->ob_digit[size_v-1] >= w->ob_digit[size_w-1]) {
2361 v->ob_digit[size_v] = carry;
2362 size_v++;
2363 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002364
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002365 /* Now v->ob_digit[size_v-1] < w->ob_digit[size_w-1], so quotient has
2366 at most (and usually exactly) k = size_v - size_w digits. */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002367 k = size_v - size_w;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002368 assert(k >= 0);
2369 a = _PyLong_New(k);
2370 if (a == NULL) {
2371 Py_DECREF(w);
2372 Py_DECREF(v);
2373 *prem = NULL;
2374 return NULL;
2375 }
2376 v0 = v->ob_digit;
2377 w0 = w->ob_digit;
2378 wm1 = w0[size_w-1];
2379 wm2 = w0[size_w-2];
2380 for (vk = v0+k, ak = a->ob_digit + k; vk-- > v0;) {
2381 /* inner loop: divide vk[0:size_w+1] by w0[0:size_w], giving
2382 single-digit quotient q, remainder in vk[0:size_w]. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002383
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002384 SIGCHECK({
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002385 Py_DECREF(a);
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002386 Py_DECREF(w);
2387 Py_DECREF(v);
2388 *prem = NULL;
2389 return NULL;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00002390 })
Tim Peters5af4e6c2002-08-12 02:31:19 +00002391
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002392 /* estimate quotient digit q; may overestimate by 1 (rare) */
2393 vtop = vk[size_w];
2394 assert(vtop <= wm1);
2395 vv = ((twodigits)vtop << PyLong_SHIFT) | vk[size_w-1];
2396 q = (digit)(vv / wm1);
2397 r = (digit)(vv - (twodigits)wm1 * q); /* r = vv % wm1 */
2398 while ((twodigits)wm2 * q > (((twodigits)r << PyLong_SHIFT)
2399 | vk[size_w-2])) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002400 --q;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002401 r += wm1;
2402 if (r >= PyLong_BASE)
2403 break;
2404 }
2405 assert(q <= PyLong_BASE);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002406
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002407 /* subtract q*w0[0:size_w] from vk[0:size_w+1] */
2408 zhi = 0;
2409 for (i = 0; i < size_w; ++i) {
2410 /* invariants: -PyLong_BASE <= -q <= zhi <= 0;
2411 -PyLong_BASE * q <= z < PyLong_BASE */
2412 z = (sdigit)vk[i] + zhi -
2413 (stwodigits)q * (stwodigits)w0[i];
2414 vk[i] = (digit)z & PyLong_MASK;
2415 zhi = (sdigit)Py_ARITHMETIC_RIGHT_SHIFT(stwodigits,
2416 z, PyLong_SHIFT);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002417 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002418
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002419 /* add w back if q was too large (this branch taken rarely) */
2420 assert((sdigit)vtop + zhi == -1 || (sdigit)vtop + zhi == 0);
2421 if ((sdigit)vtop + zhi < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002422 carry = 0;
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002423 for (i = 0; i < size_w; ++i) {
2424 carry += vk[i] + w0[i];
2425 vk[i] = carry & PyLong_MASK;
2426 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002427 }
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002428 --q;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002429 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002430
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002431 /* store quotient digit */
2432 assert(q < PyLong_BASE);
2433 *--ak = q;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002434 }
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002435
2436 /* unshift remainder; we reuse w to store the result */
2437 carry = v_rshift(w0, v0, size_w, d);
2438 assert(carry==0);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002439 Py_DECREF(v);
Mark Dickinson17e4fdd2009-03-23 18:44:57 +00002440
2441 *prem = long_normalize(w);
2442 return long_normalize(a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002443}
2444
2445/* Methods */
2446
2447static void
Tim Peters9f688bf2000-07-07 15:53:28 +00002448long_dealloc(PyObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002449{
Christian Heimes90aa7642007-12-19 02:45:37 +00002450 Py_TYPE(v)->tp_free(v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002451}
2452
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002453static int
Tim Peters9f688bf2000-07-07 15:53:28 +00002454long_compare(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002455{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002456 Py_ssize_t sign;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002457
Christian Heimes90aa7642007-12-19 02:45:37 +00002458 if (Py_SIZE(a) != Py_SIZE(b)) {
2459 if (ABS(Py_SIZE(a)) == 0 && ABS(Py_SIZE(b)) == 0)
Guido van Rossumc6913e71991-11-19 20:26:46 +00002460 sign = 0;
2461 else
Christian Heimes90aa7642007-12-19 02:45:37 +00002462 sign = Py_SIZE(a) - Py_SIZE(b);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002463 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002464 else {
Christian Heimes90aa7642007-12-19 02:45:37 +00002465 Py_ssize_t i = ABS(Py_SIZE(a));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002466 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2467 ;
2468 if (i < 0)
2469 sign = 0;
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00002470 else {
Mark Dickinsone4416742009-02-15 15:14:57 +00002471 sign = (sdigit)a->ob_digit[i] - (sdigit)b->ob_digit[i];
Christian Heimes90aa7642007-12-19 02:45:37 +00002472 if (Py_SIZE(a) < 0)
Guido van Rossum0b0db8e1993-01-21 16:07:51 +00002473 sign = -sign;
2474 }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002475 }
Guido van Rossumc6913e71991-11-19 20:26:46 +00002476 return sign < 0 ? -1 : sign > 0 ? 1 : 0;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002477}
2478
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002479#define TEST_COND(cond) \
2480 ((cond) ? Py_True : Py_False)
2481
Guido van Rossum47b9ff62006-08-24 00:41:19 +00002482static PyObject *
2483long_richcompare(PyObject *self, PyObject *other, int op)
2484{
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002485 int result;
2486 PyObject *v;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002487 CHECK_BINOP(self, other);
Antoine Pitrou51f3ef92008-12-20 13:14:23 +00002488 if (self == other)
2489 result = 0;
2490 else
2491 result = long_compare((PyLongObject*)self, (PyLongObject*)other);
2492 /* Convert the return value to a Boolean */
2493 switch (op) {
2494 case Py_EQ:
2495 v = TEST_COND(result == 0);
2496 break;
2497 case Py_NE:
2498 v = TEST_COND(result != 0);
2499 break;
2500 case Py_LE:
2501 v = TEST_COND(result <= 0);
2502 break;
2503 case Py_GE:
2504 v = TEST_COND(result >= 0);
2505 break;
2506 case Py_LT:
2507 v = TEST_COND(result == -1);
2508 break;
2509 case Py_GT:
2510 v = TEST_COND(result == 1);
2511 break;
2512 default:
2513 PyErr_BadArgument();
2514 return NULL;
2515 }
2516 Py_INCREF(v);
2517 return v;
Guido van Rossum47b9ff62006-08-24 00:41:19 +00002518}
2519
Guido van Rossum9bfef441993-03-29 10:43:31 +00002520static long
Tim Peters9f688bf2000-07-07 15:53:28 +00002521long_hash(PyLongObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +00002522{
Mark Dickinsona5cafdf2009-01-26 21:56:07 +00002523 unsigned long x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002524 Py_ssize_t i;
2525 int sign;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002526
2527 /* This is designed so that Python ints and longs with the
2528 same value hash to the same value, otherwise comparisons
2529 of mapping keys will turn out weird */
Christian Heimes90aa7642007-12-19 02:45:37 +00002530 i = Py_SIZE(v);
Guido van Rossumddefaf32007-01-14 03:31:43 +00002531 switch(i) {
Mark Dickinson0d4785b2009-02-15 17:27:41 +00002532 case -1: return v->ob_digit[0]==1 ? -2 : -(sdigit)v->ob_digit[0];
Guido van Rossumddefaf32007-01-14 03:31:43 +00002533 case 0: return 0;
2534 case 1: return v->ob_digit[0];
2535 }
Guido van Rossum9bfef441993-03-29 10:43:31 +00002536 sign = 1;
2537 x = 0;
2538 if (i < 0) {
2539 sign = -1;
2540 i = -(i);
2541 }
Mark Dickinsona5cafdf2009-01-26 21:56:07 +00002542 /* The following loop produces a C unsigned long x such that x is
2543 congruent to the absolute value of v modulo ULONG_MAX. The
Thomas Woutersce272b62007-09-19 21:19:28 +00002544 resulting x is nonzero if and only if v is. */
Guido van Rossum9bfef441993-03-29 10:43:31 +00002545 while (--i >= 0) {
Neal Norwitzd5a65a72003-02-23 23:11:41 +00002546 /* Force a native long #-bits (32 or 64) circular shift */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00002547 x = (x >> (8*SIZEOF_LONG-PyLong_SHIFT)) | (x << PyLong_SHIFT);
Guido van Rossum9bfef441993-03-29 10:43:31 +00002548 x += v->ob_digit[i];
Mark Dickinsona5cafdf2009-01-26 21:56:07 +00002549 /* If the addition above overflowed we compensate by
2550 incrementing. This preserves the value modulo
2551 ULONG_MAX. */
2552 if (x < v->ob_digit[i])
Thomas Woutersce272b62007-09-19 21:19:28 +00002553 x++;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002554 }
2555 x = x * sign;
Mark Dickinson5a74bf62009-02-15 11:04:38 +00002556 if (x == (unsigned long)-1)
2557 x = (unsigned long)-2;
2558 return (long)x;
Guido van Rossum9bfef441993-03-29 10:43:31 +00002559}
2560
2561
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002562/* Add the absolute values of two long integers. */
2563
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002564static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002565x_add(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002566{
Christian Heimes90aa7642007-12-19 02:45:37 +00002567 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002568 PyLongObject *z;
Mark Dickinson17e55872009-01-24 15:56:57 +00002569 Py_ssize_t i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002570 digit carry = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002571
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002572 /* Ensure a is the larger of the two: */
2573 if (size_a < size_b) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002574 { PyLongObject *temp = a; a = b; b = temp; }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002575 { Py_ssize_t size_temp = size_a;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002576 size_a = size_b;
2577 size_b = size_temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002578 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002579 z = _PyLong_New(size_a+1);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002580 if (z == NULL)
2581 return NULL;
2582 for (i = 0; i < size_b; ++i) {
2583 carry += a->ob_digit[i] + b->ob_digit[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002584 z->ob_digit[i] = carry & PyLong_MASK;
2585 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002586 }
2587 for (; i < size_a; ++i) {
2588 carry += a->ob_digit[i];
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002589 z->ob_digit[i] = carry & PyLong_MASK;
2590 carry >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002591 }
2592 z->ob_digit[i] = carry;
2593 return long_normalize(z);
2594}
2595
2596/* Subtract the absolute values of two integers. */
2597
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002598static PyLongObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00002599x_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002600{
Christian Heimes90aa7642007-12-19 02:45:37 +00002601 Py_ssize_t size_a = ABS(Py_SIZE(a)), size_b = ABS(Py_SIZE(b));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002602 PyLongObject *z;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002603 Py_ssize_t i;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002604 int sign = 1;
2605 digit borrow = 0;
Tim Peters69c2de32001-09-11 22:31:33 +00002606
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002607 /* Ensure a is the larger of the two: */
2608 if (size_a < size_b) {
2609 sign = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002610 { PyLongObject *temp = a; a = b; b = temp; }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002611 { Py_ssize_t size_temp = size_a;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002612 size_a = size_b;
2613 size_b = size_temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002614 }
2615 else if (size_a == size_b) {
2616 /* Find highest digit where a and b differ: */
2617 i = size_a;
2618 while (--i >= 0 && a->ob_digit[i] == b->ob_digit[i])
2619 ;
2620 if (i < 0)
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002621 return (PyLongObject *)PyLong_FromLong(0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002622 if (a->ob_digit[i] < b->ob_digit[i]) {
2623 sign = -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002624 { PyLongObject *temp = a; a = b; b = temp; }
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002625 }
2626 size_a = size_b = i+1;
2627 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002628 z = _PyLong_New(size_a);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002629 if (z == NULL)
2630 return NULL;
2631 for (i = 0; i < size_b; ++i) {
2632 /* The following assumes unsigned arithmetic
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002633 works module 2**N for some N>PyLong_SHIFT. */
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00002634 borrow = a->ob_digit[i] - b->ob_digit[i] - borrow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002635 z->ob_digit[i] = borrow & PyLong_MASK;
2636 borrow >>= PyLong_SHIFT;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002637 borrow &= 1; /* Keep only one sign bit */
2638 }
2639 for (; i < size_a; ++i) {
2640 borrow = a->ob_digit[i] - borrow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002641 z->ob_digit[i] = borrow & PyLong_MASK;
2642 borrow >>= PyLong_SHIFT;
Tim Peters43f04a32000-07-08 02:26:47 +00002643 borrow &= 1; /* Keep only one sign bit */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002644 }
2645 assert(borrow == 0);
Guido van Rossumc6913e71991-11-19 20:26:46 +00002646 if (sign < 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00002647 NEGATE(z);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002648 return long_normalize(z);
2649}
2650
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002651static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002652long_add(PyLongObject *a, PyLongObject *b)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002653{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002654 PyLongObject *z;
Tim Peters69c2de32001-09-11 22:31:33 +00002655
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002656 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00002657
Christian Heimes90aa7642007-12-19 02:45:37 +00002658 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
Christian Heimes217cfd12007-12-02 14:31:20 +00002659 PyObject *result = PyLong_FromLong(MEDIUM_VALUE(a) +
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002660 MEDIUM_VALUE(b));
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002661 return result;
2662 }
Christian Heimes90aa7642007-12-19 02:45:37 +00002663 if (Py_SIZE(a) < 0) {
2664 if (Py_SIZE(b) < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002665 z = x_add(a, b);
Christian Heimes90aa7642007-12-19 02:45:37 +00002666 if (z != NULL && Py_SIZE(z) != 0)
2667 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002668 }
2669 else
2670 z = x_sub(b, a);
2671 }
2672 else {
Christian Heimes90aa7642007-12-19 02:45:37 +00002673 if (Py_SIZE(b) < 0)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002674 z = x_sub(a, b);
2675 else
2676 z = x_add(a, b);
2677 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002678 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002679}
2680
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002681static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002682long_sub(PyLongObject *a, PyLongObject *b)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00002683{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002684 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002685
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00002686 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00002687
Christian Heimes90aa7642007-12-19 02:45:37 +00002688 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002689 PyObject* r;
2690 r = PyLong_FromLong(MEDIUM_VALUE(a)-MEDIUM_VALUE(b));
Martin v. Löwis14b6d922007-02-06 21:05:30 +00002691 return r;
2692 }
Christian Heimes90aa7642007-12-19 02:45:37 +00002693 if (Py_SIZE(a) < 0) {
2694 if (Py_SIZE(b) < 0)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002695 z = x_sub(a, b);
2696 else
2697 z = x_add(a, b);
Christian Heimes90aa7642007-12-19 02:45:37 +00002698 if (z != NULL && Py_SIZE(z) != 0)
2699 Py_SIZE(z) = -(Py_SIZE(z));
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002700 }
2701 else {
Christian Heimes90aa7642007-12-19 02:45:37 +00002702 if (Py_SIZE(b) < 0)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002703 z = x_add(a, b);
2704 else
2705 z = x_sub(a, b);
2706 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002707 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002708}
2709
Tim Peters5af4e6c2002-08-12 02:31:19 +00002710/* Grade school multiplication, ignoring the signs.
2711 * Returns the absolute value of the product, or NULL if error.
2712 */
2713static PyLongObject *
2714x_mul(PyLongObject *a, PyLongObject *b)
Neil Schemenauerba872e22001-01-04 01:46:03 +00002715{
Tim Peters5af4e6c2002-08-12 02:31:19 +00002716 PyLongObject *z;
Christian Heimes90aa7642007-12-19 02:45:37 +00002717 Py_ssize_t size_a = ABS(Py_SIZE(a));
2718 Py_ssize_t size_b = ABS(Py_SIZE(b));
Martin v. Löwis18e16552006-02-15 17:27:45 +00002719 Py_ssize_t i;
Neil Schemenauerba872e22001-01-04 01:46:03 +00002720
Tim Peters5af4e6c2002-08-12 02:31:19 +00002721 z = _PyLong_New(size_a + size_b);
2722 if (z == NULL)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002723 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002724
Christian Heimes90aa7642007-12-19 02:45:37 +00002725 memset(z->ob_digit, 0, Py_SIZE(z) * sizeof(digit));
Tim Peters0973b992004-08-29 22:16:50 +00002726 if (a == b) {
2727 /* Efficient squaring per HAC, Algorithm 14.16:
2728 * http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf
2729 * Gives slightly less than a 2x speedup when a == b,
2730 * via exploiting that each entry in the multiplication
2731 * pyramid appears twice (except for the size_a squares).
2732 */
2733 for (i = 0; i < size_a; ++i) {
2734 twodigits carry;
2735 twodigits f = a->ob_digit[i];
2736 digit *pz = z->ob_digit + (i << 1);
2737 digit *pa = a->ob_digit + i + 1;
2738 digit *paend = a->ob_digit + size_a;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002739
Tim Peters0973b992004-08-29 22:16:50 +00002740 SIGCHECK({
2741 Py_DECREF(z);
2742 return NULL;
2743 })
2744
2745 carry = *pz + f * f;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002746 *pz++ = (digit)(carry & PyLong_MASK);
2747 carry >>= PyLong_SHIFT;
2748 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002749
2750 /* Now f is added in twice in each column of the
2751 * pyramid it appears. Same as adding f<<1 once.
2752 */
2753 f <<= 1;
2754 while (pa < paend) {
2755 carry += *pz + *pa++ * f;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002756 *pz++ = (digit)(carry & PyLong_MASK);
2757 carry >>= PyLong_SHIFT;
2758 assert(carry <= (PyLong_MASK << 1));
Tim Peters0973b992004-08-29 22:16:50 +00002759 }
2760 if (carry) {
2761 carry += *pz;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002762 *pz++ = (digit)(carry & PyLong_MASK);
2763 carry >>= PyLong_SHIFT;
Tim Peters0973b992004-08-29 22:16:50 +00002764 }
2765 if (carry)
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002766 *pz += (digit)(carry & PyLong_MASK);
2767 assert((carry >> PyLong_SHIFT) == 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002768 }
Tim Peters0973b992004-08-29 22:16:50 +00002769 }
2770 else { /* a is not the same as b -- gradeschool long mult */
2771 for (i = 0; i < size_a; ++i) {
2772 twodigits carry = 0;
2773 twodigits f = a->ob_digit[i];
2774 digit *pz = z->ob_digit + i;
2775 digit *pb = b->ob_digit;
2776 digit *pbend = b->ob_digit + size_b;
2777
2778 SIGCHECK({
2779 Py_DECREF(z);
2780 return NULL;
2781 })
2782
2783 while (pb < pbend) {
2784 carry += *pz + *pb++ * f;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002785 *pz++ = (digit)(carry & PyLong_MASK);
2786 carry >>= PyLong_SHIFT;
2787 assert(carry <= PyLong_MASK);
Tim Peters0973b992004-08-29 22:16:50 +00002788 }
2789 if (carry)
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002790 *pz += (digit)(carry & PyLong_MASK);
2791 assert((carry >> PyLong_SHIFT) == 0);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00002792 }
2793 }
Tim Peters44121a62002-08-12 06:17:58 +00002794 return long_normalize(z);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002795}
2796
2797/* A helper for Karatsuba multiplication (k_mul).
2798 Takes a long "n" and an integer "size" representing the place to
2799 split, and sets low and high such that abs(n) == (high << size) + low,
2800 viewing the shift as being by digits. The sign bit is ignored, and
2801 the return values are >= 0.
2802 Returns 0 on success, -1 on failure.
2803*/
2804static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002805kmul_split(PyLongObject *n, Py_ssize_t size, PyLongObject **high, PyLongObject **low)
Tim Peters5af4e6c2002-08-12 02:31:19 +00002806{
2807 PyLongObject *hi, *lo;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002808 Py_ssize_t size_lo, size_hi;
Christian Heimes90aa7642007-12-19 02:45:37 +00002809 const Py_ssize_t size_n = ABS(Py_SIZE(n));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002810
2811 size_lo = MIN(size_n, size);
2812 size_hi = size_n - size_lo;
2813
2814 if ((hi = _PyLong_New(size_hi)) == NULL)
2815 return -1;
2816 if ((lo = _PyLong_New(size_lo)) == NULL) {
2817 Py_DECREF(hi);
2818 return -1;
2819 }
2820
2821 memcpy(lo->ob_digit, n->ob_digit, size_lo * sizeof(digit));
2822 memcpy(hi->ob_digit, n->ob_digit + size_lo, size_hi * sizeof(digit));
2823
2824 *high = long_normalize(hi);
2825 *low = long_normalize(lo);
2826 return 0;
2827}
2828
Tim Peters60004642002-08-12 22:01:34 +00002829static PyLongObject *k_lopsided_mul(PyLongObject *a, PyLongObject *b);
2830
Tim Peters5af4e6c2002-08-12 02:31:19 +00002831/* Karatsuba multiplication. Ignores the input signs, and returns the
2832 * absolute value of the product (or NULL if error).
2833 * See Knuth Vol. 2 Chapter 4.3.3 (Pp. 294-295).
2834 */
2835static PyLongObject *
2836k_mul(PyLongObject *a, PyLongObject *b)
2837{
Christian Heimes90aa7642007-12-19 02:45:37 +00002838 Py_ssize_t asize = ABS(Py_SIZE(a));
2839 Py_ssize_t bsize = ABS(Py_SIZE(b));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002840 PyLongObject *ah = NULL;
2841 PyLongObject *al = NULL;
2842 PyLongObject *bh = NULL;
2843 PyLongObject *bl = NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002844 PyLongObject *ret = NULL;
Tim Peters738eda72002-08-12 15:08:20 +00002845 PyLongObject *t1, *t2, *t3;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002846 Py_ssize_t shift; /* the number of digits we split off */
2847 Py_ssize_t i;
Tim Peters738eda72002-08-12 15:08:20 +00002848
Tim Peters5af4e6c2002-08-12 02:31:19 +00002849 /* (ah*X+al)(bh*X+bl) = ah*bh*X*X + (ah*bl + al*bh)*X + al*bl
2850 * Let k = (ah+al)*(bh+bl) = ah*bl + al*bh + ah*bh + al*bl
2851 * Then the original product is
Tim Peters18c15b92002-08-12 02:43:58 +00002852 * ah*bh*X*X + (k - ah*bh - al*bl)*X + al*bl
Tim Peters5af4e6c2002-08-12 02:31:19 +00002853 * By picking X to be a power of 2, "*X" is just shifting, and it's
2854 * been reduced to 3 multiplies on numbers half the size.
2855 */
2856
Tim Petersfc07e562002-08-12 02:54:10 +00002857 /* We want to split based on the larger number; fiddle so that b
Tim Peters5af4e6c2002-08-12 02:31:19 +00002858 * is largest.
2859 */
Tim Peters738eda72002-08-12 15:08:20 +00002860 if (asize > bsize) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002861 t1 = a;
2862 a = b;
2863 b = t1;
Tim Peters738eda72002-08-12 15:08:20 +00002864
2865 i = asize;
2866 asize = bsize;
2867 bsize = i;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002868 }
2869
2870 /* Use gradeschool math when either number is too small. */
Tim Peters0973b992004-08-29 22:16:50 +00002871 i = a == b ? KARATSUBA_SQUARE_CUTOFF : KARATSUBA_CUTOFF;
2872 if (asize <= i) {
Tim Peters738eda72002-08-12 15:08:20 +00002873 if (asize == 0)
Facundo Batista6e6f59b2008-07-24 18:57:11 +00002874 return (PyLongObject *)PyLong_FromLong(0);
Tim Peters44121a62002-08-12 06:17:58 +00002875 else
2876 return x_mul(a, b);
2877 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00002878
Tim Peters60004642002-08-12 22:01:34 +00002879 /* If a is small compared to b, splitting on b gives a degenerate
2880 * case with ah==0, and Karatsuba may be (even much) less efficient
2881 * than "grade school" then. However, we can still win, by viewing
2882 * b as a string of "big digits", each of width a->ob_size. That
2883 * leads to a sequence of balanced calls to k_mul.
2884 */
2885 if (2 * asize <= bsize)
2886 return k_lopsided_mul(a, b);
2887
Tim Petersd6974a52002-08-13 20:37:51 +00002888 /* Split a & b into hi & lo pieces. */
Tim Peters738eda72002-08-12 15:08:20 +00002889 shift = bsize >> 1;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002890 if (kmul_split(a, shift, &ah, &al) < 0) goto fail;
Christian Heimes90aa7642007-12-19 02:45:37 +00002891 assert(Py_SIZE(ah) > 0); /* the split isn't degenerate */
Tim Petersd6974a52002-08-13 20:37:51 +00002892
Tim Peters0973b992004-08-29 22:16:50 +00002893 if (a == b) {
2894 bh = ah;
2895 bl = al;
2896 Py_INCREF(bh);
2897 Py_INCREF(bl);
2898 }
2899 else if (kmul_split(b, shift, &bh, &bl) < 0) goto fail;
Tim Peters5af4e6c2002-08-12 02:31:19 +00002900
Tim Petersd64c1de2002-08-12 17:36:03 +00002901 /* The plan:
2902 * 1. Allocate result space (asize + bsize digits: that's always
2903 * enough).
2904 * 2. Compute ah*bh, and copy into result at 2*shift.
2905 * 3. Compute al*bl, and copy into result at 0. Note that this
2906 * can't overlap with #2.
2907 * 4. Subtract al*bl from the result, starting at shift. This may
2908 * underflow (borrow out of the high digit), but we don't care:
2909 * we're effectively doing unsigned arithmetic mod
2910 * BASE**(sizea + sizeb), and so long as the *final* result fits,
2911 * borrows and carries out of the high digit can be ignored.
2912 * 5. Subtract ah*bh from the result, starting at shift.
2913 * 6. Compute (ah+al)*(bh+bl), and add it into the result starting
2914 * at shift.
2915 */
2916
2917 /* 1. Allocate result space. */
Tim Peters70b041b2002-08-12 19:38:01 +00002918 ret = _PyLong_New(asize + bsize);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002919 if (ret == NULL) goto fail;
2920#ifdef Py_DEBUG
2921 /* Fill with trash, to catch reference to uninitialized digits. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002922 memset(ret->ob_digit, 0xDF, Py_SIZE(ret) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002923#endif
Tim Peters44121a62002-08-12 06:17:58 +00002924
Tim Petersd64c1de2002-08-12 17:36:03 +00002925 /* 2. t1 <- ah*bh, and copy into high digits of result. */
Tim Peters738eda72002-08-12 15:08:20 +00002926 if ((t1 = k_mul(ah, bh)) == NULL) goto fail;
Christian Heimes90aa7642007-12-19 02:45:37 +00002927 assert(Py_SIZE(t1) >= 0);
2928 assert(2*shift + Py_SIZE(t1) <= Py_SIZE(ret));
Tim Peters738eda72002-08-12 15:08:20 +00002929 memcpy(ret->ob_digit + 2*shift, t1->ob_digit,
Christian Heimes90aa7642007-12-19 02:45:37 +00002930 Py_SIZE(t1) * sizeof(digit));
Tim Peters738eda72002-08-12 15:08:20 +00002931
2932 /* Zero-out the digits higher than the ah*bh copy. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002933 i = Py_SIZE(ret) - 2*shift - Py_SIZE(t1);
Tim Peters44121a62002-08-12 06:17:58 +00002934 if (i)
Christian Heimes90aa7642007-12-19 02:45:37 +00002935 memset(ret->ob_digit + 2*shift + Py_SIZE(t1), 0,
Tim Peters44121a62002-08-12 06:17:58 +00002936 i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002937
Tim Petersd64c1de2002-08-12 17:36:03 +00002938 /* 3. t2 <- al*bl, and copy into the low digits. */
Tim Peters738eda72002-08-12 15:08:20 +00002939 if ((t2 = k_mul(al, bl)) == NULL) {
2940 Py_DECREF(t1);
2941 goto fail;
2942 }
Christian Heimes90aa7642007-12-19 02:45:37 +00002943 assert(Py_SIZE(t2) >= 0);
2944 assert(Py_SIZE(t2) <= 2*shift); /* no overlap with high digits */
2945 memcpy(ret->ob_digit, t2->ob_digit, Py_SIZE(t2) * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002946
2947 /* Zero out remaining digits. */
Christian Heimes90aa7642007-12-19 02:45:37 +00002948 i = 2*shift - Py_SIZE(t2); /* number of uninitialized digits */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002949 if (i)
Christian Heimes90aa7642007-12-19 02:45:37 +00002950 memset(ret->ob_digit + Py_SIZE(t2), 0, i * sizeof(digit));
Tim Peters5af4e6c2002-08-12 02:31:19 +00002951
Tim Petersd64c1de2002-08-12 17:36:03 +00002952 /* 4 & 5. Subtract ah*bh (t1) and al*bl (t2). We do al*bl first
2953 * because it's fresher in cache.
2954 */
Christian Heimes90aa7642007-12-19 02:45:37 +00002955 i = Py_SIZE(ret) - shift; /* # digits after shift */
2956 (void)v_isub(ret->ob_digit + shift, i, t2->ob_digit, Py_SIZE(t2));
Tim Peters738eda72002-08-12 15:08:20 +00002957 Py_DECREF(t2);
2958
Christian Heimes90aa7642007-12-19 02:45:37 +00002959 (void)v_isub(ret->ob_digit + shift, i, t1->ob_digit, Py_SIZE(t1));
Tim Peters738eda72002-08-12 15:08:20 +00002960 Py_DECREF(t1);
2961
Tim Petersd64c1de2002-08-12 17:36:03 +00002962 /* 6. t3 <- (ah+al)(bh+bl), and add into result. */
Tim Peters5af4e6c2002-08-12 02:31:19 +00002963 if ((t1 = x_add(ah, al)) == NULL) goto fail;
2964 Py_DECREF(ah);
2965 Py_DECREF(al);
2966 ah = al = NULL;
2967
Tim Peters0973b992004-08-29 22:16:50 +00002968 if (a == b) {
2969 t2 = t1;
2970 Py_INCREF(t2);
2971 }
2972 else if ((t2 = x_add(bh, bl)) == NULL) {
Tim Peters5af4e6c2002-08-12 02:31:19 +00002973 Py_DECREF(t1);
2974 goto fail;
2975 }
2976 Py_DECREF(bh);
2977 Py_DECREF(bl);
2978 bh = bl = NULL;
2979
Tim Peters738eda72002-08-12 15:08:20 +00002980 t3 = k_mul(t1, t2);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002981 Py_DECREF(t1);
2982 Py_DECREF(t2);
Tim Peters738eda72002-08-12 15:08:20 +00002983 if (t3 == NULL) goto fail;
Christian Heimes90aa7642007-12-19 02:45:37 +00002984 assert(Py_SIZE(t3) >= 0);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002985
Tim Petersd6974a52002-08-13 20:37:51 +00002986 /* Add t3. It's not obvious why we can't run out of room here.
2987 * See the (*) comment after this function.
Tim Petersd8b21732002-08-12 19:30:26 +00002988 */
Christian Heimes90aa7642007-12-19 02:45:37 +00002989 (void)v_iadd(ret->ob_digit + shift, i, t3->ob_digit, Py_SIZE(t3));
Tim Peters738eda72002-08-12 15:08:20 +00002990 Py_DECREF(t3);
Tim Peters5af4e6c2002-08-12 02:31:19 +00002991
Tim Peters5af4e6c2002-08-12 02:31:19 +00002992 return long_normalize(ret);
2993
2994 fail:
2995 Py_XDECREF(ret);
2996 Py_XDECREF(ah);
2997 Py_XDECREF(al);
2998 Py_XDECREF(bh);
2999 Py_XDECREF(bl);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003000 return NULL;
3001}
3002
Tim Petersd6974a52002-08-13 20:37:51 +00003003/* (*) Why adding t3 can't "run out of room" above.
3004
Tim Petersab86c2b2002-08-15 20:06:00 +00003005Let f(x) mean the floor of x and c(x) mean the ceiling of x. Some facts
3006to start with:
Tim Petersd6974a52002-08-13 20:37:51 +00003007
Tim Petersab86c2b2002-08-15 20:06:00 +000030081. For any integer i, i = c(i/2) + f(i/2). In particular,
3009 bsize = c(bsize/2) + f(bsize/2).
30102. shift = f(bsize/2)
30113. asize <= bsize
30124. Since we call k_lopsided_mul if asize*2 <= bsize, asize*2 > bsize in this
3013 routine, so asize > bsize/2 >= f(bsize/2) in this routine.
Tim Petersd6974a52002-08-13 20:37:51 +00003014
Tim Petersab86c2b2002-08-15 20:06:00 +00003015We allocated asize + bsize result digits, and add t3 into them at an offset
3016of shift. This leaves asize+bsize-shift allocated digit positions for t3
3017to fit into, = (by #1 and #2) asize + f(bsize/2) + c(bsize/2) - f(bsize/2) =
3018asize + c(bsize/2) available digit positions.
Tim Petersd6974a52002-08-13 20:37:51 +00003019
Tim Petersab86c2b2002-08-15 20:06:00 +00003020bh has c(bsize/2) digits, and bl at most f(size/2) digits. So bh+hl has
3021at most c(bsize/2) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00003022
Tim Petersab86c2b2002-08-15 20:06:00 +00003023If asize == bsize, ah has c(bsize/2) digits, else ah has at most f(bsize/2)
3024digits, and al has at most f(bsize/2) digits in any case. So ah+al has at
3025most (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 1 bit.
Tim Petersd6974a52002-08-13 20:37:51 +00003026
Tim Petersab86c2b2002-08-15 20:06:00 +00003027The product (ah+al)*(bh+bl) therefore has at most
Tim Petersd6974a52002-08-13 20:37:51 +00003028
Tim Petersab86c2b2002-08-15 20:06:00 +00003029 c(bsize/2) + (asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits
Tim Petersd6974a52002-08-13 20:37:51 +00003030
Tim Petersab86c2b2002-08-15 20:06:00 +00003031and we have asize + c(bsize/2) available digit positions. We need to show
3032this is always enough. An instance of c(bsize/2) cancels out in both, so
3033the question reduces to whether asize digits is enough to hold
3034(asize == bsize ? c(bsize/2) : f(bsize/2)) digits + 2 bits. If asize < bsize,
3035then we're asking whether asize digits >= f(bsize/2) digits + 2 bits. By #4,
3036asize 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 +00003037digit is enough to hold 2 bits. This is so since PyLong_SHIFT=15 >= 2. If
Tim Petersab86c2b2002-08-15 20:06:00 +00003038asize == bsize, then we're asking whether bsize digits is enough to hold
Tim Peterse417de02002-08-15 20:10:45 +00003039c(bsize/2) digits + 2 bits, or equivalently (by #1) whether f(bsize/2) digits
3040is enough to hold 2 bits. This is so if bsize >= 2, which holds because
3041bsize >= KARATSUBA_CUTOFF >= 2.
Tim Peters8e966ee2002-08-14 16:36:23 +00003042
Tim Peters48d52c02002-08-14 17:07:32 +00003043Note that since there's always enough room for (ah+al)*(bh+bl), and that's
3044clearly >= each of ah*bh and al*bl, there's always enough room to subtract
3045ah*bh and al*bl too.
Tim Petersd6974a52002-08-13 20:37:51 +00003046*/
3047
Tim Peters60004642002-08-12 22:01:34 +00003048/* b has at least twice the digits of a, and a is big enough that Karatsuba
3049 * would pay off *if* the inputs had balanced sizes. View b as a sequence
3050 * of slices, each with a->ob_size digits, and multiply the slices by a,
3051 * one at a time. This gives k_mul balanced inputs to work with, and is
3052 * also cache-friendly (we compute one double-width slice of the result
3053 * at a time, then move on, never bactracking except for the helpful
3054 * single-width slice overlap between successive partial sums).
3055 */
3056static PyLongObject *
3057k_lopsided_mul(PyLongObject *a, PyLongObject *b)
3058{
Christian Heimes90aa7642007-12-19 02:45:37 +00003059 const Py_ssize_t asize = ABS(Py_SIZE(a));
3060 Py_ssize_t bsize = ABS(Py_SIZE(b));
Martin v. Löwis18e16552006-02-15 17:27:45 +00003061 Py_ssize_t nbdone; /* # of b digits already multiplied */
Tim Peters60004642002-08-12 22:01:34 +00003062 PyLongObject *ret;
3063 PyLongObject *bslice = NULL;
3064
3065 assert(asize > KARATSUBA_CUTOFF);
3066 assert(2 * asize <= bsize);
3067
3068 /* Allocate result space, and zero it out. */
3069 ret = _PyLong_New(asize + bsize);
3070 if (ret == NULL)
3071 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00003072 memset(ret->ob_digit, 0, Py_SIZE(ret) * sizeof(digit));
Tim Peters60004642002-08-12 22:01:34 +00003073
3074 /* Successive slices of b are copied into bslice. */
Tim Peters12034032002-08-12 22:10:00 +00003075 bslice = _PyLong_New(asize);
Tim Peters60004642002-08-12 22:01:34 +00003076 if (bslice == NULL)
3077 goto fail;
3078
3079 nbdone = 0;
3080 while (bsize > 0) {
3081 PyLongObject *product;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003082 const Py_ssize_t nbtouse = MIN(bsize, asize);
Tim Peters60004642002-08-12 22:01:34 +00003083
3084 /* Multiply the next slice of b by a. */
3085 memcpy(bslice->ob_digit, b->ob_digit + nbdone,
3086 nbtouse * sizeof(digit));
Christian Heimes90aa7642007-12-19 02:45:37 +00003087 Py_SIZE(bslice) = nbtouse;
Tim Peters60004642002-08-12 22:01:34 +00003088 product = k_mul(a, bslice);
3089 if (product == NULL)
3090 goto fail;
3091
3092 /* Add into result. */
Christian Heimes90aa7642007-12-19 02:45:37 +00003093 (void)v_iadd(ret->ob_digit + nbdone, Py_SIZE(ret) - nbdone,
3094 product->ob_digit, Py_SIZE(product));
Tim Peters60004642002-08-12 22:01:34 +00003095 Py_DECREF(product);
3096
3097 bsize -= nbtouse;
3098 nbdone += nbtouse;
3099 }
3100
3101 Py_DECREF(bslice);
3102 return long_normalize(ret);
3103
3104 fail:
3105 Py_DECREF(ret);
3106 Py_XDECREF(bslice);
3107 return NULL;
3108}
Tim Peters5af4e6c2002-08-12 02:31:19 +00003109
3110static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003111long_mul(PyLongObject *a, PyLongObject *b)
Tim Peters5af4e6c2002-08-12 02:31:19 +00003112{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003113 PyLongObject *z;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003114
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003115 CHECK_BINOP(a, b);
Tim Peters5af4e6c2002-08-12 02:31:19 +00003116
Mark Dickinsonbd792642009-03-18 20:06:12 +00003117 /* fast path for single-digit multiplication */
Christian Heimes90aa7642007-12-19 02:45:37 +00003118 if (ABS(Py_SIZE(a)) <= 1 && ABS(Py_SIZE(b)) <= 1) {
Mark Dickinsonbd792642009-03-18 20:06:12 +00003119 stwodigits v = (stwodigits)(MEDIUM_VALUE(a)) * MEDIUM_VALUE(b);
3120#ifdef HAVE_LONG_LONG
3121 return PyLong_FromLongLong((PY_LONG_LONG)v);
3122#else
3123 /* if we don't have long long then we're almost certainly
3124 using 15-bit digits, so v will fit in a long. In the
3125 unlikely event that we're using 30-bit digits on a platform
3126 without long long, a large v will just cause us to fall
3127 through to the general multiplication code below. */
3128 if (v >= LONG_MIN && v <= LONG_MAX)
3129 return PyLong_FromLong((long)v);
3130#endif
Martin v. Löwis14b6d922007-02-06 21:05:30 +00003131 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00003132
Tim Petersd64c1de2002-08-12 17:36:03 +00003133 z = k_mul(a, b);
Tim Peters9973d742002-08-15 19:41:06 +00003134 /* Negate if exactly one of the inputs is negative. */
Christian Heimes90aa7642007-12-19 02:45:37 +00003135 if (((Py_SIZE(a) ^ Py_SIZE(b)) < 0) && z)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003136 NEGATE(z);
Tim Peters9973d742002-08-15 19:41:06 +00003137 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003138}
3139
Guido van Rossume32e0141992-01-19 16:31:05 +00003140/* The / and % operators are now defined in terms of divmod().
3141 The expression a mod b has the value a - b*floor(a/b).
3142 The long_divrem function gives the remainder after division of
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003143 |a| by |b|, with the sign of a. This is also expressed
3144 as a - b*trunc(a/b), if trunc truncates towards zero.
3145 Some examples:
3146 a b a rem b a mod b
3147 13 10 3 3
3148 -13 10 -3 7
3149 13 -10 3 -7
3150 -13 -10 -3 -3
3151 So, to get from rem to mod, we have to add b if a and b
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003152 have different signs. We then subtract one from the 'div'
3153 part of the outcome to keep the invariant intact. */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003154
Tim Peters47e52ee2004-08-30 02:44:38 +00003155/* Compute
3156 * *pdiv, *pmod = divmod(v, w)
3157 * NULL can be passed for pdiv or pmod, in which case that part of
3158 * the result is simply thrown away. The caller owns a reference to
3159 * each of these it requests (does not pass NULL for).
3160 */
Guido van Rossume32e0141992-01-19 16:31:05 +00003161static int
Tim Peters5af4e6c2002-08-12 02:31:19 +00003162l_divmod(PyLongObject *v, PyLongObject *w,
Tim Peters9f688bf2000-07-07 15:53:28 +00003163 PyLongObject **pdiv, PyLongObject **pmod)
Guido van Rossume32e0141992-01-19 16:31:05 +00003164{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003165 PyLongObject *div, *mod;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003166
Guido van Rossume32e0141992-01-19 16:31:05 +00003167 if (long_divrem(v, w, &div, &mod) < 0)
3168 return -1;
Christian Heimes90aa7642007-12-19 02:45:37 +00003169 if ((Py_SIZE(mod) < 0 && Py_SIZE(w) > 0) ||
3170 (Py_SIZE(mod) > 0 && Py_SIZE(w) < 0)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003171 PyLongObject *temp;
3172 PyLongObject *one;
3173 temp = (PyLongObject *) long_add(mod, w);
3174 Py_DECREF(mod);
Guido van Rossume32e0141992-01-19 16:31:05 +00003175 mod = temp;
3176 if (mod == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003177 Py_DECREF(div);
Guido van Rossume32e0141992-01-19 16:31:05 +00003178 return -1;
3179 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003180 one = (PyLongObject *) PyLong_FromLong(1L);
Guido van Rossume32e0141992-01-19 16:31:05 +00003181 if (one == NULL ||
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003182 (temp = (PyLongObject *) long_sub(div, one)) == NULL) {
3183 Py_DECREF(mod);
3184 Py_DECREF(div);
3185 Py_XDECREF(one);
Guido van Rossume32e0141992-01-19 16:31:05 +00003186 return -1;
3187 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003188 Py_DECREF(one);
3189 Py_DECREF(div);
Guido van Rossume32e0141992-01-19 16:31:05 +00003190 div = temp;
3191 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003192 if (pdiv != NULL)
3193 *pdiv = div;
3194 else
3195 Py_DECREF(div);
3196
3197 if (pmod != NULL)
3198 *pmod = mod;
3199 else
3200 Py_DECREF(mod);
3201
Guido van Rossume32e0141992-01-19 16:31:05 +00003202 return 0;
3203}
3204
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003205static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003206long_div(PyObject *a, PyObject *b)
Guido van Rossume32e0141992-01-19 16:31:05 +00003207{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003208 PyLongObject *div;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003209
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003210 CHECK_BINOP(a, b);
3211 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, &div, NULL) < 0)
Tim Peters47e52ee2004-08-30 02:44:38 +00003212 div = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003213 return (PyObject *)div;
Guido van Rossume32e0141992-01-19 16:31:05 +00003214}
3215
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003216static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003217long_true_divide(PyObject *a, PyObject *b)
Tim Peters20dab9f2001-09-04 05:31:47 +00003218{
Tim Peterse2a60002001-09-04 06:17:36 +00003219 double ad, bd;
Thomas Wouters553489a2006-02-01 21:32:04 +00003220 int failed, aexp = -1, bexp = -1;
Tim Peterse2a60002001-09-04 06:17:36 +00003221
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003222 CHECK_BINOP(a, b);
Tim Peterse2a60002001-09-04 06:17:36 +00003223 ad = _PyLong_AsScaledDouble((PyObject *)a, &aexp);
3224 bd = _PyLong_AsScaledDouble((PyObject *)b, &bexp);
Tim Peters6f97e492001-11-04 23:09:40 +00003225 failed = (ad == -1.0 || bd == -1.0) && PyErr_Occurred();
Tim Peters6f97e492001-11-04 23:09:40 +00003226 if (failed)
Tim Peterse2a60002001-09-04 06:17:36 +00003227 return NULL;
Thomas Wouters553489a2006-02-01 21:32:04 +00003228 /* 'aexp' and 'bexp' were initialized to -1 to silence gcc-4.0.x,
3229 but should really be set correctly after sucessful calls to
3230 _PyLong_AsScaledDouble() */
3231 assert(aexp >= 0 && bexp >= 0);
Tim Peterse2a60002001-09-04 06:17:36 +00003232
3233 if (bd == 0.0) {
3234 PyErr_SetString(PyExc_ZeroDivisionError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00003235 "int division or modulo by zero");
Tim Peterse2a60002001-09-04 06:17:36 +00003236 return NULL;
3237 }
3238
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003239 /* True value is very close to ad/bd * 2**(PyLong_SHIFT*(aexp-bexp)) */
Tim Peterse2a60002001-09-04 06:17:36 +00003240 ad /= bd; /* overflow/underflow impossible here */
3241 aexp -= bexp;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003242 if (aexp > INT_MAX / PyLong_SHIFT)
Tim Peterse2a60002001-09-04 06:17:36 +00003243 goto overflow;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003244 else if (aexp < -(INT_MAX / PyLong_SHIFT))
Tim Peterse56ed9b2001-09-06 21:59:14 +00003245 return PyFloat_FromDouble(0.0); /* underflow to 0 */
Tim Peterse2a60002001-09-04 06:17:36 +00003246 errno = 0;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003247 ad = ldexp(ad, aexp * PyLong_SHIFT);
Tim Peters57f282a2001-09-05 05:38:10 +00003248 if (Py_OVERFLOWED(ad)) /* ignore underflow to 0.0 */
Tim Peterse2a60002001-09-04 06:17:36 +00003249 goto overflow;
3250 return PyFloat_FromDouble(ad);
3251
3252overflow:
3253 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00003254 "int/int too large for a float");
Tim Peterse2a60002001-09-04 06:17:36 +00003255 return NULL;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003256
Tim Peters20dab9f2001-09-04 05:31:47 +00003257}
3258
3259static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003260long_mod(PyObject *a, PyObject *b)
Guido van Rossume32e0141992-01-19 16:31:05 +00003261{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003262 PyLongObject *mod;
3263
3264 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003265
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003266 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, NULL, &mod) < 0)
Tim Peters47e52ee2004-08-30 02:44:38 +00003267 mod = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003268 return (PyObject *)mod;
Guido van Rossume32e0141992-01-19 16:31:05 +00003269}
3270
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003271static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003272long_divmod(PyObject *a, PyObject *b)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003273{
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003274 PyLongObject *div, *mod;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003275 PyObject *z;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003276
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003277 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003278
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003279 if (l_divmod((PyLongObject*)a, (PyLongObject*)b, &div, &mod) < 0) {
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003280 return NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003281 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003282 z = PyTuple_New(2);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003283 if (z != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003284 PyTuple_SetItem(z, 0, (PyObject *) div);
3285 PyTuple_SetItem(z, 1, (PyObject *) mod);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003286 }
3287 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003288 Py_DECREF(div);
3289 Py_DECREF(mod);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003290 }
3291 return z;
3292}
3293
Tim Peters47e52ee2004-08-30 02:44:38 +00003294/* pow(v, w, x) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003295static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003296long_pow(PyObject *v, PyObject *w, PyObject *x)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003297{
Tim Peters47e52ee2004-08-30 02:44:38 +00003298 PyLongObject *a, *b, *c; /* a,b,c = v,w,x */
3299 int negativeOutput = 0; /* if x<0 return negative output */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003300
Tim Peters47e52ee2004-08-30 02:44:38 +00003301 PyLongObject *z = NULL; /* accumulated result */
Martin v. Löwis18e16552006-02-15 17:27:45 +00003302 Py_ssize_t i, j, k; /* counters */
Tim Peters47e52ee2004-08-30 02:44:38 +00003303 PyLongObject *temp = NULL;
3304
3305 /* 5-ary values. If the exponent is large enough, table is
3306 * precomputed so that table[i] == a**i % c for i in range(32).
3307 */
3308 PyLongObject *table[32] = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
3309 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0};
3310
3311 /* a, b, c = v, w, x */
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003312 CHECK_BINOP(v, w);
3313 a = (PyLongObject*)v; Py_INCREF(a);
3314 b = (PyLongObject*)w; Py_INCREF(b);
Tim Peters47e52ee2004-08-30 02:44:38 +00003315 if (PyLong_Check(x)) {
3316 c = (PyLongObject *)x;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003317 Py_INCREF(x);
3318 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003319 else if (x == Py_None)
3320 c = NULL;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003321 else {
3322 Py_DECREF(a);
3323 Py_DECREF(b);
3324 Py_INCREF(Py_NotImplemented);
3325 return Py_NotImplemented;
3326 }
Tim Peters4c483c42001-09-05 06:24:58 +00003327
Christian Heimes90aa7642007-12-19 02:45:37 +00003328 if (Py_SIZE(b) < 0) { /* if exponent is negative */
Tim Peters47e52ee2004-08-30 02:44:38 +00003329 if (c) {
Tim Peters4c483c42001-09-05 06:24:58 +00003330 PyErr_SetString(PyExc_TypeError, "pow() 2nd argument "
Tim Peters47e52ee2004-08-30 02:44:38 +00003331 "cannot be negative when 3rd argument specified");
Tim Peterscd97da32004-08-30 02:58:59 +00003332 goto Error;
Tim Peters32f453e2001-09-03 08:35:41 +00003333 }
Guido van Rossum2c7b8fe1999-10-11 22:34:41 +00003334 else {
Tim Peters47e52ee2004-08-30 02:44:38 +00003335 /* else return a float. This works because we know
3336 that this calls float_pow() which converts its
3337 arguments to double. */
3338 Py_DECREF(a);
3339 Py_DECREF(b);
3340 return PyFloat_Type.tp_as_number->nb_power(v, w, x);
Guido van Rossum2c7b8fe1999-10-11 22:34:41 +00003341 }
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00003342 }
Tim Peters47e52ee2004-08-30 02:44:38 +00003343
3344 if (c) {
3345 /* if modulus == 0:
3346 raise ValueError() */
Christian Heimes90aa7642007-12-19 02:45:37 +00003347 if (Py_SIZE(c) == 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003348 PyErr_SetString(PyExc_ValueError,
3349 "pow() 3rd argument cannot be 0");
Tim Peterscd97da32004-08-30 02:58:59 +00003350 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00003351 }
3352
3353 /* if modulus < 0:
3354 negativeOutput = True
3355 modulus = -modulus */
Christian Heimes90aa7642007-12-19 02:45:37 +00003356 if (Py_SIZE(c) < 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003357 negativeOutput = 1;
3358 temp = (PyLongObject *)_PyLong_Copy(c);
3359 if (temp == NULL)
3360 goto Error;
3361 Py_DECREF(c);
3362 c = temp;
3363 temp = NULL;
Guido van Rossumddefaf32007-01-14 03:31:43 +00003364 NEGATE(c);
Tim Peters47e52ee2004-08-30 02:44:38 +00003365 }
3366
3367 /* if modulus == 1:
3368 return 0 */
Christian Heimes90aa7642007-12-19 02:45:37 +00003369 if ((Py_SIZE(c) == 1) && (c->ob_digit[0] == 1)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003370 z = (PyLongObject *)PyLong_FromLong(0L);
3371 goto Done;
3372 }
3373
3374 /* if base < 0:
3375 base = base % modulus
3376 Having the base positive just makes things easier. */
Christian Heimes90aa7642007-12-19 02:45:37 +00003377 if (Py_SIZE(a) < 0) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003378 if (l_divmod(a, c, NULL, &temp) < 0)
Tim Peterscd97da32004-08-30 02:58:59 +00003379 goto Error;
Tim Peters47e52ee2004-08-30 02:44:38 +00003380 Py_DECREF(a);
3381 a = temp;
3382 temp = NULL;
3383 }
3384 }
3385
3386 /* At this point a, b, and c are guaranteed non-negative UNLESS
3387 c is NULL, in which case a may be negative. */
3388
3389 z = (PyLongObject *)PyLong_FromLong(1L);
3390 if (z == NULL)
3391 goto Error;
3392
3393 /* Perform a modular reduction, X = X % c, but leave X alone if c
3394 * is NULL.
3395 */
3396#define REDUCE(X) \
3397 if (c != NULL) { \
3398 if (l_divmod(X, c, NULL, &temp) < 0) \
3399 goto Error; \
3400 Py_XDECREF(X); \
3401 X = temp; \
3402 temp = NULL; \
3403 }
3404
3405 /* Multiply two values, then reduce the result:
3406 result = X*Y % c. If c is NULL, skip the mod. */
3407#define MULT(X, Y, result) \
3408{ \
3409 temp = (PyLongObject *)long_mul(X, Y); \
3410 if (temp == NULL) \
3411 goto Error; \
3412 Py_XDECREF(result); \
3413 result = temp; \
3414 temp = NULL; \
3415 REDUCE(result) \
3416}
3417
Christian Heimes90aa7642007-12-19 02:45:37 +00003418 if (Py_SIZE(b) <= FIVEARY_CUTOFF) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003419 /* Left-to-right binary exponentiation (HAC Algorithm 14.79) */
3420 /* http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf */
Christian Heimes90aa7642007-12-19 02:45:37 +00003421 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003422 digit bi = b->ob_digit[i];
3423
Mark Dickinsone4416742009-02-15 15:14:57 +00003424 for (j = (digit)1 << (PyLong_SHIFT-1); j != 0; j >>= 1) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003425 MULT(z, z, z)
3426 if (bi & j)
3427 MULT(z, a, z)
3428 }
3429 }
3430 }
3431 else {
3432 /* Left-to-right 5-ary exponentiation (HAC Algorithm 14.82) */
3433 Py_INCREF(z); /* still holds 1L */
3434 table[0] = z;
3435 for (i = 1; i < 32; ++i)
3436 MULT(table[i-1], a, table[i])
3437
Christian Heimes90aa7642007-12-19 02:45:37 +00003438 for (i = Py_SIZE(b) - 1; i >= 0; --i) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003439 const digit bi = b->ob_digit[i];
3440
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003441 for (j = PyLong_SHIFT - 5; j >= 0; j -= 5) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003442 const int index = (bi >> j) & 0x1f;
3443 for (k = 0; k < 5; ++k)
3444 MULT(z, z, z)
3445 if (index)
3446 MULT(z, table[index], z)
3447 }
3448 }
3449 }
3450
Christian Heimes90aa7642007-12-19 02:45:37 +00003451 if (negativeOutput && (Py_SIZE(z) != 0)) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003452 temp = (PyLongObject *)long_sub(z, c);
3453 if (temp == NULL)
3454 goto Error;
3455 Py_DECREF(z);
3456 z = temp;
3457 temp = NULL;
3458 }
3459 goto Done;
3460
3461 Error:
3462 if (z != NULL) {
3463 Py_DECREF(z);
3464 z = NULL;
3465 }
3466 /* fall through */
3467 Done:
Christian Heimes90aa7642007-12-19 02:45:37 +00003468 if (Py_SIZE(b) > FIVEARY_CUTOFF) {
Tim Peters47e52ee2004-08-30 02:44:38 +00003469 for (i = 0; i < 32; ++i)
3470 Py_XDECREF(table[i]);
3471 }
Tim Petersde7990b2005-07-17 23:45:23 +00003472 Py_DECREF(a);
3473 Py_DECREF(b);
3474 Py_XDECREF(c);
3475 Py_XDECREF(temp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003476 return (PyObject *)z;
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003477}
3478
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003479static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003480long_invert(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003481{
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003482 /* Implement ~x as -(x+1) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003483 PyLongObject *x;
3484 PyLongObject *w;
Christian Heimes90aa7642007-12-19 02:45:37 +00003485 if (ABS(Py_SIZE(v)) <=1)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003486 return PyLong_FromLong(-(MEDIUM_VALUE(v)+1));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003487 w = (PyLongObject *)PyLong_FromLong(1L);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003488 if (w == NULL)
3489 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003490 x = (PyLongObject *) long_add(v, w);
3491 Py_DECREF(w);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003492 if (x == NULL)
3493 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00003494 Py_SIZE(x) = -(Py_SIZE(x));
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003495 return (PyObject *)maybe_small_long(x);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003496}
3497
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003498static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003499long_neg(PyLongObject *v)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003500{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003501 PyLongObject *z;
Christian Heimes90aa7642007-12-19 02:45:37 +00003502 if (ABS(Py_SIZE(v)) <= 1)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003503 return PyLong_FromLong(-MEDIUM_VALUE(v));
Tim Peters69c2de32001-09-11 22:31:33 +00003504 z = (PyLongObject *)_PyLong_Copy(v);
3505 if (z != NULL)
Christian Heimes90aa7642007-12-19 02:45:37 +00003506 Py_SIZE(z) = -(Py_SIZE(v));
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003507 return (PyObject *)z;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003508}
3509
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003510static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003511long_abs(PyLongObject *v)
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003512{
Christian Heimes90aa7642007-12-19 02:45:37 +00003513 if (Py_SIZE(v) < 0)
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003514 return long_neg(v);
Tim Peters69c2de32001-09-11 22:31:33 +00003515 else
Guido van Rossumb43daf72007-08-01 18:08:08 +00003516 return long_long((PyObject *)v);
Guido van Rossumedcc38a1991-05-05 20:09:44 +00003517}
3518
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003519static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00003520long_bool(PyLongObject *v)
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003521{
Christian Heimes90aa7642007-12-19 02:45:37 +00003522 return ABS(Py_SIZE(v)) != 0;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003523}
3524
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003525static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003526long_rshift(PyLongObject *a, PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003527{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003528 PyLongObject *z = NULL;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003529 long shiftby;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003530 Py_ssize_t newsize, wordshift, loshift, hishift, i, j;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003531 digit lomask, himask;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003532
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003533 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003534
Christian Heimes90aa7642007-12-19 02:45:37 +00003535 if (Py_SIZE(a) < 0) {
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003536 /* Right shifting negative numbers is harder */
Neil Schemenauerba872e22001-01-04 01:46:03 +00003537 PyLongObject *a1, *a2;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003538 a1 = (PyLongObject *) long_invert(a);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003539 if (a1 == NULL)
3540 goto rshift_error;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003541 a2 = (PyLongObject *) long_rshift(a1, b);
3542 Py_DECREF(a1);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003543 if (a2 == NULL)
3544 goto rshift_error;
3545 z = (PyLongObject *) long_invert(a2);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003546 Py_DECREF(a2);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003547 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003548 else {
Tim Peters5af4e6c2002-08-12 02:31:19 +00003549
Neil Schemenauerba872e22001-01-04 01:46:03 +00003550 shiftby = PyLong_AsLong((PyObject *)b);
3551 if (shiftby == -1L && PyErr_Occurred())
3552 goto rshift_error;
3553 if (shiftby < 0) {
3554 PyErr_SetString(PyExc_ValueError,
3555 "negative shift count");
3556 goto rshift_error;
3557 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003558 wordshift = shiftby / PyLong_SHIFT;
Christian Heimes90aa7642007-12-19 02:45:37 +00003559 newsize = ABS(Py_SIZE(a)) - wordshift;
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003560 if (newsize <= 0)
3561 return PyLong_FromLong(0);
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003562 loshift = shiftby % PyLong_SHIFT;
3563 hishift = PyLong_SHIFT - loshift;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003564 lomask = ((digit)1 << hishift) - 1;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003565 himask = PyLong_MASK ^ lomask;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003566 z = _PyLong_New(newsize);
3567 if (z == NULL)
3568 goto rshift_error;
Christian Heimes90aa7642007-12-19 02:45:37 +00003569 if (Py_SIZE(a) < 0)
3570 Py_SIZE(z) = -(Py_SIZE(z));
Neil Schemenauerba872e22001-01-04 01:46:03 +00003571 for (i = 0, j = wordshift; i < newsize; i++, j++) {
3572 z->ob_digit[i] = (a->ob_digit[j] >> loshift) & lomask;
3573 if (i+1 < newsize)
3574 z->ob_digit[i] |=
3575 (a->ob_digit[j+1] << hishift) & himask;
3576 }
3577 z = long_normalize(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003578 }
Neil Schemenauerba872e22001-01-04 01:46:03 +00003579rshift_error:
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003580 return (PyObject *) maybe_small_long(z);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003581
Guido van Rossumc6913e71991-11-19 20:26:46 +00003582}
3583
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003584static PyObject *
Neil Schemenauerba872e22001-01-04 01:46:03 +00003585long_lshift(PyObject *v, PyObject *w)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003586{
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003587 /* This version due to Tim Peters */
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003588 PyLongObject *a = (PyLongObject*)v;
3589 PyLongObject *b = (PyLongObject*)w;
Neil Schemenauerba872e22001-01-04 01:46:03 +00003590 PyLongObject *z = NULL;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003591 long shiftby;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003592 Py_ssize_t oldsize, newsize, wordshift, remshift, i, j;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003593 twodigits accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003594
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003595 CHECK_BINOP(a, b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003596
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003597 shiftby = PyLong_AsLong((PyObject *)b);
3598 if (shiftby == -1L && PyErr_Occurred())
Neil Schemenauerba872e22001-01-04 01:46:03 +00003599 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003600 if (shiftby < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003601 PyErr_SetString(PyExc_ValueError, "negative shift count");
Neil Schemenauerba872e22001-01-04 01:46:03 +00003602 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003603 }
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003604 if ((long)(int)shiftby != shiftby) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003605 PyErr_SetString(PyExc_ValueError,
3606 "outrageous left shift count");
Neil Schemenauerba872e22001-01-04 01:46:03 +00003607 goto lshift_error;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003608 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003609 /* wordshift, remshift = divmod(shiftby, PyLong_SHIFT) */
3610 wordshift = (int)shiftby / PyLong_SHIFT;
3611 remshift = (int)shiftby - wordshift * PyLong_SHIFT;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003612
Christian Heimes90aa7642007-12-19 02:45:37 +00003613 oldsize = ABS(Py_SIZE(a));
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003614 newsize = oldsize + wordshift;
3615 if (remshift)
3616 ++newsize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003617 z = _PyLong_New(newsize);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003618 if (z == NULL)
Neil Schemenauerba872e22001-01-04 01:46:03 +00003619 goto lshift_error;
Christian Heimes90aa7642007-12-19 02:45:37 +00003620 if (Py_SIZE(a) < 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00003621 NEGATE(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003622 for (i = 0; i < wordshift; i++)
3623 z->ob_digit[i] = 0;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003624 accum = 0;
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003625 for (i = wordshift, j = 0; j < oldsize; i++, j++) {
Tim Peters0d2d87d2002-08-20 19:00:22 +00003626 accum |= (twodigits)a->ob_digit[j] << remshift;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003627 z->ob_digit[i] = (digit)(accum & PyLong_MASK);
3628 accum >>= PyLong_SHIFT;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003629 }
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003630 if (remshift)
3631 z->ob_digit[newsize-1] = (digit)accum;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003632 else
Guido van Rossumf2e499b1997-03-16 00:37:59 +00003633 assert(!accum);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003634 z = long_normalize(z);
3635lshift_error:
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003636 return (PyObject *) maybe_small_long(z);
Guido van Rossumc6913e71991-11-19 20:26:46 +00003637}
3638
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003639
3640/* Bitwise and/xor/or operations */
3641
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003642static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003643long_bitwise(PyLongObject *a,
3644 int op, /* '&', '|', '^' */
3645 PyLongObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003646{
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003647 digit maska, maskb; /* 0 or PyLong_MASK */
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003648 int negz;
Mark Dickinsone4416742009-02-15 15:14:57 +00003649 Py_ssize_t size_a, size_b, size_z, i;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003650 PyLongObject *z;
Guido van Rossum8b27d921992-03-27 17:27:05 +00003651 digit diga, digb;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003652 PyObject *v;
Tim Peters5af4e6c2002-08-12 02:31:19 +00003653
Christian Heimes90aa7642007-12-19 02:45:37 +00003654 if (Py_SIZE(a) < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003655 a = (PyLongObject *) long_invert(a);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003656 if (a == NULL)
3657 return NULL;
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003658 maska = PyLong_MASK;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003659 }
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003660 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003661 Py_INCREF(a);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003662 maska = 0;
Guido van Rossumafbb8db1991-12-31 13:14:13 +00003663 }
Christian Heimes90aa7642007-12-19 02:45:37 +00003664 if (Py_SIZE(b) < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003665 b = (PyLongObject *) long_invert(b);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003666 if (b == NULL) {
3667 Py_DECREF(a);
3668 return NULL;
3669 }
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003670 maskb = PyLong_MASK;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003671 }
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003672 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003673 Py_INCREF(b);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003674 maskb = 0;
3675 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003676
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003677 negz = 0;
3678 switch (op) {
3679 case '^':
3680 if (maska != maskb) {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003681 maska ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003682 negz = -1;
3683 }
3684 break;
Guido van Rossumeb1fafc1994-08-29 12:47:19 +00003685 case '&':
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003686 if (maska && maskb) {
3687 op = '|';
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003688 maska ^= PyLong_MASK;
3689 maskb ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003690 negz = -1;
3691 }
3692 break;
3693 case '|':
3694 if (maska || maskb) {
3695 op = '&';
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003696 maska ^= PyLong_MASK;
3697 maskb ^= PyLong_MASK;
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003698 negz = -1;
3699 }
3700 break;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003701 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003702
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003703 /* JRH: The original logic here was to allocate the result value (z)
3704 as the longer of the two operands. However, there are some cases
3705 where the result is guaranteed to be shorter than that: AND of two
3706 positives, OR of two negatives: use the shorter number. AND with
3707 mixed signs: use the positive number. OR with mixed signs: use the
3708 negative number. After the transformations above, op will be '&'
3709 iff one of these cases applies, and mask will be non-0 for operands
3710 whose length should be ignored.
3711 */
3712
Christian Heimes90aa7642007-12-19 02:45:37 +00003713 size_a = Py_SIZE(a);
3714 size_b = Py_SIZE(b);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003715 size_z = op == '&'
3716 ? (maska
3717 ? size_b
3718 : (maskb ? size_a : MIN(size_a, size_b)))
3719 : MAX(size_a, size_b);
3720 z = _PyLong_New(size_z);
Hye-Shik Chang4af5c8c2006-03-07 15:39:21 +00003721 if (z == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003722 Py_DECREF(a);
3723 Py_DECREF(b);
Guido van Rossumbd3a5271998-08-11 15:04:47 +00003724 return NULL;
3725 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003726
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003727 for (i = 0; i < size_z; ++i) {
3728 diga = (i < size_a ? a->ob_digit[i] : 0) ^ maska;
3729 digb = (i < size_b ? b->ob_digit[i] : 0) ^ maskb;
3730 switch (op) {
3731 case '&': z->ob_digit[i] = diga & digb; break;
3732 case '|': z->ob_digit[i] = diga | digb; break;
3733 case '^': z->ob_digit[i] = diga ^ digb; break;
3734 }
Guido van Rossumafbb8db1991-12-31 13:14:13 +00003735 }
Tim Peters5af4e6c2002-08-12 02:31:19 +00003736
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003737 Py_DECREF(a);
3738 Py_DECREF(b);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003739 z = long_normalize(z);
3740 if (negz == 0)
Facundo Batista6e6f59b2008-07-24 18:57:11 +00003741 return (PyObject *) maybe_small_long(z);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003742 v = long_invert(z);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003743 Py_DECREF(z);
Guido van Rossum4c260ff1992-01-14 18:36:43 +00003744 return v;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003745}
3746
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003747static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003748long_and(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003749{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003750 PyObject *c;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003751 CHECK_BINOP(a, b);
3752 c = long_bitwise((PyLongObject*)a, '&', (PyLongObject*)b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003753 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003754}
3755
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003756static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003757long_xor(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003758{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003759 PyObject *c;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003760 CHECK_BINOP(a, b);
3761 c = long_bitwise((PyLongObject*)a, '^', (PyLongObject*)b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003762 return c;
Guido van Rossumc6913e71991-11-19 20:26:46 +00003763}
3764
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003765static PyObject *
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003766long_or(PyObject *a, PyObject *b)
Guido van Rossumc6913e71991-11-19 20:26:46 +00003767{
Neil Schemenauerba872e22001-01-04 01:46:03 +00003768 PyObject *c;
Martin v. Löwisda86fcc2007-09-10 07:59:54 +00003769 CHECK_BINOP(a, b);
3770 c = long_bitwise((PyLongObject*)a, '|', (PyLongObject*)b);
Neil Schemenauerba872e22001-01-04 01:46:03 +00003771 return c;
Guido van Rossum23d6f0e1991-05-14 12:06:49 +00003772}
3773
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003774static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003775long_long(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003776{
Brett Cannonc3647ac2005-04-26 03:45:26 +00003777 if (PyLong_CheckExact(v))
3778 Py_INCREF(v);
3779 else
3780 v = _PyLong_Copy((PyLongObject *)v);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003781 return v;
3782}
3783
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003784static PyObject *
Tim Peters9f688bf2000-07-07 15:53:28 +00003785long_float(PyObject *v)
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003786{
Guido van Rossum09e6ad01997-02-14 22:54:21 +00003787 double result;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003788 result = PyLong_AsDouble(v);
Tim Peters9fffa3e2001-09-04 05:14:19 +00003789 if (result == -1.0 && PyErr_Occurred())
3790 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003791 return PyFloat_FromDouble(result);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003792}
3793
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003794static PyObject *
Guido van Rossumbef14172001-08-29 15:47:46 +00003795long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
Guido van Rossum1899c2e1992-09-12 11:09:23 +00003796
Tim Peters6d6c1a32001-08-02 04:15:00 +00003797static PyObject *
3798long_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3799{
3800 PyObject *x = NULL;
3801 int base = -909; /* unlikely! */
Martin v. Löwis15e62742006-02-27 16:46:16 +00003802 static char *kwlist[] = {"x", "base", 0};
Tim Peters6d6c1a32001-08-02 04:15:00 +00003803
Guido van Rossumbef14172001-08-29 15:47:46 +00003804 if (type != &PyLong_Type)
3805 return long_subtype_new(type, args, kwds); /* Wimp out */
Guido van Rossumddefaf32007-01-14 03:31:43 +00003806 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oi:int", kwlist,
Tim Peters6d6c1a32001-08-02 04:15:00 +00003807 &x, &base))
3808 return NULL;
3809 if (x == NULL)
3810 return PyLong_FromLong(0L);
3811 if (base == -909)
3812 return PyNumber_Long(x);
Guido van Rossum98297ee2007-11-06 21:34:58 +00003813 else if (PyUnicode_Check(x))
3814 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(x),
3815 PyUnicode_GET_SIZE(x),
3816 base);
Christian Heimes72b710a2008-05-26 13:28:38 +00003817 else if (PyByteArray_Check(x) || PyBytes_Check(x)) {
Guido van Rossumd8faa362007-04-27 19:54:29 +00003818 /* Since PyLong_FromString doesn't have a length parameter,
3819 * check here for possible NULs in the string. */
Guido van Rossum98297ee2007-11-06 21:34:58 +00003820 char *string;
Mark Dickinson5a74bf62009-02-15 11:04:38 +00003821 Py_ssize_t size = Py_SIZE(x);
Christian Heimes9c4756e2008-05-26 13:22:05 +00003822 if (PyByteArray_Check(x))
3823 string = PyByteArray_AS_STRING(x);
Guido van Rossum98297ee2007-11-06 21:34:58 +00003824 else
Christian Heimes72b710a2008-05-26 13:28:38 +00003825 string = PyBytes_AS_STRING(x);
Mark Dickinson5a74bf62009-02-15 11:04:38 +00003826 if (strlen(string) != (size_t)size) {
Guido van Rossum25236212007-08-22 23:28:23 +00003827 /* We only see this if there's a null byte in x,
Guido van Rossum98297ee2007-11-06 21:34:58 +00003828 x is a bytes or buffer, *and* a base is given. */
Guido van Rossumd8faa362007-04-27 19:54:29 +00003829 PyErr_Format(PyExc_ValueError,
Guido van Rossum25236212007-08-22 23:28:23 +00003830 "invalid literal for int() with base %d: %R",
3831 base, x);
Guido van Rossumd8faa362007-04-27 19:54:29 +00003832 return NULL;
Guido van Rossumddefaf32007-01-14 03:31:43 +00003833 }
Guido van Rossum4581ae52007-05-22 21:56:47 +00003834 return PyLong_FromString(string, NULL, base);
Guido van Rossumddefaf32007-01-14 03:31:43 +00003835 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003836 else {
3837 PyErr_SetString(PyExc_TypeError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00003838 "int() can't convert non-string with explicit base");
Tim Peters6d6c1a32001-08-02 04:15:00 +00003839 return NULL;
3840 }
3841}
3842
Guido van Rossumbef14172001-08-29 15:47:46 +00003843/* Wimpy, slow approach to tp_new calls for subtypes of long:
3844 first create a regular long from whatever arguments we got,
3845 then allocate a subtype instance and initialize it from
3846 the regular long. The regular long is then thrown away.
3847*/
3848static PyObject *
3849long_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3850{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003851 PyLongObject *tmp, *newobj;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003852 Py_ssize_t i, n;
Guido van Rossumbef14172001-08-29 15:47:46 +00003853
3854 assert(PyType_IsSubtype(type, &PyLong_Type));
3855 tmp = (PyLongObject *)long_new(&PyLong_Type, args, kwds);
3856 if (tmp == NULL)
3857 return NULL;
Tim Peters64b5ce32001-09-10 20:52:51 +00003858 assert(PyLong_CheckExact(tmp));
Christian Heimes90aa7642007-12-19 02:45:37 +00003859 n = Py_SIZE(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003860 if (n < 0)
3861 n = -n;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003862 newobj = (PyLongObject *)type->tp_alloc(type, n);
3863 if (newobj == NULL) {
Raymond Hettingerf4667932003-06-28 20:04:25 +00003864 Py_DECREF(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003865 return NULL;
Raymond Hettingerf4667932003-06-28 20:04:25 +00003866 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003867 assert(PyLong_Check(newobj));
Christian Heimes90aa7642007-12-19 02:45:37 +00003868 Py_SIZE(newobj) = Py_SIZE(tmp);
Guido van Rossumbef14172001-08-29 15:47:46 +00003869 for (i = 0; i < n; i++)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003870 newobj->ob_digit[i] = tmp->ob_digit[i];
Guido van Rossumbef14172001-08-29 15:47:46 +00003871 Py_DECREF(tmp);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003872 return (PyObject *)newobj;
Guido van Rossumbef14172001-08-29 15:47:46 +00003873}
3874
Guido van Rossum5d9113d2003-01-29 17:58:45 +00003875static PyObject *
3876long_getnewargs(PyLongObject *v)
3877{
3878 return Py_BuildValue("(N)", _PyLong_Copy(v));
3879}
3880
Guido van Rossumb43daf72007-08-01 18:08:08 +00003881static PyObject *
Mark Dickinson6bf19002009-05-02 17:57:52 +00003882long_get0(PyLongObject *v, void *context) {
3883 return PyLong_FromLong(0L);
3884}
3885
3886static PyObject *
3887long_get1(PyLongObject *v, void *context) {
3888 return PyLong_FromLong(1L);
Guido van Rossumb43daf72007-08-01 18:08:08 +00003889}
3890
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003891static PyObject *
Eric Smith8c663262007-08-25 02:26:07 +00003892long__format__(PyObject *self, PyObject *args)
3893{
Eric Smith4a7d76d2008-05-30 18:10:19 +00003894 PyObject *format_spec;
3895
3896 if (!PyArg_ParseTuple(args, "U:__format__", &format_spec))
3897 return NULL;
3898 return _PyLong_FormatAdvanced(self,
3899 PyUnicode_AS_UNICODE(format_spec),
3900 PyUnicode_GET_SIZE(format_spec));
Eric Smith8c663262007-08-25 02:26:07 +00003901}
3902
Eric Smith8c663262007-08-25 02:26:07 +00003903static PyObject *
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003904long_round(PyObject *self, PyObject *args)
3905{
Mark Dickinson1124e712009-01-28 21:25:58 +00003906 PyObject *o_ndigits=NULL, *temp;
3907 PyLongObject *pow=NULL, *q=NULL, *r=NULL, *ndigits=NULL, *one;
3908 int errcode;
3909 digit q_mod_4;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003910
Mark Dickinson1124e712009-01-28 21:25:58 +00003911 /* Notes on the algorithm: to round to the nearest 10**n (n positive),
3912 the straightforward method is:
3913
3914 (1) divide by 10**n
3915 (2) round to nearest integer (round to even in case of tie)
3916 (3) multiply result by 10**n.
3917
3918 But the rounding step involves examining the fractional part of the
3919 quotient to see whether it's greater than 0.5 or not. Since we
3920 want to do the whole calculation in integer arithmetic, it's
3921 simpler to do:
3922
3923 (1) divide by (10**n)/2
3924 (2) round to nearest multiple of 2 (multiple of 4 in case of tie)
3925 (3) multiply result by (10**n)/2.
3926
3927 Then all we need to know about the fractional part of the quotient
3928 arising in step (2) is whether it's zero or not.
3929
3930 Doing both a multiplication and division is wasteful, and is easily
3931 avoided if we just figure out how much to adjust the original input
3932 by to do the rounding.
3933
3934 Here's the whole algorithm expressed in Python.
3935
3936 def round(self, ndigits = None):
3937 """round(int, int) -> int"""
3938 if ndigits is None or ndigits >= 0:
3939 return self
3940 pow = 10**-ndigits >> 1
3941 q, r = divmod(self, pow)
3942 self -= r
3943 if (q & 1 != 0):
3944 if (q & 2 == r == 0):
3945 self -= pow
3946 else:
3947 self += pow
3948 return self
3949
3950 */
3951 if (!PyArg_ParseTuple(args, "|O", &o_ndigits))
3952 return NULL;
3953 if (o_ndigits == NULL)
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003954 return long_long(self);
3955
Mark Dickinson1124e712009-01-28 21:25:58 +00003956 ndigits = (PyLongObject *)PyNumber_Index(o_ndigits);
3957 if (ndigits == NULL)
Guido van Rossum2fa33db2007-08-23 22:07:24 +00003958 return NULL;
Mark Dickinson1124e712009-01-28 21:25:58 +00003959
3960 if (Py_SIZE(ndigits) >= 0) {
3961 Py_DECREF(ndigits);
3962 return long_long(self);
3963 }
3964
3965 Py_INCREF(self); /* to keep refcounting simple */
3966 /* we now own references to self, ndigits */
3967
3968 /* pow = 10 ** -ndigits >> 1 */
3969 pow = (PyLongObject *)PyLong_FromLong(10L);
3970 if (pow == NULL)
3971 goto error;
3972 temp = long_neg(ndigits);
3973 Py_DECREF(ndigits);
3974 ndigits = (PyLongObject *)temp;
3975 if (ndigits == NULL)
3976 goto error;
3977 temp = long_pow((PyObject *)pow, (PyObject *)ndigits, Py_None);
3978 Py_DECREF(pow);
3979 pow = (PyLongObject *)temp;
3980 if (pow == NULL)
3981 goto error;
3982 assert(PyLong_Check(pow)); /* check long_pow returned a long */
3983 one = (PyLongObject *)PyLong_FromLong(1L);
3984 if (one == NULL)
3985 goto error;
3986 temp = long_rshift(pow, one);
3987 Py_DECREF(one);
3988 Py_DECREF(pow);
3989 pow = (PyLongObject *)temp;
3990 if (pow == NULL)
3991 goto error;
3992
3993 /* q, r = divmod(self, pow) */
3994 errcode = l_divmod((PyLongObject *)self, pow, &q, &r);
3995 if (errcode == -1)
3996 goto error;
3997
3998 /* self -= r */
3999 temp = long_sub((PyLongObject *)self, r);
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004000 Py_DECREF(self);
Mark Dickinson1124e712009-01-28 21:25:58 +00004001 self = temp;
4002 if (self == NULL)
4003 goto error;
4004
4005 /* get value of quotient modulo 4 */
4006 if (Py_SIZE(q) == 0)
4007 q_mod_4 = 0;
4008 else if (Py_SIZE(q) > 0)
4009 q_mod_4 = q->ob_digit[0] & 3;
4010 else
4011 q_mod_4 = (PyLong_BASE-q->ob_digit[0]) & 3;
4012
4013 if ((q_mod_4 & 1) == 1) {
4014 /* q is odd; round self up or down by adding or subtracting pow */
4015 if (q_mod_4 == 1 && Py_SIZE(r) == 0)
4016 temp = (PyObject *)long_sub((PyLongObject *)self, pow);
4017 else
4018 temp = (PyObject *)long_add((PyLongObject *)self, pow);
4019 Py_DECREF(self);
4020 self = temp;
4021 if (self == NULL)
4022 goto error;
4023 }
4024 Py_DECREF(q);
4025 Py_DECREF(r);
4026 Py_DECREF(pow);
4027 Py_DECREF(ndigits);
4028 return self;
4029
4030 error:
4031 Py_XDECREF(q);
4032 Py_XDECREF(r);
4033 Py_XDECREF(pow);
4034 Py_XDECREF(self);
4035 Py_XDECREF(ndigits);
4036 return NULL;
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004037}
4038
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004039static PyObject *
4040long_sizeof(PyLongObject *v)
4041{
4042 Py_ssize_t res;
4043
Mark Dickinson5a74bf62009-02-15 11:04:38 +00004044 res = offsetof(PyLongObject, ob_digit) + ABS(Py_SIZE(v))*sizeof(digit);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004045 return PyLong_FromSsize_t(res);
4046}
4047
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004048static PyObject *
4049long_bit_length(PyLongObject *v)
4050{
4051 PyLongObject *result, *x, *y;
4052 Py_ssize_t ndigits, msd_bits = 0;
4053 digit msd;
4054
4055 assert(v != NULL);
4056 assert(PyLong_Check(v));
4057
4058 ndigits = ABS(Py_SIZE(v));
4059 if (ndigits == 0)
4060 return PyLong_FromLong(0);
4061
4062 msd = v->ob_digit[ndigits-1];
4063 while (msd >= 32) {
4064 msd_bits += 6;
4065 msd >>= 6;
4066 }
4067 msd_bits += (long)(BitLengthTable[msd]);
4068
4069 if (ndigits <= PY_SSIZE_T_MAX/PyLong_SHIFT)
4070 return PyLong_FromSsize_t((ndigits-1)*PyLong_SHIFT + msd_bits);
4071
4072 /* expression above may overflow; use Python integers instead */
4073 result = (PyLongObject *)PyLong_FromSsize_t(ndigits - 1);
4074 if (result == NULL)
4075 return NULL;
4076 x = (PyLongObject *)PyLong_FromLong(PyLong_SHIFT);
4077 if (x == NULL)
4078 goto error;
4079 y = (PyLongObject *)long_mul(result, x);
4080 Py_DECREF(x);
4081 if (y == NULL)
4082 goto error;
4083 Py_DECREF(result);
4084 result = y;
4085
4086 x = (PyLongObject *)PyLong_FromLong(msd_bits);
4087 if (x == NULL)
4088 goto error;
4089 y = (PyLongObject *)long_add(result, x);
4090 Py_DECREF(x);
4091 if (y == NULL)
4092 goto error;
4093 Py_DECREF(result);
4094 result = y;
4095
4096 return (PyObject *)result;
4097
4098error:
4099 Py_DECREF(result);
4100 return NULL;
4101}
4102
4103PyDoc_STRVAR(long_bit_length_doc,
4104"int.bit_length() -> int\n\
4105\n\
4106Number of bits necessary to represent self in binary.\n\
4107>>> bin(37)\n\
4108'0b100101'\n\
4109>>> (37).bit_length()\n\
41106");
4111
Christian Heimes53876d92008-04-19 00:31:39 +00004112#if 0
4113static PyObject *
4114long_is_finite(PyObject *v)
4115{
4116 Py_RETURN_TRUE;
4117}
4118#endif
4119
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004120static PyMethodDef long_methods[] = {
Guido van Rossumb43daf72007-08-01 18:08:08 +00004121 {"conjugate", (PyCFunction)long_long, METH_NOARGS,
4122 "Returns self, the complex conjugate of any int."},
Mark Dickinson54bc1ec2008-12-17 16:19:07 +00004123 {"bit_length", (PyCFunction)long_bit_length, METH_NOARGS,
4124 long_bit_length_doc},
Christian Heimes53876d92008-04-19 00:31:39 +00004125#if 0
4126 {"is_finite", (PyCFunction)long_is_finite, METH_NOARGS,
4127 "Returns always True."},
4128#endif
Guido van Rossum2fa33db2007-08-23 22:07:24 +00004129 {"__trunc__", (PyCFunction)long_long, METH_NOARGS,
4130 "Truncating an Integral returns itself."},
4131 {"__floor__", (PyCFunction)long_long, METH_NOARGS,
4132 "Flooring an Integral returns itself."},
4133 {"__ceil__", (PyCFunction)long_long, METH_NOARGS,
4134 "Ceiling of an Integral returns itself."},
4135 {"__round__", (PyCFunction)long_round, METH_VARARGS,
Mark Dickinson1124e712009-01-28 21:25:58 +00004136 "Rounding an Integral returns itself.\n"
4137 "Rounding with an ndigits argument also returns an integer."},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004138 {"__getnewargs__", (PyCFunction)long_getnewargs, METH_NOARGS},
Eric Smith8c663262007-08-25 02:26:07 +00004139 {"__format__", (PyCFunction)long__format__, METH_VARARGS},
Martin v. Löwis00709aa2008-06-04 14:18:43 +00004140 {"__sizeof__", (PyCFunction)long_sizeof, METH_NOARGS,
4141 "Returns size in memory, in bytes"},
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004142 {NULL, NULL} /* sentinel */
4143};
4144
Guido van Rossumb43daf72007-08-01 18:08:08 +00004145static PyGetSetDef long_getset[] = {
Mark Dickinson6bf19002009-05-02 17:57:52 +00004146 {"real",
Guido van Rossumb43daf72007-08-01 18:08:08 +00004147 (getter)long_long, (setter)NULL,
4148 "the real part of a complex number",
4149 NULL},
Mark Dickinson6bf19002009-05-02 17:57:52 +00004150 {"imag",
4151 (getter)long_get0, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00004152 "the imaginary part of a complex number",
Mark Dickinson6bf19002009-05-02 17:57:52 +00004153 NULL},
4154 {"numerator",
Guido van Rossumb43daf72007-08-01 18:08:08 +00004155 (getter)long_long, (setter)NULL,
4156 "the numerator of a rational number in lowest terms",
4157 NULL},
Mark Dickinson6bf19002009-05-02 17:57:52 +00004158 {"denominator",
4159 (getter)long_get1, (setter)NULL,
Guido van Rossumb43daf72007-08-01 18:08:08 +00004160 "the denominator of a rational number in lowest terms",
Mark Dickinson6bf19002009-05-02 17:57:52 +00004161 NULL},
Guido van Rossumb43daf72007-08-01 18:08:08 +00004162 {NULL} /* Sentinel */
4163};
4164
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004165PyDoc_STRVAR(long_doc,
Guido van Rossumddefaf32007-01-14 03:31:43 +00004166"int(x[, base]) -> integer\n\
Tim Peters6d6c1a32001-08-02 04:15:00 +00004167\n\
Guido van Rossumddefaf32007-01-14 03:31:43 +00004168Convert a string or number to an integer, if possible. A floating\n\
Tim Peters6d6c1a32001-08-02 04:15:00 +00004169point argument will be truncated towards zero (this does not include a\n\
4170string representation of a floating point number!) When converting a\n\
4171string, use the optional base. It is an error to supply a base when\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004172converting a non-string.");
Tim Peters6d6c1a32001-08-02 04:15:00 +00004173
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004174static PyNumberMethods long_as_number = {
Tim Peters9f688bf2000-07-07 15:53:28 +00004175 (binaryfunc) long_add, /*nb_add*/
4176 (binaryfunc) long_sub, /*nb_subtract*/
4177 (binaryfunc) long_mul, /*nb_multiply*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004178 long_mod, /*nb_remainder*/
4179 long_divmod, /*nb_divmod*/
4180 long_pow, /*nb_power*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004181 (unaryfunc) long_neg, /*nb_negative*/
Guido van Rossumb43daf72007-08-01 18:08:08 +00004182 (unaryfunc) long_long, /*tp_positive*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004183 (unaryfunc) long_abs, /*tp_absolute*/
Jack Diederich4dafcc42006-11-28 19:15:13 +00004184 (inquiry) long_bool, /*tp_bool*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004185 (unaryfunc) long_invert, /*nb_invert*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004186 long_lshift, /*nb_lshift*/
Tim Peters9f688bf2000-07-07 15:53:28 +00004187 (binaryfunc) long_rshift, /*nb_rshift*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004188 long_and, /*nb_and*/
4189 long_xor, /*nb_xor*/
4190 long_or, /*nb_or*/
Guido van Rossumb43daf72007-08-01 18:08:08 +00004191 long_long, /*nb_int*/
Mark Dickinson8055afd2009-01-17 10:04:45 +00004192 0, /*nb_reserved*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004193 long_float, /*nb_float*/
Guido van Rossum4668b002001-08-08 05:00:18 +00004194 0, /* nb_inplace_add */
4195 0, /* nb_inplace_subtract */
4196 0, /* nb_inplace_multiply */
Guido van Rossum4668b002001-08-08 05:00:18 +00004197 0, /* nb_inplace_remainder */
4198 0, /* nb_inplace_power */
4199 0, /* nb_inplace_lshift */
4200 0, /* nb_inplace_rshift */
4201 0, /* nb_inplace_and */
4202 0, /* nb_inplace_xor */
4203 0, /* nb_inplace_or */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004204 long_div, /* nb_floor_divide */
Guido van Rossum4668b002001-08-08 05:00:18 +00004205 long_true_divide, /* nb_true_divide */
4206 0, /* nb_inplace_floor_divide */
4207 0, /* nb_inplace_true_divide */
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00004208 long_long, /* nb_index */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004209};
4210
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004211PyTypeObject PyLong_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00004212 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossumddefaf32007-01-14 03:31:43 +00004213 "int", /* tp_name */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00004214 offsetof(PyLongObject, ob_digit), /* tp_basicsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004215 sizeof(digit), /* tp_itemsize */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004216 long_dealloc, /* tp_dealloc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004217 0, /* tp_print */
4218 0, /* tp_getattr */
4219 0, /* tp_setattr */
Mark Dickinsone94c6792009-02-02 20:36:42 +00004220 0, /* tp_reserved */
Mark Dickinson2031d132009-09-17 00:17:48 +00004221 long_to_decimal_string, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004222 &long_as_number, /* tp_as_number */
4223 0, /* tp_as_sequence */
4224 0, /* tp_as_mapping */
4225 (hashfunc)long_hash, /* tp_hash */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00004226 0, /* tp_call */
Mark Dickinson2031d132009-09-17 00:17:48 +00004227 long_to_decimal_string, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004228 PyObject_GenericGetAttr, /* tp_getattro */
4229 0, /* tp_setattro */
4230 0, /* tp_as_buffer */
Thomas Wouters27d517b2007-02-25 20:39:11 +00004231 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
4232 Py_TPFLAGS_LONG_SUBCLASS, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004233 long_doc, /* tp_doc */
4234 0, /* tp_traverse */
4235 0, /* tp_clear */
Guido van Rossum47b9ff62006-08-24 00:41:19 +00004236 long_richcompare, /* tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004237 0, /* tp_weaklistoffset */
4238 0, /* tp_iter */
4239 0, /* tp_iternext */
Guido van Rossum5d9113d2003-01-29 17:58:45 +00004240 long_methods, /* tp_methods */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004241 0, /* tp_members */
Guido van Rossumb43daf72007-08-01 18:08:08 +00004242 long_getset, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004243 0, /* tp_base */
4244 0, /* tp_dict */
4245 0, /* tp_descr_get */
4246 0, /* tp_descr_set */
4247 0, /* tp_dictoffset */
4248 0, /* tp_init */
4249 0, /* tp_alloc */
4250 long_new, /* tp_new */
Mark Dickinson5a74bf62009-02-15 11:04:38 +00004251 PyObject_Del, /* tp_free */
Guido van Rossumedcc38a1991-05-05 20:09:44 +00004252};
Guido van Rossumddefaf32007-01-14 03:31:43 +00004253
Mark Dickinsonbd792642009-03-18 20:06:12 +00004254static PyTypeObject Int_InfoType;
4255
4256PyDoc_STRVAR(int_info__doc__,
4257"sys.int_info\n\
4258\n\
4259A struct sequence that holds information about Python's\n\
4260internal representation of integers. The attributes are read only.");
4261
4262static PyStructSequence_Field int_info_fields[] = {
4263 {"bits_per_digit", "size of a digit in bits"},
4264 {"sizeof_digit", "size in bytes of the C type used to "
4265 "represent a digit"},
4266 {NULL, NULL}
4267};
4268
4269static PyStructSequence_Desc int_info_desc = {
4270 "sys.int_info", /* name */
4271 int_info__doc__, /* doc */
4272 int_info_fields, /* fields */
4273 2 /* number of fields */
4274};
4275
4276PyObject *
4277PyLong_GetInfo(void)
4278{
4279 PyObject* int_info;
4280 int field = 0;
4281 int_info = PyStructSequence_New(&Int_InfoType);
4282 if (int_info == NULL)
4283 return NULL;
Mark Dickinson0bdab682009-04-02 18:41:40 +00004284 PyStructSequence_SET_ITEM(int_info, field++,
4285 PyLong_FromLong(PyLong_SHIFT));
4286 PyStructSequence_SET_ITEM(int_info, field++,
4287 PyLong_FromLong(sizeof(digit)));
Mark Dickinsonbd792642009-03-18 20:06:12 +00004288 if (PyErr_Occurred()) {
4289 Py_CLEAR(int_info);
4290 return NULL;
4291 }
4292 return int_info;
4293}
4294
Guido van Rossumddefaf32007-01-14 03:31:43 +00004295int
4296_PyLong_Init(void)
4297{
4298#if NSMALLNEGINTS + NSMALLPOSINTS > 0
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004299 int ival, size;
Guido van Rossumddefaf32007-01-14 03:31:43 +00004300 PyLongObject *v = small_ints;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004301
4302 for (ival = -NSMALLNEGINTS; ival < NSMALLPOSINTS; ival++, v++) {
4303 size = (ival < 0) ? -1 : ((ival == 0) ? 0 : 1);
4304 if (Py_TYPE(v) == &PyLong_Type) {
4305 /* The element is already initialized, most likely
4306 * the Python interpreter was initialized before.
4307 */
Christian Heimes48aa4b12008-02-01 16:56:30 +00004308 Py_ssize_t refcnt;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004309 PyObject* op = (PyObject*)v;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004310
Christian Heimes48aa4b12008-02-01 16:56:30 +00004311 refcnt = Py_REFCNT(op) < 0 ? 0 : Py_REFCNT(op);
4312 _Py_NewReference(op);
4313 /* _Py_NewReference sets the ref count to 1 but
4314 * the ref count might be larger. Set the refcnt
4315 * to the original refcnt + 1 */
4316 Py_REFCNT(op) = refcnt + 1;
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004317 assert(Py_SIZE(op) == size);
4318 assert(v->ob_digit[0] == abs(ival));
4319 }
4320 else {
4321 PyObject_INIT(v, &PyLong_Type);
4322 }
4323 Py_SIZE(v) = size;
4324 v->ob_digit[0] = abs(ival);
Guido van Rossumddefaf32007-01-14 03:31:43 +00004325 }
4326#endif
Mark Dickinsonbd792642009-03-18 20:06:12 +00004327 /* initialize int_info */
4328 if (Int_InfoType.tp_name == 0)
4329 PyStructSequence_InitType(&Int_InfoType, &int_info_desc);
4330
Guido van Rossumddefaf32007-01-14 03:31:43 +00004331 return 1;
4332}
4333
4334void
4335PyLong_Fini(void)
4336{
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004337 /* Integers are currently statically allocated. Py_DECREF is not
4338 needed, but Python must forget about the reference or multiple
4339 reinitializations will fail. */
Guido van Rossumddefaf32007-01-14 03:31:43 +00004340#if NSMALLNEGINTS + NSMALLPOSINTS > 0
Christian Heimesdfc12ed2008-01-31 15:16:38 +00004341 int i;
4342 PyLongObject *v = small_ints;
4343 for (i = 0; i < NSMALLNEGINTS + NSMALLPOSINTS; i++, v++) {
4344 _Py_DEC_REFTOTAL;
4345 _Py_ForgetReference((PyObject*)v);
4346 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00004347#endif
4348}