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