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