blob: 20f3db748155c835edf621a00ea7ab4224916a99 [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
Benjamin Peterson41e35f32016-09-18 18:02:58 -070040// long long is required now. Define HAVE_LONG_LONG unconditionally for
41// compatibility.
42#define HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000043#ifndef PY_LONG_LONG
44#define PY_LONG_LONG long long
Guido van Rossumcd16bf62007-06-13 18:07:49 +000045/* If LLONG_MAX is defined in limits.h, use that. */
46#define PY_LLONG_MIN LLONG_MIN
47#define PY_LLONG_MAX LLONG_MAX
48#define PY_ULLONG_MAX ULLONG_MAX
Barry Warsawfd847b22000-08-18 04:48:18 +000049#endif
Barry Warsawfd847b22000-08-18 04:48:18 +000050
Mark Dickinsonbd792642009-03-18 20:06:12 +000051#define PY_UINT32_T uint32_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000052#define PY_UINT64_T uint64_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000053
54/* Signed variants of the above */
Mark Dickinsonbd792642009-03-18 20:06:12 +000055#define PY_INT32_T int32_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000056#define PY_INT64_T int64_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000057
58/* If PYLONG_BITS_IN_DIGIT is not defined then we'll use 30-bit digits if all
59 the necessary integer types are available, and we're on a 64-bit platform
60 (as determined by SIZEOF_VOID_P); otherwise we use 15-bit digits. */
61
62#ifndef PYLONG_BITS_IN_DIGIT
Benjamin Peterson4fe55102016-09-06 11:58:01 -070063#if SIZEOF_VOID_P >= 8
Mark Dickinsonbd792642009-03-18 20:06:12 +000064#define PYLONG_BITS_IN_DIGIT 30
65#else
66#define PYLONG_BITS_IN_DIGIT 15
67#endif
68#endif
69
Barry Warsawfd847b22000-08-18 04:48:18 +000070/* uintptr_t is the C9X name for an unsigned integral type such that a
71 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +000072 * without loss of information. Similarly for intptr_t, wrt a signed
73 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +000074 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000075typedef uintptr_t Py_uintptr_t;
76typedef intptr_t Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +000077
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000078/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
79 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
80 * unsigned integral type). See PEP 353 for details.
81 */
Martin v. Löwis18e16552006-02-15 17:27:45 +000082#ifdef HAVE_SSIZE_T
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000083typedef ssize_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +000084#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000085typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +000086#else
87# error "Python needs a typedef for Py_ssize_t in pyport.h."
88#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000089
Benjamin Peterson8f67d082010-10-17 20:54:53 +000090/* Py_hash_t is the same size as a pointer. */
Christian Heimes985ecdc2013-11-20 11:46:18 +010091#define SIZEOF_PY_HASH_T SIZEOF_SIZE_T
Benjamin Peterson8f67d082010-10-17 20:54:53 +000092typedef Py_ssize_t Py_hash_t;
Benjamin Peterson8035bc52010-10-23 16:20:50 +000093/* Py_uhash_t is the unsigned equivalent needed to calculate numeric hash. */
Christian Heimes985ecdc2013-11-20 11:46:18 +010094#define SIZEOF_PY_UHASH_T SIZEOF_SIZE_T
Benjamin Peterson8035bc52010-10-23 16:20:50 +000095typedef size_t Py_uhash_t;
Benjamin Peterson8f67d082010-10-17 20:54:53 +000096
Larry Hastingsebdcb502013-11-23 14:54:00 -080097/* Only used for compatibility with code that may not be PY_SSIZE_T_CLEAN. */
98#ifdef PY_SSIZE_T_CLEAN
99typedef Py_ssize_t Py_ssize_clean_t;
100#else
101typedef int Py_ssize_clean_t;
102#endif
103
Benjamin Peterson2f8bfef2016-09-07 09:26:18 -0700104/* Largest possible value of size_t. */
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +0000105#define PY_SIZE_MAX SIZE_MAX
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +0000106
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000107/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000108#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000109/* Smallest negative value of type Py_ssize_t. */
110#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
111
112/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
113 * format to convert an argument with the width of a size_t or Py_ssize_t.
114 * C99 introduced "z" for this purpose, but not all platforms support that;
115 * e.g., MS compilers use "I" instead.
116 *
117 * These "high level" Python format functions interpret "z" correctly on
118 * all platforms (Python interprets the format string itself, and does whatever
119 * the platform C requires to convert a size_t/Py_ssize_t argument):
120 *
Christian Heimes72b710a2008-05-26 13:28:38 +0000121 * PyBytes_FromFormat
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000122 * PyErr_Format
Christian Heimes72b710a2008-05-26 13:28:38 +0000123 * PyBytes_FromFormatV
Walter Dörwald7696ed72007-05-31 15:51:35 +0000124 * PyUnicode_FromFormatV
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000125 *
126 * Lower-level uses require that you interpolate the correct format modifier
127 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
128 * example,
129 *
130 * Py_ssize_t index;
131 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
132 *
133 * That will expand to %ld, or %Id, or to something else correct for a
134 * Py_ssize_t on the platform.
135 */
136#ifndef PY_FORMAT_SIZE_T
Thomas Wouters89f507f2006-12-13 04:49:30 +0000137# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000138# define PY_FORMAT_SIZE_T ""
139# elif SIZEOF_SIZE_T == SIZEOF_LONG
140# define PY_FORMAT_SIZE_T "l"
141# elif defined(MS_WINDOWS)
142# define PY_FORMAT_SIZE_T "I"
143# else
144# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
145# endif
146#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000147
Thomas Wouters477c8d52006-05-27 19:21:47 +0000148/* Py_LOCAL can be used instead of static to get the fastest possible calling
149 * convention for functions that are local to a given module.
150 *
151 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
152 * for platforms that support that.
153 *
154 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
Berker Peksag4882cac2015-04-14 09:30:01 +0300155 * "aggressive" inlining/optimization is enabled for the entire module. This
Thomas Wouters477c8d52006-05-27 19:21:47 +0000156 * may lead to code bloat, and may slow things down for those reasons. It may
157 * also lead to errors, if the code relies on pointer aliasing. Use with
158 * care.
159 *
160 * NOTE: You can only use this for functions that are entirely local to a
161 * module; functions that are exported via method tables, callbacks, etc,
162 * should keep using static.
163 */
164
Thomas Wouters477c8d52006-05-27 19:21:47 +0000165#if defined(_MSC_VER)
166#if defined(PY_LOCAL_AGGRESSIVE)
167/* enable more aggressive optimization for visual studio */
168#pragma optimize("agtw", on)
169#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000170/* ignore warnings if the compiler decides not to inline a function */
Thomas Wouters477c8d52006-05-27 19:21:47 +0000171#pragma warning(disable: 4710)
172/* fastest possible local call under MSVC */
173#define Py_LOCAL(type) static type __fastcall
174#define Py_LOCAL_INLINE(type) static __inline type __fastcall
175#elif defined(USE_INLINE)
176#define Py_LOCAL(type) static type
177#define Py_LOCAL_INLINE(type) static inline type
178#else
179#define Py_LOCAL(type) static type
180#define Py_LOCAL_INLINE(type) static type
181#endif
182
Christian Heimesf051e432016-09-13 20:22:02 +0200183/* Py_MEMCPY is kept for backwards compatibility,
184 * see https://bugs.python.org/issue28126 */
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000185#define Py_MEMCPY memcpy
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000186
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000187#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000188
Mark Dickinsona4962cb2009-11-28 12:35:42 +0000189#ifdef HAVE_IEEEFP_H
190#include <ieeefp.h> /* needed for 'finite' declaration on some platforms */
191#endif
192
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000193#include <math.h> /* Moved here from the math section, before extern "C" */
194
195/********************************************
196 * WRAPPER FOR <time.h> and/or <sys/time.h> *
197 ********************************************/
198
199#ifdef TIME_WITH_SYS_TIME
200#include <sys/time.h>
201#include <time.h>
202#else /* !TIME_WITH_SYS_TIME */
203#ifdef HAVE_SYS_TIME_H
204#include <sys/time.h>
205#else /* !HAVE_SYS_TIME_H */
206#include <time.h>
207#endif /* !HAVE_SYS_TIME_H */
208#endif /* !TIME_WITH_SYS_TIME */
209
210
211/******************************
212 * WRAPPER FOR <sys/select.h> *
213 ******************************/
214
215/* NB caller must include <sys/types.h> */
216
217#ifdef HAVE_SYS_SELECT_H
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000218#include <sys/select.h>
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000219#endif /* !HAVE_SYS_SELECT_H */
220
Tim Peters60f42b52001-01-18 03:03:16 +0000221/*******************************
222 * stat() and fstat() fiddling *
223 *******************************/
224
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000225#ifdef HAVE_SYS_STAT_H
Tim Peters60f42b52001-01-18 03:03:16 +0000226#include <sys/stat.h>
227#elif defined(HAVE_STAT_H)
228#include <stat.h>
229#endif
230
Christian Heimes99d61352013-06-23 23:56:05 +0200231#ifndef S_IFMT
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000232/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
Christian Heimes99d61352013-06-23 23:56:05 +0200233#define S_IFMT 0170000
234#endif
235
236#ifndef S_IFLNK
237/* Windows doesn't define S_IFLNK but posixmodule.c maps
238 * IO_REPARSE_TAG_SYMLINK to S_IFLNK */
239# define S_IFLNK 0120000
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000240#endif
241
242#ifndef S_ISREG
243#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
244#endif
245
246#ifndef S_ISDIR
247#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
248#endif
249
Victor Stinnerc6ebd162013-06-23 01:49:42 +0200250#ifndef S_ISCHR
251#define S_ISCHR(x) (((x) & S_IFMT) == S_IFCHR)
252#endif
253
Tim Peters7d3a5112000-07-08 04:17:21 +0000254#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000255/* Move this down here since some C++ #include's don't like to be included
256 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000257extern "C" {
258#endif
259
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000260
Tim Peters7d3a5112000-07-08 04:17:21 +0000261/* Py_ARITHMETIC_RIGHT_SHIFT
262 * C doesn't define whether a right-shift of a signed integer sign-extends
263 * or zero-fills. Here a macro to force sign extension:
264 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
Mark Dickinson16f966e2009-03-20 23:23:15 +0000265 * Return I >> J, forcing sign extension. Arithmetically, return the
266 * floor of I/2**J.
Tim Peters7d3a5112000-07-08 04:17:21 +0000267 * Requirements:
Mark Dickinson16f966e2009-03-20 23:23:15 +0000268 * I should have signed integer type. In the terminology of C99, this can
269 * be either one of the five standard signed integer types (signed char,
270 * short, int, long, long long) or an extended signed integer type.
271 * J is an integer >= 0 and strictly less than the number of bits in the
272 * type of I (because C doesn't define what happens for J outside that
273 * range either).
274 * TYPE used to specify the type of I, but is now ignored. It's been left
275 * in for backwards compatibility with versions <= 2.6 or 3.0.
Tim Peters7d3a5112000-07-08 04:17:21 +0000276 * Caution:
277 * I may be evaluated more than once.
278 */
279#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
280#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000281 ((I) < 0 ? -1-((-1-(I)) >> (J)) : (I) >> (J))
Tim Peters7d3a5112000-07-08 04:17:21 +0000282#else
283#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
284#endif
285
Tim Peters39dce292000-08-15 03:34:48 +0000286/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000287 * "Simply" returns its argument. However, macro expansions within the
288 * argument are evaluated. This unfortunate trickery is needed to get
289 * token-pasting to work as desired in some cases.
290 */
291#define Py_FORCE_EXPANSION(X) X
292
Tim Peters8315ea52000-07-23 19:28:35 +0000293/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
294 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
295 * assert-fails if any information is lost.
296 * Caution:
297 * VALUE may be evaluated more than once.
298 */
299#ifdef Py_DEBUG
300#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000301 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
Tim Peters8315ea52000-07-23 19:28:35 +0000302#else
303#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
304#endif
305
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000306/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000307 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000308 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
309 * to 0 before calling a libm function, and invoke this macro after,
310 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000311 * Caution:
312 * This isn't reliable. See Py_OVERFLOWED comments.
313 * X is evaluated more than once.
314 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000315#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000316#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
317#else
318#define _Py_SET_EDOM_FOR_NAN(X) ;
319#endif
320#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000321 do { \
322 if (errno == 0) { \
323 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
324 errno = ERANGE; \
325 else _Py_SET_EDOM_FOR_NAN(X) \
326 } \
327 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000328
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000329/* Py_SET_ERANGE_ON_OVERFLOW(x)
330 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
331 */
332#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
333
Tim Petersdc5a5082002-03-09 04:58:24 +0000334/* Py_ADJUST_ERANGE1(x)
335 * Py_ADJUST_ERANGE2(x, y)
336 * Set errno to 0 before calling a libm function, and invoke one of these
337 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
338 * for functions returning complex results). This makes two kinds of
339 * adjustments to errno: (A) If it looks like the platform libm set
340 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
341 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
342 * effect, we're trying to force a useful implementation of C89 errno
343 * behavior.
344 * Caution:
345 * This isn't reliable. See Py_OVERFLOWED comments.
346 * X and Y may be evaluated more than once.
347 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000348#define Py_ADJUST_ERANGE1(X) \
349 do { \
350 if (errno == 0) { \
351 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
352 errno = ERANGE; \
353 } \
354 else if (errno == ERANGE && (X) == 0.0) \
355 errno = 0; \
356 } while(0)
Tim Petersdc5a5082002-03-09 04:58:24 +0000357
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000358#define Py_ADJUST_ERANGE2(X, Y) \
359 do { \
360 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
361 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
362 if (errno == 0) \
363 errno = ERANGE; \
364 } \
365 else if (errno == ERANGE) \
366 errno = 0; \
367 } while(0)
Tim Petersdc5a5082002-03-09 04:58:24 +0000368
Mark Dickinsona4262b92009-04-19 11:35:55 +0000369/* The functions _Py_dg_strtod and _Py_dg_dtoa in Python/dtoa.c (which are
370 * required to support the short float repr introduced in Python 3.1) require
371 * that the floating-point unit that's being used for arithmetic operations
372 * on C doubles is set to use 53-bit precision. It also requires that the
373 * FPU rounding mode is round-half-to-even, but that's less often an issue.
374 *
375 * If your FPU isn't already set to 53-bit precision/round-half-to-even, and
376 * you want to make use of _Py_dg_strtod and _Py_dg_dtoa, then you should
377 *
378 * #define HAVE_PY_SET_53BIT_PRECISION 1
379 *
380 * and also give appropriate definitions for the following three macros:
381 *
382 * _PY_SET_53BIT_PRECISION_START : store original FPU settings, and
383 * set FPU to 53-bit precision/round-half-to-even
384 * _PY_SET_53BIT_PRECISION_END : restore original FPU settings
385 * _PY_SET_53BIT_PRECISION_HEADER : any variable declarations needed to
386 * use the two macros above.
387 *
388 * The macros are designed to be used within a single C function: see
389 * Python/pystrtod.c for an example of their use.
390 */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000391
Mark Dickinsona4262b92009-04-19 11:35:55 +0000392/* get and set x87 control word for gcc/x86 */
Mark Dickinson7abf8d42009-04-18 20:17:52 +0000393#ifdef HAVE_GCC_ASM_FOR_X87
Mark Dickinsona4262b92009-04-19 11:35:55 +0000394#define HAVE_PY_SET_53BIT_PRECISION 1
395/* _Py_get/set_387controlword functions are defined in Python/pymath.c */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000396#define _Py_SET_53BIT_PRECISION_HEADER \
397 unsigned short old_387controlword, new_387controlword
398#define _Py_SET_53BIT_PRECISION_START \
399 do { \
400 old_387controlword = _Py_get_387controlword(); \
401 new_387controlword = (old_387controlword & ~0x0f00) | 0x0200; \
402 if (new_387controlword != old_387controlword) \
403 _Py_set_387controlword(new_387controlword); \
404 } while (0)
405#define _Py_SET_53BIT_PRECISION_END \
406 if (new_387controlword != old_387controlword) \
407 _Py_set_387controlword(old_387controlword)
Mark Dickinsona4262b92009-04-19 11:35:55 +0000408#endif
409
Mark Dickinson18e3d812012-04-15 15:10:56 +0100410/* get and set x87 control word for VisualStudio/x86 */
411#if defined(_MSC_VER) && !defined(_WIN64) /* x87 not supported in 64-bit */
412#define HAVE_PY_SET_53BIT_PRECISION 1
413#define _Py_SET_53BIT_PRECISION_HEADER \
414 unsigned int old_387controlword, new_387controlword, out_387controlword
415/* We use the __control87_2 function to set only the x87 control word.
416 The SSE control word is unaffected. */
417#define _Py_SET_53BIT_PRECISION_START \
418 do { \
419 __control87_2(0, 0, &old_387controlword, NULL); \
420 new_387controlword = \
421 (old_387controlword & ~(_MCW_PC | _MCW_RC)) | (_PC_53 | _RC_NEAR); \
422 if (new_387controlword != old_387controlword) \
423 __control87_2(new_387controlword, _MCW_PC | _MCW_RC, \
424 &out_387controlword, NULL); \
425 } while (0)
426#define _Py_SET_53BIT_PRECISION_END \
427 do { \
428 if (new_387controlword != old_387controlword) \
429 __control87_2(old_387controlword, _MCW_PC | _MCW_RC, \
430 &out_387controlword, NULL); \
431 } while (0)
432#endif
433
Benjamin Peterson8bdeb162014-04-17 00:00:31 -0400434#ifdef HAVE_GCC_ASM_FOR_MC68881
435#define HAVE_PY_SET_53BIT_PRECISION 1
436#define _Py_SET_53BIT_PRECISION_HEADER \
437 unsigned int old_fpcr, new_fpcr
Christian Heimesf051e432016-09-13 20:22:02 +0200438#define _Py_SET_53BIT_PRECISION_START \
439 do { \
440 __asm__ ("fmove.l %%fpcr,%0" : "=g" (old_fpcr)); \
441 /* Set double precision / round to nearest. */ \
442 new_fpcr = (old_fpcr & ~0xf0) | 0x80; \
443 if (new_fpcr != old_fpcr) \
444 __asm__ volatile ("fmove.l %0,%%fpcr" : : "g" (new_fpcr)); \
Benjamin Peterson8bdeb162014-04-17 00:00:31 -0400445 } while (0)
Christian Heimesf051e432016-09-13 20:22:02 +0200446#define _Py_SET_53BIT_PRECISION_END \
447 do { \
448 if (new_fpcr != old_fpcr) \
449 __asm__ volatile ("fmove.l %0,%%fpcr" : : "g" (old_fpcr)); \
Benjamin Peterson8bdeb162014-04-17 00:00:31 -0400450 } while (0)
451#endif
452
Mark Dickinsona4262b92009-04-19 11:35:55 +0000453/* default definitions are empty */
454#ifndef HAVE_PY_SET_53BIT_PRECISION
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000455#define _Py_SET_53BIT_PRECISION_HEADER
456#define _Py_SET_53BIT_PRECISION_START
457#define _Py_SET_53BIT_PRECISION_END
458#endif
459
460/* If we can't guarantee 53-bit precision, don't use the code
461 in Python/dtoa.c, but fall back to standard code. This
462 means that repr of a float will be long (17 sig digits).
463
464 Realistically, there are two things that could go wrong:
465
466 (1) doubles aren't IEEE 754 doubles, or
467 (2) we're on x86 with the rounding precision set to 64-bits
468 (extended precision), and we don't know how to change
469 the rounding precision.
470 */
471
472#if !defined(DOUBLE_IS_LITTLE_ENDIAN_IEEE754) && \
473 !defined(DOUBLE_IS_BIG_ENDIAN_IEEE754) && \
474 !defined(DOUBLE_IS_ARM_MIXED_ENDIAN_IEEE754)
475#define PY_NO_SHORT_FLOAT_REPR
476#endif
477
Mark Dickinson60fd0992009-04-18 10:16:35 +0000478/* double rounding is symptomatic of use of extended precision on x86. If
479 we're seeing double rounding, and we don't have any mechanism available for
480 changing the FPU rounding precision, then don't use Python/dtoa.c. */
Mark Dickinsona4262b92009-04-19 11:35:55 +0000481#if defined(X87_DOUBLE_ROUNDING) && !defined(HAVE_PY_SET_53BIT_PRECISION)
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000482#define PY_NO_SHORT_FLOAT_REPR
483#endif
484
485
Neal Norwitz80292642002-12-19 15:12:26 +0000486/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000487 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000488 * Usage:
489 * extern int old_var Py_DEPRECATED(2.3);
490 * typedef int T1 Py_DEPRECATED(2.4);
491 * extern int x() Py_DEPRECATED(2.5);
492 */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000493#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000494 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000495#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
496#else
Tim Peters4643bd92002-12-28 21:56:08 +0000497#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000498#endif
499
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000500/**************************************************************************
501Prototypes that are missing from the standard include files on some systems
502(and possibly only some versions of such systems.)
503
504Please be conservative with adding new ones, document them and enclose them
505in platform-specific #ifdefs.
506**************************************************************************/
507
508#ifdef SOLARIS
509/* Unchecked */
510extern int gethostname(char *, int);
511#endif
512
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000513#ifdef HAVE__GETPTY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000515extern char * _getpty(int *, int, mode_t, int);
516#endif
517
Georg Brandlf78e02b2008-06-10 17:40:04 +0000518/* On QNX 6, struct termio must be declared by including sys/termio.h
519 if TCGETA, TCSETA, TCSETAW, or TCSETAF are used. sys/termio.h must
520 be included before termios.h or it will generate an error. */
Stefan Krah2cbbed62012-11-19 00:07:18 +0100521#if defined(HAVE_SYS_TERMIO_H) && !defined(__hpux)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000522#include <sys/termio.h>
523#endif
524
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000525#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
526#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
527/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
528 functions, even though they are included in libutil. */
529#include <termios.h>
Serhiy Storchakaaa2b22a2013-10-19 21:39:31 +0300530extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
531extern pid_t forkpty(int *, char *, struct termios *, struct winsize *);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000532#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
533#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
534
535
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000536/* On 4.4BSD-descendants, ctype functions serves the whole range of
537 * wchar_t character set rather than single byte code points only.
538 * This characteristic can break some operations of string object
539 * including str.upper() and str.split() on UTF-8 locales. This
540 * workaround was provided by Tim Robbins of FreeBSD project.
541 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000542
543#ifdef __FreeBSD__
544#include <osreldate.h>
Ned Deily3d455992016-08-15 03:08:18 -0400545#if (__FreeBSD_version >= 500040 && __FreeBSD_version < 602113) || \
546 (__FreeBSD_version >= 700000 && __FreeBSD_version < 700054) || \
547 (__FreeBSD_version >= 800000 && __FreeBSD_version < 800001)
Ronald Oussoren501aeff2010-04-18 15:02:38 +0000548# define _PY_PORT_CTYPE_UTF8_ISSUE
549#endif
550#endif
551
552
553#if defined(__APPLE__)
554# define _PY_PORT_CTYPE_UTF8_ISSUE
555#endif
556
557#ifdef _PY_PORT_CTYPE_UTF8_ISSUE
Ned Deily7659aab2016-08-15 03:07:26 -0400558#ifndef __cplusplus
559 /* The workaround below is unsafe in C++ because
560 * the <locale> defines these symbols as real functions,
561 * with a slightly different signature.
562 * See issue #10910
563 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000564#include <ctype.h>
565#include <wctype.h>
566#undef isalnum
567#define isalnum(c) iswalnum(btowc(c))
568#undef isalpha
569#define isalpha(c) iswalpha(btowc(c))
570#undef islower
571#define islower(c) iswlower(btowc(c))
572#undef isspace
573#define isspace(c) iswspace(btowc(c))
574#undef isupper
575#define isupper(c) iswupper(btowc(c))
576#undef tolower
577#define tolower(c) towlower(btowc(c))
578#undef toupper
579#define toupper(c) towupper(btowc(c))
580#endif
Ned Deily7659aab2016-08-15 03:07:26 -0400581#endif
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000582
583
Mark Hammond8235ea12002-07-19 06:55:41 +0000584/* Declarations for symbol visibility.
585
586 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000587 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000588 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000589 inside the Python core, they are private to the core.
590 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000591 external linkage depending on the platform.
592
593 As a number of platforms support/require "__declspec(dllimport/dllexport)",
594 we support a HAVE_DECLSPEC_DLL macro to save duplication.
595*/
596
Tim Peters4643bd92002-12-28 21:56:08 +0000597/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000598 All windows ports, except cygwin, are handled in PC/pyconfig.h.
599
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000600 Cygwin is the only other autoconf platform requiring special
601 linkage handling and it uses __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000602*/
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000603#if defined(__CYGWIN__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000604# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000605#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000606
Jason Tishler30765592003-09-04 11:04:06 +0000607/* only get special linkage if built as shared or platform is Cygwin */
608#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000609# if defined(HAVE_DECLSPEC_DLL)
610# ifdef Py_BUILD_CORE
611# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
612# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Daniel Stutzbach38615992010-09-14 16:02:01 +0000613 /* module init functions inside the core need no external linkage */
614 /* except for Cygwin to handle embedding */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000615# if defined(__CYGWIN__)
616# define PyMODINIT_FUNC __declspec(dllexport) PyObject*
617# else /* __CYGWIN__ */
618# define PyMODINIT_FUNC PyObject*
619# endif /* __CYGWIN__ */
620# else /* Py_BUILD_CORE */
Daniel Stutzbach38615992010-09-14 16:02:01 +0000621 /* Building an extension module, or an embedded situation */
622 /* public Python functions and data are imported */
623 /* Under Cygwin, auto-import functions to prevent compilation */
624 /* failures similar to those described at the bottom of 4.1: */
625 /* http://docs.python.org/extending/windows.html#a-cookbook-approach */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000626# if !defined(__CYGWIN__)
627# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
628# endif /* !__CYGWIN__ */
629# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Daniel Stutzbach38615992010-09-14 16:02:01 +0000630 /* module init functions outside the core must be exported */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000631# if defined(__cplusplus)
632# define PyMODINIT_FUNC extern "C" __declspec(dllexport) PyObject*
633# else /* __cplusplus */
634# define PyMODINIT_FUNC __declspec(dllexport) PyObject*
635# endif /* __cplusplus */
636# endif /* Py_BUILD_CORE */
637# endif /* HAVE_DECLSPEC */
Mark Hammond8235ea12002-07-19 06:55:41 +0000638#endif /* Py_ENABLE_SHARED */
639
640/* If no external linkage macros defined by now, create defaults */
641#ifndef PyAPI_FUNC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000642# define PyAPI_FUNC(RTYPE) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000643#endif
644#ifndef PyAPI_DATA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000645# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000646#endif
647#ifndef PyMODINIT_FUNC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000648# if defined(__cplusplus)
649# define PyMODINIT_FUNC extern "C" PyObject*
650# else /* __cplusplus */
651# define PyMODINIT_FUNC PyObject*
652# endif /* __cplusplus */
Mark Hammond8235ea12002-07-19 06:55:41 +0000653#endif
654
Fred Draked5fadf72000-09-26 05:46:01 +0000655/* limits.h constants that may be missing */
656
657#ifndef INT_MAX
658#define INT_MAX 2147483647
659#endif
660
661#ifndef LONG_MAX
662#if SIZEOF_LONG == 4
663#define LONG_MAX 0X7FFFFFFFL
664#elif SIZEOF_LONG == 8
665#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
666#else
667#error "could not set LONG_MAX in pyport.h"
668#endif
669#endif
670
671#ifndef LONG_MIN
672#define LONG_MIN (-LONG_MAX-1)
673#endif
674
Tim Petersd57731f2000-10-05 01:42:25 +0000675#ifndef LONG_BIT
676#define LONG_BIT (8 * SIZEOF_LONG)
677#endif
678
679#if LONG_BIT != 8 * SIZEOF_LONG
680/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
681 * 32-bit platforms using gcc. We try to catch that here at compile-time
682 * rather than waiting for integer multiplication to trigger bogus
683 * overflows.
684 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000685#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000686#endif
687
Tim Peters7d3a5112000-07-08 04:17:21 +0000688#ifdef __cplusplus
689}
690#endif
691
Neil Schemenauer15691082001-10-23 02:20:37 +0000692/*
693 * Hide GCC attributes from compilers that don't support them.
694 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000695#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Skip Montanaro7a98be22007-08-16 14:35:24 +0000696 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) )
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000697#define Py_GCC_ATTRIBUTE(x)
698#else
699#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000700#endif
701
Thomas Wouters89f507f2006-12-13 04:49:30 +0000702/*
Benjamin Peterson058e31e2009-01-16 03:54:08 +0000703 * Specify alignment on compilers that support it.
704 */
705#if defined(__GNUC__) && __GNUC__ >= 3
706#define Py_ALIGNED(x) __attribute__((aligned(x)))
707#else
708#define Py_ALIGNED(x)
709#endif
710
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000711/* Eliminate end-of-loop code not reached warnings from SunPro C
712 * when using do{...}while(0) macros
713 */
714#ifdef __SUNPRO_C
715#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
716#endif
717
Thomas Wouters477c8d52006-05-27 19:21:47 +0000718#ifndef Py_LL
719#define Py_LL(x) x##LL
720#endif
721
722#ifndef Py_ULL
723#define Py_ULL(x) Py_LL(x##U)
724#endif
725
Benjamin Peterson0c212142016-09-20 20:39:33 -0700726#define Py_VA_COPY va_copy
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000727
Christian Heimes743e0cd2012-10-17 23:52:17 +0200728/*
Georg Brandl3962d5e2012-10-28 08:48:28 +0100729 * Convenient macros to deal with endianness of the platform. WORDS_BIGENDIAN is
Christian Heimes743e0cd2012-10-17 23:52:17 +0200730 * detected by configure and defined in pyconfig.h. The code in pyconfig.h
Terry Jan Reedy8e7586b2013-03-11 18:38:13 -0400731 * also takes care of Apple's universal builds.
Christian Heimes743e0cd2012-10-17 23:52:17 +0200732 */
733
734#ifdef WORDS_BIGENDIAN
735#define PY_BIG_ENDIAN 1
736#define PY_LITTLE_ENDIAN 0
737#else
738#define PY_BIG_ENDIAN 0
739#define PY_LITTLE_ENDIAN 1
740#endif
741
Benjamin Peterson918aa892016-09-19 22:16:36 -0700742#ifdef Py_BUILD_CORE
Steve Dower8fc89802015-04-12 00:26:27 -0400743/*
744 * Macros to protect CRT calls against instant termination when passed an
745 * invalid parameter (issue23524).
746 */
747#if defined _MSC_VER && _MSC_VER >= 1900
748
749extern _invalid_parameter_handler _Py_silent_invalid_parameter_handler;
750#define _Py_BEGIN_SUPPRESS_IPH { _invalid_parameter_handler _Py_old_handler = \
751 _set_thread_local_invalid_parameter_handler(_Py_silent_invalid_parameter_handler);
752#define _Py_END_SUPPRESS_IPH _set_thread_local_invalid_parameter_handler(_Py_old_handler); }
753
754#else
755
756#define _Py_BEGIN_SUPPRESS_IPH
757#define _Py_END_SUPPRESS_IPH
758
759#endif /* _MSC_VER >= 1900 */
760#endif /* Py_BUILD_CORE */
761
Stefan Krah1f9eb872016-05-22 17:35:34 +0200762#ifdef __ANDROID__
763#include <android/api-level.h>
764#endif
765
Tim Peters7d3a5112000-07-08 04:17:21 +0000766#endif /* Py_PYPORT_H */