This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
util.c: Comment fix-up
[perl5.git] / perl.h
CommitLineData
a0d0e21e 1/* perl.h
a687059c 2 *
1129b882 3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
5cd3f21a 4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
a687059c 5 *
352d5a3a
LW
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.
8d063cd8 8 *
8d063cd8 9 */
d6376244 10
85e6fe83
LW
11#ifndef H_PERL
12#define H_PERL 1
8d063cd8 13
760ac839
LW
14#ifdef PERL_FOR_X2P
15/*
d460ef45 16 * This file is being used for x2p stuff.
760ac839 17 * Above symbol is defined via -D in 'x2p/Makefile.SH'
d460ef45 18 * Decouple x2p stuff from some of perls more extreme eccentricities.
760ac839 19 */
55497cff 20#undef MULTIPLICITY
760ac839
LW
21#undef USE_STDIO
22#define USE_STDIO
23#endif /* PERL_FOR_X2P */
24
d460ef45 25#ifdef PERL_MICRO
12ae5dfc
JH
26# include "uconfig.h"
27#else
611cf957 28# include "config.h"
12ae5dfc 29#endif
0cb96387 30
70febf4f
CB
31/* this is used for functions which take a depth trailing
32 * argument under debugging */
33#ifdef DEBUGGING
34#define _pDEPTH ,U32 depth
35#define _aDEPTH ,depth
36#else
37#define _pDEPTH
38#define _aDEPTH
39#endif
40
7dc3eb73 41/* NOTE 1: that with gcc -std=c89 the __STDC_VERSION__ is *not* defined
9267464d 42 * because the __STDC_VERSION__ became a thing only with C90. Therefore,
7dc3eb73
JH
43 * with gcc, HAS_C99 will never become true as long as we use -std=c89.
44
45 * NOTE 2: headers lie. Do not expect that if HAS_C99 gets to be true,
46 * all the C99 features are there and are correct. */
9267464d 47#if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || \
996959af 48 defined(_STDC_C99) || defined(__c99)
86a3cabf 49# define HAS_C99 1
86a3cabf
JH
50#endif
51
2c2d71f5
JH
52/* See L<perlguts/"The Perl API"> for detailed notes on
53 * PERL_IMPLICIT_CONTEXT and PERL_IMPLICIT_SYS */
54
7ee02ac1 55/* XXX NOTE that from here --> to <-- the same logic is
ac6bedea
JH
56 * repeated in makedef.pl, so be certain to update
57 * both places when editing. */
58
6f4183fe 59#ifdef USE_ITHREADS
acfe0abc 60# if !defined(MULTIPLICITY)
6f4183fe
GS
61# define MULTIPLICITY
62# endif
63#endif
64
97aff369
JH
65#ifdef MULTIPLICITY
66# ifndef PERL_IMPLICIT_CONTEXT
67# define PERL_IMPLICIT_CONTEXT
68# endif
69#endif
70
026fd48b
GH
71/* undef WIN32 when building on Cygwin (for libwin32) - gph */
72#ifdef __CYGWIN__
73# undef WIN32
74# undef _WIN32
75#endif
76
dd134d2c 77/* Use the reentrant APIs like localtime_r and getpwent_r */
7ee02ac1
KW
78/* Win32 has naturally threadsafe libraries, no need to use any _r variants.
79 * XXX KEEP makedef.pl copy of this code in sync */
14795193 80#if defined(USE_ITHREADS) && !defined(USE_REENTRANT_API) && !defined(NETWARE) && !defined(WIN32)
10bc17b6
JH
81# define USE_REENTRANT_API
82#endif
83
ac6bedea
JH
84/* <--- here ends the logic shared by perl.h and makedef.pl */
85
cf5a8da6
MHM
86#undef START_EXTERN_C
87#undef END_EXTERN_C
88#undef EXTERN_C
89#ifdef __cplusplus
90# define START_EXTERN_C extern "C" {
91# define END_EXTERN_C }
92# define EXTERN_C extern "C"
93#else
94# define START_EXTERN_C
95# define END_EXTERN_C
96# define EXTERN_C extern
97#endif
98
17a6c8e3
AD
99/* Fallback definitions in case we don't have definitions from config.h.
100 This should only matter for systems that don't use Configure and
101 haven't been modified to define PERL_STATIC_INLINE yet.
102*/
103#if !defined(PERL_STATIC_INLINE)
104# ifdef HAS_STATIC_INLINE
105# define PERL_STATIC_INLINE static inline
106# else
107# define PERL_STATIC_INLINE static
108# endif
109#endif
110
f0e5c859
DD
111/* this used to be off by default, now its on, see perlio.h */
112#define PERLIO_FUNCS_CONST
113
c5be433b 114#ifdef PERL_IMPLICIT_CONTEXT
3db8f154
MB
115# ifndef MULTIPLICITY
116# define MULTIPLICITY
c5be433b 117# endif
e8dda941 118# define tTHX PerlInterpreter*
5aaab254 119# define pTHX tTHX my_perl PERL_UNUSED_DECL
3db8f154 120# define aTHX my_perl
9399a70c 121# define aTHXa(a) aTHX = (tTHX)a
8c3a0f6c
DIM
122# define dTHXa(a) pTHX = (tTHX)a
123# define dTHX pTHX = PERL_GET_THX
c5be433b 124# define pTHX_ pTHX,
c5be433b 125# define aTHX_ aTHX,
4373e329 126# define pTHX_1 2
894356b3
GS
127# define pTHX_2 3
128# define pTHX_3 4
129# define pTHX_4 5
4373e329
AL
130# define pTHX_5 6
131# define pTHX_6 7
a3b680e6
AL
132# define pTHX_7 8
133# define pTHX_8 9
134# define pTHX_9 10
a6fc70e5 135# define pTHX_12 13
e8dda941
JD
136# if defined(DEBUGGING) && !defined(PERL_TRACK_MEMPOOL)
137# define PERL_TRACK_MEMPOOL
138# endif
139#else
140# undef PERL_TRACK_MEMPOOL
c5be433b
GS
141#endif
142
2d17fb74
KW
143#ifdef DEBUGGING
144# define dTHX_DEBUGGING dTHX
145#else
146# define dTHX_DEBUGGING dNOOP
147#endif
148
76e3520e 149#define STATIC static
16c91539
BM
150
151#ifndef PERL_CORE
152/* Do not use these macros. They were part of PERL_OBJECT, which was an
153 * implementation of multiplicity using C++ objects. They have been left
154 * here solely for the sake of XS code which has incorrectly
155 * cargo-culted them.
156 */
76e3520e 157#define CPERLscope(x) x
565764a8 158#define CPERLarg void
76e3520e 159#define CPERLarg_
e3b8966e 160#define _CPERLarg
1d583055
GS
161#define PERL_OBJECT_THIS
162#define _PERL_OBJECT_THIS
163#define PERL_OBJECT_THIS_
312caa8e 164#define CALL_FPTR(fptr) (*fptr)
ef69c8fc 165#define MEMBER_TO_FPTR(name) name
16c91539 166#endif /* !PERL_CORE */
76e3520e 167
16c91539 168#define CALLRUNOPS PL_runops
f9f4320a 169
3ab4a224 170#define CALLREGCOMP(sv, flags) Perl_pregcomp(aTHX_ (sv),(flags))
f9f4320a 171
16c91539 172#define CALLREGCOMP_ENG(prog, sv, flags) (prog)->comp(aTHX_ sv, flags)
a340edde 173#define CALLREGEXEC(prog,stringarg,strend,strbeg,minend,sv,data,flags) \
16c91539 174 RX_ENGINE(prog)->exec(aTHX_ (prog),(stringarg),(strend), \
a340edde 175 (strbeg),(minend),(sv),(data),(flags))
52a21eb3
DM
176#define CALLREG_INTUIT_START(prog,sv,strbeg,strpos,strend,flags,data) \
177 RX_ENGINE(prog)->intuit(aTHX_ (prog), (sv), (strbeg), (strpos), \
f9f4320a
YO
178 (strend),(flags),(data))
179#define CALLREG_INTUIT_STRING(prog) \
16c91539 180 RX_ENGINE(prog)->checkstr(aTHX_ (prog))
f8149455 181
f8149455
YO
182#define CALLREGFREE(prog) \
183 Perl_pregfree(aTHX_ (prog))
184
185#define CALLREGFREE_PVT(prog) \
4c8117d3 186 if(prog && RX_ENGINE(prog)) RX_ENGINE(prog)->rxfree(aTHX_ (prog))
f8149455 187
2fdbfb4d 188#define CALLREG_NUMBUF_FETCH(rx,paren,usesv) \
16c91539 189 RX_ENGINE(rx)->numbered_buff_FETCH(aTHX_ (rx),(paren),(usesv))
93b32b6d 190
2fdbfb4d 191#define CALLREG_NUMBUF_STORE(rx,paren,value) \
16c91539 192 RX_ENGINE(rx)->numbered_buff_STORE(aTHX_ (rx),(paren),(value))
2fdbfb4d
AB
193
194#define CALLREG_NUMBUF_LENGTH(rx,sv,paren) \
16c91539 195 RX_ENGINE(rx)->numbered_buff_LENGTH(aTHX_ (rx),(sv),(paren))
2fdbfb4d 196
192b9cd1 197#define CALLREG_NAMED_BUFF_FETCH(rx, key, flags) \
16c91539 198 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_FETCH))
192b9cd1
AB
199
200#define CALLREG_NAMED_BUFF_STORE(rx, key, value, flags) \
16c91539 201 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), (value), ((flags) | RXapif_STORE))
192b9cd1
AB
202
203#define CALLREG_NAMED_BUFF_DELETE(rx, key, flags) \
16c91539 204 RX_ENGINE(rx)->named_buff(aTHX_ (rx),(key), NULL, ((flags) | RXapif_DELETE))
192b9cd1
AB
205
206#define CALLREG_NAMED_BUFF_CLEAR(rx, flags) \
16c91539 207 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_CLEAR))
192b9cd1
AB
208
209#define CALLREG_NAMED_BUFF_EXISTS(rx, key, flags) \
16c91539 210 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_EXISTS))
192b9cd1
AB
211
212#define CALLREG_NAMED_BUFF_FIRSTKEY(rx, flags) \
16c91539 213 RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), NULL, ((flags) | RXapif_FIRSTKEY))
192b9cd1
AB
214
215#define CALLREG_NAMED_BUFF_NEXTKEY(rx, lastkey, flags) \
16c91539 216 RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), (lastkey), ((flags) | RXapif_NEXTKEY))
192b9cd1
AB
217
218#define CALLREG_NAMED_BUFF_SCALAR(rx, flags) \
16c91539 219 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_SCALAR))
192b9cd1
AB
220
221#define CALLREG_NAMED_BUFF_COUNT(rx) \
16c91539 222 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, RXapif_REGNAMES_COUNT)
192b9cd1
AB
223
224#define CALLREG_NAMED_BUFF_ALL(rx, flags) \
16c91539 225 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, flags)
93b32b6d 226
49d7dfbc 227#define CALLREG_PACKAGE(rx) \
16c91539 228 RX_ENGINE(rx)->qr_package(aTHX_ (rx))
93b32b6d 229
00f254e2 230#if defined(USE_ITHREADS)
f9f4320a 231#define CALLREGDUPE(prog,param) \
f8149455
YO
232 Perl_re_dup(aTHX_ (prog),(param))
233
234#define CALLREGDUPE_PVT(prog,param) \
16c91539 235 (prog ? RX_ENGINE(prog)->dupe(aTHX_ (prog),(param)) \
00f254e2 236 : (REGEXP *)NULL)
f9f4320a 237#endif
14dd3ad8 238
bfde97e0
TK
239/* some compilers impersonate gcc */
240#if defined(__GNUC__) && !defined(__clang__) && !defined(__INTEL_COMPILER)
241# define PERL_IS_GCC 1
242#endif
243
09f0a348
TK
244/* In case Configure was not used (we are using a "canned config"
245 * such as Win32, or a cross-compilation setup, for example) try going
246 * by the gcc major and minor versions. One useful URL is
247 * http://www.ohse.de/uwe/articles/gcc-attributes.html,
248 * but contrary to this information warn_unused_result seems
249 * not to be in gcc 3.3.5, at least. --jhi
250 * Also, when building extensions with an installed perl, this allows
251 * the user to upgrade gcc and get the right attributes, rather than
252 * relying on the list generated at Configure time. --AD
253 * Set these up now otherwise we get confused when some of the <*thread.h>
254 * includes below indirectly pull in <perlio.h> (which needs to know if we
255 * have HASATTRIBUTE_FORMAT).
256 */
257
258#ifndef PERL_MICRO
259#if defined __GNUC__ && !defined(__INTEL_COMPILER)
260# if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
261# define HASATTRIBUTE_DEPRECATED
262# endif
263# if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
264# define HASATTRIBUTE_FORMAT
265# if defined __MINGW32__
266# define PRINTF_FORMAT_NULL_OK
267# endif
268# endif
269# if __GNUC__ >= 3 /* 3.0 -> */
270# define HASATTRIBUTE_MALLOC
271# endif
272# if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
273# define HASATTRIBUTE_NONNULL
274# endif
275# if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
276# define HASATTRIBUTE_NORETURN
277# endif
278# if __GNUC__ >= 3 /* gcc 3.0 -> */
279# define HASATTRIBUTE_PURE
280# endif
281# if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
282# define HASATTRIBUTE_UNUSED
283# endif
284# if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
285# define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
286# endif
287# if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
288# define HASATTRIBUTE_WARN_UNUSED_RESULT
289# endif
d7113604
TK
290/* always_inline is buggy in gcc <= 4.6 and causes compilation errors */
291# if __GNUC__ == 4 && __GNUC_MINOR__ >= 7 || __GNUC__ > 4 /* 4.7 -> */
f1e99d0d
TK
292# define HASATTRIBUTE_ALWAYS_INLINE
293# endif
09f0a348
TK
294#endif
295#endif /* #ifndef PERL_MICRO */
a20207d7 296
09f0a348
TK
297#ifdef HASATTRIBUTE_DEPRECATED
298# define __attribute__deprecated__ __attribute__((deprecated))
299#endif
300#ifdef HASATTRIBUTE_FORMAT
301# define __attribute__format__(x,y,z) __attribute__((format(x,y,z)))
302#endif
303#ifdef HASATTRIBUTE_MALLOC
304# define __attribute__malloc__ __attribute__((__malloc__))
305#endif
306#ifdef HASATTRIBUTE_NONNULL
307# define __attribute__nonnull__(a) __attribute__((nonnull(a)))
308#endif
309#ifdef HASATTRIBUTE_NORETURN
310# define __attribute__noreturn__ __attribute__((noreturn))
311#endif
312#ifdef HASATTRIBUTE_PURE
313# define __attribute__pure__ __attribute__((pure))
314#endif
315#ifdef HASATTRIBUTE_UNUSED
316# define __attribute__unused__ __attribute__((unused))
317#endif
318#ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
319# define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
320#endif
f1e99d0d 321#ifdef HASATTRIBUTE_ALWAYS_INLINE
d7113604 322/* always_inline is buggy in gcc <= 4.6 and causes compilation errors */
bfde97e0 323# if !defined(PERL_IS_GCC) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7 || __GNUC__ > 4)
d7113604
TK
324# define __attribute__always_inline__ __attribute__((always_inline))
325# endif
f1e99d0d 326#endif
bcdf7404 327
09f0a348
TK
328/* If we haven't defined the attributes yet, define them to blank. */
329#ifndef __attribute__deprecated__
330# define __attribute__deprecated__
331#endif
332#ifndef __attribute__format__
333# define __attribute__format__(x,y,z)
334#endif
335#ifndef __attribute__malloc__
336# define __attribute__malloc__
337#endif
338#ifndef __attribute__nonnull__
339# define __attribute__nonnull__(a)
340#endif
341#ifndef __attribute__noreturn__
342# define __attribute__noreturn__
343#endif
344#ifndef __attribute__pure__
345# define __attribute__pure__
346#endif
347#ifndef __attribute__unused__
348# define __attribute__unused__
349#endif
350#ifndef __attribute__warn_unused_result__
351# define __attribute__warn_unused_result__
352#endif
f1e99d0d
TK
353#ifndef __attribute__always_inline__
354# define __attribute__always_inline__
355#endif
a20207d7 356
09f0a348
TK
357/* Some OS warn on NULL format to printf */
358#ifdef PRINTF_FORMAT_NULL_OK
359# define __attribute__format__null_ok__(x,y,z) __attribute__format__(x,y,z)
360#else
361# define __attribute__format__null_ok__(x,y,z)
362#endif
a20207d7 363
5ba4cab2
SH
364/*
365 * Because of backward compatibility reasons the PERL_UNUSED_DECL
366 * cannot be changed from postfix to PERL_UNUSED_DECL(x). Sigh.
367 *
368 * Note that there are C compilers such as MetroWerks CodeWarrior
1266ad8c 369 * which do not have an "inlined" way (like the gcc __attribute__) of
5ba4cab2
SH
370 * marking unused variables (they need e.g. a #pragma) and therefore
371 * cpp macros like PERL_UNUSED_DECL cannot work for this purpose, even
372 * if it were PERL_UNUSED_DECL(x), which it cannot be (see above).
373 *
374 */
1266ad8c 375
5b2bd0a5 376#ifndef PERL_UNUSED_DECL
09f0a348 377# define PERL_UNUSED_DECL __attribute__unused__
5b2bd0a5 378#endif
00f254e2 379
349b520e
DM
380/* gcc -Wall:
381 * for silencing unused variables that are actually used most of the time,
a730e3f2
JH
382 * but we cannot quite get rid of, such as "ax" in PPCODE+noargs xsubs,
383 * or variables/arguments that are used only in certain configurations.
fd2362a2
KW
384
385=head1 Miscellaneous Functions
386
387=for apidoc Am||PERL_UNUSED_ARG|void x
388This is used to suppress compiler warnings that a parameter to a function is
389not used. This situation can arise, for example, when a parameter is needed
390under some configuration conditions, but not others, so that C preprocessor
391conditional compilation causes it be used just some times.
392
393=for apidoc Amn||PERL_UNUSED_CONTEXT
394This is used to suppress compiler warnings that the thread context parameter to
395a function is not used. This situation can arise, for example, when a
396C preprocessor conditional compilation causes it be used just some times.
397
398=for apidoc Am||PERL_UNUSED_VAR|void x
399This is used to suppress compiler warnings that the variable I<x> is not used.
400This situation can arise, for example, when a C preprocessor conditional
401compilation causes it be used just some times.
402
403=cut
349b520e 404 */
53c1dcc0 405#ifndef PERL_UNUSED_ARG
c707756e 406# define PERL_UNUSED_ARG(x) ((void)sizeof(x))
ad73156c 407#endif
53c1dcc0 408#ifndef PERL_UNUSED_VAR
a730e3f2 409# define PERL_UNUSED_VAR(x) ((void)sizeof(x))
53c1dcc0 410#endif
ad73156c 411
8c3a0f6c 412#if defined(USE_ITHREADS)
96a5add6
AL
413# define PERL_UNUSED_CONTEXT PERL_UNUSED_ARG(my_perl)
414#else
415# define PERL_UNUSED_CONTEXT
416#endif
417
24e7ff4e
JH
418/* gcc (-ansi) -pedantic doesn't allow gcc statement expressions,
419 * g++ allows them but seems to have problems with them
420 * (insane errors ensue).
421 * g++ does not give insane errors now (RMB 2008-01-30, gcc 4.2.2).
422 */
423#if defined(PERL_GCC_PEDANTIC) || \
424 (defined(__GNUC__) && defined(__cplusplus) && \
425 ((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2))))
426# ifndef PERL_GCC_BRACE_GROUPS_FORBIDDEN
427# define PERL_GCC_BRACE_GROUPS_FORBIDDEN
428# endif
429#endif
430
fd2362a2
KW
431/*
432
433=for apidoc Am||PERL_UNUSED_RESULT|void x
434
435This macro indicates to discard the return value of the function call inside
00b72c9f 436it, I<e.g.>,
fd2362a2
KW
437
438 PERL_UNUSED_RESULT(foo(a, b))
439
00b72c9f
KW
440The main reason for this is that the combination of C<gcc -Wunused-result>
441(part of C<-Wall>) and the C<__attribute__((warn_unused_result))> cannot
442be silenced with casting to C<void>. This causes trouble when the system
fd2362a2
KW
443header files use the attribute.
444
445Use C<PERL_UNUSED_RESULT> sparingly, though, since usually the warning
446is there for a good reason: you might lose success/failure information,
447or leak resources, or changes in resources.
448
00b72c9f 449But sometimes you just want to ignore the return value, I<e.g.>, on
fd2362a2
KW
450codepaths soon ending up in abort, or in "best effort" attempts,
451or in situations where there is no good way to handle failures.
452
453Sometimes C<PERL_UNUSED_RESULT> might not be the most natural way:
454another possibility is that you can capture the return value
455and use C<L</PERL_UNUSED_VAR>> on that.
456
457=cut
458
459The __typeof__() is used instead of typeof() since typeof() is not
460available under strict C89, and because of compilers masquerading
461as gcc (clang and icc), we want exactly the gcc extension
462__typeof__ and nothing else.
463
464*/
ffea512f 465#ifndef PERL_UNUSED_RESULT
b469f1e0
JH
466# if defined(__GNUC__) && defined(HASATTRIBUTE_WARN_UNUSED_RESULT)
467# define PERL_UNUSED_RESULT(v) STMT_START { __typeof__(v) z = (v); (void)sizeof(z); } STMT_END
ffea512f
JH
468# else
469# define PERL_UNUSED_RESULT(v) ((void)(v))
470# endif
471#endif
472
e7ae132e
KW
473#if defined(_MSC_VER)
474/* XXX older MSVC versions have a smallish macro buffer */
475#define PERL_SMALL_MACRO_BUFFER
476#endif
477
b56aac20
DM
478/* on gcc (and clang), specify that a warning should be temporarily
479 * ignored; e.g.
480 *
7347ee54 481 * GCC_DIAG_IGNORE_DECL(-Wmultichar);
b56aac20 482 * char b = 'ab';
7347ee54 483 * GCC_DIAG_RESTORE_DECL;
b56aac20
DM
484 *
485 * based on http://dbp-consulting.com/tutorials/SuppressingGCCWarnings.html
486 *
487 * Note that "pragma GCC diagnostic push/pop" was added in GCC 4.6, Mar 2011;
488 * clang only pretends to be GCC 4.2, but still supports push/pop.
c1d6452f 489 *
7347ee54
Z
490 * Note on usage: all macros must be used at a place where a declaration
491 * or statement can occur, i.e., not in the middle of an expression.
492 * *_DIAG_IGNORE() and *_DIAG_RESTORE can be used in any such place, but
493 * must be used without a following semicolon. *_DIAG_IGNORE_DECL() and
494 * *_DIAG_RESTORE_DECL must be used with a following semicolon, and behave
495 * syntactically as declarations (like dNOOP). *_DIAG_IGNORE_STMT()
496 * and *_DIAG_RESTORE_STMT must be used with a following semicolon,
497 * and behave syntactically as statements (like NOOP).
c1d6452f 498 *
b56aac20
DM
499 */
500
57d4b8c5 501#if defined(__clang__) || defined(__clang) || \
d28ce8b4 502 (defined( __GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406)
c1d6452f
JH
503# define GCC_DIAG_PRAGMA(x) _Pragma (#x)
504/* clang has "clang diagnostic" pragmas, but also understands gcc. */
b56aac20 505# define GCC_DIAG_IGNORE(x) _Pragma("GCC diagnostic push") \
c1d6452f 506 GCC_DIAG_PRAGMA(GCC diagnostic ignored #x)
b56aac20
DM
507# define GCC_DIAG_RESTORE _Pragma("GCC diagnostic pop")
508#else
8ce6f80a
JH
509# define GCC_DIAG_IGNORE(w)
510# define GCC_DIAG_RESTORE
b56aac20 511#endif
7347ee54
Z
512#define GCC_DIAG_IGNORE_DECL(x) GCC_DIAG_IGNORE(x) dNOOP
513#define GCC_DIAG_RESTORE_DECL GCC_DIAG_RESTORE dNOOP
514#define GCC_DIAG_IGNORE_STMT(x) GCC_DIAG_IGNORE(x) NOOP
515#define GCC_DIAG_RESTORE_STMT GCC_DIAG_RESTORE NOOP
337458b1
JH
516/* for clang specific pragmas */
517#if defined(__clang__) || defined(__clang)
518# define CLANG_DIAG_PRAGMA(x) _Pragma (#x)
519# define CLANG_DIAG_IGNORE(x) _Pragma("clang diagnostic push") \
520 CLANG_DIAG_PRAGMA(clang diagnostic ignored #x)
521# define CLANG_DIAG_RESTORE _Pragma("clang diagnostic pop")
522#else
523# define CLANG_DIAG_IGNORE(w)
524# define CLANG_DIAG_RESTORE
525#endif
7347ee54
Z
526#define CLANG_DIAG_IGNORE_DECL(x) CLANG_DIAG_IGNORE(x) dNOOP
527#define CLANG_DIAG_RESTORE_DECL CLANG_DIAG_RESTORE dNOOP
528#define CLANG_DIAG_IGNORE_STMT(x) CLANG_DIAG_IGNORE(x) NOOP
529#define CLANG_DIAG_RESTORE_STMT CLANG_DIAG_RESTORE NOOP
b56aac20 530
6879a07b
TK
531#if defined(_MSC_VER) && (_MSC_VER >= 1300)
532# define MSVC_DIAG_IGNORE(x) __pragma(warning(push)) \
533 __pragma(warning(disable : x))
534# define MSVC_DIAG_RESTORE __pragma(warning(pop))
535#else
536# define MSVC_DIAG_IGNORE(x)
537# define MSVC_DIAG_RESTORE
538#endif
539#define MSVC_DIAG_IGNORE_DECL(x) MSVC_DIAG_IGNORE(x) dNOOP
540#define MSVC_DIAG_RESTORE_DECL MSVC_DIAG_RESTORE dNOOP
541#define MSVC_DIAG_IGNORE_STMT(x) MSVC_DIAG_IGNORE(x) NOOP
542#define MSVC_DIAG_RESTORE_STMT MSVC_DIAG_RESTORE NOOP
543
6f207bd3 544#define NOOP /*EMPTY*/(void)0
91ca80c3 545#define dNOOP struct Perl___notused_struct
71be2cbc 546
0cb96387 547#ifndef pTHX
a78adc84 548/* Don't bother defining tTHX ; using it outside
e8dda941
JD
549 * code guarded by PERL_IMPLICIT_CONTEXT is an error.
550 */
0cb96387
GS
551# define pTHX void
552# define pTHX_
0cb96387
GS
553# define aTHX
554# define aTHX_
9399a70c 555# define aTHXa(a) NOOP
0cb96387
GS
556# define dTHXa(a) dNOOP
557# define dTHX dNOOP
894356b3
GS
558# define pTHX_1 1
559# define pTHX_2 2
560# define pTHX_3 3
561# define pTHX_4 4
3d42dc86
RGS
562# define pTHX_5 5
563# define pTHX_6 6
a3b680e6
AL
564# define pTHX_7 7
565# define pTHX_8 8
566# define pTHX_9 9
a6fc70e5 567# define pTHX_12 12
0cb96387
GS
568#endif
569
c91f661c
DIM
570#ifndef PERL_CORE
571/* Backwards compatibility macro for XS code. It used to be part of
572 * the PERL_GLOBAL_STRUCT(_PRIVATE) feature, which no longer exists */
27da23d5
JH
573# define dVAR dNOOP
574#endif
575
b4f7f263
GS
576/* these are only defined for compatibility; should not be used internally */
577#if !defined(pTHXo) && !defined(PERL_CORE)
0cb96387
GS
578# define pTHXo pTHX
579# define pTHXo_ pTHX_
0cb96387
GS
580# define aTHXo aTHX
581# define aTHXo_ aTHX_
c5be433b 582# define dTHXo dTHX
71d280e3 583# define dTHXoa(x) dTHXa(x)
0cb96387
GS
584#endif
585
586#ifndef pTHXx
5aaab254 587# define pTHXx PerlInterpreter *my_perl
0cb96387 588# define pTHXx_ pTHXx,
0cb96387
GS
589# define aTHXx my_perl
590# define aTHXx_ aTHXx,
c5be433b 591# define dTHXx dTHX
22c35a8c 592#endif
71be2cbc 593
1de7c2ac
GS
594/* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
595 * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
596 * dTHXs is therefore needed for all functions using PerlIO_foo(). */
597#ifdef PERL_IMPLICIT_SYS
27da23d5 598# define dTHXs dTHX
1de7c2ac 599#else
27da23d5 600# define dTHXs dNOOP
1de7c2ac
GS
601#endif
602
5b692037
JH
603#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
604# ifndef PERL_USE_GCC_BRACE_GROUPS
605# define PERL_USE_GCC_BRACE_GROUPS
606# endif
607#endif
608
728e2803 609/*
16a2918c
KW
610=head1 Miscellaneous Functions
611
612=for apidoc AmnUu|void|STMT_START
613
614 STMT_START { statements; } STMT_END;
615
616can be used as a single statement, as in
617
618 if (x) STMT_START { ... } STMT_END; else ...
619
620These are often used in macro definitions. Note that you can't return a value
621out of them.
622
623=for apidoc AmnUhu|void|STMT_END
624
625=cut
626
627 Trying to select a version that gives no warnings...
628*/
728e2803 629#if !(defined(STMT_START) && defined(STMT_END))
5b692037 630# ifdef PERL_USE_GCC_BRACE_GROUPS
a0288114 631# define STMT_START (void)( /* gcc supports "({ STATEMENTS; })" */
728e2803
PP
632# define STMT_END )
633# else
728e2803
PP
634# define STMT_START do
635# define STMT_END while (0)
728e2803
PP
636# endif
637#endif
638
d6f9c181
JH
639#ifndef BYTEORDER /* Should never happen -- byteorder is in config.h */
640# define BYTEORDER 0x1234
79072805
LW
641#endif
642
8ada0baa
JH
643#if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
644#define ASCIIish
645#else
646#undef ASCIIish
647#endif
648
79072805
LW
649/*
650 * The following contortions are brought to you on behalf of all the
651 * standards, semi-standards, de facto standards, not-so-de-facto standards
652 * of the world, as well as all the other botches anyone ever thought of.
653 * The basic theory is that if we work hard enough here, the rest of the
654 * code can be a lot prettier. Well, so much for theory. Sorry, Henry...
655 */
ac58e20f 656
ee0007ab 657/* define this once if either system, instead of cluttering up the src */
7c458fae 658#if defined(MSDOS) || defined(WIN32) || defined(NETWARE)
ee0007ab
LW
659#define DOSISH 1
660#endif
661
3d97541c 662/* These exist only for back-compat with XS modules. */
8162b70e 663#ifndef PERL_CORE
516e10a9 664#define VOL volatile
3d97541c 665#define CAN_PROTOTYPE
ae75e3d0 666#define _(args) args
6c2ae642 667#define I_LIMITS
36a113ce 668#define I_STDARG
6c2ae642 669#define STANDARD_C
8162b70e 670#endif
663a0e37 671
284167a5
SM
672/* By compiling a perl with -DNO_TAINT_SUPPORT or -DSILENT_NO_TAINT_SUPPORT,
673 * you get a perl without taint support, but doubtlessly with a lesser
674 * degree of support. Do not do so unless you know exactly what it means
675 * technically, have a good reason to do so, and know exactly how the
676 * perl will be used. perls with -DSILENT_NO_TAINT_SUPPORT are considered
677 * a potential security risk due to flat out ignoring the security-relevant
678 * taint flags. This being said, a perl without taint support compiled in
679 * has marginal run-time performance benefits.
680 * SILENT_NO_TAINT_SUPPORT implies NO_TAINT_SUPPORT.
681 * SILENT_NO_TAINT_SUPPORT is the same as NO_TAINT_SUPPORT except it
682 * silently ignores -t/-T instead of throwing an exception.
053a3618
SM
683 *
684 * DANGER! Using NO_TAINT_SUPPORT or SILENT_NO_TAINT_SUPPORT
6ecb40c7 685 * voids your nonexistent warranty!
284167a5 686 */
dc6d7f5c 687#if defined(SILENT_NO_TAINT_SUPPORT) && !defined(NO_TAINT_SUPPORT)
284167a5
SM
688# define NO_TAINT_SUPPORT 1
689#endif
690
691/* NO_TAINT_SUPPORT can be set to transform virtually all taint-related
692 * operations into no-ops for a very modest speed-up. Enable only if you
693 * know what you're doing: tests and CPAN modules' tests are bound to fail.
694 */
dc6d7f5c 695#ifdef NO_TAINT_SUPPORT
284167a5
SM
696# define TAINT NOOP
697# define TAINT_NOT NOOP
698# define TAINT_IF(c) NOOP
699# define TAINT_ENV() NOOP
700# define TAINT_PROPER(s) NOOP
701# define TAINT_set(s) NOOP
702# define TAINT_get 0
703# define TAINTING_get 0
704# define TAINTING_set(s) NOOP
705# define TAINT_WARN_get 0
706# define TAINT_WARN_set(s) NOOP
707#else
bc2f1ca1 708 /* Set to tainted if we are running under tainting mode */
d48c660d 709# define TAINT (PL_tainted = PL_tainting)
bc2f1ca1
KW
710
711# define TAINT_NOT (PL_tainted = FALSE) /* Untaint */
712# define TAINT_IF(c) if (UNLIKELY(c)) { TAINT; } /* Conditionally taint */
2439e033 713# define TAINT_ENV() if (UNLIKELY(PL_tainting)) { taint_env(); }
bc2f1ca1
KW
714 /* croak or warn if tainting */
715# define TAINT_PROPER(s) if (UNLIKELY(PL_tainting)) { \
716 taint_proper(NULL, s); \
717 }
284167a5 718# define TAINT_set(s) (PL_tainted = (s))
ea42b70b
TC
719# define TAINT_get (cBOOL(UNLIKELY(PL_tainted))) /* Is something tainted? */
720# define TAINTING_get (cBOOL(UNLIKELY(PL_tainting))) /* Is taint checking enabled? */
284167a5 721# define TAINTING_set(s) (PL_tainting = (s))
bc2f1ca1
KW
722# define TAINT_WARN_get (PL_taint_warn) /* FALSE => tainting violations
723 are fatal
724 TRUE => they're just
725 warnings */
284167a5
SM
726# define TAINT_WARN_set(s) (PL_taint_warn = (s))
727#endif
a687059c 728
20be6587
DM
729/* flags used internally only within pp_subst and pp_substcont */
730#ifdef PERL_CORE
731# define SUBST_TAINT_STR 1 /* string tainted */
732# define SUBST_TAINT_PAT 2 /* pattern tainted */
733# define SUBST_TAINT_REPL 4 /* replacement tainted */
734# define SUBST_TAINT_RETAINT 8 /* use re'taint' in scope */
735# define SUBST_TAINT_BOOLRET 16 /* return is boolean (don't taint) */
736#endif
737
d460ef45 738/* XXX All process group stuff is handled in pp_sys.c. Should these
a6e633de
PP
739 defines move there? If so, I could simplify this a lot. --AD 9/96.
740*/
741/* Process group stuff changed from traditional BSD to POSIX.
742 perlfunc.pod documents the traditional BSD-style syntax, so we'll
743 try to preserve that, if possible.
744*/
745#ifdef HAS_SETPGID
746# define BSD_SETPGRP(pid, pgrp) setpgid((pid), (pgrp))
da5fdda8
AC
747#elif defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
748# define BSD_SETPGRP(pid, pgrp) setpgrp((pid), (pgrp))
749#elif defined(HAS_SETPGRP2)
750# define BSD_SETPGRP(pid, pgrp) setpgrp2((pid), (pgrp))
a6e633de
PP
751#endif
752#if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
753# define HAS_SETPGRP /* Well, effectively it does . . . */
754#endif
755
756/* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
757 our life easier :-) so we'll try it.
758*/
759#ifdef HAS_GETPGID
760# define BSD_GETPGRP(pid) getpgid((pid))
da5fdda8
AC
761#elif defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
762# define BSD_GETPGRP(pid) getpgrp((pid))
763#elif defined(HAS_GETPGRP2)
764# define BSD_GETPGRP(pid) getpgrp2((pid))
a6e633de
PP
765#endif
766#if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
767# define HAS_GETPGRP /* Well, effectively it does . . . */
768#endif
769
d460ef45 770/* These are not exact synonyms, since setpgrp() and getpgrp() may
a6e633de
PP
771 have different behaviors, but perl.h used to define USE_BSDPGRP
772 (prior to 5.003_05) so some extension might depend on it.
773*/
774#if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
775# ifndef USE_BSDPGRP
776# define USE_BSDPGRP
777# endif
663a0e37
LW
778#endif
779
486ec47a 780/* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
8ac5a1fe
MH
781 pthread.h must be included before all other header files.
782*/
3db8f154 783#if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
8ac5a1fe
MH
784# include <pthread.h>
785#endif
786
58ab9e8b 787#include <sys/types.h>
663a0e37 788
d2c9cb53
KW
789# ifdef I_WCHAR
790# include <wchar.h>
791# endif
792
9d82a2b7 793# include <stdarg.h>
760ac839 794
27db2737
JH
795#ifdef I_STDINT
796# include <stdint.h>
797#endif
798
fe14fcc3 799#include <ctype.h>
63b481b9
AC
800#include <float.h>
801#include <limits.h>
a0d0e21e
LW
802
803#ifdef METHOD /* Defined by OSF/1 v3.0 by ctype.h */
804#undef METHOD
a0d0e21e
LW
805#endif
806
12ae5dfc
JH
807#ifdef PERL_MICRO
808# define NO_LOCALE
809#endif
810
4633a7c4 811#ifdef I_LOCALE
36477c24 812# include <locale.h>
4633a7c4
LW
813#endif
814
6ebbc862
KW
815#ifdef I_XLOCALE
816# include <xlocale.h>
817#endif
818
aa8a2baa
KW
819/* If not forbidden, we enable locale handling if either 1) the POSIX 2008
820 * functions are available, or 2) just the setlocale() function. This logic is
821 * repeated in t/loc_tools.pl and makedef.pl; The three should be kept in
822 * sync. */
823#if ! defined(NO_LOCALE)
824
825# if ! defined(NO_POSIX_2008_LOCALE) \
826 && defined(HAS_NEWLOCALE) \
827 && defined(HAS_USELOCALE) \
828 && defined(HAS_DUPLOCALE) \
829 && defined(HAS_FREELOCALE) \
830 && defined(LC_ALL_MASK)
831
832 /* For simplicity, the code is written to assume that any platform advanced
833 * enough to have the Posix 2008 locale functions has LC_ALL. The final
834 * test above makes sure that assumption is valid */
835
836# define HAS_POSIX_2008_LOCALE
837# define USE_LOCALE
838# elif defined(HAS_SETLOCALE)
839# define USE_LOCALE
840# endif
841#endif
842
843#ifdef USE_LOCALE
ccd65d51 844# define HAS_SKIP_LOCALE_INIT /* Solely for XS code to test for this
af573503 845 #define */
36477c24
PP
846# if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
847 && defined(HAS_STRXFRM)
848# define USE_LOCALE_COLLATE
849# endif
850# if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
851# define USE_LOCALE_CTYPE
852# endif
853# if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
854# define USE_LOCALE_NUMERIC
855# endif
fa9b773e
KW
856# if !defined(NO_LOCALE_MESSAGES) && defined(LC_MESSAGES)
857# define USE_LOCALE_MESSAGES
858# endif
859# if !defined(NO_LOCALE_MONETARY) && defined(LC_MONETARY)
860# define USE_LOCALE_MONETARY
861# endif
56e45410
KW
862# if !defined(NO_LOCALE_TIME) && defined(LC_TIME)
863# define USE_LOCALE_TIME
864# endif
9821811f
KW
865# if !defined(NO_LOCALE_ADDRESS) && defined(LC_ADDRESS)
866# define USE_LOCALE_ADDRESS
867# endif
868# if !defined(NO_LOCALE_IDENTIFICATION) && defined(LC_IDENTIFICATION)
869# define USE_LOCALE_IDENTIFICATION
870# endif
871# if !defined(NO_LOCALE_MEASUREMENT) && defined(LC_MEASUREMENT)
872# define USE_LOCALE_MEASUREMENT
873# endif
874# if !defined(NO_LOCALE_PAPER) && defined(LC_PAPER)
875# define USE_LOCALE_PAPER
876# endif
877# if !defined(NO_LOCALE_TELEPHONE) && defined(LC_TELEPHONE)
878# define USE_LOCALE_TELEPHONE
879# endif
36dbc955
KW
880# if !defined(NO_LOCALE_SYNTAX) && defined(LC_SYNTAX)
881# define USE_LOCALE_SYNTAX
882# endif
883# if !defined(NO_LOCALE_TOD) && defined(LC_TOD)
884# define USE_LOCALE_TOD
885# endif
a0d0e21e 886
5a53bf38
KW
887/* XXX The next few defines are unfortunately duplicated in makedef.pl, and
888 * changes here MUST also be made there */
889
aa8a2baa
KW
890# if ! defined(HAS_SETLOCALE) && defined(HAS_POSIX_2008_LOCALE)
891# define USE_POSIX_2008_LOCALE
892# ifndef USE_THREAD_SAFE_LOCALE
893# define USE_THREAD_SAFE_LOCALE
894# endif
e1895adc
KW
895 /* If compiled with
896 * -DUSE_THREAD_SAFE_LOCALE, will do so even
897 * on unthreaded builds */
aa8a2baa
KW
898# elif (defined(USE_ITHREADS) || defined(USE_THREAD_SAFE_LOCALE)) \
899 && ( defined(HAS_POSIX_2008_LOCALE) \
900 || (defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1400)) \
901 && ! defined(NO_THREAD_SAFE_LOCALE)
e1895adc
KW
902# ifndef USE_THREAD_SAFE_LOCALE
903# define USE_THREAD_SAFE_LOCALE
904# endif
e9bc6d6b
KW
905# ifdef HAS_POSIX_2008_LOCALE
906# define USE_POSIX_2008_LOCALE
907# endif
908# endif
7f9e9632
KW
909#endif
910
69c5e0db
KW
911/* Microsoft documentation reads in the change log for VS 2015:
912 * "The localeconv function declared in locale.h now works correctly when
913 * per-thread locale is enabled. In previous versions of the library, this
914 * function would return the lconv data for the global locale, not the
915 * thread's locale."
916 */
917#if defined(WIN32) && defined(USE_THREAD_SAFE_LOCALE) && _MSC_VER < 1900
918# define TS_W32_BROKEN_LOCALECONV
919#endif
920
fe14fcc3 921#include <setjmp.h>
79072805 922
a0d0e21e 923#ifdef I_SYS_PARAM
79072805
LW
924# ifdef PARAM_NEEDS_TYPES
925# include <sys/types.h>
926# endif
927# include <sys/param.h>
352d5a3a 928#endif
79072805 929
ce3470dc
AD
930/* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
931 value something like 199306. This may be useful if no more-specific
932 feature test is available.
933*/
934#if defined(BSD)
935# ifndef BSDish
936# define BSDish
937# endif
938#endif
939
dd512de3
AC
940/* Use all the "standard" definitions */
941#include <stdlib.h>
03a14243 942
3f270f98
JH
943/* If this causes problems, set i_unistd=undef in the hint file. */
944#ifdef I_UNISTD
763ee752
AB
945# if defined(__amigaos4__)
946# ifdef I_NETINET_IN
947# include <netinet/in.h>
948# endif
949# endif
3f270f98 950# include <unistd.h>
6e3136a6
AB
951# if defined(__amigaos4__)
952/* Under AmigaOS 4 newlib.library provides an environ. However using
953 * it doesn't give us enough control over inheritance of variables by
954 * subshells etc. so replace with custom version based on abc-shell
955 * code. */
956extern char **myenviron;
957# undef environ
958# define environ myenviron
959# endif
3f270f98
JH
960#endif
961
de8ca8af
NT
962/* for WCOREDUMP */
963#ifdef I_SYS_WAIT
964# include <sys/wait.h>
965#endif
966
21e89b5f 967#if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
c45598c5 968EXTERN_C int syscall(int, ...);
2ef53570
JH
969#endif
970
21e89b5f 971#if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
c45598c5 972EXTERN_C int usleep(unsigned int);
2ef53570
JH
973#endif
974
f2f9e01d
KW
975/* macros for correct constant construction. These are in C99 <stdint.h>
976 * (so they will not be available in strict C89 mode), but they are nice, so
977 * let's define them if necessary. */
978#ifndef UINT16_C
979# if INTSIZE >= 2
980# define UINT16_C(x) ((U16_TYPE)x##U)
981# else
982# define UINT16_C(x) ((U16_TYPE)x##UL)
983# endif
984#endif
1109a392 985
f2f9e01d
KW
986#ifndef UINT32_C
987# if INTSIZE >= 4
988# define UINT32_C(x) ((U32_TYPE)x##U)
989# else
990# define UINT32_C(x) ((U32_TYPE)x##UL)
991# endif
992#endif
1109a392 993
f2f9e01d
KW
994#ifdef I_STDINT
995 typedef intmax_t PERL_INTMAX_T;
996 typedef uintmax_t PERL_UINTMAX_T;
997#endif
998
999/* N.B. We use QUADKIND here instead of HAS_QUAD here, because that doesn't
1000 * actually mean what it has always been documented to mean (see RT #119753)
1001 * and is explicitly turned off outside of core with dire warnings about
1002 * removing the undef. */
1003
1004#if defined(QUADKIND)
1005# undef PeRl_INT64_C
1006# undef PeRl_UINT64_C
1007/* Prefer the native integer types (int and long) over long long
1008 * (which is not C89) and Win32-specific __int64. */
1009# if QUADKIND == QUAD_IS_INT && INTSIZE == 8
1010# define PeRl_INT64_C(c) (c)
1011# define PeRl_UINT64_C(c) CAT2(c,U)
1012# endif
1013# if QUADKIND == QUAD_IS_LONG && LONGSIZE == 8
1014# define PeRl_INT64_C(c) CAT2(c,L)
1015# define PeRl_UINT64_C(c) CAT2(c,UL)
1016# endif
1017# if QUADKIND == QUAD_IS_LONG_LONG && defined(HAS_LONG_LONG)
1018# define PeRl_INT64_C(c) CAT2(c,LL)
1019# define PeRl_UINT64_C(c) CAT2(c,ULL)
1020# endif
1021# if QUADKIND == QUAD_IS___INT64
1022# define PeRl_INT64_C(c) CAT2(c,I64)
1023# define PeRl_UINT64_C(c) CAT2(c,UI64)
1024# endif
1025# ifndef PeRl_INT64_C
1026# define PeRl_INT64_C(c) ((I64)(c)) /* last resort */
1027# define PeRl_UINT64_C(c) ((U64TYPE)(c))
1028# endif
1029/* In OS X the INT64_C/UINT64_C are defined with LL/ULL, which will
1030 * not fly with C89-pedantic gcc, so let's undefine them first so that
1031 * we can redefine them with our native integer preferring versions. */
1032# if defined(PERL_DARWIN) && defined(PERL_GCC_PEDANTIC)
1033# undef INT64_C
1034# undef UINT64_C
1035# endif
1036# ifndef INT64_C
1037# define INT64_C(c) PeRl_INT64_C(c)
1038# endif
1039# ifndef UINT64_C
1040# define UINT64_C(c) PeRl_UINT64_C(c)
1041# endif
1109a392 1042
f2f9e01d
KW
1043# ifndef I_STDINT
1044 typedef I64TYPE PERL_INTMAX_T;
1045 typedef U64TYPE PERL_UINTMAX_T;
1109a392 1046# endif
f2f9e01d
KW
1047# ifndef INTMAX_C
1048# define INTMAX_C(c) INT64_C(c)
1049# endif
1050# ifndef UINTMAX_C
1051# define UINTMAX_C(c) UINT64_C(c)
1052# endif
1053
1054#else /* below QUADKIND is undefined */
1055
1056/* Perl doesn't work on 16 bit systems, so must be 32 bit */
1057# ifndef I_STDINT
1058 typedef I32TYPE PERL_INTMAX_T;
1059 typedef U32TYPE PERL_UINTMAX_T;
1060# endif
1061# ifndef INTMAX_C
1062# define INTMAX_C(c) INT32_C(c)
1063# endif
1064# ifndef UINTMAX_C
1065# define UINTMAX_C(c) UINT32_C(c)
1066# endif
1067
1068#endif /* no QUADKIND */
1069
1070#ifdef PERL_CORE
1109a392
MHM
1071
1072/* byte-swapping functions for big-/little-endian conversion */
1073# define _swab_16_(x) ((U16)( \
f2f9e01d
KW
1074 (((U16)(x) & UINT16_C(0x00ff)) << 8) | \
1075 (((U16)(x) & UINT16_C(0xff00)) >> 8) ))
1109a392
MHM
1076
1077# define _swab_32_(x) ((U32)( \
f2f9e01d
KW
1078 (((U32)(x) & UINT32_C(0x000000ff)) << 24) | \
1079 (((U32)(x) & UINT32_C(0x0000ff00)) << 8) | \
1080 (((U32)(x) & UINT32_C(0x00ff0000)) >> 8) | \
1081 (((U32)(x) & UINT32_C(0xff000000)) >> 24) ))
1109a392
MHM
1082
1083# ifdef HAS_QUAD
1084# define _swab_64_(x) ((U64)( \
f2f9e01d
KW
1085 (((U64)(x) & UINT64_C(0x00000000000000ff)) << 56) | \
1086 (((U64)(x) & UINT64_C(0x000000000000ff00)) << 40) | \
1087 (((U64)(x) & UINT64_C(0x0000000000ff0000)) << 24) | \
1088 (((U64)(x) & UINT64_C(0x00000000ff000000)) << 8) | \
1089 (((U64)(x) & UINT64_C(0x000000ff00000000)) >> 8) | \
1090 (((U64)(x) & UINT64_C(0x0000ff0000000000)) >> 24) | \
1091 (((U64)(x) & UINT64_C(0x00ff000000000000)) >> 40) | \
1092 (((U64)(x) & UINT64_C(0xff00000000000000)) >> 56) ))
1109a392
MHM
1093# endif
1094
9c17f24a
NC
1095/* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
1096 at least on FreeBSD. YMMV, so experiment. */
1097#ifndef PERL_ARENA_SIZE
1098#define PERL_ARENA_SIZE 4080
1099#endif
1100
ccb2c8b8 1101/* Maximum level of recursion */
2b9dff67
RGS
1102#ifndef PERL_SUB_DEPTH_WARN
1103#define PERL_SUB_DEPTH_WARN 100
ccb2c8b8
RGS
1104#endif
1105
1109a392
MHM
1106#endif /* PERL_CORE */
1107
e839e6ed
DM
1108/* Maximum number of args that may be passed to an OP_MULTICONCAT op.
1109 * It determines the size of local arrays in S_maybe_multiconcat() and
1110 * pp_multiconcat().
1111 */
1112#define PERL_MULTICONCAT_MAXARG 64
1113
1114/* The indexes of fields of a multiconcat aux struct.
1115 * The fixed fields are followed by nargs+1 const segment lengths,
1116 * and if utf8 and non-utf8 differ, a second nargs+1 set for utf8.
1117 */
1118
1119#define PERL_MULTICONCAT_IX_NARGS 0 /* number of arguments */
1120#define PERL_MULTICONCAT_IX_PLAIN_PV 1 /* non-utf8 constant string */
1121#define PERL_MULTICONCAT_IX_PLAIN_LEN 2 /* non-utf8 constant string length */
1122#define PERL_MULTICONCAT_IX_UTF8_PV 3 /* utf8 constant string */
1123#define PERL_MULTICONCAT_IX_UTF8_LEN 4 /* utf8 constant string length */
1124#define PERL_MULTICONCAT_IX_LENGTHS 5 /* first of nargs+1 const segment lens */
1125#define PERL_MULTICONCAT_HEADER_SIZE 5 /* The number of fields of a
1126 multiconcat header */
1127
bdf3085f
NC
1128/* We no longer default to creating a new SV for GvSV.
1129 Do this before embed. */
1130#ifndef PERL_CREATE_GVSV
7459f06b
NC
1131# ifndef PERL_DONT_CREATE_GVSV
1132# define PERL_DONT_CREATE_GVSV
1133# endif
bdf3085f
NC
1134#endif
1135
ca0c25f6
NC
1136#if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
1137#define PERL_USES_PL_PIDSTATUS
1138#endif
1139
822c8b4d 1140#if !defined(OS2) && !defined(WIN32) && !defined(DJGPP)
a62746fa
RGS
1141#define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
1142#endif
1143
c31fac66
GS
1144#define MEM_SIZE Size_t
1145
1936d2a7
NC
1146/* Round all values passed to malloc up, by default to a multiple of
1147 sizeof(size_t)
1148*/
1149#ifndef PERL_STRLEN_ROUNDUP_QUANTUM
1150#define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
1151#endif
1152
f1200559
WH
1153/* sv_grow() will expand strings by at least a certain percentage of
1154 the previously *used* length to avoid excessive calls to realloc().
1155 The default is 25% of the current length.
1156*/
1157#ifndef PERL_STRLEN_EXPAND_SHIFT
1158# define PERL_STRLEN_EXPAND_SHIFT 2
1159#endif
1160
4bd4e933
SH
1161/* This use of offsetof() requires /Zc:offsetof- for VS2017 (and presumably
1162 * onwards) when building Socket.xs, but we can just use a different definition
1163 * for STRUCT_OFFSET instead. */
1164#if defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1910
1165# define STRUCT_OFFSET(s,m) (Size_t)(&(((s *)0)->m))
1166#else
1167# include <stddef.h>
1168# define STRUCT_OFFSET(s,m) offsetof(s,m)
1169#endif
d0b86e2f 1170
86477e89
KW
1171/* ptrdiff_t is C11, so undef it under pedantic builds. (Actually it is
1172 * in C89, but apparently there are platforms where it doesn't exist. See
1173 * thread beginning at http://nntp.perl.org/group/perl.perl5.porters/251541.)
1174 * */
d0b86e2f
BF
1175#ifdef PERL_GCC_PEDANTIC
1176# undef HAS_PTRDIFF_T
51371543
GS
1177#endif
1178
86477e89
KW
1179#ifdef HAS_PTRDIFF_T
1180# define Ptrdiff_t ptrdiff_t
1181#else
1182# define Ptrdiff_t SSize_t
1183#endif
1184
d54fbe84 1185# include <string.h>
51371543 1186
55497cff
PP
1187/* This comes after <stdlib.h> so we don't try to change the standard
1188 * library prototypes; we'll use our own in proto.h instead. */
03a14243 1189
4633a7c4 1190#ifdef MYMALLOC
86058a2d 1191# ifdef PERL_POLLUTE_MALLOC
ee13e175 1192# ifndef PERL_EXTMALLOC_DEF
86058a2d
GS
1193# define Perl_malloc malloc
1194# define Perl_calloc calloc
1195# define Perl_realloc realloc
1196# define Perl_mfree free
ee13e175 1197# endif
86058a2d
GS
1198# else
1199# define EMBEDMYMALLOC /* for compatibility */
1200# endif
827e134a 1201
651b9576
GS
1202# define safemalloc Perl_malloc
1203# define safecalloc Perl_calloc
1204# define saferealloc Perl_realloc
1205# define safefree Perl_mfree
22f7c9c9 1206# define CHECK_MALLOC_TOO_LATE_FOR_(code) STMT_START { \
54725a52 1207 if (!TAINTING_get && MallocCfg_ptr[MallocCfg_cfg_env_read]) \
22f7c9c9
JH
1208 code; \
1209 } STMT_END
1210# define CHECK_MALLOC_TOO_LATE_FOR(ch) \
1211 CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
1212# define panic_write2(s) write(2, s, strlen(s))
1213# define CHECK_MALLOC_TAINT(newval) \
1214 CHECK_MALLOC_TOO_LATE_FOR_( \
1215 if (newval) { \
acfd4d8e 1216 PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
22f7c9c9 1217 exit(1); })
22f7c9c9 1218# define MALLOC_CHECK_TAINT(argc,argv,env) STMT_START { \
b0891165 1219 if (doing_taint(argc,argv,env)) { \
22f7c9c9
JH
1220 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1; \
1221 }} STMT_END;
f2517201
GS
1222#else /* MYMALLOC */
1223# define safemalloc safesysmalloc
1224# define safecalloc safesyscalloc
1225# define saferealloc safesysrealloc
1226# define safefree safesysfree
22f7c9c9
JH
1227# define CHECK_MALLOC_TOO_LATE_FOR(ch) ((void)0)
1228# define CHECK_MALLOC_TAINT(newval) ((void)0)
1229# define MALLOC_CHECK_TAINT(argc,argv,env)
55497cff 1230#endif /* MYMALLOC */
4633a7c4 1231
fe13d51d 1232/* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
27da23d5 1233#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)
22f7c9c9
JH
1234#define TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, "")
1235#define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
1236#define MALLOC_CHECK_TAINT2(argc,argv) MALLOC_CHECK_TAINT(argc,argv,NULL)
1237
fc36a67e 1238#ifndef memzero
04322328 1239# define memzero(d,l) memset(d,0,l)
d9d8d8de 1240#endif
378cc40b 1241
ae986130 1242#ifdef I_NETINET_IN
79072805 1243# include <netinet/in.h>
ae986130
LW
1244#endif
1245
28e8609d
JH
1246#ifdef I_ARPA_INET
1247# include <arpa/inet.h>
1248#endif
1249
1aef975c 1250#ifdef I_SYS_STAT
84902520 1251# include <sys/stat.h>
1aef975c 1252#endif
79072805 1253
287a962e
JD
1254/* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1255 This definition should ideally go into win32/win32.h, but S_IFIFO is
1256 used later here in perl.h before win32/win32.h is being included. */
1257#if !defined(S_IFIFO) && defined(_S_IFIFO)
1258# define S_IFIFO _S_IFIFO
1259#endif
1260
cc3315ba 1261/* The stat macros for Unisoft System V/88 (and derivatives
a0d0e21e
LW
1262 like UTekV) are broken, sometimes giving false positives. Undefine
1263 them here and let the code below set them to proper values.
1264
1265 The ghs macro stands for GreenHills Software C-1.8.5 which
1266 is the C compiler for sysV88 and the various derivatives.
1267 This header file bug is corrected in gcc-2.5.8 and later versions.
1268 --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94. */
1269
cc3315ba 1270#if defined(m88k) && defined(ghs)
79072805
LW
1271# undef S_ISDIR
1272# undef S_ISCHR
1273# undef S_ISBLK
1274# undef S_ISREG
1275# undef S_ISFIFO
1276# undef S_ISLNK
ee0007ab 1277#endif
135863df 1278
9245da2a 1279#include <time.h>
663a0e37 1280
fe14fcc3 1281#ifdef I_SYS_TIME
85e6fe83 1282# ifdef I_SYS_TIME_KERNEL
663a0e37
LW
1283# define KERNEL
1284# endif
1285# include <sys/time.h>
85e6fe83 1286# ifdef I_SYS_TIME_KERNEL
663a0e37
LW
1287# undef KERNEL
1288# endif
a687059c 1289#endif
135863df 1290
55497cff 1291#if defined(HAS_TIMES) && defined(I_SYS_TIMES)
85e6fe83 1292# include <sys/times.h>
d9d8d8de 1293#endif
8d063cd8 1294
663a0e37 1295#include <errno.h>
1e743fda 1296
acfe0abc 1297#if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
b4748376
NIS
1298# define WIN32SCK_IS_STDSCK /* don't pull in custom wsock layer */
1299#endif
1300
da70cfc6 1301#if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1e743fda
JH
1302# include <sys/socket.h>
1303# if defined(USE_SOCKS) && defined(I_SOCKS)
1304# if !defined(INCLUDE_PROTOTYPES)
1305# define INCLUDE_PROTOTYPES /* for <socks.h> */
1306# define PERL_SOCKS_NEED_PROTOTYPES
1307# endif
1308# include <socks.h>
1309# ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1310# undef INCLUDE_PROTOTYPES
1311# undef PERL_SOCKS_NEED_PROTOTYPES
ed6116ce 1312# endif
d460ef45 1313# endif
1e743fda 1314# ifdef I_NETDB
2986a63f
JH
1315# ifdef NETWARE
1316# include<stdio.h>
1317# endif
1e743fda
JH
1318# include <netdb.h>
1319# endif
1320# ifndef ENOTSOCK
1321# ifdef I_NET_ERRNO
1322# include <net/errno.h>
1323# endif
1324# endif
1325#endif
1326
fa0a29af 1327/* sockatmark() is so new (2001) that many places might have it hidden
29820b6d
MHM
1328 * behind some -D_BLAH_BLAH_SOURCE guard. The __THROW magic is required
1329 * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
fa0a29af 1330#if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
29820b6d
MHM
1331# if defined(__THROW) && defined(__GLIBC__)
1332int sockatmark(int) __THROW;
1333# else
2ef53570 1334int sockatmark(int);
29820b6d 1335# endif
2ef53570
JH
1336#endif
1337
7e827271 1338#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. */
45d3b546
JH
1339EXTERN_C int fchdir(int);
1340EXTERN_C int flock(int, int);
1341EXTERN_C int fseeko(FILE *, off_t, int);
1342EXTERN_C off_t ftello(FILE *);
1343#endif
1344
7e827271 1345#if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1ccb7c8d
JH
1346EXTERN_C char *crypt(const char *, const char *);
1347#endif
1348
a54aca4b 1349#if defined(__cplusplus) && defined(__CYGWIN__)
667e2948
SP
1350EXTERN_C char *crypt(const char *, const char *);
1351#endif
1352
131e4949
TC
1353/*
1354=head1 Errno
1355
1356=for apidoc m|void|SETERRNO|int errcode|int vmserrcode
1357
1358Set C<errno>, and on VMS set C<vaxc$errno>.
1359
1360=for apidoc mn|void|dSAVEDERRNO
1361
1362Declare variables needed to save C<errno> and any operating system
1363specific error number.
1364
1365=for apidoc mn|void|dSAVE_ERRNO
1366
1367Declare variables needed to save C<errno> and any operating system
1368specific error number, and save them for optional later restoration
1369by C<RESTORE_ERRNO>.
1370
1371=for apidoc mn|void|SAVE_ERRNO
1372
1373Save C<errno> and any operating system specific error number for
1374optional later restoration by C<RESTORE_ERRNO>. Requires
1375C<dSAVEDERRNO> or C<dSAVE_ERRNO> in scope.
1376
1377=for apidoc mn|void|RESTORE_ERRNO
1378
1379Restore C<errno> and any operating system specific error number that
1380was saved by C<dSAVE_ERRNO> or C<RESTORE_ERRNO>.
1381
1382=cut
1383*/
1384
1e743fda
JH
1385#ifdef SETERRNO
1386# undef SETERRNO /* SOCKS might have defined this */
ed6116ce 1387#endif
f86702cc
PP
1388
1389#ifdef VMS
1390# define SETERRNO(errcode,vmserrcode) \
1391 STMT_START { \
1392 set_errno(errcode); \
1393 set_vaxc_errno(vmserrcode); \
1394 } STMT_END
4ee39169
CS
1395# define dSAVEDERRNO int saved_errno; unsigned saved_vms_errno
1396# define dSAVE_ERRNO int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1397# define SAVE_ERRNO ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1398# define RESTORE_ERRNO SETERRNO(saved_errno, saved_vms_errno)
1399
93189314
JH
1400# define LIB_INVARG LIB$_INVARG
1401# define RMS_DIR RMS$_DIR
1402# define RMS_FAC RMS$_FAC
1403# define RMS_FEX RMS$_FEX
1404# define RMS_FNF RMS$_FNF
1405# define RMS_IFI RMS$_IFI
1406# define RMS_ISI RMS$_ISI
1407# define RMS_PRV RMS$_PRV
1408# define SS_ACCVIO SS$_ACCVIO
1409# define SS_DEVOFFLINE SS$_DEVOFFLINE
1410# define SS_IVCHAN SS$_IVCHAN
1411# define SS_NORMAL SS$_NORMAL
8a9f18be 1412# define SS_NOPRIV SS$_NOPRIV
4388f261 1413# define SS_BUFFEROVF SS$_BUFFEROVF
748a9306 1414#else
93189314
JH
1415# define LIB_INVARG 0
1416# define RMS_DIR 0
1417# define RMS_FAC 0
1418# define RMS_FEX 0
1419# define RMS_FNF 0
1420# define RMS_IFI 0
1421# define RMS_ISI 0
1422# define RMS_PRV 0
1423# define SS_ACCVIO 0
1424# define SS_DEVOFFLINE 0
1425# define SS_IVCHAN 0
1426# define SS_NORMAL 0
8a9f18be 1427# define SS_NOPRIV 0
4388f261 1428# define SS_BUFFEROVF 0
748a9306 1429#endif
ed6116ce 1430
6ca940a9
TC
1431#ifdef WIN32
1432# define dSAVEDERRNO int saved_errno; DWORD saved_win32_errno
1433# define dSAVE_ERRNO int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1434# define SAVE_ERRNO ( saved_errno = errno, saved_win32_errno = GetLastError() )
1435# define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1436#endif
1437
1438#ifdef OS2
1439# define dSAVEDERRNO int saved_errno; unsigned long saved_os2_errno
1440# define dSAVE_ERRNO int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1441# define SAVE_ERRNO ( saved_errno = errno, saved_os2_errno = Perl_rc )
1442# define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1443#endif
1444
1445#ifndef SETERRNO
1446# define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1447#endif
1448
1449#ifndef dSAVEDERRNO
1450# define dSAVEDERRNO int saved_errno
1451# define dSAVE_ERRNO int saved_errno = errno
1452# define SAVE_ERRNO (saved_errno = errno)
1453# define RESTORE_ERRNO (errno = saved_errno)
1454#endif
1455
40bec302
TC
1456/*
1457=head1 Warning and Dieing
1458
1459=for apidoc Amn|SV *|ERRSV
1460
1461Returns the SV for C<$@>, creating it if needed.
1462
1463=for apidoc Am|void|CLEAR_ERRSV
1464
1465Clear the contents of C<$@>, setting it to the empty string.
1466
1467This replaces any read-only SV with a fresh SV and removes any magic.
1468
933e3e63
TC
1469=for apidoc Am|void|SANE_ERRSV
1470
1471Clean up ERRSV so we can safely set it.
1472
1473This replaces any read-only SV with a fresh writable copy and removes
1474any magic.
1475
40bec302
TC
1476=cut
1477*/
1478
f5fa9033 1479#define ERRSV GvSVn(PL_errgv)
dfd167e9 1480
b4f8d149 1481/* contains inlined gv_add_by_type */
dfd167e9 1482#define CLEAR_ERRSV() STMT_START { \
b4f8d149
DD
1483 SV ** const svp = &GvSV(PL_errgv); \
1484 if (!*svp) { \
a1b60c8d 1485 *svp = newSVpvs(""); \
b4f8d149
DD
1486 } else if (SvREADONLY(*svp)) { \
1487 SvREFCNT_dec_NN(*svp); \
b4f8d149 1488 *svp = newSVpvs(""); \
dfd167e9 1489 } else { \
b4f8d149 1490 SV *const errsv = *svp; \
a1b60c8d 1491 SvPVCLEAR(errsv); \
b4f8d149 1492 SvPOK_only(errsv); \
dfd167e9
NC
1493 if (SvMAGICAL(errsv)) { \
1494 mg_free(errsv); \
1495 } \
dfd167e9
NC
1496 } \
1497 } STMT_END
1498
933e3e63
TC
1499/* contains inlined gv_add_by_type */
1500#define SANE_ERRSV() STMT_START { \
1501 SV ** const svp = &GvSV(PL_errgv); \
1502 if (!*svp) { \
1503 *svp = newSVpvs(""); \
1504 } else if (SvREADONLY(*svp)) { \
1505 SV *dupsv = newSVsv(*svp); \
1506 SvREFCNT_dec_NN(*svp); \
1507 *svp = dupsv; \
1508 } else { \
1509 SV *const errsv = *svp; \
1510 if (SvMAGICAL(errsv)) { \
1511 mg_free(errsv); \
1512 } \
1513 } \
1514 } STMT_END
1515
dfd167e9 1516
414bf5ae
MHM
1517#ifdef PERL_CORE
1518# define DEFSV (0 + GvSVn(PL_defgv))
55b5114f
FC
1519# define DEFSV_set(sv) \
1520 (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1521# define SAVE_DEFSV \
1522 ( \
1523 save_gp(PL_defgv, 0), \
1524 GvINTRO_off(PL_defgv), \
1525 SAVEGENERICSV(GvSV(PL_defgv)), \
1526 GvSV(PL_defgv) = NULL \
1527 )
414bf5ae
MHM
1528#else
1529# define DEFSV GvSVn(PL_defgv)
55b5114f
FC
1530# define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1531# define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
414bf5ae 1532#endif
38a03e6e 1533
55497cff 1534#ifndef errno
5ff3f7a4
GS
1535 extern int errno; /* ANSI allows errno to be an lvalue expr.
1536 * For example in multithreaded environments
1537 * something like this might happen:
1538 * extern int *_errno(void);
1539 * #define errno (*_errno()) */
d9d8d8de 1540#endif
663a0e37 1541
7e996671
KW
1542#define UNKNOWN_ERRNO_MSG "(unknown)"
1543
d1747a5a 1544#ifdef VMS
b21d8587
AC
1545#define Strerror(e) strerror((e), vaxc$errno)
1546#else
1547#define Strerror(e) strerror(e)
35c8bce7 1548#endif
663a0e37 1549
2304df62 1550#ifdef I_SYS_IOCTL
79072805
LW
1551# ifndef _IOCTL_
1552# include <sys/ioctl.h>
1553# endif
a687059c
LW
1554#endif
1555
ee0007ab 1556#if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
79072805
LW
1557# ifdef HAS_SOCKETPAIR
1558# undef HAS_SOCKETPAIR
1559# endif
2304df62
AD
1560# ifdef I_NDBM
1561# undef I_NDBM
79072805 1562# endif
a687059c
LW
1563#endif
1564
02fc2eee
NC
1565#ifndef HAS_SOCKETPAIR
1566# ifdef HAS_SOCKET
1567# define socketpair Perl_my_socketpair
1568# endif
1569#endif
1570
a687059c 1571#if INTSIZE == 2
79072805
LW
1572# define htoni htons
1573# define ntohi ntohs
a687059c 1574#else
79072805
LW
1575# define htoni htonl
1576# define ntohi ntohl
a687059c
LW
1577#endif
1578
a0d0e21e 1579/* Configure already sets Direntry_t */
35c8bce7 1580#if defined(I_DIRENT)
da5fdda8
AC
1581# include <dirent.h>
1582#elif defined(I_SYS_NDIR)
1583# include <sys/ndir.h>
1584#elif defined(I_SYS_DIR)
1585# include <sys/dir.h>
4633a7c4 1586#endif
a687059c 1587
c623bd54
LW
1588/*
1589 * The following gobbledygook brought to you on behalf of __STDC__.
1590 * (I could just use #ifndef __STDC__, but this is more bulletproof
1591 * in the face of half-implementations.)
1592 */
1593
21e89b5f 1594#if defined(I_SYSMODE)
ca6e1c26
JH
1595#include <sys/mode.h>
1596#endif
1597
c623bd54
LW
1598#ifndef S_IFMT
1599# ifdef _S_IFMT
1600# define S_IFMT _S_IFMT
1601# else
1602# define S_IFMT 0170000
1603# endif
1604#endif
1605
1606#ifndef S_ISDIR
1607# define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1608#endif
1609
1610#ifndef S_ISCHR
1611# define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1612#endif
1613
1614#ifndef S_ISBLK
fe14fcc3
LW
1615# ifdef S_IFBLK
1616# define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1617# else
1618# define S_ISBLK(m) (0)
1619# endif
c623bd54
LW
1620#endif
1621
1622#ifndef S_ISREG
1623# define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1624#endif
1625
1626#ifndef S_ISFIFO
fe14fcc3
LW
1627# ifdef S_IFIFO
1628# define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1629# else
1630# define S_ISFIFO(m) (0)
1631# endif
c623bd54
LW
1632#endif
1633
1634#ifndef S_ISLNK
da5fdda8
AC
1635# ifdef _S_ISLNK
1636# define S_ISLNK(m) _S_ISLNK(m)
1637# elif defined(_S_IFLNK)
1638# define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1639# elif defined(S_IFLNK)
1640# define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1641# else
1642# define S_ISLNK(m) (0)
1643# endif
c623bd54
LW
1644#endif
1645
1646#ifndef S_ISSOCK
da5fdda8
AC
1647# ifdef _S_ISSOCK
1648# define S_ISSOCK(m) _S_ISSOCK(m)
1649# elif defined(_S_IFSOCK)
1650# define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1651# elif defined(S_IFSOCK)
1652# define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1653# else
1654# define S_ISSOCK(m) (0)
1655# endif
c623bd54
LW
1656#endif
1657
1658#ifndef S_IRUSR
1659# ifdef S_IREAD
1660# define S_IRUSR S_IREAD
1661# define S_IWUSR S_IWRITE
1662# define S_IXUSR S_IEXEC
1663# else
1664# define S_IRUSR 0400
1665# define S_IWUSR 0200
1666# define S_IXUSR 0100
1667# endif
fac7cdfc 1668#endif
1669
1670#ifndef S_IRGRP
1671# ifdef S_IRUSR
1672# define S_IRGRP (S_IRUSR>>3)
1673# define S_IWGRP (S_IWUSR>>3)
1674# define S_IXGRP (S_IXUSR>>3)
1675# else
1676# define S_IRGRP 0040
1677# define S_IWGRP 0020
1678# define S_IXGRP 0010
1679# endif
1680#endif
1681
1682#ifndef S_IROTH
1683# ifdef S_IRUSR
1684# define S_IROTH (S_IRUSR>>6)
1685# define S_IWOTH (S_IWUSR>>6)
1686# define S_IXOTH (S_IXUSR>>6)
1687# else
1688# define S_IROTH 0040
1689# define S_IWOTH 0020
1690# define S_IXOTH 0010
1691# endif
c623bd54
LW
1692#endif
1693
1694#ifndef S_ISUID
1695# define S_ISUID 04000
1696#endif
1697
1698#ifndef S_ISGID
1699# define S_ISGID 02000
1700#endif
1701
ca6e1c26
JH
1702#ifndef S_IRWXU
1703# define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
d460ef45 1704#endif
ca6e1c26
JH
1705
1706#ifndef S_IRWXG
1707# define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
d460ef45 1708#endif
ca6e1c26
JH
1709
1710#ifndef S_IRWXO
1711# define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
d460ef45 1712#endif
ca6e1c26 1713
b6c36746 1714/* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
c21fb2b8
JH
1715 * which would get included through <sys/file.h >, but that is 3000
1716 * lines in the future. --jhi */
1717
b6c36746 1718#if !defined(S_IREAD) && !defined(__HAIKU__)
ca6e1c26
JH
1719# define S_IREAD S_IRUSR
1720#endif
1721
b6c36746 1722#if !defined(S_IWRITE) && !defined(__HAIKU__)
ca6e1c26
JH
1723# define S_IWRITE S_IWUSR
1724#endif
1725
1726#ifndef S_IEXEC
1727# define S_IEXEC S_IXUSR
1728#endif
1729
a0d0e21e 1730#if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
45d8adaa
LW
1731# define SLOPPYDIVIDE
1732#endif
1733
748a9306
LW
1734#ifdef UV
1735#undef UV
1736#endif
1737
f1519f70
AC
1738/* This used to be conditionally defined based on whether we had a sprintf()
1739 * that correctly returns the string length (as required by C89), but we no
1740 * longer need that. XS modules can (and do) use this name, so it must remain
558a6899
KW
1741 * a part of the API that's visible to modules.
1742
bcd83cc8
KW
1743=head1 Miscellaneous Functions
1744
558a6899
KW
1745=for apidoc ATmD|int|my_sprintf|NN char *buffer|NN const char *pat|...
1746
1747Do NOT use this due to the possibility of overflowing C<buffer>. Instead use
1748my_snprintf()
1749
1750=cut
1751*/
f1519f70 1752#define my_sprintf sprintf
ce582cee 1753
5b692037
JH
1754/*
1755 * If we have v?snprintf() and the C99 variadic macros, we can just
1756 * use just the v?snprintf(). It is nice to try to trap the buffer
1757 * overflow, however, so if we are DEBUGGING, and we cannot use the
e5afc1ae
DD
1758 * gcc statement expressions, then use the function wrappers which try
1759 * to trap the overflow. If we can use the gcc statement expressions,
1760 * we can try that even with the version that uses the C99 variadic
1761 * macros.
5b692037
JH
1762 */
1763
1208b3dd 1764/* Note that we do not check against snprintf()/vsnprintf() returning
4059ba87
AC
1765 * negative values because that is non-standard behaviour and we use
1766 * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1767 * that should be true only if the snprintf()/vsnprintf() are true
1768 * to the standard. */
1208b3dd 1769
571ee10c 1770#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
e8549682 1771
a4eca1d4
JH
1772#ifdef USE_QUADMATH
1773# define my_snprintf Perl_my_snprintf
1774# define PERL_MY_SNPRINTF_GUARDED
4059ba87 1775#elif defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
5b692037 1776# ifdef PERL_USE_GCC_BRACE_GROUPS
e8549682 1777# define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1208b3dd 1778# define PERL_MY_SNPRINTF_GUARDED
5b692037 1779# else
e8549682 1780# define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
5b692037
JH
1781# endif
1782#else
1783# define my_snprintf Perl_my_snprintf
1208b3dd 1784# define PERL_MY_SNPRINTF_GUARDED
5b692037
JH
1785#endif
1786
a4eca1d4
JH
1787/* There is no quadmath_vsnprintf, and therefore my_vsnprintf()
1788 * dies if called under USE_QUADMATH. */
4059ba87 1789#if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
5b692037 1790# ifdef PERL_USE_GCC_BRACE_GROUPS
e8549682 1791# define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1208b3dd 1792# define PERL_MY_VSNPRINTF_GUARDED
5b692037 1793# else
e8549682 1794# define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
5b692037
JH
1795# endif
1796#else
1797# define my_vsnprintf Perl_my_vsnprintf
1208b3dd 1798# define PERL_MY_VSNPRINTF_GUARDED
5b692037 1799#endif
d9fad198 1800
e8549682
JH
1801/* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1802 * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1803 * the result of my_snprintf() or my_vsnprintf(). (No, you should not
1804 * completely ignore it: otherwise you cannot know whether your output
1805 * was too long.)
1806 *
1807 * int len = my_sprintf(buf, max, ...);
1808 * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1809 *
1810 * The trick is that in certain platforms [a] the my_sprintf() already
1811 * contains the sanity check, while in certain platforms [b] it needs
1812 * to be done as a separate step. The POST_GUARD is that step-- in [a]
1813 * platforms the POST_GUARD actually does nothing since the check has
1814 * already been done. Watch out for the max being the same in both calls.
1815 *
1816 * If you actually use the snprintf/vsnprintf return value already,
1817 * you assumedly are checking its validity somehow. But you can
1818 * insert the POST_GUARD() also in that case. */
1819
1820#ifndef PERL_MY_SNPRINTF_GUARDED
1821# define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1822#else
1823# define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1824#endif
1825
1826#ifndef PERL_MY_VSNPRINTF_GUARDED
1827# define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
1828#else
1829# define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1830#endif
1831
a6cc4119
SP
1832#ifdef HAS_STRLCAT
1833# define my_strlcat strlcat
a6cc4119
SP
1834#endif
1835
6dba01e2
KW
1836#if defined(PERL_CORE) || defined(PERL_EXT)
1837# ifdef HAS_MEMRCHR
1838# define my_memrchr memrchr
1839# else
1840# define my_memrchr S_my_memrchr
1841# endif
1842#endif
1843
a6cc4119
SP
1844#ifdef HAS_STRLCPY
1845# define my_strlcpy strlcpy
a6cc4119
SP
1846#endif
1847
aefb3fa0
DIM
1848#ifdef HAS_STRNLEN
1849# define my_strnlen strnlen
aefb3fa0
DIM
1850#endif
1851
05f13f53 1852/*
27d4fb96
PP
1853 The IV type is supposed to be long enough to hold any integral
1854 value or a pointer.
1855 --Andy Dougherty August 1996
1856*/
1857
a22e52b9
JH
1858typedef IVTYPE IV;
1859typedef UVTYPE UV;
8175356b 1860
10cc9d2a 1861#if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
6b8eaf93 1862# if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
bf51a9b9
TC
1863# define IV_MAX ((IV)INT64_MAX)
1864# define IV_MIN ((IV)INT64_MIN)
1865# define UV_MAX ((UV)UINT64_MAX)
cae7ae48
JH
1866# ifndef UINT64_MIN
1867# define UINT64_MIN 0
1868# endif
bf51a9b9 1869# define UV_MIN ((UV)UINT64_MIN)
5ff3f7a4
GS
1870# else
1871# define IV_MAX PERL_QUAD_MAX
1872# define IV_MIN PERL_QUAD_MIN
1873# define UV_MAX PERL_UQUAD_MAX
1874# define UV_MIN PERL_UQUAD_MIN
1875# endif
cf2093f6
JH
1876# define IV_IS_QUAD
1877# define UV_IS_QUAD
79072805 1878#else
8175356b 1879# if defined(INT32_MAX) && IVSIZE == 4
bf51a9b9
TC
1880# define IV_MAX ((IV)INT32_MAX)
1881# define IV_MIN ((IV)INT32_MIN)
716026f9 1882# ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
bf51a9b9 1883# define UV_MAX ((UV)UINT32_MAX)
716026f9 1884# else
bf51a9b9 1885# define UV_MAX ((UV)4294967295U)
716026f9 1886# endif
cae7ae48
JH
1887# ifndef UINT32_MIN
1888# define UINT32_MIN 0
1889# endif
bf51a9b9 1890# define UV_MIN ((UV)UINT32_MIN)
5ff3f7a4
GS
1891# else
1892# define IV_MAX PERL_LONG_MAX
1893# define IV_MIN PERL_LONG_MIN
1894# define UV_MAX PERL_ULONG_MAX
1895# define UV_MIN PERL_ULONG_MIN
1896# endif
8175356b 1897# if IVSIZE == 8
cf2093f6
JH
1898# define IV_IS_QUAD
1899# define UV_IS_QUAD
de1c2614
JH
1900# ifndef HAS_QUAD
1901# define HAS_QUAD
1902# endif
cf2093f6
JH
1903# else
1904# undef IV_IS_QUAD
1905# undef UV_IS_QUAD
7adf2470 1906#if !defined(PERL_CORE)
e25d460c
NC
1907/* We think that removing this decade-old undef this will cause too much
1908 breakage on CPAN for too little gain. (See RT #119753)
7adf2470 1909 However, we do need HAS_QUAD in the core for use by the drand48 code. */
cb4b14d5 1910# undef HAS_QUAD
e25d460c 1911#endif
cf2093f6 1912# endif
79072805 1913#endif
d7d93a81 1914
6313e544
JH
1915#define Size_t_MAX (~(Size_t)0)
1916#define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
9a543cee 1917
cae7ae48 1918#define IV_DIG (BIT_DIGITS(IVSIZE * 8))
22ec83e3 1919#define UV_DIG (BIT_DIGITS(UVSIZE * 8))
56431972 1920
28e5dec8 1921#ifndef NO_PERL_PRESERVE_IVUV
f5c03d33 1922#define PERL_PRESERVE_IVUV /* We like our integers to stay integers. */
28e5dec8
JH
1923#endif
1924
d460ef45 1925/*
26bb67e2
JH
1926 * The macros INT2PTR and NUM2PTR are (despite their names)
1927 * bi-directional: they will convert int/float to or from pointers.
1928 * However the conversion to int/float are named explicitly:
1929 * PTR2IV, PTR2UV, PTR2NV.
1930 *
1931 * For int conversions we do not need two casts if pointers are
1932 * the same size as IV and UV. Otherwise we need an explicit
1933 * cast (PTRV) to avoid compiler warnings.
81065b6d
KW
1934 *
1935 * These are mentioned in perlguts
26bb67e2 1936 */
56431972
RB
1937#if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1938# define PTRV UV
1939# define INT2PTR(any,d) (any)(d)
da5fdda8
AC
1940#elif PTRSIZE == LONGSIZE
1941# define PTRV unsigned long
1942# define PTR2ul(p) (unsigned long)(p)
56431972 1943#else
da5fdda8 1944# define PTRV unsigned
e91e3b10
RB
1945#endif
1946
1947#ifndef INT2PTR
56431972 1948# define INT2PTR(any,d) (any)(PTRV)(d)
42718184 1949#endif
e91e3b10
RB
1950
1951#ifndef PTR2ul
1952# define PTR2ul(p) INT2PTR(unsigned long,p)
1953#endif
1954
56431972
RB
1955#define NUM2PTR(any,d) (any)(PTRV)(d)
1956#define PTR2IV(p) INT2PTR(IV,p)
1957#define PTR2UV(p) INT2PTR(UV,p)
1958#define PTR2NV(p) NUM2PTR(NV,p)
e91e3b10 1959#define PTR2nat(p) (PTRV)(p) /* pointer to integer of PTRSIZE */
d460ef45 1960
8141890a
JH
1961/* According to strict ANSI C89 one cannot freely cast between
1962 * data pointers and function (code) pointers. There are at least
1963 * two ways around this. One (used below) is to do two casts,
1964 * first the other pointer to an (unsigned) integer, and then
1965 * the integer to the other pointer. The other way would be
1966 * to use unions to "overlay" the pointers. For an example of
1967 * the latter technique, see union dirpu in struct xpvio in sv.h.
1968 * The only feasible use is probably temporarily storing
1969 * function pointers in a data pointer (such as a void pointer). */
1970
e91e3b10
RB
1971#define DPTR2FPTR(t,p) ((t)PTR2nat(p)) /* data pointer to function pointer */
1972#define FPTR2DPTR(t,p) ((t)PTR2nat(p)) /* function pointer to data pointer */
8141890a 1973
65202027 1974#ifdef USE_LONG_DOUBLE
f3654d06
JH
1975# if LONG_DOUBLESIZE == DOUBLESIZE
1976# define LONG_DOUBLE_EQUALS_DOUBLE
1977# undef USE_LONG_DOUBLE /* Ouch! */
65202027
DS
1978# endif
1979#endif
1980
2d4389e4
JH
1981/* The following is all to get LDBL_DIG, in order to pick a nice
1982 default value for printing floating point numbers in Gconvert.
1983 (see config.h)
1984*/
63b481b9 1985#ifndef HAS_LDBL_DIG
68d4903c 1986# if LONG_DOUBLESIZE == 10
63b481b9
AC
1987# define LDBL_DIG 18 /* assume IEEE */
1988# elif LONG_DOUBLESIZE == 12
68d4903c 1989# define LDBL_DIG 18 /* gcc? */
63b481b9
AC
1990# elif LONG_DOUBLESIZE == 16
1991# define LDBL_DIG 33 /* assume IEEE */
1992# elif LONG_DOUBLESIZE == DOUBLESIZE
1993# define LDBL_DIG DBL_DIG /* bummer */
68d4903c 1994# endif
2d4389e4
JH
1995#endif
1996
a22e52b9 1997typedef NVTYPE NV;
8175356b 1998
792d8dab
JH
1999#ifdef I_IEEEFP
2000# include <ieeefp.h>
2001#endif
923fc586 2002
bcd8bfa9
JH
2003#if defined(__DECC) && defined(__osf__)
2004/* Also Tru64 cc has broken NaN comparisons. */
2005# define NAN_COMPARE_BROKEN
c32c3de1 2006#endif
6504068e
JH
2007#if defined(__sgi)
2008# define NAN_COMPARE_BROKEN
2009#endif
c32c3de1 2010
65202027 2011#ifdef USE_LONG_DOUBLE
923fc586
JH
2012# ifdef I_SUNMATH
2013# include <sunmath.h>
2014# endif
84e6cb05 2015# if defined(LDBL_DIG)
05b4a618
JH
2016# define NV_DIG LDBL_DIG
2017# ifdef LDBL_MANT_DIG
2018# define NV_MANT_DIG LDBL_MANT_DIG
2019# endif
2020# ifdef LDBL_MIN
2021# define NV_MIN LDBL_MIN
2022# endif
2023# ifdef LDBL_MAX
2024# define NV_MAX LDBL_MAX
2025# endif
2026# ifdef LDBL_MIN_EXP
2027# define NV_MIN_EXP LDBL_MIN_EXP
2028# endif
2029# ifdef LDBL_MAX_EXP
2030# define NV_MAX_EXP LDBL_MAX_EXP
2031# endif
2032# ifdef LDBL_MIN_10_EXP
2033# define NV_MIN_10_EXP LDBL_MIN_10_EXP
2034# endif
2035# ifdef LDBL_MAX_10_EXP
2036# define NV_MAX_10_EXP LDBL_MAX_10_EXP
2037# endif
2038# ifdef LDBL_EPSILON
2039# define NV_EPSILON LDBL_EPSILON
2040# endif
2041# ifdef LDBL_MAX
2042# define NV_MAX LDBL_MAX
20f6aaab 2043/* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
da5fdda8
AC
2044# elif defined(HUGE_VALL)
2045# define NV_MAX HUGE_VALL
f4a14a62
JH
2046# endif
2047# endif
84e6cb05 2048# if defined(HAS_SQRTL)
8a00eddc
JH
2049# define Perl_acos acosl
2050# define Perl_asin asinl
2051# define Perl_atan atanl
940e3d56
JH
2052# define Perl_atan2 atan2l
2053# define Perl_ceil ceill
2054# define Perl_cos cosl
8a00eddc 2055# define Perl_cosh coshl
940e3d56 2056# define Perl_exp expl
55da5e5b 2057/* no Perl_fabs, but there's PERL_ABS */
940e3d56
JH
2058# define Perl_floor floorl
2059# define Perl_fmod fmodl
2060# define Perl_log logl
8a00eddc 2061# define Perl_log10 log10l
940e3d56
JH
2062# define Perl_pow powl
2063# define Perl_sin sinl
8a00eddc 2064# define Perl_sinh sinhl
940e3d56 2065# define Perl_sqrt sqrtl
8a00eddc
JH
2066# define Perl_tan tanl
2067# define Perl_tanh tanhl
68d4903c 2068# endif
a3540c92 2069/* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
05b4a618
JH
2070# ifndef Perl_modf
2071# ifdef HAS_MODFL
2072# define Perl_modf(x,y) modfl(x,y)
51997bc3
NC
2073/* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
2074 prototype in <math.h> */
05b4a618 2075# ifndef HAS_MODFL_PROTO
a221a8a5 2076EXTERN_C long double modfl(long double, long double *);
05b4a618
JH
2077# endif
2078# elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
55954f19 2079 extern long double Perl_my_modfl(long double x, long double *ip);
03476e8e 2080# define Perl_modf(x,y) Perl_my_modfl(x,y)
05b4a618 2081# endif
a3540c92 2082# endif
05b4a618
JH
2083# ifndef Perl_frexp
2084# ifdef HAS_FREXPL
2085# define Perl_frexp(x,y) frexpl(x,y)
da5fdda8 2086# elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
05b4a618 2087extern long double Perl_my_frexpl(long double x, int *e);
da5fdda8 2088# define Perl_frexp(x,y) Perl_my_frexpl(x,y)
03476e8e 2089# endif
a3540c92 2090# endif
05b4a618
JH
2091# ifndef Perl_ldexp
2092# ifdef HAS_LDEXPL
2093# define Perl_ldexp(x, y) ldexpl(x,y)
da5fdda8
AC
2094# elif defined(HAS_SCALBNL) && FLT_RADIX == 2
2095# define Perl_ldexp(x,y) scalbnl(x,y)
98181445
JH
2096# endif
2097# endif
38dbb4c5 2098# ifndef Perl_isnan
e4c957f4 2099# if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
758a5d79 2100# define Perl_isnan(x) isnanl(x)
a1115378
JH
2101# elif defined(__sgi) && defined(__c99) /* XXX Configure test needed */
2102# define Perl_isnan(x) isnan(x)
758a5d79
JH
2103# endif
2104# endif
2105# ifndef Perl_isinf
e4c957f4 2106# if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
87190886 2107# define Perl_isinf(x) isinfl(x)
a1115378
JH
2108# elif defined(__sgi) && defined(__c99) /* XXX Configure test needed */
2109# define Perl_isinf(x) isinf(x)
bcd8bfa9 2110# elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
efcbf317 2111# define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
a3540c92
JH
2112# endif
2113# endif
e38461cc
JH
2114# ifndef Perl_isfinite
2115# define Perl_isfinite(x) Perl_isfinitel(x)
2116# endif
84e6cb05
JH
2117#elif defined(USE_QUADMATH) && defined(I_QUADMATH)
2118# include <quadmath.h>
2119# define NV_DIG FLT128_DIG
2120# define NV_MANT_DIG FLT128_MANT_DIG
2121# define NV_MIN FLT128_MIN
2122# define NV_MAX FLT128_MAX
2123# define NV_MIN_EXP FLT128_MIN_EXP
2124# define NV_MAX_EXP FLT128_MAX_EXP
2125# define NV_EPSILON FLT128_EPSILON
2126# define NV_MIN_10_EXP FLT128_MIN_10_EXP
2127# define NV_MAX_10_EXP FLT128_MAX_10_EXP
84e6cb05
JH
2128# define Perl_acos acosq
2129# define Perl_asin asinq
2130# define Perl_atan atanq
2131# define Perl_atan2 atan2q
2132# define Perl_ceil ceilq
2133# define Perl_cos cosq
2134# define Perl_cosh coshq
2135# define Perl_exp expq
2136/* no Perl_fabs, but there's PERL_ABS */
2137# define Perl_floor floorq
2138# define Perl_fmod fmodq
2139# define Perl_log logq
2140# define Perl_log10 log10q
e6081c0e 2141# define Perl_signbit signbitq
84e6cb05
JH
2142# define Perl_pow powq
2143# define Perl_sin sinq
2144# define Perl_sinh sinhq
2145# define Perl_sqrt sqrtq
2146# define Perl_tan tanq
2147# define Perl_tanh tanhq
2148# define Perl_modf(x,y) modfq(x,y)
2149# define Perl_frexp(x,y) frexpq(x,y)
2150# define Perl_ldexp(x, y) ldexpq(x,y)
2151# define Perl_isinf(x) isinfq(x)
2152# define Perl_isnan(x) isnanq(x)
2153# define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
b28053d1
JH
2154# define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
2155# define Perl_fp_class_inf(x) (Perl_fp_class(x) == 3)
2156# define Perl_fp_class_nan(x) (Perl_fp_class(x) == 4)
2157# define Perl_fp_class_norm(x) (Perl_fp_class(x) == 1)
2158# define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
2159# define Perl_fp_class_zero(x) (Perl_fp_class(x) == 0)
65202027 2160#else
2d4389e4 2161# define NV_DIG DBL_DIG
63b481b9
AC
2162# define NV_MANT_DIG DBL_MANT_DIG
2163# define NV_MIN DBL_MIN
2164# define NV_MAX DBL_MAX
2165# define NV_MIN_EXP DBL_MIN_EXP
2166# define NV_MAX_EXP DBL_MAX_EXP
2167# define NV_MIN_10_EXP DBL_MIN_10_EXP
2168# define NV_MAX_10_EXP DBL_MAX_10_EXP
2169# define NV_EPSILON DBL_EPSILON
2170# define NV_MAX DBL_MAX
2171# define NV_MIN DBL_MIN
940e3d56 2172
55da5e5b 2173/* These math interfaces are C89. */
8a00eddc
JH
2174# define Perl_acos acos
2175# define Perl_asin asin
2176# define Perl_atan atan
940e3d56
JH
2177# define Perl_atan2 atan2
2178# define Perl_ceil ceil
2179# define Perl_cos cos
8a00eddc 2180# define Perl_cosh cosh
940e3d56 2181# define Perl_exp exp
55da5e5b 2182/* no Perl_fabs, but there's PERL_ABS */
940e3d56
JH
2183# define Perl_floor floor
2184# define Perl_fmod fmod
2185# define Perl_log log
8a00eddc 2186# define Perl_log10 log10
940e3d56
JH
2187# define Perl_pow pow
2188# define Perl_sin sin
8a00eddc 2189# define Perl_sinh sinh
940e3d56 2190# define Perl_sqrt sqrt
8a00eddc
JH
2191# define Perl_tan tan
2192# define Perl_tanh tanh
940e3d56
JH
2193
2194# define Perl_modf(x,y) modf(x,y)
2195# define Perl_frexp(x,y) frexp(x,y)
2196# define Perl_ldexp(x,y) ldexp(x,y)
2197
1a322af2
JH
2198# ifndef Perl_isnan
2199# ifdef HAS_ISNAN
2200# define Perl_isnan(x) isnan(x)
2201# endif
2202# endif
2203# ifndef Perl_isinf
2204# if defined(HAS_ISINF)
2205# define Perl_isinf(x) isinf(x)
bcd8bfa9 2206# elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
efcbf317 2207# define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
1a322af2
JH
2208# endif
2209# endif
2210# ifndef Perl_isfinite
2211# ifdef HAS_ISFINITE
2212# define Perl_isfinite(x) isfinite(x)
2213# elif defined(HAS_FINITE)
2214# define Perl_isfinite(x) finite(x)
2215# endif
2216# endif
758a5d79
JH
2217#endif
2218
30404d48
JH
2219/* fpclassify(): C99. It is supposed to be a macro that switches on
2220* the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
2221#if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2222# include <math.h>
25c46df8
JH
2223# if defined(FP_INFINITE) && defined(FP_NAN)
2224# define Perl_fp_class(x) fpclassify(x)
2225# define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_INFINITE)
2226# define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_NAN)
2227# define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_NORMAL)
2228# define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2229# define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_ZERO)
2230# elif defined(FP_PLUS_INF) && defined(FP_QNAN)
2231/* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
2232 * actually not the C99 fpclassify, with its own set of return defines. */
2233# define Perl_fp_class(x) fpclassify(x)
2234# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
2235# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
82947af8 2236# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
25c46df8
JH
2237# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2238# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
1ae51000 2239# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
25c46df8
JH
2240# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
2241# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
2242# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
2243# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
2244# else
2245# undef Perl_fp_class /* Unknown set of defines */
2246# endif
30404d48
JH
2247#endif
2248
25c46df8
JH
2249/* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
2250 * are identical to the C99 fpclassify(). */
2251#if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
2252# include <math.h>
558f3e66
CB
2253# ifdef __VMS
2254 /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
2255# include <fp.h>
56610b8f
CB
2256 /* oh, and the isnormal macro has a typo in it! */
2257# undef isnormal
2258# define isnormal(x) Perl_fp_class_norm(x)
558f3e66 2259# endif
25c46df8
JH
2260# if defined(FP_INFINITE) && defined(FP_NAN)
2261# define Perl_fp_class(x) fp_classify(x)
2262# define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_INFINITE)
2263# define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_NAN)
2264# define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_NORMAL)
2265# define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2266# define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_ZERO)
2267# else
2268# undef Perl_fp_class /* Unknown set of defines */
2269# endif
f279e099 2270#endif
205f51d8 2271
30404d48
JH
2272/* Feel free to check with me for the SGI manpages, SGI testing,
2273 * etcetera, if you want to try getting this to work with IRIX.
2274 *
2275 * - Allen <allens@cpan.org> */
2276
2277/* fpclass(): SysV, at least Solaris and some versions of IRIX. */
758a5d79 2278#if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
25c46df8
JH
2279/* Solaris and IRIX have fpclass/fpclassl, but they are using
2280 * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2281 * Define some symbols also as cpp symbols so we can detect them. */
033a6f7a 2282# if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
25c46df8
JH
2283# define FP_PINF FP_PINF
2284# define FP_QNAN FP_QNAN
2285# endif
f279e099 2286# include <math.h>
758a5d79
JH
2287# ifdef I_IEEFP
2288# include <ieeefp.h>
2289# endif
2290# ifdef I_FP
2291# include <fp.h>
2292# endif
2293# if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
f279e099 2294# define Perl_fp_class(x) fpclassl(x)
758a5d79 2295# else
f279e099
JH
2296# define Perl_fp_class(x) fpclass(x)
2297# endif
25c46df8 2298# if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
f279e099
JH
2299# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_CLASS_SNAN)
2300# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_CLASS_QNAN)
2301# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_CLASS_NINF)
2302# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_CLASS_PINF)
2303# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_CLASS_NNORM)
2304# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_CLASS_PNORM)
2305# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_CLASS_NDENORM)
2306# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_CLASS_PDENORM)
2307# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_CLASS_NZERO)
2308# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_CLASS_PZERO)
25c46df8 2309# elif defined(FP_PINF) && defined(FP_QNAN)
f279e099
JH
2310# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2311# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2312# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_NINF)
2313# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PINF)
2314# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_NNORM)
2315# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PNORM)
2316# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_NDENORM)
2317# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PDENORM)
2318# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_NZERO)
2319# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PZERO)
25c46df8
JH
2320# else
2321# undef Perl_fp_class /* Unknown set of defines */
758a5d79 2322# endif
758a5d79
JH
2323#endif
2324
30404d48
JH
2325/* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2326#if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
758a5d79
JH
2327# include <math.h>
2328# if !defined(FP_SNAN) && defined(I_FP_CLASS)
2329# include <fp_class.h>
2330# endif
25c46df8 2331# if defined(FP_POS_INF) && defined(FP_QNAN)
033a6f7a 2332# ifdef __sgi /* XXX Configure test instead */
25c46df8
JH
2333# ifdef USE_LONG_DOUBLE
2334# define Perl_fp_class(x) fp_class_l(x)
2335# else
2336# define Perl_fp_class(x) fp_class_d(x)
2337# endif
f279e099 2338# else
25c46df8
JH
2339# if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2340# define Perl_fp_class(x) fp_classl(x)
2341# else
2342# define Perl_fp_class(x) fp_class(x)
2343# endif
f279e099 2344# endif
25c46df8
JH
2345# if defined(FP_POS_INF) && defined(FP_QNAN)
2346# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2347# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2348# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_NEG_INF)
2349# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_POS_INF)
2350# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_NEG_NORM)
2351# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_POS_NORM)
2352# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_NEG_DENORM)
2353# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_POS_DENORM)
2354# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_NEG_ZERO)
2355# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_POS_ZERO)
30404d48 2356# else
25c46df8 2357# undef Perl_fp_class /* Unknown set of defines */
30404d48 2358# endif
f279e099 2359# endif
30404d48
JH
2360#endif
2361
052758ae 2362/* class(), _class(): Legacy: AIX. */
758a5d79
JH
2363#if !defined(Perl_fp_class) && defined(HAS_CLASS)
2364# include <math.h>
25c46df8
JH
2365# if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2366# ifndef _cplusplus
2367# define Perl_fp_class(x) class(x)
2368# else
2369# define Perl_fp_class(x) _class(x)
2370# endif
2371# if defined(FP_PLUS_INF) && defined(FP_NANQ)
2372# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_NANS)
2373# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_NANQ)
2374# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
2375# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
2376# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
2377# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
2378# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
2379# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
2380# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
2381# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
2382# else
2383# undef Perl_fp_class /* Unknown set of defines */
2384# endif
758a5d79 2385# endif
30404d48
JH
2386#endif
2387
2388/* Win32: _fpclass(), _isnan(), _finite(). */
90f54b14 2389#ifdef _MSC_VER
796ea9ea
JH
2390# ifndef Perl_isnan
2391# define Perl_isnan(x) _isnan(x)
2392# endif
2393# ifndef Perl_isfinite
2394# define Perl_isfinite(x) _finite(x)
2395# endif
2396# ifndef Perl_fp_class_snan
25c46df8
JH
2397/* No simple way to #define Perl_fp_class because _fpclass()
2398 * returns a set of bits. */
796ea9ea
JH
2399# define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2400# define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
82947af8 2401# define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
796ea9ea
JH
2402# define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF))
2403# define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF))
2404# define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2405# define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2406# define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2407# define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2408# define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2409# define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2410# define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2411# define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2412# define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2413# define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2414# endif
f279e099
JH
2415#endif
2416
2417#if !defined(Perl_fp_class_inf) && \
2418 defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2419# define Perl_fp_class_inf(x) \
2420 (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2421#endif
2422
2423#if !defined(Perl_fp_class_nan) && \
2424 defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2425# define Perl_fp_class_nan(x) \
2426 (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2427#endif
2428
2429#if !defined(Perl_fp_class_zero) && \
2430 defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2431# define Perl_fp_class_zero(x) \
2432 (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2433#endif
2434
2435#if !defined(Perl_fp_class_norm) && \
2436 defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2437# define Perl_fp_class_norm(x) \
2438 (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2439#endif
2440
2441#if !defined(Perl_fp_class_denorm) && \
2442 defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2443# define Perl_fp_class_denorm(x) \
2444 (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
796ea9ea 2445#endif
758a5d79
JH
2446
2447#ifndef Perl_isnan
1a322af2
JH
2448# ifdef Perl_fp_class_nan
2449# define Perl_isnan(x) Perl_fp_class_nan(x)
da5fdda8
AC
2450# elif defined(HAS_UNORDERED)
2451# define Perl_isnan(x) unordered((x), 0.0)
758a5d79 2452# else
da5fdda8 2453# define Perl_isnan(x) ((x)!=(x))
758a5d79
JH
2454# endif
2455#endif
2456
1a322af2
JH
2457#ifndef Perl_isinf
2458# ifdef Perl_fp_class_inf
2459# define Perl_isinf(x) Perl_fp_class_inf(x)
2460# endif
ca6c63e1
JH
2461#endif
2462
758a5d79 2463#ifndef Perl_isfinite
25c46df8 2464# if defined(HAS_ISFINITE) && !defined(isfinite)
c496ca58 2465# define Perl_isfinite(x) isfinite((double)(x))
4efd38a4 2466# elif defined(HAS_FINITE)
c496ca58 2467# define Perl_isfinite(x) finite((double)(x))
4efd38a4
JH
2468# elif defined(Perl_fp_class_finite)
2469# define Perl_isfinite(x) Perl_fp_class_finite(x)
758a5d79 2470# else
c496ca58
JH
2471/* For the infinities the multiplication returns nan,
2472 * for the nan the multiplication also returns nan,
2473 * for everything else (that is, finite) zero should be returned. */
4efd38a4 2474# define Perl_isfinite(x) (((x) * 0) == 0)
a3540c92 2475# endif
65202027
DS
2476#endif
2477
25c46df8
JH
2478#ifndef Perl_isinf
2479# if defined(Perl_isfinite) && defined(Perl_isnan)
2480# define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2481# endif
2482#endif
2483
d3685250
JH
2484/* We need Perl_isfinitel (ends with ell) (if available) even when
2485 * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2486 * needs that. */
2487#if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2488/* If isfinite() is a macro and looks like we have C99,
2489 * we assume it's the type-aware C99 isfinite(). */
c06e9e3e 2490# if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
d3685250
JH
2491# define Perl_isfinitel(x) isfinite(x)
2492# elif defined(HAS_ISFINITEL)
2493# define Perl_isfinitel(x) isfinitel(x)
2494# elif defined(HAS_FINITEL)
2495# define Perl_isfinitel(x) finitel(x)
2496# elif defined(HAS_INFL) && defined(HAS_NANL)
2497# define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
16334e6e 2498# else
99bf9e32 2499# define Perl_isfinitel(x) ((x) * 0 == 0) /* See Perl_isfinite. */
d3685250
JH
2500# endif
2501#endif
2502
a36244b7
JH
2503/* The default is to use Perl's own atof() implementation (in numeric.c).
2504 * Usually that is the one to use but for some platforms (e.g. UNICOS)
2505 * it is however best to use the native implementation of atof.
2506 * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2507 * Some good tests to try out with either setting are t/base/num.t,
205f51d8
AS
2508 * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2509 * you may need to be using a different function than atof! */
a36244b7
JH
2510
2511#ifndef USE_PERL_ATOF
2512# ifndef _UNICOS
2513# define USE_PERL_ATOF
2514# endif
2515#else
2516# if USE_PERL_ATOF == 0
2517# undef USE_PERL_ATOF
2518# endif
2519#endif
2520
2521#ifdef USE_PERL_ATOF
2522# define Perl_atof(s) Perl_my_atof(s)
6928bedc 2523# define Perl_atof2(s, n) Perl_my_atof3(aTHX_ (s), &(n), 0)
a36244b7
JH
2524#else
2525# define Perl_atof(s) (NV)atof(s)
2526# define Perl_atof2(s, n) ((n) = atof(s))
2527#endif
6928bedc 2528#define my_atof2(a,b) my_atof3(a,b,0)
cf2093f6 2529
99abf803
PP
2530/*
2531 * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2532 * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2533 * depending on local options. Until Configure detects this (or at least
2534 * detects whether the "signed" keyword is available) the CHAR ranges
2535 * will not be included. UCHAR functions normally.
2536 * - kja
2537 */
27d4fb96 2538
6ec488b3
AC
2539#define PERL_UCHAR_MIN ((unsigned char)0)
2540#define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
27d4fb96 2541
6ec488b3
AC
2542#define PERL_USHORT_MIN ((unsigned short)0)
2543#define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
27d4fb96 2544
6ec488b3
AC
2545#define PERL_SHORT_MAX ((short)SHRT_MAX)
2546#define PERL_SHORT_MIN ((short)SHRT_MIN)
27d4fb96 2547
6ec488b3 2548#define PERL_UINT_MAX ((unsigned int)UINT_MAX)
99abf803 2549#define PERL_UINT_MIN ((unsigned int)0)
27d4fb96 2550
6ec488b3
AC
2551#define PERL_INT_MAX ((int)INT_MAX)
2552#define PERL_INT_MIN ((int)INT_MIN)
27d4fb96 2553
6ec488b3 2554#define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
99abf803 2555#define PERL_ULONG_MIN ((unsigned long)0L)
27d4fb96 2556
6ec488b3
AC
2557#define PERL_LONG_MAX ((long)LONG_MAX)
2558#define PERL_LONG_MIN ((long)LONG_MIN)
760ac839 2559
d7d93a81 2560#ifdef UV_IS_QUAD
99abf803 2561# define PERL_UQUAD_MAX (~(UV)0)
f1c3b19a 2562# define PERL_UQUAD_MIN ((UV)0)
99abf803 2563# define PERL_QUAD_MAX ((IV) (PERL_UQUAD_MAX >> 1))
a6e633de 2564# define PERL_QUAD_MIN (-PERL_QUAD_MAX - ((3 & -1) == 3))
79072805
LW
2565#endif
2566
d78a5caa
KW
2567/*
2568=head1 Numeric functions
2569
2570=for apidoc AmnUh||PERL_INT_MIN
2571=for apidoc AmnUh||PERL_LONG_MAX
2572=for apidoc AmnUh||PERL_LONG_MIN
2573=for apidoc AmnUh||PERL_QUAD_MAX
2574=for apidoc AmnUh||PERL_SHORT_MAX
2575=for apidoc AmnUh||PERL_SHORT_MIN
2576=for apidoc AmnUh||PERL_UCHAR_MAX
2577=for apidoc AmnUh||PERL_UCHAR_MIN
2578=for apidoc AmnUh||PERL_UINT_MAX
2579=for apidoc AmnUh||PERL_ULONG_MAX
2580=for apidoc AmnUh||PERL_ULONG_MIN
2581=for apidoc AmnUh||PERL_UQUAD_MAX
2582=for apidoc AmnUh||PERL_UQUAD_MIN
2583=for apidoc AmnUh||PERL_USHORT_MAX
2584=for apidoc AmnUh||PERL_USHORT_MIN
2585=for apidoc AmnUh||PERL_QUAD_MIN
2586=for apidoc AmnU||PERL_INT_MAX
2587This and
2588C<PERL_INT_MIN>,
2589C<PERL_LONG_MAX>,
2590C<PERL_LONG_MIN>,
2591C<PERL_QUAD_MAX>,
2592C<PERL_SHORT_MAX>,
2593C<PERL_SHORT_MIN>,
2594C<PERL_UCHAR_MAX>,
2595C<PERL_UCHAR_MIN>,
2596C<PERL_UINT_MAX>,
2597C<PERL_ULONG_MAX>,
2598C<PERL_ULONG_MIN>,
2599C<PERL_UQUAD_MAX>,
2600C<PERL_UQUAD_MIN>,
2601C<PERL_USHORT_MAX>,
2602C<PERL_USHORT_MIN>,
2603C<PERL_QUAD_MIN>
2604give the largest and smallest number representable in the current
2605platform in variables of the corresponding types.
2606
2607For signed types, the smallest representable number is the most negative
2608number, the one furthest away from zero.
2609
2610For C99 and later compilers, these correspond to things like C<INT_MAX>, which
2611are available to the C code. But these constants, furnished by Perl,
2612allow code compiled on earlier compilers to portably have access to the same
2613constants.
2614
2615=cut
2616
2617*/
2618
ee0007ab 2619typedef MEM_SIZE STRLEN;
450a55e4 2620
79072805
LW
2621typedef struct op OP;
2622typedef struct cop COP;
2623typedef struct unop UNOP;
2f7c6295 2624typedef struct unop_aux UNOP_AUX;
79072805
LW
2625typedef struct binop BINOP;
2626typedef struct listop LISTOP;
2627typedef struct logop LOGOP;
79072805
LW
2628typedef struct pmop PMOP;
2629typedef struct svop SVOP;
7934575e 2630typedef struct padop PADOP;
79072805 2631typedef struct pvop PVOP;
79072805 2632typedef struct loop LOOP;
b46e009d 2633typedef struct methop METHOP;
79072805 2634
7aef8e5b 2635#ifdef PERL_CORE
8be227ab
FC
2636typedef struct opslab OPSLAB;
2637typedef struct opslot OPSLOT;
2638#endif
2639
52db365a 2640typedef struct block_hooks BHK;
1830b3d9 2641typedef struct custom_op XOP;
52db365a 2642
cd1541b2
NC
2643typedef struct interpreter PerlInterpreter;
2644
d2b3f365 2645/* SGI's <sys/sema.h> has struct sv */
cc3315ba 2646#if defined(__sgi)
d2b3f365 2647# define STRUCT_SV perl_sv
b8d3c5db
JH
2648#else
2649# define STRUCT_SV sv
2650#endif
2651typedef struct STRUCT_SV SV;
79072805
LW
2652typedef struct av AV;
2653typedef struct hv HV;
2654typedef struct cv CV;
d2f13c59 2655typedef struct p5rx REGEXP;
79072805 2656typedef struct gp GP;
0c30d9ec 2657typedef struct gv GV;
8990e307 2658typedef struct io IO;
c09156bb 2659typedef struct context PERL_CONTEXT;
79072805
LW
2660typedef struct block BLOCK;
2661
2662typedef struct magic MAGIC;
2663typedef struct xpv XPV;
2664typedef struct xpviv XPVIV;
ff68c719 2665typedef struct xpvuv XPVUV;
79072805
LW
2666typedef struct xpvnv XPVNV;
2667typedef struct xpvmg XPVMG;
2668typedef struct xpvlv XPVLV;
d361b004 2669typedef struct xpvinvlist XINVLIST;
79072805
LW
2670typedef struct xpvav XPVAV;
2671typedef struct xpvhv XPVHV;
2672typedef struct xpvgv XPVGV;
2673typedef struct xpvcv XPVCV;
2674typedef struct xpvbm XPVBM;
2675typedef struct xpvfm XPVFM;
8990e307 2676typedef struct xpvio XPVIO;
79072805
LW
2677typedef struct mgvtbl MGVTBL;
2678typedef union any ANY;
5f7fde29
GS
2679typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2680typedef struct ptr_tbl PTR_TBL_t;
8cf8f3d1
NIS
2681typedef struct clone_params CLONE_PARAMS;
2682
0f94cb1f 2683/* a pad is currently just an AV; but that might change,
7261499d
FC
2684 * so hide the type. */
2685typedef struct padlist PADLIST;
67634234 2686typedef AV PAD;
9b7476d7 2687typedef struct padnamelist PADNAMELIST;
0f94cb1f 2688typedef struct padname PADNAME;
67634234 2689
5a736967
DM
2690/* always enable PERL_OP_PARENT */
2691#if !defined(PERL_OP_PARENT)
5d32d268
DM
2692# define PERL_OP_PARENT
2693#endif
2694
93c10d60
FC
2695/* enable PERL_COPY_ON_WRITE by default */
2696#if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2697# define PERL_COPY_ON_WRITE
13b0f67d 2698#endif
07d01d6e 2699
93c10d60 2700#ifdef PERL_COPY_ON_WRITE
db2c6cb3 2701# define PERL_ANY_COW
9f351b45
DM
2702#else
2703# define PERL_SAWAMPERSAND
db2c6cb3
FC
2704#endif
2705
40653c20
FC
2706#if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2707# error PERL_DEBUG_READONLY_OPS only works with ithreads
2708#endif
2709
378cc40b 2710#include "handy.h"
64935bc6 2711#include "charclass_invlists.h"
a0d0e21e 2712
6b8eaf93 2713#if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
6b8eaf93
JH
2714# if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2715# define USE_64_BIT_RAWIO /* implicit */
2716# endif
4564133c
JH
2717#endif
2718
6b8eaf93
JH
2719/* Notice the use of HAS_FSEEKO: now we are obligated to always use
2720 * fseeko/ftello if possible. Don't go #defining ftell to ftello yourself,
2721 * however, because operating systems like to do that themself. */
2722#ifndef FSEEKSIZE
2723# ifdef HAS_FSEEKO
2724# define FSEEKSIZE LSEEKSIZE
2725# else
2726# define FSEEKSIZE LONGSIZE
d460ef45 2727# endif
6b8eaf93
JH
2728#endif
2729
2730#if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
6b8eaf93
JH
2731# if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2732# define USE_64_BIT_STDIO /* implicit */
2733# endif
2734#endif
4564133c 2735
09458382 2736#ifdef USE_64_BIT_RAWIO
d9b3e12d
JH
2737# ifdef HAS_OFF64_T
2738# undef Off_t
2739# define Off_t off64_t
2740# undef LSEEKSIZE
2741# define LSEEKSIZE 8
5ff3f7a4 2742# endif
d9b3e12d
JH
2743/* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2744 * will trigger defines like the ones below. Some 64-bit environments,
09458382 2745 * however, do not. Therefore we have to explicitly mix and match. */
d9b3e12d
JH
2746# if defined(USE_OPEN64)
2747# define open open64
5ff3f7a4 2748# endif
d9b3e12d
JH
2749# if defined(USE_LSEEK64)
2750# define lseek lseek64
6b8eaf93
JH
2751# else
2752# if defined(USE_LLSEEK)
2753# define lseek llseek
2754# endif
d9b3e12d
JH
2755# endif
2756# if defined(USE_STAT64)
2757# define stat stat64
2758# endif
2759# if defined(USE_FSTAT64)
2760# define fstat fstat64
2761# endif
2762# if defined(USE_LSTAT64)
2763# define lstat lstat64
2764# endif
2765# if defined(USE_FLOCK64)
2766# define flock flock64
2767# endif
2768# if defined(USE_LOCKF64)
2769# define lockf lockf64
2770# endif
2771# if defined(USE_FCNTL64)
2772# define fcntl fcntl64
2773# endif
2774# if defined(USE_TRUNCATE64)
2775# define truncate truncate64
2776# endif
2777# if defined(USE_FTRUNCATE64)
2778# define ftruncate ftruncate64
2779# endif
2780#endif
2781
2782#ifdef USE_64_BIT_STDIO
2783# ifdef HAS_FPOS64_T
2784# undef Fpos_t
2785# define Fpos_t fpos64_t
2786# endif
2787/* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2788 * will trigger defines like the ones below. Some 64-bit environments,
2789 * however, do not. */
2790# if defined(USE_FOPEN64)
2791# define fopen fopen64
2792# endif
2793# if defined(USE_FSEEK64)
6b8eaf93 2794# define fseek fseek64 /* don't do fseeko here, see perlio.c */
d9b3e12d
JH
2795# endif
2796# if defined(USE_FTELL64)
6b8eaf93 2797# define ftell ftell64 /* don't do ftello here, see perlio.c */
d9b3e12d
JH
2798# endif
2799# if defined(USE_FSETPOS64)
2800# define fsetpos fsetpos64
2801# endif
2802# if defined(USE_FGETPOS64)
2803# define fgetpos fgetpos64
2804# endif
2805# if defined(USE_TMPFILE64)
2806# define tmpfile tmpfile64
2807# endif
2808# if defined(USE_FREOPEN64)
2809# define freopen freopen64
5ff3f7a4
GS
2810# endif
2811#endif
2812
e37778c2 2813#if defined(OS2)
2c2d71f5
JH
2814# include "iperlsys.h"
2815#endif
2816
748a9306 2817#ifdef DOSISH
19848b3f
JH
2818# if defined(OS2)
2819# include "os2ish.h"
2820# else
2821# include "dosish.h"
2822# endif
009819bb 2823#elif defined(VMS)
748a9306 2824# include "vmsish.h"
009819bb 2825#elif defined(PLAN9)
19848b3f 2826# include "./plan9/plan9ish.h"
009819bb 2827#elif defined(__VOS__)
196918b0
PG
2828# ifdef __GNUC__
2829# include "./vos/vosish.h"
2830# else
2831# include "vos/vosish.h"
2832# endif
009819bb 2833#elif defined(__HAIKU__)
df00ff3b 2834# include "haiku/haikuish.h"
009819bb 2835#else
19848b3f 2836# include "unixish.h"
13b6e58c
JH
2837#endif
2838
ea34f6bd 2839#ifdef __amigaos4__
3c0208ad
AB
2840# include "amigaos.h"
2841# undef FD_CLOEXEC /* a lie in AmigaOS */
2842#endif
2843
2946a158 2844/* NSIG logic from Configure --> */
2946a158
JH
2845#ifndef NSIG
2846# ifdef _NSIG
2847# define NSIG (_NSIG)
da5fdda8 2848# elif defined(SIGMAX)
2946a158 2849# define NSIG (SIGMAX+1)
da5fdda8 2850# elif defined(SIG_MAX)
2946a158 2851# define NSIG (SIG_MAX+1)
da5fdda8 2852# elif defined(_SIG_MAX)
2946a158 2853# define NSIG (_SIG_MAX+1)
da5fdda8 2854# elif defined(MAXSIG)
2946a158 2855# define NSIG (MAXSIG+1)
da5fdda8 2856# elif defined(MAX_SIG)
2946a158 2857# define NSIG (MAX_SIG+1)
da5fdda8 2858# elif defined(SIGARRAYSIZE)
2946a158 2859# define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
da5fdda8 2860# elif defined(_sys_nsig)
2946a158 2861# define NSIG (_sys_nsig) /* Solaris 2.5 */
da5fdda8
AC
2862# else
2863 /* Default to some arbitrary number that's big enough to get most
2864 * of the common signals. */
2946a158 2865# define NSIG 50
da5fdda8 2866# endif
2946a158
JH
2867#endif
2868/* <-- NSIG logic from Configure */
2869
13b6e58c
JH
2870#ifndef NO_ENVIRON_ARRAY
2871# define USE_ENVIRON_ARRAY
2872#endif
32f822de 2873
2bc5f86a
KW
2874#ifdef USE_ITHREADS
2875 /* On some platforms it would be safe to use a read/write mutex with many
2876 * readers possible at the same time. On other platforms, notably IBM ones,
2877 * subsequent getenv calls destroy earlier ones. Those platforms would not
2878 * be able to handle simultaneous getenv calls */
2879# define ENV_LOCK MUTEX_LOCK(&PL_env_mutex)
2880# define ENV_UNLOCK MUTEX_UNLOCK(&PL_env_mutex)
2881# define ENV_INIT MUTEX_INIT(&PL_env_mutex);
2882# define ENV_TERM MUTEX_DESTROY(&PL_env_mutex);
2883#else
2884# define ENV_LOCK NOOP;
2885# define ENV_UNLOCK NOOP;
2886# define ENV_INIT NOOP;
2887# define ENV_TERM NOOP;
2888#endif
e7124897 2889
80c27f77
KW
2890/* Some critical sections need to lock both the locale and the environment.
2891 * XXX khw intends to change this to lock both mutexes, but that brings up
2892 * issues of potential deadlock, so should be done at the beginning of a
2893 * development cycle. So for now, it just locks the environment. Note that
2894 * many modern platforms are locale-thread-safe anyway, so locking the locale
2895 * mutex is a no-op anyway */
2896#define ENV_LOCALE_LOCK ENV_LOCK
2897#define ENV_LOCALE_UNLOCK ENV_UNLOCK
2898
2899/* And some critical sections care only that no one else is writing either the
2900 * locale nor the environment. XXX Again this is for the future. This can be
2901 * simulated with using COND_WAIT in thread.h */
2902#define ENV_LOCALE_READ_LOCK ENV_LOCALE_LOCK
2903#define ENV_LOCALE_READ_UNLOCK ENV_LOCALE_UNLOCK
2904
5e7940ce 2905#if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
c99d8cd6
DM
2906 /* having sigaction(2) means that the OS supports both 1-arg and 3-arg
2907 * signal handlers. But the perl core itself only fully supports 1-arg
2908 * handlers, so don't enable for now.
2909 * NB: POSIX::sigaction() supports both.
2910 *
2911 * # define PERL_USE_3ARG_SIGHANDLER
2912 */
5e7940ce
DM
2913#endif
2914
e7124897
DM
2915/* Siginfo_t:
2916 * This is an alias for the OS's siginfo_t, except that where the OS
2917 * doesn't support it, declare a dummy version instead. This allows us to
2918 * have signal handler functions which always have a Siginfo_t parameter
2919 * regardless of platform, (and which will just be passed a NULL value
2920 * where the OS doesn't support HAS_SIGACTION).
2921 */
2922
2923#if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
2924 typedef siginfo_t Siginfo_t;
2925#else
3555a05c
LT
2926#ifdef si_signo /* minix */
2927#undef si_signo
2928#endif
e7124897
DM
2929 typedef struct {
2930 int si_signo;
2931 } Siginfo_t;
2932#endif
2933
2934
c77b533b
JH
2935/*
2936 * initialise to avoid floating-point exceptions from overflow, etc
2937 */
2938#ifndef PERL_FPU_INIT
2939# ifdef HAS_FPSETMASK
2940# if HAS_FLOATINGPOINT_H
2941# include <floatingpoint.h>
2942# endif
ad3a8c67
NC
2943/* Some operating systems have this as a macro, which in turn expands to a comma
2944 expression, and the last sub-expression is something that gets calculated,
2945 and then they have the gall to warn that a value computed is not used. Hence
2946 cast to void. */
2947# define PERL_FPU_INIT (void)fpsetmask(0)
da5fdda8
AC
2948# elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2949# define PERL_FPU_INIT PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2950# define PERL_FPU_PRE_EXEC { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2951# define PERL_FPU_POST_EXEC rsignal_restore(SIGFPE, &xfpe); }
c77b533b 2952# else
da5fdda8 2953# define PERL_FPU_INIT
c77b533b
JH
2954# endif
2955#endif
b35112e7
CS
2956#ifndef PERL_FPU_PRE_EXEC
2957# define PERL_FPU_PRE_EXEC {
2958# define PERL_FPU_POST_EXEC }
2959#endif
c77b533b 2960
a308b05a
JH
2961/* In Tru64 the cc -ieee enables the IEEE math but disables traps.
2962 * We need to reenable the "invalid" trap because otherwise generation
2963 * of NaN values leaves the IEEE fp flags in bad state, leaving any further
2964 * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
2965#ifdef __osf__
2966# include <machine/fpu.h>
2967# define PERL_SYS_FPU_INIT \
2968 STMT_START { \
2969 ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
2970 signal(SIGFPE, SIG_IGN); \
2971 } STMT_END
2972#endif
94a08944
JH
2973/* In IRIX the default for Flush to Zero bit is true,
2974 * which means that results going below the minimum of normal
2975 * floating points go to zero, instead of going denormal/subnormal.
2976 * This is unlike almost any other system running Perl, so let's clear it.
2977 * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
2978 * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
2979 *
2980 * XXX The flush-to-zero behaviour should be a Configure scan.
2981 * To change the behaviour usually requires some system-specific
2982 * incantation, though, like the below. */
2983#ifdef __sgi
2984# include <sys/fpu.h>
2985# define PERL_SYS_FPU_INIT \
2986 STMT_START { \
2987 union fpc_csr csr; \
2988 csr.fc_word = get_fpc_csr(); \
2989 csr.fc_struct.flush = 0; \
2990 set_fpc_csr(csr.fc_word); \
2991 } STMT_END
2992#endif
a308b05a
JH
2993
2994#ifndef PERL_SYS_FPU_INIT
2995# define PERL_SYS_FPU_INIT NOOP
2996#endif
2997
cbec8ebe
DM
2998#ifndef PERL_SYS_INIT3_BODY
2999# define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
ed344e4f
IZ
3000#endif
3001
eb533572 3002/*
dcccc8ff
KW
3003=head1 Miscellaneous Functions
3004
4ad9e498 3005=for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
eb533572 3006Provides system-specific tune up of the C runtime environment necessary to
72d33970 3007run Perl interpreters. This should be called only once, before creating
eb533572
DM
3008any Perl interpreters.
3009
4ad9e498 3010=for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
eb533572 3011Provides system-specific tune up of the C runtime environment necessary to
72d33970 3012run Perl interpreters. This should be called only once, before creating
eb533572
DM
3013any Perl interpreters.
3014
3015=for apidoc Am|void|PERL_SYS_TERM|
3016Provides system-specific clean up of the C runtime environment after
72d33970 3017running Perl interpreters. This should be called only once, after
eb533572
DM
3018freeing any remaining Perl interpreters.
3019
3020=cut
3021 */
3022
cbec8ebe
DM
3023#define PERL_SYS_INIT(argc, argv) Perl_sys_init(argc, argv)
3024#define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
d0820ef1 3025#define PERL_SYS_TERM() Perl_sys_term()
cbec8ebe 3026
be708cc0
JH
3027#ifndef PERL_WRITE_MSG_TO_CONSOLE
3028# define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
3029#endif
3030
0f31cffe
GS
3031#ifndef MAXPATHLEN
3032# ifdef PATH_MAX
b990c8b2
JH
3033# ifdef _POSIX_PATH_MAX
3034# if PATH_MAX > _POSIX_PATH_MAX
09448d78
JH
3035/* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
3036 * included the null byte or not. Later amendments of POSIX,
3037 * XPG4, the Austin Group, and the Single UNIX Specification
3038 * all explicitly include the null byte in the PATH_MAX.
3039 * Ditto for _POSIX_PATH_MAX. */
3040# define MAXPATHLEN PATH_MAX
b990c8b2 3041# else
09448d78 3042# define MAXPATHLEN _POSIX_PATH_MAX
b990c8b2
JH
3043# endif
3044# else
3045# define MAXPATHLEN (PATH_MAX+1)
3046# endif
0f31cffe 3047# else
d552bce8 3048# define MAXPATHLEN 1024 /* Err on the large side. */
0f31cffe
GS
3049# endif
3050#endif
3051
3baee7cc
JH
3052/* clang Thread Safety Analysis/Annotations/Attributes
3053 * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
3054 *
bdc795f4 3055 * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
3baee7cc 3056 * Apple XCode hijacks __clang_major__ and __clang_minor__
bdc795f4
JH
3057 * (6.1 means really clang 3.6), so needs extra hijinks
3058 * (could probably also test the contents of __apple_build_version__).
3baee7cc
JH
3059 */
3060#if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
3061 defined(__clang__) && \
3062 !defined(SWIG) && \
3063 ((!defined(__apple_build_version__) && \
bdc795f4 3064 ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
8412ccf9 3065 (__clang_major__ >= 4))) || \
3baee7cc 3066 (defined(__apple_build_version__) && \
bdc795f4
JH
3067 ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
3068 (__clang_major__ >= 7))))
3baee7cc
JH
3069# define PERL_TSA__(x) __attribute__((x))
3070# define PERL_TSA_ACTIVE
3071#else
3072# define PERL_TSA__(x) /* No TSA, make TSA attributes no-ops. */
3073# undef PERL_TSA_ACTIVE
3074#endif
3075
3076/* PERL_TSA_CAPABILITY() is used to annotate typedefs.
3077 * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
3078 */
3079#define PERL_TSA_CAPABILITY(x) \
3080 PERL_TSA__(capability(x))
3081
3082/* In the below examples the mutex must be lexically visible, usually
3083 * either as global variables, or as function arguments. */
3084
3085/* PERL_TSA_GUARDED_BY() is used to annotate global variables.
3086 *
3087 * Foo foo PERL_TSA_GUARDED_BY(mutex);
3088 */
3089#define PERL_TSA_GUARDED_BY(x) \
3090 PERL_TSA__(guarded_by(x))
3091
3092/* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
3093 * The data _behind_ the pointer is guarded.
3094 *
3095 * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
3096 */
3097#define PERL_TSA_PT_GUARDED_BY(x) \
3098 PERL_TSA__(pt_guarded_by(x))
3099
3100/* PERL_TSA_REQUIRES() is used to annotate functions.
3101 * The caller MUST hold the resource when calling the function.
3102 *
3103 * void Foo() PERL_TSA_REQUIRES(mutex);
3104 */
3105#define PERL_TSA_REQUIRES(x) \
3106 PERL_TSA__(requires_capability(x))
3107
3108/* PERL_TSA_EXCLUDES() is used to annotate functions.
3109 * The caller MUST NOT hold resource when calling the function.
3110 *
3111 * EXCLUDES should be used when the function first acquires
3112 * the resource and then releases it. Use to avoid deadlock.
3113 *
3114 * void Foo() PERL_TSA_EXCLUDES(mutex);
3115 */
3116#define PERL_TSA_EXCLUDES(x) \
3117 PERL_TSA__(locks_excluded(x))
3118
3119/* PERL_TSA_ACQUIRE() is used to annotate functions.
3120 * The caller MUST NOT hold the resource when calling the function,
3121 * and the function will acquire the resource.
3122 *
3123 * void Foo() PERL_TSA_ACQUIRE(mutex);
3124 */
3125#define PERL_TSA_ACQUIRE(x) \
3126 PERL_TSA__(acquire_capability(x))
3127
3128/* PERL_TSA_RELEASE() is used to annotate functions.
3129 * The caller MUST hold the resource when calling the function,
3130 * and the function will release the resource.
3131 *
3132 * void Foo() PERL_TSA_RELEASE(mutex);
3133 */
3134#define PERL_TSA_RELEASE(x) \
3135 PERL_TSA__(release_capability(x))
3136
3137/* PERL_TSA_NO_TSA is used to annotate functions.
3138 * Used when being intentionally unsafe, or when the code is too
3139 * complicated for the analysis. Use sparingly.
3140 *
3141 * void Foo() PERL_TSA_NO_TSA;
3142 */
3143#define PERL_TSA_NO_TSA \
3144 PERL_TSA__(no_thread_safety_analysis)
3145
3146/* There are more annotations/attributes available, see the clang
3147 * documentation for details. */
3148
3db8f154 3149#if defined(USE_ITHREADS)
2986a63f 3150# ifdef NETWARE
da5fdda8
AC
3151# include <nw5thread.h>
3152# elif defined(WIN32)
3153# include <win32thread.h>
3154# elif defined(OS2)
3155# include "os2thread.h"
3156# elif defined(I_MACH_CTHREADS)
3157# include <mach/cthreads.h>
7f3d1cf1
BH
3158typedef cthread_t perl_os_thread;
3159typedef mutex_t perl_mutex;
3160typedef condition_t perl_cond;
3161typedef void * perl_key;
da5fdda8
AC
3162# elif defined(I_PTHREAD) /* Posix threads */
3163# include <pthread.h>
7f3d1cf1 3164typedef pthread_t perl_os_thread;
3baee7cc 3165typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
7f3d1cf1
BH
3166typedef pthread_cond_t perl_cond;
3167typedef pthread_key_t perl_key;
da5fdda8 3168# endif
3db8f154 3169#endif /* USE_ITHREADS */
c5be433b 3170
3baee7cc
JH
3171#ifdef PERL_TSA_ACTIVE
3172/* Since most pthread mutex interfaces have not been annotated, we
3173 * need to have these wrappers. The NO_TSA annotation is quite ugly
3174 * but it cannot be avoided in plain C, unlike in C++, where one could
3175 * e.g. use ACQUIRE() with no arg on a mutex lock method.
3176 *
3177 * The bodies of these wrappers are in util.c
3178 *
3179 * TODO: however, some platforms are starting to get these clang
3180 * thread safety annotations for pthreads, for example FreeBSD.
3181 * Do we need a way to a bypass these wrappers? */
67083b7b 3182EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
3baee7cc
JH
3183 PERL_TSA_ACQUIRE(*mutex)
3184 PERL_TSA_NO_TSA;
67083b7b 3185EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
3baee7cc
JH
3186 PERL_TSA_RELEASE(*mutex)
3187 PERL_TSA_NO_TSA;
3188#endif
3189
66a93824 3190#if defined(WIN32)
1feb2720 3191# include "win32.h"
c5be433b
GS
3192#endif
3193
2986a63f
JH
3194#ifdef NETWARE
3195# include "netware.h"
3196#endif
3197
e5218da5 3198#define STATUS_UNIX PL_statusvalue
68dc0745 3199#ifdef VMS
6b88bc9c 3200# define STATUS_NATIVE PL_statusvalue_vms
7a7fd8e0
JM
3201/*
3202 * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
ff7298cb 3203 * its contents can not be trusted. Unfortunately, Perl seems to check
7a7fd8e0
JM
3204 * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
3205 * be updated also.
3206 */
3207# include <stsdef.h>
3208# include <ssdef.h>
3209/* Presume this because if VMS changes it, it will require a new
3210 * set of APIs for waiting on children for binary compatibility.
3211 */
3212# define child_offset_bits (8)
3213# ifndef C_FAC_POSIX
3214# define C_FAC_POSIX 0x35A000
3215# endif
3216
3217/* STATUS_EXIT - validates and returns a NATIVE exit status code for the
3218 * platform from the existing UNIX or Native status values.
3219 */
3220
37038d91 3221# define STATUS_EXIT \
7a7fd8e0
JM
3222 (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
3223 (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
3224
7a7fd8e0 3225
fb38d079
JM
3226/* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
3227 * exit code and shifts the UNIX value over the correct number of bits to
3228 * be a child status. Usually the number of bits is 8, but that could be
3229 * platform dependent. The NATIVE status code is presumed to have either
3230 * from a child process.
7a7fd8e0
JM
3231 */
3232
fb38d079
JM
3233/* This is complicated. The child processes return a true native VMS
3234 status which must be saved. But there is an assumption in Perl that
3235 the UNIX child status has some relationship to errno values, so
00f254e2 3236 Perl tries to translate it to text in some of the tests.
fb38d079
JM
3237 In order to get the string translation correct, for the error, errno
3238 must be EVMSERR, but that generates a different text message
3239 than what the test programs are expecting. So an errno value must
3240 be derived from the native status value when an error occurs.
3241 That will hide the true native status message. With this version of
3242 perl, the true native child status can always be retrieved so that
3243 is not a problem. But in this case, Pl_statusvalue and errno may
3244 have different values in them.
3245 */
7a7fd8e0 3246
fb38d079 3247# define STATUS_NATIVE_CHILD_SET(n) \
68dc0745 3248 STMT_START { \
2fbb330f
JM
3249 I32 evalue = (I32)n; \
3250 if (evalue == EVMSERR) { \
3251 PL_statusvalue_vms = vaxc$errno; \
3252 PL_statusvalue = evalue; \
7a7fd8e0 3253 } else { \
2fbb330f 3254 PL_statusvalue_vms = evalue; \
fb38d079 3255 if (evalue == -1) { \
3280af22 3256 PL_statusvalue = -1; \
7a7fd8e0
JM
3257 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3258 } else \
fb38d079 3259 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1); \
2fbb330f 3260 set_vaxc_errno(evalue); \
fb38d079
JM
3261 if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX) \
3262 set_errno(EVMSERR); \
3263 else set_errno(Perl_vms_status_to_unix(evalue, 0)); \
3264 PL_statusvalue = PL_statusvalue << child_offset_bits; \
2fbb330f 3265 } \
68dc0745 3266 } STMT_END
7a7fd8e0 3267
68dc0745 3268# ifdef VMSISH_STATUS
e5218da5 3269# define STATUS_CURRENT (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
68dc0745 3270# else
e5218da5 3271# define STATUS_CURRENT STATUS_UNIX
68dc0745 3272# endif
7a7fd8e0
JM
3273
3274 /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3275 * the NATIVE status to an equivalent value. Can not be used to translate
3276 * exit code values as exit code values are not guaranteed to have any
3277 * relationship at all to errno values.
3278 * This is used when Perl is forcing errno to have a specific value.
3279 */
e5218da5 3280# define STATUS_UNIX_SET(n) \
68dc0745 3281 STMT_START { \
7a7fd8e0 3282 I32 evalue = (I32)n; \
0968cdad 3283 PL_statusvalue = evalue; \
3280af22 3284 if (PL_statusvalue != -1) { \
0968cdad
JM
3285 if (PL_statusvalue != EVMSERR) { \
3286 PL_statusvalue &= 0xFFFF; \
3287 if (MY_POSIX_EXIT) \
3288 PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3289 else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3290 } \
3291 else { \
3292 PL_statusvalue_vms = vaxc$errno; \
3293 } \
68dc0745 3294 } \
0968cdad
JM
3295 else PL_statusvalue_vms = SS$_ABORT; \
3296 set_vaxc_errno(PL_statusvalue_vms); \
7a7fd8e0
JM
3297 } STMT_END
3298
3299 /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
e08e1e1d
JM
3300 * the NATIVE error status based on it.
3301 *
3302 * When in the default mode to comply with the Perl VMS documentation,
3303 * 0 is a success and any other code sets the NATIVE status to a failure
3304 * code of SS$_ABORT.
fb38d079
JM
3305 *
3306 * In the new POSIX EXIT mode, native status will be set so that the
3307 * actual exit code will can be retrieved by the calling program or
3308 * shell.
3309 *
3310 * If the exit code is not clearly a UNIX parent or child exit status,
3311 * it will be passed through as a VMS status.
7a7fd8e0
JM
3312 */
3313
fb38d079 3314# define STATUS_UNIX_EXIT_SET(n) \
7a7fd8e0
JM
3315 STMT_START { \
3316 I32 evalue = (I32)n; \
3317 PL_statusvalue = evalue; \
e08e1e1d
JM
3318 if (MY_POSIX_EXIT) { \
3319 if (evalue <= 0xFF00) { \
3320 if (evalue > 0xFF) \
3321 evalue = (evalue >> child_offset_bits) & 0xFF; \
3322 PL_statusvalue_vms = \
3323 (C_FAC_POSIX | (evalue << 3 ) | \
3324 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3325 } else /* forgive them Perl, for they have sinned */ \
3326 PL_statusvalue_vms = evalue; \
3327 } else { \
3328 if (evalue == 0) \
3329 PL_statusvalue_vms = SS$_NORMAL; \
3330 else if (evalue <= 0xFF00) \
3331 PL_statusvalue_vms = SS$_ABORT; \
3332 else { /* forgive them Perl, for they have sinned */ \
3333 if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3334 else PL_statusvalue_vms = vaxc$errno; \
3335 /* And obviously used a VMS status value instead of UNIX */ \
3336 PL_statusvalue = EVMSERR; \
3337 } \
3338 set_vaxc_errno(PL_statusvalue_vms); \
3339 } \
68dc0745 3340 } STMT_END
fb38d079 3341
e08e1e1d 3342
6ac6a52b
JM
3343 /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3344 * and sets the NATIVE error status based on it. This special case
3345 * is needed to maintain compatibility with past VMS behavior.
3346 *
3347 * In the default mode on VMS, this number is passed through as
3348 * both the NATIVE and UNIX status. Which makes it different
3349 * that the STATUS_UNIX_EXIT_SET.
3350 *
3351 * In the new POSIX EXIT mode, native status will be set so that the
3352 * actual exit code will can be retrieved by the calling program or
3353 * shell.
3354 *
1a3aec58
JM
3355 * A POSIX exit code is from 0 to 255. If the exit code is higher
3356 * than this, it needs to be assumed that it is a VMS exit code and
3357 * passed through.
6ac6a52b
JM
3358 */
3359
3360# define STATUS_EXIT_SET(n) \
3361 STMT_START { \
3362 I32 evalue = (I32)n; \
3363 PL_statusvalue = evalue; \
3364 if (MY_POSIX_EXIT) \
1a3aec58
JM
3365 if (evalue > 255) PL_statusvalue_vms = evalue; else { \
3366 PL_statusvalue_vms = \
3367 (C_FAC_POSIX | (evalue << 3 ) | \
3368 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
6ac6a52b
JM
3369 else \
3370 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3371 set_vaxc_errno(PL_statusvalue_vms); \
3372 } STMT_END
3373
fb38d079
JM
3374
3375 /* This macro forces a success status */
7a7fd8e0
JM
3376# define STATUS_ALL_SUCCESS \
3377 (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
fb38d079
JM
3378
3379 /* This macro forces a failure status */
7a7fd8e0
JM
3380# define STATUS_ALL_FAILURE (PL_statusvalue = 1, \
3381 vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3382 (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
fb38d079 3383
738ab09f
AB
3384#elif defined(__amigaos4__)
3385 /* A somewhat experimental attempt to simulate posix return code values */
3386# define STATUS_NATIVE PL_statusvalue_posix
3387# define STATUS_NATIVE_CHILD_SET(n) \
3388 STMT_START { \
3389 PL_statusvalue_posix = (n); \
3390 if (PL_statusvalue_posix < 0) { \
3391 PL_statusvalue = -1; \
3392 } \
3393 else { \
3394 PL_statusvalue = n << 8; \
3395 } \
3396 } STMT_END
3397# define STATUS_UNIX_SET(n) \
3398 STMT_START { \
3399 PL_statusvalue = (n); \
3400 if (PL_statusvalue != -1) \
3401 PL_statusvalue &= 0xFFFF; \
3402 } STMT_END
3403# define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3404# define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3405# define STATUS_CURRENT STATUS_UNIX
3406# define STATUS_EXIT STATUS_UNIX
3407# define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3408# define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3409
68dc0745 3410#else
e5218da5 3411# define STATUS_NATIVE PL_statusvalue_posix
e5218da5 3412# if defined(WCOREDUMP)
37038d91 3413# define STATUS_NATIVE_CHILD_SET(n) \
e5218da5
GA
3414 STMT_START { \
3415 PL_statusvalue_posix = (n); \
3416 if (PL_statusvalue_posix == -1) \
3417 PL_statusvalue = -1; \
3418 else { \
3419 PL_statusvalue = \
3420 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
3421 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3422 (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0); \
3423 } \
3424 } STMT_END
3425# elif defined(WIFEXITED)
37038d91 3426# define STATUS_NATIVE_CHILD_SET(n) \
e5218da5
GA
3427 STMT_START { \
3428 PL_statusvalue_posix = (n); \
3429 if (PL_statusvalue_posix == -1) \
3430 PL_statusvalue = -1; \
3431 else { \
3432 PL_statusvalue = \
3433 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
3434 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0); \
3435 } \
3436 } STMT_END
3437# else
37038d91 3438# define STATUS_NATIVE_CHILD_SET(n) \
e5218da5
GA
3439 STMT_START { \
3440 PL_statusvalue_posix = (n); \
3441 if (PL_statusvalue_posix == -1) \
3442 PL_statusvalue = -1; \
3443 else { \
3444 PL_statusvalue = \
3445 PL_statusvalue_posix & 0xFFFF; \
3446 } \
3447 } STMT_END
3448# endif
3449# define STATUS_UNIX_SET(n) \
68dc0745 3450 STMT_START { \
3280af22
NIS
3451 PL_statusvalue = (n); \
3452 if (PL_statusvalue != -1) \
3453 PL_statusvalue &= 0xFFFF; \
68dc0745 3454 } STMT_END
7a7fd8e0 3455# define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
6ac6a52b 3456# define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
e5218da5 3457# define STATUS_CURRENT STATUS_UNIX
37038d91 3458# define STATUS_EXIT STATUS_UNIX
e5218da5
GA
3459# define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3460# define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
68dc0745
PP
3461#endif
3462
cc3604b1
GS
3463/* flags in PL_exit_flags for nature of exit() */
3464#define PERL_EXIT_EXPECTED 0x01
31d77e54 3465#define PERL_EXIT_DESTRUCT_END 0x02 /* Run END in perl_destruct */
6136213b
JGM
3466#define PERL_EXIT_WARN 0x04 /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3467#define PERL_EXIT_ABORT 0x08 /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
cc3604b1 3468
b79b76e0 3469#ifndef PERL_CORE
a7cb1f99 3470/* format to use for version numbers in file/directory names */
273cf8d1 3471/* XXX move to Configure? */
b79b76e0
NC
3472/* This was only ever used for the current version, and that can be done at
3473 compile time, as PERL_FS_VERSION, so should we just delete it? */
3474# ifndef PERL_FS_VER_FMT
3475# define PERL_FS_VER_FMT "%d.%d.%d"
3476# endif
3477#endif
3478
3479#ifndef PERL_FS_VERSION
3480# define PERL_FS_VERSION PERL_VERSION_STRING
0b94c7bb
GS
3481#endif
3482
45bc9206 3483/* This defines a way to flush all output buffers. This may be a
76549fef
JH
3484 * performance issue, so we allow people to disable it. Also, if
3485 * we are using stdio, there are broken implementations of fflush(NULL)
3486 * out there, Solaris being the most prominent.
45bc9206
GS
3487 */
3488#ifndef PERL_FLUSHALL_FOR_CHILD
97cb92d6 3489# if defined(USE_PERLIO) || defined(FFLUSH_NULL)
66fe083f 3490# define PERL_FLUSHALL_FOR_CHILD PerlIO_flush((PerlIO*)NULL)
da5fdda8
AC
3491# elif defined(FFLUSH_ALL)
3492# define PERL_FLUSHALL_FOR_CHILD my_fflush_all()
767df6a1 3493# else
da5fdda8 3494# define PERL_FLUSHALL_FOR_CHILD NOOP
66fe083f 3495# endif
45bc9206
GS
3496#endif
3497
7766f137
GS
3498#ifndef PERL_WAIT_FOR_CHILDREN
3499# define PERL_WAIT_FOR_CHILDREN NOOP
3500#endif
3501
ba869deb 3502/* the traditional thread-unsafe notion of "current interpreter". */
c5be433b
GS
3503#ifndef PERL_SET_INTERP
3504# define PERL_SET_INTERP(i) (PL_curinterp = (PerlInterpreter*)(i))
3505#endif
3506
3507#ifndef PERL_GET_INTERP
3508# define PERL_GET_INTERP (PL_curinterp)
3509#endif
3510
54aff467 3511#if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
54aff467 3512# ifdef MULTIPLICITY
ba869deb 3513# define PERL_GET_THX ((PerlInterpreter *)PERL_GET_CONTEXT)
54aff467 3514# endif
ba869deb
GS
3515# define PERL_SET_THX(t) PERL_SET_CONTEXT(t)
3516#endif
3517
00f254e2 3518/*
8896765a 3519 This replaces the previous %_ "hack" by the "%p" hacks.
0dbb1585 3520 All that is required is that the perl source does not
00f254e2
KW
3521 use "%-p" or "%-<number>p" or "%<number>p" formats.
3522 These formats will still work in perl code.
486ec47a 3523 See comments in sv.c for further details.
8896765a 3524
8896765a 3525 Robin Barker 2005-07-14
f46d31f2 3526
00f254e2 3527 No longer use %1p for VDf = %vd. RMB 2007-10-19
0dbb1585 3528*/
8896765a
RB
3529
3530#ifndef SVf_
63ce7bf0 3531# define SVf_(n) "-" STRINGIFY(n) "p"
894356b3
GS
3532#endif
3533
8896765a 3534#ifndef SVf
104abab4 3535# define SVf "-p"
d2560b70
RB
3536#endif
3537
014ead4b 3538#ifndef SVf32
8896765a 3539# define SVf32 SVf_(32)
014ead4b
RB
3540#endif
3541
3542#ifndef SVf256
8896765a
RB
3543# define SVf256 SVf_(256)
3544#endif
3545
be2597df
MHM
3546#define SVfARG(p) ((void*)(p))
3547
20023040
FC
3548#ifndef HEKf
3549# define HEKf "2p"
3550#endif
3551
b8fa5213
FC
3552/* Not ideal, but we cannot easily include a number in an already-numeric
3553 * format sequence. */
3554#ifndef HEKf256
3555# define HEKf256 "3p"
3556#endif
3557
20023040
FC
3558#define HEKfARG(p) ((void*)(p))
3559
eafff229
KW
3560/*
3561=for apidoc Amnh||UTF8f
3562=for apidoc Amh||UTF8fARG|bool is_utf8|Size_t byte_len|char *str
3563
3564=cut
3565 * %4p is a custom format
3566 */
b17a0679 3567#ifndef UTF8f
61608bb7 3568# define UTF8f "d%" UVuf "%4p"
b17a0679
FC
3569#endif
3570#define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3571
0f94cb1f
FC
3572#define PNf UTF8f
3573#define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
0d1e9135 3574
f46d31f2 3575#ifdef PERL_CORE
486ec47a 3576/* not used; but needed for backward compatibility with XS code? - RMB */
7776bb98 3577# undef UVf
da5fdda8
AC
3578#elif !defined(UVf)
3579# define UVf UVuf
d2560b70
RB
3580#endif
3581
6ff2ec7d
AC
3582#if !defined(DEBUGGING) && !defined(NDEBUG)
3583# define NDEBUG 1
cd13e623 3584#endif
6ff2ec7d 3585#include <assert.h>
cd13e623 3586
0dbb1585
AL
3587/* For functions that are marked as __attribute__noreturn__, it's not
3588 appropriate to call return. In either case, include the lint directive.
3589 */
3590#ifdef HASATTRIBUTE_NORETURN
bc3d2941 3591# define NORETURN_FUNCTION_END NOT_REACHED;
0dbb1585 3592#else
bc3d2941 3593# define NORETURN_FUNCTION_END NOT_REACHED; return 0
abb2c242
JH
3594#endif
3595
635aebb7 3596#ifdef HAS_BUILTIN_EXPECT
b37c2d43
AL
3597# define EXPECT(expr,val) __builtin_expect(expr,val)
3598#else
3599# define EXPECT(expr,val) (expr)
3600#endif
c515c80f
KW
3601
3602/*
3603=head1 Miscellaneous Functions
3604
3605=for apidoc AmU|bool|LIKELY|const bool expr
3606
3607Returns the input unchanged, but at the same time it gives a branch prediction
3608hint to the compiler that this condition is likely to be true.
3609
3610=for apidoc AmU|bool|UNLIKELY|const bool expr
3611
3612Returns the input unchanged, but at the same time it gives a branch prediction
3613hint to the compiler that this condition is likely to be false.
3614
3615=cut
3616*/
6d5abc62
NC
3617#define LIKELY(cond) EXPECT(cBOOL(cond),TRUE)
3618#define UNLIKELY(cond) EXPECT(cBOOL(cond),FALSE)
c515c80f 3619
635aebb7
AL
3620#ifdef HAS_BUILTIN_CHOOSE_EXPR
3621/* placeholder */
3622#endif
b37c2d43 3623
a36ca6de 3624/* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
5074d4c5
LM
3625 time invariants. That is, their argument must be a constant expression that
3626 can be verified by the compiler. This expression can contain anything that's
3627 known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3628 the expression evaluates to 0, compilation fails.
3629 Because they generate no runtime code (i.e. their use is "free"), they're
3630 always active, even under non-DEBUGGING builds.
a36ca6de 3631 STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
5074d4c5
LM
3632 file scope (outside of any function).
3633 STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3634 function.
3635*/
f223d81e
KW
3636#if (! defined(__IBMC__) || __IBMC__ >= 1210) \
3637 && (( defined(static_assert) && ( defined(_ISOC11_SOURCE) \
3638 || (__STDC_VERSION__ - 0) >= 201101L)) \
3639 || (defined(__cplusplus) && __cplusplus >= 201103L))
3640/* XXX static_assert is a macro defined in <assert.h> in C11 or a compiler
a36ca6de
LM
3641 builtin in C++11. But IBM XL C V11 does not support _Static_assert, no
3642 matter what <assert.h> says.
6d59e610 3643*/
a36ca6de 3644# define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
6d59e610
LM
3645#else
3646/* We use a bit-field instead of an array because gcc accepts
3647 'typedef char x[n]' where n is not a compile-time constant.
3648 We want to enforce constantness.
3649*/
3650# define STATIC_ASSERT_2(COND, SUFFIX) \
3651 typedef struct { \
3652 unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3653 } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3654# define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
a36ca6de 3655# define STATIC_ASSERT_DECL(COND) STATIC_ASSERT_1(COND, __LINE__)
6d59e610
LM
3656#endif
3657/* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3658 error (static_assert is a declaration, and only statements can have labels).
3659*/
21aae866 3660#define STATIC_ASSERT_STMT(COND) STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
ae103e09
DD
3661
3662#ifndef __has_builtin
3663# define __has_builtin(x) 0 /* not a clang style compiler */
3664#endif
3665
3666/* ASSUME is like assert(), but it has a benefit in a release build. It is a
3667 hint to a compiler about a statement of fact in a function call free
3668 expression, which allows the compiler to generate better machine code.
3669 In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3670 the control path is unreachable. In a for loop, ASSUME can be used to hint
b8fda935 3671 that a loop will run at least X times. ASSUME is based off MSVC's __assume
ae103e09
DD
3672 intrinsic function, see its documents for more details.
3673*/
3674
3675#ifndef DEBUGGING
3676# if __has_builtin(__builtin_unreachable) \
d1020b40 3677 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4) /* 4.5 -> */
ae103e09
DD
3678# define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3679# elif defined(_MSC_VER)
3680# define ASSUME(x) __assume(x)
3681# elif defined(__ARMCC_VERSION) /* untested */
3682# define ASSUME(x) __promise(x)
3683# else
3684/* a random compiler might define assert to its own special optimization token
3685 so pass it through to C lib as a last resort */
3686# define ASSUME(x) assert(x)
3687# endif
3688#else
3689# define ASSUME(x) assert(x)
3690#endif
3691
dbc47c6f
KW
3692#if defined(__sun) /* ASSUME() generates warnings on Solaris */
3693# define NOT_REACHED
2145f4b6
LM
3694#elif defined(DEBUGGING) && (__has_builtin(__builtin_unreachable) \
3695 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4)) /* 4.5 -> */
41bd5b11 3696# define NOT_REACHED STMT_START { ASSUME(!"UNREACHABLE"); __builtin_unreachable(); } STMT_END
dbc47c6f 3697#else
41bd5b11 3698# define NOT_REACHED ASSUME(!"UNREACHABLE")
dbc47c6f 3699#endif
ae103e09 3700
3fc1aec6
PP
3701/* Some unistd.h's give a prototype for pause() even though
3702 HAS_PAUSE ends up undefined. This causes the #define
d2560b70 3703 below to be rejected by the compiler. Sigh.
3fc1aec6
PP
3704*/
3705#ifdef HAS_PAUSE
3706#define Pause pause
3707#else
3708#define Pause() sleep((32767<<16)+32767)
748a9306
LW
3709#endif
3710
3711#ifndef IOCPARM_LEN
3712# ifdef IOCPARM_MASK
61f1c44b 3713 /* on BSDish systems we're safe */
748a9306 3714# define IOCPARM_LEN(x) (((x) >> 16) & IOCPARM_MASK)
da5fdda8 3715# elif defined(_IOC_SIZE) && defined(__GLIBC__)
301eb2f0 3716 /* on Linux systems we're safe; except when we're not [perl #38223] */
da5fdda8
AC
3717# define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3718# else
748a9306 3719 /* otherwise guess at what's safe */
da5fdda8 3720# define IOCPARM_LEN(x) 256
748a9306 3721# endif
a0d0e21e
LW
3722#endif
3723
1761cee5 3724#if defined(__CYGWIN__)
521e0776
GS
3725/* USEMYBINMODE
3726 * This symbol, if defined, indicates that the program should
16fe6d59 3727 * use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
521e0776
GS
3728 * that a file is in "binary" mode -- that is, that no translation
3729 * of bytes occurs on read or write operations.
3730 */
36894f0b 3731# define USEMYBINMODE /**/
77a40698 3732# include <io.h> /* for setmode() prototype */
16fe6d59 3733# define my_binmode(fp, iotype, mode) \
8298454c 3734 cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
5aabfad6
PP
3735#endif
3736
88d10794
JH
3737#ifdef __CYGWIN__
3738void init_os_extras(void);
3739#endif
3740
cea2e8a9
GS
3741#ifdef UNION_ANY_DEFINITION
3742UNION_ANY_DEFINITION;
3743#else
3744union any {
3745 void* any_ptr;
c9728782
DM
3746 SV* any_sv;
3747 SV** any_svp;
3748 GV* any_gv;
3749 AV* any_av;
3750 HV* any_hv;
6ffb8402 3751 OP* any_op;
c9728782
DM
3752 char* any_pv;
3753 char** any_pvp;
cea2e8a9 3754 I32 any_i32;
ae103e09 3755 U32 any_u32;
cea2e8a9 3756 IV any_iv;
c6bf6a65 3757 UV any_uv;
cea2e8a9 3758 long any_long;
9febdf04 3759 bool any_bool;
c76ac1ee 3760 void (*any_dptr) (void*);
acfe0abc 3761 void (*any_dxptr) (pTHX_ void*);
cea2e8a9
GS
3762};
3763#endif
3764
acfe0abc 3765typedef I32 (*filter_t) (pTHX_ int, SV *, int);