Tim Peters | 7d3a511 | 2000-07-08 04:17:21 +0000 | [diff] [blame] | 1 | #ifndef Py_PYPORT_H |
Vladimir Marangozov | 14a4d88 | 2000-07-10 04:59:49 +0000 | [diff] [blame] | 2 | #define Py_PYPORT_H |
Tim Peters | 7d3a511 | 2000-07-08 04:17:21 +0000 | [diff] [blame] | 3 | |
Martin v. Löwis | 4f1cd8b | 2001-07-26 13:41:06 +0000 | [diff] [blame] | 4 | #include "pyconfig.h" /* include for defines */ |
Peter Schneider-Kamp | 25f6894 | 2000-07-31 22:19:30 +0000 | [diff] [blame] | 5 | |
Mark Dickinson | 835a6c8 | 2009-06-30 15:45:17 +0000 | [diff] [blame] | 6 | #include <inttypes.h> |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 7 | |
Tim Peters | 7d3a511 | 2000-07-08 04:17:21 +0000 | [diff] [blame] | 8 | /************************************************************************** |
| 9 | Symbols and macros to supply platform-independent interfaces to basic |
Tim Peters | 1be4684 | 2000-07-23 18:10:18 +0000 | [diff] [blame] | 10 | C language & library operations whose spellings vary across platforms. |
Tim Peters | 7d3a511 | 2000-07-08 04:17:21 +0000 | [diff] [blame] | 11 | |
| 12 | Please try to make documentation here as clear as possible: by definition, |
| 13 | the stuff here is trying to illuminate C's darkest corners. |
| 14 | |
| 15 | Config #defines referenced here: |
| 16 | |
| 17 | SIGNED_RIGHT_SHIFT_ZERO_FILLS |
| 18 | Meaning: To be defined iff i>>j does not extend the sign bit when i is a |
| 19 | signed integral type and i < 0. |
| 20 | Used in: Py_ARITHMETIC_RIGHT_SHIFT |
Tim Peters | 1be4684 | 2000-07-23 18:10:18 +0000 | [diff] [blame] | 21 | |
Tim Peters | 8315ea5 | 2000-07-23 19:28:35 +0000 | [diff] [blame] | 22 | Py_DEBUG |
| 23 | Meaning: Extra checks compiled in for debug mode. |
| 24 | Used in: Py_SAFE_DOWNCAST |
Barry Warsaw | fd847b2 | 2000-08-18 04:48:18 +0000 | [diff] [blame] | 25 | |
Tim Peters | 7d3a511 | 2000-07-08 04:17:21 +0000 | [diff] [blame] | 26 | **************************************************************************/ |
| 27 | |
Barry Warsaw | fd847b2 | 2000-08-18 04:48:18 +0000 | [diff] [blame] | 28 | /* 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 Peterson | 41e35f3 | 2016-09-18 18:02:58 -0700 | [diff] [blame] | 40 | // long long is required now. Define HAVE_LONG_LONG unconditionally for |
| 41 | // compatibility. |
| 42 | #define HAVE_LONG_LONG |
Martin v. Löwis | b9a0f91 | 2003-03-29 10:06:18 +0000 | [diff] [blame] | 43 | #ifndef PY_LONG_LONG |
| 44 | #define PY_LONG_LONG long long |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 45 | /* 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 Warsaw | fd847b2 | 2000-08-18 04:48:18 +0000 | [diff] [blame] | 49 | #endif |
Barry Warsaw | fd847b2 | 2000-08-18 04:48:18 +0000 | [diff] [blame] | 50 | |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 51 | #define PY_UINT32_T uint32_t |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 52 | #define PY_UINT64_T uint64_t |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 53 | |
| 54 | /* Signed variants of the above */ |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 55 | #define PY_INT32_T int32_t |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 56 | #define PY_INT64_T int64_t |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 57 | |
| 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 Peterson | 4fe5510 | 2016-09-06 11:58:01 -0700 | [diff] [blame] | 63 | #if SIZEOF_VOID_P >= 8 |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 64 | #define PYLONG_BITS_IN_DIGIT 30 |
| 65 | #else |
| 66 | #define PYLONG_BITS_IN_DIGIT 15 |
| 67 | #endif |
| 68 | #endif |
| 69 | |
Barry Warsaw | fd847b2 | 2000-08-18 04:48:18 +0000 | [diff] [blame] | 70 | /* 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 Peters | 79248aa | 2001-08-29 21:37:10 +0000 | [diff] [blame] | 72 | * without loss of information. Similarly for intptr_t, wrt a signed |
| 73 | * integral type. |
Barry Warsaw | fd847b2 | 2000-08-18 04:48:18 +0000 | [diff] [blame] | 74 | */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 75 | typedef uintptr_t Py_uintptr_t; |
| 76 | typedef intptr_t Py_intptr_t; |
Tim Peters | 79248aa | 2001-08-29 21:37:10 +0000 | [diff] [blame] | 77 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 78 | /* 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öwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 82 | #ifdef HAVE_SSIZE_T |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 83 | typedef ssize_t Py_ssize_t; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 84 | #elif SIZEOF_VOID_P == SIZEOF_SIZE_T |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 85 | typedef Py_intptr_t Py_ssize_t; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 86 | #else |
| 87 | # error "Python needs a typedef for Py_ssize_t in pyport.h." |
| 88 | #endif |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 89 | |
Benjamin Peterson | 8f67d08 | 2010-10-17 20:54:53 +0000 | [diff] [blame] | 90 | /* Py_hash_t is the same size as a pointer. */ |
Christian Heimes | 985ecdc | 2013-11-20 11:46:18 +0100 | [diff] [blame] | 91 | #define SIZEOF_PY_HASH_T SIZEOF_SIZE_T |
Benjamin Peterson | 8f67d08 | 2010-10-17 20:54:53 +0000 | [diff] [blame] | 92 | typedef Py_ssize_t Py_hash_t; |
Benjamin Peterson | 8035bc5 | 2010-10-23 16:20:50 +0000 | [diff] [blame] | 93 | /* Py_uhash_t is the unsigned equivalent needed to calculate numeric hash. */ |
Christian Heimes | 985ecdc | 2013-11-20 11:46:18 +0100 | [diff] [blame] | 94 | #define SIZEOF_PY_UHASH_T SIZEOF_SIZE_T |
Benjamin Peterson | 8035bc5 | 2010-10-23 16:20:50 +0000 | [diff] [blame] | 95 | typedef size_t Py_uhash_t; |
Benjamin Peterson | 8f67d08 | 2010-10-17 20:54:53 +0000 | [diff] [blame] | 96 | |
Larry Hastings | ebdcb50 | 2013-11-23 14:54:00 -0800 | [diff] [blame] | 97 | /* Only used for compatibility with code that may not be PY_SSIZE_T_CLEAN. */ |
| 98 | #ifdef PY_SSIZE_T_CLEAN |
| 99 | typedef Py_ssize_t Py_ssize_clean_t; |
| 100 | #else |
| 101 | typedef int Py_ssize_clean_t; |
| 102 | #endif |
| 103 | |
Benjamin Peterson | 2f8bfef | 2016-09-07 09:26:18 -0700 | [diff] [blame] | 104 | /* Largest possible value of size_t. */ |
Amaury Forgeot d'Arc | 9c74b14 | 2008-06-18 00:47:36 +0000 | [diff] [blame] | 105 | #define PY_SIZE_MAX SIZE_MAX |
Amaury Forgeot d'Arc | 9c74b14 | 2008-06-18 00:47:36 +0000 | [diff] [blame] | 106 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 107 | /* Largest positive value of type Py_ssize_t. */ |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 108 | #define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1)) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 109 | /* 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 Heimes | 72b710a | 2008-05-26 13:28:38 +0000 | [diff] [blame] | 121 | * PyBytes_FromFormat |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 122 | * PyErr_Format |
Christian Heimes | 72b710a | 2008-05-26 13:28:38 +0000 | [diff] [blame] | 123 | * PyBytes_FromFormatV |
Walter Dörwald | 7696ed7 | 2007-05-31 15:51:35 +0000 | [diff] [blame] | 124 | * PyUnicode_FromFormatV |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 125 | * |
| 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 Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 137 | # if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 138 | # 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öwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 147 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 148 | /* 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 Peksag | 4882cac | 2015-04-14 09:30:01 +0300 | [diff] [blame] | 155 | * "aggressive" inlining/optimization is enabled for the entire module. This |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 156 | * 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 Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 165 | #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 Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 170 | /* ignore warnings if the compiler decides not to inline a function */ |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 171 | #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 Heimes | f051e43 | 2016-09-13 20:22:02 +0200 | [diff] [blame] | 183 | /* Py_MEMCPY is kept for backwards compatibility, |
| 184 | * see https://bugs.python.org/issue28126 */ |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 185 | #define Py_MEMCPY memcpy |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 186 | |
Peter Schneider-Kamp | 7e01890 | 2000-07-31 15:28:04 +0000 | [diff] [blame] | 187 | #include <stdlib.h> |
Peter Schneider-Kamp | 7e01890 | 2000-07-31 15:28:04 +0000 | [diff] [blame] | 188 | |
Mark Dickinson | a4962cb | 2009-11-28 12:35:42 +0000 | [diff] [blame] | 189 | #ifdef HAVE_IEEEFP_H |
| 190 | #include <ieeefp.h> /* needed for 'finite' declaration on some platforms */ |
| 191 | #endif |
| 192 | |
Vladimir Marangozov | 2c57e07 | 2000-08-11 11:48:33 +0000 | [diff] [blame] | 193 | #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 Marangozov | 2c57e07 | 2000-08-11 11:48:33 +0000 | [diff] [blame] | 218 | #include <sys/select.h> |
Vladimir Marangozov | 2c57e07 | 2000-08-11 11:48:33 +0000 | [diff] [blame] | 219 | #endif /* !HAVE_SYS_SELECT_H */ |
| 220 | |
Tim Peters | 60f42b5 | 2001-01-18 03:03:16 +0000 | [diff] [blame] | 221 | /******************************* |
| 222 | * stat() and fstat() fiddling * |
| 223 | *******************************/ |
| 224 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 225 | #ifdef HAVE_SYS_STAT_H |
Tim Peters | 60f42b5 | 2001-01-18 03:03:16 +0000 | [diff] [blame] | 226 | #include <sys/stat.h> |
| 227 | #elif defined(HAVE_STAT_H) |
| 228 | #include <stat.h> |
| 229 | #endif |
| 230 | |
Christian Heimes | 99d6135 | 2013-06-23 23:56:05 +0200 | [diff] [blame] | 231 | #ifndef S_IFMT |
Martin v. Löwis | f9836ba | 2001-08-08 10:28:06 +0000 | [diff] [blame] | 232 | /* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */ |
Christian Heimes | 99d6135 | 2013-06-23 23:56:05 +0200 | [diff] [blame] | 233 | #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öwis | f9836ba | 2001-08-08 10:28:06 +0000 | [diff] [blame] | 240 | #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 Stinner | c6ebd16 | 2013-06-23 01:49:42 +0200 | [diff] [blame] | 250 | #ifndef S_ISCHR |
| 251 | #define S_ISCHR(x) (((x) & S_IFMT) == S_IFCHR) |
| 252 | #endif |
| 253 | |
Tim Peters | 7d3a511 | 2000-07-08 04:17:21 +0000 | [diff] [blame] | 254 | #ifdef __cplusplus |
Peter Schneider-Kamp | 7e01890 | 2000-07-31 15:28:04 +0000 | [diff] [blame] | 255 | /* Move this down here since some C++ #include's don't like to be included |
| 256 | inside an extern "C" */ |
Tim Peters | 7d3a511 | 2000-07-08 04:17:21 +0000 | [diff] [blame] | 257 | extern "C" { |
| 258 | #endif |
| 259 | |
Vladimir Marangozov | 2c57e07 | 2000-08-11 11:48:33 +0000 | [diff] [blame] | 260 | |
Tim Peters | 7d3a511 | 2000-07-08 04:17:21 +0000 | [diff] [blame] | 261 | /* 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 Dickinson | 16f966e | 2009-03-20 23:23:15 +0000 | [diff] [blame] | 265 | * Return I >> J, forcing sign extension. Arithmetically, return the |
| 266 | * floor of I/2**J. |
Tim Peters | 7d3a511 | 2000-07-08 04:17:21 +0000 | [diff] [blame] | 267 | * Requirements: |
Mark Dickinson | 16f966e | 2009-03-20 23:23:15 +0000 | [diff] [blame] | 268 | * 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 Peters | 7d3a511 | 2000-07-08 04:17:21 +0000 | [diff] [blame] | 276 | * 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 Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 281 | ((I) < 0 ? -1-((-1-(I)) >> (J)) : (I) >> (J)) |
Tim Peters | 7d3a511 | 2000-07-08 04:17:21 +0000 | [diff] [blame] | 282 | #else |
| 283 | #define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J)) |
| 284 | #endif |
| 285 | |
Tim Peters | 39dce29 | 2000-08-15 03:34:48 +0000 | [diff] [blame] | 286 | /* Py_FORCE_EXPANSION(X) |
Tim Peters | 1be4684 | 2000-07-23 18:10:18 +0000 | [diff] [blame] | 287 | * "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 Peters | 8315ea5 | 2000-07-23 19:28:35 +0000 | [diff] [blame] | 293 | /* 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 Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 301 | (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE)) |
Tim Peters | 8315ea5 | 2000-07-23 19:28:35 +0000 | [diff] [blame] | 302 | #else |
| 303 | #define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE) |
| 304 | #endif |
| 305 | |
Hye-Shik Chang | 77d9a3e | 2004-03-22 08:43:55 +0000 | [diff] [blame] | 306 | /* Py_SET_ERRNO_ON_MATH_ERROR(x) |
Tim Peters | a40c793 | 2001-09-05 22:36:56 +0000 | [diff] [blame] | 307 | * If a libm function did not set errno, but it looks like the result |
Hye-Shik Chang | 77d9a3e | 2004-03-22 08:43:55 +0000 | [diff] [blame] | 308 | * 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 Peters | a40c793 | 2001-09-05 22:36:56 +0000 | [diff] [blame] | 311 | * Caution: |
| 312 | * This isn't reliable. See Py_OVERFLOWED comments. |
| 313 | * X is evaluated more than once. |
| 314 | */ |
Guido van Rossum | 539c662 | 2005-09-14 17:49:54 +0000 | [diff] [blame] | 315 | #if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64)) |
Hye-Shik Chang | 77d9a3e | 2004-03-22 08:43:55 +0000 | [diff] [blame] | 316 | #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 Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 321 | 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 Peters | 57f282a | 2001-09-05 05:38:10 +0000 | [diff] [blame] | 328 | |
Hye-Shik Chang | 77d9a3e | 2004-03-22 08:43:55 +0000 | [diff] [blame] | 329 | /* 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 Peters | dc5a508 | 2002-03-09 04:58:24 +0000 | [diff] [blame] | 334 | /* 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 Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 348 | #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 Peters | dc5a508 | 2002-03-09 04:58:24 +0000 | [diff] [blame] | 357 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 358 | #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 Peters | dc5a508 | 2002-03-09 04:58:24 +0000 | [diff] [blame] | 368 | |
Mark Dickinson | a4262b9 | 2009-04-19 11:35:55 +0000 | [diff] [blame] | 369 | /* 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 Dickinson | b08a53a | 2009-04-16 19:52:09 +0000 | [diff] [blame] | 391 | |
Mark Dickinson | a4262b9 | 2009-04-19 11:35:55 +0000 | [diff] [blame] | 392 | /* get and set x87 control word for gcc/x86 */ |
Mark Dickinson | 7abf8d4 | 2009-04-18 20:17:52 +0000 | [diff] [blame] | 393 | #ifdef HAVE_GCC_ASM_FOR_X87 |
Mark Dickinson | a4262b9 | 2009-04-19 11:35:55 +0000 | [diff] [blame] | 394 | #define HAVE_PY_SET_53BIT_PRECISION 1 |
| 395 | /* _Py_get/set_387controlword functions are defined in Python/pymath.c */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 396 | #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 Dickinson | a4262b9 | 2009-04-19 11:35:55 +0000 | [diff] [blame] | 408 | #endif |
| 409 | |
Mark Dickinson | 18e3d81 | 2012-04-15 15:10:56 +0100 | [diff] [blame] | 410 | /* 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 Peterson | 8bdeb16 | 2014-04-17 00:00:31 -0400 | [diff] [blame] | 434 | #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 Heimes | f051e43 | 2016-09-13 20:22:02 +0200 | [diff] [blame] | 438 | #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 Peterson | 8bdeb16 | 2014-04-17 00:00:31 -0400 | [diff] [blame] | 445 | } while (0) |
Christian Heimes | f051e43 | 2016-09-13 20:22:02 +0200 | [diff] [blame] | 446 | #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 Peterson | 8bdeb16 | 2014-04-17 00:00:31 -0400 | [diff] [blame] | 450 | } while (0) |
| 451 | #endif |
| 452 | |
Mark Dickinson | a4262b9 | 2009-04-19 11:35:55 +0000 | [diff] [blame] | 453 | /* default definitions are empty */ |
| 454 | #ifndef HAVE_PY_SET_53BIT_PRECISION |
Mark Dickinson | b08a53a | 2009-04-16 19:52:09 +0000 | [diff] [blame] | 455 | #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 Dickinson | 60fd099 | 2009-04-18 10:16:35 +0000 | [diff] [blame] | 478 | /* 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 Dickinson | a4262b9 | 2009-04-19 11:35:55 +0000 | [diff] [blame] | 481 | #if defined(X87_DOUBLE_ROUNDING) && !defined(HAVE_PY_SET_53BIT_PRECISION) |
Mark Dickinson | b08a53a | 2009-04-16 19:52:09 +0000 | [diff] [blame] | 482 | #define PY_NO_SHORT_FLOAT_REPR |
| 483 | #endif |
| 484 | |
| 485 | |
Neal Norwitz | 8029264 | 2002-12-19 15:12:26 +0000 | [diff] [blame] | 486 | /* Py_DEPRECATED(version) |
Neal Norwitz | 93344ab | 2002-12-19 15:24:11 +0000 | [diff] [blame] | 487 | * Declare a variable, type, or function deprecated. |
Neal Norwitz | 8029264 | 2002-12-19 15:12:26 +0000 | [diff] [blame] | 488 | * 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 | */ |
Victor Stinner | c6944e7 | 2016-11-11 02:13:35 +0100 | [diff] [blame^] | 493 | #if defined(__GNUC__) \ |
| 494 | && ((__GNUC__ >= 4) || (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1)) |
Neal Norwitz | 8029264 | 2002-12-19 15:12:26 +0000 | [diff] [blame] | 495 | #define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__)) |
| 496 | #else |
Tim Peters | 4643bd9 | 2002-12-28 21:56:08 +0000 | [diff] [blame] | 497 | #define Py_DEPRECATED(VERSION_UNUSED) |
Neal Norwitz | 8029264 | 2002-12-19 15:12:26 +0000 | [diff] [blame] | 498 | #endif |
| 499 | |
Victor Stinner | c6944e7 | 2016-11-11 02:13:35 +0100 | [diff] [blame^] | 500 | |
| 501 | /* Py_HOT_FUNCTION |
| 502 | * The hot attribute on a function is used to inform the compiler that the |
| 503 | * function is a hot spot of the compiled program. The function is optimized |
| 504 | * more aggressively and on many target it is placed into special subsection of |
| 505 | * the text section so all hot functions appears close together improving |
| 506 | * locality. |
| 507 | * |
| 508 | * Usage: |
| 509 | * int Py_HOT_FUNCTION x() { return 3; } |
| 510 | * |
| 511 | * Issue #28618: This attribute must not be abused, otherwise it can have a |
| 512 | * negative effect on performance. Only the functions were Python spend most of |
| 513 | * its time must use it. Use a profiler when running performance benchmark |
| 514 | * suite to find these functions. |
| 515 | */ |
| 516 | #if defined(__GNUC__) \ |
| 517 | && ((__GNUC__ >= 5) || (__GNUC__ == 4) && (__GNUC_MINOR__ >= 3)) |
| 518 | #define _Py_HOT_FUNCTION __attribute__((hot)) |
| 519 | #else |
| 520 | #define _Py_HOT_FUNCTION |
| 521 | #endif |
| 522 | |
Thomas Wouters | 1e0c2f4 | 2000-07-24 16:06:23 +0000 | [diff] [blame] | 523 | /************************************************************************** |
| 524 | Prototypes that are missing from the standard include files on some systems |
| 525 | (and possibly only some versions of such systems.) |
| 526 | |
| 527 | Please be conservative with adding new ones, document them and enclose them |
| 528 | in platform-specific #ifdefs. |
| 529 | **************************************************************************/ |
| 530 | |
| 531 | #ifdef SOLARIS |
| 532 | /* Unchecked */ |
| 533 | extern int gethostname(char *, int); |
| 534 | #endif |
| 535 | |
Thomas Wouters | 1e0c2f4 | 2000-07-24 16:06:23 +0000 | [diff] [blame] | 536 | #ifdef HAVE__GETPTY |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 537 | #include <sys/types.h> /* we need to import mode_t */ |
Thomas Wouters | 1e0c2f4 | 2000-07-24 16:06:23 +0000 | [diff] [blame] | 538 | extern char * _getpty(int *, int, mode_t, int); |
| 539 | #endif |
| 540 | |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 541 | /* On QNX 6, struct termio must be declared by including sys/termio.h |
| 542 | if TCGETA, TCSETA, TCSETAW, or TCSETAF are used. sys/termio.h must |
| 543 | be included before termios.h or it will generate an error. */ |
Stefan Krah | 2cbbed6 | 2012-11-19 00:07:18 +0100 | [diff] [blame] | 544 | #if defined(HAVE_SYS_TERMIO_H) && !defined(__hpux) |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 545 | #include <sys/termio.h> |
| 546 | #endif |
| 547 | |
Thomas Wouters | 1e0c2f4 | 2000-07-24 16:06:23 +0000 | [diff] [blame] | 548 | #if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) |
| 549 | #if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) |
| 550 | /* BSDI does not supply a prototype for the 'openpty' and 'forkpty' |
| 551 | functions, even though they are included in libutil. */ |
| 552 | #include <termios.h> |
Serhiy Storchaka | aa2b22a | 2013-10-19 21:39:31 +0300 | [diff] [blame] | 553 | extern int openpty(int *, int *, char *, struct termios *, struct winsize *); |
| 554 | extern pid_t forkpty(int *, char *, struct termios *, struct winsize *); |
Thomas Wouters | 1e0c2f4 | 2000-07-24 16:06:23 +0000 | [diff] [blame] | 555 | #endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */ |
| 556 | #endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */ |
| 557 | |
| 558 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 559 | /* On 4.4BSD-descendants, ctype functions serves the whole range of |
| 560 | * wchar_t character set rather than single byte code points only. |
| 561 | * This characteristic can break some operations of string object |
| 562 | * including str.upper() and str.split() on UTF-8 locales. This |
| 563 | * workaround was provided by Tim Robbins of FreeBSD project. |
| 564 | */ |
Hye-Shik Chang | b5047fd | 2004-08-04 06:33:51 +0000 | [diff] [blame] | 565 | |
| 566 | #ifdef __FreeBSD__ |
| 567 | #include <osreldate.h> |
Ned Deily | 3d45599 | 2016-08-15 03:08:18 -0400 | [diff] [blame] | 568 | #if (__FreeBSD_version >= 500040 && __FreeBSD_version < 602113) || \ |
| 569 | (__FreeBSD_version >= 700000 && __FreeBSD_version < 700054) || \ |
| 570 | (__FreeBSD_version >= 800000 && __FreeBSD_version < 800001) |
Ronald Oussoren | 501aeff | 2010-04-18 15:02:38 +0000 | [diff] [blame] | 571 | # define _PY_PORT_CTYPE_UTF8_ISSUE |
| 572 | #endif |
| 573 | #endif |
| 574 | |
| 575 | |
| 576 | #if defined(__APPLE__) |
| 577 | # define _PY_PORT_CTYPE_UTF8_ISSUE |
| 578 | #endif |
| 579 | |
| 580 | #ifdef _PY_PORT_CTYPE_UTF8_ISSUE |
Ned Deily | 7659aab | 2016-08-15 03:07:26 -0400 | [diff] [blame] | 581 | #ifndef __cplusplus |
| 582 | /* The workaround below is unsafe in C++ because |
| 583 | * the <locale> defines these symbols as real functions, |
| 584 | * with a slightly different signature. |
| 585 | * See issue #10910 |
| 586 | */ |
Hye-Shik Chang | b5047fd | 2004-08-04 06:33:51 +0000 | [diff] [blame] | 587 | #include <ctype.h> |
| 588 | #include <wctype.h> |
| 589 | #undef isalnum |
| 590 | #define isalnum(c) iswalnum(btowc(c)) |
| 591 | #undef isalpha |
| 592 | #define isalpha(c) iswalpha(btowc(c)) |
| 593 | #undef islower |
| 594 | #define islower(c) iswlower(btowc(c)) |
| 595 | #undef isspace |
| 596 | #define isspace(c) iswspace(btowc(c)) |
| 597 | #undef isupper |
| 598 | #define isupper(c) iswupper(btowc(c)) |
| 599 | #undef tolower |
| 600 | #define tolower(c) towlower(btowc(c)) |
| 601 | #undef toupper |
| 602 | #define toupper(c) towupper(btowc(c)) |
| 603 | #endif |
Ned Deily | 7659aab | 2016-08-15 03:07:26 -0400 | [diff] [blame] | 604 | #endif |
Hye-Shik Chang | b5047fd | 2004-08-04 06:33:51 +0000 | [diff] [blame] | 605 | |
| 606 | |
Mark Hammond | 8235ea1 | 2002-07-19 06:55:41 +0000 | [diff] [blame] | 607 | /* Declarations for symbol visibility. |
| 608 | |
| 609 | PyAPI_FUNC(type): Declares a public Python API function and return type |
Tim Peters | 4643bd9 | 2002-12-28 21:56:08 +0000 | [diff] [blame] | 610 | PyAPI_DATA(type): Declares public Python data and its type |
Mark Hammond | 8235ea1 | 2002-07-19 06:55:41 +0000 | [diff] [blame] | 611 | PyMODINIT_FUNC: A Python module init function. If these functions are |
Tim Peters | 4643bd9 | 2002-12-28 21:56:08 +0000 | [diff] [blame] | 612 | inside the Python core, they are private to the core. |
| 613 | If in an extension module, it may be declared with |
Mark Hammond | 8235ea1 | 2002-07-19 06:55:41 +0000 | [diff] [blame] | 614 | external linkage depending on the platform. |
| 615 | |
| 616 | As a number of platforms support/require "__declspec(dllimport/dllexport)", |
| 617 | we support a HAVE_DECLSPEC_DLL macro to save duplication. |
| 618 | */ |
| 619 | |
Tim Peters | 4643bd9 | 2002-12-28 21:56:08 +0000 | [diff] [blame] | 620 | /* |
Michael W. Hudson | f163d10 | 2003-02-10 19:36:46 +0000 | [diff] [blame] | 621 | All windows ports, except cygwin, are handled in PC/pyconfig.h. |
| 622 | |
Skip Montanaro | eb33e5a | 2007-08-17 12:57:41 +0000 | [diff] [blame] | 623 | Cygwin is the only other autoconf platform requiring special |
| 624 | linkage handling and it uses __declspec(). |
Mark Hammond | 8235ea1 | 2002-07-19 06:55:41 +0000 | [diff] [blame] | 625 | */ |
Skip Montanaro | eb33e5a | 2007-08-17 12:57:41 +0000 | [diff] [blame] | 626 | #if defined(__CYGWIN__) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 627 | # define HAVE_DECLSPEC_DLL |
Peter Schneider-Kamp | 7e01890 | 2000-07-31 15:28:04 +0000 | [diff] [blame] | 628 | #endif |
Mark Hammond | 8235ea1 | 2002-07-19 06:55:41 +0000 | [diff] [blame] | 629 | |
Jason Tishler | 3076559 | 2003-09-04 11:04:06 +0000 | [diff] [blame] | 630 | /* only get special linkage if built as shared or platform is Cygwin */ |
| 631 | #if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 632 | # if defined(HAVE_DECLSPEC_DLL) |
| 633 | # ifdef Py_BUILD_CORE |
| 634 | # define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE |
| 635 | # define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE |
Daniel Stutzbach | 3861599 | 2010-09-14 16:02:01 +0000 | [diff] [blame] | 636 | /* module init functions inside the core need no external linkage */ |
| 637 | /* except for Cygwin to handle embedding */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 638 | # if defined(__CYGWIN__) |
| 639 | # define PyMODINIT_FUNC __declspec(dllexport) PyObject* |
| 640 | # else /* __CYGWIN__ */ |
| 641 | # define PyMODINIT_FUNC PyObject* |
| 642 | # endif /* __CYGWIN__ */ |
| 643 | # else /* Py_BUILD_CORE */ |
Daniel Stutzbach | 3861599 | 2010-09-14 16:02:01 +0000 | [diff] [blame] | 644 | /* Building an extension module, or an embedded situation */ |
| 645 | /* public Python functions and data are imported */ |
| 646 | /* Under Cygwin, auto-import functions to prevent compilation */ |
| 647 | /* failures similar to those described at the bottom of 4.1: */ |
| 648 | /* http://docs.python.org/extending/windows.html#a-cookbook-approach */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 649 | # if !defined(__CYGWIN__) |
| 650 | # define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE |
| 651 | # endif /* !__CYGWIN__ */ |
| 652 | # define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE |
Daniel Stutzbach | 3861599 | 2010-09-14 16:02:01 +0000 | [diff] [blame] | 653 | /* module init functions outside the core must be exported */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 654 | # if defined(__cplusplus) |
| 655 | # define PyMODINIT_FUNC extern "C" __declspec(dllexport) PyObject* |
| 656 | # else /* __cplusplus */ |
| 657 | # define PyMODINIT_FUNC __declspec(dllexport) PyObject* |
| 658 | # endif /* __cplusplus */ |
| 659 | # endif /* Py_BUILD_CORE */ |
| 660 | # endif /* HAVE_DECLSPEC */ |
Mark Hammond | 8235ea1 | 2002-07-19 06:55:41 +0000 | [diff] [blame] | 661 | #endif /* Py_ENABLE_SHARED */ |
| 662 | |
| 663 | /* If no external linkage macros defined by now, create defaults */ |
| 664 | #ifndef PyAPI_FUNC |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 665 | # define PyAPI_FUNC(RTYPE) RTYPE |
Mark Hammond | 8235ea1 | 2002-07-19 06:55:41 +0000 | [diff] [blame] | 666 | #endif |
| 667 | #ifndef PyAPI_DATA |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 668 | # define PyAPI_DATA(RTYPE) extern RTYPE |
Mark Hammond | 8235ea1 | 2002-07-19 06:55:41 +0000 | [diff] [blame] | 669 | #endif |
| 670 | #ifndef PyMODINIT_FUNC |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 671 | # if defined(__cplusplus) |
| 672 | # define PyMODINIT_FUNC extern "C" PyObject* |
| 673 | # else /* __cplusplus */ |
| 674 | # define PyMODINIT_FUNC PyObject* |
| 675 | # endif /* __cplusplus */ |
Mark Hammond | 8235ea1 | 2002-07-19 06:55:41 +0000 | [diff] [blame] | 676 | #endif |
| 677 | |
Fred Drake | d5fadf7 | 2000-09-26 05:46:01 +0000 | [diff] [blame] | 678 | /* limits.h constants that may be missing */ |
| 679 | |
| 680 | #ifndef INT_MAX |
| 681 | #define INT_MAX 2147483647 |
| 682 | #endif |
| 683 | |
| 684 | #ifndef LONG_MAX |
| 685 | #if SIZEOF_LONG == 4 |
| 686 | #define LONG_MAX 0X7FFFFFFFL |
| 687 | #elif SIZEOF_LONG == 8 |
| 688 | #define LONG_MAX 0X7FFFFFFFFFFFFFFFL |
| 689 | #else |
| 690 | #error "could not set LONG_MAX in pyport.h" |
| 691 | #endif |
| 692 | #endif |
| 693 | |
| 694 | #ifndef LONG_MIN |
| 695 | #define LONG_MIN (-LONG_MAX-1) |
| 696 | #endif |
| 697 | |
Tim Peters | d57731f | 2000-10-05 01:42:25 +0000 | [diff] [blame] | 698 | #ifndef LONG_BIT |
| 699 | #define LONG_BIT (8 * SIZEOF_LONG) |
| 700 | #endif |
| 701 | |
| 702 | #if LONG_BIT != 8 * SIZEOF_LONG |
| 703 | /* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent |
| 704 | * 32-bit platforms using gcc. We try to catch that here at compile-time |
| 705 | * rather than waiting for integer multiplication to trigger bogus |
| 706 | * overflows. |
| 707 | */ |
Andrew M. Kuchling | 234fb63 | 2001-01-12 15:06:28 +0000 | [diff] [blame] | 708 | #error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)." |
Tim Peters | d57731f | 2000-10-05 01:42:25 +0000 | [diff] [blame] | 709 | #endif |
| 710 | |
Tim Peters | 7d3a511 | 2000-07-08 04:17:21 +0000 | [diff] [blame] | 711 | #ifdef __cplusplus |
| 712 | } |
| 713 | #endif |
| 714 | |
Neil Schemenauer | 1569108 | 2001-10-23 02:20:37 +0000 | [diff] [blame] | 715 | /* |
| 716 | * Hide GCC attributes from compilers that don't support them. |
| 717 | */ |
Guido van Rossum | bd67d6f | 2001-10-27 21:16:16 +0000 | [diff] [blame] | 718 | #if (!defined(__GNUC__) || __GNUC__ < 2 || \ |
Skip Montanaro | 7a98be2 | 2007-08-16 14:35:24 +0000 | [diff] [blame] | 719 | (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) |
Neil Schemenauer | 96aa0ac | 2002-09-15 14:09:54 +0000 | [diff] [blame] | 720 | #define Py_GCC_ATTRIBUTE(x) |
| 721 | #else |
| 722 | #define Py_GCC_ATTRIBUTE(x) __attribute__(x) |
Neil Schemenauer | 1569108 | 2001-10-23 02:20:37 +0000 | [diff] [blame] | 723 | #endif |
| 724 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 725 | /* |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 726 | * Specify alignment on compilers that support it. |
| 727 | */ |
| 728 | #if defined(__GNUC__) && __GNUC__ >= 3 |
| 729 | #define Py_ALIGNED(x) __attribute__((aligned(x))) |
| 730 | #else |
| 731 | #define Py_ALIGNED(x) |
| 732 | #endif |
| 733 | |
Nicholas Bastin | 9ba301e | 2004-07-15 15:54:05 +0000 | [diff] [blame] | 734 | /* Eliminate end-of-loop code not reached warnings from SunPro C |
| 735 | * when using do{...}while(0) macros |
| 736 | */ |
| 737 | #ifdef __SUNPRO_C |
| 738 | #pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED) |
| 739 | #endif |
| 740 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 741 | #ifndef Py_LL |
| 742 | #define Py_LL(x) x##LL |
| 743 | #endif |
| 744 | |
| 745 | #ifndef Py_ULL |
| 746 | #define Py_ULL(x) Py_LL(x##U) |
| 747 | #endif |
| 748 | |
Benjamin Peterson | 0c21214 | 2016-09-20 20:39:33 -0700 | [diff] [blame] | 749 | #define Py_VA_COPY va_copy |
Alexander Belopolsky | f0f4514 | 2010-08-11 17:31:17 +0000 | [diff] [blame] | 750 | |
Christian Heimes | 743e0cd | 2012-10-17 23:52:17 +0200 | [diff] [blame] | 751 | /* |
Georg Brandl | 3962d5e | 2012-10-28 08:48:28 +0100 | [diff] [blame] | 752 | * Convenient macros to deal with endianness of the platform. WORDS_BIGENDIAN is |
Christian Heimes | 743e0cd | 2012-10-17 23:52:17 +0200 | [diff] [blame] | 753 | * detected by configure and defined in pyconfig.h. The code in pyconfig.h |
Terry Jan Reedy | 8e7586b | 2013-03-11 18:38:13 -0400 | [diff] [blame] | 754 | * also takes care of Apple's universal builds. |
Christian Heimes | 743e0cd | 2012-10-17 23:52:17 +0200 | [diff] [blame] | 755 | */ |
| 756 | |
| 757 | #ifdef WORDS_BIGENDIAN |
| 758 | #define PY_BIG_ENDIAN 1 |
| 759 | #define PY_LITTLE_ENDIAN 0 |
| 760 | #else |
| 761 | #define PY_BIG_ENDIAN 0 |
| 762 | #define PY_LITTLE_ENDIAN 1 |
| 763 | #endif |
| 764 | |
Benjamin Peterson | 918aa89 | 2016-09-19 22:16:36 -0700 | [diff] [blame] | 765 | #ifdef Py_BUILD_CORE |
Steve Dower | 8fc8980 | 2015-04-12 00:26:27 -0400 | [diff] [blame] | 766 | /* |
| 767 | * Macros to protect CRT calls against instant termination when passed an |
| 768 | * invalid parameter (issue23524). |
| 769 | */ |
| 770 | #if defined _MSC_VER && _MSC_VER >= 1900 |
| 771 | |
| 772 | extern _invalid_parameter_handler _Py_silent_invalid_parameter_handler; |
| 773 | #define _Py_BEGIN_SUPPRESS_IPH { _invalid_parameter_handler _Py_old_handler = \ |
| 774 | _set_thread_local_invalid_parameter_handler(_Py_silent_invalid_parameter_handler); |
| 775 | #define _Py_END_SUPPRESS_IPH _set_thread_local_invalid_parameter_handler(_Py_old_handler); } |
| 776 | |
| 777 | #else |
| 778 | |
| 779 | #define _Py_BEGIN_SUPPRESS_IPH |
| 780 | #define _Py_END_SUPPRESS_IPH |
| 781 | |
| 782 | #endif /* _MSC_VER >= 1900 */ |
| 783 | #endif /* Py_BUILD_CORE */ |
| 784 | |
Stefan Krah | 1f9eb87 | 2016-05-22 17:35:34 +0200 | [diff] [blame] | 785 | #ifdef __ANDROID__ |
| 786 | #include <android/api-level.h> |
| 787 | #endif |
| 788 | |
Tim Peters | 7d3a511 | 2000-07-08 04:17:21 +0000 | [diff] [blame] | 789 | #endif /* Py_PYPORT_H */ |