Overflow.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. /*
  2. These functions provide integer arithmetic with integer checking. They do not
  3. actually raise an exception when an overflow is detected, but rather set a bit
  4. in the overflow parameter. (This parameter may be re-used across several
  5. arithmetic operations, so should be or-ed rather than assigned to.)
  6. The implementation is divided into two parts, the signed and unsigned basecases,
  7. which is where the magic happens, and a generic template matching a specific
  8. type to an implementation based on its (c-compile-time) size and signedness.
  9. When possible, branching is avoided, and preference is given to speed over
  10. accuracy (a low rate of falsely "detected" overflows are acceptable,
  11. undetected overflows are not).
  12. TODO: Hook up checking.
  13. TODO: Conditionally support 128-bit with intmax_t?
  14. */
  15. /////////////// Common.proto ///////////////
  16. static int __Pyx_check_twos_complement(void) {
  17. if (-1 != ~0) {
  18. PyErr_SetString(PyExc_RuntimeError, "Two's complement required for overflow checks.");
  19. return 1;
  20. } else if (sizeof(short) == sizeof(int)) {
  21. PyErr_SetString(PyExc_RuntimeError, "sizeof(short) < sizeof(int) required for overflow checks.");
  22. return 1;
  23. } else {
  24. return 0;
  25. }
  26. }
  27. #define __PYX_IS_UNSIGNED(type) (((type) -1) > 0)
  28. #define __PYX_SIGN_BIT(type) (((unsigned type) 1) << (sizeof(type) * 8 - 1))
  29. #define __PYX_HALF_MAX(type) (((type) 1) << (sizeof(type) * 8 - 2))
  30. #define __PYX_MIN(type) (__PYX_IS_UNSIGNED(type) ? (type) 0 : 0 - __PYX_HALF_MAX(type) - __PYX_HALF_MAX(type))
  31. #define __PYX_MAX(type) (~__PYX_MIN(type))
  32. #define __Pyx_add_no_overflow(a, b, overflow) ((a) + (b))
  33. #define __Pyx_add_const_no_overflow(a, b, overflow) ((a) + (b))
  34. #define __Pyx_sub_no_overflow(a, b, overflow) ((a) - (b))
  35. #define __Pyx_sub_const_no_overflow(a, b, overflow) ((a) - (b))
  36. #define __Pyx_mul_no_overflow(a, b, overflow) ((a) * (b))
  37. #define __Pyx_mul_const_no_overflow(a, b, overflow) ((a) * (b))
  38. #define __Pyx_div_no_overflow(a, b, overflow) ((a) / (b))
  39. #define __Pyx_div_const_no_overflow(a, b, overflow) ((a) / (b))
  40. /////////////// Common.init ///////////////
  41. __Pyx_check_twos_complement();
  42. /////////////// BaseCaseUnsigned.proto ///////////////
  43. static CYTHON_INLINE {{UINT}} __Pyx_add_{{NAME}}_checking_overflow({{UINT}} a, {{UINT}} b, int *overflow);
  44. static CYTHON_INLINE {{UINT}} __Pyx_sub_{{NAME}}_checking_overflow({{UINT}} a, {{UINT}} b, int *overflow);
  45. static CYTHON_INLINE {{UINT}} __Pyx_mul_{{NAME}}_checking_overflow({{UINT}} a, {{UINT}} b, int *overflow);
  46. static CYTHON_INLINE {{UINT}} __Pyx_div_{{NAME}}_checking_overflow({{UINT}} a, {{UINT}} b, int *overflow);
  47. // Use these when b is known at compile time.
  48. #define __Pyx_add_const_{{NAME}}_checking_overflow __Pyx_add_{{NAME}}_checking_overflow
  49. #define __Pyx_sub_const_{{NAME}}_checking_overflow __Pyx_sub_{{NAME}}_checking_overflow
  50. static CYTHON_INLINE {{UINT}} __Pyx_mul_const_{{NAME}}_checking_overflow({{UINT}} a, {{UINT}} constant, int *overflow);
  51. #define __Pyx_div_const_{{NAME}}_checking_overflow __Pyx_div_{{NAME}}_checking_overflow
  52. /////////////// BaseCaseUnsigned ///////////////
  53. static CYTHON_INLINE {{UINT}} __Pyx_add_{{NAME}}_checking_overflow({{UINT}} a, {{UINT}} b, int *overflow) {
  54. {{UINT}} r = a + b;
  55. *overflow |= r < a;
  56. return r;
  57. }
  58. static CYTHON_INLINE {{UINT}} __Pyx_sub_{{NAME}}_checking_overflow({{UINT}} a, {{UINT}} b, int *overflow) {
  59. {{UINT}} r = a - b;
  60. *overflow |= r > a;
  61. return r;
  62. }
  63. static CYTHON_INLINE {{UINT}} __Pyx_mul_{{NAME}}_checking_overflow({{UINT}} a, {{UINT}} b, int *overflow) {
  64. if (sizeof({{UINT}}) < sizeof(unsigned long)) {
  65. unsigned long big_r = ((unsigned long) a) * ((unsigned long) b);
  66. {{UINT}} r = ({{UINT}}) big_r;
  67. *overflow |= big_r != r;
  68. return r;
  69. #ifdef HAVE_LONG_LONG
  70. } else if (sizeof({{UINT}}) < sizeof(unsigned PY_LONG_LONG)) {
  71. unsigned PY_LONG_LONG big_r = ((unsigned PY_LONG_LONG) a) * ((unsigned PY_LONG_LONG) b);
  72. {{UINT}} r = ({{UINT}}) big_r;
  73. *overflow |= big_r != r;
  74. return r;
  75. #endif
  76. } else {
  77. {{UINT}} prod = a * b;
  78. double dprod = ((double) a) * ((double) b);
  79. // Overflow results in an error of at least 2^sizeof(UINT),
  80. // whereas rounding represents an error on the order of 2^(sizeof(UINT)-53).
  81. *overflow |= fabs(dprod - prod) > (__PYX_MAX({{UINT}}) / 2);
  82. return prod;
  83. }
  84. }
  85. static CYTHON_INLINE {{UINT}} __Pyx_mul_const_{{NAME}}_checking_overflow({{UINT}} a, {{UINT}} b, int *overflow) {
  86. if (b > 1) {
  87. *overflow |= a > __PYX_MAX({{UINT}}) / b;
  88. }
  89. return a * b;
  90. }
  91. static CYTHON_INLINE {{UINT}} __Pyx_div_{{NAME}}_checking_overflow({{UINT}} a, {{UINT}} b, int *overflow) {
  92. if (b == 0) {
  93. *overflow |= 1;
  94. return 0;
  95. }
  96. return a / b;
  97. }
  98. /////////////// BaseCaseSigned.proto ///////////////
  99. static CYTHON_INLINE {{INT}} __Pyx_add_{{NAME}}_checking_overflow({{INT}} a, {{INT}} b, int *overflow);
  100. static CYTHON_INLINE {{INT}} __Pyx_sub_{{NAME}}_checking_overflow({{INT}} a, {{INT}} b, int *overflow);
  101. static CYTHON_INLINE {{INT}} __Pyx_mul_{{NAME}}_checking_overflow({{INT}} a, {{INT}} b, int *overflow);
  102. static CYTHON_INLINE {{INT}} __Pyx_div_{{NAME}}_checking_overflow({{INT}} a, {{INT}} b, int *overflow);
  103. // Use when b is known at compile time.
  104. static CYTHON_INLINE {{INT}} __Pyx_add_const_{{NAME}}_checking_overflow({{INT}} a, {{INT}} b, int *overflow);
  105. static CYTHON_INLINE {{INT}} __Pyx_sub_const_{{NAME}}_checking_overflow({{INT}} a, {{INT}} b, int *overflow);
  106. static CYTHON_INLINE {{INT}} __Pyx_mul_const_{{NAME}}_checking_overflow({{INT}} a, {{INT}} constant, int *overflow);
  107. #define __Pyx_div_const_{{NAME}}_checking_overflow __Pyx_div_{{NAME}}_checking_overflow
  108. /////////////// BaseCaseSigned ///////////////
  109. static CYTHON_INLINE {{INT}} __Pyx_add_{{NAME}}_checking_overflow({{INT}} a, {{INT}} b, int *overflow) {
  110. if (sizeof({{INT}}) < sizeof(long)) {
  111. long big_r = ((long) a) + ((long) b);
  112. {{INT}} r = ({{INT}}) big_r;
  113. *overflow |= big_r != r;
  114. return r;
  115. #ifdef HAVE_LONG_LONG
  116. } else if (sizeof({{INT}}) < sizeof(PY_LONG_LONG)) {
  117. PY_LONG_LONG big_r = ((PY_LONG_LONG) a) + ((PY_LONG_LONG) b);
  118. {{INT}} r = ({{INT}}) big_r;
  119. *overflow |= big_r != r;
  120. return r;
  121. #endif
  122. } else {
  123. // Signed overflow undefined, but unsigned overflow is well defined.
  124. {{INT}} r = ({{INT}}) ((unsigned {{INT}}) a + (unsigned {{INT}}) b);
  125. // Overflow happened if the operands have the same sign, but the result
  126. // has opposite sign.
  127. // sign(a) == sign(b) != sign(r)
  128. {{INT}} sign_a = __PYX_SIGN_BIT({{INT}}) & a;
  129. {{INT}} sign_b = __PYX_SIGN_BIT({{INT}}) & b;
  130. {{INT}} sign_r = __PYX_SIGN_BIT({{INT}}) & r;
  131. *overflow |= (sign_a == sign_b) & (sign_a != sign_r);
  132. return r;
  133. }
  134. }
  135. static CYTHON_INLINE {{INT}} __Pyx_add_const_{{NAME}}_checking_overflow({{INT}} a, {{INT}} b, int *overflow) {
  136. if (b > 0) {
  137. *overflow |= a > __PYX_MAX({{INT}}) - b;
  138. } else if (b < 0) {
  139. *overflow |= a < __PYX_MIN({{INT}}) - b;
  140. }
  141. return a + b;
  142. }
  143. static CYTHON_INLINE {{INT}} __Pyx_sub_{{NAME}}_checking_overflow({{INT}} a, {{INT}} b, int *overflow) {
  144. *overflow |= b == __PYX_MIN({{INT}});
  145. return __Pyx_add_{{NAME}}_checking_overflow(a, -b, overflow);
  146. }
  147. static CYTHON_INLINE {{INT}} __Pyx_sub_const_{{NAME}}_checking_overflow({{INT}} a, {{INT}} b, int *overflow) {
  148. *overflow |= b == __PYX_MIN({{INT}});
  149. return __Pyx_add_const_{{NAME}}_checking_overflow(a, -b, overflow);
  150. }
  151. static CYTHON_INLINE {{INT}} __Pyx_mul_{{NAME}}_checking_overflow({{INT}} a, {{INT}} b, int *overflow) {
  152. if (sizeof({{INT}}) < sizeof(long)) {
  153. long big_r = ((long) a) * ((long) b);
  154. {{INT}} r = ({{INT}}) big_r;
  155. *overflow |= big_r != r;
  156. return ({{INT}}) r;
  157. #ifdef HAVE_LONG_LONG
  158. } else if (sizeof({{INT}}) < sizeof(PY_LONG_LONG)) {
  159. PY_LONG_LONG big_r = ((PY_LONG_LONG) a) * ((PY_LONG_LONG) b);
  160. {{INT}} r = ({{INT}}) big_r;
  161. *overflow |= big_r != r;
  162. return ({{INT}}) r;
  163. #endif
  164. } else {
  165. {{INT}} prod = a * b;
  166. double dprod = ((double) a) * ((double) b);
  167. // Overflow results in an error of at least 2^sizeof(INT),
  168. // whereas rounding represents an error on the order of 2^(sizeof(INT)-53).
  169. *overflow |= fabs(dprod - prod) > (__PYX_MAX({{INT}}) / 2);
  170. return prod;
  171. }
  172. }
  173. static CYTHON_INLINE {{INT}} __Pyx_mul_const_{{NAME}}_checking_overflow({{INT}} a, {{INT}} b, int *overflow) {
  174. if (b > 1) {
  175. *overflow |= a > __PYX_MAX({{INT}}) / b;
  176. *overflow |= a < __PYX_MIN({{INT}}) / b;
  177. } else if (b == -1) {
  178. *overflow |= a == __PYX_MIN({{INT}});
  179. } else if (b < -1) {
  180. *overflow |= a > __PYX_MIN({{INT}}) / b;
  181. *overflow |= a < __PYX_MAX({{INT}}) / b;
  182. }
  183. return a * b;
  184. }
  185. static CYTHON_INLINE {{INT}} __Pyx_div_{{NAME}}_checking_overflow({{INT}} a, {{INT}} b, int *overflow) {
  186. if (b == 0) {
  187. *overflow |= 1;
  188. return 0;
  189. }
  190. *overflow |= (a == __PYX_MIN({{INT}})) & (b == -1);
  191. return a / b;
  192. }
  193. /////////////// SizeCheck.init ///////////////
  194. __Pyx_check_sane_{{NAME}}();
  195. /////////////// SizeCheck.proto ///////////////
  196. static int __Pyx_check_sane_{{NAME}}(void) {
  197. if (sizeof({{TYPE}}) <= sizeof(int) ||
  198. #ifdef HAVE_LONG_LONG
  199. sizeof({{TYPE}}) == sizeof(PY_LONG_LONG) ||
  200. #endif
  201. sizeof({{TYPE}}) == sizeof(long)) {
  202. return 0;
  203. } else {
  204. PyErr_Format(PyExc_RuntimeError, \
  205. "Bad size for int type %.{{max(60, len(TYPE))}}s: %d", "{{TYPE}}", (int) sizeof({{TYPE}}));
  206. return 1;
  207. }
  208. }
  209. /////////////// Binop.proto ///////////////
  210. static CYTHON_INLINE {{TYPE}} __Pyx_{{BINOP}}_{{NAME}}_checking_overflow({{TYPE}} a, {{TYPE}} b, int *overflow);
  211. /////////////// Binop ///////////////
  212. static CYTHON_INLINE {{TYPE}} __Pyx_{{BINOP}}_{{NAME}}_checking_overflow({{TYPE}} a, {{TYPE}} b, int *overflow) {
  213. if (sizeof({{TYPE}}) < sizeof(int)) {
  214. return __Pyx_{{BINOP}}_no_overflow(a, b, overflow);
  215. } else if (__PYX_IS_UNSIGNED({{TYPE}})) {
  216. if (sizeof({{TYPE}}) == sizeof(unsigned int)) {
  217. return __Pyx_{{BINOP}}_unsigned_int_checking_overflow(a, b, overflow);
  218. } else if (sizeof({{TYPE}}) == sizeof(unsigned long)) {
  219. return __Pyx_{{BINOP}}_unsigned_long_checking_overflow(a, b, overflow);
  220. #ifdef HAVE_LONG_LONG
  221. } else if (sizeof({{TYPE}}) == sizeof(unsigned PY_LONG_LONG)) {
  222. return __Pyx_{{BINOP}}_unsigned_long_long_checking_overflow(a, b, overflow);
  223. #endif
  224. } else {
  225. abort(); return 0; /* handled elsewhere */
  226. }
  227. } else {
  228. if (sizeof({{TYPE}}) == sizeof(int)) {
  229. return __Pyx_{{BINOP}}_int_checking_overflow(a, b, overflow);
  230. } else if (sizeof({{TYPE}}) == sizeof(long)) {
  231. return __Pyx_{{BINOP}}_long_checking_overflow(a, b, overflow);
  232. #ifdef HAVE_LONG_LONG
  233. } else if (sizeof({{TYPE}}) == sizeof(PY_LONG_LONG)) {
  234. return __Pyx_{{BINOP}}_long_long_checking_overflow(a, b, overflow);
  235. #endif
  236. } else {
  237. abort(); return 0; /* handled elsewhere */
  238. }
  239. }
  240. }
  241. /////////////// LeftShift.proto ///////////////
  242. static CYTHON_INLINE {{TYPE}} __Pyx_lshift_{{NAME}}_checking_overflow({{TYPE}} a, {{TYPE}} b, int *overflow) {
  243. *overflow |=
  244. #if {{SIGNED}}
  245. (b < 0) |
  246. #endif
  247. (b > ({{TYPE}}) (8 * sizeof({{TYPE}}))) | (a > (__PYX_MAX({{TYPE}}) >> b));
  248. return a << b;
  249. }
  250. #define __Pyx_lshift_const_{{NAME}}_checking_overflow __Pyx_lshift_{{NAME}}_checking_overflow
  251. /////////////// UnaryNegOverflows.proto ///////////////
  252. //FIXME: shouldn't the macro name be prefixed by "__Pyx_" ? Too late now, I guess...
  253. // from intobject.c
  254. #define UNARY_NEG_WOULD_OVERFLOW(x) \
  255. (((x) < 0) & ((unsigned long)(x) == 0-(unsigned long)(x)))