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