blob: c1ed4a6901284f513dcf2651454b50aa0ba894a1 [file] [log] [blame]
Tim Peters7d3a5112000-07-08 04:17:21 +00001#ifndef Py_PYPORT_H
Vladimir Marangozov14a4d882000-07-10 04:59:49 +00002#define Py_PYPORT_H
Tim Peters7d3a5112000-07-08 04:17:21 +00003
Martin v. Löwis4f1cd8b2001-07-26 13:41:06 +00004#include "pyconfig.h" /* include for defines */
Peter Schneider-Kamp25f68942000-07-31 22:19:30 +00005
Thomas Wouters89f507f2006-12-13 04:49:30 +00006#ifdef HAVE_STDINT_H
7#include <stdint.h>
8#endif
9
Tim Peters7d3a5112000-07-08 04:17:21 +000010/**************************************************************************
11Symbols and macros to supply platform-independent interfaces to basic
Tim Peters1be46842000-07-23 18:10:18 +000012C language & library operations whose spellings vary across platforms.
Tim Peters7d3a5112000-07-08 04:17:21 +000013
14Please try to make documentation here as clear as possible: by definition,
15the stuff here is trying to illuminate C's darkest corners.
16
17Config #defines referenced here:
18
19SIGNED_RIGHT_SHIFT_ZERO_FILLS
20Meaning: To be defined iff i>>j does not extend the sign bit when i is a
21 signed integral type and i < 0.
22Used in: Py_ARITHMETIC_RIGHT_SHIFT
Tim Peters1be46842000-07-23 18:10:18 +000023
Tim Peters8315ea52000-07-23 19:28:35 +000024Py_DEBUG
25Meaning: Extra checks compiled in for debug mode.
26Used in: Py_SAFE_DOWNCAST
Barry Warsawfd847b22000-08-18 04:48:18 +000027
28HAVE_UINTPTR_T
29Meaning: The C9X type uintptr_t is supported by the compiler
30Used in: Py_uintptr_t
31
32HAVE_LONG_LONG
33Meaning: The compiler supports the C type "long long"
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000034Used in: PY_LONG_LONG
Barry Warsawfd847b22000-08-18 04:48:18 +000035
Tim Peters7d3a5112000-07-08 04:17:21 +000036**************************************************************************/
37
Barry Warsawfd847b22000-08-18 04:48:18 +000038/* typedefs for some C9X-defined synonyms for integral types.
39 *
40 * The names in Python are exactly the same as the C9X names, except with a
41 * Py_ prefix. Until C9X is universally implemented, this is the only way
42 * to ensure that Python gets reliable names that don't conflict with names
43 * in non-Python code that are playing their own tricks to define the C9X
44 * names.
45 *
46 * NOTE: don't go nuts here! Python has no use for *most* of the C9X
47 * integral synonyms. Only define the ones we actually need.
48 */
49
50#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000051#ifndef PY_LONG_LONG
52#define PY_LONG_LONG long long
Guido van Rossumcd16bf62007-06-13 18:07:49 +000053#if defined(LLONG_MAX)
54/* If LLONG_MAX is defined in limits.h, use that. */
55#define PY_LLONG_MIN LLONG_MIN
56#define PY_LLONG_MAX LLONG_MAX
57#define PY_ULLONG_MAX ULLONG_MAX
58#elif defined(__LONG_LONG_MAX__)
59/* Otherwise, if GCC has a builtin define, use that. */
60#define PY_LLONG_MAX __LONG_LONG_MAX__
61#define PY_LLONG_MIN (-PY_LLONG_MAX-1)
62#define PY_ULLONG_MAX (__LONG_LONG_MAX__*2ULL + 1ULL)
63#else
64/* Otherwise, rely on two's complement. */
65#define PY_ULLONG_MAX (~0ULL)
66#define PY_LLONG_MAX ((long long)(PY_ULLONG_MAX>>1))
67#define PY_LLONG_MIN (-PY_LLONG_MAX-1)
68#endif /* LLONG_MAX */
Barry Warsawfd847b22000-08-18 04:48:18 +000069#endif
70#endif /* HAVE_LONG_LONG */
71
Mark Dickinsonbd792642009-03-18 20:06:12 +000072/* a build with 30-bit digits for Python long integers needs an exact-width
73 * 32-bit unsigned integer type to store those digits. (We could just use
74 * type 'unsigned long', but that would be wasteful on a system where longs
75 * are 64-bits.) On Unix systems, the autoconf macro AC_TYPE_UINT32_T defines
76 * uint32_t to be such a type unless stdint.h or inttypes.h defines uint32_t.
77 * However, it doesn't set HAVE_UINT32_T, so we do that here.
78 */
79#if (defined UINT32_MAX || defined uint32_t)
80#ifndef PY_UINT32_T
81#define HAVE_UINT32_T 1
82#define PY_UINT32_T uint32_t
83#endif
84#endif
85
86/* Macros for a 64-bit unsigned integer type; used for type 'twodigits' in the
87 * long integer implementation, when 30-bit digits are enabled.
88 */
89#if (defined UINT64_MAX || defined uint64_t)
90#ifndef PY_UINT64_T
91#define HAVE_UINT64_T 1
92#define PY_UINT64_T uint64_t
93#endif
94#endif
95
96/* Signed variants of the above */
97#if (defined INT32_MAX || defined int32_t)
98#ifndef PY_INT32_T
99#define HAVE_INT32_T 1
100#define PY_INT32_T int32_t
101#endif
102#endif
103#if (defined INT64_MAX || defined int64_t)
104#ifndef PY_INT64_T
105#define HAVE_INT64_T 1
106#define PY_INT64_T int64_t
107#endif
108#endif
109
110/* If PYLONG_BITS_IN_DIGIT is not defined then we'll use 30-bit digits if all
111 the necessary integer types are available, and we're on a 64-bit platform
112 (as determined by SIZEOF_VOID_P); otherwise we use 15-bit digits. */
113
114#ifndef PYLONG_BITS_IN_DIGIT
115#if (defined HAVE_UINT64_T && defined HAVE_INT64_T && \
116 defined HAVE_UINT32_T && defined HAVE_INT32_T && SIZEOF_VOID_P >= 8)
117#define PYLONG_BITS_IN_DIGIT 30
118#else
119#define PYLONG_BITS_IN_DIGIT 15
120#endif
121#endif
122
Barry Warsawfd847b22000-08-18 04:48:18 +0000123/* uintptr_t is the C9X name for an unsigned integral type such that a
124 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +0000125 * without loss of information. Similarly for intptr_t, wrt a signed
126 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +0000127 */
128#ifdef HAVE_UINTPTR_T
Tim Peters79248aa2001-08-29 21:37:10 +0000129typedef uintptr_t Py_uintptr_t;
130typedef intptr_t Py_intptr_t;
131
Barry Warsawfd847b22000-08-18 04:48:18 +0000132#elif SIZEOF_VOID_P <= SIZEOF_INT
Tim Peters79248aa2001-08-29 21:37:10 +0000133typedef unsigned int Py_uintptr_t;
134typedef int Py_intptr_t;
135
Barry Warsawfd847b22000-08-18 04:48:18 +0000136#elif SIZEOF_VOID_P <= SIZEOF_LONG
Tim Peters79248aa2001-08-29 21:37:10 +0000137typedef unsigned long Py_uintptr_t;
138typedef long Py_intptr_t;
139
Barry Warsawfd847b22000-08-18 04:48:18 +0000140#elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000141typedef unsigned PY_LONG_LONG Py_uintptr_t;
142typedef PY_LONG_LONG Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +0000143
Barry Warsawfd847b22000-08-18 04:48:18 +0000144#else
145# error "Python needs a typedef for Py_uintptr_t in pyport.h."
146#endif /* HAVE_UINTPTR_T */
147
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000148/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
149 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
150 * unsigned integral type). See PEP 353 for details.
151 */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000152#ifdef HAVE_SSIZE_T
153typedef ssize_t Py_ssize_t;
154#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Martin v. Löwis2d65b552006-02-18 18:26:55 +0000155typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000156#else
157# error "Python needs a typedef for Py_ssize_t in pyport.h."
158#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000159
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +0000160/* Largest possible value of size_t.
161 SIZE_MAX is part of C99, so it might be defined on some
162 platforms. If it is not defined, (size_t)-1 is a portable
163 definition for C89, due to the way signed->unsigned
164 conversion is defined. */
165#ifdef SIZE_MAX
166#define PY_SIZE_MAX SIZE_MAX
167#else
168#define PY_SIZE_MAX ((size_t)-1)
169#endif
170
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000171/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000172#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000173/* Smallest negative value of type Py_ssize_t. */
174#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
175
Christian Heimes400adb02008-02-01 08:12:03 +0000176#if SIZEOF_PID_T > SIZEOF_LONG
177# error "Python doesn't support sizeof(pid_t) > sizeof(long)"
178#endif
179
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000180/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
181 * format to convert an argument with the width of a size_t or Py_ssize_t.
182 * C99 introduced "z" for this purpose, but not all platforms support that;
183 * e.g., MS compilers use "I" instead.
184 *
185 * These "high level" Python format functions interpret "z" correctly on
186 * all platforms (Python interprets the format string itself, and does whatever
187 * the platform C requires to convert a size_t/Py_ssize_t argument):
188 *
Christian Heimes72b710a2008-05-26 13:28:38 +0000189 * PyBytes_FromFormat
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000190 * PyErr_Format
Christian Heimes72b710a2008-05-26 13:28:38 +0000191 * PyBytes_FromFormatV
Walter Dörwald7696ed72007-05-31 15:51:35 +0000192 * PyUnicode_FromFormatV
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000193 *
194 * Lower-level uses require that you interpolate the correct format modifier
195 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
196 * example,
197 *
198 * Py_ssize_t index;
199 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
200 *
201 * That will expand to %ld, or %Id, or to something else correct for a
202 * Py_ssize_t on the platform.
203 */
204#ifndef PY_FORMAT_SIZE_T
Thomas Wouters89f507f2006-12-13 04:49:30 +0000205# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000206# define PY_FORMAT_SIZE_T ""
207# elif SIZEOF_SIZE_T == SIZEOF_LONG
208# define PY_FORMAT_SIZE_T "l"
209# elif defined(MS_WINDOWS)
210# define PY_FORMAT_SIZE_T "I"
211# else
212# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
213# endif
214#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000215
Thomas Wouters477c8d52006-05-27 19:21:47 +0000216/* Py_LOCAL can be used instead of static to get the fastest possible calling
217 * convention for functions that are local to a given module.
218 *
219 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
220 * for platforms that support that.
221 *
222 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
223 * "aggressive" inlining/optimizaion is enabled for the entire module. This
224 * may lead to code bloat, and may slow things down for those reasons. It may
225 * also lead to errors, if the code relies on pointer aliasing. Use with
226 * care.
227 *
228 * NOTE: You can only use this for functions that are entirely local to a
229 * module; functions that are exported via method tables, callbacks, etc,
230 * should keep using static.
231 */
232
233#undef USE_INLINE /* XXX - set via configure? */
234
235#if defined(_MSC_VER)
236#if defined(PY_LOCAL_AGGRESSIVE)
237/* enable more aggressive optimization for visual studio */
238#pragma optimize("agtw", on)
239#endif
240/* ignore warnings if the compiler decides not to inline a function */
241#pragma warning(disable: 4710)
242/* fastest possible local call under MSVC */
243#define Py_LOCAL(type) static type __fastcall
244#define Py_LOCAL_INLINE(type) static __inline type __fastcall
245#elif defined(USE_INLINE)
246#define Py_LOCAL(type) static type
247#define Py_LOCAL_INLINE(type) static inline type
248#else
249#define Py_LOCAL(type) static type
250#define Py_LOCAL_INLINE(type) static type
251#endif
252
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000253/* Py_MEMCPY can be used instead of memcpy in cases where the copied blocks
254 * are often very short. While most platforms have highly optimized code for
255 * large transfers, the setup costs for memcpy are often quite high. MEMCPY
256 * solves this by doing short copies "in line".
257 */
258
259#if defined(_MSC_VER)
260#define Py_MEMCPY(target, source, length) do { \
261 size_t i_, n_ = (length); \
262 char *t_ = (void*) (target); \
263 const char *s_ = (void*) (source); \
264 if (n_ >= 16) \
265 memcpy(t_, s_, n_); \
266 else \
267 for (i_ = 0; i_ < n_; i_++) \
268 t_[i_] = s_[i_]; \
269 } while (0)
270#else
271#define Py_MEMCPY memcpy
272#endif
273
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000274#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000275
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000276#include <math.h> /* Moved here from the math section, before extern "C" */
277
278/********************************************
279 * WRAPPER FOR <time.h> and/or <sys/time.h> *
280 ********************************************/
281
282#ifdef TIME_WITH_SYS_TIME
283#include <sys/time.h>
284#include <time.h>
285#else /* !TIME_WITH_SYS_TIME */
286#ifdef HAVE_SYS_TIME_H
287#include <sys/time.h>
288#else /* !HAVE_SYS_TIME_H */
289#include <time.h>
290#endif /* !HAVE_SYS_TIME_H */
291#endif /* !TIME_WITH_SYS_TIME */
292
293
294/******************************
295 * WRAPPER FOR <sys/select.h> *
296 ******************************/
297
298/* NB caller must include <sys/types.h> */
299
300#ifdef HAVE_SYS_SELECT_H
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000301#include <sys/select.h>
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000302#endif /* !HAVE_SYS_SELECT_H */
303
Tim Peters60f42b52001-01-18 03:03:16 +0000304/*******************************
305 * stat() and fstat() fiddling *
306 *******************************/
307
308/* We expect that stat and fstat exist on most systems.
309 * It's confirmed on Unix, Mac and Windows.
310 * If you don't have them, add
311 * #define DONT_HAVE_STAT
312 * and/or
313 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000314 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000315 * HAVE_FSTAT instead.
316 * Also
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000317 * #define HAVE_SYS_STAT_H
318 * if <sys/stat.h> exists on your platform, and
Tim Peters60f42b52001-01-18 03:03:16 +0000319 * #define HAVE_STAT_H
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000320 * if <stat.h> does.
Tim Peters60f42b52001-01-18 03:03:16 +0000321 */
322#ifndef DONT_HAVE_STAT
323#define HAVE_STAT
324#endif
325
326#ifndef DONT_HAVE_FSTAT
327#define HAVE_FSTAT
328#endif
329
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000330#ifdef HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000331#if defined(PYOS_OS2) && defined(PYCC_GCC)
332#include <sys/types.h>
333#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000334#include <sys/stat.h>
335#elif defined(HAVE_STAT_H)
336#include <stat.h>
337#endif
338
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000339#if defined(PYCC_VACPP)
340/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
341#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
342#endif
343
344#ifndef S_ISREG
345#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
346#endif
347
348#ifndef S_ISDIR
349#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
350#endif
351
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000352
Tim Peters7d3a5112000-07-08 04:17:21 +0000353#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000354/* Move this down here since some C++ #include's don't like to be included
355 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000356extern "C" {
357#endif
358
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000359
Tim Peters7d3a5112000-07-08 04:17:21 +0000360/* Py_ARITHMETIC_RIGHT_SHIFT
361 * C doesn't define whether a right-shift of a signed integer sign-extends
362 * or zero-fills. Here a macro to force sign extension:
363 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
Mark Dickinson16f966e2009-03-20 23:23:15 +0000364 * Return I >> J, forcing sign extension. Arithmetically, return the
365 * floor of I/2**J.
Tim Peters7d3a5112000-07-08 04:17:21 +0000366 * Requirements:
Mark Dickinson16f966e2009-03-20 23:23:15 +0000367 * I should have signed integer type. In the terminology of C99, this can
368 * be either one of the five standard signed integer types (signed char,
369 * short, int, long, long long) or an extended signed integer type.
370 * J is an integer >= 0 and strictly less than the number of bits in the
371 * type of I (because C doesn't define what happens for J outside that
372 * range either).
373 * TYPE used to specify the type of I, but is now ignored. It's been left
374 * in for backwards compatibility with versions <= 2.6 or 3.0.
Tim Peters7d3a5112000-07-08 04:17:21 +0000375 * Caution:
376 * I may be evaluated more than once.
377 */
378#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
379#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
Mark Dickinson16f966e2009-03-20 23:23:15 +0000380 ((I) < 0 ? -1-((-1-(I)) >> (J)) : (I) >> (J))
Tim Peters7d3a5112000-07-08 04:17:21 +0000381#else
382#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
383#endif
384
Tim Peters39dce292000-08-15 03:34:48 +0000385/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000386 * "Simply" returns its argument. However, macro expansions within the
387 * argument are evaluated. This unfortunate trickery is needed to get
388 * token-pasting to work as desired in some cases.
389 */
390#define Py_FORCE_EXPANSION(X) X
391
Tim Peters8315ea52000-07-23 19:28:35 +0000392/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
393 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
394 * assert-fails if any information is lost.
395 * Caution:
396 * VALUE may be evaluated more than once.
397 */
398#ifdef Py_DEBUG
399#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
400 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
401#else
402#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
403#endif
404
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000405/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000406 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000407 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
408 * to 0 before calling a libm function, and invoke this macro after,
409 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000410 * Caution:
411 * This isn't reliable. See Py_OVERFLOWED comments.
412 * X is evaluated more than once.
413 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000414#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000415#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
416#else
417#define _Py_SET_EDOM_FOR_NAN(X) ;
418#endif
419#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000420 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000421 if (errno == 0) { \
422 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
423 errno = ERANGE; \
424 else _Py_SET_EDOM_FOR_NAN(X) \
425 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000426 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000427
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000428/* Py_SET_ERANGE_ON_OVERFLOW(x)
429 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
430 */
431#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
432
Tim Petersdc5a5082002-03-09 04:58:24 +0000433/* Py_ADJUST_ERANGE1(x)
434 * Py_ADJUST_ERANGE2(x, y)
435 * Set errno to 0 before calling a libm function, and invoke one of these
436 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
437 * for functions returning complex results). This makes two kinds of
438 * adjustments to errno: (A) If it looks like the platform libm set
439 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
440 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
441 * effect, we're trying to force a useful implementation of C89 errno
442 * behavior.
443 * Caution:
444 * This isn't reliable. See Py_OVERFLOWED comments.
445 * X and Y may be evaluated more than once.
446 */
447#define Py_ADJUST_ERANGE1(X) \
448 do { \
449 if (errno == 0) { \
450 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
451 errno = ERANGE; \
452 } \
453 else if (errno == ERANGE && (X) == 0.0) \
454 errno = 0; \
455 } while(0)
456
457#define Py_ADJUST_ERANGE2(X, Y) \
458 do { \
459 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
460 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
461 if (errno == 0) \
462 errno = ERANGE; \
463 } \
464 else if (errno == ERANGE) \
465 errno = 0; \
466 } while(0)
467
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000468/* The functions _Py_dg_strtod and _Py_dg_dtoa in Python/dtoa.c require that
469 the FPU is using 53-bit precision. Here are macros that force this. See
470 Python/pystrtod.c for an example of their use. */
471
Mark Dickinson7abf8d42009-04-18 20:17:52 +0000472#ifdef HAVE_GCC_ASM_FOR_X87
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000473#define _Py_SET_53BIT_PRECISION_HEADER \
474 unsigned short old_387controlword, new_387controlword
475#define _Py_SET_53BIT_PRECISION_START \
476 do { \
477 old_387controlword = _Py_get_387controlword(); \
478 new_387controlword = (old_387controlword & ~0x0f00) | 0x0200; \
479 if (new_387controlword != old_387controlword) \
480 _Py_set_387controlword(new_387controlword); \
481 } while (0)
482#define _Py_SET_53BIT_PRECISION_END \
483 if (new_387controlword != old_387controlword) \
484 _Py_set_387controlword(old_387controlword)
485#else
486#define _Py_SET_53BIT_PRECISION_HEADER
487#define _Py_SET_53BIT_PRECISION_START
488#define _Py_SET_53BIT_PRECISION_END
489#endif
490
491/* If we can't guarantee 53-bit precision, don't use the code
492 in Python/dtoa.c, but fall back to standard code. This
493 means that repr of a float will be long (17 sig digits).
494
495 Realistically, there are two things that could go wrong:
496
497 (1) doubles aren't IEEE 754 doubles, or
498 (2) we're on x86 with the rounding precision set to 64-bits
499 (extended precision), and we don't know how to change
500 the rounding precision.
501 */
502
503#if !defined(DOUBLE_IS_LITTLE_ENDIAN_IEEE754) && \
504 !defined(DOUBLE_IS_BIG_ENDIAN_IEEE754) && \
505 !defined(DOUBLE_IS_ARM_MIXED_ENDIAN_IEEE754)
506#define PY_NO_SHORT_FLOAT_REPR
507#endif
508
Mark Dickinson60fd0992009-04-18 10:16:35 +0000509/* double rounding is symptomatic of use of extended precision on x86. If
510 we're seeing double rounding, and we don't have any mechanism available for
511 changing the FPU rounding precision, then don't use Python/dtoa.c. */
512#if defined(X87_DOUBLE_ROUNDING) && !defined(HAVE_GCC_ASM_FOR_X87)
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000513#define PY_NO_SHORT_FLOAT_REPR
514#endif
515
516
Neal Norwitz80292642002-12-19 15:12:26 +0000517/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000518 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000519 * Usage:
520 * extern int old_var Py_DEPRECATED(2.3);
521 * typedef int T1 Py_DEPRECATED(2.4);
522 * extern int x() Py_DEPRECATED(2.5);
523 */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000524#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
525 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000526#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
527#else
Tim Peters4643bd92002-12-28 21:56:08 +0000528#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000529#endif
530
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000531/**************************************************************************
532Prototypes that are missing from the standard include files on some systems
533(and possibly only some versions of such systems.)
534
535Please be conservative with adding new ones, document them and enclose them
536in platform-specific #ifdefs.
537**************************************************************************/
538
539#ifdef SOLARIS
540/* Unchecked */
541extern int gethostname(char *, int);
542#endif
543
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000544#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000545#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000546extern char * _getpty(int *, int, mode_t, int);
547#endif
548
Georg Brandlf78e02b2008-06-10 17:40:04 +0000549/* On QNX 6, struct termio must be declared by including sys/termio.h
550 if TCGETA, TCSETA, TCSETAW, or TCSETAF are used. sys/termio.h must
551 be included before termios.h or it will generate an error. */
552#ifdef HAVE_SYS_TERMIO_H
553#include <sys/termio.h>
554#endif
555
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000556#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
557#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
558/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
559 functions, even though they are included in libutil. */
560#include <termios.h>
561extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
Christian Heimes400adb02008-02-01 08:12:03 +0000562extern pid_t forkpty(int *, char *, struct termios *, struct winsize *);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000563#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
564#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
565
566
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000567/* On 4.4BSD-descendants, ctype functions serves the whole range of
568 * wchar_t character set rather than single byte code points only.
569 * This characteristic can break some operations of string object
570 * including str.upper() and str.split() on UTF-8 locales. This
571 * workaround was provided by Tim Robbins of FreeBSD project.
572 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000573
574#ifdef __FreeBSD__
575#include <osreldate.h>
576#if __FreeBSD_version > 500039
577#include <ctype.h>
578#include <wctype.h>
579#undef isalnum
580#define isalnum(c) iswalnum(btowc(c))
581#undef isalpha
582#define isalpha(c) iswalpha(btowc(c))
583#undef islower
584#define islower(c) iswlower(btowc(c))
585#undef isspace
586#define isspace(c) iswspace(btowc(c))
587#undef isupper
588#define isupper(c) iswupper(btowc(c))
589#undef tolower
590#define tolower(c) towlower(btowc(c))
591#undef toupper
592#define toupper(c) towupper(btowc(c))
593#endif
594#endif
595
596
Mark Hammond8235ea12002-07-19 06:55:41 +0000597/* Declarations for symbol visibility.
598
599 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000600 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000601 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000602 inside the Python core, they are private to the core.
603 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000604 external linkage depending on the platform.
605
606 As a number of platforms support/require "__declspec(dllimport/dllexport)",
607 we support a HAVE_DECLSPEC_DLL macro to save duplication.
608*/
609
Tim Peters4643bd92002-12-28 21:56:08 +0000610/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000611 All windows ports, except cygwin, are handled in PC/pyconfig.h.
612
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000613 Cygwin is the only other autoconf platform requiring special
614 linkage handling and it uses __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000615*/
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000616#if defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000617# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000618#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000619
Jason Tishler30765592003-09-04 11:04:06 +0000620/* only get special linkage if built as shared or platform is Cygwin */
621#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000622# if defined(HAVE_DECLSPEC_DLL)
623# ifdef Py_BUILD_CORE
624# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000625# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000626 /* module init functions inside the core need no external linkage */
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000627 /* except for Cygwin to handle embedding */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000628# if defined(__CYGWIN__)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000629# define PyMODINIT_FUNC __declspec(dllexport) PyObject*
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000630# else /* __CYGWIN__ */
Martin v. Löwis1a214512008-06-11 05:26:20 +0000631# define PyMODINIT_FUNC PyObject*
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000632# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000633# else /* Py_BUILD_CORE */
634 /* Building an extension module, or an embedded situation */
635 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000636 /* Under Cygwin, auto-import functions to prevent compilation */
637 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
638# if !defined(__CYGWIN__)
639# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
640# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000641# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000642 /* module init functions outside the core must be exported */
643# if defined(__cplusplus)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000644# define PyMODINIT_FUNC extern "C" __declspec(dllexport) PyObject*
Mark Hammond8235ea12002-07-19 06:55:41 +0000645# else /* __cplusplus */
Martin v. Löwis1a214512008-06-11 05:26:20 +0000646# define PyMODINIT_FUNC __declspec(dllexport) PyObject*
Mark Hammond8235ea12002-07-19 06:55:41 +0000647# endif /* __cplusplus */
648# endif /* Py_BUILD_CORE */
649# endif /* HAVE_DECLSPEC */
650#endif /* Py_ENABLE_SHARED */
651
652/* If no external linkage macros defined by now, create defaults */
653#ifndef PyAPI_FUNC
654# define PyAPI_FUNC(RTYPE) RTYPE
655#endif
656#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000657# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000658#endif
659#ifndef PyMODINIT_FUNC
660# if defined(__cplusplus)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000661# define PyMODINIT_FUNC extern "C" PyObject*
Mark Hammond8235ea12002-07-19 06:55:41 +0000662# else /* __cplusplus */
Martin v. Löwis1a214512008-06-11 05:26:20 +0000663# define PyMODINIT_FUNC PyObject*
Mark Hammond8235ea12002-07-19 06:55:41 +0000664# endif /* __cplusplus */
665#endif
666
Fred Draked5fadf72000-09-26 05:46:01 +0000667/* limits.h constants that may be missing */
668
669#ifndef INT_MAX
670#define INT_MAX 2147483647
671#endif
672
673#ifndef LONG_MAX
674#if SIZEOF_LONG == 4
675#define LONG_MAX 0X7FFFFFFFL
676#elif SIZEOF_LONG == 8
677#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
678#else
679#error "could not set LONG_MAX in pyport.h"
680#endif
681#endif
682
683#ifndef LONG_MIN
684#define LONG_MIN (-LONG_MAX-1)
685#endif
686
Tim Petersd57731f2000-10-05 01:42:25 +0000687#ifndef LONG_BIT
688#define LONG_BIT (8 * SIZEOF_LONG)
689#endif
690
691#if LONG_BIT != 8 * SIZEOF_LONG
692/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
693 * 32-bit platforms using gcc. We try to catch that here at compile-time
694 * rather than waiting for integer multiplication to trigger bogus
695 * overflows.
696 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000697#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000698#endif
699
Tim Peters7d3a5112000-07-08 04:17:21 +0000700#ifdef __cplusplus
701}
702#endif
703
Neil Schemenauer15691082001-10-23 02:20:37 +0000704/*
705 * Hide GCC attributes from compilers that don't support them.
706 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000707#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Skip Montanaro7a98be22007-08-16 14:35:24 +0000708 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) )
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000709#define Py_GCC_ATTRIBUTE(x)
710#else
711#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000712#endif
713
Thomas Wouters89f507f2006-12-13 04:49:30 +0000714/*
715 * Add PyArg_ParseTuple format where available.
716 */
717#ifdef HAVE_ATTRIBUTE_FORMAT_PARSETUPLE
718#define Py_FORMAT_PARSETUPLE(func,p1,p2) __attribute__((format(func,p1,p2)))
719#else
720#define Py_FORMAT_PARSETUPLE(func,p1,p2)
721#endif
722
Benjamin Peterson058e31e2009-01-16 03:54:08 +0000723/*
724 * Specify alignment on compilers that support it.
725 */
726#if defined(__GNUC__) && __GNUC__ >= 3
727#define Py_ALIGNED(x) __attribute__((aligned(x)))
728#else
729#define Py_ALIGNED(x)
730#endif
731
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000732/* Eliminate end-of-loop code not reached warnings from SunPro C
733 * when using do{...}while(0) macros
734 */
735#ifdef __SUNPRO_C
736#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
737#endif
738
Thomas Wouters477c8d52006-05-27 19:21:47 +0000739/*
740 * Older Microsoft compilers don't support the C99 long long literal suffixes,
741 * so these will be defined in PC/pyconfig.h for those compilers.
742 */
743#ifndef Py_LL
744#define Py_LL(x) x##LL
745#endif
746
747#ifndef Py_ULL
748#define Py_ULL(x) Py_LL(x##U)
749#endif
750
Tim Peters7d3a5112000-07-08 04:17:21 +0000751#endif /* Py_PYPORT_H */