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