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