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