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