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