blob: 17a537992ffc02f871e9ca1547ea4007dd8454fc [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
Mark Dickinson8c1e2942009-06-30 15:46:37 +00006/* Some versions of HP-UX & Solaris need inttypes.h for int32_t,
7 INT32_MAX, etc. */
8#ifdef HAVE_INTTYPES_H
9#include <inttypes.h>
10#endif
11
Thomas Wouters89f507f2006-12-13 04:49:30 +000012#ifdef HAVE_STDINT_H
13#include <stdint.h>
14#endif
15
Tim Peters7d3a5112000-07-08 04:17:21 +000016/**************************************************************************
17Symbols and macros to supply platform-independent interfaces to basic
Tim Peters1be46842000-07-23 18:10:18 +000018C language & library operations whose spellings vary across platforms.
Tim Peters7d3a5112000-07-08 04:17:21 +000019
20Please try to make documentation here as clear as possible: by definition,
21the stuff here is trying to illuminate C's darkest corners.
22
23Config #defines referenced here:
24
25SIGNED_RIGHT_SHIFT_ZERO_FILLS
26Meaning: To be defined iff i>>j does not extend the sign bit when i is a
27 signed integral type and i < 0.
28Used in: Py_ARITHMETIC_RIGHT_SHIFT
Tim Peters1be46842000-07-23 18:10:18 +000029
Tim Peters8315ea52000-07-23 19:28:35 +000030Py_DEBUG
31Meaning: Extra checks compiled in for debug mode.
32Used in: Py_SAFE_DOWNCAST
Barry Warsawfd847b22000-08-18 04:48:18 +000033
34HAVE_UINTPTR_T
35Meaning: The C9X type uintptr_t is supported by the compiler
36Used in: Py_uintptr_t
37
38HAVE_LONG_LONG
39Meaning: The compiler supports the C type "long long"
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000040Used in: PY_LONG_LONG
Barry Warsawfd847b22000-08-18 04:48:18 +000041
Tim Peters7d3a5112000-07-08 04:17:21 +000042**************************************************************************/
43
Barry Warsawfd847b22000-08-18 04:48:18 +000044/* typedefs for some C9X-defined synonyms for integral types.
45 *
46 * The names in Python are exactly the same as the C9X names, except with a
47 * Py_ prefix. Until C9X is universally implemented, this is the only way
48 * to ensure that Python gets reliable names that don't conflict with names
49 * in non-Python code that are playing their own tricks to define the C9X
50 * names.
51 *
52 * NOTE: don't go nuts here! Python has no use for *most* of the C9X
53 * integral synonyms. Only define the ones we actually need.
54 */
55
56#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000057#ifndef PY_LONG_LONG
58#define PY_LONG_LONG long long
Guido van Rossumcd16bf62007-06-13 18:07:49 +000059#if defined(LLONG_MAX)
60/* If LLONG_MAX is defined in limits.h, use that. */
61#define PY_LLONG_MIN LLONG_MIN
62#define PY_LLONG_MAX LLONG_MAX
63#define PY_ULLONG_MAX ULLONG_MAX
64#elif defined(__LONG_LONG_MAX__)
65/* Otherwise, if GCC has a builtin define, use that. */
66#define PY_LLONG_MAX __LONG_LONG_MAX__
67#define PY_LLONG_MIN (-PY_LLONG_MAX-1)
68#define PY_ULLONG_MAX (__LONG_LONG_MAX__*2ULL + 1ULL)
69#else
70/* Otherwise, rely on two's complement. */
71#define PY_ULLONG_MAX (~0ULL)
72#define PY_LLONG_MAX ((long long)(PY_ULLONG_MAX>>1))
73#define PY_LLONG_MIN (-PY_LLONG_MAX-1)
74#endif /* LLONG_MAX */
Barry Warsawfd847b22000-08-18 04:48:18 +000075#endif
76#endif /* HAVE_LONG_LONG */
77
Mark Dickinsonbd792642009-03-18 20:06:12 +000078/* a build with 30-bit digits for Python long integers needs an exact-width
79 * 32-bit unsigned integer type to store those digits. (We could just use
80 * type 'unsigned long', but that would be wasteful on a system where longs
81 * are 64-bits.) On Unix systems, the autoconf macro AC_TYPE_UINT32_T defines
82 * uint32_t to be such a type unless stdint.h or inttypes.h defines uint32_t.
83 * However, it doesn't set HAVE_UINT32_T, so we do that here.
84 */
85#if (defined UINT32_MAX || defined uint32_t)
86#ifndef PY_UINT32_T
87#define HAVE_UINT32_T 1
88#define PY_UINT32_T uint32_t
89#endif
90#endif
91
92/* Macros for a 64-bit unsigned integer type; used for type 'twodigits' in the
93 * long integer implementation, when 30-bit digits are enabled.
94 */
95#if (defined UINT64_MAX || defined uint64_t)
96#ifndef PY_UINT64_T
97#define HAVE_UINT64_T 1
98#define PY_UINT64_T uint64_t
99#endif
100#endif
101
102/* Signed variants of the above */
103#if (defined INT32_MAX || defined int32_t)
104#ifndef PY_INT32_T
105#define HAVE_INT32_T 1
106#define PY_INT32_T int32_t
107#endif
108#endif
109#if (defined INT64_MAX || defined int64_t)
110#ifndef PY_INT64_T
111#define HAVE_INT64_T 1
112#define PY_INT64_T int64_t
113#endif
114#endif
115
116/* If PYLONG_BITS_IN_DIGIT is not defined then we'll use 30-bit digits if all
117 the necessary integer types are available, and we're on a 64-bit platform
118 (as determined by SIZEOF_VOID_P); otherwise we use 15-bit digits. */
119
120#ifndef PYLONG_BITS_IN_DIGIT
121#if (defined HAVE_UINT64_T && defined HAVE_INT64_T && \
122 defined HAVE_UINT32_T && defined HAVE_INT32_T && SIZEOF_VOID_P >= 8)
123#define PYLONG_BITS_IN_DIGIT 30
124#else
125#define PYLONG_BITS_IN_DIGIT 15
126#endif
127#endif
128
Barry Warsawfd847b22000-08-18 04:48:18 +0000129/* uintptr_t is the C9X name for an unsigned integral type such that a
130 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +0000131 * without loss of information. Similarly for intptr_t, wrt a signed
132 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +0000133 */
134#ifdef HAVE_UINTPTR_T
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000135typedef uintptr_t Py_uintptr_t;
136typedef intptr_t Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +0000137
Barry Warsawfd847b22000-08-18 04:48:18 +0000138#elif SIZEOF_VOID_P <= SIZEOF_INT
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000139typedef unsigned int Py_uintptr_t;
140typedef int Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +0000141
Barry Warsawfd847b22000-08-18 04:48:18 +0000142#elif SIZEOF_VOID_P <= SIZEOF_LONG
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000143typedef unsigned long Py_uintptr_t;
144typedef long Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +0000145
Barry Warsawfd847b22000-08-18 04:48:18 +0000146#elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000147typedef unsigned PY_LONG_LONG Py_uintptr_t;
148typedef PY_LONG_LONG Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +0000149
Barry Warsawfd847b22000-08-18 04:48:18 +0000150#else
151# error "Python needs a typedef for Py_uintptr_t in pyport.h."
152#endif /* HAVE_UINTPTR_T */
153
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000154/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
155 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
156 * unsigned integral type). See PEP 353 for details.
157 */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000158#ifdef HAVE_SSIZE_T
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000159typedef ssize_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000160#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000161typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000162#else
163# error "Python needs a typedef for Py_ssize_t in pyport.h."
164#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000165
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +0000166/* Largest possible value of size_t.
167 SIZE_MAX is part of C99, so it might be defined on some
168 platforms. If it is not defined, (size_t)-1 is a portable
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000169 definition for C89, due to the way signed->unsigned
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +0000170 conversion is defined. */
171#ifdef SIZE_MAX
172#define PY_SIZE_MAX SIZE_MAX
173#else
174#define PY_SIZE_MAX ((size_t)-1)
175#endif
176
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000177/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000178#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000179/* Smallest negative value of type Py_ssize_t. */
180#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
181
Christian Heimes400adb02008-02-01 08:12:03 +0000182#if SIZEOF_PID_T > SIZEOF_LONG
183# error "Python doesn't support sizeof(pid_t) > sizeof(long)"
184#endif
185
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000186/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
187 * format to convert an argument with the width of a size_t or Py_ssize_t.
188 * C99 introduced "z" for this purpose, but not all platforms support that;
189 * e.g., MS compilers use "I" instead.
190 *
191 * These "high level" Python format functions interpret "z" correctly on
192 * all platforms (Python interprets the format string itself, and does whatever
193 * the platform C requires to convert a size_t/Py_ssize_t argument):
194 *
Christian Heimes72b710a2008-05-26 13:28:38 +0000195 * PyBytes_FromFormat
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000196 * PyErr_Format
Christian Heimes72b710a2008-05-26 13:28:38 +0000197 * PyBytes_FromFormatV
Walter Dörwald7696ed72007-05-31 15:51:35 +0000198 * PyUnicode_FromFormatV
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000199 *
200 * Lower-level uses require that you interpolate the correct format modifier
201 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
202 * example,
203 *
204 * Py_ssize_t index;
205 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
206 *
207 * That will expand to %ld, or %Id, or to something else correct for a
208 * Py_ssize_t on the platform.
209 */
210#ifndef PY_FORMAT_SIZE_T
Thomas Wouters89f507f2006-12-13 04:49:30 +0000211# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000212# define PY_FORMAT_SIZE_T ""
213# elif SIZEOF_SIZE_T == SIZEOF_LONG
214# define PY_FORMAT_SIZE_T "l"
215# elif defined(MS_WINDOWS)
216# define PY_FORMAT_SIZE_T "I"
217# else
218# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
219# endif
220#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000221
Thomas Wouters477c8d52006-05-27 19:21:47 +0000222/* Py_LOCAL can be used instead of static to get the fastest possible calling
223 * convention for functions that are local to a given module.
224 *
225 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
226 * for platforms that support that.
227 *
228 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
229 * "aggressive" inlining/optimizaion is enabled for the entire module. This
230 * may lead to code bloat, and may slow things down for those reasons. It may
231 * also lead to errors, if the code relies on pointer aliasing. Use with
232 * care.
233 *
234 * NOTE: You can only use this for functions that are entirely local to a
235 * module; functions that are exported via method tables, callbacks, etc,
236 * should keep using static.
237 */
238
239#undef USE_INLINE /* XXX - set via configure? */
240
241#if defined(_MSC_VER)
242#if defined(PY_LOCAL_AGGRESSIVE)
243/* enable more aggressive optimization for visual studio */
244#pragma optimize("agtw", on)
245#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000246/* ignore warnings if the compiler decides not to inline a function */
Thomas Wouters477c8d52006-05-27 19:21:47 +0000247#pragma warning(disable: 4710)
248/* fastest possible local call under MSVC */
249#define Py_LOCAL(type) static type __fastcall
250#define Py_LOCAL_INLINE(type) static __inline type __fastcall
251#elif defined(USE_INLINE)
252#define Py_LOCAL(type) static type
253#define Py_LOCAL_INLINE(type) static inline type
254#else
255#define Py_LOCAL(type) static type
256#define Py_LOCAL_INLINE(type) static type
257#endif
258
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000259/* Py_MEMCPY can be used instead of memcpy in cases where the copied blocks
260 * are often very short. While most platforms have highly optimized code for
261 * large transfers, the setup costs for memcpy are often quite high. MEMCPY
262 * solves this by doing short copies "in line".
263 */
264
265#if defined(_MSC_VER)
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000266#define Py_MEMCPY(target, source, length) do { \
267 size_t i_, n_ = (length); \
268 char *t_ = (void*) (target); \
269 const char *s_ = (void*) (source); \
270 if (n_ >= 16) \
271 memcpy(t_, s_, n_); \
272 else \
273 for (i_ = 0; i_ < n_; i_++) \
274 t_[i_] = s_[i_]; \
275 } while (0)
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000276#else
277#define Py_MEMCPY memcpy
278#endif
279
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000280#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000281
Jesus Cea2fc8b872011-04-20 22:26:57 +0200282#ifdef HAVE_IEEEFP_H
283#include <ieeefp.h> /* needed for 'finite' declaration on some platforms */
284#endif
285
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000286#include <math.h> /* Moved here from the math section, before extern "C" */
287
288/********************************************
289 * WRAPPER FOR <time.h> and/or <sys/time.h> *
290 ********************************************/
291
292#ifdef TIME_WITH_SYS_TIME
293#include <sys/time.h>
294#include <time.h>
295#else /* !TIME_WITH_SYS_TIME */
296#ifdef HAVE_SYS_TIME_H
297#include <sys/time.h>
298#else /* !HAVE_SYS_TIME_H */
299#include <time.h>
300#endif /* !HAVE_SYS_TIME_H */
301#endif /* !TIME_WITH_SYS_TIME */
302
303
304/******************************
305 * WRAPPER FOR <sys/select.h> *
306 ******************************/
307
308/* NB caller must include <sys/types.h> */
309
310#ifdef HAVE_SYS_SELECT_H
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000311#include <sys/select.h>
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000312#endif /* !HAVE_SYS_SELECT_H */
313
Tim Peters60f42b52001-01-18 03:03:16 +0000314/*******************************
315 * stat() and fstat() fiddling *
316 *******************************/
317
318/* We expect that stat and fstat exist on most systems.
319 * It's confirmed on Unix, Mac and Windows.
320 * If you don't have them, add
321 * #define DONT_HAVE_STAT
322 * and/or
323 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000324 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000325 * HAVE_FSTAT instead.
326 * Also
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000327 * #define HAVE_SYS_STAT_H
328 * if <sys/stat.h> exists on your platform, and
Tim Peters60f42b52001-01-18 03:03:16 +0000329 * #define HAVE_STAT_H
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000330 * if <stat.h> does.
Tim Peters60f42b52001-01-18 03:03:16 +0000331 */
332#ifndef DONT_HAVE_STAT
333#define HAVE_STAT
334#endif
335
336#ifndef DONT_HAVE_FSTAT
337#define HAVE_FSTAT
338#endif
339
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000340#ifdef HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000341#if defined(PYOS_OS2) && defined(PYCC_GCC)
342#include <sys/types.h>
343#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000344#include <sys/stat.h>
345#elif defined(HAVE_STAT_H)
346#include <stat.h>
347#endif
348
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000349#if defined(PYCC_VACPP)
350/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
351#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
352#endif
353
354#ifndef S_ISREG
355#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
356#endif
357
358#ifndef S_ISDIR
359#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
360#endif
361
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000362
Tim Peters7d3a5112000-07-08 04:17:21 +0000363#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000364/* Move this down here since some C++ #include's don't like to be included
365 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000366extern "C" {
367#endif
368
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000369
Tim Peters7d3a5112000-07-08 04:17:21 +0000370/* Py_ARITHMETIC_RIGHT_SHIFT
371 * C doesn't define whether a right-shift of a signed integer sign-extends
372 * or zero-fills. Here a macro to force sign extension:
373 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
Mark Dickinson16f966e2009-03-20 23:23:15 +0000374 * Return I >> J, forcing sign extension. Arithmetically, return the
375 * floor of I/2**J.
Tim Peters7d3a5112000-07-08 04:17:21 +0000376 * Requirements:
Mark Dickinson16f966e2009-03-20 23:23:15 +0000377 * I should have signed integer type. In the terminology of C99, this can
378 * be either one of the five standard signed integer types (signed char,
379 * short, int, long, long long) or an extended signed integer type.
380 * J is an integer >= 0 and strictly less than the number of bits in the
381 * type of I (because C doesn't define what happens for J outside that
382 * range either).
383 * TYPE used to specify the type of I, but is now ignored. It's been left
384 * in for backwards compatibility with versions <= 2.6 or 3.0.
Tim Peters7d3a5112000-07-08 04:17:21 +0000385 * Caution:
386 * I may be evaluated more than once.
387 */
388#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
389#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000390 ((I) < 0 ? -1-((-1-(I)) >> (J)) : (I) >> (J))
Tim Peters7d3a5112000-07-08 04:17:21 +0000391#else
392#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
393#endif
394
Tim Peters39dce292000-08-15 03:34:48 +0000395/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000396 * "Simply" returns its argument. However, macro expansions within the
397 * argument are evaluated. This unfortunate trickery is needed to get
398 * token-pasting to work as desired in some cases.
399 */
400#define Py_FORCE_EXPANSION(X) X
401
Tim Peters8315ea52000-07-23 19:28:35 +0000402/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
403 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
404 * assert-fails if any information is lost.
405 * Caution:
406 * VALUE may be evaluated more than once.
407 */
408#ifdef Py_DEBUG
409#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000410 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
Tim Peters8315ea52000-07-23 19:28:35 +0000411#else
412#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
413#endif
414
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000415/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000416 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000417 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
418 * to 0 before calling a libm function, and invoke this macro after,
419 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000420 * Caution:
421 * This isn't reliable. See Py_OVERFLOWED comments.
422 * X is evaluated more than once.
423 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000424#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000425#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
426#else
427#define _Py_SET_EDOM_FOR_NAN(X) ;
428#endif
429#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000430 do { \
431 if (errno == 0) { \
432 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
433 errno = ERANGE; \
434 else _Py_SET_EDOM_FOR_NAN(X) \
435 } \
436 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000437
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000438/* Py_SET_ERANGE_ON_OVERFLOW(x)
439 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
440 */
441#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
442
Tim Petersdc5a5082002-03-09 04:58:24 +0000443/* Py_ADJUST_ERANGE1(x)
444 * Py_ADJUST_ERANGE2(x, y)
445 * Set errno to 0 before calling a libm function, and invoke one of these
446 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
447 * for functions returning complex results). This makes two kinds of
448 * adjustments to errno: (A) If it looks like the platform libm set
449 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
450 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
451 * effect, we're trying to force a useful implementation of C89 errno
452 * behavior.
453 * Caution:
454 * This isn't reliable. See Py_OVERFLOWED comments.
455 * X and Y may be evaluated more than once.
456 */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000457#define Py_ADJUST_ERANGE1(X) \
458 do { \
459 if (errno == 0) { \
460 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
461 errno = ERANGE; \
462 } \
463 else if (errno == ERANGE && (X) == 0.0) \
464 errno = 0; \
465 } while(0)
Tim Petersdc5a5082002-03-09 04:58:24 +0000466
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000467#define Py_ADJUST_ERANGE2(X, Y) \
468 do { \
469 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
470 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
471 if (errno == 0) \
472 errno = ERANGE; \
473 } \
474 else if (errno == ERANGE) \
475 errno = 0; \
476 } while(0)
Tim Petersdc5a5082002-03-09 04:58:24 +0000477
Mark Dickinsona4262b92009-04-19 11:35:55 +0000478/* The functions _Py_dg_strtod and _Py_dg_dtoa in Python/dtoa.c (which are
479 * required to support the short float repr introduced in Python 3.1) require
480 * that the floating-point unit that's being used for arithmetic operations
481 * on C doubles is set to use 53-bit precision. It also requires that the
482 * FPU rounding mode is round-half-to-even, but that's less often an issue.
483 *
484 * If your FPU isn't already set to 53-bit precision/round-half-to-even, and
485 * you want to make use of _Py_dg_strtod and _Py_dg_dtoa, then you should
486 *
487 * #define HAVE_PY_SET_53BIT_PRECISION 1
488 *
489 * and also give appropriate definitions for the following three macros:
490 *
491 * _PY_SET_53BIT_PRECISION_START : store original FPU settings, and
492 * set FPU to 53-bit precision/round-half-to-even
493 * _PY_SET_53BIT_PRECISION_END : restore original FPU settings
494 * _PY_SET_53BIT_PRECISION_HEADER : any variable declarations needed to
495 * use the two macros above.
496 *
497 * The macros are designed to be used within a single C function: see
498 * Python/pystrtod.c for an example of their use.
499 */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000500
Mark Dickinsona4262b92009-04-19 11:35:55 +0000501/* get and set x87 control word for gcc/x86 */
Mark Dickinson7abf8d42009-04-18 20:17:52 +0000502#ifdef HAVE_GCC_ASM_FOR_X87
Mark Dickinsona4262b92009-04-19 11:35:55 +0000503#define HAVE_PY_SET_53BIT_PRECISION 1
504/* _Py_get/set_387controlword functions are defined in Python/pymath.c */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000505#define _Py_SET_53BIT_PRECISION_HEADER \
506 unsigned short old_387controlword, new_387controlword
507#define _Py_SET_53BIT_PRECISION_START \
508 do { \
509 old_387controlword = _Py_get_387controlword(); \
510 new_387controlword = (old_387controlword & ~0x0f00) | 0x0200; \
511 if (new_387controlword != old_387controlword) \
512 _Py_set_387controlword(new_387controlword); \
513 } while (0)
514#define _Py_SET_53BIT_PRECISION_END \
515 if (new_387controlword != old_387controlword) \
516 _Py_set_387controlword(old_387controlword)
Mark Dickinsona4262b92009-04-19 11:35:55 +0000517#endif
518
519/* default definitions are empty */
520#ifndef HAVE_PY_SET_53BIT_PRECISION
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000521#define _Py_SET_53BIT_PRECISION_HEADER
522#define _Py_SET_53BIT_PRECISION_START
523#define _Py_SET_53BIT_PRECISION_END
524#endif
525
526/* If we can't guarantee 53-bit precision, don't use the code
527 in Python/dtoa.c, but fall back to standard code. This
528 means that repr of a float will be long (17 sig digits).
529
530 Realistically, there are two things that could go wrong:
531
532 (1) doubles aren't IEEE 754 doubles, or
533 (2) we're on x86 with the rounding precision set to 64-bits
534 (extended precision), and we don't know how to change
535 the rounding precision.
536 */
537
538#if !defined(DOUBLE_IS_LITTLE_ENDIAN_IEEE754) && \
539 !defined(DOUBLE_IS_BIG_ENDIAN_IEEE754) && \
540 !defined(DOUBLE_IS_ARM_MIXED_ENDIAN_IEEE754)
541#define PY_NO_SHORT_FLOAT_REPR
542#endif
543
Mark Dickinson60fd0992009-04-18 10:16:35 +0000544/* double rounding is symptomatic of use of extended precision on x86. If
545 we're seeing double rounding, and we don't have any mechanism available for
546 changing the FPU rounding precision, then don't use Python/dtoa.c. */
Mark Dickinsona4262b92009-04-19 11:35:55 +0000547#if defined(X87_DOUBLE_ROUNDING) && !defined(HAVE_PY_SET_53BIT_PRECISION)
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000548#define PY_NO_SHORT_FLOAT_REPR
549#endif
550
551
Neal Norwitz80292642002-12-19 15:12:26 +0000552/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000553 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000554 * Usage:
555 * extern int old_var Py_DEPRECATED(2.3);
556 * typedef int T1 Py_DEPRECATED(2.4);
557 * extern int x() Py_DEPRECATED(2.5);
558 */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000559#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000560 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000561#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
562#else
Tim Peters4643bd92002-12-28 21:56:08 +0000563#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000564#endif
565
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000566/**************************************************************************
567Prototypes that are missing from the standard include files on some systems
568(and possibly only some versions of such systems.)
569
570Please be conservative with adding new ones, document them and enclose them
571in platform-specific #ifdefs.
572**************************************************************************/
573
574#ifdef SOLARIS
575/* Unchecked */
576extern int gethostname(char *, int);
577#endif
578
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000579#ifdef HAVE__GETPTY
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000580#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000581extern char * _getpty(int *, int, mode_t, int);
582#endif
583
Georg Brandlf78e02b2008-06-10 17:40:04 +0000584/* On QNX 6, struct termio must be declared by including sys/termio.h
585 if TCGETA, TCSETA, TCSETAW, or TCSETAF are used. sys/termio.h must
586 be included before termios.h or it will generate an error. */
587#ifdef HAVE_SYS_TERMIO_H
588#include <sys/termio.h>
589#endif
590
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000591#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
592#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
593/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
594 functions, even though they are included in libutil. */
595#include <termios.h>
596extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
Christian Heimes400adb02008-02-01 08:12:03 +0000597extern pid_t forkpty(int *, char *, struct termios *, struct winsize *);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000598#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
599#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
600
601
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000602/* On 4.4BSD-descendants, ctype functions serves the whole range of
603 * wchar_t character set rather than single byte code points only.
604 * This characteristic can break some operations of string object
605 * including str.upper() and str.split() on UTF-8 locales. This
606 * workaround was provided by Tim Robbins of FreeBSD project.
607 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000608
609#ifdef __FreeBSD__
610#include <osreldate.h>
611#if __FreeBSD_version > 500039
Ronald Oussoren3a20d052010-04-18 15:08:43 +0000612# define _PY_PORT_CTYPE_UTF8_ISSUE
613#endif
614#endif
615
616
617#if defined(__APPLE__)
618# define _PY_PORT_CTYPE_UTF8_ISSUE
619#endif
620
621#ifdef _PY_PORT_CTYPE_UTF8_ISSUE
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000622#include <ctype.h>
623#include <wctype.h>
624#undef isalnum
625#define isalnum(c) iswalnum(btowc(c))
626#undef isalpha
627#define isalpha(c) iswalpha(btowc(c))
628#undef islower
629#define islower(c) iswlower(btowc(c))
630#undef isspace
631#define isspace(c) iswspace(btowc(c))
632#undef isupper
633#define isupper(c) iswupper(btowc(c))
634#undef tolower
635#define tolower(c) towlower(btowc(c))
636#undef toupper
637#define toupper(c) towupper(btowc(c))
638#endif
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000639
640
Mark Hammond8235ea12002-07-19 06:55:41 +0000641/* Declarations for symbol visibility.
642
643 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000644 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000645 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000646 inside the Python core, they are private to the core.
647 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000648 external linkage depending on the platform.
649
650 As a number of platforms support/require "__declspec(dllimport/dllexport)",
651 we support a HAVE_DECLSPEC_DLL macro to save duplication.
652*/
653
Tim Peters4643bd92002-12-28 21:56:08 +0000654/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000655 All windows ports, except cygwin, are handled in PC/pyconfig.h.
656
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000657 Cygwin is the only other autoconf platform requiring special
658 linkage handling and it uses __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000659*/
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000660#if defined(__CYGWIN__)
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000661# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000662#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000663
Jason Tishler30765592003-09-04 11:04:06 +0000664/* only get special linkage if built as shared or platform is Cygwin */
665#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000666# if defined(HAVE_DECLSPEC_DLL)
667# ifdef Py_BUILD_CORE
668# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
669# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Daniel Stutzbachbd63a992010-09-14 16:07:54 +0000670 /* module init functions inside the core need no external linkage */
671 /* except for Cygwin to handle embedding */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000672# if defined(__CYGWIN__)
673# define PyMODINIT_FUNC __declspec(dllexport) PyObject*
674# else /* __CYGWIN__ */
675# define PyMODINIT_FUNC PyObject*
676# endif /* __CYGWIN__ */
677# else /* Py_BUILD_CORE */
Daniel Stutzbachbd63a992010-09-14 16:07:54 +0000678 /* Building an extension module, or an embedded situation */
679 /* public Python functions and data are imported */
680 /* Under Cygwin, auto-import functions to prevent compilation */
681 /* failures similar to those described at the bottom of 4.1: */
682 /* http://docs.python.org/extending/windows.html#a-cookbook-approach */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000683# if !defined(__CYGWIN__)
684# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
685# endif /* !__CYGWIN__ */
686# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Daniel Stutzbachbd63a992010-09-14 16:07:54 +0000687 /* module init functions outside the core must be exported */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000688# if defined(__cplusplus)
689# define PyMODINIT_FUNC extern "C" __declspec(dllexport) PyObject*
690# else /* __cplusplus */
691# define PyMODINIT_FUNC __declspec(dllexport) PyObject*
692# endif /* __cplusplus */
693# endif /* Py_BUILD_CORE */
694# endif /* HAVE_DECLSPEC */
Mark Hammond8235ea12002-07-19 06:55:41 +0000695#endif /* Py_ENABLE_SHARED */
696
697/* If no external linkage macros defined by now, create defaults */
698#ifndef PyAPI_FUNC
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000699# define PyAPI_FUNC(RTYPE) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000700#endif
701#ifndef PyAPI_DATA
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000702# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000703#endif
704#ifndef PyMODINIT_FUNC
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000705# if defined(__cplusplus)
706# define PyMODINIT_FUNC extern "C" PyObject*
707# else /* __cplusplus */
708# define PyMODINIT_FUNC PyObject*
709# endif /* __cplusplus */
Mark Hammond8235ea12002-07-19 06:55:41 +0000710#endif
711
Fred Draked5fadf72000-09-26 05:46:01 +0000712/* limits.h constants that may be missing */
713
714#ifndef INT_MAX
715#define INT_MAX 2147483647
716#endif
717
718#ifndef LONG_MAX
719#if SIZEOF_LONG == 4
720#define LONG_MAX 0X7FFFFFFFL
721#elif SIZEOF_LONG == 8
722#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
723#else
724#error "could not set LONG_MAX in pyport.h"
725#endif
726#endif
727
728#ifndef LONG_MIN
729#define LONG_MIN (-LONG_MAX-1)
730#endif
731
Tim Petersd57731f2000-10-05 01:42:25 +0000732#ifndef LONG_BIT
733#define LONG_BIT (8 * SIZEOF_LONG)
734#endif
735
736#if LONG_BIT != 8 * SIZEOF_LONG
737/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
738 * 32-bit platforms using gcc. We try to catch that here at compile-time
739 * rather than waiting for integer multiplication to trigger bogus
740 * overflows.
741 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000742#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000743#endif
744
Tim Peters7d3a5112000-07-08 04:17:21 +0000745#ifdef __cplusplus
746}
747#endif
748
Neil Schemenauer15691082001-10-23 02:20:37 +0000749/*
750 * Hide GCC attributes from compilers that don't support them.
751 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000752#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Skip Montanaro7a98be22007-08-16 14:35:24 +0000753 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) )
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000754#define Py_GCC_ATTRIBUTE(x)
755#else
756#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000757#endif
758
Thomas Wouters89f507f2006-12-13 04:49:30 +0000759/*
760 * Add PyArg_ParseTuple format where available.
761 */
762#ifdef HAVE_ATTRIBUTE_FORMAT_PARSETUPLE
763#define Py_FORMAT_PARSETUPLE(func,p1,p2) __attribute__((format(func,p1,p2)))
764#else
765#define Py_FORMAT_PARSETUPLE(func,p1,p2)
766#endif
767
Benjamin Peterson058e31e2009-01-16 03:54:08 +0000768/*
769 * Specify alignment on compilers that support it.
770 */
771#if defined(__GNUC__) && __GNUC__ >= 3
772#define Py_ALIGNED(x) __attribute__((aligned(x)))
773#else
774#define Py_ALIGNED(x)
775#endif
776
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000777/* Eliminate end-of-loop code not reached warnings from SunPro C
778 * when using do{...}while(0) macros
779 */
780#ifdef __SUNPRO_C
781#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
782#endif
783
Thomas Wouters477c8d52006-05-27 19:21:47 +0000784/*
785 * Older Microsoft compilers don't support the C99 long long literal suffixes,
786 * so these will be defined in PC/pyconfig.h for those compilers.
787 */
788#ifndef Py_LL
789#define Py_LL(x) x##LL
790#endif
791
792#ifndef Py_ULL
793#define Py_ULL(x) Py_LL(x##U)
794#endif
795
Tim Peters7d3a5112000-07-08 04:17:21 +0000796#endif /* Py_PYPORT_H */