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