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