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