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