longintrepr.h 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. #ifndef Py_LIMITED_API
  2. #ifndef Py_LONGINTREPR_H
  3. #define Py_LONGINTREPR_H
  4. #ifdef __cplusplus
  5. extern "C" {
  6. #endif
  7. /* This is published for the benefit of "friends" marshal.c and _decimal.c. */
  8. /* Parameters of the integer representation. There are two different
  9. sets of parameters: one set for 30-bit digits, stored in an unsigned 32-bit
  10. integer type, and one set for 15-bit digits with each digit stored in an
  11. unsigned short. The value of PYLONG_BITS_IN_DIGIT, defined either at
  12. configure time or in pyport.h, is used to decide which digit size to use.
  13. Type 'digit' should be able to hold 2*PyLong_BASE-1, and type 'twodigits'
  14. should be an unsigned integer type able to hold all integers up to
  15. PyLong_BASE*PyLong_BASE-1. x_sub assumes that 'digit' is an unsigned type,
  16. and that overflow is handled by taking the result modulo 2**N for some N >
  17. PyLong_SHIFT. The majority of the code doesn't care about the precise
  18. value of PyLong_SHIFT, but there are some notable exceptions:
  19. - long_pow() requires that PyLong_SHIFT be divisible by 5
  20. - PyLong_{As,From}ByteArray require that PyLong_SHIFT be at least 8
  21. - long_hash() requires that PyLong_SHIFT is *strictly* less than the number
  22. of bits in an unsigned long, as do the PyLong <-> long (or unsigned long)
  23. conversion functions
  24. - the Python int <-> size_t/Py_ssize_t conversion functions expect that
  25. PyLong_SHIFT is strictly less than the number of bits in a size_t
  26. - the marshal code currently expects that PyLong_SHIFT is a multiple of 15
  27. - NSMALLNEGINTS and NSMALLPOSINTS should be small enough to fit in a single
  28. digit; with the current values this forces PyLong_SHIFT >= 9
  29. The values 15 and 30 should fit all of the above requirements, on any
  30. platform.
  31. */
  32. #if PYLONG_BITS_IN_DIGIT == 30
  33. #if !(defined HAVE_UINT64_T && defined HAVE_UINT32_T && \
  34. defined HAVE_INT64_T && defined HAVE_INT32_T)
  35. #error "30-bit long digits requested, but the necessary types are not available on this platform"
  36. #endif
  37. typedef PY_UINT32_T digit;
  38. typedef PY_INT32_T sdigit; /* signed variant of digit */
  39. typedef PY_UINT64_T twodigits;
  40. typedef PY_INT64_T stwodigits; /* signed variant of twodigits */
  41. #define PyLong_SHIFT 30
  42. #define _PyLong_DECIMAL_SHIFT 9 /* max(e such that 10**e fits in a digit) */
  43. #define _PyLong_DECIMAL_BASE ((digit)1000000000) /* 10 ** DECIMAL_SHIFT */
  44. #elif PYLONG_BITS_IN_DIGIT == 15
  45. typedef unsigned short digit;
  46. typedef short sdigit; /* signed variant of digit */
  47. typedef unsigned long twodigits;
  48. typedef long stwodigits; /* signed variant of twodigits */
  49. #define PyLong_SHIFT 15
  50. #define _PyLong_DECIMAL_SHIFT 4 /* max(e such that 10**e fits in a digit) */
  51. #define _PyLong_DECIMAL_BASE ((digit)10000) /* 10 ** DECIMAL_SHIFT */
  52. #else
  53. #error "PYLONG_BITS_IN_DIGIT should be 15 or 30"
  54. #endif
  55. #define PyLong_BASE ((digit)1 << PyLong_SHIFT)
  56. #define PyLong_MASK ((digit)(PyLong_BASE - 1))
  57. #if PyLong_SHIFT % 5 != 0
  58. #error "longobject.c requires that PyLong_SHIFT be divisible by 5"
  59. #endif
  60. /* Long integer representation.
  61. The absolute value of a number is equal to
  62. SUM(for i=0 through abs(ob_size)-1) ob_digit[i] * 2**(SHIFT*i)
  63. Negative numbers are represented with ob_size < 0;
  64. zero is represented by ob_size == 0.
  65. In a normalized number, ob_digit[abs(ob_size)-1] (the most significant
  66. digit) is never zero. Also, in all cases, for all valid i,
  67. 0 <= ob_digit[i] <= MASK.
  68. The allocation function takes care of allocating extra memory
  69. so that ob_digit[0] ... ob_digit[abs(ob_size)-1] are actually available.
  70. CAUTION: Generic code manipulating subtypes of PyVarObject has to
  71. aware that ints abuse ob_size's sign bit.
  72. */
  73. struct _longobject {
  74. PyObject_VAR_HEAD
  75. digit ob_digit[1];
  76. };
  77. PyAPI_FUNC(PyLongObject *) _PyLong_New(Py_ssize_t);
  78. /* Return a copy of src. */
  79. PyAPI_FUNC(PyObject *) _PyLong_Copy(PyLongObject *src);
  80. #ifdef __cplusplus
  81. }
  82. #endif
  83. #endif /* !Py_LONGINTREPR_H */
  84. #endif /* Py_LIMITED_API */