perl.h

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