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