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