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