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