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 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
2798     /* having sigaction(2) means that the OS supports both 1-arg and 3-arg
2799      * signal handlers. But the perl core itself only fully supports 1-arg
2800      * handlers, so don't enable for now.
2801      * NB: POSIX::sigaction() supports both.
2802      *
2803      * # define PERL_USE_3ARG_SIGHANDLER
2804      */
2805 #endif
2806
2807 /* Siginfo_t:
2808  * This is an alias for the OS's siginfo_t, except that where the OS
2809  * doesn't support it, declare a dummy version instead. This allows us to
2810  * have signal handler functions which always have a Siginfo_t parameter
2811  * regardless of platform, (and which will just be passed a NULL value
2812  * where the OS doesn't support HAS_SIGACTION).
2813  */
2814
2815 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
2816     typedef siginfo_t Siginfo_t;
2817 #else
2818     typedef struct {
2819         int si_signo;
2820     } Siginfo_t;
2821 #endif
2822
2823
2824 /*
2825  * initialise to avoid floating-point exceptions from overflow, etc
2826  */
2827 #ifndef PERL_FPU_INIT
2828 #  ifdef HAS_FPSETMASK
2829 #    if HAS_FLOATINGPOINT_H
2830 #      include <floatingpoint.h>
2831 #    endif
2832 /* Some operating systems have this as a macro, which in turn expands to a comma
2833    expression, and the last sub-expression is something that gets calculated,
2834    and then they have the gall to warn that a value computed is not used. Hence
2835    cast to void.  */
2836 #    define PERL_FPU_INIT (void)fpsetmask(0)
2837 #  elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2838 #    define PERL_FPU_INIT       PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2839 #    define PERL_FPU_PRE_EXEC   { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2840 #    define PERL_FPU_POST_EXEC    rsignal_restore(SIGFPE, &xfpe); }
2841 #  else
2842 #    define PERL_FPU_INIT
2843 #  endif
2844 #endif
2845 #ifndef PERL_FPU_PRE_EXEC
2846 #  define PERL_FPU_PRE_EXEC   {
2847 #  define PERL_FPU_POST_EXEC  }
2848 #endif
2849
2850 /* In Tru64 the cc -ieee enables the IEEE math but disables traps.
2851  * We need to reenable the "invalid" trap because otherwise generation
2852  * of NaN values leaves the IEEE fp flags in bad state, leaving any further
2853  * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
2854 #ifdef __osf__
2855 #  include <machine/fpu.h>
2856 #  define PERL_SYS_FPU_INIT \
2857      STMT_START { \
2858          ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
2859          signal(SIGFPE, SIG_IGN); \
2860      } STMT_END
2861 #endif
2862 /* In IRIX the default for Flush to Zero bit is true,
2863  * which means that results going below the minimum of normal
2864  * floating points go to zero, instead of going denormal/subnormal.
2865  * This is unlike almost any other system running Perl, so let's clear it.
2866  * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
2867  * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
2868  *
2869  * XXX The flush-to-zero behaviour should be a Configure scan.
2870  * To change the behaviour usually requires some system-specific
2871  * incantation, though, like the below. */
2872 #ifdef __sgi
2873 #  include <sys/fpu.h>
2874 #  define PERL_SYS_FPU_INIT \
2875      STMT_START { \
2876          union fpc_csr csr; \
2877          csr.fc_word = get_fpc_csr(); \
2878          csr.fc_struct.flush = 0; \
2879          set_fpc_csr(csr.fc_word); \
2880      } STMT_END
2881 #endif
2882
2883 #ifndef PERL_SYS_FPU_INIT
2884 #  define PERL_SYS_FPU_INIT NOOP
2885 #endif
2886
2887 #ifndef PERL_SYS_INIT3_BODY
2888 #  define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
2889 #endif
2890
2891 /*
2892 =head1 Miscellaneous Functions
2893
2894 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
2895 Provides system-specific tune up of the C runtime environment necessary to
2896 run Perl interpreters.  This should be called only once, before creating
2897 any Perl interpreters.
2898
2899 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
2900 Provides system-specific tune up of the C runtime environment necessary to
2901 run Perl interpreters.  This should be called only once, before creating
2902 any Perl interpreters.
2903
2904 =for apidoc Am|void|PERL_SYS_TERM|
2905 Provides system-specific clean up of the C runtime environment after
2906 running Perl interpreters.  This should be called only once, after
2907 freeing any remaining Perl interpreters.
2908
2909 =cut
2910  */
2911
2912 #define PERL_SYS_INIT(argc, argv)       Perl_sys_init(argc, argv)
2913 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
2914 #define PERL_SYS_TERM()                 Perl_sys_term()
2915
2916 #ifndef PERL_WRITE_MSG_TO_CONSOLE
2917 #  define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
2918 #endif
2919
2920 #ifndef MAXPATHLEN
2921 #  ifdef PATH_MAX
2922 #    ifdef _POSIX_PATH_MAX
2923 #       if PATH_MAX > _POSIX_PATH_MAX
2924 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
2925  * included the null byte or not.  Later amendments of POSIX,
2926  * XPG4, the Austin Group, and the Single UNIX Specification
2927  * all explicitly include the null byte in the PATH_MAX.
2928  * Ditto for _POSIX_PATH_MAX. */
2929 #         define MAXPATHLEN PATH_MAX
2930 #       else
2931 #         define MAXPATHLEN _POSIX_PATH_MAX
2932 #       endif
2933 #    else
2934 #      define MAXPATHLEN (PATH_MAX+1)
2935 #    endif
2936 #  else
2937 #    define MAXPATHLEN 1024     /* Err on the large side. */
2938 #  endif
2939 #endif
2940
2941 /* In case Configure was not used (we are using a "canned config"
2942  * such as Win32, or a cross-compilation setup, for example) try going
2943  * by the gcc major and minor versions.  One useful URL is
2944  * http://www.ohse.de/uwe/articles/gcc-attributes.html,
2945  * but contrary to this information warn_unused_result seems
2946  * not to be in gcc 3.3.5, at least. --jhi
2947  * Also, when building extensions with an installed perl, this allows
2948  * the user to upgrade gcc and get the right attributes, rather than
2949  * relying on the list generated at Configure time.  --AD
2950  * Set these up now otherwise we get confused when some of the <*thread.h>
2951  * includes below indirectly pull in <perlio.h> (which needs to know if we
2952  * have HASATTRIBUTE_FORMAT).
2953  */
2954
2955 #ifndef PERL_MICRO
2956 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
2957 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
2958 #    define HASATTRIBUTE_DEPRECATED
2959 #  endif
2960 #  if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
2961 #    define HASATTRIBUTE_FORMAT
2962 #    if defined __MINGW32__
2963 #      define PRINTF_FORMAT_NULL_OK
2964 #    endif
2965 #  endif
2966 #  if __GNUC__ >= 3 /* 3.0 -> */
2967 #    define HASATTRIBUTE_MALLOC
2968 #  endif
2969 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
2970 #    define HASATTRIBUTE_NONNULL
2971 #  endif
2972 #  if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
2973 #    define HASATTRIBUTE_NORETURN
2974 #  endif
2975 #  if __GNUC__ >= 3 /* gcc 3.0 -> */
2976 #    define HASATTRIBUTE_PURE
2977 #  endif
2978 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2979 #    define HASATTRIBUTE_UNUSED
2980 #  endif
2981 #  if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
2982 #    define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
2983 #  endif
2984 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2985 #    define HASATTRIBUTE_WARN_UNUSED_RESULT
2986 #  endif
2987 #endif
2988 #endif /* #ifndef PERL_MICRO */
2989
2990 /* USE_5005THREADS needs to be after unixish.h as <pthread.h> includes
2991  * <sys/signal.h> which defines NSIG - which will stop inclusion of <signal.h>
2992  * this results in many functions being undeclared which bothers C++
2993  * May make sense to have threads after "*ish.h" anyway
2994  */
2995
2996 /* clang Thread Safety Analysis/Annotations/Attributes
2997  * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
2998  *
2999  * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
3000  * Apple XCode hijacks __clang_major__ and __clang_minor__
3001  * (6.1 means really clang 3.6), so needs extra hijinks
3002  * (could probably also test the contents of __apple_build_version__).
3003  */
3004 #if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
3005     defined(__clang__) && \
3006     !defined(PERL_GLOBAL_STRUCT) && \
3007     !defined(PERL_GLOBAL_STRUCT_PRIVATE) && \
3008     !defined(SWIG) && \
3009   ((!defined(__apple_build_version__) &&               \
3010     ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
3011      (__clang_major__ >= 4))) || \
3012    (defined(__apple_build_version__) &&                \
3013     ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
3014      (__clang_major__ >= 7))))
3015 #  define PERL_TSA__(x)   __attribute__((x))
3016 #  define PERL_TSA_ACTIVE
3017 #else
3018 #  define PERL_TSA__(x)   /* No TSA, make TSA attributes no-ops. */
3019 #  undef PERL_TSA_ACTIVE
3020 #endif
3021
3022 /* PERL_TSA_CAPABILITY() is used to annotate typedefs.
3023  * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
3024  */
3025 #define PERL_TSA_CAPABILITY(x) \
3026     PERL_TSA__(capability(x))
3027
3028 /* In the below examples the mutex must be lexically visible, usually
3029  * either as global variables, or as function arguments. */
3030
3031 /* PERL_TSA_GUARDED_BY() is used to annotate global variables.
3032  *
3033  * Foo foo PERL_TSA_GUARDED_BY(mutex);
3034  */
3035 #define PERL_TSA_GUARDED_BY(x) \
3036     PERL_TSA__(guarded_by(x))
3037
3038 /* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
3039  * The data _behind_ the pointer is guarded.
3040  *
3041  * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
3042  */
3043 #define PERL_TSA_PT_GUARDED_BY(x) \
3044     PERL_TSA__(pt_guarded_by(x))
3045
3046 /* PERL_TSA_REQUIRES() is used to annotate functions.
3047  * The caller MUST hold the resource when calling the function.
3048  *
3049  * void Foo() PERL_TSA_REQUIRES(mutex);
3050  */
3051 #define PERL_TSA_REQUIRES(x) \
3052     PERL_TSA__(requires_capability(x))
3053
3054 /* PERL_TSA_EXCLUDES() is used to annotate functions.
3055  * The caller MUST NOT hold resource when calling the function.
3056  *
3057  * EXCLUDES should be used when the function first acquires
3058  * the resource and then releases it.  Use to avoid deadlock.
3059  *
3060  * void Foo() PERL_TSA_EXCLUDES(mutex);
3061  */
3062 #define PERL_TSA_EXCLUDES(x) \
3063     PERL_TSA__(locks_excluded(x))
3064
3065 /* PERL_TSA_ACQUIRE() is used to annotate functions.
3066  * The caller MUST NOT hold the resource when calling the function,
3067  * and the function will acquire the resource.
3068  *
3069  * void Foo() PERL_TSA_ACQUIRE(mutex);
3070  */
3071 #define PERL_TSA_ACQUIRE(x) \
3072     PERL_TSA__(acquire_capability(x))
3073
3074 /* PERL_TSA_RELEASE() is used to annotate functions.
3075  * The caller MUST hold the resource when calling the function,
3076  * and the function will release the resource.
3077  *
3078  * void Foo() PERL_TSA_RELEASE(mutex);
3079  */
3080 #define PERL_TSA_RELEASE(x) \
3081     PERL_TSA__(release_capability(x))
3082
3083 /* PERL_TSA_NO_TSA is used to annotate functions.
3084  * Used when being intentionally unsafe, or when the code is too
3085  * complicated for the analysis.  Use sparingly.
3086  *
3087  * void Foo() PERL_TSA_NO_TSA;
3088  */
3089 #define PERL_TSA_NO_TSA \
3090     PERL_TSA__(no_thread_safety_analysis)
3091
3092 /* There are more annotations/attributes available, see the clang
3093  * documentation for details. */
3094
3095 #if defined(USE_ITHREADS)
3096 #  ifdef NETWARE
3097 #    include <nw5thread.h>
3098 #  elif defined(WIN32)
3099 #    include <win32thread.h>
3100 #  elif defined(OS2)
3101 #    include "os2thread.h"
3102 #  elif defined(I_MACH_CTHREADS)
3103 #    include <mach/cthreads.h>
3104 typedef cthread_t       perl_os_thread;
3105 typedef mutex_t         perl_mutex;
3106 typedef condition_t     perl_cond;
3107 typedef void *          perl_key;
3108 #  elif defined(I_PTHREAD) /* Posix threads */
3109 #    include <pthread.h>
3110 typedef pthread_t       perl_os_thread;
3111 typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
3112 typedef pthread_cond_t  perl_cond;
3113 typedef pthread_key_t   perl_key;
3114 #  endif
3115 #endif /* USE_ITHREADS */
3116
3117 #ifdef PERL_TSA_ACTIVE
3118 /* Since most pthread mutex interfaces have not been annotated, we
3119  * need to have these wrappers. The NO_TSA annotation is quite ugly
3120  * but it cannot be avoided in plain C, unlike in C++, where one could
3121  * e.g. use ACQUIRE() with no arg on a mutex lock method.
3122  *
3123  * The bodies of these wrappers are in util.c
3124  *
3125  * TODO: however, some platforms are starting to get these clang
3126  * thread safety annotations for pthreads, for example FreeBSD.
3127  * Do we need a way to a bypass these wrappers? */
3128 EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
3129   PERL_TSA_ACQUIRE(*mutex)
3130   PERL_TSA_NO_TSA;
3131 EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
3132   PERL_TSA_RELEASE(*mutex)
3133   PERL_TSA_NO_TSA;
3134 #endif
3135
3136 #if defined(WIN32)
3137 #  include "win32.h"
3138 #endif
3139
3140 #ifdef NETWARE
3141 #  include "netware.h"
3142 #endif
3143
3144 #define STATUS_UNIX     PL_statusvalue
3145 #ifdef VMS
3146 #   define STATUS_NATIVE        PL_statusvalue_vms
3147 /*
3148  * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
3149  * its contents can not be trusted.  Unfortunately, Perl seems to check
3150  * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
3151  * be updated also.
3152  */
3153 #  include <stsdef.h>
3154 #  include <ssdef.h>
3155 /* Presume this because if VMS changes it, it will require a new
3156  * set of APIs for waiting on children for binary compatibility.
3157  */
3158 #  define child_offset_bits (8)
3159 #  ifndef C_FAC_POSIX
3160 #  define C_FAC_POSIX 0x35A000
3161 #  endif
3162
3163 /*  STATUS_EXIT - validates and returns a NATIVE exit status code for the
3164  * platform from the existing UNIX or Native status values.
3165  */
3166
3167 #   define STATUS_EXIT \
3168         (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
3169            (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
3170
3171
3172 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
3173  * exit code and shifts the UNIX value over the correct number of bits to
3174  * be a child status.  Usually the number of bits is 8, but that could be
3175  * platform dependent.  The NATIVE status code is presumed to have either
3176  * from a child process.
3177  */
3178
3179 /* This is complicated.  The child processes return a true native VMS
3180    status which must be saved.  But there is an assumption in Perl that
3181    the UNIX child status has some relationship to errno values, so
3182    Perl tries to translate it to text in some of the tests.
3183    In order to get the string translation correct, for the error, errno
3184    must be EVMSERR, but that generates a different text message
3185    than what the test programs are expecting.  So an errno value must
3186    be derived from the native status value when an error occurs.
3187    That will hide the true native status message.  With this version of
3188    perl, the true native child status can always be retrieved so that
3189    is not a problem.  But in this case, Pl_statusvalue and errno may
3190    have different values in them.
3191  */
3192
3193 #   define STATUS_NATIVE_CHILD_SET(n) \
3194         STMT_START {                                                    \
3195             I32 evalue = (I32)n;                                        \
3196             if (evalue == EVMSERR) {                                    \
3197               PL_statusvalue_vms = vaxc$errno;                          \
3198               PL_statusvalue = evalue;                                  \
3199             } else {                                                    \
3200               PL_statusvalue_vms = evalue;                              \
3201               if (evalue == -1) {                                       \
3202                 PL_statusvalue = -1;                                    \
3203                 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3204               } else                                                    \
3205                 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1);    \
3206               set_vaxc_errno(evalue);                                   \
3207               if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX)    \
3208                   set_errno(EVMSERR);                                   \
3209               else set_errno(Perl_vms_status_to_unix(evalue, 0));       \
3210               PL_statusvalue = PL_statusvalue << child_offset_bits;     \
3211             }                                                           \
3212         } STMT_END
3213
3214 #   ifdef VMSISH_STATUS
3215 #       define STATUS_CURRENT   (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
3216 #   else
3217 #       define STATUS_CURRENT   STATUS_UNIX
3218 #   endif
3219
3220   /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3221    * the NATIVE status to an equivalent value.  Can not be used to translate
3222    * exit code values as exit code values are not guaranteed to have any
3223    * relationship at all to errno values.
3224    * This is used when Perl is forcing errno to have a specific value.
3225    */
3226 #   define STATUS_UNIX_SET(n)                           \
3227         STMT_START {                                    \
3228             I32 evalue = (I32)n;                        \
3229             PL_statusvalue = evalue;                    \
3230             if (PL_statusvalue != -1) {                 \
3231                 if (PL_statusvalue != EVMSERR) {        \
3232                   PL_statusvalue &= 0xFFFF;             \
3233                   if (MY_POSIX_EXIT)                    \
3234                     PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3235                   else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3236                 }                                       \
3237                 else {                                  \
3238                   PL_statusvalue_vms = vaxc$errno;      \
3239                 }                                       \
3240             }                                           \
3241             else PL_statusvalue_vms = SS$_ABORT;        \
3242             set_vaxc_errno(PL_statusvalue_vms);         \
3243         } STMT_END
3244
3245   /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
3246    * the NATIVE error status based on it.
3247    *
3248    * When in the default mode to comply with the Perl VMS documentation,
3249    * 0 is a success and any other code sets the NATIVE status to a failure
3250    * code of SS$_ABORT.
3251    *
3252    * In the new POSIX EXIT mode, native status will be set so that the
3253    * actual exit code will can be retrieved by the calling program or
3254    * shell.
3255    *
3256    * If the exit code is not clearly a UNIX parent or child exit status,
3257    * it will be passed through as a VMS status.
3258    */
3259
3260 #   define STATUS_UNIX_EXIT_SET(n)                      \
3261         STMT_START {                                    \
3262             I32 evalue = (I32)n;                        \
3263             PL_statusvalue = evalue;                    \
3264             if (MY_POSIX_EXIT) { \
3265               if (evalue <= 0xFF00) {           \
3266                   if (evalue > 0xFF)                    \
3267                     evalue = (evalue >> child_offset_bits) & 0xFF; \
3268                   PL_statusvalue_vms =          \
3269                     (C_FAC_POSIX | (evalue << 3 ) |     \
3270                     ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3271               } else /* forgive them Perl, for they have sinned */ \
3272                 PL_statusvalue_vms = evalue; \
3273             } else { \
3274               if (evalue == 0)                  \
3275                 PL_statusvalue_vms = SS$_NORMAL;        \
3276               else if (evalue <= 0xFF00) \
3277                 PL_statusvalue_vms = SS$_ABORT; \
3278               else { /* forgive them Perl, for they have sinned */ \
3279                   if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3280                   else PL_statusvalue_vms = vaxc$errno; \
3281                   /* And obviously used a VMS status value instead of UNIX */ \
3282                   PL_statusvalue = EVMSERR;             \
3283               } \
3284               set_vaxc_errno(PL_statusvalue_vms);       \
3285             }                                           \
3286         } STMT_END
3287
3288
3289   /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3290    * and sets the NATIVE error status based on it.  This special case
3291    * is needed to maintain compatibility with past VMS behavior.
3292    *
3293    * In the default mode on VMS, this number is passed through as
3294    * both the NATIVE and UNIX status.  Which makes it different
3295    * that the STATUS_UNIX_EXIT_SET.
3296    *
3297    * In the new POSIX EXIT mode, native status will be set so that the
3298    * actual exit code will can be retrieved by the calling program or
3299    * shell.
3300    *
3301    * A POSIX exit code is from 0 to 255.  If the exit code is higher
3302    * than this, it needs to be assumed that it is a VMS exit code and
3303    * passed through.
3304    */
3305
3306 #   define STATUS_EXIT_SET(n)                           \
3307         STMT_START {                                    \
3308             I32 evalue = (I32)n;                        \
3309             PL_statusvalue = evalue;                    \
3310             if (MY_POSIX_EXIT)                          \
3311                 if (evalue > 255) PL_statusvalue_vms = evalue; else {   \
3312                   PL_statusvalue_vms = \
3313                     (C_FAC_POSIX | (evalue << 3 ) |     \
3314                      ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
3315             else                                        \
3316                 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3317             set_vaxc_errno(PL_statusvalue_vms);         \
3318         } STMT_END
3319
3320
3321  /* This macro forces a success status */
3322 #   define STATUS_ALL_SUCCESS   \
3323         (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
3324
3325  /* This macro forces a failure status */
3326 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, \
3327      vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3328         (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3329
3330 #elif defined(__amigaos4__)
3331  /* A somewhat experimental attempt to simulate posix return code values */
3332 #   define STATUS_NATIVE        PL_statusvalue_posix
3333 #   define STATUS_NATIVE_CHILD_SET(n)                      \
3334         STMT_START {                                       \
3335             PL_statusvalue_posix = (n);                    \
3336             if (PL_statusvalue_posix < 0) {                \
3337                 PL_statusvalue = -1;                       \
3338             }                                              \
3339             else {                                         \
3340                 PL_statusvalue = n << 8;                   \
3341             }                                              \
3342         } STMT_END
3343 #   define STATUS_UNIX_SET(n)           \
3344         STMT_START {                    \
3345             PL_statusvalue = (n);               \
3346             if (PL_statusvalue != -1)   \
3347                 PL_statusvalue &= 0xFFFF;       \
3348         } STMT_END
3349 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3350 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3351 #   define STATUS_CURRENT STATUS_UNIX
3352 #   define STATUS_EXIT STATUS_UNIX
3353 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3354 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3355
3356 #else
3357 #   define STATUS_NATIVE        PL_statusvalue_posix
3358 #   if defined(WCOREDUMP)
3359 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3360             STMT_START {                                   \
3361                 PL_statusvalue_posix = (n);                \
3362                 if (PL_statusvalue_posix == -1)            \
3363                     PL_statusvalue = -1;                   \
3364                 else {                                     \
3365                     PL_statusvalue =                       \
3366                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3367                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3368                         (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0);  \
3369                 }                                          \
3370             } STMT_END
3371 #   elif defined(WIFEXITED)
3372 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3373             STMT_START {                                   \
3374                 PL_statusvalue_posix = (n);                \
3375                 if (PL_statusvalue_posix == -1)            \
3376                     PL_statusvalue = -1;                   \
3377                 else {                                     \
3378                     PL_statusvalue =                       \
3379                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3380                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0);  \
3381                 }                                          \
3382             } STMT_END
3383 #   else
3384 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3385             STMT_START {                                   \
3386                 PL_statusvalue_posix = (n);                \
3387                 if (PL_statusvalue_posix == -1)            \
3388                     PL_statusvalue = -1;                   \
3389                 else {                                     \
3390                     PL_statusvalue =                       \
3391                         PL_statusvalue_posix & 0xFFFF;     \
3392                 }                                          \
3393             } STMT_END
3394 #   endif
3395 #   define STATUS_UNIX_SET(n)           \
3396         STMT_START {                    \
3397             PL_statusvalue = (n);               \
3398             if (PL_statusvalue != -1)   \
3399                 PL_statusvalue &= 0xFFFF;       \
3400         } STMT_END
3401 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3402 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3403 #   define STATUS_CURRENT STATUS_UNIX
3404 #   define STATUS_EXIT STATUS_UNIX
3405 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3406 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3407 #endif
3408
3409 /* flags in PL_exit_flags for nature of exit() */
3410 #define PERL_EXIT_EXPECTED      0x01
3411 #define PERL_EXIT_DESTRUCT_END  0x02  /* Run END in perl_destruct */
3412 #define PERL_EXIT_WARN          0x04  /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3413 #define PERL_EXIT_ABORT         0x08  /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3414
3415 #ifndef PERL_CORE
3416 /* format to use for version numbers in file/directory names */
3417 /* XXX move to Configure? */
3418 /* This was only ever used for the current version, and that can be done at
3419    compile time, as PERL_FS_VERSION, so should we just delete it?  */
3420 #  ifndef PERL_FS_VER_FMT
3421 #    define PERL_FS_VER_FMT     "%d.%d.%d"
3422 #  endif
3423 #endif
3424
3425 #ifndef PERL_FS_VERSION
3426 #  define PERL_FS_VERSION       PERL_VERSION_STRING
3427 #endif
3428
3429 /* This defines a way to flush all output buffers.  This may be a
3430  * performance issue, so we allow people to disable it.  Also, if
3431  * we are using stdio, there are broken implementations of fflush(NULL)
3432  * out there, Solaris being the most prominent.
3433  */
3434 #ifndef PERL_FLUSHALL_FOR_CHILD
3435 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3436 #  define PERL_FLUSHALL_FOR_CHILD       PerlIO_flush((PerlIO*)NULL)
3437 # elif defined(FFLUSH_ALL)
3438 #  define PERL_FLUSHALL_FOR_CHILD       my_fflush_all()
3439 # else
3440 #  define PERL_FLUSHALL_FOR_CHILD       NOOP
3441 # endif
3442 #endif
3443
3444 #ifndef PERL_WAIT_FOR_CHILDREN
3445 #  define PERL_WAIT_FOR_CHILDREN        NOOP
3446 #endif
3447
3448 /* the traditional thread-unsafe notion of "current interpreter". */
3449 #ifndef PERL_SET_INTERP
3450 #  define PERL_SET_INTERP(i)            (PL_curinterp = (PerlInterpreter*)(i))
3451 #endif
3452
3453 #ifndef PERL_GET_INTERP
3454 #  define PERL_GET_INTERP               (PL_curinterp)
3455 #endif
3456
3457 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3458 #  ifdef MULTIPLICITY
3459 #    define PERL_GET_THX                ((PerlInterpreter *)PERL_GET_CONTEXT)
3460 #  endif
3461 #  define PERL_SET_THX(t)               PERL_SET_CONTEXT(t)
3462 #endif
3463
3464 /*
3465     This replaces the previous %_ "hack" by the "%p" hacks.
3466     All that is required is that the perl source does not
3467     use "%-p" or "%-<number>p" or "%<number>p" formats.
3468     These formats will still work in perl code.
3469     See comments in sv.c for further details.
3470
3471     Robin Barker 2005-07-14
3472
3473     No longer use %1p for VDf = %vd.  RMB 2007-10-19
3474 */
3475
3476 #ifndef SVf_
3477 #  define SVf_(n) "-" STRINGIFY(n) "p"
3478 #endif
3479
3480 #ifndef SVf
3481 #  define SVf "-p"
3482 #endif
3483
3484 #ifndef SVf32
3485 #  define SVf32 SVf_(32)
3486 #endif
3487
3488 #ifndef SVf256
3489 #  define SVf256 SVf_(256)
3490 #endif
3491
3492 #define SVfARG(p) ((void*)(p))
3493
3494 #ifndef HEKf
3495 #  define HEKf "2p"
3496 #endif
3497
3498 /* Not ideal, but we cannot easily include a number in an already-numeric
3499  * format sequence. */
3500 #ifndef HEKf256
3501 #  define HEKf256 "3p"
3502 #endif
3503
3504 #define HEKfARG(p) ((void*)(p))
3505
3506 /*
3507 =for apidoc Amnh||UTF8f
3508 =for apidoc Amh||UTF8fARG|bool is_utf8|Size_t byte_len|char *str
3509
3510 =cut
3511  * %4p is a custom format
3512  */
3513 #ifndef UTF8f
3514 #  define UTF8f "d%" UVuf "%4p"
3515 #endif
3516 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3517
3518 #define PNf UTF8f
3519 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
3520
3521 #ifdef PERL_CORE
3522 /* not used; but needed for backward compatibility with XS code? - RMB */
3523 #  undef UVf
3524 #elif !defined(UVf)
3525 #  define UVf UVuf
3526 #endif
3527
3528 #ifdef HASATTRIBUTE_DEPRECATED
3529 #  define __attribute__deprecated__         __attribute__((deprecated))
3530 #endif
3531 #ifdef HASATTRIBUTE_FORMAT
3532 #  define __attribute__format__(x,y,z)      __attribute__((format(x,y,z)))
3533 #endif
3534 #ifdef HASATTRIBUTE_MALLOC
3535 #  define __attribute__malloc__             __attribute__((__malloc__))
3536 #endif
3537 #ifdef HASATTRIBUTE_NONNULL
3538 #  define __attribute__nonnull__(a)         __attribute__((nonnull(a)))
3539 #endif
3540 #ifdef HASATTRIBUTE_NORETURN
3541 #  define __attribute__noreturn__           __attribute__((noreturn))
3542 #endif
3543 #ifdef HASATTRIBUTE_PURE
3544 #  define __attribute__pure__               __attribute__((pure))
3545 #endif
3546 #ifdef HASATTRIBUTE_UNUSED
3547 #  define __attribute__unused__             __attribute__((unused))
3548 #endif
3549 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
3550 #  define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
3551 #endif
3552
3553 /* If we haven't defined the attributes yet, define them to blank. */
3554 #ifndef __attribute__deprecated__
3555 #  define __attribute__deprecated__
3556 #endif
3557 #ifndef __attribute__format__
3558 #  define __attribute__format__(x,y,z)
3559 #endif
3560 #ifndef __attribute__malloc__
3561 #  define __attribute__malloc__
3562 #endif
3563 #ifndef __attribute__nonnull__
3564 #  define __attribute__nonnull__(a)
3565 #endif
3566 #ifndef __attribute__noreturn__
3567 #  define __attribute__noreturn__
3568 #endif
3569 #ifndef __attribute__pure__
3570 #  define __attribute__pure__
3571 #endif
3572 #ifndef __attribute__unused__
3573 #  define __attribute__unused__
3574 #endif
3575 #ifndef __attribute__warn_unused_result__
3576 #  define __attribute__warn_unused_result__
3577 #endif
3578
3579 #if !defined(DEBUGGING) && !defined(NDEBUG)
3580 #  define NDEBUG 1
3581 #endif
3582 #include <assert.h>
3583
3584 /* For functions that are marked as __attribute__noreturn__, it's not
3585    appropriate to call return.  In either case, include the lint directive.
3586  */
3587 #ifdef HASATTRIBUTE_NORETURN
3588 #  define NORETURN_FUNCTION_END NOT_REACHED;
3589 #else
3590 #  define NORETURN_FUNCTION_END NOT_REACHED; return 0
3591 #endif
3592
3593 /* Some OS warn on NULL format to printf */
3594 #ifdef PRINTF_FORMAT_NULL_OK
3595 #  define __attribute__format__null_ok__(x,y,z)  __attribute__format__(x,y,z)
3596 #else
3597 #  define __attribute__format__null_ok__(x,y,z)
3598 #endif
3599
3600 #ifdef HAS_BUILTIN_EXPECT
3601 #  define EXPECT(expr,val)                  __builtin_expect(expr,val)
3602 #else
3603 #  define EXPECT(expr,val)                  (expr)
3604 #endif
3605
3606 /*
3607 =head1 Miscellaneous Functions
3608
3609 =for apidoc AmU|bool|LIKELY|const bool expr
3610
3611 Returns the input unchanged, but at the same time it gives a branch prediction
3612 hint to the compiler that this condition is likely to be true.
3613
3614 =for apidoc AmU|bool|UNLIKELY|const bool expr
3615
3616 Returns the input unchanged, but at the same time it gives a branch prediction
3617 hint to the compiler that this condition is likely to be false.
3618
3619 =cut
3620 */
3621 #define LIKELY(cond)                        EXPECT(cBOOL(cond),TRUE)
3622 #define UNLIKELY(cond)                      EXPECT(cBOOL(cond),FALSE)
3623
3624 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3625 /* placeholder */
3626 #endif
3627
3628 /* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
3629    time invariants. That is, their argument must be a constant expression that
3630    can be verified by the compiler. This expression can contain anything that's
3631    known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3632    the expression evaluates to 0, compilation fails.
3633    Because they generate no runtime code (i.e.  their use is "free"), they're
3634    always active, even under non-DEBUGGING builds.
3635    STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
3636    file scope (outside of any function).
3637    STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3638    function.
3639 */
3640 #if (defined(static_assert) || (defined(__cplusplus) && __cplusplus >= 201103L)) && (!defined(__IBMC__) || __IBMC__ >= 1210)
3641 /* static_assert is a macro defined in <assert.h> in C11 or a compiler
3642    builtin in C++11.  But IBM XL C V11 does not support _Static_assert, no
3643    matter what <assert.h> says.
3644 */
3645 #  define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
3646 #else
3647 /* We use a bit-field instead of an array because gcc accepts
3648    'typedef char x[n]' where n is not a compile-time constant.
3649    We want to enforce constantness.
3650 */
3651 #  define STATIC_ASSERT_2(COND, SUFFIX) \
3652     typedef struct { \
3653         unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3654     } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3655 #  define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
3656 #  define STATIC_ASSERT_DECL(COND)    STATIC_ASSERT_1(COND, __LINE__)
3657 #endif
3658 /* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3659    error (static_assert is a declaration, and only statements can have labels).
3660 */
3661 #define STATIC_ASSERT_STMT(COND)      STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
3662
3663 #ifndef __has_builtin
3664 #  define __has_builtin(x) 0 /* not a clang style compiler */
3665 #endif
3666
3667 /* ASSUME is like assert(), but it has a benefit in a release build. It is a
3668    hint to a compiler about a statement of fact in a function call free
3669    expression, which allows the compiler to generate better machine code.
3670    In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3671    the control path is unreachable. In a for loop, ASSUME can be used to hint
3672    that a loop will run at least X times. ASSUME is based off MSVC's __assume
3673    intrinsic function, see its documents for more details.
3674 */
3675
3676 #ifndef DEBUGGING
3677 #  if __has_builtin(__builtin_unreachable) \
3678      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4) /* 4.5 -> */
3679 #    define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3680 #  elif defined(_MSC_VER)
3681 #    define ASSUME(x) __assume(x)
3682 #  elif defined(__ARMCC_VERSION) /* untested */
3683 #    define ASSUME(x) __promise(x)
3684 #  else
3685 /* a random compiler might define assert to its own special optimization token
3686    so pass it through to C lib as a last resort */
3687 #    define ASSUME(x) assert(x)
3688 #  endif
3689 #else
3690 #  define ASSUME(x) assert(x)
3691 #endif
3692
3693 #if defined(__sun)      /* ASSUME() generates warnings on Solaris */
3694 #  define NOT_REACHED
3695 #elif defined(DEBUGGING) && (__has_builtin(__builtin_unreachable) \
3696      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4)) /* 4.5 -> */
3697 #  define NOT_REACHED STMT_START { ASSUME(!"UNREACHABLE"); __builtin_unreachable(); } STMT_END
3698 #else
3699 #  define NOT_REACHED ASSUME(!"UNREACHABLE")
3700 #endif
3701
3702 /* Some unistd.h's give a prototype for pause() even though
3703    HAS_PAUSE ends up undefined.  This causes the #define
3704    below to be rejected by the compiler.  Sigh.
3705 */
3706 #ifdef HAS_PAUSE
3707 #define Pause   pause
3708 #else
3709 #define Pause() sleep((32767<<16)+32767)
3710 #endif
3711
3712 #ifndef IOCPARM_LEN
3713 #   ifdef IOCPARM_MASK
3714         /* on BSDish systems we're safe */
3715 #       define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
3716 #   elif defined(_IOC_SIZE) && defined(__GLIBC__)
3717         /* on Linux systems we're safe; except when we're not [perl #38223] */
3718 #       define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3719 #   else
3720         /* otherwise guess at what's safe */
3721 #       define IOCPARM_LEN(x)   256
3722 #   endif
3723 #endif
3724
3725 #if defined(__CYGWIN__)
3726 /* USEMYBINMODE
3727  *   This symbol, if defined, indicates that the program should
3728  *   use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3729  *   that a file is in "binary" mode -- that is, that no translation
3730  *   of bytes occurs on read or write operations.
3731  */
3732 #  define USEMYBINMODE /**/
3733 #  include <io.h> /* for setmode() prototype */
3734 #  define my_binmode(fp, iotype, mode) \
3735             cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
3736 #endif
3737
3738 #ifdef __CYGWIN__
3739 void init_os_extras(void);
3740 #endif
3741
3742 #ifdef UNION_ANY_DEFINITION
3743 UNION_ANY_DEFINITION;
3744 #else
3745 union any {
3746     void*       any_ptr;
3747     SV*         any_sv;
3748     SV**        any_svp;
3749     GV*         any_gv;
3750     AV*         any_av;
3751     HV*         any_hv;
3752     OP*         any_op;
3753     char*       any_pv;
3754     char**      any_pvp;
3755     I32         any_i32;
3756     U32         any_u32;
3757     IV          any_iv;
3758     UV          any_uv;
3759     long        any_long;
3760     bool        any_bool;
3761     void        (*any_dptr) (void*);
3762     void        (*any_dxptr) (pTHX_ void*);
3763 };
3764 #endif
3765
3766 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3767
3768 #define FILTER_READ(idx, sv, len)  filter_read(idx, sv, len)
3769 #define FILTER_DATA(idx) \
3770             (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3771 #define FILTER_ISREADER(idx) \
3772             (PL_parser && PL_parser->rsfp_filters \
3773                 && idx >= AvFILLp(PL_parser->rsfp_filters))
3774 #define PERL_FILTER_EXISTS(i) \
3775             (PL_parser && PL_parser->rsfp_filters \
3776                 && (i) <= av_tindex(PL_parser->rsfp_filters))
3777
3778 #if defined(_AIX) && !defined(_AIX43)
3779 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3780 /* We cannot include <crypt.h> to get the struct crypt_data
3781  * because of setkey prototype problems when threading */
3782 typedef        struct crypt_data {     /* straight from /usr/include/crypt.h */
3783     /* From OSF, Not needed in AIX
3784        char C[28], D[28];
3785     */
3786     char E[48];
3787     char KS[16][48];
3788     char block[66];
3789     char iobuf[16];
3790 } CRYPTD;
3791 #endif /* threading */
3792 #endif /* AIX */
3793
3794 #ifndef PERL_CALLCONV
3795 #  ifdef __cplusplus
3796 #    define PERL_CALLCONV extern "C"
3797 #  else
3798 #    define PERL_CALLCONV
3799 #  endif
3800 #endif
3801 #ifndef PERL_CALLCONV_NO_RET
3802 #    define PERL_CALLCONV_NO_RET PERL_CALLCONV
3803 #endif
3804
3805 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
3806    dont have a noreturn as a declaration specifier
3807 */
3808 #ifndef PERL_STATIC_NO_RET
3809 #  define PERL_STATIC_NO_RET STATIC
3810 #endif
3811 /* PERL_STATIC_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE on
3812    builds that dont have a noreturn as a declaration specifier
3813 */
3814 #ifndef PERL_STATIC_INLINE_NO_RET
3815 #  define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
3816 #endif
3817
3818 #if !defined(OS2)
3819 #  include "iperlsys.h"
3820 #endif
3821
3822 #ifdef __LIBCATAMOUNT__
3823 #undef HAS_PASSWD  /* unixish.h but not unixish enough. */
3824 #undef HAS_GROUP
3825 #define FAKE_BIT_BUCKET
3826 #endif
3827
3828 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3829  * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
3830  * Configure, despite their names being similar to other defines like
3831  * USE_ITHREADS.  Configure in fact knows nothing about the randomised
3832  * hashes.  Therefore to enable/disable the hash randomisation defines
3833  * use the Configure -Accflags=... instead. */
3834 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
3835 #  define USE_HASH_SEED
3836 #endif
3837
3838 #include "perly.h"
3839
3840
3841 /* macros to define bit-fields in structs. */
3842 #ifndef PERL_BITFIELD8
3843 #  define PERL_BITFIELD8 unsigned
3844 #endif
3845 #ifndef PERL_BITFIELD16
3846 #  define PERL_BITFIELD16 unsigned
3847 #endif
3848 #ifndef PERL_BITFIELD32
3849 #  define PERL_BITFIELD32 unsigned
3850 #endif
3851
3852 #include "sv.h"
3853 #include "regexp.h"
3854 #include "util.h"
3855 #include "form.h"
3856 #include "gv.h"
3857 #include "pad.h"
3858 #include "cv.h"
3859 #include "opnames.h"
3860 #include "op.h"
3861 #include "hv.h"
3862 #include "cop.h"
3863 #include "av.h"
3864 #include "mg.h"
3865 #include "scope.h"
3866 #include "warnings.h"
3867 #include "utf8.h"
3868
3869 /* these would be in doio.h if there was such a file */
3870 #define my_stat()  my_stat_flags(SV_GMAGIC)
3871 #define my_lstat() my_lstat_flags(SV_GMAGIC)
3872
3873 /* defined in sv.c, but also used in [ach]v.c */
3874 #undef _XPV_HEAD
3875 #undef _XPVMG_HEAD
3876 #undef _XPVCV_COMMON
3877
3878 #include "parser.h"
3879
3880 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
3881
3882 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3883
3884 /* These have to be predeclared, as they are used in proto.h which is #included
3885  * before their definitions in regcomp.h. */
3886
3887 struct scan_data_t;
3888 typedef struct regnode_charclass regnode_charclass;
3889
3890 /* A hopefully less confusing name.  The sub-classes are all Posix classes only
3891  * used under /l matching */
3892 typedef struct regnode_charclass_posixl regnode_charclass_class;
3893 typedef struct regnode_charclass_posixl regnode_charclass_posixl;
3894
3895 typedef struct regnode_ssc regnode_ssc;
3896 typedef struct RExC_state_t RExC_state_t;
3897 struct _reg_trie_data;
3898
3899 #endif
3900
3901 struct ptr_tbl_ent {
3902     struct ptr_tbl_ent*         next;
3903     const void*                 oldval;
3904     void*                       newval;
3905 };
3906
3907 struct ptr_tbl {
3908     struct ptr_tbl_ent**        tbl_ary;
3909     UV                          tbl_max;
3910     UV                          tbl_items;
3911     struct ptr_tbl_arena        *tbl_arena;
3912     struct ptr_tbl_ent          *tbl_arena_next;
3913     struct ptr_tbl_ent          *tbl_arena_end;
3914 };
3915
3916 #if defined(htonl) && !defined(HAS_HTONL)
3917 #define HAS_HTONL
3918 #endif
3919 #if defined(htons) && !defined(HAS_HTONS)
3920 #define HAS_HTONS
3921 #endif
3922 #if defined(ntohl) && !defined(HAS_NTOHL)
3923 #define HAS_NTOHL
3924 #endif
3925 #if defined(ntohs) && !defined(HAS_NTOHS)
3926 #define HAS_NTOHS
3927 #endif
3928 #ifndef HAS_HTONL
3929 #define HAS_HTONS
3930 #define HAS_HTONL
3931 #define HAS_NTOHS
3932 #define HAS_NTOHL
3933 #  if (BYTEORDER & 0xffff) == 0x4321
3934 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
3935    re-order their values. However, to behave identically to the alternative
3936    implementations, they should truncate to the correct size.  */
3937 #    define ntohl(x)    ((x)&0xFFFFFFFF)
3938 #    define htonl(x)    ntohl(x)
3939 #    define ntohs(x)    ((x)&0xFFFF)
3940 #    define htons(x)    ntohs(x)
3941 #  elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3942
3943 /* Note that we can't straight out declare our own htonl and htons because
3944    the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
3945    to avoid the overhead of initialising the socket subsystem, but the headers
3946    that *declare* the various functions are still seen. If we declare our own
3947    htonl etc they will clash with the declarations in the Win32 headers.  */
3948
3949 PERL_STATIC_INLINE U32
3950 my_swap32(const U32 x) {
3951     return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)
3952         | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
3953 }
3954
3955 PERL_STATIC_INLINE U16
3956 my_swap16(const U16 x) {
3957     return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
3958 }
3959
3960 #    define htonl(x)    my_swap32(x)
3961 #    define ntohl(x)    my_swap32(x)
3962 #    define ntohs(x)    my_swap16(x)
3963 #    define htons(x)    my_swap16(x)
3964 #  else
3965 #    error "Unsupported byteorder"
3966 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
3967    the error message. Please check the value of the macro BYTEORDER, as defined
3968    in config.h. The values of BYTEORDER we expect are
3969
3970             big endian  little endian
3971    32 bit       0x4321  0x1234
3972    64 bit   0x87654321  0x12345678
3973
3974    If you have a system with a different byte order, please see
3975    pod/perlhack.pod for how to submit a patch to add supporting code.
3976 */
3977 #  endif
3978 #endif
3979
3980 /*
3981  * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
3982  * -DWS
3983  */
3984 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3985 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
3986    re-order their values. However, to behave identically to the alternative
3987    implementations, they should truncate to the correct size.  */
3988 #  define vtohl(x)      ((x)&0xFFFFFFFF)
3989 #  define vtohs(x)      ((x)&0xFFFF)
3990 #  define htovl(x)      vtohl(x)
3991 #  define htovs(x)      vtohs(x)
3992 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
3993 #  define vtohl(x)      ((((x)&0xFF)<<24)       \
3994                         +(((x)>>24)&0xFF)       \
3995                         +(((x)&0x0000FF00)<<8)  \
3996                         +(((x)&0x00FF0000)>>8)  )
3997 #  define vtohs(x)      ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
3998 #  define htovl(x)      vtohl(x)
3999 #  define htovs(x)      vtohs(x)
4000 #else
4001 #  error "Unsupported byteorder"
4002 /* If you have need for current perl on PDP-11 or similar, and can help test
4003    that blead keeps working on a mixed-endian system, then see
4004    pod/perlhack.pod for how to submit patches to things working again.  */
4005 #endif
4006
4007 /* *MAX Plus 1. A floating point value.
4008    Hopefully expressed in a way that dodgy floating point can't mess up.
4009    >> 2 rather than 1, so that value is safely less than I32_MAX after 1
4010    is added to it
4011    May find that some broken compiler will want the value cast to I32.
4012    [after the shift, as signed >> may not be as secure as unsigned >>]
4013 */
4014 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
4015 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
4016 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
4017    0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
4018    may be greater than sizeof(IV), so don't assume that half max UV is max IV.
4019 */
4020 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
4021
4022 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
4023 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
4024 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
4025
4026 /* This may look like unnecessary jumping through hoops, but converting
4027    out of range floating point values to integers *is* undefined behaviour,
4028    and it is starting to bite.
4029 */
4030 #ifndef CAST_INLINE
4031 #define I_32(what) (cast_i32((NV)(what)))
4032 #define U_32(what) (cast_ulong((NV)(what)))
4033 #define I_V(what) (cast_iv((NV)(what)))
4034 #define U_V(what) (cast_uv((NV)(what)))
4035 #else
4036 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
4037                   : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
4038                      : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
4039 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
4040                   : ((n) < U32_MAX_P1 ? (U32) (n) \
4041                      : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
4042 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
4043                   : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
4044                      : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
4045 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
4046                   : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
4047                      : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
4048 #endif
4049
4050 #define U_S(what) ((U16)U_32(what))
4051 #define U_I(what) ((unsigned int)U_32(what))
4052 #define U_L(what) U_32(what)
4053
4054 #ifdef HAS_SIGNBIT
4055 #  ifndef Perl_signbit
4056 #    define Perl_signbit signbit
4057 #  endif
4058 #endif
4059
4060 /* These do not care about the fractional part, only about the range. */
4061 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
4062 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
4063
4064 /* Used with UV/IV arguments: */
4065                                         /* XXXX: need to speed it up */
4066 #define CLUMP_2UV(iv)   ((iv) < 0 ? 0 : (UV)(iv))
4067 #define CLUMP_2IV(uv)   ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
4068
4069 #ifndef MAXSYSFD
4070 #   define MAXSYSFD 2
4071 #endif
4072
4073 #ifndef __cplusplus
4074 #if !(defined(WIN32) || defined(SYMBIAN))
4075 Uid_t getuid (void);
4076 Uid_t geteuid (void);
4077 Gid_t getgid (void);
4078 Gid_t getegid (void);
4079 #endif
4080 #endif
4081
4082 #ifndef Perl_debug_log
4083 #  define Perl_debug_log        PerlIO_stderr()
4084 #endif
4085
4086 #ifndef Perl_error_log
4087 #  define Perl_error_log        (PL_stderrgv                    \
4088                                  && isGV(PL_stderrgv)           \
4089                                  && GvIOp(PL_stderrgv)          \
4090                                  && IoOFP(GvIOp(PL_stderrgv))   \
4091                                  ? IoOFP(GvIOp(PL_stderrgv))    \
4092                                  : PerlIO_stderr())
4093 #endif
4094
4095
4096 #define DEBUG_p_FLAG            0x00000001 /*      1 */
4097 #define DEBUG_s_FLAG            0x00000002 /*      2 */
4098 #define DEBUG_l_FLAG            0x00000004 /*      4 */
4099 #define DEBUG_t_FLAG            0x00000008 /*      8 */
4100 #define DEBUG_o_FLAG            0x00000010 /*     16 */
4101 #define DEBUG_c_FLAG            0x00000020 /*     32 */
4102 #define DEBUG_P_FLAG            0x00000040 /*     64 */
4103 #define DEBUG_m_FLAG            0x00000080 /*    128 */
4104 #define DEBUG_f_FLAG            0x00000100 /*    256 */
4105 #define DEBUG_r_FLAG            0x00000200 /*    512 */
4106 #define DEBUG_x_FLAG            0x00000400 /*   1024 */
4107 #define DEBUG_u_FLAG            0x00000800 /*   2048 */
4108 /* U is reserved for Unofficial, exploratory hacking */
4109 #define DEBUG_U_FLAG            0x00001000 /*   4096 */
4110 /* spare                                        8192 */
4111 #define DEBUG_X_FLAG            0x00004000 /*  16384 */
4112 #define DEBUG_D_FLAG            0x00008000 /*  32768 */
4113 #define DEBUG_S_FLAG            0x00010000 /*  65536 */
4114 #define DEBUG_T_FLAG            0x00020000 /* 131072 */
4115 #define DEBUG_R_FLAG            0x00040000 /* 262144 */
4116 #define DEBUG_J_FLAG            0x00080000 /* 524288 */
4117 #define DEBUG_v_FLAG            0x00100000 /*1048576 */
4118 #define DEBUG_C_FLAG            0x00200000 /*2097152 */
4119 #define DEBUG_A_FLAG            0x00400000 /*4194304 */
4120 #define DEBUG_q_FLAG            0x00800000 /*8388608 */
4121 #define DEBUG_M_FLAG            0x01000000 /*16777216*/
4122 #define DEBUG_B_FLAG            0x02000000 /*33554432*/
4123 #define DEBUG_L_FLAG            0x04000000 /*67108864*/
4124 #define DEBUG_i_FLAG            0x08000000 /*134217728*/
4125 #define DEBUG_y_FLAG            0x10000000 /*268435456*/
4126 #define DEBUG_MASK              0x1FFFEFFF /* mask of all the standard flags */
4127
4128 #define DEBUG_DB_RECURSE_FLAG   0x40000000
4129 #define DEBUG_TOP_FLAG          0x80000000 /* -D was given --> PL_debug |= FLAG */
4130
4131 #  define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
4132 #  define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
4133 #  define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
4134 #  define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
4135 #  define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
4136 #  define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
4137 #  define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
4138 #  define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
4139 #  define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
4140 #  define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
4141 #  define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
4142 #  define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
4143 #  define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
4144 #  define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
4145 #  define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
4146 #  define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
4147 #  define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
4148 #  define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
4149 #  define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
4150 #  define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
4151 #  define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
4152 #  define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
4153 #  define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
4154 #  define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
4155 #  define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
4156 #  define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
4157 #  define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
4158 #  define DEBUG_y_TEST_ UNLIKELY(PL_debug & DEBUG_y_FLAG)
4159 #  define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
4160 #  define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
4161 #  define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
4162 #  define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
4163 #  define DEBUG_yv_TEST_ (DEBUG_y_TEST_ && DEBUG_v_TEST_)
4164
4165 #ifdef DEBUGGING
4166
4167 #  define DEBUG_p_TEST DEBUG_p_TEST_
4168 #  define DEBUG_s_TEST DEBUG_s_TEST_
4169 #  define DEBUG_l_TEST DEBUG_l_TEST_
4170 #  define DEBUG_t_TEST DEBUG_t_TEST_
4171 #  define DEBUG_o_TEST DEBUG_o_TEST_
4172 #  define DEBUG_c_TEST DEBUG_c_TEST_
4173 #  define DEBUG_P_TEST DEBUG_P_TEST_
4174 #  define DEBUG_m_TEST DEBUG_m_TEST_
4175 #  define DEBUG_f_TEST DEBUG_f_TEST_
4176 #  define DEBUG_r_TEST DEBUG_r_TEST_
4177 #  define DEBUG_x_TEST DEBUG_x_TEST_
4178 #  define DEBUG_u_TEST DEBUG_u_TEST_
4179 #  define DEBUG_U_TEST DEBUG_U_TEST_
4180 #  define DEBUG_X_TEST DEBUG_X_TEST_
4181 #  define DEBUG_D_TEST DEBUG_D_TEST_
4182 #  define DEBUG_S_TEST DEBUG_S_TEST_
4183 #  define DEBUG_T_TEST DEBUG_T_TEST_
4184 #  define DEBUG_R_TEST DEBUG_R_TEST_
4185 #  define DEBUG_J_TEST DEBUG_J_TEST_
4186 #  define DEBUG_v_TEST DEBUG_v_TEST_
4187 #  define DEBUG_C_TEST DEBUG_C_TEST_
4188 #  define DEBUG_A_TEST DEBUG_A_TEST_
4189 #  define DEBUG_q_TEST DEBUG_q_TEST_
4190 #  define DEBUG_M_TEST DEBUG_M_TEST_
4191 #  define DEBUG_B_TEST DEBUG_B_TEST_
4192 #  define DEBUG_L_TEST DEBUG_L_TEST_
4193 #  define DEBUG_i_TEST DEBUG_i_TEST_
4194 #  define DEBUG_y_TEST DEBUG_y_TEST_
4195 #  define DEBUG_Xv_TEST DEBUG_Xv_TEST_
4196 #  define DEBUG_Uv_TEST DEBUG_Uv_TEST_
4197 #  define DEBUG_Pv_TEST DEBUG_Pv_TEST_
4198 #  define DEBUG_Lv_TEST DEBUG_Lv_TEST_
4199 #  define DEBUG_yv_TEST DEBUG_yv_TEST_
4200
4201 #  define PERL_DEB(a)                  a
4202 #  define PERL_DEB2(a,b)               a
4203 #  define PERL_DEBUG(a) if (PL_debug)  a
4204 #  define DEBUG_p(a) if (DEBUG_p_TEST) a
4205 #  define DEBUG_s(a) if (DEBUG_s_TEST) a
4206 #  define DEBUG_l(a) if (DEBUG_l_TEST) a
4207 #  define DEBUG_t(a) if (DEBUG_t_TEST) a
4208 #  define DEBUG_o(a) if (DEBUG_o_TEST) a
4209 #  define DEBUG_c(a) if (DEBUG_c_TEST) a
4210 #  define DEBUG_P(a) if (DEBUG_P_TEST) a
4211
4212      /* Temporarily turn off memory debugging in case the a
4213       * does memory allocation, either directly or indirectly. */
4214 #  define DEBUG_m(a)  \
4215     STMT_START {                                                        \
4216         if (PERL_GET_INTERP) {                                          \
4217                                 dTHX;                                   \
4218                                 if (DEBUG_m_TEST) {                     \
4219                                     PL_debug &= ~DEBUG_m_FLAG;          \
4220                                     a;                                  \
4221                                     PL_debug |= DEBUG_m_FLAG;           \
4222                                 }                                       \
4223                               }                                         \
4224     } STMT_END
4225
4226 #  define DEBUG__(t, a)                                                 \
4227         STMT_START {                                                    \
4228                 if (t) STMT_START {a;} STMT_END;                        \
4229         } STMT_END
4230
4231 #  define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
4232
4233 #  ifndef PERL_EXT_RE_BUILD
4234 #    define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
4235 #  else
4236 #    define DEBUG_r(a) STMT_START {a;} STMT_END
4237 #  endif /* PERL_EXT_RE_BUILD */
4238
4239 #  define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
4240 #  define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
4241 #  define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
4242 #  define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
4243 #  define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
4244 #  define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
4245 #  define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
4246 #  define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
4247 #  define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
4248 #  define DEBUG_yv(a) DEBUG__(DEBUG_yv_TEST, a)
4249
4250 #  define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
4251 #  define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
4252 #  define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
4253 #  define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
4254 #  define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
4255 #  define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
4256 #  define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
4257 #  define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
4258 #  define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
4259 #  define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
4260 #  define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
4261 #  define DEBUG_y(a) DEBUG__(DEBUG_y_TEST, a)
4262
4263 #else /* ! DEBUGGING below */
4264
4265 #  define DEBUG_p_TEST (0)
4266 #  define DEBUG_s_TEST (0)
4267 #  define DEBUG_l_TEST (0)
4268 #  define DEBUG_t_TEST (0)
4269 #  define DEBUG_o_TEST (0)
4270 #  define DEBUG_c_TEST (0)
4271 #  define DEBUG_P_TEST (0)
4272 #  define DEBUG_m_TEST (0)
4273 #  define DEBUG_f_TEST (0)
4274 #  define DEBUG_r_TEST (0)
4275 #  define DEBUG_x_TEST (0)
4276 #  define DEBUG_u_TEST (0)
4277 #  define DEBUG_U_TEST (0)
4278 #  define DEBUG_X_TEST (0)
4279 #  define DEBUG_D_TEST (0)
4280 #  define DEBUG_S_TEST (0)
4281 #  define DEBUG_T_TEST (0)
4282 #  define DEBUG_R_TEST (0)
4283 #  define DEBUG_J_TEST (0)
4284 #  define DEBUG_v_TEST (0)
4285 #  define DEBUG_C_TEST (0)
4286 #  define DEBUG_A_TEST (0)
4287 #  define DEBUG_q_TEST (0)
4288 #  define DEBUG_M_TEST (0)
4289 #  define DEBUG_B_TEST (0)
4290 #  define DEBUG_L_TEST (0)
4291 #  define DEBUG_i_TEST (0)
4292 #  define DEBUG_y_TEST (0)
4293 #  define DEBUG_Xv_TEST (0)
4294 #  define DEBUG_Uv_TEST (0)
4295 #  define DEBUG_Pv_TEST (0)
4296 #  define DEBUG_Lv_TEST (0)
4297 #  define DEBUG_yv_TEST (0)
4298
4299 #  define PERL_DEB(a)
4300 #  define PERL_DEB2(a,b)               b
4301 #  define PERL_DEBUG(a)
4302 #  define DEBUG_p(a)
4303 #  define DEBUG_s(a)
4304 #  define DEBUG_l(a)
4305 #  define DEBUG_t(a)
4306 #  define DEBUG_o(a)
4307 #  define DEBUG_c(a)
4308 #  define DEBUG_P(a)
4309 #  define DEBUG_m(a)
4310 #  define DEBUG_f(a)
4311 #  define DEBUG_r(a)
4312 #  define DEBUG_x(a)
4313 #  define DEBUG_u(a)
4314 #  define DEBUG_U(a)
4315 #  define DEBUG_X(a)
4316 #  define DEBUG_D(a)
4317 #  define DEBUG_S(a)
4318 #  define DEBUG_T(a)
4319 #  define DEBUG_R(a)
4320 #  define DEBUG_v(a)
4321 #  define DEBUG_C(a)
4322 #  define DEBUG_A(a)
4323 #  define DEBUG_q(a)
4324 #  define DEBUG_M(a)
4325 #  define DEBUG_B(a)
4326 #  define DEBUG_L(a)
4327 #  define DEBUG_i(a)
4328 #  define DEBUG_y(a)
4329 #  define DEBUG_Xv(a)
4330 #  define DEBUG_Uv(a)
4331 #  define DEBUG_Pv(a)
4332 #  define DEBUG_Lv(a)
4333 #  define DEBUG_yv(a)
4334 #endif /* DEBUGGING */
4335
4336
4337 #define DEBUG_SCOPE(where) \
4338     DEBUG_l( \
4339     Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n",   \
4340                     where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
4341                     __FILE__, __LINE__));
4342
4343 /* Keep the old croak based assert for those who want it, and as a fallback if
4344    the platform is so heretically non-ANSI that it can't assert.  */
4345
4346 #define Perl_assert(what)       PERL_DEB2(                              \
4347         ((what) ? ((void) 0) :                                          \
4348             (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
4349                         "\", line %d", STRINGIFY(what), __LINE__),      \
4350              (void) 0)), ((void)0))
4351
4352 /* assert() gets defined if DEBUGGING.
4353  * If no DEBUGGING, the <assert.h> has not been included. */
4354 #ifndef assert
4355 #  define assert(what)  Perl_assert(what)
4356 #endif
4357 #ifdef DEBUGGING
4358 #  define assert_(what) assert(what),
4359 #else
4360 #  define assert_(what)
4361 #endif
4362
4363 struct ufuncs {
4364     I32 (*uf_val)(pTHX_ IV, SV*);
4365     I32 (*uf_set)(pTHX_ IV, SV*);
4366     IV uf_index;
4367 };
4368
4369 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4370  * XS code wanting to be backward compatible can do something
4371  * like the following:
4372
4373 #ifndef PERL_MG_UFUNC
4374 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4375 #endif
4376
4377 static PERL_MG_UFUNC(foo_get, index, val)
4378 {
4379     sv_setsv(val, ...);
4380     return TRUE;
4381 }
4382
4383 -- Doug MacEachern
4384
4385 */
4386
4387 #ifndef PERL_MG_UFUNC
4388 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4389 #endif
4390
4391 #include <math.h>
4392 #ifdef __VMS
4393      /* isfinite and others are here rather than in math.h as C99 stipulates */
4394 #    include <fp.h>
4395 #endif
4396
4397 #ifndef __cplusplus
4398 #  if !defined(WIN32) && !defined(VMS)
4399 #ifndef crypt
4400 char *crypt (const char*, const char*);
4401 #endif
4402 #  endif /* !WIN32 */
4403 #  ifndef WIN32
4404 #    ifndef getlogin
4405 char *getlogin (void);
4406 #    endif
4407 #  endif /* !WIN32 */
4408 #endif /* !__cplusplus */
4409
4410 /* Fixme on VMS.  This needs to be a run-time, not build time options */
4411 /* Also rename() is affected by this */
4412 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4413 #define UNLINK unlnk
4414 I32 unlnk (pTHX_ const char*);
4415 #else
4416 #define UNLINK PerlLIO_unlink
4417 #endif
4418
4419 /* some versions of glibc are missing the setresuid() proto */
4420 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4421 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4422 #endif
4423 /* some versions of glibc are missing the setresgid() proto */
4424 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4425 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4426 #endif
4427
4428 #ifndef HAS_SETREUID
4429 #  ifdef HAS_SETRESUID
4430 #    define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4431 #    define HAS_SETREUID
4432 #  endif
4433 #endif
4434 #ifndef HAS_SETREGID
4435 #  ifdef HAS_SETRESGID
4436 #    define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4437 #    define HAS_SETREGID
4438 #  endif
4439 #endif
4440
4441 /* Sighandler_t defined in iperlsys.h */
4442
4443 #ifdef HAS_SIGACTION
4444 typedef struct sigaction Sigsave_t;
4445 #else
4446 typedef Sighandler_t Sigsave_t;
4447 #endif
4448
4449 #define SCAN_DEF 0
4450 #define SCAN_TR 1
4451 #define SCAN_REPL 2
4452
4453 #ifdef DEBUGGING
4454 # ifndef register
4455 #  define register
4456 # endif
4457 # define RUNOPS_DEFAULT Perl_runops_debug
4458 #else
4459 # define RUNOPS_DEFAULT Perl_runops_standard
4460 #endif
4461
4462 #if defined(USE_PERLIO)
4463 EXTERN_C void PerlIO_teardown(void);
4464 # ifdef USE_ITHREADS
4465 #  define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4466 #  define PERLIO_TERM                           \
4467         STMT_START {                            \
4468                 PerlIO_teardown();              \
4469                 MUTEX_DESTROY(&PL_perlio_mutex);\
4470         } STMT_END
4471 # else
4472 #  define PERLIO_INIT
4473 #  define PERLIO_TERM   PerlIO_teardown()
4474 # endif
4475 #else
4476 #  define PERLIO_INIT
4477 #  define PERLIO_TERM
4478 #endif
4479
4480 #ifdef MYMALLOC
4481 #  ifdef MUTEX_INIT_CALLS_MALLOC
4482 #    define MALLOC_INIT                                 \
4483         STMT_START {                                    \
4484                 PL_malloc_mutex = NULL;                 \
4485                 MUTEX_INIT(&PL_malloc_mutex);           \
4486         } STMT_END
4487 #    define MALLOC_TERM                                 \
4488         STMT_START {                                    \
4489                 perl_mutex tmp = PL_malloc_mutex;       \
4490                 PL_malloc_mutex = NULL;                 \
4491                 MUTEX_DESTROY(&tmp);                    \
4492         } STMT_END
4493 #  else
4494 #    define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4495 #    define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4496 #  endif
4497 #else
4498 #  define MALLOC_INIT
4499 #  define MALLOC_TERM
4500 #endif
4501
4502 #if defined(PERL_IMPLICIT_CONTEXT)
4503
4504 struct perl_memory_debug_header;
4505 struct perl_memory_debug_header {
4506   tTHX  interpreter;
4507 #  if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4508   MEM_SIZE size;
4509 #  endif
4510   struct perl_memory_debug_header *prev;
4511   struct perl_memory_debug_header *next;
4512 #  ifdef PERL_DEBUG_READONLY_COW
4513   bool readonly;
4514 #  endif
4515 };
4516
4517 #elif defined(PERL_DEBUG_READONLY_COW)
4518
4519 struct perl_memory_debug_header;
4520 struct perl_memory_debug_header {
4521   MEM_SIZE size;
4522 };
4523
4524 #endif
4525
4526 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4527
4528 #  define PERL_MEMORY_DEBUG_HEADER_SIZE \
4529         (sizeof(struct perl_memory_debug_header) + \
4530         (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4531          %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4532
4533 #else
4534 #  define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4535 #endif
4536
4537 #ifdef PERL_TRACK_MEMPOOL
4538 # ifdef PERL_DEBUG_READONLY_COW
4539 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4540         STMT_START {                                            \
4541                 (header).interpreter = (interp);                \
4542                 (header).prev = (header).next = &(header);      \
4543                 (header).readonly = 0;                          \
4544         } STMT_END
4545 # else
4546 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4547         STMT_START {                                            \
4548                 (header).interpreter = (interp);                \
4549                 (header).prev = (header).next = &(header);      \
4550         } STMT_END
4551 # endif
4552 # else
4553 #  define INIT_TRACK_MEMPOOL(header, interp)
4554 #endif
4555
4556 #ifdef I_MALLOCMALLOC
4557 /* Needed for malloc_size(), malloc_good_size() on some systems */
4558 #  include <malloc/malloc.h>
4559 #endif
4560
4561 #ifdef MYMALLOC
4562 #  define Perl_safesysmalloc_size(where)        Perl_malloced_size(where)
4563 #else
4564 #  if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4565 #    ifdef PERL_TRACK_MEMPOOL
4566 #       define Perl_safesysmalloc_size(where)                   \
4567             (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4568 #    else
4569 #       define Perl_safesysmalloc_size(where) malloc_size(where)
4570 #    endif
4571 #  endif
4572 #  ifdef HAS_MALLOC_GOOD_SIZE
4573 #    ifdef PERL_TRACK_MEMPOOL
4574 #       define Perl_malloc_good_size(how_much)                  \
4575             (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4576 #    else
4577 #       define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4578 #    endif
4579 #  else
4580 /* Having this as the identity operation makes some code simpler.  */
4581 #       define Perl_malloc_good_size(how_much)  (how_much)
4582 #  endif
4583 #endif
4584
4585 typedef int (*runops_proc_t)(pTHX);
4586 typedef void (*share_proc_t) (pTHX_ SV *sv);
4587 typedef int  (*thrhook_proc_t) (pTHX);
4588 typedef OP* (*PPADDR_t[]) (pTHX);
4589 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4590 typedef void (*despatch_signals_proc_t) (pTHX);
4591
4592 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4593 #  include <crt_externs.h>      /* for the env array */
4594 #  define environ (*_NSGetEnviron())
4595 #elif defined(USE_ENVIRON_ARRAY) && !defined(environ)
4596    /* VMS and some other platforms don't use the environ array */
4597 EXTERN_C char **environ;  /* environment variables supplied via exec */
4598 #endif
4599
4600 #define PERL_PATCHLEVEL_H_IMPLICIT
4601 #include "patchlevel.h"
4602 #undef PERL_PATCHLEVEL_H_IMPLICIT
4603
4604 #define PERL_VERSION_STRING     STRINGIFY(PERL_REVISION) "." \
4605                                 STRINGIFY(PERL_VERSION) "." \
4606                                 STRINGIFY(PERL_SUBVERSION)
4607
4608 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4609                                 STRINGIFY(PERL_API_VERSION) "." \
4610                                 STRINGIFY(PERL_API_SUBVERSION)
4611
4612 START_EXTERN_C
4613
4614 /* handy constants */
4615 EXTCONST char PL_warn_uninit[]
4616   INIT("Use of uninitialized value%s%s%s");
4617 EXTCONST char PL_warn_uninit_sv[]
4618   INIT("Use of uninitialized value%" SVf "%s%s");
4619 EXTCONST char PL_warn_nosemi[]
4620   INIT("Semicolon seems to be missing");
4621 EXTCONST char PL_warn_reserved[]
4622   INIT("Unquoted string \"%s\" may clash with future reserved word");
4623 EXTCONST char PL_warn_nl[]
4624   INIT("Unsuccessful %s on filename containing newline");
4625 EXTCONST char PL_no_wrongref[]
4626   INIT("Can't use %s ref as %s ref");
4627 /* The core no longer needs this here. If you require the string constant,
4628    please inline a copy into your own code.  */
4629 EXTCONST char PL_no_symref[] __attribute__deprecated__
4630   INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4631 EXTCONST char PL_no_symref_sv[]
4632   INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4633
4634 EXTCONST char PL_no_usym[]
4635   INIT("Can't use an undefined value as %s reference");
4636 EXTCONST char PL_no_aelem[]
4637   INIT("Modification of non-creatable array value attempted, subscript %d");
4638 EXTCONST char PL_no_helem_sv[]
4639   INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4640 EXTCONST char PL_no_modify[]
4641   INIT("Modification of a read-only value attempted");
4642 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4643   INIT("Out of memory!\n");
4644 EXTCONST char PL_no_security[]
4645   INIT("Insecure dependency in %s%s");
4646 EXTCONST char PL_no_sock_func[]
4647   INIT("Unsupported socket function \"%s\" called");
4648 EXTCONST char PL_no_dir_func[]
4649   INIT("Unsupported directory function \"%s\" called");
4650 EXTCONST char PL_no_func[]
4651   INIT("The %s function is unimplemented");
4652 EXTCONST char PL_no_myglob[]
4653   INIT("\"%s\" %s %s can't be in a package");
4654 EXTCONST char PL_no_localize_ref[]
4655   INIT("Can't localize through a reference");
4656 EXTCONST char PL_memory_wrap[]
4657   INIT("panic: memory wrap");
4658
4659 EXTCONST char PL_Yes[]
4660   INIT("1");
4661 EXTCONST char PL_No[]
4662   INIT("");
4663 EXTCONST char PL_Zero[]
4664   INIT("0");
4665 EXTCONST char PL_hexdigit[]
4666   INIT("0123456789abcdef0123456789ABCDEF");
4667
4668 EXTCONST STRLEN PL_WARN_ALL
4669   INIT(0);
4670 EXTCONST STRLEN PL_WARN_NONE
4671   INIT(0);
4672
4673 /* This is constant on most architectures, a global on OS/2 */
4674 #ifndef OS2
4675 EXTCONST char PL_sh_path[]
4676   INIT(SH_PATH); /* full path of shell */
4677 #endif
4678
4679 #ifdef CSH
4680 EXTCONST char PL_cshname[]
4681   INIT(CSH);
4682 #  define PL_cshlen     (sizeof(CSH "") - 1)
4683 #endif
4684
4685 /* These are baked at compile time into any shared perl library.
4686    In future releases this will allow us in main() to sanity test the
4687    library we're linking against.  */
4688
4689 EXTCONST U8 PL_revision
4690   INIT(PERL_REVISION);
4691 EXTCONST U8 PL_version
4692   INIT(PERL_VERSION);
4693 EXTCONST U8 PL_subversion
4694   INIT(PERL_SUBVERSION);
4695
4696 EXTCONST char PL_uuemap[65]
4697   INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4698
4699 /* a special string address whose value is "isa", but which perl knows
4700  * to treat as if it were really "DOES" when printing the method name in
4701  *  the "Can't call method '%s'" error message */
4702 EXTCONST char PL_isa_DOES[]
4703   INIT("isa");
4704
4705 #ifdef DOINIT
4706 EXTCONST char PL_uudmap[256] =
4707 #  ifdef PERL_MICRO
4708 #    include "uuudmap.h"
4709 #  else
4710 #    include "uudmap.h"
4711 #  endif
4712 ;
4713 EXTCONST char PL_bitcount[256] =
4714 #  ifdef PERL_MICRO
4715 #    include "ubitcount.h"
4716 #else
4717 #    include "bitcount.h"
4718 #  endif
4719 ;
4720 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4721 EXTCONST int         PL_sig_num[]  = { SIG_NUM };
4722 #else
4723 EXTCONST char PL_uudmap[256];
4724 EXTCONST char PL_bitcount[256];
4725 EXTCONST char* const PL_sig_name[];
4726 EXTCONST int         PL_sig_num[];
4727 #endif
4728
4729 /* fast conversion and case folding tables.  The folding tables complement the
4730  * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4731  * folds such as outside the range or to multiple characters. */
4732
4733 #ifdef DOINIT
4734 #ifndef EBCDIC
4735
4736 /* The EBCDIC fold table depends on the code page, and hence is found in
4737  * utfebcdic.h */
4738
4739 EXTCONST  unsigned char PL_fold[] = {
4740         0,      1,      2,      3,      4,      5,      6,      7,
4741         8,      9,      10,     11,     12,     13,     14,     15,
4742         16,     17,     18,     19,     20,     21,     22,     23,
4743         24,     25,     26,     27,     28,     29,     30,     31,
4744         32,     33,     34,     35,     36,     37,     38,     39,
4745         40,     41,     42,     43,     44,     45,     46,     47,
4746         48,     49,     50,     51,     52,     53,     54,     55,
4747         56,     57,     58,     59,     60,     61,     62,     63,
4748         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4749         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4750         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4751         'x',    'y',    'z',    91,     92,     93,     94,     95,
4752         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4753         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4754         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4755         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4756         128,    129,    130,    131,    132,    133,    134,    135,
4757         136,    137,    138,    139,    140,    141,    142,    143,
4758         144,    145,    146,    147,    148,    149,    150,    151,
4759         152,    153,    154,    155,    156,    157,    158,    159,
4760         160,    161,    162,    163,    164,    165,    166,    167,
4761         168,    169,    170,    171,    172,    173,    174,    175,
4762         176,    177,    178,    179,    180,    181,    182,    183,
4763         184,    185,    186,    187,    188,    189,    190,    191,
4764         192,    193,    194,    195,    196,    197,    198,    199,
4765         200,    201,    202,    203,    204,    205,    206,    207,
4766         208,    209,    210,    211,    212,    213,    214,    215,
4767         216,    217,    218,    219,    220,    221,    222,    223,
4768         224,    225,    226,    227,    228,    229,    230,    231,
4769         232,    233,    234,    235,    236,    237,    238,    239,
4770         240,    241,    242,    243,    244,    245,    246,    247,
4771         248,    249,    250,    251,    252,    253,    254,    255
4772 };
4773 EXTCONST  unsigned char PL_fold_latin1[] = {
4774     /* Full latin1 complement folding, except for three problematic code points:
4775      *  Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4776      *  fold complements outside the Latin1 range, so can't match something
4777      *  that isn't in utf8.
4778      *  German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4779      *  not one, so can't be represented in this table.
4780      *
4781      * All have to be specially handled */
4782         0,      1,      2,      3,      4,      5,      6,      7,
4783         8,      9,      10,     11,     12,     13,     14,     15,
4784         16,     17,     18,     19,     20,     21,     22,     23,
4785         24,     25,     26,     27,     28,     29,     30,     31,
4786         32,     33,     34,     35,     36,     37,     38,     39,
4787         40,     41,     42,     43,     44,     45,     46,     47,
4788         48,     49,     50,     51,     52,     53,     54,     55,
4789         56,     57,     58,     59,     60,     61,     62,     63,
4790         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4791         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4792         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4793         'x',    'y',    'z',    91,     92,     93,     94,     95,
4794         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4795         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4796         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4797         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4798         128,    129,    130,    131,    132,    133,    134,    135,
4799         136,    137,    138,    139,    140,    141,    142,    143,
4800         144,    145,    146,    147,    148,    149,    150,    151,
4801         152,    153,    154,    155,    156,    157,    158,    159,
4802         160,    161,    162,    163,    164,    165,    166,    167,
4803         168,    169,    170,    171,    172,    173,    174,    175,
4804         176,    177,    178,    179,    180,    181 /*micro */, 182,    183,
4805         184,    185,    186,    187,    188,    189,    190,    191,
4806         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4807         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4808         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4809         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
4810         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4811         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4812         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4813         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
4814         255 /* y with diaeresis */
4815 };
4816
4817 /* If these tables are accessed through ebcdic, the access will be converted to
4818  * latin1 first */
4819 EXTCONST  unsigned char PL_latin1_lc[] = {  /* lowercasing */
4820         0,      1,      2,      3,      4,      5,      6,      7,
4821         8,      9,      10,     11,     12,     13,     14,     15,
4822         16,     17,     18,     19,     20,     21,     22,     23,
4823         24,     25,     26,     27,     28,     29,     30,     31,
4824         32,     33,     34,     35,     36,     37,     38,     39,
4825         40,     41,     42,     43,     44,     45,     46,     47,
4826         48,     49,     50,     51,     52,     53,     54,     55,
4827         56,     57,     58,     59,     60,     61,     62,     63,
4828         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4829         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4830         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4831         'x',    'y',    'z',    91,     92,     93,     94,     95,
4832         96,     97,     98,     99,     100,    101,    102,    103,
4833         104,    105,    106,    107,    108,    109,    110,    111,
4834         112,    113,    114,    115,    116,    117,    118,    119,
4835         120,    121,    122,    123,    124,    125,    126,    127,
4836         128,    129,    130,    131,    132,    133,    134,    135,
4837         136,    137,    138,    139,    140,    141,    142,    143,
4838         144,    145,    146,    147,    148,    149,    150,    151,
4839         152,    153,    154,    155,    156,    157,    158,    159,
4840         160,    161,    162,    163,    164,    165,    166,    167,
4841         168,    169,    170,    171,    172,    173,    174,    175,
4842         176,    177,    178,    179,    180,    181,    182,    183,
4843         184,    185,    186,    187,    188,    189,    190,    191,
4844         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4845         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4846         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4847         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223,
4848         224,    225,    226,    227,    228,    229,    230,    231,
4849         232,    233,    234,    235,    236,    237,    238,    239,
4850         240,    241,    242,    243,    244,    245,    246,    247,
4851         248,    249,    250,    251,    252,    253,    254,    255
4852 };
4853
4854 /* upper and title case of latin1 characters, modified so that the three tricky
4855  * ones are mapped to 255 (which is one of the three) */
4856 EXTCONST  unsigned char PL_mod_latin1_uc[] = {
4857         0,      1,      2,      3,      4,      5,      6,      7,
4858         8,      9,      10,     11,     12,     13,     14,     15,
4859         16,     17,     18,     19,     20,     21,     22,     23,
4860         24,     25,     26,     27,     28,     29,     30,     31,
4861         32,     33,     34,     35,     36,     37,     38,     39,
4862         40,     41,     42,     43,     44,     45,     46,     47,
4863         48,     49,     50,     51,     52,     53,     54,     55,
4864         56,     57,     58,     59,     60,     61,     62,     63,
4865         64,     65,     66,     67,     68,     69,     70,     71,
4866         72,     73,     74,     75,     76,     77,     78,     79,
4867         80,     81,     82,     83,     84,     85,     86,     87,
4868         88,     89,     90,     91,     92,     93,     94,     95,
4869         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4870         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4871         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4872         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4873         128,    129,    130,    131,    132,    133,    134,    135,
4874         136,    137,    138,    139,    140,    141,    142,    143,
4875         144,    145,    146,    147,    148,    149,    150,    151,
4876         152,    153,    154,    155,    156,    157,    158,    159,
4877         160,    161,    162,    163,    164,    165,    166,    167,
4878         168,    169,    170,    171,    172,    173,    174,    175,
4879         176,    177,    178,    179,    180,    255 /*micro*/,  182,    183,
4880         184,    185,    186,    187,    188,    189,    190,    191,
4881         192,    193,    194,    195,    196,    197,    198,    199,
4882         200,    201,    202,    203,    204,    205,    206,    207,
4883         208,    209,    210,    211,    212,    213,    214,    215,
4884         216,    217,    218,    219,    220,    221,    222,
4885 #if    UNICODE_MAJOR_VERSION > 2                                        \
4886    || (UNICODE_MAJOR_VERSION == 2 && UNICODE_DOT_VERSION >= 1           \
4887                                   && UNICODE_DOT_DOT_VERSION >= 8)
4888                                                                 255 /*sharp s*/,
4889 #else   /* uc(sharp s) is 'sharp s' itself in early unicode */
4890                                                                 223,
4891 #endif
4892         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4893         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4894         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4895         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32, 255
4896 };
4897 #endif  /* !EBCDIC, but still in DOINIT */
4898 #else   /* ! DOINIT */
4899 #   ifndef EBCDIC
4900 EXTCONST unsigned char PL_fold[];
4901 EXTCONST unsigned char PL_fold_latin1[];
4902 EXTCONST unsigned char PL_mod_latin1_uc[];
4903 EXTCONST unsigned char PL_latin1_lc[];
4904 #   endif
4905 #endif
4906
4907 #ifndef PERL_GLOBAL_STRUCT /* or perlvars.h */
4908 #ifdef DOINIT
4909 EXT unsigned char PL_fold_locale[256] = { /* Unfortunately not EXTCONST. */
4910         0,      1,      2,      3,      4,      5,      6,      7,
4911         8,      9,      10,     11,     12,     13,     14,     15,
4912         16,     17,     18,     19,     20,     21,     22,     23,
4913         24,     25,     26,     27,     28,     29,     30,     31,
4914         32,     33,     34,     35,     36,     37,     38,     39,
4915         40,     41,     42,     43,     44,     45,     46,     47,
4916         48,     49,     50,     51,     52,     53,     54,     55,
4917         56,     57,     58,     59,     60,     61,     62,     63,
4918         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4919         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4920         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4921         'x',    'y',    'z',    91,     92,     93,     94,     95,
4922         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4923         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4924         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4925         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4926         128,    129,    130,    131,    132,    133,    134,    135,
4927         136,    137,    138,    139,    140,    141,    142,    143,
4928         144,    145,    146,    147,    148,    149,    150,    151,
4929         152,    153,    154,    155,    156,    157,    158,    159,
4930         160,    161,    162,    163,    164,    165,    166,    167,
4931         168,    169,    170,    171,    172,    173,    174,    175,
4932         176,    177,    178,    179,    180,    181,    182,    183,
4933         184,    185,    186,    187,    188,    189,    190,    191,
4934         192,    193,    194,    195,    196,    197,    198,    199,
4935         200,    201,    202,    203,    204,    205,    206,    207,
4936         208,    209,    210,    211,    212,    213,    214,    215,
4937         216,    217,    218,    219,    220,    221,    222,    223,
4938         224,    225,    226,    227,    228,    229,    230,    231,
4939         232,    233,    234,    235,    236,    237,    238,    239,
4940         240,    241,    242,    243,    244,    245,    246,    247,
4941         248,    249,    250,    251,    252,    253,    254,    255
4942 };
4943 #else
4944 EXT unsigned char PL_fold_locale[256]; /* Unfortunately not EXTCONST. */
4945 #endif
4946 #endif /* !PERL_GLOBAL_STRUCT */
4947
4948 #ifdef DOINIT
4949 #ifdef EBCDIC
4950 EXTCONST unsigned char PL_freq[] = {/* EBCDIC frequencies for mixed English/C */
4951     1,      2,      84,     151,    154,    155,    156,    157,
4952     165,    246,    250,    3,      158,    7,      18,     29,
4953     40,     51,     62,     73,     85,     96,     107,    118,
4954     129,    140,    147,    148,    149,    150,    152,    153,
4955     255,      6,      8,      9,     10,     11,     12,     13,
4956      14,     15,     24,     25,     26,     27,     28,    226,
4957      29,     30,     31,     32,     33,     43,     44,     45,
4958      46,     47,     48,     49,     50,     76,     77,     78,
4959      79,     80,     81,     82,     83,     84,     85,     86,
4960      87,     94,     95,    234,    181,    233,    187,    190,
4961     180,     96,     97,     98,     99,    100,    101,    102,
4962     104,    112,    182,    174,    236,    232,    229,    103,
4963     228,    226,    114,    115,    116,    117,    118,    119,
4964     120,    121,    122,    235,    176,    230,    194,    162,
4965     130,    131,    132,    133,    134,    135,    136,    137,
4966     138,    139,    201,    205,    163,    217,    220,    224,
4967     5,      248,    227,    244,    242,    255,    241,    231,
4968     240,    253,    16,     197,    19,     20,     21,     187,
4969     23,     169,    210,    245,    237,    249,    247,    239,
4970     168,    252,    34,     196,    36,     37,     38,     39,
4971     41,     42,     251,    254,    238,    223,    221,    213,
4972     225,    177,    52,     53,     54,     55,     56,     57,
4973     58,     59,     60,     61,     63,     64,     65,     66,
4974     67,     68,     69,     70,     71,     72,     74,     75,
4975     205,    208,    186,    202,    200,    218,    198,    179,
4976     178,    214,    88,     89,     90,     91,     92,     93,
4977     217,    166,    170,    207,    199,    209,    206,    204,
4978     160,    212,    105,    106,    108,    109,    110,    111,
4979     203,    113,    216,    215,    192,    175,    193,    243,
4980     172,    161,    123,    124,    125,    126,    127,    128,
4981     222,    219,    211,    195,    188,    193,    185,    184,
4982     191,    183,    141,    142,    143,    144,    145,    146
4983 };
4984 #else  /* ascii rather than ebcdic */
4985 EXTCONST unsigned char PL_freq[] = {    /* letter frequencies for mixed English/C */
4986         1,      2,      84,     151,    154,    155,    156,    157,
4987         165,    246,    250,    3,      158,    7,      18,     29,
4988         40,     51,     62,     73,     85,     96,     107,    118,
4989         129,    140,    147,    148,    149,    150,    152,    153,
4990         255,    182,    224,    205,    174,    176,    180,    217,
4991         233,    232,    236,    187,    235,    228,    234,    226,
4992         222,    219,    211,    195,    188,    193,    185,    184,
4993         191,    183,    201,    229,    181,    220,    194,    162,
4994         163,    208,    186,    202,    200,    218,    198,    179,
4995         178,    214,    166,    170,    207,    199,    209,    206,
4996         204,    160,    212,    216,    215,    192,    175,    173,
4997         243,    172,    161,    190,    203,    189,    164,    230,
4998         167,    248,    227,    244,    242,    255,    241,    231,
4999         240,    253,    169,    210,    245,    237,    249,    247,
5000         239,    168,    252,    251,    254,    238,    223,    221,
5001         213,    225,    177,    197,    171,    196,    159,    4,
5002         5,      6,      8,      9,      10,     11,     12,     13,
5003         14,     15,     16,     17,     19,     20,     21,     22,
5004         23,     24,     25,     26,     27,     28,     30,     31,
5005         32,     33,     34,     35,     36,     37,     38,     39,
5006         41,     42,     43,     44,     45,     46,     47,     48,
5007         49,     50,     52,     53,     54,     55,     56,     57,
5008         58,     59,     60,     61,     63,     64,     65,     66,
5009         67,     68,     69,     70,     71,     72,     74,     75,
5010         76,     77,     78,     79,     80,     81,     82,     83,
5011         86,     87,     88,     89,     90,     91,     92,     93,
5012         94,     95,     97,     98,     99,     100,    101,    102,
5013         103,    104,    105,    106,    108,    109,    110,    111,
5014         112,    113,    114,    115,    116,    117,    119,    120,
5015         121,    122,    123,    124,    125,    126,    127,    128,
5016         130,    131,    132,    133,    134,    135,    136,    137,
5017         138,    139,    141,    142,    143,    144,    145,    146
5018 };
5019 #endif
5020 #else
5021 EXTCONST unsigned char PL_freq[];
5022 #endif
5023
5024 /* Although only used for debugging, these constants must be available in
5025  * non-debugging builds too, since they're used in ext/re/re_exec.c,
5026  * which has DEBUGGING enabled always */
5027 #ifdef DOINIT
5028 EXTCONST char* const PL_block_type[] = {
5029         "NULL",
5030         "WHEN",
5031         "BLOCK",
5032         "GIVEN",
5033         "LOOP_ARY",
5034         "LOOP_LAZYSV",
5035         "LOOP_LAZYIV",
5036         "LOOP_LIST",
5037         "LOOP_PLAIN",
5038         "SUB",
5039         "FORMAT",
5040         "EVAL",
5041         "SUBST"
5042 };
5043 #else
5044 EXTCONST char* PL_block_type[];
5045 #endif
5046
5047 /* These are all the compile time options that affect binary compatibility.
5048    Other compile time options that are binary compatible are in perl.c
5049    (in S_Internals_V()). Both are combined for the output of perl -V
5050    However, this string will be embedded in any shared perl library, which will
5051    allow us add a comparison check in perlmain.c in the near future.  */
5052 #ifdef DOINIT
5053 EXTCONST char PL_bincompat_options[] =
5054 #  ifdef DEBUG_LEAKING_SCALARS
5055                              " DEBUG_LEAKING_SCALARS"
5056 #  endif
5057 #  ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5058                              " DEBUG_LEAKING_SCALARS_FORK_DUMP"
5059 #  endif
5060 #  ifdef FCRYPT
5061                              " FCRYPT"
5062 #  endif
5063 #  ifdef HAS_TIMES
5064                              " HAS_TIMES"
5065 #  endif
5066 #  ifdef HAVE_INTERP_INTERN
5067                              " HAVE_INTERP_INTERN"
5068 #  endif
5069 #  ifdef MULTIPLICITY
5070                              " MULTIPLICITY"
5071 #  endif
5072 #  ifdef MYMALLOC
5073                              " MYMALLOC"
5074 #  endif
5075 #  ifdef PERLIO_LAYERS
5076                              " PERLIO_LAYERS"
5077 #  endif
5078 #  ifdef PERL_DEBUG_READONLY_COW
5079                              " PERL_DEBUG_READONLY_COW"
5080 #  endif
5081 #  ifdef PERL_DEBUG_READONLY_OPS
5082                              " PERL_DEBUG_READONLY_OPS"
5083 #  endif
5084 #  ifdef PERL_GLOBAL_STRUCT
5085                              " PERL_GLOBAL_STRUCT"
5086 #  endif
5087 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
5088                              " PERL_GLOBAL_STRUCT_PRIVATE"
5089 #  endif
5090 #  ifdef PERL_IMPLICIT_CONTEXT
5091                              " PERL_IMPLICIT_CONTEXT"
5092 #  endif
5093 #  ifdef PERL_IMPLICIT_SYS
5094                              " PERL_IMPLICIT_SYS"
5095 #  endif
5096 #  ifdef PERL_MICRO
5097                              " PERL_MICRO"
5098 #  endif
5099 #  ifdef PERL_NEED_APPCTX
5100                              " PERL_NEED_APPCTX"
5101 #  endif
5102 #  ifdef PERL_NEED_TIMESBASE
5103                              " PERL_NEED_TIMESBASE"
5104 #  endif
5105 #  ifdef PERL_POISON
5106                              " PERL_POISON"
5107 #  endif
5108 #  ifdef PERL_SAWAMPERSAND
5109                              " PERL_SAWAMPERSAND"
5110 #  endif
5111 #  ifdef PERL_TRACK_MEMPOOL
5112                              " PERL_TRACK_MEMPOOL"
5113 #  endif
5114 #  ifdef PERL_USES_PL_PIDSTATUS
5115                              " PERL_USES_PL_PIDSTATUS"
5116 #  endif
5117 #  ifdef USE_64_BIT_ALL
5118                              " USE_64_BIT_ALL"
5119 #  endif
5120 #  ifdef USE_64_BIT_INT
5121                              " USE_64_BIT_INT"
5122 #  endif
5123 #  ifdef USE_IEEE
5124                              " USE_IEEE"
5125 #  endif
5126 #  ifdef USE_ITHREADS
5127                              " USE_ITHREADS"
5128 #  endif
5129 #  ifdef USE_LARGE_FILES
5130                              " USE_LARGE_FILES"
5131 #  endif
5132 #  ifdef USE_LOCALE_COLLATE
5133                              " USE_LOCALE_COLLATE"
5134 #  endif
5135 #  ifdef USE_LOCALE_NUMERIC
5136                              " USE_LOCALE_NUMERIC"
5137 #  endif
5138 #  ifdef USE_LOCALE_TIME
5139                              " USE_LOCALE_TIME"
5140 #  endif
5141 #  ifdef USE_LONG_DOUBLE
5142                              " USE_LONG_DOUBLE"
5143 #  endif
5144 #  ifdef USE_PERLIO
5145                              " USE_PERLIO"
5146 #  endif
5147 #  ifdef USE_QUADMATH
5148                              " USE_QUADMATH"
5149 #  endif
5150 #  ifdef USE_REENTRANT_API
5151                              " USE_REENTRANT_API"
5152 #  endif
5153 #  ifdef USE_SOCKS
5154                              " USE_SOCKS"
5155 #  endif
5156 #  ifdef VMS_DO_SOCKETS
5157                              " VMS_DO_SOCKETS"
5158 #  endif
5159 #  ifdef VMS_SHORTEN_LONG_SYMBOLS
5160                              " VMS_SHORTEN_LONG_SYMBOLS"
5161 #  endif
5162 #  ifdef VMS_WE_ARE_CASE_SENSITIVE
5163                              " VMS_SYMBOL_CASE_AS_IS"
5164 #  endif
5165   "";
5166 #else
5167 EXTCONST char PL_bincompat_options[];
5168 #endif
5169
5170 #ifndef PERL_SET_PHASE
5171 #  define PERL_SET_PHASE(new_phase) \
5172     PERL_DTRACE_PROBE_PHASE(new_phase); \
5173     PL_phase = new_phase;
5174 #endif
5175
5176 /* The interpreter phases. If these ever change, PL_phase_names right below will
5177  * need to be updated accordingly. */
5178 enum perl_phase {
5179     PERL_PHASE_CONSTRUCT        = 0,
5180     PERL_PHASE_START            = 1,
5181     PERL_PHASE_CHECK            = 2,
5182     PERL_PHASE_INIT             = 3,
5183     PERL_PHASE_RUN              = 4,
5184     PERL_PHASE_END              = 5,
5185     PERL_PHASE_DESTRUCT         = 6
5186 };
5187
5188 #ifdef DOINIT
5189 EXTCONST char *const PL_phase_names[] = {
5190     "CONSTRUCT",
5191     "START",
5192     "CHECK",
5193     "INIT",
5194     "RUN",
5195     "END",
5196     "DESTRUCT"
5197 };
5198 #else
5199 EXTCONST char *const PL_phase_names[];
5200 #endif
5201
5202 #ifndef PERL_CORE
5203 /* Do not use this macro. It only exists for extensions that rely on PL_dirty
5204  * instead of using the newer PL_phase, which provides everything PL_dirty
5205  * provided, and more. */
5206 #  define PL_dirty cBOOL(PL_phase == PERL_PHASE_DESTRUCT)
5207
5208 #  define PL_amagic_generation PL_na
5209 #  define PL_encoding ((SV *)NULL)
5210 #endif /* !PERL_CORE */
5211
5212 #define PL_hints PL_compiling.cop_hints
5213 #define PL_maxo  MAXO
5214
5215 END_EXTERN_C
5216
5217 /*****************************************************************************/
5218 /* This lexer/parser stuff is currently global since yacc is hard to reenter */
5219 /*****************************************************************************/
5220 /* XXX This needs to be revisited, since BEGIN makes yacc re-enter... */
5221
5222 #ifdef __Lynx__
5223 /* LynxOS defines these in scsi.h which is included via ioctl.h */
5224 #ifdef FORMAT
5225 #undef FORMAT
5226 #endif
5227 #ifdef SPACE
5228 #undef SPACE
5229 #endif
5230 #endif
5231
5232 #define LEX_NOTPARSING          11      /* borrowed from toke.c */
5233
5234 typedef enum {
5235     XOPERATOR,
5236     XTERM,
5237     XREF,
5238     XSTATE,
5239     XBLOCK,
5240     XATTRBLOCK, /* next token should be an attribute or block */
5241     XATTRTERM,  /* next token should be an attribute, or block in a term */
5242     XTERMBLOCK,
5243     XBLOCKTERM,
5244     XPOSTDEREF,
5245     XTERMORDORDOR /* evil hack */
5246     /* update exp_name[] in toke.c if adding to this enum */
5247 } expectation;
5248
5249 #define KEY_sigvar 0xFFFF /* fake keyword representing a signature var */
5250
5251 /* Hints are now stored in a dedicated U32, so the bottom 8 bits are no longer
5252    special and there is no need for HINT_PRIVATE_MASK for COPs
5253    However, bitops store HINT_INTEGER in their op_private.
5254
5255     NOTE: The typical module using these has the bit value hard-coded, so don't
5256     blindly change the values of these.
5257
5258    If we run out of bits, the 2 locale ones could be combined.  The PARTIAL one
5259    is for "use locale 'FOO'" which excludes some categories.  It requires going
5260    to %^H to find out which are in and which are out.  This could be extended
5261    for the normal case of a plain HINT_LOCALE, so that %^H would be used for
5262    any locale form. */
5263 #define HINT_INTEGER            0x00000001 /* integer pragma */
5264 #define HINT_STRICT_REFS        0x00000002 /* strict pragma */
5265 #define HINT_LOCALE             0x00000004 /* locale pragma */
5266 #define HINT_BYTES              0x00000008 /* bytes pragma */
5267 #define HINT_LOCALE_PARTIAL     0x00000010 /* locale, but a subset of categories */
5268
5269 #define HINT_EXPLICIT_STRICT_REFS       0x00000020 /* strict.pm */
5270 #define HINT_EXPLICIT_STRICT_SUBS       0x00000040 /* strict.pm */
5271 #define HINT_EXPLICIT_STRICT_VARS       0x00000080 /* strict.pm */
5272
5273 #define HINT_BLOCK_SCOPE        0x00000100
5274 #define HINT_STRICT_SUBS        0x00000200 /* strict pragma */
5275 #define HINT_STRICT_VARS        0x00000400 /* strict pragma */
5276 #define HINT_UNI_8_BIT          0x00000800 /* unicode_strings feature */
5277
5278 /* The HINT_NEW_* constants are used by the overload pragma */
5279 #define HINT_NEW_INTEGER        0x00001000
5280 #define HINT_NEW_FLOAT          0x00002000
5281 #define HINT_NEW_BINARY         0x00004000
5282 #define HINT_NEW_STRING         0x00008000
5283 #define HINT_NEW_RE             0x00010000
5284 #define HINT_LOCALIZE_HH        0x00020000 /* %^H needs to be copied */
5285 #define HINT_LEXICAL_IO_IN      0x00040000 /* ${^OPEN} is set for input */
5286 #define HINT_LEXICAL_IO_OUT     0x00080000 /* ${^OPEN} is set for output */
5287
5288 #define HINT_RE_TAINT           0x00100000 /* re pragma */
5289 #define HINT_RE_EVAL            0x00200000 /* re pragma */
5290
5291 #define HINT_FILETEST_ACCESS    0x00400000 /* filetest pragma */
5292 #define HINT_UTF8               0x00800000 /* utf8 pragma */
5293
5294 #define HINT_NO_AMAGIC          0x01000000 /* overloading pragma */
5295
5296 #define HINT_RE_FLAGS           0x02000000 /* re '/xism' pragma */
5297
5298 #define HINT_FEATURE_MASK       0x1c000000 /* 3 bits for feature bundles */
5299
5300                                 /* Note: Used for HINT_M_VMSISH_*,
5301                                    currently defined by vms/vmsish.h:
5302                                 0x40000000
5303                                 0x80000000
5304                                  */
5305
5306 /* The following are stored in $^H{sort}, not in PL_hints */
5307 #define HINT_SORT_STABLE        0x00000100 /* sort styles */
5308 #define HINT_SORT_UNSTABLE      0x00000200
5309
5310 /* flags for PL_sawampersand */
5311
5312 #define SAWAMPERSAND_LEFT       1   /* saw $` */
5313 #define SAWAMPERSAND_MIDDLE     2   /* saw $& */
5314 #define SAWAMPERSAND_RIGHT      4   /* saw $' */
5315
5316 #ifndef PERL_SAWAMPERSAND
5317 # define PL_sawampersand \
5318         (SAWAMPERSAND_LEFT|SAWAMPERSAND_MIDDLE|SAWAMPERSAND_RIGHT)
5319 #endif
5320
5321 /* Used for debugvar magic */
5322 #define DBVARMG_SINGLE  0
5323 #define DBVARMG_TRACE   1
5324 #define DBVARMG_SIGNAL  2
5325 #define DBVARMG_COUNT   3
5326
5327 #define PL_DBsingle_iv  (PL_DBcontrol[DBVARMG_SINGLE])
5328 #define PL_DBtrace_iv   (PL_DBcontrol[DBVARMG_TRACE])
5329 #define PL_DBsignal_iv  (PL_DBcontrol[DBVARMG_SIGNAL])
5330
5331 /* Various states of the input record separator SV (rs) */
5332 #define RsSNARF(sv)   (! SvOK(sv))
5333 #define RsSIMPLE(sv)  (SvOK(sv) && (! SvPOK(sv) || SvCUR(sv)))
5334 #define RsPARA(sv)    (SvPOK(sv) && ! SvCUR(sv))
5335 #define RsRECORD(sv)  (SvROK(sv) && (SvIV(SvRV(sv)) > 0))
5336
5337 /* A struct for keeping various DEBUGGING related stuff,
5338  * neatly packed.  Currently only scratch variables for
5339  * constructing debug output are included.  Needed always,
5340  * not just when DEBUGGING, though, because of the re extension. c*/
5341 struct perl_debug_pad {
5342   SV pad[3];
5343 };
5344
5345 #define PERL_DEBUG_PAD(i)       &(PL_debug_pad.pad[i])
5346 #define PERL_DEBUG_PAD_ZERO(i)  (SvPVX(PERL_DEBUG_PAD(i))[0] = 0, \
5347         (((XPV*) SvANY(PERL_DEBUG_PAD(i)))->xpv_cur = 0), \
5348         PERL_DEBUG_PAD(i))
5349
5350 /* Enable variables which are pointers to functions */
5351 typedef void (*peep_t)(pTHX_ OP* o);
5352 typedef regexp* (*regcomp_t) (pTHX_ char* exp, char* xend, PMOP* pm);
5353 typedef I32     (*regexec_t) (pTHX_ regexp* prog, char* stringarg,
5354                                       char* strend, char* strbeg, I32 minend,
5355                                       SV* screamer, void* data, U32 flags);
5356 typedef char*   (*re_intuit_start_t) (pTHX_ regexp *prog, SV *sv,
5357                                                 char *strpos, char *strend,
5358                                                 U32 flags,
5359                                                 re_scream_pos_data *d);
5360 typedef SV*     (*re_intuit_string_t) (pTHX_ regexp *prog);
5361 typedef void    (*regfree_t) (pTHX_ struct regexp* r);
5362 typedef regexp* (*regdupe_t) (pTHX_ const regexp* r, CLONE_PARAMS *param);
5363 typedef I32     (*re_fold_t)(const char *, char const *, I32);
5364
5365 typedef void (*DESTRUCTORFUNC_NOCONTEXT_t) (void*);
5366 typedef void (*DESTRUCTORFUNC_t) (pTHX_ void*);
5367 typedef void (*SVFUNC_t) (pTHX_ SV* const);
5368 typedef I32  (*SVCOMPARE_t) (pTHX_ SV* const, SV* const);
5369 typedef void (*XSINIT_t) (pTHX);
5370 typedef void (*ATEXIT_t) (pTHX_ void*);
5371 typedef void (*XSUBADDR_t) (pTHX_ CV *);
5372
5373 typedef OP* (*Perl_ppaddr_t)(pTHX);
5374 typedef OP* (*Perl_check_t) (pTHX_ OP*);
5375 typedef void(*Perl_ophook_t)(pTHX_ OP*);
5376 typedef int (*Perl_keyword_plugin_t)(pTHX_ char*, STRLEN, OP**);
5377 typedef void(*Perl_cpeep_t)(pTHX_ OP *, OP *);
5378
5379 typedef void(*globhook_t)(pTHX);
5380
5381 #define KEYWORD_PLUGIN_DECLINE 0
5382 #define KEYWORD_PLUGIN_STMT    1
5383 #define KEYWORD_PLUGIN_EXPR    2
5384
5385 /* Interpreter exitlist entry */
5386 typedef struct exitlistentry {
5387     void (*fn) (pTHX_ void*);
5388     void *ptr;
5389 } PerlExitListEntry;
5390
5391 /* if you only have signal() and it resets on each signal, FAKE_PERSISTENT_SIGNAL_HANDLERS fixes */
5392 /* These have to be before perlvars.h */
5393 #if !defined(HAS_SIGACTION) && defined(VMS)
5394 #  define  FAKE_PERSISTENT_SIGNAL_HANDLERS
5395 #endif
5396 /* if we're doing kill() with sys$sigprc on VMS, FAKE_DEFAULT_SIGNAL_HANDLERS */
5397 #if defined(KILL_BY_SIGPRC)
5398 #  define  FAKE_DEFAULT_SIGNAL_HANDLERS
5399 #endif
5400
5401 #if !defined(MULTIPLICITY)
5402
5403 struct interpreter {
5404     char broiled;
5405 };
5406
5407 #else
5408
5409 /* If we have multiple interpreters define a struct
5410    holding variables which must be per-interpreter
5411    If we don't have threads anything that would have
5412    be per-thread is per-interpreter.
5413 */
5414
5415 /* Set up PERLVAR macros for populating structs */
5416 #  define PERLVAR(prefix,var,type) type prefix##var;
5417
5418 /* 'var' is an array of length 'n' */
5419 #  define PERLVARA(prefix,var,n,type) type prefix##var[n];
5420
5421 /* initialize 'var' to init' */
5422 #  define PERLVARI(prefix,var,type,init) type prefix##var;
5423
5424 /* like PERLVARI, but make 'var' a const */
5425 #  define PERLVARIC(prefix,var,type,init) type prefix##var;
5426
5427 struct interpreter {
5428 #  include "intrpvar.h"
5429 };
5430
5431 EXTCONST U16 PL_interp_size
5432   INIT(sizeof(struct interpreter));
5433
5434 #  define PERL_INTERPRETER_SIZE_UPTO_MEMBER(member)                     \
5435     STRUCT_OFFSET(struct interpreter, member) +                         \
5436     sizeof(((struct interpreter*)0)->member)
5437
5438 /* This will be useful for subsequent releases, because this has to be the
5439    same in your libperl as in main(), else you have a mismatch and must abort.
5440 */
5441 EXTCONST U16 PL_interp_size_5_18_0
5442   INIT(PERL_INTERPRETER_SIZE_UPTO_MEMBER(PERL_LAST_5_18_0_INTERP_MEMBER));
5443
5444
5445 #  ifdef PERL_GLOBAL_STRUCT
5446 /* MULTIPLICITY is automatically defined when PERL_GLOBAL_STRUCT is defined,
5447    hence it's safe and sane to nest this within #ifdef MULTIPLICITY  */
5448
5449 struct perl_vars {
5450 #    include "perlvars.h"
5451 };
5452
5453 EXTCONST U16 PL_global_struct_size
5454   INIT(sizeof(struct perl_vars));
5455
5456 #    ifdef PERL_CORE
5457 #      ifndef PERL_GLOBAL_STRUCT_PRIVATE
5458 EXT struct perl_vars PL_Vars;
5459 EXT struct perl_vars *PL_VarsPtr INIT(&PL_Vars);
5460 #        undef PERL_GET_VARS
5461 #        define PERL_GET_VARS() PL_VarsPtr
5462 #      endif /* !PERL_GLOBAL_STRUCT_PRIVATE */
5463 #    else /* PERL_CORE */
5464 #      if !defined(__GNUC__) || !defined(WIN32)
5465 EXT
5466 #      endif /* WIN32 */
5467 struct perl_vars *PL_VarsPtr;
5468 #      define PL_Vars (*((PL_VarsPtr) \
5469                        ? PL_VarsPtr : (PL_VarsPtr = Perl_GetVars(aTHX))))
5470 #    endif /* PERL_CORE */
5471 #  endif /* PERL_GLOBAL_STRUCT */
5472
5473 /* Done with PERLVAR macros for now ... */
5474 #  undef PERLVAR
5475 #  undef PERLVARA
5476 #  undef PERLVARI
5477 #  undef PERLVARIC
5478
5479 #endif /* MULTIPLICITY */
5480
5481 struct tempsym; /* defined in pp_pack.c */
5482
5483 #include "thread.h"
5484 #include "pp.h"
5485
5486 #undef PERL_CKDEF
5487 #undef PERL_PPDEF
5488 #define PERL_CKDEF(s)   PERL_CALLCONV OP *s (pTHX_ OP *o);
5489 #define PERL_PPDEF(s)   PERL_CALLCONV OP *s (pTHX);
5490
5491 #ifdef MYMALLOC
5492 #  include "malloc_ctl.h"
5493 #endif
5494
5495 /*
5496  * This provides a layer of functions and macros to ensure extensions will
5497  * get to use the same RTL functions as the core.
5498  */
5499 #if defined(WIN32)
5500 #  include "win32iop.h"
5501 #endif
5502
5503
5504 #include "proto.h"
5505
5506 /* this has structure inits, so it cannot be included before here */
5507 #include "opcode.h"
5508
5509 /* The following must follow proto.h as #defines mess up syntax */
5510
5511 #if !defined(PERL_FOR_X2P)
5512 #  include "embedvar.h"
5513 #endif
5514
5515 /* Now include all the 'global' variables
5516  * If we don't have threads or multiple interpreters
5517  * these include variables that would have been their struct-s
5518  */
5519
5520 #define PERLVAR(prefix,var,type) EXT type PL_##var;
5521 #define PERLVARA(prefix,var,n,type) EXT type PL_##var[n];
5522 #define PERLVARI(prefix,var,type,init) EXT type  PL_##var INIT(init);
5523 #define PERLVARIC(prefix,var,type,init) EXTCONST type PL_##var INIT(init);
5524
5525 #if !defined(MULTIPLICITY)
5526 START_EXTERN_C
5527 #  include "intrpvar.h"
5528 END_EXTERN_C
5529 #  define PL_sv_yes   (PL_sv_immortals[0])
5530 #  define PL_sv_undef (PL_sv_immortals[1])
5531 #  define PL_sv_no    (PL_sv_immortals[2])
5532 #  define PL_sv_zero  (PL_sv_immortals[3])
5533 #endif
5534
5535 #ifdef PERL_CORE
5536 /* All core uses now exterminated. Ensure no zombies can return:  */
5537 #  undef PL_na
5538 #endif
5539
5540 /* Now all the config stuff is setup we can include embed.h
5541    In particular, need the relevant *ish file included already, as it may
5542    define HAVE_INTERP_INTERN  */
5543 #include "embed.h"
5544
5545 #ifndef PERL_GLOBAL_STRUCT
5546 START_EXTERN_C
5547
5548 #  include "perlvars.h"
5549
5550 END_EXTERN_C
5551 #endif
5552
5553 #undef PERLVAR
5554 #undef PERLVARA
5555 #undef PERLVARI
5556 #undef PERLVARIC
5557
5558 #if !defined(MULTIPLICITY)
5559 /* Set up PERLVAR macros for populating structs */
5560 #  define PERLVAR(prefix,var,type) type prefix##var;
5561 /* 'var' is an array of length 'n' */
5562 #  define PERLVARA(prefix,var,n,type) type prefix##var[n];
5563 /* initialize 'var' to init' */
5564 #  define PERLVARI(prefix,var,type,init) type prefix##var;
5565 /* like PERLVARI, but make 'var' a const */
5566 #  define PERLVARIC(prefix,var,type,init) type prefix##var;
5567
5568 /* this is never instantiated, is it just used for sizeof(struct PerlHandShakeInterpreter) */
5569 struct PerlHandShakeInterpreter {
5570 #  include "intrpvar.h"
5571 };
5572 #  undef PERLVAR
5573 #  undef PERLVARA
5574 #  undef PERLVARI
5575 #  undef PERLVARIC
5576 #endif
5577
5578 START_EXTERN_C
5579
5580 /* dummy variables that hold pointers to both runops functions, thus forcing
5581  * them *both* to get linked in (useful for Peek.xs, debugging etc) */
5582
5583 EXTCONST runops_proc_t PL_runops_std
5584   INIT(Perl_runops_standard);
5585 EXTCONST runops_proc_t PL_runops_dbg
5586   INIT(Perl_runops_debug);
5587
5588 #define EXT_MGVTBL EXTCONST MGVTBL
5589
5590 #define PERL_MAGIC_READONLY_ACCEPTABLE 0x40
5591 #define PERL_MAGIC_VALUE_MAGIC 0x80
5592 #define PERL_MAGIC_VTABLE_MASK 0x3F
5593 #define PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(t) \
5594     (PL_magic_data[(U8)(t)] & PERL_MAGIC_READONLY_ACCEPTABLE)
5595 #define PERL_MAGIC_TYPE_IS_VALUE_MAGIC(t) \
5596     (PL_magic_data[(U8)(t)] & PERL_MAGIC_VALUE_MAGIC)
5597
5598 #include "mg_vtable.h"
5599
5600 #ifdef DOINIT
5601 EXTCONST U8 PL_magic_data[256] =
5602 #  ifdef PERL_MICRO
5603 #    include "umg_data.h"
5604 #  else
5605 #    include "mg_data.h"
5606 #  endif
5607 ;
5608 #else
5609 EXTCONST U8 PL_magic_data[256];
5610 #endif
5611
5612 #ifdef DOINIT
5613                         /* NL IV NV PV INV PI PN MG RX GV LV AV HV CV FM IO */
5614 EXTCONST bool
5615 PL_valid_types_IVX[]    = { 0, 1, 0, 0, 0, 1, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5616 EXTCONST bool
5617 PL_valid_types_NVX[]    = { 0, 0, 1, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5618 EXTCONST bool
5619 PL_valid_types_PVX[]    = { 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1 };
5620 EXTCONST bool
5621 PL_valid_types_RV[]     = { 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1 };
5622 EXTCONST bool
5623 PL_valid_types_IV_set[] = { 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1 };
5624 EXTCONST bool
5625 PL_valid_types_NV_set[] = { 0, 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0 };
5626
5627 #else
5628
5629 EXTCONST bool PL_valid_types_IVX[];
5630 EXTCONST bool PL_valid_types_NVX[];
5631 EXTCONST bool PL_valid_types_PVX[];
5632 EXTCONST bool PL_valid_types_RV[];
5633 EXTCONST bool PL_valid_types_IV_set[];
5634 EXTCONST bool PL_valid_types_NV_set[];
5635
5636 #endif
5637
5638 /* In C99 we could use designated (named field) union initializers.
5639  * In C89 we need to initialize the member declared first.
5640  * In C++ we need extern C initializers.
5641  *
5642  * With the U8_NV version you will want to have inner braces,
5643  * while with the NV_U8 use just the NV. */
5644
5645 #define INFNAN_U8_NV_DECL EXTCONST union { U8 u8[NVSIZE]; NV nv; }
5646 #define INFNAN_NV_U8_DECL EXTCONST union { NV nv; U8 u8[NVSIZE]; }
5647
5648 /* if these never got defined, they need defaults */
5649 #ifndef PERL_SET_CONTEXT
5650 #  define PERL_SET_CONTEXT(i)           PERL_SET_INTERP(i)
5651 #endif
5652
5653 #ifndef PERL_GET_CONTEXT
5654 #  define PERL_GET_CONTEXT              PERL_GET_INTERP
5655 #endif
5656
5657 #ifndef PERL_GET_THX
5658 #  define PERL_GET_THX                  ((void*)NULL)
5659 #endif
5660
5661 #ifndef PERL_SET_THX
5662 #  define PERL_SET_THX(t)               NOOP
5663 #endif
5664
5665 #ifndef EBCDIC
5666
5667 /* The tables below are adapted from
5668  * https://bjoern.hoehrmann.de/utf-8/decoder/dfa/, which requires this copyright
5669  * notice:
5670
5671 Copyright (c) 2008-2009 Bjoern Hoehrmann <bjoern@hoehrmann.de>
5672
5673 Permission is hereby granted, free of charge, to any person obtaining a copy of
5674 this software and associated documentation files (the "Software"), to deal in
5675 the Software without restriction, including without limitation the rights to
5676 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
5677 of the Software, and to permit persons to whom the Software is furnished to do
5678 so, subject to the following conditions:
5679
5680 The above copyright notice and this permission notice shall be included in all
5681 copies or substantial portions of the Software.
5682
5683 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
5684 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
5685 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
5686 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
5687 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
5688 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
5689 SOFTWARE.
5690
5691 */
5692
5693 #  ifdef DOINIT
5694 #    if 0       /* This is the original table given in
5695                    https://bjoern.hoehrmann.de/utf-8/decoder/dfa/ */
5696 static U8 utf8d_C9[] = {
5697   /* The first part of the table maps bytes to character classes that
5698    * to reduce the size of the transition table and create bitmasks. */
5699    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*/
5700    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*/
5701    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*/
5702    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*/
5703    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*/
5704    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*/
5705    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*/
5706   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*/
5707
5708   /* The second part is a transition table that maps a combination
5709    * of a state of the automaton and a character class to a state. */
5710    0,12,24,36,60,96,84,12,12,12,48,72, 12,12,12,12,12,12,12,12,12,12,12,12,
5711   12, 0,12,12,12,12,12, 0,12, 0,12,12, 12,24,12,12,12,12,12,24,12,24,12,12,
5712   12,12,12,12,12,12,12,24,12,12,12,12, 12,24,12,12,12,12,12,12,12,24,12,12,
5713   12,12,12,12,12,12,12,36,12,36,12,12, 12,36,12,12,12,12,12,36,12,36,12,12,
5714   12,36,12,12,12,12,12,12,12,12,12,12
5715 };
5716
5717 #    endif
5718
5719 /* This is a version of the above table customized for Perl that doesn't
5720  * exclude surrogates and accepts start bytes up through FD (FE on 64-bit
5721  * machines).  The classes have been renumbered so that the patterns are more
5722  * evident in the table.  The class numbers for start bytes are constrained so
5723  * that they can be used as a shift count for masking off the leading one bits.
5724  * It would make the code simpler if start byte FF could also be handled, but
5725  * doing so would mean adding nodes for each of continuation bytes 6-12
5726  * remaining, and two more nodes for overlong detection (a total of 9), and
5727  * there is room only for 4 more nodes unless we make the array U16 instead of
5728  * U8.
5729  *
5730  * The classes are
5731  *      00-7F           0
5732  *      80-81           7   Not legal immediately after start bytes E0 F0 F8 FC
5733  *                          FE
5734  *      82-83           8   Not legal immediately after start bytes E0 F0 F8 FC
5735  *      84-87           9   Not legal immediately after start bytes E0 F0 F8
5736  *      88-8F          10   Not legal immediately after start bytes E0 F0
5737  *      90-9F          11   Not legal immediately after start byte E0
5738  *      A0-BF          12
5739  *      C0,C1           1
5740  *      C2-DF           2
5741  *      E0             13
5742  *      E1-EF           3
5743  *      F0             14
5744  *      F1-F7           4
5745  *      F8             15
5746  *      F9-FB           5
5747  *      FC             16
5748  *      FD              6
5749  *      FE             17  (or 1 on 32-bit machines, since it overflows)
5750  *      FF              1
5751  */
5752
5753 EXTCONST U8 PL_extended_utf8_dfa_tab[] = {
5754     /* The first part of the table maps bytes to character classes to reduce
5755      * the size of the transition table and create bitmasks. */
5756    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*00-0F*/
5757    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*10-1F*/
5758    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*20-2F*/
5759    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*30-3F*/
5760    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*40-4F*/
5761    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*50-5F*/
5762    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*60-6F*/
5763    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*70-7F*/
5764    7, 7, 8, 8, 9, 9, 9, 9,10,10,10,10,10,10,10,10, /*80-8F*/
5765   11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11, /*90-9F*/
5766   12,12,12,12,12,12,12,12,12,12,12,12,12,12,12,12, /*A0-AF*/
5767   12,12,12,12,12,12,12,12,12,12,12,12,12,12,12,12, /*B0-BF*/
5768    1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*C0-CF*/
5769    2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*D0-DF*/
5770   13, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, /*E0-EF*/
5771   14, 4, 4, 4, 4, 4, 4, 4,15, 5, 5, 5,16, 6,       /*F0-FD*/
5772 #    ifdef UV_IS_QUAD
5773                                             17,    /*FE*/
5774 #    else
5775                                              1,    /*FE*/
5776 #    endif
5777                                                 1, /*FF*/
5778
5779 /* The second part is a transition table that maps a combination
5780  * of a state of the automaton and a character class to a new state, called a
5781  * node.  The nodes are:
5782  * N0     The initial state, and final accepting one.
5783  * N1     Any one continuation byte (80-BF) left.  This is transitioned to
5784  *        immediately when the start byte indicates a two-byte sequence
5785  * N2     Any two continuation bytes left.
5786  * N3     Any three continuation bytes left.
5787  * N4     Any four continuation bytes left.
5788  * N5     Any five continuation bytes left.
5789  * N6     Start byte is E0.  Continuation bytes 80-9F are illegal (overlong);
5790  *        the other continuations transition to N1
5791  * N7     Start byte is F0.  Continuation bytes 80-8F are illegal (overlong);
5792  *        the other continuations transition to N2
5793  * N8     Start byte is F8.  Continuation bytes 80-87 are illegal (overlong);
5794  *        the other continuations transition to N3
5795  * N9     Start byte is FC.  Continuation bytes 80-83 are illegal (overlong);
5796  *        the other continuations transition to N4
5797  * N10    Start byte is FE.  Continuation bytes 80-81 are illegal (overlong);
5798  *        the other continuations transition to N5
5799  * 1      Reject.  All transitions not mentioned above (except the single
5800  *        byte ones (as they are always legal) are to this state.
5801  */
5802
5803 #    define NUM_CLASSES 18
5804 #    define N0 0
5805 #    define N1 ((N0)   + NUM_CLASSES)
5806 #    define N2 ((N1)   + NUM_CLASSES)
5807 #    define N3 ((N2)   + NUM_CLASSES)
5808 #    define N4 ((N3)   + NUM_CLASSES)
5809 #    define N5 ((N4)   + NUM_CLASSES)
5810 #    define N6 ((N5)   + NUM_CLASSES)
5811 #    define N7 ((N6)   + NUM_CLASSES)
5812 #    define N8 ((N7)   + NUM_CLASSES)
5813 #    define N9 ((N8)   + NUM_CLASSES)
5814 #    define N10 ((N9)  + NUM_CLASSES)
5815
5816 /*Class: 0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17  */
5817 /*N0*/   0, 1,N1,N2,N3,N4,N5, 1, 1, 1, 1, 1, 1,N6,N7,N8,N9,N10,
5818 /*N1*/   1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1,
5819 /*N2*/   1, 1, 1, 1, 1, 1, 1,N1,N1,N1,N1,N1,N1, 1, 1, 1, 1, 1,
5820 /*N3*/   1, 1, 1, 1, 1, 1, 1,N2,N2,N2,N2,N2,N2, 1, 1, 1, 1, 1,
5821 /*N4*/   1, 1, 1, 1, 1, 1, 1,N3,N3,N3,N3,N3,N3, 1, 1, 1, 1, 1,
5822 /*N5*/   1, 1, 1, 1, 1, 1, 1,N4,N4,N4,N4,N4,N4, 1, 1, 1, 1, 1,
5823
5824 /*N6*/   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,N1, 1, 1, 1, 1, 1,
5825 /*N7*/   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,N2,N2, 1, 1, 1, 1, 1,
5826 /*N8*/   1, 1, 1, 1, 1, 1, 1, 1, 1, 1,N3,N3,N3, 1, 1, 1, 1, 1,
5827 /*N9*/   1, 1, 1, 1, 1, 1, 1, 1, 1,N4,N4,N4,N4, 1, 1, 1, 1, 1,
5828 /*N10*/  1, 1, 1, 1, 1, 1, 1, 1,N5,N5,N5,N5,N5, 1, 1, 1, 1, 1,
5829 };
5830
5831 /* And below is a version of the above table that accepts only strict UTF-8.
5832  * Hence no surrogates nor non-characters, nor non-Unicode.  Thus, if the input
5833  * passes this dfa, it will be for a well-formed, non-problematic code point
5834  * that can be returned immediately.
5835  *
5836  * The "Implementation details" portion of
5837  * https://bjoern.hoehrmann.de/utf-8/decoder/dfa/ shows how
5838  * the first portion of the table maps each possible byte into a character
5839  * class.  And that the classes for those bytes which are start bytes have been
5840  * carefully chosen so they serve as well to be used as a shift value to mask
5841  * off the leading 1 bits of the start byte.  Unfortunately the addition of
5842  * being able to distinguish non-characters makes this not fully work.  This is
5843  * because, now, the start bytes E1-EF have to be broken into 3 classes instead
5844  * of 2:
5845  *  1) ED because it could be a surrogate
5846  *  2) EF because it could be a non-character
5847  *  3) the rest, which can never evaluate to a problematic code point.
5848  *
5849  * Each of E1-EF has three leading 1 bits, then a 0.  That means we could use a
5850  * shift (and hence class number) of either 3 or 4 to get a mask that works.
5851  * But that only allows two categories, and we need three.  khw made the
5852  * decision to therefore treat the ED start byte as an error, so that the dfa
5853  * drops out immediately for that.  In the dfa, classes 3 and 4 are used to
5854  * distinguish EF vs the rest.  Then special code is used to deal with ED,
5855  * that's executed only when the dfa drops out.  The code points started by ED
5856  * are half surrogates, and half hangul syllables.  This means that 2048 of the
5857  * the hangul syllables (about 18%) take longer than all other non-problematic
5858  * code points to handle.
5859  *
5860  * The changes to handle non-characters requires the addition of states and
5861  * classes to the dfa.  (See the section on "Mapping bytes to character
5862  * classes" in the linked-to document for further explanation of the original
5863  * dfa.)
5864  *
5865  * The classes are
5866  *      00-7F           0
5867  *      80-8E           9
5868  *      8F             10
5869  *      90-9E          11
5870  *      9F             12
5871  *      A0-AE          13
5872  *      AF             14
5873  *      B0-B6          15
5874  *      B7             16
5875  *      B8-BD          15
5876  *      BE             17
5877  *      BF             18
5878  *      C0,C1           1
5879  *      C2-DF           2
5880  *      E0              7
5881  *      E1-EC           3
5882  *      ED              1
5883  *      EE              3
5884  *      EF              4
5885  *      F0              8
5886  *      F1-F3           6  (6 bits can be stripped)
5887  *      F4              5  (only 5 can be stripped)
5888  *      F5-FF           1
5889  */
5890
5891 EXTCONST U8 PL_strict_utf8_dfa_tab[] = {
5892     /* The first part of the table maps bytes to character classes to reduce
5893      * the size of the transition table and create bitmasks. */
5894    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*00-0F*/
5895    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*10-1F*/
5896    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*20-2F*/
5897    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*30-3F*/
5898    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*40-4F*/
5899    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*50-5F*/
5900    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*60-6F*/
5901    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*70-7F*/
5902    9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9,10, /*80-8F*/
5903   11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,12, /*90-9F*/
5904   13,13,13,13,13,13,13,13,13,13,13,13,13,13,13,14, /*A0-AF*/
5905   15,15,15,15,15,15,15,16,15,15,15,15,15,15,17,18, /*B0-BF*/
5906    1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*C0-CF*/
5907    2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*D0-DF*/
5908    7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 1, 3, 4, /*E0-EF*/
5909    8, 6, 6, 6, 5, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /*F0-FF*/
5910
5911 /* The second part is a transition table that maps a combination
5912  * of a state of the automaton and a character class to a new state, called a
5913  * node.  The nodes are:
5914  * N0     The initial state, and final accepting one.
5915  * N1     Any one continuation byte (80-BF) left.  This is transitioned to
5916  *        immediately when the start byte indicates a two-byte sequence
5917  * N2     Any two continuation bytes left.
5918  * N3     Start byte is E0.  Continuation bytes 80-9F are illegal (overlong);
5919  *        the other continuations transition to state N1
5920  * N4     Start byte is EF.  Continuation byte B7 transitions to N8; BF to N9;
5921  *        the other continuations transitions to N1
5922  * N5     Start byte is F0.  Continuation bytes 80-8F are illegal (overlong);
5923  *        [9AB]F transition to N10; the other continuations to N2.
5924  * N6     Start byte is F[123].  Continuation bytes [89AB]F transition
5925  *        to N10; the other continuations to N2.
5926  * N7     Start byte is F4.  Continuation bytes 90-BF are illegal
5927  *        (non-unicode); 8F transitions to N10; the other continuations to N2
5928  * N8     Initial sequence is EF B7.  Continuation bytes 90-AF are illegal
5929  *        (non-characters); the other continuations transition to N0.
5930  * N9     Initial sequence is EF BF.  Continuation bytes BE and BF are illegal
5931  *        (non-characters); the other continuations transition to N0.
5932  * N10    Initial sequence is one of: F0 [9-B]F; F[123] [8-B]F; or F4 8F.
5933  *        Continuation byte BF transitions to N11; the other continuations to
5934  *        N1
5935  * N11    Initial sequence is the two bytes given in N10 followed by BF.
5936  *        Continuation bytes BE and BF are illegal (non-characters); the other
5937  *        continuations transition to N0.
5938  * 1      Reject.  All transitions not mentioned above (except the single
5939  *        byte ones (as they are always legal) are to this state.
5940  */
5941
5942 #    undef N0
5943 #    undef N1
5944 #    undef N2
5945 #    undef N3
5946 #    undef N4
5947 #    undef N5
5948 #    undef N6
5949 #    undef N7
5950 #    undef N8
5951 #    undef N9
5952 #    undef NUM_CLASSES
5953 #    define NUM_CLASSES 19
5954 #    define N0 0
5955 #    define N1  ((N0)  + NUM_CLASSES)
5956 #    define N2  ((N1)  + NUM_CLASSES)
5957 #    define N3  ((N2)  + NUM_CLASSES)
5958 #    define N4  ((N3)  + NUM_CLASSES)
5959 #    define N5  ((N4)  + NUM_CLASSES)
5960 #    define N6  ((N5)  + NUM_CLASSES)
5961 #    define N7  ((N6)  + NUM_CLASSES)
5962 #    define N8  ((N7)  + NUM_CLASSES)
5963 #    define N9  ((N8)  + NUM_CLASSES)
5964 #    define N10 ((N9)  + NUM_CLASSES)
5965 #    define N11 ((N10) + NUM_CLASSES)
5966
5967 /*Class: 0   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18 */
5968 /*N0*/   0,  1, N1, N2, N4, N7, N6, N3, N5,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,
5969 /*N1*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
5970 /*N2*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N1, N1, N1, N1, N1, N1, N1, N1, N1, N1,
5971
5972 /*N3*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1, N1, N1, N1, N1, N1, N1,
5973 /*N4*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N1, N1, N1, N1, N1, N1, N1, N8, N1, N9,
5974 /*N5*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1, N2,N10, N2,N10, N2, N2, N2,N10,
5975 /*N6*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N2,N10, N2,N10, N2,N10, N2, N2, N2,N10,
5976 /*N7*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N2,N10,  1,  1,  1,  1,  1,  1,  1,  1,
5977 /*N8*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  0,  0,  1,  1,  1,  1,  0,  0,  0,  0,
5978 /*N9*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  0,  0,  0,  0,  0,  0,  0,  0,  1,  1,
5979 /*N10*/  1,  1,  1,  1,  1,  1,  1,  1,  1, N1, N1, N1, N1, N1, N1, N1, N1, N1,N11,
5980 /*N11*/  1,  1,  1,  1,  1,  1,  1,  1,  1,  0,  0,  0,  0,  0,  0,  0,  0,  1,  1,
5981 };
5982
5983 /* And below is yet another version of the above tables that accepts only UTF-8
5984  * as defined by Corregidum #9.  Hence no surrogates nor non-Unicode, but
5985  * it allows non-characters.  This is isomorphic to the original table
5986  * in https://bjoern.hoehrmann.de/utf-8/decoder/dfa/
5987  *
5988  * The classes are
5989  *      00-7F           0
5990  *      80-8F           9
5991  *      90-9F          10
5992  *      A0-BF          11
5993  *      C0,C1           1
5994  *      C2-DF           2
5995  *      E0              7
5996  *      E1-EC           3
5997  *      ED              4
5998  *      EE-EF           3
5999  *      F0              8
6000  *      F1-F3           6  (6 bits can be stripped)
6001  *      F4              5  (only 5 can be stripped)
6002  *      F5-FF           1
6003  */
6004
6005 EXTCONST U8 PL_c9_utf8_dfa_tab[] = {
6006     /* The first part of the table maps bytes to character classes to reduce
6007      * the size of the transition table and create bitmasks. */
6008    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*00-0F*/
6009    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*10-1F*/
6010    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*20-2F*/
6011    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*30-3F*/
6012    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*40-4F*/
6013    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*50-5F*/
6014    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*60-6F*/
6015    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*70-7F*/
6016    9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, /*80-8F*/
6017   10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10, /*90-9F*/
6018   11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11, /*A0-AF*/
6019   11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11, /*B0-BF*/
6020    1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*C0-CF*/
6021    2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*D0-DF*/
6022    7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 4, 3, 3, /*E0-EF*/
6023    8, 6, 6, 6, 5, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /*F0-FF*/
6024
6025 /* The second part is a transition table that maps a combination
6026  * of a state of the automaton and a character class to a new state, called a
6027  * node.  The nodes are:
6028  * N0     The initial state, and final accepting one.
6029  * N1     Any one continuation byte (80-BF) left.  This is transitioned to
6030  *        immediately when the start byte indicates a two-byte sequence
6031  * N2     Any two continuation bytes left.
6032  * N3     Any three continuation bytes left.
6033  * N4     Start byte is E0.  Continuation bytes 80-9F are illegal (overlong);
6034  *        the other continuations transition to state N1
6035  * N5     Start byte is ED.  Continuation bytes A0-BF all lead to surrogates,
6036  *        so are illegal.  The other continuations transition to state N1.
6037  * N6     Start byte is F0.  Continuation bytes 80-8F are illegal (overlong);
6038  *        the other continuations transition to N2
6039  * N7     Start byte is F4.  Continuation bytes 90-BF are illegal
6040  *        (non-unicode); the other continuations transition to N2
6041  * 1      Reject.  All transitions not mentioned above (except the single
6042  *        byte ones (as they are always legal) are to this state.
6043  */
6044
6045 #    undef N0
6046 #    undef N1
6047 #    undef N2
6048 #    undef N3
6049 #    undef N4
6050 #    undef N5
6051 #    undef N6
6052 #    undef N7
6053 #    undef NUM_CLASSES
6054 #    define NUM_CLASSES 12
6055 #    define N0 0
6056 #    define N1  ((N0)  + NUM_CLASSES)
6057 #    define N2  ((N1)  + NUM_CLASSES)
6058 #    define N3  ((N2)  + NUM_CLASSES)
6059 #    define N4  ((N3)  + NUM_CLASSES)
6060 #    define N5  ((N4)  + NUM_CLASSES)
6061 #    define N6  ((N5)  + NUM_CLASSES)
6062 #    define N7  ((N6)  + NUM_CLASSES)
6063
6064 /*Class: 0   1   2   3   4   5   6   7   8   9  10  11 */
6065 /*N0*/   0,  1, N1, N2, N5, N7, N3, N4, N6,  1,  1,  1,
6066 /*N1*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  0,  0,  0,
6067 /*N2*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N1, N1, N1,
6068 /*N3*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N2, N2, N2,
6069
6070 /*N4*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1, N1,
6071 /*N5*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N1, N1,  1,
6072 /*N6*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  1, N2, N2,
6073 /*N7*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N2,  1,  1,
6074 };
6075
6076 #  else     /* End of is DOINIT */
6077
6078 EXTCONST U8 PL_extended_utf8_dfa_tab[];
6079 EXTCONST U8 PL_strict_utf8_dfa_tab[];
6080 EXTCONST U8 PL_c9_utf8_dfa_tab[];
6081
6082 #  endif
6083 #endif    /* end of isn't EBCDIC */
6084
6085 #ifndef PERL_NO_INLINE_FUNCTIONS
6086 /* Static inline funcs that depend on includes and declarations above.
6087    Some of these reference functions in the perl object files, and some
6088    compilers aren't smart enough to eliminate unused static inline
6089    functions, so including this file in source code can cause link errors
6090    even if the source code uses none of the functions. Hence including these
6091    can be be suppressed by setting PERL_NO_INLINE_FUNCTIONS. Doing this will
6092    (obviously) result in unworkable XS code, but allows simple probing code
6093    to continue to work, because it permits tests to include the perl headers
6094    for definitions without creating a link dependency on the perl library
6095    (which may not exist yet).
6096 */
6097
6098 #  include "inline.h"
6099 #endif
6100
6101 #include "overload.h"
6102
6103 END_EXTERN_C
6104
6105 struct am_table {
6106   U8 flags;
6107   U8 fallback;
6108   U16 spare;
6109   U32 was_ok_sub;
6110   CV* table[NofAMmeth];
6111 };
6112 struct am_table_short {
6113   U8 flags;
6114   U8 fallback;
6115   U16 spare;
6116   U32 was_ok_sub;
6117 };
6118 typedef struct am_table AMT;
6119 typedef struct am_table_short AMTS;
6120
6121 #define AMGfallNEVER    1
6122 #define AMGfallNO       2
6123 #define AMGfallYES      3
6124
6125 #define AMTf_AMAGIC             1
6126 #define AMT_AMAGIC(amt)         ((amt)->flags & AMTf_AMAGIC)
6127 #define AMT_AMAGIC_on(amt)      ((amt)->flags |= AMTf_AMAGIC)
6128 #define AMT_AMAGIC_off(amt)     ((amt)->flags &= ~AMTf_AMAGIC)
6129
6130 #define StashHANDLER(stash,meth)        gv_handler((stash),CAT2(meth,_amg))
6131
6132 /*
6133  * some compilers like to redefine cos et alia as faster
6134  * (and less accurate?) versions called F_cos et cetera (Quidquid
6135  * latine dictum sit, altum viditur.)  This trick collides with
6136  * the Perl overloading (amg).  The following #defines fool both.
6137  */
6138
6139 #ifdef _FASTMATH
6140 #   ifdef atan2
6141 #       define F_atan2_amg  atan2_amg
6142 #   endif
6143 #   ifdef cos
6144 #       define F_cos_amg    cos_amg
6145 #   endif
6146 #   ifdef exp
6147 #       define F_exp_amg    exp_amg
6148 #   endif
6149 #   ifdef log
6150 #       define F_log_amg    log_amg
6151 #   endif
6152 #   ifdef pow
6153 #       define F_pow_amg    pow_amg
6154 #   endif
6155 #   ifdef sin
6156 #       define F_sin_amg    sin_amg
6157 #   endif
6158 #   ifdef sqrt
6159 #       define F_sqrt_amg   sqrt_amg
6160 #   endif
6161 #endif /* _FASTMATH */
6162
6163 #define PERLDB_ALL              (PERLDBf_SUB    | PERLDBf_LINE  |       \
6164                                  PERLDBf_NOOPT  | PERLDBf_INTER |       \
6165                                  PERLDBf_SUBLINE| PERLDBf_SINGLE|       \
6166                                  PERLDBf_NAMEEVAL| PERLDBf_NAMEANON |   \
6167                                  PERLDBf_SAVESRC)
6168                                         /* No _NONAME, _GOTO */
6169 #define PERLDBf_SUB             0x01    /* Debug sub enter/exit */
6170 #define PERLDBf_LINE            0x02    /* Keep line # */
6171 #define PERLDBf_NOOPT           0x04    /* Switch off optimizations */
6172 #define PERLDBf_INTER           0x08    /* Preserve more data for
6173                                            later inspections  */
6174 #define PERLDBf_SUBLINE         0x10    /* Keep subr source lines */
6175 #define PERLDBf_SINGLE          0x20    /* Start with single-step on */
6176 #define PERLDBf_NONAME          0x40    /* For _SUB: no name of the subr */
6177 #define PERLDBf_GOTO            0x80    /* Report goto: call DB::goto */
6178 #define PERLDBf_NAMEEVAL        0x100   /* Informative names for evals */
6179 #define PERLDBf_NAMEANON        0x200   /* Informative names for anon subs */
6180 #define PERLDBf_SAVESRC         0x400   /* Save source lines into @{"_<$filename"} */
6181 #define PERLDBf_SAVESRC_NOSUBS  0x800   /* Including evals that generate no subroutines */
6182 #define PERLDBf_SAVESRC_INVALID 0x1000  /* Save source that did not compile */
6183
6184 #define PERLDB_SUB              (PL_perldb & PERLDBf_SUB)
6185 #define PERLDB_LINE             (PL_perldb & PERLDBf_LINE)
6186 #define PERLDB_NOOPT            (PL_perldb & PERLDBf_NOOPT)
6187 #define PERLDB_INTER            (PL_perldb & PERLDBf_INTER)
6188 #define PERLDB_SUBLINE          (PL_perldb & PERLDBf_SUBLINE)
6189 #define PERLDB_SINGLE           (PL_perldb & PERLDBf_SINGLE)
6190 #define PERLDB_SUB_NN           (PL_perldb & PERLDBf_NONAME)
6191 #define PERLDB_GOTO             (PL_perldb & PERLDBf_GOTO)
6192 #define PERLDB_NAMEEVAL         (PL_perldb & PERLDBf_NAMEEVAL)
6193 #define PERLDB_NAMEANON         (PL_perldb & PERLDBf_NAMEANON)
6194 #define PERLDB_SAVESRC          (PL_perldb & PERLDBf_SAVESRC)
6195 #define PERLDB_SAVESRC_NOSUBS   (PL_perldb & PERLDBf_SAVESRC_NOSUBS)
6196 #define PERLDB_SAVESRC_INVALID  (PL_perldb & PERLDBf_SAVESRC_INVALID)
6197
6198 #define PERLDB_LINE_OR_SAVESRC (PL_perldb & (PERLDBf_LINE | PERLDBf_SAVESRC))
6199
6200 #ifdef USE_ITHREADS
6201 #  define KEYWORD_PLUGIN_MUTEX_INIT    MUTEX_INIT(&PL_keyword_plugin_mutex)
6202 #  define KEYWORD_PLUGIN_MUTEX_LOCK    MUTEX_LOCK(&PL_keyword_plugin_mutex)
6203 #  define KEYWORD_PLUGIN_MUTEX_UNLOCK  MUTEX_UNLOCK(&PL_keyword_plugin_mutex)
6204 #  define KEYWORD_PLUGIN_MUTEX_TERM    MUTEX_DESTROY(&PL_keyword_plugin_mutex)
6205 #  define USER_PROP_MUTEX_INIT    MUTEX_INIT(&PL_user_prop_mutex)
6206 #  define USER_PROP_MUTEX_LOCK    MUTEX_LOCK(&PL_user_prop_mutex)
6207 #  define USER_PROP_MUTEX_UNLOCK  MUTEX_UNLOCK(&PL_user_prop_mutex)
6208 #  define USER_PROP_MUTEX_TERM    MUTEX_DESTROY(&PL_user_prop_mutex)
6209 #else
6210 #  define KEYWORD_PLUGIN_MUTEX_INIT    NOOP
6211 #  define KEYWORD_PLUGIN_MUTEX_LOCK    NOOP
6212 #  define KEYWORD_PLUGIN_MUTEX_UNLOCK  NOOP
6213 #  define KEYWORD_PLUGIN_MUTEX_TERM    NOOP
6214 #  define USER_PROP_MUTEX_INIT    NOOP
6215 #  define USER_PROP_MUTEX_LOCK    NOOP
6216 #  define USER_PROP_MUTEX_UNLOCK  NOOP
6217 #  define USER_PROP_MUTEX_TERM    NOOP
6218 #endif
6219
6220 #ifdef USE_LOCALE /* These locale things are all subject to change */
6221
6222    /* Returns TRUE if the plain locale pragma without a parameter is in effect.
6223     * */
6224 #  define IN_LOCALE_RUNTIME     (PL_curcop                                  \
6225                               && CopHINTS_get(PL_curcop) & HINT_LOCALE)
6226
6227    /* Returns TRUE if either form of the locale pragma is in effect */
6228 #  define IN_SOME_LOCALE_FORM_RUNTIME                                       \
6229         cBOOL(CopHINTS_get(PL_curcop) & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
6230
6231 #  define IN_LOCALE_COMPILETIME cBOOL(PL_hints & HINT_LOCALE)
6232 #  define IN_SOME_LOCALE_FORM_COMPILETIME                                   \
6233                         cBOOL(PL_hints & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
6234
6235 /*
6236 =head1 Locale-related functions and macros
6237
6238 =for apidoc Amn|bool|IN_LOCALE
6239
6240 Evaluates to TRUE if the plain locale pragma without a parameter (S<C<use
6241 locale>>) is in effect.
6242
6243 =for apidoc Amn|bool|IN_LOCALE_COMPILETIME
6244
6245 Evaluates to TRUE if, when compiling a perl program (including an C<eval>) if
6246 the plain locale pragma without a parameter (S<C<use locale>>) is in effect.
6247
6248 =for apidoc Amn|bool|IN_LOCALE_RUNTIME
6249
6250 Evaluates to TRUE if, when executing a perl program (including an C<eval>) if
6251 the plain locale pragma without a parameter (S<C<use locale>>) is in effect.
6252
6253 =cut
6254 */
6255
6256 #  define IN_LOCALE                                                         \
6257         (IN_PERL_COMPILETIME ? IN_LOCALE_COMPILETIME : IN_LOCALE_RUNTIME)
6258 #  define IN_SOME_LOCALE_FORM                                               \
6259                     (IN_PERL_COMPILETIME ? IN_SOME_LOCALE_FORM_COMPILETIME  \
6260                                          : IN_SOME_LOCALE_FORM_RUNTIME)
6261
6262 #  define IN_LC_ALL_COMPILETIME   IN_LOCALE_COMPILETIME
6263 #  define IN_LC_ALL_RUNTIME       IN_LOCALE_RUNTIME
6264
6265 #  define IN_LC_PARTIAL_COMPILETIME   cBOOL(PL_hints & HINT_LOCALE_PARTIAL)
6266 #  define IN_LC_PARTIAL_RUNTIME                                             \
6267               (PL_curcop && CopHINTS_get(PL_curcop) & HINT_LOCALE_PARTIAL)
6268
6269 #  define IN_LC_COMPILETIME(category)                                       \
6270        (       IN_LC_ALL_COMPILETIME                                        \
6271         || (   IN_LC_PARTIAL_COMPILETIME                                    \
6272             && Perl__is_in_locale_category(aTHX_ TRUE, (category))))
6273 #  define IN_LC_RUNTIME(category)                                           \
6274       (IN_LC_ALL_RUNTIME || (IN_LC_PARTIAL_RUNTIME                          \
6275                  && Perl__is_in_locale_category(aTHX_ FALSE, (category))))
6276 #  define IN_LC(category)  \
6277                     (IN_LC_COMPILETIME(category) || IN_LC_RUNTIME(category))
6278
6279 #  if defined (PERL_CORE) || defined (PERL_IN_XSUB_RE)
6280
6281      /* This internal macro should be called from places that operate under
6282       * locale rules.  If there is a problem with the current locale that
6283       * hasn't been raised yet, it will output a warning this time.  Because
6284       * this will so rarely  be true, there is no point to optimize for time;
6285       * instead it makes sense to minimize space used and do all the work in
6286       * the rarely called function */
6287 #    ifdef USE_LOCALE_CTYPE
6288 #      define _CHECK_AND_WARN_PROBLEMATIC_LOCALE                              \
6289                 STMT_START {                                                  \
6290                     if (UNLIKELY(PL_warn_locale)) {                           \
6291                         Perl__warn_problematic_locale();                      \
6292                     }                                                         \
6293                 }  STMT_END
6294 #    else
6295 #      define _CHECK_AND_WARN_PROBLEMATIC_LOCALE
6296 #    endif
6297
6298
6299      /* These two internal macros are called when a warning should be raised,
6300       * and will do so if enabled.  The first takes a single code point
6301       * argument; the 2nd, is a pointer to the first byte of the UTF-8 encoded
6302       * string, and an end position which it won't try to read past */
6303 #    define _CHECK_AND_OUTPUT_WIDE_LOCALE_CP_MSG(cp)                        \
6304         STMT_START {                                                        \
6305             if (! PL_in_utf8_CTYPE_locale && ckWARN(WARN_LOCALE)) {         \
6306                 Perl_warner(aTHX_ packWARN(WARN_LOCALE),                    \
6307                                        "Wide character (U+%" UVXf ") in %s",\
6308                                        (UV) cp, OP_DESC(PL_op));            \
6309             }                                                               \
6310         }  STMT_END
6311
6312 #    define _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(s, send)                 \
6313         STMT_START { /* Check if to warn before doing the conversion work */\
6314             if (! PL_in_utf8_CTYPE_locale && ckWARN(WARN_LOCALE)) {         \
6315                 UV cp = utf8_to_uvchr_buf((U8 *) (s), (U8 *) (send), NULL); \
6316                 Perl_warner(aTHX_ packWARN(WARN_LOCALE),                    \
6317                     "Wide character (U+%" UVXf ") in %s",                   \
6318                     (cp == 0)                                               \
6319                      ? UNICODE_REPLACEMENT                                  \
6320                      : (UV) cp,                                             \
6321                     OP_DESC(PL_op));                                        \
6322             }                                                               \
6323         }  STMT_END
6324
6325 #  endif   /* PERL_CORE or PERL_IN_XSUB_RE */
6326 #else   /* No locale usage */
6327 #  define IN_LOCALE_RUNTIME                0
6328 #  define IN_SOME_LOCALE_FORM_RUNTIME      0
6329 #  define IN_LOCALE_COMPILETIME            0
6330 #  define IN_SOME_LOCALE_FORM_COMPILETIME  0
6331 #  define IN_LOCALE                        0
6332 #  define IN_SOME_LOCALE_FORM              0
6333 #  define IN_LC_ALL_COMPILETIME            0
6334 #  define IN_LC_ALL_RUNTIME                0
6335 #  define IN_LC_PARTIAL_COMPILETIME        0
6336 #  define IN_LC_PARTIAL_RUNTIME            0
6337 #  define IN_LC_COMPILETIME(category)      0
6338 #  define IN_LC_RUNTIME(category)          0
6339 #  define IN_LC(category)                  0
6340 #  define _CHECK_AND_WARN_PROBLEMATIC_LOCALE
6341 #  define _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(s, send)
6342 #  define _CHECK_AND_OUTPUT_WIDE_LOCALE_CP_MSG(c)
6343 #endif
6344
6345
6346 /* Locale/thread synchronization macros.  These aren't needed if using
6347  * thread-safe locale operations, except if something is broken */
6348 #if    defined(USE_LOCALE)                                                  \
6349  &&    defined(USE_ITHREADS)                                                \
6350  && (! defined(USE_THREAD_SAFE_LOCALE) || defined(TS_W32_BROKEN_LOCALECONV))
6351
6352 /* We have a locale object holding the 'C' locale for Posix 2008 */
6353 #  ifndef USE_POSIX_2008_LOCALE
6354 #    define _LOCALE_TERM_POSIX_2008  NOOP
6355 #  else
6356 #    define _LOCALE_TERM_POSIX_2008                                         \
6357                     STMT_START {                                            \
6358                         if (PL_C_locale_obj) {                              \
6359                             /* Make sure we aren't using the locale         \
6360                              * space we are about to free */                \
6361                             uselocale(LC_GLOBAL_LOCALE);                    \
6362                             freelocale(PL_C_locale_obj);                    \
6363                             PL_C_locale_obj = (locale_t) NULL;              \
6364                         }                                                   \
6365                     } STMT_END
6366 #  endif
6367
6368 /* This is used as a generic lock for locale operations.  For example this is
6369  * used when calling nl_langinfo() so that another thread won't zap the
6370  * contents of its buffer before it gets saved; and it's called when changing
6371  * the locale of LC_MESSAGES.  On some systems the latter can cause the
6372  * nl_langinfo buffer to be zapped under a race condition.
6373  *
6374  * If combined with LC_NUMERIC_LOCK, calls to this and its corresponding unlock
6375  * should be contained entirely within the locked portion of LC_NUMERIC.  This
6376  * mutex should be used only in very short sections of code, while
6377  * LC_NUMERIC_LOCK may span more operations.  By always following this
6378  * convention, deadlock should be impossible.  But if necessary, the two
6379  * mutexes could be combined.
6380  *
6381  * Actually, the two macros just below with the '_V' suffixes are used in just
6382  * a few places where there is a broken localeconv(), but otherwise things are
6383  * thread safe, and hence don't need locking.  Just below LOCALE_LOCK and
6384  * LOCALE_UNLOCK are defined in terms of these for use everywhere else */
6385 #  define LOCALE_LOCK_V                                                     \
6386         STMT_START {                                                        \
6387             DEBUG_Lv(PerlIO_printf(Perl_debug_log,                          \
6388                     "%s: %d: locking locale\n", __FILE__, __LINE__));       \
6389             MUTEX_LOCK(&PL_locale_mutex);                                   \
6390         } STMT_END
6391 #  define LOCALE_UNLOCK_V                                                   \
6392         STMT_START {                                                        \
6393             DEBUG_Lv(PerlIO_printf(Perl_debug_log,                          \
6394                    "%s: %d: unlocking locale\n", __FILE__, __LINE__));      \
6395             MUTEX_UNLOCK(&PL_locale_mutex);                                 \
6396         } STMT_END
6397
6398 /* On windows, we just need the mutex for LOCALE_LOCK */
6399 #  ifdef TS_W32_BROKEN_LOCALECONV
6400 #    define LOCALE_LOCK     NOOP
6401 #    define LOCALE_UNLOCK   NOOP
6402 #    define LOCALE_INIT     MUTEX_INIT(&PL_locale_mutex);
6403 #    define LOCALE_TERM     MUTEX_DESTROY(&PL_locale_mutex)
6404 #    define LC_NUMERIC_LOCK(cond)
6405 #    define LC_NUMERIC_UNLOCK
6406 #  else
6407 #    define LOCALE_LOCK     LOCALE_LOCK_V
6408 #    define LOCALE_UNLOCK   LOCALE_UNLOCK_V
6409
6410      /* We also need to lock LC_NUMERIC for non-windows (hence Posix 2008)
6411       * systems */
6412 #    define LOCALE_INIT          STMT_START {                               \
6413                                     MUTEX_INIT(&PL_locale_mutex);           \
6414                                     MUTEX_INIT(&PL_lc_numeric_mutex);       \
6415                                 } STMT_END
6416
6417 #    define LOCALE_TERM         STMT_START {                                \
6418                                     MUTEX_DESTROY(&PL_locale_mutex);        \
6419                                     MUTEX_DESTROY(&PL_lc_numeric_mutex);    \
6420                                     _LOCALE_TERM_POSIX_2008;                \
6421                                 } STMT_END
6422
6423     /* This mutex is used to create critical sections where we want the
6424      * LC_NUMERIC locale to be locked into either the C (standard) locale, or
6425      * the underlying locale, so that other threads interrupting this one don't
6426      * change it to the wrong state before we've had a chance to complete our
6427      * operation.  It can stay locked over an entire printf operation, for
6428      * example.  And so is made distinct from the LOCALE_LOCK mutex.
6429      *
6430      * This simulates kind of a general semaphore.  The current thread will
6431      * lock the mutex if the per-thread variable is zero, and then increments
6432      * that variable.  Each corresponding UNLOCK decrements the variable until
6433      * it is 0, at which point it actually unlocks the mutex.  Since the
6434      * variable is per-thread, there is no race with other threads.
6435      *
6436      * The single argument is a condition to test for, and if true, to panic,
6437      * as this would be an attempt to complement the LC_NUMERIC state, and
6438      * we're not supposed to because it's locked.
6439      *
6440      * Clang improperly gives warnings for this, if not silenced:
6441      * https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#conditional-locks
6442      * */
6443 #    define LC_NUMERIC_LOCK(cond_to_panic_if_already_locked)                \
6444         CLANG_DIAG_IGNORE(-Wthread-safety)                                  \
6445         STMT_START {                                                        \
6446             if (PL_lc_numeric_mutex_depth <= 0) {                           \
6447                 MUTEX_LOCK(&PL_lc_numeric_mutex);                           \
6448                 PL_lc_numeric_mutex_depth = 1;                              \
6449                 DEBUG_Lv(PerlIO_printf(Perl_debug_log,                      \
6450                          "%s: %d: locking lc_numeric; depth=1\n",           \
6451                          __FILE__, __LINE__));                              \
6452             }                                                               \
6453             else {                                                          \
6454                 PL_lc_numeric_mutex_depth++;                                \
6455                 DEBUG_Lv(PerlIO_printf(Perl_debug_log,                      \
6456                         "%s: %d: avoided lc_numeric_lock; new depth=%d\n",  \
6457                         __FILE__, __LINE__, PL_lc_numeric_mutex_depth));    \
6458                 if (cond_to_panic_if_already_locked) {                      \
6459                     Perl_croak_nocontext("panic: %s: %d: Trying to change"  \
6460                                          " LC_NUMERIC incompatibly",        \
6461                                          __FILE__, __LINE__);               \
6462                 }                                                           \
6463             }                                                               \
6464         } STMT_END
6465
6466 #    define LC_NUMERIC_UNLOCK                                               \
6467         STMT_START {                                                        \
6468             if (PL_lc_numeric_mutex_depth <= 1) {                           \
6469                 MUTEX_UNLOCK(&PL_lc_numeric_mutex);                         \
6470                 PL_lc_numeric_mutex_depth = 0;                              \
6471                 DEBUG_Lv(PerlIO_printf(Perl_debug_log,                      \
6472                          "%s: %d: unlocking lc_numeric; depth=0\n",         \
6473                          __FILE__, __LINE__));                              \
6474             }                                                               \
6475             else {                                                          \
6476                 PL_lc_numeric_mutex_depth--;                                \
6477                 DEBUG_Lv(PerlIO_printf(Perl_debug_log,                      \
6478                         "%s: %d: avoided lc_numeric_unlock; new depth=%d\n",\
6479                         __FILE__, __LINE__, PL_lc_numeric_mutex_depth));    \
6480             }                                                               \
6481         } STMT_END                                                          \
6482         CLANG_DIAG_RESTORE
6483
6484 #  endif    /* End of needs locking LC_NUMERIC */
6485 #else   /* Below is no locale sync needed */
6486 #  define LOCALE_INIT
6487 #  define LOCALE_LOCK
6488 #  define LOCALE_LOCK_V
6489 #  define LOCALE_UNLOCK
6490 #  define LOCALE_UNLOCK_V
6491 #  define LC_NUMERIC_LOCK(cond)
6492 #  define LC_NUMERIC_UNLOCK
6493 #  define LOCALE_TERM
6494 #endif
6495
6496 #ifdef USE_LOCALE_NUMERIC
6497
6498 /* These macros are for toggling between the underlying locale (UNDERLYING or
6499  * LOCAL) and the C locale (STANDARD).  (Actually we don't have to use the C
6500  * locale if the underlying locale is indistinguishable from it in the numeric
6501  * operations used by Perl, namely the decimal point, and even the thousands
6502  * separator.)
6503
6504 =head1 Locale-related functions and macros
6505
6506 =for apidoc Amn|void|DECLARATION_FOR_LC_NUMERIC_MANIPULATION
6507
6508 This macro should be used as a statement.  It declares a private variable
6509 (whose name begins with an underscore) that is needed by the other macros in
6510 this section.  Failing to include this correctly should lead to a syntax error.
6511 For compatibility with C89 C compilers it should be placed in a block before
6512 any executable statements.
6513
6514 =for apidoc Am|void|STORE_LC_NUMERIC_FORCE_TO_UNDERLYING
6515
6516 This is used by XS code that that is C<LC_NUMERIC> locale-aware to force the
6517 locale for category C<LC_NUMERIC> to be what perl thinks is the current
6518 underlying locale.  (The perl interpreter could be wrong about what the
6519 underlying locale actually is if some C or XS code has called the C library
6520 function L<setlocale(3)> behind its back; calling L</sync_locale> before calling
6521 this macro will update perl's records.)
6522
6523 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
6524 declare at compile time a private variable used by this macro.  This macro
6525 should be called as a single statement, not an expression, but with an empty
6526 argument list, like this:
6527
6528  {
6529     DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6530      ...
6531     STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
6532      ...
6533     RESTORE_LC_NUMERIC();
6534      ...
6535  }
6536
6537 The private variable is used to save the current locale state, so
6538 that the requisite matching call to L</RESTORE_LC_NUMERIC> can restore it.
6539
6540 On threaded perls not operating with thread-safe functionality, this macro uses
6541 a mutex to force a critical section.  Therefore the matching RESTORE should be
6542 close by, and guaranteed to be called.
6543
6544 =for apidoc Am|void|STORE_LC_NUMERIC_SET_TO_NEEDED
6545
6546 This is used to help wrap XS or C code that is C<LC_NUMERIC> locale-aware.
6547 This locale category is generally kept set to a locale where the decimal radix
6548 character is a dot, and the separator between groups of digits is empty.  This
6549 is because most XS code that reads floating point numbers is expecting them to
6550 have this syntax.
6551
6552 This macro makes sure the current C<LC_NUMERIC> state is set properly, to be
6553 aware of locale if the call to the XS or C code from the Perl program is
6554 from within the scope of a S<C<use locale>>; or to ignore locale if the call is
6555 instead from outside such scope.
6556
6557 This macro is the start of wrapping the C or XS code; the wrap ending is done
6558 by calling the L</RESTORE_LC_NUMERIC> macro after the operation.  Otherwise
6559 the state can be changed that will adversely affect other XS code.
6560
6561 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
6562 declare at compile time a private variable used by this macro.  This macro
6563 should be called as a single statement, not an expression, but with an empty
6564 argument list, like this:
6565
6566  {
6567     DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6568      ...
6569     STORE_LC_NUMERIC_SET_TO_NEEDED();
6570      ...
6571     RESTORE_LC_NUMERIC();
6572      ...
6573  }
6574
6575 On threaded perls not operating with thread-safe functionality, this macro uses
6576 a mutex to force a critical section.  Therefore the matching RESTORE should be
6577 close by, and guaranteed to be called; see L</WITH_LC_NUMERIC_SET_TO_NEEDED>
6578 for a more contained way to ensure that.
6579
6580 =for apidoc Am|void|STORE_LC_NUMERIC_SET_TO_NEEDED_IN|bool in_lc_numeric
6581
6582 Same as L</STORE_LC_NUMERIC_SET_TO_NEEDED> with in_lc_numeric provided
6583 as the precalculated value of C<IN_LC(LC_NUMERIC)>. It is the caller's
6584 responsibility to ensure that the status of C<PL_compiling> and C<PL_hints>
6585 cannot have changed since the precalculation.
6586
6587 =for apidoc Am|void|RESTORE_LC_NUMERIC
6588
6589 This is used in conjunction with one of the macros
6590 L</STORE_LC_NUMERIC_SET_TO_NEEDED>
6591 and L</STORE_LC_NUMERIC_FORCE_TO_UNDERLYING> to properly restore the
6592 C<LC_NUMERIC> state.
6593
6594 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
6595 declare at compile time a private variable used by this macro and the two
6596 C<STORE> ones.  This macro should be called as a single statement, not an
6597 expression, but with an empty argument list, like this:
6598
6599  {
6600     DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6601      ...
6602     RESTORE_LC_NUMERIC();
6603      ...
6604  }
6605
6606 =for apidoc Am|void|WITH_LC_NUMERIC_SET_TO_NEEDED|block
6607
6608 This macro invokes the supplied statement or block within the context
6609 of a L</STORE_LC_NUMERIC_SET_TO_NEEDED> .. L</RESTORE_LC_NUMERIC> pair
6610 if required, so eg:
6611
6612   WITH_LC_NUMERIC_SET_TO_NEEDED(
6613     SNPRINTF_G(fv, ebuf, sizeof(ebuf), precis)
6614   );
6615
6616 is equivalent to:
6617
6618   {
6619 #ifdef USE_LOCALE_NUMERIC
6620     DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6621     STORE_LC_NUMERIC_SET_TO_NEEDED();
6622 #endif
6623     SNPRINTF_G(fv, ebuf, sizeof(ebuf), precis);
6624 #ifdef USE_LOCALE_NUMERIC
6625     RESTORE_LC_NUMERIC();
6626 #endif
6627   }
6628
6629 =for apidoc Am|void|WITH_LC_NUMERIC_SET_TO_NEEDED_IN|bool in_lc_numeric|block
6630
6631 Same as L</WITH_LC_NUMERIC_SET_TO_NEEDED> with in_lc_numeric provided
6632 as the precalculated value of C<IN_LC(LC_NUMERIC)>. It is the caller's
6633 responsibility to ensure that the status of C<PL_compiling> and C<PL_hints>
6634 cannot have changed since the precalculation.
6635
6636 =cut
6637
6638 */
6639
6640 /* If the underlying numeric locale has a non-dot decimal point or has a
6641  * non-empty floating point thousands separator, the current locale is instead
6642  * generally kept in the C locale instead of that underlying locale.  The
6643  * current status is known by looking at two words.  One is non-zero if the
6644  * current numeric locale is the standard C/POSIX one or is indistinguishable
6645  * from C.  The other is non-zero if the current locale is the underlying
6646  * locale.  Both can be non-zero if, as often happens, the underlying locale is
6647  * C or indistinguishable from it.
6648  *
6649  * khw believes the reason for the variables instead of the bits in a single
6650  * word is to avoid having to have masking instructions. */
6651
6652 #  define _NOT_IN_NUMERIC_STANDARD (! PL_numeric_standard)
6653
6654 /* We can lock the category to stay in the C locale, making requests to the
6655  * contrary be noops, in the dynamic scope by setting PL_numeric_standard to 2.
6656  * */
6657 #  define _NOT_IN_NUMERIC_UNDERLYING                                        \
6658                     (! PL_numeric_underlying && PL_numeric_standard < 2)
6659
6660 #  define DECLARATION_FOR_LC_NUMERIC_MANIPULATION                           \
6661     void (*_restore_LC_NUMERIC_function)(pTHX) = NULL
6662
6663 #  define STORE_LC_NUMERIC_SET_TO_NEEDED_IN(in)                             \
6664         STMT_START {                                                        \
6665             bool _in_lc_numeric = (in);                                     \
6666             LC_NUMERIC_LOCK(                                                \
6667                     (   (  _in_lc_numeric && _NOT_IN_NUMERIC_UNDERLYING)    \
6668                      || (! _in_lc_numeric && _NOT_IN_NUMERIC_STANDARD)));   \
6669             if (_in_lc_numeric) {                                           \
6670                 if (_NOT_IN_NUMERIC_UNDERLYING) {                           \
6671                     Perl_set_numeric_underlying(aTHX);                      \
6672                     _restore_LC_NUMERIC_function                            \
6673                                             = &Perl_set_numeric_standard;   \
6674                 }                                                           \
6675             }                                                               \
6676             else {                                                          \
6677                 if (_NOT_IN_NUMERIC_STANDARD) {                             \
6678                     Perl_set_numeric_standard(aTHX);                        \
6679                     _restore_LC_NUMERIC_function                            \
6680                                             = &Perl_set_numeric_underlying; \
6681                 }                                                           \
6682             }                                                               \
6683         } STMT_END
6684
6685 #  define STORE_LC_NUMERIC_SET_TO_NEEDED() \
6686         STORE_LC_NUMERIC_SET_TO_NEEDED_IN(IN_LC(LC_NUMERIC))
6687
6688 #  define RESTORE_LC_NUMERIC()                                              \
6689         STMT_START {                                                        \
6690             if (_restore_LC_NUMERIC_function) {                             \
6691                 _restore_LC_NUMERIC_function(aTHX);                         \
6692             }                                                               \
6693             LC_NUMERIC_UNLOCK;                                              \
6694         } STMT_END
6695
6696 /* The next two macros set unconditionally.  These should be rarely used, and
6697  * only after being sure that this is what is needed */
6698 #  define SET_NUMERIC_STANDARD()                                            \
6699         STMT_START {                                                        \
6700             DEBUG_Lv(PerlIO_printf(Perl_debug_log,                          \
6701                                "%s: %d: lc_numeric standard=%d\n",          \
6702                                 __FILE__, __LINE__, PL_numeric_standard));  \
6703             Perl_set_numeric_standard(aTHX);                                \
6704             DEBUG_Lv(PerlIO_printf(Perl_debug_log,                          \
6705                                  "%s: %d: lc_numeric standard=%d\n",        \
6706                                  __FILE__, __LINE__, PL_numeric_standard)); \
6707         } STMT_END
6708
6709 #  define SET_NUMERIC_UNDERLYING()                                          \
6710         STMT_START {                                                        \
6711             if (_NOT_IN_NUMERIC_UNDERLYING) {                               \
6712                 Perl_set_numeric_underlying(aTHX);                          \
6713             }                                                               \
6714         } STMT_END
6715
6716 /* The rest of these LC_NUMERIC macros toggle to one or the other state, with
6717  * the RESTORE_foo ones called to switch back, but only if need be */
6718 #  define STORE_LC_NUMERIC_SET_STANDARD()                                   \
6719         STMT_START {                                                        \
6720             LC_NUMERIC_LOCK(_NOT_IN_NUMERIC_STANDARD);                      \
6721             if (_NOT_IN_NUMERIC_STANDARD) {                                 \
6722                 _restore_LC_NUMERIC_function = &Perl_set_numeric_underlying;\
6723                 Perl_set_numeric_standard(aTHX);                            \
6724             }                                                               \
6725         } STMT_END
6726
6727 /* Rarely, we want to change to the underlying locale even outside of 'use
6728  * locale'.  This is principally in the POSIX:: functions */
6729 #  define STORE_LC_NUMERIC_FORCE_TO_UNDERLYING()                            \
6730         STMT_START {                                                        \
6731             LC_NUMERIC_LOCK(_NOT_IN_NUMERIC_UNDERLYING);                    \
6732             if (_NOT_IN_NUMERIC_UNDERLYING) {                               \
6733                 Perl_set_numeric_underlying(aTHX);                          \
6734                 _restore_LC_NUMERIC_function = &Perl_set_numeric_standard;  \
6735             }                                                               \
6736         } STMT_END
6737
6738 /* Lock/unlock to the C locale until unlock is called.  This needs to be
6739  * recursively callable.  [perl #128207] */
6740 #  define LOCK_LC_NUMERIC_STANDARD()                                        \
6741         STMT_START {                                                        \
6742             DEBUG_Lv(PerlIO_printf(Perl_debug_log,                          \
6743                       "%s: %d: lock lc_numeric_standard: new depth=%d\n",   \
6744                       __FILE__, __LINE__, PL_numeric_standard + 1));        \
6745             __ASSERT_(PL_numeric_standard)                                  \
6746             PL_numeric_standard++;                                          \
6747         } STMT_END
6748
6749 #  define UNLOCK_LC_NUMERIC_STANDARD()                                      \
6750         STMT_START {                                                        \
6751             if (PL_numeric_standard > 1) {                                  \
6752                 PL_numeric_standard--;                                      \
6753             }                                                               \
6754             else {                                                          \
6755                 assert(0);                                                  \
6756             }                                                               \
6757             DEBUG_Lv(PerlIO_printf(Perl_debug_log,                          \
6758             "%s: %d: lc_numeric_standard decrement lock, new depth=%d\n",   \
6759             __FILE__, __LINE__, PL_numeric_standard));                      \
6760         } STMT_END
6761
6762 #  define WITH_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric, block)            \
6763         STMT_START {                                                        \
6764             DECLARATION_FOR_LC_NUMERIC_MANIPULATION;                        \
6765             STORE_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric);               \
6766             block;                                                          \
6767             RESTORE_LC_NUMERIC();                                           \
6768         } STMT_END;
6769
6770 #  define WITH_LC_NUMERIC_SET_TO_NEEDED(block) \
6771         WITH_LC_NUMERIC_SET_TO_NEEDED_IN(IN_LC(LC_NUMERIC), block)
6772
6773 #else /* !USE_LOCALE_NUMERIC */
6774
6775 #  define SET_NUMERIC_STANDARD()
6776 #  define SET_NUMERIC_UNDERLYING()
6777 #  define IS_NUMERIC_RADIX(a, b)                (0)
6778 #  define DECLARATION_FOR_LC_NUMERIC_MANIPULATION
6779 #  define STORE_LC_NUMERIC_SET_STANDARD()
6780 #  define STORE_LC_NUMERIC_FORCE_TO_UNDERLYING()
6781 #  define STORE_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric)
6782 #  define STORE_LC_NUMERIC_SET_TO_NEEDED()
6783 #  define RESTORE_LC_NUMERIC()
6784 #  define LOCK_LC_NUMERIC_STANDARD()
6785 #  define UNLOCK_LC_NUMERIC_STANDARD()
6786 #  define WITH_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric, block) \
6787     STMT_START { block; } STMT_END
6788 #  define WITH_LC_NUMERIC_SET_TO_NEEDED(block) \
6789     STMT_START { block; } STMT_END
6790
6791 #endif /* !USE_LOCALE_NUMERIC */
6792
6793 #define Atof                            my_atof
6794
6795 /*
6796
6797 =head1 Numeric functions
6798
6799 =for apidoc AmTR|NV|Strtod|NN const char * const s|NULLOK char ** e
6800
6801 This is a synonym for L</my_strtod>.
6802
6803 =for apidoc AmTR|NV|Strtol|NN const char * const s|NULLOK char ** e|int base
6804
6805 Platform and configuration independent C<strtol>.  This expands to the
6806 appropriate C<strotol>-like function based on the platform and F<Configure>
6807 options>.  For example it could expand to C<strtoll> or C<strtoq> instead of
6808 C<strtol>.
6809
6810 =for apidoc AmTR|NV|Strtoul|NN const char * const s|NULLOK char ** e|int base
6811
6812 Platform and configuration independent C<strtoul>.  This expands to the
6813 appropriate C<strotoul>-like function based on the platform and F<Configure>
6814 options>.  For example it could expand to C<strtoull> or C<strtouq> instead of
6815 C<strtoul>.
6816
6817 =cut
6818
6819 */
6820
6821 #define Strtod                          my_strtod
6822
6823 #if    defined(HAS_STRTOD)                                          \
6824    ||  defined(USE_QUADMATH)                                        \
6825    || (defined(HAS_STRTOLD) && defined(HAS_LONG_DOUBLE)             \
6826                             && defined(USE_LONG_DOUBLE))
6827 #  define Perl_strtod   Strtod
6828 #endif
6829
6830 #if !defined(Strtol) && defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && \
6831         (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
6832 #    ifdef __hpux
6833 #        define strtoll __strtoll       /* secret handshake */
6834 #    endif
6835 #    if defined(WIN64) && defined(_MSC_VER)
6836 #        define strtoll _strtoi64       /* secret handshake */
6837 #    endif
6838 #   if !defined(Strtol) && defined(HAS_STRTOLL)
6839 #       define Strtol   strtoll
6840 #   endif
6841 #    if !defined(Strtol) && defined(HAS_STRTOQ)
6842 #       define Strtol   strtoq
6843 #    endif
6844 /* is there atoq() anywhere? */
6845 #endif
6846 #if !defined(Strtol) && defined(HAS_STRTOL)
6847 #   define Strtol       strtol
6848 #endif
6849 #ifndef Atol
6850 /* It would be more fashionable to use Strtol() to define atol()
6851  * (as is done for Atoul(), see below) but for backward compatibility
6852  * we just assume atol(). */
6853 #   if defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && defined(HAS_ATOLL) && \
6854         (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
6855 #    ifdef WIN64
6856 #       define atoll    _atoi64         /* secret handshake */
6857 #    endif
6858 #       define Atol     atoll
6859 #   else
6860 #       define Atol     atol
6861 #   endif
6862 #endif
6863
6864 #if !defined(Strtoul) && defined(USE_64_BIT_INT) && defined(UV_IS_QUAD) && \
6865         (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
6866 #    ifdef __hpux
6867 #        define strtoull __strtoull     /* secret handshake */
6868 #    endif
6869 #    if defined(WIN64) && defined(_MSC_VER)
6870 #        define strtoull _strtoui64     /* secret handshake */
6871 #    endif
6872 #    if !defined(Strtoul) && defined(HAS_STRTOULL)
6873 #       define Strtoul  strtoull
6874 #    endif
6875 #    if !defined(Strtoul) && defined(HAS_STRTOUQ)
6876 #       define Strtoul  strtouq
6877 #    endif
6878 /* is there atouq() anywhere? */
6879 #endif
6880 #if !defined(Strtoul) && defined(HAS_STRTOUL)
6881 #   define Strtoul      strtoul
6882 #endif
6883 #if !defined(Strtoul) && defined(HAS_STRTOL) /* Last resort. */
6884 #   define Strtoul(s, e, b)     strchr((s), '-') ? ULONG_MAX : (unsigned long)strtol((s), (e), (b))
6885 #endif
6886 #ifndef Atoul
6887 #   define Atoul(s)     Strtoul(s, NULL, 10)
6888 #endif
6889
6890 #ifndef PERL_SCRIPT_MODE
6891 #define PERL_SCRIPT_MODE "r"
6892 #endif
6893
6894 /* not used. Kept as a NOOP for backcompat */
6895 #define PERL_STACK_OVERFLOW_CHECK()  NOOP
6896
6897 /*
6898  * Some nonpreemptive operating systems find it convenient to
6899  * check for asynchronous conditions after each op execution.
6900  * Keep this check simple, or it may slow down execution
6901  * massively.
6902  */
6903
6904 #ifndef PERL_MICRO
6905 #       ifndef PERL_ASYNC_CHECK
6906 #               define PERL_ASYNC_CHECK() if (UNLIKELY(PL_sig_pending)) PL_signalhook(aTHX)
6907 #       endif
6908 #endif
6909
6910 #ifndef PERL_ASYNC_CHECK
6911 #   define PERL_ASYNC_CHECK()  NOOP
6912 #endif
6913
6914 /*
6915  * On some operating systems, a memory allocation may succeed,
6916  * but put the process too close to the system's comfort limit.
6917  * In this case, PERL_ALLOC_CHECK frees the pointer and sets
6918  * it to NULL.
6919  */
6920 #ifndef PERL_ALLOC_CHECK
6921 #define PERL_ALLOC_CHECK(p)  NOOP
6922 #endif
6923
6924 #ifdef HAS_SEM
6925 #   include <sys/ipc.h>
6926 #   include <sys/sem.h>
6927 #   ifndef HAS_UNION_SEMUN      /* Provide the union semun. */
6928     union semun {
6929         int             val;
6930         struct semid_ds *buf;
6931         unsigned short  *array;
6932     };
6933 #   endif
6934 #   ifdef USE_SEMCTL_SEMUN
6935 #       ifdef IRIX32_SEMUN_BROKEN_BY_GCC
6936             union gccbug_semun {
6937                 int             val;
6938                 struct semid_ds *buf;
6939                 unsigned short  *array;
6940                 char            __dummy[5];
6941             };
6942 #           define semun gccbug_semun
6943 #       endif
6944 #       define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun)
6945 #   elif defined(USE_SEMCTL_SEMID_DS)
6946 #           ifdef EXTRA_F_IN_SEMUN_BUF
6947 #               define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buff)
6948 #           else
6949 #               define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buf)
6950 #           endif
6951 #   endif
6952 #endif
6953
6954 /*
6955  * Boilerplate macros for initializing and accessing interpreter-local
6956  * data from C.  All statics in extensions should be reworked to use
6957  * this, if you want to make the extension thread-safe.  See
6958  * ext/XS/APItest/APItest.xs for an example of the use of these macros,
6959  * and perlxs.pod for more.
6960  *
6961  * Code that uses these macros is responsible for the following:
6962  * 1. #define MY_CXT_KEY to a unique string, e.g.
6963  *    "DynaLoader::_guts" XS_VERSION
6964  *    XXX in the current implementation, this string is ignored.
6965  * 2. Declare a typedef named my_cxt_t that is a structure that contains
6966  *    all the data that needs to be interpreter-local.
6967  * 3. Use the START_MY_CXT macro after the declaration of my_cxt_t.
6968  * 4. Use the MY_CXT_INIT macro such that it is called exactly once
6969  *    (typically put in the BOOT: section).
6970  * 5. Use the members of the my_cxt_t structure everywhere as
6971  *    MY_CXT.member.
6972  * 6. Use the dMY_CXT macro (a declaration) in all the functions that
6973  *    access MY_CXT.
6974  */
6975
6976 #if defined(PERL_IMPLICIT_CONTEXT)
6977
6978 /* START_MY_CXT must appear in all extensions that define a my_cxt_t structure,
6979  * right after the definition (i.e. at file scope).  The non-threads
6980  * case below uses it to declare the data as static. */
6981 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
6982 #    define START_MY_CXT
6983 #    define MY_CXT_INDEX Perl_my_cxt_index(aTHX_ MY_CXT_KEY)
6984 #    define MY_CXT_INIT_ARG MY_CXT_KEY
6985 #  else
6986 #    define START_MY_CXT static int my_cxt_index = -1;
6987 #    define MY_CXT_INDEX my_cxt_index
6988 #    define MY_CXT_INIT_ARG &my_cxt_index
6989 #  endif /* #ifdef PERL_GLOBAL_STRUCT_PRIVATE */
6990
6991 /* Creates and zeroes the per-interpreter data.
6992  * (We allocate my_cxtp in a Perl SV so that it will be released when
6993  * the interpreter goes away.) */
6994 #  define MY_CXT_INIT \
6995         my_cxt_t *my_cxtp = \
6996             (my_cxt_t*)Perl_my_cxt_init(aTHX_ MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
6997         PERL_UNUSED_VAR(my_cxtp)
6998 #  define MY_CXT_INIT_INTERP(my_perl) \
6999         my_cxt_t *my_cxtp = \
7000             (my_cxt_t*)Perl_my_cxt_init(my_perl, MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
7001         PERL_UNUSED_VAR(my_cxtp)
7002
7003 /* This declaration should be used within all functions that use the
7004  * interpreter-local data. */
7005 #  define dMY_CXT       \
7006         my_cxt_t *my_cxtp = (my_cxt_t *)PL_my_cxt_list[MY_CXT_INDEX]
7007 #  define dMY_CXT_INTERP(my_perl)       \
7008         my_cxt_t *my_cxtp = (my_cxt_t *)(my_perl)->Imy_cxt_list[MY_CXT_INDEX]
7009
7010 /* Clones the per-interpreter data. */
7011 #  define MY_CXT_CLONE \
7012         my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1));\
7013         void * old_my_cxtp = PL_my_cxt_list[MY_CXT_INDEX];              \
7014         PL_my_cxt_list[MY_CXT_INDEX] = my_cxtp;                         \
7015         Copy(old_my_cxtp, my_cxtp, 1, my_cxt_t);
7016
7017
7018
7019 /* This macro must be used to access members of the my_cxt_t structure.
7020  * e.g. MY_CXT.some_data */
7021 #  define MY_CXT                (*my_cxtp)
7022
7023 /* Judicious use of these macros can reduce the number of times dMY_CXT
7024  * is used.  Use is similar to pTHX, aTHX etc. */
7025 #  define pMY_CXT       my_cxt_t *my_cxtp
7026 #  define pMY_CXT_      pMY_CXT,
7027 #  define _pMY_CXT      ,pMY_CXT
7028 #  define aMY_CXT       my_cxtp
7029 #  define aMY_CXT_      aMY_CXT,
7030 #  define _aMY_CXT      ,aMY_CXT
7031
7032 #else /* PERL_IMPLICIT_CONTEXT */
7033
7034 #  define START_MY_CXT          static my_cxt_t my_cxt;
7035 #  define dMY_CXT_SV            dNOOP
7036 #  define dMY_CXT               dNOOP
7037 #  define dMY_CXT_INTERP(my_perl) dNOOP
7038 #  define MY_CXT_INIT           NOOP
7039 #  define MY_CXT_CLONE          NOOP
7040 #  define MY_CXT                my_cxt
7041
7042 #  define pMY_CXT               void
7043 #  define pMY_CXT_
7044 #  define _pMY_CXT
7045 #  define aMY_CXT
7046 #  define aMY_CXT_
7047 #  define _aMY_CXT
7048
7049 #endif /* !defined(PERL_IMPLICIT_CONTEXT) */
7050
7051 #ifdef I_FCNTL
7052 #  include <fcntl.h>
7053 #endif
7054
7055 #ifdef __Lynx__
7056 #  include <fcntl.h>
7057 #endif
7058
7059 #ifdef __amigaos4__
7060 #  undef FD_CLOEXEC /* a lie in AmigaOS */
7061 #endif
7062
7063 #ifdef I_SYS_FILE
7064 #  include <sys/file.h>
7065 #endif
7066
7067 #if defined(HAS_FLOCK) && !defined(HAS_FLOCK_PROTO)
7068 int flock(int fd, int op);
7069 #endif
7070
7071 #ifndef O_RDONLY
7072 /* Assume UNIX defaults */
7073 #    define O_RDONLY    0000
7074 #    define O_WRONLY    0001
7075 #    define O_RDWR      0002
7076 #    define O_CREAT     0100
7077 #endif
7078
7079 #ifndef O_BINARY
7080 #  define O_BINARY 0
7081 #endif
7082
7083 #ifndef O_TEXT
7084 #  define O_TEXT 0
7085 #endif
7086
7087 #if O_TEXT != O_BINARY
7088     /* If you have different O_TEXT and O_BINARY and you are a CRLF shop,
7089      * that is, you are somehow DOSish. */
7090 #   if defined(__HAIKU__) || defined(__VOS__) || defined(__CYGWIN__)
7091     /* Haiku has O_TEXT != O_BINARY but O_TEXT and O_BINARY have no effect;
7092      * Haiku is always UNIXoid (LF), not DOSish (CRLF). */
7093     /* VOS has O_TEXT != O_BINARY, and they have effect,
7094      * but VOS always uses LF, never CRLF. */
7095     /* If you have O_TEXT different from your O_BINARY but you still are
7096      * not a CRLF shop. */
7097 #       undef PERLIO_USING_CRLF
7098 #   else
7099     /* If you really are DOSish. */
7100 #      define PERLIO_USING_CRLF 1
7101 #   endif
7102 #endif
7103
7104 #ifdef I_LIBUTIL
7105 #   include <libutil.h>         /* setproctitle() in some FreeBSDs */
7106 #endif
7107
7108 #ifndef EXEC_ARGV_CAST
7109 #define EXEC_ARGV_CAST(x) (char **)x
7110 #endif
7111
7112 #define IS_NUMBER_IN_UV               0x01 /* number within UV range (maybe not
7113                                               int).  value returned in pointed-
7114                                               to UV */
7115 #define IS_NUMBER_GREATER_THAN_UV_MAX 0x02 /* pointed to UV undefined */
7116 #define IS_NUMBER_NOT_INT             0x04 /* saw . or E notation or infnan */
7117 #define IS_NUMBER_NEG                 0x08 /* leading minus sign */
7118 #define IS_NUMBER_INFINITY            0x10 /* this is big */
7119 #define IS_NUMBER_NAN                 0x20 /* this is not */
7120 #define IS_NUMBER_TRAILING            0x40 /* number has trailing trash */
7121
7122 /*
7123 =head1 Numeric functions
7124
7125 =for apidoc AmdR|bool|GROK_NUMERIC_RADIX|NN const char **sp|NN const char *send
7126
7127 A synonym for L</grok_numeric_radix>
7128
7129 =cut
7130 */
7131 #define GROK_NUMERIC_RADIX(sp, send) grok_numeric_radix(sp, send)
7132
7133 /* Input flags: */
7134 #define PERL_SCAN_ALLOW_UNDERSCORES   0x01 /* grok_??? accept _ in numbers */
7135 #define PERL_SCAN_DISALLOW_PREFIX     0x02 /* grok_??? reject 0x in hex etc */
7136 #define PERL_SCAN_SILENT_ILLDIGIT     0x04 /* grok_??? not warn about illegal digits */
7137 #define PERL_SCAN_SILENT_NON_PORTABLE 0x08 /* grok_??? not warn about very large
7138                                               numbers which are <= UV_MAX */
7139 #define PERL_SCAN_TRAILING            0x10 /* grok_number_flags() allow trailing
7140                                               and set IS_NUMBER_TRAILING */
7141
7142 /* Output flags: */
7143 #define PERL_SCAN_GREATER_THAN_UV_MAX 0x02 /* should this merge with above? */
7144
7145 /* to let user control profiling */
7146 #ifdef PERL_GPROF_CONTROL
7147 extern void moncontrol(int);
7148 #define PERL_GPROF_MONCONTROL(x) moncontrol(x)
7149 #else
7150 #define PERL_GPROF_MONCONTROL(x)
7151 #endif
7152
7153 /* ISO 6429 NEL - C1 control NExt Line */
7154 /* See https://www.unicode.org/unicode/reports/tr13/ */
7155 #define NEXT_LINE_CHAR  NEXT_LINE_NATIVE
7156
7157 #ifndef PIPESOCK_MODE
7158 #  define PIPESOCK_MODE
7159 #endif
7160
7161 #ifndef SOCKET_OPEN_MODE
7162 #  define SOCKET_OPEN_MODE      PIPESOCK_MODE
7163 #endif
7164
7165 #ifndef PIPE_OPEN_MODE
7166 #  define PIPE_OPEN_MODE        PIPESOCK_MODE
7167 #endif
7168
7169 #define PERL_MAGIC_UTF8_CACHESIZE       2
7170
7171 #define PERL_UNICODE_STDIN_FLAG                 0x0001
7172 #define PERL_UNICODE_STDOUT_FLAG                0x0002
7173 #define PERL_UNICODE_STDERR_FLAG                0x0004
7174 #define PERL_UNICODE_IN_FLAG                    0x0008
7175 #define PERL_UNICODE_OUT_FLAG                   0x0010
7176 #define PERL_UNICODE_ARGV_FLAG                  0x0020
7177 #define PERL_UNICODE_LOCALE_FLAG                0x0040
7178 #define PERL_UNICODE_WIDESYSCALLS_FLAG          0x0080 /* for Sarathy */
7179 #define PERL_UNICODE_UTF8CACHEASSERT_FLAG       0x0100
7180
7181 #define PERL_UNICODE_STD_FLAG           \
7182         (PERL_UNICODE_STDIN_FLAG        | \
7183          PERL_UNICODE_STDOUT_FLAG       | \
7184          PERL_UNICODE_STDERR_FLAG)
7185
7186 #define PERL_UNICODE_INOUT_FLAG         \
7187         (PERL_UNICODE_IN_FLAG   | \
7188          PERL_UNICODE_OUT_FLAG)
7189
7190 #define PERL_UNICODE_DEFAULT_FLAGS      \
7191         (PERL_UNICODE_STD_FLAG          | \
7192          PERL_UNICODE_INOUT_FLAG        | \
7193          PERL_UNICODE_LOCALE_FLAG)
7194
7195 #define PERL_UNICODE_ALL_FLAGS                  0x01ff
7196
7197 #define PERL_UNICODE_STDIN                      'I'
7198 #define PERL_UNICODE_STDOUT                     'O'
7199 #define PERL_UNICODE_STDERR                     'E'
7200 #define PERL_UNICODE_STD                        'S'
7201 #define PERL_UNICODE_IN                         'i'
7202 #define PERL_UNICODE_OUT                        'o'
7203 #define PERL_UNICODE_INOUT                      'D'
7204 #define PERL_UNICODE_ARGV                       'A'
7205 #define PERL_UNICODE_LOCALE                     'L'
7206 #define PERL_UNICODE_WIDESYSCALLS               'W'
7207 #define PERL_UNICODE_UTF8CACHEASSERT            'a'
7208
7209 #define PERL_SIGNALS_UNSAFE_FLAG        0x0001
7210
7211 /*
7212 =head1 Numeric functions
7213
7214 =for apidoc Am|int|PERL_ABS|int
7215
7216 Typeless C<abs> or C<fabs>, I<etc>.  (The usage below indicates it is for
7217 integers, but it works for any type.)  Use instead of these, since the C
7218 library ones force their argument to be what it is expecting, potentially
7219 leading to disaster.  But also beware that this evaluates its argument twice,
7220 so no C<x++>.
7221
7222 =cut
7223 */
7224
7225 #define PERL_ABS(x) ((x) < 0 ? -(x) : (x))
7226
7227 #if defined(__DECC) && defined(__osf__)
7228 #pragma message disable (mainparm) /* Perl uses the envp in main(). */
7229 #endif
7230
7231 #define do_open(g, n, l, a, rm, rp, sf) \
7232         do_openn(g, n, l, a, rm, rp, sf, (SV **) NULL, 0)
7233 #ifdef PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
7234 #  define do_exec(cmd)                  do_exec3(cmd,0,0)
7235 #endif
7236 #ifdef OS2
7237 #  define do_aexec                      Perl_do_aexec
7238 #else
7239 #  define do_aexec(really, mark,sp)     do_aexec5(really, mark, sp, 0, 0)
7240 #endif
7241
7242
7243 /*
7244 =head1 Miscellaneous Functions
7245
7246 =for apidoc Am|bool|IS_SAFE_SYSCALL|NN const char *pv|STRLEN len|NN const char *what|NN const char *op_name
7247
7248 Same as L</is_safe_syscall>.
7249
7250 =cut
7251
7252 Allows one ending \0
7253 */
7254 #define IS_SAFE_SYSCALL(p, len, what, op_name) (Perl_is_safe_syscall(aTHX_ (p), (len), (what), (op_name)))
7255
7256 #define IS_SAFE_PATHNAME(p, len, op_name) IS_SAFE_SYSCALL((p), (len), "pathname", (op_name))
7257
7258 #if defined(OEMVS) || defined(__amigaos4__)
7259 #define NO_ENV_ARRAY_IN_MAIN
7260 #endif
7261
7262 /* These are used by Perl_pv_escape() and Perl_pv_pretty()
7263  * are here so that they are available throughout the core
7264  * NOTE that even though some are for _escape and some for _pretty
7265  * there must not be any clashes as the flags from _pretty are
7266  * passed straight through to _escape.
7267  */
7268
7269 #define PERL_PV_ESCAPE_QUOTE        0x000001
7270 #define PERL_PV_PRETTY_QUOTE        PERL_PV_ESCAPE_QUOTE
7271
7272 #define PERL_PV_PRETTY_ELLIPSES     0x000002
7273 #define PERL_PV_PRETTY_LTGT         0x000004
7274 #define PERL_PV_PRETTY_EXACTSIZE    0x000008
7275
7276 #define PERL_PV_ESCAPE_UNI          0x000100
7277 #define PERL_PV_ESCAPE_UNI_DETECT   0x000200
7278 #define PERL_PV_ESCAPE_NONASCII     0x000400
7279 #define PERL_PV_ESCAPE_FIRSTCHAR    0x000800
7280
7281 #define PERL_PV_ESCAPE_ALL            0x001000
7282 #define PERL_PV_ESCAPE_NOBACKSLASH  0x002000
7283 #define PERL_PV_ESCAPE_NOCLEAR      0x004000
7284 #define PERL_PV_PRETTY_NOCLEAR      PERL_PV_ESCAPE_NOCLEAR
7285 #define PERL_PV_ESCAPE_RE           0x008000
7286
7287 #define PERL_PV_ESCAPE_DWIM         0x010000
7288
7289
7290 /* used by pv_display in dump.c*/
7291 #define PERL_PV_PRETTY_DUMP  PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE
7292 #define PERL_PV_PRETTY_REGPROP PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_LTGT|PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII
7293
7294 #if DOUBLEKIND == DOUBLE_IS_VAX_F_FLOAT || \
7295     DOUBLEKIND == DOUBLE_IS_VAX_D_FLOAT || \
7296     DOUBLEKIND == DOUBLE_IS_VAX_G_FLOAT
7297 #  define DOUBLE_IS_VAX_FLOAT
7298 #else
7299 #  define DOUBLE_IS_IEEE_FORMAT
7300 #endif
7301
7302 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN || \
7303     DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN || \
7304     DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
7305 #  define DOUBLE_LITTLE_ENDIAN
7306 #endif
7307
7308 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN || \
7309     DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN || \
7310     DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
7311 #  define DOUBLE_BIG_ENDIAN
7312 #endif
7313
7314 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE || \
7315     DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
7316 #  define DOUBLE_MIX_ENDIAN
7317 #endif
7318
7319 /* The VAX fp formats are neither consistently little-endian nor
7320  * big-endian, and neither are they really IEEE-mixed endian like
7321  * the mixed-endian ARM IEEE formats (with swapped bytes).
7322  * Ultimately, the VAX format came from the PDP-11.
7323  *
7324  * The ordering of the parts in VAX floats is quite vexing.
7325  * In the below the fraction_n are the mantissa bits.
7326  *
7327  * The fraction_1 is the most significant (numbering as by DEC/Digital),
7328  * while the rightmost bit in each fraction is the least significant:
7329  * in other words, big-endian bit order within the fractions.
7330  *
7331  * The fraction segments themselves would be big-endianly, except that
7332  * within 32 bit segments the less significant half comes first, the more
7333  * significant after, except that in the format H (used for long doubles)
7334  * the first fraction segment is alone, because the exponent is wider.
7335  * This means for example that both the most and the least significant
7336  * bits can be in the middle of the floats, not at either end.
7337  *
7338  * References:
7339  * http://nssdc.gsfc.nasa.gov/nssdc/formats/VAXFloatingPoint.htm
7340  * http://www.quadibloc.com/comp/cp0201.htm
7341  * http://h71000.www7.hp.com/doc/82final/6443/6443pro_028.html
7342  * (somebody at HP should be fired for the URLs)
7343  *
7344  * F   fraction_2:16 sign:1 exp:8  fraction_1:7
7345  *     (exponent bias 128, hidden first one-bit)
7346  *
7347  * D   fraction_2:16 sign:1 exp:8  fraction_1:7
7348  *     fraction_4:16               fraction_3:16
7349  *     (exponent bias 128, hidden first one-bit)
7350  *
7351  * G   fraction_2:16 sign:1 exp:11 fraction_1:4
7352  *     fraction_4:16               fraction_3:16
7353  *     (exponent bias 1024, hidden first one-bit)
7354  *
7355  * H   fraction_1:16 sign:1 exp:15
7356  *     fraction_3:16               fraction_2:16
7357  *     fraction_5:16               fraction_4:16
7358  *     fraction_7:16               fraction_6:16
7359  *     (exponent bias 16384, hidden first one-bit)
7360  *     (available only on VAX, and only on Fortran?)
7361  *
7362  * The formats S, T and X are available on the Alpha (and Itanium,
7363  * also known as I64/IA64) and are equivalent with the IEEE-754 formats
7364  * binary32, binary64, and binary128 (commonly: float, double, long double).
7365  *
7366  * S   sign:1 exp:8 mantissa:23
7367  *     (exponent bias 127, hidden first one-bit)
7368  *
7369  * T   sign:1 exp:11 mantissa:52
7370  *     (exponent bias 1022, hidden first one-bit)
7371  *
7372  * X   sign:1 exp:15 mantissa:112
7373  *     (exponent bias 16382, hidden first one-bit)
7374  *
7375  */
7376
7377 #ifdef DOUBLE_IS_VAX_FLOAT
7378 #  define DOUBLE_VAX_ENDIAN
7379 #endif
7380
7381 #ifdef DOUBLE_IS_IEEE_FORMAT
7382 /* All the basic IEEE formats have the implicit bit,
7383  * except for the x86 80-bit extended formats, which will undef this.
7384  * Also note that the IEEE 754 subnormals (formerly known as denormals)
7385  * do not have the implicit bit of one. */
7386 #  define NV_IMPLICIT_BIT
7387 #endif
7388
7389 #if defined(LONG_DOUBLEKIND) && LONG_DOUBLEKIND != LONG_DOUBLE_IS_DOUBLE
7390
7391 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN || \
7392       LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
7393       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
7394 #    define LONGDOUBLE_LITTLE_ENDIAN
7395 #  endif
7396
7397 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN || \
7398       LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN || \
7399       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
7400 #    define LONGDOUBLE_BIG_ENDIAN
7401 #  endif
7402
7403 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
7404       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
7405 #    define LONGDOUBLE_MIX_ENDIAN
7406 #  endif
7407
7408 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
7409       LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
7410 #    define LONGDOUBLE_X86_80_BIT
7411 #    ifdef USE_LONG_DOUBLE
7412 #      undef NV_IMPLICIT_BIT
7413 #      define NV_X86_80_BIT
7414 #    endif
7415 #  endif
7416
7417 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE || \
7418       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE || \
7419       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
7420       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
7421 #    define LONGDOUBLE_DOUBLEDOUBLE
7422 #  endif
7423
7424 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_VAX_H_FLOAT
7425 #    define LONGDOUBLE_VAX_ENDIAN
7426 #  endif
7427
7428 #endif /* LONG_DOUBLEKIND */
7429
7430 #ifdef USE_QUADMATH /* assume quadmath endianness == native double endianness */
7431 #  if defined(DOUBLE_LITTLE_ENDIAN)
7432 #    define NV_LITTLE_ENDIAN
7433 #  elif defined(DOUBLE_BIG_ENDIAN)
7434 #    define NV_BIG_ENDIAN
7435 #  elif defined(DOUBLE_MIX_ENDIAN) /* stretch */
7436 #    define NV_MIX_ENDIAN
7437 #  endif
7438 #elif NVSIZE == DOUBLESIZE
7439 #  ifdef DOUBLE_LITTLE_ENDIAN
7440 #    define NV_LITTLE_ENDIAN
7441 #  endif
7442 #  ifdef DOUBLE_BIG_ENDIAN
7443 #    define NV_BIG_ENDIAN
7444 #  endif
7445 #  ifdef DOUBLE_MIX_ENDIAN
7446 #    define NV_MIX_ENDIAN
7447 #  endif
7448 #  ifdef DOUBLE_VAX_ENDIAN
7449 #    define NV_VAX_ENDIAN
7450 #  endif
7451 #elif NVSIZE == LONG_DOUBLESIZE
7452 #  ifdef LONGDOUBLE_LITTLE_ENDIAN
7453 #    define NV_LITTLE_ENDIAN
7454 #  endif
7455 #  ifdef LONGDOUBLE_BIG_ENDIAN
7456 #    define NV_BIG_ENDIAN
7457 #  endif
7458 #  ifdef LONGDOUBLE_MIX_ENDIAN
7459 #    define NV_MIX_ENDIAN
7460 #  endif
7461 #  ifdef LONGDOUBLE_VAX_ENDIAN
7462 #    define NV_VAX_ENDIAN
7463 #  endif
7464 #endif
7465
7466 /* We have somehow managed not to define the denormal/subnormal
7467  * detection.
7468  *
7469  * This may happen if the compiler doesn't expose the C99 math like
7470  * the fpclassify() without some special switches.  Perl tries to
7471  * stay C89, so for example -std=c99 is not an option.
7472  *
7473  * The Perl_isinf() and Perl_isnan() should have been defined even if
7474  * the C99 isinf() and isnan() are unavailable, and the NV_MIN becomes
7475  * from the C89 DBL_MIN or moral equivalent. */
7476 #if !defined(Perl_fp_class_denorm) && defined(Perl_isinf) && defined(Perl_isnan) && defined(NV_MIN)
7477 #  define Perl_fp_class_denorm(x) ((x) != 0.0 && !Perl_isinf(x) && !Perl_isnan(x) && PERL_ABS(x) < NV_MIN)
7478 #endif
7479
7480 /* This is not a great fallback: subnormals tests will fail,
7481  * but at least Perl will link and 99.999% of tests will work. */
7482 #if !defined(Perl_fp_class_denorm)
7483 #  define Perl_fp_class_denorm(x) FALSE
7484 #endif
7485
7486 #ifdef DOUBLE_IS_IEEE_FORMAT
7487 #  define DOUBLE_HAS_INF
7488 #  define DOUBLE_HAS_NAN
7489 #endif
7490
7491 #ifdef DOUBLE_HAS_NAN
7492
7493 START_EXTERN_C
7494
7495 #ifdef DOINIT
7496
7497 /* PL_inf and PL_nan initialization.
7498  *
7499  * For inf and nan initialization the ultimate fallback is dividing
7500  * one or zero by zero: however, some compilers will warn or even fail
7501  * on divide-by-zero, but hopefully something earlier will work.
7502  *
7503  * If you are thinking of using HUGE_VAL for infinity, or using
7504  * <math.h> functions to generate NV_INF (e.g. exp(1e9), log(-1.0)),
7505  * stop.  Neither will work portably: HUGE_VAL can be just DBL_MAX,
7506  * and the math functions might be just generating DBL_MAX, or even zero.
7507  *
7508  * Also, do NOT try doing NV_NAN based on NV_INF and trying (NV_INF-NV_INF).
7509  * Though logically correct, some compilers (like Visual C 2003)
7510  * falsely misoptimize that to zero (x-x is always zero, right?)
7511  *
7512  * Finally, note that not all floating point formats define Inf (or NaN).
7513  * For the infinity a large number may be used instead.  Operations that
7514  * under the IEEE floating point would return Inf or NaN may return
7515  * either large numbers (positive or negative), or they may cause
7516  * a floating point exception or some other fault.
7517  */
7518
7519 /* The quadmath literals are anon structs which -Wc++-compat doesn't like. */
7520 GCC_DIAG_IGNORE_DECL(-Wpragmas);
7521 GCC_DIAG_IGNORE_DECL(-Wc++-compat);
7522
7523 #  ifdef USE_QUADMATH
7524 /* Cannot use HUGE_VALQ for PL_inf because not a compile-time
7525  * constant. */
7526 INFNAN_NV_U8_DECL PL_inf = { 1.0Q/0.0Q };
7527 #  elif NVSIZE == LONG_DOUBLESIZE && defined(LONGDBLINFBYTES)
7528 INFNAN_U8_NV_DECL PL_inf = { { LONGDBLINFBYTES } };
7529 #  elif NVSIZE == DOUBLESIZE && defined(DOUBLEINFBYTES)
7530 INFNAN_U8_NV_DECL PL_inf = { { DOUBLEINFBYTES } };
7531 #  else
7532 #    if NVSIZE == LONG_DOUBLESIZE && defined(USE_LONG_DOUBLE)
7533 #      if defined(LDBL_INFINITY)
7534 INFNAN_NV_U8_DECL PL_inf = { LDBL_INFINITY };
7535 #      elif defined(LDBL_INF)
7536 INFNAN_NV_U8_DECL PL_inf = { LDBL_INF };
7537 #      elif defined(INFINITY)
7538 INFNAN_NV_U8_DECL PL_inf = { (NV)INFINITY };
7539 #      elif defined(INF)
7540 INFNAN_NV_U8_DECL PL_inf = { (NV)INF };
7541 #      else
7542 INFNAN_NV_U8_DECL PL_inf = { 1.0L/0.0L }; /* keep last */
7543 #      endif
7544 #    else
7545 #      if defined(DBL_INFINITY)
7546 INFNAN_NV_U8_DECL PL_inf = { DBL_INFINITY };
7547 #      elif defined(DBL_INF)
7548 INFNAN_NV_U8_DECL PL_inf = { DBL_INF };
7549 #      elif defined(INFINITY) /* C99 */
7550 INFNAN_NV_U8_DECL PL_inf = { (NV)INFINITY };
7551 #      elif defined(INF)
7552 INFNAN_NV_U8_DECL PL_inf = { (NV)INF };
7553 #      else
7554 INFNAN_NV_U8_DECL PL_inf = { 1.0/0.0 }; /* keep last */
7555 #      endif
7556 #    endif
7557 #  endif
7558
7559 #  ifdef USE_QUADMATH
7560 /* Cannot use nanq("0") for PL_nan because not a compile-time
7561  * constant. */
7562 INFNAN_NV_U8_DECL PL_nan = { 0.0Q/0.0Q };
7563 #  elif NVSIZE == LONG_DOUBLESIZE && defined(LONGDBLNANBYTES)
7564 INFNAN_U8_NV_DECL PL_nan = { { LONGDBLNANBYTES } };
7565 #  elif NVSIZE == DOUBLESIZE && defined(DOUBLENANBYTES)
7566 INFNAN_U8_NV_DECL PL_nan = { { DOUBLENANBYTES } };
7567 #  else
7568 #    if NVSIZE == LONG_DOUBLESIZE && defined(USE_LONG_DOUBLE)
7569 #      if defined(LDBL_NAN)
7570 INFNAN_NV_U8_DECL PL_nan = { LDBL_NAN };
7571 #      elif defined(LDBL_QNAN)
7572 INFNAN_NV_U8_DECL PL_nan = { LDBL_QNAN };
7573 #      elif defined(NAN)
7574 INFNAN_NV_U8_DECL PL_nan = { (NV)NAN };
7575 #      else
7576 INFNAN_NV_U8_DECL PL_nan = { 0.0L/0.0L }; /* keep last */
7577 #      endif
7578 #    else
7579 #      if defined(DBL_NAN)
7580 INFNAN_NV_U8_DECL PL_nan = { DBL_NAN };
7581 #      elif defined(DBL_QNAN)
7582 INFNAN_NV_U8_DECL PL_nan = { DBL_QNAN };
7583 #      elif defined(NAN) /* C99 */
7584 INFNAN_NV_U8_DECL PL_nan = { (NV)NAN };
7585 #      else
7586 INFNAN_NV_U8_DECL PL_nan = { 0.0/0.0 }; /* keep last */
7587 #      endif
7588 #    endif
7589 #  endif
7590
7591 GCC_DIAG_RESTORE_DECL;
7592 GCC_DIAG_RESTORE_DECL;
7593
7594 #else
7595
7596 INFNAN_NV_U8_DECL PL_inf;
7597 INFNAN_NV_U8_DECL PL_nan;
7598
7599 #endif
7600
7601 END_EXTERN_C
7602
7603 /* If you have not defined NV_INF/NV_NAN (like for example win32/win32.h),
7604  * we will define NV_INF/NV_NAN as the nv part of the global const
7605  * PL_inf/PL_nan.  Note, however, that the preexisting NV_INF/NV_NAN
7606  * might not be a compile-time constant, in which case it cannot be
7607  * used to initialize PL_inf/PL_nan above. */
7608 #ifndef NV_INF
7609 #  define NV_INF PL_inf.nv
7610 #endif
7611 #ifndef NV_NAN
7612 #  define NV_NAN PL_nan.nv
7613 #endif
7614
7615 /* NaNs (not-a-numbers) can carry payload bits, in addition to
7616  * "nan-ness".  Part of the payload is the quiet/signaling bit.
7617  * To back up a bit (harhar):
7618  *
7619  * For IEEE 754 64-bit formats [1]:
7620  *
7621  * s 000 (mantissa all-zero)  zero
7622  * s 000 (mantissa non-zero)  subnormals (denormals)
7623  * s 001 ... 7fe              normals
7624  * s 7ff q                    nan
7625  *
7626  * For IEEE 754 128-bit formats:
7627  *
7628  * s 0000 (mantissa all-zero)  zero
7629  * s 0000 (mantissa non-zero)  subnormals (denormals)
7630  * s 0001 ... 7ffe             normals
7631  * s 7fff q                    nan
7632  *
7633  * [1] this looks like big-endian, but applies equally to little-endian.
7634  *
7635  * s = Sign bit.  Yes, zeros and nans can have negative sign,
7636  *     the interpretation is application-specific.
7637  *
7638  * q = Quietness bit, the interpretation is platform-specific.
7639  *     Most platforms have the most significant bit being one
7640  *     meaning quiet, but some (older mips, hppa) have the msb
7641  *     being one meaning signaling.  Note that the above means
7642  *     that on most platforms there cannot be signaling nan with
7643  *     zero payload because that is identical with infinity;
7644  *     while conversely on older mips/hppa there cannot be a quiet nan
7645  *     because that is identical with infinity.
7646  *
7647  *     Moreover, whether there is any behavioral difference
7648  *     between quiet and signaling NaNs, depends on the platform.
7649  *
7650  * x86 80-bit extended precision is different, the mantissa bits:
7651  *
7652  * 63 62 61   30387+    pre-387    visual c
7653  * --------   ----      --------   --------
7654  *  0  0  0   invalid   infinity
7655  *  0  0  1   invalid   snan
7656  *  0  1  0   invalid   snan
7657  *  0  1  1   invalid   snan
7658  *  1  0  0   infinity  snan        1.#INF
7659  *  1  0  1   snan                  1.#SNAN
7660  *  1  1  0   qnan                 -1.#IND  (x86 chooses this to negative)
7661  *  1  1  1   qnan                  1.#QNAN
7662  *
7663  * This means that in this format there are 61 bits available
7664  * for the nan payload.
7665  *
7666  * Note that the 32-bit x86 ABI cannot do signaling nans: the x87
7667  * simply cannot preserve the bit.  You can either use the 80-bit
7668  * extended precision (long double, -Duselongdouble), or use x86-64.
7669  *
7670  * In all platforms, the payload bytes (and bits, some of them are
7671  * often in a partial byte) themselves can be either all zero (x86),
7672  * all one (sparc or mips), or a mixture: in IEEE 754 128-bit double
7673  * or in a double-double, the first half of the payload can follow the
7674  * native double, while in the second half the payload can be all
7675  * zeros.  (Therefore the mask for payload bits is not necessarily
7676  * identical to bit complement of the NaN.)  Another way of putting
7677  * this: the payload for the default NaN might not be zero.
7678  *
7679  * For the x86 80-bit long doubles, the trailing bytes (the 80 bits
7680  * being 'packaged' in either 12 or 16 bytes) can be whatever random
7681  * garbage.
7682  *
7683  * Furthermore, the semantics of the sign bit on NaNs are platform-specific.
7684  * On normal floats, the sign bit being on means negative.  But this may,
7685  * or may not, be reverted on NaNs: in other words, the default NaN might
7686  * have the sign bit on, and therefore look like negative if you look
7687  * at it at the bit level.
7688  *
7689  * NaN payloads are not propagated even on copies, or in arithmetics.
7690  * They *might* be, according to some rules, on your particular
7691  * cpu/os/compiler/libraries, but no guarantees.
7692  *
7693  * To summarize, on most platforms, and for 64-bit doubles
7694  * (using big-endian ordering here):
7695  *
7696  * [7FF8000000000000..7FFFFFFFFFFFFFFF] quiet
7697  * [FFF8000000000000..FFFFFFFFFFFFFFFF] quiet
7698  * [7FF0000000000001..7FF7FFFFFFFFFFFF] signaling
7699  * [FFF0000000000001..FFF7FFFFFFFFFFFF] signaling
7700  *
7701  * The C99 nan() is supposed to generate *quiet* NaNs.
7702  *
7703  * Note the asymmetry:
7704  * The 7FF0000000000000 is positive infinity,
7705  * the FFF0000000000000 is negative infinity.
7706  */
7707
7708 /* NVMANTBITS is the number of _real_ mantissa bits in an NV.
7709  * For the standard IEEE 754 fp this number is usually one less that
7710  * *DBL_MANT_DIG because of the implicit (aka hidden) bit, which isn't
7711  * real.  For the 80-bit extended precision formats (x86*), the number
7712  * of mantissa bits... depends. For normal floats, it's 64.  But for
7713  * the inf/nan, it's different (zero for inf, 61 for nan).
7714  * NVMANTBITS works for normal floats. */
7715
7716 /* We do not want to include the quiet/signaling bit. */
7717 #define NV_NAN_BITS (NVMANTBITS - 1)
7718
7719 #if defined(USE_LONG_DOUBLE) && NVSIZE > DOUBLESIZE
7720 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
7721 #    define NV_NAN_QS_BYTE_OFFSET 13
7722 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
7723 #    define NV_NAN_QS_BYTE_OFFSET 2
7724 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN
7725 #    define NV_NAN_QS_BYTE_OFFSET 7
7726 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
7727 #    define NV_NAN_QS_BYTE_OFFSET 2
7728 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
7729 #    define NV_NAN_QS_BYTE_OFFSET 13
7730 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
7731 #    define NV_NAN_QS_BYTE_OFFSET 1
7732 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE
7733 #    define NV_NAN_QS_BYTE_OFFSET 9
7734 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
7735 #    define NV_NAN_QS_BYTE_OFFSET 6
7736 #  else
7737 #    error "Unexpected long double format"
7738 #  endif
7739 #else
7740 #  ifdef USE_QUADMATH
7741 #    ifdef NV_LITTLE_ENDIAN
7742 #      define NV_NAN_QS_BYTE_OFFSET 13
7743 #    elif defined(NV_BIG_ENDIAN)
7744 #      define NV_NAN_QS_BYTE_OFFSET 2
7745 #    else
7746 #      error "Unexpected quadmath format"
7747 #    endif
7748 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN
7749 #    define NV_NAN_QS_BYTE_OFFSET 2
7750 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN
7751 #    define NV_NAN_QS_BYTE_OFFSET 1
7752 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN
7753 #    define NV_NAN_QS_BYTE_OFFSET 6
7754 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN
7755 #    define NV_NAN_QS_BYTE_OFFSET 1
7756 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
7757 #    define NV_NAN_QS_BYTE_OFFSET 13
7758 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
7759 #    define NV_NAN_QS_BYTE_OFFSET 2
7760 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE
7761 #    define NV_NAN_QS_BYTE_OFFSET 2 /* bytes 4 5 6 7 0 1 2 3 (MSB 7) */
7762 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
7763 #    define NV_NAN_QS_BYTE_OFFSET 5 /* bytes 3 2 1 0 7 6 5 4 (MSB 7) */
7764 #  else
7765 /* For example the VAX formats should never
7766  * get here because they do not have NaN. */
7767 #    error "Unexpected double format"
7768 #  endif
7769 #endif
7770 /* NV_NAN_QS_BYTE is the byte to test for the quiet/signaling */
7771 #define NV_NAN_QS_BYTE(nvp) (((U8*)(nvp))[NV_NAN_QS_BYTE_OFFSET])
7772 /* NV_NAN_QS_BIT is the bit to test in the NV_NAN_QS_BYTE_OFFSET
7773  * for the quiet/signaling */
7774 #if defined(USE_LONG_DOUBLE) && \
7775   (LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
7776    LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN)
7777 #  define NV_NAN_QS_BIT_SHIFT 6 /* 0x40 */
7778 #elif defined(USE_LONG_DOUBLE) && \
7779   (LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE || \
7780    LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE || \
7781    LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
7782    LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE)
7783 #  define NV_NAN_QS_BIT_SHIFT 3 /* 0x08, but not via NV_NAN_BITS */
7784 #else
7785 #  define NV_NAN_QS_BIT_SHIFT ((NV_NAN_BITS) % 8) /* usually 3, or 0x08 */
7786 #endif
7787 #define NV_NAN_QS_BIT (1 << (NV_NAN_QS_BIT_SHIFT))
7788 /* NV_NAN_QS_BIT_OFFSET is the bit offset from the beginning of a NV
7789  * (bytes ordered big-endianly) for the quiet/signaling bit
7790  * for the quiet/signaling */
7791 #define NV_NAN_QS_BIT_OFFSET \
7792     (8 * (NV_NAN_QS_BYTE_OFFSET) + (NV_NAN_QS_BIT_SHIFT))
7793 /* NV_NAN_QS_QUIET (always defined) is true if the NV_NAN_QS_QS_BIT being
7794  * on indicates quiet NaN.  NV_NAN_QS_SIGNALING (also always defined)
7795  * is true if the NV_NAN_QS_BIT being on indicates signaling NaN. */
7796 #define NV_NAN_QS_QUIET \
7797     ((NV_NAN_QS_BYTE(PL_nan.u8) & NV_NAN_QS_BIT) == NV_NAN_QS_BIT)
7798 #define NV_NAN_QS_SIGNALING (!(NV_NAN_QS_QUIET))
7799 #define NV_NAN_QS_TEST(nvp) (NV_NAN_QS_BYTE(nvp) & NV_NAN_QS_BIT)
7800 /* NV_NAN_IS_QUIET() returns true if the NV behind nvp is a NaN,
7801  * whether it is a quiet NaN, NV_NAN_IS_SIGNALING() if a signaling NaN.
7802  * Note however that these do not check whether the nvp is a NaN. */
7803 #define NV_NAN_IS_QUIET(nvp) \
7804     (NV_NAN_QS_TEST(nvp) == (NV_NAN_QS_QUIET ? NV_NAN_QS_BIT : 0))
7805 #define NV_NAN_IS_SIGNALING(nvp) \
7806     (NV_NAN_QS_TEST(nvp) == (NV_NAN_QS_QUIET ? 0 : NV_NAN_QS_BIT))
7807 #define NV_NAN_SET_QUIET(nvp) \
7808     (NV_NAN_QS_QUIET ? \
7809      (NV_NAN_QS_BYTE(nvp) |= NV_NAN_QS_BIT) : \
7810      (NV_NAN_QS_BYTE(nvp) &= ~NV_NAN_QS_BIT))
7811 #define NV_NAN_SET_SIGNALING(nvp) \
7812     (NV_NAN_QS_QUIET ? \
7813      (NV_NAN_QS_BYTE(nvp) &= ~NV_NAN_QS_BIT) : \
7814      (NV_NAN_QS_BYTE(nvp) |= NV_NAN_QS_BIT))
7815 #define NV_NAN_QS_XOR(nvp) (NV_NAN_QS_BYTE(nvp) ^= NV_NAN_QS_BIT)
7816
7817 /* NV_NAN_PAYLOAD_MASK: masking the nan payload bits.
7818  *
7819  * NV_NAN_PAYLOAD_PERM: permuting the nan payload bytes.
7820  * 0xFF means "don't go here".*/
7821
7822 /* Shorthands to avoid typoses. */
7823 #define NV_NAN_PAYLOAD_MASK_SKIP_EIGHT \
7824   0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0
7825 #define NV_NAN_PAYLOAD_PERM_SKIP_EIGHT \
7826   0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
7827 #define NV_NAN_PAYLOAD_PERM_0_TO_7 \
7828   0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7
7829 #define NV_NAN_PAYLOAD_PERM_7_TO_0 \
7830   0x7, 0x6, 0x5, 0x4, 0x3, 0x2, 0x1, 0x0
7831 #define NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE \
7832   0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
7833   0xff, 0xff, 0xff, 0xff, 0xff, 0x7f, 0x00, 0x00
7834 #define NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE \
7835   NV_NAN_PAYLOAD_PERM_0_TO_7, \
7836   0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xFF, 0xFF
7837 #define NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE \
7838   0x00, 0x00, 0x7f, 0xff, 0xff, 0xff, 0xff, 0xff, \
7839   0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
7840 #define NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE \
7841   0xFF, 0xFF, 0xd, 0xc, 0xb, 0xa, 0x9, 0x8, \
7842   NV_NAN_PAYLOAD_PERM_7_TO_0
7843 #define NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE \
7844   0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x07, 0x00
7845 #define NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE \
7846   0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0xFF
7847 #define NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE \
7848   0x00, 0x07, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
7849 #define NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE \
7850   0xFF, 0x6, 0x5, 0x4, 0x3, 0x2, 0x1, 0x0
7851
7852 #if defined(USE_LONG_DOUBLE) && NVSIZE > DOUBLESIZE
7853 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
7854 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
7855 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
7856 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
7857 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
7858 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
7859 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN
7860 #    if LONG_DOUBLESIZE == 10
7861 #      define NV_NAN_PAYLOAD_MASK \
7862          0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
7863          0x00, 0x00
7864 #      define NV_NAN_PAYLOAD_PERM \
7865          NV_NAN_PAYLOAD_PERM_0_TO_7, 0xFF, 0xFF
7866 #    elif LONG_DOUBLESIZE == 12
7867 #      define NV_NAN_PAYLOAD_MASK \
7868          0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
7869          0x00, 0x00, 0x00, 0x00
7870 #      define NV_NAN_PAYLOAD_PERM \
7871          NV_NAN_PAYLOAD_PERM_0_TO_7, 0xFF, 0xFF, 0xFF, 0xFF
7872 #    elif LONG_DOUBLESIZE == 16
7873 #      define NV_NAN_PAYLOAD_MASK \
7874          0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
7875          0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
7876 #      define NV_NAN_PAYLOAD_PERM \
7877          NV_NAN_PAYLOAD_PERM_0_TO_7, \
7878          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
7879 #    else
7880 #      error "Unexpected x86 80-bit little-endian long double format"
7881 #    endif
7882 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
7883 #    if LONG_DOUBLESIZE == 10
7884 #      define NV_NAN_PAYLOAD_MASK \
7885          0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
7886          0xff, 0xff
7887 #      define NV_NAN_PAYLOAD_PERM \
7888          NV_NAN_PAYLOAD_PERM_7_TO_0, 0xFF, 0xFF
7889 #    elif LONG_DOUBLESIZE == 12
7890 #      define NV_NAN_PAYLOAD_MASK \
7891          0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
7892          0xff, 0xff, 0x00, 0x00
7893 #      define NV_NAN_PAYLOAD_PERM \
7894          NV_NAN_PAYLOAD_PERM_7_TO_0, 0xFF, 0xFF, 0xFF, 0xFF
7895 #    elif LONG_DOUBLESIZE == 16
7896 #      define NV_NAN_PAYLOAD_MASK \
7897          0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
7898          0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
7899 #      define NV_NAN_PAYLOAD_PERM \
7900          NV_NAN_PAYLOAD_PERM_7_TO_0, \
7901          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
7902 #    else
7903 #      error "Unexpected x86 80-bit big-endian long double format"
7904 #    endif
7905 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
7906 /* For double-double we assume only the first double (in LE or BE terms)
7907  * is used for NaN. */
7908 #    define NV_NAN_PAYLOAD_MASK \
7909        NV_NAN_PAYLOAD_MASK_SKIP_EIGHT, NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
7910 #    define NV_NAN_PAYLOAD_PERM \
7911        NV_NAN_PAYLOAD_PERM_SKIP_EIGHT, NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
7912 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
7913 #    define NV_NAN_PAYLOAD_MASK \
7914        NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
7915 #    define NV_NAN_PAYLOAD_PERM \
7916        NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
7917 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE
7918 #    define NV_NAN_PAYLOAD_MASK \
7919        NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
7920 #    define NV_NAN_PAYLOAD_PERM \
7921        NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
7922 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
7923 #    define NV_NAN_PAYLOAD_MASK \
7924        NV_NAN_PAYLOAD_MASK_SKIP_EIGHT, NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
7925 #    define NV_NAN_PAYLOAD_PERM \
7926        NV_NAN_PAYLOAD_PERM_SKIP_EIGHT, NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
7927 #  else
7928 #    error "Unexpected long double format"
7929 #  endif
7930 #else
7931 #  ifdef USE_QUADMATH /* quadmath is not long double */
7932 #    ifdef NV_LITTLE_ENDIAN
7933 #      define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
7934 #      define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
7935 #    elif defined(NV_BIG_ENDIAN)
7936 #      define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
7937 #      define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
7938 #    else
7939 #      error "Unexpected quadmath format"
7940 #    endif
7941 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN
7942 #    define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0x07, 0x00
7943 #    define NV_NAN_PAYLOAD_PERM 0x0, 0x1, 0x2, 0xFF
7944 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN
7945 #    define NV_NAN_PAYLOAD_MASK 0x00, 0x07, 0xff, 0xff
7946 #    define NV_NAN_PAYLOAD_PERM 0xFF, 0x2, 0x1, 0x0
7947 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN
7948 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
7949 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
7950 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN
7951 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
7952 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
7953 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
7954 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
7955 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
7956 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
7957 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
7958 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
7959 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE
7960 #    define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0x07, 0x00, 0xff, 0xff, 0xff, 0xff
7961 #    define NV_NAN_PAYLOAD_PERM 0x4, 0x5, 0x6, 0xFF, 0x0, 0x1, 0x2, 0x3
7962 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
7963 #    define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0xff, 0xff, 0x00, 0x07, 0xff, 0xff
7964 #    define NV_NAN_PAYLOAD_PERM 0x3, 0x2, 0x1, 0x0, 0xFF, 0x6, 0x5, 0x4
7965 #  else
7966 #    error "Unexpected double format"
7967 #  endif
7968 #endif
7969
7970 #endif /* DOUBLE_HAS_NAN */
7971
7972
7973 /*
7974
7975    (KEEP THIS LAST IN perl.h!)
7976
7977    Mention
7978
7979    NV_PRESERVES_UV
7980
7981    HAS_MKSTEMP
7982    HAS_MKSTEMPS
7983    HAS_MKDTEMP
7984
7985    HAS_GETCWD
7986
7987    HAS_MMAP
7988    HAS_MPROTECT
7989    HAS_MSYNC
7990    HAS_MADVISE
7991    HAS_MUNMAP
7992    I_SYSMMAN
7993    Mmap_t
7994
7995    NVef
7996    NVff
7997    NVgf
7998
7999    HAS_UALARM
8000    HAS_USLEEP
8001
8002    HAS_SETITIMER
8003    HAS_GETITIMER
8004
8005    HAS_SENDMSG
8006    HAS_RECVMSG
8007    HAS_READV
8008    HAS_WRITEV
8009    I_SYSUIO
8010    HAS_STRUCT_MSGHDR
8011    HAS_STRUCT_CMSGHDR
8012
8013    HAS_NL_LANGINFO
8014
8015    HAS_DIRFD
8016
8017    so that Configure picks them up.
8018
8019    (KEEP THIS LAST IN perl.h!)
8020
8021 */
8022
8023 #endif /* Include guard */
8024
8025 /*
8026  * ex: set ts=8 sts=4 sw=4 et:
8027  */