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