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