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