perl.h

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