perl.h

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