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