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