This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
358da90098f453db1215deb2cd1d0958cacaa791
[perl5.git] / perl.h
1 /*    perl.h
2  *
3  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
4  *    2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
5  *
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.
8  *
9  */
10
11 #ifndef H_PERL
12 #define H_PERL 1
13
14 #ifdef PERL_FOR_X2P
15 /*
16  * This file is being used for x2p stuff.
17  * Above symbol is defined via -D in 'x2p/Makefile.SH'
18  * Decouple x2p stuff from some of perls more extreme eccentricities.
19  */
20 #undef MULTIPLICITY
21 #undef USE_STDIO
22 #define USE_STDIO
23 #endif /* PERL_FOR_X2P */
24
25 #ifdef PERL_MICRO
26 #   include "uconfig.h"
27 #else
28 #   include "config.h"
29 #endif
30
31 /* this is used for functions which take a depth trailing
32  * argument under debugging */
33 #ifdef DEBUGGING
34 #define _pDEPTH ,U32 depth
35 #define _aDEPTH ,depth
36 #else
37 #define _pDEPTH
38 #define _aDEPTH
39 #endif
40
41 /* NOTE 1: that with gcc -std=c89 the __STDC_VERSION__ is *not* defined
42  * because the __STDC_VERSION__ became a thing only with C90.  Therefore,
43  * with gcc, HAS_C99 will never become true as long as we use -std=c89.
44
45  * NOTE 2: headers lie.  Do not expect that if HAS_C99 gets to be true,
46  * all the C99 features are there and are correct. */
47 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || \
48     defined(_STDC_C99) || defined(__c99)
49 #  define HAS_C99 1
50 #endif
51
52 /* See L<perlguts/"The Perl API"> for detailed notes on
53  * PERL_IMPLICIT_CONTEXT and PERL_IMPLICIT_SYS */
54
55 /* Note that from here --> to <-- the same logic is
56  * repeated in makedef.pl, so be certain to update
57  * both places when editing. */
58
59 #ifdef USE_ITHREADS
60 #  if !defined(MULTIPLICITY)
61 #    define MULTIPLICITY
62 #  endif
63 #endif
64
65 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
66 #  ifndef PERL_GLOBAL_STRUCT
67 #    define PERL_GLOBAL_STRUCT
68 #  endif
69 #endif
70
71 #ifdef PERL_GLOBAL_STRUCT
72 #  ifndef MULTIPLICITY
73 #    define MULTIPLICITY
74 #  endif
75 #endif
76
77 #ifdef MULTIPLICITY
78 #  ifndef PERL_IMPLICIT_CONTEXT
79 #    define PERL_IMPLICIT_CONTEXT
80 #  endif
81 #endif
82
83 /* undef WIN32 when building on Cygwin (for libwin32) - gph */
84 #ifdef __CYGWIN__
85 #   undef WIN32
86 #   undef _WIN32
87 #endif
88
89 #if defined(__SYMBIAN32__) || (defined(__VC32__) && defined(WINS))
90 #   ifndef SYMBIAN
91 #       define SYMBIAN
92 #   endif
93 #endif
94
95 #ifdef __SYMBIAN32__
96 #  include "symbian/symbian_proto.h"
97 #endif
98
99 /* Any stack-challenged places.  The limit varies (and often
100  * is configurable), but using more than a kilobyte of stack
101  * is usually dubious in these systems. */
102 #if defined(__SYMBIAN32__)
103 /* Symbian: need to work around the SDK features. *
104  * On WINS: MS VC5 generates calls to _chkstk,         *
105  * if a "large" stack frame is allocated.              *
106  * gcc on MARM does not generate calls like these.     */
107 #   define USE_HEAP_INSTEAD_OF_STACK
108 #endif
109
110 /* Use the reentrant APIs like localtime_r and getpwent_r */
111 /* Win32 has naturally threadsafe libraries, no need to use any _r variants. */
112 #if defined(USE_ITHREADS) && !defined(USE_REENTRANT_API) && !defined(NETWARE) && !defined(WIN32)
113 #   define USE_REENTRANT_API
114 #endif
115
116 /* <--- here ends the logic shared by perl.h and makedef.pl */
117
118 /* Microsoft Visual C++ 6.0 needs special treatment in numerous places */
119 #if defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1200 && _MSC_VER < 1300
120 #  define USING_MSVC6
121 #endif
122
123 #undef START_EXTERN_C
124 #undef END_EXTERN_C
125 #undef EXTERN_C
126 #ifdef __cplusplus
127 #  define START_EXTERN_C extern "C" {
128 #  define END_EXTERN_C }
129 #  define EXTERN_C extern "C"
130 #else
131 #  define START_EXTERN_C
132 #  define END_EXTERN_C
133 #  define EXTERN_C extern
134 #endif
135
136 /* Fallback definitions in case we don't have definitions from config.h.
137    This should only matter for systems that don't use Configure and
138    haven't been modified to define PERL_STATIC_INLINE yet.
139 */
140 #if !defined(PERL_STATIC_INLINE)
141 #  ifdef HAS_STATIC_INLINE
142 #    define PERL_STATIC_INLINE static inline
143 #  else
144 #    define PERL_STATIC_INLINE static
145 #  endif
146 #endif
147
148 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GET_VARS)
149 #    ifdef PERL_GLOBAL_STRUCT_PRIVATE
150        EXTERN_C struct perl_vars* Perl_GetVarsPrivate();
151 #      define PERL_GET_VARS() Perl_GetVarsPrivate() /* see miniperlmain.c */
152 #    else
153 #      define PERL_GET_VARS() PL_VarsPtr
154 #    endif
155 #endif
156
157 /* this used to be off by default, now its on, see perlio.h */
158 #define PERLIO_FUNCS_CONST
159
160 #define pVAR    struct perl_vars* my_vars PERL_UNUSED_DECL
161
162 #ifdef PERL_GLOBAL_STRUCT
163 #  define dVAR          pVAR    = (struct perl_vars*)PERL_GET_VARS()
164 #else
165 #  define dVAR          dNOOP
166 #endif
167
168 #ifdef PERL_IMPLICIT_CONTEXT
169 #  ifndef MULTIPLICITY
170 #    define MULTIPLICITY
171 #  endif
172 #  define tTHX  PerlInterpreter*
173 #  define pTHX  tTHX my_perl PERL_UNUSED_DECL
174 #  define aTHX  my_perl
175 #  define aTHXa(a) aTHX = (tTHX)a
176 #  ifdef PERL_GLOBAL_STRUCT
177 #    define dTHXa(a)    dVAR; pTHX = (tTHX)a
178 #  else
179 #    define dTHXa(a)    pTHX = (tTHX)a
180 #  endif
181 #  ifdef PERL_GLOBAL_STRUCT
182 #    define dTHX                dVAR; pTHX = PERL_GET_THX
183 #  else
184 #    define dTHX                pTHX = PERL_GET_THX
185 #  endif
186 #  define pTHX_         pTHX,
187 #  define aTHX_         aTHX,
188 #  define pTHX_1        2
189 #  define pTHX_2        3
190 #  define pTHX_3        4
191 #  define pTHX_4        5
192 #  define pTHX_5        6
193 #  define pTHX_6        7
194 #  define pTHX_7        8
195 #  define pTHX_8        9
196 #  define pTHX_9        10
197 #  define pTHX_12       13
198 #  if defined(DEBUGGING) && !defined(PERL_TRACK_MEMPOOL)
199 #    define PERL_TRACK_MEMPOOL
200 #  endif
201 #else
202 #  undef PERL_TRACK_MEMPOOL
203 #endif
204
205 #define STATIC static
206
207 #ifndef PERL_CORE
208 /* Do not use these macros. They were part of PERL_OBJECT, which was an
209  * implementation of multiplicity using C++ objects. They have been left
210  * here solely for the sake of XS code which has incorrectly
211  * cargo-culted them.
212  */
213 #define CPERLscope(x) x
214 #define CPERLarg void
215 #define CPERLarg_
216 #define _CPERLarg
217 #define PERL_OBJECT_THIS
218 #define _PERL_OBJECT_THIS
219 #define PERL_OBJECT_THIS_
220 #define CALL_FPTR(fptr) (*fptr)
221 #define MEMBER_TO_FPTR(name) name
222 #endif /* !PERL_CORE */
223
224 #define CALLRUNOPS  PL_runops
225
226 #define CALLREGCOMP(sv, flags) Perl_pregcomp(aTHX_ (sv),(flags))
227
228 #define CALLREGCOMP_ENG(prog, sv, flags) (prog)->comp(aTHX_ sv, flags)
229 #define CALLREGEXEC(prog,stringarg,strend,strbeg,minend,sv,data,flags) \
230     RX_ENGINE(prog)->exec(aTHX_ (prog),(stringarg),(strend), \
231         (strbeg),(minend),(sv),(data),(flags))
232 #define CALLREG_INTUIT_START(prog,sv,strbeg,strpos,strend,flags,data) \
233     RX_ENGINE(prog)->intuit(aTHX_ (prog), (sv), (strbeg), (strpos), \
234         (strend),(flags),(data))
235 #define CALLREG_INTUIT_STRING(prog) \
236     RX_ENGINE(prog)->checkstr(aTHX_ (prog))
237
238 #define CALLREGFREE(prog) \
239     Perl_pregfree(aTHX_ (prog))
240
241 #define CALLREGFREE_PVT(prog) \
242     if(prog) RX_ENGINE(prog)->rxfree(aTHX_ (prog))
243
244 #define CALLREG_NUMBUF_FETCH(rx,paren,usesv)                                \
245     RX_ENGINE(rx)->numbered_buff_FETCH(aTHX_ (rx),(paren),(usesv))
246
247 #define CALLREG_NUMBUF_STORE(rx,paren,value) \
248     RX_ENGINE(rx)->numbered_buff_STORE(aTHX_ (rx),(paren),(value))
249
250 #define CALLREG_NUMBUF_LENGTH(rx,sv,paren)                              \
251     RX_ENGINE(rx)->numbered_buff_LENGTH(aTHX_ (rx),(sv),(paren))
252
253 #define CALLREG_NAMED_BUFF_FETCH(rx, key, flags) \
254     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_FETCH))
255
256 #define CALLREG_NAMED_BUFF_STORE(rx, key, value, flags) \
257     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), (value), ((flags) | RXapif_STORE))
258
259 #define CALLREG_NAMED_BUFF_DELETE(rx, key, flags) \
260     RX_ENGINE(rx)->named_buff(aTHX_ (rx),(key), NULL, ((flags) | RXapif_DELETE))
261
262 #define CALLREG_NAMED_BUFF_CLEAR(rx, flags) \
263     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_CLEAR))
264
265 #define CALLREG_NAMED_BUFF_EXISTS(rx, key, flags) \
266     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_EXISTS))
267
268 #define CALLREG_NAMED_BUFF_FIRSTKEY(rx, flags) \
269     RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), NULL, ((flags) | RXapif_FIRSTKEY))
270
271 #define CALLREG_NAMED_BUFF_NEXTKEY(rx, lastkey, flags) \
272     RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), (lastkey), ((flags) | RXapif_NEXTKEY))
273
274 #define CALLREG_NAMED_BUFF_SCALAR(rx, flags) \
275     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_SCALAR))
276
277 #define CALLREG_NAMED_BUFF_COUNT(rx) \
278     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, RXapif_REGNAMES_COUNT)
279
280 #define CALLREG_NAMED_BUFF_ALL(rx, flags) \
281     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, flags)
282
283 #define CALLREG_PACKAGE(rx) \
284     RX_ENGINE(rx)->qr_package(aTHX_ (rx))
285
286 #if defined(USE_ITHREADS)
287 #define CALLREGDUPE(prog,param) \
288     Perl_re_dup(aTHX_ (prog),(param))
289
290 #define CALLREGDUPE_PVT(prog,param) \
291     (prog ? RX_ENGINE(prog)->dupe(aTHX_ (prog),(param)) \
292           : (REGEXP *)NULL)
293 #endif
294
295
296
297
298
299 /*
300  * Because of backward compatibility reasons the PERL_UNUSED_DECL
301  * cannot be changed from postfix to PERL_UNUSED_DECL(x).  Sigh.
302  *
303  * Note that there are C compilers such as MetroWerks CodeWarrior
304  * which do not have an "inlined" way (like the gcc __attribute__) of
305  * marking unused variables (they need e.g. a #pragma) and therefore
306  * cpp macros like PERL_UNUSED_DECL cannot work for this purpose, even
307  * if it were PERL_UNUSED_DECL(x), which it cannot be (see above).
308  *
309  */
310
311 #if defined(__SYMBIAN32__) && defined(__GNUC__)
312 #  ifdef __cplusplus
313 #    define PERL_UNUSED_DECL
314 #  else
315 #    define PERL_UNUSED_DECL __attribute__((unused))
316 #  endif
317 #endif
318
319 #ifndef PERL_UNUSED_DECL
320 #  if defined(HASATTRIBUTE_UNUSED) && (!defined(__cplusplus) || (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)))
321 #    define PERL_UNUSED_DECL __attribute__unused__
322 #  else
323 #    define PERL_UNUSED_DECL
324 #  endif
325 #endif
326
327 /* gcc -Wall:
328  * for silencing unused variables that are actually used most of the time,
329  * but we cannot quite get rid of, such as "ax" in PPCODE+noargs xsubs,
330  * or variables/arguments that are used only in certain configurations.
331  */
332 #ifndef PERL_UNUSED_ARG
333 #  define PERL_UNUSED_ARG(x) ((void)sizeof(x))
334 #endif
335 #ifndef PERL_UNUSED_VAR
336 #  define PERL_UNUSED_VAR(x) ((void)sizeof(x))
337 #endif
338
339 #if defined(USE_ITHREADS) || defined(PERL_GLOBAL_STRUCT)
340 #  define PERL_UNUSED_CONTEXT PERL_UNUSED_ARG(my_perl)
341 #else
342 #  define PERL_UNUSED_CONTEXT
343 #endif
344
345 /* gcc (-ansi) -pedantic doesn't allow gcc statement expressions,
346  * g++ allows them but seems to have problems with them
347  * (insane errors ensue).
348  * g++ does not give insane errors now (RMB 2008-01-30, gcc 4.2.2).
349  */
350 #if defined(PERL_GCC_PEDANTIC) || \
351     (defined(__GNUC__) && defined(__cplusplus) && \
352         ((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2))))
353 #  ifndef PERL_GCC_BRACE_GROUPS_FORBIDDEN
354 #    define PERL_GCC_BRACE_GROUPS_FORBIDDEN
355 #  endif
356 #endif
357
358 /* Use PERL_UNUSED_RESULT() to suppress the warnings about unused results
359  * of function calls, e.g. PERL_UNUSED_RESULT(foo(a, b)).
360  *
361  * The main reason for this is that the combination of gcc -Wunused-result
362  * (part of -Wall) and the __attribute__((warn_unused_result)) cannot
363  * be silenced with casting to void.  This causes trouble when the system
364  * header files use the attribute.
365  *
366  * Use PERL_UNUSED_RESULT sparingly, though, since usually the warning
367  * is there for a good reason: you might lose success/failure information,
368  * or leak resources, or changes in resources.
369  *
370  * But sometimes you just want to ignore the return value, e.g. on
371  * codepaths soon ending up in abort, or in "best effort" attempts,
372  * or in situations where there is no good way to handle failures.
373  *
374  * Sometimes PERL_UNUSED_RESULT might not be the most natural way:
375  * another possibility is that you can capture the return value
376  * and use PERL_UNUSED_VAR on that.
377  *
378  * The __typeof__() is used instead of typeof() since typeof() is not
379  * available under strict C89, and because of compilers masquerading
380  * as gcc (clang and icc), we want exactly the gcc extension
381  * __typeof__ and nothing else.
382  */
383 #ifndef PERL_UNUSED_RESULT
384 #  if defined(__GNUC__) && defined(HASATTRIBUTE_WARN_UNUSED_RESULT)
385 #    define PERL_UNUSED_RESULT(v) STMT_START { __typeof__(v) z = (v); (void)sizeof(z); } STMT_END
386 #  else
387 #    define PERL_UNUSED_RESULT(v) ((void)(v))
388 #  endif
389 #endif
390
391 /* on gcc (and clang), specify that a warning should be temporarily
392  * ignored; e.g.
393  *
394  *    GCC_DIAG_IGNORE(-Wmultichar);
395  *    char b = 'ab';
396  *    GCC_DIAG_RESTORE;
397  *
398  * based on http://dbp-consulting.com/tutorials/SuppressingGCCWarnings.html
399  *
400  * Note that "pragma GCC diagnostic push/pop" was added in GCC 4.6, Mar 2011;
401  * clang only pretends to be GCC 4.2, but still supports push/pop.
402  *
403  * Note on usage: on non-gcc (or lookalike, like clang) compilers
404  * one cannot use these with a semicolon at file (global) level without
405  * warnings since they are defined as empty, which leads into the terminating
406  * semicolon being left alone on a line:
407  * ;
408  * which makes compilers mildly cranky.  Therefore at file level one
409  * should use the GCC_DIAG_IGNORE and GCC_DIAG_RESTORE macros *without*
410  * the semicolons.
411  *
412  * (A dead-on-arrival solution would be to try to define the macros as
413  * NOOP or dNOOP, those don't work both inside functions and outside.)
414  */
415
416 #if defined(__clang__) || defined(__clang) || \
417        (defined( __GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406)
418 #  define GCC_DIAG_PRAGMA(x) _Pragma (#x)
419 /* clang has "clang diagnostic" pragmas, but also understands gcc. */
420 #  define GCC_DIAG_IGNORE(x) _Pragma("GCC diagnostic push") \
421                              GCC_DIAG_PRAGMA(GCC diagnostic ignored #x)
422 #  define GCC_DIAG_RESTORE   _Pragma("GCC diagnostic pop")
423 #else
424 #  define GCC_DIAG_IGNORE(w)
425 #  define GCC_DIAG_RESTORE
426 #endif
427 /* for clang specific pragmas */
428 #if defined(__clang__) || defined(__clang)
429 #  define CLANG_DIAG_PRAGMA(x) _Pragma (#x)
430 #  define CLANG_DIAG_IGNORE(x) _Pragma("clang diagnostic push") \
431                                CLANG_DIAG_PRAGMA(clang diagnostic ignored #x)
432 #  define CLANG_DIAG_RESTORE   _Pragma("clang diagnostic pop")
433 #else
434 #  define CLANG_DIAG_IGNORE(w)
435 #  define CLANG_DIAG_RESTORE
436 #endif
437
438 #define NOOP /*EMPTY*/(void)0
439 /* cea2e8a9dd23747f accidentally lost the comment originally from the first
440    check in of thread.h, explaining why we need dNOOP at all:  */
441 /* Rats: if dTHR is just blank then the subsequent ";" throws an error */
442 /* Declaring a *function*, instead of a variable, ensures that we don't rely
443    on being able to suppress "unused" warnings.  */
444 #ifdef __cplusplus
445 #define dNOOP (void)0
446 #else
447 #define dNOOP extern int Perl___notused(void)
448 #endif
449
450 #ifndef pTHX
451 /* Don't bother defining tTHX ; using it outside
452  * code guarded by PERL_IMPLICIT_CONTEXT is an error.
453  */
454 #  define pTHX          void
455 #  define pTHX_
456 #  define aTHX
457 #  define aTHX_
458 #  define aTHXa(a)      NOOP
459 #  define dTHXa(a)      dNOOP
460 #  define dTHX          dNOOP
461 #  define pTHX_1        1       
462 #  define pTHX_2        2
463 #  define pTHX_3        3
464 #  define pTHX_4        4
465 #  define pTHX_5        5
466 #  define pTHX_6        6
467 #  define pTHX_7        7
468 #  define pTHX_8        8
469 #  define pTHX_9        9
470 #  define pTHX_12       12
471 #endif
472
473 #ifndef dVAR
474 #  define dVAR          dNOOP
475 #endif
476
477 /* these are only defined for compatibility; should not be used internally */
478 #if !defined(pTHXo) && !defined(PERL_CORE)
479 #  define pTHXo         pTHX
480 #  define pTHXo_        pTHX_
481 #  define aTHXo         aTHX
482 #  define aTHXo_        aTHX_
483 #  define dTHXo         dTHX
484 #  define dTHXoa(x)     dTHXa(x)
485 #endif
486
487 #ifndef pTHXx
488 #  define pTHXx         PerlInterpreter *my_perl
489 #  define pTHXx_        pTHXx,
490 #  define aTHXx         my_perl
491 #  define aTHXx_        aTHXx,
492 #  define dTHXx         dTHX
493 #endif
494
495 /* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
496  * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
497  * dTHXs is therefore needed for all functions using PerlIO_foo(). */
498 #ifdef PERL_IMPLICIT_SYS
499 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
500 #    define dTHXs               dVAR; dTHX
501 #  else
502 #    define dTHXs               dTHX
503 #  endif
504 #else
505 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
506 #    define dTHXs               dVAR
507 #  else
508 #    define dTHXs               dNOOP
509 #  endif
510 #endif
511
512 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
513 #  ifndef PERL_USE_GCC_BRACE_GROUPS
514 #    define PERL_USE_GCC_BRACE_GROUPS
515 #  endif
516 #endif
517
518 /*
519  * STMT_START { statements; } STMT_END;
520  * can be used as a single statement, as in
521  * if (x) STMT_START { ... } STMT_END; else ...
522  *
523  * Trying to select a version that gives no warnings...
524  */
525 #if !(defined(STMT_START) && defined(STMT_END))
526 # ifdef PERL_USE_GCC_BRACE_GROUPS
527 #   define STMT_START   (void)( /* gcc supports "({ STATEMENTS; })" */
528 #   define STMT_END     )
529 # else
530 #   define STMT_START   do
531 #   define STMT_END     while (0)
532 # endif
533 #endif
534
535 #ifndef BYTEORDER  /* Should never happen -- byteorder is in config.h */
536 #   define BYTEORDER 0x1234
537 #endif
538
539 /* Overall memory policy? */
540 #ifndef CONSERVATIVE
541 #   define LIBERAL 1
542 #endif
543
544 #if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
545 #define ASCIIish
546 #else
547 #undef  ASCIIish
548 #endif
549
550 /*
551  * The following contortions are brought to you on behalf of all the
552  * standards, semi-standards, de facto standards, not-so-de-facto standards
553  * of the world, as well as all the other botches anyone ever thought of.
554  * The basic theory is that if we work hard enough here, the rest of the
555  * code can be a lot prettier.  Well, so much for theory.  Sorry, Henry...
556  */
557
558 /* define this once if either system, instead of cluttering up the src */
559 #if defined(MSDOS) || defined(WIN32) || defined(NETWARE)
560 #define DOSISH 1
561 #endif
562
563 #if defined(__STDC__) || defined(_AIX) || defined(__stdc__) || defined(__cplusplus) || defined(NETWARE) || defined(__SYMBIAN32__)
564 # define STANDARD_C 1
565 #endif
566
567 #if defined(__cplusplus) || defined(WIN32) || defined(__sgi) || defined(__EMX__) || defined(__QNX__) || defined(NETWARE) || defined(PERL_MICRO)
568 # define DONT_DECLARE_STD 1
569 #endif
570
571 /* These exist only for back-compat with XS modules. */
572 #ifndef PERL_CORE
573 #define VOL volatile
574 #define CAN_PROTOTYPE
575 #endif
576
577 /* By compiling a perl with -DNO_TAINT_SUPPORT or -DSILENT_NO_TAINT_SUPPORT,
578  * you get a perl without taint support, but doubtlessly with a lesser
579  * degree of support. Do not do so unless you know exactly what it means
580  * technically, have a good reason to do so, and know exactly how the
581  * perl will be used. perls with -DSILENT_NO_TAINT_SUPPORT are considered
582  * a potential security risk due to flat out ignoring the security-relevant
583  * taint flags. This being said, a perl without taint support compiled in
584  * has marginal run-time performance benefits.
585  * SILENT_NO_TAINT_SUPPORT implies NO_TAINT_SUPPORT.
586  * SILENT_NO_TAINT_SUPPORT is the same as NO_TAINT_SUPPORT except it
587  * silently ignores -t/-T instead of throwing an exception.
588  *
589  * DANGER! Using NO_TAINT_SUPPORT or SILENT_NO_TAINT_SUPPORT
590  *         voids your nonexistent warranty!
591  */
592 #if defined(SILENT_NO_TAINT_SUPPORT) && !defined(NO_TAINT_SUPPORT)
593 #  define NO_TAINT_SUPPORT 1
594 #endif
595
596 /* NO_TAINT_SUPPORT can be set to transform virtually all taint-related
597  * operations into no-ops for a very modest speed-up. Enable only if you
598  * know what you're doing: tests and CPAN modules' tests are bound to fail.
599  */
600 #ifdef NO_TAINT_SUPPORT
601 #   define TAINT                NOOP
602 #   define TAINT_NOT            NOOP
603 #   define TAINT_IF(c)          NOOP
604 #   define TAINT_ENV()          NOOP
605 #   define TAINT_PROPER(s)      NOOP
606 #   define TAINT_set(s)         NOOP
607 #   define TAINT_get            0
608 #   define TAINTING_get         0
609 #   define TAINTING_set(s)      NOOP
610 #   define TAINT_WARN_get       0
611 #   define TAINT_WARN_set(s)    NOOP
612 #else
613 #   define TAINT                (PL_tainted = PL_tainting)
614 #   define TAINT_NOT    (PL_tainted = FALSE)
615 #   define TAINT_IF(c)  if (UNLIKELY(c)) { PL_tainted = PL_tainting; }
616 #   define TAINT_ENV()  if (UNLIKELY(PL_tainting)) { taint_env(); }
617 #   define TAINT_PROPER(s)      if (UNLIKELY(PL_tainting)) { taint_proper(NULL, s); }
618 #   define TAINT_set(s)         (PL_tainted = (s))
619 #   define TAINT_get            (PL_tainted)
620 #   define TAINTING_get         (PL_tainting)
621 #   define TAINTING_set(s)      (PL_tainting = (s))
622 #   define TAINT_WARN_get       (PL_taint_warn)
623 #   define TAINT_WARN_set(s)    (PL_taint_warn = (s))
624 #endif
625
626 /* flags used internally only within pp_subst and pp_substcont */
627 #ifdef PERL_CORE
628 #  define SUBST_TAINT_STR      1        /* string tainted */
629 #  define SUBST_TAINT_PAT      2        /* pattern tainted */
630 #  define SUBST_TAINT_REPL     4        /* replacement tainted */
631 #  define SUBST_TAINT_RETAINT  8        /* use re'taint' in scope */
632 #  define SUBST_TAINT_BOOLRET 16        /* return is boolean (don't taint) */
633 #endif
634
635 /* XXX All process group stuff is handled in pp_sys.c.  Should these
636    defines move there?  If so, I could simplify this a lot. --AD  9/96.
637 */
638 /* Process group stuff changed from traditional BSD to POSIX.
639    perlfunc.pod documents the traditional BSD-style syntax, so we'll
640    try to preserve that, if possible.
641 */
642 #ifdef HAS_SETPGID
643 #  define BSD_SETPGRP(pid, pgrp)        setpgid((pid), (pgrp))
644 #elif defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
645 #  define BSD_SETPGRP(pid, pgrp)        setpgrp((pid), (pgrp))
646 #elif defined(HAS_SETPGRP2)
647 #  define BSD_SETPGRP(pid, pgrp)        setpgrp2((pid), (pgrp))
648 #endif
649 #if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
650 #  define HAS_SETPGRP  /* Well, effectively it does . . . */
651 #endif
652
653 /* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
654     our life easier :-) so we'll try it.
655 */
656 #ifdef HAS_GETPGID
657 #  define BSD_GETPGRP(pid)              getpgid((pid))
658 #elif defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
659 #  define BSD_GETPGRP(pid)              getpgrp((pid))
660 #elif defined(HAS_GETPGRP2)
661 #  define BSD_GETPGRP(pid)              getpgrp2((pid))
662 #endif
663 #if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
664 #  define HAS_GETPGRP  /* Well, effectively it does . . . */
665 #endif
666
667 /* These are not exact synonyms, since setpgrp() and getpgrp() may
668    have different behaviors, but perl.h used to define USE_BSDPGRP
669    (prior to 5.003_05) so some extension might depend on it.
670 */
671 #if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
672 #  ifndef USE_BSDPGRP
673 #    define USE_BSDPGRP
674 #  endif
675 #endif
676
677 /* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
678    pthread.h must be included before all other header files.
679 */
680 #if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
681 #  include <pthread.h>
682 #endif
683
684 #include <sys/types.h>
685
686 /* EVC 4 SDK headers includes a bad definition of MB_CUR_MAX in stdlib.h
687   which is included from stdarg.h. Bad definition not present in SD 2008
688   SDK headers. wince.h is not yet included, so we cant fix this from there
689   since by then MB_CUR_MAX will be defined from stdlib.h.
690   cewchar.h includes a correct definition of MB_CUR_MAX and it is copied here
691   since cewchar.h can't be included this early */
692 #if defined(UNDER_CE) && (_MSC_VER < 1300)
693 #  define MB_CUR_MAX 1
694 #endif
695
696 # include <stdarg.h>
697
698 #ifdef I_STDINT
699 # include <stdint.h>
700 #endif
701
702 #include <ctype.h>
703 #include <float.h>
704 #include <limits.h>
705
706 #ifdef METHOD   /* Defined by OSF/1 v3.0 by ctype.h */
707 #undef METHOD
708 #endif
709
710 #ifdef PERL_MICRO
711 #   define NO_LOCALE
712 #endif
713
714 #ifdef I_LOCALE
715 #   include <locale.h>
716 #endif
717
718 #ifdef I_XLOCALE
719 #   include <xlocale.h>
720 #endif
721
722 #if !defined(NO_LOCALE) && defined(HAS_SETLOCALE)
723 #   define USE_LOCALE
724 #   define HAS_SKIP_LOCALE_INIT /* Solely for XS code to test for this
725                                    capability */
726 #   if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
727        && defined(HAS_STRXFRM)
728 #       define USE_LOCALE_COLLATE
729 #   endif
730 #   if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
731 #       define USE_LOCALE_CTYPE
732 #   endif
733 #   if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
734 #       define USE_LOCALE_NUMERIC
735 #   endif
736 #   if !defined(NO_LOCALE_MESSAGES) && defined(LC_MESSAGES)
737 #       define USE_LOCALE_MESSAGES
738 #   endif
739 #   if !defined(NO_LOCALE_MONETARY) && defined(LC_MONETARY)
740 #       define USE_LOCALE_MONETARY
741 #   endif
742 #   if !defined(NO_LOCALE_TIME) && defined(LC_TIME)
743 #       define USE_LOCALE_TIME
744 #   endif
745 #endif /* !NO_LOCALE && HAS_SETLOCALE */
746
747 #include <setjmp.h>
748
749 #ifdef I_SYS_PARAM
750 #   ifdef PARAM_NEEDS_TYPES
751 #       include <sys/types.h>
752 #   endif
753 #   include <sys/param.h>
754 #endif
755
756 /* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
757    value something like 199306.  This may be useful if no more-specific
758    feature test is available.
759 */
760 #if defined(BSD)
761 #   ifndef BSDish
762 #       define BSDish
763 #   endif
764 #endif
765
766 /* Use all the "standard" definitions */
767 #include <stdlib.h>
768
769 /* If this causes problems, set i_unistd=undef in the hint file.  */
770 #ifdef I_UNISTD
771 #    if defined(__amigaos4__)
772 #        ifdef I_NETINET_IN
773 #            include <netinet/in.h>
774 #        endif
775 #   endif
776 #   include <unistd.h>
777 #   if defined(__amigaos4__)
778 /* Under AmigaOS 4 newlib.library provides an environ.  However using
779  * it doesn't give us enough control over inheritance of variables by
780  * subshells etc. so replace with custom version based on abc-shell
781  * code. */
782 extern char **myenviron;
783 #       undef environ
784 #       define environ myenviron
785 #   endif
786 #endif
787
788 /* for WCOREDUMP */
789 #ifdef I_SYS_WAIT
790 #   include <sys/wait.h>
791 #endif
792
793 #ifdef __SYMBIAN32__
794 #   undef _SC_ARG_MAX /* Symbian has _SC_ARG_MAX but no sysconf() */
795 #endif
796
797 #if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
798 EXTERN_C int syscall(int, ...);
799 #endif
800
801 #if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
802 EXTERN_C int usleep(unsigned int);
803 #endif
804
805 #ifdef PERL_CORE
806
807 /* macros for correct constant construction */
808 # if INTSIZE >= 2
809 #  define U16_CONST(x) ((U16)x##U)
810 # else
811 #  define U16_CONST(x) ((U16)x##UL)
812 # endif
813
814 # if INTSIZE >= 4
815 #  define U32_CONST(x) ((U32)x##U)
816 # else
817 #  define U32_CONST(x) ((U32)x##UL)
818 # endif
819
820 # ifdef HAS_QUAD
821 #  if INTSIZE >= 8
822 #   define U64_CONST(x) ((U64)x##U)
823 #  elif LONGSIZE >= 8
824 #   define U64_CONST(x) ((U64)x##UL)
825 #  elif QUADKIND == QUAD_IS_LONG_LONG
826 #   define U64_CONST(x) ((U64)x##ULL)
827 #  elif QUADKIND == QUAD_IS___INT64
828 #   define U64_CONST(x) ((U64)x##UI64)
829 #  else /* best guess we can make */
830 #   define U64_CONST(x) ((U64)x##UL)
831 #  endif
832 # endif
833
834 /* byte-swapping functions for big-/little-endian conversion */
835 # define _swab_16_(x) ((U16)( \
836          (((U16)(x) & U16_CONST(0x00ff)) << 8) | \
837          (((U16)(x) & U16_CONST(0xff00)) >> 8) ))
838
839 # define _swab_32_(x) ((U32)( \
840          (((U32)(x) & U32_CONST(0x000000ff)) << 24) | \
841          (((U32)(x) & U32_CONST(0x0000ff00)) <<  8) | \
842          (((U32)(x) & U32_CONST(0x00ff0000)) >>  8) | \
843          (((U32)(x) & U32_CONST(0xff000000)) >> 24) ))
844
845 # ifdef HAS_QUAD
846 #  define _swab_64_(x) ((U64)( \
847           (((U64)(x) & U64_CONST(0x00000000000000ff)) << 56) | \
848           (((U64)(x) & U64_CONST(0x000000000000ff00)) << 40) | \
849           (((U64)(x) & U64_CONST(0x0000000000ff0000)) << 24) | \
850           (((U64)(x) & U64_CONST(0x00000000ff000000)) <<  8) | \
851           (((U64)(x) & U64_CONST(0x000000ff00000000)) >>  8) | \
852           (((U64)(x) & U64_CONST(0x0000ff0000000000)) >> 24) | \
853           (((U64)(x) & U64_CONST(0x00ff000000000000)) >> 40) | \
854           (((U64)(x) & U64_CONST(0xff00000000000000)) >> 56) ))
855 # endif
856
857 /* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
858    at least on FreeBSD.  YMMV, so experiment.  */
859 #ifndef PERL_ARENA_SIZE
860 #define PERL_ARENA_SIZE 4080
861 #endif
862
863 /* Maximum level of recursion */
864 #ifndef PERL_SUB_DEPTH_WARN
865 #define PERL_SUB_DEPTH_WARN 100
866 #endif
867
868 #endif /* PERL_CORE */
869
870 /* We no longer default to creating a new SV for GvSV.
871    Do this before embed.  */
872 #ifndef PERL_CREATE_GVSV
873 #  ifndef PERL_DONT_CREATE_GVSV
874 #    define PERL_DONT_CREATE_GVSV
875 #  endif
876 #endif
877
878 #if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
879 #define PERL_USES_PL_PIDSTATUS
880 #endif
881
882 #if !defined(OS2) && !defined(WIN32) && !defined(DJGPP) && !defined(__SYMBIAN32__)
883 #define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
884 #endif
885
886 #define MEM_SIZE Size_t
887
888 /* Round all values passed to malloc up, by default to a multiple of
889    sizeof(size_t)
890 */
891 #ifndef PERL_STRLEN_ROUNDUP_QUANTUM
892 #define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
893 #endif
894
895 /* sv_grow() will expand strings by at least a certain percentage of
896    the previously *used* length to avoid excessive calls to realloc().
897    The default is 25% of the current length.
898 */
899 #ifndef PERL_STRLEN_EXPAND_SHIFT
900 #  define PERL_STRLEN_EXPAND_SHIFT 2
901 #endif
902
903 #include <stddef.h>
904 #define STRUCT_OFFSET(s,m)  offsetof(s,m)
905
906 /* ptrdiff_t is C11, so undef it under pedantic builds */
907 #ifdef PERL_GCC_PEDANTIC
908 #   undef HAS_PTRDIFF_T
909 #endif
910
911 #ifndef __SYMBIAN32__
912 #  if defined(I_STRING) || defined(__cplusplus)
913 #     include <string.h>
914 #  else
915 #     include <strings.h>
916 #  endif
917 #endif
918
919 /* This comes after <stdlib.h> so we don't try to change the standard
920  * library prototypes; we'll use our own in proto.h instead. */
921
922 #ifdef MYMALLOC
923 #  ifdef PERL_POLLUTE_MALLOC
924 #   ifndef PERL_EXTMALLOC_DEF
925 #    define Perl_malloc         malloc
926 #    define Perl_calloc         calloc
927 #    define Perl_realloc        realloc
928 #    define Perl_mfree          free
929 #   endif
930 #  else
931 #    define EMBEDMYMALLOC       /* for compatibility */
932 #  endif
933
934 #  define safemalloc  Perl_malloc
935 #  define safecalloc  Perl_calloc
936 #  define saferealloc Perl_realloc
937 #  define safefree    Perl_mfree
938 #  define CHECK_MALLOC_TOO_LATE_FOR_(code)      STMT_START {            \
939         if (!PL_tainting && MallocCfg_ptr[MallocCfg_cfg_env_read])      \
940                 code;                                                   \
941     } STMT_END
942 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)                         \
943         CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
944 #  define panic_write2(s)               write(2, s, strlen(s))
945 #  define CHECK_MALLOC_TAINT(newval)                            \
946         CHECK_MALLOC_TOO_LATE_FOR_(                             \
947                 if (newval) {                                   \
948                   PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
949                   exit(1); })
950 #  define MALLOC_CHECK_TAINT(argc,argv,env)     STMT_START {    \
951         if (doing_taint(argc,argv,env)) {                       \
952                 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1;      \
953     }} STMT_END;
954 #else  /* MYMALLOC */
955 #  define safemalloc  safesysmalloc
956 #  define safecalloc  safesyscalloc
957 #  define saferealloc safesysrealloc
958 #  define safefree    safesysfree
959 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)         ((void)0)
960 #  define CHECK_MALLOC_TAINT(newval)            ((void)0)
961 #  define MALLOC_CHECK_TAINT(argc,argv,env)
962 #endif /* MYMALLOC */
963
964 /* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
965 #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)
966 #define TOO_LATE_FOR(ch)        TOO_LATE_FOR_(ch, "")
967 #define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
968 #define MALLOC_CHECK_TAINT2(argc,argv)  MALLOC_CHECK_TAINT(argc,argv,NULL)
969
970 #ifdef I_MEMORY
971 #  include <memory.h>
972 #endif
973
974 #ifndef memzero
975 #   define memzero(d,l) memset(d,0,l)
976 #endif
977
978 #ifdef I_NETINET_IN
979 #   include <netinet/in.h>
980 #endif
981
982 #ifdef I_ARPA_INET
983 #   include <arpa/inet.h>
984 #endif
985
986 #ifdef I_SYS_STAT
987 #   include <sys/stat.h>
988 #endif
989
990 /* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
991    This definition should ideally go into win32/win32.h, but S_IFIFO is
992    used later here in perl.h before win32/win32.h is being included. */
993 #if !defined(S_IFIFO) && defined(_S_IFIFO)
994 #   define S_IFIFO _S_IFIFO
995 #endif
996
997 /* The stat macros for Unisoft System V/88 (and derivatives
998    like UTekV) are broken, sometimes giving false positives.  Undefine
999    them here and let the code below set them to proper values.
1000
1001    The ghs macro stands for GreenHills Software C-1.8.5 which
1002    is the C compiler for sysV88 and the various derivatives.
1003    This header file bug is corrected in gcc-2.5.8 and later versions.
1004    --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94.  */
1005
1006 #if defined(m88k) && defined(ghs)
1007 #   undef S_ISDIR
1008 #   undef S_ISCHR
1009 #   undef S_ISBLK
1010 #   undef S_ISREG
1011 #   undef S_ISFIFO
1012 #   undef S_ISLNK
1013 #endif
1014
1015 #include <time.h>
1016
1017 #ifdef I_SYS_TIME
1018 #   ifdef I_SYS_TIME_KERNEL
1019 #       define KERNEL
1020 #   endif
1021 #   include <sys/time.h>
1022 #   ifdef I_SYS_TIME_KERNEL
1023 #       undef KERNEL
1024 #   endif
1025 #endif
1026
1027 #if defined(HAS_TIMES) && defined(I_SYS_TIMES)
1028 #    include <sys/times.h>
1029 #endif
1030
1031 #if defined(HAS_STRERROR) && (!defined(HAS_MKDIR) || !defined(HAS_RMDIR))
1032 #   undef HAS_STRERROR
1033 #endif
1034
1035 #include <errno.h>
1036
1037 #if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
1038 #  define WIN32SCK_IS_STDSCK            /* don't pull in custom wsock layer */
1039 #endif
1040
1041 #if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1042 # include <sys/socket.h>
1043 # if defined(USE_SOCKS) && defined(I_SOCKS)
1044 #   if !defined(INCLUDE_PROTOTYPES)
1045 #       define INCLUDE_PROTOTYPES /* for <socks.h> */
1046 #       define PERL_SOCKS_NEED_PROTOTYPES
1047 #   endif
1048 #   include <socks.h>
1049 #   ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1050 #       undef INCLUDE_PROTOTYPES
1051 #       undef PERL_SOCKS_NEED_PROTOTYPES
1052 #   endif
1053 # endif
1054 # ifdef I_NETDB
1055 #  ifdef NETWARE
1056 #   include<stdio.h>
1057 #  endif
1058 #  include <netdb.h>
1059 # endif
1060 # ifndef ENOTSOCK
1061 #  ifdef I_NET_ERRNO
1062 #   include <net/errno.h>
1063 #  endif
1064 # endif
1065 #endif
1066
1067 /* sockatmark() is so new (2001) that many places might have it hidden
1068  * behind some -D_BLAH_BLAH_SOURCE guard.  The __THROW magic is required
1069  * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
1070 #if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
1071 # if defined(__THROW) && defined(__GLIBC__)
1072 int sockatmark(int) __THROW;
1073 # else
1074 int sockatmark(int);
1075 # endif
1076 #endif
1077
1078 #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. */
1079 EXTERN_C int fchdir(int);
1080 EXTERN_C int flock(int, int);
1081 EXTERN_C int fseeko(FILE *, off_t, int);
1082 EXTERN_C off_t ftello(FILE *);
1083 #endif
1084
1085 #if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1086 EXTERN_C char *crypt(const char *, const char *);
1087 EXTERN_C char **environ;
1088 #endif
1089
1090 #if defined(__cplusplus)
1091 #  if defined(BSDish)
1092 EXTERN_C char **environ;
1093 #  elif defined(__CYGWIN__)
1094 EXTERN_C char *crypt(const char *, const char *);
1095 #endif
1096 #endif
1097
1098 #ifdef SETERRNO
1099 # undef SETERRNO  /* SOCKS might have defined this */
1100 #endif
1101
1102 #ifdef VMS
1103 #   define SETERRNO(errcode,vmserrcode) \
1104         STMT_START {                    \
1105             set_errno(errcode);         \
1106             set_vaxc_errno(vmserrcode); \
1107         } STMT_END
1108 #   define dSAVEDERRNO    int saved_errno; unsigned saved_vms_errno
1109 #   define dSAVE_ERRNO    int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1110 #   define SAVE_ERRNO     ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1111 #   define RESTORE_ERRNO  SETERRNO(saved_errno, saved_vms_errno)
1112
1113 #   define LIB_INVARG           LIB$_INVARG
1114 #   define RMS_DIR              RMS$_DIR
1115 #   define RMS_FAC              RMS$_FAC
1116 #   define RMS_FEX              RMS$_FEX
1117 #   define RMS_FNF              RMS$_FNF
1118 #   define RMS_IFI              RMS$_IFI
1119 #   define RMS_ISI              RMS$_ISI
1120 #   define RMS_PRV              RMS$_PRV
1121 #   define SS_ACCVIO            SS$_ACCVIO
1122 #   define SS_DEVOFFLINE        SS$_DEVOFFLINE
1123 #   define SS_IVCHAN            SS$_IVCHAN
1124 #   define SS_NORMAL            SS$_NORMAL
1125 #   define SS_NOPRIV            SS$_NOPRIV
1126 #   define SS_BUFFEROVF         SS$_BUFFEROVF
1127 #else
1128 #   define LIB_INVARG           0
1129 #   define RMS_DIR              0
1130 #   define RMS_FAC              0
1131 #   define RMS_FEX              0
1132 #   define RMS_FNF              0
1133 #   define RMS_IFI              0
1134 #   define RMS_ISI              0
1135 #   define RMS_PRV              0
1136 #   define SS_ACCVIO            0
1137 #   define SS_DEVOFFLINE        0
1138 #   define SS_IVCHAN            0
1139 #   define SS_NORMAL            0
1140 #   define SS_NOPRIV            0
1141 #   define SS_BUFFEROVF         0
1142 #endif
1143
1144 #ifdef WIN32
1145 #   define dSAVEDERRNO  int saved_errno; DWORD saved_win32_errno
1146 #   define dSAVE_ERRNO  int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1147 #   define SAVE_ERRNO   ( saved_errno = errno, saved_win32_errno = GetLastError() )
1148 #   define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1149 #endif
1150
1151 #ifdef OS2
1152 #   define dSAVEDERRNO  int saved_errno; unsigned long saved_os2_errno
1153 #   define dSAVE_ERRNO  int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1154 #   define SAVE_ERRNO   ( saved_errno = errno, saved_os2_errno = Perl_rc )
1155 #   define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1156 #endif
1157
1158 #ifndef SETERRNO
1159 #   define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1160 #endif
1161
1162 #ifndef dSAVEDERRNO
1163 #   define dSAVEDERRNO    int saved_errno
1164 #   define dSAVE_ERRNO    int saved_errno = errno
1165 #   define SAVE_ERRNO     (saved_errno = errno)
1166 #   define RESTORE_ERRNO  (errno = saved_errno)
1167 #endif
1168
1169 #define ERRSV GvSVn(PL_errgv)
1170
1171 /* contains inlined gv_add_by_type */
1172 #define CLEAR_ERRSV() STMT_START {                                      \
1173     SV ** const svp = &GvSV(PL_errgv);                                  \
1174     if (!*svp) {                                                        \
1175         *svp = newSVpvs("");                                            \
1176     } else if (SvREADONLY(*svp)) {                                      \
1177         SvREFCNT_dec_NN(*svp);                                          \
1178         *svp = newSVpvs("");                                            \
1179     } else {                                                            \
1180         SV *const errsv = *svp;                                         \
1181         SvPVCLEAR(errsv);                                               \
1182         SvPOK_only(errsv);                                              \
1183         if (SvMAGICAL(errsv)) {                                         \
1184             mg_free(errsv);                                             \
1185         }                                                               \
1186     }                                                                   \
1187     } STMT_END
1188
1189
1190 #ifdef PERL_CORE
1191 # define DEFSV (0 + GvSVn(PL_defgv))
1192 # define DEFSV_set(sv) \
1193     (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1194 # define SAVE_DEFSV                \
1195     (                               \
1196         save_gp(PL_defgv, 0),        \
1197         GvINTRO_off(PL_defgv),        \
1198         SAVEGENERICSV(GvSV(PL_defgv)), \
1199         GvSV(PL_defgv) = NULL           \
1200     )
1201 #else
1202 # define DEFSV GvSVn(PL_defgv)
1203 # define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1204 # define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
1205 #endif
1206
1207 #ifndef errno
1208         extern int errno;     /* ANSI allows errno to be an lvalue expr.
1209                                * For example in multithreaded environments
1210                                * something like this might happen:
1211                                * extern int *_errno(void);
1212                                * #define errno (*_errno()) */
1213 #endif
1214
1215 #define UNKNOWN_ERRNO_MSG "(unknown)"
1216
1217 #ifdef HAS_STRERROR
1218 #   ifndef DONT_DECLARE_STD
1219 #       ifdef VMS
1220         char *strerror (int,...);
1221 #       else
1222         char *strerror (int);
1223 #       endif
1224 #    endif
1225 #    ifndef Strerror
1226 #       define Strerror strerror
1227 #    endif
1228 #elif defined(HAS_SYS_ERRLIST)
1229         extern int sys_nerr;
1230         extern char *sys_errlist[];
1231 #       ifndef Strerror
1232 #           define Strerror(e) \
1233                 ((e) < 0 || (e) >= sys_nerr ? UNKNOWN_ERRNO_MSG : sys_errlist[e])
1234 #       endif
1235 #endif
1236
1237 #ifdef I_SYS_IOCTL
1238 #   ifndef _IOCTL_
1239 #       include <sys/ioctl.h>
1240 #   endif
1241 #endif
1242
1243 #if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
1244 #   ifdef HAS_SOCKETPAIR
1245 #       undef HAS_SOCKETPAIR
1246 #   endif
1247 #   ifdef I_NDBM
1248 #       undef I_NDBM
1249 #   endif
1250 #endif
1251
1252 #ifndef HAS_SOCKETPAIR
1253 #   ifdef HAS_SOCKET
1254 #       define socketpair Perl_my_socketpair
1255 #   endif
1256 #endif
1257
1258 #if INTSIZE == 2
1259 #   define htoni htons
1260 #   define ntohi ntohs
1261 #else
1262 #   define htoni htonl
1263 #   define ntohi ntohl
1264 #endif
1265
1266 /* Configure already sets Direntry_t */
1267 #if defined(I_DIRENT)
1268 #  include <dirent.h>
1269 #elif defined(I_SYS_NDIR)
1270 #  include <sys/ndir.h>
1271 #elif defined(I_SYS_DIR)
1272 #  include <sys/dir.h>
1273 #endif
1274
1275 /*
1276  * The following gobbledygook brought to you on behalf of __STDC__.
1277  * (I could just use #ifndef __STDC__, but this is more bulletproof
1278  * in the face of half-implementations.)
1279  */
1280
1281 #if defined(I_SYSMODE)
1282 #include <sys/mode.h>
1283 #endif
1284
1285 #ifndef S_IFMT
1286 #   ifdef _S_IFMT
1287 #       define S_IFMT _S_IFMT
1288 #   else
1289 #       define S_IFMT 0170000
1290 #   endif
1291 #endif
1292
1293 #ifndef S_ISDIR
1294 #   define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1295 #endif
1296
1297 #ifndef S_ISCHR
1298 #   define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1299 #endif
1300
1301 #ifndef S_ISBLK
1302 #   ifdef S_IFBLK
1303 #       define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1304 #   else
1305 #       define S_ISBLK(m) (0)
1306 #   endif
1307 #endif
1308
1309 #ifndef S_ISREG
1310 #   define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1311 #endif
1312
1313 #ifndef S_ISFIFO
1314 #   ifdef S_IFIFO
1315 #       define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1316 #   else
1317 #       define S_ISFIFO(m) (0)
1318 #   endif
1319 #endif
1320
1321 #ifndef S_ISLNK
1322 #  ifdef _S_ISLNK
1323 #    define S_ISLNK(m) _S_ISLNK(m)
1324 #  elif defined(_S_IFLNK)
1325 #    define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1326 #  elif defined(S_IFLNK)
1327 #    define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1328 #  else
1329 #    define S_ISLNK(m) (0)
1330 #  endif
1331 #endif
1332
1333 #ifndef S_ISSOCK
1334 #  ifdef _S_ISSOCK
1335 #    define S_ISSOCK(m) _S_ISSOCK(m)
1336 #  elif defined(_S_IFSOCK)
1337 #    define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1338 #  elif defined(S_IFSOCK)
1339 #    define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1340 #  else
1341 #    define S_ISSOCK(m) (0)
1342 #  endif
1343 #endif
1344
1345 #ifndef S_IRUSR
1346 #   ifdef S_IREAD
1347 #       define S_IRUSR S_IREAD
1348 #       define S_IWUSR S_IWRITE
1349 #       define S_IXUSR S_IEXEC
1350 #   else
1351 #       define S_IRUSR 0400
1352 #       define S_IWUSR 0200
1353 #       define S_IXUSR 0100
1354 #   endif
1355 #endif
1356
1357 #ifndef S_IRGRP
1358 #   ifdef S_IRUSR
1359 #       define S_IRGRP (S_IRUSR>>3)
1360 #       define S_IWGRP (S_IWUSR>>3)
1361 #       define S_IXGRP (S_IXUSR>>3)
1362 #   else
1363 #       define S_IRGRP 0040
1364 #       define S_IWGRP 0020
1365 #       define S_IXGRP 0010
1366 #   endif
1367 #endif
1368
1369 #ifndef S_IROTH
1370 #   ifdef S_IRUSR
1371 #       define S_IROTH (S_IRUSR>>6)
1372 #       define S_IWOTH (S_IWUSR>>6)
1373 #       define S_IXOTH (S_IXUSR>>6)
1374 #   else
1375 #       define S_IROTH 0040
1376 #       define S_IWOTH 0020
1377 #       define S_IXOTH 0010
1378 #   endif
1379 #endif
1380
1381 #ifndef S_ISUID
1382 #   define S_ISUID 04000
1383 #endif
1384
1385 #ifndef S_ISGID
1386 #   define S_ISGID 02000
1387 #endif
1388
1389 #ifndef S_IRWXU
1390 #   define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
1391 #endif
1392
1393 #ifndef S_IRWXG
1394 #   define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
1395 #endif
1396
1397 #ifndef S_IRWXO
1398 #   define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
1399 #endif
1400
1401 /* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
1402  * which would get included through <sys/file.h >, but that is 3000
1403  * lines in the future.  --jhi */
1404
1405 #if !defined(S_IREAD) && !defined(__HAIKU__)
1406 #   define S_IREAD S_IRUSR
1407 #endif
1408
1409 #if !defined(S_IWRITE) && !defined(__HAIKU__)
1410 #   define S_IWRITE S_IWUSR
1411 #endif
1412
1413 #ifndef S_IEXEC
1414 #   define S_IEXEC S_IXUSR
1415 #endif
1416
1417 #if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
1418 #   define SLOPPYDIVIDE
1419 #endif
1420
1421 #ifdef UV
1422 #undef UV
1423 #endif
1424
1425 /* This used to be conditionally defined based on whether we had a sprintf()
1426  * that correctly returns the string length (as required by C89), but we no
1427  * longer need that. XS modules can (and do) use this name, so it must remain
1428  * a part of the API that's visible to modules. But we no longer document it
1429  * either (because using sprintf() rather than snprintf() is almost always
1430  * a bad idea). */
1431 #define my_sprintf sprintf
1432
1433 /*
1434  * If we have v?snprintf() and the C99 variadic macros, we can just
1435  * use just the v?snprintf().  It is nice to try to trap the buffer
1436  * overflow, however, so if we are DEBUGGING, and we cannot use the
1437  * gcc statement expressions, then use the function wrappers which try
1438  * to trap the overflow.  If we can use the gcc statement expressions,
1439  * we can try that even with the version that uses the C99 variadic
1440  * macros.
1441  */
1442
1443 /* Note that we do not check against snprintf()/vsnprintf() returning
1444  * negative values because that is non-standard behaviour and we now
1445  * assume a working C89 implementation. */
1446
1447 #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
1448
1449 #ifdef USE_QUADMATH
1450 #  define my_snprintf Perl_my_snprintf
1451 #  define PERL_MY_SNPRINTF_GUARDED
1452 #elif defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1453 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1454 #      define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1455 #      define PERL_MY_SNPRINTF_GUARDED
1456 #  else
1457 #    define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
1458 #  endif
1459 #else
1460 #  define my_snprintf  Perl_my_snprintf
1461 #  define PERL_MY_SNPRINTF_GUARDED
1462 #endif
1463
1464 /* There is no quadmath_vsnprintf, and therefore my_vsnprintf()
1465  * dies if called under USE_QUADMATH. */
1466 #if defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1467 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1468 #      define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1469 #      define PERL_MY_VSNPRINTF_GUARDED
1470 #  else
1471 #    define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
1472 #  endif
1473 #else
1474 #  define my_vsnprintf Perl_my_vsnprintf
1475 #  define PERL_MY_VSNPRINTF_GUARDED
1476 #endif
1477
1478 /* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1479  * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1480  * the result of my_snprintf() or my_vsnprintf().  (No, you should not
1481  * completely ignore it: otherwise you cannot know whether your output
1482  * was too long.)
1483  *
1484  * int len = my_sprintf(buf, max, ...);
1485  * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1486  *
1487  * The trick is that in certain platforms [a] the my_sprintf() already
1488  * contains the sanity check, while in certain platforms [b] it needs
1489  * to be done as a separate step.  The POST_GUARD is that step-- in [a]
1490  * platforms the POST_GUARD actually does nothing since the check has
1491  * already been done.  Watch out for the max being the same in both calls.
1492  *
1493  * If you actually use the snprintf/vsnprintf return value already,
1494  * you assumedly are checking its validity somehow.  But you can
1495  * insert the POST_GUARD() also in that case. */
1496
1497 #ifndef PERL_MY_SNPRINTF_GUARDED
1498 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1499 #else
1500 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1501 #endif
1502
1503 #ifndef  PERL_MY_VSNPRINTF_GUARDED
1504 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
1505 #else
1506 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1507 #endif
1508
1509 #ifdef HAS_STRLCAT
1510 #  define my_strlcat    strlcat
1511 #else
1512 #  define my_strlcat    Perl_my_strlcat
1513 #endif
1514
1515 #ifdef HAS_STRLCPY
1516 #  define my_strlcpy    strlcpy
1517 #else
1518 #  define my_strlcpy    Perl_my_strlcpy
1519 #endif
1520
1521 /*
1522     The IV type is supposed to be long enough to hold any integral
1523     value or a pointer.
1524     --Andy Dougherty    August 1996
1525 */
1526
1527 typedef IVTYPE IV;
1528 typedef UVTYPE UV;
1529
1530 #if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
1531 #  if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
1532 #    define IV_MAX INT64_MAX
1533 #    define IV_MIN INT64_MIN
1534 #    define UV_MAX UINT64_MAX
1535 #    ifndef UINT64_MIN
1536 #      define UINT64_MIN 0
1537 #    endif
1538 #    define UV_MIN UINT64_MIN
1539 #  else
1540 #    define IV_MAX PERL_QUAD_MAX
1541 #    define IV_MIN PERL_QUAD_MIN
1542 #    define UV_MAX PERL_UQUAD_MAX
1543 #    define UV_MIN PERL_UQUAD_MIN
1544 #  endif
1545 #  define IV_IS_QUAD
1546 #  define UV_IS_QUAD
1547 #else
1548 #  if defined(INT32_MAX) && IVSIZE == 4
1549 #    define IV_MAX INT32_MAX
1550 #    define IV_MIN INT32_MIN
1551 #    ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
1552 #        define UV_MAX UINT32_MAX
1553 #    else
1554 #        define UV_MAX 4294967295U
1555 #    endif
1556 #    ifndef UINT32_MIN
1557 #      define UINT32_MIN 0
1558 #    endif
1559 #    define UV_MIN UINT32_MIN
1560 #  else
1561 #    define IV_MAX PERL_LONG_MAX
1562 #    define IV_MIN PERL_LONG_MIN
1563 #    define UV_MAX PERL_ULONG_MAX
1564 #    define UV_MIN PERL_ULONG_MIN
1565 #  endif
1566 #  if IVSIZE == 8
1567 #    define IV_IS_QUAD
1568 #    define UV_IS_QUAD
1569 #    ifndef HAS_QUAD
1570 #      define HAS_QUAD
1571 #    endif
1572 #  else
1573 #    undef IV_IS_QUAD
1574 #    undef UV_IS_QUAD
1575 #if !defined(PERL_CORE) || defined(USING_MSVC6)
1576 /* We think that removing this decade-old undef this will cause too much
1577    breakage on CPAN for too little gain. (See RT #119753)
1578    However, we do need HAS_QUAD in the core for use by the drand48 code,
1579    but not for Win32 VC6 because it has poor __int64 support. */
1580 #    undef HAS_QUAD
1581 #endif
1582 #  endif
1583 #endif
1584
1585 #define Size_t_MAX (~(Size_t)0)
1586 #define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
1587
1588 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
1589 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
1590
1591 #ifndef NO_PERL_PRESERVE_IVUV
1592 #define PERL_PRESERVE_IVUV      /* We like our integers to stay integers. */
1593 #endif
1594
1595 /*
1596  *  The macros INT2PTR and NUM2PTR are (despite their names)
1597  *  bi-directional: they will convert int/float to or from pointers.
1598  *  However the conversion to int/float are named explicitly:
1599  *  PTR2IV, PTR2UV, PTR2NV.
1600  *
1601  *  For int conversions we do not need two casts if pointers are
1602  *  the same size as IV and UV.   Otherwise we need an explicit
1603  *  cast (PTRV) to avoid compiler warnings.
1604  */
1605 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1606 #  define PTRV                  UV
1607 #  define INT2PTR(any,d)        (any)(d)
1608 #elif PTRSIZE == LONGSIZE
1609 #  define PTRV                  unsigned long
1610 #  define PTR2ul(p)             (unsigned long)(p)
1611 #else
1612 #  define PTRV                  unsigned
1613 #endif
1614
1615 #ifndef INT2PTR
1616 #  define INT2PTR(any,d)        (any)(PTRV)(d)
1617 #endif
1618
1619 #ifndef PTR2ul
1620 #  define PTR2ul(p)     INT2PTR(unsigned long,p)        
1621 #endif
1622
1623 #define NUM2PTR(any,d)  (any)(PTRV)(d)
1624 #define PTR2IV(p)       INT2PTR(IV,p)
1625 #define PTR2UV(p)       INT2PTR(UV,p)
1626 #define PTR2NV(p)       NUM2PTR(NV,p)
1627 #define PTR2nat(p)      (PTRV)(p)       /* pointer to integer of PTRSIZE */
1628
1629 /* According to strict ANSI C89 one cannot freely cast between
1630  * data pointers and function (code) pointers.  There are at least
1631  * two ways around this.  One (used below) is to do two casts,
1632  * first the other pointer to an (unsigned) integer, and then
1633  * the integer to the other pointer.  The other way would be
1634  * to use unions to "overlay" the pointers.  For an example of
1635  * the latter technique, see union dirpu in struct xpvio in sv.h.
1636  * The only feasible use is probably temporarily storing
1637  * function pointers in a data pointer (such as a void pointer). */
1638
1639 #define DPTR2FPTR(t,p) ((t)PTR2nat(p))  /* data pointer to function pointer */
1640 #define FPTR2DPTR(t,p) ((t)PTR2nat(p))  /* function pointer to data pointer */
1641
1642 #ifdef USE_LONG_DOUBLE
1643 #  if LONG_DOUBLESIZE == DOUBLESIZE
1644 #    define LONG_DOUBLE_EQUALS_DOUBLE
1645 #    undef USE_LONG_DOUBLE /* Ouch! */
1646 #  endif
1647 #endif
1648
1649 /* The following is all to get LDBL_DIG, in order to pick a nice
1650    default value for printing floating point numbers in Gconvert.
1651    (see config.h)
1652 */
1653 #ifndef HAS_LDBL_DIG
1654 #  if LONG_DOUBLESIZE == 10
1655 #    define LDBL_DIG 18 /* assume IEEE */
1656 #  elif LONG_DOUBLESIZE == 12
1657 #    define LDBL_DIG 18 /* gcc? */
1658 #  elif LONG_DOUBLESIZE == 16
1659 #    define LDBL_DIG 33 /* assume IEEE */
1660 #  elif LONG_DOUBLESIZE == DOUBLESIZE
1661 #    define LDBL_DIG DBL_DIG /* bummer */
1662 #  endif
1663 #endif
1664
1665 typedef NVTYPE NV;
1666
1667 #ifdef I_IEEEFP
1668 #   include <ieeefp.h>
1669 #endif
1670
1671 #ifdef USING_MSVC6
1672 /* VC6 has broken NaN semantics: NaN == NaN returns true instead of false,
1673  * and for example NaN < IV_MIN. */
1674 #  define NAN_COMPARE_BROKEN
1675 #endif
1676 #if defined(__DECC) && defined(__osf__)
1677 /* Also Tru64 cc has broken NaN comparisons. */
1678 #  define NAN_COMPARE_BROKEN
1679 #endif
1680 #if defined(__sgi)
1681 #  define NAN_COMPARE_BROKEN
1682 #endif
1683
1684 #ifdef USE_LONG_DOUBLE
1685 #   ifdef I_SUNMATH
1686 #       include <sunmath.h>
1687 #   endif
1688 #   if defined(LDBL_DIG)
1689 #       define NV_DIG LDBL_DIG
1690 #       ifdef LDBL_MANT_DIG
1691 #           define NV_MANT_DIG LDBL_MANT_DIG
1692 #       endif
1693 #       ifdef LDBL_MIN
1694 #           define NV_MIN LDBL_MIN
1695 #       endif
1696 #       ifdef LDBL_MAX
1697 #           define NV_MAX LDBL_MAX
1698 #       endif
1699 #       ifdef LDBL_MIN_EXP
1700 #           define NV_MIN_EXP LDBL_MIN_EXP
1701 #       endif
1702 #       ifdef LDBL_MAX_EXP
1703 #           define NV_MAX_EXP LDBL_MAX_EXP
1704 #       endif
1705 #       ifdef LDBL_MIN_10_EXP
1706 #           define NV_MIN_10_EXP LDBL_MIN_10_EXP
1707 #       endif
1708 #       ifdef LDBL_MAX_10_EXP
1709 #           define NV_MAX_10_EXP LDBL_MAX_10_EXP
1710 #       endif
1711 #       ifdef LDBL_EPSILON
1712 #           define NV_EPSILON LDBL_EPSILON
1713 #       endif
1714 #       ifdef LDBL_MAX
1715 #           define NV_MAX LDBL_MAX
1716 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
1717 #       elif defined(HUGE_VALL)
1718 #           define NV_MAX HUGE_VALL
1719 #       endif
1720 #   endif
1721 #   if defined(HAS_SQRTL)
1722 #       define Perl_acos acosl
1723 #       define Perl_asin asinl
1724 #       define Perl_atan atanl
1725 #       define Perl_atan2 atan2l
1726 #       define Perl_ceil ceill
1727 #       define Perl_cos cosl
1728 #       define Perl_cosh coshl
1729 #       define Perl_exp expl
1730 /* no Perl_fabs, but there's PERL_ABS */
1731 #       define Perl_floor floorl
1732 #       define Perl_fmod fmodl
1733 #       define Perl_log logl
1734 #       define Perl_log10 log10l
1735 #       define Perl_pow powl
1736 #       define Perl_sin sinl
1737 #       define Perl_sinh sinhl
1738 #       define Perl_sqrt sqrtl
1739 #       define Perl_tan tanl
1740 #       define Perl_tanh tanhl
1741 #   endif
1742 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
1743 #   ifndef Perl_modf
1744 #       ifdef HAS_MODFL
1745 #           define Perl_modf(x,y) modfl(x,y)
1746 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
1747    prototype in <math.h> */
1748 #           ifndef HAS_MODFL_PROTO
1749 EXTERN_C long double modfl(long double, long double *);
1750 #           endif
1751 #       elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
1752         extern long double Perl_my_modfl(long double x, long double *ip);
1753 #           define Perl_modf(x,y) Perl_my_modfl(x,y)
1754 #       endif
1755 #   endif
1756 #   ifndef Perl_frexp
1757 #       ifdef HAS_FREXPL
1758 #           define Perl_frexp(x,y) frexpl(x,y)
1759 #       elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
1760 extern long double Perl_my_frexpl(long double x, int *e);
1761 #           define Perl_frexp(x,y) Perl_my_frexpl(x,y)
1762 #       endif
1763 #   endif
1764 #   ifndef Perl_ldexp
1765 #       ifdef HAS_LDEXPL
1766 #           define Perl_ldexp(x, y) ldexpl(x,y)
1767 #       elif defined(HAS_SCALBNL) && FLT_RADIX == 2
1768 #           define Perl_ldexp(x,y) scalbnl(x,y)
1769 #       endif
1770 #   endif
1771 #   ifndef Perl_isnan
1772 #       if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
1773 #           define Perl_isnan(x) isnanl(x)
1774 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
1775 #           define Perl_isnan(x) isnan(x)
1776 #       endif
1777 #   endif
1778 #   ifndef Perl_isinf
1779 #       if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
1780 #           define Perl_isinf(x) isinfl(x)
1781 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
1782 #           define Perl_isinf(x) isinf(x)
1783 #       elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
1784 #           define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
1785 #       endif
1786 #   endif
1787 #   ifndef Perl_isfinite
1788 #       define Perl_isfinite(x) Perl_isfinitel(x)
1789 #   endif
1790 #elif defined(USE_QUADMATH) && defined(I_QUADMATH)
1791 #   include <quadmath.h>
1792 #   define NV_DIG FLT128_DIG
1793 #   define NV_MANT_DIG FLT128_MANT_DIG
1794 #   define NV_MIN FLT128_MIN
1795 #   define NV_MAX FLT128_MAX
1796 #   define NV_MIN_EXP FLT128_MIN_EXP
1797 #   define NV_MAX_EXP FLT128_MAX_EXP
1798 #   define NV_EPSILON FLT128_EPSILON
1799 #   define NV_MIN_10_EXP FLT128_MIN_10_EXP
1800 #   define NV_MAX_10_EXP FLT128_MAX_10_EXP
1801 #   define Perl_acos acosq
1802 #   define Perl_asin asinq
1803 #   define Perl_atan atanq
1804 #   define Perl_atan2 atan2q
1805 #   define Perl_ceil ceilq
1806 #   define Perl_cos cosq
1807 #   define Perl_cosh coshq
1808 #   define Perl_exp expq
1809 /* no Perl_fabs, but there's PERL_ABS */
1810 #   define Perl_floor floorq
1811 #   define Perl_fmod fmodq
1812 #   define Perl_log logq
1813 #   define Perl_log10 log10q
1814 #   define Perl_pow powq
1815 #   define Perl_sin sinq
1816 #   define Perl_sinh sinhq
1817 #   define Perl_sqrt sqrtq
1818 #   define Perl_tan tanq
1819 #   define Perl_tanh tanhq
1820 #   define Perl_modf(x,y) modfq(x,y)
1821 #   define Perl_frexp(x,y) frexpq(x,y)
1822 #   define Perl_ldexp(x, y) ldexpq(x,y)
1823 #   define Perl_isinf(x) isinfq(x)
1824 #   define Perl_isnan(x) isnanq(x)
1825 #   define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
1826 #   define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
1827 #   define Perl_fp_class_inf(x)    (Perl_fp_class(x) == 3)
1828 #   define Perl_fp_class_nan(x)    (Perl_fp_class(x) == 4)
1829 #   define Perl_fp_class_norm(x)   (Perl_fp_class(x) == 1)
1830 #   define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
1831 #   define Perl_fp_class_zero(x)   (Perl_fp_class(x) == 0)
1832 #else
1833 #   define NV_DIG DBL_DIG
1834 #   define NV_MANT_DIG DBL_MANT_DIG
1835 #   define NV_MIN DBL_MIN
1836 #   define NV_MAX DBL_MAX
1837 #   define NV_MIN_EXP DBL_MIN_EXP
1838 #   define NV_MAX_EXP DBL_MAX_EXP
1839 #   define NV_MIN_10_EXP DBL_MIN_10_EXP
1840 #   define NV_MAX_10_EXP DBL_MAX_10_EXP
1841 #   define NV_EPSILON DBL_EPSILON
1842 #   define NV_MAX DBL_MAX
1843 #   define NV_MIN DBL_MIN
1844
1845 /* These math interfaces are C89. */
1846 #   define Perl_acos acos
1847 #   define Perl_asin asin
1848 #   define Perl_atan atan
1849 #   define Perl_atan2 atan2
1850 #   define Perl_ceil ceil
1851 #   define Perl_cos cos
1852 #   define Perl_cosh cosh
1853 #   define Perl_exp exp
1854 /* no Perl_fabs, but there's PERL_ABS */
1855 #   define Perl_floor floor
1856 #   define Perl_fmod fmod
1857 #   define Perl_log log
1858 #   define Perl_log10 log10
1859 #   define Perl_pow pow
1860 #   define Perl_sin sin
1861 #   define Perl_sinh sinh
1862 #   define Perl_sqrt sqrt
1863 #   define Perl_tan tan
1864 #   define Perl_tanh tanh
1865
1866 #   define Perl_modf(x,y) modf(x,y)
1867 #   define Perl_frexp(x,y) frexp(x,y)
1868 #   define Perl_ldexp(x,y) ldexp(x,y)
1869
1870 #   ifndef Perl_isnan
1871 #       ifdef HAS_ISNAN
1872 #           define Perl_isnan(x) isnan(x)
1873 #       endif
1874 #   endif
1875 #   ifndef Perl_isinf
1876 #       if defined(HAS_ISINF)
1877 #           define Perl_isinf(x) isinf(x)
1878 #       elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
1879 #           define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
1880 #       endif
1881 #   endif
1882 #   ifndef Perl_isfinite
1883 #     ifdef HAS_ISFINITE
1884 #       define Perl_isfinite(x) isfinite(x)
1885 #     elif defined(HAS_FINITE)
1886 #       define Perl_isfinite(x) finite(x)
1887 #     endif
1888 #   endif
1889 #endif
1890
1891 /* fpclassify(): C99.  It is supposed to be a macro that switches on
1892 * the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
1893 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
1894 #    include <math.h>
1895 #    if defined(FP_INFINITE) && defined(FP_NAN)
1896 #        define Perl_fp_class(x)        fpclassify(x)
1897 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
1898 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
1899 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
1900 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
1901 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
1902 #    elif defined(FP_PLUS_INF) && defined(FP_QNAN)
1903 /* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
1904  * actually not the C99 fpclassify, with its own set of return defines. */
1905 #        define Perl_fp_class(x)        fpclassify(x)
1906 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PLUS_INF)
1907 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_MINUS_INF)
1908 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
1909 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
1910 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PLUS_NORM)
1911 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_MINUS_NORM)
1912 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PLUS_DENORM)
1913 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_MINUS_DENORM)
1914 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PLUS_ZERO)
1915 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_MINUS_ZERO)
1916 #    else
1917 #        undef Perl_fp_class /* Unknown set of defines */
1918 #    endif
1919 #endif
1920
1921 /* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
1922  * are identical to the C99 fpclassify(). */
1923 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
1924 #    include <math.h>
1925 #    ifdef __VMS
1926      /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
1927 #        include <fp.h>
1928      /* oh, and the isnormal macro has a typo in it! */
1929 #    undef isnormal
1930 #    define isnormal(x) Perl_fp_class_norm(x)
1931 #    endif
1932 #    if defined(FP_INFINITE) && defined(FP_NAN)
1933 #        define Perl_fp_class(x)        fp_classify(x)
1934 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
1935 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
1936 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
1937 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
1938 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
1939 #    else
1940 #        undef Perl_fp_class /* Unknown set of defines */
1941 #    endif
1942 #endif
1943
1944 /* Feel free to check with me for the SGI manpages, SGI testing,
1945  * etcetera, if you want to try getting this to work with IRIX.
1946  *
1947  * - Allen <allens@cpan.org> */
1948
1949 /* fpclass(): SysV, at least Solaris and some versions of IRIX. */
1950 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
1951 /* Solaris and IRIX have fpclass/fpclassl, but they are using
1952  * an enum typedef, not cpp symbols, and Configure doesn't detect that.
1953  * Define some symbols also as cpp symbols so we can detect them. */
1954 #    if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
1955 #     define FP_PINF FP_PINF
1956 #     define FP_QNAN FP_QNAN
1957 #    endif
1958 #    include <math.h>
1959 #    ifdef I_IEEFP
1960 #        include <ieeefp.h>
1961 #    endif
1962 #    ifdef I_FP
1963 #        include <fp.h>
1964 #    endif
1965 #    if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
1966 #        define Perl_fp_class(x)        fpclassl(x)
1967 #    else
1968 #        define Perl_fp_class(x)        fpclass(x)
1969 #    endif
1970 #    if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
1971 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_CLASS_SNAN)
1972 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_CLASS_QNAN)
1973 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_CLASS_NINF)
1974 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_CLASS_PINF)
1975 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_CLASS_NNORM)
1976 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_CLASS_PNORM)
1977 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_CLASS_NDENORM)
1978 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_CLASS_PDENORM)
1979 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_CLASS_NZERO)
1980 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_CLASS_PZERO)
1981 #    elif defined(FP_PINF) && defined(FP_QNAN)
1982 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
1983 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
1984 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_NINF)
1985 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PINF)
1986 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_NNORM)
1987 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PNORM)
1988 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_NDENORM)
1989 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PDENORM)
1990 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_NZERO)
1991 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PZERO)
1992 #    else
1993 #        undef Perl_fp_class /* Unknown set of defines */
1994 #    endif
1995 #endif
1996
1997 /* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
1998 #if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
1999 #    include <math.h>
2000 #    if !defined(FP_SNAN) && defined(I_FP_CLASS)
2001 #        include <fp_class.h>
2002 #    endif
2003 #    if defined(FP_POS_INF) && defined(FP_QNAN)
2004 #        ifdef __sgi /* XXX Configure test instead */
2005 #            ifdef USE_LONG_DOUBLE
2006 #                define Perl_fp_class(x)        fp_class_l(x)
2007 #            else
2008 #                define Perl_fp_class(x)        fp_class_d(x)
2009 #            endif
2010 #        else
2011 #            if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2012 #                define Perl_fp_class(x)        fp_classl(x)
2013 #            else
2014 #                define Perl_fp_class(x)        fp_class(x)
2015 #            endif
2016 #        endif
2017 #        if defined(FP_POS_INF) && defined(FP_QNAN)
2018 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_SNAN)
2019 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_QNAN)
2020 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_NEG_INF)
2021 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_POS_INF)
2022 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_NEG_NORM)
2023 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_POS_NORM)
2024 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_NEG_DENORM)
2025 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_POS_DENORM)
2026 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_NEG_ZERO)
2027 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_POS_ZERO)
2028 #        else
2029 #            undef Perl_fp_class /* Unknown set of defines */
2030 #        endif
2031 #    endif
2032 #endif
2033
2034 /* class(), _class(): Legacy: AIX. */
2035 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2036 #    include <math.h>
2037 #    if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2038 #        ifndef _cplusplus
2039 #            define Perl_fp_class(x)    class(x)
2040 #        else
2041 #            define Perl_fp_class(x)    _class(x)
2042 #        endif
2043 #        if defined(FP_PLUS_INF) && defined(FP_NANQ)
2044 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_NANS)
2045 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_NANQ)
2046 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_MINUS_INF)
2047 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_PLUS_INF)
2048 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_MINUS_NORM)
2049 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_PLUS_NORM)
2050 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_MINUS_DENORM)
2051 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_PLUS_DENORM)
2052 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_MINUS_ZERO)
2053 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_PLUS_ZERO)
2054 #        else
2055 #            undef Perl_fp_class /* Unknown set of defines */
2056 #        endif
2057 #    endif
2058 #endif
2059
2060 /* Win32: _fpclass(), _isnan(), _finite(). */
2061 #ifdef WIN32
2062 #  ifndef Perl_isnan
2063 #    define Perl_isnan(x) _isnan(x)
2064 #  endif
2065 #  ifndef Perl_isfinite
2066 #    define Perl_isfinite(x) _finite(x)
2067 #  endif
2068 #  ifndef Perl_fp_class_snan
2069 /* No simple way to #define Perl_fp_class because _fpclass()
2070  * returns a set of bits. */
2071 #    define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2072 #    define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
2073 #    define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
2074 #    define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF))
2075 #    define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF))
2076 #    define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2077 #    define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2078 #    define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2079 #    define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2080 #    define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2081 #    define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2082 #    define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2083 #    define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2084 #    define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2085 #    define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2086 #  endif
2087 #endif
2088
2089 #if !defined(Perl_fp_class_inf) && \
2090   defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2091 #  define Perl_fp_class_inf(x) \
2092     (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2093 #endif
2094
2095 #if !defined(Perl_fp_class_nan) && \
2096   defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2097 #  define Perl_fp_class_nan(x) \
2098     (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2099 #endif
2100
2101 #if !defined(Perl_fp_class_zero) && \
2102   defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2103 #  define Perl_fp_class_zero(x) \
2104     (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2105 #endif
2106
2107 #if !defined(Perl_fp_class_norm) && \
2108   defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2109 #  define Perl_fp_class_norm(x) \
2110     (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2111 #endif
2112
2113 #if !defined(Perl_fp_class_denorm) && \
2114   defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2115 #  define Perl_fp_class_denorm(x) \
2116     (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
2117 #endif
2118
2119 #ifdef UNDER_CE
2120 int isnan(double d);
2121 #endif
2122
2123 #ifndef Perl_isnan
2124 #   ifdef Perl_fp_class_nan
2125 #       define Perl_isnan(x) Perl_fp_class_nan(x)
2126 #   elif defined(HAS_UNORDERED)
2127 #       define Perl_isnan(x) unordered((x), 0.0)
2128 #   else
2129 #       define Perl_isnan(x) ((x)!=(x))
2130 #   endif
2131 #endif
2132
2133 #ifndef Perl_isinf
2134 #   ifdef Perl_fp_class_inf
2135 #       define Perl_isinf(x) Perl_fp_class_inf(x)
2136 #   endif
2137 #endif
2138
2139 #ifndef Perl_isfinite
2140 #   if defined(HAS_ISFINITE) && !defined(isfinite)
2141 #     define Perl_isfinite(x) isfinite((double)(x))
2142 #   elif defined(HAS_FINITE)
2143 #       define Perl_isfinite(x) finite((double)(x))
2144 #   elif defined(Perl_fp_class_finite)
2145 #     define Perl_isfinite(x) Perl_fp_class_finite(x)
2146 #   else
2147 /* For the infinities the multiplication returns nan,
2148  * for the nan the multiplication also returns nan,
2149  * for everything else (that is, finite) zero should be returned. */
2150 #     define Perl_isfinite(x) (((x) * 0) == 0)
2151 #   endif
2152 #endif
2153
2154 #ifndef Perl_isinf
2155 #   if defined(Perl_isfinite) && defined(Perl_isnan)
2156 #       define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2157 #   endif
2158 #endif
2159
2160 /* We need Perl_isfinitel (ends with ell) (if available) even when
2161  * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2162  * needs that. */
2163 #if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2164 /* If isfinite() is a macro and looks like we have C99,
2165  * we assume it's the type-aware C99 isfinite(). */
2166 #    if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
2167 #        define Perl_isfinitel(x) isfinite(x)
2168 #    elif defined(HAS_ISFINITEL)
2169 #        define Perl_isfinitel(x) isfinitel(x)
2170 #    elif defined(HAS_FINITEL)
2171 #        define Perl_isfinitel(x) finitel(x)
2172 #    elif defined(HAS_INFL) && defined(HAS_NANL)
2173 #        define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
2174 #    else
2175 #        define Perl_isfinitel(x) ((x) * 0 == 0)  /* See Perl_isfinite. */
2176 #    endif
2177 #endif
2178
2179 /* The default is to use Perl's own atof() implementation (in numeric.c).
2180  * Usually that is the one to use but for some platforms (e.g. UNICOS)
2181  * it is however best to use the native implementation of atof.
2182  * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2183  * Some good tests to try out with either setting are t/base/num.t,
2184  * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2185  * you may need to be using a different function than atof! */
2186
2187 #ifndef USE_PERL_ATOF
2188 #   ifndef _UNICOS
2189 #       define USE_PERL_ATOF
2190 #   endif
2191 #else
2192 #   if USE_PERL_ATOF == 0
2193 #       undef USE_PERL_ATOF
2194 #   endif
2195 #endif
2196
2197 #ifdef USE_PERL_ATOF
2198 #   define Perl_atof(s) Perl_my_atof(s)
2199 #   define Perl_atof2(s, n) Perl_my_atof2(aTHX_ (s), &(n))
2200 #else
2201 #   define Perl_atof(s) (NV)atof(s)
2202 #   define Perl_atof2(s, n) ((n) = atof(s))
2203 #endif
2204
2205 /*
2206  * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2207  * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2208  * depending on local options. Until Configure detects this (or at least
2209  * detects whether the "signed" keyword is available) the CHAR ranges
2210  * will not be included. UCHAR functions normally.
2211  *                                                           - kja
2212  */
2213
2214 #define PERL_UCHAR_MIN ((unsigned char)0)
2215 #define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2216
2217 #define PERL_USHORT_MIN ((unsigned short)0)
2218 #define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2219
2220 #define PERL_SHORT_MAX ((short)SHRT_MAX)
2221 #define PERL_SHORT_MIN ((short)SHRT_MIN)
2222
2223 #define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2224 #define PERL_UINT_MIN ((unsigned int)0)
2225
2226 #define PERL_INT_MAX ((int)INT_MAX)
2227 #define PERL_INT_MIN ((int)INT_MIN)
2228
2229 #define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2230 #define PERL_ULONG_MIN ((unsigned long)0L)
2231
2232 #define PERL_LONG_MAX ((long)LONG_MAX)
2233 #define PERL_LONG_MIN ((long)LONG_MIN)
2234
2235 #ifdef UV_IS_QUAD
2236 #    define PERL_UQUAD_MAX      (~(UV)0)
2237 #    define PERL_UQUAD_MIN      ((UV)0)
2238 #    define PERL_QUAD_MAX       ((IV) (PERL_UQUAD_MAX >> 1))
2239 #    define PERL_QUAD_MIN       (-PERL_QUAD_MAX - ((3 & -1) == 3))
2240 #endif
2241
2242 typedef MEM_SIZE STRLEN;
2243
2244 typedef struct op OP;
2245 typedef struct cop COP;
2246 typedef struct unop UNOP;
2247 typedef struct unop_aux UNOP_AUX;
2248 typedef struct binop BINOP;
2249 typedef struct listop LISTOP;
2250 typedef struct logop LOGOP;
2251 typedef struct pmop PMOP;
2252 typedef struct svop SVOP;
2253 typedef struct padop PADOP;
2254 typedef struct pvop PVOP;
2255 typedef struct loop LOOP;
2256 typedef struct methop METHOP;
2257
2258 #ifdef PERL_CORE
2259 typedef struct opslab OPSLAB;
2260 typedef struct opslot OPSLOT;
2261 #endif
2262
2263 typedef struct block_hooks BHK;
2264 typedef struct custom_op XOP;
2265
2266 typedef struct interpreter PerlInterpreter;
2267
2268 /* SGI's <sys/sema.h> has struct sv */
2269 #if defined(__sgi)
2270 #   define STRUCT_SV perl_sv
2271 #else
2272 #   define STRUCT_SV sv
2273 #endif
2274 typedef struct STRUCT_SV SV;
2275 typedef struct av AV;
2276 typedef struct hv HV;
2277 typedef struct cv CV;
2278 typedef struct p5rx REGEXP;
2279 typedef struct gp GP;
2280 typedef struct gv GV;
2281 typedef struct io IO;
2282 typedef struct context PERL_CONTEXT;
2283 typedef struct block BLOCK;
2284
2285 typedef struct magic MAGIC;
2286 typedef struct xpv XPV;
2287 typedef struct xpviv XPVIV;
2288 typedef struct xpvuv XPVUV;
2289 typedef struct xpvnv XPVNV;
2290 typedef struct xpvmg XPVMG;
2291 typedef struct xpvlv XPVLV;
2292 typedef struct xpvinvlist XINVLIST;
2293 typedef struct xpvav XPVAV;
2294 typedef struct xpvhv XPVHV;
2295 typedef struct xpvgv XPVGV;
2296 typedef struct xpvcv XPVCV;
2297 typedef struct xpvbm XPVBM;
2298 typedef struct xpvfm XPVFM;
2299 typedef struct xpvio XPVIO;
2300 typedef struct mgvtbl MGVTBL;
2301 typedef union any ANY;
2302 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2303 typedef struct ptr_tbl PTR_TBL_t;
2304 typedef struct clone_params CLONE_PARAMS;
2305
2306 /* a pad is currently just an AV; but that might change,
2307  * so hide the type.  */
2308 typedef struct padlist PADLIST;
2309 typedef AV PAD;
2310 typedef struct padnamelist PADNAMELIST;
2311 typedef struct padname PADNAME;
2312
2313 /* enable PERL_OP_PARENT by default */
2314 #if !defined(PERL_OP_PARENT) && !defined(PERL_NO_OP_PARENT)
2315 #  define PERL_OP_PARENT
2316 #endif
2317
2318 /* enable PERL_COPY_ON_WRITE by default */
2319 #if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2320 #  define PERL_COPY_ON_WRITE
2321 #endif
2322
2323 #ifdef PERL_COPY_ON_WRITE
2324 #  define PERL_ANY_COW
2325 #else
2326 # define PERL_SAWAMPERSAND
2327 #endif
2328
2329 #if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2330 # error PERL_DEBUG_READONLY_OPS only works with ithreads
2331 #endif
2332
2333 #include "handy.h"
2334 #include "charclass_invlists.h"
2335
2336 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2337 #   if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2338 #       define USE_64_BIT_RAWIO /* implicit */
2339 #   endif
2340 #endif
2341
2342 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2343  * fseeko/ftello if possible.  Don't go #defining ftell to ftello yourself,
2344  * however, because operating systems like to do that themself. */
2345 #ifndef FSEEKSIZE
2346 #   ifdef HAS_FSEEKO
2347 #       define FSEEKSIZE LSEEKSIZE
2348 #   else
2349 #       define FSEEKSIZE LONGSIZE
2350 #   endif
2351 #endif
2352
2353 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2354 #   if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2355 #       define USE_64_BIT_STDIO /* implicit */
2356 #   endif
2357 #endif
2358
2359 #ifdef USE_64_BIT_RAWIO
2360 #   ifdef HAS_OFF64_T
2361 #       undef Off_t
2362 #       define Off_t off64_t
2363 #       undef LSEEKSIZE
2364 #       define LSEEKSIZE 8
2365 #   endif
2366 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2367  * will trigger defines like the ones below.  Some 64-bit environments,
2368  * however, do not.  Therefore we have to explicitly mix and match. */
2369 #   if defined(USE_OPEN64)
2370 #       define open open64
2371 #   endif
2372 #   if defined(USE_LSEEK64)
2373 #       define lseek lseek64
2374 #   else
2375 #       if defined(USE_LLSEEK)
2376 #           define lseek llseek
2377 #       endif
2378 #   endif
2379 #   if defined(USE_STAT64)
2380 #       define stat stat64
2381 #   endif
2382 #   if defined(USE_FSTAT64)
2383 #       define fstat fstat64
2384 #   endif
2385 #   if defined(USE_LSTAT64)
2386 #       define lstat lstat64
2387 #   endif
2388 #   if defined(USE_FLOCK64)
2389 #       define flock flock64
2390 #   endif
2391 #   if defined(USE_LOCKF64)
2392 #       define lockf lockf64
2393 #   endif
2394 #   if defined(USE_FCNTL64)
2395 #       define fcntl fcntl64
2396 #   endif
2397 #   if defined(USE_TRUNCATE64)
2398 #       define truncate truncate64
2399 #   endif
2400 #   if defined(USE_FTRUNCATE64)
2401 #       define ftruncate ftruncate64
2402 #   endif
2403 #endif
2404
2405 #ifdef USE_64_BIT_STDIO
2406 #   ifdef HAS_FPOS64_T
2407 #       undef Fpos_t
2408 #       define Fpos_t fpos64_t
2409 #   endif
2410 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2411  * will trigger defines like the ones below.  Some 64-bit environments,
2412  * however, do not. */
2413 #   if defined(USE_FOPEN64)
2414 #       define fopen fopen64
2415 #   endif
2416 #   if defined(USE_FSEEK64)
2417 #       define fseek fseek64 /* don't do fseeko here, see perlio.c */
2418 #   endif
2419 #   if defined(USE_FTELL64)
2420 #       define ftell ftell64 /* don't do ftello here, see perlio.c */
2421 #   endif
2422 #   if defined(USE_FSETPOS64)
2423 #       define fsetpos fsetpos64
2424 #   endif
2425 #   if defined(USE_FGETPOS64)
2426 #       define fgetpos fgetpos64
2427 #   endif
2428 #   if defined(USE_TMPFILE64)
2429 #       define tmpfile tmpfile64
2430 #   endif
2431 #   if defined(USE_FREOPEN64)
2432 #       define freopen freopen64
2433 #   endif
2434 #endif
2435
2436 #if defined(OS2)
2437 #  include "iperlsys.h"
2438 #endif
2439
2440 #ifdef DOSISH
2441 #   if defined(OS2)
2442 #       include "os2ish.h"
2443 #   else
2444 #       include "dosish.h"
2445 #   endif
2446 #elif defined(VMS)
2447 #   include "vmsish.h"
2448 #elif defined(PLAN9)
2449 #   include "./plan9/plan9ish.h"
2450 #elif defined(__VOS__)
2451 #   ifdef __GNUC__
2452 #     include "./vos/vosish.h"
2453 #   else
2454 #     include "vos/vosish.h"
2455 #   endif
2456 #elif defined(__SYMBIAN32__)
2457 #   include "symbian/symbianish.h"
2458 #elif defined(__HAIKU__)
2459 #   include "haiku/haikuish.h"
2460 #else
2461 #   include "unixish.h"
2462 #endif
2463
2464 #ifdef __amigaos4__
2465 #    include "amigaos.h"
2466 #    undef FD_CLOEXEC /* a lie in AmigaOS */
2467 #endif
2468
2469 /* NSIG logic from Configure --> */
2470 #ifndef NSIG
2471 #  ifdef _NSIG
2472 #    define NSIG (_NSIG)
2473 #  elif defined(SIGMAX)
2474 #    define NSIG (SIGMAX+1)
2475 #  elif defined(SIG_MAX)
2476 #    define NSIG (SIG_MAX+1)
2477 #  elif defined(_SIG_MAX)
2478 #    define NSIG (_SIG_MAX+1)
2479 #  elif defined(MAXSIG)
2480 #    define NSIG (MAXSIG+1)
2481 #  elif defined(MAX_SIG)
2482 #    define NSIG (MAX_SIG+1)
2483 #  elif defined(SIGARRAYSIZE)
2484 #    define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
2485 #  elif defined(_sys_nsig)
2486 #    define NSIG (_sys_nsig) /* Solaris 2.5 */
2487 #  else
2488      /* Default to some arbitrary number that's big enough to get most
2489       * of the common signals.  */
2490 #    define NSIG 50
2491 #  endif
2492 #endif
2493 /* <-- NSIG logic from Configure */
2494
2495 #ifndef NO_ENVIRON_ARRAY
2496 #  define USE_ENVIRON_ARRAY
2497 #endif
2498
2499 /*
2500  * initialise to avoid floating-point exceptions from overflow, etc
2501  */
2502 #ifndef PERL_FPU_INIT
2503 #  ifdef HAS_FPSETMASK
2504 #    if HAS_FLOATINGPOINT_H
2505 #      include <floatingpoint.h>
2506 #    endif
2507 /* Some operating systems have this as a macro, which in turn expands to a comma
2508    expression, and the last sub-expression is something that gets calculated,
2509    and then they have the gall to warn that a value computed is not used. Hence
2510    cast to void.  */
2511 #    define PERL_FPU_INIT (void)fpsetmask(0)
2512 #  elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2513 #    define PERL_FPU_INIT       PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2514 #    define PERL_FPU_PRE_EXEC   { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2515 #    define PERL_FPU_POST_EXEC    rsignal_restore(SIGFPE, &xfpe); }
2516 #  else
2517 #    define PERL_FPU_INIT
2518 #  endif
2519 #endif
2520 #ifndef PERL_FPU_PRE_EXEC
2521 #  define PERL_FPU_PRE_EXEC   {
2522 #  define PERL_FPU_POST_EXEC  }
2523 #endif
2524
2525 /* In Tru64 the cc -ieee enables the IEEE math but disables traps.
2526  * We need to reenable the "invalid" trap because otherwise generation
2527  * of NaN values leaves the IEEE fp flags in bad state, leaving any further
2528  * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
2529 #ifdef __osf__
2530 #  include <machine/fpu.h>
2531 #  define PERL_SYS_FPU_INIT \
2532      STMT_START { \
2533          ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
2534          signal(SIGFPE, SIG_IGN); \
2535      } STMT_END
2536 #endif
2537 /* In IRIX the default for Flush to Zero bit is true,
2538  * which means that results going below the minimum of normal
2539  * floating points go to zero, instead of going denormal/subnormal.
2540  * This is unlike almost any other system running Perl, so let's clear it.
2541  * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
2542  * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
2543  *
2544  * XXX The flush-to-zero behaviour should be a Configure scan.
2545  * To change the behaviour usually requires some system-specific
2546  * incantation, though, like the below. */
2547 #ifdef __sgi
2548 #  include <sys/fpu.h>
2549 #  define PERL_SYS_FPU_INIT \
2550      STMT_START { \
2551          union fpc_csr csr; \
2552          csr.fc_word = get_fpc_csr(); \
2553          csr.fc_struct.flush = 0; \
2554          set_fpc_csr(csr.fc_word); \
2555      } STMT_END
2556 #endif
2557
2558 #ifndef PERL_SYS_FPU_INIT
2559 #  define PERL_SYS_FPU_INIT NOOP
2560 #endif
2561
2562 #ifndef PERL_SYS_INIT3_BODY
2563 #  define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
2564 #endif
2565
2566 /*
2567 =head1 Miscellaneous Functions
2568
2569 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
2570 Provides system-specific tune up of the C runtime environment necessary to
2571 run Perl interpreters.  This should be called only once, before creating
2572 any Perl interpreters.
2573
2574 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
2575 Provides system-specific tune up of the C runtime environment necessary to
2576 run Perl interpreters.  This should be called only once, before creating
2577 any Perl interpreters.
2578
2579 =for apidoc Am|void|PERL_SYS_TERM|
2580 Provides system-specific clean up of the C runtime environment after
2581 running Perl interpreters.  This should be called only once, after
2582 freeing any remaining Perl interpreters.
2583
2584 =cut
2585  */
2586
2587 #define PERL_SYS_INIT(argc, argv)       Perl_sys_init(argc, argv)
2588 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
2589 #define PERL_SYS_TERM()                 Perl_sys_term()
2590
2591 #ifndef PERL_WRITE_MSG_TO_CONSOLE
2592 #  define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
2593 #endif
2594
2595 #ifndef MAXPATHLEN
2596 #  ifdef PATH_MAX
2597 #    ifdef _POSIX_PATH_MAX
2598 #       if PATH_MAX > _POSIX_PATH_MAX
2599 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
2600  * included the null byte or not.  Later amendments of POSIX,
2601  * XPG4, the Austin Group, and the Single UNIX Specification
2602  * all explicitly include the null byte in the PATH_MAX.
2603  * Ditto for _POSIX_PATH_MAX. */
2604 #         define MAXPATHLEN PATH_MAX
2605 #       else
2606 #         define MAXPATHLEN _POSIX_PATH_MAX
2607 #       endif
2608 #    else
2609 #      define MAXPATHLEN (PATH_MAX+1)
2610 #    endif
2611 #  else
2612 #    define MAXPATHLEN 1024     /* Err on the large side. */
2613 #  endif
2614 #endif
2615
2616 /* In case Configure was not used (we are using a "canned config"
2617  * such as Win32, or a cross-compilation setup, for example) try going
2618  * by the gcc major and minor versions.  One useful URL is
2619  * http://www.ohse.de/uwe/articles/gcc-attributes.html,
2620  * but contrary to this information warn_unused_result seems
2621  * not to be in gcc 3.3.5, at least. --jhi
2622  * Also, when building extensions with an installed perl, this allows
2623  * the user to upgrade gcc and get the right attributes, rather than
2624  * relying on the list generated at Configure time.  --AD
2625  * Set these up now otherwise we get confused when some of the <*thread.h>
2626  * includes below indirectly pull in <perlio.h> (which needs to know if we
2627  * have HASATTRIBUTE_FORMAT).
2628  */
2629
2630 #ifndef PERL_MICRO
2631 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
2632 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
2633 #    define HASATTRIBUTE_DEPRECATED
2634 #  endif
2635 #  if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
2636 #    define HASATTRIBUTE_FORMAT
2637 #    if defined __MINGW32__
2638 #      define PRINTF_FORMAT_NULL_OK
2639 #    endif
2640 #  endif
2641 #  if __GNUC__ >= 3 /* 3.0 -> */
2642 #    define HASATTRIBUTE_MALLOC
2643 #  endif
2644 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
2645 #    define HASATTRIBUTE_NONNULL
2646 #  endif
2647 #  if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
2648 #    define HASATTRIBUTE_NORETURN
2649 #  endif
2650 #  if __GNUC__ >= 3 /* gcc 3.0 -> */
2651 #    define HASATTRIBUTE_PURE
2652 #  endif
2653 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2654 #    define HASATTRIBUTE_UNUSED
2655 #  endif
2656 #  if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
2657 #    define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
2658 #  endif
2659 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2660 #    define HASATTRIBUTE_WARN_UNUSED_RESULT
2661 #  endif
2662 #endif
2663 #endif /* #ifndef PERL_MICRO */
2664
2665 /* USE_5005THREADS needs to be after unixish.h as <pthread.h> includes
2666  * <sys/signal.h> which defines NSIG - which will stop inclusion of <signal.h>
2667  * this results in many functions being undeclared which bothers C++
2668  * May make sense to have threads after "*ish.h" anyway
2669  */
2670
2671 /* clang Thread Safety Analysis/Annotations/Attributes
2672  * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
2673  *
2674  * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
2675  * Apple XCode hijacks __clang_major__ and __clang_minor__
2676  * (6.1 means really clang 3.6), so needs extra hijinks
2677  * (could probably also test the contents of __apple_build_version__).
2678  */
2679 #if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
2680     defined(__clang__) && \
2681     !defined(PERL_GLOBAL_STRUCT) && \
2682     !defined(PERL_GLOBAL_STRUCT_PRIVATE) && \
2683     !defined(SWIG) && \
2684   ((!defined(__apple_build_version__) &&               \
2685     ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
2686      (__clang_major__ >= 4))) || \
2687    (defined(__apple_build_version__) &&                \
2688     ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
2689      (__clang_major__ >= 7))))
2690 #  define PERL_TSA__(x)   __attribute__((x))
2691 #  define PERL_TSA_ACTIVE
2692 #else
2693 #  define PERL_TSA__(x)   /* No TSA, make TSA attributes no-ops. */
2694 #  undef PERL_TSA_ACTIVE
2695 #endif
2696
2697 /* PERL_TSA_CAPABILITY() is used to annotate typedefs.
2698  * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
2699  */
2700 #define PERL_TSA_CAPABILITY(x) \
2701     PERL_TSA__(capability(x))
2702
2703 /* In the below examples the mutex must be lexically visible, usually
2704  * either as global variables, or as function arguments. */
2705
2706 /* PERL_TSA_GUARDED_BY() is used to annotate global variables.
2707  *
2708  * Foo foo PERL_TSA_GUARDED_BY(mutex);
2709  */
2710 #define PERL_TSA_GUARDED_BY(x) \
2711     PERL_TSA__(guarded_by(x))
2712
2713 /* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
2714  * The data _behind_ the pointer is guarded.
2715  *
2716  * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
2717  */
2718 #define PERL_TSA_PT_GUARDED_BY(x) \
2719     PERL_TSA__(pt_guarded_by(x))
2720
2721 /* PERL_TSA_REQUIRES() is used to annotate functions.
2722  * The caller MUST hold the resource when calling the function.
2723  *
2724  * void Foo() PERL_TSA_REQUIRES(mutex);
2725  */
2726 #define PERL_TSA_REQUIRES(x) \
2727     PERL_TSA__(requires_capability(x))
2728
2729 /* PERL_TSA_EXCLUDES() is used to annotate functions.
2730  * The caller MUST NOT hold resource when calling the function.
2731  *
2732  * EXCLUDES should be used when the function first acquires
2733  * the resource and then releases it.  Use to avoid deadlock.
2734  *
2735  * void Foo() PERL_TSA_EXCLUDES(mutex);
2736  */
2737 #define PERL_TSA_EXCLUDES(x) \
2738     PERL_TSA__(locks_excluded(x))
2739
2740 /* PERL_TSA_ACQUIRE() is used to annotate functions.
2741  * The caller MUST NOT hold the resource when calling the function,
2742  * and the function will acquire the resource.
2743  *
2744  * void Foo() PERL_TSA_ACQUIRE(mutex);
2745  */
2746 #define PERL_TSA_ACQUIRE(x) \
2747     PERL_TSA__(acquire_capability(x))
2748
2749 /* PERL_TSA_RELEASE() is used to annotate functions.
2750  * The caller MUST hold the resource when calling the function,
2751  * and the function will release the resource.
2752  *
2753  * void Foo() PERL_TSA_RELEASE(mutex);
2754  */
2755 #define PERL_TSA_RELEASE(x) \
2756     PERL_TSA__(release_capability(x))
2757
2758 /* PERL_TSA_NO_TSA is used to annotate functions.
2759  * Used when being intentionally unsafe, or when the code is too
2760  * complicated for the analysis.  Use sparingly.
2761  *
2762  * void Foo() PERL_TSA_NO_TSA;
2763  */
2764 #define PERL_TSA_NO_TSA \
2765     PERL_TSA__(no_thread_safety_analysis)
2766
2767 /* There are more annotations/attributes available, see the clang
2768  * documentation for details. */
2769
2770 #if defined(USE_ITHREADS)
2771 #  ifdef NETWARE
2772 #    include <nw5thread.h>
2773 #  elif defined(WIN32)
2774 #    include <win32thread.h>
2775 #  elif defined(OS2)
2776 #    include "os2thread.h"
2777 #  elif defined(I_MACH_CTHREADS)
2778 #    include <mach/cthreads.h>
2779 typedef cthread_t       perl_os_thread;
2780 typedef mutex_t         perl_mutex;
2781 typedef condition_t     perl_cond;
2782 typedef void *          perl_key;
2783 #  elif defined(I_PTHREAD) /* Posix threads */
2784 #    include <pthread.h>
2785 typedef pthread_t       perl_os_thread;
2786 typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
2787 typedef pthread_cond_t  perl_cond;
2788 typedef pthread_key_t   perl_key;
2789 #  endif
2790 #endif /* USE_ITHREADS */
2791
2792 #ifdef PERL_TSA_ACTIVE
2793 /* Since most pthread mutex interfaces have not been annotated, we
2794  * need to have these wrappers. The NO_TSA annotation is quite ugly
2795  * but it cannot be avoided in plain C, unlike in C++, where one could
2796  * e.g. use ACQUIRE() with no arg on a mutex lock method.
2797  *
2798  * The bodies of these wrappers are in util.c
2799  *
2800  * TODO: however, some platforms are starting to get these clang
2801  * thread safety annotations for pthreads, for example FreeBSD.
2802  * Do we need a way to a bypass these wrappers? */
2803 EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
2804   PERL_TSA_ACQUIRE(*mutex)
2805   PERL_TSA_NO_TSA;
2806 EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
2807   PERL_TSA_RELEASE(*mutex)
2808   PERL_TSA_NO_TSA;
2809 #endif
2810
2811 #if defined(WIN32)
2812 #  include "win32.h"
2813 #endif
2814
2815 #ifdef NETWARE
2816 #  include "netware.h"
2817 #endif
2818
2819 #define STATUS_UNIX     PL_statusvalue
2820 #ifdef VMS
2821 #   define STATUS_NATIVE        PL_statusvalue_vms
2822 /*
2823  * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
2824  * its contents can not be trusted.  Unfortunately, Perl seems to check
2825  * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
2826  * be updated also.
2827  */
2828 #  include <stsdef.h>
2829 #  include <ssdef.h>
2830 /* Presume this because if VMS changes it, it will require a new
2831  * set of APIs for waiting on children for binary compatibility.
2832  */
2833 #  define child_offset_bits (8)
2834 #  ifndef C_FAC_POSIX
2835 #  define C_FAC_POSIX 0x35A000
2836 #  endif
2837
2838 /*  STATUS_EXIT - validates and returns a NATIVE exit status code for the
2839  * platform from the existing UNIX or Native status values.
2840  */
2841
2842 #   define STATUS_EXIT \
2843         (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
2844            (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
2845
2846
2847 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
2848  * exit code and shifts the UNIX value over the correct number of bits to
2849  * be a child status.  Usually the number of bits is 8, but that could be
2850  * platform dependent.  The NATIVE status code is presumed to have either
2851  * from a child process.
2852  */
2853
2854 /* This is complicated.  The child processes return a true native VMS
2855    status which must be saved.  But there is an assumption in Perl that
2856    the UNIX child status has some relationship to errno values, so
2857    Perl tries to translate it to text in some of the tests.
2858    In order to get the string translation correct, for the error, errno
2859    must be EVMSERR, but that generates a different text message
2860    than what the test programs are expecting.  So an errno value must
2861    be derived from the native status value when an error occurs.
2862    That will hide the true native status message.  With this version of
2863    perl, the true native child status can always be retrieved so that
2864    is not a problem.  But in this case, Pl_statusvalue and errno may
2865    have different values in them.
2866  */
2867
2868 #   define STATUS_NATIVE_CHILD_SET(n) \
2869         STMT_START {                                                    \
2870             I32 evalue = (I32)n;                                        \
2871             if (evalue == EVMSERR) {                                    \
2872               PL_statusvalue_vms = vaxc$errno;                          \
2873               PL_statusvalue = evalue;                                  \
2874             } else {                                                    \
2875               PL_statusvalue_vms = evalue;                              \
2876               if (evalue == -1) {                                       \
2877                 PL_statusvalue = -1;                                    \
2878                 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
2879               } else                                                    \
2880                 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1);    \
2881               set_vaxc_errno(evalue);                                   \
2882               if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX)    \
2883                   set_errno(EVMSERR);                                   \
2884               else set_errno(Perl_vms_status_to_unix(evalue, 0));       \
2885               PL_statusvalue = PL_statusvalue << child_offset_bits;     \
2886             }                                                           \
2887         } STMT_END
2888
2889 #   ifdef VMSISH_STATUS
2890 #       define STATUS_CURRENT   (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
2891 #   else
2892 #       define STATUS_CURRENT   STATUS_UNIX
2893 #   endif
2894
2895   /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
2896    * the NATIVE status to an equivalent value.  Can not be used to translate
2897    * exit code values as exit code values are not guaranteed to have any
2898    * relationship at all to errno values.
2899    * This is used when Perl is forcing errno to have a specific value.
2900    */
2901 #   define STATUS_UNIX_SET(n)                           \
2902         STMT_START {                                    \
2903             I32 evalue = (I32)n;                        \
2904             PL_statusvalue = evalue;                    \
2905             if (PL_statusvalue != -1) {                 \
2906                 if (PL_statusvalue != EVMSERR) {        \
2907                   PL_statusvalue &= 0xFFFF;             \
2908                   if (MY_POSIX_EXIT)                    \
2909                     PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
2910                   else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
2911                 }                                       \
2912                 else {                                  \
2913                   PL_statusvalue_vms = vaxc$errno;      \
2914                 }                                       \
2915             }                                           \
2916             else PL_statusvalue_vms = SS$_ABORT;        \
2917             set_vaxc_errno(PL_statusvalue_vms);         \
2918         } STMT_END
2919
2920   /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
2921    * the NATIVE error status based on it.
2922    *
2923    * When in the default mode to comply with the Perl VMS documentation,
2924    * 0 is a success and any other code sets the NATIVE status to a failure
2925    * code of SS$_ABORT.
2926    *
2927    * In the new POSIX EXIT mode, native status will be set so that the
2928    * actual exit code will can be retrieved by the calling program or
2929    * shell.
2930    *
2931    * If the exit code is not clearly a UNIX parent or child exit status,
2932    * it will be passed through as a VMS status.
2933    */
2934
2935 #   define STATUS_UNIX_EXIT_SET(n)                      \
2936         STMT_START {                                    \
2937             I32 evalue = (I32)n;                        \
2938             PL_statusvalue = evalue;                    \
2939             if (MY_POSIX_EXIT) { \
2940               if (evalue <= 0xFF00) {           \
2941                   if (evalue > 0xFF)                    \
2942                     evalue = (evalue >> child_offset_bits) & 0xFF; \
2943                   PL_statusvalue_vms =          \
2944                     (C_FAC_POSIX | (evalue << 3 ) |     \
2945                     ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
2946               } else /* forgive them Perl, for they have sinned */ \
2947                 PL_statusvalue_vms = evalue; \
2948             } else { \
2949               if (evalue == 0)                  \
2950                 PL_statusvalue_vms = SS$_NORMAL;        \
2951               else if (evalue <= 0xFF00) \
2952                 PL_statusvalue_vms = SS$_ABORT; \
2953               else { /* forgive them Perl, for they have sinned */ \
2954                   if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
2955                   else PL_statusvalue_vms = vaxc$errno; \
2956                   /* And obviously used a VMS status value instead of UNIX */ \
2957                   PL_statusvalue = EVMSERR;             \
2958               } \
2959               set_vaxc_errno(PL_statusvalue_vms);       \
2960             }                                           \
2961         } STMT_END
2962
2963
2964   /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
2965    * and sets the NATIVE error status based on it.  This special case
2966    * is needed to maintain compatibility with past VMS behavior.
2967    *
2968    * In the default mode on VMS, this number is passed through as
2969    * both the NATIVE and UNIX status.  Which makes it different
2970    * that the STATUS_UNIX_EXIT_SET.
2971    *
2972    * In the new POSIX EXIT mode, native status will be set so that the
2973    * actual exit code will can be retrieved by the calling program or
2974    * shell.
2975    *
2976    * A POSIX exit code is from 0 to 255.  If the exit code is higher
2977    * than this, it needs to be assumed that it is a VMS exit code and
2978    * passed through.
2979    */
2980
2981 #   define STATUS_EXIT_SET(n)                           \
2982         STMT_START {                                    \
2983             I32 evalue = (I32)n;                        \
2984             PL_statusvalue = evalue;                    \
2985             if (MY_POSIX_EXIT)                          \
2986                 if (evalue > 255) PL_statusvalue_vms = evalue; else {   \
2987                   PL_statusvalue_vms = \
2988                     (C_FAC_POSIX | (evalue << 3 ) |     \
2989                      ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
2990             else                                        \
2991                 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
2992             set_vaxc_errno(PL_statusvalue_vms);         \
2993         } STMT_END
2994
2995
2996  /* This macro forces a success status */
2997 #   define STATUS_ALL_SUCCESS   \
2998         (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
2999
3000  /* This macro forces a failure status */
3001 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, \
3002      vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3003         (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3004
3005 #elif defined(__amigaos4__)
3006  /* A somewhat experimental attempt to simulate posix return code values */
3007 #   define STATUS_NATIVE        PL_statusvalue_posix
3008 #   define STATUS_NATIVE_CHILD_SET(n)                      \
3009         STMT_START {                                       \
3010             PL_statusvalue_posix = (n);                    \
3011             if (PL_statusvalue_posix < 0) {                \
3012                 PL_statusvalue = -1;                       \
3013             }                                              \
3014             else {                                         \
3015                 PL_statusvalue = n << 8;                   \
3016             }                                              \
3017         } STMT_END
3018 #   define STATUS_UNIX_SET(n)           \
3019         STMT_START {                    \
3020             PL_statusvalue = (n);               \
3021             if (PL_statusvalue != -1)   \
3022                 PL_statusvalue &= 0xFFFF;       \
3023         } STMT_END
3024 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3025 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3026 #   define STATUS_CURRENT STATUS_UNIX
3027 #   define STATUS_EXIT STATUS_UNIX
3028 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3029 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3030
3031 #else
3032 #   define STATUS_NATIVE        PL_statusvalue_posix
3033 #   if defined(WCOREDUMP)
3034 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3035             STMT_START {                                   \
3036                 PL_statusvalue_posix = (n);                \
3037                 if (PL_statusvalue_posix == -1)            \
3038                     PL_statusvalue = -1;                   \
3039                 else {                                     \
3040                     PL_statusvalue =                       \
3041                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3042                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3043                         (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0);  \
3044                 }                                          \
3045             } STMT_END
3046 #   elif defined(WIFEXITED)
3047 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3048             STMT_START {                                   \
3049                 PL_statusvalue_posix = (n);                \
3050                 if (PL_statusvalue_posix == -1)            \
3051                     PL_statusvalue = -1;                   \
3052                 else {                                     \
3053                     PL_statusvalue =                       \
3054                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3055                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0);  \
3056                 }                                          \
3057             } STMT_END
3058 #   else
3059 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3060             STMT_START {                                   \
3061                 PL_statusvalue_posix = (n);                \
3062                 if (PL_statusvalue_posix == -1)            \
3063                     PL_statusvalue = -1;                   \
3064                 else {                                     \
3065                     PL_statusvalue =                       \
3066                         PL_statusvalue_posix & 0xFFFF;     \
3067                 }                                          \
3068             } STMT_END
3069 #   endif
3070 #   define STATUS_UNIX_SET(n)           \
3071         STMT_START {                    \
3072             PL_statusvalue = (n);               \
3073             if (PL_statusvalue != -1)   \
3074                 PL_statusvalue &= 0xFFFF;       \
3075         } STMT_END
3076 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3077 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3078 #   define STATUS_CURRENT STATUS_UNIX
3079 #   define STATUS_EXIT STATUS_UNIX
3080 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3081 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3082 #endif
3083
3084 /* flags in PL_exit_flags for nature of exit() */
3085 #define PERL_EXIT_EXPECTED      0x01
3086 #define PERL_EXIT_DESTRUCT_END  0x02  /* Run END in perl_destruct */
3087 #define PERL_EXIT_WARN          0x04  /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3088 #define PERL_EXIT_ABORT         0x08  /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3089
3090 #ifndef PERL_CORE
3091 /* format to use for version numbers in file/directory names */
3092 /* XXX move to Configure? */
3093 /* This was only ever used for the current version, and that can be done at
3094    compile time, as PERL_FS_VERSION, so should we just delete it?  */
3095 #  ifndef PERL_FS_VER_FMT
3096 #    define PERL_FS_VER_FMT     "%d.%d.%d"
3097 #  endif
3098 #endif
3099
3100 #ifndef PERL_FS_VERSION
3101 #  define PERL_FS_VERSION       PERL_VERSION_STRING
3102 #endif
3103
3104 /* This defines a way to flush all output buffers.  This may be a
3105  * performance issue, so we allow people to disable it.  Also, if
3106  * we are using stdio, there are broken implementations of fflush(NULL)
3107  * out there, Solaris being the most prominent.
3108  */
3109 #ifndef PERL_FLUSHALL_FOR_CHILD
3110 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3111 #  define PERL_FLUSHALL_FOR_CHILD       PerlIO_flush((PerlIO*)NULL)
3112 # elif defined(FFLUSH_ALL)
3113 #  define PERL_FLUSHALL_FOR_CHILD       my_fflush_all()
3114 # else
3115 #  define PERL_FLUSHALL_FOR_CHILD       NOOP
3116 # endif
3117 #endif
3118
3119 #ifndef PERL_WAIT_FOR_CHILDREN
3120 #  define PERL_WAIT_FOR_CHILDREN        NOOP
3121 #endif
3122
3123 /* the traditional thread-unsafe notion of "current interpreter". */
3124 #ifndef PERL_SET_INTERP
3125 #  define PERL_SET_INTERP(i)            (PL_curinterp = (PerlInterpreter*)(i))
3126 #endif
3127
3128 #ifndef PERL_GET_INTERP
3129 #  define PERL_GET_INTERP               (PL_curinterp)
3130 #endif
3131
3132 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3133 #  ifdef MULTIPLICITY
3134 #    define PERL_GET_THX                ((PerlInterpreter *)PERL_GET_CONTEXT)
3135 #  endif
3136 #  define PERL_SET_THX(t)               PERL_SET_CONTEXT(t)
3137 #endif
3138
3139 /*
3140     This replaces the previous %_ "hack" by the "%p" hacks.
3141     All that is required is that the perl source does not
3142     use "%-p" or "%-<number>p" or "%<number>p" formats.
3143     These formats will still work in perl code.
3144     See comments in sv.c for further details.
3145
3146     Robin Barker 2005-07-14
3147
3148     No longer use %1p for VDf = %vd.  RMB 2007-10-19
3149 */
3150
3151 #ifndef SVf_
3152 #  define SVf_(n) "-" STRINGIFY(n) "p"
3153 #endif
3154
3155 #ifndef SVf
3156 #  define SVf "-p"
3157 #endif
3158
3159 #ifndef SVf32
3160 #  define SVf32 SVf_(32)
3161 #endif
3162
3163 #ifndef SVf256
3164 #  define SVf256 SVf_(256)
3165 #endif
3166
3167 #define SVfARG(p) ((void*)(p))
3168
3169 #ifndef HEKf
3170 #  define HEKf "2p"
3171 #endif
3172
3173 /* Not ideal, but we cannot easily include a number in an already-numeric
3174  * format sequence. */
3175 #ifndef HEKf256
3176 #  define HEKf256 "3p"
3177 #endif
3178
3179 #define HEKfARG(p) ((void*)(p))
3180
3181 /* Takes three arguments: is_utf8, length, str */
3182 #ifndef UTF8f
3183 #  define UTF8f "d%" UVuf "%4p"
3184 #endif
3185 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3186
3187 #define PNf UTF8f
3188 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
3189
3190 #ifdef PERL_CORE
3191 /* not used; but needed for backward compatibility with XS code? - RMB */
3192 #  undef UVf
3193 #elif !defined(UVf)
3194 #  define UVf UVuf
3195 #endif
3196
3197 #ifdef HASATTRIBUTE_DEPRECATED
3198 #  define __attribute__deprecated__         __attribute__((deprecated))
3199 #endif
3200 #ifdef HASATTRIBUTE_FORMAT
3201 #  define __attribute__format__(x,y,z)      __attribute__((format(x,y,z)))
3202 #endif
3203 #ifdef HASATTRIBUTE_MALLOC
3204 #  define __attribute__malloc__             __attribute__((__malloc__))
3205 #endif
3206 #ifdef HASATTRIBUTE_NONNULL
3207 #  define __attribute__nonnull__(a)         __attribute__((nonnull(a)))
3208 #endif
3209 #ifdef HASATTRIBUTE_NORETURN
3210 #  define __attribute__noreturn__           __attribute__((noreturn))
3211 #endif
3212 #ifdef HASATTRIBUTE_PURE
3213 #  define __attribute__pure__               __attribute__((pure))
3214 #endif
3215 #ifdef HASATTRIBUTE_UNUSED
3216 #  define __attribute__unused__             __attribute__((unused))
3217 #endif
3218 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
3219 #  define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
3220 #endif
3221
3222 /* If we haven't defined the attributes yet, define them to blank. */
3223 #ifndef __attribute__deprecated__
3224 #  define __attribute__deprecated__
3225 #endif
3226 #ifndef __attribute__format__
3227 #  define __attribute__format__(x,y,z)
3228 #endif
3229 #ifndef __attribute__malloc__
3230 #  define __attribute__malloc__
3231 #endif
3232 #ifndef __attribute__nonnull__
3233 #  define __attribute__nonnull__(a)
3234 #endif
3235 #ifndef __attribute__noreturn__
3236 #  define __attribute__noreturn__
3237 #endif
3238 #ifndef __attribute__pure__
3239 #  define __attribute__pure__
3240 #endif
3241 #ifndef __attribute__unused__
3242 #  define __attribute__unused__
3243 #endif
3244 #ifndef __attribute__warn_unused_result__
3245 #  define __attribute__warn_unused_result__
3246 #endif
3247
3248 #ifdef I_ASSERT
3249 #  if !defined(DEBUGGING) && !defined(NDEBUG)
3250 #    define NDEBUG 1
3251 #  endif
3252 #  include <assert.h>
3253 #endif
3254
3255 /* For functions that are marked as __attribute__noreturn__, it's not
3256    appropriate to call return.  In either case, include the lint directive.
3257  */
3258 #ifdef HASATTRIBUTE_NORETURN
3259 #  define NORETURN_FUNCTION_END NOT_REACHED;
3260 #else
3261 #  define NORETURN_FUNCTION_END NOT_REACHED; return 0
3262 #endif
3263
3264 /* Some OS warn on NULL format to printf */
3265 #ifdef PRINTF_FORMAT_NULL_OK
3266 #  define __attribute__format__null_ok__(x,y,z)  __attribute__format__(x,y,z)
3267 #else
3268 #  define __attribute__format__null_ok__(x,y,z)
3269 #endif
3270
3271 #ifdef HAS_BUILTIN_EXPECT
3272 #  define EXPECT(expr,val)                  __builtin_expect(expr,val)
3273 #else
3274 #  define EXPECT(expr,val)                  (expr)
3275 #endif
3276 #define LIKELY(cond)                        EXPECT(cBOOL(cond),TRUE)
3277 #define UNLIKELY(cond)                      EXPECT(cBOOL(cond),FALSE)
3278 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3279 /* placeholder */
3280 #endif
3281
3282 /* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
3283    time invariants. That is, their argument must be a constant expression that
3284    can be verified by the compiler. This expression can contain anything that's
3285    known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3286    the expression evaluates to 0, compilation fails.
3287    Because they generate no runtime code (i.e.  their use is "free"), they're
3288    always active, even under non-DEBUGGING builds.
3289    STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
3290    file scope (outside of any function).
3291    STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3292    function.
3293 */
3294 #if (defined(static_assert) || (defined(__cplusplus) && __cplusplus >= 201103L)) && (!defined(__IBMC__) || __IBMC__ >= 1210)
3295 /* static_assert is a macro defined in <assert.h> in C11 or a compiler
3296    builtin in C++11.  But IBM XL C V11 does not support _Static_assert, no
3297    matter what <assert.h> says.
3298 */
3299 #  define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
3300 #else
3301 /* We use a bit-field instead of an array because gcc accepts
3302    'typedef char x[n]' where n is not a compile-time constant.
3303    We want to enforce constantness.
3304 */
3305 #  define STATIC_ASSERT_2(COND, SUFFIX) \
3306     typedef struct { \
3307         unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3308     } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3309 #  define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
3310 #  define STATIC_ASSERT_DECL(COND)    STATIC_ASSERT_1(COND, __LINE__)
3311 #endif
3312 /* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3313    error (static_assert is a declaration, and only statements can have labels).
3314 */
3315 #define STATIC_ASSERT_STMT(COND)      STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
3316
3317 #ifndef __has_builtin
3318 #  define __has_builtin(x) 0 /* not a clang style compiler */
3319 #endif
3320
3321 /* ASSUME is like assert(), but it has a benefit in a release build. It is a
3322    hint to a compiler about a statement of fact in a function call free
3323    expression, which allows the compiler to generate better machine code.
3324    In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3325    the control path is unreachable. In a for loop, ASSUME can be used to hint
3326    that a loop will run at least X times. ASSUME is based off MSVC's __assume
3327    intrinsic function, see its documents for more details.
3328 */
3329
3330 #ifndef DEBUGGING
3331 #  if __has_builtin(__builtin_unreachable) \
3332      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4) /* 4.5 -> */
3333 #    define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3334 #  elif defined(_MSC_VER)
3335 #    define ASSUME(x) __assume(x)
3336 #  elif defined(__ARMCC_VERSION) /* untested */
3337 #    define ASSUME(x) __promise(x)
3338 #  else
3339 /* a random compiler might define assert to its own special optimization token
3340    so pass it through to C lib as a last resort */
3341 #    define ASSUME(x) assert(x)
3342 #  endif
3343 #else
3344 #  define ASSUME(x) assert(x)
3345 #endif
3346
3347 #if defined(__sun)      /* ASSUME() generates warnings on Solaris */
3348 #  define NOT_REACHED
3349 #elif defined(DEBUGGING) && (__has_builtin(__builtin_unreachable) \
3350      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4)) /* 4.5 -> */
3351 #  define NOT_REACHED STMT_START { ASSUME(0); __builtin_unreachable(); } STMT_END
3352 #else
3353 #  define NOT_REACHED ASSUME(0)
3354 #endif
3355
3356 /* Some unistd.h's give a prototype for pause() even though
3357    HAS_PAUSE ends up undefined.  This causes the #define
3358    below to be rejected by the compiler.  Sigh.
3359 */
3360 #ifdef HAS_PAUSE
3361 #define Pause   pause
3362 #else
3363 #define Pause() sleep((32767<<16)+32767)
3364 #endif
3365
3366 #ifndef IOCPARM_LEN
3367 #   ifdef IOCPARM_MASK
3368         /* on BSDish systems we're safe */
3369 #       define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
3370 #   elif defined(_IOC_SIZE) && defined(__GLIBC__)
3371         /* on Linux systems we're safe; except when we're not [perl #38223] */
3372 #       define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3373 #   else
3374         /* otherwise guess at what's safe */
3375 #       define IOCPARM_LEN(x)   256
3376 #   endif
3377 #endif
3378
3379 #if defined(__CYGWIN__)
3380 /* USEMYBINMODE
3381  *   This symbol, if defined, indicates that the program should
3382  *   use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3383  *   that a file is in "binary" mode -- that is, that no translation
3384  *   of bytes occurs on read or write operations.
3385  */
3386 #  define USEMYBINMODE /**/
3387 #  include <io.h> /* for setmode() prototype */
3388 #  define my_binmode(fp, iotype, mode) \
3389             cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
3390 #endif
3391
3392 #ifdef __CYGWIN__
3393 void init_os_extras(void);
3394 #endif
3395
3396 #ifdef UNION_ANY_DEFINITION
3397 UNION_ANY_DEFINITION;
3398 #else
3399 union any {
3400     void*       any_ptr;
3401     SV*         any_sv;
3402     SV**        any_svp;
3403     GV*         any_gv;
3404     AV*         any_av;
3405     HV*         any_hv;
3406     OP*         any_op;
3407     char*       any_pv;
3408     char**      any_pvp;
3409     I32         any_i32;
3410     U32         any_u32;
3411     IV          any_iv;
3412     UV          any_uv;
3413     long        any_long;
3414     bool        any_bool;
3415     void        (*any_dptr) (void*);
3416     void        (*any_dxptr) (pTHX_ void*);
3417 };
3418 #endif
3419
3420 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3421
3422 #define FILTER_READ(idx, sv, len)  filter_read(idx, sv, len)
3423 #define FILTER_DATA(idx) \
3424             (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3425 #define FILTER_ISREADER(idx) \
3426             (PL_parser && PL_parser->rsfp_filters \
3427                 && idx >= AvFILLp(PL_parser->rsfp_filters))
3428 #define PERL_FILTER_EXISTS(i) \
3429             (PL_parser && PL_parser->rsfp_filters \
3430                 && (i) <= av_tindex(PL_parser->rsfp_filters))
3431
3432 #if defined(_AIX) && !defined(_AIX43)
3433 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3434 /* We cannot include <crypt.h> to get the struct crypt_data
3435  * because of setkey prototype problems when threading */
3436 typedef        struct crypt_data {     /* straight from /usr/include/crypt.h */
3437     /* From OSF, Not needed in AIX
3438        char C[28], D[28];
3439     */
3440     char E[48];
3441     char KS[16][48];
3442     char block[66];
3443     char iobuf[16];
3444 } CRYPTD;
3445 #endif /* threading */
3446 #endif /* AIX */
3447
3448 #ifndef PERL_CALLCONV
3449 #  ifdef __cplusplus
3450 #    define PERL_CALLCONV extern "C"
3451 #  else
3452 #    define PERL_CALLCONV
3453 #  endif
3454 #endif
3455 #ifndef PERL_CALLCONV_NO_RET
3456 #    define PERL_CALLCONV_NO_RET PERL_CALLCONV
3457 #endif
3458
3459 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
3460    dont have a noreturn as a declaration specifier
3461 */
3462 #ifndef PERL_STATIC_NO_RET
3463 #  define PERL_STATIC_NO_RET STATIC
3464 #endif
3465 /* PERL_STATIC_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE on
3466    builds that dont have a noreturn as a declaration specifier
3467 */
3468 #ifndef PERL_STATIC_INLINE_NO_RET
3469 #  define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
3470 #endif
3471
3472 #if !defined(OS2)
3473 #  include "iperlsys.h"
3474 #endif
3475
3476 #ifdef __LIBCATAMOUNT__
3477 #undef HAS_PASSWD  /* unixish.h but not unixish enough. */
3478 #undef HAS_GROUP
3479 #define FAKE_BIT_BUCKET
3480 #endif
3481
3482 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3483  * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
3484  * Configure, despite their names being similar to other defines like
3485  * USE_ITHREADS.  Configure in fact knows nothing about the randomised
3486  * hashes.  Therefore to enable/disable the hash randomisation defines
3487  * use the Configure -Accflags=... instead. */
3488 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
3489 #  define USE_HASH_SEED
3490 #endif
3491
3492 #include "perly.h"
3493
3494
3495 /* macros to define bit-fields in structs. */
3496 #ifndef PERL_BITFIELD8
3497 #  define PERL_BITFIELD8 unsigned
3498 #endif
3499 #ifndef PERL_BITFIELD16
3500 #  define PERL_BITFIELD16 unsigned
3501 #endif
3502 #ifndef PERL_BITFIELD32
3503 #  define PERL_BITFIELD32 unsigned
3504 #endif
3505
3506 #include "sv.h"
3507 #include "regexp.h"
3508 #include "util.h"
3509 #include "form.h"
3510 #include "gv.h"
3511 #include "pad.h"
3512 #include "cv.h"
3513 #include "opnames.h"
3514 #include "op.h"
3515 #include "hv.h"
3516 #include "cop.h"
3517 #include "av.h"
3518 #include "mg.h"
3519 #include "scope.h"
3520 #include "warnings.h"
3521 #include "utf8.h"
3522
3523 /* these would be in doio.h if there was such a file */
3524 #define my_stat()  my_stat_flags(SV_GMAGIC)
3525 #define my_lstat() my_lstat_flags(SV_GMAGIC)
3526
3527 /* defined in sv.c, but also used in [ach]v.c */
3528 #undef _XPV_HEAD
3529 #undef _XPVMG_HEAD
3530 #undef _XPVCV_COMMON
3531
3532 #include "parser.h"
3533
3534 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
3535
3536 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3537
3538 /* These have to be predeclared, as they are used in proto.h which is #included
3539  * before their definitions in regcomp.h. */
3540
3541 struct scan_data_t;
3542 typedef struct regnode_charclass regnode_charclass;
3543
3544 struct regnode_charclass_class;
3545
3546 /* A hopefully less confusing name.  The sub-classes are all Posix classes only
3547  * used under /l matching */
3548 typedef struct regnode_charclass_class regnode_charclass_posixl;
3549
3550 typedef struct regnode_ssc regnode_ssc;
3551 typedef struct RExC_state_t RExC_state_t;
3552 struct _reg_trie_data;
3553
3554 #endif
3555
3556 struct ptr_tbl_ent {
3557     struct ptr_tbl_ent*         next;
3558     const void*                 oldval;
3559     void*                       newval;
3560 };
3561
3562 struct ptr_tbl {
3563     struct ptr_tbl_ent**        tbl_ary;
3564     UV                          tbl_max;
3565     UV                          tbl_items;
3566     struct ptr_tbl_arena        *tbl_arena;
3567     struct ptr_tbl_ent          *tbl_arena_next;
3568     struct ptr_tbl_ent          *tbl_arena_end;
3569 };
3570
3571 #if defined(htonl) && !defined(HAS_HTONL)
3572 #define HAS_HTONL
3573 #endif
3574 #if defined(htons) && !defined(HAS_HTONS)
3575 #define HAS_HTONS
3576 #endif
3577 #if defined(ntohl) && !defined(HAS_NTOHL)
3578 #define HAS_NTOHL
3579 #endif
3580 #if defined(ntohs) && !defined(HAS_NTOHS)
3581 #define HAS_NTOHS
3582 #endif
3583 #ifndef HAS_HTONL
3584 #define HAS_HTONS
3585 #define HAS_HTONL
3586 #define HAS_NTOHS
3587 #define HAS_NTOHL
3588 #  if (BYTEORDER & 0xffff) == 0x4321
3589 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
3590    re-order their values. However, to behave identically to the alternative
3591    implementations, they should truncate to the correct size.  */
3592 #    define ntohl(x)    ((x)&0xFFFFFFFF)
3593 #    define htonl(x)    ntohl(x)
3594 #    define ntohs(x)    ((x)&0xFFFF)
3595 #    define htons(x)    ntohs(x)
3596 #  elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3597
3598 /* Note that we can't straight out declare our own htonl and htons because
3599    the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
3600    to avoid the overhead of initialising the socket subsystem, but the headers
3601    that *declare* the various functions are still seen. If we declare our own
3602    htonl etc they will clash with the declarations in the Win32 headers.  */
3603
3604 PERL_STATIC_INLINE U32
3605 my_swap32(const U32 x) {
3606     return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)      
3607         | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
3608 }
3609
3610 PERL_STATIC_INLINE U16
3611 my_swap16(const U16 x) {
3612     return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
3613 }
3614
3615 #    define htonl(x)    my_swap32(x)
3616 #    define ntohl(x)    my_swap32(x)
3617 #    define ntohs(x)    my_swap16(x)
3618 #    define htons(x)    my_swap16(x)
3619 #  else
3620 #    error "Unsupported byteorder"
3621 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
3622    the error message. Please check the value of the macro BYTEORDER, as defined
3623    in config.h. The values of BYTEORDER we expect are
3624
3625             big endian  little endian
3626    32 bit       0x4321  0x1234
3627    64 bit   0x87654321  0x12345678
3628
3629    If you have a system with a different byte order, please see
3630    pod/perlhack.pod for how to submit a patch to add supporting code.
3631 */
3632 #  endif
3633 #endif
3634
3635 /*
3636  * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
3637  * -DWS
3638  */
3639 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3640 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
3641    re-order their values. However, to behave identically to the alternative
3642    implementations, they should truncate to the correct size.  */
3643 #  define vtohl(x)      ((x)&0xFFFFFFFF)
3644 #  define vtohs(x)      ((x)&0xFFFF)
3645 #  define htovl(x)      vtohl(x)
3646 #  define htovs(x)      vtohs(x)
3647 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
3648 #  define vtohl(x)      ((((x)&0xFF)<<24)       \
3649                         +(((x)>>24)&0xFF)       \
3650                         +(((x)&0x0000FF00)<<8)  \
3651                         +(((x)&0x00FF0000)>>8)  )
3652 #  define vtohs(x)      ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
3653 #  define htovl(x)      vtohl(x)
3654 #  define htovs(x)      vtohs(x)
3655 #else
3656 #  error "Unsupported byteorder"
3657 /* If you have need for current perl on PDP-11 or similar, and can help test
3658    that blead keeps working on a mixed-endian system, then see
3659    pod/perlhack.pod for how to submit patches to things working again.  */
3660 #endif
3661
3662 /* *MAX Plus 1. A floating point value.
3663    Hopefully expressed in a way that dodgy floating point can't mess up.
3664    >> 2 rather than 1, so that value is safely less than I32_MAX after 1
3665    is added to it
3666    May find that some broken compiler will want the value cast to I32.
3667    [after the shift, as signed >> may not be as secure as unsigned >>]
3668 */
3669 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
3670 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
3671 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
3672    0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
3673    may be greater than sizeof(IV), so don't assume that half max UV is max IV.
3674 */
3675 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
3676
3677 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
3678 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
3679 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
3680
3681 /* This may look like unnecessary jumping through hoops, but converting
3682    out of range floating point values to integers *is* undefined behaviour,
3683    and it is starting to bite.
3684 */
3685 #ifndef CAST_INLINE
3686 #define I_32(what) (cast_i32((NV)(what)))
3687 #define U_32(what) (cast_ulong((NV)(what)))
3688 #define I_V(what) (cast_iv((NV)(what)))
3689 #define U_V(what) (cast_uv((NV)(what)))
3690 #else
3691 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
3692                   : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
3693                      : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
3694 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
3695                   : ((n) < U32_MAX_P1 ? (U32) (n) \
3696                      : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
3697 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
3698                   : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
3699                      : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
3700 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
3701                   : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
3702                      : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
3703 #endif
3704
3705 #define U_S(what) ((U16)U_32(what))
3706 #define U_I(what) ((unsigned int)U_32(what))
3707 #define U_L(what) U_32(what)
3708
3709 #ifdef HAS_SIGNBIT
3710 #  define Perl_signbit signbit
3711 #endif
3712
3713 /* These do not care about the fractional part, only about the range. */
3714 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
3715 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
3716
3717 /* Used with UV/IV arguments: */
3718                                         /* XXXX: need to speed it up */
3719 #define CLUMP_2UV(iv)   ((iv) < 0 ? 0 : (UV)(iv))
3720 #define CLUMP_2IV(uv)   ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
3721
3722 #ifndef MAXSYSFD
3723 #   define MAXSYSFD 2
3724 #endif
3725
3726 #ifndef __cplusplus
3727 #if !(defined(WIN32) || defined(UNDER_CE) || defined(SYMBIAN))
3728 Uid_t getuid (void);
3729 Uid_t geteuid (void);
3730 Gid_t getgid (void);
3731 Gid_t getegid (void);
3732 #endif
3733 #endif
3734
3735 #ifndef Perl_debug_log
3736 #  define Perl_debug_log        PerlIO_stderr()
3737 #endif
3738
3739 #ifndef Perl_error_log
3740 #  define Perl_error_log        (PL_stderrgv                    \
3741                                  && isGV(PL_stderrgv)           \
3742                                  && GvIOp(PL_stderrgv)          \
3743                                  && IoOFP(GvIOp(PL_stderrgv))   \
3744                                  ? IoOFP(GvIOp(PL_stderrgv))    \
3745                                  : PerlIO_stderr())
3746 #endif
3747
3748
3749 #define DEBUG_p_FLAG            0x00000001 /*      1 */
3750 #define DEBUG_s_FLAG            0x00000002 /*      2 */
3751 #define DEBUG_l_FLAG            0x00000004 /*      4 */
3752 #define DEBUG_t_FLAG            0x00000008 /*      8 */
3753 #define DEBUG_o_FLAG            0x00000010 /*     16 */
3754 #define DEBUG_c_FLAG            0x00000020 /*     32 */
3755 #define DEBUG_P_FLAG            0x00000040 /*     64 */
3756 #define DEBUG_m_FLAG            0x00000080 /*    128 */
3757 #define DEBUG_f_FLAG            0x00000100 /*    256 */
3758 #define DEBUG_r_FLAG            0x00000200 /*    512 */
3759 #define DEBUG_x_FLAG            0x00000400 /*   1024 */
3760 #define DEBUG_u_FLAG            0x00000800 /*   2048 */
3761 /* U is reserved for Unofficial, exploratory hacking */
3762 #define DEBUG_U_FLAG            0x00001000 /*   4096 */
3763 /* spare                                        8192 */
3764 #define DEBUG_X_FLAG            0x00004000 /*  16384 */
3765 #define DEBUG_D_FLAG            0x00008000 /*  32768 */
3766 #define DEBUG_S_FLAG            0x00010000 /*  65536 */
3767 #define DEBUG_T_FLAG            0x00020000 /* 131072 */
3768 #define DEBUG_R_FLAG            0x00040000 /* 262144 */
3769 #define DEBUG_J_FLAG            0x00080000 /* 524288 */
3770 #define DEBUG_v_FLAG            0x00100000 /*1048576 */
3771 #define DEBUG_C_FLAG            0x00200000 /*2097152 */
3772 #define DEBUG_A_FLAG            0x00400000 /*4194304 */
3773 #define DEBUG_q_FLAG            0x00800000 /*8388608 */
3774 #define DEBUG_M_FLAG            0x01000000 /*16777216*/
3775 #define DEBUG_B_FLAG            0x02000000 /*33554432*/
3776 #define DEBUG_L_FLAG            0x04000000 /*67108864*/
3777 #define DEBUG_i_FLAG            0x08000000 /*134217728*/
3778 #define DEBUG_MASK              0x0FFFEFFF /* mask of all the standard flags */
3779
3780 #define DEBUG_DB_RECURSE_FLAG   0x40000000
3781 #define DEBUG_TOP_FLAG          0x80000000 /* -D was given --> PL_debug |= FLAG */
3782
3783 #  define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
3784 #  define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
3785 #  define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
3786 #  define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
3787 #  define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
3788 #  define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
3789 #  define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
3790 #  define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
3791 #  define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
3792 #  define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
3793 #  define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
3794 #  define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
3795 #  define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
3796 #  define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
3797 #  define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
3798 #  define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
3799 #  define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
3800 #  define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
3801 #  define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
3802 #  define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
3803 #  define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
3804 #  define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
3805 #  define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
3806 #  define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
3807 #  define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
3808 #  define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
3809 #  define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
3810 #  define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
3811 #  define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
3812 #  define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
3813 #  define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
3814
3815 #ifdef DEBUGGING
3816
3817 #  define DEBUG_p_TEST DEBUG_p_TEST_
3818 #  define DEBUG_s_TEST DEBUG_s_TEST_
3819 #  define DEBUG_l_TEST DEBUG_l_TEST_
3820 #  define DEBUG_t_TEST DEBUG_t_TEST_
3821 #  define DEBUG_o_TEST DEBUG_o_TEST_
3822 #  define DEBUG_c_TEST DEBUG_c_TEST_
3823 #  define DEBUG_P_TEST DEBUG_P_TEST_
3824 #  define DEBUG_m_TEST DEBUG_m_TEST_
3825 #  define DEBUG_f_TEST DEBUG_f_TEST_
3826 #  define DEBUG_r_TEST DEBUG_r_TEST_
3827 #  define DEBUG_x_TEST DEBUG_x_TEST_
3828 #  define DEBUG_u_TEST DEBUG_u_TEST_
3829 #  define DEBUG_U_TEST DEBUG_U_TEST_
3830 #  define DEBUG_X_TEST DEBUG_X_TEST_
3831 #  define DEBUG_D_TEST DEBUG_D_TEST_
3832 #  define DEBUG_S_TEST DEBUG_S_TEST_
3833 #  define DEBUG_T_TEST DEBUG_T_TEST_
3834 #  define DEBUG_R_TEST DEBUG_R_TEST_
3835 #  define DEBUG_J_TEST DEBUG_J_TEST_
3836 #  define DEBUG_v_TEST DEBUG_v_TEST_
3837 #  define DEBUG_C_TEST DEBUG_C_TEST_
3838 #  define DEBUG_A_TEST DEBUG_A_TEST_
3839 #  define DEBUG_q_TEST DEBUG_q_TEST_
3840 #  define DEBUG_M_TEST DEBUG_M_TEST_
3841 #  define DEBUG_B_TEST DEBUG_B_TEST_
3842 #  define DEBUG_L_TEST DEBUG_L_TEST_
3843 #  define DEBUG_i_TEST DEBUG_i_TEST_
3844 #  define DEBUG_Xv_TEST DEBUG_Xv_TEST_
3845 #  define DEBUG_Uv_TEST DEBUG_Uv_TEST_
3846 #  define DEBUG_Pv_TEST DEBUG_Pv_TEST_
3847 #  define DEBUG_Lv_TEST DEBUG_Lv_TEST_
3848
3849 #  define PERL_DEB(a)                  a
3850 #  define PERL_DEB2(a,b)               a
3851 #  define PERL_DEBUG(a) if (PL_debug)  a
3852 #  define DEBUG_p(a) if (DEBUG_p_TEST) a
3853 #  define DEBUG_s(a) if (DEBUG_s_TEST) a
3854 #  define DEBUG_l(a) if (DEBUG_l_TEST) a
3855 #  define DEBUG_t(a) if (DEBUG_t_TEST) a
3856 #  define DEBUG_o(a) if (DEBUG_o_TEST) a
3857 #  define DEBUG_c(a) if (DEBUG_c_TEST) a
3858 #  define DEBUG_P(a) if (DEBUG_P_TEST) a
3859
3860      /* Temporarily turn off memory debugging in case the a
3861       * does memory allocation, either directly or indirectly. */
3862 #  define DEBUG_m(a)  \
3863     STMT_START {                                                        \
3864         if (PERL_GET_INTERP) {                                          \
3865                                 dTHX;                                   \
3866                                 if (DEBUG_m_TEST) {                     \
3867                                     PL_debug &= ~DEBUG_m_FLAG;          \
3868                                     a;                                  \
3869                                     PL_debug |= DEBUG_m_FLAG;           \
3870                                 }                                       \
3871                               }                                         \
3872     } STMT_END
3873
3874 #  define DEBUG__(t, a)                                                 \
3875         STMT_START {                                                    \
3876                 if (t) STMT_START {a;} STMT_END;                        \
3877         } STMT_END
3878
3879 #  define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
3880
3881 #ifndef PERL_EXT_RE_BUILD
3882 #  define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
3883 #else
3884 #  define DEBUG_r(a) STMT_START {a;} STMT_END
3885 #endif /* PERL_EXT_RE_BUILD */
3886
3887 #  define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
3888 #  define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
3889 #  define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
3890 #  define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
3891 #  define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
3892 #  define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
3893 #  define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
3894 #  define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
3895 #  define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
3896
3897 #  define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
3898 #  define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
3899 #  define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
3900 #  define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
3901 #  define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
3902 #  define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
3903 #  define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
3904 #  define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
3905 #  define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
3906 #  define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
3907 #  define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
3908
3909 #else /* DEBUGGING */
3910
3911 #  define DEBUG_p_TEST (0)
3912 #  define DEBUG_s_TEST (0)
3913 #  define DEBUG_l_TEST (0)
3914 #  define DEBUG_t_TEST (0)
3915 #  define DEBUG_o_TEST (0)
3916 #  define DEBUG_c_TEST (0)
3917 #  define DEBUG_P_TEST (0)
3918 #  define DEBUG_m_TEST (0)
3919 #  define DEBUG_f_TEST (0)
3920 #  define DEBUG_r_TEST (0)
3921 #  define DEBUG_x_TEST (0)
3922 #  define DEBUG_u_TEST (0)
3923 #  define DEBUG_U_TEST (0)
3924 #  define DEBUG_X_TEST (0)
3925 #  define DEBUG_D_TEST (0)
3926 #  define DEBUG_S_TEST (0)
3927 #  define DEBUG_T_TEST (0)
3928 #  define DEBUG_R_TEST (0)
3929 #  define DEBUG_J_TEST (0)
3930 #  define DEBUG_v_TEST (0)
3931 #  define DEBUG_C_TEST (0)
3932 #  define DEBUG_A_TEST (0)
3933 #  define DEBUG_q_TEST (0)
3934 #  define DEBUG_M_TEST (0)
3935 #  define DEBUG_B_TEST (0)
3936 #  define DEBUG_L_TEST (0)
3937 #  define DEBUG_i_TEST (0)
3938 #  define DEBUG_Xv_TEST (0)
3939 #  define DEBUG_Uv_TEST (0)
3940 #  define DEBUG_Pv_TEST (0)
3941 #  define DEBUG_Lv_TEST (0)
3942
3943 #  define PERL_DEB(a)
3944 #  define PERL_DEB2(a,b)               b
3945 #  define PERL_DEBUG(a)
3946 #  define DEBUG_p(a)
3947 #  define DEBUG_s(a)
3948 #  define DEBUG_l(a)
3949 #  define DEBUG_t(a)
3950 #  define DEBUG_o(a)
3951 #  define DEBUG_c(a)
3952 #  define DEBUG_P(a)
3953 #  define DEBUG_m(a)
3954 #  define DEBUG_f(a)
3955 #  define DEBUG_r(a)
3956 #  define DEBUG_x(a)
3957 #  define DEBUG_u(a)
3958 #  define DEBUG_U(a)
3959 #  define DEBUG_X(a)
3960 #  define DEBUG_D(a)
3961 #  define DEBUG_S(a)
3962 #  define DEBUG_T(a)
3963 #  define DEBUG_R(a)
3964 #  define DEBUG_v(a)
3965 #  define DEBUG_C(a)
3966 #  define DEBUG_A(a)
3967 #  define DEBUG_q(a)
3968 #  define DEBUG_M(a)
3969 #  define DEBUG_B(a)
3970 #  define DEBUG_L(a)
3971 #  define DEBUG_i(a)
3972 #  define DEBUG_Xv(a)
3973 #  define DEBUG_Uv(a)
3974 #  define DEBUG_Pv(a)
3975 #  define DEBUG_Lv(a)
3976 #endif /* DEBUGGING */
3977
3978
3979 #define DEBUG_SCOPE(where) \
3980     DEBUG_l( \
3981     Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n",   \
3982                     where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
3983                     __FILE__, __LINE__));
3984
3985 /* Keep the old croak based assert for those who want it, and as a fallback if
3986    the platform is so heretically non-ANSI that it can't assert.  */
3987
3988 #define Perl_assert(what)       PERL_DEB2(                              \
3989         ((what) ? ((void) 0) :                                          \
3990             (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
3991                         "\", line %d", STRINGIFY(what), __LINE__),      \
3992              (void) 0)), ((void)0))
3993
3994 /* assert() gets defined if DEBUGGING (and I_ASSERT).
3995  * If no DEBUGGING, the <assert.h> has not been included. */
3996 #ifndef assert
3997 #  define assert(what)  Perl_assert(what)
3998 #endif
3999 #ifdef DEBUGGING
4000 #  define assert_(what) assert(what),
4001 #else
4002 #  define assert_(what)
4003 #endif
4004
4005 struct ufuncs {
4006     I32 (*uf_val)(pTHX_ IV, SV*);
4007     I32 (*uf_set)(pTHX_ IV, SV*);
4008     IV uf_index;
4009 };
4010
4011 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4012  * XS code wanting to be backward compatible can do something
4013  * like the following:
4014
4015 #ifndef PERL_MG_UFUNC
4016 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4017 #endif
4018
4019 static PERL_MG_UFUNC(foo_get, index, val)
4020 {
4021     sv_setsv(val, ...);
4022     return TRUE;
4023 }
4024
4025 -- Doug MacEachern
4026
4027 */
4028
4029 #ifndef PERL_MG_UFUNC
4030 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4031 #endif
4032
4033 /* Fix these up for __STDC__ */
4034 #ifndef DONT_DECLARE_STD
4035 char *mktemp (char*);
4036 #ifndef atof
4037 double atof (const char*);
4038 #endif
4039 #endif
4040
4041 #ifndef STANDARD_C
4042 /* All of these are in stdlib.h or time.h for ANSI C */
4043 Time_t time();
4044 struct tm *gmtime(), *localtime();
4045 #if defined(OEMVS)
4046 char *(strcpy)(), *(strcat)();
4047 #else
4048 char *strcpy(), *strcat();
4049 #endif
4050 #endif /* ! STANDARD_C */
4051
4052
4053 #ifdef I_MATH
4054 #    include <math.h>
4055 #    ifdef __VMS
4056      /* isfinite and others are here rather than in math.h as C99 stipulates */
4057 #        include <fp.h>
4058 #    endif
4059 #else
4060 START_EXTERN_C
4061             double exp (double);
4062             double log (double);
4063             double log10 (double);
4064             double sqrt (double);
4065             double frexp (double,int*);
4066             double ldexp (double,int);
4067             double modf (double,double*);
4068             double sin (double);
4069             double cos (double);
4070             double atan2 (double,double);
4071             double pow (double,double);
4072 END_EXTERN_C
4073 #endif
4074
4075 #ifndef __cplusplus
4076 #  if !defined(WIN32) && !defined(VMS)
4077 #ifndef crypt
4078 char *crypt (const char*, const char*);
4079 #endif
4080 #  endif /* !WIN32 */
4081 #  ifndef DONT_DECLARE_STD
4082 #    ifndef getenv
4083 char *getenv (const char*);
4084 #    endif /* !getenv */
4085 #    if !defined(HAS_LSEEK_PROTO) && !defined(__hpux)
4086 #      ifdef _FILE_OFFSET_BITS
4087 #        if _FILE_OFFSET_BITS == 64
4088 Off_t lseek (int,Off_t,int);
4089 #        endif
4090 #      endif
4091 #    endif
4092 #  endif /* !DONT_DECLARE_STD */
4093 #  ifndef WIN32
4094 #    ifndef getlogin
4095 char *getlogin (void);
4096 #    endif
4097 #  endif /* !WIN32 */
4098 #endif /* !__cplusplus */
4099
4100 /* Fixme on VMS.  This needs to be a run-time, not build time options */
4101 /* Also rename() is affected by this */
4102 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4103 #define UNLINK unlnk
4104 I32 unlnk (pTHX_ const char*);
4105 #else
4106 #define UNLINK PerlLIO_unlink
4107 #endif
4108
4109 /* some versions of glibc are missing the setresuid() proto */
4110 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4111 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4112 #endif
4113 /* some versions of glibc are missing the setresgid() proto */
4114 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4115 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4116 #endif
4117
4118 #ifndef HAS_SETREUID
4119 #  ifdef HAS_SETRESUID
4120 #    define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4121 #    define HAS_SETREUID
4122 #  endif
4123 #endif
4124 #ifndef HAS_SETREGID
4125 #  ifdef HAS_SETRESGID
4126 #    define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4127 #    define HAS_SETREGID
4128 #  endif
4129 #endif
4130
4131 /* Sighandler_t defined in iperlsys.h */
4132
4133 #ifdef HAS_SIGACTION
4134 typedef struct sigaction Sigsave_t;
4135 #else
4136 typedef Sighandler_t Sigsave_t;
4137 #endif
4138
4139 #define SCAN_DEF 0
4140 #define SCAN_TR 1
4141 #define SCAN_REPL 2
4142
4143 #ifdef DEBUGGING
4144 # ifndef register
4145 #  define register
4146 # endif
4147 # define RUNOPS_DEFAULT Perl_runops_debug
4148 #else
4149 # define RUNOPS_DEFAULT Perl_runops_standard
4150 #endif
4151
4152 #if defined(USE_PERLIO)
4153 EXTERN_C void PerlIO_teardown(void);
4154 # ifdef USE_ITHREADS
4155 #  define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4156 #  define PERLIO_TERM                           \
4157         STMT_START {                            \
4158                 PerlIO_teardown();              \
4159                 MUTEX_DESTROY(&PL_perlio_mutex);\
4160         } STMT_END
4161 # else
4162 #  define PERLIO_INIT
4163 #  define PERLIO_TERM   PerlIO_teardown()
4164 # endif
4165 #else
4166 #  define PERLIO_INIT
4167 #  define PERLIO_TERM
4168 #endif
4169
4170 #ifdef MYMALLOC
4171 #  ifdef MUTEX_INIT_CALLS_MALLOC
4172 #    define MALLOC_INIT                                 \
4173         STMT_START {                                    \
4174                 PL_malloc_mutex = NULL;                 \
4175                 MUTEX_INIT(&PL_malloc_mutex);           \
4176         } STMT_END
4177 #    define MALLOC_TERM                                 \
4178         STMT_START {                                    \
4179                 perl_mutex tmp = PL_malloc_mutex;       \
4180                 PL_malloc_mutex = NULL;                 \
4181                 MUTEX_DESTROY(&tmp);                    \
4182         } STMT_END
4183 #  else
4184 #    define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4185 #    define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4186 #  endif
4187 #else
4188 #  define MALLOC_INIT
4189 #  define MALLOC_TERM
4190 #endif
4191
4192 #if defined(PERL_IMPLICIT_CONTEXT)
4193
4194 struct perl_memory_debug_header;
4195 struct perl_memory_debug_header {
4196   tTHX  interpreter;
4197 #  if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4198   MEM_SIZE size;
4199 #  endif
4200   struct perl_memory_debug_header *prev;
4201   struct perl_memory_debug_header *next;
4202 #  ifdef PERL_DEBUG_READONLY_COW
4203   bool readonly;
4204 #  endif
4205 };
4206
4207 #elif defined(PERL_DEBUG_READONLY_COW)
4208
4209 struct perl_memory_debug_header;
4210 struct perl_memory_debug_header {
4211   MEM_SIZE size;
4212 };
4213
4214 #endif
4215
4216 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4217
4218 #  define PERL_MEMORY_DEBUG_HEADER_SIZE \
4219         (sizeof(struct perl_memory_debug_header) + \
4220         (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4221          %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4222
4223 #else
4224 #  define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4225 #endif
4226
4227 #ifdef PERL_TRACK_MEMPOOL
4228 # ifdef PERL_DEBUG_READONLY_COW
4229 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4230         STMT_START {                                            \
4231                 (header).interpreter = (interp);                \
4232                 (header).prev = (header).next = &(header);      \
4233                 (header).readonly = 0;                          \
4234         } STMT_END
4235 # else
4236 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4237         STMT_START {                                            \
4238                 (header).interpreter = (interp);                \
4239                 (header).prev = (header).next = &(header);      \
4240         } STMT_END
4241 # endif
4242 # else
4243 #  define INIT_TRACK_MEMPOOL(header, interp)
4244 #endif
4245
4246 #ifdef I_MALLOCMALLOC
4247 /* Needed for malloc_size(), malloc_good_size() on some systems */
4248 #  include <malloc/malloc.h>
4249 #endif
4250
4251 #ifdef MYMALLOC
4252 #  define Perl_safesysmalloc_size(where)        Perl_malloced_size(where)
4253 #else
4254 #  if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4255 #    ifdef PERL_TRACK_MEMPOOL
4256 #       define Perl_safesysmalloc_size(where)                   \
4257             (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4258 #    else
4259 #       define Perl_safesysmalloc_size(where) malloc_size(where)
4260 #    endif
4261 #  endif
4262 #  ifdef HAS_MALLOC_GOOD_SIZE
4263 #    ifdef PERL_TRACK_MEMPOOL
4264 #       define Perl_malloc_good_size(how_much)                  \
4265             (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4266 #    else
4267 #       define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4268 #    endif
4269 #  else
4270 /* Having this as the identity operation makes some code simpler.  */
4271 #       define Perl_malloc_good_size(how_much)  (how_much)
4272 #  endif
4273 #endif
4274
4275 typedef int (*runops_proc_t)(pTHX);
4276 typedef void (*share_proc_t) (pTHX_ SV *sv);
4277 typedef int  (*thrhook_proc_t) (pTHX);
4278 typedef OP* (*PPADDR_t[]) (pTHX);
4279 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4280 typedef void (*despatch_signals_proc_t) (pTHX);
4281
4282 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4283 #  include <crt_externs.h>      /* for the env array */
4284 #  define environ (*_NSGetEnviron())
4285 #elif defined(USE_ENVIRON_ARRAY)
4286    /* VMS and some other platforms don't use the environ array */
4287 #    if !defined(DONT_DECLARE_STD) || \
4288         (defined(__svr4__) && defined(__GNUC__) && defined(__sun)) || \
4289         defined(__sgi)
4290 extern char **  environ;        /* environment variables supplied via exec */
4291 #    endif
4292 #endif
4293
4294 #define PERL_PATCHLEVEL_H_IMPLICIT
4295 #include "patchlevel.h"
4296 #undef PERL_PATCHLEVEL_H_IMPLICIT
4297
4298 #define PERL_VERSION_STRING     STRINGIFY(PERL_REVISION) "." \
4299                                 STRINGIFY(PERL_VERSION) "." \
4300                                 STRINGIFY(PERL_SUBVERSION)
4301
4302 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4303                                 STRINGIFY(PERL_API_VERSION) "." \
4304                                 STRINGIFY(PERL_API_SUBVERSION)
4305
4306 START_EXTERN_C
4307
4308 /* handy constants */
4309 EXTCONST char PL_warn_uninit[]
4310   INIT("Use of uninitialized value%s%s%s");
4311 EXTCONST char PL_warn_uninit_sv[]
4312   INIT("Use of uninitialized value%" SVf "%s%s");
4313 EXTCONST char PL_warn_nosemi[]
4314   INIT("Semicolon seems to be missing");
4315 EXTCONST char PL_warn_reserved[]
4316   INIT("Unquoted string \"%s\" may clash with future reserved word");
4317 EXTCONST char PL_warn_nl[]
4318   INIT("Unsuccessful %s on filename containing newline");
4319 EXTCONST char PL_no_wrongref[]
4320   INIT("Can't use %s ref as %s ref");
4321 /* The core no longer needs this here. If you require the string constant,
4322    please inline a copy into your own code.  */
4323 EXTCONST char PL_no_symref[] __attribute__deprecated__
4324   INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4325 EXTCONST char PL_no_symref_sv[]
4326   INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4327
4328 EXTCONST char PL_no_usym[]
4329   INIT("Can't use an undefined value as %s reference");
4330 EXTCONST char PL_no_aelem[]
4331   INIT("Modification of non-creatable array value attempted, subscript %d");
4332 EXTCONST char PL_no_helem_sv[]
4333   INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4334 EXTCONST char PL_no_modify[]
4335   INIT("Modification of a read-only value attempted");
4336 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4337   INIT("Out of memory!\n");
4338 EXTCONST char PL_no_security[]
4339   INIT("Insecure dependency in %s%s");
4340 EXTCONST char PL_no_sock_func[]
4341   INIT("Unsupported socket function \"%s\" called");
4342 EXTCONST char PL_no_dir_func[]
4343   INIT("Unsupported directory function \"%s\" called");
4344 EXTCONST char PL_no_func[]
4345   INIT("The %s function is unimplemented");
4346 EXTCONST char PL_no_myglob[]
4347   INIT("\"%s\" %se %s can't be in a package");
4348 EXTCONST char PL_no_localize_ref[]
4349   INIT("Can't localize through a reference");
4350 EXTCONST char PL_memory_wrap[]
4351   INIT("panic: memory wrap");
4352
4353 EXTCONST char PL_Yes[]
4354   INIT("1");
4355 EXTCONST char PL_No[]
4356   INIT("");
4357 EXTCONST char PL_Zero[]
4358   INIT("0");
4359 EXTCONST char PL_hexdigit[]
4360   INIT("0123456789abcdef0123456789ABCDEF");
4361
4362 /* This is constant on most architectures, a global on OS/2 */
4363 #ifndef OS2
4364 EXTCONST char PL_sh_path[]
4365   INIT(SH_PATH); /* full path of shell */
4366 #endif
4367
4368 #ifdef CSH
4369 EXTCONST char PL_cshname[]
4370   INIT(CSH);
4371 #  define PL_cshlen     (sizeof(CSH "") - 1)
4372 #endif
4373
4374 /* These are baked at compile time into any shared perl library.
4375    In future releases this will allow us in main() to sanity test the
4376    library we're linking against.  */
4377
4378 EXTCONST U8 PL_revision
4379   INIT(PERL_REVISION);
4380 EXTCONST U8 PL_version
4381   INIT(PERL_VERSION);
4382 EXTCONST U8 PL_subversion
4383   INIT(PERL_SUBVERSION);
4384
4385 EXTCONST char PL_uuemap[65]
4386   INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4387
4388 /* a special string address whose value is "isa", but which perl knows
4389  * to treat as if it were really "DOES" when printing the method name in
4390  *  the "Can't call method '%s'" error message */
4391 EXTCONST char PL_isa_DOES[]
4392   INIT("isa");
4393
4394 #ifdef DOINIT
4395 EXTCONST char PL_uudmap[256] =
4396 #  ifdef PERL_MICRO
4397 #    include "uuudmap.h"
4398 #  else
4399 #    include "uudmap.h"
4400 #  endif
4401 ;
4402 EXTCONST char PL_bitcount[256] =
4403 #  ifdef PERL_MICRO
4404 #    include "ubitcount.h"
4405 #else
4406 #    include "bitcount.h"
4407 #  endif
4408 ;
4409 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4410 EXTCONST int         PL_sig_num[]  = { SIG_NUM };
4411 #else
4412 EXTCONST char PL_uudmap[256];
4413 EXTCONST char PL_bitcount[256];
4414 EXTCONST char* const PL_sig_name[];
4415 EXTCONST int         PL_sig_num[];
4416 #endif
4417
4418 /* fast conversion and case folding tables.  The folding tables complement the
4419  * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4420  * folds such as outside the range or to multiple characters. */
4421
4422 #ifdef DOINIT
4423 #ifndef EBCDIC
4424
4425 /* The EBCDIC fold table depends on the code page, and hence is found in
4426  * utfebcdic.h */
4427
4428 EXTCONST  unsigned char PL_fold[] = {
4429         0,      1,      2,      3,      4,      5,      6,      7,
4430         8,      9,      10,     11,     12,     13,     14,     15,
4431         16,     17,     18,     19,     20,     21,     22,     23,
4432         24,     25,     26,     27,     28,     29,     30,     31,
4433         32,     33,     34,     35,     36,     37,     38,     39,
4434         40,     41,     42,     43,     44,     45,     46,     47,
4435         48,     49,     50,     51,     52,     53,     54,     55,
4436         56,     57,     58,     59,     60,     61,     62,     63,
4437         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4438         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4439         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4440         'x',    'y',    'z',    91,     92,     93,     94,     95,
4441         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4442         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4443         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4444         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4445         128,    129,    130,    131,    132,    133,    134,    135,
4446         136,    137,    138,    139,    140,    141,    142,    143,
4447         144,    145,    146,    147,    148,    149,    150,    151,
4448         152,    153,    154,    155,    156,    157,    158,    159,
4449         160,    161,    162,    163,    164,    165,    166,    167,
4450         168,    169,    170,    171,    172,    173,    174,    175,
4451         176,    177,    178,    179,    180,    181,    182,    183,
4452         184,    185,    186,    187,    188,    189,    190,    191,
4453         192,    193,    194,    195,    196,    197,    198,    199,
4454         200,    201,    202,    203,    204,    205,    206,    207,
4455         208,    209,    210,    211,    212,    213,    214,    215,
4456         216,    217,    218,    219,    220,    221,    222,    223,    
4457         224,    225,    226,    227,    228,    229,    230,    231,
4458         232,    233,    234,    235,    236,    237,    238,    239,
4459         240,    241,    242,    243,    244,    245,    246,    247,
4460         248,    249,    250,    251,    252,    253,    254,    255
4461 };
4462 EXTCONST  unsigned char PL_fold_latin1[] = {
4463     /* Full latin1 complement folding, except for three problematic code points:
4464      *  Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4465      *  fold complements outside the Latin1 range, so can't match something
4466      *  that isn't in utf8.
4467      *  German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4468      *  not one, so can't be represented in this table.
4469      *
4470      * All have to be specially handled */
4471         0,      1,      2,      3,      4,      5,      6,      7,
4472         8,      9,      10,     11,     12,     13,     14,     15,
4473         16,     17,     18,     19,     20,     21,     22,     23,
4474         24,     25,     26,     27,     28,     29,     30,     31,
4475         32,     33,     34,     35,     36,     37,     38,     39,
4476         40,     41,     42,     43,     44,     45,     46,     47,
4477         48,     49,     50,     51,     52,     53,     54,     55,
4478         56,     57,     58,     59,     60,     61,     62,     63,
4479         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4480         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4481         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4482         'x',    'y',    'z',    91,     92,     93,     94,     95,
4483         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4484         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4485         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4486         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4487         128,    129,    130,    131,    132,    133,    134,    135,
4488         136,    137,    138,    139,    140,    141,    142,    143,
4489         144,    145,    146,    147,    148,    149,    150,    151,
4490         152,    153,    154,    155,    156,    157,    158,    159,
4491         160,    161,    162,    163,    164,    165,    166,    167,
4492         168,    169,    170,    171,    172,    173,    174,    175,
4493         176,    177,    178,    179,    180,    181 /*micro */, 182,    183,
4494         184,    185,    186,    187,    188,    189,    190,    191,
4495         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4496         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4497         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4498         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
4499         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4500         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4501         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4502         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
4503         255 /* y with diaeresis */
4504 };
4505
4506 /* If these tables are accessed through ebcdic, the access will be converted to
4507  * latin1 first */
4508 EXTCONST  unsigned char PL_latin1_lc[] = {  /* lowercasing */
4509         0,      1,      2,      3,      4,      5,      6,      7,
4510         8,      9,      10,     11,     12,     13,     14,     15,
4511         16,     17,     18,     19,     20,     21,     22,     23,
4512         24,     25,     26,     27,     28,     29,     30,     31,
4513         32,     33,     34,     35,     36,     37,     38,     39,
4514         40,     41,     42,     43,     44,     45,     46,     47,
4515         48,     49,     50,     51,     52,     53,     54,     55,
4516         56,     57,     58,     59,     60,     61,     62,     63,
4517         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4518         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4519         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4520         'x',    'y',    'z',    91,     92,     93,     94,     95,
4521         96,     97,     98,     99,     100,    101,    102,    103,
4522         104,    105,    106,    107,    108,    109,    110,    111,
4523         112,    113,    114,    115,    116,    117,    118,    119,
4524         120,    121,    122,    123,    124,    125,    126,    127,
4525         128,    129,    130,    131,    132,    133,    134,    135,
4526         136,    137,    138,    139,    140,    141,    142,    143,
4527         144,    145,    146,    147,    148,    149,    150,    151,
4528         152,    153,    154,    155,    156,    157,    158,    159,
4529         160,    161,    162,    163,    164,    165,    166,    167,
4530         168,    169,    170,    171,    172,    173,    174,    175,
4531         176,    177,    178,    179,    180,    181,    182,    183,
4532         184,    185,    186,    187,    188,    189,    190,    191,
4533         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4534         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4535         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4536         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223,    
4537         224,    225,    226,    227,    228,    229,    230,    231,
4538         232,    233,    234,    235,    236,    237,    238,    239,
4539         240,    241,    242,    243,    244,    245,    246,    247,
4540         248,    249,    250,    251,    252,    253,    254,    255
4541 };
4542
4543 /* upper and title case of latin1 characters, modified so that the three tricky
4544  * ones are mapped to 255 (which is one of the three) */
4545 EXTCONST  unsigned char PL_mod_latin1_uc[] = {
4546         0,      1,      2,      3,      4,      5,      6,      7,
4547         8,      9,      10,     11,     12,     13,     14,     15,
4548         16,     17,     18,     19,     20,     21,     22,     23,
4549         24,     25,     26,     27,     28,     29,     30,     31,
4550         32,     33,     34,     35,     36,     37,     38,     39,
4551         40,     41,     42,     43,     44,     45,     46,     47,
4552         48,     49,     50,     51,     52,     53,     54,     55,
4553         56,     57,     58,     59,     60,     61,     62,     63,
4554         64,     65,     66,     67,     68,     69,     70,     71,
4555         72,     73,     74,     75,     76,     77,     78,     79,
4556         80,     81,     82,     83,     84,     85,     86,     87,
4557         88,     89,     90,     91,     92,     93,     94,     95,
4558         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4559         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4560         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4561         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4562         128,    129,    130,    131,    132,    133,    134,    135,
4563         136,    137,    138,    139,    140,    141,    142,    143,
4564         144,    145,    146,    147,    148,    149,    150,    151,
4565         152,    153,    154,    155,    156,    157,    158,    159,
4566         160,    161,    162,    163,    164,    165,    166,    167,
4567         168,    169,    170,    171,    172,    173,    174,    175,
4568         176,    177,    178,    179,    180,    255 /*micro*/,  182,    183,
4569         184,    185,    186,    187,    188,    189,    190,    191,
4570         192,    193,    194,    195,    196,    197,    198,    199,
4571         200,    201,    202,    203,    204,    205,    206,    207,
4572         208,    209,    210,    211,    212,    213,    214,    215,
4573         216,    217,    218,    219,    220,    221,    222,
4574 #if    UNICODE_MAJOR_VERSION > 2                                        \
4575    || (UNICODE_MAJOR_VERSION == 2 && UNICODE_DOT_VERSION >= 1           \
4576                                   && UNICODE_DOT_DOT_VERSION >= 8)
4577                                                                 255 /*sharp s*/,
4578 #else   /* uc() is itself in early unicode */
4579                                                                 223,
4580 #endif
4581         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4582         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4583         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4584         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32, 255
4585 };
4586 #endif  /* !EBCDIC, but still in DOINIT */
4587 #else   /* ! DOINIT */
4588 #   ifndef EBCDIC
4589 EXTCONST unsigned char PL_fold[];
4590 EXTCONST unsigned char PL_fold_latin1[];
4591 EXTCONST unsigned char PL_mod_latin1_uc[];
4592 EXTCONST unsigned char PL_latin1_lc[];
4593 #   endif
4594 #endif
4595
4596 #ifndef PERL_GLOBAL_STRUCT /* or perlvars.h */
4597 #ifdef DOINIT
4598 EXT unsigned char PL_fold_locale[] = { /* Unfortunately not EXTCONST. */
4599         0,      1,      2,      3,      4,      5,      6,      7,
4600         8,      9,      10,     11,     12,     13,     14,     15,
4601         16,     17,     18,     19,     20,     21,     22,     23,
4602         24,     25,     26,     27,     28,     29,     30,     31,
4603         32,     33,     34,     35,     36,     37,     38,     39,
4604         40,     41,     42,     43,     44,     45,     46,     47,
4605         48,     49,     50,     51,     52,     53,     54,     55,
4606         56,     57,     58,     59,     60,     61,     62,     63,
4607         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4608         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4609         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4610         'x',    'y',    'z',    91,     92,     93,     94,     95,
4611         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4612         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4613         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4614         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4615         128,    129,    130,    131,    132,    133,    134,    135,
4616         136,    137,    138,    139,    140,    141,    142,    143,
4617         144,    145,    146,    147,    148,    149,    150,    151,
4618         152,    153,    154,    155,    156,    157,    158,    159,
4619         160,    161,    162,    163,    164,    165,    166,    167,
4620         168,    169,    170,    171,    172,    173,    174,    175,
4621         176,    177,    178,    179,    180,    181,    182,    183,
4622         184,    185,    186,    187,    188,    189,    190,    191,
4623         192,    193,    194,    195,    196,    197,    198,    199,
4624         200,    201,    202,    203,    204,    205,    206,    207,
4625         208,    209,    210,    211,    212,    213,    214,    215,
4626         216,    217,    218,    219,    220,    221,    222,    223,    
4627         224,    225,    226,    227,    228,    229,    230,    231,
4628         232,    233,    234,    235,    236,    237,    238,    239,
4629         240,    241,    242,    243,    244,    245,    246,    247,
4630         248,    249,    250,    251,    252,    253,    254,    255
4631 };
4632 #else
4633 EXT unsigned char PL_fold_locale[]; /* Unfortunately not EXTCONST. */
4634 #endif
4635 #endif /* !PERL_GLOBAL_STRUCT */
4636
4637 #ifdef DOINIT
4638 #ifdef EBCDIC
4639 EXTCONST unsigned char PL_freq[] = {/* EBCDIC frequencies for mixed English/C */
4640     1,      2,      84,     151,    154,    155,    156,    157,
4641     165,    246,    250,    3,      158,    7,      18,     29,
4642     40,     51,     62,     73,     85,     96,     107,    118,
4643     129,    140,    147,    148,    149,    150,    152,    153,
4644     255,      6,      8,      9,     10,     11,     12,     13,
4645      14,     15,     24,     25,     26,     27,     28,    226,
4646      29,     30,     31,     32,     33,     43,     44,     45,
4647      46,     47,     48,     49,     50,     76,     77,     78,
4648      79,     80,     81,     82,     83,     84,     85,     86,
4649      87,     94,     95,    234,    181,    233,    187,    190,
4650     180,     96,     97,     98,     99,    100,    101,    102,
4651     104,    112,    182,    174,    236,    232,    229,    103,
4652     228,    226,    114,    115,    116,    117,    118,    119,
4653     120,    121,    122,    235,    176,    230,    194,    162,
4654     130,    131,    132,    133,    134,    135,    136,    137,
4655     138,    139,    201,    205,    163,    217,    220,    224,
4656     5,      248,    227,    244,    242,    255,    241,    231,
4657     240,    253,    16,     197,    19,     20,     21,     187,
4658     23,     169,    210,    245,    237,    249,    247,    239,
4659     168,    252,    34,     196,    36,     37,     38,     39,
4660     41,     42,     251,    254,    238,    223,    221,    213,
4661     225,    177,    52,     53,     54,     55,     56,     57,
4662     58,     59,     60,     61,     63,     64,     65,     66,
4663     67,     68,     69,     70,     71,     72,     74,     75,
4664     205,    208,    186,    202,    200,    218,    198,    179,
4665     178,    214,    88,     89,     90,     91,     92,     93,
4666     217,    166,    170,    207,    199,    209,    206,    204,
4667     160,    212,    105,    106,    108,    109,    110,    111,
4668     203,    113,    216,    215,    192,    175,    193,    243,
4669     172,    161,    123,    124,    125,    126,    127,    128,
4670     222,    219,    211,    195,    188,    193,    185,    184,
4671     191,    183,    141,    142,    143,    144,    145,    146
4672 };
4673 #else  /* ascii rather than ebcdic */
4674 EXTCONST unsigned char PL_freq[] = {    /* letter frequencies for mixed English/C */
4675         1,      2,      84,     151,    154,    155,    156,    157,
4676         165,    246,    250,    3,      158,    7,      18,     29,
4677         40,     51,     62,     73,     85,     96,     107,    118,
4678         129,    140,    147,    148,    149,    150,    152,    153,
4679         255,    182,    224,    205,    174,    176,    180,    217,
4680         233,    232,    236,    187,    235,    228,    234,    226,
4681         222,    219,    211,    195,    188,    193,    185,    184,
4682         191,    183,    201,    229,    181,    220,    194,    162,
4683         163,    208,    186,    202,    200,    218,    198,    179,
4684         178,    214,    166,    170,    207,    199,    209,    206,
4685         204,    160,    212,    216,    215,    192,    175,    173,
4686         243,    172,    161,    190,    203,    189,    164,    230,
4687         167,    248,    227,    244,    242,    255,    241,    231,
4688         240,    253,    169,    210,    245,    237,    249,    247,
4689         239,    168,    252,    251,    254,    238,    223,    221,
4690         213,    225,    177,    197,    171,    196,    159,    4,
4691         5,      6,      8,      9,      10,     11,     12,     13,
4692         14,     15,     16,     17,     19,     20,     21,     22,
4693         23,     24,     25,     26,     27,     28,     30,     31,
4694         32,     33,     34,     35,     36,     37,     38,     39,
4695         41,     42,     43,     44,     45,     46,     47,     48,
4696         49,     50,     52,     53,     54,     55,     56,     57,
4697         58,     59,     60,     61,     63,     64,     65,     66,
4698         67,     68,     69,     70,     71,     72,     74,     75,
4699         76,     77,     78,     79,     80,     81,     82,     83,
4700         86,     87,     88,     89,     90,     91,     92,     93,
4701         94,     95,     97,     98,     99,     100,    101,    102,
4702         103,    104,    105,    106,    108,    109,    110,    111,
4703         112,    113,    114,    115,    116,    117,    119,    120,
4704         121,    122,    123,    124,    125,    126,    127,    128,
4705         130,    131,    132,    133,    134,    135,    136,    137,
4706         138,    139,    141,    142,    143,    144,    145,    146
4707 };
4708 #endif
4709 #else
4710 EXTCONST unsigned char PL_freq[];
4711 #endif
4712
4713 /* Although only used for debugging, these constants must be available in
4714  * non-debugging builds too, since they're used in ext/re/re_exec.c,
4715  * which has DEBUGGING enabled always */
4716 #ifdef DOINIT
4717 EXTCONST char* const PL_block_type[] = {
4718         "NULL",
4719         "WHEN",
4720         "BLOCK",
4721         "GIVEN",
4722         "LOOP_ARY",
4723         "LOOP_LAZYSV",
4724         "LOOP_LAZYIV",
4725         "LOOP_LIST",
4726         "LOOP_PLAIN",
4727         "SUB",
4728         "FORMAT",
4729         "EVAL",
4730         "SUBST"
4731 };
4732 #else
4733 EXTCONST char* PL_block_type[];
4734 #endif
4735
4736 /* These are all the compile time options that affect binary compatibility.
4737    Other compile time options that are binary compatible are in perl.c
4738    (in S_Internals_V()). Both are combined for the output of perl -V
4739    However, this string will be embedded in any shared perl library, which will
4740    allow us add a comparison check in perlmain.c in the near future.  */
4741 #ifdef DOINIT
4742 EXTCONST char PL_bincompat_options[] =
4743 #  ifdef DEBUG_LEAKING_SCALARS
4744                              " DEBUG_LEAKING_SCALARS"
4745 #  endif
4746 #  ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4747                              " DEBUG_LEAKING_SCALARS_FORK_DUMP"
4748 #  endif
4749 #  ifdef FCRYPT
4750                              " FCRYPT"
4751 #  endif
4752 #  ifdef HAS_TIMES
4753                              " HAS_TIMES"
4754 #  endif
4755 #  ifdef HAVE_INTERP_INTERN
4756                              " HAVE_INTERP_INTERN"
4757 #  endif
4758 #  ifdef MULTIPLICITY
4759                              " MULTIPLICITY"
4760 #  endif
4761 #  ifdef MYMALLOC
4762                              " MYMALLOC"
4763 #  endif
4764 #  ifdef PERLIO_LAYERS
4765                              " PERLIO_LAYERS"
4766 #  endif
4767 #  ifdef PERL_DEBUG_READONLY_COW
4768                              " PERL_DEBUG_READONLY_COW"
4769 #  endif
4770 #  ifdef PERL_DEBUG_READONLY_OPS
4771                              " PERL_DEBUG_READONLY_OPS"
4772 #  endif
4773 #  ifdef PERL_GLOBAL_STRUCT
4774                              " PERL_GLOBAL_STRUCT"
4775 #  endif
4776 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
4777                              " PERL_GLOBAL_STRUCT_PRIVATE"
4778 #  endif
4779 #  ifdef PERL_IMPLICIT_CONTEXT
4780                              " PERL_IMPLICIT_CONTEXT"
4781 #  endif
4782 #  ifdef PERL_IMPLICIT_SYS
4783                              " PERL_IMPLICIT_SYS"
4784 #  endif
4785 #  ifdef PERL_MICRO
4786                     &nbs