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