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