perl.h

   1 /*    perl.h
   2  *
   3  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
   4  *    2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10
  11 #ifndef H_PERL
  12 #define H_PERL 1
  13
  14 #ifdef PERL_FOR_X2P
  15 /*
  16  * This file is being used for x2p stuff.
  17  * Above symbol is defined via -D in 'x2p/Makefile.SH'
  18  * Decouple x2p stuff from some of perls more extreme eccentricities.
  19  */
  20 #undef MULTIPLICITY
  21 #undef USE_STDIO
  22 #define USE_STDIO
  23 #endif /* PERL_FOR_X2P */
  24
  25 #ifdef PERL_MICRO
  26 #   include "uconfig.h"
  27 #else
  28 #   include "config.h"
  29 #endif
  30
  31 /* this is used for functions which take a depth trailing
  32  * argument under debugging */
  33 #ifdef DEBUGGING
  34 #define _pDEPTH ,U32 depth
  35 #define _aDEPTH ,depth
  36 #else
  37 #define _pDEPTH
  38 #define _aDEPTH
  39 #endif
  40
  41 /* NOTE 1: that with gcc -std=c89 the __STDC_VERSION__ is *not* defined
  42  * because the __STDC_VERSION__ became a thing only with C90.  Therefore,
  43  * with gcc, HAS_C99 will never become true as long as we use -std=c89.
  44
  45  * NOTE 2: headers lie.  Do not expect that if HAS_C99 gets to be true,
  46  * all the C99 features are there and are correct. */
  47 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || \
  48     defined(_STDC_C99) || defined(__c99)
  49 #  define HAS_C99 1
  50 #endif
  51
  52 /* See L<perlguts/"The Perl API"> for detailed notes on
  53  * PERL_IMPLICIT_CONTEXT and PERL_IMPLICIT_SYS */
  54
  55 /* XXX NOTE that from here --> to <-- the same logic is
  56  * repeated in makedef.pl, so be certain to update
  57  * both places when editing. */
  58
  59 #ifdef USE_ITHREADS
  60 #  if !defined(MULTIPLICITY)
  61 #    define MULTIPLICITY
  62 #  endif
  63 #endif
  64
  65 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
  66 #  ifndef PERL_GLOBAL_STRUCT
  67 #    define PERL_GLOBAL_STRUCT
  68 #  endif
  69 #endif
  70
  71 #ifdef PERL_GLOBAL_STRUCT
  72 #  ifndef MULTIPLICITY
  73 #    define MULTIPLICITY
  74 #  endif
  75 #endif
  76
  77 #ifdef MULTIPLICITY
  78 #  ifndef PERL_IMPLICIT_CONTEXT
  79 #    define PERL_IMPLICIT_CONTEXT
  80 #  endif
  81 #endif
  82
  83 /* undef WIN32 when building on Cygwin (for libwin32) - gph */
  84 #ifdef __CYGWIN__
  85 #   undef WIN32
  86 #   undef _WIN32
  87 #endif
  88
  89 #if defined(__SYMBIAN32__) || (defined(__VC32__) && defined(WINS))
  90 #   ifndef SYMBIAN
  91 #       define SYMBIAN
  92 #   endif
  93 #endif
  94
  95 #ifdef __SYMBIAN32__
  96 #  include "symbian/symbian_proto.h"
  97 #endif
  98
  99 /* Any stack-challenged places.  The limit varies (and often
 100  * is configurable), but using more than a kilobyte of stack
 101  * is usually dubious in these systems. */
 102 #if defined(__SYMBIAN32__)
 103 /* Symbian: need to work around the SDK features. *
 104  * On WINS: MS VC5 generates calls to _chkstk,         *
 105  * if a "large" stack frame is allocated.              *
 106  * gcc on MARM does not generate calls like these.     */
 107 #   define USE_HEAP_INSTEAD_OF_STACK
 108 #endif
 109
 110 /* Use the reentrant APIs like localtime_r and getpwent_r */
 111 /* Win32 has naturally threadsafe libraries, no need to use any _r variants.
 112  * XXX KEEP makedef.pl copy of this code in sync */
 113 #if defined(USE_ITHREADS) && !defined(USE_REENTRANT_API) && !defined(NETWARE) && !defined(WIN32)
 114 #   define USE_REENTRANT_API
 115 #endif
 116
 117 /* <--- here ends the logic shared by perl.h and makedef.pl */
 118
 119 #undef START_EXTERN_C
 120 #undef END_EXTERN_C
 121 #undef EXTERN_C
 122 #ifdef __cplusplus
 123 #  define START_EXTERN_C extern "C" {
 124 #  define END_EXTERN_C }
 125 #  define EXTERN_C extern "C"
 126 #else
 127 #  define START_EXTERN_C
 128 #  define END_EXTERN_C
 129 #  define EXTERN_C extern
 130 #endif
 131
 132 /* Fallback definitions in case we don't have definitions from config.h.
 133    This should only matter for systems that don't use Configure and
 134    haven't been modified to define PERL_STATIC_INLINE yet.
 135 */
 136 #if !defined(PERL_STATIC_INLINE)
 137 #  ifdef HAS_STATIC_INLINE
 138 #    define PERL_STATIC_INLINE static inline
 139 #  else
 140 #    define PERL_STATIC_INLINE static
 141 #  endif
 142 #endif
 143
 144 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GET_VARS)
 145 #    ifdef PERL_GLOBAL_STRUCT_PRIVATE
 146        EXTERN_C struct perl_vars* Perl_GetVarsPrivate();
 147 #      define PERL_GET_VARS() Perl_GetVarsPrivate() /* see miniperlmain.c */
 148 #    else
 149 #      define PERL_GET_VARS() PL_VarsPtr
 150 #    endif
 151 #endif
 152
 153 /* this used to be off by default, now its on, see perlio.h */
 154 #define PERLIO_FUNCS_CONST
 155
 156 #define pVAR    struct perl_vars* my_vars PERL_UNUSED_DECL
 157
 158 #ifdef PERL_GLOBAL_STRUCT
 159 #  define dVAR          pVAR    = (struct perl_vars*)PERL_GET_VARS()
 160 #else
 161 #  define dVAR          dNOOP
 162 #endif
 163
 164 #ifdef PERL_IMPLICIT_CONTEXT
 165 #  ifndef MULTIPLICITY
 166 #    define MULTIPLICITY
 167 #  endif
 168 #  define tTHX  PerlInterpreter*
 169 #  define pTHX  tTHX my_perl PERL_UNUSED_DECL
 170 #  define aTHX  my_perl
 171 #  define aTHXa(a) aTHX = (tTHX)a
 172 #  ifdef PERL_GLOBAL_STRUCT
 173 #    define dTHXa(a)    dVAR; pTHX = (tTHX)a
 174 #  else
 175 #    define dTHXa(a)    pTHX = (tTHX)a
 176 #  endif
 177 #  ifdef PERL_GLOBAL_STRUCT
 178 #    define dTHX                dVAR; pTHX = PERL_GET_THX
 179 #  else
 180 #    define dTHX                pTHX = PERL_GET_THX
 181 #  endif
 182 #  define pTHX_         pTHX,
 183 #  define aTHX_         aTHX,
 184 #  define pTHX_1        2
 185 #  define pTHX_2        3
 186 #  define pTHX_3        4
 187 #  define pTHX_4        5
 188 #  define pTHX_5        6
 189 #  define pTHX_6        7
 190 #  define pTHX_7        8
 191 #  define pTHX_8        9
 192 #  define pTHX_9        10
 193 #  define pTHX_12       13
 194 #  if defined(DEBUGGING) && !defined(PERL_TRACK_MEMPOOL)
 195 #    define PERL_TRACK_MEMPOOL
 196 #  endif
 197 #else
 198 #  undef PERL_TRACK_MEMPOOL
 199 #endif
 200
 201 #ifdef DEBUGGING
 202 #  define dTHX_DEBUGGING dTHX
 203 #else
 204 #  define dTHX_DEBUGGING dNOOP
 205 #endif
 206
 207 #define STATIC static
 208
 209 #ifndef PERL_CORE
 210 /* Do not use these macros. They were part of PERL_OBJECT, which was an
 211  * implementation of multiplicity using C++ objects. They have been left
 212  * here solely for the sake of XS code which has incorrectly
 213  * cargo-culted them.
 214  */
 215 #define CPERLscope(x) x
 216 #define CPERLarg void
 217 #define CPERLarg_
 218 #define _CPERLarg
 219 #define PERL_OBJECT_THIS
 220 #define _PERL_OBJECT_THIS
 221 #define PERL_OBJECT_THIS_
 222 #define CALL_FPTR(fptr) (*fptr)
 223 #define MEMBER_TO_FPTR(name) name
 224 #endif /* !PERL_CORE */
 225
 226 #define CALLRUNOPS  PL_runops
 227
 228 #define CALLREGCOMP(sv, flags) Perl_pregcomp(aTHX_ (sv),(flags))
 229
 230 #define CALLREGCOMP_ENG(prog, sv, flags) (prog)->comp(aTHX_ sv, flags)
 231 #define CALLREGEXEC(prog,stringarg,strend,strbeg,minend,sv,data,flags) \
 232     RX_ENGINE(prog)->exec(aTHX_ (prog),(stringarg),(strend), \
 233         (strbeg),(minend),(sv),(data),(flags))
 234 #define CALLREG_INTUIT_START(prog,sv,strbeg,strpos,strend,flags,data) \
 235     RX_ENGINE(prog)->intuit(aTHX_ (prog), (sv), (strbeg), (strpos), \
 236         (strend),(flags),(data))
 237 #define CALLREG_INTUIT_STRING(prog) \
 238     RX_ENGINE(prog)->checkstr(aTHX_ (prog))
 239
 240 #define CALLREGFREE(prog) \
 241     Perl_pregfree(aTHX_ (prog))
 242
 243 #define CALLREGFREE_PVT(prog) \
 244     if(prog && RX_ENGINE(prog)) RX_ENGINE(prog)->rxfree(aTHX_ (prog))
 245
 246 #define CALLREG_NUMBUF_FETCH(rx,paren,usesv)                                \
 247     RX_ENGINE(rx)->numbered_buff_FETCH(aTHX_ (rx),(paren),(usesv))
 248
 249 #define CALLREG_NUMBUF_STORE(rx,paren,value) \
 250     RX_ENGINE(rx)->numbered_buff_STORE(aTHX_ (rx),(paren),(value))
 251
 252 #define CALLREG_NUMBUF_LENGTH(rx,sv,paren)                              \
 253     RX_ENGINE(rx)->numbered_buff_LENGTH(aTHX_ (rx),(sv),(paren))
 254
 255 #define CALLREG_NAMED_BUFF_FETCH(rx, key, flags) \
 256     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_FETCH))
 257
 258 #define CALLREG_NAMED_BUFF_STORE(rx, key, value, flags) \
 259     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), (value), ((flags) | RXapif_STORE))
 260
 261 #define CALLREG_NAMED_BUFF_DELETE(rx, key, flags) \
 262     RX_ENGINE(rx)->named_buff(aTHX_ (rx),(key), NULL, ((flags) | RXapif_DELETE))
 263
 264 #define CALLREG_NAMED_BUFF_CLEAR(rx, flags) \
 265     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_CLEAR))
 266
 267 #define CALLREG_NAMED_BUFF_EXISTS(rx, key, flags) \
 268     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_EXISTS))
 269
 270 #define CALLREG_NAMED_BUFF_FIRSTKEY(rx, flags) \
 271     RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), NULL, ((flags) | RXapif_FIRSTKEY))
 272
 273 #define CALLREG_NAMED_BUFF_NEXTKEY(rx, lastkey, flags) \
 274     RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), (lastkey), ((flags) | RXapif_NEXTKEY))
 275
 276 #define CALLREG_NAMED_BUFF_SCALAR(rx, flags) \
 277     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_SCALAR))
 278
 279 #define CALLREG_NAMED_BUFF_COUNT(rx) \
 280     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, RXapif_REGNAMES_COUNT)
 281
 282 #define CALLREG_NAMED_BUFF_ALL(rx, flags) \
 283     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, flags)
 284
 285 #define CALLREG_PACKAGE(rx) \
 286     RX_ENGINE(rx)->qr_package(aTHX_ (rx))
 287
 288 #if defined(USE_ITHREADS)
 289 #define CALLREGDUPE(prog,param) \
 290     Perl_re_dup(aTHX_ (prog),(param))
 291
 292 #define CALLREGDUPE_PVT(prog,param) \
 293     (prog ? RX_ENGINE(prog)->dupe(aTHX_ (prog),(param)) \
 294           : (REGEXP *)NULL)
 295 #endif
 296
 297 /* some compilers impersonate gcc */
 298 #if defined(__GNUC__) && !defined(__clang__) && !defined(__INTEL_COMPILER)
 299 #  define PERL_IS_GCC 1
 300 #endif
 301
 302 /* In case Configure was not used (we are using a "canned config"
 303  * such as Win32, or a cross-compilation setup, for example) try going
 304  * by the gcc major and minor versions.  One useful URL is
 305  * http://www.ohse.de/uwe/articles/gcc-attributes.html,
 306  * but contrary to this information warn_unused_result seems
 307  * not to be in gcc 3.3.5, at least. --jhi
 308  * Also, when building extensions with an installed perl, this allows
 309  * the user to upgrade gcc and get the right attributes, rather than
 310  * relying on the list generated at Configure time.  --AD
 311  * Set these up now otherwise we get confused when some of the <*thread.h>
 312  * includes below indirectly pull in <perlio.h> (which needs to know if we
 313  * have HASATTRIBUTE_FORMAT).
 314  */
 315
 316 #ifndef PERL_MICRO
 317 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
 318 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
 319 #    define HASATTRIBUTE_DEPRECATED
 320 #  endif
 321 #  if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
 322 #    define HASATTRIBUTE_FORMAT
 323 #    if defined __MINGW32__
 324 #      define PRINTF_FORMAT_NULL_OK
 325 #    endif
 326 #  endif
 327 #  if __GNUC__ >= 3 /* 3.0 -> */
 328 #    define HASATTRIBUTE_MALLOC
 329 #  endif
 330 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
 331 #    define HASATTRIBUTE_NONNULL
 332 #  endif
 333 #  if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
 334 #    define HASATTRIBUTE_NORETURN
 335 #  endif
 336 #  if __GNUC__ >= 3 /* gcc 3.0 -> */
 337 #    define HASATTRIBUTE_PURE
 338 #  endif
 339 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
 340 #    define HASATTRIBUTE_UNUSED
 341 #  endif
 342 #  if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
 343 #    define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
 344 #  endif
 345 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
 346 #    define HASATTRIBUTE_WARN_UNUSED_RESULT
 347 #  endif
 348 /* always_inline is buggy in gcc <= 4.6 and causes compilation errors */
 349 #  if __GNUC__ == 4 && __GNUC_MINOR__ >= 7 || __GNUC__ > 4 /* 4.7 -> */
 350 #    define HASATTRIBUTE_ALWAYS_INLINE
 351 #  endif
 352 #endif
 353 #endif /* #ifndef PERL_MICRO */
 354
 355 #ifdef HASATTRIBUTE_DEPRECATED
 356 #  define __attribute__deprecated__         __attribute__((deprecated))
 357 #endif
 358 #ifdef HASATTRIBUTE_FORMAT
 359 #  define __attribute__format__(x,y,z)      __attribute__((format(x,y,z)))
 360 #endif
 361 #ifdef HASATTRIBUTE_MALLOC
 362 #  define __attribute__malloc__             __attribute__((__malloc__))
 363 #endif
 364 #ifdef HASATTRIBUTE_NONNULL
 365 #  define __attribute__nonnull__(a)         __attribute__((nonnull(a)))
 366 #endif
 367 #ifdef HASATTRIBUTE_NORETURN
 368 #  define __attribute__noreturn__           __attribute__((noreturn))
 369 #endif
 370 #ifdef HASATTRIBUTE_PURE
 371 #  define __attribute__pure__               __attribute__((pure))
 372 #endif
 373 #ifdef HASATTRIBUTE_UNUSED
 374 #  define __attribute__unused__             __attribute__((unused))
 375 #endif
 376 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
 377 #  define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
 378 #endif
 379 #ifdef HASATTRIBUTE_ALWAYS_INLINE
 380 /* always_inline is buggy in gcc <= 4.6 and causes compilation errors */
 381 #  if !defined(PERL_IS_GCC) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7 || __GNUC__ > 4)
 382 #    define __attribute__always_inline__      __attribute__((always_inline))
 383 #  endif
 384 #endif
 385
 386 /* If we haven't defined the attributes yet, define them to blank. */
 387 #ifndef __attribute__deprecated__
 388 #  define __attribute__deprecated__
 389 #endif
 390 #ifndef __attribute__format__
 391 #  define __attribute__format__(x,y,z)
 392 #endif
 393 #ifndef __attribute__malloc__
 394 #  define __attribute__malloc__
 395 #endif
 396 #ifndef __attribute__nonnull__
 397 #  define __attribute__nonnull__(a)
 398 #endif
 399 #ifndef __attribute__noreturn__
 400 #  define __attribute__noreturn__
 401 #endif
 402 #ifndef __attribute__pure__
 403 #  define __attribute__pure__
 404 #endif
 405 #ifndef __attribute__unused__
 406 #  define __attribute__unused__
 407 #endif
 408 #ifndef __attribute__warn_unused_result__
 409 #  define __attribute__warn_unused_result__
 410 #endif
 411 #ifndef __attribute__always_inline__
 412 #  define __attribute__always_inline__
 413 #endif
 414
 415 /* Some OS warn on NULL format to printf */
 416 #ifdef PRINTF_FORMAT_NULL_OK
 417 #  define __attribute__format__null_ok__(x,y,z)  __attribute__format__(x,y,z)
 418 #else
 419 #  define __attribute__format__null_ok__(x,y,z)
 420 #endif
 421
 422 /*
 423  * Because of backward compatibility reasons the PERL_UNUSED_DECL
 424  * cannot be changed from postfix to PERL_UNUSED_DECL(x).  Sigh.
 425  *
 426  * Note that there are C compilers such as MetroWerks CodeWarrior
 427  * which do not have an "inlined" way (like the gcc __attribute__) of
 428  * marking unused variables (they need e.g. a #pragma) and therefore
 429  * cpp macros like PERL_UNUSED_DECL cannot work for this purpose, even
 430  * if it were PERL_UNUSED_DECL(x), which it cannot be (see above).
 431  *
 432  */
 433
 434 #ifndef PERL_UNUSED_DECL
 435 #  define PERL_UNUSED_DECL __attribute__unused__
 436 #endif
 437
 438 /* gcc -Wall:
 439  * for silencing unused variables that are actually used most of the time,
 440  * but we cannot quite get rid of, such as "ax" in PPCODE+noargs xsubs,
 441  * or variables/arguments that are used only in certain configurations.
 442  */
 443 #ifndef PERL_UNUSED_ARG
 444 #  define PERL_UNUSED_ARG(x) ((void)sizeof(x))
 445 #endif
 446 #ifndef PERL_UNUSED_VAR
 447 #  define PERL_UNUSED_VAR(x) ((void)sizeof(x))
 448 #endif
 449
 450 #if defined(USE_ITHREADS) || defined(PERL_GLOBAL_STRUCT)
 451 #  define PERL_UNUSED_CONTEXT PERL_UNUSED_ARG(my_perl)
 452 #else
 453 #  define PERL_UNUSED_CONTEXT
 454 #endif
 455
 456 /* gcc (-ansi) -pedantic doesn't allow gcc statement expressions,
 457  * g++ allows them but seems to have problems with them
 458  * (insane errors ensue).
 459  * g++ does not give insane errors now (RMB 2008-01-30, gcc 4.2.2).
 460  */
 461 #if defined(PERL_GCC_PEDANTIC) || \
 462     (defined(__GNUC__) && defined(__cplusplus) && \
 463         ((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2))))
 464 #  ifndef PERL_GCC_BRACE_GROUPS_FORBIDDEN
 465 #    define PERL_GCC_BRACE_GROUPS_FORBIDDEN
 466 #  endif
 467 #endif
 468
 469 /* Use PERL_UNUSED_RESULT() to suppress the warnings about unused results
 470  * of function calls, e.g. PERL_UNUSED_RESULT(foo(a, b)).
 471  *
 472  * The main reason for this is that the combination of gcc -Wunused-result
 473  * (part of -Wall) and the __attribute__((warn_unused_result)) cannot
 474  * be silenced with casting to void.  This causes trouble when the system
 475  * header files use the attribute.
 476  *
 477  * Use PERL_UNUSED_RESULT sparingly, though, since usually the warning
 478  * is there for a good reason: you might lose success/failure information,
 479  * or leak resources, or changes in resources.
 480  *
 481  * But sometimes you just want to ignore the return value, e.g. on
 482  * codepaths soon ending up in abort, or in "best effort" attempts,
 483  * or in situations where there is no good way to handle failures.
 484  *
 485  * Sometimes PERL_UNUSED_RESULT might not be the most natural way:
 486  * another possibility is that you can capture the return value
 487  * and use PERL_UNUSED_VAR on that.
 488  *
 489  * The __typeof__() is used instead of typeof() since typeof() is not
 490  * available under strict C89, and because of compilers masquerading
 491  * as gcc (clang and icc), we want exactly the gcc extension
 492  * __typeof__ and nothing else.
 493  */
 494 #ifndef PERL_UNUSED_RESULT
 495 #  if defined(__GNUC__) && defined(HASATTRIBUTE_WARN_UNUSED_RESULT)
 496 #    define PERL_UNUSED_RESULT(v) STMT_START { __typeof__(v) z = (v); (void)sizeof(z); } STMT_END
 497 #  else
 498 #    define PERL_UNUSED_RESULT(v) ((void)(v))
 499 #  endif
 500 #endif
 501
 502 #if defined(_MSC_VER)
 503 /* XXX older MSVC versions have a smallish macro buffer */
 504 #define PERL_SMALL_MACRO_BUFFER
 505 #endif
 506
 507 /* on gcc (and clang), specify that a warning should be temporarily
 508  * ignored; e.g.
 509  *
 510  *    GCC_DIAG_IGNORE_DECL(-Wmultichar);
 511  *    char b = 'ab';
 512  *    GCC_DIAG_RESTORE_DECL;
 513  *
 514  * based on http://dbp-consulting.com/tutorials/SuppressingGCCWarnings.html
 515  *
 516  * Note that "pragma GCC diagnostic push/pop" was added in GCC 4.6, Mar 2011;
 517  * clang only pretends to be GCC 4.2, but still supports push/pop.
 518  *
 519  * Note on usage: all macros must be used at a place where a declaration
 520  * or statement can occur, i.e., not in the middle of an expression.
 521  * *_DIAG_IGNORE() and *_DIAG_RESTORE can be used in any such place, but
 522  * must be used without a following semicolon.  *_DIAG_IGNORE_DECL() and
 523  * *_DIAG_RESTORE_DECL must be used with a following semicolon, and behave
 524  * syntactically as declarations (like dNOOP).  *_DIAG_IGNORE_STMT()
 525  * and *_DIAG_RESTORE_STMT must be used with a following semicolon,
 526  * and behave syntactically as statements (like NOOP).
 527  *
 528  */
 529
 530 #if defined(__clang__) || defined(__clang) || \
 531        (defined( __GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406)
 532 #  define GCC_DIAG_PRAGMA(x) _Pragma (#x)
 533 /* clang has "clang diagnostic" pragmas, but also understands gcc. */
 534 #  define GCC_DIAG_IGNORE(x) _Pragma("GCC diagnostic push") \
 535                              GCC_DIAG_PRAGMA(GCC diagnostic ignored #x)
 536 #  define GCC_DIAG_RESTORE   _Pragma("GCC diagnostic pop")
 537 #else
 538 #  define GCC_DIAG_IGNORE(w)
 539 #  define GCC_DIAG_RESTORE
 540 #endif
 541 #define GCC_DIAG_IGNORE_DECL(x) GCC_DIAG_IGNORE(x) dNOOP
 542 #define GCC_DIAG_RESTORE_DECL GCC_DIAG_RESTORE dNOOP
 543 #define GCC_DIAG_IGNORE_STMT(x) GCC_DIAG_IGNORE(x) NOOP
 544 #define GCC_DIAG_RESTORE_STMT GCC_DIAG_RESTORE NOOP
 545 /* for clang specific pragmas */
 546 #if defined(__clang__) || defined(__clang)
 547 #  define CLANG_DIAG_PRAGMA(x) _Pragma (#x)
 548 #  define CLANG_DIAG_IGNORE(x) _Pragma("clang diagnostic push") \
 549                                CLANG_DIAG_PRAGMA(clang diagnostic ignored #x)
 550 #  define CLANG_DIAG_RESTORE   _Pragma("clang diagnostic pop")
 551 #else
 552 #  define CLANG_DIAG_IGNORE(w)
 553 #  define CLANG_DIAG_RESTORE
 554 #endif
 555 #define CLANG_DIAG_IGNORE_DECL(x) CLANG_DIAG_IGNORE(x) dNOOP
 556 #define CLANG_DIAG_RESTORE_DECL CLANG_DIAG_RESTORE dNOOP
 557 #define CLANG_DIAG_IGNORE_STMT(x) CLANG_DIAG_IGNORE(x) NOOP
 558 #define CLANG_DIAG_RESTORE_STMT CLANG_DIAG_RESTORE NOOP
 559
 560 #if defined(_MSC_VER) && (_MSC_VER >= 1300)
 561 #  define MSVC_DIAG_IGNORE(x) __pragma(warning(push)) \
 562                               __pragma(warning(disable : x))
 563 #  define MSVC_DIAG_RESTORE   __pragma(warning(pop))
 564 #else
 565 #  define MSVC_DIAG_IGNORE(x)
 566 #  define MSVC_DIAG_RESTORE
 567 #endif
 568 #define MSVC_DIAG_IGNORE_DECL(x) MSVC_DIAG_IGNORE(x) dNOOP
 569 #define MSVC_DIAG_RESTORE_DECL MSVC_DIAG_RESTORE dNOOP
 570 #define MSVC_DIAG_IGNORE_STMT(x) MSVC_DIAG_IGNORE(x) NOOP
 571 #define MSVC_DIAG_RESTORE_STMT MSVC_DIAG_RESTORE NOOP
 572
 573 #define NOOP /*EMPTY*/(void)0
 574 #define dNOOP struct Perl___notused_struct
 575
 576 #ifndef pTHX
 577 /* Don't bother defining tTHX ; using it outside
 578  * code guarded by PERL_IMPLICIT_CONTEXT is an error.
 579  */
 580 #  define pTHX          void
 581 #  define pTHX_
 582 #  define aTHX
 583 #  define aTHX_
 584 #  define aTHXa(a)      NOOP
 585 #  define dTHXa(a)      dNOOP
 586 #  define dTHX          dNOOP
 587 #  define pTHX_1        1
 588 #  define pTHX_2        2
 589 #  define pTHX_3        3
 590 #  define pTHX_4        4
 591 #  define pTHX_5        5
 592 #  define pTHX_6        6
 593 #  define pTHX_7        7
 594 #  define pTHX_8        8
 595 #  define pTHX_9        9
 596 #  define pTHX_12       12
 597 #endif
 598
 599 #ifndef dVAR
 600 #  define dVAR          dNOOP
 601 #endif
 602
 603 /* these are only defined for compatibility; should not be used internally */
 604 #if !defined(pTHXo) && !defined(PERL_CORE)
 605 #  define pTHXo         pTHX
 606 #  define pTHXo_        pTHX_
 607 #  define aTHXo         aTHX
 608 #  define aTHXo_        aTHX_
 609 #  define dTHXo         dTHX
 610 #  define dTHXoa(x)     dTHXa(x)
 611 #endif
 612
 613 #ifndef pTHXx
 614 #  define pTHXx         PerlInterpreter *my_perl
 615 #  define pTHXx_        pTHXx,
 616 #  define aTHXx         my_perl
 617 #  define aTHXx_        aTHXx,
 618 #  define dTHXx         dTHX
 619 #endif
 620
 621 /* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
 622  * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
 623  * dTHXs is therefore needed for all functions using PerlIO_foo(). */
 624 #ifdef PERL_IMPLICIT_SYS
 625 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
 626 #    define dTHXs               dVAR; dTHX
 627 #  else
 628 #    define dTHXs               dTHX
 629 #  endif
 630 #else
 631 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
 632 #    define dTHXs               dVAR
 633 #  else
 634 #    define dTHXs               dNOOP
 635 #  endif
 636 #endif
 637
 638 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
 639 #  ifndef PERL_USE_GCC_BRACE_GROUPS
 640 #    define PERL_USE_GCC_BRACE_GROUPS
 641 #  endif
 642 #endif
 643
 644 /*
 645 =head1 Miscellaneous Functions
 646
 647 =for apidoc AmnUu|void|STMT_START
 648
 649  STMT_START { statements; } STMT_END;
 650
 651 can be used as a single statement, as in
 652
 653  if (x) STMT_START { ... } STMT_END; else ...
 654
 655 These are often used in macro definitions.  Note that you can't return a value
 656 out of them.
 657
 658 =for apidoc AmnUhu|void|STMT_END
 659
 660 =cut
 661
 662  Trying to select a version that gives no warnings...
 663 */
 664 #if !(defined(STMT_START) && defined(STMT_END))
 665 # ifdef PERL_USE_GCC_BRACE_GROUPS
 666 #   define STMT_START   (void)( /* gcc supports "({ STATEMENTS; })" */
 667 #   define STMT_END     )
 668 # else
 669 #   define STMT_START   do
 670 #   define STMT_END     while (0)
 671 # endif
 672 #endif
 673
 674 #ifndef BYTEORDER  /* Should never happen -- byteorder is in config.h */
 675 #   define BYTEORDER 0x1234
 676 #endif
 677
 678 #if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
 679 #define ASCIIish
 680 #else
 681 #undef  ASCIIish
 682 #endif
 683
 684 /*
 685  * The following contortions are brought to you on behalf of all the
 686  * standards, semi-standards, de facto standards, not-so-de-facto standards
 687  * of the world, as well as all the other botches anyone ever thought of.
 688  * The basic theory is that if we work hard enough here, the rest of the
 689  * code can be a lot prettier.  Well, so much for theory.  Sorry, Henry...
 690  */
 691
 692 /* define this once if either system, instead of cluttering up the src */
 693 #if defined(MSDOS) || defined(WIN32) || defined(NETWARE)
 694 #define DOSISH 1
 695 #endif
 696
 697 /* These exist only for back-compat with XS modules. */
 698 #ifndef PERL_CORE
 699 #define VOL volatile
 700 #define CAN_PROTOTYPE
 701 #define _(args) args
 702 #define I_LIMITS
 703 #define I_STDARG
 704 #define STANDARD_C
 705 #endif
 706
 707 /* By compiling a perl with -DNO_TAINT_SUPPORT or -DSILENT_NO_TAINT_SUPPORT,
 708  * you get a perl without taint support, but doubtlessly with a lesser
 709  * degree of support. Do not do so unless you know exactly what it means
 710  * technically, have a good reason to do so, and know exactly how the
 711  * perl will be used. perls with -DSILENT_NO_TAINT_SUPPORT are considered
 712  * a potential security risk due to flat out ignoring the security-relevant
 713  * taint flags. This being said, a perl without taint support compiled in
 714  * has marginal run-time performance benefits.
 715  * SILENT_NO_TAINT_SUPPORT implies NO_TAINT_SUPPORT.
 716  * SILENT_NO_TAINT_SUPPORT is the same as NO_TAINT_SUPPORT except it
 717  * silently ignores -t/-T instead of throwing an exception.
 718  *
 719  * DANGER! Using NO_TAINT_SUPPORT or SILENT_NO_TAINT_SUPPORT
 720  *         voids your nonexistent warranty!
 721  */
 722 #if defined(SILENT_NO_TAINT_SUPPORT) && !defined(NO_TAINT_SUPPORT)
 723 #  define NO_TAINT_SUPPORT 1
 724 #endif
 725
 726 /* NO_TAINT_SUPPORT can be set to transform virtually all taint-related
 727  * operations into no-ops for a very modest speed-up. Enable only if you
 728  * know what you're doing: tests and CPAN modules' tests are bound to fail.
 729  */
 730 #ifdef NO_TAINT_SUPPORT
 731 #   define TAINT                NOOP
 732 #   define TAINT_NOT            NOOP
 733 #   define TAINT_IF(c)          NOOP
 734 #   define TAINT_ENV()          NOOP
 735 #   define TAINT_PROPER(s)      NOOP
 736 #   define TAINT_set(s)         NOOP
 737 #   define TAINT_get            0
 738 #   define TAINTING_get         0
 739 #   define TAINTING_set(s)      NOOP
 740 #   define TAINT_WARN_get       0
 741 #   define TAINT_WARN_set(s)    NOOP
 742 #else
 743     /* Set to tainted if we are running under tainting mode */
 744 #   define TAINT                (PL_tainted = PL_tainting)
 745
 746 #   define TAINT_NOT    (PL_tainted = FALSE)        /* Untaint */
 747 #   define TAINT_IF(c)  if (UNLIKELY(c)) { TAINT; } /* Conditionally taint */
 748 #   define TAINT_ENV()  if (UNLIKELY(PL_tainting)) { taint_env(); }
 749                                 /* croak or warn if tainting */
 750 #   define TAINT_PROPER(s)      if (UNLIKELY(PL_tainting)) {                \
 751                                     taint_proper(NULL, s);                  \
 752                                 }
 753 #   define TAINT_set(s)         (PL_tainted = (s))
 754 #   define TAINT_get            (cBOOL(UNLIKELY(PL_tainted)))    /* Is something tainted? */
 755 #   define TAINTING_get         (cBOOL(UNLIKELY(PL_tainting)))   /* Is taint checking enabled? */
 756 #   define TAINTING_set(s)      (PL_tainting = (s))
 757 #   define TAINT_WARN_get       (PL_taint_warn) /* FALSE => tainting violations
 758                                                             are fatal
 759                                                    TRUE =>  they're just
 760                                                             warnings */
 761 #   define TAINT_WARN_set(s)    (PL_taint_warn = (s))
 762 #endif
 763
 764 /* flags used internally only within pp_subst and pp_substcont */
 765 #ifdef PERL_CORE
 766 #  define SUBST_TAINT_STR      1        /* string tainted */
 767 #  define SUBST_TAINT_PAT      2        /* pattern tainted */
 768 #  define SUBST_TAINT_REPL     4        /* replacement tainted */
 769 #  define SUBST_TAINT_RETAINT  8        /* use re'taint' in scope */
 770 #  define SUBST_TAINT_BOOLRET 16        /* return is boolean (don't taint) */
 771 #endif
 772
 773 /* XXX All process group stuff is handled in pp_sys.c.  Should these
 774    defines move there?  If so, I could simplify this a lot. --AD  9/96.
 775 */
 776 /* Process group stuff changed from traditional BSD to POSIX.
 777    perlfunc.pod documents the traditional BSD-style syntax, so we'll
 778    try to preserve that, if possible.
 779 */
 780 #ifdef HAS_SETPGID
 781 #  define BSD_SETPGRP(pid, pgrp)        setpgid((pid), (pgrp))
 782 #elif defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
 783 #  define BSD_SETPGRP(pid, pgrp)        setpgrp((pid), (pgrp))
 784 #elif defined(HAS_SETPGRP2)
 785 #  define BSD_SETPGRP(pid, pgrp)        setpgrp2((pid), (pgrp))
 786 #endif
 787 #if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
 788 #  define HAS_SETPGRP  /* Well, effectively it does . . . */
 789 #endif
 790
 791 /* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
 792     our life easier :-) so we'll try it.
 793 */
 794 #ifdef HAS_GETPGID
 795 #  define BSD_GETPGRP(pid)              getpgid((pid))
 796 #elif defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
 797 #  define BSD_GETPGRP(pid)              getpgrp((pid))
 798 #elif defined(HAS_GETPGRP2)
 799 #  define BSD_GETPGRP(pid)              getpgrp2((pid))
 800 #endif
 801 #if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
 802 #  define HAS_GETPGRP  /* Well, effectively it does . . . */
 803 #endif
 804
 805 /* These are not exact synonyms, since setpgrp() and getpgrp() may
 806    have different behaviors, but perl.h used to define USE_BSDPGRP
 807    (prior to 5.003_05) so some extension might depend on it.
 808 */
 809 #if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
 810 #  ifndef USE_BSDPGRP
 811 #    define USE_BSDPGRP
 812 #  endif
 813 #endif
 814
 815 /* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
 816    pthread.h must be included before all other header files.
 817 */
 818 #if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
 819 #  include <pthread.h>
 820 #endif
 821
 822 #include <sys/types.h>
 823
 824 #  ifdef I_WCHAR
 825 #    include <wchar.h>
 826 #  endif
 827
 828 # include <stdarg.h>
 829
 830 #ifdef I_STDINT
 831 # include <stdint.h>
 832 #endif
 833
 834 #include <ctype.h>
 835 #include <float.h>
 836 #include <limits.h>
 837
 838 #ifdef METHOD   /* Defined by OSF/1 v3.0 by ctype.h */
 839 #undef METHOD
 840 #endif
 841
 842 #ifdef PERL_MICRO
 843 #   define NO_LOCALE
 844 #endif
 845
 846 #ifdef I_LOCALE
 847 #   include <locale.h>
 848 #endif
 849
 850 #ifdef I_XLOCALE
 851 #   include <xlocale.h>
 852 #endif
 853
 854 /* If not forbidden, we enable locale handling if either 1) the POSIX 2008
 855  * functions are available, or 2) just the setlocale() function.  This logic is
 856  * repeated in t/loc_tools.pl and makedef.pl;  The three should be kept in
 857  * sync. */
 858 #if   ! defined(NO_LOCALE)
 859
 860 #  if ! defined(NO_POSIX_2008_LOCALE)           \
 861    &&   defined(HAS_NEWLOCALE)                  \
 862    &&   defined(HAS_USELOCALE)                  \
 863    &&   defined(HAS_DUPLOCALE)                  \
 864    &&   defined(HAS_FREELOCALE)                 \
 865    &&   defined(LC_ALL_MASK)
 866
 867     /* For simplicity, the code is written to assume that any platform advanced
 868      * enough to have the Posix 2008 locale functions has LC_ALL.  The final
 869      * test above makes sure that assumption is valid */
 870
 871 #    define HAS_POSIX_2008_LOCALE
 872 #    define USE_LOCALE
 873 #  elif defined(HAS_SETLOCALE)
 874 #    define USE_LOCALE
 875 #  endif
 876 #endif
 877
 878 #ifdef USE_LOCALE
 879 #   define HAS_SKIP_LOCALE_INIT /* Solely for XS code to test for this
 880                                    #define */
 881 #   if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
 882        && defined(HAS_STRXFRM)
 883 #       define USE_LOCALE_COLLATE
 884 #   endif
 885 #   if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
 886 #       define USE_LOCALE_CTYPE
 887 #   endif
 888 #   if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
 889 #       define USE_LOCALE_NUMERIC
 890 #   endif
 891 #   if !defined(NO_LOCALE_MESSAGES) && defined(LC_MESSAGES)
 892 #       define USE_LOCALE_MESSAGES
 893 #   endif
 894 #   if !defined(NO_LOCALE_MONETARY) && defined(LC_MONETARY)
 895 #       define USE_LOCALE_MONETARY
 896 #   endif
 897 #   if !defined(NO_LOCALE_TIME) && defined(LC_TIME)
 898 #       define USE_LOCALE_TIME
 899 #   endif
 900 #   if !defined(NO_LOCALE_ADDRESS) && defined(LC_ADDRESS)
 901 #       define USE_LOCALE_ADDRESS
 902 #   endif
 903 #   if !defined(NO_LOCALE_IDENTIFICATION) && defined(LC_IDENTIFICATION)
 904 #       define USE_LOCALE_IDENTIFICATION
 905 #   endif
 906 #   if !defined(NO_LOCALE_MEASUREMENT) && defined(LC_MEASUREMENT)
 907 #       define USE_LOCALE_MEASUREMENT
 908 #   endif
 909 #   if !defined(NO_LOCALE_PAPER) && defined(LC_PAPER)
 910 #       define USE_LOCALE_PAPER
 911 #   endif
 912 #   if !defined(NO_LOCALE_TELEPHONE) && defined(LC_TELEPHONE)
 913 #       define USE_LOCALE_TELEPHONE
 914 #   endif
 915 #   if !defined(NO_LOCALE_SYNTAX) && defined(LC_SYNTAX)
 916 #       define USE_LOCALE_SYNTAX
 917 #   endif
 918 #   if !defined(NO_LOCALE_TOD) && defined(LC_TOD)
 919 #       define USE_LOCALE_TOD
 920 #   endif
 921
 922 /* XXX The next few defines are unfortunately duplicated in makedef.pl, and
 923  * changes here MUST also be made there */
 924
 925 #  if ! defined(HAS_SETLOCALE) && defined(HAS_POSIX_2008_LOCALE)
 926 #      define USE_POSIX_2008_LOCALE
 927 #      ifndef USE_THREAD_SAFE_LOCALE
 928 #        define USE_THREAD_SAFE_LOCALE
 929 #      endif
 930                                    /* If compiled with
 931                                     * -DUSE_THREAD_SAFE_LOCALE, will do so even
 932                                     * on unthreaded builds */
 933 #  elif   (defined(USE_ITHREADS) || defined(USE_THREAD_SAFE_LOCALE))         \
 934        && (    defined(HAS_POSIX_2008_LOCALE)                                \
 935            || (defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1400))     \
 936        && ! defined(NO_THREAD_SAFE_LOCALE)
 937 #    ifndef USE_THREAD_SAFE_LOCALE
 938 #      define USE_THREAD_SAFE_LOCALE
 939 #    endif
 940 #    ifdef HAS_POSIX_2008_LOCALE
 941 #      define USE_POSIX_2008_LOCALE
 942 #    endif
 943 #  endif
 944 #endif
 945
 946 /*  Microsoft documentation reads in the change log for VS 2015:
 947  *     "The localeconv function declared in locale.h now works correctly when
 948  *     per-thread locale is enabled. In previous versions of the library, this
 949  *     function would return the lconv data for the global locale, not the
 950  *     thread's locale."
 951  */
 952 #if defined(WIN32) && defined(USE_THREAD_SAFE_LOCALE) && _MSC_VER < 1900
 953 #  define TS_W32_BROKEN_LOCALECONV
 954 #endif
 955
 956 #include <setjmp.h>
 957
 958 #ifdef I_SYS_PARAM
 959 #   ifdef PARAM_NEEDS_TYPES
 960 #       include <sys/types.h>
 961 #   endif
 962 #   include <sys/param.h>
 963 #endif
 964
 965 /* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
 966    value something like 199306.  This may be useful if no more-specific
 967    feature test is available.
 968 */
 969 #if defined(BSD)
 970 #   ifndef BSDish
 971 #       define BSDish
 972 #   endif
 973 #endif
 974
 975 /* Use all the "standard" definitions */
 976 #include <stdlib.h>
 977
 978 /* If this causes problems, set i_unistd=undef in the hint file.  */
 979 #ifdef I_UNISTD
 980 #    if defined(__amigaos4__)
 981 #        ifdef I_NETINET_IN
 982 #            include <netinet/in.h>
 983 #        endif
 984 #   endif
 985 #   include <unistd.h>
 986 #   if defined(__amigaos4__)
 987 /* Under AmigaOS 4 newlib.library provides an environ.  However using
 988  * it doesn't give us enough control over inheritance of variables by
 989  * subshells etc. so replace with custom version based on abc-shell
 990  * code. */
 991 extern char **myenviron;
 992 #       undef environ
 993 #       define environ myenviron
 994 #   endif
 995 #endif
 996
 997 /* for WCOREDUMP */
 998 #ifdef I_SYS_WAIT
 999 #   include <sys/wait.h>
1000 #endif
1001
1002 #ifdef __SYMBIAN32__
1003 #   undef _SC_ARG_MAX /* Symbian has _SC_ARG_MAX but no sysconf() */
1004 #endif
1005
1006 #if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
1007 EXTERN_C int syscall(int, ...);
1008 #endif
1009
1010 #if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
1011 EXTERN_C int usleep(unsigned int);
1012 #endif
1013
1014 /* macros for correct constant construction.  These are in C99 <stdint.h>
1015  * (so they will not be available in strict C89 mode), but they are nice, so
1016  * let's define them if necessary. */
1017 #ifndef UINT16_C
1018 #  if INTSIZE >= 2
1019 #    define UINT16_C(x) ((U16_TYPE)x##U)
1020 #  else
1021 #    define UINT16_C(x) ((U16_TYPE)x##UL)
1022 #  endif
1023 #endif
1024
1025 #ifndef UINT32_C
1026 #  if INTSIZE >= 4
1027 #    define UINT32_C(x) ((U32_TYPE)x##U)
1028 #  else
1029 #    define UINT32_C(x) ((U32_TYPE)x##UL)
1030 #  endif
1031 #endif
1032
1033 #ifdef I_STDINT
1034     typedef intmax_t  PERL_INTMAX_T;
1035     typedef uintmax_t PERL_UINTMAX_T;
1036 #endif
1037
1038 /* N.B.  We use QUADKIND here instead of HAS_QUAD here, because that doesn't
1039  * actually mean what it has always been documented to mean (see RT #119753)
1040  * and is explicitly turned off outside of core with dire warnings about
1041  * removing the undef. */
1042
1043 #if defined(QUADKIND)
1044 #  undef PeRl_INT64_C
1045 #  undef PeRl_UINT64_C
1046 /* Prefer the native integer types (int and long) over long long
1047  * (which is not C89) and Win32-specific __int64. */
1048 #  if QUADKIND == QUAD_IS_INT && INTSIZE == 8
1049 #    define PeRl_INT64_C(c)     (c)
1050 #    define PeRl_UINT64_C(c)    CAT2(c,U)
1051 #  endif
1052 #  if QUADKIND == QUAD_IS_LONG && LONGSIZE == 8
1053 #    define PeRl_INT64_C(c)     CAT2(c,L)
1054 #    define PeRl_UINT64_C(c)    CAT2(c,UL)
1055 #  endif
1056 #  if QUADKIND == QUAD_IS_LONG_LONG && defined(HAS_LONG_LONG)
1057 #    define PeRl_INT64_C(c)     CAT2(c,LL)
1058 #    define PeRl_UINT64_C(c)    CAT2(c,ULL)
1059 #  endif
1060 #  if QUADKIND == QUAD_IS___INT64
1061 #    define PeRl_INT64_C(c)     CAT2(c,I64)
1062 #    define PeRl_UINT64_C(c)    CAT2(c,UI64)
1063 #  endif
1064 #  ifndef PeRl_INT64_C
1065 #    define PeRl_INT64_C(c)     ((I64)(c)) /* last resort */
1066 #    define PeRl_UINT64_C(c)    ((U64TYPE)(c))
1067 #  endif
1068 /* In OS X the INT64_C/UINT64_C are defined with LL/ULL, which will
1069  * not fly with C89-pedantic gcc, so let's undefine them first so that
1070  * we can redefine them with our native integer preferring versions. */
1071 #  if defined(PERL_DARWIN) && defined(PERL_GCC_PEDANTIC)
1072 #    undef INT64_C
1073 #    undef UINT64_C
1074 #  endif
1075 #  ifndef INT64_C
1076 #    define INT64_C(c) PeRl_INT64_C(c)
1077 #  endif
1078 #  ifndef UINT64_C
1079 #    define UINT64_C(c) PeRl_UINT64_C(c)
1080 #  endif
1081
1082 #  ifndef I_STDINT
1083     typedef I64TYPE PERL_INTMAX_T;
1084     typedef U64TYPE PERL_UINTMAX_T;
1085 #  endif
1086 #  ifndef INTMAX_C
1087 #    define INTMAX_C(c) INT64_C(c)
1088 #  endif
1089 #  ifndef UINTMAX_C
1090 #    define UINTMAX_C(c) UINT64_C(c)
1091 #  endif
1092
1093 #else  /* below QUADKIND is undefined */
1094
1095 /* Perl doesn't work on 16 bit systems, so must be 32 bit */
1096 #  ifndef I_STDINT
1097     typedef I32TYPE PERL_INTMAX_T;
1098     typedef U32TYPE PERL_UINTMAX_T;
1099 #  endif
1100 #  ifndef INTMAX_C
1101 #    define INTMAX_C(c) INT32_C(c)
1102 #  endif
1103 #  ifndef UINTMAX_C
1104 #    define UINTMAX_C(c) UINT32_C(c)
1105 #  endif
1106
1107 #endif  /* no QUADKIND */
1108
1109 #ifdef PERL_CORE
1110
1111 /* byte-swapping functions for big-/little-endian conversion */
1112 # define _swab_16_(x) ((U16)( \
1113          (((U16)(x) & UINT16_C(0x00ff)) << 8) | \
1114          (((U16)(x) & UINT16_C(0xff00)) >> 8) ))
1115
1116 # define _swab_32_(x) ((U32)( \
1117          (((U32)(x) & UINT32_C(0x000000ff)) << 24) | \
1118          (((U32)(x) & UINT32_C(0x0000ff00)) <<  8) | \
1119          (((U32)(x) & UINT32_C(0x00ff0000)) >>  8) | \
1120          (((U32)(x) & UINT32_C(0xff000000)) >> 24) ))
1121
1122 # ifdef HAS_QUAD
1123 #  define _swab_64_(x) ((U64)( \
1124           (((U64)(x) & UINT64_C(0x00000000000000ff)) << 56) | \
1125           (((U64)(x) & UINT64_C(0x000000000000ff00)) << 40) | \
1126           (((U64)(x) & UINT64_C(0x0000000000ff0000)) << 24) | \
1127           (((U64)(x) & UINT64_C(0x00000000ff000000)) <<  8) | \
1128           (((U64)(x) & UINT64_C(0x000000ff00000000)) >>  8) | \
1129           (((U64)(x) & UINT64_C(0x0000ff0000000000)) >> 24) | \
1130           (((U64)(x) & UINT64_C(0x00ff000000000000)) >> 40) | \
1131           (((U64)(x) & UINT64_C(0xff00000000000000)) >> 56) ))
1132 # endif
1133
1134 /* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
1135    at least on FreeBSD.  YMMV, so experiment.  */
1136 #ifndef PERL_ARENA_SIZE
1137 #define PERL_ARENA_SIZE 4080
1138 #endif
1139
1140 /* Maximum level of recursion */
1141 #ifndef PERL_SUB_DEPTH_WARN
1142 #define PERL_SUB_DEPTH_WARN 100
1143 #endif
1144
1145 #endif /* PERL_CORE */
1146
1147 /* Maximum number of args that may be passed to an OP_MULTICONCAT op.
1148  * It determines the size of local arrays in S_maybe_multiconcat() and
1149  * pp_multiconcat().
1150  */
1151 #define PERL_MULTICONCAT_MAXARG 64
1152
1153 /* The indexes of fields of a multiconcat aux struct.
1154  * The fixed fields are followed by nargs+1 const segment lengths,
1155  * and if utf8 and non-utf8 differ, a second nargs+1 set for utf8.
1156  */
1157
1158 #define PERL_MULTICONCAT_IX_NARGS     0 /* number of arguments */
1159 #define PERL_MULTICONCAT_IX_PLAIN_PV  1 /* non-utf8 constant string */
1160 #define PERL_MULTICONCAT_IX_PLAIN_LEN 2 /* non-utf8 constant string length */
1161 #define PERL_MULTICONCAT_IX_UTF8_PV   3 /* utf8 constant string */
1162 #define PERL_MULTICONCAT_IX_UTF8_LEN  4 /* utf8 constant string length */
1163 #define PERL_MULTICONCAT_IX_LENGTHS   5 /* first of nargs+1 const segment lens */
1164 #define PERL_MULTICONCAT_HEADER_SIZE 5 /* The number of fields of a
1165                                            multiconcat header */
1166
1167 /* We no longer default to creating a new SV for GvSV.
1168    Do this before embed.  */
1169 #ifndef PERL_CREATE_GVSV
1170 #  ifndef PERL_DONT_CREATE_GVSV
1171 #    define PERL_DONT_CREATE_GVSV
1172 #  endif
1173 #endif
1174
1175 #if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
1176 #define PERL_USES_PL_PIDSTATUS
1177 #endif
1178
1179 #if !defined(OS2) && !defined(WIN32) && !defined(DJGPP) && !defined(__SYMBIAN32__)
1180 #define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
1181 #endif
1182
1183 #define MEM_SIZE Size_t
1184
1185 /* Round all values passed to malloc up, by default to a multiple of
1186    sizeof(size_t)
1187 */
1188 #ifndef PERL_STRLEN_ROUNDUP_QUANTUM
1189 #define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
1190 #endif
1191
1192 /* sv_grow() will expand strings by at least a certain percentage of
1193    the previously *used* length to avoid excessive calls to realloc().
1194    The default is 25% of the current length.
1195 */
1196 #ifndef PERL_STRLEN_EXPAND_SHIFT
1197 #  define PERL_STRLEN_EXPAND_SHIFT 2
1198 #endif
1199
1200 /* This use of offsetof() requires /Zc:offsetof- for VS2017 (and presumably
1201  * onwards) when building Socket.xs, but we can just use a different definition
1202  * for STRUCT_OFFSET instead. */
1203 #if defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1910
1204 #  define STRUCT_OFFSET(s,m)  (Size_t)(&(((s *)0)->m))
1205 #else
1206 #  include <stddef.h>
1207 #  define STRUCT_OFFSET(s,m)  offsetof(s,m)
1208 #endif
1209
1210 /* ptrdiff_t is C11, so undef it under pedantic builds.  (Actually it is
1211  * in C89, but apparently there are platforms where it doesn't exist.  See
1212  * thread beginning at http://nntp.perl.org/group/perl.perl5.porters/251541.)
1213  * */
1214 #ifdef PERL_GCC_PEDANTIC
1215 #   undef HAS_PTRDIFF_T
1216 #endif
1217
1218 #ifdef HAS_PTRDIFF_T
1219 #  define Ptrdiff_t ptrdiff_t
1220 #else
1221 #  define Ptrdiff_t SSize_t
1222 #endif
1223
1224 #ifndef __SYMBIAN32__
1225 #  include <string.h>
1226 #endif
1227
1228 /* This comes after <stdlib.h> so we don't try to change the standard
1229  * library prototypes; we'll use our own in proto.h instead. */
1230
1231 #ifdef MYMALLOC
1232 #  ifdef PERL_POLLUTE_MALLOC
1233 #   ifndef PERL_EXTMALLOC_DEF
1234 #    define Perl_malloc         malloc
1235 #    define Perl_calloc         calloc
1236 #    define Perl_realloc        realloc
1237 #    define Perl_mfree          free
1238 #   endif
1239 #  else
1240 #    define EMBEDMYMALLOC       /* for compatibility */
1241 #  endif
1242
1243 #  define safemalloc  Perl_malloc
1244 #  define safecalloc  Perl_calloc
1245 #  define saferealloc Perl_realloc
1246 #  define safefree    Perl_mfree
1247 #  define CHECK_MALLOC_TOO_LATE_FOR_(code)      STMT_START {            \
1248         if (!TAINTING_get && MallocCfg_ptr[MallocCfg_cfg_env_read])     \
1249                 code;                                                   \
1250     } STMT_END
1251 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)                         \
1252         CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
1253 #  define panic_write2(s)               write(2, s, strlen(s))
1254 #  define CHECK_MALLOC_TAINT(newval)                            \
1255         CHECK_MALLOC_TOO_LATE_FOR_(                             \
1256                 if (newval) {                                   \
1257                   PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
1258                   exit(1); })
1259 #  define MALLOC_CHECK_TAINT(argc,argv,env)     STMT_START {    \
1260         if (doing_taint(argc,argv,env)) {                       \
1261                 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1;      \
1262     }} STMT_END;
1263 #else  /* MYMALLOC */
1264 #  define safemalloc  safesysmalloc
1265 #  define safecalloc  safesyscalloc
1266 #  define saferealloc safesysrealloc
1267 #  define safefree    safesysfree
1268 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)         ((void)0)
1269 #  define CHECK_MALLOC_TAINT(newval)            ((void)0)
1270 #  define MALLOC_CHECK_TAINT(argc,argv,env)
1271 #endif /* MYMALLOC */
1272
1273 /* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
1274 #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)
1275 #define TOO_LATE_FOR(ch)        TOO_LATE_FOR_(ch, "")
1276 #define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
1277 #define MALLOC_CHECK_TAINT2(argc,argv)  MALLOC_CHECK_TAINT(argc,argv,NULL)
1278
1279 #ifndef memzero
1280 #   define memzero(d,l) memset(d,0,l)
1281 #endif
1282
1283 #ifdef I_NETINET_IN
1284 #   include <netinet/in.h>
1285 #endif
1286
1287 #ifdef I_ARPA_INET
1288 #   include <arpa/inet.h>
1289 #endif
1290
1291 #ifdef I_SYS_STAT
1292 #   include <sys/stat.h>
1293 #endif
1294
1295 /* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1296    This definition should ideally go into win32/win32.h, but S_IFIFO is
1297    used later here in perl.h before win32/win32.h is being included. */
1298 #if !defined(S_IFIFO) && defined(_S_IFIFO)
1299 #   define S_IFIFO _S_IFIFO
1300 #endif
1301
1302 /* The stat macros for Unisoft System V/88 (and derivatives
1303    like UTekV) are broken, sometimes giving false positives.  Undefine
1304    them here and let the code below set them to proper values.
1305
1306    The ghs macro stands for GreenHills Software C-1.8.5 which
1307    is the C compiler for sysV88 and the various derivatives.
1308    This header file bug is corrected in gcc-2.5.8 and later versions.
1309    --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94.  */
1310
1311 #if defined(m88k) && defined(ghs)
1312 #   undef S_ISDIR
1313 #   undef S_ISCHR
1314 #   undef S_ISBLK
1315 #   undef S_ISREG
1316 #   undef S_ISFIFO
1317 #   undef S_ISLNK
1318 #endif
1319
1320 #include <time.h>
1321
1322 #ifdef I_SYS_TIME
1323 #   ifdef I_SYS_TIME_KERNEL
1324 #       define KERNEL
1325 #   endif
1326 #   include <sys/time.h>
1327 #   ifdef I_SYS_TIME_KERNEL
1328 #       undef KERNEL
1329 #   endif
1330 #endif
1331
1332 #if defined(HAS_TIMES) && defined(I_SYS_TIMES)
1333 #    include <sys/times.h>
1334 #endif
1335
1336 #include <errno.h>
1337
1338 #if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
1339 #  define WIN32SCK_IS_STDSCK            /* don't pull in custom wsock layer */
1340 #endif
1341
1342 #if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1343 # include <sys/socket.h>
1344 # if defined(USE_SOCKS) && defined(I_SOCKS)
1345 #   if !defined(INCLUDE_PROTOTYPES)
1346 #       define INCLUDE_PROTOTYPES /* for <socks.h> */
1347 #       define PERL_SOCKS_NEED_PROTOTYPES
1348 #   endif
1349 #   include <socks.h>
1350 #   ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1351 #       undef INCLUDE_PROTOTYPES
1352 #       undef PERL_SOCKS_NEED_PROTOTYPES
1353 #   endif
1354 # endif
1355 # ifdef I_NETDB
1356 #  ifdef NETWARE
1357 #   include<stdio.h>
1358 #  endif
1359 #  include <netdb.h>
1360 # endif
1361 # ifndef ENOTSOCK
1362 #  ifdef I_NET_ERRNO
1363 #   include <net/errno.h>
1364 #  endif
1365 # endif
1366 #endif
1367
1368 /* sockatmark() is so new (2001) that many places might have it hidden
1369  * behind some -D_BLAH_BLAH_SOURCE guard.  The __THROW magic is required
1370  * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
1371 #if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
1372 # if defined(__THROW) && defined(__GLIBC__)
1373 int sockatmark(int) __THROW;
1374 # else
1375 int sockatmark(int);
1376 # endif
1377 #endif
1378
1379 #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. */
1380 EXTERN_C int fchdir(int);
1381 EXTERN_C int flock(int, int);
1382 EXTERN_C int fseeko(FILE *, off_t, int);
1383 EXTERN_C off_t ftello(FILE *);
1384 #endif
1385
1386 #if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1387 EXTERN_C char *crypt(const char *, const char *);
1388 #endif
1389
1390 #if defined(__cplusplus) && defined(__CYGWIN__)
1391 EXTERN_C char *crypt(const char *, const char *);
1392 #endif
1393
1394 /*
1395 =head1 Errno
1396
1397 =for apidoc m|void|SETERRNO|int errcode|int vmserrcode
1398
1399 Set C<errno>, and on VMS set C<vaxc$errno>.
1400
1401 =for apidoc mn|void|dSAVEDERRNO
1402
1403 Declare variables needed to save C<errno> and any operating system
1404 specific error number.
1405
1406 =for apidoc mn|void|dSAVE_ERRNO
1407
1408 Declare variables needed to save C<errno> and any operating system
1409 specific error number, and save them for optional later restoration
1410 by C<RESTORE_ERRNO>.
1411
1412 =for apidoc mn|void|SAVE_ERRNO
1413
1414 Save C<errno> and any operating system specific error number for
1415 optional later restoration by C<RESTORE_ERRNO>.  Requires
1416 C<dSAVEDERRNO> or C<dSAVE_ERRNO> in scope.
1417
1418 =for apidoc mn|void|RESTORE_ERRNO
1419
1420 Restore C<errno> and any operating system specific error number that
1421 was saved by C<dSAVE_ERRNO> or C<RESTORE_ERRNO>.
1422
1423 =cut
1424 */
1425
1426 #ifdef SETERRNO
1427 # undef SETERRNO  /* SOCKS might have defined this */
1428 #endif
1429
1430 #ifdef VMS
1431 #   define SETERRNO(errcode,vmserrcode) \
1432         STMT_START {                    \
1433             set_errno(errcode);         \
1434             set_vaxc_errno(vmserrcode); \
1435         } STMT_END
1436 #   define dSAVEDERRNO    int saved_errno; unsigned saved_vms_errno
1437 #   define dSAVE_ERRNO    int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1438 #   define SAVE_ERRNO     ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1439 #   define RESTORE_ERRNO  SETERRNO(saved_errno, saved_vms_errno)
1440
1441 #   define LIB_INVARG           LIB$_INVARG
1442 #   define RMS_DIR              RMS$_DIR
1443 #   define RMS_FAC              RMS$_FAC
1444 #   define RMS_FEX              RMS$_FEX
1445 #   define RMS_FNF              RMS$_FNF
1446 #   define RMS_IFI              RMS$_IFI
1447 #   define RMS_ISI              RMS$_ISI
1448 #   define RMS_PRV              RMS$_PRV
1449 #   define SS_ACCVIO            SS$_ACCVIO
1450 #   define SS_DEVOFFLINE        SS$_DEVOFFLINE
1451 #   define SS_IVCHAN            SS$_IVCHAN
1452 #   define SS_NORMAL            SS$_NORMAL
1453 #   define SS_NOPRIV            SS$_NOPRIV
1454 #   define SS_BUFFEROVF         SS$_BUFFEROVF
1455 #else
1456 #   define LIB_INVARG           0
1457 #   define RMS_DIR              0
1458 #   define RMS_FAC              0
1459 #   define RMS_FEX              0
1460 #   define RMS_FNF              0
1461 #   define RMS_IFI              0
1462 #   define RMS_ISI              0
1463 #   define RMS_PRV              0
1464 #   define SS_ACCVIO            0
1465 #   define SS_DEVOFFLINE        0
1466 #   define SS_IVCHAN            0
1467 #   define SS_NORMAL            0
1468 #   define SS_NOPRIV            0
1469 #   define SS_BUFFEROVF         0
1470 #endif
1471
1472 #ifdef WIN32
1473 #   define dSAVEDERRNO  int saved_errno; DWORD saved_win32_errno
1474 #   define dSAVE_ERRNO  int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1475 #   define SAVE_ERRNO   ( saved_errno = errno, saved_win32_errno = GetLastError() )
1476 #   define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1477 #endif
1478
1479 #ifdef OS2
1480 #   define dSAVEDERRNO  int saved_errno; unsigned long saved_os2_errno
1481 #   define dSAVE_ERRNO  int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1482 #   define SAVE_ERRNO   ( saved_errno = errno, saved_os2_errno = Perl_rc )
1483 #   define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1484 #endif
1485
1486 #ifndef SETERRNO
1487 #   define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1488 #endif
1489
1490 #ifndef dSAVEDERRNO
1491 #   define dSAVEDERRNO    int saved_errno
1492 #   define dSAVE_ERRNO    int saved_errno = errno
1493 #   define SAVE_ERRNO     (saved_errno = errno)
1494 #   define RESTORE_ERRNO  (errno = saved_errno)
1495 #endif
1496
1497 /*
1498 =head1 Warning and Dieing
1499
1500 =for apidoc Amn|SV *|ERRSV
1501
1502 Returns the SV for C<$@>, creating it if needed.
1503
1504 =for apidoc Am|void|CLEAR_ERRSV
1505
1506 Clear the contents of C<$@>, setting it to the empty string.
1507
1508 This replaces any read-only SV with a fresh SV and removes any magic.
1509
1510 =for apidoc Am|void|SANE_ERRSV
1511
1512 Clean up ERRSV so we can safely set it.
1513
1514 This replaces any read-only SV with a fresh writable copy and removes
1515 any magic.
1516
1517 =cut
1518 */
1519
1520 #define ERRSV GvSVn(PL_errgv)
1521
1522 /* contains inlined gv_add_by_type */
1523 #define CLEAR_ERRSV() STMT_START {                                      \
1524     SV ** const svp = &GvSV(PL_errgv);                                  \
1525     if (!*svp) {                                                        \
1526         *svp = newSVpvs("");                                            \
1527     } else if (SvREADONLY(*svp)) {                                      \
1528         SvREFCNT_dec_NN(*svp);                                          \
1529         *svp = newSVpvs("");                                            \
1530     } else {                                                            \
1531         SV *const errsv = *svp;                                         \
1532         SvPVCLEAR(errsv);                                               \
1533         SvPOK_only(errsv);                                              \
1534         if (SvMAGICAL(errsv)) {                                         \
1535             mg_free(errsv);                                             \
1536         }                                                               \
1537     }                                                                   \
1538     } STMT_END
1539
1540 /* contains inlined gv_add_by_type */
1541 #define SANE_ERRSV() STMT_START {                                       \
1542     SV ** const svp = &GvSV(PL_errgv);                                  \
1543     if (!*svp) {                                                        \
1544         *svp = newSVpvs("");                                            \
1545     } else if (SvREADONLY(*svp)) {                                      \
1546         SV *dupsv = newSVsv(*svp);                                      \
1547         SvREFCNT_dec_NN(*svp);                                          \
1548         *svp = dupsv;                                                   \
1549     } else {                                                            \
1550         SV *const errsv = *svp;                                         \
1551         if (SvMAGICAL(errsv)) {                                         \
1552             mg_free(errsv);                                             \
1553         }                                                               \
1554     }                                                                   \
1555     } STMT_END
1556
1557
1558 #ifdef PERL_CORE
1559 # define DEFSV (0 + GvSVn(PL_defgv))
1560 # define DEFSV_set(sv) \
1561     (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1562 # define SAVE_DEFSV                \
1563     (                               \
1564         save_gp(PL_defgv, 0),        \
1565         GvINTRO_off(PL_defgv),        \
1566         SAVEGENERICSV(GvSV(PL_defgv)), \
1567         GvSV(PL_defgv) = NULL           \
1568     )
1569 #else
1570 # define DEFSV GvSVn(PL_defgv)
1571 # define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1572 # define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
1573 #endif
1574
1575 #ifndef errno
1576         extern int errno;     /* ANSI allows errno to be an lvalue expr.
1577                                * For example in multithreaded environments
1578                                * something like this might happen:
1579                                * extern int *_errno(void);
1580                                * #define errno (*_errno()) */
1581 #endif
1582
1583 #define UNKNOWN_ERRNO_MSG "(unknown)"
1584
1585 #ifdef VMS
1586 #define Strerror(e) strerror((e), vaxc$errno)
1587 #else
1588 #define Strerror(e) strerror(e)
1589 #endif
1590
1591 #ifdef I_SYS_IOCTL
1592 #   ifndef _IOCTL_
1593 #       include <sys/ioctl.h>
1594 #   endif
1595 #endif
1596
1597 #if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
1598 #   ifdef HAS_SOCKETPAIR
1599 #       undef HAS_SOCKETPAIR
1600 #   endif
1601 #   ifdef I_NDBM
1602 #       undef I_NDBM
1603 #   endif
1604 #endif
1605
1606 #ifndef HAS_SOCKETPAIR
1607 #   ifdef HAS_SOCKET
1608 #       define socketpair Perl_my_socketpair
1609 #   endif
1610 #endif
1611
1612 #if INTSIZE == 2
1613 #   define htoni htons
1614 #   define ntohi ntohs
1615 #else
1616 #   define htoni htonl
1617 #   define ntohi ntohl
1618 #endif
1619
1620 /* Configure already sets Direntry_t */
1621 #if defined(I_DIRENT)
1622 #  include <dirent.h>
1623 #elif defined(I_SYS_NDIR)
1624 #  include <sys/ndir.h>
1625 #elif defined(I_SYS_DIR)
1626 #  include <sys/dir.h>
1627 #endif
1628
1629 /*
1630  * The following gobbledygook brought to you on behalf of __STDC__.
1631  * (I could just use #ifndef __STDC__, but this is more bulletproof
1632  * in the face of half-implementations.)
1633  */
1634
1635 #if defined(I_SYSMODE)
1636 #include <sys/mode.h>
1637 #endif
1638
1639 #ifndef S_IFMT
1640 #   ifdef _S_IFMT
1641 #       define S_IFMT _S_IFMT
1642 #   else
1643 #       define S_IFMT 0170000
1644 #   endif
1645 #endif
1646
1647 #ifndef S_ISDIR
1648 #   define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1649 #endif
1650
1651 #ifndef S_ISCHR
1652 #   define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1653 #endif
1654
1655 #ifndef S_ISBLK
1656 #   ifdef S_IFBLK
1657 #       define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1658 #   else
1659 #       define S_ISBLK(m) (0)
1660 #   endif
1661 #endif
1662
1663 #ifndef S_ISREG
1664 #   define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1665 #endif
1666
1667 #ifndef S_ISFIFO
1668 #   ifdef S_IFIFO
1669 #       define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1670 #   else
1671 #       define S_ISFIFO(m) (0)
1672 #   endif
1673 #endif
1674
1675 #ifndef S_ISLNK
1676 #  ifdef _S_ISLNK
1677 #    define S_ISLNK(m) _S_ISLNK(m)
1678 #  elif defined(_S_IFLNK)
1679 #    define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1680 #  elif defined(S_IFLNK)
1681 #    define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1682 #  else
1683 #    define S_ISLNK(m) (0)
1684 #  endif
1685 #endif
1686
1687 #ifndef S_ISSOCK
1688 #  ifdef _S_ISSOCK
1689 #    define S_ISSOCK(m) _S_ISSOCK(m)
1690 #  elif defined(_S_IFSOCK)
1691 #    define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1692 #  elif defined(S_IFSOCK)
1693 #    define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1694 #  else
1695 #    define S_ISSOCK(m) (0)
1696 #  endif
1697 #endif
1698
1699 #ifndef S_IRUSR
1700 #   ifdef S_IREAD
1701 #       define S_IRUSR S_IREAD
1702 #       define S_IWUSR S_IWRITE
1703 #       define S_IXUSR S_IEXEC
1704 #   else
1705 #       define S_IRUSR 0400
1706 #       define S_IWUSR 0200
1707 #       define S_IXUSR 0100
1708 #   endif
1709 #endif
1710
1711 #ifndef S_IRGRP
1712 #   ifdef S_IRUSR
1713 #       define S_IRGRP (S_IRUSR>>3)
1714 #       define S_IWGRP (S_IWUSR>>3)
1715 #       define S_IXGRP (S_IXUSR>>3)
1716 #   else
1717 #       define S_IRGRP 0040
1718 #       define S_IWGRP 0020
1719 #       define S_IXGRP 0010
1720 #   endif
1721 #endif
1722
1723 #ifndef S_IROTH
1724 #   ifdef S_IRUSR
1725 #       define S_IROTH (S_IRUSR>>6)
1726 #       define S_IWOTH (S_IWUSR>>6)
1727 #       define S_IXOTH (S_IXUSR>>6)
1728 #   else
1729 #       define S_IROTH 0040
1730 #       define S_IWOTH 0020
1731 #       define S_IXOTH 0010
1732 #   endif
1733 #endif
1734
1735 #ifndef S_ISUID
1736 #   define S_ISUID 04000
1737 #endif
1738
1739 #ifndef S_ISGID
1740 #   define S_ISGID 02000
1741 #endif
1742
1743 #ifndef S_IRWXU
1744 #   define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
1745 #endif
1746
1747 #ifndef S_IRWXG
1748 #   define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
1749 #endif
1750
1751 #ifndef S_IRWXO
1752 #   define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
1753 #endif
1754
1755 /* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
1756  * which would get included through <sys/file.h >, but that is 3000
1757  * lines in the future.  --jhi */
1758
1759 #if !defined(S_IREAD) && !defined(__HAIKU__)
1760 #   define S_IREAD S_IRUSR
1761 #endif
1762
1763 #if !defined(S_IWRITE) && !defined(__HAIKU__)
1764 #   define S_IWRITE S_IWUSR
1765 #endif
1766
1767 #ifndef S_IEXEC
1768 #   define S_IEXEC S_IXUSR
1769 #endif
1770
1771 #if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
1772 #   define SLOPPYDIVIDE
1773 #endif
1774
1775 #ifdef UV
1776 #undef UV
1777 #endif
1778
1779 /* This used to be conditionally defined based on whether we had a sprintf()
1780  * that correctly returns the string length (as required by C89), but we no
1781  * longer need that. XS modules can (and do) use this name, so it must remain
1782  * a part of the API that's visible to modules.
1783
1784 =head1 Miscellaneous Functions
1785
1786 =for apidoc ATmD|int|my_sprintf|NN char *buffer|NN const char *pat|...
1787
1788 Do NOT use this due to the possibility of overflowing C<buffer>.  Instead use
1789 my_snprintf()
1790
1791 =cut
1792 */
1793 #define my_sprintf sprintf
1794
1795 /*
1796  * If we have v?snprintf() and the C99 variadic macros, we can just
1797  * use just the v?snprintf().  It is nice to try to trap the buffer
1798  * overflow, however, so if we are DEBUGGING, and we cannot use the
1799  * gcc statement expressions, then use the function wrappers which try
1800  * to trap the overflow.  If we can use the gcc statement expressions,
1801  * we can try that even with the version that uses the C99 variadic
1802  * macros.
1803  */
1804
1805 /* Note that we do not check against snprintf()/vsnprintf() returning
1806  * negative values because that is non-standard behaviour and we use
1807  * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1808  * that should be true only if the snprintf()/vsnprintf() are true
1809  * to the standard. */
1810
1811 #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
1812
1813 #ifdef USE_QUADMATH
1814 #  define my_snprintf Perl_my_snprintf
1815 #  define PERL_MY_SNPRINTF_GUARDED
1816 #elif defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1817 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1818 #      define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1819 #      define PERL_MY_SNPRINTF_GUARDED
1820 #  else
1821 #    define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
1822 #  endif
1823 #else
1824 #  define my_snprintf  Perl_my_snprintf
1825 #  define PERL_MY_SNPRINTF_GUARDED
1826 #endif
1827
1828 /* There is no quadmath_vsnprintf, and therefore my_vsnprintf()
1829  * dies if called under USE_QUADMATH. */
1830 #if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1831 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1832 #      define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1833 #      define PERL_MY_VSNPRINTF_GUARDED
1834 #  else
1835 #    define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
1836 #  endif
1837 #else
1838 #  define my_vsnprintf Perl_my_vsnprintf
1839 #  define PERL_MY_VSNPRINTF_GUARDED
1840 #endif
1841
1842 /* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1843  * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1844  * the result of my_snprintf() or my_vsnprintf().  (No, you should not
1845  * completely ignore it: otherwise you cannot know whether your output
1846  * was too long.)
1847  *
1848  * int len = my_sprintf(buf, max, ...);
1849  * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1850  *
1851  * The trick is that in certain platforms [a] the my_sprintf() already
1852  * contains the sanity check, while in certain platforms [b] it needs
1853  * to be done as a separate step.  The POST_GUARD is that step-- in [a]
1854  * platforms the POST_GUARD actually does nothing since the check has
1855  * already been done.  Watch out for the max being the same in both calls.
1856  *
1857  * If you actually use the snprintf/vsnprintf return value already,
1858  * you assumedly are checking its validity somehow.  But you can
1859  * insert the POST_GUARD() also in that case. */
1860
1861 #ifndef PERL_MY_SNPRINTF_GUARDED
1862 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1863 #else
1864 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1865 #endif
1866
1867 #ifndef  PERL_MY_VSNPRINTF_GUARDED
1868 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
1869 #else
1870 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1871 #endif
1872
1873 #ifdef HAS_STRLCAT
1874 #  define my_strlcat    strlcat
1875 #endif
1876
1877 #if defined(PERL_CORE) || defined(PERL_EXT)
1878 #  ifdef HAS_MEMRCHR
1879 #    define my_memrchr  memrchr
1880 #  else
1881 #    define my_memrchr  S_my_memrchr
1882 #  endif
1883 #endif
1884
1885 #ifdef HAS_STRLCPY
1886 #  define my_strlcpy    strlcpy
1887 #endif
1888
1889 #ifdef HAS_STRNLEN
1890 #  define my_strnlen    strnlen
1891 #endif
1892
1893 /*
1894     The IV type is supposed to be long enough to hold any integral
1895     value or a pointer.
1896     --Andy Dougherty    August 1996
1897 */
1898
1899 typedef IVTYPE IV;
1900 typedef UVTYPE UV;
1901
1902 #if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
1903 #  if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
1904 #    define IV_MAX ((IV)INT64_MAX)
1905 #    define IV_MIN ((IV)INT64_MIN)
1906 #    define UV_MAX ((UV)UINT64_MAX)
1907 #    ifndef UINT64_MIN
1908 #      define UINT64_MIN 0
1909 #    endif
1910 #    define UV_MIN ((UV)UINT64_MIN)
1911 #  else
1912 #    define IV_MAX PERL_QUAD_MAX
1913 #    define IV_MIN PERL_QUAD_MIN
1914 #    define UV_MAX PERL_UQUAD_MAX
1915 #    define UV_MIN PERL_UQUAD_MIN
1916 #  endif
1917 #  define IV_IS_QUAD
1918 #  define UV_IS_QUAD
1919 #else
1920 #  if defined(INT32_MAX) && IVSIZE == 4
1921 #    define IV_MAX ((IV)INT32_MAX)
1922 #    define IV_MIN ((IV)INT32_MIN)
1923 #    ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
1924 #        define UV_MAX ((UV)UINT32_MAX)
1925 #    else
1926 #        define UV_MAX ((UV)4294967295U)
1927 #    endif
1928 #    ifndef UINT32_MIN
1929 #      define UINT32_MIN 0
1930 #    endif
1931 #    define UV_MIN ((UV)UINT32_MIN)
1932 #  else
1933 #    define IV_MAX PERL_LONG_MAX
1934 #    define IV_MIN PERL_LONG_MIN
1935 #    define UV_MAX PERL_ULONG_MAX
1936 #    define UV_MIN PERL_ULONG_MIN
1937 #  endif
1938 #  if IVSIZE == 8
1939 #    define IV_IS_QUAD
1940 #    define UV_IS_QUAD
1941 #    ifndef HAS_QUAD
1942 #      define HAS_QUAD
1943 #    endif
1944 #  else
1945 #    undef IV_IS_QUAD
1946 #    undef UV_IS_QUAD
1947 #if !defined(PERL_CORE)
1948 /* We think that removing this decade-old undef this will cause too much
1949    breakage on CPAN for too little gain. (See RT #119753)
1950    However, we do need HAS_QUAD in the core for use by the drand48 code. */
1951 #    undef HAS_QUAD
1952 #endif
1953 #  endif
1954 #endif
1955
1956 #define Size_t_MAX (~(Size_t)0)
1957 #define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
1958
1959 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
1960 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
1961
1962 #ifndef NO_PERL_PRESERVE_IVUV
1963 #define PERL_PRESERVE_IVUV      /* We like our integers to stay integers. */
1964 #endif
1965
1966 /*
1967  *  The macros INT2PTR and NUM2PTR are (despite their names)
1968  *  bi-directional: they will convert int/float to or from pointers.
1969  *  However the conversion to int/float are named explicitly:
1970  *  PTR2IV, PTR2UV, PTR2NV.
1971  *
1972  *  For int conversions we do not need two casts if pointers are
1973  *  the same size as IV and UV.   Otherwise we need an explicit
1974  *  cast (PTRV) to avoid compiler warnings.
1975  */
1976 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1977 #  define PTRV                  UV
1978 #  define INT2PTR(any,d)        (any)(d)
1979 #elif PTRSIZE == LONGSIZE
1980 #  define PTRV                  unsigned long
1981 #  define PTR2ul(p)             (unsigned long)(p)
1982 #else
1983 #  define PTRV                  unsigned
1984 #endif
1985
1986 #ifndef INT2PTR
1987 #  define INT2PTR(any,d)        (any)(PTRV)(d)
1988 #endif
1989
1990 #ifndef PTR2ul
1991 #  define PTR2ul(p)     INT2PTR(unsigned long,p)
1992 #endif
1993
1994 #define NUM2PTR(any,d)  (any)(PTRV)(d)
1995 #define PTR2IV(p)       INT2PTR(IV,p)
1996 #define PTR2UV(p)       INT2PTR(UV,p)
1997 #define PTR2NV(p)       NUM2PTR(NV,p)
1998 #define PTR2nat(p)      (PTRV)(p)       /* pointer to integer of PTRSIZE */
1999
2000 /* According to strict ANSI C89 one cannot freely cast between
2001  * data pointers and function (code) pointers.  There are at least
2002  * two ways around this.  One (used below) is to do two casts,
2003  * first the other pointer to an (unsigned) integer, and then
2004  * the integer to the other pointer.  The other way would be
2005  * to use unions to "overlay" the pointers.  For an example of
2006  * the latter technique, see union dirpu in struct xpvio in sv.h.
2007  * The only feasible use is probably temporarily storing
2008  * function pointers in a data pointer (such as a void pointer). */
2009
2010 #define DPTR2FPTR(t,p) ((t)PTR2nat(p))  /* data pointer to function pointer */
2011 #define FPTR2DPTR(t,p) ((t)PTR2nat(p))  /* function pointer to data pointer */
2012
2013 #ifdef USE_LONG_DOUBLE
2014 #  if LONG_DOUBLESIZE == DOUBLESIZE
2015 #    define LONG_DOUBLE_EQUALS_DOUBLE
2016 #    undef USE_LONG_DOUBLE /* Ouch! */
2017 #  endif
2018 #endif
2019
2020 /* The following is all to get LDBL_DIG, in order to pick a nice
2021    default value for printing floating point numbers in Gconvert.
2022    (see config.h)
2023 */
2024 #ifndef HAS_LDBL_DIG
2025 #  if LONG_DOUBLESIZE == 10
2026 #    define LDBL_DIG 18 /* assume IEEE */
2027 #  elif LONG_DOUBLESIZE == 12
2028 #    define LDBL_DIG 18 /* gcc? */
2029 #  elif LONG_DOUBLESIZE == 16
2030 #    define LDBL_DIG 33 /* assume IEEE */
2031 #  elif LONG_DOUBLESIZE == DOUBLESIZE
2032 #    define LDBL_DIG DBL_DIG /* bummer */
2033 #  endif
2034 #endif
2035
2036 typedef NVTYPE NV;
2037
2038 #ifdef I_IEEEFP
2039 #   include <ieeefp.h>
2040 #endif
2041
2042 #if defined(__DECC) && defined(__osf__)
2043 /* Also Tru64 cc has broken NaN comparisons. */
2044 #  define NAN_COMPARE_BROKEN
2045 #endif
2046 #if defined(__sgi)
2047 #  define NAN_COMPARE_BROKEN
2048 #endif
2049
2050 #ifdef USE_LONG_DOUBLE
2051 #   ifdef I_SUNMATH
2052 #       include <sunmath.h>
2053 #   endif
2054 #   if defined(LDBL_DIG)
2055 #       define NV_DIG LDBL_DIG
2056 #       ifdef LDBL_MANT_DIG
2057 #           define NV_MANT_DIG LDBL_MANT_DIG
2058 #       endif
2059 #       ifdef LDBL_MIN
2060 #           define NV_MIN LDBL_MIN
2061 #       endif
2062 #       ifdef LDBL_MAX
2063 #           define NV_MAX LDBL_MAX
2064 #       endif
2065 #       ifdef LDBL_MIN_EXP
2066 #           define NV_MIN_EXP LDBL_MIN_EXP
2067 #       endif
2068 #       ifdef LDBL_MAX_EXP
2069 #           define NV_MAX_EXP LDBL_MAX_EXP
2070 #       endif
2071 #       ifdef LDBL_MIN_10_EXP
2072 #           define NV_MIN_10_EXP LDBL_MIN_10_EXP
2073 #       endif
2074 #       ifdef LDBL_MAX_10_EXP
2075 #           define NV_MAX_10_EXP LDBL_MAX_10_EXP
2076 #       endif
2077 #       ifdef LDBL_EPSILON
2078 #           define NV_EPSILON LDBL_EPSILON
2079 #       endif
2080 #       ifdef LDBL_MAX
2081 #           define NV_MAX LDBL_MAX
2082 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
2083 #       elif defined(HUGE_VALL)
2084 #           define NV_MAX HUGE_VALL
2085 #       endif
2086 #   endif
2087 #   if defined(HAS_SQRTL)
2088 #       define Perl_acos acosl
2089 #       define Perl_asin asinl
2090 #       define Perl_atan atanl
2091 #       define Perl_atan2 atan2l
2092 #       define Perl_ceil ceill
2093 #       define Perl_cos cosl
2094 #       define Perl_cosh coshl
2095 #       define Perl_exp expl
2096 /* no Perl_fabs, but there's PERL_ABS */
2097 #       define Perl_floor floorl
2098 #       define Perl_fmod fmodl
2099 #       define Perl_log logl
2100 #       define Perl_log10 log10l
2101 #       define Perl_pow powl
2102 #       define Perl_sin sinl
2103 #       define Perl_sinh sinhl
2104 #       define Perl_sqrt sqrtl
2105 #       define Perl_tan tanl
2106 #       define Perl_tanh tanhl
2107 #   endif
2108 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
2109 #   ifndef Perl_modf
2110 #       ifdef HAS_MODFL
2111 #           define Perl_modf(x,y) modfl(x,y)
2112 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
2113    prototype in <math.h> */
2114 #           ifndef HAS_MODFL_PROTO
2115 EXTERN_C long double modfl(long double, long double *);
2116 #           endif
2117 #       elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
2118         extern long double Perl_my_modfl(long double x, long double *ip);
2119 #           define Perl_modf(x,y) Perl_my_modfl(x,y)
2120 #       endif
2121 #   endif
2122 #   ifndef Perl_frexp
2123 #       ifdef HAS_FREXPL
2124 #           define Perl_frexp(x,y) frexpl(x,y)
2125 #       elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
2126 extern long double Perl_my_frexpl(long double x, int *e);
2127 #           define Perl_frexp(x,y) Perl_my_frexpl(x,y)
2128 #       endif
2129 #   endif
2130 #   ifndef Perl_ldexp
2131 #       ifdef HAS_LDEXPL
2132 #           define Perl_ldexp(x, y) ldexpl(x,y)
2133 #       elif defined(HAS_SCALBNL) && FLT_RADIX == 2
2134 #           define Perl_ldexp(x,y) scalbnl(x,y)
2135 #       endif
2136 #   endif
2137 #   ifndef Perl_isnan
2138 #       if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
2139 #           define Perl_isnan(x) isnanl(x)
2140 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
2141 #           define Perl_isnan(x) isnan(x)
2142 #       endif
2143 #   endif
2144 #   ifndef Perl_isinf
2145 #       if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
2146 #           define Perl_isinf(x) isinfl(x)
2147 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
2148 #           define Perl_isinf(x) isinf(x)
2149 #       elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2150 #           define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
2151 #       endif
2152 #   endif
2153 #   ifndef Perl_isfinite
2154 #       define Perl_isfinite(x) Perl_isfinitel(x)
2155 #   endif
2156 #elif defined(USE_QUADMATH) && defined(I_QUADMATH)
2157 #   include <quadmath.h>
2158 #   define NV_DIG FLT128_DIG
2159 #   define NV_MANT_DIG FLT128_MANT_DIG
2160 #   define NV_MIN FLT128_MIN
2161 #   define NV_MAX FLT128_MAX
2162 #   define NV_MIN_EXP FLT128_MIN_EXP
2163 #   define NV_MAX_EXP FLT128_MAX_EXP
2164 #   define NV_EPSILON FLT128_EPSILON
2165 #   define NV_MIN_10_EXP FLT128_MIN_10_EXP
2166 #   define NV_MAX_10_EXP FLT128_MAX_10_EXP
2167 #   define Perl_acos acosq
2168 #   define Perl_asin asinq
2169 #   define Perl_atan atanq
2170 #   define Perl_atan2 atan2q
2171 #   define Perl_ceil ceilq
2172 #   define Perl_cos cosq
2173 #   define Perl_cosh coshq
2174 #   define Perl_exp expq
2175 /* no Perl_fabs, but there's PERL_ABS */
2176 #   define Perl_floor floorq
2177 #   define Perl_fmod fmodq
2178 #   define Perl_log logq
2179 #   define Perl_log10 log10q
2180 #   define Perl_signbit signbitq
2181 #   define Perl_pow powq
2182 #   define Perl_sin sinq
2183 #   define Perl_sinh sinhq
2184 #   define Perl_sqrt sqrtq
2185 #   define Perl_tan tanq
2186 #   define Perl_tanh tanhq
2187 #   define Perl_modf(x,y) modfq(x,y)
2188 #   define Perl_frexp(x,y) frexpq(x,y)
2189 #   define Perl_ldexp(x, y) ldexpq(x,y)
2190 #   define Perl_isinf(x) isinfq(x)
2191 #   define Perl_isnan(x) isnanq(x)
2192 #   define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
2193 #   define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
2194 #   define Perl_fp_class_inf(x)    (Perl_fp_class(x) == 3)
2195 #   define Perl_fp_class_nan(x)    (Perl_fp_class(x) == 4)
2196 #   define Perl_fp_class_norm(x)   (Perl_fp_class(x) == 1)
2197 #   define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
2198 #   define Perl_fp_class_zero(x)   (Perl_fp_class(x) == 0)
2199 #else
2200 #   define NV_DIG DBL_DIG
2201 #   define NV_MANT_DIG DBL_MANT_DIG
2202 #   define NV_MIN DBL_MIN
2203 #   define NV_MAX DBL_MAX
2204 #   define NV_MIN_EXP DBL_MIN_EXP
2205 #   define NV_MAX_EXP DBL_MAX_EXP
2206 #   define NV_MIN_10_EXP DBL_MIN_10_EXP
2207 #   define NV_MAX_10_EXP DBL_MAX_10_EXP
2208 #   define NV_EPSILON DBL_EPSILON
2209 #   define NV_MAX DBL_MAX
2210 #   define NV_MIN DBL_MIN
2211
2212 /* These math interfaces are C89. */
2213 #   define Perl_acos acos
2214 #   define Perl_asin asin
2215 #   define Perl_atan atan
2216 #   define Perl_atan2 atan2
2217 #   define Perl_ceil ceil
2218 #   define Perl_cos cos
2219 #   define Perl_cosh cosh
2220 #   define Perl_exp exp
2221 /* no Perl_fabs, but there's PERL_ABS */
2222 #   define Perl_floor floor
2223 #   define Perl_fmod fmod
2224 #   define Perl_log log
2225 #   define Perl_log10 log10
2226 #   define Perl_pow pow
2227 #   define Perl_sin sin
2228 #   define Perl_sinh sinh
2229 #   define Perl_sqrt sqrt
2230 #   define Perl_tan tan
2231 #   define Perl_tanh tanh
2232
2233 #   define Perl_modf(x,y) modf(x,y)
2234 #   define Perl_frexp(x,y) frexp(x,y)
2235 #   define Perl_ldexp(x,y) ldexp(x,y)
2236
2237 #   ifndef Perl_isnan
2238 #       ifdef HAS_ISNAN
2239 #           define Perl_isnan(x) isnan(x)
2240 #       endif
2241 #   endif
2242 #   ifndef Perl_isinf
2243 #       if defined(HAS_ISINF)
2244 #           define Perl_isinf(x) isinf(x)
2245 #       elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2246 #           define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
2247 #       endif
2248 #   endif
2249 #   ifndef Perl_isfinite
2250 #     ifdef HAS_ISFINITE
2251 #       define Perl_isfinite(x) isfinite(x)
2252 #     elif defined(HAS_FINITE)
2253 #       define Perl_isfinite(x) finite(x)
2254 #     endif
2255 #   endif
2256 #endif
2257
2258 /* fpclassify(): C99.  It is supposed to be a macro that switches on
2259 * the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
2260 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2261 #    include <math.h>
2262 #    if defined(FP_INFINITE) && defined(FP_NAN)
2263 #        define Perl_fp_class(x)        fpclassify(x)
2264 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
2265 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
2266 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
2267 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2268 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
2269 #    elif defined(FP_PLUS_INF) && defined(FP_QNAN)
2270 /* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
2271  * actually not the C99 fpclassify, with its own set of return defines. */
2272 #        define Perl_fp_class(x)        fpclassify(x)
2273 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PLUS_INF)
2274 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_MINUS_INF)
2275 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
2276 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
2277 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PLUS_NORM)
2278 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_MINUS_NORM)
2279 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PLUS_DENORM)
2280 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_MINUS_DENORM)
2281 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PLUS_ZERO)
2282 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_MINUS_ZERO)
2283 #    else
2284 #        undef Perl_fp_class /* Unknown set of defines */
2285 #    endif
2286 #endif
2287
2288 /* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
2289  * are identical to the C99 fpclassify(). */
2290 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
2291 #    include <math.h>
2292 #    ifdef __VMS
2293      /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
2294 #        include <fp.h>
2295      /* oh, and the isnormal macro has a typo in it! */
2296 #    undef isnormal
2297 #    define isnormal(x) Perl_fp_class_norm(x)
2298 #    endif
2299 #    if defined(FP_INFINITE) && defined(FP_NAN)
2300 #        define Perl_fp_class(x)        fp_classify(x)
2301 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
2302 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
2303 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
2304 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2305 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
2306 #    else
2307 #        undef Perl_fp_class /* Unknown set of defines */
2308 #    endif
2309 #endif
2310
2311 /* Feel free to check with me for the SGI manpages, SGI testing,
2312  * etcetera, if you want to try getting this to work with IRIX.
2313  *
2314  * - Allen <allens@cpan.org> */
2315
2316 /* fpclass(): SysV, at least Solaris and some versions of IRIX. */
2317 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
2318 /* Solaris and IRIX have fpclass/fpclassl, but they are using
2319  * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2320  * Define some symbols also as cpp symbols so we can detect them. */
2321 #    if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
2322 #     define FP_PINF FP_PINF
2323 #     define FP_QNAN FP_QNAN
2324 #    endif
2325 #    include <math.h>
2326 #    ifdef I_IEEFP
2327 #        include <ieeefp.h>
2328 #    endif
2329 #    ifdef I_FP
2330 #        include <fp.h>
2331 #    endif
2332 #    if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
2333 #        define Perl_fp_class(x)        fpclassl(x)
2334 #    else
2335 #        define Perl_fp_class(x)        fpclass(x)
2336 #    endif
2337 #    if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
2338 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_CLASS_SNAN)
2339 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_CLASS_QNAN)
2340 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_CLASS_NINF)
2341 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_CLASS_PINF)
2342 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_CLASS_NNORM)
2343 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_CLASS_PNORM)
2344 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_CLASS_NDENORM)
2345 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_CLASS_PDENORM)
2346 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_CLASS_NZERO)
2347 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_CLASS_PZERO)
2348 #    elif defined(FP_PINF) && defined(FP_QNAN)
2349 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
2350 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
2351 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_NINF)
2352 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PINF)
2353 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_NNORM)
2354 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PNORM)
2355 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_NDENORM)
2356 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PDENORM)
2357 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_NZERO)
2358 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PZERO)
2359 #    else
2360 #        undef Perl_fp_class /* Unknown set of defines */
2361 #    endif
2362 #endif
2363
2364 /* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2365 #if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
2366 #    include <math.h>
2367 #    if !defined(FP_SNAN) && defined(I_FP_CLASS)
2368 #        include <fp_class.h>
2369 #    endif
2370 #    if defined(FP_POS_INF) && defined(FP_QNAN)
2371 #        ifdef __sgi /* XXX Configure test instead */
2372 #            ifdef USE_LONG_DOUBLE
2373 #                define Perl_fp_class(x)        fp_class_l(x)
2374 #            else
2375 #                define Perl_fp_class(x)        fp_class_d(x)
2376 #            endif
2377 #        else
2378 #            if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2379 #                define Perl_fp_class(x)        fp_classl(x)
2380 #            else
2381 #                define Perl_fp_class(x)        fp_class(x)
2382 #            endif
2383 #        endif
2384 #        if defined(FP_POS_INF) && defined(FP_QNAN)
2385 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_SNAN)
2386 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_QNAN)
2387 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_NEG_INF)
2388 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_POS_INF)
2389 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_NEG_NORM)
2390 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_POS_NORM)
2391 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_NEG_DENORM)
2392 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_POS_DENORM)
2393 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_NEG_ZERO)
2394 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_POS_ZERO)
2395 #        else
2396 #            undef Perl_fp_class /* Unknown set of defines */
2397 #        endif
2398 #    endif
2399 #endif
2400
2401 /* class(), _class(): Legacy: AIX. */
2402 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2403 #    include <math.h>
2404 #    if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2405 #        ifndef _cplusplus
2406 #            define Perl_fp_class(x)    class(x)
2407 #        else
2408 #            define Perl_fp_class(x)    _class(x)
2409 #        endif
2410 #        if defined(FP_PLUS_INF) && defined(FP_NANQ)
2411 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_NANS)
2412 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_NANQ)
2413 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_MINUS_INF)
2414 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_PLUS_INF)
2415 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_MINUS_NORM)
2416 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_PLUS_NORM)
2417 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_MINUS_DENORM)
2418 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_PLUS_DENORM)
2419 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_MINUS_ZERO)
2420 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_PLUS_ZERO)
2421 #        else
2422 #            undef Perl_fp_class /* Unknown set of defines */
2423 #        endif
2424 #    endif
2425 #endif
2426
2427 /* Win32: _fpclass(), _isnan(), _finite(). */
2428 #ifdef _MSC_VER
2429 #  ifndef Perl_isnan
2430 #    define Perl_isnan(x) _isnan(x)
2431 #  endif
2432 #  ifndef Perl_isfinite
2433 #    define Perl_isfinite(x) _finite(x)
2434 #  endif
2435 #  ifndef Perl_fp_class_snan
2436 /* No simple way to #define Perl_fp_class because _fpclass()
2437  * returns a set of bits. */
2438 #    define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2439 #    define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
2440 #    define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
2441 #    define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF))
2442 #    define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF))
2443 #    define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2444 #    define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2445 #    define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2446 #    define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2447 #    define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2448 #    define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2449 #    define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2450 #    define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2451 #    define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2452 #    define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2453 #  endif
2454 #endif
2455
2456 #if !defined(Perl_fp_class_inf) && \
2457   defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2458 #  define Perl_fp_class_inf(x) \
2459     (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2460 #endif
2461
2462 #if !defined(Perl_fp_class_nan) && \
2463   defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2464 #  define Perl_fp_class_nan(x) \
2465     (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2466 #endif
2467
2468 #if !defined(Perl_fp_class_zero) && \
2469   defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2470 #  define Perl_fp_class_zero(x) \
2471     (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2472 #endif
2473
2474 #if !defined(Perl_fp_class_norm) && \
2475   defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2476 #  define Perl_fp_class_norm(x) \
2477     (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2478 #endif
2479
2480 #if !defined(Perl_fp_class_denorm) && \
2481   defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2482 #  define Perl_fp_class_denorm(x) \
2483     (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
2484 #endif
2485
2486 #ifndef Perl_isnan
2487 #   ifdef Perl_fp_class_nan
2488 #       define Perl_isnan(x) Perl_fp_class_nan(x)
2489 #   elif defined(HAS_UNORDERED)
2490 #       define Perl_isnan(x) unordered((x), 0.0)
2491 #   else
2492 #       define Perl_isnan(x) ((x)!=(x))
2493 #   endif
2494 #endif
2495
2496 #ifndef Perl_isinf
2497 #   ifdef Perl_fp_class_inf
2498 #       define Perl_isinf(x) Perl_fp_class_inf(x)
2499 #   endif
2500 #endif
2501
2502 #ifndef Perl_isfinite
2503 #   if defined(HAS_ISFINITE) && !defined(isfinite)
2504 #     define Perl_isfinite(x) isfinite((double)(x))
2505 #   elif defined(HAS_FINITE)
2506 #       define Perl_isfinite(x) finite((double)(x))
2507 #   elif defined(Perl_fp_class_finite)
2508 #     define Perl_isfinite(x) Perl_fp_class_finite(x)
2509 #   else
2510 /* For the infinities the multiplication returns nan,
2511  * for the nan the multiplication also returns nan,
2512  * for everything else (that is, finite) zero should be returned. */
2513 #     define Perl_isfinite(x) (((x) * 0) == 0)
2514 #   endif
2515 #endif
2516
2517 #ifndef Perl_isinf
2518 #   if defined(Perl_isfinite) && defined(Perl_isnan)
2519 #       define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2520 #   endif
2521 #endif
2522
2523 /* We need Perl_isfinitel (ends with ell) (if available) even when
2524  * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2525  * needs that. */
2526 #if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2527 /* If isfinite() is a macro and looks like we have C99,
2528  * we assume it's the type-aware C99 isfinite(). */
2529 #    if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
2530 #        define Perl_isfinitel(x) isfinite(x)
2531 #    elif defined(HAS_ISFINITEL)
2532 #        define Perl_isfinitel(x) isfinitel(x)
2533 #    elif defined(HAS_FINITEL)
2534 #        define Perl_isfinitel(x) finitel(x)
2535 #    elif defined(HAS_INFL) && defined(HAS_NANL)
2536 #        define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
2537 #    else
2538 #        define Perl_isfinitel(x) ((x) * 0 == 0)  /* See Perl_isfinite. */
2539 #    endif
2540 #endif
2541
2542 /* The default is to use Perl's own atof() implementation (in numeric.c).
2543  * Usually that is the one to use but for some platforms (e.g. UNICOS)
2544  * it is however best to use the native implementation of atof.
2545  * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2546  * Some good tests to try out with either setting are t/base/num.t,
2547  * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2548  * you may need to be using a different function than atof! */
2549
2550 #ifndef USE_PERL_ATOF
2551 #   ifndef _UNICOS
2552 #       define USE_PERL_ATOF
2553 #   endif
2554 #else
2555 #   if USE_PERL_ATOF == 0
2556 #       undef USE_PERL_ATOF
2557 #   endif
2558 #endif
2559
2560 #ifdef USE_PERL_ATOF
2561 #   define Perl_atof(s) Perl_my_atof(s)
2562 #   define Perl_atof2(s, n) Perl_my_atof3(aTHX_ (s), &(n), 0)
2563 #else
2564 #   define Perl_atof(s) (NV)atof(s)
2565 #   define Perl_atof2(s, n) ((n) = atof(s))
2566 #endif
2567 #define my_atof2(a,b) my_atof3(a,b,0)
2568
2569 /*
2570  * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2571  * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2572  * depending on local options. Until Configure detects this (or at least
2573  * detects whether the "signed" keyword is available) the CHAR ranges
2574  * will not be included. UCHAR functions normally.
2575  *                                                           - kja
2576  */
2577
2578 #define PERL_UCHAR_MIN ((unsigned char)0)
2579 #define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2580
2581 #define PERL_USHORT_MIN ((unsigned short)0)
2582 #define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2583
2584 #define PERL_SHORT_MAX ((short)SHRT_MAX)
2585 #define PERL_SHORT_MIN ((short)SHRT_MIN)
2586
2587 #define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2588 #define PERL_UINT_MIN ((unsigned int)0)
2589
2590 #define PERL_INT_MAX ((int)INT_MAX)
2591 #define PERL_INT_MIN ((int)INT_MIN)
2592
2593 #define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2594 #define PERL_ULONG_MIN ((unsigned long)0L)
2595
2596 #define PERL_LONG_MAX ((long)LONG_MAX)
2597 #define PERL_LONG_MIN ((long)LONG_MIN)
2598
2599 #ifdef UV_IS_QUAD
2600 #    define PERL_UQUAD_MAX      (~(UV)0)
2601 #    define PERL_UQUAD_MIN      ((UV)0)
2602 #    define PERL_QUAD_MAX       ((IV) (PERL_UQUAD_MAX >> 1))
2603 #    define PERL_QUAD_MIN       (-PERL_QUAD_MAX - ((3 & -1) == 3))
2604 #endif
2605
2606 /*
2607 =head1 Numeric functions
2608
2609 =for apidoc AmnUh||PERL_INT_MIN
2610 =for apidoc AmnUh||PERL_LONG_MAX
2611 =for apidoc AmnUh||PERL_LONG_MIN
2612 =for apidoc AmnUh||PERL_QUAD_MAX
2613 =for apidoc AmnUh||PERL_SHORT_MAX
2614 =for apidoc AmnUh||PERL_SHORT_MIN
2615 =for apidoc AmnUh||PERL_UCHAR_MAX
2616 =for apidoc AmnUh||PERL_UCHAR_MIN
2617 =for apidoc AmnUh||PERL_UINT_MAX
2618 =for apidoc AmnUh||PERL_ULONG_MAX
2619 =for apidoc AmnUh||PERL_ULONG_MIN
2620 =for apidoc AmnUh||PERL_UQUAD_MAX
2621 =for apidoc AmnUh||PERL_UQUAD_MIN
2622 =for apidoc AmnUh||PERL_USHORT_MAX
2623 =for apidoc AmnUh||PERL_USHORT_MIN
2624 =for apidoc AmnUh||PERL_QUAD_MIN
2625 =for apidoc AmnU||PERL_INT_MAX
2626 This and
2627 C<PERL_INT_MIN>,
2628 C<PERL_LONG_MAX>,
2629 C<PERL_LONG_MIN>,
2630 C<PERL_QUAD_MAX>,
2631 C<PERL_SHORT_MAX>,
2632 C<PERL_SHORT_MIN>,
2633 C<PERL_UCHAR_MAX>,
2634 C<PERL_UCHAR_MIN>,
2635 C<PERL_UINT_MAX>,
2636 C<PERL_ULONG_MAX>,
2637 C<PERL_ULONG_MIN>,
2638 C<PERL_UQUAD_MAX>,
2639 C<PERL_UQUAD_MIN>,
2640 C<PERL_USHORT_MAX>,
2641 C<PERL_USHORT_MIN>,
2642 C<PERL_QUAD_MIN>
2643 give the largest and smallest number representable in the current
2644 platform in variables of the corresponding types.
2645
2646 For signed types, the smallest representable number is the most negative
2647 number, the one furthest away from zero.
2648
2649 For C99 and later compilers, these correspond to things like C<INT_MAX>, which
2650 are available to the C code.  But these constants, furnished by Perl,
2651 allow code compiled on earlier compilers to portably have access to the same
2652 constants.
2653
2654 =cut
2655
2656 */
2657
2658 typedef MEM_SIZE STRLEN;
2659
2660 typedef struct op OP;
2661 typedef struct cop COP;
2662 typedef struct unop UNOP;
2663 typedef struct unop_aux UNOP_AUX;
2664 typedef struct binop BINOP;
2665 typedef struct listop LISTOP;
2666 typedef struct logop LOGOP;
2667 typedef struct pmop PMOP;
2668 typedef struct svop SVOP;
2669 typedef struct padop PADOP;
2670 typedef struct pvop PVOP;
2671 typedef struct loop LOOP;
2672 typedef struct methop METHOP;
2673
2674 #ifdef PERL_CORE
2675 typedef struct opslab OPSLAB;
2676 typedef struct opslot OPSLOT;
2677 #endif
2678
2679 typedef struct block_hooks BHK;
2680 typedef struct custom_op XOP;
2681
2682 typedef struct interpreter PerlInterpreter;
2683
2684 /* SGI's <sys/sema.h> has struct sv */
2685 #if defined(__sgi)
2686 #   define STRUCT_SV perl_sv
2687 #else
2688 #   define STRUCT_SV sv
2689 #endif
2690 typedef struct STRUCT_SV SV;
2691 typedef struct av AV;
2692 typedef struct hv HV;
2693 typedef struct cv CV;
2694 typedef struct p5rx REGEXP;
2695 typedef struct gp GP;
2696 typedef struct gv GV;
2697 typedef struct io IO;
2698 typedef struct context PERL_CONTEXT;
2699 typedef struct block BLOCK;
2700
2701 typedef struct magic MAGIC;
2702 typedef struct xpv XPV;
2703 typedef struct xpviv XPVIV;
2704 typedef struct xpvuv XPVUV;
2705 typedef struct xpvnv XPVNV;
2706 typedef struct xpvmg XPVMG;
2707 typedef struct xpvlv XPVLV;
2708 typedef struct xpvinvlist XINVLIST;
2709 typedef struct xpvav XPVAV;
2710 typedef struct xpvhv XPVHV;
2711 typedef struct xpvgv XPVGV;
2712 typedef struct xpvcv XPVCV;
2713 typedef struct xpvbm XPVBM;
2714 typedef struct xpvfm XPVFM;
2715 typedef struct xpvio XPVIO;
2716 typedef struct mgvtbl MGVTBL;
2717 typedef union any ANY;
2718 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2719 typedef struct ptr_tbl PTR_TBL_t;
2720 typedef struct clone_params CLONE_PARAMS;
2721
2722 /* a pad is currently just an AV; but that might change,
2723  * so hide the type.  */
2724 typedef struct padlist PADLIST;
2725 typedef AV PAD;
2726 typedef struct padnamelist PADNAMELIST;
2727 typedef struct padname PADNAME;
2728
2729 /* always enable PERL_OP_PARENT  */
2730 #if !defined(PERL_OP_PARENT)
2731 #  define PERL_OP_PARENT
2732 #endif
2733
2734 /* enable PERL_COPY_ON_WRITE by default */
2735 #if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2736 #  define PERL_COPY_ON_WRITE
2737 #endif
2738
2739 #ifdef PERL_COPY_ON_WRITE
2740 #  define PERL_ANY_COW
2741 #else
2742 # define PERL_SAWAMPERSAND
2743 #endif
2744
2745 #if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2746 # error PERL_DEBUG_READONLY_OPS only works with ithreads
2747 #endif
2748
2749 #include "handy.h"
2750 #include "charclass_invlists.h"
2751
2752 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2753 #   if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2754 #       define USE_64_BIT_RAWIO /* implicit */
2755 #   endif
2756 #endif
2757
2758 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2759  * fseeko/ftello if possible.  Don't go #defining ftell to ftello yourself,
2760  * however, because operating systems like to do that themself. */
2761 #ifndef FSEEKSIZE
2762 #   ifdef HAS_FSEEKO
2763 #       define FSEEKSIZE LSEEKSIZE
2764 #   else
2765 #       define FSEEKSIZE LONGSIZE
2766 #   endif
2767 #endif
2768
2769 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2770 #   if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2771 #       define USE_64_BIT_STDIO /* implicit */
2772 #   endif
2773 #endif
2774
2775 #ifdef USE_64_BIT_RAWIO
2776 #   ifdef HAS_OFF64_T
2777 #       undef Off_t
2778 #       define Off_t off64_t
2779 #       undef LSEEKSIZE
2780 #       define LSEEKSIZE 8
2781 #   endif
2782 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2783  * will trigger defines like the ones below.  Some 64-bit environments,
2784  * however, do not.  Therefore we have to explicitly mix and match. */
2785 #   if defined(USE_OPEN64)
2786 #       define open open64
2787 #   endif
2788 #   if defined(USE_LSEEK64)
2789 #       define lseek lseek64
2790 #   else
2791 #       if defined(USE_LLSEEK)
2792 #           define lseek llseek
2793 #       endif
2794 #   endif
2795 #   if defined(USE_STAT64)
2796 #       define stat stat64
2797 #   endif
2798 #   if defined(USE_FSTAT64)
2799 #       define fstat fstat64
2800 #   endif
2801 #   if defined(USE_LSTAT64)
2802 #       define lstat lstat64
2803 #   endif
2804 #   if defined(USE_FLOCK64)
2805 #       define flock flock64
2806 #   endif
2807 #   if defined(USE_LOCKF64)
2808 #       define lockf lockf64
2809 #   endif
2810 #   if defined(USE_FCNTL64)
2811 #       define fcntl fcntl64
2812 #   endif
2813 #   if defined(USE_TRUNCATE64)
2814 #       define truncate truncate64
2815 #   endif
2816 #   if defined(USE_FTRUNCATE64)
2817 #       define ftruncate ftruncate64
2818 #   endif
2819 #endif
2820
2821 #ifdef USE_64_BIT_STDIO
2822 #   ifdef HAS_FPOS64_T
2823 #       undef Fpos_t
2824 #       define Fpos_t fpos64_t
2825 #   endif
2826 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2827  * will trigger defines like the ones below.  Some 64-bit environments,
2828  * however, do not. */
2829 #   if defined(USE_FOPEN64)
2830 #       define fopen fopen64
2831 #   endif
2832 #   if defined(USE_FSEEK64)
2833 #       define fseek fseek64 /* don't do fseeko here, see perlio.c */
2834 #   endif
2835 #   if defined(USE_FTELL64)
2836 #       define ftell ftell64 /* don't do ftello here, see perlio.c */
2837 #   endif
2838 #   if defined(USE_FSETPOS64)
2839 #       define fsetpos fsetpos64
2840 #   endif
2841 #   if defined(USE_FGETPOS64)
2842 #       define fgetpos fgetpos64
2843 #   endif
2844 #   if defined(USE_TMPFILE64)
2845 #       define tmpfile tmpfile64
2846 #   endif
2847 #   if defined(USE_FREOPEN64)
2848 #       define freopen freopen64
2849 #   endif
2850 #endif
2851
2852 #if defined(OS2)
2853 #  include "iperlsys.h"
2854 #endif
2855
2856 #ifdef DOSISH
2857 #   if defined(OS2)
2858 #       include "os2ish.h"
2859 #   else
2860 #       include "dosish.h"
2861 #   endif
2862 #elif defined(VMS)
2863 #   include "vmsish.h"
2864 #elif defined(PLAN9)
2865 #   include "./plan9/plan9ish.h"
2866 #elif defined(__VOS__)
2867 #   ifdef __GNUC__
2868 #     include "./vos/vosish.h"
2869 #   else
2870 #     include "vos/vosish.h"
2871 #   endif
2872 #elif defined(__SYMBIAN32__)
2873 #   include "symbian/symbianish.h"
2874 #elif defined(__HAIKU__)
2875 #   include "haiku/haikuish.h"
2876 #else
2877 #   include "unixish.h"
2878 #endif
2879
2880 #ifdef __amigaos4__
2881 #    include "amigaos.h"
2882 #    undef FD_CLOEXEC /* a lie in AmigaOS */
2883 #endif
2884
2885 /* NSIG logic from Configure --> */
2886 #ifndef NSIG
2887 #  ifdef _NSIG
2888 #    define NSIG (_NSIG)
2889 #  elif defined(SIGMAX)
2890 #    define NSIG (SIGMAX+1)
2891 #  elif defined(SIG_MAX)
2892 #    define NSIG (SIG_MAX+1)
2893 #  elif defined(_SIG_MAX)
2894 #    define NSIG (_SIG_MAX+1)
2895 #  elif defined(MAXSIG)
2896 #    define NSIG (MAXSIG+1)
2897 #  elif defined(MAX_SIG)
2898 #    define NSIG (MAX_SIG+1)
2899 #  elif defined(SIGARRAYSIZE)
2900 #    define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
2901 #  elif defined(_sys_nsig)
2902 #    define NSIG (_sys_nsig) /* Solaris 2.5 */
2903 #  else
2904      /* Default to some arbitrary number that's big enough to get most
2905       * of the common signals.  */
2906 #    define NSIG 50
2907 #  endif
2908 #endif
2909 /* <-- NSIG logic from Configure */
2910
2911 #ifndef NO_ENVIRON_ARRAY
2912 #  define USE_ENVIRON_ARRAY
2913 #endif
2914
2915 #ifdef USE_ITHREADS
2916    /* On some platforms it would be safe to use a read/write mutex with many
2917     * readers possible at the same time.  On other platforms, notably IBM ones,
2918     * subsequent getenv calls destroy earlier ones.  Those platforms would not
2919     * be able to handle simultaneous getenv calls */
2920 #  define ENV_LOCK            MUTEX_LOCK(&PL_env_mutex)
2921 #  define ENV_UNLOCK          MUTEX_UNLOCK(&PL_env_mutex)
2922 #  define ENV_INIT            MUTEX_INIT(&PL_env_mutex);
2923 #  define ENV_TERM            MUTEX_DESTROY(&PL_env_mutex);
2924 #else
2925 #  define ENV_LOCK       NOOP;
2926 #  define ENV_UNLOCK     NOOP;
2927 #  define ENV_INIT       NOOP;
2928 #  define ENV_TERM       NOOP;
2929 #endif
2930
2931 /* Some critical sections need to lock both the locale and the environment.
2932  * XXX khw intends to change this to lock both mutexes, but that brings up
2933  * issues of potential deadlock, so should be done at the beginning of a
2934  * development cycle.  So for now, it just locks the environment.  Note that
2935  * many modern platforms are locale-thread-safe anyway, so locking the locale
2936  * mutex is a no-op anyway */
2937 #define ENV_LOCALE_LOCK     ENV_LOCK
2938 #define ENV_LOCALE_UNLOCK   ENV_UNLOCK
2939
2940 /* And some critical sections care only that no one else is writing either the
2941  * locale nor the environment.  XXX Again this is for the future.  This can be
2942  * simulated with using COND_WAIT in thread.h */
2943 #define ENV_LOCALE_READ_LOCK     ENV_LOCALE_LOCK
2944 #define ENV_LOCALE_READ_UNLOCK   ENV_LOCALE_UNLOCK
2945
2946 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
2947     /* having sigaction(2) means that the OS supports both 1-arg and 3-arg
2948      * signal handlers. But the perl core itself only fully supports 1-arg
2949      * handlers, so don't enable for now.
2950      * NB: POSIX::sigaction() supports both.
2951      *
2952      * # define PERL_USE_3ARG_SIGHANDLER
2953      */
2954 #endif
2955
2956 /* Siginfo_t:
2957  * This is an alias for the OS's siginfo_t, except that where the OS
2958  * doesn't support it, declare a dummy version instead. This allows us to
2959  * have signal handler functions which always have a Siginfo_t parameter
2960  * regardless of platform, (and which will just be passed a NULL value
2961  * where the OS doesn't support HAS_SIGACTION).
2962  */
2963
2964 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
2965     typedef siginfo_t Siginfo_t;
2966 #else
2967 #ifdef si_signo /* minix */
2968 #undef si_signo
2969 #endif
2970     typedef struct {
2971         int si_signo;
2972     } Siginfo_t;
2973 #endif
2974
2975
2976 /*
2977  * initialise to avoid floating-point exceptions from overflow, etc
2978  */
2979 #ifndef PERL_FPU_INIT
2980 #  ifdef HAS_FPSETMASK
2981 #    if HAS_FLOATINGPOINT_H
2982 #      include <floatingpoint.h>
2983 #    endif
2984 /* Some operating systems have this as a macro, which in turn expands to a comma
2985    expression, and the last sub-expression is something that gets calculated,
2986    and then they have the gall to warn that a value computed is not used. Hence
2987    cast to void.  */
2988 #    define PERL_FPU_INIT (void)fpsetmask(0)
2989 #  elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2990 #    define PERL_FPU_INIT       PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2991 #    define PERL_FPU_PRE_EXEC   { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2992 #    define PERL_FPU_POST_EXEC    rsignal_restore(SIGFPE, &xfpe); }
2993 #  else
2994 #    define PERL_FPU_INIT
2995 #  endif
2996 #endif
2997 #ifndef PERL_FPU_PRE_EXEC
2998 #  define PERL_FPU_PRE_EXEC   {
2999 #  define PERL_FPU_POST_EXEC  }
3000 #endif
3001
3002 /* In Tru64 the cc -ieee enables the IEEE math but disables traps.
3003  * We need to reenable the "invalid" trap because otherwise generation
3004  * of NaN values leaves the IEEE fp flags in bad state, leaving any further
3005  * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
3006 #ifdef __osf__
3007 #  include <machine/fpu.h>
3008 #  define PERL_SYS_FPU_INIT \
3009      STMT_START { \
3010          ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
3011          signal(SIGFPE, SIG_IGN); \
3012      } STMT_END
3013 #endif
3014 /* In IRIX the default for Flush to Zero bit is true,
3015  * which means that results going below the minimum of normal
3016  * floating points go to zero, instead of going denormal/subnormal.
3017  * This is unlike almost any other system running Perl, so let's clear it.
3018  * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
3019  * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
3020  *
3021  * XXX The flush-to-zero behaviour should be a Configure scan.
3022  * To change the behaviour usually requires some system-specific
3023  * incantation, though, like the below. */
3024 #ifdef __sgi
3025 #  include <sys/fpu.h>
3026 #  define PERL_SYS_FPU_INIT \
3027      STMT_START { \
3028          union fpc_csr csr; \
3029          csr.fc_word = get_fpc_csr(); \
3030          csr.fc_struct.flush = 0; \
3031          set_fpc_csr(csr.fc_word); \
3032      } STMT_END
3033 #endif
3034
3035 #ifndef PERL_SYS_FPU_INIT
3036 #  define PERL_SYS_FPU_INIT NOOP
3037 #endif
3038
3039 #ifndef PERL_SYS_INIT3_BODY
3040 #  define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
3041 #endif
3042
3043 /*
3044 =head1 Miscellaneous Functions
3045
3046 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
3047 Provides system-specific tune up of the C runtime environment necessary to
3048 run Perl interpreters.  This should be called only once, before creating
3049 any Perl interpreters.
3050
3051 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
3052 Provides system-specific tune up of the C runtime environment necessary to
3053 run Perl interpreters.  This should be called only once, before creating
3054 any Perl interpreters.
3055
3056 =for apidoc Am|void|PERL_SYS_TERM|
3057 Provides system-specific clean up of the C runtime environment after
3058 running Perl interpreters.  This should be called only once, after
3059 freeing any remaining Perl interpreters.
3060
3061 =cut
3062  */
3063
3064 #define PERL_SYS_INIT(argc, argv)       Perl_sys_init(argc, argv)
3065 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
3066 #define PERL_SYS_TERM()                 Perl_sys_term()
3067
3068 #ifndef PERL_WRITE_MSG_TO_CONSOLE
3069 #  define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
3070 #endif
3071
3072 #ifndef MAXPATHLEN
3073 #  ifdef PATH_MAX
3074 #    ifdef _POSIX_PATH_MAX
3075 #       if PATH_MAX > _POSIX_PATH_MAX
3076 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
3077  * included the null byte or not.  Later amendments of POSIX,
3078  * XPG4, the Austin Group, and the Single UNIX Specification
3079  * all explicitly include the null byte in the PATH_MAX.
3080  * Ditto for _POSIX_PATH_MAX. */
3081 #         define MAXPATHLEN PATH_MAX
3082 #       else
3083 #         define MAXPATHLEN _POSIX_PATH_MAX
3084 #       endif
3085 #    else
3086 #      define MAXPATHLEN (PATH_MAX+1)
3087 #    endif
3088 #  else
3089 #    define MAXPATHLEN 1024     /* Err on the large side. */
3090 #  endif
3091 #endif
3092
3093 /* clang Thread Safety Analysis/Annotations/Attributes
3094  * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
3095  *
3096  * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
3097  * Apple XCode hijacks __clang_major__ and __clang_minor__
3098  * (6.1 means really clang 3.6), so needs extra hijinks
3099  * (could probably also test the contents of __apple_build_version__).
3100  */
3101 #if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
3102     defined(__clang__) && \
3103     !defined(PERL_GLOBAL_STRUCT) && \
3104     !defined(PERL_GLOBAL_STRUCT_PRIVATE) && \
3105     !defined(SWIG) && \
3106   ((!defined(__apple_build_version__) &&               \
3107     ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
3108      (__clang_major__ >= 4))) || \
3109    (defined(__apple_build_version__) &&                \
3110     ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
3111      (__clang_major__ >= 7))))
3112 #  define PERL_TSA__(x)   __attribute__((x))
3113 #  define PERL_TSA_ACTIVE
3114 #else
3115 #  define PERL_TSA__(x)   /* No TSA, make TSA attributes no-ops. */
3116 #  undef PERL_TSA_ACTIVE
3117 #endif
3118
3119 /* PERL_TSA_CAPABILITY() is used to annotate typedefs.
3120  * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
3121  */
3122 #define PERL_TSA_CAPABILITY(x) \
3123     PERL_TSA__(capability(x))
3124
3125 /* In the below examples the mutex must be lexically visible, usually
3126  * either as global variables, or as function arguments. */
3127
3128 /* PERL_TSA_GUARDED_BY() is used to annotate global variables.
3129  *
3130  * Foo foo PERL_TSA_GUARDED_BY(mutex);
3131  */
3132 #define PERL_TSA_GUARDED_BY(x) \
3133     PERL_TSA__(guarded_by(x))
3134
3135 /* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
3136  * The data _behind_ the pointer is guarded.
3137  *
3138  * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
3139  */
3140 #define PERL_TSA_PT_GUARDED_BY(x) \
3141     PERL_TSA__(pt_guarded_by(x))
3142
3143 /* PERL_TSA_REQUIRES() is used to annotate functions.
3144  * The caller MUST hold the resource when calling the function.
3145  *
3146  * void Foo() PERL_TSA_REQUIRES(mutex);
3147  */
3148 #define PERL_TSA_REQUIRES(x) \
3149     PERL_TSA__(requires_capability(x))
3150
3151 /* PERL_TSA_EXCLUDES() is used to annotate functions.
3152  * The caller MUST NOT hold resource when calling the function.
3153  *
3154  * EXCLUDES should be used when the function first acquires
3155  * the resource and then releases it.  Use to avoid deadlock.
3156  *
3157  * void Foo() PERL_TSA_EXCLUDES(mutex);
3158  */
3159 #define PERL_TSA_EXCLUDES(x) \
3160     PERL_TSA__(locks_excluded(x))
3161
3162 /* PERL_TSA_ACQUIRE() is used to annotate functions.
3163  * The caller MUST NOT hold the resource when calling the function,
3164  * and the function will acquire the resource.
3165  *
3166  * void Foo() PERL_TSA_ACQUIRE(mutex);
3167  */
3168 #define PERL_TSA_ACQUIRE(x) \
3169     PERL_TSA__(acquire_capability(x))
3170
3171 /* PERL_TSA_RELEASE() is used to annotate functions.
3172  * The caller MUST hold the resource when calling the function,
3173  * and the function will release the resource.
3174  *
3175  * void Foo() PERL_TSA_RELEASE(mutex);
3176  */
3177 #define PERL_TSA_RELEASE(x) \
3178     PERL_TSA__(release_capability(x))
3179
3180 /* PERL_TSA_NO_TSA is used to annotate functions.
3181  * Used when being intentionally unsafe, or when the code is too
3182  * complicated for the analysis.  Use sparingly.
3183  *
3184  * void Foo() PERL_TSA_NO_TSA;
3185  */
3186 #define PERL_TSA_NO_TSA \
3187     PERL_TSA__(no_thread_safety_analysis)
3188
3189 /* There are more annotations/attributes available, see the clang
3190  * documentation for details. */
3191
3192 #if defined(USE_ITHREADS)
3193 #  ifdef NETWARE
3194 #    include <nw5thread.h>
3195 #  elif defined(WIN32)
3196 #    include <win32thread.h>
3197 #  elif defined(OS2)
3198 #    include "os2thread.h"
3199 #  elif defined(I_MACH_CTHREADS)
3200 #    include <mach/cthreads.h>
3201 typedef cthread_t       perl_os_thread;
3202 typedef mutex_t         perl_mutex;
3203 typedef condition_t     perl_cond;
3204 typedef void *          perl_key;
3205 #  elif defined(I_PTHREAD) /* Posix threads */
3206 #    include <pthread.h>
3207 typedef pthread_t       perl_os_thread;
3208 typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
3209 typedef pthread_cond_t  perl_cond;
3210 typedef pthread_key_t   perl_key;
3211 #  endif
3212 #endif /* USE_ITHREADS */
3213
3214 #ifdef PERL_TSA_ACTIVE
3215 /* Since most pthread mutex interfaces have not been annotated, we
3216  * need to have these wrappers. The NO_TSA annotation is quite ugly
3217  * but it cannot be avoided in plain C, unlike in C++, where one could
3218  * e.g. use ACQUIRE() with no arg on a mutex lock method.
3219  *
3220  * The bodies of these wrappers are in util.c
3221  *
3222  * TODO: however, some platforms are starting to get these clang
3223  * thread safety annotations for pthreads, for example FreeBSD.
3224  * Do we need a way to a bypass these wrappers? */
3225 EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
3226   PERL_TSA_ACQUIRE(*mutex)
3227   PERL_TSA_NO_TSA;
3228 EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
3229   PERL_TSA_RELEASE(*mutex)
3230   PERL_TSA_NO_TSA;
3231 #endif
3232
3233 #if defined(WIN32)
3234 #  include "win32.h"
3235 #endif
3236
3237 #ifdef NETWARE
3238 #  include "netware.h"
3239 #endif
3240
3241 #define STATUS_UNIX     PL_statusvalue
3242 #ifdef VMS
3243 #   define STATUS_NATIVE        PL_statusvalue_vms
3244 /*
3245  * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
3246  * its contents can not be trusted.  Unfortunately, Perl seems to check
3247  * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
3248  * be updated also.
3249  */
3250 #  include <stsdef.h>
3251 #  include <ssdef.h>
3252 /* Presume this because if VMS changes it, it will require a new
3253  * set of APIs for waiting on children for binary compatibility.
3254  */
3255 #  define child_offset_bits (8)
3256 #  ifndef C_FAC_POSIX
3257 #  define C_FAC_POSIX 0x35A000
3258 #  endif
3259
3260 /*  STATUS_EXIT - validates and returns a NATIVE exit status code for the
3261  * platform from the existing UNIX or Native status values.
3262  */
3263
3264 #   define STATUS_EXIT \
3265         (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
3266            (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
3267
3268
3269 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
3270  * exit code and shifts the UNIX value over the correct number of bits to
3271  * be a child status.  Usually the number of bits is 8, but that could be
3272  * platform dependent.  The NATIVE status code is presumed to have either
3273  * from a child process.
3274  */
3275
3276 /* This is complicated.  The child processes return a true native VMS
3277    status which must be saved.  But there is an assumption in Perl that
3278    the UNIX child status has some relationship to errno values, so
3279    Perl tries to translate it to text in some of the tests.
3280    In order to get the string translation correct, for the error, errno
3281    must be EVMSERR, but that generates a different text message
3282    than what the test programs are expecting.  So an errno value must
3283    be derived from the native status value when an error occurs.
3284    That will hide the true native status message.  With this version of
3285    perl, the true native child status can always be retrieved so that
3286    is not a problem.  But in this case, Pl_statusvalue and errno may
3287    have different values in them.
3288  */
3289
3290 #   define STATUS_NATIVE_CHILD_SET(n) \
3291         STMT_START {                                                    \
3292             I32 evalue = (I32)n;                                        \
3293             if (evalue == EVMSERR) {                                    \
3294               PL_statusvalue_vms = vaxc$errno;                          \
3295               PL_statusvalue = evalue;                                  \
3296             } else {                                                    \
3297               PL_statusvalue_vms = evalue;                              \
3298               if (evalue == -1) {                                       \
3299                 PL_statusvalue = -1;                                    \
3300                 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3301               } else                                                    \
3302                 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1);    \
3303               set_vaxc_errno(evalue);                                   \
3304               if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX)    \
3305                   set_errno(EVMSERR);                                   \
3306               else set_errno(Perl_vms_status_to_unix(evalue, 0));       \
3307               PL_statusvalue = PL_statusvalue << child_offset_bits;     \
3308             }                                                           \
3309         } STMT_END
3310
3311 #   ifdef VMSISH_STATUS
3312 #       define STATUS_CURRENT   (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
3313 #   else
3314 #       define STATUS_CURRENT   STATUS_UNIX
3315 #   endif
3316
3317   /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3318    * the NATIVE status to an equivalent value.  Can not be used to translate
3319    * exit code values as exit code values are not guaranteed to have any
3320    * relationship at all to errno values.
3321    * This is used when Perl is forcing errno to have a specific value.
3322    */
3323 #   define STATUS_UNIX_SET(n)                           \
3324         STMT_START {                                    \
3325             I32 evalue = (I32)n;                        \
3326             PL_statusvalue = evalue;                    \
3327             if (PL_statusvalue != -1) {                 \
3328                 if (PL_statusvalue != EVMSERR) {        \
3329                   PL_statusvalue &= 0xFFFF;             \
3330                   if (MY_POSIX_EXIT)                    \
3331                     PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3332                   else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3333                 }                                       \
3334                 else {                                  \
3335                   PL_statusvalue_vms = vaxc$errno;      \
3336                 }                                       \
3337             }                                           \
3338             else PL_statusvalue_vms = SS$_ABORT;        \
3339             set_vaxc_errno(PL_statusvalue_vms);         \
3340         } STMT_END
3341
3342   /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
3343    * the NATIVE error status based on it.
3344    *
3345    * When in the default mode to comply with the Perl VMS documentation,
3346    * 0 is a success and any other code sets the NATIVE status to a failure
3347    * code of SS$_ABORT.
3348    *
3349    * In the new POSIX EXIT mode, native status will be set so that the
3350    * actual exit code will can be retrieved by the calling program or
3351    * shell.
3352    *
3353    * If the exit code is not clearly a UNIX parent or child exit status,
3354    * it will be passed through as a VMS status.
3355    */
3356
3357 #   define STATUS_UNIX_EXIT_SET(n)                      \
3358         STMT_START {                                    \
3359             I32 evalue = (I32)n;                        \
3360             PL_statusvalue = evalue;                    \
3361             if (MY_POSIX_EXIT) { \
3362               if (evalue <= 0xFF00) {           \
3363                   if (evalue > 0xFF)                    \
3364                     evalue = (evalue >> child_offset_bits) & 0xFF; \
3365                   PL_statusvalue_vms =          \
3366                     (C_FAC_POSIX | (evalue << 3 ) |     \
3367                     ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3368               } else /* forgive them Perl, for they have sinned */ \
3369                 PL_statusvalue_vms = evalue; \
3370             } else { \
3371               if (evalue == 0)                  \
3372                 PL_statusvalue_vms = SS$_NORMAL;        \
3373               else if (evalue <= 0xFF00) \
3374                 PL_statusvalue_vms = SS$_ABORT; \
3375               else { /* forgive them Perl, for they have sinned */ \
3376                   if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3377                   else PL_statusvalue_vms = vaxc$errno; \
3378                   /* And obviously used a VMS status value instead of UNIX */ \
3379                   PL_statusvalue = EVMSERR;             \
3380               } \
3381               set_vaxc_errno(PL_statusvalue_vms);       \
3382             }                                           \
3383         } STMT_END
3384
3385
3386   /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3387    * and sets the NATIVE error status based on it.  This special case
3388    * is needed to maintain compatibility with past VMS behavior.
3389    *
3390    * In the default mode on VMS, this number is passed through as
3391    * both the NATIVE and UNIX status.  Which makes it different
3392    * that the STATUS_UNIX_EXIT_SET.
3393    *
3394    * In the new POSIX EXIT mode, native status will be set so that the
3395    * actual exit code will can be retrieved by the calling program or
3396    * shell.
3397    *
3398    * A POSIX exit code is from 0 to 255.  If the exit code is higher
3399    * than this, it needs to be assumed that it is a VMS exit code and
3400    * passed through.
3401    */
3402
3403 #   define STATUS_EXIT_SET(n)                           \
3404         STMT_START {                                    \
3405             I32 evalue = (I32)n;                        \
3406             PL_statusvalue = evalue;                    \
3407             if (MY_POSIX_EXIT)                          \
3408                 if (evalue > 255) PL_statusvalue_vms = evalue; else {   \
3409                   PL_statusvalue_vms = \
3410                     (C_FAC_POSIX | (evalue << 3 ) |     \
3411                      ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
3412             else                                        \
3413                 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3414             set_vaxc_errno(PL_statusvalue_vms);         \
3415         } STMT_END
3416
3417
3418  /* This macro forces a success status */
3419 #   define STATUS_ALL_SUCCESS   \
3420         (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
3421
3422  /* This macro forces a failure status */
3423 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, \
3424      vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3425         (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3426
3427 #elif defined(__amigaos4__)
3428  /* A somewhat experimental attempt to simulate posix return code values */
3429 #   define STATUS_NATIVE        PL_statusvalue_posix
3430 #   define STATUS_NATIVE_CHILD_SET(n)                      \
3431         STMT_START {                                       \
3432             PL_statusvalue_posix = (n);                    \
3433             if (PL_statusvalue_posix < 0) {                \
3434                 PL_statusvalue = -1;                       \
3435             }                                              \
3436             else {                                         \
3437                 PL_statusvalue = n << 8;                   \
3438             }                                              \
3439         } STMT_END
3440 #   define STATUS_UNIX_SET(n)           \
3441         STMT_START {                    \
3442             PL_statusvalue = (n);               \
3443             if (PL_statusvalue != -1)   \
3444                 PL_statusvalue &= 0xFFFF;       \
3445         } STMT_END
3446 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3447 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3448 #   define STATUS_CURRENT STATUS_UNIX
3449 #   define STATUS_EXIT STATUS_UNIX
3450 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3451 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3452
3453 #else
3454 #   define STATUS_NATIVE        PL_statusvalue_posix
3455 #   if defined(WCOREDUMP)
3456 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3457             STMT_START {                                   \
3458                 PL_statusvalue_posix = (n);                \
3459                 if (PL_statusvalue_posix == -1)            \
3460                     PL_statusvalue = -1;                   \
3461                 else {                                     \
3462                     PL_statusvalue =                       \
3463                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3464                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3465                         (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0);  \
3466                 }                                          \
3467             } STMT_END
3468 #   elif defined(WIFEXITED)
3469 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3470             STMT_START {                                   \
3471                 PL_statusvalue_posix = (n);                \
3472                 if (PL_statusvalue_posix == -1)            \
3473                     PL_statusvalue = -1;                   \
3474                 else {                                     \
3475                     PL_statusvalue =                       \
3476                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3477                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0);  \
3478                 }                                          \
3479             } STMT_END
3480 #   else
3481 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3482             STMT_START {                                   \
3483                 PL_statusvalue_posix = (n);                \
3484                 if (PL_statusvalue_posix == -1)            \
3485                     PL_statusvalue = -1;                   \
3486                 else {                                     \
3487                     PL_statusvalue =                       \
3488                         PL_statusvalue_posix & 0xFFFF;     \
3489                 }                                          \
3490             } STMT_END
3491 #   endif
3492 #   define STATUS_UNIX_SET(n)           \
3493         STMT_START {                    \
3494             PL_statusvalue = (n);               \
3495             if (PL_statusvalue != -1)   \
3496                 PL_statusvalue &= 0xFFFF;       \
3497         } STMT_END
3498 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3499 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3500 #   define STATUS_CURRENT STATUS_UNIX
3501 #   define STATUS_EXIT STATUS_UNIX
3502 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3503 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3504 #endif
3505
3506 /* flags in PL_exit_flags for nature of exit() */
3507 #define PERL_EXIT_EXPECTED      0x01
3508 #define PERL_EXIT_DESTRUCT_END  0x02  /* Run END in perl_destruct */
3509 #define PERL_EXIT_WARN          0x04  /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3510 #define PERL_EXIT_ABORT         0x08  /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3511
3512 #ifndef PERL_CORE
3513 /* format to use for version numbers in file/directory names */
3514 /* XXX move to Configure? */
3515 /* This was only ever used for the current version, and that can be done at
3516    compile time, as PERL_FS_VERSION, so should we just delete it?  */
3517 #  ifndef PERL_FS_VER_FMT
3518 #    define PERL_FS_VER_FMT     "%d.%d.%d"
3519 #  endif
3520 #endif
3521
3522 #ifndef PERL_FS_VERSION
3523 #  define PERL_FS_VERSION       PERL_VERSION_STRING
3524 #endif
3525
3526 /* This defines a way to flush all output buffers.  This may be a
3527  * performance issue, so we allow people to disable it.  Also, if
3528  * we are using stdio, there are broken implementations of fflush(NULL)
3529  * out there, Solaris being the most prominent.
3530  */
3531 #ifndef PERL_FLUSHALL_FOR_CHILD
3532 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3533 #  define PERL_FLUSHALL_FOR_CHILD       PerlIO_flush((PerlIO*)NULL)
3534 # elif defined(FFLUSH_ALL)
3535 #  define PERL_FLUSHALL_FOR_CHILD       my_fflush_all()
3536 # else
3537 #  define PERL_FLUSHALL_FOR_CHILD       NOOP
3538 # endif
3539 #endif
3540
3541 #ifndef PERL_WAIT_FOR_CHILDREN
3542 #  define PERL_WAIT_FOR_CHILDREN        NOOP
3543 #endif
3544
3545 /* the traditional thread-unsafe notion of "current interpreter". */
3546 #ifndef PERL_SET_INTERP
3547 #  define PERL_SET_INTERP(i)            (PL_curinterp = (PerlInterpreter*)(i))
3548 #endif
3549
3550 #ifndef PERL_GET_INTERP
3551 #  define PERL_GET_INTERP               (PL_curinterp)
3552 #endif
3553
3554 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3555 #  ifdef MULTIPLICITY
3556 #    define PERL_GET_THX                ((PerlInterpreter *)PERL_GET_CONTEXT)
3557 #  endif
3558 #  define PERL_SET_THX(t)               PERL_SET_CONTEXT(t)
3559 #endif
3560
3561 /*
3562     This replaces the previous %_ "hack" by the "%p" hacks.
3563     All that is required is that the perl source does not
3564     use "%-p" or "%-<number>p" or "%<number>p" formats.
3565     These formats will still work in perl code.
3566     See comments in sv.c for further details.
3567
3568     Robin Barker 2005-07-14
3569
3570     No longer use %1p for VDf = %vd.  RMB 2007-10-19
3571 */
3572
3573 #ifndef SVf_
3574 #  define SVf_(n) "-" STRINGIFY(n) "p"
3575 #endif
3576
3577 #ifndef SVf
3578 #  define SVf "-p"
3579 #endif
3580
3581 #ifndef SVf32
3582 #  define SVf32 SVf_(32)
3583 #endif
3584
3585 #ifndef SVf256
3586 #  define SVf256 SVf_(256)
3587 #endif
3588
3589 #define SVfARG(p) ((void*)(p))
3590
3591 #ifndef HEKf
3592 #  define HEKf "2p"
3593 #endif
3594
3595 /* Not ideal, but we cannot easily include a number in an already-numeric
3596  * format sequence. */
3597 #ifndef HEKf256
3598 #  define HEKf256 "3p"
3599 #endif
3600
3601 #define HEKfARG(p) ((void*)(p))
3602
3603 /*
3604 =for apidoc Amnh||UTF8f
3605 =for apidoc Amh||UTF8fARG|bool is_utf8|Size_t byte_len|char *str
3606
3607 =cut
3608  * %4p is a custom format
3609  */
3610 #ifndef UTF8f
3611 #  define UTF8f "d%" UVuf "%4p"
3612 #endif
3613 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3614
3615 #define PNf UTF8f
3616 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
3617
3618 #ifdef PERL_CORE
3619 /* not used; but needed for backward compatibility with XS code? - RMB */
3620 #  undef UVf
3621 #elif !defined(UVf)
3622 #  define UVf UVuf
3623 #endif
3624
3625 #if !defined(DEBUGGING) && !defined(NDEBUG)
3626 #  define NDEBUG 1
3627 #endif
3628 #include <assert.h>
3629
3630 /* For functions that are marked as __attribute__noreturn__, it's not
3631    appropriate to call return.  In either case, include the lint directive.
3632  */
3633 #ifdef HASATTRIBUTE_NORETURN
3634 #  define NORETURN_FUNCTION_END NOT_REACHED;
3635 #else
3636 #  define NORETURN_FUNCTION_END NOT_REACHED; return 0
3637 #endif
3638
3639 #ifdef HAS_BUILTIN_EXPECT
3640 #  define EXPECT(expr,val)                  __builtin_expect(expr,val)
3641 #else
3642 #  define EXPECT(expr,val)                  (expr)
3643 #endif
3644
3645 /*
3646 =head1 Miscellaneous Functions
3647
3648 =for apidoc AmU|bool|LIKELY|const bool expr
3649
3650 Returns the input unchanged, but at the same time it gives a branch prediction
3651 hint to the compiler that this condition is likely to be true.
3652
3653 =for apidoc AmU|bool|UNLIKELY|const bool expr
3654
3655 Returns the input unchanged, but at the same time it gives a branch prediction
3656 hint to the compiler that this condition is likely to be false.
3657
3658 =cut
3659 */
3660 #define LIKELY(cond)                        EXPECT(cBOOL(cond),TRUE)
3661 #define UNLIKELY(cond)                      EXPECT(cBOOL(cond),FALSE)
3662
3663 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3664 /* placeholder */
3665 #endif
3666
3667 /* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
3668    time invariants. That is, their argument must be a constant expression that
3669    can be verified by the compiler. This expression can contain anything that's
3670    known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3671    the expression evaluates to 0, compilation fails.
3672    Because they generate no runtime code (i.e.  their use is "free"), they're
3673    always active, even under non-DEBUGGING builds.
3674    STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
3675    file scope (outside of any function).
3676    STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3677    function.
3678 */
3679 #if (! defined(__IBMC__) || __IBMC__ >= 1210)                               \
3680  && ((   defined(static_assert) && (   defined(_ISOC11_SOURCE)              \
3681                                     || (__STDC_VERSION__ - 0) >= 201101L))  \
3682      || (defined(__cplusplus) && __cplusplus >= 201103L))
3683 /* XXX static_assert is a macro defined in <assert.h> in C11 or a compiler
3684    builtin in C++11.  But IBM XL C V11 does not support _Static_assert, no
3685    matter what <assert.h> says.
3686 */
3687 #  define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
3688 #else
3689 /* We use a bit-field instead of an array because gcc accepts
3690    'typedef char x[n]' where n is not a compile-time constant.
3691    We want to enforce constantness.
3692 */
3693 #  define STATIC_ASSERT_2(COND, SUFFIX) \
3694     typedef struct { \
3695         unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3696     } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3697 #  define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
3698 #  define STATIC_ASSERT_DECL(COND)    STATIC_ASSERT_1(COND, __LINE__)
3699 #endif
3700 /* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3701    error (static_assert is a declaration, and only statements can have labels).
3702 */
3703 #define STATIC_ASSERT_STMT(COND)      STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
3704
3705 #ifndef __has_builtin
3706 #  define __has_builtin(x) 0 /* not a clang style compiler */
3707 #endif
3708
3709 /* ASSUME is like assert(), but it has a benefit in a release build. It is a
3710    hint to a compiler about a statement of fact in a function call free
3711    expression, which allows the compiler to generate better machine code.
3712    In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3713    the control path is unreachable. In a for loop, ASSUME can be used to hint
3714    that a loop will run at least X times. ASSUME is based off MSVC's __assume
3715    intrinsic function, see its documents for more details.
3716 */
3717
3718 #ifndef DEBUGGING
3719 #  if __has_builtin(__builtin_unreachable) \
3720      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4) /* 4.5 -> */
3721 #    define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3722 #  elif defined(_MSC_VER)
3723 #    define ASSUME(x) __assume(x)
3724 #  elif defined(__ARMCC_VERSION) /* untested */
3725 #    define ASSUME(x) __promise(x)
3726 #  else
3727 /* a random compiler might define assert to its own special optimization token
3728    so pass it through to C lib as a last resort */
3729 #    define ASSUME(x) assert(x)
3730 #  endif
3731 #else
3732 #  define ASSUME(x) assert(x)
3733 #endif
3734
3735 #if defined(__sun)      /* ASSUME() generates warnings on Solaris */
3736 #  define NOT_REACHED
3737 #elif defined(DEBUGGING) && (__has_builtin(__builtin_unreachable) \
3738      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4)) /* 4.5 -> */
3739 #  define NOT_REACHED STMT_START { ASSUME(!"UNREACHABLE"); __builtin_unreachable(); } STMT_END
3740 #else
3741 #  define NOT_REACHED ASSUME(!"UNREACHABLE")
3742 #endif
3743
3744 /* Some unistd.h's give a prototype for pause() even though
3745    HAS_PAUSE ends up undefined.  This causes the #define
3746    below to be rejected by the compiler.  Sigh.
3747 */
3748 #ifdef HAS_PAUSE
3749 #define Pause   pause
3750 #else
3751 #define Pause() sleep((32767<<16)+32767)
3752 #endif
3753
3754 #ifndef IOCPARM_LEN
3755 #   ifdef IOCPARM_MASK
3756         /* on BSDish systems we're safe */
3757 #       define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
3758 #   elif defined(_IOC_SIZE) && defined(__GLIBC__)
3759         /* on Linux systems we're safe; except when we're not [perl #38223] */
3760 #       define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3761 #   else
3762         /* otherwise guess at what's safe */
3763 #       define IOCPARM_LEN(x)   256
3764 #   endif
3765 #endif
3766
3767 #if defined(__CYGWIN__)
3768 /* USEMYBINMODE
3769  *   This symbol, if defined, indicates that the program should
3770  *   use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3771  *   that a file is in "binary" mode -- that is, that no translation
3772  *   of bytes occurs on read or write operations.
3773  */
3774 #  define USEMYBINMODE /**/
3775 #  include <io.h> /* for setmode() prototype */
3776 #  define my_binmode(fp, iotype, mode) \
3777             cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
3778 #endif
3779
3780 #ifdef __CYGWIN__
3781 void init_os_extras(void);
3782 #endif
3783
3784 #ifdef UNION_ANY_DEFINITION
3785 UNION_ANY_DEFINITION;
3786 #else
3787 union any {
3788     void*       any_ptr;
3789     SV*         any_sv;
3790     SV**        any_svp;
3791     GV*         any_gv;
3792     AV*         any_av;
3793     HV*         any_hv;
3794     OP*         any_op;
3795     char*       any_pv;
3796     char**      any_pvp;
3797     I32         any_i32;
3798     U32         any_u32;
3799     IV          any_iv;
3800     UV          any_uv;
3801     long        any_long;
3802     bool        any_bool;
3803     void        (*any_dptr) (void*);
3804     void        (*any_dxptr) (pTHX_ void*);
3805 };
3806 #endif
3807
3808 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3809
3810 #define FILTER_READ(idx, sv, len)  filter_read(idx, sv, len)
3811 #define FILTER_DATA(idx) \
3812             (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3813 #define FILTER_ISREADER(idx) \
3814             (PL_parser && PL_parser->rsfp_filters \
3815                 && idx >= AvFILLp(PL_parser->rsfp_filters))
3816 #define PERL_FILTER_EXISTS(i) \
3817             (PL_parser && PL_parser->rsfp_filters \
3818                 && (i) <= av_tindex(PL_parser->rsfp_filters))
3819
3820 #if defined(_AIX) && !defined(_AIX43)
3821 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3822 /* We cannot include <crypt.h> to get the struct crypt_data
3823  * because of setkey prototype problems when threading */
3824 typedef        struct crypt_data {     /* straight from /usr/include/crypt.h */
3825     /* From OSF, Not needed in AIX
3826        char C[28], D[28];
3827     */
3828     char E[48];
3829     char KS[16][48];
3830     char block[66];
3831     char iobuf[16];
3832 } CRYPTD;
3833 #endif /* threading */
3834 #endif /* AIX */
3835
3836 #ifndef PERL_CALLCONV
3837 #  ifdef __cplusplus
3838 #    define PERL_CALLCONV extern "C"
3839 #  else
3840 #    define PERL_CALLCONV
3841 #  endif
3842 #endif
3843 #ifndef PERL_CALLCONV_NO_RET
3844 #    define PERL_CALLCONV_NO_RET PERL_CALLCONV
3845 #endif
3846
3847 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
3848    dont have a noreturn as a declaration specifier
3849 */
3850 #ifndef PERL_STATIC_NO_RET
3851 #  define PERL_STATIC_NO_RET STATIC
3852 #endif
3853 /* PERL_STATIC_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE on
3854    builds that dont have a noreturn as a declaration specifier
3855 */
3856 #ifndef PERL_STATIC_INLINE_NO_RET
3857 #  define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
3858 #endif
3859
3860 #ifndef PERL_STATIC_FORCE_INLINE
3861 #  define PERL_STATIC_FORCE_INLINE PERL_STATIC_INLINE
3862 #endif
3863
3864 #ifndef PERL_STATIC_FORCE_INLINE_NO_RET
3865 #  define PERL_STATIC_FORCE_INLINE_NO_RET PERL_STATIC_INLINE
3866 #endif
3867
3868 #if !defined(OS2)
3869 #  include "iperlsys.h"
3870 #endif
3871
3872 #ifdef __LIBCATAMOUNT__
3873 #undef HAS_PASSWD  /* unixish.h but not unixish enough. */
3874 #undef HAS_GROUP
3875 #define FAKE_BIT_BUCKET
3876 #endif
3877
3878 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3879  * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
3880  * Configure, despite their names being similar to other defines like
3881  * USE_ITHREADS.  Configure in fact knows nothing about the randomised
3882  * hashes.  Therefore to enable/disable the hash randomisation defines
3883  * use the Configure -Accflags=... instead. */
3884 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
3885 #  define USE_HASH_SEED
3886 #endif
3887
3888 #include "perly.h"
3889
3890
3891 /* macros to define bit-fields in structs. */
3892 #ifndef PERL_BITFIELD8
3893 #  define PERL_BITFIELD8 U8
3894 #endif
3895 #ifndef PERL_BITFIELD16
3896 #  define PERL_BITFIELD16 U16
3897 #endif
3898 #ifndef PERL_BITFIELD32
3899 #  define PERL_BITFIELD32 U32
3900 #endif
3901
3902 #include "sv.h"
3903 #include "regexp.h"
3904 #include "util.h"
3905 #include "form.h"
3906 #include "gv.h"
3907 #include "pad.h"
3908 #include "cv.h"
3909 #include "opnames.h"
3910 #include "op.h"
3911 #include "hv.h"
3912 #include "cop.h"
3913 #include "av.h"
3914 #include "mg.h"
3915 #include "scope.h"
3916 #include "warnings.h"
3917 #include "utf8.h"
3918
3919 /* these would be in doio.h if there was such a file */
3920 #define my_stat()  my_stat_flags(SV_GMAGIC)
3921 #define my_lstat() my_lstat_flags(SV_GMAGIC)
3922
3923 /* defined in sv.c, but also used in [ach]v.c */
3924 #undef _XPV_HEAD
3925 #undef _XPVMG_HEAD
3926 #undef _XPVCV_COMMON
3927
3928 #include "parser.h"
3929
3930 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
3931
3932 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3933
3934 /* These have to be predeclared, as they are used in proto.h which is #included
3935  * before their definitions in regcomp.h. */
3936
3937 struct scan_data_t;
3938 typedef struct regnode_charclass regnode_charclass;
3939
3940 /* A hopefully less confusing name.  The sub-classes are all Posix classes only
3941  * used under /l matching */
3942 typedef struct regnode_charclass_posixl regnode_charclass_class;
3943 typedef struct regnode_charclass_posixl regnode_charclass_posixl;
3944
3945 typedef struct regnode_ssc regnode_ssc;
3946 typedef struct RExC_state_t RExC_state_t;
3947 struct _reg_trie_data;
3948
3949 #endif
3950
3951 struct ptr_tbl_ent {
3952     struct ptr_tbl_ent*         next;
3953     const void*                 oldval;
3954     void*                       newval;
3955 };
3956
3957 struct ptr_tbl {
3958     struct ptr_tbl_ent**        tbl_ary;
3959     UV                          tbl_max;
3960     UV                          tbl_items;
3961     struct ptr_tbl_arena        *tbl_arena;
3962     struct ptr_tbl_ent          *tbl_arena_next;
3963     struct ptr_tbl_ent          *tbl_arena_end;
3964 };
3965
3966 #if defined(htonl) && !defined(HAS_HTONL)
3967 #define HAS_HTONL
3968 #endif
3969 #if defined(htons) && !defined(HAS_HTONS)
3970 #define HAS_HTONS
3971 #endif
3972 #if defined(ntohl) && !defined(HAS_NTOHL)
3973 #define HAS_NTOHL
3974 #endif
3975 #if defined(ntohs) && !defined(HAS_NTOHS)
3976 #define HAS_NTOHS
3977 #endif
3978 #ifndef HAS_HTONL
3979 #define HAS_HTONS
3980 #define HAS_HTONL
3981 #define HAS_NTOHS
3982 #define HAS_NTOHL
3983 #  if (BYTEORDER & 0xffff) == 0x4321
3984 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
3985    re-order their values. However, to behave identically to the alternative
3986    implementations, they should truncate to the correct size.  */
3987 #    define ntohl(x)    ((x)&0xFFFFFFFF)
3988 #    define htonl(x)    ntohl(x)
3989 #    define ntohs(x)    ((x)&0xFFFF)
3990 #    define htons(x)    ntohs(x)
3991 #  elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3992
3993 /* Note that we can't straight out declare our own htonl and htons because
3994    the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
3995    to avoid the overhead of initialising the socket subsystem, but the headers
3996    that *declare* the various functions are still seen. If we declare our own
3997    htonl etc they will clash with the declarations in the Win32 headers.  */
3998
3999 PERL_STATIC_INLINE U32
4000 my_swap32(const U32 x) {
4001     return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)
4002         | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
4003 }
4004
4005 PERL_STATIC_INLINE U16
4006 my_swap16(const U16 x) {
4007     return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
4008 }
4009
4010 #    define htonl(x)    my_swap32(x)
4011 #    define ntohl(x)    my_swap32(x)
4012 #    define ntohs(x)    my_swap16(x)
4013 #    define htons(x)    my_swap16(x)
4014 #  else
4015 #    error "Unsupported byteorder"
4016 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
4017    the error message. Please check the value of the macro BYTEORDER, as defined
4018    in config.h. The values of BYTEORDER we expect are
4019
4020             big endian  little endian
4021    32 bit       0x4321  0x1234
4022    64 bit   0x87654321  0x12345678
4023
4024    If you have a system with a different byte order, please see
4025    pod/perlhack.pod for how to submit a patch to add supporting code.
4026 */
4027 #  endif
4028 #endif
4029
4030 /*
4031  * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
4032  * -DWS
4033  */
4034 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
4035 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
4036    re-order their values. However, to behave identically to the alternative
4037    implementations, they should truncate to the correct size.  */
4038 #  define vtohl(x)      ((x)&0xFFFFFFFF)
4039 #  define vtohs(x)      ((x)&0xFFFF)
4040 #  define htovl(x)      vtohl(x)
4041 #  define htovs(x)      vtohs(x)
4042 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
4043 #  define vtohl(x)      ((((x)&0xFF)<<24)       \
4044                         +(((x)>>24)&0xFF)       \
4045                         +(((x)&0x0000FF00)<<8)  \
4046                         +(((x)&0x00FF0000)>>8)  )
4047 #  define vtohs(x)      ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
4048 #  define htovl(x)      vtohl(x)
4049 #  define htovs(x)      vtohs(x)
4050 #else
4051 #  error "Unsupported byteorder"
4052 /* If you have need for current perl on PDP-11 or similar, and can help test
4053    that blead keeps working on a mixed-endian system, then see
4054    pod/perlhack.pod for how to submit patches to things working again.  */
4055 #endif
4056
4057 /* *MAX Plus 1. A floating point value.
4058    Hopefully expressed in a way that dodgy floating point can't mess up.
4059    >> 2 rather than 1, so that value is safely less than I32_MAX after 1
4060    is added to it
4061    May find that some broken compiler will want the value cast to I32.
4062    [after the shift, as signed >> may not be as secure as unsigned >>]
4063 */
4064 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
4065 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
4066 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
4067    0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
4068    may be greater than sizeof(IV), so don't assume that half max UV is max IV.
4069 */
4070 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
4071
4072 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
4073 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
4074 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
4075
4076 /* This may look like unnecessary jumping through hoops, but converting
4077    out of range floating point values to integers *is* undefined behaviour,
4078    and it is starting to bite.
4079 */
4080 #ifndef CAST_INLINE
4081 #define I_32(what) (cast_i32((NV)(what)))
4082 #define U_32(what) (cast_ulong((NV)(what)))
4083 #define I_V(what) (cast_iv((NV)(what)))
4084 #define U_V(what) (cast_uv((NV)(what)))
4085 #else
4086 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
4087                   : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
4088                      : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
4089 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
4090                   : ((n) < U32_MAX_P1 ? (U32) (n) \
4091                      : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
4092 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
4093                   : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
4094                      : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
4095 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
4096                   : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
4097                      : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
4098 #endif
4099
4100 #define U_S(what) ((U16)U_32(what))
4101 #define U_I(what) ((unsigned int)U_32(what))
4102 #define U_L(what) U_32(what)
4103
4104 #ifdef HAS_SIGNBIT
4105 #  ifndef Perl_signbit
4106 #    define Perl_signbit signbit
4107 #  endif
4108 #endif
4109
4110 /* These do not care about the fractional part, only about the range. */
4111 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
4112 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
4113
4114 /* Used with UV/IV arguments: */
4115                                         /* XXXX: need to speed it up */
4116 #define CLUMP_2UV(iv)   ((iv) < 0 ? 0 : (UV)(iv))
4117 #define CLUMP_2IV(uv)   ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
4118
4119 #ifndef MAXSYSFD
4120 #   define MAXSYSFD 2
4121 #endif
4122
4123 #ifndef __cplusplus
4124 #if !(defined(WIN32) || defined(SYMBIAN))
4125 Uid_t getuid (void);
4126 Uid_t geteuid (void);
4127 Gid_t getgid (void);
4128 Gid_t getegid (void);
4129 #endif
4130 #endif
4131
4132 #ifndef Perl_debug_log
4133 #  define Perl_debug_log        PerlIO_stderr()
4134 #endif
4135
4136 #ifndef Perl_error_log
4137 #  define Perl_error_log        (PL_stderrgv                    \
4138                                  && isGV(PL_stderrgv)           \
4139                                  && GvIOp(PL_stderrgv)          \
4140                                  && IoOFP(GvIOp(PL_stderrgv))   \
4141                                  ? IoOFP(GvIOp(PL_stderrgv))    \
4142                                  : PerlIO_stderr())
4143 #endif
4144
4145
4146 #define DEBUG_p_FLAG            0x00000001 /*      1 */
4147 #define DEBUG_s_FLAG            0x00000002 /*      2 */
4148 #define DEBUG_l_FLAG            0x00000004 /*      4 */
4149 #define DEBUG_t_FLAG            0x00000008 /*      8 */
4150 #define DEBUG_o_FLAG            0x00000010 /*     16 */
4151 #define DEBUG_c_FLAG            0x00000020 /*     32 */
4152 #define DEBUG_P_FLAG            0x00000040 /*     64 */
4153 #define DEBUG_m_FLAG            0x00000080 /*    128 */
4154 #define DEBUG_f_FLAG            0x00000100 /*    256 */
4155 #define DEBUG_r_FLAG            0x00000200 /*    512 */
4156 #define DEBUG_x_FLAG            0x00000400 /*   1024 */
4157 #define DEBUG_u_FLAG            0x00000800 /*   2048 */
4158 /* U is reserved for Unofficial, exploratory hacking */
4159 #define DEBUG_U_FLAG            0x00001000 /*   4096 */
4160 /* spare                                        8192 */
4161 #define DEBUG_X_FLAG            0x00004000 /*  16384 */
4162 #define DEBUG_D_FLAG            0x00008000 /*  32768 */
4163 #define DEBUG_S_FLAG            0x00010000 /*  65536 */
4164 #define DEBUG_T_FLAG            0x00020000 /* 131072 */
4165 #define DEBUG_R_FLAG            0x00040000 /* 262144 */
4166 #define DEBUG_J_FLAG            0x00080000 /* 524288 */
4167 #define DEBUG_v_FLAG            0x00100000 /*1048576 */
4168 #define DEBUG_C_FLAG            0x00200000 /*2097152 */
4169 #define DEBUG_A_FLAG            0x00400000 /*4194304 */
4170 #define DEBUG_q_FLAG            0x00800000 /*8388608 */
4171 #define DEBUG_M_FLAG            0x01000000 /*16777216*/
4172 #define DEBUG_B_FLAG            0x02000000 /*33554432*/
4173 #define DEBUG_L_FLAG            0x04000000 /*67108864*/
4174 #define DEBUG_i_FLAG            0x08000000 /*134217728*/
4175 #define DEBUG_y_FLAG            0x10000000 /*268435456*/
4176 #define DEBUG_MASK              0x1FFFEFFF /* mask of all the standard flags */
4177
4178 #define DEBUG_DB_RECURSE_FLAG   0x40000000
4179 #define DEBUG_TOP_FLAG          0x80000000 /* -D was given --> PL_debug |= FLAG */
4180
4181 #  define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
4182 #  define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
4183 #  define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
4184 #  define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
4185 #  define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
4186 #  define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
4187 #  define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
4188 #  define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
4189 #  define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
4190 #  define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
4191 #  define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
4192 #  define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
4193 #  define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
4194 #  define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
4195 #  define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
4196 #  define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
4197 #  define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
4198 #  define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
4199 #  define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
4200 #  define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
4201 #  define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
4202 #  define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
4203 #  define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
4204 #  define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
4205 #  define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
4206 #  define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
4207 #  define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
4208 #  define DEBUG_y_TEST_ UNLIKELY(PL_debug & DEBUG_y_FLAG)
4209 #  define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
4210 #  define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
4211 #  define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
4212 #  define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
4213 #  define DEBUG_yv_TEST_ (DEBUG_y_TEST_ && DEBUG_v_TEST_)
4214
4215 #ifdef DEBUGGING
4216
4217 #  define DEBUG_p_TEST DEBUG_p_TEST_
4218 #  define DEBUG_s_TEST DEBUG_s_TEST_
4219 #  define DEBUG_l_TEST DEBUG_l_TEST_
4220 #  define DEBUG_t_TEST DEBUG_t_TEST_
4221 #  define DEBUG_o_TEST DEBUG_o_TEST_
4222 #  define DEBUG_c_TEST DEBUG_c_TEST_
4223 #  define DEBUG_P_TEST DEBUG_P_TEST_
4224 #  define DEBUG_m_TEST DEBUG_m_TEST_
4225 #  define DEBUG_f_TEST DEBUG_f_TEST_
4226 #  define DEBUG_r_TEST DEBUG_r_TEST_
4227 #  define DEBUG_x_TEST DEBUG_x_TEST_
4228 #  define DEBUG_u_TEST DEBUG_u_TEST_
4229 #  define DEBUG_U_TEST DEBUG_U_TEST_
4230 #  define DEBUG_X_TEST DEBUG_X_TEST_
4231 #  define DEBUG_D_TEST DEBUG_D_TEST_
4232 #  define DEBUG_S_TEST DEBUG_S_TEST_
4233 #  define DEBUG_T_TEST DEBUG_T_TEST_
4234 #  define DEBUG_R_TEST DEBUG_R_TEST_
4235 #  define DEBUG_J_TEST DEBUG_J_TEST_
4236 #  define DEBUG_v_TEST DEBUG_v_TEST_
4237 #  define DEBUG_C_TEST DEBUG_C_TEST_
4238 #  define DEBUG_A_TEST DEBUG_A_TEST_
4239 #  define DEBUG_q_TEST DEBUG_q_TEST_
4240 #  define DEBUG_M_TEST DEBUG_M_TEST_
4241 #  define DEBUG_B_TEST DEBUG_B_TEST_
4242 #  define DEBUG_L_TEST DEBUG_L_TEST_
4243 #  define DEBUG_i_TEST DEBUG_i_TEST_
4244 #  define DEBUG_y_TEST DEBUG_y_TEST_
4245 #  define DEBUG_Xv_TEST DEBUG_Xv_TEST_
4246 #  define DEBUG_Uv_TEST DEBUG_Uv_TEST_
4247 #  define DEBUG_Pv_TEST DEBUG_Pv_TEST_
4248 #  define DEBUG_Lv_TEST DEBUG_Lv_TEST_
4249 #  define DEBUG_yv_TEST DEBUG_yv_TEST_
4250
4251 #  define PERL_DEB(a)                  a
4252 #  define PERL_DEB2(a,b)               a
4253 #  define PERL_DEBUG(a) if (PL_debug)  a
4254 #  define DEBUG_p(a) if (DEBUG_p_TEST) a
4255 #  define DEBUG_s(a) if (DEBUG_s_TEST) a
4256 #  define DEBUG_l(a) if (DEBUG_l_TEST) a
4257 #  define DEBUG_t(a) if (DEBUG_t_TEST) a
4258 #  define DEBUG_o(a) if (DEBUG_o_TEST) a
4259 #  define DEBUG_c(a) if (DEBUG_c_TEST) a
4260 #  define DEBUG_P(a) if (DEBUG_P_TEST) a
4261
4262      /* Temporarily turn off memory debugging in case the a
4263       * does memory allocation, either directly or indirectly. */
4264 #  define DEBUG_m(a)  \
4265     STMT_START {                                                        \
4266         if (PERL_GET_INTERP) {                                          \
4267                                 dTHX;                                   \
4268                                 if (DEBUG_m_TEST) {                     \
4269                                     PL_debug &= ~DEBUG_m_FLAG;          \
4270                                     a;                                  \
4271                                     PL_debug |= DEBUG_m_FLAG;           \
4272                                 }                                       \
4273                               }                                         \
4274     } STMT_END
4275
4276 #  define DEBUG__(t, a)                                                 \
4277         STMT_START {                                                    \
4278                 if (t) STMT_START {a;} STMT_END;                        \
4279         } STMT_END
4280
4281 #  define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
4282
4283 /* For re_comp.c, re_exec.c, assume -Dr has been specified */
4284 #  ifdef PERL_EXT_RE_BUILD
4285 #    define DEBUG_r(a) STMT_START {a;} STMT_END
4286 #  else
4287 #    define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
4288 #  endif /* PERL_EXT_RE_BUILD */
4289
4290 #  define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
4291 #  define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
4292 #  define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
4293 #  define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
4294 #  define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
4295 #  define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
4296 #  define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
4297 #  define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
4298 #  define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
4299 #  define DEBUG_yv(a) DEBUG__(DEBUG_yv_TEST, a)
4300
4301 #  define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
4302 #  define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
4303 #  define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
4304 #  define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
4305 #  define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
4306 #  define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
4307 #  define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
4308 #  define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
4309 #  define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
4310 #  define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
4311 #  define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
4312 #  define DEBUG_y(a) DEBUG__(DEBUG_y_TEST, a)
4313
4314 #else /* ! DEBUGGING below */
4315
4316 #  define DEBUG_p_TEST (0)
4317 #  define DEBUG_s_TEST (0)
4318 #  define DEBUG_l_TEST (0)
4319 #  define DEBUG_t_TEST (0)
4320 #  define DEBUG_o_TEST (0)
4321 #  define DEBUG_c_TEST (0)
4322 #  define DEBUG_P_TEST (0)
4323 #  define DEBUG_m_TEST (0)
4324 #  define DEBUG_f_TEST (0)
4325 #  define DEBUG_r_TEST (0)
4326 #  define DEBUG_x_TEST (0)
4327 #  define DEBUG_u_TEST (0)
4328 #  define DEBUG_U_TEST (0)
4329 #  define DEBUG_X_TEST (0)
4330 #  define DEBUG_D_TEST (0)
4331 #  define DEBUG_S_TEST (0)
4332 #  define DEBUG_T_TEST (0)
4333 #  define DEBUG_R_TEST (0)
4334 #  define DEBUG_J_TEST (0)
4335 #  define DEBUG_v_TEST (0)
4336 #  define DEBUG_C_TEST (0)
4337 #  define DEBUG_A_TEST (0)
4338 #  define DEBUG_q_TEST (0)
4339 #  define DEBUG_M_TEST (0)
4340 #  define DEBUG_B_TEST (0)
4341 #  define DEBUG_L_TEST (0)
4342 #  define DEBUG_i_TEST (0)
4343 #  define DEBUG_y_TEST (0)
4344 #  define DEBUG_Xv_TEST (0)
4345 #  define DEBUG_Uv_TEST (0)
4346 #  define DEBUG_Pv_TEST (0)
4347 #  define DEBUG_Lv_TEST (0)
4348 #  define DEBUG_yv_TEST (0)
4349
4350 #  define PERL_DEB(a)
4351 #  define PERL_DEB2(a,b)               b
4352 #  define PERL_DEBUG(a)
4353 #  define DEBUG_p(a)
4354 #  define DEBUG_s(a)
4355 #  define DEBUG_l(a)
4356 #  define DEBUG_t(a)
4357 #  define DEBUG_o(a)
4358 #  define DEBUG_c(a)
4359 #  define DEBUG_P(a)
4360 #  define DEBUG_m(a)
4361 #  define DEBUG_f(a)
4362 #  define DEBUG_r(a)
4363 #  define DEBUG_x(a)
4364 #  define DEBUG_u(a)
4365 #  define DEBUG_U(a)
4366 #  define DEBUG_X(a)
4367 #  define DEBUG_D(a)
4368 #  define DEBUG_S(a)
4369 #  define DEBUG_T(a)
4370 #  define DEBUG_R(a)
4371 #  define DEBUG_v(a)
4372 #  define DEBUG_C(a)
4373 #  define DEBUG_A(a)
4374 #  define DEBUG_q(a)
4375 #  define DEBUG_M(a)
4376 #  define DEBUG_B(a)
4377 #  define DEBUG_L(a)
4378 #  define DEBUG_i(a)
4379 #  define DEBUG_y(a)
4380 #  define DEBUG_Xv(a)
4381 #  define DEBUG_Uv(a)
4382 #  define DEBUG_Pv(a)
4383 #  define DEBUG_Lv(a)
4384 #  define DEBUG_yv(a)
4385 #endif /* DEBUGGING */
4386
4387
4388 #define DEBUG_SCOPE(where) \
4389     DEBUG_l( \
4390     Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n",   \
4391                     where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
4392                     __FILE__, __LINE__));
4393
4394 /* Keep the old croak based assert for those who want it, and as a fallback if
4395    the platform is so heretically non-ANSI that it can't assert.  */
4396
4397 #define Perl_assert(what)       PERL_DEB2(                              \
4398         ((what) ? ((void) 0) :                                          \
4399             (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
4400                         "\", line %d", STRINGIFY(what), __LINE__),      \
4401              (void) 0)), ((void)0))
4402
4403 /* assert() gets defined if DEBUGGING.
4404  * If no DEBUGGING, the <assert.h> has not been included. */
4405 #ifndef assert
4406 #  define assert(what)  Perl_assert(what)
4407 #endif
4408 #ifdef DEBUGGING
4409 #  define assert_(what) assert(what),
4410 #else
4411 #  define assert_(what)
4412 #endif
4413
4414 struct ufuncs {
4415     I32 (*uf_val)(pTHX_ IV, SV*);
4416     I32 (*uf_set)(pTHX_ IV, SV*);
4417     IV uf_index;
4418 };
4419
4420 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4421  * XS code wanting to be backward compatible can do something
4422  * like the following:
4423
4424 #ifndef PERL_MG_UFUNC
4425 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4426 #endif
4427
4428 static PERL_MG_UFUNC(foo_get, index, val)
4429 {
4430     sv_setsv(val, ...);
4431     return TRUE;
4432 }
4433
4434 -- Doug MacEachern
4435
4436 */
4437
4438 #ifndef PERL_MG_UFUNC
4439 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4440 #endif
4441
4442 #include <math.h>
4443 #ifdef __VMS
4444      /* isfinite and others are here rather than in math.h as C99 stipulates */
4445 #    include <fp.h>
4446 #endif
4447
4448 #ifndef __cplusplus
4449 #  if !defined(WIN32) && !defined(VMS)
4450 #ifndef crypt
4451 char *crypt (const char*, const char*);
4452 #endif
4453 #  endif /* !WIN32 */
4454 #  ifndef WIN32
4455 #    ifndef getlogin
4456 char *getlogin (void);
4457 #    endif
4458 #  endif /* !WIN32 */
4459 #endif /* !__cplusplus */
4460
4461 /* Fixme on VMS.  This needs to be a run-time, not build time options */
4462 /* Also rename() is affected by this */
4463 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4464 #define UNLINK unlnk
4465 I32 unlnk (pTHX_ const char*);
4466 #else
4467 #define UNLINK PerlLIO_unlink
4468 #endif
4469
4470 /* some versions of glibc are missing the setresuid() proto */
4471 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4472 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4473 #endif
4474 /* some versions of glibc are missing the setresgid() proto */
4475 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4476 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4477 #endif
4478
4479 #ifndef HAS_SETREUID
4480 #  ifdef HAS_SETRESUID
4481 #    define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4482 #    define HAS_SETREUID
4483 #  endif
4484 #endif
4485 #ifndef HAS_SETREGID
4486 #  ifdef HAS_SETRESGID
4487 #    define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4488 #    define HAS_SETREGID
4489 #  endif
4490 #endif
4491
4492 /* Sighandler_t defined in iperlsys.h */
4493
4494 #ifdef HAS_SIGACTION
4495 typedef struct sigaction Sigsave_t;
4496 #else
4497 typedef Sighandler_t Sigsave_t;
4498 #endif
4499
4500 #define SCAN_DEF 0
4501 #define SCAN_TR 1
4502 #define SCAN_REPL 2
4503
4504 #ifdef DEBUGGING
4505 # ifndef register
4506 #  define register
4507 # endif
4508 # define RUNOPS_DEFAULT Perl_runops_debug
4509 #else
4510 # define RUNOPS_DEFAULT Perl_runops_standard
4511 #endif
4512
4513 #if defined(USE_PERLIO)
4514 EXTERN_C void PerlIO_teardown(void);
4515 # ifdef USE_ITHREADS
4516 #  define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4517 #  define PERLIO_TERM                           \
4518         STMT_START {                            \
4519                 PerlIO_teardown();              \
4520                 MUTEX_DESTROY(&PL_perlio_mutex);\
4521         } STMT_END
4522 # else
4523 #  define PERLIO_INIT
4524 #  define PERLIO_TERM   PerlIO_teardown()
4525 # endif
4526 #else
4527 #  define PERLIO_INIT
4528 #  define PERLIO_TERM
4529 #endif
4530
4531 #ifdef MYMALLOC
4532 #  ifdef MUTEX_INIT_CALLS_MALLOC
4533 #    define MALLOC_INIT                                 \
4534         STMT_START {                                    \
4535                 PL_malloc_mutex = NULL;                 \
4536                 MUTEX_INIT(&PL_malloc_mutex);           \
4537         } STMT_END
4538 #    define MALLOC_TERM                                 \
4539         STMT_START {                                    \
4540                 perl_mutex tmp = PL_malloc_mutex;       \
4541                 PL_malloc_mutex = NULL;                 \
4542                 MUTEX_DESTROY(&tmp);                    \
4543         } STMT_END
4544 #  else
4545 #    define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4546 #    define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4547 #  endif
4548 #else
4549 #  define MALLOC_INIT
4550 #  define MALLOC_TERM
4551 #endif
4552
4553 #if defined(PERL_IMPLICIT_CONTEXT)
4554
4555 struct perl_memory_debug_header;
4556 struct perl_memory_debug_header {
4557   tTHX  interpreter;
4558 #  if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4559   MEM_SIZE size;
4560 #  endif
4561   struct perl_memory_debug_header *prev;
4562   struct perl_memory_debug_header *next;
4563 #  ifdef PERL_DEBUG_READONLY_COW
4564   bool readonly;
4565 #  endif
4566 };
4567
4568 #elif defined(PERL_DEBUG_READONLY_COW)
4569
4570 struct perl_memory_debug_header;
4571 struct perl_memory_debug_header {
4572   MEM_SIZE size;
4573 };
4574
4575 #endif
4576
4577 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4578
4579 #  define PERL_MEMORY_DEBUG_HEADER_SIZE \
4580         (sizeof(struct perl_memory_debug_header) + \
4581         (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4582          %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4583
4584 #else
4585 #  define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4586 #endif
4587
4588 #ifdef PERL_TRACK_MEMPOOL
4589 # ifdef PERL_DEBUG_READONLY_COW
4590 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4591         STMT_START {                                            \
4592                 (header).interpreter = (interp);                \
4593                 (header).prev = (header).next = &(header);      \
4594                 (header).readonly = 0;                          \
4595         } STMT_END
4596 # else
4597 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4598         STMT_START {                                            \
4599                 (header).interpreter = (interp);                \
4600                 (header).prev = (header).next = &(header);      \
4601         } STMT_END
4602 # endif
4603 # else
4604 #  define INIT_TRACK_MEMPOOL(header, interp)
4605 #endif
4606
4607 #ifdef I_MALLOCMALLOC
4608 /* Needed for malloc_size(), malloc_good_size() on some systems */
4609 #  include <malloc/malloc.h>
4610 #endif
4611
4612 #ifdef MYMALLOC
4613 #  define Perl_safesysmalloc_size(where)        Perl_malloced_size(where)
4614 #else
4615 #  if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4616 #    ifdef PERL_TRACK_MEMPOOL
4617 #       define Perl_safesysmalloc_size(where)                   \
4618             (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4619 #    else
4620 #       define Perl_safesysmalloc_size(where) malloc_size(where)
4621 #    endif
4622 #  endif
4623 #  ifdef HAS_MALLOC_GOOD_SIZE
4624 #    ifdef PERL_TRACK_MEMPOOL
4625 #       define Perl_malloc_good_size(how_much)                  \
4626             (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4627 #    else
4628 #       define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4629 #    endif
4630 #  else
4631 /* Having this as the identity operation makes some code simpler.  */
4632 #       define Perl_malloc_good_size(how_much)  (how_much)
4633 #  endif
4634 #endif
4635
4636 typedef int (*runops_proc_t)(pTHX);
4637 typedef void (*share_proc_t) (pTHX_ SV *sv);
4638 typedef int  (*thrhook_proc_t) (pTHX);
4639 typedef OP* (*PPADDR_t[]) (pTHX);
4640 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4641 typedef void (*despatch_signals_proc_t) (pTHX);
4642
4643 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4644 #  include <crt_externs.h>      /* for the env array */
4645 #  define environ (*_NSGetEnviron())
4646 #elif defined(USE_ENVIRON_ARRAY) && !defined(environ)
4647    /* VMS and some other platforms don't use the environ array */
4648 EXTERN_C char **environ;  /* environment variables supplied via exec */
4649 #endif
4650
4651 #define PERL_PATCHLEVEL_H_IMPLICIT
4652 #include "patchlevel.h"
4653 #undef PERL_PATCHLEVEL_H_IMPLICIT
4654
4655 #define PERL_VERSION_STRING     STRINGIFY(PERL_REVISION) "." \
4656                                 STRINGIFY(PERL_VERSION) "." \
4657                                 STRINGIFY(PERL_SUBVERSION)
4658
4659 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4660                                 STRINGIFY(PERL_API_VERSION) "." \
4661                                 STRINGIFY(PERL_API_SUBVERSION)
4662
4663 START_EXTERN_C
4664
4665 /* handy constants */
4666 EXTCONST char PL_warn_uninit[]
4667   INIT("Use of uninitialized value%s%s%s");
4668 EXTCONST char PL_warn_uninit_sv[]
4669   INIT("Use of uninitialized value%" SVf "%s%s");
4670 EXTCONST char PL_warn_nosemi[]
4671   INIT("Semicolon seems to be missing");
4672 EXTCONST char PL_warn_reserved[]
4673   INIT("Unquoted string \"%s\" may clash with future reserved word");
4674 EXTCONST char PL_warn_nl[]
4675   INIT("Unsuccessful %s on filename containing newline");
4676 EXTCONST char PL_no_wrongref[]
4677   INIT("Can't use %s ref as %s ref");
4678 /* The core no longer needs this here. If you require the string constant,
4679    please inline a copy into your own code.  */
4680 EXTCONST char PL_no_symref[] __attribute__deprecated__
4681   INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4682 EXTCONST char PL_no_symref_sv[]
4683   INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4684
4685 EXTCONST char PL_no_usym[]
4686   INIT("Can't use an undefined value as %s reference");
4687 EXTCONST char PL_no_aelem[]
4688   INIT("Modification of non-creatable array value attempted, subscript %d");
4689 EXTCONST char PL_no_helem_sv[]
4690   INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4691 EXTCONST char PL_no_modify[]
4692   INIT("Modification of a read-only value attempted");
4693 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4694   INIT("Out of memory!\n");
4695 EXTCONST char PL_no_security[]
4696   INIT("Insecure dependency in %s%s");
4697 EXTCONST char PL_no_sock_func[]
4698   INIT("Unsupported socket function \"%s\" called");
4699 EXTCONST char PL_no_dir_func[]
4700   INIT("Unsupported directory function \"%s\" called");
4701 EXTCONST char PL_no_func[]
4702   INIT("The %s function is unimplemented");
4703 EXTCONST char PL_no_myglob[]
4704   INIT("\"%s\" %s %s can't be in a package");
4705 EXTCONST char PL_no_localize_ref[]
4706   INIT("Can't localize through a reference");
4707 EXTCONST char PL_memory_wrap[]
4708   INIT("panic: memory wrap");
4709 EXTCONST char PL_extended_cp_format[]
4710   INIT("Code point 0x%" UVXf " is not Unicode, requires a Perl extension,"
4711                              " and so is not portable");
4712 EXTCONST char PL_Yes[]
4713   INIT("1");
4714 EXTCONST char PL_No[]
4715   INIT("");
4716 EXTCONST char PL_Zero[]
4717   INIT("0");
4718 EXTCONST char PL_hexdigit[]
4719   INIT("0123456789abcdef0123456789ABCDEF");
4720
4721 EXTCONST STRLEN PL_WARN_ALL
4722   INIT(0);
4723 EXTCONST STRLEN PL_WARN_NONE
4724   INIT(0);
4725
4726 /* This is constant on most architectures, a global on OS/2 */
4727 #ifndef OS2
4728 EXTCONST char PL_sh_path[]
4729   INIT(SH_PATH); /* full path of shell */
4730 #endif
4731
4732 #ifdef CSH
4733 EXTCONST char PL_cshname[]
4734   INIT(CSH);
4735 #  define PL_cshlen     (sizeof(CSH "") - 1)
4736 #endif
4737
4738 /* These are baked at compile time into any shared perl library.
4739    In future releases this will allow us in main() to sanity test the
4740    library we're linking against.  */
4741
4742 EXTCONST U8 PL_revision
4743   INIT(PERL_REVISION);
4744 EXTCONST U8 PL_version
4745   INIT(PERL_VERSION);
4746 EXTCONST U8 PL_subversion
4747   INIT(PERL_SUBVERSION);
4748
4749 EXTCONST char PL_uuemap[65]
4750   INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4751
4752 /* a special string address whose value is "isa", but which perl knows
4753  * to treat as if it were really "DOES" when printing the method name in
4754  *  the "Can't call method '%s'" error message */
4755 EXTCONST char PL_isa_DOES[]
4756   INIT("isa");
4757
4758 #ifdef DOINIT
4759 EXTCONST char PL_uudmap[256] =
4760 #  ifdef PERL_MICRO
4761 #    include "uuudmap.h"
4762 #  else
4763 #    include "uudmap.h"
4764 #  endif
4765 ;
4766 EXTCONST char PL_bitcount[256] =
4767 #  ifdef PERL_MICRO
4768 #    include "ubitcount.h"
4769 #else
4770 #    include "bitcount.h"
4771 #  endif
4772 ;
4773 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4774 EXTCONST int         PL_sig_num[]  = { SIG_NUM };
4775 #else
4776 EXTCONST char PL_uudmap[256];
4777 EXTCONST char PL_bitcount[256];
4778 EXTCONST char* const PL_sig_name[];
4779 EXTCONST int         PL_sig_num[];
4780 #endif
4781
4782 /* fast conversion and case folding tables.  The folding tables complement the
4783  * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4784  * folds such as outside the range or to multiple characters. */
4785
4786 #ifdef DOINIT
4787 #  ifndef EBCDIC
4788
4789 /* The EBCDIC fold table depends on the code page, and hence is found in
4790  * utfebcdic.h */
4791
4792 EXTCONST  unsigned char PL_fold[] = {
4793         0,      1,      2,      3,      4,      5,      6,      7,
4794         8,      9,      10,     11,     12,     13,     14,     15,
4795         16,     17,     18,     19,     20,     21,     22,     23,
4796         24,     25,     26,     27,     28,     29,     30,     31,
4797         32,     33,     34,     35,     36,     37,     38,     39,
4798         40,     41,     42,     43,     44,     45,     46,     47,
4799         48,     49,     50,     51,     52,     53,     54,     55,
4800         56,     57,     58,     59,     60,     61,     62,     63,
4801         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4802         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4803         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4804         'x',    'y',    'z',    91,     92,     93,     94,     95,
4805         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4806         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4807         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4808         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4809         128,    129,    130,    131,    132,    133,    134,    135,
4810         136,    137,    138,    139,    140,    141,    142,    143,
4811         144,    145,    146,    147,    148,    149,    150,    151,
4812         152,    153,    154,    155,    156,    157,    158,    159,
4813         160,    161,    162,    163,    164,    165,    166,    167,
4814         168,    169,    170,    171,    172,    173,    174,    175,
4815         176,    177,    178,    179,    180,    181,    182,    183,
4816         184,    185,    186,    187,    188,    189,    190,    191,
4817         192,    193,    194,    195,    196,    197,    198,    199,
4818         200,    201,    202,    203,    204,    205,    206,    207,
4819         208,    209,    210,    211,    212,    213,    214,    215,
4820         216,    217,    218,    219,    220,    221,    222,    223,
4821         224,    225,    226,    227,    228,    229,    230,    231,
4822         232,    233,    234,    235,    236,    237,    238,    239,
4823         240,    241,    242,    243,    244,    245,    246,    247,
4824         248,    249,    250,    251,    252,    253,    254,    255
4825 };
4826
4827 #    ifndef PERL_GLOBAL_STRUCT /* or perlvars.h */
4828 EXT unsigned char PL_fold_locale[] = { /* Unfortunately not EXTCONST. */
4829         0,      1,      2,      3,      4,      5,      6,      7,
4830         8,      9,      10,     11,     12,     13,     14,     15,
4831         16,     17,     18,     19,     20,     21,     22,     23,
4832         24,     25,     26,     27,     28,     29,     30,     31,
4833         32,     33,     34,     35,     36,     37,     38,     39,
4834         40,     41,     42,     43,     44,     45,     46,     47,
4835         48,     49,     50,     51,     52,     53,     54,     55,
4836         56,     57,     58,     59,     60,     61,     62,     63,
4837         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4838         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4839         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4840         'x',    'y',    'z',    91,     92,     93,     94,     95,
4841         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4842         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4843         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4844         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4845         128,    129,    130,    131,    132,    133,    134,    135,
4846         136,    137,    138,    139,    140,    141,    142,    143,
4847         144,    145,    146,    147,    148,    149,    150,    151,
4848         152,    153,    154,    155,    156,    157,    158,    159,
4849         160,    161,    162,    163,    164,    165,    166,    167,
4850         168,    169,    170,    171,    172,    173,    174,    175,
4851         176,    177,    178,    179,    180,    181,    182,    183,
4852         184,    185,    186,    187,    188,    189,    190,    191,
4853         192,    193,    194,    195,    196,    197,    198,    199,
4854         200,    201,    202,    203,    204,    205,    206,    207,
4855         208,    209,    210,    211,    212,    213,    214,    215,
4856         216,    217,    218,    219,    220,    221,    222,    223,
4857         224,    225,    226,    227,    228,    229,    230,    231,
4858         232,    233,    234,    235,    236,    237,    238,    239,
4859         240,    241,    242,    243,    244,    245,    246,    247,
4860         248,    249,    250,    251,    252,    253,    254,    255
4861 };
4862 #    endif
4863
4864 EXTCONST  unsigned char PL_fold_latin1[] = {
4865     /* Full latin1 complement folding, except for three problematic code points:
4866      *  Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4867      *  fold complements outside the Latin1 range, so can't match something
4868      *  that isn't in utf8.
4869      *  German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4870      *  not one, so can't be represented in this table.
4871      *
4872      * All have to be specially handled */
4873         0,      1,      2,      3,      4,      5,      6,      7,
4874         8,      9,      10,     11,     12,     13,     14,     15,
4875         16,     17,     18,     19,     20,     21,     22,     23,
4876         24,     25,     26,     27,     28,     29,     30,     31,
4877         32,     33,     34,     35,     36,     37,     38,     39,
4878         40,     41,     42,     43,     44,     45,     46,     47,
4879         48,     49,     50,     51,     52,     53,     54,     55,
4880         56,     57,     58,     59,     60,     61,     62,     63,
4881         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4882         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4883         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4884         'x',    'y',    'z',    91,     92,     93,     94,     95,
4885         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4886         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4887         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4888         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4889         128,    129,    130,    131,    132,    133,    134,    135,
4890         136,    137,    138,    139,    140,    141,    142,    143,
4891         144,    145,    146,    147,    148,    149,    150,    151,
4892         152,    153,    154,    155,    156,    157,    158,    159,
4893         160,    161,    162,    163,    164,    165,    166,    167,
4894         168,    169,    170,    171,    172,    173,    174,    175,
4895         176,    177,    178,    179,    180,    181 /*micro */, 182,    183,
4896         184,    185,    186,    187,    188,    189,    190,    191,
4897         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4898         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4899         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4900         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
4901         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4902         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4903         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4904         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
4905         255 /* y with diaeresis */
4906 };
4907