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