3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
16 * This file is being used for x2p stuff.
17 * Above symbol is defined via -D in 'x2p/Makefile.SH'
18 * Decouple x2p stuff from some of perls more extreme eccentricities.
23 #endif /* PERL_FOR_X2P */
31 /* this is used for functions which take a depth trailing
32 * argument under debugging */
34 #define _pDEPTH ,U32 depth
35 #define _aDEPTH ,depth
41 /* NOTE 1: that with gcc -std=c89 the __STDC_VERSION__ is *not* defined
42 * because the __STDC_VERSION__ became a thing only with C90. Therefore,
43 * with gcc, HAS_C99 will never become true as long as we use -std=c89.
45 * NOTE 2: headers lie. Do not expect that if HAS_C99 gets to be true,
46 * all the C99 features are there and are correct. */
47 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || \
48 defined(_STDC_C99) || defined(__c99)
52 /* See L<perlguts/"The Perl API"> for detailed notes on
53 * PERL_IMPLICIT_CONTEXT and PERL_IMPLICIT_SYS */
55 /* XXX NOTE that from here --> to <-- the same logic is
56 * repeated in makedef.pl, so be certain to update
57 * both places when editing. */
60 # if !defined(MULTIPLICITY)
66 # ifndef PERL_IMPLICIT_CONTEXT
67 # define PERL_IMPLICIT_CONTEXT
71 /* undef WIN32 when building on Cygwin (for libwin32) - gph */
77 /* Use the reentrant APIs like localtime_r and getpwent_r */
78 /* Win32 has naturally threadsafe libraries, no need to use any _r variants.
79 * XXX KEEP makedef.pl copy of this code in sync */
80 #if defined(USE_ITHREADS) && !defined(USE_REENTRANT_API) && !defined(NETWARE) && !defined(WIN32)
81 # define USE_REENTRANT_API
84 /* <--- here ends the logic shared by perl.h and makedef.pl */
87 =for apidoc_section $directives
88 =for apidoc AmnUu|void|EXTERN_C
89 When not compiling using C++, expands to nothing.
90 Otherwise is used in a declaration of a function to indicate the function
91 should have external C linkage. This is required for things to work for just
92 about all functions with external linkage compiled into perl.
93 Often, you can use C<L</START_EXTERN_C>> ... C<L</END_EXTERN_C>> blocks
94 surrounding all your code that you need to have this linkage.
98 EXTERN_C int flock(int fd, int op);
100 =for apidoc Amnu||START_EXTERN_C
101 When not compiling using C++, expands to nothing.
102 Otherwise begins a section of code in which every function will effectively
103 have C<L</EXTERN_C>> applied to it, that is to have external C linkage. The
104 section is ended by a C<L</END_EXTERN_C>>.
106 =for apidoc Amnu||END_EXTERN_C
107 When not compiling using C++, expands to nothing.
108 Otherwise ends a section of code already begun by a C<L</START_EXTERN_C>>.
113 #undef START_EXTERN_C
117 # define EXTERN_C extern "C"
118 # define START_EXTERN_C EXTERN_C {
119 # define END_EXTERN_C }
121 # define START_EXTERN_C
122 # define END_EXTERN_C
123 # define EXTERN_C extern
126 /* Fallback definitions in case we don't have definitions from config.h.
127 This should only matter for systems that don't use Configure and
128 haven't been modified to define PERL_STATIC_INLINE yet.
130 #if !defined(PERL_STATIC_INLINE)
131 # ifdef HAS_STATIC_INLINE
132 # define PERL_STATIC_INLINE static inline
134 # define PERL_STATIC_INLINE static
139 =for apidoc_section $concurrency
140 =for apidoc AmU|void|dTHXa|PerlInterpreter * a
141 On threaded perls, set C<pTHX> to C<a>; on unthreaded perls, do nothing
143 =for apidoc AmU|void|dTHXoa|PerlInterpreter * a
144 Now a synonym for C<L</dTHXa>>.
149 #ifdef PERL_IMPLICIT_CONTEXT
150 # ifndef MULTIPLICITY
151 # define MULTIPLICITY
153 # define tTHX PerlInterpreter*
154 # define pTHX tTHX my_perl PERL_UNUSED_DECL
155 # define aTHX my_perl
156 # define aTHXa(a) aTHX = (tTHX)a
157 # define dTHXa(a) pTHX = (tTHX)a
158 # define dTHX pTHX = PERL_GET_THX
171 # if defined(DEBUGGING) && !defined(PERL_TRACK_MEMPOOL)
172 # define PERL_TRACK_MEMPOOL
175 # undef PERL_TRACK_MEMPOOL
179 # define dTHX_DEBUGGING dTHX
181 # define dTHX_DEBUGGING dNOOP
184 #define STATIC static
187 /* Do not use these macros. They were part of PERL_OBJECT, which was an
188 * implementation of multiplicity using C++ objects. They have been left
189 * here solely for the sake of XS code which has incorrectly
192 * The only one Devel::PPPort handles is this; list it as deprecated
194 =for apidoc_section $concurrency
195 =for apidoc AmD|void|CPERLscope|void x
200 #define CPERLscope(x) x
201 #define CPERLarg void
204 #define PERL_OBJECT_THIS
205 #define _PERL_OBJECT_THIS
206 #define PERL_OBJECT_THIS_
207 #define CALL_FPTR(fptr) (*fptr)
208 #define MEMBER_TO_FPTR(name) name
209 #endif /* !PERL_CORE */
211 #define CALLRUNOPS PL_runops
213 #define CALLREGCOMP(sv, flags) Perl_pregcomp(aTHX_ (sv),(flags))
215 #define CALLREGCOMP_ENG(prog, sv, flags) (prog)->comp(aTHX_ sv, flags)
216 #define CALLREGEXEC(prog,stringarg,strend,strbeg,minend,sv,data,flags) \
217 RX_ENGINE(prog)->exec(aTHX_ (prog),(stringarg),(strend), \
218 (strbeg),(minend),(sv),(data),(flags))
219 #define CALLREG_INTUIT_START(prog,sv,strbeg,strpos,strend,flags,data) \
220 RX_ENGINE(prog)->intuit(aTHX_ (prog), (sv), (strbeg), (strpos), \
221 (strend),(flags),(data))
222 #define CALLREG_INTUIT_STRING(prog) \
223 RX_ENGINE(prog)->checkstr(aTHX_ (prog))
225 #define CALLREGFREE(prog) \
226 Perl_pregfree(aTHX_ (prog))
228 #define CALLREGFREE_PVT(prog) \
229 if(prog && RX_ENGINE(prog)) RX_ENGINE(prog)->rxfree(aTHX_ (prog))
231 #define CALLREG_NUMBUF_FETCH(rx,paren,usesv) \
232 RX_ENGINE(rx)->numbered_buff_FETCH(aTHX_ (rx),(paren),(usesv))
234 #define CALLREG_NUMBUF_STORE(rx,paren,value) \
235 RX_ENGINE(rx)->numbered_buff_STORE(aTHX_ (rx),(paren),(value))
237 #define CALLREG_NUMBUF_LENGTH(rx,sv,paren) \
238 RX_ENGINE(rx)->numbered_buff_LENGTH(aTHX_ (rx),(sv),(paren))
240 #define CALLREG_NAMED_BUFF_FETCH(rx, key, flags) \
241 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_FETCH))
243 #define CALLREG_NAMED_BUFF_STORE(rx, key, value, flags) \
244 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), (value), ((flags) | RXapif_STORE))
246 #define CALLREG_NAMED_BUFF_DELETE(rx, key, flags) \
247 RX_ENGINE(rx)->named_buff(aTHX_ (rx),(key), NULL, ((flags) | RXapif_DELETE))
249 #define CALLREG_NAMED_BUFF_CLEAR(rx, flags) \
250 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_CLEAR))
252 #define CALLREG_NAMED_BUFF_EXISTS(rx, key, flags) \
253 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_EXISTS))
255 #define CALLREG_NAMED_BUFF_FIRSTKEY(rx, flags) \
256 RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), NULL, ((flags) | RXapif_FIRSTKEY))
258 #define CALLREG_NAMED_BUFF_NEXTKEY(rx, lastkey, flags) \
259 RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), (lastkey), ((flags) | RXapif_NEXTKEY))
261 #define CALLREG_NAMED_BUFF_SCALAR(rx, flags) \
262 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_SCALAR))
264 #define CALLREG_NAMED_BUFF_COUNT(rx) \
265 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, RXapif_REGNAMES_COUNT)
267 #define CALLREG_NAMED_BUFF_ALL(rx, flags) \
268 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, flags)
270 #define CALLREG_PACKAGE(rx) \
271 RX_ENGINE(rx)->qr_package(aTHX_ (rx))
273 #if defined(USE_ITHREADS)
274 #define CALLREGDUPE(prog,param) \
275 Perl_re_dup(aTHX_ (prog),(param))
277 #define CALLREGDUPE_PVT(prog,param) \
278 (prog ? RX_ENGINE(prog)->dupe(aTHX_ (prog),(param)) \
282 /* some compilers impersonate gcc */
283 #if defined(__GNUC__) && !defined(__clang__) && !defined(__INTEL_COMPILER)
284 # define PERL_IS_GCC 1
287 /* In case Configure was not used (we are using a "canned config"
288 * such as Win32, or a cross-compilation setup, for example) try going
289 * by the gcc major and minor versions. One useful URL is
290 * http://www.ohse.de/uwe/articles/gcc-attributes.html,
291 * but contrary to this information warn_unused_result seems
292 * not to be in gcc 3.3.5, at least. --jhi
293 * Also, when building extensions with an installed perl, this allows
294 * the user to upgrade gcc and get the right attributes, rather than
295 * relying on the list generated at Configure time. --AD
296 * Set these up now otherwise we get confused when some of the <*thread.h>
297 * includes below indirectly pull in <perlio.h> (which needs to know if we
298 * have HASATTRIBUTE_FORMAT).
302 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
303 # if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
304 # define HASATTRIBUTE_DEPRECATED
306 # if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
307 # define HASATTRIBUTE_FORMAT
308 # if defined __MINGW32__
309 # define PRINTF_FORMAT_NULL_OK
312 # if __GNUC__ >= 3 /* 3.0 -> */
313 # define HASATTRIBUTE_MALLOC
315 # if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
316 # define HASATTRIBUTE_NONNULL
318 # if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
319 # define HASATTRIBUTE_NORETURN
321 # if __GNUC__ >= 3 /* gcc 3.0 -> */
322 # define HASATTRIBUTE_PURE
324 # if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
325 # define HASATTRIBUTE_UNUSED
327 # if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
328 # define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
330 # if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
331 # define HASATTRIBUTE_WARN_UNUSED_RESULT
333 /* always_inline is buggy in gcc <= 4.6 and causes compilation errors */
334 # if __GNUC__ == 4 && __GNUC_MINOR__ >= 7 || __GNUC__ > 4 /* 4.7 -> */
335 # define HASATTRIBUTE_ALWAYS_INLINE
338 #endif /* #ifndef PERL_MICRO */
340 #ifdef HASATTRIBUTE_DEPRECATED
341 # define __attribute__deprecated__ __attribute__((deprecated))
343 #ifdef HASATTRIBUTE_FORMAT
344 # define __attribute__format__(x,y,z) __attribute__((format(x,y,z)))
346 #ifdef HASATTRIBUTE_MALLOC
347 # define __attribute__malloc__ __attribute__((__malloc__))
349 #ifdef HASATTRIBUTE_NONNULL
350 # define __attribute__nonnull__(a) __attribute__((nonnull(a)))
352 #ifdef HASATTRIBUTE_NORETURN
353 # define __attribute__noreturn__ __attribute__((noreturn))
355 #ifdef HASATTRIBUTE_PURE
356 # define __attribute__pure__ __attribute__((pure))
358 #ifdef HASATTRIBUTE_UNUSED
359 # define __attribute__unused__ __attribute__((unused))
361 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
362 # define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
364 #ifdef HASATTRIBUTE_ALWAYS_INLINE
365 /* always_inline is buggy in gcc <= 4.6 and causes compilation errors */
366 # if !defined(PERL_IS_GCC) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7 || __GNUC__ > 4)
367 # define __attribute__always_inline__ __attribute__((always_inline))
371 /* If we haven't defined the attributes yet, define them to blank. */
372 #ifndef __attribute__deprecated__
373 # define __attribute__deprecated__
375 #ifndef __attribute__format__
376 # define __attribute__format__(x,y,z)
378 #ifndef __attribute__malloc__
379 # define __attribute__malloc__
381 #ifndef __attribute__nonnull__
382 # define __attribute__nonnull__(a)
384 #ifndef __attribute__noreturn__
385 # define __attribute__noreturn__
387 #ifndef __attribute__pure__
388 # define __attribute__pure__
390 #ifndef __attribute__unused__
391 # define __attribute__unused__
393 #ifndef __attribute__warn_unused_result__
394 # define __attribute__warn_unused_result__
396 #ifndef __attribute__always_inline__
397 # define __attribute__always_inline__
400 /* Some OS warn on NULL format to printf */
401 #ifdef PRINTF_FORMAT_NULL_OK
402 # define __attribute__format__null_ok__(x,y,z) __attribute__format__(x,y,z)
404 # define __attribute__format__null_ok__(x,y,z)
408 * Because of backward compatibility reasons the PERL_UNUSED_DECL
409 * cannot be changed from postfix to PERL_UNUSED_DECL(x). Sigh.
411 * Note that there are C compilers such as MetroWerks CodeWarrior
412 * which do not have an "inlined" way (like the gcc __attribute__) of
413 * marking unused variables (they need e.g. a #pragma) and therefore
414 * cpp macros like PERL_UNUSED_DECL cannot work for this purpose, even
415 * if it were PERL_UNUSED_DECL(x), which it cannot be (see above).
417 =for apidoc_section $directives
418 =for apidoc AmnU||PERL_UNUSED_DECL
419 Tells the compiler that the parameter in the function prototype just before it
420 is not necessarily expected to be used in the function. Not that many
421 compilers understand this, so this should only be used in cases where
422 C<L</PERL_UNUSED_ARG>> can't conveniently be used.
429 Perl_perly_sighandler(int sig, Siginfo_t *sip PERL_UNUSED_DECL,
430 void *uap PERL_UNUSED_DECL, bool safe)
437 #ifndef PERL_UNUSED_DECL
438 # define PERL_UNUSED_DECL __attribute__unused__
442 * for silencing unused variables that are actually used most of the time,
443 * but we cannot quite get rid of, such as "ax" in PPCODE+noargs xsubs,
444 * or variables/arguments that are used only in certain configurations.
446 =for apidoc Ams||PERL_UNUSED_ARG|void x
447 This is used to suppress compiler warnings that a parameter to a function is
448 not used. This situation can arise, for example, when a parameter is needed
449 under some configuration conditions, but not others, so that C preprocessor
450 conditional compilation causes it be used just some times.
452 =for apidoc Amns||PERL_UNUSED_CONTEXT
453 This is used to suppress compiler warnings that the thread context parameter to
454 a function is not used. This situation can arise, for example, when a
455 C preprocessor conditional compilation causes it be used just some times.
457 =for apidoc Ams||PERL_UNUSED_VAR|void x
458 This is used to suppress compiler warnings that the variable I<x> is not used.
459 This situation can arise, for example, when a C preprocessor conditional
460 compilation causes it be used just some times.
464 #ifndef PERL_UNUSED_ARG
465 # define PERL_UNUSED_ARG(x) ((void)sizeof(x))
467 #ifndef PERL_UNUSED_VAR
468 # define PERL_UNUSED_VAR(x) ((void)sizeof(x))
471 #if defined(USE_ITHREADS)
472 # define PERL_UNUSED_CONTEXT PERL_UNUSED_ARG(my_perl)
474 # define PERL_UNUSED_CONTEXT
477 /* gcc (-ansi) -pedantic doesn't allow gcc statement expressions,
478 * g++ allows them but seems to have problems with them
479 * (insane errors ensue).
480 * g++ does not give insane errors now (RMB 2008-01-30, gcc 4.2.2).
482 #if defined(PERL_GCC_PEDANTIC) || \
483 (defined(__GNUC__) && defined(__cplusplus) && \
484 ((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2))))
485 # ifndef PERL_GCC_BRACE_GROUPS_FORBIDDEN
486 # define PERL_GCC_BRACE_GROUPS_FORBIDDEN
492 =for apidoc Am||PERL_UNUSED_RESULT|void x
494 This macro indicates to discard the return value of the function call inside
497 PERL_UNUSED_RESULT(foo(a, b))
499 The main reason for this is that the combination of C<gcc -Wunused-result>
500 (part of C<-Wall>) and the C<__attribute__((warn_unused_result))> cannot
501 be silenced with casting to C<void>. This causes trouble when the system
502 header files use the attribute.
504 Use C<PERL_UNUSED_RESULT> sparingly, though, since usually the warning
505 is there for a good reason: you might lose success/failure information,
506 or leak resources, or changes in resources.
508 But sometimes you just want to ignore the return value, I<e.g.>, on
509 codepaths soon ending up in abort, or in "best effort" attempts,
510 or in situations where there is no good way to handle failures.
512 Sometimes C<PERL_UNUSED_RESULT> might not be the most natural way:
513 another possibility is that you can capture the return value
514 and use C<L</PERL_UNUSED_VAR>> on that.
518 The __typeof__() is used instead of typeof() since typeof() is not
519 available under strict C89, and because of compilers masquerading
520 as gcc (clang and icc), we want exactly the gcc extension
521 __typeof__ and nothing else.
524 #ifndef PERL_UNUSED_RESULT
525 # if defined(__GNUC__) && defined(HASATTRIBUTE_WARN_UNUSED_RESULT)
526 # define PERL_UNUSED_RESULT(v) STMT_START { __typeof__(v) z = (v); (void)sizeof(z); } STMT_END
528 # define PERL_UNUSED_RESULT(v) ((void)(v))
532 #if defined(_MSC_VER)
533 /* XXX older MSVC versions have a smallish macro buffer */
534 #define PERL_SMALL_MACRO_BUFFER
537 /* on gcc (and clang), specify that a warning should be temporarily
540 * GCC_DIAG_IGNORE_DECL(-Wmultichar);
542 * GCC_DIAG_RESTORE_DECL;
544 * based on http://dbp-consulting.com/tutorials/SuppressingGCCWarnings.html
546 * Note that "pragma GCC diagnostic push/pop" was added in GCC 4.6, Mar 2011;
547 * clang only pretends to be GCC 4.2, but still supports push/pop.
549 * Note on usage: all macros must be used at a place where a declaration
550 * or statement can occur, i.e., not in the middle of an expression.
551 * *_DIAG_IGNORE() and *_DIAG_RESTORE can be used in any such place, but
552 * must be used without a following semicolon. *_DIAG_IGNORE_DECL() and
553 * *_DIAG_RESTORE_DECL must be used with a following semicolon, and behave
554 * syntactically as declarations (like dNOOP). *_DIAG_IGNORE_STMT()
555 * and *_DIAG_RESTORE_STMT must be used with a following semicolon,
556 * and behave syntactically as statements (like NOOP).
560 #if defined(__clang__) || defined(__clang) || \
561 (defined( __GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406)
562 # define GCC_DIAG_PRAGMA(x) _Pragma (#x)
563 /* clang has "clang diagnostic" pragmas, but also understands gcc. */
564 # define GCC_DIAG_IGNORE(x) _Pragma("GCC diagnostic push") \
565 GCC_DIAG_PRAGMA(GCC diagnostic ignored #x)
566 # define GCC_DIAG_RESTORE _Pragma("GCC diagnostic pop")
568 # define GCC_DIAG_IGNORE(w)
569 # define GCC_DIAG_RESTORE
571 #define GCC_DIAG_IGNORE_DECL(x) GCC_DIAG_IGNORE(x) dNOOP
572 #define GCC_DIAG_RESTORE_DECL GCC_DIAG_RESTORE dNOOP
573 #define GCC_DIAG_IGNORE_STMT(x) GCC_DIAG_IGNORE(x) NOOP
574 #define GCC_DIAG_RESTORE_STMT GCC_DIAG_RESTORE NOOP
575 /* for clang specific pragmas */
576 #if defined(__clang__) || defined(__clang)
577 # define CLANG_DIAG_PRAGMA(x) _Pragma (#x)
578 # define CLANG_DIAG_IGNORE(x) _Pragma("clang diagnostic push") \
579 CLANG_DIAG_PRAGMA(clang diagnostic ignored #x)
580 # define CLANG_DIAG_RESTORE _Pragma("clang diagnostic pop")
582 # define CLANG_DIAG_IGNORE(w)
583 # define CLANG_DIAG_RESTORE
585 #define CLANG_DIAG_IGNORE_DECL(x) CLANG_DIAG_IGNORE(x) dNOOP
586 #define CLANG_DIAG_RESTORE_DECL CLANG_DIAG_RESTORE dNOOP
587 #define CLANG_DIAG_IGNORE_STMT(x) CLANG_DIAG_IGNORE(x) NOOP
588 #define CLANG_DIAG_RESTORE_STMT CLANG_DIAG_RESTORE NOOP
590 #if defined(_MSC_VER) && (_MSC_VER >= 1300)
591 # define MSVC_DIAG_IGNORE(x) __pragma(warning(push)) \
592 __pragma(warning(disable : x))
593 # define MSVC_DIAG_RESTORE __pragma(warning(pop))
595 # define MSVC_DIAG_IGNORE(x)
596 # define MSVC_DIAG_RESTORE
598 #define MSVC_DIAG_IGNORE_DECL(x) MSVC_DIAG_IGNORE(x) dNOOP
599 #define MSVC_DIAG_RESTORE_DECL MSVC_DIAG_RESTORE dNOOP
600 #define MSVC_DIAG_IGNORE_STMT(x) MSVC_DIAG_IGNORE(x) NOOP
601 #define MSVC_DIAG_RESTORE_STMT MSVC_DIAG_RESTORE NOOP
604 =for apidoc Amns||NOOP
605 Do nothing; typically used as a placeholder to replace something that used to
608 =for apidoc Amns||dNOOP
609 Declare nothing; typically used as a placeholder to replace something that used
610 to declare something. Works on compilers that require declarations before any
615 #define NOOP /*EMPTY*/(void)0
616 #define dNOOP struct Perl___notused_struct
619 /* Don't bother defining tTHX ; using it outside
620 * code guarded by PERL_IMPLICIT_CONTEXT is an error.
626 # define aTHXa(a) NOOP
627 # define dTHXa(a) dNOOP
642 =for apidoc_section $concurrency
643 =for apidoc AmnU||dVAR
644 This is now a synonym for dNOOP: declare nothing
650 /* Backwards compatibility macro for XS code. It used to be part of the
651 * PERL_GLOBAL_STRUCT(_PRIVATE) feature, which no longer exists */
654 /* these are only defined for compatibility; should not be used internally.
658 # define pTHXo_ pTHX_
660 # define aTHXo_ aTHX_
662 # define dTHXoa(x) dTHXa(x)
667 # define pTHXx PerlInterpreter *my_perl
668 # define pTHXx_ pTHXx,
669 # define aTHXx my_perl
670 # define aTHXx_ aTHXx,
674 /* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
675 * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
676 * dTHXs is therefore needed for all functions using PerlIO_foo(). */
677 #ifdef PERL_IMPLICIT_SYS
683 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
684 # ifndef PERL_USE_GCC_BRACE_GROUPS
685 # define PERL_USE_GCC_BRACE_GROUPS
690 =for apidoc_section $directives
691 =for apidoc AmnUu|void|STMT_START
692 =for apidoc_item ||STMT_END
694 This allows a series of statements in a macro to be used as a single statement,
697 if (x) STMT_START { ... } STMT_END else ...
699 Note that you can't return a value out of them, which limits their utility.
700 But see C<L</PERL_USE_GCC_BRACE_GROUPS>>.
702 =for apidoc AmnuU|bool|PERL_USE_GCC_BRACE_GROUPS
704 This C pre-processor value, if defined, indicates that it is permissible to use
705 the GCC brace groups extension. This extension, of the form
709 turns the block consisting of I<statements ...> into an expression with a
710 value, unlike plain C language blocks. This can present optimization
711 possibilities, B<BUT> you generally need to specify an alternative in case this
712 ability doesn't exist or has otherwise been forbidden.
718 #ifdef PERL_USE_GCC_BRACE_GROUPS
728 Trying to select a version that gives no warnings...
730 #if !(defined(STMT_START) && defined(STMT_END))
731 # ifdef PERL_USE_GCC_BRACE_GROUPS
732 # define STMT_START (void)( /* gcc supports "({ STATEMENTS; })" */
735 # define STMT_START do
736 # define STMT_END while (0)
740 #ifndef BYTEORDER /* Should never happen -- byteorder is in config.h */
741 # define BYTEORDER 0x1234
744 #if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
751 * The following contortions are brought to you on behalf of all the
752 * standards, semi-standards, de facto standards, not-so-de-facto standards
753 * of the world, as well as all the other botches anyone ever thought of.
754 * The basic theory is that if we work hard enough here, the rest of the
755 * code can be a lot prettier. Well, so much for theory. Sorry, Henry...
758 /* define this once if either system, instead of cluttering up the src */
759 #if defined(MSDOS) || defined(WIN32) || defined(NETWARE)
763 /* These exist only for back-compat with XS modules. */
766 #define CAN_PROTOTYPE
773 /* By compiling a perl with -DNO_TAINT_SUPPORT or -DSILENT_NO_TAINT_SUPPORT,
774 * you get a perl without taint support, but doubtlessly with a lesser
775 * degree of support. Do not do so unless you know exactly what it means
776 * technically, have a good reason to do so, and know exactly how the
777 * perl will be used. perls with -DSILENT_NO_TAINT_SUPPORT are considered
778 * a potential security risk due to flat out ignoring the security-relevant
779 * taint flags. This being said, a perl without taint support compiled in
780 * has marginal run-time performance benefits.
781 * SILENT_NO_TAINT_SUPPORT implies NO_TAINT_SUPPORT.
782 * SILENT_NO_TAINT_SUPPORT is the same as NO_TAINT_SUPPORT except it
783 * silently ignores -t/-T instead of throwing an exception.
785 * DANGER! Using NO_TAINT_SUPPORT or SILENT_NO_TAINT_SUPPORT
786 * voids your nonexistent warranty!
788 #if defined(SILENT_NO_TAINT_SUPPORT) && !defined(NO_TAINT_SUPPORT)
789 # define NO_TAINT_SUPPORT 1
792 /* NO_TAINT_SUPPORT can be set to transform virtually all taint-related
793 * operations into no-ops for a very modest speed-up. Enable only if you
794 * know what you're doing: tests and CPAN modules' tests are bound to fail.
796 #ifdef NO_TAINT_SUPPORT
798 # define TAINT_NOT NOOP
799 # define TAINT_IF(c) NOOP
800 # define TAINT_ENV() NOOP
801 # define TAINT_PROPER(s) NOOP
802 # define TAINT_set(s) NOOP
804 # define TAINTING_get 0
805 # define TAINTING_set(s) NOOP
806 # define TAINT_WARN_get 0
807 # define TAINT_WARN_set(s) NOOP
809 /* Set to tainted if we are running under tainting mode */
810 # define TAINT (PL_tainted = PL_tainting)
812 # define TAINT_NOT (PL_tainted = FALSE) /* Untaint */
813 # define TAINT_IF(c) if (UNLIKELY(c)) { TAINT; } /* Conditionally taint */
814 # define TAINT_ENV() if (UNLIKELY(PL_tainting)) { taint_env(); }
815 /* croak or warn if tainting */
816 # define TAINT_PROPER(s) if (UNLIKELY(PL_tainting)) { \
817 taint_proper(NULL, s); \
819 # define TAINT_set(s) (PL_tainted = (s))
820 # define TAINT_get (cBOOL(UNLIKELY(PL_tainted))) /* Is something tainted? */
821 # define TAINTING_get (cBOOL(UNLIKELY(PL_tainting))) /* Is taint checking enabled? */
822 # define TAINTING_set(s) (PL_tainting = (s))
823 # define TAINT_WARN_get (PL_taint_warn) /* FALSE => tainting violations
827 # define TAINT_WARN_set(s) (PL_taint_warn = (s))
830 /* flags used internally only within pp_subst and pp_substcont */
832 # define SUBST_TAINT_STR 1 /* string tainted */
833 # define SUBST_TAINT_PAT 2 /* pattern tainted */
834 # define SUBST_TAINT_REPL 4 /* replacement tainted */
835 # define SUBST_TAINT_RETAINT 8 /* use re'taint' in scope */
836 # define SUBST_TAINT_BOOLRET 16 /* return is boolean (don't taint) */
839 /* XXX All process group stuff is handled in pp_sys.c. Should these
840 defines move there? If so, I could simplify this a lot. --AD 9/96.
842 /* Process group stuff changed from traditional BSD to POSIX.
843 perlfunc.pod documents the traditional BSD-style syntax, so we'll
844 try to preserve that, if possible.
847 # define BSD_SETPGRP(pid, pgrp) setpgid((pid), (pgrp))
848 #elif defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
849 # define BSD_SETPGRP(pid, pgrp) setpgrp((pid), (pgrp))
850 #elif defined(HAS_SETPGRP2)
851 # define BSD_SETPGRP(pid, pgrp) setpgrp2((pid), (pgrp))
853 #if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
854 # define HAS_SETPGRP /* Well, effectively it does . . . */
857 /* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
858 our life easier :-) so we'll try it.
861 # define BSD_GETPGRP(pid) getpgid((pid))
862 #elif defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
863 # define BSD_GETPGRP(pid) getpgrp((pid))
864 #elif defined(HAS_GETPGRP2)
865 # define BSD_GETPGRP(pid) getpgrp2((pid))
867 #if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
868 # define HAS_GETPGRP /* Well, effectively it does . . . */
871 /* These are not exact synonyms, since setpgrp() and getpgrp() may
872 have different behaviors, but perl.h used to define USE_BSDPGRP
873 (prior to 5.003_05) so some extension might depend on it.
875 #if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
881 /* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
882 pthread.h must be included before all other header files.
884 #if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
885 # include <pthread.h>
888 #include <sys/types.h>
904 #ifdef METHOD /* Defined by OSF/1 v3.0 by ctype.h */
917 # include <xlocale.h>
920 /* If not forbidden, we enable locale handling if either 1) the POSIX 2008
921 * functions are available, or 2) just the setlocale() function. This logic is
922 * repeated in t/loc_tools.pl and makedef.pl; The three should be kept in
924 #if ! defined(NO_LOCALE)
926 # if ! defined(NO_POSIX_2008_LOCALE) \
927 && defined(HAS_NEWLOCALE) \
928 && defined(HAS_USELOCALE) \
929 && defined(HAS_DUPLOCALE) \
930 && defined(HAS_FREELOCALE) \
931 && defined(LC_ALL_MASK)
933 /* For simplicity, the code is written to assume that any platform advanced
934 * enough to have the Posix 2008 locale functions has LC_ALL. The final
935 * test above makes sure that assumption is valid */
937 # define HAS_POSIX_2008_LOCALE
939 # elif defined(HAS_SETLOCALE)
945 # define HAS_SKIP_LOCALE_INIT /* Solely for XS code to test for this
947 # if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
948 && defined(HAS_STRXFRM)
949 # define USE_LOCALE_COLLATE
951 # if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
952 # define USE_LOCALE_CTYPE
954 # if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
955 # define USE_LOCALE_NUMERIC
957 # if !defined(NO_LOCALE_MESSAGES) && defined(LC_MESSAGES)
958 # define USE_LOCALE_MESSAGES
960 # if !defined(NO_LOCALE_MONETARY) && defined(LC_MONETARY)
961 # define USE_LOCALE_MONETARY
963 # if !defined(NO_LOCALE_TIME) && defined(LC_TIME)
964 # define USE_LOCALE_TIME
966 # if !defined(NO_LOCALE_ADDRESS) && defined(LC_ADDRESS)
967 # define USE_LOCALE_ADDRESS
969 # if !defined(NO_LOCALE_IDENTIFICATION) && defined(LC_IDENTIFICATION)
970 # define USE_LOCALE_IDENTIFICATION
972 # if !defined(NO_LOCALE_MEASUREMENT) && defined(LC_MEASUREMENT)
973 # define USE_LOCALE_MEASUREMENT
975 # if !defined(NO_LOCALE_PAPER) && defined(LC_PAPER)
976 # define USE_LOCALE_PAPER
978 # if !defined(NO_LOCALE_TELEPHONE) && defined(LC_TELEPHONE)
979 # define USE_LOCALE_TELEPHONE
981 # if !defined(NO_LOCALE_SYNTAX) && defined(LC_SYNTAX)
982 # define USE_LOCALE_SYNTAX
984 # if !defined(NO_LOCALE_TOD) && defined(LC_TOD)
985 # define USE_LOCALE_TOD
988 /* XXX The next few defines are unfortunately duplicated in makedef.pl, and
989 * changes here MUST also be made there */
991 # if ! defined(HAS_SETLOCALE) && defined(HAS_POSIX_2008_LOCALE)
992 # define USE_POSIX_2008_LOCALE
993 # ifndef USE_THREAD_SAFE_LOCALE
994 # define USE_THREAD_SAFE_LOCALE
997 * -DUSE_THREAD_SAFE_LOCALE, will do so even
998 * on unthreaded builds */
999 # elif (defined(USE_ITHREADS) || defined(USE_THREAD_SAFE_LOCALE)) \
1000 && ( defined(HAS_POSIX_2008_LOCALE) \
1001 || (defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1400)) \
1002 && ! defined(NO_THREAD_SAFE_LOCALE)
1003 # ifndef USE_THREAD_SAFE_LOCALE
1004 # define USE_THREAD_SAFE_LOCALE
1006 # ifdef HAS_POSIX_2008_LOCALE
1007 # define USE_POSIX_2008_LOCALE
1012 /* Microsoft documentation reads in the change log for VS 2015:
1013 * "The localeconv function declared in locale.h now works correctly when
1014 * per-thread locale is enabled. In previous versions of the library, this
1015 * function would return the lconv data for the global locale, not the
1018 #if defined(WIN32) && defined(USE_THREAD_SAFE_LOCALE) && _MSC_VER < 1900
1019 # define TS_W32_BROKEN_LOCALECONV
1025 # ifdef PARAM_NEEDS_TYPES
1026 # include <sys/types.h>
1028 # include <sys/param.h>
1031 /* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
1032 value something like 199306. This may be useful if no more-specific
1033 feature test is available.
1041 /* Use all the "standard" definitions */
1044 /* If this causes problems, set i_unistd=undef in the hint file. */
1046 # if defined(__amigaos4__)
1047 # ifdef I_NETINET_IN
1048 # include <netinet/in.h>
1051 # include <unistd.h>
1052 # if defined(__amigaos4__)
1053 /* Under AmigaOS 4 newlib.library provides an environ. However using
1054 * it doesn't give us enough control over inheritance of variables by
1055 * subshells etc. so replace with custom version based on abc-shell
1057 extern char **myenviron;
1059 # define environ myenviron
1065 # include <sys/wait.h>
1068 #if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
1069 EXTERN_C int syscall(int, ...);
1072 #if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
1073 EXTERN_C int usleep(unsigned int);
1076 /* Macros for correct constant construction. These are in C99 <stdint.h>
1077 * (so they will not be available in strict C89 mode), but they are nice, so
1078 * let's define them if necessary.
1079 =for apidoc_section $integer
1080 =for apidoc Am|I16|INT16_C|number
1081 =for apidoc_item |I32|INT32_C|number
1082 =for apidoc_item |I64|INT64_C|number
1084 Returns a token the C compiler recognizes for the constant C<number> of the
1085 corresponding integer type on the machine.
1087 If the machine does not have a 64-bit type, C<INT64_C> is undefined.
1088 Use C<L</INTMAX_C>> to get the largest type available on the platform.
1090 =for apidoc Am|U16|UINT16_C|number
1091 =for apidoc_item |U32|UINT32_C|number
1092 =for apidoc_item |U64|UINT64_C|number
1094 Returns a token the C compiler recognizes for the constant C<number> of the
1095 corresponding unsigned integer type on the machine.
1097 If the machine does not have a 64-bit type, C<UINT64_C> is undefined.
1098 Use C<L</UINTMAX_C>> to get the largest type available on the platform.
1105 # define UINT16_C(x) ((U16_TYPE)x##U)
1107 # define UINT16_C(x) ((U16_TYPE)x##UL)
1113 # define UINT32_C(x) ((U32_TYPE)x##U)
1115 # define UINT32_C(x) ((U32_TYPE)x##UL)
1120 typedef intmax_t PERL_INTMAX_T;
1121 typedef uintmax_t PERL_UINTMAX_T;
1124 /* N.B. We use QUADKIND here instead of HAS_QUAD here, because that doesn't
1125 * actually mean what it has always been documented to mean (see RT #119753)
1126 * and is explicitly turned off outside of core with dire warnings about
1127 * removing the undef. */
1129 #if defined(QUADKIND)
1130 # undef PeRl_INT64_C
1131 # undef PeRl_UINT64_C
1132 /* Prefer the native integer types (int and long) over long long
1133 * (which is not C89) and Win32-specific __int64. */
1134 # if QUADKIND == QUAD_IS_INT && INTSIZE == 8
1135 # define PeRl_INT64_C(c) (c)
1136 # define PeRl_UINT64_C(c) CAT2(c,U)
1138 # if QUADKIND == QUAD_IS_LONG && LONGSIZE == 8
1139 # define PeRl_INT64_C(c) CAT2(c,L)
1140 # define PeRl_UINT64_C(c) CAT2(c,UL)
1142 # if QUADKIND == QUAD_IS_LONG_LONG && defined(HAS_LONG_LONG)
1143 # define PeRl_INT64_C(c) CAT2(c,LL)
1144 # define PeRl_UINT64_C(c) CAT2(c,ULL)
1146 # if QUADKIND == QUAD_IS___INT64
1147 # define PeRl_INT64_C(c) CAT2(c,I64)
1148 # define PeRl_UINT64_C(c) CAT2(c,UI64)
1150 # ifndef PeRl_INT64_C
1151 # define PeRl_INT64_C(c) ((I64)(c)) /* last resort */
1152 # define PeRl_UINT64_C(c) ((U64TYPE)(c))
1154 /* In OS X the INT64_C/UINT64_C are defined with LL/ULL, which will
1155 * not fly with C89-pedantic gcc, so let's undefine them first so that
1156 * we can redefine them with our native integer preferring versions. */
1157 # if defined(PERL_DARWIN) && defined(PERL_GCC_PEDANTIC)
1162 # define INT64_C(c) PeRl_INT64_C(c)
1165 # define UINT64_C(c) PeRl_UINT64_C(c)
1169 =for apidoc_section $integer
1170 =for apidoc Am||INTMAX_C|number
1171 Returns a token the C compiler recognizes for the constant C<number> of the
1172 widest integer type on the machine. For example, if the machine has C<long
1173 long>s, C<INTMAX_C(-1)> would yield
1177 See also, for example, C<L</INT32_C>>.
1179 Use L</IV> to declare variables of the maximum usable size on this platform.
1181 =for apidoc Am||UINTMAX_C|number
1182 Returns a token the C compiler recognizes for the constant C<number> of the
1183 widest unsigned integer type on the machine. For example, if the machine has
1184 C<long>s, C<UINTMAX_C(1)> would yield
1188 See also, for example, C<L</UINT32_C>>.
1190 Use L</UV> to declare variables of the maximum usable size on this platform.
1196 typedef I64TYPE PERL_INTMAX_T;
1197 typedef U64TYPE PERL_UINTMAX_T;
1200 # define INTMAX_C(c) INT64_C(c)
1203 # define UINTMAX_C(c) UINT64_C(c)
1206 #else /* below QUADKIND is undefined */
1208 /* Perl doesn't work on 16 bit systems, so must be 32 bit */
1210 typedef I32TYPE PERL_INTMAX_T;
1211 typedef U32TYPE PERL_UINTMAX_T;
1214 # define INTMAX_C(c) INT32_C(c)
1217 # define UINTMAX_C(c) UINT32_C(c)
1220 #endif /* no QUADKIND */
1224 /* byte-swapping functions for big-/little-endian conversion */
1225 # define _swab_16_(x) ((U16)( \
1226 (((U16)(x) & UINT16_C(0x00ff)) << 8) | \
1227 (((U16)(x) & UINT16_C(0xff00)) >> 8) ))
1229 # define _swab_32_(x) ((U32)( \
1230 (((U32)(x) & UINT32_C(0x000000ff)) << 24) | \
1231 (((U32)(x) & UINT32_C(0x0000ff00)) << 8) | \
1232 (((U32)(x) & UINT32_C(0x00ff0000)) >> 8) | \
1233 (((U32)(x) & UINT32_C(0xff000000)) >> 24) ))
1236 # define _swab_64_(x) ((U64)( \
1237 (((U64)(x) & UINT64_C(0x00000000000000ff)) << 56) | \
1238 (((U64)(x) & UINT64_C(0x000000000000ff00)) << 40) | \
1239 (((U64)(x) & UINT64_C(0x0000000000ff0000)) << 24) | \
1240 (((U64)(x) & UINT64_C(0x00000000ff000000)) << 8) | \
1241 (((U64)(x) & UINT64_C(0x000000ff00000000)) >> 8) | \
1242 (((U64)(x) & UINT64_C(0x0000ff0000000000)) >> 24) | \
1243 (((U64)(x) & UINT64_C(0x00ff000000000000)) >> 40) | \
1244 (((U64)(x) & UINT64_C(0xff00000000000000)) >> 56) ))
1247 /* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
1248 at least on FreeBSD. YMMV, so experiment. */
1249 #ifndef PERL_ARENA_SIZE
1250 #define PERL_ARENA_SIZE 4080
1253 /* Maximum level of recursion */
1254 #ifndef PERL_SUB_DEPTH_WARN
1255 #define PERL_SUB_DEPTH_WARN 100
1258 #endif /* PERL_CORE */
1260 /* Maximum number of args that may be passed to an OP_MULTICONCAT op.
1261 * It determines the size of local arrays in S_maybe_multiconcat() and
1264 #define PERL_MULTICONCAT_MAXARG 64
1266 /* The indexes of fields of a multiconcat aux struct.
1267 * The fixed fields are followed by nargs+1 const segment lengths,
1268 * and if utf8 and non-utf8 differ, a second nargs+1 set for utf8.
1271 #define PERL_MULTICONCAT_IX_NARGS 0 /* number of arguments */
1272 #define PERL_MULTICONCAT_IX_PLAIN_PV 1 /* non-utf8 constant string */
1273 #define PERL_MULTICONCAT_IX_PLAIN_LEN 2 /* non-utf8 constant string length */
1274 #define PERL_MULTICONCAT_IX_UTF8_PV 3 /* utf8 constant string */
1275 #define PERL_MULTICONCAT_IX_UTF8_LEN 4 /* utf8 constant string length */
1276 #define PERL_MULTICONCAT_IX_LENGTHS 5 /* first of nargs+1 const segment lens */
1277 #define PERL_MULTICONCAT_HEADER_SIZE 5 /* The number of fields of a
1278 multiconcat header */
1280 /* We no longer default to creating a new SV for GvSV.
1281 Do this before embed. */
1282 #ifndef PERL_CREATE_GVSV
1283 # ifndef PERL_DONT_CREATE_GVSV
1284 # define PERL_DONT_CREATE_GVSV
1288 #if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
1289 #define PERL_USES_PL_PIDSTATUS
1292 #if !defined(OS2) && !defined(WIN32) && !defined(DJGPP)
1293 #define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
1296 #define MEM_SIZE Size_t
1298 /* Round all values passed to malloc up, by default to a multiple of
1301 #ifndef PERL_STRLEN_ROUNDUP_QUANTUM
1302 #define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
1305 /* sv_grow() will expand strings by at least a certain percentage of
1306 the previously *used* length to avoid excessive calls to realloc().
1307 The default is 25% of the current length.
1309 #ifndef PERL_STRLEN_EXPAND_SHIFT
1310 # define PERL_STRLEN_EXPAND_SHIFT 2
1313 /* This use of offsetof() requires /Zc:offsetof- for VS2017 (and presumably
1314 * onwards) when building Socket.xs, but we can just use a different definition
1315 * for STRUCT_OFFSET instead. */
1316 #if defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1910
1317 # define STRUCT_OFFSET(s,m) (Size_t)(&(((s *)0)->m))
1319 # include <stddef.h>
1320 # define STRUCT_OFFSET(s,m) offsetof(s,m)
1323 /* ptrdiff_t is C11, so undef it under pedantic builds. (Actually it is
1324 * in C89, but apparently there are platforms where it doesn't exist. See
1325 * thread beginning at http://nntp.perl.org/group/perl.perl5.porters/251541.)
1327 #ifdef PERL_GCC_PEDANTIC
1328 # undef HAS_PTRDIFF_T
1331 #ifdef HAS_PTRDIFF_T
1332 # define Ptrdiff_t ptrdiff_t
1334 # define Ptrdiff_t SSize_t
1337 # include <string.h>
1339 /* This comes after <stdlib.h> so we don't try to change the standard
1340 * library prototypes; we'll use our own in proto.h instead. */
1343 # ifdef PERL_POLLUTE_MALLOC
1344 # ifndef PERL_EXTMALLOC_DEF
1345 # define Perl_malloc malloc
1346 # define Perl_calloc calloc
1347 # define Perl_realloc realloc
1348 # define Perl_mfree free
1351 # define EMBEDMYMALLOC /* for compatibility */
1354 # define safemalloc Perl_malloc
1355 # define safecalloc Perl_calloc
1356 # define saferealloc Perl_realloc
1357 # define safefree Perl_mfree
1358 # define CHECK_MALLOC_TOO_LATE_FOR_(code) STMT_START { \
1359 if (!TAINTING_get && MallocCfg_ptr[MallocCfg_cfg_env_read]) \
1362 # define CHECK_MALLOC_TOO_LATE_FOR(ch) \
1363 CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
1364 # define panic_write2(s) write(2, s, strlen(s))
1365 # define CHECK_MALLOC_TAINT(newval) \
1366 CHECK_MALLOC_TOO_LATE_FOR_( \
1368 PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
1370 # define MALLOC_CHECK_TAINT(argc,argv,env) STMT_START { \
1371 if (doing_taint(argc,argv,env)) { \
1372 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1; \
1374 #else /* MYMALLOC */
1375 # define safemalloc safesysmalloc
1376 # define safecalloc safesyscalloc
1377 # define saferealloc safesysrealloc
1378 # define safefree safesysfree
1379 # define CHECK_MALLOC_TOO_LATE_FOR(ch) ((void)0)
1380 # define CHECK_MALLOC_TAINT(newval) ((void)0)
1381 # define MALLOC_CHECK_TAINT(argc,argv,env)
1382 #endif /* MYMALLOC */
1384 /* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
1385 #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)
1386 #define TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, "")
1387 #define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
1388 #define MALLOC_CHECK_TAINT2(argc,argv) MALLOC_CHECK_TAINT(argc,argv,NULL)
1391 =for apidoc Am|void|memzero|void * d|Size_t l
1392 Set the C<l> bytes starting at C<*d> to all zeroes.
1397 # define memzero(d,l) memset(d,0,l)
1401 # include <netinet/in.h>
1405 # include <arpa/inet.h>
1409 # include <sys/stat.h>
1412 /* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1413 This definition should ideally go into win32/win32.h, but S_IFIFO is
1414 used later here in perl.h before win32/win32.h is being included. */
1415 #if !defined(S_IFIFO) && defined(_S_IFIFO)
1416 # define S_IFIFO _S_IFIFO
1419 /* The stat macros for Unisoft System V/88 (and derivatives
1420 like UTekV) are broken, sometimes giving false positives. Undefine
1421 them here and let the code below set them to proper values.
1423 The ghs macro stands for GreenHills Software C-1.8.5 which
1424 is the C compiler for sysV88 and the various derivatives.
1425 This header file bug is corrected in gcc-2.5.8 and later versions.
1426 --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94. */
1428 #if defined(m88k) && defined(ghs)
1440 # ifdef I_SYS_TIME_KERNEL
1443 # include <sys/time.h>
1444 # ifdef I_SYS_TIME_KERNEL
1449 #if defined(HAS_TIMES) && defined(I_SYS_TIMES)
1450 # include <sys/times.h>
1455 #if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
1456 # define WIN32SCK_IS_STDSCK /* don't pull in custom wsock layer */
1459 #if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1460 # include <sys/socket.h>
1461 # if defined(USE_SOCKS) && defined(I_SOCKS)
1462 # if !defined(INCLUDE_PROTOTYPES)
1463 # define INCLUDE_PROTOTYPES /* for <socks.h> */
1464 # define PERL_SOCKS_NEED_PROTOTYPES
1467 # ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1468 # undef INCLUDE_PROTOTYPES
1469 # undef PERL_SOCKS_NEED_PROTOTYPES
1480 # include <net/errno.h>
1485 /* sockatmark() is so new (2001) that many places might have it hidden
1486 * behind some -D_BLAH_BLAH_SOURCE guard. The __THROW magic is required
1487 * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
1488 #if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
1489 # if defined(__THROW) && defined(__GLIBC__)
1490 int sockatmark(int) __THROW;
1492 int sockatmark(int);
1496 #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. */
1497 EXTERN_C int fchdir(int);
1498 EXTERN_C int flock(int, int);
1499 EXTERN_C int fseeko(FILE *, off_t, int);
1500 EXTERN_C off_t ftello(FILE *);
1503 #if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1504 EXTERN_C char *crypt(const char *, const char *);
1507 #if defined(__cplusplus) && defined(__CYGWIN__)
1508 EXTERN_C char *crypt(const char *, const char *);
1512 =for apidoc_section $errno
1514 =for apidoc m|void|SETERRNO|int errcode|int vmserrcode
1516 Set C<errno>, and on VMS set C<vaxc$errno>.
1518 =for apidoc mn|void|dSAVEDERRNO
1520 Declare variables needed to save C<errno> and any operating system
1521 specific error number.
1523 =for apidoc mn|void|dSAVE_ERRNO
1525 Declare variables needed to save C<errno> and any operating system
1526 specific error number, and save them for optional later restoration
1527 by C<RESTORE_ERRNO>.
1529 =for apidoc mn|void|SAVE_ERRNO
1531 Save C<errno> and any operating system specific error number for
1532 optional later restoration by C<RESTORE_ERRNO>. Requires
1533 C<dSAVEDERRNO> or C<dSAVE_ERRNO> in scope.
1535 =for apidoc mn|void|RESTORE_ERRNO
1537 Restore C<errno> and any operating system specific error number that
1538 was saved by C<dSAVE_ERRNO> or C<RESTORE_ERRNO>.
1544 # undef SETERRNO /* SOCKS might have defined this */
1548 # define SETERRNO(errcode,vmserrcode) \
1550 set_errno(errcode); \
1551 set_vaxc_errno(vmserrcode); \
1553 # define dSAVEDERRNO int saved_errno; unsigned saved_vms_errno
1554 # define dSAVE_ERRNO int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1555 # define SAVE_ERRNO ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1556 # define RESTORE_ERRNO SETERRNO(saved_errno, saved_vms_errno)
1558 # define LIB_INVARG LIB$_INVARG
1559 # define RMS_DIR RMS$_DIR
1560 # define RMS_FAC RMS$_FAC
1561 # define RMS_FEX RMS$_FEX
1562 # define RMS_FNF RMS$_FNF
1563 # define RMS_IFI RMS$_IFI
1564 # define RMS_ISI RMS$_ISI
1565 # define RMS_PRV RMS$_PRV
1566 # define SS_ACCVIO SS$_ACCVIO
1567 # define SS_DEVOFFLINE SS$_DEVOFFLINE
1568 # define SS_IVCHAN SS$_IVCHAN
1569 # define SS_NORMAL SS$_NORMAL
1570 # define SS_NOPRIV SS$_NOPRIV
1571 # define SS_BUFFEROVF SS$_BUFFEROVF
1573 # define LIB_INVARG 0
1581 # define SS_ACCVIO 0
1582 # define SS_DEVOFFLINE 0
1583 # define SS_IVCHAN 0
1584 # define SS_NORMAL 0
1585 # define SS_NOPRIV 0
1586 # define SS_BUFFEROVF 0
1590 # define dSAVEDERRNO int saved_errno; DWORD saved_win32_errno
1591 # define dSAVE_ERRNO int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1592 # define SAVE_ERRNO ( saved_errno = errno, saved_win32_errno = GetLastError() )
1593 # define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1597 # define dSAVEDERRNO int saved_errno; unsigned long saved_os2_errno
1598 # define dSAVE_ERRNO int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1599 # define SAVE_ERRNO ( saved_errno = errno, saved_os2_errno = Perl_rc )
1600 # define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1604 # define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1608 # define dSAVEDERRNO int saved_errno
1609 # define dSAVE_ERRNO int saved_errno = errno
1610 # define SAVE_ERRNO (saved_errno = errno)
1611 # define RESTORE_ERRNO (errno = saved_errno)
1615 =for apidoc_section $warning
1617 =for apidoc Amn|SV *|ERRSV
1619 Returns the SV for C<$@>, creating it if needed.
1621 =for apidoc Am|void|CLEAR_ERRSV
1623 Clear the contents of C<$@>, setting it to the empty string.
1625 This replaces any read-only SV with a fresh SV and removes any magic.
1627 =for apidoc Am|void|SANE_ERRSV
1629 Clean up ERRSV so we can safely set it.
1631 This replaces any read-only SV with a fresh writable copy and removes
1637 #define ERRSV GvSVn(PL_errgv)
1639 /* contains inlined gv_add_by_type */
1640 #define CLEAR_ERRSV() STMT_START { \
1641 SV ** const svp = &GvSV(PL_errgv); \
1643 *svp = newSVpvs(""); \
1644 } else if (SvREADONLY(*svp)) { \
1645 SvREFCNT_dec_NN(*svp); \
1646 *svp = newSVpvs(""); \
1648 SV *const errsv = *svp; \
1650 SvPOK_only(errsv); \
1651 if (SvMAGICAL(errsv)) { \
1657 /* contains inlined gv_add_by_type */
1658 #define SANE_ERRSV() STMT_START { \
1659 SV ** const svp = &GvSV(PL_errgv); \
1661 *svp = newSVpvs(""); \
1662 } else if (SvREADONLY(*svp)) { \
1663 SV *dupsv = newSVsv(*svp); \
1664 SvREFCNT_dec_NN(*svp); \
1667 SV *const errsv = *svp; \
1668 if (SvMAGICAL(errsv)) { \
1676 # define DEFSV (0 + GvSVn(PL_defgv))
1677 # define DEFSV_set(sv) \
1678 (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1679 # define SAVE_DEFSV \
1681 save_gp(PL_defgv, 0), \
1682 GvINTRO_off(PL_defgv), \
1683 SAVEGENERICSV(GvSV(PL_defgv)), \
1684 GvSV(PL_defgv) = NULL \
1687 # define DEFSV GvSVn(PL_defgv)
1688 # define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1689 # define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
1693 =for apidoc_section $SV
1694 =for apidoc Amn|SV *|DEFSV
1695 Returns the SV associated with C<$_>
1697 =for apidoc Am|void|DEFSV_set|SV * sv
1698 Associate C<sv> with C<$_>
1700 =for apidoc Amn|void|SAVE_DEFSV
1701 Localize C<$_>. See L<perlguts/Localizing changes>.
1707 extern int errno; /* ANSI allows errno to be an lvalue expr.
1708 * For example in multithreaded environments
1709 * something like this might happen:
1710 * extern int *_errno(void);
1711 * #define errno (*_errno()) */
1714 #define UNKNOWN_ERRNO_MSG "(unknown)"
1717 #define Strerror(e) strerror((e), vaxc$errno)
1719 #define Strerror(e) strerror(e)
1724 # include <sys/ioctl.h>
1728 #if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
1729 # ifdef HAS_SOCKETPAIR
1730 # undef HAS_SOCKETPAIR
1737 #ifndef HAS_SOCKETPAIR
1739 # define socketpair Perl_my_socketpair
1744 # define htoni htons
1745 # define ntohi ntohs
1747 # define htoni htonl
1748 # define ntohi ntohl
1751 /* Configure already sets Direntry_t */
1752 #if defined(I_DIRENT)
1753 # include <dirent.h>
1754 #elif defined(I_SYS_NDIR)
1755 # include <sys/ndir.h>
1756 #elif defined(I_SYS_DIR)
1757 # include <sys/dir.h>
1761 * The following gobbledygook brought to you on behalf of __STDC__.
1762 * (I could just use #ifndef __STDC__, but this is more bulletproof
1763 * in the face of half-implementations.)
1766 #if defined(I_SYSMODE)
1767 #include <sys/mode.h>
1772 # define S_IFMT _S_IFMT
1774 # define S_IFMT 0170000
1779 # define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1783 # define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1788 # define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1790 # define S_ISBLK(m) (0)
1795 # define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1800 # define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1802 # define S_ISFIFO(m) (0)
1808 # define S_ISLNK(m) _S_ISLNK(m)
1809 # elif defined(_S_IFLNK)
1810 # define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1811 # elif defined(S_IFLNK)
1812 # define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1814 # define S_ISLNK(m) (0)
1820 # define S_ISSOCK(m) _S_ISSOCK(m)
1821 # elif defined(_S_IFSOCK)
1822 # define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1823 # elif defined(S_IFSOCK)
1824 # define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1826 # define S_ISSOCK(m) (0)
1832 # define S_IRUSR S_IREAD
1833 # define S_IWUSR S_IWRITE
1834 # define S_IXUSR S_IEXEC
1836 # define S_IRUSR 0400
1837 # define S_IWUSR 0200
1838 # define S_IXUSR 0100
1844 # define S_IRGRP (S_IRUSR>>3)
1845 # define S_IWGRP (S_IWUSR>>3)
1846 # define S_IXGRP (S_IXUSR>>3)
1848 # define S_IRGRP 0040
1849 # define S_IWGRP 0020
1850 # define S_IXGRP 0010
1856 # define S_IROTH (S_IRUSR>>6)
1857 # define S_IWOTH (S_IWUSR>>6)
1858 # define S_IXOTH (S_IXUSR>>6)
1860 # define S_IROTH 0040
1861 # define S_IWOTH 0020
1862 # define S_IXOTH 0010
1867 # define S_ISUID 04000
1871 # define S_ISGID 02000
1875 # define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
1879 # define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
1883 # define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
1886 /* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
1887 * which would get included through <sys/file.h >, but that is 3000
1888 * lines in the future. --jhi */
1890 #if !defined(S_IREAD) && !defined(__HAIKU__)
1891 # define S_IREAD S_IRUSR
1894 #if !defined(S_IWRITE) && !defined(__HAIKU__)
1895 # define S_IWRITE S_IWUSR
1899 # define S_IEXEC S_IXUSR
1902 #if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
1903 # define SLOPPYDIVIDE
1910 /* This used to be conditionally defined based on whether we had a sprintf()
1911 * that correctly returns the string length (as required by C89), but we no
1912 * longer need that. XS modules can (and do) use this name, so it must remain
1913 * a part of the API that's visible to modules.
1915 =for apidoc_section $string
1916 =for apidoc ATmD|int|my_sprintf|NN char *buffer|NN const char *pat|...
1918 Do NOT use this due to the possibility of overflowing C<buffer>. Instead use
1923 #define my_sprintf sprintf
1926 * If we have v?snprintf() and the C99 variadic macros, we can just
1927 * use just the v?snprintf(). It is nice to try to trap the buffer
1928 * overflow, however, so if we are DEBUGGING, and we cannot use the
1929 * gcc statement expressions, then use the function wrappers which try
1930 * to trap the overflow. If we can use the gcc statement expressions,
1931 * we can try that even with the version that uses the C99 variadic
1935 /* Note that we do not check against snprintf()/vsnprintf() returning
1936 * negative values because that is non-standard behaviour and we use
1937 * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1938 * that should be true only if the snprintf()/vsnprintf() are true
1939 * to the standard. */
1941 #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
1944 # define my_snprintf Perl_my_snprintf
1945 # define PERL_MY_SNPRINTF_GUARDED
1946 #elif defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1947 # ifdef PERL_USE_GCC_BRACE_GROUPS
1948 # define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1949 # define PERL_MY_SNPRINTF_GUARDED
1951 # define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
1954 # define my_snprintf Perl_my_snprintf
1955 # define PERL_MY_SNPRINTF_GUARDED
1958 /* There is no quadmath_vsnprintf, and therefore my_vsnprintf()
1959 * dies if called under USE_QUADMATH. */
1960 #if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1961 # ifdef PERL_USE_GCC_BRACE_GROUPS
1962 # define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1963 # define PERL_MY_VSNPRINTF_GUARDED
1965 # define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
1968 # define my_vsnprintf Perl_my_vsnprintf
1969 # define PERL_MY_VSNPRINTF_GUARDED
1972 /* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1973 * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1974 * the result of my_snprintf() or my_vsnprintf(). (No, you should not
1975 * completely ignore it: otherwise you cannot know whether your output
1978 * int len = my_sprintf(buf, max, ...);
1979 * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1981 * The trick is that in certain platforms [a] the my_sprintf() already
1982 * contains the sanity check, while in certain platforms [b] it needs
1983 * to be done as a separate step. The POST_GUARD is that step-- in [a]
1984 * platforms the POST_GUARD actually does nothing since the check has
1985 * already been done. Watch out for the max being the same in both calls.
1987 * If you actually use the snprintf/vsnprintf return value already,
1988 * you assumedly are checking its validity somehow. But you can
1989 * insert the POST_GUARD() also in that case. */
1991 #ifndef PERL_MY_SNPRINTF_GUARDED
1992 # define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1994 # define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1997 #ifndef PERL_MY_VSNPRINTF_GUARDED
1998 # define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
2000 # define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
2004 # define my_strlcat strlcat
2007 #if defined(PERL_CORE) || defined(PERL_EXT)
2009 # define my_memrchr memrchr
2011 # define my_memrchr S_my_memrchr
2016 # define my_strlcpy strlcpy
2020 # define my_strnlen strnlen
2024 The IV type is supposed to be long enough to hold any integral
2026 --Andy Dougherty August 1996
2032 #if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
2033 # if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
2034 # define IV_MAX ((IV)INT64_MAX)
2035 # define IV_MIN ((IV)INT64_MIN)
2036 # define UV_MAX ((UV)UINT64_MAX)
2038 # define UINT64_MIN 0
2040 # define UV_MIN ((UV)UINT64_MIN)
2042 # define IV_MAX PERL_QUAD_MAX
2043 # define IV_MIN PERL_QUAD_MIN
2044 # define UV_MAX PERL_UQUAD_MAX
2045 # define UV_MIN PERL_UQUAD_MIN
2050 # if defined(INT32_MAX) && IVSIZE == 4
2051 # define IV_MAX ((IV)INT32_MAX)
2052 # define IV_MIN ((IV)INT32_MIN)
2053 # ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
2054 # define UV_MAX ((UV)UINT32_MAX)
2056 # define UV_MAX ((UV)4294967295U)
2059 # define UINT32_MIN 0
2061 # define UV_MIN ((UV)UINT32_MIN)
2063 # define IV_MAX PERL_LONG_MAX
2064 # define IV_MIN PERL_LONG_MIN
2065 # define UV_MAX PERL_ULONG_MAX
2066 # define UV_MIN PERL_ULONG_MIN
2077 #if !defined(PERL_CORE)
2078 /* We think that removing this decade-old undef this will cause too much
2079 breakage on CPAN for too little gain. (See RT #119753)
2080 However, we do need HAS_QUAD in the core for use by the drand48 code. */
2086 #define Size_t_MAX (~(Size_t)0)
2087 #define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
2089 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
2090 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
2092 #ifndef NO_PERL_PRESERVE_IVUV
2093 #define PERL_PRESERVE_IVUV /* We like our integers to stay integers. */
2097 * The macros INT2PTR and NUM2PTR are (despite their names)
2098 * bi-directional: they will convert int/float to or from pointers.
2099 * However the conversion to int/float are named explicitly:
2100 * PTR2IV, PTR2UV, PTR2NV.
2102 * For int conversions we do not need two casts if pointers are
2103 * the same size as IV and UV. Otherwise we need an explicit
2104 * cast (PTRV) to avoid compiler warnings.
2106 * These are mentioned in perlguts
2108 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
2110 # define INT2PTR(any,d) (any)(d)
2111 #elif PTRSIZE == LONGSIZE
2112 # define PTRV unsigned long
2113 # define PTR2ul(p) (unsigned long)(p)
2115 # define PTRV unsigned
2119 # define INT2PTR(any,d) (any)(PTRV)(d)
2123 # define PTR2ul(p) INT2PTR(unsigned long,p)
2127 =for apidoc_section Casting
2128 =for apidoc Cyh|type|NUM2PTR|type|int value
2129 You probably want to be using L<C</INT2PTR>> instead.
2134 #define NUM2PTR(any,d) (any)(PTRV)(d)
2135 #define PTR2IV(p) INT2PTR(IV,p)
2136 #define PTR2UV(p) INT2PTR(UV,p)
2137 #define PTR2NV(p) NUM2PTR(NV,p)
2138 #define PTR2nat(p) (PTRV)(p) /* pointer to integer of PTRSIZE */
2140 /* According to strict ANSI C89 one cannot freely cast between
2141 * data pointers and function (code) pointers. There are at least
2142 * two ways around this. One (used below) is to do two casts,
2143 * first the other pointer to an (unsigned) integer, and then
2144 * the integer to the other pointer. The other way would be
2145 * to use unions to "overlay" the pointers. For an example of
2146 * the latter technique, see union dirpu in struct xpvio in sv.h.
2147 * The only feasible use is probably temporarily storing
2148 * function pointers in a data pointer (such as a void pointer). */
2150 #define DPTR2FPTR(t,p) ((t)PTR2nat(p)) /* data pointer to function pointer */
2151 #define FPTR2DPTR(t,p) ((t)PTR2nat(p)) /* function pointer to data pointer */
2153 #ifdef USE_LONG_DOUBLE
2154 # if LONG_DOUBLESIZE == DOUBLESIZE
2155 # define LONG_DOUBLE_EQUALS_DOUBLE
2156 # undef USE_LONG_DOUBLE /* Ouch! */
2160 /* The following is all to get LDBL_DIG, in order to pick a nice
2161 default value for printing floating point numbers in Gconvert.
2164 #ifndef HAS_LDBL_DIG
2165 # if LONG_DOUBLESIZE == 10
2166 # define LDBL_DIG 18 /* assume IEEE */
2167 # elif LONG_DOUBLESIZE == 12
2168 # define LDBL_DIG 18 /* gcc? */
2169 # elif LONG_DOUBLESIZE == 16
2170 # define LDBL_DIG 33 /* assume IEEE */
2171 # elif LONG_DOUBLESIZE == DOUBLESIZE
2172 # define LDBL_DIG DBL_DIG /* bummer */
2179 # include <ieeefp.h>
2182 #if defined(__DECC) && defined(__osf__)
2183 /* Also Tru64 cc has broken NaN comparisons. */
2184 # define NAN_COMPARE_BROKEN
2187 # define NAN_COMPARE_BROKEN
2190 #ifdef USE_LONG_DOUBLE
2192 # include <sunmath.h>
2194 # if defined(LDBL_DIG)
2195 # define NV_DIG LDBL_DIG
2196 # ifdef LDBL_MANT_DIG
2197 # define NV_MANT_DIG LDBL_MANT_DIG
2200 # define NV_MIN LDBL_MIN
2203 # define NV_MAX LDBL_MAX
2205 # ifdef LDBL_MIN_EXP
2206 # define NV_MIN_EXP LDBL_MIN_EXP
2208 # ifdef LDBL_MAX_EXP
2209 # define NV_MAX_EXP LDBL_MAX_EXP
2211 # ifdef LDBL_MIN_10_EXP
2212 # define NV_MIN_10_EXP LDBL_MIN_10_EXP
2214 # ifdef LDBL_MAX_10_EXP
2215 # define NV_MAX_10_EXP LDBL_MAX_10_EXP
2217 # ifdef LDBL_EPSILON
2218 # define NV_EPSILON LDBL_EPSILON
2221 # define NV_MAX LDBL_MAX
2222 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
2223 # elif defined(HUGE_VALL)
2224 # define NV_MAX HUGE_VALL
2227 # if defined(HAS_SQRTL)
2228 # define Perl_acos acosl
2229 # define Perl_asin asinl
2230 # define Perl_atan atanl
2231 # define Perl_atan2 atan2l
2232 # define Perl_ceil ceill
2233 # define Perl_cos cosl
2234 # define Perl_cosh coshl
2235 # define Perl_exp expl
2236 /* no Perl_fabs, but there's PERL_ABS */
2237 # define Perl_floor floorl
2238 # define Perl_fmod fmodl
2239 # define Perl_log logl
2240 # define Perl_log10 log10l
2241 # define Perl_pow powl
2242 # define Perl_sin sinl
2243 # define Perl_sinh sinhl
2244 # define Perl_sqrt sqrtl
2245 # define Perl_tan tanl
2246 # define Perl_tanh tanhl
2248 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
2251 # define Perl_modf(x,y) modfl(x,y)
2252 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
2253 prototype in <math.h> */
2254 # ifndef HAS_MODFL_PROTO
2255 EXTERN_C long double modfl(long double, long double *);
2257 # elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
2258 extern long double Perl_my_modfl(long double x, long double *ip);
2259 # define Perl_modf(x,y) Perl_my_modfl(x,y)
2264 # define Perl_frexp(x,y) frexpl(x,y)
2265 # elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
2266 extern long double Perl_my_frexpl(long double x, int *e);
2267 # define Perl_frexp(x,y) Perl_my_frexpl(x,y)
2272 # define Perl_ldexp(x, y) ldexpl(x,y)
2273 # elif defined(HAS_SCALBNL) && FLT_RADIX == 2
2274 # define Perl_ldexp(x,y) scalbnl(x,y)
2278 # if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
2279 # define Perl_isnan(x) isnanl(x)
2280 # elif defined(__sgi) && defined(__c99) /* XXX Configure test needed */
2281 # define Perl_isnan(x) isnan(x)
2285 # if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
2286 # define Perl_isinf(x) isinfl(x)
2287 # elif defined(__sgi) && defined(__c99) /* XXX Configure test needed */
2288 # define Perl_isinf(x) isinf(x)
2289 # elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2290 # define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
2293 # ifndef Perl_isfinite
2294 # define Perl_isfinite(x) Perl_isfinitel(x)
2296 #elif defined(USE_QUADMATH) && defined(I_QUADMATH)
2297 # include <quadmath.h>
2298 # define NV_DIG FLT128_DIG
2299 # define NV_MANT_DIG FLT128_MANT_DIG
2300 # define NV_MIN FLT128_MIN
2301 # define NV_MAX FLT128_MAX
2302 # define NV_MIN_EXP FLT128_MIN_EXP
2303 # define NV_MAX_EXP FLT128_MAX_EXP
2304 # define NV_EPSILON FLT128_EPSILON
2305 # define NV_MIN_10_EXP FLT128_MIN_10_EXP
2306 # define NV_MAX_10_EXP FLT128_MAX_10_EXP
2307 # define Perl_acos acosq
2308 # define Perl_asin asinq
2309 # define Perl_atan atanq
2310 # define Perl_atan2 atan2q
2311 # define Perl_ceil ceilq
2312 # define Perl_cos cosq
2313 # define Perl_cosh coshq
2314 # define Perl_exp expq
2315 /* no Perl_fabs, but there's PERL_ABS */
2316 # define Perl_floor floorq
2317 # define Perl_fmod fmodq
2318 # define Perl_log logq
2319 # define Perl_log10 log10q
2320 # define Perl_signbit signbitq
2321 # define Perl_pow powq
2322 # define Perl_sin sinq
2323 # define Perl_sinh sinhq
2324 # define Perl_sqrt sqrtq
2325 # define Perl_tan tanq
2326 # define Perl_tanh tanhq
2327 # define Perl_modf(x,y) modfq(x,y)
2328 # define Perl_frexp(x,y) frexpq(x,y)
2329 # define Perl_ldexp(x, y) ldexpq(x,y)
2330 # define Perl_isinf(x) isinfq(x)
2331 # define Perl_isnan(x) isnanq(x)
2332 # define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
2333 # define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
2334 # define Perl_fp_class_inf(x) (Perl_fp_class(x) == 3)
2335 # define Perl_fp_class_nan(x) (Perl_fp_class(x) == 4)
2336 # define Perl_fp_class_norm(x) (Perl_fp_class(x) == 1)
2337 # define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
2338 # define Perl_fp_class_zero(x) (Perl_fp_class(x) == 0)
2340 # define NV_DIG DBL_DIG
2341 # define NV_MANT_DIG DBL_MANT_DIG
2342 # define NV_MIN DBL_MIN
2343 # define NV_MAX DBL_MAX
2344 # define NV_MIN_EXP DBL_MIN_EXP
2345 # define NV_MAX_EXP DBL_MAX_EXP
2346 # define NV_MIN_10_EXP DBL_MIN_10_EXP
2347 # define NV_MAX_10_EXP DBL_MAX_10_EXP
2348 # define NV_EPSILON DBL_EPSILON
2349 # define NV_MAX DBL_MAX
2350 # define NV_MIN DBL_MIN
2352 /* These math interfaces are C89. */
2353 # define Perl_acos acos
2354 # define Perl_asin asin
2355 # define Perl_atan atan
2356 # define Perl_atan2 atan2
2357 # define Perl_ceil ceil
2358 # define Perl_cos cos
2359 # define Perl_cosh cosh
2360 # define Perl_exp exp
2361 /* no Perl_fabs, but there's PERL_ABS */
2362 # define Perl_floor floor
2363 # define Perl_fmod fmod
2364 # define Perl_log log
2365 # define Perl_log10 log10
2366 # define Perl_pow pow
2367 # define Perl_sin sin
2368 # define Perl_sinh sinh
2369 # define Perl_sqrt sqrt
2370 # define Perl_tan tan
2371 # define Perl_tanh tanh
2373 # define Perl_modf(x,y) modf(x,y)
2374 # define Perl_frexp(x,y) frexp(x,y)
2375 # define Perl_ldexp(x,y) ldexp(x,y)
2379 # define Perl_isnan(x) isnan(x)
2383 # if defined(HAS_ISINF)
2384 # define Perl_isinf(x) isinf(x)
2385 # elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2386 # define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
2389 # ifndef Perl_isfinite
2390 # ifdef HAS_ISFINITE
2391 # define Perl_isfinite(x) isfinite(x)
2392 # elif defined(HAS_FINITE)
2393 # define Perl_isfinite(x) finite(x)
2398 /* fpclassify(): C99. It is supposed to be a macro that switches on
2399 * the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
2400 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2402 # if defined(FP_INFINITE) && defined(FP_NAN)
2403 # define Perl_fp_class(x) fpclassify(x)
2404 # define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_INFINITE)
2405 # define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_NAN)
2406 # define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_NORMAL)
2407 # define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2408 # define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_ZERO)
2409 # elif defined(FP_PLUS_INF) && defined(FP_QNAN)
2410 /* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
2411 * actually not the C99 fpclassify, with its own set of return defines. */
2412 # define Perl_fp_class(x) fpclassify(x)
2413 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
2414 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
2415 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2416 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2417 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
2418 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
2419 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
2420 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
2421 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
2422 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
2424 # undef Perl_fp_class /* Unknown set of defines */
2428 /* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
2429 * are identical to the C99 fpclassify(). */
2430 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
2433 /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
2435 /* oh, and the isnormal macro has a typo in it! */
2437 # define isnormal(x) Perl_fp_class_norm(x)
2439 # if defined(FP_INFINITE) && defined(FP_NAN)
2440 # define Perl_fp_class(x) fp_classify(x)
2441 # define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_INFINITE)
2442 # define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_NAN)
2443 # define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_NORMAL)
2444 # define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2445 # define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_ZERO)
2447 # undef Perl_fp_class /* Unknown set of defines */
2451 /* Feel free to check with me for the SGI manpages, SGI testing,
2452 * etcetera, if you want to try getting this to work with IRIX.
2454 * - Allen <allens@cpan.org> */
2456 /* fpclass(): SysV, at least Solaris and some versions of IRIX. */
2457 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
2458 /* Solaris and IRIX have fpclass/fpclassl, but they are using
2459 * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2460 * Define some symbols also as cpp symbols so we can detect them. */
2461 # if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
2462 # define FP_PINF FP_PINF
2463 # define FP_QNAN FP_QNAN
2467 # include <ieeefp.h>
2472 # if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
2473 # define Perl_fp_class(x) fpclassl(x)
2475 # define Perl_fp_class(x) fpclass(x)
2477 # if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
2478 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_CLASS_SNAN)
2479 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_CLASS_QNAN)
2480 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_CLASS_NINF)
2481 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_CLASS_PINF)
2482 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_CLASS_NNORM)
2483 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_CLASS_PNORM)
2484 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_CLASS_NDENORM)
2485 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_CLASS_PDENORM)
2486 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_CLASS_NZERO)
2487 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_CLASS_PZERO)
2488 # elif defined(FP_PINF) && defined(FP_QNAN)
2489 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2490 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2491 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_NINF)
2492 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PINF)
2493 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_NNORM)
2494 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PNORM)
2495 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_NDENORM)
2496 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PDENORM)
2497 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_NZERO)
2498 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PZERO)
2500 # undef Perl_fp_class /* Unknown set of defines */
2504 /* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2505 #if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
2507 # if !defined(FP_SNAN) && defined(I_FP_CLASS)
2508 # include <fp_class.h>
2510 # if defined(FP_POS_INF) && defined(FP_QNAN)
2511 # ifdef __sgi /* XXX Configure test instead */
2512 # ifdef USE_LONG_DOUBLE
2513 # define Perl_fp_class(x) fp_class_l(x)
2515 # define Perl_fp_class(x) fp_class_d(x)
2518 # if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2519 # define Perl_fp_class(x) fp_classl(x)
2521 # define Perl_fp_class(x) fp_class(x)
2524 # if defined(FP_POS_INF) && defined(FP_QNAN)
2525 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2526 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2527 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_NEG_INF)
2528 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_POS_INF)
2529 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_NEG_NORM)
2530 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_POS_NORM)
2531 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_NEG_DENORM)
2532 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_POS_DENORM)
2533 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_NEG_ZERO)
2534 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_POS_ZERO)
2536 # undef Perl_fp_class /* Unknown set of defines */
2541 /* class(), _class(): Legacy: AIX. */
2542 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2544 # if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2546 # define Perl_fp_class(x) class(x)
2548 # define Perl_fp_class(x) _class(x)
2550 # if defined(FP_PLUS_INF) && defined(FP_NANQ)
2551 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_NANS)
2552 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_NANQ)
2553 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
2554 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
2555 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
2556 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
2557 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
2558 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
2559 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
2560 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
2562 # undef Perl_fp_class /* Unknown set of defines */
2567 /* Win32: _fpclass(), _isnan(), _finite(). */
2570 # define Perl_isnan(x) _isnan(x)
2572 # ifndef Perl_isfinite
2573 # define Perl_isfinite(x) _finite(x)
2575 # ifndef Perl_fp_class_snan
2576 /* No simple way to #define Perl_fp_class because _fpclass()
2577 * returns a set of bits. */
2578 # define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2579 # define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
2580 # define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
2581 # define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF)
2582 # define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF)
2583 # define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2584 # define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2585 # define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2586 # define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2587 # define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2588 # define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2589 # define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2590 # define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2591 # define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2592 # define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2596 #if !defined(Perl_fp_class_inf) && \
2597 defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2598 # define Perl_fp_class_inf(x) \
2599 (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2602 #if !defined(Perl_fp_class_nan) && \
2603 defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2604 # define Perl_fp_class_nan(x) \
2605 (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2608 #if !defined(Perl_fp_class_zero) && \
2609 defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2610 # define Perl_fp_class_zero(x) \
2611 (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2614 #if !defined(Perl_fp_class_norm) && \
2615 defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2616 # define Perl_fp_class_norm(x) \
2617 (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2620 #if !defined(Perl_fp_class_denorm) && \
2621 defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2622 # define Perl_fp_class_denorm(x) \
2623 (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
2627 # ifdef Perl_fp_class_nan
2628 # define Perl_isnan(x) Perl_fp_class_nan(x)
2629 # elif defined(HAS_UNORDERED)
2630 # define Perl_isnan(x) unordered((x), 0.0)
2632 # define Perl_isnan(x) ((x)!=(x))
2637 # ifdef Perl_fp_class_inf
2638 # define Perl_isinf(x) Perl_fp_class_inf(x)
2642 #ifndef Perl_isfinite
2643 # if defined(HAS_ISFINITE) && !defined(isfinite)
2644 # define Perl_isfinite(x) isfinite((double)(x))
2645 # elif defined(HAS_FINITE)
2646 # define Perl_isfinite(x) finite((double)(x))
2647 # elif defined(Perl_fp_class_finite)
2648 # define Perl_isfinite(x) Perl_fp_class_finite(x)
2650 /* For the infinities the multiplication returns nan,
2651 * for the nan the multiplication also returns nan,
2652 * for everything else (that is, finite) zero should be returned. */
2653 # define Perl_isfinite(x) (((x) * 0) == 0)
2658 # if defined(Perl_isfinite) && defined(Perl_isnan)
2659 # define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2663 /* We need Perl_isfinitel (ends with ell) (if available) even when
2664 * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2666 #if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2667 /* If isfinite() is a macro and looks like we have C99,
2668 * we assume it's the type-aware C99 isfinite(). */
2669 # if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
2670 # define Perl_isfinitel(x) isfinite(x)
2671 # elif defined(HAS_ISFINITEL)
2672 # define Perl_isfinitel(x) isfinitel(x)
2673 # elif defined(HAS_FINITEL)
2674 # define Perl_isfinitel(x) finitel(x)
2675 # elif defined(HAS_INFL) && defined(HAS_NANL)
2676 # define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
2678 # define Perl_isfinitel(x) ((x) * 0 == 0) /* See Perl_isfinite. */
2682 /* The default is to use Perl's own atof() implementation (in numeric.c).
2683 * Usually that is the one to use but for some platforms (e.g. UNICOS)
2684 * it is however best to use the native implementation of atof.
2685 * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2686 * Some good tests to try out with either setting are t/base/num.t,
2687 * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2688 * you may need to be using a different function than atof! */
2690 #ifndef USE_PERL_ATOF
2692 # define USE_PERL_ATOF
2695 # if USE_PERL_ATOF == 0
2696 # undef USE_PERL_ATOF
2700 #ifdef USE_PERL_ATOF
2701 # define Perl_atof(s) Perl_my_atof(s)
2702 # define Perl_atof2(s, n) Perl_my_atof3(aTHX_ (s), &(n), 0)
2704 # define Perl_atof(s) (NV)atof(s)
2705 # define Perl_atof2(s, n) ((n) = atof(s))
2707 #define my_atof2(a,b) my_atof3(a,b,0)
2710 =for apidoc_section $numeric
2711 =for apidoc AmT|NV|Perl_acos|NV x
2712 =for apidoc_item |NV|Perl_asin|NV x
2713 =for apidoc_item |NV|Perl_atan|NV x
2714 =for apidoc_item |NV|Perl_atan2|NV x|NV y
2715 =for apidoc_item |NV|Perl_ceil|NV x
2716 =for apidoc_item |NV|Perl_cos|NV x
2717 =for apidoc_item |NV|Perl_cosh|NV x
2718 =for apidoc_item |NV|Perl_exp|NV x
2719 =for apidoc_item |NV|Perl_floor|NV x
2720 =for apidoc_item |NV|Perl_fmod|NV x|NV y
2721 =for apidoc_item |NV|Perl_frexp|NV x|int *exp
2722 =for apidoc_item |IV|Perl_isfinite|NV x
2723 =for apidoc_item |IV|Perl_isinf|NV x
2724 =for apidoc_item |IV|Perl_isnan|NV x
2725 =for apidoc_item |NV|Perl_ldexp|NV x|int exp
2726 =for apidoc_item |NV|Perl_log|NV x
2727 =for apidoc_item |NV|Perl_log10|NV x
2728 =for apidoc_item |NV|Perl_modf|NV x|NV *iptr
2729 =for apidoc_item |NV|Perl_pow|NV x|NV y
2730 =for apidoc_item |NV|Perl_sin|NV x
2731 =for apidoc_item |NV|Perl_sinh|NV x
2732 =for apidoc_item |NV|Perl_sqrt|NV x
2733 =for apidoc_item |NV|Perl_tan|NV x
2734 =for apidoc_item |NV|Perl_tanh|NV x
2736 These perform the corresponding mathematical operation on the operand(s), using
2737 the libc function designed for the task that has just enough precision for an
2738 NV on this platform. If no such function with sufficient precision exists,
2739 the highest precision one available is used.
2745 * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2746 * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2747 * depending on local options. Until Configure detects this (or at least
2748 * detects whether the "signed" keyword is available) the CHAR ranges
2749 * will not be included. UCHAR functions normally.
2753 #define PERL_UCHAR_MIN ((unsigned char)0)
2754 #define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2756 #define PERL_USHORT_MIN ((unsigned short)0)
2757 #define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2759 #define PERL_SHORT_MAX ((short)SHRT_MAX)
2760 #define PERL_SHORT_MIN ((short)SHRT_MIN)
2762 #define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2763 #define PERL_UINT_MIN ((unsigned int)0)
2765 #define PERL_INT_MAX ((int)INT_MAX)
2766 #define PERL_INT_MIN ((int)INT_MIN)
2768 #define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2769 #define PERL_ULONG_MIN ((unsigned long)0L)
2771 #define PERL_LONG_MAX ((long)LONG_MAX)
2772 #define PERL_LONG_MIN ((long)LONG_MIN)
2775 # define PERL_UQUAD_MAX (~(UV)0)
2776 # define PERL_UQUAD_MIN ((UV)0)
2777 # define PERL_QUAD_MAX ((IV) (PERL_UQUAD_MAX >> 1))
2778 # define PERL_QUAD_MIN (-PERL_QUAD_MAX - ((3 & -1) == 3))
2782 =for apidoc_section $integer
2784 =for apidoc AmnU||PERL_INT_MAX
2785 =for apidoc_item ||PERL_INT_MIN
2786 =for apidoc_item ||PERL_LONG_MAX
2787 =for apidoc_item ||PERL_LONG_MIN
2788 =for apidoc_item ||PERL_SHORT_MAX
2789 =for apidoc_item ||PERL_SHORT_MIN
2790 =for apidoc_item ||PERL_UCHAR_MAX
2791 =for apidoc_item ||PERL_UCHAR_MIN
2792 =for apidoc_item ||PERL_UINT_MAX
2793 =for apidoc_item ||PERL_UINT_MIN
2794 =for apidoc_item ||PERL_ULONG_MAX
2795 =for apidoc_item ||PERL_ULONG_MIN
2796 =for apidoc_item ||PERL_USHORT_MAX
2797 =for apidoc_item ||PERL_USHORT_MIN
2798 =for apidoc_item ||PERL_QUAD_MAX
2799 =for apidoc_item ||PERL_QUAD_MIN
2800 =for apidoc_item ||PERL_UQUAD_MAX
2801 =for apidoc_item ||PERL_UQUAD_MIN
2803 These give the largest and smallest number representable in the current
2804 platform in variables of the corresponding types.
2806 For signed types, the smallest representable number is the most negative
2807 number, the one furthest away from zero.
2809 For C99 and later compilers, these correspond to things like C<INT_MAX>, which
2810 are available to the C code. But these constants, furnished by Perl,
2811 allow code compiled on earlier compilers to portably have access to the same
2818 typedef MEM_SIZE STRLEN;
2820 typedef struct op OP;
2821 typedef struct cop COP;
2822 typedef struct unop UNOP;
2823 typedef struct unop_aux UNOP_AUX;
2824 typedef struct binop BINOP;
2825 typedef struct listop LISTOP;
2826 typedef struct logop LOGOP;
2827 typedef struct pmop PMOP;
2828 typedef struct svop SVOP;
2829 typedef struct padop PADOP;
2830 typedef struct pvop PVOP;
2831 typedef struct loop LOOP;
2832 typedef struct methop METHOP;
2835 typedef struct opslab OPSLAB;
2836 typedef struct opslot OPSLOT;
2839 typedef struct block_hooks BHK;
2840 typedef struct custom_op XOP;
2842 typedef struct interpreter PerlInterpreter;
2844 /* SGI's <sys/sema.h> has struct sv */
2846 # define STRUCT_SV perl_sv
2848 # define STRUCT_SV sv
2850 typedef struct STRUCT_SV SV;
2851 typedef struct av AV;
2852 typedef struct hv HV;
2853 typedef struct cv CV;
2854 typedef struct p5rx REGEXP;
2855 typedef struct gp GP;
2856 typedef struct gv GV;
2857 typedef struct io IO;
2858 typedef struct context PERL_CONTEXT;
2859 typedef struct block BLOCK;
2860 typedef struct invlist INVLIST;
2862 typedef struct magic MAGIC;
2863 typedef struct xpv XPV;
2864 typedef struct xpviv XPVIV;
2865 typedef struct xpvuv XPVUV;
2866 typedef struct xpvnv XPVNV;
2867 typedef struct xpvmg XPVMG;
2868 typedef struct xpvlv XPVLV;
2869 typedef struct xpvinvlist XINVLIST;
2870 typedef struct xpvav XPVAV;
2871 typedef struct xpvhv XPVHV;
2872 typedef struct xpvgv XPVGV;
2873 typedef struct xpvcv XPVCV;
2874 typedef struct xpvbm XPVBM;
2875 typedef struct xpvfm XPVFM;
2876 typedef struct xpvio XPVIO;
2877 typedef struct mgvtbl MGVTBL;
2878 typedef union any ANY;
2879 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2880 typedef struct ptr_tbl PTR_TBL_t;
2881 typedef struct clone_params CLONE_PARAMS;
2883 /* a pad is currently just an AV; but that might change,
2884 * so hide the type. */
2885 typedef struct padlist PADLIST;
2887 typedef struct padnamelist PADNAMELIST;
2888 typedef struct padname PADNAME;
2890 /* always enable PERL_OP_PARENT */
2891 #if !defined(PERL_OP_PARENT)
2892 # define PERL_OP_PARENT
2895 /* enable PERL_COPY_ON_WRITE by default */
2896 #if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2897 # define PERL_COPY_ON_WRITE
2900 #ifdef PERL_COPY_ON_WRITE
2901 # define PERL_ANY_COW
2903 # define PERL_SAWAMPERSAND
2906 #if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2907 # error PERL_DEBUG_READONLY_OPS only works with ithreads
2911 #include "charclass_invlists.h"
2913 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2914 # if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2915 # define USE_64_BIT_RAWIO /* implicit */
2919 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2920 * fseeko/ftello if possible. Don't go #defining ftell to ftello yourself,
2921 * however, because operating systems like to do that themself. */
2924 # define FSEEKSIZE LSEEKSIZE
2926 # define FSEEKSIZE LONGSIZE
2930 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2931 # if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2932 # define USE_64_BIT_STDIO /* implicit */
2936 #ifdef USE_64_BIT_RAWIO
2939 # define Off_t off64_t
2941 # define LSEEKSIZE 8
2943 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2944 * will trigger defines like the ones below. Some 64-bit environments,
2945 * however, do not. Therefore we have to explicitly mix and match. */
2946 # if defined(USE_OPEN64)
2947 # define open open64
2949 # if defined(USE_LSEEK64)
2950 # define lseek lseek64
2952 # if defined(USE_LLSEEK)
2953 # define lseek llseek
2956 # if defined(USE_STAT64)
2957 # define stat stat64
2959 # if defined(USE_FSTAT64)
2960 # define fstat fstat64
2962 # if defined(USE_LSTAT64)
2963 # define lstat lstat64
2965 # if defined(USE_FLOCK64)
2966 # define flock flock64
2968 # if defined(USE_LOCKF64)
2969 # define lockf lockf64
2971 # if defined(USE_FCNTL64)
2972 # define fcntl fcntl64
2974 # if defined(USE_TRUNCATE64)
2975 # define truncate truncate64
2977 # if defined(USE_FTRUNCATE64)
2978 # define ftruncate ftruncate64
2982 #ifdef USE_64_BIT_STDIO
2983 # ifdef HAS_FPOS64_T
2985 # define Fpos_t fpos64_t
2987 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2988 * will trigger defines like the ones below. Some 64-bit environments,
2989 * however, do not. */
2990 # if defined(USE_FOPEN64)
2991 # define fopen fopen64
2993 # if defined(USE_FSEEK64)
2994 # define fseek fseek64 /* don't do fseeko here, see perlio.c */
2996 # if defined(USE_FTELL64)
2997 # define ftell ftell64 /* don't do ftello here, see perlio.c */
2999 # if defined(USE_FSETPOS64)
3000 # define fsetpos fsetpos64
3002 # if defined(USE_FGETPOS64)
3003 # define fgetpos fgetpos64
3005 # if defined(USE_TMPFILE64)
3006 # define tmpfile tmpfile64
3008 # if defined(USE_FREOPEN64)
3009 # define freopen freopen64
3014 # include "iperlsys.h"
3019 # include "os2ish.h"
3021 # include "dosish.h"
3024 # include "vmsish.h"
3025 #elif defined(PLAN9)
3026 # include "./plan9/plan9ish.h"
3027 #elif defined(__VOS__)
3029 # include "./vos/vosish.h"
3031 # include "vos/vosish.h"
3033 #elif defined(__HAIKU__)
3034 # include "haiku/haikuish.h"
3036 # include "unixish.h"
3040 # include "amigaos.h"
3041 # undef FD_CLOEXEC /* a lie in AmigaOS */
3044 /* NSIG logic from Configure --> */
3047 # define NSIG (_NSIG)
3048 # elif defined(SIGMAX)
3049 # define NSIG (SIGMAX+1)
3050 # elif defined(SIG_MAX)
3051 # define NSIG (SIG_MAX+1)
3052 # elif defined(_SIG_MAX)
3053 # define NSIG (_SIG_MAX+1)
3054 # elif defined(MAXSIG)
3055 # define NSIG (MAXSIG+1)
3056 # elif defined(MAX_SIG)
3057 # define NSIG (MAX_SIG+1)
3058 # elif defined(SIGARRAYSIZE)
3059 # define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
3060 # elif defined(_sys_nsig)
3061 # define NSIG (_sys_nsig) /* Solaris 2.5 */
3063 /* Default to some arbitrary number that's big enough to get most
3064 * of the common signals. */
3068 /* <-- NSIG logic from Configure */
3070 #ifndef NO_ENVIRON_ARRAY
3071 # define USE_ENVIRON_ARRAY
3075 /* On some platforms it would be safe to use a read/write mutex with many
3076 * readers possible at the same time. On other platforms, notably IBM ones,
3077 * subsequent getenv calls destroy earlier ones. Those platforms would not
3078 * be able to handle simultaneous getenv calls */
3079 # define ENV_LOCK MUTEX_LOCK(&PL_env_mutex)
3080 # define ENV_UNLOCK MUTEX_UNLOCK(&PL_env_mutex)
3081 # define ENV_INIT MUTEX_INIT(&PL_env_mutex);
3082 # define ENV_TERM MUTEX_DESTROY(&PL_env_mutex);
3084 # define ENV_LOCK NOOP;
3085 # define ENV_UNLOCK NOOP;
3086 # define ENV_INIT NOOP;
3087 # define ENV_TERM NOOP;
3090 /* Some critical sections need to lock both the locale and the environment.
3091 * XXX khw intends to change this to lock both mutexes, but that brings up
3092 * issues of potential deadlock, so should be done at the beginning of a
3093 * development cycle. So for now, it just locks the environment. Note that
3094 * many modern platforms are locale-thread-safe anyway, so locking the locale
3095 * mutex is a no-op anyway */
3096 #define ENV_LOCALE_LOCK ENV_LOCK
3097 #define ENV_LOCALE_UNLOCK ENV_UNLOCK
3099 /* And some critical sections care only that no one else is writing either the
3100 * locale nor the environment. XXX Again this is for the future. This can be
3101 * simulated with using COND_WAIT in thread.h */
3102 #define ENV_LOCALE_READ_LOCK ENV_LOCALE_LOCK
3103 #define ENV_LOCALE_READ_UNLOCK ENV_LOCALE_UNLOCK
3105 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3106 /* having sigaction(2) means that the OS supports both 1-arg and 3-arg
3107 * signal handlers. But the perl core itself only fully supports 1-arg
3108 * handlers, so don't enable for now.
3109 * NB: POSIX::sigaction() supports both.
3111 * # define PERL_USE_3ARG_SIGHANDLER
3116 * This is an alias for the OS's siginfo_t, except that where the OS
3117 * doesn't support it, declare a dummy version instead. This allows us to
3118 * have signal handler functions which always have a Siginfo_t parameter
3119 * regardless of platform, (and which will just be passed a NULL value
3120 * where the OS doesn't support HAS_SIGACTION).
3123 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3124 typedef siginfo_t Siginfo_t;
3126 #ifdef si_signo /* minix */
3136 * initialise to avoid floating-point exceptions from overflow, etc
3138 #ifndef PERL_FPU_INIT
3139 # ifdef HAS_FPSETMASK
3140 # if HAS_FLOATINGPOINT_H
3141 # include <floatingpoint.h>
3143 /* Some operating systems have this as a macro, which in turn expands to a comma
3144 expression, and the last sub-expression is something that gets calculated,
3145 and then they have the gall to warn that a value computed is not used. Hence
3147 # define PERL_FPU_INIT (void)fpsetmask(0)
3148 # elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
3149 # define PERL_FPU_INIT PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
3150 # define PERL_FPU_PRE_EXEC { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
3151 # define PERL_FPU_POST_EXEC rsignal_restore(SIGFPE, &xfpe); }
3153 # define PERL_FPU_INIT
3156 #ifndef PERL_FPU_PRE_EXEC
3157 # define PERL_FPU_PRE_EXEC {
3158 # define PERL_FPU_POST_EXEC }
3161 /* In Tru64 the cc -ieee enables the IEEE math but disables traps.
3162 * We need to reenable the "invalid" trap because otherwise generation
3163 * of NaN values leaves the IEEE fp flags in bad state, leaving any further
3164 * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
3166 # include <machine/fpu.h>
3167 # define PERL_SYS_FPU_INIT \
3169 ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
3170 signal(SIGFPE, SIG_IGN); \
3173 /* In IRIX the default for Flush to Zero bit is true,
3174 * which means that results going below the minimum of normal
3175 * floating points go to zero, instead of going denormal/subnormal.
3176 * This is unlike almost any other system running Perl, so let's clear it.
3177 * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
3178 * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
3180 * XXX The flush-to-zero behaviour should be a Configure scan.
3181 * To change the behaviour usually requires some system-specific
3182 * incantation, though, like the below. */
3184 # include <sys/fpu.h>
3185 # define PERL_SYS_FPU_INIT \
3187 union fpc_csr csr; \
3188 csr.fc_word = get_fpc_csr(); \
3189 csr.fc_struct.flush = 0; \
3190 set_fpc_csr(csr.fc_word); \
3194 #ifndef PERL_SYS_FPU_INIT
3195 # define PERL_SYS_FPU_INIT NOOP
3198 #ifndef PERL_SYS_INIT3_BODY
3199 # define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
3203 =for apidoc_section $embedding
3205 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
3206 Provides system-specific tune up of the C runtime environment necessary to
3207 run Perl interpreters. This should be called only once, before creating
3208 any Perl interpreters.
3210 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
3211 Provides system-specific tune up of the C runtime environment necessary to
3212 run Perl interpreters. This should be called only once, before creating
3213 any Perl interpreters.
3215 =for apidoc Am|void|PERL_SYS_TERM|
3216 Provides system-specific clean up of the C runtime environment after
3217 running Perl interpreters. This should be called only once, after
3218 freeing any remaining Perl interpreters.
3223 #define PERL_SYS_INIT(argc, argv) Perl_sys_init(argc, argv)
3224 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
3225 #define PERL_SYS_TERM() Perl_sys_term()
3227 #ifndef PERL_WRITE_MSG_TO_CONSOLE
3228 # define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
3233 # ifdef _POSIX_PATH_MAX
3234 # if PATH_MAX > _POSIX_PATH_MAX
3235 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
3236 * included the null byte or not. Later amendments of POSIX,
3237 * XPG4, the Austin Group, and the Single UNIX Specification
3238 * all explicitly include the null byte in the PATH_MAX.
3239 * Ditto for _POSIX_PATH_MAX. */
3240 # define MAXPATHLEN PATH_MAX
3242 # define MAXPATHLEN _POSIX_PATH_MAX
3245 # define MAXPATHLEN (PATH_MAX+1)
3248 # define MAXPATHLEN 1024 /* Err on the large side. */
3252 /* clang Thread Safety Analysis/Annotations/Attributes
3253 * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
3255 * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
3256 * Apple XCode hijacks __clang_major__ and __clang_minor__
3257 * (6.1 means really clang 3.6), so needs extra hijinks
3258 * (could probably also test the contents of __apple_build_version__).
3260 #if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
3261 defined(__clang__) && \
3263 ((!defined(__apple_build_version__) && \
3264 ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
3265 (__clang_major__ >= 4))) || \
3266 (defined(__apple_build_version__) && \
3267 ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
3268 (__clang_major__ >= 7))))
3269 # define PERL_TSA__(x) __attribute__((x))
3270 # define PERL_TSA_ACTIVE
3272 # define PERL_TSA__(x) /* No TSA, make TSA attributes no-ops. */
3273 # undef PERL_TSA_ACTIVE
3276 /* PERL_TSA_CAPABILITY() is used to annotate typedefs.
3277 * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
3279 #define PERL_TSA_CAPABILITY(x) \
3280 PERL_TSA__(capability(x))
3282 /* In the below examples the mutex must be lexically visible, usually
3283 * either as global variables, or as function arguments. */
3285 /* PERL_TSA_GUARDED_BY() is used to annotate global variables.
3287 * Foo foo PERL_TSA_GUARDED_BY(mutex);
3289 #define PERL_TSA_GUARDED_BY(x) \
3290 PERL_TSA__(guarded_by(x))
3292 /* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
3293 * The data _behind_ the pointer is guarded.
3295 * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
3297 #define PERL_TSA_PT_GUARDED_BY(x) \
3298 PERL_TSA__(pt_guarded_by(x))
3300 /* PERL_TSA_REQUIRES() is used to annotate functions.
3301 * The caller MUST hold the resource when calling the function.
3303 * void Foo() PERL_TSA_REQUIRES(mutex);
3305 #define PERL_TSA_REQUIRES(x) \
3306 PERL_TSA__(requires_capability(x))
3308 /* PERL_TSA_EXCLUDES() is used to annotate functions.
3309 * The caller MUST NOT hold resource when calling the function.
3311 * EXCLUDES should be used when the function first acquires
3312 * the resource and then releases it. Use to avoid deadlock.
3314 * void Foo() PERL_TSA_EXCLUDES(mutex);
3316 #define PERL_TSA_EXCLUDES(x) \
3317 PERL_TSA__(locks_excluded(x))
3319 /* PERL_TSA_ACQUIRE() is used to annotate functions.
3320 * The caller MUST NOT hold the resource when calling the function,
3321 * and the function will acquire the resource.
3323 * void Foo() PERL_TSA_ACQUIRE(mutex);
3325 #define PERL_TSA_ACQUIRE(x) \
3326 PERL_TSA__(acquire_capability(x))
3328 /* PERL_TSA_RELEASE() is used to annotate functions.
3329 * The caller MUST hold the resource when calling the function,
3330 * and the function will release the resource.
3332 * void Foo() PERL_TSA_RELEASE(mutex);
3334 #define PERL_TSA_RELEASE(x) \
3335 PERL_TSA__(release_capability(x))
3337 /* PERL_TSA_NO_TSA is used to annotate functions.
3338 * Used when being intentionally unsafe, or when the code is too
3339 * complicated for the analysis. Use sparingly.
3341 * void Foo() PERL_TSA_NO_TSA;
3343 #define PERL_TSA_NO_TSA \
3344 PERL_TSA__(no_thread_safety_analysis)
3346 /* There are more annotations/attributes available, see the clang
3347 * documentation for details. */
3349 #if defined(USE_ITHREADS)
3351 # include <nw5thread.h>
3352 # elif defined(WIN32)
3353 # include <win32thread.h>
3355 # include "os2thread.h"
3356 # elif defined(I_MACH_CTHREADS)
3357 # include <mach/cthreads.h>
3358 typedef cthread_t perl_os_thread;
3359 typedef mutex_t perl_mutex;
3360 typedef condition_t perl_cond;
3361 typedef void * perl_key;
3362 # elif defined(I_PTHREAD) /* Posix threads */
3363 # include <pthread.h>
3364 typedef pthread_t perl_os_thread;
3365 typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
3366 typedef pthread_cond_t perl_cond;
3367 typedef pthread_key_t perl_key;
3369 #endif /* USE_ITHREADS */
3371 #ifdef PERL_TSA_ACTIVE
3372 /* Since most pthread mutex interfaces have not been annotated, we
3373 * need to have these wrappers. The NO_TSA annotation is quite ugly
3374 * but it cannot be avoided in plain C, unlike in C++, where one could
3375 * e.g. use ACQUIRE() with no arg on a mutex lock method.
3377 * The bodies of these wrappers are in util.c
3379 * TODO: however, some platforms are starting to get these clang
3380 * thread safety annotations for pthreads, for example FreeBSD.
3381 * Do we need a way to a bypass these wrappers? */
3382 EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
3383 PERL_TSA_ACQUIRE(*mutex)
3385 EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
3386 PERL_TSA_RELEASE(*mutex)
3395 # include "netware.h"
3398 #define STATUS_UNIX PL_statusvalue
3400 # define STATUS_NATIVE PL_statusvalue_vms
3402 * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
3403 * its contents can not be trusted. Unfortunately, Perl seems to check
3404 * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
3407 # include <stsdef.h>
3409 /* Presume this because if VMS changes it, it will require a new
3410 * set of APIs for waiting on children for binary compatibility.
3412 # define child_offset_bits (8)
3413 # ifndef C_FAC_POSIX
3414 # define C_FAC_POSIX 0x35A000
3417 /* STATUS_EXIT - validates and returns a NATIVE exit status code for the
3418 * platform from the existing UNIX or Native status values.
3421 # define STATUS_EXIT \
3422 (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
3423 (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
3426 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
3427 * exit code and shifts the UNIX value over the correct number of bits to
3428 * be a child status. Usually the number of bits is 8, but that could be
3429 * platform dependent. The NATIVE status code is presumed to have either
3430 * from a child process.
3433 /* This is complicated. The child processes return a true native VMS
3434 status which must be saved. But there is an assumption in Perl that
3435 the UNIX child status has some relationship to errno values, so
3436 Perl tries to translate it to text in some of the tests.
3437 In order to get the string translation correct, for the error, errno
3438 must be EVMSERR, but that generates a different text message
3439 than what the test programs are expecting. So an errno value must
3440 be derived from the native status value when an error occurs.
3441 That will hide the true native status message. With this version of
3442 perl, the true native child status can always be retrieved so that
3443 is not a problem. But in this case, Pl_statusvalue and errno may
3444 have different values in them.
3447 # define STATUS_NATIVE_CHILD_SET(n) \
3449 I32 evalue = (I32)n; \
3450 if (evalue == EVMSERR) { \
3451 PL_statusvalue_vms = vaxc$errno; \
3452 PL_statusvalue = evalue; \
3454 PL_statusvalue_vms = evalue; \
3455 if (evalue == -1) { \
3456 PL_statusvalue = -1; \
3457 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3459 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1); \
3460 set_vaxc_errno(evalue); \
3461 if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX) \
3462 set_errno(EVMSERR); \
3463 else set_errno(Perl_vms_status_to_unix(evalue, 0)); \
3464 PL_statusvalue = PL_statusvalue << child_offset_bits; \
3468 # ifdef VMSISH_STATUS
3469 # define STATUS_CURRENT (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
3471 # define STATUS_CURRENT STATUS_UNIX
3474 /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3475 * the NATIVE status to an equivalent value. Can not be used to translate
3476 * exit code values as exit code values are not guaranteed to have any
3477 * relationship at all to errno values.
3478 * This is used when Perl is forcing errno to have a specific value.
3480 # define STATUS_UNIX_SET(n) \
3482 I32 evalue = (I32)n; \
3483 PL_statusvalue = evalue; \
3484 if (PL_statusvalue != -1) { \
3485 if (PL_statusvalue != EVMSERR) { \
3486 PL_statusvalue &= 0xFFFF; \
3487 if (MY_POSIX_EXIT) \
3488 PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3489 else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3492 PL_statusvalue_vms = vaxc$errno; \
3495 else PL_statusvalue_vms = SS$_ABORT; \
3496 set_vaxc_errno(PL_statusvalue_vms); \
3499 /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
3500 * the NATIVE error status based on it.
3502 * When in the default mode to comply with the Perl VMS documentation,
3503 * 0 is a success and any other code sets the NATIVE status to a failure
3504 * code of SS$_ABORT.
3506 * In the new POSIX EXIT mode, native status will be set so that the
3507 * actual exit code will can be retrieved by the calling program or
3510 * If the exit code is not clearly a UNIX parent or child exit status,
3511 * it will be passed through as a VMS status.
3514 # define STATUS_UNIX_EXIT_SET(n) \
3516 I32 evalue = (I32)n; \
3517 PL_statusvalue = evalue; \
3518 if (MY_POSIX_EXIT) { \
3519 if (evalue <= 0xFF00) { \
3520 if (evalue > 0xFF) \
3521 evalue = (evalue >> child_offset_bits) & 0xFF; \
3522 PL_statusvalue_vms = \
3523 (C_FAC_POSIX | (evalue << 3 ) | \
3524 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3525 } else /* forgive them Perl, for they have sinned */ \
3526 PL_statusvalue_vms = evalue; \
3529 PL_statusvalue_vms = SS$_NORMAL; \
3530 else if (evalue <= 0xFF00) \
3531 PL_statusvalue_vms = SS$_ABORT; \
3532 else { /* forgive them Perl, for they have sinned */ \
3533 if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3534 else PL_statusvalue_vms = vaxc$errno; \
3535 /* And obviously used a VMS status value instead of UNIX */ \
3536 PL_statusvalue = EVMSERR; \
3538 set_vaxc_errno(PL_statusvalue_vms); \
3543 /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3544 * and sets the NATIVE error status based on it. This special case
3545 * is needed to maintain compatibility with past VMS behavior.
3547 * In the default mode on VMS, this number is passed through as
3548 * both the NATIVE and UNIX status. Which makes it different
3549 * that the STATUS_UNIX_EXIT_SET.
3551 * In the new POSIX EXIT mode, native status will be set so that the
3552 * actual exit code will can be retrieved by the calling program or
3555 * A POSIX exit code is from 0 to 255. If the exit code is higher
3556 * than this, it needs to be assumed that it is a VMS exit code and
3560 # define STATUS_EXIT_SET(n) \
3562 I32 evalue = (I32)n; \
3563 PL_statusvalue = evalue; \
3564 if (MY_POSIX_EXIT) \
3565 if (evalue > 255) PL_statusvalue_vms = evalue; else { \
3566 PL_statusvalue_vms = \
3567 (C_FAC_POSIX | (evalue << 3 ) | \
3568 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
3570 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3571 set_vaxc_errno(PL_statusvalue_vms); \
3575 /* This macro forces a success status */
3576 # define STATUS_ALL_SUCCESS \
3577 (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
3579 /* This macro forces a failure status */
3580 # define STATUS_ALL_FAILURE (PL_statusvalue = 1, \
3581 vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3582 (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3584 #elif defined(__amigaos4__)
3585 /* A somewhat experimental attempt to simulate posix return code values */
3586 # define STATUS_NATIVE PL_statusvalue_posix
3587 # define STATUS_NATIVE_CHILD_SET(n) \
3589 PL_statusvalue_posix = (n); \
3590 if (PL_statusvalue_posix < 0) { \
3591 PL_statusvalue = -1; \
3594 PL_statusvalue = n << 8; \
3597 # define STATUS_UNIX_SET(n) \
3599 PL_statusvalue = (n); \
3600 if (PL_statusvalue != -1) \
3601 PL_statusvalue &= 0xFFFF; \
3603 # define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3604 # define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3605 # define STATUS_CURRENT STATUS_UNIX
3606 # define STATUS_EXIT STATUS_UNIX
3607 # define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3608 # define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3611 # define STATUS_NATIVE PL_statusvalue_posix
3612 # if defined(WCOREDUMP)
3613 # define STATUS_NATIVE_CHILD_SET(n) \
3615 PL_statusvalue_posix = (n); \
3616 if (PL_statusvalue_posix == -1) \
3617 PL_statusvalue = -1; \
3620 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
3621 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3622 (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0); \
3625 # elif defined(WIFEXITED)
3626 # define STATUS_NATIVE_CHILD_SET(n) \
3628 PL_statusvalue_posix = (n); \
3629 if (PL_statusvalue_posix == -1) \
3630 PL_statusvalue = -1; \
3633 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
3634 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0); \
3638 # define STATUS_NATIVE_CHILD_SET(n) \
3640 PL_statusvalue_posix = (n); \
3641 if (PL_statusvalue_posix == -1) \
3642 PL_statusvalue = -1; \
3645 PL_statusvalue_posix & 0xFFFF; \
3649 # define STATUS_UNIX_SET(n) \
3651 PL_statusvalue = (n); \
3652 if (PL_statusvalue != -1) \
3653 PL_statusvalue &= 0xFFFF; \
3655 # define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3656 # define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3657 # define STATUS_CURRENT STATUS_UNIX
3658 # define STATUS_EXIT STATUS_UNIX
3659 # define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3660 # define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3663 /* flags in PL_exit_flags for nature of exit() */
3664 #define PERL_EXIT_EXPECTED 0x01
3665 #define PERL_EXIT_DESTRUCT_END 0x02 /* Run END in perl_destruct */
3666 #define PERL_EXIT_WARN 0x04 /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3667 #define PERL_EXIT_ABORT 0x08 /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3670 /* format to use for version numbers in file/directory names */
3671 /* XXX move to Configure? */
3672 /* This was only ever used for the current version, and that can be done at
3673 compile time, as PERL_FS_VERSION, so should we just delete it? */
3674 # ifndef PERL_FS_VER_FMT
3675 # define PERL_FS_VER_FMT "%d.%d.%d"
3679 #ifndef PERL_FS_VERSION
3680 # define PERL_FS_VERSION PERL_VERSION_STRING
3683 /* This defines a way to flush all output buffers. This may be a
3684 * performance issue, so we allow people to disable it. Also, if
3685 * we are using stdio, there are broken implementations of fflush(NULL)
3686 * out there, Solaris being the most prominent.
3688 #ifndef PERL_FLUSHALL_FOR_CHILD
3689 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3690 # define PERL_FLUSHALL_FOR_CHILD PerlIO_flush((PerlIO*)NULL)
3691 # elif defined(FFLUSH_ALL)
3692 # define PERL_FLUSHALL_FOR_CHILD my_fflush_all()
3694 # define PERL_FLUSHALL_FOR_CHILD NOOP
3698 #ifndef PERL_WAIT_FOR_CHILDREN
3699 # define PERL_WAIT_FOR_CHILDREN NOOP
3702 /* the traditional thread-unsafe notion of "current interpreter". */
3703 #ifndef PERL_SET_INTERP
3704 # define PERL_SET_INTERP(i) (PL_curinterp = (PerlInterpreter*)(i))
3707 #ifndef PERL_GET_INTERP
3708 # define PERL_GET_INTERP (PL_curinterp)
3711 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3712 # ifdef MULTIPLICITY
3713 # define PERL_GET_THX ((PerlInterpreter *)PERL_GET_CONTEXT)
3715 # define PERL_SET_THX(t) PERL_SET_CONTEXT(t)
3719 This replaces the previous %_ "hack" by the "%p" hacks.
3720 All that is required is that the perl source does not
3721 use "%-p" or "%-<number>p" or "%<number>p" formats.
3722 These formats will still work in perl code.
3723 See comments in sv.c for further details.
3725 Robin Barker 2005-07-14
3727 No longer use %1p for VDf = %vd. RMB 2007-10-19
3731 # define SVf_(n) "-" STRINGIFY(n) "p"
3739 # define SVf32 SVf_(32)
3743 # define SVf256 SVf_(256)
3746 #define SVfARG(p) ((void*)(p))
3752 /* Not ideal, but we cannot easily include a number in an already-numeric
3753 * format sequence. */
3755 # define HEKf256 "3p"
3758 #define HEKfARG(p) ((void*)(p))
3760 /* Documented in perlguts
3762 * %4p is a custom format
3765 # define UTF8f "d%" UVuf "%4p"
3767 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3770 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
3773 /* not used; but needed for backward compatibility with XS code? - RMB
3774 =for apidoc AmnD|const char *|UVf
3776 Obsolete form of C<UVuf>, which you should convert to instead use
3785 #if !defined(DEBUGGING) && !defined(NDEBUG)
3790 /* For functions that are marked as __attribute__noreturn__, it's not
3791 appropriate to call return. In either case, include the lint directive.
3793 #ifdef HASATTRIBUTE_NORETURN
3794 # define NORETURN_FUNCTION_END NOT_REACHED;
3796 # define NORETURN_FUNCTION_END NOT_REACHED; return 0
3799 #ifdef HAS_BUILTIN_EXPECT
3800 # define EXPECT(expr,val) __builtin_expect(expr,val)
3802 # define EXPECT(expr,val) (expr)
3806 =for apidoc_section $directives
3808 =for apidoc Am||LIKELY|bool expr
3810 Returns the input unchanged, but at the same time it gives a branch prediction
3811 hint to the compiler that this condition is likely to be true.
3813 =for apidoc Am||UNLIKELY|bool expr
3815 Returns the input unchanged, but at the same time it gives a branch prediction
3816 hint to the compiler that this condition is likely to be false.
3820 #define LIKELY(cond) EXPECT(cBOOL(cond),TRUE)
3821 #define UNLIKELY(cond) EXPECT(cBOOL(cond),FALSE)
3823 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3827 /* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
3828 time invariants. That is, their argument must be a constant expression that
3829 can be verified by the compiler. This expression can contain anything that's
3830 known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3831 the expression evaluates to 0, compilation fails.
3832 Because they generate no runtime code (i.e. their use is "free"), they're
3833 always active, even under non-DEBUGGING builds.
3834 STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
3835 file scope (outside of any function).
3836 STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3839 #if (! defined(__IBMC__) || __IBMC__ >= 1210) \
3840 && (( defined(static_assert) && ( defined(_ISOC11_SOURCE) \
3841 || (__STDC_VERSION__ - 0) >= 201101L)) \
3842 || (defined(__cplusplus) && __cplusplus >= 201103L))
3843 /* XXX static_assert is a macro defined in <assert.h> in C11 or a compiler
3844 builtin in C++11. But IBM XL C V11 does not support _Static_assert, no
3845 matter what <assert.h> says.
3847 # define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
3849 /* We use a bit-field instead of an array because gcc accepts
3850 'typedef char x[n]' where n is not a compile-time constant.
3851 We want to enforce constantness.
3853 # define STATIC_ASSERT_2(COND, SUFFIX) \
3855 unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3856 } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3857 # define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
3858 # define STATIC_ASSERT_DECL(COND) STATIC_ASSERT_1(COND, __LINE__)
3860 /* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3861 error (static_assert is a declaration, and only statements can have labels).
3863 #define STATIC_ASSERT_STMT(COND) STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
3865 #ifndef __has_builtin
3866 # define __has_builtin(x) 0 /* not a clang style compiler */
3870 =for apidoc Am||ASSUME|bool expr
3871 C<ASSUME> is like C<assert()>, but it has a benefit in a release build. It is a
3872 hint to a compiler about a statement of fact in a function call free
3873 expression, which allows the compiler to generate better machine code. In a
3874 debug build, C<ASSUME(x)> is a synonym for C<assert(x)>. C<ASSUME(0)> means the
3875 control path is unreachable. In a for loop, C<ASSUME> can be used to hint that
3876 a loop will run at least X times. C<ASSUME> is based off MSVC's C<__assume>
3877 intrinsic function, see its documents for more details.
3883 # define ASSUME(x) assert(x)
3884 # if __has_builtin(__builtin_unreachable)
3885 # define HAS_BUILTIN_UNREACHABLE
3886 # elif (defined(__GNUC__) && ( __GNUC__ > 4 \
3887 || __GNUC__ == 4 && __GNUC_MINOR__ >= 5))
3888 # define HAS_BUILTIN_UNREACHABLE
3892 #if defined(__sun) || (defined(__hpux) && !defined(__GNUC__))
3894 # define ASSUME(x) /* ASSUME() generates warnings on Solaris */
3896 # define NOT_REACHED
3897 #elif defined(HAS_BUILTIN_UNREACHABLE)
3899 # define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3901 # define NOT_REACHED \
3903 ASSUME(!"UNREACHABLE"); __builtin_unreachable(); \
3906 # if defined(_MSC_VER)
3907 # define ASSUME(x) __assume(x)
3908 # elif defined(__ARMCC_VERSION) /* untested */
3909 # define ASSUME(x) __promise(x)
3911 /* a random compiler might define assert to its own special optimization
3912 * token so pass it through to C lib as a last resort */
3913 # define ASSUME(x) assert(x)
3915 # define NOT_REACHED ASSUME(!"UNREACHABLE")
3917 #undef HAS_BUILTIN_UNREACHABLE
3919 /* Some unistd.h's give a prototype for pause() even though
3920 HAS_PAUSE ends up undefined. This causes the #define
3921 below to be rejected by the compiler. Sigh.
3926 #define Pause() sleep((32767<<16)+32767)
3930 # ifdef IOCPARM_MASK
3931 /* on BSDish systems we're safe */
3932 # define IOCPARM_LEN(x) (((x) >> 16) & IOCPARM_MASK)
3933 # elif defined(_IOC_SIZE) && defined(__GLIBC__)
3934 /* on Linux systems we're safe; except when we're not [perl #38223] */
3935 # define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3937 /* otherwise guess at what's safe */
3938 # define IOCPARM_LEN(x) 256
3942 #if defined(__CYGWIN__)
3944 * This symbol, if defined, indicates that the program should
3945 * use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3946 * that a file is in "binary" mode -- that is, that no translation
3947 * of bytes occurs on read or write operations.
3949 # define USEMYBINMODE /**/
3950 # include <io.h> /* for setmode() prototype */
3951 # define my_binmode(fp, iotype, mode) \
3952 cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
3956 void init_os_extras(void);
3959 #ifdef UNION_ANY_DEFINITION
3960 UNION_ANY_DEFINITION;
3978 void (*any_dptr) (void*);
3979 void (*any_dxptr) (pTHX_ void*);
3983 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3985 #define FILTER_READ(idx, sv, len) filter_read(idx, sv, len)
3986 #define FILTER_DATA(idx) \
3987 (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3988 #define FILTER_ISREADER(idx) \
3989 (PL_parser && PL_parser->rsfp_filters \
3990 && idx >= AvFILLp(PL_parser->rsfp_filters))
3991 #define PERL_FILTER_EXISTS(i) \
3992 (PL_parser && PL_parser->rsfp_filters \
3993 && (Size_t) (i) < av_count(PL_parser->rsfp_filters))
3995 #if defined(_AIX) && !defined(_AIX43)
3996 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3997 /* We cannot include <crypt.h> to get the struct crypt_data
3998 * because of setkey prototype problems when threading */
3999 typedef struct crypt_data { /* straight from /usr/include/crypt.h */
4000 /* From OSF, Not needed in AIX
4008 #endif /* threading */
4011 #ifndef PERL_CALLCONV
4013 # define PERL_CALLCONV EXTERN_C
4015 # define PERL_CALLCONV
4018 #ifndef PERL_CALLCONV_NO_RET
4019 # define PERL_CALLCONV_NO_RET PERL_CALLCONV
4022 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
4023 dont have a noreturn as a declaration specifier
4025 #ifndef PERL_STATIC_NO_RET
4026 # define PERL_STATIC_NO_RET STATIC
4029 /* PERL_STATIC_INLINE_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE
4030 * on builds that dont have a noreturn as a declaration specifier
4032 #ifndef PERL_STATIC_INLINE_NO_RET
4033 # define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
4036 #ifndef PERL_STATIC_FORCE_INLINE
4037 # define PERL_STATIC_FORCE_INLINE PERL_STATIC_INLINE
4040 #ifndef PERL_STATIC_FORCE_INLINE_NO_RET
4041 # define PERL_STATIC_FORCE_INLINE_NO_RET PERL_STATIC_INLINE
4045 # include "iperlsys.h"
4048 #ifdef __LIBCATAMOUNT__
4049 #undef HAS_PASSWD /* unixish.h but not unixish enough. */
4051 #define FAKE_BIT_BUCKET
4054 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
4055 * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
4056 * Configure, despite their names being similar to other defines like
4057 * USE_ITHREADS. Configure in fact knows nothing about the randomised
4058 * hashes. Therefore to enable/disable the hash randomisation defines
4059 * use the Configure -Accflags=... instead. */
4060 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
4061 # define USE_HASH_SEED
4067 /* macros to define bit-fields in structs. */
4068 #ifndef PERL_BITFIELD8
4069 # define PERL_BITFIELD8 U8
4071 #ifndef PERL_BITFIELD16
4072 # define PERL_BITFIELD16 U16
4074 #ifndef PERL_BITFIELD32
4075 # define PERL_BITFIELD32 U32
4085 #include "opnames.h"
4092 #include "warnings.h"
4095 /* these would be in doio.h if there was such a file */
4096 #define my_stat() my_stat_flags(SV_GMAGIC)
4097 #define my_lstat() my_lstat_flags(SV_GMAGIC)
4099 /* defined in sv.c, but also used in [ach]v.c */
4102 #undef _XPVCV_COMMON
4106 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
4108 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C) \
4109 || defined(PERL_EXT_RE_BUILD)
4111 /* These have to be predeclared, as they are used in proto.h which is #included
4112 * before their definitions in regcomp.h. */
4115 typedef struct regnode_charclass regnode_charclass;
4117 /* A hopefully less confusing name. The sub-classes are all Posix classes only
4118 * used under /l matching */
4119 typedef struct regnode_charclass_posixl regnode_charclass_class;
4120 typedef struct regnode_charclass_posixl regnode_charclass_posixl;
4122 typedef struct regnode_ssc regnode_ssc;
4123 typedef struct RExC_state_t RExC_state_t;
4124 struct _reg_trie_data;
4128 struct ptr_tbl_ent {
4129 struct ptr_tbl_ent* next;
4135 struct ptr_tbl_ent** tbl_ary;
4138 struct ptr_tbl_arena *tbl_arena;
4139 struct ptr_tbl_ent *tbl_arena_next;
4140 struct ptr_tbl_ent *tbl_arena_end;
4143 #if defined(htonl) && !defined(HAS_HTONL)
4146 #if defined(htons) && !defined(HAS_HTONS)
4149 #if defined(ntohl) && !defined(HAS_NTOHL)
4152 #if defined(ntohs) && !defined(HAS_NTOHS)
4160 # if (BYTEORDER & 0xffff) == 0x4321
4161 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
4162 re-order their values. However, to behave identically to the alternative
4163 implementations, they should truncate to the correct size. */
4164 # define ntohl(x) ((x)&0xFFFFFFFF)
4165 # define htonl(x) ntohl(x)
4166 # define ntohs(x) ((x)&0xFFFF)
4167 # define htons(x) ntohs(x)
4168 # elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
4170 /* Note that we can't straight out declare our own htonl and htons because
4171 the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
4172 to avoid the overhead of initialising the socket subsystem, but the headers
4173 that *declare* the various functions are still seen. If we declare our own
4174 htonl etc they will clash with the declarations in the Win32 headers. */
4176 PERL_STATIC_INLINE U32
4177 my_swap32(const U32 x) {
4178 return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)
4179 | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
4182 PERL_STATIC_INLINE U16
4183 my_swap16(const U16 x) {
4184 return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
4187 # define htonl(x) my_swap32(x)
4188 # define ntohl(x) my_swap32(x)
4189 # define ntohs(x) my_swap16(x)
4190 # define htons(x) my_swap16(x)
4192 # error "Unsupported byteorder"
4193 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
4194 the error message. Please check the value of the macro BYTEORDER, as defined
4195 in config.h. The values of BYTEORDER we expect are
4197 big endian little endian
4198 32 bit 0x4321 0x1234
4199 64 bit 0x87654321 0x12345678
4201 If you have a system with a different byte order, please see
4202 pod/perlhack.pod for how to submit a patch to add supporting code.
4208 * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
4211 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
4212 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
4213 re-order their values. However, to behave identically to the alternative
4214 implementations, they should truncate to the correct size. */
4215 # define vtohl(x) ((x)&0xFFFFFFFF)
4216 # define vtohs(x) ((x)&0xFFFF)
4217 # define htovl(x) vtohl(x)
4218 # define htovs(x) vtohs(x)
4219 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
4220 # define vtohl(x) ((((x)&0xFF)<<24) \
4222 +(((x)&0x0000FF00)<<8) \
4223 +(((x)&0x00FF0000)>>8) )
4224 # define vtohs(x) ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
4225 # define htovl(x) vtohl(x)
4226 # define htovs(x) vtohs(x)
4228 # error "Unsupported byteorder"
4229 /* If you have need for current perl on PDP-11 or similar, and can help test
4230 that blead keeps working on a mixed-endian system, then see
4231 pod/perlhack.pod for how to submit patches to things working again. */
4234 /* *MAX Plus 1. A floating point value.
4235 Hopefully expressed in a way that dodgy floating point can't mess up.
4236 >> 2 rather than 1, so that value is safely less than I32_MAX after 1
4238 May find that some broken compiler will want the value cast to I32.
4239 [after the shift, as signed >> may not be as secure as unsigned >>]
4241 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
4242 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
4243 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
4244 0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
4245 may be greater than sizeof(IV), so don't assume that half max UV is max IV.
4247 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
4249 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
4250 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
4251 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
4253 /* This may look like unnecessary jumping through hoops, but converting
4254 out of range floating point values to integers *is* undefined behaviour,
4255 and it is starting to bite.
4257 =for apidoc_section $casting
4258 =for apidoc Am|I32|I_32|NV what
4259 Cast an NV to I32 while avoiding undefined C behavior
4261 =for apidoc Am|U32|U_32|NV what
4262 Cast an NV to U32 while avoiding undefined C behavior
4264 =for apidoc Am|IV|I_V|NV what
4265 Cast an NV to IV while avoiding undefined C behavior
4267 =for apidoc Am|UV|U_V|NV what
4268 Cast an NV to UV while avoiding undefined C behavior
4273 #define I_32(what) (cast_i32((NV)(what)))
4274 #define U_32(what) (cast_ulong((NV)(what)))
4275 #define I_V(what) (cast_iv((NV)(what)))
4276 #define U_V(what) (cast_uv((NV)(what)))
4278 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
4279 : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
4280 : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
4281 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
4282 : ((n) < U32_MAX_P1 ? (U32) (n) \
4283 : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
4284 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
4285 : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
4286 : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
4287 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
4288 : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
4289 : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
4292 #define U_S(what) ((U16)U_32(what))
4293 #define U_I(what) ((unsigned int)U_32(what))
4294 #define U_L(what) U_32(what)
4297 =for apidoc_section $integer
4298 =for apidoc Amn|IV|IV_MAX
4299 The largest signed integer that fits in an IV on this platform.
4301 =for apidoc Amn|IV|IV_MIN
4302 The negative signed integer furthest away from 0 that fits in an IV on this
4305 =for apidoc Amn|UV|UV_MAX
4306 The largest unsigned integer that fits in a UV on this platform.
4308 =for apidoc Amn|UV|UV_MIN
4309 The smallest unsigned integer that fits in a UV on this platform. It should
4316 # ifndef Perl_signbit
4317 # define Perl_signbit signbit
4321 /* These do not care about the fractional part, only about the range. */
4322 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
4323 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
4325 /* Used with UV/IV arguments: */
4326 /* XXXX: need to speed it up */
4327 #define CLUMP_2UV(iv) ((iv) < 0 ? 0 : (UV)(iv))
4328 #define CLUMP_2IV(uv) ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
4336 Uid_t getuid (void);
4337 Uid_t geteuid (void);
4338 Gid_t getgid (void);
4339 Gid_t getegid (void);
4343 #ifndef Perl_debug_log
4344 # define Perl_debug_log PerlIO_stderr()
4347 #ifndef Perl_error_log
4348 # define Perl_error_log (PL_stderrgv \
4349 && isGV(PL_stderrgv) \
4350 && GvIOp(PL_stderrgv) \
4351 && IoOFP(GvIOp(PL_stderrgv)) \
4352 ? IoOFP(GvIOp(PL_stderrgv)) \
4357 #define DEBUG_p_FLAG 0x00000001 /* 1 */
4358 #define DEBUG_s_FLAG 0x00000002 /* 2 */
4359 #define DEBUG_l_FLAG 0x00000004 /* 4 */
4360 #define DEBUG_t_FLAG 0x00000008 /* 8 */
4361 #define DEBUG_o_FLAG 0x00000010 /* 16 */
4362 #define DEBUG_c_FLAG 0x00000020 /* 32 */
4363 #define DEBUG_P_FLAG 0x00000040 /* 64 */
4364 #define DEBUG_m_FLAG 0x00000080 /* 128 */
4365 #define DEBUG_f_FLAG 0x00000100 /* 256 */
4366 #define DEBUG_r_FLAG 0x00000200 /* 512 */
4367 #define DEBUG_x_FLAG 0x00000400 /* 1024 */
4368 #define DEBUG_u_FLAG 0x00000800 /* 2048 */
4369 /* U is reserved for Unofficial, exploratory hacking */
4370 #define DEBUG_U_FLAG 0x00001000 /* 4096 */
4372 #define DEBUG_X_FLAG 0x00004000 /* 16384 */
4373 #define DEBUG_D_FLAG 0x00008000 /* 32768 */
4374 #define DEBUG_S_FLAG 0x00010000 /* 65536 */
4375 #define DEBUG_T_FLAG 0x00020000 /* 131072 */
4376 #define DEBUG_R_FLAG 0x00040000 /* 262144 */
4377 #define DEBUG_J_FLAG 0x00080000 /* 524288 */
4378 #define DEBUG_v_FLAG 0x00100000 /*1048576 */
4379 #define DEBUG_C_FLAG 0x00200000 /*2097152 */
4380 #define DEBUG_A_FLAG 0x00400000 /*4194304 */
4381 #define DEBUG_q_FLAG 0x00800000 /*8388608 */
4382 #define DEBUG_M_FLAG 0x01000000 /*16777216*/
4383 #define DEBUG_B_FLAG 0x02000000 /*33554432*/
4384 #define DEBUG_L_FLAG 0x04000000 /*67108864*/
4385 #define DEBUG_i_FLAG 0x08000000 /*134217728*/
4386 #define DEBUG_y_FLAG 0x10000000 /*268435456*/
4387 #define DEBUG_MASK 0x1FFFEFFF /* mask of all the standard flags */
4389 #define DEBUG_DB_RECURSE_FLAG 0x40000000
4390 #define DEBUG_TOP_FLAG 0x80000000 /* -D was given --> PL_debug |= FLAG */
4392 # define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
4393 # define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
4394 # define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
4395 # define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
4396 # define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
4397 # define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
4398 # define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
4399 # define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
4400 # define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
4401 # define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
4402 # define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
4403 # define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
4404 # define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
4405 # define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
4406 # define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
4407 # define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
4408 # define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
4409 # define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
4410 # define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
4411 # define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
4412 # define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
4413 # define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
4414 # define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
4415 # define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
4416 # define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
4417 # define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
4418 # define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
4419 # define DEBUG_y_TEST_ UNLIKELY(PL_debug & DEBUG_y_FLAG)
4420 # define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
4421 # define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
4422 # define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
4423 # define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
4424 # define DEBUG_yv_TEST_ (DEBUG_y_TEST_ && DEBUG_v_TEST_)
4428 # define DEBUG_p_TEST DEBUG_p_TEST_
4429 # define DEBUG_s_TEST DEBUG_s_TEST_
4430 # define DEBUG_l_TEST DEBUG_l_TEST_
4431 # define DEBUG_t_TEST DEBUG_t_TEST_
4432 # define DEBUG_o_TEST DEBUG_o_TEST_
4433 # define DEBUG_c_TEST DEBUG_c_TEST_
4434 # define DEBUG_P_TEST DEBUG_P_TEST_
4435 # define DEBUG_m_TEST DEBUG_m_TEST_
4436 # define DEBUG_f_TEST DEBUG_f_TEST_
4437 # define DEBUG_r_TEST DEBUG_r_TEST_
4438 # define DEBUG_x_TEST DEBUG_x_TEST_
4439 # define DEBUG_u_TEST DEBUG_u_TEST_
4440 # define DEBUG_U_TEST DEBUG_U_TEST_
4441 # define DEBUG_X_TEST DEBUG_X_TEST_
4442 # define DEBUG_D_TEST DEBUG_D_TEST_
4443 # define DEBUG_S_TEST DEBUG_S_TEST_
4444 # define DEBUG_T_TEST DEBUG_T_TEST_
4445 # define DEBUG_R_TEST DEBUG_R_TEST_
4446 # define DEBUG_J_TEST DEBUG_J_TEST_
4447 # define DEBUG_v_TEST DEBUG_v_TEST_
4448 # define DEBUG_C_TEST DEBUG_C_TEST_
4449 # define DEBUG_A_TEST DEBUG_A_TEST_
4450 # define DEBUG_q_TEST DEBUG_q_TEST_
4451 # define DEBUG_M_TEST DEBUG_M_TEST_
4452 # define DEBUG_B_TEST DEBUG_B_TEST_
4453 # define DEBUG_L_TEST DEBUG_L_TEST_
4454 # define DEBUG_i_TEST DEBUG_i_TEST_
4455 # define DEBUG_y_TEST DEBUG_y_TEST_
4456 # define DEBUG_Xv_TEST DEBUG_Xv_TEST_
4457 # define DEBUG_Uv_TEST DEBUG_Uv_TEST_
4458 # define DEBUG_Pv_TEST DEBUG_Pv_TEST_
4459 # define DEBUG_Lv_TEST DEBUG_Lv_TEST_
4460 # define DEBUG_yv_TEST DEBUG_yv_TEST_
4462 # define PERL_DEB(a) a
4463 # define PERL_DEB2(a,b) a
4464 # define PERL_DEBUG(a) if (PL_debug) a
4465 # define DEBUG_p(a) if (DEBUG_p_TEST) a
4466 # define DEBUG_s(a) if (DEBUG_s_TEST) a
4467 # define DEBUG_l(a) if (DEBUG_l_TEST) a
4468 # define DEBUG_t(a) if (DEBUG_t_TEST) a
4469 # define DEBUG_o(a) if (DEBUG_o_TEST) a
4470 # define DEBUG_c(a) if (DEBUG_c_TEST) a
4471 # define DEBUG_P(a) if (DEBUG_P_TEST) a
4473 /* Temporarily turn off memory debugging in case the a
4474 * does memory allocation, either directly or indirectly. */
4475 # define DEBUG_m(a) \
4477 if (PERL_GET_INTERP) { \
4479 if (DEBUG_m_TEST) { \
4480 PL_debug &= ~DEBUG_m_FLAG; \
4482 PL_debug |= DEBUG_m_FLAG; \
4487 # define DEBUG__(t, a) \
4489 if (t) STMT_START {a;} STMT_END; \
4492 # define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
4494 /* For re_comp.c, re_exec.c, assume -Dr has been specified */
4495 # ifdef PERL_EXT_RE_BUILD
4496 # define DEBUG_r(a) STMT_START {a;} STMT_END
4498 # define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
4499 # endif /* PERL_EXT_RE_BUILD */
4501 # define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
4502 # define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
4503 # define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
4504 # define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
4505 # define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
4506 # define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
4507 # define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
4508 # define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
4509 # define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
4510 # define DEBUG_yv(a) DEBUG__(DEBUG_yv_TEST, a)
4512 # define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
4513 # define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
4514 # define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
4515 # define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
4516 # define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
4517 # define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
4518 # define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
4519 # define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
4520 # define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
4521 # define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
4522 # define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
4523 # define DEBUG_y(a) DEBUG__(DEBUG_y_TEST, a)
4525 #else /* ! DEBUGGING below */
4527 # define DEBUG_p_TEST (0)
4528 # define DEBUG_s_TEST (0)
4529 # define DEBUG_l_TEST (0)
4530 # define DEBUG_t_TEST (0)
4531 # define DEBUG_o_TEST (0)
4532 # define DEBUG_c_TEST (0)
4533 # define DEBUG_P_TEST (0)
4534 # define DEBUG_m_TEST (0)
4535 # define DEBUG_f_TEST (0)
4536 # define DEBUG_r_TEST (0)
4537 # define DEBUG_x_TEST (0)
4538 # define DEBUG_u_TEST (0)
4539 # define DEBUG_U_TEST (0)
4540 # define DEBUG_X_TEST (0)
4541 # define DEBUG_D_TEST (0)
4542 # define DEBUG_S_TEST (0)
4543 # define DEBUG_T_TEST (0)
4544 # define DEBUG_R_TEST (0)
4545 # define DEBUG_J_TEST (0)
4546 # define DEBUG_v_TEST (0)
4547 # define DEBUG_C_TEST (0)
4548 # define DEBUG_A_TEST (0)
4549 # define DEBUG_q_TEST (0)
4550 # define DEBUG_M_TEST (0)
4551 # define DEBUG_B_TEST (0)
4552 # define DEBUG_L_TEST (0)
4553 # define DEBUG_i_TEST (0)
4554 # define DEBUG_y_TEST (0)
4555 # define DEBUG_Xv_TEST (0)
4556 # define DEBUG_Uv_TEST (0)
4557 # define DEBUG_Pv_TEST (0)
4558 # define DEBUG_Lv_TEST (0)
4559 # define DEBUG_yv_TEST (0)
4561 # define PERL_DEB(a)
4562 # define PERL_DEB2(a,b) b
4563 # define PERL_DEBUG(a)
4591 # define DEBUG_Xv(a)
4592 # define DEBUG_Uv(a)
4593 # define DEBUG_Pv(a)
4594 # define DEBUG_Lv(a)
4595 # define DEBUG_yv(a)
4596 #endif /* DEBUGGING */
4599 #define DEBUG_SCOPE(where) \
4601 Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n", \
4602 where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
4603 __FILE__, __LINE__));
4605 /* Keep the old croak based assert for those who want it, and as a fallback if
4606 the platform is so heretically non-ANSI that it can't assert. */
4608 #define Perl_assert(what) PERL_DEB2( \
4609 ((what) ? ((void) 0) : \
4610 (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
4611 "\", line %d", STRINGIFY(what), __LINE__), \
4612 (void) 0)), ((void)0))
4614 /* assert() gets defined if DEBUGGING.
4615 * If no DEBUGGING, the <assert.h> has not been included. */
4617 # define assert(what) Perl_assert(what)
4620 # define assert_(what) assert(what),
4622 # define assert_(what)
4626 I32 (*uf_val)(pTHX_ IV, SV*);
4627 I32 (*uf_set)(pTHX_ IV, SV*);
4631 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4632 * XS code wanting to be backward compatible can do something
4633 * like the following:
4635 #ifndef PERL_MG_UFUNC
4636 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4639 static PERL_MG_UFUNC(foo_get, index, val)
4649 #ifndef PERL_MG_UFUNC
4650 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4655 /* isfinite and others are here rather than in math.h as C99 stipulates */
4660 # if !defined(WIN32) && !defined(VMS)
4662 char *crypt (const char*, const char*);
4664 # endif /* !WIN32 */
4667 char *getlogin (void);
4669 # endif /* !WIN32 */
4670 #endif /* !__cplusplus */
4672 /* Fixme on VMS. This needs to be a run-time, not build time options */
4673 /* Also rename() is affected by this */
4674 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4675 #define UNLINK unlnk
4676 I32 unlnk (pTHX_ const char*);
4678 #define UNLINK PerlLIO_unlink
4681 /* some versions of glibc are missing the setresuid() proto */
4682 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4683 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4685 /* some versions of glibc are missing the setresgid() proto */
4686 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4687 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4690 #ifndef HAS_SETREUID
4691 # ifdef HAS_SETRESUID
4692 # define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4693 # define HAS_SETREUID
4696 #ifndef HAS_SETREGID
4697 # ifdef HAS_SETRESGID
4698 # define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4699 # define HAS_SETREGID
4703 /* Sighandler_t defined in iperlsys.h */
4705 #ifdef HAS_SIGACTION
4706 typedef struct sigaction Sigsave_t;
4708 typedef Sighandler_t Sigsave_t;
4719 # define RUNOPS_DEFAULT Perl_runops_debug
4721 # define RUNOPS_DEFAULT Perl_runops_standard
4724 #if defined(USE_PERLIO)
4725 EXTERN_C void PerlIO_teardown(void);
4726 # ifdef USE_ITHREADS
4727 # define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4728 # define PERLIO_TERM \
4730 PerlIO_teardown(); \
4731 MUTEX_DESTROY(&PL_perlio_mutex);\
4734 # define PERLIO_INIT
4735 # define PERLIO_TERM PerlIO_teardown()
4738 # define PERLIO_INIT
4739 # define PERLIO_TERM
4743 # ifdef MUTEX_INIT_CALLS_MALLOC
4744 # define MALLOC_INIT \
4746 PL_malloc_mutex = NULL; \
4747 MUTEX_INIT(&PL_malloc_mutex); \
4749 # define MALLOC_TERM \
4751 perl_mutex tmp = PL_malloc_mutex; \
4752 PL_malloc_mutex = NULL; \
4753 MUTEX_DESTROY(&tmp); \
4756 # define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4757 # define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4760 # define MALLOC_INIT
4761 # define MALLOC_TERM
4764 #if defined(PERL_IMPLICIT_CONTEXT)
4766 struct perl_memory_debug_header;
4767 struct perl_memory_debug_header {
4769 # if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4772 struct perl_memory_debug_header *prev;
4773 struct perl_memory_debug_header *next;
4774 # ifdef PERL_DEBUG_READONLY_COW
4779 #elif defined(PERL_DEBUG_READONLY_COW)
4781 struct perl_memory_debug_header;
4782 struct perl_memory_debug_header {
4788 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4790 # define PERL_MEMORY_DEBUG_HEADER_SIZE \
4791 (sizeof(struct perl_memory_debug_header) + \
4792 (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4793 %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4796 # define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4799 #ifdef PERL_TRACK_MEMPOOL
4800 # ifdef PERL_DEBUG_READONLY_COW
4801 # define INIT_TRACK_MEMPOOL(header, interp) \
4803 (header).interpreter = (interp); \
4804 (header).prev = (header).next = &(header); \
4805 (header).readonly = 0; \
4808 # define INIT_TRACK_MEMPOOL(header, interp) \
4810 (header).interpreter = (interp); \
4811 (header).prev = (header).next = &(header); \
4815 # define INIT_TRACK_MEMPOOL(header, interp)
4818 #ifdef I_MALLOCMALLOC
4819 /* Needed for malloc_size(), malloc_good_size() on some systems */
4820 # include <malloc/malloc.h>
4824 # define Perl_safesysmalloc_size(where) Perl_malloced_size(where)
4826 # if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4827 # ifdef PERL_TRACK_MEMPOOL
4828 # define Perl_safesysmalloc_size(where) \
4829 (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4831 # define Perl_safesysmalloc_size(where) malloc_size(where)
4834 # ifdef HAS_MALLOC_GOOD_SIZE
4835 # ifdef PERL_TRACK_MEMPOOL
4836 # define Perl_malloc_good_size(how_much) \
4837 (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4839 # define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4842 /* Having this as the identity operation makes some code simpler. */
4843 # define Perl_malloc_good_size(how_much) (how_much)
4847 typedef int (*runops_proc_t)(pTHX);
4848 typedef void (*share_proc_t) (pTHX_ SV *sv);
4849 typedef int (*thrhook_proc_t) (pTHX);
4850 typedef OP* (*PPADDR_t[]) (pTHX);
4851 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4852 typedef void (*despatch_signals_proc_t) (pTHX);
4854 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4855 # include <crt_externs.h> /* for the env array */
4856 # define environ (*_NSGetEnviron())
4857 #elif defined(USE_ENVIRON_ARRAY) && !defined(environ)
4858 /* VMS and some other platforms don't use the environ array */
4859 EXTERN_C char **environ; /* environment variables supplied via exec */
4862 #define PERL_PATCHLEVEL_H_IMPLICIT
4863 #include "patchlevel.h"
4864 #undef PERL_PATCHLEVEL_H_IMPLICIT
4866 #define PERL_VERSION_STRING STRINGIFY(PERL_REVISION) "." \
4867 STRINGIFY(PERL_VERSION) "." \
4868 STRINGIFY(PERL_SUBVERSION)
4870 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4871 STRINGIFY(PERL_API_VERSION) "." \
4872 STRINGIFY(PERL_API_SUBVERSION)
4876 /* handy constants */
4877 EXTCONST char PL_warn_uninit[]
4878 INIT("Use of uninitialized value%s%s%s");
4879 EXTCONST char PL_warn_uninit_sv[]
4880 INIT("Use of uninitialized value%" SVf "%s%s");
4881 EXTCONST char PL_warn_nosemi[]
4882 INIT("Semicolon seems to be missing");
4883 EXTCONST char PL_warn_reserved[]
4884 INIT("Unquoted string \"%s\" may clash with future reserved word");
4885 EXTCONST char PL_warn_nl[]
4886 INIT("Unsuccessful %s on filename containing newline");
4887 EXTCONST char PL_no_wrongref[]
4888 INIT("Can't use %s ref as %s ref");
4889 /* The core no longer needs this here. If you require the string constant,
4890 please inline a copy into your own code. */
4891 EXTCONST char PL_no_symref[] __attribute__deprecated__
4892 INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4893 EXTCONST char PL_no_symref_sv[]
4894 INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4896 EXTCONST char PL_no_usym[]
4897 INIT("Can't use an undefined value as %s reference");
4898 EXTCONST char PL_no_aelem[]
4899 INIT("Modification of non-creatable array value attempted, subscript %d");
4900 EXTCONST char PL_no_helem_sv[]
4901 INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4902 EXTCONST char PL_no_modify[]
4903 INIT("Modification of a read-only value attempted");
4904 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4905 INIT("Out of memory!\n");
4906 EXTCONST char PL_no_security[]
4907 INIT("Insecure dependency in %s%s");
4908 EXTCONST char PL_no_sock_func[]
4909 INIT("Unsupported socket function \"%s\" called");
4910 EXTCONST char PL_no_dir_func[]
4911 INIT("Unsupported directory function \"%s\" called");
4912 EXTCONST char PL_no_func[]
4913 INIT("The %s function is unimplemented");
4914 EXTCONST char PL_no_myglob[]
4915 INIT("\"%s\" %s %s can't be in a package");
4916 EXTCONST char PL_no_localize_ref[]
4917 INIT("Can't localize through a reference");
4918 EXTCONST char PL_memory_wrap[]
4919 INIT("panic: memory wrap");
4920 EXTCONST char PL_extended_cp_format[]
4921 INIT("Code point 0x%" UVXf " is not Unicode, requires a Perl extension,"
4922 " and so is not portable");
4923 EXTCONST char PL_Yes[]
4925 EXTCONST char PL_No[]
4927 EXTCONST char PL_Zero[]
4931 =for apidoc_section $numeric
4932 =for apidoc AmTuU|const char *|PL_hexdigit|U8 value
4934 This array, indexed by an integer, converts that value into the character that
4935 represents it. For example, if the input is 8, the return will be a string
4936 whose first character is '8'. What is actually returned is a pointer into a
4937 string. All you are interested in is the first character of that string. To
4938 get uppercase letters (for the values 10..15), add 16 to the index. Hence,
4939 C<PL_hexdigit[11]> is C<'b'>, and C<PL_hexdigit[11+16]> is C<'B'>. Adding 16
4940 to an index whose representation is '0'..'9' yields the same as not adding 16.
4941 Indices outside the range 0..31 result in (bad) undedefined behavior.
4945 EXTCONST char PL_hexdigit[]
4946 INIT("0123456789abcdef0123456789ABCDEF");
4948 EXTCONST STRLEN PL_WARN_ALL
4950 EXTCONST STRLEN PL_WARN_NONE
4953 /* This is constant on most architectures, a global on OS/2 */
4955 EXTCONST char PL_sh_path[]
4956 INIT(SH_PATH); /* full path of shell */
4960 EXTCONST char PL_cshname[]
4962 # define PL_cshlen (sizeof(CSH "") - 1)
4965 /* These are baked at compile time into any shared perl library.
4966 In future releases this will allow us in main() to sanity test the
4967 library we're linking against. */
4969 EXTCONST U8 PL_revision
4970 INIT(PERL_REVISION);
4971 EXTCONST U8 PL_version
4973 EXTCONST U8 PL_subversion
4974 INIT(PERL_SUBVERSION);
4976 EXTCONST char PL_uuemap[65]
4977 INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4979 /* a special string address whose value is "isa", but which perl knows
4980 * to treat as if it were really "DOES" when printing the method name in
4981 * the "Can't call method '%s'" error message */
4982 EXTCONST char PL_isa_DOES[]
4986 EXTCONST char PL_uudmap[256] =
4988 # include "uuudmap.h"
4990 # include "uudmap.h"
4993 EXTCONST char PL_bitcount[256] =
4995 # include "ubitcount.h"
4997 # include "bitcount.h"
5000 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
5001 EXTCONST int PL_sig_num[] = { SIG_NUM };
5003 EXTCONST char PL_uudmap[256];
5004 EXTCONST char PL_bitcount[256];
5005 EXTCONST char* const PL_sig_name[];
5006 EXTCONST int PL_sig_num[];
5009 /* fast conversion and case folding tables. The folding tables complement the
5010 * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
5011 * folds such as outside the range or to multiple characters. */
5016 /* The EBCDIC fold table depends on the code page, and hence is found in
5017 * ebcdic_tables.h */
5019 EXTCONST unsigned char PL_fold[] = {
5020 0, 1, 2, 3, 4, 5, 6, 7,
5021 8, 9, 10, 11, 12, 13, 14, 15,
5022 16, 17, 18, 19, 20, 21, 22, 23,
5023 24, 25, 26, 27, 28, 29, 30, 31,
5024 32, 33, 34, 35, 36, 37, 38, 39,
5025 40, 41, 42, 43, 44, 45, 46, 47,
5026 48, 49, 50, 51, 52, 53, 54, 55,
5027 56, 57, 58, 59, 60, 61, 62, 63,
5028 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
5029 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
5030 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
5031 'x', 'y', 'z', 91, 92, 93, 94, 95,
5032 96, 'A', 'B', 'C', 'D', 'E', 'F', 'G',
5033 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
5034 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
5035 'X', 'Y', 'Z', 123, 124, 125, 126, 127,
5036 128, 129, 130, 131, 132, 133, 134, 135,
5037 136, 137, 138, 139, 140, 141, 142, 143,
5038 144, 145, 146, 147, 148, 149, 150, 151,
5039 152, 153, 154, 155, 156, 157, 158, 159,
5040 160, 161, 162, 163, 164, 165, 166, 167,
5041 168, 169, 170, 171, 172, 173, 174, 175,
5042 176, 177, 178, 179, 180, 181, 182, 183,
5043 184, 185, 186, 187, 188, 189, 190, 191,
5044 192, 193, 194, 195, 196, 197, 198, 199,
5045 200, 201, 202, 203, 204, 205, 206, 207,
5046 208, 209, 210, 211, 212, 213, 214, 215,
5047 216, 217, 218, 219, 220, 221, 222, 223,
5048 224, 225, 226, 227, 228, 229, 230, 231,
5049 232, 233, 234, 235, 236, 237, 238, 239,
5050 240, 241, 242, 243, 244, 245, 246, 247,
5051 248, 249, 250, 251, 252, 253, 254, 255
5054 EXT unsigned char PL_fold_locale[] = { /* Unfortunately not EXTCONST. */
5055 0, 1, 2, 3, 4, 5, 6, 7,
5056 8, 9, 10, 11, 12, 13, 14, 15,
5057 16, 17, 18, 19, 20, 21, 22, 23,
5058 24, 25, 26, 27, 28, 29, 30, 31,
5059 32, 33, 34, 35, 36, 37, 38, 39,
5060 40, 41, 42, 43, 44, 45, 46, 47,
5061 48, 49, 50, 51, 52, 53, 54, 55,
5062 56, 57, 58, 59, 60, 61, 62, 63,
5063 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
5064 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
5065 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
5066 'x', 'y', 'z', 91, 92, 93, 94, 95,
5067 96, 'A', 'B', 'C', 'D', 'E', 'F', 'G',
5068 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
5069 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
5070 'X', 'Y', 'Z', 123, 124, 125, 126, 127,
5071 128, 129, 130, 131, 132, 133, 134, 135,
5072 136, 137, 138, 139, 140, 141, 142, 143,
5073 144, 145, 146, 147, 148, 149, 150, 151,
5074 152, 153, 154, 155, 156, 157, 158, 159,
5075 160, 161, 162, 163, 164, 165, 166, 167,
5076 168, 169, 170, 171, 172, 173, 174, 175,
5077 176, 177, 178, 179, 180, 181, 182, 183,
5078 184, 185, 186, 187, 188, 189, 190, 191,
5079 192, 193, 194, 195, 196, 197, 198, 199,
5080 200, 201, 202, 203, 204, 205, 206, 207,
5081 208, 209, 210, 211, 212, 213, 214, 215,
5082 216, 217, 218, 219, 220, 221, 222, 223,
5083 224, 225, 226, 227, 228, 229, 230, 231,
5084 232, 233, 234, 235, 236, 237, 238, 239,
5085 240, 241, 242, 243, 244, 245, 246, 247,
5086 248, 249, 250, 251, 252, 253, 254, 255
5089 EXTCONST unsigned char PL_fold_latin1[] = {
5090 /* Full latin1 complement folding, except for three problematic code points:
5091 * Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
5092 * fold complements outside the Latin1 range, so can't match something
5093 * that isn't in utf8.
5094 * German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
5095 * not one, so can't be represented in this table.
5097 * All have to be specially handled */
5098 0, 1, 2, 3, 4, 5, 6, 7,
5099 8, 9, 10, 11, 12, 13, 14, 15,
5100 16, 17, 18, 19, 20, 21, 22, 23,
5101 24, 25, 26, 27, 28, 29, 30, 31,
5102 32, 33, 34, 35, 36, 37, 38, 39,
5103 40, 41, 42, 43, 44, 45, 46, 47,
5104 48, 49, 50, 51, 52, 53, 54, 55,
5105 56, 57, 58, 59, 60, 61, 62, 63,
5106 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
5107 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
5108 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
5109 'x', 'y', 'z', 91, 92, 93, 94, 95,
5110 96, 'A', 'B', 'C', 'D', 'E', 'F', 'G',
5111 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
5112 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
5113 'X', 'Y', 'Z', 123, 124, 125, 126, 127,
5114 128, 129, 130, 131, 132, 133, 134, 135,
5115 136, 137, 138, 139, 140, 141, 142, 143,
5116 144, 145, 146, 147, 148, 149, 150, 151,
5117 152, 153, 154, 155, 156, 157, 158, 159,
5118 160, 161, 162, 163, 164, 165, 166, 167,
5119 168, 169, 170, 171, 172, 173, 174, 175,
5120 176, 177, 178, 179, 180, 181 /*micro */, 182, 183,
5121 184, 185, 186, 187, 188, 189, 190, 191,
5122 192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
5123 200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
5124 208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
5125 216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
5126 224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
5127 232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
5128 240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
5129 248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
5130 255 /* y with diaeresis */
5133 /* If these tables are accessed through ebcdic, the access will be converted to
5135 EXTCONST unsigned char PL_latin1_lc[] = { /* lowercasing */
5136 0, 1, 2, 3, 4, 5, 6, 7,
5137 8, 9, 10, 11, 12, 13, 14, 15,
5138 16, 17, 18, 19, 20, 21, 22, 23,
5139 24, 25, 26, 27, 28, 29, 30, 31,
5140 32, 33, 34, 35, 36, 37, 38, 39,
5141 40, 41, 42, 43, 44, 45, 46, 47,
5142 48, 49, 50, 51, 52, 53, 54, 55,
5143 56, 57, 58, 59, 60, 61, 62, 63,
5144 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
5145 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
5146 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
5147 'x', 'y', 'z', 91, 92, 93, 94, 95,
5148 96, 97, 98, 99, 100, 101, 102, 103,
5149 104, 105, 106, 107, 108, 109, 110, 111,
5150 112, 113, 114, 115, 116, 117, 118, 119,
5151 120, 121, 122, 123, 124, 125, 126, 127,
5152 128, 129, 130, 131, 132, 133, 134, 135,
5153 136, 137, 138, 139, 140, 141, 142, 143,
5154 144, 145, 146, 147, 148, 149, 150, 151,
5155 152, 153, 154, 155, 156, 157, 158, 159,
5156 160, 161, 162, 163, 164, 165, 166, 167,
5157 168, 169, 170, 171, 172, 173, 174, 175,
5158 176, 177, 178, 179, 180, 181, 182, 183,
5159 184, 185, 186, 187, 188, 189, 190, 191,
5160 192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
5161 200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
5162 208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
5163 216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223,
5164 224, 225, 226, 227, 228, 229, 230, 231,
5165 232, 233, 234, 235, 236, 237, 238, 239,
5166 240, 241, 242, 243, 244, 245, 246, 247,
5167 248, 249, 250, 251, 252, 253, 254, 255
5170 /* upper and title case of latin1 characters, modified so that the three tricky
5171 * ones are mapped to 255 (which is one of the three) */
5172 EXTCONST unsigned char PL_mod_latin1_uc[] = {
5173 0, 1, 2, 3, 4, 5, 6, 7,
5174 8, 9, 10, 11, 12, 13, 14, 15,
5175 16, 17, 18, 19, 20, 21, 22, 23,
5176 24, 25, 26, 27, 28, 29, 30, 31,
5177 32, 33, 34, 35, 36, 37, 38, 39,
5178 40, 41, 42, 43, 44, 45, 46, 47,
5179 48, 49, 50, 51, 52, 53, 54, 55,
5180 56, 57, 58, 59, 60, 61, 62, 63,
5181 64, 65, 66, 67, 68, 69, 70, 71,
5182 72, 73, 74, 75, 76, 77, 78, 79,
5183 80, 81, 82, 83, 84, 85, 86, 87,
5184 88, 89, 90, 91, 92, 93, 94, 95,
5185 96, 'A', 'B', 'C', 'D', 'E', 'F', 'G',
5186 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
5187 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
5188 'X', 'Y', 'Z', 123, 124, 125, 126, 127,
5189 128, 129, 130, 131, 132, 133, 134, 135,
5190 136, 137, 138, 139, 140, 141, 142, 143,
5191 144, 145, 146, 147, 148, 149, 150, 151,
5192 152, 153, 154, 155, 156, 157, 158, 159,
5193 160, 161, 162, 163, 164, 165, 166, 167,
5194 168, 169, 170, 171, 172, 173, 174, 175,
5195 176, 177, 178, 179, 180, 255 /*micro*/, 182, 183,
5196 184, 185, 186, 187, 188, 189, 190, 191,
5197 192, 193, 194, 195, 196, 197, 198, 199,
5198 200, 201, 202, 203, 204, 205, 206, 207,
5199 208, 209, 210, 211, 212, 213, 214, 215,
5200 216, 217, 218, 219, 220, 221, 222,
5201 # if UNICODE_MAJOR_VERSION > 2 \
5202 || (UNICODE_MAJOR_VERSION == 2 && UNICODE_DOT_VERSION >= 1 \
5203 && UNICODE_DOT_DOT_VERSION >= 8)
5205 # else /* uc(sharp s) is 'sharp s' itself in early unicode */
5208 224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
5209 232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
5210 240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
5211 248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32, 255
5213 # endif /* !EBCDIC, but still in DOINIT */
5214 #else /* ! DOINIT */
5216 EXTCONST unsigned char PL_fold[];
5217 EXTCONST unsigned char PL_fold_latin1[];
5218 EXTCONST unsigned char PL_mod_latin1_uc[];
5219 EXTCONST unsigned char PL_latin1_lc[];
5220 EXT unsigned char PL_fold_locale[]; /* Unfortunately not EXTCONST. */
5224 /* Although only used for debugging, these constants must be available in
5225 * non-debugging builds too, since they're used in ext/re/re_exec.c,
5226 * which has DEBUGGING enabled always */
5228 EXTCONST char* const PL_block_type[] = {
5244 EXTCONST char* PL_block_type[];
5247 /* These are all the compile time options that affect binary compatibility.
5248 Other compile time options that are binary compatible are in perl.c
5249 (in S_Internals_V()). Both are combined for the output of perl -V
5250 However, this string will be embedded in any shared perl library, which will
5251 allow us add a comparison check in perlmain.c in the near future. */
5253 EXTCONST char PL_bincompat_options[] =
5254 # ifdef DEBUG_LEAKING_SCALARS
5255 " DEBUG_LEAKING_SCALARS"
5257 # ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5258 " DEBUG_LEAKING_SCALARS_FORK_DUMP"
5263 # ifdef HAVE_INTERP_INTERN
5264 " HAVE_INTERP_INTERN"
5266 # ifdef MULTIPLICITY
5272 # ifdef PERLIO_LAYERS
5275 # ifdef PERL_DEBUG_READONLY_COW
5276 " PERL_DEBUG_READONLY_COW"
5278 # ifdef PERL_DEBUG_READONLY_OPS
5279 " PERL_DEBUG_READONLY_OPS"
5281 # ifdef PERL_IMPLICIT_CONTEXT
5282 " PERL_IMPLICIT_CONTEXT"
5284 # ifdef PERL_IMPLICIT_SYS
5285 " PERL_IMPLICIT_SYS"
5293 # ifdef PERL_SAWAMPERSAND
5294 " PERL_SAWAMPERSAND"
5296 # ifdef PERL_TRACK_MEMPOOL
5297 " PERL_TRACK_MEMPOOL"
5299 # ifdef PERL_USES_PL_PIDSTATUS
5300 " PERL_USES_PL_PIDSTATUS"
5302 # ifdef USE_64_BIT_ALL
5305 # ifdef USE_64_BIT_INT
5311 # ifdef USE_ITHREADS
5314 # ifdef USE_LARGE_FILES
5317 # ifdef USE_LOCALE_COLLATE
5318 " USE_LOCALE_COLLATE"
5320 # ifdef USE_LOCALE_NUMERIC
5321 " USE_LOCALE_NUMERIC"
5323 # ifdef USE_LOCALE_TIME
5326 # ifdef USE_LONG_DOUBLE
5332 # ifdef USE_QUADMATH
5335 # ifdef USE_REENTRANT_API
5336 " USE_REENTRANT_API"
5341 # ifdef VMS_DO_SOCKETS
5344 # ifdef VMS_SHORTEN_LONG_SYMBOLS
5345 " VMS_SHORTEN_LONG_SYMBOLS"
5347 # ifdef VMS_WE_ARE_CASE_SENSITIVE
5348 " VMS_SYMBOL_CASE_AS_IS"
5352 EXTCONST char PL_bincompat_options[];
5355 #ifndef PERL_SET_PHASE
5356 # define PERL_SET_PHASE(new_phase) \
5357 PERL_DTRACE_PROBE_PHASE(new_phase); \
5358 PL_phase = new_phase;
5361 /* The interpreter phases. If these ever change, PL_phase_names right below will
5362 * need to be updated accordingly. */
5364 PERL_PHASE_CONSTRUCT = 0,
5365 PERL_PHASE_START = 1,
5366 PERL_PHASE_CHECK = 2,
5367 PERL_PHASE_INIT = 3,
5370 PERL_PHASE_DESTRUCT = 6
5374 EXTCONST char *const PL_phase_names[] = {
5384 EXTCONST char *const PL_phase_names[];
5388 /* Do not use this macro. It only exists for extensions that rely on PL_dirty
5389 * instead of using the newer PL_phase, which provides everything PL_dirty
5390 * provided, and more. */
5391 # define PL_dirty cBOOL(PL_phase == PERL_PHASE_DESTRUCT)
5393 # define PL_amagic_generation PL_na
5394 # define PL_encoding ((SV *)NULL)
5395 #endif /* !PERL_CORE */
5397 #define PL_hints PL_compiling.cop_hints
5398 #define PL_maxo MAXO
5402 /*****************************************************************************/
5403 /* This lexer/parser stuff is currently global since yacc is hard to reenter */
5404 /*****************************************************************************/
5405 /* XXX This needs to be revisited, since BEGIN makes yacc re-enter... */
5408 /* LynxOS defines these in scsi.h which is included via ioctl.h */
5417 #define LEX_NOTPARSING 11 /* borrowed from toke.c */
5425 XATTRBLOCK, /* next token should be an attribute or block */
5426 XATTRTERM, /* next token should be an attribute, or block in a term */
5430 XTERMORDORDOR /* evil hack */
5431 /* update exp_name[] in toke.c if adding to this enum */
5434 #define KEY_sigvar 0xFFFF /* fake keyword representing a signature var */
5436 /* Hints are now stored in a dedicated U32, so the bottom 8 bits are no longer
5437 special and there is no need for HINT_PRIVATE_MASK for COPs
5438 However, bitops store HINT_INTEGER in their op_private.
5440 NOTE: The typical module using these has the bit value hard-coded, so don't
5441 blindly change the values of these.
5443 If we run out of bits, the 2 locale ones could be combined. The PARTIAL one
5444 is for "use locale 'FOO'" which excludes some categories. It requires going
5445 to %^H to find out which are in and which are out. This could be extended
5446 for the normal case of a plain HINT_LOCALE, so that %^H would be used for
5448 #define HINT_INTEGER 0x00000001 /* integer pragma */
5449 #define HINT_STRICT_REFS 0x00000002 /* strict pragma */
5450 #define HINT_LOCALE 0x00000004 /* locale pragma */
5451 #define HINT_BYTES 0x00000008 /* bytes pragma */
5452 #define HINT_LOCALE_PARTIAL 0x00000010 /* locale, but a subset of categories */
5454 #define HINT_EXPLICIT_STRICT_REFS 0x00000020 /* strict.pm */
5455 #define HINT_EXPLICIT_STRICT_SUBS 0x00000040 /* strict.pm */
5456 #define HINT_EXPLICIT_STRICT_VARS 0x00000080 /* strict.pm */
5458 #define HINT_BLOCK_SCOPE 0x00000100
5459 #define HINT_STRICT_SUBS 0x00000200 /* strict pragma */
5460 #define HINT_STRICT_VARS 0x00000400 /* strict pragma */
5461 #define HINT_UNI_8_BIT 0x00000800 /* unicode_strings feature */
5463 /* The HINT_NEW_* constants are used by the overload pragma */
5464 #define HINT_NEW_INTEGER 0x00001000
5465 #define HINT_NEW_FLOAT 0x00002000
5466 #define HINT_NEW_BINARY 0x00004000
5467 #define HINT_NEW_STRING 0x00008000
5468 #define HINT_NEW_RE 0x00010000
5469 #define HINT_LOCALIZE_HH 0x00020000 /* %^H needs to be copied */
5470 #define HINT_LEXICAL_IO_IN 0x00040000 /* ${^OPEN} is set for input */
5471 #define HINT_LEXICAL_IO_OUT 0x00080000 /* ${^OPEN} is set for output */
5473 #define HINT_RE_TAINT 0x00100000 /* re pragma */
5474 #define HINT_RE_EVAL 0x00200000 /* re pragma */
5476 #define HINT_FILETEST_ACCESS 0x00400000 /* filetest pragma */
5477 #define HINT_UTF8 0x00800000 /* utf8 pragma */
5479 #define HINT_NO_AMAGIC 0x01000000 /* overloading pragma */
5481 #define HINT_RE_FLAGS 0x02000000 /* re '/xism' pragma */
5483 #define HINT_FEATURE_MASK 0x3c000000 /* 4 bits for feature bundles */
5485 /* Note: Used for HINT_M_VMSISH_*,
5486 currently defined by vms/vmsish.h:
5491 /* The following are stored in $^H{sort}, not in PL_hints */
5492 #define HINT_SORT_STABLE 0x00000100 /* sort styles */
5493 #define HINT_SORT_UNSTABLE 0x00000200
5495 #define HINT_ALL_STRICT HINT_STRICT_REFS \
5496 | HINT_STRICT_SUBS \
5499 #ifdef USE_STRICT_BY_DEFAULT
5500 #define HINTS_DEFAULT HINT_ALL_STRICT
5502 #define HINTS_DEFAULT 0
5505 /* flags for PL_sawampersand */
5507 #define SAWAMPERSAND_LEFT 1 /* saw $` */
5508 #define SAWAMPERSAND_MIDDLE 2 /* saw $& */
5509 #define SAWAMPERSAND_RIGHT 4 /* saw $' */
5511 #ifndef PERL_SAWAMPERSAND
5512 # define PL_sawampersand \
5513 (SAWAMPERSAND_LEFT|SAWAMPERSAND_MIDDLE|SAWAMPERSAND_RIGHT)
5516 /* Used for debugvar magic */
5517 #define DBVARMG_SINGLE 0
5518 #define DBVARMG_TRACE 1
5519 #define DBVARMG_SIGNAL 2
5520 #define DBVARMG_COUNT 3
5522 #define PL_DBsingle_iv (PL_DBcontrol[DBVARMG_SINGLE])
5523 #define PL_DBtrace_iv (PL_DBcontrol[DBVARMG_TRACE])
5524 #define PL_DBsignal_iv (PL_DBcontrol[DBVARMG_SIGNAL])
5526 /* Various states of the input record separator SV (rs) */
5527 #define RsSNARF(sv) (! SvOK(sv))
5528 #define RsSIMPLE(sv) (SvOK(sv) && (! SvPOK(sv) || SvCUR(sv)))
5529 #define RsPARA(sv) (SvPOK(sv) && ! SvCUR(sv))
5530 #define RsRECORD(sv) (SvROK(sv) && (SvIV(SvRV(sv)) > 0))
5532 /* A struct for keeping various DEBUGGING related stuff,
5533 * neatly packed. Currently only scratch variables for
5534 * constructing debug output are included. Needed always,
5535 * not just when DEBUGGING, though, because of the re extension. c*/
5536 struct perl_debug_pad {
5540 #define PERL_DEBUG_PAD(i) &(PL_debug_pad.pad[i])
5541 #define PERL_DEBUG_PAD_ZERO(i) (SvPVX(PERL_DEBUG_PAD(i))[0] = 0, \
5542 (((XPV*) SvANY(PERL_DEBUG_PAD(i)))->xpv_cur = 0), \
5545 /* Enable variables which are pointers to functions */
5546 typedef void (*peep_t)(pTHX_ OP* o);
5547 typedef regexp* (*regcomp_t) (pTHX_ char* exp, char* xend, PMOP* pm);
5548 typedef I32 (*regexec_t) (pTHX_ regexp* prog, char* stringarg,
5549 char* strend, char* strbeg, I32 minend,
5550 SV* screamer, void* data, U32 flags);
5551 typedef char* (*re_intuit_start_t) (pTHX_ regexp *prog, SV *sv,
5552 char *strpos, char *strend,
5554 re_scream_pos_data *d);
5555 typedef SV* (*re_intuit_string_t) (pTHX_ regexp *prog);
5556 typedef void (*regfree_t) (pTHX_ struct regexp* r);
5557 typedef regexp* (*regdupe_t) (pTHX_ const regexp* r, CLONE_PARAMS *param);
5558 typedef I32 (*re_fold_t)(const char *, char const *, I32);
5560 typedef void (*DESTRUCTORFUNC_NOCONTEXT_t) (void*);
5561 typedef void (*DESTRUCTORFUNC_t) (pTHX_ void*);
5562 typedef void (*SVFUNC_t) (pTHX_ SV* const);
5563 typedef I32 (*SVCOMPARE_t) (pTHX_ SV* const, SV* const);
5564 typedef void (*XSINIT_t) (pTHX);
5565 typedef void (*ATEXIT_t) (pTHX_ void*);
5566 typedef void (*XSUBADDR_t) (pTHX_ CV *);
5568 typedef OP* (*Perl_ppaddr_t)(pTHX);
5569 typedef OP* (*Perl_check_t) (pTHX_ OP*);
5570 typedef void(*Perl_ophook_t)(pTHX_ OP*);
5571 typedef int (*Perl_keyword_plugin_t)(pTHX_ char*, STRLEN, OP**);
5572 typedef void(*Perl_cpeep_t)(pTHX_ OP *, OP *);
5574 typedef void(*globhook_t)(pTHX);
5576 #define KEYWORD_PLUGIN_DECLINE 0
5577 #define KEYWORD_PLUGIN_STMT 1
5578 #define KEYWORD_PLUGIN_EXPR 2
5580 /* Interpreter exitlist entry */
5581 typedef struct exitlistentry {
5582 void (*fn) (pTHX_ void*);
5584 } PerlExitListEntry;
5586 /* if you only have signal() and it resets on each signal, FAKE_PERSISTENT_SIGNAL_HANDLERS fixes */
5587 /* These have to be before perlvars.h */
5588 #if !defined(HAS_SIGACTION) && defined(VMS)
5589 # define FAKE_PERSISTENT_SIGNAL_HANDLERS
5591 /* if we're doing kill() with sys$sigprc on VMS, FAKE_DEFAULT_SIGNAL_HANDLERS */
5592 #if defined(KILL_BY_SIGPRC)
5593 # define FAKE_DEFAULT_SIGNAL_HANDLERS
5596 #if !defined(MULTIPLICITY)
5598 struct interpreter {
5604 /* If we have multiple interpreters define a struct
5605 holding variables which must be per-interpreter
5606 If we don't have threads anything that would have
5607 be per-thread is per-interpreter.
5610 /* Set up PERLVAR macros for populating structs */
5611 # define PERLVAR(prefix,var,type) type prefix##var;
5613 /* 'var' is an array of length 'n' */
5614 # define PERLVARA(prefix,var,n,type) type prefix##var[n];
5616 /* initialize 'var' to init' */
5617 # define PERLVARI(prefix,var,type,init) type prefix##var;
5619 /* like PERLVARI, but make 'var' a const */
5620 # define PERLVARIC(prefix,var,type,init) type prefix##var;
5622 struct interpreter {
5623 # include "intrpvar.h"
5626 EXTCONST U16 PL_interp_size
5627 INIT(sizeof(struct interpreter));
5629 # define PERL_INTERPRETER_SIZE_UPTO_MEMBER(member) \
5630 STRUCT_OFFSET(struct interpreter, member) + \
5631 sizeof(((struct interpreter*)0)->member)
5633 /* This will be useful for subsequent releases, because this has to be the
5634 same in your libperl as in main(), else you have a mismatch and must abort.
5636 EXTCONST U16 PL_interp_size_5_18_0
5637 INIT(PERL_INTERPRETER_SIZE_UPTO_MEMBER(PERL_LAST_5_18_0_INTERP_MEMBER));
5640 /* Done with PERLVAR macros for now ... */
5646 #endif /* MULTIPLICITY */
5648 struct tempsym; /* defined in pp_pack.c */
5655 #define PERL_CKDEF(s) PERL_CALLCONV OP *s (pTHX_ OP *o);
5656 #define PERL_PPDEF(s) PERL_CALLCONV OP *s (pTHX);
5659 # include "malloc_ctl.h"
5663 * This provides a layer of functions and macros to ensure extensions will
5664 * get to use the same RTL functions as the core.
5667 # include "win32iop.h"
5673 /* this has structure inits, so it cannot be included before here */
5676 /* The following must follow proto.h as #defines mess up syntax */
5678 #if !defined(PERL_FOR_X2P)
5679 # include "embedvar.h"
5682 /* Now include all the 'global' variables
5683 * If we don't have threads or multiple interpreters
5684 * these include variables that would have been their struct-s
5687 #define PERLVAR(prefix,var,type) EXT type PL_##var;
5688 #define PERLVARA(prefix,var,n,type) EXT type PL_##var[n];
5689 #define PERLVARI(prefix,var,type,init) EXT type PL_##var INIT(init);
5690 #define PERLVARIC(prefix,var,type,init) EXTCONST type PL_##var INIT(init);
5692 #if !defined(MULTIPLICITY)
5694 # include "intrpvar.h"
5696 # define PL_sv_yes (PL_sv_immortals[0])
5697 # define PL_sv_undef (PL_sv_immortals[1])
5698 # define PL_sv_no (PL_sv_immortals[2])
5699 # define PL_sv_zero (PL_sv_immortals[3])
5703 /* All core uses now exterminated. Ensure no zombies can return: */
5707 /* Now all the config stuff is setup we can include embed.h
5708 In particular, need the relevant *ish file included already, as it may
5709 define HAVE_INTERP_INTERN */
5714 # include "perlvars.h"
5723 #if !defined(MULTIPLICITY)
5724 /* Set up PERLVAR macros for populating structs */
5725 # define PERLVAR(prefix,var,type) type prefix##var;
5726 /* 'var' is an array of length 'n' */
5727 # define PERLVARA(prefix,var,n,type) type prefix##var[n];
5728 /* initialize 'var' to init' */
5729 # define PERLVARI(prefix,var,type,init) type prefix##var;
5730 /* like PERLVARI, but make 'var' a const */
5731 # define PERLVARIC(prefix,var,type,init) type prefix##var;
5733 /* this is never instantiated, is it just used for sizeof(struct PerlHandShakeInterpreter) */
5734 struct PerlHandShakeInterpreter {
5735 # include "intrpvar.h"
5745 /* dummy variables that hold pointers to both runops functions, thus forcing
5746 * them *both* to get linked in (useful for Peek.xs, debugging etc) */
5748 EXTCONST runops_proc_t PL_runops_std
5749 INIT(Perl_runops_standard);
5750 EXTCONST runops_proc_t PL_runops_dbg
5751 INIT(Perl_runops_debug);
5753 #define EXT_MGVTBL EXTCONST MGVTBL
5755 #define PERL_MAGIC_READONLY_ACCEPTABLE 0x40
5756 #define PERL_MAGIC_VALUE_MAGIC 0x80
5757 #define PERL_MAGIC_VTABLE_MASK 0x3F
5759 /* can this type of magic be attached to a readonly SV? */
5760 #define PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(t) \
5761 (PL_magic_data[(U8)(t)] & PERL_MAGIC_READONLY_ACCEPTABLE)
5763 /* Is this type of magic container magic (%ENV, $1 etc),
5764 * or value magic (pos, taint etc)?
5766 #define PERL_MAGIC_TYPE_IS_VALUE_MAGIC(t) \
5767 (PL_magic_data[(U8)(t)] & PERL_MAGIC_VALUE_MAGIC)
5769 #include "mg_vtable.h"
5772 EXTCONST U8 PL_magic_data[256] =
5774 # include "umg_data.h"
5776 # include "mg_data.h"
5780 EXTCONST U8 PL_magic_data[256];
5784 /* NL IV NV PV INV PI PN MG RX GV LV AV HV CV FM IO */
5786 PL_valid_types_IVX[] = { 0, 1, 0, 0, 0, 1, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5788 PL_valid_types_NVX[] = { 0, 0, 1, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5790 PL_valid_types_PVX[] = { 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1 };
5792 PL_valid_types_RV[] = { 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1 };
5794 PL_valid_types_IV_set[] = { 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1 };
5796 PL_valid_types_NV_set[] = { 0, 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0 };
5800 EXTCONST bool PL_valid_types_IVX[];
5801 EXTCONST bool PL_valid_types_NVX[];
5802 EXTCONST bool PL_valid_types_PVX[];
5803 EXTCONST bool PL_valid_types_RV[];
5804 EXTCONST bool PL_valid_types_IV_set[];
5805 EXTCONST bool PL_valid_types_NV_set[];
5809 /* In C99 we could use designated (named field) union initializers.
5810 * In C89 we need to initialize the member declared first.
5811 * In C++ we need extern C initializers.
5813 * With the U8_NV version you will want to have inner braces,
5814 * while with the NV_U8 use just the NV. */
5816 #define INFNAN_U8_NV_DECL EXTCONST union { U8 u8[NVSIZE]; NV nv; }
5817 #define INFNAN_NV_U8_DECL EXTCONST union { NV nv; U8 u8[NVSIZE]; }
5819 /* if these never got defined, they need defaults */
5820 #ifndef PERL_SET_CONTEXT
5821 # define PERL_SET_CONTEXT(i) PERL_SET_INTERP(i)
5824 #ifndef PERL_GET_CONTEXT
5825 # define PERL_GET_CONTEXT PERL_GET_INTERP
5828 #ifndef PERL_GET_THX
5829 # define PERL_GET_THX ((void*)NULL)
5832 #ifndef PERL_SET_THX
5833 # define PERL_SET_THX(t) NOOP
5838 /* The tables below are adapted from
5839 * https://bjoern.hoehrmann.de/utf-8/decoder/dfa/, which requires this copyright
5842 Copyright (c) 2008-2009 Bjoern Hoehrmann <bjoern@hoehrmann.de>
5844 Permission is hereby granted, free of charge, to any person obtaining a copy of
5845 this software and associated documentation files (the "Software"), to deal in
5846 the Software without restriction, including without limitation the rights to
5847 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
5848 of the Software, and to permit persons to whom the Software is furnished to do
5849 so, subject to the following conditions:
5851 The above copyright notice and this permission notice shall be included in all
5852 copies or substantial portions of the Software.
5854 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
5855 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
5856 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
5857 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
5858 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
5859 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
5865 # if 0 /* This is the original table given in
5866 https://bjoern.hoehrmann.de/utf-8/decoder/dfa/ */
5867 static U8 utf8d_C9[] = {
5868 /* The first part of the table maps bytes to character classes that
5869 * to reduce the size of the transition table and create bitmasks. */
5870 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /*-1F*/
5871 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /*-3F*/
5872 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /*-5F*/
5873 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /*-7F*/
5874 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, /*-9F*/
5875 7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7, 7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7, /*-BF*/
5876 8,8,2,2,2,2,2,2,2,2,2,2,2,2,2,2, 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2, /*-DF*/
5877 10,3,3,3,3,3,3,3,3,3,3,3,3,4,3,3, 11,6,6,6,5,8,8,8,8,8,8,8,8,8,8,8, /*-FF*/
5879 /* The second part is a transition table that maps a combination
5880 * of a state of the automaton and a character class to a state. */
5881 0,12,24,36,60,96,84,12,12,12,48,72, 12,12,12,12,12,12,12,12,12,12,12,12,
5882 12, 0,12,12,12,12,12, 0,12, 0,12,12, 12,24,12,12,12,12,12,24,12,24,12,12,
5883 12,12,12,12,12,12,12,24,12,12,12,12, 12,24,12,12,12,12,12,12,12,24,12,12,
5884 12,12,12,12,12,12,12,36,12,36,12,12, 12,36,12,12,12,12,12,36,12,36,12,12,
5885 12,36,12,12,12,12,12,12,12,12,12,12
5890 /* This is a version of the above table customized for Perl that doesn't
5891 * exclude surrogates and accepts start bytes up through FD (FE on 64-bit
5892 * machines). The classes have been renumbered so that the patterns are more
5893 * evident in the table. The class numbers for start bytes are constrained so
5894 * that they can be used as a shift count for masking off the leading one bits.
5895 * It would make the code simpler if start byte FF could also be handled, but
5896 * doing so would mean adding nodes for each of continuation bytes 6-12
5897 * remaining, and two more nodes for overlong detection (a total of 9), and
5898 * there is room only for 4 more nodes unless we make the array U16 instead of
5903 * 80-81 7 Not legal immediately after start bytes E0 F0 F8 FC
5905 * 82-83 8 Not legal immediately after start bytes E0 F0 F8 FC
5906 * 84-87 9 Not legal immediately after start bytes E0 F0 F8
5907 * 88-8F 10 Not legal immediately after start bytes E0 F0
5908 * 90-9F 11 Not legal immediately after start byte E0
5920 * FE 17 (or 1 on 32-bit machines, since it overflows)
5924 EXTCONST U8 PL_extended_utf8_dfa_tab[] = {
5925 /* The first part of the table maps bytes to character classes to reduce
5926 * the size of the transition table and create bitmasks. */
5927 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*00-0F*/
5928 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*10-1F*/
5929 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*20-2F*/
5930 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*30-3F*/
5931 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*40-4F*/
5932 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*50-5F*/
5933 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*60-6F*/
5934 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*70-7F*/
5935 7, 7, 8, 8, 9, 9, 9, 9,10,10,10,10,10,10,10,10, /*80-8F*/
5936 11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11, /*90-9F*/
5937 12,12,12,12,12,12,12,12,12,12,12,12,12,12,12,12, /*A0-AF*/
5938 12,12,12,12,12,12,12,12,12,12,12,12,12,12,12,12, /*B0-BF*/
5939 1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*C0-CF*/
5940 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*D0-DF*/
5941 13, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, /*E0-EF*/
5942 14, 4, 4, 4, 4, 4, 4, 4,15, 5, 5, 5,16, 6, /*F0-FD*/
5950 /* The second part is a transition table that maps a combination
5951 * of a state of the automaton and a character class to a new state, called a
5952 * node. The nodes are:
5953 * N0 The initial state, and final accepting one.
5954 * N1 Any one continuation byte (80-BF) left. This is transitioned to
5955 * immediately when the start byte indicates a two-byte sequence
5956 * N2 Any two continuation bytes left.
5957 * N3 Any three continuation bytes left.
5958 * N4 Any four continuation bytes left.
5959 * N5 Any five continuation bytes left.
5960 * N6 Start byte is E0. Continuation bytes 80-9F are illegal (overlong);
5961 * the other continuations transition to N1
5962 * N7 Start byte is F0. Continuation bytes 80-8F are illegal (overlong);
5963 * the other continuations transition to N2
5964 * N8 Start byte is F8. Continuation bytes 80-87 are illegal (overlong);
5965 * the other continuations transition to N3
5966 * N9 Start byte is FC. Continuation bytes 80-83 are illegal (overlong);
5967 * the other continuations transition to N4
5968 * N10 Start byte is FE. Continuation bytes 80-81 are illegal (overlong);
5969 * the other continuations transition to N5
5970 * 1 Reject. All transitions not mentioned above (except the single
5971 * byte ones (as they are always legal) are to this state.
5974 # if defined(PERL_CORE)
5975 # define NUM_CLASSES 18
5977 # define N1 ((N0) + NUM_CLASSES)
5978 # define N2 ((N1) + NUM_CLASSES)
5979 # define N3 ((N2) + NUM_CLASSES)
5980 # define N4 ((N3) + NUM_CLASSES)
5981 # define N5 ((N4) + NUM_CLASSES)
5982 # define N6 ((N5) + NUM_CLASSES)
5983 # define N7 ((N6) + NUM_CLASSES)
5984 # define N8 ((N7) + NUM_CLASSES)
5985 # define N9 ((N8) + NUM_CLASSES)
5986 # define N10 ((N9) + NUM_CLASSES)
5988 /*Class: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 */
5989 /*N0*/ 0, 1,N1,N2,N3,N4,N5, 1, 1, 1, 1, 1, 1,N6,N7,N8,N9,N10,
5990 /*N1*/ 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1,
5991 /*N2*/ 1, 1, 1, 1, 1, 1, 1,N1,N1,N1,N1,N1,N1, 1, 1, 1, 1, 1,
5992 /*N3*/ 1, 1, 1, 1, 1, 1, 1,N2,N2,N2,N2,N2,N2, 1, 1, 1, 1, 1,
5993 /*N4*/ 1, 1, 1, 1, 1, 1, 1,N3,N3,N3,N3,N3,N3, 1, 1, 1, 1, 1,
5994 /*N5*/ 1, 1, 1, 1, 1, 1, 1,N4,N4,N4,N4,N4,N4, 1, 1, 1, 1, 1,
5996 /*N6*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,N1, 1, 1, 1, 1, 1,
5997 /*N7*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,N2,N2, 1, 1, 1, 1, 1,
5998 /*N8*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,N3,N3,N3, 1, 1, 1, 1, 1,
5999 /*N9*/ 1, 1, 1, 1, 1, 1, 1, 1, 1,N4,N4,N4,N4, 1, 1, 1, 1, 1,
6000 /*N10*/ 1, 1, 1, 1, 1, 1, 1, 1,N5,N5,N5,N5,N5, 1, 1, 1, 1, 1,
6003 /* And below is a version of the above table that accepts only strict UTF-8.
6004 * Hence no surrogates nor non-characters, nor non-Unicode. Thus, if the input
6005 * passes this dfa, it will be for a well-formed, non-problematic code point
6006 * that can be returned immediately.
6008 * The "Implementation details" portion of
6009 * https://bjoern.hoehrmann.de/utf-8/decoder/dfa/ shows how
6010 * the first portion of the table maps each possible byte into a character
6011 * class. And that the classes for those bytes which are start bytes have been
6012 * carefully chosen so they serve as well to be used as a shift value to mask
6013 * off the leading 1 bits of the start byte. Unfortunately the addition of
6014 * being able to distinguish non-characters makes this not fully work. This is
6015 * because, now, the start bytes E1-EF have to be broken into 3 classes instead
6017 * 1) ED because it could be a surrogate
6018 * 2) EF because it could be a non-character
6019 * 3) the rest, which can never evaluate to a problematic code point.
6021 * Each of E1-EF has three leading 1 bits, then a 0. That means we could use a
6022 * shift (and hence class number) of either 3 or 4 to get a mask that works.
6023 * But that only allows two categories, and we need three. khw made the
6024 * decision to therefore treat the ED start byte as an error, so that the dfa
6025 * drops out immediately for that. In the dfa, classes 3 and 4 are used to
6026 * distinguish EF vs the rest. Then special code is used to deal with ED,
6027 * that's executed only when the dfa drops out. The code points started by ED
6028 * are half surrogates, and half hangul syllables. This means that 2048 of
6029 * the hangul syllables (about 18%) take longer than all other non-problematic
6030 * code points to handle.
6032 * The changes to handle non-characters requires the addition of states and
6033 * classes to the dfa. (See the section on "Mapping bytes to character
6034 * classes" in the linked-to document for further explanation of the original
6058 * F1-F3 6 (6 bits can be stripped)
6059 * F4 5 (only 5 can be stripped)
6063 EXTCONST U8 PL_strict_utf8_dfa_tab[] = {
6064 /* The first part of the table maps bytes to character classes to reduce
6065 * the size of the transition table and create bitmasks. */
6066 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*00-0F*/
6067 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*10-1F*/
6068 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*20-2F*/
6069 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*30-3F*/
6070 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*40-4F*/
6071 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*50-5F*/
6072 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*60-6F*/
6073 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*70-7F*/
6074 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9,10, /*80-8F*/
6075 11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,12, /*90-9F*/
6076 13,13,13,13,13,13,13,13,13,13,13,13,13,13,13,14, /*A0-AF*/
6077 15,15,15,15,15,15,15,16,15,15,15,15,15,15,17,18, /*B0-BF*/
6078 1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*C0-CF*/
6079 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*D0-DF*/
6080 7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 1, 3, 4, /*E0-EF*/
6081 8, 6, 6, 6, 5, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /*F0-FF*/
6083 /* The second part is a transition table that maps a combination
6084 * of a state of the automaton and a character class to a new state, called a
6085 * node. The nodes are:
6086 * N0 The initial state, and final accepting one.
6087 * N1 Any one continuation byte (80-BF) left. This is transitioned to
6088 * immediately when the start byte indicates a two-byte sequence
6089 * N2 Any two continuation bytes left.
6090 * N3 Start byte is E0. Continuation bytes 80-9F are illegal (overlong);
6091 * the other continuations transition to state N1
6092 * N4 Start byte is EF. Continuation byte B7 transitions to N8; BF to N9;
6093 * the other continuations transitions to N1
6094 * N5 Start byte is F0. Continuation bytes 80-8F are illegal (overlong);
6095 * [9AB]F transition to N10; the other continuations to N2.
6096 * N6 Start byte is F[123]. Continuation bytes [89AB]F transition
6097 * to N10; the other continuations to N2.
6098 * N7 Start byte is F4. Continuation bytes 90-BF are illegal
6099 * (non-unicode); 8F transitions to N10; the other continuations to N2
6100 * N8 Initial sequence is EF B7. Continuation bytes 90-AF are illegal
6101 * (non-characters); the other continuations transition to N0.
6102 * N9 Initial sequence is EF BF. Continuation bytes BE and BF are illegal
6103 * (non-characters); the other continuations transition to N0.
6104 * N10 Initial sequence is one of: F0 [9-B]F; F[123] [8-B]F; or F4 8F.
6105 * Continuation byte BF transitions to N11; the other continuations to
6107 * N11 Initial sequence is the two bytes given in N10 followed by BF.
6108 * Continuation bytes BE and BF are illegal (non-characters); the other
6109 * continuations transition to N0.
6110 * 1 Reject. All transitions not mentioned above (except the single
6111 * byte ones (as they are always legal) are to this state.
6125 # define NUM_CLASSES 19
6127 # define N1 ((N0) + NUM_CLASSES)
6128 # define N2 ((N1) + NUM_CLASSES)
6129 # define N3 ((N2) + NUM_CLASSES)
6130 # define N4 ((N3) + NUM_CLASSES)
6131 # define N5 ((N4) + NUM_CLASSES)
6132 # define N6 ((N5) + NUM_CLASSES)
6133 # define N7 ((N6) + NUM_CLASSES)
6134 # define N8 ((N7) + NUM_CLASSES)
6135 # define N9 ((N8) + NUM_CLASSES)
6136 # define N10 ((N9) + NUM_CLASSES)
6137 # define N11 ((N10) + NUM_CLASSES)
6139 /*Class: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 */
6140 /*N0*/ 0, 1, N1, N2, N4, N7, N6, N3, N5, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
6141 /*N1*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6142 /*N2*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N1, N1, N1, N1, N1, N1, N1, N1, N1, N1,
6144 /*N3*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, N1, N1, N1, N1, N1, N1,
6145 /*N4*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N1, N1, N1, N1, N1, N1, N1, N8, N1, N9,
6146 /*N5*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, N2,N10, N2,N10, N2, N2, N2,N10,
6147 /*N6*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N2,N10, N2,N10, N2,N10, N2, N2, N2,N10,
6148 /*N7*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N2,N10, 1, 1, 1, 1, 1, 1, 1, 1,
6149 /*N8*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0,
6150 /*N9*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1,
6151 /*N10*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N1, N1, N1, N1, N1, N1, N1, N1, N1,N11,
6152 /*N11*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1,
6155 /* And below is yet another version of the above tables that accepts only UTF-8
6156 * as defined by Corregidum #9. Hence no surrogates nor non-Unicode, but
6157 * it allows non-characters. This is isomorphic to the original table
6158 * in https://bjoern.hoehrmann.de/utf-8/decoder/dfa/
6172 * F1-F3 6 (6 bits can be stripped)
6173 * F4 5 (only 5 can be stripped)
6177 EXTCONST U8 PL_c9_utf8_dfa_tab[] = {
6178 /* The first part of the table maps bytes to character classes to reduce
6179 * the size of the transition table and create bitmasks. */
6180 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*00-0F*/
6181 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*10-1F*/
6182 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*20-2F*/
6183 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*30-3F*/
6184 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*40-4F*/
6185 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*50-5F*/
6186 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*60-6F*/
6187 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*70-7F*/
6188 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, /*80-8F*/
6189 10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10, /*90-9F*/
6190 11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11, /*A0-AF*/
6191 11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11, /*B0-BF*/
6192 1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*C0-CF*/
6193 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*D0-DF*/
6194 7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 4, 3, 3, /*E0-EF*/
6195 8, 6, 6, 6, 5, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /*F0-FF*/
6197 /* The second part is a transition table that maps a combination
6198 * of a state of the automaton and a character class to a new state, called a
6199 * node. The nodes are:
6200 * N0 The initial state, and final accepting one.
6201 * N1 Any one continuation byte (80-BF) left. This is transitioned to
6202 * immediately when the start byte indicates a two-byte sequence
6203 * N2 Any two continuation bytes left.
6204 * N3 Any three continuation bytes left.
6205 * N4 Start byte is E0. Continuation bytes 80-9F are illegal (overlong);
6206 * the other continuations transition to state N1
6207 * N5 Start byte is ED. Continuation bytes A0-BF all lead to surrogates,
6208 * so are illegal. The other continuations transition to state N1.
6209 * N6 Start byte is F0. Continuation bytes 80-8F are illegal (overlong);
6210 * the other continuations transition to N2
6211 * N7 Start byte is F4. Continuation bytes 90-BF are illegal
6212 * (non-unicode); the other continuations transition to N2
6213 * 1 Reject. All transitions not mentioned above (except the single
6214 * byte ones (as they are always legal) are to this state.
6226 # define NUM_CLASSES 12
6228 # define N1 ((N0) + NUM_CLASSES)
6229 # define N2 ((N1) + NUM_CLASSES)
6230 # define N3 ((N2) + NUM_CLASSES)
6231 # define N4 ((N3) + NUM_CLASSES)
6232 # define N5 ((N4) + NUM_CLASSES)
6233 # define N6 ((N5) + NUM_CLASSES)
6234 # define N7 ((N6) + NUM_CLASSES)
6236 /*Class: 0 1 2 3 4 5 6 7 8 9 10 11 */
6237 /*N0*/ 0, 1, N1, N2, N5, N7, N3, N4, N6, 1, 1, 1,
6238 /*N1*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0,
6239 /*N2*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N1, N1, N1,
6240 /*N3*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N2, N2, N2,
6242 /*N4*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, N1,
6243 /*N5*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N1, N1, 1,
6244 /*N6*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, N2, N2,
6245 /*N7*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N2, 1, 1,
6248 # endif /* defined(PERL_CORE) */
6249 # else /* End of is DOINIT */
6251 EXTCONST U8 PL_extended_utf8_dfa_tab[];
6252 EXTCONST U8 PL_strict_utf8_dfa_tab[];
6253 EXTCONST U8 PL_c9_utf8_dfa_tab[];
6256 #endif /* end of isn't EBCDIC */
6258 #ifndef PERL_NO_INLINE_FUNCTIONS
6259 /* Static inline funcs that depend on includes and declarations above.
6260 Some of these reference functions in the perl object files, and some
6261 compilers aren't smart enough to eliminate unused static inline
6262 functions, so including this file in source code can cause link errors
6263 even if the source code uses none of the functions. Hence including these
6264 can be suppressed by setting PERL_NO_INLINE_FUNCTIONS. Doing this will
6265 (obviously) result in unworkable XS code, but allows simple probing code
6266 to continue to work, because it permits tests to include the perl headers
6267 for definitions without creating a link dependency on the perl library
6268 (which may not exist yet).
6271 # include "inline.h"
6274 #include "overload.h"
6283 CV* table[NofAMmeth];
6285 struct am_table_short {
6291 typedef struct am_table AMT;
6292 typedef struct am_table_short AMTS;
6294 #define AMGfallNEVER 1
6296 #define AMGfallYES 3
6298 #define AMTf_AMAGIC 1
6299 #define AMT_AMAGIC(amt) ((amt)->flags & AMTf_AMAGIC)
6300 #define AMT_AMAGIC_on(amt) ((amt)->flags |= AMTf_AMAGIC)
6301 #define AMT_AMAGIC_off(amt) ((amt)->flags &= ~AMTf_AMAGIC)
6303 #define StashHANDLER(stash,meth) gv_handler((stash),CAT2(meth,_amg))
6306 * some compilers like to redefine cos et alia as faster
6307 * (and less accurate?) versions called F_cos et cetera (Quidquid
6308 * latine dictum sit, altum viditur.) This trick collides with
6309 * the Perl overloading (amg). The following #defines fool both.
6314 # define F_atan2_amg atan2_amg
6317 # define F_cos_amg cos_amg
6320 # define F_exp_amg exp_amg
6323 # define F_log_amg log_amg
6326 # define F_pow_amg pow_amg
6329 # define F_sin_amg sin_amg
6332 # define F_sqrt_amg sqrt_amg
6334 #endif /* _FASTMATH */
6336 #define PERLDB_ALL (PERLDBf_SUB | PERLDBf_LINE | \
6337 PERLDBf_NOOPT | PERLDBf_INTER | \
6338 PERLDBf_SUBLINE| PERLDBf_SINGLE| \
6339 PERLDBf_NAMEEVAL| PERLDBf_NAMEANON | \
6341 /* No _NONAME, _GOTO */
6342 #define PERLDBf_SUB 0x01 /* Debug sub enter/exit */
6343 #define PERLDBf_LINE 0x02 /* Keep line # */
6344 #define PERLDBf_NOOPT 0x04 /* Switch off optimizations */
6345 #define PERLDBf_INTER 0x08 /* Preserve more data for
6346 later inspections */
6347 #define PERLDBf_SUBLINE 0x10 /* Keep subr source lines */
6348 #define PERLDBf_SINGLE 0x20 /* Start with single-step on */
6349 #define PERLDBf_NONAME 0x40 /* For _SUB: no name of the subr */
6350 #define PERLDBf_GOTO 0x80 /* Report goto: call DB::goto */
6351 #define PERLDBf_NAMEEVAL 0x100 /* Informative names for evals */
6352 #define PERLDBf_NAMEANON 0x200 /* Informative names for anon subs */
6353 #define PERLDBf_SAVESRC 0x400 /* Save source lines into @{"_<$filename"} */
6354 #define PERLDBf_SAVESRC_NOSUBS 0x800 /* Including evals that generate no subroutines */
6355 #define PERLDBf_SAVESRC_INVALID 0x1000 /* Save source that did not compile */
6357 #define PERLDB_SUB (PL_perldb & PERLDBf_SUB)
6358 #define PERLDB_LINE (PL_perldb & PERLDBf_LINE)
6359 #define PERLDB_NOOPT (PL_perldb & PERLDBf_NOOPT)
6360 #define PERLDB_INTER (PL_perldb & PERLDBf_INTER)
6361 #define PERLDB_SUBLINE (PL_perldb & PERLDBf_SUBLINE)
6362 #define PERLDB_SINGLE (PL_perldb & PERLDBf_SINGLE)
6363 #define PERLDB_SUB_NN (PL_perldb & PERLDBf_NONAME)
6364 #define PERLDB_GOTO (PL_perldb & PERLDBf_GOTO)
6365 #define PERLDB_NAMEEVAL (PL_perldb & PERLDBf_NAMEEVAL)
6366 #define PERLDB_NAMEANON (PL_perldb & PERLDBf_NAMEANON)
6367 #define PERLDB_SAVESRC (PL_perldb & PERLDBf_SAVESRC)
6368 #define PERLDB_SAVESRC_NOSUBS (PL_perldb & PERLDBf_SAVESRC_NOSUBS)
6369 #define PERLDB_SAVESRC_INVALID (PL_perldb & PERLDBf_SAVESRC_INVALID)
6371 #define PERLDB_LINE_OR_SAVESRC (PL_perldb & (PERLDBf_LINE | PERLDBf_SAVESRC))
6374 # define KEYWORD_PLUGIN_MUTEX_INIT MUTEX_INIT(&PL_keyword_plugin_mutex)
6375 # define KEYWORD_PLUGIN_MUTEX_LOCK MUTEX_LOCK(&PL_keyword_plugin_mutex)
6376 # define KEYWORD_PLUGIN_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_keyword_plugin_mutex)
6377 # define KEYWORD_PLUGIN_MUTEX_TERM MUTEX_DESTROY(&PL_keyword_plugin_mutex)
6378 # define USER_PROP_MUTEX_INIT MUTEX_INIT(&PL_user_prop_mutex)
6379 # define USER_PROP_MUTEX_LOCK MUTEX_LOCK(&PL_user_prop_mutex)
6380 # define USER_PROP_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_user_prop_mutex)
6381 # define USER_PROP_MUTEX_TERM MUTEX_DESTROY(&PL_user_prop_mutex)
6383 # define KEYWORD_PLUGIN_MUTEX_INIT NOOP
6384 # define KEYWORD_PLUGIN_MUTEX_LOCK NOOP
6385 # define KEYWORD_PLUGIN_MUTEX_UNLOCK NOOP
6386 # define KEYWORD_PLUGIN_MUTEX_TERM NOOP
6387 # define USER_PROP_MUTEX_INIT NOOP
6388 # define USER_PROP_MUTEX_LOCK NOOP
6389 # define USER_PROP_MUTEX_UNLOCK NOOP
6390 # define USER_PROP_MUTEX_TERM NOOP
6393 #ifdef USE_LOCALE /* These locale things are all subject to change */
6395 /* Returns TRUE if the plain locale pragma without a parameter is in effect.
6397 # define IN_LOCALE_RUNTIME (PL_curcop \
6398 && CopHINTS_get(PL_curcop) & HINT_LOCALE)
6400 /* Returns TRUE if either form of the locale pragma is in effect */
6401 # define IN_SOME_LOCALE_FORM_RUNTIME \
6402 cBOOL(CopHINTS_get(PL_curcop) & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
6404 # define IN_LOCALE_COMPILETIME cBOOL(PL_hints & HINT_LOCALE)
6405 # define IN_SOME_LOCALE_FORM_COMPILETIME \
6406 cBOOL(PL_hints & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
6409 =for apidoc_section $locale
6411 =for apidoc Amn|bool|IN_LOCALE
6413 Evaluates to TRUE if the plain locale pragma without a parameter (S<C<use
6414 locale>>) is in effect.
6416 =for apidoc Amn|bool|IN_LOCALE_COMPILETIME
6418 Evaluates to TRUE if, when compiling a perl program (including an C<eval>) if
6419 the plain locale pragma without a parameter (S<C<use locale>>) is in effect.
6421 =for apidoc Amn|bool|IN_LOCALE_RUNTIME
6423 Evaluates to TRUE if, when executing a perl program (including an C<eval>) if
6424 the plain locale pragma without a parameter (S<C<use locale>>) is in effect.
6429 # define IN_LOCALE \
6430 (IN_PERL_COMPILETIME ? IN_LOCALE_COMPILETIME : IN_LOCALE_RUNTIME)
6431 # define IN_SOME_LOCALE_FORM \
6432 (IN_PERL_COMPILETIME ? IN_SOME_LOCALE_FORM_COMPILETIME \
6433 : IN_SOME_LOCALE_FORM_RUNTIME)
6435 # define IN_LC_ALL_COMPILETIME IN_LOCALE_COMPILETIME
6436 # define IN_LC_ALL_RUNTIME IN_LOCALE_RUNTIME
6438 # define IN_LC_PARTIAL_COMPILETIME cBOOL(PL_hints & HINT_LOCALE_PARTIAL)
6439 # define IN_LC_PARTIAL_RUNTIME \
6440 (PL_curcop && CopHINTS_get(PL_curcop) & HINT_LOCALE_PARTIAL)
6442 # define IN_LC_COMPILETIME(category) \
6443 ( IN_LC_ALL_COMPILETIME \
6444 || ( IN_LC_PARTIAL_COMPILETIME \
6445 && Perl__is_in_locale_category(aTHX_ TRUE, (category))))
6446 # define IN_LC_RUNTIME(category) \
6447 (IN_LC_ALL_RUNTIME || (IN_LC_PARTIAL_RUNTIME \
6448 && Perl__is_in_locale_category(aTHX_ FALSE, (category))))
6449 # define IN_LC(category) \
6450 (IN_LC_COMPILETIME(category) || IN_LC_RUNTIME(category))
6452 # if defined (PERL_CORE) || defined (PERL_IN_XSUB_RE)
6454 /* This internal macro should be called from places that operate under
6455 * locale rules. If there is a problem with the current locale that
6456 * hasn't been raised yet, it will output a warning this time. Because
6457 * this will so rarely be true, there is no point to optimize for time;
6458 * instead it makes sense to minimize space used and do all the work in
6459 * the rarely called function */
6460 # ifdef USE_LOCALE_CTYPE
6461 # define _CHECK_AND_WARN_PROBLEMATIC_LOCALE \
6463 if (UNLIKELY(PL_warn_locale)) { \
6464 Perl__warn_problematic_locale(); \
6468 # define _CHECK_AND_WARN_PROBLEMATIC_LOCALE
6472 /* These two internal macros are called when a warning should be raised,
6473 * and will do so if enabled. The first takes a single code point
6474 * argument; the 2nd, is a pointer to the first byte of the UTF-8 encoded
6475 * string, and an end position which it won't try to read past */
6476 # define _CHECK_AND_OUTPUT_WIDE_LOCALE_CP_MSG(cp) \
6478 if (! PL_in_utf8_CTYPE_locale && ckWARN(WARN_LOCALE)) { \
6479 Perl_warner(aTHX_ packWARN(WARN_LOCALE), \
6480 "Wide character (U+%" UVXf ") in %s",\
6481 (UV) cp, OP_DESC(PL_op)); \
6485 # define _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(s, send) \
6486 STMT_START { /* Check if to warn before doing the conversion work */\
6487 if (! PL_in_utf8_CTYPE_locale && ckWARN(WARN_LOCALE)) { \
6488 UV cp = utf8_to_uvchr_buf((U8 *) (s), (U8 *) (send), NULL); \
6489 Perl_warner(aTHX_ packWARN(WARN_LOCALE), \
6490 "Wide character (U+%" UVXf ") in %s", \
6492 ? UNICODE_REPLACEMENT \
6498 # endif /* PERL_CORE or PERL_IN_XSUB_RE */
6499 #else /* No locale usage */
6500 # define IN_LOCALE_RUNTIME 0
6501 # define IN_SOME_LOCALE_FORM_RUNTIME 0
6502 # define IN_LOCALE_COMPILETIME 0
6503 # define IN_SOME_LOCALE_FORM_COMPILETIME 0
6504 # define IN_LOCALE 0
6505 # define IN_SOME_LOCALE_FORM 0
6506 # define IN_LC_ALL_COMPILETIME 0
6507 # define IN_LC_ALL_RUNTIME 0
6508 # define IN_LC_PARTIAL_COMPILETIME 0
6509 # define IN_LC_PARTIAL_RUNTIME 0
6510 # define IN_LC_COMPILETIME(category) 0
6511 # define IN_LC_RUNTIME(category) 0
6512 # define IN_LC(category) 0
6513 # define _CHECK_AND_WARN_PROBLEMATIC_LOCALE
6514 # define _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(s, send)
6515 # define _CHECK_AND_OUTPUT_WIDE_LOCALE_CP_MSG(c)
6519 /* Locale/thread synchronization macros. These aren't needed if using
6520 * thread-safe locale operations, except if something is broken */
6521 #if defined(USE_LOCALE) \
6522 && defined(USE_ITHREADS) \
6523 && (! defined(USE_THREAD_SAFE_LOCALE) || defined(TS_W32_BROKEN_LOCALECONV))
6525 /* We have a locale object holding the 'C' locale for Posix 2008 */
6526 # ifndef USE_POSIX_2008_LOCALE
6527 # define _LOCALE_TERM_POSIX_2008 NOOP
6529 # define _LOCALE_TERM_POSIX_2008 \
6531 if (PL_C_locale_obj) { \
6532 /* Make sure we aren't using the locale \
6533 * space we are about to free */ \
6534 uselocale(LC_GLOBAL_LOCALE); \
6535 freelocale(PL_C_locale_obj); \
6536 PL_C_locale_obj = (locale_t) NULL; \
6541 /* This is used as a generic lock for locale operations. For example this is
6542 * used when calling nl_langinfo() so that another thread won't zap the
6543 * contents of its buffer before it gets saved; and it's called when changing
6544 * the locale of LC_MESSAGES. On some systems the latter can cause the
6545 * nl_langinfo buffer to be zapped under a race condition.
6547 * If combined with LC_NUMERIC_LOCK, calls to this and its corresponding unlock
6548 * should be contained entirely within the locked portion of LC_NUMERIC. This
6549 * mutex should be used only in very short sections of code, while
6550 * LC_NUMERIC_LOCK may span more operations. By always following this
6551 * convention, deadlock should be impossible. But if necessary, the two
6552 * mutexes could be combined.
6554 * Actually, the two macros just below with the '_V' suffixes are used in just
6555 * a few places where there is a broken localeconv(), but otherwise things are
6556 * thread safe, and hence don't need locking. Just below LOCALE_LOCK and
6557 * LOCALE_UNLOCK are defined in terms of these for use everywhere else */
6558 # define LOCALE_LOCK_V \
6560 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6561 "%s: %d: locking locale\n", __FILE__, __LINE__)); \
6562 MUTEX_LOCK(&PL_locale_mutex); \
6564 # define LOCALE_UNLOCK_V \
6566 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6567 "%s: %d: unlocking locale\n", __FILE__, __LINE__)); \
6568 MUTEX_UNLOCK(&PL_locale_mutex); \
6571 /* On windows, we just need the mutex for LOCALE_LOCK */
6572 # ifdef TS_W32_BROKEN_LOCALECONV
6573 # define LOCALE_LOCK NOOP
6574 # define LOCALE_UNLOCK NOOP
6575 # define LOCALE_INIT MUTEX_INIT(&PL_locale_mutex);
6576 # define LOCALE_TERM MUTEX_DESTROY(&PL_locale_mutex)
6577 # define LC_NUMERIC_LOCK(cond)
6578 # define LC_NUMERIC_UNLOCK
6580 # define LOCALE_LOCK LOCALE_LOCK_V
6581 # define LOCALE_UNLOCK LOCALE_UNLOCK_V
6583 /* We also need to lock LC_NUMERIC for non-windows (hence Posix 2008)
6585 # define LOCALE_INIT STMT_START { \
6586 MUTEX_INIT(&PL_locale_mutex); \
6587 MUTEX_INIT(&PL_lc_numeric_mutex); \
6590 # define LOCALE_TERM STMT_START { \
6591 MUTEX_DESTROY(&PL_locale_mutex); \
6592 MUTEX_DESTROY(&PL_lc_numeric_mutex); \
6593 _LOCALE_TERM_POSIX_2008; \
6596 /* This mutex is used to create critical sections where we want the
6597 * LC_NUMERIC locale to be locked into either the C (standard) locale, or
6598 * the underlying locale, so that other threads interrupting this one don't
6599 * change it to the wrong state before we've had a chance to complete our
6600 * operation. It can stay locked over an entire printf operation, for
6601 * example. And so is made distinct from the LOCALE_LOCK mutex.
6603 * This simulates kind of a general semaphore. The current thread will
6604 * lock the mutex if the per-thread variable is zero, and then increments
6605 * that variable. Each corresponding UNLOCK decrements the variable until
6606 * it is 0, at which point it actually unlocks the mutex. Since the
6607 * variable is per-thread, there is no race with other threads.
6609 * The single argument is a condition to test for, and if true, to panic,
6610 * as this would be an attempt to complement the LC_NUMERIC state, and
6611 * we're not supposed to because it's locked.
6613 * Clang improperly gives warnings for this, if not silenced:
6614 * https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#conditional-locks
6616 # define LC_NUMERIC_LOCK(cond_to_panic_if_already_locked) \
6617 CLANG_DIAG_IGNORE(-Wthread-safety) \
6619 if (PL_lc_numeric_mutex_depth <= 0) { \
6620 MUTEX_LOCK(&PL_lc_numeric_mutex); \
6621 PL_lc_numeric_mutex_depth = 1; \
6622 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6623 "%s: %d: locking lc_numeric; depth=1\n", \
6624 __FILE__, __LINE__)); \
6627 PL_lc_numeric_mutex_depth++; \
6628 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6629 "%s: %d: avoided lc_numeric_lock; new depth=%d\n", \
6630 __FILE__, __LINE__, PL_lc_numeric_mutex_depth)); \
6631 if (cond_to_panic_if_already_locked) { \
6632 Perl_croak_nocontext("panic: %s: %d: Trying to change" \
6633 " LC_NUMERIC incompatibly", \
6634 __FILE__, __LINE__); \
6639 # define LC_NUMERIC_UNLOCK \
6641 if (PL_lc_numeric_mutex_depth <= 1) { \
6642 MUTEX_UNLOCK(&PL_lc_numeric_mutex); \
6643 PL_lc_numeric_mutex_depth = 0; \
6644 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6645 "%s: %d: unlocking lc_numeric; depth=0\n", \
6646 __FILE__, __LINE__)); \
6649 PL_lc_numeric_mutex_depth--; \
6650 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6651 "%s: %d: avoided lc_numeric_unlock; new depth=%d\n",\
6652 __FILE__, __LINE__, PL_lc_numeric_mutex_depth)); \
6657 # endif /* End of needs locking LC_NUMERIC */
6658 #else /* Below is no locale sync needed */
6659 # define LOCALE_INIT
6660 # define LOCALE_LOCK
6661 # define LOCALE_LOCK_V
6662 # define LOCALE_UNLOCK
6663 # define LOCALE_UNLOCK_V
6664 # define LC_NUMERIC_LOCK(cond)
6665 # define LC_NUMERIC_UNLOCK
6666 # define LOCALE_TERM
6669 #ifdef USE_LOCALE_NUMERIC
6671 /* These macros are for toggling between the underlying locale (UNDERLYING or
6672 * LOCAL) and the C locale (STANDARD). (Actually we don't have to use the C
6673 * locale if the underlying locale is indistinguishable from it in the numeric
6674 * operations used by Perl, namely the decimal point, and even the thousands
6677 =for apidoc_section $locale
6679 =for apidoc Amn|void|DECLARATION_FOR_LC_NUMERIC_MANIPULATION
6681 This macro should be used as a statement. It declares a private variable
6682 (whose name begins with an underscore) that is needed by the other macros in
6683 this section. Failing to include this correctly should lead to a syntax error.
6684 For compatibility with C89 C compilers it should be placed in a block before
6685 any executable statements.
6687 =for apidoc Am|void|STORE_LC_NUMERIC_FORCE_TO_UNDERLYING
6689 This is used by XS code that is C<LC_NUMERIC> locale-aware to force the
6690 locale for category C<LC_NUMERIC> to be what perl thinks is the current
6691 underlying locale. (The perl interpreter could be wrong about what the
6692 underlying locale actually is if some C or XS code has called the C library
6693 function L<setlocale(3)> behind its back; calling L</sync_locale> before calling
6694 this macro will update perl's records.)
6696 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
6697 declare at compile time a private variable used by this macro. This macro
6698 should be called as a single statement, not an expression, but with an empty
6699 argument list, like this:
6702 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6704 STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
6706 RESTORE_LC_NUMERIC();
6710 The private variable is used to save the current locale state, so
6711 that the requisite matching call to L</RESTORE_LC_NUMERIC> can restore it.
6713 On threaded perls not operating with thread-safe functionality, this macro uses
6714 a mutex to force a critical section. Therefore the matching RESTORE should be
6715 close by, and guaranteed to be called.
6717 =for apidoc Am|void|STORE_LC_NUMERIC_SET_TO_NEEDED
6719 This is used to help wrap XS or C code that is C<LC_NUMERIC> locale-aware.
6720 This locale category is generally kept set to a locale where the decimal radix
6721 character is a dot, and the separator between groups of digits is empty. This
6722 is because most XS code that reads floating point numbers is expecting them to
6725 This macro makes sure the current C<LC_NUMERIC> state is set properly, to be
6726 aware of locale if the call to the XS or C code from the Perl program is
6727 from within the scope of a S<C<use locale>>; or to ignore locale if the call is
6728 instead from outside such scope.
6730 This macro is the start of wrapping the C or XS code; the wrap ending is done
6731 by calling the L</RESTORE_LC_NUMERIC> macro after the operation. Otherwise
6732 the state can be changed that will adversely affect other XS code.
6734 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
6735 declare at compile time a private variable used by this macro. This macro
6736 should be called as a single statement, not an expression, but with an empty
6737 argument list, like this:
6740 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6742 STORE_LC_NUMERIC_SET_TO_NEEDED();
6744 RESTORE_LC_NUMERIC();
6748 On threaded perls not operating with thread-safe functionality, this macro uses
6749 a mutex to force a critical section. Therefore the matching RESTORE should be
6750 close by, and guaranteed to be called; see L</WITH_LC_NUMERIC_SET_TO_NEEDED>
6751 for a more contained way to ensure that.
6753 =for apidoc Am|void|STORE_LC_NUMERIC_SET_TO_NEEDED_IN|bool in_lc_numeric
6755 Same as L</STORE_LC_NUMERIC_SET_TO_NEEDED> with in_lc_numeric provided
6756 as the precalculated value of C<IN_LC(LC_NUMERIC)>. It is the caller's
6757 responsibility to ensure that the status of C<PL_compiling> and C<PL_hints>
6758 cannot have changed since the precalculation.
6760 =for apidoc Am|void|RESTORE_LC_NUMERIC
6762 This is used in conjunction with one of the macros
6763 L</STORE_LC_NUMERIC_SET_TO_NEEDED>
6764 and L</STORE_LC_NUMERIC_FORCE_TO_UNDERLYING> to properly restore the
6765 C<LC_NUMERIC> state.
6767 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
6768 declare at compile time a private variable used by this macro and the two
6769 C<STORE> ones. This macro should be called as a single statement, not an
6770 expression, but with an empty argument list, like this:
6773 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6775 RESTORE_LC_NUMERIC();
6779 =for apidoc Am|void|WITH_LC_NUMERIC_SET_TO_NEEDED|block
6781 This macro invokes the supplied statement or block within the context
6782 of a L</STORE_LC_NUMERIC_SET_TO_NEEDED> .. L</RESTORE_LC_NUMERIC> pair
6785 WITH_LC_NUMERIC_SET_TO_NEEDED(
6786 SNPRINTF_G(fv, ebuf, sizeof(ebuf), precis)
6792 #ifdef USE_LOCALE_NUMERIC
6793 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6794 STORE_LC_NUMERIC_SET_TO_NEEDED();
6796 SNPRINTF_G(fv, ebuf, sizeof(ebuf), precis);
6797 #ifdef USE_LOCALE_NUMERIC
6798 RESTORE_LC_NUMERIC();
6802 =for apidoc Am|void|WITH_LC_NUMERIC_SET_TO_NEEDED_IN|bool in_lc_numeric|block
6804 Same as L</WITH_LC_NUMERIC_SET_TO_NEEDED> with in_lc_numeric provided
6805 as the precalculated value of C<IN_LC(LC_NUMERIC)>. It is the caller's
6806 responsibility to ensure that the status of C<PL_compiling> and C<PL_hints>
6807 cannot have changed since the precalculation.
6813 /* If the underlying numeric locale has a non-dot decimal point or has a
6814 * non-empty floating point thousands separator, the current locale is instead
6815 * generally kept in the C locale instead of that underlying locale. The
6816 * current status is known by looking at two words. One is non-zero if the
6817 * current numeric locale is the standard C/POSIX one or is indistinguishable
6818 * from C. The other is non-zero if the current locale is the underlying
6819 * locale. Both can be non-zero if, as often happens, the underlying locale is
6820 * C or indistinguishable from it.
6822 * khw believes the reason for the variables instead of the bits in a single
6823 * word is to avoid having to have masking instructions. */
6825 # define _NOT_IN_NUMERIC_STANDARD (! PL_numeric_standard)
6827 /* We can lock the category to stay in the C locale, making requests to the
6828 * contrary be noops, in the dynamic scope by setting PL_numeric_standard to 2.
6830 # define _NOT_IN_NUMERIC_UNDERLYING \
6831 (! PL_numeric_underlying && PL_numeric_standard < 2)
6833 # define DECLARATION_FOR_LC_NUMERIC_MANIPULATION \
6834 void (*_restore_LC_NUMERIC_function)(pTHX) = NULL
6836 # define STORE_LC_NUMERIC_SET_TO_NEEDED_IN(in) \
6838 bool _in_lc_numeric = (in); \
6840 ( ( _in_lc_numeric && _NOT_IN_NUMERIC_UNDERLYING) \
6841 || (! _in_lc_numeric && _NOT_IN_NUMERIC_STANDARD))); \
6842 if (_in_lc_numeric) { \
6843 if (_NOT_IN_NUMERIC_UNDERLYING) { \
6844 Perl_set_numeric_underlying(aTHX); \
6845 _restore_LC_NUMERIC_function \
6846 = &Perl_set_numeric_standard; \
6850 if (_NOT_IN_NUMERIC_STANDARD) { \
6851 Perl_set_numeric_standard(aTHX); \
6852 _restore_LC_NUMERIC_function \
6853 = &Perl_set_numeric_underlying; \
6858 # define STORE_LC_NUMERIC_SET_TO_NEEDED() \
6859 STORE_LC_NUMERIC_SET_TO_NEEDED_IN(IN_LC(LC_NUMERIC))
6861 # define RESTORE_LC_NUMERIC() \
6863 if (_restore_LC_NUMERIC_function) { \
6864 _restore_LC_NUMERIC_function(aTHX); \
6866 LC_NUMERIC_UNLOCK; \
6869 /* The next two macros set unconditionally. These should be rarely used, and
6870 * only after being sure that this is what is needed */
6871 # define SET_NUMERIC_STANDARD() \
6873 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6874 "%s: %d: lc_numeric standard=%d\n", \
6875 __FILE__, __LINE__, PL_numeric_standard)); \
6876 Perl_set_numeric_standard(aTHX); \
6877 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6878 "%s: %d: lc_numeric standard=%d\n", \
6879 __FILE__, __LINE__, PL_numeric_standard)); \
6882 # define SET_NUMERIC_UNDERLYING() \
6884 if (_NOT_IN_NUMERIC_UNDERLYING) { \
6885 Perl_set_numeric_underlying(aTHX); \
6889 /* The rest of these LC_NUMERIC macros toggle to one or the other state, with
6890 * the RESTORE_foo ones called to switch back, but only if need be */
6891 # define STORE_LC_NUMERIC_SET_STANDARD() \
6893 LC_NUMERIC_LOCK(_NOT_IN_NUMERIC_STANDARD); \
6894 if (_NOT_IN_NUMERIC_STANDARD) { \
6895 _restore_LC_NUMERIC_function = &Perl_set_numeric_underlying;\
6896 Perl_set_numeric_standard(aTHX); \
6900 /* Rarely, we want to change to the underlying locale even outside of 'use
6901 * locale'. This is principally in the POSIX:: functions */
6902 # define STORE_LC_NUMERIC_FORCE_TO_UNDERLYING() \
6904 LC_NUMERIC_LOCK(_NOT_IN_NUMERIC_UNDERLYING); \
6905 if (_NOT_IN_NUMERIC_UNDERLYING) { \
6906 Perl_set_numeric_underlying(aTHX); \
6907 _restore_LC_NUMERIC_function = &Perl_set_numeric_standard; \
6911 /* Lock/unlock to the C locale until unlock is called. This needs to be
6912 * recursively callable. [perl #128207] */
6913 # define LOCK_LC_NUMERIC_STANDARD() \
6915 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6916 "%s: %d: lock lc_numeric_standard: new depth=%d\n", \
6917 __FILE__, __LINE__, PL_numeric_standard + 1)); \
6918 __ASSERT_(PL_numeric_standard) \
6919 PL_numeric_standard++; \
6922 # define UNLOCK_LC_NUMERIC_STANDARD() \
6924 if (PL_numeric_standard > 1) { \
6925 PL_numeric_standard--; \
6930 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6931 "%s: %d: lc_numeric_standard decrement lock, new depth=%d\n", \
6932 __FILE__, __LINE__, PL_numeric_standard)); \
6935 # define WITH_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric, block) \
6937 DECLARATION_FOR_LC_NUMERIC_MANIPULATION; \
6938 STORE_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric); \
6940 RESTORE_LC_NUMERIC(); \
6943 # define WITH_LC_NUMERIC_SET_TO_NEEDED(block) \
6944 WITH_LC_NUMERIC_SET_TO_NEEDED_IN(IN_LC(LC_NUMERIC), block)
6946 #else /* !USE_LOCALE_NUMERIC */
6948 # define SET_NUMERIC_STANDARD()
6949 # define SET_NUMERIC_UNDERLYING()
6950 # define IS_NUMERIC_RADIX(a, b) (0)
6951 # define DECLARATION_FOR_LC_NUMERIC_MANIPULATION dNOOP
6952 # define STORE_LC_NUMERIC_SET_STANDARD()
6953 # define STORE_LC_NUMERIC_FORCE_TO_UNDERLYING()
6954 # define STORE_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric)
6955 # define STORE_LC_NUMERIC_SET_TO_NEEDED()
6956 # define RESTORE_LC_NUMERIC()
6957 # define LOCK_LC_NUMERIC_STANDARD()
6958 # define UNLOCK_LC_NUMERIC_STANDARD()
6959 # define WITH_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric, block) \
6960 STMT_START { block; } STMT_END
6961 # define WITH_LC_NUMERIC_SET_TO_NEEDED(block) \
6962 STMT_START { block; } STMT_END
6964 #endif /* !USE_LOCALE_NUMERIC */
6966 #define Atof my_atof
6970 =for apidoc_section $numeric
6972 =for apidoc AmTR|NV|Strtod|NN const char * const s|NULLOK char ** e
6974 This is a synonym for L</my_strtod>.
6976 =for apidoc AmTR|NV|Strtol|NN const char * const s|NULLOK char ** e|int base
6978 Platform and configuration independent C<strtol>. This expands to the
6979 appropriate C<strotol>-like function based on the platform and F<Configure>
6980 options>. For example it could expand to C<strtoll> or C<strtoq> instead of
6983 =for apidoc AmTR|NV|Strtoul|NN const char * const s|NULLOK char ** e|int base
6985 Platform and configuration independent C<strtoul>. This expands to the
6986 appropriate C<strotoul>-like function based on the platform and F<Configure>
6987 options>. For example it could expand to C<strtoull> or C<strtouq> instead of
6994 #define Strtod my_strtod
6996 #if defined(HAS_STRTOD) \
6997 || defined(USE_QUADMATH) \
6998 || (defined(HAS_STRTOLD) && defined(HAS_LONG_DOUBLE) \
6999 && defined(USE_LONG_DOUBLE))
7000 # define Perl_strtod Strtod
7003 #if !defined(Strtol) && defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && \
7004 (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
7006 # define strtoll __strtoll /* secret handshake */
7008 # if defined(WIN64) && defined(_MSC_VER)
7009 # define strtoll _strtoi64 /* secret handshake */
7011 # if !defined(Strtol) && defined(HAS_STRTOLL)
7012 # define Strtol strtoll
7014 # if !defined(Strtol) && defined(HAS_STRTOQ)
7015 # define Strtol strtoq
7017 /* is there atoq() anywhere? */
7019 #if !defined(Strtol) && defined(HAS_STRTOL)
7020 # define Strtol strtol
7023 /* It would be more fashionable to use Strtol() to define atol()
7024 * (as is done for Atoul(), see below) but for backward compatibility
7025 * we just assume atol(). */
7026 # if defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && defined(HAS_ATOLL) && \
7027 (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
7029 # define atoll _atoi64 /* secret handshake */
7037 #if !defined(Strtoul) && defined(USE_64_BIT_INT) && defined(UV_IS_QUAD) && \
7038 (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
7040 # define strtoull __strtoull /* secret handshake */
7042 # if defined(WIN64) && defined(_MSC_VER)
7043 # define strtoull _strtoui64 /* secret handshake */
7045 # if !defined(Strtoul) && defined(HAS_STRTOULL)
7046 # define Strtoul strtoull
7048 # if !defined(Strtoul) && defined(HAS_STRTOUQ)
7049 # define Strtoul strtouq
7051 /* is there atouq() anywhere? */
7053 #if !defined(Strtoul) && defined(HAS_STRTOUL)
7054 # define Strtoul strtoul
7056 #if !defined(Strtoul) && defined(HAS_STRTOL) /* Last resort. */
7057 # define Strtoul(s, e, b) strchr((s), '-') ? ULONG_MAX : (unsigned long)strtol((s), (e), (b))
7060 # define Atoul(s) Strtoul(s, NULL, 10)
7063 #define grok_bin(s,lp,fp,rp) \
7064 grok_bin_oct_hex(s, lp, fp, rp, 1, _CC_BINDIGIT, 'b')
7065 #define grok_oct(s,lp,fp,rp) \
7066 (*(fp) |= PERL_SCAN_DISALLOW_PREFIX, \
7067 grok_bin_oct_hex(s, lp, fp, rp, 3, _CC_OCTDIGIT, '\0'))
7068 #define grok_hex(s,lp,fp,rp) \
7069 grok_bin_oct_hex(s, lp, fp, rp, 4, _CC_XDIGIT, 'x')
7071 #ifndef PERL_SCRIPT_MODE
7072 #define PERL_SCRIPT_MODE "r"
7075 /* not used. Kept as a NOOP for backcompat */
7076 #define PERL_STACK_OVERFLOW_CHECK() NOOP
7079 * Some nonpreemptive operating systems find it convenient to
7080 * check for asynchronous conditions after each op execution.
7081 * Keep this check simple, or it may slow down execution
7086 # ifndef PERL_ASYNC_CHECK
7087 # define PERL_ASYNC_CHECK() if (UNLIKELY(PL_sig_pending)) PL_signalhook(aTHX)
7091 #ifndef PERL_ASYNC_CHECK
7092 # define PERL_ASYNC_CHECK() NOOP
7096 * On some operating systems, a memory allocation may succeed,
7097 * but put the process too close to the system's comfort limit.
7098 * In this case, PERL_ALLOC_CHECK frees the pointer and sets
7101 #ifndef PERL_ALLOC_CHECK
7102 #define PERL_ALLOC_CHECK(p) NOOP
7106 # include <sys/ipc.h>
7107 # include <sys/sem.h>
7108 # ifndef HAS_UNION_SEMUN /* Provide the union semun. */
7111 struct semid_ds *buf;
7112 unsigned short *array;
7115 # ifdef USE_SEMCTL_SEMUN
7116 # ifdef IRIX32_SEMUN_BROKEN_BY_GCC
7117 union gccbug_semun {
7119 struct semid_ds *buf;
7120 unsigned short *array;
7123 # define semun gccbug_semun
7125 # define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun)
7126 # elif defined(USE_SEMCTL_SEMID_DS)
7127 # ifdef EXTRA_F_IN_SEMUN_BUF
7128 # define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buff)
7130 # define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buf)
7136 * Boilerplate macros for initializing and accessing interpreter-local
7137 * data from C. All statics in extensions should be reworked to use
7138 * this, if you want to make the extension thread-safe. See
7139 * ext/XS/APItest/APItest.xs for an example of the use of these macros,
7140 * and perlxs.pod for more.
7142 * Code that uses these macros is responsible for the following:
7143 * 1. #define MY_CXT_KEY to a unique string, e.g.
7144 * "DynaLoader::_guts" XS_VERSION
7145 * XXX in the current implementation, this string is ignored.
7146 * 2. Declare a typedef named my_cxt_t that is a structure that contains
7147 * all the data that needs to be interpreter-local.
7148 * 3. Use the START_MY_CXT macro after the declaration of my_cxt_t.
7149 * 4. Use the MY_CXT_INIT macro such that it is called exactly once
7150 * (typically put in the BOOT: section).
7151 * 5. Use the members of the my_cxt_t structure everywhere as
7153 * 6. Use the dMY_CXT macro (a declaration) in all the functions that
7157 #if defined(PERL_IMPLICIT_CONTEXT)
7159 /* START_MY_CXT must appear in all extensions that define a my_cxt_t structure,
7160 * right after the definition (i.e. at file scope). The non-threads
7161 * case below uses it to declare the data as static. */
7162 # define START_MY_CXT static int my_cxt_index = -1;
7163 # define MY_CXT_INDEX my_cxt_index
7164 # define MY_CXT_INIT_ARG &my_cxt_index
7166 /* Creates and zeroes the per-interpreter data.
7167 * (We allocate my_cxtp in a Perl SV so that it will be released when
7168 * the interpreter goes away.) */
7169 # define MY_CXT_INIT \
7170 my_cxt_t *my_cxtp = \
7171 (my_cxt_t*)Perl_my_cxt_init(aTHX_ MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
7172 PERL_UNUSED_VAR(my_cxtp)
7173 # define MY_CXT_INIT_INTERP(my_perl) \
7174 my_cxt_t *my_cxtp = \
7175 (my_cxt_t*)Perl_my_cxt_init(my_perl, MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
7176 PERL_UNUSED_VAR(my_cxtp)
7178 /* This declaration should be used within all functions that use the
7179 * interpreter-local data. */
7181 my_cxt_t *my_cxtp = (my_cxt_t *)PL_my_cxt_list[MY_CXT_INDEX]
7182 # define dMY_CXT_INTERP(my_perl) \
7183 my_cxt_t *my_cxtp = (my_cxt_t *)(my_perl)->Imy_cxt_list[MY_CXT_INDEX]
7185 /* Clones the per-interpreter data. */
7186 # define MY_CXT_CLONE \
7187 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1));\
7188 void * old_my_cxtp = PL_my_cxt_list[MY_CXT_INDEX]; \
7189 PL_my_cxt_list[MY_CXT_INDEX] = my_cxtp; \
7190 Copy(old_my_cxtp, my_cxtp, 1, my_cxt_t);
7194 /* This macro must be used to access members of the my_cxt_t structure.
7195 * e.g. MY_CXT.some_data */
7196 # define MY_CXT (*my_cxtp)
7198 /* Judicious use of these macros can reduce the number of times dMY_CXT
7199 * is used. Use is similar to pTHX, aTHX etc. */
7200 # define pMY_CXT my_cxt_t *my_cxtp
7201 # define pMY_CXT_ pMY_CXT,
7202 # define _pMY_CXT ,pMY_CXT
7203 # define aMY_CXT my_cxtp
7204 # define aMY_CXT_ aMY_CXT,
7205 # define _aMY_CXT ,aMY_CXT
7207 #else /* PERL_IMPLICIT_CONTEXT */
7209 # define START_MY_CXT static my_cxt_t my_cxt;
7210 # define dMY_CXT_SV dNOOP
7211 # define dMY_CXT dNOOP
7212 # define dMY_CXT_INTERP(my_perl) dNOOP
7213 # define MY_CXT_INIT NOOP
7214 # define MY_CXT_CLONE NOOP
7215 # define MY_CXT my_cxt
7217 # define pMY_CXT void
7224 #endif /* !defined(PERL_IMPLICIT_CONTEXT) */
7235 # undef FD_CLOEXEC /* a lie in AmigaOS */
7239 # include <sys/file.h>
7242 #if defined(HAS_FLOCK) && !defined(HAS_FLOCK_PROTO)
7243 EXTERN_C int flock(int fd, int op);
7247 /* Assume UNIX defaults */
7248 # define O_RDONLY 0000
7249 # define O_WRONLY 0001
7250 # define O_RDWR 0002
7251 # define O_CREAT 0100
7262 #if O_TEXT != O_BINARY
7263 /* If you have different O_TEXT and O_BINARY and you are a CRLF shop,
7264 * that is, you are somehow DOSish. */
7265 # if defined(__HAIKU__) || defined(__VOS__) || defined(__CYGWIN__)
7266 /* Haiku has O_TEXT != O_BINARY but O_TEXT and O_BINARY have no effect;
7267 * Haiku is always UNIXoid (LF), not DOSish (CRLF). */
7268 /* VOS has O_TEXT != O_BINARY, and they have effect,
7269 * but VOS always uses LF, never CRLF. */
7270 /* If you have O_TEXT different from your O_BINARY but you still are
7271 * not a CRLF shop. */
7272 # undef PERLIO_USING_CRLF
7274 /* If you really are DOSish. */
7275 # define PERLIO_USING_CRLF 1
7280 # include <libutil.h> /* setproctitle() in some FreeBSDs */
7283 #ifndef EXEC_ARGV_CAST
7284 #define EXEC_ARGV_CAST(x) (char **)x
7287 #define IS_NUMBER_IN_UV 0x01 /* number within UV range (maybe not
7288 int). value returned in pointed-
7290 #define IS_NUMBER_GREATER_THAN_UV_MAX 0x02 /* pointed to UV undefined */
7291 #define IS_NUMBER_NOT_INT 0x04 /* saw . or E notation or infnan */
7292 #define IS_NUMBER_NEG 0x08 /* leading minus sign */
7293 #define IS_NUMBER_INFINITY 0x10 /* this is big */
7294 #define IS_NUMBER_NAN 0x20 /* this is not */
7295 #define IS_NUMBER_TRAILING 0x40 /* number has trailing trash */
7298 =for apidoc_section $numeric
7300 =for apidoc AmdR|bool|GROK_NUMERIC_RADIX|NN const char **sp|NN const char *send
7302 A synonym for L</grok_numeric_radix>
7306 #define GROK_NUMERIC_RADIX(sp, send) grok_numeric_radix(sp, send)
7308 /* Number scan flags. All are used for input, the ones used for output are so
7310 #define PERL_SCAN_ALLOW_UNDERSCORES 0x01 /* grok_??? accept _ in numbers */
7311 #define PERL_SCAN_DISALLOW_PREFIX 0x02 /* grok_??? reject 0x in hex etc */
7313 /* grok_??? input: ignored; output: found overflow */
7314 #define PERL_SCAN_GREATER_THAN_UV_MAX 0x04
7316 /* grok_??? don't warn about illegal digits. To preserve total backcompat,
7317 * this isn't set on output if one is found. Instead, see
7318 * PERL_SCAN_NOTIFY_ILLDIGIT. */
7319 #define PERL_SCAN_SILENT_ILLDIGIT 0x08
7321 #define PERL_SCAN_TRAILING 0x10 /* grok_number_flags() allow trailing
7322 and set IS_NUMBER_TRAILING */
7324 /* These are considered experimental, so not exposed publicly */
7325 #if defined(PERL_CORE) || defined(PERL_EXT)
7326 /* grok_??? don't warn about very large numbers which are <= UV_MAX;
7327 * output: found such a number */
7328 # define PERL_SCAN_SILENT_NON_PORTABLE 0x20
7330 /* If this is set on input, and no illegal digit is found, it will be cleared
7331 * on output; otherwise unchanged */
7332 # define PERL_SCAN_NOTIFY_ILLDIGIT 0x40
7334 /* Don't warn on overflow; output flag still set */
7335 # define PERL_SCAN_SILENT_OVERFLOW 0x80
7337 /* Forbid a leading underscore, which the other one doesn't */
7338 # define PERL_SCAN_ALLOW_MEDIAL_UNDERSCORES (0x100|PERL_SCAN_ALLOW_UNDERSCORES)
7342 /* to let user control profiling */
7343 #ifdef PERL_GPROF_CONTROL
7344 extern void moncontrol(int);
7345 #define PERL_GPROF_MONCONTROL(x) moncontrol(x)
7347 #define PERL_GPROF_MONCONTROL(x)
7350 /* ISO 6429 NEL - C1 control NExt Line */
7351 /* See https://www.unicode.org/unicode/reports/tr13/ */
7352 #define NEXT_LINE_CHAR NEXT_LINE_NATIVE
7354 #ifndef PIPESOCK_MODE
7355 # define PIPESOCK_MODE
7358 #ifndef SOCKET_OPEN_MODE
7359 # define SOCKET_OPEN_MODE PIPESOCK_MODE
7362 #ifndef PIPE_OPEN_MODE
7363 # define PIPE_OPEN_MODE PIPESOCK_MODE
7366 #define PERL_MAGIC_UTF8_CACHESIZE 2
7370 #define PERL_UNICODE_STDIN_FLAG 0x0001
7371 #define PERL_UNICODE_STDOUT_FLAG 0x0002
7372 #define PERL_UNICODE_STDERR_FLAG 0x0004
7373 #define PERL_UNICODE_IN_FLAG 0x0008
7374 #define PERL_UNICODE_OUT_FLAG 0x0010
7375 #define PERL_UNICODE_ARGV_FLAG 0x0020
7376 #define PERL_UNICODE_LOCALE_FLAG 0x0040
7377 #define PERL_UNICODE_WIDESYSCALLS_FLAG 0x0080 /* for Sarathy */
7378 #define PERL_UNICODE_UTF8CACHEASSERT_FLAG 0x0100
7380 #define PERL_UNICODE_STD_FLAG \
7381 (PERL_UNICODE_STDIN_FLAG | \
7382 PERL_UNICODE_STDOUT_FLAG | \
7383 PERL_UNICODE_STDERR_FLAG)
7385 #define PERL_UNICODE_INOUT_FLAG \
7386 (PERL_UNICODE_IN_FLAG | \
7387 PERL_UNICODE_OUT_FLAG)
7389 #define PERL_UNICODE_DEFAULT_FLAGS \
7390 (PERL_UNICODE_STD_FLAG | \
7391 PERL_UNICODE_INOUT_FLAG | \
7392 PERL_UNICODE_LOCALE_FLAG)
7394 #define PERL_UNICODE_ALL_FLAGS 0x01ff
7396 #define PERL_UNICODE_STDIN 'I'
7397 #define PERL_UNICODE_STDOUT 'O'
7398 #define PERL_UNICODE_STDERR 'E'
7399 #define PERL_UNICODE_STD 'S'
7400 #define PERL_UNICODE_IN 'i'
7401 #define PERL_UNICODE_OUT 'o'
7402 #define PERL_UNICODE_INOUT 'D'
7403 #define PERL_UNICODE_ARGV 'A'
7404 #define PERL_UNICODE_LOCALE 'L'
7405 #define PERL_UNICODE_WIDESYSCALLS 'W'
7406 #define PERL_UNICODE_UTF8CACHEASSERT 'a'
7411 =for apidoc_section $signals
7412 =for apidoc Amn|U32|PERL_SIGNALS_UNSAFE_FLAG
7413 If this bit in C<PL_signals> is set, the system is uing the pre-Perl 5.8
7414 unsafe signals. See L<perlrun/PERL_SIGNALS> and L<perlipc/Deferred Signals
7419 #define PERL_SIGNALS_UNSAFE_FLAG 0x0001
7422 =for apidoc_section $numeric
7424 =for apidoc Am|int|PERL_ABS|int x
7426 Typeless C<abs> or C<fabs>, I<etc>. (The usage below indicates it is for
7427 integers, but it works for any type.) Use instead of these, since the C
7428 library ones force their argument to be what it is expecting, potentially
7429 leading to disaster. But also beware that this evaluates its argument twice,
7435 #define PERL_ABS(x) ((x) < 0 ? -(x) : (x))
7437 #if defined(__DECC) && defined(__osf__)
7438 #pragma message disable (mainparm) /* Perl uses the envp in main(). */
7441 #define do_open(g, n, l, a, rm, rp, sf) \
7442 do_openn(g, n, l, a, rm, rp, sf, (SV **) NULL, 0)
7443 #ifdef PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
7444 # define do_exec(cmd) do_exec3(cmd,0,0)
7447 # define do_aexec Perl_do_aexec
7449 # define do_aexec(really, mark,sp) do_aexec5(really, mark, sp, 0, 0)
7454 =for apidoc_section $utility
7456 =for apidoc Am|bool|IS_SAFE_SYSCALL|NN const char *pv|STRLEN len|NN const char *what|NN const char *op_name
7458 Same as L</is_safe_syscall>.
7462 Allows one ending \0
7464 #define IS_SAFE_SYSCALL(p, len, what, op_name) (Perl_is_safe_syscall(aTHX_ (p), (len), (what), (op_name)))
7466 #define IS_SAFE_PATHNAME(p, len, op_name) IS_SAFE_SYSCALL((p), (len), "pathname", (op_name))
7468 #if defined(OEMVS) || defined(__amigaos4__)
7469 #define NO_ENV_ARRAY_IN_MAIN
7472 /* These are used by Perl_pv_escape() and Perl_pv_pretty()
7473 * are here so that they are available throughout the core
7474 * NOTE that even though some are for _escape and some for _pretty
7475 * there must not be any clashes as the flags from _pretty are
7476 * passed straight through to _escape.
7479 #define PERL_PV_ESCAPE_QUOTE 0x000001
7480 #define PERL_PV_PRETTY_QUOTE PERL_PV_ESCAPE_QUOTE
7482 #define PERL_PV_PRETTY_ELLIPSES 0x000002
7483 #define PERL_PV_PRETTY_LTGT 0x000004
7484 #define PERL_PV_PRETTY_EXACTSIZE 0x000008
7486 #define PERL_PV_ESCAPE_UNI 0x000100
7487 #define PERL_PV_ESCAPE_UNI_DETECT 0x000200
7488 #define PERL_PV_ESCAPE_NONASCII 0x000400
7489 #define PERL_PV_ESCAPE_FIRSTCHAR 0x000800
7491 #define PERL_PV_ESCAPE_ALL 0x001000
7492 #define PERL_PV_ESCAPE_NOBACKSLASH 0x002000
7493 #define PERL_PV_ESCAPE_NOCLEAR 0x004000
7494 #define PERL_PV_PRETTY_NOCLEAR PERL_PV_ESCAPE_NOCLEAR
7495 #define PERL_PV_ESCAPE_RE 0x008000
7497 #define PERL_PV_ESCAPE_DWIM 0x010000
7500 /* used by pv_display in dump.c*/
7501 #define PERL_PV_PRETTY_DUMP PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE
7502 #define PERL_PV_PRETTY_REGPROP PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_LTGT|PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII
7504 #if DOUBLEKIND == DOUBLE_IS_VAX_F_FLOAT || \
7505 DOUBLEKIND == DOUBLE_IS_VAX_D_FLOAT || \
7506 DOUBLEKIND == DOUBLE_IS_VAX_G_FLOAT
7507 # define DOUBLE_IS_VAX_FLOAT
7509 # define DOUBLE_IS_IEEE_FORMAT
7512 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN || \
7513 DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN || \
7514 DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
7515 # define DOUBLE_LITTLE_ENDIAN
7518 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN || \
7519 DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN || \
7520 DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
7521 # define DOUBLE_BIG_ENDIAN
7524 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE || \
7525 DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
7526 # define DOUBLE_MIX_ENDIAN
7529 /* The VAX fp formats are neither consistently little-endian nor
7530 * big-endian, and neither are they really IEEE-mixed endian like
7531 * the mixed-endian ARM IEEE formats (with swapped bytes).
7532 * Ultimately, the VAX format came from the PDP-11.
7534 * The ordering of the parts in VAX floats is quite vexing.
7535 * In the below the fraction_n are the mantissa bits.
7537 * The fraction_1 is the most significant (numbering as by DEC/Digital),
7538 * while the rightmost bit in each fraction is the least significant:
7539 * in other words, big-endian bit order within the fractions.
7541 * The fraction segments themselves would be big-endianly, except that
7542 * within 32 bit segments the less significant half comes first, the more
7543 * significant after, except that in the format H (used for long doubles)
7544 * the first fraction segment is alone, because the exponent is wider.
7545 * This means for example that both the most and the least significant
7546 * bits can be in the middle of the floats, not at either end.
7549 * http://nssdc.gsfc.nasa.gov/nssdc/formats/VAXFloatingPoint.htm
7550 * http://www.quadibloc.com/comp/cp0201.htm
7551 * http://h71000.www7.hp.com/doc/82final/6443/6443pro_028.html
7552 * (somebody at HP should be fired for the URLs)
7554 * F fraction_2:16 sign:1 exp:8 fraction_1:7
7555 * (exponent bias 128, hidden first one-bit)
7557 * D fraction_2:16 sign:1 exp:8 fraction_1:7
7558 * fraction_4:16 fraction_3:16
7559 * (exponent bias 128, hidden first one-bit)
7561 * G fraction_2:16 sign:1 exp:11 fraction_1:4
7562 * fraction_4:16 fraction_3:16
7563 * (exponent bias 1024, hidden first one-bit)
7565 * H fraction_1:16 sign:1 exp:15
7566 * fraction_3:16 fraction_2:16
7567 * fraction_5:16 fraction_4:16
7568 * fraction_7:16 fraction_6:16
7569 * (exponent bias 16384, hidden first one-bit)
7570 * (available only on VAX, and only on Fortran?)
7572 * The formats S, T and X are available on the Alpha (and Itanium,
7573 * also known as I64/IA64) and are equivalent with the IEEE-754 formats
7574 * binary32, binary64, and binary128 (commonly: float, double, long double).
7576 * S sign:1 exp:8 mantissa:23
7577 * (exponent bias 127, hidden first one-bit)
7579 * T sign:1 exp:11 mantissa:52
7580 * (exponent bias 1022, hidden first one-bit)
7582 * X sign:1 exp:15 mantissa:112
7583 * (exponent bias 16382, hidden first one-bit)
7587 #ifdef DOUBLE_IS_VAX_FLOAT
7588 # define DOUBLE_VAX_ENDIAN
7591 #ifdef DOUBLE_IS_IEEE_FORMAT
7592 /* All the basic IEEE formats have the implicit bit,
7593 * except for the x86 80-bit extended formats, which will undef this.
7594 * Also note that the IEEE 754 subnormals (formerly known as denormals)
7595 * do not have the implicit bit of one. */
7596 # define NV_IMPLICIT_BIT
7599 #if defined(LONG_DOUBLEKIND) && LONG_DOUBLEKIND != LONG_DOUBLE_IS_DOUBLE
7601 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN || \
7602 LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
7603 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
7604 # define LONGDOUBLE_LITTLE_ENDIAN
7607 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN || \
7608 LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN || \
7609 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
7610 # define LONGDOUBLE_BIG_ENDIAN
7613 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
7614 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
7615 # define LONGDOUBLE_MIX_ENDIAN
7618 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
7619 LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
7620 # define LONGDOUBLE_X86_80_BIT
7621 # ifdef USE_LONG_DOUBLE
7622 # undef NV_IMPLICIT_BIT
7623 # define NV_X86_80_BIT
7627 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE || \
7628 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE || \
7629 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
7630 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
7631 # define LONGDOUBLE_DOUBLEDOUBLE
7634 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_VAX_H_FLOAT
7635 # define LONGDOUBLE_VAX_ENDIAN
7638 #endif /* LONG_DOUBLEKIND */
7640 #ifdef USE_QUADMATH /* assume quadmath endianness == native double endianness */
7641 # if defined(DOUBLE_LITTLE_ENDIAN)
7642 # define NV_LITTLE_ENDIAN
7643 # elif defined(DOUBLE_BIG_ENDIAN)
7644 # define NV_BIG_ENDIAN
7645 # elif defined(DOUBLE_MIX_ENDIAN) /* stretch */
7646 # define NV_MIX_ENDIAN
7648 #elif NVSIZE == DOUBLESIZE
7649 # ifdef DOUBLE_LITTLE_ENDIAN
7650 # define NV_LITTLE_ENDIAN
7652 # ifdef DOUBLE_BIG_ENDIAN
7653 # define NV_BIG_ENDIAN
7655 # ifdef DOUBLE_MIX_ENDIAN
7656 # define NV_MIX_ENDIAN
7658 # ifdef DOUBLE_VAX_ENDIAN
7659 # define NV_VAX_ENDIAN
7661 #elif NVSIZE == LONG_DOUBLESIZE
7662 # ifdef LONGDOUBLE_LITTLE_ENDIAN
7663 # define NV_LITTLE_ENDIAN
7665 # ifdef LONGDOUBLE_BIG_ENDIAN
7666 # define NV_BIG_ENDIAN
7668 # ifdef LONGDOUBLE_MIX_ENDIAN
7669 # define NV_MIX_ENDIAN
7671 # ifdef LONGDOUBLE_VAX_ENDIAN
7672 # define NV_VAX_ENDIAN
7676 /* We have somehow managed not to define the denormal/subnormal
7679 * This may happen if the compiler doesn't expose the C99 math like
7680 * the fpclassify() without some special switches. Perl tries to
7681 * stay C89, so for example -std=c99 is not an option.
7683 * The Perl_isinf() and Perl_isnan() should have been defined even if
7684 * the C99 isinf() and isnan() are unavailable, and the NV_MIN becomes
7685 * from the C89 DBL_MIN or moral equivalent. */
7686 #if !defined(Perl_fp_class_denorm) && defined(Perl_isinf) && defined(Perl_isnan) && defined(NV_MIN)
7687 # define Perl_fp_class_denorm(x) ((x) != 0.0 && !Perl_isinf(x) && !Perl_isnan(x) && PERL_ABS(x) < NV_MIN)
7690 /* This is not a great fallback: subnormals tests will fail,
7691 * but at least Perl will link and 99.999% of tests will work. */
7692 #if !defined(Perl_fp_class_denorm)
7693 # define Perl_fp_class_denorm(x) FALSE
7696 #ifdef DOUBLE_IS_IEEE_FORMAT
7697 # define DOUBLE_HAS_INF
7698 # define DOUBLE_HAS_NAN
7701 #ifdef DOUBLE_HAS_NAN
7707 /* PL_inf and PL_nan initialization.
7709 * For inf and nan initialization the ultimate fallback is dividing
7710 * one or zero by zero: however, some compilers will warn or even fail
7711 * on divide-by-zero, but hopefully something earlier will work.
7713 * If you are thinking of using HUGE_VAL for infinity, or using
7714 * <math.h> functions to generate NV_INF (e.g. exp(1e9), log(-1.0)),
7715 * stop. Neither will work portably: HUGE_VAL can be just DBL_MAX,
7716 * and the math functions might be just generating DBL_MAX, or even zero.
7718 * Also, do NOT try doing NV_NAN based on NV_INF and trying (NV_INF-NV_INF).
7719 * Though logically correct, some compilers (like Visual C 2003)
7720 * falsely misoptimize that to zero (x-x is always zero, right?)
7722 * Finally, note that not all floating point formats define Inf (or NaN).
7723 * For the infinity a large number may be used instead. Operations that
7724 * under the IEEE floating point would return Inf or NaN may return
7725 * either large numbers (positive or negative), or they may cause
7726 * a floating point exception or some other fault.
7729 /* The quadmath literals are anon structs which -Wc++-compat doesn't like. */
7730 # ifndef USE_CPLUSPLUS
7731 GCC_DIAG_IGNORE_DECL(-Wc++-compat);
7734 # ifdef USE_QUADMATH
7735 /* Cannot use HUGE_VALQ for PL_inf because not a compile-time
7737 INFNAN_NV_U8_DECL PL_inf = { 1.0Q/0.0Q };
7738 # elif NVSIZE == LONG_DOUBLESIZE && defined(LONGDBLINFBYTES)
7739 INFNAN_U8_NV_DECL PL_inf = { { LONGDBLINFBYTES } };
7740 # elif NVSIZE == DOUBLESIZE && defined(DOUBLEINFBYTES)
7741 INFNAN_U8_NV_DECL PL_inf = { { DOUBLEINFBYTES } };
7743 # if NVSIZE == LONG_DOUBLESIZE && defined(USE_LONG_DOUBLE)
7744 # if defined(LDBL_INFINITY)
7745 INFNAN_NV_U8_DECL PL_inf = { LDBL_INFINITY };
7746 # elif defined(LDBL_INF)
7747 INFNAN_NV_U8_DECL PL_inf = { LDBL_INF };
7748 # elif defined(INFINITY)
7749 INFNAN_NV_U8_DECL PL_inf = { (NV)INFINITY };
7751 INFNAN_NV_U8_DECL PL_inf = { (NV)INF };
7753 INFNAN_NV_U8_DECL PL_inf = { 1.0L/0.0L }; /* keep last */
7756 # if defined(DBL_INFINITY)
7757 INFNAN_NV_U8_DECL PL_inf = { DBL_INFINITY };
7758 # elif defined(DBL_INF)
7759 INFNAN_NV_U8_DECL PL_inf = { DBL_INF };
7760 # elif defined(INFINITY) /* C99 */
7761 INFNAN_NV_U8_DECL PL_inf = { (NV)INFINITY };
7763 INFNAN_NV_U8_DECL PL_inf = { (NV)INF };
7765 INFNAN_NV_U8_DECL PL_inf = { 1.0/0.0 }; /* keep last */
7770 # ifdef USE_QUADMATH
7771 /* Cannot use nanq("0") for PL_nan because not a compile-time
7773 INFNAN_NV_U8_DECL PL_nan = { 0.0Q/0.0Q };
7774 # elif NVSIZE == LONG_DOUBLESIZE && defined(LONGDBLNANBYTES)
7775 INFNAN_U8_NV_DECL PL_nan = { { LONGDBLNANBYTES } };
7776 # elif NVSIZE == DOUBLESIZE && defined(DOUBLENANBYTES)
7777 INFNAN_U8_NV_DECL PL_nan = { { DOUBLENANBYTES } };
7779 # if NVSIZE == LONG_DOUBLESIZE && defined(USE_LONG_DOUBLE)
7780 # if defined(LDBL_NAN)
7781 INFNAN_NV_U8_DECL PL_nan = { LDBL_NAN };
7782 # elif defined(LDBL_QNAN)
7783 INFNAN_NV_U8_DECL PL_nan = { LDBL_QNAN };
7785 INFNAN_NV_U8_DECL PL_nan = { (NV)NAN };
7787 INFNAN_NV_U8_DECL PL_nan = { 0.0L/0.0L }; /* keep last */
7790 # if defined(DBL_NAN)
7791 INFNAN_NV_U8_DECL PL_nan = { DBL_NAN };
7792 # elif defined(DBL_QNAN)
7793 INFNAN_NV_U8_DECL PL_nan = { DBL_QNAN };
7794 # elif defined(NAN) /* C99 */
7795 INFNAN_NV_U8_DECL PL_nan = { (NV)NAN };
7797 INFNAN_NV_U8_DECL PL_nan = { 0.0/0.0 }; /* keep last */
7802 # ifndef USE_CPLUSPLUS
7803 GCC_DIAG_RESTORE_DECL;
7808 INFNAN_NV_U8_DECL PL_inf;
7809 INFNAN_NV_U8_DECL PL_nan;
7815 /* If you have not defined NV_INF/NV_NAN (like for example win32/win32.h),
7816 * we will define NV_INF/NV_NAN as the nv part of the global const
7817 * PL_inf/PL_nan. Note, however, that the preexisting NV_INF/NV_NAN
7818 * might not be a compile-time constant, in which case it cannot be
7819 * used to initialize PL_inf/PL_nan above. */
7821 # define NV_INF PL_inf.nv
7824 # define NV_NAN PL_nan.nv
7827 /* NaNs (not-a-numbers) can carry payload bits, in addition to
7828 * "nan-ness". Part of the payload is the quiet/signaling bit.
7829 * To back up a bit (harhar):
7831 * For IEEE 754 64-bit formats [1]:
7833 * s 000 (mantissa all-zero) zero
7834 * s 000 (mantissa non-zero) subnormals (denormals)
7835 * s 001 ... 7fe normals
7838 * For IEEE 754 128-bit formats:
7840 * s 0000 (mantissa all-zero) zero
7841 * s 0000 (mantissa non-zero) subnormals (denormals)
7842 * s 0001 ... 7ffe normals
7845 * [1] this looks like big-endian, but applies equally to little-endian.
7847 * s = Sign bit. Yes, zeros and nans can have negative sign,
7848 * the interpretation is application-specific.
7850 * q = Quietness bit, the interpretation is platform-specific.
7851 * Most platforms have the most significant bit being one
7852 * meaning quiet, but some (older mips, hppa) have the msb
7853 * being one meaning signaling. Note that the above means
7854 * that on most platforms there cannot be signaling nan with
7855 * zero payload because that is identical with infinity;
7856 * while conversely on older mips/hppa there cannot be a quiet nan
7857 * because that is identical with infinity.
7859 * Moreover, whether there is any behavioral difference
7860 * between quiet and signaling NaNs, depends on the platform.
7862 * x86 80-bit extended precision is different, the mantissa bits:
7864 * 63 62 61 30387+ pre-387 visual c
7865 * -------- ---- -------- --------
7866 * 0 0 0 invalid infinity
7867 * 0 0 1 invalid snan
7868 * 0 1 0 invalid snan
7869 * 0 1 1 invalid snan
7870 * 1 0 0 infinity snan 1.#INF
7871 * 1 0 1 snan 1.#SNAN
7872 * 1 1 0 qnan -1.#IND (x86 chooses this to negative)
7873 * 1 1 1 qnan 1.#QNAN
7875 * This means that in this format there are 61 bits available
7876 * for the nan payload.
7878 * Note that the 32-bit x86 ABI cannot do signaling nans: the x87
7879 * simply cannot preserve the bit. You can either use the 80-bit
7880 * extended precision (long double, -Duselongdouble), or use x86-64.
7882 * In all platforms, the payload bytes (and bits, some of them are
7883 * often in a partial byte) themselves can be either all zero (x86),
7884 * all one (sparc or mips), or a mixture: in IEEE 754 128-bit double
7885 * or in a double-double, the first half of the payload can follow the
7886 * native double, while in the second half the payload can be all
7887 * zeros. (Therefore the mask for payload bits is not necessarily
7888 * identical to bit complement of the NaN.) Another way of putting
7889 * this: the payload for the default NaN might not be zero.
7891 * For the x86 80-bit long doubles, the trailing bytes (the 80 bits
7892 * being 'packaged' in either 12 or 16 bytes) can be whatever random
7895 * Furthermore, the semantics of the sign bit on NaNs are platform-specific.
7896 * On normal floats, the sign bit being on means negative. But this may,
7897 * or may not, be reverted on NaNs: in other words, the default NaN might
7898 * have the sign bit on, and therefore look like negative if you look
7899 * at it at the bit level.
7901 * NaN payloads are not propagated even on copies, or in arithmetics.
7902 * They *might* be, according to some rules, on your particular
7903 * cpu/os/compiler/libraries, but no guarantees.
7905 * To summarize, on most platforms, and for 64-bit doubles
7906 * (using big-endian ordering here):
7908 * [7FF8000000000000..7FFFFFFFFFFFFFFF] quiet
7909 * [FFF8000000000000..FFFFFFFFFFFFFFFF] quiet
7910 * [7FF0000000000001..7FF7FFFFFFFFFFFF] signaling
7911 * [FFF0000000000001..FFF7FFFFFFFFFFFF] signaling
7913 * The C99 nan() is supposed to generate *quiet* NaNs.
7915 * Note the asymmetry:
7916 * The 7FF0000000000000 is positive infinity,
7917 * the FFF0000000000000 is negative infinity.
7920 /* NVMANTBITS is the number of _real_ mantissa bits in an NV.
7921 * For the standard IEEE 754 fp this number is usually one less that
7922 * *DBL_MANT_DIG because of the implicit (aka hidden) bit, which isn't
7923 * real. For the 80-bit extended precision formats (x86*), the number
7924 * of mantissa bits... depends. For normal floats, it's 64. But for
7925 * the inf/nan, it's different (zero for inf, 61 for nan).
7926 * NVMANTBITS works for normal floats. */
7928 /* We do not want to include the quiet/signaling bit. */
7929 #define NV_NAN_BITS (NVMANTBITS - 1)
7931 #if defined(USE_LONG_DOUBLE) && NVSIZE > DOUBLESIZE
7932 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
7933 # define NV_NAN_QS_BYTE_OFFSET 13
7934 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
7935 # define NV_NAN_QS_BYTE_OFFSET 2
7936 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN
7937 # define NV_NAN_QS_BYTE_OFFSET 7
7938 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
7939 # define NV_NAN_QS_BYTE_OFFSET 2
7940 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
7941 # define NV_NAN_QS_BYTE_OFFSET 13
7942 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
7943 # define NV_NAN_QS_BYTE_OFFSET 1
7944 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE
7945 # define NV_NAN_QS_BYTE_OFFSET 9
7946 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
7947 # define NV_NAN_QS_BYTE_OFFSET 6
7949 # error "Unexpected long double format"
7952 # ifdef USE_QUADMATH
7953 # ifdef NV_LITTLE_ENDIAN
7954 # define NV_NAN_QS_BYTE_OFFSET 13
7955 # elif defined(NV_BIG_ENDIAN)
7956 # define NV_NAN_QS_BYTE_OFFSET 2
7958 # error "Unexpected quadmath format"
7960 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN
7961 # define NV_NAN_QS_BYTE_OFFSET 2
7962 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN
7963 # define NV_NAN_QS_BYTE_OFFSET 1
7964 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN
7965 # define NV_NAN_QS_BYTE_OFFSET 6
7966 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN
7967 # define NV_NAN_QS_BYTE_OFFSET 1
7968 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
7969 # define NV_NAN_QS_BYTE_OFFSET 13
7970 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
7971 # define NV_NAN_QS_BYTE_OFFSET 2
7972 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE
7973 # define NV_NAN_QS_BYTE_OFFSET 2 /* bytes 4 5 6 7 0 1 2 3 (MSB 7) */
7974 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
7975 # define NV_NAN_QS_BYTE_OFFSET 5 /* bytes 3 2 1 0 7 6 5 4 (MSB 7) */
7977 /* For example the VAX formats should never
7978 * get here because they do not have NaN. */
7979 # error "Unexpected double format"
7982 /* NV_NAN_QS_BYTE is the byte to test for the quiet/signaling */
7983 #define NV_NAN_QS_BYTE(nvp) (((U8*)(nvp))[NV_NAN_QS_BYTE_OFFSET])
7984 /* NV_NAN_QS_BIT is the bit to test in the NV_NAN_QS_BYTE_OFFSET
7985 * for the quiet/signaling */
7986 #if defined(USE_LONG_DOUBLE) && \
7987 (LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
7988 LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN)
7989 # define NV_NAN_QS_BIT_SHIFT 6 /* 0x40 */
7990 #elif defined(USE_LONG_DOUBLE) && \
7991 (LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE || \
7992 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE || \
7993 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
7994 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE)
7995 # define NV_NAN_QS_BIT_SHIFT 3 /* 0x08, but not via NV_NAN_BITS */
7997 # define NV_NAN_QS_BIT_SHIFT ((NV_NAN_BITS) % 8) /* usually 3, or 0x08 */
7999 #define NV_NAN_QS_BIT (1 << (NV_NAN_QS_BIT_SHIFT))
8000 /* NV_NAN_QS_BIT_OFFSET is the bit offset from the beginning of a NV
8001 * (bytes ordered big-endianly) for the quiet/signaling bit
8002 * for the quiet/signaling */
8003 #define NV_NAN_QS_BIT_OFFSET \
8004 (8 * (NV_NAN_QS_BYTE_OFFSET) + (NV_NAN_QS_BIT_SHIFT))
8005 /* NV_NAN_QS_QUIET (always defined) is true if the NV_NAN_QS_QS_BIT being
8006 * on indicates quiet NaN. NV_NAN_QS_SIGNALING (also always defined)
8007 * is true if the NV_NAN_QS_BIT being on indicates signaling NaN. */
8008 #define NV_NAN_QS_QUIET \
8009 ((NV_NAN_QS_BYTE(PL_nan.u8) & NV_NAN_QS_BIT) == NV_NAN_QS_BIT)
8010 #define NV_NAN_QS_SIGNALING (!(NV_NAN_QS_QUIET))
8011 #define NV_NAN_QS_TEST(nvp) (NV_NAN_QS_BYTE(nvp) & NV_NAN_QS_BIT)
8012 /* NV_NAN_IS_QUIET() returns true if the NV behind nvp is a NaN,
8013 * whether it is a quiet NaN, NV_NAN_IS_SIGNALING() if a signaling NaN.
8014 * Note however that these do not check whether the nvp is a NaN. */
8015 #define NV_NAN_IS_QUIET(nvp) \
8016 (NV_NAN_QS_TEST(nvp) == (NV_NAN_QS_QUIET ? NV_NAN_QS_BIT : 0))
8017 #define NV_NAN_IS_SIGNALING(nvp) \
8018 (NV_NAN_QS_TEST(nvp) == (NV_NAN_QS_QUIET ? 0 : NV_NAN_QS_BIT))
8019 #define NV_NAN_SET_QUIET(nvp) \
8020 (NV_NAN_QS_QUIET ? \
8021 (NV_NAN_QS_BYTE(nvp) |= NV_NAN_QS_BIT) : \
8022 (NV_NAN_QS_BYTE(nvp) &= ~NV_NAN_QS_BIT))
8023 #define NV_NAN_SET_SIGNALING(nvp) \
8024 (NV_NAN_QS_QUIET ? \
8025 (NV_NAN_QS_BYTE(nvp) &= ~NV_NAN_QS_BIT) : \
8026 (NV_NAN_QS_BYTE(nvp) |= NV_NAN_QS_BIT))
8027 #define NV_NAN_QS_XOR(nvp) (NV_NAN_QS_BYTE(nvp) ^= NV_NAN_QS_BIT)
8029 /* NV_NAN_PAYLOAD_MASK: masking the nan payload bits.
8031 * NV_NAN_PAYLOAD_PERM: permuting the nan payload bytes.
8032 * 0xFF means "don't go here".*/
8034 /* Shorthands to avoid typoses. */
8035 #define NV_NAN_PAYLOAD_MASK_SKIP_EIGHT \
8036 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0
8037 #define NV_NAN_PAYLOAD_PERM_SKIP_EIGHT \
8038 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
8039 #define NV_NAN_PAYLOAD_PERM_0_TO_7 \
8040 0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7
8041 #define NV_NAN_PAYLOAD_PERM_7_TO_0 \
8042 0x7, 0x6, 0x5, 0x4, 0x3, 0x2, 0x1, 0x0
8043 #define NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE \
8044 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
8045 0xff, 0xff, 0xff, 0xff, 0xff, 0x7f, 0x00, 0x00
8046 #define NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE \
8047 NV_NAN_PAYLOAD_PERM_0_TO_7, \
8048 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xFF, 0xFF
8049 #define NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE \
8050 0x00, 0x00, 0x7f, 0xff, 0xff, 0xff, 0xff, 0xff, \
8051 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
8052 #define NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE \
8053 0xFF, 0xFF, 0xd, 0xc, 0xb, 0xa, 0x9, 0x8, \
8054 NV_NAN_PAYLOAD_PERM_7_TO_0
8055 #define NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE \
8056 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x07, 0x00
8057 #define NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE \
8058 0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0xFF
8059 #define NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE \
8060 0x00, 0x07, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
8061 #define NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE \
8062 0xFF, 0x6, 0x5, 0x4, 0x3, 0x2, 0x1, 0x0
8064 #if defined(USE_LONG_DOUBLE) && NVSIZE > DOUBLESIZE
8065 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
8066 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
8067 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
8068 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
8069 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
8070 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
8071 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN
8072 # if LONG_DOUBLESIZE == 10
8073 # define NV_NAN_PAYLOAD_MASK \
8074 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
8076 # define NV_NAN_PAYLOAD_PERM \
8077 NV_NAN_PAYLOAD_PERM_0_TO_7, 0xFF, 0xFF
8078 # elif LONG_DOUBLESIZE == 12
8079 # define NV_NAN_PAYLOAD_MASK \
8080 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
8081 0x00, 0x00, 0x00, 0x00
8082 # define NV_NAN_PAYLOAD_PERM \
8083 NV_NAN_PAYLOAD_PERM_0_TO_7, 0xFF, 0xFF, 0xFF, 0xFF
8084 # elif LONG_DOUBLESIZE == 16
8085 # define NV_NAN_PAYLOAD_MASK \
8086 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
8087 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
8088 # define NV_NAN_PAYLOAD_PERM \
8089 NV_NAN_PAYLOAD_PERM_0_TO_7, \
8090 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
8092 # error "Unexpected x86 80-bit little-endian long double format"
8094 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
8095 # if LONG_DOUBLESIZE == 10
8096 # define NV_NAN_PAYLOAD_MASK \
8097 0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
8099 # define NV_NAN_PAYLOAD_PERM \
8100 NV_NAN_PAYLOAD_PERM_7_TO_0, 0xFF, 0xFF
8101 # elif LONG_DOUBLESIZE == 12
8102 # define NV_NAN_PAYLOAD_MASK \
8103 0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
8104 0xff, 0xff, 0x00, 0x00
8105 # define NV_NAN_PAYLOAD_PERM \
8106 NV_NAN_PAYLOAD_PERM_7_TO_0, 0xFF, 0xFF, 0xFF, 0xFF
8107 # elif LONG_DOUBLESIZE == 16
8108 # define NV_NAN_PAYLOAD_MASK \
8109 0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
8110 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
8111 # define NV_NAN_PAYLOAD_PERM \
8112 NV_NAN_PAYLOAD_PERM_7_TO_0, \
8113 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
8115 # error "Unexpected x86 80-bit big-endian long double format"
8117 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
8118 /* For double-double we assume only the first double (in LE or BE terms)
8119 * is used for NaN. */
8120 # define NV_NAN_PAYLOAD_MASK \
8121 NV_NAN_PAYLOAD_MASK_SKIP_EIGHT, NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
8122 # define NV_NAN_PAYLOAD_PERM \
8123 NV_NAN_PAYLOAD_PERM_SKIP_EIGHT, NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
8124 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
8125 # define NV_NAN_PAYLOAD_MASK \
8126 NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
8127 # define NV_NAN_PAYLOAD_PERM \
8128 NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
8129 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE
8130 # define NV_NAN_PAYLOAD_MASK \
8131 NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
8132 # define NV_NAN_PAYLOAD_PERM \
8133 NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
8134 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
8135 # define NV_NAN_PAYLOAD_MASK \
8136 NV_NAN_PAYLOAD_MASK_SKIP_EIGHT, NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
8137 # define NV_NAN_PAYLOAD_PERM \
8138 NV_NAN_PAYLOAD_PERM_SKIP_EIGHT, NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
8140 # error "Unexpected long double format"
8143 # ifdef USE_QUADMATH /* quadmath is not long double */
8144 # ifdef NV_LITTLE_ENDIAN
8145 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
8146 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
8147 # elif defined(NV_BIG_ENDIAN)
8148 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
8149 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
8151 # error "Unexpected quadmath format"
8153 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN
8154 # define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0x07, 0x00
8155 # define NV_NAN_PAYLOAD_PERM 0x0, 0x1, 0x2, 0xFF
8156 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN
8157 # define NV_NAN_PAYLOAD_MASK 0x00, 0x07, 0xff, 0xff
8158 # define NV_NAN_PAYLOAD_PERM 0xFF, 0x2, 0x1, 0x0
8159 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN
8160 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
8161 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
8162 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN
8163 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
8164 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
8165 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
8166 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
8167 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
8168 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
8169 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
8170 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
8171 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE
8172 # define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0x07, 0x00, 0xff, 0xff, 0xff, 0xff
8173 # define NV_NAN_PAYLOAD_PERM 0x4, 0x5, 0x6, 0xFF, 0x0, 0x1, 0x2, 0x3
8174 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
8175 # define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0xff, 0xff, 0x00, 0x07, 0xff, 0xff
8176 # define NV_NAN_PAYLOAD_PERM 0x3, 0x2, 0x1, 0x0, 0xFF, 0x6, 0x5, 0x4
8178 # error "Unexpected double format"
8182 #endif /* DOUBLE_HAS_NAN */
8187 (KEEP THIS LAST IN perl.h!)
8229 so that Configure picks them up.
8231 (KEEP THIS LAST IN perl.h!)
8235 #endif /* Include guard */
8238 * ex: set ts=8 sts=4 sw=4 et: