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