perl.h

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