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