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