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