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