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