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 #ifdef USE_LOCALE /* These locale things are all subject to change */
 763 #  if      defined(HAS_NEWLOCALE)               \
 764       &&   defined(LC_ALL_MASK)                 \
 765       &&   defined(HAS_FREELOCALE)              \
 766       &&   defined(HAS_USELOCALE)               \
 767       && ! defined(NO_POSIX_2008_LOCALE)
 768
 769     /* For simplicity, the code is written to assume that any platform advanced
 770      * enough to have the Posix 2008 locale functions has LC_ALL.  The test
 771      * above makes sure that assumption is valid */
 772
 773 #    define HAS_POSIX_2008_LOCALE
 774 #  endif
 775 #  if     defined(USE_ITHREADS)                                             \
 776       && (    defined(HAS_POSIX_2008_LOCALE)                                \
 777           || (defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1400))     \
 778       && ! defined(NO_THREAD_SAFE_LOCALE)
 779 #    define USE_THREAD_SAFE_LOCALE
 780 #    ifdef HAS_POSIX_2008_LOCALE
 781 #      define USE_POSIX_2008_LOCALE
 782 #    endif
 783 #  endif
 784 #endif
 785
 786 /*  Microsoft documentation reads in the change log for VS 2015:
 787  *     "The localeconv function declared in locale.h now works correctly when
 788  *     per-thread locale is enabled. In previous versions of the library, this
 789  *     function would return the lconv data for the global locale, not the
 790  *     thread's locale."
 791  */
 792 #if defined(WIN32) && defined(USE_THREAD_SAFE_LOCALE) && _MSC_VER < 1900
 793 #  define TS_W32_BROKEN_LOCALECONV
 794 #endif
 795
 796 #include <setjmp.h>
 797
 798 #ifdef I_SYS_PARAM
 799 #   ifdef PARAM_NEEDS_TYPES
 800 #       include <sys/types.h>
 801 #   endif
 802 #   include <sys/param.h>
 803 #endif
 804
 805 /* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
 806    value something like 199306.  This may be useful if no more-specific
 807    feature test is available.
 808 */
 809 #if defined(BSD)
 810 #   ifndef BSDish
 811 #       define BSDish
 812 #   endif
 813 #endif
 814
 815 /* Use all the "standard" definitions */
 816 #include <stdlib.h>
 817
 818 /* If this causes problems, set i_unistd=undef in the hint file.  */
 819 #ifdef I_UNISTD
 820 #    if defined(__amigaos4__)
 821 #        ifdef I_NETINET_IN
 822 #            include <netinet/in.h>
 823 #        endif
 824 #   endif
 825 #   include <unistd.h>
 826 #   if defined(__amigaos4__)
 827 /* Under AmigaOS 4 newlib.library provides an environ.  However using
 828  * it doesn't give us enough control over inheritance of variables by
 829  * subshells etc. so replace with custom version based on abc-shell
 830  * code. */
 831 extern char **myenviron;
 832 #       undef environ
 833 #       define environ myenviron
 834 #   endif
 835 #endif
 836
 837 /* for WCOREDUMP */
 838 #ifdef I_SYS_WAIT
 839 #   include <sys/wait.h>
 840 #endif
 841
 842 #ifdef __SYMBIAN32__
 843 #   undef _SC_ARG_MAX /* Symbian has _SC_ARG_MAX but no sysconf() */
 844 #endif
 845
 846 #if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
 847 EXTERN_C int syscall(int, ...);
 848 #endif
 849
 850 #if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
 851 EXTERN_C int usleep(unsigned int);
 852 #endif
 853
 854 /* macros for correct constant construction.  These are in C99 <stdint.h>
 855  * (so they will not be available in strict C89 mode), but they are nice, so
 856  * let's define them if necessary. */
 857 #ifndef UINT16_C
 858 #  if INTSIZE >= 2
 859 #    define UINT16_C(x) ((U16_TYPE)x##U)
 860 #  else
 861 #    define UINT16_C(x) ((U16_TYPE)x##UL)
 862 #  endif
 863 #endif
 864
 865 #ifndef UINT32_C
 866 #  if INTSIZE >= 4
 867 #    define UINT32_C(x) ((U32_TYPE)x##U)
 868 #  else
 869 #    define UINT32_C(x) ((U32_TYPE)x##UL)
 870 #  endif
 871 #endif
 872
 873 #ifdef I_STDINT
 874     typedef intmax_t  PERL_INTMAX_T;
 875     typedef uintmax_t PERL_UINTMAX_T;
 876 #endif
 877
 878 /* N.B.  We use QUADKIND here instead of HAS_QUAD here, because that doesn't
 879  * actually mean what it has always been documented to mean (see RT #119753)
 880  * and is explicitly turned off outside of core with dire warnings about
 881  * removing the undef. */
 882
 883 #if defined(QUADKIND)
 884 #  undef PeRl_INT64_C
 885 #  undef PeRl_UINT64_C
 886 /* Prefer the native integer types (int and long) over long long
 887  * (which is not C89) and Win32-specific __int64. */
 888 #  if QUADKIND == QUAD_IS_INT && INTSIZE == 8
 889 #    define PeRl_INT64_C(c)     (c)
 890 #    define PeRl_UINT64_C(c)    CAT2(c,U)
 891 #  endif
 892 #  if QUADKIND == QUAD_IS_LONG && LONGSIZE == 8
 893 #    define PeRl_INT64_C(c)     CAT2(c,L)
 894 #    define PeRl_UINT64_C(c)    CAT2(c,UL)
 895 #  endif
 896 #  if QUADKIND == QUAD_IS_LONG_LONG && defined(HAS_LONG_LONG)
 897 #    define PeRl_INT64_C(c)     CAT2(c,LL)
 898 #    define PeRl_UINT64_C(c)    CAT2(c,ULL)
 899 #  endif
 900 #  if QUADKIND == QUAD_IS___INT64
 901 #    define PeRl_INT64_C(c)     CAT2(c,I64)
 902 #    define PeRl_UINT64_C(c)    CAT2(c,UI64)
 903 #  endif
 904 #  ifndef PeRl_INT64_C
 905 #    define PeRl_INT64_C(c)     ((I64)(c)) /* last resort */
 906 #    define PeRl_UINT64_C(c)    ((U64TYPE)(c))
 907 #  endif
 908 /* In OS X the INT64_C/UINT64_C are defined with LL/ULL, which will
 909  * not fly with C89-pedantic gcc, so let's undefine them first so that
 910  * we can redefine them with our native integer preferring versions. */
 911 #  if defined(PERL_DARWIN) && defined(PERL_GCC_PEDANTIC)
 912 #    undef INT64_C
 913 #    undef UINT64_C
 914 #  endif
 915 #  ifndef INT64_C
 916 #    define INT64_C(c) PeRl_INT64_C(c)
 917 #  endif
 918 #  ifndef UINT64_C
 919 #    define UINT64_C(c) PeRl_UINT64_C(c)
 920 #  endif
 921
 922 #  ifndef I_STDINT
 923     typedef I64TYPE PERL_INTMAX_T;
 924     typedef U64TYPE PERL_UINTMAX_T;
 925 #  endif
 926 #  ifndef INTMAX_C
 927 #    define INTMAX_C(c) INT64_C(c)
 928 #  endif
 929 #  ifndef UINTMAX_C
 930 #    define UINTMAX_C(c) UINT64_C(c)
 931 #  endif
 932
 933 #else  /* below QUADKIND is undefined */
 934
 935 /* Perl doesn't work on 16 bit systems, so must be 32 bit */
 936 #  ifndef I_STDINT
 937     typedef I32TYPE PERL_INTMAX_T;
 938     typedef U32TYPE PERL_UINTMAX_T;
 939 #  endif
 940 #  ifndef INTMAX_C
 941 #    define INTMAX_C(c) INT32_C(c)
 942 #  endif
 943 #  ifndef UINTMAX_C
 944 #    define UINTMAX_C(c) UINT32_C(c)
 945 #  endif
 946
 947 #endif  /* no QUADKIND */
 948
 949 #ifdef PERL_CORE
 950
 951 /* byte-swapping functions for big-/little-endian conversion */
 952 # define _swab_16_(x) ((U16)( \
 953          (((U16)(x) & UINT16_C(0x00ff)) << 8) | \
 954          (((U16)(x) & UINT16_C(0xff00)) >> 8) ))
 955
 956 # define _swab_32_(x) ((U32)( \
 957          (((U32)(x) & UINT32_C(0x000000ff)) << 24) | \
 958          (((U32)(x) & UINT32_C(0x0000ff00)) <<  8) | \
 959          (((U32)(x) & UINT32_C(0x00ff0000)) >>  8) | \
 960          (((U32)(x) & UINT32_C(0xff000000)) >> 24) ))
 961
 962 # ifdef HAS_QUAD
 963 #  define _swab_64_(x) ((U64)( \
 964           (((U64)(x) & UINT64_C(0x00000000000000ff)) << 56) | \
 965           (((U64)(x) & UINT64_C(0x000000000000ff00)) << 40) | \
 966           (((U64)(x) & UINT64_C(0x0000000000ff0000)) << 24) | \
 967           (((U64)(x) & UINT64_C(0x00000000ff000000)) <<  8) | \
 968           (((U64)(x) & UINT64_C(0x000000ff00000000)) >>  8) | \
 969           (((U64)(x) & UINT64_C(0x0000ff0000000000)) >> 24) | \
 970           (((U64)(x) & UINT64_C(0x00ff000000000000)) >> 40) | \
 971           (((U64)(x) & UINT64_C(0xff00000000000000)) >> 56) ))
 972 # endif
 973
 974 /* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
 975    at least on FreeBSD.  YMMV, so experiment.  */
 976 #ifndef PERL_ARENA_SIZE
 977 #define PERL_ARENA_SIZE 4080
 978 #endif
 979
 980 /* Maximum level of recursion */
 981 #ifndef PERL_SUB_DEPTH_WARN
 982 #define PERL_SUB_DEPTH_WARN 100
 983 #endif
 984
 985 #endif /* PERL_CORE */
 986
 987 /* Maximum number of args that may be passed to an OP_MULTICONCAT op.
 988  * It determines the size of local arrays in S_maybe_multiconcat() and
 989  * pp_multiconcat().
 990  */
 991 #define PERL_MULTICONCAT_MAXARG 64
 992
 993 /* The indexes of fields of a multiconcat aux struct.
 994  * The fixed fields are followed by nargs+1 const segment lengths,
 995  * and if utf8 and non-utf8 differ, a second nargs+1 set for utf8.
 996  */
 997
 998 #define PERL_MULTICONCAT_IX_NARGS     0 /* number of arguments */
 999 #define PERL_MULTICONCAT_IX_PLAIN_PV  1 /* non-utf8 constant string */
