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