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