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