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