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