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