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