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