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