This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta 47836a13cc4c999c9b3589c6797d6769b52c37fd
[perl5.git] / perl.h
CommitLineData
a0d0e21e 1/* perl.h
a687059c 2 *
1129b882 3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
5cd3f21a 4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
a687059c 5 *
352d5a3a
LW
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8d063cd8 8 *
8d063cd8 9 */
d6376244 10
85e6fe83
LW
11#ifndef H_PERL
12#define H_PERL 1
8d063cd8 13
760ac839
LW
14#ifdef PERL_FOR_X2P
15/*
d460ef45 16 * This file is being used for x2p stuff.
760ac839 17 * Above symbol is defined via -D in 'x2p/Makefile.SH'
d460ef45 18 * Decouple x2p stuff from some of perls more extreme eccentricities.
760ac839 19 */
55497cff 20#undef MULTIPLICITY
760ac839
LW
21#undef USE_STDIO
22#define USE_STDIO
23#endif /* PERL_FOR_X2P */
24
d460ef45 25#ifdef PERL_MICRO
12ae5dfc
JH
26# include "uconfig.h"
27#else
611cf957 28# include "config.h"
12ae5dfc 29#endif
0cb96387 30
70febf4f
CB
31/* this is used for functions which take a depth trailing
32 * argument under debugging */
33#ifdef DEBUGGING
34#define _pDEPTH ,U32 depth
35#define _aDEPTH ,depth
36#else
37#define _pDEPTH
38#define _aDEPTH
39#endif
40
7dc3eb73 41/* NOTE 1: that with gcc -std=c89 the __STDC_VERSION__ is *not* defined
9267464d 42 * because the __STDC_VERSION__ became a thing only with C90. Therefore,
7dc3eb73
JH
43 * with gcc, HAS_C99 will never become true as long as we use -std=c89.
44
45 * NOTE 2: headers lie. Do not expect that if HAS_C99 gets to be true,
46 * all the C99 features are there and are correct. */
9267464d 47#if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || \
996959af 48 defined(_STDC_C99) || defined(__c99)
86a3cabf 49# define HAS_C99 1
86a3cabf
JH
50#endif
51
2c2d71f5
JH
52/* See L<perlguts/"The Perl API"> for detailed notes on
53 * PERL_IMPLICIT_CONTEXT and PERL_IMPLICIT_SYS */
54
ac6bedea
JH
55/* Note that from here --> to <-- the same logic is
56 * repeated in makedef.pl, so be certain to update
57 * both places when editing. */
58
6f4183fe 59#ifdef USE_ITHREADS
acfe0abc 60# if !defined(MULTIPLICITY)
6f4183fe
GS
61# define MULTIPLICITY
62# endif
63#endif
64
27da23d5
JH
65#ifdef PERL_GLOBAL_STRUCT_PRIVATE
66# ifndef PERL_GLOBAL_STRUCT
67# define PERL_GLOBAL_STRUCT
68# endif
69#endif
97aff369 70
27da23d5
JH
71#ifdef PERL_GLOBAL_STRUCT
72# ifndef MULTIPLICITY
73# define MULTIPLICITY
74# endif
75#endif
76
97aff369
JH
77#ifdef MULTIPLICITY
78# ifndef PERL_IMPLICIT_CONTEXT
79# define PERL_IMPLICIT_CONTEXT
80# endif
81#endif
82
026fd48b
GH
83/* undef WIN32 when building on Cygwin (for libwin32) - gph */
84#ifdef __CYGWIN__
85# undef WIN32
86# undef _WIN32
87#endif
88
27da23d5
JH
89#if defined(__SYMBIAN32__) || (defined(__VC32__) && defined(WINS))
90# ifndef SYMBIAN
91# define SYMBIAN
92# endif
93#endif
94
a0fd4948 95#ifdef __SYMBIAN32__
27da23d5
JH
96# include "symbian/symbian_proto.h"
97#endif
98
99/* Any stack-challenged places. The limit varies (and often
100 * is configurable), but using more than a kilobyte of stack
101 * is usually dubious in these systems. */
739a0b84
NC
102#if defined(__SYMBIAN32__)
103/* Symbian: need to work around the SDK features. *
27da23d5
JH
104 * On WINS: MS VC5 generates calls to _chkstk, *
105 * if a "large" stack frame is allocated. *
106 * gcc on MARM does not generate calls like these. */
107# define USE_HEAP_INSTEAD_OF_STACK
108#endif
109
dd134d2c 110/* Use the reentrant APIs like localtime_r and getpwent_r */
10bc17b6 111/* Win32 has naturally threadsafe libraries, no need to use any _r variants. */
14795193 112#if defined(USE_ITHREADS) && !defined(USE_REENTRANT_API) && !defined(NETWARE) && !defined(WIN32)
10bc17b6
JH
113# define USE_REENTRANT_API
114#endif
115
ac6bedea
JH
116/* <--- here ends the logic shared by perl.h and makedef.pl */
117
9ea40801
SH
118/* Microsoft Visual C++ 6.0 needs special treatment in numerous places */
119#if defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1200 && _MSC_VER < 1300
120# define USING_MSVC6
121#endif
122
cf5a8da6
MHM
123#undef START_EXTERN_C
124#undef END_EXTERN_C
125#undef EXTERN_C
126#ifdef __cplusplus
127# define START_EXTERN_C extern "C" {
128# define END_EXTERN_C }
129# define EXTERN_C extern "C"
130#else
131# define START_EXTERN_C
132# define END_EXTERN_C
133# define EXTERN_C extern
134#endif
135
17a6c8e3
AD
136/* Fallback definitions in case we don't have definitions from config.h.
137 This should only matter for systems that don't use Configure and
138 haven't been modified to define PERL_STATIC_INLINE yet.
139*/
140#if !defined(PERL_STATIC_INLINE)
141# ifdef HAS_STATIC_INLINE
142# define PERL_STATIC_INLINE static inline
143# else
144# define PERL_STATIC_INLINE static
145# endif
146#endif
147
da5fdda8 148#if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GET_VARS)
27da23d5 149# ifdef PERL_GLOBAL_STRUCT_PRIVATE
cf5a8da6 150 EXTERN_C struct perl_vars* Perl_GetVarsPrivate();
27da23d5 151# define PERL_GET_VARS() Perl_GetVarsPrivate() /* see miniperlmain.c */
27da23d5
JH
152# else
153# define PERL_GET_VARS() PL_VarsPtr
154# endif
27da23d5
JH
155#endif
156
f0e5c859
DD
157/* this used to be off by default, now its on, see perlio.h */
158#define PERLIO_FUNCS_CONST
159
5aaab254 160#define pVAR struct perl_vars* my_vars PERL_UNUSED_DECL
27da23d5
JH
161
162#ifdef PERL_GLOBAL_STRUCT
163# define dVAR pVAR = (struct perl_vars*)PERL_GET_VARS()
164#else
165# define dVAR dNOOP
166#endif
167
c5be433b 168#ifdef PERL_IMPLICIT_CONTEXT
3db8f154
MB
169# ifndef MULTIPLICITY
170# define MULTIPLICITY
c5be433b 171# endif
e8dda941 172# define tTHX PerlInterpreter*
5aaab254 173# define pTHX tTHX my_perl PERL_UNUSED_DECL
3db8f154 174# define aTHX my_perl
9399a70c 175# define aTHXa(a) aTHX = (tTHX)a
27da23d5 176# ifdef PERL_GLOBAL_STRUCT
e8dda941 177# define dTHXa(a) dVAR; pTHX = (tTHX)a
27da23d5 178# else
e8dda941 179# define dTHXa(a) pTHX = (tTHX)a
27da23d5
JH
180# endif
181# ifdef PERL_GLOBAL_STRUCT
182# define dTHX dVAR; pTHX = PERL_GET_THX
183# else
184# define dTHX pTHX = PERL_GET_THX
185# endif
c5be433b 186# define pTHX_ pTHX,
c5be433b 187# define aTHX_ aTHX,
4373e329 188# define pTHX_1 2
894356b3
GS
189# define pTHX_2 3
190# define pTHX_3 4
191# define pTHX_4 5
4373e329
AL
192# define pTHX_5 6
193# define pTHX_6 7
a3b680e6
AL
194# define pTHX_7 8
195# define pTHX_8 9
196# define pTHX_9 10
a6fc70e5 197# define pTHX_12 13
e8dda941
JD
198# if defined(DEBUGGING) && !defined(PERL_TRACK_MEMPOOL)
199# define PERL_TRACK_MEMPOOL
200# endif
201#else
202# undef PERL_TRACK_MEMPOOL
c5be433b
GS
203#endif
204
76e3520e 205#define STATIC static
16c91539
BM
206
207#ifndef PERL_CORE
208/* Do not use these macros. They were part of PERL_OBJECT, which was an
209 * implementation of multiplicity using C++ objects. They have been left
210 * here solely for the sake of XS code which has incorrectly
211 * cargo-culted them.
212 */
76e3520e 213#define CPERLscope(x) x
565764a8 214#define CPERLarg void
76e3520e 215#define CPERLarg_
e3b8966e 216#define _CPERLarg
1d583055
GS
217#define PERL_OBJECT_THIS
218#define _PERL_OBJECT_THIS
219#define PERL_OBJECT_THIS_
312caa8e 220#define CALL_FPTR(fptr) (*fptr)
ef69c8fc 221#define MEMBER_TO_FPTR(name) name
16c91539 222#endif /* !PERL_CORE */
76e3520e 223
16c91539 224#define CALLRUNOPS PL_runops
f9f4320a 225
3ab4a224 226#define CALLREGCOMP(sv, flags) Perl_pregcomp(aTHX_ (sv),(flags))
f9f4320a 227
16c91539 228#define CALLREGCOMP_ENG(prog, sv, flags) (prog)->comp(aTHX_ sv, flags)
a340edde 229#define CALLREGEXEC(prog,stringarg,strend,strbeg,minend,sv,data,flags) \
16c91539 230 RX_ENGINE(prog)->exec(aTHX_ (prog),(stringarg),(strend), \
a340edde 231 (strbeg),(minend),(sv),(data),(flags))
52a21eb3
DM
232#define CALLREG_INTUIT_START(prog,sv,strbeg,strpos,strend,flags,data) \
233 RX_ENGINE(prog)->intuit(aTHX_ (prog), (sv), (strbeg), (strpos), \
f9f4320a
YO
234 (strend),(flags),(data))
235#define CALLREG_INTUIT_STRING(prog) \
16c91539 236 RX_ENGINE(prog)->checkstr(aTHX_ (prog))
f8149455 237
f8149455
YO
238#define CALLREGFREE(prog) \
239 Perl_pregfree(aTHX_ (prog))
240
241#define CALLREGFREE_PVT(prog) \
fc6bde6f 242 if(prog) RX_ENGINE(prog)->rxfree(aTHX_ (prog))
f8149455 243
2fdbfb4d 244#define CALLREG_NUMBUF_FETCH(rx,paren,usesv) \
16c91539 245 RX_ENGINE(rx)->numbered_buff_FETCH(aTHX_ (rx),(paren),(usesv))
93b32b6d 246
2fdbfb4d 247#define CALLREG_NUMBUF_STORE(rx,paren,value) \
16c91539 248 RX_ENGINE(rx)->numbered_buff_STORE(aTHX_ (rx),(paren),(value))
2fdbfb4d
AB
249
250#define CALLREG_NUMBUF_LENGTH(rx,sv,paren) \
16c91539 251 RX_ENGINE(rx)->numbered_buff_LENGTH(aTHX_ (rx),(sv),(paren))
2fdbfb4d 252
192b9cd1 253#define CALLREG_NAMED_BUFF_FETCH(rx, key, flags) \
16c91539 254 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_FETCH))
192b9cd1
AB
255
256#define CALLREG_NAMED_BUFF_STORE(rx, key, value, flags) \
16c91539 257 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), (value), ((flags) | RXapif_STORE))
192b9cd1
AB
258
259#define CALLREG_NAMED_BUFF_DELETE(rx, key, flags) \
16c91539 260 RX_ENGINE(rx)->named_buff(aTHX_ (rx),(key), NULL, ((flags) | RXapif_DELETE))
192b9cd1
AB
261
262#define CALLREG_NAMED_BUFF_CLEAR(rx, flags) \
16c91539 263 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_CLEAR))
192b9cd1
AB
264
265#define CALLREG_NAMED_BUFF_EXISTS(rx, key, flags) \
16c91539 266 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_EXISTS))
192b9cd1
AB
267
268#define CALLREG_NAMED_BUFF_FIRSTKEY(rx, flags) \
16c91539 269 RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), NULL, ((flags) | RXapif_FIRSTKEY))
192b9cd1
AB
270
271#define CALLREG_NAMED_BUFF_NEXTKEY(rx, lastkey, flags) \
16c91539 272 RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), (lastkey), ((flags) | RXapif_NEXTKEY))
192b9cd1
AB
273
274#define CALLREG_NAMED_BUFF_SCALAR(rx, flags) \
16c91539 275 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_SCALAR))
192b9cd1
AB
276
277#define CALLREG_NAMED_BUFF_COUNT(rx) \
16c91539 278 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, RXapif_REGNAMES_COUNT)
192b9cd1
AB
279
280#define CALLREG_NAMED_BUFF_ALL(rx, flags) \
16c91539 281 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, flags)
93b32b6d 282
49d7dfbc 283#define CALLREG_PACKAGE(rx) \
16c91539 284 RX_ENGINE(rx)->qr_package(aTHX_ (rx))
93b32b6d 285
00f254e2 286#if defined(USE_ITHREADS)
f9f4320a 287#define CALLREGDUPE(prog,param) \
f8149455
YO
288 Perl_re_dup(aTHX_ (prog),(param))
289
290#define CALLREGDUPE_PVT(prog,param) \
16c91539 291 (prog ? RX_ENGINE(prog)->dupe(aTHX_ (prog),(param)) \
00f254e2 292 : (REGEXP *)NULL)
f9f4320a 293#endif
14dd3ad8 294
a20207d7 295
bcdf7404 296
a20207d7
YO
297
298
5ba4cab2
SH
299/*
300 * Because of backward compatibility reasons the PERL_UNUSED_DECL
301 * cannot be changed from postfix to PERL_UNUSED_DECL(x). Sigh.
302 *
303 * Note that there are C compilers such as MetroWerks CodeWarrior
1266ad8c 304 * which do not have an "inlined" way (like the gcc __attribute__) of
5ba4cab2
SH
305 * marking unused variables (they need e.g. a #pragma) and therefore
306 * cpp macros like PERL_UNUSED_DECL cannot work for this purpose, even
307 * if it were PERL_UNUSED_DECL(x), which it cannot be (see above).
308 *
309 */
1266ad8c 310
9969cdde 311#if defined(__SYMBIAN32__) && defined(__GNUC__)
5b2bd0a5 312# ifdef __cplusplus
5ba4cab2 313# define PERL_UNUSED_DECL
5b2bd0a5 314# else
5ba4cab2 315# define PERL_UNUSED_DECL __attribute__((unused))
5b2bd0a5
AMS
316# endif
317#endif
44dbb695 318
5b2bd0a5 319#ifndef PERL_UNUSED_DECL
98d1c64e 320# if defined(HASATTRIBUTE_UNUSED) && (!defined(__cplusplus) || __GNUC__ >= 4)
5ba4cab2 321# define PERL_UNUSED_DECL __attribute__unused__
b79c357a 322# else
5ba4cab2 323# define PERL_UNUSED_DECL
b79c357a 324# endif
5b2bd0a5 325#endif
00f254e2 326
349b520e
DM
327/* gcc -Wall:
328 * for silencing unused variables that are actually used most of the time,
a730e3f2
JH
329 * but we cannot quite get rid of, such as "ax" in PPCODE+noargs xsubs,
330 * or variables/arguments that are used only in certain configurations.
349b520e 331 */
53c1dcc0 332#ifndef PERL_UNUSED_ARG
c707756e 333# define PERL_UNUSED_ARG(x) ((void)sizeof(x))
ad73156c 334#endif
53c1dcc0 335#ifndef PERL_UNUSED_VAR
a730e3f2 336# define PERL_UNUSED_VAR(x) ((void)sizeof(x))
53c1dcc0 337#endif
ad73156c 338
23491f1d 339#if defined(USE_ITHREADS) || defined(PERL_GLOBAL_STRUCT)
96a5add6
AL
340# define PERL_UNUSED_CONTEXT PERL_UNUSED_ARG(my_perl)
341#else
342# define PERL_UNUSED_CONTEXT
343#endif
344
24e7ff4e
JH
345/* gcc (-ansi) -pedantic doesn't allow gcc statement expressions,
346 * g++ allows them but seems to have problems with them
347 * (insane errors ensue).
348 * g++ does not give insane errors now (RMB 2008-01-30, gcc 4.2.2).
349 */
350#if defined(PERL_GCC_PEDANTIC) || \
351 (defined(__GNUC__) && defined(__cplusplus) && \
352 ((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2))))
353# ifndef PERL_GCC_BRACE_GROUPS_FORBIDDEN
354# define PERL_GCC_BRACE_GROUPS_FORBIDDEN
355# endif
356#endif
357
ffea512f 358/* Use PERL_UNUSED_RESULT() to suppress the warnings about unused results
b469f1e0
JH
359 * of function calls, e.g. PERL_UNUSED_RESULT(foo(a, b)).
360 *
361 * The main reason for this is that the combination of gcc -Wunused-result
362 * (part of -Wall) and the __attribute__((warn_unused_result)) cannot
363 * be silenced with casting to void. This causes trouble when the system
364 * header files use the attribute.
365 *
366 * Use PERL_UNUSED_RESULT sparingly, though, since usually the warning
367 * is there for a good reason: you might lose success/failure information,
368 * or leak resources, or changes in resources.
ffea512f
JH
369 *
370 * But sometimes you just want to ignore the return value, e.g. on
b469f1e0
JH
371 * codepaths soon ending up in abort, or in "best effort" attempts,
372 * or in situations where there is no good way to handle failures.
ffea512f 373 *
b469f1e0
JH
374 * Sometimes PERL_UNUSED_RESULT might not be the most natural way:
375 * another possibility is that you can capture the return value
376 * and use PERL_UNUSED_VAR on that.
ffea512f 377 *
b469f1e0
JH
378 * The __typeof__() is used instead of typeof() since typeof() is not
379 * available under strict C89, and because of compilers masquerading
380 * as gcc (clang and icc), we want exactly the gcc extension
381 * __typeof__ and nothing else.
ffea512f
JH
382 */
383#ifndef PERL_UNUSED_RESULT
b469f1e0
JH
384# if defined(__GNUC__) && defined(HASATTRIBUTE_WARN_UNUSED_RESULT)
385# define PERL_UNUSED_RESULT(v) STMT_START { __typeof__(v) z = (v); (void)sizeof(z); } STMT_END
ffea512f
JH
386# else
387# define PERL_UNUSED_RESULT(v) ((void)(v))
388# endif
389#endif
390
b56aac20
DM
391/* on gcc (and clang), specify that a warning should be temporarily
392 * ignored; e.g.
393 *
394 * GCC_DIAG_IGNORE(-Wmultichar);
395 * char b = 'ab';
396 * GCC_DIAG_RESTORE;
397 *
398 * based on http://dbp-consulting.com/tutorials/SuppressingGCCWarnings.html
399 *
400 * Note that "pragma GCC diagnostic push/pop" was added in GCC 4.6, Mar 2011;
401 * clang only pretends to be GCC 4.2, but still supports push/pop.
c1d6452f
JH
402 *
403 * Note on usage: on non-gcc (or lookalike, like clang) compilers
95b872d5
LM
404 * one cannot use these with a semicolon at file (global) level without
405 * warnings since they are defined as empty, which leads into the terminating
c1d6452f
JH
406 * semicolon being left alone on a line:
407 * ;
408 * which makes compilers mildly cranky. Therefore at file level one
95b872d5 409 * should use the GCC_DIAG_IGNORE and GCC_DIAG_RESTORE macros *without*
6ab56f1e 410 * the semicolons.
c1d6452f
JH
411 *
412 * (A dead-on-arrival solution would be to try to define the macros as
413 * NOOP or dNOOP, those don't work both inside functions and outside.)
b56aac20
DM
414 */
415
57d4b8c5 416#if defined(__clang__) || defined(__clang) || \
d28ce8b4 417 (defined( __GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406)
c1d6452f
JH
418# define GCC_DIAG_PRAGMA(x) _Pragma (#x)
419/* clang has "clang diagnostic" pragmas, but also understands gcc. */
b56aac20 420# define GCC_DIAG_IGNORE(x) _Pragma("GCC diagnostic push") \
c1d6452f 421 GCC_DIAG_PRAGMA(GCC diagnostic ignored #x)
b56aac20
DM
422# define GCC_DIAG_RESTORE _Pragma("GCC diagnostic pop")
423#else
8ce6f80a
JH
424# define GCC_DIAG_IGNORE(w)
425# define GCC_DIAG_RESTORE
b56aac20 426#endif
337458b1
JH
427/* for clang specific pragmas */
428#if defined(__clang__) || defined(__clang)
429# define CLANG_DIAG_PRAGMA(x) _Pragma (#x)
430# define CLANG_DIAG_IGNORE(x) _Pragma("clang diagnostic push") \
431 CLANG_DIAG_PRAGMA(clang diagnostic ignored #x)
432# define CLANG_DIAG_RESTORE _Pragma("clang diagnostic pop")
433#else
434# define CLANG_DIAG_IGNORE(w)
435# define CLANG_DIAG_RESTORE
436#endif
b56aac20 437
6f207bd3 438#define NOOP /*EMPTY*/(void)0
bafdc25d
NC
439/* cea2e8a9dd23747f accidentally lost the comment originally from the first
440 check in of thread.h, explaining why we need dNOOP at all: */
441/* Rats: if dTHR is just blank then the subsequent ";" throws an error */
442/* Declaring a *function*, instead of a variable, ensures that we don't rely
443 on being able to suppress "unused" warnings. */
7db66e12
CB
444#ifdef __cplusplus
445#define dNOOP (void)0
446#else
64a8239e 447#define dNOOP extern int Perl___notused(void)
7db66e12 448#endif
71be2cbc 449
0cb96387 450#ifndef pTHX
a78adc84 451/* Don't bother defining tTHX ; using it outside
e8dda941
JD
452 * code guarded by PERL_IMPLICIT_CONTEXT is an error.
453 */
0cb96387
GS
454# define pTHX void
455# define pTHX_
0cb96387
GS
456# define aTHX
457# define aTHX_
9399a70c 458# define aTHXa(a) NOOP
0cb96387
GS
459# define dTHXa(a) dNOOP
460# define dTHX dNOOP
894356b3
GS
461# define pTHX_1 1
462# define pTHX_2 2
463# define pTHX_3 3
464# define pTHX_4 4
3d42dc86
RGS
465# define pTHX_5 5
466# define pTHX_6 6
a3b680e6
AL
467# define pTHX_7 7
468# define pTHX_8 8
469# define pTHX_9 9
a6fc70e5 470# define pTHX_12 12
0cb96387
GS
471#endif
472
27da23d5
JH
473#ifndef dVAR
474# define dVAR dNOOP
475#endif
476
b4f7f263
GS
477/* these are only defined for compatibility; should not be used internally */
478#if !defined(pTHXo) && !defined(PERL_CORE)
0cb96387
GS
479# define pTHXo pTHX
480# define pTHXo_ pTHX_
0cb96387
GS
481# define aTHXo aTHX
482# define aTHXo_ aTHX_
c5be433b 483# define dTHXo dTHX
71d280e3 484# define dTHXoa(x) dTHXa(x)
0cb96387
GS
485#endif
486
487#ifndef pTHXx
5aaab254 488# define pTHXx PerlInterpreter *my_perl
0cb96387 489# define pTHXx_ pTHXx,
0cb96387
GS
490# define aTHXx my_perl
491# define aTHXx_ aTHXx,
c5be433b 492# define dTHXx dTHX
22c35a8c 493#endif
71be2cbc 494
1de7c2ac
GS
495/* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
496 * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
497 * dTHXs is therefore needed for all functions using PerlIO_foo(). */
498#ifdef PERL_IMPLICIT_SYS
27da23d5
JH
499# ifdef PERL_GLOBAL_STRUCT_PRIVATE
500# define dTHXs dVAR; dTHX
501# else
502# define dTHXs dTHX
503# endif
1de7c2ac 504#else
27da23d5
JH
505# ifdef PERL_GLOBAL_STRUCT_PRIVATE
506# define dTHXs dVAR
507# else
508# define dTHXs dNOOP
509# endif
1de7c2ac
GS
510#endif
511
5b692037
JH
512#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
513# ifndef PERL_USE_GCC_BRACE_GROUPS
514# define PERL_USE_GCC_BRACE_GROUPS
515# endif
516#endif
517
728e2803 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 528# define STMT_END )
529# else
728e2803 530# define STMT_START do
531# define STMT_END while (0)
728e2803 532# endif
533#endif
534
d6f9c181
JH
535#ifndef BYTEORDER /* Should never happen -- byteorder is in config.h */
536# define BYTEORDER 0x1234
79072805
LW
537#endif
538
539/* Overall memory policy? */
540#ifndef CONSERVATIVE
541# define LIBERAL 1
542#endif
543
8ada0baa
JH
544#if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
545#define ASCIIish
546#else
547#undef ASCIIish
548#endif
549
79072805
LW
550/*
551 * The following contortions are brought to you on behalf of all the
552 * standards, semi-standards, de facto standards, not-so-de-facto standards
553 * of the world, as well as all the other botches anyone ever thought of.
554 * The basic theory is that if we work hard enough here, the rest of the
555 * code can be a lot prettier. Well, so much for theory. Sorry, Henry...
556 */
ac58e20f 557
ee0007ab 558/* define this once if either system, instead of cluttering up the src */
7c458fae 559#if defined(MSDOS) || defined(WIN32) || defined(NETWARE)
ee0007ab
LW
560#define DOSISH 1
561#endif
562
3d97541c 563/* These exist only for back-compat with XS modules. */
8162b70e 564#ifndef PERL_CORE
516e10a9 565#define VOL volatile
3d97541c 566#define CAN_PROTOTYPE
ae75e3d0 567#define _(args) args
6c2ae642 568#define I_LIMITS
36a113ce 569#define I_STDARG
6c2ae642 570#define STANDARD_C
8162b70e 571#endif
663a0e37 572
284167a5
S
573/* By compiling a perl with -DNO_TAINT_SUPPORT or -DSILENT_NO_TAINT_SUPPORT,
574 * you get a perl without taint support, but doubtlessly with a lesser
575 * degree of support. Do not do so unless you know exactly what it means
576 * technically, have a good reason to do so, and know exactly how the
577 * perl will be used. perls with -DSILENT_NO_TAINT_SUPPORT are considered
578 * a potential security risk due to flat out ignoring the security-relevant
579 * taint flags. This being said, a perl without taint support compiled in
580 * has marginal run-time performance benefits.
581 * SILENT_NO_TAINT_SUPPORT implies NO_TAINT_SUPPORT.
582 * SILENT_NO_TAINT_SUPPORT is the same as NO_TAINT_SUPPORT except it
583 * silently ignores -t/-T instead of throwing an exception.
053a3618
S
584 *
585 * DANGER! Using NO_TAINT_SUPPORT or SILENT_NO_TAINT_SUPPORT
6ecb40c7 586 * voids your nonexistent warranty!
284167a5 587 */
dc6d7f5c 588#if defined(SILENT_NO_TAINT_SUPPORT) && !defined(NO_TAINT_SUPPORT)
284167a5
S
589# define NO_TAINT_SUPPORT 1
590#endif
591
592/* NO_TAINT_SUPPORT can be set to transform virtually all taint-related
593 * operations into no-ops for a very modest speed-up. Enable only if you
594 * know what you're doing: tests and CPAN modules' tests are bound to fail.
595 */
dc6d7f5c 596#ifdef NO_TAINT_SUPPORT
284167a5
S
597# define TAINT NOOP
598# define TAINT_NOT NOOP
599# define TAINT_IF(c) NOOP
600# define TAINT_ENV() NOOP
601# define TAINT_PROPER(s) NOOP
602# define TAINT_set(s) NOOP
603# define TAINT_get 0
604# define TAINTING_get 0
605# define TAINTING_set(s) NOOP
606# define TAINT_WARN_get 0
607# define TAINT_WARN_set(s) NOOP
608#else
d48c660d 609# define TAINT (PL_tainted = PL_tainting)
284167a5 610# define TAINT_NOT (PL_tainted = FALSE)
d48c660d 611# define TAINT_IF(c) if (UNLIKELY(c)) { PL_tainted = PL_tainting; }
2439e033
S
612# define TAINT_ENV() if (UNLIKELY(PL_tainting)) { taint_env(); }
613# define TAINT_PROPER(s) if (UNLIKELY(PL_tainting)) { taint_proper(NULL, s); }
284167a5
S
614# define TAINT_set(s) (PL_tainted = (s))
615# define TAINT_get (PL_tainted)
616# define TAINTING_get (PL_tainting)
617# define TAINTING_set(s) (PL_tainting = (s))
618# define TAINT_WARN_get (PL_taint_warn)
619# define TAINT_WARN_set(s) (PL_taint_warn = (s))
620#endif
a687059c 621
20be6587
DM
622/* flags used internally only within pp_subst and pp_substcont */
623#ifdef PERL_CORE
624# define SUBST_TAINT_STR 1 /* string tainted */
625# define SUBST_TAINT_PAT 2 /* pattern tainted */
626# define SUBST_TAINT_REPL 4 /* replacement tainted */
627# define SUBST_TAINT_RETAINT 8 /* use re'taint' in scope */
628# define SUBST_TAINT_BOOLRET 16 /* return is boolean (don't taint) */
629#endif
630
d460ef45 631/* XXX All process group stuff is handled in pp_sys.c. Should these
a6e633de 632 defines move there? If so, I could simplify this a lot. --AD 9/96.
633*/
634/* Process group stuff changed from traditional BSD to POSIX.
635 perlfunc.pod documents the traditional BSD-style syntax, so we'll
636 try to preserve that, if possible.
637*/
638#ifdef HAS_SETPGID
639# define BSD_SETPGRP(pid, pgrp) setpgid((pid), (pgrp))
da5fdda8
AC
640#elif defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
641# define BSD_SETPGRP(pid, pgrp) setpgrp((pid), (pgrp))
642#elif defined(HAS_SETPGRP2)
643# define BSD_SETPGRP(pid, pgrp) setpgrp2((pid), (pgrp))
a6e633de 644#endif
645#if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
646# define HAS_SETPGRP /* Well, effectively it does . . . */
647#endif
648
649/* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
650 our life easier :-) so we'll try it.
651*/
652#ifdef HAS_GETPGID
653# define BSD_GETPGRP(pid) getpgid((pid))
da5fdda8
AC
654#elif defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
655# define BSD_GETPGRP(pid) getpgrp((pid))
656#elif defined(HAS_GETPGRP2)
657# define BSD_GETPGRP(pid) getpgrp2((pid))
a6e633de 658#endif
659#if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
660# define HAS_GETPGRP /* Well, effectively it does . . . */
661#endif
662
d460ef45 663/* These are not exact synonyms, since setpgrp() and getpgrp() may
a6e633de 664 have different behaviors, but perl.h used to define USE_BSDPGRP
665 (prior to 5.003_05) so some extension might depend on it.
666*/
667#if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
668# ifndef USE_BSDPGRP
669# define USE_BSDPGRP
670# endif
663a0e37
LW
671#endif
672
486ec47a 673/* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
8ac5a1fe
MH
674 pthread.h must be included before all other header files.
675*/
3db8f154 676#if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
8ac5a1fe
MH
677# include <pthread.h>
678#endif
679
58ab9e8b 680#include <sys/types.h>
663a0e37 681
c7925a5e
DD
682/* EVC 4 SDK headers includes a bad definition of MB_CUR_MAX in stdlib.h
683 which is included from stdarg.h. Bad definition not present in SD 2008
684 SDK headers. wince.h is not yet included, so we cant fix this from there
685 since by then MB_CUR_MAX will be defined from stdlib.h.
686 cewchar.h includes a correct definition of MB_CUR_MAX and it is copied here
687 since cewchar.h can't be included this early */
688#if defined(UNDER_CE) && (_MSC_VER < 1300)
5703b8ce 689# define MB_CUR_MAX 1uL
c7925a5e 690#endif
9d82a2b7
AC
691
692# include <stdarg.h>
760ac839 693
27db2737
JH
694#ifdef I_STDINT
695# include <stdint.h>
696#endif
697
fe14fcc3 698#include <ctype.h>
63b481b9
AC
699#include <float.h>
700#include <limits.h>
a0d0e21e
LW
701
702#ifdef METHOD /* Defined by OSF/1 v3.0 by ctype.h */
703#undef METHOD
a0d0e21e
LW
704#endif
705
12ae5dfc
JH
706#ifdef PERL_MICRO
707# define NO_LOCALE
708#endif
709
4633a7c4 710#ifdef I_LOCALE
36477c24 711# include <locale.h>
4633a7c4
LW
712#endif
713
6ebbc862
KW
714#ifdef I_XLOCALE
715# include <xlocale.h>
716#endif
717
36477c24 718#if !defined(NO_LOCALE) && defined(HAS_SETLOCALE)
719# define USE_LOCALE
ccd65d51
KW
720# define HAS_SKIP_LOCALE_INIT /* Solely for XS code to test for this
721 capability */
36477c24 722# if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
723 && defined(HAS_STRXFRM)
724# define USE_LOCALE_COLLATE
725# endif
726# if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
727# define USE_LOCALE_CTYPE
728# endif
729# if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
730# define USE_LOCALE_NUMERIC
731# endif
fa9b773e
KW
732# if !defined(NO_LOCALE_MESSAGES) && defined(LC_MESSAGES)
733# define USE_LOCALE_MESSAGES
734# endif
735# if !defined(NO_LOCALE_MONETARY) && defined(LC_MONETARY)
736# define USE_LOCALE_MONETARY
737# endif
56e45410
KW
738# if !defined(NO_LOCALE_TIME) && defined(LC_TIME)
739# define USE_LOCALE_TIME
740# endif
36477c24 741#endif /* !NO_LOCALE && HAS_SETLOCALE */
a0d0e21e 742
fe14fcc3 743#include <setjmp.h>
79072805 744
a0d0e21e 745#ifdef I_SYS_PARAM
79072805
LW
746# ifdef PARAM_NEEDS_TYPES
747# include <sys/types.h>
748# endif
749# include <sys/param.h>
352d5a3a 750#endif
79072805 751
ce3470dc
AD
752/* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
753 value something like 199306. This may be useful if no more-specific
754 feature test is available.
755*/
756#if defined(BSD)
757# ifndef BSDish
758# define BSDish
759# endif
760#endif
761
dd512de3
AC
762/* Use all the "standard" definitions */
763#include <stdlib.h>
03a14243 764
3f270f98
JH
765/* If this causes problems, set i_unistd=undef in the hint file. */
766#ifdef I_UNISTD
763ee752
AB
767# if defined(__amigaos4__)
768# ifdef I_NETINET_IN
769# include <netinet/in.h>
770# endif
771# endif
3f270f98 772# include <unistd.h>
6e3136a6
AB
773# if defined(__amigaos4__)
774/* Under AmigaOS 4 newlib.library provides an environ. However using
775 * it doesn't give us enough control over inheritance of variables by
776 * subshells etc. so replace with custom version based on abc-shell
777 * code. */
778extern char **myenviron;
779# undef environ
780# define environ myenviron
781# endif
3f270f98
JH
782#endif
783
de8ca8af
NT
784/* for WCOREDUMP */
785#ifdef I_SYS_WAIT
786# include <sys/wait.h>
787#endif
788
9969cdde 789#ifdef __SYMBIAN32__
27da23d5
JH
790# undef _SC_ARG_MAX /* Symbian has _SC_ARG_MAX but no sysconf() */
791#endif
792
21e89b5f 793#if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
c45598c5 794EXTERN_C int syscall(int, ...);
2ef53570
JH
795#endif
796
21e89b5f 797#if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
c45598c5 798EXTERN_C int usleep(unsigned int);
2ef53570
JH
799#endif
800
f2f9e01d
KW
801/* macros for correct constant construction. These are in C99 <stdint.h>
802 * (so they will not be available in strict C89 mode), but they are nice, so
803 * let's define them if necessary. */
804#ifndef UINT16_C
805# if INTSIZE >= 2
806# define UINT16_C(x) ((U16_TYPE)x##U)
807# else
808# define UINT16_C(x) ((U16_TYPE)x##UL)
809# endif
810#endif
1109a392 811
f2f9e01d
KW
812#ifndef UINT32_C
813# if INTSIZE >= 4
814# define UINT32_C(x) ((U32_TYPE)x##U)
815# else
816# define UINT32_C(x) ((U32_TYPE)x##UL)
817# endif
818#endif
1109a392 819
f2f9e01d
KW
820#ifdef I_STDINT
821 typedef intmax_t PERL_INTMAX_T;
822 typedef uintmax_t PERL_UINTMAX_T;
823#endif
824
825/* N.B. We use QUADKIND here instead of HAS_QUAD here, because that doesn't
826 * actually mean what it has always been documented to mean (see RT #119753)
827 * and is explicitly turned off outside of core with dire warnings about
828 * removing the undef. */
829
830#if defined(QUADKIND)
831# undef PeRl_INT64_C
832# undef PeRl_UINT64_C
833/* Prefer the native integer types (int and long) over long long
834 * (which is not C89) and Win32-specific __int64. */
835# if QUADKIND == QUAD_IS_INT && INTSIZE == 8
836# define PeRl_INT64_C(c) (c)
837# define PeRl_UINT64_C(c) CAT2(c,U)
838# endif
839# if QUADKIND == QUAD_IS_LONG && LONGSIZE == 8
840# define PeRl_INT64_C(c) CAT2(c,L)
841# define PeRl_UINT64_C(c) CAT2(c,UL)
842# endif
843# if QUADKIND == QUAD_IS_LONG_LONG && defined(HAS_LONG_LONG)
844# define PeRl_INT64_C(c) CAT2(c,LL)
845# define PeRl_UINT64_C(c) CAT2(c,ULL)
846# endif
847# if QUADKIND == QUAD_IS___INT64
848# define PeRl_INT64_C(c) CAT2(c,I64)
849# define PeRl_UINT64_C(c) CAT2(c,UI64)
850# endif
851# ifndef PeRl_INT64_C
852# define PeRl_INT64_C(c) ((I64)(c)) /* last resort */
853# define PeRl_UINT64_C(c) ((U64TYPE)(c))
854# endif
855/* In OS X the INT64_C/UINT64_C are defined with LL/ULL, which will
856 * not fly with C89-pedantic gcc, so let's undefine them first so that
857 * we can redefine them with our native integer preferring versions. */
858# if defined(PERL_DARWIN) && defined(PERL_GCC_PEDANTIC)
859# undef INT64_C
860# undef UINT64_C
861# endif
862# ifndef INT64_C
863# define INT64_C(c) PeRl_INT64_C(c)
864# endif
865# ifndef UINT64_C
866# define UINT64_C(c) PeRl_UINT64_C(c)
867# endif
1109a392 868
f2f9e01d
KW
869# ifndef I_STDINT
870 typedef I64TYPE PERL_INTMAX_T;
871 typedef U64TYPE PERL_UINTMAX_T;
1109a392 872# endif
f2f9e01d
KW
873# ifndef INTMAX_C
874# define INTMAX_C(c) INT64_C(c)
875# endif
876# ifndef UINTMAX_C
877# define UINTMAX_C(c) UINT64_C(c)
878# endif
879
880#else /* below QUADKIND is undefined */
881
882/* Perl doesn't work on 16 bit systems, so must be 32 bit */
883# ifndef I_STDINT
884 typedef I32TYPE PERL_INTMAX_T;
885 typedef U32TYPE PERL_UINTMAX_T;
886# endif
887# ifndef INTMAX_C
888# define INTMAX_C(c) INT32_C(c)
889# endif
890# ifndef UINTMAX_C
891# define UINTMAX_C(c) UINT32_C(c)
892# endif
893
894#endif /* no QUADKIND */
895
896#ifdef PERL_CORE
1109a392
MHM
897
898/* byte-swapping functions for big-/little-endian conversion */
899# define _swab_16_(x) ((U16)( \
f2f9e01d
KW
900 (((U16)(x) & UINT16_C(0x00ff)) << 8) | \
901 (((U16)(x) & UINT16_C(0xff00)) >> 8) ))
1109a392
MHM
902
903# define _swab_32_(x) ((U32)( \
f2f9e01d
KW
904 (((U32)(x) & UINT32_C(0x000000ff)) << 24) | \
905 (((U32)(x) & UINT32_C(0x0000ff00)) << 8) | \
906 (((U32)(x) & UINT32_C(0x00ff0000)) >> 8) | \
907 (((U32)(x) & UINT32_C(0xff000000)) >> 24) ))
1109a392
MHM
908
909# ifdef HAS_QUAD
910# define _swab_64_(x) ((U64)( \
f2f9e01d
KW
911 (((U64)(x) & UINT64_C(0x00000000000000ff)) << 56) | \
912 (((U64)(x) & UINT64_C(0x000000000000ff00)) << 40) | \
913 (((U64)(x) & UINT64_C(0x0000000000ff0000)) << 24) | \
914 (((U64)(x) & UINT64_C(0x00000000ff000000)) << 8) | \
915 (((U64)(x) & UINT64_C(0x000000ff00000000)) >> 8) | \
916 (((U64)(x) & UINT64_C(0x0000ff0000000000)) >> 24) | \
917 (((U64)(x) & UINT64_C(0x00ff000000000000)) >> 40) | \
918 (((U64)(x) & UINT64_C(0xff00000000000000)) >> 56) ))
1109a392
MHM
919# endif
920
9c17f24a
NC
921/* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
922 at least on FreeBSD. YMMV, so experiment. */
923#ifndef PERL_ARENA_SIZE
924#define PERL_ARENA_SIZE 4080
925#endif
926
ccb2c8b8 927/* Maximum level of recursion */
2b9dff67
RGS
928#ifndef PERL_SUB_DEPTH_WARN
929#define PERL_SUB_DEPTH_WARN 100
ccb2c8b8
RGS
930#endif
931
1109a392
MHM
932#endif /* PERL_CORE */
933
e839e6ed
DM
934/* Maximum number of args that may be passed to an OP_MULTICONCAT op.
935 * It determines the size of local arrays in S_maybe_multiconcat() and
936 * pp_multiconcat().
937 */
938#define PERL_MULTICONCAT_MAXARG 64
939
940/* The indexes of fields of a multiconcat aux struct.
941 * The fixed fields are followed by nargs+1 const segment lengths,
942 * and if utf8 and non-utf8 differ, a second nargs+1 set for utf8.
943 */
944
945#define PERL_MULTICONCAT_IX_NARGS 0 /* number of arguments */
946#define PERL_MULTICONCAT_IX_PLAIN_PV 1 /* non-utf8 constant string */
947#define PERL_MULTICONCAT_IX_PLAIN_LEN 2 /* non-utf8 constant string length */
948#define PERL_MULTICONCAT_IX_UTF8_PV 3 /* utf8 constant string */
949#define PERL_MULTICONCAT_IX_UTF8_LEN 4 /* utf8 constant string length */
950#define PERL_MULTICONCAT_IX_LENGTHS 5 /* first of nargs+1 const segment lens */
951#define PERL_MULTICONCAT_HEADER_SIZE 5 /* The number of fields of a
952 multiconcat header */
953
bdf3085f
NC
954/* We no longer default to creating a new SV for GvSV.
955 Do this before embed. */
956#ifndef PERL_CREATE_GVSV
7459f06b
NC
957# ifndef PERL_DONT_CREATE_GVSV
958# define PERL_DONT_CREATE_GVSV
959# endif
bdf3085f
NC
960#endif
961
ca0c25f6
NC
962#if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
963#define PERL_USES_PL_PIDSTATUS
964#endif
965
739a0b84 966#if !defined(OS2) && !defined(WIN32) && !defined(DJGPP) && !defined(__SYMBIAN32__)
a62746fa
RGS
967#define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
968#endif
969
c31fac66
GS
970#define MEM_SIZE Size_t
971
1936d2a7
NC
972/* Round all values passed to malloc up, by default to a multiple of
973 sizeof(size_t)
974*/
975#ifndef PERL_STRLEN_ROUNDUP_QUANTUM
976#define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
977#endif
978
f1200559
WH
979/* sv_grow() will expand strings by at least a certain percentage of
980 the previously *used* length to avoid excessive calls to realloc().
981 The default is 25% of the current length.
982*/
983#ifndef PERL_STRLEN_EXPAND_SHIFT
984# define PERL_STRLEN_EXPAND_SHIFT 2
985#endif
986
346712be
AC
987#include <stddef.h>
988#define STRUCT_OFFSET(s,m) offsetof(s,m)
d0b86e2f
BF
989
990/* ptrdiff_t is C11, so undef it under pedantic builds */
991#ifdef PERL_GCC_PEDANTIC
992# undef HAS_PTRDIFF_T
51371543
GS
993#endif
994
9969cdde 995#ifndef __SYMBIAN32__
d54fbe84 996# include <string.h>
51371543
GS
997#endif
998
55497cff 999/* This comes after <stdlib.h> so we don't try to change the standard
1000 * library prototypes; we'll use our own in proto.h instead. */
03a14243 1001
4633a7c4 1002#ifdef MYMALLOC
86058a2d 1003# ifdef PERL_POLLUTE_MALLOC
ee13e175 1004# ifndef PERL_EXTMALLOC_DEF
86058a2d
GS
1005# define Perl_malloc malloc
1006# define Perl_calloc calloc
1007# define Perl_realloc realloc
1008# define Perl_mfree free
ee13e175 1009# endif
86058a2d
GS
1010# else
1011# define EMBEDMYMALLOC /* for compatibility */
1012# endif
827e134a 1013
651b9576
GS
1014# define safemalloc Perl_malloc
1015# define safecalloc Perl_calloc
1016# define saferealloc Perl_realloc
1017# define safefree Perl_mfree
22f7c9c9
JH
1018# define CHECK_MALLOC_TOO_LATE_FOR_(code) STMT_START { \
1019 if (!PL_tainting && MallocCfg_ptr[MallocCfg_cfg_env_read]) \
1020 code; \
1021 } STMT_END
1022# define CHECK_MALLOC_TOO_LATE_FOR(ch) \
1023 CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
1024# define panic_write2(s) write(2, s, strlen(s))
1025# define CHECK_MALLOC_TAINT(newval) \
1026 CHECK_MALLOC_TOO_LATE_FOR_( \
1027 if (newval) { \
acfd4d8e 1028 PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
22f7c9c9 1029 exit(1); })
22f7c9c9 1030# define MALLOC_CHECK_TAINT(argc,argv,env) STMT_START { \
b0891165 1031 if (doing_taint(argc,argv,env)) { \
22f7c9c9
JH
1032 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1; \
1033 }} STMT_END;
f2517201
GS
1034#else /* MYMALLOC */
1035# define safemalloc safesysmalloc
1036# define safecalloc safesyscalloc
1037# define saferealloc safesysrealloc
1038# define safefree safesysfree
22f7c9c9
JH
1039# define CHECK_MALLOC_TOO_LATE_FOR(ch) ((void)0)
1040# define CHECK_MALLOC_TAINT(newval) ((void)0)
1041# define MALLOC_CHECK_TAINT(argc,argv,env)
55497cff 1042#endif /* MYMALLOC */
4633a7c4 1043
fe13d51d 1044/* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
27da23d5 1045#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
1046#define TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, "")
1047#define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
1048#define MALLOC_CHECK_TAINT2(argc,argv) MALLOC_CHECK_TAINT(argc,argv,NULL)
1049
fc36a67e 1050#ifndef memzero
04322328 1051# define memzero(d,l) memset(d,0,l)
d9d8d8de 1052#endif
378cc40b 1053
ae986130 1054#ifdef I_NETINET_IN
79072805 1055# include <netinet/in.h>
ae986130
LW
1056#endif
1057
28e8609d
JH
1058#ifdef I_ARPA_INET
1059# include <arpa/inet.h>
1060#endif
1061
1aef975c 1062#ifdef I_SYS_STAT
84902520 1063# include <sys/stat.h>
1aef975c 1064#endif
79072805 1065
287a962e
JD
1066/* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1067 This definition should ideally go into win32/win32.h, but S_IFIFO is
1068 used later here in perl.h before win32/win32.h is being included. */
1069#if !defined(S_IFIFO) && defined(_S_IFIFO)
1070# define S_IFIFO _S_IFIFO
1071#endif
1072
cc3315ba 1073/* The stat macros for Unisoft System V/88 (and derivatives
a0d0e21e
LW
1074 like UTekV) are broken, sometimes giving false positives. Undefine
1075 them here and let the code below set them to proper values.
1076
1077 The ghs macro stands for GreenHills Software C-1.8.5 which
1078 is the C compiler for sysV88 and the various derivatives.
1079 This header file bug is corrected in gcc-2.5.8 and later versions.
1080 --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94. */
1081
cc3315ba 1082#if defined(m88k) && defined(ghs)
79072805
LW
1083# undef S_ISDIR
1084# undef S_ISCHR
1085# undef S_ISBLK
1086# undef S_ISREG
1087# undef S_ISFIFO
1088# undef S_ISLNK
ee0007ab 1089#endif
135863df 1090
9245da2a 1091#include <time.h>
663a0e37 1092
fe14fcc3 1093#ifdef I_SYS_TIME
85e6fe83 1094# ifdef I_SYS_TIME_KERNEL
663a0e37
LW
1095# define KERNEL
1096# endif
1097# include <sys/time.h>
85e6fe83 1098# ifdef I_SYS_TIME_KERNEL
663a0e37
LW
1099# undef KERNEL
1100# endif
a687059c 1101#endif
135863df 1102
55497cff 1103#if defined(HAS_TIMES) && defined(I_SYS_TIMES)
85e6fe83 1104# include <sys/times.h>
d9d8d8de 1105#endif
8d063cd8 1106
663a0e37 1107#include <errno.h>
1e743fda 1108
acfe0abc 1109#if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
b4748376
NIS
1110# define WIN32SCK_IS_STDSCK /* don't pull in custom wsock layer */
1111#endif
1112
da70cfc6 1113#if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1e743fda
JH
1114# include <sys/socket.h>
1115# if defined(USE_SOCKS) && defined(I_SOCKS)
1116# if !defined(INCLUDE_PROTOTYPES)
1117# define INCLUDE_PROTOTYPES /* for <socks.h> */
1118# define PERL_SOCKS_NEED_PROTOTYPES
1119# endif
1120# include <socks.h>
1121# ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1122# undef INCLUDE_PROTOTYPES
1123# undef PERL_SOCKS_NEED_PROTOTYPES
ed6116ce 1124# endif
d460ef45 1125# endif
1e743fda 1126# ifdef I_NETDB
2986a63f
JH
1127# ifdef NETWARE
1128# include<stdio.h>
1129# endif
1e743fda
JH
1130# include <netdb.h>
1131# endif
1132# ifndef ENOTSOCK
1133# ifdef I_NET_ERRNO
1134# include <net/errno.h>
1135# endif
1136# endif
1137#endif
1138
fa0a29af 1139/* sockatmark() is so new (2001) that many places might have it hidden
29820b6d
MHM
1140 * behind some -D_BLAH_BLAH_SOURCE guard. The __THROW magic is required
1141 * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
fa0a29af 1142#if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
29820b6d
MHM
1143# if defined(__THROW) && defined(__GLIBC__)
1144int sockatmark(int) __THROW;
1145# else
2ef53570 1146int sockatmark(int);
29820b6d 1147# endif
2ef53570
JH
1148#endif
1149
7e827271 1150#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
1151EXTERN_C int fchdir(int);
1152EXTERN_C int flock(int, int);
1153EXTERN_C int fseeko(FILE *, off_t, int);
1154EXTERN_C off_t ftello(FILE *);
1155#endif
1156
7e827271 1157#if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1ccb7c8d
JH
1158EXTERN_C char *crypt(const char *, const char *);
1159#endif
1160
a54aca4b 1161#if defined(__cplusplus) && defined(__CYGWIN__)
667e2948
SP
1162EXTERN_C char *crypt(const char *, const char *);
1163#endif
1164
1e743fda
JH
1165#ifdef SETERRNO
1166# undef SETERRNO /* SOCKS might have defined this */
ed6116ce 1167#endif
f86702cc 1168
1169#ifdef VMS
1170# define SETERRNO(errcode,vmserrcode) \
1171 STMT_START { \
1172 set_errno(errcode); \
1173 set_vaxc_errno(vmserrcode); \
1174 } STMT_END
4ee39169
CS
1175# define dSAVEDERRNO int saved_errno; unsigned saved_vms_errno
1176# define dSAVE_ERRNO int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1177# define SAVE_ERRNO ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1178# define RESTORE_ERRNO SETERRNO(saved_errno, saved_vms_errno)
1179
93189314
JH
1180# define LIB_INVARG LIB$_INVARG
1181# define RMS_DIR RMS$_DIR
1182# define RMS_FAC RMS$_FAC
1183# define RMS_FEX RMS$_FEX
1184# define RMS_FNF RMS$_FNF
1185# define RMS_IFI RMS$_IFI
1186# define RMS_ISI RMS$_ISI
1187# define RMS_PRV RMS$_PRV
1188# define SS_ACCVIO SS$_ACCVIO
1189# define SS_DEVOFFLINE SS$_DEVOFFLINE
1190# define SS_IVCHAN SS$_IVCHAN
1191# define SS_NORMAL SS$_NORMAL
8a9f18be 1192# define SS_NOPRIV SS$_NOPRIV
4388f261 1193# define SS_BUFFEROVF SS$_BUFFEROVF
748a9306 1194#else
93189314
JH
1195# define LIB_INVARG 0
1196# define RMS_DIR 0
1197# define RMS_FAC 0
1198# define RMS_FEX 0
1199# define RMS_FNF 0
1200# define RMS_IFI 0
1201# define RMS_ISI 0
1202# define RMS_PRV 0
1203# define SS_ACCVIO 0
1204# define SS_DEVOFFLINE 0
1205# define SS_IVCHAN 0
1206# define SS_NORMAL 0
8a9f18be 1207# define SS_NOPRIV 0
4388f261 1208# define SS_BUFFEROVF 0
748a9306 1209#endif
ed6116ce 1210
6ca940a9
TC
1211#ifdef WIN32
1212# define dSAVEDERRNO int saved_errno; DWORD saved_win32_errno
1213# define dSAVE_ERRNO int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1214# define SAVE_ERRNO ( saved_errno = errno, saved_win32_errno = GetLastError() )
1215# define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1216#endif
1217
1218#ifdef OS2
1219# define dSAVEDERRNO int saved_errno; unsigned long saved_os2_errno
1220# define dSAVE_ERRNO int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1221# define SAVE_ERRNO ( saved_errno = errno, saved_os2_errno = Perl_rc )
1222# define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1223#endif
1224
1225#ifndef SETERRNO
1226# define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1227#endif
1228
1229#ifndef dSAVEDERRNO
1230# define dSAVEDERRNO int saved_errno
1231# define dSAVE_ERRNO int saved_errno = errno
1232# define SAVE_ERRNO (saved_errno = errno)
1233# define RESTORE_ERRNO (errno = saved_errno)
1234#endif
1235
f5fa9033 1236#define ERRSV GvSVn(PL_errgv)
dfd167e9 1237
b4f8d149 1238/* contains inlined gv_add_by_type */
dfd167e9 1239#define CLEAR_ERRSV() STMT_START { \
b4f8d149
DD
1240 SV ** const svp = &GvSV(PL_errgv); \
1241 if (!*svp) { \
a1b60c8d 1242 *svp = newSVpvs(""); \
b4f8d149
DD
1243 } else if (SvREADONLY(*svp)) { \
1244 SvREFCNT_dec_NN(*svp); \
b4f8d149 1245 *svp = newSVpvs(""); \
dfd167e9 1246 } else { \
b4f8d149 1247 SV *const errsv = *svp; \
a1b60c8d 1248 SvPVCLEAR(errsv); \
b4f8d149 1249 SvPOK_only(errsv); \
dfd167e9
NC
1250 if (SvMAGICAL(errsv)) { \
1251 mg_free(errsv); \
1252 } \
dfd167e9
NC
1253 } \
1254 } STMT_END
1255
1256
414bf5ae
MHM
1257#ifdef PERL_CORE
1258# define DEFSV (0 + GvSVn(PL_defgv))
55b5114f
FC
1259# define DEFSV_set(sv) \
1260 (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1261# define SAVE_DEFSV \
1262 ( \
1263 save_gp(PL_defgv, 0), \
1264 GvINTRO_off(PL_defgv), \
1265 SAVEGENERICSV(GvSV(PL_defgv)), \
1266 GvSV(PL_defgv) = NULL \
1267 )
414bf5ae
MHM
1268#else
1269# define DEFSV GvSVn(PL_defgv)
55b5114f
FC
1270# define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1271# define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
414bf5ae 1272#endif
38a03e6e 1273
55497cff 1274#ifndef errno
5ff3f7a4
GS
1275 extern int errno; /* ANSI allows errno to be an lvalue expr.
1276 * For example in multithreaded environments
1277 * something like this might happen:
1278 * extern int *_errno(void);
1279 * #define errno (*_errno()) */
d9d8d8de 1280#endif
663a0e37 1281
7e996671
KW
1282#define UNKNOWN_ERRNO_MSG "(unknown)"
1283
b21d8587
AC
1284#if VMS
1285#define Strerror(e) strerror((e), vaxc$errno)
1286#else
1287#define Strerror(e) strerror(e)
35c8bce7 1288#endif
663a0e37 1289
2304df62 1290#ifdef I_SYS_IOCTL
79072805
LW
1291# ifndef _IOCTL_
1292# include <sys/ioctl.h>
1293# endif
a687059c
LW
1294#endif
1295
ee0007ab 1296#if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
79072805
LW
1297# ifdef HAS_SOCKETPAIR
1298# undef HAS_SOCKETPAIR
1299# endif
2304df62
AD
1300# ifdef I_NDBM
1301# undef I_NDBM
79072805 1302# endif
a687059c
LW
1303#endif
1304
02fc2eee
NC
1305#ifndef HAS_SOCKETPAIR
1306# ifdef HAS_SOCKET
1307# define socketpair Perl_my_socketpair
1308# endif
1309#endif
1310
a687059c 1311#if INTSIZE == 2
79072805
LW
1312# define htoni htons
1313# define ntohi ntohs
a687059c 1314#else
79072805
LW
1315# define htoni htonl
1316# define ntohi ntohl
a687059c
LW
1317#endif
1318
a0d0e21e 1319/* Configure already sets Direntry_t */
35c8bce7 1320#if defined(I_DIRENT)
da5fdda8
AC
1321# include <dirent.h>
1322#elif defined(I_SYS_NDIR)
1323# include <sys/ndir.h>
1324#elif defined(I_SYS_DIR)
1325# include <sys/dir.h>
4633a7c4 1326#endif
a687059c 1327
c623bd54
LW
1328/*
1329 * The following gobbledygook brought to you on behalf of __STDC__.
1330 * (I could just use #ifndef __STDC__, but this is more bulletproof
1331 * in the face of half-implementations.)
1332 */
1333
21e89b5f 1334#if defined(I_SYSMODE)
ca6e1c26
JH
1335#include <sys/mode.h>
1336#endif
1337
c623bd54
LW
1338#ifndef S_IFMT
1339# ifdef _S_IFMT
1340# define S_IFMT _S_IFMT
1341# else
1342# define S_IFMT 0170000
1343# endif
1344#endif
1345
1346#ifndef S_ISDIR
1347# define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1348#endif
1349
1350#ifndef S_ISCHR
1351# define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1352#endif
1353
1354#ifndef S_ISBLK
fe14fcc3
LW
1355# ifdef S_IFBLK
1356# define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1357# else
1358# define S_ISBLK(m) (0)
1359# endif
c623bd54
LW
1360#endif
1361
1362#ifndef S_ISREG
1363# define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1364#endif
1365
1366#ifndef S_ISFIFO
fe14fcc3
LW
1367# ifdef S_IFIFO
1368# define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1369# else
1370# define S_ISFIFO(m) (0)
1371# endif
c623bd54
LW
1372#endif
1373
1374#ifndef S_ISLNK
da5fdda8
AC
1375# ifdef _S_ISLNK
1376# define S_ISLNK(m) _S_ISLNK(m)
1377# elif defined(_S_IFLNK)
1378# define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1379# elif defined(S_IFLNK)
1380# define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1381# else
1382# define S_ISLNK(m) (0)
1383# endif
c623bd54
LW
1384#endif
1385
1386#ifndef S_ISSOCK
da5fdda8
AC
1387# ifdef _S_ISSOCK
1388# define S_ISSOCK(m) _S_ISSOCK(m)
1389# elif defined(_S_IFSOCK)
1390# define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1391# elif defined(S_IFSOCK)
1392# define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1393# else
1394# define S_ISSOCK(m) (0)
1395# endif
c623bd54
LW
1396#endif
1397
1398#ifndef S_IRUSR
1399# ifdef S_IREAD
1400# define S_IRUSR S_IREAD
1401# define S_IWUSR S_IWRITE
1402# define S_IXUSR S_IEXEC
1403# else
1404# define S_IRUSR 0400
1405# define S_IWUSR 0200
1406# define S_IXUSR 0100
1407# endif
fac7cdfc
JS
1408#endif
1409
1410#ifndef S_IRGRP
1411# ifdef S_IRUSR
1412# define S_IRGRP (S_IRUSR>>3)
1413# define S_IWGRP (S_IWUSR>>3)
1414# define S_IXGRP (S_IXUSR>>3)
1415# else
1416# define S_IRGRP 0040
1417# define S_IWGRP 0020
1418# define S_IXGRP 0010
1419# endif
1420#endif
1421
1422#ifndef S_IROTH
1423# ifdef S_IRUSR
1424# define S_IROTH (S_IRUSR>>6)
1425# define S_IWOTH (S_IWUSR>>6)
1426# define S_IXOTH (S_IXUSR>>6)
1427# else
1428# define S_IROTH 0040
1429# define S_IWOTH 0020
1430# define S_IXOTH 0010
1431# endif
c623bd54
LW
1432#endif
1433
1434#ifndef S_ISUID
1435# define S_ISUID 04000
1436#endif
1437
1438#ifndef S_ISGID
1439# define S_ISGID 02000
1440#endif
1441
ca6e1c26
JH
1442#ifndef S_IRWXU
1443# define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
d460ef45 1444#endif
ca6e1c26
JH
1445
1446#ifndef S_IRWXG
1447# define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
d460ef45 1448#endif
ca6e1c26
JH
1449
1450#ifndef S_IRWXO
1451# define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
d460ef45 1452#endif
ca6e1c26 1453
b6c36746 1454/* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
c21fb2b8
JH
1455 * which would get included through <sys/file.h >, but that is 3000
1456 * lines in the future. --jhi */
1457
b6c36746 1458#if !defined(S_IREAD) && !defined(__HAIKU__)
ca6e1c26
JH
1459# define S_IREAD S_IRUSR
1460#endif
1461
b6c36746 1462#if !defined(S_IWRITE) && !defined(__HAIKU__)
ca6e1c26
JH
1463# define S_IWRITE S_IWUSR
1464#endif
1465
1466#ifndef S_IEXEC
1467# define S_IEXEC S_IXUSR
1468#endif
1469
a0d0e21e 1470#if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
45d8adaa
LW
1471# define SLOPPYDIVIDE
1472#endif
1473
748a9306
LW
1474#ifdef UV
1475#undef UV
1476#endif
1477
f1519f70
AC
1478/* This used to be conditionally defined based on whether we had a sprintf()
1479 * that correctly returns the string length (as required by C89), but we no
1480 * longer need that. XS modules can (and do) use this name, so it must remain
1481 * a part of the API that's visible to modules. But we no longer document it
1482 * either (because using sprintf() rather than snprintf() is almost always
1483 * a bad idea). */
1484#define my_sprintf sprintf
ce582cee 1485
5b692037
JH
1486/*
1487 * If we have v?snprintf() and the C99 variadic macros, we can just
1488 * use just the v?snprintf(). It is nice to try to trap the buffer
1489 * overflow, however, so if we are DEBUGGING, and we cannot use the
e5afc1ae
DD
1490 * gcc statement expressions, then use the function wrappers which try
1491 * to trap the overflow. If we can use the gcc statement expressions,
1492 * we can try that even with the version that uses the C99 variadic
1493 * macros.
5b692037
JH
1494 */
1495
1208b3dd 1496/* Note that we do not check against snprintf()/vsnprintf() returning
4059ba87
AC
1497 * negative values because that is non-standard behaviour and we use
1498 * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1499 * that should be true only if the snprintf()/vsnprintf() are true
1500 * to the standard. */
1208b3dd 1501
571ee10c 1502#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 1503
a4eca1d4
JH
1504#ifdef USE_QUADMATH
1505# define my_snprintf Perl_my_snprintf
1506# define PERL_MY_SNPRINTF_GUARDED
4059ba87 1507#elif defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
5b692037 1508# ifdef PERL_USE_GCC_BRACE_GROUPS
e8549682 1509# define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1208b3dd 1510# define PERL_MY_SNPRINTF_GUARDED
5b692037 1511# else
e8549682 1512# define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
5b692037
JH
1513# endif
1514#else
1515# define my_snprintf Perl_my_snprintf
1208b3dd 1516# define PERL_MY_SNPRINTF_GUARDED
5b692037
JH
1517#endif
1518
a4eca1d4
JH
1519/* There is no quadmath_vsnprintf, and therefore my_vsnprintf()
1520 * dies if called under USE_QUADMATH. */
4059ba87 1521#if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
5b692037 1522# ifdef PERL_USE_GCC_BRACE_GROUPS
e8549682 1523# define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1208b3dd 1524# define PERL_MY_VSNPRINTF_GUARDED
5b692037 1525# else
e8549682 1526# define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
5b692037
JH
1527# endif
1528#else
1529# define my_vsnprintf Perl_my_vsnprintf
1208b3dd 1530# define PERL_MY_VSNPRINTF_GUARDED
5b692037 1531#endif
d9fad198 1532
e8549682
JH
1533/* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1534 * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1535 * the result of my_snprintf() or my_vsnprintf(). (No, you should not
1536 * completely ignore it: otherwise you cannot know whether your output
1537 * was too long.)
1538 *
1539 * int len = my_sprintf(buf, max, ...);
1540 * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1541 *
1542 * The trick is that in certain platforms [a] the my_sprintf() already
1543 * contains the sanity check, while in certain platforms [b] it needs
1544 * to be done as a separate step. The POST_GUARD is that step-- in [a]
1545 * platforms the POST_GUARD actually does nothing since the check has
1546 * already been done. Watch out for the max being the same in both calls.
1547 *
1548 * If you actually use the snprintf/vsnprintf return value already,
1549 * you assumedly are checking its validity somehow. But you can
1550 * insert the POST_GUARD() also in that case. */
1551
1552#ifndef PERL_MY_SNPRINTF_GUARDED
1553# define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1554#else
1555# define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1556#endif
1557
1558#ifndef PERL_MY_VSNPRINTF_GUARDED
1559# define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
1560#else
1561# define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1562#endif
1563
a6cc4119
SP
1564#ifdef HAS_STRLCAT
1565# define my_strlcat strlcat
1566#else
1567# define my_strlcat Perl_my_strlcat
1568#endif
1569
6dba01e2
KW
1570#if defined(PERL_CORE) || defined(PERL_EXT)
1571# ifdef HAS_MEMRCHR
1572# define my_memrchr memrchr
1573# else
1574# define my_memrchr S_my_memrchr
1575# endif
1576#endif
1577
a6cc4119
SP
1578#ifdef HAS_STRLCPY
1579# define my_strlcpy strlcpy
1580#else
1581# define my_strlcpy Perl_my_strlcpy
1582#endif
1583
aefb3fa0
DIM
1584#ifdef HAS_STRNLEN
1585# define my_strnlen strnlen
1586#else
1587# define my_strnlen Perl_my_strnlen
1588#endif
1589
05f13f53 1590/*
27d4fb96 1591 The IV type is supposed to be long enough to hold any integral
1592 value or a pointer.
1593 --Andy Dougherty August 1996
1594*/
1595
a22e52b9
JH
1596typedef IVTYPE IV;
1597typedef UVTYPE UV;
8175356b 1598
10cc9d2a 1599#if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
6b8eaf93 1600# if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
5ff3f7a4
GS
1601# define IV_MAX INT64_MAX
1602# define IV_MIN INT64_MIN
1603# define UV_MAX UINT64_MAX
cae7ae48
JH
1604# ifndef UINT64_MIN
1605# define UINT64_MIN 0
1606# endif
5ff3f7a4
GS
1607# define UV_MIN UINT64_MIN
1608# else
1609# define IV_MAX PERL_QUAD_MAX
1610# define IV_MIN PERL_QUAD_MIN
1611# define UV_MAX PERL_UQUAD_MAX
1612# define UV_MIN PERL_UQUAD_MIN
1613# endif
cf2093f6
JH
1614# define IV_IS_QUAD
1615# define UV_IS_QUAD
79072805 1616#else
8175356b 1617# if defined(INT32_MAX) && IVSIZE == 4
5ff3f7a4
GS
1618# define IV_MAX INT32_MAX
1619# define IV_MIN INT32_MIN
716026f9
DL
1620# ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
1621# define UV_MAX UINT32_MAX
1622# else
1623# define UV_MAX 4294967295U
1624# endif
cae7ae48
JH
1625# ifndef UINT32_MIN
1626# define UINT32_MIN 0
1627# endif
5ff3f7a4
GS
1628# define UV_MIN UINT32_MIN
1629# else
1630# define IV_MAX PERL_LONG_MAX
1631# define IV_MIN PERL_LONG_MIN
1632# define UV_MAX PERL_ULONG_MAX
1633# define UV_MIN PERL_ULONG_MIN
1634# endif
8175356b 1635# if IVSIZE == 8
cf2093f6
JH
1636# define IV_IS_QUAD
1637# define UV_IS_QUAD
de1c2614
JH
1638# ifndef HAS_QUAD
1639# define HAS_QUAD
1640# endif
cf2093f6
JH
1641# else
1642# undef IV_IS_QUAD
1643# undef UV_IS_QUAD
9ea40801 1644#if !defined(PERL_CORE) || defined(USING_MSVC6)
e25d460c
NC
1645/* We think that removing this decade-old undef this will cause too much
1646 breakage on CPAN for too little gain. (See RT #119753)
9ea40801
SH
1647 However, we do need HAS_QUAD in the core for use by the drand48 code,
1648 but not for Win32 VC6 because it has poor __int64 support. */
cb4b14d5 1649# undef HAS_QUAD
e25d460c 1650#endif
cf2093f6 1651# endif
79072805 1652#endif
d7d93a81 1653
6313e544
JH
1654#define Size_t_MAX (~(Size_t)0)
1655#define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
9a543cee 1656
cae7ae48 1657#define IV_DIG (BIT_DIGITS(IVSIZE * 8))
22ec83e3 1658#define UV_DIG (BIT_DIGITS(UVSIZE * 8))
56431972 1659
28e5dec8 1660#ifndef NO_PERL_PRESERVE_IVUV
f5c03d33 1661#define PERL_PRESERVE_IVUV /* We like our integers to stay integers. */
28e5dec8
JH
1662#endif
1663
d460ef45 1664/*
26bb67e2
JH
1665 * The macros INT2PTR and NUM2PTR are (despite their names)
1666 * bi-directional: they will convert int/float to or from pointers.
1667 * However the conversion to int/float are named explicitly:
1668 * PTR2IV, PTR2UV, PTR2NV.
1669 *
1670 * For int conversions we do not need two casts if pointers are
1671 * the same size as IV and UV. Otherwise we need an explicit
1672 * cast (PTRV) to avoid compiler warnings.
1673 */
56431972
RB
1674#if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1675# define PTRV UV
1676# define INT2PTR(any,d) (any)(d)
da5fdda8
AC
1677#elif PTRSIZE == LONGSIZE
1678# define PTRV unsigned long
1679# define PTR2ul(p) (unsigned long)(p)
56431972 1680#else
da5fdda8 1681# define PTRV unsigned
e91e3b10
RB
1682#endif
1683
1684#ifndef INT2PTR
56431972 1685# define INT2PTR(any,d) (any)(PTRV)(d)
42718184 1686#endif
e91e3b10
RB
1687
1688#ifndef PTR2ul
1689# define PTR2ul(p) INT2PTR(unsigned long,p)
1690#endif
1691
56431972
RB
1692#define NUM2PTR(any,d) (any)(PTRV)(d)
1693#define PTR2IV(p) INT2PTR(IV,p)
1694#define PTR2UV(p) INT2PTR(UV,p)
1695#define PTR2NV(p) NUM2PTR(NV,p)
e91e3b10 1696#define PTR2nat(p) (PTRV)(p) /* pointer to integer of PTRSIZE */
d460ef45 1697
8141890a
JH
1698/* According to strict ANSI C89 one cannot freely cast between
1699 * data pointers and function (code) pointers. There are at least
1700 * two ways around this. One (used below) is to do two casts,
1701 * first the other pointer to an (unsigned) integer, and then
1702 * the integer to the other pointer. The other way would be
1703 * to use unions to "overlay" the pointers. For an example of
1704 * the latter technique, see union dirpu in struct xpvio in sv.h.
1705 * The only feasible use is probably temporarily storing
1706 * function pointers in a data pointer (such as a void pointer). */
1707
e91e3b10
RB
1708#define DPTR2FPTR(t,p) ((t)PTR2nat(p)) /* data pointer to function pointer */
1709#define FPTR2DPTR(t,p) ((t)PTR2nat(p)) /* function pointer to data pointer */
8141890a 1710
65202027 1711#ifdef USE_LONG_DOUBLE
f3654d06
JH
1712# if LONG_DOUBLESIZE == DOUBLESIZE
1713# define LONG_DOUBLE_EQUALS_DOUBLE
1714# undef USE_LONG_DOUBLE /* Ouch! */
65202027
DS
1715# endif
1716#endif
1717
2d4389e4
JH
1718/* The following is all to get LDBL_DIG, in order to pick a nice
1719 default value for printing floating point numbers in Gconvert.
1720 (see config.h)
1721*/
63b481b9 1722#ifndef HAS_LDBL_DIG
68d4903c 1723# if LONG_DOUBLESIZE == 10
63b481b9
AC
1724# define LDBL_DIG 18 /* assume IEEE */
1725# elif LONG_DOUBLESIZE == 12
68d4903c 1726# define LDBL_DIG 18 /* gcc? */
63b481b9
AC
1727# elif LONG_DOUBLESIZE == 16
1728# define LDBL_DIG 33 /* assume IEEE */
1729# elif LONG_DOUBLESIZE == DOUBLESIZE
1730# define LDBL_DIG DBL_DIG /* bummer */
68d4903c 1731# endif
2d4389e4
JH
1732#endif
1733
a22e52b9 1734typedef NVTYPE NV;
8175356b 1735
792d8dab
JH
1736#ifdef I_IEEEFP
1737# include <ieeefp.h>
1738#endif
923fc586 1739
c32c3de1
JH
1740#ifdef USING_MSVC6
1741/* VC6 has broken NaN semantics: NaN == NaN returns true instead of false,
1742 * and for example NaN < IV_MIN. */
bcd8bfa9
JH
1743# define NAN_COMPARE_BROKEN
1744#endif
1745#if defined(__DECC) && defined(__osf__)
1746/* Also Tru64 cc has broken NaN comparisons. */
1747# define NAN_COMPARE_BROKEN
c32c3de1 1748#endif
6504068e
JH
1749#if defined(__sgi)
1750# define NAN_COMPARE_BROKEN
1751#endif
c32c3de1 1752
65202027 1753#ifdef USE_LONG_DOUBLE
923fc586
JH
1754# ifdef I_SUNMATH
1755# include <sunmath.h>
1756# endif
84e6cb05 1757# if defined(LDBL_DIG)
05b4a618
JH
1758# define NV_DIG LDBL_DIG
1759# ifdef LDBL_MANT_DIG
1760# define NV_MANT_DIG LDBL_MANT_DIG
1761# endif
1762# ifdef LDBL_MIN
1763# define NV_MIN LDBL_MIN
1764# endif
1765# ifdef LDBL_MAX
1766# define NV_MAX LDBL_MAX
1767# endif
1768# ifdef LDBL_MIN_EXP
1769# define NV_MIN_EXP LDBL_MIN_EXP
1770# endif
1771# ifdef LDBL_MAX_EXP
1772# define NV_MAX_EXP LDBL_MAX_EXP
1773# endif
1774# ifdef LDBL_MIN_10_EXP
1775# define NV_MIN_10_EXP LDBL_MIN_10_EXP
1776# endif
1777# ifdef LDBL_MAX_10_EXP
1778# define NV_MAX_10_EXP LDBL_MAX_10_EXP
1779# endif
1780# ifdef LDBL_EPSILON
1781# define NV_EPSILON LDBL_EPSILON
1782# endif
1783# ifdef LDBL_MAX
1784# define NV_MAX LDBL_MAX
20f6aaab 1785/* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
da5fdda8
AC
1786# elif defined(HUGE_VALL)
1787# define NV_MAX HUGE_VALL
f4a14a62
JH
1788# endif
1789# endif
84e6cb05 1790# if defined(HAS_SQRTL)
8a00eddc
JH
1791# define Perl_acos acosl
1792# define Perl_asin asinl
1793# define Perl_atan atanl
940e3d56
JH
1794# define Perl_atan2 atan2l
1795# define Perl_ceil ceill
1796# define Perl_cos cosl
8a00eddc 1797# define Perl_cosh coshl
940e3d56 1798# define Perl_exp expl
55da5e5b 1799/* no Perl_fabs, but there's PERL_ABS */
940e3d56
JH
1800# define Perl_floor floorl
1801# define Perl_fmod fmodl
1802# define Perl_log logl
8a00eddc 1803# define Perl_log10 log10l
940e3d56
JH
1804# define Perl_pow powl
1805# define Perl_sin sinl
8a00eddc 1806# define Perl_sinh sinhl
940e3d56 1807# define Perl_sqrt sqrtl
8a00eddc
JH
1808# define Perl_tan tanl
1809# define Perl_tanh tanhl
68d4903c 1810# endif
a3540c92 1811/* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
05b4a618
JH
1812# ifndef Perl_modf
1813# ifdef HAS_MODFL
1814# define Perl_modf(x,y) modfl(x,y)
51997bc3
NC
1815/* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
1816 prototype in <math.h> */
05b4a618 1817# ifndef HAS_MODFL_PROTO
a221a8a5 1818EXTERN_C long double modfl(long double, long double *);
05b4a618
JH
1819# endif
1820# elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
55954f19 1821 extern long double Perl_my_modfl(long double x, long double *ip);
03476e8e 1822# define Perl_modf(x,y) Perl_my_modfl(x,y)
05b4a618 1823# endif
a3540c92 1824# endif
05b4a618
JH
1825# ifndef Perl_frexp
1826# ifdef HAS_FREXPL
1827# define Perl_frexp(x,y) frexpl(x,y)
da5fdda8 1828# elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
05b4a618 1829extern long double Perl_my_frexpl(long double x, int *e);
da5fdda8 1830# define Perl_frexp(x,y) Perl_my_frexpl(x,y)
03476e8e 1831# endif
a3540c92 1832# endif
05b4a618
JH
1833# ifndef Perl_ldexp
1834# ifdef HAS_LDEXPL
1835# define Perl_ldexp(x, y) ldexpl(x,y)
da5fdda8
AC
1836# elif defined(HAS_SCALBNL) && FLT_RADIX == 2
1837# define Perl_ldexp(x,y) scalbnl(x,y)
98181445
JH
1838# endif
1839# endif
38dbb4c5 1840# ifndef Perl_isnan
e4c957f4 1841# if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
758a5d79 1842# define Perl_isnan(x) isnanl(x)
a1115378
JH
1843# elif defined(__sgi) && defined(__c99) /* XXX Configure test needed */
1844# define Perl_isnan(x) isnan(x)
758a5d79
JH
1845# endif
1846# endif
1847# ifndef Perl_isinf
e4c957f4 1848# if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
87190886 1849# define Perl_isinf(x) isinfl(x)
a1115378
JH
1850# elif defined(__sgi) && defined(__c99) /* XXX Configure test needed */
1851# define Perl_isinf(x) isinf(x)
bcd8bfa9 1852# elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
efcbf317 1853# define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
a3540c92
JH
1854# endif
1855# endif
e38461cc
JH
1856# ifndef Perl_isfinite
1857# define Perl_isfinite(x) Perl_isfinitel(x)
1858# endif
84e6cb05
JH
1859#elif defined(USE_QUADMATH) && defined(I_QUADMATH)
1860# include <quadmath.h>
1861# define NV_DIG FLT128_DIG
1862# define NV_MANT_DIG FLT128_MANT_DIG
1863# define NV_MIN FLT128_MIN
1864# define NV_MAX FLT128_MAX
1865# define NV_MIN_EXP FLT128_MIN_EXP
1866# define NV_MAX_EXP FLT128_MAX_EXP
1867# define NV_EPSILON FLT128_EPSILON
1868# define NV_MIN_10_EXP FLT128_MIN_10_EXP
1869# define NV_MAX_10_EXP FLT128_MAX_10_EXP
84e6cb05
JH
1870# define Perl_acos acosq
1871# define Perl_asin asinq
1872# define Perl_atan atanq
1873# define Perl_atan2 atan2q
1874# define Perl_ceil ceilq
1875# define Perl_cos cosq
1876# define Perl_cosh coshq
1877# define Perl_exp expq
1878/* no Perl_fabs, but there's PERL_ABS */
1879# define Perl_floor floorq
1880# define Perl_fmod fmodq
1881# define Perl_log logq
1882# define Perl_log10 log10q
1883# define Perl_pow powq
1884# define Perl_sin sinq
1885# define Perl_sinh sinhq
1886# define Perl_sqrt sqrtq
1887# define Perl_tan tanq
1888# define Perl_tanh tanhq
1889# define Perl_modf(x,y) modfq(x,y)
1890# define Perl_frexp(x,y) frexpq(x,y)
1891# define Perl_ldexp(x, y) ldexpq(x,y)
1892# define Perl_isinf(x) isinfq(x)
1893# define Perl_isnan(x) isnanq(x)
1894# define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
b28053d1
JH
1895# define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
1896# define Perl_fp_class_inf(x) (Perl_fp_class(x) == 3)
1897# define Perl_fp_class_nan(x) (Perl_fp_class(x) == 4)
1898# define Perl_fp_class_norm(x) (Perl_fp_class(x) == 1)
1899# define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
1900# define Perl_fp_class_zero(x) (Perl_fp_class(x) == 0)
65202027 1901#else
2d4389e4 1902# define NV_DIG DBL_DIG
63b481b9
AC
1903# define NV_MANT_DIG DBL_MANT_DIG
1904# define NV_MIN DBL_MIN
1905# define NV_MAX DBL_MAX
1906# define NV_MIN_EXP DBL_MIN_EXP
1907# define NV_MAX_EXP DBL_MAX_EXP
1908# define NV_MIN_10_EXP DBL_MIN_10_EXP
1909# define NV_MAX_10_EXP DBL_MAX_10_EXP
1910# define NV_EPSILON DBL_EPSILON
1911# define NV_MAX DBL_MAX
1912# define NV_MIN DBL_MIN
940e3d56 1913
55da5e5b 1914/* These math interfaces are C89. */
8a00eddc
JH
1915# define Perl_acos acos
1916# define Perl_asin asin
1917# define Perl_atan atan
940e3d56
JH
1918# define Perl_atan2 atan2
1919# define Perl_ceil ceil
1920# define Perl_cos cos
8a00eddc 1921# define Perl_cosh cosh
940e3d56 1922# define Perl_exp exp
55da5e5b 1923/* no Perl_fabs, but there's PERL_ABS */
940e3d56
JH
1924# define Perl_floor floor
1925# define Perl_fmod fmod
1926# define Perl_log log
8a00eddc 1927# define Perl_log10 log10
940e3d56
JH
1928# define Perl_pow pow
1929# define Perl_sin sin
8a00eddc 1930# define Perl_sinh sinh
940e3d56 1931# define Perl_sqrt sqrt
8a00eddc
JH
1932# define Perl_tan tan
1933# define Perl_tanh tanh
940e3d56
JH
1934
1935# define Perl_modf(x,y) modf(x,y)
1936# define Perl_frexp(x,y) frexp(x,y)
1937# define Perl_ldexp(x,y) ldexp(x,y)
1938
1a322af2
JH
1939# ifndef Perl_isnan
1940# ifdef HAS_ISNAN
1941# define Perl_isnan(x) isnan(x)
1942# endif
1943# endif
1944# ifndef Perl_isinf
1945# if defined(HAS_ISINF)
1946# define Perl_isinf(x) isinf(x)
bcd8bfa9 1947# elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
efcbf317 1948# define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
1a322af2
JH
1949# endif
1950# endif
1951# ifndef Perl_isfinite
1952# ifdef HAS_ISFINITE
1953# define Perl_isfinite(x) isfinite(x)
1954# elif defined(HAS_FINITE)
1955# define Perl_isfinite(x) finite(x)
1956# endif
1957# endif
758a5d79
JH
1958#endif
1959
30404d48
JH
1960/* fpclassify(): C99. It is supposed to be a macro that switches on
1961* the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
1962#if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
1963# include <math.h>
25c46df8
JH
1964# if defined(FP_INFINITE) && defined(FP_NAN)
1965# define Perl_fp_class(x) fpclassify(x)
1966# define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_INFINITE)
1967# define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_NAN)
1968# define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_NORMAL)
1969# define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
1970# define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_ZERO)
1971# elif defined(FP_PLUS_INF) && defined(FP_QNAN)
1972/* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
1973 * actually not the C99 fpclassify, with its own set of return defines. */
1974# define Perl_fp_class(x) fpclassify(x)
1975# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
1976# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
82947af8 1977# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
25c46df8
JH
1978# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
1979# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
1ae51000 1980# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
25c46df8
JH
1981# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
1982# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
1983# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
1984# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
1985# else
1986# undef Perl_fp_class /* Unknown set of defines */
1987# endif
30404d48
JH
1988#endif
1989
25c46df8
JH
1990/* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
1991 * are identical to the C99 fpclassify(). */
1992#if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
1993# include <math.h>
558f3e66
CB
1994# ifdef __VMS
1995 /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
1996# include <fp.h>
56610b8f
CB
1997 /* oh, and the isnormal macro has a typo in it! */
1998# undef isnormal
1999# define isnormal(x) Perl_fp_class_norm(x)
558f3e66 2000# endif
25c46df8
JH
2001# if defined(FP_INFINITE) && defined(FP_NAN)
2002# define Perl_fp_class(x) fp_classify(x)
2003# define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_INFINITE)
2004# define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_NAN)
2005# define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_NORMAL)
2006# define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2007# define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_ZERO)
2008# else
2009# undef Perl_fp_class /* Unknown set of defines */
2010# endif
f279e099 2011#endif
205f51d8 2012
30404d48
JH
2013/* Feel free to check with me for the SGI manpages, SGI testing,
2014 * etcetera, if you want to try getting this to work with IRIX.
2015 *
2016 * - Allen <allens@cpan.org> */
2017
2018/* fpclass(): SysV, at least Solaris and some versions of IRIX. */
758a5d79 2019#if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
25c46df8
JH
2020/* Solaris and IRIX have fpclass/fpclassl, but they are using
2021 * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2022 * Define some symbols also as cpp symbols so we can detect them. */
033a6f7a 2023# if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
25c46df8
JH
2024# define FP_PINF FP_PINF
2025# define FP_QNAN FP_QNAN
2026# endif
f279e099 2027# include <math.h>
758a5d79
JH
2028# ifdef I_IEEFP
2029# include <ieeefp.h>
2030# endif
2031# ifdef I_FP
2032# include <fp.h>
2033# endif
2034# if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
f279e099 2035# define Perl_fp_class(x) fpclassl(x)
758a5d79 2036# else
f279e099
JH
2037# define Perl_fp_class(x) fpclass(x)
2038# endif
25c46df8 2039# if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
f279e099
JH
2040# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_CLASS_SNAN)
2041# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_CLASS_QNAN)
2042# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_CLASS_NINF)
2043# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_CLASS_PINF)
2044# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_CLASS_NNORM)
2045# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_CLASS_PNORM)
2046# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_CLASS_NDENORM)
2047# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_CLASS_PDENORM)
2048# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_CLASS_NZERO)
2049# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_CLASS_PZERO)
25c46df8 2050# elif defined(FP_PINF) && defined(FP_QNAN)
f279e099
JH
2051# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2052# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2053# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_NINF)
2054# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PINF)
2055# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_NNORM)
2056# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PNORM)
2057# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_NDENORM)
2058# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PDENORM)
2059# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_NZERO)
2060# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PZERO)
25c46df8
JH
2061# else
2062# undef Perl_fp_class /* Unknown set of defines */
758a5d79 2063# endif
758a5d79
JH
2064#endif
2065
30404d48
JH
2066/* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2067#if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
758a5d79
JH
2068# include <math.h>
2069# if !defined(FP_SNAN) && defined(I_FP_CLASS)
2070# include <fp_class.h>
2071# endif
25c46df8 2072# if defined(FP_POS_INF) && defined(FP_QNAN)
033a6f7a 2073# ifdef __sgi /* XXX Configure test instead */
25c46df8
JH
2074# ifdef USE_LONG_DOUBLE
2075# define Perl_fp_class(x) fp_class_l(x)
2076# else
2077# define Perl_fp_class(x) fp_class_d(x)
2078# endif
f279e099 2079# else
25c46df8
JH
2080# if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2081# define Perl_fp_class(x) fp_classl(x)
2082# else
2083# define Perl_fp_class(x) fp_class(x)
2084# endif
f279e099 2085# endif
25c46df8
JH
2086# if defined(FP_POS_INF) && defined(FP_QNAN)
2087# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2088# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2089# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_NEG_INF)
2090# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_POS_INF)
2091# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_NEG_NORM)
2092# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_POS_NORM)
2093# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_NEG_DENORM)
2094# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_POS_DENORM)
2095# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_NEG_ZERO)
2096# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_POS_ZERO)
30404d48 2097# else
25c46df8 2098# undef Perl_fp_class /* Unknown set of defines */
30404d48 2099# endif
f279e099 2100# endif
30404d48
JH
2101#endif
2102
052758ae 2103/* class(), _class(): Legacy: AIX. */
758a5d79
JH
2104#if !defined(Perl_fp_class) && defined(HAS_CLASS)
2105# include <math.h>
25c46df8
JH
2106# if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2107# ifndef _cplusplus
2108# define Perl_fp_class(x) class(x)
2109# else
2110# define Perl_fp_class(x) _class(x)
2111# endif
2112# if defined(FP_PLUS_INF) && defined(FP_NANQ)
2113# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_NANS)
2114# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_NANQ)
2115# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
2116# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
2117# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
2118# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
2119# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
2120# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
2121# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
2122# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
2123# else
2124# undef Perl_fp_class /* Unknown set of defines */
2125# endif
758a5d79 2126# endif
30404d48
JH
2127#endif
2128
2129/* Win32: _fpclass(), _isnan(), _finite(). */
796ea9ea
JH
2130#ifdef WIN32
2131# ifndef Perl_isnan
2132# define Perl_isnan(x) _isnan(x)
2133# endif
2134# ifndef Perl_isfinite
2135# define Perl_isfinite(x) _finite(x)
2136# endif
2137# ifndef Perl_fp_class_snan
25c46df8
JH
2138/* No simple way to #define Perl_fp_class because _fpclass()
2139 * returns a set of bits. */
796ea9ea
JH
2140# define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2141# define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
82947af8 2142# define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
796ea9ea
JH
2143# define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF))
2144# define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF))
2145# define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2146# define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2147# define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2148# define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2149# define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2150# define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2151# define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2152# define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2153# define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2154# define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2155# endif
f279e099
JH
2156#endif
2157
2158#if !defined(Perl_fp_class_inf) && \
2159 defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2160# define Perl_fp_class_inf(x) \
2161 (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2162#endif
2163
2164#if !defined(Perl_fp_class_nan) && \
2165 defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2166# define Perl_fp_class_nan(x) \
2167 (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2168#endif
2169
2170#if !defined(Perl_fp_class_zero) && \
2171 defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2172# define Perl_fp_class_zero(x) \
2173 (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2174#endif
2175
2176#if !defined(Perl_fp_class_norm) && \
2177 defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2178# define Perl_fp_class_norm(x) \
2179 (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2180#endif
2181
2182#if !defined(Perl_fp_class_denorm) && \
2183 defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2184# define Perl_fp_class_denorm(x) \
2185 (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
796ea9ea 2186#endif
758a5d79 2187
1a322af2
JH
2188#ifdef UNDER_CE
2189int isnan(double d);
2190#endif
2191
758a5d79 2192#ifndef Perl_isnan
1a322af2
JH
2193# ifdef Perl_fp_class_nan
2194# define Perl_isnan(x) Perl_fp_class_nan(x)
da5fdda8
AC
2195# elif defined(HAS_UNORDERED)
2196# define Perl_isnan(x) unordered((x), 0.0)
758a5d79 2197# else
da5fdda8 2198# define Perl_isnan(x) ((x)!=(x))
758a5d79
JH
2199# endif
2200#endif
2201
1a322af2
JH
2202#ifndef Perl_isinf
2203# ifdef Perl_fp_class_inf
2204# define Perl_isinf(x) Perl_fp_class_inf(x)
2205# endif
ca6c63e1
JH
2206#endif
2207
758a5d79 2208#ifndef Perl_isfinite
25c46df8 2209# if defined(HAS_ISFINITE) && !defined(isfinite)
c496ca58 2210# define Perl_isfinite(x) isfinite((double)(x))
4efd38a4 2211# elif defined(HAS_FINITE)
c496ca58 2212# define Perl_isfinite(x) finite((double)(x))
4efd38a4
JH
2213# elif defined(Perl_fp_class_finite)
2214# define Perl_isfinite(x) Perl_fp_class_finite(x)
758a5d79 2215# else
c496ca58
JH
2216/* For the infinities the multiplication returns nan,
2217 * for the nan the multiplication also returns nan,
2218 * for everything else (that is, finite) zero should be returned. */
4efd38a4 2219# define Perl_isfinite(x) (((x) * 0) == 0)
a3540c92 2220# endif
65202027
DS
2221#endif
2222
25c46df8
JH
2223#ifndef Perl_isinf
2224# if defined(Perl_isfinite) && defined(Perl_isnan)
2225# define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2226# endif
2227#endif
2228
d3685250
JH
2229/* We need Perl_isfinitel (ends with ell) (if available) even when
2230 * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2231 * needs that. */
2232#if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2233/* If isfinite() is a macro and looks like we have C99,
2234 * we assume it's the type-aware C99 isfinite(). */
c06e9e3e 2235# if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
d3685250
JH
2236# define Perl_isfinitel(x) isfinite(x)
2237# elif defined(HAS_ISFINITEL)
2238# define Perl_isfinitel(x) isfinitel(x)
2239# elif defined(HAS_FINITEL)
2240# define Perl_isfinitel(x) finitel(x)
2241# elif defined(HAS_INFL) && defined(HAS_NANL)
2242# define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
16334e6e 2243# else
99bf9e32 2244# define Perl_isfinitel(x) ((x) * 0 == 0) /* See Perl_isfinite. */
d3685250
JH
2245# endif
2246#endif
2247
a36244b7
JH
2248/* The default is to use Perl's own atof() implementation (in numeric.c).
2249 * Usually that is the one to use but for some platforms (e.g. UNICOS)
2250 * it is however best to use the native implementation of atof.
2251 * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2252 * Some good tests to try out with either setting are t/base/num.t,
205f51d8
AS
2253 * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2254 * you may need to be using a different function than atof! */
a36244b7
JH
2255
2256#ifndef USE_PERL_ATOF
2257# ifndef _UNICOS
2258# define USE_PERL_ATOF
2259# endif
2260#else
2261# if USE_PERL_ATOF == 0
2262# undef USE_PERL_ATOF
2263# endif
2264#endif
2265
2266#ifdef USE_PERL_ATOF
2267# define Perl_atof(s) Perl_my_atof(s)
2268# define Perl_atof2(s, n) Perl_my_atof2(aTHX_ (s), &(n))
2269#else
2270# define Perl_atof(s) (NV)atof(s)
2271# define Perl_atof2(s, n) ((n) = atof(s))
2272#endif
cf2093f6 2273
99abf803 2274/*
2275 * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2276 * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2277 * depending on local options. Until Configure detects this (or at least
2278 * detects whether the "signed" keyword is available) the CHAR ranges
2279 * will not be included. UCHAR functions normally.
2280 * - kja
2281 */
27d4fb96 2282
6ec488b3
AC
2283#define PERL_UCHAR_MIN ((unsigned char)0)
2284#define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
27d4fb96 2285
6ec488b3
AC
2286#define PERL_USHORT_MIN ((unsigned short)0)
2287#define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
27d4fb96 2288
6ec488b3
AC
2289#define PERL_SHORT_MAX ((short)SHRT_MAX)
2290#define PERL_SHORT_MIN ((short)SHRT_MIN)
27d4fb96 2291
6ec488b3 2292#define PERL_UINT_MAX ((unsigned int)UINT_MAX)
99abf803 2293#define PERL_UINT_MIN ((unsigned int)0)
27d4fb96 2294
6ec488b3
AC
2295#define PERL_INT_MAX ((int)INT_MAX)
2296#define PERL_INT_MIN ((int)INT_MIN)
27d4fb96 2297
6ec488b3 2298#define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
99abf803 2299#define PERL_ULONG_MIN ((unsigned long)0L)
27d4fb96 2300
6ec488b3
AC
2301#define PERL_LONG_MAX ((long)LONG_MAX)
2302#define PERL_LONG_MIN ((long)LONG_MIN)
760ac839 2303
d7d93a81 2304#ifdef UV_IS_QUAD
99abf803 2305# define PERL_UQUAD_MAX (~(UV)0)
f1c3b19a 2306# define PERL_UQUAD_MIN ((UV)0)
99abf803 2307# define PERL_QUAD_MAX ((IV) (PERL_UQUAD_MAX >> 1))
a6e633de 2308# define PERL_QUAD_MIN (-PERL_QUAD_MAX - ((3 & -1) == 3))
79072805
LW
2309#endif
2310
ee0007ab 2311typedef MEM_SIZE STRLEN;
450a55e4 2312
79072805
LW
2313typedef struct op OP;
2314typedef struct cop COP;
2315typedef struct unop UNOP;
2f7c6295 2316typedef struct unop_aux UNOP_AUX;
79072805
LW
2317typedef struct binop BINOP;
2318typedef struct listop LISTOP;
2319typedef struct logop LOGOP;
79072805
LW
2320typedef struct pmop PMOP;
2321typedef struct svop SVOP;
7934575e 2322typedef struct padop PADOP;
79072805 2323typedef struct pvop PVOP;
79072805 2324typedef struct loop LOOP;
b46e009d 2325typedef struct methop METHOP;
79072805 2326
7aef8e5b 2327#ifdef PERL_CORE
8be227ab
FC
2328typedef struct opslab OPSLAB;
2329typedef struct opslot OPSLOT;
2330#endif
2331
52db365a 2332typedef struct block_hooks BHK;
1830b3d9 2333typedef struct custom_op XOP;
52db365a 2334
cd1541b2
NC
2335typedef struct interpreter PerlInterpreter;
2336
d2b3f365 2337/* SGI's <sys/sema.h> has struct sv */
cc3315ba 2338#if defined(__sgi)
d2b3f365 2339# define STRUCT_SV perl_sv
b8d3c5db
JH
2340#else
2341# define STRUCT_SV sv
2342#endif
2343typedef struct STRUCT_SV SV;
79072805
LW
2344typedef struct av AV;
2345typedef struct hv HV;
2346typedef struct cv CV;
d2f13c59 2347typedef struct p5rx REGEXP;
79072805 2348typedef struct gp GP;
0c30d9ec 2349typedef struct gv GV;
8990e307 2350typedef struct io IO;
c09156bb 2351typedef struct context PERL_CONTEXT;
79072805
LW
2352typedef struct block BLOCK;
2353
2354typedef struct magic MAGIC;
2355typedef struct xpv XPV;
2356typedef struct xpviv XPVIV;
ff68c719 2357typedef struct xpvuv XPVUV;
79072805
LW
2358typedef struct xpvnv XPVNV;
2359typedef struct xpvmg XPVMG;
2360typedef struct xpvlv XPVLV;
d361b004 2361typedef struct xpvinvlist XINVLIST;
79072805
LW
2362typedef struct xpvav XPVAV;
2363typedef struct xpvhv XPVHV;
2364typedef struct xpvgv XPVGV;
2365typedef struct xpvcv XPVCV;
2366typedef struct xpvbm XPVBM;
2367typedef struct xpvfm XPVFM;
8990e307 2368typedef struct xpvio XPVIO;
79072805
LW
2369typedef struct mgvtbl MGVTBL;
2370typedef union any ANY;
5f7fde29
GS
2371typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2372typedef struct ptr_tbl PTR_TBL_t;
8cf8f3d1
NIS
2373typedef struct clone_params CLONE_PARAMS;
2374
0f94cb1f 2375/* a pad is currently just an AV; but that might change,
7261499d
FC
2376 * so hide the type. */
2377typedef struct padlist PADLIST;
67634234 2378typedef AV PAD;
9b7476d7 2379typedef struct padnamelist PADNAMELIST;
0f94cb1f 2380typedef struct padname PADNAME;
67634234 2381
5d32d268
DM
2382/* enable PERL_OP_PARENT by default */
2383#if !defined(PERL_OP_PARENT) && !defined(PERL_NO_OP_PARENT)
2384# define PERL_OP_PARENT
2385#endif
2386
93c10d60
FC
2387/* enable PERL_COPY_ON_WRITE by default */
2388#if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2389# define PERL_COPY_ON_WRITE
13b0f67d 2390#endif
07d01d6e 2391
93c10d60 2392#ifdef PERL_COPY_ON_WRITE
db2c6cb3 2393# define PERL_ANY_COW
9f351b45
DM
2394#else
2395# define PERL_SAWAMPERSAND
db2c6cb3
FC
2396#endif
2397
40653c20
FC
2398#if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2399# error PERL_DEBUG_READONLY_OPS only works with ithreads
2400#endif
2401
378cc40b 2402#include "handy.h"
64935bc6 2403#include "charclass_invlists.h"
a0d0e21e 2404
6b8eaf93 2405#if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
6b8eaf93
JH
2406# if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2407# define USE_64_BIT_RAWIO /* implicit */
2408# endif
4564133c
JH
2409#endif
2410
6b8eaf93
JH
2411/* Notice the use of HAS_FSEEKO: now we are obligated to always use
2412 * fseeko/ftello if possible. Don't go #defining ftell to ftello yourself,
2413 * however, because operating systems like to do that themself. */
2414#ifndef FSEEKSIZE
2415# ifdef HAS_FSEEKO
2416# define FSEEKSIZE LSEEKSIZE
2417# else
2418# define FSEEKSIZE LONGSIZE
d460ef45 2419# endif
6b8eaf93
JH
2420#endif
2421
2422#if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
6b8eaf93
JH
2423# if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2424# define USE_64_BIT_STDIO /* implicit */
2425# endif
2426#endif
4564133c 2427
09458382 2428#ifdef USE_64_BIT_RAWIO
d9b3e12d
JH
2429# ifdef HAS_OFF64_T
2430# undef Off_t
2431# define Off_t off64_t
2432# undef LSEEKSIZE
2433# define LSEEKSIZE 8
5ff3f7a4 2434# endif
d9b3e12d
JH
2435/* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2436 * will trigger defines like the ones below. Some 64-bit environments,
09458382 2437 * however, do not. Therefore we have to explicitly mix and match. */
d9b3e12d
JH
2438# if defined(USE_OPEN64)
2439# define open open64
5ff3f7a4 2440# endif
d9b3e12d
JH
2441# if defined(USE_LSEEK64)
2442# define lseek lseek64
6b8eaf93
JH
2443# else
2444# if defined(USE_LLSEEK)
2445# define lseek llseek
2446# endif
d9b3e12d
JH
2447# endif
2448# if defined(USE_STAT64)
2449# define stat stat64
2450# endif
2451# if defined(USE_FSTAT64)
2452# define fstat fstat64
2453# endif
2454# if defined(USE_LSTAT64)
2455# define lstat lstat64
2456# endif
2457# if defined(USE_FLOCK64)
2458# define flock flock64
2459# endif
2460# if defined(USE_LOCKF64)
2461# define lockf lockf64
2462# endif
2463# if defined(USE_FCNTL64)
2464# define fcntl fcntl64
2465# endif
2466# if defined(USE_TRUNCATE64)
2467# define truncate truncate64
2468# endif
2469# if defined(USE_FTRUNCATE64)
2470# define ftruncate ftruncate64
2471# endif
2472#endif
2473
2474#ifdef USE_64_BIT_STDIO
2475# ifdef HAS_FPOS64_T
2476# undef Fpos_t
2477# define Fpos_t fpos64_t
2478# endif
2479/* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2480 * will trigger defines like the ones below. Some 64-bit environments,
2481 * however, do not. */
2482# if defined(USE_FOPEN64)
2483# define fopen fopen64
2484# endif
2485# if defined(USE_FSEEK64)
6b8eaf93 2486# define fseek fseek64 /* don't do fseeko here, see perlio.c */
d9b3e12d
JH
2487# endif
2488# if defined(USE_FTELL64)
6b8eaf93 2489# define ftell ftell64 /* don't do ftello here, see perlio.c */
d9b3e12d
JH
2490# endif
2491# if defined(USE_FSETPOS64)
2492# define fsetpos fsetpos64
2493# endif
2494# if defined(USE_FGETPOS64)
2495# define fgetpos fgetpos64
2496# endif
2497# if defined(USE_TMPFILE64)
2498# define tmpfile tmpfile64
2499# endif
2500# if defined(USE_FREOPEN64)
2501# define freopen freopen64
5ff3f7a4
GS
2502# endif
2503#endif
2504
e37778c2 2505#if defined(OS2)
2c2d71f5
JH
2506# include "iperlsys.h"
2507#endif
2508
748a9306 2509#ifdef DOSISH
19848b3f
JH
2510# if defined(OS2)
2511# include "os2ish.h"
2512# else
2513# include "dosish.h"
2514# endif
009819bb 2515#elif defined(VMS)
748a9306 2516# include "vmsish.h"
009819bb 2517#elif defined(PLAN9)
19848b3f 2518# include "./plan9/plan9ish.h"
009819bb 2519#elif defined(__VOS__)
196918b0
PG
2520# ifdef __GNUC__
2521# include "./vos/vosish.h"
2522# else
2523# include "vos/vosish.h"
2524# endif
009819bb 2525#elif defined(__SYMBIAN32__)
27da23d5 2526# include "symbian/symbianish.h"
009819bb 2527#elif defined(__HAIKU__)
df00ff3b 2528# include "haiku/haikuish.h"
009819bb 2529#else
19848b3f 2530# include "unixish.h"
13b6e58c
JH
2531#endif
2532
ea34f6bd 2533#ifdef __amigaos4__
3c0208ad
AB
2534# include "amigaos.h"
2535# undef FD_CLOEXEC /* a lie in AmigaOS */
2536#endif
2537
2946a158 2538/* NSIG logic from Configure --> */
2946a158
JH
2539#ifndef NSIG
2540# ifdef _NSIG
2541# define NSIG (_NSIG)
da5fdda8 2542# elif defined(SIGMAX)
2946a158 2543# define NSIG (SIGMAX+1)
da5fdda8 2544# elif defined(SIG_MAX)
2946a158 2545# define NSIG (SIG_MAX+1)
da5fdda8 2546# elif defined(_SIG_MAX)
2946a158 2547# define NSIG (_SIG_MAX+1)
da5fdda8 2548# elif defined(MAXSIG)
2946a158 2549# define NSIG (MAXSIG+1)
da5fdda8 2550# elif defined(MAX_SIG)
2946a158 2551# define NSIG (MAX_SIG+1)
da5fdda8 2552# elif defined(SIGARRAYSIZE)
2946a158 2553# define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
da5fdda8 2554# elif defined(_sys_nsig)
2946a158 2555# define NSIG (_sys_nsig) /* Solaris 2.5 */
da5fdda8
AC
2556# else
2557 /* Default to some arbitrary number that's big enough to get most
2558 * of the common signals. */
2946a158 2559# define NSIG 50
da5fdda8 2560# endif
2946a158
JH
2561#endif
2562/* <-- NSIG logic from Configure */
2563
13b6e58c
JH
2564#ifndef NO_ENVIRON_ARRAY
2565# define USE_ENVIRON_ARRAY
2566#endif
32f822de 2567
c77b533b
JH
2568/*
2569 * initialise to avoid floating-point exceptions from overflow, etc
2570 */
2571#ifndef PERL_FPU_INIT
2572# ifdef HAS_FPSETMASK
2573# if HAS_FLOATINGPOINT_H
2574# include <floatingpoint.h>
2575# endif
ad3a8c67
NC
2576/* Some operating systems have this as a macro, which in turn expands to a comma
2577 expression, and the last sub-expression is something that gets calculated,
2578 and then they have the gall to warn that a value computed is not used. Hence
2579 cast to void. */
2580# define PERL_FPU_INIT (void)fpsetmask(0)
da5fdda8
AC
2581# elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2582# define PERL_FPU_INIT PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2583# define PERL_FPU_PRE_EXEC { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2584# define PERL_FPU_POST_EXEC rsignal_restore(SIGFPE, &xfpe); }
c77b533b 2585# else
da5fdda8 2586# define PERL_FPU_INIT
c77b533b
JH
2587# endif
2588#endif
b35112e7
CS
2589#ifndef PERL_FPU_PRE_EXEC
2590# define PERL_FPU_PRE_EXEC {
2591# define PERL_FPU_POST_EXEC }
2592#endif
c77b533b 2593
a308b05a
JH
2594/* In Tru64 the cc -ieee enables the IEEE math but disables traps.
2595 * We need to reenable the "invalid" trap because otherwise generation
2596 * of NaN values leaves the IEEE fp flags in bad state, leaving any further
2597 * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
2598#ifdef __osf__
2599# include <machine/fpu.h>
2600# define PERL_SYS_FPU_INIT \
2601 STMT_START { \
2602 ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
2603 signal(SIGFPE, SIG_IGN); \
2604 } STMT_END
2605#endif
94a08944
JH
2606/* In IRIX the default for Flush to Zero bit is true,
2607 * which means that results going below the minimum of normal
2608 * floating points go to zero, instead of going denormal/subnormal.
2609 * This is unlike almost any other system running Perl, so let's clear it.
2610 * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
2611 * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
2612 *
2613 * XXX The flush-to-zero behaviour should be a Configure scan.
2614 * To change the behaviour usually requires some system-specific
2615 * incantation, though, like the below. */
2616#ifdef __sgi
2617# include <sys/fpu.h>
2618# define PERL_SYS_FPU_INIT \
2619 STMT_START { \
2620 union fpc_csr csr; \
2621 csr.fc_word = get_fpc_csr(); \
2622 csr.fc_struct.flush = 0; \
2623 set_fpc_csr(csr.fc_word); \
2624 } STMT_END
2625#endif
a308b05a
JH
2626
2627#ifndef PERL_SYS_FPU_INIT
2628# define PERL_SYS_FPU_INIT NOOP
2629#endif
2630
cbec8ebe
DM
2631#ifndef PERL_SYS_INIT3_BODY
2632# define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
ed344e4f
IZ
2633#endif
2634
eb533572 2635/*
dcccc8ff
KW
2636=head1 Miscellaneous Functions
2637
4ad9e498 2638=for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
eb533572 2639Provides system-specific tune up of the C runtime environment necessary to
72d33970 2640run Perl interpreters. This should be called only once, before creating
eb533572
DM
2641any Perl interpreters.
2642
4ad9e498 2643=for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
eb533572 2644Provides system-specific tune up of the C runtime environment necessary to
72d33970 2645run Perl interpreters. This should be called only once, before creating
eb533572
DM
2646any Perl interpreters.
2647
2648=for apidoc Am|void|PERL_SYS_TERM|
2649Provides system-specific clean up of the C runtime environment after
72d33970 2650running Perl interpreters. This should be called only once, after
eb533572
DM
2651freeing any remaining Perl interpreters.
2652
2653=cut
2654 */
2655
cbec8ebe
DM
2656#define PERL_SYS_INIT(argc, argv) Perl_sys_init(argc, argv)
2657#define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
d0820ef1 2658#define PERL_SYS_TERM() Perl_sys_term()
cbec8ebe 2659
be708cc0
JH
2660#ifndef PERL_WRITE_MSG_TO_CONSOLE
2661# define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
2662#endif
2663
0f31cffe
GS
2664#ifndef MAXPATHLEN
2665# ifdef PATH_MAX
b990c8b2
JH
2666# ifdef _POSIX_PATH_MAX
2667# if PATH_MAX > _POSIX_PATH_MAX
09448d78
JH
2668/* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
2669 * included the null byte or not. Later amendments of POSIX,
2670 * XPG4, the Austin Group, and the Single UNIX Specification
2671 * all explicitly include the null byte in the PATH_MAX.
2672 * Ditto for _POSIX_PATH_MAX. */
2673# define MAXPATHLEN PATH_MAX
b990c8b2 2674# else
09448d78 2675# define MAXPATHLEN _POSIX_PATH_MAX
b990c8b2
JH
2676# endif
2677# else
2678# define MAXPATHLEN (PATH_MAX+1)
2679# endif
0f31cffe 2680# else
d552bce8 2681# define MAXPATHLEN 1024 /* Err on the large side. */
0f31cffe
GS
2682# endif
2683#endif
2684
c80263a8
SH
2685/* In case Configure was not used (we are using a "canned config"
2686 * such as Win32, or a cross-compilation setup, for example) try going
2687 * by the gcc major and minor versions. One useful URL is
2688 * http://www.ohse.de/uwe/articles/gcc-attributes.html,
2689 * but contrary to this information warn_unused_result seems
2690 * not to be in gcc 3.3.5, at least. --jhi
42bf5550
AD
2691 * Also, when building extensions with an installed perl, this allows
2692 * the user to upgrade gcc and get the right attributes, rather than
2693 * relying on the list generated at Configure time. --AD
c80263a8
SH
2694 * Set these up now otherwise we get confused when some of the <*thread.h>
2695 * includes below indirectly pull in <perlio.h> (which needs to know if we
2696 * have HASATTRIBUTE_FORMAT).
2697 */
2698
4d7c7898 2699#ifndef PERL_MICRO
fc2007d4 2700#if defined __GNUC__ && !defined(__INTEL_COMPILER)
6a387721
RGS
2701# if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
2702# define HASATTRIBUTE_DEPRECATED
2703# endif
c80263a8
SH
2704# if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
2705# define HASATTRIBUTE_FORMAT
63cdf24b
SH
2706# if defined __MINGW32__
2707# define PRINTF_FORMAT_NULL_OK
2708# endif
c80263a8
SH
2709# endif
2710# if __GNUC__ >= 3 /* 3.0 -> */
2711# define HASATTRIBUTE_MALLOC
2712# endif
2713# if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
2714# define HASATTRIBUTE_NONNULL
2715# endif
2716# if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
2717# define HASATTRIBUTE_NORETURN
2718# endif
2719# if __GNUC__ >= 3 /* gcc 3.0 -> */
2720# define HASATTRIBUTE_PURE
2721# endif
42bf5550 2722# if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
c80263a8
SH
2723# define HASATTRIBUTE_UNUSED
2724# endif
d324fe49
AD
2725# if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
2726# define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
2727# endif
c80263a8
SH
2728# if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2729# define HASATTRIBUTE_WARN_UNUSED_RESULT
2730# endif
2731#endif
00f254e2 2732#endif /* #ifndef PERL_MICRO */
c80263a8 2733
3db8f154 2734/* USE_5005THREADS needs to be after unixish.h as <pthread.h> includes
dd96f567 2735 * <sys/signal.h> which defines NSIG - which will stop inclusion of <signal.h>
32f822de
GS
2736 * this results in many functions being undeclared which bothers C++
2737 * May make sense to have threads after "*ish.h" anyway
2738 */
2739
3baee7cc
JH
2740/* clang Thread Safety Analysis/Annotations/Attributes
2741 * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
2742 *
bdc795f4 2743 * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
3baee7cc 2744 * Apple XCode hijacks __clang_major__ and __clang_minor__
bdc795f4
JH
2745 * (6.1 means really clang 3.6), so needs extra hijinks
2746 * (could probably also test the contents of __apple_build_version__).
3baee7cc
JH
2747 */
2748#if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
2749 defined(__clang__) && \
ab0fe36e
DM
2750 !defined(PERL_GLOBAL_STRUCT) && \
2751 !defined(PERL_GLOBAL_STRUCT_PRIVATE) && \
3baee7cc
JH
2752 !defined(SWIG) && \
2753 ((!defined(__apple_build_version__) && \
bdc795f4 2754 ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
8412ccf9 2755 (__clang_major__ >= 4))) || \
3baee7cc 2756 (defined(__apple_build_version__) && \
bdc795f4
JH
2757 ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
2758 (__clang_major__ >= 7))))
3baee7cc
JH
2759# define PERL_TSA__(x) __attribute__((x))
2760# define PERL_TSA_ACTIVE
2761#else
2762# define PERL_TSA__(x) /* No TSA, make TSA attributes no-ops. */
2763# undef PERL_TSA_ACTIVE
2764#endif
2765
2766/* PERL_TSA_CAPABILITY() is used to annotate typedefs.
2767 * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
2768 */
2769#define PERL_TSA_CAPABILITY(x) \
2770 PERL_TSA__(capability(x))
2771
2772/* In the below examples the mutex must be lexically visible, usually
2773 * either as global variables, or as function arguments. */
2774
2775/* PERL_TSA_GUARDED_BY() is used to annotate global variables.
2776 *
2777 * Foo foo PERL_TSA_GUARDED_BY(mutex);
2778 */
2779#define PERL_TSA_GUARDED_BY(x) \
2780 PERL_TSA__(guarded_by(x))
2781
2782/* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
2783 * The data _behind_ the pointer is guarded.
2784 *
2785 * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
2786 */
2787#define PERL_TSA_PT_GUARDED_BY(x) \
2788 PERL_TSA__(pt_guarded_by(x))
2789
2790/* PERL_TSA_REQUIRES() is used to annotate functions.
2791 * The caller MUST hold the resource when calling the function.
2792 *
2793 * void Foo() PERL_TSA_REQUIRES(mutex);
2794 */
2795#define PERL_TSA_REQUIRES(x) \
2796 PERL_TSA__(requires_capability(x))
2797
2798/* PERL_TSA_EXCLUDES() is used to annotate functions.
2799 * The caller MUST NOT hold resource when calling the function.
2800 *
2801 * EXCLUDES should be used when the function first acquires
2802 * the resource and then releases it. Use to avoid deadlock.
2803 *
2804 * void Foo() PERL_TSA_EXCLUDES(mutex);
2805 */
2806#define PERL_TSA_EXCLUDES(x) \
2807 PERL_TSA__(locks_excluded(x))
2808
2809/* PERL_TSA_ACQUIRE() is used to annotate functions.
2810 * The caller MUST NOT hold the resource when calling the function,
2811 * and the function will acquire the resource.
2812 *
2813 * void Foo() PERL_TSA_ACQUIRE(mutex);
2814 */
2815#define PERL_TSA_ACQUIRE(x) \
2816 PERL_TSA__(acquire_capability(x))
2817
2818/* PERL_TSA_RELEASE() is used to annotate functions.
2819 * The caller MUST hold the resource when calling the function,
2820 * and the function will release the resource.
2821 *
2822 * void Foo() PERL_TSA_RELEASE(mutex);
2823 */
2824#define PERL_TSA_RELEASE(x) \
2825 PERL_TSA__(release_capability(x))
2826
2827/* PERL_TSA_NO_TSA is used to annotate functions.
2828 * Used when being intentionally unsafe, or when the code is too
2829 * complicated for the analysis. Use sparingly.
2830 *
2831 * void Foo() PERL_TSA_NO_TSA;
2832 */
2833#define PERL_TSA_NO_TSA \
2834 PERL_TSA__(no_thread_safety_analysis)
2835
2836/* There are more annotations/attributes available, see the clang
2837 * documentation for details. */
2838
3db8f154 2839#if defined(USE_ITHREADS)
2986a63f 2840# ifdef NETWARE
da5fdda8
AC
2841# include <nw5thread.h>
2842# elif defined(WIN32)
2843# include <win32thread.h>
2844# elif defined(OS2)
2845# include "os2thread.h"
2846# elif defined(I_MACH_CTHREADS)
2847# include <mach/cthreads.h>
7f3d1cf1
BH
2848typedef cthread_t perl_os_thread;
2849typedef mutex_t perl_mutex;
2850typedef condition_t perl_cond;
2851typedef void * perl_key;
da5fdda8
AC
2852# elif defined(I_PTHREAD) /* Posix threads */
2853# include <pthread.h>
7f3d1cf1 2854typedef pthread_t perl_os_thread;
3baee7cc 2855typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
7f3d1cf1
BH
2856typedef pthread_cond_t perl_cond;
2857typedef pthread_key_t perl_key;
da5fdda8 2858# endif
3db8f154 2859#endif /* USE_ITHREADS */
c5be433b 2860
3baee7cc
JH
2861#ifdef PERL_TSA_ACTIVE
2862/* Since most pthread mutex interfaces have not been annotated, we
2863 * need to have these wrappers. The NO_TSA annotation is quite ugly
2864 * but it cannot be avoided in plain C, unlike in C++, where one could
2865 * e.g. use ACQUIRE() with no arg on a mutex lock method.
2866 *
2867 * The bodies of these wrappers are in util.c
2868 *
2869 * TODO: however, some platforms are starting to get these clang
2870 * thread safety annotations for pthreads, for example FreeBSD.
2871 * Do we need a way to a bypass these wrappers? */
67083b7b 2872EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
3baee7cc
JH
2873 PERL_TSA_ACQUIRE(*mutex)
2874 PERL_TSA_NO_TSA;
67083b7b 2875EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
3baee7cc
JH
2876 PERL_TSA_RELEASE(*mutex)
2877 PERL_TSA_NO_TSA;
2878#endif
2879
66a93824 2880#if defined(WIN32)
1feb2720 2881# include "win32.h"
c5be433b
GS
2882#endif
2883
2986a63f
JH
2884#ifdef NETWARE
2885# include "netware.h"
2886#endif
2887
e5218da5 2888#define STATUS_UNIX PL_statusvalue
68dc0745 2889#ifdef VMS
6b88bc9c 2890# define STATUS_NATIVE PL_statusvalue_vms
7a7fd8e0
JM
2891/*
2892 * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
ff7298cb 2893 * its contents can not be trusted. Unfortunately, Perl seems to check
7a7fd8e0
JM
2894 * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
2895 * be updated also.
2896 */
2897# include <stsdef.h>
2898# include <ssdef.h>
2899/* Presume this because if VMS changes it, it will require a new
2900 * set of APIs for waiting on children for binary compatibility.
2901 */
2902# define child_offset_bits (8)
2903# ifndef C_FAC_POSIX
2904# define C_FAC_POSIX 0x35A000
2905# endif
2906
2907/* STATUS_EXIT - validates and returns a NATIVE exit status code for the
2908 * platform from the existing UNIX or Native status values.
2909 */
2910
37038d91 2911# define STATUS_EXIT \
7a7fd8e0
JM
2912 (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
2913 (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
2914
7a7fd8e0 2915
fb38d079
JM
2916/* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
2917 * exit code and shifts the UNIX value over the correct number of bits to
2918 * be a child status. Usually the number of bits is 8, but that could be
2919 * platform dependent. The NATIVE status code is presumed to have either
2920 * from a child process.
7a7fd8e0
JM
2921 */
2922
fb38d079
JM
2923/* This is complicated. The child processes return a true native VMS
2924 status which must be saved. But there is an assumption in Perl that
2925 the UNIX child status has some relationship to errno values, so
00f254e2 2926 Perl tries to translate it to text in some of the tests.
fb38d079
JM
2927 In order to get the string translation correct, for the error, errno
2928 must be EVMSERR, but that generates a different text message
2929 than what the test programs are expecting. So an errno value must
2930 be derived from the native status value when an error occurs.
2931 That will hide the true native status message. With this version of
2932 perl, the true native child status can always be retrieved so that
2933 is not a problem. But in this case, Pl_statusvalue and errno may
2934 have different values in them.
2935 */
7a7fd8e0 2936
fb38d079 2937# define STATUS_NATIVE_CHILD_SET(n) \
68dc0745 2938 STMT_START { \
2fbb330f
JM
2939 I32 evalue = (I32)n; \
2940 if (evalue == EVMSERR) { \
2941 PL_statusvalue_vms = vaxc$errno; \
2942 PL_statusvalue = evalue; \
7a7fd8e0 2943 } else { \
2fbb330f 2944 PL_statusvalue_vms = evalue; \
fb38d079 2945 if (evalue == -1) { \
3280af22 2946 PL_statusvalue = -1; \
7a7fd8e0
JM
2947 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
2948 } else \
fb38d079 2949 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1); \
2fbb330f 2950 set_vaxc_errno(evalue); \
fb38d079
JM
2951 if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX) \
2952 set_errno(EVMSERR); \
2953 else set_errno(Perl_vms_status_to_unix(evalue, 0)); \
2954 PL_statusvalue = PL_statusvalue << child_offset_bits; \
2fbb330f 2955 } \
68dc0745 2956 } STMT_END
7a7fd8e0 2957
68dc0745 2958# ifdef VMSISH_STATUS
e5218da5 2959# define STATUS_CURRENT (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
68dc0745 2960# else
e5218da5 2961# define STATUS_CURRENT STATUS_UNIX
68dc0745 2962# endif
7a7fd8e0
JM
2963
2964 /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
2965 * the NATIVE status to an equivalent value. Can not be used to translate
2966 * exit code values as exit code values are not guaranteed to have any
2967 * relationship at all to errno values.
2968 * This is used when Perl is forcing errno to have a specific value.
2969 */
e5218da5 2970# define STATUS_UNIX_SET(n) \
68dc0745 2971 STMT_START { \
7a7fd8e0 2972 I32 evalue = (I32)n; \
0968cdad 2973 PL_statusvalue = evalue; \
3280af22 2974 if (PL_statusvalue != -1) { \
0968cdad
JM
2975 if (PL_statusvalue != EVMSERR) { \
2976 PL_statusvalue &= 0xFFFF; \
2977 if (MY_POSIX_EXIT) \
2978 PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
2979 else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
2980 } \
2981 else { \
2982 PL_statusvalue_vms = vaxc$errno; \
2983 } \
68dc0745 2984 } \
0968cdad
JM
2985 else PL_statusvalue_vms = SS$_ABORT; \
2986 set_vaxc_errno(PL_statusvalue_vms); \
7a7fd8e0
JM
2987 } STMT_END
2988
2989 /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
e08e1e1d
JM
2990 * the NATIVE error status based on it.
2991 *
2992 * When in the default mode to comply with the Perl VMS documentation,
2993 * 0 is a success and any other code sets the NATIVE status to a failure
2994 * code of SS$_ABORT.
fb38d079
JM
2995 *
2996 * In the new POSIX EXIT mode, native status will be set so that the
2997 * actual exit code will can be retrieved by the calling program or
2998 * shell.
2999 *
3000 * If the exit code is not clearly a UNIX parent or child exit status,
3001 * it will be passed through as a VMS status.
7a7fd8e0
JM
3002 */
3003
fb38d079 3004# define STATUS_UNIX_EXIT_SET(n) \
7a7fd8e0
JM
3005 STMT_START { \
3006 I32 evalue = (I32)n; \
3007 PL_statusvalue = evalue; \
e08e1e1d
JM
3008 if (MY_POSIX_EXIT) { \
3009 if (evalue <= 0xFF00) { \
3010 if (evalue > 0xFF) \
3011 evalue = (evalue >> child_offset_bits) & 0xFF; \
3012 PL_statusvalue_vms = \
3013 (C_FAC_POSIX | (evalue << 3 ) | \
3014 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3015 } else /* forgive them Perl, for they have sinned */ \
3016 PL_statusvalue_vms = evalue; \
3017 } else { \
3018 if (evalue == 0) \
3019 PL_statusvalue_vms = SS$_NORMAL; \
3020 else if (evalue <= 0xFF00) \
3021 PL_statusvalue_vms = SS$_ABORT; \
3022 else { /* forgive them Perl, for they have sinned */ \
3023 if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3024 else PL_statusvalue_vms = vaxc$errno; \
3025 /* And obviously used a VMS status value instead of UNIX */ \
3026 PL_statusvalue = EVMSERR; \
3027 } \
3028 set_vaxc_errno(PL_statusvalue_vms); \
3029 } \
68dc0745 3030 } STMT_END
fb38d079 3031
e08e1e1d 3032
6ac6a52b
JM
3033 /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3034 * and sets the NATIVE error status based on it. This special case
3035 * is needed to maintain compatibility with past VMS behavior.
3036 *
3037 * In the default mode on VMS, this number is passed through as
3038 * both the NATIVE and UNIX status. Which makes it different
3039 * that the STATUS_UNIX_EXIT_SET.
3040 *
3041 * In the new POSIX EXIT mode, native status will be set so that the
3042 * actual exit code will can be retrieved by the calling program or
3043 * shell.
3044 *
1a3aec58
JM
3045 * A POSIX exit code is from 0 to 255. If the exit code is higher
3046 * than this, it needs to be assumed that it is a VMS exit code and
3047 * passed through.
6ac6a52b
JM
3048 */
3049
3050# define STATUS_EXIT_SET(n) \
3051 STMT_START { \
3052 I32 evalue = (I32)n; \
3053 PL_statusvalue = evalue; \
3054 if (MY_POSIX_EXIT) \
1a3aec58
JM
3055 if (evalue > 255) PL_statusvalue_vms = evalue; else { \
3056 PL_statusvalue_vms = \
3057 (C_FAC_POSIX | (evalue << 3 ) | \
3058 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
6ac6a52b
JM
3059 else \
3060 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3061 set_vaxc_errno(PL_statusvalue_vms); \
3062 } STMT_END
3063
fb38d079
JM
3064
3065 /* This macro forces a success status */
7a7fd8e0
JM
3066# define STATUS_ALL_SUCCESS \
3067 (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
fb38d079
JM
3068
3069 /* This macro forces a failure status */
7a7fd8e0
JM
3070# define STATUS_ALL_FAILURE (PL_statusvalue = 1, \
3071 vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3072 (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
fb38d079 3073
738ab09f
AB
3074#elif defined(__amigaos4__)
3075 /* A somewhat experimental attempt to simulate posix return code values */
3076# define STATUS_NATIVE PL_statusvalue_posix
3077# define STATUS_NATIVE_CHILD_SET(n) \
3078 STMT_START { \
3079 PL_statusvalue_posix = (n); \
3080 if (PL_statusvalue_posix < 0) { \
3081 PL_statusvalue = -1; \
3082 } \
3083 else { \
3084 PL_statusvalue = n << 8; \
3085 } \
3086 } STMT_END
3087# define STATUS_UNIX_SET(n) \
3088 STMT_START { \
3089 PL_statusvalue = (n); \
3090 if (PL_statusvalue != -1) \
3091 PL_statusvalue &= 0xFFFF; \
3092 } STMT_END
3093# define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3094# define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3095# define STATUS_CURRENT STATUS_UNIX
3096# define STATUS_EXIT STATUS_UNIX
3097# define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3098# define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3099
68dc0745 3100#else
e5218da5 3101# define STATUS_NATIVE PL_statusvalue_posix
e5218da5 3102# if defined(WCOREDUMP)
37038d91 3103# define STATUS_NATIVE_CHILD_SET(n) \
e5218da5
GA
3104 STMT_START { \
3105 PL_statusvalue_posix = (n); \
3106 if (PL_statusvalue_posix == -1) \
3107 PL_statusvalue = -1; \
3108 else { \
3109 PL_statusvalue = \
3110 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
3111 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3112 (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0); \
3113 } \
3114 } STMT_END
3115# elif defined(WIFEXITED)
37038d91 3116# define STATUS_NATIVE_CHILD_SET(n) \
e5218da5
GA
3117 STMT_START { \
3118 PL_statusvalue_posix = (n); \
3119 if (PL_statusvalue_posix == -1) \
3120 PL_statusvalue = -1; \
3121 else { \
3122 PL_statusvalue = \
3123 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
3124 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0); \
3125 } \
3126 } STMT_END
3127# else
37038d91 3128# define STATUS_NATIVE_CHILD_SET(n) \
e5218da5
GA
3129 STMT_START { \
3130 PL_statusvalue_posix = (n); \
3131 if (PL_statusvalue_posix == -1) \
3132 PL_statusvalue = -1; \
3133 else { \
3134 PL_statusvalue = \
3135 PL_statusvalue_posix & 0xFFFF; \
3136 } \
3137 } STMT_END
3138# endif
3139# define STATUS_UNIX_SET(n) \
68dc0745 3140 STMT_START { \
3280af22
NIS
3141 PL_statusvalue = (n); \
3142 if (PL_statusvalue != -1) \
3143 PL_statusvalue &= 0xFFFF; \
68dc0745 3144 } STMT_END
7a7fd8e0 3145# define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
6ac6a52b 3146# define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
e5218da5 3147# define STATUS_CURRENT STATUS_UNIX
37038d91 3148# define STATUS_EXIT STATUS_UNIX
e5218da5
GA
3149# define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3150# define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
68dc0745 3151#endif
3152
cc3604b1
GS
3153/* flags in PL_exit_flags for nature of exit() */
3154#define PERL_EXIT_EXPECTED 0x01
31d77e54 3155#define PERL_EXIT_DESTRUCT_END 0x02 /* Run END in perl_destruct */
6136213b
JGM
3156#define PERL_EXIT_WARN 0x04 /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3157#define PERL_EXIT_ABORT 0x08 /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
cc3604b1 3158
b79b76e0 3159#ifndef PERL_CORE
a7cb1f99 3160/* format to use for version numbers in file/directory names */
273cf8d1 3161/* XXX move to Configure? */
b79b76e0
NC
3162/* This was only ever used for the current version, and that can be done at
3163 compile time, as PERL_FS_VERSION, so should we just delete it? */
3164# ifndef PERL_FS_VER_FMT
3165# define PERL_FS_VER_FMT "%d.%d.%d"
3166# endif
3167#endif
3168
3169#ifndef PERL_FS_VERSION
3170# define PERL_FS_VERSION PERL_VERSION_STRING
0b94c7bb
GS
3171#endif
3172
45bc9206 3173/* This defines a way to flush all output buffers. This may be a
76549fef
JH
3174 * performance issue, so we allow people to disable it. Also, if
3175 * we are using stdio, there are broken implementations of fflush(NULL)
3176 * out there, Solaris being the most prominent.
45bc9206
GS
3177 */
3178#ifndef PERL_FLUSHALL_FOR_CHILD
97cb92d6 3179# if defined(USE_PERLIO) || defined(FFLUSH_NULL)
66fe083f 3180# define PERL_FLUSHALL_FOR_CHILD PerlIO_flush((PerlIO*)NULL)
da5fdda8
AC
3181# elif defined(FFLUSH_ALL)
3182# define PERL_FLUSHALL_FOR_CHILD my_fflush_all()
767df6a1 3183# else
da5fdda8 3184# define PERL_FLUSHALL_FOR_CHILD NOOP
66fe083f 3185# endif
45bc9206
GS
3186#endif
3187
7766f137
GS
3188#ifndef PERL_WAIT_FOR_CHILDREN
3189# define PERL_WAIT_FOR_CHILDREN NOOP
3190#endif
3191
ba869deb 3192/* the traditional thread-unsafe notion of "current interpreter". */
c5be433b
GS
3193#ifndef PERL_SET_INTERP
3194# define PERL_SET_INTERP(i) (PL_curinterp = (PerlInterpreter*)(i))
3195#endif
3196
3197#ifndef PERL_GET_INTERP
3198# define PERL_GET_INTERP (PL_curinterp)
3199#endif
3200
54aff467 3201#if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
54aff467 3202# ifdef MULTIPLICITY
ba869deb 3203# define PERL_GET_THX ((PerlInterpreter *)PERL_GET_CONTEXT)
54aff467 3204# endif
ba869deb
GS
3205# define PERL_SET_THX(t) PERL_SET_CONTEXT(t)
3206#endif
3207
00f254e2 3208/*
8896765a 3209 This replaces the previous %_ "hack" by the "%p" hacks.
0dbb1585 3210 All that is required is that the perl source does not
00f254e2
KW
3211 use "%-p" or "%-<number>p" or "%<number>p" formats.
3212 These formats will still work in perl code.
486ec47a 3213 See comments in sv.c for further details.
8896765a 3214
8896765a 3215 Robin Barker 2005-07-14
f46d31f2 3216
00f254e2 3217 No longer use %1p for VDf = %vd. RMB 2007-10-19
0dbb1585 3218*/
8896765a
RB
3219
3220#ifndef SVf_
63ce7bf0 3221# define SVf_(n) "-" STRINGIFY(n) "p"
894356b3
GS
3222#endif
3223
8896765a 3224#ifndef SVf
104abab4 3225# define SVf "-p"
d2560b70
RB
3226#endif
3227
014ead4b 3228#ifndef SVf32
8896765a 3229# define SVf32 SVf_(32)
014ead4b
RB
3230#endif
3231
3232#ifndef SVf256
8896765a
RB
3233# define SVf256 SVf_(256)
3234#endif
3235
be2597df
MHM
3236#define SVfARG(p) ((void*)(p))
3237
20023040
FC
3238#ifndef HEKf
3239# define HEKf "2p"
3240#endif
3241
b8fa5213
FC
3242/* Not ideal, but we cannot easily include a number in an already-numeric
3243 * format sequence. */
3244#ifndef HEKf256
3245# define HEKf256 "3p"
3246#endif
3247
20023040
FC
3248#define HEKfARG(p) ((void*)(p))
3249
b17a0679
FC
3250/* Takes three arguments: is_utf8, length, str */
3251#ifndef UTF8f
61608bb7 3252# define UTF8f "d%" UVuf "%4p"
b17a0679
FC
3253#endif
3254#define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3255
0f94cb1f
FC
3256#define PNf UTF8f
3257#define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
0d1e9135 3258
f46d31f2 3259#ifdef PERL_CORE
486ec47a 3260/* not used; but needed for backward compatibility with XS code? - RMB */
7776bb98 3261# undef UVf
da5fdda8
AC
3262#elif !defined(UVf)
3263# define UVf UVuf
d2560b70
RB
3264#endif
3265
fcdf39cf
RGS
3266#ifdef HASATTRIBUTE_DEPRECATED
3267# define __attribute__deprecated__ __attribute__((deprecated))
3268#endif
0dbb1585
AL
3269#ifdef HASATTRIBUTE_FORMAT
3270# define __attribute__format__(x,y,z) __attribute__((format(x,y,z)))
3271#endif
3272#ifdef HASATTRIBUTE_MALLOC
77785eea 3273# define __attribute__malloc__ __attribute__((__malloc__))
f22be1b8 3274#endif
0dbb1585 3275#ifdef HASATTRIBUTE_NONNULL
abb2c242 3276# define __attribute__nonnull__(a) __attribute__((nonnull(a)))
f22be1b8 3277#endif
0dbb1585 3278#ifdef HASATTRIBUTE_NORETURN
abb2c242 3279# define __attribute__noreturn__ __attribute__((noreturn))
f22be1b8 3280#endif
0dbb1585 3281#ifdef HASATTRIBUTE_PURE
abb2c242 3282# define __attribute__pure__ __attribute__((pure))
f22be1b8 3283#endif
0dbb1585
AL
3284#ifdef HASATTRIBUTE_UNUSED
3285# define __attribute__unused__ __attribute__((unused))
3286#endif
3287#ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
abb2c242 3288# define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
f22be1b8
JH
3289#endif
3290
0dbb1585 3291/* If we haven't defined the attributes yet, define them to blank. */
fcdf39cf
RGS
3292#ifndef __attribute__deprecated__
3293# define __attribute__deprecated__
3294#endif
0dbb1585
AL
3295#ifndef __attribute__format__
3296# define __attribute__format__(x,y,z)
3297#endif
f22be1b8 3298#ifndef __attribute__malloc__
abb2c242 3299# define __attribute__malloc__
f22be1b8
JH
3300#endif
3301#ifndef __attribute__nonnull__
abb2c242 3302# define __attribute__nonnull__(a)
f22be1b8
JH
3303#endif
3304#ifndef __attribute__noreturn__
abb2c242 3305# define __attribute__noreturn__
f22be1b8
JH
3306#endif
3307#ifndef __attribute__pure__
abb2c242 3308# define __attribute__pure__
f22be1b8 3309#endif
0dbb1585
AL
3310#ifndef __attribute__unused__
3311# define __attribute__unused__
3312#endif
f22be1b8 3313#ifndef __attribute__warn_unused_result__
abb2c242
JH
3314# define __attribute__warn_unused_result__
3315#endif
3316
6ff2ec7d
AC
3317#if !defined(DEBUGGING) && !defined(NDEBUG)
3318# define NDEBUG 1
cd13e623 3319#endif
6ff2ec7d 3320#include <assert.h>
cd13e623 3321
0dbb1585
AL
3322/* For functions that are marked as __attribute__noreturn__, it's not
3323 appropriate to call return. In either case, include the lint directive.
3324 */
3325#ifdef HASATTRIBUTE_NORETURN
bc3d2941 3326# define NORETURN_FUNCTION_END NOT_REACHED;
0dbb1585 3327#else
bc3d2941 3328# define NORETURN_FUNCTION_END NOT_REACHED; return 0
abb2c242
JH
3329#endif
3330
cdfeb707
RB
3331/* Some OS warn on NULL format to printf */
3332#ifdef PRINTF_FORMAT_NULL_OK
3333# define __attribute__format__null_ok__(x,y,z) __attribute__format__(x,y,z)
3334#else
00f254e2 3335# define __attribute__format__null_ok__(x,y,z)
cdfeb707
RB
3336#endif
3337
635aebb7 3338#ifdef HAS_BUILTIN_EXPECT
b37c2d43
AL
3339# define EXPECT(expr,val) __builtin_expect(expr,val)
3340#else
3341# define EXPECT(expr,val) (expr)
3342#endif
6d5abc62
NC
3343#define LIKELY(cond) EXPECT(cBOOL(cond),TRUE)
3344#define UNLIKELY(cond) EXPECT(cBOOL(cond),FALSE)
635aebb7
AL
3345#ifdef HAS_BUILTIN_CHOOSE_EXPR
3346/* placeholder */
3347#endif
b37c2d43 3348
a36ca6de 3349/* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
5074d4c5
LM
3350 time invariants. That is, their argument must be a constant expression that
3351 can be verified by the compiler. This expression can contain anything that's
3352 known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3353 the expression evaluates to 0, compilation fails.
3354 Because they generate no runtime code (i.e. their use is "free"), they're
3355 always active, even under non-DEBUGGING builds.
a36ca6de 3356 STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
5074d4c5
LM
3357 file scope (outside of any function).
3358 STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3359 function.
3360*/
7ea096df 3361#if (defined(static_assert) || (defined(__cplusplus) && __cplusplus >= 201103L)) && (!defined(__IBMC__) || __IBMC__ >= 1210)
6d59e610 3362/* static_assert is a macro defined in <assert.h> in C11 or a compiler
a36ca6de
LM
3363 builtin in C++11. But IBM XL C V11 does not support _Static_assert, no
3364 matter what <assert.h> says.
6d59e610 3365*/
a36ca6de 3366# define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
6d59e610
LM
3367#else
3368/* We use a bit-field instead of an array because gcc accepts
3369 'typedef char x[n]' where n is not a compile-time constant.
3370 We want to enforce constantness.
3371*/
3372# define STATIC_ASSERT_2(COND, SUFFIX) \
3373 typedef struct { \
3374 unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3375 } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3376# define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
a36ca6de 3377# define STATIC_ASSERT_DECL(COND) STATIC_ASSERT_1(COND, __LINE__)
6d59e610
LM
3378#endif
3379/* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3380 error (static_assert is a declaration, and only statements can have labels).
3381*/
21aae866 3382#define STATIC_ASSERT_STMT(COND) STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
ae103e09
DD
3383
3384#ifndef __has_builtin
3385# define __has_builtin(x) 0 /* not a clang style compiler */
3386#endif
3387
3388/* ASSUME is like assert(), but it has a benefit in a release build. It is a
3389 hint to a compiler about a statement of fact in a function call free
3390 expression, which allows the compiler to generate better machine code.
3391 In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3392 the control path is unreachable. In a for loop, ASSUME can be used to hint
b8fda935 3393 that a loop will run at least X times. ASSUME is based off MSVC's __assume
ae103e09
DD
3394 intrinsic function, see its documents for more details.
3395*/
3396
3397#ifndef DEBUGGING
3398# if __has_builtin(__builtin_unreachable) \
d1020b40 3399 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4) /* 4.5 -> */
ae103e09
DD
3400# define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3401# elif defined(_MSC_VER)
3402# define ASSUME(x) __assume(x)
3403# elif defined(__ARMCC_VERSION) /* untested */
3404# define ASSUME(x) __promise(x)
3405# else
3406/* a random compiler might define assert to its own special optimization token
3407 so pass it through to C lib as a last resort */
3408# define ASSUME(x) assert(x)
3409# endif
3410#else
3411# define ASSUME(x) assert(x)
3412#endif
3413
dbc47c6f
KW
3414#if defined(__sun) /* ASSUME() generates warnings on Solaris */
3415# define NOT_REACHED
2145f4b6
LM
3416#elif defined(DEBUGGING) && (__has_builtin(__builtin_unreachable) \
3417 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4)) /* 4.5 -> */
3418# define NOT_REACHED STMT_START { ASSUME(0); __builtin_unreachable(); } STMT_END
dbc47c6f
KW
3419#else
3420# define NOT_REACHED ASSUME(0)
3421#endif
ae103e09 3422
3fc1aec6 3423/* Some unistd.h's give a prototype for pause() even though
3424 HAS_PAUSE ends up undefined. This causes the #define
d2560b70 3425 below to be rejected by the compiler. Sigh.
3fc1aec6 3426*/
3427#ifdef HAS_PAUSE
3428#define Pause pause
3429#else
3430#define Pause() sleep((32767<<16)+32767)
748a9306
LW
3431#endif
3432
3433#ifndef IOCPARM_LEN
3434# ifdef IOCPARM_MASK
61f1c44b 3435 /* on BSDish systems we're safe */
748a9306 3436# define IOCPARM_LEN(x) (((x) >> 16) & IOCPARM_MASK)
da5fdda8 3437# elif defined(_IOC_SIZE) && defined(__GLIBC__)
301eb2f0 3438 /* on Linux systems we're safe; except when we're not [perl #38223] */
da5fdda8
AC
3439# define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3440# else
748a9306 3441 /* otherwise guess at what's safe */
da5fdda8 3442# define IOCPARM_LEN(x) 256
748a9306 3443# endif
a0d0e21e
LW
3444#endif
3445
1761cee5 3446#if defined(__CYGWIN__)
521e0776
GS
3447/* USEMYBINMODE
3448 * This symbol, if defined, indicates that the program should
16fe6d59 3449 * use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
521e0776
GS
3450 * that a file is in "binary" mode -- that is, that no translation
3451 * of bytes occurs on read or write operations.
3452 */
36894f0b 3453# define USEMYBINMODE /**/
77a40698 3454# include <io.h> /* for setmode() prototype */
16fe6d59 3455# define my_binmode(fp, iotype, mode) \
8298454c 3456 cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
5aabfad6 3457#endif
3458
88d10794
JH
3459#ifdef __CYGWIN__
3460void init_os_extras(void);
3461#endif
3462
cea2e8a9
GS
3463#ifdef UNION_ANY_DEFINITION
3464UNION_ANY_DEFINITION;
3465#else
3466union any {
3467 void* any_ptr;
c9728782
DM
3468 SV* any_sv;
3469 SV** any_svp;
3470 GV* any_gv;
3471 AV* any_av;
3472 HV* any_hv;
6ffb8402 3473 OP* any_op;
c9728782
DM
3474 char* any_pv;
3475 char** any_pvp;
cea2e8a9 3476 I32 any_i32;
ae103e09 3477 U32 any_u32;
cea2e8a9 3478 IV any_iv;
c6bf6a65 3479 UV any_uv;
cea2e8a9 3480 long any_long;
9febdf04 3481 bool any_bool;
c76ac1ee 3482 void (*any_dptr) (void*);
acfe0abc 3483 void (*any_dxptr) (pTHX_ void*);
cea2e8a9
GS
3484};
3485#endif
3486
acfe0abc 3487typedef I32 (*filter_t) (pTHX_ int, SV *, int);
cea2e8a9
GS
3488
3489#define FILTER_READ(idx, sv, len) filter_read(idx, sv, len)
5486870f
DM
3490#define FILTER_DATA(idx) \
3491 (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3492#define FILTER_ISREADER(idx) \
3493 (PL_parser && PL_parser->rsfp_filters \
3494 && idx >= AvFILLp(PL_parser->rsfp_filters))
3495#define PERL_FILTER_EXISTS(i) \
3496 (PL_parser && PL_parser->rsfp_filters \
b9f2b683 3497 && (i) <= av_tindex(PL_parser->rsfp_filters))
cea2e8a9 3498
c5078cac
JH
3499#if defined(_AIX) && !defined(_AIX43)
3500#if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3501/* We cannot include <crypt.h> to get the struct crypt_data
3502 * because of setkey prototype problems when threading */
3503typedef struct crypt_data { /* straight from /usr/include/crypt.h */
3504 /* From OSF, Not needed in AIX
3505 char C[28], D[28];
3506 */
3507 char E[48];
3508 char KS[16][48];
3509 char block[66];
3510 char iobuf[16];
3511} CRYPTD;
3512#endif /* threading */
3513#endif /* AIX */
3514
fc6bde6f
DD
3515#ifndef PERL_CALLCONV
3516# ifdef __cplusplus
3517# define PERL_CALLCONV extern "C"
3518# else
3519# define PERL_CALLCONV
3520# endif
3521#endif
3522#ifndef PERL_CALLCONV_NO_RET
3523# define PERL_CALLCONV_NO_RET PERL_CALLCONV
3524#endif
3525
3526/* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
3527 dont have a noreturn as a declaration specifier
3528*/
3529#ifndef PERL_STATIC_NO_RET
3530# define PERL_STATIC_NO_RET STATIC
3531#endif
3532/* PERL_STATIC_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE on
3533 builds that dont have a noreturn as a declaration specifier
3534*/
3535#ifndef PERL_STATIC_INLINE_NO_RET
3536# define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
3537#endif
3538
e37778c2 3539#if !defined(OS2)
2c2d71f5
JH
3540# include "iperlsys.h"
3541#endif
504f80c1 3542
9c12f1e5 3543#ifdef __LIBCATAMOUNT__
00f254e2 3544#undef HAS_PASSWD /* unixish.h but not unixish enough. */
9c12f1e5
RGS
3545#undef HAS_GROUP
3546#define FAKE_BIT_BUCKET
3547#endif
3548
d10dc2ae 3549/* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
1a237f4f
YO
3550 * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
3551 * Configure, despite their names being similar to other defines like
3552 * USE_ITHREADS. Configure in fact knows nothing about the randomised
3553 * hashes. Therefore to enable/disable the hash randomisation defines
3554 * use the Configure -Accflags=... instead. */
3555#if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
4546b9e6 3556# define USE_HASH_SEED
504f80c1
JH
3557#endif
3558
598921a7
NC
3559#include "perly.h"
3560
598921a7 3561
654eccd5
JD
3562/* macros to define bit-fields in structs. */
3563#ifndef PERL_BITFIELD8
3564# define PERL_BITFIELD8 unsigned
3565#endif
3566#ifndef PERL_BITFIELD16
3567# define PERL_BITFIELD16 unsigned
3568#endif
3569#ifndef PERL_BITFIELD32
3570# define PERL_BITFIELD32 unsigned
3571#endif
3572
79072805 3573#include "sv.h"
288b8c02 3574#include "regexp.h"
378cc40b 3575#include "util.h"
8d063cd8 3576#include "form.h"
79072805 3577#include "gv.h"
dd2155a4 3578#include "pad.h"
79072805 3579#include "cv.h"
abdd5c84 3580#include "opnames.h"
79072805 3581#include "op.h"
b3ca2e83 3582#include "hv.h"
79072805
LW
3583#include "cop.h"
3584#include "av.h"
79072805
LW
3585#include "mg.h"
3586#include "scope.h"
4438c4b7 3587#include "warnings.h"
a0ed51b3 3588#include "utf8.h"
8d063cd8 3589
0d7d409d
DM
3590/* these would be in doio.h if there was such a file */
3591#define my_stat() my_stat_flags(SV_GMAGIC)
3592#define my_lstat() my_lstat_flags(SV_GMAGIC)
3593
20f4945e 3594/* defined in sv.c, but also used in [ach]v.c */
20f4945e
MHM
3595#undef _XPV_HEAD
3596#undef _XPVMG_HEAD
3597#undef _XPVCV_COMMON
7fae4e64 3598
199e78b7
DM
3599#include "parser.h"
3600
455ece5e 3601typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
76e3520e 3602
2260ab51
KW
3603#if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3604
3605/* These have to be predeclared, as they are used in proto.h which is #included
3606 * before their definitions in regcomp.h. */
3607
3608struct scan_data_t;
7dcac5f6
KW
3609typedef struct regnode_charclass regnode_charclass;
3610
2260ab51 3611struct regnode_charclass_class;
d1d040e5
KW
3612
3613/* A hopefully less confusing name. The sub-classes are all Posix classes only
3614 * used under /l matching */
3615typedef struct regnode_charclass_class regnode_charclass_posixl;
3616
b8f7bb16 3617typedef struct regnode_ssc regnode_ssc;
09b2b2e6
KW
3618typedef struct RExC_state_t RExC_state_t;
3619struct _reg_trie_data;
76e3520e 3620
2260ab51
KW
3621#endif
3622
5f7fde29
GS
3623struct ptr_tbl_ent {
3624 struct ptr_tbl_ent* next;
53c1dcc0 3625 const void* oldval;
5f7fde29 3626 void* newval;
d18c6117
GS
3627};
3628
5f7fde29
GS
3629struct ptr_tbl {
3630 struct ptr_tbl_ent** tbl_ary;
3631 UV tbl_max;
3632 UV tbl_items;
db93c0c4
NC
3633 struct ptr_tbl_arena *tbl_arena;
3634 struct ptr_tbl_ent *tbl_arena_next;
3635 struct ptr_tbl_ent *tbl_arena_end;
d18c6117
GS
3636};
3637
fe14fcc3
LW
3638#if defined(htonl) && !defined(HAS_HTONL)
3639#define HAS_HTONL
ae986130 3640#endif
fe14fcc3
LW
3641#if defined(htons) && !defined(HAS_HTONS)
3642#define HAS_HTONS
ae986130 3643#endif
fe14fcc3
LW
3644#if defined(ntohl) && !defined(HAS_NTOHL)
3645#define HAS_NTOHL
ae986130 3646#endif
fe14fcc3
LW
3647#if defined(ntohs) && !defined(HAS_NTOHS)
3648#define HAS_NTOHS
ae986130 3649#endif
fe14fcc3 3650#ifndef HAS_HTONL
fe14fcc3
LW
3651#define HAS_HTONS
3652#define HAS_HTONL
3653#define HAS_NTOHS
3654#define HAS_NTOHL
8e2d7c44
NC
3655# if (BYTEORDER & 0xffff) == 0x4321
3656/* Big endian system, so ntohl, ntohs, htonl and htons do not need to
3657 re-order their values. However, to behave identically to the alternative
3658 implementations, they should truncate to the correct size. */
3659# define ntohl(x) ((x)&0xFFFFFFFF)
3660# define htonl(x) ntohl(x)
3661# define ntohs(x) ((x)&0xFFFF)
3662# define htons(x) ntohs(x)
e4b03fed
NC
3663# elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3664
3665/* Note that we can't straight out declare our own htonl and htons because
3666 the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
3667 to avoid the overhead of initialising the socket subsystem, but the headers
3668 that *declare* the various functions are still seen. If we declare our own
3669 htonl etc they will clash with the declarations in the Win32 headers. */
3670
3671PERL_STATIC_INLINE U32
3672my_swap32(const U32 x) {
3673 return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)
3674 | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
3675}
3676
3677PERL_STATIC_INLINE U16
3678my_swap16(const U16 x) {
3679 return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
3680}
3681
3682# define htonl(x) my_swap32(x)
3683# define ntohl(x) my_swap32(x)
3684# define ntohs(x) my_swap16(x)
3685# define htons(x) my_swap16(x)
8e2d7c44 3686# else
691a44df
NC
3687# error "Unsupported byteorder"
3688/* The C pre-processor doesn't let us return the value of BYTEORDER as part of
3689 the error message. Please check the value of the macro BYTEORDER, as defined
3690 in config.h. The values of BYTEORDER we expect are
3691
3692 big endian little endian
3693 32 bit 0x4321 0x1234
3694 64 bit 0x87654321 0x12345678
3695
3696 If you have a system with a different byte order, please see
3697 pod/perlhack.pod for how to submit a patch to add supporting code.
3698*/
3699# endif
a687059c
LW
3700#endif
3701
988174c1
LW
3702/*
3703 * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
3704 * -DWS
3705 */
5ae72479 3706#if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
260c6fee
NC
3707/* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
3708 re-order their values. However, to behave identically to the alternative
3709 implementations, they should truncate to the correct size. */
3710# define vtohl(x) ((x)&0xFFFFFFFF)
3711# define vtohs(x) ((x)&0xFFFF)
3712# define htovl(x) vtohl(x)
3713# define htovs(x) vtohs(x)
545872c5 3714#elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
988174c1
LW
3715# define vtohl(x) ((((x)&0xFF)<<24) \
3716 +(((x)>>24)&0xFF) \
3717 +(((x)&0x0000FF00)<<8) \
3718 +(((x)&0x00FF0000)>>8) )
3719# define vtohs(x) ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
3720# define htovl(x) vtohl(x)
3721# define htovs(x) vtohs(x)
545872c5
NC
3722#else
3723# error "Unsupported byteorder"
3724/* If you have need for current perl on PDP-11 or similar, and can help test
3725 that blead keeps working on a mixed-endian system, then see
3726 pod/perlhack.pod for how to submit patches to things working again. */
2a8c3029 3727#endif
988174c1 3728
3bb7c1b4
JH
3729/* *MAX Plus 1. A floating point value.
3730 Hopefully expressed in a way that dodgy floating point can't mess up.
3731 >> 2 rather than 1, so that value is safely less than I32_MAX after 1
3732 is added to it
3733 May find that some broken compiler will want the value cast to I32.
3734 [after the shift, as signed >> may not be as secure as unsigned >>]
3735*/
3736#define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
3737#define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
3738/* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
3739 0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
3740 may be greater than sizeof(IV), so don't assume that half max UV is max IV.
3741*/
3742#define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
ee0007ab 3743
3bb7c1b4
JH
3744#define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
3745#define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
3746#define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
3747
3748/* This may look like unnecessary jumping through hoops, but converting
3749 out of range floating point values to integers *is* undefined behaviour,
3750 and it is starting to bite.
3751*/
3752#ifndef CAST_INLINE
65202027 3753#define I_32(what) (cast_i32((NV)(what)))
3bb7c1b4 3754#define U_32(what) (cast_ulong((NV)(what)))
65202027
DS
3755#define I_V(what) (cast_iv((NV)(what)))
3756#define U_V(what) (cast_uv((NV)(what)))
3bb7c1b4
JH
3757#else
3758#define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
3759 : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
3760 : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
3761#define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
3762 : ((n) < U32_MAX_P1 ? (U32) (n) \
3763 : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
5d9574c1
DM
3764#define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
3765 : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
3bb7c1b4 3766 : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
5d9574c1
DM
3767#define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
3768 : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
3bb7c1b4
JH
3769 : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
3770#endif
3771
3772#define U_S(what) ((U16)U_32(what))
3773#define U_I(what) ((unsigned int)U_32(what))
3774#define U_L(what) U_32(what)
ed6116ce 3775
ed140128
AD
3776#ifdef HAS_SIGNBIT
3777# define Perl_signbit signbit
3778#endif
3779
2d4389e4
JH
3780/* These do not care about the fractional part, only about the range. */
3781#define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
24db6c0d 3782#define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
2d4389e4 3783
25da4f38
IZ
3784/* Used with UV/IV arguments: */
3785 /* XXXX: need to speed it up */
3786#define CLUMP_2UV(iv) ((iv) < 0 ? 0 : (UV)(iv))
3787#define CLUMP_2IV(uv) ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
3788
352d5a3a
LW
3789#ifndef MAXSYSFD
3790# define MAXSYSFD 2
3791#endif
ee0007ab 3792
79072805 3793#ifndef __cplusplus
e37d7e38 3794#if !(defined(WIN32) || defined(UNDER_CE) || defined(SYMBIAN))
20ce7b12
GS
3795Uid_t getuid (void);
3796Uid_t geteuid (void);
3797Gid_t getgid (void);
3798Gid_t getegid (void);
79072805 3799#endif
e1caacb4 3800#endif
8d063cd8 3801
0c30d9ec 3802#ifndef Perl_debug_log
bf49b057
GS
3803# define Perl_debug_log PerlIO_stderr()
3804#endif
3805
3806#ifndef Perl_error_log
3807# define Perl_error_log (PL_stderrgv \
6b78add2 3808 && isGV(PL_stderrgv) \
01bb7c6d 3809 && GvIOp(PL_stderrgv) \
42de951c 3810 && IoOFP(GvIOp(PL_stderrgv)) \
bf49b057
GS
3811 ? IoOFP(GvIOp(PL_stderrgv)) \
3812 : PerlIO_stderr())
0c30d9ec 3813#endif
3967c732 3814
aea4f609
DM
3815
3816#define DEBUG_p_FLAG 0x00000001 /* 1 */
3817#define DEBUG_s_FLAG 0x00000002 /* 2 */
3818#define DEBUG_l_FLAG 0x00000004 /* 4 */
3819#define DEBUG_t_FLAG 0x00000008 /* 8 */
3820#define DEBUG_o_FLAG 0x00000010 /* 16 */
3821#define DEBUG_c_FLAG 0x00000020 /* 32 */
3822#define DEBUG_P_FLAG 0x00000040 /* 64 */
3823#define DEBUG_m_FLAG 0x00000080 /* 128 */
3824#define DEBUG_f_FLAG 0x00000100 /* 256 */
3825#define DEBUG_r_FLAG 0x00000200 /* 512 */
3826#define DEBUG_x_FLAG 0x00000400 /* 1024 */
3827#define DEBUG_u_FLAG 0x00000800 /* 2048 */
88d2d28a
JC
3828/* U is reserved for Unofficial, exploratory hacking */
3829#define DEBUG_U_FLAG 0x00001000 /* 4096 */
fcd573e7 3830/* spare 8192 */
aea4f609
DM
3831#define DEBUG_X_FLAG 0x00004000 /* 16384 */
3832#define DEBUG_D_FLAG 0x00008000 /* 32768 */
56967202 3833#define DEBUG_S_FLAG 0x00010000 /* 65536 */
aea4f609 3834#define DEBUG_T_FLAG 0x00020000 /* 131072 */
04932ac8 3835#define DEBUG_R_FLAG 0x00040000 /* 262144 */
1045810a 3836#define DEBUG_J_FLAG 0x00080000 /* 524288 */
d6721266 3837#define DEBUG_v_FLAG 0x00100000 /*1048576 */
46187eeb 3838#define DEBUG_C_FLAG 0x00200000 /*2097152 */
ecae49c0 3839#define DEBUG_A_FLAG 0x00400000 /*4194304 */
a3c98653 3840#define DEBUG_q_FLAG 0x00800000 /*8388608 */
cc8773c0
CS
3841#define DEBUG_M_FLAG 0x01000000 /*16777216*/
3842#define DEBUG_B_FLAG 0x02000000 /*33554432*/
69014004 3843#define DEBUG_L_FLAG 0x04000000 /*67108864*/
e17bc05a
TC
3844#define DEBUG_i_FLAG 0x08000000 /*134217728*/
3845#define DEBUG_MASK 0x0FFFEFFF /* mask of all the standard flags */
aea4f609
DM
3846
3847#define DEBUG_DB_RECURSE_FLAG 0x40000000
31ada1fb 3848#define DEBUG_TOP_FLAG 0x80000000 /* -D was given --> PL_debug |= FLAG */
aea4f609 3849
36195052
KW
3850# define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
3851# define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
3852# define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
3853# define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
3854# define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
3855# define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
3856# define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
3857# define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
3858# define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
3859# define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
3860# define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
3861# define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
3862# define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
36195052
KW
3863# define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
3864# define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
3865# define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
3866# define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
3867# define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
3868# define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
3869# define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
3870# define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
3871# define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
3872# define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
3873# define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
3874# define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
3875# define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
3876# define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
dd2155a4 3877# define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
7949c6f5 3878# define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
ad9e76a8 3879# define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
bbc98134 3880# define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
bd16a5f0 3881
3967c732 3882#ifdef DEBUGGING
aea4f609 3883
bd16a5f0
IZ
3884# define DEBUG_p_TEST DEBUG_p_TEST_
3885# define DEBUG_s_TEST DEBUG_s_TEST_
3886# define DEBUG_l_TEST DEBUG_l_TEST_
3887# define DEBUG_t_TEST DEBUG_t_TEST_
3888# define DEBUG_o_TEST DEBUG_o_TEST_
3889# define DEBUG_c_TEST DEBUG_c_TEST_
3890# define DEBUG_P_TEST DEBUG_P_TEST_
3891# define DEBUG_m_TEST DEBUG_m_TEST_
3892# define DEBUG_f_TEST DEBUG_f_TEST_
3893# define DEBUG_r_TEST DEBUG_r_TEST_
3894# define DEBUG_x_TEST DEBUG_x_TEST_
3895# define DEBUG_u_TEST DEBUG_u_TEST_
88d2d28a 3896# define DEBUG_U_TEST DEBUG_U_TEST_
bd16a5f0
IZ
3897# define DEBUG_X_TEST DEBUG_X_TEST_
3898# define DEBUG_D_TEST DEBUG_D_TEST_
56967202 3899# define DEBUG_S_TEST DEBUG_S_TEST_
bd16a5f0
IZ
3900# define DEBUG_T_TEST DEBUG_T_TEST_
3901# define DEBUG_R_TEST DEBUG_R_TEST_
1045810a 3902# define DEBUG_J_TEST DEBUG_J_TEST_
d6721266 3903# define DEBUG_v_TEST DEBUG_v_TEST_
46187eeb 3904# define DEBUG_C_TEST DEBUG_C_TEST_
ecae49c0 3905# define DEBUG_A_TEST DEBUG_A_TEST_
a3c98653 3906# define DEBUG_q_TEST DEBUG_q_TEST_
d7c0d282 3907# define DEBUG_M_TEST DEBUG_M_TEST_
cc8773c0 3908# define DEBUG_B_TEST DEBUG_B_TEST_
69014004 3909# define DEBUG_L_TEST DEBUG_L_TEST_
e17bc05a 3910# define DEBUG_i_TEST DEBUG_i_TEST_
7949c6f5
JC
3911# define DEBUG_Xv_TEST DEBUG_Xv_TEST_
3912# define DEBUG_Uv_TEST DEBUG_Uv_TEST_
ad9e76a8 3913# define DEBUG_Pv_TEST DEBUG_Pv_TEST_
bbc98134 3914# define DEBUG_Lv_TEST DEBUG_Lv_TEST_
aea4f609 3915
488b0c7a 3916# define PERL_DEB(a) a
11f9ab1a 3917# define PERL_DEB2(a,b) a
488b0c7a 3918# define PERL_DEBUG(a) if (PL_debug) a
aea4f609
DM
3919# define DEBUG_p(a) if (DEBUG_p_TEST) a
3920# define DEBUG_s(a) if (DEBUG_s_TEST) a
3921# define DEBUG_l(a) if (DEBUG_l_TEST) a
3922# define DEBUG_t(a) if (DEBUG_t_TEST) a
3923# define DEBUG_o(a) if (DEBUG_o_TEST) a
3924# define DEBUG_c(a) if (DEBUG_c_TEST) a
3925# define DEBUG_P(a) if (DEBUG_P_TEST) a
3926
969058bb
VK
3927 /* Temporarily turn off memory debugging in case the a
3928 * does memory allocation, either directly or indirectly. */
acfe0abc 3929# define DEBUG_m(a) \
f60d22a6
KW
3930 STMT_START { \
3931 if (PERL_GET_INTERP) { \
3932 dTHX; \
3933 if (DEBUG_m_TEST) { \
3934 PL_debug &= ~DEBUG_m_FLAG; \
3935 a; \
3936 PL_debug |= DEBUG_m_FLAG; \
3937 } \
3938 } \
0b250b9e 3939 } STMT_END
aea4f609 3940
f60d22a6
KW
3941# define DEBUG__(t, a) \
3942 STMT_START { \
3943 if (t) STMT_START {a;} STMT_END; \
3944 } STMT_END
5f80b19c
AMS
3945
3946# define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
f60d22a6 3947
f9f4320a 3948#ifndef PERL_EXT_RE_BUILD
5f80b19c 3949# define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
f9f4320a
YO
3950#else
3951# define DEBUG_r(a) STMT_START {a;} STMT_END
3952#endif /* PERL_EXT_RE_BUILD */
f60d22a6 3953
5f80b19c
AMS
3954# define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
3955# define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
88d2d28a 3956# define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
5f80b19c
AMS
3957# define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
3958# define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
7949c6f5
JC
3959# define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
3960# define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
ad9e76a8 3961# define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
bbc98134 3962# define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
aea4f609 3963
56967202 3964# define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
5f80b19c
AMS
3965# define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
3966# define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
d6721266 3967# define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
46187eeb 3968# define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
ecae49c0
NC
3969# define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
3970# define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
d7c0d282 3971# define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
cc8773c0 3972# define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
69014004 3973# define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
e17bc05a 3974# define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
aea4f609
DM
3975
3976#else /* DEBUGGING */
3977
3978# define DEBUG_p_TEST (0)
3979# define DEBUG_s_TEST (0)
3980# define DEBUG_l_TEST (0)
3981# define DEBUG_t_TEST (0)
3982# define DEBUG_o_TEST (0)
3983# define DEBUG_c_TEST (0)
3984# define DEBUG_P_TEST (0)
3985# define DEBUG_m_TEST (0)
3986# define DEBUG_f_TEST (0)
3987# define DEBUG_r_TEST (0)
3988# define DEBUG_x_TEST (0)
3989# define DEBUG_u_TEST (0)
88d2d28a 3990# define DEBUG_U_TEST (0)
aea4f609
DM
3991# define DEBUG_X_TEST (0)
3992# define DEBUG_D_TEST (0)
56967202 3993# define DEBUG_S_TEST (0)
aea4f609 3994# define DEBUG_T_TEST (0)
04932ac8 3995# define DEBUG_R_TEST (0)
1045810a 3996# define DEBUG_J_TEST (0)
d6721266 3997# define DEBUG_v_TEST (0)
46187eeb 3998# define DEBUG_C_TEST (0)
ecae49c0
NC
3999# define DEBUG_A_TEST (0)
4000# define DEBUG_q_TEST (0)
d7c0d282 4001# define DEBUG_M_TEST (0)
cc8773c0 4002# define DEBUG_B_TEST (0)
69014004 4003# define DEBUG_L_TEST (0)
e17bc05a 4004# define DEBUG_i_TEST (0)
7949c6f5
JC
4005# define DEBUG_Xv_TEST (0)
4006# define DEBUG_Uv_TEST (0)
ad9e76a8 4007# define DEBUG_Pv_TEST (0)
bbc98134 4008# define DEBUG_Lv_TEST (0)
aea4f609 4009
488b0c7a 4010# define PERL_DEB(a)
11f9ab1a 4011# define PERL_DEB2(a,b) b
488b0c7a 4012# define PERL_DEBUG(a)
aea4f609
DM
4013# define DEBUG_p(a)
4014# define DEBUG_s(a)
4015# define DEBUG_l(a)
4016# define DEBUG_t(a)
4017# define DEBUG_o(a)
4018# define DEBUG_c(a)
4019# define DEBUG_P(a)
4020# define DEBUG_m(a)
4021# define DEBUG_f(a)
4022# define DEBUG_r(a)
4023# define DEBUG_x(a)
4024# define DEBUG_u(a)
88d2d28a 4025# define DEBUG_U(a)
aea4f609
DM
4026# define DEBUG_X(a)
4027# define DEBUG_D(a)
56967202 4028# define DEBUG_S(a)
aea4f609 4029# define DEBUG_T(a)
04932ac8 4030# define DEBUG_R(a)
d6721266 4031# define DEBUG_v(a)
46187eeb 4032# define DEBUG_C(a)
ecae49c0
NC
4033# define DEBUG_A(a)
4034# define DEBUG_q(a)
d7c0d282 4035# define DEBUG_M(a)
cc8773c0 4036# define DEBUG_B(a)
69014004 4037# define DEBUG_L(a)
e17bc05a 4038# define DEBUG_i(a)
7949c6f5
JC
4039# define DEBUG_Xv(a)
4040# define DEBUG_Uv(a)
ad9e76a8 4041# define DEBUG_Pv(a)
bbc98134 4042# define DEBUG_Lv(a)
aea4f609
DM
4043#endif /* DEBUGGING */
4044
4045
b4ab917c 4046#define DEBUG_SCOPE(where) \
d9f81b50 4047 DEBUG_l( \
1c98cc53
DM
4048 Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n", \
4049 where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
d9f81b50 4050 __FILE__, __LINE__));
b4ab917c 4051
de84dc04 4052/* Keep the old croak based assert for those who want it, and as a fallback if
27ceb597 4053 the platform is so heretically non-ANSI that it can't assert. */
14befaf4 4054
11f9ab1a 4055#define Perl_assert(what) PERL_DEB2( \
2b057284 4056 ((what) ? ((void) 0) : \
67eb4d30 4057 (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
60b9f5a7 4058 "\", line %d", STRINGIFY(what), __LINE__), \
11f9ab1a 4059 (void) 0)), ((void)0))
de84dc04 4060
6ff2ec7d 4061/* assert() gets defined if DEBUGGING.
81d52ecd 4062 * If no DEBUGGING, the <assert.h> has not been included. */
de84dc04
NC
4063#ifndef assert
4064# define assert(what) Perl_assert(what)
a446a88f 4065#endif
c7724415
FC
4066#ifdef DEBUGGING
4067# define assert_(what) assert(what),
4068#else
4069# define assert_(what)
4070#endif
8d063cd8 4071
450a55e4 4072struct ufuncs {
24f81a43
DM
4073 I32 (*uf_val)(pTHX_ IV, SV*);
4074 I32 (*uf_set)(pTHX_ IV, SV*);
a0d0e21e 4075 IV uf_index;
450a55e4
LW
4076};
4077
14befaf4 4078/* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
24f81a43
DM
4079 * XS code wanting to be backward compatible can do something
4080 * like the following:
c745e42c 4081
24f81a43 4082#ifndef PERL_MG_UFUNC
24f81a43
DM
4083#define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4084#endif
4085
4086static PERL_MG_UFUNC(foo_get, index, val)
4087{
4088 sv_setsv(val, ...);
4089 return TRUE;
4090}
4091
4092-- Doug MacEachern
4093
4094*/
4095
fc9c74e6 4096#ifndef PERL_MG_UFUNC
24f81a43 4097#define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
fc9c74e6 4098#endif
24f81a43 4099
7e034659
AC
4100#include <math.h>
4101#ifdef __VMS
a80f53e7 4102 /* isfinite and others are here rather than in math.h as C99 stipulates */
7e034659 4103# include <fp.h>
79072805
LW
4104#endif
4105
a0d0e21e 4106#ifndef __cplusplus
f05550c0 4107# if !defined(WIN32) && !defined(VMS)
10bc17b6 4108#ifndef crypt
20ce7b12 4109char *crypt (const char*, const char*);
10bc17b6 4110#endif
f05550c0 4111# endif /* !WIN32 */
e37d7e38
SH
4112# ifndef WIN32
4113# ifndef getlogin
20ce7b12 4114char *getlogin (void);
e37d7e38
SH
4115# endif
4116# endif /* !WIN32 */
26618a56 4117#endif /* !__cplusplus */
79072805 4118
7a7fd8e0
JM
4119/* Fixme on VMS. This needs to be a run-time, not build time options */
4120/* Also rename() is affected by this */
16d20bd9 4121#ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
378cc40b 4122#define UNLINK unlnk
083639a9 4123I32 unlnk (pTHX_ const char*);
8d063cd8 4124#else
80252599 4125#define UNLINK PerlLIO_unlink
8d063cd8 4126#endif
a687059c 4127
fa0a29af
JH
4128/* some versions of glibc are missing the setresuid() proto */
4129#if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
640374d0
JH
4130int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4131#endif
fa0a29af
JH
4132/* some versions of glibc are missing the setresgid() proto */
4133#if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
640374d0
JH
4134int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4135#endif
4136
fe14fcc3 4137#ifndef HAS_SETREUID
85e6fe83
LW
4138# ifdef HAS_SETRESUID
4139# define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4140# define HAS_SETREUID
4141# endif
a687059c 4142#endif
fe14fcc3 4143#ifndef HAS_SETREGID
85e6fe83
LW
4144# ifdef HAS_SETRESGID
4145# define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4146# define HAS_SETREGID
4147# endif
a687059c 4148#endif
ee0007ab 4149
d543acb6 4150/* Sighandler_t defined in iperlsys.h */
ff68c719 4151
4152#ifdef HAS_SIGACTION
4153typedef struct sigaction Sigsave_t;
4154#else
4155typedef Sighandler_t Sigsave_t;
4156#endif
4157
ee0007ab
LW
4158#define SCAN_DEF 0
4159#define SCAN_TR 1
4160#define SCAN_REPL 2
79072805
LW
4161
4162#ifdef DEBUGGING
4633a7c4 4163# ifndef register
a0d0e21e
LW
4164# define register
4165# endif
cea2e8a9 4166# define RUNOPS_DEFAULT Perl_runops_debug
79072805 4167#else
cea2e8a9 4168# define RUNOPS_DEFAULT Perl_runops_standard
79072805
LW
4169#endif
4170
97cb92d6 4171#if defined(USE_PERLIO)
0934c9d9 4172EXTERN_C void PerlIO_teardown(void);
2f44961c 4173# ifdef USE_ITHREADS
6cb8cb21
RGS
4174# define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4175# define PERLIO_TERM \
4176 STMT_START { \
d0820ef1 4177 PerlIO_teardown(); \
6cb8cb21
RGS
4178 MUTEX_DESTROY(&PL_perlio_mutex);\
4179 } STMT_END
4180# else
4181# define PERLIO_INIT
d0820ef1 4182# define PERLIO_TERM PerlIO_teardown()
6cb8cb21 4183# endif
6b29934b
NC
4184#else
4185# define PERLIO_INIT
4186# define PERLIO_TERM
6cb8cb21
RGS
4187#endif
4188
18f739ee 4189#ifdef MYMALLOC
772fe5b3 4190# ifdef MUTEX_INIT_CALLS_MALLOC
3541dd58
HM
4191# define MALLOC_INIT \
4192 STMT_START { \
4193 PL_malloc_mutex = NULL; \
4194 MUTEX_INIT(&PL_malloc_mutex); \
4195 } STMT_END
4196# define MALLOC_TERM \
4197 STMT_START { \
4198 perl_mutex tmp = PL_malloc_mutex; \
4199 PL_malloc_mutex = NULL; \
4200 MUTEX_DESTROY(&tmp); \
4201 } STMT_END
4202# else
4203# define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4204# define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4205# endif
18f739ee
IZ
4206#else
4207# define MALLOC_INIT
4208# define MALLOC_TERM
4209#endif
4210
cd1541b2 4211#if defined(PERL_IMPLICIT_CONTEXT)
7cb608b5
NC
4212
4213struct perl_memory_debug_header;
cd1541b2
NC
4214struct perl_memory_debug_header {
4215 tTHX interpreter;
b001a0d1 4216# if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
cd1541b2 4217 MEM_SIZE size;
cd1541b2 4218# endif
7cb608b5
NC
4219 struct perl_memory_debug_header *prev;
4220 struct perl_memory_debug_header *next;
b001a0d1
FC
4221# ifdef PERL_DEBUG_READONLY_COW
4222 bool readonly;
4223# endif
4224};
4225
4226#elif defined(PERL_DEBUG_READONLY_COW)
4227
4228struct perl_memory_debug_header;
4229struct perl_memory_debug_header {
4230 MEM_SIZE size;
cd1541b2
NC
4231};
4232
b001a0d1
FC
4233#endif
4234
60175f94 4235#if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
b001a0d1 4236
a78adc84
DM
4237# define PERL_MEMORY_DEBUG_HEADER_SIZE \
4238 (sizeof(struct perl_memory_debug_header) + \
cd1541b2
NC
4239 (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4240 %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4241
d8fca402 4242#else
a78adc84 4243# define PERL_MEMORY_DEBUG_HEADER_SIZE 0
cd1541b2
NC
4244#endif
4245
7cb608b5 4246#ifdef PERL_TRACK_MEMPOOL
b001a0d1 4247# ifdef PERL_DEBUG_READONLY_COW
7cb608b5
NC
4248# define INIT_TRACK_MEMPOOL(header, interp) \
4249 STMT_START { \
4250 (header).interpreter = (interp); \
4251 (header).prev = (header).next = &(header); \
b001a0d1 4252 (header).readonly = 0; \
7cb608b5 4253 } STMT_END
b001a0d1
FC
4254# else
4255# define INIT_TRACK_MEMPOOL(header, interp) \
4256 STMT_START { \
4257 (header).interpreter = (interp); \
4258 (header).prev = (header).next = &(header); \
4259 } STMT_END
4260# endif
4261# else
7cb608b5
NC
4262# define INIT_TRACK_MEMPOOL(header, interp)
4263#endif
4264
1cd66f7c
DD
4265#ifdef I_MALLOCMALLOC
4266/* Needed for malloc_size(), malloc_good_size() on some systems */
4267# include <malloc/malloc.h>
4268#endif
4269
ca7c1a29
NC
4270#ifdef MYMALLOC
4271# define Perl_safesysmalloc_size(where) Perl_malloced_size(where)
cfe52898 4272#else
b001a0d1 4273# if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
e82be400 4274# ifdef PERL_TRACK_MEMPOOL
cfe52898 4275# define Perl_safesysmalloc_size(where) \
a78adc84 4276 (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
e82be400
NC
4277# else
4278# define Perl_safesysmalloc_size(where) malloc_size(where)
4279# endif
4280# endif
4281# ifdef HAS_MALLOC_GOOD_SIZE
4282# ifdef PERL_TRACK_MEMPOOL
d8fca402 4283# define Perl_malloc_good_size(how_much) \
a78adc84 4284 (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
e82be400
NC
4285# else
4286# define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4287# endif
4288# else
d8fca402
NC
4289/* Having this as the identity operation makes some code simpler. */
4290# define Perl_malloc_good_size(how_much) (how_much)
e82be400 4291# endif
ca7c1a29 4292#endif
b6d9d515 4293
16c91539
BM
4294typedef int (*runops_proc_t)(pTHX);
4295typedef void (*share_proc_t) (pTHX_ SV *sv);
4296typedef int (*thrhook_proc_t) (pTHX);
4297typedef OP* (*PPADDR_t[]) (pTHX);
4298typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4299typedef void (*despatch_signals_proc_t) (pTHX);
22c35a8c 4300
f05550c0
BF
4301#if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4302# include <crt_externs.h> /* for the env array */
4303# define environ (*_NSGetEnviron())
a54aca4b 4304#elif defined(USE_ENVIRON_ARRAY) && !defined(environ)
8f1f23e8 4305 /* VMS and some other platforms don't use the environ array */
a54aca4b 4306EXTERN_C char **environ; /* environment variables supplied via exec */
8f1f23e8 4307#endif
79072805 4308
457c5385
NC
4309#define PERL_PATCHLEVEL_H_IMPLICIT
4310#include "patchlevel.h"
4311#undef PERL_PATCHLEVEL_H_IMPLICIT
4312
4313#define PERL_VERSION_STRING STRINGIFY(PERL_REVISION) "." \
4314 STRINGIFY(PERL_VERSION) "." \
4315 STRINGIFY(PERL_SUBVERSION)
4316
4317#define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4318 STRINGIFY(PERL_API_VERSION) "." \
4319 STRINGIFY(PERL_API_SUBVERSION)
4320
73c4f7a1
GS
4321START_EXTERN_C
4322
79072805 4323/* handy constants */
22c35a8c 4324EXTCONST char PL_warn_uninit[]
29489e7c 4325 INIT("Use of uninitialized value%s%s%s");
fef7e7a0 4326EXTCONST char PL_warn_uninit_sv[]
61608bb7 4327 INIT("Use of uninitialized value%" SVf "%s%s");
22c35a8c 4328EXTCONST char PL_warn_nosemi[]
463ee0b2 4329 INIT("Semicolon seems to be missing");
22c35a8c 4330EXTCONST char PL_warn_reserved[]
463ee0b2 4331 INIT("Unquoted string \"%s\" may clash with future reserved word");
22c35a8c 4332EXTCONST char PL_warn_nl[]
93a17b20 4333 INIT("Unsuccessful %s on filename containing newline");
22c35a8c 4334EXTCONST char PL_no_wrongref[]
a0d0e21e 4335 INIT("Can't use %s ref as %s ref");
fedf30e1 4336/* The core no longer needs this here. If you require the string constant,
def89bff 4337 please inline a copy into your own code. */
973a7615
NC
4338EXTCONST char PL_no_symref[] __attribute__deprecated__
4339 INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
fedf30e1
DM
4340EXTCONST char PL_no_symref_sv[]
4341 INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4342
22c35a8c 4343EXTCONST char PL_no_usym[]
8990e307 4344 INIT("Can't use an undefined value as %s reference");
22c35a8c 4345EXTCONST char PL_no_aelem[]
93a17b20 4346 INIT("Modification of non-creatable array value attempted, subscript %d");
ce5030a2 4347EXTCONST char PL_no_helem_sv[]
61608bb7 4348 INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
22c35a8c 4349EXTCONST char PL_no_modify[]
93a17b20 4350 INIT("Modification of a read-only value attempted");
4cbe3a7d 4351EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
93a17b20 4352 INIT("Out of memory!\n");
22c35a8c 4353EXTCONST char PL_no_security[]
463ee0b2 4354 INIT("Insecure dependency in %s%s");
22c35a8c 4355EXTCONST char PL_no_sock_func[]
93a17b20 4356 INIT("Unsupported socket function \"%s\" called");
22c35a8c 4357EXTCONST char PL_no_dir_func[]
93a17b20 4358 INIT("Unsupported directory function \"%s\" called");
22c35a8c 4359EXTCONST char PL_no_func[]
93a17b20 4360 INIT("The %s function is unimplemented");
22c35a8c 4361EXTCONST char PL_no_myglob[]
a21eb52b 4362 INIT("\"%s\" %se %s can't be in a package");
82d03984
RGS
4363EXTCONST char PL_no_localize_ref[]
4364 INIT("Can't localize through a reference");
27d5b266
JH
4365EXTCONST char PL_memory_wrap[]
4366 INIT("panic: memory wrap");
93a17b20 4367
58f645e2
NC
4368EXTCONST char PL_Yes[]
4369 INIT("1");
4370EXTCONST char PL_No[]
4371 INIT("");
5a6c2837
DM
4372EXTCONST char PL_Zero[]
4373 INIT("0");
58f645e2
NC
4374EXTCONST char PL_hexdigit[]
4375 INIT("0123456789abcdef0123456789ABCDEF");
4376
0447859b
NC
4377/* This is constant on most architectures, a global on OS/2 */
4378#ifndef OS2
4379EXTCONST char PL_sh_path[]
4380 INIT(SH_PATH); /* full path of shell */
4381#endif
4382
618b9757
NC
4383#ifdef CSH
4384EXTCONST char PL_cshname[]
4385 INIT(CSH);
4386# define PL_cshlen (sizeof(CSH "") - 1)
4387#endif
4388
457c5385
NC
4389/* These are baked at compile time into any shared perl library.
4390 In future releases this will allow us in main() to sanity test the
4391 library we're linking against. */
4392
4393EXTCONST U8 PL_revision
4394 INIT(PERL_REVISION);
4395EXTCONST U8 PL_version
4396 INIT(PERL_VERSION);
4397EXTCONST U8 PL_subversion
4398 INIT(PERL_SUBVERSION);
4399
7575fa06 4400EXTCONST char PL_uuemap[65]
80252599
GS
4401 INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4402
7bfe3bfd
DM
4403/* a special string address whose value is "isa", but which perl knows
4404 * to treat as if it were really "DOES" when printing the method name in
4405 * the "Can't call method '%s'" error message */
4406EXTCONST char PL_isa_DOES[]
4407 INIT("isa");
4408
79072805 4409#ifdef DOINIT
9444d213 4410EXTCONST char PL_uudmap[256] =
dde5ec2c
NC
4411# ifdef PERL_MICRO
4412# include "uuudmap.h"
4413# else
4414# include "uudmap.h"
4415# endif
9444d213 4416;
efa50c51 4417EXTCONST char PL_bitcount[256] =
dde5ec2c
NC
4418# ifdef PERL_MICRO
4419# include "ubitcount.h"
4420#else
4421# include "bitcount.h"
4422# endif
efa50c51 4423;
27da23d5
JH
4424EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4425EXTCONST int PL_sig_num[] = { SIG_NUM };
79072805 4426#else
9444d213 4427EXTCONST char PL_uudmap[256];
efa50c51 4428EXTCONST char PL_bitcount[256];
27da23d5
JH
4429EXTCONST char* const PL_sig_name[];
4430EXTCONST int PL_sig_num[];
79072805
LW
4431#endif
4432
6d8e7a01
KW
4433/* fast conversion and case folding tables. The folding tables complement the
4434 * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4435 * folds such as outside the range or to multiple characters. */
bbce6d69 4436
79072805 4437#ifdef DOINIT
d02f4dad
KW
4438#ifndef EBCDIC
4439
4440/* The EBCDIC fold table depends on the code page, and hence is found in
4441 * utfebcdic.h */
4442
22c35a8c 4443EXTCONST unsigned char PL_fold[] = {
79072805
LW
4444 0, 1, 2, 3, 4, 5, 6, 7,
4445 8, 9, 10, 11, 12, 13, 14, 15,
4446 16, 17, 18, 19, 20, 21, 22, 23,
4447 24, 25, 26, 27, 28, 29, 30, 31,
4448 32, 33, 34, 35, 36, 37, 38, 39,
4449 40, 41, 42, 43, 44, 45, 46, 47,
4450 48, 49, 50, 51, 52, 53, 54, 55,
4451 56, 57, 58, 59, 60, 61, 62, 63,
4452 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
4453 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
4454 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
4455 'x', 'y', 'z', 91, 92, 93, 94, 95,
4456 96, 'A', 'B', 'C', 'D', 'E', 'F', 'G',
4457 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
4458 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
4459 'X', 'Y', 'Z', 123, 124, 125, 126, 127,
4460 128, 129, 130, 131, 132, 133, 134, 135,
4461 136, 137, 138, 139, 140, 141, 142, 143,
4462 144, 145, 146, 147, 148, 149, 150, 151,
4463 152, 153, 154, 155, 156, 157, 158, 159,
4464 160, 161, 162, 163, 164, 165, 166, 167,
4465 168, 169, 170, 171, 172, 173, 174, 175,
4466 176, 177, 178, 179, 180, 181, 182, 183,
4467 184, 185, 186, 187, 188, 189, 190, 191,
4468 192, 193, 194, 195, 196, 197, 198, 199,
4469 200, 201, 202, 203, 204, 205, 206, 207,
4470 208, 209, 210, 211, 212, 213, 214, 215,
4471 216, 217, 218, 219, 220, 221, 222, 223,
4472 224, 225, 226, 227, 228, 229, 230, 231,
4473 232, 233, 234, 235, 236, 237, 238, 239,
4474 240, 241, 242, 243, 244, 245, 246, 247,
4475 248, 249, 250, 251, 252, 253, 254, 255
4476};
3871f40b
KW
4477EXTCONST unsigned char PL_fold_latin1[] = {
4478 /* Full latin1 complement folding, except for three problematic code points:
4479 * Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4480 * fold complements outside the Latin1 range, so can't match something
4481 * that isn't in utf8.
4482 * German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4483 * not one, so can't be represented in this table.
4484 *
4485 * All have to be specially handled */
4486 0, 1, 2, 3, 4, 5, 6, 7,
4487 8, 9, 10, 11, 12, 13, 14, 15,
4488 16, 17, 18, 19, 20, 21, 22, 23,
4489 24, 25, 26, 27, 28, 29, 30, 31,
4490 32, 33, 34, 35, 36, 37, 38, 39,
4491 40, 41, 42, 43, 44, 45, 46, 47,
4492 48, 49, 50, 51, 52, 53, 54, 55,
4493 56, 57, 58, 59, 60, 61, 62, 63,
4494 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
4495 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
4496 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
4497 'x', 'y', 'z', 91, 92, 93, 94, 95,
4498 96, 'A', 'B', 'C', 'D', 'E', 'F', 'G',
4499 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
4500 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
4501 'X', 'Y', 'Z', 123, 124, 125, 126, 127,
4502 128, 129, 130, 131, 132, 133, 134, 135,
4503 136, 137, 138, 139, 140, 141, 142, 143,
4504 144, 145, 146, 147, 148, 149, 150, 151,
4505 152, 153, 154, 155, 156, 157, 158, 159,
4506 160, 161, 162, 163, 164, 165, 166, 167,
4507 168, 169, 170, 171, 172, 173, 174, 175,
4508 176, 177, 178, 179, 180, 181 /*micro */, 182, 183,
4509 184, 185, 186, 187, 188, 189, 190, 191,
4510 192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4511 200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4512 208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4513 216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
4514 224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4515 232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4516 240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4517 248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
4518 255 /* y with diaeresis */
4519};
00f254e2
KW
4520
4521/* If these tables are accessed through ebcdic, the access will be converted to
4522 * latin1 first */
4523EXTCONST unsigned char PL_latin1_lc[] = { /* lowercasing */
4524 0, 1, 2, 3, 4, 5, 6, 7,
4525 8, 9, 10, 11, 12, 13, 14, 15,
4526 16, 17, 18, 19, 20, 21, 22, 23,
4527 24, 25, 26, 27, 28, 29, 30, 31,
4528 32, 33, 34, 35, 36, 37, 38, 39,
4529 40, 41, 42, 43, 44, 45, 46, 47,
4530 48, 49, 50, 51, 52, 53, 54, 55,
4531 56, 57, 58, 59, 60, 61, 62, 63,
4532 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
4533 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
4534 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
4535 'x', 'y', 'z', 91, 92, 93, 94, 95,
4536 96, 97, 98, 99, 100, 101, 102, 103,
4537 104, 105, 106, 107, 108, 109, 110, 111,
4538 112, 113, 114, 115, 116, 117, 118, 119,
4539 120, 121, 122, 123, 124, 125, 126, 127,
4540 128, 129, 130, 131, 132, 133, 134, 135,
4541 136, 137, 138, 139, 140, 141, 142, 143,
4542 144, 145, 146, 147, 148, 149, 150, 151,
4543 152, 153, 154, 155, 156, 157, 158, 159,
4544 160, 161, 162, 163, 164, 165, 166, 167,
4545 168, 169, 170, 171, 172, 173, 174, 175,
4546 176, 177, 178, 179, 180, 181, 182, 183,
4547 184, 185, 186, 187, 188, 189, 190, 191,
4548 192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4549 200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4550 208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4551 216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223,
4552 224, 225, 226, 227, 228, 229, 230, 231,
4553 232, 233, 234, 235, 236, 237, 238, 239,
4554 240, 241, 242, 243, 244, 245, 246, 247,
4555 248, 249, 250, 251, 252, 253, 254, 255
4556};
4557
4558/* upper and title case of latin1 characters, modified so that the three tricky
4559 * ones are mapped to 255 (which is one of the three) */
4560EXTCONST unsigned char PL_mod_latin1_uc[] = {
4561 0, 1, 2, 3, 4, 5, 6, 7,
4562 8, 9, 10, 11, 12, 13, 14, 15,
4563 16, 17, 18, 19, 20, 21, 22, 23,
4564 24, 25, 26, 27, 28, 29, 30, 31,
4565 32, 33, 34, 35, 36, 37, 38, 39,
4566 40, 41, 42, 43, 44, 45, 46, 47,
4567 48, 49, 50, 51, 52, 53, 54, 55,
4568 56, 57, 58, 59, 60, 61, 62, 63,
4569 64, 65, 66, 67, 68, 69, 70, 71,
4570 72, 73, 74, 75, 76, 77, 78, 79,
4571 80, 81, 82, 83, 84, 85, 86, 87,
4572 88, 89, 90, 91, 92, 93, 94, 95,
4573 96, 'A', 'B', 'C', 'D', 'E', 'F', 'G',
4574 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
4575 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
4576 'X', 'Y', 'Z', 123, 124, 125, 126, 127,
4577 128, 129, 130, 131, 132, 133, 134, 135,
4578 136, 137, 138, 139, 140, 141, 142, 143,
4579 144, 145, 146, 147, 148, 149, 150, 151,
4580 152, 153, 154, 155, 156, 157, 158, 159,
4581 160, 161, 162, 163, 164, 165, 166, 167,
4582 168, 169, 170, 171, 172, 173, 174, 175,
4583 176, 177, 178, 179, 180, 255 /*micro*/, 182, 183,
4584 184, 185, 186, 187, 188, 189, 190, 191,
4585 192, 193, 194, 195, 196, 197, 198, 199,
4586 200, 201, 202, 203, 204, 205, 206, 207,
4587 208, 209, 210, 211, 212, 213, 214, 215,
79e064b9
KW
4588 216, 217, 218, 219, 220, 221, 222,
4589#if UNICODE_MAJOR_VERSION > 2 \
4590 || (UNICODE_MAJOR_VERSION == 2 && UNICODE_DOT_VERSION >= 1 \
4591 && UNICODE_DOT_DOT_VERSION >= 8)
4592 255 /*sharp s*/,
4593#else /* uc() is itself in early unicode */
4594 223,
4595#endif
00f254e2
KW
4596 224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4597 232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4598 240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4599 248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32, 255
4600};
1248eb9d 4601#endif /* !EBCDIC, but still in DOINIT */
00f254e2 4602#else /* ! DOINIT */
1248eb9d 4603# ifndef EBCDIC
22c35a8c 4604EXTCONST unsigned char PL_fold[];
3871f40b 4605EXTCONST unsigned char PL_fold_latin1[];
00f254e2
KW
4606EXTCONST unsigned char PL_mod_latin1_uc[];
4607EXTCONST unsigned char PL_latin1_lc[];
1248eb9d 4608# endif
79072805
LW
4609#endif
4610
27da23d5 4611#ifndef PERL_GLOBAL_STRUCT /* or perlvars.h */
79072805 4612#ifdef DOINIT
27da23d5 4613EXT unsigned char PL_fold_locale[] = { /* Unfortunately not EXTCONST. */
79072805
LW
4614 0, 1, 2, 3, 4, 5, 6, 7,
4615 8, 9, 10, 11, 12, 13, 14, 15,
4616 16, 17, 18, 19, 20, 21, 22, 23,
4617 24, 25, 26, 27, 28, 29, 30, 31,
4618 32, 33, 34, 35, 36, 37, 38, 39,
4619 40, 41, 42, 43, 44, 45, 46, 47,
4620 48, 49, 50, 51, 52, 53, 54, 55,
4621 56, 57, 58, 59, 60, 61, 62, 63,
4622 64, 'a', 'b', 'c', 'd', 'e', 'f', 'g',
4623 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
4624 'p', 'q', 'r', 's', 't', 'u', 'v', 'w',
4625 'x', 'y', 'z', 91, 92, 93, 94, 95,
4626 96, 'A', 'B', 'C', 'D', 'E', 'F', 'G',
4627 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
4628 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W',
4629 'X', 'Y', 'Z', 123, 124, 125, 126, 127,
4630 128, 129, 130, 131, 132, 133, 134, 135,
4631 136, 137, 138, 139, 140, 141, 142, 143,
4632 144, 145, 146, 147, 148, 149, 150, 151,
4633 152, 153, 154, 155, 156, 157, 158, 159,
4634 160, 161, 162, 163, 164, 165, 166, 167,
4635 168, 169, 170, 171, 172, 173, 174, 175,
4636 176, 177, 178, 179, 180, 181, 182, 183,
4637 184, 185, 186, 187, 188, 189, 190, 191,
4638 192, 193, 194, 195, 196, 197, 198, 199,
4639 200, 201, 202, 203, 204, 205, 206, 207,
4640 208, 209, 210, 211, 212, 213, 214, 215,
4641 216, 217, 218, 219, 220, 221, 222, 223,
4642 224, 225, 226, 227, 228, 229, 230, 231,
4643 232, 233, 234, 235, 236, 237, 238, 239,
4644 240, 241, 242, 243, 244, 245, 246, 247,
4645 248, 249, 250, 251, 252, 253, 254, 255
4646};
4647#else
27da23d5 4648EXT unsigned char PL_fold_locale[]; /* Unfortunately not EXTCONST. */
79072805 4649#endif
27da23d5 4650#endif /* !PERL_GLOBAL_STRUCT */
79072805
LW
4651
4652#ifdef DOINIT
9d116dd7 4653#ifdef EBCDIC
27da23d5 4654EXTCONST unsigned char PL_freq[] = {/* EBCDIC frequencies for mixed English/C */
9d116dd7
JH
4655 1, 2, 84, 151, 154, 155, 156, 157,
4656 165, 246, 250, 3, 158, 7, 18, 29,
4657 40, 51, 62, 73, 85, 96, 107, 118,
4658 129, 140, 147, 148, 149, 150, 152, 153,
4659 255, 6, 8, 9, 10, 11, 12, 13,
4660 14, 15, 24, 25, 26, 27, 28, 226,
4661 29, 30, 31, 32, 33, 43, 44, 45,
4662 46, 47, 48, 49, 50, 76, 77, 78,
4663 79, 80, 81, 82, 83, 84, 85, 86,
4664 87, 94, 95, 234, 181, 233, 187, 190,
4665 180, 96, 97, 98, 99, 100, 101, 102,
4666 104, 112, 182, 174, 236, 232, 229, 103,
4667 228, 226, 114, 115, 116, 117, 118, 119,
4668 120, 121, 122, 235, 176, 230, 194, 162,
4669 130, 131, 132, 133, 134, 135, 136, 137,
4670 138, 139, 201, 205, 163, 217, 220, 224,
4671 5, 248, 227, 244, 242, 255, 241, 231,
4672 240, 253, 16, 197, 19, 20, 21, 187,
4673 23, 169, 210, 245, 237, 249, 247, 239,
4674 168, 252, 34, 196, 36, 37, 38, 39,
4675 41, 42, 251, 254, 238, 223, 221, 213,
4676 225, 177, 52, 53, 54, 55, 56, 57,
4677 58, 59, 60, 61, 63, 64, 65, 66,
4678 67, 68, 69, 70, 71, 72, 74, 75,
4679 205, 208, 186, 202, 200, 218, 198, 179,
4680 178, 214, 88, 89, 90, 91, 92, 93,
4681 217, 166, 170, 207, 199, 209, 206, 204,
4682 160, 212, 105, 106, 108, 109, 110, 111,
4683 203, 113, 216, 215, 192, 175, 193, 243,
4684 172, 161, 123, 124, 125, 126, 127, 128,
4685 222, 219, 211, 195, 188, 193, 185, 184,
4686 191, 183, 141, 142, 143, 144, 145, 146
4687};
4688#else /* ascii rather than ebcdic */
22c35a8c 4689EXTCONST unsigned char PL_freq[] = { /* letter frequencies for mixed English/C */
79072805
LW
4690 1, 2, 84, 151, 154, 155, 156, 157,
4691 165, 246, 250, 3, 158, 7, 18, 29,
4692 40, 51, 62, 73, 85, 96, 107, 118,
4693 129, 140, 147, 148, 149, 150, 152, 153,
4694 255, 182, 224, 205, 174, 176, 180, 217,
4695 233, 232, 236, 187, 235, 228, 234, 226,
4696 222, 219, 211, 195, 188, 193, 185, 184,
4697 191, 183, 201, 229, 181, 220, 194, 162,
4698 163, 208, 186, 202, 200, 218, 198, 179,
4699 178, 214, 166, 170, 207, 199, 209, 206,
4700 204, 160, 212, 216, 215, 192, 175, 173,
4701 243, 172, 161, 190, 203, 189, 164, 230,
4702 167, 248, 227, 244, 242, 255, 241, 231,
4703 240, 253, 169, 210, 245, 237, 249, 247,
4704 239, 168, 252, 251, 254, 238, 223, 221,
4705 213, 225, 177, 197, 171, 196, 159, 4,
4706 5, 6, 8, 9, 10, 11, 12, 13,
4707 14, 15, 16, 17, 19, 20, 21, 22,
4708 23, 24, 25, 26, 27, 28, 30, 31,
4709 32, 33, 34, 35, 36, 37, 38, 39,
4710 41, 42, 43, 44, 45, 46, 47, 48,
4711 49, 50, 52, 53, 54, 55, 56, 57,
4712 58, 59, 60, 61, 63, 64, 65, 66,
4713 67, 68, 69, 70, 71, 72, 74, 75,
4714 76, 77, 78, 79, 80, 81, 82, 83,
4715 86, 87, 88, 89, 90, 91, 92, 93,
4716 94, 95, 97, 98, 99, 100, 101, 102,
4717 103, 104, 105, 106, 108, 109, 110, 111,
4718 112, 113, 114, 115, 116, 117, 119, 120,
4719 121, 122, 123, 124, 125, 126, 127, 128,
4720 130, 131, 132, 133, 134, 135, 136, 137,
4721 138, 139, 141, 142, 143, 144, 145, 146
4722};
9d116dd7 4723#endif
79072805 4724#else
22c35a8c 4725EXTCONST unsigned char PL_freq[];
79072805
LW
4726#endif
4727
b0812ba3
DM
4728/* Although only used for debugging, these constants must be available in
4729 * non-debugging builds too, since they're used in ext/re/re_exec.c,
4730 * which has DEBUGGING enabled always */
8990e307 4731#ifdef DOINIT
27da23d5 4732EXTCONST char* const PL_block_type[] = {
8990e307 4733 "NULL",
d01136d6 4734 "WHEN",
8990e307 4735 "BLOCK",
0d863452 4736 "GIVEN",
1611176f 4737 "LOOP_ARY",
93661e56 4738 "LOOP_LAZYSV",
1611176f 4739 "LOOP_LAZYIV",
93661e56 4740 "LOOP_LIST",
1611176f 4741 "LOOP_PLAIN",
76753e7f
NC
4742 "SUB",
4743 "FORMAT",
4744 "EVAL",
4745 "SUBST"
8990e307
LW
4746};
4747#else
22c35a8c 4748EXTCONST char* PL_block_type[];
8990e307 4749#endif
8990e307 4750
b75885fd
NC
4751/* These are all the compile time options that affect binary compatibility.
4752 Other compile time options that are binary compatible are in perl.c
e23397c2 4753 (in S_Internals_V()). Both are combined for the output of perl -V
b75885fd
NC
4754 However, this string will be embedded in any shared perl library, which will
4755 allow us add a comparison check in perlmain.c in the near future. */
4756#ifdef DOINIT
4757EXTCONST char PL_bincompat_options[] =
4758# ifdef DEBUG_LEAKING_SCALARS
4759 " DEBUG_LEAKING_SCALARS"
4760# endif
4761# ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4762 " DEBUG_LEAKING_SCALARS_FORK_DUMP"
4763# endif
eba804b9
NC
4764# ifdef FCRYPT
4765 " FCRYPT"
4766# endif
4767# ifdef HAS_TIMES
4768 " HAS_TIMES"
4769# endif
4770# ifdef HAVE_INTERP_INTERN
426f6eb2 4771 " HAVE_INTERP_INTERN"
eba804b9 4772# endif
b75885fd
NC
4773# ifdef MULTIPLICITY
4774 " MULTIPLICITY"
4775# endif
4776# ifdef MYMALLOC
4777 " MYMALLOC"
4778# endif
eba804b9
NC
4779# ifdef PERLIO_LAYERS
4780 " PERLIO_LAYERS"
4781# endif
cb26ef7a
MB
4782# ifdef PERL_DEBUG_READONLY_COW
4783 " PERL_DEBUG_READONLY_COW"
4784# endif
b75885fd
NC
4785# ifdef PERL_DEBUG_READONLY_OPS
4786 " PERL_DEBUG_READONLY_OPS"
4787# endif
4788# ifdef PERL_GLOBAL_STRUCT
4789 " PERL_GLOBAL_STRUCT"
4790# endif
59dba841
JH
4791# ifdef PERL_GLOBAL_STRUCT_PRIVATE
4792 " PERL_GLOBAL_STRUCT_PRIVATE"
4793# endif
b75885fd
NC
4794# ifdef PERL_IMPLICIT_CONTEXT
4795 " PERL_IMPLICIT_CONTEXT"
4796# endif
4797# ifdef PERL_IMPLICIT_SYS
4798 " PERL_IMPLICIT_SYS"
4799# endif
eba804b9
NC
4800# ifdef PERL_MICRO
4801 " PERL_MICRO"
4802# endif
b75885fd
NC
4803# ifdef PERL_NEED_APPCTX
4804 " PERL_NEED_APPCTX"
4805# endif
4806# ifdef PERL_NEED_TIMESBASE
4807 " PERL_NEED_TIMESBASE"
4808# endif
b75885fd
NC
4809# ifdef PERL_POISON
4810 " PERL_POISON"
4811# endif
5b50f57e
FC
4812# ifdef PERL_SAWAMPERSAND
4813 " PERL_SAWAMPERSAND"
4814# endif
b75885fd
NC
4815# ifdef PERL_TRACK_MEMPOOL
4816 " PERL_TRACK_MEMPOOL"
4817# endif
4818# ifdef PERL_USES_PL_PIDSTATUS
4819 " PERL_USES_PL_PIDSTATUS"
4820# endif
b75885fd
NC
4821# ifdef USE_64_BIT_ALL
4822 " USE_64_BIT_ALL"
4823# endif
4824# ifdef USE_64_BIT_INT
4825 " USE_64_BIT_INT"
4826# endif
c7b392fa
NC
4827# ifdef USE_IEEE
4828 " USE_IEEE"
4829# endif
b75885fd
NC
4830# ifdef USE_ITHREADS
4831 " USE_ITHREADS"
4832# endif
4833# ifdef USE_LARGE_FILES
4834 " USE_LARGE_FILES"
4835# endif
eba804b9
NC
4836# ifdef USE_LOCALE_COLLATE
4837 " USE_LOCALE_COLLATE"
4838# endif
4839# ifdef USE_LOCALE_NUMERIC
4840 " USE_LOCALE_NUMERIC"
4841# endif
56e45410
KW
4842# ifdef USE_LOCALE_TIME
4843 " USE_LOCALE_TIME"
4844# endif
b75885fd
NC
4845# ifdef USE_LONG_DOUBLE
4846 " USE_LONG_DOUBLE"
4847# endif
4848# ifdef USE_PERLIO
4849 " USE_PERLIO"
4850# endif
05b4a618
JH
4851# ifdef USE_QUADMATH
4852 " USE_QUADMATH"
4853# endif
b75885fd
NC
4854# ifdef USE_REENTRANT_API
4855 " USE_REENTRANT_API"
4856# endif
b75885fd
NC
4857# ifdef USE_SOCKS
4858 " USE_SOCKS"
4859# endif
4f575702
CB
4860# ifdef VMS_DO_SOCKETS
4861 " VMS_DO_SOCKETS"
4f575702 4862# endif
e8b231c6
CB
4863# ifdef VMS_SHORTEN_LONG_SYMBOLS
4864 " VMS_SHORTEN_LONG_SYMBOLS"
4865# endif
ad5e438d
NC
4866# ifdef VMS_WE_ARE_CASE_SENSITIVE
4867 " VMS_SYMBOL_CASE_AS_IS"
4868# endif
a68dd89e 4869 "";
b75885fd
NC
4870#else
4871EXTCONST char PL_bincompat_options[];
4872#endif
4873
ca7b837b
SM
4874#ifndef PERL_SET_PHASE
4875# define PERL_SET_PHASE(new_phase) \
3f6bd23a 4876 PERL_DTRACE_PROBE_PHASE(new_phase); \
ca7b837b
SM
4877 PL_phase = new_phase;
4878#endif
4879
9ebf26ad
FR
4880/* The interpreter phases. If these ever change, PL_phase_names right below will
4881 * need to be updated accordingly. */
4882enum perl_phase {
4883 PERL_PHASE_CONSTRUCT = 0,
4884 PERL_PHASE_START = 1,
4885 PERL_PHASE_CHECK = 2,
4886 PERL_PHASE_INIT = 3,
4887 PERL_PHASE_RUN = 4,
4888 PERL_PHASE_END = 5,
4889 PERL_PHASE_DESTRUCT = 6
4890};
4891
4892#ifdef DOINIT
4893EXTCONST char *const PL_phase_names[] = {
4894 "CONSTRUCT",
4895 "START",
4896 "CHECK",
4897 "INIT",
4898 "RUN",
4899 "END",
4900 "DESTRUCT"
4901};
4902#else
4903EXTCONST char *const PL_phase_names[];
4904#endif
4905
627364f1
FR
4906#ifndef PERL_CORE
4907/* Do not use this macro. It only exists for extensions that rely on PL_dirty
4908 * instead of using the newer PL_phase, which provides everything PL_dirty
4909 * provided, and more. */
9d990559 4910# define PL_dirty cBOOL(PL_phase == PERL_PHASE_DESTRUCT)
66978156
FC
4911
4912# define PL_amagic_generation PL_na
8bfa1b58 4913# define PL_encoding ((SV *)NULL)
627364f1
FR
4914#endif /* !PERL_CORE */
4915
823ac2c8 4916#define PL_hints PL_compiling.cop_hints
8d89205a 4917#define PL_maxo MAXO
823ac2c8 4918
73c4f7a1
GS
4919END_EXTERN_C
4920
79072805
LW
4921/*****************************************************************************/
4922/* This lexer/parser stuff is currently global since yacc is hard to reenter */
4923/*****************************************************************************/
8990e307 4924/* XXX This needs to be revisited, since BEGIN makes yacc re-enter... */
79072805 4925
d4c3c482 4926#ifdef __Lynx__
9cffb111
OS
4927/* LynxOS defines these in scsi.h which is included via ioctl.h */
4928#ifdef FORMAT
4929#undef FORMAT
4930#endif
4931#ifdef SPACE
4932#undef SPACE
4933#endif
d4c3c482 4934#endif
9cffb111 4935
fb73857a 4936#define LEX_NOTPARSING 11 /* borrowed from toke.c */
4937
79072805
LW
4938typedef enum {
4939 XOPERATOR,
4940 XTERM,
79072805 4941 XREF,
8990e307 4942 XSTATE,
a0d0e21e 4943 XBLOCK,
09bef843
SB
4944 XATTRBLOCK,
4945 XATTRTERM,
6f33ba73 4946 XTERMBLOCK,
b5b6210a 4947 XBLOCKTERM,
89f35911 4948 XPOSTDEREF,
6f33ba73 4949 XTERMORDORDOR /* evil hack */
27308ded 4950 /* update exp_name[] in toke.c if adding to this enum */
79072805
LW
4951} expectation;
4952
49fb8620
DM
4953#define KEY_sigvar 0xFFFF /* fake keyword representing a signature var */
4954
d5ec2987
NC
4955/* Hints are now stored in a dedicated U32, so the bottom 8 bits are no longer
4956 special and there is no need for HINT_PRIVATE_MASK for COPs
538e84ed
KW
4957 However, bitops store HINT_INTEGER in their op_private.
4958
4959 NOTE: The typical module using these has the bit value hard-coded, so don't
d6ded950
KW
4960 blindly change the values of these.
4961
4962 If we run out of bits, the 2 locale ones could be combined. The PARTIAL one
4963 is for "use locale 'FOO'" which excludes some categories. It requires going
4964 to %^H to find out which are in and which are out. This could be extended
4965 for the normal case of a plain HINT_LOCALE, so that %^H would be used for
4966 any locale form. */
9cfe5470
RGS
4967#define HINT_INTEGER 0x00000001 /* integer pragma */
4968#define HINT_STRICT_REFS 0x00000002 /* strict pragma */
4969#define HINT_LOCALE 0x00000004 /* locale pragma */
4970#define HINT_BYTES 0x00000008 /* bytes pragma */
d6ded950 4971#define HINT_LOCALE_PARTIAL 0x00000010 /* locale, but a subset of categories */
894ea76b
FC
4972
4973#define HINT_EXPLICIT_STRICT_REFS 0x00000020 /* strict.pm */
4974#define HINT_EXPLICIT_STRICT_SUBS 0x00000040 /* strict.pm */
4975#define HINT_EXPLICIT_STRICT_VARS 0x00000080 /* strict.pm */
85e6fe83
LW
4976
4977#define HINT_BLOCK_SCOPE 0x00000100
9cfe5470
RGS
4978#define HINT_STRICT_SUBS 0x00000200 /* strict pragma */
4979#define HINT_STRICT_VARS 0x00000400 /* strict pragma */
1863b879 4980#define HINT_UNI_8_BIT 0x00000800 /* unicode_strings feature */
85e6fe83 4981
9cfe5470 4982/* The HINT_NEW_* constants are used by the overload pragma */
b3ac6de7
IZ
4983#define HINT_NEW_INTEGER 0x00001000
4984#define HINT_NEW_FLOAT 0x00002000
4985#define HINT_NEW_BINARY 0x00004000
4986#define HINT_NEW_STRING 0x00008000
4987#define HINT_NEW_RE 0x00010000
4988#define HINT_LOCALIZE_HH 0x00020000 /* %^H needs to be copied */
8b850bd5
NC
4989#define HINT_LEXICAL_IO_IN 0x00040000 /* ${^OPEN} is set for input */
4990#define HINT_LEXICAL_IO_OUT 0x00080000 /* ${^OPEN} is set for output */
b3ac6de7 4991
9cfe5470
RGS
4992#define HINT_RE_TAINT 0x00100000 /* re pragma */
4993#define HINT_RE_EVAL 0x00200000 /* re pragma */
b3eb6a9b 4994
9cfe5470
RGS
4995#define HINT_FILETEST_ACCESS 0x00400000 /* filetest pragma */
4996#define HINT_UTF8 0x00800000 /* utf8 pragma */
5ff3f7a4 4997
e46c382e
YK
4998#define HINT_NO_AMAGIC 0x01000000 /* overloading pragma */
4999
1e215989
FC
5000#define HINT_RE_FLAGS 0x02000000 /* re '/xism' pragma */
5001
a803b9b4
FC
5002#define HINT_FEATURE_MASK 0x1c000000 /* 3 bits for feature bundles */
5003
15da1ccf
FC
5004 /* Note: Used for HINT_M_VMSISH_*,
5005 currently defined by vms/vmsish.h:
894ea76b
FC
5006 0x40000000
5007 0x80000000
5008 */
d1718a7c 5009
0239f47c 5010/* The following are stored in $^H{sort}, not in PL_hints */
afe59f35
FC
5011#define HINT_SORT_STABLE 0x00000100 /* sort styles */
5012#define HINT_SORT_UNSTABLE 0x00000200
84d4ea48 5013
d3b97530
DM
5014/* flags for PL_sawampersand */
5015
5016#define SAWAMPERSAND_LEFT 1 /* saw $` */
5017#define SAWAMPERSAND_MIDDLE 2 /* saw $& */
5018#define SAWAMPERSAND_RIGHT 4 /* saw $' */
5019
1a904fc8
FC
5020#ifndef PERL_SAWAMPERSAND
5021# define PL_sawampersand \
5022 (SAWAMPERSAND_LEFT|SAWAMPERSAND_MIDDLE|SAWAMPERSAND_RIGHT)
5023#endif
5024
a6d69523
TC
5025/* Used for debugvar magic */
5026#define DBVARMG_SINGLE 0
5027#define DBVARMG_TRACE 1
5028#define DBVARMG_SIGNAL 2
5029#define DBVARMG_COUNT 3
5030
5031#define PL_DBsingle_iv (PL_DBcontrol[DBVARMG_SINGLE])
5032#define PL_DBtrace_iv (PL_DBcontrol[DBVARMG_TRACE])
5033#define PL_DBsignal_iv (PL_DBcontrol[DBVARMG_SIGNAL])
5034
8bfdd7d9 5035/* Various states of the input record separator SV (rs) */
d4cce5f1 5036#define RsSNARF(sv) (! SvOK(sv))
af7d13df
MG
5037#define RsSIMPLE(sv) (SvOK(sv) && (! SvPOK(sv) || SvCUR(sv)))
5038#define RsPARA(sv) (SvPOK(sv) && ! SvCUR(sv))
5b2b9c68 5039#define RsRECORD(sv) (SvROK(sv) && (SvIV(SvRV(sv)) > 0))
79072805 5040
128e8167 5041/* A struct for keeping various DEBUGGING related stuff,
ce333219 5042 * neatly packed. Currently only scratch variables for
128e8167
JH
5043 * constructing debug output are included. Needed always,
5044 * not just when DEBUGGING, though, because of the re extension. c*/
ce333219
JH
5045struct perl_debug_pad {
5046 SV pad[3];
5047};
5048
5049#define PERL_DEBUG_PAD(i) &(PL_debug_pad.pad[i])
a5c57919
RGS
5050#define PERL_DEBUG_PAD_ZERO(i) (SvPVX(PERL_DEBUG_PAD(i))[0] = 0, \
5051 (((XPV*) SvANY(PERL_DEBUG_PAD(i)))->xpv_cur = 0), \
5052 PERL_DEBUG_PAD(i))
ce333219 5053
56953603 5054/* Enable variables which are pointers to functions */
16c91539
BM
5055typedef void (*peep_t)(pTHX_ OP* o);
5056typedef regexp* (*regcomp_t) (pTHX_ char* exp, char* xend, PMOP* pm);
5057typedef I32 (*regexec_t) (pTHX_ regexp* prog, char* stringarg,
0cb96387
GS
5058 char* strend, char* strbeg, I32 minend,
5059 SV* screamer, void* data, U32 flags);
16c91539 5060typedef char* (*re_intuit_start_t) (pTHX_ regexp *prog, SV *sv,
f722798b
IZ
5061 char *strpos, char *strend,
5062 U32 flags,
9f61653a 5063 re_scream_pos_data *d);
16c91539
BM
5064typedef SV* (*re_intuit_string_t) (pTHX_ regexp *prog);
5065typedef void (*regfree_t) (pTHX_ struct regexp* r);
5066typedef regexp* (*regdupe_t) (pTHX_ const regexp* r, CLONE_PARAMS *param);
a932d541 5067typedef I32 (*re_fold_t)(const char *, char const *, I32);
56953603 5068
c76ac1ee 5069typedef void (*DESTRUCTORFUNC_NOCONTEXT_t) (void*);
acfe0abc 5070typedef void (*DESTRUCTORFUNC_t) (pTHX_ void*);
f30de749 5071typedef void (*SVFUNC_t) (pTHX_ SV* const);
31e9e0a3 5072typedef I32 (*SVCOMPARE_t) (pTHX_ SV* const, SV* const);
acfe0abc
GS
5073typedef void (*XSINIT_t) (pTHX);
5074typedef void (*ATEXIT_t) (pTHX_ void*);
5075typedef void (*XSUBADDR_t) (pTHX_ CV *);
15e52e56 5076
16c91539
BM
5077typedef OP* (*Perl_ppaddr_t)(pTHX);
5078typedef OP* (*Perl_check_t) (pTHX_ OP*);
5079typedef void(*Perl_ophook_t)(pTHX_ OP*);
5080typedef int (*Perl_keyword_plugin_t)(pTHX_ char*, STRLEN, OP**);
1830b3d9 5081typedef void(*Perl_cpeep_t)(pTHX_ OP *, OP *);
88e1f1a2 5082
d67594ff
FC
5083typedef void(*globhook_t)(pTHX);
5084
88e1f1a2
JV
5085#define KEYWORD_PLUGIN_DECLINE 0
5086#define KEYWORD_PLUGIN_STMT 1
5087#define KEYWORD_PLUGIN_EXPR 2
22239a37 5088
58a50f62
GS
5089/* Interpreter exitlist entry */
5090typedef struct exitlistentry {
acfe0abc 5091 void (*fn) (pTHX_ void*);
58a50f62
GS
5092 void *ptr;
5093} PerlExitListEntry;
5094
aadb217d
JH
5095/* if you only have signal() and it resets on each signal, FAKE_PERSISTENT_SIGNAL_HANDLERS fixes */
5096/* These have to be before perlvars.h */
5097#if !defined(HAS_SIGACTION) && defined(VMS)
5098# define FAKE_PERSISTENT_SIGNAL_HANDLERS
5099#endif
5100/* if we're doing kill() with sys$sigprc on VMS, FAKE_DEFAULT_SIGNAL_HANDLERS */
5101#if defined(KILL_BY_SIGPRC)
5102# define FAKE_DEFAULT_SIGNAL_HANDLERS
5103#endif
5104
8c1cc017
NC
5105#if !defined(MULTIPLICITY)
5106
5107struct interpreter {
5108 char broiled;
22239a37
NIS
5109};
5110
8c1cc017 5111#else
22239a37 5112
d460ef45 5113/* If we have multiple interpreters define a struct
d4cce5f1 5114 holding variables which must be per-interpreter
d460ef45 5115 If we don't have threads anything that would have
d4cce5f1
NIS
5116 be per-thread is per-interpreter.
5117*/
5118
8c1cc017 5119/* Set up PERLVAR macros for populating structs */
115ff745 5120# define PERLVAR(prefix,var,type) type prefix##var;
eb42f199
KW
5121
5122/* 'var' is an array of length 'n' */
115ff745 5123# define PERLVARA(prefix,var,n,type) type prefix##var[n];
eb42f199
KW
5124
5125/* initialize 'var' to init' */
115ff745 5126# define PERLVARI(prefix,var,type,init) type prefix##var;
eb42f199
KW
5127
5128/* like PERLVARI, but make 'var' a const */
115ff745 5129# define PERLVARIC(prefix,var,type,init) type prefix##var;
8c1cc017 5130
79072805 5131struct interpreter {
7766f137 5132# include "intrpvar.h"
49f531da 5133};
d4cce5f1 5134
724cf8d6
NC
5135EXTCONST U16 PL_interp_size
5136 INIT(sizeof(struct interpreter));
5137
5138# define PERL_INTERPRETER_SIZE_UPTO_MEMBER(member) \
5139 STRUCT_OFFSET(struct interpreter, member) + \
5140 sizeof(((struct interpreter*)0)->member)
5141
5142/* This will be useful for subsequent releases, because this has to be the
5143 same in your libperl as in main(), else you have a mismatch and must abort.
5144*/
d399cf59
NC
5145EXTCONST U16 PL_interp_size_5_18_0
5146 INIT(PERL_INTERPRETER_SIZE_UPTO_MEMBER(PERL_LAST_5_18_0_INTERP_MEMBER));
724cf8d6
NC
5147
5148
8c1cc017
NC
5149# ifdef PERL_GLOBAL_STRUCT
5150/* MULTIPLICITY is automatically defined when PERL_GLOBAL_STRUCT is defined,
5151 hence it's safe and sane to nest this within #ifdef MULTIPLICITY */
5152
5153struct perl_vars {
5154# include "perlvars.h"
49f531da 5155};
8c1cc017 5156
724cf8d6
NC
5157EXTCONST U16 PL_global_struct_size
5158 INIT(sizeof(struct perl_vars));
5159
8c1cc017
NC
5160# ifdef PERL_CORE
5161# ifndef PERL_GLOBAL_STRUCT_PRIVATE
5162EXT struct perl_vars PL_Vars;
5163EXT struct perl_vars *PL_VarsPtr INIT(&PL_Vars);
5164# undef PERL_GET_VARS
5165# define PERL_GET_VARS() PL_VarsPtr
5166# endif /* !PERL_GLOBAL_STRUCT_PRIVATE */
5167# else /* PERL_CORE */
5168# if !defined(__GNUC__) || !defined(WIN32)
5169EXT
5170# endif /* WIN32 */
5171struct perl_vars *PL_VarsPtr;
5172# define PL_Vars (*((PL_VarsPtr) \
5173 ? PL_VarsPtr : (PL_VarsPtr = Perl_GetVars(aTHX))))
5174# endif /* PERL_CORE */
5175# endif /* PERL_GLOBAL_STRUCT */
79072805 5176
22239a37 5177/* Done with PERLVAR macros for now ... */
8c1cc017
NC
5178# undef PERLVAR
5179# undef PERLVARA
5180# undef PERLVARI
5181# undef PERLVARIC
8c1cc017
NC
5182
5183#endif /* MULTIPLICITY */
79072805 5184
f7fe979e 5185struct tempsym; /* defined in pp_pack.c */
49704364 5186
22239a37 5187#include "thread.h"
79072805 5188#include "pp.h"
864dbfa3 5189
0cb96387
GS
5190#undef PERL_CKDEF
5191#undef PERL_PPDEF
0159f81b
JH
5192#define PERL_CKDEF(s) PERL_CALLCONV OP *s (pTHX_ OP *o);
5193#define PERL_PPDEF(s) PERL_CALLCONV OP *s (pTHX);
0cb96387 5194
158cfab6
JD
5195#ifdef MYMALLOC
5196# include "malloc_ctl.h"
5197#endif
5198
fc6bde6f
DD
5199/*
5200 * This provides a layer of functions and macros to ensure extensions will
5201 * get to use the same RTL functions as the core.
5202 */
5203#if defined(WIN32)
5204# include "win32iop.h"
5205#endif
5206
839a9f02 5207
7766f137 5208#include "proto.h"
864dbfa3 5209
0cb96387 5210/* this has structure inits, so it cannot be included before here */
acfe0abc 5211#include "opcode.h"
864dbfa3 5212
d4cce5f1
NIS
5213/* The following must follow proto.h as #defines mess up syntax */
5214
22c35a8c
GS
5215#if !defined(PERL_FOR_X2P)
5216# include "embedvar.h"
5217#endif
d4cce5f1 5218
d460ef45 5219/* Now include all the 'global' variables
d4cce5f1 5220 * If we don't have threads or multiple interpreters
d460ef45 5221 * these include variables that would have been their struct-s
d4cce5f1 5222 */
d460ef45 5223
115ff745
NC
5224#define PERLVAR(prefix,var,type) EXT type PL_##var;
5225#define PERLVARA(prefix,var,n,type) EXT type PL_##var[n];
5226#define PERLVARI(prefix,var,type,init) EXT type PL_##var INIT(init);
5227#define PERLVARIC(prefix,var,type,init) EXTCONST type PL_##var INIT(init);
d4cce5f1 5228
acfe0abc 5229#if !defined(MULTIPLICITY)
7766f137 5230START_EXTERN_C
066ef5b5 5231# include "intrpvar.h"
7766f137 5232END_EXTERN_C
7c123f9d
DM
5233# define PL_sv_yes (PL_sv_immortals[0])
5234# define PL_sv_undef (PL_sv_immortals[1])
5235# define PL_sv_no (PL_sv_immortals[2])
5236# define PL_sv_zero (PL_sv_immortals[3])
22239a37
NIS
5237#endif
5238
24792b8d
NC
5239#ifdef PERL_CORE
5240/* All core uses now exterminated. Ensure no zombies can return: */
5241# undef PL_na
5242#endif
5243
f9293c5b
NC
5244/* Now all the config stuff is setup we can include embed.h
5245 In particular, need the relevant *ish file included already, as it may
5246 define HAVE_INTERP_INTERN */
5247#include "embed.h"
22239a37 5248
c5be433b
GS
5249#ifndef PERL_GLOBAL_STRUCT
5250START_EXTERN_C
5251
5252# include "perlvars.h"
5253
5254END_EXTERN_C
5255#endif
5256
d4cce5f1 5257#undef PERLVAR
51371543 5258#undef PERLVARA
d4cce5f1 5259#undef PERLVARI
0f3f18a6 5260#undef PERLVARIC
79072805 5261
db6e00bd
DD
5262#if !defined(MULTIPLICITY)
5263/* Set up PERLVAR macros for populating structs */
5264# define PERLVAR(prefix,var,type) type prefix##var;
5265/* 'var' is an array of length 'n' */
5266# define PERLVARA(prefix,var,n,type) type prefix##var[n];
5267/* initialize 'var' to init' */
5268# define PERLVARI(prefix,var,type,init) type prefix##var;
5269/* like PERLVARI, but make 'var' a const */
5270# define PERLVARIC(prefix,var,type,init) type prefix##var;
5271
5272/* this is never instantiated, is it just used for sizeof(struct PerlHandShakeInterpreter) */
5273struct PerlHandShakeInterpreter {
5274# include "intrpvar.h"
5275};
5276# undef PERLVAR
5277# undef PERLVARA
5278# undef PERLVARI
5279# undef PERLVARIC
5280#endif
5281
73c4f7a1
GS
5282START_EXTERN_C
5283
af2f0da9
NC
5284/* dummy variables that hold pointers to both runops functions, thus forcing
5285 * them *both* to get linked in (useful for Peek.xs, debugging etc) */
5286
5287EXTCONST runops_proc_t PL_runops_std
5288 INIT(Perl_runops_standard);
5289EXTCONST runops_proc_t PL_runops_dbg
5290 INIT(Perl_runops_debug);
5291
c910fead 5292#define EXT_MGVTBL EXTCONST MGVTBL
bc028b6b 5293
82ff486e 5294#define PERL_MAGIC_READONLY_ACCEPTABLE 0x40
e0a73de4
NC
5295#define PERL_MAGIC_VALUE_MAGIC 0x80
5296#define PERL_MAGIC_VTABLE_MASK 0x3F
82ff486e
NC
5297#define PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(t) \
5298 (PL_magic_data[(U8)(t)] & PERL_MAGIC_READONLY_ACCEPTABLE)
e0a73de4
NC
5299#define PERL_MAGIC_TYPE_IS_VALUE_MAGIC(t) \
5300 (PL_magic_data[(U8)(t)] & PERL_MAGIC_VALUE_MAGIC)
5301
8b09643d 5302#include "mg_vtable.h"
6f83ef0e
NC
5303
5304#ifdef DOINIT
5305EXTCONST U8 PL_magic_data[256] =
dde5ec2c
NC
5306# ifdef PERL_MICRO
5307# include "umg_data.h"
5308# else
5309# include "mg_data.h"
5310# endif
6f83ef0e
NC
5311;
5312#else
5313EXTCONST U8 PL_magic_data[256];
5314#endif
5315
f1fb8741 5316#ifdef DOINIT
e94d9b54 5317 /* NL IV NV PV INV PI PN MG RX GV LV AV HV CV FM IO */
f1fb8741 5318EXTCONST bool
e94d9b54 5319PL_valid_types_IVX[] = { 0, 1, 0, 0, 0, 1, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
f1fb8741 5320EXTCONST bool
e94d9b54 5321PL_valid_types_NVX[] = { 0, 0, 1, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
f1fb8741 5322EXTCONST bool
df6b4bd5 5323PL_valid_types_PVX[] = { 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1 };
f1fb8741 5324EXTCONST bool
e94d9b54 5325PL_valid_types_RV[] = { 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1 };
f1fb8741 5326EXTCONST bool
e94d9b54 5327PL_valid_types_IV_set[] = { 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1 };
f1fb8741 5328EXTCONST bool
e94d9b54 5329PL_valid_types_NV_set[] = { 0, 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0 };
f1fb8741
DM
5330
5331#else
5332
5333EXTCONST bool PL_valid_types_IVX[];
5334EXTCONST bool PL_valid_types_NVX[];
5335EXTCONST bool PL_valid_types_PVX[];
5336EXTCONST bool PL_valid_types_RV[];
5337EXTCONST bool PL_valid_types_IV_set[];
5338EXTCONST bool PL_valid_types_NV_set[];
5339
5340#endif
5341
9e76e8dd
JH
5342/* In C99 we could use designated (named field) union initializers.
5343 * In C89 we need to initialize the member declared first.
0879cd66 5344 * In C++ we need extern C initializers.
9e76e8dd
JH
5345 *
5346 * With the U8_NV version you will want to have inner braces,
9ee3aea9 5347 * while with the NV_U8 use just the NV. */
0879cd66
JH
5348
5349#ifdef __cplusplus
5350#define INFNAN_U8_NV_DECL EXTERN_C const union { U8 u8[NVSIZE]; NV nv; }
5351#define INFNAN_NV_U8_DECL EXTERN_C const union { NV nv; U8 u8[NVSIZE]; }
5352#else
9e76e8dd
JH
5353#define INFNAN_U8_NV_DECL EXTCONST union { U8 u8[NVSIZE]; NV nv; }
5354#define INFNAN_NV_U8_DECL EXTCONST union { NV nv; U8 u8[NVSIZE]; }
0879cd66 5355#endif
9e76e8dd 5356
cf6e31e9
DM
5357/* if these never got defined, they need defaults */
5358#ifndef PERL_SET_CONTEXT
5359# define PERL_SET_CONTEXT(i) PERL_SET_INTERP(i)
5360#endif
5361
5362#ifndef PERL_GET_CONTEXT
5363# define PERL_GET_CONTEXT PERL_GET_INTERP
5364#endif
5365
5366#ifndef PERL_GET_THX
5367# define PERL_GET_THX ((void*)NULL)
5368#endif
5369
5370#ifndef PERL_SET_THX
5371# define PERL_SET_THX(t) NOOP
5372#endif
5373
5374
c7627e6d
NC
5375#ifndef PERL_NO_INLINE_FUNCTIONS
5376/* Static inline funcs that depend on includes and declarations above.
5377 Some of these reference functions in the perl object files, and some
5378 compilers aren't smart enough to eliminate unused static inline
5379 functions, so including this file in source code can cause link errors
5380 even if the source code uses none of the functions. Hence including these
5381 can be be suppressed by setting PERL_NO_INLINE_FUNCTIONS. Doing this will
5382 (obviously) result in unworkable XS code, but allows simple probing code
5383 to continue to work, because it permits tests to include the perl headers
5384 for definitions without creating a link dependency on the perl library
5385 (which may not exist yet).
5386*/
5387
5388# include "inline.h"
5389#endif
f1fb8741 5390
bab3dc31 5391#include "overload.h"
a0d0e21e 5392
73c4f7a1
GS
5393END_EXTERN_C
5394
a6006777 5395struct am_table {
8978b4ac
NC
5396 U8 flags;
5397 U8 fallback;
5398 U16 spare;
eb160463 5399 U32 was_ok_sub;
9bd87817 5400 CV* table[NofAMmeth];
a0d0e21e 5401};
a6006777 5402struct am_table_short {
8978b4ac
NC
5403 U8 flags;
5404 U8 fallback;
5405 U16 spare;
eb160463 5406 U32 was_ok_sub;
a6006777 5407};
a0d0e21e 5408typedef struct am_table AMT;
a6006777 5409typedef struct am_table_short AMTS;
a0d0e21e
LW
5410
5411#define AMGfallNEVER 1
5412#define AMGfallNO 2
5413#define AMGfallYES 3
5414
a6006777 5415#define AMTf_AMAGIC 1
5416#define AMT_AMAGIC(amt) ((amt)->flags & AMTf_AMAGIC)
5417#define AMT_AMAGIC_on(amt) ((amt)->flags |= AMTf_AMAGIC)
5418#define AMT_AMAGIC_off(amt) ((amt)->flags &= ~AMTf_AMAGIC)
5419
32251b26 5420#define StashHANDLER(stash,meth) gv_handler((stash),CAT2(meth,_amg))
c0315cdf
JH
5421
5422/*
5423 * some compilers like to redefine cos et alia as faster
5424 * (and less accurate?) versions called F_cos et cetera (Quidquid
5425 * latine dictum sit, altum viditur.) This trick collides with
5426 * the Perl overloading (amg). The following #defines fool both.
5427 */
5428
5429#ifdef _FASTMATH
5430# ifdef atan2
5431# define F_atan2_amg atan2_amg
5432# endif
5433# ifdef cos
5434# define F_cos_amg cos_amg
5435# endif
5436# ifdef exp
5437# define F_exp_amg exp_amg
5438# endif
5439# ifdef log
5440# define F_log_amg log_amg
5441# endif
5442# ifdef pow
5443# define F_pow_amg pow_amg
5444# endif
5445# ifdef sin
5446# define F_sin_amg sin_amg
5447# endif
5448# ifdef sqrt
5449# define F_sqrt_amg sqrt_amg
5450# endif
5451#endif /* _FASTMATH */
5452
83ee9e09
GS
5453#define PERLDB_ALL (PERLDBf_SUB | PERLDBf_LINE | \
5454 PERLDBf_NOOPT | PERLDBf_INTER | \
5455 PERLDBf_SUBLINE| PERLDBf_SINGLE| \
b8fcbefe
NC
5456 PERLDBf_NAMEEVAL| PERLDBf_NAMEANON | \
5457 PERLDBf_SAVESRC)
925cfbb8 5458 /* No _NONAME, _GOTO */
83ee9e09
GS
5459#define PERLDBf_SUB 0x01 /* Debug sub enter/exit */
5460#define PERLDBf_LINE 0x02 /* Keep line # */
5461#define PERLDBf_NOOPT 0x04 /* Switch off optimizations */
5462#define PERLDBf_INTER 0x08 /* Preserve more data for
5463 later inspections */
5464#define PERLDBf_SUBLINE 0x10 /* Keep subr source lines */
5465#define PERLDBf_SINGLE 0x20 /* Start with single-step on */
5466#define PERLDBf_NONAME 0x40 /* For _SUB: no name of the subr */
5467#define PERLDBf_GOTO 0x80 /* Report goto: call DB::goto */
5468#define PERLDBf_NAMEEVAL 0x100 /* Informative names for evals */
5469#define PERLDBf_NAMEANON 0x200 /* Informative names for anon subs */
b8fcbefe 5470#define PERLDBf_SAVESRC 0x400 /* Save source lines into @{"_<$filename"} */
486ec47a 5471#define PERLDBf_SAVESRC_NOSUBS 0x800 /* Including evals that generate no subroutines */
c30d8139 5472#define PERLDBf_SAVESRC_INVALID 0x1000 /* Save source that did not compile */
84902520 5473
8bd38399
DD
5474#define PERLDB_SUB (PL_perldb & PERLDBf_SUB)
5475#define PERLDB_LINE (PL_perldb & PERLDBf_LINE)
5476#define PERLDB_NOOPT (PL_perldb & PERLDBf_NOOPT)
5477#define PERLDB_INTER (PL_perldb & PERLDBf_INTER)
5478#define PERLDB_SUBLINE (PL_perldb & PERLDBf_SUBLINE)
5479#define PERLDB_SINGLE (PL_perldb & PERLDBf_SINGLE)
5480#define PERLDB_SUB_NN (PL_perldb & PERLDBf_NONAME)
5481#define PERLDB_GOTO (PL_perldb & PERLDBf_GOTO)
5482#define PERLDB_NAMEEVAL (PL_perldb & PERLDBf_NAMEEVAL)
5483#define PERLDB_NAMEANON (PL_perldb & PERLDBf_NAMEANON)
5484#define PERLDB_SAVESRC (PL_perldb & PERLDBf_SAVESRC)
5485#define PERLDB_SAVESRC_NOSUBS (PL_perldb & PERLDBf_SAVESRC_NOSUBS)
5486#define PERLDB_SAVESRC_INVALID (PL_perldb & PERLDBf_SAVESRC_INVALID)
bbce6d69 5487
c7a622b3
DD
5488#define PERLDB_LINE_OR_SAVESRC (PL_perldb & (PERLDBf_LINE | PERLDBf_SAVESRC))
5489
1e5c5f69
LM
5490#ifdef USE_ITHREADS
5491# define KEYWORD_PLUGIN_MUTEX_INIT MUTEX_INIT(&PL_keyword_plugin_mutex)
5492# define KEYWORD_PLUGIN_MUTEX_LOCK MUTEX_LOCK(&PL_keyword_plugin_mutex)
5493# define KEYWORD_PLUGIN_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_keyword_plugin_mutex)
5494# define KEYWORD_PLUGIN_MUTEX_TERM MUTEX_DESTROY(&PL_keyword_plugin_mutex)
5495#else
5496# define KEYWORD_PLUGIN_MUTEX_INIT NOOP
5497# define KEYWORD_PLUGIN_MUTEX_LOCK NOOP
5498# define KEYWORD_PLUGIN_MUTEX_UNLOCK NOOP
5499# define KEYWORD_PLUGIN_MUTEX_TERM NOOP
5500#endif
5501
91191cf7 5502#ifdef USE_LOCALE
d6ded950 5503/* These locale things are all subject to change */
929e1213 5504
5acc3fa5
KW
5505
5506# if defined(HAS_NEWLOCALE) \
d269de98
KW
5507 && defined(LC_ALL_MASK) \
5508 && defined(HAS_FREELOCALE) \
5509 && defined(HAS_USELOCALE) \
f1d2176b 5510 && ! defined(NO_POSIX_2008_LOCALE)
d269de98
KW
5511
5512 /* The code is written for simplicity to assume that any platform advanced
5513 * enough to have the Posix 2008 locale functions has LC_ALL. The test
5514 * above makes sure that assumption is valid */
5515
5acc3fa5 5516# define HAS_POSIX_2008_LOCALE
d269de98
KW
5517# endif
5518
5acc3fa5
KW
5519/* We create a C locale object unconditionally if we have the functions to do
5520 * so; hence must destroy it unconditionally at the end */
5521# ifndef HAS_POSIX_2008_LOCALE
5522# define _LOCALE_TERM_POSIX_2008 NOOP
5523# else
5524# define _LOCALE_TERM_POSIX_2008 \
ffdde306 5525 STMT_START { \
ffdde306
KW
5526 if (PL_C_locale_obj) { \
5527 /* Make sure we aren't using the locale \
5528 * space we are about to free */ \
5529 uselocale(LC_GLOBAL_LOCALE); \
5530 freelocale(PL_C_locale_obj); \
5531 PL_C_locale_obj = (locale_t) NULL; \
5532 } \
5acc3fa5
KW
5533 } STMT_END
5534# endif
5535
5536# ifndef USE_ITHREADS
5537# define LOCALE_INIT
5538# define LOCALE_LOCK
5539# define LOCALE_UNLOCK
5540# define LOCALE_TERM STMT_START { _LOCALE_TERM_POSIX_2008; } STMT_END
5541# else /* Below is do use threads */
5542# define LOCALE_INIT MUTEX_INIT(&PL_locale_mutex)
5543# define LOCALE_LOCK MUTEX_LOCK(&PL_locale_mutex)
5544# define LOCALE_UNLOCK MUTEX_UNLOCK(&PL_locale_mutex)
5545# define LOCALE_TERM \
5546 STMT_START { \
5547 MUTEX_DESTROY(&PL_locale_mutex); \
5548 _LOCALE_TERM_POSIX_2008; \
5549 } STMT_END
5550# ifdef HAS_POSIX_2008_LOCALE
5551# define USE_POSIX_2008_LOCALE
5552# define USE_THREAD_SAFE_LOCALE
5553# endif
5554# endif
a0b53297 5555
c8bf5ca7 5556/* Returns TRUE if the plain locale pragma without a parameter is in effect
66cbab2c 5557 */
6b421707
FC
5558# define IN_LOCALE_RUNTIME (PL_curcop \
5559 && CopHINTS_get(PL_curcop) & HINT_LOCALE)
66cbab2c 5560
c8bf5ca7 5561/* Returns TRUE if either form of the locale pragma is in effect */
6d62ead0 5562# define IN_SOME_LOCALE_FORM_RUNTIME \
d6ded950 5563 cBOOL(CopHINTS_get(PL_curcop) & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
66cbab2c 5564
6d62ead0
KW
5565# define IN_LOCALE_COMPILETIME cBOOL(PL_hints & HINT_LOCALE)
5566# define IN_SOME_LOCALE_FORM_COMPILETIME \
d6ded950 5567 cBOOL(PL_hints & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
2de3dbcc 5568
6d62ead0 5569# define IN_LOCALE \
923e4eb5 5570 (IN_PERL_COMPILETIME ? IN_LOCALE_COMPILETIME : IN_LOCALE_RUNTIME)
6d62ead0 5571# define IN_SOME_LOCALE_FORM \
66cbab2c
KW
5572 (IN_PERL_COMPILETIME ? IN_SOME_LOCALE_FORM_COMPILETIME \
5573 : IN_SOME_LOCALE_FORM_RUNTIME)
2de3dbcc 5574
6d62ead0
KW
5575# define IN_LC_ALL_COMPILETIME IN_LOCALE_COMPILETIME
5576# define IN_LC_ALL_RUNTIME IN_LOCALE_RUNTIME
5577
5578# define IN_LC_PARTIAL_COMPILETIME cBOOL(PL_hints & HINT_LOCALE_PARTIAL)
5579# define IN_LC_PARTIAL_RUNTIME \
6b421707 5580 (PL_curcop && CopHINTS_get(PL_curcop) & HINT_LOCALE_PARTIAL)
6d62ead0
KW
5581
5582# define IN_LC_COMPILETIME(category) \
5583 (IN_LC_ALL_COMPILETIME || (IN_LC_PARTIAL_COMPILETIME \
5c1ff086 5584 && Perl__is_in_locale_category(aTHX_ TRUE, (category))))
6d62ead0
KW
5585# define IN_LC_RUNTIME(category) \
5586 (IN_LC_ALL_RUNTIME || (IN_LC_PARTIAL_RUNTIME \
5c1ff086 5587 && Perl__is_in_locale_category(aTHX_ FALSE, (category))))
6d62ead0
KW
5588# define IN_LC(category) \
5589 (IN_LC_COMPILETIME(category) || IN_LC_RUNTIME(category))
d6ded950 5590
780fcc9f
KW
5591# if defined (PERL_CORE) || defined (PERL_IN_XSUB_RE)
5592
5593 /* This internal macro should be called from places that operate under
5594 * locale rules. It there is a problem with the current locale that
2726666d
KW
5595 * hasn't been raised yet, it will output a warning this time. Because
5596 * this will so rarely be true, there is no point to optimize for
5597 * time; instead it makes sense to minimize space used and do all the
5598 * work in the rarely called function */
33245021
KW
5599# ifdef USE_LOCALE_CTYPE
5600# define _CHECK_AND_WARN_PROBLEMATIC_LOCALE \
5601 STMT_START { \
5602 if (UNLIKELY(PL_warn_locale)) { \
8d8472df 5603 Perl__warn_problematic_locale(); \
33245021
KW
5604 } \
5605 } STMT_END
5606# else
5607# define _CHECK_AND_WARN_PROBLEMATIC_LOCALE
5608# endif
780fcc9f
KW
5609
5610
613abc6d
KW
5611 /* These two internal macros are called when a warning should be raised,
5612 * and will do so if enabled. The first takes a single code point
5613 * argument; the 2nd, is a pointer to the first byte of the UTF-8 encoded
5614 * string, and an end position which it won't try to read past */
5615# define _CHECK_AND_OUTPUT_WIDE_LOCALE_CP_MSG(cp) \
008e8e82
KW
5616 STMT_START { \
5617 if (! PL_in_utf8_CTYPE_locale && ckWARN(WARN_LOCALE)) { \
5618 Perl_warner(aTHX_ packWARN(WARN_LOCALE), \
147e3846
KW
5619 "Wide character (U+%" UVXf ") in %s",\
5620 (UV) cp, OP_DESC(PL_op)); \
008e8e82
KW
5621 } \
5622 } STMT_END
613abc6d
KW
5623
5624# define _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(s, send) \
5625 STMT_START { /* Check if to warn before doing the conversion work */\
008e8e82 5626 if (! PL_in_utf8_CTYPE_locale && ckWARN(WARN_LOCALE)) { \
613abc6d
KW
5627 UV cp = utf8_to_uvchr_buf((U8 *) s, (U8 *) send, NULL); \
5628 Perl_warner(aTHX_ packWARN(WARN_LOCALE), \
147e3846 5629 "Wide character (U+%" UVXf ") in %s", \
613abc6d
KW
5630 (cp == 0) \
5631 ? UNICODE_REPLACEMENT \
5632 : (UV) cp, \
5633 OP_DESC(PL_op)); \
5634 } \
5635 } STMT_END
5636
780fcc9f 5637# endif /* PERL_CORE or PERL_IN_XSUB_RE */
91191cf7 5638#else /* No locale usage */
929e1213
KW
5639# define LOCALE_INIT
5640# define LOCALE_TERM
a0b53297
KW
5641# define LOCALE_LOCK
5642# define LOCALE_UNLOCK
91191cf7
KW
5643# define IN_LOCALE_RUNTIME 0
5644# define IN_SOME_LOCALE_FORM_RUNTIME 0
5645# define IN_LOCALE_COMPILETIME 0
5646# define IN_SOME_LOCALE_FORM_COMPILETIME 0
5647# define IN_LOCALE 0
5648# define IN_SOME_LOCALE_FORM 0
5649# define IN_LC_ALL_COMPILETIME 0
5650# define IN_LC_ALL_RUNTIME 0
5651# define IN_LC_PARTIAL_COMPILETIME 0
5652# define IN_LC_PARTIAL_RUNTIME 0
5653# define IN_LC_COMPILETIME(category) 0
5654# define IN_LC_RUNTIME(category) 0
5655# define IN_LC(category) 0
780fcc9f
KW
5656
5657# define _CHECK_AND_WARN_PROBLEMATIC_LOCALE
613abc6d
KW
5658# define _CHECK_AND_OUTPUT_WIDE_LOCALE_CP_MSG(a)
5659# define _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(a,b)
91191cf7
KW
5660#endif
5661
6bf09f55
KW
5662#ifdef USE_LOCALE_NUMERIC
5663
67d796ae 5664/* These macros are for toggling between the underlying locale (UNDERLYING or
45235d99
KW
5665 * LOCAL) and the C locale (STANDARD).
5666
5667=head1 Locale-related functions and macros
5668
5669=for apidoc Amn|void|DECLARATION_FOR_LC_NUMERIC_MANIPULATION
5670
5671This macro should be used as a statement. It declares a private variable
5672(whose name begins with an underscore) that is needed by the other macros in
5673this section. Failing to include this correctly should lead to a syntax error.
5674For compatibility with C89 C compilers it should be placed in a block before
5675any executable statements.
5676
5677=for apidoc Am|void|STORE_LC_NUMERIC_FORCE_TO_UNDERLYING
5678
5679This is used by XS code that that is C<LC_NUMERIC> locale-aware to force the
5680locale for category C<LC_NUMERIC> to be what perl thinks is the current
5681underlying locale. (The perl interpreter could be wrong about what the
5682underlying locale actually is if some C or XS code has called the C library
5683function L<setlocale(3)> behind its back; calling L</sync_locale> before calling
5684this macro will update perl's records.)
5685
5686A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
5687declare at compile time a private variable used by this macro. This macro
5688should be called as a single statement, not an expression, but with an empty
5689argument list, like this:
5690
5691 {
5692 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
5693 ...
5694 STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
5695 ...
5696 RESTORE_LC_NUMERIC();
5697 ...
5698 }
5699
5700The private variable is used to save the current locale state, so
5701that the requisite matching call to L</RESTORE_LC_NUMERIC> can restore it.
5702
5703=for apidoc Am|void|STORE_LC_NUMERIC_SET_TO_NEEDED
5704
5705This is used to help wrap XS or C code that that is C<LC_NUMERIC> locale-aware.
5706This locale category is generally kept set to the C locale by Perl for
5707backwards compatibility, and because most XS code that reads floating point
5708values can cope only with the decimal radix character being a dot.
5709
5710This macro makes sure the current C<LC_NUMERIC> state is set properly, to be
5711aware of locale if the call to the XS or C code from the Perl program is
5712from within the scope of a S<C<use locale>>; or to ignore locale if the call is
5713instead from outside such scope.
5714
5715This macro is the start of wrapping the C or XS code; the wrap ending is done
5716by calling the L</RESTORE_LC_NUMERIC> macro after the operation. Otherwise
5717the state can be changed that will adversely affect other XS code.
5718
5719A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
5720declare at compile time a private variable used by this macro. This macro
5721should be called as a single statement, not an expression, but with an empty
5722argument list, like this:
5723
5724 {
5725 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
5726 ...
5727 STORE_LC_NUMERIC_SET_TO_NEEDED();
5728 ...
5729 RESTORE_LC_NUMERIC();
5730 ...
5731 }
5732
5733=for apidoc Am|void|RESTORE_LC_NUMERIC
5734
5735This is used in conjunction with one of the macros
5736L</STORE_LC_NUMERIC_SET_TO_NEEDED>
5737and
5738L</STORE_LC_NUMERIC_FORCE_TO_UNDERLYING>
5739
5740to properly restore the C<LC_NUMERIC> state.
5741
5742A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
5743declare at compile time a private variable used by this macro and the two
5744C<STORE> ones. This macro should be called as a single statement, not an
5745expression, but with an empty argument list, like this:
5746
5747 {
5748 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
5749 ...
5750 RESTORE_LC_NUMERIC();
5751 ...
5752 }
5753
5754=cut
5755
5756*/
8a11fac9 5757
80752aac 5758# define _NOT_IN_NUMERIC_STANDARD (! PL_numeric_standard)
7738054c
KW
5759
5760/* We can lock the category to stay in the C locale, making requests to the
260c7ace
KW
5761 * contrary be noops, in the dynamic scope by setting PL_numeric_standard to 2.
5762 * */
80752aac 5763# define _NOT_IN_NUMERIC_UNDERLYING \
892e6465 5764 (! PL_numeric_underlying && PL_numeric_standard < 2)
67d796ae 5765
80752aac 5766# define DECLARATION_FOR_LC_NUMERIC_MANIPULATION \
67d796ae
KW
5767 void (*_restore_LC_NUMERIC_function)(pTHX) = NULL
5768
80752aac 5769# define STORE_LC_NUMERIC_SET_TO_NEEDED() \
67d796ae
KW
5770 if (IN_LC(LC_NUMERIC)) { \
5771 if (_NOT_IN_NUMERIC_UNDERLYING) { \
5792c642 5772 Perl_set_numeric_underlying(aTHX); \
67d796ae
KW
5773 _restore_LC_NUMERIC_function = &Perl_set_numeric_standard; \
5774 } \
5775 } \
5776 else { \
5777 if (_NOT_IN_NUMERIC_STANDARD) { \
5778 SET_NUMERIC_STANDARD(); \
5792c642 5779 _restore_LC_NUMERIC_function = &Perl_set_numeric_underlying; \
67d796ae 5780 } \
8a11fac9
KW
5781 }
5782
80752aac 5783# define RESTORE_LC_NUMERIC() \
e737dcc5
KW
5784 if (_restore_LC_NUMERIC_function) { \
5785 _restore_LC_NUMERIC_function(aTHX); \
8a11fac9
KW
5786 }
5787
5788/* The next two macros set unconditionally. These should be rarely used, and
5789 * only after being sure that this is what is needed */
80752aac 5790# define SET_NUMERIC_STANDARD() \
8d8472df
KW
5791 STMT_START { if (_NOT_IN_NUMERIC_STANDARD) \
5792 Perl_set_numeric_standard(aTHX); \
5793 } STMT_END
87755cd9 5794
80752aac 5795# define SET_NUMERIC_UNDERLYING() \
67d796ae 5796 STMT_START { if (_NOT_IN_NUMERIC_UNDERLYING) \
5792c642 5797 Perl_set_numeric_underlying(aTHX); } STMT_END
87755cd9 5798
8a11fac9
KW
5799/* The rest of these LC_NUMERIC macros toggle to one or the other state, with
5800 * the RESTORE_foo ones called to switch back, but only if need be */
80752aac 5801# define STORE_LC_NUMERIC_UNDERLYING_SET_STANDARD() \
5792c642
KW
5802 bool _was_underlying = _NOT_IN_NUMERIC_STANDARD; \
5803 if (_was_underlying) Perl_set_numeric_standard(aTHX);
f93f4e46 5804
b34856cb
KW
5805/* Doesn't change to underlying locale unless within the scope of some form of
5806 * 'use locale'. This is the usual desired behavior. */
80752aac 5807# define STORE_LC_NUMERIC_STANDARD_SET_UNDERLYING() \
67d796ae
KW
5808 bool _was_standard = _NOT_IN_NUMERIC_UNDERLYING \
5809 && IN_LC(LC_NUMERIC); \
5792c642 5810 if (_was_standard) Perl_set_numeric_underlying(aTHX);
f93f4e46 5811
371d5d44
KW
5812/* Rarely, we want to change to the underlying locale even outside of 'use
5813 * locale'. This is principally in the POSIX:: functions */
80752aac 5814# define STORE_LC_NUMERIC_FORCE_TO_UNDERLYING() \
67d796ae 5815 if (_NOT_IN_NUMERIC_UNDERLYING) { \
5792c642 5816 Perl_set_numeric_underlying(aTHX); \
67d796ae
KW
5817 _restore_LC_NUMERIC_function = &Perl_set_numeric_standard; \
5818 }
371d5d44 5819
42752acc
KW
5820/* Lock/unlock to the C locale until unlock is called. This needs to be
5821 * recursively callable. [perl #128207] */
80752aac 5822# define LOCK_LC_NUMERIC_STANDARD() \
67d796ae 5823 (__ASSERT_(PL_numeric_standard) \
42752acc 5824 PL_numeric_standard++)
80752aac 5825# define UNLOCK_LC_NUMERIC_STANDARD() \
42752acc
KW
5826 STMT_START { \
5827 if (PL_numeric_standard > 1) { \
5828 PL_numeric_standard--; \
5829 } \
5830 else { \
5831 assert(0); \
5832 } \
5833 } STMT_END
7738054c 5834
5792c642
KW
5835# define RESTORE_LC_NUMERIC_UNDERLYING() \
5836 if (_was_underlying) Perl_set_numeric_underlying(aTHX);
f93f4e46 5837
80752aac 5838# define RESTORE_LC_NUMERIC_STANDARD() \
67d796ae
KW
5839 if (_restore_LC_NUMERIC_function) { \
5840 _restore_LC_NUMERIC_function(aTHX); \
5841 }
f93f4e46 5842
36477c24 5843#else /* !USE_LOCALE_NUMERIC */
bbce6d69 5844
80752aac
KW
5845# define SET_NUMERIC_STANDARD()
5846# define SET_NUMERIC_UNDERLYING()
5847# define IS_NUMERIC_RADIX(a, b) (0)
5848# define STORE_LC_NUMERIC_UNDERLYING_SET_STANDARD()
5849# define STORE_LC_NUMERIC_STANDARD_SET_UNDERLYING()
5850# define STORE_LC_NUMERIC_FORCE_TO_UNDERLYING()
5851# define RESTORE_LC_NUMERIC_UNDERLYING()
5852# define RESTORE_LC_NUMERIC_STANDARD()
5853# define DECLARATION_FOR_LC_NUMERIC_MANIPULATION
5854# define STORE_LC_NUMERIC_SET_TO_NEEDED()
5855# define RESTORE_LC_NUMERIC()
5856# define LOCK_LC_NUMERIC_STANDARD()
5857# define UNLOCK_LC_NUMERIC_STANDARD()
8a11fac9 5858
36477c24 5859#endif /* !USE_LOCALE_NUMERIC */
a0d0e21e 5860
22bc8aa4
KW
5861#define Atof my_atof
5862
67d796ae
KW
5863/* Back-compat names */
5864#define DECLARATION_FOR_STORE_LC_NUMERIC_SET_TO_NEEDED \
5865 DECLARATION_FOR_LC_NUMERIC_MANIPULATION
5866#define DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED() \
4d99b64b
LM
5867 DECLARATION_FOR_STORE_LC_NUMERIC_SET_TO_NEEDED; \
5868 STORE_LC_NUMERIC_SET_TO_NEEDED();
67d796ae
KW
5869#define LOCK_NUMERIC_STANDARD() LOCK_LC_NUMERIC_STANDARD()
5870#define RESTORE_NUMERIC_LOCAL() RESTORE_LC_NUMERIC_UNDERLYING()
5871#define RESTORE_NUMERIC_STANDARD() RESTORE_LC_NUMERIC_STANDARD()
5872#define SET_NUMERIC_LOCAL() SET_NUMERIC_UNDERLYING()
5873#define STORE_NUMERIC_LOCAL_SET_STANDARD() \
5874 STORE_LC_NUMERIC_UNDERLYING_SET_STANDARD()
5875#define STORE_NUMERIC_STANDARD_SET_LOCAL() \
5876 STORE_LC_NUMERIC_STANDARD_SET_UNDERLYING()
5877#define STORE_NUMERIC_STANDARD_FORCE_LOCAL() \
5878 STORE_LC_NUMERIC_FORCE_TO_UNDERLYING()
5879#define UNLOCK_NUMERIC_STANDARD() UNLOCK_LC_NUMERIC_STANDARD()
5880
5881
5882
05b4a618
JH
5883#ifdef USE_QUADMATH
5884# define Perl_strtod(s, e) strtoflt128(s, e)
5885#elif defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE)
f1b32d61
JH
5886# if defined(HAS_STRTOLD)
5887# define Perl_strtod(s, e) strtold(s, e)
5888# elif defined(HAS_STRTOD)
5889# define Perl_strtod(s, e) (NV)strtod(s, e) /* Unavoidable loss. */
5890# endif
5891#elif defined(HAS_STRTOD)
5892# define Perl_strtod(s, e) strtod(s, e)
5893#endif
5894
85b76970
SH
5895#if !defined(Strtol) && defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && \
5896 (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
ec7b9793
JH
5897# ifdef __hpux
5898# define strtoll __strtoll /* secret handshake */
5899# endif
8ed77d12 5900# if defined(WIN64) && defined(_MSC_VER)
c623ac67
GS
5901# define strtoll _strtoi64 /* secret handshake */
5902# endif
079290de
GS
5903# if !defined(Strtol) && defined(HAS_STRTOLL)
5904# define Strtol strtoll
ad551343 5905# endif
28e5dec8
JH
5906# if !defined(Strtol) && defined(HAS_STRTOQ)
5907# define Strtol strtoq
5908# endif
ff935051 5909/* is there atoq() anywhere? */
15b99d39 5910#endif
079290de
GS
5911#if !defined(Strtol) && defined(HAS_STRTOL)
5912# define Strtol strtol
5913#endif
5914#ifndef Atol
5915/* It would be more fashionable to use Strtol() to define atol()
5916 * (as is done for Atoul(), see below) but for backward compatibility
5917 * we just assume atol(). */
85b76970
SH
5918# if defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && defined(HAS_ATOLL) && \
5919 (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
c623ac67
GS
5920# ifdef WIN64
5921# define atoll _atoi64 /* secret handshake */
5922# endif
76b882ba
JH
5923# define Atol atoll
5924# else
5925# define Atol atol
5926# endif
cf2093f6
JH
5927#endif
5928
85b76970
SH
5929#if !defined(Strtoul) && defined(USE_64_BIT_INT) && defined(UV_IS_QUAD) && \
5930 (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
ec7b9793
JH
5931# ifdef __hpux
5932# define strtoull __strtoull /* secret handshake */
5933# endif
8ed77d12 5934# if defined(WIN64) && defined(_MSC_VER)
c623ac67
GS
5935# define strtoull _strtoui64 /* secret handshake */
5936# endif
ad551343 5937# if !defined(Strtoul) && defined(HAS_STRTOULL)
388d3c03 5938# define Strtoul strtoull
15b99d39 5939# endif
079290de
GS
5940# if !defined(Strtoul) && defined(HAS_STRTOUQ)
5941# define Strtoul strtouq
5942# endif
76d49b1c 5943/* is there atouq() anywhere? */
ad551343 5944#endif
079290de
GS
5945#if !defined(Strtoul) && defined(HAS_STRTOUL)
5946# define Strtoul strtoul
cf2093f6 5947#endif
a5523c5b
JH
5948#if !defined(Strtoul) && defined(HAS_STRTOL) /* Last resort. */
5949# define Strtoul(s, e, b) strchr((s), '-') ? ULONG_MAX : (unsigned long)strtol((s), (e), (b))
5950#endif
079290de 5951#ifndef Atoul
d4c19fe8 5952# define Atoul(s) Strtoul(s, NULL, 10)
55eb892c 5953#endif
cf2093f6 5954
a868473f
NIS
5955#ifndef PERL_SCRIPT_MODE
5956#define PERL_SCRIPT_MODE "r"
5957#endif
5958
d2af2719 5959/* not used. Kept as a NOOP for backcompat */
c2af87cb 5960#define PERL_STACK_OVERFLOW_CHECK() NOOP
da927450
JH
5961
5962/*
5963 * Some nonpreemptive operating systems find it convenient to
5964 * check for asynchronous conditions after each op execution.
5965 * Keep this check simple, or it may slow down execution
5966 * massively.
5967 */
ce08f86c 5968
1d615522 5969#ifndef PERL_MICRO
4ffa73a3 5970# ifndef PERL_ASYNC_CHECK
5d9574c1 5971# define PERL_ASYNC_CHECK() if (UNLIKELY(PL_sig_pending)) PL_signalhook(aTHX)
4ffa73a3 5972# endif
ce08f86c
NIS
5973#endif
5974
da927450 5975#ifndef PERL_ASYNC_CHECK
1d615522 5976# define PERL_ASYNC_CHECK() NOOP
da927450
JH
5977#endif
5978
5979/*
5980 * On some operating systems, a memory allocation may succeed,
5981 * but put the process too close to the system's comfort limit.
5982 * In this case, PERL_ALLOC_CHECK frees the pointer and sets
5983 * it to NULL.
5984 */
5985#ifndef PERL_ALLOC_CHECK
c2af87cb 5986#define PERL_ALLOC_CHECK(p) NOOP
da927450
JH
5987#endif
5988
bd89102f
AD
5989#ifdef HAS_SEM
5990# include <sys/ipc.h>
5991# include <sys/sem.h>
5992# ifndef HAS_UNION_SEMUN /* Provide the union semun. */
5993 union semun {
dbba660d
TC
5994 int val;
5995 struct semid_ds *buf;
5996 unsigned short *array;
bd89102f
AD
5997 };
5998# endif
5999# ifdef USE_SEMCTL_SEMUN
dbba660d
TC
6000# ifdef IRIX32_SEMUN_BROKEN_BY_GCC
6001 union gccbug_semun {
6002 int val;
6003 struct semid_ds *buf;
6004 unsigned short *array;
6005 char __dummy[5];
6006 };
6007# define semun gccbug_semun
6008# endif
bd89102f 6009# define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun)
da5fdda8 6010# elif defined(USE_SEMCTL_SEMID_DS)
e6f0bdd6
GS
6011# ifdef EXTRA_F_IN_SEMUN_BUF
6012# define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buff)
6013# else
6014# define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buf)
6015# endif
bd89102f 6016# endif
bd89102f 6017#endif
49f531da 6018
89ca4ac7
JH
6019/*
6020 * Boilerplate macros for initializing and accessing interpreter-local
6021 * data from C. All statics in extensions should be reworked to use
7588b095
JH
6022 * this, if you want to make the extension thread-safe. See
6023 * ext/XS/APItest/APItest.xs for an example of the use of these macros,
6024 * and perlxs.pod for more.
89ca4ac7
JH
6025 *
6026 * Code that uses these macros is responsible for the following:
43a739c2
JH
6027 * 1. #define MY_CXT_KEY to a unique string, e.g.
6028 * "DynaLoader::_guts" XS_VERSION
f16dd614 6029 * XXX in the current implementation, this string is ignored.
89ca4ac7
JH
6030 * 2. Declare a typedef named my_cxt_t that is a structure that contains
6031 * all the data that needs to be interpreter-local.
6032 * 3. Use the START_MY_CXT macro after the declaration of my_cxt_t.
6033 * 4. Use the MY_CXT_INIT macro such that it is called exactly once
6034 * (typically put in the BOOT: section).
6035 * 5. Use the members of the my_cxt_t structure everywhere as
6036 * MY_CXT.member.
6037 * 6. Use the dMY_CXT macro (a declaration) in all the functions that
6038 * access MY_CXT.
6039 */
6040
fc958cd2 6041#if defined(PERL_IMPLICIT_CONTEXT)
89ca4ac7 6042
4eddb856 6043/* START_MY_CXT must appear in all extensions that define a my_cxt_t structure,
53d44271
JH
6044 * right after the definition (i.e. at file scope). The non-threads
6045 * case below uses it to declare the data as static. */
00ab59c9
DM
6046# ifdef PERL_GLOBAL_STRUCT_PRIVATE
6047# define START_MY_CXT
6048# define MY_CXT_INDEX Perl_my_cxt_index(aTHX_ MY_CXT_KEY)
6049# define MY_CXT_INIT_ARG MY_CXT_KEY
6050# else
6051# define START_MY_CXT static int my_cxt_index = -1;
6052# define MY_CXT_INDEX my_cxt_index
6053# define MY_CXT_INIT_ARG &my_cxt_index
6054# endif /* #ifdef PERL_GLOBAL_STRUCT_PRIVATE */
53d44271
JH
6055
6056/* Creates and zeroes the per-interpreter data.
6057 * (We allocate my_cxtp in a Perl SV so that it will be released when
6058 * the interpreter goes away.) */
00ab59c9 6059# define MY_CXT_INIT \
53d44271 6060 my_cxt_t *my_cxtp = \
9f6df31a
Z
6061 (my_cxt_t*)Perl_my_cxt_init(aTHX_ MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
6062 PERL_UNUSED_VAR(my_cxtp)
00ab59c9 6063# define MY_CXT_INIT_INTERP(my_perl) \
53d44271 6064 my_cxt_t *my_cxtp = \
9f6df31a
Z
6065 (my_cxt_t*)Perl_my_cxt_init(my_perl, MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
6066 PERL_UNUSED_VAR(my_cxtp)
53d44271
JH
6067
6068/* This declaration should be used within all functions that use the
6069 * interpreter-local data. */
00ab59c9 6070# define dMY_CXT \
53d44271 6071 my_cxt_t *my_cxtp = (my_cxt_t *)PL_my_cxt_list[MY_CXT_INDEX]
00ab59c9 6072# define dMY_CXT_INTERP(my_perl) \
53d44271
JH
6073 my_cxt_t *my_cxtp = (my_cxt_t *)(my_perl)->Imy_cxt_list[MY_CXT_INDEX]
6074
6075/* Clones the per-interpreter data. */
00ab59c9 6076# define MY_CXT_CLONE \
53d44271 6077 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1));\
8b573070 6078 void * old_my_cxtp = PL_my_cxt_list[MY_CXT_INDEX]; \
ccaa51ca
DD
6079 PL_my_cxt_list[MY_CXT_INDEX] = my_cxtp; \
6080 Copy(old_my_cxtp, my_cxtp, 1, my_cxt_t);
6081
53d44271 6082
53d44271 6083
89ca4ac7 6084/* This macro must be used to access members of the my_cxt_t structure.
870598ae 6085 * e.g. MY_CXT.some_data */
00ab59c9 6086# define MY_CXT (*my_cxtp)
89ca4ac7
JH
6087
6088/* Judicious use of these macros can reduce the number of times dMY_CXT
6089 * is used. Use is similar to pTHX, aTHX etc. */
00ab59c9
DM
6090# define pMY_CXT my_cxt_t *my_cxtp
6091# define pMY_CXT_ pMY_CXT,
6092# define _pMY_CXT ,pMY_CXT
6093# define aMY_CXT my_cxtp
6094# define aMY_CXT_ aMY_CXT,
6095# define _aMY_CXT ,aMY_CXT
89ca4ac7 6096
f16dd614 6097#else /* PERL_IMPLICIT_CONTEXT */
89ca4ac7 6098
00ab59c9
DM
6099# define START_MY_CXT static my_cxt_t my_cxt;
6100# define dMY_CXT_SV dNOOP
6101# define dMY_CXT dNOOP
6102# define dMY_CXT_INTERP(my_perl) dNOOP
6103# define MY_CXT_INIT NOOP
6104# define MY_CXT_CLONE NOOP
6105# define MY_CXT my_cxt
6106
6107# define pMY_CXT void
6108# define pMY_CXT_
6109# define _pMY_CXT
6110# define aMY_CXT
6111# define aMY_CXT_
6112# define _aMY_CXT
89ca4ac7 6113
f16dd614 6114#endif /* !defined(PERL_IMPLICIT_CONTEXT) */
89ca4ac7 6115
9a34ef1d
GS
6116#ifdef I_FCNTL
6117# include <fcntl.h>
9a34ef1d
GS
6118#endif
6119
9cffb111
OS
6120#ifdef __Lynx__
6121# include <fcntl.h>
6122#endif
6123
3c0208ad
AB
6124#ifdef __amigaos4__
6125# undef FD_CLOEXEC /* a lie in AmigaOS */
6126#endif
6127
9a34ef1d
GS
6128#ifdef I_SYS_FILE
6129# include <sys/file.h>
6130#endif
6131
fa0a29af 6132#if defined(HAS_FLOCK) && !defined(HAS_FLOCK_PROTO)
2ef53570
JH
6133int flock(int fd, int op);
6134#endif
6135
fe52b3b7
GS
6136#ifndef O_RDONLY
6137/* Assume UNIX defaults */
6138# define O_RDONLY 0000
6139# define O_WRONLY 0001
6140# define O_RDWR 0002
6141# define O_CREAT 0100
6142#endif
9a34ef1d 6143
16fe6d59
GS
6144#ifndef O_BINARY
6145# define O_BINARY 0
6146#endif
6147
6148#ifndef O_TEXT
6149# define O_TEXT 0
6150#endif
6151
6ce75a77 6152#if O_TEXT != O_BINARY
38d96942 6153 /* If you have different O_TEXT and O_BINARY and you are a CRLF shop,
6ce75a77 6154 * that is, you are somehow DOSish. */
b6c36746
NC
6155# if defined(__HAIKU__) || defined(__VOS__) || defined(__CYGWIN__)
6156 /* Haiku has O_TEXT != O_BINARY but O_TEXT and O_BINARY have no effect;
6157 * Haiku is always UNIXoid (LF), not DOSish (CRLF). */
73250e76
JH
6158 /* VOS has O_TEXT != O_BINARY, and they have effect,
6159 * but VOS always uses LF, never CRLF. */
6ce75a77
JH
6160 /* If you have O_TEXT different from your O_BINARY but you still are
6161 * not a CRLF shop. */
35990314 6162# undef PERLIO_USING_CRLF
ec53fe4f
JH
6163# else
6164 /* If you really are DOSish. */
6165# define PERLIO_USING_CRLF 1
6ce75a77
JH
6166# endif
6167#endif
6168
4bc88a62
PS
6169#ifdef I_LIBUTIL
6170# include <libutil.h> /* setproctitle() in some FreeBSDs */
6171#endif
6172
b4748376 6173#ifndef EXEC_ARGV_CAST
360ea906 6174#define EXEC_ARGV_CAST(x) (char **)x
b4748376
NIS
6175#endif
6176
dd5dc04f
JH
6177#define IS_NUMBER_IN_UV 0x01 /* number within UV range (maybe not
6178 int). value returned in pointed-
6179 to UV */
6180#define IS_NUMBER_GREATER_THAN_UV_MAX 0x02 /* pointed to UV undefined */
d70489e1 6181#define IS_NUMBER_NOT_INT 0x04 /* saw . or E notation or infnan */
dd5dc04f
JH
6182#define IS_NUMBER_NEG 0x08 /* leading minus sign */
6183#define IS_NUMBER_INFINITY 0x10 /* this is big */
aa8b85de 6184#define IS_NUMBER_NAN 0x20 /* this is not */
3f7602fa 6185#define IS_NUMBER_TRAILING 0x40 /* number has trailing trash */
dd5dc04f
JH
6186
6187#define GROK_NUMERIC_RADIX(sp, send) grok_numeric_radix(sp, send)
6188
53305cf1
NC
6189/* Input flags: */
6190#define PERL_SCAN_ALLOW_UNDERSCORES 0x01 /* grok_??? accept _ in numbers */
a4c04bdc 6191#define PERL_SCAN_DISALLOW_PREFIX 0x02 /* grok_??? reject 0x in hex etc */
94dd8549 6192#define PERL_SCAN_SILENT_ILLDIGIT 0x04 /* grok_??? not warn about illegal digits */
02470786
KW
6193#define PERL_SCAN_SILENT_NON_PORTABLE 0x08 /* grok_??? not warn about very large
6194 numbers which are <= UV_MAX */
3f7602fa
TC
6195#define PERL_SCAN_TRAILING 0x10 /* grok_number_flags() allow trailing
6196 and set IS_NUMBER_TRAILING */
6197
53305cf1
NC
6198/* Output flags: */
6199#define PERL_SCAN_GREATER_THAN_UV_MAX 0x02 /* should this merge with above? */
6200
2c4f7f0e
DM
6201/* to let user control profiling */
6202#ifdef PERL_GPROF_CONTROL
6203extern void moncontrol(int);
6204#define PERL_GPROF_MONCONTROL(x) moncontrol(x)
6205#else
6206#define PERL_GPROF_MONCONTROL(x)
6207#endif
6208
ae0e3d3b
JH
6209#ifdef UNDER_CE
6210#include "wince.h"
6211#endif
6212
6213/* ISO 6429 NEL - C1 control NExt Line */
6214/* See http://www.unicode.org/unicode/reports/tr13/ */
ec34087a 6215#define NEXT_LINE_CHAR NEXT_LINE_NATIVE
ae0e3d3b 6216
479b2847
GS
6217#ifndef PIPESOCK_MODE
6218# define PIPESOCK_MODE
6219#endif
6220
460c8493
IZ
6221#ifndef SOCKET_OPEN_MODE
6222# define SOCKET_OPEN_MODE PIPESOCK_MODE
6223#endif
6224
6225#ifndef PIPE_OPEN_MODE
6226# define PIPE_OPEN_MODE PIPESOCK_MODE
6227#endif
6228
7e8c5dac
HS
6229#define PERL_MAGIC_UTF8_CACHESIZE 2
6230
a05d7ebb
JH
6231#define PERL_UNICODE_STDIN_FLAG 0x0001
6232#define PERL_UNICODE_STDOUT_FLAG 0x0002
6233#define PERL_UNICODE_STDERR_FLAG 0x0004
a05d7ebb
JH
6234#define PERL_UNICODE_IN_FLAG 0x0008
6235#define PERL_UNICODE_OUT_FLAG 0x0010
06e66572 6236#define PERL_UNICODE_ARGV_FLAG 0x0020
a05d7ebb
JH
6237#define PERL_UNICODE_LOCALE_FLAG 0x0040
6238#define PERL_UNICODE_WIDESYSCALLS_FLAG 0x0080 /* for Sarathy */
5a22a2bb 6239#define PERL_UNICODE_UTF8CACHEASSERT_FLAG 0x0100
a05d7ebb 6240
06e66572
JH
6241#define PERL_UNICODE_STD_FLAG \
6242 (PERL_UNICODE_STDIN_FLAG | \
6243 PERL_UNICODE_STDOUT_FLAG | \
6244 PERL_UNICODE_STDERR_FLAG)
6245
6246#define PERL_UNICODE_INOUT_FLAG \
6247 (PERL_UNICODE_IN_FLAG | \
6248 PERL_UNICODE_OUT_FLAG)
6249
6250#define PERL_UNICODE_DEFAULT_FLAGS \
a05d7ebb
JH
6251 (PERL_UNICODE_STD_FLAG | \
6252 PERL_UNICODE_INOUT_FLAG | \
6253 PERL_UNICODE_LOCALE_FLAG)
6254
5a22a2bb 6255#define PERL_UNICODE_ALL_FLAGS 0x01ff
a05d7ebb
JH
6256
6257#define PERL_UNICODE_STDIN 'I'
6258#define PERL_UNICODE_STDOUT 'O'
6259#define PERL_UNICODE_STDERR 'E'
6260#define PERL_UNICODE_STD 'S'
6261#define PERL_UNICODE_IN 'i'
6262#define PERL_UNICODE_OUT 'o'
6263#define PERL_UNICODE_INOUT 'D'
6264#define PERL_UNICODE_ARGV 'A'
6265#define PERL_UNICODE_LOCALE 'L'
6266#define PERL_UNICODE_WIDESYSCALLS 'W'
5a22a2bb 6267#define PERL_UNICODE_UTF8CACHEASSERT 'a'
a05d7ebb 6268
4ffa73a3
JH
6269#define PERL_SIGNALS_UNSAFE_FLAG 0x0001
6270
32fdb065 6271/* Use instead of abs() since abs() forces its argument to be an int,
56c380de 6272 * but also beware since this evaluates its argument twice, so no x++. */
32fdb065
JH
6273#define PERL_ABS(x) ((x) < 0 ? -(x) : (x))
6274
3c0f78ca
JH
6275#if defined(__DECC) && defined(__osf__)
6276#pragma message disable (mainparm) /* Perl uses the envp in main(). */
24801a4b
JH
6277#endif
6278
e4dba786
NC
6279#define do_open(g, n, l, a, rm, rp, sf) \
6280 do_openn(g, n, l, a, rm, rp, sf, (SV **) NULL, 0)
9555a685 6281#ifdef PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
711aba4c 6282# define do_exec(cmd) do_exec3(cmd,0,0)
a9f96b3f 6283#endif
15871fce
NC
6284#ifdef OS2
6285# define do_aexec Perl_do_aexec
6286#else
6287# define do_aexec(really, mark,sp) do_aexec5(really, mark, sp, 0, 0)
9555a685 6288#endif
e4dba786 6289
c8028aa6
TC
6290/* check embedded \0 characters in pathnames passed to syscalls,
6291 but allow one ending \0 */
41188aa0 6292#define IS_SAFE_SYSCALL(p, len, what, op_name) (S_is_safe_syscall(aTHX_ (p), (len), (what), (op_name)))
c8028aa6 6293
41188aa0 6294#define IS_SAFE_PATHNAME(p, len, op_name) IS_SAFE_SYSCALL((p), (len), "pathname", (op_name))
c8028aa6 6295
53e89cff 6296#if defined(OEMVS) || defined(__amigaos4__)
2f3efc97
JH
6297#define NO_ENV_ARRAY_IN_MAIN
6298#endif
6299
00f254e2
KW
6300/* These are used by Perl_pv_escape() and Perl_pv_pretty()
6301 * are here so that they are available throughout the core
10edeb5d
JH
6302 * NOTE that even though some are for _escape and some for _pretty
6303 * there must not be any clashes as the flags from _pretty are
6304 * passed straight through to _escape.
6305 */
6306
4420a417 6307#define PERL_PV_ESCAPE_QUOTE 0x000001
10edeb5d
JH
6308#define PERL_PV_PRETTY_QUOTE PERL_PV_ESCAPE_QUOTE
6309
4420a417
YO
6310#define PERL_PV_PRETTY_ELLIPSES 0x000002
6311#define PERL_PV_PRETTY_LTGT 0x000004
6312#define PERL_PV_PRETTY_EXACTSIZE 0x000008
10edeb5d 6313
4420a417
YO
6314#define PERL_PV_ESCAPE_UNI 0x000100
6315#define PERL_PV_ESCAPE_UNI_DETECT 0x000200
6316#define PERL_PV_ESCAPE_NONASCII 0x000400
6317#define PERL_PV_ESCAPE_FIRSTCHAR 0x000800
10edeb5d 6318
4420a417
YO
6319#define PERL_PV_ESCAPE_ALL 0x001000
6320#define PERL_PV_ESCAPE_NOBACKSLASH 0x002000
6321#define PERL_PV_ESCAPE_NOCLEAR 0x004000
6322#define PERL_PV_PRETTY_NOCLEAR PERL_PV_ESCAPE_NOCLEAR
6323#define PERL_PV_ESCAPE_RE 0x008000
10edeb5d 6324
4420a417 6325#define PERL_PV_ESCAPE_DWIM 0x010000
0eb335df 6326
881a015e 6327
10edeb5d 6328/* used by pv_display in dump.c*/
95b611b0 6329#define PERL_PV_PRETTY_DUMP PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE
c89df6cf 6330#define PERL_PV_PRETTY_REGPROP PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_LTGT|PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII
10edeb5d 6331
a7157111
JH
6332#if DOUBLEKIND == DOUBLE_IS_VAX_F_FLOAT || \
6333 DOUBLEKIND == DOUBLE_IS_VAX_D_FLOAT || \
6334 DOUBLEKIND == DOUBLE_IS_VAX_G_FLOAT
6335# define DOUBLE_IS_VAX_FLOAT
6336#else
6337# define DOUBLE_IS_IEEE_FORMAT
6338#endif
6339
3fd106b1
JH
6340#if DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN || \
6341 DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN || \
6342 DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
6343# define DOUBLE_LITTLE_ENDIAN
6344#endif
6345
075bc527
JH
6346#if DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN || \
6347 DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN || \
6348 DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
6349# define DOUBLE_BIG_ENDIAN
6350#endif
6351
804d4e64
JH
6352#if DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE || \
6353 DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
6354# define DOUBLE_MIX_ENDIAN
6355#endif
6356
60d50332
JH
6357/* The VAX fp formats are neither consistently little-endian nor
6358 * big-endian, and neither are they really IEEE-mixed endian like
6359 * the mixed-endian ARM IEEE formats (with swapped bytes).
e90f8530 6360 * Ultimately, the VAX format came from the PDP-11.
60d50332
JH
6361 *
6362 * The ordering of the parts in VAX floats is quite vexing.
6363 * In the below the fraction_n are the mantissa bits.
df127a67 6364 *
60d50332 6365 * The fraction_1 is the most significant (numbering as by DEC/Digital),
6ce22998
JH
6366 * while the rightmost bit in each fraction is the least significant:
6367 * in other words, big-endian bit order within the fractions.
df127a67 6368 *
6ce22998 6369 * The fraction segments themselves would be big-endianly, except that
df127a67 6370 * within 32 bit segments the less significant half comes first, the more
6ce22998 6371 * significant after, except that in the format H (used for long doubles)
df127a67 6372 * the first fraction segment is alone, because the exponent is wider.
6ce22998
JH
6373 * This means for example that both the most and the least significant
6374 * bits can be in the middle of the floats, not at either end.
6375 *
6376 * References:
6377 * http://nssdc.gsfc.nasa.gov/nssdc/formats/VAXFloatingPoint.htm
6378 * http://www.quadibloc.com/comp/cp0201.htm
6379 * http://h71000.www7.hp.com/doc/82final/6443/6443pro_028.html
6380 * (somebody at HP should be fired for the URLs)
60d50332 6381 *
df127a67 6382 * F fraction_2:16 sign:1 exp:8 fraction_1:7
e90f8530 6383 * (exponent bias 128, hidden first one-bit)
60d50332 6384 *
df127a67 6385 * D fraction_2:16 sign:1 exp:8 fraction_1:7
60d50332 6386 * fraction_4:16 fraction_3:16
e90f8530 6387 * (exponent bias 128, hidden first one-bit)
60d50332 6388 *
6ce22998 6389 * G fraction_2:16 sign:1 exp:11 fraction_1:4
60d50332 6390 * fraction_4:16 fraction_3:16
e90f8530 6391 * (exponent bias 1024, hidden first one-bit)
60d50332
JH
6392 *
6393 * H fraction_1:16 sign:1 exp:15
6394 * fraction_3:16 fraction_2:16
6395 * fraction_5:16 fraction_4:16
6396 * fraction_7:16 fraction_6:16
e90f8530
JH
6397 * (exponent bias 16384, hidden first one-bit)
6398 * (available only on VAX, and only on Fortran?)
6399 *
6400 * The formats S, T and X are available on the Alpha (and Itanium,
6401 * also known as I64/IA64) and are equivalent with the IEEE-754 formats
6402 * binary32, binary64, and binary128 (commonly: float, double, long double).
6403 *
6404 * S sign:1 exp:8 mantissa:23
6405 * (exponent bias 127, hidden first one-bit)
6406 *
6407 * T sign:1 exp:11 mantissa:52
6408 * (exponent bias 1022, hidden first one-bit)
6409 *
6410 * X sign:1 exp:15 mantissa:112
6411 * (exponent bias 16382, hidden first one-bit)
60d50332 6412 *
60d50332 6413 */
a7157111
JH
6414
6415#ifdef DOUBLE_IS_VAX_FLOAT
6416# define DOUBLE_VAX_ENDIAN
6417#endif
6418
6419#ifdef DOUBLE_IS_IEEE_FORMAT
63a6ab05 6420/* All the basic IEEE formats have the implicit bit,
b6d9b423
JH
6421 * except for the x86 80-bit extended formats, which will undef this.
6422 * Also note that the IEEE 754 subnormals (formerly known as denormals)
6423 * do not have the implicit bit of one. */
a7157111
JH
6424# define NV_IMPLICIT_BIT
6425#endif
63a6ab05 6426
a7157111 6427#if defined(LONG_DOUBLEKIND) && LONG_DOUBLEKIND != LONG_DOUBLE_IS_DOUBLE
3fd106b1
JH
6428
6429# if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN || \
6430 LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
1f02ab1d 6431 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
3fd106b1
JH
6432# define LONGDOUBLE_LITTLE_ENDIAN
6433# endif
6434
6435# if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN || \
6436 LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN || \
1f02ab1d 6437 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
3fd106b1
JH
6438# define LONGDOUBLE_BIG_ENDIAN
6439# endif
6440
1f02ab1d
JH
6441# if LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
6442 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
6443# define LONGDOUBLE_MIX_ENDIAN
6444# endif
6445
3fd106b1
JH
6446# if LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
6447 LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
6448# define LONGDOUBLE_X86_80_BIT
63a6ab05
JH
6449# ifdef USE_LONG_DOUBLE
6450# undef NV_IMPLICIT_BIT
f40ac91c 6451# define NV_X86_80_BIT
63a6ab05 6452# endif
3fd106b1
JH
6453# endif
6454
1f02ab1d
JH
6455# if LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE || \
6456 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE || \
6457 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
6458 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
3fd106b1
JH
6459# define LONGDOUBLE_DOUBLEDOUBLE
6460# endif
6461
2c7d9883
JH
6462# if LONG_DOUBLEKIND == LONG_DOUBLE_IS_VAX_H_FLOAT
6463# define LONGDOUBLE_VAX_ENDIAN
6464# endif
6465
f03a9d38 6466#endif /* LONG_DOUBLEKIND */
3fd106b1 6467
9e76e8dd
JH
6468#ifdef USE_QUADMATH /* assume quadmath endianness == native double endianness */
6469# if defined(DOUBLE_LITTLE_ENDIAN)
6470# define NV_LITTLE_ENDIAN
6471# elif defined(DOUBLE_BIG_ENDIAN)
6472# define NV_BIG_ENDIAN
6473# elif defined(DOUBLE_MIX_ENDIAN) /* stretch */
6474# define NV_MIX_ENDIAN
6475# endif
6476#elif NVSIZE == DOUBLESIZE
d701dd28
JH
6477# ifdef DOUBLE_LITTLE_ENDIAN
6478# define NV_LITTLE_ENDIAN
6479# endif
6480# ifdef DOUBLE_BIG_ENDIAN
6481# define NV_BIG_ENDIAN
6482# endif
804d4e64
JH
6483# ifdef DOUBLE_MIX_ENDIAN
6484# define NV_MIX_ENDIAN
6485# endif
a7157111
JH
6486# ifdef DOUBLE_VAX_ENDIAN
6487# define NV_VAX_ENDIAN
6488# endif
d701dd28
JH
6489#elif NVSIZE == LONG_DOUBLESIZE
6490# ifdef LONGDOUBLE_LITTLE_ENDIAN
6491# define NV_LITTLE_ENDIAN
6492# endif
6493# ifdef LONGDOUBLE_BIG_ENDIAN
6494# define NV_BIG_ENDIAN
6495# endif
1f02ab1d
JH
6496# ifdef LONGDOUBLE_MIX_ENDIAN
6497# define NV_MIX_ENDIAN
6498# endif
2c7d9883
JH
6499# ifdef LONGDOUBLE_VAX_ENDIAN
6500# define NV_VAX_ENDIAN
6501# endif
d701dd28
JH
6502#endif
6503
488307ff
S
6504/* We have somehow managed not to define the denormal/subnormal
6505 * detection.
6506 *
6507 * This may happen if the compiler doesn't expose the C99 math like
6508 * the fpclassify() without some special switches. Perl tries to
6509 * stay C89, so for example -std=c99 is not an option.
6510 *
6511 * The Perl_isinf() and Perl_isnan() should have been defined even if
6512 * the C99 isinf() and isnan() are unavailable, and the NV_MIN becomes
6513 * from the C89 DBL_MIN or moral equivalent. */
6514#if !defined(Perl_fp_class_denorm) && defined(Perl_isinf) && defined(Perl_isnan) && defined(NV_MIN)
6515# define Perl_fp_class_denorm(x) ((x) != 0.0 && !Perl_isinf(x) && !Perl_isnan(x) && PERL_ABS(x) < NV_MIN)
6516#endif
6517
6518/* This is not a great fallback: subnormals tests will fail,
6519 * but at least Perl will link and 99.999% of tests will work. */
6520#if !defined(Perl_fp_class_denorm)
6521# define Perl_fp_class_denorm(x) FALSE
6522#endif
6523
a7157111
JH
6524#ifdef DOUBLE_IS_IEEE_FORMAT
6525# define DOUBLE_HAS_INF
6526# define DOUBLE_HAS_NAN
6527#endif
6528
6529#ifdef DOUBLE_HAS_NAN
6530
9ee3aea9
JH
6531#ifdef DOINIT
6532
6533/* PL_inf and PL_nan initialization.
6534 *
6535 * For inf and nan initialization the ultimate fallback is dividing
6536 * one or zero by zero: however, some compilers will warn or even fail
6537 * on divide-by-zero, but hopefully something earlier will work.
6538 *
6539 * If you are thinking of using HUGE_VAL for infinity, or using
6540 * <math.h> functions to generate NV_INF (e.g. exp(1e9), log(-1.0)),
6541 * stop. Neither will work portably: HUGE_VAL can be just DBL_MAX,
6542 * and the math functions might be just generating DBL_MAX, or even zero.
6543 *
6544 * Also, do NOT try doing NV_NAN based on NV_INF and trying (NV_INF-NV_INF).
6545 * Though logically correct, some compilers (like Visual C 2003)
6546 * falsely misoptimize that to zero (x-x is always zero, right?)
6547 *
6548 * Finally, note that not all floating point formats define Inf (or NaN).
6549 * For the infinity a large number may be used instead. Operations that
6550 * under the IEEE floating point would return Inf or NaN may return
6551 * either large numbers (positive or negative), or they may cause
6552 * a floating point exception or some other fault.
6553 */
6554
6555/* The quadmath literals are anon structs which -Wc++-compat doesn't like. */
6556GCC_DIAG_IGNORE(-Wc++-compat)
6557
6558# ifdef USE_QUADMATH
6559/* Cannot use HUGE_VALQ for PL_inf because not a compile-time
6560 * constant. */
6561INFNAN_NV_U8_DECL PL_inf = { 1.0Q/0.0Q };
6562# elif NVSIZE == LONG_DOUBLESIZE && defined(LONGDBLINFBYTES)
6563INFNAN_U8_NV_DECL PL_inf = { { LONGDBLINFBYTES } };
6564# elif NVSIZE == DOUBLESIZE && defined(DOUBLEINFBYTES)
6565INFNAN_U8_NV_DECL PL_inf = { { DOUBLEINFBYTES } };
6566# else
6567# if NVSIZE == LONG_DOUBLESIZE && defined(USE_LONG_DOUBLE)
6568# if defined(LDBL_INFINITY)
6569INFNAN_NV_U8_DECL PL_inf = { LDBL_INFINITY };
6570# elif defined(LDBL_INF)
6571INFNAN_NV_U8_DECL PL_inf = { LDBL_INF };
6572# elif defined(INFINITY)
6573INFNAN_NV_U8_DECL PL_inf = { (NV)INFINITY };
6574# elif defined(INF)
6575INFNAN_NV_U8_DECL PL_inf = { (NV)INF };
6576# else
6577INFNAN_NV_U8_DECL PL_inf = { 1.0L/0.0L }; /* keep last */
6578# endif
6579# else
6580# if defined(DBL_INFINITY)
6581INFNAN_NV_U8_DECL PL_inf = { DBL_INFINITY };
6582# elif defined(DBL_INF)
6583INFNAN_NV_U8_DECL PL_inf = { DBL_INF };
6584# elif defined(INFINITY) /* C99 */
6585INFNAN_NV_U8_DECL PL_inf = { (NV)INFINITY };
6586# elif defined(INF)
6587INFNAN_NV_U8_DECL PL_inf = { (NV)INF };
6588# else
6589INFNAN_NV_U8_DECL PL_inf = { 1.0/0.0 }; /* keep last */
6590# endif
6591# endif
6592# endif
6593
6594# ifdef USE_QUADMATH
6595/* Cannot use nanq("0") for PL_nan because not a compile-time
6596 * constant. */
6597INFNAN_NV_U8_DECL PL_nan = { 0.0Q/0.0Q };
6598# elif NVSIZE == LONG_DOUBLESIZE && defined(LONGDBLNANBYTES)
6599INFNAN_U8_NV_DECL PL_nan = { { LONGDBLNANBYTES } };
6600# elif NVSIZE == DOUBLESIZE && defined(DOUBLENANBYTES)
6601INFNAN_U8_NV_DECL PL_nan = { { DOUBLENANBYTES } };
6602# else
6603# if NVSIZE == LONG_DOUBLESIZE && defined(USE_LONG_DOUBLE)
6604# if defined(LDBL_NAN)
6605INFNAN_NV_U8_DECL PL_nan = { LDBL_NAN };
6606# elif defined(LDBL_QNAN)
6607INFNAN_NV_U8_DECL PL_nan = { LDBL_QNAN };
6608# elif defined(NAN)
6609INFNAN_NV_U8_DECL PL_nan = { (NV)NAN };
6610# else
6611INFNAN_NV_U8_DECL PL_nan = { 0.0L/0.0L }; /* keep last */
6612# endif
6613# else
6614# if defined(DBL_NAN)
6615INFNAN_NV_U8_DECL PL_nan = { DBL_NAN };
6616# elif defined(DBL_QNAN)
6617INFNAN_NV_U8_DECL PL_nan = { DBL_QNAN };
6618# elif defined(NAN) /* C99 */
6619INFNAN_NV_U8_DECL PL_nan = { (NV)NAN };
6620# else
6621INFNAN_NV_U8_DECL PL_nan = { 0.0/0.0 }; /* keep last */
6622# endif
6623# endif
6624# endif
6625
6626GCC_DIAG_RESTORE
6627
6628#else
6629
6630INFNAN_NV_U8_DECL PL_inf;
6631INFNAN_NV_U8_DECL PL_nan;
6632
6633#endif
6634
6635/* If you have not defined NV_INF/NV_NAN (like for example win32/win32.h),
6636 * we will define NV_INF/NV_NAN as the nv part of the global const
6637 * PL_inf/PL_nan. Note, however, that the preexisting NV_INF/NV_NAN
6638 * might not be a compile-time constant, in which case it cannot be
6639 * used to initialize PL_inf/PL_nan above. */
6640#ifndef NV_INF
6641# define NV_INF PL_inf.nv
6642#endif
6643#ifndef NV_NAN
6644# define NV_NAN PL_nan.nv
6645#endif
6646
5c255b3b
JH
6647/* NaNs (not-a-numbers) can carry payload bits, in addition to
6648 * "nan-ness". Part of the payload is the quiet/signaling bit.
6649 * To back up a bit (harhar):
6650 *
6651 * For IEEE 754 64-bit formats [1]:
6652 *
6653 * s 000 (mantissa all-zero) zero
6654 * s 000 (mantissa non-zero) subnormals (denormals)
6655 * s 001 ... 7fe normals
6656 * s 7ff q nan
6657 *
6658 * For IEEE 754 128-bit formats:
6659 *
6660 * s 0000 (mantissa all-zero) zero
6661 * s 0000 (mantissa non-zero) subnormals (denormals)
6662 * s 0001 ... 7ffe normals
6663 * s 7fff q nan
6664 *
6665 * [1] this looks like big-endian, but applies equally to little-endian.
6666 *
6667 * s = Sign bit. Yes, zeros and nans can have negative sign,
6668 * the interpretation is application-specific.
6669 *
6670 * q = Quietness bit, the interpretation is platform-specific.
453b60f1 6671 * Most platforms have the most significant bit being one
5c255b3b
JH
6672 * meaning quiet, but some (older mips, hppa) have the msb
6673 * being one meaning signaling. Note that the above means
6674 * that on most platforms there cannot be signaling nan with
453b60f1
JH
6675 * zero payload because that is identical with infinity;
6676 * while conversely on older mips/hppa there cannot be a quiet nan
6677 * because that is identical with infinity.
6678 *
6679 * Moreover, whether there is any behavioral difference
6680 * between quiet and signaling NaNs, depends on the platform.
5c255b3b
JH
6681 *
6682 * x86 80-bit extended precision is different, the mantissa bits:
6683 *
6684 * 63 62 61 30387+ pre-387 visual c
6685 * -------- ---- -------- --------
6686 * 0 0 0 invalid infinity
6687 * 0 0 1 invalid snan
6688 * 0 1 0 invalid snan
6689 * 0 1 1 invalid snan
6690 * 1 0 0 infinity snan 1.#INF
6691 * 1 0 1 snan 1.#SNAN
6692 * 1 1 0 qnan -1.#IND (x86 chooses this to negative)
6693 * 1 1 1 qnan 1.#QNAN
6694 *
6695 * This means that in this format there are 61 bits available
6696 * for the nan payload.
6697 *
3bbe6a60
JH
6698 * Note that the 32-bit x86 ABI cannot do signaling nans: the x87
6699 * simply cannot preserve the bit. You can either use the 80-bit
6700 * extended precision (long double, -Duselongdouble), or use x86-64.
6701 *
453b60f1
JH
6702 * In all platforms, the payload bytes (and bits, some of them are
6703 * often in a partial byte) themselves can be either all zero (x86),
6704 * all one (sparc or mips), or a mixture: in IEEE 754 128-bit double
6705 * or in a double-double, the first half of the payload can follow the
6706 * native double, while in the second half the payload can be all
6707 * zeros. (Therefore the mask for payload bits is not necessarily
6708 * identical to bit complement of the NaN.) Another way of putting
6709 * this: the payload for the default NaN might not be zero.
6710 *
6711 * For the x86 80-bit long doubles, the trailing bytes (the 80 bits
6712 * being 'packaged' in either 12 or 16 bytes) can be whatever random
6713 * garbage.
6714 *
6715 * Furthermore, the semantics of the sign bit on NaNs are platform-specific.
6716 * On normal floats, the sign bit being on means negative. But this may,
6717 * or may not, be reverted on NaNs: in other words, the default NaN might
6718 * have the sign bit on, and therefore look like negative if you look
6719 * at it at the bit level.
6720 *
6721 * NaN payloads are not propagated even on copies, or in arithmetics.
6722 * They *might* be, according to some rules, on your particular
6723 * cpu/os/compiler/libraries, but no guarantees.
6724 *
6725 * To summarize, on most platforms, and for 64-bit doubles
6726 * (using big-endian ordering here):
6727 *
6728 * [7FF8000000000000..7FFFFFFFFFFFFFFF] quiet
6729 * [FFF8000000000000..FFFFFFFFFFFFFFFF] quiet
6730 * [7FF0000000000001..7FF7FFFFFFFFFFFF] signaling
6731 * [FFF0000000000001..FFF7FFFFFFFFFFFF] signaling
6732 *
6733 * The C99 nan() is supposed to generate *quiet* NaNs.
6734 *
6735 * Note the asymmetry:
6736 * The 7FF0000000000000 is positive infinity,
6737 * the FFF0000000000000 is negative infinity.
6738 */
6739
6740/* NVMANTBITS is the number of _real_ mantissa bits in an NV.
5a14060a
JH
6741 * For the standard IEEE 754 fp this number is usually one less that
6742 * *DBL_MANT_DIG because of the implicit (aka hidden) bit, which isn't
6743 * real. For the 80-bit extended precision formats (x86*), the number
6744 * of mantissa bits... depends. For normal floats, it's 64. But for
6745 * the inf/nan, it's different (zero for inf, 61 for nan).
6746 * NVMANTBITS works for normal floats. */
6747
6748/* We do not want to include the quiet/signaling bit. */
6749#define NV_NAN_BITS (NVMANTBITS - 1)
5c255b3b 6750
f37aa828
JH
6751#if defined(USE_LONG_DOUBLE) && NVSIZE > DOUBLESIZE
6752# if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
6753# define NV_NAN_QS_BYTE_OFFSET 13
6754# elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
6755# define NV_NAN_QS_BYTE_OFFSET 2
6756# elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN
6757# define NV_NAN_QS_BYTE_OFFSET 7
6758# elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
6759# define NV_NAN_QS_BYTE_OFFSET 2
1f02ab1d 6760# elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
f37aa828 6761# define NV_NAN_QS_BYTE_OFFSET 13
1f02ab1d 6762# elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
f37aa828 6763# define NV_NAN_QS_BYTE_OFFSET 1
1f02ab1d
JH
6764# elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE
6765# define NV_NAN_QS_BYTE_OFFSET 9
6766# elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
6767# define NV_NAN_QS_BYTE_OFFSET 6
f37aa828
JH
6768# else
6769# error "Unexpected long double format"
6770# endif
6771#else
6772# ifdef USE_QUADMATH
6773# ifdef NV_LITTLE_ENDIAN
6774# define NV_NAN_QS_BYTE_OFFSET 13
6775# elif defined(NV_BIG_ENDIAN)
6776# define NV_NAN_QS_BYTE_OFFSET 2
6777# else
6778# error "Unexpected quadmath format"
6779# endif
6780# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN
6781# define NV_NAN_QS_BYTE_OFFSET 2
6782# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN
6783# define NV_NAN_QS_BYTE_OFFSET 1
6784# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN
6785# define NV_NAN_QS_BYTE_OFFSET 6
6786# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN
6787# define NV_NAN_QS_BYTE_OFFSET 1
6788# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
6789# define NV_NAN_QS_BYTE_OFFSET 13
6790# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
6791# define NV_NAN_QS_BYTE_OFFSET 2
6792# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE
6793# define NV_NAN_QS_BYTE_OFFSET 2 /* bytes 4 5 6 7 0 1 2 3 (MSB 7) */
6794# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
6795# define NV_NAN_QS_BYTE_OFFSET 5 /* bytes 3 2 1 0 7 6 5 4 (MSB 7) */
6796# else
a7157111
JH
6797/* For example the VAX formats should never
6798 * get here because they do not have NaN. */
f37aa828
JH
6799# error "Unexpected double format"
6800# endif
6801#endif
6802/* NV_NAN_QS_BYTE is the byte to test for the quiet/signaling */
6803#define NV_NAN_QS_BYTE(nvp) (((U8*)(nvp))[NV_NAN_QS_BYTE_OFFSET])
6804/* NV_NAN_QS_BIT is the bit to test in the NV_NAN_QS_BYTE_OFFSET
6805 * for the quiet/signaling */
6806#if defined(USE_LONG_DOUBLE) && \
6807 (LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
6808 LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN)
6809# define NV_NAN_QS_BIT_SHIFT 6 /* 0x40 */
6810#elif defined(USE_LONG_DOUBLE) && \
1f02ab1d
JH
6811 (LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE || \
6812 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE || \
6813 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
6814 LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE)
5a14060a 6815# define NV_NAN_QS_BIT_SHIFT 3 /* 0x08, but not via NV_NAN_BITS */
f37aa828 6816#else
5a14060a 6817# define NV_NAN_QS_BIT_SHIFT ((NV_NAN_BITS) % 8) /* usually 3, or 0x08 */
f37aa828
JH
6818#endif
6819#define NV_NAN_QS_BIT (1 << (NV_NAN_QS_BIT_SHIFT))
6820/* NV_NAN_QS_BIT_OFFSET is the bit offset from the beginning of a NV
6821 * (bytes ordered big-endianly) for the quiet/signaling bit
6822 * for the quiet/signaling */
6823#define NV_NAN_QS_BIT_OFFSET \
6824 (8 * (NV_NAN_QS_BYTE_OFFSET) + (NV_NAN_QS_BIT_SHIFT))
8122f9aa
JH
6825/* NV_NAN_QS_QUIET (always defined) is true if the NV_NAN_QS_QS_BIT being
6826 * on indicates quiet NaN. NV_NAN_QS_SIGNALING (also always defined)
6827 * is true if the NV_NAN_QS_BIT being on indicates signaling NaN. */
f37aa828
JH
6828#define NV_NAN_QS_QUIET \
6829 ((NV_NAN_QS_BYTE(PL_nan.u8) & NV_NAN_QS_BIT) == NV_NAN_QS_BIT)
6830#define NV_NAN_QS_SIGNALING (!(NV_NAN_QS_QUIET))
6831#define NV_NAN_QS_TEST(nvp) (NV_NAN_QS_BYTE(nvp) & NV_NAN_QS_BIT)
6832/* NV_NAN_IS_QUIET() returns true if the NV behind nvp is a NaN,
6833 * whether it is a quiet NaN, NV_NAN_IS_SIGNALING() if a signaling NaN.
6834 * Note however that these do not check whether the nvp is a NaN. */
6835#define NV_NAN_IS_QUIET(nvp) \
6836 (NV_NAN_QS_TEST(nvp) == (NV_NAN_QS_QUIET ? NV_NAN_QS_BIT : 0))
6837#define NV_NAN_IS_SIGNALING(nvp) \
6838 (NV_NAN_QS_TEST(nvp) == (NV_NAN_QS_QUIET ? 0 : NV_NAN_QS_BIT))
6839#define NV_NAN_SET_QUIET(nvp) \
6840 (NV_NAN_QS_QUIET ? \
6841 (NV_NAN_QS_BYTE(nvp) |= NV_NAN_QS_BIT) : \
6842 (NV_NAN_QS_BYTE(nvp) &= ~NV_NAN_QS_BIT))
6843#define NV_NAN_SET_SIGNALING(nvp) \
6844 (NV_NAN_QS_QUIET ? \
6845 (NV_NAN_QS_BYTE(nvp) &= ~NV_NAN_QS_BIT) : \
6846 (NV_NAN_QS_BYTE(nvp) |= NV_NAN_QS_BIT))
6847#define NV_NAN_QS_XOR(nvp) (NV_NAN_QS_BYTE(nvp) ^= NV_NAN_QS_BIT)
6848
d3137b5f
JH
6849/* NV_NAN_PAYLOAD_MASK: masking the nan payload bits.
6850 *
6851 * NV_NAN_PAYLOAD_PERM: permuting the nan payload bytes.
6852 * 0xFF means "don't go here".*/
6853
6854/* Shorthands to avoid typoses. */
1f02ab1d
JH
6855#define NV_NAN_PAYLOAD_MASK_SKIP_EIGHT \
6856 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0
6857#define NV_NAN_PAYLOAD_PERM_SKIP_EIGHT \
6858 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
d3137b5f
JH
6859#define NV_NAN_PAYLOAD_PERM_0_TO_7 \
6860 0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7
6861#define NV_NAN_PAYLOAD_PERM_7_TO_0 \
6862 0x7, 0x6, 0x5, 0x4, 0x3, 0x2, 0x1, 0x0
6863#define NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE \
6864 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
6865 0xff, 0xff, 0xff, 0xff, 0xff, 0x7f, 0x00, 0x00
6866#define NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE \
6867 NV_NAN_PAYLOAD_PERM_0_TO_7, \
6868 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xFF, 0xFF
6869#define NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE \
6870 0x00, 0x00, 0x7f, 0xff, 0xff, 0xff, 0xff, 0xff, \
6871 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
6872#define NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE \
6873 0xFF, 0xFF, 0xd, 0xc, 0xb, 0xa, 0x9, 0x8, \
6874 NV_NAN_PAYLOAD_PERM_7_TO_0
6875#define NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE \
6876 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x07, 0x00
6877#define NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE \
6878 0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0xFF
6879#define NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE \
6880 0x00, 0x07, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
6881#define NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE \
6882 0xFF, 0x6, 0x5, 0x4, 0x3, 0x2, 0x1, 0x0
6883
6884#if defined(USE_LONG_DOUBLE) && NVSIZE > DOUBLESIZE
6885# if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
6886# define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
6887# define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
6888# elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
6889# define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
6890# define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
6891# elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN
a7ab4d96
JH
6892# if LONG_DOUBLESIZE == 10
6893# define NV_NAN_PAYLOAD_MASK \
6894 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
6895 0x00, 0x00
6896# define NV_NAN_PAYLOAD_PERM \
6897 NV_NAN_PAYLOAD_PERM_0_TO_7, 0xFF, 0xFF
6898# elif LONG_DOUBLESIZE == 12
d3137b5f
JH
6899# define NV_NAN_PAYLOAD_MASK \
6900 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
6901 0x00, 0x00, 0x00, 0x00
6902# define NV_NAN_PAYLOAD_PERM \
6903 NV_NAN_PAYLOAD_PERM_0_TO_7, 0xFF, 0xFF, 0xFF, 0xFF
6904# elif LONG_DOUBLESIZE == 16
6905# define NV_NAN_PAYLOAD_MASK \
6906 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
6907 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
6908# define NV_NAN_PAYLOAD_PERM \
6909 NV_NAN_PAYLOAD_PERM_0_TO_7, \
6910 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
6911# else
6912# error "Unexpected x86 80-bit little-endian long double format"
6913# endif
6914# elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
a7ab4d96
JH
6915# if LONG_DOUBLESIZE == 10
6916# define NV_NAN_PAYLOAD_MASK \
6917 0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
6918 0xff, 0xff
6919# define NV_NAN_PAYLOAD_PERM \
6920 NV_NAN_PAYLOAD_PERM_7_TO_0, 0xFF, 0xFF
6921# elif LONG_DOUBLESIZE == 12
d3137b5f
JH
6922# define NV_NAN_PAYLOAD_MASK \
6923 0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
6924 0xff, 0xff, 0x00, 0x00
6925# define NV_NAN_PAYLOAD_PERM \
6926 NV_NAN_PAYLOAD_PERM_7_TO_0, 0xFF, 0xFF, 0xFF, 0xFF
6927# elif LONG_DOUBLESIZE == 16
6928# define NV_NAN_PAYLOAD_MASK \
6929 0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
6930 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
6931# define NV_NAN_PAYLOAD_PERM \
6932 NV_NAN_PAYLOAD_PERM_7_TO_0, \
6933 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
6934# else
a7ab4d96 6935# error "Unexpected x86 80-bit big-endian long double format"
d3137b5f 6936# endif
1f02ab1d
JH
6937# elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
6938/* For double-double we assume only the first double (in LE or BE terms)
6939 * is used for NaN. */
d3137b5f 6940# define NV_NAN_PAYLOAD_MASK \
1f02ab1d 6941 NV_NAN_PAYLOAD_MASK_SKIP_EIGHT, NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
d3137b5f 6942# define NV_NAN_PAYLOAD_PERM \
1f02ab1d
JH
6943 NV_NAN_PAYLOAD_PERM_SKIP_EIGHT, NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
6944# elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
d3137b5f
JH
6945# define NV_NAN_PAYLOAD_MASK \
6946 NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
6947# define NV_NAN_PAYLOAD_PERM \
6948 NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
1f02ab1d
JH
6949# elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE
6950# define NV_NAN_PAYLOAD_MASK \
6951 NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
6952# define NV_NAN_PAYLOAD_PERM \
6953 NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
6954# elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
6955# define NV_NAN_PAYLOAD_MASK \
6956 NV_NAN_PAYLOAD_MASK_SKIP_EIGHT, NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
6957# define NV_NAN_PAYLOAD_PERM \
6958 NV_NAN_PAYLOAD_PERM_SKIP_EIGHT, NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
d3137b5f
JH
6959# else
6960# error "Unexpected long double format"
6961# endif
6962#else
6963# ifdef USE_QUADMATH /* quadmath is not long double */
6964# ifdef NV_LITTLE_ENDIAN
6965# define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
6966# define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
6967# elif defined(NV_BIG_ENDIAN)
6968# define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
6969# define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
6970# else
6971# error "Unexpected quadmath format"
6972# endif
6973# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN
6974# define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0x07, 0x00
6975# define NV_NAN_PAYLOAD_PERM 0x0, 0x1, 0x2, 0xFF
6976# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN
6977# define NV_NAN_PAYLOAD_MASK 0x00, 0x07, 0xff, 0xff
6978# define NV_NAN_PAYLOAD_PERM 0xFF, 0x2, 0x1, 0x0
6979# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN
6980# define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
6981# define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
6982# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN
6983# define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
6984# define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
6985# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
6986# define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
6987# define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
6988# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
6989# define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
6990# define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
6991# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE
6992# define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0x07, 0x00, 0xff, 0xff, 0xff, 0xff
6993# define NV_NAN_PAYLOAD_PERM 0x4, 0x5, 0x6, 0xFF, 0x0, 0x1, 0x2, 0x3
6994# elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
6995# define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0xff, 0xff, 0x00, 0x07, 0xff, 0xff
6996# define NV_NAN_PAYLOAD_PERM 0x3, 0x2, 0x1, 0x0, 0xFF, 0x6, 0x5, 0x4
6997# else
6998# error "Unexpected double format"
6999# endif
7000#endif
a7157111
JH
7001
7002#endif /* DOUBLE_HAS_NAN */
7003
21553840 7004
10edeb5d
JH
7005/*
7006
7007 (KEEP THIS LAST IN perl.h!)
7008
7009 Mention
d460ef45 7010
43999f95 7011 NV_PRESERVES_UV
fe749a9f 7012
fe749a9f
JH
7013 HAS_MKSTEMP
7014 HAS_MKSTEMPS
7015 HAS_MKDTEMP
7016
49dabb45
JH
7017 HAS_GETCWD
7018
d59b5429 7019 HAS_MMAP
fe749a9f
JH
7020 HAS_MPROTECT
7021 HAS_MSYNC
1e8c3fde 7022 HAS_MADVISE
fe749a9f
JH
7023 HAS_MUNMAP
7024 I_SYSMMAN
7025 Mmap_t
7026
6b4667fc
A
7027 NVef
7028 NVff
7029 NVgf
7030
4e0554ec 7031 HAS_UALARM
2d736872 7032 HAS_USLEEP
4e0554ec
JH
7033
7034 HAS_SETITIMER
7035 HAS_GETITIMER
7036
7037 HAS_SENDMSG
7038 HAS_RECVMSG
7039 HAS_READV
7040 HAS_WRITEV
7041 I_SYSUIO
7042 HAS_STRUCT_MSGHDR
7043 HAS_STRUCT_CMSGHDR
7044
2765b840 7045 HAS_NL_LANGINFO
0a7020c9 7046
ae0e3d3b 7047 HAS_DIRFD
2765b840 7048
10edeb5d 7049 so that Configure picks them up.
ab3bbdeb 7050
10edeb5d 7051 (KEEP THIS LAST IN perl.h!)
3df15adc 7052
10edeb5d 7053*/
3df15adc 7054
85e6fe83 7055#endif /* Include guard */
e9a8c099
MHM
7056
7057/*
14d04a33 7058 * ex: set ts=8 sts=4 sw=4 et:
e9a8c099 7059 */