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