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