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