Include/pyport.h

   1 #ifndef Py_PYPORT_H
   2 #define Py_PYPORT_H
   3
   4 #include "pyconfig.h" /* include for defines */
   5
   6 /* Some versions of HP-UX & Solaris need inttypes.h for int32_t,
   7    INT32_MAX, etc. */
   8 #ifdef HAVE_INTTYPES_H
   9 #include <inttypes.h>
  10 #endif
  11
  12 #ifdef HAVE_STDINT_H
  13 #include <stdint.h>
  14 #endif
  15
  16 /**************************************************************************
  17 Symbols and macros to supply platform-independent interfaces to basic
  18 C language & library operations whose spellings vary across platforms.
  19
  20 Please try to make documentation here as clear as possible:  by definition,
  21 the stuff here is trying to illuminate C's darkest corners.
  22
  23 Config #defines referenced here:
  24
  25 SIGNED_RIGHT_SHIFT_ZERO_FILLS
  26 Meaning:  To be defined iff i>>j does not extend the sign bit when i is a
  27           signed integral type and i < 0.
  28 Used in:  Py_ARITHMETIC_RIGHT_SHIFT
  29
  30 Py_DEBUG
  31 Meaning:  Extra checks compiled in for debug mode.
  32 Used in:  Py_SAFE_DOWNCAST
  33
  34 HAVE_UINTPTR_T
  35 Meaning:  The C9X type uintptr_t is supported by the compiler
  36 Used in:  Py_uintptr_t
  37
  38 HAVE_LONG_LONG
  39 Meaning:  The compiler supports the C type "long long"
  40 Used in:  PY_LONG_LONG
  41
  42 **************************************************************************/
  43
  44
  45 /* For backward compatibility only. Obsolete, do not use. */
  46 #ifdef HAVE_PROTOTYPES
  47 #define Py_PROTO(x) x
  48 #else
  49 #define Py_PROTO(x) ()
  50 #endif
  51 #ifndef Py_FPROTO
  52 #define Py_FPROTO(x) Py_PROTO(x)
  53 #endif
  54
  55 /* typedefs for some C9X-defined synonyms for integral types.
  56  *
  57  * The names in Python are exactly the same as the C9X names, except with a
  58  * Py_ prefix.  Until C9X is universally implemented, this is the only way
  59  * to ensure that Python gets reliable names that don't conflict with names
  60  * in non-Python code that are playing their own tricks to define the C9X
  61  * names.
  62  *
  63  * NOTE: don't go nuts here!  Python has no use for *most* of the C9X
  64  * integral synonyms.  Only define the ones we actually need.
  65  */
  66
  67 #ifdef HAVE_LONG_LONG
  68 #ifndef PY_LONG_LONG
  69 #define PY_LONG_LONG long long
  70 #if defined(LLONG_MAX)
  71 /* If LLONG_MAX is defined in limits.h, use that. */
  72 #define PY_LLONG_MIN LLONG_MIN
  73 #define PY_LLONG_MAX LLONG_MAX
  74 #define PY_ULLONG_MAX ULLONG_MAX
  75 #elif defined(__LONG_LONG_MAX__)
  76 /* Otherwise, if GCC has a builtin define, use that. */
  77 #define PY_LLONG_MAX __LONG_LONG_MAX__
  78 #define PY_LLONG_MIN (-PY_LLONG_MAX-1)
  79 #define PY_ULLONG_MAX (__LONG_LONG_MAX__*2ULL + 1ULL)
  80 #else
  81 /* Otherwise, rely on two's complement. */
  82 #define PY_ULLONG_MAX (~0ULL)
  83 #define PY_LLONG_MAX  ((long long)(PY_ULLONG_MAX>>1))
  84 #define PY_LLONG_MIN (-PY_LLONG_MAX-1)
  85 #endif /* LLONG_MAX */
  86 #endif
  87 #endif /* HAVE_LONG_LONG */
  88
  89 /* a build with 30-bit digits for Python long integers needs an exact-width
  90  * 32-bit unsigned integer type to store those digits.  (We could just use
  91  * type 'unsigned long', but that would be wasteful on a system where longs
  92  * are 64-bits.)  On Unix systems, the autoconf macro AC_TYPE_UINT32_T defines
  93  * uint32_t to be such a type unless stdint.h or inttypes.h defines uint32_t.
  94  * However, it doesn't set HAVE_UINT32_T, so we do that here.
  95  */
  96 #if (defined UINT32_MAX || defined uint32_t)
  97 #ifndef PY_UINT32_T
  98 #define HAVE_UINT32_T 1
  99 #define PY_UINT32_T uint32_t
 100 #endif
 101 #endif
 102
 103 /* Macros for a 64-bit unsigned integer type; used for type 'twodigits' in the
 104  * long integer implementation, when 30-bit digits are enabled.
 105  */
 106 #if (defined UINT64_MAX || defined uint64_t)
 107 #ifndef PY_UINT64_T
 108 #define HAVE_UINT64_T 1
 109 #define PY_UINT64_T uint64_t
 110 #endif
 111 #endif
 112
 113 /* Signed variants of the above */
 114 #if (defined INT32_MAX || defined int32_t)
 115 #ifndef PY_INT32_T
 116 #define HAVE_INT32_T 1
 117 #define PY_INT32_T int32_t
 118 #endif
 119 #endif
 120 #if (defined INT64_MAX || defined int64_t)
 121 #ifndef PY_INT64_T
 122 #define HAVE_INT64_T 1
 123 #define PY_INT64_T int64_t
 124 #endif
 125 #endif
 126
 127 /* If PYLONG_BITS_IN_DIGIT is not defined then we'll use 30-bit digits if all
 128    the necessary integer types are available, and we're on a 64-bit platform
 129    (as determined by SIZEOF_VOID_P); otherwise we use 15-bit digits. */
 130
 131 #ifndef PYLONG_BITS_IN_DIGIT
 132 #if (defined HAVE_UINT64_T && defined HAVE_INT64_T && \
 133      defined HAVE_UINT32_T && defined HAVE_INT32_T && SIZEOF_VOID_P >= 8)
 134 #define PYLONG_BITS_IN_DIGIT 30
 135 #else
 136 #define PYLONG_BITS_IN_DIGIT 15
 137 #endif
 138 #endif
 139
 140 /* uintptr_t is the C9X name for an unsigned integral type such that a
 141  * legitimate void* can be cast to uintptr_t and then back to void* again
 142  * without loss of information.  Similarly for intptr_t, wrt a signed
 143  * integral type.
 144  */
 145 #ifdef HAVE_UINTPTR_T
 146 typedef uintptr_t       Py_uintptr_t;
 147 typedef intptr_t        Py_intptr_t;
 148
 149 #elif SIZEOF_VOID_P <= SIZEOF_INT
 150 typedef unsigned int    Py_uintptr_t;
 151 typedef int             Py_intptr_t;
 152
 153 #elif SIZEOF_VOID_P <= SIZEOF_LONG
 154 typedef unsigned long   Py_uintptr_t;
 155 typedef long            Py_intptr_t;
 156
 157 #elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
 158 typedef unsigned PY_LONG_LONG   Py_uintptr_t;
 159 typedef PY_LONG_LONG            Py_intptr_t;
 160
 161 #else
 162 #   error "Python needs a typedef for Py_uintptr_t in pyport.h."
 163 #endif /* HAVE_UINTPTR_T */
 164
 165 /* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
 166  * sizeof(size_t).  C99 doesn't define such a thing directly (size_t is an
 167  * unsigned integral type).  See PEP 353 for details.
 168  */
 169 #ifdef HAVE_SSIZE_T
 170 typedef ssize_t         Py_ssize_t;
 171 #elif SIZEOF_VOID_P == SIZEOF_SIZE_T
 172 typedef Py_intptr_t     Py_ssize_t;
 173 #else
 174 #   error "Python needs a typedef for Py_ssize_t in pyport.h."
 175 #endif
 176
 177 /* Largest possible value of size_t.
 178    SIZE_MAX is part of C99, so it might be defined on some
 179    platforms. If it is not defined, (size_t)-1 is a portable
 180    definition for C89, due to the way signed->unsigned
 181    conversion is defined. */
 182 #ifdef SIZE_MAX
 183 #define PY_SIZE_MAX SIZE_MAX
 184 #else
 185 #define PY_SIZE_MAX ((size_t)-1)
 186 #endif
 187
 188 /* Largest positive value of type Py_ssize_t. */
 189 #define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
 190 /* Smallest negative value of type Py_ssize_t. */
 191 #define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
 192
 193 #if SIZEOF_PID_T > SIZEOF_LONG
 194 #   error "Python doesn't support sizeof(pid_t) > sizeof(long)"
 195 #endif
 196
 197 /* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
 198  * format to convert an argument with the width of a size_t or Py_ssize_t.
 199  * C99 introduced "z" for this purpose, but not all platforms support that;
 200  * e.g., MS compilers use "I" instead.
 201  *
 202  * These "high level" Python format functions interpret "z" correctly on
 203  * all platforms (Python interprets the format string itself, and does whatever
 204  * the platform C requires to convert a size_t/Py_ssize_t argument):
 205  *
 206  *     PyString_FromFormat
 207  *     PyErr_Format
 208  *     PyString_FromFormatV
 209  *
 210  * Lower-level uses require that you interpolate the correct format modifier
 211  * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
 212  * example,
 213  *
 214  *     Py_ssize_t index;
 215  *     fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
 216  *
 217  * That will expand to %ld, or %Id, or to something else correct for a
 218  * Py_ssize_t on the platform.
 219  */
 220 #ifndef PY_FORMAT_SIZE_T
 221 #   if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
 222 #       define PY_FORMAT_SIZE_T ""
 223 #   elif SIZEOF_SIZE_T == SIZEOF_LONG
 224 #       define PY_FORMAT_SIZE_T "l"
 225 #   elif defined(MS_WINDOWS)
 226 #       define PY_FORMAT_SIZE_T "I"
 227 #   else
 228 #       error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
 229 #   endif
 230 #endif
 231
 232 /* PY_FORMAT_LONG_LONG is analogous to PY_FORMAT_SIZE_T above, but for
 233  * the long long type instead of the size_t type.  It's only available
 234  * when HAVE_LONG_LONG is defined. The "high level" Python format
 235  * functions listed above will interpret "lld" or "llu" correctly on
 236  * all platforms.
 237  */
 238 #ifdef HAVE_LONG_LONG
 239 #   ifndef PY_FORMAT_LONG_LONG
 240 #       if defined(MS_WIN64) || defined(MS_WINDOWS)
 241 #           define PY_FORMAT_LONG_LONG "I64"
 242 #       else
 243 #           error "This platform's pyconfig.h needs to define PY_FORMAT_LONG_LONG"
 244 #       endif
 245 #   endif
 246 #endif
 247
 248 /* Py_LOCAL can be used instead of static to get the fastest possible calling
 249  * convention for functions that are local to a given module.
 250  *
 251  * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
 252  * for platforms that support that.
 253  *
 254  * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
 255  * "aggressive" inlining/optimizaion is enabled for the entire module.  This
 256  * may lead to code bloat, and may slow things down for those reasons.  It may
 257  * also lead to errors, if the code relies on pointer aliasing.  Use with
 258  * care.
 259  *
 260  * NOTE: You can only use this for functions that are entirely local to a
 261  * module; functions that are exported via method tables, callbacks, etc,
 262  * should keep using static.
 263  */
 264
 265 #undef USE_INLINE /* XXX - set via configure? */
 266
 267 #if defined(_MSC_VER)
 268 #if defined(PY_LOCAL_AGGRESSIVE)
 269 /* enable more aggressive optimization for visual studio */
 270 #pragma optimize("agtw", on)
 271 #endif
 272 /* ignore warnings if the compiler decides not to inline a function */
 273 #pragma warning(disable: 4710)
 274 /* fastest possible local call under MSVC */
 275 #define Py_LOCAL(type) static type __fastcall
 276 #define Py_LOCAL_INLINE(type) static __inline type __fastcall
 277 #elif defined(USE_INLINE)
 278 #define Py_LOCAL(type) static type
 279 #define Py_LOCAL_INLINE(type) static inline type
 280 #else
 281 #define Py_LOCAL(type) static type
 282 #define Py_LOCAL_INLINE(type) static type
 283 #endif
 284
 285 /* Py_MEMCPY can be used instead of memcpy in cases where the copied blocks
 286  * are often very short.  While most platforms have highly optimized code for
 287  * large transfers, the setup costs for memcpy are often quite high.  MEMCPY
 288  * solves this by doing short copies "in line".
 289  */
 290
 291 #if defined(_MSC_VER)
 292 #define Py_MEMCPY(target, source, length) do {                          \
 293                 size_t i_, n_ = (length);                               \
 294                 char *t_ = (void*) (target);                            \
 295                 const char *s_ = (void*) (source);                      \
 296                 if (n_ >= 16)                                           \
 297                         memcpy(t_, s_, n_);                             \
 298                 else                                                    \
 299                         for (i_ = 0; i_ < n_; i_++)                     \
 300                                 t_[i_] = s_[i_];                        \
 301         } while (0)
 302 #else
 303 #define Py_MEMCPY memcpy
 304 #endif
 305
 306 #include <stdlib.h>
 307
 308 #include <math.h> /* Moved here from the math section, before extern "C" */
 309
 310 /********************************************
 311  * WRAPPER FOR <time.h> and/or <sys/time.h> *
 312  ********************************************/
 313
 314 #ifdef TIME_WITH_SYS_TIME
 315 #include <sys/time.h>
 316 #include <time.h>
 317 #else /* !TIME_WITH_SYS_TIME */
 318 #ifdef HAVE_SYS_TIME_H
 319 #include <sys/time.h>
 320 #else /* !HAVE_SYS_TIME_H */
 321 #include <time.h>
 322 #endif /* !HAVE_SYS_TIME_H */
 323 #endif /* !TIME_WITH_SYS_TIME */
 324
 325
 326 /******************************
 327  * WRAPPER FOR <sys/select.h> *
 328  ******************************/
 329
 330 /* NB caller must include <sys/types.h> */
 331
 332 #ifdef HAVE_SYS_SELECT_H
 333
 334 #include <sys/select.h>
 335
 336 #endif /* !HAVE_SYS_SELECT_H */
 337
 338 /*******************************
 339  * stat() and fstat() fiddling *
 340  *******************************/
 341
 342 /* We expect that stat and fstat exist on most systems.
 343  *  It's confirmed on Unix, Mac and Windows.
 344  *  If you don't have them, add
 345  *      #define DONT_HAVE_STAT
 346  * and/or
 347  *      #define DONT_HAVE_FSTAT
 348  * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
 349  * HAVE_FSTAT instead.
 350  * Also
 351  *      #define HAVE_SYS_STAT_H
 352  * if <sys/stat.h> exists on your platform, and
 353  *      #define HAVE_STAT_H
 354  * if <stat.h> does.
 355  */
 356 #ifndef DONT_HAVE_STAT
 357 #define HAVE_STAT
 358 #endif
 359
 360 #ifndef DONT_HAVE_FSTAT
 361 #define HAVE_FSTAT
 362 #endif
 363
 364 #ifdef RISCOS
 365 #include <sys/types.h>
 366 #include "unixstuff.h"
 367 #endif
 368
 369 #ifdef HAVE_SYS_STAT_H
 370 #if defined(PYOS_OS2) && defined(PYCC_GCC)
 371 #include <sys/types.h>
 372 #endif
 373 #include <sys/stat.h>
 374 #elif defined(HAVE_STAT_H)
 375 #include <stat.h>
 376 #endif
 377
 378 #if defined(PYCC_VACPP)
 379 /* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
 380 #define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
 381 #endif
 382
 383 #ifndef S_ISREG
 384 #define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
 385 #endif
 386
 387 #ifndef S_ISDIR
 388 #define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
 389 #endif
 390
 391
 392 #ifdef __cplusplus
 393 /* Move this down here since some C++ #include's don't like to be included
 394    inside an extern "C" */
 395 extern "C" {
 396 #endif
 397
 398
 399 /* Py_ARITHMETIC_RIGHT_SHIFT
 400  * C doesn't define whether a right-shift of a signed integer sign-extends
 401  * or zero-fills.  Here a macro to force sign extension:
 402  * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
 403  *    Return I >> J, forcing sign extension.  Arithmetically, return the
 404  *    floor of I/2**J.
 405  * Requirements:
 406  *    I should have signed integer type.  In the terminology of C99, this can
 407  *    be either one of the five standard signed integer types (signed char,
 408  *    short, int, long, long long) or an extended signed integer type.
 409  *    J is an integer >= 0 and strictly less than the number of bits in the
 410  *    type of I (because C doesn't define what happens for J outside that
 411  *    range either).
 412  *    TYPE used to specify the type of I, but is now ignored.  It's been left
 413  *    in for backwards compatibility with versions <= 2.6 or 3.0.
 414  * Caution:
 415  *    I may be evaluated more than once.
 416  */
 417 #ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
 418 #define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
 419         ((I) < 0 ? -1-((-1-(I)) >> (J)) : (I) >> (J))
 420 #else
 421 #define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
 422 #endif
 423
 424 /* Py_FORCE_EXPANSION(X)
 425  * "Simply" returns its argument.  However, macro expansions within the
 426  * argument are evaluated.  This unfortunate trickery is needed to get
 427  * token-pasting to work as desired in some cases.
 428  */
 429 #define Py_FORCE_EXPANSION(X) X
 430
 431 /* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
 432  * Cast VALUE to type NARROW from type WIDE.  In Py_DEBUG mode, this
 433  * assert-fails if any information is lost.
 434  * Caution:
 435  *    VALUE may be evaluated more than once.
 436  */
 437 #ifdef Py_DEBUG
 438 #define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
 439         (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
 440 #else
 441 #define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
 442 #endif
 443
 444 /* Py_SET_ERRNO_ON_MATH_ERROR(x)
 445  * If a libm function did not set errno, but it looks like the result
 446  * overflowed or not-a-number, set errno to ERANGE or EDOM.  Set errno
 447  * to 0 before calling a libm function, and invoke this macro after,
 448  * passing the function result.
 449  * Caution:
 450  *    This isn't reliable.  See Py_OVERFLOWED comments.
 451  *    X is evaluated more than once.
 452  */
 453 #if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
 454 #define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
 455 #else
 456 #define _Py_SET_EDOM_FOR_NAN(X) ;
 457 #endif
 458 #define Py_SET_ERRNO_ON_MATH_ERROR(X) \
 459         do { \
 460                 if (errno == 0) { \
 461                         if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
 462                                 errno = ERANGE; \
 463                         else _Py_SET_EDOM_FOR_NAN(X) \
 464                 } \
 465         } while(0)
 466
 467 /* Py_SET_ERANGE_ON_OVERFLOW(x)
 468  * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
 469  */
 470 #define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
 471
 472 /* Py_ADJUST_ERANGE1(x)
 473  * Py_ADJUST_ERANGE2(x, y)
 474  * Set errno to 0 before calling a libm function, and invoke one of these
 475  * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
 476  * for functions returning complex results).  This makes two kinds of
 477  * adjustments to errno:  (A) If it looks like the platform libm set
 478  * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
 479  * platform libm overflowed but didn't set errno, force errno to ERANGE.  In
 480  * effect, we're trying to force a useful implementation of C89 errno
 481  * behavior.
 482  * Caution:
 483  *    This isn't reliable.  See Py_OVERFLOWED comments.
 484  *    X and Y may be evaluated more than once.
 485  */
 486 #define Py_ADJUST_ERANGE1(X)                                            \
 487         do {                                                            \
 488                 if (errno == 0) {                                       \
 489                         if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL)  \
 490                                 errno = ERANGE;                         \
 491                 }                                                       \
 492                 else if (errno == ERANGE && (X) == 0.0)                 \
 493                         errno = 0;                                      \
 494         } while(0)
 495
 496 #define Py_ADJUST_ERANGE2(X, Y)                                         \
 497         do {                                                            \
 498                 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL ||        \
 499                     (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) {        \
 500                                 if (errno == 0)                         \
 501                                         errno = ERANGE;                 \
 502                 }                                                       \
 503                 else if (errno == ERANGE)                               \
 504                         errno = 0;                                      \
 505         } while(0)
 506
 507 /*  The functions _Py_dg_strtod and _Py_dg_dtoa in Python/dtoa.c (which are
 508  *  required to support the short float repr introduced in Python 3.1) require
 509  *  that the floating-point unit that's being used for arithmetic operations
 510  *  on C doubles is set to use 53-bit precision.  It also requires that the
 511  *  FPU rounding mode is round-half-to-even, but that's less often an issue.
 512  *
 513  *  If your FPU isn't already set to 53-bit precision/round-half-to-even, and
 514  *  you want to make use of _Py_dg_strtod and _Py_dg_dtoa, then you should
 515  *
 516  *     #define HAVE_PY_SET_53BIT_PRECISION 1
 517  *
 518  *  and also give appropriate definitions for the following three macros:
 519  *
 520  *    _PY_SET_53BIT_PRECISION_START : store original FPU settings, and
 521  *        set FPU to 53-bit precision/round-half-to-even
 522  *    _PY_SET_53BIT_PRECISION_END : restore original FPU settings
 523  *    _PY_SET_53BIT_PRECISION_HEADER : any variable declarations needed to
 524  *        use the two macros above.
 525  *
 526  * The macros are designed to be used within a single C function: see
 527  * Python/pystrtod.c for an example of their use.
 528  */
 529
 530 /* get and set x87 control word for gcc/x86 */
 531 #ifdef HAVE_GCC_ASM_FOR_X87
 532 #define HAVE_PY_SET_53BIT_PRECISION 1
 533 /* _Py_get/set_387controlword functions are defined in Python/pymath.c */
 534 #define _Py_SET_53BIT_PRECISION_HEADER                          \
 535         unsigned short old_387controlword, new_387controlword
 536 #define _Py_SET_53BIT_PRECISION_START                                   \
 537         do {                                                            \
 538                 old_387controlword = _Py_get_387controlword();          \
 539                 new_387controlword = (old_387controlword & ~0x0f00) | 0x0200; \
 540                 if (new_387controlword != old_387controlword)           \
 541                         _Py_set_387controlword(new_387controlword);     \
 542         } while (0)
 543 #define _Py_SET_53BIT_PRECISION_END                             \
 544         if (new_387controlword != old_387controlword)           \
 545                 _Py_set_387controlword(old_387controlword)
 546 #endif
 547
 548 /* default definitions are empty */
 549 #ifndef HAVE_PY_SET_53BIT_PRECISION
 550 #define _Py_SET_53BIT_PRECISION_HEADER
 551 #define _Py_SET_53BIT_PRECISION_START
 552 #define _Py_SET_53BIT_PRECISION_END
 553 #endif
 554
 555 /* If we can't guarantee 53-bit precision, don't use the code
 556    in Python/dtoa.c, but fall back to standard code.  This
 557    means that repr of a float will be long (17 sig digits).
 558
 559    Realistically, there are two things that could go wrong:
 560
 561    (1) doubles aren't IEEE 754 doubles, or
 562    (2) we're on x86 with the rounding precision set to 64-bits
 563        (extended precision), and we don't know how to change
 564        the rounding precision.
 565  */
 566
 567 #if !defined(DOUBLE_IS_LITTLE_ENDIAN_IEEE754) && \
 568     !defined(DOUBLE_IS_BIG_ENDIAN_IEEE754) && \
 569     !defined(DOUBLE_IS_ARM_MIXED_ENDIAN_IEEE754)
 570 #define PY_NO_SHORT_FLOAT_REPR
 571 #endif
 572
 573 /* double rounding is symptomatic of use of extended precision on x86.  If
 574    we're seeing double rounding, and we don't have any mechanism available for
 575    changing the FPU rounding precision, then don't use Python/dtoa.c. */
 576 #if defined(X87_DOUBLE_ROUNDING) && !defined(HAVE_PY_SET_53BIT_PRECISION)
 577 #define PY_NO_SHORT_FLOAT_REPR
 578 #endif
 579
 580 /* Py_DEPRECATED(version)
 581  * Declare a variable, type, or function deprecated.
 582  * Usage:
 583  *    extern int old_var Py_DEPRECATED(2.3);
 584  *    typedef int T1 Py_DEPRECATED(2.4);
 585  *    extern int x() Py_DEPRECATED(2.5);
 586  */
 587 #if defined(__GNUC__) && ((__GNUC__ >= 4) || \
 588                           (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
 589 #define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
 590 #else
 591 #define Py_DEPRECATED(VERSION_UNUSED)
 592 #endif
 593
 594 /**************************************************************************
 595 Prototypes that are missing from the standard include files on some systems
 596 (and possibly only some versions of such systems.)
 597
 598 Please be conservative with adding new ones, document them and enclose them
 599 in platform-specific #ifdefs.
 600 **************************************************************************/
 601
 602 #ifdef SOLARIS
 603 /* Unchecked */
 604 extern int gethostname(char *, int);
 605 #endif
 606
 607 #ifdef __BEOS__
 608 /* Unchecked */
 609 /* It's in the libs, but not the headers... - [cjh] */
 610 int shutdown( int, int );
 611 #endif
 612
 613 #ifdef HAVE__GETPTY
 614 #include <sys/types.h>          /* we need to import mode_t */
 615 extern char * _getpty(int *, int, mode_t, int);
 616 #endif
 617
 618 /* On QNX 6, struct termio must be declared by including sys/termio.h
 619    if TCGETA, TCSETA, TCSETAW, or TCSETAF are used.  sys/termio.h must
 620    be included before termios.h or it will generate an error. */
 621 #ifdef HAVE_SYS_TERMIO_H
 622 #include <sys/termio.h>
 623 #endif
 624
 625 #if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
 626 #if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
 627 /* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
 628    functions, even though they are included in libutil. */
 629 #include <termios.h>
 630 extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
 631 extern pid_t forkpty(int *, char *, struct termios *, struct winsize *);
 632 #endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
 633 #endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
 634
 635
 636 /* These are pulled from various places. It isn't obvious on what platforms
 637    they are necessary, nor what the exact prototype should look like (which
 638    is likely to vary between platforms!) If you find you need one of these
 639    declarations, please move them to a platform-specific block and include
 640    proper prototypes. */
 641 #if 0
 642
 643 /* From Modules/resource.c */
 644 extern int getrusage();
 645 extern int getpagesize();
 646
 647 /* From Python/sysmodule.c and Modules/posixmodule.c */
 648 extern int fclose(FILE *);
 649
 650 /* From Modules/posixmodule.c */
 651 extern int fdatasync(int);
 652 #endif /* 0 */
 653
 654
 655 /* On 4.4BSD-descendants, ctype functions serves the whole range of
 656  * wchar_t character set rather than single byte code points only.
 657  * This characteristic can break some operations of string object
 658  * including str.upper() and str.split() on UTF-8 locales.  This
 659  * workaround was provided by Tim Robbins of FreeBSD project.
 660  */
 661
 662 #ifdef __FreeBSD__
 663 #include <osreldate.h>
 664 #if __FreeBSD_version > 500039
 665 #include <ctype.h>
 666 #include <wctype.h>
 667 #undef isalnum
 668 #define isalnum(c) iswalnum(btowc(c))
 669 #undef isalpha
 670 #define isalpha(c) iswalpha(btowc(c))
 671 #undef islower
 672 #define islower(c) iswlower(btowc(c))
 673 #undef isspace
 674 #define isspace(c) iswspace(btowc(c))
 675 #undef isupper
 676 #define isupper(c) iswupper(btowc(c))
 677 #undef tolower
 678 #define tolower(c) towlower(btowc(c))
 679 #undef toupper
 680 #define toupper(c) towupper(btowc(c))
 681 #endif
 682 #endif
 683
 684
 685 /* Declarations for symbol visibility.
 686
 687   PyAPI_FUNC(type): Declares a public Python API function and return type
 688   PyAPI_DATA(type): Declares public Python data and its type
 689   PyMODINIT_FUNC:   A Python module init function.  If these functions are
 690                     inside the Python core, they are private to the core.
 691                     If in an extension module, it may be declared with
 692                     external linkage depending on the platform.
 693
 694   As a number of platforms support/require "__declspec(dllimport/dllexport)",
 695   we support a HAVE_DECLSPEC_DLL macro to save duplication.
 696 */
 697
 698 /*
 699   All windows ports, except cygwin, are handled in PC/pyconfig.h.
 700
 701   BeOS and cygwin are the only other autoconf platform requiring special
 702   linkage handling and both of these use __declspec().
 703 */
 704 #if defined(__CYGWIN__) || defined(__BEOS__)
 705 #       define HAVE_DECLSPEC_DLL
 706 #endif
 707
 708 /* only get special linkage if built as shared or platform is Cygwin */
 709 #if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
 710 #       if defined(HAVE_DECLSPEC_DLL)
 711 #               ifdef Py_BUILD_CORE
 712 #                       define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
 713 #                       define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
 714                         /* module init functions inside the core need no external linkage */
 715                         /* except for Cygwin to handle embedding (FIXME: BeOS too?) */
 716 #                       if defined(__CYGWIN__)
 717 #                               define PyMODINIT_FUNC __declspec(dllexport) void
 718 #                       else /* __CYGWIN__ */
 719 #                               define PyMODINIT_FUNC void
 720 #                       endif /* __CYGWIN__ */
 721 #               else /* Py_BUILD_CORE */
 722                         /* Building an extension module, or an embedded situation */
 723                         /* public Python functions and data are imported */
 724                         /* Under Cygwin, auto-import functions to prevent compilation */
 725                         /* failures similar to http://python.org/doc/FAQ.html#3.24 */
 726 #                       if !defined(__CYGWIN__)
 727 #                               define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
 728 #                       endif /* !__CYGWIN__ */
 729 #                       define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
 730                         /* module init functions outside the core must be exported */
 731 #                       if defined(__cplusplus)
 732 #                               define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
 733 #                       else /* __cplusplus */
 734 #                               define PyMODINIT_FUNC __declspec(dllexport) void
 735 #                       endif /* __cplusplus */
 736 #               endif /* Py_BUILD_CORE */
 737 #       endif /* HAVE_DECLSPEC */
 738 #endif /* Py_ENABLE_SHARED */
 739
 740 /* If no external linkage macros defined by now, create defaults */
 741 #ifndef PyAPI_FUNC
 742 #       define PyAPI_FUNC(RTYPE) RTYPE
 743 #endif
 744 #ifndef PyAPI_DATA
 745 #       define PyAPI_DATA(RTYPE) extern RTYPE
 746 #endif
 747 #ifndef PyMODINIT_FUNC
 748 #       if defined(__cplusplus)
 749 #               define PyMODINIT_FUNC extern "C" void
 750 #       else /* __cplusplus */
 751 #               define PyMODINIT_FUNC void
 752 #       endif /* __cplusplus */
 753 #endif
 754
 755 /* Deprecated DL_IMPORT and DL_EXPORT macros */
 756 #if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
 757 #       if defined(Py_BUILD_CORE)
 758 #               define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
 759 #               define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
 760 #       else
 761 #               define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
 762 #               define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
 763 #       endif
 764 #endif
 765 #ifndef DL_EXPORT
 766 #       define DL_EXPORT(RTYPE) RTYPE
 767 #endif
 768 #ifndef DL_IMPORT
 769 #       define DL_IMPORT(RTYPE) RTYPE
 770 #endif
 771 /* End of deprecated DL_* macros */
 772
 773 /* If the fd manipulation macros aren't defined,
 774    here is a set that should do the job */
 775
 776 #if 0 /* disabled and probably obsolete */
 777
 778 #ifndef FD_SETSIZE
 779 #define FD_SETSIZE      256
 780 #endif
 781
 782 #ifndef FD_SET
 783
 784 typedef long fd_mask;
 785
 786 #define NFDBITS (sizeof(fd_mask) * NBBY)        /* bits per mask */
 787 #ifndef howmany
 788 #define howmany(x, y)   (((x)+((y)-1))/(y))
 789 #endif /* howmany */
 790
 791 typedef struct fd_set {
 792         fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
 793 } fd_set;
 794
 795 #define FD_SET(n, p)    ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
 796 #define FD_CLR(n, p)    ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
 797 #define FD_ISSET(n, p)  ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
 798 #define FD_ZERO(p)      memset((char *)(p), '\0', sizeof(*(p)))
 799
 800 #endif /* FD_SET */
 801
 802 #endif /* fd manipulation macros */
 803
 804
 805 /* limits.h constants that may be missing */
 806
 807 #ifndef INT_MAX
 808 #define INT_MAX 2147483647
 809 #endif
 810
 811 #ifndef LONG_MAX
 812 #if SIZEOF_LONG == 4
 813 #define LONG_MAX 0X7FFFFFFFL
 814 #elif SIZEOF_LONG == 8
 815 #define LONG_MAX 0X7FFFFFFFFFFFFFFFL
 816 #else
 817 #error "could not set LONG_MAX in pyport.h"
 818 #endif
 819 #endif
 820
 821 #ifndef LONG_MIN
 822 #define LONG_MIN (-LONG_MAX-1)
 823 #endif
 824
 825 #ifndef LONG_BIT
 826 #define LONG_BIT (8 * SIZEOF_LONG)
 827 #endif
 828
 829 #if LONG_BIT != 8 * SIZEOF_LONG
 830 /* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
 831  * 32-bit platforms using gcc.  We try to catch that here at compile-time
 832  * rather than waiting for integer multiplication to trigger bogus
 833  * overflows.
 834  */
 835 #error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
 836 #endif
 837
 838 #ifdef __cplusplus
 839 }
 840 #endif
 841
 842 /*
 843  * Hide GCC attributes from compilers that don't support them.
 844  */
 845 #if (!defined(__GNUC__) || __GNUC__ < 2 || \
 846      (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
 847     !defined(RISCOS)
 848 #define Py_GCC_ATTRIBUTE(x)
 849 #else
 850 #define Py_GCC_ATTRIBUTE(x) __attribute__(x)
 851 #endif
 852
 853 /*
 854  * Add PyArg_ParseTuple format where available.
 855  */
 856 #ifdef HAVE_ATTRIBUTE_FORMAT_PARSETUPLE
 857 #define Py_FORMAT_PARSETUPLE(func,p1,p2) __attribute__((format(func,p1,p2)))
 858 #else
 859 #define Py_FORMAT_PARSETUPLE(func,p1,p2)
 860 #endif
 861
 862 /*
 863  * Specify alignment on compilers that support it.
 864  */
 865 #if defined(__GNUC__) && __GNUC__ >= 3
 866 #define Py_ALIGNED(x) __attribute__((aligned(x)))
 867 #else
 868 #define Py_ALIGNED(x)
 869 #endif
 870
 871 /* Eliminate end-of-loop code not reached warnings from SunPro C
 872  * when using do{...}while(0) macros
 873  */
 874 #ifdef __SUNPRO_C
 875 #pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
 876 #endif
 877
 878 /*
 879  * Older Microsoft compilers don't support the C99 long long literal suffixes,
 880  * so these will be defined in PC/pyconfig.h for those compilers.
 881  */
 882 #ifndef Py_LL
 883 #define Py_LL(x) x##LL
 884 #endif
 885
 886 #ifndef Py_ULL
 887 #define Py_ULL(x) Py_LL(x##U)
 888 #endif
 889
 890 #endif /* Py_PYPORT_H */