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