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