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