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