perl.h

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