blob: 1adb5f0d02004e90d3e82f4f10646f69e7642175 [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 Dickinson835a6c82009-06-30 15:45:17 +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
Tim Peters79248aa2001-08-29 21:37:10 +0000135typedef uintptr_t Py_uintptr_t;
136typedef intptr_t Py_intptr_t;
137
Barry Warsawfd847b22000-08-18 04:48:18 +0000138#elif SIZEOF_VOID_P <= SIZEOF_INT
Tim Peters79248aa2001-08-29 21:37:10 +0000139typedef unsigned int Py_uintptr_t;
140typedef int Py_intptr_t;
141
Barry Warsawfd847b22000-08-18 04:48:18 +0000142#elif SIZEOF_VOID_P <= SIZEOF_LONG
Tim Peters79248aa2001-08-29 21:37:10 +0000143typedef unsigned long Py_uintptr_t;
144typedef long Py_intptr_t;
145
Barry Warsawfd847b22000-08-18 04:48:18 +0000146#elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +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
159typedef ssize_t Py_ssize_t;
160#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Martin v. Löwis2d65b552006-02-18 18:26:55 +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
169 definition for C89, due to the way signed->unsigned
170 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
Mark Dickinson6ce4a9a2009-11-16 17:00:11 +0000222/* PY_FORMAT_LONG_LONG is analogous to PY_FORMAT_SIZE_T above, but for
223 * the long long type instead of the size_t type. It's only available
224 * when HAVE_LONG_LONG is defined. The "high level" Python format
225 * functions listed above will interpret "lld" or "llu" correctly on
226 * all platforms.
227 */
228#ifdef HAVE_LONG_LONG
229# ifndef PY_FORMAT_LONG_LONG
230# if defined(MS_WIN64) || defined(MS_WINDOWS)
231# define PY_FORMAT_LONG_LONG "I64"
232# else
233# error "This platform's pyconfig.h needs to define PY_FORMAT_LONG_LONG"
234# endif
235# endif
236#endif
237
Thomas Wouters477c8d52006-05-27 19:21:47 +0000238/* Py_LOCAL can be used instead of static to get the fastest possible calling
239 * convention for functions that are local to a given module.
240 *
241 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
242 * for platforms that support that.
243 *
244 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
245 * "aggressive" inlining/optimizaion is enabled for the entire module. This
246 * may lead to code bloat, and may slow things down for those reasons. It may
247 * also lead to errors, if the code relies on pointer aliasing. Use with
248 * care.
249 *
250 * NOTE: You can only use this for functions that are entirely local to a
251 * module; functions that are exported via method tables, callbacks, etc,
252 * should keep using static.
253 */
254
255#undef USE_INLINE /* XXX - set via configure? */
256
257#if defined(_MSC_VER)
258#if defined(PY_LOCAL_AGGRESSIVE)
259/* enable more aggressive optimization for visual studio */
260#pragma optimize("agtw", on)
261#endif
262/* ignore warnings if the compiler decides not to inline a function */
263#pragma warning(disable: 4710)
264/* fastest possible local call under MSVC */
265#define Py_LOCAL(type) static type __fastcall
266#define Py_LOCAL_INLINE(type) static __inline type __fastcall
267#elif defined(USE_INLINE)
268#define Py_LOCAL(type) static type
269#define Py_LOCAL_INLINE(type) static inline type
270#else
271#define Py_LOCAL(type) static type
272#define Py_LOCAL_INLINE(type) static type
273#endif
274
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000275/* Py_MEMCPY can be used instead of memcpy in cases where the copied blocks
276 * are often very short. While most platforms have highly optimized code for
277 * large transfers, the setup costs for memcpy are often quite high. MEMCPY
278 * solves this by doing short copies "in line".
279 */
280
281#if defined(_MSC_VER)
282#define Py_MEMCPY(target, source, length) do { \
283 size_t i_, n_ = (length); \
284 char *t_ = (void*) (target); \
285 const char *s_ = (void*) (source); \
286 if (n_ >= 16) \
287 memcpy(t_, s_, n_); \
288 else \
289 for (i_ = 0; i_ < n_; i_++) \
290 t_[i_] = s_[i_]; \
291 } while (0)
292#else
293#define Py_MEMCPY memcpy
294#endif
295
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000296#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000297
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000298#include <math.h> /* Moved here from the math section, before extern "C" */
299
300/********************************************
301 * WRAPPER FOR <time.h> and/or <sys/time.h> *
302 ********************************************/
303
304#ifdef TIME_WITH_SYS_TIME
305#include <sys/time.h>
306#include <time.h>
307#else /* !TIME_WITH_SYS_TIME */
308#ifdef HAVE_SYS_TIME_H
309#include <sys/time.h>
310#else /* !HAVE_SYS_TIME_H */
311#include <time.h>
312#endif /* !HAVE_SYS_TIME_H */
313#endif /* !TIME_WITH_SYS_TIME */
314
315
316/******************************
317 * WRAPPER FOR <sys/select.h> *
318 ******************************/
319
320/* NB caller must include <sys/types.h> */
321
322#ifdef HAVE_SYS_SELECT_H
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000323#include <sys/select.h>
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000324#endif /* !HAVE_SYS_SELECT_H */
325
Tim Peters60f42b52001-01-18 03:03:16 +0000326/*******************************
327 * stat() and fstat() fiddling *
328 *******************************/
329
330/* We expect that stat and fstat exist on most systems.
331 * It's confirmed on Unix, Mac and Windows.
332 * If you don't have them, add
333 * #define DONT_HAVE_STAT
334 * and/or
335 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000336 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000337 * HAVE_FSTAT instead.
338 * Also
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000339 * #define HAVE_SYS_STAT_H
340 * if <sys/stat.h> exists on your platform, and
Tim Peters60f42b52001-01-18 03:03:16 +0000341 * #define HAVE_STAT_H
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000342 * if <stat.h> does.
Tim Peters60f42b52001-01-18 03:03:16 +0000343 */
344#ifndef DONT_HAVE_STAT
345#define HAVE_STAT
346#endif
347
348#ifndef DONT_HAVE_FSTAT
349#define HAVE_FSTAT
350#endif
351
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000352#ifdef HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000353#if defined(PYOS_OS2) && defined(PYCC_GCC)
354#include <sys/types.h>
355#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000356#include <sys/stat.h>
357#elif defined(HAVE_STAT_H)
358#include <stat.h>
359#endif
360
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000361#if defined(PYCC_VACPP)
362/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
363#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
364#endif
365
366#ifndef S_ISREG
367#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
368#endif
369
370#ifndef S_ISDIR
371#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
372#endif
373
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000374
Tim Peters7d3a5112000-07-08 04:17:21 +0000375#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000376/* Move this down here since some C++ #include's don't like to be included
377 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000378extern "C" {
379#endif
380
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000381
Tim Peters7d3a5112000-07-08 04:17:21 +0000382/* Py_ARITHMETIC_RIGHT_SHIFT
383 * C doesn't define whether a right-shift of a signed integer sign-extends
384 * or zero-fills. Here a macro to force sign extension:
385 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
Mark Dickinson16f966e2009-03-20 23:23:15 +0000386 * Return I >> J, forcing sign extension. Arithmetically, return the
387 * floor of I/2**J.
Tim Peters7d3a5112000-07-08 04:17:21 +0000388 * Requirements:
Mark Dickinson16f966e2009-03-20 23:23:15 +0000389 * I should have signed integer type. In the terminology of C99, this can
390 * be either one of the five standard signed integer types (signed char,
391 * short, int, long, long long) or an extended signed integer type.
392 * J is an integer >= 0 and strictly less than the number of bits in the
393 * type of I (because C doesn't define what happens for J outside that
394 * range either).
395 * TYPE used to specify the type of I, but is now ignored. It's been left
396 * in for backwards compatibility with versions <= 2.6 or 3.0.
Tim Peters7d3a5112000-07-08 04:17:21 +0000397 * Caution:
398 * I may be evaluated more than once.
399 */
400#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
401#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
Mark Dickinson16f966e2009-03-20 23:23:15 +0000402 ((I) < 0 ? -1-((-1-(I)) >> (J)) : (I) >> (J))
Tim Peters7d3a5112000-07-08 04:17:21 +0000403#else
404#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
405#endif
406
Tim Peters39dce292000-08-15 03:34:48 +0000407/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000408 * "Simply" returns its argument. However, macro expansions within the
409 * argument are evaluated. This unfortunate trickery is needed to get
410 * token-pasting to work as desired in some cases.
411 */
412#define Py_FORCE_EXPANSION(X) X
413
Tim Peters8315ea52000-07-23 19:28:35 +0000414/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
415 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
416 * assert-fails if any information is lost.
417 * Caution:
418 * VALUE may be evaluated more than once.
419 */
420#ifdef Py_DEBUG
421#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
422 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
423#else
424#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
425#endif
426
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000427/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000428 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000429 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
430 * to 0 before calling a libm function, and invoke this macro after,
431 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000432 * Caution:
433 * This isn't reliable. See Py_OVERFLOWED comments.
434 * X is evaluated more than once.
435 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000436#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000437#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
438#else
439#define _Py_SET_EDOM_FOR_NAN(X) ;
440#endif
441#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000442 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000443 if (errno == 0) { \
444 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
445 errno = ERANGE; \
446 else _Py_SET_EDOM_FOR_NAN(X) \
447 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000448 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000449
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000450/* Py_SET_ERANGE_ON_OVERFLOW(x)
451 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
452 */
453#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
454
Tim Petersdc5a5082002-03-09 04:58:24 +0000455/* Py_ADJUST_ERANGE1(x)
456 * Py_ADJUST_ERANGE2(x, y)
457 * Set errno to 0 before calling a libm function, and invoke one of these
458 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
459 * for functions returning complex results). This makes two kinds of
460 * adjustments to errno: (A) If it looks like the platform libm set
461 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
462 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
463 * effect, we're trying to force a useful implementation of C89 errno
464 * behavior.
465 * Caution:
466 * This isn't reliable. See Py_OVERFLOWED comments.
467 * X and Y may be evaluated more than once.
468 */
469#define Py_ADJUST_ERANGE1(X) \
470 do { \
471 if (errno == 0) { \
472 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
473 errno = ERANGE; \
474 } \
475 else if (errno == ERANGE && (X) == 0.0) \
476 errno = 0; \
477 } while(0)
478
479#define Py_ADJUST_ERANGE2(X, Y) \
480 do { \
481 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
482 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
483 if (errno == 0) \
484 errno = ERANGE; \
485 } \
486 else if (errno == ERANGE) \
487 errno = 0; \
488 } while(0)
489
Mark Dickinsona4262b92009-04-19 11:35:55 +0000490/* The functions _Py_dg_strtod and _Py_dg_dtoa in Python/dtoa.c (which are
491 * required to support the short float repr introduced in Python 3.1) require
492 * that the floating-point unit that's being used for arithmetic operations
493 * on C doubles is set to use 53-bit precision. It also requires that the
494 * FPU rounding mode is round-half-to-even, but that's less often an issue.
495 *
496 * If your FPU isn't already set to 53-bit precision/round-half-to-even, and
497 * you want to make use of _Py_dg_strtod and _Py_dg_dtoa, then you should
498 *
499 * #define HAVE_PY_SET_53BIT_PRECISION 1
500 *
501 * and also give appropriate definitions for the following three macros:
502 *
503 * _PY_SET_53BIT_PRECISION_START : store original FPU settings, and
504 * set FPU to 53-bit precision/round-half-to-even
505 * _PY_SET_53BIT_PRECISION_END : restore original FPU settings
506 * _PY_SET_53BIT_PRECISION_HEADER : any variable declarations needed to
507 * use the two macros above.
508 *
509 * The macros are designed to be used within a single C function: see
510 * Python/pystrtod.c for an example of their use.
511 */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000512
Mark Dickinsona4262b92009-04-19 11:35:55 +0000513/* get and set x87 control word for gcc/x86 */
Mark Dickinson7abf8d42009-04-18 20:17:52 +0000514#ifdef HAVE_GCC_ASM_FOR_X87
Mark Dickinsona4262b92009-04-19 11:35:55 +0000515#define HAVE_PY_SET_53BIT_PRECISION 1
516/* _Py_get/set_387controlword functions are defined in Python/pymath.c */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000517#define _Py_SET_53BIT_PRECISION_HEADER \
518 unsigned short old_387controlword, new_387controlword
519#define _Py_SET_53BIT_PRECISION_START \
520 do { \
521 old_387controlword = _Py_get_387controlword(); \
522 new_387controlword = (old_387controlword & ~0x0f00) | 0x0200; \
523 if (new_387controlword != old_387controlword) \
524 _Py_set_387controlword(new_387controlword); \
525 } while (0)
526#define _Py_SET_53BIT_PRECISION_END \
527 if (new_387controlword != old_387controlword) \
528 _Py_set_387controlword(old_387controlword)
Mark Dickinsona4262b92009-04-19 11:35:55 +0000529#endif
530
531/* default definitions are empty */
532#ifndef HAVE_PY_SET_53BIT_PRECISION
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000533#define _Py_SET_53BIT_PRECISION_HEADER
534#define _Py_SET_53BIT_PRECISION_START
535#define _Py_SET_53BIT_PRECISION_END
536#endif
537
538/* If we can't guarantee 53-bit precision, don't use the code
539 in Python/dtoa.c, but fall back to standard code. This
540 means that repr of a float will be long (17 sig digits).
541
542 Realistically, there are two things that could go wrong:
543
544 (1) doubles aren't IEEE 754 doubles, or
545 (2) we're on x86 with the rounding precision set to 64-bits
546 (extended precision), and we don't know how to change
547 the rounding precision.
548 */
549
550#if !defined(DOUBLE_IS_LITTLE_ENDIAN_IEEE754) && \
551 !defined(DOUBLE_IS_BIG_ENDIAN_IEEE754) && \
552 !defined(DOUBLE_IS_ARM_MIXED_ENDIAN_IEEE754)
553#define PY_NO_SHORT_FLOAT_REPR
554#endif
555
Mark Dickinson60fd0992009-04-18 10:16:35 +0000556/* double rounding is symptomatic of use of extended precision on x86. If
557 we're seeing double rounding, and we don't have any mechanism available for
558 changing the FPU rounding precision, then don't use Python/dtoa.c. */
Mark Dickinsona4262b92009-04-19 11:35:55 +0000559#if defined(X87_DOUBLE_ROUNDING) && !defined(HAVE_PY_SET_53BIT_PRECISION)
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000560#define PY_NO_SHORT_FLOAT_REPR
561#endif
562
563
Neal Norwitz80292642002-12-19 15:12:26 +0000564/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000565 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000566 * Usage:
567 * extern int old_var Py_DEPRECATED(2.3);
568 * typedef int T1 Py_DEPRECATED(2.4);
569 * extern int x() Py_DEPRECATED(2.5);
570 */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000571#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
572 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000573#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
574#else
Tim Peters4643bd92002-12-28 21:56:08 +0000575#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000576#endif
577
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000578/**************************************************************************
579Prototypes that are missing from the standard include files on some systems
580(and possibly only some versions of such systems.)
581
582Please be conservative with adding new ones, document them and enclose them
583in platform-specific #ifdefs.
584**************************************************************************/
585
586#ifdef SOLARIS
587/* Unchecked */
588extern int gethostname(char *, int);
589#endif
590
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000591#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000592#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000593extern char * _getpty(int *, int, mode_t, int);
594#endif
595
Georg Brandlf78e02b2008-06-10 17:40:04 +0000596/* On QNX 6, struct termio must be declared by including sys/termio.h
597 if TCGETA, TCSETA, TCSETAW, or TCSETAF are used. sys/termio.h must
598 be included before termios.h or it will generate an error. */
599#ifdef HAVE_SYS_TERMIO_H
600#include <sys/termio.h>
601#endif
602
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000603#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
604#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
605/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
606 functions, even though they are included in libutil. */
607#include <termios.h>
608extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
Christian Heimes400adb02008-02-01 08:12:03 +0000609extern pid_t forkpty(int *, char *, struct termios *, struct winsize *);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000610#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
611#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
612
613
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000614/* On 4.4BSD-descendants, ctype functions serves the whole range of
615 * wchar_t character set rather than single byte code points only.
616 * This characteristic can break some operations of string object
617 * including str.upper() and str.split() on UTF-8 locales. This
618 * workaround was provided by Tim Robbins of FreeBSD project.
619 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000620
621#ifdef __FreeBSD__
622#include <osreldate.h>
623#if __FreeBSD_version > 500039
624#include <ctype.h>
625#include <wctype.h>
626#undef isalnum
627#define isalnum(c) iswalnum(btowc(c))
628#undef isalpha
629#define isalpha(c) iswalpha(btowc(c))
630#undef islower
631#define islower(c) iswlower(btowc(c))
632#undef isspace
633#define isspace(c) iswspace(btowc(c))
634#undef isupper
635#define isupper(c) iswupper(btowc(c))
636#undef tolower
637#define tolower(c) towlower(btowc(c))
638#undef toupper
639#define toupper(c) towupper(btowc(c))
640#endif
641#endif
642
643
Mark Hammond8235ea12002-07-19 06:55:41 +0000644/* Declarations for symbol visibility.
645
646 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000647 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000648 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000649 inside the Python core, they are private to the core.
650 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000651 external linkage depending on the platform.
652
653 As a number of platforms support/require "__declspec(dllimport/dllexport)",
654 we support a HAVE_DECLSPEC_DLL macro to save duplication.
655*/
656
Tim Peters4643bd92002-12-28 21:56:08 +0000657/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000658 All windows ports, except cygwin, are handled in PC/pyconfig.h.
659
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000660 Cygwin is the only other autoconf platform requiring special
661 linkage handling and it uses __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000662*/
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000663#if defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000664# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000665#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000666
Jason Tishler30765592003-09-04 11:04:06 +0000667/* only get special linkage if built as shared or platform is Cygwin */
668#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000669# if defined(HAVE_DECLSPEC_DLL)
670# ifdef Py_BUILD_CORE
671# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000672# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000673 /* module init functions inside the core need no external linkage */
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000674 /* except for Cygwin to handle embedding */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000675# if defined(__CYGWIN__)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000676# define PyMODINIT_FUNC __declspec(dllexport) PyObject*
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000677# else /* __CYGWIN__ */
Martin v. Löwis1a214512008-06-11 05:26:20 +0000678# define PyMODINIT_FUNC PyObject*
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000679# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000680# else /* Py_BUILD_CORE */
681 /* Building an extension module, or an embedded situation */
682 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000683 /* Under Cygwin, auto-import functions to prevent compilation */
684 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
685# if !defined(__CYGWIN__)
686# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
687# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000688# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000689 /* module init functions outside the core must be exported */
690# if defined(__cplusplus)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000691# define PyMODINIT_FUNC extern "C" __declspec(dllexport) PyObject*
Mark Hammond8235ea12002-07-19 06:55:41 +0000692# else /* __cplusplus */
Martin v. Löwis1a214512008-06-11 05:26:20 +0000693# define PyMODINIT_FUNC __declspec(dllexport) PyObject*
Mark Hammond8235ea12002-07-19 06:55:41 +0000694# endif /* __cplusplus */
695# endif /* Py_BUILD_CORE */
696# endif /* HAVE_DECLSPEC */
697#endif /* Py_ENABLE_SHARED */
698
699/* If no external linkage macros defined by now, create defaults */
700#ifndef PyAPI_FUNC
701# define PyAPI_FUNC(RTYPE) RTYPE
702#endif
703#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000704# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000705#endif
706#ifndef PyMODINIT_FUNC
707# if defined(__cplusplus)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000708# define PyMODINIT_FUNC extern "C" PyObject*
Mark Hammond8235ea12002-07-19 06:55:41 +0000709# else /* __cplusplus */
Martin v. Löwis1a214512008-06-11 05:26:20 +0000710# define PyMODINIT_FUNC PyObject*
Mark Hammond8235ea12002-07-19 06:55:41 +0000711# endif /* __cplusplus */
712#endif
713
Fred Draked5fadf72000-09-26 05:46:01 +0000714/* limits.h constants that may be missing */
715
716#ifndef INT_MAX
717#define INT_MAX 2147483647
718#endif
719
720#ifndef LONG_MAX
721#if SIZEOF_LONG == 4
722#define LONG_MAX 0X7FFFFFFFL
723#elif SIZEOF_LONG == 8
724#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
725#else
726#error "could not set LONG_MAX in pyport.h"
727#endif
728#endif
729
730#ifndef LONG_MIN
731#define LONG_MIN (-LONG_MAX-1)
732#endif
733
Tim Petersd57731f2000-10-05 01:42:25 +0000734#ifndef LONG_BIT
735#define LONG_BIT (8 * SIZEOF_LONG)
736#endif
737
738#if LONG_BIT != 8 * SIZEOF_LONG
739/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
740 * 32-bit platforms using gcc. We try to catch that here at compile-time
741 * rather than waiting for integer multiplication to trigger bogus
742 * overflows.
743 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000744#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000745#endif
746
Tim Peters7d3a5112000-07-08 04:17:21 +0000747#ifdef __cplusplus
748}
749#endif
750
Neil Schemenauer15691082001-10-23 02:20:37 +0000751/*
752 * Hide GCC attributes from compilers that don't support them.
753 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000754#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Skip Montanaro7a98be22007-08-16 14:35:24 +0000755 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) )
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000756#define Py_GCC_ATTRIBUTE(x)
757#else
758#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000759#endif
760
Thomas Wouters89f507f2006-12-13 04:49:30 +0000761/*
762 * Add PyArg_ParseTuple format where available.
763 */
764#ifdef HAVE_ATTRIBUTE_FORMAT_PARSETUPLE
765#define Py_FORMAT_PARSETUPLE(func,p1,p2) __attribute__((format(func,p1,p2)))
766#else
767#define Py_FORMAT_PARSETUPLE(func,p1,p2)
768#endif
769
Benjamin Peterson058e31e2009-01-16 03:54:08 +0000770/*
771 * Specify alignment on compilers that support it.
772 */
773#if defined(__GNUC__) && __GNUC__ >= 3
774#define Py_ALIGNED(x) __attribute__((aligned(x)))
775#else
776#define Py_ALIGNED(x)
777#endif
778
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000779/* Eliminate end-of-loop code not reached warnings from SunPro C
780 * when using do{...}while(0) macros
781 */
782#ifdef __SUNPRO_C
783#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
784#endif
785
Thomas Wouters477c8d52006-05-27 19:21:47 +0000786/*
787 * Older Microsoft compilers don't support the C99 long long literal suffixes,
788 * so these will be defined in PC/pyconfig.h for those compilers.
789 */
790#ifndef Py_LL
791#define Py_LL(x) x##LL
792#endif
793
794#ifndef Py_ULL
795#define Py_ULL(x) Py_LL(x##U)
796#endif
797
Tim Peters7d3a5112000-07-08 04:17:21 +0000798#endif /* Py_PYPORT_H */