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