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