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