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