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