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