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