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