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