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
PATCH: [perl #133988], Assertion failure
[perl5.git] / perl.h
CommitLineData
a0d0e21e 1/* perl.h
a687059c 2 *
1129b882 3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
5cd3f21a 4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
a687059c 5 *
352d5a3a
LW		 6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8d063cd8 8 *
8d063cd8 9 */
d6376244 10
85e6fe83
LW		 11#ifndef H_PERL
12#define H_PERL 1
8d063cd8 13
760ac839
LW		 14#ifdef PERL_FOR_X2P
15/*
d460ef45 16 * This file is being used for x2p stuff.
760ac839 17 * Above symbol is defined via -D in 'x2p/Makefile.SH'
d460ef45 18 * Decouple x2p stuff from some of perls more extreme eccentricities.
760ac839 19 */
55497cff 20#undef MULTIPLICITY
760ac839
LW		 21#undef USE_STDIO
22#define USE_STDIO
23#endif /* PERL_FOR_X2P */
24
d460ef45 25#ifdef PERL_MICRO
12ae5dfc
JH		 26# include "uconfig.h"
27#else
611cf957 28# include "config.h"
12ae5dfc 29#endif
0cb96387 30
70febf4f
CB		 31/* this is used for functions which take a depth trailing
32 * argument under debugging */
33#ifdef DEBUGGING
34#define _pDEPTH ,U32 depth
35#define _aDEPTH ,depth
36#else
37#define _pDEPTH
38#define _aDEPTH
39#endif
40
7dc3eb73 41/* NOTE 1: that with gcc -std=c89 the __STDC_VERSION__ is *not* defined
9267464d 42 * because the __STDC_VERSION__ became a thing only with C90. Therefore,
7dc3eb73
JH		 43 * with gcc, HAS_C99 will never become true as long as we use -std=c89.
44
45 * NOTE 2: headers lie. Do not expect that if HAS_C99 gets to be true,
46 * all the C99 features are there and are correct. */
9267464d 47#if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || \
996959af 48 defined(_STDC_C99) || defined(__c99)
86a3cabf 49# define HAS_C99 1
86a3cabf
JH		 50#endif
51
2c2d71f5
JH		 52/* See L<perlguts/"The Perl API"> for detailed notes on
53 * PERL_IMPLICIT_CONTEXT and PERL_IMPLICIT_SYS */
54
7ee02ac1 55/* XXX NOTE that from here --> to <-- the same logic is
ac6bedea
JH		 56 * repeated in makedef.pl, so be certain to update
57 * both places when editing. */
58
6f4183fe 59#ifdef USE_ITHREADS
acfe0abc 60# if !defined(MULTIPLICITY)
6f4183fe
GS		 61# define MULTIPLICITY
62# endif
63#endif
64
27da23d5
JH		 65#ifdef PERL_GLOBAL_STRUCT_PRIVATE
66# ifndef PERL_GLOBAL_STRUCT
67# define PERL_GLOBAL_STRUCT
68# endif
69#endif
97aff369 70
27da23d5
JH		 71#ifdef PERL_GLOBAL_STRUCT
72# ifndef MULTIPLICITY
73# define MULTIPLICITY
74# endif
75#endif
76
97aff369
JH		 77#ifdef MULTIPLICITY
78# ifndef PERL_IMPLICIT_CONTEXT
79# define PERL_IMPLICIT_CONTEXT
80# endif
81#endif
82
026fd48b
GH		 83/* undef WIN32 when building on Cygwin (for libwin32) - gph */
84#ifdef __CYGWIN__
85# undef WIN32
86# undef _WIN32
87#endif
88
27da23d5
JH		 89#if defined(__SYMBIAN32__) || (defined(__VC32__) && defined(WINS))
90# ifndef SYMBIAN
91# define SYMBIAN
92# endif
93#endif
94
a0fd4948 95#ifdef __SYMBIAN32__
27da23d5
JH		 96# include "symbian/symbian_proto.h"
97#endif
98
99/* Any stack-challenged places. The limit varies (and often
100 * is configurable), but using more than a kilobyte of stack
101 * is usually dubious in these systems. */
739a0b84
NC		 102#if defined(__SYMBIAN32__)
103/* Symbian: need to work around the SDK features. *
27da23d5
JH		 104 * On WINS: MS VC5 generates calls to _chkstk, *
105 * if a "large" stack frame is allocated. *
106 * gcc on MARM does not generate calls like these. */
107# define USE_HEAP_INSTEAD_OF_STACK
108#endif
109
dd134d2c 110/* Use the reentrant APIs like localtime_r and getpwent_r */
7ee02ac1
KW		 111/* Win32 has naturally threadsafe libraries, no need to use any _r variants.
112 * XXX KEEP makedef.pl copy of this code in sync */
14795193 113#if defined(USE_ITHREADS) && !defined(USE_REENTRANT_API) && !defined(NETWARE) && !defined(WIN32)
10bc17b6
JH		 114# define USE_REENTRANT_API
115#endif
116
ac6bedea
JH		 117/* <--- here ends the logic shared by perl.h and makedef.pl */
118
9ea40801
SH		 119/* Microsoft Visual C++ 6.0 needs special treatment in numerous places */
120#if defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1200 && _MSC_VER < 1300
121# define USING_MSVC6
122#endif
123
cf5a8da6
MHM		 124#undef START_EXTERN_C
125#undef END_EXTERN_C
126#undef EXTERN_C
127#ifdef __cplusplus
128# define START_EXTERN_C extern "C" {
129# define END_EXTERN_C }
130# define EXTERN_C extern "C"
131#else
132# define START_EXTERN_C
133# define END_EXTERN_C
134# define EXTERN_C extern
135#endif
136
17a6c8e3
AD		 137/* Fallback definitions in case we don't have definitions from config.h.
138 This should only matter for systems that don't use Configure and
139 haven't been modified to define PERL_STATIC_INLINE yet.
140*/
141#if !defined(PERL_STATIC_INLINE)
142# ifdef HAS_STATIC_INLINE
143# define PERL_STATIC_INLINE static inline
144# else
145# define PERL_STATIC_INLINE static
146# endif
147#endif
148
da5fdda8 149#if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GET_VARS)
27da23d5 150# ifdef PERL_GLOBAL_STRUCT_PRIVATE
cf5a8da6 151 EXTERN_C struct perl_vars* Perl_GetVarsPrivate();
27da23d5 152# define PERL_GET_VARS() Perl_GetVarsPrivate() /* see miniperlmain.c */
27da23d5
JH		 153# else
154# define PERL_GET_VARS() PL_VarsPtr
155# endif
27da23d5
JH		 156#endif
157
f0e5c859
DD		 158/* this used to be off by default, now its on, see perlio.h */
159#define PERLIO_FUNCS_CONST
160
5aaab254 161#define pVAR struct perl_vars* my_vars PERL_UNUSED_DECL
27da23d5
JH		 162
163#ifdef PERL_GLOBAL_STRUCT
164# define dVAR pVAR = (struct perl_vars*)PERL_GET_VARS()
165#else
166# define dVAR dNOOP
167#endif
168
c5be433b 169#ifdef PERL_IMPLICIT_CONTEXT
3db8f154
MB		 170# ifndef MULTIPLICITY
171# define MULTIPLICITY
c5be433b 172# endif
e8dda941 173# define tTHX PerlInterpreter*
5aaab254 174# define pTHX tTHX my_perl PERL_UNUSED_DECL
3db8f154 175# define aTHX my_perl
9399a70c 176# define aTHXa(a) aTHX = (tTHX)a
27da23d5 177# ifdef PERL_GLOBAL_STRUCT
e8dda941 178# define dTHXa(a) dVAR; pTHX = (tTHX)a
27da23d5 179# else
e8dda941 180# define dTHXa(a) pTHX = (tTHX)a
27da23d5
JH		 181# endif
182# ifdef PERL_GLOBAL_STRUCT
183# define dTHX dVAR; pTHX = PERL_GET_THX
184# else
185# define dTHX pTHX = PERL_GET_THX
186# endif
c5be433b 187# define pTHX_ pTHX,
c5be433b 188# define aTHX_ aTHX,
4373e329 189# define pTHX_1 2
894356b3
GS		 190# define pTHX_2 3
191# define pTHX_3 4
192# define pTHX_4 5
4373e329
AL		 193# define pTHX_5 6
194# define pTHX_6 7
a3b680e6
AL		 195# define pTHX_7 8
196# define pTHX_8 9
197# define pTHX_9 10
a6fc70e5 198# define pTHX_12 13
e8dda941
JD		 199# if defined(DEBUGGING) && !defined(PERL_TRACK_MEMPOOL)
200# define PERL_TRACK_MEMPOOL
201# endif
202#else
203# undef PERL_TRACK_MEMPOOL
c5be433b
GS		 204#endif
205
2d17fb74
KW		 206#ifdef DEBUGGING
207# define dTHX_DEBUGGING dTHX
208#else
209# define dTHX_DEBUGGING dNOOP
210#endif
211
76e3520e 212#define STATIC static
16c91539
BM		 213
214#ifndef PERL_CORE
215/* Do not use these macros. They were part of PERL_OBJECT, which was an
216 * implementation of multiplicity using C++ objects. They have been left
217 * here solely for the sake of XS code which has incorrectly
218 * cargo-culted them.
219 */
76e3520e 220#define CPERLscope(x) x
565764a8 221#define CPERLarg void
76e3520e 222#define CPERLarg_
e3b8966e 223#define _CPERLarg
1d583055
GS		 224#define PERL_OBJECT_THIS
225#define _PERL_OBJECT_THIS
226#define PERL_OBJECT_THIS_
312caa8e 227#define CALL_FPTR(fptr) (*fptr)
ef69c8fc 228#define MEMBER_TO_FPTR(name) name
16c91539 229#endif /* !PERL_CORE */
76e3520e 230
16c91539 231#define CALLRUNOPS PL_runops
f9f4320a 232
3ab4a224 233#define CALLREGCOMP(sv, flags) Perl_pregcomp(aTHX_ (sv),(flags))
f9f4320a 234
16c91539 235#define CALLREGCOMP_ENG(prog, sv, flags) (prog)->comp(aTHX_ sv, flags)
a340edde 236#define CALLREGEXEC(prog,stringarg,strend,strbeg,minend,sv,data,flags) \
16c91539 237 RX_ENGINE(prog)->exec(aTHX_ (prog),(stringarg),(strend), \
a340edde 238 (strbeg),(minend),(sv),(data),(flags))
52a21eb3
DM		 239#define CALLREG_INTUIT_START(prog,sv,strbeg,strpos,strend,flags,data) \
240 RX_ENGINE(prog)->intuit(aTHX_ (prog), (sv), (strbeg), (strpos), \
f9f4320a
YO		 241 (strend),(flags),(data))
242#define CALLREG_INTUIT_STRING(prog) \
16c91539 243 RX_ENGINE(prog)->checkstr(aTHX_ (prog))
f8149455 244
f8149455
YO		 245#define CALLREGFREE(prog) \
246 Perl_pregfree(aTHX_ (prog))
247
248#define CALLREGFREE_PVT(prog) \
4c8117d3 249 if(prog && RX_ENGINE(prog)) RX_ENGINE(prog)->rxfree(aTHX_ (prog))
f8149455 250
2fdbfb4d 251#define CALLREG_NUMBUF_FETCH(rx,paren,usesv) \
16c91539 252 RX_ENGINE(rx)->numbered_buff_FETCH(aTHX_ (rx),(paren),(usesv))
93b32b6d 253
2fdbfb4d 254#define CALLREG_NUMBUF_STORE(rx,paren,value) \
16c91539 255 RX_ENGINE(rx)->numbered_buff_STORE(aTHX_ (rx),(paren),(value))
2fdbfb4d
AB		 256
257#define CALLREG_NUMBUF_LENGTH(rx,sv,paren) \
16c91539 258 RX_ENGINE(rx)->numbered_buff_LENGTH(aTHX_ (rx),(sv),(paren))
2fdbfb4d 259
192b9cd1 260#define CALLREG_NAMED_BUFF_FETCH(rx, key, flags) \
16c91539 261 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_FETCH))
192b9cd1
AB		 262
263#define CALLREG_NAMED_BUFF_STORE(rx, key, value, flags) \
16c91539 264 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), (value), ((flags) | RXapif_STORE))
192b9cd1
AB		 265
266#define CALLREG_NAMED_BUFF_DELETE(rx, key, flags) \
16c91539 267 RX_ENGINE(rx)->named_buff(aTHX_ (rx),(key), NULL, ((flags) | RXapif_DELETE))
192b9cd1
AB		 268
269#define CALLREG_NAMED_BUFF_CLEAR(rx, flags) \
16c91539 270 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_CLEAR))
192b9cd1
AB		 271
272#define CALLREG_NAMED_BUFF_EXISTS(rx, key, flags) \
16c91539 273 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_EXISTS))
192b9cd1
AB		 274
275#define CALLREG_NAMED_BUFF_FIRSTKEY(rx, flags) \
16c91539 276 RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), NULL, ((flags) | RXapif_FIRSTKEY))
192b9cd1
AB		 277
278#define CALLREG_NAMED_BUFF_NEXTKEY(rx, lastkey, flags) \
16c91539 279 RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), (lastkey), ((flags) | RXapif_NEXTKEY))
192b9cd1
AB		 280
281#define CALLREG_NAMED_BUFF_SCALAR(rx, flags) \
16c91539 282 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_SCALAR))
192b9cd1
AB		 283
284#define CALLREG_NAMED_BUFF_COUNT(rx) \
16c91539 285 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, RXapif_REGNAMES_COUNT)
192b9cd1
AB		 286
287#define CALLREG_NAMED_BUFF_ALL(rx, flags) \
16c91539 288 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, flags)
93b32b6d 289
49d7dfbc 290#define CALLREG_PACKAGE(rx) \
16c91539 291 RX_ENGINE(rx)->qr_package(aTHX_ (rx))
93b32b6d 292
00f254e2 293#if defined(USE_ITHREADS)
f9f4320a 294#define CALLREGDUPE(prog,param) \
f8149455
YO		 295 Perl_re_dup(aTHX_ (prog),(param))
296
297#define CALLREGDUPE_PVT(prog,param) \
16c91539 298 (prog ? RX_ENGINE(prog)->dupe(aTHX_ (prog),(param)) \
00f254e2 299 : (REGEXP *)NULL)
f9f4320a 300#endif
14dd3ad8 301
a20207d7 302
bcdf7404 303
a20207d7
YO		 304
305
5ba4cab2
SH		 306/*
307 * Because of backward compatibility reasons the PERL_UNUSED_DECL
308 * cannot be changed from postfix to PERL_UNUSED_DECL(x). Sigh.
309 *
310 * Note that there are C compilers such as MetroWerks CodeWarrior
1266ad8c 311 * which do not have an "inlined" way (like the gcc __attribute__) of
5ba4cab2
SH		 312 * marking unused variables (they need e.g. a #pragma) and therefore
313 * cpp macros like PERL_UNUSED_DECL cannot work for this purpose, even
314 * if it were PERL_UNUSED_DECL(x), which it cannot be (see above).
315 *
316 */
1266ad8c 317
9969cdde 318#if defined(__SYMBIAN32__) && defined(__GNUC__)
5b2bd0a5 319# ifdef __cplusplus
5ba4cab2 320# define PERL_UNUSED_DECL
5b2bd0a5 321# else
5ba4cab2 322# define PERL_UNUSED_DECL __attribute__((unused))
5b2bd0a5
AMS		 323# endif
324#endif
44dbb695 325
5b2bd0a5 326#ifndef PERL_UNUSED_DECL
98d1c64e 327# if defined(HASATTRIBUTE_UNUSED) && (!defined(__cplusplus) || __GNUC__ >= 4)
5ba4cab2 328# define PERL_UNUSED_DECL __attribute__unused__
b79c357a 329# else
5ba4cab2 330# define PERL_UNUSED_DECL
b79c357a 331# endif
5b2bd0a5 332#endif
00f254e2 333
349b520e
DM		 334/* gcc -Wall:
335 * for silencing unused variables that are actually used most of the time,
a730e3f2
JH		 336 * but we cannot quite get rid of, such as "ax" in PPCODE+noargs xsubs,
337 * or variables/arguments that are used only in certain configurations.
349b520e 338 */
53c1dcc0 339#ifndef PERL_UNUSED_ARG
c707756e 340# define PERL_UNUSED_ARG(x) ((void)sizeof(x))
ad73156c 341#endif
53c1dcc0 342#ifndef PERL_UNUSED_VAR
a730e3f2 343# define PERL_UNUSED_VAR(x) ((void)sizeof(x))
53c1dcc0 344#endif
ad73156c 345
23491f1d 346#if defined(USE_ITHREADS) || defined(PERL_GLOBAL_STRUCT)
96a5add6
AL		 347# define PERL_UNUSED_CONTEXT PERL_UNUSED_ARG(my_perl)
348#else
349# define PERL_UNUSED_CONTEXT
350#endif
351
24e7ff4e
JH		 352/* gcc (-ansi) -pedantic doesn't allow gcc statement expressions,
353 * g++ allows them but seems to have problems with them
354 * (insane errors ensue).
355 * g++ does not give insane errors now (RMB 2008-01-30, gcc 4.2.2).
356 */
357#if defined(PERL_GCC_PEDANTIC) || \
358 (defined(__GNUC__) && defined(__cplusplus) && \
359 ((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2))))
360# ifndef PERL_GCC_BRACE_GROUPS_FORBIDDEN
361# define PERL_GCC_BRACE_GROUPS_FORBIDDEN
362# endif
363#endif
364
ffea512f 365/* Use PERL_UNUSED_RESULT() to suppress the warnings about unused results
b469f1e0
JH		 366 * of function calls, e.g. PERL_UNUSED_RESULT(foo(a, b)).
367 *
368 * The main reason for this is that the combination of gcc -Wunused-result
369 * (part of -Wall) and the __attribute__((warn_unused_result)) cannot
370 * be silenced with casting to void. This causes trouble when the system
371 * header files use the attribute.
372 *
373 * Use PERL_UNUSED_RESULT sparingly, though, since usually the warning
374 * is there for a good reason: you might lose success/failure information,
375 * or leak resources, or changes in resources.
ffea512f
JH		 376 *
377 * But sometimes you just want to ignore the return value, e.g. on
b469f1e0
JH		 378 * codepaths soon ending up in abort, or in "best effort" attempts,
379 * or in situations where there is no good way to handle failures.
ffea512f 380 *
b469f1e0
JH		 381 * Sometimes PERL_UNUSED_RESULT might not be the most natural way:
382 * another possibility is that you can capture the return value
383 * and use PERL_UNUSED_VAR on that.
ffea512f 384 *
b469f1e0
JH		 385 * The __typeof__() is used instead of typeof() since typeof() is not
386 * available under strict C89, and because of compilers masquerading
387 * as gcc (clang and icc), we want exactly the gcc extension
388 * __typeof__ and nothing else.
ffea512f
JH		 389 */
390#ifndef PERL_UNUSED_RESULT
b469f1e0
JH		 391# if defined(__GNUC__) && defined(HASATTRIBUTE_WARN_UNUSED_RESULT)
392# define PERL_UNUSED_RESULT(v) STMT_START { __typeof__(v) z = (v); (void)sizeof(z); } STMT_END
ffea512f
JH		 393# else
394# define PERL_UNUSED_RESULT(v) ((void)(v))
395# endif
396#endif
397
b56aac20
DM		 398/* on gcc (and clang), specify that a warning should be temporarily
399 * ignored; e.g.
400 *
7347ee54 401 * GCC_DIAG_IGNORE_DECL(-Wmultichar);
b56aac20 402 * char b = 'ab';
7347ee54 403 * GCC_DIAG_RESTORE_DECL;
b56aac20
DM		 404 *
405 * based on http://dbp-consulting.com/tutorials/SuppressingGCCWarnings.html
406 *
407 * Note that "pragma GCC diagnostic push/pop" was added in GCC 4.6, Mar 2011;
408 * clang only pretends to be GCC 4.2, but still supports push/pop.
c1d6452f 409 *
7347ee54
Z		 410 * Note on usage: all macros must be used at a place where a declaration
411 * or statement can occur, i.e., not in the middle of an expression.
412 * *_DIAG_IGNORE() and *_DIAG_RESTORE can be used in any such place, but
413 * must be used without a following semicolon. *_DIAG_IGNORE_DECL() and
414 * *_DIAG_RESTORE_DECL must be used with a following semicolon, and behave
415 * syntactically as declarations (like dNOOP). *_DIAG_IGNORE_STMT()
416 * and *_DIAG_RESTORE_STMT must be used with a following semicolon,
417 * and behave syntactically as statements (like NOOP).
c1d6452f 418 *
b56aac20
DM		 419 */
420
57d4b8c5 421#if defined(__clang__) || defined(__clang) || \
d28ce8b4 422 (defined( __GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406)
c1d6452f
JH		 423# define GCC_DIAG_PRAGMA(x) _Pragma (#x)
424/* clang has "clang diagnostic" pragmas, but also understands gcc. */
b56aac20 425# define GCC_DIAG_IGNORE(x) _Pragma("GCC diagnostic push") \
c1d6452f 426 GCC_DIAG_PRAGMA(GCC diagnostic ignored #x)
b56aac20
DM		 427# define GCC_DIAG_RESTORE _Pragma("GCC diagnostic pop")
428#else
8ce6f80a
JH		 429# define GCC_DIAG_IGNORE(w)
430# define GCC_DIAG_RESTORE
b56aac20 431#endif
7347ee54
Z		 432#define GCC_DIAG_IGNORE_DECL(x) GCC_DIAG_IGNORE(x) dNOOP
433#define GCC_DIAG_RESTORE_DECL GCC_DIAG_RESTORE dNOOP
434#define GCC_DIAG_IGNORE_STMT(x) GCC_DIAG_IGNORE(x) NOOP
435#define GCC_DIAG_RESTORE_STMT GCC_DIAG_RESTORE NOOP
337458b1
JH		 436/* for clang specific pragmas */
437#if defined(__clang__) || defined(__clang)
438# define CLANG_DIAG_PRAGMA(x) _Pragma (#x)
439# define CLANG_DIAG_IGNORE(x) _Pragma("clang diagnostic push") \
440 CLANG_DIAG_PRAGMA(clang diagnostic ignored #x)
441# define CLANG_DIAG_RESTORE _Pragma("clang diagnostic pop")
442#else
443# define CLANG_DIAG_IGNORE(w)
444# define CLANG_DIAG_RESTORE
445#endif
7347ee54
Z		 446#define CLANG_DIAG_IGNORE_DECL(x) CLANG_DIAG_IGNORE(x) dNOOP
447#define CLANG_DIAG_RESTORE_DECL CLANG_DIAG_RESTORE dNOOP
448#define CLANG_DIAG_IGNORE_STMT(x) CLANG_DIAG_IGNORE(x) NOOP
449#define CLANG_DIAG_RESTORE_STMT CLANG_DIAG_RESTORE NOOP
b56aac20 450
6f207bd3 451#define NOOP /*EMPTY*/(void)0
91ca80c3 452#define dNOOP struct Perl___notused_struct
71be2cbc 453
0cb96387 454#ifndef pTHX
a78adc84 455/* Don't bother defining tTHX ; using it outside
e8dda941
JD		 456 * code guarded by PERL_IMPLICIT_CONTEXT is an error.
457 */
0cb96387
GS		 458# define pTHX void
459# define pTHX_
0cb96387
GS		 460# define aTHX
461# define aTHX_
9399a70c 462# define aTHXa(a) NOOP
0cb96387
GS		 463# define dTHXa(a) dNOOP
464# define dTHX dNOOP
894356b3
GS		 465# define pTHX_1 1
466# define pTHX_2 2
467# define pTHX_3 3
468# define pTHX_4 4
3d42dc86
RGS		 469# define pTHX_5 5
470# define pTHX_6 6
a3b680e6
AL		 471# define pTHX_7 7
472# define pTHX_8 8
473# define pTHX_9 9
a6fc70e5 474# define pTHX_12 12
0cb96387
GS		 475#endif
476
27da23d5
JH		 477#ifndef dVAR
478# define dVAR dNOOP
479#endif
480
b4f7f263
GS		 481/* these are only defined for compatibility; should not be used internally */
482#if !defined(pTHXo) && !defined(PERL_CORE)
0cb96387
GS		 483# define pTHXo pTHX
484# define pTHXo_ pTHX_
0cb96387
GS		 485# define aTHXo aTHX
486# define aTHXo_ aTHX_
c5be433b 487# define dTHXo dTHX
71d280e3 488# define dTHXoa(x) dTHXa(x)
0cb96387
GS		 489#endif
490
491#ifndef pTHXx
5aaab254 492# define pTHXx PerlInterpreter *my_perl
0cb96387 493# define pTHXx_ pTHXx,
0cb96387
GS		 494# define aTHXx my_perl
495# define aTHXx_ aTHXx,
c5be433b 496# define dTHXx dTHX
22c35a8c 497#endif
71be2cbc 498
1de7c2ac
GS		 499/* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
500 * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
501 * dTHXs is therefore needed for all functions using PerlIO_foo(). */
502#ifdef PERL_IMPLICIT_SYS
27da23d5
JH		 503# ifdef PERL_GLOBAL_STRUCT_PRIVATE
504# define dTHXs dVAR; dTHX
505# else
506# define dTHXs dTHX
507# endif
1de7c2ac 508#else
27da23d5
JH		 509# ifdef PERL_GLOBAL_STRUCT_PRIVATE
510# define dTHXs dVAR
511# else
512# define dTHXs dNOOP
513# endif
1de7c2ac
GS		 514#endif
515
5b692037
JH		 516#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
517# ifndef PERL_USE_GCC_BRACE_GROUPS
518# define PERL_USE_GCC_BRACE_GROUPS
519# endif
520#endif
521
728e2803
PP		 522/*
523 * STMT_START { statements; } STMT_END;
524 * can be used as a single statement, as in
525 * if (x) STMT_START { ... } STMT_END; else ...
526 *
527 * Trying to select a version that gives no warnings...
528 */
529#if !(defined(STMT_START) && defined(STMT_END))
5b692037 530# ifdef PERL_USE_GCC_BRACE_GROUPS
a0288114 531# define STMT_START (void)( /* gcc supports "({ STATEMENTS; })" */
728e2803
PP		 532# define STMT_END )
533# else
728e2803
PP		 534# define STMT_START do
535# define STMT_END while (0)
728e2803
PP		 536# endif
537#endif
538
d6f9c181
JH		 539#ifndef BYTEORDER /* Should never happen -- byteorder is in config.h */
540# define BYTEORDER 0x1234
79072805
LW		 541#endif
542
543/* Overall memory policy? */
544#ifndef CONSERVATIVE
545# define LIBERAL 1
546#endif
547
8ada0baa
JH		 548#if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
549#define ASCIIish
550#else
551#undef ASCIIish
552#endif
553
79072805
LW		 554/*
555 * The following contortions are brought to you on behalf of all the
556 * standards, semi-standards, de facto standards, not-so-de-facto standards
557 * of the world, as well as all the other botches anyone ever thought of.
558 * The basic theory is that if we work hard enough here, the rest of the
559 * code can be a lot prettier. Well, so much for theory. Sorry, Henry...
560 */
ac58e20f 561
ee0007ab 562/* define this once if either system, instead of cluttering up the src */
7c458fae 563#if defined(MSDOS) || defined(WIN32) || defined(NETWARE)
ee0007ab
LW		 564#define DOSISH 1
565#endif
566
3d97541c 567/* These exist only for back-compat with XS modules. */
8162b70e 568#ifndef PERL_CORE
516e10a9 569#define VOL volatile
3d97541c 570#define CAN_PROTOTYPE
ae75e3d0 571#define _(args) args
6c2ae642 572#define I_LIMITS
36a113ce 573#define I_STDARG
6c2ae642 574#define STANDARD_C
8162b70e 575#endif
663a0e37 576
284167a5
SM		 577/* By compiling a perl with -DNO_TAINT_SUPPORT or -DSILENT_NO_TAINT_SUPPORT,
578 * you get a perl without taint support, but doubtlessly with a lesser
579 * degree of support. Do not do so unless you know exactly what it means
580 * technically, have a good reason to do so, and know exactly how the
581 * perl will be used. perls with -DSILENT_NO_TAINT_SUPPORT are considered
582 * a potential security risk due to flat out ignoring the security-relevant
583 * taint flags. This being said, a perl without taint support compiled in
584 * has marginal run-time performance benefits.
585 * SILENT_NO_TAINT_SUPPORT implies NO_TAINT_SUPPORT.
586 * SILENT_NO_TAINT_SUPPORT is the same as NO_TAINT_SUPPORT except it
587 * silently ignores -t/-T instead of throwing an exception.
053a3618
SM		 588 *
589 * DANGER! Using NO_TAINT_SUPPORT or SILENT_NO_TAINT_SUPPORT
6ecb40c7 590 * voids your nonexistent warranty!
284167a5 591 */
dc6d7f5c 592#if defined(SILENT_NO_TAINT_SUPPORT) && !defined(NO_TAINT_SUPPORT)
284167a5
SM		 593# define NO_TAINT_SUPPORT 1
594#endif
595
596/* NO_TAINT_SUPPORT can be set to transform virtually all taint-related
597 * operations into no-ops for a very modest speed-up. Enable only if you
598 * know what you're doing: tests and CPAN modules' tests are bound to fail.
599 */
dc6d7f5c 600#ifdef NO_TAINT_SUPPORT
284167a5
SM		 601# define TAINT NOOP
602# define TAINT_NOT NOOP
603# define TAINT_IF(c) NOOP
604# define TAINT_ENV() NOOP
605# define TAINT_PROPER(s) NOOP
606# define TAINT_set(s) NOOP
607# define TAINT_get 0
608# define TAINTING_get 0
609# define TAINTING_set(s) NOOP
610# define TAINT_WARN_get 0
611# define TAINT_WARN_set(s) NOOP
612#else
d48c660d 613# define TAINT (PL_tainted = PL_tainting)
284167a5 614# define TAINT_NOT (PL_tainted = FALSE)
d48c660d 615# define TAINT_IF(c) if (UNLIKELY(c)) { PL_tainted = PL_tainting; }
2439e033
SM		 616# define TAINT_ENV() if (UNLIKELY(PL_tainting)) { taint_env(); }
617# define TAINT_PROPER(s) if (UNLIKELY(PL_tainting)) { taint_proper(NULL, s); }
284167a5
SM		 618# define TAINT_set(s) (PL_tainted = (s))
619# define TAINT_get (PL_tainted)
620# define TAINTING_get (PL_tainting)
621# define TAINTING_set(s) (PL_tainting = (s))
622# define TAINT_WARN_get (PL_taint_warn)
623# define TAINT_WARN_set(s) (PL_taint_warn = (s))
624#endif
a687059c 625
20be6587
DM		 626/* flags used internally only within pp_subst and pp_substcont */
627#ifdef PERL_CORE
628# define SUBST_TAINT_STR 1 /* string tainted */
629# define SUBST_TAINT_PAT 2 /* pattern tainted */
630# define SUBST_TAINT_REPL 4 /* replacement tainted */
631# define SUBST_TAINT_RETAINT 8 /* use re'taint' in scope */
632# define SUBST_TAINT_BOOLRET 16 /* return is boolean (don't taint) */
633#endif
634
d460ef45 635/* XXX All process group stuff is handled in pp_sys.c. Should these
a6e633de
PP		 636 defines move there? If so, I could simplify this a lot. --AD 9/96.
637*/
638/* Process group stuff changed from traditional BSD to POSIX.
639 perlfunc.pod documents the traditional BSD-style syntax, so we'll
640 try to preserve that, if possible.
641*/
642#ifdef HAS_SETPGID
643# define BSD_SETPGRP(pid, pgrp) setpgid((pid), (pgrp))
da5fdda8
AC		 644#elif defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
645# define BSD_SETPGRP(pid, pgrp) setpgrp((pid), (pgrp))
646#elif defined(HAS_SETPGRP2)
647# define BSD_SETPGRP(pid, pgrp) setpgrp2((pid), (pgrp))
a6e633de
PP		 648#endif
649#if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
650# define HAS_SETPGRP /* Well, effectively it does . . . */
651#endif
652
653/* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
654 our life easier :-) so we'll try it.
655*/
656#ifdef HAS_GETPGID
657# define BSD_GETPGRP(pid) getpgid((pid))
da5fdda8
AC		 658#elif defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
659# define BSD_GETPGRP(pid) getpgrp((pid))
660#elif defined(HAS_GETPGRP2)
661# define BSD_GETPGRP(pid) getpgrp2((pid))
a6e633de
PP		 662#endif
663#if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
664# define HAS_GETPGRP /* Well, effectively it does . . . */
665#endif
666
d460ef45 667/* These are not exact synonyms, since setpgrp() and getpgrp() may
a6e633de
PP		 668 have different behaviors, but perl.h used to define USE_BSDPGRP
669 (prior to 5.003_05) so some extension might depend on it.
670*/
671#if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
672# ifndef USE_BSDPGRP
673# define USE_BSDPGRP
674# endif
663a0e37
LW		 675#endif
676
486ec47a 677/* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
8ac5a1fe
MH		 678 pthread.h must be included before all other header files.
679*/
3db8f154 680#if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
8ac5a1fe
MH		 681# include <pthread.h>
682#endif
683
58ab9e8b 684#include <sys/types.h>
663a0e37 685
c7925a5e
DD		 686/* EVC 4 SDK headers includes a bad definition of MB_CUR_MAX in stdlib.h
687 which is included from stdarg.h. Bad definition not present in SD 2008
688 SDK headers. wince.h is not yet included, so we cant fix this from there
689 since by then MB_CUR_MAX will be defined from stdlib.h.
690 cewchar.h includes a correct definition of MB_CUR_MAX and it is copied here
691 since cewchar.h can't be included this early */
692#if defined(UNDER_CE) && (_MSC_VER < 1300)
5703b8ce 693# define MB_CUR_MAX 1uL
c7925a5e 694#endif
9d82a2b7
AC		 695
696# include <stdarg.h>
760ac839 697
27db2737
JH		 698#ifdef I_STDINT
699# include <stdint.h>
700#endif
701
fe14fcc3 702#include <ctype.h>
63b481b9
AC		 703#include <float.h>
704#include <limits.h>
a0d0e21e
LW		 705
706#ifdef METHOD /* Defined by OSF/1 v3.0 by ctype.h */
707#undef METHOD
a0d0e21e
LW		 708#endif
709
12ae5dfc
JH		 710#ifdef PERL_MICRO
711# define NO_LOCALE
712#endif
713
4633a7c4 714#ifdef I_LOCALE
36477c24 715# include <locale.h>
4633a7c4
LW		 716#endif
717
6ebbc862
KW		 718#ifdef I_XLOCALE
719# include <xlocale.h>
720#endif
721
aa8a2baa
KW		 722/* If not forbidden, we enable locale handling if either 1) the POSIX 2008
723 * functions are available, or 2) just the setlocale() function. This logic is
724 * repeated in t/loc_tools.pl and makedef.pl; The three should be kept in
725 * sync. */
726#if ! defined(NO_LOCALE)
727
728# if ! defined(NO_POSIX_2008_LOCALE) \
729 && defined(HAS_NEWLOCALE) \
730 && defined(HAS_USELOCALE) \
731 && defined(HAS_DUPLOCALE) \
732 && defined(HAS_FREELOCALE) \
733 && defined(LC_ALL_MASK)
734
735 /* For simplicity, the code is written to assume that any platform advanced
736 * enough to have the Posix 2008 locale functions has LC_ALL. The final
737 * test above makes sure that assumption is valid */
738
739# define HAS_POSIX_2008_LOCALE
740# define USE_LOCALE
741# elif defined(HAS_SETLOCALE)
742# define USE_LOCALE
743# endif
744#endif
745
746#ifdef USE_LOCALE
ccd65d51 747# define HAS_SKIP_LOCALE_INIT /* Solely for XS code to test for this
af573503 748 #define */
36477c24
PP		 749# if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
750 && defined(HAS_STRXFRM)
751# define USE_LOCALE_COLLATE
752# endif
753# if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
754# define USE_LOCALE_CTYPE
755# endif
756# if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
757# define USE_LOCALE_NUMERIC
758# endif
fa9b773e
KW		 759# if !defined(NO_LOCALE_MESSAGES) && defined(LC_MESSAGES)
760# define USE_LOCALE_MESSAGES
761# endif
762# if !defined(NO_LOCALE_MONETARY) && defined(LC_MONETARY)
763# define USE_LOCALE_MONETARY
764# endif
56e45410
KW		 765# if !defined(NO_LOCALE_TIME) && defined(LC_TIME)
766# define USE_LOCALE_TIME
767# endif
9821811f
KW		 768# if !defined(NO_LOCALE_ADDRESS) && defined(LC_ADDRESS)
769# define USE_LOCALE_ADDRESS
770# endif
771# if !defined(NO_LOCALE_IDENTIFICATION) && defined(LC_IDENTIFICATION)
772# define USE_LOCALE_IDENTIFICATION
773# endif
774# if !defined(NO_LOCALE_MEASUREMENT) && defined(LC_MEASUREMENT)
775# define USE_LOCALE_MEASUREMENT
776# endif
777# if !defined(NO_LOCALE_PAPER) && defined(LC_PAPER)
778# define USE_LOCALE_PAPER
779# endif
780# if !defined(NO_LOCALE_TELEPHONE) && defined(LC_TELEPHONE)
781# define USE_LOCALE_TELEPHONE
782# endif
a0d0e21e 783
5a53bf38
KW		 784/* XXX The next few defines are unfortunately duplicated in makedef.pl, and
785 * changes here MUST also be made there */
786
aa8a2baa
KW		 787# if ! defined(HAS_SETLOCALE) && defined(HAS_POSIX_2008_LOCALE)
788# define USE_POSIX_2008_LOCALE
789# ifndef USE_THREAD_SAFE_LOCALE
790# define USE_THREAD_SAFE_LOCALE
791# endif
e1895adc
KW		 792 /* If compiled with
793 * -DUSE_THREAD_SAFE_LOCALE, will do so even
794 * on unthreaded builds */
aa8a2baa
KW		 795# elif (defined(USE_ITHREADS) || defined(USE_THREAD_SAFE_LOCALE)) \
796 && ( defined(HAS_POSIX_2008_LOCALE) \
797 || (defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1400)) \
798 && ! defined(NO_THREAD_SAFE_LOCALE)
e1895adc
KW		 799# ifndef USE_THREAD_SAFE_LOCALE
800# define USE_THREAD_SAFE_LOCALE
801# endif
e9bc6d6b
KW		 802# ifdef HAS_POSIX_2008_LOCALE
803# define USE_POSIX_2008_LOCALE
804# endif
805# endif
7f9e9632
KW		 806#endif
807
69c5e0db
KW		 808/* Microsoft documentation reads in the change log for VS 2015:
809 * "The localeconv function declared in locale.h now works correctly when
810 * per-thread locale is enabled. In previous versions of the library, this
811 * function would return the lconv data for the global locale, not the
812 * thread's locale."
813 */
814#if defined(WIN32) && defined(USE_THREAD_SAFE_LOCALE) && _MSC_VER < 1900
815# define TS_W32_BROKEN_LOCALECONV
816#endif
817
fe14fcc3 818#include <setjmp.h>
79072805 819
a0d0e21e 820#ifdef I_SYS_PARAM
79072805
LW		 821# ifdef PARAM_NEEDS_TYPES
822# include <sys/types.h>
823# endif
824# include <sys/param.h>
352d5a3a 825#endif
79072805 826
ce3470dc
AD		 827/* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
828 value something like 199306. This may be useful if no more-specific
829 feature test is available.
830*/
831#if defined(BSD)
832# ifndef BSDish
833# define BSDish
834# endif
835#endif
836
dd512de3
AC		 837/* Use all the "standard" definitions */
838#include <stdlib.h>
03a14243 839
3f270f98
JH		 840/* If this causes problems, set i_unistd=undef in the hint file. */
841#ifdef I_UNISTD
763ee752
AB		 842# if defined(__amigaos4__)
843# ifdef I_NETINET_IN
844# include <netinet/in.h>
845# endif
846# endif
3f270f98 847# include <unistd.h>
6e3136a6
AB		 848# if defined(__amigaos4__)
849/* Under AmigaOS 4 newlib.library provides an environ. However using
850 * it doesn't give us enough control over inheritance of variables by
851 * subshells etc. so replace with custom version based on abc-shell
852 * code. */
853extern char **myenviron;
854# undef environ
855# define environ myenviron
856# endif
3f270f98
JH		 857#endif
858
de8ca8af
NT		 859/* for WCOREDUMP */
860#ifdef I_SYS_WAIT
861# include <sys/wait.h>
862#endif
863
9969cdde 864#ifdef __SYMBIAN32__
27da23d5
JH		 865# undef _SC_ARG_MAX /* Symbian has _SC_ARG_MAX but no sysconf() */
866#endif
867
21e89b5f 868#if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
c45598c5 869EXTERN_C int syscall(int, ...);
2ef53570
JH		 870#endif
871
21e89b5f 872#if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
c45598c5 873EXTERN_C int usleep(unsigned int);
2ef53570
JH		 874#endif
875
f2f9e01d
KW		 876/* macros for correct constant construction. These are in C99 <stdint.h>
877 * (so they will not be available in strict C89 mode), but they are nice, so
878 * let's define them if necessary. */
879#ifndef UINT16_C
880# if INTSIZE >= 2
881# define UINT16_C(x) ((U16_TYPE)x##U)
882# else
883# define UINT16_C(x) ((U16_TYPE)x##UL)
884# endif
885#endif
1109a392 886
f2f9e01d
KW		 887#ifndef UINT32_C
888# if INTSIZE >= 4
889# define UINT32_C(x) ((U32_TYPE)x##U)
890# else
891# define UINT32_C(x) ((U32_TYPE)x##UL)
892# endif
893#endif
1109a392 894
f2f9e01d
KW		 895#ifdef I_STDINT
896 typedef intmax_t PERL_INTMAX_T;
897 typedef uintmax_t PERL_UINTMAX_T;
898#endif
899
900/* N.B. We use QUADKIND here instead of HAS_QUAD here, because that doesn't
901 * actually mean what it has always been documented to mean (see RT #119753)
902 * and is explicitly turned off outside of core with dire warnings about
903 * removing the undef. */
904
905#if defined(QUADKIND)
906# undef PeRl_INT64_C
907# undef PeRl_UINT64_C
908/* Prefer the native integer types (int and long) over long long
909 * (which is not C89) and Win32-specific __int64. */
910# if QUADKIND == QUAD_IS_INT && INTSIZE == 8
911# define PeRl_INT64_C(c) (c)
912# define PeRl_UINT64_C(c) CAT2(c,U)
913# endif
914# if QUADKIND == QUAD_IS_LONG && LONGSIZE == 8
915# define PeRl_INT64_C(c) CAT2(c,L)
916# define PeRl_UINT64_C(c) CAT2(c,UL)
917# endif
918# if QUADKIND == QUAD_IS_LONG_LONG && defined(HAS_LONG_LONG)
919# define PeRl_INT64_C(c) CAT2(c,LL)
920# define PeRl_UINT64_C(c) CAT2(c,ULL)
921# endif
922# if QUADKIND == QUAD_IS___INT64
923# define PeRl_INT64_C(c) CAT2(c,I64)
924# define PeRl_UINT64_C(c) CAT2(c,UI64)
925# endif
926# ifndef PeRl_INT64_C
927# define PeRl_INT64_C(c) ((I64)(c)) /* last resort */
928# define PeRl_UINT64_C(c) ((U64TYPE)(c))
929# endif
930/* In OS X the INT64_C/UINT64_C are defined with LL/ULL, which will
931 * not fly with C89-pedantic gcc, so let's undefine them first so that
932 * we can redefine them with our native integer preferring versions. */
933# if defined(PERL_DARWIN) && defined(PERL_GCC_PEDANTIC)
934# undef INT64_C
935# undef UINT64_C
936# endif
937# ifndef INT64_C
938# define INT64_C(c) PeRl_INT64_C(c)
939# endif
940# ifndef UINT64_C
941# define UINT64_C(c) PeRl_UINT64_C(c)
942# endif
1109a392 943
f2f9e01d
KW		 944# ifndef I_STDINT
945 typedef I64TYPE PERL_INTMAX_T;
946 typedef U64TYPE PERL_UINTMAX_T;
1109a392 947# endif
f2f9e01d
KW		 948# ifndef INTMAX_C
949# define INTMAX_C(c) INT64_C(c)
950# endif
951# ifndef UINTMAX_C
952# define UINTMAX_C(c) UINT64_C(c)
953# endif
954
955#else /* below QUADKIND is undefined */
956
957/* Perl doesn't work on 16 bit systems, so must be 32 bit */
958# ifndef I_STDINT
959 typedef I32TYPE PERL_INTMAX_T;
960 typedef U32TYPE PERL_UINTMAX_T;
961# endif
962# ifndef INTMAX_C
963# define INTMAX_C(c) INT32_C(c)
964# endif
965# ifndef UINTMAX_C
966# define UINTMAX_C(c) UINT32_C(c)
967# endif
968
969#endif /* no QUADKIND */
970
971#ifdef PERL_CORE
1109a392
MHM		 972
973/* byte-swapping functions for big-/little-endian conversion */
974# define _swab_16_(x) ((U16)( \
f2f9e01d
KW		 975 (((U16)(x) & UINT16_C(0x00ff)) << 8) | \
976 (((U16)(x) & UINT16_C(0xff00)) >> 8) ))
1109a392
MHM		 977
978# define _swab_32_(x) ((U32)( \
f2f9e01d
KW		 979 (((U32)(x) & UINT32_C(0x000000ff)) << 24) | \
980 (((U32)(x) & UINT32_C(0x0000ff00)) << 8) | \
981 (((U32)(x) & UINT32_C(0x00ff0000)) >> 8) | \
982 (((U32)(x) & UINT32_C(0xff000000)) >> 24) ))
1109a392
MHM		 983
984# ifdef HAS_QUAD
985# define _swab_64_(x) ((U64)( \
f2f9e01d
KW		 986 (((U64)(x) & UINT64_C(0x00000000000000ff)) << 56) | \
987 (((U64)(x) & UINT64_C(0x000000000000ff00)) << 40) | \
988 (((U64)(x) & UINT64_C(0x0000000000ff0000)) << 24) | \
989 (((U64)(x) & UINT64_C(0x00000000ff000000)) << 8) | \
990 (((U64)(x) & UINT64_C(0x000000ff00000000)) >> 8) | \
991 (((U64)(x) & UINT64_C(0x0000ff0000000000)) >> 24) | \
992 (((U64)(x) & UINT64_C(0x00ff000000000000)) >> 40) | \
993 (((U64)(x) & UINT64_C(0xff00000000000000)) >> 56) ))
1109a392
MHM		 994# endif
995
9c17f24a
NC		 996/* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
997 at least on FreeBSD. YMMV, so experiment. */
998#ifndef PERL_ARENA_SIZE
999#define PERL_ARENA_SIZE 4080
1000#endif
1001
ccb2c8b8 1002/* Maximum level of recursion */
2b9dff67
RGS		 1003#ifndef PERL_SUB_DEPTH_WARN
1004#define PERL_SUB_DEPTH_WARN 100
ccb2c8b8
RGS		 1005#endif
1006
1109a392
MHM		 1007#endif /* PERL_CORE */
1008
e839e6ed
DM		 1009/* Maximum number of args that may be passed to an OP_MULTICONCAT op.
1010 * It determines the size of local arrays in S_maybe_multiconcat() and
1011 * pp_multiconcat().
1012 */
1013#define PERL_MULTICONCAT_MAXARG 64
1014
1015/* The indexes of fields of a multiconcat aux struct.
1016 * The fixed fields are followed by nargs+1 const segment lengths,
1017 * and if utf8 and non-utf8 differ, a second nargs+1 set for utf8.
1018 */
1019
1020#define PERL_MULTICONCAT_IX_NARGS 0 /* number of arguments */
1021#define PERL_MULTICONCAT_IX_PLAIN_PV 1 /* non-utf8 constant string */
1022#define PERL_MULTICONCAT_IX_PLAIN_LEN 2 /* non-utf8 constant string length */
1023#define PERL_MULTICONCAT_IX_UTF8_PV 3 /* utf8 constant string */
1024#define PERL_MULTICONCAT_IX_UTF8_LEN 4 /* utf8 constant string length */
1025#define PERL_MULTICONCAT_IX_LENGTHS 5 /* first of nargs+1 const segment lens */
1026#define PERL_MULTICONCAT_HEADER_SIZE 5 /* The number of fields of a
1027 multiconcat header */
1028
bdf3085f
NC		 1029/* We no longer default to creating a new SV for GvSV.
1030 Do this before embed. */
1031#ifndef PERL_CREATE_GVSV
7459f06b
NC		 1032# ifndef PERL_DONT_CREATE_GVSV
1033# define PERL_DONT_CREATE_GVSV
1034# endif
bdf3085f
NC		 1035#endif
1036
ca0c25f6
NC		 1037#if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
1038#define PERL_USES_PL_PIDSTATUS
1039#endif
1040
739a0b84 1041#if !defined(OS2) && !defined(WIN32) && !defined(DJGPP) && !defined(__SYMBIAN32__)
a62746fa
RGS		 1042#define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
1043#endif
1044
c31fac66
GS		 1045#define MEM_SIZE Size_t
1046
1936d2a7
NC		 1047/* Round all values passed to malloc up, by default to a multiple of
1048 sizeof(size_t)
1049*/
1050#ifndef PERL_STRLEN_ROUNDUP_QUANTUM
1051#define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
1052#endif
1053
f1200559
WH		 1054/* sv_grow() will expand strings by at least a certain percentage of
1055 the previously *used* length to avoid excessive calls to realloc().
1056 The default is 25% of the current length.
1057*/
1058#ifndef PERL_STRLEN_EXPAND_SHIFT
1059# define PERL_STRLEN_EXPAND_SHIFT 2
1060#endif
1061
4bd4e933
SH		 1062/* This use of offsetof() requires /Zc:offsetof- for VS2017 (and presumably
1063 * onwards) when building Socket.xs, but we can just use a different definition
1064 * for STRUCT_OFFSET instead. */
1065#if defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1910
1066# define STRUCT_OFFSET(s,m) (Size_t)(&(((s *)0)->m))
1067#else
1068# include <stddef.h>
1069# define STRUCT_OFFSET(s,m) offsetof(s,m)
1070#endif
d0b86e2f 1071
86477e89
KW		 1072/* ptrdiff_t is C11, so undef it under pedantic builds. (Actually it is
1073 * in C89, but apparently there are platforms where it doesn't exist. See
1074 * thread beginning at http://nntp.perl.org/group/perl.perl5.porters/251541.)
1075 * */
d0b86e2f
BF		 1076#ifdef PERL_GCC_PEDANTIC
1077# undef HAS_PTRDIFF_T
51371543
GS		 1078#endif
1079
86477e89
KW		 1080#ifdef HAS_PTRDIFF_T
1081# define Ptrdiff_t ptrdiff_t
1082#else
1083# define Ptrdiff_t SSize_t
1084#endif
1085
9969cdde 1086#ifndef __SYMBIAN32__
d54fbe84 1087# include <string.h>
51371543
GS		 1088#endif
1089
55497cff
PP		 1090/* This comes after <stdlib.h> so we don't try to change the standard
1091 * library prototypes; we'll use our own in proto.h instead. */
03a14243 1092
4633a7c4 1093#ifdef MYMALLOC
86058a2d 1094# ifdef PERL_POLLUTE_MALLOC
ee13e175 1095# ifndef PERL_EXTMALLOC_DEF
86058a2d
GS		 1096# define Perl_malloc malloc
1097# define Perl_calloc calloc
1098# define Perl_realloc realloc
1099# define Perl_mfree free
ee13e175 1100# endif
86058a2d
GS		 1101# else
1102# define EMBEDMYMALLOC /* for compatibility */
1103# endif
827e134a 1104
651b9576
GS		 1105# define safemalloc Perl_malloc
1106# define safecalloc Perl_calloc
1107# define saferealloc Perl_realloc
1108# define safefree Perl_mfree
22f7c9c9 1109# define CHECK_MALLOC_TOO_LATE_FOR_(code) STMT_START { \
54725a52 1110 if (!TAINTING_get && MallocCfg_ptr[MallocCfg_cfg_env_read]) \
22f7c9c9
JH		 1111 code; \
1112 } STMT_END
1113# define CHECK_MALLOC_TOO_LATE_FOR(ch) \
1114 CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
1115# define panic_write2(s) write(2, s, strlen(s))
1116# define CHECK_MALLOC_TAINT(newval) \
1117 CHECK_MALLOC_TOO_LATE_FOR_( \
1118 if (newval) { \
acfd4d8e 1119 PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
22f7c9c9 1120 exit(1); })
22f7c9c9 1121# define MALLOC_CHECK_TAINT(argc,argv,env) STMT_START { \
b0891165 1122 if (doing_taint(argc,argv,env)) { \
22f7c9c9
JH		 1123 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1; \
1124 }} STMT_END;
f2517201
GS		 1125#else /* MYMALLOC */
1126# define safemalloc safesysmalloc
1127# define safecalloc safesyscalloc
1128# define saferealloc safesysrealloc
1129# define safefree safesysfree
22f7c9c9
JH		 1130# define CHECK_MALLOC_TOO_LATE_FOR(ch) ((void)0)
1131# define CHECK_MALLOC_TAINT(newval) ((void)0)
1132# define MALLOC_CHECK_TAINT(argc,argv,env)
55497cff 1133#endif /* MYMALLOC */
4633a7c4 1134
fe13d51d 1135/* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
27da23d5 1136#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		 1137#define TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, "")
1138#define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
1139#define MALLOC_CHECK_TAINT2(argc,argv) MALLOC_CHECK_TAINT(argc,argv,NULL)
1140
fc36a67e 1141#ifndef memzero
04322328 1142# define memzero(d,l) memset(d,0,l)
d9d8d8de 1143#endif
378cc40b 1144
ae986130 1145#ifdef I_NETINET_IN
79072805 1146# include <netinet/in.h>
ae986130
LW		 1147#endif
1148
28e8609d
JH		 1149#ifdef I_ARPA_INET
1150# include <arpa/inet.h>
1151#endif
1152
1aef975c 1153#ifdef I_SYS_STAT
84902520 1154# include <sys/stat.h>
1aef975c 1155#endif
79072805 1156
287a962e
JD		 1157/* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1158 This definition should ideally go into win32/win32.h, but S_IFIFO is
1159 used later here in perl.h before win32/win32.h is being included. */
1160#if !defined(S_IFIFO) && defined(_S_IFIFO)
1161# define S_IFIFO _S_IFIFO
1162#endif
1163
cc3315ba 1164/* The stat macros for Unisoft System V/88 (and derivatives
a0d0e21e
LW		 1165 like UTekV) are broken, sometimes giving false positives. Undefine
1166 them here and let the code below set them to proper values.
1167
1168 The ghs macro stands for GreenHills Software C-1.8.5 which
1169 is the C compiler for sysV88 and the various derivatives.
1170 This header file bug is corrected in gcc-2.5.8 and later versions.
1171 --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94. */
1172
cc3315ba 1173#if defined(m88k) && defined(ghs)
79072805
LW		 1174# undef S_ISDIR
1175# undef S_ISCHR
1176# undef S_ISBLK
1177# undef S_ISREG
1178# undef S_ISFIFO
1179# undef S_ISLNK
ee0007ab 1180#endif
135863df 1181
9245da2a 1182#include <time.h>
663a0e37 1183
fe14fcc3 1184#ifdef I_SYS_TIME
85e6fe83 1185# ifdef I_SYS_TIME_KERNEL
663a0e37
LW		 1186# define KERNEL
1187# endif
1188# include <sys/time.h>
85e6fe83 1189# ifdef I_SYS_TIME_KERNEL
663a0e37
LW		 1190# undef KERNEL
1191# endif
a687059c 1192#endif
135863df 1193
55497cff 1194#if defined(HAS_TIMES) && defined(I_SYS_TIMES)
85e6fe83 1195# include <sys/times.h>
d9d8d8de 1196#endif
8d063cd8 1197
663a0e37 1198#include <errno.h>
1e743fda 1199
acfe0abc 1200#if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
b4748376
NIS		 1201# define WIN32SCK_IS_STDSCK /* don't pull in custom wsock layer */
1202#endif
1203
da70cfc6 1204#if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1e743fda
JH		 1205# include <sys/socket.h>
1206# if defined(USE_SOCKS) && defined(I_SOCKS)
1207# if !defined(INCLUDE_PROTOTYPES)
1208# define INCLUDE_PROTOTYPES /* for <socks.h> */
1209# define PERL_SOCKS_NEED_PROTOTYPES
1210# endif
1211# include <socks.h>
1212# ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1213# undef INCLUDE_PROTOTYPES
1214# undef PERL_SOCKS_NEED_PROTOTYPES
ed6116ce 1215# endif
d460ef45 1216# endif
1e743fda 1217# ifdef I_NETDB
2986a63f
JH		 1218# ifdef NETWARE
1219# include<stdio.h>
1220# endif
1e743fda
JH		 1221# include <netdb.h>
1222# endif
1223# ifndef ENOTSOCK
1224# ifdef I_NET_ERRNO
1225# include <net/errno.h>
1226# endif
1227# endif
1228#endif
1229
fa0a29af 1230/* sockatmark() is so new (2001) that many places might have it hidden
29820b6d
MHM		 1231 * behind some -D_BLAH_BLAH_SOURCE guard. The __THROW magic is required
1232 * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
fa0a29af 1233#if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
29820b6d
MHM		 1234# if defined(__THROW) && defined(__GLIBC__)
1235int sockatmark(int) __THROW;
1236# else
2ef53570 1237int sockatmark(int);
29820b6d 1238# endif
2ef53570
JH		 1239#endif
1240
7e827271 1241#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		 1242EXTERN_C int fchdir(int);
1243EXTERN_C int flock(int, int);
1244EXTERN_C int fseeko(FILE *, off_t, int);
1245EXTERN_C off_t ftello(FILE *);
1246#endif
1247
7e827271 1248#if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1ccb7c8d
JH		 1249EXTERN_C char *crypt(const char *, const char *);
1250#endif
1251
a54aca4b 1252#if defined(__cplusplus) && defined(__CYGWIN__)
667e2948
SP		 1253EXTERN_C char *crypt(const char *, const char *);
1254#endif
1255
1e743fda
JH		 1256#ifdef SETERRNO
1257# undef SETERRNO /* SOCKS might have defined this */
ed6116ce 1258#endif
f86702cc
PP		 1259
1260#ifdef VMS
1261# define SETERRNO(errcode,vmserrcode) \
1262 STMT_START { \
1263 set_errno(errcode); \
1264 set_vaxc_errno(vmserrcode); \
1265 } STMT_END
4ee39169
CS		 1266# define dSAVEDERRNO int saved_errno; unsigned saved_vms_errno
1267# define dSAVE_ERRNO int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1268# define SAVE_ERRNO ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1269# define RESTORE_ERRNO SETERRNO(saved_errno, saved_vms_errno)
1270
93189314
JH		 1271# define LIB_INVARG LIB$_INVARG
1272# define RMS_DIR RMS$_DIR
1273# define RMS_FAC RMS$_FAC
1274# define RMS_FEX RMS$_FEX
1275# define RMS_FNF RMS$_FNF
1276# define RMS_IFI RMS$_IFI
1277# define RMS_ISI RMS$_ISI
1278# define RMS_PRV RMS$_PRV
1279# define SS_ACCVIO SS$_ACCVIO
1280# define SS_DEVOFFLINE SS$_DEVOFFLINE
1281# define SS_IVCHAN SS$_IVCHAN
1282# define SS_NORMAL SS$_NORMAL
8a9f18be 1283# define SS_NOPRIV SS$_NOPRIV
4388f261 1284# define SS_BUFFEROVF SS$_BUFFEROVF
748a9306 1285#else
93189314
JH		 1286# define LIB_INVARG 0
1287# define RMS_DIR 0
1288# define RMS_FAC 0
1289# define RMS_FEX 0
1290# define RMS_FNF 0
1291# define RMS_IFI 0
1292# define RMS_ISI 0
1293# define RMS_PRV 0
1294# define SS_ACCVIO 0
1295# define SS_DEVOFFLINE 0
1296# define SS_IVCHAN 0
1297# define SS_NORMAL 0
8a9f18be 1298# define SS_NOPRIV 0
4388f261 1299# define SS_BUFFEROVF 0
748a9306 1300#endif
ed6116ce 1301
6ca940a9
TC		 1302#ifdef WIN32
1303# define dSAVEDERRNO int saved_errno; DWORD saved_win32_errno
1304# define dSAVE_ERRNO int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1305# define SAVE_ERRNO ( saved_errno = errno, saved_win32_errno = GetLastError() )
1306# define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1307#endif
1308
1309#ifdef OS2
1310# define dSAVEDERRNO int saved_errno; unsigned long saved_os2_errno
1311# define dSAVE_ERRNO int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1312# define SAVE_ERRNO ( saved_errno = errno, saved_os2_errno = Perl_rc )
1313# define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1314#endif
1315
1316#ifndef SETERRNO
1317# define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1318#endif
1319
1320#ifndef dSAVEDERRNO
1321# define dSAVEDERRNO int saved_errno
1322# define dSAVE_ERRNO int saved_errno = errno
1323# define SAVE_ERRNO (saved_errno = errno)
1324# define RESTORE_ERRNO (errno = saved_errno)
1325#endif
1326
f5fa9033 1327#define ERRSV GvSVn(PL_errgv)
dfd167e9 1328
b4f8d149 1329/* contains inlined gv_add_by_type */
dfd167e9 1330#define CLEAR_ERRSV() STMT_START { \
b4f8d149
DD		 1331 SV ** const svp = &GvSV(PL_errgv); \
1332 if (!*svp) { \
a1b60c8d 1333 *svp = newSVpvs(""); \
b4f8d149
DD		 1334 } else if (SvREADONLY(*svp)) { \
1335 SvREFCNT_dec_NN(*svp); \
b4f8d149 1336 *svp = newSVpvs(""); \
dfd167e9 1337 } else { \
b4f8d149 1338 SV *const errsv = *svp; \
a1b60c8d 1339 SvPVCLEAR(errsv); \
b4f8d149 1340 SvPOK_only(errsv); \
dfd167e9
NC		 1341 if (SvMAGICAL(errsv)) { \
1342 mg_free(errsv); \
1343 } \
dfd167e9
NC		 1344 } \
1345 } STMT_END
1346
1347
414bf5ae
MHM		 1348#ifdef PERL_CORE
1349# define DEFSV (0 + GvSVn(PL_defgv))
55b5114f
FC		 1350# define DEFSV_set(sv) \
1351 (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1352# define SAVE_DEFSV \
1353 ( \
1354 save_gp(PL_defgv, 0), \
1355 GvINTRO_off(PL_defgv), \
1356 SAVEGENERICSV(GvSV(PL_defgv)), \
1357 GvSV(PL_defgv) = NULL \
1358 )
414bf5ae
MHM		 1359#else
1360# define DEFSV GvSVn(PL_defgv)
55b5114f
FC		 1361# define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1362# define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
414bf5ae 1363#endif
38a03e6e 1364
55497cff 1365#ifndef errno
5ff3f7a4
GS		 1366 extern int errno; /* ANSI allows errno to be an lvalue expr.
1367 * For example in multithreaded environments
1368 * something like this might happen:
1369 * extern int *_errno(void);
1370 * #define errno (*_errno()) */
d9d8d8de 1371#endif
663a0e37 1372
7e996671
KW		 1373#define UNKNOWN_ERRNO_MSG "(unknown)"
1374
b21d8587
AC		 1375#if VMS
1376#define Strerror(e) strerror((e), vaxc$errno)
1377#else
1378#define Strerror(e) strerror(e)
35c8bce7 1379#endif
663a0e37 1380
2304df62 1381#ifdef I_SYS_IOCTL
79072805
LW		 1382# ifndef _IOCTL_
1383# include <sys/ioctl.h>
1384# endif
a687059c
LW		 1385#endif
1386
ee0007ab 1387#if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
79072805
LW		 1388# ifdef HAS_SOCKETPAIR
1389# undef HAS_SOCKETPAIR
1390# endif
2304df62
AD		 1391# ifdef I_NDBM
1392# undef I_NDBM
79072805 1393# endif
a687059c
LW		 1394#endif
1395
02fc2eee
NC		 1396#ifndef HAS_SOCKETPAIR
1397# ifdef HAS_SOCKET
1398# define socketpair Perl_my_socketpair
1399# endif
1400#endif
1401
a687059c 1402#if INTSIZE == 2
79072805
LW		 1403# define htoni htons
1404# define ntohi ntohs
a687059c 1405#else
79072805
LW		 1406# define htoni htonl
1407# define ntohi ntohl
a687059c
LW		 1408#endif
1409
a0d0e21e 1410/* Configure already sets Direntry_t */
35c8bce7 1411#if defined(I_DIRENT)
da5fdda8
AC		 1412# include <dirent.h>
1413#elif defined(I_SYS_NDIR)
1414# include <sys/ndir.h>
1415#elif defined(I_SYS_DIR)
1416# include <sys/dir.h>
4633a7c4 1417#endif
a687059c 1418
c623bd54
LW		 1419/*
1420 * The following gobbledygook brought to you on behalf of __STDC__.
1421 * (I could just use #ifndef __STDC__, but this is more bulletproof
1422 * in the face of half-implementations.)
1423 */
1424
21e89b5f 1425#if defined(I_SYSMODE)
ca6e1c26
JH		 1426#include <sys/mode.h>
1427#endif
1428
c623bd54
LW		 1429#ifndef S_IFMT
1430# ifdef _S_IFMT
1431# define S_IFMT _S_IFMT
1432# else
1433# define S_IFMT 0170000
1434# endif
1435#endif
1436
1437#ifndef S_ISDIR
1438# define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1439#endif
1440
1441#ifndef S_ISCHR
1442# define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1443#endif
1444
1445#ifndef S_ISBLK
fe14fcc3
LW		 1446# ifdef S_IFBLK
1447# define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1448# else
1449# define S_ISBLK(m) (0)
1450# endif
c623bd54
LW		 1451#endif
1452
1453#ifndef S_ISREG
1454# define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1455#endif
1456
1457#ifndef S_ISFIFO
fe14fcc3
LW		 1458# ifdef S_IFIFO
1459# define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1460# else
1461# define S_ISFIFO(m) (0)
1462# endif
c623bd54
LW		 1463#endif
1464
1465#ifndef S_ISLNK
da5fdda8
AC		 1466# ifdef _S_ISLNK
1467# define S_ISLNK(m) _S_ISLNK(m)
1468# elif defined(_S_IFLNK)
1469# define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1470# elif defined(S_IFLNK)
1471# define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1472# else
1473# define S_ISLNK(m) (0)
1474# endif
c623bd54
LW		 1475#endif
1476
1477#ifndef S_ISSOCK
da5fdda8
AC		 1478# ifdef _S_ISSOCK
1479# define S_ISSOCK(m) _S_ISSOCK(m)
1480# elif defined(_S_IFSOCK)
1481# define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1482# elif defined(S_IFSOCK)
1483# define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1484# else
1485# define S_ISSOCK(m) (0)
1486# endif
c623bd54
LW		 1487#endif
1488
1489#ifndef S_IRUSR
1490# ifdef S_IREAD
1491# define S_IRUSR S_IREAD
1492# define S_IWUSR S_IWRITE
1493# define S_IXUSR S_IEXEC
1494# else
1495# define S_IRUSR 0400
1496# define S_IWUSR 0200
1497# define S_IXUSR 0100
1498# endif
fac7cdfc 1499#endif
1500
1501#ifndef S_IRGRP
1502# ifdef S_IRUSR
1503# define S_IRGRP (S_IRUSR>>3)
1504# define S_IWGRP (S_IWUSR>>3)
1505# define S_IXGRP (S_IXUSR>>3)
1506# else
1507# define S_IRGRP 0040
1508# define S_IWGRP 0020
1509# define S_IXGRP 0010
1510# endif
1511#endif
1512
1513#ifndef S_IROTH
1514# ifdef S_IRUSR
1515# define S_IROTH (S_IRUSR>>6)
1516# define S_IWOTH (S_IWUSR>>6)
1517# define S_IXOTH (S_IXUSR>>6)
1518# else
1519# define S_IROTH 0040
1520# define S_IWOTH 0020
1521# define S_IXOTH 0010
1522# endif
c623bd54
LW		 1523#endif
1524
1525#ifndef S_ISUID
1526# define S_ISUID 04000
1527#endif
1528
1529#ifndef S_ISGID
1530# define S_ISGID 02000
1531#endif
1532
ca6e1c26
JH		 1533#ifndef S_IRWXU
1534# define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
d460ef45 1535#endif
ca6e1c26
JH		 1536
1537#ifndef S_IRWXG
1538# define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
d460ef45 1539#endif
ca6e1c26
JH		 1540
1541#ifndef S_IRWXO
1542# define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
d460ef45 1543#endif
ca6e1c26 1544
b6c36746 1545/* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
c21fb2b8
JH		 1546 * which would get included through <sys/file.h >, but that is 3000
1547 * lines in the future. --jhi */
1548
b6c36746 1549#if !defined(S_IREAD) && !defined(__HAIKU__)
ca6e1c26
JH		 1550# define S_IREAD S_IRUSR
1551#endif
1552
b6c36746 1553#if !defined(S_IWRITE) && !defined(__HAIKU__)
ca6e1c26
JH		 1554# define S_IWRITE S_IWUSR
1555#endif
1556
1557#ifndef S_IEXEC
1558# define S_IEXEC S_IXUSR
1559#endif
1560
a0d0e21e 1561#if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
45d8adaa
LW		 1562# define SLOPPYDIVIDE
1563#endif
1564
748a9306
LW		 1565#ifdef UV
1566#undef UV
1567#endif
1568
f1519f70
AC		 1569/* This used to be conditionally defined based on whether we had a sprintf()
1570 * that correctly returns the string length (as required by C89), but we no
1571 * longer need that. XS modules can (and do) use this name, so it must remain
1572 * a part of the API that's visible to modules. But we no longer document it
1573 * either (because using sprintf() rather than snprintf() is almost always
1574 * a bad idea). */
1575#define my_sprintf sprintf
ce582cee 1576
5b692037
JH		 1577/*
1578 * If we have v?snprintf() and the C99 variadic macros, we can just
1579 * use just the v?snprintf(). It is nice to try to trap the buffer
1580 * overflow, however, so if we are DEBUGGING, and we cannot use the
e5afc1ae
DD		 1581 * gcc statement expressions, then use the function wrappers which try
1582 * to trap the overflow. If we can use the gcc statement expressions,
1583 * we can try that even with the version that uses the C99 variadic
1584 * macros.
5b692037
JH		 1585 */
1586
1208b3dd 1587/* Note that we do not check against snprintf()/vsnprintf() returning
4059ba87
AC		 1588 * negative values because that is non-standard behaviour and we use
1589 * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1590 * that should be true only if the snprintf()/vsnprintf() are true
1591 * to the standard. */
1208b3dd 1592
571ee10c 1593#define PERL_SNPRINTF_CHECK(len, max, api) STMT_START { if ((max) > 0 && (Size_t)len > (max)) Perl_croak_nocontext("panic: %s buffer overflow", STRINGIFY(api)); } STMT_END
e8549682 1594
a4eca1d4
JH		 1595#ifdef USE_QUADMATH
1596# define my_snprintf Perl_my_snprintf
1597# define PERL_MY_SNPRINTF_GUARDED
4059ba87 1598#elif defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
5b692037 1599# ifdef PERL_USE_GCC_BRACE_GROUPS
e8549682 1600# define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1208b3dd 1601# define PERL_MY_SNPRINTF_GUARDED
5b692037 1602# else
e8549682 1603# define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
5b692037
JH		 1604# endif
1605#else
1606# define my_snprintf Perl_my_snprintf
1208b3dd 1607# define PERL_MY_SNPRINTF_GUARDED
5b692037
JH		 1608#endif
1609
a4eca1d4
JH		 1610/* There is no quadmath_vsnprintf, and therefore my_vsnprintf()
1611 * dies if called under USE_QUADMATH. */
4059ba87 1612#if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
5b692037 1613# ifdef PERL_USE_GCC_BRACE_GROUPS
e8549682 1614# define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1208b3dd 1615# define PERL_MY_VSNPRINTF_GUARDED
5b692037 1616# else
e8549682 1617# define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
5b692037
JH		 1618# endif
1619#else
1620# define my_vsnprintf Perl_my_vsnprintf
1208b3dd 1621# define PERL_MY_VSNPRINTF_GUARDED
5b692037 1622#endif
d9fad198 1623
e8549682
JH		 1624/* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1625 * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1626 * the result of my_snprintf() or my_vsnprintf(). (No, you should not
1627 * completely ignore it: otherwise you cannot know whether your output
1628 * was too long.)
1629 *
1630 * int len = my_sprintf(buf, max, ...);
1631 * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1632 *
1633 * The trick is that in certain platforms [a] the my_sprintf() already
1634 * contains the sanity check, while in certain platforms [b] it needs
1635 * to be done as a separate step. The POST_GUARD is that step-- in [a]
1636 * platforms the POST_GUARD actually does nothing since the check has
1637 * already been done. Watch out for the max being the same in both calls.
1638 *
1639 * If you actually use the snprintf/vsnprintf return value already,
1640 * you assumedly are checking its validity somehow. But you can
1641 * insert the POST_GUARD() also in that case. */
1642
1643#ifndef PERL_MY_SNPRINTF_GUARDED
1644# define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1645#else
1646# define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1647#endif
1648
1649#ifndef PERL_MY_VSNPRINTF_GUARDED
1650# define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
1651#else
1652# define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1653#endif
1654
a6cc4119
SP		 1655#ifdef HAS_STRLCAT
1656# define my_strlcat strlcat
1657#else
1658# define my_strlcat Perl_my_strlcat
1659#endif
1660
6dba01e2
KW		 1661#if defined(PERL_CORE) || defined(PERL_EXT)
1662# ifdef HAS_MEMRCHR
1663# define my_memrchr memrchr
1664# else
1665# define my_memrchr S_my_memrchr
1666# endif
1667#endif
1668
a6cc4119
SP		 1669#ifdef HAS_STRLCPY
1670# define my_strlcpy strlcpy
1671#else
1672# define my_strlcpy Perl_my_strlcpy
1673#endif
1674
aefb3fa0
DIM		 1675#ifdef HAS_STRNLEN
1676# define my_strnlen strnlen
1677#else
1678# define my_strnlen Perl_my_strnlen
1679#endif
1680
05f13f53 1681/*
27d4fb96
PP		 1682 The IV type is supposed to be long enough to hold any integral
1683 value or a pointer.
1684 --Andy Dougherty August 1996
1685*/
1686
a22e52b9
JH		 1687typedef IVTYPE IV;
1688typedef UVTYPE UV;
8175356b 1689
10cc9d2a 1690#if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
6b8eaf93 1691# if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
5ff3f7a4
GS		 1692# define IV_MAX INT64_MAX
1693# define IV_MIN INT64_MIN
1694# define UV_MAX UINT64_MAX
cae7ae48
JH		 1695# ifndef UINT64_MIN
1696# define UINT64_MIN 0
1697# endif
5ff3f7a4
GS		 1698# define UV_MIN UINT64_MIN
1699# else
1700# define IV_MAX PERL_QUAD_MAX
1701# define IV_MIN PERL_QUAD_MIN
1702# define UV_MAX PERL_UQUAD_MAX
1703# define UV_MIN PERL_UQUAD_MIN
1704# endif
cf2093f6
JH		 1705# define IV_IS_QUAD
1706# define UV_IS_QUAD
79072805 1707#else
8175356b 1708# if defined(INT32_MAX) && IVSIZE == 4
5ff3f7a4
GS		 1709# define IV_MAX INT32_MAX
1710# define IV_MIN INT32_MIN
716026f9
DL		 1711# ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
1712# define UV_MAX UINT32_MAX
1713# else
1714# define UV_MAX 4294967295U
1715# endif
cae7ae48
JH		 1716# ifndef UINT32_MIN
1717# define UINT32_MIN 0
1718# endif
5ff3f7a4
GS		 1719# define UV_MIN UINT32_MIN
1720# else
1721# define IV_MAX PERL_LONG_MAX
1722# define IV_MIN PERL_LONG_MIN
1723# define UV_MAX PERL_ULONG_MAX
1724# define UV_MIN PERL_ULONG_MIN
1725# endif
8175356b 1726# if IVSIZE == 8
cf2093f6
JH		 1727# define IV_IS_QUAD
1728# define UV_IS_QUAD
de1c2614
JH		 1729# ifndef HAS_QUAD
1730# define HAS_QUAD
1731# endif
cf2093f6
JH		 1732# else
1733# undef IV_IS_QUAD
1734# undef UV_IS_QUAD
9ea40801 1735#if !defined(PERL_CORE) || defined(USING_MSVC6)
e25d460c
NC		 1736/* We think that removing this decade-old undef this will cause too much
1737 breakage on CPAN for too little gain. (See RT #119753)
9ea40801
SH		 1738 However, we do need HAS_QUAD in the core for use by the drand48 code,
1739 but not for Win32 VC6 because it has poor __int64 support. */
cb4b14d5 1740# undef HAS_QUAD
e25d460c 1741#endif
cf2093f6 1742# endif
79072805 1743#endif
d7d93a81 1744
6313e544
JH		 1745#define Size_t_MAX (~(Size_t)0)
1746#define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
9a543cee 1747
cae7ae48 1748#define IV_DIG (BIT_DIGITS(IVSIZE * 8))
22ec83e3 1749#define UV_DIG (BIT_DIGITS(UVSIZE * 8))
56431972 1750
28e5dec8 1751#ifndef NO_PERL_PRESERVE_IVUV
f5c03d33 1752#define PERL_PRESERVE_IVUV /* We like our integers to stay integers. */
28e5dec8
JH		 1753#endif
1754
d460ef45 1755/*
26bb67e2
JH		 1756 * The macros INT2PTR and NUM2PTR are (despite their names)
1757 * bi-directional: they will convert int/float to or from pointers.
1758 * However the conversion to int/float are named explicitly:
1759 * PTR2IV, PTR2UV, PTR2NV.
1760 *
1761 * For int conversions we do not need two casts if pointers are
1762 * the same size as IV and UV. Otherwise we need an explicit
1763 * cast (PTRV) to avoid compiler warnings.
1764 */
56431972
RB		 1765#if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1766# define PTRV UV
1767# define INT2PTR(any,d) (any)(d)
da5fdda8
AC		 1768#elif PTRSIZE == LONGSIZE
1769# define PTRV unsigned long
1770# define PTR2ul(p) (unsigned long)(p)
56431972 1771#else
da5fdda8 1772# define PTRV unsigned
e91e3b10
RB		 1773#endif
1774
1775#ifndef INT2PTR
56431972 1776# define INT2PTR(any,d) (any)(PTRV)(d)
42718184 1777#endif
e91e3b10
RB		 1778
1779#ifndef PTR2ul
1780# define PTR2ul(p) INT2PTR(unsigned long,p)
1781#endif
1782
56431972
RB		 1783#define NUM2PTR(any,d) (any)(PTRV)(d)
1784#define PTR2IV(p) INT2PTR(IV,p)
1785#define PTR2UV(p) INT2PTR(UV,p)
1786#define PTR2NV(p) NUM2PTR(NV,p)
e91e3b10 1787#define PTR2nat(p) (PTRV)(p) /* pointer to integer of PTRSIZE */
d460ef45 1788
8141890a
JH		 1789/* According to strict ANSI C89 one cannot freely cast between
1790 * data pointers and function (code) pointers. There are at least
1791 * two ways around this. One (used below) is to do two casts,
1792 * first the other pointer to an (unsigned) integer, and then
1793 * the integer to the other pointer. The other way would be
1794 * to use unions to "overlay" the pointers. For an example of
1795 * the latter technique, see union dirpu in struct xpvio in sv.h.
1796 * The only feasible use is probably temporarily storing
1797 * function pointers in a data pointer (such as a void pointer). */
1798
e91e3b10
RB		 1799#define DPTR2FPTR(t,p) ((t)PTR2nat(p)) /* data pointer to function pointer */
1800#define FPTR2DPTR(t,p) ((t)PTR2nat(p)) /* function pointer to data pointer */
8141890a 1801
65202027 1802#ifdef USE_LONG_DOUBLE
f3654d06
JH		 1803# if LONG_DOUBLESIZE == DOUBLESIZE
1804# define LONG_DOUBLE_EQUALS_DOUBLE
1805# undef USE_LONG_DOUBLE /* Ouch! */
65202027
DS		 1806# endif
1807#endif
1808
2d4389e4
JH		 1809/* The following is all to get LDBL_DIG, in order to pick a nice
1810 default value for printing floating point numbers in Gconvert.
1811 (see config.h)
1812*/
63b481b9 1813#ifndef HAS_LDBL_DIG
68d4903c 1814# if LONG_DOUBLESIZE == 10
63b481b9
AC		 1815# define LDBL_DIG 18 /* assume IEEE */
1816# elif LONG_DOUBLESIZE == 12
68d4903c 1817# define LDBL_DIG 18 /* gcc? */
63b481b9
AC		 1818# elif LONG_DOUBLESIZE == 16
1819# define LDBL_DIG 33 /* assume IEEE */
1820# elif LONG_DOUBLESIZE == DOUBLESIZE
1821# define LDBL_DIG DBL_DIG /* bummer */
68d4903c 1822# endif
2d4389e4
JH		 1823#endif
1824
a22e52b9 1825typedef NVTYPE NV;
8175356b 1826
792d8dab
JH		 1827#ifdef I_IEEEFP
1828# include <ieeefp.h>
1829#endif
923fc586 1830
c32c3de1
JH		 1831#ifdef USING_MSVC6
1832/* VC6 has broken NaN semantics: NaN == NaN returns true instead of false,
1833 * and for example NaN < IV_MIN. */
bcd8bfa9
JH		 1834# define NAN_COMPARE_BROKEN
1835#endif
1836#if defined(__DECC) && defined(__osf__)
1837/* Also Tru64 cc has broken NaN comparisons. */
1838# define NAN_COMPARE_BROKEN
c32c3de1 1839#endif
6504068e
JH		 1840#if defined(__sgi)
1841# define NAN_COMPARE_BROKEN
1842#endif
c32c3de1 1843
65202027 1844#ifdef USE_LONG_DOUBLE
923fc586
JH		 1845# ifdef I_SUNMATH
1846# include <sunmath.h>
1847# endif
84e6cb05 1848# if defined(LDBL_DIG)
05b4a618
JH		 1849# define NV_DIG LDBL_DIG
1850# ifdef LDBL_MANT_DIG
1851# define NV_MANT_DIG LDBL_MANT_DIG
1852# endif
1853# ifdef LDBL_MIN
1854# define NV_MIN LDBL_MIN
1855# endif
1856# ifdef LDBL_MAX
1857# define NV_MAX LDBL_MAX
1858# endif
1859# ifdef LDBL_MIN_EXP
1860# define NV_MIN_EXP LDBL_MIN_EXP
1861# endif
1862# ifdef LDBL_MAX_EXP
1863# define NV_MAX_EXP LDBL_MAX_EXP
1864# endif
1865# ifdef LDBL_MIN_10_EXP
1866# define NV_MIN_10_EXP LDBL_MIN_10_EXP
1867# endif
1868# ifdef LDBL_MAX_10_EXP
1869# define NV_MAX_10_EXP LDBL_MAX_10_EXP
1870# endif
1871# ifdef LDBL_EPSILON
1872# define NV_EPSILON LDBL_EPSILON
1873# endif
1874# ifdef LDBL_MAX
1875# define NV_MAX LDBL_MAX
20f6aaab 1876/* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
da5fdda8
AC		 1877# elif defined(HUGE_VALL)
1878# define NV_MAX HUGE_VALL
f4a14a62
JH		 1879# endif
1880# endif
84e6cb05 1881# if defined(HAS_SQRTL)
8a00eddc
JH		 1882# define Perl_acos acosl
1883# define Perl_asin asinl
1884# define Perl_atan atanl
940e3d56
JH		 1885# define Perl_atan2 atan2l
1886# define Perl_ceil ceill
1887# define Perl_cos cosl
8a00eddc 1888# define Perl_cosh coshl
940e3d56 1889# define Perl_exp expl
55da5e5b 1890/* no Perl_fabs, but there's PERL_ABS */
940e3d56
JH		 1891# define Perl_floor floorl
1892# define Perl_fmod fmodl
1893# define Perl_log logl
8a00eddc 1894# define Perl_log10 log10l
940e3d56
JH		 1895# define Perl_pow powl
1896# define Perl_sin sinl
8a00eddc 1897# define Perl_sinh sinhl
940e3d56 1898# define Perl_sqrt sqrtl
8a00eddc
JH		 1899# define Perl_tan tanl
1900# define Perl_tanh tanhl
68d4903c 1901# endif
a3540c92 1902/* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
05b4a618
JH		 1903# ifndef Perl_modf
1904# ifdef HAS_MODFL
1905# define Perl_modf(x,y) modfl(x,y)
51997bc3
NC		 1906/* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
1907 prototype in <math.h> */
05b4a618 1908# ifndef HAS_MODFL_PROTO
a221a8a5 1909EXTERN_C long double modfl(long double, long double *);
05b4a618
JH		 1910# endif
1911# elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
55954f19 1912 extern long double Perl_my_modfl(long double x, long double *ip);
03476e8e 1913# define Perl_modf(x,y) Perl_my_modfl(x,y)
05b4a618 1914# endif
a3540c92 1915# endif
05b4a618
JH		 1916# ifndef Perl_frexp
1917# ifdef HAS_FREXPL
1918# define Perl_frexp(x,y) frexpl(x,y)
da5fdda8 1919# elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
05b4a618 1920extern long double Perl_my_frexpl(long double x, int *e);
da5fdda8 1921# define Perl_frexp(x,y) Perl_my_frexpl(x,y)
03476e8e 1922# endif
a3540c92 1923# endif
05b4a618
JH		 1924# ifndef Perl_ldexp
1925# ifdef HAS_LDEXPL
1926# define Perl_ldexp(x, y) ldexpl(x,y)
da5fdda8
AC		 1927# elif defined(HAS_SCALBNL) && FLT_RADIX == 2
1928# define Perl_ldexp(x,y) scalbnl(x,y)
98181445
JH		 1929# endif
1930# endif
38dbb4c5 1931# ifndef Perl_isnan
e4c957f4 1932# if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
758a5d79 1933# define Perl_isnan(x) isnanl(x)
a1115378
JH		 1934# elif defined(__sgi) && defined(__c99) /* XXX Configure test needed */
1935# define Perl_isnan(x) isnan(x)
758a5d79
JH		 1936# endif
1937# endif
1938# ifndef Perl_isinf
e4c957f4 1939# if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
87190886 1940# define Perl_isinf(x) isinfl(x)
a1115378
JH		 1941# elif defined(__sgi) && defined(__c99) /* XXX Configure test needed */
1942# define Perl_isinf(x) isinf(x)
bcd8bfa9 1943# elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
efcbf317 1944# define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
a3540c92
JH		 1945# endif
1946# endif
e38461cc
JH		 1947# ifndef Perl_isfinite
1948# define Perl_isfinite(x) Perl_isfinitel(x)
1949# endif
84e6cb05
JH		 1950#elif defined(USE_QUADMATH) && defined(I_QUADMATH)
1951# include <quadmath.h>
1952# define NV_DIG FLT128_DIG
1953# define NV_MANT_DIG FLT128_MANT_DIG
1954# define NV_MIN FLT128_MIN
1955# define NV_MAX FLT128_MAX
1956# define NV_MIN_EXP FLT128_MIN_EXP
1957# define NV_MAX_EXP FLT128_MAX_EXP
1958# define NV_EPSILON FLT128_EPSILON
1959# define NV_MIN_10_EXP FLT128_MIN_10_EXP
1960# define NV_MAX_10_EXP FLT128_MAX_10_EXP
84e6cb05
JH		 1961# define Perl_acos acosq
1962# define Perl_asin asinq
1963# define Perl_atan atanq
1964# define Perl_atan2 atan2q
1965# define Perl_ceil ceilq
1966# define Perl_cos cosq
1967# define Perl_cosh coshq
1968# define Perl_exp expq
1969/* no Perl_fabs, but there's PERL_ABS */
1970# define Perl_floor floorq
1971# define Perl_fmod fmodq
1972# define Perl_log logq
1973# define Perl_log10 log10q
e6081c0e 1974# define Perl_signbit signbitq
84e6cb05
JH		 1975# define Perl_pow powq
1976# define Perl_sin sinq
1977# define Perl_sinh sinhq
1978# define Perl_sqrt sqrtq
1979# define Perl_tan tanq
1980# define Perl_tanh tanhq
1981# define Perl_modf(x,y) modfq(x,y)
1982# define Perl_frexp(x,y) frexpq(x,y)
1983# define Perl_ldexp(x, y) ldexpq(x,y)
1984# define Perl_isinf(x) isinfq(x)
1985# define Perl_isnan(x) isnanq(x)
1986# define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
b28053d1
JH		 1987# define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
1988# define Perl_fp_class_inf(x) (Perl_fp_class(x) == 3)
1989# define Perl_fp_class_nan(x) (Perl_fp_class(x) == 4)
1990# define Perl_fp_class_norm(x) (Perl_fp_class(x) == 1)
1991# define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
1992# define Perl_fp_class_zero(x) (Perl_fp_class(x) == 0)
65202027 1993#else
2d4389e4 1994# define NV_DIG DBL_DIG
63b481b9
AC		 1995# define NV_MANT_DIG DBL_MANT_DIG
1996# define NV_MIN DBL_MIN
1997# define NV_MAX DBL_MAX
1998# define NV_MIN_EXP DBL_MIN_EXP
1999# define NV_MAX_EXP DBL_MAX_EXP
2000# define NV_MIN_10_EXP DBL_MIN_10_EXP
2001# define NV_MAX_10_EXP DBL_MAX_10_EXP
2002# define NV_EPSILON DBL_EPSILON
2003# define NV_MAX DBL_MAX
2004# define NV_MIN DBL_MIN
940e3d56 2005
55da5e5b 2006/* These math interfaces are C89. */
8a00eddc
JH		 2007# define Perl_acos acos
2008# define Perl_asin asin
2009# define Perl_atan atan
940e3d56
JH		 2010# define Perl_atan2 atan2
2011# define Perl_ceil ceil
2012# define Perl_cos cos
8a00eddc 2013# define Perl_cosh cosh
940e3d56 2014# define Perl_exp exp
55da5e5b 2015/* no Perl_fabs, but there's PERL_ABS */
940e3d56
JH		 2016# define Perl_floor floor
2017# define Perl_fmod fmod
2018# define Perl_log log
8a00eddc 2019# define Perl_log10 log10
940e3d56
JH		 2020# define Perl_pow pow
2021# define Perl_sin sin
8a00eddc 2022# define Perl_sinh sinh
940e3d56 2023# define Perl_sqrt sqrt
8a00eddc
JH		 2024# define Perl_tan tan
2025# define Perl_tanh tanh
940e3d56
JH		 2026
2027# define Perl_modf(x,y) modf(x,y)
2028# define Perl_frexp(x,y) frexp(x,y)
2029# define Perl_ldexp(x,y) ldexp(x,y)
2030
1a322af2
JH		 2031# ifndef Perl_isnan
2032# ifdef HAS_ISNAN
2033# define Perl_isnan(x) isnan(x)
2034# endif
2035# endif
2036# ifndef Perl_isinf
2037# if defined(HAS_ISINF)
2038# define Perl_isinf(x) isinf(x)
bcd8bfa9 2039# elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
efcbf317 2040# define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
1a322af2
JH		 2041# endif
2042# endif
2043# ifndef Perl_isfinite
2044# ifdef HAS_ISFINITE
2045# define Perl_isfinite(x) isfinite(x)
2046# elif defined(HAS_FINITE)
2047# define Perl_isfinite(x) finite(x)
2048# endif
2049# endif
758a5d79
JH		 2050#endif
2051
30404d48
JH		 2052/* fpclassify(): C99. It is supposed to be a macro that switches on
2053* the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
2054#if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2055# include <math.h>
25c46df8
JH		 2056# if defined(FP_INFINITE) && defined(FP_NAN)
2057# define Perl_fp_class(x) fpclassify(x)
2058# define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_INFINITE)
2059# define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_NAN)
2060# define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_NORMAL)
2061# define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2062# define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_ZERO)
2063# elif defined(FP_PLUS_INF) && defined(FP_QNAN)
2064/* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
2065 * actually not the C99 fpclassify, with its own set of return defines. */
2066# define Perl_fp_class(x) fpclassify(x)
2067# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
2068# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
82947af8 2069# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
25c46df8
JH		 2070# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2071# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
1ae51000 2072# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
25c46df8
JH		 2073# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
2074# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
2075# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
2076# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
2077# else
2078# undef Perl_fp_class /* Unknown set of defines */
2079# endif
30404d48
JH		 2080#endif
2081
25c46df8
JH		 2082/* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
2083 * are identical to the C99 fpclassify(). */
2084#if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
2085# include <math.h>
558f3e66
CB		 2086# ifdef __VMS
2087 /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
2088# include <fp.h>
56610b8f
CB		 2089 /* oh, and the isnormal macro has a typo in it! */
2090# undef isnormal
2091# define isnormal(x) Perl_fp_class_norm(x)
558f3e66 2092# endif
25c46df8
JH		 2093# if defined(FP_INFINITE) && defined(FP_NAN)
2094# define Perl_fp_class(x) fp_classify(x)
2095# define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_INFINITE)
2096# define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_NAN)
2097# define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_NORMAL)
2098# define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2099# define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_ZERO)
2100# else
2101# undef Perl_fp_class /* Unknown set of defines */
2102# endif
f279e099 2103#endif
205f51d8 2104
30404d48
JH		 2105/* Feel free to check with me for the SGI manpages, SGI testing,
2106 * etcetera, if you want to try getting this to work with IRIX.
2107 *
2108 * - Allen <allens@cpan.org> */
2109
2110/* fpclass(): SysV, at least Solaris and some versions of IRIX. */
758a5d79 2111#if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
25c46df8
JH		 2112/* Solaris and IRIX have fpclass/fpclassl, but they are using
2113 * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2114 * Define some symbols also as cpp symbols so we can detect them. */
033a6f7a 2115# if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
25c46df8
JH		 2116# define FP_PINF FP_PINF
2117# define FP_QNAN FP_QNAN
2118# endif
f279e099 2119# include <math.h>
758a5d79
JH		 2120# ifdef I_IEEFP
2121# include <ieeefp.h>
2122# endif
2123# ifdef I_FP
2124# include <fp.h>
2125# endif
2126# if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
f279e099 2127# define Perl_fp_class(x) fpclassl(x)
758a5d79 2128# else
f279e099
JH		 2129# define Perl_fp_class(x) fpclass(x)
2130# endif
25c46df8 2131# if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
f279e099
JH		 2132# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_CLASS_SNAN)
2133# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_CLASS_QNAN)
2134# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_CLASS_NINF)
2135# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_CLASS_PINF)
2136# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_CLASS_NNORM)
2137# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_CLASS_PNORM)
2138# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_CLASS_NDENORM)
2139# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_CLASS_PDENORM)
2140# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_CLASS_NZERO)
2141# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_CLASS_PZERO)
25c46df8 2142# elif defined(FP_PINF) && defined(FP_QNAN)
f279e099
JH		 2143# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2144# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2145# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_NINF)
2146# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PINF)
2147# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_NNORM)
2148# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PNORM)
2149# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_NDENORM)
2150# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PDENORM)
2151# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_NZERO)
2152# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PZERO)
25c46df8
JH		 2153# else
2154# undef Perl_fp_class /* Unknown set of defines */
758a5d79 2155# endif
758a5d79
JH		 2156#endif
2157
30404d48
JH		 2158/* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2159#if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
758a5d79
JH		 2160# include <math.h>
2161# if !defined(FP_SNAN) && defined(I_FP_CLASS)
2162# include <fp_class.h>
2163# endif
25c46df8 2164# if defined(FP_POS_INF) && defined(FP_QNAN)
033a6f7a 2165# ifdef __sgi /* XXX Configure test instead */
25c46df8
JH		 2166# ifdef USE_LONG_DOUBLE
2167# define Perl_fp_class(x) fp_class_l(x)
2168# else
2169# define Perl_fp_class(x) fp_class_d(x)
2170# endif
f279e099 2171# else
25c46df8
JH		 2172# if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2173# define Perl_fp_class(x) fp_classl(x)
2174# else
2175# define Perl_fp_class(x) fp_class(x)
2176# endif
f279e099 2177# endif
25c46df8
JH		 2178# if defined(FP_POS_INF) && defined(FP_QNAN)
2179# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_SNAN)
2180# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_QNAN)
2181# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_NEG_INF)
2182# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_POS_INF)
2183# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_NEG_NORM)
2184# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_POS_NORM)
2185# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_NEG_DENORM)
2186# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_POS_DENORM)
2187# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_NEG_ZERO)
2188# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_POS_ZERO)
30404d48 2189# else
25c46df8 2190# undef Perl_fp_class /* Unknown set of defines */
30404d48 2191# endif
f279e099 2192# endif
30404d48
JH		 2193#endif
2194
052758ae 2195/* class(), _class(): Legacy: AIX. */
758a5d79
JH		 2196#if !defined(Perl_fp_class) && defined(HAS_CLASS)
2197# include <math.h>
25c46df8
JH		 2198# if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2199# ifndef _cplusplus
2200# define Perl_fp_class(x) class(x)
2201# else
2202# define Perl_fp_class(x) _class(x)
2203# endif
2204# if defined(FP_PLUS_INF) && defined(FP_NANQ)
2205# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_NANS)
2206# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_NANQ)
2207# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
2208# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
2209# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
2210# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
2211# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
2212# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
2213# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
2214# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
2215# else
2216# undef Perl_fp_class /* Unknown set of defines */
2217# endif
758a5d79 2218# endif
30404d48
JH		 2219#endif
2220
2221/* Win32: _fpclass(), _isnan(), _finite(). */
90f54b14 2222#ifdef _MSC_VER
796ea9ea
JH		 2223# ifndef Perl_isnan
2224# define Perl_isnan(x) _isnan(x)
2225# endif
2226# ifndef Perl_isfinite
2227# define Perl_isfinite(x) _finite(x)
2228# endif
2229# ifndef Perl_fp_class_snan
25c46df8
JH		 2230/* No simple way to #define Perl_fp_class because _fpclass()
2231 * returns a set of bits. */
796ea9ea
JH		 2232# define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2233# define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
82947af8 2234# define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
796ea9ea
JH		 2235# define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF))
2236# define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF))
2237# define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2238# define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2239# define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2240# define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2241# define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2242# define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2243# define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2244# define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2245# define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2246# define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2247# endif
f279e099
JH		 2248#endif
2249
2250#if !defined(Perl_fp_class_inf) && \
2251 defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2252# define Perl_fp_class_inf(x) \
2253 (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2254#endif
2255
2256#if !defined(Perl_fp_class_nan) && \
2257 defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2258# define Perl_fp_class_nan(x) \
2259 (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2260#endif
2261
2262#if !defined(Perl_fp_class_zero) && \
2263 defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2264# define Perl_fp_class_zero(x) \
2265 (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2266#endif
2267
2268#if !defined(Perl_fp_class_norm) && \
2269 defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2270# define Perl_fp_class_norm(x) \
2271 (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2272#endif
2273
2274#if !defined(Perl_fp_class_denorm) && \
2275 defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2276# define Perl_fp_class_denorm(x) \
2277 (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
796ea9ea 2278#endif
758a5d79 2279
1a322af2
JH		 2280#ifdef UNDER_CE
2281int isnan(double d);
2282#endif
2283
758a5d79 2284#ifndef Perl_isnan
1a322af2
JH		 2285# ifdef Perl_fp_class_nan
2286# define Perl_isnan(x) Perl_fp_class_nan(x)
da5fdda8
AC		 2287# elif defined(HAS_UNORDERED)
2288# define Perl_isnan(x) unordered((x), 0.0)
758a5d79 2289# else
da5fdda8 2290# define Perl_isnan(x) ((x)!=(x))
758a5d79
JH		 2291# endif
2292#endif
2293
1a322af2
JH		 2294#ifndef Perl_isinf
2295# ifdef Perl_fp_class_inf
2296# define Perl_isinf(x) Perl_fp_class_inf(x)
2297# endif
ca6c63e1
JH		 2298#endif
2299
758a5d79 2300#ifndef Perl_isfinite
25c46df8 2301# if defined(HAS_ISFINITE) && !defined(isfinite)
c496ca58 2302# define Perl_isfinite(x) isfinite((double)(x))
4efd38a4 2303# elif defined(HAS_FINITE)
c496ca58 2304# define Perl_isfinite(x) finite((double)(x))
4efd38a4
JH		 2305# elif defined(Perl_fp_class_finite)
2306# define Perl_isfinite(x) Perl_fp_class_finite(x)
758a5d79 2307# else
c496ca58
JH		 2308/* For the infinities the multiplication returns nan,
2309 * for the nan the multiplication also returns nan,
2310 * for everything else (that is, finite) zero should be returned. */
4efd38a4 2311# define Perl_isfinite(x) (((x) * 0) == 0)
a3540c92 2312# endif
65202027
DS		 2313#endif
2314
25c46df8
JH		 2315#ifndef Perl_isinf
2316# if defined(Perl_isfinite) && defined(Perl_isnan)
2317# define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2318# endif
2319#endif
2320
d3685250
JH		 2321/* We need Perl_isfinitel (ends with ell) (if available) even when
2322 * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2323 * needs that. */
2324#if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2325/* If isfinite() is a macro and looks like we have C99,
2326 * we assume it's the type-aware C99 isfinite(). */
c06e9e3e 2327# if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
d3685250
JH		 2328# define Perl_isfinitel(x) isfinite(x)
2329# elif defined(HAS_ISFINITEL)
2330# define Perl_isfinitel(x) isfinitel(x)
2331# elif defined(HAS_FINITEL)
2332# define Perl_isfinitel(x) finitel(x)
2333# elif defined(HAS_INFL) && defined(HAS_NANL)
2334# define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
16334e6e 2335# else
99bf9e32 2336# define Perl_isfinitel(x) ((x) * 0 == 0) /* See Perl_isfinite. */
d3685250
JH		 2337# endif
2338#endif
2339
a36244b7
JH		 2340/* The default is to use Perl's own atof() implementation (in numeric.c).
2341 * Usually that is the one to use but for some platforms (e.g. UNICOS)
2342 * it is however best to use the native implementation of atof.
2343 * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2344 * Some good tests to try out with either setting are t/base/num.t,
205f51d8
AS		 2345 * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2346 * you may need to be using a different function than atof! */
a36244b7
JH		 2347
2348#ifndef USE_PERL_ATOF
2349# ifndef _UNICOS
2350# define USE_PERL_ATOF
2351# endif
2352#else
2353# if USE_PERL_ATOF == 0
2354# undef USE_PERL_ATOF
2355# endif
2356#endif
2357
2358#ifdef USE_PERL_ATOF
2359# define Perl_atof(s) Perl_my_atof(s)
6928bedc 2360# define Perl_atof2(s, n) Perl_my_atof3(aTHX_ (s), &(n), 0)
a36244b7
JH		 2361#else
2362# define Perl_atof(s) (NV)atof(s)
2363# define Perl_atof2(s, n) ((n) = atof(s))
2364#endif
6928bedc 2365#define my_atof2(a,b) my_atof3(a,b,0)
cf2093f6 2366
99abf803
PP		 2367/*
2368 * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2369 * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2370 * depending on local options. Until Configure detects this (or at least
2371 * detects whether the "signed" keyword is available) the CHAR ranges
2372 * will not be included. UCHAR functions normally.
2373 * - kja
2374 */
27d4fb96 2375
6ec488b3
AC		 2376#define PERL_UCHAR_MIN ((unsigned char)0)
2377#define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
27d4fb96 2378
6ec488b3
AC		 2379#define PERL_USHORT_MIN ((unsigned short)0)
2380#define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
27d4fb96 2381
6ec488b3
AC		 2382#define PERL_SHORT_MAX ((short)SHRT_MAX)
2383#define PERL_SHORT_MIN ((short)SHRT_MIN)
27d4fb96 2384
6ec488b3 2385#define PERL_UINT_MAX ((unsigned int)UINT_MAX)
99abf803 2386#define PERL_UINT_MIN ((unsigned int)0)
27d4fb96 2387
6ec488b3
AC		 2388#define PERL_INT_MAX ((int)INT_MAX)
2389#define PERL_INT_MIN ((int)INT_MIN)
27d4fb96 2390
6ec488b3 2391#define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
99abf803 2392#define PERL_ULONG_MIN ((unsigned long)0L)
27d4fb96 2393
6ec488b3
AC		 2394#define PERL_LONG_MAX ((long)LONG_MAX)
2395#define PERL_LONG_MIN ((long)LONG_MIN)
760ac839 2396
d7d93a81 2397#ifdef UV_IS_QUAD
99abf803 2398# define PERL_UQUAD_MAX (~(UV)0)
f1c3b19a 2399# define PERL_UQUAD_MIN ((UV)0)
99abf803 2400# define PERL_QUAD_MAX ((IV) (PERL_UQUAD_MAX >> 1))
a6e633de 2401# define PERL_QUAD_MIN (-PERL_QUAD_MAX - ((3 & -1) == 3))
79072805
LW		 2402#endif
2403
ee0007ab 2404typedef MEM_SIZE STRLEN;
450a55e4 2405
79072805
LW		 2406typedef struct op OP;
2407typedef struct cop COP;
2408typedef struct unop UNOP;
2f7c6295 2409typedef struct unop_aux UNOP_AUX;
79072805
LW		 2410typedef struct binop BINOP;
2411typedef struct listop LISTOP;
2412typedef struct logop LOGOP;
79072805
LW		 2413typedef struct pmop PMOP;
2414typedef struct svop SVOP;
7934575e 2415typedef struct padop PADOP;
79072805 2416typedef struct pvop PVOP;
79072805 2417typedef struct loop LOOP;
b46e009d 2418typedef struct methop METHOP;
79072805 2419
7aef8e5b 2420#ifdef PERL_CORE
8be227ab
FC		 2421typedef struct opslab OPSLAB;
2422typedef struct opslot OPSLOT;
2423#endif
2424
52db365a 2425typedef struct block_hooks BHK;
1830b3d9 2426typedef struct custom_op XOP;
52db365a 2427
cd1541b2
NC		 2428typedef struct interpreter PerlInterpreter;
2429
d2b3f365 2430/* SGI's <sys/sema.h> has struct sv */
cc3315ba 2431#if defined(__sgi)
d2b3f365 2432# define STRUCT_SV perl_sv
b8d3c5db
JH		 2433#else
2434# define STRUCT_SV sv
2435#endif
2436typedef struct STRUCT_SV SV;
79072805
LW		 2437typedef struct av AV;
2438typedef struct hv HV;
2439typedef struct cv CV;
d2f13c59 2440typedef struct p5rx REGEXP;
79072805 2441typedef struct gp GP;
0c30d9ec 2442typedef struct gv GV;
8990e307 2443typedef struct io IO;
c09156bb 2444typedef struct context PERL_CONTEXT;
79072805
LW		 2445typedef struct block BLOCK;
2446
2447typedef struct magic MAGIC;
2448typedef struct xpv XPV;
2449typedef struct xpviv XPVIV;
ff68c719 2450typedef struct xpvuv XPVUV;
79072805
LW		 2451typedef struct xpvnv XPVNV;
2452typedef struct xpvmg XPVMG;
2453typedef struct xpvlv XPVLV;
d361b004 2454typedef struct xpvinvlist XINVLIST;
79072805
LW		 2455typedef struct xpvav XPVAV;
2456typedef struct xpvhv XPVHV;
2457typedef struct xpvgv XPVGV;
2458typedef struct xpvcv XPVCV;
2459typedef struct xpvbm XPVBM;
2460typedef struct xpvfm XPVFM;
8990e307 2461typedef struct xpvio XPVIO;
79072805
LW		 2462typedef struct mgvtbl MGVTBL;
2463typedef union any ANY;
5f7fde29
GS		 2464typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2465typedef struct ptr_tbl PTR_TBL_t;
8cf8f3d1
NIS		 2466typedef struct clone_params CLONE_PARAMS;
2467
0f94cb1f 2468/* a pad is currently just an AV; but that might change,
7261499d
FC		 2469 * so hide the type. */
2470typedef struct padlist PADLIST;
67634234 2471typedef AV PAD;
9b7476d7 2472typedef struct padnamelist PADNAMELIST;
0f94cb1f 2473typedef struct padname PADNAME;
67634234 2474
5a736967
DM		 2475/* always enable PERL_OP_PARENT */
2476#if !defined(PERL_OP_PARENT)
5d32d268
DM		 2477# define PERL_OP_PARENT
2478#endif
2479
93c10d60
FC		 2480/* enable PERL_COPY_ON_WRITE by default */
2481#if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2482# define PERL_COPY_ON_WRITE
13b0f67d 2483#endif
07d01d6e 2484
93c10d60 2485#ifdef PERL_COPY_ON_WRITE
db2c6cb3 2486# define PERL_ANY_COW
9f351b45
DM		 2487#else
2488# define PERL_SAWAMPERSAND
db2c6cb3
FC		 2489#endif
2490
40653c20
FC		 2491#if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2492# error PERL_DEBUG_READONLY_OPS only works with ithreads
2493#endif
2494
378cc40b 2495#include "handy.h"
64935bc6 2496#include "charclass_invlists.h"
a0d0e21e 2497
6b8eaf93 2498#if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
6b8eaf93
JH		 2499# if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2500# define USE_64_BIT_RAWIO /* implicit */
2501# endif
4564133c
JH		 2502#endif
2503
6b8eaf93
JH		 2504/* Notice the use of HAS_FSEEKO: now we are obligated to always use
2505 * fseeko/ftello if possible. Don't go #defining ftell to ftello yourself,
2506 * however, because operating systems like to do that themself. */
2507#ifndef FSEEKSIZE
2508# ifdef HAS_FSEEKO
2509# define FSEEKSIZE LSEEKSIZE
2510# else
2511# define FSEEKSIZE LONGSIZE
d460ef45 2512# endif
6b8eaf93
JH		 2513#endif
2514
2515#if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
6b8eaf93
JH		 2516# if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2517# define USE_64_BIT_STDIO /* implicit */
2518# endif
2519#endif
4564133c 2520
09458382 2521#ifdef USE_64_BIT_RAWIO
d9b3e12d
JH		 2522# ifdef HAS_OFF64_T
2523# undef Off_t
2524# define Off_t off64_t
2525# undef LSEEKSIZE
2526# define LSEEKSIZE 8
5ff3f7a4 2527# endif
d9b3e12d
JH		 2528/* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2529 * will trigger defines like the ones below. Some 64-bit environments,
09458382 2530 * however, do not. Therefore we have to explicitly mix and match. */
d9b3e12d
JH		 2531# if defined(USE_OPEN64)
2532# define open open64
5ff3f7a4 2533# endif
d9b3e12d
JH		 2534# if defined(USE_LSEEK64)
2535# define lseek lseek64
6b8eaf93
JH		 2536# else
2537# if defined(USE_LLSEEK)
2538# define lseek llseek
2539# endif
d9b3e12d
JH		 2540# endif
2541# if defined(USE_STAT64)
2542# define stat stat64
2543# endif
2544# if defined(USE_FSTAT64)
2545# define fstat fstat64
2546# endif
2547# if defined(USE_LSTAT64)
2548# define lstat lstat64
2549# endif
2550# if defined(USE_FLOCK64)
2551# define flock flock64
2552# endif
2553# if defined(USE_LOCKF64)
2554# define lockf lockf64
2555# endif
2556# if defined(USE_FCNTL64)
2557# define fcntl fcntl64
2558# endif
2559# if defined(USE_TRUNCATE64)
2560# define truncate truncate64
2561# endif
2562# if defined(USE_FTRUNCATE64)
2563# define ftruncate ftruncate64
2564# endif
2565#endif
2566
2567#ifdef USE_64_BIT_STDIO
2568# ifdef HAS_FPOS64_T
2569# undef Fpos_t
2570# define Fpos_t fpos64_t
2571# endif
2572/* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2573 * will trigger defines like the ones below. Some 64-bit environments,
2574 * however, do not. */
2575# if defined(USE_FOPEN64)
2576# define fopen fopen64
2577# endif
2578# if defined(USE_FSEEK64)
6b8eaf93 2579# define fseek fseek64 /* don't do fseeko here, see perlio.c */
d9b3e12d
JH		 2580# endif
2581# if defined(USE_FTELL64)
6b8eaf93 2582# define ftell ftell64 /* don't do ftello here, see perlio.c */
d9b3e12d
JH		 2583# endif
2584# if defined(USE_FSETPOS64)
2585# define fsetpos fsetpos64
2586# endif
2587# if defined(USE_FGETPOS64)
2588# define fgetpos fgetpos64
2589# endif
2590# if defined(USE_TMPFILE64)
2591# define tmpfile tmpfile64
2592# endif
2593# if defined(USE_FREOPEN64)
2594# define freopen freopen64
5ff3f7a4
GS		 2595# endif
2596#endif
2597
e37778c2 2598#if defined(OS2)
2c2d71f5
JH		 2599# include "iperlsys.h"
2600#endif
2601
748a9306 2602#ifdef DOSISH
19848b3f
JH		 2603# if defined(OS2)
2604# include "os2ish.h"
2605# else
2606# include "dosish.h"
2607# endif
009819bb 2608#elif defined(VMS)
748a9306 2609# include "vmsish.h"
009819bb 2610#elif defined(PLAN9)
19848b3f 2611# include "./plan9/plan9ish.h"
009819bb 2612#elif defined(__VOS__)
196918b0
PG		 2613# ifdef __GNUC__
2614# include "./vos/vosish.h"
2615# else
2616# include "vos/vosish.h"
2617# endif
009819bb 2618#elif defined(__SYMBIAN32__)
27da23d5 2619# include "symbian/symbianish.h"
009819bb 2620#elif defined(__HAIKU__)
df00ff3b 2621# include "haiku/haikuish.h"
009819bb 2622#else
19848b3f 2623# include "unixish.h"
13b6e58c
JH		 2624#endif
2625
ea34f6bd 2626#ifdef __amigaos4__
3c0208ad
AB		 2627# include "amigaos.h"
2628# undef FD_CLOEXEC /* a lie in AmigaOS */
2629#endif
2630
2946a158 2631/* NSIG logic from Configure --> */
2946a158
JH		 2632#ifndef NSIG
2633# ifdef _NSIG
2634# define NSIG (_NSIG)
da5fdda8 2635# elif defined(SIGMAX)
2946a158 2636# define NSIG (SIGMAX+1)
da5fdda8 2637# elif defined(SIG_MAX)
2946a158 2638# define NSIG (SIG_MAX+1)
da5fdda8 2639# elif defined(_SIG_MAX)
2946a158 2640# define NSIG (_SIG_MAX+1)
da5fdda8 2641# elif defined(MAXSIG)
2946a158 2642# define NSIG (MAXSIG+1)
da5fdda8 2643# elif defined(MAX_SIG)
2946a158 2644# define NSIG (MAX_SIG+1)
da5fdda8 2645# elif defined(SIGARRAYSIZE)
2946a158 2646# define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
da5fdda8 2647# elif defined(_sys_nsig)
2946a158 2648# define NSIG (_sys_nsig) /* Solaris 2.5 */
da5fdda8
AC		 2649# else
2650 /* Default to some arbitrary number that's big enough to get most
2651 * of the common signals. */
2946a158 2652# define NSIG 50
da5fdda8 2653# endif
2946a158
JH		 2654#endif
2655/* <-- NSIG logic from Configure */
2656
13b6e58c
JH		 2657#ifndef NO_ENVIRON_ARRAY
2658# define USE_ENVIRON_ARRAY
2659#endif
32f822de 2660
c77b533b
JH		 2661/*
2662 * initialise to avoid floating-point exceptions from overflow, etc
2663 */
2664#ifndef PERL_FPU_INIT
2665# ifdef HAS_FPSETMASK
2666# if HAS_FLOATINGPOINT_H
2667# include <floatingpoint.h>
2668# endif
ad3a8c67
NC		 2669/* Some operating systems have this as a macro, which in turn expands to a comma
2670 expression, and the last sub-expression is something that gets calculated,
2671 and then they have the gall to warn that a value computed is not used. Hence
2672 cast to void. */
2673# define PERL_FPU_INIT (void)fpsetmask(0)
da5fdda8
AC		 2674# elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2675# define PERL_FPU_INIT PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2676# define PERL_FPU_PRE_EXEC { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2677# define PERL_FPU_POST_EXEC rsignal_restore(SIGFPE, &xfpe); }
c77b533b 2678# else
da5fdda8 2679# define PERL_FPU_INIT
c77b533b
JH		 2680# endif
2681#endif
b35112e7
CS		 2682#ifndef PERL_FPU_PRE_EXEC
2683# define PERL_FPU_PRE_EXEC {
2684# define PERL_FPU_POST_EXEC }
2685#endif
c77b533b 2686
a308b05a
JH		 2687/* In Tru64 the cc -ieee enables the IEEE math but disables traps.
2688 * We need to reenable the "invalid" trap because otherwise generation
2689 * of NaN values leaves the IEEE fp flags in bad state, leaving any further
2690 * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
2691#ifdef __osf__
2692# include <machine/fpu.h>
2693# define PERL_SYS_FPU_INIT \
2694 STMT_START { \
2695 ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
2696 signal(SIGFPE, SIG_IGN); \
2697 } STMT_END
2698#endif
94a08944
JH		 2699/* In IRIX the default for Flush to Zero bit is true,
2700 * which means that results going below the minimum of normal
2701 * floating points go to zero, instead of going denormal/subnormal.
2702 * This is unlike almost any other system running Perl, so let's clear it.
2703 * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
2704 * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
2705 *
2706 * XXX The flush-to-zero behaviour should be a Configure scan.
2707 * To change the behaviour usually requires some system-specific
2708 * incantation, though, like the below. */
2709#ifdef __sgi
2710# include <sys/fpu.h>
2711# define PERL_SYS_FPU_INIT \
2712 STMT_START { \
2713 union fpc_csr csr; \
2714 csr.fc_word = get_fpc_csr(); \
2715 csr.fc_struct.flush = 0; \
2716 set_fpc_csr(csr.fc_word); \
2717 } STMT_END
2718#endif
a308b05a
JH		 2719
2720#ifndef PERL_SYS_FPU_INIT
2721# define PERL_SYS_FPU_INIT NOOP
2722#endif
2723
cbec8ebe
DM		 2724#ifndef PERL_SYS_INIT3_BODY
2725# define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
ed344e4f
IZ		 2726#endif
2727
eb533572 2728/*
dcccc8ff
KW		 2729=head1 Miscellaneous Functions
2730
4ad9e498 2731=for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
eb533572 2732Provides system-specific tune up of the C runtime environment necessary to
72d33970 2733run Perl interpreters. This should be called only once, before creating
eb533572
DM		 2734any Perl interpreters.
2735
4ad9e498 2736=for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
eb533572 2737Provides system-specific tune up of the C runtime environment necessary to
72d33970 2738run Perl interpreters. This should be called only once, before creating
eb533572
DM		 2739any Perl interpreters.
2740
2741=for apidoc Am|void|PERL_SYS_TERM|
2742Provides system-specific clean up of the C runtime environment after
72d33970 2743running Perl interpreters. This should be called only once, after
eb533572
DM		 2744freeing any remaining Perl interpreters.
2745
2746=cut
2747 */
2748
cbec8ebe
DM		 2749#define PERL_SYS_INIT(argc, argv) Perl_sys_init(argc, argv)
2750#define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
d0820ef1 2751#define PERL_SYS_TERM() Perl_sys_term()
cbec8ebe 2752
be708cc0
JH		 2753#ifndef PERL_WRITE_MSG_TO_CONSOLE
2754# define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
2755#endif
2756
0f31cffe
GS		 2757#ifndef MAXPATHLEN
2758# ifdef PATH_MAX
b990c8b2
JH		 2759# ifdef _POSIX_PATH_MAX
2760# if PATH_MAX > _POSIX_PATH_MAX
09448d78
JH		 2761/* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
2762 * included the null byte or not. Later amendments of POSIX,
2763 * XPG4, the Austin Group, and the Single UNIX Specification
2764 * all explicitly include the null byte in the PATH_MAX.
2765 * Ditto for _POSIX_PATH_MAX. */
2766# define MAXPATHLEN PATH_MAX
b990c8b2 2767# else
09448d78 2768# define MAXPATHLEN _POSIX_PATH_MAX
b990c8b2
JH		 2769# endif
2770# else
2771# define MAXPATHLEN (PATH_MAX+1)
2772# endif
0f31cffe 2773# else
d552bce8 2774# define MAXPATHLEN 1024 /* Err on the large side. */
0f31cffe
GS		 2775# endif
2776#endif
2777
c80263a8
SH		 2778/* In case Configure was not used (we are using a "canned config"
2779 * such as Win32, or a cross-compilation setup, for example) try going
2780 * by the gcc major and minor versions. One useful URL is
2781 * http://www.ohse.de/uwe/articles/gcc-attributes.html,
2782 * but contrary to this information warn_unused_result seems
2783 * not to be in gcc 3.3.5, at least. --jhi
42bf5550
AD		 2784 * Also, when building extensions with an installed perl, this allows
2785 * the user to upgrade gcc and get the right attributes, rather than
2786 * relying on the list generated at Configure time. --AD
c80263a8
SH		 2787 * Set these up now otherwise we get confused when some of the <*thread.h>
2788 * includes below indirectly pull in <perlio.h> (which needs to know if we
2789 * have HASATTRIBUTE_FORMAT).
2790 */
2791
4d7c7898 2792#ifndef PERL_MICRO
fc2007d4 2793#if defined __GNUC__ && !defined(__INTEL_COMPILER)
6a387721
RGS		 2794# if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
2795# define HASATTRIBUTE_DEPRECATED
2796# endif
c80263a8
SH		 2797# if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
2798# define HASATTRIBUTE_FORMAT
63cdf24b
SH		 2799# if defined __MINGW32__
2800# define PRINTF_FORMAT_NULL_OK
2801# endif
c80263a8
SH		 2802# endif
2803# if __GNUC__ >= 3 /* 3.0 -> */
2804# define HASATTRIBUTE_MALLOC
2805# endif
2806# if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
2807# define HASATTRIBUTE_NONNULL
2808# endif
2809# if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
2810# define HASATTRIBUTE_NORETURN
2811# endif
2812# if __GNUC__ >= 3 /* gcc 3.0 -> */
2813# define HASATTRIBUTE_PURE
2814# endif
42bf5550 2815# if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
c80263a8
SH		 2816# define HASATTRIBUTE_UNUSED
2817# endif
d324fe49
AD		 2818# if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
2819# define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
2820# endif
c80263a8
SH		 2821# if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2822# define HASATTRIBUTE_WARN_UNUSED_RESULT
2823# endif
2824#endif
00f254e2 2825#endif /* #ifndef PERL_MICRO */
c80263a8 2826
3db8f154 2827/* USE_5005THREADS needs to be after unixish.h as <pthread.h> includes
dd96f567 2828 * <sys/signal.h> which defines NSIG - which will stop inclusion of <signal.h>
32f822de
GS		 2829 * this results in many functions being undeclared which bothers C++
2830 * May make sense to have threads after "*ish.h" anyway
2831 */
2832
3baee7cc
JH		 2833/* clang Thread Safety Analysis/Annotations/Attributes
2834 * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
2835 *
bdc795f4 2836 * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
3baee7cc 2837 * Apple XCode hijacks __clang_major__ and __clang_minor__
bdc795f4
JH		 2838 * (6.1 means really clang 3.6), so needs extra hijinks
2839 * (could probably also test the contents of __apple_build_version__).
3baee7cc
JH		 2840 */
2841#if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
2842 defined(__clang__) && \
ab0fe36e
DM		 2843 !defined(PERL_GLOBAL_STRUCT) && \
2844 !defined(PERL_GLOBAL_STRUCT_PRIVATE) && \
3baee7cc
JH		 2845 !defined(SWIG) && \
2846 ((!defined(__apple_build_version__) && \
bdc795f4 2847 ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
8412ccf9 2848 (__clang_major__ >= 4))) || \
3baee7cc 2849 (defined(__apple_build_version__) && \
bdc795f4
JH		 2850 ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
2851 (__clang_major__ >= 7))))
3baee7cc
JH		 2852# define PERL_TSA__(x) __attribute__((x))
2853# define PERL_TSA_ACTIVE
2854#else
2855# define PERL_TSA__(x) /* No TSA, make TSA attributes no-ops. */
2856# undef PERL_TSA_ACTIVE
2857#endif
2858
2859/* PERL_TSA_CAPABILITY() is used to annotate typedefs.
2860 * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
2861 */
2862#define PERL_TSA_CAPABILITY(x) \
2863 PERL_TSA__(capability(x))
2864
2865/* In the below examples the mutex must be lexically visible, usually
2866 * either as global variables, or as function arguments. */
2867
2868/* PERL_TSA_GUARDED_BY() is used to annotate global variables.
2869 *
2870 * Foo foo PERL_TSA_GUARDED_BY(mutex);
2871 */
2872#define PERL_TSA_GUARDED_BY(x) \
2873 PERL_TSA__(guarded_by(x))
2874
2875/* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
2876 * The data _behind_ the pointer is guarded.
2877 *
2878 * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
2879 */
2880#define PERL_TSA_PT_GUARDED_BY(x) \
2881 PERL_TSA__(pt_guarded_by(x))
2882
2883/* PERL_TSA_REQUIRES() is used to annotate functions.
2884 * The caller MUST hold the resource when calling the function.
2885 *
2886 * void Foo() PERL_TSA_REQUIRES(mutex);
2887 */
2888#define PERL_TSA_REQUIRES(x) \
2889 PERL_TSA__(requires_capability(x))
2890
2891/* PERL_TSA_EXCLUDES() is used to annotate functions.
2892 * The caller MUST NOT hold resource when calling the function.
2893 *
2894 * EXCLUDES should be used when the function first acquires
2895 * the resource and then releases it. Use to avoid deadlock.
2896 *
2897 * void Foo() PERL_TSA_EXCLUDES(mutex);
2898 */
2899#define PERL_TSA_EXCLUDES(x) \
2900 PERL_TSA__(locks_excluded(x))
2901
2902/* PERL_TSA_ACQUIRE() is used to annotate functions.
2903 * The caller MUST NOT hold the resource when calling the function,
2904 * and the function will acquire the resource.
2905 *
2906 * void Foo() PERL_TSA_ACQUIRE(mutex);
2907 */
2908#define PERL_TSA_ACQUIRE(x) \
2909 PERL_TSA__(acquire_capability(x))
2910
2911/* PERL_TSA_RELEASE() is used to annotate functions.
2912 * The caller MUST hold the resource when calling the function,
2913 * and the function will release the resource.
2914 *
2915 * void Foo() PERL_TSA_RELEASE(mutex);
2916 */
2917#define PERL_TSA_RELEASE(x) \
2918 PERL_TSA__(release_capability(x))
2919
2920/* PERL_TSA_NO_TSA is used to annotate functions.
2921 * Used when being intentionally unsafe, or when the code is too
2922 * complicated for the analysis. Use sparingly.
2923 *
2924 * void Foo() PERL_TSA_NO_TSA;
2925 */
2926#define PERL_TSA_NO_TSA \
2927 PERL_TSA__(no_thread_safety_analysis)
2928
2929/* There are more annotations/attributes available, see the clang
2930 * documentation for details. */
2931
3db8f154 2932#if defined(USE_ITHREADS)
2986a63f 2933# ifdef NETWARE
da5fdda8
AC		 2934# include <nw5thread.h>
2935# elif defined(WIN32)
2936# include <win32thread.h>
2937# elif defined(OS2)
2938# include "os2thread.h"
2939# elif defined(I_MACH_CTHREADS)
2940# include <mach/cthreads.h>
7f3d1cf1
BH		 2941typedef cthread_t perl_os_thread;
2942typedef mutex_t perl_mutex;
2943typedef condition_t perl_cond;
2944typedef void * perl_key;
da5fdda8
AC		 2945# elif defined(I_PTHREAD) /* Posix threads */
2946# include <pthread.h>
7f3d1cf1 2947typedef pthread_t perl_os_thread;
3baee7cc 2948typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
7f3d1cf1
BH		 2949typedef pthread_cond_t perl_cond;
2950typedef pthread_key_t perl_key;
da5fdda8 2951# endif
3db8f154 2952#endif /* USE_ITHREADS */
c5be433b 2953
3baee7cc
JH		 2954#ifdef PERL_TSA_ACTIVE
2955/* Since most pthread mutex interfaces have not been annotated, we
2956 * need to have these wrappers. The NO_TSA annotation is quite ugly
2957 * but it cannot be avoided in plain C, unlike in C++, where one could
2958 * e.g. use ACQUIRE() with no arg on a mutex lock method.
2959 *
2960 * The bodies of these wrappers are in util.c
2961 *
2962 * TODO: however, some platforms are starting to get these clang
2963 * thread safety annotations for pthreads, for example FreeBSD.
2964 * Do we need a way to a bypass these wrappers? */
67083b7b 2965EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
3baee7cc
JH		 2966 PERL_TSA_ACQUIRE(*mutex)
2967 PERL_TSA_NO_TSA;
67083b7b 2968EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
3baee7cc
JH		 2969 PERL_TSA_RELEASE(*mutex)
2970 PERL_TSA_NO_TSA;
2971#endif
2972
66a93824 2973#if defined(WIN32)
1feb2720 2974# include "win32.h"
c5be433b
GS		 2975#endif
2976
2986a63f
JH		 2977#ifdef NETWARE
2978# include "netware.h"
2979#endif
2980
e5218da5 2981#define STATUS_UNIX PL_statusvalue
68dc0745 2982#ifdef VMS
6b88bc9c 2983# define STATUS_NATIVE PL_statusvalue_vms
7a7fd8e0
JM		 2984/*
2985 * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
ff7298cb 2986 * its contents can not be trusted. Unfortunately, Perl seems to check
7a7fd8e0
JM		 2987 * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
2988 * be updated also.
2989 */
2990# include <stsdef.h>
2991# include <ssdef.h>
2992/* Presume this because if VMS changes it, it will require a new
2993 * set of APIs for waiting on children for binary compatibility.
2994 */
2995# define child_offset_bits (8)
2996# ifndef C_FAC_POSIX
2997# define C_FAC_POSIX 0x35A000
2998# endif
2999
3000/* STATUS_EXIT - validates and returns a NATIVE exit status code for the
3001 * platform from the existing UNIX or Native status values.
3002 */
3003
37038d91 3004# define STATUS_EXIT \
7a7fd8e0
JM		 3005 (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
3006 (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
3007
7a7fd8e0 3008
fb38d079
JM		 3009/* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
3010 * exit code and shifts the UNIX value over the correct number of bits to
3011 * be a child status. Usually the number of bits is 8, but that could be
3012 * platform dependent. The NATIVE status code is presumed to have either
3013 * from a child process.
7a7fd8e0
JM		 3014 */
3015
fb38d079
JM		 3016/* This is complicated. The child processes return a true native VMS
3017 status which must be saved. But there is an assumption in Perl that
3018 the UNIX child status has some relationship to errno values, so
00f254e2 3019 Perl tries to translate it to text in some of the tests.
fb38d079
JM		 3020 In order to get the string translation correct, for the error, errno
3021 must be EVMSERR, but that generates a different text message
3022 than what the test programs are expecting. So an errno value must
3023 be derived from the native status value when an error occurs.
3024 That will hide the true native status message. With this version of
3025 perl, the true native child status can always be retrieved so that
3026 is not a problem. But in this case, Pl_statusvalue and errno may
3027 have different values in them.
3028 */
7a7fd8e0 3029
fb38d079 3030# define STATUS_NATIVE_CHILD_SET(n) \
68dc0745 3031 STMT_START { \
2fbb330f
JM		 3032 I32 evalue = (I32)n; \
3033 if (evalue == EVMSERR) { \
3034 PL_statusvalue_vms = vaxc$errno; \
3035 PL_statusvalue = evalue; \
7a7fd8e0 3036 } else { \
2fbb330f 3037 PL_statusvalue_vms = evalue; \
fb38d079 3038 if (evalue == -1) { \
3280af22 3039 PL_statusvalue = -1; \
7a7fd8e0
JM		 3040 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3041 } else \
fb38d079 3042 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1); \
2fbb330f 3043 set_vaxc_errno(evalue); \
fb38d079
JM		 3044 if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX) \
3045 set_errno(EVMSERR); \
3046 else set_errno(Perl_vms_status_to_unix(evalue, 0)); \
3047 PL_statusvalue = PL_statusvalue << child_offset_bits; \
2fbb330f 3048 } \
68dc0745 3049 } STMT_END
7a7fd8e0 3050
68dc0745 3051# ifdef VMSISH_STATUS
e5218da5 3052# define STATUS_CURRENT (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
68dc0745 3053# else
e5218da5 3054# define STATUS_CURRENT STATUS_UNIX
68dc0745 3055# endif
7a7fd8e0
JM		 3056
3057 /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3058 * the NATIVE status to an equivalent value. Can not be used to translate
3059 * exit code values as exit code values are not guaranteed to have any
3060 * relationship at all to errno values.
3061 * This is used when Perl is forcing errno to have a specific value.
3062 */
e5218da5 3063# define STATUS_UNIX_SET(n) \
68dc0745 3064 STMT_START { \
7a7fd8e0 3065 I32 evalue = (I32)n; \
0968cdad 3066 PL_statusvalue = evalue; \
3280af22 3067 if (PL_statusvalue != -1) { \
0968cdad
JM		 3068 if (PL_statusvalue != EVMSERR) { \
3069 PL_statusvalue &= 0xFFFF; \
3070 if (MY_POSIX_EXIT) \
3071 PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3072 else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3073 } \
3074 else { \
3075 PL_statusvalue_vms = vaxc$errno; \
3076 } \
68dc0745 3077 } \
0968cdad
JM		 3078 else PL_statusvalue_vms = SS$_ABORT; \
3079 set_vaxc_errno(PL_statusvalue_vms); \
7a7fd8e0
JM		 3080 } STMT_END
3081
3082 /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
e08e1e1d
JM		 3083 * the NATIVE error status based on it.
3084 *
3085 * When in the default mode to comply with the Perl VMS documentation,
3086 * 0 is a success and any other code sets the NATIVE status to a failure
3087 * code of SS$_ABORT.
fb38d079
JM		 3088 *
3089 * In the new POSIX EXIT mode, native status will be set so that the
3090 * actual exit code will can be retrieved by the calling program or
3091 * shell.
3092 *
3093 * If the exit code is not clearly a UNIX parent or child exit status,
3094 * it will be passed through as a VMS status.
7a7fd8e0
JM		 3095 */
3096
fb38d079 3097# define STATUS_UNIX_EXIT_SET(n) \
7a7fd8e0
JM		 3098 STMT_START { \
3099 I32 evalue = (I32)n; \
3100 PL_statusvalue = evalue; \
e08e1e1d
JM		 3101 if (MY_POSIX_EXIT) { \
3102 if (evalue <= 0xFF00) { \
3103 if (evalue > 0xFF) \
3104 evalue = (evalue >> child_offset_bits) & 0xFF; \
3105 PL_statusvalue_vms = \
3106 (C_FAC_POSIX | (evalue << 3 ) | \
3107 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3108 } else /* forgive them Perl, for they have sinned */ \
3109 PL_statusvalue_vms = evalue; \
3110 } else { \
3111 if (evalue == 0) \
3112 PL_statusvalue_vms = SS$_NORMAL; \
3113 else if (evalue <= 0xFF00) \
3114 PL_statusvalue_vms = SS$_ABORT; \
3115 else { /* forgive them Perl, for they have sinned */ \
3116 if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3117 else PL_statusvalue_vms = vaxc$errno; \
3118 /* And obviously used a VMS status value instead of UNIX */ \
3119 PL_statusvalue = EVMSERR; \
3120 } \
3121 set_vaxc_errno(PL_statusvalue_vms); \
3122 } \
68dc0745 3123 } STMT_END
fb38d079 3124
e08e1e1d 3125
6ac6a52b
JM		 3126 /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3127 * and sets the NATIVE error status based on it. This special case
3128 * is needed to maintain compatibility with past VMS behavior.
3129 *
3130 * In the default mode on VMS, this number is passed through as
3131 * both the NATIVE and UNIX status. Which makes it different
3132 * that the STATUS_UNIX_EXIT_SET.
3133 *
3134 * In the new POSIX EXIT mode, native status will be set so that the
3135 * actual exit code will can be retrieved by the calling program or
3136 * shell.
3137 *
1a3aec58
JM		 3138 * A POSIX exit code is from 0 to 255. If the exit code is higher
3139 * than this, it needs to be assumed that it is a VMS exit code and
3140 * passed through.
6ac6a52b
JM		 3141 */
3142
3143# define STATUS_EXIT_SET(n) \
3144 STMT_START { \
3145 I32 evalue = (I32)n; \
3146 PL_statusvalue = evalue; \
3147 if (MY_POSIX_EXIT) \
1a3aec58
JM		 3148 if (evalue > 255) PL_statusvalue_vms = evalue; else { \
3149 PL_statusvalue_vms = \
3150 (C_FAC_POSIX | (evalue << 3 ) | \
3151 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
6ac6a52b
JM		 3152 else \
3153 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3154 set_vaxc_errno(PL_statusvalue_vms); \
3155 } STMT_END
3156
fb38d079
JM		 3157
3158 /* This macro forces a success status */
7a7fd8e0
JM		 3159# define STATUS_ALL_SUCCESS \
3160 (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
fb38d079
JM		 3161
3162 /* This macro forces a failure status */
7a7fd8e0
JM		 3163# define STATUS_ALL_FAILURE (PL_statusvalue = 1, \
3164 vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3165 (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
fb38d079 3166
738ab09f
AB		 3167#elif defined(__amigaos4__)
3168 /* A somewhat experimental attempt to simulate posix return code values */
3169# define STATUS_NATIVE PL_statusvalue_posix
3170# define STATUS_NATIVE_CHILD_SET(n) \
3171 STMT_START { \
3172 PL_statusvalue_posix = (n); \
3173 if (PL_statusvalue_posix < 0) { \
3174 PL_statusvalue = -1; \
3175 } \
3176 else { \
3177 PL_statusvalue = n << 8; \
3178 } \
3179 } STMT_END
3180# define STATUS_UNIX_SET(n) \
3181 STMT_START { \
3182 PL_statusvalue = (n); \
3183 if (PL_statusvalue != -1) \
3184 PL_statusvalue &= 0xFFFF; \
3185 } STMT_END
3186# define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3187# define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3188# define STATUS_CURRENT STATUS_UNIX
3189# define STATUS_EXIT STATUS_UNIX
3190# define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3191# define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3192
68dc0745 3193#else
e5218da5 3194# define STATUS_NATIVE PL_statusvalue_posix
e5218da5 3195# if defined(WCOREDUMP)
37038d91 3196# define STATUS_NATIVE_CHILD_SET(n) \
e5218da5
GA		 3197 STMT_START { \
3198 PL_statusvalue_posix = (n); \
3199 if (PL_statusvalue_posix == -1) \
3200 PL_statusvalue = -1; \
3201 else { \
3202 PL_statusvalue = \
3203 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
3204 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3205 (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0); \
3206 } \
3207 } STMT_END
3208# elif defined(WIFEXITED)
37038d91 3209# define STATUS_NATIVE_CHILD_SET(n) \
e5218da5
GA		 3210 STMT_START { \
3211 PL_statusvalue_posix = (n); \
3212 if (PL_statusvalue_posix == -1) \
3213 PL_statusvalue = -1; \
3214 else { \
3215 PL_statusvalue = \
3216 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
3217 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0); \
3218 } \
3219 } STMT_END
3220# else
37038d91 3221# define STATUS_NATIVE_CHILD_SET(n) \
e5218da5
GA		 3222 STMT_START { \
3223 PL_statusvalue_posix = (n); \
3224 if (PL_statusvalue_posix == -1) \
3225 PL_statusvalue = -1; \
3226 else { \
3227 PL_statusvalue = \
3228 PL_statusvalue_posix & 0xFFFF; \
3229 } \
3230 } STMT_END
3231# endif
3232# define STATUS_UNIX_SET(n) \
68dc0745 3233 STMT_START { \
3280af22
NIS		 3234 PL_statusvalue = (n); \
3235 if (PL_statusvalue != -1) \
3236 PL_statusvalue &= 0xFFFF; \
68dc0745 3237 } STMT_END
7a7fd8e0 3238# define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
6ac6a52b 3239# define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
e5218da5 3240# define STATUS_CURRENT STATUS_UNIX
37038d91 3241# define STATUS_EXIT STATUS_UNIX
e5218da5
GA		 3242# define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3243# define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
68dc0745
PP		 3244#endif
3245
cc3604b1
GS		 3246/* flags in PL_exit_flags for nature of exit() */
3247#define PERL_EXIT_EXPECTED 0x01
31d77e54 3248#define PERL_EXIT_DESTRUCT_END 0x02 /* Run END in perl_destruct */
6136213b
JGM		 3249#define PERL_EXIT_WARN 0x04 /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3250#define PERL_EXIT_ABORT 0x08 /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
cc3604b1 3251
b79b76e0 3252#ifndef PERL_CORE
a7cb1f99 3253/* format to use for version numbers in file/directory names */
273cf8d1 3254/* XXX move to Configure? */
b79b76e0
NC		 3255/* This was only ever used for the current version, and that can be done at
3256 compile time, as PERL_FS_VERSION, so should we just delete it? */
3257# ifndef PERL_FS_VER_FMT
3258# define PERL_FS_VER_FMT "%d.%d.%d"
3259# endif
3260#endif
3261
3262#ifndef PERL_FS_VERSION
3263# define PERL_FS_VERSION PERL_VERSION_STRING
0b94c7bb
GS		 3264#endif
3265
45bc9206 3266/* This defines a way to flush all output buffers. This may be a
76549fef
JH		 3267 * performance issue, so we allow people to disable it. Also, if
3268 * we are using stdio, there are broken implementations of fflush(NULL)
3269 * out there, Solaris being the most prominent.
45bc9206
GS		 3270 */
3271#ifndef PERL_FLUSHALL_FOR_CHILD
97cb92d6 3272# if defined(USE_PERLIO) || defined(FFLUSH_NULL)
66fe083f 3273# define PERL_FLUSHALL_FOR_CHILD PerlIO_flush((PerlIO*)NULL)
da5fdda8
AC		 3274# elif defined(FFLUSH_ALL)
3275# define PERL_FLUSHALL_FOR_CHILD my_fflush_all()
767df6a1 3276# else
da5fdda8 3277# define PERL_FLUSHALL_FOR_CHILD NOOP
66fe083f 3278# endif
45bc9206
GS		 3279#endif
3280
7766f137
GS		 3281#ifndef PERL_WAIT_FOR_CHILDREN
3282# define PERL_WAIT_FOR_CHILDREN NOOP
3283#endif
3284
ba869deb 3285/* the traditional thread-unsafe notion of "current interpreter". */
c5be433b
GS		 3286#ifndef PERL_SET_INTERP
3287# define PERL_SET_INTERP(i) (PL_curinterp = (PerlInterpreter*)(i))
3288#endif
3289
3290#ifndef PERL_GET_INTERP
3291# define PERL_GET_INTERP (PL_curinterp)
3292#endif
3293
54aff467 3294#if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
54aff467 3295# ifdef MULTIPLICITY
ba869deb 3296# define PERL_GET_THX ((PerlInterpreter *)PERL_GET_CONTEXT)
54aff467 3297# endif
ba869deb
GS		 3298# define PERL_SET_THX(t) PERL_SET_CONTEXT(t)
3299#endif
3300
00f254e2 3301/*
8896765a 3302 This replaces the previous %_ "hack" by the "%p" hacks.
0dbb1585 3303 All that is required is that the perl source does not
00f254e2
KW		 3304 use "%-p" or "%-<number>p" or "%<number>p" formats.
3305 These formats will still work in perl code.
486ec47a 3306 See comments in sv.c for further details.
8896765a 3307
8896765a 3308 Robin Barker 2005-07-14
f46d31f2 3309
00f254e2 3310 No longer use %1p for VDf = %vd. RMB 2007-10-19
0dbb1585 3311*/
8896765a
RB		 3312
3313#ifndef SVf_
63ce7bf0 3314# define SVf_(n) "-" STRINGIFY(n) "p"
894356b3
GS		 3315#endif
3316
8896765a 3317#ifndef SVf
104abab4 3318# define SVf "-p"
d2560b70
RB		 3319#endif
3320
014ead4b 3321#ifndef SVf32
8896765a 3322# define SVf32 SVf_(32)
014ead4b
RB		 3323#endif
3324
3325#ifndef SVf256
8896765a
RB		 3326# define SVf256 SVf_(256)
3327#endif
3328
be2597df
MHM		 3329#define SVfARG(p) ((void*)(p))
3330
20023040
FC		 3331#ifndef HEKf
3332# define HEKf "2p"
3333#endif
3334
b8fa5213
FC		 3335/* Not ideal, but we cannot easily include a number in an already-numeric
3336 * format sequence. */
3337#ifndef HEKf256
3338# define HEKf256 "3p"
3339#endif
3340
20023040
FC		 3341#define HEKfARG(p) ((void*)(p))
3342
b17a0679
FC		 3343/* Takes three arguments: is_utf8, length, str */
3344#ifndef UTF8f
61608bb7 3345# define UTF8f "d%" UVuf "%4p"
b17a0679
FC		 3346#endif
3347#define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3348
0f94cb1f
FC		 3349#define PNf UTF8f
3350#define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
0d1e9135 3351
f46d31f2 3352#ifdef PERL_CORE
486ec47a 3353/* not used; but needed for backward compatibility with XS code? - RMB */
7776bb98 3354# undef UVf
da5fdda8
AC		 3355#elif !defined(UVf)
3356# define UVf UVuf
d2560b70
RB		 3357#endif
3358
fcdf39cf
RGS		 3359#ifdef HASATTRIBUTE_DEPRECATED
3360# define __attribute__deprecated__ __attribute__((deprecated))
3361#endif
0dbb1585
AL		 3362#ifdef HASATTRIBUTE_FORMAT
3363# define __attribute__format__(x,y,z) __attribute__((format(x,y,z)))
3364#endif
3365#ifdef HASATTRIBUTE_MALLOC
77785eea 3366# define __attribute__malloc__ __attribute__((__malloc__))
f22be1b8 3367#endif
0dbb1585 3368#ifdef HASATTRIBUTE_NONNULL
abb2c242 3369# define __attribute__nonnull__(a) __attribute__((nonnull(a)))
f22be1b8 3370#endif
0dbb1585 3371#ifdef HASATTRIBUTE_NORETURN
abb2c242 3372# define __attribute__noreturn__ __attribute__((noreturn))
f22be1b8 3373#endif
0dbb1585 3374#ifdef HASATTRIBUTE_PURE
abb2c242 3375# define __attribute__pure__ __attribute__((pure))
f22be1b8 3376#endif
0dbb1585
AL		 3377#ifdef HASATTRIBUTE_UNUSED
3378# define __attribute__unused__ __attribute__((unused))
3379#endif
3380#ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
abb2c242 3381# define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
f22be1b8
JH		 3382#endif
3383
0dbb1585 3384/* If we haven't defined the attributes yet, define them to blank. */
fcdf39cf
RGS		 3385#ifndef __attribute__deprecated__
3386# define __attribute__deprecated__
3387#endif
0dbb1585
AL		 3388#ifndef __attribute__format__
3389# define __attribute__format__(x,y,z)
3390#endif
f22be1b8 3391#ifndef __attribute__malloc__
abb2c242 3392# define __attribute__malloc__
f22be1b8
JH		 3393#endif
3394#ifndef __attribute__nonnull__
abb2c242 3395# define __attribute__nonnull__(a)
f22be1b8
JH		 3396#endif
3397#ifndef __attribute__noreturn__
abb2c242 3398# define __attribute__noreturn__
f22be1b8
JH		 3399#endif
3400#ifndef __attribute__pure__
abb2c242 3401# define __attribute__pure__
f22be1b8 3402#endif
0dbb1585
AL		 3403#ifndef __attribute__unused__
3404# define __attribute__unused__
3405#endif
f22be1b8 3406#ifndef __attribute__warn_unused_result__
abb2c242
JH		 3407# define __attribute__warn_unused_result__
3408#endif
3409
6ff2ec7d
AC		 3410#if !defined(DEBUGGING) && !defined(NDEBUG)
3411# define NDEBUG 1
cd13e623 3412#endif
6ff2ec7d 3413#include <assert.h>
cd13e623 3414
0dbb1585
AL		 3415/* For functions that are marked as __attribute__noreturn__, it's not
3416 appropriate to call return. In either case, include the lint directive.
3417 */
3418#ifdef HASATTRIBUTE_NORETURN
bc3d2941 3419# define NORETURN_FUNCTION_END NOT_REACHED;
0dbb1585 3420#else
bc3d2941 3421# define NORETURN_FUNCTION_END NOT_REACHED; return 0
abb2c242
JH		 3422#endif
3423
cdfeb707
RB		 3424/* Some OS warn on NULL format to printf */
3425#ifdef PRINTF_FORMAT_NULL_OK
3426# define __attribute__format__null_ok__(x,y,z) __attribute__format__(x,y,z)
3427#else
00f254e2 3428# define __attribute__format__null_ok__(x,y,z)
cdfeb707
RB		 3429#endif
3430
635aebb7 3431#ifdef HAS_BUILTIN_EXPECT
b37c2d43
AL		 3432# define EXPECT(expr,val) __builtin_expect(expr,val)
3433#else
3434# define EXPECT(expr,val) (expr)
3435#endif
6d5abc62
NC		 3436#define LIKELY(cond) EXPECT(cBOOL(cond),TRUE)
3437#define UNLIKELY(cond) EXPECT(cBOOL(cond),FALSE)
635aebb7
AL		 3438#ifdef HAS_BUILTIN_CHOOSE_EXPR
3439/* placeholder */
3440#endif
b37c2d43 3441
a36ca6de 3442/* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
5074d4c5
LM		 3443 time invariants. That is, their argument must be a constant expression that
3444 can be verified by the compiler. This expression can contain anything that's
3445 known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3446 the expression evaluates to 0, compilation fails.
3447 Because they generate no runtime code (i.e. their use is "free"), they're
3448 always active, even under non-DEBUGGING builds.
a36ca6de 3449 STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
5074d4c5
LM		 3450 file scope (outside of any function).
3451 STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3452 function.
3453*/
7ea096df 3454#if (defined(static_assert) || (defined(__cplusplus) && __cplusplus >= 201103L)) && (!defined(__IBMC__) || __IBMC__ >= 1210)
6d59e610 3455/* static_assert is a macro defined in <assert.h> in C11 or a compiler
a36ca6de
LM		 3456 builtin in C++11. But IBM XL C V11 does not support _Static_assert, no
3457 matter what <assert.h> says.
6d59e610 3458*/
a36ca6de 3459# define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
6d59e610
LM		 3460#else
3461/* We use a bit-field instead of an array because gcc accepts
3462 'typedef char x[n]' where n is not a compile-time constant.
3463 We want to enforce constantness.
3464*/
3465# define STATIC_ASSERT_2(COND, SUFFIX) \
3466 typedef struct { \
3467 unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3468 } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3469# define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
a36ca6de 3470# define STATIC_ASSERT_DECL(COND) STATIC_ASSERT_1(COND, __LINE__)
6d59e610
LM		 3471#endif
3472/* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3473 error (static_assert is a declaration, and only statements can have labels).
3474*/
21aae866 3475#define STATIC_ASSERT_STMT(COND) STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
ae103e09
DD		 3476
3477#ifndef __has_builtin
3478# define __has_builtin(x) 0 /* not a clang style compiler */
3479#endif
3480
3481/* ASSUME is like assert(), but it has a benefit in a release build. It is a
3482 hint to a compiler about a statement of fact in a function call free
3483 expression, which allows the compiler to generate better machine code.
3484 In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3485 the control path is unreachable. In a for loop, ASSUME can be used to hint
b8fda935 3486 that a loop will run at least X times. ASSUME is based off MSVC's __assume
ae103e09
DD		 3487 intrinsic function, see its documents for more details.
3488*/
3489
3490#ifndef DEBUGGING
3491# if __has_builtin(__builtin_unreachable) \
d1020b40 3492 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4) /* 4.5 -> */
ae103e09
DD		 3493# define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3494# elif defined(_MSC_VER)
3495# define ASSUME(x) __assume(x)
3496# elif defined(__ARMCC_VERSION) /* untested */
3497# define ASSUME(x) __promise(x)
3498# else
3499/* a random compiler might define assert to its own special optimization token
3500 so pass it through to C lib as a last resort */
3501# define ASSUME(x) assert(x)
3502# endif
3503#else
3504# define ASSUME(x) assert(x)
3505#endif
3506
dbc47c6f
KW		 3507#if defined(__sun) /* ASSUME() generates warnings on Solaris */
3508# define NOT_REACHED
2145f4b6
LM		 3509#elif defined(DEBUGGING) && (__has_builtin(__builtin_unreachable) \
3510 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4)) /* 4.5 -> */
3511# define NOT_REACHED STMT_START { ASSUME(0); __builtin_unreachable(); } STMT_END
dbc47c6f
KW		 3512#else
3513# define NOT_REACHED ASSUME(0)
3514#endif
ae103e09 3515
3fc1aec6
PP		 3516/* Some unistd.h's give a prototype for pause() even though
3517 HAS_PAUSE ends up undefined. This causes the #define
d2560b70 3518 below to be rejected by the compiler. Sigh.
3fc1aec6
PP		 3519*/
3520#ifdef HAS_PAUSE
3521#define Pause pause
3522#else
3523#define Pause() sleep((32767<<16)+32767)
748a9306
LW		 3524#endif
3525
3526#ifndef IOCPARM_LEN
3527# ifdef IOCPARM_MASK
61f1c44b 3528 /* on BSDish systems we're safe */
748a9306 3529# define IOCPARM_LEN(x) (((x) >> 16) & IOCPARM_MASK)
da5fdda8 3530# elif defined(_IOC_SIZE) && defined(__GLIBC__)
301eb2f0 3531 /* on Linux systems we're safe; except when we're not [perl #38223] */
da5fdda8
AC		 3532# define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3533# else
748a9306 3534 /* otherwise guess at what's safe */
da5fdda8 3535# define IOCPARM_LEN(x) 256
748a9306 3536# endif
a0d0e21e
LW		 3537#endif
3538
1761cee5 3539#if defined(__CYGWIN__)
521e0776
GS		 3540/* USEMYBINMODE
3541 * This symbol, if defined, indicates that the program should
16fe6d59 3542 * use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
521e0776
GS		 3543 * that a file is in "binary" mode -- that is, that no translation
3544 * of bytes occurs on read or write operations.
3545 */
36894f0b 3546# define USEMYBINMODE /**/
77a40698 3547# include <io.h> /* for setmode() prototype */
16fe6d59 3548# define my_binmode(fp, iotype, mode) \
8298454c 3549 cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
5aabfad6
PP		 3550#endif
3551
88d10794
JH		 3552#ifdef __CYGWIN__
3553void init_os_extras(void);
3554#endif
3555
cea2e8a9
GS		 3556#ifdef UNION_ANY_DEFINITION
3557UNION_ANY_DEFINITION;
3558#else
3559union any {
3560 void* any_ptr;
c9728782
DM		 3561 SV* any_sv;
3562 SV** any_svp;
3563 GV* any_gv;
3564 AV* any_av;
3565 HV* any_hv;
6ffb8402 3566 OP* any_op;
c9728782
DM		 3567 char* any_pv;
3568 char** any_pvp;
cea2e8a9 3569 I32 any_i32;
ae103e09 3570 U32 any_u32;
cea2e8a9 3571 IV any_iv;
c6bf6a65 3572 UV any_uv;
cea2e8a9 3573 long any_long;
9febdf04 3574 bool any_bool;
c76ac1ee 3575 void (*any_dptr) (void*);
acfe0abc 3576 void (*any_dxptr) (pTHX_ void*);
cea2e8a9
GS		 3577};
3578#endif
3579
acfe0abc 3580typedef I32 (*filter_t) (pTHX_ int, SV *, int);
cea2e8a9
GS		 3581
3582#define FILTER_READ(idx, sv, len) filter_read(idx, sv, len)
5486870f
DM		 3583#define FILTER_DATA(idx) \
3584 (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3585#define FILTER_ISREADER(idx) \
3586 (PL_parser && PL_parser->rsfp_filters \
3587 && idx >= AvFILLp(PL_parser->rsfp_filters))
3588#define PERL_FILTER_EXISTS(i) \
3589 (PL_parser && PL_parser->rsfp_filters \
b9f2b683 3590 && (i) <= av_tindex(PL_parser->rsfp_filters))
cea2e8a9 3591
c5078cac
JH		 3592#if defined(_AIX) && !defined(_AIX43)
3593#if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3594/* We cannot include <crypt.h> to get the struct crypt_data
3595 * because of setkey prototype problems when threading */
3596typedef struct crypt_data { /* straight from /usr/include/crypt.h */
3597 /* From OSF, Not needed in AIX
3598 char C[28], D[28];
3599 */
3600 char E[48];
3601 char KS[16][48];
3602 char block[66];
3603 char iobuf[16];
3604} CRYPTD;
3605#endif /* threading */
3606#endif /* AIX */
3607
fc6bde6f
DD		 3608#ifndef PERL_CALLCONV
3609# ifdef __cplusplus
3610# define PERL_CALLCONV extern "C"
3611# else
3612# define PERL_CALLCONV
3613# endif
3614#endif
3615#ifndef PERL_CALLCONV_NO_RET
3616# define PERL_CALLCONV_NO_RET PERL_CALLCONV
3617#endif
3618
3619/* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
3620 dont have a noreturn as a declaration specifier
3621*/
3622#ifndef PERL_STATIC_NO_RET
3623# define PERL_STATIC_NO_RET STATIC
3624#endif
3625/* PERL_STATIC_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE on
3626 builds that dont have a noreturn as a declaration specifier
3627*/
3628#ifndef PERL_STATIC_INLINE_NO_RET
3629# define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
3630#endif
3631
e37778c2 3632#if !defined(OS2)
2c2d71f5
JH		 3633# include "iperlsys.h"
3634#endif
504f80c1 3635
9c12f1e5 3636#ifdef __LIBCATAMOUNT__
00f254e2 3637#undef HAS_PASSWD /* unixish.h but not unixish enough. */
9c12f1e5
RGS		 3638#undef HAS_GROUP
3639#define FAKE_BIT_BUCKET
3640#endif
3641
d10dc2ae 3642/* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
1a237f4f
YO		 3643 * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
3644 * Configure, despite their names being similar to other defines like
3645 * USE_ITHREADS. Configure in fact knows nothing about the randomised
3646 * hashes. Therefore to enable/disable the hash randomisation defines
3647 * use the Configure -Accflags=... instead. */
3648#if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
4546b9e6 3649# define USE_HASH_SEED
504f80c1
JH		 3650#endif
3651
598921a7
NC		 3652#include "perly.h"
3653
598921a7 3654
654eccd5
JD		 3655/* macros to define bit-fields in structs. */
3656#ifndef PERL_BITFIELD8
3657# define PERL_BITFIELD8 unsigned
3658#endif
3659#ifndef PERL_BITFIELD16
3660# define PERL_BITFIELD16 unsigned
3661#endif
3662#ifndef PERL_BITFIELD32
3663# define PERL_BITFIELD32 unsigned
3664#endif
3665
79072805 3666#include "sv.h"
288b8c02 3667#include "regexp.h"
378cc40b 3668#include "util.h"
8d063cd8 3669#include "form.h"
79072805 3670#include "gv.h"
dd2155a4 3671#include "pad.h"
79072805 3672#include "cv.h"
abdd5c84 3673#include "opnames.h"
79072805 3674#include "op.h"
b3ca2e83 3675#include "hv.h"
79072805
LW		 3676#include "cop.h"
3677#include "av.h"
79072805
LW		 3678#include "mg.h"
3679#include "scope.h"
4438c4b7 3680#include "warnings.h"
a0ed51b3 3681#include "utf8.h"
8d063cd8 3682
0d7d409d
DM		 3683/* these would be in doio.h if there was such a file */
3684#define my_stat() my_stat_flags(SV_GMAGIC)
3685#define my_lstat() my_lstat_flags(SV_GMAGIC)
3686
20f4945e 3687/* defined in sv.c, but also used in [ach]v.c */
20f4945e
MHM		 3688#undef _XPV_HEAD
3689#undef _XPVMG_HEAD
3690#undef _XPVCV_COMMON
7fae4e64 3691
199e78b7
DM		 3692#include "parser.h"
3693
455ece5e 3694typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
76e3520e 3695
2260ab51
KW		 3696#if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3697
3698/* These have to be predeclared, as they are used in proto.h which is #included
3699 * before their definitions in regcomp.h. */
3700
3701struct scan_data_t;
7dcac5f6
KW		 3702typedef struct regnode_charclass regnode_charclass;
3703
d1d040e5
KW		 3704/* A hopefully less confusing name. The sub-classes are all Posix classes only
3705 * used under /l matching */
ea461dd6
KW		 3706typedef struct regnode_charclass_posixl regnode_charclass_class;