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