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