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