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