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