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