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