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