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