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