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