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