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