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