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