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
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.
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.
23 #endif /* PERL_FOR_X2P */
31 /* this is used for functions which take a depth trailing
32 * argument under debugging */
34 #define _pDEPTH ,U32 depth
35 #define _aDEPTH ,depth
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.
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)
52 /* See L<perlguts/"The Perl API"> for detailed notes on
53 * PERL_IMPLICIT_CONTEXT and PERL_IMPLICIT_SYS */
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. */
60 # if !defined(MULTIPLICITY)
66 # ifndef PERL_IMPLICIT_CONTEXT
67 # define PERL_IMPLICIT_CONTEXT
71 /* undef WIN32 when building on Cygwin (for libwin32) - gph */
77 /* Use the reentrant APIs like localtime_r and getpwent_r */
78 /* Win32 has naturally threadsafe libraries, no need to use any _r variants.
79 * XXX KEEP makedef.pl copy of this code in sync */
80 #if defined(USE_ITHREADS) && !defined(USE_REENTRANT_API) && !defined(NETWARE) && !defined(WIN32)
81 # define USE_REENTRANT_API
84 /* <--- here ends the logic shared by perl.h and makedef.pl */
87 =for apidoc_section $directives
88 =for apidoc AmnUu|void|EXTERN_C
89 When not compiling using C++, expands to nothing.
90 Otherwise is used in a declaration of a function to indicate the function
91 should have external C linkage. This is required for things to work for just
92 about all functions with external linkage compiled into perl.
93 Often, you can use C<L</START_EXTERN_C>> ... C<L</END_EXTERN_C>> blocks
94 surrounding all your code that you need to have this linkage.
98 EXTERN_C int flock(int fd, int op);
100 =for apidoc Amnu||START_EXTERN_C
101 When not compiling using C++, expands to nothing.
102 Otherwise begins a section of code in which every function will effectively
103 have C<L</EXTERN_C>> applied to it, that is to have external C linkage. The
104 section is ended by a C<L</END_EXTERN_C>>.
106 =for apidoc Amnu||END_EXTERN_C
107 When not compiling using C++, expands to nothing.
108 Otherwise ends a section of code already begun by a C<L</START_EXTERN_C>>.
113 #undef START_EXTERN_C
117 # define EXTERN_C extern "C"
118 # define START_EXTERN_C EXTERN_C {
119 # define END_EXTERN_C }
121 # define START_EXTERN_C
122 # define END_EXTERN_C
123 # define EXTERN_C extern
126 /* Fallback definitions in case we don't have definitions from config.h.
127 This should only matter for systems that don't use Configure and
128 haven't been modified to define PERL_STATIC_INLINE yet.
130 #if !defined(PERL_STATIC_INLINE)
131 # ifdef HAS_STATIC_INLINE
132 # define PERL_STATIC_INLINE static inline
134 # define PERL_STATIC_INLINE static
138 #ifdef PERL_IMPLICIT_CONTEXT
139 # ifndef MULTIPLICITY
140 # define MULTIPLICITY
142 # define tTHX PerlInterpreter*
143 # define pTHX tTHX my_perl PERL_UNUSED_DECL
144 # define aTHX my_perl
145 # define aTHXa(a) aTHX = (tTHX)a
146 # define dTHXa(a) pTHX = (tTHX)a
147 # define dTHX pTHX = PERL_GET_THX
160 # if defined(DEBUGGING) && !defined(PERL_TRACK_MEMPOOL)
161 # define PERL_TRACK_MEMPOOL
164 # undef PERL_TRACK_MEMPOOL
168 # define dTHX_DEBUGGING dTHX
170 # define dTHX_DEBUGGING dNOOP
173 #define STATIC static
176 /* Do not use these macros. They were part of PERL_OBJECT, which was an
177 * implementation of multiplicity using C++ objects. They have been left
178 * here solely for the sake of XS code which has incorrectly
181 * The only one Devel::PPPort handles is this; list it as deprecated
183 =for apidoc_section $concurrency
184 =for apidoc AmD|void|CPERLscope|void x
189 #define CPERLscope(x) x
190 #define CPERLarg void
193 #define PERL_OBJECT_THIS
194 #define _PERL_OBJECT_THIS
195 #define PERL_OBJECT_THIS_
196 #define CALL_FPTR(fptr) (*fptr)
197 #define MEMBER_TO_FPTR(name) name
198 #endif /* !PERL_CORE */
200 #define CALLRUNOPS PL_runops
202 #define CALLREGCOMP(sv, flags) Perl_pregcomp(aTHX_ (sv),(flags))
204 #define CALLREGCOMP_ENG(prog, sv, flags) (prog)->comp(aTHX_ sv, flags)
205 #define CALLREGEXEC(prog,stringarg,strend,strbeg,minend,sv,data,flags) \
206 RX_ENGINE(prog)->exec(aTHX_ (prog),(stringarg),(strend), \
207 (strbeg),(minend),(sv),(data),(flags))
208 #define CALLREG_INTUIT_START(prog,sv,strbeg,strpos,strend,flags,data) \
209 RX_ENGINE(prog)->intuit(aTHX_ (prog), (sv), (strbeg), (strpos), \
210 (strend),(flags),(data))
211 #define CALLREG_INTUIT_STRING(prog) \
212 RX_ENGINE(prog)->checkstr(aTHX_ (prog))
214 #define CALLREGFREE(prog) \
215 Perl_pregfree(aTHX_ (prog))
217 #define CALLREGFREE_PVT(prog) \
218 if(prog && RX_ENGINE(prog)) RX_ENGINE(prog)->rxfree(aTHX_ (prog))
220 #define CALLREG_NUMBUF_FETCH(rx,paren,usesv) \
221 RX_ENGINE(rx)->numbered_buff_FETCH(aTHX_ (rx),(paren),(usesv))
223 #define CALLREG_NUMBUF_STORE(rx,paren,value) \
224 RX_ENGINE(rx)->numbered_buff_STORE(aTHX_ (rx),(paren),(value))
226 #define CALLREG_NUMBUF_LENGTH(rx,sv,paren) \
227 RX_ENGINE(rx)->numbered_buff_LENGTH(aTHX_ (rx),(sv),(paren))
229 #define CALLREG_NAMED_BUFF_FETCH(rx, key, flags) \
230 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_FETCH))
232 #define CALLREG_NAMED_BUFF_STORE(rx, key, value, flags) \
233 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), (value), ((flags) | RXapif_STORE))
235 #define CALLREG_NAMED_BUFF_DELETE(rx, key, flags) \
236 RX_ENGINE(rx)->named_buff(aTHX_ (rx),(key), NULL, ((flags) | RXapif_DELETE))
238 #define CALLREG_NAMED_BUFF_CLEAR(rx, flags) \
239 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_CLEAR))
241 #define CALLREG_NAMED_BUFF_EXISTS(rx, key, flags) \
242 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_EXISTS))
244 #define CALLREG_NAMED_BUFF_FIRSTKEY(rx, flags) \
245 RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), NULL, ((flags) | RXapif_FIRSTKEY))
247 #define CALLREG_NAMED_BUFF_NEXTKEY(rx, lastkey, flags) \
248 RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), (lastkey), ((flags) | RXapif_NEXTKEY))
250 #define CALLREG_NAMED_BUFF_SCALAR(rx, flags) \
251 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_SCALAR))
253 #define CALLREG_NAMED_BUFF_COUNT(rx) \
254 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, RXapif_REGNAMES_COUNT)
256 #define CALLREG_NAMED_BUFF_ALL(rx, flags) \
257 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, flags)
259 #define CALLREG_PACKAGE(rx) \
260 RX_ENGINE(rx)->qr_package(aTHX_ (rx))
262 #if defined(USE_ITHREADS)
263 #define CALLREGDUPE(prog,param) \
264 Perl_re_dup(aTHX_ (prog),(param))
266 #define CALLREGDUPE_PVT(prog,param) \
267 (prog ? RX_ENGINE(prog)->dupe(aTHX_ (prog),(param)) \
271 /* some compilers impersonate gcc */
272 #if defined(__GNUC__) && !defined(__clang__) && !defined(__INTEL_COMPILER)
273 # define PERL_IS_GCC 1
276 /* In case Configure was not used (we are using a "canned config"
277 * such as Win32, or a cross-compilation setup, for example) try going
278 * by the gcc major and minor versions. One useful URL is
279 * http://www.ohse.de/uwe/articles/gcc-attributes.html,
280 * but contrary to this information warn_unused_result seems
281 * not to be in gcc 3.3.5, at least. --jhi
282 * Also, when building extensions with an installed perl, this allows
283 * the user to upgrade gcc and get the right attributes, rather than
284 * relying on the list generated at Configure time. --AD
285 * Set these up now otherwise we get confused when some of the <*thread.h>
286 * includes below indirectly pull in <perlio.h> (which needs to know if we
287 * have HASATTRIBUTE_FORMAT).
291 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
292 # if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
293 # define HASATTRIBUTE_DEPRECATED
295 # if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
296 # define HASATTRIBUTE_FORMAT
297 # if defined __MINGW32__
298 # define PRINTF_FORMAT_NULL_OK
301 # if __GNUC__ >= 3 /* 3.0 -> */
302 # define HASATTRIBUTE_MALLOC
304 # if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
305 # define HASATTRIBUTE_NONNULL
307 # if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
308 # define HASATTRIBUTE_NORETURN
310 # if __GNUC__ >= 3 /* gcc 3.0 -> */
311 # define HASATTRIBUTE_PURE
313 # if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
314 # define HASATTRIBUTE_UNUSED
316 # if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
317 # define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
319 # if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
320 # define HASATTRIBUTE_WARN_UNUSED_RESULT
322 /* always_inline is buggy in gcc <= 4.6 and causes compilation errors */
323 # if __GNUC__ == 4 && __GNUC_MINOR__ >= 7 || __GNUC__ > 4 /* 4.7 -> */
324 # define HASATTRIBUTE_ALWAYS_INLINE
327 #endif /* #ifndef PERL_MICRO */
329 #ifdef HASATTRIBUTE_DEPRECATED
330 # define __attribute__deprecated__ __attribute__((deprecated))
332 #ifdef HASATTRIBUTE_FORMAT
333 # define __attribute__format__(x,y,z) __attribute__((format(x,y,z)))
335 #ifdef HASATTRIBUTE_MALLOC
336 # define __attribute__malloc__ __attribute__((__malloc__))
338 #ifdef HASATTRIBUTE_NONNULL
339 # define __attribute__nonnull__(a) __attribute__((nonnull(a)))
341 #ifdef HASATTRIBUTE_NORETURN
342 # define __attribute__noreturn__ __attribute__((noreturn))
344 #ifdef HASATTRIBUTE_PURE
345 # define __attribute__pure__ __attribute__((pure))
347 #ifdef HASATTRIBUTE_UNUSED
348 # define __attribute__unused__ __attribute__((unused))
350 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
351 # define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
353 #ifdef HASATTRIBUTE_ALWAYS_INLINE
354 /* always_inline is buggy in gcc <= 4.6 and causes compilation errors */
355 # if !defined(PERL_IS_GCC) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7 || __GNUC__ > 4)
356 # define __attribute__always_inline__ __attribute__((always_inline))
360 /* If we haven't defined the attributes yet, define them to blank. */
361 #ifndef __attribute__deprecated__
362 # define __attribute__deprecated__
364 #ifndef __attribute__format__
365 # define __attribute__format__(x,y,z)
367 #ifndef __attribute__malloc__
368 # define __attribute__malloc__
370 #ifndef __attribute__nonnull__
371 # define __attribute__nonnull__(a)
373 #ifndef __attribute__noreturn__
374 # define __attribute__noreturn__
376 #ifndef __attribute__pure__
377 # define __attribute__pure__
379 #ifndef __attribute__unused__
380 # define __attribute__unused__
382 #ifndef __attribute__warn_unused_result__
383 # define __attribute__warn_unused_result__
385 #ifndef __attribute__always_inline__
386 # define __attribute__always_inline__
389 /* Some OS warn on NULL format to printf */
390 #ifdef PRINTF_FORMAT_NULL_OK
391 # define __attribute__format__null_ok__(x,y,z) __attribute__format__(x,y,z)
393 # define __attribute__format__null_ok__(x,y,z)
397 * Because of backward compatibility reasons the PERL_UNUSED_DECL
398 * cannot be changed from postfix to PERL_UNUSED_DECL(x). Sigh.
400 * Note that there are C compilers such as MetroWerks CodeWarrior
401 * which do not have an "inlined" way (like the gcc __attribute__) of
402 * marking unused variables (they need e.g. a #pragma) and therefore
403 * cpp macros like PERL_UNUSED_DECL cannot work for this purpose, even
404 * if it were PERL_UNUSED_DECL(x), which it cannot be (see above).
406 =for apidoc_section $directives
407 =for apidoc AmnU||PERL_UNUSED_DECL
408 Tells the compiler that the parameter in the function prototype just before it
409 is not necessarily expected to be used in the function. Not that many
410 compilers understand this, so this should only be used in cases where
411 C<L</PERL_UNUSED_ARG>> can't conveniently be used.
418 Perl_perly_sighandler(int sig, Siginfo_t *sip PERL_UNUSED_DECL,
419 void *uap PERL_UNUSED_DECL, bool safe)
426 #ifndef PERL_UNUSED_DECL
427 # define PERL_UNUSED_DECL __attribute__unused__
431 * for silencing unused variables that are actually used most of the time,
432 * but we cannot quite get rid of, such as "ax" in PPCODE+noargs xsubs,
433 * or variables/arguments that are used only in certain configurations.
435 =for apidoc Ams||PERL_UNUSED_ARG|void x
436 This is used to suppress compiler warnings that a parameter to a function is
437 not used. This situation can arise, for example, when a parameter is needed
438 under some configuration conditions, but not others, so that C preprocessor
439 conditional compilation causes it be used just some times.
441 =for apidoc Amns||PERL_UNUSED_CONTEXT
442 This is used to suppress compiler warnings that the thread context parameter to
443 a function is not used. This situation can arise, for example, when a
444 C preprocessor conditional compilation causes it be used just some times.
446 =for apidoc Ams||PERL_UNUSED_VAR|void x
447 This is used to suppress compiler warnings that the variable I<x> is not used.
448 This situation can arise, for example, when a C preprocessor conditional
449 compilation causes it be used just some times.
453 #ifndef PERL_UNUSED_ARG
454 # define PERL_UNUSED_ARG(x) ((void)sizeof(x))
456 #ifndef PERL_UNUSED_VAR
457 # define PERL_UNUSED_VAR(x) ((void)sizeof(x))
460 #if defined(USE_ITHREADS)
461 # define PERL_UNUSED_CONTEXT PERL_UNUSED_ARG(my_perl)
463 # define PERL_UNUSED_CONTEXT
466 /* gcc (-ansi) -pedantic doesn't allow gcc statement expressions,
467 * g++ allows them but seems to have problems with them
468 * (insane errors ensue).
469 * g++ does not give insane errors now (RMB 2008-01-30, gcc 4.2.2).
471 #if defined(PERL_GCC_PEDANTIC) || \
472 (defined(__GNUC__) && defined(__cplusplus) && \
473 ((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2))))
474 # ifndef PERL_GCC_BRACE_GROUPS_FORBIDDEN
475 # define PERL_GCC_BRACE_GROUPS_FORBIDDEN
481 =for apidoc Am||PERL_UNUSED_RESULT|void x
483 This macro indicates to discard the return value of the function call inside
486 PERL_UNUSED_RESULT(foo(a, b))
488 The main reason for this is that the combination of C<gcc -Wunused-result>
489 (part of C<-Wall>) and the C<__attribute__((warn_unused_result))> cannot
490 be silenced with casting to C<void>. This causes trouble when the system
491 header files use the attribute.
493 Use C<PERL_UNUSED_RESULT> sparingly, though, since usually the warning
494 is there for a good reason: you might lose success/failure information,
495 or leak resources, or changes in resources.
497 But sometimes you just want to ignore the return value, I<e.g.>, on
498 codepaths soon ending up in abort, or in "best effort" attempts,
499 or in situations where there is no good way to handle failures.
501 Sometimes C<PERL_UNUSED_RESULT> might not be the most natural way:
502 another possibility is that you can capture the return value
503 and use C<L</PERL_UNUSED_VAR>> on that.
507 The __typeof__() is used instead of typeof() since typeof() is not
508 available under strict C89, and because of compilers masquerading
509 as gcc (clang and icc), we want exactly the gcc extension
510 __typeof__ and nothing else.
513 #ifndef PERL_UNUSED_RESULT
514 # if defined(__GNUC__) && defined(HASATTRIBUTE_WARN_UNUSED_RESULT)
515 # define PERL_UNUSED_RESULT(v) STMT_START { __typeof__(v) z = (v); (void)sizeof(z); } STMT_END
517 # define PERL_UNUSED_RESULT(v) ((void)(v))
521 #if defined(_MSC_VER)
522 /* XXX older MSVC versions have a smallish macro buffer */
523 #define PERL_SMALL_MACRO_BUFFER
526 /* on gcc (and clang), specify that a warning should be temporarily
529 * GCC_DIAG_IGNORE_DECL(-Wmultichar);
531 * GCC_DIAG_RESTORE_DECL;
533 * based on http://dbp-consulting.com/tutorials/SuppressingGCCWarnings.html
535 * Note that "pragma GCC diagnostic push/pop" was added in GCC 4.6, Mar 2011;
536 * clang only pretends to be GCC 4.2, but still supports push/pop.
538 * Note on usage: all macros must be used at a place where a declaration
539 * or statement can occur, i.e., not in the middle of an expression.
540 * *_DIAG_IGNORE() and *_DIAG_RESTORE can be used in any such place, but
541 * must be used without a following semicolon. *_DIAG_IGNORE_DECL() and
542 * *_DIAG_RESTORE_DECL must be used with a following semicolon, and behave
543 * syntactically as declarations (like dNOOP). *_DIAG_IGNORE_STMT()
544 * and *_DIAG_RESTORE_STMT must be used with a following semicolon,
545 * and behave syntactically as statements (like NOOP).
549 #if defined(__clang__) || defined(__clang) || \
550 (defined( __GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406)
551 # define GCC_DIAG_PRAGMA(x) _Pragma (#x)
552 /* clang has "clang diagnostic" pragmas, but also understands gcc. */
553 # define GCC_DIAG_IGNORE(x) _Pragma("GCC diagnostic push") \
554 GCC_DIAG_PRAGMA(GCC diagnostic ignored #x)
555 # define GCC_DIAG_RESTORE _Pragma("GCC diagnostic pop")
557 # define GCC_DIAG_IGNORE(w)
558 # define GCC_DIAG_RESTORE
560 #define GCC_DIAG_IGNORE_DECL(x) GCC_DIAG_IGNORE(x) dNOOP
561 #define GCC_DIAG_RESTORE_DECL GCC_DIAG_RESTORE dNOOP
562 #define GCC_DIAG_IGNORE_STMT(x) GCC_DIAG_IGNORE(x) NOOP
563 #define GCC_DIAG_RESTORE_STMT GCC_DIAG_RESTORE NOOP
564 /* for clang specific pragmas */
565 #if defined(__clang__) || defined(__clang)
566 # define CLANG_DIAG_PRAGMA(x) _Pragma (#x)
567 # define CLANG_DIAG_IGNORE(x) _Pragma("clang diagnostic push") \
568 CLANG_DIAG_PRAGMA(clang diagnostic ignored #x)
569 # define CLANG_DIAG_RESTORE _Pragma("clang diagnostic pop")
571 # define CLANG_DIAG_IGNORE(w)
572 # define CLANG_DIAG_RESTORE
574 #define CLANG_DIAG_IGNORE_DECL(x) CLANG_DIAG_IGNORE(x) dNOOP
575 #define CLANG_DIAG_RESTORE_DECL CLANG_DIAG_RESTORE dNOOP
576 #define CLANG_DIAG_IGNORE_STMT(x) CLANG_DIAG_IGNORE(x) NOOP
577 #define CLANG_DIAG_RESTORE_STMT CLANG_DIAG_RESTORE NOOP
579 #if defined(_MSC_VER) && (_MSC_VER >= 1300)
580 # define MSVC_DIAG_IGNORE(x) __pragma(warning(push)) \
581 __pragma(warning(disable : x))
582 # define MSVC_DIAG_RESTORE __pragma(warning(pop))
584 # define MSVC_DIAG_IGNORE(x)
585 # define MSVC_DIAG_RESTORE
587 #define MSVC_DIAG_IGNORE_DECL(x) MSVC_DIAG_IGNORE(x) dNOOP
588 #define MSVC_DIAG_RESTORE_DECL MSVC_DIAG_RESTORE dNOOP
589 #define MSVC_DIAG_IGNORE_STMT(x) MSVC_DIAG_IGNORE(x) NOOP
590 #define MSVC_DIAG_RESTORE_STMT MSVC_DIAG_RESTORE NOOP
593 =for apidoc Amns||NOOP
594 Do nothing; typically used as a placeholder to replace something that used to
597 =for apidoc Amns||dNOOP
598 Declare nothing; typically used as a placeholder to replace something that used
599 to declare something. Works on compilers that require declarations before any
604 #define NOOP /*EMPTY*/(void)0
605 #define dNOOP struct Perl___notused_struct
608 /* Don't bother defining tTHX ; using it outside
609 * code guarded by PERL_IMPLICIT_CONTEXT is an error.
615 # define aTHXa(a) NOOP
616 # define dTHXa(a) dNOOP
631 =for apidoc_section $concurrency
632 =for apidoc AmnU||dVAR
633 This is now a synonym for dNOOP: declare nothing
639 /* Backwards compatibility macro for XS code. It used to be part of the
640 * PERL_GLOBAL_STRUCT(_PRIVATE) feature, which no longer exists */
643 /* these are only defined for compatibility; should not be used internally.
647 # define pTHXo_ pTHX_
649 # define aTHXo_ aTHX_
651 # define dTHXoa(x) dTHXa(x)
656 # define pTHXx PerlInterpreter *my_perl
657 # define pTHXx_ pTHXx,
658 # define aTHXx my_perl
659 # define aTHXx_ aTHXx,
663 /* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
664 * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
665 * dTHXs is therefore needed for all functions using PerlIO_foo(). */
666 #ifdef PERL_IMPLICIT_SYS
672 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
673 # ifndef PERL_USE_GCC_BRACE_GROUPS
674 # define PERL_USE_GCC_BRACE_GROUPS
679 =for apidoc_section $directives
680 =for apidoc AmnUu|void|STMT_START
681 =for apidoc_item ||STMT_END
683 This allows a series of statements in a macro to be used as a single statement,
686 if (x) STMT_START { ... } STMT_END else ...
688 Note that you can't return a value out of them, which limits their utility.
689 But see C<L</PERL_USE_GCC_BRACE_GROUPS>>.
691 =for apidoc AmnuU|bool|PERL_USE_GCC_BRACE_GROUPS
693 This C pre-processor value, if defined, indicates that it is permissible to use
694 the GCC brace groups extension. This extension, of the form
698 turns the block consisting of I<statements ...> into an expression with a
699 value, unlike plain C language blocks. This can present optimization
700 possibilities, B<BUT> you generally need to specify an alternative in case this
701 ability doesn't exist or has otherwise been forbidden.
707 #ifdef PERL_USE_GCC_BRACE_GROUPS
717 Trying to select a version that gives no warnings...
719 #if !(defined(STMT_START) && defined(STMT_END))
720 # ifdef PERL_USE_GCC_BRACE_GROUPS
721 # define STMT_START (void)( /* gcc supports "({ STATEMENTS; })" */
724 # define STMT_START do
725 # define STMT_END while (0)
729 #ifndef BYTEORDER /* Should never happen -- byteorder is in config.h */
730 # define BYTEORDER 0x1234
733 #if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
740 * The following contortions are brought to you on behalf of all the
741 * standards, semi-standards, de facto standards, not-so-de-facto standards
742 * of the world, as well as all the other botches anyone ever thought of.
743 * The basic theory is that if we work hard enough here, the rest of the
744 * code can be a lot prettier. Well, so much for theory. Sorry, Henry...
747 /* define this once if either system, instead of cluttering up the src */
748 #if defined(MSDOS) || defined(WIN32) || defined(NETWARE)
752 /* These exist only for back-compat with XS modules. */
755 #define CAN_PROTOTYPE
762 /* By compiling a perl with -DNO_TAINT_SUPPORT or -DSILENT_NO_TAINT_SUPPORT,
763 * you get a perl without taint support, but doubtlessly with a lesser
764 * degree of support. Do not do so unless you know exactly what it means
765 * technically, have a good reason to do so, and know exactly how the
766 * perl will be used. perls with -DSILENT_NO_TAINT_SUPPORT are considered
767 * a potential security risk due to flat out ignoring the security-relevant
768 * taint flags. This being said, a perl without taint support compiled in
769 * has marginal run-time performance benefits.
770 * SILENT_NO_TAINT_SUPPORT implies NO_TAINT_SUPPORT.
771 * SILENT_NO_TAINT_SUPPORT is the same as NO_TAINT_SUPPORT except it
772 * silently ignores -t/-T instead of throwing an exception.
774 * DANGER! Using NO_TAINT_SUPPORT or SILENT_NO_TAINT_SUPPORT
775 * voids your nonexistent warranty!
777 #if defined(SILENT_NO_TAINT_SUPPORT) && !defined(NO_TAINT_SUPPORT)
778 # define NO_TAINT_SUPPORT 1
781 /* NO_TAINT_SUPPORT can be set to transform virtually all taint-related
782 * operations into no-ops for a very modest speed-up. Enable only if you
783 * know what you're doing: tests and CPAN modules' tests are bound to fail.
785 #ifdef NO_TAINT_SUPPORT
787 # define TAINT_NOT NOOP
788 # define TAINT_IF(c) NOOP
789 # define TAINT_ENV() NOOP
790 # define TAINT_PROPER(s) NOOP
791 # define TAINT_set(s) NOOP
793 # define TAINTING_get 0
794 # define TAINTING_set(s) NOOP
795 # define TAINT_WARN_get 0
796 # define TAINT_WARN_set(s) NOOP
798 /* Set to tainted if we are running under tainting mode */
799 # define TAINT (PL_tainted = PL_tainting)
801 # define TAINT_NOT (PL_tainted = FALSE) /* Untaint */
802 # define TAINT_IF(c) if (UNLIKELY(c)) { TAINT; } /* Conditionally taint */
803 # define TAINT_ENV() if (UNLIKELY(PL_tainting)) { taint_env(); }
804 /* croak or warn if tainting */
805 # define TAINT_PROPER(s) if (UNLIKELY(PL_tainting)) { \
806 taint_proper(NULL, s); \
808 # define TAINT_set(s) (PL_tainted = (s))
809 # define TAINT_get (cBOOL(UNLIKELY(PL_tainted))) /* Is something tainted? */
810 # define TAINTING_get (cBOOL(UNLIKELY(PL_tainting))) /* Is taint checking enabled? */
811 # define TAINTING_set(s) (PL_tainting = (s))
812 # define TAINT_WARN_get (PL_taint_warn) /* FALSE => tainting violations
816 # define TAINT_WARN_set(s) (PL_taint_warn = (s))
819 /* flags used internally only within pp_subst and pp_substcont */
821 # define SUBST_TAINT_STR 1 /* string tainted */
822 # define SUBST_TAINT_PAT 2 /* pattern tainted */
823 # define SUBST_TAINT_REPL 4 /* replacement tainted */
824 # define SUBST_TAINT_RETAINT 8 /* use re'taint' in scope */
825 # define SUBST_TAINT_BOOLRET 16 /* return is boolean (don't taint) */
828 /* XXX All process group stuff is handled in pp_sys.c. Should these
829 defines move there? If so, I could simplify this a lot. --AD 9/96.
831 /* Process group stuff changed from traditional BSD to POSIX.
832 perlfunc.pod documents the traditional BSD-style syntax, so we'll
833 try to preserve that, if possible.
836 # define BSD_SETPGRP(pid, pgrp) setpgid((pid), (pgrp))
837 #elif defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
838 # define BSD_SETPGRP(pid, pgrp) setpgrp((pid), (pgrp))
839 #elif defined(HAS_SETPGRP2)
840 # define BSD_SETPGRP(pid, pgrp) setpgrp2((pid), (pgrp))
842 #if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
843 # define HAS_SETPGRP /* Well, effectively it does . . . */
846 /* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
847 our life easier :-) so we'll try it.
850 # define BSD_GETPGRP(pid) getpgid((pid))
851 #elif defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
852 # define BSD_GETPGRP(pid) getpgrp((pid))
853 #elif defined(HAS_GETPGRP2)
854 # define BSD_GETPGRP(pid) getpgrp2((pid))
856 #if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
857 # define HAS_GETPGRP /* Well, effectively it does . . . */
860 /* These are not exact synonyms, since setpgrp() and getpgrp() may
861 have different behaviors, but perl.h used to define USE_BSDPGRP
862 (prior to 5.003_05) so some extension might depend on it.
864 #if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
870 /* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
871 pthread.h must be included before all other header files.
873 #if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
874 # include <pthread.h>
877 #include <sys/types.h>
893 #ifdef METHOD /* Defined by OSF/1 v3.0 by ctype.h */
906 # include <xlocale.h>
909 /* If not forbidden, we enable locale handling if either 1) the POSIX 2008
910 * functions are available, or 2) just the setlocale() function. This logic is
911 * repeated in t/loc_tools.pl and makedef.pl; The three should be kept in
913 #if ! defined(NO_LOCALE)
915 # if ! defined(NO_POSIX_2008_LOCALE) \
916 && defined(HAS_NEWLOCALE) \
917 && defined(HAS_USELOCALE) \
918 && defined(HAS_DUPLOCALE) \
919 && defined(HAS_FREELOCALE) \
920 && defined(LC_ALL_MASK)
922 /* For simplicity, the code is written to assume that any platform advanced
923 * enough to have the Posix 2008 locale functions has LC_ALL. The final
924 * test above makes sure that assumption is valid */
926 # define HAS_POSIX_2008_LOCALE
928 # elif defined(HAS_SETLOCALE)
934 # define HAS_SKIP_LOCALE_INIT /* Solely for XS code to test for this
936 # if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
937 && defined(HAS_STRXFRM)
938 # define USE_LOCALE_COLLATE
940 # if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
941 # define USE_LOCALE_CTYPE
943 # if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
944 # define USE_LOCALE_NUMERIC
946 # if !defined(NO_LOCALE_MESSAGES) && defined(LC_MESSAGES)
947 # define USE_LOCALE_MESSAGES
949 # if !defined(NO_LOCALE_MONETARY) && defined(LC_MONETARY)
950 # define USE_LOCALE_MONETARY
952 # if !defined(NO_LOCALE_TIME) && defined(LC_TIME)
953 # define USE_LOCALE_TIME
955 # if !defined(NO_LOCALE_ADDRESS) && defined(LC_ADDRESS)
956 # define USE_LOCALE_ADDRESS
958 # if !defined(NO_LOCALE_IDENTIFICATION) && defined(LC_IDENTIFICATION)
959 # define USE_LOCALE_IDENTIFICATION
961 # if !defined(NO_LOCALE_MEASUREMENT) && defined(LC_MEASUREMENT)
962 # define USE_LOCALE_MEASUREMENT
964 # if !defined(NO_LOCALE_PAPER) && defined(LC_PAPER)
965 # define USE_LOCALE_PAPER
967 # if !defined(NO_LOCALE_TELEPHONE) && defined(LC_TELEPHONE)
968 # define USE_LOCALE_TELEPHONE
970 # if !defined(NO_LOCALE_SYNTAX) && defined(LC_SYNTAX)
971 # define USE_LOCALE_SYNTAX
973 # if !defined(NO_LOCALE_TOD) && defined(LC_TOD)
974 # define USE_LOCALE_TOD
977 /* XXX The next few defines are unfortunately duplicated in makedef.pl, and
978 * changes here MUST also be made there */
980 # if ! defined(HAS_SETLOCALE) && defined(HAS_POSIX_2008_LOCALE)
981 # define USE_POSIX_2008_LOCALE
982 # ifndef USE_THREAD_SAFE_LOCALE
983 # define USE_THREAD_SAFE_LOCALE
986 * -DUSE_THREAD_SAFE_LOCALE, will do so even
987 * on unthreaded builds */
988 # elif (defined(USE_ITHREADS) || defined(USE_THREAD_SAFE_LOCALE)) \
989 && ( defined(HAS_POSIX_2008_LOCALE) \
990 || (defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1400)) \
991 && ! defined(NO_THREAD_SAFE_LOCALE)
992 # ifndef USE_THREAD_SAFE_LOCALE
993 # define USE_THREAD_SAFE_LOCALE
995 # ifdef HAS_POSIX_2008_LOCALE
996 # define USE_POSIX_2008_LOCALE
1001 /* Microsoft documentation reads in the change log for VS 2015:
1002 * "The localeconv function declared in locale.h now works correctly when
1003 * per-thread locale is enabled. In previous versions of the library, this
1004 * function would return the lconv data for the global locale, not the
1007 #if defined(WIN32) && defined(USE_THREAD_SAFE_LOCALE) && _MSC_VER < 1900
1008 # define TS_W32_BROKEN_LOCALECONV
1014 # ifdef PARAM_NEEDS_TYPES
1015 # include <sys/types.h>
1017 # include <sys/param.h>
1020 /* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
1021 value something like 199306. This may be useful if no more-specific
1022 feature test is available.
1030 /* Use all the "standard" definitions */
1033 /* If this causes problems, set i_unistd=undef in the hint file. */
1035 # if defined(__amigaos4__)
1036 # ifdef I_NETINET_IN
1037 # include <netinet/in.h>
1040 # include <unistd.h>
1041 # if defined(__amigaos4__)
1042 /* Under AmigaOS 4 newlib.library provides an environ. However using
1043 * it doesn't give us enough control over inheritance of variables by
1044 * subshells etc. so replace with custom version based on abc-shell
1046 extern char **myenviron;
1048 # define environ myenviron
1054 # include <sys/wait.h>
1057 #if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
1058 EXTERN_C int syscall(int, ...);
1061 #if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
1062 EXTERN_C int usleep(unsigned int);
1065 /* Macros for correct constant construction. These are in C99 <stdint.h>
1066 * (so they will not be available in strict C89 mode), but they are nice, so
1067 * let's define them if necessary.
1068 =for apidoc_section $integer
1069 =for apidoc Am|I16|INT16_C|number
1070 =for apidoc_item |I32|INT32_C|number
1071 =for apidoc_item |I64|INT64_C|number
1073 Returns a token the C compiler recognizes for the constant C<number> of the
1074 corresponding integer type on the machine.
1076 If the machine does not have a 64-bit type, C<INT64_C> is undefined.
1077 Use C<L</INTMAX_C>> to get the largest type available on the platform.
1079 =for apidoc Am|U16|UINT16_C|number
1080 =for apidoc_item |U32|UINT32_C|number
1081 =for apidoc_item |U64|UINT64_C|number
1083 Returns a token the C compiler recognizes for the constant C<number> of the
1084 corresponding unsigned integer type on the machine.
1086 If the machine does not have a 64-bit type, C<UINT64_C> is undefined.
1087 Use C<L</UINTMAX_C>> to get the largest type available on the platform.
1094 # define UINT16_C(x) ((U16_TYPE)x##U)
1096 # define UINT16_C(x) ((U16_TYPE)x##UL)
1102 # define UINT32_C(x) ((U32_TYPE)x##U)
1104 # define UINT32_C(x) ((U32_TYPE)x##UL)
1109 typedef intmax_t PERL_INTMAX_T;
1110 typedef uintmax_t PERL_UINTMAX_T;
1113 /* N.B. We use QUADKIND here instead of HAS_QUAD here, because that doesn't
1114 * actually mean what it has always been documented to mean (see RT #119753)
1115 * and is explicitly turned off outside of core with dire warnings about
1116 * removing the undef. */
1118 #if defined(QUADKIND)
1119 # undef PeRl_INT64_C
1120 # undef PeRl_UINT64_C
1121 /* Prefer the native integer types (int and long) over long long
1122 * (which is not C89) and Win32-specific __int64. */
1123 # if QUADKIND == QUAD_IS_INT && INTSIZE == 8
1124 # define PeRl_INT64_C(c) (c)
1125 # define PeRl_UINT64_C(c) CAT2(c,U)
1127 # if QUADKIND == QUAD_IS_LONG && LONGSIZE == 8
1128 # define PeRl_INT64_C(c) CAT2(c,L)
1129 # define PeRl_UINT64_C(c) CAT2(c,UL)
1131 # if QUADKIND == QUAD_IS_LONG_LONG && defined(HAS_LONG_LONG)
1132 # define PeRl_INT64_C(c) CAT2(c,LL)
1133 # define PeRl_UINT64_C(c) CAT2(c,ULL)
1135 # if QUADKIND == QUAD_IS___INT64
1136 # define PeRl_INT64_C(c) CAT2(c,I64)
1137 # define PeRl_UINT64_C(c) CAT2(c,UI64)
1139 # ifndef PeRl_INT64_C
1140 # define PeRl_INT64_C(c) ((I64)(c)) /* last resort */
1141 # define PeRl_UINT64_C(c) ((U64TYPE)(c))
1143 /* In OS X the INT64_C/UINT64_C are defined with LL/ULL, which will
1144 * not fly with C89-pedantic gcc, so let's undefine them first so that
1145 * we can redefine them with our native integer preferring versions. */
1146 # if defined(PERL_DARWIN) && defined(PERL_GCC_PEDANTIC)
1151 # define INT64_C(c) PeRl_INT64_C(c)
1154 # define UINT64_C(c) PeRl_UINT64_C(c)
1158 =for apidoc_section $integer
1159 =for apidoc Am||INTMAX_C|number
1160 Returns a token the C compiler recognizes for the constant C<number> of the
1161 widest integer type on the machine. For example, if the machine has C<long
1162 long>s, C<INTMAX_C(-1)> would yield
1166 See also, for example, C<L</INT32_C>>.
1168 Use L</IV> to declare variables of the maximum usable size on this platform.
1170 =for apidoc Am||UINTMAX_C|number
1171 Returns a token the C compiler recognizes for the constant C<number> of the
1172 widest unsigned integer type on the machine. For example, if the machine has
1173 C<long>s, C<UINTMAX_C(1)> would yield
1177 See also, for example, C<L</UINT32_C>>.
1179 Use L</UV> to declare variables of the maximum usable size on this platform.
1185 typedef I64TYPE PERL_INTMAX_T;
1186 typedef U64TYPE PERL_UINTMAX_T;
1189 # define INTMAX_C(c) INT64_C(c)
1192 # define UINTMAX_C(c) UINT64_C(c)
1195 #else /* below QUADKIND is undefined */
1197 /* Perl doesn't work on 16 bit systems, so must be 32 bit */
1199 typedef I32TYPE PERL_INTMAX_T;
1200 typedef U32TYPE PERL_UINTMAX_T;
1203 # define INTMAX_C(c) INT32_C(c)
1206 # define UINTMAX_C(c) UINT32_C(c)
1209 #endif /* no QUADKIND */
1213 /* byte-swapping functions for big-/little-endian conversion */
1214 # define _swab_16_(x) ((U16)( \
1215 (((U16)(x) & UINT16_C(0x00ff)) << 8) | \
1216 (((U16)(x) & UINT16_C(0xff00)) >> 8) ))
1218 # define _swab_32_(x) ((U32)( \
1219 (((U32)(x) & UINT32_C(0x000000ff)) << 24) | \
1220 (((U32)(x) & UINT32_C(0x0000ff00)) << 8) | \
1221 (((U32)(x) & UINT32_C(0x00ff0000)) >> 8) | \
1222 (((U32)(x) & UINT32_C(0xff000000)) >> 24) ))
1225 # define _swab_64_(x) ((U64)( \
1226 (((U64)(x) & UINT64_C(0x00000000000000ff)) << 56) | \
1227 (((U64)(x) & UINT64_C(0x000000000000ff00)) << 40) | \
1228 (((U64)(x) & UINT64_C(0x0000000000ff0000)) << 24) | \
1229 (((U64)(x) & UINT64_C(0x00000000ff000000)) << 8) | \
1230 (((U64)(x) & UINT64_C(0x000000ff00000000)) >> 8) | \
1231 (((U64)(x) & UINT64_C(0x0000ff0000000000)) >> 24) | \
1232 (((U64)(x) & UINT64_C(0x00ff000000000000)) >> 40) | \
1233 (((U64)(x) & UINT64_C(0xff00000000000000)) >> 56) ))
1236 /* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
1237 at least on FreeBSD. YMMV, so experiment. */
1238 #ifndef PERL_ARENA_SIZE
1239 #define PERL_ARENA_SIZE 4080
1242 /* Maximum level of recursion */
1243 #ifndef PERL_SUB_DEPTH_WARN
1244 #define PERL_SUB_DEPTH_WARN 100
1247 #endif /* PERL_CORE */
1249 /* Maximum number of args that may be passed to an OP_MULTICONCAT op.
1250 * It determines the size of local arrays in S_maybe_multiconcat() and
1253 #define PERL_MULTICONCAT_MAXARG 64
1255 /* The indexes of fields of a multiconcat aux struct.
1256 * The fixed fields are followed by nargs+1 const segment lengths,
1257 * and if utf8 and non-utf8 differ, a second nargs+1 set for utf8.
1260 #define PERL_MULTICONCAT_IX_NARGS 0 /* number of arguments */
1261 #define PERL_MULTICONCAT_IX_PLAIN_PV 1 /* non-utf8 constant string */
1262 #define PERL_MULTICONCAT_IX_PLAIN_LEN 2 /* non-utf8 constant string length */
1263 #define PERL_MULTICONCAT_IX_UTF8_PV 3 /* utf8 constant string */
1264 #define PERL_MULTICONCAT_IX_UTF8_LEN 4 /* utf8 constant string length */
1265 #define PERL_MULTICONCAT_IX_LENGTHS 5 /* first of nargs+1 const segment lens */
1266 #define PERL_MULTICONCAT_HEADER_SIZE 5 /* The number of fields of a
1267 multiconcat header */
1269 /* We no longer default to creating a new SV for GvSV.
1270 Do this before embed. */
1271 #ifndef PERL_CREATE_GVSV
1272 # ifndef PERL_DONT_CREATE_GVSV
1273 # define PERL_DONT_CREATE_GVSV
1277 #if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
1278 #define PERL_USES_PL_PIDSTATUS
1281 #if !defined(OS2) && !defined(WIN32) && !defined(DJGPP)
1282 #define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
1285 #define MEM_SIZE Size_t
1287 /* Round all values passed to malloc up, by default to a multiple of
1290 #ifndef PERL_STRLEN_ROUNDUP_QUANTUM
1291 #define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
1294 /* sv_grow() will expand strings by at least a certain percentage of
1295 the previously *used* length to avoid excessive calls to realloc().
1296 The default is 25% of the current length.
1298 #ifndef PERL_STRLEN_EXPAND_SHIFT
1299 # define PERL_STRLEN_EXPAND_SHIFT 2
1302 /* This use of offsetof() requires /Zc:offsetof- for VS2017 (and presumably
1303 * onwards) when building Socket.xs, but we can just use a different definition
1304 * for STRUCT_OFFSET instead. */
1305 #if defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1910
1306 # define STRUCT_OFFSET(s,m) (Size_t)(&(((s *)0)->m))
1308 # include <stddef.h>
1309 # define STRUCT_OFFSET(s,m) offsetof(s,m)
1312 /* ptrdiff_t is C11, so undef it under pedantic builds. (Actually it is
1313 * in C89, but apparently there are platforms where it doesn't exist. See
1314 * thread beginning at http://nntp.perl.org/group/perl.perl5.porters/251541.)
1316 #ifdef PERL_GCC_PEDANTIC
1317 # undef HAS_PTRDIFF_T
1320 #ifdef HAS_PTRDIFF_T
1321 # define Ptrdiff_t ptrdiff_t
1323 # define Ptrdiff_t SSize_t
1326 # include <string.h>
1328 /* This comes after <stdlib.h> so we don't try to change the standard
1329 * library prototypes; we'll use our own in proto.h instead. */
1332 # ifdef PERL_POLLUTE_MALLOC
1333 # ifndef PERL_EXTMALLOC_DEF
1334 # define Perl_malloc malloc
1335 # define Perl_calloc calloc
1336 # define Perl_realloc realloc
1337 # define Perl_mfree free
1340 # define EMBEDMYMALLOC /* for compatibility */
1343 # define safemalloc Perl_malloc
1344 # define safecalloc Perl_calloc
1345 # define saferealloc Perl_realloc
1346 # define safefree Perl_mfree
1347 # define CHECK_MALLOC_TOO_LATE_FOR_(code) STMT_START { \
1348 if (!TAINTING_get && MallocCfg_ptr[MallocCfg_cfg_env_read]) \
1351 # define CHECK_MALLOC_TOO_LATE_FOR(ch) \
1352 CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
1353 # define panic_write2(s) write(2, s, strlen(s))
1354 # define CHECK_MALLOC_TAINT(newval) \
1355 CHECK_MALLOC_TOO_LATE_FOR_( \
1357 PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
1359 # define MALLOC_CHECK_TAINT(argc,argv,env) STMT_START { \
1360 if (doing_taint(argc,argv,env)) { \
1361 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1; \
1363 #else /* MYMALLOC */
1364 # define safemalloc safesysmalloc
1365 # define safecalloc safesyscalloc
1366 # define saferealloc safesysrealloc
1367 # define safefree safesysfree
1368 # define CHECK_MALLOC_TOO_LATE_FOR(ch) ((void)0)
1369 # define CHECK_MALLOC_TAINT(newval) ((void)0)
1370 # define MALLOC_CHECK_TAINT(argc,argv,env)
1371 #endif /* MYMALLOC */
1373 /* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
1374 #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)
1375 #define TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, "")
1376 #define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
1377 #define MALLOC_CHECK_TAINT2(argc,argv) MALLOC_CHECK_TAINT(argc,argv,NULL)
1380 =for apidoc Am|void|memzero|void * d|Size_t l
1381 Set the C<l> bytes starting at C<*d> to all zeroes.
1386 # define memzero(d,l) memset(d,0,l)
1390 # include <netinet/in.h>
1394 # include <arpa/inet.h>
1398 # include <sys/stat.h>
1401 /* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1402 This definition should ideally go into win32/win32.h, but S_IFIFO is
1403 used later here in perl.h before win32/win32.h is being included. */
1404 #if !defined(S_IFIFO) && defined(_S_IFIFO)
1405 # define S_IFIFO _S_IFIFO
1408 /* The stat macros for Unisoft System V/88 (and derivatives
1409 like UTekV) are broken, sometimes giving false positives. Undefine
1410 them here and let the code below set them to proper values.
1412 The ghs macro stands for GreenHills Software C-1.8.5 which
1413 is the C compiler for sysV88 and the various derivatives.
1414 This header file bug is corrected in gcc-2.5.8 and later versions.
1415 --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94. */
1417 #if defined(m88k) && defined(ghs)
1429 # ifdef I_SYS_TIME_KERNEL
1432 # include <sys/time.h>
1433 # ifdef I_SYS_TIME_KERNEL
1438 #if defined(HAS_TIMES) && defined(I_SYS_TIMES)
1439 # include <sys/times.h>
1444 #if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
1445 # define WIN32SCK_IS_STDSCK /* don't pull in custom wsock layer */
1448 #if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1449 # include <sys/socket.h>
1450 # if defined(USE_SOCKS) && defined(I_SOCKS)
1451 # if !defined(INCLUDE_PROTOTYPES)
1452 # define INCLUDE_PROTOTYPES /* for <socks.h> */
1453 # define PERL_SOCKS_NEED_PROTOTYPES
1456 # ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1457 # undef INCLUDE_PROTOTYPES
1458 # undef PERL_SOCKS_NEED_PROTOTYPES
1469 # include <net/errno.h>
1474 /* sockatmark() is so new (2001) that many places might have it hidden
1475 * behind some -D_BLAH_BLAH_SOURCE guard. The __THROW magic is required
1476 * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
1477 #if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
1478 # if defined(__THROW) && defined(__GLIBC__)
1479 int sockatmark(int) __THROW;
1481 int sockatmark(int);
1485 #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. */
1486 EXTERN_C int fchdir(int);
1487 EXTERN_C int flock(int, int);
1488 EXTERN_C int fseeko(FILE *, off_t, int);
1489 EXTERN_C off_t ftello(FILE *);
1492 #if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1493 EXTERN_C char *crypt(const char *, const char *);
1496 #if defined(__cplusplus) && defined(__CYGWIN__)
1497 EXTERN_C char *crypt(const char *, const char *);
1501 =for apidoc_section $errno
1503 =for apidoc m|void|SETERRNO|int errcode|int vmserrcode
1505 Set C<errno>, and on VMS set C<vaxc$errno>.
1507 =for apidoc mn|void|dSAVEDERRNO
1509 Declare variables needed to save C<errno> and any operating system
1510 specific error number.
1512 =for apidoc mn|void|dSAVE_ERRNO
1514 Declare variables needed to save C<errno> and any operating system
1515 specific error number, and save them for optional later restoration
1516 by C<RESTORE_ERRNO>.
1518 =for apidoc mn|void|SAVE_ERRNO
1520 Save C<errno> and any operating system specific error number for
1521 optional later restoration by C<RESTORE_ERRNO>. Requires
1522 C<dSAVEDERRNO> or C<dSAVE_ERRNO> in scope.
1524 =for apidoc mn|void|RESTORE_ERRNO
1526 Restore C<errno> and any operating system specific error number that
1527 was saved by C<dSAVE_ERRNO> or C<RESTORE_ERRNO>.
1533 # undef SETERRNO /* SOCKS might have defined this */
1537 # define SETERRNO(errcode,vmserrcode) \
1539 set_errno(errcode); \
1540 set_vaxc_errno(vmserrcode); \
1542 # define dSAVEDERRNO int saved_errno; unsigned saved_vms_errno
1543 # define dSAVE_ERRNO int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1544 # define SAVE_ERRNO ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1545 # define RESTORE_ERRNO SETERRNO(saved_errno, saved_vms_errno)
1547 # define LIB_INVARG LIB$_INVARG
1548 # define RMS_DIR RMS$_DIR
1549 # define RMS_FAC RMS$_FAC
1550 # define RMS_FEX RMS$_FEX
1551 # define RMS_FNF RMS$_FNF
1552 # define RMS_IFI RMS$_IFI
1553 # define RMS_ISI RMS$_ISI
1554 # define RMS_PRV RMS$_PRV
1555 # define SS_ACCVIO SS$_ACCVIO
1556 # define SS_DEVOFFLINE SS$_DEVOFFLINE
1557 # define SS_IVCHAN SS$_IVCHAN
1558 # define SS_NORMAL SS$_NORMAL
1559 # define SS_NOPRIV SS$_NOPRIV
1560 # define SS_BUFFEROVF SS$_BUFFEROVF
1562 # define LIB_INVARG 0
1570 # define SS_ACCVIO 0
1571 # define SS_DEVOFFLINE 0
1572 # define SS_IVCHAN 0
1573 # define SS_NORMAL 0
1574 # define SS_NOPRIV 0
1575 # define SS_BUFFEROVF 0
1579 # define dSAVEDERRNO int saved_errno; DWORD saved_win32_errno
1580 # define dSAVE_ERRNO int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1581 # define SAVE_ERRNO ( saved_errno = errno, saved_win32_errno = GetLastError() )
1582 # define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1586 # define dSAVEDERRNO int saved_errno; unsigned long saved_os2_errno
1587 # define dSAVE_ERRNO int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1588 # define SAVE_ERRNO ( saved_errno = errno, saved_os2_errno = Perl_rc )
1589 # define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1593 # define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1597 # define dSAVEDERRNO int saved_errno
1598 # define dSAVE_ERRNO int saved_errno = errno
1599 # define SAVE_ERRNO (saved_errno = errno)
1600 # define RESTORE_ERRNO (errno = saved_errno)
1604 =for apidoc_section $warning
1606 =for apidoc Amn|SV *|ERRSV
1608 Returns the SV for C<$@>, creating it if needed.
1610 =for apidoc Am|void|CLEAR_ERRSV
1612 Clear the contents of C<$@>, setting it to the empty string.
1614 This replaces any read-only SV with a fresh SV and removes any magic.
1616 =for apidoc Am|void|SANE_ERRSV
1618 Clean up ERRSV so we can safely set it.
1620 This replaces any read-only SV with a fresh writable copy and removes
1626 #define ERRSV GvSVn(PL_errgv)
1628 /* contains inlined gv_add_by_type */
1629 #define CLEAR_ERRSV() STMT_START { \
1630 SV ** const svp = &GvSV(PL_errgv); \
1632 *svp = newSVpvs(""); \
1633 } else if (SvREADONLY(*svp)) { \
1634 SvREFCNT_dec_NN(*svp); \
1635 *svp = newSVpvs(""); \
1637 SV *const errsv = *svp; \
1639 SvPOK_only(errsv); \
1640 if (SvMAGICAL(errsv)) { \
1646 /* contains inlined gv_add_by_type */
1647 #define SANE_ERRSV() STMT_START { \
1648 SV ** const svp = &GvSV(PL_errgv); \
1650 *svp = newSVpvs(""); \
1651 } else if (SvREADONLY(*svp)) { \
1652 SV *dupsv = newSVsv(*svp); \
1653 SvREFCNT_dec_NN(*svp); \
1656 SV *const errsv = *svp; \
1657 if (SvMAGICAL(errsv)) { \
1665 # define DEFSV (0 + GvSVn(PL_defgv))
1666 # define DEFSV_set(sv) \
1667 (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1668 # define SAVE_DEFSV \
1670 save_gp(PL_defgv, 0), \
1671 GvINTRO_off(PL_defgv), \
1672 SAVEGENERICSV(GvSV(PL_defgv)), \
1673 GvSV(PL_defgv) = NULL \
1676 # define DEFSV GvSVn(PL_defgv)
1677 # define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1678 # define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
1682 =for apidoc_section $SV
1683 =for apidoc Amn|SV *|DEFSV
1684 Returns the SV associated with C<$_>
1686 =for apidoc Am|void|DEFSV_set|SV * sv
1687 Associate C<sv> with C<$_>
1689 =for apidoc Amn|void|SAVE_DEFSV
1690 Localize C<$_>. See L<perlguts/Localizing changes>.
1696 extern int errno; /* ANSI allows errno to be an lvalue expr.
1697 * For example in multithreaded environments
1698 * something like this might happen:
1699 * extern int *_errno(void);
1700 * #define errno (*_errno()) */
1703 #define UNKNOWN_ERRNO_MSG "(unknown)"
1706 #define Strerror(e) strerror((e), vaxc$errno)
1708 #define Strerror(e) strerror(e)
1713 # include <sys/ioctl.h>
1717 #if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
1718 # ifdef HAS_SOCKETPAIR
1719 # undef HAS_SOCKETPAIR
1726 #ifndef HAS_SOCKETPAIR
1728 # define socketpair Perl_my_socketpair
1733 # define htoni htons
1734 # define ntohi ntohs
1736 # define htoni htonl
1737 # define ntohi ntohl
1740 /* Configure already sets Direntry_t */
1741 #if defined(I_DIRENT)
1742 # include <dirent.h>
1743 #elif defined(I_SYS_NDIR)
1744 # include <sys/ndir.h>
1745 #elif defined(I_SYS_DIR)
1746 # include <sys/dir.h>
1750 * The following gobbledygook brought to you on behalf of __STDC__.
1751 * (I could just use #ifndef __STDC__, but this is more bulletproof
1752 * in the face of half-implementations.)
1755 #if defined(I_SYSMODE)
1756 #include <sys/mode.h>
1761 # define S_IFMT _S_IFMT
1763 # define S_IFMT 0170000
1768 # define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1772 # define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1777 # define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1779 # define S_ISBLK(m) (0)
1784 # define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1789 # define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1791 # define S_ISFIFO(m) (0)
1797 # define S_ISLNK(m) _S_ISLNK(m)
1798 # elif defined(_S_IFLNK)
1799 # define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1800 # elif defined(S_IFLNK)
1801 # define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1803 # define S_ISLNK(m) (0)
1809 # define S_ISSOCK(m) _S_ISSOCK(m)
1810 # elif defined(_S_IFSOCK)
1811 # define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1812 # elif defined(S_IFSOCK)
1813 # define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1815 # define S_ISSOCK(m) (0)
1821 # define S_IRUSR S_IREAD
1822 # define S_IWUSR S_IWRITE
1823 # define S_IXUSR S_IEXEC
1825 # define S_IRUSR 0400
1826 # define S_IWUSR 0200
1827 # define S_IXUSR 0100
1833 # define S_IRGRP (S_IRUSR>>3)
1834 # define S_IWGRP (S_IWUSR>>3)
1835 # define S_IXGRP (S_IXUSR>>3)
1837 # define S_IRGRP 0040
1838 # define S_IWGRP 0020
1839 # define S_IXGRP 0010
1845 # define S_IROTH (S_IRUSR>>6)
1846 # define S_IWOTH (S_IWUSR>>6)
1847 # define S_IXOTH (S_IXUSR>>6)
1849 # define S_IROTH 0040
1850 # define S_IWOTH 0020
1851 # define S_IXOTH 0010
1856 # define S_ISUID 04000
1860 # define S_ISGID 02000
1864 # define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
1868 # define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
1872 # define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
1875 /* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
1876 * which would get included through <sys/file.h >, but that is 3000
1877 * lines in the future. --jhi */
1879 #if !defined(S_IREAD) && !defined(__HAIKU__)
1880 # define S_IREAD S_IRUSR
1883 #if !defined(S_IWRITE) && !defined(__HAIKU__)
1884 # define S_IWRITE S_IWUSR
1888 # define S_IEXEC S_IXUSR
1891 #if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
1892 # define SLOPPYDIVIDE
1899 /* This used to be conditionally defined based on whether we had a sprintf()
1900 * that correctly returns the string length (as required by C89), but we no
1901 * longer need that. XS modules can (and do) use this name, so it must remain
1902 * a part of the API that's visible to modules.
1904 =for apidoc_section $string
1905 =for apidoc ATmD|int|my_sprintf|NN char *buffer|NN const char *pat|...
1907 Do NOT use this due to the possibility of overflowing C<buffer>. Instead use
1912 #define my_sprintf sprintf
1915 * If we have v?snprintf() and the C99 variadic macros, we can just
1916 * use just the v?snprintf(). It is nice to try to trap the buffer
1917 * overflow, however, so if we are DEBUGGING, and we cannot use the
1918 * gcc statement expressions, then use the function wrappers which try
1919 * to trap the overflow. If we can use the gcc statement expressions,
1920 * we can try that even with the version that uses the C99 variadic
1924 /* Note that we do not check against snprintf()/vsnprintf() returning
1925 * negative values because that is non-standard behaviour and we use
1926 * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1927 * that should be true only if the snprintf()/vsnprintf() are true
1928 * to the standard. */
1930 #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
1933 # define my_snprintf Perl_my_snprintf
1934 # define PERL_MY_SNPRINTF_GUARDED
1935 #elif defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1936 # ifdef PERL_USE_GCC_BRACE_GROUPS
1937 # define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1938 # define PERL_MY_SNPRINTF_GUARDED
1940 # define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
1943 # define my_snprintf Perl_my_snprintf
1944 # define PERL_MY_SNPRINTF_GUARDED
1947 /* There is no quadmath_vsnprintf, and therefore my_vsnprintf()
1948 * dies if called under USE_QUADMATH. */
1949 #if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1950 # ifdef PERL_USE_GCC_BRACE_GROUPS
1951 # define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1952 # define PERL_MY_VSNPRINTF_GUARDED
1954 # define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
1957 # define my_vsnprintf Perl_my_vsnprintf
1958 # define PERL_MY_VSNPRINTF_GUARDED
1961 /* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1962 * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1963 * the result of my_snprintf() or my_vsnprintf(). (No, you should not
1964 * completely ignore it: otherwise you cannot know whether your output
1967 * int len = my_sprintf(buf, max, ...);
1968 * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1970 * The trick is that in certain platforms [a] the my_sprintf() already
1971 * contains the sanity check, while in certain platforms [b] it needs
1972 * to be done as a separate step. The POST_GUARD is that step-- in [a]
1973 * platforms the POST_GUARD actually does nothing since the check has
1974 * already been done. Watch out for the max being the same in both calls.
1976 * If you actually use the snprintf/vsnprintf return value already,
1977 * you assumedly are checking its validity somehow. But you can
1978 * insert the POST_GUARD() also in that case. */
1980 #ifndef PERL_MY_SNPRINTF_GUARDED
1981 # define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1983 # define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1986 #ifndef PERL_MY_VSNPRINTF_GUARDED
1987 # define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
1989 # define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1993 # define my_strlcat strlcat
1996 #if defined(PERL_CORE) || defined(PERL_EXT)
1998 # define my_memrchr memrchr
2000 # define my_memrchr S_my_memrchr
2005 # define my_strlcpy strlcpy
2009 # define my_strnlen strnlen
2013 The IV type is supposed to be long enough to hold any integral
2015 --Andy Dougherty August 1996
2021 #if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
2022 # if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
2023 # define IV_MAX ((IV)INT64_MAX)
2024 # define IV_MIN ((IV)INT64_MIN)
2025 # define UV_MAX ((UV)UINT64_MAX)
2027 # define UINT64_MIN 0
2029 # define UV_MIN ((UV)UINT64_MIN)
2031 # define IV_MAX PERL_QUAD_MAX
2032 # define IV_MIN PERL_QUAD_MIN
2033 # define UV_MAX PERL_UQUAD_MAX
2034 # define UV_MIN PERL_UQUAD_MIN
2039 # if defined(INT32_MAX) && IVSIZE == 4
2040 # define IV_MAX ((IV)INT32_MAX)
2041 # define IV_MIN ((IV)INT32_MIN)
2042 # ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
2043 # define UV_MAX ((UV)UINT32_MAX)
2045 # define UV_MAX ((UV)4294967295U)
2048 # define UINT32_MIN 0
2050 # define UV_MIN ((UV)UINT32_MIN)
2052 # define IV_MAX PERL_LONG_MAX
2053 # define IV_MIN PERL_LONG_MIN
2054 # define UV_MAX PERL_ULONG_MAX
2055 # define UV_MIN PERL_ULONG_MIN
2066 #if !defined(PERL_CORE)
2067 /* We think that removing this decade-old undef this will cause too much
2068 breakage on CPAN for too little gain. (See RT #119753)
2069 However, we do need HAS_QUAD in the core for use by the drand48 code. */
2075 #define Size_t_MAX (~(Size_t)0)
2076 #define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
2078 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
2079 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
2081 #ifndef NO_PERL_PRESERVE_IVUV
2082 #define PERL_PRESERVE_IVUV /* We like our integers to stay integers. */
2086 * The macros INT2PTR and NUM2PTR are (despite their names)
2087 * bi-directional: they will convert int/float to or from pointers.
2088 * However the conversion to int/float are named explicitly:
2089 * PTR2IV, PTR2UV, PTR2NV.
2091 * For int conversions we do not need two casts if pointers are
2092 * the same size as IV and UV. Otherwise we need an explicit
2093 * cast (PTRV) to avoid compiler warnings.
2095 * These are mentioned in perlguts
2097 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
2099 # define INT2PTR(any,d) (any)(d)
2100 #elif PTRSIZE == LONGSIZE
2101 # define PTRV unsigned long
2102 # define PTR2ul(p) (unsigned long)(p)
2104 # define PTRV unsigned
2108 # define INT2PTR(any,d) (any)(PTRV)(d)
2112 # define PTR2ul(p) INT2PTR(unsigned long,p)
2115 #define NUM2PTR(any,d) (any)(PTRV)(d)
2116 #define PTR2IV(p) INT2PTR(IV,p)
2117 #define PTR2UV(p) INT2PTR(UV,p)
2118 #define PTR2NV(p) NUM2PTR(NV,p)
2119 #define PTR2nat(p) (PTRV)(p) /* pointer to integer of PTRSIZE */
2121 /* According to strict ANSI C89 one cannot freely cast between
2122 * data pointers and function (code) pointers. There are at least
2123 * two ways around this. One (used below) is to do two casts,
2124 * first the other pointer to an (unsigned) integer, and then
2125 * the integer to the other pointer. The other way would be
2126 * to use unions to "overlay" the pointers. For an example of
2127 * the latter technique, see union dirpu in struct xpvio in sv.h.
2128 * The only feasible use is probably temporarily storing
2129 * function pointers in a data pointer (such as a void pointer). */
2131 #define DPTR2FPTR(t,p) ((t)PTR2nat(p)) /* data pointer to function pointer */
2132 #define FPTR2DPTR(t,p) ((t)PTR2nat(p)) /* function pointer to data pointer */
2134 #ifdef USE_LONG_DOUBLE
2135 # if LONG_DOUBLESIZE == DOUBLESIZE
2136 # define LONG_DOUBLE_EQUALS_DOUBLE
2137 # undef USE_LONG_DOUBLE /* Ouch! */
2141 /* The following is all to get LDBL_DIG, in order to pick a nice
2142 default value for printing floating point numbers in Gconvert.
2145 #ifndef HAS_LDBL_DIG
2146 # if LONG_DOUBLESIZE == 10
2147 # define LDBL_DIG 18 /* assume IEEE */
2148 # elif LONG_DOUBLESIZE == 12
2149 # define LDBL_DIG 18 /* gcc? */
2150 # elif LONG_DOUBLESIZE == 16
2151 # define LDBL_DIG 33 /* assume IEEE */
2152 # elif LONG_DOUBLESIZE == DOUBLESIZE
2153 # define LDBL_DIG DBL_DIG /* bummer */
2160 # include <ieeefp.h>
2163 #if defined(__DECC) && defined(__osf__)
2164 /* Also Tru64 cc has broken NaN comparisons. */
2165 # define NAN_COMPARE_BROKEN
2168 # define NAN_COMPARE_BROKEN
2171 #ifdef USE_LONG_DOUBLE
2173 # include <sunmath.h>
2175 # if defined(LDBL_DIG)
2176 # define NV_DIG LDBL_DIG
2177 # ifdef LDBL_MANT_DIG
2178 # define NV_MANT_DIG LDBL_MANT_DIG
2181 # define NV_MIN LDBL_MIN
2184 # define NV_MAX LDBL_MAX
2186 # ifdef LDBL_MIN_EXP
2187 # define NV_MIN_EXP LDBL_MIN_EXP
2189 # ifdef LDBL_MAX_EXP
2190 # define NV_MAX_EXP LDBL_MAX_EXP
2192 # ifdef LDBL_MIN_10_EXP
2193 # define NV_MIN_10_EXP LDBL_MIN_10_EXP
2195 # ifdef LDBL_MAX_10_EXP
2196 # define NV_MAX_10_EXP LDBL_MAX_10_EXP
2198 # ifdef LDBL_EPSILON
2199 # define NV_EPSILON LDBL_EPSILON
2202 # define NV_MAX LDBL_MAX
2203 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
2204 # elif defined(HUGE_VALL)
2205 # define NV_MAX HUGE_VALL
2208 # if defined(HAS_SQRTL)
2209 # define Perl_acos acosl
2210 # define Perl_asin asinl
2211 # define Perl_atan atanl
2212 # define Perl_atan2 atan2l
2213 # define Perl_ceil ceill
2214 # define Perl_cos cosl
2215 # define Perl_cosh coshl
2216 # define Perl_exp expl
2217 /* no Perl_fabs, but there's PERL_ABS */
2218 # define Perl_floor floorl
2219 # define Perl_fmod fmodl
2220 # define Perl_log logl
2221 # define Perl_log10 log10l
2222 # define Perl_pow powl
2223 # define Perl_sin sinl
2224 # define Perl_sinh sinhl
2225 # define Perl_sqrt sqrtl
2226 # define Perl_tan tanl
2227 # define Perl_tanh tanhl
2229 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
2232 # define Perl_modf(x,y) modfl(x,y)
2233 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
2234 prototype in <math.h> */
2235 # ifndef HAS_MODFL_PROTO
2236 EXTERN_C long double modfl(long double, long double *);
2238 # elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
2239 extern long double Perl_my_modfl(long double x, long double *ip);
2240 # define Perl_modf(x,y) Perl_my_modfl(x,y)
2245 # define Perl_frexp(x,y) frexpl(x,y)
2246 # elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
2247 extern long double Perl_my_frexpl(long double x, int *e);
2248 # define Perl_frexp(x,y) Perl_my_frexpl(x,y)
2253 # define Perl_ldexp(x, y) ldexpl(x,y)
2254 # elif defined(HAS_SCALBNL) && FLT_RADIX == 2
2255 # define Perl_ldexp(x,y) scalbnl(x,y)
2259 # if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
2260 # define Perl_isnan(x) isnanl(x)
2261 # elif defined(__sgi) && defined(__c99) /* XXX Configure test needed */
2262 # define Perl_isnan(x) isnan(x)
2266 # if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
2267 # define Perl_isinf(x) isinfl(x)
2268 # elif defined(__sgi) && defined(__c99) /* XXX Configure test needed */
2269 # define Perl_isinf(x) isinf(x)
2270 # elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2271 # define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
2274 # ifndef Perl_isfinite
2275 # define Perl_isfinite(x) Perl_isfinitel(x)
2277 #elif defined(USE_QUADMATH) && defined(I_QUADMATH)
2278 # include <quadmath.h>
2279 # define NV_DIG FLT128_DIG
2280 # define NV_MANT_DIG FLT128_MANT_DIG
2281 # define NV_MIN FLT128_MIN
2282 # define NV_MAX FLT128_MAX
2283 # define NV_MIN_EXP FLT128_MIN_EXP
2284 # define NV_MAX_EXP FLT128_MAX_EXP
2285 # define NV_EPSILON FLT128_EPSILON
2286 # define NV_MIN_10_EXP FLT128_MIN_10_EXP
2287 # define NV_MAX_10_EXP FLT128_MAX_10_EXP
2288 # define Perl_acos acosq
2289 # define Perl_asin asinq
2290 # define Perl_atan atanq
2291 # define Perl_atan2 atan2q
2292 # define Perl_ceil ceilq
2293 # define Perl_cos cosq
2294 # define Perl_cosh coshq
2295 # define Perl_exp expq
2296 /* no Perl_fabs, but there's PERL_ABS */
2297 # define Perl_floor floorq
2298 # define Perl_fmod fmodq
2299 # define Perl_log logq
2300 # define Perl_log10 log10q
2301 # define Perl_signbit signbitq
2302 # define Perl_pow powq
2303 # define Perl_sin sinq
2304 # define Perl_sinh sinhq
2305 # define Perl_sqrt sqrtq
2306 # define Perl_tan tanq
2307 # define Perl_tanh tanhq
2308 # define Perl_modf(x,y) modfq(x,y)
2309 # define Perl_frexp(x,y) frexpq(x,y)
2310 # define Perl_ldexp(x, y) ldexpq(x,y)
2311 # define Perl_isinf(x) isinfq(x)
2312 # define Perl_isnan(x) isnanq(x)
2313 # define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
2314 # define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
2315 # define Perl_fp_class_inf(x) (Perl_fp_class(x) == 3)
2316 # define Perl_fp_class_nan(x) (Perl_fp_class(x) == 4)
2317 # define Perl_fp_class_norm(x) (Perl_fp_class(x) == 1)
2318 # define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
2319 # define Perl_fp_class_zero(x) (Perl_fp_class(x) == 0)
2321 # define NV_DIG DBL_DIG
2322 # define NV_MANT_DIG DBL_MANT_DIG
2323 # define NV_MIN DBL_MIN
2324 # define NV_MAX DBL_MAX
2325 # define NV_MIN_EXP DBL_MIN_EXP
2326 # define NV_MAX_EXP DBL_MAX_EXP
2327 # define NV_MIN_10_EXP DBL_MIN_10_EXP
2328 # define NV_MAX_10_EXP DBL_MAX_10_EXP
2329 # define NV_EPSILON DBL_EPSILON
2330 # define NV_MAX DBL_MAX
2331 # define NV_MIN DBL_MIN
2333 /* These math interfaces are C89. */
2334 # define Perl_acos acos
2335 # define Perl_asin asin
2336 # define Perl_atan atan
2337 # define Perl_atan2 atan2
2338 # define Perl_ceil ceil
2339 # define Perl_cos cos
2340 # define Perl_cosh cosh
2341 # define Perl_exp exp
2342 /* no Perl_fabs, but there's PERL_ABS */
2343 # define Perl_floor floor
2344 # define Perl_fmod fmod
2345 # define Perl_log log
2346 # define Perl_log10 log10
2347 # define Perl_pow pow
2348 # define Perl_sin sin
2349 # define Perl_sinh sinh
2350 # define Perl_sqrt sqrt
2351 # define Perl_tan tan
2352 # define Perl_tanh tanh
2354 # define Perl_modf(x,y) modf(x,y)
2355 # define Perl_frexp(x,y) frexp(x,y)
2356 # define Perl_ldexp(x,y) ldexp(x,y)
2360 # define Perl_isnan(x) isnan(x)
2364 # if defined(HAS_ISINF)
2365 # define Perl_isinf(x) isinf(x)
2366 # elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2367 # define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
2370 # ifndef Perl_isfinite
2371 # ifdef HAS_ISFINITE
2372 # define Perl_isfinite(x) isfinite(x)
2373 # elif defined(HAS_FINITE)
2374 # define Perl_isfinite(x) finite(x)
2379 /* fpclassify(): C99. It is supposed to be a macro that switches on
2380 * the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
2381 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2383 # if defined(FP_INFINITE) && defined(FP_NAN)
2384 # define Perl_fp_class(x) fpclassify(x)
2385 # define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_INFINITE)
2386 # define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_NAN)
2387 # define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_NORMAL)
2388 # define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2389 # define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_ZERO)
2390 # elif defined(FP_PLUS_INF) && defined(FP_QNAN)
2391 /* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
2392 * actually not the C99 fpclassify, with its own set of return defines. */
2393 # define Perl_fp_class(x) fpclassify(x)
2394 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
2395 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
2396 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2397 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2398 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
2399 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
2400 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
2401 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
2402 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
2403 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
2405 # undef Perl_fp_class /* Unknown set of defines */
2409 /* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
2410 * are identical to the C99 fpclassify(). */
2411 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
2414 /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
2416 /* oh, and the isnormal macro has a typo in it! */
2418 # define isnormal(x) Perl_fp_class_norm(x)
2420 # if defined(FP_INFINITE) && defined(FP_NAN)
2421 # define Perl_fp_class(x) fp_classify(x)
2422 # define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_INFINITE)
2423 # define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_NAN)
2424 # define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_NORMAL)
2425 # define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2426 # define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_ZERO)
2428 # undef Perl_fp_class /* Unknown set of defines */
2432 /* Feel free to check with me for the SGI manpages, SGI testing,
2433 * etcetera, if you want to try getting this to work with IRIX.
2435 * - Allen <allens@cpan.org> */
2437 /* fpclass(): SysV, at least Solaris and some versions of IRIX. */
2438 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
2439 /* Solaris and IRIX have fpclass/fpclassl, but they are using
2440 * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2441 * Define some symbols also as cpp symbols so we can detect them. */
2442 # if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
2443 # define FP_PINF FP_PINF
2444 # define FP_QNAN FP_QNAN
2448 # include <ieeefp.h>
2453 # if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
2454 # define Perl_fp_class(x) fpclassl(x)
2456 # define Perl_fp_class(x) fpclass(x)
2458 # if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
2459 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_CLASS_SNAN)
2460 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_CLASS_QNAN)
2461 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_CLASS_NINF)
2462 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_CLASS_PINF)
2463 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_CLASS_NNORM)
2464 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_CLASS_PNORM)
2465 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_CLASS_NDENORM)
2466 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_CLASS_PDENORM)
2467 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_CLASS_NZERO)
2468 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_CLASS_PZERO)
2469 # elif defined(FP_PINF) && defined(FP_QNAN)
2470 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2471 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2472 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_NINF)
2473 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PINF)
2474 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_NNORM)
2475 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PNORM)
2476 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_NDENORM)
2477 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PDENORM)
2478 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_NZERO)
2479 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PZERO)
2481 # undef Perl_fp_class /* Unknown set of defines */
2485 /* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2486 #if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
2488 # if !defined(FP_SNAN) && defined(I_FP_CLASS)
2489 # include <fp_class.h>
2491 # if defined(FP_POS_INF) && defined(FP_QNAN)
2492 # ifdef __sgi /* XXX Configure test instead */
2493 # ifdef USE_LONG_DOUBLE
2494 # define Perl_fp_class(x) fp_class_l(x)
2496 # define Perl_fp_class(x) fp_class_d(x)
2499 # if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2500 # define Perl_fp_class(x) fp_classl(x)
2502 # define Perl_fp_class(x) fp_class(x)
2505 # if defined(FP_POS_INF) && defined(FP_QNAN)
2506 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2507 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2508 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_NEG_INF)
2509 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_POS_INF)
2510 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_NEG_NORM)
2511 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_POS_NORM)
2512 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_NEG_DENORM)
2513 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_POS_DENORM)
2514 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_NEG_ZERO)
2515 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_POS_ZERO)
2517 # undef Perl_fp_class /* Unknown set of defines */
2522 /* class(), _class(): Legacy: AIX. */
2523 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2525 # if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2527 # define Perl_fp_class(x) class(x)
2529 # define Perl_fp_class(x) _class(x)
2531 # if defined(FP_PLUS_INF) && defined(FP_NANQ)
2532 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_NANS)
2533 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_NANQ)
2534 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
2535 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
2536 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
2537 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
2538 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
2539 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
2540 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
2541 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
2543 # undef Perl_fp_class /* Unknown set of defines */
2548 /* Win32: _fpclass(), _isnan(), _finite(). */
2551 # define Perl_isnan(x) _isnan(x)
2553 # ifndef Perl_isfinite
2554 # define Perl_isfinite(x) _finite(x)
2556 # ifndef Perl_fp_class_snan
2557 /* No simple way to #define Perl_fp_class because _fpclass()
2558 * returns a set of bits. */
2559 # define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2560 # define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
2561 # define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
2562 # define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF)
2563 # define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF)
2564 # define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2565 # define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2566 # define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2567 # define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2568 # define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2569 # define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2570 # define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2571 # define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2572 # define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2573 # define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2577 #if !defined(Perl_fp_class_inf) && \
2578 defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2579 # define Perl_fp_class_inf(x) \
2580 (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2583 #if !defined(Perl_fp_class_nan) && \
2584 defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2585 # define Perl_fp_class_nan(x) \
2586 (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2589 #if !defined(Perl_fp_class_zero) && \
2590 defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2591 # define Perl_fp_class_zero(x) \
2592 (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2595 #if !defined(Perl_fp_class_norm) && \
2596 defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2597 # define Perl_fp_class_norm(x) \
2598 (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2601 #if !defined(Perl_fp_class_denorm) && \
2602 defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2603 # define Perl_fp_class_denorm(x) \
2604 (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
2608 # ifdef Perl_fp_class_nan
2609 # define Perl_isnan(x) Perl_fp_class_nan(x)
2610 # elif defined(HAS_UNORDERED)
2611 # define Perl_isnan(x) unordered((x), 0.0)
2613 # define Perl_isnan(x) ((x)!=(x))
2618 # ifdef Perl_fp_class_inf
2619 # define Perl_isinf(x) Perl_fp_class_inf(x)
2623 #ifndef Perl_isfinite
2624 # if defined(HAS_ISFINITE) && !defined(isfinite)
2625 # define Perl_isfinite(x) isfinite((double)(x))
2626 # elif defined(HAS_FINITE)
2627 # define Perl_isfinite(x) finite((double)(x))
2628 # elif defined(Perl_fp_class_finite)
2629 # define Perl_isfinite(x) Perl_fp_class_finite(x)
2631 /* For the infinities the multiplication returns nan,
2632 * for the nan the multiplication also returns nan,
2633 * for everything else (that is, finite) zero should be returned. */
2634 # define Perl_isfinite(x) (((x) * 0) == 0)
2639 # if defined(Perl_isfinite) && defined(Perl_isnan)
2640 # define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2644 /* We need Perl_isfinitel (ends with ell) (if available) even when
2645 * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2647 #if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2648 /* If isfinite() is a macro and looks like we have C99,
2649 * we assume it's the type-aware C99 isfinite(). */
2650 # if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
2651 # define Perl_isfinitel(x) isfinite(x)
2652 # elif defined(HAS_ISFINITEL)
2653 # define Perl_isfinitel(x) isfinitel(x)
2654 # elif defined(HAS_FINITEL)
2655 # define Perl_isfinitel(x) finitel(x)
2656 # elif defined(HAS_INFL) && defined(HAS_NANL)
2657 # define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
2659 # define Perl_isfinitel(x) ((x) * 0 == 0) /* See Perl_isfinite. */
2663 /* The default is to use Perl's own atof() implementation (in numeric.c).
2664 * Usually that is the one to use but for some platforms (e.g. UNICOS)
2665 * it is however best to use the native implementation of atof.
2666 * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2667 * Some good tests to try out with either setting are t/base/num.t,
2668 * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2669 * you may need to be using a different function than atof! */
2671 #ifndef USE_PERL_ATOF
2673 # define USE_PERL_ATOF
2676 # if USE_PERL_ATOF == 0
2677 # undef USE_PERL_ATOF
2681 #ifdef USE_PERL_ATOF
2682 # define Perl_atof(s) Perl_my_atof(s)
2683 # define Perl_atof2(s, n) Perl_my_atof3(aTHX_ (s), &(n), 0)
2685 # define Perl_atof(s) (NV)atof(s)
2686 # define Perl_atof2(s, n) ((n) = atof(s))
2688 #define my_atof2(a,b) my_atof3(a,b,0)
2691 =for apidoc_section $numeric
2692 =for apidoc AmT|NV|Perl_acos|NV x
2693 =for apidoc_item |NV|Perl_asin|NV x
2694 =for apidoc_item |NV|Perl_atan|NV x
2695 =for apidoc_item |NV|Perl_atan2|NV x|NV y
2696 =for apidoc_item |NV|Perl_ceil|NV x
2697 =for apidoc_item |NV|Perl_cos|NV x
2698 =for apidoc_item |NV|Perl_cosh|NV x
2699 =for apidoc_item |NV|Perl_exp|NV x
2700 =for apidoc_item |NV|Perl_floor|NV x
2701 =for apidoc_item |NV|Perl_fmod|NV x|NV y
2702 =for apidoc_item |NV|Perl_frexp|NV x|int *exp
2703 =for apidoc_item |IV|Perl_isfinite|NV x
2704 =for apidoc_item |IV|Perl_isinf|NV x
2705 =for apidoc_item |IV|Perl_isnan|NV x
2706 =for apidoc_item |NV|Perl_ldexp|NV x|int exp
2707 =for apidoc_item |NV|Perl_log|NV x
2708 =for apidoc_item |NV|Perl_log10|NV x
2709 =for apidoc_item |NV|Perl_modf|NV x|NV *iptr
2710 =for apidoc_item |NV|Perl_pow|NV x|NV y
2711 =for apidoc_item |NV|Perl_sin|NV x
2712 =for apidoc_item |NV|Perl_sinh|NV x
2713 =for apidoc_item |NV|Perl_sqrt|NV x
2714 =for apidoc_item |NV|Perl_tan|NV x
2715 =for apidoc_item |NV|Perl_tanh|NV x
2717 These perform the corresponding mathematical operation on the operand(s), using
2718 the libc function designed for the task that has just enough precision for an
2719 NV on this platform. If no such function with sufficient precision exists,
2720 the highest precision one available is used.
2726 * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2727 * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2728 * depending on local options. Until Configure detects this (or at least
2729 * detects whether the "signed" keyword is available) the CHAR ranges
2730 * will not be included. UCHAR functions normally.
2734 #define PERL_UCHAR_MIN ((unsigned char)0)
2735 #define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2737 #define PERL_USHORT_MIN ((unsigned short)0)
2738 #define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2740 #define PERL_SHORT_MAX ((short)SHRT_MAX)
2741 #define PERL_SHORT_MIN ((short)SHRT_MIN)
2743 #define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2744 #define PERL_UINT_MIN ((unsigned int)0)
2746 #define PERL_INT_MAX ((int)INT_MAX)
2747 #define PERL_INT_MIN ((int)INT_MIN)
2749 #define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2750 #define PERL_ULONG_MIN ((unsigned long)0L)
2752 #define PERL_LONG_MAX ((long)LONG_MAX)
2753 #define PERL_LONG_MIN ((long)LONG_MIN)
2756 # define PERL_UQUAD_MAX (~(UV)0)
2757 # define PERL_UQUAD_MIN ((UV)0)
2758 # define PERL_QUAD_MAX ((IV) (PERL_UQUAD_MAX >> 1))
2759 # define PERL_QUAD_MIN (-PERL_QUAD_MAX - ((3 & -1) == 3))
2763 =for apidoc_section $integer
2765 =for apidoc AmnU||PERL_INT_MAX
2766 =for apidoc_item ||PERL_INT_MIN
2767 =for apidoc_item ||PERL_LONG_MAX
2768 =for apidoc_item ||PERL_LONG_MIN
2769 =for apidoc_item ||PERL_SHORT_MAX
2770 =for apidoc_item ||PERL_SHORT_MIN
2771 =for apidoc_item ||PERL_UCHAR_MAX
2772 =for apidoc_item ||PERL_UCHAR_MIN
2773 =for apidoc_item ||PERL_UINT_MAX
2774 =for apidoc_item ||PERL_UINT_MIN
2775 =for apidoc_item ||PERL_ULONG_MAX
2776 =for apidoc_item ||PERL_ULONG_MIN
2777 =for apidoc_item ||PERL_USHORT_MAX
2778 =for apidoc_item ||PERL_USHORT_MIN
2779 =for apidoc_item ||PERL_QUAD_MAX
2780 =for apidoc_item ||PERL_QUAD_MIN
2781 =for apidoc_item ||PERL_UQUAD_MAX
2782 =for apidoc_item ||PERL_UQUAD_MIN
2784 These give the largest and smallest number representable in the current
2785 platform in variables of the corresponding types.
2787 For signed types, the smallest representable number is the most negative
2788 number, the one furthest away from zero.
2790 For C99 and later compilers, these correspond to things like C<INT_MAX>, which
2791 are available to the C code. But these constants, furnished by Perl,
2792 allow code compiled on earlier compilers to portably have access to the same
2799 typedef MEM_SIZE STRLEN;
2801 typedef struct op OP;
2802 typedef struct cop COP;
2803 typedef struct unop UNOP;
2804 typedef struct unop_aux UNOP_AUX;
2805 typedef struct binop BINOP;
2806 typedef struct listop LISTOP;
2807 typedef struct logop LOGOP;
2808 typedef struct pmop PMOP;
2809 typedef struct svop SVOP;
2810 typedef struct padop PADOP;
2811 typedef struct pvop PVOP;
2812 typedef struct loop LOOP;
2813 typedef struct methop METHOP;
2816 typedef struct opslab OPSLAB;
2817 typedef struct opslot OPSLOT;
2820 typedef struct block_hooks BHK;
2821 typedef struct custom_op XOP;
2823 typedef struct interpreter PerlInterpreter;
2825 /* SGI's <sys/sema.h> has struct sv */
2827 # define STRUCT_SV perl_sv
2829 # define STRUCT_SV sv
2831 typedef struct STRUCT_SV SV;
2832 typedef struct av AV;
2833 typedef struct hv HV;
2834 typedef struct cv CV;
2835 typedef struct p5rx REGEXP;
2836 typedef struct gp GP;
2837 typedef struct gv GV;
2838 typedef struct io IO;
2839 typedef struct context PERL_CONTEXT;
2840 typedef struct block BLOCK;
2841 typedef struct invlist INVLIST;
2843 typedef struct magic MAGIC;
2844 typedef struct xpv XPV;
2845 typedef struct xpviv XPVIV;
2846 typedef struct xpvuv XPVUV;
2847 typedef struct xpvnv XPVNV;
2848 typedef struct xpvmg XPVMG;
2849 typedef struct xpvlv XPVLV;
2850 typedef struct xpvinvlist XINVLIST;
2851 typedef struct xpvav XPVAV;
2852 typedef struct xpvhv XPVHV;
2853 typedef struct xpvgv XPVGV;
2854 typedef struct xpvcv XPVCV;
2855 typedef struct xpvbm XPVBM;
2856 typedef struct xpvfm XPVFM;
2857 typedef struct xpvio XPVIO;
2858 typedef struct mgvtbl MGVTBL;
2859 typedef union any ANY;
2860 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2861 typedef struct ptr_tbl PTR_TBL_t;
2862 typedef struct clone_params CLONE_PARAMS;
2864 /* a pad is currently just an AV; but that might change,
2865 * so hide the type. */
2866 typedef struct padlist PADLIST;
2868 typedef struct padnamelist PADNAMELIST;
2869 typedef struct padname PADNAME;
2871 /* always enable PERL_OP_PARENT */
2872 #if !defined(PERL_OP_PARENT)
2873 # define PERL_OP_PARENT
2876 /* enable PERL_COPY_ON_WRITE by default */
2877 #if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2878 # define PERL_COPY_ON_WRITE
2881 #ifdef PERL_COPY_ON_WRITE
2882 # define PERL_ANY_COW
2884 # define PERL_SAWAMPERSAND
2887 #if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2888 # error PERL_DEBUG_READONLY_OPS only works with ithreads
2892 #include "charclass_invlists.h"
2894 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2895 # if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2896 # define USE_64_BIT_RAWIO /* implicit */
2900 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2901 * fseeko/ftello if possible. Don't go #defining ftell to ftello yourself,
2902 * however, because operating systems like to do that themself. */
2905 # define FSEEKSIZE LSEEKSIZE
2907 # define FSEEKSIZE LONGSIZE
2911 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2912 # if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2913 # define USE_64_BIT_STDIO /* implicit */
2917 #ifdef USE_64_BIT_RAWIO
2920 # define Off_t off64_t
2922 # define LSEEKSIZE 8
2924 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2925 * will trigger defines like the ones below. Some 64-bit environments,
2926 * however, do not. Therefore we have to explicitly mix and match. */
2927 # if defined(USE_OPEN64)
2928 # define open open64
2930 # if defined(USE_LSEEK64)
2931 # define lseek lseek64
2933 # if defined(USE_LLSEEK)
2934 # define lseek llseek
2937 # if defined(USE_STAT64)
2938 # define stat stat64
2940 # if defined(USE_FSTAT64)
2941 # define fstat fstat64
2943 # if defined(USE_LSTAT64)
2944 # define lstat lstat64
2946 # if defined(USE_FLOCK64)
2947 # define flock flock64
2949 # if defined(USE_LOCKF64)
2950 # define lockf lockf64
2952 # if defined(USE_FCNTL64)
2953 # define fcntl fcntl64
2955 # if defined(USE_TRUNCATE64)
2956 # define truncate truncate64
2958 # if defined(USE_FTRUNCATE64)
2959 # define ftruncate ftruncate64
2963 #ifdef USE_64_BIT_STDIO
2964 # ifdef HAS_FPOS64_T
2966 # define Fpos_t fpos64_t
2968 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2969 * will trigger defines like the ones below. Some 64-bit environments,
2970 * however, do not. */
2971 # if defined(USE_FOPEN64)
2972 # define fopen fopen64
2974 # if defined(USE_FSEEK64)
2975 # define fseek fseek64 /* don't do fseeko here, see perlio.c */
2977 # if defined(USE_FTELL64)
2978 # define ftell ftell64 /* don't do ftello here, see perlio.c */
2980 # if defined(USE_FSETPOS64)
2981 # define fsetpos fsetpos64
2983 # if defined(USE_FGETPOS64)
2984 # define fgetpos fgetpos64
2986 # if defined(USE_TMPFILE64)
2987 # define tmpfile tmpfile64
2989 # if defined(USE_FREOPEN64)
2990 # define freopen freopen64
2995 # include "iperlsys.h"
3000 # include "os2ish.h"
3002 # include "dosish.h"
3005 # include "vmsish.h"
3006 #elif defined(PLAN9)
3007 # include "./plan9/plan9ish.h"
3008 #elif defined(__VOS__)
3010 # include "./vos/vosish.h"
3012 # include "vos/vosish.h"
3014 #elif defined(__HAIKU__)
3015 # include "haiku/haikuish.h"
3017 # include "unixish.h"
3021 # include "amigaos.h"
3022 # undef FD_CLOEXEC /* a lie in AmigaOS */
3025 /* NSIG logic from Configure --> */
3028 # define NSIG (_NSIG)
3029 # elif defined(SIGMAX)
3030 # define NSIG (SIGMAX+1)
3031 # elif defined(SIG_MAX)
3032 # define NSIG (SIG_MAX+1)
3033 # elif defined(_SIG_MAX)
3034 # define NSIG (_SIG_MAX+1)
3035 # elif defined(MAXSIG)
3036 # define NSIG (MAXSIG+1)
3037 # elif defined(MAX_SIG)
3038 # define NSIG (MAX_SIG+1)
3039 # elif defined(SIGARRAYSIZE)
3040 # define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
3041 # elif defined(_sys_nsig)
3042 # define NSIG (_sys_nsig) /* Solaris 2.5 */
3044 /* Default to some arbitrary number that's big enough to get most
3045 * of the common signals. */
3049 /* <-- NSIG logic from Configure */
3051 #ifndef NO_ENVIRON_ARRAY
3052 # define USE_ENVIRON_ARRAY
3056 /* On some platforms it would be safe to use a read/write mutex with many
3057 * readers possible at the same time. On other platforms, notably IBM ones,
3058 * subsequent getenv calls destroy earlier ones. Those platforms would not
3059 * be able to handle simultaneous getenv calls */
3060 # define ENV_LOCK MUTEX_LOCK(&PL_env_mutex)
3061 # define ENV_UNLOCK MUTEX_UNLOCK(&PL_env_mutex)
3062 # define ENV_INIT MUTEX_INIT(&PL_env_mutex);
3063 # define ENV_TERM MUTEX_DESTROY(&PL_env_mutex);
3065 # define ENV_LOCK NOOP;
3066 # define ENV_UNLOCK NOOP;
3067 # define ENV_INIT NOOP;
3068 # define ENV_TERM NOOP;
3071 /* Some critical sections need to lock both the locale and the environment.
3072 * XXX khw intends to change this to lock both mutexes, but that brings up
3073 * issues of potential deadlock, so should be done at the beginning of a
3074 * development cycle. So for now, it just locks the environment. Note that
3075 * many modern platforms are locale-thread-safe anyway, so locking the locale
3076 * mutex is a no-op anyway */
3077 #define ENV_LOCALE_LOCK ENV_LOCK
3078 #define ENV_LOCALE_UNLOCK ENV_UNLOCK
3080 /* And some critical sections care only that no one else is writing either the
3081 * locale nor the environment. XXX Again this is for the future. This can be
3082 * simulated with using COND_WAIT in thread.h */
3083 #define ENV_LOCALE_READ_LOCK ENV_LOCALE_LOCK
3084 #define ENV_LOCALE_READ_UNLOCK ENV_LOCALE_UNLOCK
3086 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3087 /* having sigaction(2) means that the OS supports both 1-arg and 3-arg
3088 * signal handlers. But the perl core itself only fully supports 1-arg
3089 * handlers, so don't enable for now.
3090 * NB: POSIX::sigaction() supports both.
3092 * # define PERL_USE_3ARG_SIGHANDLER
3097 * This is an alias for the OS's siginfo_t, except that where the OS
3098 * doesn't support it, declare a dummy version instead. This allows us to
3099 * have signal handler functions which always have a Siginfo_t parameter
3100 * regardless of platform, (and which will just be passed a NULL value
3101 * where the OS doesn't support HAS_SIGACTION).
3104 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3105 typedef siginfo_t Siginfo_t;
3107 #ifdef si_signo /* minix */
3117 * initialise to avoid floating-point exceptions from overflow, etc
3119 #ifndef PERL_FPU_INIT
3120 # ifdef HAS_FPSETMASK
3121 # if HAS_FLOATINGPOINT_H
3122 # include <floatingpoint.h>
3124 /* Some operating systems have this as a macro, which in turn expands to a comma
3125 expression, and the last sub-expression is something that gets calculated,
3126 and then they have the gall to warn that a value computed is not used. Hence
3128 # define PERL_FPU_INIT (void)fpsetmask(0)
3129 # elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
3130 # define PERL_FPU_INIT PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
3131 # define PERL_FPU_PRE_EXEC { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
3132 # define PERL_FPU_POST_EXEC rsignal_restore(SIGFPE, &xfpe); }
3134 # define PERL_FPU_INIT
3137 #ifndef PERL_FPU_PRE_EXEC
3138 # define PERL_FPU_PRE_EXEC {
3139 # define PERL_FPU_POST_EXEC }
3142 /* In Tru64 the cc -ieee enables the IEEE math but disables traps.
3143 * We need to reenable the "invalid" trap because otherwise generation
3144 * of NaN values leaves the IEEE fp flags in bad state, leaving any further
3145 * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
3147 # include <machine/fpu.h>
3148 # define PERL_SYS_FPU_INIT \
3150 ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
3151 signal(SIGFPE, SIG_IGN); \
3154 /* In IRIX the default for Flush to Zero bit is true,
3155 * which means that results going below the minimum of normal
3156 * floating points go to zero, instead of going denormal/subnormal.
3157 * This is unlike almost any other system running Perl, so let's clear it.
3158 * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
3159 * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
3161 * XXX The flush-to-zero behaviour should be a Configure scan.
3162 * To change the behaviour usually requires some system-specific
3163 * incantation, though, like the below. */
3165 # include <sys/fpu.h>
3166 # define PERL_SYS_FPU_INIT \
3168 union fpc_csr csr; \
3169 csr.fc_word = get_fpc_csr(); \
3170 csr.fc_struct.flush = 0; \
3171 set_fpc_csr(csr.fc_word); \
3175 #ifndef PERL_SYS_FPU_INIT
3176 # define PERL_SYS_FPU_INIT NOOP
3179 #ifndef PERL_SYS_INIT3_BODY
3180 # define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
3184 =for apidoc_section $embedding
3186 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
3187 Provides system-specific tune up of the C runtime environment necessary to
3188 run Perl interpreters. This should be called only once, before creating
3189 any Perl interpreters.
3191 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
3192 Provides system-specific tune up of the C runtime environment necessary to
3193 run Perl interpreters. This should be called only once, before creating
3194 any Perl interpreters.
3196 =for apidoc Am|void|PERL_SYS_TERM|
3197 Provides system-specific clean up of the C runtime environment after
3198 running Perl interpreters. This should be called only once, after
3199 freeing any remaining Perl interpreters.
3204 #define PERL_SYS_INIT(argc, argv) Perl_sys_init(argc, argv)
3205 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
3206 #define PERL_SYS_TERM() Perl_sys_term()
3208 #ifndef PERL_WRITE_MSG_TO_CONSOLE
3209 # define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
3214 # ifdef _POSIX_PATH_MAX
3215 # if PATH_MAX > _POSIX_PATH_MAX
3216 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
3217 * included the null byte or not. Later amendments of POSIX,
3218 * XPG4, the Austin Group, and the Single UNIX Specification
3219 * all explicitly include the null byte in the PATH_MAX.
3220 * Ditto for _POSIX_PATH_MAX. */
3221 # define MAXPATHLEN PATH_MAX
3223 # define MAXPATHLEN _POSIX_PATH_MAX
3226 # define MAXPATHLEN (PATH_MAX+1)
3229 # define MAXPATHLEN 1024 /* Err on the large side. */
3233 /* clang Thread Safety Analysis/Annotations/Attributes
3234 * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
3236 * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
3237 * Apple XCode hijacks __clang_major__ and __clang_minor__
3238 * (6.1 means really clang 3.6), so needs extra hijinks
3239 * (could probably also test the contents of __apple_build_version__).
3241 #if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
3242 defined(__clang__) && \
3244 ((!defined(__apple_build_version__) && \
3245 ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
3246 (__clang_major__ >= 4))) || \
3247 (defined(__apple_build_version__) && \
3248 ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
3249 (__clang_major__ >= 7))))
3250 # define PERL_TSA__(x) __attribute__((x))
3251 # define PERL_TSA_ACTIVE
3253 # define PERL_TSA__(x) /* No TSA, make TSA attributes no-ops. */
3254 # undef PERL_TSA_ACTIVE
3257 /* PERL_TSA_CAPABILITY() is used to annotate typedefs.
3258 * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
3260 #define PERL_TSA_CAPABILITY(x) \
3261 PERL_TSA__(capability(x))
3263 /* In the below examples the mutex must be lexically visible, usually
3264 * either as global variables, or as function arguments. */
3266 /* PERL_TSA_GUARDED_BY() is used to annotate global variables.
3268 * Foo foo PERL_TSA_GUARDED_BY(mutex);
3270 #define PERL_TSA_GUARDED_BY(x) \
3271 PERL_TSA__(guarded_by(x))
3273 /* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
3274 * The data _behind_ the pointer is guarded.
3276 * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
3278 #define PERL_TSA_PT_GUARDED_BY(x) \
3279 PERL_TSA__(pt_guarded_by(x))
3281 /* PERL_TSA_REQUIRES() is used to annotate functions.
3282 * The caller MUST hold the resource when calling the function.
3284 * void Foo() PERL_TSA_REQUIRES(mutex);
3286 #define PERL_TSA_REQUIRES(x) \
3287 PERL_TSA__(requires_capability(x))
3289 /* PERL_TSA_EXCLUDES() is used to annotate functions.
3290 * The caller MUST NOT hold resource when calling the function.
3292 * EXCLUDES should be used when the function first acquires
3293 * the resource and then releases it. Use to avoid deadlock.
3295 * void Foo() PERL_TSA_EXCLUDES(mutex);
3297 #define PERL_TSA_EXCLUDES(x) \
3298 PERL_TSA__(locks_excluded(x))
3300 /* PERL_TSA_ACQUIRE() is used to annotate functions.
3301 * The caller MUST NOT hold the resource when calling the function,
3302 * and the function will acquire the resource.
3304 * void Foo() PERL_TSA_ACQUIRE(mutex);
3306 #define PERL_TSA_ACQUIRE(x) \
3307 PERL_TSA__(acquire_capability(x))
3309 /* PERL_TSA_RELEASE() is used to annotate functions.
3310 * The caller MUST hold the resource when calling the function,
3311 * and the function will release the resource.
3313 * void Foo() PERL_TSA_RELEASE(mutex);
3315 #define PERL_TSA_RELEASE(x) \
3316 PERL_TSA__(release_capability(x))
3318 /* PERL_TSA_NO_TSA is used to annotate functions.
3319 * Used when being intentionally unsafe, or when the code is too
3320 * complicated for the analysis. Use sparingly.
3322 * void Foo() PERL_TSA_NO_TSA;
3324 #define PERL_TSA_NO_TSA \
3325 PERL_TSA__(no_thread_safety_analysis)
3327 /* There are more annotations/attributes available, see the clang
3328 * documentation for details. */
3330 #if defined(USE_ITHREADS)
3332 # include <nw5thread.h>
3333 # elif defined(WIN32)
3334 # include <win32thread.h>
3336 # include "os2thread.h"
3337 # elif defined(I_MACH_CTHREADS)
3338 # include <mach/cthreads.h>
3339 typedef cthread_t perl_os_thread;
3340 typedef mutex_t perl_mutex;
3341 typedef condition_t perl_cond;
3342 typedef void * perl_key;
3343 # elif defined(I_PTHREAD) /* Posix threads */
3344 # include <pthread.h>
3345 typedef pthread_t perl_os_thread;
3346 typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
3347 typedef pthread_cond_t perl_cond;
3348 typedef pthread_key_t perl_key;
3350 #endif /* USE_ITHREADS */
3352 #ifdef PERL_TSA_ACTIVE
3353 /* Since most pthread mutex interfaces have not been annotated, we
3354 * need to have these wrappers. The NO_TSA annotation is quite ugly
3355 * but it cannot be avoided in plain C, unlike in C++, where one could
3356 * e.g. use ACQUIRE() with no arg on a mutex lock method.
3358 * The bodies of these wrappers are in util.c
3360 * TODO: however, some platforms are starting to get these clang
3361 * thread safety annotations for pthreads, for example FreeBSD.
3362 * Do we need a way to a bypass these wrappers? */
3363 EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
3364 PERL_TSA_ACQUIRE(*mutex)
3366 EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
3367 PERL_TSA_RELEASE(*mutex)
3376 # include "netware.h"
3379 #define STATUS_UNIX PL_statusvalue
3381 # define STATUS_NATIVE PL_statusvalue_vms
3383 * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
3384 * its contents can not be trusted. Unfortunately, Perl seems to check
3385 * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
3388 # include <stsdef.h>
3390 /* Presume this because if VMS changes it, it will require a new
3391 * set of APIs for waiting on children for binary compatibility.
3393 # define child_offset_bits (8)
3394 # ifndef C_FAC_POSIX
3395 # define C_FAC_POSIX 0x35A000
3398 /* STATUS_EXIT - validates and returns a NATIVE exit status code for the
3399 * platform from the existing UNIX or Native status values.
3402 # define STATUS_EXIT \
3403 (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
3404 (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
3407 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
3408 * exit code and shifts the UNIX value over the correct number of bits to
3409 * be a child status. Usually the number of bits is 8, but that could be
3410 * platform dependent. The NATIVE status code is presumed to have either
3411 * from a child process.
3414 /* This is complicated. The child processes return a true native VMS
3415 status which must be saved. But there is an assumption in Perl that
3416 the UNIX child status has some relationship to errno values, so
3417 Perl tries to translate it to text in some of the tests.
3418 In order to get the string translation correct, for the error, errno
3419 must be EVMSERR, but that generates a different text message
3420 than what the test programs are expecting. So an errno value must
3421 be derived from the native status value when an error occurs.
3422 That will hide the true native status message. With this version of
3423 perl, the true native child status can always be retrieved so that
3424 is not a problem. But in this case, Pl_statusvalue and errno may
3425 have different values in them.
3428 # define STATUS_NATIVE_CHILD_SET(n) \
3430 I32 evalue = (I32)n; \
3431 if (evalue == EVMSERR) { \
3432 PL_statusvalue_vms = vaxc$errno; \
3433 PL_statusvalue = evalue; \
3435 PL_statusvalue_vms = evalue; \
3436 if (evalue == -1) { \
3437 PL_statusvalue = -1; \
3438 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3440 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1); \
3441 set_vaxc_errno(evalue); \
3442 if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX) \
3443 set_errno(EVMSERR); \
3444 else set_errno(Perl_vms_status_to_unix(evalue, 0)); \
3445 PL_statusvalue = PL_statusvalue << child_offset_bits; \
3449 # ifdef VMSISH_STATUS
3450 # define STATUS_CURRENT (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
3452 # define STATUS_CURRENT STATUS_UNIX
3455 /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3456 * the NATIVE status to an equivalent value. Can not be used to translate
3457 * exit code values as exit code values are not guaranteed to have any
3458 * relationship at all to errno values.
3459 * This is used when Perl is forcing errno to have a specific value.
3461 # define STATUS_UNIX_SET(n) \
3463 I32 evalue = (I32)n; \
3464 PL_statusvalue = evalue; \
3465 if (PL_statusvalue != -1) { \
3466 if (PL_statusvalue != EVMSERR) { \
3467 PL_statusvalue &= 0xFFFF; \
3468 if (MY_POSIX_EXIT) \
3469 PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3470 else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3473 PL_statusvalue_vms = vaxc$errno; \
3476 else PL_statusvalue_vms = SS$_ABORT; \
3477 set_vaxc_errno(PL_statusvalue_vms); \
3480 /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
3481 * the NATIVE error status based on it.
3483 * When in the default mode to comply with the Perl VMS documentation,
3484 * 0 is a success and any other code sets the NATIVE status to a failure
3485 * code of SS$_ABORT.
3487 * In the new POSIX EXIT mode, native status will be set so that the
3488 * actual exit code will can be retrieved by the calling program or
3491 * If the exit code is not clearly a UNIX parent or child exit status,
3492 * it will be passed through as a VMS status.
3495 # define STATUS_UNIX_EXIT_SET(n) \
3497 I32 evalue = (I32)n; \
3498 PL_statusvalue = evalue; \
3499 if (MY_POSIX_EXIT) { \
3500 if (evalue <= 0xFF00) { \
3501 if (evalue > 0xFF) \
3502 evalue = (evalue >> child_offset_bits) & 0xFF; \
3503 PL_statusvalue_vms = \
3504 (C_FAC_POSIX | (evalue << 3 ) | \
3505 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3506 } else /* forgive them Perl, for they have sinned */ \
3507 PL_statusvalue_vms = evalue; \
3510 PL_statusvalue_vms = SS$_NORMAL; \
3511 else if (evalue <= 0xFF00) \
3512 PL_statusvalue_vms = SS$_ABORT; \
3513 else { /* forgive them Perl, for they have sinned */ \
3514 if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3515 else PL_statusvalue_vms = vaxc$errno; \
3516 /* And obviously used a VMS status value instead of UNIX */ \
3517 PL_statusvalue = EVMSERR; \
3519 set_vaxc_errno(PL_statusvalue_vms); \
3524 /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3525 * and sets the NATIVE error status based on it. This special case
3526 * is needed to maintain compatibility with past VMS behavior.
3528 * In the default mode on VMS, this number is passed through as
3529 * both the NATIVE and UNIX status. Which makes it different
3530 * that the STATUS_UNIX_EXIT_SET.
3532 * In the new POSIX EXIT mode, native status will be set so that the
3533 * actual exit code will can be retrieved by the calling program or
3536 * A POSIX exit code is from 0 to 255. If the exit code is higher
3537 * than this, it needs to be assumed that it is a VMS exit code and
3541 # define STATUS_EXIT_SET(n) \
3543 I32 evalue = (I32)n; \
3544 PL_statusvalue = evalue; \
3545 if (MY_POSIX_EXIT) \
3546 if (evalue > 255) PL_statusvalue_vms = evalue; else { \
3547 PL_statusvalue_vms = \
3548 (C_FAC_POSIX | (evalue << 3 ) | \
3549 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
3551 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3552 set_vaxc_errno(PL_statusvalue_vms); \
3556 /* This macro forces a success status */
3557 # define STATUS_ALL_SUCCESS \
3558 (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
3560 /* This macro forces a failure status */
3561 # define STATUS_ALL_FAILURE (PL_statusvalue = 1, \
3562 vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3563 (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3565 #elif defined(__amigaos4__)
3566 /* A somewhat experimental attempt to simulate posix return code values */
3567 # define STATUS_NATIVE PL_statusvalue_posix
3568 # define STATUS_NATIVE_CHILD_SET(n) \
3570 PL_statusvalue_posix = (n); \
3571 if (PL_statusvalue_posix < 0) { \
3572 PL_statusvalue = -1; \
3575 PL_statusvalue = n << 8; \
3578 # define STATUS_UNIX_SET(n) \
3580 PL_statusvalue = (n); \
3581 if (PL_statusvalue != -1) \
3582 PL_statusvalue &= 0xFFFF; \
3584 # define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3585 # define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3586 # define STATUS_CURRENT STATUS_UNIX
3587 # define STATUS_EXIT STATUS_UNIX
3588 # define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3589 # define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3592 # define STATUS_NATIVE PL_statusvalue_posix
3593 # if defined(WCOREDUMP)
3594 # define STATUS_NATIVE_CHILD_SET(n) \
3596 PL_statusvalue_posix = (n); \
3597 if (PL_statusvalue_posix == -1) \
3598 PL_statusvalue = -1; \
3601 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
3602 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3603 (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0); \
3606 # elif defined(WIFEXITED)
3607 # define STATUS_NATIVE_CHILD_SET(n) \
3609 PL_statusvalue_posix = (n); \
3610 if (PL_statusvalue_posix == -1) \
3611 PL_statusvalue = -1; \
3614 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
3615 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0); \
3619 # define STATUS_NATIVE_CHILD_SET(n) \
3621 PL_statusvalue_posix = (n); \
3622 if (PL_statusvalue_posix == -1) \
3623 PL_statusvalue = -1; \
3626 PL_statusvalue_posix & 0xFFFF; \
3630 # define STATUS_UNIX_SET(n) \
3632 PL_statusvalue = (n); \
3633 if (PL_statusvalue != -1) \
3634 PL_statusvalue &= 0xFFFF; \
3636 # define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3637 # define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3638 # define STATUS_CURRENT STATUS_UNIX
3639 # define STATUS_EXIT STATUS_UNIX
3640 # define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3641 # define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3644 /* flags in PL_exit_flags for nature of exit() */
3645 #define PERL_EXIT_EXPECTED 0x01
3646 #define PERL_EXIT_DESTRUCT_END 0x02 /* Run END in perl_destruct */
3647 #define PERL_EXIT_WARN 0x04 /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3648 #define PERL_EXIT_ABORT 0x08 /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3651 /* format to use for version numbers in file/directory names */
3652 /* XXX move to Configure? */
3653 /* This was only ever used for the current version, and that can be done at
3654 compile time, as PERL_FS_VERSION, so should we just delete it? */
3655 # ifndef PERL_FS_VER_FMT
3656 # define PERL_FS_VER_FMT "%d.%d.%d"
3660 #ifndef PERL_FS_VERSION
3661 # define PERL_FS_VERSION PERL_VERSION_STRING
3664 /* This defines a way to flush all output buffers. This may be a
3665 * performance issue, so we allow people to disable it. Also, if
3666 * we are using stdio, there are broken implementations of fflush(NULL)
3667 * out there, Solaris being the most prominent.
3669 #ifndef PERL_FLUSHALL_FOR_CHILD
3670 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3671 # define PERL_FLUSHALL_FOR_CHILD PerlIO_flush((PerlIO*)NULL)
3672 # elif defined(FFLUSH_ALL)
3673 # define PERL_FLUSHALL_FOR_CHILD my_fflush_all()
3675 # define PERL_FLUSHALL_FOR_CHILD NOOP
3679 #ifndef PERL_WAIT_FOR_CHILDREN
3680 # define PERL_WAIT_FOR_CHILDREN NOOP
3683 /* the traditional thread-unsafe notion of "current interpreter". */
3684 #ifndef PERL_SET_INTERP
3685 # define PERL_SET_INTERP(i) (PL_curinterp = (PerlInterpreter*)(i))
3688 #ifndef PERL_GET_INTERP
3689 # define PERL_GET_INTERP (PL_curinterp)
3692 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3693 # ifdef MULTIPLICITY
3694 # define PERL_GET_THX ((PerlInterpreter *)PERL_GET_CONTEXT)
3696 # define PERL_SET_THX(t) PERL_SET_CONTEXT(t)
3700 This replaces the previous %_ "hack" by the "%p" hacks.
3701 All that is required is that the perl source does not
3702 use "%-p" or "%-<number>p" or "%<number>p" formats.
3703 These formats will still work in perl code.
3704 See comments in sv.c for further details.
3706 Robin Barker 2005-07-14
3708 No longer use %1p for VDf = %vd. RMB 2007-10-19
3712 # define SVf_(n) "-" STRINGIFY(n) "p"
3720 # define SVf32 SVf_(32)
3724 # define SVf256 SVf_(256)
3727 #define SVfARG(p) ((void*)(p))
3733 /* Not ideal, but we cannot easily include a number in an already-numeric
3734 * format sequence. */
3736 # define HEKf256 "3p"
3739 #define HEKfARG(p) ((void*)(p))
3741 /* Documented in perlguts
3743 * %4p is a custom format
3746 # define UTF8f "d%" UVuf "%4p"
3748 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3751 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
3754 /* not used; but needed for backward compatibility with XS code? - RMB */
3760 #if !defined(DEBUGGING) && !defined(NDEBUG)
3765 /* For functions that are marked as __attribute__noreturn__, it's not
3766 appropriate to call return. In either case, include the lint directive.
3768 #ifdef HASATTRIBUTE_NORETURN
3769 # define NORETURN_FUNCTION_END NOT_REACHED;
3771 # define NORETURN_FUNCTION_END NOT_REACHED; return 0
3774 #ifdef HAS_BUILTIN_EXPECT
3775 # define EXPECT(expr,val) __builtin_expect(expr,val)
3777 # define EXPECT(expr,val) (expr)
3781 =for apidoc_section $directives
3783 =for apidoc Am||LIKELY|bool expr
3785 Returns the input unchanged, but at the same time it gives a branch prediction
3786 hint to the compiler that this condition is likely to be true.
3788 =for apidoc Am||UNLIKELY|bool expr
3790 Returns the input unchanged, but at the same time it gives a branch prediction
3791 hint to the compiler that this condition is likely to be false.
3795 #define LIKELY(cond) EXPECT(cBOOL(cond),TRUE)
3796 #define UNLIKELY(cond) EXPECT(cBOOL(cond),FALSE)
3798 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3802 /* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
3803 time invariants. That is, their argument must be a constant expression that
3804 can be verified by the compiler. This expression can contain anything that's
3805 known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3806 the expression evaluates to 0, compilation fails.
3807 Because they generate no runtime code (i.e. their use is "free"), they're
3808 always active, even under non-DEBUGGING builds.
3809 STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
3810 file scope (outside of any function).
3811 STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3814 #if (! defined(__IBMC__) || __IBMC__ >= 1210) \
3815 && (( defined(static_assert) && ( defined(_ISOC11_SOURCE) \
3816 || (__STDC_VERSION__ - 0) >= 201101L)) \
3817 || (defined(__cplusplus) && __cplusplus >= 201103L))
3818 /* XXX static_assert is a macro defined in <assert.h> in C11 or a compiler
3819 builtin in C++11. But IBM XL C V11 does not support _Static_assert, no
3820 matter what <assert.h> says.
3822 # define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
3824 /* We use a bit-field instead of an array because gcc accepts
3825 'typedef char x[n]' where n is not a compile-time constant.
3826 We want to enforce constantness.
3828 # define STATIC_ASSERT_2(COND, SUFFIX) \
3830 unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3831 } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3832 # define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
3833 # define STATIC_ASSERT_DECL(COND) STATIC_ASSERT_1(COND, __LINE__)
3835 /* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3836 error (static_assert is a declaration, and only statements can have labels).
3838 #define STATIC_ASSERT_STMT(COND) STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
3840 #ifndef __has_builtin
3841 # define __has_builtin(x) 0 /* not a clang style compiler */
3845 =for apidoc Am||ASSUME|bool expr
3846 C<ASSUME> is like C<assert()>, but it has a benefit in a release build. It is a
3847 hint to a compiler about a statement of fact in a function call free
3848 expression, which allows the compiler to generate better machine code. In a
3849 debug build, C<ASSUME(x)> is a synonym for C<assert(x)>. C<ASSUME(0)> means the
3850 control path is unreachable. In a for loop, C<ASSUME> can be used to hint that
3851 a loop will run at least X times. C<ASSUME> is based off MSVC's C<__assume>
3852 intrinsic function, see its documents for more details.
3858 # define ASSUME(x) assert(x)
3859 # if __has_builtin(__builtin_unreachable)
3860 # define HAS_BUILTIN_UNREACHABLE
3861 # elif (defined(__GNUC__) && ( __GNUC__ > 4 \
3862 || __GNUC__ == 4 && __GNUC_MINOR__ >= 5))
3863 # define HAS_BUILTIN_UNREACHABLE
3867 #if defined(__sun) || (defined(__hpux) && !defined(__GNUC__))
3869 # define ASSUME(x) /* ASSUME() generates warnings on Solaris */
3871 # define NOT_REACHED
3872 #elif defined(HAS_BUILTIN_UNREACHABLE)
3874 # define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3876 # define NOT_REACHED \
3878 ASSUME(!"UNREACHABLE"); __builtin_unreachable(); \
3881 # if defined(_MSC_VER)
3882 # define ASSUME(x) __assume(x)
3883 # elif defined(__ARMCC_VERSION) /* untested */
3884 # define ASSUME(x) __promise(x)
3886 /* a random compiler might define assert to its own special optimization
3887 * token so pass it through to C lib as a last resort */
3888 # define ASSUME(x) assert(x)
3890 # define NOT_REACHED ASSUME(!"UNREACHABLE")
3892 #undef HAS_BUILTIN_UNREACHABLE
3894 /* Some unistd.h's give a prototype for pause() even though
3895 HAS_PAUSE ends up undefined. This causes the #define
3896 below to be rejected by the compiler. Sigh.
3901 #define Pause() sleep((32767<<16)+32767)
3905 # ifdef IOCPARM_MASK
3906 /* on BSDish systems we're safe */
3907 # define IOCPARM_LEN(x) (((x) >> 16) & IOCPARM_MASK)
3908 # elif defined(_IOC_SIZE) && defined(__GLIBC__)
3909 /* on Linux systems we're safe; except when we're not [perl #38223] */
3910 # define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3912 /* otherwise guess at what's safe */
3913 # define IOCPARM_LEN(x) 256
3917 #if defined(__CYGWIN__)
3919 * This symbol, if defined, indicates that the program should
3920 * use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3921 * that a file is in "binary" mode -- that is, that no translation
3922 * of bytes occurs on read or write operations.
3924 # define USEMYBINMODE /**/
3925 # include <io.h> /* for setmode() prototype */
3926 # define my_binmode(fp, iotype, mode) \
3927 cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
3931 void init_os_extras(void);
3934 #ifdef UNION_ANY_DEFINITION
3935 UNION_ANY_DEFINITION;
3953 void (*any_dptr) (void*);
3954 void (*any_dxptr) (pTHX_ void*);
3958 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3960 #define FILTER_READ(idx, sv, len) filter_read(idx, sv, len)
3961 #define FILTER_DATA(idx) \
3962 (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3963 #define FILTER_ISREADER(idx) \
3964 (PL_parser && PL_parser->rsfp_filters \
3965 && idx >= AvFILLp(PL_parser->rsfp_filters))
3966 #define PERL_FILTER_EXISTS(i) \
3967 (PL_parser && PL_parser->rsfp_filters \
3968 && (Size_t) (i) < av_count(PL_parser->rsfp_filters))
3970 #if defined(_AIX) && !defined(_AIX43)
3971 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3972 /* We cannot include <crypt.h> to get the struct crypt_data
3973 * because of setkey prototype problems when threading */
3974 typedef struct crypt_data { /* straight from /usr/include/crypt.h */
3975 /* From OSF, Not needed in AIX
3983 #endif /* threading */
3986 #ifndef PERL_CALLCONV
3988 # define PERL_CALLCONV EXTERN_C
3990 # define PERL_CALLCONV
3993 #ifndef PERL_CALLCONV_NO_RET
3994 # define PERL_CALLCONV_NO_RET PERL_CALLCONV
3997 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
3998 dont have a noreturn as a declaration specifier
4000 #ifndef PERL_STATIC_NO_RET
4001 # define PERL_STATIC_NO_RET STATIC
4004 /* PERL_STATIC_INLINE_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE
4005 * on builds that dont have a noreturn as a declaration specifier
4007 #ifndef PERL_STATIC_INLINE_NO_RET
4008 # define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
4011 #ifndef PERL_STATIC_FORCE_INLINE
4012 # define PERL_STATIC_FORCE_INLINE PERL_STATIC_INLINE
4015 #ifndef PERL_STATIC_FORCE_INLINE_NO_RET
4016 # define PERL_STATIC_FORCE_INLINE_NO_RET PERL_STATIC_INLINE
4020 # include "iperlsys.h"
4023 #ifdef __LIBCATAMOUNT__
4024 #undef HAS_PASSWD /* unixish.h but not unixish enough. */
4026 #define FAKE_BIT_BUCKET
4029 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
4030 * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
4031 * Configure, despite their names being similar to other defines like
4032 * USE_ITHREADS. Configure in fact knows nothing about the randomised
4033 * hashes. Therefore to enable/disable the hash randomisation defines
4034 * use the Configure -Accflags=... instead. */
4035 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
4036 # define USE_HASH_SEED
4042 /* macros to define bit-fields in structs. */
4043 #ifndef PERL_BITFIELD8
4044 # define PERL_BITFIELD8 U8
4046 #ifndef PERL_BITFIELD16
4047 # define PERL_BITFIELD16 U16
4049 #ifndef PERL_BITFIELD32
4050 # define PERL_BITFIELD32 U32
4060 #include "opnames.h"
4067 #include "warnings.h"
4070 /* these would be in doio.h if there was such a file */
4071 #define my_stat() my_stat_flags(SV_GMAGIC)
4072 #define my_lstat() my_lstat_flags(SV_GMAGIC)
4074 /* defined in sv.c, but also used in [ach]v.c */
4077 #undef _XPVCV_COMMON
4081 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
4083 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C) \
4084 || defined(PERL_EXT_RE_BUILD)
4086 /* These have to be predeclared, as they are used in proto.h which is #included
4087 * before their definitions in regcomp.h. */
4090 typedef struct regnode_charclass regnode_charclass;
4092 /* A hopefully less confusing name. The sub-classes are all Posix classes only
4093 * used under /l matching */
4094 typedef struct regnode_charclass_posixl regnode_charclass_class;
4095 typedef struct regnode_charclass_posixl regnode_charclass_posixl;
4097 typedef struct regnode_ssc regnode_ssc;
4098 typedef struct RExC_state_t RExC_state_t;
4099 struct _reg_trie_data;
4103 struct ptr_tbl_ent {
4104 struct ptr_tbl_ent* next;
4110 struct ptr_tbl_ent** tbl_ary;
4113 struct ptr_tbl_arena *tbl_arena;
4114 struct ptr_tbl_ent *tbl_arena_next;
4115 struct ptr_tbl_ent *tbl_arena_end;
4118 #if defined(htonl) && !defined(HAS_HTONL)
4121 #if defined(htons) && !defined(HAS_HTONS)
4124 #if defined(ntohl) && !defined(HAS_NTOHL)
4127 #if defined(ntohs) && !defined(HAS_NTOHS)
4135 # if (BYTEORDER & 0xffff) == 0x4321
4136 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
4137 re-order their values. However, to behave identically to the alternative
4138 implementations, they should truncate to the correct size. */
4139 # define ntohl(x) ((x)&0xFFFFFFFF)
4140 # define htonl(x) ntohl(x)
4141 # define ntohs(x) ((x)&0xFFFF)
4142 # define htons(x) ntohs(x)
4143 # elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
4145 /* Note that we can't straight out declare our own htonl and htons because
4146 the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
4147 to avoid the overhead of initialising the socket subsystem, but the headers
4148 that *declare* the various functions are still seen. If we declare our own
4149 htonl etc they will clash with the declarations in the Win32 headers. */
4151 PERL_STATIC_INLINE U32
4152 my_swap32(const U32 x) {
4153 return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)
4154 | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
4157 PERL_STATIC_INLINE U16
4158 my_swap16(const U16 x) {
4159 return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
4162 # define htonl(x) my_swap32(x)
4163 # define ntohl(x) my_swap32(x)
4164 # define ntohs(x) my_swap16(x)
4165 # define htons(x) my_swap16(x)
4167 # error "Unsupported byteorder"
4168 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
4169 the error message. Please check the value of the macro BYTEORDER, as defined
4170 in config.h. The values of BYTEORDER we expect are
4172 big endian little endian
4173 32 bit 0x4321 0x1234
4174 64 bit 0x87654321 0x12345678
4176 If you have a system with a different byte order, please see
4177 pod/perlhack.pod for how to submit a patch to add supporting code.
4183 * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
4186 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
4187 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
4188 re-order their values. However, to behave identically to the alternative
4189 implementations, they should truncate to the correct size. */
4190 # define vtohl(x) ((x)&0xFFFFFFFF)
4191 # define vtohs(x) ((x)&0xFFFF)
4192 # define htovl(x) vtohl(x)
4193 # define htovs(x) vtohs(x)
4194 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
4195 # define vtohl(x) ((((x)&0xFF)<<24) \
4197 +(((x)&0x0000FF00)<<8) \
4198 +(((x)&0x00FF0000)>>8) )
4199 # define vtohs(x) ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
4200 # define htovl(x) vtohl(x)
4201 # define htovs(x) vtohs(x)
4203 # error "Unsupported byteorder"
4204 /* If you have need for current perl on PDP-11 or similar, and can help test
4205 that blead keeps working on a mixed-endian system, then see
4206 pod/perlhack.pod for how to submit patches to things working again. */
4209 /* *MAX Plus 1. A floating point value.
4210 Hopefully expressed in a way that dodgy floating point can't mess up.
4211 >> 2 rather than 1, so that value is safely less than I32_MAX after 1
4213 May find that some broken compiler will want the value cast to I32.
4214 [after the shift, as signed >> may not be as secure as unsigned >>]
4216 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
4217 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
4218 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
4219 0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
4220 may be greater than sizeof(IV), so don't assume that half max UV is max IV.
4222 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
4224 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
4225 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
4226 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
4228 /* This may look like unnecessary jumping through hoops, but converting
4229 out of range floating point values to integers *is* undefined behaviour,
4230 and it is starting to bite.
4232 =for apidoc_section $casting
4233 =for apidoc Am|I32|I_32|NV what
4234 Cast an NV to I32 while avoiding undefined C behavior
4236 =for apidoc Am|U32|U_32|NV what
4237 Cast an NV to U32 while avoiding undefined C behavior
4239 =for apidoc Am|IV|I_V|NV what
4240 Cast an NV to IV while avoiding undefined C behavior
4242 =for apidoc Am|UV|U_V|NV what
4243 Cast an NV to UV while avoiding undefined C behavior
4248 #define I_32(what) (cast_i32((NV)(what)))
4249 #define U_32(what) (cast_ulong((NV)(what)))
4250 #define I_V(what) (cast_iv((NV)(what)))
4251 #define U_V(what) (cast_uv((NV)(what)))
4253 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
4254 : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
4255 : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
4256 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
4257 : ((n) < U32_MAX_P1 ? (U32) (n) \
4258 : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
4259 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
4260 : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
4261 : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
4262 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
4263 : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
4264 : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
4267 #define U_S(what) ((U16)U_32(what))
4268 #define U_I(what) ((unsigned int)U_32(what))
4269 #define U_L(what) U_32(what)
4272 =for apidoc_section $integer
4273 =for apidoc Amn|IV|IV_MAX
4274 The largest signed integer that fits in an IV on this platform.
4276 =for apidoc Amn|IV|IV_MIN
4277 The negative signed integer furthest away from 0 that fits in an IV on this
4280 =for apidoc Amn|UV|UV_MAX
4281 The largest unsigned integer that fits in a UV on this platform.
4283 =for apidoc Amn|UV|UV_MIN
4284 The smallest unsigned integer that fits in a UV on this platform. It should
4291 # ifndef Perl_signbit
4292 # define Perl_signbit signbit
4296 /* These do not care about the fractional part, only about the range. */
4297 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
4298 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
4300 /* Used with UV/IV arguments: */
4301 /* XXXX: need to speed it up */
4302 #define CLUMP_2UV(iv) ((iv) < 0 ? 0 : (UV)(iv))
4303 #define CLUMP_2IV(uv) ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
4311 Uid_t getuid (void);
4312 Uid_t geteuid (void);
4313 Gid_t getgid (void);
4314 Gid_t getegid (void);
4318 #ifndef Perl_debug_log
4319 # define Perl_debug_log PerlIO_stderr()
4322 #ifndef Perl_error_log
4323 # define Perl_error_log (PL_stderrgv \
4324 && isGV(PL_stderrgv) \
4325 && GvIOp(PL_stderrgv) \
4326 && IoOFP(GvIOp(PL_stderrgv)) \
4327 ? IoOFP(GvIOp(PL_stderrgv)) \
4332 #define DEBUG_p_FLAG 0x00000001 /* 1 */
4333 #define DEBUG_s_FLAG 0x00000002 /* 2 */
4334 #define DEBUG_l_FLAG 0x00000004 /* 4 */
4335 #define DEBUG_t_FLAG 0x00000008 /* 8 */
4336 #define DEBUG_o_FLAG 0x00000010 /* 16 */
4337 #define DEBUG_c_FLAG 0x00000020 /* 32 */
4338 #define DEBUG_P_FLAG 0x00000040 /* 64 */
4339 #define DEBUG_m_FLAG 0x00000080 /* 128 */
4340 #define DEBUG_f_FLAG 0x00000100 /* 256 */
4341 #define DEBUG_r_FLAG 0x00000200 /* 512 */
4342 #define DEBUG_x_FLAG 0x00000400 /* 1024 */
4343 #define DEBUG_u_FLAG 0x00000800 /* 2048 */
4344 /* U is reserved for Unofficial, exploratory hacking */
4345 #define DEBUG_U_FLAG 0x00001000 /* 4096 */
4347 #define DEBUG_X_FLAG 0x00004000 /* 16384 */
4348 #define DEBUG_D_FLAG 0x00008000 /* 32768 */
4349 #define DEBUG_S_FLAG 0x00010000 /* 65536 */
4350 #define DEBUG_T_FLAG 0x00020000 /* 131072 */
4351 #define DEBUG_R_FLAG 0x00040000 /* 262144 */
4352 #define DEBUG_J_FLAG 0x00080000 /* 524288 */
4353 #define DEBUG_v_FLAG 0x00100000 /*1048576 */
4354 #define DEBUG_C_FLAG 0x00200000 /*2097152 */
4355 #define DEBUG_A_FLAG 0x00400000 /*4194304 */
4356 #define DEBUG_q_FLAG 0x00800000 /*8388608 */
4357 #define DEBUG_M_FLAG 0x01000000 /*16777216*/
4358 #define DEBUG_B_FLAG 0x02000000 /*33554432*/
4359 #define DEBUG_L_FLAG 0x04000000 /*67108864*/
4360 #define DEBUG_i_FLAG 0x08000000 /*134217728*/
4361 #define DEBUG_y_FLAG 0x10000000 /*268435456*/
4362 #define DEBUG_MASK 0x1FFFEFFF /* mask of all the standard flags */
4364 #define DEBUG_DB_RECURSE_FLAG 0x40000000
4365 #define DEBUG_TOP_FLAG 0x80000000 /* -D was given --> PL_debug |= FLAG */
4367 # define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
4368 # define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
4369 # define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
4370 # define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
4371 # define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
4372 # define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
4373 # define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
4374 # define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
4375 # define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
4376 # define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
4377 # define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
4378 # define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
4379 # define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
4380 # define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
4381 # define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
4382 # define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
4383 # define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
4384 # define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
4385 # define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
4386 # define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
4387 # define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
4388 # define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
4389 # define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
4390 # define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
4391 # define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
4392 # define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
4393 # define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
4394 # define DEBUG_y_TEST_ UNLIKELY(PL_debug & DEBUG_y_FLAG)
4395 # define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
4396 # define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
4397 # define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
4398 # define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
4399 # define DEBUG_yv_TEST_ (DEBUG_y_TEST_ && DEBUG_v_TEST_)
4403 # define DEBUG_p_TEST DEBUG_p_TEST_
4404 # define DEBUG_s_TEST DEBUG_s_TEST_
4405 # define DEBUG_l_TEST DEBUG_l_TEST_
4406 # define DEBUG_t_TEST DEBUG_t_TEST_
4407 # define DEBUG_o_TEST DEBUG_o_TEST_
4408 # define DEBUG_c_TEST DEBUG_c_TEST_
4409 # define DEBUG_P_TEST DEBUG_P_TEST_
4410 # define DEBUG_m_TEST DEBUG_m_TEST_
4411 # define DEBUG_f_TEST DEBUG_f_TEST_
4412 # define DEBUG_r_TEST DEBUG_r_TEST_
4413 # define DEBUG_x_TEST DEBUG_x_TEST_
4414 # define DEBUG_u_TEST DEBUG_u_TEST_
4415 # define DEBUG_U_TEST DEBUG_U_TEST_
4416 # define DEBUG_X_TEST DEBUG_X_TEST_
4417 # define DEBUG_D_TEST DEBUG_D_TEST_
4418 # define DEBUG_S_TEST DEBUG_S_TEST_
4419 # define DEBUG_T_TEST DEBUG_T_TEST_
4420 # define DEBUG_R_TEST DEBUG_R_TEST_
4421 # define DEBUG_J_TEST DEBUG_J_TEST_
4422 # define DEBUG_v_TEST DEBUG_v_TEST_
4423 # define DEBUG_C_TEST DEBUG_C_TEST_
4424 # define DEBUG_A_TEST DEBUG_A_TEST_
4425 # define DEBUG_q_TEST DEBUG_q_TEST_
4426 # define DEBUG_M_TEST DEBUG_M_TEST_
4427 # define DEBUG_B_TEST DEBUG_B_TEST_
4428 # define DEBUG_L_TEST DEBUG_L_TEST_
4429 # define DEBUG_i_TEST DEBUG_i_TEST_
4430 # define DEBUG_y_TEST DEBUG_y_TEST_
4431 # define DEBUG_Xv_TEST DEBUG_Xv_TEST_
4432 # define DEBUG_Uv_TEST DEBUG_Uv_TEST_
4433 # define DEBUG_Pv_TEST DEBUG_Pv_TEST_
4434 # define DEBUG_Lv_TEST DEBUG_Lv_TEST_
4435 # define DEBUG_yv_TEST DEBUG_yv_TEST_
4437 # define PERL_DEB(a) a
4438 # define PERL_DEB2(a,b) a
4439 # define PERL_DEBUG(a) if (PL_debug) a
4440 # define DEBUG_p(a) if (DEBUG_p_TEST) a
4441 # define DEBUG_s(a) if (DEBUG_s_TEST) a
4442 # define DEBUG_l(a) if (DEBUG_l_TEST) a
4443 # define DEBUG_t(a) if (DEBUG_t_TEST) a
4444 # define DEBUG_o(a) if (DEBUG_o_TEST) a
4445 # define DEBUG_c(a) if (DEBUG_c_TEST) a
4446 # define DEBUG_P(a) if (DEBUG_P_TEST) a
4448 /* Temporarily turn off memory debugging in case the a
4449 * does memory allocation, either directly or indirectly. */
4450 # define DEBUG_m(a) \
4452 if (PERL_GET_INTERP) { \
4454 if (DEBUG_m_TEST) { \
4455 PL_debug &= ~DEBUG_m_FLAG; \
4457 PL_debug |= DEBUG_m_FLAG; \
4462 # define DEBUG__(t, a) \
4464 if (t) STMT_START {a;} STMT_END; \
4467 # define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
4469 /* For re_comp.c, re_exec.c, assume -Dr has been specified */
4470 # ifdef PERL_EXT_RE_BUILD
4471 # define DEBUG_r(a) STMT_START {a;} STMT_END
4473 # define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
4474 # endif /* PERL_EXT_RE_BUILD */
4476 # define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
4477 # define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
4478 # define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
4479 # define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
4480 # define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
4481 # define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
4482 # define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
4483 # define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
4484 # define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
4485 # define DEBUG_yv(a) DEBUG__(DEBUG_yv_TEST, a)
4487 # define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
4488 # define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
4489 # define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
4490 # define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
4491 # define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
4492 # define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
4493 # define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
4494 # define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
4495 # define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
4496 # define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
4497 # define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
4498 # define DEBUG_y(a) DEBUG__(DEBUG_y_TEST, a)
4500 #else /* ! DEBUGGING below */
4502 # define DEBUG_p_TEST (0)
4503 # define DEBUG_s_TEST (0)
4504 # define DEBUG_l_TEST (0)
4505 # define DEBUG_t_TEST (0)
4506 # define DEBUG_o_TEST (0)
4507 # define DEBUG_c_TEST (0)
4508 # define DEBUG_P_TEST (0)
4509 # define DEBUG_m_TEST (0)
4510 # define DEBUG_f_TEST (0)
4511 # define DEBUG_r_TEST (0)
4512 # define DEBUG_x_TEST (0)
4513 # define DEBUG_u_TEST (0)
4514 # define DEBUG_U_TEST (0)
4515 # define DEBUG_X_TEST (0)
4516 # define DEBUG_D_TEST (0)
4517 # define DEBUG_S_TEST (0)
4518 # define DEBUG_T_TEST (0)
4519 # define DEBUG_R_TEST (0)
4520 # define DEBUG_J_TEST (0)
4521 # define DEBUG_v_TEST (0)
4522 # define DEBUG_C_TEST (0)
4523 # define DEBUG_A_TEST (0)
4524 # define DEBUG_q_TEST (0)
4525 # define DEBUG_M_TEST (0)
4526 # define DEBUG_B_TEST (0)
4527 # define DEBUG_L_TEST (0)
4528 # define DEBUG_i_TEST (0)
4529 # define DEBUG_y_TEST (0)
4530 # define DEBUG_Xv_TEST (0)
4531 # define DEBUG_Uv_TEST (0)
4532 # define DEBUG_Pv_TEST (0)
4533 # define DEBUG_Lv_TEST (0)
4534 # define DEBUG_yv_TEST (0)
4536 # define PERL_DEB(a)
4537 # define PERL_DEB2(a,b) b
4538 # define PERL_DEBUG(a)
4566 # define DEBUG_Xv(a)
4567 # define DEBUG_Uv(a)
4568 # define DEBUG_Pv(a)
4569 # define DEBUG_Lv(a)
4570 # define DEBUG_yv(a)
4571 #endif /* DEBUGGING */
4574 #define DEBUG_SCOPE(where) \
4576 Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n", \
4577 where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
4578 __FILE__, __LINE__));
4580 /* Keep the old croak based assert for those who want it, and as a fallback if
4581 the platform is so heretically non-ANSI that it can't assert. */
4583 #define Perl_assert(what) PERL_DEB2( \
4584 ((what) ? ((void) 0) : \
4585 (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
4586 "\", line %d", STRINGIFY(what), __LINE__), \
4587 (void) 0)), ((void)0))
4589 /* assert() gets defined if DEBUGGING.
4590 * If no DEBUGGING, the <assert.h> has not been included. */
4592 # define assert(what) Perl_assert(what)
4595 # define assert_(what) assert(what),
4597 # define assert_(what)
4601 I32 (*uf_val)(pTHX_ IV, SV*);
4602 I32 (*uf_set)(pTHX_ IV, SV*);
4606 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4607 * XS code wanting to be backward compatible can do something
4608 * like the following:
4610 #ifndef PERL_MG_UFUNC
4611 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4614 static PERL_MG_UFUNC(foo_get, index, val)
4624 #ifndef PERL_MG_UFUNC
4625 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4630 /* isfinite and others are here rather than in math.h as C99 stipulates */
4635 # if !defined(WIN32) && !defined(VMS)
4637 char *crypt (const char*, const char*);
4639 # endif /* !WIN32 */
4642 char *getlogin (void);
4644 # endif /* !WIN32 */
4645 #endif /* !__cplusplus */
4647 /* Fixme on VMS. This needs to be a run-time, not build time options */
4648 /* Also rename() is affected by this */
4649 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4650 #define UNLINK unlnk
4651 I32 unlnk (pTHX_ const char*);
4653 #define UNLINK PerlLIO_unlink
4656 /* some versions of glibc are missing the setresuid() proto */
4657 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4658 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4660 /* some versions of glibc are missing the setresgid() proto */
4661 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4662 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4665 #ifndef HAS_SETREUID
4666 # ifdef HAS_SETRESUID
4667 # define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4668 # define HAS_SETREUID
4671 #ifndef HAS_SETREGID
4672 # ifdef HAS_SETRESGID
4673 # define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4674 # define HAS_SETREGID
4678 /* Sighandler_t defined in iperlsys.h */
4680 #ifdef HAS_SIGACTION
4681 typedef struct sigaction Sigsave_t;
4683 typedef Sighandler_t Sigsave_t;
4694 # define RUNOPS_DEFAULT Perl_runops_debug
4696 # define RUNOPS_DEFAULT Perl_runops_standard
4699 #if defined(USE_PERLIO)
4700 EXTERN_C void PerlIO_teardown(void);
4701 # ifdef USE_ITHREADS
4702 # define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4703 # define PERLIO_TERM \
4705 PerlIO_teardown(); \
4706 MUTEX_DESTROY(&PL_perlio_mutex);\
4709 # define PERLIO_INIT
4710 # define PERLIO_TERM PerlIO_teardown()
4713 # define PERLIO_INIT
4714 # define PERLIO_TERM
4718 # ifdef MUTEX_INIT_CALLS_MALLOC
4719 # define MALLOC_INIT \
4721 PL_malloc_mutex = NULL; \
4722 MUTEX_INIT(&PL_malloc_mutex); \
4724 # define MALLOC_TERM \
4726 perl_mutex tmp = PL_malloc_mutex; \
4727 PL_malloc_mutex = NULL; \
4728 MUTEX_DESTROY(&tmp); \
4731 # define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4732 # define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4735 # define MALLOC_INIT
4736 # define MALLOC_TERM
4739 #if defined(PERL_IMPLICIT_CONTEXT)
4741 struct perl_memory_debug_header;
4742 struct perl_memory_debug_header {
4744 # if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4747 struct perl_memory_debug_header *prev;
4748 struct perl_memory_debug_header *next;
4749 # ifdef PERL_DEBUG_READONLY_COW
4754 #elif defined(PERL_DEBUG_READONLY_COW)
4756 struct perl_memory_debug_header;
4757 struct perl_memory_debug_header {
4763 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4765 # define PERL_MEMORY_DEBUG_HEADER_SIZE \
4766 (sizeof(struct perl_memory_debug_header) + \
4767 (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4768 %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4771 # define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4774 #ifdef PERL_TRACK_MEMPOOL
4775 # ifdef PERL_DEBUG_READONLY_COW
4776 # define INIT_TRACK_MEMPOOL(header, interp) \
4778 (header).interpreter = (interp); \
4779 (header).prev = (header).next = &(header); \
4780 (header).readonly = 0; \
4783 # define INIT_TRACK_MEMPOOL(header, interp) \
4785 (header).interpreter = (interp); \
4786 (header).prev = (header).next = &(header); \
4790 # define INIT_TRACK_MEMPOOL(header, interp)
4793 #ifdef I_MALLOCMALLOC
4794 /* Needed for malloc_size(), malloc_good_size() on some systems */
4795 # include <malloc/malloc.h>
4799 # define Perl_safesysmalloc_size(where) Perl_malloced_size(where)
4801 # if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4802 # ifdef PERL_TRACK_MEMPOOL
4803 # define Perl_safesysmalloc_size(where) \
4804 (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4806 # define Perl_safesysmalloc_size(where) malloc_size(where)
4809 # ifdef HAS_MALLOC_GOOD_SIZE
4810 # ifdef PERL_TRACK_MEMPOOL
4811 # define Perl_malloc_good_size(how_much) \
4812 (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4814 # define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4817 /* Having this as the identity operation makes some code simpler. */
4818 # define Perl_malloc_good_size(how_much) (how_much)
4822 typedef int (*runops_proc_t)(pTHX);
4823 typedef void (*share_proc_t) (pTHX_ SV *sv);
4824 typedef int (*thrhook_proc_t) (pTHX);
4825 typedef OP* (*PPADDR_t[]) (pTHX);
4826 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4827 typedef void (*despatch_signals_proc_t) (pTHX);
4829 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4830 # include <crt_externs.h> /* for the env array */
4831 # define environ (*_NSGetEnviron())
4832 #elif defined(USE_ENVIRON_ARRAY) && !defined(environ)
4833 /* VMS and some other platforms don't use the environ array */
4834 EXTERN_C char **environ; /* environment variables supplied via exec */
4837 #define PERL_PATCHLEVEL_H_IMPLICIT
4838 #include "patchlevel.h"
4839 #undef PERL_PATCHLEVEL_H_IMPLICIT
4841 #define PERL_VERSION_STRING STRINGIFY(PERL_REVISION) "." \
4842 STRINGIFY(PERL_VERSION) "." \
4843 STRINGIFY(PERL_SUBVERSION)
4845 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4846 STRINGIFY(PERL_API_VERSION) "." \
4847 STRINGIFY(PERL_API_SUBVERSION)
4851 /* handy constants */
4852 EXTCONST char PL_warn_uninit[]
4853 INIT("Use of uninitialized value%s%s%s");
4854 EXTCONST char PL_warn_uninit_sv[]
4855 INIT("Use of uninitialized value%" SVf "%s%s");
4856 EXTCONST char PL_warn_nosemi[]
4857 INIT("Semicolon seems to be missing");
4858 EXTCONST char PL_warn_reserved[]
4859 INIT("Unquoted string \"%s\" may clash with future reserved word");
4860 EXTCONST char PL_warn_nl[]
4861 INIT("Unsuccessful %s on filename containing newline");
4862 EXTCONST char PL_no_wrongref[]
4863 INIT("Can't use %s ref as %s ref");
4864 /* The core no longer needs this here. If you require the string constant,
4865 please inline a copy into your own code. */
4866 EXTCONST char PL_no_symref[] __attribute__deprecated__
4867 INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4868 EXTCONST char PL_no_symref_sv[]
4869 INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4871 EXTCONST char PL_no_usym[]
4872 INIT("Can't use an undefined value as %s reference");
4873 EXTCONST char PL_no_aelem[]
4874 INIT("Modification of non-creatable array value attempted, subscript %d");
4875 EXTCONST char PL_no_helem_sv[]
4876 INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4877 EXTCONST char PL_no_modify[]
4878 INIT("Modification of a read-only value attempted");
4879 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4880 INIT("Out of memory!\n");
4881 EXTCONST char PL_no_security[]
4882 INIT("Insecure dependency in %s%s");
4883 EXTCONST char PL_no_sock_func[]
4884 INIT("Unsupported socket function \"%s\" called");
4885 EXTCONST char PL_no_dir_func[]
4886 INIT("Unsupported directory function \"%s\" called");
4887 EXTCONST char PL_no_func[]
4888 INIT("The %s function is unimplemented");
4889 EXTCONST char PL_no_myglob[]
4890 INIT("\"%s\" %s %s can't be in a package");
4891 EXTCONST char PL_no_localize_ref[]
4892 INIT("Can't localize through a reference");
4893 EXTCONST char PL_memory_wrap[]
4894 INIT("panic: memory wrap");
4895 EXTCONST char PL_extended_cp_format[]
4896 INIT("Code point 0x%" UVXf " is not Unicode, requires a Perl extension,"
4897 " and so is not portable");
4898 EXTCONST char PL_Yes[]
4900 EXTCONST char PL_No[]
4902 EXTCONST char PL_Zero[]
4906 =for apidoc_section $numeric
4907 =for apidoc AmTuU|const char *|PL_hexdigit|U8 value
4909 This array, indexed by an integer, converts that value into the character that
4910 represents it. For example, if the input is 8, the return will be a string
4911 whose first character is '8'. What is actually returned is a pointer into a
4912 string. All you are interested in is the first character of that string. To
4913 get uppercase letters (for the values 10..15), add 16 to the index. Hence,
4914 C<PL_hexdigit[11]> is C<'b'>, and C<PL_hexdigit[11+16]> is C<'B'>. Adding 16
4915 to an index whose representation is '0'..'9' yields the same as not adding 16.
4916 Indices outside the range 0..31 result in (bad) undedefined behavior.
4920 EXTCONST char PL_hexdigit[]
4921 INIT("0123456789abcdef0123456789ABCDEF");
4923 EXTCONST STRLEN PL_WARN_ALL
4925 EXTCONST STRLEN PL_WARN_NONE
4928 /* This is constant on most architectures, a global on OS/2 */
4930 EXTCONST char PL_sh_path[]
4931 INIT(SH_PATH); /* full path of shell */
4935 EXTCONST char PL_cshname[]
4937 # define PL_cshlen (sizeof(CSH "") - 1)
4940 /* These are baked at compile time into any shared perl library.
4941 In future releases this will allow us in main() to sanity test the
4942 library we're linking against. */
4944 EXTCONST U8 PL_revision
4945 INIT(PERL_REVISION);
4946 EXTCONST U8 PL_version
4948 EXTCONST U8 PL_subversion
4949 INIT(PERL_SUBVERSION);
4951 EXTCONST char PL_uuemap[65]
4952 INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4954 /* a special string address whose value is "isa", but which perl knows
4955 * to treat as if it were really "DOES" when printing the method name in
4956 * the "Can't call method '%s'" error message */
4957 EXTCONST char PL_isa_DOES[]
4961 EXTCONST char PL_uudmap[256] =
4963 # include "uuudmap.h"
4965 # include "uudmap.h"
4968 EXTCONST char PL_bitcount[256] =
4970 # include "ubitcount.h"
4972 # include "bitcount.h"
4975 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4976 EXTCONST int PL_sig_num[] = { SIG_NUM };
4978 EXTCONST char PL_uudmap[256];
4979 EXTCONST char PL_bitcount[256];
4980 EXTCONST char* const PL_sig_name[];
4981 EXTCONST int PL_sig_num[];
4984 /* fast conversion and case folding tables. The folding tables complement the
4985 * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4986 * folds such as outside the range or to multiple characters. */
4991 /* The EBCDIC fold table depends on the code page, and hence is found in
4992 * ebcdic_tables.h */
4994 EXTCONST unsigned char PL_fold[] = {
4995 0, 1, 2, 3, 4, 5, 6, 7,
4996 8, 9, 10, 11, 12, 13, 14, 15,
4997 16, 17, 18, 19, 20, 21, 22, 23,
4998 24, 25, 26, 27, 28, 29, 30, 31,
4999 32, 33, 34, 35, 36, 37, 38, 39,
5000 40, 41, 42, 43, 44, 45, 46, 47,