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