perl.h

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