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