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