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