longintrepr.h 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  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. - PyLong_{As,From}ByteArray require that PyLong_SHIFT be at least 8
  20. - long_hash() requires that PyLong_SHIFT is *strictly* less than the number
  21. of bits in an unsigned long, as do the PyLong <-> long (or unsigned long)
  22. conversion functions
  23. - the Python int <-> size_t/Py_ssize_t conversion functions expect that
  24. PyLong_SHIFT is strictly less than the number of bits in a size_t
  25. - the marshal code currently expects that PyLong_SHIFT is a multiple of 15
  26. - NSMALLNEGINTS and NSMALLPOSINTS should be small enough to fit in a single
  27. digit; with the current values this forces PyLong_SHIFT >= 9
  28. The values 15 and 30 should fit all of the above requirements, on any
  29. platform.
  30. */
  31. #if PYLONG_BITS_IN_DIGIT == 30
  32. typedef uint32_t digit;
  33. typedef int32_t sdigit; /* signed variant of digit */
  34. typedef uint64_t twodigits;
  35. typedef int64_t stwodigits; /* signed variant of twodigits */
  36. #define PyLong_SHIFT 30
  37. #define _PyLong_DECIMAL_SHIFT 9 /* max(e such that 10**e fits in a digit) */
  38. #define _PyLong_DECIMAL_BASE ((digit)1000000000) /* 10 ** DECIMAL_SHIFT */
  39. #elif PYLONG_BITS_IN_DIGIT == 15
  40. typedef unsigned short digit;
  41. typedef short sdigit; /* signed variant of digit */
  42. typedef unsigned long twodigits;
  43. typedef long stwodigits; /* signed variant of twodigits */
  44. #define PyLong_SHIFT 15
  45. #define _PyLong_DECIMAL_SHIFT 4 /* max(e such that 10**e fits in a digit) */
  46. #define _PyLong_DECIMAL_BASE ((digit)10000) /* 10 ** DECIMAL_SHIFT */
  47. #else
  48. #error "PYLONG_BITS_IN_DIGIT should be 15 or 30"
  49. #endif
  50. #define PyLong_BASE ((digit)1 << PyLong_SHIFT)
  51. #define PyLong_MASK ((digit)(PyLong_BASE - 1))
  52. /* Long integer representation.
  53. The absolute value of a number is equal to
  54. SUM(for i=0 through abs(ob_size)-1) ob_digit[i] * 2**(SHIFT*i)
  55. Negative numbers are represented with ob_size < 0;
  56. zero is represented by ob_size == 0.
  57. In a normalized number, ob_digit[abs(ob_size)-1] (the most significant
  58. digit) is never zero. Also, in all cases, for all valid i,
  59. 0 <= ob_digit[i] <= MASK.
  60. The allocation function takes care of allocating extra memory
  61. so that ob_digit[0] ... ob_digit[abs(ob_size)-1] are actually available.
  62. We always allocate memory for at least one digit, so accessing ob_digit[0]
  63. is always safe. However, in the case ob_size == 0, the contents of
  64. ob_digit[0] may be undefined.
  65. CAUTION: Generic code manipulating subtypes of PyVarObject has to
  66. aware that ints abuse ob_size's sign bit.
  67. */
  68. typedef struct _PyLongValue {
  69. uintptr_t lv_tag; /* Number of digits, sign and flags */
  70. digit ob_digit[1];
  71. } _PyLongValue;
  72. struct _longobject {
  73. PyObject_HEAD
  74. _PyLongValue long_value;
  75. };
  76. PyAPI_FUNC(PyLongObject *) _PyLong_New(Py_ssize_t);
  77. /* Return a copy of src. */
  78. PyAPI_FUNC(PyObject *) _PyLong_Copy(PyLongObject *src);
  79. PyAPI_FUNC(PyLongObject *)
  80. _PyLong_FromDigits(int negative, Py_ssize_t digit_count, digit *digits);
  81. /* Inline some internals for speed. These should be in pycore_long.h
  82. * if user code didn't need them inlined. */
  83. #define _PyLong_SIGN_MASK 3
  84. #define _PyLong_NON_SIZE_BITS 3
  85. static inline int
  86. _PyLong_IsCompact(const PyLongObject* op) {
  87. assert(PyType_HasFeature((op)->ob_base.ob_type, Py_TPFLAGS_LONG_SUBCLASS));
  88. return op->long_value.lv_tag < (2 << _PyLong_NON_SIZE_BITS);
  89. }
  90. #define PyUnstable_Long_IsCompact _PyLong_IsCompact
  91. static inline Py_ssize_t
  92. _PyLong_CompactValue(const PyLongObject *op)
  93. {
  94. assert(PyType_HasFeature((op)->ob_base.ob_type, Py_TPFLAGS_LONG_SUBCLASS));
  95. assert(PyUnstable_Long_IsCompact(op));
  96. Py_ssize_t sign = 1 - (op->long_value.lv_tag & _PyLong_SIGN_MASK);
  97. return sign * (Py_ssize_t)op->long_value.ob_digit[0];
  98. }
  99. #define PyUnstable_Long_CompactValue _PyLong_CompactValue
  100. #ifdef __cplusplus
  101. }
  102. #endif
  103. #endif /* !Py_LONGINTREPR_H */
  104. #endif /* Py_LIMITED_API */