perl.h

   1 /*    perl.h
   2  *
   3  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
   4  *    2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10
  11 #ifndef H_PERL
  12 #define H_PERL 1
  13
  14 #ifdef PERL_FOR_X2P
  15 /*
  16  * This file is being used for x2p stuff.
  17  * Above symbol is defined via -D in 'x2p/Makefile.SH'
  18  * Decouple x2p stuff from some of perls more extreme eccentricities.
  19  */
  20 #undef MULTIPLICITY
  21 #undef USE_STDIO
  22 #define USE_STDIO
  23 #endif /* PERL_FOR_X2P */
  24
  25 #ifdef PERL_MICRO
  26 #   include "uconfig.h"
  27 #else
  28 #   include "config.h"
  29 #endif
  30
  31 /* this is used for functions which take a depth trailing
  32  * argument under debugging */
  33 #ifdef DEBUGGING
  34 #define _pDEPTH ,U32 depth
  35 #define _aDEPTH ,depth
  36 #else
  37 #define _pDEPTH
  38 #define _aDEPTH
  39 #endif
  40
  41 /* NOTE 1: that with gcc -std=c89 the __STDC_VERSION__ is *not* defined
  42  * because the __STDC_VERSION__ became a thing only with C90.  Therefore,
  43  * with gcc, HAS_C99 will never become true as long as we use -std=c89.
  44
  45  * NOTE 2: headers lie.  Do not expect that if HAS_C99 gets to be true,
  46  * all the C99 features are there and are correct. */
  47 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || \
  48     defined(_STDC_C99) || defined(__c99)
  49 #  define HAS_C99 1
  50 #endif
  51
  52 /* See L<perlguts/"The Perl API"> for detailed notes on
  53  * PERL_IMPLICIT_CONTEXT and PERL_IMPLICIT_SYS */
  54
  55 /* Note that from here --> to <-- the same logic is
  56  * repeated in makedef.pl, so be certain to update
  57  * both places when editing. */
  58
  59 #ifdef USE_ITHREADS
  60 #  if !defined(MULTIPLICITY)
  61 #    define MULTIPLICITY
  62 #  endif
  63 #endif
  64
  65 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
  66 #  ifndef PERL_GLOBAL_STRUCT
  67 #    define PERL_GLOBAL_STRUCT
  68 #  endif
  69 #endif
  70
  71 #ifdef PERL_GLOBAL_STRUCT
  72 #  ifndef MULTIPLICITY
  73 #    define MULTIPLICITY
  74 #  endif
  75 #endif
  76
  77 #ifdef MULTIPLICITY
  78 #  ifndef PERL_IMPLICIT_CONTEXT
  79 #    define PERL_IMPLICIT_CONTEXT
  80 #  endif
  81 #endif
  82
  83 /* undef WIN32 when building on Cygwin (for libwin32) - gph */
  84 #ifdef __CYGWIN__
  85 #   undef WIN32
  86 #   undef _WIN32
  87 #endif
  88
  89 #if defined(__SYMBIAN32__) || (defined(__VC32__) && defined(WINS))
  90 #   ifndef SYMBIAN
  91 #       define SYMBIAN
  92 #   endif
  93 #endif
  94
  95 #ifdef __SYMBIAN32__
  96 #  include "symbian/symbian_proto.h"
  97 #endif
  98
  99 /* Any stack-challenged places.  The limit varies (and often
 100  * is configurable), but using more than a kilobyte of stack
 101  * is usually dubious in these systems. */
 102 #if defined(__SYMBIAN32__)
 103 /* Symbian: need to work around the SDK features. *
 104  * On WINS: MS VC5 generates calls to _chkstk,         *
 105  * if a "large" stack frame is allocated.              *
 106  * gcc on MARM does not generate calls like these.     */
 107 #   define USE_HEAP_INSTEAD_OF_STACK
 108 #endif
 109
 110 /* Use the reentrant APIs like localtime_r and getpwent_r */
 111 /* Win32 has naturally threadsafe libraries, no need to use any _r variants. */
 112 #if defined(USE_ITHREADS) && !defined(USE_REENTRANT_API) && !defined(NETWARE) && !defined(WIN32)
 113 #   define USE_REENTRANT_API
 114 #endif
 115
 116 /* <--- here ends the logic shared by perl.h and makedef.pl */
 117
 118 /* Microsoft Visual C++ 6.0 needs special treatment in numerous places */
 119 #if defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1200 && _MSC_VER < 1300
 120 #  define USING_MSVC6
 121 #endif
 122
 123 #undef START_EXTERN_C
 124 #undef END_EXTERN_C
 125 #undef EXTERN_C
 126 #ifdef __cplusplus
 127 #  define START_EXTERN_C extern "C" {
 128 #  define END_EXTERN_C }
 129 #  define EXTERN_C extern "C"
 130 #else
 131 #  define START_EXTERN_C
 132 #  define END_EXTERN_C
 133 #  define EXTERN_C extern
 134 #endif
 135
 136 /* Fallback definitions in case we don't have definitions from config.h.
 137    This should only matter for systems that don't use Configure and
 138    haven't been modified to define PERL_STATIC_INLINE yet.
 139 */
 140 #if !defined(PERL_STATIC_INLINE)
 141 #  ifdef HAS_STATIC_INLINE
 142 #    define PERL_STATIC_INLINE static inline
 143 #  else
 144 #    define PERL_STATIC_INLINE static
 145 #  endif
 146 #endif
 147
 148 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GET_VARS)
 149 #    ifdef PERL_GLOBAL_STRUCT_PRIVATE
 150        EXTERN_C struct perl_vars* Perl_GetVarsPrivate();
 151 #      define PERL_GET_VARS() Perl_GetVarsPrivate() /* see miniperlmain.c */
 152 #    else
 153 #      define PERL_GET_VARS() PL_VarsPtr
 154 #    endif
 155 #endif
 156
 157 /* this used to be off by default, now its on, see perlio.h */
 158 #define PERLIO_FUNCS_CONST
 159
 160 #define pVAR    struct perl_vars* my_vars PERL_UNUSED_DECL
 161
 162 #ifdef PERL_GLOBAL_STRUCT
 163 #  define dVAR          pVAR    = (struct perl_vars*)PERL_GET_VARS()
 164 #else
 165 #  define dVAR          dNOOP
 166 #endif
 167
 168 #ifdef PERL_IMPLICIT_CONTEXT
 169 #  ifndef MULTIPLICITY
 170 #    define MULTIPLICITY
 171 #  endif
 172 #  define tTHX  PerlInterpreter*
 173 #  define pTHX  tTHX my_perl PERL_UNUSED_DECL
 174 #  define aTHX  my_perl
 175 #  define aTHXa(a) aTHX = (tTHX)a
 176 #  ifdef PERL_GLOBAL_STRUCT
 177 #    define dTHXa(a)    dVAR; pTHX = (tTHX)a
 178 #  else
 179 #    define dTHXa(a)    pTHX = (tTHX)a
 180 #  endif
 181 #  ifdef PERL_GLOBAL_STRUCT
 182 #    define dTHX                dVAR; pTHX = PERL_GET_THX
 183 #  else
 184 #    define dTHX                pTHX = PERL_GET_THX
 185 #  endif
 186 #  define pTHX_         pTHX,
 187 #  define aTHX_         aTHX,
 188 #  define pTHX_1        2
 189 #  define pTHX_2        3
 190 #  define pTHX_3        4
 191 #  define pTHX_4        5
 192 #  define pTHX_5        6
 193 #  define pTHX_6        7
 194 #  define pTHX_7        8
 195 #  define pTHX_8        9
 196 #  define pTHX_9        10
 197 #  define pTHX_12       13
 198 #  if defined(DEBUGGING) && !defined(PERL_TRACK_MEMPOOL)
 199 #    define PERL_TRACK_MEMPOOL
 200 #  endif
 201 #else
 202 #  undef PERL_TRACK_MEMPOOL
 203 #endif
 204
 205 #define STATIC static
 206
 207 #ifndef PERL_CORE
 208 /* Do not use these macros. They were part of PERL_OBJECT, which was an
 209  * implementation of multiplicity using C++ objects. They have been left
 210  * here solely for the sake of XS code which has incorrectly
 211  * cargo-culted them.
 212  */
 213 #define CPERLscope(x) x
 214 #define CPERLarg void
 215 #define CPERLarg_
 216 #define _CPERLarg
 217 #define PERL_OBJECT_THIS
 218 #define _PERL_OBJECT_THIS
 219 #define PERL_OBJECT_THIS_
 220 #define CALL_FPTR(fptr) (*fptr)
 221 #define MEMBER_TO_FPTR(name) name
 222 #endif /* !PERL_CORE */
 223
 224 #define CALLRUNOPS  PL_runops
 225
 226 #define CALLREGCOMP(sv, flags) Perl_pregcomp(aTHX_ (sv),(flags))
 227
 228 #define CALLREGCOMP_ENG(prog, sv, flags) (prog)->comp(aTHX_ sv, flags)
 229 #define CALLREGEXEC(prog,stringarg,strend,strbeg,minend,sv,data,flags) \
 230     RX_ENGINE(prog)->exec(aTHX_ (prog),(stringarg),(strend), \
 231         (strbeg),(minend),(sv),(data),(flags))
 232 #define CALLREG_INTUIT_START(prog,sv,strbeg,strpos,strend,flags,data) \
 233     RX_ENGINE(prog)->intuit(aTHX_ (prog), (sv), (strbeg), (strpos), \
 234         (strend),(flags),(data))
 235 #define CALLREG_INTUIT_STRING(prog) \
 236     RX_ENGINE(prog)->checkstr(aTHX_ (prog))
 237
 238 #define CALLREGFREE(prog) \
 239     Perl_pregfree(aTHX_ (prog))
 240
 241 #define CALLREGFREE_PVT(prog) \
 242     if(prog) RX_ENGINE(prog)->rxfree(aTHX_ (prog))
 243
 244 #define CALLREG_NUMBUF_FETCH(rx,paren,usesv)                                \
 245     RX_ENGINE(rx)->numbered_buff_FETCH(aTHX_ (rx),(paren),(usesv))
 246
 247 #define CALLREG_NUMBUF_STORE(rx,paren,value) \
 248     RX_ENGINE(rx)->numbered_buff_STORE(aTHX_ (rx),(paren),(value))
 249
 250 #define CALLREG_NUMBUF_LENGTH(rx,sv,paren)                              \
 251     RX_ENGINE(rx)->numbered_buff_LENGTH(aTHX_ (rx),(sv),(paren))
 252
 253 #define CALLREG_NAMED_BUFF_FETCH(rx, key, flags) \
 254     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_FETCH))
 255
 256 #define CALLREG_NAMED_BUFF_STORE(rx, key, value, flags) \
 257     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), (value), ((flags) | RXapif_STORE))
 258
 259 #define CALLREG_NAMED_BUFF_DELETE(rx, key, flags) \
 260     RX_ENGINE(rx)->named_buff(aTHX_ (rx),(key), NULL, ((flags) | RXapif_DELETE))
 261
 262 #define CALLREG_NAMED_BUFF_CLEAR(rx, flags) \
 263     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_CLEAR))
 264
 265 #define CALLREG_NAMED_BUFF_EXISTS(rx, key, flags) \
 266     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_EXISTS))
 267
 268 #define CALLREG_NAMED_BUFF_FIRSTKEY(rx, flags) \
 269     RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), NULL, ((flags) | RXapif_FIRSTKEY))
 270
 271 #define CALLREG_NAMED_BUFF_NEXTKEY(rx, lastkey, flags) \
 272     RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), (lastkey), ((flags) | RXapif_NEXTKEY))
 273
 274 #define CALLREG_NAMED_BUFF_SCALAR(rx, flags) \
 275     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_SCALAR))
 276
 277 #define CALLREG_NAMED_BUFF_COUNT(rx) \
 278     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, RXapif_REGNAMES_COUNT)
 279
 280 #define CALLREG_NAMED_BUFF_ALL(rx, flags) \
 281     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, flags)
 282
 283 #define CALLREG_PACKAGE(rx) \
 284     RX_ENGINE(rx)->qr_package(aTHX_ (rx))
 285
 286 #if defined(USE_ITHREADS)
 287 #define CALLREGDUPE(prog,param) \
 288     Perl_re_dup(aTHX_ (prog),(param))
 289
 290 #define CALLREGDUPE_PVT(prog,param) \
 291     (prog ? RX_ENGINE(prog)->dupe(aTHX_ (prog),(param)) \
 292           : (REGEXP *)NULL)
 293 #endif
 294
 295
 296
 297
 298
 299 /*
 300  * Because of backward compatibility reasons the PERL_UNUSED_DECL
 301  * cannot be changed from postfix to PERL_UNUSED_DECL(x).  Sigh.
 302  *
 303  * Note that there are C compilers such as MetroWerks CodeWarrior
 304  * which do not have an "inlined" way (like the gcc __attribute__) of
 305  * marking unused variables (they need e.g. a #pragma) and therefore
 306  * cpp macros like PERL_UNUSED_DECL cannot work for this purpose, even
 307  * if it were PERL_UNUSED_DECL(x), which it cannot be (see above).
 308  *
 309  */
 310
 311 #if defined(__SYMBIAN32__) && defined(__GNUC__)
 312 #  ifdef __cplusplus
 313 #    define PERL_UNUSED_DECL
 314 #  else
 315 #    define PERL_UNUSED_DECL __attribute__((unused))
 316 #  endif
 317 #endif
 318
 319 #ifndef PERL_UNUSED_DECL
 320 #  if defined(HASATTRIBUTE_UNUSED) && (!defined(__cplusplus) || __GNUC__ >= 4)
 321 #    define PERL_UNUSED_DECL __attribute__unused__
 322 #  else
 323 #    define PERL_UNUSED_DECL
 324 #  endif
 325 #endif
 326
 327 /* gcc -Wall:
 328  * for silencing unused variables that are actually used most of the time,
 329  * but we cannot quite get rid of, such as "ax" in PPCODE+noargs xsubs,
 330  * or variables/arguments that are used only in certain configurations.
 331  */
 332 #ifndef PERL_UNUSED_ARG
 333 #  define PERL_UNUSED_ARG(x) ((void)sizeof(x))
 334 #endif
 335 #ifndef PERL_UNUSED_VAR
 336 #  define PERL_UNUSED_VAR(x) ((void)sizeof(x))
 337 #endif
 338
 339 #if defined(USE_ITHREADS) || defined(PERL_GLOBAL_STRUCT)
 340 #  define PERL_UNUSED_CONTEXT PERL_UNUSED_ARG(my_perl)
 341 #else
 342 #  define PERL_UNUSED_CONTEXT
 343 #endif
 344
 345 /* gcc (-ansi) -pedantic doesn't allow gcc statement expressions,
 346  * g++ allows them but seems to have problems with them
 347  * (insane errors ensue).
 348  * g++ does not give insane errors now (RMB 2008-01-30, gcc 4.2.2).
 349  */
 350 #if defined(PERL_GCC_PEDANTIC) || \
 351     (defined(__GNUC__) && defined(__cplusplus) && \
 352         ((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2))))
 353 #  ifndef PERL_GCC_BRACE_GROUPS_FORBIDDEN
 354 #    define PERL_GCC_BRACE_GROUPS_FORBIDDEN
 355 #  endif
 356 #endif
 357
 358 /* Use PERL_UNUSED_RESULT() to suppress the warnings about unused results
 359  * of function calls, e.g. PERL_UNUSED_RESULT(foo(a, b)).
 360  *
 361  * The main reason for this is that the combination of gcc -Wunused-result
 362  * (part of -Wall) and the __attribute__((warn_unused_result)) cannot
 363  * be silenced with casting to void.  This causes trouble when the system
 364  * header files use the attribute.
 365  *
 366  * Use PERL_UNUSED_RESULT sparingly, though, since usually the warning
 367  * is there for a good reason: you might lose success/failure information,
 368  * or leak resources, or changes in resources.
 369  *
 370  * But sometimes you just want to ignore the return value, e.g. on
 371  * codepaths soon ending up in abort, or in "best effort" attempts,
 372  * or in situations where there is no good way to handle failures.
 373  *
 374  * Sometimes PERL_UNUSED_RESULT might not be the most natural way:
 375  * another possibility is that you can capture the return value
 376  * and use PERL_UNUSED_VAR on that.
 377  *
 378  * The __typeof__() is used instead of typeof() since typeof() is not
 379  * available under strict C89, and because of compilers masquerading
 380  * as gcc (clang and icc), we want exactly the gcc extension
 381  * __typeof__ and nothing else.
 382  */
 383 #ifndef PERL_UNUSED_RESULT
 384 #  if defined(__GNUC__) && defined(HASATTRIBUTE_WARN_UNUSED_RESULT)
 385 #    define PERL_UNUSED_RESULT(v) STMT_START { __typeof__(v) z = (v); (void)sizeof(z); } STMT_END
 386 #  else
 387 #    define PERL_UNUSED_RESULT(v) ((void)(v))
 388 #  endif
 389 #endif
 390
 391 /* on gcc (and clang), specify that a warning should be temporarily
 392  * ignored; e.g.
 393  *
 394  *    GCC_DIAG_IGNORE(-Wmultichar);
 395  *    char b = 'ab';
 396  *    GCC_DIAG_RESTORE;
 397  *
 398  * based on http://dbp-consulting.com/tutorials/SuppressingGCCWarnings.html
 399  *
 400  * Note that "pragma GCC diagnostic push/pop" was added in GCC 4.6, Mar 2011;
 401  * clang only pretends to be GCC 4.2, but still supports push/pop.
 402  *
 403  * Note on usage: on non-gcc (or lookalike, like clang) compilers
 404  * one cannot use these with a semicolon at file (global) level without
 405  * warnings since they are defined as empty, which leads into the terminating
 406  * semicolon being left alone on a line:
 407  * ;
 408  * which makes compilers mildly cranky.  Therefore at file level one
 409  * should use the GCC_DIAG_IGNORE and GCC_DIAG_RESTORE macros *without*
 410  * the semicolons.
 411  *
 412  * (A dead-on-arrival solution would be to try to define the macros as
 413  * NOOP or dNOOP, those don't work both inside functions and outside.)
 414  */
 415
 416 #if defined(__clang__) || defined(__clang) || \
 417        (defined( __GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406)
 418 #  define GCC_DIAG_PRAGMA(x) _Pragma (#x)
 419 /* clang has "clang diagnostic" pragmas, but also understands gcc. */
 420 #  define GCC_DIAG_IGNORE(x) _Pragma("GCC diagnostic push") \
 421                              GCC_DIAG_PRAGMA(GCC diagnostic ignored #x)
 422 #  define GCC_DIAG_RESTORE   _Pragma("GCC diagnostic pop")
 423 #else
 424 #  define GCC_DIAG_IGNORE(w)
 425 #  define GCC_DIAG_RESTORE
 426 #endif
 427 /* for clang specific pragmas */
 428 #if defined(__clang__) || defined(__clang)
 429 #  define CLANG_DIAG_PRAGMA(x) _Pragma (#x)
 430 #  define CLANG_DIAG_IGNORE(x) _Pragma("clang diagnostic push") \
 431                                CLANG_DIAG_PRAGMA(clang diagnostic ignored #x)
 432 #  define CLANG_DIAG_RESTORE   _Pragma("clang diagnostic pop")
 433 #else
 434 #  define CLANG_DIAG_IGNORE(w)
 435 #  define CLANG_DIAG_RESTORE
 436 #endif
 437
 438 #define NOOP /*EMPTY*/(void)0
 439 /* cea2e8a9dd23747f accidentally lost the comment originally from the first
 440    check in of thread.h, explaining why we need dNOOP at all:  */
 441 /* Rats: if dTHR is just blank then the subsequent ";" throws an error */
 442 /* Declaring a *function*, instead of a variable, ensures that we don't rely
 443    on being able to suppress "unused" warnings.  */
 444 #ifdef __cplusplus
 445 #define dNOOP (void)0
 446 #else
 447 #define dNOOP extern int Perl___notused(void)
 448 #endif
 449
 450 #ifndef pTHX
 451 /* Don't bother defining tTHX ; using it outside
 452  * code guarded by PERL_IMPLICIT_CONTEXT is an error.
 453  */
 454 #  define pTHX          void
 455 #  define pTHX_
 456 #  define aTHX
 457 #  define aTHX_
 458 #  define aTHXa(a)      NOOP
 459 #  define dTHXa(a)      dNOOP
 460 #  define dTHX          dNOOP
 461 #  define pTHX_1        1
 462 #  define pTHX_2        2
 463 #  define pTHX_3        3
 464 #  define pTHX_4        4
 465 #  define pTHX_5        5
 466 #  define pTHX_6        6
 467 #  define pTHX_7        7
 468 #  define pTHX_8        8
 469 #  define pTHX_9        9
 470 #  define pTHX_12       12
 471 #endif
 472
 473 #ifndef dVAR
 474 #  define dVAR          dNOOP
 475 #endif
 476
 477 /* these are only defined for compatibility; should not be used internally */
 478 #if !defined(pTHXo) && !defined(PERL_CORE)
 479 #  define pTHXo         pTHX
 480 #  define pTHXo_        pTHX_
 481 #  define aTHXo         aTHX
 482 #  define aTHXo_        aTHX_
 483 #  define dTHXo         dTHX
 484 #  define dTHXoa(x)     dTHXa(x)
 485 #endif
 486
 487 #ifndef pTHXx
 488 #  define pTHXx         PerlInterpreter *my_perl
 489 #  define pTHXx_        pTHXx,
 490 #  define aTHXx         my_perl
 491 #  define aTHXx_        aTHXx,
 492 #  define dTHXx         dTHX
 493 #endif
 494
 495 /* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
 496  * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
 497  * dTHXs is therefore needed for all functions using PerlIO_foo(). */
 498 #ifdef PERL_IMPLICIT_SYS
 499 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
 500 #    define dTHXs               dVAR; dTHX
 501 #  else
 502 #    define dTHXs               dTHX
 503 #  endif
 504 #else
 505 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
 506 #    define dTHXs               dVAR
 507 #  else
 508 #    define dTHXs               dNOOP
 509 #  endif
 510 #endif
 511
 512 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
 513 #  ifndef PERL_USE_GCC_BRACE_GROUPS
 514 #    define PERL_USE_GCC_BRACE_GROUPS
 515 #  endif
 516 #endif
 517
 518 /*
 519  * STMT_START { statements; } STMT_END;
 520  * can be used as a single statement, as in
 521  * if (x) STMT_START { ... } STMT_END; else ...
 522  *
 523  * Trying to select a version that gives no warnings...
 524  */
 525 #if !(defined(STMT_START) && defined(STMT_END))
 526 # ifdef PERL_USE_GCC_BRACE_GROUPS
 527 #   define STMT_START   (void)( /* gcc supports "({ STATEMENTS; })" */
 528 #   define STMT_END     )
 529 # else
 530 #   define STMT_START   do
 531 #   define STMT_END     while (0)
 532 # endif
 533 #endif
 534
 535 #ifndef BYTEORDER  /* Should never happen -- byteorder is in config.h */
 536 #   define BYTEORDER 0x1234
 537 #endif
 538
 539 /* Overall memory policy? */
 540 #ifndef CONSERVATIVE
 541 #   define LIBERAL 1
 542 #endif
 543
 544 #if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
 545 #define ASCIIish
 546 #else
 547 #undef  ASCIIish
 548 #endif
 549
 550 /*
 551  * The following contortions are brought to you on behalf of all the
 552  * standards, semi-standards, de facto standards, not-so-de-facto standards
 553  * of the world, as well as all the other botches anyone ever thought of.
 554  * The basic theory is that if we work hard enough here, the rest of the
 555  * code can be a lot prettier.  Well, so much for theory.  Sorry, Henry...
 556  */
 557
 558 /* define this once if either system, instead of cluttering up the src */
 559 #if defined(MSDOS) || defined(WIN32) || defined(NETWARE)
 560 #define DOSISH 1
 561 #endif
 562
 563 /* These exist only for back-compat with XS modules. */
 564 #ifndef PERL_CORE
 565 #define VOL volatile
 566 #define CAN_PROTOTYPE
 567 #define _(args) args
 568 #define I_LIMITS
 569 #define I_STDARG
 570 #define STANDARD_C
 571 #endif
 572
 573 /* By compiling a perl with -DNO_TAINT_SUPPORT or -DSILENT_NO_TAINT_SUPPORT,
 574  * you get a perl without taint support, but doubtlessly with a lesser
 575  * degree of support. Do not do so unless you know exactly what it means
 576  * technically, have a good reason to do so, and know exactly how the
 577  * perl will be used. perls with -DSILENT_NO_TAINT_SUPPORT are considered
 578  * a potential security risk due to flat out ignoring the security-relevant
 579  * taint flags. This being said, a perl without taint support compiled in
 580  * has marginal run-time performance benefits.
 581  * SILENT_NO_TAINT_SUPPORT implies NO_TAINT_SUPPORT.
 582  * SILENT_NO_TAINT_SUPPORT is the same as NO_TAINT_SUPPORT except it
 583  * silently ignores -t/-T instead of throwing an exception.
 584  *
 585  * DANGER! Using NO_TAINT_SUPPORT or SILENT_NO_TAINT_SUPPORT
 586  *         voids your nonexistent warranty!
 587  */
 588 #if defined(SILENT_NO_TAINT_SUPPORT) && !defined(NO_TAINT_SUPPORT)
 589 #  define NO_TAINT_SUPPORT 1
 590 #endif
 591
 592 /* NO_TAINT_SUPPORT can be set to transform virtually all taint-related
 593  * operations into no-ops for a very modest speed-up. Enable only if you
 594  * know what you're doing: tests and CPAN modules' tests are bound to fail.
 595  */
 596 #ifdef NO_TAINT_SUPPORT
 597 #   define TAINT                NOOP
 598 #   define TAINT_NOT            NOOP
 599 #   define TAINT_IF(c)          NOOP
 600 #   define TAINT_ENV()          NOOP
 601 #   define TAINT_PROPER(s)      NOOP
 602 #   define TAINT_set(s)         NOOP
 603 #   define TAINT_get            0
 604 #   define TAINTING_get         0
 605 #   define TAINTING_set(s)      NOOP
 606 #   define TAINT_WARN_get       0
 607 #   define TAINT_WARN_set(s)    NOOP
 608 #else
 609 #   define TAINT                (PL_tainted = PL_tainting)
 610 #   define TAINT_NOT    (PL_tainted = FALSE)
 611 #   define TAINT_IF(c)  if (UNLIKELY(c)) { PL_tainted = PL_tainting; }
 612 #   define TAINT_ENV()  if (UNLIKELY(PL_tainting)) { taint_env(); }
 613 #   define TAINT_PROPER(s)      if (UNLIKELY(PL_tainting)) { taint_proper(NULL, s); }
 614 #   define TAINT_set(s)         (PL_tainted = (s))
 615 #   define TAINT_get            (PL_tainted)
 616 #   define TAINTING_get         (PL_tainting)
 617 #   define TAINTING_set(s)      (PL_tainting = (s))
 618 #   define TAINT_WARN_get       (PL_taint_warn)
 619 #   define TAINT_WARN_set(s)    (PL_taint_warn = (s))
 620 #endif
 621
 622 /* flags used internally only within pp_subst and pp_substcont */
 623 #ifdef PERL_CORE
 624 #  define SUBST_TAINT_STR      1        /* string tainted */
 625 #  define SUBST_TAINT_PAT      2        /* pattern tainted */
 626 #  define SUBST_TAINT_REPL     4        /* replacement tainted */
 627 #  define SUBST_TAINT_RETAINT  8        /* use re'taint' in scope */
 628 #  define SUBST_TAINT_BOOLRET 16        /* return is boolean (don't taint) */
 629 #endif
 630
 631 /* XXX All process group stuff is handled in pp_sys.c.  Should these
 632    defines move there?  If so, I could simplify this a lot. --AD  9/96.
 633 */
 634 /* Process group stuff changed from traditional BSD to POSIX.
 635    perlfunc.pod documents the traditional BSD-style syntax, so we'll
 636    try to preserve that, if possible.
 637 */
 638 #ifdef HAS_SETPGID
 639 #  define BSD_SETPGRP(pid, pgrp)        setpgid((pid), (pgrp))
 640 #elif defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
 641 #  define BSD_SETPGRP(pid, pgrp)        setpgrp((pid), (pgrp))
 642 #elif defined(HAS_SETPGRP2)
 643 #  define BSD_SETPGRP(pid, pgrp)        setpgrp2((pid), (pgrp))
 644 #endif
 645 #if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
 646 #  define HAS_SETPGRP  /* Well, effectively it does . . . */
 647 #endif
 648
 649 /* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
 650     our life easier :-) so we'll try it.
 651 */
 652 #ifdef HAS_GETPGID
 653 #  define BSD_GETPGRP(pid)              getpgid((pid))
 654 #elif defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
 655 #  define BSD_GETPGRP(pid)              getpgrp((pid))
 656 #elif defined(HAS_GETPGRP2)
 657 #  define BSD_GETPGRP(pid)              getpgrp2((pid))
 658 #endif
 659 #if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
 660 #  define HAS_GETPGRP  /* Well, effectively it does . . . */
 661 #endif
 662
 663 /* These are not exact synonyms, since setpgrp() and getpgrp() may
 664    have different behaviors, but perl.h used to define USE_BSDPGRP
 665    (prior to 5.003_05) so some extension might depend on it.
 666 */
 667 #if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
 668 #  ifndef USE_BSDPGRP
 669 #    define USE_BSDPGRP
 670 #  endif
 671 #endif
 672
 673 /* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
 674    pthread.h must be included before all other header files.
 675 */
 676 #if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
 677 #  include <pthread.h>
 678 #endif
 679
 680 #include <sys/types.h>
 681
 682 /* EVC 4 SDK headers includes a bad definition of MB_CUR_MAX in stdlib.h
 683   which is included from stdarg.h. Bad definition not present in SD 2008
 684   SDK headers. wince.h is not yet included, so we cant fix this from there
 685   since by then MB_CUR_MAX will be defined from stdlib.h.
 686   cewchar.h includes a correct definition of MB_CUR_MAX and it is copied here
 687   since cewchar.h can't be included this early */
 688 #if defined(UNDER_CE) && (_MSC_VER < 1300)
 689 #  define MB_CUR_MAX 1
 690 #endif
 691
 692 # include <stdarg.h>
 693
 694 #ifdef I_STDINT
 695 # include <stdint.h>
 696 #endif
 697
 698 #include <ctype.h>
 699 #include <float.h>
 700 #include <limits.h>
 701
 702 #ifdef METHOD   /* Defined by OSF/1 v3.0 by ctype.h */
 703 #undef METHOD
 704 #endif
 705
 706 #ifdef PERL_MICRO
 707 #   define NO_LOCALE
 708 #endif
 709
 710 #ifdef I_LOCALE
 711 #   include <locale.h>
 712 #endif
 713
 714 #ifdef I_XLOCALE
 715 #   include <xlocale.h>
 716 #endif
 717
 718 #if !defined(NO_LOCALE) && defined(HAS_SETLOCALE)
 719 #   define USE_LOCALE
 720 #   define HAS_SKIP_LOCALE_INIT /* Solely for XS code to test for this
 721                                    capability */
 722 #   if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
 723        && defined(HAS_STRXFRM)
 724 #       define USE_LOCALE_COLLATE
 725 #   endif
 726 #   if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
 727 #       define USE_LOCALE_CTYPE
 728 #   endif
 729 #   if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
 730 #       define USE_LOCALE_NUMERIC
 731 #   endif
 732 #   if !defined(NO_LOCALE_MESSAGES) && defined(LC_MESSAGES)
 733 #       define USE_LOCALE_MESSAGES
 734 #   endif
 735 #   if !defined(NO_LOCALE_MONETARY) && defined(LC_MONETARY)
 736 #       define USE_LOCALE_MONETARY
 737 #   endif
 738 #   if !defined(NO_LOCALE_TIME) && defined(LC_TIME)
 739 #       define USE_LOCALE_TIME
 740 #   endif
 741 #endif /* !NO_LOCALE && HAS_SETLOCALE */
 742
 743 #include <setjmp.h>
 744
 745 #ifdef I_SYS_PARAM
 746 #   ifdef PARAM_NEEDS_TYPES
 747 #       include <sys/types.h>
 748 #   endif
 749 #   include <sys/param.h>
 750 #endif
 751
 752 /* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
 753    value something like 199306.  This may be useful if no more-specific
 754    feature test is available.
 755 */
 756 #if defined(BSD)
 757 #   ifndef BSDish
 758 #       define BSDish
 759 #   endif
 760 #endif
 761
 762 /* Use all the "standard" definitions */
 763 #include <stdlib.h>
 764
 765 /* If this causes problems, set i_unistd=undef in the hint file.  */
 766 #ifdef I_UNISTD
 767 #    if defined(__amigaos4__)
 768 #        ifdef I_NETINET_IN
 769 #            include <netinet/in.h>
 770 #        endif
 771 #   endif
 772 #   include <unistd.h>
 773 #   if defined(__amigaos4__)
 774 /* Under AmigaOS 4 newlib.library provides an environ.  However using
 775  * it doesn't give us enough control over inheritance of variables by
 776  * subshells etc. so replace with custom version based on abc-shell
 777  * code. */
 778 extern char **myenviron;
 779 #       undef environ
 780 #       define environ myenviron
 781 #   endif
 782 #endif
 783
 784 /* for WCOREDUMP */
 785 #ifdef I_SYS_WAIT
 786 #   include <sys/wait.h>
 787 #endif
 788
 789 #ifdef __SYMBIAN32__
 790 #   undef _SC_ARG_MAX /* Symbian has _SC_ARG_MAX but no sysconf() */
 791 #endif
 792
 793 #if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
 794 EXTERN_C int syscall(int, ...);
 795 #endif
 796
 797 #if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
 798 EXTERN_C int usleep(unsigned int);
 799 #endif
 800
 801 #ifdef PERL_CORE
 802
 803 /* macros for correct constant construction */
 804 # if INTSIZE >= 2
 805 #  define U16_CONST(x) ((U16)x##U)
 806 # else
 807 #  define U16_CONST(x) ((U16)x##UL)
 808 # endif
 809
 810 # if INTSIZE >= 4
 811 #  define U32_CONST(x) ((U32)x##U)
 812 # else
 813 #  define U32_CONST(x) ((U32)x##UL)
 814 # endif
 815
 816 # ifdef HAS_QUAD
 817 #  if INTSIZE >= 8
 818 #   define U64_CONST(x) ((U64)x##U)
 819 #  elif LONGSIZE >= 8
 820 #   define U64_CONST(x) ((U64)x##UL)
 821 #  elif QUADKIND == QUAD_IS_LONG_LONG
 822 #   define U64_CONST(x) ((U64)x##ULL)
 823 #  elif QUADKIND == QUAD_IS___INT64
 824 #   define U64_CONST(x) ((U64)x##UI64)
 825 #  else /* best guess we can make */
 826 #   define U64_CONST(x) ((U64)x##UL)
 827 #  endif
 828 # endif
 829
 830 /* byte-swapping functions for big-/little-endian conversion */
 831 # define _swab_16_(x) ((U16)( \
 832          (((U16)(x) & U16_CONST(0x00ff)) << 8) | \
 833          (((U16)(x) & U16_CONST(0xff00)) >> 8) ))
 834
 835 # define _swab_32_(x) ((U32)( \
 836          (((U32)(x) & U32_CONST(0x000000ff)) << 24) | \
 837          (((U32)(x) & U32_CONST(0x0000ff00)) <<  8) | \
 838          (((U32)(x) & U32_CONST(0x00ff0000)) >>  8) | \
 839          (((U32)(x) & U32_CONST(0xff000000)) >> 24) ))
 840
 841 # ifdef HAS_QUAD
 842 #  define _swab_64_(x) ((U64)( \
 843           (((U64)(x) & U64_CONST(0x00000000000000ff)) << 56) | \
 844           (((U64)(x) & U64_CONST(0x000000000000ff00)) << 40) | \
 845           (((U64)(x) & U64_CONST(0x0000000000ff0000)) << 24) | \
 846           (((U64)(x) & U64_CONST(0x00000000ff000000)) <<  8) | \
 847           (((U64)(x) & U64_CONST(0x000000ff00000000)) >>  8) | \
 848           (((U64)(x) & U64_CONST(0x0000ff0000000000)) >> 24) | \
 849           (((U64)(x) & U64_CONST(0x00ff000000000000)) >> 40) | \
 850           (((U64)(x) & U64_CONST(0xff00000000000000)) >> 56) ))
 851 # endif
 852
 853 /* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
 854    at least on FreeBSD.  YMMV, so experiment.  */
 855 #ifndef PERL_ARENA_SIZE
 856 #define PERL_ARENA_SIZE 4080
 857 #endif
 858
 859 /* Maximum level of recursion */
 860 #ifndef PERL_SUB_DEPTH_WARN
 861 #define PERL_SUB_DEPTH_WARN 100
 862 #endif
 863
 864 #endif /* PERL_CORE */
 865
 866 /* Maximum number of args that may be passed to an OP_MULTICONCAT op.
 867  * It determines the size of local arrays in S_maybe_multiconcat() and
 868  * pp_multiconcat().
 869  */
 870 #define PERL_MULTICONCAT_MAXARG 64
 871
 872 /* The indexes of fields of a multiconcat aux struct.
 873  * The fixed fields are followed by nargs+1 const segment lengths,
 874  * and if utf8 and non-utf8 differ, a second nargs+1 set for utf8.
 875  */
 876
 877 #define PERL_MULTICONCAT_IX_NARGS     0 /* number of arguments */
 878 #define PERL_MULTICONCAT_IX_PLAIN_PV  1 /* non-utf8 constant string */
 879 #define PERL_MULTICONCAT_IX_PLAIN_LEN 2 /* non-utf8 constant string length */
 880 #define PERL_MULTICONCAT_IX_UTF8_PV   3 /* utf8 constant string */
 881 #define PERL_MULTICONCAT_IX_UTF8_LEN  4 /* utf8 constant string length */
 882 #define PERL_MULTICONCAT_IX_LENGTHS   5 /* first of nargs+1 const segment lens */
 883 #define PERL_MULTICONCAT_HEADER_SIZE 5 /* The number of fields of a
 884                                            multiconcat header */
 885
 886 /* We no longer default to creating a new SV for GvSV.
 887    Do this before embed.  */
 888 #ifndef PERL_CREATE_GVSV
 889 #  ifndef PERL_DONT_CREATE_GVSV
 890 #    define PERL_DONT_CREATE_GVSV
 891 #  endif
 892 #endif
 893
 894 #if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
 895 #define PERL_USES_PL_PIDSTATUS
 896 #endif
 897
 898 #if !defined(OS2) && !defined(WIN32) && !defined(DJGPP) && !defined(__SYMBIAN32__)
 899 #define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
 900 #endif
 901
 902 #define MEM_SIZE Size_t
 903
 904 /* Round all values passed to malloc up, by default to a multiple of
 905    sizeof(size_t)
 906 */
 907 #ifndef PERL_STRLEN_ROUNDUP_QUANTUM
 908 #define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
 909 #endif
 910
 911 /* sv_grow() will expand strings by at least a certain percentage of
 912    the previously *used* length to avoid excessive calls to realloc().
 913    The default is 25% of the current length.
 914 */
 915 #ifndef PERL_STRLEN_EXPAND_SHIFT
 916 #  define PERL_STRLEN_EXPAND_SHIFT 2
 917 #endif
 918
 919 #include <stddef.h>
 920 #define STRUCT_OFFSET(s,m)  offsetof(s,m)
 921
 922 /* ptrdiff_t is C11, so undef it under pedantic builds */
 923 #ifdef PERL_GCC_PEDANTIC
 924 #   undef HAS_PTRDIFF_T
 925 #endif
 926
 927 #ifndef __SYMBIAN32__
 928 #  include <string.h>
 929 #endif
 930
 931 /* This comes after <stdlib.h> so we don't try to change the standard
 932  * library prototypes; we'll use our own in proto.h instead. */
 933
 934 #ifdef MYMALLOC
 935 #  ifdef PERL_POLLUTE_MALLOC
 936 #   ifndef PERL_EXTMALLOC_DEF
 937 #    define Perl_malloc         malloc
 938 #    define Perl_calloc         calloc
 939 #    define Perl_realloc        realloc
 940 #    define Perl_mfree          free
 941 #   endif
 942 #  else
 943 #    define EMBEDMYMALLOC       /* for compatibility */
 944 #  endif
 945
 946 #  define safemalloc  Perl_malloc
 947 #  define safecalloc  Perl_calloc
 948 #  define saferealloc Perl_realloc
 949 #  define safefree    Perl_mfree
 950 #  define CHECK_MALLOC_TOO_LATE_FOR_(code)      STMT_START {            \
 951         if (!PL_tainting && MallocCfg_ptr[MallocCfg_cfg_env_read])      \
 952                 code;                                                   \
 953     } STMT_END
 954 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)                         \
 955         CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
 956 #  define panic_write2(s)               write(2, s, strlen(s))
 957 #  define CHECK_MALLOC_TAINT(newval)                            \
 958         CHECK_MALLOC_TOO_LATE_FOR_(                             \
 959                 if (newval) {                                   \
 960                   PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
 961                   exit(1); })
 962 #  define MALLOC_CHECK_TAINT(argc,argv,env)     STMT_START {    \
 963         if (doing_taint(argc,argv,env)) {                       \
 964                 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1;      \
 965     }} STMT_END;
 966 #else  /* MYMALLOC */
 967 #  define safemalloc  safesysmalloc
 968 #  define safecalloc  safesyscalloc
 969 #  define saferealloc safesysrealloc
 970 #  define safefree    safesysfree
 971 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)         ((void)0)
 972 #  define CHECK_MALLOC_TAINT(newval)            ((void)0)
 973 #  define MALLOC_CHECK_TAINT(argc,argv,env)
 974 #endif /* MYMALLOC */
 975
 976 /* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
 977 #define TOO_LATE_FOR_(ch,what)  Perl_croak(aTHX_ "\"-%c\" is on the #! line, it must also be used on the command line%s", (char)(ch), what)
 978 #define TOO_LATE_FOR(ch)        TOO_LATE_FOR_(ch, "")
 979 #define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
 980 #define MALLOC_CHECK_TAINT2(argc,argv)  MALLOC_CHECK_TAINT(argc,argv,NULL)
 981
 982 #ifndef memzero
 983 #   define memzero(d,l) memset(d,0,l)
 984 #endif
 985
 986 #ifdef I_NETINET_IN
 987 #   include <netinet/in.h>
 988 #endif
 989
 990 #ifdef I_ARPA_INET
 991 #   include <arpa/inet.h>
 992 #endif
 993
 994 #ifdef I_SYS_STAT
 995 #   include <sys/stat.h>
 996 #endif
 997
 998 /* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
 999    This definition should ideally go into win32/win32.h, but S_IFIFO is
1000    used later here in perl.h before win32/win32.h is being included. */
1001 #if !defined(S_IFIFO) && defined(_S_IFIFO)
1002 #   define S_IFIFO _S_IFIFO
1003 #endif
1004
1005 /* The stat macros for Unisoft System V/88 (and derivatives
1006    like UTekV) are broken, sometimes giving false positives.  Undefine
1007    them here and let the code below set them to proper values.
1008
1009    The ghs macro stands for GreenHills Software C-1.8.5 which
1010    is the C compiler for sysV88 and the various derivatives.
1011    This header file bug is corrected in gcc-2.5.8 and later versions.
1012    --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94.  */
1013
1014 #if defined(m88k) && defined(ghs)
1015 #   undef S_ISDIR
1016 #   undef S_ISCHR
1017 #   undef S_ISBLK
1018 #   undef S_ISREG
1019 #   undef S_ISFIFO
1020 #   undef S_ISLNK
1021 #endif
1022
1023 #include <time.h>
1024
1025 #ifdef I_SYS_TIME
1026 #   ifdef I_SYS_TIME_KERNEL
1027 #       define KERNEL
1028 #   endif
1029 #   include <sys/time.h>
1030 #   ifdef I_SYS_TIME_KERNEL
1031 #       undef KERNEL
1032 #   endif
1033 #endif
1034
1035 #if defined(HAS_TIMES) && defined(I_SYS_TIMES)
1036 #    include <sys/times.h>
1037 #endif
1038
1039 #include <errno.h>
1040
1041 #if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
1042 #  define WIN32SCK_IS_STDSCK            /* don't pull in custom wsock layer */
1043 #endif
1044
1045 #if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1046 # include <sys/socket.h>
1047 # if defined(USE_SOCKS) && defined(I_SOCKS)
1048 #   if !defined(INCLUDE_PROTOTYPES)
1049 #       define INCLUDE_PROTOTYPES /* for <socks.h> */
1050 #       define PERL_SOCKS_NEED_PROTOTYPES
1051 #   endif
1052 #   include <socks.h>
1053 #   ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1054 #       undef INCLUDE_PROTOTYPES
1055 #       undef PERL_SOCKS_NEED_PROTOTYPES
1056 #   endif
1057 # endif
1058 # ifdef I_NETDB
1059 #  ifdef NETWARE
1060 #   include<stdio.h>
1061 #  endif
1062 #  include <netdb.h>
1063 # endif
1064 # ifndef ENOTSOCK
1065 #  ifdef I_NET_ERRNO
1066 #   include <net/errno.h>
1067 #  endif
1068 # endif
1069 #endif
1070
1071 /* sockatmark() is so new (2001) that many places might have it hidden
1072  * behind some -D_BLAH_BLAH_SOURCE guard.  The __THROW magic is required
1073  * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
1074 #if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
1075 # if defined(__THROW) && defined(__GLIBC__)
1076 int sockatmark(int) __THROW;
1077 # else
1078 int sockatmark(int);
1079 # endif
1080 #endif
1081
1082 #if defined(__osf__) && defined(__cplusplus) && !defined(_XOPEN_SOURCE_EXTENDED) /* Tru64 "cxx" (C++), see hints/dec_osf.sh for why the _XOPEN_SOURCE_EXTENDED cannot be defined. */
1083 EXTERN_C int fchdir(int);
1084 EXTERN_C int flock(int, int);
1085 EXTERN_C int fseeko(FILE *, off_t, int);
1086 EXTERN_C off_t ftello(FILE *);
1087 #endif
1088
1089 #if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1090 EXTERN_C char *crypt(const char *, const char *);
1091 #endif
1092
1093 #if defined(__cplusplus) && defined(__CYGWIN__)
1094 EXTERN_C char *crypt(const char *, const char *);
1095 #endif
1096
1097 #ifdef SETERRNO
1098 # undef SETERRNO  /* SOCKS might have defined this */
1099 #endif
1100
1101 #ifdef VMS
1102 #   define SETERRNO(errcode,vmserrcode) \
1103         STMT_START {                    \
1104             set_errno(errcode);         \
1105             set_vaxc_errno(vmserrcode); \
1106         } STMT_END
1107 #   define dSAVEDERRNO    int saved_errno; unsigned saved_vms_errno
1108 #   define dSAVE_ERRNO    int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1109 #   define SAVE_ERRNO     ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1110 #   define RESTORE_ERRNO  SETERRNO(saved_errno, saved_vms_errno)
1111
1112 #   define LIB_INVARG           LIB$_INVARG
1113 #   define RMS_DIR              RMS$_DIR
1114 #   define RMS_FAC              RMS$_FAC
1115 #   define RMS_FEX              RMS$_FEX
1116 #   define RMS_FNF              RMS$_FNF
1117 #   define RMS_IFI              RMS$_IFI
1118 #   define RMS_ISI              RMS$_ISI
1119 #   define RMS_PRV              RMS$_PRV
1120 #   define SS_ACCVIO            SS$_ACCVIO
1121 #   define SS_DEVOFFLINE        SS$_DEVOFFLINE
1122 #   define SS_IVCHAN            SS$_IVCHAN
1123 #   define SS_NORMAL            SS$_NORMAL
1124 #   define SS_NOPRIV            SS$_NOPRIV
1125 #   define SS_BUFFEROVF         SS$_BUFFEROVF
1126 #else
1127 #   define LIB_INVARG           0
1128 #   define RMS_DIR              0
1129 #   define RMS_FAC              0
1130 #   define RMS_FEX              0
1131 #   define RMS_FNF              0
1132 #   define RMS_IFI              0
1133 #   define RMS_ISI              0
1134 #   define RMS_PRV              0
1135 #   define SS_ACCVIO            0
1136 #   define SS_DEVOFFLINE        0
1137 #   define SS_IVCHAN            0
1138 #   define SS_NORMAL            0
1139 #   define SS_NOPRIV            0
1140 #   define SS_BUFFEROVF         0
1141 #endif
1142
1143 #ifdef WIN32
1144 #   define dSAVEDERRNO  int saved_errno; DWORD saved_win32_errno
1145 #   define dSAVE_ERRNO  int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1146 #   define SAVE_ERRNO   ( saved_errno = errno, saved_win32_errno = GetLastError() )
1147 #   define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1148 #endif
1149
1150 #ifdef OS2
1151 #   define dSAVEDERRNO  int saved_errno; unsigned long saved_os2_errno
1152 #   define dSAVE_ERRNO  int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1153 #   define SAVE_ERRNO   ( saved_errno = errno, saved_os2_errno = Perl_rc )
1154 #   define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1155 #endif
1156
1157 #ifndef SETERRNO
1158 #   define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1159 #endif
1160
1161 #ifndef dSAVEDERRNO
1162 #   define dSAVEDERRNO    int saved_errno
1163 #   define dSAVE_ERRNO    int saved_errno = errno
1164 #   define SAVE_ERRNO     (saved_errno = errno)
1165 #   define RESTORE_ERRNO  (errno = saved_errno)
1166 #endif
1167
1168 #define ERRSV GvSVn(PL_errgv)
1169
1170 /* contains inlined gv_add_by_type */
1171 #define CLEAR_ERRSV() STMT_START {                                      \
1172     SV ** const svp = &GvSV(PL_errgv);                                  \
1173     if (!*svp) {                                                        \
1174         *svp = newSVpvs("");                                            \
1175     } else if (SvREADONLY(*svp)) {                                      \
1176         SvREFCNT_dec_NN(*svp);                                          \
1177         *svp = newSVpvs("");                                            \
1178     } else {                                                            \
1179         SV *const errsv = *svp;                                         \
1180         SvPVCLEAR(errsv);                                               \
1181         SvPOK_only(errsv);                                              \
1182         if (SvMAGICAL(errsv)) {                                         \
1183             mg_free(errsv);                                             \
1184         }                                                               \
1185     }                                                                   \
1186     } STMT_END
1187
1188
1189 #ifdef PERL_CORE
1190 # define DEFSV (0 + GvSVn(PL_defgv))
1191 # define DEFSV_set(sv) \
1192     (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1193 # define SAVE_DEFSV                \
1194     (                               \
1195         save_gp(PL_defgv, 0),        \
1196         GvINTRO_off(PL_defgv),        \
1197         SAVEGENERICSV(GvSV(PL_defgv)), \
1198         GvSV(PL_defgv) = NULL           \
1199     )
1200 #else
1201 # define DEFSV GvSVn(PL_defgv)
1202 # define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1203 # define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
1204 #endif
1205
1206 #ifndef errno
1207         extern int errno;     /* ANSI allows errno to be an lvalue expr.
1208                                * For example in multithreaded environments
1209                                * something like this might happen:
1210                                * extern int *_errno(void);
1211                                * #define errno (*_errno()) */
1212 #endif
1213
1214 #define UNKNOWN_ERRNO_MSG "(unknown)"
1215
1216 #if VMS
1217 #define Strerror(e) strerror((e), vaxc$errno)
1218 #else
1219 #define Strerror(e) strerror(e)
1220 #endif
1221
1222 #ifdef I_SYS_IOCTL
1223 #   ifndef _IOCTL_
1224 #       include <sys/ioctl.h>
1225 #   endif
1226 #endif
1227
1228 #if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
1229 #   ifdef HAS_SOCKETPAIR
1230 #       undef HAS_SOCKETPAIR
1231 #   endif
1232 #   ifdef I_NDBM
1233 #       undef I_NDBM
1234 #   endif
1235 #endif
1236
1237 #ifndef HAS_SOCKETPAIR
1238 #   ifdef HAS_SOCKET
1239 #       define socketpair Perl_my_socketpair
1240 #   endif
1241 #endif
1242
1243 #if INTSIZE == 2
1244 #   define htoni htons
1245 #   define ntohi ntohs
1246 #else
1247 #   define htoni htonl
1248 #   define ntohi ntohl
1249 #endif
1250
1251 /* Configure already sets Direntry_t */
1252 #if defined(I_DIRENT)
1253 #  include <dirent.h>
1254 #elif defined(I_SYS_NDIR)
1255 #  include <sys/ndir.h>
1256 #elif defined(I_SYS_DIR)
1257 #  include <sys/dir.h>
1258 #endif
1259
1260 /*
1261  * The following gobbledygook brought to you on behalf of __STDC__.
1262  * (I could just use #ifndef __STDC__, but this is more bulletproof
1263  * in the face of half-implementations.)
1264  */
1265
1266 #if defined(I_SYSMODE)
1267 #include <sys/mode.h>
1268 #endif
1269
1270 #ifndef S_IFMT
1271 #   ifdef _S_IFMT
1272 #       define S_IFMT _S_IFMT
1273 #   else
1274 #       define S_IFMT 0170000
1275 #   endif
1276 #endif
1277
1278 #ifndef S_ISDIR
1279 #   define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1280 #endif
1281
1282 #ifndef S_ISCHR
1283 #   define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1284 #endif
1285
1286 #ifndef S_ISBLK
1287 #   ifdef S_IFBLK
1288 #       define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1289 #   else
1290 #       define S_ISBLK(m) (0)
1291 #   endif
1292 #endif
1293
1294 #ifndef S_ISREG
1295 #   define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1296 #endif
1297
1298 #ifndef S_ISFIFO
1299 #   ifdef S_IFIFO
1300 #       define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1301 #   else
1302 #       define S_ISFIFO(m) (0)
1303 #   endif
1304 #endif
1305
1306 #ifndef S_ISLNK
1307 #  ifdef _S_ISLNK
1308 #    define S_ISLNK(m) _S_ISLNK(m)
1309 #  elif defined(_S_IFLNK)
1310 #    define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1311 #  elif defined(S_IFLNK)
1312 #    define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1313 #  else
1314 #    define S_ISLNK(m) (0)
1315 #  endif
1316 #endif
1317
1318 #ifndef S_ISSOCK
1319 #  ifdef _S_ISSOCK
1320 #    define S_ISSOCK(m) _S_ISSOCK(m)
1321 #  elif defined(_S_IFSOCK)
1322 #    define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1323 #  elif defined(S_IFSOCK)
1324 #    define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1325 #  else
1326 #    define S_ISSOCK(m) (0)
1327 #  endif
1328 #endif
1329
1330 #ifndef S_IRUSR
1331 #   ifdef S_IREAD
1332 #       define S_IRUSR S_IREAD
1333 #       define S_IWUSR S_IWRITE
1334 #       define S_IXUSR S_IEXEC
1335 #   else
1336 #       define S_IRUSR 0400
1337 #       define S_IWUSR 0200
1338 #       define S_IXUSR 0100
1339 #   endif
1340 #endif
1341
1342 #ifndef S_IRGRP
1343 #   ifdef S_IRUSR
1344 #       define S_IRGRP (S_IRUSR>>3)
1345 #       define S_IWGRP (S_IWUSR>>3)
1346 #       define S_IXGRP (S_IXUSR>>3)
1347 #   else
1348 #       define S_IRGRP 0040
1349 #       define S_IWGRP 0020
1350 #       define S_IXGRP 0010
1351 #   endif
1352 #endif
1353
1354 #ifndef S_IROTH
1355 #   ifdef S_IRUSR
1356 #       define S_IROTH (S_IRUSR>>6)
1357 #       define S_IWOTH (S_IWUSR>>6)
1358 #       define S_IXOTH (S_IXUSR>>6)
1359 #   else
1360 #       define S_IROTH 0040
1361 #       define S_IWOTH 0020
1362 #       define S_IXOTH 0010
1363 #   endif
1364 #endif
1365
1366 #ifndef S_ISUID
1367 #   define S_ISUID 04000
1368 #endif
1369
1370 #ifndef S_ISGID
1371 #   define S_ISGID 02000
1372 #endif
1373
1374 #ifndef S_IRWXU
1375 #   define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
1376 #endif
1377
1378 #ifndef S_IRWXG
1379 #   define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
1380 #endif
1381
1382 #ifndef S_IRWXO
1383 #   define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
1384 #endif
1385
1386 /* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
1387  * which would get included through <sys/file.h >, but that is 3000
1388  * lines in the future.  --jhi */
1389
1390 #if !defined(S_IREAD) && !defined(__HAIKU__)
1391 #   define S_IREAD S_IRUSR
1392 #endif
1393
1394 #if !defined(S_IWRITE) && !defined(__HAIKU__)
1395 #   define S_IWRITE S_IWUSR
1396 #endif
1397
1398 #ifndef S_IEXEC
1399 #   define S_IEXEC S_IXUSR
1400 #endif
1401
1402 #if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
1403 #   define SLOPPYDIVIDE
1404 #endif
1405
1406 #ifdef UV
1407 #undef UV
1408 #endif
1409
1410 /* This used to be conditionally defined based on whether we had a sprintf()
1411  * that correctly returns the string length (as required by C89), but we no
1412  * longer need that. XS modules can (and do) use this name, so it must remain
1413  * a part of the API that's visible to modules. But we no longer document it
1414  * either (because using sprintf() rather than snprintf() is almost always
1415  * a bad idea). */
1416 #define my_sprintf sprintf
1417
1418 /*
1419  * If we have v?snprintf() and the C99 variadic macros, we can just
1420  * use just the v?snprintf().  It is nice to try to trap the buffer
1421  * overflow, however, so if we are DEBUGGING, and we cannot use the
1422  * gcc statement expressions, then use the function wrappers which try
1423  * to trap the overflow.  If we can use the gcc statement expressions,
1424  * we can try that even with the version that uses the C99 variadic
1425  * macros.
1426  */
1427
1428 /* Note that we do not check against snprintf()/vsnprintf() returning
1429  * negative values because that is non-standard behaviour and we now
1430  * assume a working C89 implementation. */
1431
1432 #define PERL_SNPRINTF_CHECK(len, max, api) STMT_START { if ((max) > 0 && (Size_t)len > (max)) Perl_croak_nocontext("panic: %s buffer overflow", STRINGIFY(api)); } STMT_END
1433
1434 #ifdef USE_QUADMATH
1435 #  define my_snprintf Perl_my_snprintf
1436 #  define PERL_MY_SNPRINTF_GUARDED
1437 #elif defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1438 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1439 #      define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1440 #      define PERL_MY_SNPRINTF_GUARDED
1441 #  else
1442 #    define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
1443 #  endif
1444 #else
1445 #  define my_snprintf  Perl_my_snprintf
1446 #  define PERL_MY_SNPRINTF_GUARDED
1447 #endif
1448
1449 /* There is no quadmath_vsnprintf, and therefore my_vsnprintf()
1450  * dies if called under USE_QUADMATH. */
1451 #if defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1452 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1453 #      define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1454 #      define PERL_MY_VSNPRINTF_GUARDED
1455 #  else
1456 #    define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
1457 #  endif
1458 #else
1459 #  define my_vsnprintf Perl_my_vsnprintf
1460 #  define PERL_MY_VSNPRINTF_GUARDED
1461 #endif
1462
1463 /* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1464  * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1465  * the result of my_snprintf() or my_vsnprintf().  (No, you should not
1466  * completely ignore it: otherwise you cannot know whether your output
1467  * was too long.)
1468  *
1469  * int len = my_sprintf(buf, max, ...);
1470  * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1471  *
1472  * The trick is that in certain platforms [a] the my_sprintf() already
1473  * contains the sanity check, while in certain platforms [b] it needs
1474  * to be done as a separate step.  The POST_GUARD is that step-- in [a]
1475  * platforms the POST_GUARD actually does nothing since the check has
1476  * already been done.  Watch out for the max being the same in both calls.
1477  *
1478  * If you actually use the snprintf/vsnprintf return value already,
1479  * you assumedly are checking its validity somehow.  But you can
1480  * insert the POST_GUARD() also in that case. */
1481
1482 #ifndef PERL_MY_SNPRINTF_GUARDED
1483 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1484 #else
1485 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1486 #endif
1487
1488 #ifndef  PERL_MY_VSNPRINTF_GUARDED
1489 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
1490 #else
1491 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1492 #endif
1493
1494 #ifdef HAS_STRLCAT
1495 #  define my_strlcat    strlcat
1496 #else
1497 #  define my_strlcat    Perl_my_strlcat
1498 #endif
1499
1500 #if defined(PERL_CORE) || defined(PERL_EXT)
1501 #  ifdef HAS_MEMRCHR
1502 #    define my_memrchr  memrchr
1503 #  else
1504 #    define my_memrchr  S_my_memrchr
1505 #  endif
1506 #endif
1507
1508 #ifdef HAS_STRLCPY
1509 #  define my_strlcpy    strlcpy
1510 #else
1511 #  define my_strlcpy    Perl_my_strlcpy
1512 #endif
1513
1514 #ifdef HAS_STRNLEN
1515 #  define my_strnlen    strnlen
1516 #else
1517 #  define my_strnlen    Perl_my_strnlen
1518 #endif
1519
1520 /*
1521     The IV type is supposed to be long enough to hold any integral
1522     value or a pointer.
1523     --Andy Dougherty    August 1996
1524 */
1525
1526 typedef IVTYPE IV;
1527 typedef UVTYPE UV;
1528
1529 #if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
1530 #  if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
1531 #    define IV_MAX INT64_MAX
1532 #    define IV_MIN INT64_MIN
1533 #    define UV_MAX UINT64_MAX
1534 #    ifndef UINT64_MIN
1535 #      define UINT64_MIN 0
1536 #    endif
1537 #    define UV_MIN UINT64_MIN
1538 #  else
1539 #    define IV_MAX PERL_QUAD_MAX
1540 #    define IV_MIN PERL_QUAD_MIN
1541 #    define UV_MAX PERL_UQUAD_MAX
1542 #    define UV_MIN PERL_UQUAD_MIN
1543 #  endif
1544 #  define IV_IS_QUAD
1545 #  define UV_IS_QUAD
1546 #else
1547 #  if defined(INT32_MAX) && IVSIZE == 4
1548 #    define IV_MAX INT32_MAX
1549 #    define IV_MIN INT32_MIN
1550 #    ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
1551 #        define UV_MAX UINT32_MAX
1552 #    else
1553 #        define UV_MAX 4294967295U
1554 #    endif
1555 #    ifndef UINT32_MIN
1556 #      define UINT32_MIN 0
1557 #    endif
1558 #    define UV_MIN UINT32_MIN
1559 #  else
1560 #    define IV_MAX PERL_LONG_MAX
1561 #    define IV_MIN PERL_LONG_MIN
1562 #    define UV_MAX PERL_ULONG_MAX
1563 #    define UV_MIN PERL_ULONG_MIN
1564 #  endif
1565 #  if IVSIZE == 8
1566 #    define IV_IS_QUAD
1567 #    define UV_IS_QUAD
1568 #    ifndef HAS_QUAD
1569 #      define HAS_QUAD
1570 #    endif
1571 #  else
1572 #    undef IV_IS_QUAD
1573 #    undef UV_IS_QUAD
1574 #if !defined(PERL_CORE) || defined(USING_MSVC6)
1575 /* We think that removing this decade-old undef this will cause too much
1576    breakage on CPAN for too little gain. (See RT #119753)
1577    However, we do need HAS_QUAD in the core for use by the drand48 code,
1578    but not for Win32 VC6 because it has poor __int64 support. */
1579 #    undef HAS_QUAD
1580 #endif
1581 #  endif
1582 #endif
1583
1584 #define Size_t_MAX (~(Size_t)0)
1585 #define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
1586
1587 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
1588 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
1589
1590 #ifndef NO_PERL_PRESERVE_IVUV
1591 #define PERL_PRESERVE_IVUV      /* We like our integers to stay integers. */
1592 #endif
1593
1594 /*
1595  *  The macros INT2PTR and NUM2PTR are (despite their names)
1596  *  bi-directional: they will convert int/float to or from pointers.
1597  *  However the conversion to int/float are named explicitly:
1598  *  PTR2IV, PTR2UV, PTR2NV.
1599  *
1600  *  For int conversions we do not need two casts if pointers are
1601  *  the same size as IV and UV.   Otherwise we need an explicit
1602  *  cast (PTRV) to avoid compiler warnings.
1603  */
1604 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1605 #  define PTRV                  UV
1606 #  define INT2PTR(any,d)        (any)(d)
1607 #elif PTRSIZE == LONGSIZE
1608 #  define PTRV                  unsigned long
1609 #  define PTR2ul(p)             (unsigned long)(p)
1610 #else
1611 #  define PTRV                  unsigned
1612 #endif
1613
1614 #ifndef INT2PTR
1615 #  define INT2PTR(any,d)        (any)(PTRV)(d)
1616 #endif
1617
1618 #ifndef PTR2ul
1619 #  define PTR2ul(p)     INT2PTR(unsigned long,p)
1620 #endif
1621
1622 #define NUM2PTR(any,d)  (any)(PTRV)(d)
1623 #define PTR2IV(p)       INT2PTR(IV,p)
1624 #define PTR2UV(p)       INT2PTR(UV,p)
1625 #define PTR2NV(p)       NUM2PTR(NV,p)
1626 #define PTR2nat(p)      (PTRV)(p)       /* pointer to integer of PTRSIZE */
1627
1628 /* According to strict ANSI C89 one cannot freely cast between
1629  * data pointers and function (code) pointers.  There are at least
1630  * two ways around this.  One (used below) is to do two casts,
1631  * first the other pointer to an (unsigned) integer, and then
1632  * the integer to the other pointer.  The other way would be
1633  * to use unions to "overlay" the pointers.  For an example of
1634  * the latter technique, see union dirpu in struct xpvio in sv.h.
1635  * The only feasible use is probably temporarily storing
1636  * function pointers in a data pointer (such as a void pointer). */
1637
1638 #define DPTR2FPTR(t,p) ((t)PTR2nat(p))  /* data pointer to function pointer */
1639 #define FPTR2DPTR(t,p) ((t)PTR2nat(p))  /* function pointer to data pointer */
1640
1641 #ifdef USE_LONG_DOUBLE
1642 #  if LONG_DOUBLESIZE == DOUBLESIZE
1643 #    define LONG_DOUBLE_EQUALS_DOUBLE
1644 #    undef USE_LONG_DOUBLE /* Ouch! */
1645 #  endif
1646 #endif
1647
1648 /* The following is all to get LDBL_DIG, in order to pick a nice
1649    default value for printing floating point numbers in Gconvert.
1650    (see config.h)
1651 */
1652 #ifndef HAS_LDBL_DIG
1653 #  if LONG_DOUBLESIZE == 10
1654 #    define LDBL_DIG 18 /* assume IEEE */
1655 #  elif LONG_DOUBLESIZE == 12
1656 #    define LDBL_DIG 18 /* gcc? */
1657 #  elif LONG_DOUBLESIZE == 16
1658 #    define LDBL_DIG 33 /* assume IEEE */
1659 #  elif LONG_DOUBLESIZE == DOUBLESIZE
1660 #    define LDBL_DIG DBL_DIG /* bummer */
1661 #  endif
1662 #endif
1663
1664 typedef NVTYPE NV;
1665
1666 #ifdef I_IEEEFP
1667 #   include <ieeefp.h>
1668 #endif
1669
1670 #ifdef USING_MSVC6
1671 /* VC6 has broken NaN semantics: NaN == NaN returns true instead of false,
1672  * and for example NaN < IV_MIN. */
1673 #  define NAN_COMPARE_BROKEN
1674 #endif
1675 #if defined(__DECC) && defined(__osf__)
1676 /* Also Tru64 cc has broken NaN comparisons. */
1677 #  define NAN_COMPARE_BROKEN
1678 #endif
1679 #if defined(__sgi)
1680 #  define NAN_COMPARE_BROKEN
1681 #endif
1682
1683 #ifdef USE_LONG_DOUBLE
1684 #   ifdef I_SUNMATH
1685 #       include <sunmath.h>
1686 #   endif
1687 #   if defined(LDBL_DIG)
1688 #       define NV_DIG LDBL_DIG
1689 #       ifdef LDBL_MANT_DIG
1690 #           define NV_MANT_DIG LDBL_MANT_DIG
1691 #       endif
1692 #       ifdef LDBL_MIN
1693 #           define NV_MIN LDBL_MIN
1694 #       endif
1695 #       ifdef LDBL_MAX
1696 #           define NV_MAX LDBL_MAX
1697 #       endif
1698 #       ifdef LDBL_MIN_EXP
1699 #           define NV_MIN_EXP LDBL_MIN_EXP
1700 #       endif
1701 #       ifdef LDBL_MAX_EXP
1702 #           define NV_MAX_EXP LDBL_MAX_EXP
1703 #       endif
1704 #       ifdef LDBL_MIN_10_EXP
1705 #           define NV_MIN_10_EXP LDBL_MIN_10_EXP
1706 #       endif
1707 #       ifdef LDBL_MAX_10_EXP
1708 #           define NV_MAX_10_EXP LDBL_MAX_10_EXP
1709 #       endif
1710 #       ifdef LDBL_EPSILON
1711 #           define NV_EPSILON LDBL_EPSILON
1712 #       endif
1713 #       ifdef LDBL_MAX
1714 #           define NV_MAX LDBL_MAX
1715 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
1716 #       elif defined(HUGE_VALL)
1717 #           define NV_MAX HUGE_VALL
1718 #       endif
1719 #   endif
1720 #   if defined(HAS_SQRTL)
1721 #       define Perl_acos acosl
1722 #       define Perl_asin asinl
1723 #       define Perl_atan atanl
1724 #       define Perl_atan2 atan2l
1725 #       define Perl_ceil ceill
1726 #       define Perl_cos cosl
1727 #       define Perl_cosh coshl
1728 #       define Perl_exp expl
1729 /* no Perl_fabs, but there's PERL_ABS */
1730 #       define Perl_floor floorl
1731 #       define Perl_fmod fmodl
1732 #       define Perl_log logl
1733 #       define Perl_log10 log10l
1734 #       define Perl_pow powl
1735 #       define Perl_sin sinl
1736 #       define Perl_sinh sinhl
1737 #       define Perl_sqrt sqrtl
1738 #       define Perl_tan tanl
1739 #       define Perl_tanh tanhl
1740 #   endif
1741 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
1742 #   ifndef Perl_modf
1743 #       ifdef HAS_MODFL
1744 #           define Perl_modf(x,y) modfl(x,y)
1745 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
1746    prototype in <math.h> */
1747 #           ifndef HAS_MODFL_PROTO
1748 EXTERN_C long double modfl(long double, long double *);
1749 #           endif
1750 #       elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
1751         extern long double Perl_my_modfl(long double x, long double *ip);
1752 #           define Perl_modf(x,y) Perl_my_modfl(x,y)
1753 #       endif
1754 #   endif
1755 #   ifndef Perl_frexp
1756 #       ifdef HAS_FREXPL
1757 #           define Perl_frexp(x,y) frexpl(x,y)
1758 #       elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
1759 extern long double Perl_my_frexpl(long double x, int *e);
1760 #           define Perl_frexp(x,y) Perl_my_frexpl(x,y)
1761 #       endif
1762 #   endif
1763 #   ifndef Perl_ldexp
1764 #       ifdef HAS_LDEXPL
1765 #           define Perl_ldexp(x, y) ldexpl(x,y)
1766 #       elif defined(HAS_SCALBNL) && FLT_RADIX == 2
1767 #           define Perl_ldexp(x,y) scalbnl(x,y)
1768 #       endif
1769 #   endif
1770 #   ifndef Perl_isnan
1771 #       if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
1772 #           define Perl_isnan(x) isnanl(x)
1773 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
1774 #           define Perl_isnan(x) isnan(x)
1775 #       endif
1776 #   endif
1777 #   ifndef Perl_isinf
1778 #       if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
1779 #           define Perl_isinf(x) isinfl(x)
1780 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
1781 #           define Perl_isinf(x) isinf(x)
1782 #       elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
1783 #           define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
1784 #       endif
1785 #   endif
1786 #   ifndef Perl_isfinite
1787 #       define Perl_isfinite(x) Perl_isfinitel(x)
1788 #   endif
1789 #elif defined(USE_QUADMATH) && defined(I_QUADMATH)
1790 #   include <quadmath.h>
1791 #   define NV_DIG FLT128_DIG
1792 #   define NV_MANT_DIG FLT128_MANT_DIG
1793 #   define NV_MIN FLT128_MIN
1794 #   define NV_MAX FLT128_MAX
1795 #   define NV_MIN_EXP FLT128_MIN_EXP
1796 #   define NV_MAX_EXP FLT128_MAX_EXP
1797 #   define NV_EPSILON FLT128_EPSILON
1798 #   define NV_MIN_10_EXP FLT128_MIN_10_EXP
1799 #   define NV_MAX_10_EXP FLT128_MAX_10_EXP
1800 #   define Perl_acos acosq
1801 #   define Perl_asin asinq
1802 #   define Perl_atan atanq
1803 #   define Perl_atan2 atan2q
1804 #   define Perl_ceil ceilq
1805 #   define Perl_cos cosq
1806 #   define Perl_cosh coshq
1807 #   define Perl_exp expq
1808 /* no Perl_fabs, but there's PERL_ABS */
1809 #   define Perl_floor floorq
1810 #   define Perl_fmod fmodq
1811 #   define Perl_log logq
1812 #   define Perl_log10 log10q
1813 #   define Perl_pow powq
1814 #   define Perl_sin sinq
1815 #   define Perl_sinh sinhq
1816 #   define Perl_sqrt sqrtq
1817 #   define Perl_tan tanq
1818 #   define Perl_tanh tanhq
1819 #   define Perl_modf(x,y) modfq(x,y)
1820 #   define Perl_frexp(x,y) frexpq(x,y)
1821 #   define Perl_ldexp(x, y) ldexpq(x,y)
1822 #   define Perl_isinf(x) isinfq(x)
1823 #   define Perl_isnan(x) isnanq(x)
1824 #   define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
1825 #   define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
1826 #   define Perl_fp_class_inf(x)    (Perl_fp_class(x) == 3)
1827 #   define Perl_fp_class_nan(x)    (Perl_fp_class(x) == 4)
1828 #   define Perl_fp_class_norm(x)   (Perl_fp_class(x) == 1)
1829 #   define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
1830 #   define Perl_fp_class_zero(x)   (Perl_fp_class(x) == 0)
1831 #else
1832 #   define NV_DIG DBL_DIG
1833 #   define NV_MANT_DIG DBL_MANT_DIG
1834 #   define NV_MIN DBL_MIN
1835 #   define NV_MAX DBL_MAX
1836 #   define NV_MIN_EXP DBL_MIN_EXP
1837 #   define NV_MAX_EXP DBL_MAX_EXP
1838 #   define NV_MIN_10_EXP DBL_MIN_10_EXP
1839 #   define NV_MAX_10_EXP DBL_MAX_10_EXP
1840 #   define NV_EPSILON DBL_EPSILON
1841 #   define NV_MAX DBL_MAX
1842 #   define NV_MIN DBL_MIN
1843
1844 /* These math interfaces are C89. */
1845 #   define Perl_acos acos
1846 #   define Perl_asin asin
1847 #   define Perl_atan atan
1848 #   define Perl_atan2 atan2
1849 #   define Perl_ceil ceil
1850 #   define Perl_cos cos
1851 #   define Perl_cosh cosh
1852 #   define Perl_exp exp
1853 /* no Perl_fabs, but there's PERL_ABS */
1854 #   define Perl_floor floor
1855 #   define Perl_fmod fmod
1856 #   define Perl_log log
1857 #   define Perl_log10 log10
1858 #   define Perl_pow pow
1859 #   define Perl_sin sin
1860 #   define Perl_sinh sinh
1861 #   define Perl_sqrt sqrt
1862 #   define Perl_tan tan
1863 #   define Perl_tanh tanh
1864
1865 #   define Perl_modf(x,y) modf(x,y)
1866 #   define Perl_frexp(x,y) frexp(x,y)
1867 #   define Perl_ldexp(x,y) ldexp(x,y)
1868
1869 #   ifndef Perl_isnan
1870 #       ifdef HAS_ISNAN
1871 #           define Perl_isnan(x) isnan(x)
1872 #       endif
1873 #   endif
1874 #   ifndef Perl_isinf
1875 #       if defined(HAS_ISINF)
1876 #           define Perl_isinf(x) isinf(x)
1877 #       elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
1878 #           define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
1879 #       endif
1880 #   endif
1881 #   ifndef Perl_isfinite
1882 #     ifdef HAS_ISFINITE
1883 #       define Perl_isfinite(x) isfinite(x)
1884 #     elif defined(HAS_FINITE)
1885 #       define Perl_isfinite(x) finite(x)
1886 #     endif
1887 #   endif
1888 #endif
1889
1890 /* fpclassify(): C99.  It is supposed to be a macro that switches on
1891 * the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
1892 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
1893 #    include <math.h>
1894 #    if defined(FP_INFINITE) && defined(FP_NAN)
1895 #        define Perl_fp_class(x)        fpclassify(x)
1896 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
1897 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
1898 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
1899 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
1900 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
1901 #    elif defined(FP_PLUS_INF) && defined(FP_QNAN)
1902 /* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
1903  * actually not the C99 fpclassify, with its own set of return defines. */
1904 #        define Perl_fp_class(x)        fpclassify(x)
1905 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PLUS_INF)
1906 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_MINUS_INF)
1907 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
1908 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
1909 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PLUS_NORM)
1910 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_MINUS_NORM)
1911 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PLUS_DENORM)
1912 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_MINUS_DENORM)
1913 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PLUS_ZERO)
1914 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_MINUS_ZERO)
1915 #    else
1916 #        undef Perl_fp_class /* Unknown set of defines */
1917 #    endif
1918 #endif
1919
1920 /* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
1921  * are identical to the C99 fpclassify(). */
1922 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
1923 #    include <math.h>
1924 #    ifdef __VMS
1925      /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
1926 #        include <fp.h>
1927      /* oh, and the isnormal macro has a typo in it! */
1928 #    undef isnormal
1929 #    define isnormal(x) Perl_fp_class_norm(x)
1930 #    endif
1931 #    if defined(FP_INFINITE) && defined(FP_NAN)
1932 #        define Perl_fp_class(x)        fp_classify(x)
1933 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
1934 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
1935 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
1936 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
1937 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
1938 #    else
1939 #        undef Perl_fp_class /* Unknown set of defines */
1940 #    endif
1941 #endif
1942
1943 /* Feel free to check with me for the SGI manpages, SGI testing,
1944  * etcetera, if you want to try getting this to work with IRIX.
1945  *
1946  * - Allen <allens@cpan.org> */
1947
1948 /* fpclass(): SysV, at least Solaris and some versions of IRIX. */
1949 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
1950 /* Solaris and IRIX have fpclass/fpclassl, but they are using
1951  * an enum typedef, not cpp symbols, and Configure doesn't detect that.
1952  * Define some symbols also as cpp symbols so we can detect them. */
1953 #    if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
1954 #     define FP_PINF FP_PINF
1955 #     define FP_QNAN FP_QNAN
1956 #    endif
1957 #    include <math.h>
1958 #    ifdef I_IEEFP
1959 #        include <ieeefp.h>
1960 #    endif
1961 #    ifdef I_FP
1962 #        include <fp.h>
1963 #    endif
1964 #    if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
1965 #        define Perl_fp_class(x)        fpclassl(x)
1966 #    else
1967 #        define Perl_fp_class(x)        fpclass(x)
1968 #    endif
1969 #    if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
1970 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_CLASS_SNAN)
1971 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_CLASS_QNAN)
1972 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_CLASS_NINF)
1973 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_CLASS_PINF)
1974 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_CLASS_NNORM)
1975 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_CLASS_PNORM)
1976 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_CLASS_NDENORM)
1977 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_CLASS_PDENORM)
1978 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_CLASS_NZERO)
1979 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_CLASS_PZERO)
1980 #    elif defined(FP_PINF) && defined(FP_QNAN)
1981 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
1982 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
1983 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_NINF)
1984 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PINF)
1985 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_NNORM)
1986 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PNORM)
1987 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_NDENORM)
1988 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PDENORM)
1989 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_NZERO)
1990 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PZERO)
1991 #    else
1992 #        undef Perl_fp_class /* Unknown set of defines */
1993 #    endif
1994 #endif
1995
1996 /* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
1997 #if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
1998 #    include <math.h>
1999 #    if !defined(FP_SNAN) && defined(I_FP_CLASS)
2000 #        include <fp_class.h>
2001 #    endif
2002 #    if defined(FP_POS_INF) && defined(FP_QNAN)
2003 #        ifdef __sgi /* XXX Configure test instead */
2004 #            ifdef USE_LONG_DOUBLE
2005 #                define Perl_fp_class(x)        fp_class_l(x)
2006 #            else
2007 #                define Perl_fp_class(x)        fp_class_d(x)
2008 #            endif
2009 #        else
2010 #            if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2011 #                define Perl_fp_class(x)        fp_classl(x)
2012 #            else
2013 #                define Perl_fp_class(x)        fp_class(x)
2014 #            endif
2015 #        endif
2016 #        if defined(FP_POS_INF) && defined(FP_QNAN)
2017 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_SNAN)
2018 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_QNAN)
2019 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_NEG_INF)
2020 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_POS_INF)
2021 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_NEG_NORM)
2022 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_POS_NORM)
2023 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_NEG_DENORM)
2024 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_POS_DENORM)
2025 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_NEG_ZERO)
2026 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_POS_ZERO)
2027 #        else
2028 #            undef Perl_fp_class /* Unknown set of defines */
2029 #        endif
2030 #    endif
2031 #endif
2032
2033 /* class(), _class(): Legacy: AIX. */
2034 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2035 #    include <math.h>
2036 #    if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2037 #        ifndef _cplusplus
2038 #            define Perl_fp_class(x)    class(x)
2039 #        else
2040 #            define Perl_fp_class(x)    _class(x)
2041 #        endif
2042 #        if defined(FP_PLUS_INF) && defined(FP_NANQ)
2043 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_NANS)
2044 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_NANQ)
2045 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_MINUS_INF)
2046 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_PLUS_INF)
2047 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_MINUS_NORM)
2048 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_PLUS_NORM)
2049 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_MINUS_DENORM)
2050 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_PLUS_DENORM)
2051 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_MINUS_ZERO)
2052 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_PLUS_ZERO)
2053 #        else
2054 #            undef Perl_fp_class /* Unknown set of defines */
2055 #        endif
2056 #    endif
2057 #endif
2058
2059 /* Win32: _fpclass(), _isnan(), _finite(). */
2060 #ifdef WIN32
2061 #  ifndef Perl_isnan
2062 #    define Perl_isnan(x) _isnan(x)
2063 #  endif
2064 #  ifndef Perl_isfinite
2065 #    define Perl_isfinite(x) _finite(x)
2066 #  endif
2067 #  ifndef Perl_fp_class_snan
2068 /* No simple way to #define Perl_fp_class because _fpclass()
2069  * returns a set of bits. */
2070 #    define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2071 #    define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
2072 #    define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
2073 #    define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF))
2074 #    define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF))
2075 #    define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2076 #    define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2077 #    define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2078 #    define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2079 #    define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2080 #    define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2081 #    define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2082 #    define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2083 #    define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2084 #    define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2085 #  endif
2086 #endif
2087
2088 #if !defined(Perl_fp_class_inf) && \
2089   defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2090 #  define Perl_fp_class_inf(x) \
2091     (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2092 #endif
2093
2094 #if !defined(Perl_fp_class_nan) && \
2095   defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2096 #  define Perl_fp_class_nan(x) \
2097     (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2098 #endif
2099
2100 #if !defined(Perl_fp_class_zero) && \
2101   defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2102 #  define Perl_fp_class_zero(x) \
2103     (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2104 #endif
2105
2106 #if !defined(Perl_fp_class_norm) && \
2107   defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2108 #  define Perl_fp_class_norm(x) \
2109     (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2110 #endif
2111
2112 #if !defined(Perl_fp_class_denorm) && \
2113   defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2114 #  define Perl_fp_class_denorm(x) \
2115     (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
2116 #endif
2117
2118 #ifdef UNDER_CE
2119 int isnan(double d);
2120 #endif
2121
2122 #ifndef Perl_isnan
2123 #   ifdef Perl_fp_class_nan
2124 #       define Perl_isnan(x) Perl_fp_class_nan(x)
2125 #   elif defined(HAS_UNORDERED)
2126 #       define Perl_isnan(x) unordered((x), 0.0)
2127 #   else
2128 #       define Perl_isnan(x) ((x)!=(x))
2129 #   endif
2130 #endif
2131
2132 #ifndef Perl_isinf
2133 #   ifdef Perl_fp_class_inf
2134 #       define Perl_isinf(x) Perl_fp_class_inf(x)
2135 #   endif
2136 #endif
2137
2138 #ifndef Perl_isfinite
2139 #   if defined(HAS_ISFINITE) && !defined(isfinite)
2140 #     define Perl_isfinite(x) isfinite((double)(x))
2141 #   elif defined(HAS_FINITE)
2142 #       define Perl_isfinite(x) finite((double)(x))
2143 #   elif defined(Perl_fp_class_finite)
2144 #     define Perl_isfinite(x) Perl_fp_class_finite(x)
2145 #   else
2146 /* For the infinities the multiplication returns nan,
2147  * for the nan the multiplication also returns nan,
2148  * for everything else (that is, finite) zero should be returned. */
2149 #     define Perl_isfinite(x) (((x) * 0) == 0)
2150 #   endif
2151 #endif
2152
2153 #ifndef Perl_isinf
2154 #   if defined(Perl_isfinite) && defined(Perl_isnan)
2155 #       define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2156 #   endif
2157 #endif
2158
2159 /* We need Perl_isfinitel (ends with ell) (if available) even when
2160  * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2161  * needs that. */
2162 #if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2163 /* If isfinite() is a macro and looks like we have C99,
2164  * we assume it's the type-aware C99 isfinite(). */
2165 #    if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
2166 #        define Perl_isfinitel(x) isfinite(x)
2167 #    elif defined(HAS_ISFINITEL)
2168 #        define Perl_isfinitel(x) isfinitel(x)
2169 #    elif defined(HAS_FINITEL)
2170 #        define Perl_isfinitel(x) finitel(x)
2171 #    elif defined(HAS_INFL) && defined(HAS_NANL)
2172 #        define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
2173 #    else
2174 #        define Perl_isfinitel(x) ((x) * 0 == 0)  /* See Perl_isfinite. */
2175 #    endif
2176 #endif
2177
2178 /* The default is to use Perl's own atof() implementation (in numeric.c).
2179  * Usually that is the one to use but for some platforms (e.g. UNICOS)
2180  * it is however best to use the native implementation of atof.
2181  * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2182  * Some good tests to try out with either setting are t/base/num.t,
2183  * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2184  * you may need to be using a different function than atof! */
2185
2186 #ifndef USE_PERL_ATOF
2187 #   ifndef _UNICOS
2188 #       define USE_PERL_ATOF
2189 #   endif
2190 #else
2191 #   if USE_PERL_ATOF == 0
2192 #       undef USE_PERL_ATOF
2193 #   endif
2194 #endif
2195
2196 #ifdef USE_PERL_ATOF
2197 #   define Perl_atof(s) Perl_my_atof(s)
2198 #   define Perl_atof2(s, n) Perl_my_atof2(aTHX_ (s), &(n))
2199 #else
2200 #   define Perl_atof(s) (NV)atof(s)
2201 #   define Perl_atof2(s, n) ((n) = atof(s))
2202 #endif
2203
2204 /*
2205  * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2206  * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2207  * depending on local options. Until Configure detects this (or at least
2208  * detects whether the "signed" keyword is available) the CHAR ranges
2209  * will not be included. UCHAR functions normally.
2210  *                                                           - kja
2211  */
2212
2213 #define PERL_UCHAR_MIN ((unsigned char)0)
2214 #define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2215
2216 #define PERL_USHORT_MIN ((unsigned short)0)
2217 #define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2218
2219 #define PERL_SHORT_MAX ((short)SHRT_MAX)
2220 #define PERL_SHORT_MIN ((short)SHRT_MIN)
2221
2222 #define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2223 #define PERL_UINT_MIN ((unsigned int)0)
2224
2225 #define PERL_INT_MAX ((int)INT_MAX)
2226 #define PERL_INT_MIN ((int)INT_MIN)
2227
2228 #define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2229 #define PERL_ULONG_MIN ((unsigned long)0L)
2230
2231 #define PERL_LONG_MAX ((long)LONG_MAX)
2232 #define PERL_LONG_MIN ((long)LONG_MIN)
2233
2234 #ifdef UV_IS_QUAD
2235 #    define PERL_UQUAD_MAX      (~(UV)0)
2236 #    define PERL_UQUAD_MIN      ((UV)0)
2237 #    define PERL_QUAD_MAX       ((IV) (PERL_UQUAD_MAX >> 1))
2238 #    define PERL_QUAD_MIN       (-PERL_QUAD_MAX - ((3 & -1) == 3))
2239 #endif
2240
2241 typedef MEM_SIZE STRLEN;
2242
2243 typedef struct op OP;
2244 typedef struct cop COP;
2245 typedef struct unop UNOP;
2246 typedef struct unop_aux UNOP_AUX;
2247 typedef struct binop BINOP;
2248 typedef struct listop LISTOP;
2249 typedef struct logop LOGOP;
2250 typedef struct pmop PMOP;
2251 typedef struct svop SVOP;
2252 typedef struct padop PADOP;
2253 typedef struct pvop PVOP;
2254 typedef struct loop LOOP;
2255 typedef struct methop METHOP;
2256
2257 #ifdef PERL_CORE
2258 typedef struct opslab OPSLAB;
2259 typedef struct opslot OPSLOT;
2260 #endif
2261
2262 typedef struct block_hooks BHK;
2263 typedef struct custom_op XOP;
2264
2265 typedef struct interpreter PerlInterpreter;
2266
2267 /* SGI's <sys/sema.h> has struct sv */
2268 #if defined(__sgi)
2269 #   define STRUCT_SV perl_sv
2270 #else
2271 #   define STRUCT_SV sv
2272 #endif
2273 typedef struct STRUCT_SV SV;
2274 typedef struct av AV;
2275 typedef struct hv HV;
2276 typedef struct cv CV;
2277 typedef struct p5rx REGEXP;
2278 typedef struct gp GP;
2279 typedef struct gv GV;
2280 typedef struct io IO;
2281 typedef struct context PERL_CONTEXT;
2282 typedef struct block BLOCK;
2283
2284 typedef struct magic MAGIC;
2285 typedef struct xpv XPV;
2286 typedef struct xpviv XPVIV;
2287 typedef struct xpvuv XPVUV;
2288 typedef struct xpvnv XPVNV;
2289 typedef struct xpvmg XPVMG;
2290 typedef struct xpvlv XPVLV;
2291 typedef struct xpvinvlist XINVLIST;
2292 typedef struct xpvav XPVAV;
2293 typedef struct xpvhv XPVHV;
2294 typedef struct xpvgv XPVGV;
2295 typedef struct xpvcv XPVCV;
2296 typedef struct xpvbm XPVBM;
2297 typedef struct xpvfm XPVFM;
2298 typedef struct xpvio XPVIO;
2299 typedef struct mgvtbl MGVTBL;
2300 typedef union any ANY;
2301 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2302 typedef struct ptr_tbl PTR_TBL_t;
2303 typedef struct clone_params CLONE_PARAMS;
2304
2305 /* a pad is currently just an AV; but that might change,
2306  * so hide the type.  */
2307 typedef struct padlist PADLIST;
2308 typedef AV PAD;
2309 typedef struct padnamelist PADNAMELIST;
2310 typedef struct padname PADNAME;
2311
2312 /* enable PERL_OP_PARENT by default */
2313 #if !defined(PERL_OP_PARENT) && !defined(PERL_NO_OP_PARENT)
2314 #  define PERL_OP_PARENT
2315 #endif
2316
2317 /* enable PERL_COPY_ON_WRITE by default */
2318 #if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2319 #  define PERL_COPY_ON_WRITE
2320 #endif
2321
2322 #ifdef PERL_COPY_ON_WRITE
2323 #  define PERL_ANY_COW
2324 #else
2325 # define PERL_SAWAMPERSAND
2326 #endif
2327
2328 #if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2329 # error PERL_DEBUG_READONLY_OPS only works with ithreads
2330 #endif
2331
2332 #include "handy.h"
2333 #include "charclass_invlists.h"
2334
2335 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2336 #   if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2337 #       define USE_64_BIT_RAWIO /* implicit */
2338 #   endif
2339 #endif
2340
2341 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2342  * fseeko/ftello if possible.  Don't go #defining ftell to ftello yourself,
2343  * however, because operating systems like to do that themself. */
2344 #ifndef FSEEKSIZE
2345 #   ifdef HAS_FSEEKO
2346 #       define FSEEKSIZE LSEEKSIZE
2347 #   else
2348 #       define FSEEKSIZE LONGSIZE
2349 #   endif
2350 #endif
2351
2352 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2353 #   if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2354 #       define USE_64_BIT_STDIO /* implicit */
2355 #   endif
2356 #endif
2357
2358 #ifdef USE_64_BIT_RAWIO
2359 #   ifdef HAS_OFF64_T
2360 #       undef Off_t
2361 #       define Off_t off64_t
2362 #       undef LSEEKSIZE
2363 #       define LSEEKSIZE 8
2364 #   endif
2365 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2366  * will trigger defines like the ones below.  Some 64-bit environments,
2367  * however, do not.  Therefore we have to explicitly mix and match. */
2368 #   if defined(USE_OPEN64)
2369 #       define open open64
2370 #   endif
2371 #   if defined(USE_LSEEK64)
2372 #       define lseek lseek64
2373 #   else
2374 #       if defined(USE_LLSEEK)
2375 #           define lseek llseek
2376 #       endif
2377 #   endif
2378 #   if defined(USE_STAT64)
2379 #       define stat stat64
2380 #   endif
2381 #   if defined(USE_FSTAT64)
2382 #       define fstat fstat64
2383 #   endif
2384 #   if defined(USE_LSTAT64)
2385 #       define lstat lstat64
2386 #   endif
2387 #   if defined(USE_FLOCK64)
2388 #       define flock flock64
2389 #   endif
2390 #   if defined(USE_LOCKF64)
2391 #       define lockf lockf64
2392 #   endif
2393 #   if defined(USE_FCNTL64)
2394 #       define fcntl fcntl64
2395 #   endif
2396 #   if defined(USE_TRUNCATE64)
2397 #       define truncate truncate64
2398 #   endif
2399 #   if defined(USE_FTRUNCATE64)
2400 #       define ftruncate ftruncate64
2401 #   endif
2402 #endif
2403
2404 #ifdef USE_64_BIT_STDIO
2405 #   ifdef HAS_FPOS64_T
2406 #       undef Fpos_t
2407 #       define Fpos_t fpos64_t
2408 #   endif
2409 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2410  * will trigger defines like the ones below.  Some 64-bit environments,
2411  * however, do not. */
2412 #   if defined(USE_FOPEN64)
2413 #       define fopen fopen64
2414 #   endif
2415 #   if defined(USE_FSEEK64)
2416 #       define fseek fseek64 /* don't do fseeko here, see perlio.c */
2417 #   endif
2418 #   if defined(USE_FTELL64)
2419 #       define ftell ftell64 /* don't do ftello here, see perlio.c */
2420 #   endif
2421 #   if defined(USE_FSETPOS64)
2422 #       define fsetpos fsetpos64
2423 #   endif
2424 #   if defined(USE_FGETPOS64)
2425 #       define fgetpos fgetpos64
2426 #   endif
2427 #   if defined(USE_TMPFILE64)
2428 #       define tmpfile tmpfile64
2429 #   endif
2430 #   if defined(USE_FREOPEN64)
2431 #       define freopen freopen64
2432 #   endif
2433 #endif
2434
2435 #if defined(OS2)
2436 #  include "iperlsys.h"
2437 #endif
2438
2439 #ifdef DOSISH
2440 #   if defined(OS2)
2441 #       include "os2ish.h"
2442 #   else
2443 #       include "dosish.h"
2444 #   endif
2445 #elif defined(VMS)
2446 #   include "vmsish.h"
2447 #elif defined(PLAN9)
2448 #   include "./plan9/plan9ish.h"
2449 #elif defined(__VOS__)
2450 #   ifdef __GNUC__
2451 #     include "./vos/vosish.h"
2452 #   else
2453 #     include "vos/vosish.h"
2454 #   endif
2455 #elif defined(__SYMBIAN32__)
2456 #   include "symbian/symbianish.h"
2457 #elif defined(__HAIKU__)
2458 #   include "haiku/haikuish.h"
2459 #else
2460 #   include "unixish.h"
2461 #endif
2462
2463 #ifdef __amigaos4__
2464 #    include "amigaos.h"
2465 #    undef FD_CLOEXEC /* a lie in AmigaOS */
2466 #endif
2467
2468 /* NSIG logic from Configure --> */
2469 #ifndef NSIG
2470 #  ifdef _NSIG
2471 #    define NSIG (_NSIG)
2472 #  elif defined(SIGMAX)
2473 #    define NSIG (SIGMAX+1)
2474 #  elif defined(SIG_MAX)
2475 #    define NSIG (SIG_MAX+1)
2476 #  elif defined(_SIG_MAX)
2477 #    define NSIG (_SIG_MAX+1)
2478 #  elif defined(MAXSIG)
2479 #    define NSIG (MAXSIG+1)
2480 #  elif defined(MAX_SIG)
2481 #    define NSIG (MAX_SIG+1)
2482 #  elif defined(SIGARRAYSIZE)
2483 #    define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
2484 #  elif defined(_sys_nsig)
2485 #    define NSIG (_sys_nsig) /* Solaris 2.5 */
2486 #  else
2487      /* Default to some arbitrary number that's big enough to get most
2488       * of the common signals.  */
2489 #    define NSIG 50
2490 #  endif
2491 #endif
2492 /* <-- NSIG logic from Configure */
2493
2494 #ifndef NO_ENVIRON_ARRAY
2495 #  define USE_ENVIRON_ARRAY
2496 #endif
2497
2498 /*
2499  * initialise to avoid floating-point exceptions from overflow, etc
2500  */
2501 #ifndef PERL_FPU_INIT
2502 #  ifdef HAS_FPSETMASK
2503 #    if HAS_FLOATINGPOINT_H
2504 #      include <floatingpoint.h>
2505 #    endif
2506 /* Some operating systems have this as a macro, which in turn expands to a comma
2507    expression, and the last sub-expression is something that gets calculated,
2508    and then they have the gall to warn that a value computed is not used. Hence
2509    cast to void.  */
2510 #    define PERL_FPU_INIT (void)fpsetmask(0)
2511 #  elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2512 #    define PERL_FPU_INIT       PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2513 #    define PERL_FPU_PRE_EXEC   { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2514 #    define PERL_FPU_POST_EXEC    rsignal_restore(SIGFPE, &xfpe); }
2515 #  else
2516 #    define PERL_FPU_INIT
2517 #  endif
2518 #endif
2519 #ifndef PERL_FPU_PRE_EXEC
2520 #  define PERL_FPU_PRE_EXEC   {
2521 #  define PERL_FPU_POST_EXEC  }
2522 #endif
2523
2524 /* In Tru64 the cc -ieee enables the IEEE math but disables traps.
2525  * We need to reenable the "invalid" trap because otherwise generation
2526  * of NaN values leaves the IEEE fp flags in bad state, leaving any further
2527  * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
2528 #ifdef __osf__
2529 #  include <machine/fpu.h>
2530 #  define PERL_SYS_FPU_INIT \
2531      STMT_START { \
2532          ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
2533          signal(SIGFPE, SIG_IGN); \
2534      } STMT_END
2535 #endif
2536 /* In IRIX the default for Flush to Zero bit is true,
2537  * which means that results going below the minimum of normal
2538  * floating points go to zero, instead of going denormal/subnormal.
2539  * This is unlike almost any other system running Perl, so let's clear it.
2540  * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
2541  * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
2542  *
2543  * XXX The flush-to-zero behaviour should be a Configure scan.
2544  * To change the behaviour usually requires some system-specific
2545  * incantation, though, like the below. */
2546 #ifdef __sgi
2547 #  include <sys/fpu.h>
2548 #  define PERL_SYS_FPU_INIT \
2549      STMT_START { \
2550          union fpc_csr csr; \
2551          csr.fc_word = get_fpc_csr(); \
2552          csr.fc_struct.flush = 0; \
2553          set_fpc_csr(csr.fc_word); \
2554      } STMT_END
2555 #endif
2556
2557 #ifndef PERL_SYS_FPU_INIT
2558 #  define PERL_SYS_FPU_INIT NOOP
2559 #endif
2560
2561 #ifndef PERL_SYS_INIT3_BODY
2562 #  define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
2563 #endif
2564
2565 /*
2566 =head1 Miscellaneous Functions
2567
2568 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
2569 Provides system-specific tune up of the C runtime environment necessary to
2570 run Perl interpreters.  This should be called only once, before creating
2571 any Perl interpreters.
2572
2573 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
2574 Provides system-specific tune up of the C runtime environment necessary to
2575 run Perl interpreters.  This should be called only once, before creating
2576 any Perl interpreters.
2577
2578 =for apidoc Am|void|PERL_SYS_TERM|
2579 Provides system-specific clean up of the C runtime environment after
2580 running Perl interpreters.  This should be called only once, after
2581 freeing any remaining Perl interpreters.
2582
2583 =cut
2584  */
2585
2586 #define PERL_SYS_INIT(argc, argv)       Perl_sys_init(argc, argv)
2587 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
2588 #define PERL_SYS_TERM()                 Perl_sys_term()
2589
2590 #ifndef PERL_WRITE_MSG_TO_CONSOLE
2591 #  define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
2592 #endif
2593
2594 #ifndef MAXPATHLEN
2595 #  ifdef PATH_MAX
2596 #    ifdef _POSIX_PATH_MAX
2597 #       if PATH_MAX > _POSIX_PATH_MAX
2598 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
2599  * included the null byte or not.  Later amendments of POSIX,
2600  * XPG4, the Austin Group, and the Single UNIX Specification
2601  * all explicitly include the null byte in the PATH_MAX.
2602  * Ditto for _POSIX_PATH_MAX. */
2603 #         define MAXPATHLEN PATH_MAX
2604 #       else
2605 #         define MAXPATHLEN _POSIX_PATH_MAX
2606 #       endif
2607 #    else
2608 #      define MAXPATHLEN (PATH_MAX+1)
2609 #    endif
2610 #  else
2611 #    define MAXPATHLEN 1024     /* Err on the large side. */
2612 #  endif
2613 #endif
2614
2615 /* In case Configure was not used (we are using a "canned config"
2616  * such as Win32, or a cross-compilation setup, for example) try going
2617  * by the gcc major and minor versions.  One useful URL is
2618  * http://www.ohse.de/uwe/articles/gcc-attributes.html,
2619  * but contrary to this information warn_unused_result seems
2620  * not to be in gcc 3.3.5, at least. --jhi
2621  * Also, when building extensions with an installed perl, this allows
2622  * the user to upgrade gcc and get the right attributes, rather than
2623  * relying on the list generated at Configure time.  --AD
2624  * Set these up now otherwise we get confused when some of the <*thread.h>
2625  * includes below indirectly pull in <perlio.h> (which needs to know if we
2626  * have HASATTRIBUTE_FORMAT).
2627  */
2628
2629 #ifndef PERL_MICRO
2630 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
2631 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
2632 #    define HASATTRIBUTE_DEPRECATED
2633 #  endif
2634 #  if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
2635 #    define HASATTRIBUTE_FORMAT
2636 #    if defined __MINGW32__
2637 #      define PRINTF_FORMAT_NULL_OK
2638 #    endif
2639 #  endif
2640 #  if __GNUC__ >= 3 /* 3.0 -> */
2641 #    define HASATTRIBUTE_MALLOC
2642 #  endif
2643 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
2644 #    define HASATTRIBUTE_NONNULL
2645 #  endif
2646 #  if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
2647 #    define HASATTRIBUTE_NORETURN
2648 #  endif
2649 #  if __GNUC__ >= 3 /* gcc 3.0 -> */
2650 #    define HASATTRIBUTE_PURE
2651 #  endif
2652 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2653 #    define HASATTRIBUTE_UNUSED
2654 #  endif
2655 #  if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
2656 #    define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
2657 #  endif
2658 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2659 #    define HASATTRIBUTE_WARN_UNUSED_RESULT
2660 #  endif
2661 #endif
2662 #endif /* #ifndef PERL_MICRO */
2663
2664 /* USE_5005THREADS needs to be after unixish.h as <pthread.h> includes
2665  * <sys/signal.h> which defines NSIG - which will stop inclusion of <signal.h>
2666  * this results in many functions being undeclared which bothers C++
2667  * May make sense to have threads after "*ish.h" anyway
2668  */
2669
2670 /* clang Thread Safety Analysis/Annotations/Attributes
2671  * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
2672  *
2673  * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
2674  * Apple XCode hijacks __clang_major__ and __clang_minor__
2675  * (6.1 means really clang 3.6), so needs extra hijinks
2676  * (could probably also test the contents of __apple_build_version__).
2677  */
2678 #if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
2679     defined(__clang__) && \
2680     !defined(PERL_GLOBAL_STRUCT) && \
2681     !defined(PERL_GLOBAL_STRUCT_PRIVATE) && \
2682     !defined(SWIG) && \
2683   ((!defined(__apple_build_version__) &&               \
2684     ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
2685      (__clang_major__ >= 4))) || \
2686    (defined(__apple_build_version__) &&                \
2687     ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
2688      (__clang_major__ >= 7))))
2689 #  define PERL_TSA__(x)   __attribute__((x))
2690 #  define PERL_TSA_ACTIVE
2691 #else
2692 #  define PERL_TSA__(x)   /* No TSA, make TSA attributes no-ops. */
2693 #  undef PERL_TSA_ACTIVE
2694 #endif
2695
2696 /* PERL_TSA_CAPABILITY() is used to annotate typedefs.
2697  * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
2698  */
2699 #define PERL_TSA_CAPABILITY(x) \
2700     PERL_TSA__(capability(x))
2701
2702 /* In the below examples the mutex must be lexically visible, usually
2703  * either as global variables, or as function arguments. */
2704
2705 /* PERL_TSA_GUARDED_BY() is used to annotate global variables.
2706  *
2707  * Foo foo PERL_TSA_GUARDED_BY(mutex);
2708  */
2709 #define PERL_TSA_GUARDED_BY(x) \
2710     PERL_TSA__(guarded_by(x))
2711
2712 /* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
2713  * The data _behind_ the pointer is guarded.
2714  *
2715  * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
2716  */
2717 #define PERL_TSA_PT_GUARDED_BY(x) \
2718     PERL_TSA__(pt_guarded_by(x))
2719
2720 /* PERL_TSA_REQUIRES() is used to annotate functions.
2721  * The caller MUST hold the resource when calling the function.
2722  *
2723  * void Foo() PERL_TSA_REQUIRES(mutex);
2724  */
2725 #define PERL_TSA_REQUIRES(x) \
2726     PERL_TSA__(requires_capability(x))
2727
2728 /* PERL_TSA_EXCLUDES() is used to annotate functions.
2729  * The caller MUST NOT hold resource when calling the function.
2730  *
2731  * EXCLUDES should be used when the function first acquires
2732  * the resource and then releases it.  Use to avoid deadlock.
2733  *
2734  * void Foo() PERL_TSA_EXCLUDES(mutex);
2735  */
2736 #define PERL_TSA_EXCLUDES(x) \
2737     PERL_TSA__(locks_excluded(x))
2738
2739 /* PERL_TSA_ACQUIRE() is used to annotate functions.
2740  * The caller MUST NOT hold the resource when calling the function,
2741  * and the function will acquire the resource.
2742  *
2743  * void Foo() PERL_TSA_ACQUIRE(mutex);
2744  */
2745 #define PERL_TSA_ACQUIRE(x) \
2746     PERL_TSA__(acquire_capability(x))
2747
2748 /* PERL_TSA_RELEASE() is used to annotate functions.
2749  * The caller MUST hold the resource when calling the function,
2750  * and the function will release the resource.
2751  *
2752  * void Foo() PERL_TSA_RELEASE(mutex);
2753  */
2754 #define PERL_TSA_RELEASE(x) \
2755     PERL_TSA__(release_capability(x))
2756
2757 /* PERL_TSA_NO_TSA is used to annotate functions.
2758  * Used when being intentionally unsafe, or when the code is too
2759  * complicated for the analysis.  Use sparingly.
2760  *
2761  * void Foo() PERL_TSA_NO_TSA;
2762  */
2763 #define PERL_TSA_NO_TSA \
2764     PERL_TSA__(no_thread_safety_analysis)
2765
2766 /* There are more annotations/attributes available, see the clang
2767  * documentation for details. */
2768
2769 #if defined(USE_ITHREADS)
2770 #  ifdef NETWARE
2771 #    include <nw5thread.h>
2772 #  elif defined(WIN32)
2773 #    include <win32thread.h>
2774 #  elif defined(OS2)
2775 #    include "os2thread.h"
2776 #  elif defined(I_MACH_CTHREADS)
2777 #    include <mach/cthreads.h>
2778 typedef cthread_t       perl_os_thread;
2779 typedef mutex_t         perl_mutex;
2780 typedef condition_t     perl_cond;
2781 typedef void *          perl_key;
2782 #  elif defined(I_PTHREAD) /* Posix threads */
2783 #    include <pthread.h>
2784 typedef pthread_t       perl_os_thread;
2785 typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
2786 typedef pthread_cond_t  perl_cond;
2787 typedef pthread_key_t   perl_key;
2788 #  endif
2789 #endif /* USE_ITHREADS */
2790
2791 #ifdef PERL_TSA_ACTIVE
2792 /* Since most pthread mutex interfaces have not been annotated, we
2793  * need to have these wrappers. The NO_TSA annotation is quite ugly
2794  * but it cannot be avoided in plain C, unlike in C++, where one could
2795  * e.g. use ACQUIRE() with no arg on a mutex lock method.
2796  *
2797  * The bodies of these wrappers are in util.c
2798  *
2799  * TODO: however, some platforms are starting to get these clang
2800  * thread safety annotations for pthreads, for example FreeBSD.
2801  * Do we need a way to a bypass these wrappers? */
2802 EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
2803   PERL_TSA_ACQUIRE(*mutex)
2804   PERL_TSA_NO_TSA;
2805 EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
2806   PERL_TSA_RELEASE(*mutex)
2807   PERL_TSA_NO_TSA;
2808 #endif
2809
2810 #if defined(WIN32)
2811 #  include "win32.h"
2812 #endif
2813
2814 #ifdef NETWARE
2815 #  include "netware.h"
2816 #endif
2817
2818 #define STATUS_UNIX     PL_statusvalue
2819 #ifdef VMS
2820 #   define STATUS_NATIVE        PL_statusvalue_vms
2821 /*
2822  * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
2823  * its contents can not be trusted.  Unfortunately, Perl seems to check
2824  * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
2825  * be updated also.
2826  */
2827 #  include <stsdef.h>
2828 #  include <ssdef.h>
2829 /* Presume this because if VMS changes it, it will require a new
2830  * set of APIs for waiting on children for binary compatibility.
2831  */
2832 #  define child_offset_bits (8)
2833 #  ifndef C_FAC_POSIX
2834 #  define C_FAC_POSIX 0x35A000
2835 #  endif
2836
2837 /*  STATUS_EXIT - validates and returns a NATIVE exit status code for the
2838  * platform from the existing UNIX or Native status values.
2839  */
2840
2841 #   define STATUS_EXIT \
2842         (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
2843            (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
2844
2845
2846 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
2847  * exit code and shifts the UNIX value over the correct number of bits to
2848  * be a child status.  Usually the number of bits is 8, but that could be
2849  * platform dependent.  The NATIVE status code is presumed to have either
2850  * from a child process.
2851  */
2852
2853 /* This is complicated.  The child processes return a true native VMS
2854    status which must be saved.  But there is an assumption in Perl that
2855    the UNIX child status has some relationship to errno values, so
2856    Perl tries to translate it to text in some of the tests.
2857    In order to get the string translation correct, for the error, errno
2858    must be EVMSERR, but that generates a different text message
2859    than what the test programs are expecting.  So an errno value must
2860    be derived from the native status value when an error occurs.
2861    That will hide the true native status message.  With this version of
2862    perl, the true native child status can always be retrieved so that
2863    is not a problem.  But in this case, Pl_statusvalue and errno may
2864    have different values in them.
2865  */
2866
2867 #   define STATUS_NATIVE_CHILD_SET(n) \
2868         STMT_START {                                                    \
2869             I32 evalue = (I32)n;                                        \
2870             if (evalue == EVMSERR) {                                    \
2871               PL_statusvalue_vms = vaxc$errno;                          \
2872               PL_statusvalue = evalue;                                  \
2873             } else {                                                    \
2874               PL_statusvalue_vms = evalue;                              \
2875               if (evalue == -1) {                                       \
2876                 PL_statusvalue = -1;                                    \
2877                 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
2878               } else                                                    \
2879                 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1);    \
2880               set_vaxc_errno(evalue);                                   \
2881               if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX)    \
2882                   set_errno(EVMSERR);                                   \
2883               else set_errno(Perl_vms_status_to_unix(evalue, 0));       \
2884               PL_statusvalue = PL_statusvalue << child_offset_bits;     \
2885             }                                                           \
2886         } STMT_END
2887
2888 #   ifdef VMSISH_STATUS
2889 #       define STATUS_CURRENT   (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
2890 #   else
2891 #       define STATUS_CURRENT   STATUS_UNIX
2892 #   endif
2893
2894   /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
2895    * the NATIVE status to an equivalent value.  Can not be used to translate
2896    * exit code values as exit code values are not guaranteed to have any
2897    * relationship at all to errno values.
2898    * This is used when Perl is forcing errno to have a specific value.
2899    */
2900 #   define STATUS_UNIX_SET(n)                           \
2901         STMT_START {                                    \
2902             I32 evalue = (I32)n;                        \
2903             PL_statusvalue = evalue;                    \
2904             if (PL_statusvalue != -1) {                 \
2905                 if (PL_statusvalue != EVMSERR) {        \
2906                   PL_statusvalue &= 0xFFFF;             \
2907                   if (MY_POSIX_EXIT)                    \
2908                     PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
2909                   else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
2910                 }                                       \
2911                 else {                                  \
2912                   PL_statusvalue_vms = vaxc$errno;      \
2913                 }                                       \
2914             }                                           \
2915             else PL_statusvalue_vms = SS$_ABORT;        \
2916             set_vaxc_errno(PL_statusvalue_vms);         \
2917         } STMT_END
2918
2919   /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
2920    * the NATIVE error status based on it.
2921    *
2922    * When in the default mode to comply with the Perl VMS documentation,
2923    * 0 is a success and any other code sets the NATIVE status to a failure
2924    * code of SS$_ABORT.
2925    *
2926    * In the new POSIX EXIT mode, native status will be set so that the
2927    * actual exit code will can be retrieved by the calling program or
2928    * shell.
2929    *
2930    * If the exit code is not clearly a UNIX parent or child exit status,
2931    * it will be passed through as a VMS status.
2932    */
2933
2934 #   define STATUS_UNIX_EXIT_SET(n)                      \
2935         STMT_START {                                    \
2936             I32 evalue = (I32)n;                        \
2937             PL_statusvalue = evalue;                    \
2938             if (MY_POSIX_EXIT) { \
2939               if (evalue <= 0xFF00) {           \
2940                   if (evalue > 0xFF)                    \
2941                     evalue = (evalue >> child_offset_bits) & 0xFF; \
2942                   PL_statusvalue_vms =          \
2943                     (C_FAC_POSIX | (evalue << 3 ) |     \
2944                     ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
2945               } else /* forgive them Perl, for they have sinned */ \
2946                 PL_statusvalue_vms = evalue; \
2947             } else { \
2948               if (evalue == 0)                  \
2949                 PL_statusvalue_vms = SS$_NORMAL;        \
2950               else if (evalue <= 0xFF00) \
2951                 PL_statusvalue_vms = SS$_ABORT; \
2952               else { /* forgive them Perl, for they have sinned */ \
2953                   if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
2954                   else PL_statusvalue_vms = vaxc$errno; \
2955                   /* And obviously used a VMS status value instead of UNIX */ \
2956                   PL_statusvalue = EVMSERR;             \
2957               } \
2958               set_vaxc_errno(PL_statusvalue_vms);       \
2959             }                                           \
2960         } STMT_END
2961
2962
2963   /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
2964    * and sets the NATIVE error status based on it.  This special case
2965    * is needed to maintain compatibility with past VMS behavior.
2966    *
2967    * In the default mode on VMS, this number is passed through as
2968    * both the NATIVE and UNIX status.  Which makes it different
2969    * that the STATUS_UNIX_EXIT_SET.
2970    *
2971    * In the new POSIX EXIT mode, native status will be set so that the
2972    * actual exit code will can be retrieved by the calling program or
2973    * shell.
2974    *
2975    * A POSIX exit code is from 0 to 255.  If the exit code is higher
2976    * than this, it needs to be assumed that it is a VMS exit code and
2977    * passed through.
2978    */
2979
2980 #   define STATUS_EXIT_SET(n)                           \
2981         STMT_START {                                    \
2982             I32 evalue = (I32)n;                        \
2983             PL_statusvalue = evalue;                    \
2984             if (MY_POSIX_EXIT)                          \
2985                 if (evalue > 255) PL_statusvalue_vms = evalue; else {   \
2986                   PL_statusvalue_vms = \
2987                     (C_FAC_POSIX | (evalue << 3 ) |     \
2988                      ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
2989             else                                        \
2990                 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
2991             set_vaxc_errno(PL_statusvalue_vms);         \
2992         } STMT_END
2993
2994
2995  /* This macro forces a success status */
2996 #   define STATUS_ALL_SUCCESS   \
2997         (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
2998
2999  /* This macro forces a failure status */
3000 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, \
3001      vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3002         (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3003
3004 #elif defined(__amigaos4__)
3005  /* A somewhat experimental attempt to simulate posix return code values */
3006 #   define STATUS_NATIVE        PL_statusvalue_posix
3007 #   define STATUS_NATIVE_CHILD_SET(n)                      \
3008         STMT_START {                                       \
3009             PL_statusvalue_posix = (n);                    \
3010             if (PL_statusvalue_posix < 0) {                \
3011                 PL_statusvalue = -1;                       \
3012             }                                              \
3013             else {                                         \
3014                 PL_statusvalue = n << 8;                   \
3015             }                                              \
3016         } STMT_END
3017 #   define STATUS_UNIX_SET(n)           \
3018         STMT_START {                    \
3019             PL_statusvalue = (n);               \
3020             if (PL_statusvalue != -1)   \
3021                 PL_statusvalue &= 0xFFFF;       \
3022         } STMT_END
3023 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3024 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3025 #   define STATUS_CURRENT STATUS_UNIX
3026 #   define STATUS_EXIT STATUS_UNIX
3027 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3028 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3029
3030 #else
3031 #   define STATUS_NATIVE        PL_statusvalue_posix
3032 #   if defined(WCOREDUMP)
3033 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3034             STMT_START {                                   \
3035                 PL_statusvalue_posix = (n);                \
3036                 if (PL_statusvalue_posix == -1)            \
3037                     PL_statusvalue = -1;                   \
3038                 else {                                     \
3039                     PL_statusvalue =                       \
3040                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3041                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3042                         (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0);  \
3043                 }                                          \
3044             } STMT_END
3045 #   elif defined(WIFEXITED)
3046 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3047             STMT_START {                                   \
3048                 PL_statusvalue_posix = (n);                \
3049                 if (PL_statusvalue_posix == -1)            \
3050                     PL_statusvalue = -1;                   \
3051                 else {                                     \
3052                     PL_statusvalue =                       \
3053                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3054                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0);  \
3055                 }                                          \
3056             } STMT_END
3057 #   else
3058 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3059             STMT_START {                                   \
3060                 PL_statusvalue_posix = (n);                \
3061                 if (PL_statusvalue_posix == -1)            \
3062                     PL_statusvalue = -1;                   \
3063                 else {                                     \
3064                     PL_statusvalue =                       \
3065                         PL_statusvalue_posix & 0xFFFF;     \
3066                 }                                          \
3067             } STMT_END
3068 #   endif
3069 #   define STATUS_UNIX_SET(n)           \
3070         STMT_START {                    \
3071             PL_statusvalue = (n);               \
3072             if (PL_statusvalue != -1)   \
3073                 PL_statusvalue &= 0xFFFF;       \
3074         } STMT_END
3075 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3076 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3077 #   define STATUS_CURRENT STATUS_UNIX
3078 #   define STATUS_EXIT STATUS_UNIX
3079 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3080 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3081 #endif
3082
3083 /* flags in PL_exit_flags for nature of exit() */
3084 #define PERL_EXIT_EXPECTED      0x01
3085 #define PERL_EXIT_DESTRUCT_END  0x02  /* Run END in perl_destruct */
3086 #define PERL_EXIT_WARN          0x04  /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3087 #define PERL_EXIT_ABORT         0x08  /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3088
3089 #ifndef PERL_CORE
3090 /* format to use for version numbers in file/directory names */
3091 /* XXX move to Configure? */
3092 /* This was only ever used for the current version, and that can be done at
3093    compile time, as PERL_FS_VERSION, so should we just delete it?  */
3094 #  ifndef PERL_FS_VER_FMT
3095 #    define PERL_FS_VER_FMT     "%d.%d.%d"
3096 #  endif
3097 #endif
3098
3099 #ifndef PERL_FS_VERSION
3100 #  define PERL_FS_VERSION       PERL_VERSION_STRING
3101 #endif
3102
3103 /* This defines a way to flush all output buffers.  This may be a
3104  * performance issue, so we allow people to disable it.  Also, if
3105  * we are using stdio, there are broken implementations of fflush(NULL)
3106  * out there, Solaris being the most prominent.
3107  */
3108 #ifndef PERL_FLUSHALL_FOR_CHILD
3109 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3110 #  define PERL_FLUSHALL_FOR_CHILD       PerlIO_flush((PerlIO*)NULL)
3111 # elif defined(FFLUSH_ALL)
3112 #  define PERL_FLUSHALL_FOR_CHILD       my_fflush_all()
3113 # else
3114 #  define PERL_FLUSHALL_FOR_CHILD       NOOP
3115 # endif
3116 #endif
3117
3118 #ifndef PERL_WAIT_FOR_CHILDREN
3119 #  define PERL_WAIT_FOR_CHILDREN        NOOP
3120 #endif
3121
3122 /* the traditional thread-unsafe notion of "current interpreter". */
3123 #ifndef PERL_SET_INTERP
3124 #  define PERL_SET_INTERP(i)            (PL_curinterp = (PerlInterpreter*)(i))
3125 #endif
3126
3127 #ifndef PERL_GET_INTERP
3128 #  define PERL_GET_INTERP               (PL_curinterp)
3129 #endif
3130
3131 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3132 #  ifdef MULTIPLICITY
3133 #    define PERL_GET_THX                ((PerlInterpreter *)PERL_GET_CONTEXT)
3134 #  endif
3135 #  define PERL_SET_THX(t)               PERL_SET_CONTEXT(t)
3136 #endif
3137
3138 /*
3139     This replaces the previous %_ "hack" by the "%p" hacks.
3140     All that is required is that the perl source does not
3141     use "%-p" or "%-<number>p" or "%<number>p" formats.
3142     These formats will still work in perl code.
3143     See comments in sv.c for further details.
3144
3145     Robin Barker 2005-07-14
3146
3147     No longer use %1p for VDf = %vd.  RMB 2007-10-19
3148 */
3149
3150 #ifndef SVf_
3151 #  define SVf_(n) "-" STRINGIFY(n) "p"
3152 #endif
3153
3154 #ifndef SVf
3155 #  define SVf "-p"
3156 #endif
3157
3158 #ifndef SVf32
3159 #  define SVf32 SVf_(32)
3160 #endif
3161
3162 #ifndef SVf256
3163 #  define SVf256 SVf_(256)
3164 #endif
3165
3166 #define SVfARG(p) ((void*)(p))
3167
3168 #ifndef HEKf
3169 #  define HEKf "2p"
3170 #endif
3171
3172 /* Not ideal, but we cannot easily include a number in an already-numeric
3173  * format sequence. */
3174 #ifndef HEKf256
3175 #  define HEKf256 "3p"
3176 #endif
3177
3178 #define HEKfARG(p) ((void*)(p))
3179
3180 /* Takes three arguments: is_utf8, length, str */
3181 #ifndef UTF8f
3182 #  define UTF8f "d%" UVuf "%4p"
3183 #endif
3184 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3185
3186 #define PNf UTF8f
3187 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
3188
3189 #ifdef PERL_CORE
3190 /* not used; but needed for backward compatibility with XS code? - RMB */
3191 #  undef UVf
3192 #elif !defined(UVf)
3193 #  define UVf UVuf
3194 #endif
3195
3196 #ifdef HASATTRIBUTE_DEPRECATED
3197 #  define __attribute__deprecated__         __attribute__((deprecated))
3198 #endif
3199 #ifdef HASATTRIBUTE_FORMAT
3200 #  define __attribute__format__(x,y,z)      __attribute__((format(x,y,z)))
3201 #endif
3202 #ifdef HASATTRIBUTE_MALLOC
3203 #  define __attribute__malloc__             __attribute__((__malloc__))
3204 #endif
3205 #ifdef HASATTRIBUTE_NONNULL
3206 #  define __attribute__nonnull__(a)         __attribute__((nonnull(a)))
3207 #endif
3208 #ifdef HASATTRIBUTE_NORETURN
3209 #  define __attribute__noreturn__           __attribute__((noreturn))
3210 #endif
3211 #ifdef HASATTRIBUTE_PURE
3212 #  define __attribute__pure__               __attribute__((pure))
3213 #endif
3214 #ifdef HASATTRIBUTE_UNUSED
3215 #  define __attribute__unused__             __attribute__((unused))
3216 #endif
3217 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
3218 #  define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
3219 #endif
3220
3221 /* If we haven't defined the attributes yet, define them to blank. */
3222 #ifndef __attribute__deprecated__
3223 #  define __attribute__deprecated__
3224 #endif
3225 #ifndef __attribute__format__
3226 #  define __attribute__format__(x,y,z)
3227 #endif
3228 #ifndef __attribute__malloc__
3229 #  define __attribute__malloc__
3230 #endif
3231 #ifndef __attribute__nonnull__
3232 #  define __attribute__nonnull__(a)
3233 #endif
3234 #ifndef __attribute__noreturn__
3235 #  define __attribute__noreturn__
3236 #endif
3237 #ifndef __attribute__pure__
3238 #  define __attribute__pure__
3239 #endif
3240 #ifndef __attribute__unused__
3241 #  define __attribute__unused__
3242 #endif
3243 #ifndef __attribute__warn_unused_result__
3244 #  define __attribute__warn_unused_result__
3245 #endif
3246
3247 #if !defined(DEBUGGING) && !defined(NDEBUG)
3248 #  define NDEBUG 1
3249 #endif
3250 #include <assert.h>
3251
3252 /* For functions that are marked as __attribute__noreturn__, it's not
3253    appropriate to call return.  In either case, include the lint directive.
3254  */
3255 #ifdef HASATTRIBUTE_NORETURN
3256 #  define NORETURN_FUNCTION_END NOT_REACHED;
3257 #else
3258 #  define NORETURN_FUNCTION_END NOT_REACHED; return 0
3259 #endif
3260
3261 /* Some OS warn on NULL format to printf */
3262 #ifdef PRINTF_FORMAT_NULL_OK
3263 #  define __attribute__format__null_ok__(x,y,z)  __attribute__format__(x,y,z)
3264 #else
3265 #  define __attribute__format__null_ok__(x,y,z)
3266 #endif
3267
3268 #ifdef HAS_BUILTIN_EXPECT
3269 #  define EXPECT(expr,val)                  __builtin_expect(expr,val)
3270 #else
3271 #  define EXPECT(expr,val)                  (expr)
3272 #endif
3273 #define LIKELY(cond)                        EXPECT(cBOOL(cond),TRUE)
3274 #define UNLIKELY(cond)                      EXPECT(cBOOL(cond),FALSE)
3275 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3276 /* placeholder */
3277 #endif
3278
3279 /* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
3280    time invariants. That is, their argument must be a constant expression that
3281    can be verified by the compiler. This expression can contain anything that's
3282    known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3283    the expression evaluates to 0, compilation fails.
3284    Because they generate no runtime code (i.e.  their use is "free"), they're
3285    always active, even under non-DEBUGGING builds.
3286    STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
3287    file scope (outside of any function).
3288    STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3289    function.
3290 */
3291 #if (defined(static_assert) || (defined(__cplusplus) && __cplusplus >= 201103L)) && (!defined(__IBMC__) || __IBMC__ >= 1210)
3292 /* static_assert is a macro defined in <assert.h> in C11 or a compiler
3293    builtin in C++11.  But IBM XL C V11 does not support _Static_assert, no
3294    matter what <assert.h> says.
3295 */
3296 #  define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
3297 #else
3298 /* We use a bit-field instead of an array because gcc accepts
3299    'typedef char x[n]' where n is not a compile-time constant.
3300    We want to enforce constantness.
3301 */
3302 #  define STATIC_ASSERT_2(COND, SUFFIX) \
3303     typedef struct { \
3304         unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3305     } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3306 #  define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
3307 #  define STATIC_ASSERT_DECL(COND)    STATIC_ASSERT_1(COND, __LINE__)
3308 #endif
3309 /* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3310    error (static_assert is a declaration, and only statements can have labels).
3311 */
3312 #define STATIC_ASSERT_STMT(COND)      STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
3313
3314 #ifndef __has_builtin
3315 #  define __has_builtin(x) 0 /* not a clang style compiler */
3316 #endif
3317
3318 /* ASSUME is like assert(), but it has a benefit in a release build. It is a
3319    hint to a compiler about a statement of fact in a function call free
3320    expression, which allows the compiler to generate better machine code.
3321    In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3322    the control path is unreachable. In a for loop, ASSUME can be used to hint
3323    that a loop will run at least X times. ASSUME is based off MSVC's __assume
3324    intrinsic function, see its documents for more details.
3325 */
3326
3327 #ifndef DEBUGGING
3328 #  if __has_builtin(__builtin_unreachable) \
3329      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4) /* 4.5 -> */
3330 #    define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3331 #  elif defined(_MSC_VER)
3332 #    define ASSUME(x) __assume(x)
3333 #  elif defined(__ARMCC_VERSION) /* untested */
3334 #    define ASSUME(x) __promise(x)
3335 #  else
3336 /* a random compiler might define assert to its own special optimization token
3337    so pass it through to C lib as a last resort */
3338 #    define ASSUME(x) assert(x)
3339 #  endif
3340 #else
3341 #  define ASSUME(x) assert(x)
3342 #endif
3343
3344 #if defined(__sun)      /* ASSUME() generates warnings on Solaris */
3345 #  define NOT_REACHED
3346 #elif defined(DEBUGGING) && (__has_builtin(__builtin_unreachable) \
3347      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4)) /* 4.5 -> */
3348 #  define NOT_REACHED STMT_START { ASSUME(0); __builtin_unreachable(); } STMT_END
3349 #else
3350 #  define NOT_REACHED ASSUME(0)
3351 #endif
3352
3353 /* Some unistd.h's give a prototype for pause() even though
3354    HAS_PAUSE ends up undefined.  This causes the #define
3355    below to be rejected by the compiler.  Sigh.
3356 */
3357 #ifdef HAS_PAUSE
3358 #define Pause   pause
3359 #else
3360 #define Pause() sleep((32767<<16)+32767)
3361 #endif
3362
3363 #ifndef IOCPARM_LEN
3364 #   ifdef IOCPARM_MASK
3365         /* on BSDish systems we're safe */
3366 #       define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
3367 #   elif defined(_IOC_SIZE) && defined(__GLIBC__)
3368         /* on Linux systems we're safe; except when we're not [perl #38223] */
3369 #       define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3370 #   else
3371         /* otherwise guess at what's safe */
3372 #       define IOCPARM_LEN(x)   256
3373 #   endif
3374 #endif
3375
3376 #if defined(__CYGWIN__)
3377 /* USEMYBINMODE
3378  *   This symbol, if defined, indicates that the program should
3379  *   use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3380  *   that a file is in "binary" mode -- that is, that no translation
3381  *   of bytes occurs on read or write operations.
3382  */
3383 #  define USEMYBINMODE /**/
3384 #  include <io.h> /* for setmode() prototype */
3385 #  define my_binmode(fp, iotype, mode) \
3386             cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
3387 #endif
3388
3389 #ifdef __CYGWIN__
3390 void init_os_extras(void);
3391 #endif
3392
3393 #ifdef UNION_ANY_DEFINITION
3394 UNION_ANY_DEFINITION;
3395 #else
3396 union any {
3397     void*       any_ptr;
3398     SV*         any_sv;
3399     SV**        any_svp;
3400     GV*         any_gv;
3401     AV*         any_av;
3402     HV*         any_hv;
3403     OP*         any_op;
3404     char*       any_pv;
3405     char**      any_pvp;
3406     I32         any_i32;
3407     U32         any_u32;
3408     IV          any_iv;
3409     UV          any_uv;
3410     long        any_long;
3411     bool        any_bool;
3412     void        (*any_dptr) (void*);
3413     void        (*any_dxptr) (pTHX_ void*);
3414 };
3415 #endif
3416
3417 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3418
3419 #define FILTER_READ(idx, sv, len)  filter_read(idx, sv, len)
3420 #define FILTER_DATA(idx) \
3421             (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3422 #define FILTER_ISREADER(idx) \
3423             (PL_parser && PL_parser->rsfp_filters \
3424                 && idx >= AvFILLp(PL_parser->rsfp_filters))
3425 #define PERL_FILTER_EXISTS(i) \
3426             (PL_parser && PL_parser->rsfp_filters \
3427                 && (i) <= av_tindex(PL_parser->rsfp_filters))
3428
3429 #if defined(_AIX) && !defined(_AIX43)
3430 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3431 /* We cannot include <crypt.h> to get the struct crypt_data
3432  * because of setkey prototype problems when threading */
3433 typedef        struct crypt_data {     /* straight from /usr/include/crypt.h */
3434     /* From OSF, Not needed in AIX
3435        char C[28], D[28];
3436     */
3437     char E[48];
3438     char KS[16][48];
3439     char block[66];
3440     char iobuf[16];
3441 } CRYPTD;
3442 #endif /* threading */
3443 #endif /* AIX */
3444
3445 #ifndef PERL_CALLCONV
3446 #  ifdef __cplusplus
3447 #    define PERL_CALLCONV extern "C"
3448 #  else
3449 #    define PERL_CALLCONV
3450 #  endif
3451 #endif
3452 #ifndef PERL_CALLCONV_NO_RET
3453 #    define PERL_CALLCONV_NO_RET PERL_CALLCONV
3454 #endif
3455
3456 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
3457    dont have a noreturn as a declaration specifier
3458 */
3459 #ifndef PERL_STATIC_NO_RET
3460 #  define PERL_STATIC_NO_RET STATIC
3461 #endif
3462 /* PERL_STATIC_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE on
3463    builds that dont have a noreturn as a declaration specifier
3464 */
3465 #ifndef PERL_STATIC_INLINE_NO_RET
3466 #  define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
3467 #endif
3468
3469 #if !defined(OS2)
3470 #  include "iperlsys.h"
3471 #endif
3472
3473 #ifdef __LIBCATAMOUNT__
3474 #undef HAS_PASSWD  /* unixish.h but not unixish enough. */
3475 #undef HAS_GROUP
3476 #define FAKE_BIT_BUCKET
3477 #endif
3478
3479 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3480  * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
3481  * Configure, despite their names being similar to other defines like
3482  * USE_ITHREADS.  Configure in fact knows nothing about the randomised
3483  * hashes.  Therefore to enable/disable the hash randomisation defines
3484  * use the Configure -Accflags=... instead. */
3485 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
3486 #  define USE_HASH_SEED
3487 #endif
3488
3489 #include "perly.h"
3490
3491
3492 /* macros to define bit-fields in structs. */
3493 #ifndef PERL_BITFIELD8
3494 #  define PERL_BITFIELD8 unsigned
3495 #endif
3496 #ifndef PERL_BITFIELD16
3497 #  define PERL_BITFIELD16 unsigned
3498 #endif
3499 #ifndef PERL_BITFIELD32
3500 #  define PERL_BITFIELD32 unsigned
3501 #endif
3502
3503 #include "sv.h"
3504 #include "regexp.h"
3505 #include "util.h"
3506 #include "form.h"
3507 #include "gv.h"
3508 #include "pad.h"
3509 #include "cv.h"
3510 #include "opnames.h"
3511 #include "op.h"
3512 #include "hv.h"
3513 #include "cop.h"
3514 #include "av.h"
3515 #include "mg.h"
3516 #include "scope.h"
3517 #include "warnings.h"
3518 #include "utf8.h"
3519
3520 /* these would be in doio.h if there was such a file */
3521 #define my_stat()  my_stat_flags(SV_GMAGIC)
3522 #define my_lstat() my_lstat_flags(SV_GMAGIC)
3523
3524 /* defined in sv.c, but also used in [ach]v.c */
3525 #undef _XPV_HEAD
3526 #undef _XPVMG_HEAD
3527 #undef _XPVCV_COMMON
3528
3529 #include "parser.h"
3530
3531 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
3532
3533 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3534
3535 /* These have to be predeclared, as they are used in proto.h which is #included
3536  * before their definitions in regcomp.h. */
3537
3538 struct scan_data_t;
3539 typedef struct regnode_charclass regnode_charclass;
3540
3541 struct regnode_charclass_class;
3542
3543 /* A hopefully less confusing name.  The sub-classes are all Posix classes only
3544  * used under /l matching */
3545 typedef struct regnode_charclass_class regnode_charclass_posixl;
3546
3547 typedef struct regnode_ssc regnode_ssc;
3548 typedef struct RExC_state_t RExC_state_t;
3549 struct _reg_trie_data;
3550
3551 #endif
3552
3553 struct ptr_tbl_ent {
3554     struct ptr_tbl_ent*         next;
3555     const void*                 oldval;
3556     void*                       newval;
3557 };
3558
3559 struct ptr_tbl {
3560     struct ptr_tbl_ent**        tbl_ary;
3561     UV                          tbl_max;
3562     UV                          tbl_items;
3563     struct ptr_tbl_arena        *tbl_arena;
3564     struct ptr_tbl_ent          *tbl_arena_next;
3565     struct ptr_tbl_ent          *tbl_arena_end;
3566 };
3567
3568 #if defined(htonl) && !defined(HAS_HTONL)
3569 #define HAS_HTONL
3570 #endif
3571 #if defined(htons) && !defined(HAS_HTONS)
3572 #define HAS_HTONS
3573 #endif
3574 #if defined(ntohl) && !defined(HAS_NTOHL)
3575 #define HAS_NTOHL
3576 #endif
3577 #if defined(ntohs) && !defined(HAS_NTOHS)
3578 #define HAS_NTOHS
3579 #endif
3580 #ifndef HAS_HTONL
3581 #define HAS_HTONS
3582 #define HAS_HTONL
3583 #define HAS_NTOHS
3584 #define HAS_NTOHL
3585 #  if (BYTEORDER & 0xffff) == 0x4321
3586 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
3587    re-order their values. However, to behave identically to the alternative
3588    implementations, they should truncate to the correct size.  */
3589 #    define ntohl(x)    ((x)&0xFFFFFFFF)
3590 #    define htonl(x)    ntohl(x)
3591 #    define ntohs(x)    ((x)&0xFFFF)
3592 #    define htons(x)    ntohs(x)
3593 #  elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3594
3595 /* Note that we can't straight out declare our own htonl and htons because
3596    the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
3597    to avoid the overhead of initialising the socket subsystem, but the headers
3598    that *declare* the various functions are still seen. If we declare our own
3599    htonl etc they will clash with the declarations in the Win32 headers.  */
3600
3601 PERL_STATIC_INLINE U32
3602 my_swap32(const U32 x) {
3603     return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)
3604         | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
3605 }
3606
3607 PERL_STATIC_INLINE U16
3608 my_swap16(const U16 x) {
3609     return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
3610 }
3611
3612 #    define htonl(x)    my_swap32(x)
3613 #    define ntohl(x)    my_swap32(x)
3614 #    define ntohs(x)    my_swap16(x)
3615 #    define htons(x)    my_swap16(x)
3616 #  else
3617 #    error "Unsupported byteorder"
3618 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
3619    the error message. Please check the value of the macro BYTEORDER, as defined
3620    in config.h. The values of BYTEORDER we expect are
3621
3622             big endian  little endian
3623    32 bit       0x4321  0x1234
3624    64 bit   0x87654321  0x12345678
3625
3626    If you have a system with a different byte order, please see
3627    pod/perlhack.pod for how to submit a patch to add supporting code.
3628 */
3629 #  endif
3630 #endif
3631
3632 /*
3633  * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
3634  * -DWS
3635  */
3636 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3637 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
3638    re-order their values. However, to behave identically to the alternative
3639    implementations, they should truncate to the correct size.  */
3640 #  define vtohl(x)      ((x)&0xFFFFFFFF)
3641 #  define vtohs(x)      ((x)&0xFFFF)
3642 #  define htovl(x)      vtohl(x)
3643 #  define htovs(x)      vtohs(x)
3644 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
3645 #  define vtohl(x)      ((((x)&0xFF)<<24)       \
3646                         +(((x)>>24)&0xFF)       \
3647                         +(((x)&0x0000FF00)<<8)  \
3648                         +(((x)&0x00FF0000)>>8)  )
3649 #  define vtohs(x)      ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
3650 #  define htovl(x)      vtohl(x)
3651 #  define htovs(x)      vtohs(x)
3652 #else
3653 #  error "Unsupported byteorder"
3654 /* If you have need for current perl on PDP-11 or similar, and can help test
3655    that blead keeps working on a mixed-endian system, then see
3656    pod/perlhack.pod for how to submit patches to things working again.  */
3657 #endif
3658
3659 /* *MAX Plus 1. A floating point value.
3660    Hopefully expressed in a way that dodgy floating point can't mess up.
3661    >> 2 rather than 1, so that value is safely less than I32_MAX after 1
3662    is added to it
3663    May find that some broken compiler will want the value cast to I32.
3664    [after the shift, as signed >> may not be as secure as unsigned >>]
3665 */
3666 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
3667 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
3668 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
3669    0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
3670    may be greater than sizeof(IV), so don't assume that half max UV is max IV.
3671 */
3672 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
3673
3674 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
3675 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
3676 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
3677
3678 /* This may look like unnecessary jumping through hoops, but converting
3679    out of range floating point values to integers *is* undefined behaviour,
3680    and it is starting to bite.
3681 */
3682 #ifndef CAST_INLINE
3683 #define I_32(what) (cast_i32((NV)(what)))
3684 #define U_32(what) (cast_ulong((NV)(what)))
3685 #define I_V(what) (cast_iv((NV)(what)))
3686 #define U_V(what) (cast_uv((NV)(what)))
3687 #else
3688 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
3689                   : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
3690                      : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
3691 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
3692                   : ((n) < U32_MAX_P1 ? (U32) (n) \
3693                      : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
3694 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
3695                   : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
3696                      : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
3697 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
3698                   : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
3699                      : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
3700 #endif
3701
3702 #define U_S(what) ((U16)U_32(what))
3703 #define U_I(what) ((unsigned int)U_32(what))
3704 #define U_L(what) U_32(what)
3705
3706 #ifdef HAS_SIGNBIT
3707 #  define Perl_signbit signbit
3708 #endif
3709
3710 /* These do not care about the fractional part, only about the range. */
3711 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
3712 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
3713
3714 /* Used with UV/IV arguments: */
3715                                         /* XXXX: need to speed it up */
3716 #define CLUMP_2UV(iv)   ((iv) < 0 ? 0 : (UV)(iv))
3717 #define CLUMP_2IV(uv)   ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
3718
3719 #ifndef MAXSYSFD
3720 #   define MAXSYSFD 2
3721 #endif
3722
3723 #ifndef __cplusplus
3724 #if !(defined(WIN32) || defined(UNDER_CE) || defined(SYMBIAN))
3725 Uid_t getuid (void);
3726 Uid_t geteuid (void);
3727 Gid_t getgid (void);
3728 Gid_t getegid (void);
3729 #endif
3730 #endif
3731
3732 #ifndef Perl_debug_log
3733 #  define Perl_debug_log        PerlIO_stderr()
3734 #endif
3735
3736 #ifndef Perl_error_log
3737 #  define Perl_error_log        (PL_stderrgv                    \
3738                                  && isGV(PL_stderrgv)           \
3739                                  && GvIOp(PL_stderrgv)          \
3740                                  && IoOFP(GvIOp(PL_stderrgv))   \
3741                                  ? IoOFP(GvIOp(PL_stderrgv))    \
3742                                  : PerlIO_stderr())
3743 #endif
3744
3745
3746 #define DEBUG_p_FLAG            0x00000001 /*      1 */
3747 #define DEBUG_s_FLAG            0x00000002 /*      2 */
3748 #define DEBUG_l_FLAG            0x00000004 /*      4 */
3749 #define DEBUG_t_FLAG            0x00000008 /*      8 */
3750 #define DEBUG_o_FLAG            0x00000010 /*     16 */
3751 #define DEBUG_c_FLAG            0x00000020 /*     32 */
3752 #define DEBUG_P_FLAG            0x00000040 /*     64 */
3753 #define DEBUG_m_FLAG            0x00000080 /*    128 */
3754 #define DEBUG_f_FLAG            0x00000100 /*    256 */
3755 #define DEBUG_r_FLAG            0x00000200 /*    512 */
3756 #define DEBUG_x_FLAG            0x00000400 /*   1024 */
3757 #define DEBUG_u_FLAG            0x00000800 /*   2048 */
3758 /* U is reserved for Unofficial, exploratory hacking */
3759 #define DEBUG_U_FLAG            0x00001000 /*   4096 */
3760 /* spare                                        8192 */
3761 #define DEBUG_X_FLAG            0x00004000 /*  16384 */
3762 #define DEBUG_D_FLAG            0x00008000 /*  32768 */
3763 #define DEBUG_S_FLAG            0x00010000 /*  65536 */
3764 #define DEBUG_T_FLAG            0x00020000 /* 131072 */
3765 #define DEBUG_R_FLAG            0x00040000 /* 262144 */
3766 #define DEBUG_J_FLAG            0x00080000 /* 524288 */
3767 #define DEBUG_v_FLAG            0x00100000 /*1048576 */
3768 #define DEBUG_C_FLAG            0x00200000 /*2097152 */
3769 #define DEBUG_A_FLAG            0x00400000 /*4194304 */
3770 #define DEBUG_q_FLAG            0x00800000 /*8388608 */
3771 #define DEBUG_M_FLAG            0x01000000 /*16777216*/
3772 #define DEBUG_B_FLAG            0x02000000 /*33554432*/
3773 #define DEBUG_L_FLAG            0x04000000 /*67108864*/
3774 #define DEBUG_i_FLAG            0x08000000 /*134217728*/
3775 #define DEBUG_MASK              0x0FFFEFFF /* mask of all the standard flags */
3776
3777 #define DEBUG_DB_RECURSE_FLAG   0x40000000
3778 #define DEBUG_TOP_FLAG          0x80000000 /* -D was given --> PL_debug |= FLAG */
3779
3780 #  define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
3781 #  define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
3782 #  define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
3783 #  define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
3784 #  define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
3785 #  define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
3786 #  define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
3787 #  define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
3788 #  define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
3789 #  define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
3790 #  define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
3791 #  define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
3792 #  define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
3793 #  define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
3794 #  define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
3795 #  define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
3796 #  define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
3797 #  define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
3798 #  define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
3799 #  define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
3800 #  define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
3801 #  define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
3802 #  define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
3803 #  define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
3804 #  define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
3805 #  define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
3806 #  define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
3807 #  define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
3808 #  define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
3809 #  define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
3810 #  define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
3811
3812 #ifdef DEBUGGING
3813
3814 #  define DEBUG_p_TEST DEBUG_p_TEST_
3815 #  define DEBUG_s_TEST DEBUG_s_TEST_
3816 #  define DEBUG_l_TEST DEBUG_l_TEST_
3817 #  define DEBUG_t_TEST DEBUG_t_TEST_
3818 #  define DEBUG_o_TEST DEBUG_o_TEST_
3819 #  define DEBUG_c_TEST DEBUG_c_TEST_
3820 #  define DEBUG_P_TEST DEBUG_P_TEST_
3821 #  define DEBUG_m_TEST DEBUG_m_TEST_
3822 #  define DEBUG_f_TEST DEBUG_f_TEST_
3823 #  define DEBUG_r_TEST DEBUG_r_TEST_
3824 #  define DEBUG_x_TEST DEBUG_x_TEST_
3825 #  define DEBUG_u_TEST DEBUG_u_TEST_
3826 #  define DEBUG_U_TEST DEBUG_U_TEST_
3827 #  define DEBUG_X_TEST DEBUG_X_TEST_
3828 #  define DEBUG_D_TEST DEBUG_D_TEST_
3829 #  define DEBUG_S_TEST DEBUG_S_TEST_
3830 #  define DEBUG_T_TEST DEBUG_T_TEST_
3831 #  define DEBUG_R_TEST DEBUG_R_TEST_
3832 #  define DEBUG_J_TEST DEBUG_J_TEST_
3833 #  define DEBUG_v_TEST DEBUG_v_TEST_
3834 #  define DEBUG_C_TEST DEBUG_C_TEST_
3835 #  define DEBUG_A_TEST DEBUG_A_TEST_
3836 #  define DEBUG_q_TEST DEBUG_q_TEST_
3837 #  define DEBUG_M_TEST DEBUG_M_TEST_
3838 #  define DEBUG_B_TEST DEBUG_B_TEST_
3839 #  define DEBUG_L_TEST DEBUG_L_TEST_
3840 #  define DEBUG_i_TEST DEBUG_i_TEST_
3841 #  define DEBUG_Xv_TEST DEBUG_Xv_TEST_
3842 #  define DEBUG_Uv_TEST DEBUG_Uv_TEST_
3843 #  define DEBUG_Pv_TEST DEBUG_Pv_TEST_
3844 #  define DEBUG_Lv_TEST DEBUG_Lv_TEST_
3845
3846 #  define PERL_DEB(a)                  a
3847 #  define PERL_DEB2(a,b)               a
3848 #  define PERL_DEBUG(a) if (PL_debug)  a
3849 #  define DEBUG_p(a) if (DEBUG_p_TEST) a
3850 #  define DEBUG_s(a) if (DEBUG_s_TEST) a
3851 #  define DEBUG_l(a) if (DEBUG_l_TEST) a
3852 #  define DEBUG_t(a) if (DEBUG_t_TEST) a
3853 #  define DEBUG_o(a) if (DEBUG_o_TEST) a
3854 #  define DEBUG_c(a) if (DEBUG_c_TEST) a
3855 #  define DEBUG_P(a) if (DEBUG_P_TEST) a
3856
3857      /* Temporarily turn off memory debugging in case the a
3858       * does memory allocation, either directly or indirectly. */
3859 #  define DEBUG_m(a)  \
3860     STMT_START {                                                        \
3861         if (PERL_GET_INTERP) {                                          \
3862                                 dTHX;                                   \
3863                                 if (DEBUG_m_TEST) {                     \
3864                                     PL_debug &= ~DEBUG_m_FLAG;          \
3865                                     a;                                  \
3866                                     PL_debug |= DEBUG_m_FLAG;           \
3867                                 }                                       \
3868                               }                                         \
3869     } STMT_END
3870
3871 #  define DEBUG__(t, a)                                                 \
3872         STMT_START {                                                    \
3873                 if (t) STMT_START {a;} STMT_END;                        \
3874         } STMT_END
3875
3876 #  define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
3877
3878 #ifndef PERL_EXT_RE_BUILD
3879 #  define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
3880 #else
3881 #  define DEBUG_r(a) STMT_START {a;} STMT_END
3882 #endif /* PERL_EXT_RE_BUILD */
3883
3884 #  define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
3885 #  define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
3886 #  define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
3887 #  define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
3888 #  define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
3889 #  define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
3890 #  define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
3891 #  define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
3892 #  define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
3893
3894 #  define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
3895 #  define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
3896 #  define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
3897 #  define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
3898 #  define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
3899 #  define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
3900 #  define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
3901 #  define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
3902 #  define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
3903 #  define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
3904 #  define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
3905
3906 #else /* DEBUGGING */
3907
3908 #  define DEBUG_p_TEST (0)
3909 #  define DEBUG_s_TEST (0)
3910 #  define DEBUG_l_TEST (0)
3911 #  define DEBUG_t_TEST (0)
3912 #  define DEBUG_o_TEST (0)
3913 #  define DEBUG_c_TEST (0)
3914 #  define DEBUG_P_TEST (0)
3915 #  define DEBUG_m_TEST (0)
3916 #  define DEBUG_f_TEST (0)
3917 #  define DEBUG_r_TEST (0)
3918 #  define DEBUG_x_TEST (0)
3919 #  define DEBUG_u_TEST (0)
3920 #  define DEBUG_U_TEST (0)
3921 #  define DEBUG_X_TEST (0)
3922 #  define DEBUG_D_TEST (0)
3923 #  define DEBUG_S_TEST (0)
3924 #  define DEBUG_T_TEST (0)
3925 #  define DEBUG_R_TEST (0)
3926 #  define DEBUG_J_TEST (0)
3927 #  define DEBUG_v_TEST (0)
3928 #  define DEBUG_C_TEST (0)
3929 #  define DEBUG_A_TEST (0)
3930 #  define DEBUG_q_TEST (0)
3931 #  define DEBUG_M_TEST (0)
3932 #  define DEBUG_B_TEST (0)
3933 #  define DEBUG_L_TEST (0)
3934 #  define DEBUG_i_TEST (0)
3935 #  define DEBUG_Xv_TEST (0)
3936 #  define DEBUG_Uv_TEST (0)
3937 #  define DEBUG_Pv_TEST (0)
3938 #  define DEBUG_Lv_TEST (0)
3939
3940 #  define PERL_DEB(a)
3941 #  define PERL_DEB2(a,b)               b
3942 #  define PERL_DEBUG(a)
3943 #  define DEBUG_p(a)
3944 #  define DEBUG_s(a)
3945 #  define DEBUG_l(a)
3946 #  define DEBUG_t(a)
3947 #  define DEBUG_o(a)
3948 #  define DEBUG_c(a)
3949 #  define DEBUG_P(a)
3950 #  define DEBUG_m(a)
3951 #  define DEBUG_f(a)
3952 #  define DEBUG_r(a)
3953 #  define DEBUG_x(a)
3954 #  define DEBUG_u(a)
3955 #  define DEBUG_U(a)
3956 #  define DEBUG_X(a)
3957 #  define DEBUG_D(a)
3958 #  define DEBUG_S(a)
3959 #  define DEBUG_T(a)
3960 #  define DEBUG_R(a)
3961 #  define DEBUG_v(a)
3962 #  define DEBUG_C(a)
3963 #  define DEBUG_A(a)
3964 #  define DEBUG_q(a)
3965 #  define DEBUG_M(a)
3966 #  define DEBUG_B(a)
3967 #  define DEBUG_L(a)
3968 #  define DEBUG_i(a)
3969 #  define DEBUG_Xv(a)
3970 #  define DEBUG_Uv(a)
3971 #  define DEBUG_Pv(a)
3972 #  define DEBUG_Lv(a)
3973 #endif /* DEBUGGING */
3974
3975
3976 #define DEBUG_SCOPE(where) \
3977     DEBUG_l( \
3978     Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n",   \
3979                     where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
3980                     __FILE__, __LINE__));
3981
3982 /* Keep the old croak based assert for those who want it, and as a fallback if
3983    the platform is so heretically non-ANSI that it can't assert.  */
3984
3985 #define Perl_assert(what)       PERL_DEB2(                              \
3986         ((what) ? ((void) 0) :                                          \
3987             (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
3988                         "\", line %d", STRINGIFY(what), __LINE__),      \
3989              (void) 0)), ((void)0))
3990
3991 /* assert() gets defined if DEBUGGING.
3992  * If no DEBUGGING, the <assert.h> has not been included. */
3993 #ifndef assert
3994 #  define assert(what)  Perl_assert(what)
3995 #endif
3996 #ifdef DEBUGGING
3997 #  define assert_(what) assert(what),
3998 #else
3999 #  define assert_(what)
4000 #endif
4001
4002 struct ufuncs {
4003     I32 (*uf_val)(pTHX_ IV, SV*);
4004     I32 (*uf_set)(pTHX_ IV, SV*);
4005     IV uf_index;
4006 };
4007
4008 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4009  * XS code wanting to be backward compatible can do something
4010  * like the following:
4011
4012 #ifndef PERL_MG_UFUNC
4013 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4014 #endif
4015
4016 static PERL_MG_UFUNC(foo_get, index, val)
4017 {
4018     sv_setsv(val, ...);
4019     return TRUE;
4020 }
4021
4022 -- Doug MacEachern
4023
4024 */
4025
4026 #ifndef PERL_MG_UFUNC
4027 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4028 #endif
4029
4030 #include <math.h>
4031 #ifdef __VMS
4032      /* isfinite and others are here rather than in math.h as C99 stipulates */
4033 #    include <fp.h>
4034 #endif
4035
4036 #ifndef __cplusplus
4037 #  if !defined(WIN32) && !defined(VMS)
4038 #ifndef crypt
4039 char *crypt (const char*, const char*);
4040 #endif
4041 #  endif /* !WIN32 */
4042 #  ifndef WIN32
4043 #    ifndef getlogin
4044 char *getlogin (void);
4045 #    endif
4046 #  endif /* !WIN32 */
4047 #endif /* !__cplusplus */
4048
4049 /* Fixme on VMS.  This needs to be a run-time, not build time options */
4050 /* Also rename() is affected by this */
4051 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4052 #define UNLINK unlnk
4053 I32 unlnk (pTHX_ const char*);
4054 #else
4055 #define UNLINK PerlLIO_unlink
4056 #endif
4057
4058 /* some versions of glibc are missing the setresuid() proto */
4059 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4060 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4061 #endif
4062 /* some versions of glibc are missing the setresgid() proto */
4063 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4064 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4065 #endif
4066
4067 #ifndef HAS_SETREUID
4068 #  ifdef HAS_SETRESUID
4069 #    define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4070 #    define HAS_SETREUID
4071 #  endif
4072 #endif
4073 #ifndef HAS_SETREGID
4074 #  ifdef HAS_SETRESGID
4075 #    define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4076 #    define HAS_SETREGID
4077 #  endif
4078 #endif
4079
4080 /* Sighandler_t defined in iperlsys.h */
4081
4082 #ifdef HAS_SIGACTION
4083 typedef struct sigaction Sigsave_t;
4084 #else
4085 typedef Sighandler_t Sigsave_t;
4086 #endif
4087
4088 #define SCAN_DEF 0
4089 #define SCAN_TR 1
4090 #define SCAN_REPL 2
4091
4092 #ifdef DEBUGGING
4093 # ifndef register
4094 #  define register
4095 # endif
4096 # define RUNOPS_DEFAULT Perl_runops_debug
4097 #else
4098 # define RUNOPS_DEFAULT Perl_runops_standard
4099 #endif
4100
4101 #if defined(USE_PERLIO)
4102 EXTERN_C void PerlIO_teardown(void);
4103 # ifdef USE_ITHREADS
4104 #  define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4105 #  define PERLIO_TERM                           \
4106         STMT_START {                            \
4107                 PerlIO_teardown();              \
4108                 MUTEX_DESTROY(&PL_perlio_mutex);\
4109         } STMT_END
4110 # else
4111 #  define PERLIO_INIT
4112 #  define PERLIO_TERM   PerlIO_teardown()
4113 # endif
4114 #else
4115 #  define PERLIO_INIT
4116 #  define PERLIO_TERM
4117 #endif
4118
4119 #ifdef MYMALLOC
4120 #  ifdef MUTEX_INIT_CALLS_MALLOC
4121 #    define MALLOC_INIT                                 \
4122         STMT_START {                                    \
4123                 PL_malloc_mutex = NULL;                 \
4124                 MUTEX_INIT(&PL_malloc_mutex);           \
4125         } STMT_END
4126 #    define MALLOC_TERM                                 \
4127         STMT_START {                                    \
4128                 perl_mutex tmp = PL_malloc_mutex;       \
4129                 PL_malloc_mutex = NULL;                 \
4130                 MUTEX_DESTROY(&tmp);                    \
4131         } STMT_END
4132 #  else
4133 #    define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4134 #    define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4135 #  endif
4136 #else
4137 #  define MALLOC_INIT
4138 #  define MALLOC_TERM
4139 #endif
4140
4141 #if defined(PERL_IMPLICIT_CONTEXT)
4142
4143 struct perl_memory_debug_header;
4144 struct perl_memory_debug_header {
4145   tTHX  interpreter;
4146 #  if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4147   MEM_SIZE size;
4148 #  endif
4149   struct perl_memory_debug_header *prev;
4150   struct perl_memory_debug_header *next;
4151 #  ifdef PERL_DEBUG_READONLY_COW
4152   bool readonly;
4153 #  endif
4154 };
4155
4156 #elif defined(PERL_DEBUG_READONLY_COW)
4157
4158 struct perl_memory_debug_header;
4159 struct perl_memory_debug_header {
4160   MEM_SIZE size;
4161 };
4162
4163 #endif
4164
4165 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4166
4167 #  define PERL_MEMORY_DEBUG_HEADER_SIZE \
4168         (sizeof(struct perl_memory_debug_header) + \
4169         (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4170          %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4171
4172 #else
4173 #  define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4174 #endif
4175
4176 #ifdef PERL_TRACK_MEMPOOL
4177 # ifdef PERL_DEBUG_READONLY_COW
4178 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4179         STMT_START {                                            \
4180                 (header).interpreter = (interp);                \
4181                 (header).prev = (header).next = &(header);      \
4182                 (header).readonly = 0;                          \
4183         } STMT_END
4184 # else
4185 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4186         STMT_START {                                            \
4187                 (header).interpreter = (interp);                \
4188                 (header).prev = (header).next = &(header);      \
4189         } STMT_END
4190 # endif
4191 # else
4192 #  define INIT_TRACK_MEMPOOL(header, interp)
4193 #endif
4194
4195 #ifdef I_MALLOCMALLOC
4196 /* Needed for malloc_size(), malloc_good_size() on some systems */
4197 #  include <malloc/malloc.h>
4198 #endif
4199
4200 #ifdef MYMALLOC
4201 #  define Perl_safesysmalloc_size(where)        Perl_malloced_size(where)
4202 #else
4203 #  if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4204 #    ifdef PERL_TRACK_MEMPOOL
4205 #       define Perl_safesysmalloc_size(where)                   \
4206             (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4207 #    else
4208 #       define Perl_safesysmalloc_size(where) malloc_size(where)
4209 #    endif
4210 #  endif
4211 #  ifdef HAS_MALLOC_GOOD_SIZE
4212 #    ifdef PERL_TRACK_MEMPOOL
4213 #       define Perl_malloc_good_size(how_much)                  \
4214             (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4215 #    else
4216 #       define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4217 #    endif
4218 #  else
4219 /* Having this as the identity operation makes some code simpler.  */
4220 #       define Perl_malloc_good_size(how_much)  (how_much)
4221 #  endif
4222 #endif
4223
4224 typedef int (*runops_proc_t)(pTHX);
4225 typedef void (*share_proc_t) (pTHX_ SV *sv);
4226 typedef int  (*thrhook_proc_t) (pTHX);
4227 typedef OP* (*PPADDR_t[]) (pTHX);
4228 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4229 typedef void (*despatch_signals_proc_t) (pTHX);
4230
4231 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4232 #  include <crt_externs.h>      /* for the env array */
4233 #  define environ (*_NSGetEnviron())
4234 #elif defined(USE_ENVIRON_ARRAY) && !defined(environ)
4235    /* VMS and some other platforms don't use the environ array */
4236 EXTERN_C char **environ;  /* environment variables supplied via exec */
4237 #endif
4238
4239 #define PERL_PATCHLEVEL_H_IMPLICIT
4240 #include "patchlevel.h"
4241 #undef PERL_PATCHLEVEL_H_IMPLICIT
4242
4243 #define PERL_VERSION_STRING     STRINGIFY(PERL_REVISION) "." \
4244                                 STRINGIFY(PERL_VERSION) "." \
4245                                 STRINGIFY(PERL_SUBVERSION)
4246
4247 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4248                                 STRINGIFY(PERL_API_VERSION) "." \
4249                                 STRINGIFY(PERL_API_SUBVERSION)
4250
4251 START_EXTERN_C
4252
4253 /* handy constants */
4254 EXTCONST char PL_warn_uninit[]
4255   INIT("Use of uninitialized value%s%s%s");
4256 EXTCONST char PL_warn_uninit_sv[]
4257   INIT("Use of uninitialized value%" SVf "%s%s");
4258 EXTCONST char PL_warn_nosemi[]
4259   INIT("Semicolon seems to be missing");
4260 EXTCONST char PL_warn_reserved[]
4261   INIT("Unquoted string \"%s\" may clash with future reserved word");
4262 EXTCONST char PL_warn_nl[]
4263   INIT("Unsuccessful %s on filename containing newline");
4264 EXTCONST char PL_no_wrongref[]
4265   INIT("Can't use %s ref as %s ref");
4266 /* The core no longer needs this here. If you require the string constant,
4267    please inline a copy into your own code.  */
4268 EXTCONST char PL_no_symref[] __attribute__deprecated__
4269   INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4270 EXTCONST char PL_no_symref_sv[]
4271   INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4272
4273 EXTCONST char PL_no_usym[]
4274   INIT("Can't use an undefined value as %s reference");
4275 EXTCONST char PL_no_aelem[]
4276   INIT("Modification of non-creatable array value attempted, subscript %d");
4277 EXTCONST char PL_no_helem_sv[]
4278   INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4279 EXTCONST char PL_no_modify[]
4280   INIT("Modification of a read-only value attempted");
4281 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4282   INIT("Out of memory!\n");
4283 EXTCONST char PL_no_security[]
4284   INIT("Insecure dependency in %s%s");
4285 EXTCONST char PL_no_sock_func[]
4286   INIT("Unsupported socket function \"%s\" called");
4287 EXTCONST char PL_no_dir_func[]
4288   INIT("Unsupported directory function \"%s\" called");
4289 EXTCONST char PL_no_func[]
4290   INIT("The %s function is unimplemented");
4291 EXTCONST char PL_no_myglob[]
4292   INIT("\"%s\" %se %s can't be in a package");
4293 EXTCONST char PL_no_localize_ref[]
4294   INIT("Can't localize through a reference");
4295 EXTCONST char PL_memory_wrap[]
4296   INIT("panic: memory wrap");
4297
4298 EXTCONST char PL_Yes[]
4299   INIT("1");
4300 EXTCONST char PL_No[]
4301   INIT("");
4302 EXTCONST char PL_Zero[]
4303   INIT("0");
4304 EXTCONST char PL_hexdigit[]
4305   INIT("0123456789abcdef0123456789ABCDEF");
4306
4307 /* This is constant on most architectures, a global on OS/2 */
4308 #ifndef OS2
4309 EXTCONST char PL_sh_path[]
4310   INIT(SH_PATH); /* full path of shell */
4311 #endif
4312
4313 #ifdef CSH
4314 EXTCONST char PL_cshname[]
4315   INIT(CSH);
4316 #  define PL_cshlen     (sizeof(CSH "") - 1)
4317 #endif
4318
4319 /* These are baked at compile time into any shared perl library.
4320    In future releases this will allow us in main() to sanity test the
4321    library we're linking against.  */
4322
4323 EXTCONST U8 PL_revision
4324   INIT(PERL_REVISION);
4325 EXTCONST U8 PL_version
4326   INIT(PERL_VERSION);
4327 EXTCONST U8 PL_subversion
4328   INIT(PERL_SUBVERSION);
4329
4330 EXTCONST char PL_uuemap[65]
4331   INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4332
4333 /* a special string address whose value is "isa", but which perl knows
4334  * to treat as if it were really "DOES" when printing the method name in
4335  *  the "Can't call method '%s'" error message */
4336 EXTCONST char PL_isa_DOES[]
4337   INIT("isa");
4338
4339 #ifdef DOINIT
4340 EXTCONST char PL_uudmap[256] =
4341 #  ifdef PERL_MICRO
4342 #    include "uuudmap.h"
4343 #  else
4344 #    include "uudmap.h"
4345 #  endif
4346 ;
4347 EXTCONST char PL_bitcount[256] =
4348 #  ifdef PERL_MICRO
4349 #    include "ubitcount.h"
4350 #else
4351 #    include "bitcount.h"
4352 #  endif
4353 ;
4354 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4355 EXTCONST int         PL_sig_num[]  = { SIG_NUM };
4356 #else
4357 EXTCONST char PL_uudmap[256];
4358 EXTCONST char PL_bitcount[256];
4359 EXTCONST char* const PL_sig_name[];
4360 EXTCONST int         PL_sig_num[];
4361 #endif
4362
4363 /* fast conversion and case folding tables.  The folding tables complement the
4364  * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4365  * folds such as outside the range or to multiple characters. */
4366
4367 #ifdef DOINIT
4368 #ifndef EBCDIC
4369
4370 /* The EBCDIC fold table depends on the code page, and hence is found in
4371  * utfebcdic.h */
4372
4373 EXTCONST  unsigned char PL_fold[] = {
4374         0,      1,      2,      3,      4,      5,      6,      7,
4375         8,      9,      10,     11,     12,     13,     14,     15,
4376         16,     17,     18,     19,     20,     21,     22,     23,
4377         24,     25,     26,     27,     28,     29,     30,     31,
4378         32,     33,     34,     35,     36,     37,     38,     39,
4379         40,     41,     42,     43,     44,     45,     46,     47,
4380         48,     49,     50,     51,     52,     53,     54,     55,
4381         56,     57,     58,     59,     60,     61,     62,     63,
4382         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4383         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4384         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4385         'x',    'y',    'z',    91,     92,     93,     94,     95,
4386         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4387         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4388         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4389         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4390         128,    129,    130,    131,    132,    133,    134,    135,
4391         136,    137,    138,    139,    140,    141,    142,    143,
4392         144,    145,    146,    147,    148,    149,    150,    151,
4393         152,    153,    154,    155,    156,    157,    158,    159,
4394         160,    161,    162,    163,    164,    165,    166,    167,
4395         168,    169,    170,    171,    172,    173,    174,    175,
4396         176,    177,    178,    179,    180,    181,    182,    183,
4397         184,    185,    186,    187,    188,    189,    190,    191,
4398         192,    193,    194,    195,    196,    197,    198,    199,
4399         200,    201,    202,    203,    204,    205,    206,    207,
4400         208,    209,    210,    211,    212,    213,    214,    215,
4401         216,    217,    218,    219,    220,    221,    222,    223,
4402         224,    225,    226,    227,    228,    229,    230,    231,
4403         232,    233,    234,    235,    236,    237,    238,    239,
4404         240,    241,    242,    243,    244,    245,    246,    247,
4405         248,    249,    250,    251,    252,    253,    254,    255
4406 };
4407 EXTCONST  unsigned char PL_fold_latin1[] = {
4408     /* Full latin1 complement folding, except for three problematic code points:
4409      *  Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4410      *  fold complements outside the Latin1 range, so can't match something
4411      *  that isn't in utf8.
4412      *  German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4413      *  not one, so can't be represented in this table.
4414      *
4415      * All have to be specially handled */
4416         0,      1,      2,      3,      4,      5,      6,      7,
4417         8,      9,      10,     11,     12,     13,     14,     15,
4418         16,     17,     18,     19,     20,     21,     22,     23,
4419         24,     25,     26,     27,     28,     29,     30,     31,
4420         32,     33,     34,     35,     36,     37,     38,     39,
4421         40,     41,     42,     43,     44,     45,     46,     47,
4422         48,     49,     50,     51,     52,     53,     54,     55,
4423         56,     57,     58,     59,     60,     61,     62,     63,
4424         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4425         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4426         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4427         'x',    'y',    'z',    91,     92,     93,     94,     95,
4428         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4429         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4430         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4431         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4432         128,    129,    130,    131,    132,    133,    134,    135,
4433         136,    137,    138,    139,    140,    141,    142,    143,
4434         144,    145,    146,    147,    148,    149,    150,    151,
4435         152,    153,    154,    155,    156,    157,    158,    159,
4436         160,    161,    162,    163,    164,    165,    166,    167,
4437         168,    169,    170,    171,    172,    173,    174,    175,
4438         176,    177,    178,    179,    180,    181 /*micro */, 182,    183,
4439         184,    185,    186,    187,    188,    189,    190,    191,
4440         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4441         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4442         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4443         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
4444         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4445         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4446         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4447         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
4448         255 /* y with diaeresis */
4449 };
4450
4451 /* If these tables are accessed through ebcdic, the access will be converted to
4452  * latin1 first */
4453 EXTCONST  unsigned char PL_latin1_lc[] = {  /* lowercasing */
4454         0,      1,      2,      3,      4,      5,      6,      7,
4455         8,      9,      10,     11,     12,     13,     14,     15,
4456         16,     17,     18,     19,     20,     21,     22,     23,
4457         24,     25,     26,     27,     28,     29,     30,     31,
4458         32,     33,     34,     35,     36,     37,     38,     39,
4459         40,     41,     42,     43,     44,     45,     46,     47,
4460         48,     49,     50,     51,     52,     53,     54,     55,
4461         56,     57,     58,     59,     60,     61,     62,     63,
4462         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4463         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4464         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4465         'x',    'y',    'z',    91,     92,     93,     94,     95,
4466         96,     97,     98,     99,     100,    101,    102,    103,
4467         104,    105,    106,    107,    108,    109,    110,    111,
4468         112,    113,    114,    115,    116,    117,    118,    119,
4469         120,    121,    122,    123,    124,    125,    126,    127,
4470         128,    129,    130,    131,    132,    133,    134,    135,
4471         136,    137,    138,    139,    140,    141,    142,    143,
4472         144,    145,    146,    147,    148,    149,    150,    151,
4473         152,    153,    154,    155,    156,    157,    158,    159,
4474         160,    161,    162,    163,    164,    165,    166,    167,
4475         168,    169,    170,    171,    172,    173,    174,    175,
4476         176,    177,    178,    179,    180,    181,    182,    183,
4477         184,    185,    186,    187,    188,    189,    190,    191,
4478         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4479         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4480         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4481         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223,
4482         224,    225,    226,    227,    228,    229,    230,    231,
4483         232,    233,    234,    235,    236,    237,    238,    239,
4484         240,    241,    242,    243,    244,    245,    246,    247,
4485         248,    249,    250,    251,    252,    253,    254,    255
4486 };
4487
4488 /* upper and title case of latin1 characters, modified so that the three tricky
4489  * ones are mapped to 255 (which is one of the three) */
4490 EXTCONST  unsigned char PL_mod_latin1_uc[] = {
4491         0,      1,      2,      3,      4,      5,      6,      7,
4492         8,      9,      10,     11,     12,     13,     14,     15,
4493         16,     17,     18,     19,     20,     21,     22,     23,
4494         24,     25,     26,     27,     28,     29,     30,     31,
4495         32,     33,     34,     35,     36,     37,     38,     39,
4496         40,     41,     42,     43,     44,     45,     46,     47,
4497         48,     49,     50,     51,     52,     53,     54,     55,
4498         56,     57,     58,     59,     60,     61,     62,     63,
4499         64,     65,     66,     67,     68,     69,     70,     71,
4500         72,     73,     74,     75,     76,     77,     78,     79,
4501         80,     81,     82,     83,     84,     85,     86,     87,
4502         88,     89,     90,     91,     92,     93,     94,     95,
4503         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4504         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4505         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4506         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4507         128,    129,    130,    131,    132,    133,    134,    135,
4508         136,    137,    138,    139,    140,    141,    142,    143,
4509         144,    145,    146,    147,    148,    149,    150,    151,
4510         152,    153,    154,    155,    156,    157,    158,    159,
4511         160,    161,    162,    163,    164,    165,    166,    167,
4512         168,    169,    170,    171,    172,    173,    174,    175,
4513         176,    177,    178,    179,    180,    255 /*micro*/,  182,    183,
4514         184,    185,    186,    187,    188,    189,    190,    191,
4515         192,    193,    194,    195,    196,    197,    198,    199,
4516         200,    201,    202,    203,    204,    205,    206,    207,
4517         208,    209,    210,    211,    212,    213,    214,    215,
4518         216,    217,    218,    219,    220,    221,    222,
4519 #if    UNICODE_MAJOR_VERSION > 2                                        \
4520    || (UNICODE_MAJOR_VERSION == 2 && UNICODE_DOT_VERSION >= 1           \
4521                                   && UNICODE_DOT_DOT_VERSION >= 8)
4522                                                                 255 /*sharp s*/,
4523 #else   /* uc() is itself in early unicode */
4524                                                                 223,
4525 #endif
4526         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4527         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4528         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4529         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32, 255
4530 };
4531 #endif  /* !EBCDIC, but still in DOINIT */
4532 #else   /* ! DOINIT */
4533 #   ifndef EBCDIC
4534 EXTCONST unsigned char PL_fold[];
4535 EXTCONST unsigned char PL_fold_latin1[];
4536 EXTCONST unsigned char PL_mod_latin1_uc[];
4537 EXTCONST unsigned char PL_latin1_lc[];
4538 #   endif
4539 #endif
4540
4541 #ifndef PERL_GLOBAL_STRUCT /* or perlvars.h */
4542 #ifdef DOINIT
4543 EXT unsigned char PL_fold_locale[] = { /* Unfortunately not EXTCONST. */
4544         0,      1,      2,      3,      4,      5,      6,      7,
4545         8,      9,      10,     11,     12,     13,     14,     15,
4546         16,     17,     18,     19,     20,     21,     22,     23,
4547         24,     25,     26,     27,     28,     29,     30,     31,
4548         32,     33,     34,     35,     36,     37,     38,     39,
4549         40,     41,     42,     43,     44,     45,     46,     47,
4550         48,     49,     50,     51,     52,     53,     54,     55,
4551         56,     57,     58,     59,     60,     61,     62,     63,
4552         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4553         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4554         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4555         'x',    'y',    'z',    91,     92,     93,     94,     95,
4556         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4557         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4558         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4559         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4560         128,    129,    130,    131,    132,    133,    134,    135,
4561         136,    137,    138,    139,    140,    141,    142,    143,
4562         144,    145,    146,    147,    148,    149,    150,    151,
4563         152,    153,    154,    155,    156,    157,    158,    159,
4564         160,    161,    162,    163,    164,    165,    166,    167,
4565         168,    169,    170,    171,    172,    173,    174,    175,
4566         176,    177,    178,    179,    180,    181,    182,    183,
4567         184,    185,    186,    187,    188,    189,    190,    191,
4568         192,    193,    194,    195,    196,    197,    198,    199,
4569         200,    201,    202,    203,    204,    205,    206,    207,
4570         208,    209,    210,    211,    212,    213,    214,    215,
4571         216,    217,    218,    219,    220,    221,    222,    223,
4572         224,    225,    226,    227,    228,    229,    230,    231,
4573         232,    233,    234,    235,    236,    237,    238,    239,
4574         240,    241,    242,    243,    244,    245,    246,    247,
4575         248,    249,    250,    251,    252,    253,    254,    255
4576 };
4577 #else
4578 EXT unsigned char PL_fold_locale[]; /* Unfortunately not EXTCONST. */
4579 #endif
4580 #endif /* !PERL_GLOBAL_STRUCT */
4581
4582 #ifdef DOINIT
4583 #ifdef EBCDIC
4584 EXTCONST unsigned char PL_freq[] = {/* EBCDIC frequencies for mixed English/C */
4585     1,      2,      84,     151,    154,    155,    156,    157,
4586     165,    246,    250,    3,      158,    7,      18,     29,
4587     40,     51,     62,     73,     85,     96,     107,    118,
4588     129,    140,    147,    148,    149,    150,    152,    153,
4589     255,      6,      8,      9,     10,     11,     12,     13,
4590      14,     15,     24,     25,     26,     27,     28,    226,
4591      29,     30,     31,     32,     33,     43,     44,     45,
4592      46,     47,     48,     49,     50,     76,     77,     78,
4593      79,     80,     81,     82,     83,     84,     85,     86,
4594      87,     94,     95,    234,    181,    233,    187,    190,
4595     180,     96,     97,     98,     99,    100,    101,    102,
4596     104,    112,    182,    174,    236,    232,    229,    103,
4597     228,    226,    114,    115,    116,    117,    118,    119,
4598     120,    121,    122,    235,    176,    230,    194,    162,
4599     130,    131,    132,    133,    134,    135,    136,    137,
4600     138,    139,    201,    205,    163,    217,    220,    224,
4601     5,      248,    227,    244,    242,    255,    241,    231,
4602     240,    253,    16,     197,    19,     20,     21,     187,
4603     23,     169,    210,    245,    237,    249,    247,    239,
4604     168,    252,    34,     196,    36,     37,     38,     39,
4605     41,     42,     251,    254,    238,    223,    221,    213,
4606     225,    177,    52,     53,     54,     55,     56,     57,
4607     58,     59,     60,     61,     63,     64,     65,     66,
4608     67,     68,     69,     70,     71,     72,     74,     75,
4609     205,    208,    186,    202,    200,    218,    198,    179,
4610     178,    214,    88,     89,     90,     91,     92,     93,
4611     217,    166,    170,    207,    199,    209,    206,    204,
4612     160,    212,    105,    106,    108,    109,    110,    111,
4613     203,    113,    216,    215,    192,    175,    193,    243,
4614     172,    161,    123,    124,    125,    126,    127,    128,
4615     222,    219,    211,    195,    188,    193,    185,    184,
4616     191,    183,    141,    142,    143,    144,    145,    146
4617 };
4618 #else  /* ascii rather than ebcdic */
4619 EXTCONST unsigned char PL_freq[] = {    /* letter frequencies for mixed English/C */
4620         1,      2,      84,     151,    154,    155,    156,    157,
4621         165,    246,    250,    3,      158,    7,      18,     29,
4622         40,     51,     62,     73,     85,     96,     107,    118,
4623         129,    140,    147,    148,    149,    150,    152,    153,
4624         255,    182,    224,    205,    174,    176,    180,    217,
4625         233,    232,    236,    187,    235,    228,    234,    226,
4626         222,    219,    211,    195,    188,    193,    185,    184,
4627         191,    183,    201,    229,    181,    220,    194,    162,
4628         163,    208,    186,    202,    200,    218,    198,    179,
4629         178,    214,    166,    170,    207,    199,    209,    206,
4630         204,    160,    212,    216,    215,    192,    175,    173,
4631         243,    172,    161,    190,    203,    189,    164,    230,
4632         167,    248,    227,    244,    242,    255,    241,    231,
4633         240,    253,    169,    210,    245,    237,    249,    247,
4634         239,    168,    252,    251,    254,    238,    223,    221,
4635         213,    225,    177,    197,    171,    196,    159,    4,
4636         5,      6,      8,      9,      10,     11,     12,     13,
4637         14,     15,     16,     17,     19,     20,     21,     22,
4638         23,     24,     25,     26,     27,     28,     30,     31,
4639         32,     33,     34,     35,     36,     37,     38,     39,
4640         41,     42,     43,     44,     45,     46,     47,     48,
4641         49,     50,     52,     53,     54,     55,     56,     57,
4642         58,     59,     60,     61,     63,     64,     65,     66,
4643         67,     68,     69,     70,     71,     72,     74,     75,
4644         76,     77,     78,     79,     80,     81,     82,     83,
4645         86,     87,     88,     89,     90,     91,     92,     93,
4646         94,     95,     97,     98,     99,     100,    101,    102,
4647         103,    104,    105,    106,    108,    109,    110,    111,
4648         112,    113,    114,    115,    116,    117,    119,    120,
4649         121,    122,    123,    124,    125,    126,    127,    128,
4650         130,    131,    132,    133,    134,    135,    136,    137,
4651         138,    139,    141,    142,    143,    144,    145,    146
4652 };
4653 #endif
4654 #else
4655 EXTCONST unsigned char PL_freq[];
4656 #endif
4657
4658 /* Although only used for debugging, these constants must be available in
4659  * non-debugging builds too, since they're used in ext/re/re_exec.c,
4660  * which has DEBUGGING enabled always */
4661 #ifdef DOINIT
4662 EXTCONST char* const PL_block_type[] = {
4663         "NULL",
4664         "WHEN",
4665         "BLOCK",
4666         "GIVEN",
4667         "LOOP_ARY",
4668         "LOOP_LAZYSV",
4669         "LOOP_LAZYIV",
4670         "LOOP_LIST",
4671         "LOOP_PLAIN",
4672         "SUB",
4673         "FORMAT",
4674         "EVAL",
4675         "SUBST"
4676 };
4677 #else
4678 EXTCONST char* PL_block_type[];
4679 #endif
4680
4681 /* These are all the compile time options that affect binary compatibility.
4682    Other compile time options that are binary compatible are in perl.c
4683    (in S_Internals_V()). Both are combined for the output of perl -V
4684    However, this string will be embedded in any shared perl library, which will
4685    allow us add a comparison check in perlmain.c in the near future.  */
4686 #ifdef DOINIT
4687 EXTCONST char PL_bincompat_options[] =
4688 #  ifdef DEBUG_LEAKING_SCALARS
4689                              " DEBUG_LEAKING_SCALARS"
4690 #  endif
4691 #  ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4692                              " DEBUG_LEAKING_SCALARS_FORK_DUMP"
4693 #  endif
4694 #  ifdef FCRYPT
4695                              " FCRYPT"
4696 #  endif
4697 #  ifdef HAS_TIMES
4698                              " HAS_TIMES"
4699 #  endif
4700 #  ifdef HAVE_INTERP_INTERN
4701                              " HAVE_INTERP_INTERN"
4702 #  endif
4703 #  ifdef MULTIPLICITY
4704                              " MULTIPLICITY"
4705 #  endif
4706 #  ifdef MYMALLOC
4707                              " MYMALLOC"
4708 #  endif
4709 #  ifdef PERLIO_LAYERS
4710                              " PERLIO_LAYERS"
4711 #  endif
4712 #  ifdef PERL_DEBUG_READONLY_COW
4713                              " PERL_DEBUG_READONLY_COW"
4714 #  endif
4715 #  ifdef PERL_DEBUG_READONLY_OPS
4716                              " PERL_DEBUG_READONLY_OPS"
4717 #  endif
4718 #  ifdef PERL_GLOBAL_STRUCT
4719                              " PERL_GLOBAL_STRUCT"
4720 #  endif
4721 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
4722                              " PERL_GLOBAL_STRUCT_PRIVATE"
4723 #  endif
4724 #  ifdef PERL_IMPLICIT_CONTEXT
4725                              " PERL_IMPLICIT_CONTEXT"
4726 #  endif
4727 #  ifdef PERL_IMPLICIT_SYS
4728                              " PERL_IMPLICIT_SYS"
4729 #  endif
4730 #  ifdef PERL_MICRO
4731                              " PERL_MICRO"
4732 #  endif
4733 #  ifdef PERL_NEED_APPCTX
4734                              " PERL_NEED_APPCTX"
4735 #  endif
4736 #  ifdef PERL_NEED_TIMESBASE
4737                              " PERL_NEED_TIMESBASE"
4738 #  endif
4739 #  ifdef PERL_POISON
4740                              " PERL_POISON"
4741 #  endif
4742 #  ifdef PERL_SAWAMPERSAND
4743                              " PERL_SAWAMPERSAND"
4744 #  endif
4745 #  ifdef PERL_TRACK_MEMPOOL
4746                              " PERL_TRACK_MEMPOOL"
4747 #  endif
4748 #  ifdef PERL_USES_PL_PIDSTATUS
4749                              " PERL_USES_PL_PIDSTATUS"
4750 #  endif
4751 #  ifdef USE_64_BIT_ALL
4752                              " USE_64_BIT_ALL"
4753 #  endif
4754 #  ifdef USE_64_BIT_INT
4755                              " USE_64_BIT_INT"
4756 #  endif
4757 #  ifdef USE_IEEE
4758                              " USE_IEEE"
4759 #  endif
4760 #  ifdef USE_ITHREADS
4761                              " USE_ITHREADS"
4762 #  endif
4763 #  ifdef USE_LARGE_FILES
4764                              " USE_LARGE_FILES"
4765 #  endif
4766 #  ifdef USE_LOCALE_COLLATE
4767                              " USE_LOCALE_COLLATE"
4768 #  endif
4769 #  ifdef USE_LOCALE_NUMERIC
4770                              " USE_LOCALE_NUMERIC"
4771 #  endif
4772 #  ifdef USE_LOCALE_TIME
4773                              " USE_LOCALE_TIME"
4774 #  endif
4775 #  ifdef USE_LONG_DOUBLE
4776                              " USE_LONG_DOUBLE"
4777 #  endif
4778 #  ifdef USE_PERLIO
4779                              " USE_PERLIO"
4780 #  endif
4781 #  ifdef USE_QUADMATH
4782                              " USE_QUADMATH"
4783 #  endif
4784 #  ifdef USE_REENTRANT_API
4785                              " USE_REENTRANT_API"
4786 #  endif
4787 #  ifdef USE_SOCKS
4788                              " USE_SOCKS"
4789 #  endif
4790 #  ifdef VMS_DO_SOCKETS
4791                              " VMS_DO_SOCKETS"
4792 #  endif
4793 #  ifdef VMS_SHORTEN_LONG_SYMBOLS
4794                              " VMS_SHORTEN_LONG_SYMBOLS"
4795 #  endif
4796 #  ifdef VMS_WE_ARE_CASE_SENSITIVE
4797                              " VMS_SYMBOL_CASE_AS_IS"
4798 #  endif
4799   "";
4800 #else
4801 EXTCONST char PL_bincompat_options[];
4802 #endif
4803
4804 #ifndef PERL_SET_PHASE
4805 #  define PERL_SET_PHASE(new_phase) \
4806     PERL_DTRACE_PROBE_PHASE(new_phase); \
4807     PL_phase = new_phase;
4808 #endif
4809
4810 /* The interpreter phases. If these ever change, PL_phase_names right below will
4811  * need to be updated accordingly. */
4812 enum perl_phase {
4813     PERL_PHASE_CONSTRUCT        = 0,
4814     PERL_PHASE_START            = 1,
4815     PERL_PHASE_CHECK            = 2,
4816     PERL_PHASE_INIT             = 3,
4817     PERL_PHASE_RUN              = 4,
4818     PERL_PHASE_END              = 5,
4819     PERL_PHASE_DESTRUCT         = 6
4820 };
4821
4822 #ifdef DOINIT
4823 EXTCONST char *const PL_phase_names[] = {
4824     "CONSTRUCT",
4825     "START",
4826     "CHECK",
4827     "INIT",
4828     "RUN",
4829     "END",
4830     "DESTRUCT"
4831 };
4832 #else
4833 EXTCONST char *const PL_phase_names[];
4834 #endif
4835
4836 #ifndef PERL_CORE
4837 /* Do not use this macro. It only exists for extensions that rely on PL_dirty
4838  * instead of using the newer PL_phase, which provides everything PL_dirty
4839  * provided, and more. */
4840 #  define PL_dirty cBOOL(PL_phase == PERL_PHASE_DESTRUCT)
4841
4842 #  define PL_amagic_generation PL_na
4843 #  define PL_encoding ((SV *)NULL)
4844 #endif /* !PERL_CORE */
4845
4846 #define PL_hints PL_compiling.cop_hints
4847 #define PL_maxo  MAXO
4848
4849 END_EXTERN_C
4850
4851 /*****************************************************************************/
4852 /* This lexer/parser stuff is currently global since yacc is hard to reenter */
4853 /*****************************************************************************/
4854 /* XXX This needs to be revisited, since BEGIN makes yacc re-enter... */
4855
4856 #ifdef __Lynx__
4857 /* LynxOS defines these in scsi.h which is included via ioctl.h */
4858 #ifdef FORMAT
4859 #undef FORMAT
4860 #endif
4861 #ifdef SPACE
4862 #undef SPACE
4863 #endif
4864 #endif
4865
4866 #define LEX_NOTPARSING          11      /* borrowed from toke.c */
4867
4868 typedef enum {
4869     XOPERATOR,
4870     XTERM,
4871     XREF,
4872     XSTATE,
4873     XBLOCK,
4874     XATTRBLOCK,
4875     XATTRTERM,
4876     XTERMBLOCK,
4877     XBLOCKTERM,
4878     XPOSTDEREF,
4879     XTERMORDORDOR /* evil hack */
4880     /* update exp_name[] in toke.c if adding to this enum */
4881 } expectation;
4882
4883 #define KEY_sigvar 0xFFFF /* fake keyword representing a signature var */
4884
4885 /* Hints are now stored in a dedicated U32, so the bottom 8 bits are no longer
4886    special and there is no need for HINT_PRIVATE_MASK for COPs
4887    However, bitops store HINT_INTEGER in their op_private.
4888
4889     NOTE: The typical module using these has the bit value hard-coded, so don't
4890     blindly change the values of these.
4891
4892    If we run out of bits, the 2 locale ones could be combined.  The PARTIAL one
4893    is for "use locale 'FOO'" which excludes some categories.  It requires going
4894    to %^H to find out which are in and which are out.  This could be extended
4895    for the normal case of a plain HINT_LOCALE, so that %^H would be used for
4896    any locale form. */
4897 #define HINT_INTEGER            0x00000001 /* integer pragma */
4898 #define HINT_STRICT_REFS        0x00000002 /* strict pragma */
4899 #define HINT_LOCALE             0x00000004 /* locale pragma */
4900 #define HINT_BYTES              0x00000008 /* bytes pragma */
4901 #define HINT_LOCALE_PARTIAL     0x00000010 /* locale, but a subset of categories */
4902
4903 #define HINT_EXPLICIT_STRICT_REFS       0x00000020 /* strict.pm */
4904 #define HINT_EXPLICIT_STRICT_SUBS       0x00000040 /* strict.pm */
4905 #define HINT_EXPLICIT_STRICT_VARS       0x00000080 /* strict.pm */
4906
4907 #define HINT_BLOCK_SCOPE        0x00000100
4908 #define HINT_STRICT_SUBS        0x00000200 /* strict pragma */
4909 #define HINT_STRICT_VARS        0x00000400 /* strict pragma */
4910 #define HINT_UNI_8_BIT          0x00000800 /* unicode_strings feature */
4911
4912 /* The HINT_NEW_* constants are used by the overload pragma */
4913 #define HINT_NEW_INTEGER        0x00001000
4914 #define HINT_NEW_FLOAT          0x00002000
4915 #define HINT_NEW_BINARY         0x00004000
4916 #define HINT_NEW_STRING         0x00008000
4917 #define HINT_NEW_RE             0x00010000
4918 #define HINT_LOCALIZE_HH        0x00020000 /* %^H needs to be copied */
4919 #define HINT_LEXICAL_IO_IN      0x00040000 /* ${^OPEN} is set for input */
4920 #define HINT_LEXICAL_IO_OUT     0x00080000 /* ${^OPEN} is set for output */
4921
4922 #define HINT_RE_TAINT           0x00100000 /* re pragma */
4923 #define HINT_RE_EVAL            0x00200000 /* re pragma */
4924
4925 #define HINT_FILETEST_ACCESS    0x00400000 /* filetest pragma */
4926 #define HINT_UTF8               0x00800000 /* utf8 pragma */
4927
4928 #define HINT_NO_AMAGIC          0x01000000 /* overloading pragma */
4929
4930 #define HINT_RE_FLAGS           0x02000000 /* re '/xism' pragma */
4931
4932 #define HINT_FEATURE_MASK       0x1c000000 /* 3 bits for feature bundles */
4933
4934                                 /* Note: Used for HINT_M_VMSISH_*,
4935                                    currently defined by vms/vmsish.h:
4936                                 0x40000000
4937                                 0x80000000
4938                                  */
4939
4940 /* The following are stored in $^H{sort}, not in PL_hints */
4941 #define HINT_SORT_SORT_BITS     0x000000FF /* allow 256 different ones */
4942 #define HINT_SORT_QUICKSORT     0x00000001
4943 #define HINT_SORT_MERGESORT     0x00000002
4944 #define HINT_SORT_STABLE        0x00000100 /* sort styles */
4945 #define HINT_SORT_UNSTABLE      0x00000200
4946
4947 /* flags for PL_sawampersand */
4948
4949 #define SAWAMPERSAND_LEFT       1   /* saw $` */
4950 #define SAWAMPERSAND_MIDDLE     2   /* saw $& */
4951 #define SAWAMPERSAND_RIGHT      4   /* saw $' */
4952
4953 #ifndef PERL_SAWAMPERSAND
4954 # define PL_sawampersand \
4955         (SAWAMPERSAND_LEFT|SAWAMPERSAND_MIDDLE|SAWAMPERSAND_RIGHT)
4956 #endif
4957
4958 /* Used for debugvar magic */
4959 #define DBVARMG_SINGLE  0
4960 #define DBVARMG_TRACE   1
4961 #define DBVARMG_SIGNAL  2
4962 #define DBVARMG_COUNT   3
4963
4964 #define PL_DBsingle_iv  (PL_DBcontrol[DBVARMG_SINGLE])
4965 #define PL_DBtrace_iv   (PL_DBcontrol[DBVARMG_TRACE])
4966 #define PL_DBsignal_iv  (PL_DBcontrol[DBVARMG_SIGNAL])
4967
4968 /* Various states of the input record separator SV (rs) */
4969 #define RsSNARF(sv)   (! SvOK(sv))
4970 #define RsSIMPLE(sv)  (SvOK(sv) && (! SvPOK(sv) || SvCUR(sv)))
4971 #define RsPARA(sv)    (SvPOK(sv) && ! SvCUR(sv))
4972 #define RsRECORD(sv)  (SvROK(sv) && (SvIV(SvRV(sv)) > 0))
4973
4974 /* A struct for keeping various DEBUGGING related stuff,
4975  * neatly packed.  Currently only scratch variables for
4976  * constructing debug output are included.  Needed always,
4977  * not just when DEBUGGING, though, because of the re extension. c*/
4978 struct perl_debug_pad {
4979   SV pad[3];
4980 };
4981
4982 #define PERL_DEBUG_PAD(i)       &(PL_debug_pad.pad[i])
4983 #define PERL_DEBUG_PAD_ZERO(i)  (SvPVX(PERL_DEBUG_PAD(i))[0] = 0, \
4984         (((XPV*) SvANY(PERL_DEBUG_PAD(i)))->xpv_cur = 0), \
4985         PERL_DEBUG_PAD(i))
4986
4987 /* Enable variables which are pointers to functions */
4988 typedef void (*peep_t)(pTHX_ OP* o);
4989 typedef regexp* (*regcomp_t) (pTHX_ char* exp, char* xend, PMOP* pm);
4990 typedef I32     (*regexec_t) (pTHX_ regexp* prog, char* stringarg,
4991                                       char* strend, char* strbeg, I32 minend,
4992                                       SV* screamer, void* data, U32 flags);
4993 typedef char*   (*re_intuit_start_t) (pTHX_ regexp *prog, SV *sv,
4994                                                 char *strpos, char *strend,
4995                                                 U32 flags,
4996                                                 re_scream_pos_data *d);
4997 typedef SV*     (*re_intuit_string_t) (pTHX_ regexp *prog);
4998 typedef void    (*regfree_t) (pTHX_ struct regexp* r);
4999 typedef regexp* (*regdupe_t) (pTHX_ const regexp* r, CLONE_PARAMS *param);
5000 typedef I32     (*re_fold_t)(const char *, char const *, I32);
5001
5002 typedef void (*DESTRUCTORFUNC_NOCONTEXT_t) (void*);
5003 typedef void (*DESTRUCTORFUNC_t) (pTHX_ void*);
5004 typedef void (*SVFUNC_t) (pTHX_ SV* const);
5005 typedef I32  (*SVCOMPARE_t) (pTHX_ SV* const, SV* const);
5006 typedef void (*XSINIT_t) (pTHX);
5007 typedef void (*ATEXIT_t) (pTHX_ void*);
5008 typedef void (*XSUBADDR_t) (pTHX_ CV *);
5009
5010 typedef OP* (*Perl_ppaddr_t)(pTHX);
5011 typedef OP* (*Perl_check_t) (pTHX_ OP*);
5012 typedef void(*Perl_ophook_t)(pTHX_ OP*);
5013 typedef int (*Perl_keyword_plugin_t)(pTHX_ char*, STRLEN, OP**);
5014 typedef void(*Perl_cpeep_t)(pTHX_ OP *, OP *);
5015
5016 typedef void(*globhook_t)(pTHX);
5017
5018 #define KEYWORD_PLUGIN_DECLINE 0
5019 #define KEYWORD_PLUGIN_STMT    1
5020 #define KEYWORD_PLUGIN_EXPR    2
5021
5022 /* Interpreter exitlist entry */
5023 typedef struct exitlistentry {
5024     void (*fn) (pTHX_ void*);
5025     void *ptr;
5026 } PerlExitListEntry;
5027
5028 /* if you only have signal() and it resets on each signal, FAKE_PERSISTENT_SIGNAL_HANDLERS fixes */
5029 /* These have to be before perlvars.h */
5030 #if !defined(HAS_SIGACTION) && defined(VMS)
5031 #  define  FAKE_PERSISTENT_SIGNAL_HANDLERS
5032 #endif
5033 /* if we're doing kill() with sys$sigprc on VMS, FAKE_DEFAULT_SIGNAL_HANDLERS */
5034 #if defined(KILL_BY_SIGPRC)
5035 #  define  FAKE_DEFAULT_SIGNAL_HANDLERS
5036 #endif
5037
5038 #if !defined(MULTIPLICITY)
5039
5040 struct interpreter {
5041     char broiled;
5042 };
5043
5044 #else
5045
5046 /* If we have multiple interpreters define a struct
5047    holding variables which must be per-interpreter
5048    If we don't have threads anything that would have
5049    be per-thread is per-interpreter.
5050 */
5051
5052 /* Set up PERLVAR macros for populating structs */
5053 #  define PERLVAR(prefix,var,type) type prefix##var;
5054
5055 /* 'var' is an array of length 'n' */
5056 #  define PERLVARA(prefix,var,n,type) type prefix##var[n];
5057
5058 /* initialize 'var' to init' */
5059 #  define PERLVARI(prefix,var,type,init) type prefix##var;
5060
5061 /* like PERLVARI, but make 'var' a const */
5062 #  define PERLVARIC(prefix,var,type,init) type prefix##var;
5063
5064 struct interpreter {
5065 #  include "intrpvar.h"
5066 };
5067
5068 EXTCONST U16 PL_interp_size
5069   INIT(sizeof(struct interpreter));
5070
5071 #  define PERL_INTERPRETER_SIZE_UPTO_MEMBER(member)                     \
5072     STRUCT_OFFSET(struct interpreter, member) +                         \
5073     sizeof(((struct interpreter*)0)->member)
5074
5075 /* This will be useful for subsequent releases, because this has to be the
5076    same in your libperl as in main(), else you have a mismatch and must abort.
5077 */
5078 EXTCONST U16 PL_interp_size_5_18_0
5079   INIT(PERL_INTERPRETER_SIZE_UPTO_MEMBER(PERL_LAST_5_18_0_INTERP_MEMBER));
5080
5081
5082 #  ifdef PERL_GLOBAL_STRUCT
5083 /* MULTIPLICITY is automatically defined when PERL_GLOBAL_STRUCT is defined,
5084    hence it's safe and sane to nest this within #ifdef MULTIPLICITY  */
5085
5086 struct perl_vars {
5087 #    include "perlvars.h"
5088 };
5089
5090 EXTCONST U16 PL_global_struct_size
5091   INIT(sizeof(struct perl_vars));
5092
5093 #    ifdef PERL_CORE
5094 #      ifndef PERL_GLOBAL_STRUCT_PRIVATE
5095 EXT struct perl_vars PL_Vars;
5096 EXT struct perl_vars *PL_VarsPtr INIT(&PL_Vars);
5097 #        undef PERL_GET_VARS
5098 #        define PERL_GET_VARS() PL_VarsPtr
5099 #      endif /* !PERL_GLOBAL_STRUCT_PRIVATE */
5100 #    else /* PERL_CORE */
5101 #      if !defined(__GNUC__) || !defined(WIN32)
5102 EXT
5103 #      endif /* WIN32 */
5104 struct perl_vars *PL_VarsPtr;
5105 #      define PL_Vars (*((PL_VarsPtr) \
5106                        ? PL_VarsPtr : (PL_VarsPtr = Perl_GetVars(aTHX))))
5107 #    endif /* PERL_CORE */
5108 #  endif /* PERL_GLOBAL_STRUCT */
5109
5110 /* Done with PERLVAR macros for now ... */
5111 #  undef PERLVAR
5112 #  undef PERLVARA
5113 #  undef PERLVARI
5114 #  undef PERLVARIC
5115
5116 #endif /* MULTIPLICITY */
5117
5118 struct tempsym; /* defined in pp_pack.c */
5119
5120 #include "thread.h"
5121 #include "pp.h"
5122
5123 #undef PERL_CKDEF
5124 #undef PERL_PPDEF
5125 #define PERL_CKDEF(s)   PERL_CALLCONV OP *s (pTHX_ OP *o);
5126 #define PERL_PPDEF(s)   PERL_CALLCONV OP *s (pTHX);
5127
5128 #ifdef MYMALLOC
5129 #  include "malloc_ctl.h"
5130 #endif
5131
5132 /*
5133  * This provides a layer of functions and macros to ensure extensions will
5134  * get to use the same RTL functions as the core.
5135  */
5136 #if defined(WIN32)
5137 #  include "win32iop.h"
5138 #endif
5139
5140
5141 #include "proto.h"
5142
5143 /* this has structure inits, so it cannot be included before here */
5144 #include "opcode.h"
5145
5146 /* The following must follow proto.h as #defines mess up syntax */
5147
5148 #if !defined(PERL_FOR_X2P)
5149 #  include "embedvar.h"
5150 #endif
5151
5152 /* Now include all the 'global' variables
5153  * If we don't have threads or multiple interpreters
5154  * these include variables that would have been their struct-s
5155  */
5156
5157 #define PERLVAR(prefix,var,type) EXT type PL_##var;
5158 #define PERLVARA(prefix,var,n,type) EXT type PL_##var[n];
5159 #define PERLVARI(prefix,var,type,init) EXT type  PL_##var INIT(init);
5160 #define PERLVARIC(prefix,var,type,init) EXTCONST type PL_##var INIT(init);
5161
5162 #if !defined(MULTIPLICITY)
5163 START_EXTERN_C
5164 #  include "intrpvar.h"
5165 END_EXTERN_C
5166 #  define PL_sv_yes   (PL_sv_immortals[0])
5167 #  define PL_sv_undef (PL_sv_immortals[1])
5168 #  define PL_sv_no    (PL_sv_immortals[2])
5169 #  define PL_sv_zero  (PL_sv_immortals[3])
5170 #endif
5171
5172 #ifdef PERL_CORE
5173 /* All core uses now exterminated. Ensure no zombies can return:  */
5174 #  undef PL_na
5175 #endif
5176
5177 /* Now all the config stuff is setup we can include embed.h
5178    In particular, need the relevant *ish file included already, as it may
5179    define HAVE_INTERP_INTERN  */
5180 #include "embed.h"
5181
5182 #ifndef PERL_GLOBAL_STRUCT
5183 START_EXTERN_C
5184
5185 #  include "perlvars.h"
5186
5187 END_EXTERN_C
5188 #endif
5189
5190 #undef PERLVAR
5191 #undef PERLVARA
5192 #undef PERLVARI
5193 #undef PERLVARIC
5194
5195 #if !defined(MULTIPLICITY)
5196 /* Set up PERLVAR macros for populating structs */
5197 #  define PERLVAR(prefix,var,type) type prefix##var;
5198 /* 'var' is an array of length 'n' */
5199 #  define PERLVARA(prefix,var,n,type) type prefix##var[n];
5200 /* initialize 'var' to init' */
5201 #  define PERLVARI(prefix,var,type,init) type prefix##var;
5202 /* like PERLVARI, but make 'var' a const */
5203 #  define PERLVARIC(prefix,var,type,init) type prefix##var;
5204
5205 /* this is never instantiated, is it just used for sizeof(struct PerlHandShakeInterpreter) */
5206 struct PerlHandShakeInterpreter {
5207 #  include "intrpvar.h"
5208 };
5209 #  undef PERLVAR
5210 #  undef PERLVARA
5211 #  undef PERLVARI
5212 #  undef PERLVARIC
5213 #endif
5214
5215 START_EXTERN_C
5216
5217 /* dummy variables that hold pointers to both runops functions, thus forcing
5218  * them *both* to get linked in (useful for Peek.xs, debugging etc) */
5219
5220 EXTCONST runops_proc_t PL_runops_std
5221   INIT(Perl_runops_standard);
5222 EXTCONST runops_proc_t PL_runops_dbg
5223   INIT(Perl_runops_debug);
5224
5225 #define EXT_MGVTBL EXTCONST MGVTBL
5226
5227 #define PERL_MAGIC_READONLY_ACCEPTABLE 0x40
5228 #define PERL_MAGIC_VALUE_MAGIC 0x80
5229 #define PERL_MAGIC_VTABLE_MASK 0x3F
5230 #define PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(t) \
5231     (PL_magic_data[(U8)(t)] & PERL_MAGIC_READONLY_ACCEPTABLE)
5232 #define PERL_MAGIC_TYPE_IS_VALUE_MAGIC(t) \
5233     (PL_magic_data[(U8)(t)] & PERL_MAGIC_VALUE_MAGIC)
5234
5235 #include "mg_vtable.h"
5236
5237 #ifdef DOINIT
5238 EXTCONST U8 PL_magic_data[256] =
5239 #  ifdef PERL_MICRO
5240 #    include "umg_data.h"
5241 #  else
5242 #    include "mg_data.h"
5243 #  endif
5244 ;
5245 #else
5246 EXTCONST U8 PL_magic_data[256];
5247 #endif
5248
5249 #ifdef DOINIT
5250                         /* NL IV NV PV INV PI PN MG RX GV LV AV HV CV FM IO */
5251 EXTCONST bool
5252 PL_valid_types_IVX[]    = { 0, 1, 0, 0, 0, 1, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5253 EXTCONST bool
5254 PL_valid_types_NVX[]    = { 0, 0, 1, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5255 EXTCONST bool
5256 PL_valid_types_PVX[]    = { 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1 };
5257 EXTCONST bool
5258 PL_valid_types_RV[]     = { 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1 };
5259 EXTCONST bool
5260 PL_valid_types_IV_set[] = { 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1 };
5261 EXTCONST bool
5262 PL_valid_types_NV_set[] = { 0, 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0 };
5263
5264 #else
5265
5266 EXTCONST bool PL_valid_types_IVX[];
5267 EXTCONST bool PL_valid_types_NVX[];
5268 EXTCONST bool PL_valid_types_PVX[];
5269 EXTCONST bool PL_valid_types_RV[];
5270 EXTCONST bool PL_valid_types_IV_set[];
5271 EXTCONST bool PL_valid_types_NV_set[];
5272
5273 #endif
5274
5275 /* In C99 we could use designated (named field) union initializers.
5276  * In C89 we need to initialize the member declared first.
5277  * In C++ we need extern C initializers.
5278  *
5279  * With the U8_NV version you will want to have inner braces,
5280  * while with the NV_U8 use just the NV. */
5281
5282 #ifdef __cplusplus
5283 #define INFNAN_U8_NV_DECL EXTERN_C const union { U8 u8[NVSIZE]; NV nv; }
5284 #define INFNAN_NV_U8_DECL EXTERN_C const union { NV nv; U8 u8[NVSIZE]; }
5285 #else
5286 #define INFNAN_U8_NV_DECL EXTCONST union { U8 u8[NVSIZE]; NV nv; }
5287 #define INFNAN_NV_U8_DECL EXTCONST union { NV nv; U8 u8[NVSIZE]; }
5288 #endif
5289
5290 /* if these never got defined, they need defaults */
5291 #ifndef PERL_SET_CONTEXT
5292 #  define PERL_SET_CONTEXT(i)           PERL_SET_INTERP(i)
5293 #endif
5294
5295 #ifndef PERL_GET_CONTEXT
5296 #  define PERL_GET_CONTEXT              PERL_GET_INTERP
5297 #endif
5298
5299 #ifndef PERL_GET_THX
5300 #  define PERL_GET_THX                  ((void*)NULL)
5301 #endif
5302
5303 #ifndef PERL_SET_THX
5304 #  define PERL_SET_THX(t)               NOOP
5305 #endif
5306
5307
5308 #ifndef PERL_NO_INLINE_FUNCTIONS
5309 /* Static inline funcs that depend on includes and declarations above.
5310    Some of these reference functions in the perl object files, and some
5311    compilers aren't smart enough to eliminate unused static inline
5312    functions, so including this file in source code can cause link errors
5313    even if the source code uses none of the functions. Hence including these
5314    can be be suppressed by setting PERL_NO_INLINE_FUNCTIONS. Doing this will
5315    (obviously) result in unworkable XS code, but allows simple probing code
5316    to continue to work, because it permits tests to include the perl headers
5317    for definitions without creating a link dependency on the perl library
5318    (which may not exist yet).
5319 */
5320
5321 #  include "inline.h"
5322 #endif
5323
5324 #include "overload.h"
5325
5326 END_EXTERN_C
5327
5328 struct am_table {
5329   U8 flags;
5330   U8 fallback;
5331   U16 spare;
5332   U32 was_ok_sub;
5333   CV* table[NofAMmeth];
5334 };
5335 struct am_table_short {
5336   U8 flags;
5337   U8 fallback;
5338   U16 spare;
5339   U32 was_ok_sub;
5340 };
5341 typedef struct am_table AMT;
5342 typedef struct am_table_short AMTS;
5343
5344 #define AMGfallNEVER    1
5345 #define AMGfallNO       2
5346 #define AMGfallYES      3
5347
5348 #define AMTf_AMAGIC             1
5349 #define AMT_AMAGIC(amt)         ((amt)->flags & AMTf_AMAGIC)
5350 #define AMT_AMAGIC_on(amt)      ((amt)->flags |= AMTf_AMAGIC)
5351 #define AMT_AMAGIC_off(amt)     ((amt)->flags &= ~AMTf_AMAGIC)
5352
5353 #define StashHANDLER(stash,meth)        gv_handler((stash),CAT2(meth,_amg))
5354
5355 /*
5356  * some compilers like to redefine cos et alia as faster
5357  * (and less accurate?) versions called F_cos et cetera (Quidquid
5358  * latine dictum sit, altum viditur.)  This trick collides with
5359  * the Perl overloading (amg).  The following #defines fool both.
5360  */
5361
5362 #ifdef _FASTMATH
5363 #   ifdef atan2
5364 #       define F_atan2_amg  atan2_amg
5365 #   endif
5366 #   ifdef cos
5367 #       define F_cos_amg    cos_amg
5368 #   endif
5369 #   ifdef exp
5370 #       define F_exp_amg    exp_amg
5371 #   endif
5372 #   ifdef log
5373 #       define F_log_amg    log_amg
5374 #   endif
5375 #   ifdef pow
5376 #       define F_pow_amg    pow_amg
5377 #   endif
5378 #   ifdef sin
5379 #       define F_sin_amg    sin_amg
5380 #   endif
5381 #   ifdef sqrt
5382 #       define F_sqrt_amg   sqrt_amg
5383 #   endif
5384 #endif /* _FASTMATH */
5385
5386 #define PERLDB_ALL              (PERLDBf_SUB    | PERLDBf_LINE  |       \
5387                                  PERLDBf_NOOPT  | PERLDBf_INTER |       \
5388                                  PERLDBf_SUBLINE| PERLDBf_SINGLE|       \
5389                                  PERLDBf_NAMEEVAL| PERLDBf_NAMEANON |   \
5390                                  PERLDBf_SAVESRC)
5391                                         /* No _NONAME, _GOTO */
5392 #define PERLDBf_SUB             0x01    /* Debug sub enter/exit */
5393 #define PERLDBf_LINE            0x02    /* Keep line # */
5394 #define PERLDBf_NOOPT           0x04    /* Switch off optimizations */
5395 #define PERLDBf_INTER           0x08    /* Preserve more data for
5396                                            later inspections  */
5397 #define PERLDBf_SUBLINE         0x10    /* Keep subr source lines */
5398 #define PERLDBf_SINGLE          0x20    /* Start with single-step on */
5399 #define PERLDBf_NONAME          0x40    /* For _SUB: no name of the subr */
5400 #define PERLDBf_GOTO            0x80    /* Report goto: call DB::goto */
5401 #define PERLDBf_NAMEEVAL        0x100   /* Informative names for evals */
5402 #define PERLDBf_NAMEANON        0x200   /* Informative names for anon subs */
5403 #define PERLDBf_SAVESRC         0x400   /* Save source lines into @{"_<$filename"} */
5404 #define PERLDBf_SAVESRC_NOSUBS  0x800   /* Including evals that generate no subroutines */
5405 #define PERLDBf_SAVESRC_INVALID 0x1000  /* Save source that did not compile */
5406
5407 #define PERLDB_SUB              (PL_perldb & PERLDBf_SUB)
5408 #define PERLDB_LINE             (PL_perldb & PERLDBf_LINE)
5409 #define PERLDB_NOOPT            (PL_perldb & PERLDBf_NOOPT)
5410 #define PERLDB_INTER            (PL_perldb & PERLDBf_INTER)
5411 #define PERLDB_SUBLINE          (PL_perldb & PERLDBf_SUBLINE)
5412 #define PERLDB_SINGLE           (PL_perldb & PERLDBf_SINGLE)
5413 #define PERLDB_SUB_NN           (PL_perldb & PERLDBf_NONAME)
5414 #define PERLDB_GOTO             (PL_perldb & PERLDBf_GOTO)
5415 #define PERLDB_NAMEEVAL         (PL_perldb & PERLDBf_NAMEEVAL)
5416 #define PERLDB_NAMEANON         (PL_perldb & PERLDBf_NAMEANON)
5417 #define PERLDB_SAVESRC          (PL_perldb & PERLDBf_SAVESRC)
5418 #define PERLDB_SAVESRC_NOSUBS   (PL_perldb & PERLDBf_SAVESRC_NOSUBS)
5419 #define PERLDB_SAVESRC_INVALID  (PL_perldb & PERLDBf_SAVESRC_INVALID)
5420
5421 #define PERLDB_LINE_OR_SAVESRC (PL_perldb & (PERLDBf_LINE | PERLDBf_SAVESRC))
5422
5423 #ifdef USE_LOCALE
5424 /* These locale things are all subject to change */
5425
5426
5427 #  if      defined(HAS_NEWLOCALE)               \
5428       &&   defined(LC_ALL_MASK)                 \
5429       &&   defined(HAS_FREELOCALE)              \
5430       &&   defined(HAS_USELOCALE)               \
5431       && ! defined(NO_POSIX_2008_LOCALE)
5432
5433     /* The code is written for simplicity to assume that any platform advanced
5434      * enough to have the Posix 2008 locale functions has LC_ALL.  The test
5435      * above makes sure that assumption is valid */
5436
5437 #    define HAS_POSIX_2008_LOCALE
5438 #  endif
5439
5440 /* We create a C locale object unconditionally if we have the functions to do
5441  * so; hence must destroy it unconditionally at the end */
5442 #  ifndef HAS_POSIX_2008_LOCALE
5443 #    define _LOCALE_TERM_POSIX_2008  NOOP
5444 #  else
5445 #    define _LOCALE_TERM_POSIX_2008                                         \
5446                     STMT_START {                                            \
5447                         if (PL_C_locale_obj) {                              \
5448                             /* Make sure we aren't using the locale         \
5449                              * space we are about to free */                \
5450                             uselocale(LC_GLOBAL_LOCALE);                    \
5451                             freelocale(PL_C_locale_obj);                    \
5452                             PL_C_locale_obj = (locale_t) NULL;              \
5453                         }                                                   \
5454                     } STMT_END
5455 #  endif
5456
5457 #  ifndef USE_ITHREADS
5458 #    define LOCALE_INIT
5459 #    define LOCALE_LOCK
5460 #    define LOCALE_UNLOCK
5461 #    define LOCALE_TERM  STMT_START { _LOCALE_TERM_POSIX_2008; } STMT_END
5462 #  else /* Below is do use threads */
5463 #    define LOCALE_INIT         MUTEX_INIT(&PL_locale_mutex)
5464 #    define LOCALE_LOCK         MUTEX_LOCK(&PL_locale_mutex)
5465 #    define LOCALE_UNLOCK       MUTEX_UNLOCK(&PL_locale_mutex)
5466 #    define LOCALE_TERM                                                     \
5467                     STMT_START {                                            \
5468                         MUTEX_DESTROY(&PL_locale_mutex);                    \
5469                         _LOCALE_TERM_POSIX_2008;                            \
5470                     } STMT_END
5471 #    ifdef HAS_POSIX_2008_LOCALE
5472 #      define USE_POSIX_2008_LOCALE
5473 #      define USE_THREAD_SAFE_LOCALE
5474 #    endif
5475 #  endif
5476
5477 /* Returns TRUE if the plain locale pragma without a parameter is in effect
5478  */
5479 #   define IN_LOCALE_RUNTIME    (PL_curcop \
5480                                 && CopHINTS_get(PL_curcop) & HINT_LOCALE)
5481
5482 /* Returns TRUE if either form of the locale pragma is in effect */
5483 #   define IN_SOME_LOCALE_FORM_RUNTIME   \
5484            cBOOL(CopHINTS_get(PL_curcop) & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
5485
5486 #   define IN_LOCALE_COMPILETIME        cBOOL(PL_hints & HINT_LOCALE)
5487 #   define IN_SOME_LOCALE_FORM_COMPILETIME \
5488                           cBOOL(PL_hints & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
5489
5490 #   define IN_LOCALE \
5491         (IN_PERL_COMPILETIME ? IN_LOCALE_COMPILETIME : IN_LOCALE_RUNTIME)
5492 #   define IN_SOME_LOCALE_FORM \
5493         (IN_PERL_COMPILETIME ? IN_SOME_LOCALE_FORM_COMPILETIME \
5494                              : IN_SOME_LOCALE_FORM_RUNTIME)
5495
5496 #   define IN_LC_ALL_COMPILETIME   IN_LOCALE_COMPILETIME
5497 #   define IN_LC_ALL_RUNTIME       IN_LOCALE_RUNTIME
5498
5499 #   define IN_LC_PARTIAL_COMPILETIME   cBOOL(PL_hints & HINT_LOCALE_PARTIAL)
5500 #   define IN_LC_PARTIAL_RUNTIME  \
5501                (PL_curcop && CopHINTS_get(PL_curcop) & HINT_LOCALE_PARTIAL)
5502
5503 #   define IN_LC_COMPILETIME(category)                                       \
5504        (IN_LC_ALL_COMPILETIME || (IN_LC_PARTIAL_COMPILETIME                  \
5505                   && Perl__is_in_locale_category(aTHX_ TRUE, (category))))
5506 #   define IN_LC_RUNTIME(category)                                           \
5507        (IN_LC_ALL_RUNTIME || (IN_LC_PARTIAL_RUNTIME                          \
5508                   && Perl__is_in_locale_category(aTHX_ FALSE, (category))))
5509 #   define IN_LC(category)  \
5510                     (IN_LC_COMPILETIME(category) || IN_LC_RUNTIME(category))
5511
5512 #   if defined (PERL_CORE) || defined (PERL_IN_XSUB_RE)
5513
5514         /* This internal macro should be called from places that operate under
5515          * locale rules.  It there is a problem with the current locale that
5516          * hasn't been raised yet, it will output a warning this time.  Because
5517          * this will so rarely  be true, there is no point to optimize for
5518          * time; instead it makes sense to minimize space used and do all the
5519          * work in the rarely called function */
5520 #       ifdef USE_LOCALE_CTYPE
5521 #           define _CHECK_AND_WARN_PROBLEMATIC_LOCALE                         \
5522                 STMT_START {                                                  \
5523                     if (UNLIKELY(PL_warn_locale)) {                           \
5524                         Perl__warn_problematic_locale();                      \
5525                     }                                                         \
5526                 }  STMT_END
5527 #       else
5528 #           define _CHECK_AND_WARN_PROBLEMATIC_LOCALE
5529 #       endif
5530
5531
5532     /* These two internal macros are called when a warning should be raised,
5533      * and will do so if enabled.  The first takes a single code point
5534      * argument; the 2nd, is a pointer to the first byte of the UTF-8 encoded
5535      * string, and an end position which it won't try to read past */
5536 #   define _CHECK_AND_OUTPUT_WIDE_LOCALE_CP_MSG(cp)                         \
5537         STMT_START {                                                        \
5538             if (! PL_in_utf8_CTYPE_locale && ckWARN(WARN_LOCALE)) {         \
5539                 Perl_warner(aTHX_ packWARN(WARN_LOCALE),                    \
5540                                        "Wide character (U+%" UVXf ") in %s",\
5541                                        (UV) cp, OP_DESC(PL_op));            \
5542             }                                                               \
5543         }  STMT_END
5544
5545 #  define _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(s, send)                   \
5546         STMT_START { /* Check if to warn before doing the conversion work */\
5547             if (! PL_in_utf8_CTYPE_locale && ckWARN(WARN_LOCALE)) {         \
5548                 UV cp = utf8_to_uvchr_buf((U8 *) s, (U8 *) send, NULL);     \
5549                 Perl_warner(aTHX_ packWARN(WARN_LOCALE),                    \
5550                     "Wide character (U+%" UVXf ") in %s",                   \
5551                     (cp == 0)                                               \
5552                      ? UNICODE_REPLACEMENT                                  \
5553                      : (UV) cp,                                             \
5554                     OP_DESC(PL_op));                                        \
5555             }                                                               \
5556         }  STMT_END
5557
5558 #   endif   /* PERL_CORE or PERL_IN_XSUB_RE */
5559 #else   /* No locale usage */
5560 #   define LOCALE_INIT
5561 #   define LOCALE_TERM
5562 #   define LOCALE_LOCK
5563 #   define LOCALE_UNLOCK
5564 #   define IN_LOCALE_RUNTIME                0
5565 #   define IN_SOME_LOCALE_FORM_RUNTIME      0
5566 #   define IN_LOCALE_COMPILETIME            0
5567 #   define IN_SOME_LOCALE_FORM_COMPILETIME  0
5568 #   define IN_LOCALE                        0
5569 #   define IN_SOME_LOCALE_FORM              0
5570 #   define IN_LC_ALL_COMPILETIME            0
5571 #   define IN_LC_ALL_RUNTIME                0
5572 #   define IN_LC_PARTIAL_COMPILETIME        0
5573 #   define IN_LC_PARTIAL_RUNTIME            0
5574 #   define IN_LC_COMPILETIME(category)      0
5575 #   define IN_LC_RUNTIME(category)          0
5576 #   define IN_LC(category)                  0
5577
5578 #   define _CHECK_AND_WARN_PROBLEMATIC_LOCALE
5579 #   define _CHECK_AND_OUTPUT_WIDE_LOCALE_CP_MSG(a)
5580 #   define _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(a,b)
5581 #endif
5582
5583 #ifdef USE_LOCALE_NUMERIC
5584
5585 /* These macros are for toggling between the underlying locale (UNDERLYING or
5586  * LOCAL) and the C locale (STANDARD).
5587
5588 =head1 Locale-related functions and macros
5589
5590 =for apidoc Amn|void|DECLARATION_FOR_LC_NUMERIC_MANIPULATION
5591
5592 This macro should be used as a statement.  It declares a private variable
5593 (whose name begins with an underscore) that is needed by the other macros in
5594 this section.  Failing to include this correctly should lead to a syntax error.
5595 For compatibility with C89 C compilers it should be placed in a block before
5596 any executable statements.
5597
5598 =for apidoc Am|void|STORE_LC_NUMERIC_FORCE_TO_UNDERLYING
5599
5600 This is used by XS code that that is C<LC_NUMERIC> locale-aware to force the
5601 locale for category C<LC_NUMERIC> to be what perl thinks is the current
5602 underlying locale.  (The perl interpreter could be wrong about what the
5603 underlying locale actually is if some C or XS code has called the C library
5604 function L<setlocale(3)> behind its back; calling L</sync_locale> before calling
5605 this macro will update perl's records.)
5606
5607 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
5608 declare at compile time a private variable used by this macro.  This macro
5609 should be called as a single statement, not an expression, but with an empty
5610 argument list, like this:
5611
5612  {
5613     DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
5614      ...
5615     STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
5616      ...
5617     RESTORE_LC_NUMERIC();
5618      ...
5619  }
5620
5621 The private variable is used to save the current locale state, so
5622 that the requisite matching call to L</RESTORE_LC_NUMERIC> can restore it.
5623
5624 =for apidoc Am|void|STORE_LC_NUMERIC_SET_TO_NEEDED
5625
5626 This is used to help wrap XS or C code that that is C<LC_NUMERIC> locale-aware.
5627 This locale category is generally kept set to the C locale by Perl for
5628 backwards compatibility, and because most XS code that reads floating point
5629 values can cope only with the decimal radix character being a dot.
5630
5631 This macro makes sure the current C<LC_NUMERIC> state is set properly, to be
5632 aware of locale if the call to the XS or C code from the Perl program is
5633 from within the scope of a S<C<use locale>>; or to ignore locale if the call is
5634 instead from outside such scope.
5635
5636 This macro is the start of wrapping the C or XS code; the wrap ending is done
5637 by calling the L</RESTORE_LC_NUMERIC> macro after the operation.  Otherwise
5638 the state can be changed that will adversely affect other XS code.
5639
5640 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
5641 declare at compile time a private variable used by this macro.  This macro
5642 should be called as a single statement, not an expression, but with an empty
5643 argument list, like this:
5644
5645  {
5646     DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
5647      ...
5648     STORE_LC_NUMERIC_SET_TO_NEEDED();
5649      ...
5650     RESTORE_LC_NUMERIC();
5651      ...
5652  }
5653
5654 =for apidoc Am|void|RESTORE_LC_NUMERIC
5655
5656 This is used in conjunction with one of the macros
5657 L</STORE_LC_NUMERIC_SET_TO_NEEDED>
5658 and
5659 L</STORE_LC_NUMERIC_FORCE_TO_UNDERLYING>
5660
5661 to properly restore the C<LC_NUMERIC> state.
5662
5663 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
5664 declare at compile time a private variable used by this macro and the two
5665 C<STORE> ones.  This macro should be called as a single statement, not an
5666 expression, but with an empty argument list, like this:
5667
5668  {
5669     DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
5670      ...
5671     RESTORE_LC_NUMERIC();
5672      ...
5673  }
5674
5675 =cut
5676
5677 */
5678
5679 #  define _NOT_IN_NUMERIC_STANDARD (! PL_numeric_standard)
5680
5681 /* We can lock the category to stay in the C locale, making requests to the
5682  * contrary be noops, in the dynamic scope by setting PL_numeric_standard to 2.
5683  * */
5684 #  define _NOT_IN_NUMERIC_UNDERLYING                                        \
5685                         (! PL_numeric_underlying && PL_numeric_standard < 2)
5686
5687 #  define DECLARATION_FOR_LC_NUMERIC_MANIPULATION                           \
5688     void (*_restore_LC_NUMERIC_function)(pTHX) = NULL
5689
5690 #  define STORE_LC_NUMERIC_SET_TO_NEEDED()                                  \
5691     if (IN_LC(LC_NUMERIC)) {                                                \
5692         if (_NOT_IN_NUMERIC_UNDERLYING) {                                   \
5693             Perl_set_numeric_underlying(aTHX);                              \
5694             _restore_LC_NUMERIC_function = &Perl_set_numeric_standard;      \
5695         }                                                                   \
5696     }                                                                       \
5697     else {                                                                  \
5698         if (_NOT_IN_NUMERIC_STANDARD) {                                     \
5699             SET_NUMERIC_STANDARD();                                         \
5700             _restore_LC_NUMERIC_function = &Perl_set_numeric_underlying;    \
5701         }                                                                   \
5702     }
5703
5704 #  define RESTORE_LC_NUMERIC()                                              \
5705     if (_restore_LC_NUMERIC_function) {                                     \
5706         _restore_LC_NUMERIC_function(aTHX);                                 \
5707     }
5708
5709 /* The next two macros set unconditionally.  These should be rarely used, and
5710  * only after being sure that this is what is needed */
5711 #  define SET_NUMERIC_STANDARD()                                            \
5712         STMT_START { if (_NOT_IN_NUMERIC_STANDARD)                          \
5713                                           Perl_set_numeric_standard(aTHX);  \
5714                    } STMT_END
5715
5716 #  define SET_NUMERIC_UNDERLYING()                                          \
5717         STMT_START { if (_NOT_IN_NUMERIC_UNDERLYING)                        \
5718                             Perl_set_numeric_underlying(aTHX); } STMT_END
5719
5720 /* The rest of these LC_NUMERIC macros toggle to one or the other state, with
5721  * the RESTORE_foo ones called to switch back, but only if need be */
5722 #  define STORE_LC_NUMERIC_UNDERLYING_SET_STANDARD()                        \
5723         bool _was_underlying = _NOT_IN_NUMERIC_STANDARD;                         \
5724         if (_was_underlying) Perl_set_numeric_standard(aTHX);
5725
5726 /* Doesn't change to underlying locale unless within the scope of some form of
5727  * 'use locale'.  This is the usual desired behavior. */
5728 #  define STORE_LC_NUMERIC_STANDARD_SET_UNDERLYING()        \
5729         bool _was_standard = _NOT_IN_NUMERIC_UNDERLYING                     \
5730                             && IN_LC(LC_NUMERIC);                           \
5731         if (_was_standard) Perl_set_numeric_underlying(aTHX);
5732
5733 /* Rarely, we want to change to the underlying locale even outside of 'use
5734  * locale'.  This is principally in the POSIX:: functions */
5735 #  define STORE_LC_NUMERIC_FORCE_TO_UNDERLYING()            \
5736     if (_NOT_IN_NUMERIC_UNDERLYING) {                                       \
5737         Perl_set_numeric_underlying(aTHX);                                       \
5738         _restore_LC_NUMERIC_function = &Perl_set_numeric_standard;          \
5739     }
5740
5741 /* Lock/unlock to the C locale until unlock is called.  This needs to be
5742  * recursively callable.  [perl #128207] */
5743 #  define LOCK_LC_NUMERIC_STANDARD()                        \
5744         (__ASSERT_(PL_numeric_standard)                     \
5745         PL_numeric_standard++)
5746 #  define UNLOCK_LC_NUMERIC_STANDARD()                      \
5747             STMT_START {                                    \
5748                 if (PL_numeric_standard > 1) {              \
5749                     PL_numeric_standard--;                  \
5750                 }                                           \
5751                 else {                                      \
5752                     assert(0);                              \
5753                 }                                           \
5754             } STMT_END
5755
5756 #  define RESTORE_LC_NUMERIC_UNDERLYING()                       \
5757         if (_was_underlying) Perl_set_numeric_underlying(aTHX);
5758
5759 #  define RESTORE_LC_NUMERIC_STANDARD()                     \
5760     if (_restore_LC_NUMERIC_function) {                     \
5761         _restore_LC_NUMERIC_function(aTHX);                 \
5762     }
5763
5764 #else /* !USE_LOCALE_NUMERIC */
5765
5766 #  define SET_NUMERIC_STANDARD()
5767 #  define SET_NUMERIC_UNDERLYING()
5768 #  define IS_NUMERIC_RADIX(a, b)                (0)
5769 #  define STORE_LC_NUMERIC_UNDERLYING_SET_STANDARD()
5770 #  define STORE_LC_NUMERIC_STANDARD_SET_UNDERLYING()
5771 #  define STORE_LC_NUMERIC_FORCE_TO_UNDERLYING()
5772 #  define RESTORE_LC_NUMERIC_UNDERLYING()
5773 #  define RESTORE_LC_NUMERIC_STANDARD()
5774 #  define DECLARATION_FOR_LC_NUMERIC_MANIPULATION
5775 #  define STORE_LC_NUMERIC_SET_TO_NEEDED()
5776 #  define RESTORE_LC_NUMERIC()
5777 #  define LOCK_LC_NUMERIC_STANDARD()
5778 #  define UNLOCK_LC_NUMERIC_STANDARD()
5779
5780 #endif /* !USE_LOCALE_NUMERIC */
5781
5782 #define Atof                            my_atof
5783
5784 /* Back-compat names */
5785 #define DECLARATION_FOR_STORE_LC_NUMERIC_SET_TO_NEEDED              \
5786                         DECLARATION_FOR_LC_NUMERIC_MANIPULATION
5787 #define DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED()                    \
5788                 DECLARATION_FOR_STORE_LC_NUMERIC_SET_TO_NEEDED;     \
5789                 STORE_LC_NUMERIC_SET_TO_NEEDED();
5790 #define LOCK_NUMERIC_STANDARD() LOCK_LC_NUMERIC_STANDARD()
5791 #define RESTORE_NUMERIC_LOCAL() RESTORE_LC_NUMERIC_UNDERLYING()
5792 #define RESTORE_NUMERIC_STANDARD() RESTORE_LC_NUMERIC_STANDARD()
5793 #define SET_NUMERIC_LOCAL() SET_NUMERIC_UNDERLYING()
5794 #define STORE_NUMERIC_LOCAL_SET_STANDARD()                          \
5795                     STORE_LC_NUMERIC_UNDERLYING_SET_STANDARD()
5796 #define STORE_NUMERIC_STANDARD_SET_LOCAL()                          \
5797                     STORE_LC_NUMERIC_STANDARD_SET_UNDERLYING()
5798 #define STORE_NUMERIC_STANDARD_FORCE_LOCAL()                        \
5799                         STORE_LC_NUMERIC_FORCE_TO_UNDERLYING()
5800 #define UNLOCK_NUMERIC_STANDARD() UNLOCK_LC_NUMERIC_STANDARD()
5801
5802
5803
5804 #ifdef USE_QUADMATH
5805 #  define Perl_strtod(s, e) strtoflt128(s, e)
5806 #elif defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE)
5807 #  if defined(HAS_STRTOLD)
5808 #    define Perl_strtod(s, e) strtold(s, e)
5809 #  elif defined(HAS_STRTOD)
5810 #    define Perl_strtod(s, e) (NV)strtod(s, e) /* Unavoidable loss. */
5811 #  endif
5812 #elif defined(HAS_STRTOD)
5813 #  define Perl_strtod(s, e) strtod(s, e)
5814 #endif
5815
5816 #if !defined(Strtol) && defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && \
5817         (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
5818 #    ifdef __hpux
5819 #        define strtoll __strtoll       /* secret handshake */
5820 #    endif
5821 #    if defined(WIN64) && defined(_MSC_VER)
5822 #        define strtoll _strtoi64       /* secret handshake */
5823 #    endif
5824 #   if !defined(Strtol) && defined(HAS_STRTOLL)
5825 #       define Strtol   strtoll
5826 #   endif
5827 #    if !defined(Strtol) && defined(HAS_STRTOQ)
5828 #       define Strtol   strtoq
5829 #    endif
5830 /* is there atoq() anywhere? */
5831 #endif
5832 #if !defined(Strtol) && defined(HAS_STRTOL)
5833 #   define Strtol       strtol
5834 #endif
5835 #ifndef Atol
5836 /* It would be more fashionable to use Strtol() to define atol()
5837  * (as is done for Atoul(), see below) but for backward compatibility
5838  * we just assume atol(). */
5839 #   if defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && defined(HAS_ATOLL) && \
5840         (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
5841 #    ifdef WIN64
5842 #       define atoll    _atoi64         /* secret handshake */
5843 #    endif
5844 #       define Atol     atoll
5845 #   else
5846 #       define Atol     atol
5847 #   endif
5848 #endif
5849
5850 #if !defined(Strtoul) && defined(USE_64_BIT_INT) && defined(UV_IS_QUAD) && \
5851         (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
5852 #    ifdef __hpux
5853 #        define strtoull __strtoull     /* secret handshake */
5854 #    endif
5855 #    if defined(WIN64) && defined(_MSC_VER)
5856 #        define strtoull _strtoui64     /* secret handshake */
5857 #    endif
5858 #    if !defined(Strtoul) && defined(HAS_STRTOULL)
5859 #       define Strtoul  strtoull
5860 #    endif
5861 #    if !defined(Strtoul) && defined(HAS_STRTOUQ)
5862 #       define Strtoul  strtouq
5863 #    endif
5864 /* is there atouq() anywhere? */
5865 #endif
5866 #if !defined(Strtoul) && defined(HAS_STRTOUL)
5867 #   define Strtoul      strtoul
5868 #endif
5869 #if !defined(Strtoul) && defined(HAS_STRTOL) /* Last resort. */
5870 #   define Strtoul(s, e, b)     strchr((s), '-') ? ULONG_MAX : (unsigned long)strtol((s), (e), (b))
5871 #endif
5872 #ifndef Atoul
5873 #   define Atoul(s)     Strtoul(s, NULL, 10)
5874 #endif
5875
5876 #ifndef PERL_SCRIPT_MODE
5877 #define PERL_SCRIPT_MODE "r"
5878 #endif
5879
5880 /* not used. Kept as a NOOP for backcompat */
5881 #define PERL_STACK_OVERFLOW_CHECK()  NOOP
5882
5883 /*
5884  * Some nonpreemptive operating systems find it convenient to
5885  * check for asynchronous conditions after each op execution.
5886  * Keep this check simple, or it may slow down execution
5887  * massively.
5888  */
5889
5890 #ifndef PERL_MICRO
5891 #       ifndef PERL_ASYNC_CHECK
5892 #               define PERL_ASYNC_CHECK() if (UNLIKELY(PL_sig_pending)) PL_signalhook(aTHX)
5893 #       endif
5894 #endif
5895
5896 #ifndef PERL_ASYNC_CHECK
5897 #   define PERL_ASYNC_CHECK()  NOOP
5898 #endif
5899
5900 /*
5901  * On some operating systems, a memory allocation may succeed,
5902  * but put the process too close to the system's comfort limit.
5903  * In this case, PERL_ALLOC_CHECK frees the pointer and sets
5904  * it to NULL.
5905  */
5906 #ifndef PERL_ALLOC_CHECK
5907 #define PERL_ALLOC_CHECK(p)  NOOP
5908 #endif
5909
5910 #ifdef HAS_SEM
5911 #   include <sys/ipc.h>
5912 #   include <sys/sem.h>
5913 #   ifndef HAS_UNION_SEMUN      /* Provide the union semun. */
5914     union semun {
5915         int             val;
5916         struct semid_ds *buf;
5917         unsigned short  *array;
5918     };
5919 #   endif
5920 #   ifdef USE_SEMCTL_SEMUN
5921 #       ifdef IRIX32_SEMUN_BROKEN_BY_GCC
5922             union gccbug_semun {
5923                 int             val;
5924                 struct semid_ds *buf;
5925                 unsigned short  *array;
5926                 char            __dummy[5];
5927             };
5928 #           define semun gccbug_semun
5929 #       endif
5930 #       define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun)
5931 #   elif defined(USE_SEMCTL_SEMID_DS)
5932 #           ifdef EXTRA_F_IN_SEMUN_BUF
5933 #               define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buff)
5934 #           else
5935 #               define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buf)
5936 #           endif
5937 #   endif
5938 #endif
5939
5940 /*
5941  * Boilerplate macros for initializing and accessing interpreter-local
5942  * data from C.  All statics in extensions should be reworked to use
5943  * this, if you want to make the extension thread-safe.  See
5944  * ext/XS/APItest/APItest.xs for an example of the use of these macros,
5945  * and perlxs.pod for more.
5946  *
5947  * Code that uses these macros is responsible for the following:
5948  * 1. #define MY_CXT_KEY to a unique string, e.g.
5949  *    "DynaLoader::_guts" XS_VERSION
5950  *    XXX in the current implementation, this string is ignored.
5951  * 2. Declare a typedef named my_cxt_t that is a structure that contains
5952  *    all the data that needs to be interpreter-local.
5953  * 3. Use the START_MY_CXT macro after the declaration of my_cxt_t.
5954  * 4. Use the MY_CXT_INIT macro such that it is called exactly once
5955  *    (typically put in the BOOT: section).
5956  * 5. Use the members of the my_cxt_t structure everywhere as
5957  *    MY_CXT.member.
5958  * 6. Use the dMY_CXT macro (a declaration) in all the functions that
5959  *    access MY_CXT.
5960  */
5961
5962 #if defined(PERL_IMPLICIT_CONTEXT)
5963
5964 /* START_MY_CXT must appear in all extensions that define a my_cxt_t structure,
5965  * right after the definition (i.e. at file scope).  The non-threads
5966  * case below uses it to declare the data as static. */
5967 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
5968 #    define START_MY_CXT
5969 #    define MY_CXT_INDEX Perl_my_cxt_index(aTHX_ MY_CXT_KEY)
5970 #    define MY_CXT_INIT_ARG MY_CXT_KEY
5971 #  else
5972 #    define START_MY_CXT static int my_cxt_index = -1;
5973 #    define MY_CXT_INDEX my_cxt_index
5974 #    define MY_CXT_INIT_ARG &my_cxt_index
5975 #  endif /* #ifdef PERL_GLOBAL_STRUCT_PRIVATE */
5976
5977 /* Creates and zeroes the per-interpreter data.
5978  * (We allocate my_cxtp in a Perl SV so that it will be released when
5979  * the interpreter goes away.) */
5980 #  define MY_CXT_INIT \
5981         my_cxt_t *my_cxtp = \
5982             (my_cxt_t*)Perl_my_cxt_init(aTHX_ MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
5983         PERL_UNUSED_VAR(my_cxtp)
5984 #  define MY_CXT_INIT_INTERP(my_perl) \
5985         my_cxt_t *my_cxtp = \
5986             (my_cxt_t*)Perl_my_cxt_init(my_perl, MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
5987         PERL_UNUSED_VAR(my_cxtp)
5988
5989 /* This declaration should be used within all functions that use the
5990  * interpreter-local data. */
5991 #  define dMY_CXT       \
5992         my_cxt_t *my_cxtp = (my_cxt_t *)PL_my_cxt_list[MY_CXT_INDEX]
5993 #  define dMY_CXT_INTERP(my_perl)       \
5994         my_cxt_t *my_cxtp = (my_cxt_t *)(my_perl)->Imy_cxt_list[MY_CXT_INDEX]
5995
5996 /* Clones the per-interpreter data. */
5997 #  define MY_CXT_CLONE \
5998         my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1));\
5999         void * old_my_cxtp = PL_my_cxt_list[MY_CXT_INDEX];              \
6000         PL_my_cxt_list[MY_CXT_INDEX] = my_cxtp;                         \
6001         Copy(old_my_cxtp, my_cxtp, 1, my_cxt_t);
6002
6003
6004
6005 /* This macro must be used to access members of the my_cxt_t structure.
6006  * e.g. MY_CXT.some_data */
6007 #  define MY_CXT                (*my_cxtp)
6008
6009 /* Judicious use of these macros can reduce the number of times dMY_CXT
6010  * is used.  Use is similar to pTHX, aTHX etc. */
6011 #  define pMY_CXT       my_cxt_t *my_cxtp
6012 #  define pMY_CXT_      pMY_CXT,
6013 #  define _pMY_CXT      ,pMY_CXT
6014 #  define aMY_CXT       my_cxtp
6015 #  define aMY_CXT_      aMY_CXT,
6016 #  define _aMY_CXT      ,aMY_CXT
6017
6018 #else /* PERL_IMPLICIT_CONTEXT */
6019
6020 #  define START_MY_CXT          static my_cxt_t my_cxt;
6021 #  define dMY_CXT_SV            dNOOP
6022 #  define dMY_CXT               dNOOP
6023 #  define dMY_CXT_INTERP(my_perl) dNOOP
6024 #  define MY_CXT_INIT           NOOP
6025 #  define MY_CXT_CLONE          NOOP
6026 #  define MY_CXT                my_cxt
6027
6028 #  define pMY_CXT               void
6029 #  define pMY_CXT_
6030 #  define _pMY_CXT
6031 #  define aMY_CXT
6032 #  define aMY_CXT_
6033 #  define _aMY_CXT
6034
6035 #endif /* !defined(PERL_IMPLICIT_CONTEXT) */
6036
6037 #ifdef I_FCNTL
6038 #  include <fcntl.h>
6039 #endif
6040
6041 #ifdef __Lynx__
6042 #  include <fcntl.h>
6043 #endif
6044
6045 #ifdef __amigaos4__
6046 #  undef FD_CLOEXEC /* a lie in AmigaOS */
6047 #endif
6048
6049 #ifdef I_SYS_FILE
6050 #  include <sys/file.h>
6051 #endif
6052
6053 #if defined(HAS_FLOCK) && !defined(HAS_FLOCK_PROTO)
6054 int flock(int fd, int op);
6055 #endif
6056
6057 #ifndef O_RDONLY
6058 /* Assume UNIX defaults */
6059 #    define O_RDONLY    0000
6060 #    define O_WRONLY    0001
6061 #    define O_RDWR      0002
6062 #    define O_CREAT     0100
6063 #endif
6064
6065 #ifndef O_BINARY
6066 #  define O_BINARY 0
6067 #endif
6068
6069 #ifndef O_TEXT
6070 #  define O_TEXT 0
6071 #endif
6072
6073 #if O_TEXT != O_BINARY
6074     /* If you have different O_TEXT and O_BINARY and you are a CRLF shop,
6075      * that is, you are somehow DOSish. */
6076 #   if defined(__HAIKU__) || defined(__VOS__) || defined(__CYGWIN__)
6077     /* Haiku has O_TEXT != O_BINARY but O_TEXT and O_BINARY have no effect;
6078      * Haiku is always UNIXoid (LF), not DOSish (CRLF). */
6079     /* VOS has O_TEXT != O_BINARY, and they have effect,
6080      * but VOS always uses LF, never CRLF. */
6081     /* If you have O_TEXT different from your O_BINARY but you still are
6082      * not a CRLF shop. */
6083 #       undef PERLIO_USING_CRLF
6084 #   else
6085     /* If you really are DOSish. */
6086 #      define PERLIO_USING_CRLF 1
6087 #   endif
6088 #endif
6089
6090 #ifdef I_LIBUTIL
6091 #   include <libutil.h>         /* setproctitle() in some FreeBSDs */
6092 #endif
6093
6094 #ifndef EXEC_ARGV_CAST
6095 #define EXEC_ARGV_CAST(x) (char **)x
6096 #endif
6097
6098 #define IS_NUMBER_IN_UV               0x01 /* number within UV range (maybe not
6099                                               int).  value returned in pointed-
6100                                               to UV */
6101 #define IS_NUMBER_GREATER_THAN_UV_MAX 0x02 /* pointed to UV undefined */
6102 #define IS_NUMBER_NOT_INT             0x04 /* saw . or E notation or infnan */
6103 #define IS_NUMBER_NEG                 0x08 /* leading minus sign */
6104 #define IS_NUMBER_INFINITY            0x10 /* this is big */
6105 #define IS_NUMBER_NAN                 0x20 /* this is not */
6106 #define IS_NUMBER_TRAILING            0x40 /* number has trailing trash */
6107
6108 #define GROK_NUMERIC_RADIX(sp, send) grok_numeric_radix(sp, send)
6109
6110 /* Input flags: */
6111 #define PERL_SCAN_ALLOW_UNDERSCORES   0x01 /* grok_??? accept _ in numbers */
6112 #define PERL_SCAN_DISALLOW_PREFIX     0x02 /* grok_??? reject 0x in hex etc */
6113 #define PERL_SCAN_SILENT_ILLDIGIT     0x04 /* grok_??? not warn about illegal digits */
6114 #define PERL_SCAN_SILENT_NON_PORTABLE 0x08 /* grok_??? not warn about very large
6115                                               numbers which are <= UV_MAX */
6116 #define PERL_SCAN_TRAILING            0x10 /* grok_number_flags() allow trailing
6117                                               and set IS_NUMBER_TRAILING */
6118
6119 /* Output flags: */
6120 #define PERL_SCAN_GREATER_THAN_UV_MAX 0x02 /* should this merge with above? */
6121
6122 /* to let user control profiling */
6123 #ifdef PERL_GPROF_CONTROL
6124 extern void moncontrol(int);
6125 #define PERL_GPROF_MONCONTROL(x) moncontrol(x)
6126 #else
6127 #define PERL_GPROF_MONCONTROL(x)
6128 #endif
6129
6130 #ifdef UNDER_CE
6131 #include "wince.h"
6132 #endif
6133
6134 /* ISO 6429 NEL - C1 control NExt Line */
6135 /* See http://www.unicode.org/unicode/reports/tr13/ */
6136 #define NEXT_LINE_CHAR  NEXT_LINE_NATIVE
6137
6138 #ifndef PIPESOCK_MODE
6139 #  define PIPESOCK_MODE
6140 #endif
6141
6142 #ifndef SOCKET_OPEN_MODE
6143 #  define SOCKET_OPEN_MODE      PIPESOCK_MODE
6144 #endif
6145
6146 #ifndef PIPE_OPEN_MODE
6147 #  define PIPE_OPEN_MODE        PIPESOCK_MODE
6148 #endif
6149
6150 #define PERL_MAGIC_UTF8_CACHESIZE       2
6151
6152 #define PERL_UNICODE_STDIN_FLAG                 0x0001
6153 #define PERL_UNICODE_STDOUT_FLAG                0x0002
6154 #define PERL_UNICODE_STDERR_FLAG                0x0004
6155 #define PERL_UNICODE_IN_FLAG                    0x0008
6156 #define PERL_UNICODE_OUT_FLAG                   0x0010
6157 #define PERL_UNICODE_ARGV_FLAG                  0x0020
6158 #define PERL_UNICODE_LOCALE_FLAG                0x0040
6159 #define PERL_UNICODE_WIDESYSCALLS_FLAG          0x0080 /* for Sarathy */
6160 #define PERL_UNICODE_UTF8CACHEASSERT_FLAG       0x0100
6161
6162 #define PERL_UNICODE_STD_FLAG           \
6163         (PERL_UNICODE_STDIN_FLAG        | \
6164          PERL_UNICODE_STDOUT_FLAG       | \
6165          PERL_UNICODE_STDERR_FLAG)
6166
6167 #define PERL_UNICODE_INOUT_FLAG         \
6168         (PERL_UNICODE_IN_FLAG   | \
6169          PERL_UNICODE_OUT_FLAG)
6170
6171 #define PERL_UNICODE_DEFAULT_FLAGS      \
6172         (PERL_UNICODE_STD_FLAG          | \
6173          PERL_UNICODE_INOUT_FLAG        | \
6174          PERL_UNICODE_LOCALE_FLAG)
6175
6176 #define PERL_UNICODE_ALL_FLAGS                  0x01ff
6177
6178 #define PERL_UNICODE_STDIN                      'I'
6179 #define PERL_UNICODE_STDOUT                     'O'
6180 #define PERL_UNICODE_STDERR                     'E'
6181 #define PERL_UNICODE_STD                        'S'
6182 #define PERL_UNICODE_IN                         'i'
6183 #define PERL_UNICODE_OUT                        'o'
6184 #define PERL_UNICODE_INOUT                      'D'
6185 #define PERL_UNICODE_ARGV                       'A'
6186 #define PERL_UNICODE_LOCALE                     'L'
6187 #define PERL_UNICODE_WIDESYSCALLS               'W'
6188 #define PERL_UNICODE_UTF8CACHEASSERT            'a'
6189
6190 #define PERL_SIGNALS_UNSAFE_FLAG        0x0001
6191
6192 /* Use instead of abs() since abs() forces its argument to be an int,
6193  * but also beware since this evaluates its argument twice, so no x++. */
6194 #define PERL_ABS(x) ((x) < 0 ? -(x) : (x))
6195
6196 #if defined(__DECC) && defined(__osf__)
6197 #pragma message disable (mainparm) /* Perl uses the envp in main(). */
6198 #endif
6199
6200 #define do_open(g, n, l, a, rm, rp, sf) \
6201         do_openn(g, n, l, a, rm, rp, sf, (SV **) NULL, 0)
6202 #ifdef PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
6203 #  define do_exec(cmd)                  do_exec3(cmd,0,0)
6204 #endif
6205 #ifdef OS2
6206 #  define do_aexec                      Perl_do_aexec
6207 #else
6208 #  define do_aexec(really, mark,sp)     do_aexec5(really, mark, sp, 0, 0)
6209 #endif
6210
6211 /* check embedded \0 characters in pathnames passed to syscalls,
6212    but allow one ending \0 */
6213 #define IS_SAFE_SYSCALL(p, len, what, op_name) (S_is_safe_syscall(aTHX_ (p), (len), (what), (op_name)))
6214
6215 #define IS_SAFE_PATHNAME(p, len, op_name) IS_SAFE_SYSCALL((p), (len), "pathname", (op_name))
6216
6217 #if defined(OEMVS) || defined(__amigaos4__)
6218 #define NO_ENV_ARRAY_IN_MAIN
6219 #endif
6220
6221 /* These are used by Perl_pv_escape() and Perl_pv_pretty()
6222  * are here so that they are available throughout the core
6223  * NOTE that even though some are for _escape and some for _pretty
6224  * there must not be any clashes as the flags from _pretty are
6225  * passed straight through to _escape.
6226  */
6227
6228 #define PERL_PV_ESCAPE_QUOTE        0x000001
6229 #define PERL_PV_PRETTY_QUOTE        PERL_PV_ESCAPE_QUOTE
6230
6231 #define PERL_PV_PRETTY_ELLIPSES     0x000002
6232 #define PERL_PV_PRETTY_LTGT         0x000004
6233 #define PERL_PV_PRETTY_EXACTSIZE    0x000008
6234
6235 #define PERL_PV_ESCAPE_UNI          0x000100
6236 #define PERL_PV_ESCAPE_UNI_DETECT   0x000200
6237 #define PERL_PV_ESCAPE_NONASCII     0x000400
6238 #define PERL_PV_ESCAPE_FIRSTCHAR    0x000800
6239
6240 #define PERL_PV_ESCAPE_ALL            0x001000
6241 #define PERL_PV_ESCAPE_NOBACKSLASH  0x002000
6242 #define PERL_PV_ESCAPE_NOCLEAR      0x004000
6243 #define PERL_PV_PRETTY_NOCLEAR      PERL_PV_ESCAPE_NOCLEAR
6244 #define PERL_PV_ESCAPE_RE           0x008000
6245
6246 #define PERL_PV_ESCAPE_DWIM         0x010000
6247
6248
6249 /* used by pv_display in dump.c*/
6250 #define PERL_PV_PRETTY_DUMP  PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE
6251 #define PERL_PV_PRETTY_REGPROP PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_LTGT|PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII
6252
6253 #if DOUBLEKIND == DOUBLE_IS_VAX_F_FLOAT || \
6254     DOUBLEKIND == DOUBLE_IS_VAX_D_FLOAT || \
6255     DOUBLEKIND == DOUBLE_IS_VAX_G_FLOAT
6256 #  define DOUBLE_IS_VAX_FLOAT
6257 #else
6258 #  define DOUBLE_IS_IEEE_FORMAT
6259 #endif
6260
6261 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN || \
6262     DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN || \
6263     DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
6264 #  define DOUBLE_LITTLE_ENDIAN
6265 #endif
6266
6267 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN || \
6268     DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN || \
6269     DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
6270 #  define DOUBLE_BIG_ENDIAN
6271 #endif
6272
6273 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE || \
6274     DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
6275 #  define DOUBLE_MIX_ENDIAN
6276 #endif
6277
6278 /* The VAX fp formats are neither consistently little-endian nor
6279  * big-endian, and neither are they really IEEE-mixed endian like
6280  * the mixed-endian ARM IEEE formats (with swapped bytes).
6281  * Ultimately, the VAX format came from the PDP-11.
6282  *
6283  * The ordering of the parts in VAX floats is quite vexing.
6284  * In the below the fraction_n are the mantissa bits.
6285  *
6286  * The fraction_1 is the most significant (numbering as by DEC/Digital),
6287  * while the rightmost bit in each fraction is the least significant:
6288  * in other words, big-endian bit order within the fractions.
6289  *
6290  * The fraction segments themselves would be big-endianly, except that
6291  * within 32 bit segments the less significant half comes first, the more
6292  * significant after, except that in the format H (used for long doubles)
6293  * the first fraction segment is alone, because the exponent is wider.
6294  * This means for example that both the most and the least significant
6295  * bits can be in the middle of the floats, not at either end.
6296  *
6297  * References:
6298  * http://nssdc.gsfc.nasa.gov/nssdc/formats/VAXFloatingPoint.htm
6299  * http://www.quadibloc.com/comp/cp0201.htm
6300  * http://h71000.www7.hp.com/doc/82final/6443/6443pro_028.html
6301  * (somebody at HP should be fired for the URLs)
6302  *
6303  * F   fraction_2:16 sign:1 exp:8  fraction_1:7
6304  *     (exponent bias 128, hidden first one-bit)
6305  *
6306  * D   fraction_2:16 sign:1 exp:8  fraction_1:7
6307  *     fraction_4:16               fraction_3:16
6308  *     (exponent bias 128, hidden first one-bit)
6309  *
6310  * G   fraction_2:16 sign:1 exp:11 fraction_1:4
6311  *     fraction_4:16               fraction_3:16
6312  *     (exponent bias 1024, hidden first one-bit)
6313  *
6314  * H   fraction_1:16 sign:1 exp:15
6315  *     fraction_3:16               fraction_2:16
6316  *     fraction_5:16               fraction_4:16
6317  *     fraction_7:16               fraction_6:16
6318  *     (exponent bias 16384, hidden first one-bit)
6319  *     (available only on VAX, and only on Fortran?)
6320  *
6321  * The formats S, T and X are available on the Alpha (and Itanium,
6322  * also known as I64/IA64) and are equivalent with the IEEE-754 formats
6323  * binary32, binary64, and binary128 (commonly: float, double, long double).
6324  *
6325  * S   sign:1 exp:8 mantissa:23
6326  *     (exponent bias 127, hidden first one-bit)
6327  *
6328  * T   sign:1 exp:11 mantissa:52
6329  *     (exponent bias 1022, hidden first one-bit)
6330  *
6331  * X   sign:1 exp:15 mantissa:112
6332  *     (exponent bias 16382, hidden first one-bit)
6333  *
6334  */
6335
6336 #ifdef DOUBLE_IS_VAX_FLOAT
6337 #  define DOUBLE_VAX_ENDIAN
6338 #endif
6339
6340 #ifdef DOUBLE_IS_IEEE_FORMAT
6341 /* All the basic IEEE formats have the implicit bit,
6342  * except for the x86 80-bit extended formats, which will undef this.
6343  * Also note that the IEEE 754 subnormals (formerly known as denormals)
6344  * do not have the implicit bit of one. */
6345 #  define NV_IMPLICIT_BIT
6346 #endif
6347
6348 #if defined(LONG_DOUBLEKIND) && LONG_DOUBLEKIND != LONG_DOUBLE_IS_DOUBLE
6349
6350 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN || \
6351       LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
6352       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
6353 #    define LONGDOUBLE_LITTLE_ENDIAN
6354 #  endif
6355
6356 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN || \
6357       LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN || \
6358       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
6359 #    define LONGDOUBLE_BIG_ENDIAN
6360 #  endif
6361
6362 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
6363       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
6364 #    define LONGDOUBLE_MIX_ENDIAN
6365 #  endif
6366
6367 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
6368       LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
6369 #    define LONGDOUBLE_X86_80_BIT
6370 #    ifdef USE_LONG_DOUBLE
6371 #      undef NV_IMPLICIT_BIT
6372 #      define NV_X86_80_BIT
6373 #    endif
6374 #  endif
6375
6376 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE || \
6377       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE || \
6378       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
6379       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
6380 #    define LONGDOUBLE_DOUBLEDOUBLE
6381 #  endif
6382
6383 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_VAX_H_FLOAT
6384 #    define LONGDOUBLE_VAX_ENDIAN
6385 #  endif
6386
6387 #endif /* LONG_DOUBLEKIND */
6388
6389 #ifdef USE_QUADMATH /* assume quadmath endianness == native double endianness */
6390 #  if defined(DOUBLE_LITTLE_ENDIAN)
6391 #    define NV_LITTLE_ENDIAN
6392 #  elif defined(DOUBLE_BIG_ENDIAN)
6393 #    define NV_BIG_ENDIAN
6394 #  elif defined(DOUBLE_MIX_ENDIAN) /* stretch */
6395 #    define NV_MIX_ENDIAN
6396 #  endif
6397 #elif NVSIZE == DOUBLESIZE
6398 #  ifdef DOUBLE_LITTLE_ENDIAN
6399 #    define NV_LITTLE_ENDIAN
6400 #  endif
6401 #  ifdef DOUBLE_BIG_ENDIAN
6402 #    define NV_BIG_ENDIAN
6403 #  endif
6404 #  ifdef DOUBLE_MIX_ENDIAN
6405 #    define NV_MIX_ENDIAN
6406 #  endif
6407 #  ifdef DOUBLE_VAX_ENDIAN
6408 #    define NV_VAX_ENDIAN
6409 #  endif
6410 #elif NVSIZE == LONG_DOUBLESIZE
6411 #  ifdef LONGDOUBLE_LITTLE_ENDIAN
6412 #    define NV_LITTLE_ENDIAN
6413 #  endif
6414 #  ifdef LONGDOUBLE_BIG_ENDIAN
6415 #    define NV_BIG_ENDIAN
6416 #  endif
6417 #  ifdef LONGDOUBLE_MIX_ENDIAN
6418 #    define NV_MIX_ENDIAN
6419 #  endif
6420 #  ifdef LONGDOUBLE_VAX_ENDIAN
6421 #    define NV_VAX_ENDIAN
6422 #  endif
6423 #endif
6424
6425 /* We have somehow managed not to define the denormal/subnormal
6426  * detection.
6427  *
6428  * This may happen if the compiler doesn't expose the C99 math like
6429  * the fpclassify() without some special switches.  Perl tries to
6430  * stay C89, so for example -std=c99 is not an option.
6431  *
6432  * The Perl_isinf() and Perl_isnan() should have been defined even if
6433  * the C99 isinf() and isnan() are unavailable, and the NV_MIN becomes
6434  * from the C89 DBL_MIN or moral equivalent. */
6435 #if !defined(Perl_fp_class_denorm) && defined(Perl_isinf) && defined(Perl_isnan) && defined(NV_MIN)
6436 #  define Perl_fp_class_denorm(x) ((x) != 0.0 && !Perl_isinf(x) && !Perl_isnan(x) && PERL_ABS(x) < NV_MIN)
6437 #endif
6438
6439 /* This is not a great fallback: subnormals tests will fail,
6440  * but at least Perl will link and 99.999% of tests will work. */
6441 #if !defined(Perl_fp_class_denorm)
6442 #  define Perl_fp_class_denorm(x) FALSE
6443 #endif
6444
6445 #ifdef DOUBLE_IS_IEEE_FORMAT
6446 #  define DOUBLE_HAS_INF
6447 #  define DOUBLE_HAS_NAN
6448 #endif
6449
6450 #ifdef DOUBLE_HAS_NAN
6451
6452 #ifdef DOINIT
6453
6454 /* PL_inf and PL_nan initialization.
6455  *
6456  * For inf and nan initialization the ultimate fallback is dividing
6457  * one or zero by zero: however, some compilers will warn or even fail
6458  * on divide-by-zero, but hopefully something earlier will work.
6459  *
6460  * If you are thinking of using HUGE_VAL for infinity, or using
6461  * <math.h> functions to generate NV_INF (e.g. exp(1e9), log(-1.0)),
6462  * stop.  Neither will work portably: HUGE_VAL can be just DBL_MAX,
6463  * and the math functions might be just generating DBL_MAX, or even zero.
6464  *
6465  * Also, do NOT try doing NV_NAN based on NV_INF and trying (NV_INF-NV_INF).
6466  * Though logically correct, some compilers (like Visual C 2003)
6467  * falsely misoptimize that to zero (x-x is always zero, right?)
6468  *
6469  * Finally, note that not all floating point formats define Inf (or NaN).
6470  * For the infinity a large number may be used instead.  Operations that
6471  * under the IEEE floating point would return Inf or NaN may return
6472  * either large numbers (positive or negative), or they may cause
6473  * a floating point exception or some other fault.
6474  */
6475
6476 /* The quadmath literals are anon structs which -Wc++-compat doesn't like. */
6477 GCC_DIAG_IGNORE(-Wc++-compat)
6478
6479 #  ifdef USE_QUADMATH
6480 /* Cannot use HUGE_VALQ for PL_inf because not a compile-time
6481  * constant. */
6482 INFNAN_NV_U8_DECL PL_inf = { 1.0Q/0.0Q };
6483 #  elif NVSIZE == LONG_DOUBLESIZE && defined(LONGDBLINFBYTES)
6484 INFNAN_U8_NV_DECL PL_inf = { { LONGDBLINFBYTES } };
6485 #  elif NVSIZE == DOUBLESIZE && defined(DOUBLEINFBYTES)
6486 INFNAN_U8_NV_DECL PL_inf = { { DOUBLEINFBYTES } };
6487 #  else
6488 #    if NVSIZE == LONG_DOUBLESIZE && defined(USE_LONG_DOUBLE)
6489 #      if defined(LDBL_INFINITY)
6490 INFNAN_NV_U8_DECL PL_inf = { LDBL_INFINITY };
6491 #      elif defined(LDBL_INF)
6492 INFNAN_NV_U8_DECL PL_inf = { LDBL_INF };
6493 #      elif defined(INFINITY)
6494 INFNAN_NV_U8_DECL PL_inf = { (NV)INFINITY };
6495 #      elif defined(INF)
6496 INFNAN_NV_U8_DECL PL_inf = { (NV)INF };
6497 #      else
6498 INFNAN_NV_U8_DECL PL_inf = { 1.0L/0.0L }; /* keep last */
6499 #      endif
6500 #    else
6501 #      if defined(DBL_INFINITY)
6502 INFNAN_NV_U8_DECL PL_inf = { DBL_INFINITY };
6503 #      elif defined(DBL_INF)
6504 INFNAN_NV_U8_DECL PL_inf = { DBL_INF };
6505 #      elif defined(INFINITY) /* C99 */
6506 INFNAN_NV_U8_DECL PL_inf = { (NV)INFINITY };
6507 #      elif defined(INF)
6508 INFNAN_NV_U8_DECL PL_inf = { (NV)INF };
6509 #      else
6510 INFNAN_NV_U8_DECL PL_inf = { 1.0/0.0 }; /* keep last */
6511 #      endif
6512 #    endif
6513 #  endif
6514
6515 #  ifdef USE_QUADMATH
6516 /* Cannot use nanq("0") for PL_nan because not a compile-time
6517  * constant. */
6518 INFNAN_NV_U8_DECL PL_nan = { 0.0Q/0.0Q };
6519 #  elif NVSIZE == LONG_DOUBLESIZE && defined(LONGDBLNANBYTES)
6520 INFNAN_U8_NV_DECL PL_nan = { { LONGDBLNANBYTES } };
6521 #  elif NVSIZE == DOUBLESIZE && defined(DOUBLENANBYTES)
6522 INFNAN_U8_NV_DECL PL_nan = { { DOUBLENANBYTES } };
6523 #  else
6524 #    if NVSIZE == LONG_DOUBLESIZE && defined(USE_LONG_DOUBLE)
6525 #      if defined(LDBL_NAN)
6526 INFNAN_NV_U8_DECL PL_nan = { LDBL_NAN };
6527 #      elif defined(LDBL_QNAN)
6528 INFNAN_NV_U8_DECL PL_nan = { LDBL_QNAN };
6529 #      elif defined(NAN)
6530 INFNAN_NV_U8_DECL PL_nan = { (NV)NAN };
6531 #      else
6532 INFNAN_NV_U8_DECL PL_nan = { 0.0L/0.0L }; /* keep last */
6533 #      endif
6534 #    else
6535 #      if defined(DBL_NAN)
6536 INFNAN_NV_U8_DECL PL_nan = { DBL_NAN };
6537 #      elif defined(DBL_QNAN)
6538 INFNAN_NV_U8_DECL PL_nan = { DBL_QNAN };
6539 #      elif defined(NAN) /* C99 */
6540 INFNAN_NV_U8_DECL PL_nan = { (NV)NAN };
6541 #      else
6542 INFNAN_NV_U8_DECL PL_nan = { 0.0/0.0 }; /* keep last */
6543 #      endif
6544 #    endif
6545 #  endif
6546
6547 GCC_DIAG_RESTORE
6548
6549 #else
6550
6551 INFNAN_NV_U8_DECL PL_inf;
6552 INFNAN_NV_U8_DECL PL_nan;
6553
6554 #endif
6555
6556 /* If you have not defined NV_INF/NV_NAN (like for example win32/win32.h),
6557  * we will define NV_INF/NV_NAN as the nv part of the global const
6558  * PL_inf/PL_nan.  Note, however, that the preexisting NV_INF/NV_NAN
6559  * might not be a compile-time constant, in which case it cannot be
6560  * used to initialize PL_inf/PL_nan above. */
6561 #ifndef NV_INF
6562 #  define NV_INF PL_inf.nv
6563 #endif
6564 #ifndef NV_NAN
6565 #  define NV_NAN PL_nan.nv
6566 #endif
6567
6568 /* NaNs (not-a-numbers) can carry payload bits, in addition to
6569  * "nan-ness".  Part of the payload is the quiet/signaling bit.
6570  * To back up a bit (harhar):
6571  *
6572  * For IEEE 754 64-bit formats [1]:
6573  *
6574  * s 000 (mantissa all-zero)  zero
6575  * s 000 (mantissa non-zero)  subnormals (denormals)
6576  * s 001 ... 7fe              normals
6577  * s 7ff q                    nan
6578  *
6579  * For IEEE 754 128-bit formats:
6580  *
6581  * s 0000 (mantissa all-zero)  zero
6582  * s 0000 (mantissa non-zero)  subnormals (denormals)
6583  * s 0001 ... 7ffe             normals
6584  * s 7fff q                    nan
6585  *
6586  * [1] this looks like big-endian, but applies equally to little-endian.
6587  *
6588  * s = Sign bit.  Yes, zeros and nans can have negative sign,
6589  *     the interpretation is application-specific.
6590  *
6591  * q = Quietness bit, the interpretation is platform-specific.
6592  *     Most platforms have the most significant bit being one
6593  *     meaning quiet, but some (older mips, hppa) have the msb
6594  *     being one meaning signaling.  Note that the above means
6595  *     that on most platforms there cannot be signaling nan with
6596  *     zero payload because that is identical with infinity;
6597  *     while conversely on older mips/hppa there cannot be a quiet nan
6598  *     because that is identical with infinity.
6599  *
6600  *     Moreover, whether there is any behavioral difference
6601  *     between quiet and signaling NaNs, depends on the platform.
6602  *
6603  * x86 80-bit extended precision is different, the mantissa bits:
6604  *
6605  * 63 62 61   30387+    pre-387    visual c
6606  * --------   ----      --------   --------
6607  *  0  0  0   invalid   infinity
6608  *  0  0  1   invalid   snan
6609  *  0  1  0   invalid   snan
6610  *  0  1  1   invalid   snan
6611  *  1  0  0   infinity  snan        1.#INF
6612  *  1  0  1   snan                  1.#SNAN
6613  *  1  1  0   qnan                 -1.#IND  (x86 chooses this to negative)
6614  *  1  1  1   qnan                  1.#QNAN
6615  *
6616  * This means that in this format there are 61 bits available
6617  * for the nan payload.
6618  *
6619  * Note that the 32-bit x86 ABI cannot do signaling nans: the x87
6620  * simply cannot preserve the bit.  You can either use the 80-bit
6621  * extended precision (long double, -Duselongdouble), or use x86-64.
6622  *
6623  * In all platforms, the payload bytes (and bits, some of them are
6624  * often in a partial byte) themselves can be either all zero (x86),
6625  * all one (sparc or mips), or a mixture: in IEEE 754 128-bit double
6626  * or in a double-double, the first half of the payload can follow the
6627  * native double, while in the second half the payload can be all
6628  * zeros.  (Therefore the mask for payload bits is not necessarily
6629  * identical to bit complement of the NaN.)  Another way of putting
6630  * this: the payload for the default NaN might not be zero.
6631  *
6632  * For the x86 80-bit long doubles, the trailing bytes (the 80 bits
6633  * being 'packaged' in either 12 or 16 bytes) can be whatever random
6634  * garbage.
6635  *
6636  * Furthermore, the semantics of the sign bit on NaNs are platform-specific.
6637  * On normal floats, the sign bit being on means negative.  But this may,
6638  * or may not, be reverted on NaNs: in other words, the default NaN might
6639  * have the sign bit on, and therefore look like negative if you look
6640  * at it at the bit level.
6641  *
6642  * NaN payloads are not propagated even on copies, or in arithmetics.
6643  * They *might* be, according to some rules, on your particular
6644  * cpu/os/compiler/libraries, but no guarantees.
6645  *
6646  * To summarize, on most platforms, and for 64-bit doubles
6647  * (using big-endian ordering here):
6648  *
6649  * [7FF8000000000000..7FFFFFFFFFFFFFFF] quiet
6650  * [FFF8000000000000..FFFFFFFFFFFFFFFF] quiet
6651  * [7FF0000000000001..7FF7FFFFFFFFFFFF] signaling
6652  * [FFF0000000000001..FFF7FFFFFFFFFFFF] signaling
6653  *
6654  * The C99 nan() is supposed to generate *quiet* NaNs.
6655  *
6656  * Note the asymmetry:
6657  * The 7FF0000000000000 is positive infinity,
6658  * the FFF0000000000000 is negative infinity.
6659  */
6660
6661 /* NVMANTBITS is the number of _real_ mantissa bits in an NV.
6662  * For the standard IEEE 754 fp this number is usually one less that
6663  * *DBL_MANT_DIG because of the implicit (aka hidden) bit, which isn't
6664  * real.  For the 80-bit extended precision formats (x86*), the number
6665  * of mantissa bits... depends. For normal floats, it's 64.  But for
6666  * the inf/nan, it's different (zero for inf, 61 for nan).
6667  * NVMANTBITS works for normal floats. */
6668
6669 /* We do not want to include the quiet/signaling bit. */
6670 #define NV_NAN_BITS (NVMANTBITS - 1)
6671
6672 #if defined(USE_LONG_DOUBLE) && NVSIZE > DOUBLESIZE
6673 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
6674 #    define NV_NAN_QS_BYTE_OFFSET 13
6675 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
6676 #    define NV_NAN_QS_BYTE_OFFSET 2
6677 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN
6678 #    define NV_NAN_QS_BYTE_OFFSET 7
6679 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
6680 #    define NV_NAN_QS_BYTE_OFFSET 2
6681 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
6682 #    define NV_NAN_QS_BYTE_OFFSET 13
6683 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
6684 #    define NV_NAN_QS_BYTE_OFFSET 1
6685 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE
6686 #    define NV_NAN_QS_BYTE_OFFSET 9
6687 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
6688 #    define NV_NAN_QS_BYTE_OFFSET 6
6689 #  else
6690 #    error "Unexpected long double format"
6691 #  endif
6692 #else
6693 #  ifdef USE_QUADMATH
6694 #    ifdef NV_LITTLE_ENDIAN
6695 #      define NV_NAN_QS_BYTE_OFFSET 13
6696 #    elif defined(NV_BIG_ENDIAN)
6697 #      define NV_NAN_QS_BYTE_OFFSET 2
6698 #    else
6699 #      error "Unexpected quadmath format"
6700 #    endif
6701 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN
6702 #    define NV_NAN_QS_BYTE_OFFSET 2
6703 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN
6704 #    define NV_NAN_QS_BYTE_OFFSET 1
6705 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN
6706 #    define NV_NAN_QS_BYTE_OFFSET 6
6707 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN
6708 #    define NV_NAN_QS_BYTE_OFFSET 1
6709 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
6710 #    define NV_NAN_QS_BYTE_OFFSET 13
6711 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
6712 #    define NV_NAN_QS_BYTE_OFFSET 2
6713 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE
6714 #    define NV_NAN_QS_BYTE_OFFSET 2 /* bytes 4 5 6 7 0 1 2 3 (MSB 7) */
6715 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
6716 #    define NV_NAN_QS_BYTE_OFFSET 5 /* bytes 3 2 1 0 7 6 5 4 (MSB 7) */
6717 #  else
6718 /* For example the VAX formats should never
6719  * get here because they do not have NaN. */
6720 #    error "Unexpected double format"
6721 #  endif
6722 #endif
6723 /* NV_NAN_QS_BYTE is the byte to test for the quiet/signaling */
6724 #define NV_NAN_QS_BYTE(nvp) (((U8*)(nvp))[NV_NAN_QS_BYTE_OFFSET])
6725 /* NV_NAN_QS_BIT is the bit to test in the NV_NAN_QS_BYTE_OFFSET
6726  * for the quiet/signaling */
6727 #if defined(USE_LONG_DOUBLE) && \
6728   (LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
6729    LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN)
6730 #  define NV_NAN_QS_BIT_SHIFT 6 /* 0x40 */
6731 #elif defined(USE_LONG_DOUBLE) && \
6732   (LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE || \
6733    LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE || \
6734    LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
6735    LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE)
6736 #  define NV_NAN_QS_BIT_SHIFT 3 /* 0x08, but not via NV_NAN_BITS */
6737 #else
6738 #  define NV_NAN_QS_BIT_SHIFT ((NV_NAN_BITS) % 8) /* usually 3, or 0x08 */
6739 #endif
6740 #define NV_NAN_QS_BIT (1 << (NV_NAN_QS_BIT_SHIFT))
6741 /* NV_NAN_QS_BIT_OFFSET is the bit offset from the beginning of a NV
6742  * (bytes ordered big-endianly) for the quiet/signaling bit
6743  * for the quiet/signaling */
6744 #define NV_NAN_QS_BIT_OFFSET \
6745     (8 * (NV_NAN_QS_BYTE_OFFSET) + (NV_NAN_QS_BIT_SHIFT))
6746 /* NV_NAN_QS_QUIET (always defined) is true if the NV_NAN_QS_QS_BIT being
6747  * on indicates quiet NaN.  NV_NAN_QS_SIGNALING (also always defined)
6748  * is true if the NV_NAN_QS_BIT being on indicates signaling NaN. */
6749 #define NV_NAN_QS_QUIET \
6750     ((NV_NAN_QS_BYTE(PL_nan.u8) & NV_NAN_QS_BIT) == NV_NAN_QS_BIT)
6751 #define NV_NAN_QS_SIGNALING (!(NV_NAN_QS_QUIET))
6752 #define NV_NAN_QS_TEST(nvp) (NV_NAN_QS_BYTE(nvp) & NV_NAN_QS_BIT)
6753 /* NV_NAN_IS_QUIET() returns true if the NV behind nvp is a NaN,
6754  * whether it is a quiet NaN, NV_NAN_IS_SIGNALING() if a signaling NaN.
6755  * Note however that these do not check whether the nvp is a NaN. */
6756 #define NV_NAN_IS_QUIET(nvp) \
6757     (NV_NAN_QS_TEST(nvp) == (NV_NAN_QS_QUIET ? NV_NAN_QS_BIT : 0))
6758 #define NV_NAN_IS_SIGNALING(nvp) \
6759     (NV_NAN_QS_TEST(nvp) == (NV_NAN_QS_QUIET ? 0 : NV_NAN_QS_BIT))
6760 #define NV_NAN_SET_QUIET(nvp) \
6761     (NV_NAN_QS_QUIET ? \
6762      (NV_NAN_QS_BYTE(nvp) |= NV_NAN_QS_BIT) : \
6763      (NV_NAN_QS_BYTE(nvp) &= ~NV_NAN_QS_BIT))
6764 #define NV_NAN_SET_SIGNALING(nvp) \
6765     (NV_NAN_QS_QUIET ? \
6766      (NV_NAN_QS_BYTE(nvp) &= ~NV_NAN_QS_BIT) : \
6767      (NV_NAN_QS_BYTE(nvp) |= NV_NAN_QS_BIT))
6768 #define NV_NAN_QS_XOR(nvp) (NV_NAN_QS_BYTE(nvp) ^= NV_NAN_QS_BIT)
6769
6770 /* NV_NAN_PAYLOAD_MASK: masking the nan payload bits.
6771  *
6772  * NV_NAN_PAYLOAD_PERM: permuting the nan payload bytes.
6773  * 0xFF means "don't go here".*/
6774
6775 /* Shorthands to avoid typoses. */
6776 #define NV_NAN_PAYLOAD_MASK_SKIP_EIGHT \
6777   0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0
6778 #define NV_NAN_PAYLOAD_PERM_SKIP_EIGHT \
6779   0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
6780 #define NV_NAN_PAYLOAD_PERM_0_TO_7 \
6781   0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7
6782 #define NV_NAN_PAYLOAD_PERM_7_TO_0 \
6783   0x7, 0x6, 0x5, 0x4, 0x3, 0x2, 0x1, 0x0
6784 #define NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE \
6785   0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
6786   0xff, 0xff, 0xff, 0xff, 0xff, 0x7f, 0x00, 0x00
6787 #define NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE \
6788   NV_NAN_PAYLOAD_PERM_0_TO_7, \
6789   0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xFF, 0xFF
6790 #define NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE \
6791   0x00, 0x00, 0x7f, 0xff, 0xff, 0xff, 0xff, 0xff, \
6792   0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
6793 #define NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE \
6794   0xFF, 0xFF, 0xd, 0xc, 0xb, 0xa, 0x9, 0x8, \
6795   NV_NAN_PAYLOAD_PERM_7_TO_0
6796 #define NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE \
6797   0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x07, 0x00
6798 #define NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE \
6799   0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0xFF
6800 #define NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE \
6801   0x00, 0x07, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
6802 #define NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE \
6803   0xFF, 0x6, 0x5, 0x4, 0x3, 0x2, 0x1, 0x0
6804
6805 #if defined(USE_LONG_DOUBLE) && NVSIZE > DOUBLESIZE
6806 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
6807 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
6808 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
6809 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
6810 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
6811 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
6812 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN
6813 #    if LONG_DOUBLESIZE == 10
6814 #      define NV_NAN_PAYLOAD_MASK \
6815          0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
6816          0x00, 0x00
6817 #      define NV_NAN_PAYLOAD_PERM \
6818          NV_NAN_PAYLOAD_PERM_0_TO_7, 0xFF, 0xFF
6819 #    elif LONG_DOUBLESIZE == 12
6820 #      define NV_NAN_PAYLOAD_MASK \
6821          0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
6822          0x00, 0x00, 0x00, 0x00
6823 #      define NV_NAN_PAYLOAD_PERM \
6824          NV_NAN_PAYLOAD_PERM_0_TO_7, 0xFF, 0xFF, 0xFF, 0xFF
6825 #    elif LONG_DOUBLESIZE == 16
6826 #      define NV_NAN_PAYLOAD_MASK \
6827          0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
6828          0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
6829 #      define NV_NAN_PAYLOAD_PERM \
6830          NV_NAN_PAYLOAD_PERM_0_TO_7, \
6831          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
6832 #    else
6833 #      error "Unexpected x86 80-bit little-endian long double format"
6834 #    endif
6835 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
6836 #    if LONG_DOUBLESIZE == 10
6837 #      define NV_NAN_PAYLOAD_MASK \
6838          0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
6839          0xff, 0xff
6840 #      define NV_NAN_PAYLOAD_PERM \
6841          NV_NAN_PAYLOAD_PERM_7_TO_0, 0xFF, 0xFF
6842 #    elif LONG_DOUBLESIZE == 12
6843 #      define NV_NAN_PAYLOAD_MASK \
6844          0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
6845          0xff, 0xff, 0x00, 0x00
6846 #      define NV_NAN_PAYLOAD_PERM \
6847          NV_NAN_PAYLOAD_PERM_7_TO_0, 0xFF, 0xFF, 0xFF, 0xFF
6848 #    elif LONG_DOUBLESIZE == 16
6849 #      define NV_NAN_PAYLOAD_MASK \
6850          0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
6851          0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
6852 #      define NV_NAN_PAYLOAD_PERM \
6853          NV_NAN_PAYLOAD_PERM_7_TO_0, \
6854          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
6855 #    else
6856 #      error "Unexpected x86 80-bit big-endian long double format"
6857 #    endif
6858 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
6859 /* For double-double we assume only the first double (in LE or BE terms)
6860  * is used for NaN. */
6861 #    define NV_NAN_PAYLOAD_MASK \
6862        NV_NAN_PAYLOAD_MASK_SKIP_EIGHT, NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
6863 #    define NV_NAN_PAYLOAD_PERM \
6864        NV_NAN_PAYLOAD_PERM_SKIP_EIGHT, NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
6865 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
6866 #    define NV_NAN_PAYLOAD_MASK \
6867        NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
6868 #    define NV_NAN_PAYLOAD_PERM \
6869        NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
6870 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE
6871 #    define NV_NAN_PAYLOAD_MASK \
6872        NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
6873 #    define NV_NAN_PAYLOAD_PERM \
6874        NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
6875 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
6876 #    define NV_NAN_PAYLOAD_MASK \
6877        NV_NAN_PAYLOAD_MASK_SKIP_EIGHT, NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
6878 #    define NV_NAN_PAYLOAD_PERM \
6879        NV_NAN_PAYLOAD_PERM_SKIP_EIGHT, NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
6880 #  else
6881 #    error "Unexpected long double format"
6882 #  endif
6883 #else
6884 #  ifdef USE_QUADMATH /* quadmath is not long double */
6885 #    ifdef NV_LITTLE_ENDIAN
6886 #      define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
6887 #      define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
6888 #    elif defined(NV_BIG_ENDIAN)
6889 #      define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
6890 #      define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
6891 #    else
6892 #      error "Unexpected quadmath format"
6893 #    endif
6894 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN
6895 #    define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0x07, 0x00
6896 #    define NV_NAN_PAYLOAD_PERM 0x0, 0x1, 0x2, 0xFF
6897 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN
6898 #    define NV_NAN_PAYLOAD_MASK 0x00, 0x07, 0xff, 0xff
6899 #    define NV_NAN_PAYLOAD_PERM 0xFF, 0x2, 0x1, 0x0
6900 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN
6901 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
6902 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
6903 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN
6904 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
6905 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
6906 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
6907 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
6908 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
6909 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
6910 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
6911 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
6912 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE
6913 #    define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0x07, 0x00, 0xff, 0xff, 0xff, 0xff
6914 #    define NV_NAN_PAYLOAD_PERM 0x4, 0x5, 0x6, 0xFF, 0x0, 0x1, 0x2, 0x3
6915 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
6916 #    define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0xff, 0xff, 0x00, 0x07, 0xff, 0xff
6917 #    define NV_NAN_PAYLOAD_PERM 0x3, 0x2, 0x1, 0x0, 0xFF, 0x6, 0x5, 0x4
6918 #  else
6919 #    error "Unexpected double format"
6920 #  endif
6921 #endif
6922
6923 #endif /* DOUBLE_HAS_NAN */
6924
6925
6926 /*
6927
6928    (KEEP THIS LAST IN perl.h!)
6929
6930    Mention
6931
6932    NV_PRESERVES_UV
6933
6934    HAS_MKSTEMP
6935    HAS_MKSTEMPS
6936    HAS_MKDTEMP
6937
6938    HAS_GETCWD
6939
6940    HAS_MMAP
6941    HAS_MPROTECT
6942    HAS_MSYNC
6943    HAS_MADVISE
6944    HAS_MUNMAP
6945    I_SYSMMAN
6946    Mmap_t
6947
6948    NVef
6949    NVff
6950    NVgf
6951
6952    HAS_UALARM
6953    HAS_USLEEP
6954
6955    HAS_SETITIMER
6956    HAS_GETITIMER
6957
6958    HAS_SENDMSG
6959    HAS_RECVMSG
6960    HAS_READV
6961    HAS_WRITEV
6962    I_SYSUIO
6963    HAS_STRUCT_MSGHDR
6964    HAS_STRUCT_CMSGHDR
6965
6966    HAS_NL_LANGINFO
6967
6968    HAS_DIRFD
6969
6970    so that Configure picks them up.
6971
6972    (KEEP THIS LAST IN perl.h!)
6973
6974 */
6975
6976 #endif /* Include guard */
6977
6978 /*
6979  * ex: set ts=8 sts=4 sw=4 et:
6980  */