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