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