Include/pyport.h

   1 #ifndef Py_PYPORT_H
   2 #define Py_PYPORT_H
   3
   4 #include "pyconfig.h" /* include for defines */
   5
   6 /**************************************************************************
   7 Symbols and macros to supply platform-independent interfaces to basic
   8 C language & library operations whose spellings vary across platforms.
   9
  10 Please try to make documentation here as clear as possible:  by definition,
  11 the stuff here is trying to illuminate C's darkest corners.
  12
  13 Config #defines referenced here:
  14
  15 SIGNED_RIGHT_SHIFT_ZERO_FILLS
  16 Meaning:  To be defined iff i>>j does not extend the sign bit when i is a
  17           signed integral type and i < 0.
  18 Used in:  Py_ARITHMETIC_RIGHT_SHIFT
  19
  20 Py_DEBUG
  21 Meaning:  Extra checks compiled in for debug mode.
  22 Used in:  Py_SAFE_DOWNCAST
  23
  24 HAVE_UINTPTR_T
  25 Meaning:  The C9X type uintptr_t is supported by the compiler
  26 Used in:  Py_uintptr_t
  27
  28 HAVE_LONG_LONG
  29 Meaning:  The compiler supports the C type "long long"
  30 Used in:  LONG_LONG
  31
  32 **************************************************************************/
  33
  34
  35 /* For backward compatibility only. Obsolete, do not use. */
  36 #ifdef HAVE_PROTOTYPES
  37 #define Py_PROTO(x) x
  38 #else
  39 #define Py_PROTO(x) ()
  40 #endif
  41 #ifndef Py_FPROTO
  42 #define Py_FPROTO(x) Py_PROTO(x)
  43 #endif
  44
  45 /* typedefs for some C9X-defined synonyms for integral types.
  46  *
  47  * The names in Python are exactly the same as the C9X names, except with a
  48  * Py_ prefix.  Until C9X is universally implemented, this is the only way
  49  * to ensure that Python gets reliable names that don't conflict with names
  50  * in non-Python code that are playing their own tricks to define the C9X
  51  * names.
  52  *
  53  * NOTE: don't go nuts here!  Python has no use for *most* of the C9X
  54  * integral synonyms.  Only define the ones we actually need.
  55  */
  56
  57 #ifdef HAVE_LONG_LONG
  58 #ifndef LONG_LONG
  59 #define LONG_LONG long long
  60 #endif
  61 #endif /* HAVE_LONG_LONG */
  62
  63 /* uintptr_t is the C9X name for an unsigned integral type such that a
  64  * legitimate void* can be cast to uintptr_t and then back to void* again
  65  * without loss of information.  Similarly for intptr_t, wrt a signed
  66  * integral type.
  67  */
  68 #ifdef HAVE_UINTPTR_T
  69 typedef uintptr_t       Py_uintptr_t;
  70 typedef intptr_t        Py_intptr_t;
  71
  72 #elif SIZEOF_VOID_P <= SIZEOF_INT
  73 typedef unsigned int    Py_uintptr_t;
  74 typedef int             Py_intptr_t;
  75
  76 #elif SIZEOF_VOID_P <= SIZEOF_LONG
  77 typedef unsigned long   Py_uintptr_t;
  78 typedef long            Py_intptr_t;
  79
  80 #elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
  81 typedef unsigned LONG_LONG      Py_uintptr_t;
  82 typedef LONG_LONG               Py_intptr_t;
  83
  84 #else
  85 #   error "Python needs a typedef for Py_uintptr_t in pyport.h."
  86 #endif /* HAVE_UINTPTR_T */
  87
  88 #ifdef HAVE_STDLIB_H
  89 #include <stdlib.h>
  90 #endif
  91
  92 #include <math.h> /* Moved here from the math section, before extern "C" */
  93
  94 /********************************************
  95  * WRAPPER FOR <time.h> and/or <sys/time.h> *
  96  ********************************************/
  97
  98 #ifdef TIME_WITH_SYS_TIME
  99 #include <sys/time.h>
 100 #include <time.h>
 101 #else /* !TIME_WITH_SYS_TIME */
 102 #ifdef HAVE_SYS_TIME_H
 103 #include <sys/time.h>
 104 #else /* !HAVE_SYS_TIME_H */
 105 #include <time.h>
 106 #endif /* !HAVE_SYS_TIME_H */
 107 #endif /* !TIME_WITH_SYS_TIME */
 108
 109
 110 /******************************
 111  * WRAPPER FOR <sys/select.h> *
 112  ******************************/
 113
 114 /* NB caller must include <sys/types.h> */
 115
 116 #ifdef HAVE_SYS_SELECT_H
 117
 118 #include <sys/select.h>
 119
 120 #endif /* !HAVE_SYS_SELECT_H */
 121
 122 /*******************************
 123  * stat() and fstat() fiddling *
 124  *******************************/
 125
 126 /* We expect that stat and fstat exist on most systems.
 127  *  It's confirmed on Unix, Mac and Windows.
 128  *  If you don't have them, add
 129  *      #define DONT_HAVE_STAT
 130  * and/or
 131  *      #define DONT_HAVE_FSTAT
 132  * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
 133  * HAVE_FSTAT instead.
 134  * Also
 135  *      #define DONT_HAVE_SYS_STAT_H
 136  * if <sys/stat.h> doesn't exist on your platform, and
 137  *      #define HAVE_STAT_H
 138  * if <stat.h> does (don't look at me -- ths mess is inherited).
 139  */
 140 #ifndef DONT_HAVE_STAT
 141 #define HAVE_STAT
 142 #endif
 143
 144 #ifndef DONT_HAVE_FSTAT
 145 #define HAVE_FSTAT
 146 #endif
 147
 148 #ifdef RISCOS
 149 #include <sys/types.h>
 150 #endif
 151
 152 #ifndef DONT_HAVE_SYS_STAT_H
 153 #if defined(PYOS_OS2) && defined(PYCC_GCC)
 154 #include <sys/types.h>
 155 #endif
 156 #include <sys/stat.h>
 157 #elif defined(HAVE_STAT_H)
 158 #include <stat.h>
 159 #endif
 160
 161 #if defined(PYCC_VACPP)
 162 /* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
 163 #define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
 164 #endif
 165
 166 #ifndef S_ISREG
 167 #define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
 168 #endif
 169
 170 #ifndef S_ISDIR
 171 #define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
 172 #endif
 173
 174
 175 #ifdef __cplusplus
 176 /* Move this down here since some C++ #include's don't like to be included
 177    inside an extern "C" */
 178 extern "C" {
 179 #endif
 180
 181
 182 /* Py_ARITHMETIC_RIGHT_SHIFT
 183  * C doesn't define whether a right-shift of a signed integer sign-extends
 184  * or zero-fills.  Here a macro to force sign extension:
 185  * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
 186  *    Return I >> J, forcing sign extension.
 187  * Requirements:
 188  *    I is of basic signed type TYPE (char, short, int, long, or long long).
 189  *    TYPE is one of char, short, int, long, or long long, although long long
 190  *    must not be used except on platforms that support it.
 191  *    J is an integer >= 0 and strictly less than the number of bits in TYPE
 192  *    (because C doesn't define what happens for J outside that range either).
 193  * Caution:
 194  *    I may be evaluated more than once.
 195  */
 196 #ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
 197 #define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
 198         ((I) < 0 ? ~((~(unsigned TYPE)(I)) >> (J)) : (I) >> (J))
 199 #else
 200 #define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
 201 #endif
 202
 203 /* Py_FORCE_EXPANSION(X)
 204  * "Simply" returns its argument.  However, macro expansions within the
 205  * argument are evaluated.  This unfortunate trickery is needed to get
 206  * token-pasting to work as desired in some cases.
 207  */
 208 #define Py_FORCE_EXPANSION(X) X
 209
 210 /* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
 211  * Cast VALUE to type NARROW from type WIDE.  In Py_DEBUG mode, this
 212  * assert-fails if any information is lost.
 213  * Caution:
 214  *    VALUE may be evaluated more than once.
 215  */
 216 #ifdef Py_DEBUG
 217 #define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
 218         (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
 219 #else
 220 #define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
 221 #endif
 222
 223 /* Py_IS_INFINITY(X)
 224  * Return 1 if float or double arg is an infinity, else 0.
 225  * Caution:
 226  *    X is evaluated more than once.
 227  *    This implementation may set the underflow flag if |X| is very small;
 228  *    it really can't be implemented correctly (& easily) before C99.
 229  */
 230 #define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
 231
 232 /* HUGE_VAL is supposed to expand to a positive double infinity.  Python
 233  * uses Py_HUGE_VAL instead because some platforms are broken in this
 234  * respect.  We used to embed code in pyport.h to try to worm around that,
 235  * but different platforms are broken in conflicting ways.  If you're on
 236  * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
 237  * config to #define Py_HUGE_VAL to something that works on your platform.
 238  */
 239 #ifndef Py_HUGE_VAL
 240 #define Py_HUGE_VAL HUGE_VAL
 241 #endif
 242
 243 /* Py_OVERFLOWED(X)
 244  * Return 1 iff a libm function overflowed.  Set errno to 0 before calling
 245  * a libm function, and invoke this macro after, passing the function
 246  * result.
 247  * Caution:
 248  *    This isn't reliable.  C99 no longer requires libm to set errno under
 249  *        any exceptional condition, but does require +- HUGE_VAL return
 250  *        values on overflow.  A 754 box *probably* maps HUGE_VAL to a
 251  *        double infinity, and we're cool if that's so, unless the input
 252  *        was an infinity and an infinity is the expected result.  A C89
 253  *        system sets errno to ERANGE, so we check for that too.  We're
 254  *        out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
 255  *        if the returned result is a NaN, or if a C89 box returns HUGE_VAL
 256  *        in non-overflow cases.
 257  *    X is evaluated more than once.
 258  * Some platforms have better way to spell this, so expect some #ifdef'ery.
 259  */
 260 #ifdef __FreeBSD__
 261 #define Py_OVERFLOWED(X) isinf(X)
 262 #else
 263 #define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE ||    \
 264                                          (X) == Py_HUGE_VAL || \
 265                                          (X) == -Py_HUGE_VAL))
 266 #endif
 267
 268 /* Py_SET_ERANGE_ON_OVERFLOW(x)
 269  * If a libm function did not set errno, but it looks like the result
 270  * overflowed, set errno to ERANGE.  Set errno to 0 before calling a libm
 271  * function, and invoke this macro after, passing the function result.
 272  * Caution:
 273  *    This isn't reliable.  See Py_OVERFLOWED comments.
 274  *    X is evaluated more than once.
 275  */
 276 #define Py_SET_ERANGE_IF_OVERFLOW(X) \
 277         do { \
 278                 if (errno == 0 && ((X) == Py_HUGE_VAL ||  \
 279                                    (X) == -Py_HUGE_VAL))  \
 280                         errno = ERANGE; \
 281         } while(0)
 282
 283 /* Py_ADJUST_ERANGE1(x)
 284  * Py_ADJUST_ERANGE2(x, y)
 285  * Set errno to 0 before calling a libm function, and invoke one of these
 286  * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
 287  * for functions returning complex results).  This makes two kinds of
 288  * adjustments to errno:  (A) If it looks like the platform libm set
 289  * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
 290  * platform libm overflowed but didn't set errno, force errno to ERANGE.  In
 291  * effect, we're trying to force a useful implementation of C89 errno
 292  * behavior.
 293  * Caution:
 294  *    This isn't reliable.  See Py_OVERFLOWED comments.
 295  *    X and Y may be evaluated more than once.
 296  */
 297 #define Py_ADJUST_ERANGE1(X)                                            \
 298         do {                                                            \
 299                 if (errno == 0) {                                       \
 300                         if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL)  \
 301                                 errno = ERANGE;                         \
 302                 }                                                       \
 303                 else if (errno == ERANGE && (X) == 0.0)                 \
 304                         errno = 0;                                      \
 305         } while(0)
 306
 307 #define Py_ADJUST_ERANGE2(X, Y)                                         \
 308         do {                                                            \
 309                 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL ||        \
 310                     (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) {        \
 311                                 if (errno == 0)                         \
 312                                         errno = ERANGE;                 \
 313                 }                                                       \
 314                 else if (errno == ERANGE)                               \
 315                         errno = 0;                                      \
 316         } while(0)
 317
 318 /* Py_DEPRECATED(version)
 319  * Declare a variable, type, or function deprecated.
 320  * Usage:
 321  *    extern int old_var Py_DEPRECATED(2.3);
 322  *    typedef int T1 Py_DEPRECATED(2.4);
 323  *    extern int x() Py_DEPRECATED(2.5);
 324  */
 325 #if defined(__GNUC__) && (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1)
 326 #define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
 327 #else
 328 #define Py_DEPRECATED(VERSION_UNUSED)
 329 #endif
 330
 331 /**************************************************************************
 332 Prototypes that are missing from the standard include files on some systems
 333 (and possibly only some versions of such systems.)
 334
 335 Please be conservative with adding new ones, document them and enclose them
 336 in platform-specific #ifdefs.
 337 **************************************************************************/
 338
 339 #ifdef SOLARIS
 340 /* Unchecked */
 341 extern int gethostname(char *, int);
 342 #endif
 343
 344 #ifdef __BEOS__
 345 /* Unchecked */
 346 /* It's in the libs, but not the headers... - [cjh] */
 347 int shutdown( int, int );
 348 #endif
 349
 350 #ifdef HAVE__GETPTY
 351 #include <sys/types.h>          /* we need to import mode_t */
 352 extern char * _getpty(int *, int, mode_t, int);
 353 #endif
 354
 355 #if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
 356 #if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
 357 /* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
 358    functions, even though they are included in libutil. */
 359 #include <termios.h>
 360 extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
 361 extern int forkpty(int *, char *, struct termios *, struct winsize *);
 362 #endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
 363 #endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
 364
 365
 366 /* These are pulled from various places. It isn't obvious on what platforms
 367    they are necessary, nor what the exact prototype should look like (which
 368    is likely to vary between platforms!) If you find you need one of these
 369    declarations, please move them to a platform-specific block and include
 370    proper prototypes. */
 371 #if 0
 372
 373 /* From Modules/resource.c */
 374 extern int getrusage();
 375 extern int getpagesize();
 376
 377 /* From Python/sysmodule.c and Modules/posixmodule.c */
 378 extern int fclose(FILE *);
 379
 380 /* From Modules/posixmodule.c */
 381 extern int fdatasync(int);
 382 /* XXX These are supposedly for SunOS4.1.3 but "shouldn't hurt elsewhere" */
 383 extern int rename(const char *, const char *);
 384 extern int pclose(FILE *);
 385 extern int lstat(const char *, struct stat *);
 386 extern int symlink(const char *, const char *);
 387 extern int fsync(int fd);
 388
 389 #endif /* 0 */
 390
 391
 392 /************************
 393  * WRAPPER FOR <math.h> *
 394  ************************/
 395
 396 #ifndef HAVE_HYPOT
 397 extern double hypot(double, double);
 398 #endif
 399
 400 /* Declarations for symbol visibility.
 401
 402   PyAPI_FUNC(type): Declares a public Python API function and return type
 403   PyAPI_DATA(type): Declares public Python data and its type
 404   PyMODINIT_FUNC:   A Python module init function.  If these functions are
 405                     inside the Python core, they are private to the core.
 406                     If in an extension module, it may be declared with
 407                     external linkage depending on the platform.
 408
 409   As a number of platforms support/require "__declspec(dllimport/dllexport)",
 410   we support a HAVE_DECLSPEC_DLL macro to save duplication.
 411 */
 412
 413 /*
 414   All windows ports, except cygwin, are handled in PC/pyconfig.h.
 415
 416   BeOS and cygwin are the only other autoconf platform requiring special
 417   linkage handling and both of these use __declspec().
 418 */
 419 #if defined(__CYGWIN__) || defined(__BEOS__)
 420 #       define HAVE_DECLSPEC_DLL
 421 #endif
 422
 423 #if defined(Py_ENABLE_SHARED) /* only get special linkage if built as shared */
 424 #       if defined(HAVE_DECLSPEC_DLL)
 425 #               ifdef Py_BUILD_CORE
 426 #                       define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
 427 #                       define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
 428                         /* module init functions inside the core need no external linkage */
 429 #                       define PyMODINIT_FUNC void
 430 #               else /* Py_BUILD_CORE */
 431                         /* Building an extension module, or an embedded situation */
 432                         /* public Python functions and data are imported */
 433                         /* Under Cygwin, auto-import functions to prevent compilation */
 434                         /* failures similar to http://python.org/doc/FAQ.html#3.24 */
 435 #                       if !defined(__CYGWIN__)
 436 #                               define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
 437 #                       endif /* !__CYGWIN__ */
 438 #                       define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
 439                         /* module init functions outside the core must be exported */
 440 #                       if defined(__cplusplus)
 441 #                               define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
 442 #                       else /* __cplusplus */
 443 #                               define PyMODINIT_FUNC __declspec(dllexport) void
 444 #                       endif /* __cplusplus */
 445 #               endif /* Py_BUILD_CORE */
 446 #       endif /* HAVE_DECLSPEC */
 447 #endif /* Py_ENABLE_SHARED */
 448
 449 /* If no external linkage macros defined by now, create defaults */
 450 #ifndef PyAPI_FUNC
 451 #       define PyAPI_FUNC(RTYPE) RTYPE
 452 #endif
 453 #ifndef PyAPI_DATA
 454 #       define PyAPI_DATA(RTYPE) extern RTYPE
 455 #endif
 456 #ifndef PyMODINIT_FUNC
 457 #       if defined(__cplusplus)
 458 #               define PyMODINIT_FUNC extern "C" void
 459 #       else /* __cplusplus */
 460 #               define PyMODINIT_FUNC void
 461 #       endif /* __cplusplus */
 462 #endif
 463
 464 /* Deprecated DL_IMPORT and DL_EXPORT macros */
 465 #if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
 466 #       if defined(Py_BUILD_CORE)
 467 #               define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
 468 #               define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
 469 #       else
 470 #               define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
 471 #               define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
 472 #       endif
 473 #endif
 474 #ifndef DL_EXPORT
 475 #       define DL_EXPORT(RTYPE) RTYPE
 476 #endif
 477 #ifndef DL_IMPORT
 478 #       define DL_IMPORT(RTYPE) RTYPE
 479 #endif
 480 /* End of deprecated DL_* macros */
 481
 482 /* If the fd manipulation macros aren't defined,
 483    here is a set that should do the job */
 484
 485 #if 0 /* disabled and probably obsolete */
 486
 487 #ifndef FD_SETSIZE
 488 #define FD_SETSIZE      256
 489 #endif
 490
 491 #ifndef FD_SET
 492
 493 typedef long fd_mask;
 494
 495 #define NFDBITS (sizeof(fd_mask) * NBBY)        /* bits per mask */
 496 #ifndef howmany
 497 #define howmany(x, y)   (((x)+((y)-1))/(y))
 498 #endif /* howmany */
 499
 500 typedef struct fd_set {
 501         fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
 502 } fd_set;
 503
 504 #define FD_SET(n, p)    ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
 505 #define FD_CLR(n, p)    ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
 506 #define FD_ISSET(n, p)  ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
 507 #define FD_ZERO(p)      memset((char *)(p), '\0', sizeof(*(p)))
 508
 509 #endif /* FD_SET */
 510
 511 #endif /* fd manipulation macros */
 512
 513
 514 /* limits.h constants that may be missing */
 515
 516 #ifndef INT_MAX
 517 #define INT_MAX 2147483647
 518 #endif
 519
 520 #ifndef LONG_MAX
 521 #if SIZEOF_LONG == 4
 522 #define LONG_MAX 0X7FFFFFFFL
 523 #elif SIZEOF_LONG == 8
 524 #define LONG_MAX 0X7FFFFFFFFFFFFFFFL
 525 #else
 526 #error "could not set LONG_MAX in pyport.h"
 527 #endif
 528 #endif
 529
 530 #ifndef LONG_MIN
 531 #define LONG_MIN (-LONG_MAX-1)
 532 #endif
 533
 534 #ifndef LONG_BIT
 535 #define LONG_BIT (8 * SIZEOF_LONG)
 536 #endif
 537
 538 #if LONG_BIT != 8 * SIZEOF_LONG
 539 /* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
 540  * 32-bit platforms using gcc.  We try to catch that here at compile-time
 541  * rather than waiting for integer multiplication to trigger bogus
 542  * overflows.
 543  */
 544 #error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
 545 #endif
 546
 547 #ifdef __cplusplus
 548 }
 549 #endif
 550
 551 /*
 552  * Hide GCC attributes from compilers that don't support them.
 553  */
 554 #if (!defined(__GNUC__) || __GNUC__ < 2 || \
 555      (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
 556     !defined(RISCOS)
 557 #define Py_GCC_ATTRIBUTE(x)
 558 #else
 559 #define Py_GCC_ATTRIBUTE(x) __attribute__(x)
 560 #endif
 561
 562 #endif /* Py_PYPORT_H */