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