1 #ifndef Py_PYPORT_H 2 #define Py_PYPORT_H 3 4 #include "pyconfig.h" /* include for defines */ 5 6 #include <inttypes.h> 7 8 9 /* Defines to build Python and its standard library: 10 * 11 * - Py_BUILD_CORE: Build Python core. Give access to Python internals, but 12 * should not be used by third-party modules. 13 * - Py_BUILD_CORE_BUILTIN: Build a Python stdlib module as a built-in module. 14 * - Py_BUILD_CORE_MODULE: Build a Python stdlib module as a dynamic library. 15 * 16 * Py_BUILD_CORE_BUILTIN and Py_BUILD_CORE_MODULE imply Py_BUILD_CORE. 17 * 18 * On Windows, Py_BUILD_CORE_MODULE exports "PyInit_xxx" symbol, whereas 19 * Py_BUILD_CORE_BUILTIN does not. 20 */ 21 #if defined(Py_BUILD_CORE_BUILTIN) && !defined(Py_BUILD_CORE) 22 # define Py_BUILD_CORE 23 #endif 24 #if defined(Py_BUILD_CORE_MODULE) && !defined(Py_BUILD_CORE) 25 # define Py_BUILD_CORE 26 #endif 27 28 29 /************************************************************************** 30 Symbols and macros to supply platform-independent interfaces to basic 31 C language & library operations whose spellings vary across platforms. 32 33 Please try to make documentation here as clear as possible: by definition, 34 the stuff here is trying to illuminate C's darkest corners. 35 36 Config #defines referenced here: 37 38 SIGNED_RIGHT_SHIFT_ZERO_FILLS 39 Meaning: To be defined iff i>>j does not extend the sign bit when i is a 40 signed integral type and i < 0. 41 Used in: Py_ARITHMETIC_RIGHT_SHIFT 42 43 Py_DEBUG 44 Meaning: Extra checks compiled in for debug mode. 45 Used in: Py_SAFE_DOWNCAST 46 47 **************************************************************************/ 48 49 /* typedefs for some C9X-defined synonyms for integral types. 50 * 51 * The names in Python are exactly the same as the C9X names, except with a 52 * Py_ prefix. Until C9X is universally implemented, this is the only way 53 * to ensure that Python gets reliable names that don't conflict with names 54 * in non-Python code that are playing their own tricks to define the C9X 55 * names. 56 * 57 * NOTE: don't go nuts here! Python has no use for *most* of the C9X 58 * integral synonyms. Only define the ones we actually need. 59 */ 60 61 /* long long is required. Ensure HAVE_LONG_LONG is defined for compatibility. */ 62 #ifndef HAVE_LONG_LONG 63 #define HAVE_LONG_LONG 1 64 #endif 65 #ifndef PY_LONG_LONG 66 #define PY_LONG_LONG long long 67 /* If LLONG_MAX is defined in limits.h, use that. */ 68 #define PY_LLONG_MIN LLONG_MIN 69 #define PY_LLONG_MAX LLONG_MAX 70 #define PY_ULLONG_MAX ULLONG_MAX 71 #endif 72 73 #define PY_UINT32_T uint32_t 74 #define PY_UINT64_T uint64_t 75 76 /* Signed variants of the above */ 77 #define PY_INT32_T int32_t 78 #define PY_INT64_T int64_t 79 80 /* If PYLONG_BITS_IN_DIGIT is not defined then we'll use 30-bit digits if all 81 the necessary integer types are available, and we're on a 64-bit platform 82 (as determined by SIZEOF_VOID_P); otherwise we use 15-bit digits. */ 83 84 #ifndef PYLONG_BITS_IN_DIGIT 85 #if SIZEOF_VOID_P >= 8 86 #define PYLONG_BITS_IN_DIGIT 30 87 #else 88 #define PYLONG_BITS_IN_DIGIT 15 89 #endif 90 #endif 91 92 /* uintptr_t is the C9X name for an unsigned integral type such that a 93 * legitimate void* can be cast to uintptr_t and then back to void* again 94 * without loss of information. Similarly for intptr_t, wrt a signed 95 * integral type. 96 */ 97 typedef uintptr_t Py_uintptr_t; 98 typedef intptr_t Py_intptr_t; 99 100 /* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) == 101 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an 102 * unsigned integral type). See PEP 353 for details. 103 */ 104 #ifdef HAVE_SSIZE_T 105 typedef ssize_t Py_ssize_t; 106 #elif SIZEOF_VOID_P == SIZEOF_SIZE_T 107 typedef Py_intptr_t Py_ssize_t; 108 #else 109 # error "Python needs a typedef for Py_ssize_t in pyport.h." 110 #endif 111 112 /* Py_hash_t is the same size as a pointer. */ 113 #define SIZEOF_PY_HASH_T SIZEOF_SIZE_T 114 typedef Py_ssize_t Py_hash_t; 115 /* Py_uhash_t is the unsigned equivalent needed to calculate numeric hash. */ 116 #define SIZEOF_PY_UHASH_T SIZEOF_SIZE_T 117 typedef size_t Py_uhash_t; 118 119 /* Only used for compatibility with code that may not be PY_SSIZE_T_CLEAN. */ 120 #ifdef PY_SSIZE_T_CLEAN 121 typedef Py_ssize_t Py_ssize_clean_t; 122 #else 123 typedef int Py_ssize_clean_t; 124 #endif 125 126 /* Largest possible value of size_t. */ 127 #define PY_SIZE_MAX SIZE_MAX 128 129 /* Largest positive value of type Py_ssize_t. */ 130 #define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1)) 131 /* Smallest negative value of type Py_ssize_t. */ 132 #define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1) 133 134 /* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf 135 * format to convert an argument with the width of a size_t or Py_ssize_t. 136 * C99 introduced "z" for this purpose, but old MSVCs had not supported it. 137 * Since MSVC supports "z" since (at least) 2015, we can just use "z" 138 * for new code. 139 * 140 * These "high level" Python format functions interpret "z" correctly on 141 * all platforms (Python interprets the format string itself, and does whatever 142 * the platform C requires to convert a size_t/Py_ssize_t argument): 143 * 144 * PyBytes_FromFormat 145 * PyErr_Format 146 * PyBytes_FromFormatV 147 * PyUnicode_FromFormatV 148 * 149 * Lower-level uses require that you interpolate the correct format modifier 150 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for 151 * example, 152 * 153 * Py_ssize_t index; 154 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index); 155 * 156 * That will expand to %zd or to something else correct for a Py_ssize_t on 157 * the platform. 158 */ 159 #ifndef PY_FORMAT_SIZE_T 160 # define PY_FORMAT_SIZE_T "z" 161 #endif 162 163 /* Py_LOCAL can be used instead of static to get the fastest possible calling 164 * convention for functions that are local to a given module. 165 * 166 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining, 167 * for platforms that support that. 168 * 169 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more 170 * "aggressive" inlining/optimization is enabled for the entire module. This 171 * may lead to code bloat, and may slow things down for those reasons. It may 172 * also lead to errors, if the code relies on pointer aliasing. Use with 173 * care. 174 * 175 * NOTE: You can only use this for functions that are entirely local to a 176 * module; functions that are exported via method tables, callbacks, etc, 177 * should keep using static. 178 */ 179 180 #if defined(_MSC_VER) 181 # if defined(PY_LOCAL_AGGRESSIVE) 182 /* enable more aggressive optimization for visual studio */ 183 # pragma optimize("agtw", on) 184 #endif 185 /* ignore warnings if the compiler decides not to inline a function */ 186 # pragma warning(disable: 4710) 187 /* fastest possible local call under MSVC */ 188 # define Py_LOCAL(type) static type __fastcall 189 # define Py_LOCAL_INLINE(type) static __inline type __fastcall 190 #else 191 # define Py_LOCAL(type) static type 192 # define Py_LOCAL_INLINE(type) static inline type 193 #endif 194 195 /* Py_MEMCPY is kept for backwards compatibility, 196 * see https://bugs.python.org/issue28126 */ 197 #define Py_MEMCPY memcpy 198 199 #include <stdlib.h> 200 201 #ifdef HAVE_IEEEFP_H 202 #include <ieeefp.h> /* needed for 'finite' declaration on some platforms */ 203 #endif 204 205 #include <math.h> /* Moved here from the math section, before extern "C" */ 206 207 /******************************************** 208 * WRAPPER FOR <time.h> and/or <sys/time.h> * 209 ********************************************/ 210 211 #ifdef TIME_WITH_SYS_TIME 212 #include <sys/time.h> 213 #include <time.h> 214 #else /* !TIME_WITH_SYS_TIME */ 215 #ifdef HAVE_SYS_TIME_H 216 #include <sys/time.h> 217 #else /* !HAVE_SYS_TIME_H */ 218 #include <time.h> 219 #endif /* !HAVE_SYS_TIME_H */ 220 #endif /* !TIME_WITH_SYS_TIME */ 221 222 223 /****************************** 224 * WRAPPER FOR <sys/select.h> * 225 ******************************/ 226 227 /* NB caller must include <sys/types.h> */ 228 229 #ifdef HAVE_SYS_SELECT_H 230 #include <sys/select.h> 231 #endif /* !HAVE_SYS_SELECT_H */ 232 233 /******************************* 234 * stat() and fstat() fiddling * 235 *******************************/ 236 237 #ifdef HAVE_SYS_STAT_H 238 #include <sys/stat.h> 239 #elif defined(HAVE_STAT_H) 240 #include <stat.h> 241 #endif 242 243 #ifndef S_IFMT 244 /* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */ 245 #define S_IFMT 0170000 246 #endif 247 248 #ifndef S_IFLNK 249 /* Windows doesn't define S_IFLNK but posixmodule.c maps 250 * IO_REPARSE_TAG_SYMLINK to S_IFLNK */ 251 # define S_IFLNK 0120000 252 #endif 253 254 #ifndef S_ISREG 255 #define S_ISREG(x) (((x) & S_IFMT) == S_IFREG) 256 #endif 257 258 #ifndef S_ISDIR 259 #define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR) 260 #endif 261 262 #ifndef S_ISCHR 263 #define S_ISCHR(x) (((x) & S_IFMT) == S_IFCHR) 264 #endif 265 266 #ifdef __cplusplus 267 /* Move this down here since some C++ #include's don't like to be included 268 inside an extern "C" */ 269 extern "C" { 270 #endif 271 272 273 /* Py_ARITHMETIC_RIGHT_SHIFT 274 * C doesn't define whether a right-shift of a signed integer sign-extends 275 * or zero-fills. Here a macro to force sign extension: 276 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) 277 * Return I >> J, forcing sign extension. Arithmetically, return the 278 * floor of I/2**J. 279 * Requirements: 280 * I should have signed integer type. In the terminology of C99, this can 281 * be either one of the five standard signed integer types (signed char, 282 * short, int, long, long long) or an extended signed integer type. 283 * J is an integer >= 0 and strictly less than the number of bits in the 284 * type of I (because C doesn't define what happens for J outside that 285 * range either). 286 * TYPE used to specify the type of I, but is now ignored. It's been left 287 * in for backwards compatibility with versions <= 2.6 or 3.0. 288 * Caution: 289 * I may be evaluated more than once. 290 */ 291 #ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS 292 #define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \ 293 ((I) < 0 ? -1-((-1-(I)) >> (J)) : (I) >> (J)) 294 #else 295 #define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J)) 296 #endif 297 298 /* Py_FORCE_EXPANSION(X) 299 * "Simply" returns its argument. However, macro expansions within the 300 * argument are evaluated. This unfortunate trickery is needed to get 301 * token-pasting to work as desired in some cases. 302 */ 303 #define Py_FORCE_EXPANSION(X) X 304 305 /* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) 306 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this 307 * assert-fails if any information is lost. 308 * Caution: 309 * VALUE may be evaluated more than once. 310 */ 311 #ifdef Py_DEBUG 312 #define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \ 313 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE)) 314 #else 315 #define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE) 316 #endif 317 318 /* Py_SET_ERRNO_ON_MATH_ERROR(x) 319 * If a libm function did not set errno, but it looks like the result 320 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno 321 * to 0 before calling a libm function, and invoke this macro after, 322 * passing the function result. 323 * Caution: 324 * This isn't reliable. See Py_OVERFLOWED comments. 325 * X is evaluated more than once. 326 */ 327 #if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64)) 328 #define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM; 329 #else 330 #define _Py_SET_EDOM_FOR_NAN(X) ; 331 #endif 332 #define Py_SET_ERRNO_ON_MATH_ERROR(X) \ 333 do { \ 334 if (errno == 0) { \ 335 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \ 336 errno = ERANGE; \ 337 else _Py_SET_EDOM_FOR_NAN(X) \ 338 } \ 339 } while(0) 340 341 /* Py_SET_ERANGE_IF_OVERFLOW(x) 342 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility. 343 */ 344 #define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X) 345 346 /* Py_ADJUST_ERANGE1(x) 347 * Py_ADJUST_ERANGE2(x, y) 348 * Set errno to 0 before calling a libm function, and invoke one of these 349 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful 350 * for functions returning complex results). This makes two kinds of 351 * adjustments to errno: (A) If it looks like the platform libm set 352 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the 353 * platform libm overflowed but didn't set errno, force errno to ERANGE. In 354 * effect, we're trying to force a useful implementation of C89 errno 355 * behavior. 356 * Caution: 357 * This isn't reliable. See Py_OVERFLOWED comments. 358 * X and Y may be evaluated more than once. 359 */ 360 #define Py_ADJUST_ERANGE1(X) \ 361 do { \ 362 if (errno == 0) { \ 363 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \ 364 errno = ERANGE; \ 365 } \ 366 else if (errno == ERANGE && (X) == 0.0) \ 367 errno = 0; \ 368 } while(0) 369 370 #define Py_ADJUST_ERANGE2(X, Y) \ 371 do { \ 372 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \ 373 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \ 374 if (errno == 0) \ 375 errno = ERANGE; \ 376 } \ 377 else if (errno == ERANGE) \ 378 errno = 0; \ 379 } while(0) 380 381 /* The functions _Py_dg_strtod and _Py_dg_dtoa in Python/dtoa.c (which are 382 * required to support the short float repr introduced in Python 3.1) require 383 * that the floating-point unit that's being used for arithmetic operations 384 * on C doubles is set to use 53-bit precision. It also requires that the 385 * FPU rounding mode is round-half-to-even, but that's less often an issue. 386 * 387 * If your FPU isn't already set to 53-bit precision/round-half-to-even, and 388 * you want to make use of _Py_dg_strtod and _Py_dg_dtoa, then you should 389 * 390 * #define HAVE_PY_SET_53BIT_PRECISION 1 391 * 392 * and also give appropriate definitions for the following three macros: 393 * 394 * _PY_SET_53BIT_PRECISION_START : store original FPU settings, and 395 * set FPU to 53-bit precision/round-half-to-even 396 * _PY_SET_53BIT_PRECISION_END : restore original FPU settings 397 * _PY_SET_53BIT_PRECISION_HEADER : any variable declarations needed to 398 * use the two macros above. 399 * 400 * The macros are designed to be used within a single C function: see 401 * Python/pystrtod.c for an example of their use. 402 */ 403 404 /* get and set x87 control word for gcc/x86 */ 405 #ifdef HAVE_GCC_ASM_FOR_X87 406 #define HAVE_PY_SET_53BIT_PRECISION 1 407 /* _Py_get/set_387controlword functions are defined in Python/pymath.c */ 408 #define _Py_SET_53BIT_PRECISION_HEADER \ 409 unsigned short old_387controlword, new_387controlword 410 #define _Py_SET_53BIT_PRECISION_START \ 411 do { \ 412 old_387controlword = _Py_get_387controlword(); \ 413 new_387controlword = (old_387controlword & ~0x0f00) | 0x0200; \ 414 if (new_387controlword != old_387controlword) \ 415 _Py_set_387controlword(new_387controlword); \ 416 } while (0) 417 #define _Py_SET_53BIT_PRECISION_END \ 418 if (new_387controlword != old_387controlword) \ 419 _Py_set_387controlword(old_387controlword) 420 #endif 421 422 /* get and set x87 control word for VisualStudio/x86 */ 423 #if defined(_MSC_VER) && !defined(_WIN64) && !defined(_M_ARM) /* x87 not supported in 64-bit or ARM */ 424 #define HAVE_PY_SET_53BIT_PRECISION 1 425 #define _Py_SET_53BIT_PRECISION_HEADER \ 426 unsigned int old_387controlword, new_387controlword, out_387controlword 427 /* We use the __control87_2 function to set only the x87 control word. 428 The SSE control word is unaffected. */ 429 #define _Py_SET_53BIT_PRECISION_START \ 430 do { \ 431 __control87_2(0, 0, &old_387controlword, NULL); \ 432 new_387controlword = \ 433 (old_387controlword & ~(_MCW_PC | _MCW_RC)) | (_PC_53 | _RC_NEAR); \ 434 if (new_387controlword != old_387controlword) \ 435 __control87_2(new_387controlword, _MCW_PC | _MCW_RC, \ 436 &out_387controlword, NULL); \ 437 } while (0) 438 #define _Py_SET_53BIT_PRECISION_END \ 439 do { \ 440 if (new_387controlword != old_387controlword) \ 441 __control87_2(old_387controlword, _MCW_PC | _MCW_RC, \ 442 &out_387controlword, NULL); \ 443 } while (0) 444 #endif 445 446 #ifdef HAVE_GCC_ASM_FOR_MC68881 447 #define HAVE_PY_SET_53BIT_PRECISION 1 448 #define _Py_SET_53BIT_PRECISION_HEADER \ 449 unsigned int old_fpcr, new_fpcr 450 #define _Py_SET_53BIT_PRECISION_START \ 451 do { \ 452 __asm__ ("fmove.l %%fpcr,%0" : "=g" (old_fpcr)); \ 453 /* Set double precision / round to nearest. */ \ 454 new_fpcr = (old_fpcr & ~0xf0) | 0x80; \ 455 if (new_fpcr != old_fpcr) \ 456 __asm__ volatile ("fmove.l %0,%%fpcr" : : "g" (new_fpcr)); \ 457 } while (0) 458 #define _Py_SET_53BIT_PRECISION_END \ 459 do { \ 460 if (new_fpcr != old_fpcr) \ 461 __asm__ volatile ("fmove.l %0,%%fpcr" : : "g" (old_fpcr)); \ 462 } while (0) 463 #endif 464 465 /* default definitions are empty */ 466 #ifndef HAVE_PY_SET_53BIT_PRECISION 467 #define _Py_SET_53BIT_PRECISION_HEADER 468 #define _Py_SET_53BIT_PRECISION_START 469 #define _Py_SET_53BIT_PRECISION_END 470 #endif 471 472 /* If we can't guarantee 53-bit precision, don't use the code 473 in Python/dtoa.c, but fall back to standard code. This 474 means that repr of a float will be long (17 sig digits). 475 476 Realistically, there are two things that could go wrong: 477 478 (1) doubles aren't IEEE 754 doubles, or 479 (2) we're on x86 with the rounding precision set to 64-bits 480 (extended precision), and we don't know how to change 481 the rounding precision. 482 */ 483 484 #if !defined(DOUBLE_IS_LITTLE_ENDIAN_IEEE754) && \ 485 !defined(DOUBLE_IS_BIG_ENDIAN_IEEE754) && \ 486 !defined(DOUBLE_IS_ARM_MIXED_ENDIAN_IEEE754) 487 #define PY_NO_SHORT_FLOAT_REPR 488 #endif 489 490 /* double rounding is symptomatic of use of extended precision on x86. If 491 we're seeing double rounding, and we don't have any mechanism available for 492 changing the FPU rounding precision, then don't use Python/dtoa.c. */ 493 #if defined(X87_DOUBLE_ROUNDING) && !defined(HAVE_PY_SET_53BIT_PRECISION) 494 #define PY_NO_SHORT_FLOAT_REPR 495 #endif 496 497 498 /* Py_DEPRECATED(version) 499 * Declare a variable, type, or function deprecated. 500 * The macro must be placed before the declaration. 501 * Usage: 502 * Py_DEPRECATED(3.3) extern int old_var; 503 * Py_DEPRECATED(3.4) typedef int T1; 504 * Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void); 505 */ 506 #if defined(__GNUC__) \ 507 && ((__GNUC__ >= 4) || (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1)) 508 #define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__)) 509 #elif defined(_MSC_VER) 510 #define Py_DEPRECATED(VERSION) __declspec(deprecated( \ 511 "deprecated in " #VERSION)) 512 #else 513 #define Py_DEPRECATED(VERSION_UNUSED) 514 #endif 515 516 #if defined(__clang__) 517 #define _Py_COMP_DIAG_PUSH _Pragma("clang diagnostic push") 518 #define _Py_COMP_DIAG_IGNORE_DEPR_DECLS \ 519 _Pragma("clang diagnostic ignored \"-Wdeprecated-declarations\"") 520 #define _Py_COMP_DIAG_POP _Pragma("clang diagnostic pop") 521 #elif defined(__GNUC__) \ 522 && ((__GNUC__ >= 5) || (__GNUC__ == 4) && (__GNUC_MINOR__ >= 6)) 523 #define _Py_COMP_DIAG_PUSH _Pragma("GCC diagnostic push") 524 #define _Py_COMP_DIAG_IGNORE_DEPR_DECLS \ 525 _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") 526 #define _Py_COMP_DIAG_POP _Pragma("GCC diagnostic pop") 527 #elif defined(_MSC_VER) 528 #define _Py_COMP_DIAG_PUSH __pragma(warning(push)) 529 #define _Py_COMP_DIAG_IGNORE_DEPR_DECLS __pragma(warning(disable: 4996)) 530 #define _Py_COMP_DIAG_POP __pragma(warning(pop)) 531 #else 532 #define _Py_COMP_DIAG_PUSH 533 #define _Py_COMP_DIAG_IGNORE_DEPR_DECLS 534 #define _Py_COMP_DIAG_POP 535 #endif 536 537 /* _Py_HOT_FUNCTION 538 * The hot attribute on a function is used to inform the compiler that the 539 * function is a hot spot of the compiled program. The function is optimized 540 * more aggressively and on many target it is placed into special subsection of 541 * the text section so all hot functions appears close together improving 542 * locality. 543 * 544 * Usage: 545 * int _Py_HOT_FUNCTION x(void) { return 3; } 546 * 547 * Issue #28618: This attribute must not be abused, otherwise it can have a 548 * negative effect on performance. Only the functions were Python spend most of 549 * its time must use it. Use a profiler when running performance benchmark 550 * suite to find these functions. 551 */ 552 #if defined(__GNUC__) \ 553 && ((__GNUC__ >= 5) || (__GNUC__ == 4) && (__GNUC_MINOR__ >= 3)) 554 #define _Py_HOT_FUNCTION __attribute__((hot)) 555 #else 556 #define _Py_HOT_FUNCTION 557 #endif 558 559 /* _Py_NO_INLINE 560 * Disable inlining on a function. For example, it helps to reduce the C stack 561 * consumption. 562 * 563 * Usage: 564 * int _Py_NO_INLINE x(void) { return 3; } 565 */ 566 #if defined(_MSC_VER) 567 # define _Py_NO_INLINE __declspec(noinline) 568 #elif defined(__GNUC__) || defined(__clang__) 569 # define _Py_NO_INLINE __attribute__ ((noinline)) 570 #else 571 # define _Py_NO_INLINE 572 #endif 573 574 /************************************************************************** 575 Prototypes that are missing from the standard include files on some systems 576 (and possibly only some versions of such systems.) 577 578 Please be conservative with adding new ones, document them and enclose them 579 in platform-specific #ifdefs. 580 **************************************************************************/ 581 582 #ifdef SOLARIS 583 /* Unchecked */ 584 extern int gethostname(char *, int); 585 #endif 586 587 #ifdef HAVE__GETPTY 588 #include <sys/types.h> /* we need to import mode_t */ 589 extern char * _getpty(int *, int, mode_t, int); 590 #endif 591 592 /* On QNX 6, struct termio must be declared by including sys/termio.h 593 if TCGETA, TCSETA, TCSETAW, or TCSETAF are used. sys/termio.h must 594 be included before termios.h or it will generate an error. */ 595 #if defined(HAVE_SYS_TERMIO_H) && !defined(__hpux) 596 #include <sys/termio.h> 597 #endif 598 599 600 /* On 4.4BSD-descendants, ctype functions serves the whole range of 601 * wchar_t character set rather than single byte code points only. 602 * This characteristic can break some operations of string object 603 * including str.upper() and str.split() on UTF-8 locales. This 604 * workaround was provided by Tim Robbins of FreeBSD project. 605 */ 606 607 #if defined(__APPLE__) 608 # define _PY_PORT_CTYPE_UTF8_ISSUE 609 #endif 610 611 #ifdef _PY_PORT_CTYPE_UTF8_ISSUE 612 #ifndef __cplusplus 613 /* The workaround below is unsafe in C++ because 614 * the <locale> defines these symbols as real functions, 615 * with a slightly different signature. 616 * See issue #10910 617 */ 618 #include <ctype.h> 619 #include <wctype.h> 620 #undef isalnum 621 #define isalnum(c) iswalnum(btowc(c)) 622 #undef isalpha 623 #define isalpha(c) iswalpha(btowc(c)) 624 #undef islower 625 #define islower(c) iswlower(btowc(c)) 626 #undef isspace 627 #define isspace(c) iswspace(btowc(c)) 628 #undef isupper 629 #define isupper(c) iswupper(btowc(c)) 630 #undef tolower 631 #define tolower(c) towlower(btowc(c)) 632 #undef toupper 633 #define toupper(c) towupper(btowc(c)) 634 #endif 635 #endif 636 637 638 /* Declarations for symbol visibility. 639 640 PyAPI_FUNC(type): Declares a public Python API function and return type 641 PyAPI_DATA(type): Declares public Python data and its type 642 PyMODINIT_FUNC: A Python module init function. If these functions are 643 inside the Python core, they are private to the core. 644 If in an extension module, it may be declared with 645 external linkage depending on the platform. 646 647 As a number of platforms support/require "__declspec(dllimport/dllexport)", 648 we support a HAVE_DECLSPEC_DLL macro to save duplication. 649 */ 650 651 /* 652 All windows ports, except cygwin, are handled in PC/pyconfig.h. 653 654 Cygwin is the only other autoconf platform requiring special 655 linkage handling and it uses __declspec(). 656 */ 657 #if defined(__CYGWIN__) 658 # define HAVE_DECLSPEC_DLL 659 #endif 660 661 #include "exports.h" 662 663 /* only get special linkage if built as shared or platform is Cygwin */ 664 #if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__) 665 # if defined(HAVE_DECLSPEC_DLL) 666 # if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE) 667 # define PyAPI_FUNC(RTYPE) Py_EXPORTED_SYMBOL RTYPE 668 # define PyAPI_DATA(RTYPE) extern Py_EXPORTED_SYMBOL RTYPE 669 /* module init functions inside the core need no external linkage */ 670 /* except for Cygwin to handle embedding */ 671 # if defined(__CYGWIN__) 672 # define PyMODINIT_FUNC Py_EXPORTED_SYMBOL PyObject* 673 # else /* __CYGWIN__ */ 674 # define PyMODINIT_FUNC PyObject* 675 # endif /* __CYGWIN__ */ 676 # else /* Py_BUILD_CORE */ 677 /* Building an extension module, or an embedded situation */ 678 /* public Python functions and data are imported */ 679 /* Under Cygwin, auto-import functions to prevent compilation */ 680 /* failures similar to those described at the bottom of 4.1: */ 681 /* http://docs.python.org/extending/windows.html#a-cookbook-approach */ 682 # if !defined(__CYGWIN__) 683 # define PyAPI_FUNC(RTYPE) Py_IMPORTED_SYMBOL RTYPE 684 # endif /* !__CYGWIN__ */ 685 # define PyAPI_DATA(RTYPE) extern Py_IMPORTED_SYMBOL RTYPE 686 /* module init functions outside the core must be exported */ 687 # if defined(__cplusplus) 688 # define PyMODINIT_FUNC extern "C" Py_EXPORTED_SYMBOL PyObject* 689 # else /* __cplusplus */ 690 # define PyMODINIT_FUNC Py_EXPORTED_SYMBOL PyObject* 691 # endif /* __cplusplus */ 692 # endif /* Py_BUILD_CORE */ 693 # endif /* HAVE_DECLSPEC_DLL */ 694 #endif /* Py_ENABLE_SHARED */ 695 696 /* If no external linkage macros defined by now, create defaults */ 697 #ifndef PyAPI_FUNC 698 # define PyAPI_FUNC(RTYPE) Py_EXPORTED_SYMBOL RTYPE 699 #endif 700 #ifndef PyAPI_DATA 701 # define PyAPI_DATA(RTYPE) extern Py_EXPORTED_SYMBOL RTYPE 702 #endif 703 #ifndef PyMODINIT_FUNC 704 # if defined(__cplusplus) 705 # define PyMODINIT_FUNC extern "C" Py_EXPORTED_SYMBOL PyObject* 706 # else /* __cplusplus */ 707 # define PyMODINIT_FUNC Py_EXPORTED_SYMBOL PyObject* 708 # endif /* __cplusplus */ 709 #endif 710 711 /* limits.h constants that may be missing */ 712 713 #ifndef INT_MAX 714 #define INT_MAX 2147483647 715 #endif 716 717 #ifndef LONG_MAX 718 #if SIZEOF_LONG == 4 719 #define LONG_MAX 0X7FFFFFFFL 720 #elif SIZEOF_LONG == 8 721 #define LONG_MAX 0X7FFFFFFFFFFFFFFFL 722 #else 723 #error "could not set LONG_MAX in pyport.h" 724 #endif 725 #endif 726 727 #ifndef LONG_MIN 728 #define LONG_MIN (-LONG_MAX-1) 729 #endif 730 731 #ifndef LONG_BIT 732 #define LONG_BIT (8 * SIZEOF_LONG) 733 #endif 734 735 #if LONG_BIT != 8 * SIZEOF_LONG 736 /* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent 737 * 32-bit platforms using gcc. We try to catch that here at compile-time 738 * rather than waiting for integer multiplication to trigger bogus 739 * overflows. 740 */ 741 #error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)." 742 #endif 743 744 #ifdef __cplusplus 745 } 746 #endif 747 748 /* 749 * Hide GCC attributes from compilers that don't support them. 750 */ 751 #if (!defined(__GNUC__) || __GNUC__ < 2 || \ 752 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) 753 #define Py_GCC_ATTRIBUTE(x) 754 #else 755 #define Py_GCC_ATTRIBUTE(x) __attribute__(x) 756 #endif 757 758 /* 759 * Specify alignment on compilers that support it. 760 */ 761 #if defined(__GNUC__) && __GNUC__ >= 3 762 #define Py_ALIGNED(x) __attribute__((aligned(x))) 763 #else 764 #define Py_ALIGNED(x) 765 #endif 766 767 /* Eliminate end-of-loop code not reached warnings from SunPro C 768 * when using do{...}while(0) macros 769 */ 770 #ifdef __SUNPRO_C 771 #pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED) 772 #endif 773 774 #ifndef Py_LL 775 #define Py_LL(x) x##LL 776 #endif 777 778 #ifndef Py_ULL 779 #define Py_ULL(x) Py_LL(x##U) 780 #endif 781 782 #define Py_VA_COPY va_copy 783 784 /* 785 * Convenient macros to deal with endianness of the platform. WORDS_BIGENDIAN is 786 * detected by configure and defined in pyconfig.h. The code in pyconfig.h 787 * also takes care of Apple's universal builds. 788 */ 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 798 #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 805 extern _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 818 #ifdef __ANDROID__ 819 /* The Android langinfo.h header is not used. */ 820 # undef HAVE_LANGINFO_H 821 # undef CODESET 822 #endif 823 824 /* Maximum value of the Windows DWORD type */ 825 #define PY_DWORD_MAX 4294967295U 826 827 /* This macro used to tell whether Python was built with multithreading 828 * enabled. Now multithreading is always enabled, but keep the macro 829 * for compatibility. 830 */ 831 #ifndef WITH_THREAD 832 # define WITH_THREAD 833 #endif 834 835 /* Check that ALT_SOABI is consistent with Py_TRACE_REFS: 836 ./configure --with-trace-refs should must be used to define Py_TRACE_REFS */ 837 #if defined(ALT_SOABI) && defined(Py_TRACE_REFS) 838 # error "Py_TRACE_REFS ABI is not compatible with release and debug ABI" 839 #endif 840 841 #if defined(__ANDROID__) || defined(__VXWORKS__) 842 /* Ignore the locale encoding: force UTF-8 */ 843 # define _Py_FORCE_UTF8_LOCALE 844 #endif 845 846 #if defined(_Py_FORCE_UTF8_LOCALE) || defined(__APPLE__) 847 /* Use UTF-8 as filesystem encoding */ 848 # define _Py_FORCE_UTF8_FS_ENCODING 849 #endif 850 851 /* Mark a function which cannot return. Example: 852 PyAPI_FUNC(void) _Py_NO_RETURN PyThread_exit_thread(void); 853 854 XLC support is intentionally omitted due to bpo-40244 */ 855 #if defined(__clang__) || \ 856 (defined(__GNUC__) && \ 857 ((__GNUC__ >= 3) || \ 858 (__GNUC__ == 2) && (__GNUC_MINOR__ >= 5))) 859 # define _Py_NO_RETURN __attribute__((__noreturn__)) 860 #elif defined(_MSC_VER) 861 # define _Py_NO_RETURN __declspec(noreturn) 862 #else 863 # define _Py_NO_RETURN 864 #endif 865 866 867 // Preprocessor check for a builtin preprocessor function. Always return 0 868 // if __has_builtin() macro is not defined. 869 // 870 // __has_builtin() is available on clang and GCC 10. 871 #ifdef __has_builtin 872 # define _Py__has_builtin(x) __has_builtin(x) 873 #else 874 # define _Py__has_builtin(x) 0 875 #endif 876 877 878 #endif /* Py_PYPORT_H */ 879