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 =head1 Miscellaneous Functions
2586
2587 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
2588 Provides system-specific tune up of the C runtime environment necessary to
2589 run Perl interpreters.  This should be called only once, before creating
2590 any Perl interpreters.
2591
2592 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
2593 Provides system-specific tune up of the C runtime environment necessary to
2594 run Perl interpreters.  This should be called only once, before creating
2595 any Perl interpreters.
2596
2597 =for apidoc Am|void|PERL_SYS_TERM|
2598 Provides system-specific clean up of the C runtime environment after
2599 running Perl interpreters.  This should be called only once, after
2600 freeing any remaining Perl interpreters.
2601
2602 =cut
2603  */
2604
2605 #define PERL_SYS_INIT(argc, argv)       Perl_sys_init(argc, argv)
2606 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
2607 #define PERL_SYS_TERM()                 Perl_sys_term()
2608
2609 #ifndef PERL_WRITE_MSG_TO_CONSOLE
2610 #  define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
2611 #endif
2612
2613 #ifndef MAXPATHLEN
2614 #  ifdef PATH_MAX
2615 #    ifdef _POSIX_PATH_MAX
2616 #       if PATH_MAX > _POSIX_PATH_MAX
2617 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
2618  * included the null byte or not.  Later amendments of POSIX,
2619  * XPG4, the Austin Group, and the Single UNIX Specification
2620  * all explicitly include the null byte in the PATH_MAX.
2621  * Ditto for _POSIX_PATH_MAX. */
2622 #         define MAXPATHLEN PATH_MAX
2623 #       else
2624 #         define MAXPATHLEN _POSIX_PATH_MAX
2625 #       endif
2626 #    else
2627 #      define MAXPATHLEN (PATH_MAX+1)
2628 #    endif
2629 #  else
2630 #    define MAXPATHLEN 1024     /* Err on the large side. */
2631 #  endif
2632 #endif
2633
2634 /* In case Configure was not used (we are using a "canned config"
2635  * such as Win32, or a cross-compilation setup, for example) try going
2636  * by the gcc major and minor versions.  One useful URL is
2637  * http://www.ohse.de/uwe/articles/gcc-attributes.html,
2638  * but contrary to this information warn_unused_result seems
2639  * not to be in gcc 3.3.5, at least. --jhi
2640  * Also, when building extensions with an installed perl, this allows
2641  * the user to upgrade gcc and get the right attributes, rather than
2642  * relying on the list generated at Configure time.  --AD
2643  * Set these up now otherwise we get confused when some of the <*thread.h>
2644  * includes below indirectly pull in <perlio.h> (which needs to know if we
2645  * have HASATTRIBUTE_FORMAT).
2646  */
2647
2648 #ifndef PERL_MICRO
2649 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
2650 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
2651 #    define HASATTRIBUTE_DEPRECATED
2652 #  endif
2653 #  if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
2654 #    define HASATTRIBUTE_FORMAT
2655 #    if defined __MINGW32__
2656 #      define PRINTF_FORMAT_NULL_OK
2657 #    endif
2658 #  endif
2659 #  if __GNUC__ >= 3 /* 3.0 -> */
2660 #    define HASATTRIBUTE_MALLOC
2661 #  endif
2662 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
2663 #    define HASATTRIBUTE_NONNULL
2664 #  endif
2665 #  if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
2666 #    define HASATTRIBUTE_NORETURN
2667 #  endif
2668 #  if __GNUC__ >= 3 /* gcc 3.0 -> */
2669 #    define HASATTRIBUTE_PURE
2670 #  endif
2671 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2672 #    define HASATTRIBUTE_UNUSED
2673 #  endif
2674 #  if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
2675 #    define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
2676 #  endif
2677 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2678 #    define HASATTRIBUTE_WARN_UNUSED_RESULT
2679 #  endif
2680 #endif
2681 #endif /* #ifndef PERL_MICRO */
2682
2683 /* USE_5005THREADS needs to be after unixish.h as <pthread.h> includes
2684  * <sys/signal.h> which defines NSIG - which will stop inclusion of <signal.h>
2685  * this results in many functions being undeclared which bothers C++
2686  * May make sense to have threads after "*ish.h" anyway
2687  */
2688
2689 #if defined(USE_ITHREADS)
2690 #  ifdef NETWARE
2691 #   include <nw5thread.h>
2692 #  else
2693 #    ifdef WIN32
2694 #      include <win32thread.h>
2695 #    else
2696 #      ifdef OS2
2697 #        include "os2thread.h"
2698 #      else
2699 #        ifdef I_MACH_CTHREADS
2700 #          include <mach/cthreads.h>
2701 #          if (defined(NeXT) || defined(__NeXT__)) && defined(PERL_POLLUTE_MALLOC)
2702 #            define MUTEX_INIT_CALLS_MALLOC
2703 #          endif
2704 typedef cthread_t       perl_os_thread;
2705 typedef mutex_t         perl_mutex;
2706 typedef condition_t     perl_cond;
2707 typedef void *          perl_key;
2708 #        else /* Posix threads */
2709 #          ifdef I_PTHREAD
2710 #            include <pthread.h>
2711 #          endif
2712 typedef pthread_t       perl_os_thread;
2713 typedef pthread_mutex_t perl_mutex;
2714 typedef pthread_cond_t  perl_cond;
2715 typedef pthread_key_t   perl_key;
2716 #        endif /* I_MACH_CTHREADS */
2717 #      endif /* OS2 */
2718 #    endif /* WIN32 */
2719 #  endif /* NETWARE */
2720 #endif /* USE_ITHREADS */
2721
2722 #if defined(WIN32)
2723 #  include "win32.h"
2724 #endif
2725
2726 #ifdef NETWARE
2727 #  include "netware.h"
2728 #endif
2729
2730 #define STATUS_UNIX     PL_statusvalue
2731 #ifdef VMS
2732 #   define STATUS_NATIVE        PL_statusvalue_vms
2733 /*
2734  * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
2735  * its contents can not be trusted.  Unfortunately, Perl seems to check
2736  * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
2737  * be updated also.
2738  */
2739 #  include <stsdef.h>
2740 #  include <ssdef.h>
2741 /* Presume this because if VMS changes it, it will require a new
2742  * set of APIs for waiting on children for binary compatibility.
2743  */
2744 #  define child_offset_bits (8)
2745 #  ifndef C_FAC_POSIX
2746 #  define C_FAC_POSIX 0x35A000
2747 #  endif
2748
2749 /*  STATUS_EXIT - validates and returns a NATIVE exit status code for the
2750  * platform from the existing UNIX or Native status values.
2751  */
2752
2753 #   define STATUS_EXIT \
2754         (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
2755            (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
2756
2757
2758 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
2759  * exit code and shifts the UNIX value over the correct number of bits to
2760  * be a child status.  Usually the number of bits is 8, but that could be
2761  * platform dependent.  The NATIVE status code is presumed to have either
2762  * from a child process.
2763  */
2764
2765 /* This is complicated.  The child processes return a true native VMS
2766    status which must be saved.  But there is an assumption in Perl that
2767    the UNIX child status has some relationship to errno values, so
2768    Perl tries to translate it to text in some of the tests.
2769    In order to get the string translation correct, for the error, errno
2770    must be EVMSERR, but that generates a different text message
2771    than what the test programs are expecting.  So an errno value must
2772    be derived from the native status value when an error occurs.
2773    That will hide the true native status message.  With this version of
2774    perl, the true native child status can always be retrieved so that
2775    is not a problem.  But in this case, Pl_statusvalue and errno may
2776    have different values in them.
2777  */
2778
2779 #   define STATUS_NATIVE_CHILD_SET(n) \
2780         STMT_START {                                                    \
2781             I32 evalue = (I32)n;                                        \
2782             if (evalue == EVMSERR) {                                    \
2783               PL_statusvalue_vms = vaxc$errno;                          \
2784               PL_statusvalue = evalue;                                  \
2785             } else {                                                    \
2786               PL_statusvalue_vms = evalue;                              \
2787               if (evalue == -1) {                                       \
2788                 PL_statusvalue = -1;                                    \
2789                 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
2790               } else                                                    \
2791                 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1);    \
2792               set_vaxc_errno(evalue);                                   \
2793               if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX)    \
2794                   set_errno(EVMSERR);                                   \
2795               else set_errno(Perl_vms_status_to_unix(evalue, 0));       \
2796               PL_statusvalue = PL_statusvalue << child_offset_bits;     \
2797             }                                                           \
2798         } STMT_END
2799
2800 #   ifdef VMSISH_STATUS
2801 #       define STATUS_CURRENT   (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
2802 #   else
2803 #       define STATUS_CURRENT   STATUS_UNIX
2804 #   endif
2805
2806   /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
2807    * the NATIVE status to an equivalent value.  Can not be used to translate
2808    * exit code values as exit code values are not guaranteed to have any
2809    * relationship at all to errno values.
2810    * This is used when Perl is forcing errno to have a specific value.
2811    */
2812 #   define STATUS_UNIX_SET(n)                           \
2813         STMT_START {                                    \
2814             I32 evalue = (I32)n;                        \
2815             PL_statusvalue = evalue;                    \
2816             if (PL_statusvalue != -1) {                 \
2817                 if (PL_statusvalue != EVMSERR) {        \
2818                   PL_statusvalue &= 0xFFFF;             \
2819                   if (MY_POSIX_EXIT)                    \
2820                     PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
2821                   else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
2822                 }                                       \
2823                 else {                                  \
2824                   PL_statusvalue_vms = vaxc$errno;      \
2825                 }                                       \
2826             }                                           \
2827             else PL_statusvalue_vms = SS$_ABORT;        \
2828             set_vaxc_errno(PL_statusvalue_vms);         \
2829         } STMT_END
2830
2831   /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
2832    * the NATIVE error status based on it.
2833    *
2834    * When in the default mode to comply with the Perl VMS documentation,
2835    * 0 is a success and any other code sets the NATIVE status to a failure
2836    * code of SS$_ABORT.
2837    *
2838    * In the new POSIX EXIT mode, native status will be set so that the
2839    * actual exit code will can be retrieved by the calling program or
2840    * shell.
2841    *
2842    * If the exit code is not clearly a UNIX parent or child exit status,
2843    * it will be passed through as a VMS status.
2844    */
2845
2846 #   define STATUS_UNIX_EXIT_SET(n)                      \
2847         STMT_START {                                    \
2848             I32 evalue = (I32)n;                        \
2849             PL_statusvalue = evalue;                    \
2850             if (MY_POSIX_EXIT) { \
2851               if (evalue <= 0xFF00) {           \
2852                   if (evalue > 0xFF)                    \
2853                     evalue = (evalue >> child_offset_bits) & 0xFF; \
2854                   PL_statusvalue_vms =          \
2855                     (C_FAC_POSIX | (evalue << 3 ) |     \
2856                     ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
2857               } else /* forgive them Perl, for they have sinned */ \
2858                 PL_statusvalue_vms = evalue; \
2859             } else { \
2860               if (evalue == 0)                  \
2861                 PL_statusvalue_vms = SS$_NORMAL;        \
2862               else if (evalue <= 0xFF00) \
2863                 PL_statusvalue_vms = SS$_ABORT; \
2864               else { /* forgive them Perl, for they have sinned */ \
2865                   if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
2866                   else PL_statusvalue_vms = vaxc$errno; \
2867                   /* And obviously used a VMS status value instead of UNIX */ \
2868                   PL_statusvalue = EVMSERR;             \
2869               } \
2870               set_vaxc_errno(PL_statusvalue_vms);       \
2871             }                                           \
2872         } STMT_END
2873
2874
2875   /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
2876    * and sets the NATIVE error status based on it.  This special case
2877    * is needed to maintain compatibility with past VMS behavior.
2878    *
2879    * In the default mode on VMS, this number is passed through as
2880    * both the NATIVE and UNIX status.  Which makes it different
2881    * that the STATUS_UNIX_EXIT_SET.
2882    *
2883    * In the new POSIX EXIT mode, native status will be set so that the
2884    * actual exit code will can be retrieved by the calling program or
2885    * shell.
2886    *
2887    * A POSIX exit code is from 0 to 255.  If the exit code is higher
2888    * than this, it needs to be assumed that it is a VMS exit code and
2889    * passed through.
2890    */
2891
2892 #   define STATUS_EXIT_SET(n)                           \
2893         STMT_START {                                    \
2894             I32 evalue = (I32)n;                        \
2895             PL_statusvalue = evalue;                    \
2896             if (MY_POSIX_EXIT)                          \
2897                 if (evalue > 255) PL_statusvalue_vms = evalue; else {   \
2898                   PL_statusvalue_vms = \
2899                     (C_FAC_POSIX | (evalue << 3 ) |     \
2900                      ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
2901             else                                        \
2902                 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
2903             set_vaxc_errno(PL_statusvalue_vms);         \
2904         } STMT_END
2905
2906
2907  /* This macro forces a success status */
2908 #   define STATUS_ALL_SUCCESS   \
2909         (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
2910
2911  /* This macro forces a failure status */
2912 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, \
2913      vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
2914         (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
2915
2916 #else
2917 #   define STATUS_NATIVE        PL_statusvalue_posix
2918 #   if defined(WCOREDUMP)
2919 #       define STATUS_NATIVE_CHILD_SET(n)                  \
2920             STMT_START {                                   \
2921                 PL_statusvalue_posix = (n);                \
2922                 if (PL_statusvalue_posix == -1)            \
2923                     PL_statusvalue = -1;                   \
2924                 else {                                     \
2925                     PL_statusvalue =                       \
2926                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
2927                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
2928                         (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0);  \
2929                 }                                          \
2930             } STMT_END
2931 #   elif defined(WIFEXITED)
2932 #       define STATUS_NATIVE_CHILD_SET(n)                  \
2933             STMT_START {                                   \
2934                 PL_statusvalue_posix = (n);                \
2935                 if (PL_statusvalue_posix == -1)            \
2936                     PL_statusvalue = -1;                   \
2937                 else {                                     \
2938                     PL_statusvalue =                       \
2939                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
2940                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0);  \
2941                 }                                          \
2942             } STMT_END
2943 #   else
2944 #       define STATUS_NATIVE_CHILD_SET(n)                  \
2945             STMT_START {                                   \
2946                 PL_statusvalue_posix = (n);                \
2947                 if (PL_statusvalue_posix == -1)            \
2948                     PL_statusvalue = -1;                   \
2949                 else {                                     \
2950                     PL_statusvalue =                       \
2951                         PL_statusvalue_posix & 0xFFFF;     \
2952                 }                                          \
2953             } STMT_END
2954 #   endif
2955 #   define STATUS_UNIX_SET(n)           \
2956         STMT_START {                    \
2957             PL_statusvalue = (n);               \
2958             if (PL_statusvalue != -1)   \
2959                 PL_statusvalue &= 0xFFFF;       \
2960         } STMT_END
2961 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
2962 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
2963 #   define STATUS_CURRENT STATUS_UNIX
2964 #   define STATUS_EXIT STATUS_UNIX
2965 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
2966 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
2967 #endif
2968
2969 /* flags in PL_exit_flags for nature of exit() */
2970 #define PERL_EXIT_EXPECTED      0x01
2971 #define PERL_EXIT_DESTRUCT_END  0x02  /* Run END in perl_destruct */
2972 #define PERL_EXIT_WARN          0x04  /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
2973 #define PERL_EXIT_ABORT         0x08  /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
2974
2975 #ifndef PERL_CORE
2976 /* format to use for version numbers in file/directory names */
2977 /* XXX move to Configure? */
2978 /* This was only ever used for the current version, and that can be done at
2979    compile time, as PERL_FS_VERSION, so should we just delete it?  */
2980 #  ifndef PERL_FS_VER_FMT
2981 #    define PERL_FS_VER_FMT     "%d.%d.%d"
2982 #  endif
2983 #endif
2984
2985 #ifndef PERL_FS_VERSION
2986 #  define PERL_FS_VERSION       PERL_VERSION_STRING
2987 #endif
2988
2989 /* This defines a way to flush all output buffers.  This may be a
2990  * performance issue, so we allow people to disable it.  Also, if
2991  * we are using stdio, there are broken implementations of fflush(NULL)
2992  * out there, Solaris being the most prominent.
2993  */
2994 #ifndef PERL_FLUSHALL_FOR_CHILD
2995 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
2996 #  define PERL_FLUSHALL_FOR_CHILD       PerlIO_flush((PerlIO*)NULL)
2997 # else
2998 #  ifdef FFLUSH_ALL
2999 #   define PERL_FLUSHALL_FOR_CHILD      my_fflush_all()
3000 #  else
3001 #   define PERL_FLUSHALL_FOR_CHILD      NOOP
3002 #  endif
3003 # endif
3004 #endif
3005
3006 #ifndef PERL_WAIT_FOR_CHILDREN
3007 #  define PERL_WAIT_FOR_CHILDREN        NOOP
3008 #endif
3009
3010 /* the traditional thread-unsafe notion of "current interpreter". */
3011 #ifndef PERL_SET_INTERP
3012 #  define PERL_SET_INTERP(i)            (PL_curinterp = (PerlInterpreter*)(i))
3013 #endif
3014
3015 #ifndef PERL_GET_INTERP
3016 #  define PERL_GET_INTERP               (PL_curinterp)
3017 #endif
3018
3019 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3020 #  ifdef MULTIPLICITY
3021 #    define PERL_GET_THX                ((PerlInterpreter *)PERL_GET_CONTEXT)
3022 #  endif
3023 #  define PERL_SET_THX(t)               PERL_SET_CONTEXT(t)
3024 #endif
3025
3026 /*
3027     This replaces the previous %_ "hack" by the "%p" hacks.
3028     All that is required is that the perl source does not
3029     use "%-p" or "%-<number>p" or "%<number>p" formats.
3030     These formats will still work in perl code.
3031     See comments in sv.c for further details.
3032
3033     Robin Barker 2005-07-14
3034
3035     No longer use %1p for VDf = %vd.  RMB 2007-10-19
3036 */
3037
3038 #ifndef SVf_
3039 #  define SVf_(n) "-" STRINGIFY(n) "p"
3040 #endif
3041
3042 #ifndef SVf
3043 #  define SVf "-p"
3044 #endif
3045
3046 #ifndef SVf32
3047 #  define SVf32 SVf_(32)
3048 #endif
3049
3050 #ifndef SVf256
3051 #  define SVf256 SVf_(256)
3052 #endif
3053
3054 #define SVfARG(p) ((void*)(p))
3055
3056 #ifndef HEKf
3057 #  define HEKf "2p"
3058 #endif
3059
3060 /* Not ideal, but we cannot easily include a number in an already-numeric
3061  * format sequence. */
3062 #ifndef HEKf256
3063 #  define HEKf256 "3p"
3064 #endif
3065
3066 #define HEKfARG(p) ((void*)(p))
3067
3068 /* Takes three arguments: is_utf8, length, str */
3069 #ifndef UTF8f
3070 #  define UTF8f "d%" UVuf "%4p"
3071 #endif
3072 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3073
3074 #ifdef PERL_CORE
3075 /* not used; but needed for backward compatibility with XS code? - RMB */
3076 #  undef UVf
3077 #else
3078 #  ifndef UVf
3079 #    define UVf UVuf
3080 #  endif
3081 #endif
3082
3083 #ifdef HASATTRIBUTE_DEPRECATED
3084 #  define __attribute__deprecated__         __attribute__((deprecated))
3085 #endif
3086 #ifdef HASATTRIBUTE_FORMAT
3087 #  define __attribute__format__(x,y,z)      __attribute__((format(x,y,z)))
3088 #endif
3089 #ifdef HASATTRIBUTE_MALLOC
3090 #  define __attribute__malloc__             __attribute__((__malloc__))
3091 #endif
3092 #ifdef HASATTRIBUTE_NONNULL
3093 #  define __attribute__nonnull__(a)         __attribute__((nonnull(a)))
3094 #endif
3095 #ifdef HASATTRIBUTE_NORETURN
3096 #  define __attribute__noreturn__           __attribute__((noreturn))
3097 #endif
3098 #ifdef HASATTRIBUTE_PURE
3099 #  define __attribute__pure__               __attribute__((pure))
3100 #endif
3101 #ifdef HASATTRIBUTE_UNUSED
3102 #  define __attribute__unused__             __attribute__((unused))
3103 #endif
3104 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
3105 #  define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
3106 #endif
3107
3108 /* If we haven't defined the attributes yet, define them to blank. */
3109 #ifndef __attribute__deprecated__
3110 #  define __attribute__deprecated__
3111 #endif
3112 #ifndef __attribute__format__
3113 #  define __attribute__format__(x,y,z)
3114 #endif
3115 #ifndef __attribute__malloc__
3116 #  define __attribute__malloc__
3117 #endif
3118 #ifndef __attribute__nonnull__
3119 #  define __attribute__nonnull__(a)
3120 #endif
3121 #ifndef __attribute__noreturn__
3122 #  define __attribute__noreturn__
3123 #endif
3124 #ifndef __attribute__pure__
3125 #  define __attribute__pure__
3126 #endif
3127 #ifndef __attribute__unused__
3128 #  define __attribute__unused__
3129 #endif
3130 #ifndef __attribute__warn_unused_result__
3131 #  define __attribute__warn_unused_result__
3132 #endif
3133
3134 #if defined(DEBUGGING) && defined(I_ASSERT)
3135 #  include <assert.h>
3136 #endif
3137
3138 /* For functions that are marked as __attribute__noreturn__, it's not
3139    appropriate to call return.  In either case, include the lint directive.
3140  */
3141 #ifdef HASATTRIBUTE_NORETURN
3142 #  define NORETURN_FUNCTION_END NOT_REACHED; /* NOTREACHED */
3143 #else
3144 #  define NORETURN_FUNCTION_END NOT_REACHED; /* NOTREACHED */ return 0
3145 #endif
3146
3147 /* Some OS warn on NULL format to printf */
3148 #ifdef PRINTF_FORMAT_NULL_OK
3149 #  define __attribute__format__null_ok__(x,y,z)  __attribute__format__(x,y,z)
3150 #else
3151 #  define __attribute__format__null_ok__(x,y,z)
3152 #endif
3153
3154 #ifdef HAS_BUILTIN_EXPECT
3155 #  define EXPECT(expr,val)                  __builtin_expect(expr,val)
3156 #else
3157 #  define EXPECT(expr,val)                  (expr)
3158 #endif
3159 #define LIKELY(cond)                        EXPECT(cBOOL(cond),TRUE)
3160 #define UNLIKELY(cond)                      EXPECT(cBOOL(cond),FALSE)
3161 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3162 /* placeholder */
3163 #endif
3164
3165
3166 #ifndef __has_builtin
3167 #  define __has_builtin(x) 0 /* not a clang style compiler */
3168 #endif
3169
3170 /* ASSUME is like assert(), but it has a benefit in a release build. It is a
3171    hint to a compiler about a statement of fact in a function call free
3172    expression, which allows the compiler to generate better machine code.
3173    In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3174    the control path is unreachable. In a for loop, ASSUME can be used to hint
3175    that a loop will run atleast X times. ASSUME is based off MSVC's __assume
3176    intrinsic function, see its documents for more details.
3177 */
3178
3179 #ifndef DEBUGGING
3180 #  if __has_builtin(__builtin_unreachable) \
3181      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 5) /* 4.5 -> */
3182 #    define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3183 #  elif defined(_MSC_VER)
3184 #    define ASSUME(x) __assume(x)
3185 #  elif defined(__ARMCC_VERSION) /* untested */
3186 #    define ASSUME(x) __promise(x)
3187 #  else
3188 /* a random compiler might define assert to its own special optimization token
3189    so pass it through to C lib as a last resort */
3190 #    define ASSUME(x) assert(x)
3191 #  endif
3192 #else
3193 #  define ASSUME(x) assert(x)
3194 #endif
3195
3196 #define NOT_REACHED ASSUME(0)
3197
3198 /* Some unistd.h's give a prototype for pause() even though
3199    HAS_PAUSE ends up undefined.  This causes the #define
3200    below to be rejected by the compiler.  Sigh.
3201 */
3202 #ifdef HAS_PAUSE
3203 #define Pause   pause
3204 #else
3205 #define Pause() sleep((32767<<16)+32767)
3206 #endif
3207
3208 #ifndef IOCPARM_LEN
3209 #   ifdef IOCPARM_MASK
3210         /* on BSDish systems we're safe */
3211 #       define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
3212 #   else
3213 #       if defined(_IOC_SIZE) && defined(__GLIBC__)
3214         /* on Linux systems we're safe; except when we're not [perl #38223] */
3215 #           define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3216 #       else
3217         /* otherwise guess at what's safe */
3218 #           define IOCPARM_LEN(x)       256
3219 #       endif
3220 #   endif
3221 #endif
3222
3223 #if defined(__CYGWIN__)
3224 /* USEMYBINMODE
3225  *   This symbol, if defined, indicates that the program should
3226  *   use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3227  *   that a file is in "binary" mode -- that is, that no translation
3228  *   of bytes occurs on read or write operations.
3229  */
3230 #  define USEMYBINMODE /**/
3231 #  include <io.h> /* for setmode() prototype */
3232 #  define my_binmode(fp, iotype, mode) \
3233             (PerlLIO_setmode(fileno(fp), mode) != -1 ? TRUE : FALSE)
3234 #endif
3235
3236 #ifdef __CYGWIN__
3237 void init_os_extras(void);
3238 #endif
3239
3240 #ifdef UNION_ANY_DEFINITION
3241 UNION_ANY_DEFINITION;
3242 #else
3243 union any {
3244     void*       any_ptr;
3245     I32         any_i32;
3246     U32         any_u32;
3247     IV          any_iv;
3248     UV          any_uv;
3249     long        any_long;
3250     bool        any_bool;
3251     void        (*any_dptr) (void*);
3252     void        (*any_dxptr) (pTHX_ void*);
3253 };
3254 #endif
3255
3256 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3257
3258 #define FILTER_READ(idx, sv, len)  filter_read(idx, sv, len)
3259 #define FILTER_DATA(idx) \
3260             (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3261 #define FILTER_ISREADER(idx) \
3262             (PL_parser && PL_parser->rsfp_filters \
3263                 && idx >= AvFILLp(PL_parser->rsfp_filters))
3264 #define PERL_FILTER_EXISTS(i) \
3265             (PL_parser && PL_parser->rsfp_filters \
3266                 && (i) <= av_tindex(PL_parser->rsfp_filters))
3267
3268 #if defined(_AIX) && !defined(_AIX43)
3269 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3270 /* We cannot include <crypt.h> to get the struct crypt_data
3271  * because of setkey prototype problems when threading */
3272 typedef        struct crypt_data {     /* straight from /usr/include/crypt.h */
3273     /* From OSF, Not needed in AIX
3274        char C[28], D[28];
3275     */
3276     char E[48];
3277     char KS[16][48];
3278     char block[66];
3279     char iobuf[16];
3280 } CRYPTD;
3281 #endif /* threading */
3282 #endif /* AIX */
3283
3284 #if !defined(OS2)
3285 #  include "iperlsys.h"
3286 #endif
3287
3288 #ifdef __LIBCATAMOUNT__
3289 #undef HAS_PASSWD  /* unixish.h but not unixish enough. */
3290 #undef HAS_GROUP
3291 #define FAKE_BIT_BUCKET
3292 #endif
3293
3294 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3295  * Note that the USE_HASH_SEED and USE_HASH_SEED_EXPLICIT are *NOT*
3296  * defined by Configure, despite their names being similar to the
3297  * other defines like USE_ITHREADS.  Configure in fact knows nothing
3298  * about the randomised hashes.  Therefore to enable/disable the hash
3299  * randomisation defines use the Configure -Accflags=... instead. */
3300 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED) && !defined(USE_HASH_SEED_EXPLICIT)
3301 #  define USE_HASH_SEED
3302 #endif
3303
3304 /* Win32 defines a type 'WORD' in windef.h. This conflicts with the enumerator
3305  * 'WORD' defined in perly.h. The yytokentype enum is only a debugging aid, so
3306  * it's not really needed.
3307  */
3308 #if defined(WIN32)
3309 #  define YYTOKENTYPE
3310 #endif
3311 #include "perly.h"
3312
3313 #ifdef PERL_MAD
3314 struct nexttoken {
3315     YYSTYPE next_val;   /* value of next token, if any */
3316     I32 next_type;      /* type of next token */
3317     MADPROP *next_mad;  /* everything else about that token */
3318 };
3319 #endif
3320
3321 /* macros to define bit-fields in structs. */
3322 #ifndef PERL_BITFIELD8
3323 #  define PERL_BITFIELD8 unsigned
3324 #endif
3325 #ifndef PERL_BITFIELD16
3326 #  define PERL_BITFIELD16 unsigned
3327 #endif
3328 #ifndef PERL_BITFIELD32
3329 #  define PERL_BITFIELD32 unsigned
3330 #endif
3331
3332 #include "sv.h"
3333 #include "regexp.h"
3334 #include "util.h"
3335 #include "form.h"
3336 #include "gv.h"
3337 #include "pad.h"
3338 #include "cv.h"
3339 #include "opnames.h"
3340 #include "op.h"
3341 #include "hv.h"
3342 #include "cop.h"
3343 #include "av.h"
3344 #include "mg.h"
3345 #include "scope.h"
3346 #include "warnings.h"
3347 #include "utf8.h"
3348
3349 /* these would be in doio.h if there was such a file */
3350 #define my_stat()  my_stat_flags(SV_GMAGIC)
3351 #define my_lstat() my_lstat_flags(SV_GMAGIC)
3352
3353 /* defined in sv.c, but also used in [ach]v.c */
3354 #undef _XPV_HEAD
3355 #undef _XPVMG_HEAD
3356 #undef _XPVCV_COMMON
3357
3358 typedef struct _sublex_info SUBLEXINFO;
3359 struct _sublex_info {
3360     U8 super_state;     /* lexer state to save */
3361     U16 sub_inwhat;     /* "lex_inwhat" to use */
3362     OP *sub_op;         /* "lex_op" to use */
3363     SV *repl;           /* replacement of s/// or y/// */
3364 };
3365
3366 #include "parser.h"
3367
3368 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
3369
3370 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3371
3372 /* These have to be predeclared, as they are used in proto.h which is #included
3373  * before their definitions in regcomp.h. */
3374
3375 struct scan_data_t;
3376 typedef struct regnode_charclass regnode_charclass;
3377
3378 struct regnode_charclass_class;
3379
3380 /* A hopefully less confusing name.  The sub-classes are all Posix classes only
3381  * used under /l matching */
3382 typedef struct regnode_charclass_class regnode_charclass_posixl;
3383
3384 typedef struct regnode_ssc regnode_ssc;
3385 typedef struct RExC_state_t RExC_state_t;
3386 struct _reg_trie_data;
3387
3388 #endif
3389
3390 struct ptr_tbl_ent {
3391     struct ptr_tbl_ent*         next;
3392     const void*                 oldval;
3393     void*                       newval;
3394 };
3395
3396 struct ptr_tbl {
3397     struct ptr_tbl_ent**        tbl_ary;
3398     UV                          tbl_max;
3399     UV                          tbl_items;
3400     struct ptr_tbl_arena        *tbl_arena;
3401     struct ptr_tbl_ent          *tbl_arena_next;
3402     struct ptr_tbl_ent          *tbl_arena_end;
3403 };
3404
3405 #if defined(htonl) && !defined(HAS_HTONL)
3406 #define HAS_HTONL
3407 #endif
3408 #if defined(htons) && !defined(HAS_HTONS)
3409 #define HAS_HTONS
3410 #endif
3411 #if defined(ntohl) && !defined(HAS_NTOHL)
3412 #define HAS_NTOHL
3413 #endif
3414 #if defined(ntohs) && !defined(HAS_NTOHS)
3415 #define HAS_NTOHS
3416 #endif
3417 #ifndef HAS_HTONL
3418 #define HAS_HTONS
3419 #define HAS_HTONL
3420 #define HAS_NTOHS
3421 #define HAS_NTOHL
3422 #  if (BYTEORDER & 0xffff) == 0x4321
3423 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
3424    re-order their values. However, to behave identically to the alternative
3425    implementations, they should truncate to the correct size.  */
3426 #    define ntohl(x)    ((x)&0xFFFFFFFF)
3427 #    define htonl(x)    ntohl(x)
3428 #    define ntohs(x)    ((x)&0xFFFF)
3429 #    define htons(x)    ntohs(x)
3430 #  elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3431
3432 /* Note that we can't straight out declare our own htonl and htons because
3433    the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
3434    to avoid the overhead of initialising the socket subsystem, but the headers
3435    that *declare* the various functions are still seen. If we declare our own
3436    htonl etc they will clash with the declarations in the Win32 headers.  */
3437
3438 PERL_STATIC_INLINE U32
3439 my_swap32(const U32 x) {
3440     return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)
3441         | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
3442 }
3443
3444 PERL_STATIC_INLINE U16
3445 my_swap16(const U16 x) {
3446     return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
3447 }
3448
3449 #    define htonl(x)    my_swap32(x)
3450 #    define ntohl(x)    my_swap32(x)
3451 #    define ntohs(x)    my_swap16(x)
3452 #    define htons(x)    my_swap16(x)
3453 #  else
3454 #    error "Unsupported byteorder"
3455 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
3456    the error message. Please check the value of the macro BYTEORDER, as defined
3457    in config.h. The values of BYTEORDER we expect are
3458
3459             big endian  little endian
3460    32 bit       0x4321  0x1234
3461    64 bit   0x87654321  0x12345678
3462
3463    If you have a system with a different byte order, please see
3464    pod/perlhack.pod for how to submit a patch to add supporting code.
3465 */
3466 #  endif
3467 #endif
3468
3469 /*
3470  * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
3471  * -DWS
3472  */
3473 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3474 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
3475    re-order their values. However, to behave identically to the alternative
3476    implementations, they should truncate to the correct size.  */
3477 #  define vtohl(x)      ((x)&0xFFFFFFFF)
3478 #  define vtohs(x)      ((x)&0xFFFF)
3479 #  define htovl(x)      vtohl(x)
3480 #  define htovs(x)      vtohs(x)
3481 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
3482 #  define vtohl(x)      ((((x)&0xFF)<<24)       \
3483                         +(((x)>>24)&0xFF)       \
3484                         +(((x)&0x0000FF00)<<8)  \
3485                         +(((x)&0x00FF0000)>>8)  )
3486 #  define vtohs(x)      ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
3487 #  define htovl(x)      vtohl(x)
3488 #  define htovs(x)      vtohs(x)
3489 #else
3490 #  error "Unsupported byteorder"
3491 /* If you have need for current perl on PDP-11 or similar, and can help test
3492    that blead keeps working on a mixed-endian system, then see
3493    pod/perlhack.pod for how to submit patches to things working again.  */
3494 #endif
3495
3496 /* *MAX Plus 1. A floating point value.
3497    Hopefully expressed in a way that dodgy floating point can't mess up.
3498    >> 2 rather than 1, so that value is safely less than I32_MAX after 1
3499    is added to it
3500    May find that some broken compiler will want the value cast to I32.
3501    [after the shift, as signed >> may not be as secure as unsigned >>]
3502 */
3503 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
3504 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
3505 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
3506    0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
3507    may be greater than sizeof(IV), so don't assume that half max UV is max IV.
3508 */
3509 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
3510
3511 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
3512 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
3513 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
3514
3515 /* This may look like unnecessary jumping through hoops, but converting
3516    out of range floating point values to integers *is* undefined behaviour,
3517    and it is starting to bite.
3518 */
3519 #ifndef CAST_INLINE
3520 #define I_32(what) (cast_i32((NV)(what)))
3521 #define U_32(what) (cast_ulong((NV)(what)))
3522 #define I_V(what) (cast_iv((NV)(what)))
3523 #define U_V(what) (cast_uv((NV)(what)))
3524 #else
3525 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
3526                   : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
3527                      : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
3528 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
3529                   : ((n) < U32_MAX_P1 ? (U32) (n) \
3530                      : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
3531 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
3532                   : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
3533                      : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
3534 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
3535                   : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
3536                      : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
3537 #endif
3538
3539 #define U_S(what) ((U16)U_32(what))
3540 #define U_I(what) ((unsigned int)U_32(what))
3541 #define U_L(what) U_32(what)
3542
3543 #ifdef HAS_SIGNBIT
3544 #  define Perl_signbit signbit
3545 #endif
3546
3547 /* These do not care about the fractional part, only about the range. */
3548 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
3549 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
3550
3551 /* Used with UV/IV arguments: */
3552                                         /* XXXX: need to speed it up */
3553 #define CLUMP_2UV(iv)   ((iv) < 0 ? 0 : (UV)(iv))
3554 #define CLUMP_2IV(uv)   ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
3555
3556 #ifndef MAXSYSFD
3557 #   define MAXSYSFD 2
3558 #endif
3559
3560 #ifndef __cplusplus
3561 #if !(defined(WIN32) || defined(UNDER_CE) || defined(SYMBIAN))
3562 Uid_t getuid (void);
3563 Uid_t geteuid (void);
3564 Gid_t getgid (void);
3565 Gid_t getegid (void);
3566 #endif
3567 #endif
3568
3569 #ifndef Perl_debug_log
3570 #  define Perl_debug_log        PerlIO_stderr()
3571 #endif
3572
3573 #ifndef Perl_error_log
3574 #  define Perl_error_log        (PL_stderrgv                    \
3575                                  && isGV(PL_stderrgv)           \
3576                                  && GvIOp(PL_stderrgv)          \
3577                                  && IoOFP(GvIOp(PL_stderrgv))   \
3578                                  ? IoOFP(GvIOp(PL_stderrgv))    \
3579                                  : PerlIO_stderr())
3580 #endif
3581
3582
3583 #define DEBUG_p_FLAG            0x00000001 /*      1 */
3584 #define DEBUG_s_FLAG            0x00000002 /*      2 */
3585 #define DEBUG_l_FLAG            0x00000004 /*      4 */
3586 #define DEBUG_t_FLAG            0x00000008 /*      8 */
3587 #define DEBUG_o_FLAG            0x00000010 /*     16 */
3588 #define DEBUG_c_FLAG            0x00000020 /*     32 */
3589 #define DEBUG_P_FLAG            0x00000040 /*     64 */
3590 #define DEBUG_m_FLAG            0x00000080 /*    128 */
3591 #define DEBUG_f_FLAG            0x00000100 /*    256 */
3592 #define DEBUG_r_FLAG            0x00000200 /*    512 */
3593 #define DEBUG_x_FLAG            0x00000400 /*   1024 */
3594 #define DEBUG_u_FLAG            0x00000800 /*   2048 */
3595 /* U is reserved for Unofficial, exploratory hacking */
3596 #define DEBUG_U_FLAG            0x00001000 /*   4096 */
3597 #define DEBUG_H_FLAG            0x00002000 /*   8192 */
3598 #define DEBUG_X_FLAG            0x00004000 /*  16384 */
3599 #define DEBUG_D_FLAG            0x00008000 /*  32768 */
3600 #define DEBUG_S_FLAG            0x00010000 /*  65536 */
3601 #define DEBUG_T_FLAG            0x00020000 /* 131072 */
3602 #define DEBUG_R_FLAG            0x00040000 /* 262144 */
3603 #define DEBUG_J_FLAG            0x00080000 /* 524288 */
3604 #define DEBUG_v_FLAG            0x00100000 /*1048576 */
3605 #define DEBUG_C_FLAG            0x00200000 /*2097152 */
3606 #define DEBUG_A_FLAG            0x00400000 /*4194304 */
3607 #define DEBUG_q_FLAG            0x00800000 /*8388608 */
3608 #define DEBUG_M_FLAG            0x01000000 /*16777216*/
3609 #define DEBUG_B_FLAG            0x02000000 /*33554432*/
3610 #define DEBUG_L_FLAG            0x04000000 /*67108864*/
3611 #define DEBUG_MASK              0x07FFEFFF /* mask of all the standard flags */
3612
3613 #define DEBUG_DB_RECURSE_FLAG   0x40000000
3614 #define DEBUG_TOP_FLAG          0x80000000 /* XXX what's this for ??? Signal
3615                                               that something was done? */
3616
3617 #  define DEBUG_p_TEST_ (PL_debug & DEBUG_p_FLAG)
3618 #  define DEBUG_s_TEST_ (PL_debug & DEBUG_s_FLAG)
3619 #  define DEBUG_l_TEST_ (PL_debug & DEBUG_l_FLAG)
3620 #  define DEBUG_t_TEST_ (PL_debug & DEBUG_t_FLAG)
3621 #  define DEBUG_o_TEST_ (PL_debug & DEBUG_o_FLAG)
3622 #  define DEBUG_c_TEST_ (PL_debug & DEBUG_c_FLAG)
3623 #  define DEBUG_P_TEST_ (PL_debug & DEBUG_P_FLAG)
3624 #  define DEBUG_m_TEST_ (PL_debug & DEBUG_m_FLAG)
3625 #  define DEBUG_f_TEST_ (PL_debug & DEBUG_f_FLAG)
3626 #  define DEBUG_r_TEST_ (PL_debug & DEBUG_r_FLAG)
3627 #  define DEBUG_x_TEST_ (PL_debug & DEBUG_x_FLAG)
3628 #  define DEBUG_u_TEST_ (PL_debug & DEBUG_u_FLAG)
3629 #  define DEBUG_U_TEST_ (PL_debug & DEBUG_U_FLAG)
3630 #  define DEBUG_H_TEST_ (PL_debug & DEBUG_H_FLAG)
3631 #  define DEBUG_X_TEST_ (PL_debug & DEBUG_X_FLAG)
3632 #  define DEBUG_D_TEST_ (PL_debug & DEBUG_D_FLAG)
3633 #  define DEBUG_S_TEST_ (PL_debug & DEBUG_S_FLAG)
3634 #  define DEBUG_T_TEST_ (PL_debug & DEBUG_T_FLAG)
3635 #  define DEBUG_R_TEST_ (PL_debug & DEBUG_R_FLAG)
3636 #  define DEBUG_J_TEST_ (PL_debug & DEBUG_J_FLAG)
3637 #  define DEBUG_v_TEST_ (PL_debug & DEBUG_v_FLAG)
3638 #  define DEBUG_C_TEST_ (PL_debug & DEBUG_C_FLAG)
3639 #  define DEBUG_A_TEST_ (PL_debug & DEBUG_A_FLAG)
3640 #  define DEBUG_q_TEST_ (PL_debug & DEBUG_q_FLAG)
3641 #  define DEBUG_M_TEST_ (PL_debug & DEBUG_M_FLAG)
3642 #  define DEBUG_B_TEST_ (PL_debug & DEBUG_B_FLAG)
3643 #  define DEBUG_L_TEST_ (PL_debug & DEBUG_L_FLAG)
3644 #  define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
3645 #  define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
3646 #  define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
3647
3648 #ifdef DEBUGGING
3649
3650 #  define DEBUG_p_TEST DEBUG_p_TEST_
3651 #  define DEBUG_s_TEST DEBUG_s_TEST_
3652 #  define DEBUG_l_TEST DEBUG_l_TEST_
3653 #  define DEBUG_t_TEST DEBUG_t_TEST_
3654 #  define DEBUG_o_TEST DEBUG_o_TEST_
3655 #  define DEBUG_c_TEST DEBUG_c_TEST_
3656 #  define DEBUG_P_TEST DEBUG_P_TEST_
3657 #  define DEBUG_m_TEST DEBUG_m_TEST_
3658 #  define DEBUG_f_TEST DEBUG_f_TEST_
3659 #  define DEBUG_r_TEST DEBUG_r_TEST_
3660 #  define DEBUG_x_TEST DEBUG_x_TEST_
3661 #  define DEBUG_u_TEST DEBUG_u_TEST_
3662 #  define DEBUG_U_TEST DEBUG_U_TEST_
3663 #  define DEBUG_H_TEST DEBUG_H_TEST_
3664 #  define DEBUG_X_TEST DEBUG_X_TEST_
3665 #  define DEBUG_D_TEST DEBUG_D_TEST_
3666 #  define DEBUG_S_TEST DEBUG_S_TEST_
3667 #  define DEBUG_T_TEST DEBUG_T_TEST_
3668 #  define DEBUG_R_TEST DEBUG_R_TEST_
3669 #  define DEBUG_J_TEST DEBUG_J_TEST_
3670 #  define DEBUG_v_TEST DEBUG_v_TEST_
3671 #  define DEBUG_C_TEST DEBUG_C_TEST_
3672 #  define DEBUG_A_TEST DEBUG_A_TEST_
3673 #  define DEBUG_q_TEST DEBUG_q_TEST_
3674 #  define DEBUG_M_TEST DEBUG_M_TEST_
3675 #  define DEBUG_B_TEST DEBUG_B_TEST_
3676 #  define DEBUG_L_TEST DEBUG_L_TEST_
3677 #  define DEBUG_Xv_TEST DEBUG_Xv_TEST_
3678 #  define DEBUG_Uv_TEST DEBUG_Uv_TEST_
3679 #  define DEBUG_Pv_TEST DEBUG_Pv_TEST_
3680
3681 #  define PERL_DEB(a)                  a
3682 #  define PERL_DEBUG(a) if (PL_debug)  a
3683 #  define DEBUG_p(a) if (DEBUG_p_TEST) a
3684 #  define DEBUG_s(a) if (DEBUG_s_TEST) a
3685 #  define DEBUG_l(a) if (DEBUG_l_TEST) a
3686 #  define DEBUG_t(a) if (DEBUG_t_TEST) a
3687 #  define DEBUG_o(a) if (DEBUG_o_TEST) a
3688 #  define DEBUG_c(a) if (DEBUG_c_TEST) a
3689 #  define DEBUG_P(a) if (DEBUG_P_TEST) a
3690
3691      /* Temporarily turn off memory debugging in case the a
3692       * does memory allocation, either directly or indirectly. */
3693 #  define DEBUG_m(a)  \
3694     STMT_START {                                                        \
3695         if (PERL_GET_INTERP) { dTHX; if (DEBUG_m_TEST) {PL_debug&=~DEBUG_m_FLAG; a; PL_debug|=DEBUG_m_FLAG;} } \
3696     } STMT_END
3697
3698 #  define DEBUG__(t, a) \
3699         STMT_START { \
3700                 if (t) STMT_START {a;} STMT_END; \
3701         } STMT_END
3702
3703 #  define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
3704 #ifndef PERL_EXT_RE_BUILD
3705 #  define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
3706 #else
3707 #  define DEBUG_r(a) STMT_START {a;} STMT_END
3708 #endif /* PERL_EXT_RE_BUILD */
3709 #  define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
3710 #  define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
3711 #  define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
3712 #  define DEBUG_H(a) DEBUG__(DEBUG_H_TEST, a)
3713 #  define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
3714 #  define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
3715 #  define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
3716 #  define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
3717 #  define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
3718
3719 #  define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
3720 #  define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
3721 #  define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
3722 #  define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
3723 #  define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
3724 #  define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
3725 #  define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
3726 #  define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
3727 #  define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
3728 #  define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
3729
3730 #else /* DEBUGGING */
3731
3732 #  define DEBUG_p_TEST (0)
3733 #  define DEBUG_s_TEST (0)
3734 #  define DEBUG_l_TEST (0)
3735 #  define DEBUG_t_TEST (0)
3736 #  define DEBUG_o_TEST (0)
3737 #  define DEBUG_c_TEST (0)
3738 #  define DEBUG_P_TEST (0)
3739 #  define DEBUG_m_TEST (0)
3740 #  define DEBUG_f_TEST (0)
3741 #  define DEBUG_r_TEST (0)
3742 #  define DEBUG_x_TEST (0)
3743 #  define DEBUG_u_TEST (0)
3744 #  define DEBUG_U_TEST (0)
3745 #  define DEBUG_H_TEST (0)
3746 #  define DEBUG_X_TEST (0)
3747 #  define DEBUG_D_TEST (0)
3748 #  define DEBUG_S_TEST (0)
3749 #  define DEBUG_T_TEST (0)
3750 #  define DEBUG_R_TEST (0)
3751 #  define DEBUG_J_TEST (0)
3752 #  define DEBUG_v_TEST (0)
3753 #  define DEBUG_C_TEST (0)
3754 #  define DEBUG_A_TEST (0)
3755 #  define DEBUG_q_TEST (0)
3756 #  define DEBUG_M_TEST (0)
3757 #  define DEBUG_B_TEST (0)
3758 #  define DEBUG_L_TEST (0)
3759 #  define DEBUG_Xv_TEST (0)
3760 #  define DEBUG_Uv_TEST (0)
3761 #  define DEBUG_Pv_TEST (0)
3762
3763 #  define PERL_DEB(a)
3764 #  define PERL_DEBUG(a)
3765 #  define DEBUG_p(a)
3766 #  define DEBUG_s(a)
3767 #  define DEBUG_l(a)
3768 #  define DEBUG_t(a)
3769 #  define DEBUG_o(a)
3770 #  define DEBUG_c(a)
3771 #  define DEBUG_P(a)
3772 #  define DEBUG_m(a)
3773 #  define DEBUG_f(a)
3774 #  define DEBUG_r(a)
3775 #  define DEBUG_x(a)
3776 #  define DEBUG_u(a)
3777 #  define DEBUG_U(a)
3778 #  define DEBUG_H(a)
3779 #  define DEBUG_X(a)
3780 #  define DEBUG_D(a)
3781 #  define DEBUG_S(a)
3782 #  define DEBUG_T(a)
3783 #  define DEBUG_R(a)
3784 #  define DEBUG_v(a)
3785 #  define DEBUG_C(a)
3786 #  define DEBUG_A(a)
3787 #  define DEBUG_q(a)
3788 #  define DEBUG_M(a)
3789 #  define DEBUG_B(a)
3790 #  define DEBUG_L(a)
3791 #  define DEBUG_Xv(a)
3792 #  define DEBUG_Uv(a)
3793 #  define DEBUG_Pv(a)
3794 #endif /* DEBUGGING */
3795
3796
3797 #define DEBUG_SCOPE(where) \
3798     DEBUG_l( \
3799     Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n",   \
3800                     where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
3801                     __FILE__, __LINE__));
3802
3803 /* Keep the old croak based assert for those who want it, and as a fallback if
3804    the platform is so heretically non-ANSI that it can't assert.  */
3805
3806 #define Perl_assert(what)       PERL_DEB(                               \
3807         ((what) ? ((void) 0) :                                          \
3808             (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
3809                         "\", line %d", STRINGIFY(what), __LINE__),      \
3810             (void) 0)))
3811
3812 #ifndef assert
3813 #  define assert(what)  Perl_assert(what)
3814 #endif
3815 #ifdef DEBUGGING
3816 #  define assert_(what) assert(what),
3817 #else
3818 #  define assert_(what)
3819 #endif
3820
3821 struct ufuncs {
3822     I32 (*uf_val)(pTHX_ IV, SV*);
3823     I32 (*uf_set)(pTHX_ IV, SV*);
3824     IV uf_index;
3825 };
3826
3827 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
3828  * XS code wanting to be backward compatible can do something
3829  * like the following:
3830
3831 #ifndef PERL_MG_UFUNC
3832 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
3833 #endif
3834
3835 static PERL_MG_UFUNC(foo_get, index, val)
3836 {
3837     sv_setsv(val, ...);
3838     return TRUE;
3839 }
3840
3841 -- Doug MacEachern
3842
3843 */
3844
3845 #ifndef PERL_MG_UFUNC
3846 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
3847 #endif
3848
3849 /* Fix these up for __STDC__ */
3850 #ifndef DONT_DECLARE_STD
3851 char *mktemp (char*);
3852 #ifndef atof
3853 double atof (const char*);
3854 #endif
3855 #endif
3856
3857 #ifndef STANDARD_C
3858 /* All of these are in stdlib.h or time.h for ANSI C */
3859 Time_t time();
3860 struct tm *gmtime(), *localtime();
3861 #if defined(OEMVS)
3862 char *(strchr)(), *(strrchr)();
3863 char *(strcpy)(), *(strcat)();
3864 #else
3865 char *strchr(), *strrchr();
3866 char *strcpy(), *strcat();
3867 #endif
3868 #endif /* ! STANDARD_C */
3869
3870
3871 #ifdef I_MATH
3872 #    include <math.h>
3873 #else
3874 START_EXTERN_C
3875             double exp (double);
3876             double log (double);
3877             double log10 (double);
3878             double sqrt (double);
3879             double frexp (double,int*);
3880             double ldexp (double,int);
3881             double modf (double,double*);
3882             double sin (double);
3883             double cos (double);
3884             double atan2 (double,double);
3885             double pow (double,double);
3886 END_EXTERN_C
3887 #endif
3888
3889 #if !defined(NV_INF) && defined(USE_LONG_DOUBLE) && defined(LDBL_INFINITY)
3890 #  define NV_INF LDBL_INFINITY
3891 #endif
3892 #if !defined(NV_INF) && defined(DBL_INFINITY)
3893 #  define NV_INF (NV)DBL_INFINITY
3894 #endif
3895 #if !defined(NV_INF) && defined(INFINITY)
3896 #  define NV_INF (NV)INFINITY
3897 #endif
3898 #if !defined(NV_INF) && defined(INF)
3899 #  define NV_INF (NV)INF
3900 #endif
3901 #if !defined(NV_INF) && defined(USE_LONG_DOUBLE) && defined(HUGE_VALL)
3902 #  define NV_INF (NV)HUGE_VALL
3903 #endif
3904 #if !defined(NV_INF) && defined(HUGE_VAL)
3905 #  define NV_INF (NV)HUGE_VAL
3906 #endif
3907
3908 #if !defined(NV_NAN) && defined(USE_LONG_DOUBLE)
3909 #   if !defined(NV_NAN) && defined(LDBL_NAN)
3910 #       define NV_NAN LDBL_NAN
3911 #   endif
3912 #   if !defined(NV_NAN) && defined(LDBL_QNAN)
3913 #       define NV_NAN LDBL_QNAN
3914 #   endif
3915 #   if !defined(NV_NAN) && defined(LDBL_SNAN)
3916 #       define NV_NAN LDBL_SNAN
3917 #   endif
3918 #endif
3919 #if !defined(NV_NAN) && defined(DBL_NAN)
3920 #  define NV_NAN (NV)DBL_NAN
3921 #endif
3922 #if !defined(NV_NAN) && defined(DBL_QNAN)
3923 #  define NV_NAN (NV)DBL_QNAN
3924 #endif
3925 #if !defined(NV_NAN) && defined(DBL_SNAN)
3926 #  define NV_NAN (NV)DBL_SNAN
3927 #endif
3928 #if !defined(NV_NAN) && defined(QNAN)
3929 #  define NV_NAN (NV)QNAN
3930 #endif
3931 #if !defined(NV_NAN) && defined(SNAN)
3932 #  define NV_NAN (NV)SNAN
3933 #endif
3934 #if !defined(NV_NAN) && defined(NAN)
3935 #  define NV_NAN (NV)NAN
3936 #endif
3937
3938 #ifndef __cplusplus
3939 #  if defined(NeXT) || defined(__NeXT__) /* or whatever catches all NeXTs */
3940 char *crypt ();       /* Maybe more hosts will need the unprototyped version */
3941 #  else
3942 #    if !defined(WIN32) && !defined(VMS)
3943 #ifndef crypt
3944 char *crypt (const char*, const char*);
3945 #endif
3946 #    endif /* !WIN32 */
3947 #  endif /* !NeXT && !__NeXT__ */
3948 #  ifndef DONT_DECLARE_STD
3949 #    ifndef getenv
3950 char *getenv (const char*);
3951 #    endif /* !getenv */
3952 #    if !defined(HAS_LSEEK_PROTO) && !defined(__hpux)
3953 #      ifdef _FILE_OFFSET_BITS
3954 #        if _FILE_OFFSET_BITS == 64
3955 Off_t lseek (int,Off_t,int);
3956 #        endif
3957 #      endif
3958 #    endif
3959 #  endif /* !DONT_DECLARE_STD */
3960 #  ifndef WIN32
3961 #    ifndef getlogin
3962 char *getlogin (void);
3963 #    endif
3964 #  endif /* !WIN32 */
3965 #endif /* !__cplusplus */
3966
3967 /* Fixme on VMS.  This needs to be a run-time, not build time options */
3968 /* Also rename() is affected by this */
3969 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
3970 #define UNLINK unlnk
3971 I32 unlnk (pTHX_ const char*);
3972 #else
3973 #define UNLINK PerlLIO_unlink
3974 #endif
3975
3976 /* some versions of glibc are missing the setresuid() proto */
3977 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
3978 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
3979 #endif
3980 /* some versions of glibc are missing the setresgid() proto */
3981 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
3982 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
3983 #endif
3984
3985 #ifndef HAS_SETREUID
3986 #  ifdef HAS_SETRESUID
3987 #    define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
3988 #    define HAS_SETREUID
3989 #  endif
3990 #endif
3991 #ifndef HAS_SETREGID
3992 #  ifdef HAS_SETRESGID
3993 #    define setregid(r,e) setresgid(r,e,(Gid_t)-1)
3994 #    define HAS_SETREGID
3995 #  endif
3996 #endif
3997
3998 /* Sighandler_t defined in iperlsys.h */
3999
4000 #ifdef HAS_SIGACTION
4001 typedef struct sigaction Sigsave_t;
4002 #else
4003 typedef Sighandler_t Sigsave_t;
4004 #endif
4005
4006 #define SCAN_DEF 0
4007 #define SCAN_TR 1
4008 #define SCAN_REPL 2
4009
4010 #ifdef DEBUGGING
4011 # ifndef register
4012 #  define register
4013 # endif
4014 # define RUNOPS_DEFAULT Perl_runops_debug
4015 #else
4016 # define RUNOPS_DEFAULT Perl_runops_standard
4017 #endif
4018
4019 #if defined(USE_PERLIO)
4020 EXTERN_C void PerlIO_teardown(void);
4021 # ifdef USE_ITHREADS
4022 #  define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4023 #  define PERLIO_TERM                           \
4024         STMT_START {                            \
4025                 PerlIO_teardown();              \
4026                 MUTEX_DESTROY(&PL_perlio_mutex);\
4027         } STMT_END
4028 # else
4029 #  define PERLIO_INIT
4030 #  define PERLIO_TERM   PerlIO_teardown()
4031 # endif
4032 #else
4033 #  define PERLIO_INIT
4034 #  define PERLIO_TERM
4035 #endif
4036
4037 #ifdef MYMALLOC
4038 #  ifdef MUTEX_INIT_CALLS_MALLOC
4039 #    define MALLOC_INIT                                 \
4040         STMT_START {                                    \
4041                 PL_malloc_mutex = NULL;                 \
4042                 MUTEX_INIT(&PL_malloc_mutex);           \
4043         } STMT_END
4044 #    define MALLOC_TERM                                 \
4045         STMT_START {                                    \
4046                 perl_mutex tmp = PL_malloc_mutex;       \
4047                 PL_malloc_mutex = NULL;                 \
4048                 MUTEX_DESTROY(&tmp);                    \
4049         } STMT_END
4050 #  else
4051 #    define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4052 #    define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4053 #  endif
4054 #else
4055 #  define MALLOC_INIT
4056 #  define MALLOC_TERM
4057 #endif
4058
4059 #if defined(PERL_IMPLICIT_CONTEXT)
4060
4061 struct perl_memory_debug_header;
4062 struct perl_memory_debug_header {
4063   tTHX  interpreter;
4064 #  if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4065   MEM_SIZE size;
4066 #  endif
4067   struct perl_memory_debug_header *prev;
4068   struct perl_memory_debug_header *next;
4069 #  ifdef PERL_DEBUG_READONLY_COW
4070   bool readonly;
4071 #  endif
4072 };
4073
4074 #elif defined(PERL_DEBUG_READONLY_COW)
4075
4076 struct perl_memory_debug_header;
4077 struct perl_memory_debug_header {
4078   MEM_SIZE size;
4079 };
4080
4081 #endif
4082
4083 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4084
4085 #  define PERL_MEMORY_DEBUG_HEADER_SIZE \
4086         (sizeof(struct perl_memory_debug_header) + \
4087         (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4088          %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4089
4090 #else
4091 #  define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4092 #endif
4093
4094 #ifdef PERL_TRACK_MEMPOOL
4095 # ifdef PERL_DEBUG_READONLY_COW
4096 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4097         STMT_START {                                            \
4098                 (header).interpreter = (interp);                \
4099                 (header).prev = (header).next = &(header);      \
4100                 (header).readonly = 0;                          \
4101         } STMT_END
4102 # else
4103 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4104         STMT_START {                                            \
4105                 (header).interpreter = (interp);                \
4106                 (header).prev = (header).next = &(header);      \
4107         } STMT_END
4108 # endif
4109 # else
4110 #  define INIT_TRACK_MEMPOOL(header, interp)
4111 #endif
4112
4113 #ifdef I_MALLOCMALLOC
4114 /* Needed for malloc_size(), malloc_good_size() on some systems */
4115 #  include <malloc/malloc.h>
4116 #endif
4117
4118 #ifdef MYMALLOC
4119 #  define Perl_safesysmalloc_size(where)        Perl_malloced_size(where)
4120 #else
4121 #  if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4122 #    ifdef PERL_TRACK_MEMPOOL
4123 #       define Perl_safesysmalloc_size(where)                   \
4124             (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4125 #    else
4126 #       define Perl_safesysmalloc_size(where) malloc_size(where)
4127 #    endif
4128 #  endif
4129 #  ifdef HAS_MALLOC_GOOD_SIZE
4130 #    ifdef PERL_TRACK_MEMPOOL
4131 #       define Perl_malloc_good_size(how_much)                  \
4132             (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4133 #    else
4134 #       define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4135 #    endif
4136 #  else
4137 /* Having this as the identity operation makes some code simpler.  */
4138 #       define Perl_malloc_good_size(how_much)  (how_much)
4139 #  endif
4140 #endif
4141
4142 typedef int (*runops_proc_t)(pTHX);
4143 typedef void (*share_proc_t) (pTHX_ SV *sv);
4144 typedef int  (*thrhook_proc_t) (pTHX);
4145 typedef OP* (*PPADDR_t[]) (pTHX);
4146 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4147 typedef void (*despatch_signals_proc_t) (pTHX);
4148
4149 /* NeXT has problems with crt0.o globals */
4150 #if defined(__DYNAMIC__) && \
4151     (defined(NeXT) || defined(__NeXT__) || defined(PERL_DARWIN))
4152 #  if defined(NeXT) || defined(__NeXT)
4153 #    include <mach-o/dyld.h>
4154 #    define environ (*environ_pointer)
4155 EXT char *** environ_pointer;
4156 #  else
4157 #    if defined(PERL_DARWIN) && defined(PERL_CORE)
4158 #      include <crt_externs.h>  /* for the env array */
4159 #      define environ (*_NSGetEnviron())
4160 #    endif
4161 #  endif
4162 #else
4163    /* VMS and some other platforms don't use the environ array */
4164 #  ifdef USE_ENVIRON_ARRAY
4165 #    if !defined(DONT_DECLARE_STD) || \
4166         (defined(__svr4__) && defined(__GNUC__) && defined(__sun)) || \
4167         defined(__sgi)
4168 extern char **  environ;        /* environment variables supplied via exec */
4169 #    endif
4170 #  endif
4171 #endif
4172
4173 #define PERL_PATCHLEVEL_H_IMPLICIT
4174 #include "patchlevel.h"
4175 #undef PERL_PATCHLEVEL_H_IMPLICIT
4176
4177 #define PERL_VERSION_STRING     STRINGIFY(PERL_REVISION) "." \
4178                                 STRINGIFY(PERL_VERSION) "." \
4179                                 STRINGIFY(PERL_SUBVERSION)
4180
4181 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4182                                 STRINGIFY(PERL_API_VERSION) "." \
4183                                 STRINGIFY(PERL_API_SUBVERSION)
4184
4185 START_EXTERN_C
4186
4187 /* handy constants */
4188 EXTCONST char PL_warn_uninit[]
4189   INIT("Use of uninitialized value%s%s%s");
4190 EXTCONST char PL_warn_uninit_sv[]
4191   INIT("Use of uninitialized value%" SVf "%s%s");
4192 EXTCONST char PL_warn_nosemi[]
4193   INIT("Semicolon seems to be missing");
4194 EXTCONST char PL_warn_reserved[]
4195   INIT("Unquoted string \"%s\" may clash with future reserved word");
4196 EXTCONST char PL_warn_nl[]
4197   INIT("Unsuccessful %s on filename containing newline");
4198 EXTCONST char PL_no_wrongref[]
4199   INIT("Can't use %s ref as %s ref");
4200 /* The core no longer needs these here. If you require the string constant,
4201    please inline a copy into your own code.  */
4202 EXTCONST char PL_no_symref[] __attribute__deprecated__
4203   INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4204 EXTCONST char PL_no_symref_sv[] __attribute__deprecated__
4205   INIT("Can't use string (\"%" SVf32 "\") as %s ref while \"strict refs\" in use");
4206 EXTCONST char PL_no_usym[]
4207   INIT("Can't use an undefined value as %s reference");
4208 EXTCONST char PL_no_aelem[]
4209   INIT("Modification of non-creatable array value attempted, subscript %d");
4210 EXTCONST char PL_no_helem_sv[]
4211   INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4212 EXTCONST char PL_no_modify[]
4213   INIT("Modification of a read-only value attempted");
4214 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4215   INIT("Out of memory!\n");
4216 EXTCONST char PL_no_security[]
4217   INIT("Insecure dependency in %s%s");
4218 EXTCONST char PL_no_sock_func[]
4219   INIT("Unsupported socket function \"%s\" called");
4220 EXTCONST char PL_no_dir_func[]
4221   INIT("Unsupported directory function \"%s\" called");
4222 EXTCONST char PL_no_func[]
4223   INIT("The %s function is unimplemented");
4224 EXTCONST char PL_no_myglob[]
4225   INIT("\"%s\" variable %s can't be in a package");
4226 EXTCONST char PL_no_localize_ref[]
4227   INIT("Can't localize through a reference");
4228 EXTCONST char PL_memory_wrap[]
4229   INIT("panic: memory wrap");
4230
4231 EXTCONST char PL_Yes[]
4232   INIT("1");
4233 EXTCONST char PL_No[]
4234   INIT("");
4235 EXTCONST char PL_hexdigit[]
4236   INIT("0123456789abcdef0123456789ABCDEF");
4237
4238 /* This is constant on most architectures, a global on OS/2 */
4239 #ifndef OS2
4240 EXTCONST char PL_sh_path[]
4241   INIT(SH_PATH); /* full path of shell */
4242 #endif
4243
4244 #ifdef CSH
4245 EXTCONST char PL_cshname[]
4246   INIT(CSH);
4247 #  define PL_cshlen     (sizeof(CSH "") - 1)
4248 #endif
4249
4250 /* These are baked at compile time into any shared perl library.
4251    In future releases this will allow us in main() to sanity test the
4252    library we're linking against.  */
4253
4254 EXTCONST U8 PL_revision
4255   INIT(PERL_REVISION);
4256 EXTCONST U8 PL_version
4257   INIT(PERL_VERSION);
4258 EXTCONST U8 PL_subversion
4259   INIT(PERL_SUBVERSION);
4260
4261 EXTCONST char PL_uuemap[65]
4262   INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4263
4264 #ifdef DOINIT
4265 EXTCONST char PL_uudmap[256] =
4266 #  ifdef PERL_MICRO
4267 #    include "uuudmap.h"
4268 #  else
4269 #    include "uudmap.h"
4270 #  endif
4271 ;
4272 EXTCONST char PL_bitcount[256] =
4273 #  ifdef PERL_MICRO
4274 #    include "ubitcount.h"
4275 #else
4276 #    include "bitcount.h"
4277 #  endif
4278 ;
4279 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4280 EXTCONST int         PL_sig_num[]  = { SIG_NUM };
4281 #else
4282 EXTCONST char PL_uudmap[256];
4283 EXTCONST char PL_bitcount[256];
4284 EXTCONST char* const PL_sig_name[];
4285 EXTCONST int         PL_sig_num[];
4286 #endif
4287
4288 /* fast conversion and case folding tables.  The folding tables complement the
4289  * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4290  * folds such as outside the range or to multiple characters. */
4291
4292 #ifdef DOINIT
4293 #ifndef EBCDIC
4294
4295 /* The EBCDIC fold table depends on the code page, and hence is found in
4296  * utfebcdic.h */
4297
4298 EXTCONST  unsigned char PL_fold[] = {
4299         0,      1,      2,      3,      4,      5,      6,      7,
4300         8,      9,      10,     11,     12,     13,     14,     15,
4301         16,     17,     18,     19,     20,     21,     22,     23,
4302         24,     25,     26,     27,     28,     29,     30,     31,
4303         32,     33,     34,     35,     36,     37,     38,     39,
4304         40,     41,     42,     43,     44,     45,     46,     47,
4305         48,     49,     50,     51,     52,     53,     54,     55,
4306         56,     57,     58,     59,     60,     61,     62,     63,
4307         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4308         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4309         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4310         'x',    'y',    'z',    91,     92,     93,     94,     95,
4311         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4312         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4313         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4314         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4315         128,    129,    130,    131,    132,    133,    134,    135,
4316         136,    137,    138,    139,    140,    141,    142,    143,
4317         144,    145,    146,    147,    148,    149,    150,    151,
4318         152,    153,    154,    155,    156,    157,    158,    159,
4319         160,    161,    162,    163,    164,    165,    166,    167,
4320         168,    169,    170,    171,    172,    173,    174,    175,
4321         176,    177,    178,    179,    180,    181,    182,    183,
4322         184,    185,    186,    187,    188,    189,    190,    191,
4323         192,    193,    194,    195,    196,    197,    198,    199,
4324         200,    201,    202,    203,    204,    205,    206,    207,
4325         208,    209,    210,    211,    212,    213,    214,    215,
4326         216,    217,    218,    219,    220,    221,    222,    223,
4327         224,    225,    226,    227,    228,    229,    230,    231,
4328         232,    233,    234,    235,    236,    237,    238,    239,
4329         240,    241,    242,    243,    244,    245,    246,    247,
4330         248,    249,    250,    251,    252,    253,    254,    255
4331 };
4332 EXTCONST  unsigned char PL_fold_latin1[] = {
4333     /* Full latin1 complement folding, except for three problematic code points:
4334      *  Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4335      *  fold complements outside the Latin1 range, so can't match something
4336      *  that isn't in utf8.
4337      *  German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4338      *  not one, so can't be represented in this table.
4339      *
4340      * All have to be specially handled */
4341         0,      1,      2,      3,      4,      5,      6,      7,
4342         8,      9,      10,     11,     12,     13,     14,     15,
4343         16,     17,     18,     19,     20,     21,     22,     23,
4344         24,     25,     26,     27,     28,     29,     30,     31,
4345         32,     33,     34,     35,     36,     37,     38,     39,
4346         40,     41,     42,     43,     44,     45,     46,     47,
4347         48,     49,     50,     51,     52,     53,     54,     55,
4348         56,     57,     58,     59,     60,     61,     62,     63,
4349         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4350         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4351         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4352         'x',    'y',    'z',    91,     92,     93,     94,     95,
4353         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4354         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4355         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4356         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4357         128,    129,    130,    131,    132,    133,    134,    135,
4358         136,    137,    138,    139,    140,    141,    142,    143,
4359         144,    145,    146,    147,    148,    149,    150,    151,
4360         152,    153,    154,    155,    156,    157,    158,    159,
4361         160,    161,    162,    163,    164,    165,    166,    167,
4362         168,    169,    170,    171,    172,    173,    174,    175,
4363         176,    177,    178,    179,    180,    181 /*micro */, 182,    183,
4364         184,    185,    186,    187,    188,    189,    190,    191,
4365         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4366         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4367         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4368         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
4369         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4370         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4371         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4372         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
4373         255 /* y with diaeresis */
4374 };
4375
4376 /* If these tables are accessed through ebcdic, the access will be converted to
4377  * latin1 first */
4378 EXTCONST  unsigned char PL_latin1_lc[] = {  /* lowercasing */
4379         0,      1,      2,      3,      4,      5,      6,      7,
4380         8,      9,      10,     11,     12,     13,     14,     15,
4381         16,     17,     18,     19,     20,     21,     22,     23,
4382         24,     25,     26,     27,     28,     29,     30,     31,
4383         32,     33,     34,     35,     36,     37,     38,     39,
4384         40,     41,     42,     43,     44,     45,     46,     47,
4385         48,     49,     50,     51,     52,     53,     54,     55,
4386         56,     57,     58,     59,     60,     61,     62,     63,
4387         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4388         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4389         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4390         'x',    'y',    'z',    91,     92,     93,     94,     95,
4391         96,     97,     98,     99,     100,    101,    102,    103,
4392         104,    105,    106,    107,    108,    109,    110,    111,
4393         112,    113,    114,    115,    116,    117,    118,    119,
4394         120,    121,    122,    123,    124,    125,    126,    127,
4395         128,    129,    130,    131,    132,    133,    134,    135,
4396         136,    137,    138,    139,    140,    141,    142,    143,
4397         144,    145,    146,    147,    148,    149,    150,    151,
4398         152,    153,    154,    155,    156,    157,    158,    159,
4399         160,    161,    162,    163,    164,    165,    166,    167,
4400         168,    169,    170,    171,    172,    173,    174,    175,
4401         176,    177,    178,    179,    180,    181,    182,    183,
4402         184,    185,    186,    187,    188,    189,    190,    191,
4403         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4404         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4405         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4406         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223,
4407         224,    225,    226,    227,    228,    229,    230,    231,
4408         232,    233,    234,    235,    236,    237,    238,    239,
4409         240,    241,    242,    243,    244,    245,    246,    247,
4410         248,    249,    250,    251,    252,    253,    254,    255
4411 };
4412
4413 /* upper and title case of latin1 characters, modified so that the three tricky
4414  * ones are mapped to 255 (which is one of the three) */
4415 EXTCONST  unsigned char PL_mod_latin1_uc[] = {
4416         0,      1,      2,      3,      4,      5,      6,      7,
4417         8,      9,      10,     11,     12,     13,     14,     15,
4418         16,     17,     18,     19,     20,     21,     22,     23,
4419         24,     25,     26,     27,     28,     29,     30,     31,
4420         32,     33,     34,     35,     36,     37,     38,     39,
4421         40,     41,     42,     43,     44,     45,     46,     47,
4422         48,     49,     50,     51,     52,     53,     54,     55,
4423         56,     57,     58,     59,     60,     61,     62,     63,
4424         64,     65,     66,     67,     68,     69,     70,     71,
4425         72,     73,     74,     75,     76,     77,     78,     79,
4426         80,     81,     82,     83,     84,     85,     86,     87,
4427         88,     89,     90,     91,     92,     93,     94,     95,
4428         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4429         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4430         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4431         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4432         128,    129,    130,    131,    132,    133,    134,    135,
4433         136,    137,    138,    139,    140,    141,    142,    143,
4434         144,    145,    146,    147,    148,    149,    150,    151,
4435         152,    153,    154,    155,    156,    157,    158,    159,
4436         160,    161,    162,    163,    164,    165,    166,    167,
4437         168,    169,    170,    171,    172,    173,    174,    175,
4438         176,    177,    178,    179,    180,    255 /*micro*/,  182,    183,
4439         184,    185,    186,    187,    188,    189,    190,    191,
4440         192,    193,    194,    195,    196,    197,    198,    199,
4441         200,    201,    202,    203,    204,    205,    206,    207,
4442         208,    209,    210,    211,    212,    213,    214,    215,
4443         216,    217,    218,    219,    220,    221,    222,    255 /*sharp s*/,
4444         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4445         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4446         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4447         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32, 255
4448 };
4449 #endif  /* !EBCDIC, but still in DOINIT */
4450 #else   /* ! DOINIT */
4451 #   ifndef EBCDIC
4452 EXTCONST unsigned char PL_fold[];
4453 EXTCONST unsigned char PL_fold_latin1[];
4454 EXTCONST unsigned char PL_mod_latin1_uc[];
4455 EXTCONST unsigned char PL_latin1_lc[];
4456 #   endif
4457 #endif
4458
4459 #ifndef PERL_GLOBAL_STRUCT /* or perlvars.h */
4460 #ifdef DOINIT
4461 EXT unsigned char PL_fold_locale[] = { /* Unfortunately not EXTCONST. */
4462         0,      1,      2,      3,      4,      5,      6,      7,
4463         8,      9,      10,     11,     12,     13,     14,     15,
4464         16,     17,     18,     19,     20,     21,     22,     23,
4465         24,     25,     26,     27,     28,     29,     30,     31,
4466         32,     33,     34,     35,     36,     37,     38,     39,
4467         40,     41,     42,     43,     44,     45,     46,     47,
4468         48,     49,     50,     51,     52,     53,     54,     55,
4469         56,     57,     58,     59,     60,     61,     62,     63,
4470         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4471         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4472         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4473         'x',    'y',    'z',    91,     92,     93,     94,     95,
4474         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4475         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4476         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4477         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4478         128,    129,    130,    131,    132,    133,    134,    135,
4479         136,    137,    138,    139,    140,    141,    142,    143,
4480         144,    145,    146,    147,    148,    149,    150,    151,
4481         152,    153,    154,    155,    156,    157,    158,    159,
4482         160,    161,    162,    163,    164,    165,    166,    167,
4483         168,    169,    170,    171,    172,    173,    174,    175,
4484         176,    177,    178,    179,    180,    181,    182,    183,
4485         184,    185,    186,    187,    188,    189,    190,    191,
4486         192,    193,    194,    195,    196,    197,    198,    199,
4487         200,    201,    202,    203,    204,    205,    206,    207,
4488         208,    209,    210,    211,    212,    213,    214,    215,
4489         216,    217,    218,    219,    220,    221,    222,    223,
4490         224,    225,    226,    227,    228,    229,    230,    231,
4491         232,    233,    234,    235,    236,    237,    238,    239,
4492         240,    241,    242,    243,    244,    245,    246,    247,
4493         248,    249,    250,    251,    252,    253,    254,    255
4494 };
4495 #else
4496 EXT unsigned char PL_fold_locale[]; /* Unfortunately not EXTCONST. */
4497 #endif
4498 #endif /* !PERL_GLOBAL_STRUCT */
4499
4500 #ifdef DOINIT
4501 #ifdef EBCDIC
4502 EXTCONST unsigned char PL_freq[] = {/* EBCDIC frequencies for mixed English/C */
4503     1,      2,      84,     151,    154,    155,    156,    157,
4504     165,    246,    250,    3,      158,    7,      18,     29,
4505     40,     51,     62,     73,     85,     96,     107,    118,
4506     129,    140,    147,    148,    149,    150,    152,    153,
4507     255,      6,      8,      9,     10,     11,     12,     13,
4508      14,     15,     24,     25,     26,     27,     28,    226,
4509      29,     30,     31,     32,     33,     43,     44,     45,
4510      46,     47,     48,     49,     50,     76,     77,     78,
4511      79,     80,     81,     82,     83,     84,     85,     86,
4512      87,     94,     95,    234,    181,    233,    187,    190,
4513     180,     96,     97,     98,     99,    100,    101,    102,
4514     104,    112,    182,    174,    236,    232,    229,    103,
4515     228,    226,    114,    115,    116,    117,    118,    119,
4516     120,    121,    122,    235,    176,    230,    194,    162,
4517     130,    131,    132,    133,    134,    135,    136,    137,
4518     138,    139,    201,    205,    163,    217,    220,    224,
4519     5,      248,    227,    244,    242,    255,    241,    231,
4520     240,    253,    16,     197,    19,     20,     21,     187,
4521     23,     169,    210,    245,    237,    249,    247,    239,
4522     168,    252,    34,     196,    36,     37,     38,     39,
4523     41,     42,     251,    254,    238,    223,    221,    213,
4524     225,    177,    52,     53,     54,     55,     56,     57,
4525     58,     59,     60,     61,     63,     64,     65,     66,
4526     67,     68,     69,     70,     71,     72,     74,     75,
4527     205,    208,    186,    202,    200,    218,    198,    179,
4528     178,    214,    88,     89,     90,     91,     92,     93,
4529     217,    166,    170,    207,    199,    209,    206,    204,
4530     160,    212,    105,    106,    108,    109,    110,    111,
4531     203,    113,    216,    215,    192,    175,    193,    243,
4532     172,    161,    123,    124,    125,    126,    127,    128,
4533     222,    219,    211,    195,    188,    193,    185,    184,
4534     191,    183,    141,    142,    143,    144,    145,    146
4535 };
4536 #else  /* ascii rather than ebcdic */
4537 EXTCONST unsigned char PL_freq[] = {    /* letter frequencies for mixed English/C */
4538         1,      2,      84,     151,    154,    155,    156,    157,
4539         165,    246,    250,    3,      158,    7,      18,     29,
4540         40,     51,     62,     73,     85,     96,     107,    118,
4541         129,    140,    147,    148,    149,    150,    152,    153,
4542         255,    182,    224,    205,    174,    176,    180,    217,
4543         233,    232,    236,    187,    235,    228,    234,    226,
4544         222,    219,    211,    195,    188,    193,    185,    184,
4545         191,    183,    201,    229,    181,    220,    194,    162,
4546         163,    208,    186,    202,    200,    218,    198,    179,
4547         178,    214,    166,    170,    207,    199,    209,    206,
4548         204,    160,    212,    216,    215,    192,    175,    173,
4549         243,    172,    161,    190,    203,    189,    164,    230,
4550         167,    248,    227,    244,    242,    255,    241,    231,
4551         240,    253,    169,    210,    245,    237,    249,    247,
4552         239,    168,    252,    251,    254,    238,    223,    221,
4553         213,    225,    177,    197,    171,    196,    159,    4,
4554         5,      6,      8,      9,      10,     11,     12,     13,
4555         14,     15,     16,     17,     19,     20,     21,     22,
4556         23,     24,     25,     26,     27,     28,     30,     31,
4557         32,     33,     34,     35,     36,     37,     38,     39,
4558         41,     42,     43,     44,     45,     46,     47,     48,
4559         49,     50,     52,     53,     54,     55,     56,     57,
4560         58,     59,     60,     61,     63,     64,     65,     66,
4561         67,     68,     69,     70,     71,     72,     74,     75,
4562         76,     77,     78,     79,     80,     81,     82,     83,
4563         86,     87,     88,     89,     90,     91,     92,     93,
4564         94,     95,     97,     98,     99,     100,    101,    102,
4565         103,    104,    105,    106,    108,    109,    110,    111,
4566         112,    113,    114,    115,    116,    117,    119,    120,
4567         121,    122,    123,    124,    125,    126,    127,    128,
4568         130,    131,    132,    133,    134,    135,    136,    137,
4569         138,    139,    141,    142,    143,    144,    145,    146
4570 };
4571 #endif
4572 #else
4573 EXTCONST unsigned char PL_freq[];
4574 #endif
4575
4576 /* Although only used for debugging, these constants must be available in
4577  * non-debugging builds too, since they're used in ext/re/re_exec.c,
4578  * which has DEBUGGING enabled always */
4579 #ifdef DOINIT
4580 EXTCONST char* const PL_block_type[] = {
4581         "NULL",
4582         "WHEN",
4583         "BLOCK",
4584         "GIVEN",
4585         "LOOP_FOR",
4586         "LOOP_PLAIN",
4587         "LOOP_LAZYSV",
4588         "LOOP_LAZYIV",
4589         "SUB",
4590         "FORMAT",
4591         "EVAL",
4592         "SUBST"
4593 };
4594 #else
4595 EXTCONST char* PL_block_type[];
4596 #endif
4597
4598 /* These are all the compile time options that affect binary compatibility.
4599    Other compile time options that are binary compatible are in perl.c
4600    Both are combined for the output of perl -V
4601    However, this string will be embedded in any shared perl library, which will
4602    allow us add a comparison check in perlmain.c in the near future.  */
4603 #ifdef DOINIT
4604 EXTCONST char PL_bincompat_options[] =
4605 #  ifdef DEBUG_LEAKING_SCALARS
4606                              " DEBUG_LEAKING_SCALARS"
4607 #  endif
4608 #  ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4609                              " DEBUG_LEAKING_SCALARS_FORK_DUMP"
4610 #  endif
4611 #  ifdef FCRYPT
4612                              " FCRYPT"
4613 #  endif
4614 #  ifdef HAS_TIMES
4615                              " HAS_TIMES"
4616 #  endif
4617 #  ifdef HAVE_INTERP_INTERN
4618                              " HAVE_INTERP_INTERN"
4619 #  endif
4620 #  ifdef MULTIPLICITY
4621                              " MULTIPLICITY"
4622 #  endif
4623 #  ifdef MYMALLOC
4624                              " MYMALLOC"
4625 #  endif
4626 #  ifdef PERLIO_LAYERS
4627                              " PERLIO_LAYERS"
4628 #  endif
4629 #  ifdef PERL_DEBUG_READONLY_COW
4630                              " PERL_DEBUG_READONLY_COW"
4631 #  endif
4632 #  ifdef PERL_DEBUG_READONLY_OPS
4633                              " PERL_DEBUG_READONLY_OPS"
4634 #  endif
4635 #  ifdef PERL_GLOBAL_STRUCT
4636                              " PERL_GLOBAL_STRUCT"
4637 #  endif
4638 #  ifdef PERL_IMPLICIT_CONTEXT
4639                              " PERL_IMPLICIT_CONTEXT"
4640 #  endif
4641 #  ifdef PERL_IMPLICIT_SYS
4642                              " PERL_IMPLICIT_SYS"
4643 #  endif
4644 #  ifdef PERL_MAD
4645                              " PERL_MAD"
4646 #  endif
4647 #  ifdef PERL_MICRO
4648                              " PERL_MICRO"
4649 #  endif
4650 #  ifdef PERL_NEED_APPCTX
4651                              " PERL_NEED_APPCTX"
4652 #  endif
4653 #  ifdef PERL_NEED_TIMESBASE
4654                              " PERL_NEED_TIMESBASE"
4655 #  endif
4656 #  ifdef PERL_OLD_COPY_ON_WRITE
4657                              " PERL_OLD_COPY_ON_WRITE"
4658 #  endif
4659 #  ifdef PERL_POISON
4660                              " PERL_POISON"
4661 #  endif
4662 #  ifdef PERL_SAWAMPERSAND
4663                              " PERL_SAWAMPERSAND"
4664 #  endif
4665 #  ifdef PERL_TRACK_MEMPOOL
4666                              " PERL_TRACK_MEMPOOL"
4667 #  endif
4668 #  ifdef PERL_USES_PL_PIDSTATUS
4669                              " PERL_USES_PL_PIDSTATUS"
4670 #  endif
4671 #  ifdef USE_64_BIT_ALL
4672                              " USE_64_BIT_ALL"
4673 #  endif
4674 #  ifdef USE_64_BIT_INT
4675                              " USE_64_BIT_INT"
4676 #  endif
4677 #  ifdef USE_IEEE
4678                              " USE_IEEE"
4679 #  endif
4680 #  ifdef USE_ITHREADS
4681                              " USE_ITHREADS"
4682 #  endif
4683 #  ifdef USE_LARGE_FILES
4684                              " USE_LARGE_FILES"
4685 #  endif
4686 #  ifdef USE_LOCALE_COLLATE
4687                              " USE_LOCALE_COLLATE"
4688 #  endif
4689 #  ifdef USE_LOCALE_NUMERIC
4690                              " USE_LOCALE_NUMERIC"
4691 #  endif
4692 #  ifdef USE_LONG_DOUBLE
4693                              " USE_LONG_DOUBLE"
4694 #  endif
4695 #  ifdef USE_PERLIO
4696                              " USE_PERLIO"
4697 #  endif
4698 #  ifdef USE_REENTRANT_API
4699                              " USE_REENTRANT_API"
4700 #  endif
4701 #  ifdef USE_SOCKS
4702                              " USE_SOCKS"
4703 #  endif
4704 #  ifdef VMS_DO_SOCKETS
4705                              " VMS_DO_SOCKETS"
4706 #  endif
4707 #  ifdef VMS_SHORTEN_LONG_SYMBOLS
4708                              " VMS_SHORTEN_LONG_SYMBOLS"
4709 #  endif
4710 #  ifdef VMS_WE_ARE_CASE_SENSITIVE
4711                              " VMS_SYMBOL_CASE_AS_IS"
4712 #  endif
4713   "";
4714 #else
4715 EXTCONST char PL_bincompat_options[];
4716 #endif
4717
4718 #ifndef PERL_SET_PHASE
4719 #  define PERL_SET_PHASE(new_phase) \
4720     PHASE_CHANGE_PROBE(PL_phase_names[new_phase], PL_phase_names[PL_phase]); \
4721     PL_phase = new_phase;
4722 #endif
4723
4724 /* The interpreter phases. If these ever change, PL_phase_names right below will
4725  * need to be updated accordingly. */
4726 enum perl_phase {
4727     PERL_PHASE_CONSTRUCT        = 0,
4728     PERL_PHASE_START            = 1,
4729     PERL_PHASE_CHECK            = 2,
4730     PERL_PHASE_INIT             = 3,
4731     PERL_PHASE_RUN              = 4,
4732     PERL_PHASE_END              = 5,
4733     PERL_PHASE_DESTRUCT         = 6
4734 };
4735
4736 #ifdef DOINIT
4737 EXTCONST char *const PL_phase_names[] = {
4738     "CONSTRUCT",
4739     "START",
4740     "CHECK",
4741     "INIT",
4742     "RUN",
4743     "END",
4744     "DESTRUCT"
4745 };
4746 #else
4747 EXTCONST char *const PL_phase_names[];
4748 #endif
4749
4750 #ifndef PERL_CORE
4751 /* Do not use this macro. It only exists for extensions that rely on PL_dirty
4752  * instead of using the newer PL_phase, which provides everything PL_dirty
4753  * provided, and more. */
4754 #  define PL_dirty (PL_phase == PERL_PHASE_DESTRUCT)
4755
4756 #  define PL_amagic_generation PL_na
4757 #endif /* !PERL_CORE */
4758
4759 #define PL_hints PL_compiling.cop_hints
4760
4761 END_EXTERN_C
4762
4763 /*****************************************************************************/
4764 /* This lexer/parser stuff is currently global since yacc is hard to reenter */
4765 /*****************************************************************************/
4766 /* XXX This needs to be revisited, since BEGIN makes yacc re-enter... */
4767
4768 #ifdef __Lynx__
4769 /* LynxOS defines these in scsi.h which is included via ioctl.h */
4770 #ifdef FORMAT
4771 #undef FORMAT
4772 #endif
4773 #ifdef SPACE
4774 #undef SPACE
4775 #endif
4776 #endif
4777
4778 #define LEX_NOTPARSING          11      /* borrowed from toke.c */
4779
4780 typedef enum {
4781     XOPERATOR,
4782     XTERM,
4783     XREF,
4784     XSTATE,
4785     XBLOCK,
4786     XATTRBLOCK,
4787     XATTRTERM,
4788     XTERMBLOCK,
4789     XPOSTDEREF,
4790     XTERMORDORDOR /* evil hack */
4791     /* update exp_name[] in toke.c if adding to this enum */
4792 } expectation;
4793
4794 /* Hints are now stored in a dedicated U32, so the bottom 8 bits are no longer
4795    special and there is no need for HINT_PRIVATE_MASK for COPs
4796    However, bitops store HINT_INTEGER in their op_private.
4797
4798     NOTE: The typical module using these has the bit value hard-coded, so don't
4799     blindly change the values of these.
4800
4801    If we run out of bits, the 2 locale ones could be combined.  The PARTIAL one
4802    is for "use locale 'FOO'" which excludes some categories.  It requires going
4803    to %^H to find out which are in and which are out.  This could be extended
4804    for the normal case of a plain HINT_LOCALE, so that %^H would be used for
4805    any locale form. */
4806 #define HINT_INTEGER            0x00000001 /* integer pragma */
4807 #define HINT_STRICT_REFS        0x00000002 /* strict pragma */
4808 #define HINT_LOCALE             0x00000004 /* locale pragma */
4809 #define HINT_BYTES              0x00000008 /* bytes pragma */
4810 #define HINT_LOCALE_PARTIAL     0x00000010 /* locale, but a subset of categories */
4811
4812 #define HINT_EXPLICIT_STRICT_REFS       0x00000020 /* strict.pm */
4813 #define HINT_EXPLICIT_STRICT_SUBS       0x00000040 /* strict.pm */
4814 #define HINT_EXPLICIT_STRICT_VARS       0x00000080 /* strict.pm */
4815
4816 #define HINT_BLOCK_SCOPE        0x00000100
4817 #define HINT_STRICT_SUBS        0x00000200 /* strict pragma */
4818 #define HINT_STRICT_VARS        0x00000400 /* strict pragma */
4819 #define HINT_UNI_8_BIT          0x00000800 /* unicode_strings feature */
4820
4821 /* The HINT_NEW_* constants are used by the overload pragma */
4822 #define HINT_NEW_INTEGER        0x00001000
4823 #define HINT_NEW_FLOAT          0x00002000
4824 #define HINT_NEW_BINARY         0x00004000
4825 #define HINT_NEW_STRING         0x00008000
4826 #define HINT_NEW_RE             0x00010000
4827 #define HINT_LOCALIZE_HH        0x00020000 /* %^H needs to be copied */
4828 #define HINT_LEXICAL_IO_IN      0x00040000 /* ${^OPEN} is set for input */
4829 #define HINT_LEXICAL_IO_OUT     0x00080000 /* ${^OPEN} is set for output */
4830
4831 #define HINT_RE_TAINT           0x00100000 /* re pragma */
4832 #define HINT_RE_EVAL            0x00200000 /* re pragma */
4833
4834 #define HINT_FILETEST_ACCESS    0x00400000 /* filetest pragma */
4835 #define HINT_UTF8               0x00800000 /* utf8 pragma */
4836
4837 #define HINT_NO_AMAGIC          0x01000000 /* overloading pragma */
4838
4839 #define HINT_RE_FLAGS           0x02000000 /* re '/xism' pragma */
4840
4841 #define HINT_FEATURE_MASK       0x1c000000 /* 3 bits for feature bundles */
4842
4843                                 /* Note: Used for NATIVE_HINTS, currently
4844                                    defined by vms/vmsish.h:
4845                                 0x40000000
4846                                 0x80000000
4847                                  */
4848
4849 /* The following are stored in $^H{sort}, not in PL_hints */
4850 #define HINT_SORT_SORT_BITS     0x000000FF /* allow 256 different ones */
4851 #define HINT_SORT_QUICKSORT     0x00000001
4852 #define HINT_SORT_MERGESORT     0x00000002
4853 #define HINT_SORT_STABLE        0x00000100 /* sort styles (currently one) */
4854
4855 /* flags for PL_sawampersand */
4856
4857 #define SAWAMPERSAND_LEFT       1   /* saw $` */
4858 #define SAWAMPERSAND_MIDDLE     2   /* saw $& */
4859 #define SAWAMPERSAND_RIGHT      4   /* saw $' */
4860
4861 #ifndef PERL_SAWAMPERSAND
4862 # define PL_sawampersand \
4863         (SAWAMPERSAND_LEFT|SAWAMPERSAND_MIDDLE|SAWAMPERSAND_RIGHT)
4864 #endif
4865
4866 /* Various states of the input record separator SV (rs) */
4867 #define RsSNARF(sv)   (! SvOK(sv))
4868 #define RsSIMPLE(sv)  (SvOK(sv) && (! SvPOK(sv) || SvCUR(sv)))
4869 #define RsPARA(sv)    (SvPOK(sv) && ! SvCUR(sv))
4870 #define RsRECORD(sv)  (SvROK(sv) && (SvIV(SvRV(sv)) > 0))
4871
4872 /* A struct for keeping various DEBUGGING related stuff,
4873  * neatly packed.  Currently only scratch variables for
4874  * constructing debug output are included.  Needed always,
4875  * not just when DEBUGGING, though, because of the re extension. c*/
4876 struct perl_debug_pad {
4877   SV pad[3];
4878 };
4879
4880 #define PERL_DEBUG_PAD(i)       &(PL_debug_pad.pad[i])
4881 #define PERL_DEBUG_PAD_ZERO(i)  (SvPVX(PERL_DEBUG_PAD(i))[0] = 0, \
4882         (((XPV*) SvANY(PERL_DEBUG_PAD(i)))->xpv_cur = 0), \
4883         PERL_DEBUG_PAD(i))
4884
4885 /* Enable variables which are pointers to functions */
4886 typedef void (*peep_t)(pTHX_ OP* o);
4887 typedef regexp* (*regcomp_t) (pTHX_ char* exp, char* xend, PMOP* pm);
4888 typedef I32     (*regexec_t) (pTHX_ regexp* prog, char* stringarg,
4889                                       char* strend, char* strbeg, I32 minend,
4890                                       SV* screamer, void* data, U32 flags);
4891 typedef char*   (*re_intuit_start_t) (pTHX_ regexp *prog, SV *sv,
4892                                                 char *strpos, char *strend,
4893                                                 U32 flags,
4894                                                 re_scream_pos_data *d);
4895 typedef SV*     (*re_intuit_string_t) (pTHX_ regexp *prog);
4896 typedef void    (*regfree_t) (pTHX_ struct regexp* r);
4897 typedef regexp* (*regdupe_t) (pTHX_ const regexp* r, CLONE_PARAMS *param);
4898 typedef I32     (*re_fold_t)(const char *, char const *, I32);
4899
4900 typedef void (*DESTRUCTORFUNC_NOCONTEXT_t) (void*);
4901 typedef void (*DESTRUCTORFUNC_t) (pTHX_ void*);
4902 typedef void (*SVFUNC_t) (pTHX_ SV* const);
4903 typedef I32  (*SVCOMPARE_t) (pTHX_ SV* const, SV* const);
4904 typedef void (*XSINIT_t) (pTHX);
4905 typedef void (*ATEXIT_t) (pTHX_ void*);
4906 typedef void (*XSUBADDR_t) (pTHX_ CV *);
4907
4908 typedef OP* (*Perl_ppaddr_t)(pTHX);
4909 typedef OP* (*Perl_check_t) (pTHX_ OP*);
4910 typedef void(*Perl_ophook_t)(pTHX_ OP*);
4911 typedef int (*Perl_keyword_plugin_t)(pTHX_ char*, STRLEN, OP**);
4912 typedef void(*Perl_cpeep_t)(pTHX_ OP *, OP *);
4913
4914 typedef void(*globhook_t)(pTHX);
4915
4916 #define KEYWORD_PLUGIN_DECLINE 0
4917 #define KEYWORD_PLUGIN_STMT    1
4918 #define KEYWORD_PLUGIN_EXPR    2
4919
4920 /* Interpreter exitlist entry */
4921 typedef struct exitlistentry {
4922     void (*fn) (pTHX_ void*);
4923     void *ptr;
4924 } PerlExitListEntry;
4925
4926 /* if you only have signal() and it resets on each signal, FAKE_PERSISTENT_SIGNAL_HANDLERS fixes */
4927 /* These have to be before perlvars.h */
4928 #if !defined(HAS_SIGACTION) && defined(VMS)
4929 #  define  FAKE_PERSISTENT_SIGNAL_HANDLERS
4930 #endif
4931 /* if we're doing kill() with sys$sigprc on VMS, FAKE_DEFAULT_SIGNAL_HANDLERS */
4932 #if defined(KILL_BY_SIGPRC)
4933 #  define  FAKE_DEFAULT_SIGNAL_HANDLERS
4934 #endif
4935
4936 #if !defined(MULTIPLICITY)
4937
4938 struct interpreter {
4939     char broiled;
4940 };
4941
4942 #else
4943
4944 /* If we have multiple interpreters define a struct
4945    holding variables which must be per-interpreter
4946    If we don't have threads anything that would have
4947    be per-thread is per-interpreter.
4948 */
4949
4950 /* Set up PERLVAR macros for populating structs */
4951 #  define PERLVAR(prefix,var,type) type prefix##var;
4952
4953 /* 'var' is an array of length 'n' */
4954 #  define PERLVARA(prefix,var,n,type) type prefix##var[n];
4955
4956 /* initialize 'var' to init' */
4957 #  define PERLVARI(prefix,var,type,init) type prefix##var;
4958
4959 /* like PERLVARI, but make 'var' a const */
4960 #  define PERLVARIC(prefix,var,type,init) type prefix##var;
4961
4962 struct interpreter {
4963 #  include "intrpvar.h"
4964 };
4965
4966 EXTCONST U16 PL_interp_size
4967   INIT(sizeof(struct interpreter));
4968
4969 #  define PERL_INTERPRETER_SIZE_UPTO_MEMBER(member)                     \
4970     STRUCT_OFFSET(struct interpreter, member) +                         \
4971     sizeof(((struct interpreter*)0)->member)
4972
4973 /* This will be useful for subsequent releases, because this has to be the
4974    same in your libperl as in main(), else you have a mismatch and must abort.
4975 */
4976 EXTCONST U16 PL_interp_size_5_18_0
4977   INIT(PERL_INTERPRETER_SIZE_UPTO_MEMBER(PERL_LAST_5_18_0_INTERP_MEMBER));
4978
4979
4980 #  ifdef PERL_GLOBAL_STRUCT
4981 /* MULTIPLICITY is automatically defined when PERL_GLOBAL_STRUCT is defined,
4982    hence it's safe and sane to nest this within #ifdef MULTIPLICITY  */
4983
4984 struct perl_vars {
4985 #    include "perlvars.h"
4986 };
4987
4988 EXTCONST U16 PL_global_struct_size
4989   INIT(sizeof(struct perl_vars));
4990
4991 #    ifdef PERL_CORE
4992 #      ifndef PERL_GLOBAL_STRUCT_PRIVATE
4993 EXT struct perl_vars PL_Vars;
4994 EXT struct perl_vars *PL_VarsPtr INIT(&PL_Vars);
4995 #        undef PERL_GET_VARS
4996 #        define PERL_GET_VARS() PL_VarsPtr
4997 #      endif /* !PERL_GLOBAL_STRUCT_PRIVATE */
4998 #    else /* PERL_CORE */
4999 #      if !defined(__GNUC__) || !defined(WIN32)
5000 EXT
5001 #      endif /* WIN32 */
5002 struct perl_vars *PL_VarsPtr;
5003 #      define PL_Vars (*((PL_VarsPtr) \
5004                        ? PL_VarsPtr : (PL_VarsPtr = Perl_GetVars(aTHX))))
5005 #    endif /* PERL_CORE */
5006 #  endif /* PERL_GLOBAL_STRUCT */
5007
5008 /* Done with PERLVAR macros for now ... */
5009 #  undef PERLVAR
5010 #  undef PERLVARA
5011 #  undef PERLVARI
5012 #  undef PERLVARIC
5013
5014 #endif /* MULTIPLICITY */
5015
5016 struct tempsym; /* defined in pp_pack.c */
5017
5018 #include "thread.h"
5019 #include "pp.h"
5020
5021 #ifndef PERL_CALLCONV
5022 #  ifdef __cplusplus
5023 #    define PERL_CALLCONV extern "C"
5024 #  else
5025 #    define PERL_CALLCONV
5026 #  endif
5027 #endif
5028 #ifndef PERL_CALLCONV_NO_RET
5029 #    define PERL_CALLCONV_NO_RET PERL_CALLCONV
5030 #endif
5031
5032 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
5033    dont have a noreturn as a declaration specifier
5034 */
5035 #ifndef PERL_STATIC_NO_RET
5036 #  define PERL_STATIC_NO_RET STATIC
5037 #endif
5038 /* PERL_STATIC_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE on
5039    builds that dont have a noreturn as a declaration specifier
5040 */
5041 #ifndef PERL_STATIC_INLINE_NO_RET
5042 #  define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
5043 #endif
5044
5045
5046 #undef PERL_CKDEF
5047 #undef PERL_PPDEF
5048 #define PERL_CKDEF(s)   PERL_CALLCONV OP *s (pTHX_ OP *o);
5049 #define PERL_PPDEF(s)   PERL_CALLCONV OP *s (pTHX);
5050
5051 #ifdef MYMALLOC
5052 #  include "malloc_ctl.h"
5053 #endif
5054
5055 #include "proto.h"
5056
5057 /* this has structure inits, so it cannot be included before here */
5058 #include "opcode.h"
5059
5060 /* The following must follow proto.h as #defines mess up syntax */
5061
5062 #if !defined(PERL_FOR_X2P)
5063 #  include "embedvar.h"
5064 #endif
5065 #ifndef PERL_MAD
5066 #  undef PL_madskills
5067 #  undef PL_xmlfp
5068 #  define PL_madskills 0
5069 #  define PL_xmlfp 0
5070 #endif
5071
5072 /* Now include all the 'global' variables
5073  * If we don't have threads or multiple interpreters
5074  * these include variables that would have been their struct-s
5075  */
5076
5077 #define PERLVAR(prefix,var,type) EXT type PL_##var;
5078 #define PERLVARA(prefix,var,n,type) EXT type PL_##var[n];
5079 #define PERLVARI(prefix,var,type,init) EXT type  PL_##var INIT(init);
5080 #define PERLVARIC(prefix,var,type,init) EXTCONST type PL_##var INIT(init);
5081
5082 #if !defined(MULTIPLICITY)
5083 START_EXTERN_C
5084 #  include "intrpvar.h"
5085 END_EXTERN_C
5086 #endif
5087
5088 #ifdef PERL_CORE
5089 /* All core uses now exterminated. Ensure no zombies can return:  */
5090 #  undef PL_na
5091 #endif
5092
5093 /* Now all the config stuff is setup we can include embed.h
5094    In particular, need the relevant *ish file included already, as it may
5095    define HAVE_INTERP_INTERN  */
5096 #include "embed.h"
5097 #ifndef PERL_MAD
5098 #  undef op_getmad
5099 #  define op_getmad(arg,pegop,slot) NOOP
5100 #endif
5101
5102 #ifndef PERL_GLOBAL_STRUCT
5103 START_EXTERN_C
5104
5105 #  include "perlvars.h"
5106
5107 END_EXTERN_C
5108 #endif
5109
5110 #undef PERLVAR
5111 #undef PERLVARA
5112 #undef PERLVARI
5113 #undef PERLVARIC
5114
5115 START_EXTERN_C
5116
5117 /* dummy variables that hold pointers to both runops functions, thus forcing
5118  * them *both* to get linked in (useful for Peek.xs, debugging etc) */
5119
5120 EXTCONST runops_proc_t PL_runops_std
5121   INIT(Perl_runops_standard);
5122 EXTCONST runops_proc_t PL_runops_dbg
5123   INIT(Perl_runops_debug);
5124
5125 /* PERL_GLOBAL_STRUCT_PRIVATE wants to keep global data like the
5126  * magic vtables const, but this is incompatible with SWIG which
5127  * does want to modify the vtables. */
5128 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
5129 #  define EXT_MGVTBL EXTCONST MGVTBL
5130 #else
5131 #  define EXT_MGVTBL EXT MGVTBL
5132 #endif
5133
5134 #define PERL_MAGIC_READONLY_ACCEPTABLE 0x40
5135 #define PERL_MAGIC_VALUE_MAGIC 0x80
5136 #define PERL_MAGIC_VTABLE_MASK 0x3F
5137 #define PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(t) \
5138     (PL_magic_data[(U8)(t)] & PERL_MAGIC_READONLY_ACCEPTABLE)
5139 #define PERL_MAGIC_TYPE_IS_VALUE_MAGIC(t) \
5140     (PL_magic_data[(U8)(t)] & PERL_MAGIC_VALUE_MAGIC)
5141
5142 #include "mg_vtable.h"
5143
5144 #ifdef DOINIT
5145 EXTCONST U8 PL_magic_data[256] =
5146 #  ifdef PERL_MICRO
5147 #    include "umg_data.h"
5148 #  else
5149 #    include "mg_data.h"
5150 #  endif
5151 ;
5152 #else
5153 EXTCONST U8 PL_magic_data[256];
5154 #endif
5155
5156 #ifdef DOINIT
5157                         /* NL IV NV PV INV PI PN MG RX GV LV AV HV CV FM IO */
5158 EXTCONST bool
5159 PL_valid_types_IVX[]    = { 0, 1, 0, 0, 0, 1, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5160 EXTCONST bool
5161 PL_valid_types_NVX[]    = { 0, 0, 1, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5162 EXTCONST bool
5163 PL_valid_types_PVX[]    = { 0, 0, 0, 1, 1, 1, 1, 1, 0, 1, 1, 0, 0, 1, 1, 1 };
5164 EXTCONST bool
5165 PL_valid_types_RV[]     = { 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1 };
5166 EXTCONST bool
5167 PL_valid_types_IV_set[] = { 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1 };
5168 EXTCONST bool
5169 PL_valid_types_NV_set[] = { 0, 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0 };
5170
5171 #else
5172
5173 EXTCONST bool PL_valid_types_IVX[];
5174 EXTCONST bool PL_valid_types_NVX[];
5175 EXTCONST bool PL_valid_types_PVX[];
5176 EXTCONST bool PL_valid_types_RV[];
5177 EXTCONST bool PL_valid_types_IV_set[];
5178 EXTCONST bool PL_valid_types_NV_set[];
5179
5180 #endif
5181
5182
5183 /* if these never got defined, they need defaults */
5184 #ifndef PERL_SET_CONTEXT
5185 #  define PERL_SET_CONTEXT(i)           PERL_SET_INTERP(i)
5186 #endif
5187
5188 #ifndef PERL_GET_CONTEXT
5189 #  define PERL_GET_CONTEXT              PERL_GET_INTERP
5190 #endif
5191
5192 #ifndef PERL_GET_THX
5193 #  define PERL_GET_THX                  ((void*)NULL)
5194 #endif
5195
5196 #ifndef PERL_SET_THX
5197 #  define PERL_SET_THX(t)               NOOP
5198 #endif
5199
5200
5201 #ifndef PERL_NO_INLINE_FUNCTIONS
5202 /* Static inline funcs that depend on includes and declarations above.
5203    Some of these reference functions in the perl object files, and some
5204    compilers aren't smart enough to eliminate unused static inline
5205    functions, so including this file in source code can cause link errors
5206    even if the source code uses none of the functions. Hence including these
5207    can be be suppressed by setting PERL_NO_INLINE_FUNCTIONS. Doing this will
5208    (obviously) result in unworkable XS code, but allows simple probing code
5209    to continue to work, because it permits tests to include the perl headers
5210    for definitions without creating a link dependency on the perl library
5211    (which may not exist yet).
5212 */
5213
5214 #  include "inline.h"
5215 #endif
5216
5217 #include "overload.h"
5218
5219 END_EXTERN_C
5220
5221 struct am_table {
5222   U8 flags;
5223   U8 fallback;
5224   U16 spare;
5225   U32 was_ok_sub;
5226   CV* table[NofAMmeth];
5227 };
5228 struct am_table_short {
5229   U8 flags;
5230   U8 fallback;
5231   U16 spare;
5232   U32 was_ok_sub;
5233 };
5234 typedef struct am_table AMT;
5235 typedef struct am_table_short AMTS;
5236
5237 #define AMGfallNEVER    1
5238 #define AMGfallNO       2
5239 #define AMGfallYES      3
5240
5241 #define AMTf_AMAGIC             1
5242 #define AMT_AMAGIC(amt)         ((amt)->flags & AMTf_AMAGIC)
5243 #define AMT_AMAGIC_on(amt)      ((amt)->flags |= AMTf_AMAGIC)
5244 #define AMT_AMAGIC_off(amt)     ((amt)->flags &= ~AMTf_AMAGIC)
5245
5246 #define StashHANDLER(stash,meth)        gv_handler((stash),CAT2(meth,_amg))
5247
5248 /*
5249  * some compilers like to redefine cos et alia as faster
5250  * (and less accurate?) versions called F_cos et cetera (Quidquid
5251  * latine dictum sit, altum viditur.)  This trick collides with
5252  * the Perl overloading (amg).  The following #defines fool both.
5253  */
5254
5255 #ifdef _FASTMATH
5256 #   ifdef atan2
5257 #       define F_atan2_amg  atan2_amg
5258 #   endif
5259 #   ifdef cos
5260 #       define F_cos_amg    cos_amg
5261 #   endif
5262 #   ifdef exp
5263 #       define F_exp_amg    exp_amg
5264 #   endif
5265 #   ifdef log
5266 #       define F_log_amg    log_amg
5267 #   endif
5268 #   ifdef pow
5269 #       define F_pow_amg    pow_amg
5270 #   endif
5271 #   ifdef sin
5272 #       define F_sin_amg    sin_amg
5273 #   endif
5274 #   ifdef sqrt
5275 #       define F_sqrt_amg   sqrt_amg
5276 #   endif
5277 #endif /* _FASTMATH */
5278
5279 #define PERLDB_ALL              (PERLDBf_SUB    | PERLDBf_LINE  |       \
5280                                  PERLDBf_NOOPT  | PERLDBf_INTER |       \
5281                                  PERLDBf_SUBLINE| PERLDBf_SINGLE|       \
5282                                  PERLDBf_NAMEEVAL| PERLDBf_NAMEANON |   \
5283                                  PERLDBf_SAVESRC)
5284                                         /* No _NONAME, _GOTO */
5285 #define PERLDBf_SUB             0x01    /* Debug sub enter/exit */
5286 #define PERLDBf_LINE            0x02    /* Keep line # */
5287 #define PERLDBf_NOOPT           0x04    /* Switch off optimizations */
5288 #define PERLDBf_INTER           0x08    /* Preserve more data for
5289                                            later inspections  */
5290 #define PERLDBf_SUBLINE         0x10    /* Keep subr source lines */
5291 #define PERLDBf_SINGLE          0x20    /* Start with single-step on */
5292 #define PERLDBf_NONAME          0x40    /* For _SUB: no name of the subr */
5293 #define PERLDBf_GOTO            0x80    /* Report goto: call DB::goto */
5294 #define PERLDBf_NAMEEVAL        0x100   /* Informative names for evals */
5295 #define PERLDBf_NAMEANON        0x200   /* Informative names for anon subs */
5296 #define PERLDBf_SAVESRC         0x400   /* Save source lines into @{"_<$filename"} */
5297 #define PERLDBf_SAVESRC_NOSUBS  0x800   /* Including evals that generate no subroutines */
5298 #define PERLDBf_SAVESRC_INVALID 0x1000  /* Save source that did not compile */
5299
5300 #define PERLDB_SUB      (PL_perldb && (PL_perldb & PERLDBf_SUB))
5301 #define PERLDB_LINE     (PL_perldb && (PL_perldb & PERLDBf_LINE))
5302 #define PERLDB_NOOPT    (PL_perldb && (PL_perldb & PERLDBf_NOOPT))
5303 #define PERLDB_INTER    (PL_perldb && (PL_perldb & PERLDBf_INTER))
5304 #define PERLDB_SUBLINE  (PL_perldb && (PL_perldb & PERLDBf_SUBLINE))
5305 #define PERLDB_SINGLE   (PL_perldb && (PL_perldb & PERLDBf_SINGLE))
5306 #define PERLDB_SUB_NN   (PL_perldb && (PL_perldb & (PERLDBf_NONAME)))
5307 #define PERLDB_GOTO     (PL_perldb && (PL_perldb & PERLDBf_GOTO))
5308 #define PERLDB_NAMEEVAL (PL_perldb && (PL_perldb & PERLDBf_NAMEEVAL))
5309 #define PERLDB_NAMEANON (PL_perldb && (PL_perldb & PERLDBf_NAMEANON))
5310 #define PERLDB_SAVESRC  (PL_perldb && (PL_perldb & PERLDBf_SAVESRC))
5311 #define PERLDB_SAVESRC_NOSUBS   (PL_perldb && (PL_perldb & PERLDBf_SAVESRC_NOSUBS))
5312 #define PERLDB_SAVESRC_INVALID  (PL_perldb && (PL_perldb & PERLDBf_SAVESRC_INVALID))
5313
5314 /* These locale things are all subject to change */
5315 /* Returns TRUE if the plain locale pragma without a parameter is in effect
5316  */
5317 #define IN_LOCALE_RUNTIME       cBOOL(CopHINTS_get(PL_curcop) & HINT_LOCALE)
5318
5319 /* Returns TRUE if either form of the locale pragma is in effect */
5320 #define IN_SOME_LOCALE_FORM_RUNTIME   \
5321            cBOOL(CopHINTS_get(PL_curcop) & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
5322
5323 #define IN_LOCALE_COMPILETIME   cBOOL(PL_hints & HINT_LOCALE)
5324 #define IN_SOME_LOCALE_FORM_COMPILETIME \
5325                           cBOOL(PL_hints & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
5326
5327 #define IN_LOCALE \
5328         (IN_PERL_COMPILETIME ? IN_LOCALE_COMPILETIME : IN_LOCALE_RUNTIME)
5329 #define IN_SOME_LOCALE_FORM \
5330         (IN_PERL_COMPILETIME ? IN_SOME_LOCALE_FORM_COMPILETIME \
5331                              : IN_SOME_LOCALE_FORM_RUNTIME)
5332
5333 #define IN_LC_ALL_COMPILETIME   IN_LOCALE_COMPILETIME
5334 #define IN_LC_ALL_RUNTIME       IN_LOCALE_RUNTIME
5335
5336 #define IN_LC_PARTIAL_COMPILETIME   cBOOL(PL_hints & HINT_LOCALE_PARTIAL)
5337 #define IN_LC_PARTIAL_RUNTIME       cBOOL(CopHINTS_get(PL_curcop) & HINT_LOCALE_PARTIAL)
5338
5339 #define IN_LC_COMPILETIME(category)     (IN_LC_ALL_COMPILETIME || (IN_LC_PARTIAL_COMPILETIME && _is_in_locale_category(TRUE, (category))))
5340 #define IN_LC_RUNTIME(category)         (IN_LC_ALL_RUNTIME || (IN_LC_PARTIAL_RUNTIME && _is_in_locale_category(FALSE, (category))))
5341 #define IN_LC(category)                 (IN_LC_COMPILETIME(category) || IN_LC_RUNTIME(category))
5342
5343 #ifdef USE_LOCALE_NUMERIC
5344
5345 /* These macros are for toggling between the underlying locale (LOCAL) and the
5346  * C locale. */
5347
5348 /* The first set makes sure that the locale is set to C unless within a 'use
5349  * locale's scope; otherwise to the default locale.  A function pointer is
5350  * used, which can be declared separately by
5351  * DECLARATION_FOR_STORE_LC_NUMERIC_SET_TO_NEEDED, followed by the actual
5352  * setting (using STORE_LC_NUMERIC_SET_TO_NEEDED()), or the two can be combined
5353  * into one call DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED().
5354  * RESTORE_LC_NUMERIC() in all cases restores the locale to what it was before
5355  * these were called */
5356
5357 #define _NOT_IN_NUMERIC_STANDARD (! PL_numeric_standard)
5358
5359 /* We can lock the category to stay in the C locale, making requests to the
5360  * contrary noops, in the dynamic scope by setting PL_numeric_standard to 2 */
5361 #define _NOT_IN_NUMERIC_LOCAL    (! PL_numeric_local && PL_numeric_standard < 2)
5362
5363 #define DECLARATION_FOR_STORE_LC_NUMERIC_SET_TO_NEEDED                       \
5364     void (*_restore_LC_NUMERIC_function)(pTHX) = NULL;
5365
5366 #define STORE_LC_NUMERIC_SET_TO_NEEDED()                                     \
5367     if (IN_LC(LC_NUMERIC)) {                                                 \
5368         if (_NOT_IN_NUMERIC_LOCAL) {                                         \
5369             set_numeric_local();                                             \
5370             _restore_LC_NUMERIC_function = &Perl_set_numeric_standard;       \
5371         }                                                                    \
5372     }                                                                        \
5373     else {                                                                   \
5374         if (_NOT_IN_NUMERIC_STANDARD) {                                      \
5375             SET_NUMERIC_STANDARD();                                          \
5376             _restore_LC_NUMERIC_function = &Perl_set_numeric_local;          \
5377         }                                                                    \
5378     }
5379
5380 #define DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED()                             \
5381     DECLARATION_FOR_STORE_LC_NUMERIC_SET_TO_NEEDED;                          \
5382     STORE_LC_NUMERIC_SET_TO_NEEDED();
5383
5384 #define RESTORE_LC_NUMERIC()                                                 \
5385     if (_restore_LC_NUMERIC_function) {                                      \
5386         _restore_LC_NUMERIC_function(aTHX);                                  \
5387     }
5388
5389 /* The next two macros set unconditionally.  These should be rarely used, and
5390  * only after being sure that this is what is needed */
5391 #define SET_NUMERIC_STANDARD()                                              \
5392         STMT_START { if (_NOT_IN_NUMERIC_STANDARD) set_numeric_standard();  \
5393                                                                  } STMT_END
5394
5395 #define SET_NUMERIC_LOCAL()                                                 \
5396         STMT_START { if (_NOT_IN_NUMERIC_LOCAL)                             \
5397                                             set_numeric_local(); } STMT_END
5398
5399 /* The rest of these LC_NUMERIC macros toggle to one or the other state, with
5400  * the RESTORE_foo ones called to switch back, but only if need be */
5401 #define STORE_NUMERIC_LOCAL_SET_STANDARD()          \
5402         bool _was_local = _NOT_IN_NUMERIC_STANDARD; \
5403         if (_was_local) set_numeric_standard();
5404
5405 /* Doesn't change to underlying locale unless within the scope of some form of
5406  * 'use locale'.  This is the usual desired behavior. */
5407 #define STORE_NUMERIC_STANDARD_SET_LOCAL()              \
5408         bool _was_standard = _NOT_IN_NUMERIC_LOCAL      \
5409                             && IN_LC(LC_NUMERIC);       \
5410         if (_was_standard) set_numeric_local();
5411
5412 /* Rarely, we want to change to the underlying locale even outside of 'use
5413  * locale'.  This is principally in the POSIX:: functions */
5414 #define STORE_NUMERIC_STANDARD_FORCE_LOCAL()            \
5415         bool _was_standard = _NOT_IN_NUMERIC_LOCAL;     \
5416         if (_was_standard) set_numeric_local();
5417
5418 /* Lock to the C locale until unlock is called */
5419 #define LOCK_NUMERIC_STANDARD()                         \
5420         (__ASSERT_(PL_numeric_standard)                 \
5421         PL_numeric_standard = 2)
5422
5423 #define UNLOCK_NUMERIC_STANDARD()                       \
5424         (__ASSERT_(PL_numeric_standard == 2)            \
5425         PL_numeric_standard = 1)
5426
5427 #define RESTORE_NUMERIC_LOCAL() \
5428         if (_was_local) set_numeric_local();
5429
5430 #define RESTORE_NUMERIC_STANDARD() \
5431         if (_was_standard) SET_NUMERIC_STANDARD();
5432
5433 #define Atof                            my_atof
5434
5435 #else /* !USE_LOCALE_NUMERIC */
5436
5437 #define SET_NUMERIC_STANDARD()          /**/
5438 #define SET_NUMERIC_LOCAL()             /**/
5439 #define IS_NUMERIC_RADIX(a, b)          (0)
5440 #define STORE_NUMERIC_LOCAL_SET_STANDARD()      /**/
5441 #define STORE_NUMERIC_STANDARD_SET_LOCAL()      /**/
5442 #define STORE_NUMERIC_STANDARD_FORCE_LOCAL()
5443 #define RESTORE_NUMERIC_LOCAL()         /**/
5444 #define RESTORE_NUMERIC_STANDARD()      /**/
5445 #define DECLARATION_FOR_STORE_LC_NUMERIC_SET_TO_NEEDED
5446 #define STORE_LC_NUMERIC_SET_TO_NEEDED()
5447 #define DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED()
5448 #define RESTORE_LC_NUMERIC()
5449
5450 #define Atof                            my_atof
5451 #define IN_LOCALE_RUNTIME               0
5452 #define IN_LOCALE_COMPILETIME           0
5453
5454 #endif /* !USE_LOCALE_NUMERIC */
5455
5456 #if !defined(Strtol) && defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && \
5457         (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
5458 #    ifdef __hpux
5459 #        define strtoll __strtoll       /* secret handshake */
5460 #    endif
5461 #    ifdef WIN64
5462 #        define strtoll _strtoi64       /* secret handshake */
5463 #    endif
5464 #   if !defined(Strtol) && defined(HAS_STRTOLL)
5465 #       define Strtol   strtoll
5466 #   endif
5467 #    if !defined(Strtol) && defined(HAS_STRTOQ)
5468 #       define Strtol   strtoq
5469 #    endif
5470 /* is there atoq() anywhere? */
5471 #endif
5472 #if !defined(Strtol) && defined(HAS_STRTOL)
5473 #   define Strtol       strtol
5474 #endif
5475 #ifndef Atol
5476 /* It would be more fashionable to use Strtol() to define atol()
5477  * (as is done for Atoul(), see below) but for backward compatibility
5478  * we just assume atol(). */
5479 #   if defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && defined(HAS_ATOLL) && \
5480         (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
5481 #    ifdef WIN64
5482 #       define atoll    _atoi64         /* secret handshake */
5483 #    endif
5484 #       define Atol     atoll
5485 #   else
5486 #       define Atol     atol
5487 #   endif
5488 #endif
5489
5490 #if !defined(Strtoul) && defined(USE_64_BIT_INT) && defined(UV_IS_QUAD) && \
5491         (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
5492 #    ifdef __hpux
5493 #        define strtoull __strtoull     /* secret handshake */
5494 #    endif
5495 #    ifdef WIN64
5496 #        define strtoull _strtoui64     /* secret handshake */
5497 #    endif
5498 #    if !defined(Strtoul) && defined(HAS_STRTOULL)
5499 #       define Strtoul  strtoull
5500 #    endif
5501 #    if !defined(Strtoul) && defined(HAS_STRTOUQ)
5502 #       define Strtoul  strtouq
5503 #    endif
5504 /* is there atouq() anywhere? */
5505 #endif
5506 #if !defined(Strtoul) && defined(HAS_STRTOUL)
5507 #   define Strtoul      strtoul
5508 #endif
5509 #if !defined(Strtoul) && defined(HAS_STRTOL) /* Last resort. */
5510 #   define Strtoul(s, e, b)     strchr((s), '-') ? ULONG_MAX : (unsigned long)strtol((s), (e), (b))
5511 #endif
5512 #ifndef Atoul
5513 #   define Atoul(s)     Strtoul(s, NULL, 10)
5514 #endif
5515
5516 #ifndef PERL_SCRIPT_MODE
5517 #define PERL_SCRIPT_MODE "r"
5518 #endif
5519
5520 /*
5521  * Some operating systems are stingy with stack allocation,
5522  * so perl may have to guard against stack overflow.
5523  */
5524 #ifndef PERL_STACK_OVERFLOW_CHECK
5525 #define PERL_STACK_OVERFLOW_CHECK()  NOOP
5526 #endif
5527
5528 /*
5529  * Some nonpreemptive operating systems find it convenient to
5530  * check for asynchronous conditions after each op execution.
5531  * Keep this check simple, or it may slow down execution
5532  * massively.
5533  */
5534
5535 #ifndef PERL_MICRO
5536 #       ifndef PERL_ASYNC_CHECK
5537 #               define PERL_ASYNC_CHECK() if (UNLIKELY(PL_sig_pending)) PL_signalhook(aTHX)
5538 #       endif
5539 #endif
5540
5541 #ifndef PERL_ASYNC_CHECK
5542 #   define PERL_ASYNC_CHECK()  NOOP
5543 #endif
5544
5545 /*
5546  * On some operating systems, a memory allocation may succeed,
5547  * but put the process too close to the system's comfort limit.
5548  * In this case, PERL_ALLOC_CHECK frees the pointer and sets
5549  * it to NULL.
5550  */
5551 #ifndef PERL_ALLOC_CHECK
5552 #define PERL_ALLOC_CHECK(p)  NOOP
5553 #endif
5554
5555 #ifdef HAS_SEM
5556 #   include <sys/ipc.h>
5557 #   include <sys/sem.h>
5558 #   ifndef HAS_UNION_SEMUN      /* Provide the union semun. */
5559     union semun {
5560         int             val;
5561         struct semid_ds *buf;
5562         unsigned short  *array;
5563     };
5564 #   endif
5565 #   ifdef USE_SEMCTL_SEMUN
5566 #       ifdef IRIX32_SEMUN_BROKEN_BY_GCC
5567             union gccbug_semun {
5568                 int             val;
5569                 struct semid_ds *buf;
5570                 unsigned short  *array;
5571                 char            __dummy[5];
5572             };
5573 #           define semun gccbug_semun
5574 #       endif
5575 #       define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun)
5576 #   else
5577 #       ifdef USE_SEMCTL_SEMID_DS
5578 #           ifdef EXTRA_F_IN_SEMUN_BUF
5579 #               define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buff)
5580 #           else
5581 #               define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buf)
5582 #           endif
5583 #       endif
5584 #   endif
5585 #endif
5586
5587 /*
5588  * Boilerplate macros for initializing and accessing interpreter-local
5589  * data from C.  All statics in extensions should be reworked to use
5590  * this, if you want to make the extension thread-safe.  See
5591  * ext/XS/APItest/APItest.xs for an example of the use of these macros,
5592  * and perlxs.pod for more.
5593  *
5594  * Code that uses these macros is responsible for the following:
5595  * 1. #define MY_CXT_KEY to a unique string, e.g.
5596  *    "DynaLoader::_guts" XS_VERSION
5597  *    XXX in the current implementation, this string is ignored.
5598  * 2. Declare a typedef named my_cxt_t that is a structure that contains
5599  *    all the data that needs to be interpreter-local.
5600  * 3. Use the START_MY_CXT macro after the declaration of my_cxt_t.
5601  * 4. Use the MY_CXT_INIT macro such that it is called exactly once
5602  *    (typically put in the BOOT: section).
5603  * 5. Use the members of the my_cxt_t structure everywhere as
5604  *    MY_CXT.member.
5605  * 6. Use the dMY_CXT macro (a declaration) in all the functions that
5606  *    access MY_CXT.
5607  */
5608
5609 #if defined(PERL_IMPLICIT_CONTEXT)
5610
5611 /* START_MY_CXT must appear in all extensions that define a my_cxt_t structure,
5612  * right after the definition (i.e. at file scope).  The non-threads
5613  * case below uses it to declare the data as static. */
5614 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
5615 #    define START_MY_CXT
5616 #    define MY_CXT_INDEX Perl_my_cxt_index(aTHX_ MY_CXT_KEY)
5617 #    define MY_CXT_INIT_ARG MY_CXT_KEY
5618 #  else
5619 #    define START_MY_CXT static int my_cxt_index = -1;
5620 #    define MY_CXT_INDEX my_cxt_index
5621 #    define MY_CXT_INIT_ARG &my_cxt_index
5622 #  endif /* #ifdef PERL_GLOBAL_STRUCT_PRIVATE */
5623
5624 /* Creates and zeroes the per-interpreter data.
5625  * (We allocate my_cxtp in a Perl SV so that it will be released when
5626  * the interpreter goes away.) */
5627 #  define MY_CXT_INIT \
5628         my_cxt_t *my_cxtp = \
5629             (my_cxt_t*)Perl_my_cxt_init(aTHX_ MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
5630         PERL_UNUSED_VAR(my_cxtp)
5631 #  define MY_CXT_INIT_INTERP(my_perl) \
5632         my_cxt_t *my_cxtp = \
5633             (my_cxt_t*)Perl_my_cxt_init(my_perl, MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
5634         PERL_UNUSED_VAR(my_cxtp)
5635
5636 /* This declaration should be used within all functions that use the
5637  * interpreter-local data. */
5638 #  define dMY_CXT       \
5639         my_cxt_t *my_cxtp = (my_cxt_t *)PL_my_cxt_list[MY_CXT_INDEX]
5640 #  define dMY_CXT_INTERP(my_perl)       \
5641         my_cxt_t *my_cxtp = (my_cxt_t *)(my_perl)->Imy_cxt_list[MY_CXT_INDEX]
5642
5643 /* Clones the per-interpreter data. */
5644 #  define MY_CXT_CLONE \
5645         my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1));\
5646         Copy(PL_my_cxt_list[MY_CXT_INDEX], my_cxtp, 1, my_cxt_t);\
5647         PL_my_cxt_list[MY_CXT_INDEX] = my_cxtp                          \
5648
5649
5650 /* This macro must be used to access members of the my_cxt_t structure.
5651  * e.g. MY_CXT.some_data */
5652 #  define MY_CXT                (*my_cxtp)
5653
5654 /* Judicious use of these macros can reduce the number of times dMY_CXT
5655  * is used.  Use is similar to pTHX, aTHX etc. */
5656 #  define pMY_CXT       my_cxt_t *my_cxtp
5657 #  define pMY_CXT_      pMY_CXT,
5658 #  define _pMY_CXT      ,pMY_CXT
5659 #  define aMY_CXT       my_cxtp
5660 #  define aMY_CXT_      aMY_CXT,
5661 #  define _aMY_CXT      ,aMY_CXT
5662
5663 #else /* PERL_IMPLICIT_CONTEXT */
5664
5665 #  define START_MY_CXT          static my_cxt_t my_cxt;
5666 #  define dMY_CXT_SV            dNOOP
5667 #  define dMY_CXT               dNOOP
5668 #  define dMY_CXT_INTERP(my_perl) dNOOP
5669 #  define MY_CXT_INIT           NOOP
5670 #  define MY_CXT_CLONE          NOOP
5671 #  define MY_CXT                my_cxt
5672
5673 #  define pMY_CXT               void
5674 #  define pMY_CXT_
5675 #  define _pMY_CXT
5676 #  define aMY_CXT
5677 #  define aMY_CXT_
5678 #  define _aMY_CXT
5679
5680 #endif /* !defined(PERL_IMPLICIT_CONTEXT) */
5681
5682 #ifdef I_FCNTL
5683 #  include <fcntl.h>
5684 #endif
5685
5686 #ifdef __Lynx__
5687 #  include <fcntl.h>
5688 #endif
5689
5690 #ifdef I_SYS_FILE
5691 #  include <sys/file.h>
5692 #endif
5693
5694 #if defined(HAS_FLOCK) && !defined(HAS_FLOCK_PROTO)
5695 int flock(int fd, int op);
5696 #endif
5697
5698 #ifndef O_RDONLY
5699 /* Assume UNIX defaults */
5700 #    define O_RDONLY    0000
5701 #    define O_WRONLY    0001
5702 #    define O_RDWR      0002
5703 #    define O_CREAT     0100
5704 #endif
5705
5706 #ifndef O_BINARY
5707 #  define O_BINARY 0
5708 #endif
5709
5710 #ifndef O_TEXT
5711 #  define O_TEXT 0
5712 #endif
5713
5714 #if O_TEXT != O_BINARY
5715     /* If you have different O_TEXT and O_BINARY and you are a CRLF shop,
5716      * that is, you are somehow DOSish. */
5717 #   if defined(__HAIKU__) || defined(__VOS__) || defined(__CYGWIN__)
5718     /* Haiku has O_TEXT != O_BINARY but O_TEXT and O_BINARY have no effect;
5719      * Haiku is always UNIXoid (LF), not DOSish (CRLF). */
5720     /* VOS has O_TEXT != O_BINARY, and they have effect,
5721      * but VOS always uses LF, never CRLF. */
5722     /* If you have O_TEXT different from your O_BINARY but you still are
5723      * not a CRLF shop. */
5724 #       undef PERLIO_USING_CRLF
5725 #   else
5726     /* If you really are DOSish. */
5727 #      define PERLIO_USING_CRLF 1
5728 #   endif
5729 #endif
5730
5731 #ifdef I_LIBUTIL
5732 #   include <libutil.h>         /* setproctitle() in some FreeBSDs */
5733 #endif
5734
5735 #ifndef EXEC_ARGV_CAST
5736 #define EXEC_ARGV_CAST(x) (char **)x
5737 #endif
5738
5739 #define IS_NUMBER_IN_UV               0x01 /* number within UV range (maybe not
5740                                               int).  value returned in pointed-
5741                                               to UV */
5742 #define IS_NUMBER_GREATER_THAN_UV_MAX 0x02 /* pointed to UV undefined */
5743 #define IS_NUMBER_NOT_INT             0x04 /* saw . or E notation */
5744 #define IS_NUMBER_NEG                 0x08 /* leading minus sign */
5745 #define IS_NUMBER_INFINITY            0x10 /* this is big */
5746 #define IS_NUMBER_NAN                 0x20 /* this is not */
5747
5748 #define GROK_NUMERIC_RADIX(sp, send) grok_numeric_radix(sp, send)
5749
5750 /* Input flags: */
5751 #define PERL_SCAN_ALLOW_UNDERSCORES   0x01 /* grok_??? accept _ in numbers */
5752 #define PERL_SCAN_DISALLOW_PREFIX     0x02 /* grok_??? reject 0x in hex etc */
5753 #define PERL_SCAN_SILENT_ILLDIGIT     0x04 /* grok_??? not warn about illegal digits */
5754 #define PERL_SCAN_SILENT_NON_PORTABLE 0x08 /* grok_??? not warn about very large
5755                                               numbers which are <= UV_MAX */
5756 /* Output flags: */
5757 #define PERL_SCAN_GREATER_THAN_UV_MAX 0x02 /* should this merge with above? */
5758
5759 /* to let user control profiling */
5760 #ifdef PERL_GPROF_CONTROL
5761 extern void moncontrol(int);
5762 #define PERL_GPROF_MONCONTROL(x) moncontrol(x)
5763 #else
5764 #define PERL_GPROF_MONCONTROL(x)
5765 #endif
5766
5767 #ifdef UNDER_CE
5768 #include "wince.h"
5769 #endif
5770
5771 /* ISO 6429 NEL - C1 control NExt Line */
5772 /* See http://www.unicode.org/unicode/reports/tr13/ */
5773 #define NEXT_LINE_CHAR  NEXT_LINE_NATIVE
5774
5775 /* The UTF-8 bytes of the Unicode LS and PS, U+2028 and U+2029 */
5776 #define UNICODE_LINE_SEPA_0     0xE2
5777 #define UNICODE_LINE_SEPA_1     0x80
5778 #define UNICODE_LINE_SEPA_2     0xA8
5779 #define UNICODE_PARA_SEPA_0     0xE2
5780 #define UNICODE_PARA_SEPA_1     0x80
5781 #define UNICODE_PARA_SEPA_2     0xA9
5782
5783 #ifndef PIPESOCK_MODE
5784 #  define PIPESOCK_MODE
5785 #endif
5786
5787 #ifndef SOCKET_OPEN_MODE
5788 #  define SOCKET_OPEN_MODE      PIPESOCK_MODE
5789 #endif
5790
5791 #ifndef PIPE_OPEN_MODE
5792 #  define PIPE_OPEN_MODE        PIPESOCK_MODE
5793 #endif
5794
5795 #define PERL_MAGIC_UTF8_CACHESIZE       2
5796
5797 #define PERL_UNICODE_STDIN_FLAG                 0x0001
5798 #define PERL_UNICODE_STDOUT_FLAG                0x0002
5799 #define PERL_UNICODE_STDERR_FLAG                0x0004
5800 #define PERL_UNICODE_IN_FLAG                    0x0008
5801 #define PERL_UNICODE_OUT_FLAG                   0x0010
5802 #define PERL_UNICODE_ARGV_FLAG                  0x0020
5803 #define PERL_UNICODE_LOCALE_FLAG                0x0040
5804 #define PERL_UNICODE_WIDESYSCALLS_FLAG          0x0080 /* for Sarathy */
5805 #define PERL_UNICODE_UTF8CACHEASSERT_FLAG       0x0100
5806
5807 #define PERL_UNICODE_STD_FLAG           \
5808         (PERL_UNICODE_STDIN_FLAG        | \
5809          PERL_UNICODE_STDOUT_FLAG       | \
5810          PERL_UNICODE_STDERR_FLAG)
5811
5812 #define PERL_UNICODE_INOUT_FLAG         \
5813         (PERL_UNICODE_IN_FLAG   | \
5814          PERL_UNICODE_OUT_FLAG)
5815
5816 #define PERL_UNICODE_DEFAULT_FLAGS      \
5817         (PERL_UNICODE_STD_FLAG          | \
5818          PERL_UNICODE_INOUT_FLAG        | \
5819          PERL_UNICODE_LOCALE_FLAG)
5820
5821 #define PERL_UNICODE_ALL_FLAGS                  0x01ff
5822
5823 #define PERL_UNICODE_STDIN                      'I'
5824 #define PERL_UNICODE_STDOUT                     'O'
5825 #define PERL_UNICODE_STDERR                     'E'
5826 #define PERL_UNICODE_STD                        'S'
5827 #define PERL_UNICODE_IN                         'i'
5828 #define PERL_UNICODE_OUT                        'o'
5829 #define PERL_UNICODE_INOUT                      'D'
5830 #define PERL_UNICODE_ARGV                       'A'
5831 #define PERL_UNICODE_LOCALE                     'L'
5832 #define PERL_UNICODE_WIDESYSCALLS               'W'
5833 #define PERL_UNICODE_UTF8CACHEASSERT            'a'
5834
5835 #define PERL_SIGNALS_UNSAFE_FLAG        0x0001
5836
5837 /* Use instead of abs() since abs() forces its argument to be an int,
5838  * but also beware since this evaluates its argument twice, so no x++. */
5839 #define PERL_ABS(x) ((x) < 0 ? -(x) : (x))
5840
5841 #if defined(__DECC) && defined(__osf__)
5842 #pragma message disable (mainparm) /* Perl uses the envp in main(). */
5843 #endif
5844
5845 #define do_open(g, n, l, a, rm, rp, sf) \
5846         do_openn(g, n, l, a, rm, rp, sf, (SV **) NULL, 0)
5847 #ifdef PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
5848 #  define do_exec(cmd)                  do_exec3(cmd,0,0)
5849 #endif
5850 #ifdef OS2
5851 #  define do_aexec                      Perl_do_aexec
5852 #else
5853 #  define do_aexec(really, mark,sp)     do_aexec5(really, mark, sp, 0, 0)
5854 #endif
5855
5856 /* check embedded \0 characters in pathnames passed to syscalls,
5857    but allow one ending \0 */
5858 #define IS_SAFE_SYSCALL(p, len, what, op_name) (S_is_safe_syscall(aTHX_ (p), (len), (what), (op_name)))
5859
5860 #define IS_SAFE_PATHNAME(p, len, op_name) IS_SAFE_SYSCALL((p), (len), "pathname", (op_name))
5861
5862 #if defined(OEMVS)
5863 #define NO_ENV_ARRAY_IN_MAIN
5864 #endif
5865
5866 /* These are used by Perl_pv_escape() and Perl_pv_pretty()
5867  * are here so that they are available throughout the core
5868  * NOTE that even though some are for _escape and some for _pretty
5869  * there must not be any clashes as the flags from _pretty are
5870  * passed straight through to _escape.
5871  */
5872
5873 #define PERL_PV_ESCAPE_QUOTE        0x0001
5874 #define PERL_PV_PRETTY_QUOTE        PERL_PV_ESCAPE_QUOTE
5875
5876 #define PERL_PV_PRETTY_ELLIPSES     0x0002
5877 #define PERL_PV_PRETTY_LTGT         0x0004
5878
5879 #define PERL_PV_ESCAPE_FIRSTCHAR    0x0008
5880
5881 #define PERL_PV_ESCAPE_UNI          0x0100
5882 #define PERL_PV_ESCAPE_UNI_DETECT   0x0200
5883 #define PERL_PV_ESCAPE_NONASCII     0x0400
5884
5885 #define PERL_PV_ESCAPE_ALL          0x1000
5886 #define PERL_PV_ESCAPE_NOBACKSLASH  0x2000
5887 #define PERL_PV_ESCAPE_NOCLEAR      0x4000
5888 #define PERL_PV_ESCAPE_RE           0x8000
5889
5890 #define PERL_PV_ESCAPE_DWIM         0x10000
5891
5892 #define PERL_PV_PRETTY_NOCLEAR      PERL_PV_ESCAPE_NOCLEAR
5893
5894 /* used by pv_display in dump.c*/
5895 #define PERL_PV_PRETTY_DUMP  PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE
5896 #define PERL_PV_PRETTY_REGPROP PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_LTGT|PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII
5897
5898 #if defined(USE_C_BACKTRACE) && defined(I_BFD)
5899 #  define USE_BFD
5900 #  ifdef PERL_DARWIN
5901 #    undef USE_BFD /* BFD is useless in OS X. */
5902 #  endif
5903 #  ifdef USE_BFD
5904 #    include <bfd.h>
5905 #  endif
5906 #endif
5907
5908 /*
5909
5910    (KEEP THIS LAST IN perl.h!)
5911
5912    Mention
5913
5914    NV_PRESERVES_UV
5915
5916    HAS_MKSTEMP
5917    HAS_MKSTEMPS
5918    HAS_MKDTEMP
5919
5920    HAS_GETCWD
5921
5922    HAS_MMAP
5923    HAS_MPROTECT
5924    HAS_MSYNC
5925    HAS_MADVISE
5926    HAS_MUNMAP
5927    I_SYSMMAN
5928    Mmap_t
5929
5930    NVef
5931    NVff
5932    NVgf
5933
5934    HAS_UALARM
5935    HAS_USLEEP
5936
5937    HAS_SETITIMER
5938    HAS_GETITIMER
5939
5940    HAS_SENDMSG
5941    HAS_RECVMSG
5942    HAS_READV
5943    HAS_WRITEV
5944    I_SYSUIO
5945    HAS_STRUCT_MSGHDR
5946    HAS_STRUCT_CMSGHDR
5947
5948    HAS_NL_LANGINFO
5949
5950    HAS_DIRFD
5951
5952    so that Configure picks them up.
5953
5954    (KEEP THIS LAST IN perl.h!)
5955
5956 */
5957
5958 #endif /* Include guard */
5959
5960 /*
5961  * Local variables:
5962  * c-indentation-style: bsd
5963  * c-basic-offset: 4
5964  * indent-tabs-mode: nil
5965  * End:
5966  *
5967  * ex: set ts=8 sts=4 sw=4 et:
5968  */