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