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