blob: be1d66d5634bd1a0cbee3ae40f5ef954ff13526f [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#include <inttypes.h>
Thomas Wouters89f507f2006-12-13 04:49:30 +00007
Tim Peters7d3a5112000-07-08 04:17:21 +00008/**************************************************************************
9Symbols and macros to supply platform-independent interfaces to basic
Tim Peters1be46842000-07-23 18:10:18 +000010C language & library operations whose spellings vary across platforms.
Tim Peters7d3a5112000-07-08 04:17:21 +000011
12Please try to make documentation here as clear as possible: by definition,
13the stuff here is trying to illuminate C's darkest corners.
14
15Config #defines referenced here:
16
17SIGNED_RIGHT_SHIFT_ZERO_FILLS
18Meaning: To be defined iff i>>j does not extend the sign bit when i is a
19 signed integral type and i < 0.
20Used in: Py_ARITHMETIC_RIGHT_SHIFT
Tim Peters1be46842000-07-23 18:10:18 +000021
Tim Peters8315ea52000-07-23 19:28:35 +000022Py_DEBUG
23Meaning: Extra checks compiled in for debug mode.
24Used in: Py_SAFE_DOWNCAST
Barry Warsawfd847b22000-08-18 04:48:18 +000025
Tim Peters7d3a5112000-07-08 04:17:21 +000026**************************************************************************/
27
Barry Warsawfd847b22000-08-18 04:48:18 +000028/* typedefs for some C9X-defined synonyms for integral types.
29 *
30 * The names in Python are exactly the same as the C9X names, except with a
31 * Py_ prefix. Until C9X is universally implemented, this is the only way
32 * to ensure that Python gets reliable names that don't conflict with names
33 * in non-Python code that are playing their own tricks to define the C9X
34 * names.
35 *
36 * NOTE: don't go nuts here! Python has no use for *most* of the C9X
37 * integral synonyms. Only define the ones we actually need.
38 */
39
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000040#ifndef PY_LONG_LONG
41#define PY_LONG_LONG long long
Guido van Rossumcd16bf62007-06-13 18:07:49 +000042/* If LLONG_MAX is defined in limits.h, use that. */
43#define PY_LLONG_MIN LLONG_MIN
44#define PY_LLONG_MAX LLONG_MAX
45#define PY_ULLONG_MAX ULLONG_MAX
Barry Warsawfd847b22000-08-18 04:48:18 +000046#endif
Barry Warsawfd847b22000-08-18 04:48:18 +000047
Mark Dickinsonbd792642009-03-18 20:06:12 +000048#define PY_UINT32_T uint32_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000049#define PY_UINT64_T uint64_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000050
51/* Signed variants of the above */
Mark Dickinsonbd792642009-03-18 20:06:12 +000052#define PY_INT32_T int32_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000053#define PY_INT64_T int64_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000054
55/* If PYLONG_BITS_IN_DIGIT is not defined then we'll use 30-bit digits if all
56 the necessary integer types are available, and we're on a 64-bit platform
57 (as determined by SIZEOF_VOID_P); otherwise we use 15-bit digits. */
58
59#ifndef PYLONG_BITS_IN_DIGIT
Benjamin Peterson4fe55102016-09-06 11:58:01 -070060#if SIZEOF_VOID_P >= 8
Mark Dickinsonbd792642009-03-18 20:06:12 +000061#define PYLONG_BITS_IN_DIGIT 30
62#else
63#define PYLONG_BITS_IN_DIGIT 15
64#endif
65#endif
66
Barry Warsawfd847b22000-08-18 04:48:18 +000067/* uintptr_t is the C9X name for an unsigned integral type such that a
68 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +000069 * without loss of information. Similarly for intptr_t, wrt a signed
70 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +000071 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000072typedef uintptr_t Py_uintptr_t;
73typedef intptr_t Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +000074
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000075/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
76 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
77 * unsigned integral type). See PEP 353 for details.
78 */
Martin v. Löwis18e16552006-02-15 17:27:45 +000079#ifdef HAVE_SSIZE_T
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000080typedef ssize_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +000081#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000082typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +000083#else
84# error "Python needs a typedef for Py_ssize_t in pyport.h."
85#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000086
Benjamin Peterson8f67d082010-10-17 20:54:53 +000087/* Py_hash_t is the same size as a pointer. */
Christian Heimes985ecdc2013-11-20 11:46:18 +010088#define SIZEOF_PY_HASH_T SIZEOF_SIZE_T
Benjamin Peterson8f67d082010-10-17 20:54:53 +000089typedef Py_ssize_t Py_hash_t;
Benjamin Peterson8035bc52010-10-23 16:20:50 +000090/* Py_uhash_t is the unsigned equivalent needed to calculate numeric hash. */
Christian Heimes985ecdc2013-11-20 11:46:18 +010091#define SIZEOF_PY_UHASH_T SIZEOF_SIZE_T
Benjamin Peterson8035bc52010-10-23 16:20:50 +000092typedef size_t Py_uhash_t;
Benjamin Peterson8f67d082010-10-17 20:54:53 +000093
Larry Hastingsebdcb502013-11-23 14:54:00 -080094/* Only used for compatibility with code that may not be PY_SSIZE_T_CLEAN. */
95#ifdef PY_SSIZE_T_CLEAN
96typedef Py_ssize_t Py_ssize_clean_t;
97#else
98typedef int Py_ssize_clean_t;
99#endif
100
Benjamin Peterson2f8bfef2016-09-07 09:26:18 -0700101/* Largest possible value of size_t. */
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +0000102#define PY_SIZE_MAX SIZE_MAX
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +0000103
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000104/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000105#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000106/* Smallest negative value of type Py_ssize_t. */
107#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
108
109/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
110 * format to convert an argument with the width of a size_t or Py_ssize_t.
111 * C99 introduced "z" for this purpose, but not all platforms support that;
112 * e.g., MS compilers use "I" instead.
113 *
114 * These "high level" Python format functions interpret "z" correctly on
115 * all platforms (Python interprets the format string itself, and does whatever
116 * the platform C requires to convert a size_t/Py_ssize_t argument):
117 *
Christian Heimes72b710a2008-05-26 13:28:38 +0000118 * PyBytes_FromFormat
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000119 * PyErr_Format
Christian Heimes72b710a2008-05-26 13:28:38 +0000120 * PyBytes_FromFormatV
Walter Dörwald7696ed72007-05-31 15:51:35 +0000121 * PyUnicode_FromFormatV
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000122 *
123 * Lower-level uses require that you interpolate the correct format modifier
124 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
125 * example,
126 *
127 * Py_ssize_t index;
128 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
129 *
130 * That will expand to %ld, or %Id, or to something else correct for a
131 * Py_ssize_t on the platform.
132 */
133#ifndef PY_FORMAT_SIZE_T
Thomas Wouters89f507f2006-12-13 04:49:30 +0000134# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000135# define PY_FORMAT_SIZE_T ""
136# elif SIZEOF_SIZE_T == SIZEOF_LONG
137# define PY_FORMAT_SIZE_T "l"
138# elif defined(MS_WINDOWS)
139# define PY_FORMAT_SIZE_T "I"
140# else
141# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
142# endif
143#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000144
Thomas Wouters477c8d52006-05-27 19:21:47 +0000145/* Py_LOCAL can be used instead of static to get the fastest possible calling
146 * convention for functions that are local to a given module.
147 *
148 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
149 * for platforms that support that.
150 *
151 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
Berker Peksag4882cac2015-04-14 09:30:01 +0300152 * "aggressive" inlining/optimization is enabled for the entire module. This
Thomas Wouters477c8d52006-05-27 19:21:47 +0000153 * may lead to code bloat, and may slow things down for those reasons. It may
154 * also lead to errors, if the code relies on pointer aliasing. Use with
155 * care.
156 *
157 * NOTE: You can only use this for functions that are entirely local to a
158 * module; functions that are exported via method tables, callbacks, etc,
159 * should keep using static.
160 */
161
Thomas Wouters477c8d52006-05-27 19:21:47 +0000162#if defined(_MSC_VER)
163#if defined(PY_LOCAL_AGGRESSIVE)
164/* enable more aggressive optimization for visual studio */
165#pragma optimize("agtw", on)
166#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000167/* ignore warnings if the compiler decides not to inline a function */
Thomas Wouters477c8d52006-05-27 19:21:47 +0000168#pragma warning(disable: 4710)
169/* fastest possible local call under MSVC */
170#define Py_LOCAL(type) static type __fastcall
171#define Py_LOCAL_INLINE(type) static __inline type __fastcall
172#elif defined(USE_INLINE)
173#define Py_LOCAL(type) static type
174#define Py_LOCAL_INLINE(type) static inline type
175#else
176#define Py_LOCAL(type) static type
177#define Py_LOCAL_INLINE(type) static type
178#endif
179
Christian Heimesf051e432016-09-13 20:22:02 +0200180/* Py_MEMCPY is kept for backwards compatibility,
181 * see https://bugs.python.org/issue28126 */
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000182#define Py_MEMCPY memcpy
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000183
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000184#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000185
Mark Dickinsona4962cb2009-11-28 12:35:42 +0000186#ifdef HAVE_IEEEFP_H
187#include <ieeefp.h> /* needed for 'finite' declaration on some platforms */
188#endif
189
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000190#include <math.h> /* Moved here from the math section, before extern "C" */
191
192/********************************************
193 * WRAPPER FOR <time.h> and/or <sys/time.h> *
194 ********************************************/
195
196#ifdef TIME_WITH_SYS_TIME
197#include <sys/time.h>
198#include <time.h>
199#else /* !TIME_WITH_SYS_TIME */
200#ifdef HAVE_SYS_TIME_H
201#include <sys/time.h>
202#else /* !HAVE_SYS_TIME_H */
203#include <time.h>
204#endif /* !HAVE_SYS_TIME_H */
205#endif /* !TIME_WITH_SYS_TIME */
206
207
208/******************************
209 * WRAPPER FOR <sys/select.h> *
210 ******************************/
211
212/* NB caller must include <sys/types.h> */
213
214#ifdef HAVE_SYS_SELECT_H
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000215#include <sys/select.h>
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000216#endif /* !HAVE_SYS_SELECT_H */
217
Tim Peters60f42b52001-01-18 03:03:16 +0000218/*******************************
219 * stat() and fstat() fiddling *
220 *******************************/
221
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000222#ifdef HAVE_SYS_STAT_H
Tim Peters60f42b52001-01-18 03:03:16 +0000223#include <sys/stat.h>
224#elif defined(HAVE_STAT_H)
225#include <stat.h>
226#endif
227
Christian Heimes99d61352013-06-23 23:56:05 +0200228#ifndef S_IFMT
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000229/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
Christian Heimes99d61352013-06-23 23:56:05 +0200230#define S_IFMT 0170000
231#endif
232
233#ifndef S_IFLNK
234/* Windows doesn't define S_IFLNK but posixmodule.c maps
235 * IO_REPARSE_TAG_SYMLINK to S_IFLNK */
236# define S_IFLNK 0120000
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000237#endif
238
239#ifndef S_ISREG
240#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
241#endif
242
243#ifndef S_ISDIR
244#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
245#endif
246
Victor Stinnerc6ebd162013-06-23 01:49:42 +0200247#ifndef S_ISCHR
248#define S_ISCHR(x) (((x) & S_IFMT) == S_IFCHR)
249#endif
250
Tim Peters7d3a5112000-07-08 04:17:21 +0000251#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000252/* Move this down here since some C++ #include's don't like to be included
253 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000254extern "C" {
255#endif
256
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000257
Tim Peters7d3a5112000-07-08 04:17:21 +0000258/* Py_ARITHMETIC_RIGHT_SHIFT
259 * C doesn't define whether a right-shift of a signed integer sign-extends
260 * or zero-fills. Here a macro to force sign extension:
261 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
Mark Dickinson16f966e2009-03-20 23:23:15 +0000262 * Return I >> J, forcing sign extension. Arithmetically, return the
263 * floor of I/2**J.
Tim Peters7d3a5112000-07-08 04:17:21 +0000264 * Requirements:
Mark Dickinson16f966e2009-03-20 23:23:15 +0000265 * I should have signed integer type. In the terminology of C99, this can
266 * be either one of the five standard signed integer types (signed char,
267 * short, int, long, long long) or an extended signed integer type.
268 * J is an integer >= 0 and strictly less than the number of bits in the
269 * type of I (because C doesn't define what happens for J outside that
270 * range either).
271 * TYPE used to specify the type of I, but is now ignored. It's been left
272 * in for backwards compatibility with versions <= 2.6 or 3.0.
Tim Peters7d3a5112000-07-08 04:17:21 +0000273 * Caution:
274 * I may be evaluated more than once.
275 */
276#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
277#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000278 ((I) < 0 ? -1-((-1-(I)) >> (J)) : (I) >> (J))
Tim Peters7d3a5112000-07-08 04:17:21 +0000279#else
280#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
281#endif
282
Tim Peters39dce292000-08-15 03:34:48 +0000283/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000284 * "Simply" returns its argument. However, macro expansions within the
285 * argument are evaluated. This unfortunate trickery is needed to get
286 * token-pasting to work as desired in some cases.
287 */
288#define Py_FORCE_EXPANSION(X) X
289
Tim Peters8315ea52000-07-23 19:28:35 +0000290/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
291 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
292 * assert-fails if any information is lost.
293 * Caution:
294 * VALUE may be evaluated more than once.
295 */
296#ifdef Py_DEBUG
297#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000298 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
Tim Peters8315ea52000-07-23 19:28:35 +0000299#else
300#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
301#endif
302
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000303/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000304 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000305 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
306 * to 0 before calling a libm function, and invoke this macro after,
307 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000308 * Caution:
309 * This isn't reliable. See Py_OVERFLOWED comments.
310 * X is evaluated more than once.
311 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000312#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000313#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
314#else
315#define _Py_SET_EDOM_FOR_NAN(X) ;
316#endif
317#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000318 do { \
319 if (errno == 0) { \
320 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
321 errno = ERANGE; \
322 else _Py_SET_EDOM_FOR_NAN(X) \
323 } \
324 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000325
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000326/* Py_SET_ERANGE_ON_OVERFLOW(x)
327 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
328 */
329#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
330
Tim Petersdc5a5082002-03-09 04:58:24 +0000331/* Py_ADJUST_ERANGE1(x)
332 * Py_ADJUST_ERANGE2(x, y)
333 * Set errno to 0 before calling a libm function, and invoke one of these
334 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
335 * for functions returning complex results). This makes two kinds of
336 * adjustments to errno: (A) If it looks like the platform libm set
337 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
338 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
339 * effect, we're trying to force a useful implementation of C89 errno
340 * behavior.
341 * Caution:
342 * This isn't reliable. See Py_OVERFLOWED comments.
343 * X and Y may be evaluated more than once.
344 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000345#define Py_ADJUST_ERANGE1(X) \
346 do { \
347 if (errno == 0) { \
348 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
349 errno = ERANGE; \
350 } \
351 else if (errno == ERANGE && (X) == 0.0) \
352 errno = 0; \
353 } while(0)
Tim Petersdc5a5082002-03-09 04:58:24 +0000354
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000355#define Py_ADJUST_ERANGE2(X, Y) \
356 do { \
357 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
358 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
359 if (errno == 0) \
360 errno = ERANGE; \
361 } \
362 else if (errno == ERANGE) \
363 errno = 0; \
364 } while(0)
Tim Petersdc5a5082002-03-09 04:58:24 +0000365
Mark Dickinsona4262b92009-04-19 11:35:55 +0000366/* The functions _Py_dg_strtod and _Py_dg_dtoa in Python/dtoa.c (which are
367 * required to support the short float repr introduced in Python 3.1) require
368 * that the floating-point unit that's being used for arithmetic operations
369 * on C doubles is set to use 53-bit precision. It also requires that the
370 * FPU rounding mode is round-half-to-even, but that's less often an issue.
371 *
372 * If your FPU isn't already set to 53-bit precision/round-half-to-even, and
373 * you want to make use of _Py_dg_strtod and _Py_dg_dtoa, then you should
374 *
375 * #define HAVE_PY_SET_53BIT_PRECISION 1
376 *
377 * and also give appropriate definitions for the following three macros:
378 *
379 * _PY_SET_53BIT_PRECISION_START : store original FPU settings, and
380 * set FPU to 53-bit precision/round-half-to-even
381 * _PY_SET_53BIT_PRECISION_END : restore original FPU settings
382 * _PY_SET_53BIT_PRECISION_HEADER : any variable declarations needed to
383 * use the two macros above.
384 *
385 * The macros are designed to be used within a single C function: see
386 * Python/pystrtod.c for an example of their use.
387 */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000388
Mark Dickinsona4262b92009-04-19 11:35:55 +0000389/* get and set x87 control word for gcc/x86 */
Mark Dickinson7abf8d42009-04-18 20:17:52 +0000390#ifdef HAVE_GCC_ASM_FOR_X87
Mark Dickinsona4262b92009-04-19 11:35:55 +0000391#define HAVE_PY_SET_53BIT_PRECISION 1
392/* _Py_get/set_387controlword functions are defined in Python/pymath.c */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000393#define _Py_SET_53BIT_PRECISION_HEADER \
394 unsigned short old_387controlword, new_387controlword
395#define _Py_SET_53BIT_PRECISION_START \
396 do { \
397 old_387controlword = _Py_get_387controlword(); \
398 new_387controlword = (old_387controlword & ~0x0f00) | 0x0200; \
399 if (new_387controlword != old_387controlword) \
400 _Py_set_387controlword(new_387controlword); \
401 } while (0)
402#define _Py_SET_53BIT_PRECISION_END \
403 if (new_387controlword != old_387controlword) \
404 _Py_set_387controlword(old_387controlword)
Mark Dickinsona4262b92009-04-19 11:35:55 +0000405#endif
406
Mark Dickinson18e3d812012-04-15 15:10:56 +0100407/* get and set x87 control word for VisualStudio/x86 */
408#if defined(_MSC_VER) && !defined(_WIN64) /* x87 not supported in 64-bit */
409#define HAVE_PY_SET_53BIT_PRECISION 1
410#define _Py_SET_53BIT_PRECISION_HEADER \
411 unsigned int old_387controlword, new_387controlword, out_387controlword
412/* We use the __control87_2 function to set only the x87 control word.
413 The SSE control word is unaffected. */
414#define _Py_SET_53BIT_PRECISION_START \
415 do { \
416 __control87_2(0, 0, &old_387controlword, NULL); \
417 new_387controlword = \
418 (old_387controlword & ~(_MCW_PC | _MCW_RC)) | (_PC_53 | _RC_NEAR); \
419 if (new_387controlword != old_387controlword) \
420 __control87_2(new_387controlword, _MCW_PC | _MCW_RC, \
421 &out_387controlword, NULL); \
422 } while (0)
423#define _Py_SET_53BIT_PRECISION_END \
424 do { \
425 if (new_387controlword != old_387controlword) \
426 __control87_2(old_387controlword, _MCW_PC | _MCW_RC, \
427 &out_387controlword, NULL); \
428 } while (0)
429#endif
430
Benjamin Peterson8bdeb162014-04-17 00:00:31 -0400431#ifdef HAVE_GCC_ASM_FOR_MC68881
432#define HAVE_PY_SET_53BIT_PRECISION 1
433#define _Py_SET_53BIT_PRECISION_HEADER \
434 unsigned int old_fpcr, new_fpcr
Christian Heimesf051e432016-09-13 20:22:02 +0200435#define _Py_SET_53BIT_PRECISION_START \
436 do { \
437 __asm__ ("fmove.l %%fpcr,%0" : "=g" (old_fpcr)); \
438 /* Set double precision / round to nearest. */ \
439 new_fpcr = (old_fpcr & ~0xf0) | 0x80; \
440 if (new_fpcr != old_fpcr) \
441 __asm__ volatile ("fmove.l %0,%%fpcr" : : "g" (new_fpcr)); \
Benjamin Peterson8bdeb162014-04-17 00:00:31 -0400442 } while (0)
Christian Heimesf051e432016-09-13 20:22:02 +0200443#define _Py_SET_53BIT_PRECISION_END \
444 do { \
445 if (new_fpcr != old_fpcr) \
446 __asm__ volatile ("fmove.l %0,%%fpcr" : : "g" (old_fpcr)); \
Benjamin Peterson8bdeb162014-04-17 00:00:31 -0400447 } while (0)
448#endif
449
Mark Dickinsona4262b92009-04-19 11:35:55 +0000450/* default definitions are empty */
451#ifndef HAVE_PY_SET_53BIT_PRECISION
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000452#define _Py_SET_53BIT_PRECISION_HEADER
453#define _Py_SET_53BIT_PRECISION_START
454#define _Py_SET_53BIT_PRECISION_END
455#endif
456
457/* If we can't guarantee 53-bit precision, don't use the code
458 in Python/dtoa.c, but fall back to standard code. This
459 means that repr of a float will be long (17 sig digits).
460
461 Realistically, there are two things that could go wrong:
462
463 (1) doubles aren't IEEE 754 doubles, or
464 (2) we're on x86 with the rounding precision set to 64-bits
465 (extended precision), and we don't know how to change
466 the rounding precision.
467 */
468
469#if !defined(DOUBLE_IS_LITTLE_ENDIAN_IEEE754) && \
470 !defined(DOUBLE_IS_BIG_ENDIAN_IEEE754) && \
471 !defined(DOUBLE_IS_ARM_MIXED_ENDIAN_IEEE754)
472#define PY_NO_SHORT_FLOAT_REPR
473#endif
474
Mark Dickinson60fd0992009-04-18 10:16:35 +0000475/* double rounding is symptomatic of use of extended precision on x86. If
476 we're seeing double rounding, and we don't have any mechanism available for
477 changing the FPU rounding precision, then don't use Python/dtoa.c. */
Mark Dickinsona4262b92009-04-19 11:35:55 +0000478#if defined(X87_DOUBLE_ROUNDING) && !defined(HAVE_PY_SET_53BIT_PRECISION)
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000479#define PY_NO_SHORT_FLOAT_REPR
480#endif
481
482
Neal Norwitz80292642002-12-19 15:12:26 +0000483/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000484 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000485 * Usage:
486 * extern int old_var Py_DEPRECATED(2.3);
487 * typedef int T1 Py_DEPRECATED(2.4);
488 * extern int x() Py_DEPRECATED(2.5);
489 */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000490#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000491 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000492#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
493#else
Tim Peters4643bd92002-12-28 21:56:08 +0000494#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000495#endif
496
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000497/**************************************************************************
498Prototypes that are missing from the standard include files on some systems
499(and possibly only some versions of such systems.)
500
501Please be conservative with adding new ones, document them and enclose them
502in platform-specific #ifdefs.
503**************************************************************************/
504
505#ifdef SOLARIS
506/* Unchecked */
507extern int gethostname(char *, int);
508#endif
509
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000510#ifdef HAVE__GETPTY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000512extern char * _getpty(int *, int, mode_t, int);
513#endif
514
Georg Brandlf78e02b2008-06-10 17:40:04 +0000515/* On QNX 6, struct termio must be declared by including sys/termio.h
516 if TCGETA, TCSETA, TCSETAW, or TCSETAF are used. sys/termio.h must
517 be included before termios.h or it will generate an error. */
Stefan Krah2cbbed62012-11-19 00:07:18 +0100518#if defined(HAVE_SYS_TERMIO_H) && !defined(__hpux)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000519#include <sys/termio.h>
520#endif
521
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000522#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
523#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
524/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
525 functions, even though they are included in libutil. */
526#include <termios.h>
Serhiy Storchakaaa2b22a2013-10-19 21:39:31 +0300527extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
528extern pid_t forkpty(int *, char *, struct termios *, struct winsize *);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000529#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
530#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
531
532
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000533/* On 4.4BSD-descendants, ctype functions serves the whole range of
534 * wchar_t character set rather than single byte code points only.
535 * This characteristic can break some operations of string object
536 * including str.upper() and str.split() on UTF-8 locales. This
537 * workaround was provided by Tim Robbins of FreeBSD project.
538 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000539
540#ifdef __FreeBSD__
541#include <osreldate.h>
Ned Deily3d455992016-08-15 03:08:18 -0400542#if (__FreeBSD_version >= 500040 && __FreeBSD_version < 602113) || \
543 (__FreeBSD_version >= 700000 && __FreeBSD_version < 700054) || \
544 (__FreeBSD_version >= 800000 && __FreeBSD_version < 800001)
Ronald Oussoren501aeff2010-04-18 15:02:38 +0000545# define _PY_PORT_CTYPE_UTF8_ISSUE
546#endif
547#endif
548
549
550#if defined(__APPLE__)
551# define _PY_PORT_CTYPE_UTF8_ISSUE
552#endif
553
554#ifdef _PY_PORT_CTYPE_UTF8_ISSUE
Ned Deily7659aab2016-08-15 03:07:26 -0400555#ifndef __cplusplus
556 /* The workaround below is unsafe in C++ because
557 * the <locale> defines these symbols as real functions,
558 * with a slightly different signature.
559 * See issue #10910
560 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000561#include <ctype.h>
562#include <wctype.h>
563#undef isalnum
564#define isalnum(c) iswalnum(btowc(c))
565#undef isalpha
566#define isalpha(c) iswalpha(btowc(c))
567#undef islower
568#define islower(c) iswlower(btowc(c))
569#undef isspace
570#define isspace(c) iswspace(btowc(c))
571#undef isupper
572#define isupper(c) iswupper(btowc(c))
573#undef tolower
574#define tolower(c) towlower(btowc(c))
575#undef toupper
576#define toupper(c) towupper(btowc(c))
577#endif
Ned Deily7659aab2016-08-15 03:07:26 -0400578#endif
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000579
580
Mark Hammond8235ea12002-07-19 06:55:41 +0000581/* Declarations for symbol visibility.
582
583 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000584 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000585 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000586 inside the Python core, they are private to the core.
587 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000588 external linkage depending on the platform.
589
590 As a number of platforms support/require "__declspec(dllimport/dllexport)",
591 we support a HAVE_DECLSPEC_DLL macro to save duplication.
592*/
593
Tim Peters4643bd92002-12-28 21:56:08 +0000594/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000595 All windows ports, except cygwin, are handled in PC/pyconfig.h.
596
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000597 Cygwin is the only other autoconf platform requiring special
598 linkage handling and it uses __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000599*/
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000600#if defined(__CYGWIN__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000601# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000602#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000603
Jason Tishler30765592003-09-04 11:04:06 +0000604/* only get special linkage if built as shared or platform is Cygwin */
605#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000606# if defined(HAVE_DECLSPEC_DLL)
607# ifdef Py_BUILD_CORE
608# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
609# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Daniel Stutzbach38615992010-09-14 16:02:01 +0000610 /* module init functions inside the core need no external linkage */
611 /* except for Cygwin to handle embedding */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000612# if defined(__CYGWIN__)
613# define PyMODINIT_FUNC __declspec(dllexport) PyObject*
614# else /* __CYGWIN__ */
615# define PyMODINIT_FUNC PyObject*
616# endif /* __CYGWIN__ */
617# else /* Py_BUILD_CORE */
Daniel Stutzbach38615992010-09-14 16:02:01 +0000618 /* Building an extension module, or an embedded situation */
619 /* public Python functions and data are imported */
620 /* Under Cygwin, auto-import functions to prevent compilation */
621 /* failures similar to those described at the bottom of 4.1: */
622 /* http://docs.python.org/extending/windows.html#a-cookbook-approach */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000623# if !defined(__CYGWIN__)
624# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
625# endif /* !__CYGWIN__ */
626# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Daniel Stutzbach38615992010-09-14 16:02:01 +0000627 /* module init functions outside the core must be exported */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000628# if defined(__cplusplus)
629# define PyMODINIT_FUNC extern "C" __declspec(dllexport) PyObject*
630# else /* __cplusplus */
631# define PyMODINIT_FUNC __declspec(dllexport) PyObject*
632# endif /* __cplusplus */
633# endif /* Py_BUILD_CORE */
634# endif /* HAVE_DECLSPEC */
Mark Hammond8235ea12002-07-19 06:55:41 +0000635#endif /* Py_ENABLE_SHARED */
636
637/* If no external linkage macros defined by now, create defaults */
638#ifndef PyAPI_FUNC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000639# define PyAPI_FUNC(RTYPE) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000640#endif
641#ifndef PyAPI_DATA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000642# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000643#endif
644#ifndef PyMODINIT_FUNC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000645# if defined(__cplusplus)
646# define PyMODINIT_FUNC extern "C" PyObject*
647# else /* __cplusplus */
648# define PyMODINIT_FUNC PyObject*
649# endif /* __cplusplus */
Mark Hammond8235ea12002-07-19 06:55:41 +0000650#endif
651
Fred Draked5fadf72000-09-26 05:46:01 +0000652/* limits.h constants that may be missing */
653
654#ifndef INT_MAX
655#define INT_MAX 2147483647
656#endif
657
658#ifndef LONG_MAX
659#if SIZEOF_LONG == 4
660#define LONG_MAX 0X7FFFFFFFL
661#elif SIZEOF_LONG == 8
662#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
663#else
664#error "could not set LONG_MAX in pyport.h"
665#endif
666#endif
667
668#ifndef LONG_MIN
669#define LONG_MIN (-LONG_MAX-1)
670#endif
671
Tim Petersd57731f2000-10-05 01:42:25 +0000672#ifndef LONG_BIT
673#define LONG_BIT (8 * SIZEOF_LONG)
674#endif
675
676#if LONG_BIT != 8 * SIZEOF_LONG
677/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
678 * 32-bit platforms using gcc. We try to catch that here at compile-time
679 * rather than waiting for integer multiplication to trigger bogus
680 * overflows.
681 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000682#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000683#endif
684
Tim Peters7d3a5112000-07-08 04:17:21 +0000685#ifdef __cplusplus
686}
687#endif
688
Neil Schemenauer15691082001-10-23 02:20:37 +0000689/*
690 * Hide GCC attributes from compilers that don't support them.
691 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000692#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Skip Montanaro7a98be22007-08-16 14:35:24 +0000693 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) )
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000694#define Py_GCC_ATTRIBUTE(x)
695#else
696#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000697#endif
698
Thomas Wouters89f507f2006-12-13 04:49:30 +0000699/*
Benjamin Peterson058e31e2009-01-16 03:54:08 +0000700 * Specify alignment on compilers that support it.
701 */
702#if defined(__GNUC__) && __GNUC__ >= 3
703#define Py_ALIGNED(x) __attribute__((aligned(x)))
704#else
705#define Py_ALIGNED(x)
706#endif
707
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000708/* Eliminate end-of-loop code not reached warnings from SunPro C
709 * when using do{...}while(0) macros
710 */
711#ifdef __SUNPRO_C
712#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
713#endif
714
Thomas Wouters477c8d52006-05-27 19:21:47 +0000715/*
716 * Older Microsoft compilers don't support the C99 long long literal suffixes,
717 * so these will be defined in PC/pyconfig.h for those compilers.
718 */
719#ifndef Py_LL
720#define Py_LL(x) x##LL
721#endif
722
723#ifndef Py_ULL
724#define Py_ULL(x) Py_LL(x##U)
725#endif
726
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000727#ifdef VA_LIST_IS_ARRAY
Christian Heimesf051e432016-09-13 20:22:02 +0200728#define Py_VA_COPY(x, y) memcpy((x), (y), sizeof(va_list))
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000729#else
730#ifdef __va_copy
731#define Py_VA_COPY __va_copy
732#else
733#define Py_VA_COPY(x, y) (x) = (y)
734#endif
735#endif
736
Christian Heimes743e0cd2012-10-17 23:52:17 +0200737/*
Georg Brandl3962d5e2012-10-28 08:48:28 +0100738 * Convenient macros to deal with endianness of the platform. WORDS_BIGENDIAN is
Christian Heimes743e0cd2012-10-17 23:52:17 +0200739 * detected by configure and defined in pyconfig.h. The code in pyconfig.h
Terry Jan Reedy8e7586b2013-03-11 18:38:13 -0400740 * also takes care of Apple's universal builds.
Christian Heimes743e0cd2012-10-17 23:52:17 +0200741 */
742
743#ifdef WORDS_BIGENDIAN
744#define PY_BIG_ENDIAN 1
745#define PY_LITTLE_ENDIAN 0
746#else
747#define PY_BIG_ENDIAN 0
748#define PY_LITTLE_ENDIAN 1
749#endif
750
Steve Dower8fc89802015-04-12 00:26:27 -0400751#ifdef Py_BUILD_CORE
752/*
753 * Macros to protect CRT calls against instant termination when passed an
754 * invalid parameter (issue23524).
755 */
756#if defined _MSC_VER && _MSC_VER >= 1900
757
758extern _invalid_parameter_handler _Py_silent_invalid_parameter_handler;
759#define _Py_BEGIN_SUPPRESS_IPH { _invalid_parameter_handler _Py_old_handler = \
760 _set_thread_local_invalid_parameter_handler(_Py_silent_invalid_parameter_handler);
761#define _Py_END_SUPPRESS_IPH _set_thread_local_invalid_parameter_handler(_Py_old_handler); }
762
763#else
764
765#define _Py_BEGIN_SUPPRESS_IPH
766#define _Py_END_SUPPRESS_IPH
767
768#endif /* _MSC_VER >= 1900 */
769#endif /* Py_BUILD_CORE */
770
Stefan Krah1f9eb872016-05-22 17:35:34 +0200771#ifdef __ANDROID__
772#include <android/api-level.h>
773#endif
774
Tim Peters7d3a5112000-07-08 04:17:21 +0000775#endif /* Py_PYPORT_H */