perl.h

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