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