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