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