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