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) && _MSC_VER < 1400
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
646 =for apidoc_section $XS
647 =for apidoc Amns||dMY_CXT_SV
648 Now a placeholder that declares nothing
654 /* Backwards compatibility macro for XS code. It used to be part of the
655 * PERL_GLOBAL_STRUCT(_PRIVATE) feature, which no longer exists */
658 /* these are only defined for compatibility; should not be used internally.
660 # define dMY_CXT_SV dNOOP
663 # define pTHXo_ pTHX_
665 # define aTHXo_ aTHX_
667 # define dTHXoa(x) dTHXa(x)
672 # define pTHXx PerlInterpreter *my_perl
673 # define pTHXx_ pTHXx,
674 # define aTHXx my_perl
675 # define aTHXx_ aTHXx,
679 /* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
680 * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
681 * dTHXs is therefore needed for all functions using PerlIO_foo(). */
682 #ifdef PERL_IMPLICIT_SYS
688 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
689 # ifndef PERL_USE_GCC_BRACE_GROUPS
690 # define PERL_USE_GCC_BRACE_GROUPS
695 =for apidoc_section $directives
696 =for apidoc AmnUu|void|STMT_START
697 =for apidoc_item ||STMT_END
699 This allows a series of statements in a macro to be used as a single statement,
702 if (x) STMT_START { ... } STMT_END else ...
704 Note that you can't return a value out of them, which limits their utility.
705 But see C<L</PERL_USE_GCC_BRACE_GROUPS>>.
707 =for apidoc AmnuU|bool|PERL_USE_GCC_BRACE_GROUPS
709 This C pre-processor value, if defined, indicates that it is permissible to use
710 the GCC brace groups extension. This extension, of the form
714 turns the block consisting of I<statements ...> into an expression with a
715 value, unlike plain C language blocks. This can present optimization
716 possibilities, B<BUT> you generally need to specify an alternative in case this
717 ability doesn't exist or has otherwise been forbidden.
723 #ifdef PERL_USE_GCC_BRACE_GROUPS
733 Trying to select a version that gives no warnings...
735 #if !(defined(STMT_START) && defined(STMT_END))
736 # ifdef PERL_USE_GCC_BRACE_GROUPS
737 # define STMT_START (void)( /* gcc supports "({ STATEMENTS; })" */
740 # define STMT_START do
741 # define STMT_END while (0)
745 #ifndef BYTEORDER /* Should never happen -- byteorder is in config.h */
746 # define BYTEORDER 0x1234
749 #if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
756 * The following contortions are brought to you on behalf of all the
757 * standards, semi-standards, de facto standards, not-so-de-facto standards
758 * of the world, as well as all the other botches anyone ever thought of.
759 * The basic theory is that if we work hard enough here, the rest of the
760 * code can be a lot prettier. Well, so much for theory. Sorry, Henry...
763 /* define this once if either system, instead of cluttering up the src */
764 #if defined(MSDOS) || defined(WIN32) || defined(NETWARE)
768 /* These exist only for back-compat with XS modules. */
771 #define CAN_PROTOTYPE
778 /* By compiling a perl with -DNO_TAINT_SUPPORT or -DSILENT_NO_TAINT_SUPPORT,
779 * you get a perl without taint support, but doubtlessly with a lesser
780 * degree of support. Do not do so unless you know exactly what it means
781 * technically, have a good reason to do so, and know exactly how the
782 * perl will be used. perls with -DSILENT_NO_TAINT_SUPPORT are considered
783 * a potential security risk due to flat out ignoring the security-relevant
784 * taint flags. This being said, a perl without taint support compiled in
785 * has marginal run-time performance benefits.
786 * SILENT_NO_TAINT_SUPPORT implies NO_TAINT_SUPPORT.
787 * SILENT_NO_TAINT_SUPPORT is the same as NO_TAINT_SUPPORT except it
788 * silently ignores -t/-T instead of throwing an exception.
790 * DANGER! Using NO_TAINT_SUPPORT or SILENT_NO_TAINT_SUPPORT
791 * voids your nonexistent warranty!
793 #if defined(SILENT_NO_TAINT_SUPPORT) && !defined(NO_TAINT_SUPPORT)
794 # define NO_TAINT_SUPPORT 1
797 /* NO_TAINT_SUPPORT can be set to transform virtually all taint-related
798 * operations into no-ops for a very modest speed-up. Enable only if you
799 * know what you're doing: tests and CPAN modules' tests are bound to fail.
801 #ifdef NO_TAINT_SUPPORT
803 # define TAINT_NOT NOOP
804 # define TAINT_IF(c) NOOP
805 # define TAINT_ENV() NOOP
806 # define TAINT_PROPER(s) NOOP
807 # define TAINT_set(s) NOOP
809 # define TAINTING_get 0
810 # define TAINTING_set(s) NOOP
811 # define TAINT_WARN_get 0
812 # define TAINT_WARN_set(s) NOOP
814 /* Set to tainted if we are running under tainting mode */
815 # define TAINT (PL_tainted = PL_tainting)
817 # define TAINT_NOT (PL_tainted = FALSE) /* Untaint */
818 # define TAINT_IF(c) if (UNLIKELY(c)) { TAINT; } /* Conditionally taint */
819 # define TAINT_ENV() if (UNLIKELY(PL_tainting)) { taint_env(); }
820 /* croak or warn if tainting */
821 # define TAINT_PROPER(s) if (UNLIKELY(PL_tainting)) { \
822 taint_proper(NULL, s); \
824 # define TAINT_set(s) (PL_tainted = (s))
825 # define TAINT_get (cBOOL(UNLIKELY(PL_tainted))) /* Is something tainted? */
826 # define TAINTING_get (cBOOL(UNLIKELY(PL_tainting))) /* Is taint checking enabled? */
827 # define TAINTING_set(s) (PL_tainting = (s))
828 # define TAINT_WARN_get (PL_taint_warn) /* FALSE => tainting violations
832 # define TAINT_WARN_set(s) (PL_taint_warn = (s))
835 /* flags used internally only within pp_subst and pp_substcont */
837 # define SUBST_TAINT_STR 1 /* string tainted */
838 # define SUBST_TAINT_PAT 2 /* pattern tainted */
839 # define SUBST_TAINT_REPL 4 /* replacement tainted */
840 # define SUBST_TAINT_RETAINT 8 /* use re'taint' in scope */
841 # define SUBST_TAINT_BOOLRET 16 /* return is boolean (don't taint) */
844 /* XXX All process group stuff is handled in pp_sys.c. Should these
845 defines move there? If so, I could simplify this a lot. --AD 9/96.
847 /* Process group stuff changed from traditional BSD to POSIX.
848 perlfunc.pod documents the traditional BSD-style syntax, so we'll
849 try to preserve that, if possible.
852 # define BSD_SETPGRP(pid, pgrp) setpgid((pid), (pgrp))
853 #elif defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
854 # define BSD_SETPGRP(pid, pgrp) setpgrp((pid), (pgrp))
855 #elif defined(HAS_SETPGRP2)
856 # define BSD_SETPGRP(pid, pgrp) setpgrp2((pid), (pgrp))
858 #if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
859 # define HAS_SETPGRP /* Well, effectively it does . . . */
862 /* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
863 our life easier :-) so we'll try it.
866 # define BSD_GETPGRP(pid) getpgid((pid))
867 #elif defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
868 # define BSD_GETPGRP(pid) getpgrp((pid))
869 #elif defined(HAS_GETPGRP2)
870 # define BSD_GETPGRP(pid) getpgrp2((pid))
872 #if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
873 # define HAS_GETPGRP /* Well, effectively it does . . . */
876 /* These are not exact synonyms, since setpgrp() and getpgrp() may
877 have different behaviors, but perl.h used to define USE_BSDPGRP
878 (prior to 5.003_05) so some extension might depend on it.
880 #if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
886 /* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
887 pthread.h must be included before all other header files.
889 #if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
890 # include <pthread.h>
893 #include <sys/types.h>
909 #ifdef METHOD /* Defined by OSF/1 v3.0 by ctype.h */
922 # include <xlocale.h>
925 /* If not forbidden, we enable locale handling if either 1) the POSIX 2008
926 * functions are available, or 2) just the setlocale() function. This logic is
927 * repeated in t/loc_tools.pl and makedef.pl; The three should be kept in
929 #if ! defined(NO_LOCALE)
931 # if ! defined(NO_POSIX_2008_LOCALE) \
932 && defined(HAS_NEWLOCALE) \
933 && defined(HAS_USELOCALE) \
934 && defined(HAS_DUPLOCALE) \
935 && defined(HAS_FREELOCALE) \
936 && defined(LC_ALL_MASK)
938 /* For simplicity, the code is written to assume that any platform advanced
939 * enough to have the Posix 2008 locale functions has LC_ALL. The final
940 * test above makes sure that assumption is valid */
942 # define HAS_POSIX_2008_LOCALE
944 # elif defined(HAS_SETLOCALE)
950 # define HAS_SKIP_LOCALE_INIT /* Solely for XS code to test for this
952 # if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
953 && defined(HAS_STRXFRM)
954 # define USE_LOCALE_COLLATE
956 # if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
957 # define USE_LOCALE_CTYPE
959 # if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
960 # define USE_LOCALE_NUMERIC
962 # if !defined(NO_LOCALE_MESSAGES) && defined(LC_MESSAGES)
963 # define USE_LOCALE_MESSAGES
965 # if !defined(NO_LOCALE_MONETARY) && defined(LC_MONETARY)
966 # define USE_LOCALE_MONETARY
968 # if !defined(NO_LOCALE_TIME) && defined(LC_TIME)
969 # define USE_LOCALE_TIME
971 # if !defined(NO_LOCALE_ADDRESS) && defined(LC_ADDRESS)
972 # define USE_LOCALE_ADDRESS
974 # if !defined(NO_LOCALE_IDENTIFICATION) && defined(LC_IDENTIFICATION)
975 # define USE_LOCALE_IDENTIFICATION
977 # if !defined(NO_LOCALE_MEASUREMENT) && defined(LC_MEASUREMENT)
978 # define USE_LOCALE_MEASUREMENT
980 # if !defined(NO_LOCALE_PAPER) && defined(LC_PAPER)
981 # define USE_LOCALE_PAPER
983 # if !defined(NO_LOCALE_TELEPHONE) && defined(LC_TELEPHONE)
984 # define USE_LOCALE_TELEPHONE
986 # if !defined(NO_LOCALE_SYNTAX) && defined(LC_SYNTAX)
987 # define USE_LOCALE_SYNTAX
989 # if !defined(NO_LOCALE_TOD) && defined(LC_TOD)
990 # define USE_LOCALE_TOD
993 /* XXX The next few defines are unfortunately duplicated in makedef.pl, and
994 * changes here MUST also be made there */
996 # if ! defined(HAS_SETLOCALE) && defined(HAS_POSIX_2008_LOCALE)
997 # define USE_POSIX_2008_LOCALE
998 # ifndef USE_THREAD_SAFE_LOCALE
999 # define USE_THREAD_SAFE_LOCALE
1002 * -DUSE_THREAD_SAFE_LOCALE, will do so even
1003 * on unthreaded builds */
1004 # elif (defined(USE_ITHREADS) || defined(USE_THREAD_SAFE_LOCALE)) \
1005 && ( defined(HAS_POSIX_2008_LOCALE) \
1006 || (defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1400)) \
1007 && ! defined(NO_THREAD_SAFE_LOCALE)
1008 # ifndef USE_THREAD_SAFE_LOCALE
1009 # define USE_THREAD_SAFE_LOCALE
1011 # ifdef HAS_POSIX_2008_LOCALE
1012 # define USE_POSIX_2008_LOCALE
1017 /* Microsoft documentation reads in the change log for VS 2015:
1018 * "The localeconv function declared in locale.h now works correctly when
1019 * per-thread locale is enabled. In previous versions of the library, this
1020 * function would return the lconv data for the global locale, not the
1023 #if defined(WIN32) && defined(USE_THREAD_SAFE_LOCALE) && _MSC_VER < 1900
1024 # define TS_W32_BROKEN_LOCALECONV
1030 # ifdef PARAM_NEEDS_TYPES
1031 # include <sys/types.h>
1033 # include <sys/param.h>
1036 /* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
1037 value something like 199306. This may be useful if no more-specific
1038 feature test is available.
1046 /* Use all the "standard" definitions */
1049 /* If this causes problems, set i_unistd=undef in the hint file. */
1051 # if defined(__amigaos4__)
1052 # ifdef I_NETINET_IN
1053 # include <netinet/in.h>
1056 # include <unistd.h>
1057 # if defined(__amigaos4__)
1058 /* Under AmigaOS 4 newlib.library provides an environ. However using
1059 * it doesn't give us enough control over inheritance of variables by
1060 * subshells etc. so replace with custom version based on abc-shell
1062 extern char **myenviron;
1064 # define environ myenviron
1070 # include <sys/wait.h>
1073 #if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
1074 EXTERN_C int syscall(int, ...);
1077 #if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
1078 EXTERN_C int usleep(unsigned int);
1081 /* Macros for correct constant construction. These are in C99 <stdint.h>
1082 * (so they will not be available in strict C89 mode), but they are nice, so
1083 * let's define them if necessary.
1084 =for apidoc_section $integer
1085 =for apidoc Am|I16|INT16_C|number
1086 =for apidoc_item |I32|INT32_C|number
1087 =for apidoc_item |I64|INT64_C|number
1089 Returns a token the C compiler recognizes for the constant C<number> of the
1090 corresponding integer type on the machine.
1092 If the machine does not have a 64-bit type, C<INT64_C> is undefined.
1093 Use C<L</INTMAX_C>> to get the largest type available on the platform.
1095 =for apidoc Am|U16|UINT16_C|number
1096 =for apidoc_item |U32|UINT32_C|number
1097 =for apidoc_item |U64|UINT64_C|number
1099 Returns a token the C compiler recognizes for the constant C<number> of the
1100 corresponding unsigned integer type on the machine.
1102 If the machine does not have a 64-bit type, C<UINT64_C> is undefined.
1103 Use C<L</UINTMAX_C>> to get the largest type available on the platform.
1110 # define UINT16_C(x) ((U16_TYPE)x##U)
1112 # define UINT16_C(x) ((U16_TYPE)x##UL)
1118 # define UINT32_C(x) ((U32_TYPE)x##U)
1120 # define UINT32_C(x) ((U32_TYPE)x##UL)
1125 typedef intmax_t PERL_INTMAX_T;
1126 typedef uintmax_t PERL_UINTMAX_T;
1129 /* N.B. We use QUADKIND here instead of HAS_QUAD here, because that doesn't
1130 * actually mean what it has always been documented to mean (see RT #119753)
1131 * and is explicitly turned off outside of core with dire warnings about
1132 * removing the undef. */
1134 #if defined(QUADKIND)
1135 # undef PeRl_INT64_C
1136 # undef PeRl_UINT64_C
1137 /* Prefer the native integer types (int and long) over long long
1138 * (which is not C89) and Win32-specific __int64. */
1139 # if QUADKIND == QUAD_IS_INT && INTSIZE == 8
1140 # define PeRl_INT64_C(c) (c)
1141 # define PeRl_UINT64_C(c) CAT2(c,U)
1143 # if QUADKIND == QUAD_IS_LONG && LONGSIZE == 8
1144 # define PeRl_INT64_C(c) CAT2(c,L)
1145 # define PeRl_UINT64_C(c) CAT2(c,UL)
1147 # if QUADKIND == QUAD_IS_LONG_LONG && defined(HAS_LONG_LONG)
1148 # define PeRl_INT64_C(c) CAT2(c,LL)
1149 # define PeRl_UINT64_C(c) CAT2(c,ULL)
1151 # if QUADKIND == QUAD_IS___INT64
1152 # define PeRl_INT64_C(c) CAT2(c,I64)
1153 # define PeRl_UINT64_C(c) CAT2(c,UI64)
1155 # ifndef PeRl_INT64_C
1156 # define PeRl_INT64_C(c) ((I64)(c)) /* last resort */
1157 # define PeRl_UINT64_C(c) ((U64TYPE)(c))
1159 /* In OS X the INT64_C/UINT64_C are defined with LL/ULL, which will
1160 * not fly with C89-pedantic gcc, so let's undefine them first so that
1161 * we can redefine them with our native integer preferring versions. */
1162 # if defined(PERL_DARWIN) && defined(PERL_GCC_PEDANTIC)
1167 # define INT64_C(c) PeRl_INT64_C(c)
1170 # define UINT64_C(c) PeRl_UINT64_C(c)
1174 =for apidoc_section $integer
1175 =for apidoc Am||INTMAX_C|number
1176 Returns a token the C compiler recognizes for the constant C<number> of the
1177 widest integer type on the machine. For example, if the machine has C<long
1178 long>s, C<INTMAX_C(-1)> would yield
1182 See also, for example, C<L</INT32_C>>.
1184 Use L</IV> to declare variables of the maximum usable size on this platform.
1186 =for apidoc Am||UINTMAX_C|number
1187 Returns a token the C compiler recognizes for the constant C<number> of the
1188 widest unsigned integer type on the machine. For example, if the machine has
1189 C<long>s, C<UINTMAX_C(1)> would yield
1193 See also, for example, C<L</UINT32_C>>.
1195 Use L</UV> to declare variables of the maximum usable size on this platform.
1201 typedef I64TYPE PERL_INTMAX_T;
1202 typedef U64TYPE PERL_UINTMAX_T;
1205 # define INTMAX_C(c) INT64_C(c)
1208 # define UINTMAX_C(c) UINT64_C(c)
1211 #else /* below QUADKIND is undefined */
1213 /* Perl doesn't work on 16 bit systems, so must be 32 bit */
1215 typedef I32TYPE PERL_INTMAX_T;
1216 typedef U32TYPE PERL_UINTMAX_T;
1219 # define INTMAX_C(c) INT32_C(c)
1222 # define UINTMAX_C(c) UINT32_C(c)
1225 #endif /* no QUADKIND */
1229 /* byte-swapping functions for big-/little-endian conversion */
1230 # define _swab_16_(x) ((U16)( \
1231 (((U16)(x) & UINT16_C(0x00ff)) << 8) | \
1232 (((U16)(x) & UINT16_C(0xff00)) >> 8) ))
1234 # define _swab_32_(x) ((U32)( \
1235 (((U32)(x) & UINT32_C(0x000000ff)) << 24) | \
1236 (((U32)(x) & UINT32_C(0x0000ff00)) << 8) | \
1237 (((U32)(x) & UINT32_C(0x00ff0000)) >> 8) | \
1238 (((U32)(x) & UINT32_C(0xff000000)) >> 24) ))
1241 # define _swab_64_(x) ((U64)( \
1242 (((U64)(x) & UINT64_C(0x00000000000000ff)) << 56) | \
1243 (((U64)(x) & UINT64_C(0x000000000000ff00)) << 40) | \
1244 (((U64)(x) & UINT64_C(0x0000000000ff0000)) << 24) | \
1245 (((U64)(x) & UINT64_C(0x00000000ff000000)) << 8) | \
1246 (((U64)(x) & UINT64_C(0x000000ff00000000)) >> 8) | \
1247 (((U64)(x) & UINT64_C(0x0000ff0000000000)) >> 24) | \
1248 (((U64)(x) & UINT64_C(0x00ff000000000000)) >> 40) | \
1249 (((U64)(x) & UINT64_C(0xff00000000000000)) >> 56) ))
1252 /* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
1253 at least on FreeBSD. YMMV, so experiment. */
1254 #ifndef PERL_ARENA_SIZE
1255 #define PERL_ARENA_SIZE 4080
1258 /* Maximum level of recursion */
1259 #ifndef PERL_SUB_DEPTH_WARN
1260 #define PERL_SUB_DEPTH_WARN 100
1263 #endif /* PERL_CORE */
1265 /* Maximum number of args that may be passed to an OP_MULTICONCAT op.
1266 * It determines the size of local arrays in S_maybe_multiconcat() and
1269 #define PERL_MULTICONCAT_MAXARG 64
1271 /* The indexes of fields of a multiconcat aux struct.
1272 * The fixed fields are followed by nargs+1 const segment lengths,
1273 * and if utf8 and non-utf8 differ, a second nargs+1 set for utf8.
1276 #define PERL_MULTICONCAT_IX_NARGS 0 /* number of arguments */
1277 #define PERL_MULTICONCAT_IX_PLAIN_PV 1 /* non-utf8 constant string */
1278 #define PERL_MULTICONCAT_IX_PLAIN_LEN 2 /* non-utf8 constant string length */
1279 #define PERL_MULTICONCAT_IX_UTF8_PV 3 /* utf8 constant string */
1280 #define PERL_MULTICONCAT_IX_UTF8_LEN 4 /* utf8 constant string length */
1281 #define PERL_MULTICONCAT_IX_LENGTHS 5 /* first of nargs+1 const segment lens */
1282 #define PERL_MULTICONCAT_HEADER_SIZE 5 /* The number of fields of a
1283 multiconcat header */
1285 /* We no longer default to creating a new SV for GvSV.
1286 Do this before embed. */
1287 #ifndef PERL_CREATE_GVSV
1288 # ifndef PERL_DONT_CREATE_GVSV
1289 # define PERL_DONT_CREATE_GVSV
1293 #if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
1294 #define PERL_USES_PL_PIDSTATUS
1297 #if !defined(OS2) && !defined(WIN32) && !defined(DJGPP)
1298 #define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
1301 #define MEM_SIZE Size_t
1303 /* Round all values passed to malloc up, by default to a multiple of
1306 #ifndef PERL_STRLEN_ROUNDUP_QUANTUM
1307 #define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
1310 /* sv_grow() will expand strings by at least a certain percentage of
1311 the previously *used* length to avoid excessive calls to realloc().
1312 The default is 25% of the current length.
1314 #ifndef PERL_STRLEN_EXPAND_SHIFT
1315 # define PERL_STRLEN_EXPAND_SHIFT 2
1318 /* This use of offsetof() requires /Zc:offsetof- for VS2017 (and presumably
1319 * onwards) when building Socket.xs, but we can just use a different definition
1320 * for STRUCT_OFFSET instead. */
1321 #if defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1910
1322 # define STRUCT_OFFSET(s,m) (Size_t)(&(((s *)0)->m))
1324 # include <stddef.h>
1325 # define STRUCT_OFFSET(s,m) offsetof(s,m)
1328 /* ptrdiff_t is C11, so undef it under pedantic builds. (Actually it is
1329 * in C89, but apparently there are platforms where it doesn't exist. See
1330 * thread beginning at http://nntp.perl.org/group/perl.perl5.porters/251541.)
1332 #ifdef PERL_GCC_PEDANTIC
1333 # undef HAS_PTRDIFF_T
1336 #ifdef HAS_PTRDIFF_T
1337 # define Ptrdiff_t ptrdiff_t
1339 # define Ptrdiff_t SSize_t
1342 # include <string.h>
1344 /* This comes after <stdlib.h> so we don't try to change the standard
1345 * library prototypes; we'll use our own in proto.h instead. */
1348 # ifdef PERL_POLLUTE_MALLOC
1349 # ifndef PERL_EXTMALLOC_DEF
1350 # define Perl_malloc malloc
1351 # define Perl_calloc calloc
1352 # define Perl_realloc realloc
1353 # define Perl_mfree free
1356 # define EMBEDMYMALLOC /* for compatibility */
1359 # define safemalloc Perl_malloc
1360 # define safecalloc Perl_calloc
1361 # define saferealloc Perl_realloc
1362 # define safefree Perl_mfree
1363 # define CHECK_MALLOC_TOO_LATE_FOR_(code) STMT_START { \
1364 if (!TAINTING_get && MallocCfg_ptr[MallocCfg_cfg_env_read]) \
1367 # define CHECK_MALLOC_TOO_LATE_FOR(ch) \
1368 CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
1369 # define panic_write2(s) write(2, s, strlen(s))
1370 # define CHECK_MALLOC_TAINT(newval) \
1371 CHECK_MALLOC_TOO_LATE_FOR_( \
1373 PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
1375 # define MALLOC_CHECK_TAINT(argc,argv,env) STMT_START { \
1376 if (doing_taint(argc,argv,env)) { \
1377 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1; \
1379 #else /* MYMALLOC */
1380 # define safemalloc safesysmalloc
1381 # define safecalloc safesyscalloc
1382 # define saferealloc safesysrealloc
1383 # define safefree safesysfree
1384 # define CHECK_MALLOC_TOO_LATE_FOR(ch) ((void)0)
1385 # define CHECK_MALLOC_TAINT(newval) ((void)0)
1386 # define MALLOC_CHECK_TAINT(argc,argv,env)
1387 #endif /* MYMALLOC */
1389 /* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
1390 #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)
1391 #define TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, "")
1392 #define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
1393 #define MALLOC_CHECK_TAINT2(argc,argv) MALLOC_CHECK_TAINT(argc,argv,NULL)
1396 =for apidoc Am|void|memzero|void * d|Size_t l
1397 Set the C<l> bytes starting at C<*d> to all zeroes.
1402 # define memzero(d,l) memset(d,0,l)
1406 # include <netinet/in.h>
1410 # include <arpa/inet.h>
1414 # include <sys/stat.h>
1417 /* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1418 This definition should ideally go into win32/win32.h, but S_IFIFO is
1419 used later here in perl.h before win32/win32.h is being included. */
1420 #if !defined(S_IFIFO) && defined(_S_IFIFO)
1421 # define S_IFIFO _S_IFIFO
1424 /* The stat macros for Unisoft System V/88 (and derivatives
1425 like UTekV) are broken, sometimes giving false positives. Undefine
1426 them here and let the code below set them to proper values.
1428 The ghs macro stands for GreenHills Software C-1.8.5 which
1429 is the C compiler for sysV88 and the various derivatives.
1430 This header file bug is corrected in gcc-2.5.8 and later versions.
1431 --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94. */
1433 #if defined(m88k) && defined(ghs)
1445 # ifdef I_SYS_TIME_KERNEL
1448 # include <sys/time.h>
1449 # ifdef I_SYS_TIME_KERNEL
1454 #if defined(HAS_TIMES) && defined(I_SYS_TIMES)
1455 # include <sys/times.h>
1460 #if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
1461 # define WIN32SCK_IS_STDSCK /* don't pull in custom wsock layer */
1464 #if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1465 # include <sys/socket.h>
1466 # if defined(USE_SOCKS) && defined(I_SOCKS)
1467 # if !defined(INCLUDE_PROTOTYPES)
1468 # define INCLUDE_PROTOTYPES /* for <socks.h> */
1469 # define PERL_SOCKS_NEED_PROTOTYPES
1472 # ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1473 # undef INCLUDE_PROTOTYPES
1474 # undef PERL_SOCKS_NEED_PROTOTYPES
1485 # include <net/errno.h>
1490 /* sockatmark() is so new (2001) that many places might have it hidden
1491 * behind some -D_BLAH_BLAH_SOURCE guard. The __THROW magic is required
1492 * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
1493 #if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
1494 # if defined(__THROW) && defined(__GLIBC__)
1495 int sockatmark(int) __THROW;
1497 int sockatmark(int);
1501 #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. */
1502 EXTERN_C int fchdir(int);
1503 EXTERN_C int flock(int, int);
1504 EXTERN_C int fseeko(FILE *, off_t, int);
1505 EXTERN_C off_t ftello(FILE *);
1508 #if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1509 EXTERN_C char *crypt(const char *, const char *);
1512 #if defined(__cplusplus) && defined(__CYGWIN__)
1513 EXTERN_C char *crypt(const char *, const char *);
1517 =for apidoc_section $errno
1519 =for apidoc m|void|SETERRNO|int errcode|int vmserrcode
1521 Set C<errno>, and on VMS set C<vaxc$errno>.
1523 =for apidoc mn|void|dSAVEDERRNO
1525 Declare variables needed to save C<errno> and any operating system
1526 specific error number.
1528 =for apidoc mn|void|dSAVE_ERRNO
1530 Declare variables needed to save C<errno> and any operating system
1531 specific error number, and save them for optional later restoration
1532 by C<RESTORE_ERRNO>.
1534 =for apidoc mn|void|SAVE_ERRNO
1536 Save C<errno> and any operating system specific error number for
1537 optional later restoration by C<RESTORE_ERRNO>. Requires
1538 C<dSAVEDERRNO> or C<dSAVE_ERRNO> in scope.
1540 =for apidoc mn|void|RESTORE_ERRNO
1542 Restore C<errno> and any operating system specific error number that
1543 was saved by C<dSAVE_ERRNO> or C<RESTORE_ERRNO>.
1549 # undef SETERRNO /* SOCKS might have defined this */
1553 # define SETERRNO(errcode,vmserrcode) \
1555 set_errno(errcode); \
1556 set_vaxc_errno(vmserrcode); \
1558 # define dSAVEDERRNO int saved_errno; unsigned saved_vms_errno
1559 # define dSAVE_ERRNO int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1560 # define SAVE_ERRNO ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1561 # define RESTORE_ERRNO SETERRNO(saved_errno, saved_vms_errno)
1563 # define LIB_INVARG LIB$_INVARG
1564 # define RMS_DIR RMS$_DIR
1565 # define RMS_FAC RMS$_FAC
1566 # define RMS_FEX RMS$_FEX
1567 # define RMS_FNF RMS$_FNF
1568 # define RMS_IFI RMS$_IFI
1569 # define RMS_ISI RMS$_ISI
1570 # define RMS_PRV RMS$_PRV
1571 # define SS_ACCVIO SS$_ACCVIO
1572 # define SS_DEVOFFLINE SS$_DEVOFFLINE
1573 # define SS_IVCHAN SS$_IVCHAN
1574 # define SS_NORMAL SS$_NORMAL
1575 # define SS_NOPRIV SS$_NOPRIV
1576 # define SS_BUFFEROVF SS$_BUFFEROVF
1578 # define LIB_INVARG 0
1586 # define SS_ACCVIO 0
1587 # define SS_DEVOFFLINE 0
1588 # define SS_IVCHAN 0
1589 # define SS_NORMAL 0
1590 # define SS_NOPRIV 0
1591 # define SS_BUFFEROVF 0
1595 # define dSAVEDERRNO int saved_errno; DWORD saved_win32_errno
1596 # define dSAVE_ERRNO int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1597 # define SAVE_ERRNO ( saved_errno = errno, saved_win32_errno = GetLastError() )
1598 # define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1602 # define dSAVEDERRNO int saved_errno; unsigned long saved_os2_errno
1603 # define dSAVE_ERRNO int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1604 # define SAVE_ERRNO ( saved_errno = errno, saved_os2_errno = Perl_rc )
1605 # define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1609 # define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1613 # define dSAVEDERRNO int saved_errno
1614 # define dSAVE_ERRNO int saved_errno = errno
1615 # define SAVE_ERRNO (saved_errno = errno)
1616 # define RESTORE_ERRNO (errno = saved_errno)
1620 =for apidoc_section $warning
1622 =for apidoc Amn|SV *|ERRSV
1624 Returns the SV for C<$@>, creating it if needed.
1626 =for apidoc Am|void|CLEAR_ERRSV
1628 Clear the contents of C<$@>, setting it to the empty string.
1630 This replaces any read-only SV with a fresh SV and removes any magic.
1632 =for apidoc Am|void|SANE_ERRSV
1634 Clean up ERRSV so we can safely set it.
1636 This replaces any read-only SV with a fresh writable copy and removes
1642 #define ERRSV GvSVn(PL_errgv)
1644 /* contains inlined gv_add_by_type */
1645 #define CLEAR_ERRSV() STMT_START { \
1646 SV ** const svp = &GvSV(PL_errgv); \
1648 *svp = newSVpvs(""); \
1649 } else if (SvREADONLY(*svp)) { \
1650 SvREFCNT_dec_NN(*svp); \
1651 *svp = newSVpvs(""); \
1653 SV *const errsv = *svp; \
1655 SvPOK_only(errsv); \
1656 if (SvMAGICAL(errsv)) { \
1662 /* contains inlined gv_add_by_type */
1663 #define SANE_ERRSV() STMT_START { \
1664 SV ** const svp = &GvSV(PL_errgv); \
1666 *svp = newSVpvs(""); \
1667 } else if (SvREADONLY(*svp)) { \
1668 SV *dupsv = newSVsv(*svp); \
1669 SvREFCNT_dec_NN(*svp); \
1672 SV *const errsv = *svp; \
1673 if (SvMAGICAL(errsv)) { \
1681 # define DEFSV (0 + GvSVn(PL_defgv))
1682 # define DEFSV_set(sv) \
1683 (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1684 # define SAVE_DEFSV \
1686 save_gp(PL_defgv, 0), \
1687 GvINTRO_off(PL_defgv), \
1688 SAVEGENERICSV(GvSV(PL_defgv)), \
1689 GvSV(PL_defgv) = NULL \
1692 # define DEFSV GvSVn(PL_defgv)
1693 # define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1694 # define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
1698 =for apidoc_section $SV
1699 =for apidoc Amn|SV *|DEFSV
1700 Returns the SV associated with C<$_>
1702 =for apidoc Am|void|DEFSV_set|SV * sv
1703 Associate C<sv> with C<$_>
1705 =for apidoc Amn|void|SAVE_DEFSV
1706 Localize C<$_>. See L<perlguts/Localizing changes>.
1712 extern int errno; /* ANSI allows errno to be an lvalue expr.
1713 * For example in multithreaded environments
1714 * something like this might happen:
1715 * extern int *_errno(void);
1716 * #define errno (*_errno()) */
1719 #define UNKNOWN_ERRNO_MSG "(unknown)"
1722 #define Strerror(e) strerror((e), vaxc$errno)
1724 #define Strerror(e) strerror(e)
1729 # include <sys/ioctl.h>
1733 #if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
1734 # ifdef HAS_SOCKETPAIR
1735 # undef HAS_SOCKETPAIR
1742 #ifndef HAS_SOCKETPAIR
1744 # define socketpair Perl_my_socketpair
1749 # define htoni htons
1750 # define ntohi ntohs
1752 # define htoni htonl
1753 # define ntohi ntohl
1756 /* Configure already sets Direntry_t */
1757 #if defined(I_DIRENT)
1758 # include <dirent.h>
1759 #elif defined(I_SYS_NDIR)
1760 # include <sys/ndir.h>
1761 #elif defined(I_SYS_DIR)
1762 # include <sys/dir.h>
1766 * The following gobbledygook brought to you on behalf of __STDC__.
1767 * (I could just use #ifndef __STDC__, but this is more bulletproof
1768 * in the face of half-implementations.)
1771 #if defined(I_SYSMODE)
1772 #include <sys/mode.h>
1777 # define S_IFMT _S_IFMT
1779 # define S_IFMT 0170000
1784 # define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1788 # define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1793 # define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1795 # define S_ISBLK(m) (0)
1800 # define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1805 # define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1807 # define S_ISFIFO(m) (0)
1813 # define S_ISLNK(m) _S_ISLNK(m)
1814 # elif defined(_S_IFLNK)
1815 # define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1816 # elif defined(S_IFLNK)
1817 # define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1819 # define S_ISLNK(m) (0)
1825 # define S_ISSOCK(m) _S_ISSOCK(m)
1826 # elif defined(_S_IFSOCK)
1827 # define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1828 # elif defined(S_IFSOCK)
1829 # define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1831 # define S_ISSOCK(m) (0)
1837 # define S_IRUSR S_IREAD
1838 # define S_IWUSR S_IWRITE
1839 # define S_IXUSR S_IEXEC
1841 # define S_IRUSR 0400
1842 # define S_IWUSR 0200
1843 # define S_IXUSR 0100
1849 # define S_IRGRP (S_IRUSR>>3)
1850 # define S_IWGRP (S_IWUSR>>3)
1851 # define S_IXGRP (S_IXUSR>>3)
1853 # define S_IRGRP 0040
1854 # define S_IWGRP 0020
1855 # define S_IXGRP 0010
1861 # define S_IROTH (S_IRUSR>>6)
1862 # define S_IWOTH (S_IWUSR>>6)
1863 # define S_IXOTH (S_IXUSR>>6)
1865 # define S_IROTH 0040
1866 # define S_IWOTH 0020
1867 # define S_IXOTH 0010
1872 # define S_ISUID 04000
1876 # define S_ISGID 02000
1880 # define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
1884 # define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
1888 # define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
1891 /* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
1892 * which would get included through <sys/file.h >, but that is 3000
1893 * lines in the future. --jhi */
1895 #if !defined(S_IREAD) && !defined(__HAIKU__)
1896 # define S_IREAD S_IRUSR
1899 #if !defined(S_IWRITE) && !defined(__HAIKU__)
1900 # define S_IWRITE S_IWUSR
1904 # define S_IEXEC S_IXUSR
1907 #if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
1908 # define SLOPPYDIVIDE
1915 /* This used to be conditionally defined based on whether we had a sprintf()
1916 * that correctly returns the string length (as required by C89), but we no
1917 * longer need that. XS modules can (and do) use this name, so it must remain
1918 * a part of the API that's visible to modules.
1920 =for apidoc_section $string
1921 =for apidoc ATmD|int|my_sprintf|NN char *buffer|NN const char *pat|...
1923 Do NOT use this due to the possibility of overflowing C<buffer>. Instead use
1928 #define my_sprintf sprintf
1931 * If we have v?snprintf() and the C99 variadic macros, we can just
1932 * use just the v?snprintf(). It is nice to try to trap the buffer
1933 * overflow, however, so if we are DEBUGGING, and we cannot use the
1934 * gcc statement expressions, then use the function wrappers which try
1935 * to trap the overflow. If we can use the gcc statement expressions,
1936 * we can try that even with the version that uses the C99 variadic
1940 /* Note that we do not check against snprintf()/vsnprintf() returning
1941 * negative values because that is non-standard behaviour and we use
1942 * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1943 * that should be true only if the snprintf()/vsnprintf() are true
1944 * to the standard. */
1946 #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
1949 # define my_snprintf Perl_my_snprintf
1950 # define PERL_MY_SNPRINTF_GUARDED
1951 #elif defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1952 # ifdef PERL_USE_GCC_BRACE_GROUPS
1953 # define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1954 # define PERL_MY_SNPRINTF_GUARDED
1956 # define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
1959 # define my_snprintf Perl_my_snprintf
1960 # define PERL_MY_SNPRINTF_GUARDED
1963 /* There is no quadmath_vsnprintf, and therefore my_vsnprintf()
1964 * dies if called under USE_QUADMATH. */
1965 #if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1966 # ifdef PERL_USE_GCC_BRACE_GROUPS
1967 # define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1968 # define PERL_MY_VSNPRINTF_GUARDED
1970 # define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
1973 # define my_vsnprintf Perl_my_vsnprintf
1974 # define PERL_MY_VSNPRINTF_GUARDED
1977 /* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1978 * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1979 * the result of my_snprintf() or my_vsnprintf(). (No, you should not
1980 * completely ignore it: otherwise you cannot know whether your output
1983 * int len = my_sprintf(buf, max, ...);
1984 * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1986 * The trick is that in certain platforms [a] the my_sprintf() already
1987 * contains the sanity check, while in certain platforms [b] it needs
1988 * to be done as a separate step. The POST_GUARD is that step-- in [a]
1989 * platforms the POST_GUARD actually does nothing since the check has
1990 * already been done. Watch out for the max being the same in both calls.
1992 * If you actually use the snprintf/vsnprintf return value already,
1993 * you assumedly are checking its validity somehow. But you can
1994 * insert the POST_GUARD() also in that case. */
1996 #ifndef PERL_MY_SNPRINTF_GUARDED
1997 # define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1999 # define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
2002 #ifndef PERL_MY_VSNPRINTF_GUARDED
2003 # define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
2005 # define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
2009 # define my_strlcat strlcat
2012 #if defined(PERL_CORE) || defined(PERL_EXT)
2014 # define my_memrchr memrchr
2016 # define my_memrchr S_my_memrchr
2021 # define my_strlcpy strlcpy
2025 # define my_strnlen strnlen
2029 The IV type is supposed to be long enough to hold any integral
2031 --Andy Dougherty August 1996
2037 #if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
2038 # if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
2039 # define IV_MAX ((IV)INT64_MAX)
2040 # define IV_MIN ((IV)INT64_MIN)
2041 # define UV_MAX ((UV)UINT64_MAX)
2043 # define UINT64_MIN 0
2045 # define UV_MIN ((UV)UINT64_MIN)
2047 # define IV_MAX PERL_QUAD_MAX
2048 # define IV_MIN PERL_QUAD_MIN
2049 # define UV_MAX PERL_UQUAD_MAX
2050 # define UV_MIN PERL_UQUAD_MIN
2055 # if defined(INT32_MAX) && IVSIZE == 4
2056 # define IV_MAX ((IV)INT32_MAX)
2057 # define IV_MIN ((IV)INT32_MIN)
2058 # ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
2059 # define UV_MAX ((UV)UINT32_MAX)
2061 # define UV_MAX ((UV)4294967295U)
2064 # define UINT32_MIN 0
2066 # define UV_MIN ((UV)UINT32_MIN)
2068 # define IV_MAX PERL_LONG_MAX
2069 # define IV_MIN PERL_LONG_MIN
2070 # define UV_MAX PERL_ULONG_MAX
2071 # define UV_MIN PERL_ULONG_MIN
2082 #if !defined(PERL_CORE)
2083 /* We think that removing this decade-old undef this will cause too much
2084 breakage on CPAN for too little gain. (See RT #119753)
2085 However, we do need HAS_QUAD in the core for use by the drand48 code. */
2091 #define Size_t_MAX (~(Size_t)0)
2092 #define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
2094 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
2095 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
2097 #ifndef NO_PERL_PRESERVE_IVUV
2098 #define PERL_PRESERVE_IVUV /* We like our integers to stay integers. */
2102 * The macros INT2PTR and NUM2PTR are (despite their names)
2103 * bi-directional: they will convert int/float to or from pointers.
2104 * However the conversion to int/float are named explicitly:
2105 * PTR2IV, PTR2UV, PTR2NV.
2107 * For int conversions we do not need two casts if pointers are
2108 * the same size as IV and UV. Otherwise we need an explicit
2109 * cast (PTRV) to avoid compiler warnings.
2111 * These are mentioned in perlguts
2113 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
2115 # define INT2PTR(any,d) (any)(d)
2116 #elif PTRSIZE == LONGSIZE
2117 # define PTRV unsigned long
2118 # define PTR2ul(p) (unsigned long)(p)
2120 # define PTRV unsigned
2124 # define INT2PTR(any,d) (any)(PTRV)(d)
2128 # define PTR2ul(p) INT2PTR(unsigned long,p)
2132 =for apidoc_section Casting
2133 =for apidoc Cyh|type|NUM2PTR|type|int value
2134 You probably want to be using L<C</INT2PTR>> instead.
2139 #define NUM2PTR(any,d) (any)(PTRV)(d)
2140 #define PTR2IV(p) INT2PTR(IV,p)
2141 #define PTR2UV(p) INT2PTR(UV,p)
2142 #define PTR2NV(p) NUM2PTR(NV,p)
2143 #define PTR2nat(p) (PTRV)(p) /* pointer to integer of PTRSIZE */
2145 /* According to strict ANSI C89 one cannot freely cast between
2146 * data pointers and function (code) pointers. There are at least
2147 * two ways around this. One (used below) is to do two casts,
2148 * first the other pointer to an (unsigned) integer, and then
2149 * the integer to the other pointer. The other way would be
2150 * to use unions to "overlay" the pointers. For an example of
2151 * the latter technique, see union dirpu in struct xpvio in sv.h.
2152 * The only feasible use is probably temporarily storing
2153 * function pointers in a data pointer (such as a void pointer). */
2155 #define DPTR2FPTR(t,p) ((t)PTR2nat(p)) /* data pointer to function pointer */
2156 #define FPTR2DPTR(t,p) ((t)PTR2nat(p)) /* function pointer to data pointer */
2158 #ifdef USE_LONG_DOUBLE
2159 # if LONG_DOUBLESIZE == DOUBLESIZE
2160 # define LONG_DOUBLE_EQUALS_DOUBLE
2161 # undef USE_LONG_DOUBLE /* Ouch! */
2165 /* The following is all to get LDBL_DIG, in order to pick a nice
2166 default value for printing floating point numbers in Gconvert.
2169 #ifndef HAS_LDBL_DIG
2170 # if LONG_DOUBLESIZE == 10
2171 # define LDBL_DIG 18 /* assume IEEE */
2172 # elif LONG_DOUBLESIZE == 12
2173 # define LDBL_DIG 18 /* gcc? */
2174 # elif LONG_DOUBLESIZE == 16
2175 # define LDBL_DIG 33 /* assume IEEE */
2176 # elif LONG_DOUBLESIZE == DOUBLESIZE
2177 # define LDBL_DIG DBL_DIG /* bummer */
2184 # include <ieeefp.h>
2187 #if defined(__DECC) && defined(__osf__)
2188 /* Also Tru64 cc has broken NaN comparisons. */
2189 # define NAN_COMPARE_BROKEN
2192 # define NAN_COMPARE_BROKEN
2195 #ifdef USE_LONG_DOUBLE
2197 # include <sunmath.h>
2199 # if defined(LDBL_DIG)
2200 # define NV_DIG LDBL_DIG
2201 # ifdef LDBL_MANT_DIG
2202 # define NV_MANT_DIG LDBL_MANT_DIG
2205 # define NV_MIN LDBL_MIN
2208 # define NV_MAX LDBL_MAX
2210 # ifdef LDBL_MIN_EXP
2211 # define NV_MIN_EXP LDBL_MIN_EXP
2213 # ifdef LDBL_MAX_EXP
2214 # define NV_MAX_EXP LDBL_MAX_EXP
2216 # ifdef LDBL_MIN_10_EXP
2217 # define NV_MIN_10_EXP LDBL_MIN_10_EXP
2219 # ifdef LDBL_MAX_10_EXP
2220 # define NV_MAX_10_EXP LDBL_MAX_10_EXP
2222 # ifdef LDBL_EPSILON
2223 # define NV_EPSILON LDBL_EPSILON
2226 # define NV_MAX LDBL_MAX
2227 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
2228 # elif defined(HUGE_VALL)
2229 # define NV_MAX HUGE_VALL
2232 # if defined(HAS_SQRTL)
2233 # define Perl_acos acosl
2234 # define Perl_asin asinl
2235 # define Perl_atan atanl
2236 # define Perl_atan2 atan2l
2237 # define Perl_ceil ceill
2238 # define Perl_cos cosl
2239 # define Perl_cosh coshl
2240 # define Perl_exp expl
2241 /* no Perl_fabs, but there's PERL_ABS */
2242 # define Perl_floor floorl
2243 # define Perl_fmod fmodl
2244 # define Perl_log logl
2245 # define Perl_log10 log10l
2246 # define Perl_pow powl
2247 # define Perl_sin sinl
2248 # define Perl_sinh sinhl
2249 # define Perl_sqrt sqrtl
2250 # define Perl_tan tanl
2251 # define Perl_tanh tanhl
2253 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
2256 # define Perl_modf(x,y) modfl(x,y)
2257 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
2258 prototype in <math.h> */
2259 # ifndef HAS_MODFL_PROTO
2260 EXTERN_C long double modfl(long double, long double *);
2262 # elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
2263 extern long double Perl_my_modfl(long double x, long double *ip);
2264 # define Perl_modf(x,y) Perl_my_modfl(x,y)
2269 # define Perl_frexp(x,y) frexpl(x,y)
2270 # elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
2271 extern long double Perl_my_frexpl(long double x, int *e);
2272 # define Perl_frexp(x,y) Perl_my_frexpl(x,y)
2277 # define Perl_ldexp(x, y) ldexpl(x,y)
2278 # elif defined(HAS_SCALBNL) && FLT_RADIX == 2
2279 # define Perl_ldexp(x,y) scalbnl(x,y)
2283 # if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
2284 # define Perl_isnan(x) isnanl(x)
2285 # elif defined(__sgi) && defined(__c99) /* XXX Configure test needed */
2286 # define Perl_isnan(x) isnan(x)
2290 # if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
2291 # define Perl_isinf(x) isinfl(x)
2292 # elif defined(__sgi) && defined(__c99) /* XXX Configure test needed */
2293 # define Perl_isinf(x) isinf(x)
2294 # elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2295 # define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
2298 # ifndef Perl_isfinite
2299 # define Perl_isfinite(x) Perl_isfinitel(x)
2301 #elif defined(USE_QUADMATH) && defined(I_QUADMATH)
2302 # include <quadmath.h>
2303 # define NV_DIG FLT128_DIG
2304 # define NV_MANT_DIG FLT128_MANT_DIG
2305 # define NV_MIN FLT128_MIN
2306 # define NV_MAX FLT128_MAX
2307 # define NV_MIN_EXP FLT128_MIN_EXP
2308 # define NV_MAX_EXP FLT128_MAX_EXP
2309 # define NV_EPSILON FLT128_EPSILON
2310 # define NV_MIN_10_EXP FLT128_MIN_10_EXP
2311 # define NV_MAX_10_EXP FLT128_MAX_10_EXP
2312 # define Perl_acos acosq
2313 # define Perl_asin asinq
2314 # define Perl_atan atanq
2315 # define Perl_atan2 atan2q
2316 # define Perl_ceil ceilq
2317 # define Perl_cos cosq
2318 # define Perl_cosh coshq
2319 # define Perl_exp expq
2320 /* no Perl_fabs, but there's PERL_ABS */
2321 # define Perl_floor floorq
2322 # define Perl_fmod fmodq
2323 # define Perl_log logq
2324 # define Perl_log10 log10q
2325 # define Perl_signbit signbitq
2326 # define Perl_pow powq
2327 # define Perl_sin sinq
2328 # define Perl_sinh sinhq
2329 # define Perl_sqrt sqrtq
2330 # define Perl_tan tanq
2331 # define Perl_tanh tanhq
2332 # define Perl_modf(x,y) modfq(x,y)
2333 # define Perl_frexp(x,y) frexpq(x,y)
2334 # define Perl_ldexp(x, y) ldexpq(x,y)
2335 # define Perl_isinf(x) isinfq(x)
2336 # define Perl_isnan(x) isnanq(x)
2337 # define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
2338 # define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
2339 # define Perl_fp_class_inf(x) (Perl_fp_class(x) == 3)
2340 # define Perl_fp_class_nan(x) (Perl_fp_class(x) == 4)
2341 # define Perl_fp_class_norm(x) (Perl_fp_class(x) == 1)
2342 # define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
2343 # define Perl_fp_class_zero(x) (Perl_fp_class(x) == 0)
2345 # define NV_DIG DBL_DIG
2346 # define NV_MANT_DIG DBL_MANT_DIG
2347 # define NV_MIN DBL_MIN
2348 # define NV_MAX DBL_MAX
2349 # define NV_MIN_EXP DBL_MIN_EXP
2350 # define NV_MAX_EXP DBL_MAX_EXP
2351 # define NV_MIN_10_EXP DBL_MIN_10_EXP
2352 # define NV_MAX_10_EXP DBL_MAX_10_EXP
2353 # define NV_EPSILON DBL_EPSILON
2354 # define NV_MAX DBL_MAX
2355 # define NV_MIN DBL_MIN
2357 /* These math interfaces are C89. */
2358 # define Perl_acos acos
2359 # define Perl_asin asin
2360 # define Perl_atan atan
2361 # define Perl_atan2 atan2
2362 # define Perl_ceil ceil
2363 # define Perl_cos cos
2364 # define Perl_cosh cosh
2365 # define Perl_exp exp
2366 /* no Perl_fabs, but there's PERL_ABS */
2367 # define Perl_floor floor
2368 # define Perl_fmod fmod
2369 # define Perl_log log
2370 # define Perl_log10 log10
2371 # define Perl_pow pow
2372 # define Perl_sin sin
2373 # define Perl_sinh sinh
2374 # define Perl_sqrt sqrt
2375 # define Perl_tan tan
2376 # define Perl_tanh tanh
2378 # define Perl_modf(x,y) modf(x,y)
2379 # define Perl_frexp(x,y) frexp(x,y)
2380 # define Perl_ldexp(x,y) ldexp(x,y)
2384 # define Perl_isnan(x) isnan(x)
2388 # if defined(HAS_ISINF)
2389 # define Perl_isinf(x) isinf(x)
2390 # elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2391 # define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
2394 # ifndef Perl_isfinite
2395 # ifdef HAS_ISFINITE
2396 # define Perl_isfinite(x) isfinite(x)
2397 # elif defined(HAS_FINITE)
2398 # define Perl_isfinite(x) finite(x)
2403 /* fpclassify(): C99. It is supposed to be a macro that switches on
2404 * the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
2405 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2407 # if defined(FP_INFINITE) && defined(FP_NAN)
2408 # define Perl_fp_class(x) fpclassify(x)
2409 # define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_INFINITE)
2410 # define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_NAN)
2411 # define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_NORMAL)
2412 # define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2413 # define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_ZERO)
2414 # elif defined(FP_PLUS_INF) && defined(FP_QNAN)
2415 /* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
2416 * actually not the C99 fpclassify, with its own set of return defines. */
2417 # define Perl_fp_class(x) fpclassify(x)
2418 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
2419 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
2420 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2421 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2422 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
2423 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
2424 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
2425 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
2426 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
2427 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
2429 # undef Perl_fp_class /* Unknown set of defines */
2433 /* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
2434 * are identical to the C99 fpclassify(). */
2435 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
2438 /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
2440 /* oh, and the isnormal macro has a typo in it! */
2442 # define isnormal(x) Perl_fp_class_norm(x)
2444 # if defined(FP_INFINITE) && defined(FP_NAN)
2445 # define Perl_fp_class(x) fp_classify(x)
2446 # define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_INFINITE)
2447 # define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_NAN)
2448 # define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_NORMAL)
2449 # define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2450 # define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_ZERO)
2452 # undef Perl_fp_class /* Unknown set of defines */
2456 /* Feel free to check with me for the SGI manpages, SGI testing,
2457 * etcetera, if you want to try getting this to work with IRIX.
2459 * - Allen <allens@cpan.org> */
2461 /* fpclass(): SysV, at least Solaris and some versions of IRIX. */
2462 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
2463 /* Solaris and IRIX have fpclass/fpclassl, but they are using
2464 * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2465 * Define some symbols also as cpp symbols so we can detect them. */
2466 # if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
2467 # define FP_PINF FP_PINF
2468 # define FP_QNAN FP_QNAN
2472 # include <ieeefp.h>
2477 # if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
2478 # define Perl_fp_class(x) fpclassl(x)
2480 # define Perl_fp_class(x) fpclass(x)
2482 # if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
2483 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_CLASS_SNAN)
2484 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_CLASS_QNAN)
2485 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_CLASS_NINF)
2486 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_CLASS_PINF)
2487 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_CLASS_NNORM)
2488 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_CLASS_PNORM)
2489 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_CLASS_NDENORM)
2490 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_CLASS_PDENORM)
2491 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_CLASS_NZERO)
2492 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_CLASS_PZERO)
2493 # elif defined(FP_PINF) && defined(FP_QNAN)
2494 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2495 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2496 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_NINF)
2497 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PINF)
2498 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_NNORM)
2499 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PNORM)
2500 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_NDENORM)
2501 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PDENORM)
2502 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_NZERO)
2503 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PZERO)
2505 # undef Perl_fp_class /* Unknown set of defines */
2509 /* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2510 #if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
2512 # if !defined(FP_SNAN) && defined(I_FP_CLASS)
2513 # include <fp_class.h>
2515 # if defined(FP_POS_INF) && defined(FP_QNAN)
2516 # ifdef __sgi /* XXX Configure test instead */
2517 # ifdef USE_LONG_DOUBLE
2518 # define Perl_fp_class(x) fp_class_l(x)
2520 # define Perl_fp_class(x) fp_class_d(x)
2523 # if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2524 # define Perl_fp_class(x) fp_classl(x)
2526 # define Perl_fp_class(x) fp_class(x)
2529 # if defined(FP_POS_INF) && defined(FP_QNAN)
2530 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2531 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2532 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_NEG_INF)
2533 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_POS_INF)
2534 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_NEG_NORM)
2535 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_POS_NORM)
2536 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_NEG_DENORM)
2537 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_POS_DENORM)
2538 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_NEG_ZERO)
2539 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_POS_ZERO)
2541 # undef Perl_fp_class /* Unknown set of defines */
2546 /* class(), _class(): Legacy: AIX. */
2547 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2549 # if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2551 # define Perl_fp_class(x) class(x)
2553 # define Perl_fp_class(x) _class(x)
2555 # if defined(FP_PLUS_INF) && defined(FP_NANQ)
2556 # define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_NANS)
2557 # define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_NANQ)
2558 # define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
2559 # define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
2560 # define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
2561 # define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
2562 # define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
2563 # define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
2564 # define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
2565 # define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
2567 # undef Perl_fp_class /* Unknown set of defines */
2572 /* Win32: _fpclass(), _isnan(), _finite(). */
2575 # define Perl_isnan(x) _isnan(x)
2577 # ifndef Perl_isfinite
2578 # define Perl_isfinite(x) _finite(x)
2580 # ifndef Perl_fp_class_snan
2581 /* No simple way to #define Perl_fp_class because _fpclass()
2582 * returns a set of bits. */
2583 # define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2584 # define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
2585 # define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
2586 # define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF)
2587 # define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF)
2588 # define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2589 # define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2590 # define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2591 # define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2592 # define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2593 # define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2594 # define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2595 # define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2596 # define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2597 # define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2601 #if !defined(Perl_fp_class_inf) && \
2602 defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2603 # define Perl_fp_class_inf(x) \
2604 (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2607 #if !defined(Perl_fp_class_nan) && \
2608 defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2609 # define Perl_fp_class_nan(x) \
2610 (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2613 #if !defined(Perl_fp_class_zero) && \
2614 defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2615 # define Perl_fp_class_zero(x) \
2616 (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2619 #if !defined(Perl_fp_class_norm) && \
2620 defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2621 # define Perl_fp_class_norm(x) \
2622 (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2625 #if !defined(Perl_fp_class_denorm) && \
2626 defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2627 # define Perl_fp_class_denorm(x) \
2628 (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
2632 # ifdef Perl_fp_class_nan
2633 # define Perl_isnan(x) Perl_fp_class_nan(x)
2634 # elif defined(HAS_UNORDERED)
2635 # define Perl_isnan(x) unordered((x), 0.0)
2637 # define Perl_isnan(x) ((x)!=(x))
2642 # ifdef Perl_fp_class_inf
2643 # define Perl_isinf(x) Perl_fp_class_inf(x)
2647 #ifndef Perl_isfinite
2648 # if defined(HAS_ISFINITE) && !defined(isfinite)
2649 # define Perl_isfinite(x) isfinite((double)(x))
2650 # elif defined(HAS_FINITE)
2651 # define Perl_isfinite(x) finite((double)(x))
2652 # elif defined(Perl_fp_class_finite)
2653 # define Perl_isfinite(x) Perl_fp_class_finite(x)
2655 /* For the infinities the multiplication returns nan,
2656 * for the nan the multiplication also returns nan,
2657 * for everything else (that is, finite) zero should be returned. */
2658 # define Perl_isfinite(x) (((x) * 0) == 0)
2663 # if defined(Perl_isfinite) && defined(Perl_isnan)
2664 # define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2668 /* We need Perl_isfinitel (ends with ell) (if available) even when
2669 * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2671 #if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2672 /* If isfinite() is a macro and looks like we have C99,
2673 * we assume it's the type-aware C99 isfinite(). */
2674 # if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
2675 # define Perl_isfinitel(x) isfinite(x)
2676 # elif defined(HAS_ISFINITEL)
2677 # define Perl_isfinitel(x) isfinitel(x)
2678 # elif defined(HAS_FINITEL)
2679 # define Perl_isfinitel(x) finitel(x)
2680 # elif defined(HAS_INFL) && defined(HAS_NANL)
2681 # define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
2683 # define Perl_isfinitel(x) ((x) * 0 == 0) /* See Perl_isfinite. */
2687 /* The default is to use Perl's own atof() implementation (in numeric.c).
2688 * Usually that is the one to use but for some platforms (e.g. UNICOS)
2689 * it is however best to use the native implementation of atof.
2690 * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2691 * Some good tests to try out with either setting are t/base/num.t,
2692 * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2693 * you may need to be using a different function than atof! */
2695 #ifndef USE_PERL_ATOF
2697 # define USE_PERL_ATOF
2700 # if USE_PERL_ATOF == 0
2701 # undef USE_PERL_ATOF
2705 #ifdef USE_PERL_ATOF
2706 # define Perl_atof(s) Perl_my_atof(s)
2707 # define Perl_atof2(s, n) Perl_my_atof3(aTHX_ (s), &(n), 0)
2709 # define Perl_atof(s) (NV)atof(s)
2710 # define Perl_atof2(s, n) ((n) = atof(s))
2712 #define my_atof2(a,b) my_atof3(a,b,0)
2715 =for apidoc_section $numeric
2716 =for apidoc AmT|NV|Perl_acos|NV x
2717 =for apidoc_item |NV|Perl_asin|NV x
2718 =for apidoc_item |NV|Perl_atan|NV x
2719 =for apidoc_item |NV|Perl_atan2|NV x|NV y
2720 =for apidoc_item |NV|Perl_ceil|NV x
2721 =for apidoc_item |NV|Perl_cos|NV x
2722 =for apidoc_item |NV|Perl_cosh|NV x
2723 =for apidoc_item |NV|Perl_exp|NV x
2724 =for apidoc_item |NV|Perl_floor|NV x
2725 =for apidoc_item |NV|Perl_fmod|NV x|NV y
2726 =for apidoc_item |NV|Perl_frexp|NV x|int *exp
2727 =for apidoc_item |IV|Perl_isfinite|NV x
2728 =for apidoc_item |IV|Perl_isinf|NV x
2729 =for apidoc_item |IV|Perl_isnan|NV x
2730 =for apidoc_item |NV|Perl_ldexp|NV x|int exp
2731 =for apidoc_item |NV|Perl_log|NV x
2732 =for apidoc_item |NV|Perl_log10|NV x
2733 =for apidoc_item |NV|Perl_modf|NV x|NV *iptr
2734 =for apidoc_item |NV|Perl_pow|NV x|NV y
2735 =for apidoc_item |NV|Perl_sin|NV x
2736 =for apidoc_item |NV|Perl_sinh|NV x
2737 =for apidoc_item |NV|Perl_sqrt|NV x
2738 =for apidoc_item |NV|Perl_tan|NV x
2739 =for apidoc_item |NV|Perl_tanh|NV x
2741 These perform the corresponding mathematical operation on the operand(s), using
2742 the libc function designed for the task that has just enough precision for an
2743 NV on this platform. If no such function with sufficient precision exists,
2744 the highest precision one available is used.
2750 * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2751 * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2752 * depending on local options. Until Configure detects this (or at least
2753 * detects whether the "signed" keyword is available) the CHAR ranges
2754 * will not be included. UCHAR functions normally.
2758 #define PERL_UCHAR_MIN ((unsigned char)0)
2759 #define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2761 #define PERL_USHORT_MIN ((unsigned short)0)
2762 #define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2764 #define PERL_SHORT_MAX ((short)SHRT_MAX)
2765 #define PERL_SHORT_MIN ((short)SHRT_MIN)
2767 #define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2768 #define PERL_UINT_MIN ((unsigned int)0)
2770 #define PERL_INT_MAX ((int)INT_MAX)
2771 #define PERL_INT_MIN ((int)INT_MIN)
2773 #define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2774 #define PERL_ULONG_MIN ((unsigned long)0L)
2776 #define PERL_LONG_MAX ((long)LONG_MAX)
2777 #define PERL_LONG_MIN ((long)LONG_MIN)
2780 # define PERL_UQUAD_MAX (~(UV)0)
2781 # define PERL_UQUAD_MIN ((UV)0)
2782 # define PERL_QUAD_MAX ((IV) (PERL_UQUAD_MAX >> 1))
2783 # define PERL_QUAD_MIN (-PERL_QUAD_MAX - ((3 & -1) == 3))
2787 =for apidoc_section $integer
2789 =for apidoc AmnU||PERL_INT_MAX
2790 =for apidoc_item ||PERL_INT_MIN
2791 =for apidoc_item ||PERL_LONG_MAX
2792 =for apidoc_item ||PERL_LONG_MIN
2793 =for apidoc_item ||PERL_SHORT_MAX
2794 =for apidoc_item ||PERL_SHORT_MIN
2795 =for apidoc_item ||PERL_UCHAR_MAX
2796 =for apidoc_item ||PERL_UCHAR_MIN
2797 =for apidoc_item ||PERL_UINT_MAX
2798 =for apidoc_item ||PERL_UINT_MIN
2799 =for apidoc_item ||PERL_ULONG_MAX
2800 =for apidoc_item ||PERL_ULONG_MIN
2801 =for apidoc_item ||PERL_USHORT_MAX
2802 =for apidoc_item ||PERL_USHORT_MIN
2803 =for apidoc_item ||PERL_QUAD_MAX
2804 =for apidoc_item ||PERL_QUAD_MIN
2805 =for apidoc_item ||PERL_UQUAD_MAX
2806 =for apidoc_item ||PERL_UQUAD_MIN
2808 These give the largest and smallest number representable in the current
2809 platform in variables of the corresponding types.
2811 For signed types, the smallest representable number is the most negative
2812 number, the one furthest away from zero.
2814 For C99 and later compilers, these correspond to things like C<INT_MAX>, which
2815 are available to the C code. But these constants, furnished by Perl,
2816 allow code compiled on earlier compilers to portably have access to the same
2823 typedef MEM_SIZE STRLEN;
2825 typedef struct op OP;
2826 typedef struct cop COP;
2827 typedef struct unop UNOP;
2828 typedef struct unop_aux UNOP_AUX;
2829 typedef struct binop BINOP;
2830 typedef struct listop LISTOP;
2831 typedef struct logop LOGOP;
2832 typedef struct pmop PMOP;
2833 typedef struct svop SVOP;
2834 typedef struct padop PADOP;
2835 typedef struct pvop PVOP;
2836 typedef struct loop LOOP;
2837 typedef struct methop METHOP;
2840 typedef struct opslab OPSLAB;
2841 typedef struct opslot OPSLOT;
2844 typedef struct block_hooks BHK;
2845 typedef struct custom_op XOP;
2847 typedef struct interpreter PerlInterpreter;
2849 /* SGI's <sys/sema.h> has struct sv */
2851 # define STRUCT_SV perl_sv
2853 # define STRUCT_SV sv
2855 typedef struct STRUCT_SV SV;
2856 typedef struct av AV;
2857 typedef struct hv HV;
2858 typedef struct cv CV;
2859 typedef struct p5rx REGEXP;
2860 typedef struct gp GP;
2861 typedef struct gv GV;
2862 typedef struct io IO;
2863 typedef struct context PERL_CONTEXT;
2864 typedef struct block BLOCK;
2865 typedef struct invlist INVLIST;
2867 typedef struct magic MAGIC;
2868 typedef struct xpv XPV;
2869 typedef struct xpviv XPVIV;
2870 typedef struct xpvuv XPVUV;
2871 typedef struct xpvnv XPVNV;
2872 typedef struct xpvmg XPVMG;
2873 typedef struct xpvlv XPVLV;
2874 typedef struct xpvinvlist XINVLIST;
2875 typedef struct xpvav XPVAV;
2876 typedef struct xpvhv XPVHV;
2877 typedef struct xpvgv XPVGV;
2878 typedef struct xpvcv XPVCV;
2879 typedef struct xpvbm XPVBM;
2880 typedef struct xpvfm XPVFM;
2881 typedef struct xpvio XPVIO;
2882 typedef struct mgvtbl MGVTBL;
2883 typedef union any ANY;
2884 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2885 typedef struct ptr_tbl PTR_TBL_t;
2886 typedef struct clone_params CLONE_PARAMS;
2888 /* a pad is currently just an AV; but that might change,
2889 * so hide the type. */
2890 typedef struct padlist PADLIST;
2892 typedef struct padnamelist PADNAMELIST;
2893 typedef struct padname PADNAME;
2895 /* always enable PERL_OP_PARENT */
2896 #if !defined(PERL_OP_PARENT)
2897 # define PERL_OP_PARENT
2900 /* enable PERL_COPY_ON_WRITE by default */
2901 #if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2902 # define PERL_COPY_ON_WRITE
2905 #ifdef PERL_COPY_ON_WRITE
2906 # define PERL_ANY_COW
2908 # define PERL_SAWAMPERSAND
2911 #if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2912 # error PERL_DEBUG_READONLY_OPS only works with ithreads
2916 #include "charclass_invlists.h"
2918 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2919 # if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2920 # define USE_64_BIT_RAWIO /* implicit */
2924 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2925 * fseeko/ftello if possible. Don't go #defining ftell to ftello yourself,
2926 * however, because operating systems like to do that themself. */
2929 # define FSEEKSIZE LSEEKSIZE
2931 # define FSEEKSIZE LONGSIZE
2935 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2936 # if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2937 # define USE_64_BIT_STDIO /* implicit */
2941 #ifdef USE_64_BIT_RAWIO
2944 # define Off_t off64_t
2946 # define LSEEKSIZE 8
2948 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2949 * will trigger defines like the ones below. Some 64-bit environments,
2950 * however, do not. Therefore we have to explicitly mix and match. */
2951 # if defined(USE_OPEN64)
2952 # define open open64
2954 # if defined(USE_LSEEK64)
2955 # define lseek lseek64
2957 # if defined(USE_LLSEEK)
2958 # define lseek llseek
2961 # if defined(USE_STAT64)
2962 # define stat stat64
2964 # if defined(USE_FSTAT64)
2965 # define fstat fstat64
2967 # if defined(USE_LSTAT64)
2968 # define lstat lstat64
2970 # if defined(USE_FLOCK64)
2971 # define flock flock64
2973 # if defined(USE_LOCKF64)
2974 # define lockf lockf64
2976 # if defined(USE_FCNTL64)
2977 # define fcntl fcntl64
2979 # if defined(USE_TRUNCATE64)
2980 # define truncate truncate64
2982 # if defined(USE_FTRUNCATE64)
2983 # define ftruncate ftruncate64
2987 #ifdef USE_64_BIT_STDIO
2988 # ifdef HAS_FPOS64_T
2990 # define Fpos_t fpos64_t
2992 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2993 * will trigger defines like the ones below. Some 64-bit environments,
2994 * however, do not. */
2995 # if defined(USE_FOPEN64)
2996 # define fopen fopen64
2998 # if defined(USE_FSEEK64)
2999 # define fseek fseek64 /* don't do fseeko here, see perlio.c */
3001 # if defined(USE_FTELL64)
3002 # define ftell ftell64 /* don't do ftello here, see perlio.c */
3004 # if defined(USE_FSETPOS64)
3005 # define fsetpos fsetpos64
3007 # if defined(USE_FGETPOS64)
3008 # define fgetpos fgetpos64
3010 # if defined(USE_TMPFILE64)
3011 # define tmpfile tmpfile64
3013 # if defined(USE_FREOPEN64)
3014 # define freopen freopen64
3019 # include "iperlsys.h"
3024 # include "os2ish.h"
3026 # include "dosish.h"
3029 # include "vmsish.h"
3030 #elif defined(PLAN9)
3031 # include "./plan9/plan9ish.h"
3032 #elif defined(__VOS__)
3034 # include "./vos/vosish.h"
3036 # include "vos/vosish.h"
3038 #elif defined(__HAIKU__)
3039 # include "haiku/haikuish.h"
3041 # include "unixish.h"
3045 # include "amigaos.h"
3046 # undef FD_CLOEXEC /* a lie in AmigaOS */
3049 /* NSIG logic from Configure --> */
3052 # define NSIG (_NSIG)
3053 # elif defined(SIGMAX)
3054 # define NSIG (SIGMAX+1)
3055 # elif defined(SIG_MAX)
3056 # define NSIG (SIG_MAX+1)
3057 # elif defined(_SIG_MAX)
3058 # define NSIG (_SIG_MAX+1)
3059 # elif defined(MAXSIG)
3060 # define NSIG (MAXSIG+1)
3061 # elif defined(MAX_SIG)
3062 # define NSIG (MAX_SIG+1)
3063 # elif defined(SIGARRAYSIZE)
3064 # define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
3065 # elif defined(_sys_nsig)
3066 # define NSIG (_sys_nsig) /* Solaris 2.5 */
3068 /* Default to some arbitrary number that's big enough to get most
3069 * of the common signals. */
3073 /* <-- NSIG logic from Configure */
3075 #ifndef NO_ENVIRON_ARRAY
3076 # define USE_ENVIRON_ARRAY
3079 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3080 /* having sigaction(2) means that the OS supports both 1-arg and 3-arg
3081 * signal handlers. But the perl core itself only fully supports 1-arg
3082 * handlers, so don't enable for now.
3083 * NB: POSIX::sigaction() supports both.
3085 * # define PERL_USE_3ARG_SIGHANDLER
3090 * This is an alias for the OS's siginfo_t, except that where the OS
3091 * doesn't support it, declare a dummy version instead. This allows us to
3092 * have signal handler functions which always have a Siginfo_t parameter
3093 * regardless of platform, (and which will just be passed a NULL value
3094 * where the OS doesn't support HAS_SIGACTION).
3097 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3098 typedef siginfo_t Siginfo_t;
3100 #ifdef si_signo /* minix */
3110 * initialise to avoid floating-point exceptions from overflow, etc
3112 #ifndef PERL_FPU_INIT
3113 # ifdef HAS_FPSETMASK
3114 # if HAS_FLOATINGPOINT_H
3115 # include <floatingpoint.h>
3117 /* Some operating systems have this as a macro, which in turn expands to a comma
3118 expression, and the last sub-expression is something that gets calculated,
3119 and then they have the gall to warn that a value computed is not used. Hence
3121 # define PERL_FPU_INIT (void)fpsetmask(0)
3122 # elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
3123 # define PERL_FPU_INIT PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
3124 # define PERL_FPU_PRE_EXEC { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
3125 # define PERL_FPU_POST_EXEC rsignal_restore(SIGFPE, &xfpe); }
3127 # define PERL_FPU_INIT
3130 #ifndef PERL_FPU_PRE_EXEC
3131 # define PERL_FPU_PRE_EXEC {
3132 # define PERL_FPU_POST_EXEC }
3135 /* In Tru64 the cc -ieee enables the IEEE math but disables traps.
3136 * We need to reenable the "invalid" trap because otherwise generation
3137 * of NaN values leaves the IEEE fp flags in bad state, leaving any further
3138 * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
3140 # include <machine/fpu.h>
3141 # define PERL_SYS_FPU_INIT \
3143 ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
3144 signal(SIGFPE, SIG_IGN); \
3147 /* In IRIX the default for Flush to Zero bit is true,
3148 * which means that results going below the minimum of normal
3149 * floating points go to zero, instead of going denormal/subnormal.
3150 * This is unlike almost any other system running Perl, so let's clear it.
3151 * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
3152 * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
3154 * XXX The flush-to-zero behaviour should be a Configure scan.
3155 * To change the behaviour usually requires some system-specific
3156 * incantation, though, like the below. */
3158 # include <sys/fpu.h>
3159 # define PERL_SYS_FPU_INIT \
3161 union fpc_csr csr; \
3162 csr.fc_word = get_fpc_csr(); \
3163 csr.fc_struct.flush = 0; \
3164 set_fpc_csr(csr.fc_word); \
3168 #ifndef PERL_SYS_FPU_INIT
3169 # define PERL_SYS_FPU_INIT NOOP
3172 #ifndef PERL_SYS_INIT3_BODY
3173 # define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
3177 =for apidoc_section $embedding
3179 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
3180 Provides system-specific tune up of the C runtime environment necessary to
3181 run Perl interpreters. This should be called only once, before creating
3182 any Perl interpreters.
3184 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
3185 Provides system-specific tune up of the C runtime environment necessary to
3186 run Perl interpreters. This should be called only once, before creating
3187 any Perl interpreters.
3189 =for apidoc Am|void|PERL_SYS_TERM|
3190 Provides system-specific clean up of the C runtime environment after
3191 running Perl interpreters. This should be called only once, after
3192 freeing any remaining Perl interpreters.
3197 #define PERL_SYS_INIT(argc, argv) Perl_sys_init(argc, argv)
3198 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
3199 #define PERL_SYS_TERM() Perl_sys_term()
3201 #ifndef PERL_WRITE_MSG_TO_CONSOLE
3202 # define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
3207 # ifdef _POSIX_PATH_MAX
3208 # if PATH_MAX > _POSIX_PATH_MAX
3209 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
3210 * included the null byte or not. Later amendments of POSIX,
3211 * XPG4, the Austin Group, and the Single UNIX Specification
3212 * all explicitly include the null byte in the PATH_MAX.
3213 * Ditto for _POSIX_PATH_MAX. */
3214 # define MAXPATHLEN PATH_MAX
3216 # define MAXPATHLEN _POSIX_PATH_MAX
3219 # define MAXPATHLEN (PATH_MAX+1)
3222 # define MAXPATHLEN 1024 /* Err on the large side. */
3226 /* clang Thread Safety Analysis/Annotations/Attributes
3227 * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
3229 * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
3230 * Apple XCode hijacks __clang_major__ and __clang_minor__
3231 * (6.1 means really clang 3.6), so needs extra hijinks
3232 * (could probably also test the contents of __apple_build_version__).
3234 #if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
3235 defined(__clang__) && \
3237 ((!defined(__apple_build_version__) && \
3238 ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
3239 (__clang_major__ >= 4))) || \
3240 (defined(__apple_build_version__) && \
3241 ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
3242 (__clang_major__ >= 7))))
3243 # define PERL_TSA__(x) __attribute__((x))
3244 # define PERL_TSA_ACTIVE
3246 # define PERL_TSA__(x) /* No TSA, make TSA attributes no-ops. */
3247 # undef PERL_TSA_ACTIVE
3250 /* PERL_TSA_CAPABILITY() is used to annotate typedefs.
3251 * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
3253 #define PERL_TSA_CAPABILITY(x) \
3254 PERL_TSA__(capability(x))
3256 /* In the below examples the mutex must be lexically visible, usually
3257 * either as global variables, or as function arguments. */
3259 /* PERL_TSA_GUARDED_BY() is used to annotate global variables.
3261 * Foo foo PERL_TSA_GUARDED_BY(mutex);
3263 #define PERL_TSA_GUARDED_BY(x) \
3264 PERL_TSA__(guarded_by(x))
3266 /* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
3267 * The data _behind_ the pointer is guarded.
3269 * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
3271 #define PERL_TSA_PT_GUARDED_BY(x) \
3272 PERL_TSA__(pt_guarded_by(x))
3274 /* PERL_TSA_REQUIRES() is used to annotate functions.
3275 * The caller MUST hold the resource when calling the function.
3277 * void Foo() PERL_TSA_REQUIRES(mutex);
3279 #define PERL_TSA_REQUIRES(x) \
3280 PERL_TSA__(requires_capability(x))
3282 /* PERL_TSA_EXCLUDES() is used to annotate functions.
3283 * The caller MUST NOT hold resource when calling the function.
3285 * EXCLUDES should be used when the function first acquires
3286 * the resource and then releases it. Use to avoid deadlock.
3288 * void Foo() PERL_TSA_EXCLUDES(mutex);
3290 #define PERL_TSA_EXCLUDES(x) \
3291 PERL_TSA__(locks_excluded(x))
3293 /* PERL_TSA_ACQUIRE() is used to annotate functions.
3294 * The caller MUST NOT hold the resource when calling the function,
3295 * and the function will acquire the resource.
3297 * void Foo() PERL_TSA_ACQUIRE(mutex);
3299 #define PERL_TSA_ACQUIRE(x) \
3300 PERL_TSA__(acquire_capability(x))
3302 /* PERL_TSA_RELEASE() is used to annotate functions.
3303 * The caller MUST hold the resource when calling the function,
3304 * and the function will release the resource.
3306 * void Foo() PERL_TSA_RELEASE(mutex);
3308 #define PERL_TSA_RELEASE(x) \
3309 PERL_TSA__(release_capability(x))
3311 /* PERL_TSA_NO_TSA is used to annotate functions.
3312 * Used when being intentionally unsafe, or when the code is too
3313 * complicated for the analysis. Use sparingly.
3315 * void Foo() PERL_TSA_NO_TSA;
3317 #define PERL_TSA_NO_TSA \
3318 PERL_TSA__(no_thread_safety_analysis)
3320 /* There are more annotations/attributes available, see the clang
3321 * documentation for details. */
3323 #if defined(USE_ITHREADS)
3325 # include <nw5thread.h>
3326 # elif defined(WIN32)
3327 # include <win32thread.h>
3329 # include "os2thread.h"
3330 # elif defined(I_MACH_CTHREADS)
3331 # include <mach/cthreads.h>
3332 typedef cthread_t perl_os_thread;
3333 typedef mutex_t perl_mutex;
3334 typedef condition_t perl_cond;
3335 typedef void * perl_key;
3336 # elif defined(I_PTHREAD) /* Posix threads */
3337 # include <pthread.h>
3338 typedef pthread_t perl_os_thread;
3339 typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
3340 typedef pthread_cond_t perl_cond;
3341 typedef pthread_key_t perl_key;
3344 /* Many readers; single writer */
3348 Size_t readers_count;
3349 } perl_RnW1_mutex_t;
3352 #endif /* USE_ITHREADS */
3354 #ifdef PERL_TSA_ACTIVE
3355 /* Since most pthread mutex interfaces have not been annotated, we
3356 * need to have these wrappers. The NO_TSA annotation is quite ugly
3357 * but it cannot be avoided in plain C, unlike in C++, where one could
3358 * e.g. use ACQUIRE() with no arg on a mutex lock method.
3360 * The bodies of these wrappers are in util.c
3362 * TODO: however, some platforms are starting to get these clang
3363 * thread safety annotations for pthreads, for example FreeBSD.
3364 * Do we need a way to a bypass these wrappers? */
3365 EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
3366 PERL_TSA_ACQUIRE(*mutex)
3368 EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
3369 PERL_TSA_RELEASE(*mutex)
3378 # include "netware.h"
3381 #define STATUS_UNIX PL_statusvalue
3383 # define STATUS_NATIVE PL_statusvalue_vms
3385 * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
3386 * its contents can not be trusted. Unfortunately, Perl seems to check
3387 * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
3390 # include <stsdef.h>
3392 /* Presume this because if VMS changes it, it will require a new
3393 * set of APIs for waiting on children for binary compatibility.
3395 # define child_offset_bits (8)
3396 # ifndef C_FAC_POSIX
3397 # define C_FAC_POSIX 0x35A000
3400 /* STATUS_EXIT - validates and returns a NATIVE exit status code for the
3401 * platform from the existing UNIX or Native status values.
3404 # define STATUS_EXIT \
3405 (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
3406 (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
3409 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
3410 * exit code and shifts the UNIX value over the correct number of bits to
3411 * be a child status. Usually the number of bits is 8, but that could be
3412 * platform dependent. The NATIVE status code is presumed to have either
3413 * from a child process.
3416 /* This is complicated. The child processes return a true native VMS
3417 status which must be saved. But there is an assumption in Perl that
3418 the UNIX child status has some relationship to errno values, so
3419 Perl tries to translate it to text in some of the tests.
3420 In order to get the string translation correct, for the error, errno
3421 must be EVMSERR, but that generates a different text message
3422 than what the test programs are expecting. So an errno value must
3423 be derived from the native status value when an error occurs.
3424 That will hide the true native status message. With this version of
3425 perl, the true native child status can always be retrieved so that
3426 is not a problem. But in this case, Pl_statusvalue and errno may
3427 have different values in them.
3430 # define STATUS_NATIVE_CHILD_SET(n) \
3432 I32 evalue = (I32)n; \
3433 if (evalue == EVMSERR) { \
3434 PL_statusvalue_vms = vaxc$errno; \
3435 PL_statusvalue = evalue; \
3437 PL_statusvalue_vms = evalue; \
3438 if (evalue == -1) { \
3439 PL_statusvalue = -1; \
3440 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3442 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1); \
3443 set_vaxc_errno(evalue); \
3444 if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX) \
3445 set_errno(EVMSERR); \
3446 else set_errno(Perl_vms_status_to_unix(evalue, 0)); \
3447 PL_statusvalue = PL_statusvalue << child_offset_bits; \
3451 # ifdef VMSISH_STATUS
3452 # define STATUS_CURRENT (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
3454 # define STATUS_CURRENT STATUS_UNIX
3457 /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3458 * the NATIVE status to an equivalent value. Can not be used to translate
3459 * exit code values as exit code values are not guaranteed to have any
3460 * relationship at all to errno values.
3461 * This is used when Perl is forcing errno to have a specific value.
3463 # define STATUS_UNIX_SET(n) \
3465 I32 evalue = (I32)n; \
3466 PL_statusvalue = evalue; \
3467 if (PL_statusvalue != -1) { \
3468 if (PL_statusvalue != EVMSERR) { \
3469 PL_statusvalue &= 0xFFFF; \
3470 if (MY_POSIX_EXIT) \
3471 PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3472 else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3475 PL_statusvalue_vms = vaxc$errno; \
3478 else PL_statusvalue_vms = SS$_ABORT; \
3479 set_vaxc_errno(PL_statusvalue_vms); \
3482 /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
3483 * the NATIVE error status based on it.
3485 * When in the default mode to comply with the Perl VMS documentation,
3486 * 0 is a success and any other code sets the NATIVE status to a failure
3487 * code of SS$_ABORT.
3489 * In the new POSIX EXIT mode, native status will be set so that the
3490 * actual exit code will can be retrieved by the calling program or
3493 * If the exit code is not clearly a UNIX parent or child exit status,
3494 * it will be passed through as a VMS status.
3497 # define STATUS_UNIX_EXIT_SET(n) \
3499 I32 evalue = (I32)n; \
3500 PL_statusvalue = evalue; \
3501 if (MY_POSIX_EXIT) { \
3502 if (evalue <= 0xFF00) { \
3503 if (evalue > 0xFF) \
3504 evalue = (evalue >> child_offset_bits) & 0xFF; \
3505 PL_statusvalue_vms = \
3506 (C_FAC_POSIX | (evalue << 3 ) | \
3507 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3508 } else /* forgive them Perl, for they have sinned */ \
3509 PL_statusvalue_vms = evalue; \
3512 PL_statusvalue_vms = SS$_NORMAL; \
3513 else if (evalue <= 0xFF00) \
3514 PL_statusvalue_vms = SS$_ABORT; \
3515 else { /* forgive them Perl, for they have sinned */ \
3516 if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3517 else PL_statusvalue_vms = vaxc$errno; \
3518 /* And obviously used a VMS status value instead of UNIX */ \
3519 PL_statusvalue = EVMSERR; \
3521 set_vaxc_errno(PL_statusvalue_vms); \
3526 /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3527 * and sets the NATIVE error status based on it. This special case
3528 * is needed to maintain compatibility with past VMS behavior.
3530 * In the default mode on VMS, this number is passed through as
3531 * both the NATIVE and UNIX status. Which makes it different
3532 * that the STATUS_UNIX_EXIT_SET.
3534 * In the new POSIX EXIT mode, native status will be set so that the
3535 * actual exit code will can be retrieved by the calling program or
3538 * A POSIX exit code is from 0 to 255. If the exit code is higher
3539 * than this, it needs to be assumed that it is a VMS exit code and
3543 # define STATUS_EXIT_SET(n) \
3545 I32 evalue = (I32)n; \
3546 PL_statusvalue = evalue; \
3547 if (MY_POSIX_EXIT) \
3548 if (evalue > 255) PL_statusvalue_vms = evalue; else { \
3549 PL_statusvalue_vms = \
3550 (C_FAC_POSIX | (evalue << 3 ) | \
3551 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
3553 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3554 set_vaxc_errno(PL_statusvalue_vms); \
3558 /* This macro forces a success status */
3559 # define STATUS_ALL_SUCCESS \
3560 (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
3562 /* This macro forces a failure status */
3563 # define STATUS_ALL_FAILURE (PL_statusvalue = 1, \
3564 vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3565 (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3567 #elif defined(__amigaos4__)
3568 /* A somewhat experimental attempt to simulate posix return code values */
3569 # define STATUS_NATIVE PL_statusvalue_posix
3570 # define STATUS_NATIVE_CHILD_SET(n) \
3572 PL_statusvalue_posix = (n); \
3573 if (PL_statusvalue_posix < 0) { \
3574 PL_statusvalue = -1; \
3577 PL_statusvalue = n << 8; \
3580 # define STATUS_UNIX_SET(n) \
3582 PL_statusvalue = (n); \
3583 if (PL_statusvalue != -1) \
3584 PL_statusvalue &= 0xFFFF; \
3586 # define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3587 # define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3588 # define STATUS_CURRENT STATUS_UNIX
3589 # define STATUS_EXIT STATUS_UNIX
3590 # define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3591 # define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3594 # define STATUS_NATIVE PL_statusvalue_posix
3595 # if defined(WCOREDUMP)
3596 # define STATUS_NATIVE_CHILD_SET(n) \
3598 PL_statusvalue_posix = (n); \
3599 if (PL_statusvalue_posix == -1) \
3600 PL_statusvalue = -1; \
3603 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
3604 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3605 (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0); \
3608 # elif defined(WIFEXITED)
3609 # define STATUS_NATIVE_CHILD_SET(n) \
3611 PL_statusvalue_posix = (n); \
3612 if (PL_statusvalue_posix == -1) \
3613 PL_statusvalue = -1; \
3616 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
3617 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0); \
3621 # define STATUS_NATIVE_CHILD_SET(n) \
3623 PL_statusvalue_posix = (n); \
3624 if (PL_statusvalue_posix == -1) \
3625 PL_statusvalue = -1; \
3628 PL_statusvalue_posix & 0xFFFF; \
3632 # define STATUS_UNIX_SET(n) \
3634 PL_statusvalue = (n); \
3635 if (PL_statusvalue != -1) \
3636 PL_statusvalue &= 0xFFFF; \
3638 # define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3639 # define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3640 # define STATUS_CURRENT STATUS_UNIX
3641 # define STATUS_EXIT STATUS_UNIX
3642 # define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3643 # define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3646 /* flags in PL_exit_flags for nature of exit() */
3647 #define PERL_EXIT_EXPECTED 0x01
3648 #define PERL_EXIT_DESTRUCT_END 0x02 /* Run END in perl_destruct */
3649 #define PERL_EXIT_WARN 0x04 /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3650 #define PERL_EXIT_ABORT 0x08 /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3653 /* format to use for version numbers in file/directory names */
3654 /* XXX move to Configure? */
3655 /* This was only ever used for the current version, and that can be done at
3656 compile time, as PERL_FS_VERSION, so should we just delete it? */
3657 # ifndef PERL_FS_VER_FMT
3658 # define PERL_FS_VER_FMT "%d.%d.%d"
3662 #ifndef PERL_FS_VERSION
3663 # define PERL_FS_VERSION PERL_VERSION_STRING
3666 /* This defines a way to flush all output buffers. This may be a
3667 * performance issue, so we allow people to disable it. Also, if
3668 * we are using stdio, there are broken implementations of fflush(NULL)
3669 * out there, Solaris being the most prominent.
3671 #ifndef PERL_FLUSHALL_FOR_CHILD
3672 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3673 # define PERL_FLUSHALL_FOR_CHILD PerlIO_flush((PerlIO*)NULL)
3674 # elif defined(FFLUSH_ALL)
3675 # define PERL_FLUSHALL_FOR_CHILD my_fflush_all()
3677 # define PERL_FLUSHALL_FOR_CHILD NOOP
3681 #ifndef PERL_WAIT_FOR_CHILDREN
3682 # define PERL_WAIT_FOR_CHILDREN NOOP
3685 /* the traditional thread-unsafe notion of "current interpreter". */
3686 #ifndef PERL_SET_INTERP
3687 # define PERL_SET_INTERP(i) (PL_curinterp = (PerlInterpreter*)(i))
3690 #ifndef PERL_GET_INTERP
3691 # define PERL_GET_INTERP (PL_curinterp)
3694 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3695 # ifdef MULTIPLICITY
3696 # define PERL_GET_THX ((PerlInterpreter *)PERL_GET_CONTEXT)
3698 # define PERL_SET_THX(t) PERL_SET_CONTEXT(t)
3702 This replaces the previous %_ "hack" by the "%p" hacks.
3703 All that is required is that the perl source does not
3704 use "%-p" or "%-<number>p" or "%<number>p" formats.
3705 These formats will still work in perl code.
3706 See comments in sv.c for further details.
3708 Robin Barker 2005-07-14
3710 No longer use %1p for VDf = %vd. RMB 2007-10-19
3714 # define SVf_(n) "-" STRINGIFY(n) "p"
3722 # define SVf32 SVf_(32)
3726 # define SVf256 SVf_(256)
3729 #define SVfARG(p) ((void*)(p))
3735 /* Not ideal, but we cannot easily include a number in an already-numeric
3736 * format sequence. */
3738 # define HEKf256 "3p"
3741 #define HEKfARG(p) ((void*)(p))
3743 /* Documented in perlguts
3745 * %4p is a custom format
3748 # define UTF8f "d%" UVuf "%4p"
3750 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3753 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
3756 /* not used; but needed for backward compatibility with XS code? - RMB
3757 =for apidoc AmnD|const char *|UVf
3759 Obsolete form of C<UVuf>, which you should convert to instead use
3768 #if !defined(DEBUGGING) && !defined(NDEBUG)
3773 /* For functions that are marked as __attribute__noreturn__, it's not
3774 appropriate to call return. In either case, include the lint directive.
3776 #ifdef HASATTRIBUTE_NORETURN
3777 # define NORETURN_FUNCTION_END NOT_REACHED;
3779 # define NORETURN_FUNCTION_END NOT_REACHED; return 0
3782 #ifdef HAS_BUILTIN_EXPECT
3783 # define EXPECT(expr,val) __builtin_expect(expr,val)
3785 # define EXPECT(expr,val) (expr)
3789 =for apidoc_section $directives
3791 =for apidoc Am||LIKELY|bool expr
3793 Returns the input unchanged, but at the same time it gives a branch prediction
3794 hint to the compiler that this condition is likely to be true.
3796 =for apidoc Am||UNLIKELY|bool expr
3798 Returns the input unchanged, but at the same time it gives a branch prediction
3799 hint to the compiler that this condition is likely to be false.
3803 #define LIKELY(cond) EXPECT(cBOOL(cond),TRUE)
3804 #define UNLIKELY(cond) EXPECT(cBOOL(cond),FALSE)
3806 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3810 /* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
3811 time invariants. That is, their argument must be a constant expression that
3812 can be verified by the compiler. This expression can contain anything that's
3813 known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3814 the expression evaluates to 0, compilation fails.
3815 Because they generate no runtime code (i.e. their use is "free"), they're
3816 always active, even under non-DEBUGGING builds.
3817 STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
3818 file scope (outside of any function).
3819 STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3822 #if (! defined(__IBMC__) || __IBMC__ >= 1210) \
3823 && (( defined(static_assert) && ( defined(_ISOC11_SOURCE) \
3824 || (__STDC_VERSION__ - 0) >= 201101L)) \
3825 || (defined(__cplusplus) && __cplusplus >= 201103L))
3826 /* XXX static_assert is a macro defined in <assert.h> in C11 or a compiler
3827 builtin in C++11. But IBM XL C V11 does not support _Static_assert, no
3828 matter what <assert.h> says.
3830 # define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
3832 /* We use a bit-field instead of an array because gcc accepts
3833 'typedef char x[n]' where n is not a compile-time constant.
3834 We want to enforce constantness.
3836 # define STATIC_ASSERT_2(COND, SUFFIX) \
3838 unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3839 } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3840 # define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
3841 # define STATIC_ASSERT_DECL(COND) STATIC_ASSERT_1(COND, __LINE__)
3843 /* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3844 error (static_assert is a declaration, and only statements can have labels).
3846 #define STATIC_ASSERT_STMT(COND) STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
3848 #ifndef __has_builtin
3849 # define __has_builtin(x) 0 /* not a clang style compiler */
3853 =for apidoc Am||ASSUME|bool expr
3854 C<ASSUME> is like C<assert()>, but it has a benefit in a release build. It is a
3855 hint to a compiler about a statement of fact in a function call free
3856 expression, which allows the compiler to generate better machine code. In a
3857 debug build, C<ASSUME(x)> is a synonym for C<assert(x)>. C<ASSUME(0)> means the
3858 control path is unreachable. In a for loop, C<ASSUME> can be used to hint that
3859 a loop will run at least X times. C<ASSUME> is based off MSVC's C<__assume>
3860 intrinsic function, see its documents for more details.
3866 # define ASSUME(x) assert(x)
3867 # if __has_builtin(__builtin_unreachable)
3868 # define HAS_BUILTIN_UNREACHABLE
3869 # elif (defined(__GNUC__) && ( __GNUC__ > 4 \
3870 || __GNUC__ == 4 && __GNUC_MINOR__ >= 5))
3871 # define HAS_BUILTIN_UNREACHABLE
3875 #if defined(__sun) || (defined(__hpux) && !defined(__GNUC__))
3877 # define ASSUME(x) /* ASSUME() generates warnings on Solaris */
3879 # define NOT_REACHED
3880 #elif defined(HAS_BUILTIN_UNREACHABLE)
3882 # define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3884 # define NOT_REACHED \
3886 ASSUME(!"UNREACHABLE"); __builtin_unreachable(); \
3889 # if defined(_MSC_VER)
3890 # define ASSUME(x) __assume(x)
3891 # elif defined(__ARMCC_VERSION) /* untested */
3892 # define ASSUME(x) __promise(x)
3894 /* a random compiler might define assert to its own special optimization
3895 * token so pass it through to C lib as a last resort */
3896 # define ASSUME(x) assert(x)
3898 # define NOT_REACHED ASSUME(!"UNREACHABLE")
3900 #undef HAS_BUILTIN_UNREACHABLE
3902 /* Some unistd.h's give a prototype for pause() even though
3903 HAS_PAUSE ends up undefined. This causes the #define
3904 below to be rejected by the compiler. Sigh.
3909 #define Pause() sleep((32767<<16)+32767)
3913 # ifdef IOCPARM_MASK
3914 /* on BSDish systems we're safe */
3915 # define IOCPARM_LEN(x) (((x) >> 16) & IOCPARM_MASK)
3916 # elif defined(_IOC_SIZE) && defined(__GLIBC__)
3917 /* on Linux systems we're safe; except when we're not [perl #38223] */
3918 # define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3920 /* otherwise guess at what's safe */
3921 # define IOCPARM_LEN(x) 256
3925 #if defined(__CYGWIN__)
3927 * This symbol, if defined, indicates that the program should
3928 * use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3929 * that a file is in "binary" mode -- that is, that no translation
3930 * of bytes occurs on read or write operations.
3932 # define USEMYBINMODE /**/
3933 # include <io.h> /* for setmode() prototype */
3934 # define my_binmode(fp, iotype, mode) \
3935 cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
3939 void init_os_extras(void);
3942 #ifdef UNION_ANY_DEFINITION
3943 UNION_ANY_DEFINITION;
3961 void (*any_dptr) (void*);
3962 void (*any_dxptr) (pTHX_ void*);
3966 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3968 #define FILTER_READ(idx, sv, len) filter_read(idx, sv, len)
3969 #define FILTER_DATA(idx) \
3970 (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3971 #define FILTER_ISREADER(idx) \
3972 (PL_parser && PL_parser->rsfp_filters \
3973 && idx >= AvFILLp(PL_parser->rsfp_filters))
3974 #define PERL_FILTER_EXISTS(i) \
3975 (PL_parser && PL_parser->rsfp_filters \
3976 && (Size_t) (i) < av_count(PL_parser->rsfp_filters))
3978 #if defined(_AIX) && !defined(_AIX43)
3979 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3980 /* We cannot include <crypt.h> to get the struct crypt_data
3981 * because of setkey prototype problems when threading */
3982 typedef struct crypt_data { /* straight from /usr/include/crypt.h */
3983 /* From OSF, Not needed in AIX
3991 #endif /* threading */
3994 #ifndef PERL_CALLCONV
3996 # define PERL_CALLCONV EXTERN_C
3998 # define PERL_CALLCONV
4001 #ifndef PERL_CALLCONV_NO_RET
4002 # define PERL_CALLCONV_NO_RET PERL_CALLCONV
4005 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
4006 dont have a noreturn as a declaration specifier
4008 #ifndef PERL_STATIC_NO_RET
4009 # define PERL_STATIC_NO_RET STATIC
4012 /* PERL_STATIC_INLINE_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE
4013 * on builds that dont have a noreturn as a declaration specifier
4015 #ifndef PERL_STATIC_INLINE_NO_RET
4016 # define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
4019 #ifndef PERL_STATIC_FORCE_INLINE
4020 # define PERL_STATIC_FORCE_INLINE PERL_STATIC_INLINE
4023 #ifndef PERL_STATIC_FORCE_INLINE_NO_RET
4024 # define PERL_STATIC_FORCE_INLINE_NO_RET PERL_STATIC_INLINE
4028 # include "iperlsys.h"
4031 #ifdef __LIBCATAMOUNT__
4032 #undef HAS_PASSWD /* unixish.h but not unixish enough. */
4034 #define FAKE_BIT_BUCKET
4037 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
4038 * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
4039 * Configure, despite their names being similar to other defines like
4040 * USE_ITHREADS. Configure in fact knows nothing about the randomised
4041 * hashes. Therefore to enable/disable the hash randomisation defines
4042 * use the Configure -Accflags=... instead. */
4043 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
4044 # define USE_HASH_SEED
4050 /* macros to define bit-fields in structs. */
4051 #ifndef PERL_BITFIELD8
4052 # define PERL_BITFIELD8 U8
4054 #ifndef PERL_BITFIELD16
4055 # define PERL_BITFIELD16 U16
4057 #ifndef PERL_BITFIELD32
4058 # define PERL_BITFIELD32 U32
4068 #include "opnames.h"
4075 #include "warnings.h"
4078 /* these would be in doio.h if there was such a file */
4079 #define my_stat() my_stat_flags(SV_GMAGIC)
4080 #define my_lstat() my_lstat_flags(SV_GMAGIC)
4082 /* defined in sv.c, but also used in [ach]v.c */
4085 #undef _XPVCV_COMMON
4089 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
4091 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C) \
4092 || defined(PERL_EXT_RE_BUILD)
4094 /* These have to be predeclared, as they are used in proto.h which is #included
4095 * before their definitions in regcomp.h. */
4098 typedef struct regnode_charclass regnode_charclass;
4100 /* A hopefully less confusing name. The sub-classes are all Posix classes only
4101 * used under /l matching */
4102 typedef struct regnode_charclass_posixl regnode_charclass_class;
4103 typedef struct regnode_charclass_posixl regnode_charclass_posixl;
4105 typedef struct regnode_ssc regnode_ssc;
4106 typedef struct RExC_state_t RExC_state_t;
4107 struct _reg_trie_data;
4111 struct ptr_tbl_ent {
4112 struct ptr_tbl_ent* next;
4118 struct ptr_tbl_ent** tbl_ary;
4121 struct ptr_tbl_arena *tbl_arena;
4122 struct ptr_tbl_ent *tbl_arena_next;
4123 struct ptr_tbl_ent *tbl_arena_end;
4126 #if defined(htonl) && !defined(HAS_HTONL)
4129 #if defined(htons) && !defined(HAS_HTONS)
4132 #if defined(ntohl) && !defined(HAS_NTOHL)
4135 #if defined(ntohs) && !defined(HAS_NTOHS)
4143 # if (BYTEORDER & 0xffff) == 0x4321
4144 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
4145 re-order their values. However, to behave identically to the alternative
4146 implementations, they should truncate to the correct size. */
4147 # define ntohl(x) ((x)&0xFFFFFFFF)
4148 # define htonl(x) ntohl(x)
4149 # define ntohs(x) ((x)&0xFFFF)
4150 # define htons(x) ntohs(x)
4151 # elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
4153 /* Note that we can't straight out declare our own htonl and htons because
4154 the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
4155 to avoid the overhead of initialising the socket subsystem, but the headers
4156 that *declare* the various functions are still seen. If we declare our own
4157 htonl etc they will clash with the declarations in the Win32 headers. */
4159 PERL_STATIC_INLINE U32
4160 my_swap32(const U32 x) {
4161 return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)
4162 | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
4165 PERL_STATIC_INLINE U16
4166 my_swap16(const U16 x) {
4167 return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
4170 # define htonl(x) my_swap32(x)
4171 # define ntohl(x) my_swap32(x)
4172 # define ntohs(x) my_swap16(x)
4173 # define htons(x) my_swap16(x)
4175 # error "Unsupported byteorder"
4176 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
4177 the error message. Please check the value of the macro BYTEORDER, as defined
4178 in config.h. The values of BYTEORDER we expect are
4180 big endian little endian
4181 32 bit 0x4321 0x1234
4182 64 bit 0x87654321 0x12345678
4184 If you have a system with a different byte order, please see
4185 pod/perlhack.pod for how to submit a patch to add supporting code.
4191 * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
4194 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
4195 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
4196 re-order their values. However, to behave identically to the alternative
4197 implementations, they should truncate to the correct size. */
4198 # define vtohl(x) ((x)&0xFFFFFFFF)
4199 # define vtohs(x) ((x)&0xFFFF)
4200 # define htovl(x) vtohl(x)
4201 # define htovs(x) vtohs(x)
4202 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
4203 # define vtohl(x) ((((x)&0xFF)<<24) \
4205 +(((x)&0x0000FF00)<<8) \
4206 +(((x)&0x00FF0000)>>8) )
4207 # define vtohs(x) ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
4208 # define htovl(x) vtohl(x)
4209 # define htovs(x) vtohs(x)
4211 # error "Unsupported byteorder"
4212 /* If you have need for current perl on PDP-11 or similar, and can help test
4213 that blead keeps working on a mixed-endian system, then see
4214 pod/perlhack.pod for how to submit patches to things working again. */
4217 /* *MAX Plus 1. A floating point value.
4218 Hopefully expressed in a way that dodgy floating point can't mess up.
4219 >> 2 rather than 1, so that value is safely less than I32_MAX after 1
4221 May find that some broken compiler will want the value cast to I32.
4222 [after the shift, as signed >> may not be as secure as unsigned >>]
4224 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
4225 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
4226 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
4227 0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
4228 may be greater than sizeof(IV), so don't assume that half max UV is max IV.
4230 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
4232 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
4233 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
4234 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
4236 /* This may look like unnecessary jumping through hoops, but converting
4237 out of range floating point values to integers *is* undefined behaviour,
4238 and it is starting to bite.
4240 =for apidoc_section $casting
4241 =for apidoc Am|I32|I_32|NV what
4242 Cast an NV to I32 while avoiding undefined C behavior
4244 =for apidoc Am|U32|U_32|NV what
4245 Cast an NV to U32 while avoiding undefined C behavior
4247 =for apidoc Am|IV|I_V|NV what
4248 Cast an NV to IV while avoiding undefined C behavior
4250 =for apidoc Am|UV|U_V|NV what
4251 Cast an NV to UV while avoiding undefined C behavior
4256 #define I_32(what) (cast_i32((NV)(what)))
4257 #define U_32(what) (cast_ulong((NV)(what)))
4258 #define I_V(what) (cast_iv((NV)(what)))
4259 #define U_V(what) (cast_uv((NV)(what)))
4261 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
4262 : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
4263 : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
4264 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
4265 : ((n) < U32_MAX_P1 ? (U32) (n) \
4266 : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
4267 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
4268 : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
4269 : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
4270 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
4271 : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
4272 : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
4275 #define U_S(what) ((U16)U_32(what))
4276 #define U_I(what) ((unsigned int)U_32(what))
4277 #define U_L(what) U_32(what)
4280 =for apidoc_section $integer
4281 =for apidoc Amn|IV|IV_MAX
4282 The largest signed integer that fits in an IV on this platform.
4284 =for apidoc Amn|IV|IV_MIN
4285 The negative signed integer furthest away from 0 that fits in an IV on this
4288 =for apidoc Amn|UV|UV_MAX
4289 The largest unsigned integer that fits in a UV on this platform.
4291 =for apidoc Amn|UV|UV_MIN
4292 The smallest unsigned integer that fits in a UV on this platform. It should
4299 # ifndef Perl_signbit
4300 # define Perl_signbit signbit
4304 /* These do not care about the fractional part, only about the range. */
4305 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
4306 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
4308 /* Used with UV/IV arguments: */
4309 /* XXXX: need to speed it up */
4310 #define CLUMP_2UV(iv) ((iv) < 0 ? 0 : (UV)(iv))
4311 #define CLUMP_2IV(uv) ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
4319 Uid_t getuid (void);
4320 Uid_t geteuid (void);
4321 Gid_t getgid (void);
4322 Gid_t getegid (void);
4326 #ifndef Perl_debug_log
4327 # define Perl_debug_log PerlIO_stderr()
4330 #ifndef Perl_error_log
4331 # define Perl_error_log (PL_stderrgv \
4332 && isGV(PL_stderrgv) \
4333 && GvIOp(PL_stderrgv) \
4334 && IoOFP(GvIOp(PL_stderrgv)) \
4335 ? IoOFP(GvIOp(PL_stderrgv)) \
4340 #define DEBUG_p_FLAG 0x00000001 /* 1 */
4341 #define DEBUG_s_FLAG 0x00000002 /* 2 */
4342 #define DEBUG_l_FLAG 0x00000004 /* 4 */
4343 #define DEBUG_t_FLAG 0x00000008 /* 8 */
4344 #define DEBUG_o_FLAG 0x00000010 /* 16 */
4345 #define DEBUG_c_FLAG 0x00000020 /* 32 */
4346 #define DEBUG_P_FLAG 0x00000040 /* 64 */
4347 #define DEBUG_m_FLAG 0x00000080 /* 128 */
4348 #define DEBUG_f_FLAG 0x00000100 /* 256 */
4349 #define DEBUG_r_FLAG 0x00000200 /* 512 */
4350 #define DEBUG_x_FLAG 0x00000400 /* 1024 */
4351 #define DEBUG_u_FLAG 0x00000800 /* 2048 */
4352 /* U is reserved for Unofficial, exploratory hacking */
4353 #define DEBUG_U_FLAG 0x00001000 /* 4096 */
4355 #define DEBUG_X_FLAG 0x00004000 /* 16384 */
4356 #define DEBUG_D_FLAG 0x00008000 /* 32768 */
4357 #define DEBUG_S_FLAG 0x00010000 /* 65536 */
4358 #define DEBUG_T_FLAG 0x00020000 /* 131072 */
4359 #define DEBUG_R_FLAG 0x00040000 /* 262144 */
4360 #define DEBUG_J_FLAG 0x00080000 /* 524288 */
4361 #define DEBUG_v_FLAG 0x00100000 /*1048576 */
4362 #define DEBUG_C_FLAG 0x00200000 /*2097152 */
4363 #define DEBUG_A_FLAG 0x00400000 /*4194304 */
4364 #define DEBUG_q_FLAG 0x00800000 /*8388608 */
4365 #define DEBUG_M_FLAG 0x01000000 /*16777216*/
4366 #define DEBUG_B_FLAG 0x02000000 /*33554432*/
4367 #define DEBUG_L_FLAG 0x04000000 /*67108864*/
4368 #define DEBUG_i_FLAG 0x08000000 /*134217728*/
4369 #define DEBUG_y_FLAG 0x10000000 /*268435456*/
4370 #define DEBUG_MASK 0x1FFFEFFF /* mask of all the standard flags */
4372 #define DEBUG_DB_RECURSE_FLAG 0x40000000
4373 #define DEBUG_TOP_FLAG 0x80000000 /* -D was given --> PL_debug |= FLAG */
4375 # define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
4376 # define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
4377 # define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
4378 # define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
4379 # define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
4380 # define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
4381 # define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
4382 # define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
4383 # define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
4384 # define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
4385 # define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
4386 # define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
4387 # define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
4388 # define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
4389 # define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
4390 # define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
4391 # define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
4392 # define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
4393 # define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
4394 # define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
4395 # define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
4396 # define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
4397 # define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
4398 # define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
4399 # define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
4400 # define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
4401 # define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
4402 # define DEBUG_y_TEST_ UNLIKELY(PL_debug & DEBUG_y_FLAG)
4403 # define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
4404 # define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
4405 # define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
4406 # define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
4407 # define DEBUG_yv_TEST_ (DEBUG_y_TEST_ && DEBUG_v_TEST_)
4411 # define DEBUG_p_TEST DEBUG_p_TEST_
4412 # define DEBUG_s_TEST DEBUG_s_TEST_
4413 # define DEBUG_l_TEST DEBUG_l_TEST_
4414 # define DEBUG_t_TEST DEBUG_t_TEST_
4415 # define DEBUG_o_TEST DEBUG_o_TEST_
4416 # define DEBUG_c_TEST DEBUG_c_TEST_
4417 # define DEBUG_P_TEST DEBUG_P_TEST_
4418 # define DEBUG_m_TEST DEBUG_m_TEST_
4419 # define DEBUG_f_TEST DEBUG_f_TEST_
4420 # define DEBUG_r_TEST DEBUG_r_TEST_
4421 # define DEBUG_x_TEST DEBUG_x_TEST_
4422 # define DEBUG_u_TEST DEBUG_u_TEST_
4423 # define DEBUG_U_TEST DEBUG_U_TEST_
4424 # define DEBUG_X_TEST DEBUG_X_TEST_
4425 # define DEBUG_D_TEST DEBUG_D_TEST_
4426 # define DEBUG_S_TEST DEBUG_S_TEST_
4427 # define DEBUG_T_TEST DEBUG_T_TEST_
4428 # define DEBUG_R_TEST DEBUG_R_TEST_
4429 # define DEBUG_J_TEST DEBUG_J_TEST_
4430 # define DEBUG_v_TEST DEBUG_v_TEST_
4431 # define DEBUG_C_TEST DEBUG_C_TEST_
4432 # define DEBUG_A_TEST DEBUG_A_TEST_
4433 # define DEBUG_q_TEST DEBUG_q_TEST_
4434 # define DEBUG_M_TEST DEBUG_M_TEST_
4435 # define DEBUG_B_TEST DEBUG_B_TEST_
4436 # define DEBUG_L_TEST DEBUG_L_TEST_
4437 # define DEBUG_i_TEST DEBUG_i_TEST_
4438 # define DEBUG_y_TEST DEBUG_y_TEST_
4439 # define DEBUG_Xv_TEST DEBUG_Xv_TEST_
4440 # define DEBUG_Uv_TEST DEBUG_Uv_TEST_
4441 # define DEBUG_Pv_TEST DEBUG_Pv_TEST_
4442 # define DEBUG_Lv_TEST DEBUG_Lv_TEST_
4443 # define DEBUG_yv_TEST DEBUG_yv_TEST_
4445 # define PERL_DEB(a) a
4446 # define PERL_DEB2(a,b) a
4447 # define PERL_DEBUG(a) if (PL_debug) a
4448 # define DEBUG_p(a) if (DEBUG_p_TEST) a
4449 # define DEBUG_s(a) if (DEBUG_s_TEST) a
4450 # define DEBUG_l(a) if (DEBUG_l_TEST) a
4451 # define DEBUG_t(a) if (DEBUG_t_TEST) a
4452 # define DEBUG_o(a) if (DEBUG_o_TEST) a
4453 # define DEBUG_c(a) if (DEBUG_c_TEST) a
4454 # define DEBUG_P(a) if (DEBUG_P_TEST) a
4456 /* Temporarily turn off memory debugging in case the a
4457 * does memory allocation, either directly or indirectly. */
4458 # define DEBUG_m(a) \
4460 if (PERL_GET_INTERP) { \
4462 if (DEBUG_m_TEST) { \
4463 PL_debug &= ~DEBUG_m_FLAG; \
4465 PL_debug |= DEBUG_m_FLAG; \
4470 # define DEBUG__(t, a) \
4472 if (t) STMT_START {a;} STMT_END; \
4475 # define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
4477 /* For re_comp.c, re_exec.c, assume -Dr has been specified */
4478 # ifdef PERL_EXT_RE_BUILD
4479 # define DEBUG_r(a) STMT_START {a;} STMT_END
4481 # define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
4482 # endif /* PERL_EXT_RE_BUILD */
4484 # define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
4485 # define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
4486 # define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
4487 # define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
4488 # define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
4489 # define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
4490 # define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
4491 # define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
4492 # define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
4493 # define DEBUG_yv(a) DEBUG__(DEBUG_yv_TEST, a)
4495 # define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
4496 # define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
4497 # define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
4498 # define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
4499 # define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
4500 # define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
4501 # define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
4502 # define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
4503 # define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
4504 # define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
4505 # define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
4506 # define DEBUG_y(a) DEBUG__(DEBUG_y_TEST, a)
4508 #else /* ! DEBUGGING below */
4510 # define DEBUG_p_TEST (0)
4511 # define DEBUG_s_TEST (0)
4512 # define DEBUG_l_TEST (0)
4513 # define DEBUG_t_TEST (0)
4514 # define DEBUG_o_TEST (0)
4515 # define DEBUG_c_TEST (0)
4516 # define DEBUG_P_TEST (0)
4517 # define DEBUG_m_TEST (0)
4518 # define DEBUG_f_TEST (0)
4519 # define DEBUG_r_TEST (0)
4520 # define DEBUG_x_TEST (0)
4521 # define DEBUG_u_TEST (0)
4522 # define DEBUG_U_TEST (0)
4523 # define DEBUG_X_TEST (0)
4524 # define DEBUG_D_TEST (0)
4525 # define DEBUG_S_TEST (0)
4526 # define DEBUG_T_TEST (0)
4527 # define DEBUG_R_TEST (0)
4528 # define DEBUG_J_TEST (0)
4529 # define DEBUG_v_TEST (0)
4530 # define DEBUG_C_TEST (0)
4531 # define DEBUG_A_TEST (0)
4532 # define DEBUG_q_TEST (0)
4533 # define DEBUG_M_TEST (0)
4534 # define DEBUG_B_TEST (0)
4535 # define DEBUG_L_TEST (0)
4536 # define DEBUG_i_TEST (0)
4537 # define DEBUG_y_TEST (0)
4538 # define DEBUG_Xv_TEST (0)
4539 # define DEBUG_Uv_TEST (0)
4540 # define DEBUG_Pv_TEST (0)
4541 # define DEBUG_Lv_TEST (0)
4542 # define DEBUG_yv_TEST (0)
4544 # define PERL_DEB(a)
4545 # define PERL_DEB2(a,b) b
4546 # define PERL_DEBUG(a)
4574 # define DEBUG_Xv(a)
4575 # define DEBUG_Uv(a)
4576 # define DEBUG_Pv(a)
4577 # define DEBUG_Lv(a)
4578 # define DEBUG_yv(a)
4579 #endif /* DEBUGGING */
4582 #define DEBUG_SCOPE(where) \
4584 Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n", \
4585 where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
4586 __FILE__, __LINE__));
4588 /* Keep the old croak based assert for those who want it, and as a fallback if
4589 the platform is so heretically non-ANSI that it can't assert. */
4591 #define Perl_assert(what) PERL_DEB2( \
4592 ((what) ? ((void) 0) : \
4593 (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
4594 "\", line %d", STRINGIFY(what), __LINE__), \
4595 (void) 0)), ((void)0))
4597 /* assert() gets defined if DEBUGGING.
4598 * If no DEBUGGING, the <assert.h> has not been included. */
4600 # define assert(what) Perl_assert(what)
4603 # define assert_(what) assert(what),
4605 # define assert_(what)
4609 I32 (*uf_val)(pTHX_ IV, SV*);
4610 I32 (*uf_set)(pTHX_ IV, SV*);
4614 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4615 * XS code wanting to be backward compatible can do something
4616 * like the following:
4618 #ifndef PERL_MG_UFUNC
4619 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4622 static PERL_MG_UFUNC(foo_get, index, val)
4632 #ifndef PERL_MG_UFUNC
4633 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4638 /* isfinite and others are here rather than in math.h as C99 stipulates */
4643 # if !defined(WIN32) && !defined(VMS)
4645 char *crypt (const char*, const char*);
4647 # endif /* !WIN32 */
4650 char *getlogin (void);
4652 # endif /* !WIN32 */
4653 #endif /* !__cplusplus */
4655 /* Fixme on VMS. This needs to be a run-time, not build time options */
4656 /* Also rename() is affected by this */
4657 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4658 #define UNLINK unlnk
4659 I32 unlnk (pTHX_ const char*);
4661 #define UNLINK PerlLIO_unlink
4664 /* some versions of glibc are missing the setresuid() proto */
4665 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4666 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4668 /* some versions of glibc are missing the setresgid() proto */
4669 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4670 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4673 #ifndef HAS_SETREUID
4674 # ifdef HAS_SETRESUID
4675 # define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4676 # define HAS_SETREUID
4679 #ifndef HAS_SETREGID
4680 # ifdef HAS_SETRESGID
4681 # define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4682 # define HAS_SETREGID
4686 /* Sighandler_t defined in iperlsys.h */
4688 #ifdef HAS_SIGACTION
4689 typedef struct sigaction Sigsave_t;
4691 typedef Sighandler_t Sigsave_t;
4702 # define RUNOPS_DEFAULT Perl_runops_debug
4704 # define RUNOPS_DEFAULT Perl_runops_standard
4707 #if defined(USE_PERLIO)
4708 EXTERN_C void PerlIO_teardown(void);
4709 # ifdef USE_ITHREADS
4710 # define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4711 # define PERLIO_TERM \
4713 PerlIO_teardown(); \
4714 MUTEX_DESTROY(&PL_perlio_mutex);\
4717 # define PERLIO_INIT
4718 # define PERLIO_TERM PerlIO_teardown()
4721 # define PERLIO_INIT
4722 # define PERLIO_TERM
4726 # ifdef MUTEX_INIT_CALLS_MALLOC
4727 # define MALLOC_INIT \
4729 PL_malloc_mutex = NULL; \
4730 MUTEX_INIT(&PL_malloc_mutex); \
4732 # define MALLOC_TERM \
4734 perl_mutex tmp = PL_malloc_mutex; \
4735 PL_malloc_mutex = NULL; \
4736 MUTEX_DESTROY(&tmp); \
4739 # define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4740 # define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4743 # define MALLOC_INIT
4744 # define MALLOC_TERM
4747 #if defined(PERL_IMPLICIT_CONTEXT)
4749 struct perl_memory_debug_header;
4750 struct perl_memory_debug_header {
4752 # if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4755 struct perl_memory_debug_header *prev;
4756 struct perl_memory_debug_header *next;
4757 # ifdef PERL_DEBUG_READONLY_COW
4762 #elif defined(PERL_DEBUG_READONLY_COW)
4764 struct perl_memory_debug_header;
4765 struct perl_memory_debug_header {
4771 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4773 # define PERL_MEMORY_DEBUG_HEADER_SIZE \
4774 (sizeof(struct perl_memory_debug_header) + \
4775 (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4776 %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4779 # define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4782 #ifdef PERL_TRACK_MEMPOOL
4783 # ifdef PERL_DEBUG_READONLY_COW
4784 # define INIT_TRACK_MEMPOOL(header, interp) \
4786 (header).interpreter = (interp); \
4787 (header).prev = (header).next = &(header); \
4788 (header).readonly = 0; \
4791 # define INIT_TRACK_MEMPOOL(header, interp) \
4793 (header).interpreter = (interp); \
4794 (header).prev = (header).next = &(header); \
4798 # define INIT_TRACK_MEMPOOL(header, interp)
4801 #ifdef I_MALLOCMALLOC
4802 /* Needed for malloc_size(), malloc_good_size() on some systems */
4803 # include <malloc/malloc.h>
4807 # define Perl_safesysmalloc_size(where) Perl_malloced_size(where)
4809 # if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4810 # ifdef PERL_TRACK_MEMPOOL
4811 # define Perl_safesysmalloc_size(where) \
4812 (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4814 # define Perl_safesysmalloc_size(where) malloc_size(where)
4817 # ifdef HAS_MALLOC_GOOD_SIZE
4818 # ifdef PERL_TRACK_MEMPOOL
4819 # define Perl_malloc_good_size(how_much) \
4820 (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4822 # define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4825 /* Having this as the identity operation makes some code simpler. */
4826 # define Perl_malloc_good_size(how_much) (how_much)
4830 typedef int (*runops_proc_t)(pTHX);
4831 typedef void (*share_proc_t) (pTHX_ SV *sv);
4832 typedef int (*thrhook_proc_t) (pTHX);
4833 typedef OP* (*PPADDR_t[]) (pTHX);
4834 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4835 typedef void (*despatch_signals_proc_t) (pTHX);
4837 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4838 # include <crt_externs.h> /* for the env array */
4839 # define environ (*_NSGetEnviron())
4840 #elif defined(USE_ENVIRON_ARRAY) && !defined(environ)
4841 /* VMS and some other platforms don't use the environ array */
4842 EXTERN_C char **environ; /* environment variables supplied via exec */
4845 #define PERL_PATCHLEVEL_H_IMPLICIT
4846 #include "patchlevel.h"
4847 #undef PERL_PATCHLEVEL_H_IMPLICIT
4849 #define PERL_VERSION_STRING STRINGIFY(PERL_REVISION) "." \
4850 STRINGIFY(PERL_VERSION) "." \
4851 STRINGIFY(PERL_SUBVERSION)
4853 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4854 STRINGIFY(PERL_API_VERSION) "." \
4855 STRINGIFY(PERL_API_SUBVERSION)
4859 /* handy constants */
4860 EXTCONST char PL_warn_uninit[]
4861 INIT("Use of uninitialized value%s%s%s");
4862 EXTCONST char PL_warn_uninit_sv[]
4863 INIT("Use of uninitialized value%" SVf "%s%s");
4864 EXTCONST char PL_warn_nosemi[]
4865 INIT("Semicolon seems to be missing");
4866 EXTCONST char PL_warn_reserved[]
4867 INIT("Unquoted string \"%s\" may clash with future reserved word");
4868 EXTCONST char PL_warn_nl[]
4869 INIT("Unsuccessful %s on filename containing newline");
4870 EXTCONST char PL_no_wrongref[]
4871 INIT("Can't use %s ref as %s ref");
4872 /* The core no longer needs this here. If you require the string constant,
4873 please inline a copy into your own code. */
4874 EXTCONST char PL_no_symref[] __attribute__deprecated__
4875 INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4876 EXTCONST char PL_no_symref_sv[]
4877 INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4879 EXTCONST char PL_no_usym[]
4880 INIT("Can't use an undefined value as %s reference");
4881 EXTCONST char PL_no_aelem[]
4882 INIT("Modification of non-creatable array value attempted, subscript %d");
4883 EXTCONST char PL_no_helem_sv[]
4884 INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4885 EXTCONST char PL_no_modify[]
4886 INIT("Modification of a read-only value attempted");
4887 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4888 INIT("Out of memory!\n");
4889 EXTCONST char PL_no_security[]
4890 INIT("Insecure dependency in %s%s");
4891 EXTCONST char PL_no_sock_func[]
4892 INIT("Unsupported socket function \"%s\" called");
4893 EXTCONST char PL_no_dir_func[]
4894 INIT("Unsupported directory function \"%s\" called");
4895 EXTCONST char PL_no_func[]
4896 INIT("The %s function is unimplemented");
4897 EXTCONST char PL_no_myglob[]
4898 INIT("\"%s\" %s %s can't be in a package");
4899 EXTCONST char PL_no_localize_ref[]
4900 INIT("Can't localize through a reference");
4901 EXTCONST char PL_memory_wrap[]
4902 INIT("panic: memory wrap");
4903 EXTCONST char PL_extended_cp_format[]
4904 INIT("Code point 0x%" UVXf " is not Unicode, requires a Perl extension,"
4905 " and so is not portable");
4906 EXTCONST char PL_Yes[]
4908 EXTCONST char PL_No[]
4910 EXTCONST char PL_Zero[]
4914 =for apidoc_section $numeric
4915 =for apidoc AmTuU|const char *|PL_hexdigit|U8 value
4917 This array, indexed by an integer, converts that value into the character that
4918 represents it. For example, if the input is 8, the return will be a string
4919 whose first character is '8'. What is actually returned is a pointer into a
4920 string. All you are interested in is the first character of that string. To
4921 get uppercase letters (for the values 10..15), add 16 to the index. Hence,
4922 C<PL_hexdigit[11]> is C<'b'>, and C<PL_hexdigit[11+16]> is C<'B'>. Adding 16
4923 to an index whose representation is '0'..'9' yields the same as not adding 16.
4924 Indices outside the range 0..31 result in (bad) undedefined behavior.
4928 EXTCONST char PL_hexdigit[]
4929 INIT("0123456789abcdef0123456789ABCDEF");
4931 EXTCONST STRLEN PL_WARN_ALL
4933 EXTCONST STRLEN PL_WARN_NONE
4936 /* This is constant on most architectures, a global on OS/2 */
4938 EXTCONST char PL_sh_path[]
4939 INIT(SH_PATH); /* full path of shell */
4943 EXTCONST char PL_cshname[]
4945 # define PL_cshlen (sizeof(CSH "") - 1)
4948 /* These are baked at compile time into any shared perl library.
4949 In future releases this will allow us in main() to sanity test the
4950 library we're linking against. */
4952 EXTCONST U8 PL_revision
4953 INIT(PERL_REVISION);
4954 EXTCONST U8 PL_version
4956 EXTCONST U8 PL_subversion
4957 INIT(PERL_SUBVERSION);
4959 EXTCONST char PL_uuemap[65]
4960 INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4962 /* a special string address whose value is "isa", but which perl knows
4963 * to treat as if it were really "DOES" when printing the method name in
4964 * the "Can't call method '%s'" error message */
4965 EXTCONST char PL_isa_DOES[]
4969 EXTCONST char PL_uudmap[256] =
4971 # include "uuudmap.h"
4973 # include "uudmap.h"
4976 EXTCONST char PL_bitcount[256] =
4978 # include "ubitcount.h"
4980 # include "bitcount.h"
4983 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4984 EXTCONST int PL_sig_num[] = { SIG_NUM };
4986 EXTCONST char PL_uudmap[256];
4987 EXTCONST char PL_bitcount[256];
4988 EXTCONST char* const PL_sig_name[];
4989 EXTCONST int PL_sig_num[];
4992 /* fast conversion and case folding tables. The folding tables complement the
4993 * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4994 * folds such as outside the range or to multiple characters. */
4999 /* The EBCDIC fold table depends on the code page, and hence is found in
5000 * ebcdic_tables.h */
5002 EXTCONST unsigned char PL_fold[] = {
5003 0, 1, 2, 3, 4, 5, 6, 7,
5004 8, 9, 10, 11, 12, 13, 14, 15,
5005 16, 17, 18, 19, 20, 21, 22, 23,
5006 24, 25, 26, 27, 28, 29, 30, 31,
5007 32, 33, 34, 35, 36, 37, 38, 39,
5008 40, 41, 42, 43, 44, 45, 46, 47,
5009 48, 49, 50, 51, 52, 53, 54, 55,
5010 56, 57, 58, 59, 60, 61, 62, 63,
5011 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
5012 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
5013 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
5014 'x', 'y', 'z', 91, 92, 93, 94, 95,
5015 96, 'A', 'B', 'C', 'D', 'E', 'F', 'G',
5016 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
5017 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
5018 'X', 'Y', 'Z', 123, 124, 125, 126, 127,
5019 128, 129, 130, 131, 132, 133, 134, 135,
5020 136, 137, 138, 139, 140, 141, 142, 143,
5021 144, 145, 146, 147, 148, 149, 150, 151,
5022 152, 153, 154, 155, 156, 157, 158, 159,
5023 160, 161, 162, 163, 164, 165, 166, 167,
5024 168, 169, 170, 171, 172, 173, 174, 175,
5025 176, 177, 178, 179, 180, 181, 182, 183,
5026 184, 185, 186, 187, 188, 189, 190, 191,
5027 192, 193, 194, 195, 196, 197, 198, 199,
5028 200, 201, 202, 203, 204, 205, 206, 207,
5029 208, 209, 210, 211, 212, 213, 214, 215,
5030 216, 217, 218, 219, 220, 221, 222, 223,
5031 224, 225, 226, 227, 228, 229, 230, 231,
5032 232, 233, 234, 235, 236, 237, 238, 239,
5033 240, 241, 242, 243, 244, 245, 246, 247,
5034 248, 249, 250, 251, 252, 253, 254, 255
5037 EXT unsigned char PL_fold_locale[] = { /* Unfortunately not EXTCONST. */
5038 0, 1, 2, 3, 4, 5, 6, 7,
5039 8, 9, 10, 11, 12, 13, 14, 15,
5040 16, 17, 18, 19, 20, 21, 22, 23,
5041 24, 25, 26, 27, 28, 29, 30, 31,
5042 32, 33, 34, 35, 36, 37, 38, 39,
5043 40, 41, 42, 43, 44, 45, 46, 47,
5044 48, 49, 50, 51, 52, 53, 54, 55,
5045 56, 57, 58, 59, 60, 61, 62, 63,
5046 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
5047 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
5048 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
5049 'x', 'y', 'z', 91, 92, 93, 94, 95,
5050 96, 'A', 'B', 'C', 'D', 'E', 'F', 'G',
5051 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
5052 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
5053 'X', 'Y', 'Z', 123, 124, 125, 126, 127,
5054 128, 129, 130, 131, 132, 133, 134, 135,
5055 136, 137, 138, 139, 140, 141, 142, 143,
5056 144, 145, 146, 147, 148, 149, 150, 151,
5057 152, 153, 154, 155, 156, 157, 158, 159,
5058 160, 161, 162, 163, 164, 165, 166, 167,
5059 168, 169, 170, 171, 172, 173, 174, 175,
5060 176, 177, 178, 179, 180, 181, 182, 183,
5061 184, 185, 186, 187, 188, 189, 190, 191,
5062 192, 193, 194, 195, 196, 197, 198, 199,
5063 200, 201, 202, 203, 204, 205, 206, 207,
5064 208, 209, 210, 211, 212, 213, 214, 215,
5065 216, 217, 218, 219, 220, 221, 222, 223,
5066 224, 225, 226, 227, 228, 229, 230, 231,
5067 232, 233, 234, 235, 236, 237, 238, 239,
5068 240, 241, 242, 243, 244, 245, 246, 247,
5069 248, 249, 250, 251, 252, 253, 254, 255
5072 EXTCONST unsigned char PL_fold_latin1[] = {
5073 /* Full latin1 complement folding, except for three problematic code points:
5074 * Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
5075 * fold complements outside the Latin1 range, so can't match something
5076 * that isn't in utf8.
5077 * German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
5078 * not one, so can't be represented in this table.
5080 * All have to be specially handled */
5081 0, 1, 2, 3, 4, 5, 6, 7,
5082 8, 9, 10, 11, 12, 13, 14, 15,
5083 16, 17, 18, 19, 20, 21, 22, 23,
5084 24, 25, 26, 27, 28, 29, 30, 31,
5085 32, 33, 34, 35, 36, 37, 38, 39,
5086 40, 41, 42, 43, 44, 45, 46, 47,
5087 48, 49, 50, 51, 52, 53, 54, 55,
5088 56, 57, 58, 59, 60, 61, 62, 63,
5089 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
5090 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
5091 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
5092 'x', 'y', 'z', 91, 92, 93, 94, 95,
5093 96, 'A', 'B', 'C', 'D', 'E', 'F', 'G',
5094 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
5095 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
5096 'X', 'Y', 'Z', 123, 124, 125, 126, 127,
5097 128, 129, 130, 131, 132, 133, 134, 135,
5098 136, 137, 138, 139, 140, 141, 142, 143,
5099 144, 145, 146, 147, 148, 149, 150, 151,
5100 152, 153, 154, 155, 156, 157, 158, 159,
5101 160, 161, 162, 163, 164, 165, 166, 167,
5102 168, 169, 170, 171, 172, 173, 174, 175,
5103 176, 177, 178, 179, 180, 181 /*micro */, 182, 183,
5104 184, 185, 186, 187, 188, 189, 190, 191,
5105 192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
5106 200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
5107 208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
5108 216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
5109 224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
5110 232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
5111 240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
5112 248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
5113 255 /* y with diaeresis */
5116 /* If these tables are accessed through ebcdic, the access will be converted to
5118 EXTCONST unsigned char PL_latin1_lc[] = { /* lowercasing */
5119 0, 1, 2, 3, 4, 5, 6, 7,
5120 8, 9, 10, 11, 12, 13, 14, 15,
5121 16, 17, 18, 19, 20, 21, 22, 23,
5122 24, 25, 26, 27, 28, 29, 30, 31,
5123 32, 33, 34, 35, 36, 37, 38, 39,
5124 40, 41, 42, 43, 44, 45, 46, 47,
5125 48, 49, 50, 51, 52, 53, 54, 55,
5126 56, 57, 58, 59, 60, 61, 62, 63,
5127 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
5128 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
5129 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
5130 'x', 'y', 'z', 91, 92, 93, 94, 95,
5131 96, 97, 98, 99, 100, 101, 102, 103,
5132 104, 105, 106, 107, 108, 109, 110, 111,
5133 112, 113, 114, 115, 116, 117, 118, 119,
5134 120, 121, 122, 123, 124, 125, 126, 127,
5135 128, 129, 130, 131, 132, 133, 134, 135,
5136 136, 137, 138, 139, 140, 141, 142, 143,
5137 144, 145, 146, 147, 148, 149, 150, 151,
5138 152, 153, 154, 155, 156, 157, 158, 159,
5139 160, 161, 162, 163, 164, 165, 166, 167,
5140 168, 169, 170, 171, 172, 173, 174, 175,
5141 176, 177, 178, 179, 180, 181, 182, 183,
5142 184, 185, 186, 187, 188, 189, 190, 191,
5143 192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
5144 200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
5145 208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
5146 216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223,
5147 224, 225, 226, 227, 228, 229, 230, 231,
5148 232, 233, 234, 235, 236, 237, 238, 239,
5149 240, 241, 242, 243, 244, 245, 246, 247,
5150 248, 249, 250, 251, 252, 253, 254, 255
5153 /* upper and title case of latin1 characters, modified so that the three tricky
5154 * ones are mapped to 255 (which is one of the three) */
5155 EXTCONST unsigned char PL_mod_latin1_uc[] = {
5156 0, 1, 2, 3, 4, 5, 6, 7,
5157 8, 9, 10, 11, 12, 13, 14, 15,
5158 16, 17, 18, 19, 20, 21, 22, 23,
5159 24, 25, 26, 27, 28, 29, 30, 31,
5160 32, 33, 34, 35, 36, 37, 38, 39,
5161 40, 41, 42, 43, 44, 45, 46, 47,
5162 48, 49, 50, 51, 52, 53, 54, 55,
5163 56, 57, 58, 59, 60, 61, 62, 63,
5164 64, 65, 66, 67, 68, 69, 70, 71,
5165 72, 73, 74, 75, 76, 77, 78, 79,
5166 80, 81, 82, 83, 84, 85, 86, 87,
5167 88, 89, 90, 91, 92, 93, 94, 95,
5168 96, 'A', 'B', 'C', 'D', 'E', 'F', 'G',
5169 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
5170 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
5171 'X', 'Y', 'Z', 123, 124, 125, 126, 127,
5172 128, 129, 130, 131, 132, 133, 134, 135,
5173 136, 137, 138, 139, 140, 141, 142, 143,
5174 144, 145, 146, 147, 148, 149, 150, 151,
5175 152, 153, 154, 155, 156, 157, 158, 159,
5176 160, 161, 162, 163, 164, 165, 166, 167,
5177 168, 169, 170, 171, 172, 173, 174, 175,
5178 176, 177, 178, 179, 180, 255 /*micro*/, 182, 183,
5179 184, 185, 186, 187, 188, 189, 190, 191,
5180 192, 193, 194, 195, 196, 197, 198, 199,
5181 200, 201, 202, 203, 204, 205, 206, 207,
5182 208, 209, 210, 211, 212, 213, 214, 215,
5183 216, 217, 218, 219, 220, 221, 222,
5184 # if UNICODE_MAJOR_VERSION > 2 \
5185 || (UNICODE_MAJOR_VERSION == 2 && UNICODE_DOT_VERSION >= 1 \
5186 && UNICODE_DOT_DOT_VERSION >= 8)
5188 # else /* uc(sharp s) is 'sharp s' itself in early unicode */
5191 224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
5192 232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
5193 240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
5194 248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32, 255
5196 # endif /* !EBCDIC, but still in DOINIT */
5197 #else /* ! DOINIT */
5199 EXTCONST unsigned char PL_fold[];
5200 EXTCONST unsigned char PL_fold_latin1[];
5201 EXTCONST unsigned char PL_mod_latin1_uc[];
5202 EXTCONST unsigned char PL_latin1_lc[];
5203 EXT unsigned char PL_fold_locale[]; /* Unfortunately not EXTCONST. */
5207 /* Although only used for debugging, these constants must be available in
5208 * non-debugging builds too, since they're used in ext/re/re_exec.c,
5209 * which has DEBUGGING enabled always */
5211 EXTCONST char* const PL_block_type[] = {
5227 EXTCONST char* PL_block_type[];
5230 /* These are all the compile time options that affect binary compatibility.
5231 Other compile time options that are binary compatible are in perl.c
5232 (in S_Internals_V()). Both are combined for the output of perl -V
5233 However, this string will be embedded in any shared perl library, which will
5234 allow us add a comparison check in perlmain.c in the near future. */
5236 EXTCONST char PL_bincompat_options[] =
5237 # ifdef DEBUG_LEAKING_SCALARS
5238 " DEBUG_LEAKING_SCALARS"
5240 # ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5241 " DEBUG_LEAKING_SCALARS_FORK_DUMP"
5246 # ifdef HAVE_INTERP_INTERN
5247 " HAVE_INTERP_INTERN"
5249 # ifdef MULTIPLICITY
5255 # ifdef PERLIO_LAYERS
5258 # ifdef PERL_DEBUG_READONLY_COW
5259 " PERL_DEBUG_READONLY_COW"
5261 # ifdef PERL_DEBUG_READONLY_OPS
5262 " PERL_DEBUG_READONLY_OPS"
5264 # ifdef PERL_IMPLICIT_CONTEXT
5265 " PERL_IMPLICIT_CONTEXT"
5267 # ifdef PERL_IMPLICIT_SYS
5268 " PERL_IMPLICIT_SYS"
5276 # ifdef PERL_SAWAMPERSAND
5277 " PERL_SAWAMPERSAND"
5279 # ifdef PERL_TRACK_MEMPOOL
5280 " PERL_TRACK_MEMPOOL"
5282 # ifdef PERL_USES_PL_PIDSTATUS
5283 " PERL_USES_PL_PIDSTATUS"
5285 # ifdef USE_64_BIT_ALL
5288 # ifdef USE_64_BIT_INT
5294 # ifdef USE_ITHREADS
5297 # ifdef USE_LARGE_FILES
5300 # ifdef USE_LOCALE_COLLATE
5301 " USE_LOCALE_COLLATE"
5303 # ifdef USE_LOCALE_NUMERIC
5304 " USE_LOCALE_NUMERIC"
5306 # ifdef USE_LOCALE_TIME
5309 # ifdef USE_LONG_DOUBLE
5315 # ifdef USE_QUADMATH
5318 # ifdef USE_REENTRANT_API
5319 " USE_REENTRANT_API"
5324 # ifdef VMS_DO_SOCKETS
5327 # ifdef VMS_SHORTEN_LONG_SYMBOLS
5328 " VMS_SHORTEN_LONG_SYMBOLS"
5330 # ifdef VMS_WE_ARE_CASE_SENSITIVE
5331 " VMS_SYMBOL_CASE_AS_IS"
5335 EXTCONST char PL_bincompat_options[];
5338 #ifndef PERL_SET_PHASE
5339 # define PERL_SET_PHASE(new_phase) \
5340 PERL_DTRACE_PROBE_PHASE(new_phase); \
5341 PL_phase = new_phase;
5344 /* The interpreter phases. If these ever change, PL_phase_names right below will
5345 * need to be updated accordingly. */
5347 PERL_PHASE_CONSTRUCT = 0,
5348 PERL_PHASE_START = 1,
5349 PERL_PHASE_CHECK = 2,
5350 PERL_PHASE_INIT = 3,
5353 PERL_PHASE_DESTRUCT = 6
5357 EXTCONST char *const PL_phase_names[] = {
5367 EXTCONST char *const PL_phase_names[];
5371 /* Do not use this macro. It only exists for extensions that rely on PL_dirty
5372 * instead of using the newer PL_phase, which provides everything PL_dirty
5373 * provided, and more. */
5374 # define PL_dirty cBOOL(PL_phase == PERL_PHASE_DESTRUCT)
5376 # define PL_amagic_generation PL_na
5377 # define PL_encoding ((SV *)NULL)
5378 #endif /* !PERL_CORE */
5380 #define PL_hints PL_compiling.cop_hints
5381 #define PL_maxo MAXO
5385 /*****************************************************************************/
5386 /* This lexer/parser stuff is currently global since yacc is hard to reenter */
5387 /*****************************************************************************/
5388 /* XXX This needs to be revisited, since BEGIN makes yacc re-enter... */
5391 /* LynxOS defines these in scsi.h which is included via ioctl.h */
5400 #define LEX_NOTPARSING 11 /* borrowed from toke.c */
5408 XATTRBLOCK, /* next token should be an attribute or block */
5409 XATTRTERM, /* next token should be an attribute, or block in a term */
5413 XTERMORDORDOR /* evil hack */
5414 /* update exp_name[] in toke.c if adding to this enum */
5417 #define KEY_sigvar 0xFFFF /* fake keyword representing a signature var */
5419 /* Hints are now stored in a dedicated U32, so the bottom 8 bits are no longer
5420 special and there is no need for HINT_PRIVATE_MASK for COPs
5421 However, bitops store HINT_INTEGER in their op_private.
5423 NOTE: The typical module using these has the bit value hard-coded, so don't
5424 blindly change the values of these.
5426 If we run out of bits, the 2 locale ones could be combined. The PARTIAL one
5427 is for "use locale 'FOO'" which excludes some categories. It requires going
5428 to %^H to find out which are in and which are out. This could be extended
5429 for the normal case of a plain HINT_LOCALE, so that %^H would be used for
5431 #define HINT_INTEGER 0x00000001 /* integer pragma */
5432 #define HINT_STRICT_REFS 0x00000002 /* strict pragma */
5433 #define HINT_LOCALE 0x00000004 /* locale pragma */
5434 #define HINT_BYTES 0x00000008 /* bytes pragma */
5435 #define HINT_LOCALE_PARTIAL 0x00000010 /* locale, but a subset of categories */
5437 #define HINT_EXPLICIT_STRICT_REFS 0x00000020 /* strict.pm */
5438 #define HINT_EXPLICIT_STRICT_SUBS 0x00000040 /* strict.pm */
5439 #define HINT_EXPLICIT_STRICT_VARS 0x00000080 /* strict.pm */
5441 #define HINT_BLOCK_SCOPE 0x00000100
5442 #define HINT_STRICT_SUBS 0x00000200 /* strict pragma */
5443 #define HINT_STRICT_VARS 0x00000400 /* strict pragma */
5444 #define HINT_UNI_8_BIT 0x00000800 /* unicode_strings feature */
5446 /* The HINT_NEW_* constants are used by the overload pragma */
5447 #define HINT_NEW_INTEGER 0x00001000
5448 #define HINT_NEW_FLOAT 0x00002000
5449 #define HINT_NEW_BINARY 0x00004000
5450 #define HINT_NEW_STRING 0x00008000
5451 #define HINT_NEW_RE 0x00010000
5452 #define HINT_LOCALIZE_HH 0x00020000 /* %^H needs to be copied */
5453 #define HINT_LEXICAL_IO_IN 0x00040000 /* ${^OPEN} is set for input */
5454 #define HINT_LEXICAL_IO_OUT 0x00080000 /* ${^OPEN} is set for output */
5456 #define HINT_RE_TAINT 0x00100000 /* re pragma */
5457 #define HINT_RE_EVAL 0x00200000 /* re pragma */
5459 #define HINT_FILETEST_ACCESS 0x00400000 /* filetest pragma */
5460 #define HINT_UTF8 0x00800000 /* utf8 pragma */
5462 #define HINT_NO_AMAGIC 0x01000000 /* overloading pragma */
5464 #define HINT_RE_FLAGS 0x02000000 /* re '/xism' pragma */
5466 #define HINT_FEATURE_MASK 0x3c000000 /* 4 bits for feature bundles */
5468 /* Note: Used for HINT_M_VMSISH_*,
5469 currently defined by vms/vmsish.h:
5474 /* The following are stored in $^H{sort}, not in PL_hints */
5475 #define HINT_SORT_STABLE 0x00000100 /* sort styles */
5476 #define HINT_SORT_UNSTABLE 0x00000200
5478 #define HINT_ALL_STRICT HINT_STRICT_REFS \
5479 | HINT_STRICT_SUBS \
5482 #ifdef USE_STRICT_BY_DEFAULT
5483 #define HINTS_DEFAULT HINT_ALL_STRICT
5485 #define HINTS_DEFAULT 0
5488 /* flags for PL_sawampersand */
5490 #define SAWAMPERSAND_LEFT 1 /* saw $` */
5491 #define SAWAMPERSAND_MIDDLE 2 /* saw $& */
5492 #define SAWAMPERSAND_RIGHT 4 /* saw $' */
5494 #ifndef PERL_SAWAMPERSAND
5495 # define PL_sawampersand \
5496 (SAWAMPERSAND_LEFT|SAWAMPERSAND_MIDDLE|SAWAMPERSAND_RIGHT)
5499 /* Used for debugvar magic */
5500 #define DBVARMG_SINGLE 0
5501 #define DBVARMG_TRACE 1
5502 #define DBVARMG_SIGNAL 2
5503 #define DBVARMG_COUNT 3
5505 #define PL_DBsingle_iv (PL_DBcontrol[DBVARMG_SINGLE])
5506 #define PL_DBtrace_iv (PL_DBcontrol[DBVARMG_TRACE])
5507 #define PL_DBsignal_iv (PL_DBcontrol[DBVARMG_SIGNAL])
5509 /* Various states of the input record separator SV (rs) */
5510 #define RsSNARF(sv) (! SvOK(sv))
5511 #define RsSIMPLE(sv) (SvOK(sv) && (! SvPOK(sv) || SvCUR(sv)))
5512 #define RsPARA(sv) (SvPOK(sv) && ! SvCUR(sv))
5513 #define RsRECORD(sv) (SvROK(sv) && (SvIV(SvRV(sv)) > 0))
5515 /* A struct for keeping various DEBUGGING related stuff,
5516 * neatly packed. Currently only scratch variables for
5517 * constructing debug output are included. Needed always,
5518 * not just when DEBUGGING, though, because of the re extension. c*/
5519 struct perl_debug_pad {
5523 #define PERL_DEBUG_PAD(i) &(PL_debug_pad.pad[i])
5524 #define PERL_DEBUG_PAD_ZERO(i) (SvPVX(PERL_DEBUG_PAD(i))[0] = 0, \
5525 (((XPV*) SvANY(PERL_DEBUG_PAD(i)))->xpv_cur = 0), \
5528 /* Enable variables which are pointers to functions */
5529 typedef void (*peep_t)(pTHX_ OP* o);
5530 typedef regexp* (*regcomp_t) (pTHX_ char* exp, char* xend, PMOP* pm);
5531 typedef I32 (*regexec_t) (pTHX_ regexp* prog, char* stringarg,
5532 char* strend, char* strbeg, I32 minend,
5533 SV* screamer, void* data, U32 flags);
5534 typedef char* (*re_intuit_start_t) (pTHX_ regexp *prog, SV *sv,
5535 char *strpos, char *strend,
5537 re_scream_pos_data *d);
5538 typedef SV* (*re_intuit_string_t) (pTHX_ regexp *prog);
5539 typedef void (*regfree_t) (pTHX_ struct regexp* r);
5540 typedef regexp* (*regdupe_t) (pTHX_ const regexp* r, CLONE_PARAMS *param);
5541 typedef I32 (*re_fold_t)(const char *, char const *, I32);
5543 typedef void (*DESTRUCTORFUNC_NOCONTEXT_t) (void*);
5544 typedef void (*DESTRUCTORFUNC_t) (pTHX_ void*);
5545 typedef void (*SVFUNC_t) (pTHX_ SV* const);
5546 typedef I32 (*SVCOMPARE_t) (pTHX_ SV* const, SV* const);
5547 typedef void (*XSINIT_t) (pTHX);
5548 typedef void (*ATEXIT_t) (pTHX_ void*);
5549 typedef void (*XSUBADDR_t) (pTHX_ CV *);
5551 typedef OP* (*Perl_ppaddr_t)(pTHX);
5552 typedef OP* (*Perl_check_t) (pTHX_ OP*);
5553 typedef void(*Perl_ophook_t)(pTHX_ OP*);
5554 typedef int (*Perl_keyword_plugin_t)(pTHX_ char*, STRLEN, OP**);
5555 typedef void(*Perl_cpeep_t)(pTHX_ OP *, OP *);
5557 typedef void(*globhook_t)(pTHX);
5559 #define KEYWORD_PLUGIN_DECLINE 0
5560 #define KEYWORD_PLUGIN_STMT 1
5561 #define KEYWORD_PLUGIN_EXPR 2
5563 /* Interpreter exitlist entry */
5564 typedef struct exitlistentry {
5565 void (*fn) (pTHX_ void*);
5567 } PerlExitListEntry;
5569 /* if you only have signal() and it resets on each signal, FAKE_PERSISTENT_SIGNAL_HANDLERS fixes */
5570 /* These have to be before perlvars.h */
5571 #if !defined(HAS_SIGACTION) && defined(VMS)
5572 # define FAKE_PERSISTENT_SIGNAL_HANDLERS
5574 /* if we're doing kill() with sys$sigprc on VMS, FAKE_DEFAULT_SIGNAL_HANDLERS */
5575 #if defined(KILL_BY_SIGPRC)
5576 # define FAKE_DEFAULT_SIGNAL_HANDLERS
5579 #if !defined(MULTIPLICITY)
5581 struct interpreter {
5587 /* If we have multiple interpreters define a struct
5588 holding variables which must be per-interpreter
5589 If we don't have threads anything that would have
5590 be per-thread is per-interpreter.
5593 /* Set up PERLVAR macros for populating structs */
5594 # define PERLVAR(prefix,var,type) type prefix##var;
5596 /* 'var' is an array of length 'n' */
5597 # define PERLVARA(prefix,var,n,type) type prefix##var[n];
5599 /* initialize 'var' to init' */
5600 # define PERLVARI(prefix,var,type,init) type prefix##var;
5602 /* like PERLVARI, but make 'var' a const */
5603 # define PERLVARIC(prefix,var,type,init) type prefix##var;
5605 struct interpreter {
5606 # include "intrpvar.h"
5609 EXTCONST U16 PL_interp_size
5610 INIT(sizeof(struct interpreter));
5612 # define PERL_INTERPRETER_SIZE_UPTO_MEMBER(member) \
5613 STRUCT_OFFSET(struct interpreter, member) + \
5614 sizeof(((struct interpreter*)0)->member)
5616 /* This will be useful for subsequent releases, because this has to be the
5617 same in your libperl as in main(), else you have a mismatch and must abort.
5619 EXTCONST U16 PL_interp_size_5_18_0
5620 INIT(PERL_INTERPRETER_SIZE_UPTO_MEMBER(PERL_LAST_5_18_0_INTERP_MEMBER));
5623 /* Done with PERLVAR macros for now ... */
5629 #endif /* MULTIPLICITY */
5631 struct tempsym; /* defined in pp_pack.c */
5638 #define PERL_CKDEF(s) PERL_CALLCONV OP *s (pTHX_ OP *o);
5639 #define PERL_PPDEF(s) PERL_CALLCONV OP *s (pTHX);
5642 # include "malloc_ctl.h"
5646 * This provides a layer of functions and macros to ensure extensions will
5647 * get to use the same RTL functions as the core.
5650 # include "win32iop.h"
5656 /* this has structure inits, so it cannot be included before here */
5659 /* The following must follow proto.h as #defines mess up syntax */
5661 #if !defined(PERL_FOR_X2P)
5662 # include "embedvar.h"
5665 /* Now include all the 'global' variables
5666 * If we don't have threads or multiple interpreters
5667 * these include variables that would have been their struct-s
5670 #define PERLVAR(prefix,var,type) EXT type PL_##var;
5671 #define PERLVARA(prefix,var,n,type) EXT type PL_##var[n];
5672 #define PERLVARI(prefix,var,type,init) EXT type PL_##var INIT(init);
5673 #define PERLVARIC(prefix,var,type,init) EXTCONST type PL_##var INIT(init);
5675 #if !defined(MULTIPLICITY)
5677 # include "intrpvar.h"
5679 # define PL_sv_yes (PL_sv_immortals[0])
5680 # define PL_sv_undef (PL_sv_immortals[1])
5681 # define PL_sv_no (PL_sv_immortals[2])
5682 # define PL_sv_zero (PL_sv_immortals[3])
5686 /* All core uses now exterminated. Ensure no zombies can return: */
5690 /* Now all the config stuff is setup we can include embed.h
5691 In particular, need the relevant *ish file included already, as it may
5692 define HAVE_INTERP_INTERN */
5697 # include "perlvars.h"
5706 #if !defined(MULTIPLICITY)
5707 /* Set up PERLVAR macros for populating structs */
5708 # define PERLVAR(prefix,var,type) type prefix##var;
5709 /* 'var' is an array of length 'n' */
5710 # define PERLVARA(prefix,var,n,type) type prefix##var[n];
5711 /* initialize 'var' to init' */
5712 # define PERLVARI(prefix,var,type,init) type prefix##var;
5713 /* like PERLVARI, but make 'var' a const */
5714 # define PERLVARIC(prefix,var,type,init) type prefix##var;
5716 /* this is never instantiated, is it just used for sizeof(struct PerlHandShakeInterpreter) */
5717 struct PerlHandShakeInterpreter {
5718 # include "intrpvar.h"
5728 /* dummy variables that hold pointers to both runops functions, thus forcing
5729 * them *both* to get linked in (useful for Peek.xs, debugging etc) */
5731 EXTCONST runops_proc_t PL_runops_std
5732 INIT(Perl_runops_standard);
5733 EXTCONST runops_proc_t PL_runops_dbg
5734 INIT(Perl_runops_debug);
5736 #define EXT_MGVTBL EXTCONST MGVTBL
5738 #define PERL_MAGIC_READONLY_ACCEPTABLE 0x40
5739 #define PERL_MAGIC_VALUE_MAGIC 0x80
5740 #define PERL_MAGIC_VTABLE_MASK 0x3F
5742 /* can this type of magic be attached to a readonly SV? */
5743 #define PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(t) \
5744 (PL_magic_data[(U8)(t)] & PERL_MAGIC_READONLY_ACCEPTABLE)
5746 /* Is this type of magic container magic (%ENV, $1 etc),
5747 * or value magic (pos, taint etc)?
5749 #define PERL_MAGIC_TYPE_IS_VALUE_MAGIC(t) \
5750 (PL_magic_data[(U8)(t)] & PERL_MAGIC_VALUE_MAGIC)
5752 #include "mg_vtable.h"
5755 EXTCONST U8 PL_magic_data[256] =
5757 # include "umg_data.h"
5759 # include "mg_data.h"
5763 EXTCONST U8 PL_magic_data[256];
5767 /* NL IV NV PV INV PI PN MG RX GV LV AV HV CV FM IO */
5769 PL_valid_types_IVX[] = { 0, 1, 0, 0, 0, 1, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5771 PL_valid_types_NVX[] = { 0, 0, 1, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5773 PL_valid_types_PVX[] = { 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1 };
5775 PL_valid_types_RV[] = { 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1 };
5777 PL_valid_types_IV_set[] = { 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1 };
5779 PL_valid_types_NV_set[] = { 0, 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0 };
5783 EXTCONST bool PL_valid_types_IVX[];
5784 EXTCONST bool PL_valid_types_NVX[];
5785 EXTCONST bool PL_valid_types_PVX[];
5786 EXTCONST bool PL_valid_types_RV[];
5787 EXTCONST bool PL_valid_types_IV_set[];
5788 EXTCONST bool PL_valid_types_NV_set[];
5792 /* In C99 we could use designated (named field) union initializers.
5793 * In C89 we need to initialize the member declared first.
5794 * In C++ we need extern C initializers.
5796 * With the U8_NV version you will want to have inner braces,
5797 * while with the NV_U8 use just the NV. */
5799 #define INFNAN_U8_NV_DECL EXTCONST union { U8 u8[NVSIZE]; NV nv; }
5800 #define INFNAN_NV_U8_DECL EXTCONST union { NV nv; U8 u8[NVSIZE]; }
5802 /* if these never got defined, they need defaults */
5803 #ifndef PERL_SET_CONTEXT
5804 # define PERL_SET_CONTEXT(i) PERL_SET_INTERP(i)
5807 #ifndef PERL_GET_CONTEXT
5808 # define PERL_GET_CONTEXT PERL_GET_INTERP
5811 #ifndef PERL_GET_THX
5812 # define PERL_GET_THX ((void*)NULL)
5815 #ifndef PERL_SET_THX
5816 # define PERL_SET_THX(t) NOOP
5821 /* The tables below are adapted from
5822 * https://bjoern.hoehrmann.de/utf-8/decoder/dfa/, which requires this copyright
5825 Copyright (c) 2008-2009 Bjoern Hoehrmann <bjoern@hoehrmann.de>
5827 Permission is hereby granted, free of charge, to any person obtaining a copy of
5828 this software and associated documentation files (the "Software"), to deal in
5829 the Software without restriction, including without limitation the rights to
5830 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
5831 of the Software, and to permit persons to whom the Software is furnished to do
5832 so, subject to the following conditions:
5834 The above copyright notice and this permission notice shall be included in all
5835 copies or substantial portions of the Software.
5837 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
5838 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
5839 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
5840 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
5841 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
5842 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
5848 # if 0 /* This is the original table given in
5849 https://bjoern.hoehrmann.de/utf-8/decoder/dfa/ */
5850 static U8 utf8d_C9[] = {
5851 /* The first part of the table maps bytes to character classes that
5852 * to reduce the size of the transition table and create bitmasks. */
5853 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*/
5854 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*/
5855 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*/
5856 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*/
5857 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*/
5858 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*/
5859 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*/
5860 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*/
5862 /* The second part is a transition table that maps a combination
5863 * of a state of the automaton and a character class to a state. */
5864 0,12,24,36,60,96,84,12,12,12,48,72, 12,12,12,12,12,12,12,12,12,12,12,12,
5865 12, 0,12,12,12,12,12, 0,12, 0,12,12, 12,24,12,12,12,12,12,24,12,24,12,12,
5866 12,12,12,12,12,12,12,24,12,12,12,12, 12,24,12,12,12,12,12,12,12,24,12,12,
5867 12,12,12,12,12,12,12,36,12,36,12,12, 12,36,12,12,12,12,12,36,12,36,12,12,
5868 12,36,12,12,12,12,12,12,12,12,12,12
5873 /* This is a version of the above table customized for Perl that doesn't
5874 * exclude surrogates and accepts start bytes up through FD (FE on 64-bit
5875 * machines). The classes have been renumbered so that the patterns are more
5876 * evident in the table. The class numbers for start bytes are constrained so
5877 * that they can be used as a shift count for masking off the leading one bits.
5878 * It would make the code simpler if start byte FF could also be handled, but
5879 * doing so would mean adding nodes for each of continuation bytes 6-12
5880 * remaining, and two more nodes for overlong detection (a total of 9), and
5881 * there is room only for 4 more nodes unless we make the array U16 instead of
5886 * 80-81 7 Not legal immediately after start bytes E0 F0 F8 FC
5888 * 82-83 8 Not legal immediately after start bytes E0 F0 F8 FC
5889 * 84-87 9 Not legal immediately after start bytes E0 F0 F8
5890 * 88-8F 10 Not legal immediately after start bytes E0 F0
5891 * 90-9F 11 Not legal immediately after start byte E0
5903 * FE 17 (or 1 on 32-bit machines, since it overflows)
5907 EXTCONST U8 PL_extended_utf8_dfa_tab[] = {
5908 /* The first part of the table maps bytes to character classes to reduce
5909 * the size of the transition table and create bitmasks. */
5910 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*00-0F*/
5911 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*10-1F*/
5912 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*20-2F*/
5913 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*30-3F*/
5914 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*40-4F*/
5915 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*50-5F*/
5916 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*60-6F*/
5917 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*70-7F*/
5918 7, 7, 8, 8, 9, 9, 9, 9,10,10,10,10,10,10,10,10, /*80-8F*/
5919 11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11, /*90-9F*/
5920 12,12,12,12,12,12,12,12,12,12,12,12,12,12,12,12, /*A0-AF*/
5921 12,12,12,12,12,12,12,12,12,12,12,12,12,12,12,12, /*B0-BF*/
5922 1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*C0-CF*/
5923 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*D0-DF*/
5924 13, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, /*E0-EF*/
5925 14, 4, 4, 4, 4, 4, 4, 4,15, 5, 5, 5,16, 6, /*F0-FD*/
5933 /* The second part is a transition table that maps a combination
5934 * of a state of the automaton and a character class to a new state, called a
5935 * node. The nodes are:
5936 * N0 The initial state, and final accepting one.
5937 * N1 Any one continuation byte (80-BF) left. This is transitioned to
5938 * immediately when the start byte indicates a two-byte sequence
5939 * N2 Any two continuation bytes left.
5940 * N3 Any three continuation bytes left.
5941 * N4 Any four continuation bytes left.
5942 * N5 Any five continuation bytes left.
5943 * N6 Start byte is E0. Continuation bytes 80-9F are illegal (overlong);
5944 * the other continuations transition to N1
5945 * N7 Start byte is F0. Continuation bytes 80-8F are illegal (overlong);
5946 * the other continuations transition to N2
5947 * N8 Start byte is F8. Continuation bytes 80-87 are illegal (overlong);
5948 * the other continuations transition to N3
5949 * N9 Start byte is FC. Continuation bytes 80-83 are illegal (overlong);
5950 * the other continuations transition to N4
5951 * N10 Start byte is FE. Continuation bytes 80-81 are illegal (overlong);
5952 * the other continuations transition to N5
5953 * 1 Reject. All transitions not mentioned above (except the single
5954 * byte ones (as they are always legal) are to this state.
5957 # if defined(PERL_CORE)
5958 # define NUM_CLASSES 18
5960 # define N1 ((N0) + NUM_CLASSES)
5961 # define N2 ((N1) + NUM_CLASSES)
5962 # define N3 ((N2) + NUM_CLASSES)
5963 # define N4 ((N3) + NUM_CLASSES)
5964 # define N5 ((N4) + NUM_CLASSES)
5965 # define N6 ((N5) + NUM_CLASSES)
5966 # define N7 ((N6) + NUM_CLASSES)
5967 # define N8 ((N7) + NUM_CLASSES)
5968 # define N9 ((N8) + NUM_CLASSES)
5969 # define N10 ((N9) + NUM_CLASSES)
5971 /*Class: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 */
5972 /*N0*/ 0, 1,N1,N2,N3,N4,N5, 1, 1, 1, 1, 1, 1,N6,N7,N8,N9,N10,
5973 /*N1*/ 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1,
5974 /*N2*/ 1, 1, 1, 1, 1, 1, 1,N1,N1,N1,N1,N1,N1, 1, 1, 1, 1, 1,
5975 /*N3*/ 1, 1, 1, 1, 1, 1, 1,N2,N2,N2,N2,N2,N2, 1, 1, 1, 1, 1,
5976 /*N4*/ 1, 1, 1, 1, 1, 1, 1,N3,N3,N3,N3,N3,N3, 1, 1, 1, 1, 1,
5977 /*N5*/ 1, 1, 1, 1, 1, 1, 1,N4,N4,N4,N4,N4,N4, 1, 1, 1, 1, 1,
5979 /*N6*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,N1, 1, 1, 1, 1, 1,
5980 /*N7*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,N2,N2, 1, 1, 1, 1, 1,
5981 /*N8*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,N3,N3,N3, 1, 1, 1, 1, 1,
5982 /*N9*/ 1, 1, 1, 1, 1, 1, 1, 1, 1,N4,N4,N4,N4, 1, 1, 1, 1, 1,
5983 /*N10*/ 1, 1, 1, 1, 1, 1, 1, 1,N5,N5,N5,N5,N5, 1, 1, 1, 1, 1,
5986 /* And below is a version of the above table that accepts only strict UTF-8.
5987 * Hence no surrogates nor non-characters, nor non-Unicode. Thus, if the input
5988 * passes this dfa, it will be for a well-formed, non-problematic code point
5989 * that can be returned immediately.
5991 * The "Implementation details" portion of
5992 * https://bjoern.hoehrmann.de/utf-8/decoder/dfa/ shows how
5993 * the first portion of the table maps each possible byte into a character
5994 * class. And that the classes for those bytes which are start bytes have been
5995 * carefully chosen so they serve as well to be used as a shift value to mask
5996 * off the leading 1 bits of the start byte. Unfortunately the addition of
5997 * being able to distinguish non-characters makes this not fully work. This is
5998 * because, now, the start bytes E1-EF have to be broken into 3 classes instead
6000 * 1) ED because it could be a surrogate
6001 * 2) EF because it could be a non-character
6002 * 3) the rest, which can never evaluate to a problematic code point.
6004 * Each of E1-EF has three leading 1 bits, then a 0. That means we could use a
6005 * shift (and hence class number) of either 3 or 4 to get a mask that works.
6006 * But that only allows two categories, and we need three. khw made the
6007 * decision to therefore treat the ED start byte as an error, so that the dfa
6008 * drops out immediately for that. In the dfa, classes 3 and 4 are used to
6009 * distinguish EF vs the rest. Then special code is used to deal with ED,
6010 * that's executed only when the dfa drops out. The code points started by ED
6011 * are half surrogates, and half hangul syllables. This means that 2048 of
6012 * the hangul syllables (about 18%) take longer than all other non-problematic
6013 * code points to handle.
6015 * The changes to handle non-characters requires the addition of states and
6016 * classes to the dfa. (See the section on "Mapping bytes to character
6017 * classes" in the linked-to document for further explanation of the original
6041 * F1-F3 6 (6 bits can be stripped)
6042 * F4 5 (only 5 can be stripped)
6046 EXTCONST U8 PL_strict_utf8_dfa_tab[] = {
6047 /* The first part of the table maps bytes to character classes to reduce
6048 * the size of the transition table and create bitmasks. */
6049 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*00-0F*/
6050 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*10-1F*/
6051 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*20-2F*/
6052 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*30-3F*/
6053 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*40-4F*/
6054 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*50-5F*/
6055 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*60-6F*/
6056 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*70-7F*/
6057 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9,10, /*80-8F*/
6058 11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,12, /*90-9F*/
6059 13,13,13,13,13,13,13,13,13,13,13,13,13,13,13,14, /*A0-AF*/
6060 15,15,15,15,15,15,15,16,15,15,15,15,15,15,17,18, /*B0-BF*/
6061 1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*C0-CF*/
6062 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*D0-DF*/
6063 7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 1, 3, 4, /*E0-EF*/
6064 8, 6, 6, 6, 5, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /*F0-FF*/
6066 /* The second part is a transition table that maps a combination
6067 * of a state of the automaton and a character class to a new state, called a
6068 * node. The nodes are:
6069 * N0 The initial state, and final accepting one.
6070 * N1 Any one continuation byte (80-BF) left. This is transitioned to
6071 * immediately when the start byte indicates a two-byte sequence
6072 * N2 Any two continuation bytes left.
6073 * N3 Start byte is E0. Continuation bytes 80-9F are illegal (overlong);
6074 * the other continuations transition to state N1
6075 * N4 Start byte is EF. Continuation byte B7 transitions to N8; BF to N9;
6076 * the other continuations transitions to N1
6077 * N5 Start byte is F0. Continuation bytes 80-8F are illegal (overlong);
6078 * [9AB]F transition to N10; the other continuations to N2.
6079 * N6 Start byte is F[123]. Continuation bytes [89AB]F transition
6080 * to N10; the other continuations to N2.
6081 * N7 Start byte is F4. Continuation bytes 90-BF are illegal
6082 * (non-unicode); 8F transitions to N10; the other continuations to N2
6083 * N8 Initial sequence is EF B7. Continuation bytes 90-AF are illegal
6084 * (non-characters); the other continuations transition to N0.
6085 * N9 Initial sequence is EF BF. Continuation bytes BE and BF are illegal
6086 * (non-characters); the other continuations transition to N0.
6087 * N10 Initial sequence is one of: F0 [9-B]F; F[123] [8-B]F; or F4 8F.
6088 * Continuation byte BF transitions to N11; the other continuations to
6090 * N11 Initial sequence is the two bytes given in N10 followed by BF.
6091 * Continuation bytes BE and BF are illegal (non-characters); the other
6092 * continuations transition to N0.
6093 * 1 Reject. All transitions not mentioned above (except the single
6094 * byte ones (as they are always legal) are to this state.
6108 # define NUM_CLASSES 19
6110 # define N1 ((N0) + NUM_CLASSES)
6111 # define N2 ((N1) + NUM_CLASSES)
6112 # define N3 ((N2) + NUM_CLASSES)
6113 # define N4 ((N3) + NUM_CLASSES)
6114 # define N5 ((N4) + NUM_CLASSES)
6115 # define N6 ((N5) + NUM_CLASSES)
6116 # define N7 ((N6) + NUM_CLASSES)
6117 # define N8 ((N7) + NUM_CLASSES)
6118 # define N9 ((N8) + NUM_CLASSES)
6119 # define N10 ((N9) + NUM_CLASSES)
6120 # define N11 ((N10) + NUM_CLASSES)
6122 /*Class: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 */
6123 /*N0*/ 0, 1, N1, N2, N4, N7, N6, N3, N5, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
6124 /*N1*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6125 /*N2*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N1, N1, N1, N1, N1, N1, N1, N1, N1, N1,
6127 /*N3*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, N1, N1, N1, N1, N1, N1,
6128 /*N4*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N1, N1, N1, N1, N1, N1, N1, N8, N1, N9,
6129 /*N5*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, N2,N10, N2,N10, N2, N2, N2,N10,
6130 /*N6*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N2,N10, N2,N10, N2,N10, N2, N2, N2,N10,
6131 /*N7*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N2,N10, 1, 1, 1, 1, 1, 1, 1, 1,
6132 /*N8*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0,
6133 /*N9*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1,
6134 /*N10*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N1, N1, N1, N1, N1, N1, N1, N1, N1,N11,
6135 /*N11*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1,
6138 /* And below is yet another version of the above tables that accepts only UTF-8
6139 * as defined by Corregidum #9. Hence no surrogates nor non-Unicode, but
6140 * it allows non-characters. This is isomorphic to the original table
6141 * in https://bjoern.hoehrmann.de/utf-8/decoder/dfa/
6155 * F1-F3 6 (6 bits can be stripped)
6156 * F4 5 (only 5 can be stripped)
6160 EXTCONST U8 PL_c9_utf8_dfa_tab[] = {
6161 /* The first part of the table maps bytes to character classes to reduce
6162 * the size of the transition table and create bitmasks. */
6163 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*00-0F*/
6164 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*10-1F*/
6165 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*20-2F*/
6166 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*30-3F*/
6167 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*40-4F*/
6168 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*50-5F*/
6169 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*60-6F*/
6170 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*70-7F*/
6171 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, /*80-8F*/
6172 10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10, /*90-9F*/
6173 11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11, /*A0-AF*/
6174 11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11, /*B0-BF*/
6175 1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*C0-CF*/
6176 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*D0-DF*/
6177 7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 4, 3, 3, /*E0-EF*/
6178 8, 6, 6, 6, 5, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /*F0-FF*/
6180 /* The second part is a transition table that maps a combination
6181 * of a state of the automaton and a character class to a new state, called a
6182 * node. The nodes are:
6183 * N0 The initial state, and final accepting one.
6184 * N1 Any one continuation byte (80-BF) left. This is transitioned to
6185 * immediately when the start byte indicates a two-byte sequence
6186 * N2 Any two continuation bytes left.
6187 * N3 Any three continuation bytes left.
6188 * N4 Start byte is E0. Continuation bytes 80-9F are illegal (overlong);
6189 * the other continuations transition to state N1
6190 * N5 Start byte is ED. Continuation bytes A0-BF all lead to surrogates,
6191 * so are illegal. The other continuations transition to state N1.
6192 * N6 Start byte is F0. Continuation bytes 80-8F are illegal (overlong);
6193 * the other continuations transition to N2
6194 * N7 Start byte is F4. Continuation bytes 90-BF are illegal
6195 * (non-unicode); the other continuations transition to N2
6196 * 1 Reject. All transitions not mentioned above (except the single
6197 * byte ones (as they are always legal) are to this state.
6209 # define NUM_CLASSES 12
6211 # define N1 ((N0) + NUM_CLASSES)
6212 # define N2 ((N1) + NUM_CLASSES)
6213 # define N3 ((N2) + NUM_CLASSES)
6214 # define N4 ((N3) + NUM_CLASSES)
6215 # define N5 ((N4) + NUM_CLASSES)
6216 # define N6 ((N5) + NUM_CLASSES)
6217 # define N7 ((N6) + NUM_CLASSES)
6219 /*Class: 0 1 2 3 4 5 6 7 8 9 10 11 */
6220 /*N0*/ 0, 1, N1, N2, N5, N7, N3, N4, N6, 1, 1, 1,
6221 /*N1*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0,
6222 /*N2*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N1, N1, N1,
6223 /*N3*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N2, N2, N2,
6225 /*N4*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, N1,
6226 /*N5*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N1, N1, 1,
6227 /*N6*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, N2, N2,
6228 /*N7*/ 1, 1, 1, 1, 1, 1, 1, 1, 1, N2, 1, 1,
6231 # endif /* defined(PERL_CORE) */
6232 # else /* End of is DOINIT */
6234 EXTCONST U8 PL_extended_utf8_dfa_tab[];
6235 EXTCONST U8 PL_strict_utf8_dfa_tab[];
6236 EXTCONST U8 PL_c9_utf8_dfa_tab[];
6239 #endif /* end of isn't EBCDIC */
6241 #include "overload.h"
6250 CV* table[NofAMmeth];
6252 struct am_table_short {
6258 typedef struct am_table AMT;
6259 typedef struct am_table_short AMTS;
6261 #define AMGfallNEVER 1
6263 #define AMGfallYES 3
6265 #define AMTf_AMAGIC 1
6266 #define AMT_AMAGIC(amt) ((amt)->flags & AMTf_AMAGIC)
6267 #define AMT_AMAGIC_on(amt) ((amt)->flags |= AMTf_AMAGIC)
6268 #define AMT_AMAGIC_off(amt) ((amt)->flags &= ~AMTf_AMAGIC)
6270 #define StashHANDLER(stash,meth) gv_handler((stash),CAT2(meth,_amg))
6273 * some compilers like to redefine cos et alia as faster
6274 * (and less accurate?) versions called F_cos et cetera (Quidquid
6275 * latine dictum sit, altum viditur.) This trick collides with
6276 * the Perl overloading (amg). The following #defines fool both.
6281 # define F_atan2_amg atan2_amg
6284 # define F_cos_amg cos_amg
6287 # define F_exp_amg exp_amg
6290 # define F_log_amg log_amg
6293 # define F_pow_amg pow_amg
6296 # define F_sin_amg sin_amg
6299 # define F_sqrt_amg sqrt_amg
6301 #endif /* _FASTMATH */
6303 #define PERLDB_ALL (PERLDBf_SUB | PERLDBf_LINE | \
6304 PERLDBf_NOOPT | PERLDBf_INTER | \
6305 PERLDBf_SUBLINE| PERLDBf_SINGLE| \
6306 PERLDBf_NAMEEVAL| PERLDBf_NAMEANON | \
6308 /* No _NONAME, _GOTO */
6309 #define PERLDBf_SUB 0x01 /* Debug sub enter/exit */
6310 #define PERLDBf_LINE 0x02 /* Keep line # */
6311 #define PERLDBf_NOOPT 0x04 /* Switch off optimizations */
6312 #define PERLDBf_INTER 0x08 /* Preserve more data for
6313 later inspections */
6314 #define PERLDBf_SUBLINE 0x10 /* Keep subr source lines */
6315 #define PERLDBf_SINGLE 0x20 /* Start with single-step on */
6316 #define PERLDBf_NONAME 0x40 /* For _SUB: no name of the subr */
6317 #define PERLDBf_GOTO 0x80 /* Report goto: call DB::goto */
6318 #define PERLDBf_NAMEEVAL 0x100 /* Informative names for evals */
6319 #define PERLDBf_NAMEANON 0x200 /* Informative names for anon subs */
6320 #define PERLDBf_SAVESRC 0x400 /* Save source lines into @{"_<$filename"} */
6321 #define PERLDBf_SAVESRC_NOSUBS 0x800 /* Including evals that generate no subroutines */
6322 #define PERLDBf_SAVESRC_INVALID 0x1000 /* Save source that did not compile */
6324 #define PERLDB_SUB (PL_perldb & PERLDBf_SUB)
6325 #define PERLDB_LINE (PL_perldb & PERLDBf_LINE)
6326 #define PERLDB_NOOPT (PL_perldb & PERLDBf_NOOPT)
6327 #define PERLDB_INTER (PL_perldb & PERLDBf_INTER)
6328 #define PERLDB_SUBLINE (PL_perldb & PERLDBf_SUBLINE)
6329 #define PERLDB_SINGLE (PL_perldb & PERLDBf_SINGLE)
6330 #define PERLDB_SUB_NN (PL_perldb & PERLDBf_NONAME)
6331 #define PERLDB_GOTO (PL_perldb & PERLDBf_GOTO)
6332 #define PERLDB_NAMEEVAL (PL_perldb & PERLDBf_NAMEEVAL)
6333 #define PERLDB_NAMEANON (PL_perldb & PERLDBf_NAMEANON)
6334 #define PERLDB_SAVESRC (PL_perldb & PERLDBf_SAVESRC)
6335 #define PERLDB_SAVESRC_NOSUBS (PL_perldb & PERLDBf_SAVESRC_NOSUBS)
6336 #define PERLDB_SAVESRC_INVALID (PL_perldb & PERLDBf_SAVESRC_INVALID)
6338 #define PERLDB_LINE_OR_SAVESRC (PL_perldb & (PERLDBf_LINE | PERLDBf_SAVESRC))
6341 # define KEYWORD_PLUGIN_MUTEX_INIT MUTEX_INIT(&PL_keyword_plugin_mutex)
6342 # define KEYWORD_PLUGIN_MUTEX_LOCK MUTEX_LOCK(&PL_keyword_plugin_mutex)
6343 # define KEYWORD_PLUGIN_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_keyword_plugin_mutex)
6344 # define KEYWORD_PLUGIN_MUTEX_TERM MUTEX_DESTROY(&PL_keyword_plugin_mutex)
6345 # define USER_PROP_MUTEX_INIT MUTEX_INIT(&PL_user_prop_mutex)
6346 # define USER_PROP_MUTEX_LOCK MUTEX_LOCK(&PL_user_prop_mutex)
6347 # define USER_PROP_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_user_prop_mutex)
6348 # define USER_PROP_MUTEX_TERM MUTEX_DESTROY(&PL_user_prop_mutex)
6350 # define KEYWORD_PLUGIN_MUTEX_INIT NOOP
6351 # define KEYWORD_PLUGIN_MUTEX_LOCK NOOP
6352 # define KEYWORD_PLUGIN_MUTEX_UNLOCK NOOP
6353 # define KEYWORD_PLUGIN_MUTEX_TERM NOOP
6354 # define USER_PROP_MUTEX_INIT NOOP
6355 # define USER_PROP_MUTEX_LOCK NOOP
6356 # define USER_PROP_MUTEX_UNLOCK NOOP
6357 # define USER_PROP_MUTEX_TERM NOOP
6360 #ifdef USE_LOCALE /* These locale things are all subject to change */
6362 /* Returns TRUE if the plain locale pragma without a parameter is in effect.
6364 # define IN_LOCALE_RUNTIME (PL_curcop \
6365 && CopHINTS_get(PL_curcop) & HINT_LOCALE)
6367 /* Returns TRUE if either form of the locale pragma is in effect */
6368 # define IN_SOME_LOCALE_FORM_RUNTIME \
6369 cBOOL(CopHINTS_get(PL_curcop) & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
6371 # define IN_LOCALE_COMPILETIME cBOOL(PL_hints & HINT_LOCALE)
6372 # define IN_SOME_LOCALE_FORM_COMPILETIME \
6373 cBOOL(PL_hints & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
6376 =for apidoc_section $locale
6378 =for apidoc Amn|bool|IN_LOCALE
6380 Evaluates to TRUE if the plain locale pragma without a parameter (S<C<use
6381 locale>>) is in effect.
6383 =for apidoc Amn|bool|IN_LOCALE_COMPILETIME
6385 Evaluates to TRUE if, when compiling a perl program (including an C<eval>) if
6386 the plain locale pragma without a parameter (S<C<use locale>>) is in effect.
6388 =for apidoc Amn|bool|IN_LOCALE_RUNTIME
6390 Evaluates to TRUE if, when executing a perl program (including an C<eval>) if
6391 the plain locale pragma without a parameter (S<C<use locale>>) is in effect.
6396 # define IN_LOCALE \
6397 (IN_PERL_COMPILETIME ? IN_LOCALE_COMPILETIME : IN_LOCALE_RUNTIME)
6398 # define IN_SOME_LOCALE_FORM \
6399 (IN_PERL_COMPILETIME ? IN_SOME_LOCALE_FORM_COMPILETIME \
6400 : IN_SOME_LOCALE_FORM_RUNTIME)
6402 # define IN_LC_ALL_COMPILETIME IN_LOCALE_COMPILETIME
6403 # define IN_LC_ALL_RUNTIME IN_LOCALE_RUNTIME
6405 # define IN_LC_PARTIAL_COMPILETIME cBOOL(PL_hints & HINT_LOCALE_PARTIAL)
6406 # define IN_LC_PARTIAL_RUNTIME \
6407 (PL_curcop && CopHINTS_get(PL_curcop) & HINT_LOCALE_PARTIAL)
6409 # define IN_LC_COMPILETIME(category) \
6410 ( IN_LC_ALL_COMPILETIME \
6411 || ( IN_LC_PARTIAL_COMPILETIME \
6412 && Perl__is_in_locale_category(aTHX_ TRUE, (category))))
6413 # define IN_LC_RUNTIME(category) \
6414 (IN_LC_ALL_RUNTIME || (IN_LC_PARTIAL_RUNTIME \
6415 && Perl__is_in_locale_category(aTHX_ FALSE, (category))))
6416 # define IN_LC(category) \
6417 (IN_LC_COMPILETIME(category) || IN_LC_RUNTIME(category))
6419 # if defined (PERL_CORE) || defined (PERL_IN_XSUB_RE)
6421 /* This internal macro should be called from places that operate under
6422 * locale rules. If there is a problem with the current locale that
6423 * hasn't been raised yet, it will output a warning this time. Because
6424 * this will so rarely be true, there is no point to optimize for time;
6425 * instead it makes sense to minimize space used and do all the work in
6426 * the rarely called function */
6427 # ifdef USE_LOCALE_CTYPE
6428 # define _CHECK_AND_WARN_PROBLEMATIC_LOCALE \
6430 if (UNLIKELY(PL_warn_locale)) { \
6431 Perl__warn_problematic_locale(); \
6435 # define _CHECK_AND_WARN_PROBLEMATIC_LOCALE
6439 /* These two internal macros are called when a warning should be raised,
6440 * and will do so if enabled. The first takes a single code point
6441 * argument; the 2nd, is a pointer to the first byte of the UTF-8 encoded
6442 * string, and an end position which it won't try to read past */
6443 # define _CHECK_AND_OUTPUT_WIDE_LOCALE_CP_MSG(cp) \
6445 if (! PL_in_utf8_CTYPE_locale && ckWARN(WARN_LOCALE)) { \
6446 Perl_warner(aTHX_ packWARN(WARN_LOCALE), \
6447 "Wide character (U+%" UVXf ") in %s",\
6448 (UV) cp, OP_DESC(PL_op)); \
6452 # define _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(s, send) \
6453 STMT_START { /* Check if to warn before doing the conversion work */\
6454 if (! PL_in_utf8_CTYPE_locale && ckWARN(WARN_LOCALE)) { \
6455 UV cp = utf8_to_uvchr_buf((U8 *) (s), (U8 *) (send), NULL); \
6456 Perl_warner(aTHX_ packWARN(WARN_LOCALE), \
6457 "Wide character (U+%" UVXf ") in %s", \
6459 ? UNICODE_REPLACEMENT \
6465 # endif /* PERL_CORE or PERL_IN_XSUB_RE */
6466 #else /* No locale usage */
6467 # define IN_LOCALE_RUNTIME 0
6468 # define IN_SOME_LOCALE_FORM_RUNTIME 0
6469 # define IN_LOCALE_COMPILETIME 0
6470 # define IN_SOME_LOCALE_FORM_COMPILETIME 0
6471 # define IN_LOCALE 0
6472 # define IN_SOME_LOCALE_FORM 0
6473 # define IN_LC_ALL_COMPILETIME 0
6474 # define IN_LC_ALL_RUNTIME 0
6475 # define IN_LC_PARTIAL_COMPILETIME 0
6476 # define IN_LC_PARTIAL_RUNTIME 0
6477 # define IN_LC_COMPILETIME(category) 0
6478 # define IN_LC_RUNTIME(category) 0
6479 # define IN_LC(category) 0
6480 # define _CHECK_AND_WARN_PROBLEMATIC_LOCALE
6481 # define _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(s, send)
6482 # define _CHECK_AND_OUTPUT_WIDE_LOCALE_CP_MSG(c)
6486 /* Locale/thread synchronization macros. */
6487 #if ! ( defined(USE_LOCALE) \
6488 && defined(USE_ITHREADS) \
6489 && ( ! defined(USE_THREAD_SAFE_LOCALE) \
6490 || ( defined(HAS_LOCALECONV) \
6491 && ( ! defined(HAS_LOCALECONV_L) \
6492 || defined(TS_W32_BROKEN_LOCALECONV))) \
6493 || ( defined(HAS_NL_LANGINFO) \
6494 && ! defined(HAS_THREAD_SAFE_NL_LANGINFO_L)) \
6495 || (defined(HAS_MBLEN) && ! defined(HAS_MBRLEN)) \
6496 || (defined(HAS_MBTOWC) && ! defined(HAS_MBRTOWC)) \
6497 || (defined(HAS_WCTOMB) && ! defined(HAS_WCRTOMB))))
6499 /* The whole expression just above was complemented, so here we have no need
6500 * for thread synchronization, most likely it would be that this isn't a
6501 * threaded build. */
6502 # define LOCALE_INIT
6503 # define LOCALE_TERM
6504 # define LC_NUMERIC_LOCK(cond) NOOP
6505 # define LC_NUMERIC_UNLOCK NOOP
6506 # define LOCALECONV_LOCK NOOP
6507 # define LOCALECONV_UNLOCK NOOP
6508 # define LOCALE_READ_LOCK NOOP
6509 # define LOCALE_READ_UNLOCK NOOP
6510 # define MBLEN_LOCK NOOP
6511 # define MBLEN_UNLOCK NOOP
6512 # define MBTOWC_LOCK NOOP
6513 # define MBTOWC_UNLOCK NOOP
6514 # define NL_LANGINFO_LOCK NOOP
6515 # define NL_LANGINFO_UNLOCK NOOP
6516 # define SETLOCALE_LOCK NOOP
6517 # define SETLOCALE_UNLOCK NOOP
6518 # define WCTOMB_LOCK NOOP
6519 # define WCTOMB_UNLOCK NOOP
6522 /* Here, we will need critical sections in locale handling, because one or
6523 * more of the above conditions are true. This could be because the
6524 * platform doesn't have thread-safe locales, or that at least one of the
6525 * locale-dependent functions in the core isn't thread-safe. The latter
6526 * case is generally because they return a pointer to a static buffer, which
6527 * may be per-process instead of per-thread. There are supposedly
6528 * re-entrant, safe versions for all of them Perl currently uses (which the
6529 * #if above checks for), but most platforms don't have all the needed ones
6530 * available, and the Posix standard doesn't require nl_langinfo_l() to be
6531 * fully thread-safe, so a Configure probe was written. localeconv_l() is
6532 * uncommon, and judging by bug reports on the web, some earlier library
6533 * localeconv_l versions were broken, so perhaps a probe is in order for
6534 * that, but it would be a pain to write.
6536 * On non-thread-safe systems, some of the above functions are vulnerable to
6537 * races should another thread get control and change the locale in the
6538 * middle of their execution.
6540 * We currently use a single mutex for all these cases. This solves both
6541 * the problem of another thread changing the locale, and the buffer being
6542 * overwritten (the code copies the results to a safe place before releasing
6543 * the mutex). Ideally, for locale thread-safe platforms where the only
6544 * issue is another thread clobbering the function's static buffer, there
6545 * would be a separate mutex for each such buffer. Otherwise, things get
6546 * locked that don't need to. But, it is not expected that any of these
6547 * will be called frequently, and the locked interval should be short, and
6548 * modern platforms will have reentrant versions (which don't lock) for
6549 * almost all of them, so khw thinks a single mutex should suffice. */
6550 # define LOCALE_LOCK_ \
6552 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6553 "%s: %d: locking locale\n", __FILE__, __LINE__)); \
6554 MUTEX_LOCK(&PL_locale_mutex); \
6556 # define LOCALE_UNLOCK_ \
6558 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6559 "%s: %d: unlocking locale\n", __FILE__, __LINE__)); \
6560 MUTEX_UNLOCK(&PL_locale_mutex); \
6563 /* We do define a different macro for each case; then if we want to have
6564 * separate mutexes for some of them, the only changes needed are here.
6565 * Define just the necessary macros. The compiler should then croak if the
6566 * #ifdef's in the code are incorrect */
6567 # if defined(HAS_LOCALECONV) && ( ! defined(HAS_POSIX_2008_LOCALE) \
6568 || ! defined(HAS_LOCALECONV_L) \
6569 || defined(TS_W32_BROKEN_LOCALECONV))
6570 # define LOCALECONV_LOCK LOCALE_LOCK_
6571 # define LOCALECONV_UNLOCK LOCALE_UNLOCK_
6573 # if defined(HAS_NL_LANGINFO) && ( ! defined(HAS_THREAD_SAFE_NL_LANGINFO_L) \
6574 || ! defined(HAS_POSIX_2008_LOCALE))
6575 # define NL_LANGINFO_LOCK LOCALE_LOCK_
6576 # define NL_LANGINFO_UNLOCK LOCALE_UNLOCK_
6578 # if defined(HAS_MBLEN) && ! defined(HAS_MBRLEN)
6579 # define MBLEN_LOCK LOCALE_LOCK_
6580 # define MBLEN_UNLOCK LOCALE_UNLOCK_
6582 # if defined(HAS_MBTOWC) && ! defined(HAS_MBRTOWC)
6583 # define MBTOWC_LOCK LOCALE_LOCK_
6584 # define MBTOWC_UNLOCK LOCALE_UNLOCK_
6586 # if defined(HAS_WCTOMB) && ! defined(HAS_WCRTOMB)
6587 # define WCTOMB_LOCK LOCALE_LOCK_
6588 # define WCTOMB_UNLOCK LOCALE_UNLOCK_
6590 # if defined(USE_THREAD_SAFE_LOCALE)
6591 /* On locale thread-safe systems, we don't need these workarounds */
6592 # define LOCALE_TERM_LC_NUMERIC_ NOOP
6593 # define LOCALE_INIT_LC_NUMERIC_ NOOP
6594 # define LC_NUMERIC_LOCK(cond) NOOP
6595 # define LC_NUMERIC_UNLOCK NOOP
6596 # define LOCALE_INIT_LC_NUMERIC_ NOOP
6597 # define LOCALE_TERM_LC_NUMERIC_ NOOP
6599 /* There may be instance core where we this is invoked yet should do
6600 * nothing. Rather than have #ifdef's around them, define it here */
6601 # define SETLOCALE_LOCK NOOP
6602 # define SETLOCALE_UNLOCK NOOP
6604 # define SETLOCALE_LOCK LOCALE_LOCK_
6605 # define SETLOCALE_UNLOCK LOCALE_UNLOCK_
6607 /* On platforms without per-thread locales, when another thread can switch
6608 * our locale, we need another mutex to create critical sections where we
6609 * want the LC_NUMERIC locale to be locked into either the C (standard)
6610 * locale, or the underlying locale, so that other threads interrupting
6611 * this one don't change it to the wrong state before we've had a chance to
6612 * complete our operation. It can stay locked over an entire printf
6613 * operation, for example. And so is made distinct from the LOCALE_LOCK
6616 * This simulates kind of a general semaphore. The current thread will
6617 * lock the mutex if the per-thread variable is zero, and then increments
6618 * that variable. Each corresponding UNLOCK decrements the variable until
6619 * it is 0, at which point it actually unlocks the mutex. Since the
6620 * variable is per-thread, there is no race with other threads.
6622 * The single argument is a condition to test for, and if true, to panic,
6623 * as this would be an attempt to complement the LC_NUMERIC state, and
6624 * we're not supposed to because it's locked.
6626 * Clang improperly gives warnings for this, if not silenced:
6627 * https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#conditional-locks
6629 * If LC_NUMERIC_LOCK is combined with one of the LOCKs above, calls to
6630 * that and its corresponding unlock should be contained entirely within
6631 * the locked portion of LC_NUMERIC. Those mutexes should be used only in
6632 * very short sections of code, while LC_NUMERIC_LOCK may span more
6633 * operations. By always following this convention, deadlock should be
6634 * impossible. But if necessary, the two mutexes could be combined. */
6635 # define LC_NUMERIC_LOCK(cond_to_panic_if_already_locked) \
6636 CLANG_DIAG_IGNORE(-Wthread-safety) \
6638 if (PL_lc_numeric_mutex_depth <= 0) { \
6639 MUTEX_LOCK(&PL_lc_numeric_mutex); \
6640 PL_lc_numeric_mutex_depth = 1; \
6641 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6642 "%s: %d: locking lc_numeric; depth=1\n", \
6643 __FILE__, __LINE__)); \
6646 PL_lc_numeric_mutex_depth++; \
6647 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6648 "%s: %d: avoided lc_numeric_lock; new depth=%d\n", \
6649 __FILE__, __LINE__, PL_lc_numeric_mutex_depth)); \
6650 if (cond_to_panic_if_already_locked) { \
6651 Perl_croak_nocontext("panic: %s: %d: Trying to change" \
6652 " LC_NUMERIC incompatibly", \
6653 __FILE__, __LINE__); \
6658 # define LC_NUMERIC_UNLOCK \
6660 if (PL_lc_numeric_mutex_depth <= 1) { \
6661 MUTEX_UNLOCK(&PL_lc_numeric_mutex); \
6662 PL_lc_numeric_mutex_depth = 0; \
6663 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6664 "%s: %d: unlocking lc_numeric; depth=0\n", \
6665 __FILE__, __LINE__)); \
6668 PL_lc_numeric_mutex_depth--; \
6669 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6670 "%s: %d: avoided lc_numeric_unlock; new depth=%d\n",\
6671 __FILE__, __LINE__, PL_lc_numeric_mutex_depth)); \
6676 # define LOCALE_INIT_LC_NUMERIC_ MUTEX_INIT(&PL_lc_numeric_mutex)
6677 # define LOCALE_TERM_LC_NUMERIC_ MUTEX_DESTROY(&PL_lc_numeric_mutex)
6680 # ifdef USE_POSIX_2008_LOCALE
6681 /* We have a locale object holding the 'C' locale for Posix 2008 */
6682 # define LOCALE_TERM_POSIX_2008_ \
6684 if (PL_C_locale_obj) { \
6685 /* Make sure we aren't using the locale \
6686 * space we are about to free */ \
6687 uselocale(LC_GLOBAL_LOCALE); \
6688 freelocale(PL_C_locale_obj); \
6689 PL_C_locale_obj = (locale_t) NULL; \
6693 # define LOCALE_TERM_POSIX_2008_ NOOP
6696 # define LOCALE_INIT STMT_START { \
6697 MUTEX_INIT(&PL_locale_mutex); \
6698 LOCALE_INIT_LC_NUMERIC_; \
6701 # define LOCALE_TERM STMT_START { \
6702 MUTEX_DESTROY(&PL_locale_mutex); \
6703 LOCALE_TERM_LC_NUMERIC_; \
6704 LOCALE_TERM_POSIX_2008_; \
6708 #ifdef USE_LOCALE_NUMERIC
6710 /* These macros are for toggling between the underlying locale (UNDERLYING or
6711 * LOCAL) and the C locale (STANDARD). (Actually we don't have to use the C
6712 * locale if the underlying locale is indistinguishable from it in the numeric
6713 * operations used by Perl, namely the decimal point, and even the thousands
6716 =for apidoc_section $locale
6718 =for apidoc Amn|void|DECLARATION_FOR_LC_NUMERIC_MANIPULATION
6720 This macro should be used as a statement. It declares a private variable
6721 (whose name begins with an underscore) that is needed by the other macros in
6722 this section. Failing to include this correctly should lead to a syntax error.
6723 For compatibility with C89 C compilers it should be placed in a block before
6724 any executable statements.
6726 =for apidoc Am|void|STORE_LC_NUMERIC_FORCE_TO_UNDERLYING
6728 This is used by XS code that is C<LC_NUMERIC> locale-aware to force the
6729 locale for category C<LC_NUMERIC> to be what perl thinks is the current
6730 underlying locale. (The perl interpreter could be wrong about what the
6731 underlying locale actually is if some C or XS code has called the C library
6732 function L<setlocale(3)> behind its back; calling L</sync_locale> before calling
6733 this macro will update perl's records.)
6735 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
6736 declare at compile time a private variable used by this macro. This macro
6737 should be called as a single statement, not an expression, but with an empty
6738 argument list, like this:
6741 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6743 STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
6745 RESTORE_LC_NUMERIC();
6749 The private variable is used to save the current locale state, so
6750 that the requisite matching call to L</RESTORE_LC_NUMERIC> can restore it.
6752 On threaded perls not operating with thread-safe functionality, this macro uses
6753 a mutex to force a critical section. Therefore the matching RESTORE should be
6754 close by, and guaranteed to be called.
6756 =for apidoc Am|void|STORE_LC_NUMERIC_SET_TO_NEEDED
6758 This is used to help wrap XS or C code that is C<LC_NUMERIC> locale-aware.
6759 This locale category is generally kept set to a locale where the decimal radix
6760 character is a dot, and the separator between groups of digits is empty. This
6761 is because most XS code that reads floating point numbers is expecting them to
6764 This macro makes sure the current C<LC_NUMERIC> state is set properly, to be
6765 aware of locale if the call to the XS or C code from the Perl program is
6766 from within the scope of a S<C<use locale>>; or to ignore locale if the call is
6767 instead from outside such scope.
6769 This macro is the start of wrapping the C or XS code; the wrap ending is done
6770 by calling the L</RESTORE_LC_NUMERIC> macro after the operation. Otherwise
6771 the state can be changed that will adversely affect other XS code.
6773 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
6774 declare at compile time a private variable used by this macro. This macro
6775 should be called as a single statement, not an expression, but with an empty
6776 argument list, like this:
6779 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6781 STORE_LC_NUMERIC_SET_TO_NEEDED();
6783 RESTORE_LC_NUMERIC();
6787 On threaded perls not operating with thread-safe functionality, this macro uses
6788 a mutex to force a critical section. Therefore the matching RESTORE should be
6789 close by, and guaranteed to be called; see L</WITH_LC_NUMERIC_SET_TO_NEEDED>
6790 for a more contained way to ensure that.
6792 =for apidoc Am|void|STORE_LC_NUMERIC_SET_TO_NEEDED_IN|bool in_lc_numeric
6794 Same as L</STORE_LC_NUMERIC_SET_TO_NEEDED> with in_lc_numeric provided
6795 as the precalculated value of C<IN_LC(LC_NUMERIC)>. It is the caller's
6796 responsibility to ensure that the status of C<PL_compiling> and C<PL_hints>
6797 cannot have changed since the precalculation.
6799 =for apidoc Am|void|RESTORE_LC_NUMERIC
6801 This is used in conjunction with one of the macros
6802 L</STORE_LC_NUMERIC_SET_TO_NEEDED>
6803 and L</STORE_LC_NUMERIC_FORCE_TO_UNDERLYING> to properly restore the
6804 C<LC_NUMERIC> state.
6806 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
6807 declare at compile time a private variable used by this macro and the two
6808 C<STORE> ones. This macro should be called as a single statement, not an
6809 expression, but with an empty argument list, like this:
6812 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6814 RESTORE_LC_NUMERIC();
6818 =for apidoc Am|void|WITH_LC_NUMERIC_SET_TO_NEEDED|block
6820 This macro invokes the supplied statement or block within the context
6821 of a L</STORE_LC_NUMERIC_SET_TO_NEEDED> .. L</RESTORE_LC_NUMERIC> pair
6824 WITH_LC_NUMERIC_SET_TO_NEEDED(
6825 SNPRINTF_G(fv, ebuf, sizeof(ebuf), precis)
6831 #ifdef USE_LOCALE_NUMERIC
6832 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6833 STORE_LC_NUMERIC_SET_TO_NEEDED();
6835 SNPRINTF_G(fv, ebuf, sizeof(ebuf), precis);
6836 #ifdef USE_LOCALE_NUMERIC
6837 RESTORE_LC_NUMERIC();
6841 =for apidoc Am|void|WITH_LC_NUMERIC_SET_TO_NEEDED_IN|bool in_lc_numeric|block
6843 Same as L</WITH_LC_NUMERIC_SET_TO_NEEDED> with in_lc_numeric provided
6844 as the precalculated value of C<IN_LC(LC_NUMERIC)>. It is the caller's
6845 responsibility to ensure that the status of C<PL_compiling> and C<PL_hints>
6846 cannot have changed since the precalculation.
6852 /* If the underlying numeric locale has a non-dot decimal point or has a
6853 * non-empty floating point thousands separator, the current locale is instead
6854 * generally kept in the C locale instead of that underlying locale. The
6855 * current status is known by looking at two words. One is non-zero if the
6856 * current numeric locale is the standard C/POSIX one or is indistinguishable
6857 * from C. The other is non-zero if the current locale is the underlying
6858 * locale. Both can be non-zero if, as often happens, the underlying locale is
6859 * C or indistinguishable from it.
6861 * khw believes the reason for the variables instead of the bits in a single
6862 * word is to avoid having to have masking instructions. */
6864 # define _NOT_IN_NUMERIC_STANDARD (! PL_numeric_standard)
6866 /* We can lock the category to stay in the C locale, making requests to the
6867 * contrary be noops, in the dynamic scope by setting PL_numeric_standard to 2.
6869 # define _NOT_IN_NUMERIC_UNDERLYING \
6870 (! PL_numeric_underlying && PL_numeric_standard < 2)
6872 # define DECLARATION_FOR_LC_NUMERIC_MANIPULATION \
6873 void (*_restore_LC_NUMERIC_function)(pTHX) = NULL
6875 # define STORE_LC_NUMERIC_SET_TO_NEEDED_IN(in) \
6877 bool _in_lc_numeric = (in); \
6879 ( ( _in_lc_numeric && _NOT_IN_NUMERIC_UNDERLYING) \
6880 || (! _in_lc_numeric && _NOT_IN_NUMERIC_STANDARD))); \
6881 if (_in_lc_numeric) { \
6882 if (_NOT_IN_NUMERIC_UNDERLYING) { \
6883 Perl_set_numeric_underlying(aTHX); \
6884 _restore_LC_NUMERIC_function \
6885 = &Perl_set_numeric_standard; \
6889 if (_NOT_IN_NUMERIC_STANDARD) { \
6890 Perl_set_numeric_standard(aTHX); \
6891 _restore_LC_NUMERIC_function \
6892 = &Perl_set_numeric_underlying; \
6897 # define STORE_LC_NUMERIC_SET_TO_NEEDED() \
6898 STORE_LC_NUMERIC_SET_TO_NEEDED_IN(IN_LC(LC_NUMERIC))
6900 # define RESTORE_LC_NUMERIC() \
6902 if (_restore_LC_NUMERIC_function) { \
6903 _restore_LC_NUMERIC_function(aTHX); \
6905 LC_NUMERIC_UNLOCK; \
6908 /* The next two macros set unconditionally. These should be rarely used, and
6909 * only after being sure that this is what is needed */
6910 # define SET_NUMERIC_STANDARD() \
6912 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6913 "%s: %d: lc_numeric standard=%d\n", \
6914 __FILE__, __LINE__, PL_numeric_standard)); \
6915 Perl_set_numeric_standard(aTHX); \
6916 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6917 "%s: %d: lc_numeric standard=%d\n", \
6918 __FILE__, __LINE__, PL_numeric_standard)); \
6921 # define SET_NUMERIC_UNDERLYING() \
6923 if (_NOT_IN_NUMERIC_UNDERLYING) { \
6924 Perl_set_numeric_underlying(aTHX); \
6928 /* The rest of these LC_NUMERIC macros toggle to one or the other state, with
6929 * the RESTORE_foo ones called to switch back, but only if need be */
6930 # define STORE_LC_NUMERIC_SET_STANDARD() \
6932 LC_NUMERIC_LOCK(_NOT_IN_NUMERIC_STANDARD); \
6933 if (_NOT_IN_NUMERIC_STANDARD) { \
6934 _restore_LC_NUMERIC_function = &Perl_set_numeric_underlying;\
6935 Perl_set_numeric_standard(aTHX); \
6939 /* Rarely, we want to change to the underlying locale even outside of 'use
6940 * locale'. This is principally in the POSIX:: functions */
6941 # define STORE_LC_NUMERIC_FORCE_TO_UNDERLYING() \
6943 LC_NUMERIC_LOCK(_NOT_IN_NUMERIC_UNDERLYING); \
6944 if (_NOT_IN_NUMERIC_UNDERLYING) { \
6945 Perl_set_numeric_underlying(aTHX); \
6946 _restore_LC_NUMERIC_function = &Perl_set_numeric_standard; \
6950 /* Lock/unlock to the C locale until unlock is called. This needs to be
6951 * recursively callable. [perl #128207] */
6952 # define LOCK_LC_NUMERIC_STANDARD() \
6954 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6955 "%s: %d: lock lc_numeric_standard: new depth=%d\n", \
6956 __FILE__, __LINE__, PL_numeric_standard + 1)); \
6957 __ASSERT_(PL_numeric_standard) \
6958 PL_numeric_standard++; \
6961 # define UNLOCK_LC_NUMERIC_STANDARD() \
6963 if (PL_numeric_standard > 1) { \
6964 PL_numeric_standard--; \
6969 DEBUG_Lv(PerlIO_printf(Perl_debug_log, \
6970 "%s: %d: lc_numeric_standard decrement lock, new depth=%d\n", \
6971 __FILE__, __LINE__, PL_numeric_standard)); \
6974 # define WITH_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric, block) \
6976 DECLARATION_FOR_LC_NUMERIC_MANIPULATION; \
6977 STORE_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric); \
6979 RESTORE_LC_NUMERIC(); \
6982 # define WITH_LC_NUMERIC_SET_TO_NEEDED(block) \
6983 WITH_LC_NUMERIC_SET_TO_NEEDED_IN(IN_LC(LC_NUMERIC), block)
6985 #else /* !USE_LOCALE_NUMERIC */
6987 # define SET_NUMERIC_STANDARD()
6988 # define SET_NUMERIC_UNDERLYING()
6989 # define IS_NUMERIC_RADIX(a, b) (0)
6990 # define DECLARATION_FOR_LC_NUMERIC_MANIPULATION dNOOP
6991 # define STORE_LC_NUMERIC_SET_STANDARD()
6992 # define STORE_LC_NUMERIC_FORCE_TO_UNDERLYING()
6993 # define STORE_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric)
6994 # define STORE_LC_NUMERIC_SET_TO_NEEDED()
6995 # define RESTORE_LC_NUMERIC()
6996 # define LOCK_LC_NUMERIC_STANDARD()
6997 # define UNLOCK_LC_NUMERIC_STANDARD()
6998 # define WITH_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric, block) \
6999 STMT_START { block; } STMT_END
7000 # define WITH_LC_NUMERIC_SET_TO_NEEDED(block) \
7001 STMT_START { block; } STMT_END
7003 #endif /* !USE_LOCALE_NUMERIC */
7006 # define ENV_LOCK PERL_WRITE_LOCK(&PL_env_mutex)
7007 # define ENV_UNLOCK PERL_WRITE_UNLOCK(&PL_env_mutex)
7008 # define ENV_READ_LOCK PERL_READ_LOCK(&PL_env_mutex)
7009 # define ENV_READ_UNLOCK PERL_READ_UNLOCK(&PL_env_mutex)
7010 # define ENV_INIT PERL_RW_MUTEX_INIT(&PL_env_mutex)
7011 # define ENV_TERM PERL_RW_MUTEX_DESTROY(&PL_env_mutex)
7013 /* On platforms where the static buffer contained in getenv() is per-thread
7014 * rather than process-wide, another thread executing a getenv() at the same
7015 * time won't destroy ours before we have copied the result safely away and
7016 * unlocked the mutex. On such platforms (which is most), we can have many
7017 * readers of the environment at the same time. */
7018 # ifdef GETENV_PRESERVES_OTHER_THREAD
7019 # define GETENV_LOCK ENV_READ_LOCK
7020 # define GETENV_UNLOCK ENV_READ_UNLOCK
7022 /* If, on the other hand, another thread could zap our getenv() return, we
7023 * need to keep them from executing until we are done */
7024 # define GETENV_LOCK ENV_LOCK
7025 # define GETENV_UNLOCK ENV_UNLOCK
7028 # define ENV_LOCK NOOP
7029 # define ENV_UNLOCK NOOP
7030 # define ENV_READ_LOCK NOOP
7031 # define ENV_READ_UNLOCK NOOP
7032 # define ENV_INIT NOOP
7033 # define ENV_TERM NOOP
7034 # define GETENV_LOCK NOOP
7035 # define GETENV_UNLOCK NOOP
7038 #ifndef PERL_NO_INLINE_FUNCTIONS
7039 /* Static inline funcs that depend on includes and declarations above.
7040 Some of these reference functions in the perl object files, and some
7041 compilers aren't smart enough to eliminate unused static inline
7042 functions, so including this file in source code can cause link errors
7043 even if the source code uses none of the functions. Hence including these
7044 can be suppressed by setting PERL_NO_INLINE_FUNCTIONS. Doing this will
7045 (obviously) result in unworkable XS code, but allows simple probing code
7046 to continue to work, because it permits tests to include the perl headers
7047 for definitions without creating a link dependency on the perl library
7048 (which may not exist yet).
7053 # include "inline.h"
7059 /* Some critical sections need to lock both the locale and the environment.
7060 * XXX khw intends to change this to lock both mutexes, but that brings up
7061 * issues of potential deadlock, so should be done at the beginning of a
7062 * development cycle. So for now, it just locks the environment. Note that
7063 * many modern platforms are locale-thread-safe anyway, so locking the locale
7064 * mutex is a no-op anyway */
7065 #define ENV_LOCALE_LOCK ENV_LOCK
7066 #define ENV_LOCALE_UNLOCK ENV_UNLOCK
7068 /* And some critical sections care only that no one else is writing either the
7069 * locale nor the environment. XXX Again this is for the future. This can be
7070 * simulated with using COND_WAIT in thread.h */
7071 #define ENV_LOCALE_READ_LOCK ENV_LOCALE_LOCK
7072 #define ENV_LOCALE_READ_UNLOCK ENV_LOCALE_UNLOCK
7074 #define Atof my_atof
7078 =for apidoc_section $numeric
7080 =for apidoc AmTR|NV|Strtod|NN const char * const s|NULLOK char ** e
7082 This is a synonym for L</my_strtod>.
7084 =for apidoc AmTR|NV|Strtol|NN const char * const s|NULLOK char ** e|int base
7086 Platform and configuration independent C<strtol>. This expands to the
7087 appropriate C<strotol>-like function based on the platform and F<Configure>
7088 options>. For example it could expand to C<strtoll> or C<strtoq> instead of
7091 =for apidoc AmTR|NV|Strtoul|NN const char * const s|NULLOK char ** e|int base
7093 Platform and configuration independent C<strtoul>. This expands to the
7094 appropriate C<strotoul>-like function based on the platform and F<Configure>
7095 options>. For example it could expand to C<strtoull> or C<strtouq> instead of
7102 #define Strtod my_strtod
7104 #if defined(HAS_STRTOD) \
7105 || defined(USE_QUADMATH) \
7106 || (defined(HAS_STRTOLD) && defined(HAS_LONG_DOUBLE) \
7107 && defined(USE_LONG_DOUBLE))
7108 # define Perl_strtod Strtod
7111 #if !defined(Strtol) && defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && \
7112 (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
7114 # define strtoll __strtoll /* secret handshake */
7116 # if defined(WIN64) && defined(_MSC_VER)
7117 # define strtoll _strtoi64 /* secret handshake */
7119 # if !defined(Strtol) && defined(HAS_STRTOLL)
7120 # define Strtol strtoll
7122 # if !defined(Strtol) && defined(HAS_STRTOQ)
7123 # define Strtol strtoq
7125 /* is there atoq() anywhere? */
7127 #if !defined(Strtol) && defined(HAS_STRTOL)
7128 # define Strtol strtol
7131 /* It would be more fashionable to use Strtol() to define atol()
7132 * (as is done for Atoul(), see below) but for backward compatibility
7133 * we just assume atol(). */
7134 # if defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && defined(HAS_ATOLL) && \
7135 (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
7137 # define atoll _atoi64 /* secret handshake */
7145 #if !defined(Strtoul) && defined(USE_64_BIT_INT) && defined(UV_IS_QUAD) && \
7146 (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
7148 # define strtoull __strtoull /* secret handshake */
7150 # if defined(WIN64) && defined(_MSC_VER)
7151 # define strtoull _strtoui64 /* secret handshake */
7153 # if !defined(Strtoul) && defined(HAS_STRTOULL)
7154 # define Strtoul strtoull
7156 # if !defined(Strtoul) && defined(HAS_STRTOUQ)
7157 # define Strtoul strtouq
7159 /* is there atouq() anywhere? */
7161 #if !defined(Strtoul) && defined(HAS_STRTOUL)
7162 # define Strtoul strtoul
7164 #if !defined(Strtoul) && defined(HAS_STRTOL) /* Last resort. */
7165 # define Strtoul(s, e, b) strchr((s), '-') ? ULONG_MAX : (unsigned long)strtol((s), (e), (b))
7168 # define Atoul(s) Strtoul(s, NULL, 10)
7171 #define grok_bin(s,lp,fp,rp) \
7172 grok_bin_oct_hex(s, lp, fp, rp, 1, _CC_BINDIGIT, 'b')
7173 #define grok_oct(s,lp,fp,rp) \
7174 (*(fp) |= PERL_SCAN_DISALLOW_PREFIX, \
7175 grok_bin_oct_hex(s, lp, fp, rp, 3, _CC_OCTDIGIT, '\0'))
7176 #define grok_hex(s,lp,fp,rp) \
7177 grok_bin_oct_hex(s, lp, fp, rp, 4, _CC_XDIGIT, 'x')
7179 #ifndef PERL_SCRIPT_MODE
7180 #define PERL_SCRIPT_MODE "r"
7183 /* not used. Kept as a NOOP for backcompat */
7184 #define PERL_STACK_OVERFLOW_CHECK() NOOP
7187 * Some nonpreemptive operating systems find it convenient to
7188 * check for asynchronous conditions after each op execution.
7189 * Keep this check simple, or it may slow down execution
7194 # ifndef PERL_ASYNC_CHECK
7195 # define PERL_ASYNC_CHECK() if (UNLIKELY(PL_sig_pending)) PL_signalhook(aTHX)
7199 #ifndef PERL_ASYNC_CHECK
7200 # define PERL_ASYNC_CHECK() NOOP
7204 * On some operating systems, a memory allocation may succeed,
7205 * but put the process too close to the system's comfort limit.
7206 * In this case, PERL_ALLOC_CHECK frees the pointer and sets
7209 #ifndef PERL_ALLOC_CHECK
7210 #define PERL_ALLOC_CHECK(p) NOOP
7214 # include <sys/ipc.h>
7215 # include <sys/sem.h>
7216 # ifndef HAS_UNION_SEMUN /* Provide the union semun. */
7219 struct semid_ds *buf;
7220 unsigned short *array;
7223 # ifdef USE_SEMCTL_SEMUN
7224 # ifdef IRIX32_SEMUN_BROKEN_BY_GCC
7225 union gccbug_semun {
7227 struct semid_ds *buf;
7228 unsigned short *array;
7231 # define semun gccbug_semun
7233 # define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun)
7234 # elif defined(USE_SEMCTL_SEMID_DS)
7235 # ifdef EXTRA_F_IN_SEMUN_BUF
7236 # define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buff)
7238 # define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buf)
7244 * Boilerplate macros for initializing and accessing interpreter-local
7245 * data from C. All statics in extensions should be reworked to use
7246 * this, if you want to make the extension thread-safe. See
7247 * ext/XS/APItest/APItest.xs for an example of the use of these macros,
7248 * and perlxs.pod for more.
7250 * Code that uses these macros is responsible for the following:
7251 * 1. #define MY_CXT_KEY to a unique string, e.g.
7252 * "DynaLoader::_guts" XS_VERSION
7253 * XXX in the current implementation, this string is ignored.
7254 * 2. Declare a typedef named my_cxt_t that is a structure that contains
7255 * all the data that needs to be interpreter-local.
7256 * 3. Use the START_MY_CXT macro after the declaration of my_cxt_t.
7257 * 4. Use the MY_CXT_INIT macro such that it is called exactly once
7258 * (typically put in the BOOT: section).
7259 * 5. Use the members of the my_cxt_t structure everywhere as
7261 * 6. Use the dMY_CXT macro (a declaration) in all the functions that
7265 #if defined(PERL_IMPLICIT_CONTEXT)
7267 /* START_MY_CXT must appear in all extensions that define a my_cxt_t structure,
7268 * right after the definition (i.e. at file scope). The non-threads
7269 * case below uses it to declare the data as static. */
7270 # define START_MY_CXT static int my_cxt_index = -1;
7271 # define MY_CXT_INDEX my_cxt_index
7272 # define MY_CXT_INIT_ARG &my_cxt_index
7274 /* Creates and zeroes the per-interpreter data.
7275 * (We allocate my_cxtp in a Perl SV so that it will be released when
7276 * the interpreter goes away.) */
7277 # define MY_CXT_INIT \
7278 my_cxt_t *my_cxtp = \
7279 (my_cxt_t*)Perl_my_cxt_init(aTHX_ MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
7280 PERL_UNUSED_VAR(my_cxtp)
7281 # define MY_CXT_INIT_INTERP(my_perl) \
7282 my_cxt_t *my_cxtp = \
7283 (my_cxt_t*)Perl_my_cxt_init(my_perl, MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
7284 PERL_UNUSED_VAR(my_cxtp)
7286 /* This declaration should be used within all functions that use the
7287 * interpreter-local data. */
7289 my_cxt_t *my_cxtp = (my_cxt_t *)PL_my_cxt_list[MY_CXT_INDEX]
7290 # define dMY_CXT_INTERP(my_perl) \
7291 my_cxt_t *my_cxtp = (my_cxt_t *)(my_perl)->Imy_cxt_list[MY_CXT_INDEX]
7293 /* Clones the per-interpreter data. */
7294 # define MY_CXT_CLONE \
7295 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1));\
7296 void * old_my_cxtp = PL_my_cxt_list[MY_CXT_INDEX]; \
7297 PL_my_cxt_list[MY_CXT_INDEX] = my_cxtp; \
7298 Copy(old_my_cxtp, my_cxtp, 1, my_cxt_t);
7302 /* This macro must be used to access members of the my_cxt_t structure.
7303 * e.g. MY_CXT.some_data */
7304 # define MY_CXT (*my_cxtp)
7306 /* Judicious use of these macros can reduce the number of times dMY_CXT
7307 * is used. Use is similar to pTHX, aTHX etc. */
7308 # define pMY_CXT my_cxt_t *my_cxtp
7309 # define pMY_CXT_ pMY_CXT,
7310 # define _pMY_CXT ,pMY_CXT
7311 # define aMY_CXT my_cxtp
7312 # define aMY_CXT_ aMY_CXT,
7313 # define _aMY_CXT ,aMY_CXT
7315 #else /* PERL_IMPLICIT_CONTEXT */
7316 # define START_MY_CXT static my_cxt_t my_cxt;
7317 # define dMY_CXT dNOOP
7318 # define dMY_CXT_INTERP(my_perl) dNOOP
7319 # define MY_CXT_INIT NOOP
7320 # define MY_CXT_CLONE NOOP
7321 # define MY_CXT my_cxt
7323 # define pMY_CXT void
7330 #endif /* !defined(PERL_IMPLICIT_CONTEXT) */
7341 # undef FD_CLOEXEC /* a lie in AmigaOS */
7345 # include <sys/file.h>
7348 #if defined(HAS_FLOCK) && !defined(HAS_FLOCK_PROTO)
7349 EXTERN_C int flock(int fd, int op);
7353 /* Assume UNIX defaults */
7354 # define O_RDONLY 0000
7355 # define O_WRONLY 0001
7356 # define O_RDWR 0002
7357 # define O_CREAT 0100
7368 #if O_TEXT != O_BINARY
7369 /* If you have different O_TEXT and O_BINARY and you are a CRLF shop,
7370 * that is, you are somehow DOSish. */
7371 # if defined(__HAIKU__) || defined(__VOS__) || defined(__CYGWIN__)
7372 /* Haiku has O_TEXT != O_BINARY but O_TEXT and O_BINARY have no effect;
7373 * Haiku is always UNIXoid (LF), not DOSish (CRLF). */
7374 /* VOS has O_TEXT != O_BINARY, and they have effect,
7375 * but VOS always uses LF, never CRLF. */
7376 /* If you have O_TEXT different from your O_BINARY but you still are
7377 * not a CRLF shop. */
7378 # undef PERLIO_USING_CRLF
7380 /* If you really are DOSish. */
7381 # define PERLIO_USING_CRLF 1
7386 # include <libutil.h> /* setproctitle() in some FreeBSDs */
7389 #ifndef EXEC_ARGV_CAST
7390 #define EXEC_ARGV_CAST(x) (char **)x
7393 #define IS_NUMBER_IN_UV 0x01 /* number within UV range (maybe not
7394 int). value returned in pointed-
7396 #define IS_NUMBER_GREATER_THAN_UV_MAX 0x02 /* pointed to UV undefined */
7397 #define IS_NUMBER_NOT_INT 0x04 /* saw . or E notation or infnan */
7398 #define IS_NUMBER_NEG 0x08 /* leading minus sign */
7399 #define IS_NUMBER_INFINITY 0x10 /* this is big */
7400 #define IS_NUMBER_NAN 0x20 /* this is not */
7401 #define IS_NUMBER_TRAILING 0x40 /* number has trailing trash */
7404 =for apidoc_section $numeric
7406 =for apidoc AmdR|bool|GROK_NUMERIC_RADIX|NN const char **sp|NN const char *send
7408 A synonym for L</grok_numeric_radix>
7412 #define GROK_NUMERIC_RADIX(sp, send) grok_numeric_radix(sp, send)
7414 /* Number scan flags. All are used for input, the ones used for output are so
7416 #define PERL_SCAN_ALLOW_UNDERSCORES 0x01 /* grok_??? accept _ in numbers */
7417 #define PERL_SCAN_DISALLOW_PREFIX 0x02 /* grok_??? reject 0x in hex etc */
7419 /* grok_??? input: ignored; output: found overflow */
7420 #define PERL_SCAN_GREATER_THAN_UV_MAX 0x04
7422 /* grok_??? don't warn about illegal digits. To preserve total backcompat,
7423 * this isn't set on output if one is found. Instead, see
7424 * PERL_SCAN_NOTIFY_ILLDIGIT. */
7425 #define PERL_SCAN_SILENT_ILLDIGIT 0x08
7427 #define PERL_SCAN_TRAILING 0x10 /* grok_number_flags() allow trailing
7428 and set IS_NUMBER_TRAILING */
7430 /* These are considered experimental, so not exposed publicly */
7431 #if defined(PERL_CORE) || defined(PERL_EXT)
7432 /* grok_??? don't warn about very large numbers which are <= UV_MAX;
7433 * output: found such a number */
7434 # define PERL_SCAN_SILENT_NON_PORTABLE 0x20
7436 /* If this is set on input, and no illegal digit is found, it will be cleared
7437 * on output; otherwise unchanged */
7438 # define PERL_SCAN_NOTIFY_ILLDIGIT 0x40
7440 /* Don't warn on overflow; output flag still set */
7441 # define PERL_SCAN_SILENT_OVERFLOW 0x80
7443 /* Forbid a leading underscore, which the other one doesn't */
7444 # define PERL_SCAN_ALLOW_MEDIAL_UNDERSCORES (0x100|PERL_SCAN_ALLOW_UNDERSCORES)
7448 /* to let user control profiling */
7449 #ifdef PERL_GPROF_CONTROL
7450 extern void moncontrol(int);
7451 #define PERL_GPROF_MONCONTROL(x) moncontrol(x)
7453 #define PERL_GPROF_MONCONTROL(x)
7456 /* ISO 6429 NEL - C1 control NExt Line */
7457 /* See https://www.unicode.org/unicode/reports/tr13/ */
7458 #define NEXT_LINE_CHAR NEXT_LINE_NATIVE
7460 #ifndef PIPESOCK_MODE
7461 # define PIPESOCK_MODE
7464 #ifndef SOCKET_OPEN_MODE
7465 # define SOCKET_OPEN_MODE PIPESOCK_MODE
7468 #ifndef PIPE_OPEN_MODE
7469 # define PIPE_OPEN_MODE PIPESOCK_MODE
7472 #define PERL_MAGIC_UTF8_CACHESIZE 2
7476 #define PERL_UNICODE_STDIN_FLAG 0x0001
7477 #define PERL_UNICODE_STDOUT_FLAG 0x0002
7478 #define PERL_UNICODE_STDERR_FLAG 0x0004
7479 #define PERL_UNICODE_IN_FLAG 0x0008
7480 #define PERL_UNICODE_OUT_FLAG 0x0010
7481 #define PERL_UNICODE_ARGV_FLAG 0x0020
7482 #define PERL_UNICODE_LOCALE_FLAG 0x0040
7483 #define PERL_UNICODE_WIDESYSCALLS_FLAG 0x0080 /* for Sarathy */
7484 #define PERL_UNICODE_UTF8CACHEASSERT_FLAG 0x0100
7486 #define PERL_UNICODE_STD_FLAG \
7487 (PERL_UNICODE_STDIN_FLAG | \
7488 PERL_UNICODE_STDOUT_FLAG | \
7489 PERL_UNICODE_STDERR_FLAG)
7491 #define PERL_UNICODE_INOUT_FLAG \
7492 (PERL_UNICODE_IN_FLAG | \
7493 PERL_UNICODE_OUT_FLAG)
7495 #define PERL_UNICODE_DEFAULT_FLAGS \
7496 (PERL_UNICODE_STD_FLAG | \
7497 PERL_UNICODE_INOUT_FLAG | \
7498 PERL_UNICODE_LOCALE_FLAG)
7500 #define PERL_UNICODE_ALL_FLAGS 0x01ff
7502 #define PERL_UNICODE_STDIN 'I'
7503 #define PERL_UNICODE_STDOUT 'O'
7504 #define PERL_UNICODE_STDERR 'E'
7505 #define PERL_UNICODE_STD 'S'
7506 #define PERL_UNICODE_IN 'i'
7507 #define PERL_UNICODE_OUT 'o'
7508 #define PERL_UNICODE_INOUT 'D'
7509 #define PERL_UNICODE_ARGV 'A'
7510 #define PERL_UNICODE_LOCALE 'L'
7511 #define PERL_UNICODE_WIDESYSCALLS 'W'
7512 #define PERL_UNICODE_UTF8CACHEASSERT 'a'
7517 =for apidoc_section $signals
7518 =for apidoc Amn|U32|PERL_SIGNALS_UNSAFE_FLAG
7519 If this bit in C<PL_signals> is set, the system is uing the pre-Perl 5.8
7520 unsafe signals. See L<perlrun/PERL_SIGNALS> and L<perlipc/Deferred Signals
7525 #define PERL_SIGNALS_UNSAFE_FLAG 0x0001
7528 =for apidoc_section $numeric
7530 =for apidoc Am|int|PERL_ABS|int x
7532 Typeless C<abs> or C<fabs>, I<etc>. (The usage below indicates it is for
7533 integers, but it works for any type.) Use instead of these, since the C
7534 library ones force their argument to be what it is expecting, potentially
7535 leading to disaster. But also beware that this evaluates its argument twice,
7541 #define PERL_ABS(x) ((x) < 0 ? -(x) : (x))
7543 #if defined(__DECC) && defined(__osf__)
7544 #pragma message disable (mainparm) /* Perl uses the envp in main(). */
7547 #define do_open(g, n, l, a, rm, rp, sf) \
7548 do_openn(g, n, l, a, rm, rp, sf, (SV **) NULL, 0)
7549 #ifdef PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
7550 # define do_exec(cmd) do_exec3(cmd,0,0)
7553 # define do_aexec Perl_do_aexec
7555 # define do_aexec(really, mark,sp) do_aexec5(really, mark, sp, 0, 0)
7560 =for apidoc_section $utility
7562 =for apidoc Am|bool|IS_SAFE_SYSCALL|NN const char *pv|STRLEN len|NN const char *what|NN const char *op_name
7564 Same as L</is_safe_syscall>.
7568 Allows one ending \0
7570 #define IS_SAFE_SYSCALL(p, len, what, op_name) (Perl_is_safe_syscall(aTHX_ (p), (len), (what), (op_name)))
7572 #define IS_SAFE_PATHNAME(p, len, op_name) IS_SAFE_SYSCALL((p), (len), "pathname", (op_name))
7574 #if defined(OEMVS) || defined(__amigaos4__)
7575 #define NO_ENV_ARRAY_IN_MAIN
7578 /* These are used by Perl_pv_escape() and Perl_pv_pretty()
7579 * are here so that they are available throughout the core
7580 * NOTE that even though some are for _escape and some for _pretty
7581 * there must not be any clashes as the flags from _pretty are
7582 * passed straight through to _escape.
7585 #define PERL_PV_ESCAPE_QUOTE 0x000001
7586 #define PERL_PV_PRETTY_QUOTE PERL_PV_ESCAPE_QUOTE
7588 #define PERL_PV_PRETTY_ELLIPSES 0x000002
7589 #define PERL_PV_PRETTY_LTGT 0x000004
7590 #define PERL_PV_PRETTY_EXACTSIZE 0x000008
7592 #define PERL_PV_ESCAPE_UNI 0x000100
7593 #define PERL_PV_ESCAPE_UNI_DETECT 0x000200
7594 #define PERL_PV_ESCAPE_NONASCII 0x000400
7595 #define PERL_PV_ESCAPE_FIRSTCHAR 0x000800
7597 #define PERL_PV_ESCAPE_ALL 0x001000
7598 #define PERL_PV_ESCAPE_NOBACKSLASH 0x002000
7599 #define PERL_PV_ESCAPE_NOCLEAR 0x004000
7600 #define PERL_PV_PRETTY_NOCLEAR PERL_PV_ESCAPE_NOCLEAR
7601 #define PERL_PV_ESCAPE_RE 0x008000
7603 #define PERL_PV_ESCAPE_DWIM 0x010000
7606 /* used by pv_display in dump.c*/
7607 #define PERL_PV_PRETTY_DUMP PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE
7608 #define PERL_PV_PRETTY_REGPROP PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_LTGT|PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII
7610 #if DOUBLEKIND == DOUBLE_IS_VAX_F_FLOAT || \
7611 DOUBLEKIND == DOUBLE_IS_VAX_D_FLOAT || \
7612 DOUBLEKIND == DOUBLE_IS_VAX_G_FLOAT
7613 # define DOUBLE_IS_VAX_FLOAT
7615 # define DOUBLE_IS_IEEE_FORMAT
7618 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN || \
7619 DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN || \
7620 DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
7621 # define DOUBLE_LITTLE_ENDIAN
7624 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN || \
7625 DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN || \
7626 DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
7627 # define DOUBLE_BIG_ENDIAN
7630 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE || \
7631 DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
7632 # define DOUBLE_MIX_ENDIAN
7635 /* The VAX fp formats are neither consistently little-endian nor
7636 * big-endian, and neither are they really IEEE-mixed endian like
7637 * the mixed-endian ARM IEEE formats (with swapped bytes).
7638 * Ultimately, the VAX format came from the PDP-11.
7640 * The ordering of the parts in VAX floats is quite vexing.
7641 * In the below the fraction_n are the mantissa bits.
7643 * The fraction_1 is the most significant (numbering as by DEC/Digital),
7644 * while the rightmost bit in each fraction is the least significant:
7645 * in other words, big-endian bit order within the fractions.
7647 * The fraction segments themselves would be big-endianly, except that
7648 * within 32 bit segments the less significant half comes first, the more
7649 * significant after, except that in the format H (used for long doubles)
7650 * the first fraction segment is alone, because the exponent is wider.
7651 * This means for example that both the most and the least significant
7652 * bits can be in the middle of the floats, not at either end.
7655 * http://nssdc.gsfc.nasa.gov/nssdc/formats/VAXFloatingPoint.htm
7656 * http://www.quadibloc.com/comp/cp0201.htm
7657 * http://h71000.www7.hp.com/doc/82final/6443/6443pro_028.html
7658 * (somebody at HP should be fired for the URLs)
7660 * F fraction_2:16 sign:1 exp:8 fraction_1:7
7661 * (exponent bias 128, hidden first one-bit)
7663 * D fraction_2:16 sign:1 exp:8 fraction_1:7
7664 * fraction_4:16 fraction_3:16
7665 * (exponent bias 128, hidden first one-bit)
7667 * G fraction_2:16 sign:1 exp:11 fraction_1:4
7668 * fraction_4:16 fraction_3:16
7669 * (exponent bias 1024, hidden first one-bit)
7671 * H fraction_1:16 sign:1 exp:15
7672 * fraction_3:16 fraction_2:16
7673 * fraction_5:16 fraction_4:16
7674 * fraction_7:16 fraction_6:16
7675 * (exponent bias 16384, hidden first one-bit)
7676 * (available only on VAX, and only on Fortran?)
7678 * The formats S, T and X are available on the Alpha (and Itanium,
7679 * also known as I64/IA64) and are equivalent with the IEEE-754 formats
7680 * binary32, binary64, and binary128 (commonly: float, double, long double).
7682 * S sign:1 exp:8 mantissa:23
7683 * (exponent bias 127, hidden first one-bit)
7685 * T sign:1 exp:11 mantissa:52
7686 * (exponent bias 1022, hidden first one-bit)
7688 * X sign:1 exp:15 mantissa:112
7689 * (exponent bias 16382, hidden first one-bit)
7693 #ifdef DOUBLE_IS_VAX_FLOAT
7694 # define DOUBLE_VAX_ENDIAN
7697 #ifdef DOUBLE_IS_IEEE_FORMAT
7698 /* All the basic IEEE formats have the implicit bit,
7699 * except for the x86 80-bit extended formats, which will undef this.
7700 * Also note that the IEEE 754 subnormals (formerly known as denormals)
7701 * do not have the implicit bit of one. */
7702 # define NV_IMPLICIT_BIT
7705 #if defined(LONG_DOUBLEKIND) && LONG_DOUBLEKIND != LONG_DOUBLE_IS_DOUBLE
7707 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN || \
7708 LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
7709 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
7710 # define LONGDOUBLE_LITTLE_ENDIAN
7713 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN || \
7714 LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN || \
7715 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
7716 # define LONGDOUBLE_BIG_ENDIAN
7719 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
7720 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
7721 # define LONGDOUBLE_MIX_ENDIAN
7724 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
7725 LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
7726 # define LONGDOUBLE_X86_80_BIT
7727 # ifdef USE_LONG_DOUBLE
7728 # undef NV_IMPLICIT_BIT
7729 # define NV_X86_80_BIT
7733 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE || \
7734 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE || \
7735 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
7736 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
7737 # define LONGDOUBLE_DOUBLEDOUBLE
7740 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_VAX_H_FLOAT
7741 # define LONGDOUBLE_VAX_ENDIAN
7744 #endif /* LONG_DOUBLEKIND */
7746 #ifdef USE_QUADMATH /* assume quadmath endianness == native double endianness */
7747 # if defined(DOUBLE_LITTLE_ENDIAN)
7748 # define NV_LITTLE_ENDIAN
7749 # elif defined(DOUBLE_BIG_ENDIAN)
7750 # define NV_BIG_ENDIAN
7751 # elif defined(DOUBLE_MIX_ENDIAN) /* stretch */
7752 # define NV_MIX_ENDIAN
7754 #elif NVSIZE == DOUBLESIZE
7755 # ifdef DOUBLE_LITTLE_ENDIAN
7756 # define NV_LITTLE_ENDIAN
7758 # ifdef DOUBLE_BIG_ENDIAN
7759 # define NV_BIG_ENDIAN
7761 # ifdef DOUBLE_MIX_ENDIAN
7762 # define NV_MIX_ENDIAN
7764 # ifdef DOUBLE_VAX_ENDIAN
7765 # define NV_VAX_ENDIAN
7767 #elif NVSIZE == LONG_DOUBLESIZE
7768 # ifdef LONGDOUBLE_LITTLE_ENDIAN
7769 # define NV_LITTLE_ENDIAN
7771 # ifdef LONGDOUBLE_BIG_ENDIAN
7772 # define NV_BIG_ENDIAN
7774 # ifdef LONGDOUBLE_MIX_ENDIAN
7775 # define NV_MIX_ENDIAN
7777 # ifdef LONGDOUBLE_VAX_ENDIAN
7778 # define NV_VAX_ENDIAN
7782 /* We have somehow managed not to define the denormal/subnormal
7785 * This may happen if the compiler doesn't expose the C99 math like
7786 * the fpclassify() without some special switches. Perl tries to
7787 * stay C89, so for example -std=c99 is not an option.
7789 * The Perl_isinf() and Perl_isnan() should have been defined even if
7790 * the C99 isinf() and isnan() are unavailable, and the NV_MIN becomes
7791 * from the C89 DBL_MIN or moral equivalent. */
7792 #if !defined(Perl_fp_class_denorm) && defined(Perl_isinf) && defined(Perl_isnan) && defined(NV_MIN)
7793 # define Perl_fp_class_denorm(x) ((x) != 0.0 && !Perl_isinf(x) && !Perl_isnan(x) && PERL_ABS(x) < NV_MIN)
7796 /* This is not a great fallback: subnormals tests will fail,
7797 * but at least Perl will link and 99.999% of tests will work. */
7798 #if !defined(Perl_fp_class_denorm)
7799 # define Perl_fp_class_denorm(x) FALSE
7802 #ifdef DOUBLE_IS_IEEE_FORMAT
7803 # define DOUBLE_HAS_INF
7804 # define DOUBLE_HAS_NAN
7807 #ifdef DOUBLE_HAS_NAN
7813 /* PL_inf and PL_nan initialization.
7815 * For inf and nan initialization the ultimate fallback is dividing
7816 * one or zero by zero: however, some compilers will warn or even fail
7817 * on divide-by-zero, but hopefully something earlier will work.
7819 * If you are thinking of using HUGE_VAL for infinity, or using
7820 * <math.h> functions to generate NV_INF (e.g. exp(1e9), log(-1.0)),
7821 * stop. Neither will work portably: HUGE_VAL can be just DBL_MAX,
7822 * and the math functions might be just generating DBL_MAX, or even zero.
7824 * Also, do NOT try doing NV_NAN based on NV_INF and trying (NV_INF-NV_INF).
7825 * Though logically correct, some compilers (like Visual C 2003)
7826 * falsely misoptimize that to zero (x-x is always zero, right?)
7828 * Finally, note that not all floating point formats define Inf (or NaN).
7829 * For the infinity a large number may be used instead. Operations that
7830 * under the IEEE floating point would return Inf or NaN may return
7831 * either large numbers (positive or negative), or they may cause
7832 * a floating point exception or some other fault.
7835 /* The quadmath literals are anon structs which -Wc++-compat doesn't like. */
7836 # ifndef USE_CPLUSPLUS
7837 GCC_DIAG_IGNORE_DECL(-Wc++-compat);
7840 # ifdef USE_QUADMATH
7841 /* Cannot use HUGE_VALQ for PL_inf because not a compile-time
7843 INFNAN_NV_U8_DECL PL_inf = { 1.0Q/0.0Q };
7844 # elif NVSIZE == LONG_DOUBLESIZE && defined(LONGDBLINFBYTES)
7845 INFNAN_U8_NV_DECL PL_inf = { { LONGDBLINFBYTES } };
7846 # elif NVSIZE == DOUBLESIZE && defined(DOUBLEINFBYTES)
7847 INFNAN_U8_NV_DECL PL_inf = { { DOUBLEINFBYTES } };
7849 # if NVSIZE == LONG_DOUBLESIZE && defined(USE_LONG_DOUBLE)
7850 # if defined(LDBL_INFINITY)
7851 INFNAN_NV_U8_DECL PL_inf = { LDBL_INFINITY };
7852 # elif defined(LDBL_INF)
7853 INFNAN_NV_U8_DECL PL_inf = { LDBL_INF };
7854 # elif defined(INFINITY)
7855 INFNAN_NV_U8_DECL PL_inf = { (NV)INFINITY };
7857 INFNAN_NV_U8_DECL PL_inf = { (NV)INF };
7859 INFNAN_NV_U8_DECL PL_inf = { 1.0L/0.0L }; /* keep last */
7862 # if defined(DBL_INFINITY)
7863 INFNAN_NV_U8_DECL PL_inf = { DBL_INFINITY };
7864 # elif defined(DBL_INF)
7865 INFNAN_NV_U8_DECL PL_inf = { DBL_INF };
7866 # elif defined(INFINITY) /* C99 */
7867 INFNAN_NV_U8_DECL PL_inf = { (NV)INFINITY };
7869 INFNAN_NV_U8_DECL PL_inf = { (NV)INF };
7871 INFNAN_NV_U8_DECL PL_inf = { 1.0/0.0 }; /* keep last */
7876 # ifdef USE_QUADMATH
7877 /* Cannot use nanq("0") for PL_nan because not a compile-time
7879 INFNAN_NV_U8_DECL PL_nan = { 0.0Q/0.0Q };
7880 # elif NVSIZE == LONG_DOUBLESIZE && defined(LONGDBLNANBYTES)
7881 INFNAN_U8_NV_DECL PL_nan = { { LONGDBLNANBYTES } };
7882 # elif NVSIZE == DOUBLESIZE && defined(DOUBLENANBYTES)
7883 INFNAN_U8_NV_DECL PL_nan = { { DOUBLENANBYTES } };
7885 # if NVSIZE == LONG_DOUBLESIZE && defined(USE_LONG_DOUBLE)
7886 # if defined(LDBL_NAN)
7887 INFNAN_NV_U8_DECL PL_nan = { LDBL_NAN };
7888 # elif defined(LDBL_QNAN)
7889 INFNAN_NV_U8_DECL PL_nan = { LDBL_QNAN };
7891 INFNAN_NV_U8_DECL PL_nan = { (NV)NAN };
7893 INFNAN_NV_U8_DECL PL_nan = { 0.0L/0.0L }; /* keep last */
7896 # if defined(DBL_NAN)
7897 INFNAN_NV_U8_DECL PL_nan = { DBL_NAN };
7898 # elif defined(DBL_QNAN)
7899 INFNAN_NV_U8_DECL PL_nan = { DBL_QNAN };
7900 # elif defined(NAN) /* C99 */
7901 INFNAN_NV_U8_DECL PL_nan = { (NV)NAN };
7903 INFNAN_NV_U8_DECL PL_nan = { 0.0/0.0 }; /* keep last */
7908 # ifndef USE_CPLUSPLUS
7909 GCC_DIAG_RESTORE_DECL;
7914 INFNAN_NV_U8_DECL PL_inf;
7915 INFNAN_NV_U8_DECL PL_nan;
7921 /* If you have not defined NV_INF/NV_NAN (like for example win32/win32.h),
7922 * we will define NV_INF/NV_NAN as the nv part of the global const
7923 * PL_inf/PL_nan. Note, however, that the preexisting NV_INF/NV_NAN
7924 * might not be a compile-time constant, in which case it cannot be
7925 * used to initialize PL_inf/PL_nan above. */
7927 # define NV_INF PL_inf.nv
7930 # define NV_NAN PL_nan.nv
7933 /* NaNs (not-a-numbers) can carry payload bits, in addition to
7934 * "nan-ness". Part of the payload is the quiet/signaling bit.
7935 * To back up a bit (harhar):
7937 * For IEEE 754 64-bit formats [1]:
7939 * s 000 (mantissa all-zero) zero
7940 * s 000 (mantissa non-zero) subnormals (denormals)
7941 * s 001 ... 7fe normals
7944 * For IEEE 754 128-bit formats:
7946 * s 0000 (mantissa all-zero) zero
7947 * s 0000 (mantissa non-zero) subnormals (denormals)
7948 * s 0001 ... 7ffe normals
7951 * [1] this looks like big-endian, but applies equally to little-endian.
7953 * s = Sign bit. Yes, zeros and nans can have negative sign,
7954 * the interpretation is application-specific.
7956 * q = Quietness bit, the interpretation is platform-specific.
7957 * Most platforms have the most significant bit being one
7958 * meaning quiet, but some (older mips, hppa) have the msb
7959 * being one meaning signaling. Note that the above means
7960 * that on most platforms there cannot be signaling nan with
7961 * zero payload because that is identical with infinity;
7962 * while conversely on older mips/hppa there cannot be a quiet nan
7963 * because that is identical with infinity.
7965 * Moreover, whether there is any behavioral difference
7966 * between quiet and signaling NaNs, depends on the platform.
7968 * x86 80-bit extended precision is different, the mantissa bits:
7970 * 63 62 61 30387+ pre-387 visual c
7971 * -------- ---- -------- --------
7972 * 0 0 0 invalid infinity
7973 * 0 0 1 invalid snan
7974 * 0 1 0 invalid snan
7975 * 0 1 1 invalid snan
7976 * 1 0 0 infinity snan 1.#INF
7977 * 1 0 1 snan 1.#SNAN
7978 * 1 1 0 qnan -1.#IND (x86 chooses this to negative)
7979 * 1 1 1 qnan 1.#QNAN
7981 * This means that in this format there are 61 bits available
7982 * for the nan payload.
7984 * Note that the 32-bit x86 ABI cannot do signaling nans: the x87
7985 * simply cannot preserve the bit. You can either use the 80-bit
7986 * extended precision (long double, -Duselongdouble), or use x86-64.
7988 * In all platforms, the payload bytes (and bits, some of them are
7989 * often in a partial byte) themselves can be either all zero (x86),
7990 * all one (sparc or mips), or a mixture: in IEEE 754 128-bit double
7991 * or in a double-double, the first half of the payload can follow the
7992 * native double, while in the second half the payload can be all
7993 * zeros. (Therefore the mask for payload bits is not necessarily
7994 * identical to bit complement of the NaN.) Another way of putting
7995 * this: the payload for the default NaN might not be zero.
7997 * For the x86 80-bit long doubles, the trailing bytes (the 80 bits
7998 * being 'packaged' in either 12 or 16 bytes) can be whatever random
8001 * Furthermore, the semantics of the sign bit on NaNs are platform-specific.
8002 * On normal floats, the sign bit being on means negative. But this may,
8003 * or may not, be reverted on NaNs: in other words, the default NaN might
8004 * have the sign bit on, and therefore look like negative if you look
8005 * at it at the bit level.
8007 * NaN payloads are not propagated even on copies, or in arithmetics.
8008 * They *might* be, according to some rules, on your particular
8009 * cpu/os/compiler/libraries, but no guarantees.
8011 * To summarize, on most platforms, and for 64-bit doubles
8012 * (using big-endian ordering here):
8014 * [7FF8000000000000..7FFFFFFFFFFFFFFF] quiet
8015 * [FFF8000000000000..FFFFFFFFFFFFFFFF] quiet
8016 * [7FF0000000000001..7FF7FFFFFFFFFFFF] signaling
8017 * [FFF0000000000001..FFF7FFFFFFFFFFFF] signaling
8019 * The C99 nan() is supposed to generate *quiet* NaNs.
8021 * Note the asymmetry:
8022 * The 7FF0000000000000 is positive infinity,
8023 * the FFF0000000000000 is negative infinity.
8026 /* NVMANTBITS is the number of _real_ mantissa bits in an NV.
8027 * For the standard IEEE 754 fp this number is usually one less that
8028 * *DBL_MANT_DIG because of the implicit (aka hidden) bit, which isn't
8029 * real. For the 80-bit extended precision formats (x86*), the number
8030 * of mantissa bits... depends. For normal floats, it's 64. But for
8031 * the inf/nan, it's different (zero for inf, 61 for nan).
8032 * NVMANTBITS works for normal floats. */
8034 /* We do not want to include the quiet/signaling bit. */
8035 #define NV_NAN_BITS (NVMANTBITS - 1)
8037 #if defined(USE_LONG_DOUBLE) && NVSIZE > DOUBLESIZE
8038 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
8039 # define NV_NAN_QS_BYTE_OFFSET 13
8040 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
8041 # define NV_NAN_QS_BYTE_OFFSET 2
8042 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN
8043 # define NV_NAN_QS_BYTE_OFFSET 7
8044 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
8045 # define NV_NAN_QS_BYTE_OFFSET 2
8046 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
8047 # define NV_NAN_QS_BYTE_OFFSET 13
8048 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
8049 # define NV_NAN_QS_BYTE_OFFSET 1
8050 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE
8051 # define NV_NAN_QS_BYTE_OFFSET 9
8052 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
8053 # define NV_NAN_QS_BYTE_OFFSET 6
8055 # error "Unexpected long double format"
8058 # ifdef USE_QUADMATH
8059 # ifdef NV_LITTLE_ENDIAN
8060 # define NV_NAN_QS_BYTE_OFFSET 13
8061 # elif defined(NV_BIG_ENDIAN)
8062 # define NV_NAN_QS_BYTE_OFFSET 2
8064 # error "Unexpected quadmath format"
8066 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN
8067 # define NV_NAN_QS_BYTE_OFFSET 2
8068 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN
8069 # define NV_NAN_QS_BYTE_OFFSET 1
8070 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN
8071 # define NV_NAN_QS_BYTE_OFFSET 6
8072 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN
8073 # define NV_NAN_QS_BYTE_OFFSET 1
8074 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
8075 # define NV_NAN_QS_BYTE_OFFSET 13
8076 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
8077 # define NV_NAN_QS_BYTE_OFFSET 2
8078 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE
8079 # define NV_NAN_QS_BYTE_OFFSET 2 /* bytes 4 5 6 7 0 1 2 3 (MSB 7) */
8080 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
8081 # define NV_NAN_QS_BYTE_OFFSET 5 /* bytes 3 2 1 0 7 6 5 4 (MSB 7) */
8083 /* For example the VAX formats should never
8084 * get here because they do not have NaN. */
8085 # error "Unexpected double format"
8088 /* NV_NAN_QS_BYTE is the byte to test for the quiet/signaling */
8089 #define NV_NAN_QS_BYTE(nvp) (((U8*)(nvp))[NV_NAN_QS_BYTE_OFFSET])
8090 /* NV_NAN_QS_BIT is the bit to test in the NV_NAN_QS_BYTE_OFFSET
8091 * for the quiet/signaling */
8092 #if defined(USE_LONG_DOUBLE) && \
8093 (LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
8094 LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN)
8095 # define NV_NAN_QS_BIT_SHIFT 6 /* 0x40 */
8096 #elif defined(USE_LONG_DOUBLE) && \
8097 (LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE || \
8098 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE || \
8099 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
8100 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE)
8101 # define NV_NAN_QS_BIT_SHIFT 3 /* 0x08, but not via NV_NAN_BITS */
8103 # define NV_NAN_QS_BIT_SHIFT ((NV_NAN_BITS) % 8) /* usually 3, or 0x08 */
8105 #define NV_NAN_QS_BIT (1 << (NV_NAN_QS_BIT_SHIFT))
8106 /* NV_NAN_QS_BIT_OFFSET is the bit offset from the beginning of a NV
8107 * (bytes ordered big-endianly) for the quiet/signaling bit
8108 * for the quiet/signaling */
8109 #define NV_NAN_QS_BIT_OFFSET \
8110 (8 * (NV_NAN_QS_BYTE_OFFSET) + (NV_NAN_QS_BIT_SHIFT))
8111 /* NV_NAN_QS_QUIET (always defined) is true if the NV_NAN_QS_QS_BIT being
8112 * on indicates quiet NaN. NV_NAN_QS_SIGNALING (also always defined)
8113 * is true if the NV_NAN_QS_BIT being on indicates signaling NaN. */
8114 #define NV_NAN_QS_QUIET \
8115 ((NV_NAN_QS_BYTE(PL_nan.u8) & NV_NAN_QS_BIT) == NV_NAN_QS_BIT)
8116 #define NV_NAN_QS_SIGNALING (!(NV_NAN_QS_QUIET))
8117 #define NV_NAN_QS_TEST(nvp) (NV_NAN_QS_BYTE(nvp) & NV_NAN_QS_BIT)
8118 /* NV_NAN_IS_QUIET() returns true if the NV behind nvp is a NaN,
8119 * whether it is a quiet NaN, NV_NAN_IS_SIGNALING() if a signaling NaN.
8120 * Note however that these do not check whether the nvp is a NaN. */
8121 #define NV_NAN_IS_QUIET(nvp) \
8122 (NV_NAN_QS_TEST(nvp) == (NV_NAN_QS_QUIET ? NV_NAN_QS_BIT : 0))
8123 #define NV_NAN_IS_SIGNALING(nvp) \
8124 (NV_NAN_QS_TEST(nvp) == (NV_NAN_QS_QUIET ? 0 : NV_NAN_QS_BIT))
8125 #define NV_NAN_SET_QUIET(nvp) \
8126 (NV_NAN_QS_QUIET ? \
8127 (NV_NAN_QS_BYTE(nvp) |= NV_NAN_QS_BIT) : \
8128 (NV_NAN_QS_BYTE(nvp) &= ~NV_NAN_QS_BIT))
8129 #define NV_NAN_SET_SIGNALING(nvp) \
8130 (NV_NAN_QS_QUIET ? \
8131 (NV_NAN_QS_BYTE(nvp) &= ~NV_NAN_QS_BIT) : \
8132 (NV_NAN_QS_BYTE(nvp) |= NV_NAN_QS_BIT))
8133 #define NV_NAN_QS_XOR(nvp) (NV_NAN_QS_BYTE(nvp) ^= NV_NAN_QS_BIT)
8135 /* NV_NAN_PAYLOAD_MASK: masking the nan payload bits.
8137 * NV_NAN_PAYLOAD_PERM: permuting the nan payload bytes.
8138 * 0xFF means "don't go here".*/
8140 /* Shorthands to avoid typoses. */
8141 #define NV_NAN_PAYLOAD_MASK_SKIP_EIGHT \
8142 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0
8143 #define NV_NAN_PAYLOAD_PERM_SKIP_EIGHT \
8144 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
8145 #define NV_NAN_PAYLOAD_PERM_0_TO_7 \
8146 0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7
8147 #define NV_NAN_PAYLOAD_PERM_7_TO_0 \
8148 0x7, 0x6, 0x5, 0x4, 0x3, 0x2, 0x1, 0x0
8149 #define NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE \
8150 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
8151 0xff, 0xff, 0xff, 0xff, 0xff, 0x7f, 0x00, 0x00
8152 #define NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE \
8153 NV_NAN_PAYLOAD_PERM_0_TO_7, \
8154 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xFF, 0xFF
8155 #define NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE \
8156 0x00, 0x00, 0x7f, 0xff, 0xff, 0xff, 0xff, 0xff, \
8157 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
8158 #define NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE \
8159 0xFF, 0xFF, 0xd, 0xc, 0xb, 0xa, 0x9, 0x8, \
8160 NV_NAN_PAYLOAD_PERM_7_TO_0
8161 #define NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE \
8162 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x07, 0x00
8163 #define NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE \
8164 0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0xFF
8165 #define NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE \
8166 0x00, 0x07, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
8167 #define NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE \
8168 0xFF, 0x6, 0x5, 0x4, 0x3, 0x2, 0x1, 0x0
8170 #if defined(USE_LONG_DOUBLE) && NVSIZE > DOUBLESIZE
8171 # if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
8172 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
8173 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
8174 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
8175 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
8176 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
8177 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN
8178 # if LONG_DOUBLESIZE == 10
8179 # define NV_NAN_PAYLOAD_MASK \
8180 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
8182 # define NV_NAN_PAYLOAD_PERM \
8183 NV_NAN_PAYLOAD_PERM_0_TO_7, 0xFF, 0xFF
8184 # elif LONG_DOUBLESIZE == 12
8185 # define NV_NAN_PAYLOAD_MASK \
8186 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
8187 0x00, 0x00, 0x00, 0x00
8188 # define NV_NAN_PAYLOAD_PERM \
8189 NV_NAN_PAYLOAD_PERM_0_TO_7, 0xFF, 0xFF, 0xFF, 0xFF
8190 # elif LONG_DOUBLESIZE == 16
8191 # define NV_NAN_PAYLOAD_MASK \
8192 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
8193 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
8194 # define NV_NAN_PAYLOAD_PERM \
8195 NV_NAN_PAYLOAD_PERM_0_TO_7, \
8196 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
8198 # error "Unexpected x86 80-bit little-endian long double format"
8200 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
8201 # if LONG_DOUBLESIZE == 10
8202 # define NV_NAN_PAYLOAD_MASK \
8203 0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
8205 # define NV_NAN_PAYLOAD_PERM \
8206 NV_NAN_PAYLOAD_PERM_7_TO_0, 0xFF, 0xFF
8207 # elif LONG_DOUBLESIZE == 12
8208 # define NV_NAN_PAYLOAD_MASK \
8209 0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
8210 0xff, 0xff, 0x00, 0x00
8211 # define NV_NAN_PAYLOAD_PERM \
8212 NV_NAN_PAYLOAD_PERM_7_TO_0, 0xFF, 0xFF, 0xFF, 0xFF
8213 # elif LONG_DOUBLESIZE == 16
8214 # define NV_NAN_PAYLOAD_MASK \
8215 0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
8216 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
8217 # define NV_NAN_PAYLOAD_PERM \
8218 NV_NAN_PAYLOAD_PERM_7_TO_0, \
8219 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
8221 # error "Unexpected x86 80-bit big-endian long double format"
8223 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
8224 /* For double-double we assume only the first double (in LE or BE terms)
8225 * is used for NaN. */
8226 # define NV_NAN_PAYLOAD_MASK \
8227 NV_NAN_PAYLOAD_MASK_SKIP_EIGHT, NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
8228 # define NV_NAN_PAYLOAD_PERM \
8229 NV_NAN_PAYLOAD_PERM_SKIP_EIGHT, NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
8230 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
8231 # define NV_NAN_PAYLOAD_MASK \
8232 NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
8233 # define NV_NAN_PAYLOAD_PERM \
8234 NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
8235 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE
8236 # define NV_NAN_PAYLOAD_MASK \
8237 NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
8238 # define NV_NAN_PAYLOAD_PERM \
8239 NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
8240 # elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
8241 # define NV_NAN_PAYLOAD_MASK \
8242 NV_NAN_PAYLOAD_MASK_SKIP_EIGHT, NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
8243 # define NV_NAN_PAYLOAD_PERM \
8244 NV_NAN_PAYLOAD_PERM_SKIP_EIGHT, NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
8246 # error "Unexpected long double format"
8249 # ifdef USE_QUADMATH /* quadmath is not long double */
8250 # ifdef NV_LITTLE_ENDIAN
8251 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
8252 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
8253 # elif defined(NV_BIG_ENDIAN)
8254 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
8255 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
8257 # error "Unexpected quadmath format"
8259 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN
8260 # define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0x07, 0x00
8261 # define NV_NAN_PAYLOAD_PERM 0x0, 0x1, 0x2, 0xFF
8262 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN
8263 # define NV_NAN_PAYLOAD_MASK 0x00, 0x07, 0xff, 0xff
8264 # define NV_NAN_PAYLOAD_PERM 0xFF, 0x2, 0x1, 0x0
8265 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN
8266 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
8267 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
8268 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN
8269 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
8270 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
8271 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
8272 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
8273 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
8274 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
8275 # define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
8276 # define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
8277 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE
8278 # define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0x07, 0x00, 0xff, 0xff, 0xff, 0xff
8279 # define NV_NAN_PAYLOAD_PERM 0x4, 0x5, 0x6, 0xFF, 0x0, 0x1, 0x2, 0x3
8280 # elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
8281 # define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0xff, 0xff, 0x00, 0x07, 0xff, 0xff
8282 # define NV_NAN_PAYLOAD_PERM 0x3, 0x2, 0x1, 0x0, 0xFF, 0x6, 0x5, 0x4
8284 # error "Unexpected double format"
8288 #endif /* DOUBLE_HAS_NAN */
8293 (KEEP THIS LAST IN perl.h!)
8335 so that Configure picks them up.
8337 (KEEP THIS LAST IN perl.h!)
8341 #endif /* Include guard */
8344 * ex: set ts=8 sts=4 sw=4 et: