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  *  These are mentioned in perlguts
1907  */
1908 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1909 #  define PTRV                  UV
1910 #  define INT2PTR(any,d)        (any)(d)
1911 #elif PTRSIZE == LONGSIZE
1912 #  define PTRV                  unsigned long
1913 #  define PTR2ul(p)             (unsigned long)(p)
1914 #else
1915 #  define PTRV                  unsigned
1916 #endif
1917
1918 #ifndef INT2PTR
1919 #  define INT2PTR(any,d)        (any)(PTRV)(d)
1920 #endif
1921
1922 #ifndef PTR2ul
1923 #  define PTR2ul(p)     INT2PTR(unsigned long,p)
1924 #endif
1925
1926 #define NUM2PTR(any,d)  (any)(PTRV)(d)
1927 #define PTR2IV(p)       INT2PTR(IV,p)
1928 #define PTR2UV(p)       INT2PTR(UV,p)
1929 #define PTR2NV(p)       NUM2PTR(NV,p)
1930 #define PTR2nat(p)      (PTRV)(p)       /* pointer to integer of PTRSIZE */
1931
1932 /* According to strict ANSI C89 one cannot freely cast between
1933  * data pointers and function (code) pointers.  There are at least
1934  * two ways around this.  One (used below) is to do two casts,
1935  * first the other pointer to an (unsigned) integer, and then
1936  * the integer to the other pointer.  The other way would be
1937  * to use unions to "overlay" the pointers.  For an example of
1938  * the latter technique, see union dirpu in struct xpvio in sv.h.
1939  * The only feasible use is probably temporarily storing
1940  * function pointers in a data pointer (such as a void pointer). */
1941
1942 #define DPTR2FPTR(t,p) ((t)PTR2nat(p))  /* data pointer to function pointer */
1943 #define FPTR2DPTR(t,p) ((t)PTR2nat(p))  /* function pointer to data pointer */
1944
1945 #ifdef USE_LONG_DOUBLE
1946 #  if LONG_DOUBLESIZE == DOUBLESIZE
1947 #    define LONG_DOUBLE_EQUALS_DOUBLE
1948 #    undef USE_LONG_DOUBLE /* Ouch! */
1949 #  endif
1950 #endif
1951
1952 /* The following is all to get LDBL_DIG, in order to pick a nice
1953    default value for printing floating point numbers in Gconvert.
1954    (see config.h)
1955 */
1956 #ifndef HAS_LDBL_DIG
1957 #  if LONG_DOUBLESIZE == 10
1958 #    define LDBL_DIG 18 /* assume IEEE */
1959 #  elif LONG_DOUBLESIZE == 12
1960 #    define LDBL_DIG 18 /* gcc? */
1961 #  elif LONG_DOUBLESIZE == 16
1962 #    define LDBL_DIG 33 /* assume IEEE */
1963 #  elif LONG_DOUBLESIZE == DOUBLESIZE
1964 #    define LDBL_DIG DBL_DIG /* bummer */
1965 #  endif
1966 #endif
1967
1968 typedef NVTYPE NV;
1969
1970 #ifdef I_IEEEFP
1971 #   include <ieeefp.h>
1972 #endif
1973
1974 #if defined(__DECC) && defined(__osf__)
1975 /* Also Tru64 cc has broken NaN comparisons. */
1976 #  define NAN_COMPARE_BROKEN
1977 #endif
1978 #if defined(__sgi)
1979 #  define NAN_COMPARE_BROKEN
1980 #endif
1981
1982 #ifdef USE_LONG_DOUBLE
1983 #   ifdef I_SUNMATH
1984 #       include <sunmath.h>
1985 #   endif
1986 #   if defined(LDBL_DIG)
1987 #       define NV_DIG LDBL_DIG
1988 #       ifdef LDBL_MANT_DIG
1989 #           define NV_MANT_DIG LDBL_MANT_DIG
1990 #       endif
1991 #       ifdef LDBL_MIN
1992 #           define NV_MIN LDBL_MIN
1993 #       endif
1994 #       ifdef LDBL_MAX
1995 #           define NV_MAX LDBL_MAX
1996 #       endif
1997 #       ifdef LDBL_MIN_EXP
1998 #           define NV_MIN_EXP LDBL_MIN_EXP
1999 #       endif
2000 #       ifdef LDBL_MAX_EXP
2001 #           define NV_MAX_EXP LDBL_MAX_EXP
2002 #       endif
2003 #       ifdef LDBL_MIN_10_EXP
2004 #           define NV_MIN_10_EXP LDBL_MIN_10_EXP
2005 #       endif
2006 #       ifdef LDBL_MAX_10_EXP
2007 #           define NV_MAX_10_EXP LDBL_MAX_10_EXP
2008 #       endif
2009 #       ifdef LDBL_EPSILON
2010 #           define NV_EPSILON LDBL_EPSILON
2011 #       endif
2012 #       ifdef LDBL_MAX
2013 #           define NV_MAX LDBL_MAX
2014 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
2015 #       elif defined(HUGE_VALL)
2016 #           define NV_MAX HUGE_VALL
2017 #       endif
2018 #   endif
2019 #   if defined(HAS_SQRTL)
2020 #       define Perl_acos acosl
2021 #       define Perl_asin asinl
2022 #       define Perl_atan atanl
2023 #       define Perl_atan2 atan2l
2024 #       define Perl_ceil ceill
2025 #       define Perl_cos cosl
2026 #       define Perl_cosh coshl
2027 #       define Perl_exp expl
2028 /* no Perl_fabs, but there's PERL_ABS */
2029 #       define Perl_floor floorl
2030 #       define Perl_fmod fmodl
2031 #       define Perl_log logl
2032 #       define Perl_log10 log10l
2033 #       define Perl_pow powl
2034 #       define Perl_sin sinl
2035 #       define Perl_sinh sinhl
2036 #       define Perl_sqrt sqrtl
2037 #       define Perl_tan tanl
2038 #       define Perl_tanh tanhl
2039 #   endif
2040 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
2041 #   ifndef Perl_modf
2042 #       ifdef HAS_MODFL
2043 #           define Perl_modf(x,y) modfl(x,y)
2044 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
2045    prototype in <math.h> */
2046 #           ifndef HAS_MODFL_PROTO
2047 EXTERN_C long double modfl(long double, long double *);
2048 #           endif
2049 #       elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
2050         extern long double Perl_my_modfl(long double x, long double *ip);
2051 #           define Perl_modf(x,y) Perl_my_modfl(x,y)
2052 #       endif
2053 #   endif
2054 #   ifndef Perl_frexp
2055 #       ifdef HAS_FREXPL
2056 #           define Perl_frexp(x,y) frexpl(x,y)
2057 #       elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
2058 extern long double Perl_my_frexpl(long double x, int *e);
2059 #           define Perl_frexp(x,y) Perl_my_frexpl(x,y)
2060 #       endif
2061 #   endif
2062 #   ifndef Perl_ldexp
2063 #       ifdef HAS_LDEXPL
2064 #           define Perl_ldexp(x, y) ldexpl(x,y)
2065 #       elif defined(HAS_SCALBNL) && FLT_RADIX == 2
2066 #           define Perl_ldexp(x,y) scalbnl(x,y)
2067 #       endif
2068 #   endif
2069 #   ifndef Perl_isnan
2070 #       if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
2071 #           define Perl_isnan(x) isnanl(x)
2072 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
2073 #           define Perl_isnan(x) isnan(x)
2074 #       endif
2075 #   endif
2076 #   ifndef Perl_isinf
2077 #       if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
2078 #           define Perl_isinf(x) isinfl(x)
2079 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
2080 #           define Perl_isinf(x) isinf(x)
2081 #       elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2082 #           define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
2083 #       endif
2084 #   endif
2085 #   ifndef Perl_isfinite
2086 #       define Perl_isfinite(x) Perl_isfinitel(x)
2087 #   endif
2088 #elif defined(USE_QUADMATH) && defined(I_QUADMATH)
2089 #   include <quadmath.h>
2090 #   define NV_DIG FLT128_DIG
2091 #   define NV_MANT_DIG FLT128_MANT_DIG
2092 #   define NV_MIN FLT128_MIN
2093 #   define NV_MAX FLT128_MAX
2094 #   define NV_MIN_EXP FLT128_MIN_EXP
2095 #   define NV_MAX_EXP FLT128_MAX_EXP
2096 #   define NV_EPSILON FLT128_EPSILON
2097 #   define NV_MIN_10_EXP FLT128_MIN_10_EXP
2098 #   define NV_MAX_10_EXP FLT128_MAX_10_EXP
2099 #   define Perl_acos acosq
2100 #   define Perl_asin asinq
2101 #   define Perl_atan atanq
2102 #   define Perl_atan2 atan2q
2103 #   define Perl_ceil ceilq
2104 #   define Perl_cos cosq
2105 #   define Perl_cosh coshq
2106 #   define Perl_exp expq
2107 /* no Perl_fabs, but there's PERL_ABS */
2108 #   define Perl_floor floorq
2109 #   define Perl_fmod fmodq
2110 #   define Perl_log logq
2111 #   define Perl_log10 log10q
2112 #   define Perl_signbit signbitq
2113 #   define Perl_pow powq
2114 #   define Perl_sin sinq
2115 #   define Perl_sinh sinhq
2116 #   define Perl_sqrt sqrtq
2117 #   define Perl_tan tanq
2118 #   define Perl_tanh tanhq
2119 #   define Perl_modf(x,y) modfq(x,y)
2120 #   define Perl_frexp(x,y) frexpq(x,y)
2121 #   define Perl_ldexp(x, y) ldexpq(x,y)
2122 #   define Perl_isinf(x) isinfq(x)
2123 #   define Perl_isnan(x) isnanq(x)
2124 #   define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
2125 #   define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
2126 #   define Perl_fp_class_inf(x)    (Perl_fp_class(x) == 3)
2127 #   define Perl_fp_class_nan(x)    (Perl_fp_class(x) == 4)
2128 #   define Perl_fp_class_norm(x)   (Perl_fp_class(x) == 1)
2129 #   define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
2130 #   define Perl_fp_class_zero(x)   (Perl_fp_class(x) == 0)
2131 #else
2132 #   define NV_DIG DBL_DIG
2133 #   define NV_MANT_DIG DBL_MANT_DIG
2134 #   define NV_MIN DBL_MIN
2135 #   define NV_MAX DBL_MAX
2136 #   define NV_MIN_EXP DBL_MIN_EXP
2137 #   define NV_MAX_EXP DBL_MAX_EXP
2138 #   define NV_MIN_10_EXP DBL_MIN_10_EXP
2139 #   define NV_MAX_10_EXP DBL_MAX_10_EXP
2140 #   define NV_EPSILON DBL_EPSILON
2141 #   define NV_MAX DBL_MAX
2142 #   define NV_MIN DBL_MIN
2143
2144 /* These math interfaces are C89. */
2145 #   define Perl_acos acos
2146 #   define Perl_asin asin
2147 #   define Perl_atan atan
2148 #   define Perl_atan2 atan2
2149 #   define Perl_ceil ceil
2150 #   define Perl_cos cos
2151 #   define Perl_cosh cosh
2152 #   define Perl_exp exp
2153 /* no Perl_fabs, but there's PERL_ABS */
2154 #   define Perl_floor floor
2155 #   define Perl_fmod fmod
2156 #   define Perl_log log
2157 #   define Perl_log10 log10
2158 #   define Perl_pow pow
2159 #   define Perl_sin sin
2160 #   define Perl_sinh sinh
2161 #   define Perl_sqrt sqrt
2162 #   define Perl_tan tan
2163 #   define Perl_tanh tanh
2164
2165 #   define Perl_modf(x,y) modf(x,y)
2166 #   define Perl_frexp(x,y) frexp(x,y)
2167 #   define Perl_ldexp(x,y) ldexp(x,y)
2168
2169 #   ifndef Perl_isnan
2170 #       ifdef HAS_ISNAN
2171 #           define Perl_isnan(x) isnan(x)
2172 #       endif
2173 #   endif
2174 #   ifndef Perl_isinf
2175 #       if defined(HAS_ISINF)
2176 #           define Perl_isinf(x) isinf(x)
2177 #       elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2178 #           define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
2179 #       endif
2180 #   endif
2181 #   ifndef Perl_isfinite
2182 #     ifdef HAS_ISFINITE
2183 #       define Perl_isfinite(x) isfinite(x)
2184 #     elif defined(HAS_FINITE)
2185 #       define Perl_isfinite(x) finite(x)
2186 #     endif
2187 #   endif
2188 #endif
2189
2190 /* fpclassify(): C99.  It is supposed to be a macro that switches on
2191 * the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
2192 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2193 #    include <math.h>
2194 #    if defined(FP_INFINITE) && defined(FP_NAN)
2195 #        define Perl_fp_class(x)        fpclassify(x)
2196 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
2197 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
2198 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
2199 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2200 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
2201 #    elif defined(FP_PLUS_INF) && defined(FP_QNAN)
2202 /* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
2203  * actually not the C99 fpclassify, with its own set of return defines. */
2204 #        define Perl_fp_class(x)        fpclassify(x)
2205 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PLUS_INF)
2206 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_MINUS_INF)
2207 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
2208 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
2209 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PLUS_NORM)
2210 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_MINUS_NORM)
2211 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PLUS_DENORM)
2212 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_MINUS_DENORM)
2213 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PLUS_ZERO)
2214 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_MINUS_ZERO)
2215 #    else
2216 #        undef Perl_fp_class /* Unknown set of defines */
2217 #    endif
2218 #endif
2219
2220 /* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
2221  * are identical to the C99 fpclassify(). */
2222 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
2223 #    include <math.h>
2224 #    ifdef __VMS
2225      /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
2226 #        include <fp.h>
2227      /* oh, and the isnormal macro has a typo in it! */
2228 #    undef isnormal
2229 #    define isnormal(x) Perl_fp_class_norm(x)
2230 #    endif
2231 #    if defined(FP_INFINITE) && defined(FP_NAN)
2232 #        define Perl_fp_class(x)        fp_classify(x)
2233 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
2234 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
2235 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
2236 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2237 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
2238 #    else
2239 #        undef Perl_fp_class /* Unknown set of defines */
2240 #    endif
2241 #endif
2242
2243 /* Feel free to check with me for the SGI manpages, SGI testing,
2244  * etcetera, if you want to try getting this to work with IRIX.
2245  *
2246  * - Allen <allens@cpan.org> */
2247
2248 /* fpclass(): SysV, at least Solaris and some versions of IRIX. */
2249 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
2250 /* Solaris and IRIX have fpclass/fpclassl, but they are using
2251  * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2252  * Define some symbols also as cpp symbols so we can detect them. */
2253 #    if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
2254 #     define FP_PINF FP_PINF
2255 #     define FP_QNAN FP_QNAN
2256 #    endif
2257 #    include <math.h>
2258 #    ifdef I_IEEFP
2259 #        include <ieeefp.h>
2260 #    endif
2261 #    ifdef I_FP
2262 #        include <fp.h>
2263 #    endif
2264 #    if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
2265 #        define Perl_fp_class(x)        fpclassl(x)
2266 #    else
2267 #        define Perl_fp_class(x)        fpclass(x)
2268 #    endif
2269 #    if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
2270 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_CLASS_SNAN)
2271 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_CLASS_QNAN)
2272 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_CLASS_NINF)
2273 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_CLASS_PINF)
2274 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_CLASS_NNORM)
2275 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_CLASS_PNORM)
2276 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_CLASS_NDENORM)
2277 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_CLASS_PDENORM)
2278 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_CLASS_NZERO)
2279 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_CLASS_PZERO)
2280 #    elif defined(FP_PINF) && defined(FP_QNAN)
2281 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
2282 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
2283 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_NINF)
2284 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PINF)
2285 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_NNORM)
2286 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PNORM)
2287 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_NDENORM)
2288 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PDENORM)
2289 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_NZERO)
2290 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PZERO)
2291 #    else
2292 #        undef Perl_fp_class /* Unknown set of defines */
2293 #    endif
2294 #endif
2295
2296 /* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2297 #if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
2298 #    include <math.h>
2299 #    if !defined(FP_SNAN) && defined(I_FP_CLASS)
2300 #        include <fp_class.h>
2301 #    endif
2302 #    if defined(FP_POS_INF) && defined(FP_QNAN)
2303 #        ifdef __sgi /* XXX Configure test instead */
2304 #            ifdef USE_LONG_DOUBLE
2305 #                define Perl_fp_class(x)        fp_class_l(x)
2306 #            else
2307 #                define Perl_fp_class(x)        fp_class_d(x)
2308 #            endif
2309 #        else
2310 #            if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2311 #                define Perl_fp_class(x)        fp_classl(x)
2312 #            else
2313 #                define Perl_fp_class(x)        fp_class(x)
2314 #            endif
2315 #        endif
2316 #        if defined(FP_POS_INF) && defined(FP_QNAN)
2317 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_SNAN)
2318 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_QNAN)
2319 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_NEG_INF)
2320 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_POS_INF)
2321 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_NEG_NORM)
2322 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_POS_NORM)
2323 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_NEG_DENORM)
2324 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_POS_DENORM)
2325 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_NEG_ZERO)
2326 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_POS_ZERO)
2327 #        else
2328 #            undef Perl_fp_class /* Unknown set of defines */
2329 #        endif
2330 #    endif
2331 #endif
2332
2333 /* class(), _class(): Legacy: AIX. */
2334 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2335 #    include <math.h>
2336 #    if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2337 #        ifndef _cplusplus
2338 #            define Perl_fp_class(x)    class(x)
2339 #        else
2340 #            define Perl_fp_class(x)    _class(x)
2341 #        endif
2342 #        if defined(FP_PLUS_INF) && defined(FP_NANQ)
2343 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_NANS)
2344 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_NANQ)
2345 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_MINUS_INF)
2346 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_PLUS_INF)
2347 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_MINUS_NORM)
2348 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_PLUS_NORM)
2349 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_MINUS_DENORM)
2350 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_PLUS_DENORM)
2351 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_MINUS_ZERO)
2352 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_PLUS_ZERO)
2353 #        else
2354 #            undef Perl_fp_class /* Unknown set of defines */
2355 #        endif
2356 #    endif
2357 #endif
2358
2359 /* Win32: _fpclass(), _isnan(), _finite(). */
2360 #ifdef _MSC_VER
2361 #  ifndef Perl_isnan
2362 #    define Perl_isnan(x) _isnan(x)
2363 #  endif
2364 #  ifndef Perl_isfinite
2365 #    define Perl_isfinite(x) _finite(x)
2366 #  endif
2367 #  ifndef Perl_fp_class_snan
2368 /* No simple way to #define Perl_fp_class because _fpclass()
2369  * returns a set of bits. */
2370 #    define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2371 #    define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
2372 #    define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
2373 #    define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF))
2374 #    define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF))
2375 #    define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2376 #    define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2377 #    define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2378 #    define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2379 #    define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2380 #    define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2381 #    define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2382 #    define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2383 #    define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2384 #    define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2385 #  endif
2386 #endif
2387
2388 #if !defined(Perl_fp_class_inf) && \
2389   defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2390 #  define Perl_fp_class_inf(x) \
2391     (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2392 #endif
2393
2394 #if !defined(Perl_fp_class_nan) && \
2395   defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2396 #  define Perl_fp_class_nan(x) \
2397     (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2398 #endif
2399
2400 #if !defined(Perl_fp_class_zero) && \
2401   defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2402 #  define Perl_fp_class_zero(x) \
2403     (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2404 #endif
2405
2406 #if !defined(Perl_fp_class_norm) && \
2407   defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2408 #  define Perl_fp_class_norm(x) \
2409     (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2410 #endif
2411
2412 #if !defined(Perl_fp_class_denorm) && \
2413   defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2414 #  define Perl_fp_class_denorm(x) \
2415     (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
2416 #endif
2417
2418 #ifndef Perl_isnan
2419 #   ifdef Perl_fp_class_nan
2420 #       define Perl_isnan(x) Perl_fp_class_nan(x)
2421 #   elif defined(HAS_UNORDERED)
2422 #       define Perl_isnan(x) unordered((x), 0.0)
2423 #   else
2424 #       define Perl_isnan(x) ((x)!=(x))
2425 #   endif
2426 #endif
2427
2428 #ifndef Perl_isinf
2429 #   ifdef Perl_fp_class_inf
2430 #       define Perl_isinf(x) Perl_fp_class_inf(x)
2431 #   endif
2432 #endif
2433
2434 #ifndef Perl_isfinite
2435 #   if defined(HAS_ISFINITE) && !defined(isfinite)
2436 #     define Perl_isfinite(x) isfinite((double)(x))
2437 #   elif defined(HAS_FINITE)
2438 #       define Perl_isfinite(x) finite((double)(x))
2439 #   elif defined(Perl_fp_class_finite)
2440 #     define Perl_isfinite(x) Perl_fp_class_finite(x)
2441 #   else
2442 /* For the infinities the multiplication returns nan,
2443  * for the nan the multiplication also returns nan,
2444  * for everything else (that is, finite) zero should be returned. */
2445 #     define Perl_isfinite(x) (((x) * 0) == 0)
2446 #   endif
2447 #endif
2448
2449 #ifndef Perl_isinf
2450 #   if defined(Perl_isfinite) && defined(Perl_isnan)
2451 #       define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2452 #   endif
2453 #endif
2454
2455 /* We need Perl_isfinitel (ends with ell) (if available) even when
2456  * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2457  * needs that. */
2458 #if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2459 /* If isfinite() is a macro and looks like we have C99,
2460  * we assume it's the type-aware C99 isfinite(). */
2461 #    if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
2462 #        define Perl_isfinitel(x) isfinite(x)
2463 #    elif defined(HAS_ISFINITEL)
2464 #        define Perl_isfinitel(x) isfinitel(x)
2465 #    elif defined(HAS_FINITEL)
2466 #        define Perl_isfinitel(x) finitel(x)
2467 #    elif defined(HAS_INFL) && defined(HAS_NANL)
2468 #        define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
2469 #    else
2470 #        define Perl_isfinitel(x) ((x) * 0 == 0)  /* See Perl_isfinite. */
2471 #    endif
2472 #endif
2473
2474 /* The default is to use Perl's own atof() implementation (in numeric.c).
2475  * Usually that is the one to use but for some platforms (e.g. UNICOS)
2476  * it is however best to use the native implementation of atof.
2477  * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2478  * Some good tests to try out with either setting are t/base/num.t,
2479  * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2480  * you may need to be using a different function than atof! */
2481
2482 #ifndef USE_PERL_ATOF
2483 #   ifndef _UNICOS
2484 #       define USE_PERL_ATOF
2485 #   endif
2486 #else
2487 #   if USE_PERL_ATOF == 0
2488 #       undef USE_PERL_ATOF
2489 #   endif
2490 #endif
2491
2492 #ifdef USE_PERL_ATOF
2493 #   define Perl_atof(s) Perl_my_atof(s)
2494 #   define Perl_atof2(s, n) Perl_my_atof3(aTHX_ (s), &(n), 0)
2495 #else
2496 #   define Perl_atof(s) (NV)atof(s)
2497 #   define Perl_atof2(s, n) ((n) = atof(s))
2498 #endif
2499 #define my_atof2(a,b) my_atof3(a,b,0)
2500
2501 /*
2502  * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2503  * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2504  * depending on local options. Until Configure detects this (or at least
2505  * detects whether the "signed" keyword is available) the CHAR ranges
2506  * will not be included. UCHAR functions normally.
2507  *                                                           - kja
2508  */
2509
2510 #define PERL_UCHAR_MIN ((unsigned char)0)
2511 #define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2512
2513 #define PERL_USHORT_MIN ((unsigned short)0)
2514 #define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2515
2516 #define PERL_SHORT_MAX ((short)SHRT_MAX)
2517 #define PERL_SHORT_MIN ((short)SHRT_MIN)
2518
2519 #define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2520 #define PERL_UINT_MIN ((unsigned int)0)
2521
2522 #define PERL_INT_MAX ((int)INT_MAX)
2523 #define PERL_INT_MIN ((int)INT_MIN)
2524
2525 #define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2526 #define PERL_ULONG_MIN ((unsigned long)0L)
2527
2528 #define PERL_LONG_MAX ((long)LONG_MAX)
2529 #define PERL_LONG_MIN ((long)LONG_MIN)
2530
2531 #ifdef UV_IS_QUAD
2532 #    define PERL_UQUAD_MAX      (~(UV)0)
2533 #    define PERL_UQUAD_MIN      ((UV)0)
2534 #    define PERL_QUAD_MAX       ((IV) (PERL_UQUAD_MAX >> 1))
2535 #    define PERL_QUAD_MIN       (-PERL_QUAD_MAX - ((3 & -1) == 3))
2536 #endif
2537
2538 /*
2539 =head1 Numeric functions
2540
2541 =for apidoc AmnUh||PERL_INT_MIN
2542 =for apidoc AmnUh||PERL_LONG_MAX
2543 =for apidoc AmnUh||PERL_LONG_MIN
2544 =for apidoc AmnUh||PERL_QUAD_MAX
2545 =for apidoc AmnUh||PERL_SHORT_MAX
2546 =for apidoc AmnUh||PERL_SHORT_MIN
2547 =for apidoc AmnUh||PERL_UCHAR_MAX
2548 =for apidoc AmnUh||PERL_UCHAR_MIN
2549 =for apidoc AmnUh||PERL_UINT_MAX
2550 =for apidoc AmnUh||PERL_ULONG_MAX
2551 =for apidoc AmnUh||PERL_ULONG_MIN
2552 =for apidoc AmnUh||PERL_UQUAD_MAX
2553 =for apidoc AmnUh||PERL_UQUAD_MIN
2554 =for apidoc AmnUh||PERL_USHORT_MAX
2555 =for apidoc AmnUh||PERL_USHORT_MIN
2556 =for apidoc AmnUh||PERL_QUAD_MIN
2557 =for apidoc AmnU||PERL_INT_MAX
2558 This and
2559 C<PERL_INT_MIN>,
2560 C<PERL_LONG_MAX>,
2561 C<PERL_LONG_MIN>,
2562 C<PERL_QUAD_MAX>,
2563 C<PERL_SHORT_MAX>,
2564 C<PERL_SHORT_MIN>,
2565 C<PERL_UCHAR_MAX>,
2566 C<PERL_UCHAR_MIN>,
2567 C<PERL_UINT_MAX>,
2568 C<PERL_ULONG_MAX>,
2569 C<PERL_ULONG_MIN>,
2570 C<PERL_UQUAD_MAX>,
2571 C<PERL_UQUAD_MIN>,
2572 C<PERL_USHORT_MAX>,
2573 C<PERL_USHORT_MIN>,
2574 C<PERL_QUAD_MIN>
2575 give the largest and smallest number representable in the current
2576 platform in variables of the corresponding types.
2577
2578 For signed types, the smallest representable number is the most negative
2579 number, the one furthest away from zero.
2580
2581 For C99 and later compilers, these correspond to things like C<INT_MAX>, which
2582 are available to the C code.  But these constants, furnished by Perl,
2583 allow code compiled on earlier compilers to portably have access to the same
2584 constants.
2585
2586 =cut
2587
2588 */
2589
2590 typedef MEM_SIZE STRLEN;
2591
2592 typedef struct op OP;
2593 typedef struct cop COP;
2594 typedef struct unop UNOP;
2595 typedef struct unop_aux UNOP_AUX;
2596 typedef struct binop BINOP;
2597 typedef struct listop LISTOP;
2598 typedef struct logop LOGOP;
2599 typedef struct pmop PMOP;
2600 typedef struct svop SVOP;
2601 typedef struct padop PADOP;
2602 typedef struct pvop PVOP;
2603 typedef struct loop LOOP;
2604 typedef struct methop METHOP;
2605
2606 #ifdef PERL_CORE
2607 typedef struct opslab OPSLAB;
2608 typedef struct opslot OPSLOT;
2609 #endif
2610
2611 typedef struct block_hooks BHK;
2612 typedef struct custom_op XOP;
2613
2614 typedef struct interpreter PerlInterpreter;
2615
2616 /* SGI's <sys/sema.h> has struct sv */
2617 #if defined(__sgi)
2618 #   define STRUCT_SV perl_sv
2619 #else
2620 #   define STRUCT_SV sv
2621 #endif
2622 typedef struct STRUCT_SV SV;
2623 typedef struct av AV;
2624 typedef struct hv HV;
2625 typedef struct cv CV;
2626 typedef struct p5rx REGEXP;
2627 typedef struct gp GP;
2628 typedef struct gv GV;
2629 typedef struct io IO;
2630 typedef struct context PERL_CONTEXT;
2631 typedef struct block BLOCK;
2632
2633 typedef struct magic MAGIC;
2634 typedef struct xpv XPV;
2635 typedef struct xpviv XPVIV;
2636 typedef struct xpvuv XPVUV;
2637 typedef struct xpvnv XPVNV;
2638 typedef struct xpvmg XPVMG;
2639 typedef struct xpvlv XPVLV;
2640 typedef struct xpvinvlist XINVLIST;
2641 typedef struct xpvav XPVAV;
2642 typedef struct xpvhv XPVHV;
2643 typedef struct xpvgv XPVGV;
2644 typedef struct xpvcv XPVCV;
2645 typedef struct xpvbm XPVBM;
2646 typedef struct xpvfm XPVFM;
2647 typedef struct xpvio XPVIO;
2648 typedef struct mgvtbl MGVTBL;
2649 typedef union any ANY;
2650 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2651 typedef struct ptr_tbl PTR_TBL_t;
2652 typedef struct clone_params CLONE_PARAMS;
2653
2654 /* a pad is currently just an AV; but that might change,
2655  * so hide the type.  */
2656 typedef struct padlist PADLIST;
2657 typedef AV PAD;
2658 typedef struct padnamelist PADNAMELIST;
2659 typedef struct padname PADNAME;
2660
2661 /* always enable PERL_OP_PARENT  */
2662 #if !defined(PERL_OP_PARENT)
2663 #  define PERL_OP_PARENT
2664 #endif
2665
2666 /* enable PERL_COPY_ON_WRITE by default */
2667 #if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2668 #  define PERL_COPY_ON_WRITE
2669 #endif
2670
2671 #ifdef PERL_COPY_ON_WRITE
2672 #  define PERL_ANY_COW
2673 #else
2674 # define PERL_SAWAMPERSAND
2675 #endif
2676
2677 #if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2678 # error PERL_DEBUG_READONLY_OPS only works with ithreads
2679 #endif
2680
2681 #include "handy.h"
2682 #include "charclass_invlists.h"
2683
2684 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2685 #   if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2686 #       define USE_64_BIT_RAWIO /* implicit */
2687 #   endif
2688 #endif
2689
2690 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2691  * fseeko/ftello if possible.  Don't go #defining ftell to ftello yourself,
2692  * however, because operating systems like to do that themself. */
2693 #ifndef FSEEKSIZE
2694 #   ifdef HAS_FSEEKO
2695 #       define FSEEKSIZE LSEEKSIZE
2696 #   else
2697 #       define FSEEKSIZE LONGSIZE
2698 #   endif
2699 #endif
2700
2701 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2702 #   if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2703 #       define USE_64_BIT_STDIO /* implicit */
2704 #   endif
2705 #endif
2706
2707 #ifdef USE_64_BIT_RAWIO
2708 #   ifdef HAS_OFF64_T
2709 #       undef Off_t
2710 #       define Off_t off64_t
2711 #       undef LSEEKSIZE
2712 #       define LSEEKSIZE 8
2713 #   endif
2714 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2715  * will trigger defines like the ones below.  Some 64-bit environments,
2716  * however, do not.  Therefore we have to explicitly mix and match. */
2717 #   if defined(USE_OPEN64)
2718 #       define open open64
2719 #   endif
2720 #   if defined(USE_LSEEK64)
2721 #       define lseek lseek64
2722 #   else
2723 #       if defined(USE_LLSEEK)
2724 #           define lseek llseek
2725 #       endif
2726 #   endif
2727 #   if defined(USE_STAT64)
2728 #       define stat stat64
2729 #   endif
2730 #   if defined(USE_FSTAT64)
2731 #       define fstat fstat64
2732 #   endif
2733 #   if defined(USE_LSTAT64)
2734 #       define lstat lstat64
2735 #   endif
2736 #   if defined(USE_FLOCK64)
2737 #       define flock flock64
2738 #   endif
2739 #   if defined(USE_LOCKF64)
2740 #       define lockf lockf64
2741 #   endif
2742 #   if defined(USE_FCNTL64)
2743 #       define fcntl fcntl64
2744 #   endif
2745 #   if defined(USE_TRUNCATE64)
2746 #       define truncate truncate64
2747 #   endif
2748 #   if defined(USE_FTRUNCATE64)
2749 #       define ftruncate ftruncate64
2750 #   endif
2751 #endif
2752
2753 #ifdef USE_64_BIT_STDIO
2754 #   ifdef HAS_FPOS64_T
2755 #       undef Fpos_t
2756 #       define Fpos_t fpos64_t
2757 #   endif
2758 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2759  * will trigger defines like the ones below.  Some 64-bit environments,
2760  * however, do not. */
2761 #   if defined(USE_FOPEN64)
2762 #       define fopen fopen64
2763 #   endif
2764 #   if defined(USE_FSEEK64)
2765 #       define fseek fseek64 /* don't do fseeko here, see perlio.c */
2766 #   endif
2767 #   if defined(USE_FTELL64)
2768 #       define ftell ftell64 /* don't do ftello here, see perlio.c */
2769 #   endif
2770 #   if defined(USE_FSETPOS64)
2771 #       define fsetpos fsetpos64
2772 #   endif
2773 #   if defined(USE_FGETPOS64)
2774 #       define fgetpos fgetpos64
2775 #   endif
2776 #   if defined(USE_TMPFILE64)
2777 #       define tmpfile tmpfile64
2778 #   endif
2779 #   if defined(USE_FREOPEN64)
2780 #       define freopen freopen64
2781 #   endif
2782 #endif
2783
2784 #if defined(OS2)
2785 #  include "iperlsys.h"
2786 #endif
2787
2788 #ifdef DOSISH
2789 #   if defined(OS2)
2790 #       include "os2ish.h"
2791 #   else
2792 #       include "dosish.h"
2793 #   endif
2794 #elif defined(VMS)
2795 #   include "vmsish.h"
2796 #elif defined(PLAN9)
2797 #   include "./plan9/plan9ish.h"
2798 #elif defined(__VOS__)
2799 #   ifdef __GNUC__
2800 #     include "./vos/vosish.h"
2801 #   else
2802 #     include "vos/vosish.h"
2803 #   endif
2804 #elif defined(__HAIKU__)
2805 #   include "haiku/haikuish.h"
2806 #else
2807 #   include "unixish.h"
2808 #endif
2809
2810 #ifdef __amigaos4__
2811 #    include "amigaos.h"
2812 #    undef FD_CLOEXEC /* a lie in AmigaOS */
2813 #endif
2814
2815 /* NSIG logic from Configure --> */
2816 #ifndef NSIG
2817 #  ifdef _NSIG
2818 #    define NSIG (_NSIG)
2819 #  elif defined(SIGMAX)
2820 #    define NSIG (SIGMAX+1)
2821 #  elif defined(SIG_MAX)
2822 #    define NSIG (SIG_MAX+1)
2823 #  elif defined(_SIG_MAX)
2824 #    define NSIG (_SIG_MAX+1)
2825 #  elif defined(MAXSIG)
2826 #    define NSIG (MAXSIG+1)
2827 #  elif defined(MAX_SIG)
2828 #    define NSIG (MAX_SIG+1)
2829 #  elif defined(SIGARRAYSIZE)
2830 #    define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
2831 #  elif defined(_sys_nsig)
2832 #    define NSIG (_sys_nsig) /* Solaris 2.5 */
2833 #  else
2834      /* Default to some arbitrary number that's big enough to get most
2835       * of the common signals.  */
2836 #    define NSIG 50
2837 #  endif
2838 #endif
2839 /* <-- NSIG logic from Configure */
2840
2841 #ifndef NO_ENVIRON_ARRAY
2842 #  define USE_ENVIRON_ARRAY
2843 #endif
2844
2845 #ifdef USE_ITHREADS
2846    /* On some platforms it would be safe to use a read/write mutex with many
2847     * readers possible at the same time.  On other platforms, notably IBM ones,
2848     * subsequent getenv calls destroy earlier ones.  Those platforms would not
2849     * be able to handle simultaneous getenv calls */
2850 #  define ENV_LOCK            MUTEX_LOCK(&PL_env_mutex)
2851 #  define ENV_UNLOCK          MUTEX_UNLOCK(&PL_env_mutex)
2852 #  define ENV_INIT            MUTEX_INIT(&PL_env_mutex);
2853 #  define ENV_TERM            MUTEX_DESTROY(&PL_env_mutex);
2854 #else
2855 #  define ENV_LOCK       NOOP;
2856 #  define ENV_UNLOCK     NOOP;
2857 #  define ENV_INIT       NOOP;
2858 #  define ENV_TERM       NOOP;
2859 #endif
2860
2861 /* Some critical sections need to lock both the locale and the environment.
2862  * XXX khw intends to change this to lock both mutexes, but that brings up
2863  * issues of potential deadlock, so should be done at the beginning of a
2864  * development cycle.  So for now, it just locks the environment.  Note that
2865  * many modern platforms are locale-thread-safe anyway, so locking the locale
2866  * mutex is a no-op anyway */
2867 #define ENV_LOCALE_LOCK     ENV_LOCK
2868 #define ENV_LOCALE_UNLOCK   ENV_UNLOCK
2869
2870 /* And some critical sections care only that no one else is writing either the
2871  * locale nor the environment.  XXX Again this is for the future.  This can be
2872  * simulated with using COND_WAIT in thread.h */
2873 #define ENV_LOCALE_READ_LOCK     ENV_LOCALE_LOCK
2874 #define ENV_LOCALE_READ_UNLOCK   ENV_LOCALE_UNLOCK
2875
2876 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
2877     /* having sigaction(2) means that the OS supports both 1-arg and 3-arg
2878      * signal handlers. But the perl core itself only fully supports 1-arg
2879      * handlers, so don't enable for now.
2880      * NB: POSIX::sigaction() supports both.
2881      *
2882      * # define PERL_USE_3ARG_SIGHANDLER
2883      */
2884 #endif
2885
2886 /* Siginfo_t:
2887  * This is an alias for the OS's siginfo_t, except that where the OS
2888  * doesn't support it, declare a dummy version instead. This allows us to
2889  * have signal handler functions which always have a Siginfo_t parameter
2890  * regardless of platform, (and which will just be passed a NULL value
2891  * where the OS doesn't support HAS_SIGACTION).
2892  */
2893
2894 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
2895     typedef siginfo_t Siginfo_t;
2896 #else
2897 #ifdef si_signo /* minix */
2898 #undef si_signo
2899 #endif
2900     typedef struct {
2901         int si_signo;
2902     } Siginfo_t;
2903 #endif
2904
2905
2906 /*
2907  * initialise to avoid floating-point exceptions from overflow, etc
2908  */
2909 #ifndef PERL_FPU_INIT
2910 #  ifdef HAS_FPSETMASK
2911 #    if HAS_FLOATINGPOINT_H
2912 #      include <floatingpoint.h>
2913 #    endif
2914 /* Some operating systems have this as a macro, which in turn expands to a comma
2915    expression, and the last sub-expression is something that gets calculated,
2916    and then they have the gall to warn that a value computed is not used. Hence
2917    cast to void.  */
2918 #    define PERL_FPU_INIT (void)fpsetmask(0)
2919 #  elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2920 #    define PERL_FPU_INIT       PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2921 #    define PERL_FPU_PRE_EXEC   { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2922 #    define PERL_FPU_POST_EXEC    rsignal_restore(SIGFPE, &xfpe); }
2923 #  else
2924 #    define PERL_FPU_INIT
2925 #  endif
2926 #endif
2927 #ifndef PERL_FPU_PRE_EXEC
2928 #  define PERL_FPU_PRE_EXEC   {
2929 #  define PERL_FPU_POST_EXEC  }
2930 #endif
2931
2932 /* In Tru64 the cc -ieee enables the IEEE math but disables traps.
2933  * We need to reenable the "invalid" trap because otherwise generation
2934  * of NaN values leaves the IEEE fp flags in bad state, leaving any further
2935  * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
2936 #ifdef __osf__
2937 #  include <machine/fpu.h>
2938 #  define PERL_SYS_FPU_INIT \
2939      STMT_START { \
2940          ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
2941          signal(SIGFPE, SIG_IGN); \
2942      } STMT_END
2943 #endif
2944 /* In IRIX the default for Flush to Zero bit is true,
2945  * which means that results going below the minimum of normal
2946  * floating points go to zero, instead of going denormal/subnormal.
2947  * This is unlike almost any other system running Perl, so let's clear it.
2948  * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
2949  * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
2950  *
2951  * XXX The flush-to-zero behaviour should be a Configure scan.
2952  * To change the behaviour usually requires some system-specific
2953  * incantation, though, like the below. */
2954 #ifdef __sgi
2955 #  include <sys/fpu.h>
2956 #  define PERL_SYS_FPU_INIT \
2957      STMT_START { \
2958          union fpc_csr csr; \
2959          csr.fc_word = get_fpc_csr(); \
2960          csr.fc_struct.flush = 0; \
2961          set_fpc_csr(csr.fc_word); \
2962      } STMT_END
2963 #endif
2964
2965 #ifndef PERL_SYS_FPU_INIT
2966 #  define PERL_SYS_FPU_INIT NOOP
2967 #endif
2968
2969 #ifndef PERL_SYS_INIT3_BODY
2970 #  define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
2971 #endif
2972
2973 /*
2974 =head1 Miscellaneous Functions
2975
2976 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
2977 Provides system-specific tune up of the C runtime environment necessary to
2978 run Perl interpreters.  This should be called only once, before creating
2979 any Perl interpreters.
2980
2981 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
2982 Provides system-specific tune up of the C runtime environment necessary to
2983 run Perl interpreters.  This should be called only once, before creating
2984 any Perl interpreters.
2985
2986 =for apidoc Am|void|PERL_SYS_TERM|
2987 Provides system-specific clean up of the C runtime environment after
2988 running Perl interpreters.  This should be called only once, after
2989 freeing any remaining Perl interpreters.
2990
2991 =cut
2992  */
2993
2994 #define PERL_SYS_INIT(argc, argv)       Perl_sys_init(argc, argv)
2995 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
2996 #define PERL_SYS_TERM()                 Perl_sys_term()
2997
2998 #ifndef PERL_WRITE_MSG_TO_CONSOLE
2999 #  define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
3000 #endif
3001
3002 #ifndef MAXPATHLEN
3003 #  ifdef PATH_MAX
3004 #    ifdef _POSIX_PATH_MAX
3005 #       if PATH_MAX > _POSIX_PATH_MAX
3006 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
3007  * included the null byte or not.  Later amendments of POSIX,
3008  * XPG4, the Austin Group, and the Single UNIX Specification
3009  * all explicitly include the null byte in the PATH_MAX.
3010  * Ditto for _POSIX_PATH_MAX. */
3011 #         define MAXPATHLEN PATH_MAX
3012 #       else
3013 #         define MAXPATHLEN _POSIX_PATH_MAX
3014 #       endif
3015 #    else
3016 #      define MAXPATHLEN (PATH_MAX+1)
3017 #    endif
3018 #  else
3019 #    define MAXPATHLEN 1024     /* Err on the large side. */
3020 #  endif
3021 #endif
3022
3023 /* clang Thread Safety Analysis/Annotations/Attributes
3024  * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
3025  *
3026  * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
3027  * Apple XCode hijacks __clang_major__ and __clang_minor__
3028  * (6.1 means really clang 3.6), so needs extra hijinks
3029  * (could probably also test the contents of __apple_build_version__).
3030  */
3031 #if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
3032     defined(__clang__) && \
3033     !defined(SWIG) && \
3034   ((!defined(__apple_build_version__) &&               \
3035     ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
3036      (__clang_major__ >= 4))) || \
3037    (defined(__apple_build_version__) &&                \
3038     ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
3039      (__clang_major__ >= 7))))
3040 #  define PERL_TSA__(x)   __attribute__((x))
3041 #  define PERL_TSA_ACTIVE
3042 #else
3043 #  define PERL_TSA__(x)   /* No TSA, make TSA attributes no-ops. */
3044 #  undef PERL_TSA_ACTIVE
3045 #endif
3046
3047 /* PERL_TSA_CAPABILITY() is used to annotate typedefs.
3048  * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
3049  */
3050 #define PERL_TSA_CAPABILITY(x) \
3051     PERL_TSA__(capability(x))
3052
3053 /* In the below examples the mutex must be lexically visible, usually
3054  * either as global variables, or as function arguments. */
3055
3056 /* PERL_TSA_GUARDED_BY() is used to annotate global variables.
3057  *
3058  * Foo foo PERL_TSA_GUARDED_BY(mutex);
3059  */
3060 #define PERL_TSA_GUARDED_BY(x) \
3061     PERL_TSA__(guarded_by(x))
3062
3063 /* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
3064  * The data _behind_ the pointer is guarded.
3065  *
3066  * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
3067  */
3068 #define PERL_TSA_PT_GUARDED_BY(x) \
3069     PERL_TSA__(pt_guarded_by(x))
3070
3071 /* PERL_TSA_REQUIRES() is used to annotate functions.
3072  * The caller MUST hold the resource when calling the function.
3073  *
3074  * void Foo() PERL_TSA_REQUIRES(mutex);
3075  */
3076 #define PERL_TSA_REQUIRES(x) \
3077     PERL_TSA__(requires_capability(x))
3078
3079 /* PERL_TSA_EXCLUDES() is used to annotate functions.
3080  * The caller MUST NOT hold resource when calling the function.
3081  *
3082  * EXCLUDES should be used when the function first acquires
3083  * the resource and then releases it.  Use to avoid deadlock.
3084  *
3085  * void Foo() PERL_TSA_EXCLUDES(mutex);
3086  */
3087 #define PERL_TSA_EXCLUDES(x) \
3088     PERL_TSA__(locks_excluded(x))
3089
3090 /* PERL_TSA_ACQUIRE() is used to annotate functions.
3091  * The caller MUST NOT hold the resource when calling the function,
3092  * and the function will acquire the resource.
3093  *
3094  * void Foo() PERL_TSA_ACQUIRE(mutex);
3095  */
3096 #define PERL_TSA_ACQUIRE(x) \
3097     PERL_TSA__(acquire_capability(x))
3098
3099 /* PERL_TSA_RELEASE() is used to annotate functions.
3100  * The caller MUST hold the resource when calling the function,
3101  * and the function will release the resource.
3102  *
3103  * void Foo() PERL_TSA_RELEASE(mutex);
3104  */
3105 #define PERL_TSA_RELEASE(x) \
3106     PERL_TSA__(release_capability(x))
3107
3108 /* PERL_TSA_NO_TSA is used to annotate functions.
3109  * Used when being intentionally unsafe, or when the code is too
3110  * complicated for the analysis.  Use sparingly.
3111  *
3112  * void Foo() PERL_TSA_NO_TSA;
3113  */
3114 #define PERL_TSA_NO_TSA \
3115     PERL_TSA__(no_thread_safety_analysis)
3116
3117 /* There are more annotations/attributes available, see the clang
3118  * documentation for details. */
3119
3120 #if defined(USE_ITHREADS)
3121 #  ifdef NETWARE
3122 #    include <nw5thread.h>
3123 #  elif defined(WIN32)
3124 #    include <win32thread.h>
3125 #  elif defined(OS2)
3126 #    include "os2thread.h"
3127 #  elif defined(I_MACH_CTHREADS)
3128 #    include <mach/cthreads.h>
3129 typedef cthread_t       perl_os_thread;
3130 typedef mutex_t         perl_mutex;
3131 typedef condition_t     perl_cond;
3132 typedef void *          perl_key;
3133 #  elif defined(I_PTHREAD) /* Posix threads */
3134 #    include <pthread.h>
3135 typedef pthread_t       perl_os_thread;
3136 typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
3137 typedef pthread_cond_t  perl_cond;
3138 typedef pthread_key_t   perl_key;
3139 #  endif
3140 #endif /* USE_ITHREADS */
3141
3142 #ifdef PERL_TSA_ACTIVE
3143 /* Since most pthread mutex interfaces have not been annotated, we
3144  * need to have these wrappers. The NO_TSA annotation is quite ugly
3145  * but it cannot be avoided in plain C, unlike in C++, where one could
3146  * e.g. use ACQUIRE() with no arg on a mutex lock method.
3147  *
3148  * The bodies of these wrappers are in util.c
3149  *
3150  * TODO: however, some platforms are starting to get these clang
3151  * thread safety annotations for pthreads, for example FreeBSD.
3152  * Do we need a way to a bypass these wrappers? */
3153 EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
3154   PERL_TSA_ACQUIRE(*mutex)
3155   PERL_TSA_NO_TSA;
3156 EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
3157   PERL_TSA_RELEASE(*mutex)
3158   PERL_TSA_NO_TSA;
3159 #endif
3160
3161 #if defined(WIN32)
3162 #  include "win32.h"
3163 #endif
3164
3165 #ifdef NETWARE
3166 #  include "netware.h"
3167 #endif
3168
3169 #define STATUS_UNIX     PL_statusvalue
3170 #ifdef VMS
3171 #   define STATUS_NATIVE        PL_statusvalue_vms
3172 /*
3173  * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
3174  * its contents can not be trusted.  Unfortunately, Perl seems to check
3175  * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
3176  * be updated also.
3177  */
3178 #  include <stsdef.h>
3179 #  include <ssdef.h>
3180 /* Presume this because if VMS changes it, it will require a new
3181  * set of APIs for waiting on children for binary compatibility.
3182  */
3183 #  define child_offset_bits (8)
3184 #  ifndef C_FAC_POSIX
3185 #  define C_FAC_POSIX 0x35A000
3186 #  endif
3187
3188 /*  STATUS_EXIT - validates and returns a NATIVE exit status code for the
3189  * platform from the existing UNIX or Native status values.
3190  */
3191
3192 #   define STATUS_EXIT \
3193         (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
3194            (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
3195
3196
3197 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
3198  * exit code and shifts the UNIX value over the correct number of bits to
3199  * be a child status.  Usually the number of bits is 8, but that could be
3200  * platform dependent.  The NATIVE status code is presumed to have either
3201  * from a child process.
3202  */
3203
3204 /* This is complicated.  The child processes return a true native VMS
3205    status which must be saved.  But there is an assumption in Perl that
3206    the UNIX child status has some relationship to errno values, so
3207    Perl tries to translate it to text in some of the tests.
3208    In order to get the string translation correct, for the error, errno
3209    must be EVMSERR, but that generates a different text message
3210    than what the test programs are expecting.  So an errno value must
3211    be derived from the native status value when an error occurs.
3212    That will hide the true native status message.  With this version of
3213    perl, the true native child status can always be retrieved so that
3214    is not a problem.  But in this case, Pl_statusvalue and errno may
3215    have different values in them.
3216  */
3217
3218 #   define STATUS_NATIVE_CHILD_SET(n) \
3219         STMT_START {                                                    \
3220             I32 evalue = (I32)n;                                        \
3221             if (evalue == EVMSERR) {                                    \
3222               PL_statusvalue_vms = vaxc$errno;                          \
3223               PL_statusvalue = evalue;                                  \
3224             } else {                                                    \
3225               PL_statusvalue_vms = evalue;                              \
3226               if (evalue == -1) {                                       \
3227                 PL_statusvalue = -1;                                    \
3228                 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3229               } else                                                    \
3230                 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1);    \
3231               set_vaxc_errno(evalue);                                   \
3232               if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX)    \
3233                   set_errno(EVMSERR);                                   \
3234               else set_errno(Perl_vms_status_to_unix(evalue, 0));       \
3235               PL_statusvalue = PL_statusvalue << child_offset_bits;     \
3236             }                                                           \
3237         } STMT_END
3238
3239 #   ifdef VMSISH_STATUS
3240 #       define STATUS_CURRENT   (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
3241 #   else
3242 #       define STATUS_CURRENT   STATUS_UNIX
3243 #   endif
3244
3245   /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3246    * the NATIVE status to an equivalent value.  Can not be used to translate
3247    * exit code values as exit code values are not guaranteed to have any
3248    * relationship at all to errno values.
3249    * This is used when Perl is forcing errno to have a specific value.
3250    */
3251 #   define STATUS_UNIX_SET(n)                           \
3252         STMT_START {                                    \
3253             I32 evalue = (I32)n;                        \
3254             PL_statusvalue = evalue;                    \
3255             if (PL_statusvalue != -1) {                 \
3256                 if (PL_statusvalue != EVMSERR) {        \
3257                   PL_statusvalue &= 0xFFFF;             \
3258                   if (MY_POSIX_EXIT)                    \
3259                     PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3260                   else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3261                 }                                       \
3262                 else {                                  \
3263                   PL_statusvalue_vms = vaxc$errno;      \
3264                 }                                       \
3265             }                                           \
3266             else PL_statusvalue_vms = SS$_ABORT;        \
3267             set_vaxc_errno(PL_statusvalue_vms);         \
3268         } STMT_END
3269
3270   /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
3271    * the NATIVE error status based on it.
3272    *
3273    * When in the default mode to comply with the Perl VMS documentation,
3274    * 0 is a success and any other code sets the NATIVE status to a failure
3275    * code of SS$_ABORT.
3276    *
3277    * In the new POSIX EXIT mode, native status will be set so that the
3278    * actual exit code will can be retrieved by the calling program or
3279    * shell.
3280    *
3281    * If the exit code is not clearly a UNIX parent or child exit status,
3282    * it will be passed through as a VMS status.
3283    */
3284
3285 #   define STATUS_UNIX_EXIT_SET(n)                      \
3286         STMT_START {                                    \
3287             I32 evalue = (I32)n;                        \
3288             PL_statusvalue = evalue;                    \
3289             if (MY_POSIX_EXIT) { \
3290               if (evalue <= 0xFF00) {           \
3291                   if (evalue > 0xFF)                    \
3292                     evalue = (evalue >> child_offset_bits) & 0xFF; \
3293                   PL_statusvalue_vms =          \
3294                     (C_FAC_POSIX | (evalue << 3 ) |     \
3295                     ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3296               } else /* forgive them Perl, for they have sinned */ \
3297                 PL_statusvalue_vms = evalue; \
3298             } else { \
3299               if (evalue == 0)                  \
3300                 PL_statusvalue_vms = SS$_NORMAL;        \
3301               else if (evalue <= 0xFF00) \
3302                 PL_statusvalue_vms = SS$_ABORT; \
3303               else { /* forgive them Perl, for they have sinned */ \
3304                   if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3305                   else PL_statusvalue_vms = vaxc$errno; \
3306                   /* And obviously used a VMS status value instead of UNIX */ \
3307                   PL_statusvalue = EVMSERR;             \
3308               } \
3309               set_vaxc_errno(PL_statusvalue_vms);       \
3310             }                                           \
3311         } STMT_END
3312
3313
3314   /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3315    * and sets the NATIVE error status based on it.  This special case
3316    * is needed to maintain compatibility with past VMS behavior.
3317    *
3318    * In the default mode on VMS, this number is passed through as
3319    * both the NATIVE and UNIX status.  Which makes it different
3320    * that the STATUS_UNIX_EXIT_SET.
3321    *
3322    * In the new POSIX EXIT mode, native status will be set so that the
3323    * actual exit code will can be retrieved by the calling program or
3324    * shell.
3325    *
3326    * A POSIX exit code is from 0 to 255.  If the exit code is higher
3327    * than this, it needs to be assumed that it is a VMS exit code and
3328    * passed through.
3329    */
3330
3331 #   define STATUS_EXIT_SET(n)                           \
3332         STMT_START {                                    \
3333             I32 evalue = (I32)n;                        \
3334             PL_statusvalue = evalue;                    \
3335             if (MY_POSIX_EXIT)                          \
3336                 if (evalue > 255) PL_statusvalue_vms = evalue; else {   \
3337                   PL_statusvalue_vms = \
3338                     (C_FAC_POSIX | (evalue << 3 ) |     \
3339                      ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
3340             else                                        \
3341                 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3342             set_vaxc_errno(PL_statusvalue_vms);         \
3343         } STMT_END
3344
3345
3346  /* This macro forces a success status */
3347 #   define STATUS_ALL_SUCCESS   \
3348         (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
3349
3350  /* This macro forces a failure status */
3351 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, \
3352      vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3353         (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3354
3355 #elif defined(__amigaos4__)
3356  /* A somewhat experimental attempt to simulate posix return code values */
3357 #   define STATUS_NATIVE        PL_statusvalue_posix
3358 #   define STATUS_NATIVE_CHILD_SET(n)                      \
3359         STMT_START {                                       \
3360             PL_statusvalue_posix = (n);                    \
3361             if (PL_statusvalue_posix < 0) {                \
3362                 PL_statusvalue = -1;                       \
3363             }                                              \
3364             else {                                         \
3365                 PL_statusvalue = n << 8;                   \
3366             }                                              \
3367         } STMT_END
3368 #   define STATUS_UNIX_SET(n)           \
3369         STMT_START {                    \
3370             PL_statusvalue = (n);               \
3371             if (PL_statusvalue != -1)   \
3372                 PL_statusvalue &= 0xFFFF;       \
3373         } STMT_END
3374 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3375 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3376 #   define STATUS_CURRENT STATUS_UNIX
3377 #   define STATUS_EXIT STATUS_UNIX
3378 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3379 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3380
3381 #else
3382 #   define STATUS_NATIVE        PL_statusvalue_posix
3383 #   if defined(WCOREDUMP)
3384 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3385             STMT_START {                                   \
3386                 PL_statusvalue_posix = (n);                \
3387                 if (PL_statusvalue_posix == -1)            \
3388                     PL_statusvalue = -1;                   \
3389                 else {                                     \
3390                     PL_statusvalue =                       \
3391                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3392                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3393                         (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0);  \
3394                 }                                          \
3395             } STMT_END
3396 #   elif defined(WIFEXITED)
3397 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3398             STMT_START {                                   \
3399                 PL_statusvalue_posix = (n);                \
3400                 if (PL_statusvalue_posix == -1)            \
3401                     PL_statusvalue = -1;                   \
3402                 else {                                     \
3403                     PL_statusvalue =                       \
3404                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3405                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0);  \
3406                 }                                          \
3407             } STMT_END
3408 #   else
3409 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3410             STMT_START {                                   \
3411                 PL_statusvalue_posix = (n);                \
3412                 if (PL_statusvalue_posix == -1)            \
3413                     PL_statusvalue = -1;                   \
3414                 else {                                     \
3415                     PL_statusvalue =                       \
3416                         PL_statusvalue_posix & 0xFFFF;     \
3417                 }                                          \
3418             } STMT_END
3419 #   endif
3420 #   define STATUS_UNIX_SET(n)           \
3421         STMT_START {                    \
3422             PL_statusvalue = (n);               \
3423             if (PL_statusvalue != -1)   \
3424                 PL_statusvalue &= 0xFFFF;       \
3425         } STMT_END
3426 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3427 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3428 #   define STATUS_CURRENT STATUS_UNIX
3429 #   define STATUS_EXIT STATUS_UNIX
3430 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3431 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3432 #endif
3433
3434 /* flags in PL_exit_flags for nature of exit() */
3435 #define PERL_EXIT_EXPECTED      0x01
3436 #define PERL_EXIT_DESTRUCT_END  0x02  /* Run END in perl_destruct */
3437 #define PERL_EXIT_WARN          0x04  /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3438 #define PERL_EXIT_ABORT         0x08  /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3439
3440 #ifndef PERL_CORE
3441 /* format to use for version numbers in file/directory names */
3442 /* XXX move to Configure? */
3443 /* This was only ever used for the current version, and that can be done at
3444    compile time, as PERL_FS_VERSION, so should we just delete it?  */
3445 #  ifndef PERL_FS_VER_FMT
3446 #    define PERL_FS_VER_FMT     "%d.%d.%d"
3447 #  endif
3448 #endif
3449
3450 #ifndef PERL_FS_VERSION
3451 #  define PERL_FS_VERSION       PERL_VERSION_STRING
3452 #endif
3453
3454 /* This defines a way to flush all output buffers.  This may be a
3455  * performance issue, so we allow people to disable it.  Also, if
3456  * we are using stdio, there are broken implementations of fflush(NULL)
3457  * out there, Solaris being the most prominent.
3458  */
3459 #ifndef PERL_FLUSHALL_FOR_CHILD
3460 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3461 #  define PERL_FLUSHALL_FOR_CHILD       PerlIO_flush((PerlIO*)NULL)
3462 # elif defined(FFLUSH_ALL)
3463 #  define PERL_FLUSHALL_FOR_CHILD       my_fflush_all()
3464 # else
3465 #  define PERL_FLUSHALL_FOR_CHILD       NOOP
3466 # endif
3467 #endif
3468
3469 #ifndef PERL_WAIT_FOR_CHILDREN
3470 #  define PERL_WAIT_FOR_CHILDREN        NOOP
3471 #endif
3472
3473 /* the traditional thread-unsafe notion of "current interpreter". */
3474 #ifndef PERL_SET_INTERP
3475 #  define PERL_SET_INTERP(i)            (PL_curinterp = (PerlInterpreter*)(i))
3476 #endif
3477
3478 #ifndef PERL_GET_INTERP
3479 #  define PERL_GET_INTERP               (PL_curinterp)
3480 #endif
3481
3482 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3483 #  ifdef MULTIPLICITY
3484 #    define PERL_GET_THX                ((PerlInterpreter *)PERL_GET_CONTEXT)
3485 #  endif
3486 #  define PERL_SET_THX(t)               PERL_SET_CONTEXT(t)
3487 #endif
3488
3489 /*
3490     This replaces the previous %_ "hack" by the "%p" hacks.
3491     All that is required is that the perl source does not
3492     use "%-p" or "%-<number>p" or "%<number>p" formats.
3493     These formats will still work in perl code.
3494     See comments in sv.c for further details.
3495
3496     Robin Barker 2005-07-14
3497
3498     No longer use %1p for VDf = %vd.  RMB 2007-10-19
3499 */
3500
3501 #ifndef SVf_
3502 #  define SVf_(n) "-" STRINGIFY(n) "p"
3503 #endif
3504
3505 #ifndef SVf
3506 #  define SVf "-p"
3507 #endif
3508
3509 #ifndef SVf32
3510 #  define SVf32 SVf_(32)
3511 #endif
3512
3513 #ifndef SVf256
3514 #  define SVf256 SVf_(256)
3515 #endif
3516
3517 #define SVfARG(p) ((void*)(p))
3518
3519 #ifndef HEKf
3520 #  define HEKf "2p"
3521 #endif
3522
3523 /* Not ideal, but we cannot easily include a number in an already-numeric
3524  * format sequence. */
3525 #ifndef HEKf256
3526 #  define HEKf256 "3p"
3527 #endif
3528
3529 #define HEKfARG(p) ((void*)(p))
3530
3531 /*
3532 =for apidoc Amnh||UTF8f
3533 =for apidoc Amh||UTF8fARG|bool is_utf8|Size_t byte_len|char *str
3534
3535 =cut
3536  * %4p is a custom format
3537  */
3538 #ifndef UTF8f
3539 #  define UTF8f "d%" UVuf "%4p"
3540 #endif
3541 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3542
3543 #define PNf UTF8f
3544 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
3545
3546 #ifdef PERL_CORE
3547 /* not used; but needed for backward compatibility with XS code? - RMB */
3548 #  undef UVf
3549 #elif !defined(UVf)
3550 #  define UVf UVuf
3551 #endif
3552
3553 #if !defined(DEBUGGING) && !defined(NDEBUG)
3554 #  define NDEBUG 1
3555 #endif
3556 #include <assert.h>
3557
3558 /* For functions that are marked as __attribute__noreturn__, it's not
3559    appropriate to call return.  In either case, include the lint directive.
3560  */
3561 #ifdef HASATTRIBUTE_NORETURN
3562 #  define NORETURN_FUNCTION_END NOT_REACHED;
3563 #else
3564 #  define NORETURN_FUNCTION_END NOT_REACHED; return 0
3565 #endif
3566
3567 #ifdef HAS_BUILTIN_EXPECT
3568 #  define EXPECT(expr,val)                  __builtin_expect(expr,val)
3569 #else
3570 #  define EXPECT(expr,val)                  (expr)
3571 #endif
3572
3573 /*
3574 =head1 Miscellaneous Functions
3575
3576 =for apidoc AmU|bool|LIKELY|const bool expr
3577
3578 Returns the input unchanged, but at the same time it gives a branch prediction
3579 hint to the compiler that this condition is likely to be true.
3580
3581 =for apidoc AmU|bool|UNLIKELY|const bool expr
3582
3583 Returns the input unchanged, but at the same time it gives a branch prediction
3584 hint to the compiler that this condition is likely to be false.
3585
3586 =cut
3587 */
3588 #define LIKELY(cond)                        EXPECT(cBOOL(cond),TRUE)
3589 #define UNLIKELY(cond)                      EXPECT(cBOOL(cond),FALSE)
3590
3591 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3592 /* placeholder */
3593 #endif
3594
3595 /* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
3596    time invariants. That is, their argument must be a constant expression that
3597    can be verified by the compiler. This expression can contain anything that's
3598    known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3599    the expression evaluates to 0, compilation fails.
3600    Because they generate no runtime code (i.e.  their use is "free"), they're
3601    always active, even under non-DEBUGGING builds.
3602    STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
3603    file scope (outside of any function).
3604    STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3605    function.
3606 */
3607 #if (! defined(__IBMC__) || __IBMC__ >= 1210)                               \
3608  && ((   defined(static_assert) && (   defined(_ISOC11_SOURCE)              \
3609                                     || (__STDC_VERSION__ - 0) >= 201101L))  \
3610      || (defined(__cplusplus) && __cplusplus >= 201103L))
3611 /* XXX static_assert is a macro defined in <assert.h> in C11 or a compiler
3612    builtin in C++11.  But IBM XL C V11 does not support _Static_assert, no
3613    matter what <assert.h> says.
3614 */
3615 #  define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
3616 #else
3617 /* We use a bit-field instead of an array because gcc accepts
3618    'typedef char x[n]' where n is not a compile-time constant.
3619    We want to enforce constantness.
3620 */
3621 #  define STATIC_ASSERT_2(COND, SUFFIX) \
3622     typedef struct { \
3623         unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3624     } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3625 #  define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
3626 #  define STATIC_ASSERT_DECL(COND)    STATIC_ASSERT_1(COND, __LINE__)
3627 #endif
3628 /* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3629    error (static_assert is a declaration, and only statements can have labels).
3630 */
3631 #define STATIC_ASSERT_STMT(COND)      STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
3632
3633 #ifndef __has_builtin
3634 #  define __has_builtin(x) 0 /* not a clang style compiler */
3635 #endif
3636
3637 /* ASSUME is like assert(), but it has a benefit in a release build. It is a
3638    hint to a compiler about a statement of fact in a function call free
3639    expression, which allows the compiler to generate better machine code.
3640    In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3641    the control path is unreachable. In a for loop, ASSUME can be used to hint
3642    that a loop will run at least X times. ASSUME is based off MSVC's __assume
3643    intrinsic function, see its documents for more details.
3644 */
3645
3646 #ifndef DEBUGGING
3647 #  if __has_builtin(__builtin_unreachable) \
3648      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4) /* 4.5 -> */
3649 #    define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3650 #  elif defined(_MSC_VER)
3651 #    define ASSUME(x) __assume(x)
3652 #  elif defined(__ARMCC_VERSION) /* untested */
3653 #    define ASSUME(x) __promise(x)
3654 #  else
3655 /* a random compiler might define assert to its own special optimization token
3656    so pass it through to C lib as a last resort */
3657 #    define ASSUME(x) assert(x)
3658 #  endif
3659 #else
3660 #  define ASSUME(x) assert(x)
3661 #endif
3662
3663 #if defined(__sun)      /* ASSUME() generates warnings on Solaris */
3664 #  define NOT_REACHED
3665 #elif defined(DEBUGGING) && (__has_builtin(__builtin_unreachable) \
3666      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4)) /* 4.5 -> */
3667 #  define NOT_REACHED STMT_START { ASSUME(!"UNREACHABLE"); __builtin_unreachable(); } STMT_END
3668 #else
3669 #  define NOT_REACHED ASSUME(!"UNREACHABLE")
3670 #endif
3671
3672 /* Some unistd.h's give a prototype for pause() even though
3673    HAS_PAUSE ends up undefined.  This causes the #define
3674    below to be rejected by the compiler.  Sigh.
3675 */
3676 #ifdef HAS_PAUSE
3677 #define Pause   pause
3678 #else
3679 #define Pause() sleep((32767<<16)+32767)
3680 #endif
3681
3682 #ifndef IOCPARM_LEN
3683 #   ifdef IOCPARM_MASK
3684         /* on BSDish systems we're safe */
3685 #       define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
3686 #   elif defined(_IOC_SIZE) && defined(__GLIBC__)
3687         /* on Linux systems we're safe; except when we're not [perl #38223] */
3688 #       define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3689 #   else
3690         /* otherwise guess at what's safe */
3691 #       define IOCPARM_LEN(x)   256
3692 #   endif
3693 #endif
3694
3695 #if defined(__CYGWIN__)
3696 /* USEMYBINMODE
3697  *   This symbol, if defined, indicates that the program should
3698  *   use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3699  *   that a file is in "binary" mode -- that is, that no translation
3700  *   of bytes occurs on read or write operations.
3701  */
3702 #  define USEMYBINMODE /**/
3703 #  include <io.h> /* for setmode() prototype */
3704 #  define my_binmode(fp, iotype, mode) \
3705             cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
3706 #endif
3707
3708 #ifdef __CYGWIN__
3709 void init_os_extras(void);
3710 #endif
3711
3712 #ifdef UNION_ANY_DEFINITION
3713 UNION_ANY_DEFINITION;
3714 #else
3715 union any {
3716     void*       any_ptr;
3717     SV*         any_sv;
3718     SV**        any_svp;
3719     GV*         any_gv;
3720     AV*         any_av;
3721     HV*         any_hv;
3722     OP*         any_op;
3723     char*       any_pv;
3724     char**      any_pvp;
3725     I32         any_i32;
3726     U32         any_u32;
3727     IV          any_iv;
3728     UV          any_uv;
3729     long        any_long;
3730     bool        any_bool;
3731     void        (*any_dptr) (void*);
3732     void        (*any_dxptr) (pTHX_ void*);
3733 };
3734 #endif
3735
3736 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3737
3738 #define FILTER_READ(idx, sv, len)  filter_read(idx, sv, len)
3739 #define FILTER_DATA(idx) \
3740             (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3741 #define FILTER_ISREADER(idx) \
3742             (PL_parser && PL_parser->rsfp_filters \
3743                 && idx >= AvFILLp(PL_parser->rsfp_filters))
3744 #define PERL_FILTER_EXISTS(i) \
3745             (PL_parser && PL_parser->rsfp_filters \
3746                 && (i) <= av_tindex(PL_parser->rsfp_filters))
3747
3748 #if defined(_AIX) && !defined(_AIX43)
3749 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3750 /* We cannot include <crypt.h> to get the struct crypt_data
3751  * because of setkey prototype problems when threading */
3752 typedef        struct crypt_data {     /* straight from /usr/include/crypt.h */
3753     /* From OSF, Not needed in AIX
3754        char C[28], D[28];
3755     */
3756     char E[48];
3757     char KS[16][48];
3758     char block[66];
3759     char iobuf[16];
3760 } CRYPTD;
3761 #endif /* threading */
3762 #endif /* AIX */
3763
3764 #ifndef PERL_CALLCONV
3765 #  ifdef __cplusplus
3766 #    define PERL_CALLCONV extern "C"
3767 #  else
3768 #    define PERL_CALLCONV
3769 #  endif
3770 #endif
3771 #ifndef PERL_CALLCONV_NO_RET
3772 #    define PERL_CALLCONV_NO_RET PERL_CALLCONV
3773 #endif
3774
3775 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
3776    dont have a noreturn as a declaration specifier
3777 */
3778 #ifndef PERL_STATIC_NO_RET
3779 #  define PERL_STATIC_NO_RET STATIC
3780 #endif
3781 /* PERL_STATIC_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE on
3782    builds that dont have a noreturn as a declaration specifier
3783 */
3784 #ifndef PERL_STATIC_INLINE_NO_RET
3785 #  define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
3786 #endif
3787
3788 #ifndef PERL_STATIC_FORCE_INLINE
3789 #  define PERL_STATIC_FORCE_INLINE PERL_STATIC_INLINE
3790 #endif
3791
3792 #ifndef PERL_STATIC_FORCE_INLINE_NO_RET
3793 #  define PERL_STATIC_FORCE_INLINE_NO_RET PERL_STATIC_INLINE
3794 #endif
3795
3796 #if !defined(OS2)
3797 #  include "iperlsys.h"
3798 #endif
3799
3800 #ifdef __LIBCATAMOUNT__
3801 #undef HAS_PASSWD  /* unixish.h but not unixish enough. */
3802 #undef HAS_GROUP
3803 #define FAKE_BIT_BUCKET
3804 #endif
3805
3806 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3807  * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
3808  * Configure, despite their names being similar to other defines like
3809  * USE_ITHREADS.  Configure in fact knows nothing about the randomised
3810  * hashes.  Therefore to enable/disable the hash randomisation defines
3811  * use the Configure -Accflags=... instead. */
3812 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
3813 #  define USE_HASH_SEED
3814 #endif
3815
3816 #include "perly.h"
3817
3818
3819 /* macros to define bit-fields in structs. */
3820 #ifndef PERL_BITFIELD8
3821 #  define PERL_BITFIELD8 U8
3822 #endif
3823 #ifndef PERL_BITFIELD16
3824 #  define PERL_BITFIELD16 U16
3825 #endif
3826 #ifndef PERL_BITFIELD32
3827 #  define PERL_BITFIELD32 U32
3828 #endif
3829
3830 #include "sv.h"
3831 #include "regexp.h"
3832 #include "util.h"
3833 #include "form.h"
3834 #include "gv.h"
3835 #include "pad.h"
3836 #include "cv.h"
3837 #include "opnames.h"
3838 #include "op.h"
3839 #include "hv.h"
3840 #include "cop.h"
3841 #include "av.h"
3842 #include "mg.h"
3843 #include "scope.h"
3844 #include "warnings.h"
3845 #include "utf8.h"
3846
3847 /* these would be in doio.h if there was such a file */
3848 #define my_stat()  my_stat_flags(SV_GMAGIC)
3849 #define my_lstat() my_lstat_flags(SV_GMAGIC)
3850
3851 /* defined in sv.c, but also used in [ach]v.c */
3852 #undef _XPV_HEAD
3853 #undef _XPVMG_HEAD
3854 #undef _XPVCV_COMMON
3855
3856 #include "parser.h"
3857
3858 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
3859
3860 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3861
3862 /* These have to be predeclared, as they are used in proto.h which is #included
3863  * before their definitions in regcomp.h. */
3864
3865 struct scan_data_t;
3866 typedef struct regnode_charclass regnode_charclass;
3867
3868 /* A hopefully less confusing name.  The sub-classes are all Posix classes only
3869  * used under /l matching */
3870 typedef struct regnode_charclass_posixl regnode_charclass_class;
3871 typedef struct regnode_charclass_posixl regnode_charclass_posixl;
3872
3873 typedef struct regnode_ssc regnode_ssc;
3874 typedef struct RExC_state_t RExC_state_t;
3875 struct _reg_trie_data;
3876
3877 #endif
3878
3879 struct ptr_tbl_ent {
3880     struct ptr_tbl_ent*         next;
3881     const void*                 oldval;
3882     void*                       newval;
3883 };
3884
3885 struct ptr_tbl {
3886     struct ptr_tbl_ent**        tbl_ary;
3887     UV                          tbl_max;
3888     UV                          tbl_items;
3889     struct ptr_tbl_arena        *tbl_arena;
3890     struct ptr_tbl_ent          *tbl_arena_next;
3891     struct ptr_tbl_ent          *tbl_arena_end;
3892 };
3893
3894 #if defined(htonl) && !defined(HAS_HTONL)
3895 #define HAS_HTONL
3896 #endif
3897 #if defined(htons) && !defined(HAS_HTONS)
3898 #define HAS_HTONS
3899 #endif
3900 #if defined(ntohl) && !defined(HAS_NTOHL)
3901 #define HAS_NTOHL
3902 #endif
3903 #if defined(ntohs) && !defined(HAS_NTOHS)
3904 #define HAS_NTOHS
3905 #endif
3906 #ifndef HAS_HTONL
3907 #define HAS_HTONS
3908 #define HAS_HTONL
3909 #define HAS_NTOHS
3910 #define HAS_NTOHL
3911 #  if (BYTEORDER & 0xffff) == 0x4321
3912 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
3913    re-order their values. However, to behave identically to the alternative
3914    implementations, they should truncate to the correct size.  */
3915 #    define ntohl(x)    ((x)&0xFFFFFFFF)
3916 #    define htonl(x)    ntohl(x)
3917 #    define ntohs(x)    ((x)&0xFFFF)
3918 #    define htons(x)    ntohs(x)
3919 #  elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3920
3921 /* Note that we can't straight out declare our own htonl and htons because
3922    the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
3923    to avoid the overhead of initialising the socket subsystem, but the headers
3924    that *declare* the various functions are still seen. If we declare our own
3925    htonl etc they will clash with the declarations in the Win32 headers.  */
3926
3927 PERL_STATIC_INLINE U32
3928 my_swap32(const U32 x) {
3929     return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)
3930         | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
3931 }
3932
3933 PERL_STATIC_INLINE U16
3934 my_swap16(const U16 x) {
3935     return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
3936 }
3937
3938 #    define htonl(x)    my_swap32(x)
3939 #    define ntohl(x)    my_swap32(x)
3940 #    define ntohs(x)    my_swap16(x)
3941 #    define htons(x)    my_swap16(x)
3942 #  else
3943 #    error "Unsupported byteorder"
3944 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
3945    the error message. Please check the value of the macro BYTEORDER, as defined
3946    in config.h. The values of BYTEORDER we expect are
3947
3948             big endian  little endian
3949    32 bit       0x4321  0x1234
3950    64 bit   0x87654321  0x12345678
3951
3952    If you have a system with a different byte order, please see
3953    pod/perlhack.pod for how to submit a patch to add supporting code.
3954 */
3955 #  endif
3956 #endif
3957
3958 /*
3959  * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
3960  * -DWS
3961  */
3962 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3963 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
3964    re-order their values. However, to behave identically to the alternative
3965    implementations, they should truncate to the correct size.  */
3966 #  define vtohl(x)      ((x)&0xFFFFFFFF)
3967 #  define vtohs(x)      ((x)&0xFFFF)
3968 #  define htovl(x)      vtohl(x)
3969 #  define htovs(x)      vtohs(x)
3970 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
3971 #  define vtohl(x)      ((((x)&0xFF)<<24)       \
3972                         +(((x)>>24)&0xFF)       \
3973                         +(((x)&0x0000FF00)<<8)  \
3974                         +(((x)&0x00FF0000)>>8)  )
3975 #  define vtohs(x)      ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
3976 #  define htovl(x)      vtohl(x)
3977 #  define htovs(x)      vtohs(x)
3978 #else
3979 #  error "Unsupported byteorder"
3980 /* If you have need for current perl on PDP-11 or similar, and can help test
3981    that blead keeps working on a mixed-endian system, then see
3982    pod/perlhack.pod for how to submit patches to things working again.  */
3983 #endif
3984
3985 /* *MAX Plus 1. A floating point value.
3986    Hopefully expressed in a way that dodgy floating point can't mess up.
3987    >> 2 rather than 1, so that value is safely less than I32_MAX after 1
3988    is added to it
3989    May find that some broken compiler will want the value cast to I32.
3990    [after the shift, as signed >> may not be as secure as unsigned >>]
3991 */
3992 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
3993 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
3994 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
3995    0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
3996    may be greater than sizeof(IV), so don't assume that half max UV is max IV.
3997 */
3998 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
3999
4000 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
4001 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
4002 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
4003
4004 /* This may look like unnecessary jumping through hoops, but converting
4005    out of range floating point values to integers *is* undefined behaviour,
4006    and it is starting to bite.
4007 */
4008 #ifndef CAST_INLINE
4009 #define I_32(what) (cast_i32((NV)(what)))
4010 #define U_32(what) (cast_ulong((NV)(what)))
4011 #define I_V(what) (cast_iv((NV)(what)))
4012 #define U_V(what) (cast_uv((NV)(what)))
4013 #else
4014 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
4015                   : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
4016                      : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
4017 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
4018                   : ((n) < U32_MAX_P1 ? (U32) (n) \
4019                      : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
4020 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
4021                   : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
4022                      : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
4023 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
4024                   : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
4025                      : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
4026 #endif
4027
4028 #define U_S(what) ((U16)U_32(what))
4029 #define U_I(what) ((unsigned int)U_32(what))
4030 #define U_L(what) U_32(what)
4031
4032 #ifdef HAS_SIGNBIT
4033 #  ifndef Perl_signbit
4034 #    define Perl_signbit signbit
4035 #  endif
4036 #endif
4037
4038 /* These do not care about the fractional part, only about the range. */
4039 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
4040 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
4041
4042 /* Used with UV/IV arguments: */
4043                                         /* XXXX: need to speed it up */
4044 #define CLUMP_2UV(iv)   ((iv) < 0 ? 0 : (UV)(iv))
4045 #define CLUMP_2IV(uv)   ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
4046
4047 #ifndef MAXSYSFD
4048 #   define MAXSYSFD 2
4049 #endif
4050
4051 #ifndef __cplusplus
4052 #if !defined(WIN32)
4053 Uid_t getuid (void);
4054 Uid_t geteuid (void);
4055 Gid_t getgid (void);
4056 Gid_t getegid (void);
4057 #endif
4058 #endif
4059
4060 #ifndef Perl_debug_log
4061 #  define Perl_debug_log        PerlIO_stderr()
4062 #endif
4063
4064 #ifndef Perl_error_log
4065 #  define Perl_error_log        (PL_stderrgv                    \
4066                                  && isGV(PL_stderrgv)           \
4067                                  && GvIOp(PL_stderrgv)          \
4068                                  && IoOFP(GvIOp(PL_stderrgv))   \
4069                                  ? IoOFP(GvIOp(PL_stderrgv))    \
4070                                  : PerlIO_stderr())
4071 #endif
4072
4073
4074 #define DEBUG_p_FLAG            0x00000001 /*      1 */
4075 #define DEBUG_s_FLAG            0x00000002 /*      2 */
4076 #define DEBUG_l_FLAG            0x00000004 /*      4 */
4077 #define DEBUG_t_FLAG            0x00000008 /*      8 */
4078 #define DEBUG_o_FLAG            0x00000010 /*     16 */
4079 #define DEBUG_c_FLAG            0x00000020 /*     32 */
4080 #define DEBUG_P_FLAG            0x00000040 /*     64 */
4081 #define DEBUG_m_FLAG            0x00000080 /*    128 */
4082 #define DEBUG_f_FLAG            0x00000100 /*    256 */
4083 #define DEBUG_r_FLAG            0x00000200 /*    512 */
4084 #define DEBUG_x_FLAG            0x00000400 /*   1024 */
4085 #define DEBUG_u_FLAG            0x00000800 /*   2048 */
4086 /* U is reserved for Unofficial, exploratory hacking */
4087 #define DEBUG_U_FLAG            0x00001000 /*   4096 */
4088 /* spare                                        8192 */
4089 #define DEBUG_X_FLAG            0x00004000 /*  16384 */
4090 #define DEBUG_D_FLAG            0x00008000 /*  32768 */
4091 #define DEBUG_S_FLAG            0x00010000 /*  65536 */
4092 #define DEBUG_T_FLAG            0x00020000 /* 131072 */
4093 #define DEBUG_R_FLAG            0x00040000 /* 262144 */
4094 #define DEBUG_J_FLAG            0x00080000 /* 524288 */
4095 #define DEBUG_v_FLAG            0x00100000 /*1048576 */
4096 #define DEBUG_C_FLAG            0x00200000 /*2097152 */
4097 #define DEBUG_A_FLAG            0x00400000 /*4194304 */
4098 #define DEBUG_q_FLAG            0x00800000 /*8388608 */
4099 #define DEBUG_M_FLAG            0x01000000 /*16777216*/
4100 #define DEBUG_B_FLAG            0x02000000 /*33554432*/
4101 #define DEBUG_L_FLAG            0x04000000 /*67108864*/
4102 #define DEBUG_i_FLAG            0x08000000 /*134217728*/
4103 #define DEBUG_y_FLAG            0x10000000 /*268435456*/
4104 #define DEBUG_MASK              0x1FFFEFFF /* mask of all the standard flags */
4105
4106 #define DEBUG_DB_RECURSE_FLAG   0x40000000
4107 #define DEBUG_TOP_FLAG          0x80000000 /* -D was given --> PL_debug |= FLAG */
4108
4109 #  define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
4110 #  define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
4111 #  define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
4112 #  define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
4113 #  define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
4114 #  define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
4115 #  define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
4116 #  define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
4117 #  define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
4118 #  define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
4119 #  define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
4120 #  define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
4121 #  define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
4122 #  define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
4123 #  define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
4124 #  define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
4125 #  define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
4126 #  define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
4127 #  define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
4128 #  define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
4129 #  define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
4130 #  define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
4131 #  define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
4132 #  define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
4133 #  define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
4134 #  define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
4135 #  define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
4136 #  define DEBUG_y_TEST_ UNLIKELY(PL_debug & DEBUG_y_FLAG)
4137 #  define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
4138 #  define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
4139 #  define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
4140 #  define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
4141 #  define DEBUG_yv_TEST_ (DEBUG_y_TEST_ && DEBUG_v_TEST_)
4142
4143 #ifdef DEBUGGING
4144
4145 #  define DEBUG_p_TEST DEBUG_p_TEST_
4146 #  define DEBUG_s_TEST DEBUG_s_TEST_
4147 #  define DEBUG_l_TEST DEBUG_l_TEST_
4148 #  define DEBUG_t_TEST DEBUG_t_TEST_
4149 #  define DEBUG_o_TEST DEBUG_o_TEST_
4150 #  define DEBUG_c_TEST DEBUG_c_TEST_
4151 #  define DEBUG_P_TEST DEBUG_P_TEST_
4152 #  define DEBUG_m_TEST DEBUG_m_TEST_
4153 #  define DEBUG_f_TEST DEBUG_f_TEST_
4154 #  define DEBUG_r_TEST DEBUG_r_TEST_
4155 #  define DEBUG_x_TEST DEBUG_x_TEST_
4156 #  define DEBUG_u_TEST DEBUG_u_TEST_
4157 #  define DEBUG_U_TEST DEBUG_U_TEST_
4158 #  define DEBUG_X_TEST DEBUG_X_TEST_
4159 #  define DEBUG_D_TEST DEBUG_D_TEST_
4160 #  define DEBUG_S_TEST DEBUG_S_TEST_
4161 #  define DEBUG_T_TEST DEBUG_T_TEST_
4162 #  define DEBUG_R_TEST DEBUG_R_TEST_
4163 #  define DEBUG_J_TEST DEBUG_J_TEST_
4164 #  define DEBUG_v_TEST DEBUG_v_TEST_
4165 #  define DEBUG_C_TEST DEBUG_C_TEST_
4166 #  define DEBUG_A_TEST DEBUG_A_TEST_
4167 #  define DEBUG_q_TEST DEBUG_q_TEST_
4168 #  define DEBUG_M_TEST DEBUG_M_TEST_
4169 #  define DEBUG_B_TEST DEBUG_B_TEST_
4170 #  define DEBUG_L_TEST DEBUG_L_TEST_
4171 #  define DEBUG_i_TEST DEBUG_i_TEST_
4172 #  define DEBUG_y_TEST DEBUG_y_TEST_
4173 #  define DEBUG_Xv_TEST DEBUG_Xv_TEST_
4174 #  define DEBUG_Uv_TEST DEBUG_Uv_TEST_
4175 #  define DEBUG_Pv_TEST DEBUG_Pv_TEST_
4176 #  define DEBUG_Lv_TEST DEBUG_Lv_TEST_
4177 #  define DEBUG_yv_TEST DEBUG_yv_TEST_
4178
4179 #  define PERL_DEB(a)                  a
4180 #  define PERL_DEB2(a,b)               a
4181 #  define PERL_DEBUG(a) if (PL_debug)  a
4182 #  define DEBUG_p(a) if (DEBUG_p_TEST) a
4183 #  define DEBUG_s(a) if (DEBUG_s_TEST) a
4184 #  define DEBUG_l(a) if (DEBUG_l_TEST) a
4185 #  define DEBUG_t(a) if (DEBUG_t_TEST) a
4186 #  define DEBUG_o(a) if (DEBUG_o_TEST) a
4187 #  define DEBUG_c(a) if (DEBUG_c_TEST) a
4188 #  define DEBUG_P(a) if (DEBUG_P_TEST) a
4189
4190      /* Temporarily turn off memory debugging in case the a
4191       * does memory allocation, either directly or indirectly. */
4192 #  define DEBUG_m(a)  \
4193     STMT_START {                                                        \
4194         if (PERL_GET_INTERP) {                                          \
4195                                 dTHX;                                   \
4196                                 if (DEBUG_m_TEST) {                     \
4197                                     PL_debug &= ~DEBUG_m_FLAG;          \
4198                                     a;                                  \
4199                                     PL_debug |= DEBUG_m_FLAG;           \
4200                                 }                                       \
4201                               }                                         \
4202     } STMT_END
4203
4204 #  define DEBUG__(t, a)                                                 \
4205         STMT_START {                                                    \
4206                 if (t) STMT_START {a;} STMT_END;                        \
4207         } STMT_END
4208
4209 #  define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
4210
4211 /* For re_comp.c, re_exec.c, assume -Dr has been specified */
4212 #  ifdef PERL_EXT_RE_BUILD
4213 #    define DEBUG_r(a) STMT_START {a;} STMT_END
4214 #  else
4215 #    define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
4216 #  endif /* PERL_EXT_RE_BUILD */
4217
4218 #  define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
4219 #  define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
4220 #  define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
4221 #  define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
4222 #  define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
4223 #  define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
4224 #  define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
4225 #  define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
4226 #  define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
4227 #  define DEBUG_yv(a) DEBUG__(DEBUG_yv_TEST, a)
4228
4229 #  define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
4230 #  define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
4231 #  define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
4232 #  define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
4233 #  define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
4234 #  define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
4235 #  define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
4236 #  define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
4237 #  define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
4238 #  define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
4239 #  define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
4240 #  define DEBUG_y(a) DEBUG__(DEBUG_y_TEST, a)
4241
4242 #else /* ! DEBUGGING below */
4243
4244 #  define DEBUG_p_TEST (0)
4245 #  define DEBUG_s_TEST (0)
4246 #  define DEBUG_l_TEST (0)
4247 #  define DEBUG_t_TEST (0)
4248 #  define DEBUG_o_TEST (0)
4249 #  define DEBUG_c_TEST (0)
4250 #  define DEBUG_P_TEST (0)
4251 #  define DEBUG_m_TEST (0)
4252 #  define DEBUG_f_TEST (0)
4253 #  define DEBUG_r_TEST (0)
4254 #  define DEBUG_x_TEST (0)
4255 #  define DEBUG_u_TEST (0)
4256 #  define DEBUG_U_TEST (0)
4257 #  define DEBUG_X_TEST (0)
4258 #  define DEBUG_D_TEST (0)
4259 #  define DEBUG_S_TEST (0)
4260 #  define DEBUG_T_TEST (0)
4261 #  define DEBUG_R_TEST (0)
4262 #  define DEBUG_J_TEST (0)
4263 #  define DEBUG_v_TEST (0)
4264 #  define DEBUG_C_TEST (0)
4265 #  define DEBUG_A_TEST (0)
4266 #  define DEBUG_q_TEST (0)
4267 #  define DEBUG_M_TEST (0)
4268 #  define DEBUG_B_TEST (0)
4269 #  define DEBUG_L_TEST (0)
4270 #  define DEBUG_i_TEST (0)
4271 #  define DEBUG_y_TEST (0)
4272 #  define DEBUG_Xv_TEST (0)
4273 #  define DEBUG_Uv_TEST (0)
4274 #  define DEBUG_Pv_TEST (0)
4275 #  define DEBUG_Lv_TEST (0)
4276 #  define DEBUG_yv_TEST (0)
4277
4278 #  define PERL_DEB(a)
4279 #  define PERL_DEB2(a,b)               b
4280 #  define PERL_DEBUG(a)
4281 #  define DEBUG_p(a)
4282 #  define DEBUG_s(a)
4283 #  define DEBUG_l(a)
4284 #  define DEBUG_t(a)
4285 #  define DEBUG_o(a)
4286 #  define DEBUG_c(a)
4287 #  define DEBUG_P(a)
4288 #  define DEBUG_m(a)
4289 #  define DEBUG_f(a)
4290 #  define DEBUG_r(a)
4291 #  define DEBUG_x(a)
4292 #  define DEBUG_u(a)
4293 #  define DEBUG_U(a)
4294 #  define DEBUG_X(a)
4295 #  define DEBUG_D(a)
4296 #  define DEBUG_S(a)
4297 #  define DEBUG_T(a)
4298 #  define DEBUG_R(a)
4299 #  define DEBUG_v(a)
4300 #  define DEBUG_C(a)
4301 #  define DEBUG_A(a)
4302 #  define DEBUG_q(a)
4303 #  define DEBUG_M(a)
4304 #  define DEBUG_B(a)
4305 #  define DEBUG_L(a)
4306 #  define DEBUG_i(a)
4307 #  define DEBUG_y(a)
4308 #  define DEBUG_Xv(a)
4309 #  define DEBUG_Uv(a)
4310 #  define DEBUG_Pv(a)
4311 #  define DEBUG_Lv(a)
4312 #  define DEBUG_yv(a)
4313 #endif /* DEBUGGING */
4314
4315
4316 #define DEBUG_SCOPE(where) \
4317     DEBUG_l( \
4318     Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n",   \
4319                     where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
4320                     __FILE__, __LINE__));
4321
4322 /* Keep the old croak based assert for those who want it, and as a fallback if
4323    the platform is so heretically non-ANSI that it can't assert.  */
4324
4325 #define Perl_assert(what)       PERL_DEB2(                              \
4326         ((what) ? ((void) 0) :                                          \
4327             (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
4328                         "\", line %d", STRINGIFY(what), __LINE__),      \
4329              (void) 0)), ((void)0))
4330
4331 /* assert() gets defined if DEBUGGING.
4332  * If no DEBUGGING, the <assert.h> has not been included. */
4333 #ifndef assert
4334 #  define assert(what)  Perl_assert(what)
4335 #endif
4336 #ifdef DEBUGGING
4337 #  define assert_(what) assert(what),
4338 #else
4339 #  define assert_(what)
4340 #endif
4341
4342 struct ufuncs {
4343     I32 (*uf_val)(pTHX_ IV, SV*);
4344     I32 (*uf_set)(pTHX_ IV, SV*);
4345     IV uf_index;
4346 };
4347
4348 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4349  * XS code wanting to be backward compatible can do something
4350  * like the following:
4351
4352 #ifndef PERL_MG_UFUNC
4353 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4354 #endif
4355
4356 static PERL_MG_UFUNC(foo_get, index, val)
4357 {
4358     sv_setsv(val, ...);
4359     return TRUE;
4360 }
4361
4362 -- Doug MacEachern
4363
4364 */
4365
4366 #ifndef PERL_MG_UFUNC
4367 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4368 #endif
4369
4370 #include <math.h>
4371 #ifdef __VMS
4372      /* isfinite and others are here rather than in math.h as C99 stipulates */
4373 #    include <fp.h>
4374 #endif
4375
4376 #ifndef __cplusplus
4377 #  if !defined(WIN32) && !defined(VMS)
4378 #ifndef crypt
4379 char *crypt (const char*, const char*);
4380 #endif
4381 #  endif /* !WIN32 */
4382 #  ifndef WIN32
4383 #    ifndef getlogin
4384 char *getlogin (void);
4385 #    endif
4386 #  endif /* !WIN32 */
4387 #endif /* !__cplusplus */
4388
4389 /* Fixme on VMS.  This needs to be a run-time, not build time options */
4390 /* Also rename() is affected by this */
4391 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4392 #define UNLINK unlnk
4393 I32 unlnk (pTHX_ const char*);
4394 #else
4395 #define UNLINK PerlLIO_unlink
4396 #endif
4397
4398 /* some versions of glibc are missing the setresuid() proto */
4399 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4400 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4401 #endif
4402 /* some versions of glibc are missing the setresgid() proto */
4403 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4404 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4405 #endif
4406
4407 #ifndef HAS_SETREUID
4408 #  ifdef HAS_SETRESUID
4409 #    define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4410 #    define HAS_SETREUID
4411 #  endif
4412 #endif
4413 #ifndef HAS_SETREGID
4414 #  ifdef HAS_SETRESGID
4415 #    define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4416 #    define HAS_SETREGID
4417 #  endif
4418 #endif
4419
4420 /* Sighandler_t defined in iperlsys.h */
4421
4422 #ifdef HAS_SIGACTION
4423 typedef struct sigaction Sigsave_t;
4424 #else
4425 typedef Sighandler_t Sigsave_t;
4426 #endif
4427
4428 #define SCAN_DEF 0
4429 #define SCAN_TR 1
4430 #define SCAN_REPL 2
4431
4432 #ifdef DEBUGGING
4433 # ifndef register
4434 #  define register
4435 # endif
4436 # define RUNOPS_DEFAULT Perl_runops_debug
4437 #else
4438 # define RUNOPS_DEFAULT Perl_runops_standard
4439 #endif
4440
4441 #if defined(USE_PERLIO)
4442 EXTERN_C void PerlIO_teardown(void);
4443 # ifdef USE_ITHREADS
4444 #  define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4445 #  define PERLIO_TERM                           \
4446         STMT_START {                            \
4447                 PerlIO_teardown();              \
4448                 MUTEX_DESTROY(&PL_perlio_mutex);\
4449         } STMT_END
4450 # else
4451 #  define PERLIO_INIT
4452 #  define PERLIO_TERM   PerlIO_teardown()
4453 # endif
4454 #else
4455 #  define PERLIO_INIT
4456 #  define PERLIO_TERM
4457 #endif
4458
4459 #ifdef MYMALLOC
4460 #  ifdef MUTEX_INIT_CALLS_MALLOC
4461 #    define MALLOC_INIT                                 \
4462         STMT_START {                                    \
4463                 PL_malloc_mutex = NULL;                 \
4464                 MUTEX_INIT(&PL_malloc_mutex);           \
4465         } STMT_END
4466 #    define MALLOC_TERM                                 \
4467         STMT_START {                                    \
4468                 perl_mutex tmp = PL_malloc_mutex;       \
4469                 PL_malloc_mutex = NULL;                 \
4470                 MUTEX_DESTROY(&tmp);                    \
4471         } STMT_END
4472 #  else
4473 #    define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4474 #    define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4475 #  endif
4476 #else
4477 #  define MALLOC_INIT
4478 #  define MALLOC_TERM
4479 #endif
4480
4481 #if defined(PERL_IMPLICIT_CONTEXT)
4482
4483 struct perl_memory_debug_header;
4484 struct perl_memory_debug_header {
4485   tTHX  interpreter;
4486 #  if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4487   MEM_SIZE size;
4488 #  endif
4489   struct perl_memory_debug_header *prev;
4490   struct perl_memory_debug_header *next;
4491 #  ifdef PERL_DEBUG_READONLY_COW
4492   bool readonly;
4493 #  endif
4494 };
4495
4496 #elif defined(PERL_DEBUG_READONLY_COW)
4497
4498 struct perl_memory_debug_header;
4499 struct perl_memory_debug_header {
4500   MEM_SIZE size;
4501 };
4502
4503 #endif
4504
4505 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4506
4507 #  define PERL_MEMORY_DEBUG_HEADER_SIZE \
4508         (sizeof(struct perl_memory_debug_header) + \
4509         (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4510          %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4511
4512 #else
4513 #  define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4514 #endif
4515
4516 #ifdef PERL_TRACK_MEMPOOL
4517 # ifdef PERL_DEBUG_READONLY_COW
4518 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4519         STMT_START {                                            \
4520                 (header).interpreter = (interp);                \
4521                 (header).prev = (header).next = &(header);      \
4522                 (header).readonly = 0;                          \
4523         } STMT_END
4524 # else
4525 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4526         STMT_START {                                            \
4527                 (header).interpreter = (interp);                \
4528                 (header).prev = (header).next = &(header);      \
4529         } STMT_END
4530 # endif
4531 # else
4532 #  define INIT_TRACK_MEMPOOL(header, interp)
4533 #endif
4534
4535 #ifdef I_MALLOCMALLOC
4536 /* Needed for malloc_size(), malloc_good_size() on some systems */
4537 #  include <malloc/malloc.h>
4538 #endif
4539
4540 #ifdef MYMALLOC
4541 #  define Perl_safesysmalloc_size(where)        Perl_malloced_size(where)
4542 #else
4543 #  if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4544 #    ifdef PERL_TRACK_MEMPOOL
4545 #       define Perl_safesysmalloc_size(where)                   \
4546             (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4547 #    else
4548 #       define Perl_safesysmalloc_size(where) malloc_size(where)
4549 #    endif
4550 #  endif
4551 #  ifdef HAS_MALLOC_GOOD_SIZE
4552 #    ifdef PERL_TRACK_MEMPOOL
4553 #       define Perl_malloc_good_size(how_much)                  \
4554             (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4555 #    else
4556 #       define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4557 #    endif
4558 #  else
4559 /* Having this as the identity operation makes some code simpler.  */
4560 #       define Perl_malloc_good_size(how_much)  (how_much)
4561 #  endif
4562 #endif
4563
4564 typedef int (*runops_proc_t)(pTHX);
4565 typedef void (*share_proc_t) (pTHX_ SV *sv);
4566 typedef int  (*thrhook_proc_t) (pTHX);
4567 typedef OP* (*PPADDR_t[]) (pTHX);
4568 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4569 typedef void (*despatch_signals_proc_t) (pTHX);
4570
4571 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4572 #  include <crt_externs.h>      /* for the env array */
4573 #  define environ (*_NSGetEnviron())
4574 #elif defined(USE_ENVIRON_ARRAY) && !defined(environ)
4575    /* VMS and some other platforms don't use the environ array */
4576 EXTERN_C char **environ;  /* environment variables supplied via exec */
4577 #endif
4578
4579 #define PERL_PATCHLEVEL_H_IMPLICIT
4580 #include "patchlevel.h"
4581 #undef PERL_PATCHLEVEL_H_IMPLICIT
4582
4583 #define PERL_VERSION_STRING     STRINGIFY(PERL_REVISION) "." \
4584                                 STRINGIFY(PERL_VERSION) "." \
4585                                 STRINGIFY(PERL_SUBVERSION)
4586
4587 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4588                                 STRINGIFY(PERL_API_VERSION) "." \
4589                                 STRINGIFY(PERL_API_SUBVERSION)
4590
4591 START_EXTERN_C
4592
4593 /* handy constants */
4594 EXTCONST char PL_warn_uninit[]
4595   INIT("Use of uninitialized value%s%s%s");
4596 EXTCONST char PL_warn_uninit_sv[]
4597   INIT("Use of uninitialized value%" SVf "%s%s");
4598 EXTCONST char PL_warn_nosemi[]
4599   INIT("Semicolon seems to be missing");
4600 EXTCONST char PL_warn_reserved[]
4601   INIT("Unquoted string \"%s\" may clash with future reserved word");
4602 EXTCONST char PL_warn_nl[]
4603   INIT("Unsuccessful %s on filename containing newline");
4604 EXTCONST char PL_no_wrongref[]
4605   INIT("Can't use %s ref as %s ref");
4606 /* The core no longer needs this here. If you require the string constant,
4607    please inline a copy into your own code.  */
4608 EXTCONST char PL_no_symref[] __attribute__deprecated__
4609   INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4610 EXTCONST char PL_no_symref_sv[]
4611   INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4612
4613 EXTCONST char PL_no_usym[]
4614   INIT("Can't use an undefined value as %s reference");
4615 EXTCONST char PL_no_aelem[]
4616   INIT("Modification of non-creatable array value attempted, subscript %d");
4617 EXTCONST char PL_no_helem_sv[]
4618   INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4619 EXTCONST char PL_no_modify[]
4620   INIT("Modification of a read-only value attempted");
4621 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4622   INIT("Out of memory!\n");
4623 EXTCONST char PL_no_security[]
4624   INIT("Insecure dependency in %s%s");
4625 EXTCONST char PL_no_sock_func[]
4626   INIT("Unsupported socket function \"%s\" called");
4627 EXTCONST char PL_no_dir_func[]
4628   INIT("Unsupported directory function \"%s\" called");
4629 EXTCONST char PL_no_func[]
4630   INIT("The %s function is unimplemented");
4631 EXTCONST char PL_no_myglob[]
4632   INIT("\"%s\" %s %s can't be in a package");
4633 EXTCONST char PL_no_localize_ref[]
4634   INIT("Can't localize through a reference");
4635 EXTCONST char PL_memory_wrap[]
4636   INIT("panic: memory wrap");
4637 EXTCONST char PL_extended_cp_format[]
4638   INIT("Code point 0x%" UVXf " is not Unicode, requires a Perl extension,"
4639                              " and so is not portable");
4640 EXTCONST char PL_Yes[]
4641   INIT("1");
4642 EXTCONST char PL_No[]
4643   INIT("");
4644 EXTCONST char PL_Zero[]
4645   INIT("0");
4646 EXTCONST char PL_hexdigit[]
4647   INIT("0123456789abcdef0123456789ABCDEF");
4648
4649 EXTCONST STRLEN PL_WARN_ALL
4650   INIT(0);
4651 EXTCONST STRLEN PL_WARN_NONE
4652   INIT(0);
4653
4654 /* This is constant on most architectures, a global on OS/2 */
4655 #ifndef OS2
4656 EXTCONST char PL_sh_path[]
4657   INIT(SH_PATH); /* full path of shell */
4658 #endif
4659
4660 #ifdef CSH
4661 EXTCONST char PL_cshname[]
4662   INIT(CSH);
4663 #  define PL_cshlen     (sizeof(CSH "") - 1)
4664 #endif
4665
4666 /* These are baked at compile time into any shared perl library.
4667    In future releases this will allow us in main() to sanity test the
4668    library we're linking against.  */
4669
4670 EXTCONST U8 PL_revision
4671   INIT(PERL_REVISION);
4672 EXTCONST U8 PL_version
4673   INIT(PERL_VERSION);
4674 EXTCONST U8 PL_subversion
4675   INIT(PERL_SUBVERSION);
4676
4677 EXTCONST char PL_uuemap[65]
4678   INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4679
4680 /* a special string address whose value is "isa", but which perl knows
4681  * to treat as if it were really "DOES" when printing the method name in
4682  *  the "Can't call method '%s'" error message */
4683 EXTCONST char PL_isa_DOES[]
4684   INIT("isa");
4685
4686 #ifdef DOINIT
4687 EXTCONST char PL_uudmap[256] =
4688 #  ifdef PERL_MICRO
4689 #    include "uuudmap.h"
4690 #  else
4691 #    include "uudmap.h"
4692 #  endif
4693 ;
4694 EXTCONST char PL_bitcount[256] =
4695 #  ifdef PERL_MICRO
4696 #    include "ubitcount.h"
4697 #else
4698 #    include "bitcount.h"
4699 #  endif
4700 ;
4701 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4702 EXTCONST int         PL_sig_num[]  = { SIG_NUM };
4703 #else
4704 EXTCONST char PL_uudmap[256];
4705 EXTCONST char PL_bitcount[256];
4706 EXTCONST char* const PL_sig_name[];
4707 EXTCONST int         PL_sig_num[];
4708 #endif
4709
4710 /* fast conversion and case folding tables.  The folding tables complement the
4711  * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4712  * folds such as outside the range or to multiple characters. */
4713
4714 #ifdef DOINIT
4715 #  ifndef EBCDIC
4716
4717 /* The EBCDIC fold table depends on the code page, and hence is found in
4718  * ebcdic_tables.h */
4719
4720 EXTCONST  unsigned char PL_fold[] = {
4721         0,      1,      2,      3,      4,      5,      6,      7,
4722         8,      9,      10,     11,     12,     13,     14,     15,
4723         16,     17,     18,     19,     20,     21,     22,     23,
4724         24,     25,     26,     27,     28,     29,     30,     31,
4725         32,     33,     34,     35,     36,     37,     38,     39,
4726         40,     41,     42,     43,     44,     45,     46,     47,
4727         48,     49,     50,     51,     52,     53,     54,     55,
4728         56,     57,     58,     59,     60,     61,     62,     63,
4729         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4730         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4731         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4732         'x',    'y',    'z',    91,     92,     93,     94,     95,
4733         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4734         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4735         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4736         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4737         128,    129,    130,    131,    132,    133,    134,    135,
4738         136,    137,    138,    139,    140,    141,    142,    143,
4739         144,    145,    146,    147,    148,    149,    150,    151,
4740         152,    153,    154,    155,    156,    157,    158,    159,
4741         160,    161,    162,    163,    164,    165,    166,    167,
4742         168,    169,    170,    171,    172,    173,    174,    175,
4743         176,    177,    178,    179,    180,    181,    182,    183,
4744         184,    185,    186,    187,    188,    189,    190,    191,
4745         192,    193,    194,    195,    196,    197,    198,    199,
4746         200,    201,    202,    203,    204,    205,    206,    207,
4747         208,    209,    210,    211,    212,    213,    214,    215,
4748         216,    217,    218,    219,    220,    221,    222,    223,
4749         224,    225,    226,    227,    228,    229,    230,    231,
4750         232,    233,    234,    235,    236,    237,    238,    239,
4751         240,    241,    242,    243,    244,    245,    246,    247,
4752         248,    249,    250,    251,    252,    253,    254,    255
4753 };
4754
4755 EXT unsigned char PL_fold_locale[] = { /* Unfortunately not EXTCONST. */
4756         0,      1,      2,      3,      4,      5,      6,      7,
4757         8,      9,      10,     11,     12,     13,     14,     15,
4758         16,     17,     18,     19,     20,     21,     22,     23,
4759         24,     25,     26,     27,     28,     29,     30,     31,
4760         32,     33,     34,     35,     36,     37,     38,     39,
4761         40,     41,     42,     43,     44,     45,     46,     47,
4762         48,     49,     50,     51,     52,     53,     54,     55,
4763         56,     57,     58,     59,     60,     61,     62,     63,
4764         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4765         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4766         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4767         'x',    'y',    'z',    91,     92,     93,     94,     95,
4768         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4769         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4770         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4771         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4772         128,    129,    130,    131,    132,    133,    134,    135,
4773         136,    137,    138,    139,    140,    141,    142,    143,
4774         144,    145,    146,    147,    148,    149,    150,    151,
4775         152,    153,    154,    155,    156,    157,    158,    159,
4776         160,    161,    162,    163,    164,    165,    166,    167,
4777         168,    169,    170,    171,    172,    173,    174,    175,
4778         176,    177,    178,    179,    180,    181,    182,    183,
4779         184,    185,    186,    187,    188,    189,    190,    191,
4780         192,    193,    194,    195,    196,    197,    198,    199,
4781         200,    201,    202,    203,    204,    205,    206,    207,
4782         208,    209,    210,    211,    212,    213,    214,    215,
4783         216,    217,    218,    219,    220,    221,    222,    223,
4784         224,    225,    226,    227,    228,    229,    230,    231,
4785         232,    233,    234,    235,    236,    237,    238,    239,
4786         240,    241,    242,    243,    244,    245,    246,    247,
4787         248,    249,    250,    251,    252,    253,    254,    255
4788 };
4789
4790 EXTCONST  unsigned char PL_fold_latin1[] = {
4791     /* Full latin1 complement folding, except for three problematic code points:
4792      *  Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4793      *  fold complements outside the Latin1 range, so can't match something
4794      *  that isn't in utf8.
4795      *  German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4796      *  not one, so can't be represented in this table.
4797      *
4798      * All have to be specially handled */
4799         0,      1,      2,      3,      4,      5,      6,      7,
4800         8,      9,      10,     11,     12,     13,     14,     15,
4801         16,     17,     18,     19,     20,     21,     22,     23,
4802         24,     25,     26,     27,     28,     29,     30,     31,
4803         32,     33,     34,     35,     36,     37,     38,     39,
4804         40,     41,     42,     43,     44,     45,     46,     47,
4805         48,     49,     50,     51,     52,     53,     54,     55,
4806         56,     57,     58,     59,     60,     61,     62,     63,
4807         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4808         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4809         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4810         'x',    'y',    'z',    91,     92,     93,     94,     95,
4811         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4812         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4813         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4814         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4815         128,    129,    130,    131,    132,    133,    134,    135,
4816         136,    137,    138,    139,    140,    141,    142,    143,
4817         144,    145,    146,    147,    148,    149,    150,    151,
4818         152,    153,    154,    155,    156,    157,    158,    159,
4819         160,    161,    162,    163,    164,    165,    166,    167,
4820         168,    169,    170,    171,    172,    173,    174,    175,
4821         176,    177,    178,    179,    180,    181 /*micro */, 182,    183,
4822         184,    185,    186,    187,    188,    189,    190,    191,
4823         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4824         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4825         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4826         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
4827         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4828         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4829         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4830         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
4831         255 /* y with diaeresis */
4832 };
4833
4834 /* If these tables are accessed through ebcdic, the access will be converted to
4835  * latin1 first */
4836 EXTCONST  unsigned char PL_latin1_lc[] = {  /* lowercasing */
4837         0,      1,      2,      3,      4,      5,      6,      7,
4838         8,      9,      10,     11,     12,     13,     14,     15,
4839         16,     17,     18,     19,     20,     21,     22,     23,
4840         24,     25,     26,     27,     28,     29,     30,     31,
4841         32,     33,     34,     35,     36,     37,     38,     39,
4842         40,     41,     42,     43,     44,     45,     46,     47,
4843         48,     49,     50,     51,     52,     53,     54,     55,
4844         56,     57,     58,     59,     60,     61,     62,     63,
4845         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4846         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4847         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4848         'x',    'y',    'z',    91,     92,     93,     94,     95,
4849         96,     97,     98,     99,     100,    101,    102,    103,
4850         104,    105,    106,    107,    108,    109,    110,    111,
4851         112,    113,    114,    115,    116,    117,    118,    119,
4852         120,    121,    122,    123,    124,    125,    126,    127,
4853         128,    129,    130,    131,    132,    133,    134,    135,
4854         136,    137,    138,    139,    140,    141,    142,    143,
4855         144,    145,    146,    147,    148,    149,    150,    151,
4856         152,    153,    154,    155,    156,    157,    158,    159,
4857         160,    161,    162,    163,    164,    165,    166,    167,
4858         168,    169,    170,    171,    172,    173,    174,    175,
4859         176,    177,    178,    179,    180,    181,    182,    183,
4860         184,    185,    186,    187,    188,    189,    190,    191,
4861         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4862         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4863         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4864         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223,
4865         224,    225,    226,    227,    228,    229,    230,    231,
4866         232,    233,    234,    235,    236,    237,    238,    239,
4867         240,    241,    242,    243,    244,    245,    246,    247,
4868         248,    249,    250,    251,    252,    253,    254,    255
4869 };
4870
4871 /* upper and title case of latin1 characters, modified so that the three tricky
4872  * ones are mapped to 255 (which is one of the three) */
4873 EXTCONST  unsigned char PL_mod_latin1_uc[] = {