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 #  define PERL_UNUSED_ARG(x) ((void)sizeof(x))
 336 #endif
 337 #ifndef PERL_UNUSED_VAR
 338 #  define PERL_UNUSED_VAR(x) ((void)sizeof(x))
 339 #endif
 340
 341 #if defined(USE_ITHREADS) || defined(PERL_GLOBAL_STRUCT)
 342 #  define PERL_UNUSED_CONTEXT PERL_UNUSED_ARG(my_perl)
 343 #else
 344 #  define PERL_UNUSED_CONTEXT
 345 #endif
 346
 347 /* gcc (-ansi) -pedantic doesn't allow gcc statement expressions,
 348  * g++ allows them but seems to have problems with them
 349  * (insane errors ensue).
 350  * g++ does not give insane errors now (RMB 2008-01-30, gcc 4.2.2).
 351  */
 352 #if defined(PERL_GCC_PEDANTIC) || \
 353     (defined(__GNUC__) && defined(__cplusplus) && \
 354         ((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2))))
 355 #  ifndef PERL_GCC_BRACE_GROUPS_FORBIDDEN
 356 #    define PERL_GCC_BRACE_GROUPS_FORBIDDEN
 357 #  endif
 358 #endif
 359
 360 /* Use PERL_UNUSED_RESULT() to suppress the warnings about unused results
 361  * of function calls, e.g. PERL_UNUSED_RESULT(foo(a, b)).
 362  *
 363  * The main reason for this is that the combination of gcc -Wunused-result
 364  * (part of -Wall) and the __attribute__((warn_unused_result)) cannot
 365  * be silenced with casting to void.  This causes trouble when the system
 366  * header files use the attribute.
 367  *
 368  * Use PERL_UNUSED_RESULT sparingly, though, since usually the warning
 369  * is there for a good reason: you might lose success/failure information,
 370  * or leak resources, or changes in resources.
 371  *
 372  * But sometimes you just want to ignore the return value, e.g. on
 373  * codepaths soon ending up in abort, or in "best effort" attempts,
 374  * or in situations where there is no good way to handle failures.
 375  *
 376  * Sometimes PERL_UNUSED_RESULT might not be the most natural way:
 377  * another possibility is that you can capture the return value
 378  * and use PERL_UNUSED_VAR on that.
 379  *
 380  * The __typeof__() is used instead of typeof() since typeof() is not
 381  * available under strict C89, and because of compilers masquerading
 382  * as gcc (clang and icc), we want exactly the gcc extension
 383  * __typeof__ and nothing else.
 384  */
 385 #ifndef PERL_UNUSED_RESULT
 386 #  if defined(__GNUC__) && defined(HASATTRIBUTE_WARN_UNUSED_RESULT)
 387 #    define PERL_UNUSED_RESULT(v) STMT_START { __typeof__(v) z = (v); (void)sizeof(z); } STMT_END
 388 #  else
 389 #    define PERL_UNUSED_RESULT(v) ((void)(v))
 390 #  endif
 391 #endif
 392
 393 /* on gcc (and clang), specify that a warning should be temporarily
 394  * ignored; e.g.
 395  *
 396  *    GCC_DIAG_IGNORE(-Wmultichar);
 397  *    char b = 'ab';
 398  *    GCC_DIAG_RESTORE;
 399  *
 400  * based on http://dbp-consulting.com/tutorials/SuppressingGCCWarnings.html
 401  *
 402  * Note that "pragma GCC diagnostic push/pop" was added in GCC 4.6, Mar 2011;
 403  * clang only pretends to be GCC 4.2, but still supports push/pop.
 404  *
 405  * Note on usage: on non-gcc (or lookalike, like clang) compilers
 406  * one cannot use these at file (global) level without warnings
 407  * since they are defined as empty, which leads into the terminating
 408  * semicolon being left alone on a line:
 409  * ;
 410  * which makes compilers mildly cranky.  Therefore at file level one
 411  * should use the GCC_DIAG_IGNORE and GCC_DIAG_RESTORE_FILE *without*
 412  * the semicolons.
 413  *
 414  * (A dead-on-arrival solution would be to try to define the macros as
 415  * NOOP or dNOOP, those don't work both inside functions and outside.)
 416  */
 417
 418 #if defined(__clang__) || defined(__clang) || \
 419        (defined( __GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406)
 420 #  define GCC_DIAG_PRAGMA(x) _Pragma (#x)
 421 /* clang has "clang diagnostic" pragmas, but also understands gcc. */
 422 #  define GCC_DIAG_IGNORE(x) _Pragma("GCC diagnostic push") \
 423                              GCC_DIAG_PRAGMA(GCC diagnostic ignored #x)
 424 #  define GCC_DIAG_RESTORE   _Pragma("GCC diagnostic pop")
 425 #else
 426 #  define GCC_DIAG_IGNORE(w)
 427 #  define GCC_DIAG_RESTORE
 428 #endif
 429 /* for clang specific pragmas */
 430 #if defined(__clang__) || defined(__clang)
 431 #  define CLANG_DIAG_PRAGMA(x) _Pragma (#x)
 432 #  define CLANG_DIAG_IGNORE(x) _Pragma("clang diagnostic push") \
 433                                CLANG_DIAG_PRAGMA(clang diagnostic ignored #x)
 434 #  define CLANG_DIAG_RESTORE   _Pragma("clang diagnostic pop")
 435 #else
 436 #  define CLANG_DIAG_IGNORE(w)
 437 #  define CLANG_DIAG_RESTORE
 438 #endif
 439
 440 #define NOOP /*EMPTY*/(void)0
 441 /* cea2e8a9dd23747f accidentally lost the comment originally from the first
 442    check in of thread.h, explaining why we need dNOOP at all:  */
 443 /* Rats: if dTHR is just blank then the subsequent ";" throws an error */
 444 /* Declaring a *function*, instead of a variable, ensures that we don't rely
 445    on being able to suppress "unused" warnings.  */
 446 #ifdef __cplusplus
 447 #define dNOOP (void)0
 448 #else
 449 #define dNOOP extern int Perl___notused(void)
 450 #endif
 451
 452 #ifndef pTHX
 453 /* Don't bother defining tTHX ; using it outside
 454  * code guarded by PERL_IMPLICIT_CONTEXT is an error.
 455  */
 456 #  define pTHX          void
 457 #  define pTHX_
 458 #  define aTHX
 459 #  define aTHX_
 460 #  define aTHXa(a)      NOOP
 461 #  define dTHXa(a)      dNOOP
 462 #  define dTHX          dNOOP
 463 #  define pTHX_1        1
 464 #  define pTHX_2        2
 465 #  define pTHX_3        3
 466 #  define pTHX_4        4
 467 #  define pTHX_5        5
 468 #  define pTHX_6        6
 469 #  define pTHX_7        7
 470 #  define pTHX_8        8
 471 #  define pTHX_9        9
 472 #  define pTHX_12       12
 473 #endif
 474
 475 #ifndef dVAR
 476 #  define dVAR          dNOOP
 477 #endif
 478
 479 /* these are only defined for compatibility; should not be used internally */
 480 #if !defined(pTHXo) && !defined(PERL_CORE)
 481 #  define pTHXo         pTHX
 482 #  define pTHXo_        pTHX_
 483 #  define aTHXo         aTHX
 484 #  define aTHXo_        aTHX_
 485 #  define dTHXo         dTHX
 486 #  define dTHXoa(x)     dTHXa(x)
 487 #endif
 488
 489 #ifndef pTHXx
 490 #  define pTHXx         PerlInterpreter *my_perl
 491 #  define pTHXx_        pTHXx,
 492 #  define aTHXx         my_perl
 493 #  define aTHXx_        aTHXx,
 494 #  define dTHXx         dTHX
 495 #endif
 496
 497 /* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
 498  * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
 499  * dTHXs is therefore needed for all functions using PerlIO_foo(). */
 500 #ifdef PERL_IMPLICIT_SYS
 501 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
 502 #    define dTHXs               dVAR; dTHX
 503 #  else
 504 #    define dTHXs               dTHX
 505 #  endif
 506 #else
 507 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
 508 #    define dTHXs               dVAR
 509 #  else
 510 #    define dTHXs               dNOOP
 511 #  endif
 512 #endif
 513
 514 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
 515 #  ifndef PERL_USE_GCC_BRACE_GROUPS
 516 #    define PERL_USE_GCC_BRACE_GROUPS
 517 #  endif
 518 #endif
 519
 520 /*
 521  * STMT_START { statements; } STMT_END;
 522  * can be used as a single statement, as in
 523  * if (x) STMT_START { ... } STMT_END; else ...
 524  *
 525  * Trying to select a version that gives no warnings...
 526  */
 527 #if !(defined(STMT_START) && defined(STMT_END))
 528 # ifdef PERL_USE_GCC_BRACE_GROUPS
 529 #   define STMT_START   (void)( /* gcc supports "({ STATEMENTS; })" */
 530 #   define STMT_END     )
 531 # else
 532 #   define STMT_START   do
 533 #   define STMT_END     while (0)
 534 # endif
 535 #endif
 536
 537 #ifndef BYTEORDER  /* Should never happen -- byteorder is in config.h */
 538 #   define BYTEORDER 0x1234
 539 #endif
 540
 541 /* Overall memory policy? */
 542 #ifndef CONSERVATIVE
 543 #   define LIBERAL 1
 544 #endif
 545
 546 #if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
 547 #define ASCIIish
 548 #else
 549 #undef  ASCIIish
 550 #endif
 551
 552 /*
 553  * The following contortions are brought to you on behalf of all the
 554  * standards, semi-standards, de facto standards, not-so-de-facto standards
 555  * of the world, as well as all the other botches anyone ever thought of.
 556  * The basic theory is that if we work hard enough here, the rest of the
 557  * code can be a lot prettier.  Well, so much for theory.  Sorry, Henry...
 558  */
 559
 560 /* define this once if either system, instead of cluttering up the src */
 561 #if defined(MSDOS) || defined(WIN32) || defined(NETWARE)
 562 #define DOSISH 1
 563 #endif
 564
 565 #if defined(__STDC__) || defined(_AIX) || defined(__stdc__) || defined(__cplusplus) || defined(NETWARE) || defined(__SYMBIAN32__)
 566 # define STANDARD_C 1
 567 #endif
 568
 569 #if defined(__cplusplus) || defined(WIN32) || defined(__sgi) || defined(__EMX__) || defined(__QNX__) || defined(NETWARE) || defined(PERL_MICRO)
 570 # define DONT_DECLARE_STD 1
 571 #endif
 572
 573 #if defined(HASVOLATILE) || defined(STANDARD_C)
 574 #       define VOL volatile
 575 #else
 576 #   define VOL
 577 #endif
 578
 579 /* By compiling a perl with -DNO_TAINT_SUPPORT or -DSILENT_NO_TAINT_SUPPORT,
 580  * you get a perl without taint support, but doubtlessly with a lesser
 581  * degree of support. Do not do so unless you know exactly what it means
 582  * technically, have a good reason to do so, and know exactly how the
 583  * perl will be used. perls with -DSILENT_NO_TAINT_SUPPORT are considered
 584  * a potential security risk due to flat out ignoring the security-relevant
 585  * taint flags. This being said, a perl without taint support compiled in
 586  * has marginal run-time performance benefits.
 587  * SILENT_NO_TAINT_SUPPORT implies NO_TAINT_SUPPORT.
 588  * SILENT_NO_TAINT_SUPPORT is the same as NO_TAINT_SUPPORT except it
 589  * silently ignores -t/-T instead of throwing an exception.
 590  *
 591  * DANGER! Using NO_TAINT_SUPPORT or SILENT_NO_TAINT_SUPPORT
 592  *         voids your nonexistent warranty!
 593  */
 594 #if defined(SILENT_NO_TAINT_SUPPORT) && !defined(NO_TAINT_SUPPORT)
 595 #  define NO_TAINT_SUPPORT 1
 596 #endif
 597
 598 /* NO_TAINT_SUPPORT can be set to transform virtually all taint-related
 599  * operations into no-ops for a very modest speed-up. Enable only if you
 600  * know what you're doing: tests and CPAN modules' tests are bound to fail.
 601  */
 602 #ifdef NO_TAINT_SUPPORT
 603 #   define TAINT                NOOP
 604 #   define TAINT_NOT            NOOP
 605 #   define TAINT_IF(c)          NOOP
 606 #   define TAINT_ENV()          NOOP
 607 #   define TAINT_PROPER(s)      NOOP
 608 #   define TAINT_set(s)         NOOP
 609 #   define TAINT_get            0
 610 #   define TAINTING_get         0
 611 #   define TAINTING_set(s)      NOOP
 612 #   define TAINT_WARN_get       0
 613 #   define TAINT_WARN_set(s)    NOOP
 614 #else
 615 #   define TAINT                (PL_tainted = PL_tainting)
 616 #   define TAINT_NOT    (PL_tainted = FALSE)
 617 #   define TAINT_IF(c)  if (UNLIKELY(c)) { PL_tainted = PL_tainting; }
 618 #   define TAINT_ENV()  if (UNLIKELY(PL_tainting)) { taint_env(); }
 619 #   define TAINT_PROPER(s)      if (UNLIKELY(PL_tainting)) { taint_proper(NULL, s); }
 620 #   define TAINT_set(s)         (PL_tainted = (s))
 621 #   define TAINT_get            (PL_tainted)
 622 #   define TAINTING_get         (PL_tainting)
 623 #   define TAINTING_set(s)      (PL_tainting = (s))
 624 #   define TAINT_WARN_get       (PL_taint_warn)
 625 #   define TAINT_WARN_set(s)    (PL_taint_warn = (s))
 626 #endif
 627
 628 /* flags used internally only within pp_subst and pp_substcont */
 629 #ifdef PERL_CORE
 630 #  define SUBST_TAINT_STR      1        /* string tainted */
 631 #  define SUBST_TAINT_PAT      2        /* pattern tainted */
 632 #  define SUBST_TAINT_REPL     4        /* replacement tainted */
 633 #  define SUBST_TAINT_RETAINT  8        /* use re'taint' in scope */
 634 #  define SUBST_TAINT_BOOLRET 16        /* return is boolean (don't taint) */
 635 #endif
 636
 637 /* XXX All process group stuff is handled in pp_sys.c.  Should these
 638    defines move there?  If so, I could simplify this a lot. --AD  9/96.
 639 */
 640 /* Process group stuff changed from traditional BSD to POSIX.
 641    perlfunc.pod documents the traditional BSD-style syntax, so we'll
 642    try to preserve that, if possible.
 643 */
 644 #ifdef HAS_SETPGID
 645 #  define BSD_SETPGRP(pid, pgrp)        setpgid((pid), (pgrp))
 646 #else
 647 #  if defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
 648 #    define BSD_SETPGRP(pid, pgrp)      setpgrp((pid), (pgrp))
 649 #  else
 650 #    ifdef HAS_SETPGRP2  /* DG/UX */
 651 #      define BSD_SETPGRP(pid, pgrp)    setpgrp2((pid), (pgrp))
 652 #    endif
 653 #  endif
 654 #endif
 655 #if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
 656 #  define HAS_SETPGRP  /* Well, effectively it does . . . */
 657 #endif
 658
 659 /* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
 660     our life easier :-) so we'll try it.
 661 */
 662 #ifdef HAS_GETPGID
 663 #  define BSD_GETPGRP(pid)              getpgid((pid))
 664 #else
 665 #  if defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
 666 #    define BSD_GETPGRP(pid)            getpgrp((pid))
 667 #  else
 668 #    ifdef HAS_GETPGRP2  /* DG/UX */
 669 #      define BSD_GETPGRP(pid)          getpgrp2((pid))
 670 #    endif
 671 #  endif
 672 #endif
 673 #if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
 674 #  define HAS_GETPGRP  /* Well, effectively it does . . . */
 675 #endif
 676
 677 /* These are not exact synonyms, since setpgrp() and getpgrp() may
 678    have different behaviors, but perl.h used to define USE_BSDPGRP
 679    (prior to 5.003_05) so some extension might depend on it.
 680 */
 681 #if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
 682 #  ifndef USE_BSDPGRP
 683 #    define USE_BSDPGRP
 684 #  endif
 685 #endif
 686
 687 /* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
 688    pthread.h must be included before all other header files.
 689 */
 690 #if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
 691 #  include <pthread.h>
 692 #endif
 693
 694 #include <sys/types.h>
 695
 696 #ifdef __cplusplus
 697 #  ifndef I_STDARG
 698 #    define I_STDARG 1
 699 #  endif
 700 #endif
 701
 702 /* EVC 4 SDK headers includes a bad definition of MB_CUR_MAX in stdlib.h
 703   which is included from stdarg.h. Bad definition not present in SD 2008
 704   SDK headers. wince.h is not yet included, so we cant fix this from there
 705   since by then MB_CUR_MAX will be defined from stdlib.h.
 706   cewchar.h includes a correct definition of MB_CUR_MAX and it is copied here
 707   since cewchar.h can't be included this early */
 708 #if defined(UNDER_CE) && (_MSC_VER < 1300)
 709 #  define MB_CUR_MAX 1
 710 #endif
 711 #ifdef I_STDARG
 712 #  include <stdarg.h>
 713 #else
 714 #  ifdef I_VARARGS
 715 #    include <varargs.h>
 716 #  endif
 717 #endif
 718
 719 #ifdef I_STDINT
 720 # include <stdint.h>
 721 #endif
 722
 723 #include <ctype.h>
 724
 725 #ifdef METHOD   /* Defined by OSF/1 v3.0 by ctype.h */
 726 #undef METHOD
 727 #endif
 728
 729 #ifdef PERL_MICRO
 730 #   define NO_LOCALE
 731 #endif
 732
 733 #ifdef I_LOCALE
 734 #   include <locale.h>
 735 #endif
 736
 737 #ifdef I_XLOCALE
 738 #   include <xlocale.h>
 739 #endif
 740
 741 #if !defined(NO_LOCALE) && defined(HAS_SETLOCALE)
 742 #   define USE_LOCALE
 743 #   define HAS_SKIP_LOCALE_INIT /* Solely for XS code to test for this
 744                                    capability */
 745 #   if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
 746        && defined(HAS_STRXFRM)
 747 #       define USE_LOCALE_COLLATE
 748 #   endif
 749 #   if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
 750 #       define USE_LOCALE_CTYPE
 751 #   endif
 752 #   if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
 753 #       define USE_LOCALE_NUMERIC
 754 #   endif
 755 #   if !defined(NO_LOCALE_MESSAGES) && defined(LC_MESSAGES)
 756 #       define USE_LOCALE_MESSAGES
 757 #   endif
 758 #   if !defined(NO_LOCALE_MONETARY) && defined(LC_MONETARY)
 759 #       define USE_LOCALE_MONETARY
 760 #   endif
 761 #   if !defined(NO_LOCALE_TIME) && defined(LC_TIME)
 762 #       define USE_LOCALE_TIME
 763 #   endif
 764 #endif /* !NO_LOCALE && HAS_SETLOCALE */
 765
 766 #include <setjmp.h>
 767
 768 #ifdef I_SYS_PARAM
 769 #   ifdef PARAM_NEEDS_TYPES
 770 #       include <sys/types.h>
 771 #   endif
 772 #   include <sys/param.h>
 773 #endif
 774
 775 /* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
 776    value something like 199306.  This may be useful if no more-specific
 777    feature test is available.
 778 */
 779 #if defined(BSD)
 780 #   ifndef BSDish
 781 #       define BSDish
 782 #   endif
 783 #endif
 784
 785 /* Use all the "standard" definitions? */
 786 #if defined(STANDARD_C) && defined(I_STDLIB)
 787 #   include <stdlib.h>
 788 #endif
 789
 790 /* If this causes problems, set i_unistd=undef in the hint file.  */
 791 #ifdef I_UNISTD
 792 #    if defined(__amigaos4__)
 793 #        ifdef I_NETINET_IN
 794 #            include <netinet/in.h>
 795 #        endif
 796 #   endif
 797 #   include <unistd.h>
 798 #   if defined(__amigaos4__)
 799 /* Under AmigaOS 4 newlib.library provides an environ.  However using
 800  * it doesn't give us enough control over inheritance of variables by
 801  * subshells etc. so replace with custom version based on abc-shell
 802  * code. */
 803 extern char **myenviron;
 804 #       undef environ
 805 #       define environ myenviron
 806 #   endif
 807 #endif
 808
 809 /* for WCOREDUMP */
 810 #ifdef I_SYS_WAIT
 811 #   include <sys/wait.h>
 812 #endif
 813
 814 #ifdef __SYMBIAN32__
 815 #   undef _SC_ARG_MAX /* Symbian has _SC_ARG_MAX but no sysconf() */
 816 #endif
 817
 818 #if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
 819 EXTERN_C int syscall(int, ...);
 820 #endif
 821
 822 #if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
 823 EXTERN_C int usleep(unsigned int);
 824 #endif
 825
 826 #ifdef PERL_CORE
 827
 828 /* macros for correct constant construction */
 829 # if INTSIZE >= 2
 830 #  define U16_CONST(x) ((U16)x##U)
 831 # else
 832 #  define U16_CONST(x) ((U16)x##UL)
 833 # endif
 834
 835 # if INTSIZE >= 4
 836 #  define U32_CONST(x) ((U32)x##U)
 837 # else
 838 #  define U32_CONST(x) ((U32)x##UL)
 839 # endif
 840
 841 # ifdef HAS_QUAD
 842 #  if INTSIZE >= 8
 843 #   define U64_CONST(x) ((U64)x##U)
 844 #  elif LONGSIZE >= 8
 845 #   define U64_CONST(x) ((U64)x##UL)
 846 #  elif QUADKIND == QUAD_IS_LONG_LONG
 847 #   define U64_CONST(x) ((U64)x##ULL)
 848 #  elif QUADKIND == QUAD_IS___INT64
 849 #   define U64_CONST(x) ((U64)x##UI64)
 850 #  else /* best guess we can make */
 851 #   define U64_CONST(x) ((U64)x##UL)
 852 #  endif
 853 # endif
 854
 855 /* byte-swapping functions for big-/little-endian conversion */
 856 # define _swab_16_(x) ((U16)( \
 857          (((U16)(x) & U16_CONST(0x00ff)) << 8) | \
 858          (((U16)(x) & U16_CONST(0xff00)) >> 8) ))
 859
 860 # define _swab_32_(x) ((U32)( \
 861          (((U32)(x) & U32_CONST(0x000000ff)) << 24) | \
 862          (((U32)(x) & U32_CONST(0x0000ff00)) <<  8) | \
 863          (((U32)(x) & U32_CONST(0x00ff0000)) >>  8) | \
 864          (((U32)(x) & U32_CONST(0xff000000)) >> 24) ))
 865
 866 # ifdef HAS_QUAD
 867 #  define _swab_64_(x) ((U64)( \
 868           (((U64)(x) & U64_CONST(0x00000000000000ff)) << 56) | \
 869           (((U64)(x) & U64_CONST(0x000000000000ff00)) << 40) | \
 870           (((U64)(x) & U64_CONST(0x0000000000ff0000)) << 24) | \
 871           (((U64)(x) & U64_CONST(0x00000000ff000000)) <<  8) | \
 872           (((U64)(x) & U64_CONST(0x000000ff00000000)) >>  8) | \
 873           (((U64)(x) & U64_CONST(0x0000ff0000000000)) >> 24) | \
 874           (((U64)(x) & U64_CONST(0x00ff000000000000)) >> 40) | \
 875           (((U64)(x) & U64_CONST(0xff00000000000000)) >> 56) ))
 876 # endif
 877
 878 /* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
 879    at least on FreeBSD.  YMMV, so experiment.  */
 880 #ifndef PERL_ARENA_SIZE
 881 #define PERL_ARENA_SIZE 4080
 882 #endif
 883
 884 /* Maximum level of recursion */
 885 #ifndef PERL_SUB_DEPTH_WARN
 886 #define PERL_SUB_DEPTH_WARN 100
 887 #endif
 888
 889 #endif /* PERL_CORE */
 890
 891 /* We no longer default to creating a new SV for GvSV.
 892    Do this before embed.  */
 893 #ifndef PERL_CREATE_GVSV
 894 #  ifndef PERL_DONT_CREATE_GVSV
 895 #    define PERL_DONT_CREATE_GVSV
 896 #  endif
 897 #endif
 898
 899 #if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
 900 #define PERL_USES_PL_PIDSTATUS
 901 #endif
 902
 903 #if !defined(OS2) && !defined(WIN32) && !defined(DJGPP) && !defined(__SYMBIAN32__)
 904 #define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
 905 #endif
 906
 907 #define MEM_SIZE Size_t
 908
 909 /* Round all values passed to malloc up, by default to a multiple of
 910    sizeof(size_t)
 911 */
 912 #ifndef PERL_STRLEN_ROUNDUP_QUANTUM
 913 #define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
 914 #endif
 915
 916 /* sv_grow() will expand strings by at least a certain percentage of
 917    the previously *used* length to avoid excessive calls to realloc().
 918    The default is 25% of the current length.
 919 */
 920 #ifndef PERL_STRLEN_EXPAND_SHIFT
 921 #  define PERL_STRLEN_EXPAND_SHIFT 2
 922 #endif
 923
 924 #if defined(STANDARD_C) && defined(I_STDDEF) && !defined(PERL_GCC_PEDANTIC)
 925 #   include <stddef.h>
 926 #   define STRUCT_OFFSET(s,m)  offsetof(s,m)
 927 #else
 928 #   define STRUCT_OFFSET(s,m)  (Size_t)(&(((s *)0)->m))
 929 #endif
 930
 931 /* ptrdiff_t is C11, so undef it under pedantic builds */
 932 #ifdef PERL_GCC_PEDANTIC
 933 #   undef HAS_PTRDIFF_T
 934 #endif
 935
 936 #ifndef __SYMBIAN32__
 937 #  if defined(I_STRING) || defined(__cplusplus)
 938 #     include <string.h>
 939 #  else
 940 #     include <strings.h>
 941 #  endif
 942 #endif
 943
 944 /* This comes after <stdlib.h> so we don't try to change the standard
 945  * library prototypes; we'll use our own in proto.h instead. */
 946
 947 #ifdef MYMALLOC
 948 #  ifdef PERL_POLLUTE_MALLOC
 949 #   ifndef PERL_EXTMALLOC_DEF
 950 #    define Perl_malloc         malloc
 951 #    define Perl_calloc         calloc
 952 #    define Perl_realloc        realloc
 953 #    define Perl_mfree          free
 954 #   endif
 955 #  else
 956 #    define EMBEDMYMALLOC       /* for compatibility */
 957 #  endif
 958
 959 #  define safemalloc  Perl_malloc
 960 #  define safecalloc  Perl_calloc
 961 #  define saferealloc Perl_realloc
 962 #  define safefree    Perl_mfree
 963 #  define CHECK_MALLOC_TOO_LATE_FOR_(code)      STMT_START {            \
 964         if (!PL_tainting && MallocCfg_ptr[MallocCfg_cfg_env_read])      \
 965                 code;                                                   \
 966     } STMT_END
 967 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)                         \
 968         CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
 969 #  define panic_write2(s)               write(2, s, strlen(s))
 970 #  define CHECK_MALLOC_TAINT(newval)                            \
 971         CHECK_MALLOC_TOO_LATE_FOR_(                             \
 972                 if (newval) {                                   \
 973                   PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
 974                   exit(1); })
 975 #  define MALLOC_CHECK_TAINT(argc,argv,env)     STMT_START {    \
 976         if (doing_taint(argc,argv,env)) {                       \
 977                 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1;      \
 978     }} STMT_END;
 979 #else  /* MYMALLOC */
 980 #  define safemalloc  safesysmalloc
 981 #  define safecalloc  safesyscalloc
 982 #  define saferealloc safesysrealloc
 983 #  define safefree    safesysfree
 984 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)         ((void)0)
 985 #  define CHECK_MALLOC_TAINT(newval)            ((void)0)
 986 #  define MALLOC_CHECK_TAINT(argc,argv,env)
 987 #endif /* MYMALLOC */
 988
 989 /* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
 990 #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)
 991 #define TOO_LATE_FOR(ch)        TOO_LATE_FOR_(ch, "")
 992 #define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
 993 #define MALLOC_CHECK_TAINT2(argc,argv)  MALLOC_CHECK_TAINT(argc,argv,NULL)
 994
 995 #if !defined(HAS_STRCHR) && defined(HAS_INDEX) && !defined(strchr)
 996 #define strchr index
 997 #define strrchr rindex
 998 #endif
 999
1000 #ifdef I_MEMORY
1001 #  include <memory.h>
1002 #endif
1003
1004 #ifdef HAS_MEMCPY
1005 #  if !defined(STANDARD_C) && !defined(I_STRING) && !defined(I_MEMORY)
1006 #    ifndef memcpy
1007         extern char * memcpy (char*, char*, int);
1008 #    endif
1009 #  endif
1010 #else
1011 #   ifndef memcpy
1012 #       define memcpy(d,s,l) my_bcopy(s,d,l)
1013 #   endif
1014 #endif /* HAS_MEMCPY */
1015
1016 #ifdef HAS_MEMSET
1017 #  if !defined(STANDARD_C) && !defined(I_STRING) && !defined(I_MEMORY)
1018 #    ifndef memset
1019         extern char *memset (char*, int, int);
1020 #    endif
1021 #  endif
1022 #else
1023 #  undef  memset
1024 #  define memset(d,c,l) my_memset(d,c,l)
1025 #endif /* HAS_MEMSET */
1026
1027 #if !defined(HAS_MEMMOVE) && !defined(memmove)
1028 #   if defined(HAS_MEMCPY) && defined(HAS_SAFE_MEMCPY)
1029 #       define memmove(d,s,l) memcpy(d,s,l)
1030 #   else
1031 #       define memmove(d,s,l) my_bcopy(s,d,l)
1032 #   endif
1033 #endif
1034
1035 #if defined(mips) && defined(ultrix) && !defined(__STDC__)
1036 #   undef HAS_MEMCMP
1037 #endif
1038
1039 #if defined(HAS_MEMCMP) && defined(HAS_SANE_MEMCMP)
1040 #  if !defined(STANDARD_C) && !defined(I_STRING) && !defined(I_MEMORY)
1041 #    ifndef memcmp
1042         extern int memcmp (char*, char*, int);
1043 #    endif
1044 #  endif
1045 #else
1046 #   undef memcmp
1047 #   define memcmp   my_memcmp
1048 #endif /* HAS_MEMCMP && HAS_SANE_MEMCMP */
1049
1050 #ifndef memzero
1051 #   ifdef HAS_MEMSET
1052 #       define memzero(d,l) memset(d,0,l)
1053 #   else
1054 #       ifdef HAS_BZERO
1055 #           define memzero(d,l) bzero(d,l)
1056 #       else
1057 #           define memzero(d,l) my_bzero(d,l)
1058 #       endif
1059 #   endif
1060 #endif
1061
1062 #ifndef PERL_MICRO
1063 #ifndef memchr
1064 #   ifndef HAS_MEMCHR
1065 #       define memchr(s,c,n) ninstr((char*)(s), ((char*)(s)) + n, &(c), &(c) + 1)
1066 #   endif
1067 #endif
1068 #endif
1069
1070 #ifndef HAS_BCMP
1071 #   ifndef bcmp
1072 #       define bcmp(s1,s2,l) memcmp(s1,s2,l)
1073 #   endif
1074 #endif /* !HAS_BCMP */
1075
1076 #ifdef I_NETINET_IN
1077 #   include <netinet/in.h>
1078 #endif
1079
1080 #ifdef I_ARPA_INET
1081 #   include <arpa/inet.h>
1082 #endif
1083
1084 #ifdef I_SYS_STAT
1085 #   include <sys/stat.h>
1086 #endif
1087
1088 /* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1089    This definition should ideally go into win32/win32.h, but S_IFIFO is
1090    used later here in perl.h before win32/win32.h is being included. */
1091 #if !defined(S_IFIFO) && defined(_S_IFIFO)
1092 #   define S_IFIFO _S_IFIFO
1093 #endif
1094
1095 /* The stat macros for Unisoft System V/88 (and derivatives
1096    like UTekV) are broken, sometimes giving false positives.  Undefine
1097    them here and let the code below set them to proper values.
1098
1099    The ghs macro stands for GreenHills Software C-1.8.5 which
1100    is the C compiler for sysV88 and the various derivatives.
1101    This header file bug is corrected in gcc-2.5.8 and later versions.
1102    --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94.  */
1103
1104 #if defined(m88k) && defined(ghs)
1105 #   undef S_ISDIR
1106 #   undef S_ISCHR
1107 #   undef S_ISBLK
1108 #   undef S_ISREG
1109 #   undef S_ISFIFO
1110 #   undef S_ISLNK
1111 #endif
1112
1113 #ifdef I_TIME
1114 #   include <time.h>
1115 #endif
1116
1117 #ifdef I_SYS_TIME
1118 #   ifdef I_SYS_TIME_KERNEL
1119 #       define KERNEL
1120 #   endif
1121 #   include <sys/time.h>
1122 #   ifdef I_SYS_TIME_KERNEL
1123 #       undef KERNEL
1124 #   endif
1125 #endif
1126
1127 #if defined(HAS_TIMES) && defined(I_SYS_TIMES)
1128 #    include <sys/times.h>
1129 #endif
1130
1131 #if defined(HAS_STRERROR) && (!defined(HAS_MKDIR) || !defined(HAS_RMDIR))
1132 #   undef HAS_STRERROR
1133 #endif
1134
1135 #include <errno.h>
1136
1137 #if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
1138 #  define WIN32SCK_IS_STDSCK            /* don't pull in custom wsock layer */
1139 #endif
1140
1141 #if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1142 # include <sys/socket.h>
1143 # if defined(USE_SOCKS) && defined(I_SOCKS)
1144 #   if !defined(INCLUDE_PROTOTYPES)
1145 #       define INCLUDE_PROTOTYPES /* for <socks.h> */
1146 #       define PERL_SOCKS_NEED_PROTOTYPES
1147 #   endif
1148 #   include <socks.h>
1149 #   ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1150 #       undef INCLUDE_PROTOTYPES
1151 #       undef PERL_SOCKS_NEED_PROTOTYPES
1152 #   endif
1153 # endif
1154 # ifdef I_NETDB
1155 #  ifdef NETWARE
1156 #   include<stdio.h>
1157 #  endif
1158 #  include <netdb.h>
1159 # endif
1160 # ifndef ENOTSOCK
1161 #  ifdef I_NET_ERRNO
1162 #   include <net/errno.h>
1163 #  endif
1164 # endif
1165 #endif
1166
1167 /* sockatmark() is so new (2001) that many places might have it hidden
1168  * behind some -D_BLAH_BLAH_SOURCE guard.  The __THROW magic is required
1169  * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
1170 #if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
1171 # if defined(__THROW) && defined(__GLIBC__)
1172 int sockatmark(int) __THROW;
1173 # else
1174 int sockatmark(int);
1175 # endif
1176 #endif
1177
1178 #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. */
1179 EXTERN_C int fchdir(int);
1180 EXTERN_C int flock(int, int);
1181 EXTERN_C int fseeko(FILE *, off_t, int);
1182 EXTERN_C off_t ftello(FILE *);
1183 #endif
1184
1185 #if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1186 EXTERN_C char *crypt(const char *, const char *);
1187 EXTERN_C char **environ;
1188 #endif
1189
1190 #if defined(__cplusplus)
1191 #  if defined(BSDish)
1192 EXTERN_C char **environ;
1193 #  elif defined(__CYGWIN__)
1194 EXTERN_C char *crypt(const char *, const char *);
1195 #endif
1196 #endif
1197
1198 #ifdef SETERRNO
1199 # undef SETERRNO  /* SOCKS might have defined this */
1200 #endif
1201
1202 #ifdef VMS
1203 #   define SETERRNO(errcode,vmserrcode) \
1204         STMT_START {                    \
1205             set_errno(errcode);         \
1206             set_vaxc_errno(vmserrcode); \
1207         } STMT_END
1208 #   define dSAVEDERRNO    int saved_errno; unsigned saved_vms_errno
1209 #   define dSAVE_ERRNO    int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1210 #   define SAVE_ERRNO     ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1211 #   define RESTORE_ERRNO  SETERRNO(saved_errno, saved_vms_errno)
1212
1213 #   define LIB_INVARG           LIB$_INVARG
1214 #   define RMS_DIR              RMS$_DIR
1215 #   define RMS_FAC              RMS$_FAC
1216 #   define RMS_FEX              RMS$_FEX
1217 #   define RMS_FNF              RMS$_FNF
1218 #   define RMS_IFI              RMS$_IFI
1219 #   define RMS_ISI              RMS$_ISI
1220 #   define RMS_PRV              RMS$_PRV
1221 #   define SS_ACCVIO            SS$_ACCVIO
1222 #   define SS_DEVOFFLINE        SS$_DEVOFFLINE
1223 #   define SS_IVCHAN            SS$_IVCHAN
1224 #   define SS_NORMAL            SS$_NORMAL
1225 #   define SS_NOPRIV            SS$_NOPRIV
1226 #   define SS_BUFFEROVF         SS$_BUFFEROVF
1227 #else
1228 #   define LIB_INVARG           0
1229 #   define RMS_DIR              0
1230 #   define RMS_FAC              0
1231 #   define RMS_FEX              0
1232 #   define RMS_FNF              0
1233 #   define RMS_IFI              0
1234 #   define RMS_ISI              0
1235 #   define RMS_PRV              0
1236 #   define SS_ACCVIO            0
1237 #   define SS_DEVOFFLINE        0
1238 #   define SS_IVCHAN            0
1239 #   define SS_NORMAL            0
1240 #   define SS_NOPRIV            0
1241 #   define SS_BUFFEROVF         0
1242 #endif
1243
1244 #ifdef WIN32
1245 #   define dSAVEDERRNO  int saved_errno; DWORD saved_win32_errno
1246 #   define dSAVE_ERRNO  int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1247 #   define SAVE_ERRNO   ( saved_errno = errno, saved_win32_errno = GetLastError() )
1248 #   define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1249 #endif
1250
1251 #ifdef OS2
1252 #   define dSAVEDERRNO  int saved_errno; unsigned long saved_os2_errno
1253 #   define dSAVE_ERRNO  int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1254 #   define SAVE_ERRNO   ( saved_errno = errno, saved_os2_errno = Perl_rc )
1255 #   define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1256 #endif
1257
1258 #ifndef SETERRNO
1259 #   define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1260 #endif
1261
1262 #ifndef dSAVEDERRNO
1263 #   define dSAVEDERRNO    int saved_errno
1264 #   define dSAVE_ERRNO    int saved_errno = errno
1265 #   define SAVE_ERRNO     (saved_errno = errno)
1266 #   define RESTORE_ERRNO  (errno = saved_errno)
1267 #endif
1268
1269 #define ERRSV GvSVn(PL_errgv)
1270
1271 /* contains inlined gv_add_by_type */
1272 #define CLEAR_ERRSV() STMT_START {                                      \
1273     SV ** const svp = &GvSV(PL_errgv);                                  \
1274     if (!*svp) {                                                        \
1275         *svp = newSVpvs("");                                            \
1276     } else if (SvREADONLY(*svp)) {                                      \
1277         SvREFCNT_dec_NN(*svp);                                          \
1278         *svp = newSVpvs("");                                            \
1279     } else {                                                            \
1280         SV *const errsv = *svp;                                         \
1281         SvPVCLEAR(errsv);                                               \
1282         SvPOK_only(errsv);                                              \
1283         if (SvMAGICAL(errsv)) {                                         \
1284             mg_free(errsv);                                             \
1285         }                                                               \
1286     }                                                                   \
1287     } STMT_END
1288
1289
1290 #ifdef PERL_CORE
1291 # define DEFSV (0 + GvSVn(PL_defgv))
1292 # define DEFSV_set(sv) \
1293     (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1294 # define SAVE_DEFSV                \
1295     (                               \
1296         save_gp(PL_defgv, 0),        \
1297         GvINTRO_off(PL_defgv),        \
1298         SAVEGENERICSV(GvSV(PL_defgv)), \
1299         GvSV(PL_defgv) = NULL           \
1300     )
1301 #else
1302 # define DEFSV GvSVn(PL_defgv)
1303 # define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1304 # define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
1305 #endif
1306
1307 #ifndef errno
1308         extern int errno;     /* ANSI allows errno to be an lvalue expr.
1309                                * For example in multithreaded environments
1310                                * something like this might happen:
1311                                * extern int *_errno(void);
1312                                * #define errno (*_errno()) */
1313 #endif
1314
1315 #define UNKNOWN_ERRNO_MSG "(unknown)"
1316
1317 #ifdef HAS_STRERROR
1318 #   ifndef DONT_DECLARE_STD
1319 #       ifdef VMS
1320         char *strerror (int,...);
1321 #       else
1322         char *strerror (int);
1323 #       endif
1324 #    endif
1325 #    ifndef Strerror
1326 #       define Strerror strerror
1327 #    endif
1328 #else
1329 #    ifdef HAS_SYS_ERRLIST
1330         extern int sys_nerr;
1331         extern char *sys_errlist[];
1332 #       ifndef Strerror
1333 #           define Strerror(e) \
1334                 ((e) < 0 || (e) >= sys_nerr ? UNKNOWN_ERRNO_MSG : sys_errlist[e])
1335 #       endif
1336 #   endif
1337 #endif
1338
1339 #ifdef I_SYS_IOCTL
1340 #   ifndef _IOCTL_
1341 #       include <sys/ioctl.h>
1342 #   endif
1343 #endif
1344
1345 #if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
1346 #   ifdef HAS_SOCKETPAIR
1347 #       undef HAS_SOCKETPAIR
1348 #   endif
1349 #   ifdef I_NDBM
1350 #       undef I_NDBM
1351 #   endif
1352 #endif
1353
1354 #ifndef HAS_SOCKETPAIR
1355 #   ifdef HAS_SOCKET
1356 #       define socketpair Perl_my_socketpair
1357 #   endif
1358 #endif
1359
1360 #if INTSIZE == 2
1361 #   define htoni htons
1362 #   define ntohi ntohs
1363 #else
1364 #   define htoni htonl
1365 #   define ntohi ntohl
1366 #endif
1367
1368 /* Configure already sets Direntry_t */
1369 #if defined(I_DIRENT)
1370 #   include <dirent.h>
1371 #else
1372 #   ifdef I_SYS_NDIR
1373 #       include <sys/ndir.h>
1374 #   else
1375 #       ifdef I_SYS_DIR
1376 #           ifdef hp9000s500
1377 #               include <ndir.h>        /* may be wrong in the future */
1378 #           else
1379 #               include <sys/dir.h>
1380 #           endif
1381 #       endif
1382 #   endif
1383 #endif
1384
1385 /*
1386  * The following gobbledygook brought to you on behalf of __STDC__.
1387  * (I could just use #ifndef __STDC__, but this is more bulletproof
1388  * in the face of half-implementations.)
1389  */
1390
1391 #if defined(I_SYSMODE)
1392 #include <sys/mode.h>
1393 #endif
1394
1395 #ifndef S_IFMT
1396 #   ifdef _S_IFMT
1397 #       define S_IFMT _S_IFMT
1398 #   else
1399 #       define S_IFMT 0170000
1400 #   endif
1401 #endif
1402
1403 #ifndef S_ISDIR
1404 #   define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1405 #endif
1406
1407 #ifndef S_ISCHR
1408 #   define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1409 #endif
1410
1411 #ifndef S_ISBLK
1412 #   ifdef S_IFBLK
1413 #       define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1414 #   else
1415 #       define S_ISBLK(m) (0)
1416 #   endif
1417 #endif
1418
1419 #ifndef S_ISREG
1420 #   define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1421 #endif
1422
1423 #ifndef S_ISFIFO
1424 #   ifdef S_IFIFO
1425 #       define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1426 #   else
1427 #       define S_ISFIFO(m) (0)
1428 #   endif
1429 #endif
1430
1431 #ifndef S_ISLNK
1432 #   ifdef _S_ISLNK
1433 #       define S_ISLNK(m) _S_ISLNK(m)
1434 #   else
1435 #       ifdef _S_IFLNK
1436 #           define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1437 #       else
1438 #           ifdef S_IFLNK
1439 #               define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1440 #           else
1441 #               define S_ISLNK(m) (0)
1442 #           endif
1443 #       endif
1444 #   endif
1445 #endif
1446
1447 #ifndef S_ISSOCK
1448 #   ifdef _S_ISSOCK
1449 #       define S_ISSOCK(m) _S_ISSOCK(m)
1450 #   else
1451 #       ifdef _S_IFSOCK
1452 #           define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1453 #       else
1454 #           ifdef S_IFSOCK
1455 #               define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1456 #           else
1457 #               define S_ISSOCK(m) (0)
1458 #           endif
1459 #       endif
1460 #   endif
1461 #endif
1462
1463 #ifndef S_IRUSR
1464 #   ifdef S_IREAD
1465 #       define S_IRUSR S_IREAD
1466 #       define S_IWUSR S_IWRITE
1467 #       define S_IXUSR S_IEXEC
1468 #   else
1469 #       define S_IRUSR 0400
1470 #       define S_IWUSR 0200
1471 #       define S_IXUSR 0100
1472 #   endif
1473 #endif
1474
1475 #ifndef S_IRGRP
1476 #   ifdef S_IRUSR
1477 #       define S_IRGRP (S_IRUSR>>3)
1478 #       define S_IWGRP (S_IWUSR>>3)
1479 #       define S_IXGRP (S_IXUSR>>3)
1480 #   else
1481 #       define S_IRGRP 0040
1482 #       define S_IWGRP 0020
1483 #       define S_IXGRP 0010
1484 #   endif
1485 #endif
1486
1487 #ifndef S_IROTH
1488 #   ifdef S_IRUSR
1489 #       define S_IROTH (S_IRUSR>>6)
1490 #       define S_IWOTH (S_IWUSR>>6)
1491 #       define S_IXOTH (S_IXUSR>>6)
1492 #   else
1493 #       define S_IROTH 0040
1494 #       define S_IWOTH 0020
1495 #       define S_IXOTH 0010
1496 #   endif
1497 #endif
1498
1499 #ifndef S_ISUID
1500 #   define S_ISUID 04000
1501 #endif
1502
1503 #ifndef S_ISGID
1504 #   define S_ISGID 02000
1505 #endif
1506
1507 #ifndef S_IRWXU
1508 #   define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
1509 #endif
1510
1511 #ifndef S_IRWXG
1512 #   define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
1513 #endif
1514
1515 #ifndef S_IRWXO
1516 #   define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
1517 #endif
1518
1519 /* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
1520  * which would get included through <sys/file.h >, but that is 3000
1521  * lines in the future.  --jhi */
1522
1523 #if !defined(S_IREAD) && !defined(__HAIKU__)
1524 #   define S_IREAD S_IRUSR
1525 #endif
1526
1527 #if !defined(S_IWRITE) && !defined(__HAIKU__)
1528 #   define S_IWRITE S_IWUSR
1529 #endif
1530
1531 #ifndef S_IEXEC
1532 #   define S_IEXEC S_IXUSR
1533 #endif
1534
1535 #if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
1536 #   define SLOPPYDIVIDE
1537 #endif
1538
1539 #ifdef UV
1540 #undef UV
1541 #endif
1542
1543 /* For the times when you want the return value of sprintf, and you want it
1544    to be the length. Can't have a thread variable passed in, because C89 has
1545    no varargs macros.
1546 */
1547 #ifdef SPRINTF_RETURNS_STRLEN
1548 #  define my_sprintf sprintf
1549 #else
1550 #  define my_sprintf Perl_my_sprintf
1551 #endif
1552
1553 /*
1554  * If we have v?snprintf() and the C99 variadic macros, we can just
1555  * use just the v?snprintf().  It is nice to try to trap the buffer
1556  * overflow, however, so if we are DEBUGGING, and we cannot use the
1557  * gcc statement expressions, then use the function wrappers which try
1558  * to trap the overflow.  If we can use the gcc statement expressions,
1559  * we can try that even with the version that uses the C99 variadic
1560  * macros.
1561  */
1562
1563 /* Note that we do not check against snprintf()/vsnprintf() returning
1564  * negative values because that is non-standard behaviour and we use
1565  * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1566  * that should be true only if the snprintf()/vsnprintf() are true
1567  * to the standard. */
1568
1569 #define PERL_SNPRINTF_CHECK(len, max, api) STMT_START { if ((max) > 0 && (Size_t)len > (max)) Perl_croak_nocontext("panic: %s buffer overflow", STRINGIFY(api)); } STMT_END
1570
1571 #ifdef USE_QUADMATH
1572 #  define my_snprintf Perl_my_snprintf
1573 #  define PERL_MY_SNPRINTF_GUARDED
1574 #else
1575 #if defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1576 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1577 #      define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1578 #      define PERL_MY_SNPRINTF_GUARDED
1579 #  else
1580 #    define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
1581 #  endif
1582 #else
1583 #  define my_snprintf  Perl_my_snprintf
1584 #  define PERL_MY_SNPRINTF_GUARDED
1585 #endif
1586 #endif
1587
1588 /* There is no quadmath_vsnprintf, and therefore my_vsnprintf()
1589  * dies if called under USE_QUADMATH. */
1590 #if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1591 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1592 #      define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1593 #      define PERL_MY_VSNPRINTF_GUARDED
1594 #  else
1595 #    define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
1596 #  endif
1597 #else
1598 #  define my_vsnprintf Perl_my_vsnprintf
1599 #  define PERL_MY_VSNPRINTF_GUARDED
1600 #endif
1601
1602 /* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1603  * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1604  * the result of my_snprintf() or my_vsnprintf().  (No, you should not
1605  * completely ignore it: otherwise you cannot know whether your output
1606  * was too long.)
1607  *
1608  * int len = my_sprintf(buf, max, ...);
1609  * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1610  *
1611  * The trick is that in certain platforms [a] the my_sprintf() already
1612  * contains the sanity check, while in certain platforms [b] it needs
1613  * to be done as a separate step.  The POST_GUARD is that step-- in [a]
1614  * platforms the POST_GUARD actually does nothing since the check has
1615  * already been done.  Watch out for the max being the same in both calls.
1616  *
1617  * If you actually use the snprintf/vsnprintf return value already,
1618  * you assumedly are checking its validity somehow.  But you can
1619  * insert the POST_GUARD() also in that case. */
1620
1621 #ifndef PERL_MY_SNPRINTF_GUARDED
1622 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1623 #else
1624 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1625 #endif
1626
1627 #ifndef  PERL_MY_VSNPRINTF_GUARDED
1628 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
1629 #else
1630 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1631 #endif
1632
1633 #ifdef HAS_STRLCAT
1634 #  define my_strlcat    strlcat
1635 #else
1636 #  define my_strlcat    Perl_my_strlcat
1637 #endif
1638
1639 #ifdef HAS_STRLCPY
1640 #  define my_strlcpy    strlcpy
1641 #else
1642 #  define my_strlcpy    Perl_my_strlcpy
1643 #endif
1644
1645 /*
1646     The IV type is supposed to be long enough to hold any integral
1647     value or a pointer.
1648     --Andy Dougherty    August 1996
1649 */
1650
1651 typedef IVTYPE IV;
1652 typedef UVTYPE UV;
1653
1654 #if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
1655 #  if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
1656 #    define IV_MAX INT64_MAX
1657 #    define IV_MIN INT64_MIN
1658 #    define UV_MAX UINT64_MAX
1659 #    ifndef UINT64_MIN
1660 #      define UINT64_MIN 0
1661 #    endif
1662 #    define UV_MIN UINT64_MIN
1663 #  else
1664 #    define IV_MAX PERL_QUAD_MAX
1665 #    define IV_MIN PERL_QUAD_MIN
1666 #    define UV_MAX PERL_UQUAD_MAX
1667 #    define UV_MIN PERL_UQUAD_MIN
1668 #  endif
1669 #  define IV_IS_QUAD
1670 #  define UV_IS_QUAD
1671 #else
1672 #  if defined(INT32_MAX) && IVSIZE == 4
1673 #    define IV_MAX INT32_MAX
1674 #    define IV_MIN INT32_MIN
1675 #    ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
1676 #        define UV_MAX UINT32_MAX
1677 #    else
1678 #        define UV_MAX 4294967295U
1679 #    endif
1680 #    ifndef UINT32_MIN
1681 #      define UINT32_MIN 0
1682 #    endif
1683 #    define UV_MIN UINT32_MIN
1684 #  else
1685 #    define IV_MAX PERL_LONG_MAX
1686 #    define IV_MIN PERL_LONG_MIN
1687 #    define UV_MAX PERL_ULONG_MAX
1688 #    define UV_MIN PERL_ULONG_MIN
1689 #  endif
1690 #  if IVSIZE == 8
1691 #    define IV_IS_QUAD
1692 #    define UV_IS_QUAD
1693 #    ifndef HAS_QUAD
1694 #      define HAS_QUAD
1695 #    endif
1696 #  else
1697 #    undef IV_IS_QUAD
1698 #    undef UV_IS_QUAD
1699 #if !defined(PERL_CORE) || defined(USING_MSVC6)
1700 /* We think that removing this decade-old undef this will cause too much
1701    breakage on CPAN for too little gain. (See RT #119753)
1702    However, we do need HAS_QUAD in the core for use by the drand48 code,
1703    but not for Win32 VC6 because it has poor __int64 support. */
1704 #    undef HAS_QUAD
1705 #endif
1706 #  endif
1707 #endif
1708
1709 #define Size_t_MAX (~(Size_t)0)
1710 #define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
1711
1712 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
1713 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
1714
1715 #ifndef NO_PERL_PRESERVE_IVUV
1716 #define PERL_PRESERVE_IVUV      /* We like our integers to stay integers. */
1717 #endif
1718
1719 /*
1720  *  The macros INT2PTR and NUM2PTR are (despite their names)
1721  *  bi-directional: they will convert int/float to or from pointers.
1722  *  However the conversion to int/float are named explicitly:
1723  *  PTR2IV, PTR2UV, PTR2NV.
1724  *
1725  *  For int conversions we do not need two casts if pointers are
1726  *  the same size as IV and UV.   Otherwise we need an explicit
1727  *  cast (PTRV) to avoid compiler warnings.
1728  */
1729 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1730 #  define PTRV                  UV
1731 #  define INT2PTR(any,d)        (any)(d)
1732 #else
1733 #  if PTRSIZE == LONGSIZE
1734 #    define PTRV                unsigned long
1735 #    define PTR2ul(p)           (unsigned long)(p)
1736 #  else
1737 #    define PTRV                unsigned
1738 #  endif
1739 #endif
1740
1741 #ifndef INT2PTR
1742 #  define INT2PTR(any,d)        (any)(PTRV)(d)
1743 #endif
1744
1745 #ifndef PTR2ul
1746 #  define PTR2ul(p)     INT2PTR(unsigned long,p)
1747 #endif
1748
1749 #define NUM2PTR(any,d)  (any)(PTRV)(d)
1750 #define PTR2IV(p)       INT2PTR(IV,p)
1751 #define PTR2UV(p)       INT2PTR(UV,p)
1752 #define PTR2NV(p)       NUM2PTR(NV,p)
1753 #define PTR2nat(p)      (PTRV)(p)       /* pointer to integer of PTRSIZE */
1754
1755 /* According to strict ANSI C89 one cannot freely cast between
1756  * data pointers and function (code) pointers.  There are at least
1757  * two ways around this.  One (used below) is to do two casts,
1758  * first the other pointer to an (unsigned) integer, and then
1759  * the integer to the other pointer.  The other way would be
1760  * to use unions to "overlay" the pointers.  For an example of
1761  * the latter technique, see union dirpu in struct xpvio in sv.h.
1762  * The only feasible use is probably temporarily storing
1763  * function pointers in a data pointer (such as a void pointer). */
1764
1765 #define DPTR2FPTR(t,p) ((t)PTR2nat(p))  /* data pointer to function pointer */
1766 #define FPTR2DPTR(t,p) ((t)PTR2nat(p))  /* function pointer to data pointer */
1767
1768 #ifdef USE_LONG_DOUBLE
1769 #  if LONG_DOUBLESIZE == DOUBLESIZE
1770 #    define LONG_DOUBLE_EQUALS_DOUBLE
1771 #    undef USE_LONG_DOUBLE /* Ouch! */
1772 #  endif
1773 #endif
1774
1775 #ifdef OVR_DBL_DIG
1776 /* Use an overridden DBL_DIG */
1777 # ifdef DBL_DIG
1778 #  undef DBL_DIG
1779 # endif
1780 # define DBL_DIG OVR_DBL_DIG
1781 #else
1782 /* The following is all to get DBL_DIG, in order to pick a nice
1783    default value for printing floating point numbers in Gconvert
1784    (see config.h). (It also has other uses, such as figuring out if
1785    a given precision of printing can be done with a double instead of
1786    a long double - Allen).
1787 */
1788 #ifdef I_LIMITS
1789 #include <limits.h>
1790 #endif
1791 #ifdef I_FLOAT
1792 #include <float.h>
1793 #endif
1794 #ifndef HAS_DBL_DIG
1795 #define DBL_DIG 15   /* A guess that works lots of places */
1796 #endif
1797 #endif
1798
1799 #ifdef OVR_LDBL_DIG
1800 /* Use an overridden LDBL_DIG */
1801 # ifdef LDBL_DIG
1802 #  undef LDBL_DIG
1803 # endif
1804 # define LDBL_DIG OVR_LDBL_DIG
1805 #else
1806 /* The following is all to get LDBL_DIG, in order to pick a nice
1807    default value for printing floating point numbers in Gconvert.
1808    (see config.h)
1809 */
1810 # ifdef I_LIMITS
1811 #   include <limits.h>
1812 # endif
1813 # ifdef I_FLOAT
1814 #  include <float.h>
1815 # endif
1816 # ifndef HAS_LDBL_DIG
1817 #  if LONG_DOUBLESIZE == 10
1818 #   define LDBL_DIG 18 /* assume IEEE */
1819 #  else
1820 #   if LONG_DOUBLESIZE == 12
1821 #    define LDBL_DIG 18 /* gcc? */
1822 #   else
1823 #    if LONG_DOUBLESIZE == 16
1824 #     define LDBL_DIG 33 /* assume IEEE */
1825 #    else
1826 #     if LONG_DOUBLESIZE == DOUBLESIZE
1827 #      define LDBL_DIG DBL_DIG /* bummer */
1828 #     endif
1829 #    endif
1830 #   endif
1831 #  endif
1832 # endif
1833 #endif
1834
1835 /*
1836  * This is for making sure we have a good DBL_MAX value, if possible,
1837  * either for usage as NV_MAX or for usage in figuring out if we can
1838  * fit a given long double into a double, if bug-fixing makes it
1839  * necessary to do so. - Allen <allens@cpan.org>
1840  */
1841
1842 #ifdef I_LIMITS
1843 #  include <limits.h>
1844 #endif
1845
1846 #ifdef I_VALUES
1847 #  if !(defined(DBL_MIN) && defined(DBL_MAX) && defined(I_LIMITS))
1848 #    include <values.h>
1849 #    if defined(MAXDOUBLE) && !defined(DBL_MAX)
1850 #      define DBL_MAX MAXDOUBLE
1851 #    endif
1852 #    if defined(MINDOUBLE) && !defined(DBL_MIN)
1853 #      define DBL_MIN MINDOUBLE
1854 #    endif
1855 #  endif
1856 #endif /* defined(I_VALUES) */
1857
1858 typedef NVTYPE NV;
1859
1860 #ifdef I_IEEEFP
1861 #   include <ieeefp.h>
1862 #endif
1863
1864 #ifdef USING_MSVC6
1865 /* VC6 has broken NaN semantics: NaN == NaN returns true instead of false,
1866  * and for example NaN < IV_MIN. */
1867 #  define NAN_COMPARE_BROKEN
1868 #endif
1869 #if defined(__DECC) && defined(__osf__)
1870 /* Also Tru64 cc has broken NaN comparisons. */
1871 #  define NAN_COMPARE_BROKEN
1872 #endif
1873 #if defined(__sgi)
1874 #  define NAN_COMPARE_BROKEN
1875 #endif
1876
1877 #ifdef USE_LONG_DOUBLE
1878 #   ifdef I_SUNMATH
1879 #       include <sunmath.h>
1880 #   endif
1881 #   if defined(LDBL_DIG)
1882 #       define NV_DIG LDBL_DIG
1883 #       ifdef LDBL_MANT_DIG
1884 #           define NV_MANT_DIG LDBL_MANT_DIG
1885 #       endif
1886 #       ifdef LDBL_MIN
1887 #           define NV_MIN LDBL_MIN
1888 #       endif
1889 #       ifdef LDBL_MAX
1890 #           define NV_MAX LDBL_MAX
1891 #       endif
1892 #       ifdef LDBL_MIN_EXP
1893 #           define NV_MIN_EXP LDBL_MIN_EXP
1894 #       endif
1895 #       ifdef LDBL_MAX_EXP
1896 #           define NV_MAX_EXP LDBL_MAX_EXP
1897 #       endif
1898 #       ifdef LDBL_MIN_10_EXP
1899 #           define NV_MIN_10_EXP LDBL_MIN_10_EXP
1900 #       endif
1901 #       ifdef LDBL_MAX_10_EXP
1902 #           define NV_MAX_10_EXP LDBL_MAX_10_EXP
1903 #       endif
1904 #       ifdef LDBL_EPSILON
1905 #           define NV_EPSILON LDBL_EPSILON
1906 #       endif
1907 #       ifdef LDBL_MAX
1908 #           define NV_MAX LDBL_MAX
1909 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
1910 #       else
1911 #           ifdef HUGE_VALL
1912 #               define NV_MAX HUGE_VALL
1913 #           endif
1914 #       endif
1915 #   endif
1916 #   if defined(HAS_SQRTL)
1917 #       define Perl_acos acosl
1918 #       define Perl_asin asinl
1919 #       define Perl_atan atanl
1920 #       define Perl_atan2 atan2l
1921 #       define Perl_ceil ceill
1922 #       define Perl_cos cosl
1923 #       define Perl_cosh coshl
1924 #       define Perl_exp expl
1925 /* no Perl_fabs, but there's PERL_ABS */
1926 #       define Perl_floor floorl
1927 #       define Perl_fmod fmodl
1928 #       define Perl_log logl
1929 #       define Perl_log10 log10l
1930 #       define Perl_pow powl
1931 #       define Perl_sin sinl
1932 #       define Perl_sinh sinhl
1933 #       define Perl_sqrt sqrtl
1934 #       define Perl_tan tanl
1935 #       define Perl_tanh tanhl
1936 #   endif
1937 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
1938 #   ifndef Perl_modf
1939 #       ifdef HAS_MODFL
1940 #           define Perl_modf(x,y) modfl(x,y)
1941 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
1942    prototype in <math.h> */
1943 #           ifndef HAS_MODFL_PROTO
1944 EXTERN_C long double modfl(long double, long double *);
1945 #           endif
1946 #       elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
1947         extern long double Perl_my_modfl(long double x, long double *ip);
1948 #           define Perl_modf(x,y) Perl_my_modfl(x,y)
1949 #       endif
1950 #   endif
1951 #   ifndef Perl_frexp
1952 #       ifdef HAS_FREXPL
1953 #           define Perl_frexp(x,y) frexpl(x,y)
1954 #       else
1955 #           if defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
1956 extern long double Perl_my_frexpl(long double x, int *e);
1957 #               define Perl_frexp(x,y) Perl_my_frexpl(x,y)
1958 #           endif
1959 #       endif
1960 #   endif
1961 #   ifndef Perl_ldexp
1962 #       ifdef HAS_LDEXPL
1963 #           define Perl_ldexp(x, y) ldexpl(x,y)
1964 #       else
1965 #           if defined(HAS_SCALBNL) && FLT_RADIX == 2
1966 #               define Perl_ldexp(x,y) scalbnl(x,y)
1967 #           endif
1968 #       endif
1969 #   endif
1970 #   ifndef Perl_isnan
1971 #       if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
1972 #           define Perl_isnan(x) isnanl(x)
1973 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
1974 #           define Perl_isnan(x) isnan(x)
1975 #       endif
1976 #   endif
1977 #   ifndef Perl_isinf
1978 #       if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
1979 #           define Perl_isinf(x) isinfl(x)
1980 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
1981 #           define Perl_isinf(x) isinf(x)
1982 #       elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
1983 #           define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
1984 #       endif
1985 #   endif
1986 #   ifndef Perl_isfinite
1987 #       define Perl_isfinite(x) Perl_isfinitel(x)
1988 #   endif
1989 #elif defined(USE_QUADMATH) && defined(I_QUADMATH)
1990 #   include <quadmath.h>
1991 #   define NV_DIG FLT128_DIG
1992 #   define NV_MANT_DIG FLT128_MANT_DIG
1993 #   define NV_MIN FLT128_MIN
1994 #   define NV_MAX FLT128_MAX
1995 #   define NV_MIN_EXP FLT128_MIN_EXP
1996 #   define NV_MAX_EXP FLT128_MAX_EXP
1997 #   define NV_EPSILON FLT128_EPSILON
1998 #   define NV_MIN_10_EXP FLT128_MIN_10_EXP
1999 #   define NV_MAX_10_EXP FLT128_MAX_10_EXP
2000 #   define Perl_acos acosq
2001 #   define Perl_asin asinq
2002 #   define Perl_atan atanq
2003 #   define Perl_atan2 atan2q
2004 #   define Perl_ceil ceilq
2005 #   define Perl_cos cosq
2006 #   define Perl_cosh coshq
2007 #   define Perl_exp expq
2008 /* no Perl_fabs, but there's PERL_ABS */
2009 #   define Perl_floor floorq
2010 #   define Perl_fmod fmodq
2011 #   define Perl_log logq
2012 #   define Perl_log10 log10q
2013 #   define Perl_pow powq
2014 #   define Perl_sin sinq
2015 #   define Perl_sinh sinhq
2016 #   define Perl_sqrt sqrtq
2017 #   define Perl_tan tanq
2018 #   define Perl_tanh tanhq
2019 #   define Perl_modf(x,y) modfq(x,y)
2020 #   define Perl_frexp(x,y) frexpq(x,y)
2021 #   define Perl_ldexp(x, y) ldexpq(x,y)
2022 #   define Perl_isinf(x) isinfq(x)
2023 #   define Perl_isnan(x) isnanq(x)
2024 #   define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
2025 #   define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
2026 #   define Perl_fp_class_inf(x)    (Perl_fp_class(x) == 3)
2027 #   define Perl_fp_class_nan(x)    (Perl_fp_class(x) == 4)
2028 #   define Perl_fp_class_norm(x)   (Perl_fp_class(x) == 1)
2029 #   define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
2030 #   define Perl_fp_class_zero(x)   (Perl_fp_class(x) == 0)
2031 #else
2032 #   define NV_DIG DBL_DIG
2033 #   ifdef DBL_MANT_DIG
2034 #       define NV_MANT_DIG DBL_MANT_DIG
2035 #   endif
2036 #   ifdef DBL_MIN
2037 #       define NV_MIN DBL_MIN
2038 #   endif
2039 #   ifdef DBL_MAX
2040 #       define NV_MAX DBL_MAX
2041 #   endif
2042 #   ifdef DBL_MIN_EXP
2043 #       define NV_MIN_EXP DBL_MIN_EXP
2044 #   endif
2045 #   ifdef DBL_MAX_EXP
2046 #       define NV_MAX_EXP DBL_MAX_EXP
2047 #   endif
2048 #   ifdef DBL_MIN_10_EXP
2049 #       define NV_MIN_10_EXP DBL_MIN_10_EXP
2050 #   endif
2051 #   ifdef DBL_MAX_10_EXP
2052 #       define NV_MAX_10_EXP DBL_MAX_10_EXP
2053 #   endif
2054 #   ifdef DBL_EPSILON
2055 #       define NV_EPSILON DBL_EPSILON
2056 #   endif
2057 #   ifdef DBL_MAX               /* XXX Does DBL_MAX imply having DBL_MIN? */
2058 #       define NV_MAX DBL_MAX
2059 #       define NV_MIN DBL_MIN
2060 #   else
2061 #       ifdef HUGE_VAL
2062 #           define NV_MAX HUGE_VAL
2063 #       endif
2064 #   endif
2065
2066 /* These math interfaces are C89. */
2067 #   define Perl_acos acos
2068 #   define Perl_asin asin
2069 #   define Perl_atan atan
2070 #   define Perl_atan2 atan2
2071 #   define Perl_ceil ceil
2072 #   define Perl_cos cos
2073 #   define Perl_cosh cosh
2074 #   define Perl_exp exp
2075 /* no Perl_fabs, but there's PERL_ABS */
2076 #   define Perl_floor floor
2077 #   define Perl_fmod fmod
2078 #   define Perl_log log
2079 #   define Perl_log10 log10
2080 #   define Perl_pow pow
2081 #   define Perl_sin sin
2082 #   define Perl_sinh sinh
2083 #   define Perl_sqrt sqrt
2084 #   define Perl_tan tan
2085 #   define Perl_tanh tanh
2086
2087 #   define Perl_modf(x,y) modf(x,y)
2088 #   define Perl_frexp(x,y) frexp(x,y)
2089 #   define Perl_ldexp(x,y) ldexp(x,y)
2090
2091 #   ifndef Perl_isnan
2092 #       ifdef HAS_ISNAN
2093 #           define Perl_isnan(x) isnan(x)
2094 #       endif
2095 #   endif
2096 #   ifndef Perl_isinf
2097 #       if defined(HAS_ISINF)
2098 #           define Perl_isinf(x) isinf(x)
2099 #       elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2100 #           define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
2101 #       endif
2102 #   endif
2103 #   ifndef Perl_isfinite
2104 #     ifdef HAS_ISFINITE
2105 #       define Perl_isfinite(x) isfinite(x)
2106 #     elif defined(HAS_FINITE)
2107 #       define Perl_isfinite(x) finite(x)
2108 #     endif
2109 #   endif
2110 #endif
2111
2112 /* fpclassify(): C99.  It is supposed to be a macro that switches on
2113 * the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
2114 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2115 #    include <math.h>
2116 #    if defined(FP_INFINITE) && defined(FP_NAN)
2117 #        define Perl_fp_class(x)        fpclassify(x)
2118 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
2119 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
2120 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
2121 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2122 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
2123 #    elif defined(FP_PLUS_INF) && defined(FP_QNAN)
2124 /* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
2125  * actually not the C99 fpclassify, with its own set of return defines. */
2126 #        define Perl_fp_class(x)        fpclassify(x)
2127 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PLUS_INF)
2128 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_MINUS_INF)
2129 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
2130 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
2131 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PLUS_NORM)
2132 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_MINUS_NORM)
2133 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PLUS_DENORM)
2134 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_MINUS_DENORM)
2135 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PLUS_ZERO)
2136 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_MINUS_ZERO)
2137 #    else
2138 #        undef Perl_fp_class /* Unknown set of defines */
2139 #    endif
2140 #endif
2141
2142 /* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
2143  * are identical to the C99 fpclassify(). */
2144 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
2145 #    include <math.h>
2146 #    ifdef __VMS
2147      /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
2148 #        include <fp.h>
2149      /* oh, and the isnormal macro has a typo in it! */
2150 #    undef isnormal
2151 #    define isnormal(x) Perl_fp_class_norm(x)
2152 #    endif
2153 #    if defined(FP_INFINITE) && defined(FP_NAN)
2154 #        define Perl_fp_class(x)        fp_classify(x)
2155 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
2156 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
2157 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
2158 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2159 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
2160 #    else
2161 #        undef Perl_fp_class /* Unknown set of defines */
2162 #    endif
2163 #endif
2164
2165 /* Feel free to check with me for the SGI manpages, SGI testing,
2166  * etcetera, if you want to try getting this to work with IRIX.
2167  *
2168  * - Allen <allens@cpan.org> */
2169
2170 /* fpclass(): SysV, at least Solaris and some versions of IRIX. */
2171 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
2172 /* Solaris and IRIX have fpclass/fpclassl, but they are using
2173  * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2174  * Define some symbols also as cpp symbols so we can detect them. */
2175 #    if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
2176 #     define FP_PINF FP_PINF
2177 #     define FP_QNAN FP_QNAN
2178 #    endif
2179 #    include <math.h>
2180 #    ifdef I_IEEFP
2181 #        include <ieeefp.h>
2182 #    endif
2183 #    ifdef I_FP
2184 #        include <fp.h>
2185 #    endif
2186 #    if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
2187 #        define Perl_fp_class(x)        fpclassl(x)
2188 #    else
2189 #        define Perl_fp_class(x)        fpclass(x)
2190 #    endif
2191 #    if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
2192 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_CLASS_SNAN)
2193 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_CLASS_QNAN)
2194 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_CLASS_NINF)
2195 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_CLASS_PINF)
2196 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_CLASS_NNORM)
2197 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_CLASS_PNORM)
2198 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_CLASS_NDENORM)
2199 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_CLASS_PDENORM)
2200 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_CLASS_NZERO)
2201 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_CLASS_PZERO)
2202 #    elif defined(FP_PINF) && defined(FP_QNAN)
2203 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
2204 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
2205 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_NINF)
2206 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PINF)
2207 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_NNORM)
2208 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PNORM)
2209 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_NDENORM)
2210 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PDENORM)
2211 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_NZERO)
2212 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PZERO)
2213 #    else
2214 #        undef Perl_fp_class /* Unknown set of defines */
2215 #    endif
2216 #endif
2217
2218 /* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2219 #if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
2220 #    include <math.h>
2221 #    if !defined(FP_SNAN) && defined(I_FP_CLASS)
2222 #        include <fp_class.h>
2223 #    endif
2224 #    if defined(FP_POS_INF) && defined(FP_QNAN)
2225 #        ifdef __sgi /* XXX Configure test instead */
2226 #            ifdef USE_LONG_DOUBLE
2227 #                define Perl_fp_class(x)        fp_class_l(x)
2228 #            else
2229 #                define Perl_fp_class(x)        fp_class_d(x)
2230 #            endif
2231 #        else
2232 #            if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2233 #                define Perl_fp_class(x)        fp_classl(x)
2234 #            else
2235 #                define Perl_fp_class(x)        fp_class(x)
2236 #            endif
2237 #        endif
2238 #        if defined(FP_POS_INF) && defined(FP_QNAN)
2239 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_SNAN)
2240 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_QNAN)
2241 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_NEG_INF)
2242 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_POS_INF)
2243 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_NEG_NORM)
2244 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_POS_NORM)
2245 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_NEG_DENORM)
2246 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_POS_DENORM)
2247 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_NEG_ZERO)
2248 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_POS_ZERO)
2249 #        else
2250 #            undef Perl_fp_class /* Unknown set of defines */
2251 #        endif
2252 #    endif
2253 #endif
2254
2255 /* class(), _class(): Legacy: AIX. */
2256 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2257 #    include <math.h>
2258 #    if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2259 #        ifndef _cplusplus
2260 #            define Perl_fp_class(x)    class(x)
2261 #        else
2262 #            define Perl_fp_class(x)    _class(x)
2263 #        endif
2264 #        if defined(FP_PLUS_INF) && defined(FP_NANQ)
2265 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_NANS)
2266 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_NANQ)
2267 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_MINUS_INF)
2268 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_PLUS_INF)
2269 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_MINUS_NORM)
2270 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_PLUS_NORM)
2271 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_MINUS_DENORM)
2272 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_PLUS_DENORM)
2273 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_MINUS_ZERO)
2274 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_PLUS_ZERO)
2275 #        else
2276 #            undef Perl_fp_class /* Unknown set of defines */
2277 #        endif
2278 #    endif
2279 #endif
2280
2281 /* Win32: _fpclass(), _isnan(), _finite(). */
2282 #ifdef WIN32
2283 #  ifndef Perl_isnan
2284 #    define Perl_isnan(x) _isnan(x)
2285 #  endif
2286 #  ifndef Perl_isfinite
2287 #    define Perl_isfinite(x) _finite(x)
2288 #  endif
2289 #  ifndef Perl_fp_class_snan
2290 /* No simple way to #define Perl_fp_class because _fpclass()
2291  * returns a set of bits. */
2292 #    define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2293 #    define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
2294 #    define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
2295 #    define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF))
2296 #    define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF))
2297 #    define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2298 #    define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2299 #    define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2300 #    define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2301 #    define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2302 #    define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2303 #    define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2304 #    define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2305 #    define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2306 #    define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2307 #  endif
2308 #endif
2309
2310 #if !defined(Perl_fp_class_inf) && \
2311   defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2312 #  define Perl_fp_class_inf(x) \
2313     (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2314 #endif
2315
2316 #if !defined(Perl_fp_class_nan) && \
2317   defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2318 #  define Perl_fp_class_nan(x) \
2319     (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2320 #endif
2321
2322 #if !defined(Perl_fp_class_zero) && \
2323   defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2324 #  define Perl_fp_class_zero(x) \
2325     (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2326 #endif
2327
2328 #if !defined(Perl_fp_class_norm) && \
2329   defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2330 #  define Perl_fp_class_norm(x) \
2331     (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2332 #endif
2333
2334 #if !defined(Perl_fp_class_denorm) && \
2335   defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2336 #  define Perl_fp_class_denorm(x) \
2337     (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
2338 #endif
2339
2340 #ifdef UNDER_CE
2341 int isnan(double d);
2342 #endif
2343
2344 #ifndef Perl_isnan
2345 #   ifdef Perl_fp_class_nan
2346 #       define Perl_isnan(x) Perl_fp_class_nan(x)
2347 #   else
2348 #       ifdef HAS_UNORDERED
2349 #           define Perl_isnan(x) unordered((x), 0.0)
2350 #       else
2351 #           define Perl_isnan(x) ((x)!=(x))
2352 #       endif
2353 #   endif
2354 #endif
2355
2356 #ifndef Perl_isinf
2357 #   ifdef Perl_fp_class_inf
2358 #       define Perl_isinf(x) Perl_fp_class_inf(x)
2359 #   endif
2360 #endif
2361
2362 #ifndef Perl_isfinite
2363 #   if defined(HAS_ISFINITE) && !defined(isfinite)
2364 #     define Perl_isfinite(x) isfinite((double)(x))
2365 #   elif defined(HAS_FINITE)
2366 #       define Perl_isfinite(x) finite((double)(x))
2367 #   elif defined(Perl_fp_class_finite)
2368 #     define Perl_isfinite(x) Perl_fp_class_finite(x)
2369 #   else
2370 /* For the infinities the multiplication returns nan,
2371  * for the nan the multiplication also returns nan,
2372  * for everything else (that is, finite) zero should be returned. */
2373 #     define Perl_isfinite(x) (((x) * 0) == 0)
2374 #   endif
2375 #endif
2376
2377 #ifndef Perl_isinf
2378 #   if defined(Perl_isfinite) && defined(Perl_isnan)
2379 #       define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2380 #   endif
2381 #endif
2382
2383 /* We need Perl_isfinitel (ends with ell) (if available) even when
2384  * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2385  * needs that. */
2386 #if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2387 /* If isfinite() is a macro and looks like we have C99,
2388  * we assume it's the type-aware C99 isfinite(). */
2389 #    if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
2390 #        define Perl_isfinitel(x) isfinite(x)
2391 #    elif defined(HAS_ISFINITEL)
2392 #        define Perl_isfinitel(x) isfinitel(x)
2393 #    elif defined(HAS_FINITEL)
2394 #        define Perl_isfinitel(x) finitel(x)
2395 #    elif defined(HAS_INFL) && defined(HAS_NANL)
2396 #        define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
2397 #    else
2398 #        define Perl_isfinitel(x) ((x) * 0 == 0)  /* See Perl_isfinite. */
2399 #    endif
2400 #endif
2401
2402 /* The default is to use Perl's own atof() implementation (in numeric.c).
2403  * Usually that is the one to use but for some platforms (e.g. UNICOS)
2404  * it is however best to use the native implementation of atof.
2405  * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2406  * Some good tests to try out with either setting are t/base/num.t,
2407  * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2408  * you may need to be using a different function than atof! */
2409
2410 #ifndef USE_PERL_ATOF
2411 #   ifndef _UNICOS
2412 #       define USE_PERL_ATOF
2413 #   endif
2414 #else
2415 #   if USE_PERL_ATOF == 0
2416 #       undef USE_PERL_ATOF
2417 #   endif
2418 #endif
2419
2420 #ifdef USE_PERL_ATOF
2421 #   define Perl_atof(s) Perl_my_atof(s)
2422 #   define Perl_atof2(s, n) Perl_my_atof2(aTHX_ (s), &(n))
2423 #else
2424 #   define Perl_atof(s) (NV)atof(s)
2425 #   define Perl_atof2(s, n) ((n) = atof(s))
2426 #endif
2427
2428 /* Previously these definitions used hardcoded figures.
2429  * It is hoped these formula are more portable, although
2430  * no data one way or another is presently known to me.
2431  * The "PERL_" names are used because these calculated constants
2432  * do not meet the ANSI requirements for LONG_MAX, etc., which
2433  * need to be constants acceptable to #if - kja
2434  *    define PERL_LONG_MAX        2147483647L
2435  *    define PERL_LONG_MIN        (-LONG_MAX - 1)
2436  *    define PERL ULONG_MAX       4294967295L
2437  */
2438
2439 #ifdef I_LIMITS  /* Needed for cast_xxx() functions below. */
2440 #  include <limits.h>
2441 #endif
2442 /* Included values.h above if necessary; still including limits.h down here,
2443  * despite doing above, because math.h might have overridden... XXX - Allen */
2444
2445 /*
2446  * Try to figure out max and min values for the integral types.  THE CORRECT
2447  * SOLUTION TO THIS MESS: ADAPT enquire.c FROM GCC INTO CONFIGURE.  The
2448  * following hacks are used if neither limits.h or values.h provide them:
2449  * U<TYPE>_MAX: for types >= int: ~(unsigned TYPE)0
2450  *              for types <  int:  (unsigned TYPE)~(unsigned)0
2451  *      The argument to ~ must be unsigned so that later signed->unsigned
2452  *      conversion can't modify the value's bit pattern (e.g. -0 -> +0),
2453  *      and it must not be smaller than int because ~ does integral promotion.
2454  * <type>_MAX: (<type>) (U<type>_MAX >> 1)
2455  * <type>_MIN: -<type>_MAX - <is_twos_complement_architecture: (3 & -1) == 3>.
2456  *      The latter is a hack which happens to work on some machines but
2457  *      does *not* catch any random system, or things like integer types
2458  *      with NaN if that is possible.
2459  *
2460  * All of the types are explicitly cast to prevent accidental loss of
2461  * numeric range, and in the hope that they will be less likely to confuse
2462  * over-eager optimizers.
2463  *
2464  */
2465
2466 #define PERL_UCHAR_MIN ((unsigned char)0)
2467
2468 #ifdef UCHAR_MAX
2469 #  define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2470 #else
2471 #  ifdef MAXUCHAR
2472 #    define PERL_UCHAR_MAX ((unsigned char)MAXUCHAR)
2473 #  else
2474 #    define PERL_UCHAR_MAX       ((unsigned char)~(unsigned)0)
2475 #  endif
2476 #endif
2477
2478 /*
2479  * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2480  * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2481  * depending on local options. Until Configure detects this (or at least
2482  * detects whether the "signed" keyword is available) the CHAR ranges
2483  * will not be included. UCHAR functions normally.
2484  *                                                           - kja
2485  */
2486
2487 #define PERL_USHORT_MIN ((unsigned short)0)
2488
2489 #ifdef USHORT_MAX
2490 #  define PERL_USHORT_MAX ((unsigned short)USHORT_MAX)
2491 #else
2492 #  ifdef MAXUSHORT
2493 #    define PERL_USHORT_MAX ((unsigned short)MAXUSHORT)
2494 #  else
2495 #    ifdef USHRT_MAX
2496 #      define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2497 #    else
2498 #      define PERL_USHORT_MAX       ((unsigned short)~(unsigned)0)
2499 #    endif
2500 #  endif
2501 #endif
2502
2503 #ifdef SHORT_MAX
2504 #  define PERL_SHORT_MAX ((short)SHORT_MAX)
2505 #else
2506 #  ifdef MAXSHORT    /* Often used in <values.h> */
2507 #    define PERL_SHORT_MAX ((short)MAXSHORT)
2508 #  else
2509 #    ifdef SHRT_MAX
2510 #      define PERL_SHORT_MAX ((short)SHRT_MAX)
2511 #    else
2512 #      define PERL_SHORT_MAX      ((short) (PERL_USHORT_MAX >> 1))
2513 #    endif
2514 #  endif
2515 #endif
2516
2517 #ifdef SHORT_MIN
2518 #  define PERL_SHORT_MIN ((short)SHORT_MIN)
2519 #else
2520 #  ifdef MINSHORT
2521 #    define PERL_SHORT_MIN ((short)MINSHORT)
2522 #  else
2523 #    ifdef SHRT_MIN
2524 #      define PERL_SHORT_MIN ((short)SHRT_MIN)
2525 #    else
2526 #      define PERL_SHORT_MIN        (-PERL_SHORT_MAX - ((3 & -1) == 3))
2527 #    endif
2528 #  endif
2529 #endif
2530
2531 #ifdef UINT_MAX
2532 #  define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2533 #else
2534 #  ifdef MAXUINT
2535 #    define PERL_UINT_MAX ((unsigned int)MAXUINT)
2536 #  else
2537 #    define PERL_UINT_MAX       (~(unsigned int)0)
2538 #  endif
2539 #endif
2540
2541 #define PERL_UINT_MIN ((unsigned int)0)
2542
2543 #ifdef INT_MAX
2544 #  define PERL_INT_MAX ((int)INT_MAX)
2545 #else
2546 #  ifdef MAXINT    /* Often used in <values.h> */
2547 #    define PERL_INT_MAX ((int)MAXINT)
2548 #  else
2549 #    define PERL_INT_MAX        ((int)(PERL_UINT_MAX >> 1))
2550 #  endif
2551 #endif
2552
2553 #ifdef INT_MIN
2554 #  define PERL_INT_MIN ((int)INT_MIN)
2555 #else
2556 #  ifdef MININT
2557 #    define PERL_INT_MIN ((int)MININT)
2558 #  else
2559 #    define PERL_INT_MIN        (-PERL_INT_MAX - ((3 & -1) == 3))
2560 #  endif
2561 #endif
2562
2563 #ifdef ULONG_MAX
2564 #  define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2565 #else
2566 #  ifdef MAXULONG
2567 #    define PERL_ULONG_MAX ((unsigned long)MAXULONG)
2568 #  else
2569 #    define PERL_ULONG_MAX       (~(unsigned long)0)
2570 #  endif
2571 #endif
2572
2573 #define PERL_ULONG_MIN ((unsigned long)0L)
2574
2575 #ifdef LONG_MAX
2576 #  define PERL_LONG_MAX ((long)LONG_MAX)
2577 #else
2578 #  ifdef MAXLONG    /* Often used in <values.h> */
2579 #    define PERL_LONG_MAX ((long)MAXLONG)
2580 #  else
2581 #    define PERL_LONG_MAX        ((long) (PERL_ULONG_MAX >> 1))
2582 #  endif
2583 #endif
2584
2585 #ifdef LONG_MIN
2586 #  define PERL_LONG_MIN ((long)LONG_MIN)
2587 #else
2588 #  ifdef MINLONG
2589 #    define PERL_LONG_MIN ((long)MINLONG)
2590 #  else
2591 #    define PERL_LONG_MIN        (-PERL_LONG_MAX - ((3 & -1) == 3))
2592 #  endif
2593 #endif
2594
2595 #ifdef UV_IS_QUAD
2596
2597 #    define PERL_UQUAD_MAX      (~(UV)0)
2598 #    define PERL_UQUAD_MIN      ((UV)0)
2599 #    define PERL_QUAD_MAX       ((IV) (PERL_UQUAD_MAX >> 1))
2600 #    define PERL_QUAD_MIN       (-PERL_QUAD_MAX - ((3 & -1) == 3))
2601
2602 #endif
2603
2604 typedef MEM_SIZE STRLEN;
2605
2606 typedef struct op OP;
2607 typedef struct cop COP;
2608 typedef struct unop UNOP;
2609 typedef struct unop_aux UNOP_AUX;
2610 typedef struct binop BINOP;
2611 typedef struct listop LISTOP;
2612 typedef struct logop LOGOP;
2613 typedef struct pmop PMOP;
2614 typedef struct svop SVOP;
2615 typedef struct padop PADOP;
2616 typedef struct pvop PVOP;
2617 typedef struct loop LOOP;
2618 typedef struct methop METHOP;
2619
2620 #ifdef PERL_CORE
2621 typedef struct opslab OPSLAB;
2622 typedef struct opslot OPSLOT;
2623 #endif
2624
2625 typedef struct block_hooks BHK;
2626 typedef struct custom_op XOP;
2627
2628 typedef struct interpreter PerlInterpreter;
2629
2630 /* SGI's <sys/sema.h> has struct sv */
2631 #if defined(__sgi)
2632 #   define STRUCT_SV perl_sv
2633 #else
2634 #   define STRUCT_SV sv
2635 #endif
2636 typedef struct STRUCT_SV SV;
2637 typedef struct av AV;
2638 typedef struct hv HV;
2639 typedef struct cv CV;
2640 typedef struct p5rx REGEXP;
2641 typedef struct gp GP;
2642 typedef struct gv GV;
2643 typedef struct io IO;
2644 typedef struct context PERL_CONTEXT;
2645 typedef struct block BLOCK;
2646
2647 typedef struct magic MAGIC;
2648 typedef struct xpv XPV;
2649 typedef struct xpviv XPVIV;
2650 typedef struct xpvuv XPVUV;
2651 typedef struct xpvnv XPVNV;
2652 typedef struct xpvmg XPVMG;
2653 typedef struct xpvlv XPVLV;
2654 typedef struct xpvinvlist XINVLIST;
2655 typedef struct xpvav XPVAV;
2656 typedef struct xpvhv XPVHV;
2657 typedef struct xpvgv XPVGV;
2658 typedef struct xpvcv XPVCV;
2659 typedef struct xpvbm XPVBM;
2660 typedef struct xpvfm XPVFM;
2661 typedef struct xpvio XPVIO;
2662 typedef struct mgvtbl MGVTBL;
2663 typedef union any ANY;
2664 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2665 typedef struct ptr_tbl PTR_TBL_t;
2666 typedef struct clone_params CLONE_PARAMS;
2667
2668 /* a pad is currently just an AV; but that might change,
2669  * so hide the type.  */
2670 typedef struct padlist PADLIST;
2671 typedef AV PAD;
2672 typedef struct padnamelist PADNAMELIST;
2673 typedef struct padname PADNAME;
2674
2675 /* enable PERL_OP_PARENT by default */
2676 #if !defined(PERL_OP_PARENT) && !defined(PERL_NO_OP_PARENT)
2677 #  define PERL_OP_PARENT
2678 #endif
2679
2680 /* enable PERL_COPY_ON_WRITE by default */
2681 #if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2682 #  define PERL_COPY_ON_WRITE
2683 #endif
2684
2685 #ifdef PERL_COPY_ON_WRITE
2686 #  define PERL_ANY_COW
2687 #else
2688 # define PERL_SAWAMPERSAND
2689 #endif
2690
2691 #if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2692 # error PERL_DEBUG_READONLY_OPS only works with ithreads
2693 #endif
2694
2695 #include "handy.h"
2696 #include "charclass_invlists.h"
2697
2698 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2699 #   if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2700 #       define USE_64_BIT_RAWIO /* implicit */
2701 #   endif
2702 #endif
2703
2704 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2705  * fseeko/ftello if possible.  Don't go #defining ftell to ftello yourself,
2706  * however, because operating systems like to do that themself. */
2707 #ifndef FSEEKSIZE
2708 #   ifdef HAS_FSEEKO
2709 #       define FSEEKSIZE LSEEKSIZE
2710 #   else
2711 #       define FSEEKSIZE LONGSIZE
2712 #   endif
2713 #endif
2714
2715 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2716 #   if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2717 #       define USE_64_BIT_STDIO /* implicit */
2718 #   endif
2719 #endif
2720
2721 #ifdef USE_64_BIT_RAWIO
2722 #   ifdef HAS_OFF64_T
2723 #       undef Off_t
2724 #       define Off_t off64_t
2725 #       undef LSEEKSIZE
2726 #       define LSEEKSIZE 8
2727 #   endif
2728 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2729  * will trigger defines like the ones below.  Some 64-bit environments,
2730  * however, do not.  Therefore we have to explicitly mix and match. */
2731 #   if defined(USE_OPEN64)
2732 #       define open open64
2733 #   endif
2734 #   if defined(USE_LSEEK64)
2735 #       define lseek lseek64
2736 #   else
2737 #       if defined(USE_LLSEEK)
2738 #           define lseek llseek
2739 #       endif
2740 #   endif
2741 #   if defined(USE_STAT64)
2742 #       define stat stat64
2743 #   endif
2744 #   if defined(USE_FSTAT64)
2745 #       define fstat fstat64
2746 #   endif
2747 #   if defined(USE_LSTAT64)
2748 #       define lstat lstat64
2749 #   endif
2750 #   if defined(USE_FLOCK64)
2751 #       define flock flock64
2752 #   endif
2753 #   if defined(USE_LOCKF64)
2754 #       define lockf lockf64
2755 #   endif
2756 #   if defined(USE_FCNTL64)
2757 #       define fcntl fcntl64
2758 #   endif
2759 #   if defined(USE_TRUNCATE64)
2760 #       define truncate truncate64
2761 #   endif
2762 #   if defined(USE_FTRUNCATE64)
2763 #       define ftruncate ftruncate64
2764 #   endif
2765 #endif
2766
2767 #ifdef USE_64_BIT_STDIO
2768 #   ifdef HAS_FPOS64_T
2769 #       undef Fpos_t
2770 #       define Fpos_t fpos64_t
2771 #   endif
2772 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2773  * will trigger defines like the ones below.  Some 64-bit environments,
2774  * however, do not. */
2775 #   if defined(USE_FOPEN64)
2776 #       define fopen fopen64
2777 #   endif
2778 #   if defined(USE_FSEEK64)
2779 #       define fseek fseek64 /* don't do fseeko here, see perlio.c */
2780 #   endif
2781 #   if defined(USE_FTELL64)
2782 #       define ftell ftell64 /* don't do ftello here, see perlio.c */
2783 #   endif
2784 #   if defined(USE_FSETPOS64)
2785 #       define fsetpos fsetpos64
2786 #   endif
2787 #   if defined(USE_FGETPOS64)
2788 #       define fgetpos fgetpos64
2789 #   endif
2790 #   if defined(USE_TMPFILE64)
2791 #       define tmpfile tmpfile64
2792 #   endif
2793 #   if defined(USE_FREOPEN64)
2794 #       define freopen freopen64
2795 #   endif
2796 #endif
2797
2798 #if defined(OS2)
2799 #  include "iperlsys.h"
2800 #endif
2801
2802 #ifdef DOSISH
2803 #   if defined(OS2)
2804 #       include "os2ish.h"
2805 #   else
2806 #       include "dosish.h"
2807 #   endif
2808 #elif defined(VMS)
2809 #   include "vmsish.h"
2810 #elif defined(PLAN9)
2811 #   include "./plan9/plan9ish.h"
2812 #elif defined(__VOS__)
2813 #   ifdef __GNUC__
2814 #     include "./vos/vosish.h"
2815 #   else
2816 #     include "vos/vosish.h"
2817 #   endif
2818 #elif defined(__SYMBIAN32__)
2819 #   include "symbian/symbianish.h"
2820 #elif defined(__HAIKU__)
2821 #   include "haiku/haikuish.h"
2822 #else
2823 #   include "unixish.h"
2824 #endif
2825
2826 #ifdef __amigaos4__
2827 #    include "amigaos.h"
2828 #    undef FD_CLOEXEC /* a lie in AmigaOS */
2829 #endif
2830
2831 /* NSIG logic from Configure --> */
2832 /* Strange style to avoid deeply-nested #if/#else/#endif */
2833 #ifndef NSIG
2834 #  ifdef _NSIG
2835 #    define NSIG (_NSIG)
2836 #  endif
2837 #endif
2838
2839 #ifndef NSIG
2840 #  ifdef SIGMAX
2841 #    define NSIG (SIGMAX+1)
2842 #  endif
2843 #endif
2844
2845 #ifndef NSIG
2846 #  ifdef SIG_MAX
2847 #    define NSIG (SIG_MAX+1)
2848 #  endif
2849 #endif
2850
2851 #ifndef NSIG
2852 #  ifdef _SIG_MAX
2853 #    define NSIG (_SIG_MAX+1)
2854 #  endif
2855 #endif
2856
2857 #ifndef NSIG
2858 #  ifdef MAXSIG
2859 #    define NSIG (MAXSIG+1)
2860 #  endif
2861 #endif
2862
2863 #ifndef NSIG
2864 #  ifdef MAX_SIG
2865 #    define NSIG (MAX_SIG+1)
2866 #  endif
2867 #endif
2868
2869 #ifndef NSIG
2870 #  ifdef SIGARRAYSIZE
2871 #    define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
2872 #  endif
2873 #endif
2874
2875 #ifndef NSIG
2876 #  ifdef _sys_nsig
2877 #    define NSIG (_sys_nsig) /* Solaris 2.5 */
2878 #  endif
2879 #endif
2880
2881 /* Default to some arbitrary number that's big enough to get most
2882    of the common signals.
2883 */
2884 #ifndef NSIG
2885 #    define NSIG 50
2886 #endif
2887 /* <-- NSIG logic from Configure */
2888
2889 #ifndef NO_ENVIRON_ARRAY
2890 #  define USE_ENVIRON_ARRAY
2891 #endif
2892
2893 /*
2894  * initialise to avoid floating-point exceptions from overflow, etc
2895  */
2896 #ifndef PERL_FPU_INIT
2897 #  ifdef HAS_FPSETMASK
2898 #    if HAS_FLOATINGPOINT_H
2899 #      include <floatingpoint.h>
2900 #    endif
2901 /* Some operating systems have this as a macro, which in turn expands to a comma
2902    expression, and the last sub-expression is something that gets calculated,
2903    and then they have the gall to warn that a value computed is not used. Hence
2904    cast to void.  */
2905 #    define PERL_FPU_INIT (void)fpsetmask(0)
2906 #  else
2907 #    if defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2908 #      define PERL_FPU_INIT       PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2909 #      define PERL_FPU_PRE_EXEC   { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2910 #      define PERL_FPU_POST_EXEC    rsignal_restore(SIGFPE, &xfpe); }
2911 #    else
2912 #      define PERL_FPU_INIT
2913
2914 #    endif
2915 #  endif
2916 #endif
2917 #ifndef PERL_FPU_PRE_EXEC
2918 #  define PERL_FPU_PRE_EXEC   {
2919 #  define PERL_FPU_POST_EXEC  }
2920 #endif
2921
2922 /* In Tru64 the cc -ieee enables the IEEE math but disables traps.
2923  * We need to reenable the "invalid" trap because otherwise generation
2924  * of NaN values leaves the IEEE fp flags in bad state, leaving any further
2925  * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
2926 #ifdef __osf__
2927 #  include <machine/fpu.h>
2928 #  define PERL_SYS_FPU_INIT \
2929      STMT_START { \
2930          ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
2931          signal(SIGFPE, SIG_IGN); \
2932      } STMT_END
2933 #endif
2934 /* In IRIX the default for Flush to Zero bit is true,
2935  * which means that results going below the minimum of normal
2936  * floating points go to zero, instead of going denormal/subnormal.
2937  * This is unlike almost any other system running Perl, so let's clear it.
2938  * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
2939  * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
2940  *
2941  * XXX The flush-to-zero behaviour should be a Configure scan.
2942  * To change the behaviour usually requires some system-specific
2943  * incantation, though, like the below. */
2944 #ifdef __sgi
2945 #  include <sys/fpu.h>
2946 #  define PERL_SYS_FPU_INIT \
2947      STMT_START { \
2948          union fpc_csr csr; \
2949          csr.fc_word = get_fpc_csr(); \
2950          csr.fc_struct.flush = 0; \
2951          set_fpc_csr(csr.fc_word); \
2952      } STMT_END
2953 #endif
2954
2955 #ifndef PERL_SYS_FPU_INIT
2956 #  define PERL_SYS_FPU_INIT NOOP
2957 #endif
2958
2959 #ifndef PERL_SYS_INIT3_BODY
2960 #  define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
2961 #endif
2962
2963 /*
2964 =head1 Miscellaneous Functions
2965
2966 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
2967 Provides system-specific tune up of the C runtime environment necessary to
2968 run Perl interpreters.  This should be called only once, before creating
2969 any Perl interpreters.
2970
2971 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
2972 Provides system-specific tune up of the C runtime environment necessary to
2973 run Perl interpreters.  This should be called only once, before creating
2974 any Perl interpreters.
2975
2976 =for apidoc Am|void|PERL_SYS_TERM|
2977 Provides system-specific clean up of the C runtime environment after
2978 running Perl interpreters.  This should be called only once, after
2979 freeing any remaining Perl interpreters.
2980
2981 =cut
2982  */
2983
2984 #define PERL_SYS_INIT(argc, argv)       Perl_sys_init(argc, argv)
2985 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
2986 #define PERL_SYS_TERM()                 Perl_sys_term()
2987
2988 #ifndef PERL_WRITE_MSG_TO_CONSOLE
2989 #  define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
2990 #endif
2991
2992 #ifndef MAXPATHLEN
2993 #  ifdef PATH_MAX
2994 #    ifdef _POSIX_PATH_MAX
2995 #       if PATH_MAX > _POSIX_PATH_MAX
2996 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
2997  * included the null byte or not.  Later amendments of POSIX,
2998  * XPG4, the Austin Group, and the Single UNIX Specification
2999  * all explicitly include the null byte in the PATH_MAX.
3000  * Ditto for _POSIX_PATH_MAX. */
3001 #         define MAXPATHLEN PATH_MAX
3002 #       else
3003 #         define MAXPATHLEN _POSIX_PATH_MAX
3004 #       endif
3005 #    else
3006 #      define MAXPATHLEN (PATH_MAX+1)
3007 #    endif
3008 #  else
3009 #    define MAXPATHLEN 1024     /* Err on the large side. */
3010 #  endif
3011 #endif
3012
3013 /* In case Configure was not used (we are using a "canned config"
3014  * such as Win32, or a cross-compilation setup, for example) try going
3015  * by the gcc major and minor versions.  One useful URL is
3016  * http://www.ohse.de/uwe/articles/gcc-attributes.html,
3017  * but contrary to this information warn_unused_result seems
3018  * not to be in gcc 3.3.5, at least. --jhi
3019  * Also, when building extensions with an installed perl, this allows
3020  * the user to upgrade gcc and get the right attributes, rather than
3021  * relying on the list generated at Configure time.  --AD
3022  * Set these up now otherwise we get confused when some of the <*thread.h>
3023  * includes below indirectly pull in <perlio.h> (which needs to know if we
3024  * have HASATTRIBUTE_FORMAT).
3025  */
3026
3027 #ifndef PERL_MICRO
3028 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
3029 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
3030 #    define HASATTRIBUTE_DEPRECATED
3031 #  endif
3032 #  if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
3033 #    define HASATTRIBUTE_FORMAT
3034 #    if defined __MINGW32__
3035 #      define PRINTF_FORMAT_NULL_OK
3036 #    endif
3037 #  endif
3038 #  if __GNUC__ >= 3 /* 3.0 -> */
3039 #    define HASATTRIBUTE_MALLOC
3040 #  endif
3041 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
3042 #    define HASATTRIBUTE_NONNULL
3043 #  endif
3044 #  if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
3045 #    define HASATTRIBUTE_NORETURN
3046 #  endif
3047 #  if __GNUC__ >= 3 /* gcc 3.0 -> */
3048 #    define HASATTRIBUTE_PURE
3049 #  endif
3050 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
3051 #    define HASATTRIBUTE_UNUSED
3052 #  endif
3053 #  if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
3054 #    define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
3055 #  endif
3056 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
3057 #    define HASATTRIBUTE_WARN_UNUSED_RESULT
3058 #  endif
3059 #endif
3060 #endif /* #ifndef PERL_MICRO */
3061
3062 /* USE_5005THREADS needs to be after unixish.h as <pthread.h> includes
3063  * <sys/signal.h> which defines NSIG - which will stop inclusion of <signal.h>
3064  * this results in many functions being undeclared which bothers C++
3065  * May make sense to have threads after "*ish.h" anyway
3066  */
3067
3068 /* clang Thread Safety Analysis/Annotations/Attributes
3069  * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
3070  *
3071  * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
3072  * Apple XCode hijacks __clang_major__ and __clang_minor__
3073  * (6.1 means really clang 3.6), so needs extra hijinks
3074  * (could probably also test the contents of __apple_build_version__).
3075  */
3076 #if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
3077     defined(__clang__) && \
3078     !defined(PERL_GLOBAL_STRUCT) && \
3079     !defined(PERL_GLOBAL_STRUCT_PRIVATE) && \
3080     !defined(SWIG) && \
3081   ((!defined(__apple_build_version__) &&               \
3082     ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
3083      (__clang_major__ >= 4))) || \
3084    (defined(__apple_build_version__) &&                \
3085     ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
3086      (__clang_major__ >= 7))))
3087 #  define PERL_TSA__(x)   __attribute__((x))
3088 #  define PERL_TSA_ACTIVE
3089 #else
3090 #  define PERL_TSA__(x)   /* No TSA, make TSA attributes no-ops. */
3091 #  undef PERL_TSA_ACTIVE
3092 #endif
3093
3094 /* PERL_TSA_CAPABILITY() is used to annotate typedefs.
3095  * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
3096  */
3097 #define PERL_TSA_CAPABILITY(x) \
3098     PERL_TSA__(capability(x))
3099
3100 /* In the below examples the mutex must be lexically visible, usually
3101  * either as global variables, or as function arguments. */
3102
3103 /* PERL_TSA_GUARDED_BY() is used to annotate global variables.
3104  *
3105  * Foo foo PERL_TSA_GUARDED_BY(mutex);
3106  */
3107 #define PERL_TSA_GUARDED_BY(x) \
3108     PERL_TSA__(guarded_by(x))
3109
3110 /* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
3111  * The data _behind_ the pointer is guarded.
3112  *
3113  * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
3114  */
3115 #define PERL_TSA_PT_GUARDED_BY(x) \
3116     PERL_TSA__(pt_guarded_by(x))
3117
3118 /* PERL_TSA_REQUIRES() is used to annotate functions.
3119  * The caller MUST hold the resource when calling the function.
3120  *
3121  * void Foo() PERL_TSA_REQUIRES(mutex);
3122  */
3123 #define PERL_TSA_REQUIRES(x) \
3124     PERL_TSA__(requires_capability(x))
3125
3126 /* PERL_TSA_EXCLUDES() is used to annotate functions.
3127  * The caller MUST NOT hold resource when calling the function.
3128  *
3129  * EXCLUDES should be used when the function first acquires
3130  * the resource and then releases it.  Use to avoid deadlock.
3131  *
3132  * void Foo() PERL_TSA_EXCLUDES(mutex);
3133  */
3134 #define PERL_TSA_EXCLUDES(x) \
3135     PERL_TSA__(locks_excluded(x))
3136
3137 /* PERL_TSA_ACQUIRE() is used to annotate functions.
3138  * The caller MUST NOT hold the resource when calling the function,
3139  * and the function will acquire the resource.
3140  *
3141  * void Foo() PERL_TSA_ACQUIRE(mutex);
3142  */
3143 #define PERL_TSA_ACQUIRE(x) \
3144     PERL_TSA__(acquire_capability(x))
3145
3146 /* PERL_TSA_RELEASE() is used to annotate functions.
3147  * The caller MUST hold the resource when calling the function,
3148  * and the function will release the resource.
3149  *
3150  * void Foo() PERL_TSA_RELEASE(mutex);
3151  */
3152 #define PERL_TSA_RELEASE(x) \
3153     PERL_TSA__(release_capability(x))
3154
3155 /* PERL_TSA_NO_TSA is used to annotate functions.
3156  * Used when being intentionally unsafe, or when the code is too
3157  * complicated for the analysis.  Use sparingly.
3158  *
3159  * void Foo() PERL_TSA_NO_TSA;
3160  */
3161 #define PERL_TSA_NO_TSA \
3162     PERL_TSA__(no_thread_safety_analysis)
3163
3164 /* There are more annotations/attributes available, see the clang
3165  * documentation for details. */
3166
3167 #if defined(USE_ITHREADS)
3168 #  ifdef NETWARE
3169 #   include <nw5thread.h>
3170 #  else
3171 #    ifdef WIN32
3172 #      include <win32thread.h>
3173 #    else
3174 #      ifdef OS2
3175 #        include "os2thread.h"
3176 #      else
3177 #        ifdef I_MACH_CTHREADS
3178 #          include <mach/cthreads.h>
3179 typedef cthread_t       perl_os_thread;
3180 typedef mutex_t         perl_mutex;
3181 typedef condition_t     perl_cond;
3182 typedef void *          perl_key;
3183 #        else /* Posix threads */
3184 #          ifdef I_PTHREAD
3185 #            include <pthread.h>
3186 #          endif
3187 typedef pthread_t       perl_os_thread;
3188 typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
3189 typedef pthread_cond_t  perl_cond;
3190 typedef pthread_key_t   perl_key;
3191 #        endif /* I_MACH_CTHREADS */
3192 #      endif /* OS2 */
3193 #    endif /* WIN32 */
3194 #  endif /* NETWARE */
3195 #endif /* USE_ITHREADS */
3196
3197 #ifdef PERL_TSA_ACTIVE
3198 /* Since most pthread mutex interfaces have not been annotated, we
3199  * need to have these wrappers. The NO_TSA annotation is quite ugly
3200  * but it cannot be avoided in plain C, unlike in C++, where one could
3201  * e.g. use ACQUIRE() with no arg on a mutex lock method.
3202  *
3203  * The bodies of these wrappers are in util.c
3204  *
3205  * TODO: however, some platforms are starting to get these clang
3206  * thread safety annotations for pthreads, for example FreeBSD.
3207  * Do we need a way to a bypass these wrappers? */
3208 EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
3209   PERL_TSA_ACQUIRE(*mutex)
3210   PERL_TSA_NO_TSA;
3211 EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
3212   PERL_TSA_RELEASE(*mutex)
3213   PERL_TSA_NO_TSA;
3214 #endif
3215
3216 #if defined(WIN32)
3217 #  include "win32.h"
3218 #endif
3219
3220 #ifdef NETWARE
3221 #  include "netware.h"
3222 #endif
3223
3224 #define STATUS_UNIX     PL_statusvalue
3225 #ifdef VMS
3226 #   define STATUS_NATIVE        PL_statusvalue_vms
3227 /*
3228  * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
3229  * its contents can not be trusted.  Unfortunately, Perl seems to check
3230  * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
3231  * be updated also.
3232  */
3233 #  include <stsdef.h>
3234 #  include <ssdef.h>
3235 /* Presume this because if VMS changes it, it will require a new
3236  * set of APIs for waiting on children for binary compatibility.
3237  */
3238 #  define child_offset_bits (8)
3239 #  ifndef C_FAC_POSIX
3240 #  define C_FAC_POSIX 0x35A000
3241 #  endif
3242
3243 /*  STATUS_EXIT - validates and returns a NATIVE exit status code for the
3244  * platform from the existing UNIX or Native status values.
3245  */
3246
3247 #   define STATUS_EXIT \
3248         (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
3249            (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
3250
3251
3252 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
3253  * exit code and shifts the UNIX value over the correct number of bits to
3254  * be a child status.  Usually the number of bits is 8, but that could be
3255  * platform dependent.  The NATIVE status code is presumed to have either
3256  * from a child process.
3257  */
3258
3259 /* This is complicated.  The child processes return a true native VMS
3260    status which must be saved.  But there is an assumption in Perl that
3261    the UNIX child status has some relationship to errno values, so
3262    Perl tries to translate it to text in some of the tests.
3263    In order to get the string translation correct, for the error, errno
3264    must be EVMSERR, but that generates a different text message
3265    than what the test programs are expecting.  So an errno value must
3266    be derived from the native status value when an error occurs.
3267    That will hide the true native status message.  With this version of
3268    perl, the true native child status can always be retrieved so that
3269    is not a problem.  But in this case, Pl_statusvalue and errno may
3270    have different values in them.
3271  */
3272
3273 #   define STATUS_NATIVE_CHILD_SET(n) \
3274         STMT_START {                                                    \
3275             I32 evalue = (I32)n;                                        \
3276             if (evalue == EVMSERR) {                                    \
3277               PL_statusvalue_vms = vaxc$errno;                          \
3278               PL_statusvalue = evalue;                                  \
3279             } else {                                                    \
3280               PL_statusvalue_vms = evalue;                              \
3281               if (evalue == -1) {                                       \
3282                 PL_statusvalue = -1;                                    \
3283                 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3284               } else                                                    \
3285                 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1);    \
3286               set_vaxc_errno(evalue);                                   \
3287               if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX)    \
3288                   set_errno(EVMSERR);                                   \
3289               else set_errno(Perl_vms_status_to_unix(evalue, 0));       \
3290               PL_statusvalue = PL_statusvalue << child_offset_bits;     \
3291             }                                                           \
3292         } STMT_END
3293
3294 #   ifdef VMSISH_STATUS
3295 #       define STATUS_CURRENT   (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
3296 #   else
3297 #       define STATUS_CURRENT   STATUS_UNIX
3298 #   endif
3299
3300   /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3301    * the NATIVE status to an equivalent value.  Can not be used to translate
3302    * exit code values as exit code values are not guaranteed to have any
3303    * relationship at all to errno values.
3304    * This is used when Perl is forcing errno to have a specific value.
3305    */
3306 #   define STATUS_UNIX_SET(n)                           \
3307         STMT_START {                                    \
3308             I32 evalue = (I32)n;                        \
3309             PL_statusvalue = evalue;                    \
3310             if (PL_statusvalue != -1) {                 \
3311                 if (PL_statusvalue != EVMSERR) {        \
3312                   PL_statusvalue &= 0xFFFF;             \
3313                   if (MY_POSIX_EXIT)                    \
3314                     PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3315                   else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3316                 }                                       \
3317                 else {                                  \
3318                   PL_statusvalue_vms = vaxc$errno;      \
3319                 }                                       \
3320             }                                           \
3321             else PL_statusvalue_vms = SS$_ABORT;        \
3322             set_vaxc_errno(PL_statusvalue_vms);         \
3323         } STMT_END
3324
3325   /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
3326    * the NATIVE error status based on it.
3327    *
3328    * When in the default mode to comply with the Perl VMS documentation,
3329    * 0 is a success and any other code sets the NATIVE status to a failure
3330    * code of SS$_ABORT.
3331    *
3332    * In the new POSIX EXIT mode, native status will be set so that the
3333    * actual exit code will can be retrieved by the calling program or
3334    * shell.
3335    *
3336    * If the exit code is not clearly a UNIX parent or child exit status,
3337    * it will be passed through as a VMS status.
3338    */
3339
3340 #   define STATUS_UNIX_EXIT_SET(n)                      \
3341         STMT_START {                                    \
3342             I32 evalue = (I32)n;                        \
3343             PL_statusvalue = evalue;                    \
3344             if (MY_POSIX_EXIT) { \
3345               if (evalue <= 0xFF00) {           \
3346                   if (evalue > 0xFF)                    \
3347                     evalue = (evalue >> child_offset_bits) & 0xFF; \
3348                   PL_statusvalue_vms =          \
3349                     (C_FAC_POSIX | (evalue << 3 ) |     \
3350                     ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3351               } else /* forgive them Perl, for they have sinned */ \
3352                 PL_statusvalue_vms = evalue; \
3353             } else { \
3354               if (evalue == 0)                  \
3355                 PL_statusvalue_vms = SS$_NORMAL;        \
3356               else if (evalue <= 0xFF00) \
3357                 PL_statusvalue_vms = SS$_ABORT; \
3358               else { /* forgive them Perl, for they have sinned */ \
3359                   if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3360                   else PL_statusvalue_vms = vaxc$errno; \
3361                   /* And obviously used a VMS status value instead of UNIX */ \
3362                   PL_statusvalue = EVMSERR;             \
3363               } \
3364               set_vaxc_errno(PL_statusvalue_vms);       \
3365             }                                           \
3366         } STMT_END
3367
3368
3369   /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3370    * and sets the NATIVE error status based on it.  This special case
3371    * is needed to maintain compatibility with past VMS behavior.
3372    *
3373    * In the default mode on VMS, this number is passed through as
3374    * both the NATIVE and UNIX status.  Which makes it different
3375    * that the STATUS_UNIX_EXIT_SET.
3376    *
3377    * In the new POSIX EXIT mode, native status will be set so that the
3378    * actual exit code will can be retrieved by the calling program or
3379    * shell.
3380    *
3381    * A POSIX exit code is from 0 to 255.  If the exit code is higher
3382    * than this, it needs to be assumed that it is a VMS exit code and
3383    * passed through.
3384    */
3385
3386 #   define STATUS_EXIT_SET(n)                           \
3387         STMT_START {                                    \
3388             I32 evalue = (I32)n;                        \
3389             PL_statusvalue = evalue;                    \
3390             if (MY_POSIX_EXIT)                          \
3391                 if (evalue > 255) PL_statusvalue_vms = evalue; else {   \
3392                   PL_statusvalue_vms = \
3393                     (C_FAC_POSIX | (evalue << 3 ) |     \
3394                      ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
3395             else                                        \
3396                 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3397             set_vaxc_errno(PL_statusvalue_vms);         \
3398         } STMT_END
3399
3400
3401  /* This macro forces a success status */
3402 #   define STATUS_ALL_SUCCESS   \
3403         (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
3404
3405  /* This macro forces a failure status */
3406 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, \
3407      vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3408         (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3409
3410 #elif defined(__amigaos4__)
3411  /* A somewhat experimental attempt to simulate posix return code values */
3412 #   define STATUS_NATIVE        PL_statusvalue_posix
3413 #   define STATUS_NATIVE_CHILD_SET(n)                      \
3414         STMT_START {                                       \
3415             PL_statusvalue_posix = (n);                    \
3416             if (PL_statusvalue_posix < 0) {                \
3417                 PL_statusvalue = -1;                       \
3418             }                                              \
3419             else {                                         \
3420                 PL_statusvalue = n << 8;                   \
3421             }                                              \
3422         } STMT_END
3423 #   define STATUS_UNIX_SET(n)           \
3424         STMT_START {                    \
3425             PL_statusvalue = (n);               \
3426             if (PL_statusvalue != -1)   \
3427                 PL_statusvalue &= 0xFFFF;       \
3428         } STMT_END
3429 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3430 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3431 #   define STATUS_CURRENT STATUS_UNIX
3432 #   define STATUS_EXIT STATUS_UNIX
3433 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3434 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3435
3436 #else
3437 #   define STATUS_NATIVE        PL_statusvalue_posix
3438 #   if defined(WCOREDUMP)
3439 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3440             STMT_START {                                   \
3441                 PL_statusvalue_posix = (n);                \
3442                 if (PL_statusvalue_posix == -1)            \
3443                     PL_statusvalue = -1;                   \
3444                 else {                                     \
3445                     PL_statusvalue =                       \
3446                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3447                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3448                         (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0);  \
3449                 }                                          \
3450             } STMT_END
3451 #   elif defined(WIFEXITED)
3452 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3453             STMT_START {                                   \
3454                 PL_statusvalue_posix = (n);                \
3455                 if (PL_statusvalue_posix == -1)            \
3456                     PL_statusvalue = -1;                   \
3457                 else {                                     \
3458                     PL_statusvalue =                       \
3459                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3460                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0);  \
3461                 }                                          \
3462             } STMT_END
3463 #   else
3464 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3465             STMT_START {                                   \
3466                 PL_statusvalue_posix = (n);                \
3467                 if (PL_statusvalue_posix == -1)            \
3468                     PL_statusvalue = -1;                   \
3469                 else {                                     \
3470                     PL_statusvalue =                       \
3471                         PL_statusvalue_posix & 0xFFFF;     \
3472                 }                                          \
3473             } STMT_END
3474 #   endif
3475 #   define STATUS_UNIX_SET(n)           \
3476         STMT_START {                    \
3477             PL_statusvalue = (n);               \
3478             if (PL_statusvalue != -1)   \
3479                 PL_statusvalue &= 0xFFFF;       \
3480         } STMT_END
3481 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3482 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3483 #   define STATUS_CURRENT STATUS_UNIX
3484 #   define STATUS_EXIT STATUS_UNIX
3485 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3486 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3487 #endif
3488
3489 /* flags in PL_exit_flags for nature of exit() */
3490 #define PERL_EXIT_EXPECTED      0x01
3491 #define PERL_EXIT_DESTRUCT_END  0x02  /* Run END in perl_destruct */
3492 #define PERL_EXIT_WARN          0x04  /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3493 #define PERL_EXIT_ABORT         0x08  /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3494
3495 #ifndef PERL_CORE
3496 /* format to use for version numbers in file/directory names */
3497 /* XXX move to Configure? */
3498 /* This was only ever used for the current version, and that can be done at
3499    compile time, as PERL_FS_VERSION, so should we just delete it?  */
3500 #  ifndef PERL_FS_VER_FMT
3501 #    define PERL_FS_VER_FMT     "%d.%d.%d"
3502 #  endif
3503 #endif
3504
3505 #ifndef PERL_FS_VERSION
3506 #  define PERL_FS_VERSION       PERL_VERSION_STRING
3507 #endif
3508
3509 /* This defines a way to flush all output buffers.  This may be a
3510  * performance issue, so we allow people to disable it.  Also, if
3511  * we are using stdio, there are broken implementations of fflush(NULL)
3512  * out there, Solaris being the most prominent.
3513  */
3514 #ifndef PERL_FLUSHALL_FOR_CHILD
3515 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3516 #  define PERL_FLUSHALL_FOR_CHILD       PerlIO_flush((PerlIO*)NULL)
3517 # else
3518 #  ifdef FFLUSH_ALL
3519 #   define PERL_FLUSHALL_FOR_CHILD      my_fflush_all()
3520 #  else
3521 #   define PERL_FLUSHALL_FOR_CHILD      NOOP
3522 #  endif
3523 # endif
3524 #endif
3525
3526 #ifndef PERL_WAIT_FOR_CHILDREN
3527 #  define PERL_WAIT_FOR_CHILDREN        NOOP
3528 #endif
3529
3530 /* the traditional thread-unsafe notion of "current interpreter". */
3531 #ifndef PERL_SET_INTERP
3532 #  define PERL_SET_INTERP(i)            (PL_curinterp = (PerlInterpreter*)(i))
3533 #endif
3534
3535 #ifndef PERL_GET_INTERP
3536 #  define PERL_GET_INTERP               (PL_curinterp)
3537 #endif
3538
3539 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3540 #  ifdef MULTIPLICITY
3541 #    define PERL_GET_THX                ((PerlInterpreter *)PERL_GET_CONTEXT)
3542 #  endif
3543 #  define PERL_SET_THX(t)               PERL_SET_CONTEXT(t)
3544 #endif
3545
3546 /*
3547     This replaces the previous %_ "hack" by the "%p" hacks.
3548     All that is required is that the perl source does not
3549     use "%-p" or "%-<number>p" or "%<number>p" formats.
3550     These formats will still work in perl code.
3551     See comments in sv.c for further details.
3552
3553     Robin Barker 2005-07-14
3554
3555     No longer use %1p for VDf = %vd.  RMB 2007-10-19
3556 */
3557
3558 #ifndef SVf_
3559 #  define SVf_(n) "-" STRINGIFY(n) "p"
3560 #endif
3561
3562 #ifndef SVf
3563 #  define SVf "-p"
3564 #endif
3565
3566 #ifndef SVf32
3567 #  define SVf32 SVf_(32)
3568 #endif
3569
3570 #ifndef SVf256
3571 #  define SVf256 SVf_(256)
3572 #endif
3573
3574 #define SVfARG(p) ((void*)(p))
3575
3576 #ifndef HEKf
3577 #  define HEKf "2p"
3578 #endif
3579
3580 /* Not ideal, but we cannot easily include a number in an already-numeric
3581  * format sequence. */
3582 #ifndef HEKf256
3583 #  define HEKf256 "3p"
3584 #endif
3585
3586 #define HEKfARG(p) ((void*)(p))
3587
3588 /* Takes three arguments: is_utf8, length, str */
3589 #ifndef UTF8f
3590 #  define UTF8f "d%" UVuf "%4p"
3591 #endif
3592 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3593
3594 #define PNf UTF8f
3595 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
3596
3597 #ifdef PERL_CORE
3598 /* not used; but needed for backward compatibility with XS code? - RMB */
3599 #  undef UVf
3600 #else
3601 #  ifndef UVf
3602 #    define UVf UVuf
3603 #  endif
3604 #endif
3605
3606 #ifdef HASATTRIBUTE_DEPRECATED
3607 #  define __attribute__deprecated__         __attribute__((deprecated))
3608 #endif
3609 #ifdef HASATTRIBUTE_FORMAT
3610 #  define __attribute__format__(x,y,z)      __attribute__((format(x,y,z)))
3611 #endif
3612 #ifdef HASATTRIBUTE_MALLOC
3613 #  define __attribute__malloc__             __attribute__((__malloc__))
3614 #endif
3615 #ifdef HASATTRIBUTE_NONNULL
3616 #  define __attribute__nonnull__(a)         __attribute__((nonnull(a)))
3617 #endif
3618 #ifdef HASATTRIBUTE_NORETURN
3619 #  define __attribute__noreturn__           __attribute__((noreturn))
3620 #endif
3621 #ifdef HASATTRIBUTE_PURE
3622 #  define __attribute__pure__               __attribute__((pure))
3623 #endif
3624 #ifdef HASATTRIBUTE_UNUSED
3625 #  define __attribute__unused__             __attribute__((unused))
3626 #endif
3627 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
3628 #  define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
3629 #endif
3630
3631 /* If we haven't defined the attributes yet, define them to blank. */
3632 #ifndef __attribute__deprecated__
3633 #  define __attribute__deprecated__
3634 #endif
3635 #ifndef __attribute__format__
3636 #  define __attribute__format__(x,y,z)
3637 #endif
3638 #ifndef __attribute__malloc__
3639 #  define __attribute__malloc__
3640 #endif
3641 #ifndef __attribute__nonnull__
3642 #  define __attribute__nonnull__(a)
3643 #endif
3644 #ifndef __attribute__noreturn__
3645 #  define __attribute__noreturn__
3646 #endif
3647 #ifndef __attribute__pure__
3648 #  define __attribute__pure__
3649 #endif
3650 #ifndef __attribute__unused__
3651 #  define __attribute__unused__
3652 #endif
3653 #ifndef __attribute__warn_unused_result__
3654 #  define __attribute__warn_unused_result__
3655 #endif
3656
3657 #ifdef I_ASSERT
3658 #  if !defined(DEBUGGING) && !defined(NDEBUG)
3659 #    define NDEBUG 1
3660 #  endif
3661 #  include <assert.h>
3662 #endif
3663
3664 /* For functions that are marked as __attribute__noreturn__, it's not
3665    appropriate to call return.  In either case, include the lint directive.
3666  */
3667 #ifdef HASATTRIBUTE_NORETURN
3668 #  define NORETURN_FUNCTION_END NOT_REACHED;
3669 #else
3670 #  define NORETURN_FUNCTION_END NOT_REACHED; return 0
3671 #endif
3672
3673 /* Some OS warn on NULL format to printf */
3674 #ifdef PRINTF_FORMAT_NULL_OK
3675 #  define __attribute__format__null_ok__(x,y,z)  __attribute__format__(x,y,z)
3676 #else
3677 #  define __attribute__format__null_ok__(x,y,z)
3678 #endif
3679
3680 #ifdef HAS_BUILTIN_EXPECT
3681 #  define EXPECT(expr,val)                  __builtin_expect(expr,val)
3682 #else
3683 #  define EXPECT(expr,val)                  (expr)
3684 #endif
3685 #define LIKELY(cond)                        EXPECT(cBOOL(cond),TRUE)
3686 #define UNLIKELY(cond)                      EXPECT(cBOOL(cond),FALSE)
3687 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3688 /* placeholder */
3689 #endif
3690
3691 /* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
3692    time invariants. That is, their argument must be a constant expression that
3693    can be verified by the compiler. This expression can contain anything that's
3694    known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3695    the expression evaluates to 0, compilation fails.
3696    Because they generate no runtime code (i.e.  their use is "free"), they're
3697    always active, even under non-DEBUGGING builds.
3698    STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
3699    file scope (outside of any function).
3700    STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3701    function.
3702 */
3703 #if (defined(static_assert) || (defined(__cplusplus) && __cplusplus >= 201103L)) && (!defined(__IBMC__) || __IBMC__ >= 1210)
3704 /* static_assert is a macro defined in <assert.h> in C11 or a compiler
3705    builtin in C++11.  But IBM XL C V11 does not support _Static_assert, no
3706    matter what <assert.h> says.
3707 */
3708 #  define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
3709 #else
3710 /* We use a bit-field instead of an array because gcc accepts
3711    'typedef char x[n]' where n is not a compile-time constant.
3712    We want to enforce constantness.
3713 */
3714 #  define STATIC_ASSERT_2(COND, SUFFIX) \
3715     typedef struct { \
3716         unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3717     } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3718 #  define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
3719 #  define STATIC_ASSERT_DECL(COND)    STATIC_ASSERT_1(COND, __LINE__)
3720 #endif
3721 /* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3722    error (static_assert is a declaration, and only statements can have labels).
3723 */
3724 #define STATIC_ASSERT_STMT(COND)      do { STATIC_ASSERT_DECL(COND); } while (0)
3725
3726 #ifndef __has_builtin
3727 #  define __has_builtin(x) 0 /* not a clang style compiler */
3728 #endif
3729
3730 /* ASSUME is like assert(), but it has a benefit in a release build. It is a
3731    hint to a compiler about a statement of fact in a function call free
3732    expression, which allows the compiler to generate better machine code.
3733    In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3734    the control path is unreachable. In a for loop, ASSUME can be used to hint
3735    that a loop will run at least X times. ASSUME is based off MSVC's __assume
3736    intrinsic function, see its documents for more details.
3737 */
3738
3739 #ifndef DEBUGGING
3740 #  if __has_builtin(__builtin_unreachable) \
3741      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4) /* 4.5 -> */
3742 #    define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3743 #  elif defined(_MSC_VER)
3744 #    define ASSUME(x) __assume(x)
3745 #  elif defined(__ARMCC_VERSION) /* untested */
3746 #    define ASSUME(x) __promise(x)
3747 #  else
3748 /* a random compiler might define assert to its own special optimization token
3749    so pass it through to C lib as a last resort */
3750 #    define ASSUME(x) assert(x)
3751 #  endif
3752 #else
3753 #  define ASSUME(x) assert(x)
3754 #endif
3755
3756 #if defined(__sun)      /* ASSUME() generates warnings on Solaris */
3757 #  define NOT_REACHED
3758 #else
3759 #  define NOT_REACHED ASSUME(0)
3760 #endif
3761
3762 /* Some unistd.h's give a prototype for pause() even though
3763    HAS_PAUSE ends up undefined.  This causes the #define
3764    below to be rejected by the compiler.  Sigh.
3765 */
3766 #ifdef HAS_PAUSE
3767 #define Pause   pause
3768 #else
3769 #define Pause() sleep((32767<<16)+32767)
3770 #endif
3771
3772 #ifndef IOCPARM_LEN
3773 #   ifdef IOCPARM_MASK
3774         /* on BSDish systems we're safe */
3775 #       define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
3776 #   else
3777 #       if defined(_IOC_SIZE) && defined(__GLIBC__)
3778         /* on Linux systems we're safe; except when we're not [perl #38223] */
3779 #           define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3780 #       else
3781         /* otherwise guess at what's safe */
3782 #           define IOCPARM_LEN(x)       256
3783 #       endif
3784 #   endif
3785 #endif
3786
3787 #if defined(__CYGWIN__)
3788 /* USEMYBINMODE
3789  *   This symbol, if defined, indicates that the program should
3790  *   use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3791  *   that a file is in "binary" mode -- that is, that no translation
3792  *   of bytes occurs on read or write operations.
3793  */
3794 #  define USEMYBINMODE /**/
3795 #  include <io.h> /* for setmode() prototype */
3796 #  define my_binmode(fp, iotype, mode) \
3797             cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
3798 #endif
3799
3800 #ifdef __CYGWIN__
3801 void init_os_extras(void);
3802 #endif
3803
3804 #ifdef UNION_ANY_DEFINITION
3805 UNION_ANY_DEFINITION;
3806 #else
3807 union any {
3808     void*       any_ptr;
3809     SV*         any_sv;
3810     SV**        any_svp;
3811     GV*         any_gv;
3812     AV*         any_av;
3813     HV*         any_hv;
3814     OP*         any_op;
3815     char*       any_pv;
3816     char**      any_pvp;
3817     I32         any_i32;
3818     U32         any_u32;
3819     IV          any_iv;
3820     UV          any_uv;
3821     long        any_long;
3822     bool        any_bool;
3823     void        (*any_dptr) (void*);
3824     void        (*any_dxptr) (pTHX_ void*);
3825 };
3826 #endif
3827
3828 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3829
3830 #define FILTER_READ(idx, sv, len)  filter_read(idx, sv, len)
3831 #define FILTER_DATA(idx) \
3832             (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3833 #define FILTER_ISREADER(idx) \
3834             (PL_parser && PL_parser->rsfp_filters \
3835                 && idx >= AvFILLp(PL_parser->rsfp_filters))
3836 #define PERL_FILTER_EXISTS(i) \
3837             (PL_parser && PL_parser->rsfp_filters \
3838                 && (i) <= av_tindex(PL_parser->rsfp_filters))
3839
3840 #if defined(_AIX) && !defined(_AIX43)
3841 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3842 /* We cannot include <crypt.h> to get the struct crypt_data
3843  * because of setkey prototype problems when threading */
3844 typedef        struct crypt_data {     /* straight from /usr/include/crypt.h */
3845     /* From OSF, Not needed in AIX
3846        char C[28], D[28];
3847     */
3848     char E[48];
3849     char KS[16][48];
3850     char block[66];
3851     char iobuf[16];
3852 } CRYPTD;
3853 #endif /* threading */
3854 #endif /* AIX */
3855
3856 #ifndef PERL_CALLCONV
3857 #  ifdef __cplusplus
3858 #    define PERL_CALLCONV extern "C"
3859 #  else
3860 #    define PERL_CALLCONV
3861 #  endif
3862 #endif
3863 #ifndef PERL_CALLCONV_NO_RET
3864 #    define PERL_CALLCONV_NO_RET PERL_CALLCONV
3865 #endif
3866
3867 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
3868    dont have a noreturn as a declaration specifier
3869 */
3870 #ifndef PERL_STATIC_NO_RET
3871 #  define PERL_STATIC_NO_RET STATIC
3872 #endif
3873 /* PERL_STATIC_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE on
3874    builds that dont have a noreturn as a declaration specifier
3875 */
3876 #ifndef PERL_STATIC_INLINE_NO_RET
3877 #  define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
3878 #endif
3879
3880 #if !defined(OS2)
3881 #  include "iperlsys.h"
3882 #endif
3883
3884 #ifdef __LIBCATAMOUNT__
3885 #undef HAS_PASSWD  /* unixish.h but not unixish enough. */
3886 #undef HAS_GROUP
3887 #define FAKE_BIT_BUCKET
3888 #endif
3889
3890 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3891  * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
3892  * Configure, despite their names being similar to other defines like
3893  * USE_ITHREADS.  Configure in fact knows nothing about the randomised
3894  * hashes.  Therefore to enable/disable the hash randomisation defines
3895  * use the Configure -Accflags=... instead. */
3896 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
3897 #  define USE_HASH_SEED
3898 #endif
3899
3900 #include "perly.h"
3901
3902
3903 /* macros to define bit-fields in structs. */
3904 #ifndef PERL_BITFIELD8
3905 #  define PERL_BITFIELD8 unsigned
3906 #endif
3907 #ifndef PERL_BITFIELD16
3908 #  define PERL_BITFIELD16 unsigned
3909 #endif
3910 #ifndef PERL_BITFIELD32
3911 #  define PERL_BITFIELD32 unsigned
3912 #endif
3913
3914 #include "sv.h"
3915 #include "regexp.h"
3916 #include "util.h"
3917 #include "form.h"
3918 #include "gv.h"
3919 #include "pad.h"
3920 #include "cv.h"
3921 #include "opnames.h"
3922 #include "op.h"
3923 #include "hv.h"
3924 #include "cop.h"
3925 #include "av.h"
3926 #include "mg.h"
3927 #include "scope.h"
3928 #include "warnings.h"
3929 #include "utf8.h"
3930
3931 /* these would be in doio.h if there was such a file */
3932 #define my_stat()  my_stat_flags(SV_GMAGIC)
3933 #define my_lstat() my_lstat_flags(SV_GMAGIC)
3934
3935 /* defined in sv.c, but also used in [ach]v.c */
3936 #undef _XPV_HEAD
3937 #undef _XPVMG_HEAD
3938 #undef _XPVCV_COMMON
3939
3940 #include "parser.h"
3941
3942 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
3943
3944 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3945
3946 /* These have to be predeclared, as they are used in proto.h which is #included
3947  * before their definitions in regcomp.h. */
3948
3949 struct scan_data_t;
3950 typedef struct regnode_charclass regnode_charclass;
3951
3952 struct regnode_charclass_class;
3953
3954 /* A hopefully less confusing name.  The sub-classes are all Posix classes only
3955  * used under /l matching */
3956 typedef struct regnode_charclass_class regnode_charclass_posixl;
3957
3958 typedef struct regnode_ssc regnode_ssc;
3959 typedef struct RExC_state_t RExC_state_t;
3960 struct _reg_trie_data;
3961
3962 #endif
3963
3964 struct ptr_tbl_ent {
3965     struct ptr_tbl_ent*         next;
3966     const void*                 oldval;
3967     void*                       newval;
3968 };
3969
3970 struct ptr_tbl {
3971     struct ptr_tbl_ent**        tbl_ary;
3972     UV                          tbl_max;
3973     UV                          tbl_items;
3974     struct ptr_tbl_arena        *tbl_arena;
3975     struct ptr_tbl_ent          *tbl_arena_next;
3976     struct ptr_tbl_ent          *tbl_arena_end;
3977 };
3978
3979 #if defined(htonl) && !defined(HAS_HTONL)
3980 #define HAS_HTONL
3981 #endif
3982 #if defined(htons) && !defined(HAS_HTONS)
3983 #define HAS_HTONS
3984 #endif
3985 #if defined(ntohl) && !defined(HAS_NTOHL)
3986 #define HAS_NTOHL
3987 #endif
3988 #if defined(ntohs) && !defined(HAS_NTOHS)
3989 #define HAS_NTOHS
3990 #endif
3991 #ifndef HAS_HTONL
3992 #define HAS_HTONS
3993 #define HAS_HTONL
3994 #define HAS_NTOHS
3995 #define HAS_NTOHL
3996 #  if (BYTEORDER & 0xffff) == 0x4321
3997 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
3998    re-order their values. However, to behave identically to the alternative
3999    implementations, they should truncate to the correct size.  */
4000 #    define ntohl(x)    ((x)&0xFFFFFFFF)
4001 #    define htonl(x)    ntohl(x)
4002 #    define ntohs(x)    ((x)&0xFFFF)
4003 #    define htons(x)    ntohs(x)
4004 #  elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
4005
4006 /* Note that we can't straight out declare our own htonl and htons because
4007    the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
4008    to avoid the overhead of initialising the socket subsystem, but the headers
4009    that *declare* the various functions are still seen. If we declare our own
4010    htonl etc they will clash with the declarations in the Win32 headers.  */
4011
4012 PERL_STATIC_INLINE U32
4013 my_swap32(const U32 x) {
4014     return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)
4015         | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
4016 }
4017
4018 PERL_STATIC_INLINE U16
4019 my_swap16(const U16 x) {
4020     return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
4021 }
4022
4023 #    define htonl(x)    my_swap32(x)
4024 #    define ntohl(x)    my_swap32(x)
4025 #    define ntohs(x)    my_swap16(x)
4026 #    define htons(x)    my_swap16(x)
4027 #  else
4028 #    error "Unsupported byteorder"
4029 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
4030    the error message. Please check the value of the macro BYTEORDER, as defined
4031    in config.h. The values of BYTEORDER we expect are
4032
4033             big endian  little endian
4034    32 bit       0x4321  0x1234
4035    64 bit   0x87654321  0x12345678
4036
4037    If you have a system with a different byte order, please see
4038    pod/perlhack.pod for how to submit a patch to add supporting code.
4039 */
4040 #  endif
4041 #endif
4042
4043 /*
4044  * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
4045  * -DWS
4046  */
4047 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
4048 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
4049    re-order their values. However, to behave identically to the alternative
4050    implementations, they should truncate to the correct size.  */
4051 #  define vtohl(x)      ((x)&0xFFFFFFFF)
4052 #  define vtohs(x)      ((x)&0xFFFF)
4053 #  define htovl(x)      vtohl(x)
4054 #  define htovs(x)      vtohs(x)
4055 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
4056 #  define vtohl(x)      ((((x)&0xFF)<<24)       \
4057                         +(((x)>>24)&0xFF)       \
4058                         +(((x)&0x0000FF00)<<8)  \
4059                         +(((x)&0x00FF0000)>>8)  )
4060 #  define vtohs(x)      ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
4061 #  define htovl(x)      vtohl(x)
4062 #  define htovs(x)      vtohs(x)
4063 #else
4064 #  error "Unsupported byteorder"
4065 /* If you have need for current perl on PDP-11 or similar, and can help test
4066    that blead keeps working on a mixed-endian system, then see
4067    pod/perlhack.pod for how to submit patches to things working again.  */
4068 #endif
4069
4070 /* *MAX Plus 1. A floating point value.
4071    Hopefully expressed in a way that dodgy floating point can't mess up.
4072    >> 2 rather than 1, so that value is safely less than I32_MAX after 1
4073    is added to it
4074    May find that some broken compiler will want the value cast to I32.
4075    [after the shift, as signed >> may not be as secure as unsigned >>]
4076 */
4077 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
4078 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
4079 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
4080    0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
4081    may be greater than sizeof(IV), so don't assume that half max UV is max IV.
4082 */
4083 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
4084
4085 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
4086 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
4087 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
4088
4089 /* This may look like unnecessary jumping through hoops, but converting
4090    out of range floating point values to integers *is* undefined behaviour,
4091    and it is starting to bite.
4092 */
4093 #ifndef CAST_INLINE
4094 #define I_32(what) (cast_i32((NV)(what)))
4095 #define U_32(what) (cast_ulong((NV)(what)))
4096 #define I_V(what) (cast_iv((NV)(what)))
4097 #define U_V(what) (cast_uv((NV)(what)))
4098 #else
4099 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
4100                   : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
4101                      : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
4102 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
4103                   : ((n) < U32_MAX_P1 ? (U32) (n) \
4104                      : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
4105 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
4106                   : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
4107                      : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
4108 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
4109                   : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
4110                      : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
4111 #endif
4112
4113 #define U_S(what) ((U16)U_32(what))
4114 #define U_I(what) ((unsigned int)U_32(what))
4115 #define U_L(what) U_32(what)
4116
4117 #ifdef HAS_SIGNBIT
4118 #  define Perl_signbit signbit
4119 #endif
4120
4121 /* These do not care about the fractional part, only about the range. */
4122 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
4123 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
4124
4125 /* Used with UV/IV arguments: */
4126                                         /* XXXX: need to speed it up */
4127 #define CLUMP_2UV(iv)   ((iv) < 0 ? 0 : (UV)(iv))
4128 #define CLUMP_2IV(uv)   ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
4129
4130 #ifndef MAXSYSFD
4131 #   define MAXSYSFD 2
4132 #endif
4133
4134 #ifndef __cplusplus
4135 #if !(defined(WIN32) || defined(UNDER_CE) || defined(SYMBIAN))
4136 Uid_t getuid (void);
4137 Uid_t geteuid (void);
4138 Gid_t getgid (void);
4139 Gid_t getegid (void);
4140 #endif
4141 #endif
4142
4143 #ifndef Perl_debug_log
4144 #  define Perl_debug_log        PerlIO_stderr()
4145 #endif
4146
4147 #ifndef Perl_error_log
4148 #  define Perl_error_log        (PL_stderrgv                    \
4149                                  && isGV(PL_stderrgv)           \
4150                                  && GvIOp(PL_stderrgv)          \
4151                                  && IoOFP(GvIOp(PL_stderrgv))   \
4152                                  ? IoOFP(GvIOp(PL_stderrgv))    \
4153                                  : PerlIO_stderr())
4154 #endif
4155
4156
4157 #define DEBUG_p_FLAG            0x00000001 /*      1 */
4158 #define DEBUG_s_FLAG            0x00000002 /*      2 */
4159 #define DEBUG_l_FLAG            0x00000004 /*      4 */
4160 #define DEBUG_t_FLAG            0x00000008 /*      8 */
4161 #define DEBUG_o_FLAG            0x00000010 /*     16 */
4162 #define DEBUG_c_FLAG            0x00000020 /*     32 */
4163 #define DEBUG_P_FLAG            0x00000040 /*     64 */
4164 #define DEBUG_m_FLAG            0x00000080 /*    128 */
4165 #define DEBUG_f_FLAG            0x00000100 /*    256 */
4166 #define DEBUG_r_FLAG            0x00000200 /*    512 */
4167 #define DEBUG_x_FLAG            0x00000400 /*   1024 */
4168 #define DEBUG_u_FLAG            0x00000800 /*   2048 */
4169 /* U is reserved for Unofficial, exploratory hacking */
4170 #define DEBUG_U_FLAG            0x00001000 /*   4096 */
4171 /* spare                                        8192 */
4172 #define DEBUG_X_FLAG            0x00004000 /*  16384 */
4173 #define DEBUG_D_FLAG            0x00008000 /*  32768 */
4174 #define DEBUG_S_FLAG            0x00010000 /*  65536 */
4175 #define DEBUG_T_FLAG            0x00020000 /* 131072 */
4176 #define DEBUG_R_FLAG            0x00040000 /* 262144 */
4177 #define DEBUG_J_FLAG            0x00080000 /* 524288 */
4178 #define DEBUG_v_FLAG            0x00100000 /*1048576 */
4179 #define DEBUG_C_FLAG            0x00200000 /*2097152 */
4180 #define DEBUG_A_FLAG            0x00400000 /*4194304 */
4181 #define DEBUG_q_FLAG            0x00800000 /*8388608 */
4182 #define DEBUG_M_FLAG            0x01000000 /*16777216*/
4183 #define DEBUG_B_FLAG            0x02000000 /*33554432*/
4184 #define DEBUG_L_FLAG            0x04000000 /*67108864*/
4185 #define DEBUG_i_FLAG            0x08000000 /*134217728*/
4186 #define DEBUG_MASK              0x0FFFEFFF /* mask of all the standard flags */
4187
4188 #define DEBUG_DB_RECURSE_FLAG   0x40000000
4189 #define DEBUG_TOP_FLAG          0x80000000 /* -D was given --> PL_debug |= FLAG */
4190
4191 #  define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
4192 #  define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
4193 #  define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
4194 #  define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
4195 #  define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
4196 #  define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
4197 #  define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
4198 #  define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
4199 #  define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
4200 #  define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
4201 #  define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
4202 #  define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
4203 #  define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
4204 #  define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
4205 #  define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
4206 #  define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
4207 #  define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
4208 #  define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
4209 #  define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
4210 #  define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
4211 #  define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
4212 #  define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
4213 #  define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
4214 #  define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
4215 #  define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
4216 #  define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
4217 #  define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
4218 #  define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
4219 #  define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
4220 #  define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
4221 #  define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
4222
4223 #ifdef DEBUGGING
4224
4225 #  define DEBUG_p_TEST DEBUG_p_TEST_
4226 #  define DEBUG_s_TEST DEBUG_s_TEST_
4227 #  define DEBUG_l_TEST DEBUG_l_TEST_
4228 #  define DEBUG_t_TEST DEBUG_t_TEST_
4229 #  define DEBUG_o_TEST DEBUG_o_TEST_
4230 #  define DEBUG_c_TEST DEBUG_c_TEST_
4231 #  define DEBUG_P_TEST DEBUG_P_TEST_
4232 #  define DEBUG_m_TEST DEBUG_m_TEST_
4233 #  define DEBUG_f_TEST DEBUG_f_TEST_
4234 #  define DEBUG_r_TEST DEBUG_r_TEST_
4235 #  define DEBUG_x_TEST DEBUG_x_TEST_
4236 #  define DEBUG_u_TEST DEBUG_u_TEST_
4237 #  define DEBUG_U_TEST DEBUG_U_TEST_
4238 #  define DEBUG_X_TEST DEBUG_X_TEST_
4239 #  define DEBUG_D_TEST DEBUG_D_TEST_
4240 #  define DEBUG_S_TEST DEBUG_S_TEST_
4241 #  define DEBUG_T_TEST DEBUG_T_TEST_
4242 #  define DEBUG_R_TEST DEBUG_R_TEST_
4243 #  define DEBUG_J_TEST DEBUG_J_TEST_
4244 #  define DEBUG_v_TEST DEBUG_v_TEST_
4245 #  define DEBUG_C_TEST DEBUG_C_TEST_
4246 #  define DEBUG_A_TEST DEBUG_A_TEST_
4247 #  define DEBUG_q_TEST DEBUG_q_TEST_
4248 #  define DEBUG_M_TEST DEBUG_M_TEST_
4249 #  define DEBUG_B_TEST DEBUG_B_TEST_
4250 #  define DEBUG_L_TEST DEBUG_L_TEST_
4251 #  define DEBUG_i_TEST DEBUG_i_TEST_
4252 #  define DEBUG_Xv_TEST DEBUG_Xv_TEST_
4253 #  define DEBUG_Uv_TEST DEBUG_Uv_TEST_
4254 #  define DEBUG_Pv_TEST DEBUG_Pv_TEST_
4255 #  define DEBUG_Lv_TEST DEBUG_Lv_TEST_
4256
4257 #  define PERL_DEB(a)                  a
4258 #  define PERL_DEB2(a,b)               a
4259 #  define PERL_DEBUG(a) if (PL_debug)  a
4260 #  define DEBUG_p(a) if (DEBUG_p_TEST) a
4261 #  define DEBUG_s(a) if (DEBUG_s_TEST) a
4262 #  define DEBUG_l(a) if (DEBUG_l_TEST) a
4263 #  define DEBUG_t(a) if (DEBUG_t_TEST) a
4264 #  define DEBUG_o(a) if (DEBUG_o_TEST) a
4265 #  define DEBUG_c(a) if (DEBUG_c_TEST) a
4266 #  define DEBUG_P(a) if (DEBUG_P_TEST) a
4267
4268      /* Temporarily turn off memory debugging in case the a
4269       * does memory allocation, either directly or indirectly. */
4270 #  define DEBUG_m(a)  \
4271     STMT_START {                                                        \
4272         if (PERL_GET_INTERP) {                                          \
4273                                 dTHX;                                   \
4274                                 if (DEBUG_m_TEST) {                     \
4275                                     PL_debug &= ~DEBUG_m_FLAG;          \
4276                                     a;                                  \
4277                                     PL_debug |= DEBUG_m_FLAG;           \
4278                                 }                                       \
4279                               }                                         \
4280     } STMT_END
4281
4282 #  define DEBUG__(t, a)                                                 \
4283         STMT_START {                                                    \
4284                 if (t) STMT_START {a;} STMT_END;                        \
4285         } STMT_END
4286
4287 #  define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
4288
4289 #ifndef PERL_EXT_RE_BUILD
4290 #  define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
4291 #else
4292 #  define DEBUG_r(a) STMT_START {a;} STMT_END
4293 #endif /* PERL_EXT_RE_BUILD */
4294
4295 #  define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
4296 #  define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
4297 #  define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
4298 #  define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
4299 #  define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
4300 #  define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
4301 #  define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
4302 #  define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
4303 #  define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
4304
4305 #  define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
4306 #  define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
4307 #  define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
4308 #  define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
4309 #  define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
4310 #  define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
4311 #  define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
4312 #  define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
4313 #  define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
4314 #  define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
4315 #  define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
4316
4317 #else /* DEBUGGING */
4318
4319 #  define DEBUG_p_TEST (0)
4320 #  define DEBUG_s_TEST (0)
4321 #  define DEBUG_l_TEST (0)
4322 #  define DEBUG_t_TEST (0)
4323 #  define DEBUG_o_TEST (0)
4324 #  define DEBUG_c_TEST (0)
4325 #  define DEBUG_P_TEST (0)
4326 #  define DEBUG_m_TEST (0)
4327 #  define DEBUG_f_TEST (0)
4328 #  define DEBUG_r_TEST (0)
4329 #  define DEBUG_x_TEST (0)
4330 #  define DEBUG_u_TEST (0)
4331 #  define DEBUG_U_TEST (0)
4332 #  define DEBUG_X_TEST (0)
4333 #  define DEBUG_D_TEST (0)
4334 #  define DEBUG_S_TEST (0)
4335 #  define DEBUG_T_TEST (0)
4336 #  define DEBUG_R_TEST (0)
4337 #  define DEBUG_J_TEST (0)
4338 #  define DEBUG_v_TEST (0)
4339 #  define DEBUG_C_TEST (0)
4340 #  define DEBUG_A_TEST (0)
4341 #  define DEBUG_q_TEST (0)
4342 #  define DEBUG_M_TEST (0)
4343 #  define DEBUG_B_TEST (0)
4344 #  define DEBUG_L_TEST (0)
4345 #  define DEBUG_i_TEST (0)
4346 #  define DEBUG_Xv_TEST (0)
4347 #  define DEBUG_Uv_TEST (0)
4348 #  define DEBUG_Pv_TEST (0)
4349 #  define DEBUG_Lv_TEST (0)
4350
4351 #  define PERL_DEB(a)
4352 #  define PERL_DEB2(a,b)               b
4353 #  define PERL_DEBUG(a)
4354 #  define DEBUG_p(a)
4355 #  define DEBUG_s(a)
4356 #  define DEBUG_l(a)
4357 #  define DEBUG_t(a)
4358 #  define DEBUG_o(a)
4359 #  define DEBUG_c(a)
4360 #  define DEBUG_P(a)
4361 #  define DEBUG_m(a)
4362 #  define DEBUG_f(a)
4363 #  define DEBUG_r(a)
4364 #  define DEBUG_x(a)
4365 #  define DEBUG_u(a)
4366 #  define DEBUG_U(a)
4367 #  define DEBUG_X(a)
4368 #  define DEBUG_D(a)
4369 #  define DEBUG_S(a)
4370 #  define DEBUG_T(a)
4371 #  define DEBUG_R(a)
4372 #  define DEBUG_v(a)
4373 #  define DEBUG_C(a)
4374 #  define DEBUG_A(a)
4375 #  define DEBUG_q(a)
4376 #  define DEBUG_M(a)
4377 #  define DEBUG_B(a)
4378 #  define DEBUG_L(a)
4379 #  define DEBUG_i(a)
4380 #  define DEBUG_Xv(a)
4381 #  define DEBUG_Uv(a)
4382 #  define DEBUG_Pv(a)
4383 #  define DEBUG_Lv(a)
4384 #endif /* DEBUGGING */
4385
4386
4387 #define DEBUG_SCOPE(where) \
4388     DEBUG_l( \
4389     Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n",   \
4390                     where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
4391                     __FILE__, __LINE__));
4392
4393 /* Keep the old croak based assert for those who want it, and as a fallback if
4394    the platform is so heretically non-ANSI that it can't assert.  */
4395
4396 #define Perl_assert(what)       PERL_DEB2(                              \
4397         ((what) ? ((void) 0) :                                          \
4398             (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
4399                         "\", line %d", STRINGIFY(what), __LINE__),      \
4400              (void) 0)), ((void)0))
4401
4402 /* assert() gets defined if DEBUGGING (and I_ASSERT).
4403  * If no DEBUGGING, the <assert.h> has not been included. */
4404 #ifndef assert
4405 #  define assert(what)  Perl_assert(what)
4406 #endif
4407 #ifdef DEBUGGING
4408 #  define assert_(what) assert(what),
4409 #else
4410 #  define assert_(what)
4411 #endif
4412
4413 struct ufuncs {
4414     I32 (*uf_val)(pTHX_ IV, SV*);
4415     I32 (*uf_set)(pTHX_ IV, SV*);
4416     IV uf_index;
4417 };
4418
4419 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4420  * XS code wanting to be backward compatible can do something
4421  * like the following:
4422
4423 #ifndef PERL_MG_UFUNC
4424 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4425 #endif
4426
4427 static PERL_MG_UFUNC(foo_get, index, val)
4428 {
4429     sv_setsv(val, ...);
4430     return TRUE;
4431 }
4432
4433 -- Doug MacEachern
4434
4435 */
4436
4437 #ifndef PERL_MG_UFUNC
4438 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4439 #endif
4440
4441 /* Fix these up for __STDC__ */
4442 #ifndef DONT_DECLARE_STD
4443 char *mktemp (char*);
4444 #ifndef atof
4445 double atof (const char*);
4446 #endif
4447 #endif
4448
4449 #ifndef STANDARD_C
4450 /* All of these are in stdlib.h or time.h for ANSI C */
4451 Time_t time();
4452 struct tm *gmtime(), *localtime();
4453 #if defined(OEMVS)
4454 char *(strchr)(), *(strrchr)();
4455 char *(strcpy)(), *(strcat)();
4456 #else
4457 char *strchr(), *strrchr();
4458 char *strcpy(), *strcat();
4459 #endif
4460 #endif /* ! STANDARD_C */
4461
4462
4463 #ifdef I_MATH
4464 #    include <math.h>
4465 #    ifdef __VMS
4466      /* isfinite and others are here rather than in math.h as C99 stipulates */
4467 #        include <fp.h>
4468 #    endif
4469 #else
4470 START_EXTERN_C
4471             double exp (double);
4472             double log (double);
4473             double log10 (double);
4474             double sqrt (double);
4475             double frexp (double,int*);
4476             double ldexp (double,int);
4477             double modf (double,double*);
4478             double sin (double);
4479             double cos (double);
4480             double atan2 (double,double);
4481             double pow (double,double);
4482 END_EXTERN_C
4483 #endif
4484
4485 #ifndef __cplusplus
4486 #  if !defined(WIN32) && !defined(VMS)
4487 #ifndef crypt
4488 char *crypt (const char*, const char*);
4489 #endif
4490 #  endif /* !WIN32 */
4491 #  ifndef DONT_DECLARE_STD
4492 #    ifndef getenv
4493 char *getenv (const char*);
4494 #    endif /* !getenv */
4495 #    if !defined(HAS_LSEEK_PROTO) && !defined(__hpux)
4496 #      ifdef _FILE_OFFSET_BITS
4497 #        if _FILE_OFFSET_BITS == 64
4498 Off_t lseek (int,Off_t,int);
4499 #        endif
4500 #      endif
4501 #    endif
4502 #  endif /* !DONT_DECLARE_STD */
4503 #  ifndef WIN32
4504 #    ifndef getlogin
4505 char *getlogin (void);
4506 #    endif
4507 #  endif /* !WIN32 */
4508 #endif /* !__cplusplus */
4509
4510 /* Fixme on VMS.  This needs to be a run-time, not build time options */
4511 /* Also rename() is affected by this */
4512 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4513 #define UNLINK unlnk
4514 I32 unlnk (pTHX_ const char*);
4515 #else
4516 #define UNLINK PerlLIO_unlink
4517 #endif
4518
4519 /* some versions of glibc are missing the setresuid() proto */
4520 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4521 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4522 #endif
4523 /* some versions of glibc are missing the setresgid() proto */
4524 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4525 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4526 #endif
4527
4528 #ifndef HAS_SETREUID
4529 #  ifdef HAS_SETRESUID
4530 #    define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4531 #    define HAS_SETREUID
4532 #  endif
4533 #endif
4534 #ifndef HAS_SETREGID
4535 #  ifdef HAS_SETRESGID
4536 #    define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4537 #    define HAS_SETREGID
4538 #  endif
4539 #endif
4540
4541 /* Sighandler_t defined in iperlsys.h */
4542
4543 #ifdef HAS_SIGACTION
4544 typedef struct sigaction Sigsave_t;
4545 #else
4546 typedef Sighandler_t Sigsave_t;
4547 #endif
4548
4549 #define SCAN_DEF 0
4550 #define SCAN_TR 1
4551 #define SCAN_REPL 2
4552
4553 #ifdef DEBUGGING
4554 # ifndef register
4555 #  define register
4556 # endif
4557 # define RUNOPS_DEFAULT Perl_runops_debug
4558 #else
4559 # define RUNOPS_DEFAULT Perl_runops_standard
4560 #endif
4561
4562 #if defined(USE_PERLIO)
4563 EXTERN_C void PerlIO_teardown(void);
4564 # ifdef USE_ITHREADS
4565 #  define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4566 #  define PERLIO_TERM                           \
4567         STMT_START {                            \
4568                 PerlIO_teardown();              \
4569                 MUTEX_DESTROY(&PL_perlio_mutex);\
4570         } STMT_END
4571 # else
4572 #  define PERLIO_INIT
4573 #  define PERLIO_TERM   PerlIO_teardown()
4574 # endif
4575 #else
4576 #  define PERLIO_INIT
4577 #  define PERLIO_TERM
4578 #endif
4579
4580 #ifdef MYMALLOC
4581 #  ifdef MUTEX_INIT_CALLS_MALLOC
4582 #    define MALLOC_INIT                                 \
4583         STMT_START {                                    \
4584                 PL_malloc_mutex = NULL;                 \
4585                 MUTEX_INIT(&PL_malloc_mutex);           \
4586         } STMT_END
4587 #    define MALLOC_TERM                                 \
4588         STMT_START {                                    \
4589                 perl_mutex tmp = PL_malloc_mutex;       \
4590                 PL_malloc_mutex = NULL;                 \
4591                 MUTEX_DESTROY(&tmp);                    \
4592         } STMT_END
4593 #  else
4594 #    define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4595 #    define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4596 #  endif
4597 #else
4598 #  define MALLOC_INIT
4599 #  define MALLOC_TERM
4600 #endif
4601
4602 #if defined(PERL_IMPLICIT_CONTEXT)
4603
4604 struct perl_memory_debug_header;
4605 struct perl_memory_debug_header {
4606   tTHX  interpreter;
4607 #  if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4608   MEM_SIZE size;
4609 #  endif
4610   struct perl_memory_debug_header *prev;
4611   struct perl_memory_debug_header *next;
4612 #  ifdef PERL_DEBUG_READONLY_COW
4613   bool readonly;
4614 #  endif
4615 };
4616
4617 #elif defined(PERL_DEBUG_READONLY_COW)
4618
4619 struct perl_memory_debug_header;
4620 struct perl_memory_debug_header {
4621   MEM_SIZE size;
4622 };
4623
4624 #endif
4625
4626 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4627
4628 #  define PERL_MEMORY_DEBUG_HEADER_SIZE \
4629         (sizeof(struct perl_memory_debug_header) + \
4630         (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4631          %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4632
4633 #else
4634 #  define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4635 #endif
4636
4637 #ifdef PERL_TRACK_MEMPOOL
4638 # ifdef PERL_DEBUG_READONLY_COW
4639 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4640         STMT_START {                                            \
4641                 (header).interpreter = (interp);                \
4642                 (header).prev = (header).next = &(header);      \
4643                 (header).readonly = 0;                          \
4644         } STMT_END
4645 # else
4646 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4647         STMT_START {                                            \
4648                 (header).interpreter = (interp);                \
4649                 (header).prev = (header).next = &(header);      \
4650         } STMT_END
4651 # endif
4652 # else
4653 #  define INIT_TRACK_MEMPOOL(header, interp)
4654 #endif
4655
4656 #ifdef I_MALLOCMALLOC
4657 /* Needed for malloc_size(), malloc_good_size() on some systems */
4658 #  include <malloc/malloc.h>
4659 #endif
4660
4661 #ifdef MYMALLOC
4662 #  define Perl_safesysmalloc_size(where)        Perl_malloced_size(where)
4663 #else
4664 #  if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4665 #    ifdef PERL_TRACK_MEMPOOL
4666 #       define Perl_safesysmalloc_size(where)                   \
4667             (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4668 #    else
4669 #       define Perl_safesysmalloc_size(where) malloc_size(where)
4670 #    endif
4671 #  endif
4672 #  ifdef HAS_MALLOC_GOOD_SIZE
4673 #    ifdef PERL_TRACK_MEMPOOL
4674 #       define Perl_malloc_good_size(how_much)                  \
4675             (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4676 #    else
4677 #       define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4678 #    endif
4679 #  else
4680 /* Having this as the identity operation makes some code simpler.  */
4681 #       define Perl_malloc_good_size(how_much)  (how_much)
4682 #  endif
4683 #endif
4684
4685 typedef int (*runops_proc_t)(pTHX);
4686 typedef void (*share_proc_t) (pTHX_ SV *sv);
4687 typedef int  (*thrhook_proc_t) (pTHX);
4688 typedef OP* (*PPADDR_t[]) (pTHX);
4689 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4690 typedef void (*despatch_signals_proc_t) (pTHX);
4691
4692 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4693 #  include <crt_externs.h>      /* for the env array */
4694 #  define environ (*_NSGetEnviron())
4695 #else
4696    /* VMS and some other platforms don't use the environ array */
4697 #  ifdef USE_ENVIRON_ARRAY
4698 #    if !defined(DONT_DECLARE_STD) || \
4699         (defined(__svr4__) && defined(__GNUC__) && defined(__sun)) || \
4700         defined(__sgi)
4701 extern char **  environ;        /* environment variables supplied via exec */
4702 #    endif
4703 #  endif
4704 #endif
4705
4706 #define PERL_PATCHLEVEL_H_IMPLICIT
4707 #include "patchlevel.h"
4708 #undef PERL_PATCHLEVEL_H_IMPLICIT
4709
4710 #define PERL_VERSION_STRING     STRINGIFY(PERL_REVISION) "." \
4711                                 STRINGIFY(PERL_VERSION) "." \
4712                                 STRINGIFY(PERL_SUBVERSION)
4713
4714 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4715                                 STRINGIFY(PERL_API_VERSION) "." \
4716                                 STRINGIFY(PERL_API_SUBVERSION)
4717
4718 START_EXTERN_C
4719
4720 /* handy constants */
4721 EXTCONST char PL_warn_uninit[]
4722   INIT("Use of uninitialized value%s%s%s");
4723 EXTCONST char PL_warn_uninit_sv[]
4724   INIT("Use of uninitialized value%" SVf "%s%s");
4725 EXTCONST char PL_warn_nosemi[]
4726   INIT("Semicolon seems to be missing");
4727 EXTCONST char PL_warn_reserved[]
4728   INIT("Unquoted string \"%s\" may clash with future reserved word");
4729 EXTCONST char PL_warn_nl[]
4730   INIT("Unsuccessful %s on filename containing newline");
4731 EXTCONST char PL_no_wrongref[]
4732   INIT("Can't use %s ref as %s ref");
4733 /* The core no longer needs this here. If you require the string constant,
4734    please inline a copy into your own code.  */
4735 EXTCONST char PL_no_symref[] __attribute__deprecated__
4736   INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4737 EXTCONST char PL_no_symref_sv[]
4738   INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4739
4740 EXTCONST char PL_no_usym[]
4741   INIT("Can't use an undefined value as %s reference");
4742 EXTCONST char PL_no_aelem[]
4743   INIT("Modification of non-creatable array value attempted, subscript %d");
4744 EXTCONST char PL_no_helem_sv[]
4745   INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4746 EXTCONST char PL_no_modify[]
4747   INIT("Modification of a read-only value attempted");
4748 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4749   INIT("Out of memory!\n");
4750 EXTCONST char PL_no_security[]
4751   INIT("Insecure dependency in %s%s");
4752 EXTCONST char PL_no_sock_func[]
4753   INIT("Unsupported socket function \"%s\" called");
4754 EXTCONST char PL_no_dir_func[]
4755   INIT("Unsupported directory function \"%s\" called");
4756 EXTCONST char PL_no_func[]
4757   INIT("The %s function is unimplemented");
4758 EXTCONST char PL_no_myglob[]
4759   INIT("\"%s\" %se %s can't be in a package");
4760 EXTCONST char PL_no_localize_ref[]
4761   INIT("Can't localize through a reference");
4762 EXTCONST char PL_memory_wrap[]
4763   INIT("panic: memory wrap");
4764
4765 EXTCONST char PL_Yes[]
4766   INIT("1");
4767 EXTCONST char PL_No[]
4768   INIT("");
4769 EXTCONST char PL_Zero[]
4770   INIT("0");
4771 EXTCONST char PL_hexdigit[]
4772   INIT("0123456789abcdef0123456789ABCDEF");
4773
4774 /* This is constant on most architectures, a global on OS/2 */
4775 #ifndef OS2
4776 EXTCONST char PL_sh_path[]
4777   INIT(SH_PATH); /* full path of shell */
4778 #endif
4779
4780 #ifdef CSH
4781 EXTCONST char PL_cshname[]
4782   INIT(CSH);
4783 #  define PL_cshlen     (sizeof(CSH "") - 1)
4784 #endif
4785
4786 /* These are baked at compile time into any shared perl library.
4787    In future releases this will allow us in main() to sanity test the
4788    library we're linking against.  */
4789
4790 EXTCONST U8 PL_revision
4791   INIT(PERL_REVISION);
4792 EXTCONST U8 PL_version
4793   INIT(PERL_VERSION);
4794 EXTCONST U8 PL_subversion
4795   INIT(PERL_SUBVERSION);
4796
4797 EXTCONST char PL_uuemap[65]
4798   INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4799
4800 /* a special string address whose value is "isa", but which perl knows
4801  * to treat as if it were really "DOES" when printing the method name in
4802  *  the "Can't call method '%s'" error message */
4803 EXTCONST char PL_isa_DOES[]
4804   INIT("isa");
4805
4806 #ifdef DOINIT
4807 EXTCONST char PL_uudmap[256] =
4808 #  ifdef PERL_MICRO
4809 #    include "uuudmap.h"
4810 #  else
4811 #    include "uudmap.h"
4812 #  endif
4813 ;
4814 EXTCONST char PL_bitcount[256] =
4815 #  ifdef PERL_MICRO
4816 #    include "ubitcount.h"
4817 #else
4818 #    include "bitcount.h"
4819 #  endif
4820 ;
4821 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4822 EXTCONST int         PL_sig_num[]  = { SIG_NUM };
4823 #else
4824 EXTCONST char PL_uudmap[256];
4825 EXTCONST char PL_bitcount[256];
4826 EXTCONST char* const PL_sig_name[];
4827 EXTCONST int         PL_sig_num[];
4828 #endif
4829
4830 /* fast conversion and case folding tables.  The folding tables complement the
4831  * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4832  * folds such as outside the range or to multiple characters. */
4833
4834 #ifdef DOINIT
4835 #ifndef EBCDIC
4836
4837 /* The EBCDIC fold table depends on the code page, and hence is found in
4838  * utfebcdic.h */
4839
4840 EXTCONST  unsigned char PL_fold[] = {
4841         0,      1,      2,      3,      4,      5,      6,      7,
4842         8,      9,      10,     11,     12,     13,     14,     15,
4843         16,     17,     18,     19,     20,     21,     22,     23,
4844         24,     25,     26,     27,     28,     29,     30,     31,
4845         32,     33,     34,     35,     36,     37,     38,     39,
4846         40,     41,     42,     43,     44,     45,     46,     47,
4847         48,     49,     50,     51,     52,     53,     54,     55,
4848         56,     57,     58,     59,     60,     61,     62,     63,
4849         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4850         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4851         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4852         'x',    'y',    'z',    91,     92,     93,     94,     95,
4853         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4854         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4855         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4856         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4857         128,    129,    130,    131,    132,    133,    134,    135,
4858         136,    137,    138,    139,    140,    141,    142,    143,
4859         144,    145,    146,    147,    148,    149,    150,    151,
4860         152,    153,    154,    155,    156,    157,    158,    159,
4861         160,    161,    162,    163,    164,    165,    166,    167,
4862         168,    169,    170,    171,    172,    173,    174,    175,
4863         176,    177,    178,    179,    180,    181,    182,    183,
4864         184,    185,    186,    187,    188,    189,    190,    191,
4865         192,    193,    194,    195,    196,    197,    198,    199,
4866         200,    201,    202,    203,    204,    205,    206,    207,
4867         208,    209,    210,    211,    212,    213,    214,    215,
4868         216,    217,    218,    219,    220,    221,    222,    223,
4869         224,    225,    226,    227,    228,    229,    230,    231,
4870         232,    233,    234,    235,    236,    237,    238,    239,
4871         240,    241,    242,    243,    244,    245,    246,    247,
4872         248,    249,    250,    251,    252,    253,    254,    255
4873 };
4874 EXTCONST  unsigned char PL_fold_latin1[] = {
4875     /* Full latin1 complement folding, except for three problematic code points:
4876      *  Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4877      *  fold complements outside the Latin1 range, so can't match something
4878      *  that isn't in utf8.
4879      *  German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4880      *  not one, so can't be represented in this table.
4881      *
4882      * All have to be specially handled */
4883         0,      1,      2,      3,      4,      5,      6,      7,
4884         8,      9,      10,     11,     12,     13,     14,     15,
4885         16,     17,     18,     19,     20,     21,     22,     23,
4886         24,     25,     26,     27,     28,     29,     30,     31,
4887         32,     33,     34,     35,     36,     37,     38,     39,
4888         40,     41,     42,     43,     44,     45,     46,     47,
4889         48,     49,     50,     51,     52,     53,     54,     55,
4890         56,     57,     58,     59,     60,     61,     62,     63,
4891         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4892         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4893         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4894         'x',    'y',    'z',    91,     92,     93,     94,     95,
4895         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4896         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4897         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4898         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4899         128,    129,    130,    131,    132,    133,    134,    135,
4900         136,    137,    138,    139,    140,    141,    142,    143,
4901         144,    145,    146,    147,    148,    149,    150,    151,
4902         152,    153,    154,    155,    156,    157,    158,    159,
4903         160,    161,    162,    163,    164,    165,    166,    167,
4904         168,    169,    170,    171,    172,    173,    174,    175,
4905         176,    177,    178,    179,    180,    181 /*micro */, 182,    183,
4906         184,    185,    186,    187,    188,    189,    190,    191,
4907         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4908         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4909         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4910         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
4911         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4912         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4913         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4914         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
4915         255 /* y with diaeresis */
4916 };
4917
4918 /* If these tables are accessed through ebcdic, the access will be converted to
4919  * latin1 first */
4920 EXTCONST  unsigned char PL_latin1_lc[] = {  /* lowercasing */
4921         0,      1,      2,      3,      4,      5,      6,      7,
4922         8,      9,      10,     11,     12,     13,     14,     15,
4923         16,     17,     18,     19,     20,     21,     22,     23,
4924         24,     25,     26,     27,     28,     29,     30,     31,
4925         32,     33,     34,     35,     36,     37,     38,     39,
4926         40,     41,     42,     43,     44,     45,     46,     47,
4927         48,     49,     50,     51,     52,     53,     54,     55,
4928         56,     57,     58,     59,     60,     61,     62,     63,
4929         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4930         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4931         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4932         'x',    'y',    'z',    91,     92,     93,     94,     95,
4933         96,     97,     98,     99,     100,    101,    102,    103,
4934         104,    105,    106,    107,    108,    109,    110,    111,
4935         112,    113,    114,    115,    116,    117,    118,    119,
4936         120,    121,    122,    123,    124,    125,    126,    127,
4937         128,    129,    130,    131,    132,    133,    134,    135,
4938         136,    137,    138,    139,    140,    141,    142,    143,
4939         144,    145,    146,    147,    148,    149,    150,    151,
4940         152,    153,    154,    155,    156,    157,    158,    159,
4941         160,    161,    162,    163,    164,    165,    166,    167,
4942         168,    169,    170,    171,    172,    173,    174,    175,
4943         176,    177,    178,    179,    180,    181,    182,    183,
4944         184,    185,    186,    187,    188,    189,    190,    191,
4945         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4946         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4947         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4948         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223,
4949         224,    225,    226,    227,    228,    229,    230,    231,
4950         232,    233,    234,    235,    236,    237,    238,    239,
4951         240,    241,    242,    243,    244,    245,    246,    247,
4952         248,    249,    250,    251,    252,    253,    254,    255
4953 };
4954
4955 /* upper and title case of latin1 characters, modified so that the three tricky
4956  * ones are mapped to 255 (which is one of the three) */
4957 EXTCONST  unsigned char PL_mod_latin1_uc[] = {
4958         0,      1,      2,      3,      4,      5,      6,      7,
4959         8,      9,      10,     11,     12,     13,     14,     15,
4960         16,     17,     18,     19,     20,     21,     22,     23,
4961         24,     25,     26,     27,     28,     29,     30,     31,