1 /* Interface to replace gmp-impl.h
3 Copyright 2004-2015 Free Software Foundation, Inc.
4 Contributed by the AriC and Caramel projects, INRIA.
6 This file is part of the GNU MPFR Library.
8 The GNU MPFR Library is free software; you can redistribute it and/or modify
9 it under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or (at your
11 option) any later version.
13 The GNU MPFR Library is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
16 License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with the GNU MPFR Library; see the file COPYING.LESSER. If not, see
20 http://www.gnu.org/licenses/ or write to the Free Software Foundation, Inc.,
21 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */
23 #ifndef __GMPFR_GMP_H__
24 #define __GMPFR_GMP_H__
26 #ifndef __MPFR_IMPL_H__
27 # error "mpfr-impl.h not included"
30 #include <limits.h> /* For INT_MAX, ... */
31 #include <string.h> /* For memcpy, memset and memmove */
33 /* The following tries to get a good version of alloca.
34 See gmp-impl.h for implementation details and original version */
35 /* FIXME: the autoconf manual gives a different piece of code under the
36 documentation of the AC_FUNC_ALLOCA macro. Should we switch to it? */
38 # if defined ( __GNUC__ )
39 # define alloca __builtin_alloca
40 # elif defined (__DECC)
41 # define alloca(x) __ALLOCA(x)
42 # elif defined (_MSC_VER)
44 # define alloca _alloca
45 # elif defined (HAVE_ALLOCA_H)
47 # elif defined (_AIX) || defined (_IBMR2)
50 void *alloca (size_t);
54 #if defined (__cplusplus)
58 /* Define GMP_NUMB_BITS
59 Can't use sizeof(mp_limb_t) since it should be a preprocessor constant */
60 #if defined(GMP_NUMB_BITS) /* GMP 4.1.2 or above */
62 # define GMP_NUMB_BITS (GMP_NUMB_BITS+GMP_NAIL_BITS)
64 #elif defined (__GMP_GMP_NUMB_BITS) /* Older versions 4.x.x */
65 # define GMP_NUMB_BITS __GMP_GMP_NUMB_BITS
66 # define GMP_NUMB_BITS GMP_NUMB_BITS
67 # ifndef GMP_NAIL_BITS
68 # define GMP_NAIL_BITS 0
71 # error "Could not detect GMP_NUMB_BITS. Try with gmp internal files."
74 /* Define some macros */
76 #define MP_LIMB_T_MAX (~(mp_limb_t)0)
78 #define ULONG_HIGHBIT (ULONG_MAX ^ ((unsigned long) ULONG_MAX >> 1))
79 #define UINT_HIGHBIT (UINT_MAX ^ ((unsigned) UINT_MAX >> 1))
80 #define USHRT_HIGHBIT ((unsigned short) (USHRT_MAX ^ ((unsigned short) USHRT_MAX >> 1)))
82 #define GMP_LIMB_HIGHBIT (MP_LIMB_T_MAX ^ (MP_LIMB_T_MAX >> 1))
85 #if __GMP_MP_SIZE_T_INT
86 #define MP_SIZE_T_MAX INT_MAX
87 #define MP_SIZE_T_MIN INT_MIN
89 #define MP_SIZE_T_MAX LONG_MAX
90 #define MP_SIZE_T_MIN LONG_MIN
93 #define LONG_HIGHBIT LONG_MIN
94 #define INT_HIGHBIT INT_MIN
95 #define SHRT_HIGHBIT SHRT_MIN
98 #define MPN_ZERO(dst, n) memset((dst), 0, (n)*MPFR_BYTES_PER_MP_LIMB)
99 #define MPN_COPY_DECR(dst,src,n) memmove((dst),(src),(n)*MPFR_BYTES_PER_MP_LIMB)
100 #define MPN_COPY_INCR(dst,src,n) memmove((dst),(src),(n)*MPFR_BYTES_PER_MP_LIMB)
101 #define MPN_COPY(dst,src,n) \
104 if ((dst) != (src)) \
106 MPFR_ASSERTD ((char *) (dst) >= (char *) (src) + \
107 (n) * MPFR_BYTES_PER_MP_LIMB || \
108 (char *) (src) >= (char *) (dst) + \
109 (n) * MPFR_BYTES_PER_MP_LIMB); \
110 memcpy ((dst), (src), (n) * MPFR_BYTES_PER_MP_LIMB); \
115 /* MPN macros taken from gmp-impl.h */
116 #define MPN_NORMALIZE(DST, NLIMBS) \
120 if ((DST)[(NLIMBS) - 1] != 0) \
125 #define MPN_NORMALIZE_NOT_ZERO(DST, NLIMBS) \
127 MPFR_ASSERTD ((NLIMBS) >= 1); \
130 if ((DST)[(NLIMBS) - 1] != 0) \
135 #define MPN_OVERLAP_P(xp, xsize, yp, ysize) \
136 ((xp) + (xsize) > (yp) && (yp) + (ysize) > (xp))
137 #define MPN_SAME_OR_INCR2_P(dst, dsize, src, ssize) \
138 ((dst) <= (src) || ! MPN_OVERLAP_P (dst, dsize, src, ssize))
139 #define MPN_SAME_OR_INCR_P(dst, src, size) \
140 MPN_SAME_OR_INCR2_P(dst, size, src, size)
141 #define MPN_SAME_OR_DECR2_P(dst, dsize, src, ssize) \
142 ((dst) >= (src) || ! MPN_OVERLAP_P (dst, dsize, src, ssize))
143 #define MPN_SAME_OR_DECR_P(dst, src, size) \
144 MPN_SAME_OR_DECR2_P(dst, size, src, size)
146 /* If mul_basecase or mpn_sqr_basecase are not exported, used mpn_mul instead */
147 #ifndef mpn_mul_basecase
148 # define mpn_mul_basecase(dst,s1,n1,s2,n2) mpn_mul((dst),(s1),(n1),(s2),(n2))
150 #ifndef mpn_sqr_basecase
151 # define mpn_sqr_basecase(dst,src,n) mpn_mul((dst),(src),(n),(src),(n))
155 __MPFR_DECLSPEC
void mpfr_assert_fail
_MPFR_PROTO((const char *, int,
158 #define ASSERT_FAIL(expr) mpfr_assert_fail (__FILE__, __LINE__, #expr)
159 #define ASSERT(expr) MPFR_ASSERTD(expr)
161 /* Access fileds of GMP struct */
162 #define SIZ(x) ((x)->_mp_size)
163 #define ABSIZ(x) ABS (SIZ (x))
164 #define PTR(x) ((x)->_mp_d)
165 #define EXP(x) ((x)->_mp_exp)
166 #define PREC(x) ((x)->_mp_prec)
167 #define ALLOC(x) ((x)->_mp_alloc)
168 #define MPZ_REALLOC(z,n) ((n) > ALLOC(z) ? _mpz_realloc(z,n) : PTR(z))
170 /* Non IEEE float supports -- needs to detect them with proper configure */
175 #ifdef HAVE_ATTRIBUTE_MODE
176 typedef unsigned int UQItype
__attribute__ ((mode (QI
)));
177 typedef int SItype
__attribute__ ((mode (SI
)));
178 typedef unsigned int USItype
__attribute__ ((mode (SI
)));
179 typedef int DItype
__attribute__ ((mode (DI
)));
180 typedef unsigned int UDItype
__attribute__ ((mode (DI
)));
182 typedef unsigned char UQItype
;
184 typedef unsigned long USItype
;
185 #ifdef HAVE_LONG_LONG
186 typedef long long int DItype
;
187 typedef unsigned long long int UDItype
;
188 #else /* Assume `long' gives us a wide enough type. Needed for hppa2.0w. */
189 typedef long int DItype
;
190 typedef unsigned long int UDItype
;
193 typedef mp_limb_t UWtype
;
194 typedef unsigned int UHWtype
;
195 #define W_TYPE_SIZE GMP_NUMB_BITS
197 /* Remap names of internal mpn functions (for longlong.h). */
199 #define __clz_tab mpfr_clz_tab
201 /* Use (4.0 * ...) instead of (2.0 * ...) to work around buggy compilers
202 that don't convert ulong->double correctly (eg. SunOS 4 native cc). */
203 #undef MP_BASE_AS_DOUBLE
204 #define MP_BASE_AS_DOUBLE (4.0 * ((mp_limb_t) 1 << (GMP_NUMB_BITS - 2)))
206 /* Structure for conversion between internal binary format and
207 strings in base 2..36. */
210 /* log(2)/log(conversion_base) */
211 double chars_per_bit_exactly
;
214 #define __mp_bases mpfr_bases
215 __MPFR_DECLSPEC
extern const struct bases mpfr_bases
[257];
217 /* Standard macros */
222 #define ABS(x) ((x) >= 0 ? (x) : -(x))
223 #define MIN(l,o) ((l) < (o) ? (l) : (o))
224 #define MAX(h,i) ((h) > (i) ? (h) : (i))
225 #define numberof(x) (sizeof (x) / sizeof ((x)[0]))
228 #undef __gmp_rands_initialized
230 #define __gmp_rands_initialized mpfr_rands_initialized
231 #define __gmp_rands mpfr_rands
233 __MPFR_DECLSPEC
extern char mpfr_rands_initialized
;
234 __MPFR_DECLSPEC
extern gmp_randstate_t mpfr_rands
;
238 ((__gmp_rands_initialized ? 0 \
239 : (__gmp_rands_initialized = 1, \
240 gmp_randinit_default (__gmp_rands), 0)), \
244 #define RANDS_CLEAR() \
246 if (__gmp_rands_initialized) \
248 __gmp_rands_initialized = 0; \
249 gmp_randclear (__gmp_rands); \
253 typedef __gmp_randstate_struct
*gmp_randstate_ptr
;
255 /* Allocate func are defined in gmp-impl.h */
257 /* In newer GMP, there aren't anymore __gmp_allocate_func,
258 __gmp_reallocate_func & __gmp_free_func in gmp.h
259 Just getting the correct value by calling mp_get_memory_functions */
260 #ifdef mp_get_memory_functions
262 #undef __gmp_allocate_func
263 #undef __gmp_reallocate_func
264 #undef __gmp_free_func
265 #define MPFR_GET_MEMFUNC \
266 ((void) (MPFR_LIKELY (mpfr_allocate_func != 0) || \
267 (mp_get_memory_functions(&mpfr_allocate_func, \
268 &mpfr_reallocate_func, \
269 &mpfr_free_func), 1)))
270 #define __gmp_allocate_func (MPFR_GET_MEMFUNC, mpfr_allocate_func)
271 #define __gmp_reallocate_func (MPFR_GET_MEMFUNC, mpfr_reallocate_func)
272 #define __gmp_free_func (MPFR_GET_MEMFUNC, mpfr_free_func)
273 __MPFR_DECLSPEC
extern MPFR_THREAD_ATTR
void * (*mpfr_allocate_func
) _MPFR_PROTO ((size_t));
274 __MPFR_DECLSPEC
extern MPFR_THREAD_ATTR
void * (*mpfr_reallocate_func
) _MPFR_PROTO ((void *, size_t, size_t));
275 __MPFR_DECLSPEC
extern MPFR_THREAD_ATTR
void (*mpfr_free_func
) _MPFR_PROTO ((void *, size_t));
279 #undef __gmp_default_allocate
280 #undef __gmp_default_reallocate
281 #undef __gmp_default_free
282 #define __gmp_default_allocate mpfr_default_allocate
283 #define __gmp_default_reallocate mpfr_default_reallocate
284 #define __gmp_default_free mpfr_default_free
285 __MPFR_DECLSPEC
void *__gmp_default_allocate
_MPFR_PROTO ((size_t));
286 __MPFR_DECLSPEC
void *__gmp_default_reallocate
_MPFR_PROTO ((void *, size_t,
288 __MPFR_DECLSPEC
void __gmp_default_free
_MPFR_PROTO ((void *, size_t));
290 #if defined(WANT_GMP_INTERNALS) && defined(HAVE___GMPN_ROOTREM)
291 #ifndef __gmpn_rootrem
292 __MPFR_DECLSPEC mp_size_t __gmpn_rootrem
_MPFR_PROTO ((mp_limb_t
*,
293 mp_limb_t
*, mp_limb_t
*, mp_size_t
, mp_limb_t
));
297 #if defined(WANT_GMP_INTERNALS) && defined(HAVE___GMPN_SBPI1_DIVAPPR_Q)
298 #ifndef __gmpn_sbpi1_divappr_q
299 __MPFR_DECLSPEC mp_limb_t __gmpn_sbpi1_divappr_q
_MPFR_PROTO ((mp_limb_t
*,
300 mp_limb_t
*, mp_size_t
, mp_limb_t
*, mp_size_t
, mp_limb_t
));
304 /* Temp memory allocate */
310 struct tmp_marker
*next
;
313 __MPFR_DECLSPEC
void *mpfr_tmp_allocate
_MPFR_PROTO ((struct tmp_marker
**,
315 __MPFR_DECLSPEC
void mpfr_tmp_free
_MPFR_PROTO ((struct tmp_marker
*));
317 /* Do not define TMP_SALLOC (see the test in mpfr-impl.h)! */
318 #define TMP_ALLOC(n) (MPFR_LIKELY ((n) < 16384) ? \
319 alloca (n) : mpfr_tmp_allocate (&tmp_marker, (n)))
320 #define TMP_DECL(m) struct tmp_marker *tmp_marker
321 #define TMP_MARK(m) (tmp_marker = 0)
322 #define TMP_FREE(m) mpfr_tmp_free (tmp_marker)
324 /* invert_limb macro, copied from GMP 5.0.2, file gmp-impl.h.
325 It returns invxl = floor((B^2-1)/xl)-B, where B=2^BITS_PER_LIMB,
326 assuming the most significant bit of xl is set. */
328 #define invert_limb(invxl,xl) \
331 MPFR_ASSERTD ((xl) != 0); \
332 udiv_qrnnd (invxl, dummy, ~(xl), ~(mp_limb_t)0, xl); \
335 typedef struct {mp_limb_t inv32
;} mpfr_pi1_t
; /* We changed gmp_pi1_t into
336 mpfr_pi1_t to avoid using
338 /* invert_pi1 macro, adapted from GMP 5.0.2, file gmp-impl.h.
339 It returns dinv = floor((B^3-1)/(d1*B+d0))-B, where B=2^BITS_PER_LIMB,
340 assuming the most significant bit of d1 is set. */
342 #define invert_pi1(dinv, d1, d0) \
344 mp_limb_t _v, _p, _t1, _t0, _mask; \
345 invert_limb (_v, d1); \
351 _mask = -(_p >= d1); \
356 umul_ppmm (_t1, _t0, d0, _v); \
361 if (MPFR_UNLIKELY (_p >= d1)) \
363 if (_p > d1 || _t0 >= d0) \
370 /* udiv_qr_3by2 macro, adapted from GMP 5.0.2, file gmp-impl.h.
371 Compute quotient the quotient and remainder for n / d. Requires d
372 >= B^2 / 2 and n < d B. dinv is the inverse
374 floor ((B^3 - 1) / (d0 + d1 B)) - B.
376 NOTE: Output variables are updated multiple times. Only some inputs
377 and outputs may overlap.
380 #define udiv_qr_3by2(q, r1, r0, n2, n1, n0, d1, d0, dinv) \
382 mp_limb_t _q0, _t1, _t0, _mask; \
383 umul_ppmm ((q), _q0, (n2), (dinv)); \
384 add_ssaaaa ((q), _q0, (q), _q0, (n2), (n1)); \
386 /* Compute the two most significant limbs of n - q'd */ \
387 (r1) = (n1) - (d1) * (q); \
389 sub_ddmmss ((r1), (r0), (r1), (r0), (d1), (d0)); \
390 umul_ppmm (_t1, _t0, (d0), (q)); \
391 sub_ddmmss ((r1), (r0), (r1), (r0), _t1, _t0); \
394 /* Conditionally adjust q and the remainders */ \
395 _mask = - (mp_limb_t) ((r1) >= _q0); \
397 add_ssaaaa ((r1), (r0), (r1), (r0), _mask & (d1), _mask & (d0)); \
398 if (MPFR_UNLIKELY ((r1) >= (d1))) \
400 if ((r1) > (d1) || (r0) >= (d0)) \
403 sub_ddmmss ((r1), (r0), (r1), (r0), (d1), (d0)); \
408 #if defined (__cplusplus)
412 #endif /* Gmp internal emulator */