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