blob: 4971a493ccee22efe67c151c76f91154ca77a6ae [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
n.d. parkerf7eda382017-03-08 19:24:22 +010040/* long long is required. Ensure HAVE_LONG_LONG is defined for compatibility. */
Benjamin Peterson0d5742d2016-12-07 23:54:28 -080041#ifndef HAVE_LONG_LONG
Victor Stinnera251fb02017-01-05 22:58:53 +010042#define HAVE_LONG_LONG 1
Benjamin Peterson0d5742d2016-12-07 23:54:28 -080043#endif
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000044#ifndef PY_LONG_LONG
45#define PY_LONG_LONG long long
Guido van Rossumcd16bf62007-06-13 18:07:49 +000046/* If LLONG_MAX is defined in limits.h, use that. */
47#define PY_LLONG_MIN LLONG_MIN
48#define PY_LLONG_MAX LLONG_MAX
49#define PY_ULLONG_MAX ULLONG_MAX
Barry Warsawfd847b22000-08-18 04:48:18 +000050#endif
Barry Warsawfd847b22000-08-18 04:48:18 +000051
Mark Dickinsonbd792642009-03-18 20:06:12 +000052#define PY_UINT32_T uint32_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000053#define PY_UINT64_T uint64_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000054
55/* Signed variants of the above */
Mark Dickinsonbd792642009-03-18 20:06:12 +000056#define PY_INT32_T int32_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000057#define PY_INT64_T int64_t
Mark Dickinsonbd792642009-03-18 20:06:12 +000058
59/* If PYLONG_BITS_IN_DIGIT is not defined then we'll use 30-bit digits if all
60 the necessary integer types are available, and we're on a 64-bit platform
61 (as determined by SIZEOF_VOID_P); otherwise we use 15-bit digits. */
62
63#ifndef PYLONG_BITS_IN_DIGIT
Benjamin Peterson4fe55102016-09-06 11:58:01 -070064#if SIZEOF_VOID_P >= 8
Mark Dickinsonbd792642009-03-18 20:06:12 +000065#define PYLONG_BITS_IN_DIGIT 30
66#else
67#define PYLONG_BITS_IN_DIGIT 15
68#endif
69#endif
70
Barry Warsawfd847b22000-08-18 04:48:18 +000071/* uintptr_t is the C9X name for an unsigned integral type such that a
72 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +000073 * without loss of information. Similarly for intptr_t, wrt a signed
74 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +000075 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000076typedef uintptr_t Py_uintptr_t;
77typedef intptr_t Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +000078
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000079/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
80 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
81 * unsigned integral type). See PEP 353 for details.
82 */
Martin v. Löwis18e16552006-02-15 17:27:45 +000083#ifdef HAVE_SSIZE_T
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000084typedef ssize_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +000085#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000086typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +000087#else
88# error "Python needs a typedef for Py_ssize_t in pyport.h."
89#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000090
Benjamin Peterson8f67d082010-10-17 20:54:53 +000091/* Py_hash_t is the same size as a pointer. */
Christian Heimes985ecdc2013-11-20 11:46:18 +010092#define SIZEOF_PY_HASH_T SIZEOF_SIZE_T
Benjamin Peterson8f67d082010-10-17 20:54:53 +000093typedef Py_ssize_t Py_hash_t;
Benjamin Peterson8035bc52010-10-23 16:20:50 +000094/* Py_uhash_t is the unsigned equivalent needed to calculate numeric hash. */
Christian Heimes985ecdc2013-11-20 11:46:18 +010095#define SIZEOF_PY_UHASH_T SIZEOF_SIZE_T
Benjamin Peterson8035bc52010-10-23 16:20:50 +000096typedef size_t Py_uhash_t;
Benjamin Peterson8f67d082010-10-17 20:54:53 +000097
Larry Hastingsebdcb502013-11-23 14:54:00 -080098/* Only used for compatibility with code that may not be PY_SSIZE_T_CLEAN. */
99#ifdef PY_SSIZE_T_CLEAN
100typedef Py_ssize_t Py_ssize_clean_t;
101#else
102typedef int Py_ssize_clean_t;
103#endif
104
Benjamin Peterson2f8bfef2016-09-07 09:26:18 -0700105/* Largest possible value of size_t. */
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +0000106#define PY_SIZE_MAX SIZE_MAX
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +0000107
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000108/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000109#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000110/* Smallest negative value of type Py_ssize_t. */
111#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
112
113/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
114 * format to convert an argument with the width of a size_t or Py_ssize_t.
115 * C99 introduced "z" for this purpose, but not all platforms support that;
116 * e.g., MS compilers use "I" instead.
117 *
118 * These "high level" Python format functions interpret "z" correctly on
119 * all platforms (Python interprets the format string itself, and does whatever
120 * the platform C requires to convert a size_t/Py_ssize_t argument):
121 *
Christian Heimes72b710a2008-05-26 13:28:38 +0000122 * PyBytes_FromFormat
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000123 * PyErr_Format
Christian Heimes72b710a2008-05-26 13:28:38 +0000124 * PyBytes_FromFormatV
Walter Dörwald7696ed72007-05-31 15:51:35 +0000125 * PyUnicode_FromFormatV
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000126 *
127 * Lower-level uses require that you interpolate the correct format modifier
128 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
129 * example,
130 *
131 * Py_ssize_t index;
132 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
133 *
134 * That will expand to %ld, or %Id, or to something else correct for a
135 * Py_ssize_t on the platform.
136 */
137#ifndef PY_FORMAT_SIZE_T
Thomas Wouters89f507f2006-12-13 04:49:30 +0000138# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000139# define PY_FORMAT_SIZE_T ""
140# elif SIZEOF_SIZE_T == SIZEOF_LONG
141# define PY_FORMAT_SIZE_T "l"
142# elif defined(MS_WINDOWS)
143# define PY_FORMAT_SIZE_T "I"
144# else
145# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
146# endif
147#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000148
Thomas Wouters477c8d52006-05-27 19:21:47 +0000149/* Py_LOCAL can be used instead of static to get the fastest possible calling
150 * convention for functions that are local to a given module.
151 *
152 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
153 * for platforms that support that.
154 *
155 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
Berker Peksag4882cac2015-04-14 09:30:01 +0300156 * "aggressive" inlining/optimization is enabled for the entire module. This
Thomas Wouters477c8d52006-05-27 19:21:47 +0000157 * may lead to code bloat, and may slow things down for those reasons. It may
158 * also lead to errors, if the code relies on pointer aliasing. Use with
159 * care.
160 *
161 * NOTE: You can only use this for functions that are entirely local to a
162 * module; functions that are exported via method tables, callbacks, etc,
163 * should keep using static.
164 */
165
Thomas Wouters477c8d52006-05-27 19:21:47 +0000166#if defined(_MSC_VER)
Victor Stinner18618e652018-10-25 17:28:11 +0200167# if defined(PY_LOCAL_AGGRESSIVE)
168 /* enable more aggressive optimization for visual studio */
169# pragma optimize("agtw", on)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000170#endif
Victor Stinner18618e652018-10-25 17:28:11 +0200171 /* ignore warnings if the compiler decides not to inline a function */
172# pragma warning(disable: 4710)
173 /* fastest possible local call under MSVC */
174# define Py_LOCAL(type) static type __fastcall
175# define Py_LOCAL_INLINE(type) static __inline type __fastcall
Thomas Wouters477c8d52006-05-27 19:21:47 +0000176#else
Victor Stinner18618e652018-10-25 17:28:11 +0200177# define Py_LOCAL(type) static type
178# define Py_LOCAL_INLINE(type) static inline type
Thomas Wouters477c8d52006-05-27 19:21:47 +0000179#endif
180
Christian Heimesf051e432016-09-13 20:22:02 +0200181/* Py_MEMCPY is kept for backwards compatibility,
182 * see https://bugs.python.org/issue28126 */
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000183#define Py_MEMCPY memcpy
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000184
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000185#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000186
Mark Dickinsona4962cb2009-11-28 12:35:42 +0000187#ifdef HAVE_IEEEFP_H
188#include <ieeefp.h> /* needed for 'finite' declaration on some platforms */
189#endif
190
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000191#include <math.h> /* Moved here from the math section, before extern "C" */
192
193/********************************************
194 * WRAPPER FOR <time.h> and/or <sys/time.h> *
195 ********************************************/
196
197#ifdef TIME_WITH_SYS_TIME
198#include <sys/time.h>
199#include <time.h>
200#else /* !TIME_WITH_SYS_TIME */
201#ifdef HAVE_SYS_TIME_H
202#include <sys/time.h>
203#else /* !HAVE_SYS_TIME_H */
204#include <time.h>
205#endif /* !HAVE_SYS_TIME_H */
206#endif /* !TIME_WITH_SYS_TIME */
207
208
209/******************************
210 * WRAPPER FOR <sys/select.h> *
211 ******************************/
212
213/* NB caller must include <sys/types.h> */
214
215#ifdef HAVE_SYS_SELECT_H
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000216#include <sys/select.h>
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000217#endif /* !HAVE_SYS_SELECT_H */
218
Tim Peters60f42b52001-01-18 03:03:16 +0000219/*******************************
220 * stat() and fstat() fiddling *
221 *******************************/
222
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000223#ifdef HAVE_SYS_STAT_H
Tim Peters60f42b52001-01-18 03:03:16 +0000224#include <sys/stat.h>
225#elif defined(HAVE_STAT_H)
226#include <stat.h>
227#endif
228
Christian Heimes99d61352013-06-23 23:56:05 +0200229#ifndef S_IFMT
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000230/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
Christian Heimes99d61352013-06-23 23:56:05 +0200231#define S_IFMT 0170000
232#endif
233
234#ifndef S_IFLNK
235/* Windows doesn't define S_IFLNK but posixmodule.c maps
236 * IO_REPARSE_TAG_SYMLINK to S_IFLNK */
237# define S_IFLNK 0120000
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000238#endif
239
240#ifndef S_ISREG
241#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
242#endif
243
244#ifndef S_ISDIR
245#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
246#endif
247
Victor Stinnerc6ebd162013-06-23 01:49:42 +0200248#ifndef S_ISCHR
249#define S_ISCHR(x) (((x) & S_IFMT) == S_IFCHR)
250#endif
251
Tim Peters7d3a5112000-07-08 04:17:21 +0000252#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000253/* Move this down here since some C++ #include's don't like to be included
254 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000255extern "C" {
256#endif
257
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000258
Tim Peters7d3a5112000-07-08 04:17:21 +0000259/* Py_ARITHMETIC_RIGHT_SHIFT
260 * C doesn't define whether a right-shift of a signed integer sign-extends
261 * or zero-fills. Here a macro to force sign extension:
262 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
Mark Dickinson16f966e2009-03-20 23:23:15 +0000263 * Return I >> J, forcing sign extension. Arithmetically, return the
264 * floor of I/2**J.
Tim Peters7d3a5112000-07-08 04:17:21 +0000265 * Requirements:
Mark Dickinson16f966e2009-03-20 23:23:15 +0000266 * I should have signed integer type. In the terminology of C99, this can
267 * be either one of the five standard signed integer types (signed char,
268 * short, int, long, long long) or an extended signed integer type.
269 * J is an integer >= 0 and strictly less than the number of bits in the
270 * type of I (because C doesn't define what happens for J outside that
271 * range either).
272 * TYPE used to specify the type of I, but is now ignored. It's been left
273 * in for backwards compatibility with versions <= 2.6 or 3.0.
Tim Peters7d3a5112000-07-08 04:17:21 +0000274 * Caution:
275 * I may be evaluated more than once.
276 */
277#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
278#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000279 ((I) < 0 ? -1-((-1-(I)) >> (J)) : (I) >> (J))
Tim Peters7d3a5112000-07-08 04:17:21 +0000280#else
281#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
282#endif
283
Tim Peters39dce292000-08-15 03:34:48 +0000284/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000285 * "Simply" returns its argument. However, macro expansions within the
286 * argument are evaluated. This unfortunate trickery is needed to get
287 * token-pasting to work as desired in some cases.
288 */
289#define Py_FORCE_EXPANSION(X) X
290
Tim Peters8315ea52000-07-23 19:28:35 +0000291/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
292 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
293 * assert-fails if any information is lost.
294 * Caution:
295 * VALUE may be evaluated more than once.
296 */
297#ifdef Py_DEBUG
298#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
Tim Peters8315ea52000-07-23 19:28:35 +0000300#else
301#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
302#endif
303
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000304/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000305 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000306 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
307 * to 0 before calling a libm function, and invoke this macro after,
308 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000309 * Caution:
310 * This isn't reliable. See Py_OVERFLOWED comments.
311 * X is evaluated more than once.
312 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000313#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000314#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
315#else
316#define _Py_SET_EDOM_FOR_NAN(X) ;
317#endif
318#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000319 do { \
320 if (errno == 0) { \
321 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
322 errno = ERANGE; \
323 else _Py_SET_EDOM_FOR_NAN(X) \
324 } \
325 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000326
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000327/* Py_SET_ERANGE_ON_OVERFLOW(x)
328 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
329 */
330#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
331
Tim Petersdc5a5082002-03-09 04:58:24 +0000332/* Py_ADJUST_ERANGE1(x)
333 * Py_ADJUST_ERANGE2(x, y)
334 * Set errno to 0 before calling a libm function, and invoke one of these
335 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
336 * for functions returning complex results). This makes two kinds of
337 * adjustments to errno: (A) If it looks like the platform libm set
338 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
339 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
340 * effect, we're trying to force a useful implementation of C89 errno
341 * behavior.
342 * Caution:
343 * This isn't reliable. See Py_OVERFLOWED comments.
344 * X and Y may be evaluated more than once.
345 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000346#define Py_ADJUST_ERANGE1(X) \
347 do { \
348 if (errno == 0) { \
349 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
350 errno = ERANGE; \
351 } \
352 else if (errno == ERANGE && (X) == 0.0) \
353 errno = 0; \
354 } while(0)
Tim Petersdc5a5082002-03-09 04:58:24 +0000355
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000356#define Py_ADJUST_ERANGE2(X, Y) \
357 do { \
358 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
359 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
360 if (errno == 0) \
361 errno = ERANGE; \
362 } \
363 else if (errno == ERANGE) \
364 errno = 0; \
365 } while(0)
Tim Petersdc5a5082002-03-09 04:58:24 +0000366
Mark Dickinsona4262b92009-04-19 11:35:55 +0000367/* The functions _Py_dg_strtod and _Py_dg_dtoa in Python/dtoa.c (which are
368 * required to support the short float repr introduced in Python 3.1) require
369 * that the floating-point unit that's being used for arithmetic operations
370 * on C doubles is set to use 53-bit precision. It also requires that the
371 * FPU rounding mode is round-half-to-even, but that's less often an issue.
372 *
373 * If your FPU isn't already set to 53-bit precision/round-half-to-even, and
374 * you want to make use of _Py_dg_strtod and _Py_dg_dtoa, then you should
375 *
376 * #define HAVE_PY_SET_53BIT_PRECISION 1
377 *
378 * and also give appropriate definitions for the following three macros:
379 *
380 * _PY_SET_53BIT_PRECISION_START : store original FPU settings, and
381 * set FPU to 53-bit precision/round-half-to-even
382 * _PY_SET_53BIT_PRECISION_END : restore original FPU settings
383 * _PY_SET_53BIT_PRECISION_HEADER : any variable declarations needed to
384 * use the two macros above.
385 *
386 * The macros are designed to be used within a single C function: see
387 * Python/pystrtod.c for an example of their use.
388 */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000389
Mark Dickinsona4262b92009-04-19 11:35:55 +0000390/* get and set x87 control word for gcc/x86 */
Mark Dickinson7abf8d42009-04-18 20:17:52 +0000391#ifdef HAVE_GCC_ASM_FOR_X87
Mark Dickinsona4262b92009-04-19 11:35:55 +0000392#define HAVE_PY_SET_53BIT_PRECISION 1
393/* _Py_get/set_387controlword functions are defined in Python/pymath.c */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000394#define _Py_SET_53BIT_PRECISION_HEADER \
395 unsigned short old_387controlword, new_387controlword
396#define _Py_SET_53BIT_PRECISION_START \
397 do { \
398 old_387controlword = _Py_get_387controlword(); \
399 new_387controlword = (old_387controlword & ~0x0f00) | 0x0200; \
400 if (new_387controlword != old_387controlword) \
401 _Py_set_387controlword(new_387controlword); \
402 } while (0)
403#define _Py_SET_53BIT_PRECISION_END \
404 if (new_387controlword != old_387controlword) \
405 _Py_set_387controlword(old_387controlword)
Mark Dickinsona4262b92009-04-19 11:35:55 +0000406#endif
407
Mark Dickinson18e3d812012-04-15 15:10:56 +0100408/* get and set x87 control word for VisualStudio/x86 */
Minmin Gong7a236802019-01-21 12:49:40 -0800409#if defined(_MSC_VER) && defined(_M_IX86) /* x87 only supported in x86 */
Mark Dickinson18e3d812012-04-15 15:10:56 +0100410#define HAVE_PY_SET_53BIT_PRECISION 1
411#define _Py_SET_53BIT_PRECISION_HEADER \
412 unsigned int old_387controlword, new_387controlword, out_387controlword
413/* We use the __control87_2 function to set only the x87 control word.
414 The SSE control word is unaffected. */
415#define _Py_SET_53BIT_PRECISION_START \
416 do { \
417 __control87_2(0, 0, &old_387controlword, NULL); \
418 new_387controlword = \
419 (old_387controlword & ~(_MCW_PC | _MCW_RC)) | (_PC_53 | _RC_NEAR); \
420 if (new_387controlword != old_387controlword) \
421 __control87_2(new_387controlword, _MCW_PC | _MCW_RC, \
422 &out_387controlword, NULL); \
423 } while (0)
424#define _Py_SET_53BIT_PRECISION_END \
425 do { \
426 if (new_387controlword != old_387controlword) \
427 __control87_2(old_387controlword, _MCW_PC | _MCW_RC, \
428 &out_387controlword, NULL); \
429 } while (0)
430#endif
431
Benjamin Peterson8bdeb162014-04-17 00:00:31 -0400432#ifdef HAVE_GCC_ASM_FOR_MC68881
433#define HAVE_PY_SET_53BIT_PRECISION 1
434#define _Py_SET_53BIT_PRECISION_HEADER \
435 unsigned int old_fpcr, new_fpcr
Christian Heimesf051e432016-09-13 20:22:02 +0200436#define _Py_SET_53BIT_PRECISION_START \
437 do { \
438 __asm__ ("fmove.l %%fpcr,%0" : "=g" (old_fpcr)); \
439 /* Set double precision / round to nearest. */ \
440 new_fpcr = (old_fpcr & ~0xf0) | 0x80; \
441 if (new_fpcr != old_fpcr) \
442 __asm__ volatile ("fmove.l %0,%%fpcr" : : "g" (new_fpcr)); \
Benjamin Peterson8bdeb162014-04-17 00:00:31 -0400443 } while (0)
Christian Heimesf051e432016-09-13 20:22:02 +0200444#define _Py_SET_53BIT_PRECISION_END \
445 do { \
446 if (new_fpcr != old_fpcr) \
447 __asm__ volatile ("fmove.l %0,%%fpcr" : : "g" (old_fpcr)); \
Benjamin Peterson8bdeb162014-04-17 00:00:31 -0400448 } while (0)
449#endif
450
Mark Dickinsona4262b92009-04-19 11:35:55 +0000451/* default definitions are empty */
452#ifndef HAVE_PY_SET_53BIT_PRECISION
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000453#define _Py_SET_53BIT_PRECISION_HEADER
454#define _Py_SET_53BIT_PRECISION_START
455#define _Py_SET_53BIT_PRECISION_END
456#endif
457
458/* If we can't guarantee 53-bit precision, don't use the code
459 in Python/dtoa.c, but fall back to standard code. This
460 means that repr of a float will be long (17 sig digits).
461
462 Realistically, there are two things that could go wrong:
463
464 (1) doubles aren't IEEE 754 doubles, or
465 (2) we're on x86 with the rounding precision set to 64-bits
466 (extended precision), and we don't know how to change
467 the rounding precision.
468 */
469
470#if !defined(DOUBLE_IS_LITTLE_ENDIAN_IEEE754) && \
471 !defined(DOUBLE_IS_BIG_ENDIAN_IEEE754) && \
472 !defined(DOUBLE_IS_ARM_MIXED_ENDIAN_IEEE754)
473#define PY_NO_SHORT_FLOAT_REPR
474#endif
475
Mark Dickinson60fd0992009-04-18 10:16:35 +0000476/* double rounding is symptomatic of use of extended precision on x86. If
477 we're seeing double rounding, and we don't have any mechanism available for
478 changing the FPU rounding precision, then don't use Python/dtoa.c. */
Mark Dickinsona4262b92009-04-19 11:35:55 +0000479#if defined(X87_DOUBLE_ROUNDING) && !defined(HAVE_PY_SET_53BIT_PRECISION)
Mark Dickinsonb08a53a2009-04-16 19:52:09 +0000480#define PY_NO_SHORT_FLOAT_REPR
481#endif
482
483
Neal Norwitz80292642002-12-19 15:12:26 +0000484/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000485 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000486 * Usage:
487 * extern int old_var Py_DEPRECATED(2.3);
488 * typedef int T1 Py_DEPRECATED(2.4);
489 * extern int x() Py_DEPRECATED(2.5);
490 */
Victor Stinnerc6944e72016-11-11 02:13:35 +0100491#if defined(__GNUC__) \
492 && ((__GNUC__ >= 4) || (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000493#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
494#else
Tim Peters4643bd92002-12-28 21:56:08 +0000495#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000496#endif
497
Victor Stinnerc6944e72016-11-11 02:13:35 +0100498
Victor Stinnerc7a8f672016-11-15 15:13:40 +0100499/* _Py_HOT_FUNCTION
Victor Stinnerc6944e72016-11-11 02:13:35 +0100500 * The hot attribute on a function is used to inform the compiler that the
501 * function is a hot spot of the compiled program. The function is optimized
502 * more aggressively and on many target it is placed into special subsection of
503 * the text section so all hot functions appears close together improving
504 * locality.
505 *
506 * Usage:
Victor Stinnerb915bc32017-01-11 01:07:03 +0100507 * int _Py_HOT_FUNCTION x(void) { return 3; }
Victor Stinnerc6944e72016-11-11 02:13:35 +0100508 *
509 * Issue #28618: This attribute must not be abused, otherwise it can have a
510 * negative effect on performance. Only the functions were Python spend most of
511 * its time must use it. Use a profiler when running performance benchmark
512 * suite to find these functions.
513 */
514#if defined(__GNUC__) \
515 && ((__GNUC__ >= 5) || (__GNUC__ == 4) && (__GNUC_MINOR__ >= 3))
516#define _Py_HOT_FUNCTION __attribute__((hot))
517#else
518#define _Py_HOT_FUNCTION
519#endif
520
Victor Stinnerb915bc32017-01-11 01:07:03 +0100521/* _Py_NO_INLINE
522 * Disable inlining on a function. For example, it helps to reduce the C stack
523 * consumption.
524 *
525 * Usage:
526 * int _Py_NO_INLINE x(void) { return 3; }
527 */
Serhiy Storchakac5734992018-07-24 10:55:47 +0300528#if defined(_MSC_VER)
529# define _Py_NO_INLINE __declspec(noinline)
530#elif defined(__GNUC__) || defined(__clang__)
531# define _Py_NO_INLINE __attribute__ ((noinline))
Victor Stinnerb915bc32017-01-11 01:07:03 +0100532#else
533# define _Py_NO_INLINE
534#endif
535
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000536/**************************************************************************
537Prototypes that are missing from the standard include files on some systems
538(and possibly only some versions of such systems.)
539
540Please be conservative with adding new ones, document them and enclose them
541in platform-specific #ifdefs.
542**************************************************************************/
543
544#ifdef SOLARIS
545/* Unchecked */
546extern int gethostname(char *, int);
547#endif
548
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000549#ifdef HAVE__GETPTY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000550#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000551extern char * _getpty(int *, int, mode_t, int);
552#endif
553
Georg Brandlf78e02b2008-06-10 17:40:04 +0000554/* On QNX 6, struct termio must be declared by including sys/termio.h
555 if TCGETA, TCSETA, TCSETAW, or TCSETAF are used. sys/termio.h must
556 be included before termios.h or it will generate an error. */
Stefan Krah2cbbed62012-11-19 00:07:18 +0100557#if defined(HAVE_SYS_TERMIO_H) && !defined(__hpux)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000558#include <sys/termio.h>
559#endif
560
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000561
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000562/* On 4.4BSD-descendants, ctype functions serves the whole range of
563 * wchar_t character set rather than single byte code points only.
564 * This characteristic can break some operations of string object
565 * including str.upper() and str.split() on UTF-8 locales. This
566 * workaround was provided by Tim Robbins of FreeBSD project.
567 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000568
Ronald Oussoren501aeff2010-04-18 15:02:38 +0000569#if defined(__APPLE__)
Victor Stinner13ff2452018-01-22 18:32:50 +0100570# define _PY_PORT_CTYPE_UTF8_ISSUE
Ronald Oussoren501aeff2010-04-18 15:02:38 +0000571#endif
572
573#ifdef _PY_PORT_CTYPE_UTF8_ISSUE
Ned Deily7659aab2016-08-15 03:07:26 -0400574#ifndef __cplusplus
575 /* The workaround below is unsafe in C++ because
576 * the <locale> defines these symbols as real functions,
577 * with a slightly different signature.
578 * See issue #10910
579 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000580#include <ctype.h>
581#include <wctype.h>
582#undef isalnum
583#define isalnum(c) iswalnum(btowc(c))
584#undef isalpha
585#define isalpha(c) iswalpha(btowc(c))
586#undef islower
587#define islower(c) iswlower(btowc(c))
588#undef isspace
589#define isspace(c) iswspace(btowc(c))
590#undef isupper
591#define isupper(c) iswupper(btowc(c))
592#undef tolower
593#define tolower(c) towlower(btowc(c))
594#undef toupper
595#define toupper(c) towupper(btowc(c))
596#endif
Ned Deily7659aab2016-08-15 03:07:26 -0400597#endif
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000598
599
Mark Hammond8235ea12002-07-19 06:55:41 +0000600/* Declarations for symbol visibility.
601
602 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000603 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000604 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000605 inside the Python core, they are private to the core.
606 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000607 external linkage depending on the platform.
608
609 As a number of platforms support/require "__declspec(dllimport/dllexport)",
610 we support a HAVE_DECLSPEC_DLL macro to save duplication.
611*/
612
Tim Peters4643bd92002-12-28 21:56:08 +0000613/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000614 All windows ports, except cygwin, are handled in PC/pyconfig.h.
615
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000616 Cygwin is the only other autoconf platform requiring special
617 linkage handling and it uses __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000618*/
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000619#if defined(__CYGWIN__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000620# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000621#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000622
Jason Tishler30765592003-09-04 11:04:06 +0000623/* only get special linkage if built as shared or platform is Cygwin */
624#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625# if defined(HAVE_DECLSPEC_DLL)
Eric Snowfc1bf872017-09-11 18:30:43 -0700626# if defined(Py_BUILD_CORE) || defined(Py_BUILD_CORE_BUILTIN)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
628# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Daniel Stutzbach38615992010-09-14 16:02:01 +0000629 /* module init functions inside the core need no external linkage */
630 /* except for Cygwin to handle embedding */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000631# if defined(__CYGWIN__)
632# define PyMODINIT_FUNC __declspec(dllexport) PyObject*
633# else /* __CYGWIN__ */
634# define PyMODINIT_FUNC PyObject*
635# endif /* __CYGWIN__ */
636# else /* Py_BUILD_CORE */
Daniel Stutzbach38615992010-09-14 16:02:01 +0000637 /* Building an extension module, or an embedded situation */
638 /* public Python functions and data are imported */
639 /* Under Cygwin, auto-import functions to prevent compilation */
640 /* failures similar to those described at the bottom of 4.1: */
641 /* http://docs.python.org/extending/windows.html#a-cookbook-approach */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000642# if !defined(__CYGWIN__)
643# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
644# endif /* !__CYGWIN__ */
645# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Daniel Stutzbach38615992010-09-14 16:02:01 +0000646 /* module init functions outside the core must be exported */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000647# if defined(__cplusplus)
648# define PyMODINIT_FUNC extern "C" __declspec(dllexport) PyObject*
649# else /* __cplusplus */
650# define PyMODINIT_FUNC __declspec(dllexport) PyObject*
651# endif /* __cplusplus */
652# endif /* Py_BUILD_CORE */
Joseph Shen677ab992017-03-03 21:44:51 +0800653# endif /* HAVE_DECLSPEC_DLL */
Mark Hammond8235ea12002-07-19 06:55:41 +0000654#endif /* Py_ENABLE_SHARED */
655
656/* If no external linkage macros defined by now, create defaults */
657#ifndef PyAPI_FUNC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000658# define PyAPI_FUNC(RTYPE) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000659#endif
660#ifndef PyAPI_DATA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000662#endif
663#ifndef PyMODINIT_FUNC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000664# if defined(__cplusplus)
665# define PyMODINIT_FUNC extern "C" PyObject*
666# else /* __cplusplus */
667# define PyMODINIT_FUNC PyObject*
668# endif /* __cplusplus */
Mark Hammond8235ea12002-07-19 06:55:41 +0000669#endif
670
Fred Draked5fadf72000-09-26 05:46:01 +0000671/* limits.h constants that may be missing */
672
673#ifndef INT_MAX
674#define INT_MAX 2147483647
675#endif
676
677#ifndef LONG_MAX
678#if SIZEOF_LONG == 4
679#define LONG_MAX 0X7FFFFFFFL
680#elif SIZEOF_LONG == 8
681#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
682#else
683#error "could not set LONG_MAX in pyport.h"
684#endif
685#endif
686
687#ifndef LONG_MIN
688#define LONG_MIN (-LONG_MAX-1)
689#endif
690
Tim Petersd57731f2000-10-05 01:42:25 +0000691#ifndef LONG_BIT
692#define LONG_BIT (8 * SIZEOF_LONG)
693#endif
694
695#if LONG_BIT != 8 * SIZEOF_LONG
696/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
697 * 32-bit platforms using gcc. We try to catch that here at compile-time
698 * rather than waiting for integer multiplication to trigger bogus
699 * overflows.
700 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000701#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000702#endif
703
Tim Peters7d3a5112000-07-08 04:17:21 +0000704#ifdef __cplusplus
705}
706#endif
707
Neil Schemenauer15691082001-10-23 02:20:37 +0000708/*
709 * Hide GCC attributes from compilers that don't support them.
710 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000711#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Skip Montanaro7a98be22007-08-16 14:35:24 +0000712 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) )
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000713#define Py_GCC_ATTRIBUTE(x)
714#else
715#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000716#endif
717
Thomas Wouters89f507f2006-12-13 04:49:30 +0000718/*
Benjamin Peterson058e31e2009-01-16 03:54:08 +0000719 * Specify alignment on compilers that support it.
720 */
721#if defined(__GNUC__) && __GNUC__ >= 3
722#define Py_ALIGNED(x) __attribute__((aligned(x)))
723#else
724#define Py_ALIGNED(x)
725#endif
726
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000727/* Eliminate end-of-loop code not reached warnings from SunPro C
728 * when using do{...}while(0) macros
729 */
730#ifdef __SUNPRO_C
731#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
732#endif
733
Thomas Wouters477c8d52006-05-27 19:21:47 +0000734#ifndef Py_LL
735#define Py_LL(x) x##LL
736#endif
737
738#ifndef Py_ULL
739#define Py_ULL(x) Py_LL(x##U)
740#endif
741
Benjamin Peterson0c212142016-09-20 20:39:33 -0700742#define Py_VA_COPY va_copy
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000743
Christian Heimes743e0cd2012-10-17 23:52:17 +0200744/*
Georg Brandl3962d5e2012-10-28 08:48:28 +0100745 * Convenient macros to deal with endianness of the platform. WORDS_BIGENDIAN is
Christian Heimes743e0cd2012-10-17 23:52:17 +0200746 * detected by configure and defined in pyconfig.h. The code in pyconfig.h
Terry Jan Reedy8e7586b2013-03-11 18:38:13 -0400747 * also takes care of Apple's universal builds.
Christian Heimes743e0cd2012-10-17 23:52:17 +0200748 */
749
750#ifdef WORDS_BIGENDIAN
751#define PY_BIG_ENDIAN 1
752#define PY_LITTLE_ENDIAN 0
753#else
754#define PY_BIG_ENDIAN 0
755#define PY_LITTLE_ENDIAN 1
756#endif
757
Eric Snowfc1bf872017-09-11 18:30:43 -0700758#if defined(Py_BUILD_CORE) || defined(Py_BUILD_CORE_BUILTIN)
Steve Dower8fc89802015-04-12 00:26:27 -0400759/*
760 * Macros to protect CRT calls against instant termination when passed an
761 * invalid parameter (issue23524).
762 */
763#if defined _MSC_VER && _MSC_VER >= 1900
764
765extern _invalid_parameter_handler _Py_silent_invalid_parameter_handler;
766#define _Py_BEGIN_SUPPRESS_IPH { _invalid_parameter_handler _Py_old_handler = \
767 _set_thread_local_invalid_parameter_handler(_Py_silent_invalid_parameter_handler);
768#define _Py_END_SUPPRESS_IPH _set_thread_local_invalid_parameter_handler(_Py_old_handler); }
769
770#else
771
772#define _Py_BEGIN_SUPPRESS_IPH
773#define _Py_END_SUPPRESS_IPH
774
775#endif /* _MSC_VER >= 1900 */
776#endif /* Py_BUILD_CORE */
777
Stefan Krah1f9eb872016-05-22 17:35:34 +0200778#ifdef __ANDROID__
xdegayec06c22e2017-11-23 11:44:38 +0100779/* The Android langinfo.h header is not used. */
780#undef HAVE_LANGINFO_H
781#undef CODESET
Stefan Krah1f9eb872016-05-22 17:35:34 +0200782#endif
783
Victor Stinner850a18e2017-10-24 16:53:32 -0700784/* Maximum value of the Windows DWORD type */
785#define PY_DWORD_MAX 4294967295U
786
Antoine Pitroua6a4dc82017-09-07 18:56:24 +0200787/* This macro used to tell whether Python was built with multithreading
788 * enabled. Now multithreading is always enabled, but keep the macro
789 * for compatibility.
790 */
791#ifndef WITH_THREAD
792#define WITH_THREAD
793#endif
794
Tim Peters7d3a5112000-07-08 04:17:21 +0000795#endif /* Py_PYPORT_H */