perl.h

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