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