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