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