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