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