perl.h

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