1000 #define PERL_MULTICONCAT_IX_PLAIN_LEN 2 /* non-utf8 constant string length */
1001 #define PERL_MULTICONCAT_IX_UTF8_PV   3 /* utf8 constant string */
1002 #define PERL_MULTICONCAT_IX_UTF8_LEN  4 /* utf8 constant string length */
1003 #define PERL_MULTICONCAT_IX_LENGTHS   5 /* first of nargs+1 const segment lens */
1004 #define PERL_MULTICONCAT_HEADER_SIZE 5 /* The number of fields of a
1005                                            multiconcat header */
1006
1007 /* We no longer default to creating a new SV for GvSV.
1008    Do this before embed.  */
1009 #ifndef PERL_CREATE_GVSV
1010 #  ifndef PERL_DONT_CREATE_GVSV
1011 #    define PERL_DONT_CREATE_GVSV
1012 #  endif
1013 #endif
1014
1015 #if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
1016 #define PERL_USES_PL_PIDSTATUS
1017 #endif
1018
1019 #if !defined(OS2) && !defined(WIN32) && !defined(DJGPP) && !defined(__SYMBIAN32__)
1020 #define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
1021 #endif
1022
1023 #define MEM_SIZE Size_t
1024
1025 /* Round all values passed to malloc up, by default to a multiple of
1026    sizeof(size_t)
1027 */
1028 #ifndef PERL_STRLEN_ROUNDUP_QUANTUM
1029 #define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
1030 #endif
1031
1032 /* sv_grow() will expand strings by at least a certain percentage of
1033    the previously *used* length to avoid excessive calls to realloc().
1034    The default is 25% of the current length.
1035 */
1036 #ifndef PERL_STRLEN_EXPAND_SHIFT
1037 #  define PERL_STRLEN_EXPAND_SHIFT 2
1038 #endif
1039
1040 #include <stddef.h>
1041 #define STRUCT_OFFSET(s,m)  offsetof(s,m)
1042
1043 /* ptrdiff_t is C11, so undef it under pedantic builds */
1044 #ifdef PERL_GCC_PEDANTIC
1045 #   undef HAS_PTRDIFF_T
1046 #endif
1047
1048 #ifndef __SYMBIAN32__
1049 #  include <string.h>
1050 #endif
1051
1052 /* This comes after <stdlib.h> so we don't try to change the standard
1053  * library prototypes; we'll use our own in proto.h instead. */
1054
1055 #ifdef MYMALLOC
1056 #  ifdef PERL_POLLUTE_MALLOC
1057 #   ifndef PERL_EXTMALLOC_DEF
1058 #    define Perl_malloc         malloc
1059 #    define Perl_calloc         calloc
1060 #    define Perl_realloc        realloc
1061 #    define Perl_mfree          free
1062 #   endif
1063 #  else
1064 #    define EMBEDMYMALLOC       /* for compatibility */
1065 #  endif
1066
1067 #  define safemalloc  Perl_malloc
1068 #  define safecalloc  Perl_calloc
1069 #  define saferealloc Perl_realloc
1070 #  define safefree    Perl_mfree
1071 #  define CHECK_MALLOC_TOO_LATE_FOR_(code)      STMT_START {            \
1072         if (!PL_tainting && MallocCfg_ptr[MallocCfg_cfg_env_read])      \
1073                 code;                                                   \
1074     } STMT_END
1075 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)                         \
1076         CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
1077 #  define panic_write2(s)               write(2, s, strlen(s))
1078 #  define CHECK_MALLOC_TAINT(newval)                            \
1079         CHECK_MALLOC_TOO_LATE_FOR_(                             \
1080                 if (newval) {                                   \
1081                   PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
1082                   exit(1); })
1083 #  define MALLOC_CHECK_TAINT(argc,argv,env)     STMT_START {    \
1084         if (doing_taint(argc,argv,env)) {                       \
1085                 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1;      \
1086     }} STMT_END;
1087 #else  /* MYMALLOC */
1088 #  define safemalloc  safesysmalloc
1089 #  define safecalloc  safesyscalloc
1090 #  define saferealloc safesysrealloc
1091 #  define safefree    safesysfree
1092 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)         ((void)0)
1093 #  define CHECK_MALLOC_TAINT(newval)            ((void)0)
1094 #  define MALLOC_CHECK_TAINT(argc,argv,env)
1095 #endif /* MYMALLOC */
1096
1097 /* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
1098 #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)
1099 #define TOO_LATE_FOR(ch)        TOO_LATE_FOR_(ch, "")
1100 #define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
1101 #define MALLOC_CHECK_TAINT2(argc,argv)  MALLOC_CHECK_TAINT(argc,argv,NULL)
1102
1103 #ifndef memzero
1104 #   define memzero(d,l) memset(d,0,l)
1105 #endif
1106
1107 #ifdef I_NETINET_IN
1108 #   include <netinet/in.h>
1109 #endif
1110
1111 #ifdef I_ARPA_INET
1112 #   include <arpa/inet.h>
1113 #endif
1114
1115 #ifdef I_SYS_STAT
1116 #   include <sys/stat.h>
1117 #endif
1118
1119 /* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1120    This definition should ideally go into win32/win32.h, but S_IFIFO is
1121    used later here in perl.h before win32/win32.h is being included. */
1122 #if !defined(S_IFIFO) && defined(_S_IFIFO)
1123 #   define S_IFIFO _S_IFIFO
1124 #endif
1125
1126 /* The stat macros for Unisoft System V/88 (and derivatives
1127    like UTekV) are broken, sometimes giving false positives.  Undefine
1128    them here and let the code below set them to proper values.
1129
1130    The ghs macro stands for GreenHills Software C-1.8.5 which
1131    is the C compiler for sysV88 and the various derivatives.
1132    This header file bug is corrected in gcc-2.5.8 and later versions.
1133    --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94.  */
1134
1135 #if defined(m88k) && defined(ghs)
1136 #   undef S_ISDIR
1137 #   undef S_ISCHR
1138 #   undef S_ISBLK
1139 #   undef S_ISREG
1140 #   undef S_ISFIFO
1141 #   undef S_ISLNK
1142 #endif
1143
1144 #include <time.h>
1145
1146 #ifdef I_SYS_TIME
1147 #   ifdef I_SYS_TIME_KERNEL
1148 #       define KERNEL
1149 #   endif
1150 #   include <sys/time.h>
1151 #   ifdef I_SYS_TIME_KERNEL
1152 #       undef KERNEL
1153 #   endif
1154 #endif
1155
1156 #if defined(HAS_TIMES) && defined(I_SYS_TIMES)
1157 #    include <sys/times.h>
1158 #endif
1159
1160 #include <errno.h>
1161
1162 #if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
1163 #  define WIN32SCK_IS_STDSCK            /* don't pull in custom wsock layer */
1164 #endif
1165
1166 #if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1167 # include <sys/socket.h>
1168 # if defined(USE_SOCKS) && defined(I_SOCKS)
1169 #   if !defined(INCLUDE_PROTOTYPES)
1170 #       define INCLUDE_PROTOTYPES /* for <socks.h> */
1171 #       define PERL_SOCKS_NEED_PROTOTYPES
1172 #   endif
1173 #   include <socks.h>
1174 #   ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1175 #       undef INCLUDE_PROTOTYPES
1176 #       undef PERL_SOCKS_NEED_PROTOTYPES
1177 #   endif
1178 # endif
1179 # ifdef I_NETDB
1180 #  ifdef NETWARE
1181 #   include<stdio.h>
1182 #  endif
1183 #  include <netdb.h>
1184 # endif
1185 # ifndef ENOTSOCK
1186 #  ifdef I_NET_ERRNO
1187 #   include <net/errno.h>
1188 #  endif
1189 # endif
1190 #endif
1191
1192 /* sockatmark() is so new (2001) that many places might have it hidden
1193  * behind some -D_BLAH_BLAH_SOURCE guard.  The __THROW magic is required
1194  * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
1195 #if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
1196 # if defined(__THROW) && defined(__GLIBC__)
1197 int sockatmark(int) __THROW;
1198 # else
1199 int sockatmark(int);
1200 # endif
1201 #endif
1202
1203 #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. */
1204 EXTERN_C int fchdir(int);
1205 EXTERN_C int flock(int, int);
1206 EXTERN_C int fseeko(FILE *, off_t, int);
1207 EXTERN_C off_t ftello(FILE *);
1208 #endif
1209
1210 #if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1211 EXTERN_C char *crypt(const char *, const char *);
1212 #endif
1213
1214 #if defined(__cplusplus) && defined(__CYGWIN__)
1215 EXTERN_C char *crypt(const char *, const char *);
1216 #endif
1217
1218 #ifdef SETERRNO
1219 # undef SETERRNO  /* SOCKS might have defined this */
1220 #endif
1221
1222 #ifdef VMS
1223 #   define SETERRNO(errcode,vmserrcode) \
1224         STMT_START {                    \
1225             set_errno(errcode);         \
1226             set_vaxc_errno(vmserrcode); \
1227         } STMT_END
1228 #   define dSAVEDERRNO    int saved_errno; unsigned saved_vms_errno
1229 #   define dSAVE_ERRNO    int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1230 #   define SAVE_ERRNO     ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1231 #   define RESTORE_ERRNO  SETERRNO(saved_errno, saved_vms_errno)
1232
1233 #   define LIB_INVARG           LIB$_INVARG
1234 #   define RMS_DIR              RMS$_DIR
1235 #   define RMS_FAC              RMS$_FAC
1236 #   define RMS_FEX              RMS$_FEX
1237 #   define RMS_FNF              RMS$_FNF
1238 #   define RMS_IFI              RMS$_IFI
1239 #   define RMS_ISI              RMS$_ISI
1240 #   define RMS_PRV              RMS$_PRV
1241 #   define SS_ACCVIO            SS$_ACCVIO
1242 #   define SS_DEVOFFLINE        SS$_DEVOFFLINE
1243 #   define SS_IVCHAN            SS$_IVCHAN
1244 #   define SS_NORMAL            SS$_NORMAL
1245 #   define SS_NOPRIV            SS$_NOPRIV
1246 #   define SS_BUFFEROVF         SS$_BUFFEROVF
1247 #else
1248 #   define LIB_INVARG           0
1249 #   define RMS_DIR              0
1250 #   define RMS_FAC              0
1251 #   define RMS_FEX              0
1252 #   define RMS_FNF              0
1253 #   define RMS_IFI              0
1254 #   define RMS_ISI              0
1255 #   define RMS_PRV              0
1256 #   define SS_ACCVIO            0
1257 #   define SS_DEVOFFLINE        0
1258 #   define SS_IVCHAN            0
1259 #   define SS_NORMAL            0
1260 #   define SS_NOPRIV            0
1261 #   define SS_BUFFEROVF         0
1262 #endif
1263
1264 #ifdef WIN32
1265 #   define dSAVEDERRNO  int saved_errno; DWORD saved_win32_errno
1266 #   define dSAVE_ERRNO  int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1267 #   define SAVE_ERRNO   ( saved_errno = errno, saved_win32_errno = GetLastError() )
1268 #   define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1269 #endif
1270
1271 #ifdef OS2
1272 #   define dSAVEDERRNO  int saved_errno; unsigned long saved_os2_errno
1273 #   define dSAVE_ERRNO  int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1274 #   define SAVE_ERRNO   ( saved_errno = errno, saved_os2_errno = Perl_rc )
1275 #   define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1276 #endif
1277
1278 #ifndef SETERRNO
1279 #   define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1280 #endif
1281
1282 #ifndef dSAVEDERRNO
1283 #   define dSAVEDERRNO    int saved_errno
1284 #   define dSAVE_ERRNO    int saved_errno = errno
1285 #   define SAVE_ERRNO     (saved_errno = errno)
1286 #   define RESTORE_ERRNO  (errno = saved_errno)
1287 #endif
1288
1289 #define ERRSV GvSVn(PL_errgv)
1290
1291 /* contains inlined gv_add_by_type */
1292 #define CLEAR_ERRSV() STMT_START {                                      \
1293     SV ** const svp = &GvSV(PL_errgv);                                  \
1294     if (!*svp) {                                                        \
1295         *svp = newSVpvs("");                                            \
1296     } else if (SvREADONLY(*svp)) {                                      \
1297         SvREFCNT_dec_NN(*svp);                                          \
1298         *svp = newSVpvs("");                                            \
1299     } else {                                                            \
1300         SV *const errsv = *svp;                                         \
1301         SvPVCLEAR(errsv);                                               \
1302         SvPOK_only(errsv);                                              \
1303         if (SvMAGICAL(errsv)) {                                         \
1304             mg_free(errsv);                                             \
1305         }                                                               \
1306     }                                                                   \
1307     } STMT_END
1308
1309
1310 #ifdef PERL_CORE
1311 # define DEFSV (0 + GvSVn(PL_defgv))
1312 # define DEFSV_set(sv) \
1313     (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1314 # define SAVE_DEFSV                \
1315     (                               \
1316         save_gp(PL_defgv, 0),        \
1317         GvINTRO_off(PL_defgv),        \
1318         SAVEGENERICSV(GvSV(PL_defgv)), \
1319         GvSV(PL_defgv) = NULL           \
1320     )
1321 #else
1322 # define DEFSV GvSVn(PL_defgv)
1323 # define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1324 # define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
1325 #endif
1326
1327 #ifndef errno
1328         extern int errno;     /* ANSI allows errno to be an lvalue expr.
1329                                * For example in multithreaded environments
1330                                * something like this might happen:
1331                                * extern int *_errno(void);
1332                                * #define errno (*_errno()) */
1333 #endif
1334
1335 #define UNKNOWN_ERRNO_MSG "(unknown)"
1336
1337 #if VMS
1338 #define Strerror(e) strerror((e), vaxc$errno)
1339 #else
1340 #define Strerror(e) strerror(e)
1341 #endif
1342
1343 #ifdef I_SYS_IOCTL
1344 #   ifndef _IOCTL_
1345 #       include <sys/ioctl.h>
1346 #   endif
1347 #endif
1348
1349 #if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
1350 #   ifdef HAS_SOCKETPAIR
1351 #       undef HAS_SOCKETPAIR
1352 #   endif
1353 #   ifdef I_NDBM
1354 #       undef I_NDBM
1355 #   endif
1356 #endif
1357
1358 #ifndef HAS_SOCKETPAIR
1359 #   ifdef HAS_SOCKET
1360 #       define socketpair Perl_my_socketpair
1361 #   endif
1362 #endif
1363
1364 #if INTSIZE == 2
1365 #   define htoni htons
1366 #   define ntohi ntohs
1367 #else
1368 #   define htoni htonl
1369 #   define ntohi ntohl
1370 #endif
1371
1372 /* Configure already sets Direntry_t */
1373 #if defined(I_DIRENT)
1374 #  include <dirent.h>
1375 #elif defined(I_SYS_NDIR)
1376 #  include <sys/ndir.h>
1377 #elif defined(I_SYS_DIR)
1378 #  include <sys/dir.h>
1379 #endif
1380
1381 /*
1382  * The following gobbledygook brought to you on behalf of __STDC__.
1383  * (I could just use #ifndef __STDC__, but this is more bulletproof
1384  * in the face of half-implementations.)
1385  */
1386
1387 #if defined(I_SYSMODE)
1388 #include <sys/mode.h>
1389 #endif
1390
1391 #ifndef S_IFMT
1392 #   ifdef _S_IFMT
1393 #       define S_IFMT _S_IFMT
1394 #   else
1395 #       define S_IFMT 0170000
1396 #   endif
1397 #endif
1398
1399 #ifndef S_ISDIR
1400 #   define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1401 #endif
1402
1403 #ifndef S_ISCHR
1404 #   define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1405 #endif
1406
1407 #ifndef S_ISBLK
1408 #   ifdef S_IFBLK
1409 #       define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1410 #   else
1411 #       define S_ISBLK(m) (0)
1412 #   endif
1413 #endif
1414
1415 #ifndef S_ISREG
1416 #   define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1417 #endif
1418
1419 #ifndef S_ISFIFO
1420 #   ifdef S_IFIFO
1421 #       define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1422 #   else
1423 #       define S_ISFIFO(m) (0)
1424 #   endif
1425 #endif
1426
1427 #ifndef S_ISLNK
1428 #  ifdef _S_ISLNK
1429 #    define S_ISLNK(m) _S_ISLNK(m)
1430 #  elif defined(_S_IFLNK)
1431 #    define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1432 #  elif defined(S_IFLNK)
1433 #    define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1434 #  else
1435 #    define S_ISLNK(m) (0)
1436 #  endif
1437 #endif
1438
1439 #ifndef S_ISSOCK
1440 #  ifdef _S_ISSOCK
1441 #    define S_ISSOCK(m) _S_ISSOCK(m)
1442 #  elif defined(_S_IFSOCK)
1443 #    define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1444 #  elif defined(S_IFSOCK)
1445 #    define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1446 #  else
1447 #    define S_ISSOCK(m) (0)
1448 #  endif
1449 #endif
1450
1451 #ifndef S_IRUSR
1452 #   ifdef S_IREAD
1453 #       define S_IRUSR S_IREAD
1454 #       define S_IWUSR S_IWRITE
1455 #       define S_IXUSR S_IEXEC
1456 #   else
1457 #       define S_IRUSR 0400
1458 #       define S_IWUSR 0200
1459 #       define S_IXUSR 0100
1460 #   endif
1461 #endif
1462
1463 #ifndef S_IRGRP
1464 #   ifdef S_IRUSR
1465 #       define S_IRGRP (S_IRUSR>>3)
1466 #       define S_IWGRP (S_IWUSR>>3)
1467 #       define S_IXGRP (S_IXUSR>>3)
1468 #   else
1469 #       define S_IRGRP 0040
1470 #       define S_IWGRP 0020
1471 #       define S_IXGRP 0010
1472 #   endif
1473 #endif
1474
1475 #ifndef S_IROTH
1476 #   ifdef S_IRUSR
1477 #       define S_IROTH (S_IRUSR>>6)
1478 #       define S_IWOTH (S_IWUSR>>6)
1479 #       define S_IXOTH (S_IXUSR>>6)
1480 #   else
1481 #       define S_IROTH 0040
1482 #       define S_IWOTH 0020
1483 #       define S_IXOTH 0010
1484 #   endif
1485 #endif
1486
1487 #ifndef S_ISUID
1488 #   define S_ISUID 04000
1489 #endif
1490
1491 #ifndef S_ISGID
1492 #   define S_ISGID 02000
1493 #endif
1494
1495 #ifndef S_IRWXU
1496 #   define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
1497 #endif
1498
1499 #ifndef S_IRWXG
1500 #   define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
1501 #endif
1502
1503 #ifndef S_IRWXO
1504 #   define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
1505 #endif
1506
1507 /* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
1508  * which would get included through <sys/file.h >, but that is 3000
1509  * lines in the future.  --jhi */
1510
1511 #if !defined(S_IREAD) && !defined(__HAIKU__)
1512 #   define S_IREAD S_IRUSR
1513 #endif
1514
1515 #if !defined(S_IWRITE) && !defined(__HAIKU__)
1516 #   define S_IWRITE S_IWUSR
1517 #endif
1518
1519 #ifndef S_IEXEC
1520 #   define S_IEXEC S_IXUSR
1521 #endif
1522
1523 #if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
1524 #   define SLOPPYDIVIDE
1525 #endif
1526
1527 #ifdef UV
1528 #undef UV
1529 #endif
1530
1531 /* This used to be conditionally defined based on whether we had a sprintf()
1532  * that correctly returns the string length (as required by C89), but we no
1533  * longer need that. XS modules can (and do) use this name, so it must remain
1534  * a part of the API that's visible to modules. But we no longer document it
1535  * either (because using sprintf() rather than snprintf() is almost always
1536  * a bad idea). */
1537 #define my_sprintf sprintf
1538
1539 /*
1540  * If we have v?snprintf() and the C99 variadic macros, we can just
1541  * use just the v?snprintf().  It is nice to try to trap the buffer
1542  * overflow, however, so if we are DEBUGGING, and we cannot use the
1543  * gcc statement expressions, then use the function wrappers which try
1544  * to trap the overflow.  If we can use the gcc statement expressions,
1545  * we can try that even with the version that uses the C99 variadic
1546  * macros.
1547  */
1548
1549 /* Note that we do not check against snprintf()/vsnprintf() returning
1550  * negative values because that is non-standard behaviour and we use
1551  * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1552  * that should be true only if the snprintf()/vsnprintf() are true
1553  * to the standard. */
1554
1555 #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
1556
1557 #ifdef USE_QUADMATH
1558 #  define my_snprintf Perl_my_snprintf
1559 #  define PERL_MY_SNPRINTF_GUARDED
1560 #elif defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1561 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1562 #      define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1563 #      define PERL_MY_SNPRINTF_GUARDED
1564 #  else
1565 #    define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
1566 #  endif
1567 #else
1568 #  define my_snprintf  Perl_my_snprintf
1569 #  define PERL_MY_SNPRINTF_GUARDED
1570 #endif
1571
1572 /* There is no quadmath_vsnprintf, and therefore my_vsnprintf()
1573  * dies if called under USE_QUADMATH. */
1574 #if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1575 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1576 #      define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1577 #      define PERL_MY_VSNPRINTF_GUARDED
1578 #  else
1579 #    define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
1580 #  endif
1581 #else
1582 #  define my_vsnprintf Perl_my_vsnprintf
1583 #  define PERL_MY_VSNPRINTF_GUARDED
1584 #endif
1585
1586 /* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1587  * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1588  * the result of my_snprintf() or my_vsnprintf().  (No, you should not
1589  * completely ignore it: otherwise you cannot know whether your output
1590  * was too long.)
1591  *
1592  * int len = my_sprintf(buf, max, ...);
1593  * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1594  *
1595  * The trick is that in certain platforms [a] the my_sprintf() already
1596  * contains the sanity check, while in certain platforms [b] it needs
1597  * to be done as a separate step.  The POST_GUARD is that step-- in [a]
1598  * platforms the POST_GUARD actually does nothing since the check has
1599  * already been done.  Watch out for the max being the same in both calls.
1600  *
1601  * If you actually use the snprintf/vsnprintf return value already,
1602  * you assumedly are checking its validity somehow.  But you can
1603  * insert the POST_GUARD() also in that case. */
1604
1605 #ifndef PERL_MY_SNPRINTF_GUARDED
1606 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1607 #else
1608 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1609 #endif
1610
1611 #ifndef  PERL_MY_VSNPRINTF_GUARDED
1612 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
1613 #else
1614 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1615 #endif
1616
1617 #ifdef HAS_STRLCAT
1618 #  define my_strlcat    strlcat
1619 #else
1620 #  define my_strlcat    Perl_my_strlcat
1621 #endif
1622
1623 #if defined(PERL_CORE) || defined(PERL_EXT)
1624 #  ifdef HAS_MEMRCHR
1625 #    define my_memrchr  memrchr
1626 #  else
1627 #    define my_memrchr  S_my_memrchr
1628 #  endif
1629 #endif
1630
1631 #ifdef HAS_STRLCPY
1632 #  define my_strlcpy    strlcpy
1633 #else
1634 #  define my_strlcpy    Perl_my_strlcpy
1635 #endif
1636
1637 #ifdef HAS_STRNLEN
1638 #  define my_strnlen    strnlen
1639 #else
1640 #  define my_strnlen    Perl_my_strnlen
1641 #endif
1642
1643 /*
1644     The IV type is supposed to be long enough to hold any integral
1645     value or a pointer.
1646     --Andy Dougherty    August 1996
1647 */
1648
1649 typedef IVTYPE IV;
1650 typedef UVTYPE UV;
1651
1652 #if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
1653 #  if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
1654 #    define IV_MAX INT64_MAX
1655 #    define IV_MIN INT64_MIN
1656 #    define UV_MAX UINT64_MAX
1657 #    ifndef UINT64_MIN
1658 #      define UINT64_MIN 0
1659 #    endif
1660 #    define UV_MIN UINT64_MIN
1661 #  else
1662 #    define IV_MAX PERL_QUAD_MAX
1663 #    define IV_MIN PERL_QUAD_MIN
1664 #    define UV_MAX PERL_UQUAD_MAX
1665 #    define UV_MIN PERL_UQUAD_MIN
1666 #  endif
1667 #  define IV_IS_QUAD
1668 #  define UV_IS_QUAD
1669 #else
1670 #  if defined(INT32_MAX) && IVSIZE == 4
1671 #    define IV_MAX INT32_MAX
1672 #    define IV_MIN INT32_MIN
1673 #    ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
1674 #        define UV_MAX UINT32_MAX
1675 #    else
1676 #        define UV_MAX 4294967295U
1677 #    endif
1678 #    ifndef UINT32_MIN
1679 #      define UINT32_MIN 0
1680 #    endif
1681 #    define UV_MIN UINT32_MIN
1682 #  else
1683 #    define IV_MAX PERL_LONG_MAX
1684 #    define IV_MIN PERL_LONG_MIN
1685 #    define UV_MAX PERL_ULONG_MAX
1686 #    define UV_MIN PERL_ULONG_MIN
1687 #  endif
1688 #  if IVSIZE == 8
1689 #    define IV_IS_QUAD
1690 #    define UV_IS_QUAD
1691 #    ifndef HAS_QUAD
1692 #      define HAS_QUAD
1693 #    endif
1694 #  else
1695 #    undef IV_IS_QUAD
1696 #    undef UV_IS_QUAD
1697 #if !defined(PERL_CORE) || defined(USING_MSVC6)
1698 /* We think that removing this decade-old undef this will cause too much
1699    breakage on CPAN for too little gain. (See RT #119753)
1700    However, we do need HAS_QUAD in the core for use by the drand48 code,
1701    but not for Win32 VC6 because it has poor __int64 support. */
1702 #    undef HAS_QUAD
1703 #endif
1704 #  endif
1705 #endif
1706
1707 #define Size_t_MAX (~(Size_t)0)
1708 #define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
1709
1710 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
1711 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
1712
1713 #ifndef NO_PERL_PRESERVE_IVUV
1714 #define PERL_PRESERVE_IVUV      /* We like our integers to stay integers. */
1715 #endif
1716
1717 /*
1718  *  The macros INT2PTR and NUM2PTR are (despite their names)
1719  *  bi-directional: they will convert int/float to or from pointers.
1720  *  However the conversion to int/float are named explicitly:
1721  *  PTR2IV, PTR2UV, PTR2NV.
1722  *
1723  *  For int conversions we do not need two casts if pointers are
1724  *  the same size as IV and UV.   Otherwise we need an explicit
1725  *  cast (PTRV) to avoid compiler warnings.
1726  */
1727 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1728 #  define PTRV                  UV
1729 #  define INT2PTR(any,d)        (any)(d)
1730 #elif PTRSIZE == LONGSIZE
1731 #  define PTRV                  unsigned long
1732 #  define PTR2ul(p)             (unsigned long)(p)
1733 #else
1734 #  define PTRV                  unsigned
1735 #endif
1736
1737 #ifndef INT2PTR
1738 #  define INT2PTR(any,d)        (any)(PTRV)(d)
1739 #endif
1740
1741 #ifndef PTR2ul
1742 #  define PTR2ul(p)     INT2PTR(unsigned long,p)
1743 #endif
1744
1745 #define NUM2PTR(any,d)  (any)(PTRV)(d)
1746 #define PTR2IV(p)       INT2PTR(IV,p)
1747 #define PTR2UV(p)       INT2PTR(UV,p)
1748 #define PTR2NV(p)       NUM2PTR(NV,p)
1749 #define PTR2nat(p)      (PTRV)(p)       /* pointer to integer of PTRSIZE */
1750
1751 /* According to strict ANSI C89 one cannot freely cast between
1752  * data pointers and function (code) pointers.  There are at least
1753  * two ways around this.  One (used below) is to do two casts,
1754  * first the other pointer to an (unsigned) integer, and then
1755  * the integer to the other pointer.  The other way would be
1756  * to use unions to "overlay" the pointers.  For an example of
1757  * the latter technique, see union dirpu in struct xpvio in sv.h.
1758  * The only feasible use is probably temporarily storing
1759  * function pointers in a data pointer (such as a void pointer). */
1760
1761 #define DPTR2FPTR(t,p) ((t)PTR2nat(p))  /* data pointer to function pointer */
1762 #define FPTR2DPTR(t,p) ((t)PTR2nat(p))  /* function pointer to data pointer */
1763
1764 #ifdef USE_LONG_DOUBLE
1765 #  if LONG_DOUBLESIZE == DOUBLESIZE
1766 #    define LONG_DOUBLE_EQUALS_DOUBLE
1767 #    undef USE_LONG_DOUBLE /* Ouch! */
1768 #  endif
1769 #endif
1770
1771 /* The following is all to get LDBL_DIG, in order to pick a nice
1772    default value for printing floating point numbers in Gconvert.
1773    (see config.h)
1774 */
1775 #ifndef HAS_LDBL_DIG
1776 #  if LONG_DOUBLESIZE == 10
1777 #    define LDBL_DIG 18 /* assume IEEE */
1778 #  elif LONG_DOUBLESIZE == 12
1779 #    define LDBL_DIG 18 /* gcc? */
1780 #  elif LONG_DOUBLESIZE == 16
1781 #    define LDBL_DIG 33 /* assume IEEE */
1782 #  elif LONG_DOUBLESIZE == DOUBLESIZE
1783 #    define LDBL_DIG DBL_DIG /* bummer */
1784 #  endif
1785 #endif
1786
1787 typedef NVTYPE NV;
1788
1789 #ifdef I_IEEEFP
1790 #   include <ieeefp.h>
1791 #endif
1792
1793 #ifdef USING_MSVC6
1794 /* VC6 has broken NaN semantics: NaN == NaN returns true instead of false,
1795  * and for example NaN < IV_MIN. */
1796 #  define NAN_COMPARE_BROKEN
1797 #endif
1798 #if defined(__DECC) && defined(__osf__)
1799 /* Also Tru64 cc has broken NaN comparisons. */
1800 #  define NAN_COMPARE_BROKEN
1801 #endif
1802 #if defined(__sgi)
1803 #  define NAN_COMPARE_BROKEN
1804 #endif
1805
1806 #ifdef USE_LONG_DOUBLE
1807 #   ifdef I_SUNMATH
1808 #       include <sunmath.h>
1809 #   endif
1810 #   if defined(LDBL_DIG)
1811 #       define NV_DIG LDBL_DIG
1812 #       ifdef LDBL_MANT_DIG
1813 #           define NV_MANT_DIG LDBL_MANT_DIG
1814 #       endif
1815 #       ifdef LDBL_MIN
1816 #           define NV_MIN LDBL_MIN
1817 #       endif
1818 #       ifdef LDBL_MAX
1819 #           define NV_MAX LDBL_MAX
1820 #       endif
1821 #       ifdef LDBL_MIN_EXP
1822 #           define NV_MIN_EXP LDBL_MIN_EXP
1823 #       endif
1824 #       ifdef LDBL_MAX_EXP
1825 #           define NV_MAX_EXP LDBL_MAX_EXP
1826 #       endif
1827 #       ifdef LDBL_MIN_10_EXP
1828 #           define NV_MIN_10_EXP LDBL_MIN_10_EXP
1829 #       endif
1830 #       ifdef LDBL_MAX_10_EXP
1831 #           define NV_MAX_10_EXP LDBL_MAX_10_EXP
1832 #       endif
1833 #       ifdef LDBL_EPSILON
1834 #           define NV_EPSILON LDBL_EPSILON
1835 #       endif
1836 #       ifdef LDBL_MAX
1837 #           define NV_MAX LDBL_MAX
1838 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
1839 #       elif defined(HUGE_VALL)
1840 #           define NV_MAX HUGE_VALL
1841 #       endif
1842 #   endif
1843 #   if defined(HAS_SQRTL)
1844 #       define Perl_acos acosl
1845 #       define Perl_asin asinl
1846 #       define Perl_atan atanl
1847 #       define Perl_atan2 atan2l
1848 #       define Perl_ceil ceill
1849 #       define Perl_cos cosl
1850 #       define Perl_cosh coshl
1851 #       define Perl_exp expl
1852 /* no Perl_fabs, but there's PERL_ABS */
1853 #       define Perl_floor floorl
1854 #       define Perl_fmod fmodl
1855 #       define Perl_log logl
1856 #       define Perl_log10 log10l
1857 #       define Perl_pow powl
1858 #       define Perl_sin sinl
1859 #       define Perl_sinh sinhl
1860 #       define Perl_sqrt sqrtl
1861 #       define Perl_tan tanl
1862 #       define Perl_tanh tanhl
1863 #   endif
1864 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
1865 #   ifndef Perl_modf
1866 #       ifdef HAS_MODFL
1867 #           define Perl_modf(x,y) modfl(x,y)
1868 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
1869    prototype in <math.h> */
1870 #           ifndef HAS_MODFL_PROTO
1871 EXTERN_C long double modfl(long double, long double *);
1872 #           endif
1873 #       elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
1874         extern long double Perl_my_modfl(long double x, long double *ip);
1875 #           define Perl_modf(x,y) Perl_my_modfl(x,y)
1876 #       endif
1877 #   endif
1878 #   ifndef Perl_frexp
1879 #       ifdef HAS_FREXPL
1880 #           define Perl_frexp(x,y) frexpl(x,y)
1881 #       elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
1882 extern long double Perl_my_frexpl(long double x, int *e);
1883 #           define Perl_frexp(x,y) Perl_my_frexpl(x,y)
1884 #       endif
1885 #   endif
1886 #   ifndef Perl_ldexp
1887 #       ifdef HAS_LDEXPL
1888 #           define Perl_ldexp(x, y) ldexpl(x,y)
1889 #       elif defined(HAS_SCALBNL) && FLT_RADIX == 2
1890 #           define Perl_ldexp(x,y) scalbnl(x,y)
1891 #       endif
1892 #   endif
1893 #   ifndef Perl_isnan
1894 #       if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
1895 #           define Perl_isnan(x) isnanl(x)
1896 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
1897 #           define Perl_isnan(x) isnan(x)
1898 #       endif
1899 #   endif
1900 #   ifndef Perl_isinf
1901 #       if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
1902 #           define Perl_isinf(x) isinfl(x)
1903 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
1904 #           define Perl_isinf(x) isinf(x)
1905 #       elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
1906 #           define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
1907 #       endif
1908 #   endif
1909 #   ifndef Perl_isfinite
1910 #       define Perl_isfinite(x) Perl_isfinitel(x)
1911 #   endif
1912 #elif defined(USE_QUADMATH) && defined(I_QUADMATH)
1913 #   include <quadmath.h>
1914 #   define NV_DIG FLT128_DIG
1915 #   define NV_MANT_DIG FLT128_MANT_DIG
1916 #   define NV_MIN FLT128_MIN
1917 #   define NV_MAX FLT128_MAX
1918 #   define NV_MIN_EXP FLT128_MIN_EXP
1919 #   define NV_MAX_EXP FLT128_MAX_EXP
1920 #   define NV_EPSILON FLT128_EPSILON
1921 #   define NV_MIN_10_EXP FLT128_MIN_10_EXP
1922 #   define NV_MAX_10_EXP FLT128_MAX_10_EXP
1923 #   define Perl_acos acosq
1924 #   define Perl_asin asinq
1925 #   define Perl_atan atanq
1926 #   define Perl_atan2 atan2q
1927 #   define Perl_ceil ceilq
1928 #   define Perl_cos cosq
1929 #   define Perl_cosh coshq
1930 #   define Perl_exp expq
1931 /* no Perl_fabs, but there's PERL_ABS */
1932 #   define Perl_floor floorq
1933 #   define Perl_fmod fmodq
1934 #   define Perl_log logq
1935 #   define Perl_log10 log10q
1936 #   define Perl_pow powq
1937 #   define Perl_sin sinq
1938 #   define Perl_sinh sinhq
1939 #   define Perl_sqrt sqrtq
1940 #   define Perl_tan tanq
1941 #   define Perl_tanh tanhq
1942 #   define Perl_modf(x,y) modfq(x,y)
1943 #   define Perl_frexp(x,y) frexpq(x,y)
1944 #   define Perl_ldexp(x, y) ldexpq(x,y)
1945 #   define Perl_isinf(x) isinfq(x)
1946 #   define Perl_isnan(x) isnanq(x)
1947 #   define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
1948 #   define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
1949 #   define Perl_fp_class_inf(x)    (Perl_fp_class(x) == 3)
1950 #   define Perl_fp_class_nan(x)    (Perl_fp_class(x) == 4)
1951 #   define Perl_fp_class_norm(x)   (Perl_fp_class(x) == 1)
1952 #   define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
1953 #   define Perl_fp_class_zero(x)   (Perl_fp_class(x) == 0)
1954 #else
1955 #   define NV_DIG DBL_DIG
1956 #   define NV_MANT_DIG DBL_MANT_DIG
1957 #   define NV_MIN DBL_MIN
1958 #   define NV_MAX DBL_MAX
1959 #   define NV_MIN_EXP DBL_MIN_EXP
1960 #   define NV_MAX_EXP DBL_MAX_EXP
1961 #   define NV_MIN_10_EXP DBL_MIN_10_EXP
1962 #   define NV_MAX_10_EXP DBL_MAX_10_EXP
1963 #   define NV_EPSILON DBL_EPSILON
1964 #   define NV_MAX DBL_MAX
1965 #   define NV_MIN DBL_MIN
1966
1967 /* These math interfaces are C89. */
1968 #   define Perl_acos acos
1969 #   define Perl_asin asin
1970 #   define Perl_atan atan
1971 #   define Perl_atan2 atan2
1972 #   define Perl_ceil ceil
1973 #   define Perl_cos cos
1974 #   define Perl_cosh cosh
1975 #   define Perl_exp exp
1976 /* no Perl_fabs, but there's PERL_ABS */
1977 #   define Perl_floor floor
1978 #   define Perl_fmod fmod
1979 #   define Perl_log log
1980 #   define Perl_log10 log10
1981 #   define Perl_pow pow
1982 #   define Perl_sin sin
1983 #   define Perl_sinh sinh
1984 #   define Perl_sqrt sqrt
1985 #   define Perl_tan tan
1986 #   define Perl_tanh tanh
1987
1988 #   define Perl_modf(x,y) modf(x,y)
1989 #   define Perl_frexp(x,y) frexp(x,y)
1990 #   define Perl_ldexp(x,y) ldexp(x,y)
1991
1992 #   ifndef Perl_isnan
1993 #       ifdef HAS_ISNAN
1994 #           define Perl_isnan(x) isnan(x)
1995 #       endif
1996 #   endif
1997 #   ifndef Perl_isinf
1998 #       if defined(HAS_ISINF)
1999 #           define Perl_isinf(x) isinf(x)
2000 #       elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2001 #           define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
2002 #       endif
2003 #   endif
2004 #   ifndef Perl_isfinite
2005 #     ifdef HAS_ISFINITE
2006 #       define Perl_isfinite(x) isfinite(x)
2007 #     elif defined(HAS_FINITE)
2008 #       define Perl_isfinite(x) finite(x)
2009 #     endif
2010 #   endif
2011 #endif
2012
2013 /* fpclassify(): C99.  It is supposed to be a macro that switches on
2014 * the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
2015 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2016 #    include <math.h>
2017 #    if defined(FP_INFINITE) && defined(FP_NAN)
2018 #        define Perl_fp_class(x)        fpclassify(x)
2019 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
2020 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
2021 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
2022 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2023 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
2024 #    elif defined(FP_PLUS_INF) && defined(FP_QNAN)
2025 /* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
2026  * actually not the C99 fpclassify, with its own set of return defines. */
2027 #        define Perl_fp_class(x)        fpclassify(x)
2028 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PLUS_INF)
2029 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_MINUS_INF)
2030 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
2031 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
2032 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PLUS_NORM)
2033 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_MINUS_NORM)
2034 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PLUS_DENORM)
2035 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_MINUS_DENORM)
2036 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PLUS_ZERO)
2037 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_MINUS_ZERO)
2038 #    else
2039 #        undef Perl_fp_class /* Unknown set of defines */
2040 #    endif
2041 #endif
2042
2043 /* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
2044  * are identical to the C99 fpclassify(). */
2045 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
2046 #    include <math.h>
2047 #    ifdef __VMS
2048      /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
2049 #        include <fp.h>
2050      /* oh, and the isnormal macro has a typo in it! */
2051 #    undef isnormal
2052 #    define isnormal(x) Perl_fp_class_norm(x)
2053 #    endif
2054 #    if defined(FP_INFINITE) && defined(FP_NAN)
2055 #        define Perl_fp_class(x)        fp_classify(x)
2056 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
2057 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
2058 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
2059 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2060 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
2061 #    else
2062 #        undef Perl_fp_class /* Unknown set of defines */
2063 #    endif
2064 #endif
2065
2066 /* Feel free to check with me for the SGI manpages, SGI testing,
2067  * etcetera, if you want to try getting this to work with IRIX.
2068  *
2069  * - Allen <allens@cpan.org> */
2070
2071 /* fpclass(): SysV, at least Solaris and some versions of IRIX. */
2072 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
2073 /* Solaris and IRIX have fpclass/fpclassl, but they are using
2074  * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2075  * Define some symbols also as cpp symbols so we can detect them. */
2076 #    if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
2077 #     define FP_PINF FP_PINF
2078 #     define FP_QNAN FP_QNAN
2079 #    endif
2080 #    include <math.h>
2081 #    ifdef I_IEEFP
2082 #        include <ieeefp.h>
2083 #    endif
2084 #    ifdef I_FP
2085 #        include <fp.h>
2086 #    endif
2087 #    if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
2088 #        define Perl_fp_class(x)        fpclassl(x)
2089 #    else
2090 #        define Perl_fp_class(x)        fpclass(x)
2091 #    endif
2092 #    if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
2093 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_CLASS_SNAN)
2094 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_CLASS_QNAN)
2095 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_CLASS_NINF)
2096 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_CLASS_PINF)
2097 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_CLASS_NNORM)
2098 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_CLASS_PNORM)
2099 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_CLASS_NDENORM)
2100 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_CLASS_PDENORM)
2101 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_CLASS_NZERO)
2102 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_CLASS_PZERO)
2103 #    elif defined(FP_PINF) && defined(FP_QNAN)
2104 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
2105 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
2106 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_NINF)
2107 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PINF)
2108 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_NNORM)
2109 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PNORM)
2110 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_NDENORM)
2111 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PDENORM)
2112 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_NZERO)
2113 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PZERO)
2114 #    else
2115 #        undef Perl_fp_class /* Unknown set of defines */
2116 #    endif
2117 #endif
2118
2119 /* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2120 #if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
2121 #    include <math.h>
2122 #    if !defined(FP_SNAN) && defined(I_FP_CLASS)
2123 #        include <fp_class.h>
2124 #    endif
2125 #    if defined(FP_POS_INF) && defined(FP_QNAN)
2126 #        ifdef __sgi /* XXX Configure test instead */
2127 #            ifdef USE_LONG_DOUBLE
2128 #                define Perl_fp_class(x)        fp_class_l(x)
2129 #            else
2130 #                define Perl_fp_class(x)        fp_class_d(x)
2131 #            endif
2132 #        else
2133 #            if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2134 #                define Perl_fp_class(x)        fp_classl(x)
2135 #            else
2136 #                define Perl_fp_class(x)        fp_class(x)
2137 #            endif
2138 #        endif
2139 #        if defined(FP_POS_INF) && defined(FP_QNAN)
2140 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_SNAN)
2141 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_QNAN)
2142 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_NEG_INF)
2143 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_POS_INF)
2144 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_NEG_NORM)
2145 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_POS_NORM)
2146 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_NEG_DENORM)
2147 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_POS_DENORM)
2148 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_NEG_ZERO)
2149 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_POS_ZERO)
2150 #        else
2151 #            undef Perl_fp_class /* Unknown set of defines */
2152 #        endif
2153 #    endif
2154 #endif
2155
2156 /* class(), _class(): Legacy: AIX. */
2157 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2158 #    include <math.h>
2159 #    if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2160 #        ifndef _cplusplus
2161 #            define Perl_fp_class(x)    class(x)
2162 #        else
2163 #            define Perl_fp_class(x)    _class(x)
2164 #        endif
2165 #        if defined(FP_PLUS_INF) && defined(FP_NANQ)
2166 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_NANS)
2167 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_NANQ)
2168 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_MINUS_INF)
2169 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_PLUS_INF)
2170 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_MINUS_NORM)
2171 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_PLUS_NORM)
2172 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_MINUS_DENORM)
2173 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_PLUS_DENORM)
2174 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_MINUS_ZERO)
2175 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_PLUS_ZERO)
2176 #        else
2177 #            undef Perl_fp_class /* Unknown set of defines */
2178 #        endif
2179 #    endif
2180 #endif
2181
2182 /* Win32: _fpclass(), _isnan(), _finite(). */
2183 #ifdef WIN32
2184 #  ifndef Perl_isnan
2185 #    define Perl_isnan(x) _isnan(x)
2186 #  endif
2187 #  ifndef Perl_isfinite
2188 #    define Perl_isfinite(x) _finite(x)
2189 #  endif
2190 #  ifndef Perl_fp_class_snan
2191 /* No simple way to #define Perl_fp_class because _fpclass()
2192  * returns a set of bits. */
2193 #    define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2194 #    define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
2195 #    define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
2196 #    define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF))
2197 #    define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF))
2198 #    define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2199 #    define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2200 #    define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2201 #    define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2202 #    define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2203 #    define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2204 #    define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2205 #    define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2206 #    define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2207 #    define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2208 #  endif
2209 #endif
2210
2211 #if !defined(Perl_fp_class_inf) && \
2212   defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2213 #  define Perl_fp_class_inf(x) \
2214     (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2215 #endif
2216
2217 #if !defined(Perl_fp_class_nan) && \
2218   defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2219 #  define Perl_fp_class_nan(x) \
2220     (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2221 #endif
2222
2223 #if !defined(Perl_fp_class_zero) && \
2224   defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2225 #  define Perl_fp_class_zero(x) \
2226     (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2227 #endif
2228
2229 #if !defined(Perl_fp_class_norm) && \
2230   defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2231 #  define Perl_fp_class_norm(x) \
2232     (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2233 #endif
2234
2235 #if !defined(Perl_fp_class_denorm) && \
2236   defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2237 #  define Perl_fp_class_denorm(x) \
2238     (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
2239 #endif
2240
2241 #ifdef UNDER_CE
2242 int isnan(double d);
2243 #endif
2244
2245 #ifndef Perl_isnan
2246 #   ifdef Perl_fp_class_nan
2247 #       define Perl_isnan(x) Perl_fp_class_nan(x)
2248 #   elif defined(HAS_UNORDERED)
2249 #       define Perl_isnan(x) unordered((x), 0.0)
2250 #   else
2251 #       define Perl_isnan(x) ((x)!=(x))
2252 #   endif
2253 #endif
2254
2255 #ifndef Perl_isinf
2256 #   ifdef Perl_fp_class_inf
2257 #       define Perl_isinf(x) Perl_fp_class_inf(x)
2258 #   endif
2259 #endif
2260
2261 #ifndef Perl_isfinite
2262 #   if defined(HAS_ISFINITE) && !defined(isfinite)
2263 #     define Perl_isfinite(x) isfinite((double)(x))
2264 #   elif defined(HAS_FINITE)
2265 #       define Perl_isfinite(x) finite((double)(x))
2266 #   elif defined(Perl_fp_class_finite)
2267 #     define Perl_isfinite(x) Perl_fp_class_finite(x)
2268 #   else
2269 /* For the infinities the multiplication returns nan,
2270  * for the nan the multiplication also returns nan,
2271  * for everything else (that is, finite) zero should be returned. */
2272 #     define Perl_isfinite(x) (((x) * 0) == 0)
2273 #   endif
2274 #endif
2275
2276 #ifndef Perl_isinf
2277 #   if defined(Perl_isfinite) && defined(Perl_isnan)
2278 #       define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2279 #   endif
2280 #endif
2281
2282 /* We need Perl_isfinitel (ends with ell) (if available) even when
2283  * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2284  * needs that. */
2285 #if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2286 /* If isfinite() is a macro and looks like we have C99,
2287  * we assume it's the type-aware C99 isfinite(). */
2288 #    if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
2289 #        define Perl_isfinitel(x) isfinite(x)
2290 #    elif defined(HAS_ISFINITEL)
2291 #        define Perl_isfinitel(x) isfinitel(x)
2292 #    elif defined(HAS_FINITEL)
2293 #        define Perl_isfinitel(x) finitel(x)
2294 #    elif defined(HAS_INFL) && defined(HAS_NANL)
2295 #        define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
2296 #    else
2297 #        define Perl_isfinitel(x) ((x) * 0 == 0)  /* See Perl_isfinite. */
2298 #    endif
2299 #endif
2300
2301 /* The default is to use Perl's own atof() implementation (in numeric.c).
2302  * Usually that is the one to use but for some platforms (e.g. UNICOS)
2303  * it is however best to use the native implementation of atof.
2304  * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2305  * Some good tests to try out with either setting are t/base/num.t,
2306  * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2307  * you may need to be using a different function than atof! */
2308
2309 #ifndef USE_PERL_ATOF
2310 #   ifndef _UNICOS
2311 #       define USE_PERL_ATOF
2312 #   endif
2313 #else
2314 #   if USE_PERL_ATOF == 0
2315 #       undef USE_PERL_ATOF
2316 #   endif
2317 #endif
2318
2319 #ifdef USE_PERL_ATOF
2320 #   define Perl_atof(s) Perl_my_atof(s)
2321 #   define Perl_atof2(s, n) Perl_my_atof2(aTHX_ (s), &(n))
2322 #else
2323 #   define Perl_atof(s) (NV)atof(s)
2324 #   define Perl_atof2(s, n) ((n) = atof(s))
2325 #endif
2326
2327 /*
2328  * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2329  * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2330  * depending on local options. Until Configure detects this (or at least
2331  * detects whether the "signed" keyword is available) the CHAR ranges
2332  * will not be included. UCHAR functions normally.
2333  *                                                           - kja
2334  */
2335
2336 #define PERL_UCHAR_MIN ((unsigned char)0)
2337 #define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2338
2339 #define PERL_USHORT_MIN ((unsigned short)0)
2340 #define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2341
2342 #define PERL_SHORT_MAX ((short)SHRT_MAX)
2343 #define PERL_SHORT_MIN ((short)SHRT_MIN)
2344
2345 #define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2346 #define PERL_UINT_MIN ((unsigned int)0)
2347
2348 #define PERL_INT_MAX ((int)INT_MAX)
2349 #define PERL_INT_MIN ((int)INT_MIN)
2350
2351 #define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2352 #define PERL_ULONG_MIN ((unsigned long)0L)
2353
2354 #define PERL_LONG_MAX ((long)LONG_MAX)
2355 #define PERL_LONG_MIN ((long)LONG_MIN)
2356
2357 #ifdef UV_IS_QUAD
2358 #    define PERL_UQUAD_MAX      (~(UV)0)
2359 #    define PERL_UQUAD_MIN      ((UV)0)
2360 #    define PERL_QUAD_MAX       ((IV) (PERL_UQUAD_MAX >> 1))
2361 #    define PERL_QUAD_MIN       (-PERL_QUAD_MAX - ((3 & -1) == 3))
2362 #endif
2363
2364 typedef MEM_SIZE STRLEN;
2365
2366 typedef struct op OP;
2367 typedef struct cop COP;
2368 typedef struct unop UNOP;
2369 typedef struct unop_aux UNOP_AUX;
2370 typedef struct binop BINOP;
2371 typedef struct listop LISTOP;
2372 typedef struct logop LOGOP;
2373 typedef struct pmop PMOP;
2374 typedef struct svop SVOP;
2375 typedef struct padop PADOP;
2376 typedef struct pvop PVOP;
2377 typedef struct loop LOOP;
2378 typedef struct methop METHOP;
2379
2380 #ifdef PERL_CORE
2381 typedef struct opslab OPSLAB;
2382 typedef struct opslot OPSLOT;
2383 #endif
2384
2385 typedef struct block_hooks BHK;
2386 typedef struct custom_op XOP;
2387
2388 typedef struct interpreter PerlInterpreter;
2389
2390 /* SGI's <sys/sema.h> has struct sv */
2391 #if defined(__sgi)
2392 #   define STRUCT_SV perl_sv
2393 #else
2394 #   define STRUCT_SV sv
2395 #endif
2396 typedef struct STRUCT_SV SV;
2397 typedef struct av AV;
2398 typedef struct hv HV;
2399 typedef struct cv CV;
2400 typedef struct p5rx REGEXP;
2401 typedef struct gp GP;
2402 typedef struct gv GV;
2403 typedef struct io IO;
2404 typedef struct context PERL_CONTEXT;
2405 typedef struct block BLOCK;
2406
2407 typedef struct magic MAGIC;
2408 typedef struct xpv XPV;
2409 typedef struct xpviv XPVIV;
2410 typedef struct xpvuv XPVUV;
2411 typedef struct xpvnv XPVNV;
2412 typedef struct xpvmg XPVMG;
2413 typedef struct xpvlv XPVLV;
2414 typedef struct xpvinvlist XINVLIST;
2415 typedef struct xpvav XPVAV;
2416 typedef struct xpvhv XPVHV;
2417 typedef struct xpvgv XPVGV;
2418 typedef struct xpvcv XPVCV;
2419 typedef struct xpvbm XPVBM;
2420 typedef struct xpvfm XPVFM;
2421 typedef struct xpvio XPVIO;
2422 typedef struct mgvtbl MGVTBL;
2423 typedef union any ANY;
2424 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2425 typedef struct ptr_tbl PTR_TBL_t;
2426 typedef struct clone_params CLONE_PARAMS;
2427
2428 /* a pad is currently just an AV; but that might change,
2429  * so hide the type.  */
2430 typedef struct padlist PADLIST;
2431 typedef AV PAD;
2432 typedef struct padnamelist PADNAMELIST;
2433 typedef struct padname PADNAME;
2434
2435 /* always enable PERL_OP_PARENT  */
2436 #if !defined(PERL_OP_PARENT)
2437 #  define PERL_OP_PARENT
2438 #endif
2439
2440 /* enable PERL_COPY_ON_WRITE by default */
2441 #if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2442 #  define PERL_COPY_ON_WRITE
2443 #endif
2444
2445 #ifdef PERL_COPY_ON_WRITE
2446 #  define PERL_ANY_COW
2447 #else
2448 # define PERL_SAWAMPERSAND
2449 #endif
2450
2451 #if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2452 # error PERL_DEBUG_READONLY_OPS only works with ithreads
2453 #endif
2454
2455 #include "handy.h"
2456 #include "charclass_invlists.h"
2457
2458 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2459 #   if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2460 #       define USE_64_BIT_RAWIO /* implicit */
2461 #   endif
2462 #endif
2463
2464 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2465  * fseeko/ftello if possible.  Don't go #defining ftell to ftello yourself,
2466  * however, because operating systems like to do that themself. */
2467 #ifndef FSEEKSIZE
2468 #   ifdef HAS_FSEEKO
2469 #       define FSEEKSIZE LSEEKSIZE
2470 #   else
2471 #       define FSEEKSIZE LONGSIZE
2472 #   endif
2473 #endif
2474
2475 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2476 #   if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2477 #       define USE_64_BIT_STDIO /* implicit */
2478 #   endif
2479 #endif
2480
2481 #ifdef USE_64_BIT_RAWIO
2482 #   ifdef HAS_OFF64_T
2483 #       undef Off_t
2484 #       define Off_t off64_t
2485 #       undef LSEEKSIZE
2486 #       define LSEEKSIZE 8
2487 #   endif
2488 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2489  * will trigger defines like the ones below.  Some 64-bit environments,
2490  * however, do not.  Therefore we have to explicitly mix and match. */
2491 #   if defined(USE_OPEN64)
2492 #       define open open64
2493 #   endif
2494 #   if defined(USE_LSEEK64)
2495 #       define lseek lseek64
2496 #   else
2497 #       if defined(USE_LLSEEK)
2498 #           define lseek llseek
2499 #       endif
2500 #   endif
2501 #   if defined(USE_STAT64)
2502 #       define stat stat64
2503 #   endif
2504 #   if defined(USE_FSTAT64)
2505 #       define fstat fstat64
2506 #   endif
2507 #   if defined(USE_LSTAT64)
2508 #       define lstat lstat64
2509 #   endif
2510 #   if defined(USE_FLOCK64)
2511 #       define flock flock64
2512 #   endif
2513 #   if defined(USE_LOCKF64)
2514 #       define lockf lockf64
2515 #   endif
2516 #   if defined(USE_FCNTL64)
2517 #       define fcntl fcntl64
2518 #   endif
2519 #   if defined(USE_TRUNCATE64)
2520 #       define truncate truncate64
2521 #   endif
2522 #   if defined(USE_FTRUNCATE64)
2523 #       define ftruncate ftruncate64
2524 #   endif
2525 #endif
2526
2527 #ifdef USE_64_BIT_STDIO
2528 #   ifdef HAS_FPOS64_T
2529 #       undef Fpos_t
2530 #       define Fpos_t fpos64_t
2531 #   endif
2532 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2533  * will trigger defines like the ones below.  Some 64-bit environments,
2534  * however, do not. */
2535 #   if defined(USE_FOPEN64)
2536 #       define fopen fopen64
2537 #   endif
2538 #   if defined(USE_FSEEK64)
2539 #       define fseek fseek64 /* don't do fseeko here, see perlio.c */
2540 #   endif
2541 #   if defined(USE_FTELL64)
2542 #       define ftell ftell64 /* don't do ftello here, see perlio.c */
2543 #   endif
2544 #   if defined(USE_FSETPOS64)
2545 #       define fsetpos fsetpos64
2546 #   endif
2547 #   if defined(USE_FGETPOS64)
2548 #       define fgetpos fgetpos64
2549 #   endif
2550 #   if defined(USE_TMPFILE64)
2551 #       define tmpfile tmpfile64
2552 #   endif
2553 #   if defined(USE_FREOPEN64)
2554 #       define freopen freopen64
2555 #   endif
2556 #endif
2557
2558 #if defined(OS2)
2559 #  include "iperlsys.h"
2560 #endif
2561
2562 #ifdef DOSISH
2563 #   if defined(OS2)
2564 #       include "os2ish.h"
2565 #   else
2566 #       include "dosish.h"
2567 #   endif
2568 #elif defined(VMS)
2569 #   include "vmsish.h"
2570 #elif defined(PLAN9)
2571 #   include "./plan9/plan9ish.h"
2572 #elif defined(__VOS__)
2573 #   ifdef __GNUC__
2574 #     include "./vos/vosish.h"
2575 #   else
2576 #     include "vos/vosish.h"
2577 #   endif
2578 #elif defined(__SYMBIAN32__)
2579 #   include "symbian/symbianish.h"
2580 #elif defined(__HAIKU__)
2581 #   include "haiku/haikuish.h"
2582 #else
2583 #   include "unixish.h"
2584 #endif
2585
2586 #ifdef __amigaos4__
2587 #    include "amigaos.h"
2588 #    undef FD_CLOEXEC /* a lie in AmigaOS */
2589 #endif
2590
2591 /* NSIG logic from Configure --> */
2592 #ifndef NSIG
2593 #  ifdef _NSIG
2594 #    define NSIG (_NSIG)
2595 #  elif defined(SIGMAX)
2596 #    define NSIG (SIGMAX+1)
2597 #  elif defined(SIG_MAX)
2598 #    define NSIG (SIG_MAX+1)
2599 #  elif defined(_SIG_MAX)
2600 #    define NSIG (_SIG_MAX+1)
2601 #  elif defined(MAXSIG)
2602 #    define NSIG (MAXSIG+1)
2603 #  elif defined(MAX_SIG)
2604 #    define NSIG (MAX_SIG+1)
2605 #  elif defined(SIGARRAYSIZE)
2606 #    define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
2607 #  elif defined(_sys_nsig)
2608 #    define NSIG (_sys_nsig) /* Solaris 2.5 */
2609 #  else
2610      /* Default to some arbitrary number that's big enough to get most
2611       * of the common signals.  */
2612 #    define NSIG 50
2613 #  endif
2614 #endif
2615 /* <-- NSIG logic from Configure */
2616
2617 #ifndef NO_ENVIRON_ARRAY
2618 #  define USE_ENVIRON_ARRAY
2619 #endif
2620
2621 /*
2622  * initialise to avoid floating-point exceptions from overflow, etc
2623  */
2624 #ifndef PERL_FPU_INIT
2625 #  ifdef HAS_FPSETMASK
2626 #    if HAS_FLOATINGPOINT_H
2627 #      include <floatingpoint.h>
2628 #    endif
2629 /* Some operating systems have this as a macro, which in turn expands to a comma
2630    expression, and the last sub-expression is something that gets calculated,
2631    and then they have the gall to warn that a value computed is not used. Hence
2632    cast to void.  */
2633 #    define PERL_FPU_INIT (void)fpsetmask(0)
2634 #  elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2635 #    define PERL_FPU_INIT       PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2636 #    define PERL_FPU_PRE_EXEC   { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2637 #    define PERL_FPU_POST_EXEC    rsignal_restore(SIGFPE, &xfpe); }
2638 #  else
2639 #    define PERL_FPU_INIT
2640 #  endif
2641 #endif
2642 #ifndef PERL_FPU_PRE_EXEC
2643 #  define PERL_FPU_PRE_EXEC   {
2644 #  define PERL_FPU_POST_EXEC  }
2645 #endif
2646
2647 /* In Tru64 the cc -ieee enables the IEEE math but disables traps.
2648  * We need to reenable the "invalid" trap because otherwise generation
2649  * of NaN values leaves the IEEE fp flags in bad state, leaving any further
2650  * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
2651 #ifdef __osf__
2652 #  include <machine/fpu.h>
2653 #  define PERL_SYS_FPU_INIT \
2654      STMT_START { \
2655          ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
2656          signal(SIGFPE, SIG_IGN); \
2657      } STMT_END
2658 #endif
2659 /* In IRIX the default for Flush to Zero bit is true,
2660  * which means that results going below the minimum of normal
2661  * floating points go to zero, instead of going denormal/subnormal.
2662  * This is unlike almost any other system running Perl, so let's clear it.
2663  * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
2664  * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
2665  *
2666  * XXX The flush-to-zero behaviour should be a Configure scan.
2667  * To change the behaviour usually requires some system-specific
2668  * incantation, though, like the below. */
2669 #ifdef __sgi
2670 #  include <sys/fpu.h>
2671 #  define PERL_SYS_FPU_INIT \
2672      STMT_START { \
2673          union fpc_csr csr; \
2674          csr.fc_word = get_fpc_csr(); \
2675          csr.fc_struct.flush = 0; \
2676          set_fpc_csr(csr.fc_word); \
2677      } STMT_END
2678 #endif
2679
2680 #ifndef PERL_SYS_FPU_INIT
2681 #  define PERL_SYS_FPU_INIT NOOP
2682 #endif
2683
2684 #ifndef PERL_SYS_INIT3_BODY
2685 #  define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
2686 #endif
2687
2688 /*
2689 =head1 Miscellaneous Functions
2690
2691 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
2692 Provides system-specific tune up of the C runtime environment necessary to
2693 run Perl interpreters.  This should be called only once, before creating
2694 any Perl interpreters.
2695
2696 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
2697 Provides system-specific tune up of the C runtime environment necessary to
2698 run Perl interpreters.  This should be called only once, before creating
2699 any Perl interpreters.
2700
2701 =for apidoc Am|void|PERL_SYS_TERM|
2702 Provides system-specific clean up of the C runtime environment after
2703 running Perl interpreters.  This should be called only once, after
2704 freeing any remaining Perl interpreters.
2705
2706 =cut
2707  */
2708
2709 #define PERL_SYS_INIT(argc, argv)       Perl_sys_init(argc, argv)
2710 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
2711 #define PERL_SYS_TERM()                 Perl_sys_term()
2712
2713 #ifndef PERL_WRITE_MSG_TO_CONSOLE
2714 #  define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
2715 #endif
2716
2717 #ifndef MAXPATHLEN
2718 #  ifdef PATH_MAX
2719 #    ifdef _POSIX_PATH_MAX
2720 #       if PATH_MAX > _POSIX_PATH_MAX
2721 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
2722  * included the null byte or not.  Later amendments of POSIX,
2723  * XPG4, the Austin Group, and the Single UNIX Specification
2724  * all explicitly include the null byte in the PATH_MAX.
2725  * Ditto for _POSIX_PATH_MAX. */
2726 #         define MAXPATHLEN PATH_MAX
2727 #       else
2728 #         define MAXPATHLEN _POSIX_PATH_MAX
2729 #       endif
2730 #    else
2731 #      define MAXPATHLEN (PATH_MAX+1)
2732 #    endif
2733 #  else
2734 #    define MAXPATHLEN 1024     /* Err on the large side. */
2735 #  endif
2736 #endif
2737
2738 /* In case Configure was not used (we are using a "canned config"
2739  * such as Win32, or a cross-compilation setup, for example) try going
2740  * by the gcc major and minor versions.  One useful URL is
2741  * http://www.ohse.de/uwe/articles/gcc-attributes.html,
2742  * but contrary to this information warn_unused_result seems
2743  * not to be in gcc 3.3.5, at least. --jhi
2744  * Also, when building extensions with an installed perl, this allows
2745  * the user to upgrade gcc and get the right attributes, rather than
2746  * relying on the list generated at Configure time.  --AD
2747  * Set these up now otherwise we get confused when some of the <*thread.h>
2748  * includes below indirectly pull in <perlio.h> (which needs to know if we
2749  * have HASATTRIBUTE_FORMAT).
2750  */
2751
2752 #ifndef PERL_MICRO
2753 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
2754 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
2755 #    define HASATTRIBUTE_DEPRECATED
2756 #  endif
2757 #  if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
2758 #    define HASATTRIBUTE_FORMAT
2759 #    if defined __MINGW32__
2760 #      define PRINTF_FORMAT_NULL_OK
2761 #    endif
2762 #  endif
2763 #  if __GNUC__ >= 3 /* 3.0 -> */
2764 #    define HASATTRIBUTE_MALLOC
2765 #  endif
2766 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
2767 #    define HASATTRIBUTE_NONNULL
2768 #  endif
2769 #  if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
2770 #    define HASATTRIBUTE_NORETURN
2771 #  endif
2772 #  if __GNUC__ >= 3 /* gcc 3.0 -> */
2773 #    define HASATTRIBUTE_PURE
2774 #  endif
2775 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2776 #    define HASATTRIBUTE_UNUSED
2777 #  endif
2778 #  if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
2779 #    define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
2780 #  endif
2781 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2782 #    define HASATTRIBUTE_WARN_UNUSED_RESULT
2783 #  endif
2784 #endif
2785 #endif /* #ifndef PERL_MICRO */
2786
2787 /* USE_5005THREADS needs to be after unixish.h as <pthread.h> includes
2788  * <sys/signal.h> which defines NSIG - which will stop inclusion of <signal.h>
2789  * this results in many functions being undeclared which bothers C++
2790  * May make sense to have threads after "*ish.h" anyway
2791  */
2792
2793 /* clang Thread Safety Analysis/Annotations/Attributes
2794  * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
2795  *
2796  * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
2797  * Apple XCode hijacks __clang_major__ and __clang_minor__
2798  * (6.1 means really clang 3.6), so needs extra hijinks
2799  * (could probably also test the contents of __apple_build_version__).
2800  */
2801 #if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
2802     defined(__clang__) && \
2803     !defined(PERL_GLOBAL_STRUCT) && \
2804     !defined(PERL_GLOBAL_STRUCT_PRIVATE) && \
2805     !defined(SWIG) && \
2806   ((!defined(__apple_build_version__) &&               \
2807     ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
2808      (__clang_major__ >= 4))) || \
2809    (defined(__apple_build_version__) &&                \
2810     ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
2811      (__clang_major__ >= 7))))
2812 #  define PERL_TSA__(x)   __attribute__((x))
2813 #  define PERL_TSA_ACTIVE
2814 #else
2815 #  define PERL_TSA__(x)   /* No TSA, make TSA attributes no-ops. */
2816 #  undef PERL_TSA_ACTIVE
2817 #endif
2818
2819 /* PERL_TSA_CAPABILITY() is used to annotate typedefs.
2820  * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
2821  */
2822 #define PERL_TSA_CAPABILITY(x) \
2823     PERL_TSA__(capability(x))
2824
2825 /* In the below examples the mutex must be lexically visible, usually
2826  * either as global variables, or as function arguments. */
2827
2828 /* PERL_TSA_GUARDED_BY() is used to annotate global variables.
2829  *
2830  * Foo foo PERL_TSA_GUARDED_BY(mutex);
2831  */
2832 #define PERL_TSA_GUARDED_BY(x) \
2833     PERL_TSA__(guarded_by(x))
2834
2835 /* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
2836  * The data _behind_ the pointer is guarded.
2837  *
2838  * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
2839  */
2840 #define PERL_TSA_PT_GUARDED_BY(x) \
2841     PERL_TSA__(pt_guarded_by(x))
2842
2843 /* PERL_TSA_REQUIRES() is used to annotate functions.
2844  * The caller MUST hold the resource when calling the function.
2845  *
2846  * void Foo() PERL_TSA_REQUIRES(mutex);
2847  */
2848 #define PERL_TSA_REQUIRES(x) \
2849     PERL_TSA__(requires_capability(x))
2850
2851 /* PERL_TSA_EXCLUDES() is used to annotate functions.
2852  * The caller MUST NOT hold resource when calling the function.
2853  *
2854  * EXCLUDES should be used when the function first acquires
2855  * the resource and then releases it.  Use to avoid deadlock.
2856  *
2857  * void Foo() PERL_TSA_EXCLUDES(mutex);
2858  */
2859 #define PERL_TSA_EXCLUDES(x) \
2860     PERL_TSA__(locks_excluded(x))
2861
2862 /* PERL_TSA_ACQUIRE() is used to annotate functions.
2863  * The caller MUST NOT hold the resource when calling the function,
2864  * and the function will acquire the resource.
2865  *
2866  * void Foo() PERL_TSA_ACQUIRE(mutex);
2867  */
2868 #define PERL_TSA_ACQUIRE(x) \
2869     PERL_TSA__(acquire_capability(x))
2870
2871 /* PERL_TSA_RELEASE() is used to annotate functions.
2872  * The caller MUST hold the resource when calling the function,
2873  * and the function will release the resource.
2874  *
2875  * void Foo() PERL_TSA_RELEASE(mutex);
2876  */
2877 #define PERL_TSA_RELEASE(x) \
2878     PERL_TSA__(release_capability(x))
2879
2880 /* PERL_TSA_NO_TSA is used to annotate functions.
2881  * Used when being intentionally unsafe, or when the code is too
2882  * complicated for the analysis.  Use sparingly.
2883  *
2884  * void Foo() PERL_TSA_NO_TSA;
2885  */
2886 #define PERL_TSA_NO_TSA \
2887     PERL_TSA__(no_thread_safety_analysis)
2888
2889 /* There are more annotations/attributes available, see the clang
2890  * documentation for details. */
2891
2892 #if defined(USE_ITHREADS)
2893 #  ifdef NETWARE
2894 #    include <nw5thread.h>
2895 #  elif defined(WIN32)
2896 #    include <win32thread.h>
2897 #  elif defined(OS2)
2898 #    include "os2thread.h"
2899 #  elif defined(I_MACH_CTHREADS)
2900 #    include <mach/cthreads.h>
2901 typedef cthread_t       perl_os_thread;
2902 typedef mutex_t         perl_mutex;
2903 typedef condition_t     perl_cond;
2904 typedef void *          perl_key;
2905 #  elif defined(I_PTHREAD) /* Posix threads */
2906 #    include <pthread.h>
2907 typedef pthread_t       perl_os_thread;
2908 typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
2909 typedef pthread_cond_t  perl_cond;
2910 typedef pthread_key_t   perl_key;
2911 #  endif
2912 #endif /* USE_ITHREADS */
2913
2914 #ifdef PERL_TSA_ACTIVE
2915 /* Since most pthread mutex interfaces have not been annotated, we
2916  * need to have these wrappers. The NO_TSA annotation is quite ugly
2917  * but it cannot be avoided in plain C, unlike in C++, where one could
2918  * e.g. use ACQUIRE() with no arg on a mutex lock method.
2919  *
2920  * The bodies of these wrappers are in util.c
2921  *
2922  * TODO: however, some platforms are starting to get these clang
2923  * thread safety annotations for pthreads, for example FreeBSD.
2924  * Do we need a way to a bypass these wrappers? */
2925 EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
2926   PERL_TSA_ACQUIRE(*mutex)
2927   PERL_TSA_NO_TSA;
2928 EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
2929   PERL_TSA_RELEASE(*mutex)
2930   PERL_TSA_NO_TSA;
2931 #endif
2932
2933 #if defined(WIN32)
2934 #  include "win32.h"
2935 #endif
2936
2937 #ifdef NETWARE
2938 #  include "netware.h"
2939 #endif
2940
2941 #define STATUS_UNIX     PL_statusvalue
2942 #ifdef VMS
2943 #   define STATUS_NATIVE        PL_statusvalue_vms
2944 /*
2945  * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
2946  * its contents can not be trusted.  Unfortunately, Perl seems to check
2947  * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
2948  * be updated also.
2949  */
2950 #  include <stsdef.h>
2951 #  include <ssdef.h>
2952 /* Presume this because if VMS changes it, it will require a new
2953  * set of APIs for waiting on children for binary compatibility.
2954  */
2955 #  define child_offset_bits (8)
2956 #  ifndef C_FAC_POSIX
2957 #  define C_FAC_POSIX 0x35A000
2958 #  endif
2959
2960 /*  STATUS_EXIT - validates and returns a NATIVE exit status code for the
2961  * platform from the existing UNIX or Native status values.
2962  */
2963
2964 #   define STATUS_EXIT \
2965         (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
2966            (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
2967
2968
2969 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
2970  * exit code and shifts the UNIX value over the correct number of bits to
2971  * be a child status.  Usually the number of bits is 8, but that could be
2972  * platform dependent.  The NATIVE status code is presumed to have either
2973  * from a child process.
2974  */
2975
2976 /* This is complicated.  The child processes return a true native VMS
2977    status which must be saved.  But there is an assumption in Perl that
2978    the UNIX child status has some relationship to errno values, so
2979    Perl tries to translate it to text in some of the tests.
2980    In order to get the string translation correct, for the error, errno
2981    must be EVMSERR, but that generates a different text message
2982    than what the test programs are expecting.  So an errno value must
2983    be derived from the native status value when an error occurs.
2984    That will hide the true native status message.  With this version of
2985    perl, the true native child status can always be retrieved so that
2986    is not a problem.  But in this case, Pl_statusvalue and errno may
2987    have different values in them.
2988  */
2989
2990 #   define STATUS_NATIVE_CHILD_SET(n) \
2991         STMT_START {                                                    \
2992             I32 evalue = (I32)n;                                        \
2993             if (evalue == EVMSERR) {                                    \
2994               PL_statusvalue_vms = vaxc$errno;                          \
2995               PL_statusvalue = evalue;                                  \
2996             } else {                                                    \
2997               PL_statusvalue_vms = evalue;                              \
2998               if (evalue == -1) {                                       \
2999                 PL_statusvalue = -1;                                    \
3000                 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3001               } else                                                    \
3002                 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1);    \
3003               set_vaxc_errno(evalue);                                   \
3004               if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX)    \
3005                   set_errno(EVMSERR);                                   \
3006               else set_errno(Perl_vms_status_to_unix(evalue, 0));       \
3007               PL_statusvalue = PL_statusvalue << child_offset_bits;     \
3008             }                                                           \
3009         } STMT_END
3010
3011 #   ifdef VMSISH_STATUS
3012 #       define STATUS_CURRENT   (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
3013 #   else
3014 #       define STATUS_CURRENT   STATUS_UNIX
3015 #   endif
3016
3017   /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3018    * the NATIVE status to an equivalent value.  Can not be used to translate
3019    * exit code values as exit code values are not guaranteed to have any
3020    * relationship at all to errno values.
3021    * This is used when Perl is forcing errno to have a specific value.
3022    */
3023 #   define STATUS_UNIX_SET(n)                           \
3024         STMT_START {                                    \
3025             I32 evalue = (I32)n;                        \
3026             PL_statusvalue = evalue;                    \
3027             if (PL_statusvalue != -1) {                 \
3028                 if (PL_statusvalue != EVMSERR) {        \
3029                   PL_statusvalue &= 0xFFFF;             \
3030                   if (MY_POSIX_EXIT)                    \
3031                     PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3032                   else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3033                 }                                       \
3034                 else {                                  \
3035                   PL_statusvalue_vms = vaxc$errno;      \
3036                 }                                       \
3037             }                                           \
3038             else PL_statusvalue_vms = SS$_ABORT;        \
3039             set_vaxc_errno(PL_statusvalue_vms);         \
3040         } STMT_END
3041
3042   /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
3043    * the NATIVE error status based on it.
3044    *
3045    * When in the default mode to comply with the Perl VMS documentation,
3046    * 0 is a success and any other code sets the NATIVE status to a failure
3047    * code of SS$_ABORT.
3048    *
3049    * In the new POSIX EXIT mode, native status will be set so that the
3050    * actual exit code will can be retrieved by the calling program or
3051    * shell.
3052    *
3053    * If the exit code is not clearly a UNIX parent or child exit status,
3054    * it will be passed through as a VMS status.
3055    */
3056
3057 #   define STATUS_UNIX_EXIT_SET(n)                      \
3058         STMT_START {                                    \
3059             I32 evalue = (I32)n;                        \
3060             PL_statusvalue = evalue;                    \
3061             if (MY_POSIX_EXIT) { \
3062               if (evalue <= 0xFF00) {           \
3063                   if (evalue > 0xFF)                    \
3064                     evalue = (evalue >> child_offset_bits) & 0xFF; \
3065                   PL_statusvalue_vms =          \
3066                     (C_FAC_POSIX | (evalue << 3 ) |     \
3067                     ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3068               } else /* forgive them Perl, for they have sinned */ \
3069                 PL_statusvalue_vms = evalue; \
3070             } else { \
3071               if (evalue == 0)                  \
3072                 PL_statusvalue_vms = SS$_NORMAL;        \
3073               else if (evalue <= 0xFF00) \
3074                 PL_statusvalue_vms = SS$_ABORT; \
3075               else { /* forgive them Perl, for they have sinned */ \
3076                   if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3077                   else PL_statusvalue_vms = vaxc$errno; \
3078                   /* And obviously used a VMS status value instead of UNIX */ \
3079                   PL_statusvalue = EVMSERR;             \
3080               } \
3081               set_vaxc_errno(PL_statusvalue_vms);       \
3082             }                                           \
3083         } STMT_END
3084
3085
3086   /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3087    * and sets the NATIVE error status based on it.  This special case
3088    * is needed to maintain compatibility with past VMS behavior.
3089    *
3090    * In the default mode on VMS, this number is passed through as
3091    * both the NATIVE and UNIX status.  Which makes it different
3092    * that the STATUS_UNIX_EXIT_SET.
3093    *
3094    * In the new POSIX EXIT mode, native status will be set so that the
3095    * actual exit code will can be retrieved by the calling program or
3096    * shell.
3097    *
3098    * A POSIX exit code is from 0 to 255.  If the exit code is higher
3099    * than this, it needs to be assumed that it is a VMS exit code and
3100    * passed through.
3101    */
3102
3103 #   define STATUS_EXIT_SET(n)                           \
3104         STMT_START {                                    \
3105             I32 evalue = (I32)n;                        \
3106             PL_statusvalue = evalue;                    \
3107             if (MY_POSIX_EXIT)                          \
3108                 if (evalue > 255) PL_statusvalue_vms = evalue; else {   \
3109                   PL_statusvalue_vms = \
3110                     (C_FAC_POSIX | (evalue << 3 ) |     \
3111                      ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
3112             else                                        \
3113                 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3114             set_vaxc_errno(PL_statusvalue_vms);         \
3115         } STMT_END
3116
3117
3118  /* This macro forces a success status */
3119 #   define STATUS_ALL_SUCCESS   \
3120         (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
3121
3122  /* This macro forces a failure status */
3123 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, \
3124      vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3125         (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3126
3127 #elif defined(__amigaos4__)
3128  /* A somewhat experimental attempt to simulate posix return code values */
3129 #   define STATUS_NATIVE        PL_statusvalue_posix
3130 #   define STATUS_NATIVE_CHILD_SET(n)                      \
3131         STMT_START {                                       \
3132             PL_statusvalue_posix = (n);                    \
3133             if (PL_statusvalue_posix < 0) {                \
3134                 PL_statusvalue = -1;                       \
3135             }                                              \
3136             else {                                         \
3137                 PL_statusvalue = n << 8;                   \
3138             }                                              \
3139         } STMT_END
3140 #   define STATUS_UNIX_SET(n)           \
3141         STMT_START {                    \
3142             PL_statusvalue = (n);               \
3143             if (PL_statusvalue != -1)   \
3144                 PL_statusvalue &= 0xFFFF;       \
3145         } STMT_END
3146 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3147 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3148 #   define STATUS_CURRENT STATUS_UNIX
3149 #   define STATUS_EXIT STATUS_UNIX
3150 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3151 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3152
3153 #else
3154 #   define STATUS_NATIVE        PL_statusvalue_posix
3155 #   if defined(WCOREDUMP)
3156 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3157             STMT_START {                                   \
3158                 PL_statusvalue_posix = (n);                \
3159                 if (PL_statusvalue_posix == -1)            \
3160                     PL_statusvalue = -1;                   \
3161                 else {                                     \
3162                     PL_statusvalue =                       \
3163                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3164                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3165                         (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0);  \
3166                 }                                          \
3167             } STMT_END
3168 #   elif defined(WIFEXITED)
3169 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3170             STMT_START {                                   \
3171                 PL_statusvalue_posix = (n);                \
3172                 if (PL_statusvalue_posix == -1)            \
3173                     PL_statusvalue = -1;                   \
3174                 else {                                     \
3175                     PL_statusvalue =                       \
3176                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3177                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0);  \
3178                 }                                          \
3179             } STMT_END
3180 #   else
3181 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3182             STMT_START {                                   \
3183                 PL_statusvalue_posix = (n);                \
3184                 if (PL_statusvalue_posix == -1)            \
3185                     PL_statusvalue = -1;                   \
3186                 else {                                     \
3187                     PL_statusvalue =                       \
3188                         PL_statusvalue_posix & 0xFFFF;     \
3189                 }                                          \
3190             } STMT_END
3191 #   endif
3192 #   define STATUS_UNIX_SET(n)           \
3193         STMT_START {                    \
3194             PL_statusvalue = (n);               \
3195             if (PL_statusvalue != -1)   \
3196                 PL_statusvalue &= 0xFFFF;       \
3197         } STMT_END
3198 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3199 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3200 #   define STATUS_CURRENT STATUS_UNIX
3201 #   define STATUS_EXIT STATUS_UNIX
3202 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3203 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3204 #endif
3205
3206 /* flags in PL_exit_flags for nature of exit() */
3207 #define PERL_EXIT_EXPECTED      0x01
3208 #define PERL_EXIT_DESTRUCT_END  0x02  /* Run END in perl_destruct */
3209 #define PERL_EXIT_WARN          0x04  /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3210 #define PERL_EXIT_ABORT         0x08  /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3211
3212 #ifndef PERL_CORE
3213 /* format to use for version numbers in file/directory names */
3214 /* XXX move to Configure? */
3215 /* This was only ever used for the current version, and that can be done at
3216    compile time, as PERL_FS_VERSION, so should we just delete it?  */
3217 #  ifndef PERL_FS_VER_FMT
3218 #    define PERL_FS_VER_FMT     "%d.%d.%d"
3219 #  endif
3220 #endif
3221
3222 #ifndef PERL_FS_VERSION
3223 #  define PERL_FS_VERSION       PERL_VERSION_STRING
3224 #endif
3225
3226 /* This defines a way to flush all output buffers.  This may be a
3227  * performance issue, so we allow people to disable it.  Also, if
3228  * we are using stdio, there are broken implementations of fflush(NULL)
3229  * out there, Solaris being the most prominent.
3230  */
3231 #ifndef PERL_FLUSHALL_FOR_CHILD
3232 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3233 #  define PERL_FLUSHALL_FOR_CHILD       PerlIO_flush((PerlIO*)NULL)
3234 # elif defined(FFLUSH_ALL)
3235 #  define PERL_FLUSHALL_FOR_CHILD       my_fflush_all()
3236 # else
3237 #  define PERL_FLUSHALL_FOR_CHILD       NOOP
3238 # endif
3239 #endif
3240
3241 #ifndef PERL_WAIT_FOR_CHILDREN
3242 #  define PERL_WAIT_FOR_CHILDREN        NOOP
3243 #endif
3244
3245 /* the traditional thread-unsafe notion of "current interpreter". */
3246 #ifndef PERL_SET_INTERP
3247 #  define PERL_SET_INTERP(i)            (PL_curinterp = (PerlInterpreter*)(i))
3248 #endif
3249
3250 #ifndef PERL_GET_INTERP
3251 #  define PERL_GET_INTERP               (PL_curinterp)
3252 #endif
3253
3254 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3255 #  ifdef MULTIPLICITY
3256 #    define PERL_GET_THX                ((PerlInterpreter *)PERL_GET_CONTEXT)
3257 #  endif
3258 #  define PERL_SET_THX(t)               PERL_SET_CONTEXT(t)
3259 #endif
3260
3261 /*
3262     This replaces the previous %_ "hack" by the "%p" hacks.
3263     All that is required is that the perl source does not
3264     use "%-p" or "%-<number>p" or "%<number>p" formats.
3265     These formats will still work in perl code.
3266     See comments in sv.c for further details.
3267
3268     Robin Barker 2005-07-14
3269
3270     No longer use %1p for VDf = %vd.  RMB 2007-10-19
3271 */
3272
3273 #ifndef SVf_
3274 #  define SVf_(n) "-" STRINGIFY(n) "p"
3275 #endif
3276
3277 #ifndef SVf
3278 #  define SVf "-p"
3279 #endif
3280
3281 #ifndef SVf32
3282 #  define SVf32 SVf_(32)
3283 #endif
3284
3285 #ifndef SVf256
3286 #  define SVf256 SVf_(256)
3287 #endif
3288
3289 #define SVfARG(p) ((void*)(p))
3290
3291 #ifndef HEKf
3292 #  define HEKf "2p"
3293 #endif
3294
3295 /* Not ideal, but we cannot easily include a number in an already-numeric
3296  * format sequence. */
3297 #ifndef HEKf256
3298 #  define HEKf256 "3p"
3299 #endif
3300
3301 #define HEKfARG(p) ((void*)(p))
3302
3303 /* Takes three arguments: is_utf8, length, str */
3304 #ifndef UTF8f
3305 #  define UTF8f "d%" UVuf "%4p"
3306 #endif
3307 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3308
3309 #define PNf UTF8f
3310 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
3311
3312 #ifdef PERL_CORE
3313 /* not used; but needed for backward compatibility with XS code? - RMB */
3314 #  undef UVf
3315 #elif !defined(UVf)
3316 #  define UVf UVuf
3317 #endif
3318
3319 #ifdef HASATTRIBUTE_DEPRECATED
3320 #  define __attribute__deprecated__         __attribute__((deprecated))
3321 #endif
3322 #ifdef HASATTRIBUTE_FORMAT
3323 #  define __attribute__format__(x,y,z)      __attribute__((format(x,y,z)))
3324 #endif
3325 #ifdef HASATTRIBUTE_MALLOC
3326 #  define __attribute__malloc__             __attribute__((__malloc__))
3327 #endif
3328 #ifdef HASATTRIBUTE_NONNULL
3329 #  define __attribute__nonnull__(a)         __attribute__((nonnull(a)))
3330 #endif
3331 #ifdef HASATTRIBUTE_NORETURN
3332 #  define __attribute__noreturn__           __attribute__((noreturn))
3333 #endif
3334 #ifdef HASATTRIBUTE_PURE
3335 #  define __attribute__pure__               __attribute__((pure))
3336 #endif
3337 #ifdef HASATTRIBUTE_UNUSED
3338 #  define __attribute__unused__             __attribute__((unused))
3339 #endif
3340 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
3341 #  define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
3342 #endif
3343
3344 /* If we haven't defined the attributes yet, define them to blank. */
3345 #ifndef __attribute__deprecated__
3346 #  define __attribute__deprecated__
3347 #endif
3348 #ifndef __attribute__format__
3349 #  define __attribute__format__(x,y,z)
3350 #endif
3351 #ifndef __attribute__malloc__
3352 #  define __attribute__malloc__
3353 #endif
3354 #ifndef __attribute__nonnull__
3355 #  define __attribute__nonnull__(a)
3356 #endif
3357 #ifndef __attribute__noreturn__
3358 #  define __attribute__noreturn__
3359 #endif
3360 #ifndef __attribute__pure__
3361 #  define __attribute__pure__
3362 #endif
3363 #ifndef __attribute__unused__
3364 #  define __attribute__unused__
3365 #endif
3366 #ifndef __attribute__warn_unused_result__
3367 #  define __attribute__warn_unused_result__
3368 #endif
3369
3370 #if !defined(DEBUGGING) && !defined(NDEBUG)
3371 #  define NDEBUG 1
3372 #endif
3373 #include <assert.h>
3374
3375 /* For functions that are marked as __attribute__noreturn__, it's not
3376    appropriate to call return.  In either case, include the lint directive.
3377  */
3378 #ifdef HASATTRIBUTE_NORETURN
3379 #  define NORETURN_FUNCTION_END NOT_REACHED;
3380 #else
3381 #  define NORETURN_FUNCTION_END NOT_REACHED; return 0
3382 #endif
3383
3384 /* Some OS warn on NULL format to printf */
3385 #ifdef PRINTF_FORMAT_NULL_OK
3386 #  define __attribute__format__null_ok__(x,y,z)  __attribute__format__(x,y,z)
3387 #else
3388 #  define __attribute__format__null_ok__(x,y,z)
3389 #endif
3390
3391 #ifdef HAS_BUILTIN_EXPECT
3392 #  define EXPECT(expr,val)                  __builtin_expect(expr,val)
3393 #else
3394 #  define EXPECT(expr,val)                  (expr)
3395 #endif
3396 #define LIKELY(cond)                        EXPECT(cBOOL(cond),TRUE)
3397 #define UNLIKELY(cond)                      EXPECT(cBOOL(cond),FALSE)
3398 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3399 /* placeholder */
3400 #endif
3401
3402 /* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
3403    time invariants. That is, their argument must be a constant expression that
3404    can be verified by the compiler. This expression can contain anything that's
3405    known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3406    the expression evaluates to 0, compilation fails.
3407    Because they generate no runtime code (i.e.  their use is "free"), they're
3408    always active, even under non-DEBUGGING builds.
3409    STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
3410    file scope (outside of any function).
3411    STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3412    function.
3413 */
3414 #if (defined(static_assert) || (defined(__cplusplus) && __cplusplus >= 201103L)) && (!defined(__IBMC__) || __IBMC__ >= 1210)
3415 /* static_assert is a macro defined in <assert.h> in C11 or a compiler
3416    builtin in C++11.  But IBM XL C V11 does not support _Static_assert, no
3417    matter what <assert.h> says.
3418 */
3419 #  define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
3420 #else
3421 /* We use a bit-field instead of an array because gcc accepts
3422    'typedef char x[n]' where n is not a compile-time constant.
3423    We want to enforce constantness.
3424 */
3425 #  define STATIC_ASSERT_2(COND, SUFFIX) \
3426     typedef struct { \
3427         unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3428     } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3429 #  define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
3430 #  define STATIC_ASSERT_DECL(COND)    STATIC_ASSERT_1(COND, __LINE__)
3431 #endif
3432 /* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3433    error (static_assert is a declaration, and only statements can have labels).
3434 */
3435 #define STATIC_ASSERT_STMT(COND)      STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
3436
3437 #ifndef __has_builtin
3438 #  define __has_builtin(x) 0 /* not a clang style compiler */
3439 #endif
3440
3441 /* ASSUME is like assert(), but it has a benefit in a release build. It is a
3442    hint to a compiler about a statement of fact in a function call free
3443    expression, which allows the compiler to generate better machine code.
3444    In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3445    the control path is unreachable. In a for loop, ASSUME can be used to hint
3446    that a loop will run at least X times. ASSUME is based off MSVC's __assume
3447    intrinsic function, see its documents for more details.
3448 */
3449
3450 #ifndef DEBUGGING
3451 #  if __has_builtin(__builtin_unreachable) \
3452      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4) /* 4.5 -> */
3453 #    define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3454 #  elif defined(_MSC_VER)
3455 #    define ASSUME(x) __assume(x)
3456 #  elif defined(__ARMCC_VERSION) /* untested */
3457 #    define ASSUME(x) __promise(x)
3458 #  else
3459 /* a random compiler might define assert to its own special optimization token
3460    so pass it through to C lib as a last resort */
3461 #    define ASSUME(x) assert(x)
3462 #  endif
3463 #else
3464 #  define ASSUME(x) assert(x)
3465 #endif
3466
3467 #if defined(__sun)      /* ASSUME() generates warnings on Solaris */
3468 #  define NOT_REACHED
3469 #elif defined(DEBUGGING) && (__has_builtin(__builtin_unreachable) \
3470      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4)) /* 4.5 -> */
3471 #  define NOT_REACHED STMT_START { ASSUME(0); __builtin_unreachable(); } STMT_END
3472 #else
3473 #  define NOT_REACHED ASSUME(0)
3474 #endif
3475
3476 /* Some unistd.h's give a prototype for pause() even though
3477    HAS_PAUSE ends up undefined.  This causes the #define
3478    below to be rejected by the compiler.  Sigh.
3479 */
3480 #ifdef HAS_PAUSE
3481 #define Pause   pause
3482 #else
3483 #define Pause() sleep((32767<<16)+32767)
3484 #endif
3485
3486 #ifndef IOCPARM_LEN
3487 #   ifdef IOCPARM_MASK
3488         /* on BSDish systems we're safe */
3489 #       define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
3490 #   elif defined(_IOC_SIZE) && defined(__GLIBC__)
3491         /* on Linux systems we're safe; except when we're not [perl #38223] */
3492 #       define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3493 #   else
3494         /* otherwise guess at what's safe */
3495 #       define IOCPARM_LEN(x)   256
3496 #   endif
3497 #endif
3498
3499 #if defined(__CYGWIN__)
3500 /* USEMYBINMODE
3501  *   This symbol, if defined, indicates that the program should
3502  *   use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3503  *   that a file is in "binary" mode -- that is, that no translation
3504  *   of bytes occurs on read or write operations.
3505  */
3506 #  define USEMYBINMODE /**/
3507 #  include <io.h> /* for setmode() prototype */
3508 #  define my_binmode(fp, iotype, mode) \
3509             cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
3510 #endif
3511
3512 #ifdef __CYGWIN__
3513 void init_os_extras(void);
3514 #endif
3515
3516 #ifdef UNION_ANY_DEFINITION
3517 UNION_ANY_DEFINITION;
3518 #else
3519 union any {
3520     void*       any_ptr;
3521     SV*         any_sv;
3522     SV**        any_svp;
3523     GV*         any_gv;
3524     AV*         any_av;
3525     HV*         any_hv;
3526     OP*         any_op;
3527     char*       any_pv;
3528     char**      any_pvp;
3529     I32         any_i32;
3530     U32         any_u32;
3531     IV          any_iv;
3532     UV          any_uv;
3533     long        any_long;
3534     bool        any_bool;
3535     void        (*any_dptr) (void*);
3536     void        (*any_dxptr) (pTHX_ void*);
3537 };
3538 #endif
3539
3540 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3541
3542 #define FILTER_READ(idx, sv, len)  filter_read(idx, sv, len)
3543 #define FILTER_DATA(idx) \
3544             (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3545 #define FILTER_ISREADER(idx) \
3546             (PL_parser && PL_parser->rsfp_filters \
3547                 && idx >= AvFILLp(PL_parser->rsfp_filters))
3548 #define PERL_FILTER_EXISTS(i) \
3549             (PL_parser && PL_parser->rsfp_filters \
3550                 && (i) <= av_tindex(PL_parser->rsfp_filters))
3551
3552 #if defined(_AIX) && !defined(_AIX43)
3553 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3554 /* We cannot include <crypt.h> to get the struct crypt_data
3555  * because of setkey prototype problems when threading */
3556 typedef        struct crypt_data {     /* straight from /usr/include/crypt.h */
3557     /* From OSF, Not needed in AIX
3558        char C[28], D[28];
3559     */
3560     char E[48];
3561     char KS[16][48];
3562     char block[66];
3563     char iobuf[16];
3564 } CRYPTD;
3565 #endif /* threading */
3566 #endif /* AIX */
3567
3568 #ifndef PERL_CALLCONV
3569 #  ifdef __cplusplus
3570 #    define PERL_CALLCONV extern "C"
3571 #  else
3572 #    define PERL_CALLCONV
3573 #  endif
3574 #endif
3575 #ifndef PERL_CALLCONV_NO_RET
3576 #    define PERL_CALLCONV_NO_RET PERL_CALLCONV
3577 #endif
3578
3579 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
3580    dont have a noreturn as a declaration specifier
3581 */
3582 #ifndef PERL_STATIC_NO_RET
3583 #  define PERL_STATIC_NO_RET STATIC
3584 #endif
3585 /* PERL_STATIC_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE on
3586    builds that dont have a noreturn as a declaration specifier
3587 */
3588 #ifndef PERL_STATIC_INLINE_NO_RET
3589 #  define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
3590 #endif
3591
3592 #if !defined(OS2)
3593 #  include "iperlsys.h"
3594 #endif
3595
3596 #ifdef __LIBCATAMOUNT__
3597 #undef HAS_PASSWD  /* unixish.h but not unixish enough. */
3598 #undef HAS_GROUP
3599 #define FAKE_BIT_BUCKET
3600 #endif
3601
3602 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3603  * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
3604  * Configure, despite their names being similar to other defines like
3605  * USE_ITHREADS.  Configure in fact knows nothing about the randomised
3606  * hashes.  Therefore to enable/disable the hash randomisation defines
3607  * use the Configure -Accflags=... instead. */
3608 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
3609 #  define USE_HASH_SEED
3610 #endif
3611
3612 #include "perly.h"
3613
3614
3615 /* macros to define bit-fields in structs. */
3616 #ifndef PERL_BITFIELD8
3617 #  define PERL_BITFIELD8 unsigned
3618 #endif
3619 #ifndef PERL_BITFIELD16
3620 #  define PERL_BITFIELD16 unsigned
3621 #endif
3622 #ifndef PERL_BITFIELD32
3623 #  define PERL_BITFIELD32 unsigned
3624 #endif
3625
3626 #include "sv.h"
3627 #include "regexp.h"
3628 #include "util.h"
3629 #include "form.h"
3630 #include "gv.h"
3631 #include "pad.h"
3632 #include "cv.h"
3633 #include "opnames.h"
3634 #include "op.h"
3635 #include "hv.h"
3636 #include "cop.h"
3637 #include "av.h"
3638 #include "mg.h"
3639 #include "scope.h"
3640 #include "warnings.h"
3641 #include "utf8.h"
3642
3643 /* these would be in doio.h if there was such a file */
3644 #define my_stat()  my_stat_flags(SV_GMAGIC)
3645 #define my_lstat() my_lstat_flags(SV_GMAGIC)
3646
3647 /* defined in sv.c, but also used in [ach]v.c */
3648 #undef _XPV_HEAD
3649 #undef _XPVMG_HEAD
3650 #undef _XPVCV_COMMON
3651
3652 #include "parser.h"
3653
3654 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
3655
3656 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3657
3658 /* These have to be predeclared, as they are used in proto.h which is #included
3659  * before their definitions in regcomp.h. */
3660
3661 struct scan_data_t;
3662 typedef struct regnode_charclass regnode_charclass;
3663
3664 struct regnode_charclass_class;
3665
3666 /* A hopefully less confusing name.  The sub-classes are all Posix classes only
3667  * used under /l matching */
3668 typedef struct regnode_charclass_class regnode_charclass_posixl;
3669
3670 typedef struct regnode_ssc regnode_ssc;
3671 typedef struct RExC_state_t RExC_state_t;
3672 struct _reg_trie_data;
3673
3674 #endif
3675
3676 struct ptr_tbl_ent {
3677     struct ptr_tbl_ent*         next;
3678     const void*                 oldval;
3679     void*                       newval;
3680 };
3681
3682 struct ptr_tbl {
3683     struct ptr_tbl_ent**        tbl_ary;
3684     UV                          tbl_max;
3685     UV                          tbl_items;
3686     struct ptr_tbl_arena        *tbl_arena;
3687     struct ptr_tbl_ent          *tbl_arena_next;
3688     struct ptr_tbl_ent          *tbl_arena_end;
3689 };
3690
3691 #if defined(htonl) && !defined(HAS_HTONL)
3692 #define HAS_HTONL
3693 #endif
3694 #if defined(htons) && !defined(HAS_HTONS)
3695 #define HAS_HTONS
3696 #endif
3697 #if defined(ntohl) && !defined(HAS_NTOHL)
3698 #define HAS_NTOHL
3699 #endif
3700 #if defined(ntohs) && !defined(HAS_NTOHS)
3701 #define HAS_NTOHS
3702 #endif
3703 #ifndef HAS_HTONL
3704 #define HAS_HTONS
3705 #define HAS_HTONL
3706 #define HAS_NTOHS
3707 #define HAS_NTOHL
3708 #  if (BYTEORDER & 0xffff) == 0x4321
3709 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
3710    re-order their values. However, to behave identically to the alternative
3711    implementations, they should truncate to the correct size.  */
3712 #    define ntohl(x)    ((x)&0xFFFFFFFF)
3713 #    define htonl(x)    ntohl(x)
3714 #    define ntohs(x)    ((x)&0xFFFF)
3715 #    define htons(x)    ntohs(x)
3716 #  elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3717
3718 /* Note that we can't straight out declare our own htonl and htons because
3719    the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
3720    to avoid the overhead of initialising the socket subsystem, but the headers
3721    that *declare* the various functions are still seen. If we declare our own
3722    htonl etc they will clash with the declarations in the Win32 headers.  */
3723
3724 PERL_STATIC_INLINE U32
3725 my_swap32(const U32 x) {
3726     return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)
3727         | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
3728 }
3729
3730 PERL_STATIC_INLINE U16
3731 my_swap16(const U16 x) {
3732     return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
3733 }
3734
3735 #    define htonl(x)    my_swap32(x)
3736 #    define ntohl(x)    my_swap32(x)
3737 #    define ntohs(x)    my_swap16(x)
3738 #    define htons(x)    my_swap16(x)
3739 #  else
3740 #    error "Unsupported byteorder"
3741 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
3742    the error message. Please check the value of the macro BYTEORDER, as defined
3743    in config.h. The values of BYTEORDER we expect are
3744
3745             big endian  little endian
3746    32 bit       0x4321  0x1234
3747    64 bit   0x87654321  0x12345678
3748
3749    If you have a system with a different byte order, please see
3750    pod/perlhack.pod for how to submit a patch to add supporting code.
3751 */
3752 #  endif
3753 #endif
3754
3755 /*
3756  * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
3757  * -DWS
3758  */
3759 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3760 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
3761    re-order their values. However, to behave identically to the alternative
3762    implementations, they should truncate to the correct size.  */
3763 #  define vtohl(x)      ((x)&0xFFFFFFFF)
3764 #  define vtohs(x)      ((x)&0xFFFF)
3765 #  define htovl(x)      vtohl(x)
3766 #  define htovs(x)      vtohs(x)
3767 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
3768 #  define vtohl(x)      ((((x)&0xFF)<<24)       \
3769                         +(((x)>>24)&0xFF)       \
3770                         +(((x)&0x0000FF00)<<8)  \
3771                         +(((x)&0x00FF0000)>>8)  )
3772 #  define vtohs(x)      ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
3773 #  define htovl(x)      vtohl(x)
3774 #  define htovs(x)      vtohs(x)
3775 #else
3776 #  error "Unsupported byteorder"
3777 /* If you have need for current perl on PDP-11 or similar, and can help test
3778    that blead keeps working on a mixed-endian system, then see
3779    pod/perlhack.pod for how to submit patches to things working again.  */
3780 #endif
3781
3782 /* *MAX Plus 1. A floating point value.
3783    Hopefully expressed in a way that dodgy floating point can't mess up.
3784    >> 2 rather than 1, so that value is safely less than I32_MAX after 1
3785    is added to it
3786    May find that some broken compiler will want the value cast to I32.
3787    [after the shift, as signed >> may not be as secure as unsigned >>]
3788 */
3789 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
3790 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
3791 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
3792    0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
3793    may be greater than sizeof(IV), so don't assume that half max UV is max IV.
3794 */
3795 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
3796
3797 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
3798 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
3799 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
3800
3801 /* This may look like unnecessary jumping through hoops, but converting
3802    out of range floating point values to integers *is* undefined behaviour,
3803    and it is starting to bite.
3804 */
3805 #ifndef CAST_INLINE
3806 #define I_32(what) (cast_i32((NV)(what)))
3807 #define U_32(what) (cast_ulong((NV)(what)))
3808 #define I_V(what) (cast_iv((NV)(what)))
3809 #define U_V(what) (cast_uv((NV)(what)))
3810 #else
3811 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
3812                   : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
3813                      : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
3814 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
3815                   : ((n) < U32_MAX_P1 ? (U32) (n) \
3816                      : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
3817 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
3818                   : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
3819                      : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
3820 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
3821                   : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
3822                      : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
3823 #endif
3824
3825 #define U_S(what) ((U16)U_32(what))
3826 #define U_I(what) ((unsigned int)U_32(what))
3827 #define U_L(what) U_32(what)
3828
3829 #ifdef HAS_SIGNBIT
3830 #  define Perl_signbit signbit
3831 #endif
3832
3833 /* These do not care about the fractional part, only about the range. */
3834 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
3835 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
3836
3837 /* Used with UV/IV arguments: */
3838                                         /* XXXX: need to speed it up */
3839 #define CLUMP_2UV(iv)   ((iv) < 0 ? 0 : (UV)(iv))
3840 #define CLUMP_2IV(uv)   ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
3841
3842 #ifndef MAXSYSFD
3843 #   define MAXSYSFD 2
3844 #endif
3845
3846 #ifndef __cplusplus
3847 #if !(defined(WIN32) || defined(UNDER_CE) || defined(SYMBIAN))
3848 Uid_t getuid (void);
3849 Uid_t geteuid (void);
3850 Gid_t getgid (void);
3851 Gid_t getegid (void);
3852 #endif
3853 #endif
3854
3855 #ifndef Perl_debug_log
3856 #  define Perl_debug_log        PerlIO_stderr()
3857 #endif
3858
3859 #ifndef Perl_error_log
3860 #  define Perl_error_log        (PL_stderrgv                    \
3861                                  && isGV(PL_stderrgv)           \
3862                                  && GvIOp(PL_stderrgv)          \
3863                                  && IoOFP(GvIOp(PL_stderrgv))   \
3864                                  ? IoOFP(GvIOp(PL_stderrgv))    \
3865                                  : PerlIO_stderr())
3866 #endif
3867
3868
3869 #define DEBUG_p_FLAG            0x00000001 /*      1 */
3870 #define DEBUG_s_FLAG            0x00000002 /*      2 */
3871 #define DEBUG_l_FLAG            0x00000004 /*      4 */
3872 #define DEBUG_t_FLAG            0x00000008 /*      8 */
3873 #define DEBUG_o_FLAG            0x00000010 /*     16 */
3874 #define DEBUG_c_FLAG            0x00000020 /*     32 */
3875 #define DEBUG_P_FLAG            0x00000040 /*     64 */
3876 #define DEBUG_m_FLAG            0x00000080 /*    128 */
3877 #define DEBUG_f_FLAG            0x00000100 /*    256 */
3878 #define DEBUG_r_FLAG            0x00000200 /*    512 */
3879 #define DEBUG_x_FLAG            0x00000400 /*   1024 */
3880 #define DEBUG_u_FLAG            0x00000800 /*   2048 */
3881 /* U is reserved for Unofficial, exploratory hacking */
3882 #define DEBUG_U_FLAG            0x00001000 /*   4096 */
3883 /* spare                                        8192 */
3884 #define DEBUG_X_FLAG            0x00004000 /*  16384 */
3885 #define DEBUG_D_FLAG            0x00008000 /*  32768 */
3886 #define DEBUG_S_FLAG            0x00010000 /*  65536 */
3887 #define DEBUG_T_FLAG            0x00020000 /* 131072 */
3888 #define DEBUG_R_FLAG            0x00040000 /* 262144 */
3889 #define DEBUG_J_FLAG            0x00080000 /* 524288 */
3890 #define DEBUG_v_FLAG            0x00100000 /*1048576 */
3891 #define DEBUG_C_FLAG            0x00200000 /*2097152 */
3892 #define DEBUG_A_FLAG            0x00400000 /*4194304 */
3893 #define DEBUG_q_FLAG            0x00800000 /*8388608 */
3894 #define DEBUG_M_FLAG            0x01000000 /*16777216*/
3895 #define DEBUG_B_FLAG            0x02000000 /*33554432*/
3896 #define DEBUG_L_FLAG            0x04000000 /*67108864*/
3897 #define DEBUG_i_FLAG            0x08000000 /*134217728*/
3898 #define DEBUG_MASK              0x0FFFEFFF /* mask of all the standard flags */
3899
3900 #define DEBUG_DB_RECURSE_FLAG   0x40000000
3901 #define DEBUG_TOP_FLAG          0x80000000 /* -D was given --> PL_debug |= FLAG */
3902
3903 #  define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
3904 #  define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
3905 #  define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
3906 #  define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
3907 #  define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
3908 #  define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
3909 #  define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
3910 #  define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
3911 #  define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
3912 #  define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
3913 #  define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
3914 #  define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
3915 #  define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
3916 #  define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
3917 #  define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
3918 #  define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
3919 #  define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
3920 #  define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
3921 #  define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
3922 #  define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
3923 #  define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
3924 #  define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
3925 #  define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
3926 #  define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
3927 #  define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
3928 #  define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
3929 #  define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
3930 #  define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
3931 #  define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
3932 #  define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
3933 #  define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
3934
3935 #ifdef DEBUGGING
3936
3937 #  define DEBUG_p_TEST DEBUG_p_TEST_
3938 #  define DEBUG_s_TEST DEBUG_s_TEST_
3939 #  define DEBUG_l_TEST DEBUG_l_TEST_
3940 #  define DEBUG_t_TEST DEBUG_t_TEST_
3941 #  define DEBUG_o_TEST DEBUG_o_TEST_
3942 #  define DEBUG_c_TEST DEBUG_c_TEST_
3943 #  define DEBUG_P_TEST DEBUG_P_TEST_
3944 #  define DEBUG_m_TEST DEBUG_m_TEST_
3945 #  define DEBUG_f_TEST DEBUG_f_TEST_
3946 #  define DEBUG_r_TEST DEBUG_r_TEST_
3947 #  define DEBUG_x_TEST DEBUG_x_TEST_
3948 #  define DEBUG_u_TEST DEBUG_u_TEST_
3949 #  define DEBUG_U_TEST DEBUG_U_TEST_
3950 #  define DEBUG_X_TEST DEBUG_X_TEST_
3951 #  define DEBUG_D_TEST DEBUG_D_TEST_
3952 #  define DEBUG_S_TEST DEBUG_S_TEST_
3953 #  define DEBUG_T_TEST DEBUG_T_TEST_
3954 #  define DEBUG_R_TEST DEBUG_R_TEST_
3955 #  define DEBUG_J_TEST DEBUG_J_TEST_
3956 #  define DEBUG_v_TEST DEBUG_v_TEST_
3957 #  define DEBUG_C_TEST DEBUG_C_TEST_
3958 #  define DEBUG_A_TEST DEBUG_A_TEST_
3959 #  define DEBUG_q_TEST DEBUG_q_TEST_
3960 #  define DEBUG_M_TEST DEBUG_M_TEST_
3961 #  define DEBUG_B_TEST DEBUG_B_TEST_
3962 #  define DEBUG_L_TEST DEBUG_L_TEST_
3963 #  define DEBUG_i_TEST DEBUG_i_TEST_
3964 #  define DEBUG_Xv_TEST DEBUG_Xv_TEST_
3965 #  define DEBUG_Uv_TEST DEBUG_Uv_TEST_
3966 #  define DEBUG_Pv_TEST DEBUG_Pv_TEST_
3967 #  define DEBUG_Lv_TEST DEBUG_Lv_TEST_
3968
3969 #  define PERL_DEB(a)                  a
3970 #  define PERL_DEB2(a,b)               a
3971 #  define PERL_DEBUG(a) if (PL_debug)  a
3972 #  define DEBUG_p(a) if (DEBUG_p_TEST) a
3973 #  define DEBUG_s(a) if (DEBUG_s_TEST) a
3974 #  define DEBUG_l(a) if (DEBUG_l_TEST) a
3975 #  define DEBUG_t(a) if (DEBUG_t_TEST) a
3976 #  define DEBUG_o(a) if (DEBUG_o_TEST) a
3977 #  define DEBUG_c(a) if (DEBUG_c_TEST) a
3978 #  define DEBUG_P(a) if (DEBUG_P_TEST) a
3979
3980      /* Temporarily turn off memory debugging in case the a
3981       * does memory allocation, either directly or indirectly. */
3982 #  define DEBUG_m(a)  \
3983     STMT_START {                                                        \
3984         if (PERL_GET_INTERP) {                                          \
3985                                 dTHX;                                   \
3986                                 if (DEBUG_m_TEST) {                     \
3987                                     PL_debug &= ~DEBUG_m_FLAG;          \
3988                                     a;                                  \
3989                                     PL_debug |= DEBUG_m_FLAG;           \
3990                                 }                                       \
3991                               }                                         \
3992     } STMT_END
3993
3994 #  define DEBUG__(t, a)                                                 \
3995         STMT_START {                                                    \
3996                 if (t) STMT_START {a;} STMT_END;                        \
3997         } STMT_END
3998
3999 #  define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
4000
4001 #ifndef PERL_EXT_RE_BUILD
4002 #  define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
4003 #else
4004 #  define DEBUG_r(a) STMT_START {a;} STMT_END
4005 #endif /* PERL_EXT_RE_BUILD */
4006
4007 #  define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
4008 #  define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
4009 #  define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
4010 #  define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
4011 #  define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
4012 #  define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
4013 #  define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
4014 #  define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
4015 #  define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
4016
4017 #  define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
4018 #  define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
4019 #  define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
4020 #  define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
4021 #  define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
4022 #  define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
4023 #  define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
4024 #  define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
4025 #  define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
4026 #  define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
4027 #  define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
4028
4029 #else /* DEBUGGING */
4030
4031 #  define DEBUG_p_TEST (0)
4032 #  define DEBUG_s_TEST (0)
4033 #  define DEBUG_l_TEST (0)
4034 #  define DEBUG_t_TEST (0)
4035 #  define DEBUG_o_TEST (0)
4036 #  define DEBUG_c_TEST (0)
4037 #  define DEBUG_P_TEST (0)
4038 #  define DEBUG_m_TEST (0)
4039 #  define DEBUG_f_TEST (0)
4040 #  define DEBUG_r_TEST (0)
4041 #  define DEBUG_x_TEST (0)
4042 #  define DEBUG_u_TEST (0)
4043 #  define DEBUG_U_TEST (0)
4044 #  define DEBUG_X_TEST (0)
4045 #  define DEBUG_D_TEST (0)
4046 #  define DEBUG_S_TEST (0)
4047 #  define DEBUG_T_TEST (0)
4048 #  define DEBUG_R_TEST (0)
4049 #  define DEBUG_J_TEST (0)
4050 #  define DEBUG_v_TEST (0)
4051 #  define DEBUG_C_TEST (0)
4052 #  define DEBUG_A_TEST (0)
4053 #  define DEBUG_q_TEST (0)
4054 #  define DEBUG_M_TEST (0)
4055 #  define DEBUG_B_TEST (0)
4056 #  define DEBUG_L_TEST (0)
4057 #  define DEBUG_i_TEST (0)
4058 #  define DEBUG_Xv_TEST (0)
4059 #  define DEBUG_Uv_TEST (0)
4060 #  define DEBUG_Pv_TEST (0)
4061 #  define DEBUG_Lv_TEST (0)
4062
4063 #  define PERL_DEB(a)
4064 #  define PERL_DEB2(a,b)               b
4065 #  define PERL_DEBUG(a)
4066 #  define DEBUG_p(a)
4067 #  define DEBUG_s(a)
4068 #  define DEBUG_l(a)
4069 #  define DEBUG_t(a)
4070 #  define DEBUG_o(a)
4071 #  define DEBUG_c(a)
4072 #  define DEBUG_P(a)
4073 #  define DEBUG_m(a)
4074 #  define DEBUG_f(a)
4075 #  define DEBUG_r(a)
4076 #  define DEBUG_x(a)
4077 #  define DEBUG_u(a)
4078 #  define DEBUG_U(a)
4079 #  define DEBUG_X(a)
4080 #  define DEBUG_D(a)
4081 #  define DEBUG_S(a)
4082 #  define DEBUG_T(a)
4083 #  define DEBUG_R(a)
4084 #  define DEBUG_v(a)
4085 #  define DEBUG_C(a)
4086 #  define DEBUG_A(a)
4087 #  define DEBUG_q(a)
4088 #  define DEBUG_M(a)
4089 #  define DEBUG_B(a)
4090 #  define DEBUG_L(a)
4091 #  define DEBUG_i(a)
4092 #  define DEBUG_Xv(a)
4093 #  define DEBUG_Uv(a)
4094 #  define DEBUG_Pv(a)
4095 #  define DEBUG_Lv(a)
4096 #endif /* DEBUGGING */
4097
4098
4099 #define DEBUG_SCOPE(where) \
4100     DEBUG_l( \
4101     Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n",   \
4102                     where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
4103                     __FILE__, __LINE__));
4104
4105 /* Keep the old croak based assert for those who want it, and as a fallback if
4106    the platform is so heretically non-ANSI that it can't assert.  */
4107
4108 #define Perl_assert(what)       PERL_DEB2(                              \
4109         ((what) ? ((void) 0) :                                          \
4110             (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
4111                         "\", line %d", STRINGIFY(what), __LINE__),      \
4112              (void) 0)), ((void)0))
4113
4114 /* assert() gets defined if DEBUGGING.
4115  * If no DEBUGGING, the <assert.h> has not been included. */
4116 #ifndef assert
4117 #  define assert(what)  Perl_assert(what)
4118 #endif
4119 #ifdef DEBUGGING
4120 #  define assert_(what) assert(what),
4121 #else
4122 #  define assert_(what)
4123 #endif
4124
4125 struct ufuncs {
4126     I32 (*uf_val)(pTHX_ IV, SV*);
4127     I32 (*uf_set)(pTHX_ IV, SV*);
4128     IV uf_index;
4129 };
4130
4131 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4132  * XS code wanting to be backward compatible can do something
4133  * like the following:
4134
4135 #ifndef PERL_MG_UFUNC
4136 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4137 #endif
4138
4139 static PERL_MG_UFUNC(foo_get, index, val)
4140 {
4141     sv_setsv(val, ...);
4142     return TRUE;
4143 }
4144
4145 -- Doug MacEachern
4146
4147 */
4148
4149 #ifndef PERL_MG_UFUNC
4150 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4151 #endif
4152
4153 #include <math.h>
4154 #ifdef __VMS
4155      /* isfinite and others are here rather than in math.h as C99 stipulates */
4156 #    include <fp.h>
4157 #endif
4158
4159 #ifndef __cplusplus
4160 #  if !defined(WIN32) && !defined(VMS)
4161 #ifndef crypt
4162 char *crypt (const char*, const char*);
4163 #endif
4164 #  endif /* !WIN32 */
4165 #  ifndef WIN32
4166 #    ifndef getlogin
4167 char *getlogin (void);
4168 #    endif
4169 #  endif /* !WIN32 */
4170 #endif /* !__cplusplus */
4171
4172 /* Fixme on VMS.  This needs to be a run-time, not build time options */
4173 /* Also rename() is affected by this */
4174 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4175 #define UNLINK unlnk
4176 I32 unlnk (pTHX_ const char*);
4177 #else
4178 #define UNLINK PerlLIO_unlink
4179 #endif
4180
4181 /* some versions of glibc are missing the setresuid() proto */
4182 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4183 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4184 #endif
4185 /* some versions of glibc are missing the setresgid() proto */
4186 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4187 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4188 #endif
4189
4190 #ifndef HAS_SETREUID
4191 #  ifdef HAS_SETRESUID
4192 #    define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4193 #    define HAS_SETREUID
4194 #  endif
4195 #endif
4196 #ifndef HAS_SETREGID
4197 #  ifdef HAS_SETRESGID
4198 #    define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4199 #    define HAS_SETREGID
4200 #  endif
4201 #endif
4202
4203 /* Sighandler_t defined in iperlsys.h */
4204
4205 #ifdef HAS_SIGACTION
4206 typedef struct sigaction Sigsave_t;
4207 #else
4208 typedef Sighandler_t Sigsave_t;
4209 #endif
4210
4211 #define SCAN_DEF 0
4212 #define SCAN_TR 1
4213 #define SCAN_REPL 2
4214
4215 #ifdef DEBUGGING
4216 # ifndef register
4217 #  define register
4218 # endif
4219 # define RUNOPS_DEFAULT Perl_runops_debug
4220 #else
4221 # define RUNOPS_DEFAULT Perl_runops_standard
4222 #endif
4223
4224 #if defined(USE_PERLIO)
4225 EXTERN_C void PerlIO_teardown(void);
4226 # ifdef USE_ITHREADS
4227 #  define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4228 #  define PERLIO_TERM                           \
4229         STMT_START {                            \
4230                 PerlIO_teardown();              \
4231                 MUTEX_DESTROY(&PL_perlio_mutex);\
4232         } STMT_END
4233 # else
4234 #  define PERLIO_INIT
4235 #  define PERLIO_TERM   PerlIO_teardown()
4236 # endif
4237 #else
4238 #  define PERLIO_INIT
4239 #  define PERLIO_TERM
4240 #endif
4241
4242 #ifdef MYMALLOC
4243 #  ifdef MUTEX_INIT_CALLS_MALLOC
4244 #    define MALLOC_INIT                                 \
4245         STMT_START {                                    \
4246                 PL_malloc_mutex = NULL;                 \
4247                 MUTEX_INIT(&PL_malloc_mutex);           \
4248         } STMT_END
4249 #    define MALLOC_TERM                                 \
4250         STMT_START {                                    \
4251                 perl_mutex tmp = PL_malloc_mutex;       \
4252                 PL_malloc_mutex = NULL;                 \
4253                 MUTEX_DESTROY(&tmp);                    \
4254         } STMT_END
4255 #  else
4256 #    define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4257 #    define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4258 #  endif
4259 #else
4260 #  define MALLOC_INIT
4261 #  define MALLOC_TERM
4262 #endif
4263
4264 #if defined(PERL_IMPLICIT_CONTEXT)
4265
4266 struct perl_memory_debug_header;
4267 struct perl_memory_debug_header {
4268   tTHX  interpreter;
4269 #  if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4270   MEM_SIZE size;
4271 #  endif
4272   struct perl_memory_debug_header *prev;
4273   struct perl_memory_debug_header *next;
4274 #  ifdef PERL_DEBUG_READONLY_COW
4275   bool readonly;
4276 #  endif
4277 };
4278
4279 #elif defined(PERL_DEBUG_READONLY_COW)
4280
4281 struct perl_memory_debug_header;
4282 struct perl_memory_debug_header {
4283   MEM_SIZE size;
4284 };
4285
4286 #endif
4287
4288 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4289
4290 #  define PERL_MEMORY_DEBUG_HEADER_SIZE \
4291         (sizeof(struct perl_memory_debug_header) + \
4292         (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4293          %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4294
4295 #else
4296 #  define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4297 #endif
4298
4299 #ifdef PERL_TRACK_MEMPOOL
4300 # ifdef PERL_DEBUG_READONLY_COW
4301 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4302         STMT_START {                                            \
4303                 (header).interpreter = (interp);                \
4304                 (header).prev = (header).next = &(header);      \
4305                 (header).readonly = 0;                          \
4306         } STMT_END
4307 # else
4308 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4309         STMT_START {                                            \
4310                 (header).interpreter = (interp);                \
4311                 (header).prev = (header).next = &(header);      \
4312         } STMT_END
4313 # endif
4314 # else
4315 #  define INIT_TRACK_MEMPOOL(header, interp)
4316 #endif
4317
4318 #ifdef I_MALLOCMALLOC
4319 /* Needed for malloc_size(), malloc_good_size() on some systems */
4320 #  include <malloc/malloc.h>
4321 #endif
4322
4323 #ifdef MYMALLOC
4324 #  define Perl_safesysmalloc_size(where)        Perl_malloced_size(where)
4325 #else
4326 #  if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4327 #    ifdef PERL_TRACK_MEMPOOL
4328 #       define Perl_safesysmalloc_size(where)                   \
4329             (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4330 #    else
4331 #       define Perl_safesysmalloc_size(where) malloc_size(where)
4332 #    endif
4333 #  endif
4334 #  ifdef HAS_MALLOC_GOOD_SIZE
4335 #    ifdef PERL_TRACK_MEMPOOL
4336 #       define Perl_malloc_good_size(how_much)                  \
4337             (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4338 #    else
4339 #       define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4340 #    endif
4341 #  else
4342 /* Having this as the identity operation makes some code simpler.  */
4343 #       define Perl_malloc_good_size(how_much)  (how_much)
4344 #  endif
4345 #endif
4346
4347 typedef int (*runops_proc_t)(pTHX);
4348 typedef void (*share_proc_t) (pTHX_ SV *sv);
4349 typedef int  (*thrhook_proc_t) (pTHX);
4350 typedef OP* (*PPADDR_t[]) (pTHX);
4351 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4352 typedef void (*despatch_signals_proc_t) (pTHX);
4353
4354 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4355 #  include <crt_externs.h>      /* for the env array */
4356 #  define environ (*_NSGetEnviron())
4357 #elif defined(USE_ENVIRON_ARRAY) && !defined(environ)
4358    /* VMS and some other platforms don't use the environ array */
4359 EXTERN_C char **environ;  /* environment variables supplied via exec */
4360 #endif
4361
4362 #define PERL_PATCHLEVEL_H_IMPLICIT
4363 #include "patchlevel.h"
4364 #undef PERL_PATCHLEVEL_H_IMPLICIT
4365
4366 #define PERL_VERSION_STRING     STRINGIFY(PERL_REVISION) "." \
4367                                 STRINGIFY(PERL_VERSION) "." \
4368                                 STRINGIFY(PERL_SUBVERSION)
4369
4370 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4371                                 STRINGIFY(PERL_API_VERSION) "." \
4372                                 STRINGIFY(PERL_API_SUBVERSION)
4373
4374 START_EXTERN_C
4375
4376 /* handy constants */
4377 EXTCONST char PL_warn_uninit[]
4378   INIT("Use of uninitialized value%s%s%s");
4379 EXTCONST char PL_warn_uninit_sv[]
4380   INIT("Use of uninitialized value%" SVf "%s%s");
4381 EXTCONST char PL_warn_nosemi[]
4382   INIT("Semicolon seems to be missing");
4383 EXTCONST char PL_warn_reserved[]
4384   INIT("Unquoted string \"%s\" may clash with future reserved word");
4385 EXTCONST char PL_warn_nl[]
4386   INIT("Unsuccessful %s on filename containing newline");
4387 EXTCONST char PL_no_wrongref[]
4388   INIT("Can't use %s ref as %s ref");
4389 /* The core no longer needs this here. If you require the string constant,
4390    please inline a copy into your own code.  */
4391 EXTCONST char PL_no_symref[] __attribute__deprecated__
4392   INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4393 EXTCONST char PL_no_symref_sv[]
4394   INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4395
4396 EXTCONST char PL_no_usym[]
4397   INIT("Can't use an undefined value as %s reference");
4398 EXTCONST char PL_no_aelem[]
4399   INIT("Modification of non-creatable array value attempted, subscript %d");
4400 EXTCONST char PL_no_helem_sv[]
4401   INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4402 EXTCONST char PL_no_modify[]
4403   INIT("Modification of a read-only value attempted");
4404 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4405   INIT("Out of memory!\n");
4406 EXTCONST char PL_no_security[]
4407   INIT("Insecure dependency in %s%s");
4408 EXTCONST char PL_no_sock_func[]
4409   INIT("Unsupported socket function \"%s\" called");
4410 EXTCONST char PL_no_dir_func[]
4411   INIT("Unsupported directory function \"%s\" called");
4412 EXTCONST char PL_no_func[]
4413   INIT("The %s function is unimplemented");
4414 EXTCONST char PL_no_myglob[]
4415   INIT("\"%s\" %se %s can't be in a package");
4416 EXTCONST char PL_no_localize_ref[]
4417   INIT("Can't localize through a reference");
4418 EXTCONST char PL_memory_wrap[]
4419   INIT("panic: memory wrap");
4420
4421 EXTCONST char PL_Yes[]
4422   INIT("1");
4423 EXTCONST char PL_No[]
4424   INIT("");
4425 EXTCONST char PL_Zero[]
4426   INIT("0");
4427 EXTCONST char PL_hexdigit[]
4428   INIT("0123456789abcdef0123456789ABCDEF");
4429
4430 /* This is constant on most architectures, a global on OS/2 */
4431 #ifndef OS2
4432 EXTCONST char PL_sh_path[]
4433   INIT(SH_PATH); /* full path of shell */
4434 #endif
4435
4436 #ifdef CSH
4437 EXTCONST char PL_cshname[]
4438   INIT(CSH);
4439 #  define PL_cshlen     (sizeof(CSH "") - 1)
4440 #endif
4441
4442 /* These are baked at compile time into any shared perl library.
4443    In future releases this will allow us in main() to sanity test the
4444    library we're linking against.  */
4445
4446 EXTCONST U8 PL_revision
4447   INIT(PERL_REVISION);
4448 EXTCONST U8 PL_version
4449   INIT(PERL_VERSION);
4450 EXTCONST U8 PL_subversion
4451   INIT(PERL_SUBVERSION);
4452
4453 EXTCONST char PL_uuemap[65]
4454   INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4455
4456 /* a special string address whose value is "isa", but which perl knows
4457  * to treat as if it were really "DOES" when printing the method name in
4458  *  the "Can't call method '%s'" error message */
4459 EXTCONST char PL_isa_DOES[]
4460   INIT("isa");
4461
4462 #ifdef DOINIT
4463 EXTCONST char PL_uudmap[256] =
4464 #  ifdef PERL_MICRO
4465 #    include "uuudmap.h"
4466 #  else
4467 #    include "uudmap.h"
4468 #  endif
4469 ;
4470 EXTCONST char PL_bitcount[256] =
4471 #  ifdef PERL_MICRO
4472 #    include "ubitcount.h"
4473 #else
4474 #    include "bitcount.h"
4475 #  endif
4476 ;
4477 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4478 EXTCONST int         PL_sig_num[]  = { SIG_NUM };
4479 #else
4480 EXTCONST char PL_uudmap[256];
4481 EXTCONST char PL_bitcount[256];
4482 EXTCONST char* const PL_sig_name[];
4483 EXTCONST int         PL_sig_num[];
4484 #endif
4485
4486 /* fast conversion and case folding tables.  The folding tables complement the
4487  * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4488  * folds such as outside the range or to multiple characters. */
4489
4490 #ifdef DOINIT
4491 #ifndef EBCDIC
4492
4493 /* The EBCDIC fold table depends on the code page, and hence is found in
4494  * utfebcdic.h */
4495
4496 EXTCONST  unsigned char PL_fold[] = {
4497         0,      1,      2,      3,      4,      5,      6,      7,
4498         8,      9,      10,     11,     12,     13,     14,     15,
4499         16,     17,     18,     19,     20,     21,     22,     23,
4500         24,     25,     26,     27,     28,     29,     30,     31,
4501         32,     33,     34,     35,     36,     37,     38,     39,
4502         40,     41,     42,     43,     44,     45,     46,     47,
4503         48,     49,     50,     51,     52,     53,     54,     55,
4504         56,     57,     58,     59,     60,     61,     62,     63,
4505         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4506         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4507         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4508         'x',    'y',    'z',    91,     92,     93,     94,     95,
4509         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4510         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4511         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4512         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4513         128,    129,    130,    131,    132,    133,    134,    135,
4514         136,    137,    138,    139,    140,    141,    142,    143,
4515         144,    145,    146,    147,    148,    149,    150,    151,
4516         152,    153,    154,    155,    156,    157,    158,    159,
4517         160,    161,    162,    163,    164,    165,    166,    167,
4518         168,    169,    170,    171,    172,    173,    174,    175,
4519         176,    177,    178,    179,    180,    181,    182,    183,
4520         184,    185,    186,    187,    188,    189,    190,    191,
4521         192,    193,    194,    195,    196,    197,    198,    199,
4522         200,    201,    202,    203,    204,    205,    206,    207,
4523         208,    209,    210,    211,    212,    213,    214,    215,
4524         216,    217,    218,    219,    220,    221,    222,    223,
4525         224,    225,    226,    227,    228,    229,    230,    231,
4526         232,    233,    234,    235,    236,    237,    238,    239,
4527         240,    241,    242,    243,    244,    245,    246,    247,
4528         248,    249,    250,    251,    252,    253,    254,    255
4529 };
4530 EXTCONST  unsigned char PL_fold_latin1[] = {
4531     /* Full latin1 complement folding, except for three problematic code points:
4532      *  Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4533      *  fold complements outside the Latin1 range, so can't match something
4534      *  that isn't in utf8.
4535      *  German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4536      *  not one, so can't be represented in this table.
4537      *
4538      * All have to be specially handled */
4539         0,      1,      2,      3,      4,      5,      6,      7,
4540         8,      9,      10,     11,     12,     13,     14,     15,
4541         16,     17,     18,     19,     20,     21,     22,     23,
4542         24,     25,     26,     27,     28,     29,     30,     31,
4543         32,     33,     34,     35,     36,     37,     38,     39,
4544         40,     41,     42,     43,     44,     45,     46,     47,
4545         48,     49,     50,     51,     52,     53,     54,     55,
4546         56,     57,     58,     59,     60,     61,     62,     63,
4547         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4548         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4549         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4550         'x',    'y',    'z',    91,     92,     93,     94,     95,
4551         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4552         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4553         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4554         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4555         128,    129,    130,    131,    132,    133,    134,    135,
4556         136,    137,    138,    139,    140,    141,    142,    143,
4557         144,    145,    146,    147,    148,    149,    150,    151,
4558         152,    153,    154,    155,    156,    157,    158,    159,
4559         160,    161,    162,    163,    164,    165,    166,    167,
4560         168,    169,    170,    171,    172,    173,    174,    175,
4561         176,    177,    178,    179,    180,    181 /*micro */, 182,    183,
4562         184,    185,    186,    187,    188,    189,    190,    191,
4563         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4564         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4565         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4566         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
4567         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4568         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4569         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4570         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
4571         255 /* y with diaeresis */
4572 };
4573
4574 /* If these tables are accessed through ebcdic, the access will be converted to
4575  * latin1 first */
4576 EXTCONST  unsigned char PL_latin1_lc[] = {  /* lowercasing */
4577         0,      1,      2,      3,      4,      5,      6,      7,
4578         8,      9,      10,     11,     12,     13,     14,     15,
4579         16,     17,     18,     19,     20,     21,     22,     23,
4580         24,     25,     26,     27,     28,     29,     30,     31,
4581         32,     33,     34,     35,     36,     37,     38,     39,
4582         40,     41,     42,     43,     44,     45,     46,     47,
4583         48,     49,     50,     51,     52,     53,     54,     55,
4584         56,     57,     58,     59,     60,     61,     62,     63,
4585         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4586         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4587         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4588         'x',    'y',    'z',    91,     92,     93,     94,     95,
4589         96,     97,     98,     99,     100,    101,    102,    103,
4590         104,    105,    106,    107,    108,    109,    110,    111,
4591         112,    113,    114,    115,    116,    117,    118,    119,
4592         120,    121,    122,    123,    124,    125,    126,    127,
4593         128,    129,    130,    131,    132,    133,    134,    135,
4594         136,    137,    138,    139,    140,    141,    142,    143,
4595         144,    145,    146,    147,    148,    149,    150,    151,
4596         152,    153,    154,    155,    156,    157,    158,    159,
4597         160,    161,    162,    163,    164,    165,    166,    167,
4598         168,    169,    170,    171,    172,    173,    174,    175,
4599         176,    177,    178,    179,    180,    181,    182,    183,
4600         184,    185,    186,    187,    188,    189,    190,    191,
4601         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4602         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4603         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4604         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223,
4605         224,    225,    226,    227,    228,    229,    230,    231,
4606         232,    233,    234,    235,    236,    237,    238,    239,
4607         240,    241,    242,    243,    244,    245,    246,    247,
4608         248,    249,    250,    251,    252,    253,    254,    255
4609 };
4610
4611 /* upper and title case of latin1 characters, modified so that the three tricky
4612  * ones are mapped to 255 (which is one of the three) */
4613 EXTCONST  unsigned char PL_mod_latin1_uc[] = {
4614         0,      1,      2,      3,      4,      5,      6,      7,
4615         8,      9,      10,     11,     12,     13,     14,     15,
4616         16,     17,     18,     19,     20,     21,     22,     23,
4617         24,     25,     26,     27,     28,     29,     30,     31,
4618         32,     33,     34,     35,     36,     37,     38,     39,
4619         40,     41,     42,     43,     44,     45,     46,     47,
4620         48,     49,     50,     51,     52,     53,     54,     55,
4621         56,     57,     58,     59,     60,     61,     62,     63,
4622         64,     65,     66,     67,     68,     69,     70,     71,
4623         72,     73,     74,     75,     76,     77,     78,     79,
4624         80,     81,     82,     83,     84,     85,     86,     87,
4625         88,     89,     90,     91,     92,     93,     94,     95,
4626         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4627         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4628         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4629         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4630         128,    129,    130,    131,    132,    133,    134,    135,
4631         136,    137,    138,    139,    140,    141,    142,    143,
4632         144,    145,    146,    147,    148,    149,    150,    151,
4633         152,    153,    154,    155,    156,    157,    158,    159,
4634         160,    161,    162,    163,    164,    165,    166,    167,
4635         168,    169,    170,    171,    172,    173,    174,    175,
4636         176,    177,    178,    179,    180,    255 /*micro*/,  182,    183,
4637         184,    185,    186,    187,    188,    189,    190,    191,
4638         192,    193,    194,    195,    196,    197,    198,    199,
4639         200,    201,    202,    203,    204,    205,    206,    207,
4640         208,    209,    210,    211,    212,    213,    214,    215,
4641         216,    217,    218,    219,    220,    221,    222,
4642 #if    UNICODE_MAJOR_VERSION > 2                                        \
4643    || (UNICODE_MAJOR_VERSION == 2 && UNICODE_DOT_VERSION >= 1           \
4644                                   && UNICODE_DOT_DOT_VERSION >= 8)
4645                                                                 255 /*sharp s*/,
4646 #else   /* uc() is itself in early unicode */
4647                                                                 223,
4648 #endif
4649         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4650         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4651         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4652         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32, 255
4653 };
4654 #endif  /* !EBCDIC, but still in DOINIT */
4655 #else   /* ! DOINIT */
4656 #   ifndef EBCDIC
4657 EXTCONST unsigned char PL_fold[];
4658 EXTCONST unsigned char PL_fold_latin1[];
4659 EXTCONST unsigned char PL_mod_latin1_uc[];
4660 EXTCONST unsigned char PL_latin1_lc[];
4661 #   endif
4662 #endif
4663
4664 #ifndef PERL_GLOBAL_STRUCT /* or perlvars.h */
4665 #ifdef DOINIT
4666 EXT unsigned char PL_fold_locale[] = { /* Unfortunately not EXTCONST. */
4667         0,      1,      2,      3,      4,      5,      6,      7,
4668         8,      9,      10,     11,     12,     13,     14,     15,
4669         16,     17,     18,     19,     20,     21,     22,     23,
4670         24,     25,     26,     27,     28,     29,     30,     31,
4671         32,     33,     34,     35,     36,     37,     38,     39,
4672         40,     41,     42,     43,     44,     45,     46,     47,
4673         48,     49,     50,     51,     52,     53,     54,     55,
4674         56,     57,     58,     59,     60,     61,     62,     63,
4675         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4676         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4677         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4678         'x',    'y',    'z',    91,     92,     93,     94,     95,
4679         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4680         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4681         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4682         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4683         128,    129,    130,    131,    132,    133,    134,    135,
4684         136,    137,    138,    139,    140,    141,    142,    143,
4685         144,    145,    146,    147,    148,    149,    150,    151,
4686         152,    153,    154,    155,    156,    157,    158,    159,
4687         160,    161,    162,    163,    164,    165,    166,    167,
4688         168,    169,    170,    171,    172,    173,    174,    175,
4689         176,    177,    178,    179,    180,    181,    182,    183,
4690         184,    185,    186,    187,    188,    189,    190,    191,
4691         192,    193,    194,    195,    196,    197,    198,    199,
4692         200,    201,    202,    203,    204,    205,    206,    207,
4693         208,    209,    210,    211,    212,    213,    214,    215,
4694         216,    217,    218,    219,    220,    221,    222,    223,
4695         224,    225,    226,    227,    228,    229,    230,    231,
4696         232,    233,    234,    235,    236,    237,    238,    239,
4697         240,    241,    242,    243,    244,    245,    246,    247,
4698         248,    249,    250,    251,    252,    253,    254,    255
4699 };
4700 #else
4701 EXT unsigned char PL_fold_locale[]; /* Unfortunately not EXTCONST. */
4702 #endif
4703 #endif /* !PERL_GLOBAL_STRUCT */
4704
4705 #ifdef DOINIT
4706 #ifdef EBCDIC
4707 EXTCONST unsigned char PL_freq[] = {/* EBCDIC frequencies for mixed English/C */
4708     1,      2,      84,     151,    154,    155,    156,    157,
4709     165,    246,    250,    3,      158,    7,      18,     29,
4710     40,     51,     62,     73,     85,     96,     107,    118,
4711     129,    140,    147,    148,    149,    150,    152,    153,
4712     255,      6,      8,      9,     10,     11,     12,     13,
4713      14,     15,     24,     25,     26,     27,     28,    226,
4714      29,     30,     31,     32,     33,     43,     44,     45,
4715      46,     47,     48,     49,     50,     76,     77,     78,
4716      79,     80,     81,     82,     83,     84,     85,     86,
4717      87,     94,     95,    234,    181,    233,    187,    190,
4718     180,     96,     97,     98,     99,    100,    101,    102,
4719     104,    112,    182,    174,    236,    232,    229,    103,
4720     228,    226,    114,    115,    116,    117,    118,    119,
4721     120,    121,    122,    235,    176,    230,    194,    162,
4722     130,    131,    132,    133,    134,    135,    136,    137,
4723     138,    139,    201,    205,    163,    217,    220,    224,
4724     5,      248,    227,    244,    242,    255,    241,    231,
4725     240,    253,    16,     197,    19,     20,     21,     187,
4726     23,     169,    210,    245,    237,    249,    247,    239,
4727     168,    252,    34,     196,    36,     37,     38,     39,
4728     41,     42,     251,    254,    238,    223,    221,    213,
4729     225,    177,    52,     53,     54,     55,     56,     57,
4730     58,     59,     60,     61,     63,     64,     65,     66,
4731     67,     68,     69,     70,     71,     72,     74,     75,
4732     205,    208,    186,    202,    200,    218,    198,    179,
4733     178,    214,    88,     89,     90,     91,     92,     93,
4734     217,    166,    170,    207,    199,    209,    206,    204,
4735     160,    212,    105,    106,    108,    109,    110,    111,
4736     203,    113,    216,    215,    192,    175,    193,    243,
4737     172,    161,    123,    124,    125,    126,    127,    128,
4738     222,    219,    211,    195,    188,    193,    185,    184,
4739     191,    183,    141,    142,    143,    144,    145,    146
4740 };
4741 #else  /* ascii rather than ebcdic */
4742 EXTCONST unsigned char PL_freq[] = {    /* letter frequencies for mixed English/C */
4743         1,      2,      84,     151,    154,    155,    156,    157,
4744         165,    246,    250,    3,      158,    7,      18,     29,
4745         40,     51,     62,     73,     85,     96,     107,    118,
4746         129,    140,    147,    148,    149,    150,    152,    153,
4747         255,    182,    224,    205,    174,    176,    180,    217,
4748         233,    232,    236,    187,    235,    228,    234,    226,
4749         222,    219,    211,    195,    188,    193,    185,    184,
4750         191,    183,    201,    229,    181,    220,    194,    162,
4751         163,    208,    186,    202,    200,    218,    198,    179,
4752         178,    214,    166,    170,    207,    199,    209,    206,
4753         204,    160,    212,    216,    215,    192,    175,    173,
4754         243,    172,    161,    190,    203,    189,    164,    230,
4755         167,    248,    227,    244,    242,    255,    241,    231,
4756         240,    253,    169,    210,    245,    237,    249,    247,
4757         239,    168,    252,    251,    254,    238,    223,    221,
4758         213,    225,    177,    197,    171,    196,    159,    4,
4759         5,      6,      8,      9,      10,     11,     12,     13,
4760         14,     15,     16,     17,     19,     20,     21,     22,
4761         23,     24,     25,     26,     27,     28,     30,     31,
4762         32,     33,     34,     35,     36,     37,     38,     39,
4763         41,     42,     43,     44,     45,     46,     47,     48,
4764         49,     50,     52,     53,     54,     55,     56,     57,
4765         58,     59,     60,     61,     63,     64,     65,     66,
4766         67,     68,     69,     70,     71,     72,     74,     75,
4767         76,     77,     78,     79,     80,     81,     82,     83,
4768         86,     87,     88,     89,     90,     91,     92,     93,
4769         94,     95,     97,     98,     99,     100,    101,    102,
4770         103,    104,    105,    106,    108,    109,    110,    111,
4771         112,    113,    114,    115,    116,    117,    119,    120,
4772         121,    122,    123,    124,    125,    126,    127,    128,
4773         130,    131,    132,    133,    134,    135,    136,    137,
4774         138,    139,    141,    142,    143,    144,    145,    146
4775 };
4776 #endif
4777 #else
4778 EXTCONST unsigned char PL_freq[];
4779 #endif
4780
4781 /* Although only used for debugging, these constants must be available in
4782  * non-debugging builds too, since they're used in ext/re/re_exec.c,
4783  * which has DEBUGGING enabled always */
4784 #ifdef DOINIT
4785 EXTCONST char* const PL_block_type[] = {
4786         "NULL",
4787         "WHEN",
4788         "BLOCK",
4789         "GIVEN",
4790         "LOOP_ARY",
4791         "LOOP_LAZYSV",
4792         "LOOP_LAZYIV",
4793         "LOOP_LIST",
4794         "LOOP_PLAIN",
4795         "SUB",
4796         "FORMAT",
4797         "EVAL",
4798         "SUBST"
4799 };
4800 #else
4801 EXTCONST char* PL_block_type[];
4802 #endif
4803
4804 /* These are all the compile time options that affect binary compatibility.