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