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 Compiler 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 START_EXTERN_C extern "C" {
118 # define END_EXTERN_C }
119 # define EXTERN_C 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 /* this used to be off by default, now its on, see perlio.h */
139 #define PERLIO_FUNCS_CONST
141 #ifdef PERL_IMPLICIT_CONTEXT
142 # ifndef MULTIPLICITY
143 # define MULTIPLICITY
145 # define tTHX PerlInterpreter*
146 # define pTHX tTHX my_perl PERL_UNUSED_DECL
147 # define aTHX my_perl
148 # define aTHXa(a) aTHX = (tTHX)a
149 # define dTHXa(a) pTHX = (tTHX)a
150 # define dTHX pTHX = PERL_GET_THX
163 # if defined(DEBUGGING) && !defined(PERL_TRACK_MEMPOOL)
164 # define PERL_TRACK_MEMPOOL
167 # undef PERL_TRACK_MEMPOOL
171 # define dTHX_DEBUGGING dTHX
173 # define dTHX_DEBUGGING dNOOP
176 #define STATIC static
179 /* Do not use these macros. They were part of PERL_OBJECT, which was an
180 * implementation of multiplicity using C++ objects. They have been left
181 * here solely for the sake of XS code which has incorrectly
184 * The only one Devel::PPPort handles is this; list it as deprecated
186 =for apidoc_section Concurrency
187 =for apidoc AmD|void|CPERLscope|void x
192 #define CPERLscope(x) x
193 #define CPERLarg void
196 #define PERL_OBJECT_THIS
197 #define _PERL_OBJECT_THIS
198 #define PERL_OBJECT_THIS_
199 #define CALL_FPTR(fptr) (*fptr)
200 #define MEMBER_TO_FPTR(name) name
201 #endif /* !PERL_CORE */
203 #define CALLRUNOPS PL_runops
205 #define CALLREGCOMP(sv, flags) Perl_pregcomp(aTHX_ (sv),(flags))
207 #define CALLREGCOMP_ENG(prog, sv, flags) (prog)->comp(aTHX_ sv, flags)
208 #define CALLREGEXEC(prog,stringarg,strend,strbeg,minend,sv,data,flags) \
209 RX_ENGINE(prog)->exec(aTHX_ (prog),(stringarg),(strend), \
210 (strbeg),(minend),(sv),(data),(flags))
211 #define CALLREG_INTUIT_START(prog,sv,strbeg,strpos,strend,flags,data) \
212 RX_ENGINE(prog)->intuit(aTHX_ (prog), (sv), (strbeg), (strpos), \
213 (strend),(flags),(data))
214 #define CALLREG_INTUIT_STRING(prog) \
215 RX_ENGINE(prog)->checkstr(aTHX_ (prog))
217 #define CALLREGFREE(prog) \
218 Perl_pregfree(aTHX_ (prog))
220 #define CALLREGFREE_PVT(prog) \
221 if(prog && RX_ENGINE(prog)) RX_ENGINE(prog)->rxfree(aTHX_ (prog))
223 #define CALLREG_NUMBUF_FETCH(rx,paren,usesv) \
224 RX_ENGINE(rx)->numbered_buff_FETCH(aTHX_ (rx),(paren),(usesv))
226 #define CALLREG_NUMBUF_STORE(rx,paren,value) \
227 RX_ENGINE(rx)->numbered_buff_STORE(aTHX_ (rx),(paren),(value))
229 #define CALLREG_NUMBUF_LENGTH(rx,sv,paren) \
230 RX_ENGINE(rx)->numbered_buff_LENGTH(aTHX_ (rx),(sv),(paren))
232 #define CALLREG_NAMED_BUFF_FETCH(rx, key, flags) \
233 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_FETCH))
235 #define CALLREG_NAMED_BUFF_STORE(rx, key, value, flags) \
236 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), (value), ((flags) | RXapif_STORE))
238 #define CALLREG_NAMED_BUFF_DELETE(rx, key, flags) \
239 RX_ENGINE(rx)->named_buff(aTHX_ (rx),(key), NULL, ((flags) | RXapif_DELETE))
241 #define CALLREG_NAMED_BUFF_CLEAR(rx, flags) \
242 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_CLEAR))
244 #define CALLREG_NAMED_BUFF_EXISTS(rx, key, flags) \
245 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_EXISTS))
247 #define CALLREG_NAMED_BUFF_FIRSTKEY(rx, flags) \
248 RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), NULL, ((flags) | RXapif_FIRSTKEY))
250 #define CALLREG_NAMED_BUFF_NEXTKEY(rx, lastkey, flags) \
251 RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), (lastkey), ((flags) | RXapif_NEXTKEY))
253 #define CALLREG_NAMED_BUFF_SCALAR(rx, flags) \
254 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_SCALAR))
256 #define CALLREG_NAMED_BUFF_COUNT(rx) \
257 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, RXapif_REGNAMES_COUNT)
259 #define CALLREG_NAMED_BUFF_ALL(rx, flags) \
260 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, flags)
262 #define CALLREG_PACKAGE(rx) \
263 RX_ENGINE(rx)->qr_package(aTHX_ (rx))
265 #if defined(USE_ITHREADS)
266 #define CALLREGDUPE(prog,param) \
267 Perl_re_dup(aTHX_ (prog),(param))
269 #define CALLREGDUPE_PVT(prog,param) \
270 (prog ? RX_ENGINE(prog)->dupe(aTHX_ (prog),(param)) \
274 /* some compilers impersonate gcc */
275 #if defined(__GNUC__) && !defined(__clang__) && !defined(__INTEL_COMPILER)
276 # define PERL_IS_GCC 1
279 /* In case Configure was not used (we are using a "canned config"
280 * such as Win32, or a cross-compilation setup, for example) try going
281 * by the gcc major and minor versions. One useful URL is
282 * http://www.ohse.de/uwe/articles/gcc-attributes.html,
283 * but contrary to this information warn_unused_result seems
284 * not to be in gcc 3.3.5, at least. --jhi
285 * Also, when building extensions with an installed perl, this allows
286 * the user to upgrade gcc and get the right attributes, rather than
287 * relying on the list generated at Configure time. --AD
288 * Set these up now otherwise we get confused when some of the <*thread.h>
289 * includes below indirectly pull in <perlio.h> (which needs to know if we
290 * have HASATTRIBUTE_FORMAT).
294 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
295 # if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
296 # define HASATTRIBUTE_DEPRECATED
298 # if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
299 # define HASATTRIBUTE_FORMAT
300 # if defined __MINGW32__
301 # define PRINTF_FORMAT_NULL_OK
304 # if __GNUC__ >= 3 /* 3.0 -> */
305 # define HASATTRIBUTE_MALLOC
307 # if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
308 # define HASATTRIBUTE_NONNULL
310 # if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
311 # define HASATTRIBUTE_NORETURN
313 # if __GNUC__ >= 3 /* gcc 3.0 -> */
314 # define HASATTRIBUTE_PURE
316 # if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
317 # define HASATTRIBUTE_UNUSED
319 # if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
320 # define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
322 # if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
323 # define HASATTRIBUTE_WARN_UNUSED_RESULT
325 /* always_inline is buggy in gcc <= 4.6 and causes compilation errors */
326 # if __GNUC__ == 4 && __GNUC_MINOR__ >= 7 || __GNUC__ > 4 /* 4.7 -> */
327 # define HASATTRIBUTE_ALWAYS_INLINE
330 #endif /* #ifndef PERL_MICRO */
332 #ifdef HASATTRIBUTE_DEPRECATED
333 # define __attribute__deprecated__ __attribute__((deprecated))
335 #ifdef HASATTRIBUTE_FORMAT
336 # define __attribute__format__(x,y,z) __attribute__((format(x,y,z)))
338 #ifdef HASATTRIBUTE_MALLOC
339 # define __attribute__malloc__ __attribute__((__malloc__))
341 #ifdef HASATTRIBUTE_NONNULL
342 # define __attribute__nonnull__(a) __attribute__((nonnull(a)))
344 #ifdef HASATTRIBUTE_NORETURN
345 # define __attribute__noreturn__ __attribute__((noreturn))
347 #ifdef HASATTRIBUTE_PURE
348 # define __attribute__pure__ __attribute__((pure))
350 #ifdef HASATTRIBUTE_UNUSED
351 # define __attribute__unused__ __attribute__((unused))
353 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
354 # define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
356 #ifdef HASATTRIBUTE_ALWAYS_INLINE
357 /* always_inline is buggy in gcc <= 4.6 and causes compilation errors */
358 # if !defined(PERL_IS_GCC) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7 || __GNUC__ > 4)
359 # define __attribute__always_inline__ __attribute__((always_inline))
363 /* If we haven't defined the attributes yet, define them to blank. */
364 #ifndef __attribute__deprecated__
365 # define __attribute__deprecated__
367 #ifndef __attribute__format__
368 # define __attribute__format__(x,y,z)
370 #ifndef __attribute__malloc__
371 # define __attribute__malloc__
373 #ifndef __attribute__nonnull__
374 # define __attribute__nonnull__(a)
376 #ifndef __attribute__noreturn__
377 # define __attribute__noreturn__
379 #ifndef __attribute__pure__
380 # define __attribute__pure__
382 #ifndef __attribute__unused__
383 # define __attribute__unused__
385 #ifndef __attribute__warn_unused_result__
386 # define __attribute__warn_unused_result__
388 #ifndef __attribute__always_inline__
389 # define __attribute__always_inline__
392 /* Some OS warn on NULL format to printf */
393 #ifdef PRINTF_FORMAT_NULL_OK
394 # define __attribute__format__null_ok__(x,y,z) __attribute__format__(x,y,z)
396 # define __attribute__format__null_ok__(x,y,z)
400 * Because of backward compatibility reasons the PERL_UNUSED_DECL
401 * cannot be changed from postfix to PERL_UNUSED_DECL(x). Sigh.
403 * Note that there are C compilers such as MetroWerks CodeWarrior
404 * which do not have an "inlined" way (like the gcc __attribute__) of
405 * marking unused variables (they need e.g. a #pragma) and therefore
406 * cpp macros like PERL_UNUSED_DECL cannot work for this purpose, even
407 * if it were PERL_UNUSED_DECL(x), which it cannot be (see above).
411 #ifndef PERL_UNUSED_DECL
412 # define PERL_UNUSED_DECL __attribute__unused__
416 * for silencing unused variables that are actually used most of the time,
417 * but we cannot quite get rid of, such as "ax" in PPCODE+noargs xsubs,
418 * or variables/arguments that are used only in certain configurations.
420 =for apidoc Am||PERL_UNUSED_ARG|void x
421 This is used to suppress compiler warnings that a parameter to a function is
422 not used. This situation can arise, for example, when a parameter is needed
423 under some configuration conditions, but not others, so that C preprocessor
424 conditional compilation causes it be used just some times.
426 =for apidoc Amn||PERL_UNUSED_CONTEXT
427 This is used to suppress compiler warnings that the thread context parameter to
428 a function is not used. This situation can arise, for example, when a
429 C preprocessor conditional compilation causes it be used just some times.
431 =for apidoc Am||PERL_UNUSED_VAR|void x
432 This is used to suppress compiler warnings that the variable I<x> is not used.
433 This situation can arise, for example, when a C preprocessor conditional
434 compilation causes it be used just some times.
438 #ifndef PERL_UNUSED_ARG
439 # define PERL_UNUSED_ARG(x) ((void)sizeof(x))
441 #ifndef PERL_UNUSED_VAR
442 # define PERL_UNUSED_VAR(x) ((void)sizeof(x))
445 #if defined(USE_ITHREADS)
446 # define PERL_UNUSED_CONTEXT PERL_UNUSED_ARG(my_perl)
448 # define PERL_UNUSED_CONTEXT
451 /* gcc (-ansi) -pedantic doesn't allow gcc statement expressions,
452 * g++ allows them but seems to have problems with them
453 * (insane errors ensue).
454 * g++ does not give insane errors now (RMB 2008-01-30, gcc 4.2.2).
456 #if defined(PERL_GCC_PEDANTIC) || \
457 (defined(__GNUC__) && defined(__cplusplus) && \
458 ((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2))))
459 # ifndef PERL_GCC_BRACE_GROUPS_FORBIDDEN
460 # define PERL_GCC_BRACE_GROUPS_FORBIDDEN
466 =for apidoc Am||PERL_UNUSED_RESULT|void x
468 This macro indicates to discard the return value of the function call inside
471 PERL_UNUSED_RESULT(foo(a, b))
473 The main reason for this is that the combination of C<gcc -Wunused-result>
474 (part of C<-Wall>) and the C<__attribute__((warn_unused_result))> cannot
475 be silenced with casting to C<void>. This causes trouble when the system
476 header files use the attribute.
478 Use C<PERL_UNUSED_RESULT> sparingly, though, since usually the warning
479 is there for a good reason: you might lose success/failure information,
480 or leak resources, or changes in resources.
482 But sometimes you just want to ignore the return value, I<e.g.>, on
483 codepaths soon ending up in abort, or in "best effort" attempts,
484 or in situations where there is no good way to handle failures.
486 Sometimes C<PERL_UNUSED_RESULT> might not be the most natural way:
487 another possibility is that you can capture the return value
488 and use C<L</PERL_UNUSED_VAR>> on that.
492 The __typeof__() is used instead of typeof() since typeof() is not
493 available under strict C89, and because of compilers masquerading
494 as gcc (clang and icc), we want exactly the gcc extension
495 __typeof__ and nothing else.
498 #ifndef PERL_UNUSED_RESULT
499 # if defined(__GNUC__) && defined(HASATTRIBUTE_WARN_UNUSED_RESULT)
500 # define PERL_UNUSED_RESULT(v) STMT_START { __typeof__(v) z = (v); (void)sizeof(z); } STMT_END
502 # define PERL_UNUSED_RESULT(v) ((void)(v))
506 #if defined(_MSC_VER)
507 /* XXX older MSVC versions have a smallish macro buffer */
508 #define PERL_SMALL_MACRO_BUFFER
511 /* on gcc (and clang), specify that a warning should be temporarily
514 * GCC_DIAG_IGNORE_DECL(-Wmultichar);
516 * GCC_DIAG_RESTORE_DECL;
518 * based on http://dbp-consulting.com/tutorials/SuppressingGCCWarnings.html
520 * Note that "pragma GCC diagnostic push/pop" was added in GCC 4.6, Mar 2011;
521 * clang only pretends to be GCC 4.2, but still supports push/pop.
523 * Note on usage: all macros must be used at a place where a declaration
524 * or statement can occur, i.e., not in the middle of an expression.
525 * *_DIAG_IGNORE() and *_DIAG_RESTORE can be used in any such place, but
526 * must be used without a following semicolon. *_DIAG_IGNORE_DECL() and
527 * *_DIAG_RESTORE_DECL must be used with a following semicolon, and behave
528 * syntactically as declarations (like dNOOP). *_DIAG_IGNORE_STMT()
529 * and *_DIAG_RESTORE_STMT must be used with a following semicolon,
530 * and behave syntactically as statements (like NOOP).
534 #if defined(__clang__) || defined(__clang) || \
535 (defined( __GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406)
536 # define GCC_DIAG_PRAGMA(x) _Pragma (#x)
537 /* clang has "clang diagnostic" pragmas, but also understands gcc. */
538 # define GCC_DIAG_IGNORE(x) _Pragma("GCC diagnostic push") \
539 GCC_DIAG_PRAGMA(GCC diagnostic ignored #x)
540 # define GCC_DIAG_RESTORE _Pragma("GCC diagnostic pop")
542 # define GCC_DIAG_IGNORE(w)
543 # define GCC_DIAG_RESTORE
545 #define GCC_DIAG_IGNORE_DECL(x) GCC_DIAG_IGNORE(x) dNOOP
546 #define GCC_DIAG_RESTORE_DECL GCC_DIAG_RESTORE dNOOP
547 #define GCC_DIAG_IGNORE_STMT(x) GCC_DIAG_IGNORE(x) NOOP
548 #define GCC_DIAG_RESTORE_STMT GCC_DIAG_RESTORE NOOP
549 /* for clang specific pragmas */
550 #if defined(__clang__) || defined(__clang)
551 # define CLANG_DIAG_PRAGMA(x) _Pragma (#x)
552 # define CLANG_DIAG_IGNORE(x) _Pragma("clang diagnostic push") \
553 CLANG_DIAG_PRAGMA(clang diagnostic ignored #x)
554 # define CLANG_DIAG_RESTORE _Pragma("clang diagnostic pop")
556 # define CLANG_DIAG_IGNORE(w)
557 # define CLANG_DIAG_RESTORE
559 #define CLANG_DIAG_IGNORE_DECL(x) CLANG_DIAG_IGNORE(x) dNOOP
560 #define CLANG_DIAG_RESTORE_DECL CLANG_DIAG_RESTORE dNOOP
561 #define CLANG_DIAG_IGNORE_STMT(x) CLANG_DIAG_IGNORE(x) NOOP
562 #define CLANG_DIAG_RESTORE_STMT CLANG_DIAG_RESTORE NOOP
564 #if defined(_MSC_VER) && (_MSC_VER >= 1300)
565 # define MSVC_DIAG_IGNORE(x) __pragma(warning(push)) \
566 __pragma(warning(disable : x))
567 # define MSVC_DIAG_RESTORE __pragma(warning(pop))
569 # define MSVC_DIAG_IGNORE(x)
570 # define MSVC_DIAG_RESTORE
572 #define MSVC_DIAG_IGNORE_DECL(x) MSVC_DIAG_IGNORE(x) dNOOP
573 #define MSVC_DIAG_RESTORE_DECL MSVC_DIAG_RESTORE dNOOP
574 #define MSVC_DIAG_IGNORE_STMT(x) MSVC_DIAG_IGNORE(x) NOOP
575 #define MSVC_DIAG_RESTORE_STMT MSVC_DIAG_RESTORE NOOP
577 #define NOOP /*EMPTY*/(void)0
578 #define dNOOP struct Perl___notused_struct
581 /* Don't bother defining tTHX ; using it outside
582 * code guarded by PERL_IMPLICIT_CONTEXT is an error.
588 # define aTHXa(a) NOOP
589 # define dTHXa(a) dNOOP
604 /* Backwards compatibility macro for XS code. It used to be part of
605 * the PERL_GLOBAL_STRUCT(_PRIVATE) feature, which no longer exists */
609 /* these are only defined for compatibility; should not be used internally */
610 #if !defined(pTHXo) && !defined(PERL_CORE)
612 # define pTHXo_ pTHX_
614 # define aTHXo_ aTHX_
616 # define dTHXoa(x) dTHXa(x)
620 # define pTHXx PerlInterpreter *my_perl
621 # define pTHXx_ pTHXx,
622 # define aTHXx my_perl
623 # define aTHXx_ aTHXx,
627 /* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
628 * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
629 * dTHXs is therefore needed for all functions using PerlIO_foo(). */
630 #ifdef PERL_IMPLICIT_SYS
636 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
637 # ifndef PERL_USE_GCC_BRACE_GROUPS
638 # define PERL_USE_GCC_BRACE_GROUPS
643 =for apidoc_section Compiler directives
644 =for apidoc AmnUu|void|STMT_START
645 =for apidoc_item ||STMT_END
647 This allows a series of statements in a macro to be used as a single statement,
650 if (x) STMT_START { ... } STMT_END else ...
652 Note that you can't return a value out of them, which limits their utility.
653 But see C<L</PERL_USE_GCC_BRACE_GROUPS>>.
655 =for apidoc AmnuU|bool|PERL_USE_GCC_BRACE_GROUPS
657 This C pre-processor value, if defined, indicates that it is permissible to use
658 the GCC brace groups extension. This extension, of the form
662 turns the block consisting of I<statements ...> into an expression with a
663 value, unlike plain C language blocks. This can present optimization
664 possibilities, B<BUT> you generally need to specify an alternative in case this
665 ability doesn't exist or has otherwise been forbidden.
671 #ifdef PERL_USE_GCC_BRACE_GROUPS
681 Trying to select a version that gives no warnings...
683 #if !(defined(STMT_START) && defined(STMT_END))
684 # ifdef PERL_USE_GCC_BRACE_GROUPS
685 # define STMT_START (void)( /* gcc supports "({ STATEMENTS; })" */
688 # define STMT_START do
689 # define STMT_END while (0)
693 #ifndef BYTEORDER /* Should never happen -- byteorder is in config.h */
694 # define BYTEORDER 0x1234
697 #if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
704 * The following contortions are brought to you on behalf of all the
705 * standards, semi-standards, de facto standards, not-so-de-facto standards
706 * of the world, as well as all the other botches anyone ever thought of.
707 * The basic theory is that if we work hard enough here, the rest of the
708 * code can be a lot prettier. Well, so much for theory. Sorry, Henry...
711 /* define this once if either system, instead of cluttering up the src */
712 #if defined(MSDOS) || defined(WIN32) || defined(NETWARE)
716 /* These exist only for back-compat with XS modules. */
719 #define CAN_PROTOTYPE
726 /* By compiling a perl with -DNO_TAINT_SUPPORT or -DSILENT_NO_TAINT_SUPPORT,
727 * you get a perl without taint support, but doubtlessly with a lesser
728 * degree of support. Do not do so unless you know exactly what it means
729 * technically, have a good reason to do so, and know exactly how the
730 * perl will be used. perls with -DSILENT_NO_TAINT_SUPPORT are considered
731 * a potential security risk due to flat out ignoring the security-relevant
732 * taint flags. This being said, a perl without taint support compiled in
733 * has marginal run-time performance benefits.
734 * SILENT_NO_TAINT_SUPPORT implies NO_TAINT_SUPPORT.
735 * SILENT_NO_TAINT_SUPPORT is the same as NO_TAINT_SUPPORT except it
736 * silently ignores -t/-T instead of throwing an exception.
738 * DANGER! Using NO_TAINT_SUPPORT or SILENT_NO_TAINT_SUPPORT
739 * voids your nonexistent warranty!
741 #if defined(SILENT_NO_TAINT_SUPPORT) && !defined(NO_TAINT_SUPPORT)
742 # define NO_TAINT_SUPPORT 1
745 /* NO_TAINT_SUPPORT can be set to transform virtually all taint-related
746 * operations into no-ops for a very modest speed-up. Enable only if you
747 * know what you're doing: tests and CPAN modules' tests are bound to fail.
749 #ifdef NO_TAINT_SUPPORT
751 # define TAINT_NOT NOOP
752 # define TAINT_IF(c) NOOP
753 # define TAINT_ENV() NOOP
754 # define TAINT_PROPER(s) NOOP
755 # define TAINT_set(s) NOOP
757 # define TAINTING_get 0
758 # define TAINTING_set(s) NOOP
759 # define TAINT_WARN_get 0
760 # define TAINT_WARN_set(s) NOOP
762 /* Set to tainted if we are running under tainting mode */
763 # define TAINT (PL_tainted = PL_tainting)
765 # define TAINT_NOT (PL_tainted = FALSE) /* Untaint */
766 # define TAINT_IF(c) if (UNLIKELY(c)) { TAINT; } /* Conditionally taint */
767 # define TAINT_ENV() if (UNLIKELY(PL_tainting)) { taint_env(); }
768 /* croak or warn if tainting */
769 # define TAINT_PROPER(s) if (UNLIKELY(PL_tainting)) { \
770 taint_proper(NULL, s); \
772 # define TAINT_set(s) (PL_tainted = (s))
773 # define TAINT_get (cBOOL(UNLIKELY(PL_tainted))) /* Is something tainted? */
774 # define TAINTING_get (cBOOL(UNLIKELY(PL_tainting))) /* Is taint checking enabled? */
775 # define TAINTING_set(s) (PL_tainting = (s))
776 # define TAINT_WARN_get (PL_taint_warn) /* FALSE => tainting violations
780 # define TAINT_WARN_set(s) (PL_taint_warn = (s))
783 /* flags used internally only within pp_subst and pp_substcont */
785 # define SUBST_TAINT_STR 1 /* string tainted */
786 # define SUBST_TAINT_PAT 2 /* pattern tainted */
787 # define SUBST_TAINT_REPL 4 /* replacement tainted */
788 # define SUBST_TAINT_RETAINT 8 /* use re'taint' in scope */
789 # define SUBST_TAINT_BOOLRET 16 /* return is boolean (don't taint) */
792 /* XXX All process group stuff is handled in pp_sys.c. Should these
793 defines move there? If so, I could simplify this a lot. --AD 9/96.
795 /* Process group stuff changed from traditional BSD to POSIX.
796 perlfunc.pod documents the traditional BSD-style syntax, so we'll
797 try to preserve that, if possible.
800 # define BSD_SETPGRP(pid, pgrp) setpgid((pid), (pgrp))
801 #elif defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
802 # define BSD_SETPGRP(pid, pgrp) setpgrp((pid), (pgrp))
803 #elif defined(HAS_SETPGRP2)
804 # define BSD_SETPGRP(pid, pgrp) setpgrp2((pid), (pgrp))
806 #if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
807 # define HAS_SETPGRP /* Well, effectively it does . . . */
810 /* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
811 our life easier :-) so we'll try it.
814 # define BSD_GETPGRP(pid) getpgid((pid))
815 #elif defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
816 # define BSD_GETPGRP(pid) getpgrp((pid))
817 #elif defined(HAS_GETPGRP2)
818 # define BSD_GETPGRP(pid) getpgrp2((pid))
820 #if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
821 # define HAS_GETPGRP /* Well, effectively it does . . . */
824 /* These are not exact synonyms, since setpgrp() and getpgrp() may
825 have different behaviors, but perl.h used to define USE_BSDPGRP
826 (prior to 5.003_05) so some extension might depend on it.
828 #if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
834 /* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
835 pthread.h must be included before all other header files.
837 #if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
838 # include <pthread.h>
841 #include <sys/types.h>
857 #ifdef METHOD /* Defined by OSF/1 v3.0 by ctype.h */
870 # include <xlocale.h>
873 /* If not forbidden, we enable locale handling if either 1) the POSIX 2008
874 * functions are available, or 2) just the setlocale() function. This logic is
875 * repeated in t/loc_tools.pl and makedef.pl; The three should be kept in
877 #if ! defined(NO_LOCALE)
879 # if ! defined(NO_POSIX_2008_LOCALE) \
880 && defined(HAS_NEWLOCALE) \
881 && defined(HAS_USELOCALE) \
882 && defined(HAS_DUPLOCALE) \
883 && defined(HAS_FREELOCALE) \
884 && defined(LC_ALL_MASK)
886 /* For simplicity, the code is written to assume that any platform advanced
887 * enough to have the Posix 2008 locale functions has LC_ALL. The final
888 * test above makes sure that assumption is valid */
890 # define HAS_POSIX_2008_LOCALE
892 # elif defined(HAS_SETLOCALE)
898 # define HAS_SKIP_LOCALE_INIT /* Solely for XS code to test for this
900 # if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
901 && defined(HAS_STRXFRM)
902 # define USE_LOCALE_COLLATE
904 # if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
905 # define USE_LOCALE_CTYPE
907 # if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
908 # define USE_LOCALE_NUMERIC
910 # if !defined(NO_LOCALE_MESSAGES) && defined(LC_MESSAGES)
911 # define USE_LOCALE_MESSAGES
913 # if !defined(NO_LOCALE_MONETARY) && defined(LC_MONETARY)
914 # define USE_LOCALE_MONETARY
916 # if !defined(NO_LOCALE_TIME) && defined(LC_TIME)
917 # define USE_LOCALE_TIME
919 # if !defined(NO_LOCALE_ADDRESS) && defined(LC_ADDRESS)
920 # define USE_LOCALE_ADDRESS
922 # if !defined(NO_LOCALE_IDENTIFICATION) && defined(LC_IDENTIFICATION)
923 # define USE_LOCALE_IDENTIFICATION
925 # if !defined(NO_LOCALE_MEASUREMENT) && defined(LC_MEASUREMENT)
926 # define USE_LOCALE_MEASUREMENT
928 # if !defined(NO_LOCALE_PAPER) && defined(LC_PAPER)
929 # define USE_LOCALE_PAPER
931 # if !defined(NO_LOCALE_TELEPHONE) && defined(LC_TELEPHONE)
932 # define USE_LOCALE_TELEPHONE
934 # if !defined(NO_LOCALE_SYNTAX) && defined(LC_SYNTAX)
935 # define USE_LOCALE_SYNTAX
937 # if !defined(NO_LOCALE_TOD) && defined(LC_TOD)
938 # define USE_LOCALE_TOD
941 /* XXX The next few defines are unfortunately duplicated in makedef.pl, and
942 * changes here MUST also be made there */
944 # if ! defined(HAS_SETLOCALE) && defined(HAS_POSIX_2008_LOCALE)
945 # define USE_POSIX_2008_LOCALE
946 # ifndef USE_THREAD_SAFE_LOCALE
947 # define USE_THREAD_SAFE_LOCALE
950 * -DUSE_THREAD_SAFE_LOCALE, will do so even
951 * on unthreaded builds */
952 # elif (defined(USE_ITHREADS) || defined(USE_THREAD_SAFE_LOCALE)) \
953 && ( defined(HAS_POSIX_2008_LOCALE) \
954 || (defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1400)) \
955 && ! defined(NO_THREAD_SAFE_LOCALE)
956 # ifndef USE_THREAD_SAFE_LOCALE
957 # define USE_THREAD_SAFE_LOCALE
959 # ifdef HAS_POSIX_2008_LOCALE
960 # define USE_POSIX_2008_LOCALE
965 /* Microsoft documentation reads in the change log for VS 2015:
966 * "The localeconv function declared in locale.h now works correctly when
967 * per-thread locale is enabled. In previous versions of the library, this
968 * function would return the lconv data for the global locale, not the
971 #if defined(WIN32) && defined(USE_THREAD_SAFE_LOCALE) && _MSC_VER < 1900
972 # define TS_W32_BROKEN_LOCALECONV
978 # ifdef PARAM_NEEDS_TYPES
979 # include <sys/types.h>
981 # include <sys/param.h>
984 /* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
985 value something like 199306. This may be useful if no more-specific
986 feature test is available.
994 /* Use all the "standard" definitions */
997 /* If this causes problems, set i_unistd=undef in the hint file. */
999 # if defined(__amigaos4__)
1000 # ifdef I_NETINET_IN
1001 # include <netinet/in.h>
1004 # include <unistd.h>
1005 # if defined(__amigaos4__)
1006 /* Under AmigaOS 4 newlib.library provides an environ. However using
1007 * it doesn't give us enough control over inheritance of variables by
1008 * subshells etc. so replace with custom version based on abc-shell
1010 extern char **myenviron;
1012 # define environ myenviron
1018 # include <sys/wait.h>
1021 #if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
1022 EXTERN_C int syscall(int, ...);
1025 #if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
1026 EXTERN_C int usleep(unsigned int);
1029 /* macros for correct constant construction. These are in C99 <stdint.h>
1030 * (so they will not be available in strict C89 mode), but they are nice, so
1031 * let's define them if necessary. */
1034 # define UINT16_C(x) ((U16_TYPE)x##U)
1036 # define UINT16_C(x) ((U16_TYPE)x##UL)
1042 # define UINT32_C(x) ((U32_TYPE)x##U)
1044 # define UINT32_C(x) ((U32_TYPE)x##UL)
1049 typedef intmax_t PERL_INTMAX_T;
1050 typedef uintmax_t PERL_UINTMAX_T;
1053 /* N.B. We use QUADKIND here instead of HAS_QUAD here, because that doesn't
1054 * actually mean what it has always been documented to mean (see RT #119753)
1055 * and is explicitly turned off outside of core with dire warnings about
1056 * removing the undef. */
1058 #if defined(QUADKIND)
1059 # undef PeRl_INT64_C
1060 # undef PeRl_UINT64_C
1061 /* Prefer the native integer types (int and long) over long long
1062 * (which is not C89) and Win32-specific __int64. */
1063 # if QUADKIND == QUAD_IS_INT && INTSIZE == 8
1064 # define PeRl_INT64_C(c) (c)
1065 # define PeRl_UINT64_C(c) CAT2(c,U)
1067 # if QUADKIND == QUAD_IS_LONG && LONGSIZE == 8
1068 # define PeRl_INT64_C(c) CAT2(c,L)
1069 # define PeRl_UINT64_C(c) CAT2(c,UL)
1071 # if QUADKIND == QUAD_IS_LONG_LONG && defined(HAS_LONG_LONG)
1072 # define PeRl_INT64_C(c) CAT2(c,LL)
1073 # define PeRl_UINT64_C(c) CAT2(c,ULL)
1075 # if QUADKIND == QUAD_IS___INT64
1076 # define PeRl_INT64_C(c) CAT2(c,I64)
1077 # define PeRl_UINT64_C(c) CAT2(c,UI64)
1079 # ifndef PeRl_INT64_C
1080 # define PeRl_INT64_C(c) ((I64)(c)) /* last resort */
1081 # define PeRl_UINT64_C(c) ((U64TYPE)(c))
1083 /* In OS X the INT64_C/UINT64_C are defined with LL/ULL, which will
1084 * not fly with C89-pedantic gcc, so let's undefine them first so that
1085 * we can redefine them with our native integer preferring versions. */
1086 # if defined(PERL_DARWIN) && defined(PERL_GCC_PEDANTIC)
1091 # define INT64_C(c) PeRl_INT64_C(c)
1094 # define UINT64_C(c) PeRl_UINT64_C(c)
1098 =for apidoc_section Integer configuration values
1099 =for apidoc Am||INTMAX_C|number
1100 Returns a token the C compiler recognizes for the constant C<number> of the
1101 widest integer type on the machine. For example, if the machine has C<long
1102 long>s, C<INTMAX_C(-1)> would yield
1106 =for apidoc Am||UINTMAX_C|number
1107 Returns a token the C compiler recognizes for the constant C<number> of the
1108 widest unsigned integer type on the machine. For example, if the machine has
1109 C<long>s, C<UINTMAX_C(1)> would yield
1117 typedef I64TYPE PERL_INTMAX_T;
1118 typedef U64TYPE PERL_UINTMAX_T;
1121 # define INTMAX_C(c) INT64_C(c)
1124 # define UINTMAX_C(c) UINT64_C(c)
1127 #else /* below QUADKIND is undefined */
1129 /* Perl doesn't work on 16 bit systems, so must be 32 bit */
1131 typedef I32TYPE PERL_INTMAX_T;
1132 typedef U32TYPE PERL_UINTMAX_T;
1135 # define INTMAX_C(c) INT32_C(c)
1138 # define UINTMAX_C(c) UINT32_C(c)
1141 #endif /* no QUADKIND */
1145 /* byte-swapping functions for big-/little-endian conversion */
1146 # define _swab_16_(x) ((U16)( \
1147 (((U16)(x) & UINT16_C(0x00ff)) << 8) | \
1148 (((U16)(x) & UINT16_C(0xff00)) >> 8) ))
1150 # define _swab_32_(x) ((U32)( \
1151 (((U32)(x) & UINT32_C(0x000000ff)) << 24) | \
1152 (((U32)(x) & UINT32_C(0x0000ff00)) << 8) | \
1153 (((U32)(x) & UINT32_C(0x00ff0000)) >> 8) | \
1154 (((U32)(x) & UINT32_C(0xff000000)) >> 24) ))
1157 # define _swab_64_(x) ((U64)( \
1158 (((U64)(x) & UINT64_C(0x00000000000000ff)) << 56) | \
1159 (((U64)(x) & UINT64_C(0x000000000000ff00)) << 40) | \
1160 (((U64)(x) & UINT64_C(0x0000000000ff0000)) << 24) | \
1161 (((U64)(x) & UINT64_C(0x00000000ff000000)) << 8) | \
1162 (((U64)(x) & UINT64_C(0x000000ff00000000)) >> 8) | \
1163 (((U64)(x) & UINT64_C(0x0000ff0000000000)) >> 24) | \
1164 (((U64)(x) & UINT64_C(0x00ff000000000000)) >> 40) | \
1165 (((U64)(x) & UINT64_C(0xff00000000000000)) >> 56) ))
1168 /* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
1169 at least on FreeBSD. YMMV, so experiment. */
1170 #ifndef PERL_ARENA_SIZE
1171 #define PERL_ARENA_SIZE 4080
1174 /* Maximum level of recursion */
1175 #ifndef PERL_SUB_DEPTH_WARN
1176 #define PERL_SUB_DEPTH_WARN 100
1179 #endif /* PERL_CORE */
1181 /* Maximum number of args that may be passed to an OP_MULTICONCAT op.
1182 * It determines the size of local arrays in S_maybe_multiconcat() and
1185 #define PERL_MULTICONCAT_MAXARG 64
1187 /* The indexes of fields of a multiconcat aux struct.
1188 * The fixed fields are followed by nargs+1 const segment lengths,
1189 * and if utf8 and non-utf8 differ, a second nargs+1 set for utf8.
1192 #define PERL_MULTICONCAT_IX_NARGS 0 /* number of arguments */
1193 #define PERL_MULTICONCAT_IX_PLAIN_PV 1 /* non-utf8 constant string */
1194 #define PERL_MULTICONCAT_IX_PLAIN_LEN 2 /* non-utf8 constant string length */
1195 #define PERL_MULTICONCAT_IX_UTF8_PV 3 /* utf8 constant string */
1196 #define PERL_MULTICONCAT_IX_UTF8_LEN 4 /* utf8 constant string length */
1197 #define PERL_MULTICONCAT_IX_LENGTHS 5 /* first of nargs+1 const segment lens */
1198 #define PERL_MULTICONCAT_HEADER_SIZE 5 /* The number of fields of a
1199 multiconcat header */
1201 /* We no longer default to creating a new SV for GvSV.
1202 Do this before embed. */
1203 #ifndef PERL_CREATE_GVSV
1204 # ifndef PERL_DONT_CREATE_GVSV
1205 # define PERL_DONT_CREATE_GVSV
1209 #if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
1210 #define PERL_USES_PL_PIDSTATUS
1213 #if !defined(OS2) && !defined(WIN32) && !defined(DJGPP)
1214 #define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
1217 #define MEM_SIZE Size_t
1219 /* Round all values passed to malloc up, by default to a multiple of
1222 #ifndef PERL_STRLEN_ROUNDUP_QUANTUM
1223 #define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
1226 /* sv_grow() will expand strings by at least a certain percentage of
1227 the previously *used* length to avoid excessive calls to realloc().
1228 The default is 25% of the current length.
1230 #ifndef PERL_STRLEN_EXPAND_SHIFT
1231 # define PERL_STRLEN_EXPAND_SHIFT 2
1234 /* This use of offsetof() requires /Zc:offsetof- for VS2017 (and presumably
1235 * onwards) when building Socket.xs, but we can just use a different definition
1236 * for STRUCT_OFFSET instead. */
1237 #if defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1910
1238 # define STRUCT_OFFSET(s,m) (Size_t)(&(((s *)0)->m))
1240 # include <stddef.h>
1241 # define STRUCT_OFFSET(s,m) offsetof(s,m)
1244 /* ptrdiff_t is C11, so undef it under pedantic builds. (Actually it is
1245 * in C89, but apparently there are platforms where it doesn't exist. See
1246 * thread beginning at http://nntp.perl.org/group/perl.perl5.porters/251541.)
1248 #ifdef PERL_GCC_PEDANTIC
1249 # undef HAS_PTRDIFF_T
1252 #ifdef HAS_PTRDIFF_T
1253 # define Ptrdiff_t ptrdiff_t
1255 # define Ptrdiff_t SSize_t
1258 # include <string.h>
1260 /* This comes after <stdlib.h> so we don't try to change the standard
1261 * library prototypes; we'll use our own in proto.h instead. */
1264 # ifdef PERL_POLLUTE_MALLOC
1265 # ifndef PERL_EXTMALLOC_DEF
1266 # define Perl_malloc malloc
1267 # define Perl_calloc calloc
1268 # define Perl_realloc realloc
1269 # define Perl_mfree free
1272 # define EMBEDMYMALLOC /* for compatibility */
1275 # define safemalloc Perl_malloc
1276 # define safecalloc Perl_calloc
1277 # define saferealloc Perl_realloc
1278 # define safefree Perl_mfree
1279 # define CHECK_MALLOC_TOO_LATE_FOR_(code) STMT_START { \
1280 if (!TAINTING_get && MallocCfg_ptr[MallocCfg_cfg_env_read]) \
1283 # define CHECK_MALLOC_TOO_LATE_FOR(ch) \
1284 CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
1285 # define panic_write2(s) write(2, s, strlen(s))
1286 # define CHECK_MALLOC_TAINT(newval) \
1287 CHECK_MALLOC_TOO_LATE_FOR_( \
1289 PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
1291 # define MALLOC_CHECK_TAINT(argc,argv,env) STMT_START { \
1292 if (doing_taint(argc,argv,env)) { \
1293 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1; \
1295 #else /* MYMALLOC */
1296 # define safemalloc safesysmalloc
1297 # define safecalloc safesyscalloc
1298 # define saferealloc safesysrealloc
1299 # define safefree safesysfree
1300 # define CHECK_MALLOC_TOO_LATE_FOR(ch) ((void)0)
1301 # define CHECK_MALLOC_TAINT(newval) ((void)0)
1302 # define MALLOC_CHECK_TAINT(argc,argv,env)
1303 #endif /* MYMALLOC */
1305 /* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
1306 #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)
1307 #define TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, "")
1308 #define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
1309 #define MALLOC_CHECK_TAINT2(argc,argv) MALLOC_CHECK_TAINT(argc,argv,NULL)
1312 # define memzero(d,l) memset(d,0,l)
1316 # include <netinet/in.h>
1320 # include <arpa/inet.h>
1324 # include <sys/stat.h>
1327 /* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1328 This definition should ideally go into win32/win32.h, but S_IFIFO is
1329 used later here in perl.h before win32/win32.h is being included. */
1330 #if !defined(S_IFIFO) && defined(_S_IFIFO)
1331 # define S_IFIFO _S_IFIFO
1334 /* The stat macros for Unisoft System V/88 (and derivatives
1335 like UTekV) are broken, sometimes giving false positives. Undefine
1336 them here and let the code below set them to proper values.
1338 The ghs macro stands for GreenHills Software C-1.8.5 which
1339 is the C compiler for sysV88 and the various derivatives.
1340 This header file bug is corrected in gcc-2.5.8 and later versions.
1341 --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94. */
1343 #if defined(m88k) && defined(ghs)
1355 # ifdef I_SYS_TIME_KERNEL
1358 # include <sys/time.h>
1359 # ifdef I_SYS_TIME_KERNEL
1364 #if defined(HAS_TIMES) && defined(I_SYS_TIMES)
1365 # include <sys/times.h>
1370 #if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
1371 # define WIN32SCK_IS_STDSCK /* don't pull in custom wsock layer */
1374 #if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1375 # include <sys/socket.h>
1376 # if defined(USE_SOCKS) && defined(I_SOCKS)
1377 # if !defined(INCLUDE_PROTOTYPES)
1378 # define INCLUDE_PROTOTYPES /* for <socks.h> */
1379 # define PERL_SOCKS_NEED_PROTOTYPES
1382 # ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1383 # undef INCLUDE_PROTOTYPES
1384 # undef PERL_SOCKS_NEED_PROTOTYPES
1395 # include <net/errno.h>
1400 /* sockatmark() is so new (2001) that many places might have it hidden
1401 * behind some -D_BLAH_BLAH_SOURCE guard. The __THROW magic is required
1402 * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
1403 #if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
1404 # if defined(__THROW) && defined(__GLIBC__)
1405 int sockatmark(int) __THROW;
1407 int sockatmark(int);
1411 #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. */
1412 EXTERN_C int fchdir(int);
1413 EXTERN_C int flock(int, int);
1414 EXTERN_C int fseeko(FILE *, off_t, int);
1415 EXTERN_C off_t ftello(FILE *);
1418 #if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1419 EXTERN_C char *crypt(const char *, const char *);
1422 #if defined(__cplusplus) && defined(__CYGWIN__)
1423 EXTERN_C char *crypt(const char *, const char *);
1427 =for apidoc_section Errno
1429 =for apidoc m|void|SETERRNO|int errcode|int vmserrcode
1431 Set C<errno>, and on VMS set C<vaxc$errno>.
1433 =for apidoc mn|void|dSAVEDERRNO
1435 Declare variables needed to save C<errno> and any operating system
1436 specific error number.
1438 =for apidoc mn|void|dSAVE_ERRNO
1440 Declare variables needed to save C<errno> and any operating system
1441 specific error number, and save them for optional later restoration
1442 by C<RESTORE_ERRNO>.
1444 =for apidoc mn|void|SAVE_ERRNO
1446 Save C<errno> and any operating system specific error number for
1447 optional later restoration by C<RESTORE_ERRNO>. Requires
1448 C<dSAVEDERRNO> or C<dSAVE_ERRNO> in scope.
1450 =for apidoc mn|void|RESTORE_ERRNO
1452 Restore C<errno> and any operating system specific error number that
1453 was saved by C<dSAVE_ERRNO> or C<RESTORE_ERRNO>.
1459 # undef SETERRNO /* SOCKS might have defined this */
1463 # define SETERRNO(errcode,vmserrcode) \
1465 set_errno(errcode); \
1466 set_vaxc_errno(vmserrcode); \
1468 # define dSAVEDERRNO int saved_errno; unsigned saved_vms_errno
1469 # define dSAVE_ERRNO int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1470 # define SAVE_ERRNO ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1471 # define RESTORE_ERRNO SETERRNO(saved_errno, saved_vms_errno)
1473 # define LIB_INVARG LIB$_INVARG
1474 # define RMS_DIR RMS$_DIR
1475 # define RMS_FAC RMS$_FAC
1476 # define RMS_FEX RMS$_FEX
1477 # define RMS_FNF RMS$_FNF
1478 # define RMS_IFI RMS$_IFI
1479 # define RMS_ISI RMS$_ISI
1480 # define RMS_PRV RMS$_PRV
1481 # define SS_ACCVIO SS$_ACCVIO
1482 # define SS_DEVOFFLINE SS$_DEVOFFLINE
1483 # define SS_IVCHAN SS$_IVCHAN
1484 # define SS_NORMAL SS$_NORMAL
1485 # define SS_NOPRIV SS$_NOPRIV
1486 # define SS_BUFFEROVF SS$_BUFFEROVF
1488 # define LIB_INVARG 0
1496 # define SS_ACCVIO 0
1497 # define SS_DEVOFFLINE 0
1498 # define SS_IVCHAN 0
1499 # define SS_NORMAL 0
1500 # define SS_NOPRIV 0
1501 # define SS_BUFFEROVF 0
1505 # define dSAVEDERRNO int saved_errno; DWORD saved_win32_errno
1506 # define dSAVE_ERRNO int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1507 # define SAVE_ERRNO ( saved_errno = errno, saved_win32_errno = GetLastError() )
1508 # define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1512 # define dSAVEDERRNO int saved_errno; unsigned long saved_os2_errno
1513 # define dSAVE_ERRNO int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1514 # define SAVE_ERRNO ( saved_errno = errno, saved_os2_errno = Perl_rc )
1515 # define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1519 # define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1523 # define dSAVEDERRNO int saved_errno
1524 # define dSAVE_ERRNO int saved_errno = errno
1525 # define SAVE_ERRNO (saved_errno = errno)
1526 # define RESTORE_ERRNO (errno = saved_errno)
1530 =for apidoc_section Warning and Dieing
1532 =for apidoc Amn|SV *|ERRSV
1534 Returns the SV for C<$@>, creating it if needed.
1536 =for apidoc Am|void|CLEAR_ERRSV
1538 Clear the contents of C<$@>, setting it to the empty string.
1540 This replaces any read-only SV with a fresh SV and removes any magic.
1542 =for apidoc Am|void|SANE_ERRSV
1544 Clean up ERRSV so we can safely set it.
1546 This replaces any read-only SV with a fresh writable copy and removes
1552 #define ERRSV GvSVn(PL_errgv)
1554 /* contains inlined gv_add_by_type */
1555 #define CLEAR_ERRSV() STMT_START { \
1556 SV ** const svp = &GvSV(PL_errgv); \
1558 *svp = newSVpvs(""); \
1559 } else if (SvREADONLY(*svp)) { \
1560 SvREFCNT_dec_NN(*svp); \
1561 *svp = newSVpvs(""); \
1563 SV *const errsv = *svp; \
1565 SvPOK_only(errsv); \
1566 if (SvMAGICAL(errsv)) { \
1572 /* contains inlined gv_add_by_type */
1573 #define SANE_ERRSV() STMT_START { \
1574 SV ** const svp = &GvSV(PL_errgv); \
1576 *svp = newSVpvs(""); \
1577 } else if (SvREADONLY(*svp)) { \
1578 SV *dupsv = newSVsv(*svp); \
1579 SvREFCNT_dec_NN(*svp); \
1582 SV *const errsv = *svp; \
1583 if (SvMAGICAL(errsv)) { \
1591 # define DEFSV (0 + GvSVn(PL_defgv))
1592 # define DEFSV_set(sv) \
1593 (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1594 # define SAVE_DEFSV \
1596 save_gp(PL_defgv, 0), \
1597 GvINTRO_off(PL_defgv), \
1598 SAVEGENERICSV(GvSV(PL_defgv)), \
1599 GvSV(PL_defgv) = NULL \
1602 # define DEFSV GvSVn(PL_defgv)
1603 # define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1604 # define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
1608 =for apidoc_section SV Handling
1609 =for apidoc Amn|SV *|DEFSV
1610 Returns the SV associated with C<$_>
1612 =for apidoc Am|void|DEFSV_set|SV * sv
1613 Associate C<sv> with C<$_>
1615 =for apidoc Amn|void|SAVE_DEFSV
1616 Localize C<$_>. See L<perlguts/Localizing changes>.
1622 extern int errno; /* ANSI allows errno to be an lvalue expr.
1623 * For example in multithreaded environments
1624 * something like this might happen:
1625 * extern int *_errno(void);
1626 * #define errno (*_errno()) */
1629 #define UNKNOWN_ERRNO_MSG "(unknown)"
1632 #define Strerror(e) strerror((e), vaxc$errno)
1634 #define Strerror(e) strerror(e)
1639 # include <sys/ioctl.h>
1643 #if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
1644 # ifdef HAS_SOCKETPAIR
1645 # undef HAS_SOCKETPAIR
1652 #ifndef HAS_SOCKETPAIR
1654 # define socketpair Perl_my_socketpair
1659 # define htoni htons
1660 # define ntohi ntohs
1662 # define htoni htonl
1663 # define ntohi ntohl
1666 /* Configure already sets Direntry_t */
1667 #if defined(I_DIRENT)
1668 # include <dirent.h>
1669 #elif defined(I_SYS_NDIR)
1670 # include <sys/ndir.h>
1671 #elif defined(I_SYS_DIR)
1672 # include <sys/dir.h>
1676 * The following gobbledygook brought to you on behalf of __STDC__.
1677 * (I could just use #ifndef __STDC__, but this is more bulletproof
1678 * in the face of half-implementations.)
1681 #if defined(I_SYSMODE)
1682 #include <sys/mode.h>
1687 # define S_IFMT _S_IFMT
1689 # define S_IFMT 0170000
1694 # define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1698 # define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1703 # define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1705 # define S_ISBLK(m) (0)
1710 # define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1715 # define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1717 # define S_ISFIFO(m) (0)
1723 # define S_ISLNK(m) _S_ISLNK(m)
1724 # elif defined(_S_IFLNK)
1725 # define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1726 # elif defined(S_IFLNK)
1727 # define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1729 # define S_ISLNK(m) (0)
1735 # define S_ISSOCK(m) _S_ISSOCK(m)
1736 # elif defined(_S_IFSOCK)
1737 # define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1738 # elif defined(S_IFSOCK)
1739 # define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1741 # define S_ISSOCK(m) (0)
1747 # define S_IRUSR S_IREAD
1748 # define S_IWUSR S_IWRITE
1749 # define S_IXUSR S_IEXEC
1751 # define S_IRUSR 0400
1752 # define S_IWUSR 0200
1753 # define S_IXUSR 0100
1759 # define S_IRGRP (S_IRUSR>>3)
1760 # define S_IWGRP (S_IWUSR>>3)
1761 # define S_IXGRP (S_IXUSR>>3)
1763 # define S_IRGRP 0040
1764 # define S_IWGRP 0020
1765 # define S_IXGRP 0010
1771 # define S_IROTH (S_IRUSR>>6)
1772 # define S_IWOTH (S_IWUSR>>6)
1773 # define S_IXOTH (S_IXUSR>>6)
1775 # define S_IROTH 0040
1776 # define S_IWOTH 0020
1777 # define S_IXOTH 0010
1782 # define S_ISUID 04000
1786 # define S_ISGID 02000
1790 # define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
1794 # define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
1798 # define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
1801 /* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
1802 * which would get included through <sys/file.h >, but that is 3000
1803 * lines in the future. --jhi */
1805 #if !defined(S_IREAD) && !defined(__HAIKU__)
1806 # define S_IREAD S_IRUSR
1809 #if !defined(S_IWRITE) && !defined(__HAIKU__)
1810 # define S_IWRITE S_IWUSR
1814 # define S_IEXEC S_IXUSR
1817 #if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
1818 # define SLOPPYDIVIDE
1825 /* This used to be conditionally defined based on whether we had a sprintf()
1826 * that correctly returns the string length (as required by C89), but we no
1827 * longer need that. XS modules can (and do) use this name, so it must remain
1828 * a part of the API that's visible to modules.
1830 =for apidoc_section String Handling
1831 =for apidoc ATmD|int|my_sprintf|NN char *buffer|NN const char *pat|...
1833 Do NOT use this due to the possibility of overflowing C<buffer>. Instead use
1838 #define my_sprintf sprintf
1841 * If we have v?snprintf() and the C99 variadic macros, we can just
1842 * use just the v?snprintf(). It is nice to try to trap the buffer
1843 * overflow, however, so if we are DEBUGGING, and we cannot use the
1844 * gcc statement expressions, then use the function wrappers which try
1845 * to trap the overflow. If we can use the gcc statement expressions,
1846 * we can try that even with the version that uses the C99 variadic
1850 /* Note that we do not check against snprintf()/vsnprintf() returning
1851 * negative values because that is non-standard behaviour and we use
1852 * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1853 * that should be true only if the snprintf()/vsnprintf() are true
1854 * to the standard. */
1856 #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
1859 # define my_snprintf Perl_my_snprintf
1860 # define PERL_MY_SNPRINTF_GUARDED
1861 #elif defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1862 # ifdef PERL_USE_GCC_BRACE_GROUPS
1863 # define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1864 # define PERL_MY_SNPRINTF_GUARDED
1866 # define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
1869 # define my_snprintf Perl_my_snprintf
1870 # define PERL_MY_SNPRINTF_GUARDED
1873 /* There is no quadmath_vsnprintf, and therefore my_vsnprintf()
1874 * dies if called under USE_QUADMATH. */
1875 #if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1876 # ifdef PERL_USE_GCC_BRACE_GROUPS
1877 # define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1878 # define PERL_MY_VSNPRINTF_GUARDED
1880 # define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
1883 # define my_vsnprintf Perl_my_vsnprintf
1884 # define PERL_MY_VSNPRINTF_GUARDED
1887 /* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1888 * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1889 * the result of my_snprintf() or my_vsnprintf(). (No, you should not
1890 * completely ignore it: otherwise you cannot know whether your output
1893 * int len = my_sprintf(buf, max, ...);
1894 * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1896 * The trick is that in certain platforms [a] the my_sprintf() already
1897 * contains the sanity check, while in certain platforms [b] it needs
1898 * to be done as a separate step. The POST_GUARD is that step-- in [a]
1899 * platforms the POST_GUARD actually does nothing since the check has
1900 * already been done. Watch out for the max being the same in both calls.
1902 * If you actually use the snprintf/vsnprintf return value already,
1903 * you assumedly are checking its validity somehow. But you can
1904 * insert the POST_GUARD() also in that case. */
1906 #ifndef PERL_MY_SNPRINTF_GUARDED
1907 # define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1909 # define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1912 #ifndef PERL_MY_VSNPRINTF_GUARDED
1913 # define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
1915 # define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1919 # define my_strlcat strlcat
1922 #if defined(PERL_CORE) || defined(PERL_EXT)
1924 # define my_memrchr memrchr
1926 # define my_memrchr S_my_memrchr
1931 # define my_strlcpy strlcpy
1935 # define my_strnlen strnlen
1939 The IV type is supposed to be long enough to hold any integral
1941 --Andy Dougherty August 1996
1947 #if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
1948 # if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
1949 # define IV_MAX ((IV)INT64_MAX)
1950 # define IV_MIN ((IV)INT64_MIN)
1951 # define UV_MAX ((UV)UINT64_MAX)
1953 # define UINT64_MIN 0
1955 # define UV_MIN ((UV)UINT64_MIN)
1957 # define IV_MAX PERL_QUAD_MAX
1958 # define IV_MIN PERL_QUAD_MIN
1959 # define UV_MAX PERL_UQUAD_MAX
1960 # define UV_MIN PERL_UQUAD_MIN
1965 # if defined(INT32_MAX) && IVSIZE == 4
1966 # define IV_MAX ((IV)INT32_MAX)
1967 # define IV_MIN ((IV)INT32_MIN)
1968 # ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
1969 # define UV_MAX ((UV)UINT32_MAX)
1971 # define UV_MAX ((UV)4294967295U)
1974 # define UINT32_MIN 0
1976 # define UV_MIN ((UV)UINT32_MIN)
1978 # define IV_MAX PERL_LONG_MAX
1979 # define IV_MIN PERL_LONG_MIN
1980 # define UV_MAX PERL_ULONG_MAX
1981 # define UV_MIN PERL_ULONG_MIN
1992 #if !defined(PERL_CORE)
1993 /* We think that removing this decade-old undef this will cause too much
1994 breakage on CPAN for too little gain. (See RT #119753)
1995 However, we do need HAS_QUAD in the core for use by the drand48 code. */
2001 #define Size_t_MAX (~(Size_t)0)
2002 #define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
2004 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
2005 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
2007 #ifndef NO_PERL_PRESERVE_IVUV
2008 #define PERL_PRESERVE_IVUV /* We like our integers to stay integers. */
2012 * The macros INT2PTR and NUM2PTR are (despite their names)
2013 * bi-directional: they will convert int/float to or from pointers.
2014 * However the conversion to int/float are named explicitly:
2015 * PTR2IV, PTR2UV, PTR2NV.
2017 * For int conversions we do not need two casts if pointers are
2018 * the same size as IV and UV. Otherwise we need an explicit
2019 * cast (PTRV) to avoid compiler warnings.
2021 * These are mentioned in perlguts
2023 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
2025 # define INT2PTR(any,d) (any)(d)
2026 #elif PTRSIZE == LONGSIZE
2027 # define PTRV unsigned long
2028 # define PTR2ul(p) (unsigned long)(p)
2030 # define PTRV unsigned
2034 # define INT2PTR(any,d) (any)(PTRV)(d)
2038 # define PTR2ul(p) INT2PTR(unsigned long,p)
2041 #define NUM2PTR(any,d) (any)(PTRV)(d)
2042 #define PTR2IV(p) INT2PTR(IV,p)
2043 #define PTR2UV(p) INT2PTR(UV,p)
2044 #define PTR2NV(p) NUM2PTR(NV,p)
2045 #define PTR2nat(p) (PTRV)(p) /* pointer to integer of PTRSIZE */
2047 /* According to strict ANSI C89 one cannot freely cast between
2048 * data pointers and function (code) pointers. There are at least
2049 * two ways around this. One (used below) is to do two casts,
2050 * first the other pointer to an (unsigned) integer, and then
2051 * the integer to the other pointer. The other way would be
2052 * to use unions to "overlay" the pointers. For an example of
2053 * the latter technique, see union dirpu in struct xpvio in sv.h.
2054 * The only feasible use is probably temporarily storing
2055 * function pointers in a data pointer (such as a void pointer). */
2057 #define DPTR2FPTR(t,p) ((t)PTR2nat(p)) /* data pointer to function pointer */
2058 #define FPTR2DPTR(t,p) ((t)PTR2nat(p)) /* function pointer to data pointer */
2060 #ifdef USE_LONG_DOUBLE
2061 # if LONG_DOUBLESIZE == DOUBLESIZE
2062 # define LONG_DOUBLE_EQUALS_DOUBLE
2063 # undef USE_LONG_DOUBLE /* Ouch! */
2067 /* The following is all to get LDBL_DIG, in order to pick a nice
2068 default value for printing floating point numbers in Gconvert.
2071 #ifndef HAS_LDBL_DIG
2072 # if LONG_DOUBLESIZE == 10
2073 # define LDBL_DIG 18 /* assume IEEE */
2074 # elif LONG_DOUBLESIZE == 12
2075 # define LDBL_DIG 18 /* gcc? */
2076 # elif LONG_DOUBLESIZE == 16
2077 # define LDBL_DIG 33 /* assume IEEE */
2078 # elif LONG_DOUBLESIZE == DOUBLESIZE
2079 # define LDBL_DIG DBL_DIG /* bummer */
2086 # include <ieeefp.h>
2089 #if defined(__DECC) && defined(__osf__)
2090 /* Also Tru64 cc has broken NaN comparisons. */
2091 # define NAN_COMPARE_BROKEN
2094 # define NAN_COMPARE_BROKEN
2097 #ifdef USE_LONG_DOUBLE
2099 # include <sunmath.h>
2101 # if defined(LDBL_DIG)
2102 # define NV_DIG LDBL_DIG
2103 # ifdef LDBL_MANT_DIG
2104 # define NV_MANT_DIG LDBL_MANT_DIG
2107 # define NV_MIN LDBL_MIN
2110 # define NV_MAX LDBL_MAX
2112 # ifdef LDBL_MIN_EXP
2113 # define NV_MIN_EXP LDBL_MIN_EXP
2115 # ifdef LDBL_MAX_EXP
2116 # define NV_MAX_EXP LDBL_MAX_EXP
2118 # ifdef LDBL_MIN_10_EXP
2119 # define NV_MIN_10_EXP LDBL_MIN_10_EXP
2121 # ifdef LDBL_MAX_10_EXP
2122 # define NV_MAX_10_EXP LDBL_MAX_10_EXP
2124 # ifdef LDBL_EPSILON
2125 # define NV_EPSILON LDBL_EPSILON
2128 # define NV_MAX LDBL_MAX
2129 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
2130 # elif defined(HUGE_VALL)
2131 # define NV_MAX HUGE_VALL
2134 # if defined(HAS_SQRTL)
2135 # define Perl_acos acosl
2136 # define Perl_asin asinl
2137 # define Perl_atan atanl
2138 # define Perl_atan2 atan2l
2139 # define Perl_ceil ceill
2140 # define Perl_cos cosl
2141 # define Perl_cosh coshl
2142 # define Perl_exp expl
2143 /* no Perl_fabs, but there's PERL_ABS */
2144 # define Perl_floor floorl
2145 # define Perl_fmod fmodl
2146 # define Perl_log logl
2147 # define Perl_log10 log10l
2148 # define Perl_pow powl
2149 # define Perl_sin sinl
2150 # define Perl_sinh sinhl
2151 # define Perl_sqrt sqrtl
2152 # define Perl_tan tanl
2153 # define Perl_tanh tanhl
2155 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
2158 # define Perl_modf(x,y) modfl(x,y)
2159 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
2160 prototype in <math.h> */
2161 # ifndef HAS_MODFL_PROTO
2162 EXTERN_C long double modfl(long double, long double *);
2164 # elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
2165 extern long double Perl_my_modfl(long double x, long double *ip);
2166 # define Perl_modf(x,y) Perl_my_modfl(x,y)
2171 # define Perl_frexp(x,y) frexpl(x,y)
2172 # elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
2173 extern long double Perl_my_frexpl(long double x, int *e);
2174 # define Perl_frexp(x,y) Perl_my_frexpl(x,y)
2179 # define Perl_ldexp(x, y) ldexpl(x,y)
2180 # elif defined(HAS_SCALBNL) && FLT_RADIX == 2
2181 # define Perl_ldexp(x,y) scalbnl(x,y)
2185 # if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
2186 # define Perl_isnan(x) isnanl(x)
2187 # elif defined(__sgi) && defined(__c99) /* XXX Configure test needed */
2188 # define Perl_isnan(x) isnan(x)
2192 # if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
2193 # define Perl_isinf(x) isinfl(x)
2194 # elif defined(__sgi) && defined(__c99) /* XXX Configure test needed */
2195 # define Perl_isinf(x) isinf(x)
2196 # elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2197 # define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
2200 # ifndef Perl_isfinite
2201 # define Perl_isfinite(x) Perl_isfinitel(x)
2203 #elif defined(USE_QUADMATH) && defined(I_QUADMATH)
2204 # include <quadmath.h>
2205 # define NV_DIG FLT128_DIG
2206 # define NV_MANT_DIG FLT128_MANT_DIG
2207 # define NV_MIN FLT128_MIN
2208 # define NV_MAX FLT128_MAX
2209 # define NV_MIN_EXP FLT128_MIN_EXP
2210 # define NV_MAX_EXP FLT128_MAX_EXP
2211 # define NV_EPSILON FLT128_EPSILON
2212 # define NV_MIN_10_EXP FLT128_MIN_10_EXP
2213 # define NV_MAX_10_EXP FLT128_MAX_10_EXP
2214 # define Perl_acos acosq
2215 # define Perl_asin asinq
2216 # define Perl_atan atanq
2217 # define Perl_atan2 atan2q
2218 # define Perl_ceil ceilq
2219 # define Perl_cos cosq
2220 # define Perl_cosh coshq
2221 # define Perl_exp expq
2222 /* no Perl_fabs, but there's PERL_ABS */
2223 # define Perl_floor floorq
2224 # define Perl_fmod fmodq
2225 # define Perl_log logq
2226 # define Perl_log10 log10q
2227 # define Perl_signbit signbitq
2228 # define Perl_pow powq
2229 # define Perl_sin sinq
2230 # define Perl_sinh sinhq
2231 # define Perl_sqrt sqrtq
2232 # define Perl_tan tanq
2233 # define Perl_tanh tanhq
2234 # define Perl_modf(x,y) modfq(x,y)
2235 # define Perl_frexp(x,y) frexpq(x,y)
2236 # define Perl_ldexp(x, y) ldexpq(x,y)
2237 # define Perl_isinf(x) isinfq(x)
2238 # define Perl_isnan(x) isnanq(x)
2239 # define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
2240 # define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
2241 # define Perl_fp_class_inf(x) (Perl_fp_class(x) == 3)
2242 # define Perl_fp_class_nan(x) (Perl_fp_class(x) == 4)
2243 # define Perl_fp_class_norm(x) (Perl_fp_class(x) == 1)
2244 # define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
2245 # define Perl_fp_class_zero(x) (Perl_fp_class(x) == 0)
2247 # define NV_DIG DBL_DIG
2248 # define NV_MANT_DIG DBL_MANT_DIG
2249 # define NV_MIN DBL_MIN
2250 # define NV_MAX DBL_MAX
2251 # define NV_MIN_EXP DBL_MIN_EXP
2252 # define NV_MAX_EXP DBL_MAX_EXP
2253 # define NV_MIN_10_EXP DBL_MIN_10_EXP
2254 # define NV_MAX_10_EXP DBL_MAX_10_EXP
2255 # define NV_EPSILON DBL_EPSILON
2256 # define NV_MAX DBL_MAX
2257 # define NV_MIN DBL_MIN
2259 /* These math interfaces are C89. */
2260 # define Perl_acos acos
2261 # define Perl_asin asin
2262 # define Perl_atan atan
2263 # define Perl_atan2 atan2
2264 # define Perl_ceil ceil
2265 # define Perl_cos cos
2266 # define Perl_cosh cosh
2267 # define Perl_exp exp
2268 /* no Perl_fabs, but there's PERL_ABS */
2269 # define Perl_floor floor
2270 # define Perl_fmod fmod
2271 # define Perl_log log
2272 # define Perl_log10 log10
2273 # define Perl_pow pow
2274 # define Perl_sin sin
2275 # define Perl_sinh sinh
2276 # define Perl_sqrt sqrt
2277 # define Perl_tan tan
2278 # define Perl_tanh tanh
2280 # define Perl_modf(x,y) modf(x,y)
2281 # define Perl_frexp(x,y) frexp(x,y)
2282 # define Perl_ldexp(x,y) ldexp(x,y)
2286 # define Perl_isnan(x) isnan(x)
2290 # if defined(HAS_ISINF)
2291 # define Perl_isinf(x) isinf(x)
2292 # elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2293 # define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
2296 # ifndef Perl_isfinite
2297 # ifdef HAS_ISFINITE
2298 # define Perl_isfinite(x) isfinite(x)
2299 # elif defined(HAS_FINITE)
2300 # define Perl_isfinite(x) finite(x)
2305 /* fpclassify(): C99. It is supposed to be a macro that switches on
2306 * the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
2307 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2309 # if defined(FP_INFINITE) && defined(FP_NAN)
2310 # define Perl_fp_class(x) fpclassify(x)
2311 # define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_INFINITE)
2312 # define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_NAN)
2313 # define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_NORMAL)
2314 # define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2315 # define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_ZERO)
2316 # elif defined(FP_PLUS_INF) && defined(FP_QNAN)
2317 /* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
2318 * actually not the C99 fpclassify, with its own set of return defines. */
2319 # define Perl_fp_class(x) fpclassify(x)
2320 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
2321 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
2322 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2323 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2324 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
2325 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
2326 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
2327 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
2328 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
2329 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
2331 # undef Perl_fp_class /* Unknown set of defines */
2335 /* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
2336 * are identical to the C99 fpclassify(). */
2337 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
2340 /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
2342 /* oh, and the isnormal macro has a typo in it! */
2344 # define isnormal(x) Perl_fp_class_norm(x)
2346 # if defined(FP_INFINITE) && defined(FP_NAN)
2347 # define Perl_fp_class(x) fp_classify(x)
2348 # define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_INFINITE)
2349 # define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_NAN)
2350 # define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_NORMAL)
2351 # define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2352 # define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_ZERO)
2354 # undef Perl_fp_class /* Unknown set of defines */
2358 /* Feel free to check with me for the SGI manpages, SGI testing,
2359 * etcetera, if you want to try getting this to work with IRIX.
2361 * - Allen <allens@cpan.org> */
2363 /* fpclass(): SysV, at least Solaris and some versions of IRIX. */
2364 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
2365 /* Solaris and IRIX have fpclass/fpclassl, but they are using
2366 * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2367 * Define some symbols also as cpp symbols so we can detect them. */
2368 # if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
2369 # define FP_PINF FP_PINF
2370 # define FP_QNAN FP_QNAN
2374 # include <ieeefp.h>
2379 # if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
2380 # define Perl_fp_class(x) fpclassl(x)
2382 # define Perl_fp_class(x) fpclass(x)
2384 # if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
2385 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_CLASS_SNAN)
2386 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_CLASS_QNAN)
2387 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_CLASS_NINF)
2388 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_CLASS_PINF)
2389 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_CLASS_NNORM)
2390 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_CLASS_PNORM)
2391 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_CLASS_NDENORM)
2392 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_CLASS_PDENORM)
2393 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_CLASS_NZERO)
2394 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_CLASS_PZERO)
2395 # elif defined(FP_PINF) && defined(FP_QNAN)
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_ninf(x) (Perl_fp_class(x)==FP_NINF)
2399 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PINF)
2400 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_NNORM)
2401 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PNORM)
2402 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_NDENORM)
2403 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PDENORM)
2404 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_NZERO)
2405 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PZERO)
2407 # undef Perl_fp_class /* Unknown set of defines */
2411 /* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2412 #if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
2414 # if !defined(FP_SNAN) && defined(I_FP_CLASS)
2415 # include <fp_class.h>
2417 # if defined(FP_POS_INF) && defined(FP_QNAN)
2418 # ifdef __sgi /* XXX Configure test instead */
2419 # ifdef USE_LONG_DOUBLE
2420 # define Perl_fp_class(x) fp_class_l(x)
2422 # define Perl_fp_class(x) fp_class_d(x)
2425 # if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2426 # define Perl_fp_class(x) fp_classl(x)
2428 # define Perl_fp_class(x) fp_class(x)
2431 # if defined(FP_POS_INF) && defined(FP_QNAN)
2432 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2433 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2434 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_NEG_INF)
2435 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_POS_INF)
2436 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_NEG_NORM)
2437 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_POS_NORM)
2438 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_NEG_DENORM)
2439 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_POS_DENORM)
2440 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_NEG_ZERO)
2441 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_POS_ZERO)
2443 # undef Perl_fp_class /* Unknown set of defines */
2448 /* class(), _class(): Legacy: AIX. */
2449 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2451 # if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2453 # define Perl_fp_class(x) class(x)
2455 # define Perl_fp_class(x) _class(x)
2457 # if defined(FP_PLUS_INF) && defined(FP_NANQ)
2458 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_NANS)
2459 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_NANQ)
2460 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
2461 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
2462 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
2463 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
2464 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
2465 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
2466 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
2467 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
2469 # undef Perl_fp_class /* Unknown set of defines */
2474 /* Win32: _fpclass(), _isnan(), _finite(). */
2477 # define Perl_isnan(x) _isnan(x)
2479 # ifndef Perl_isfinite
2480 # define Perl_isfinite(x) _finite(x)
2482 # ifndef Perl_fp_class_snan
2483 /* No simple way to #define Perl_fp_class because _fpclass()
2484 * returns a set of bits. */
2485 # define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2486 # define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
2487 # define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
2488 # define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF))
2489 # define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF))
2490 # define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2491 # define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2492 # define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2493 # define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2494 # define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2495 # define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2496 # define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2497 # define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2498 # define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2499 # define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2503 #if !defined(Perl_fp_class_inf) && \
2504 defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2505 # define Perl_fp_class_inf(x) \
2506 (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2509 #if !defined(Perl_fp_class_nan) && \
2510 defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2511 # define Perl_fp_class_nan(x) \
2512 (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2515 #if !defined(Perl_fp_class_zero) && \
2516 defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2517 # define Perl_fp_class_zero(x) \
2518 (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2521 #if !defined(Perl_fp_class_norm) && \
2522 defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2523 # define Perl_fp_class_norm(x) \
2524 (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2527 #if !defined(Perl_fp_class_denorm) && \
2528 defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2529 # define Perl_fp_class_denorm(x) \
2530 (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
2534 # ifdef Perl_fp_class_nan
2535 # define Perl_isnan(x) Perl_fp_class_nan(x)
2536 # elif defined(HAS_UNORDERED)
2537 # define Perl_isnan(x) unordered((x), 0.0)
2539 # define Perl_isnan(x) ((x)!=(x))
2544 # ifdef Perl_fp_class_inf
2545 # define Perl_isinf(x) Perl_fp_class_inf(x)
2549 #ifndef Perl_isfinite
2550 # if defined(HAS_ISFINITE) && !defined(isfinite)
2551 # define Perl_isfinite(x) isfinite((double)(x))
2552 # elif defined(HAS_FINITE)
2553 # define Perl_isfinite(x) finite((double)(x))
2554 # elif defined(Perl_fp_class_finite)
2555 # define Perl_isfinite(x) Perl_fp_class_finite(x)
2557 /* For the infinities the multiplication returns nan,
2558 * for the nan the multiplication also returns nan,
2559 * for everything else (that is, finite) zero should be returned. */
2560 # define Perl_isfinite(x) (((x) * 0) == 0)
2565 # if defined(Perl_isfinite) && defined(Perl_isnan)
2566 # define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2570 /* We need Perl_isfinitel (ends with ell) (if available) even when
2571 * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2573 #if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2574 /* If isfinite() is a macro and looks like we have C99,
2575 * we assume it's the type-aware C99 isfinite(). */
2576 # if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
2577 # define Perl_isfinitel(x) isfinite(x)
2578 # elif defined(HAS_ISFINITEL)
2579 # define Perl_isfinitel(x) isfinitel(x)
2580 # elif defined(HAS_FINITEL)
2581 # define Perl_isfinitel(x) finitel(x)
2582 # elif defined(HAS_INFL) && defined(HAS_NANL)
2583 # define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
2585 # define Perl_isfinitel(x) ((x) * 0 == 0) /* See Perl_isfinite. */
2589 /* The default is to use Perl's own atof() implementation (in numeric.c).
2590 * Usually that is the one to use but for some platforms (e.g. UNICOS)
2591 * it is however best to use the native implementation of atof.
2592 * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2593 * Some good tests to try out with either setting are t/base/num.t,
2594 * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2595 * you may need to be using a different function than atof! */
2597 #ifndef USE_PERL_ATOF
2599 # define USE_PERL_ATOF
2602 # if USE_PERL_ATOF == 0
2603 # undef USE_PERL_ATOF
2607 #ifdef USE_PERL_ATOF
2608 # define Perl_atof(s) Perl_my_atof(s)
2609 # define Perl_atof2(s, n) Perl_my_atof3(aTHX_ (s), &(n), 0)
2611 # define Perl_atof(s) (NV)atof(s)
2612 # define Perl_atof2(s, n) ((n) = atof(s))
2614 #define my_atof2(a,b) my_atof3(a,b,0)
2617 * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2618 * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2619 * depending on local options. Until Configure detects this (or at least
2620 * detects whether the "signed" keyword is available) the CHAR ranges
2621 * will not be included. UCHAR functions normally.
2625 #define PERL_UCHAR_MIN ((unsigned char)0)
2626 #define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2628 #define PERL_USHORT_MIN ((unsigned short)0)
2629 #define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2631 #define PERL_SHORT_MAX ((short)SHRT_MAX)
2632 #define PERL_SHORT_MIN ((short)SHRT_MIN)
2634 #define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2635 #define PERL_UINT_MIN ((unsigned int)0)
2637 #define PERL_INT_MAX ((int)INT_MAX)
2638 #define PERL_INT_MIN ((int)INT_MIN)
2640 #define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2641 #define PERL_ULONG_MIN ((unsigned long)0L)
2643 #define PERL_LONG_MAX ((long)LONG_MAX)
2644 #define PERL_LONG_MIN ((long)LONG_MIN)
2647 # define PERL_UQUAD_MAX (~(UV)0)
2648 # define PERL_UQUAD_MIN ((UV)0)
2649 # define PERL_QUAD_MAX ((IV) (PERL_UQUAD_MAX >> 1))
2650 # define PERL_QUAD_MIN (-PERL_QUAD_MAX - ((3 & -1) == 3))
2654 =for apidoc_section Integer configuration values
2656 =for apidoc AmnU||PERL_INT_MAX
2657 =for apidoc_item ||PERL_INT_MIN
2658 =for apidoc_item ||PERL_LONG_MAX
2659 =for apidoc_item ||PERL_LONG_MIN
2660 =for apidoc_item ||PERL_SHORT_MAX
2661 =for apidoc_item ||PERL_SHORT_MIN
2662 =for apidoc_item ||PERL_UCHAR_MAX
2663 =for apidoc_item ||PERL_UCHAR_MIN
2664 =for apidoc_item ||PERL_UINT_MAX
2665 =for apidoc_item ||PERL_UINT_MIN
2666 =for apidoc_item ||PERL_ULONG_MAX
2667 =for apidoc_item ||PERL_ULONG_MIN
2668 =for apidoc_item ||PERL_USHORT_MAX
2669 =for apidoc_item ||PERL_USHORT_MIN
2670 =for apidoc_item ||PERL_QUAD_MAX
2671 =for apidoc_item ||PERL_QUAD_MIN
2672 =for apidoc_item ||PERL_UQUAD_MAX
2673 =for apidoc_item ||PERL_UQUAD_MIN
2675 These give the largest and smallest number representable in the current
2676 platform in variables of the corresponding types.
2678 For signed types, the smallest representable number is the most negative
2679 number, the one furthest away from zero.
2681 For C99 and later compilers, these correspond to things like C<INT_MAX>, which
2682 are available to the C code. But these constants, furnished by Perl,
2683 allow code compiled on earlier compilers to portably have access to the same
2690 typedef MEM_SIZE STRLEN;
2692 typedef struct op OP;
2693 typedef struct cop COP;
2694 typedef struct unop UNOP;
2695 typedef struct unop_aux UNOP_AUX;
2696 typedef struct binop BINOP;
2697 typedef struct listop LISTOP;
2698 typedef struct logop LOGOP;
2699 typedef struct pmop PMOP;
2700 typedef struct svop SVOP;
2701 typedef struct padop PADOP;
2702 typedef struct pvop PVOP;
2703 typedef struct loop LOOP;
2704 typedef struct methop METHOP;
2707 typedef struct opslab OPSLAB;
2708 typedef struct opslot OPSLOT;
2711 typedef struct block_hooks BHK;
2712 typedef struct custom_op XOP;
2714 typedef struct interpreter PerlInterpreter;
2716 /* SGI's <sys/sema.h> has struct sv */
2718 # define STRUCT_SV perl_sv
2720 # define STRUCT_SV sv
2722 typedef struct STRUCT_SV SV;
2723 typedef struct av AV;
2724 typedef struct hv HV;
2725 typedef struct cv CV;
2726 typedef struct p5rx REGEXP;
2727 typedef struct gp GP;
2728 typedef struct gv GV;
2729 typedef struct io IO;
2730 typedef struct context PERL_CONTEXT;
2731 typedef struct block BLOCK;
2733 typedef struct magic MAGIC;
2734 typedef struct xpv XPV;
2735 typedef struct xpviv XPVIV;
2736 typedef struct xpvuv XPVUV;
2737 typedef struct xpvnv XPVNV;
2738 typedef struct xpvmg XPVMG;
2739 typedef struct xpvlv XPVLV;
2740 typedef struct xpvinvlist XINVLIST;
2741 typedef struct xpvav XPVAV;
2742 typedef struct xpvhv XPVHV;
2743 typedef struct xpvgv XPVGV;
2744 typedef struct xpvcv XPVCV;
2745 typedef struct xpvbm XPVBM;
2746 typedef struct xpvfm XPVFM;
2747 typedef struct xpvio XPVIO;
2748 typedef struct mgvtbl MGVTBL;
2749 typedef union any ANY;
2750 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2751 typedef struct ptr_tbl PTR_TBL_t;
2752 typedef struct clone_params CLONE_PARAMS;
2754 /* a pad is currently just an AV; but that might change,
2755 * so hide the type. */
2756 typedef struct padlist PADLIST;
2758 typedef struct padnamelist PADNAMELIST;
2759 typedef struct padname PADNAME;
2761 /* always enable PERL_OP_PARENT */
2762 #if !defined(PERL_OP_PARENT)
2763 # define PERL_OP_PARENT
2766 /* enable PERL_COPY_ON_WRITE by default */
2767 #if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2768 # define PERL_COPY_ON_WRITE
2771 #ifdef PERL_COPY_ON_WRITE
2772 # define PERL_ANY_COW
2774 # define PERL_SAWAMPERSAND
2777 #if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2778 # error PERL_DEBUG_READONLY_OPS only works with ithreads
2782 #include "charclass_invlists.h"
2784 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2785 # if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2786 # define USE_64_BIT_RAWIO /* implicit */
2790 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2791 * fseeko/ftello if possible. Don't go #defining ftell to ftello yourself,
2792 * however, because operating systems like to do that themself. */
2795 # define FSEEKSIZE LSEEKSIZE
2797 # define FSEEKSIZE LONGSIZE
2801 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2802 # if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2803 # define USE_64_BIT_STDIO /* implicit */
2807 #ifdef USE_64_BIT_RAWIO
2810 # define Off_t off64_t
2812 # define LSEEKSIZE 8
2814 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2815 * will trigger defines like the ones below. Some 64-bit environments,
2816 * however, do not. Therefore we have to explicitly mix and match. */
2817 # if defined(USE_OPEN64)
2818 # define open open64
2820 # if defined(USE_LSEEK64)
2821 # define lseek lseek64
2823 # if defined(USE_LLSEEK)
2824 # define lseek llseek
2827 # if defined(USE_STAT64)
2828 # define stat stat64
2830 # if defined(USE_FSTAT64)
2831 # define fstat fstat64
2833 # if defined(USE_LSTAT64)
2834 # define lstat lstat64
2836 # if defined(USE_FLOCK64)
2837 # define flock flock64
2839 # if defined(USE_LOCKF64)
2840 # define lockf lockf64
2842 # if defined(USE_FCNTL64)
2843 # define fcntl fcntl64
2845 # if defined(USE_TRUNCATE64)
2846 # define truncate truncate64
2848 # if defined(USE_FTRUNCATE64)
2849 # define ftruncate ftruncate64
2853 #ifdef USE_64_BIT_STDIO
2854 # ifdef HAS_FPOS64_T
2856 # define Fpos_t fpos64_t
2858 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2859 * will trigger defines like the ones below. Some 64-bit environments,
2860 * however, do not. */
2861 # if defined(USE_FOPEN64)
2862 # define fopen fopen64
2864 # if defined(USE_FSEEK64)
2865 # define fseek fseek64 /* don't do fseeko here, see perlio.c */
2867 # if defined(USE_FTELL64)
2868 # define ftell ftell64 /* don't do ftello here, see perlio.c */
2870 # if defined(USE_FSETPOS64)
2871 # define fsetpos fsetpos64
2873 # if defined(USE_FGETPOS64)
2874 # define fgetpos fgetpos64
2876 # if defined(USE_TMPFILE64)
2877 # define tmpfile tmpfile64
2879 # if defined(USE_FREOPEN64)
2880 # define freopen freopen64
2885 # include "iperlsys.h"
2890 # include "os2ish.h"
2892 # include "dosish.h"
2895 # include "vmsish.h"
2896 #elif defined(PLAN9)
2897 # include "./plan9/plan9ish.h"
2898 #elif defined(__VOS__)
2900 # include "./vos/vosish.h"
2902 # include "vos/vosish.h"
2904 #elif defined(__HAIKU__)
2905 # include "haiku/haikuish.h"
2907 # include "unixish.h"
2911 # include "amigaos.h"
2912 # undef FD_CLOEXEC /* a lie in AmigaOS */
2915 /* NSIG logic from Configure --> */
2918 # define NSIG (_NSIG)
2919 # elif defined(SIGMAX)
2920 # define NSIG (SIGMAX+1)
2921 # elif defined(SIG_MAX)
2922 # define NSIG (SIG_MAX+1)
2923 # elif defined(_SIG_MAX)
2924 # define NSIG (_SIG_MAX+1)
2925 # elif defined(MAXSIG)
2926 # define NSIG (MAXSIG+1)
2927 # elif defined(MAX_SIG)
2928 # define NSIG (MAX_SIG+1)
2929 # elif defined(SIGARRAYSIZE)
2930 # define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
2931 # elif defined(_sys_nsig)
2932 # define NSIG (_sys_nsig) /* Solaris 2.5 */
2934 /* Default to some arbitrary number that's big enough to get most
2935 * of the common signals. */
2939 /* <-- NSIG logic from Configure */
2941 #ifndef NO_ENVIRON_ARRAY
2942 # define USE_ENVIRON_ARRAY
2946 /* On some platforms it would be safe to use a read/write mutex with many
2947 * readers possible at the same time. On other platforms, notably IBM ones,
2948 * subsequent getenv calls destroy earlier ones. Those platforms would not
2949 * be able to handle simultaneous getenv calls */
2950 # define ENV_LOCK MUTEX_LOCK(&PL_env_mutex)
2951 # define ENV_UNLOCK MUTEX_UNLOCK(&PL_env_mutex)
2952 # define ENV_INIT MUTEX_INIT(&PL_env_mutex);
2953 # define ENV_TERM MUTEX_DESTROY(&PL_env_mutex);
2955 # define ENV_LOCK NOOP;
2956 # define ENV_UNLOCK NOOP;
2957 # define ENV_INIT NOOP;
2958 # define ENV_TERM NOOP;
2961 /* Some critical sections need to lock both the locale and the environment.
2962 * XXX khw intends to change this to lock both mutexes, but that brings up
2963 * issues of potential deadlock, so should be done at the beginning of a
2964 * development cycle. So for now, it just locks the environment. Note that
2965 * many modern platforms are locale-thread-safe anyway, so locking the locale
2966 * mutex is a no-op anyway */
2967 #define ENV_LOCALE_LOCK ENV_LOCK
2968 #define ENV_LOCALE_UNLOCK ENV_UNLOCK
2970 /* And some critical sections care only that no one else is writing either the
2971 * locale nor the environment. XXX Again this is for the future. This can be
2972 * simulated with using COND_WAIT in thread.h */
2973 #define ENV_LOCALE_READ_LOCK ENV_LOCALE_LOCK
2974 #define ENV_LOCALE_READ_UNLOCK ENV_LOCALE_UNLOCK
2976 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
2977 /* having sigaction(2) means that the OS supports both 1-arg and 3-arg
2978 * signal handlers. But the perl core itself only fully supports 1-arg
2979 * handlers, so don't enable for now.
2980 * NB: POSIX::sigaction() supports both.
2982 * # define PERL_USE_3ARG_SIGHANDLER
2987 * This is an alias for the OS's siginfo_t, except that where the OS
2988 * doesn't support it, declare a dummy version instead. This allows us to
2989 * have signal handler functions which always have a Siginfo_t parameter
2990 * regardless of platform, (and which will just be passed a NULL value
2991 * where the OS doesn't support HAS_SIGACTION).
2994 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
2995 typedef siginfo_t Siginfo_t;
2997 #ifdef si_signo /* minix */
3007 * initialise to avoid floating-point exceptions from overflow, etc
3009 #ifndef PERL_FPU_INIT
3010 # ifdef HAS_FPSETMASK
3011 # if HAS_FLOATINGPOINT_H
3012 # include <floatingpoint.h>
3014 /* Some operating systems have this as a macro, which in turn expands to a comma
3015 expression, and the last sub-expression is something that gets calculated,
3016 and then they have the gall to warn that a value computed is not used. Hence
3018 # define PERL_FPU_INIT (void)fpsetmask(0)
3019 # elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
3020 # define PERL_FPU_INIT PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
3021 # define PERL_FPU_PRE_EXEC { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
3022 # define PERL_FPU_POST_EXEC rsignal_restore(SIGFPE, &xfpe); }
3024 # define PERL_FPU_INIT
3027 #ifndef PERL_FPU_PRE_EXEC
3028 # define PERL_FPU_PRE_EXEC {
3029 # define PERL_FPU_POST_EXEC }
3032 /* In Tru64 the cc -ieee enables the IEEE math but disables traps.
3033 * We need to reenable the "invalid" trap because otherwise generation
3034 * of NaN values leaves the IEEE fp flags in bad state, leaving any further
3035 * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
3037 # include <machine/fpu.h>
3038 # define PERL_SYS_FPU_INIT \
3040 ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
3041 signal(SIGFPE, SIG_IGN); \
3044 /* In IRIX the default for Flush to Zero bit is true,
3045 * which means that results going below the minimum of normal
3046 * floating points go to zero, instead of going denormal/subnormal.
3047 * This is unlike almost any other system running Perl, so let's clear it.
3048 * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
3049 * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
3051 * XXX The flush-to-zero behaviour should be a Configure scan.
3052 * To change the behaviour usually requires some system-specific
3053 * incantation, though, like the below. */
3055 # include <sys/fpu.h>
3056 # define PERL_SYS_FPU_INIT \
3058 union fpc_csr csr; \
3059 csr.fc_word = get_fpc_csr(); \
3060 csr.fc_struct.flush = 0; \
3061 set_fpc_csr(csr.fc_word); \
3065 #ifndef PERL_SYS_FPU_INIT
3066 # define PERL_SYS_FPU_INIT NOOP
3069 #ifndef PERL_SYS_INIT3_BODY
3070 # define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
3074 =for apidoc_section Embedding and Interpreter Cloning
3076 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
3077 Provides system-specific tune up of the C runtime environment necessary to
3078 run Perl interpreters. This should be called only once, before creating
3079 any Perl interpreters.
3081 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
3082 Provides system-specific tune up of the C runtime environment necessary to
3083 run Perl interpreters. This should be called only once, before creating
3084 any Perl interpreters.
3086 =for apidoc Am|void|PERL_SYS_TERM|
3087 Provides system-specific clean up of the C runtime environment after
3088 running Perl interpreters. This should be called only once, after
3089 freeing any remaining Perl interpreters.
3094 #define PERL_SYS_INIT(argc, argv) Perl_sys_init(argc, argv)
3095 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
3096 #define PERL_SYS_TERM() Perl_sys_term()
3098 #ifndef PERL_WRITE_MSG_TO_CONSOLE
3099 # define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
3104 # ifdef _POSIX_PATH_MAX
3105 # if PATH_MAX > _POSIX_PATH_MAX
3106 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
3107 * included the null byte or not. Later amendments of POSIX,
3108 * XPG4, the Austin Group, and the Single UNIX Specification
3109 * all explicitly include the null byte in the PATH_MAX.
3110 * Ditto for _POSIX_PATH_MAX. */
3111 # define MAXPATHLEN PATH_MAX
3113 # define MAXPATHLEN _POSIX_PATH_MAX
3116 # define MAXPATHLEN (PATH_MAX+1)
3119 # define MAXPATHLEN 1024 /* Err on the large side. */
3123 /* clang Thread Safety Analysis/Annotations/Attributes
3124 * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
3126 * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
3127 * Apple XCode hijacks __clang_major__ and __clang_minor__
3128 * (6.1 means really clang 3.6), so needs extra hijinks
3129 * (could probably also test the contents of __apple_build_version__).
3131 #if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
3132 defined(__clang__) && \
3134 ((!defined(__apple_build_version__) && \
3135 ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
3136 (__clang_major__ >= 4))) || \
3137 (defined(__apple_build_version__) && \
3138 ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
3139 (__clang_major__ >= 7))))
3140 # define PERL_TSA__(x) __attribute__((x))
3141 # define PERL_TSA_ACTIVE
3143 # define PERL_TSA__(x) /* No TSA, make TSA attributes no-ops. */
3144 # undef PERL_TSA_ACTIVE
3147 /* PERL_TSA_CAPABILITY() is used to annotate typedefs.
3148 * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
3150 #define PERL_TSA_CAPABILITY(x) \
3151 PERL_TSA__(capability(x))
3153 /* In the below examples the mutex must be lexically visible, usually
3154 * either as global variables, or as function arguments. */
3156 /* PERL_TSA_GUARDED_BY() is used to annotate global variables.
3158 * Foo foo PERL_TSA_GUARDED_BY(mutex);
3160 #define PERL_TSA_GUARDED_BY(x) \
3161 PERL_TSA__(guarded_by(x))
3163 /* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
3164 * The data _behind_ the pointer is guarded.
3166 * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
3168 #define PERL_TSA_PT_GUARDED_BY(x) \
3169 PERL_TSA__(pt_guarded_by(x))
3171 /* PERL_TSA_REQUIRES() is used to annotate functions.
3172 * The caller MUST hold the resource when calling the function.
3174 * void Foo() PERL_TSA_REQUIRES(mutex);
3176 #define PERL_TSA_REQUIRES(x) \
3177 PERL_TSA__(requires_capability(x))
3179 /* PERL_TSA_EXCLUDES() is used to annotate functions.
3180 * The caller MUST NOT hold resource when calling the function.
3182 * EXCLUDES should be used when the function first acquires
3183 * the resource and then releases it. Use to avoid deadlock.
3185 * void Foo() PERL_TSA_EXCLUDES(mutex);
3187 #define PERL_TSA_EXCLUDES(x) \
3188 PERL_TSA__(locks_excluded(x))
3190 /* PERL_TSA_ACQUIRE() is used to annotate functions.
3191 * The caller MUST NOT hold the resource when calling the function,
3192 * and the function will acquire the resource.
3194 * void Foo() PERL_TSA_ACQUIRE(mutex);
3196 #define PERL_TSA_ACQUIRE(x) \
3197 PERL_TSA__(acquire_capability(x))
3199 /* PERL_TSA_RELEASE() is used to annotate functions.
3200 * The caller MUST hold the resource when calling the function,
3201 * and the function will release the resource.
3203 * void Foo() PERL_TSA_RELEASE(mutex);
3205 #define PERL_TSA_RELEASE(x) \
3206 PERL_TSA__(release_capability(x))
3208 /* PERL_TSA_NO_TSA is used to annotate functions.
3209 * Used when being intentionally unsafe, or when the code is too
3210 * complicated for the analysis. Use sparingly.
3212 * void Foo() PERL_TSA_NO_TSA;
3214 #define PERL_TSA_NO_TSA \
3215 PERL_TSA__(no_thread_safety_analysis)
3217 /* There are more annotations/attributes available, see the clang
3218 * documentation for details. */
3220 #if defined(USE_ITHREADS)
3222 # include <nw5thread.h>
3223 # elif defined(WIN32)
3224 # include <win32thread.h>
3226 # include "os2thread.h"
3227 # elif defined(I_MACH_CTHREADS)
3228 # include <mach/cthreads.h>
3229 typedef cthread_t perl_os_thread;
3230 typedef mutex_t perl_mutex;
3231 typedef condition_t perl_cond;
3232 typedef void * perl_key;
3233 # elif defined(I_PTHREAD) /* Posix threads */
3234 # include <pthread.h>
3235 typedef pthread_t perl_os_thread;
3236 typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
3237 typedef pthread_cond_t perl_cond;
3238 typedef pthread_key_t perl_key;
3240 #endif /* USE_ITHREADS */
3242 #ifdef PERL_TSA_ACTIVE
3243 /* Since most pthread mutex interfaces have not been annotated, we
3244 * need to have these wrappers. The NO_TSA annotation is quite ugly
3245 * but it cannot be avoided in plain C, unlike in C++, where one could
3246 * e.g. use ACQUIRE() with no arg on a mutex lock method.
3248 * The bodies of these wrappers are in util.c
3250 * TODO: however, some platforms are starting to get these clang
3251 * thread safety annotations for pthreads, for example FreeBSD.
3252 * Do we need a way to a bypass these wrappers? */
3253 EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
3254 PERL_TSA_ACQUIRE(*mutex)
3256 EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
3257 PERL_TSA_RELEASE(*mutex)
3266 # include "netware.h"
3269 #define STATUS_UNIX PL_statusvalue
3271 # define STATUS_NATIVE PL_statusvalue_vms
3273 * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
3274 * its contents can not be trusted. Unfortunately, Perl seems to check
3275 * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
3278 # include <stsdef.h>
3280 /* Presume this because if VMS changes it, it will require a new
3281 * set of APIs for waiting on children for binary compatibility.
3283 # define child_offset_bits (8)
3284 # ifndef C_FAC_POSIX
3285 # define C_FAC_POSIX 0x35A000
3288 /* STATUS_EXIT - validates and returns a NATIVE exit status code for the
3289 * platform from the existing UNIX or Native status values.
3292 # define STATUS_EXIT \
3293 (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
3294 (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
3297 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
3298 * exit code and shifts the UNIX value over the correct number of bits to
3299 * be a child status. Usually the number of bits is 8, but that could be
3300 * platform dependent. The NATIVE status code is presumed to have either
3301 * from a child process.
3304 /* This is complicated. The child processes return a true native VMS
3305 status which must be saved. But there is an assumption in Perl that
3306 the UNIX child status has some relationship to errno values, so
3307 Perl tries to translate it to text in some of the tests.
3308 In order to get the string translation correct, for the error, errno
3309 must be EVMSERR, but that generates a different text message
3310 than what the test programs are expecting. So an errno value must
3311 be derived from the native status value when an error occurs.
3312 That will hide the true native status message. With this version of
3313 perl, the true native child status can always be retrieved so that
3314 is not a problem. But in this case, Pl_statusvalue and errno may
3315 have different values in them.
3318 # define STATUS_NATIVE_CHILD_SET(n) \
3320 I32 evalue = (I32)n; \
3321 if (evalue == EVMSERR) { \
3322 PL_statusvalue_vms = vaxc$errno; \
3323 PL_statusvalue = evalue; \
3325 PL_statusvalue_vms = evalue; \
3326 if (evalue == -1) { \
3327 PL_statusvalue = -1; \
3328 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3330 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1); \
3331 set_vaxc_errno(evalue); \
3332 if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX) \
3333 set_errno(EVMSERR); \
3334 else set_errno(Perl_vms_status_to_unix(evalue, 0)); \
3335 PL_statusvalue = PL_statusvalue << child_offset_bits; \
3339 # ifdef VMSISH_STATUS
3340 # define STATUS_CURRENT (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
3342 # define STATUS_CURRENT STATUS_UNIX
3345 /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3346 * the NATIVE status to an equivalent value. Can not be used to translate
3347 * exit code values as exit code values are not guaranteed to have any
3348 * relationship at all to errno values.
3349 * This is used when Perl is forcing errno to have a specific value.
3351 # define STATUS_UNIX_SET(n) \
3353 I32 evalue = (I32)n; \
3354 PL_statusvalue = evalue; \
3355 if (PL_statusvalue != -1) { \
3356 if (PL_statusvalue != EVMSERR) { \
3357 PL_statusvalue &= 0xFFFF; \
3358 if (MY_POSIX_EXIT) \
3359 PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3360 else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3363 PL_statusvalue_vms = vaxc$errno; \
3366 else PL_statusvalue_vms = SS$_ABORT; \
3367 set_vaxc_errno(PL_statusvalue_vms); \
3370 /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
3371 * the NATIVE error status based on it.
3373 * When in the default mode to comply with the Perl VMS documentation,
3374 * 0 is a success and any other code sets the NATIVE status to a failure
3375 * code of SS$_ABORT.
3377 * In the new POSIX EXIT mode, native status will be set so that the
3378 * actual exit code will can be retrieved by the calling program or
3381 * If the exit code is not clearly a UNIX parent or child exit status,
3382 * it will be passed through as a VMS status.
3385 # define STATUS_UNIX_EXIT_SET(n) \
3387 I32 evalue = (I32)n; \
3388 PL_statusvalue = evalue; \
3389 if (MY_POSIX_EXIT) { \
3390 if (evalue <= 0xFF00) { \
3391 if (evalue > 0xFF) \
3392 evalue = (evalue >> child_offset_bits) & 0xFF; \
3393 PL_statusvalue_vms = \
3394 (C_FAC_POSIX | (evalue << 3 ) | \
3395 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3396 } else /* forgive them Perl, for they have sinned */ \
3397 PL_statusvalue_vms = evalue; \
3400 PL_statusvalue_vms = SS$_NORMAL; \
3401 else if (evalue <= 0xFF00) \
3402 PL_statusvalue_vms = SS$_ABORT; \
3403 else { /* forgive them Perl, for they have sinned */ \
3404 if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3405 else PL_statusvalue_vms = vaxc$errno; \
3406 /* And obviously used a VMS status value instead of UNIX */ \
3407 PL_statusvalue = EVMSERR; \
3409 set_vaxc_errno(PL_statusvalue_vms); \
3414 /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3415 * and sets the NATIVE error status based on it. This special case
3416 * is needed to maintain compatibility with past VMS behavior.
3418 * In the default mode on VMS, this number is passed through as
3419 * both the NATIVE and UNIX status. Which makes it different
3420 * that the STATUS_UNIX_EXIT_SET.
3422 * In the new POSIX EXIT mode, native status will be set so that the
3423 * actual exit code will can be retrieved by the calling program or
3426 * A POSIX exit code is from 0 to 255. If the exit code is higher
3427 * than this, it needs to be assumed that it is a VMS exit code and
3431 # define STATUS_EXIT_SET(n) \
3433 I32 evalue = (I32)n; \
3434 PL_statusvalue = evalue; \
3435 if (MY_POSIX_EXIT) \
3436 if (evalue > 255) PL_statusvalue_vms = evalue; else { \
3437 PL_statusvalue_vms = \
3438 (C_FAC_POSIX | (evalue << 3 ) | \
3439 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
3441 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3442 set_vaxc_errno(PL_statusvalue_vms); \
3446 /* This macro forces a success status */
3447 # define STATUS_ALL_SUCCESS \
3448 (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
3450 /* This macro forces a failure status */
3451 # define STATUS_ALL_FAILURE (PL_statusvalue = 1, \
3452 vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3453 (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3455 #elif defined(__amigaos4__)
3456 /* A somewhat experimental attempt to simulate posix return code values */
3457 # define STATUS_NATIVE PL_statusvalue_posix
3458 # define STATUS_NATIVE_CHILD_SET(n) \
3460 PL_statusvalue_posix = (n); \
3461 if (PL_statusvalue_posix < 0) { \
3462 PL_statusvalue = -1; \
3465 PL_statusvalue = n << 8; \
3468 # define STATUS_UNIX_SET(n) \
3470 PL_statusvalue = (n); \
3471 if (PL_statusvalue != -1) \
3472 PL_statusvalue &= 0xFFFF; \
3474 # define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3475 # define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3476 # define STATUS_CURRENT STATUS_UNIX
3477 # define STATUS_EXIT STATUS_UNIX
3478 # define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3479 # define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3482 # define STATUS_NATIVE PL_statusvalue_posix
3483 # if defined(WCOREDUMP)
3484 # define STATUS_NATIVE_CHILD_SET(n) \
3486 PL_statusvalue_posix = (n); \
3487 if (PL_statusvalue_posix == -1) \
3488 PL_statusvalue = -1; \
3491 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
3492 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3493 (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0); \
3496 # elif defined(WIFEXITED)
3497 # define STATUS_NATIVE_CHILD_SET(n) \
3499 PL_statusvalue_posix = (n); \
3500 if (PL_statusvalue_posix == -1) \
3501 PL_statusvalue = -1; \
3504 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
3505 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0); \
3509 # define STATUS_NATIVE_CHILD_SET(n) \
3511 PL_statusvalue_posix = (n); \
3512 if (PL_statusvalue_posix == -1) \
3513 PL_statusvalue = -1; \
3516 PL_statusvalue_posix & 0xFFFF; \
3520 # define STATUS_UNIX_SET(n) \
3522 PL_statusvalue = (n); \
3523 if (PL_statusvalue != -1) \
3524 PL_statusvalue &= 0xFFFF; \
3526 # define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3527 # define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3528 # define STATUS_CURRENT STATUS_UNIX
3529 # define STATUS_EXIT STATUS_UNIX
3530 # define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3531 # define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3534 /* flags in PL_exit_flags for nature of exit() */
3535 #define PERL_EXIT_EXPECTED 0x01
3536 #define PERL_EXIT_DESTRUCT_END 0x02 /* Run END in perl_destruct */
3537 #define PERL_EXIT_WARN 0x04 /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3538 #define PERL_EXIT_ABORT 0x08 /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3541 /* format to use for version numbers in file/directory names */
3542 /* XXX move to Configure? */
3543 /* This was only ever used for the current version, and that can be done at
3544 compile time, as PERL_FS_VERSION, so should we just delete it? */
3545 # ifndef PERL_FS_VER_FMT
3546 # define PERL_FS_VER_FMT "%d.%d.%d"
3550 #ifndef PERL_FS_VERSION
3551 # define PERL_FS_VERSION PERL_VERSION_STRING
3554 /* This defines a way to flush all output buffers. This may be a
3555 * performance issue, so we allow people to disable it. Also, if
3556 * we are using stdio, there are broken implementations of fflush(NULL)
3557 * out there, Solaris being the most prominent.
3559 #ifndef PERL_FLUSHALL_FOR_CHILD
3560 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3561 # define PERL_FLUSHALL_FOR_CHILD PerlIO_flush((PerlIO*)NULL)
3562 # elif defined(FFLUSH_ALL)
3563 # define PERL_FLUSHALL_FOR_CHILD my_fflush_all()
3565 # define PERL_FLUSHALL_FOR_CHILD NOOP
3569 #ifndef PERL_WAIT_FOR_CHILDREN
3570 # define PERL_WAIT_FOR_CHILDREN NOOP
3573 /* the traditional thread-unsafe notion of "current interpreter". */
3574 #ifndef PERL_SET_INTERP
3575 # define PERL_SET_INTERP(i) (PL_curinterp = (PerlInterpreter*)(i))
3578 #ifndef PERL_GET_INTERP
3579 # define PERL_GET_INTERP (PL_curinterp)
3582 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3583 # ifdef MULTIPLICITY
3584 # define PERL_GET_THX ((PerlInterpreter *)PERL_GET_CONTEXT)
3586 # define PERL_SET_THX(t) PERL_SET_CONTEXT(t)
3590 This replaces the previous %_ "hack" by the "%p" hacks.
3591 All that is required is that the perl source does not
3592 use "%-p" or "%-<number>p" or "%<number>p" formats.
3593 These formats will still work in perl code.
3594 See comments in sv.c for further details.
3596 Robin Barker 2005-07-14
3598 No longer use %1p for VDf = %vd. RMB 2007-10-19
3602 # define SVf_(n) "-" STRINGIFY(n) "p"
3610 # define SVf32 SVf_(32)
3614 # define SVf256 SVf_(256)
3617 #define SVfARG(p) ((void*)(p))
3623 /* Not ideal, but we cannot easily include a number in an already-numeric
3624 * format sequence. */
3626 # define HEKf256 "3p"
3629 #define HEKfARG(p) ((void*)(p))
3631 /* Documented in perlguts
3633 * %4p is a custom format
3636 # define UTF8f "d%" UVuf "%4p"
3638 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3641 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
3644 /* not used; but needed for backward compatibility with XS code? - RMB */
3650 #if !defined(DEBUGGING) && !defined(NDEBUG)
3655 /* For functions that are marked as __attribute__noreturn__, it's not
3656 appropriate to call return. In either case, include the lint directive.
3658 #ifdef HASATTRIBUTE_NORETURN
3659 # define NORETURN_FUNCTION_END NOT_REACHED;
3661 # define NORETURN_FUNCTION_END NOT_REACHED; return 0
3664 #ifdef HAS_BUILTIN_EXPECT
3665 # define EXPECT(expr,val) __builtin_expect(expr,val)
3667 # define EXPECT(expr,val) (expr)
3671 =for apidoc_section Compiler directives
3673 =for apidoc Am||LIKELY|bool expr
3675 Returns the input unchanged, but at the same time it gives a branch prediction
3676 hint to the compiler that this condition is likely to be true.
3678 =for apidoc Am||UNLIKELY|bool expr
3680 Returns the input unchanged, but at the same time it gives a branch prediction
3681 hint to the compiler that this condition is likely to be false.
3685 #define LIKELY(cond) EXPECT(cBOOL(cond),TRUE)
3686 #define UNLIKELY(cond) EXPECT(cBOOL(cond),FALSE)
3688 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3692 /* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
3693 time invariants. That is, their argument must be a constant expression that
3694 can be verified by the compiler. This expression can contain anything that's
3695 known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3696 the expression evaluates to 0, compilation fails.
3697 Because they generate no runtime code (i.e. their use is "free"), they're
3698 always active, even under non-DEBUGGING builds.
3699 STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
3700 file scope (outside of any function).
3701 STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3704 #if (! defined(__IBMC__) || __IBMC__ >= 1210) \
3705 && (( defined(static_assert) && ( defined(_ISOC11_SOURCE) \
3706 || (__STDC_VERSION__ - 0) >= 201101L)) \
3707 || (defined(__cplusplus) && __cplusplus >= 201103L))
3708 /* XXX static_assert is a macro defined in <assert.h> in C11 or a compiler
3709 builtin in C++11. But IBM XL C V11 does not support _Static_assert, no
3710 matter what <assert.h> says.
3712 # define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
3714 /* We use a bit-field instead of an array because gcc accepts
3715 'typedef char x[n]' where n is not a compile-time constant.
3716 We want to enforce constantness.
3718 # define STATIC_ASSERT_2(COND, SUFFIX) \
3720 unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3721 } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3722 # define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
3723 # define STATIC_ASSERT_DECL(COND) STATIC_ASSERT_1(COND, __LINE__)
3725 /* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3726 error (static_assert is a declaration, and only statements can have labels).
3728 #define STATIC_ASSERT_STMT(COND) STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
3730 #ifndef __has_builtin
3731 # define __has_builtin(x) 0 /* not a clang style compiler */
3734 /* ASSUME is like assert(), but it has a benefit in a release build. It is a
3735 hint to a compiler about a statement of fact in a function call free
3736 expression, which allows the compiler to generate better machine code.
3737 In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3738 the control path is unreachable. In a for loop, ASSUME can be used to hint
3739 that a loop will run at least X times. ASSUME is based off MSVC's __assume
3740 intrinsic function, see its documents for more details.
3744 # if __has_builtin(__builtin_unreachable) \
3745 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4) /* 4.5 -> */
3746 # define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3747 # elif defined(_MSC_VER)
3748 # define ASSUME(x) __assume(x)
3749 # elif defined(__ARMCC_VERSION) /* untested */
3750 # define ASSUME(x) __promise(x)
3752 /* a random compiler might define assert to its own special optimization token
3753 so pass it through to C lib as a last resort */
3754 # define ASSUME(x) assert(x)
3757 # define ASSUME(x) assert(x)
3760 #if defined(__sun) /* ASSUME() generates warnings on Solaris */
3761 # define NOT_REACHED
3762 #elif defined(DEBUGGING) && (__has_builtin(__builtin_unreachable) \
3763 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4)) /* 4.5 -> */
3764 # define NOT_REACHED STMT_START { ASSUME(!"UNREACHABLE"); __builtin_unreachable(); } STMT_END
3766 # define NOT_REACHED ASSUME(!"UNREACHABLE")
3769 /* Some unistd.h's give a prototype for pause() even though
3770 HAS_PAUSE ends up undefined. This causes the #define
3771 below to be rejected by the compiler. Sigh.
3776 #define Pause() sleep((32767<<16)+32767)
3780 # ifdef IOCPARM_MASK
3781 /* on BSDish systems we're safe */
3782 # define IOCPARM_LEN(x) (((x) >> 16) & IOCPARM_MASK)
3783 # elif defined(_IOC_SIZE) && defined(__GLIBC__)
3784 /* on Linux systems we're safe; except when we're not [perl #38223] */
3785 # define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3787 /* otherwise guess at what's safe */
3788 # define IOCPARM_LEN(x) 256
3792 #if defined(__CYGWIN__)
3794 * This symbol, if defined, indicates that the program should
3795 * use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3796 * that a file is in "binary" mode -- that is, that no translation
3797 * of bytes occurs on read or write operations.
3799 # define USEMYBINMODE /**/
3800 # include <io.h> /* for setmode() prototype */
3801 # define my_binmode(fp, iotype, mode) \
3802 cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
3806 void init_os_extras(void);
3809 #ifdef UNION_ANY_DEFINITION
3810 UNION_ANY_DEFINITION;
3828 void (*any_dptr) (void*);
3829 void (*any_dxptr) (pTHX_ void*);
3833 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3835 #define FILTER_READ(idx, sv, len) filter_read(idx, sv, len)
3836 #define FILTER_DATA(idx) \
3837 (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3838 #define FILTER_ISREADER(idx) \
3839 (PL_parser && PL_parser->rsfp_filters \
3840 && idx >= AvFILLp(PL_parser->rsfp_filters))
3841 #define PERL_FILTER_EXISTS(i) \
3842 (PL_parser && PL_parser->rsfp_filters \
3843 && (i) < av_count(PL_parser->rsfp_filters))
3845 #if defined(_AIX) && !defined(_AIX43)
3846 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3847 /* We cannot include <crypt.h> to get the struct crypt_data
3848 * because of setkey prototype problems when threading */
3849 typedef struct crypt_data { /* straight from /usr/include/crypt.h */
3850 /* From OSF, Not needed in AIX
3858 #endif /* threading */
3861 #ifndef PERL_CALLCONV
3863 # define PERL_CALLCONV extern "C"
3865 # define PERL_CALLCONV
3868 #ifndef PERL_CALLCONV_NO_RET
3869 # define PERL_CALLCONV_NO_RET PERL_CALLCONV
3872 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
3873 dont have a noreturn as a declaration specifier
3875 #ifndef PERL_STATIC_NO_RET
3876 # define PERL_STATIC_NO_RET STATIC
3878 /* PERL_STATIC_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE on
3879 builds that dont have a noreturn as a declaration specifier
3881 #ifndef PERL_STATIC_INLINE_NO_RET
3882 # define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
3885 #ifndef PERL_STATIC_FORCE_INLINE
3886 # define PERL_STATIC_FORCE_INLINE PERL_STATIC_INLINE
3889 #ifndef PERL_STATIC_FORCE_INLINE_NO_RET
3890 # define PERL_STATIC_FORCE_INLINE_NO_RET PERL_STATIC_INLINE
3894 # include "iperlsys.h"
3897 #ifdef __LIBCATAMOUNT__
3898 #undef HAS_PASSWD /* unixish.h but not unixish enough. */
3900 #define FAKE_BIT_BUCKET
3903 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3904 * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
3905 * Configure, despite their names being similar to other defines like
3906 * USE_ITHREADS. Configure in fact knows nothing about the randomised
3907 * hashes. Therefore to enable/disable the hash randomisation defines
3908 * use the Configure -Accflags=... instead. */
3909 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
3910 # define USE_HASH_SEED
3916 /* macros to define bit-fields in structs. */
3917 #ifndef PERL_BITFIELD8
3918 # define PERL_BITFIELD8 U8
3920 #ifndef PERL_BITFIELD16
3921 # define PERL_BITFIELD16 U16
3923 #ifndef PERL_BITFIELD32
3924 # define PERL_BITFIELD32 U32
3934 #include "opnames.h"
3941 #include "warnings.h"
3944 /* these would be in doio.h if there was such a file */
3945 #define my_stat() my_stat_flags(SV_GMAGIC)
3946 #define my_lstat() my_lstat_flags(SV_GMAGIC)
3948 /* defined in sv.c, but also used in [ach]v.c */
3951 #undef _XPVCV_COMMON
3955 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
3957 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3959 /* These have to be predeclared, as they are used in proto.h which is #included
3960 * before their definitions in regcomp.h. */
3963 typedef struct regnode_charclass regnode_charclass;
3965 /* A hopefully less confusing name. The sub-classes are all Posix classes only
3966 * used under /l matching */
3967 typedef struct regnode_charclass_posixl regnode_charclass_class;
3968 typedef struct regnode_charclass_posixl regnode_charclass_posixl;
3970 typedef struct regnode_ssc regnode_ssc;
3971 typedef struct RExC_state_t RExC_state_t;
3972 struct _reg_trie_data;
3976 struct ptr_tbl_ent {
3977 struct ptr_tbl_ent* next;
3983 struct ptr_tbl_ent** tbl_ary;
3986 struct ptr_tbl_arena *tbl_arena;
3987 struct ptr_tbl_ent *tbl_arena_next;
3988 struct ptr_tbl_ent *tbl_arena_end;
3991 #if defined(htonl) && !defined(HAS_HTONL)
3994 #if defined(htons) && !defined(HAS_HTONS)
3997 #if defined(ntohl) && !defined(HAS_NTOHL)
4000 #if defined(ntohs) && !defined(HAS_NTOHS)
4008 # if (BYTEORDER & 0xffff) == 0x4321
4009 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
4010 re-order their values. However, to behave identically to the alternative
4011 implementations, they should truncate to the correct size. */
4012 # define ntohl(x) ((x)&0xFFFFFFFF)
4013 # define htonl(x) ntohl(x)
4014 # define ntohs(x) ((x)&0xFFFF)
4015 # define htons(x) ntohs(x)
4016 # elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
4018 /* Note that we can't straight out declare our own htonl and htons because
4019 the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
4020 to avoid the overhead of initialising the socket subsystem, but the headers
4021 that *declare* the various functions are still seen. If we declare our own
4022 htonl etc they will clash with the declarations in the Win32 headers. */
4024 PERL_STATIC_INLINE U32
4025 my_swap32(const U32 x) {
4026 return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)
4027 | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
4030 PERL_STATIC_INLINE U16
4031 my_swap16(const U16 x) {
4032 return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
4035 # define htonl(x) my_swap32(x)
4036 # define ntohl(x) my_swap32(x)
4037 # define ntohs(x) my_swap16(x)
4038 # define htons(x) my_swap16(x)
4040 # error "Unsupported byteorder"
4041 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
4042 the error message. Please check the value of the macro BYTEORDER, as defined
4043 in config.h. The values of BYTEORDER we expect are
4045 big endian little endian
4046 32 bit 0x4321 0x1234
4047 64 bit 0x87654321 0x12345678
4049 If you have a system with a different byte order, please see
4050 pod/perlhack.pod for how to submit a patch to add supporting code.
4056 * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
4059 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
4060 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
4061 re-order their values. However, to behave identically to the alternative
4062 implementations, they should truncate to the correct size. */
4063 # define vtohl(x) ((x)&0xFFFFFFFF)
4064 # define vtohs(x) ((x)&0xFFFF)
4065 # define htovl(x) vtohl(x)
4066 # define htovs(x) vtohs(x)
4067 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
4068 # define vtohl(x) ((((x)&0xFF)<<24) \
4070 +(((x)&0x0000FF00)<<8) \
4071 +(((x)&0x00FF0000)>>8) )
4072 # define vtohs(x) ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
4073 # define htovl(x) vtohl(x)
4074 # define htovs(x) vtohs(x)
4076 # error "Unsupported byteorder"
4077 /* If you have need for current perl on PDP-11 or similar, and can help test
4078 that blead keeps working on a mixed-endian system, then see
4079 pod/perlhack.pod for how to submit patches to things working again. */
4082 /* *MAX Plus 1. A floating point value.
4083 Hopefully expressed in a way that dodgy floating point can't mess up.
4084 >> 2 rather than 1, so that value is safely less than I32_MAX after 1
4086 May find that some broken compiler will want the value cast to I32.
4087 [after the shift, as signed >> may not be as secure as unsigned >>]
4089 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
4090 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
4091 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
4092 0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
4093 may be greater than sizeof(IV), so don't assume that half max UV is max IV.
4095 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
4097 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
4098 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
4099 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
4101 /* This may look like unnecessary jumping through hoops, but converting
4102 out of range floating point values to integers *is* undefined behaviour,
4103 and it is starting to bite.
4106 #define I_32(what) (cast_i32((NV)(what)))
4107 #define U_32(what) (cast_ulong((NV)(what)))
4108 #define I_V(what) (cast_iv((NV)(what)))
4109 #define U_V(what) (cast_uv((NV)(what)))
4111 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
4112 : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
4113 : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
4114 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
4115 : ((n) < U32_MAX_P1 ? (U32) (n) \
4116 : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
4117 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
4118 : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
4119 : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
4120 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
4121 : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
4122 : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
4125 #define U_S(what) ((U16)U_32(what))
4126 #define U_I(what) ((unsigned int)U_32(what))
4127 #define U_L(what) U_32(what)
4130 # ifndef Perl_signbit
4131 # define Perl_signbit signbit
4135 /* These do not care about the fractional part, only about the range. */
4136 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
4137 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
4139 /* Used with UV/IV arguments: */
4140 /* XXXX: need to speed it up */
4141 #define CLUMP_2UV(iv) ((iv) < 0 ? 0 : (UV)(iv))
4142 #define CLUMP_2IV(uv) ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
4150 Uid_t getuid (void);
4151 Uid_t geteuid (void);
4152 Gid_t getgid (void);
4153 Gid_t getegid (void);
4157 #ifndef Perl_debug_log
4158 # define Perl_debug_log PerlIO_stderr()
4161 #ifndef Perl_error_log
4162 # define Perl_error_log (PL_stderrgv \
4163 && isGV(PL_stderrgv) \
4164 && GvIOp(PL_stderrgv) \
4165 && IoOFP(GvIOp(PL_stderrgv)) \
4166 ? IoOFP(GvIOp(PL_stderrgv)) \
4171 #define DEBUG_p_FLAG 0x00000001 /* 1 */
4172 #define DEBUG_s_FLAG 0x00000002 /* 2 */
4173 #define DEBUG_l_FLAG 0x00000004 /* 4 */
4174 #define DEBUG_t_FLAG 0x00000008 /* 8 */
4175 #define DEBUG_o_FLAG 0x00000010 /* 16 */
4176 #define DEBUG_c_FLAG 0x00000020 /* 32 */
4177 #define DEBUG_P_FLAG 0x00000040 /* 64 */
4178 #define DEBUG_m_FLAG 0x00000080 /* 128 */
4179 #define DEBUG_f_FLAG 0x00000100 /* 256 */
4180 #define DEBUG_r_FLAG 0x00000200 /* 512 */
4181 #define DEBUG_x_FLAG 0x00000400 /* 1024 */
4182 #define DEBUG_u_FLAG 0x00000800 /* 2048 */
4183 /* U is reserved for Unofficial, exploratory hacking */
4184 #define DEBUG_U_FLAG 0x00001000 /* 4096 */
4186 #define DEBUG_X_FLAG 0x00004000 /* 16384 */
4187 #define DEBUG_D_FLAG 0x00008000 /* 32768 */
4188 #define DEBUG_S_FLAG 0x00010000 /* 65536 */
4189 #define DEBUG_T_FLAG 0x00020000 /* 131072 */
4190 #define DEBUG_R_FLAG 0x00040000 /* 262144 */
4191 #define DEBUG_J_FLAG 0x00080000 /* 524288 */
4192 #define DEBUG_v_FLAG 0x00100000 /*1048576 */
4193 #define DEBUG_C_FLAG 0x00200000 /*2097152 */
4194 #define DEBUG_A_FLAG 0x00400000 /*4194304 */
4195 #define DEBUG_q_FLAG 0x00800000 /*8388608 */
4196 #define DEBUG_M_FLAG 0x01000000 /*16777216*/
4197 #define DEBUG_B_FLAG 0x02000000 /*33554432*/
4198 #define DEBUG_L_FLAG 0x04000000 /*67108864*/
4199 #define DEBUG_i_FLAG 0x08000000 /*134217728*/
4200 #define DEBUG_y_FLAG 0x10000000 /*268435456*/
4201 #define DEBUG_MASK 0x1FFFEFFF /* mask of all the standard flags */
4203 #define DEBUG_DB_RECURSE_FLAG 0x40000000
4204 #define DEBUG_TOP_FLAG 0x80000000 /* -D was given --> PL_debug |= FLAG */
4206 # define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
4207 # define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
4208 # define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
4209 # define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
4210 # define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
4211 # define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
4212 # define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
4213 # define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
4214 # define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
4215 # define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
4216 # define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
4217 # define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
4218 # define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
4219 # define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
4220 # define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
4221 # define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
4222 # define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
4223 # define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
4224 # define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
4225 # define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
4226 # define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
4227 # define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
4228 # define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
4229 # define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
4230 # define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
4231 # define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
4232 # define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
4233 # define DEBUG_y_TEST_ UNLIKELY(PL_debug & DEBUG_y_FLAG)
4234 # define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
4235 # define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
4236 # define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
4237 # define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
4238 # define DEBUG_yv_TEST_ (DEBUG_y_TEST_ && DEBUG_v_TEST_)
4242 # define DEBUG_p_TEST DEBUG_p_TEST_
4243 # define DEBUG_s_TEST DEBUG_s_TEST_
4244 # define DEBUG_l_TEST DEBUG_l_TEST_
4245 # define DEBUG_t_TEST DEBUG_t_TEST_
4246 # define DEBUG_o_TEST DEBUG_o_TEST_
4247 # define DEBUG_c_TEST DEBUG_c_TEST_
4248 # define DEBUG_P_TEST DEBUG_P_TEST_
4249 # define DEBUG_m_TEST DEBUG_m_TEST_
4250 # define DEBUG_f_TEST DEBUG_f_TEST_
4251 # define DEBUG_r_TEST DEBUG_r_TEST_
4252 # define DEBUG_x_TEST DEBUG_x_TEST_
4253 # define DEBUG_u_TEST DEBUG_u_TEST_
4254 # define DEBUG_U_TEST DEBUG_U_TEST_
4255 # define DEBUG_X_TEST DEBUG_X_TEST_
4256 # define DEBUG_D_TEST DEBUG_D_TEST_
4257 # define DEBUG_S_TEST DEBUG_S_TEST_
4258 # define DEBUG_T_TEST DEBUG_T_TEST_
4259 # define DEBUG_R_TEST DEBUG_R_TEST_
4260 # define DEBUG_J_TEST DEBUG_J_TEST_
4261 # define DEBUG_v_TEST DEBUG_v_TEST_
4262 # define DEBUG_C_TEST DEBUG_C_TEST_
4263 # define DEBUG_A_TEST DEBUG_A_TEST_
4264 # define DEBUG_q_TEST DEBUG_q_TEST_
4265 # define DEBUG_M_TEST DEBUG_M_TEST_
4266 # define DEBUG_B_TEST DEBUG_B_TEST_
4267 # define DEBUG_L_TEST DEBUG_L_TEST_
4268 # define DEBUG_i_TEST DEBUG_i_TEST_
4269 # define DEBUG_y_TEST DEBUG_y_TEST_
4270 # define DEBUG_Xv_TEST DEBUG_Xv_TEST_
4271 # define DEBUG_Uv_TEST DEBUG_Uv_TEST_
4272 # define DEBUG_Pv_TEST DEBUG_Pv_TEST_
4273 # define DEBUG_Lv_TEST DEBUG_Lv_TEST_
4274 # define DEBUG_yv_TEST DEBUG_yv_TEST_
4276 # define PERL_DEB(a) a
4277 # define PERL_DEB2(a,b) a
4278 # define PERL_DEBUG(a) if (PL_debug) a
4279 # define DEBUG_p(a) if (DEBUG_p_TEST) a
4280 # define DEBUG_s(a) if (DEBUG_s_TEST) a
4281 # define DEBUG_l(a) if (DEBUG_l_TEST) a
4282 # define DEBUG_t(a) if (DEBUG_t_TEST) a
4283 # define DEBUG_o(a) if (DEBUG_o_TEST) a
4284 # define DEBUG_c(a) if (DEBUG_c_TEST) a
4285 # define DEBUG_P(a) if (DEBUG_P_TEST) a
4287 /* Temporarily turn off memory debugging in case the a
4288 * does memory allocation, either directly or indirectly. */
4289 # define DEBUG_m(a) \
4291 if (PERL_GET_INTERP) { \
4293 if (DEBUG_m_TEST) { \
4294 PL_debug &= ~DEBUG_m_FLAG; \
4296 PL_debug |= DEBUG_m_FLAG; \
4301 # define DEBUG__(t, a) \
4303 if (t) STMT_START {a;} STMT_END; \
4306 # define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
4308 /* For re_comp.c, re_exec.c, assume -Dr has been specified */
4309 # ifdef PERL_EXT_RE_BUILD
4310 # define DEBUG_r(a) STMT_START {a;} STMT_END
4312 # define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
4313 # endif /* PERL_EXT_RE_BUILD */
4315 # define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
4316 # define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
4317 # define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
4318 # define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
4319 # define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
4320 # define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
4321 # define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
4322 # define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
4323 # define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
4324 # define DEBUG_yv(a) DEBUG__(DEBUG_yv_TEST, a)
4326 # define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
4327 # define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
4328 # define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
4329 # define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
4330 # define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
4331 # define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
4332 # define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
4333 # define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
4334 # define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
4335 # define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
4336 # define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
4337 # define DEBUG_y(a) DEBUG__(DEBUG_y_TEST, a)
4339 #else /* ! DEBUGGING below */
4341 # define DEBUG_p_TEST (0)
4342 # define DEBUG_s_TEST (0)
4343 # define DEBUG_l_TEST (0)
4344 # define DEBUG_t_TEST (0)
4345 # define DEBUG_o_TEST (0)
4346 # define DEBUG_c_TEST (0)
4347 # define DEBUG_P_TEST (0)
4348 # define DEBUG_m_TEST (0)
4349 # define DEBUG_f_TEST (0)
4350 # define DEBUG_r_TEST (0)
4351 # define DEBUG_x_TEST (0)
4352 # define DEBUG_u_TEST (0)
4353 # define DEBUG_U_TEST (0)
4354 # define DEBUG_X_TEST (0)
4355 # define DEBUG_D_TEST (0)
4356 # define DEBUG_S_TEST (0)
4357 # define DEBUG_T_TEST (0)
4358 # define DEBUG_R_TEST (0)
4359 # define DEBUG_J_TEST (0)
4360 # define DEBUG_v_TEST (0)
4361 # define DEBUG_C_TEST (0)
4362 # define DEBUG_A_TEST (0)
4363 # define DEBUG_q_TEST (0)
4364 # define DEBUG_M_TEST (0)
4365 # define DEBUG_B_TEST (0)
4366 # define DEBUG_L_TEST (0)
4367 # define DEBUG_i_TEST (0)
4368 # define DEBUG_y_TEST (0)
4369 # define DEBUG_Xv_TEST (0)
4370 # define DEBUG_Uv_TEST (0)
4371 # define DEBUG_Pv_TEST (0)
4372 # define DEBUG_Lv_TEST (0)
4373 # define DEBUG_yv_TEST (0)
4375 # define PERL_DEB(a)
4376 # define PERL_DEB2(a,b) b
4377 # define PERL_DEBUG(a)
4405 # define DEBUG_Xv(a)
4406 # define DEBUG_Uv(a)
4407 # define DEBUG_Pv(a)
4408 # define DEBUG_Lv(a)
4409 # define DEBUG_yv(a)
4410 #endif /* DEBUGGING */
4413 #define DEBUG_SCOPE(where) \
4415 Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n", \
4416 where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
4417 __FILE__, __LINE__));
4419 /* Keep the old croak based assert for those who want it, and as a fallback if
4420 the platform is so heretically non-ANSI that it can't assert. */
4422 #define Perl_assert(what) PERL_DEB2( \
4423 ((what) ? ((void) 0) : \
4424 (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
4425 "\", line %d", STRINGIFY(what), __LINE__), \
4426 (void) 0)), ((void)0))
4428 /* assert() gets defined if DEBUGGING.
4429 * If no DEBUGGING, the <assert.h> has not been included. */
4431 # define assert(what) Perl_assert(what)
4434 # define assert_(what) assert(what),
4436 # define assert_(what)
4440 I32 (*uf_val)(pTHX_ IV, SV*);
4441 I32 (*uf_set)(pTHX_ IV, SV*);
4445 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4446 * XS code wanting to be backward compatible can do something
4447 * like the following:
4449 #ifndef PERL_MG_UFUNC
4450 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4453 static PERL_MG_UFUNC(foo_get, index, val)
4463 #ifndef PERL_MG_UFUNC
4464 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4469 /* isfinite and others are here rather than in math.h as C99 stipulates */
4474 # if !defined(WIN32) && !defined(VMS)
4476 char *crypt (const char*, const char*);
4478 # endif /* !WIN32 */
4481 char *getlogin (void);
4483 # endif /* !WIN32 */
4484 #endif /* !__cplusplus */
4486 /* Fixme on VMS. This needs to be a run-time, not build time options */
4487 /* Also rename() is affected by this */
4488 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4489 #define UNLINK unlnk
4490 I32 unlnk (pTHX_ const char*);
4492 #define UNLINK PerlLIO_unlink
4495 /* some versions of glibc are missing the setresuid() proto */
4496 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4497 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4499 /* some versions of glibc are missing the setresgid() proto */
4500 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4501 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4504 #ifndef HAS_SETREUID
4505 # ifdef HAS_SETRESUID
4506 # define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4507 # define HAS_SETREUID
4510 #ifndef HAS_SETREGID
4511 # ifdef HAS_SETRESGID
4512 # define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4513 # define HAS_SETREGID
4517 /* Sighandler_t defined in iperlsys.h */
4519 #ifdef HAS_SIGACTION
4520 typedef struct sigaction Sigsave_t;
4522 typedef Sighandler_t Sigsave_t;
4533 # define RUNOPS_DEFAULT Perl_runops_debug
4535 # define RUNOPS_DEFAULT Perl_runops_standard
4538 #if defined(USE_PERLIO)
4539 EXTERN_C void PerlIO_teardown(void);
4540 # ifdef USE_ITHREADS
4541 # define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4542 # define PERLIO_TERM \
4544 PerlIO_teardown(); \
4545 MUTEX_DESTROY(&PL_perlio_mutex);\
4548 # define PERLIO_INIT
4549 # define PERLIO_TERM PerlIO_teardown()
4552 # define PERLIO_INIT
4553 # define PERLIO_TERM
4557 # ifdef MUTEX_INIT_CALLS_MALLOC
4558 # define MALLOC_INIT \
4560 PL_malloc_mutex = NULL; \
4561 MUTEX_INIT(&PL_malloc_mutex); \
4563 # define MALLOC_TERM \
4565 perl_mutex tmp = PL_malloc_mutex; \
4566 PL_malloc_mutex = NULL; \
4567 MUTEX_DESTROY(&tmp); \
4570 # define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4571 # define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4574 # define MALLOC_INIT
4575 # define MALLOC_TERM
4578 #if defined(PERL_IMPLICIT_CONTEXT)
4580 struct perl_memory_debug_header;
4581 struct perl_memory_debug_header {
4583 # if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4586 struct perl_memory_debug_header *prev;
4587 struct perl_memory_debug_header *next;
4588 # ifdef PERL_DEBUG_READONLY_COW
4593 #elif defined(PERL_DEBUG_READONLY_COW)
4595 struct perl_memory_debug_header;
4596 struct perl_memory_debug_header {
4602 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4604 # define PERL_MEMORY_DEBUG_HEADER_SIZE \
4605 (sizeof(struct perl_memory_debug_header) + \
4606 (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4607 %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4610 # define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4613 #ifdef PERL_TRACK_MEMPOOL
4614 # ifdef PERL_DEBUG_READONLY_COW
4615 # define INIT_TRACK_MEMPOOL(header, interp) \
4617 (header).interpreter = (interp); \
4618 (header).prev = (header).next = &(header); \
4619 (header).readonly = 0; \
4622 # define INIT_TRACK_MEMPOOL(header, interp) \
4624 (header).interpreter = (interp); \
4625 (header).prev = (header).next = &(header); \
4629 # define INIT_TRACK_MEMPOOL(header, interp)
4632 #ifdef I_MALLOCMALLOC
4633 /* Needed for malloc_size(), malloc_good_size() on some systems */
4634 # include <malloc/malloc.h>
4638 # define Perl_safesysmalloc_size(where) Perl_malloced_size(where)
4640 # if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4641 # ifdef PERL_TRACK_MEMPOOL
4642 # define Perl_safesysmalloc_size(where) \
4643 (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4645 # define Perl_safesysmalloc_size(where) malloc_size(where)
4648 # ifdef HAS_MALLOC_GOOD_SIZE
4649 # ifdef PERL_TRACK_MEMPOOL
4650 # define Perl_malloc_good_size(how_much) \
4651 (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4653 # define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4656 /* Having this as the identity operation makes some code simpler. */
4657 # define Perl_malloc_good_size(how_much) (how_much)
4661 typedef int (*runops_proc_t)(pTHX);
4662 typedef void (*share_proc_t) (pTHX_ SV *sv);
4663 typedef int (*thrhook_proc_t) (pTHX);
4664 typedef OP* (*PPADDR_t[]) (pTHX);
4665 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4666 typedef void (*despatch_signals_proc_t) (pTHX);
4668 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4669 # include <crt_externs.h> /* for the env array */
4670 # define environ (*_NSGetEnviron())
4671 #elif defined(USE_ENVIRON_ARRAY) && !defined(environ)
4672 /* VMS and some other platforms don't use the environ array */
4673 EXTERN_C char **environ; /* environment variables supplied via exec */
4676 #define PERL_PATCHLEVEL_H_IMPLICIT
4677 #include "patchlevel.h"
4678 #undef PERL_PATCHLEVEL_H_IMPLICIT
4680 #define PERL_VERSION_STRING STRINGIFY(PERL_REVISION) "." \
4681 STRINGIFY(PERL_VERSION) "." \
4682 STRINGIFY(PERL_SUBVERSION)
4684 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4685 STRINGIFY(PERL_API_VERSION) "." \
4686 STRINGIFY(PERL_API_SUBVERSION)
4690 /* handy constants */
4691 EXTCONST char PL_warn_uninit[]
4692 INIT("Use of uninitialized value%s%s%s");
4693 EXTCONST char PL_warn_uninit_sv[]
4694 INIT("Use of uninitialized value%" SVf "%s%s");
4695 EXTCONST char PL_warn_nosemi[]
4696 INIT("Semicolon seems to be missing");
4697 EXTCONST char PL_warn_reserved[]
4698 INIT("Unquoted string \"%s\" may clash with future reserved word");
4699 EXTCONST char PL_warn_nl[]
4700 INIT("Unsuccessful %s on filename containing newline");
4701 EXTCONST char PL_no_wrongref[]
4702 INIT("Can't use %s ref as %s ref");
4703 /* The core no longer needs this here. If you require the string constant,
4704 please inline a copy into your own code. */
4705 EXTCONST char PL_no_symref[] __attribute__deprecated__
4706 INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4707 EXTCONST char PL_no_symref_sv[]
4708 INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4710 EXTCONST char PL_no_usym[]
4711 INIT("Can't use an undefined value as %s reference");
4712 EXTCONST char PL_no_aelem[]
4713 INIT("Modification of non-creatable array value attempted, subscript %d");
4714 EXTCONST char PL_no_helem_sv[]
4715 INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4716 EXTCONST char PL_no_modify[]
4717 INIT("Modification of a read-only value attempted");
4718 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4719 INIT("Out of memory!\n");
4720 EXTCONST char PL_no_security[]
4721 INIT("Insecure dependency in %s%s");
4722 EXTCONST char PL_no_sock_func[]
4723 INIT("Unsupported socket function \"%s\" called");
4724 EXTCONST char PL_no_dir_func[]
4725 INIT("Unsupported directory function \"%s\" called");
4726 EXTCONST char PL_no_func[]
4727 INIT("The %s function is unimplemented");
4728 EXTCONST char PL_no_myglob[]
4729 INIT("\"%s\" %s %s can't be in a package");
4730 EXTCONST char PL_no_localize_ref[]
4731 INIT("Can't localize through a reference");
4732 EXTCONST char PL_memory_wrap[]
4733 INIT("panic: memory wrap");
4734 EXTCONST char PL_extended_cp_format[]
4735 INIT("Code point 0x%" UVXf " is not Unicode, requires a Perl extension,"
4736 " and so is not portable");
4737 EXTCONST char PL_Yes[]
4739 EXTCONST char PL_No[]
4741 EXTCONST char PL_Zero[]
4745 =for apidoc_section Numeric Functions
4746 =for apidoc AmTuU|const char *|PL_hexdigit|U8 value
4748 This array, indexed by an integer, converts that value into the character that
4749 represents it. For example, if the input is 8, the return will be a string
4750 whose first character is '8'. What is actually returned is a pointer into a
4751 string. All you are interested in is the first character of that string. To
4752 get uppercase letters (for the values 10..15), add 16 to the index. Hence,
4753 C<PL_hexdigit[11]> is C<'b'>, and C<PL_hexdigit[11+16]> is C<'B'>. Adding 16
4754 to an index whose representation is '0'..'9' yields the same as not adding 16.
4755 Indices outside the range 0..31 result in (bad) undedefined behavior.
4759 EXTCONST char PL_hexdigit[]
4760 INIT("0123456789abcdef0123456789ABCDEF");
4762 EXTCONST STRLEN PL_WARN_ALL
4764 EXTCONST STRLEN PL_WARN_NONE
4767 /* This is constant on most architectures, a global on OS/2 */
4769 EXTCONST char PL_sh_path[]
4770 INIT(SH_PATH); /* full path of shell */
4774 EXTCONST char PL_cshname[]
4776 # define PL_cshlen (sizeof(CSH "") - 1)
4779 /* These are baked at compile time into any shared perl library.
4780 In future releases this will allow us in main() to sanity test the
4781 library we're linking against. */
4783 EXTCONST U8 PL_revision
4784 INIT(PERL_REVISION);
4785 EXTCONST U8 PL_version
4787 EXTCONST U8 PL_subversion
4788 INIT(PERL_SUBVERSION);
4790 EXTCONST char PL_uuemap[65]
4791 INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4793 /* a special string address whose value is "isa", but which perl knows
4794 * to treat as if it were really "DOES" when printing the method name in
4795 * the "Can't call method '%s'" error message */
4796 EXTCONST char PL_isa_DOES[]
4800 EXTCONST char PL_uudmap[256] =
4802 # include "uuudmap.h"
4804 # include "uudmap.h"
4807 EXTCONST char PL_bitcount[256] =
4809 # include "ubitcount.h"
4811 # include "bitcount.h"
4814 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4815 EXTCONST int PL_sig_num[] = { SIG_NUM };
4817 EXTCONST char PL_uudmap[256];
4818 EXTCONST char PL_bitcount[256];
4819 EXTCONST char* const PL_sig_name[];
4820 EXTCONST int PL_sig_num[];
4823 /* fast conversion and case folding tables. The folding tables complement the
4824 * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4825 * folds such as outside the range or to multiple characters. */
4830 /* The EBCDIC fold table depends on the code page, and hence is found in
4831 * ebcdic_tables.h */
4833 EXTCONST unsigned char PL_fold[] = {
4834 0, 1, 2, 3, 4, 5, 6, 7,
4835 8, 9, 10, 11, 12, 13, 14, 15,
4836 16, 17, 18, 19, 20, 21, 22, 23,
4837 24, 25, 26, 27, 28, 29, 30, 31,
4838 32, 33, 34, 35, 36, 37, 38, 39,
4839 40, 41, 42, 43, 44, 45, 46, 47,
4840 48, 49, 50, 51, 52, 53, 54, 55,
4841 56, 57, 58, 59, 60, 61, 62, 63,
4842 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
4843 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
4844 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
4845 'x', 'y', 'z', 91, 92, 93, 94, 95,
4846 96, 'A', 'B', 'C', 'D', 'E', 'F', 'G',
4847 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
4848 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
4849 'X', 'Y', 'Z', 123, 124, 125, 126, 127,
4850 128, 129, 130, 131, 132, 133, 134, 135,
4851 136, 137, 138, 139, 140, 141, 142, 143,
4852 144, 145, 146, 147, 148, 149, 150, 151,
4853 152, 153, 154, 155, 156, 157, 158, 159,
4854 160, 161, 162, 163, 164, 165, 166, 167,
4855 168, 169, 170, 171, 172, 173, 174, 175,
4856 176, 177, 178, 179, 180, 181, 182, 183,
4857 184, 185, 186, 187, 188, 189, 190, 191,
4858 192, 193, 194, 195, 196, 197, 198, 199,
4859 200, 201, 202, 203, 204, 205, 206, 207,
4860 208, 209, 210, 211, 212, 213, 214, 215,
4861 216, 217, 218, 219, 220, 221, 222, 223,
4862 224, 225, 226, 227, 228, 229, 230, 231,
4863 232, 233, 234, 235, 236, 237, 238, 239,
4864 240, 241, 242, 243, 244, 245, 246, 247,
4865 248, 249, 250, 251, 252, 253, 254, 255
4868 EXT unsigned char PL_fold_locale[] = { /* Unfortunately not EXTCONST. */
4869 0, 1, 2, 3, 4, 5, 6, 7,
4870 8, 9, 10, 11, 12, 13, 14, 15,
4871 16, 17, 18, 19, 20, 21, 22, 23,
4872 24, 25, 26, 27, 28, 29, 30, 31,
4873 32, 33, 34, 35, 36, 37, 38, 39,
4874 40, 41, 42, 43, 44, 45, 46, 47,
4875 48, 49, 50, 51, 52, 53, 54, 55,
4876 56, 57, 58, 59, 60, 61, 62, 63,
4877 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
4878 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
4879 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
4880 'x', 'y', 'z', 91, 92, 93, 94, 95,
4881 96, 'A', 'B', 'C', 'D', 'E', 'F', 'G',
4882 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
4883 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
4884 'X', 'Y', 'Z', 123, 124, 125, 126, 127,
4885 128, 129, 130, 131, 132, 133, 134, 135,
4886 136, 137, 138, 139, 140, 141, 142, 143,
4887 144, 145, 146, 147, 148, 149, 150, 151,
4888 152, 153, 154, 155, 156, 157, 158, 159,
4889 160, 161, 162, 163, 164, 165, 166, 167,
4890 168, 169, 170, 171, 172, 173, 174, 175,
4891 176, 177, 178, 179, 180, 181, 182, 183,
4892 184, 185, 186, 187, 188, 189, 190, 191,
4893 192, 193, 194, 195, 196, 197, 198, 199,
4894 200, 201, 202, 203, 204, 205, 206, 207,
4895 208, 209, 210, 211, 212, 213, 214, 215,
4896 216, 217, 218, 219, 220, 221, 222, 223,
4897 224, 225, 226, 227, 228, 229, 230, 231,
4898 232, 233, 234, 235, 236, 237, 238, 239,
4899 240, 241, 242, 243, 244, 245, 246, 247,
4900 248, 249, 250, 251, 252, 253, 254, 255
4903 EXTCONST unsigned char PL_fold_latin1[] = {
4904 /* Full latin1 complement folding, except for three problematic code points:
4905 * Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4906 * fold complements outside the Latin1 range, so can't match something
4907 * that isn't in utf8.
4908 * German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4909 * not one, so can't be represented in this table.
4911 * All have to be specially handled */
4912 0, 1, 2, 3, 4, 5, 6, 7,
4913 8, 9, 10, 11, 12, 13, 14, 15,
4914 16, 17, 18, 19, 20, 21, 22, 23,
4915 24, 25, 26, 27, 28, 29, 30, 31,
4916 32, 33, 34, 35, 36, 37, 38, 39,
4917 40, 41, 42, 43, 44, 45, 46, 47,
4918 48, 49, 50, 51, 52, 53, 54, 55,
4919 56, 57, 58, 59, 60, 61, 62, 63,
4920 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
4921 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
4922 'p', 'q', 'r', 's', &nbs
https://perl5.git.perl.org / perl5.git / blob