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