blob: 94c135ff610e16182e9b8c734df820e08444a045 [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 defined(LLONG_MAX)
43/* If LLONG_MAX is defined in limits.h, use that. */
44#define PY_LLONG_MIN LLONG_MIN
45#define PY_LLONG_MAX LLONG_MAX
46#define PY_ULLONG_MAX ULLONG_MAX
47#elif defined(__LONG_LONG_MAX__)
Mark Dickinson6646cd42010-11-20 10:43:10 +000048/* Otherwise, if GCC has a builtin define, use that. (Definition of
49 * PY_LLONG_MIN assumes two's complement with no trap representation.) */
Guido van Rossumcd16bf62007-06-13 18:07:49 +000050#define PY_LLONG_MAX __LONG_LONG_MAX__
Mark Dickinson6646cd42010-11-20 10:43:10 +000051#define PY_LLONG_MIN (-PY_LLONG_MAX - 1)
52#define PY_ULLONG_MAX (PY_LLONG_MAX * Py_ULL(2) + 1)
53#elif defined(SIZEOF_LONG_LONG)
54/* Otherwise compute from SIZEOF_LONG_LONG, assuming two's complement, no
55 padding bits, and no trap representation. Note: PY_ULLONG_MAX was
56 previously #defined as (~0ULL) here; but that'll give the wrong value in a
57 preprocessor expression on systems where long long != intmax_t. */
58#define PY_LLONG_MAX \
59 (1 + 2 * ((Py_LL(1) << (CHAR_BIT * SIZEOF_LONG_LONG - 2)) - 1))
60#define PY_LLONG_MIN (-PY_LLONG_MAX - 1)
61#define PY_ULLONG_MAX (PY_LLONG_MAX * Py_ULL(2) + 1)
Guido van Rossumcd16bf62007-06-13 18:07:49 +000062#endif /* LLONG_MAX */
Barry Warsawfd847b22000-08-18 04:48:18 +000063#endif
Barry Warsawfd847b22000-08-18 04:48:18 +000064
Mark Dickinsonbd792642009-03-18 20:06:12 +000065#define PY_UINT32_T uint32_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000066#define PY_UINT64_T uint64_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000067
68/* Signed variants of the above */
Mark Dickinsonbd792642009-03-18 20:06:12 +000069#define PY_INT32_T int32_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000070#define PY_INT64_T int64_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000071
72/* If PYLONG_BITS_IN_DIGIT is not defined then we'll use 30-bit digits if all
73 the necessary integer types are available, and we're on a 64-bit platform
74 (as determined by SIZEOF_VOID_P); otherwise we use 15-bit digits. */
75
76#ifndef PYLONG_BITS_IN_DIGIT
Benjamin Peterson4fe55102016-09-06 11:58:01 -070077#if SIZEOF_VOID_P >= 8
Mark Dickinsonbd792642009-03-18 20:06:12 +000078#define PYLONG_BITS_IN_DIGIT 30
79#else
80#define PYLONG_BITS_IN_DIGIT 15
81#endif
82#endif
83
Barry Warsawfd847b22000-08-18 04:48:18 +000084/* uintptr_t is the C9X name for an unsigned integral type such that a
85 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +000086 * without loss of information. Similarly for intptr_t, wrt a signed
87 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +000088 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000089typedef uintptr_t Py_uintptr_t;
90typedef intptr_t Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +000091
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000092/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
93 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
94 * unsigned integral type). See PEP 353 for details.
95 */
Martin v. Löwis18e16552006-02-15 17:27:45 +000096#ifdef HAVE_SSIZE_T
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000097typedef ssize_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +000098#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000099typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000100#else
101# error "Python needs a typedef for Py_ssize_t in pyport.h."
102#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000103
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000104/* Py_hash_t is the same size as a pointer. */
Christian Heimes985ecdc2013-11-20 11:46:18 +0100105#define SIZEOF_PY_HASH_T SIZEOF_SIZE_T
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000106typedef Py_ssize_t Py_hash_t;
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000107/* Py_uhash_t is the unsigned equivalent needed to calculate numeric hash. */
Christian Heimes985ecdc2013-11-20 11:46:18 +0100108#define SIZEOF_PY_UHASH_T SIZEOF_SIZE_T
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000109typedef size_t Py_uhash_t;
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000110
Larry Hastingsebdcb502013-11-23 14:54:00 -0800111/* Only used for compatibility with code that may not be PY_SSIZE_T_CLEAN. */
112#ifdef PY_SSIZE_T_CLEAN
113typedef Py_ssize_t Py_ssize_clean_t;
114#else
115typedef int Py_ssize_clean_t;
116#endif
117
Benjamin Peterson2f8bfef2016-09-07 09:26:18 -0700118/* Largest possible value of size_t. */
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +0000119#define PY_SIZE_MAX SIZE_MAX
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +0000120
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000121/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000122#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000123/* Smallest negative value of type Py_ssize_t. */
124#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
125
126/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
127 * format to convert an argument with the width of a size_t or Py_ssize_t.
128 * C99 introduced "z" for this purpose, but not all platforms support that;
129 * e.g., MS compilers use "I" instead.
130 *
131 * These "high level" Python format functions interpret "z" correctly on
132 * all platforms (Python interprets the format string itself, and does whatever
133 * the platform C requires to convert a size_t/Py_ssize_t argument):
134 *
Christian Heimes72b710a2008-05-26 13:28:38 +0000135 * PyBytes_FromFormat
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000136 * PyErr_Format
Christian Heimes72b710a2008-05-26 13:28:38 +0000137 * PyBytes_FromFormatV
Walter Dörwald7696ed72007-05-31 15:51:35 +0000138 * PyUnicode_FromFormatV
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000139 *
140 * Lower-level uses require that you interpolate the correct format modifier
141 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
142 * example,
143 *
144 * Py_ssize_t index;
145 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
146 *
147 * That will expand to %ld, or %Id, or to something else correct for a
148 * Py_ssize_t on the platform.
149 */
150#ifndef PY_FORMAT_SIZE_T
Thomas Wouters89f507f2006-12-13 04:49:30 +0000151# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000152# define PY_FORMAT_SIZE_T ""
153# elif SIZEOF_SIZE_T == SIZEOF_LONG
154# define PY_FORMAT_SIZE_T "l"
155# elif defined(MS_WINDOWS)
156# define PY_FORMAT_SIZE_T "I"
157# else
158# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
159# endif
160#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000161
Mark Dickinson6ce4a9a2009-11-16 17:00:11 +0000162/* PY_FORMAT_LONG_LONG is analogous to PY_FORMAT_SIZE_T above, but for
Benjamin Petersoned4aa832016-09-05 17:44:18 -0700163 * the long long type instead of the size_t type. The "high level" Python format
Mark Dickinson6ce4a9a2009-11-16 17:00:11 +0000164 * functions listed above will interpret "lld" or "llu" correctly on
165 * all platforms.
166 */
Benjamin Petersoned4aa832016-09-05 17:44:18 -0700167#ifndef PY_FORMAT_LONG_LONG
168# ifdef MS_WINDOWS
169# define PY_FORMAT_LONG_LONG "I64"
170# else
171# error "This platform's pyconfig.h needs to define PY_FORMAT_LONG_LONG"
172# endif
Mark Dickinson6ce4a9a2009-11-16 17:00:11 +0000173#endif
174
Thomas Wouters477c8d52006-05-27 19:21:47 +0000175/* Py_LOCAL can be used instead of static to get the fastest possible calling
176 * convention for functions that are local to a given module.
177 *
178 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
179 * for platforms that support that.
180 *
181 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
Berker Peksag4882cac2015-04-14 09:30:01 +0300182 * "aggressive" inlining/optimization is enabled for the entire module. This
Thomas Wouters477c8d52006-05-27 19:21:47 +0000183 * may lead to code bloat, and may slow things down for those reasons. It may
184 * also lead to errors, if the code relies on pointer aliasing. Use with
185 * care.
186 *
187 * NOTE: You can only use this for functions that are entirely local to a
188 * module; functions that are exported via method tables, callbacks, etc,
189 * should keep using static.
190 */
191
Thomas Wouters477c8d52006-05-27 19:21:47 +0000192#if defined(_MSC_VER)
193#if defined(PY_LOCAL_AGGRESSIVE)
194/* enable more aggressive optimization for visual studio */
195#pragma optimize("agtw", on)
196#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000197/* ignore warnings if the compiler decides not to inline a function */
Thomas Wouters477c8d52006-05-27 19:21:47 +0000198#pragma warning(disable: 4710)
199/* fastest possible local call under MSVC */
200#define Py_LOCAL(type) static type __fastcall
201#define Py_LOCAL_INLINE(type) static __inline type __fastcall
202#elif defined(USE_INLINE)
203#define Py_LOCAL(type) static type
204#define Py_LOCAL_INLINE(type) static inline type
205#else
206#define Py_LOCAL(type) static type
207#define Py_LOCAL_INLINE(type) static type
208#endif
209
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000210/* Py_MEMCPY can be used instead of memcpy in cases where the copied blocks
211 * are often very short. While most platforms have highly optimized code for
212 * large transfers, the setup costs for memcpy are often quite high. MEMCPY
213 * solves this by doing short copies "in line".
214 */
215
216#if defined(_MSC_VER)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000217#define Py_MEMCPY(target, source, length) do { \
218 size_t i_, n_ = (length); \
219 char *t_ = (void*) (target); \
220 const char *s_ = (void*) (source); \
221 if (n_ >= 16) \
222 memcpy(t_, s_, n_); \
223 else \
224 for (i_ = 0; i_ < n_; i_++) \
225 t_[i_] = s_[i_]; \
226 } while (0)
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000227#else
228#define Py_MEMCPY memcpy
229#endif
230
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000231#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000232
Mark Dickinsona4962cb2009-11-28 12:35:42 +0000233#ifdef HAVE_IEEEFP_H
234#include <ieeefp.h> /* needed for 'finite' declaration on some platforms */
235#endif
236
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000237#include <math.h> /* Moved here from the math section, before extern "C" */
238
239/********************************************
240 * WRAPPER FOR <time.h> and/or <sys/time.h> *
241 ********************************************/
242
243#ifdef TIME_WITH_SYS_TIME
244#include <sys/time.h>
245#include <time.h>
246#else /* !TIME_WITH_SYS_TIME */
247#ifdef HAVE_SYS_TIME_H
248#include <sys/time.h>
249#else /* !HAVE_SYS_TIME_H */
250#include <time.h>
251#endif /* !HAVE_SYS_TIME_H */
252#endif /* !TIME_WITH_SYS_TIME */
253
254
255/******************************
256 * WRAPPER FOR <sys/select.h> *
257 ******************************/
258
259/* NB caller must include <sys/types.h> */
260
261#ifdef HAVE_SYS_SELECT_H
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000262#include <sys/select.h>
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000263#endif /* !HAVE_SYS_SELECT_H */
264
Tim Peters60f42b52001-01-18 03:03:16 +0000265/*******************************
266 * stat() and fstat() fiddling *
267 *******************************/
268
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000269#ifdef HAVE_SYS_STAT_H
Tim Peters60f42b52001-01-18 03:03:16 +0000270#include <sys/stat.h>
271#elif defined(HAVE_STAT_H)
272#include <stat.h>
273#endif
274
Christian Heimes99d61352013-06-23 23:56:05 +0200275#ifndef S_IFMT
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000276/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
Christian Heimes99d61352013-06-23 23:56:05 +0200277#define S_IFMT 0170000
278#endif
279
280#ifndef S_IFLNK
281/* Windows doesn't define S_IFLNK but posixmodule.c maps
282 * IO_REPARSE_TAG_SYMLINK to S_IFLNK */
283# define S_IFLNK 0120000
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000284#endif
285
286#ifndef S_ISREG
287#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
288#endif
289
290#ifndef S_ISDIR
291#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
292#endif
293
Victor Stinnerc6ebd162013-06-23 01:49:42 +0200294#ifndef S_ISCHR
295#define S_ISCHR(x) (((x) & S_IFMT) == S_IFCHR)
296#endif
297
Tim Peters7d3a5112000-07-08 04:17:21 +0000298#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000299/* Move this down here since some C++ #include's don't like to be included
300 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000301extern "C" {
302#endif
303
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000304
Tim Peters7d3a5112000-07-08 04:17:21 +0000305/* Py_ARITHMETIC_RIGHT_SHIFT
306 * C doesn't define whether a right-shift of a signed integer sign-extends
307 * or zero-fills. Here a macro to force sign extension:
308 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
Mark Dickinson16f966e2009-03-20 23:23:15 +0000309 * Return I >> J, forcing sign extension. Arithmetically, return the
310 * floor of I/2**J.
Tim Peters7d3a5112000-07-08 04:17:21 +0000311 * Requirements:
Mark Dickinson16f966e2009-03-20 23:23:15 +0000312 * I should have signed integer type. In the terminology of C99, this can
313 * be either one of the five standard signed integer types (signed char,
314 * short, int, long, long long) or an extended signed integer type.
315 * J is an integer >= 0 and strictly less than the number of bits in the
316 * type of I (because C doesn't define what happens for J outside that
317 * range either).
318 * TYPE used to specify the type of I, but is now ignored. It's been left
319 * in for backwards compatibility with versions <= 2.6 or 3.0.
Tim Peters7d3a5112000-07-08 04:17:21 +0000320 * Caution:
321 * I may be evaluated more than once.
322 */
323#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
324#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000325 ((I) < 0 ? -1-((-1-(I)) >> (J)) : (I) >> (J))
Tim Peters7d3a5112000-07-08 04:17:21 +0000326#else
327#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
328#endif
329
Tim Peters39dce292000-08-15 03:34:48 +0000330/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000331 * "Simply" returns its argument. However, macro expansions within the
332 * argument are evaluated. This unfortunate trickery is needed to get
333 * token-pasting to work as desired in some cases.
334 */
335#define Py_FORCE_EXPANSION(X) X
336
Tim Peters8315ea52000-07-23 19:28:35 +0000337/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
338 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
339 * assert-fails if any information is lost.
340 * Caution:
341 * VALUE may be evaluated more than once.
342 */
343#ifdef Py_DEBUG
344#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000345 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
Tim Peters8315ea52000-07-23 19:28:35 +0000346#else
347#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
348#endif
349
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000350/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000351 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000352 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
353 * to 0 before calling a libm function, and invoke this macro after,
354 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000355 * Caution:
356 * This isn't reliable. See Py_OVERFLOWED comments.
357 * X is evaluated more than once.
358 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000359#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000360#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
361#else
362#define _Py_SET_EDOM_FOR_NAN(X) ;
363#endif
364#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000365 do { \
366 if (errno == 0) { \
367 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
368 errno = ERANGE; \
369 else _Py_SET_EDOM_FOR_NAN(X) \
370 } \
371 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000372
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000373/* Py_SET_ERANGE_ON_OVERFLOW(x)
374 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
375 */
376#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
377
Tim Petersdc5a5082002-03-09 04:58:24 +0000378/* Py_ADJUST_ERANGE1(x)
379 * Py_ADJUST_ERANGE2(x, y)
380 * Set errno to 0 before calling a libm function, and invoke one of these
381 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
382 * for functions returning complex results). This makes two kinds of
383 * adjustments to errno: (A) If it looks like the platform libm set
384 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
385 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
386 * effect, we're trying to force a useful implementation of C89 errno
387 * behavior.
388 * Caution:
389 * This isn't reliable. See Py_OVERFLOWED comments.
390 * X and Y may be evaluated more than once.
391 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000392#define Py_ADJUST_ERANGE1(X) \
393 do { \
394 if (errno == 0) { \
395 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
396 errno = ERANGE; \
397 } \
398 else if (errno == ERANGE && (X) == 0.0) \
399 errno = 0; \
400 } while(0)
Tim Petersdc5a5082002-03-09 04:58:24 +0000401
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000402#define Py_ADJUST_ERANGE2(X, Y) \
403 do { \
404 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
405 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
406 if (errno == 0) \
407 errno = ERANGE; \
408 } \
409 else if (errno == ERANGE) \
410 errno = 0; \
411 } while(0)
Tim Petersdc5a5082002-03-09 04:58:24 +0000412
Mark Dickinsona4262b92009-04-19 11:35:55 +0000413/* The functions _Py_dg_strtod and _Py_dg_dtoa in Python/dtoa.c (which are
414 * required to support the short float repr introduced in Python 3.1) require
415 * that the floating-point unit that's being used for arithmetic operations
416 * on C doubles is set to use 53-bit precision. It also requires that the
417 * FPU rounding mode is round-half-to-even, but that's less often an issue.
418 *
419 * If your FPU isn't already set to 53-bit precision/round-half-to-even, and
420 * you want to make use of _Py_dg_strtod and _Py_dg_dtoa, then you should
421 *
422 * #define HAVE_PY_SET_53BIT_PRECISION 1
423 *
424 * and also give appropriate definitions for the following three macros:
425 *
426 * _PY_SET_53BIT_PRECISION_START : store original FPU settings, and
427 * set FPU to 53-bit precision/round-half-to-even
428 * _PY_SET_53BIT_PRECISION_END : restore original FPU settings
429 * _PY_SET_53BIT_PRECISION_HEADER : any variable declarations needed to
430 * use the two macros above.
431 *
432 * The macros are designed to be used within a single C function: see
433 * Python/pystrtod.c for an example of their use.
434 */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000435
Mark Dickinsona4262b92009-04-19 11:35:55 +0000436/* get and set x87 control word for gcc/x86 */
Mark Dickinson7abf8d42009-04-18 20:17:52 +0000437#ifdef HAVE_GCC_ASM_FOR_X87
Mark Dickinsona4262b92009-04-19 11:35:55 +0000438#define HAVE_PY_SET_53BIT_PRECISION 1
439/* _Py_get/set_387controlword functions are defined in Python/pymath.c */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440#define _Py_SET_53BIT_PRECISION_HEADER \
441 unsigned short old_387controlword, new_387controlword
442#define _Py_SET_53BIT_PRECISION_START \
443 do { \
444 old_387controlword = _Py_get_387controlword(); \
445 new_387controlword = (old_387controlword & ~0x0f00) | 0x0200; \
446 if (new_387controlword != old_387controlword) \
447 _Py_set_387controlword(new_387controlword); \
448 } while (0)
449#define _Py_SET_53BIT_PRECISION_END \
450 if (new_387controlword != old_387controlword) \
451 _Py_set_387controlword(old_387controlword)
Mark Dickinsona4262b92009-04-19 11:35:55 +0000452#endif
453
Mark Dickinson18e3d812012-04-15 15:10:56 +0100454/* get and set x87 control word for VisualStudio/x86 */
455#if defined(_MSC_VER) && !defined(_WIN64) /* x87 not supported in 64-bit */
456#define HAVE_PY_SET_53BIT_PRECISION 1
457#define _Py_SET_53BIT_PRECISION_HEADER \
458 unsigned int old_387controlword, new_387controlword, out_387controlword
459/* We use the __control87_2 function to set only the x87 control word.
460 The SSE control word is unaffected. */
461#define _Py_SET_53BIT_PRECISION_START \
462 do { \
463 __control87_2(0, 0, &old_387controlword, NULL); \
464 new_387controlword = \
465 (old_387controlword & ~(_MCW_PC | _MCW_RC)) | (_PC_53 | _RC_NEAR); \
466 if (new_387controlword != old_387controlword) \
467 __control87_2(new_387controlword, _MCW_PC | _MCW_RC, \
468 &out_387controlword, NULL); \
469 } while (0)
470#define _Py_SET_53BIT_PRECISION_END \
471 do { \
472 if (new_387controlword != old_387controlword) \
473 __control87_2(old_387controlword, _MCW_PC | _MCW_RC, \
474 &out_387controlword, NULL); \
475 } while (0)
476#endif
477
Benjamin Peterson8bdeb162014-04-17 00:00:31 -0400478#ifdef HAVE_GCC_ASM_FOR_MC68881
479#define HAVE_PY_SET_53BIT_PRECISION 1
480#define _Py_SET_53BIT_PRECISION_HEADER \
481 unsigned int old_fpcr, new_fpcr
482#define _Py_SET_53BIT_PRECISION_START \
483 do { \
484 __asm__ ("fmove.l %%fpcr,%0" : "=g" (old_fpcr)); \
485 /* Set double precision / round to nearest. */ \
486 new_fpcr = (old_fpcr & ~0xf0) | 0x80; \
487 if (new_fpcr != old_fpcr) \
488 __asm__ volatile ("fmove.l %0,%%fpcr" : : "g" (new_fpcr)); \
489 } while (0)
490#define _Py_SET_53BIT_PRECISION_END \
491 do { \
492 if (new_fpcr != old_fpcr) \
493 __asm__ volatile ("fmove.l %0,%%fpcr" : : "g" (old_fpcr)); \
494 } while (0)
495#endif
496
Mark Dickinsona4262b92009-04-19 11:35:55 +0000497/* default definitions are empty */
498#ifndef HAVE_PY_SET_53BIT_PRECISION
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000499#define _Py_SET_53BIT_PRECISION_HEADER
500#define _Py_SET_53BIT_PRECISION_START
501#define _Py_SET_53BIT_PRECISION_END
502#endif
503
504/* If we can't guarantee 53-bit precision, don't use the code
505 in Python/dtoa.c, but fall back to standard code. This
506 means that repr of a float will be long (17 sig digits).
507
508 Realistically, there are two things that could go wrong:
509
510 (1) doubles aren't IEEE 754 doubles, or
511 (2) we're on x86 with the rounding precision set to 64-bits
512 (extended precision), and we don't know how to change
513 the rounding precision.
514 */
515
516#if !defined(DOUBLE_IS_LITTLE_ENDIAN_IEEE754) && \
517 !defined(DOUBLE_IS_BIG_ENDIAN_IEEE754) && \
518 !defined(DOUBLE_IS_ARM_MIXED_ENDIAN_IEEE754)
519#define PY_NO_SHORT_FLOAT_REPR
520#endif
521
Mark Dickinson60fd0992009-04-18 10:16:35 +0000522/* double rounding is symptomatic of use of extended precision on x86. If
523 we're seeing double rounding, and we don't have any mechanism available for
524 changing the FPU rounding precision, then don't use Python/dtoa.c. */
Mark Dickinsona4262b92009-04-19 11:35:55 +0000525#if defined(X87_DOUBLE_ROUNDING) && !defined(HAVE_PY_SET_53BIT_PRECISION)
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000526#define PY_NO_SHORT_FLOAT_REPR
527#endif
528
529
Neal Norwitz80292642002-12-19 15:12:26 +0000530/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000531 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000532 * Usage:
533 * extern int old_var Py_DEPRECATED(2.3);
534 * typedef int T1 Py_DEPRECATED(2.4);
535 * extern int x() Py_DEPRECATED(2.5);
536 */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000537#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000539#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
540#else
Tim Peters4643bd92002-12-28 21:56:08 +0000541#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000542#endif
543
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000544/**************************************************************************
545Prototypes that are missing from the standard include files on some systems
546(and possibly only some versions of such systems.)
547
548Please be conservative with adding new ones, document them and enclose them
549in platform-specific #ifdefs.
550**************************************************************************/
551
552#ifdef SOLARIS
553/* Unchecked */
554extern int gethostname(char *, int);
555#endif
556
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000557#ifdef HAVE__GETPTY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000558#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000559extern char * _getpty(int *, int, mode_t, int);
560#endif
561
Georg Brandlf78e02b2008-06-10 17:40:04 +0000562/* On QNX 6, struct termio must be declared by including sys/termio.h
563 if TCGETA, TCSETA, TCSETAW, or TCSETAF are used. sys/termio.h must
564 be included before termios.h or it will generate an error. */
Stefan Krah2cbbed62012-11-19 00:07:18 +0100565#if defined(HAVE_SYS_TERMIO_H) && !defined(__hpux)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000566#include <sys/termio.h>
567#endif
568
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000569#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
570#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
571/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
572 functions, even though they are included in libutil. */
573#include <termios.h>
Serhiy Storchakaaa2b22a2013-10-19 21:39:31 +0300574extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
575extern pid_t forkpty(int *, char *, struct termios *, struct winsize *);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000576#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
577#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
578
579
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000580/* On 4.4BSD-descendants, ctype functions serves the whole range of
581 * wchar_t character set rather than single byte code points only.
582 * This characteristic can break some operations of string object
583 * including str.upper() and str.split() on UTF-8 locales. This
584 * workaround was provided by Tim Robbins of FreeBSD project.
585 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000586
587#ifdef __FreeBSD__
588#include <osreldate.h>
Ned Deily3d455992016-08-15 03:08:18 -0400589#if (__FreeBSD_version >= 500040 && __FreeBSD_version < 602113) || \
590 (__FreeBSD_version >= 700000 && __FreeBSD_version < 700054) || \
591 (__FreeBSD_version >= 800000 && __FreeBSD_version < 800001)
Ronald Oussoren501aeff2010-04-18 15:02:38 +0000592# define _PY_PORT_CTYPE_UTF8_ISSUE
593#endif
594#endif
595
596
597#if defined(__APPLE__)
598# define _PY_PORT_CTYPE_UTF8_ISSUE
599#endif
600
601#ifdef _PY_PORT_CTYPE_UTF8_ISSUE
Ned Deily7659aab2016-08-15 03:07:26 -0400602#ifndef __cplusplus
603 /* The workaround below is unsafe in C++ because
604 * the <locale> defines these symbols as real functions,
605 * with a slightly different signature.
606 * See issue #10910
607 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000608#include <ctype.h>
609#include <wctype.h>
610#undef isalnum
611#define isalnum(c) iswalnum(btowc(c))
612#undef isalpha
613#define isalpha(c) iswalpha(btowc(c))
614#undef islower
615#define islower(c) iswlower(btowc(c))
616#undef isspace
617#define isspace(c) iswspace(btowc(c))
618#undef isupper
619#define isupper(c) iswupper(btowc(c))
620#undef tolower
621#define tolower(c) towlower(btowc(c))
622#undef toupper
623#define toupper(c) towupper(btowc(c))
624#endif
Ned Deily7659aab2016-08-15 03:07:26 -0400625#endif
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000626
627
Mark Hammond8235ea12002-07-19 06:55:41 +0000628/* Declarations for symbol visibility.
629
630 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000631 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000632 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000633 inside the Python core, they are private to the core.
634 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000635 external linkage depending on the platform.
636
637 As a number of platforms support/require "__declspec(dllimport/dllexport)",
638 we support a HAVE_DECLSPEC_DLL macro to save duplication.
639*/
640
Tim Peters4643bd92002-12-28 21:56:08 +0000641/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000642 All windows ports, except cygwin, are handled in PC/pyconfig.h.
643
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000644 Cygwin is the only other autoconf platform requiring special
645 linkage handling and it uses __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000646*/
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000647#if defined(__CYGWIN__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000648# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000649#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000650
Jason Tishler30765592003-09-04 11:04:06 +0000651/* only get special linkage if built as shared or platform is Cygwin */
652#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000653# if defined(HAVE_DECLSPEC_DLL)
654# ifdef Py_BUILD_CORE
655# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
656# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Daniel Stutzbach38615992010-09-14 16:02:01 +0000657 /* module init functions inside the core need no external linkage */
658 /* except for Cygwin to handle embedding */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000659# if defined(__CYGWIN__)
660# define PyMODINIT_FUNC __declspec(dllexport) PyObject*
661# else /* __CYGWIN__ */
662# define PyMODINIT_FUNC PyObject*
663# endif /* __CYGWIN__ */
664# else /* Py_BUILD_CORE */
Daniel Stutzbach38615992010-09-14 16:02:01 +0000665 /* Building an extension module, or an embedded situation */
666 /* public Python functions and data are imported */
667 /* Under Cygwin, auto-import functions to prevent compilation */
668 /* failures similar to those described at the bottom of 4.1: */
669 /* http://docs.python.org/extending/windows.html#a-cookbook-approach */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000670# if !defined(__CYGWIN__)
671# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
672# endif /* !__CYGWIN__ */
673# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Daniel Stutzbach38615992010-09-14 16:02:01 +0000674 /* module init functions outside the core must be exported */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675# if defined(__cplusplus)
676# define PyMODINIT_FUNC extern "C" __declspec(dllexport) PyObject*
677# else /* __cplusplus */
678# define PyMODINIT_FUNC __declspec(dllexport) PyObject*
679# endif /* __cplusplus */
680# endif /* Py_BUILD_CORE */
681# endif /* HAVE_DECLSPEC */
Mark Hammond8235ea12002-07-19 06:55:41 +0000682#endif /* Py_ENABLE_SHARED */
683
684/* If no external linkage macros defined by now, create defaults */
685#ifndef PyAPI_FUNC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000686# define PyAPI_FUNC(RTYPE) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000687#endif
688#ifndef PyAPI_DATA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000689# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000690#endif
691#ifndef PyMODINIT_FUNC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000692# if defined(__cplusplus)
693# define PyMODINIT_FUNC extern "C" PyObject*
694# else /* __cplusplus */
695# define PyMODINIT_FUNC PyObject*
696# endif /* __cplusplus */
Mark Hammond8235ea12002-07-19 06:55:41 +0000697#endif
698
Fred Draked5fadf72000-09-26 05:46:01 +0000699/* limits.h constants that may be missing */
700
701#ifndef INT_MAX
702#define INT_MAX 2147483647
703#endif
704
705#ifndef LONG_MAX
706#if SIZEOF_LONG == 4
707#define LONG_MAX 0X7FFFFFFFL
708#elif SIZEOF_LONG == 8
709#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
710#else
711#error "could not set LONG_MAX in pyport.h"
712#endif
713#endif
714
715#ifndef LONG_MIN
716#define LONG_MIN (-LONG_MAX-1)
717#endif
718
Tim Petersd57731f2000-10-05 01:42:25 +0000719#ifndef LONG_BIT
720#define LONG_BIT (8 * SIZEOF_LONG)
721#endif
722
723#if LONG_BIT != 8 * SIZEOF_LONG
724/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
725 * 32-bit platforms using gcc. We try to catch that here at compile-time
726 * rather than waiting for integer multiplication to trigger bogus
727 * overflows.
728 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000729#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000730#endif
731
Tim Peters7d3a5112000-07-08 04:17:21 +0000732#ifdef __cplusplus
733}
734#endif
735
Neil Schemenauer15691082001-10-23 02:20:37 +0000736/*
737 * Hide GCC attributes from compilers that don't support them.
738 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000739#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Skip Montanaro7a98be22007-08-16 14:35:24 +0000740 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) )
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000741#define Py_GCC_ATTRIBUTE(x)
742#else
743#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000744#endif
745
Thomas Wouters89f507f2006-12-13 04:49:30 +0000746/*
Benjamin Peterson058e31e2009-01-16 03:54:08 +0000747 * Specify alignment on compilers that support it.
748 */
749#if defined(__GNUC__) && __GNUC__ >= 3
750#define Py_ALIGNED(x) __attribute__((aligned(x)))
751#else
752#define Py_ALIGNED(x)
753#endif
754
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000755/* Eliminate end-of-loop code not reached warnings from SunPro C
756 * when using do{...}while(0) macros
757 */
758#ifdef __SUNPRO_C
759#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
760#endif
761
Thomas Wouters477c8d52006-05-27 19:21:47 +0000762/*
763 * Older Microsoft compilers don't support the C99 long long literal suffixes,
764 * so these will be defined in PC/pyconfig.h for those compilers.
765 */
766#ifndef Py_LL
767#define Py_LL(x) x##LL
768#endif
769
770#ifndef Py_ULL
771#define Py_ULL(x) Py_LL(x##U)
772#endif
773
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000774#ifdef VA_LIST_IS_ARRAY
775#define Py_VA_COPY(x, y) Py_MEMCPY((x), (y), sizeof(va_list))
776#else
777#ifdef __va_copy
778#define Py_VA_COPY __va_copy
779#else
780#define Py_VA_COPY(x, y) (x) = (y)
781#endif
782#endif
783
Christian Heimes743e0cd2012-10-17 23:52:17 +0200784/*
Georg Brandl3962d5e2012-10-28 08:48:28 +0100785 * Convenient macros to deal with endianness of the platform. WORDS_BIGENDIAN is
Christian Heimes743e0cd2012-10-17 23:52:17 +0200786 * detected by configure and defined in pyconfig.h. The code in pyconfig.h
Terry Jan Reedy8e7586b2013-03-11 18:38:13 -0400787 * also takes care of Apple's universal builds.
Christian Heimes743e0cd2012-10-17 23:52:17 +0200788 */
789
790#ifdef WORDS_BIGENDIAN
791#define PY_BIG_ENDIAN 1
792#define PY_LITTLE_ENDIAN 0
793#else
794#define PY_BIG_ENDIAN 0
795#define PY_LITTLE_ENDIAN 1
796#endif
797
Steve Dower8fc89802015-04-12 00:26:27 -0400798#ifdef Py_BUILD_CORE
799/*
800 * Macros to protect CRT calls against instant termination when passed an
801 * invalid parameter (issue23524).
802 */
803#if defined _MSC_VER && _MSC_VER >= 1900
804
805extern _invalid_parameter_handler _Py_silent_invalid_parameter_handler;
806#define _Py_BEGIN_SUPPRESS_IPH { _invalid_parameter_handler _Py_old_handler = \
807 _set_thread_local_invalid_parameter_handler(_Py_silent_invalid_parameter_handler);
808#define _Py_END_SUPPRESS_IPH _set_thread_local_invalid_parameter_handler(_Py_old_handler); }
809
810#else
811
812#define _Py_BEGIN_SUPPRESS_IPH
813#define _Py_END_SUPPRESS_IPH
814
815#endif /* _MSC_VER >= 1900 */
816#endif /* Py_BUILD_CORE */
817
Stefan Krah1f9eb872016-05-22 17:35:34 +0200818#ifdef __ANDROID__
819#include <android/api-level.h>
820#endif
821
Tim Peters7d3a5112000-07-08 04:17:21 +0000822#endif /* Py_PYPORT_H */