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