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