This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
POSIX math: more hypot tests.
[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 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || defined(_STDC_C99)
32 #  define HAS_C99 1
33 #endif
34
35 /* See L<perlguts/"The Perl API"> for detailed notes on
36  * PERL_IMPLICIT_CONTEXT and PERL_IMPLICIT_SYS */
37
38 /* Note that from here --> to <-- the same logic is
39  * repeated in makedef.pl, so be certain to update
40  * both places when editing. */
41
42 #ifdef USE_ITHREADS
43 #  if !defined(MULTIPLICITY)
44 #    define MULTIPLICITY
45 #  endif
46 #endif
47
48 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
49 #  ifndef PERL_GLOBAL_STRUCT
50 #    define PERL_GLOBAL_STRUCT
51 #  endif
52 #endif
53
54 #ifdef PERL_GLOBAL_STRUCT
55 #  ifndef MULTIPLICITY
56 #    define MULTIPLICITY
57 #  endif
58 #endif
59
60 #ifdef MULTIPLICITY
61 #  ifndef PERL_IMPLICIT_CONTEXT
62 #    define PERL_IMPLICIT_CONTEXT
63 #  endif
64 #endif
65
66 /* undef WIN32 when building on Cygwin (for libwin32) - gph */
67 #ifdef __CYGWIN__
68 #   undef WIN32
69 #   undef _WIN32
70 #endif
71
72 #if defined(__SYMBIAN32__) || (defined(__VC32__) && defined(WINS))
73 #   ifndef SYMBIAN
74 #       define SYMBIAN
75 #   endif
76 #endif
77
78 #ifdef __SYMBIAN32__
79 #  include "symbian/symbian_proto.h"
80 #endif
81
82 /* Any stack-challenged places.  The limit varies (and often
83  * is configurable), but using more than a kilobyte of stack
84  * is usually dubious in these systems. */
85 #if defined(__SYMBIAN32__)
86 /* Symbian: need to work around the SDK features. *
87  * On WINS: MS VC5 generates calls to _chkstk,         *
88  * if a "large" stack frame is allocated.              *
89  * gcc on MARM does not generate calls like these.     */
90 #   define USE_HEAP_INSTEAD_OF_STACK
91 #endif
92
93 /* Use the reentrant APIs like localtime_r and getpwent_r */
94 /* Win32 has naturally threadsafe libraries, no need to use any _r variants. */
95 #if defined(USE_ITHREADS) && !defined(USE_REENTRANT_API) && !defined(NETWARE) && !defined(WIN32) && !defined(PERL_DARWIN)
96 #   define USE_REENTRANT_API
97 #endif
98
99 /* <--- here ends the logic shared by perl.h and makedef.pl */
100
101 /* Microsoft Visual C++ 6.0 needs special treatment in numerous places */
102 #if defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1200 && _MSC_VER < 1300
103 #  define USING_MSVC6
104 #endif
105
106 #undef START_EXTERN_C
107 #undef END_EXTERN_C
108 #undef EXTERN_C
109 #ifdef __cplusplus
110 #  define START_EXTERN_C extern "C" {
111 #  define END_EXTERN_C }
112 #  define EXTERN_C extern "C"
113 #else
114 #  define START_EXTERN_C
115 #  define END_EXTERN_C
116 #  define EXTERN_C extern
117 #endif
118
119 /* Fallback definitions in case we don't have definitions from config.h.
120    This should only matter for systems that don't use Configure and
121    haven't been modified to define PERL_STATIC_INLINE yet.
122 */
123 #if !defined(PERL_STATIC_INLINE)
124 #  ifdef HAS_STATIC_INLINE
125 #    define PERL_STATIC_INLINE static inline
126 #  else
127 #    define PERL_STATIC_INLINE static
128 #  endif
129 #endif
130
131 #ifdef PERL_GLOBAL_STRUCT
132 #  ifndef PERL_GET_VARS
133 #    ifdef PERL_GLOBAL_STRUCT_PRIVATE
134        EXTERN_C struct perl_vars* Perl_GetVarsPrivate();
135 #      define PERL_GET_VARS() Perl_GetVarsPrivate() /* see miniperlmain.c */
136 #      ifndef PERLIO_FUNCS_CONST
137 #        define PERLIO_FUNCS_CONST /* Can't have these lying around. */
138 #      endif
139 #    else
140 #      define PERL_GET_VARS() PL_VarsPtr
141 #    endif
142 #  endif
143 #endif
144
145 #define pVAR    struct perl_vars* my_vars PERL_UNUSED_DECL
146
147 #ifdef PERL_GLOBAL_STRUCT
148 #  define dVAR          pVAR    = (struct perl_vars*)PERL_GET_VARS()
149 #else
150 #  define dVAR          dNOOP
151 #endif
152
153 #ifdef PERL_IMPLICIT_CONTEXT
154 #  ifndef MULTIPLICITY
155 #    define MULTIPLICITY
156 #  endif
157 #  define tTHX  PerlInterpreter*
158 #  define pTHX  tTHX my_perl PERL_UNUSED_DECL
159 #  define aTHX  my_perl
160 #  define aTHXa(a) aTHX = (tTHX)a
161 #  ifdef PERL_GLOBAL_STRUCT
162 #    define dTHXa(a)    dVAR; pTHX = (tTHX)a
163 #  else
164 #    define dTHXa(a)    pTHX = (tTHX)a
165 #  endif
166 #  ifdef PERL_GLOBAL_STRUCT
167 #    define dTHX                dVAR; pTHX = PERL_GET_THX
168 #  else
169 #    define dTHX                pTHX = PERL_GET_THX
170 #  endif
171 #  define pTHX_         pTHX,
172 #  define aTHX_         aTHX,
173 #  define pTHX_1        2
174 #  define pTHX_2        3
175 #  define pTHX_3        4
176 #  define pTHX_4        5
177 #  define pTHX_5        6
178 #  define pTHX_6        7
179 #  define pTHX_7        8
180 #  define pTHX_8        9
181 #  define pTHX_9        10
182 #  define pTHX_12       13
183 #  if defined(DEBUGGING) && !defined(PERL_TRACK_MEMPOOL)
184 #    define PERL_TRACK_MEMPOOL
185 #  endif
186 #else
187 #  undef PERL_TRACK_MEMPOOL
188 #endif
189
190 #define STATIC static
191
192 #ifndef PERL_CORE
193 /* Do not use these macros. They were part of PERL_OBJECT, which was an
194  * implementation of multiplicity using C++ objects. They have been left
195  * here solely for the sake of XS code which has incorrectly
196  * cargo-culted them.
197  */
198 #define CPERLscope(x) x
199 #define CPERLarg void
200 #define CPERLarg_
201 #define _CPERLarg
202 #define PERL_OBJECT_THIS
203 #define _PERL_OBJECT_THIS
204 #define PERL_OBJECT_THIS_
205 #define CALL_FPTR(fptr) (*fptr)
206 #define MEMBER_TO_FPTR(name) name
207 #endif /* !PERL_CORE */
208
209 #define CALLRUNOPS  PL_runops
210
211 #define CALLREGCOMP(sv, flags) Perl_pregcomp(aTHX_ (sv),(flags))
212
213 #define CALLREGCOMP_ENG(prog, sv, flags) (prog)->comp(aTHX_ sv, flags)
214 #define CALLREGEXEC(prog,stringarg,strend,strbeg,minend,sv,data,flags) \
215     RX_ENGINE(prog)->exec(aTHX_ (prog),(stringarg),(strend), \
216         (strbeg),(minend),(sv),(data),(flags))
217 #define CALLREG_INTUIT_START(prog,sv,strbeg,strpos,strend,flags,data) \
218     RX_ENGINE(prog)->intuit(aTHX_ (prog), (sv), (strbeg), (strpos), \
219         (strend),(flags),(data))
220 #define CALLREG_INTUIT_STRING(prog) \
221     RX_ENGINE(prog)->checkstr(aTHX_ (prog))
222
223 #define CALLREGFREE(prog) \
224     Perl_pregfree(aTHX_ (prog))
225
226 #define CALLREGFREE_PVT(prog) \
227     if(prog) RX_ENGINE(prog)->free(aTHX_ (prog))
228
229 #define CALLREG_NUMBUF_FETCH(rx,paren,usesv)                                \
230     RX_ENGINE(rx)->numbered_buff_FETCH(aTHX_ (rx),(paren),(usesv))
231
232 #define CALLREG_NUMBUF_STORE(rx,paren,value) \
233     RX_ENGINE(rx)->numbered_buff_STORE(aTHX_ (rx),(paren),(value))
234
235 #define CALLREG_NUMBUF_LENGTH(rx,sv,paren)                              \
236     RX_ENGINE(rx)->numbered_buff_LENGTH(aTHX_ (rx),(sv),(paren))
237
238 #define CALLREG_NAMED_BUFF_FETCH(rx, key, flags) \
239     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_FETCH))
240
241 #define CALLREG_NAMED_BUFF_STORE(rx, key, value, flags) \
242     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), (value), ((flags) | RXapif_STORE))
243
244 #define CALLREG_NAMED_BUFF_DELETE(rx, key, flags) \
245     RX_ENGINE(rx)->named_buff(aTHX_ (rx),(key), NULL, ((flags) | RXapif_DELETE))
246
247 #define CALLREG_NAMED_BUFF_CLEAR(rx, flags) \
248     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_CLEAR))
249
250 #define CALLREG_NAMED_BUFF_EXISTS(rx, key, flags) \
251     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_EXISTS))
252
253 #define CALLREG_NAMED_BUFF_FIRSTKEY(rx, flags) \
254     RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), NULL, ((flags) | RXapif_FIRSTKEY))
255
256 #define CALLREG_NAMED_BUFF_NEXTKEY(rx, lastkey, flags) \
257     RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), (lastkey), ((flags) | RXapif_NEXTKEY))
258
259 #define CALLREG_NAMED_BUFF_SCALAR(rx, flags) \
260     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_SCALAR))
261
262 #define CALLREG_NAMED_BUFF_COUNT(rx) \
263     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, RXapif_REGNAMES_COUNT)
264
265 #define CALLREG_NAMED_BUFF_ALL(rx, flags) \
266     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, flags)
267
268 #define CALLREG_PACKAGE(rx) \
269     RX_ENGINE(rx)->qr_package(aTHX_ (rx))
270
271 #if defined(USE_ITHREADS)
272 #define CALLREGDUPE(prog,param) \
273     Perl_re_dup(aTHX_ (prog),(param))
274
275 #define CALLREGDUPE_PVT(prog,param) \
276     (prog ? RX_ENGINE(prog)->dupe(aTHX_ (prog),(param)) \
277           : (REGEXP *)NULL)
278 #endif
279
280
281
282
283
284 /*
285  * Because of backward compatibility reasons the PERL_UNUSED_DECL
286  * cannot be changed from postfix to PERL_UNUSED_DECL(x).  Sigh.
287  *
288  * Note that there are C compilers such as MetroWerks CodeWarrior
289  * which do not have an "inlined" way (like the gcc __attribute__) of
290  * marking unused variables (they need e.g. a #pragma) and therefore
291  * cpp macros like PERL_UNUSED_DECL cannot work for this purpose, even
292  * if it were PERL_UNUSED_DECL(x), which it cannot be (see above).
293  *
294  */
295
296 #if defined(__SYMBIAN32__) && defined(__GNUC__)
297 #  ifdef __cplusplus
298 #    define PERL_UNUSED_DECL
299 #  else
300 #    define PERL_UNUSED_DECL __attribute__((unused))
301 #  endif
302 #endif
303
304 #ifndef PERL_UNUSED_DECL
305 #  if defined(HASATTRIBUTE_UNUSED) && !defined(__cplusplus)
306 #    define PERL_UNUSED_DECL __attribute__unused__
307 #  else
308 #    define PERL_UNUSED_DECL
309 #  endif
310 #endif
311
312 /* gcc -Wall:
313  * for silencing unused variables that are actually used most of the time,
314  * but we cannot quite get rid of, such as "ax" in PPCODE+noargs xsubs
315  */
316 #ifndef PERL_UNUSED_ARG
317 #  if defined(lint) && defined(S_SPLINT_S) /* www.splint.org */
318 #    include <note.h>
319 #    define PERL_UNUSED_ARG(x) NOTE(ARGUNUSED(x))
320 #  else
321 #    define PERL_UNUSED_ARG(x) ((void)x)
322 #  endif
323 #endif
324 #ifndef PERL_UNUSED_VAR
325 #  define PERL_UNUSED_VAR(x) ((void)x)
326 #endif
327
328 #if defined(USE_ITHREADS) || defined(PERL_GLOBAL_STRUCT)
329 #  define PERL_UNUSED_CONTEXT PERL_UNUSED_ARG(my_perl)
330 #else
331 #  define PERL_UNUSED_CONTEXT
332 #endif
333
334 /* gcc (-ansi) -pedantic doesn't allow gcc statement expressions,
335  * g++ allows them but seems to have problems with them
336  * (insane errors ensue).
337  * g++ does not give insane errors now (RMB 2008-01-30, gcc 4.2.2).
338  */
339 #if defined(PERL_GCC_PEDANTIC) || \
340     (defined(__GNUC__) && defined(__cplusplus) && \
341         ((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2))))
342 #  ifndef PERL_GCC_BRACE_GROUPS_FORBIDDEN
343 #    define PERL_GCC_BRACE_GROUPS_FORBIDDEN
344 #  endif
345 #endif
346
347 /* Use PERL_UNUSED_RESULT() to suppress the warnings about unused results
348  * of function calls, e.g. PERL_UNUSED_RESULT(foo(a, b)).
349  *
350  * The main reason for this is that the combination of gcc -Wunused-result
351  * (part of -Wall) and the __attribute__((warn_unused_result)) cannot
352  * be silenced with casting to void.  This causes trouble when the system
353  * header files use the attribute.
354  *
355  * Use PERL_UNUSED_RESULT sparingly, though, since usually the warning
356  * is there for a good reason: you might lose success/failure information,
357  * or leak resources, or changes in resources.
358  *
359  * But sometimes you just want to ignore the return value, e.g. on
360  * codepaths soon ending up in abort, or in "best effort" attempts,
361  * or in situations where there is no good way to handle failures.
362  *
363  * Sometimes PERL_UNUSED_RESULT might not be the most natural way:
364  * another possibility is that you can capture the return value
365  * and use PERL_UNUSED_VAR on that.
366  *
367  * The __typeof__() is used instead of typeof() since typeof() is not
368  * available under strict C89, and because of compilers masquerading
369  * as gcc (clang and icc), we want exactly the gcc extension
370  * __typeof__ and nothing else.
371  */
372 #ifndef PERL_UNUSED_RESULT
373 #  if defined(__GNUC__) && defined(HASATTRIBUTE_WARN_UNUSED_RESULT)
374 #    define PERL_UNUSED_RESULT(v) STMT_START { __typeof__(v) z = (v); (void)sizeof(z); } STMT_END
375 #  else
376 #    define PERL_UNUSED_RESULT(v) ((void)(v))
377 #  endif
378 #endif
379
380 /* on gcc (and clang), specify that a warning should be temporarily
381  * ignored; e.g.
382  *
383  *    GCC_DIAG_IGNORE(-Wmultichar);
384  *    char b = 'ab';
385  *    GCC_DIAG_RESTORE;
386  *
387  * based on http://dbp-consulting.com/tutorials/SuppressingGCCWarnings.html
388  *
389  * Note that "pragma GCC diagnostic push/pop" was added in GCC 4.6, Mar 2011;
390  * clang only pretends to be GCC 4.2, but still supports push/pop.
391  *
392  * Note on usage: on non-gcc (or lookalike, like clang) compilers
393  * one cannot use these at file (global) level without warnings
394  * since they are defined as empty, which leads into the terminating
395  * semicolon being left alone on a line:
396  * ;
397  * which makes compilers mildly cranky.  Therefore at file level one
398  * should use the GCC_DIAG_IGNORE and GCC_DIAG_RESTORE_FILE *without*
399  * the semicolons.
400  *
401  * (A dead-on-arrival solution would be to try to define the macros as
402  * NOOP or dNOOP, those don't work both inside functions and outside.)
403  */
404
405 #if defined(__clang__) || defined(__clang) || \
406        (defined( __GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406)
407 #  define GCC_DIAG_PRAGMA(x) _Pragma (#x)
408 /* clang has "clang diagnostic" pragmas, but also understands gcc. */
409 #  define GCC_DIAG_IGNORE(x) _Pragma("GCC diagnostic push") \
410                              GCC_DIAG_PRAGMA(GCC diagnostic ignored #x)
411 #  define GCC_DIAG_RESTORE   _Pragma("GCC diagnostic pop")
412 #else
413 #  define GCC_DIAG_IGNORE(w)
414 #  define GCC_DIAG_RESTORE
415 #endif
416
417 #define NOOP /*EMPTY*/(void)0
418 /* cea2e8a9dd23747f accidentally lost the comment originally from the first
419    check in of thread.h, explaining why we need dNOOP at all:  */
420 /* Rats: if dTHR is just blank then the subsequent ";" throws an error */
421 /* Declaring a *function*, instead of a variable, ensures that we don't rely
422    on being able to suppress "unused" warnings.  */
423 #ifdef __cplusplus
424 #define dNOOP (void)0
425 #else
426 #define dNOOP extern int Perl___notused(void)
427 #endif
428
429 #ifndef pTHX
430 /* Don't bother defining tTHX ; using it outside
431  * code guarded by PERL_IMPLICIT_CONTEXT is an error.
432  */
433 #  define pTHX          void
434 #  define pTHX_
435 #  define aTHX
436 #  define aTHX_
437 #  define aTHXa(a)      NOOP
438 #  define dTHXa(a)      dNOOP
439 #  define dTHX          dNOOP
440 #  define pTHX_1        1       
441 #  define pTHX_2        2
442 #  define pTHX_3        3
443 #  define pTHX_4        4
444 #  define pTHX_5        5
445 #  define pTHX_6        6
446 #  define pTHX_7        7
447 #  define pTHX_8        8
448 #  define pTHX_9        9
449 #  define pTHX_12       12
450 #endif
451
452 #ifndef dVAR
453 #  define dVAR          dNOOP
454 #endif
455
456 /* these are only defined for compatibility; should not be used internally */
457 #if !defined(pTHXo) && !defined(PERL_CORE)
458 #  define pTHXo         pTHX
459 #  define pTHXo_        pTHX_
460 #  define aTHXo         aTHX
461 #  define aTHXo_        aTHX_
462 #  define dTHXo         dTHX
463 #  define dTHXoa(x)     dTHXa(x)
464 #endif
465
466 #ifndef pTHXx
467 #  define pTHXx         PerlInterpreter *my_perl
468 #  define pTHXx_        pTHXx,
469 #  define aTHXx         my_perl
470 #  define aTHXx_        aTHXx,
471 #  define dTHXx         dTHX
472 #endif
473
474 /* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
475  * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
476  * dTHXs is therefore needed for all functions using PerlIO_foo(). */
477 #ifdef PERL_IMPLICIT_SYS
478 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
479 #    define dTHXs               dVAR; dTHX
480 #  else
481 #    define dTHXs               dTHX
482 #  endif
483 #else
484 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
485 #    define dTHXs               dVAR
486 #  else
487 #    define dTHXs               dNOOP
488 #  endif
489 #endif
490
491 /* Some platforms require marking function declarations
492  * for them to be exportable.  Used in perlio.h, proto.h
493  * is handled either by the makedef.pl or by defining the
494  * PERL_CALLCONV to be something special.  See also the
495  * definition of XS() in XSUB.h. */
496 #ifndef PERL_EXPORT_C
497 #  ifdef __cplusplus
498 #    define PERL_EXPORT_C extern "C"
499 #  else
500 #    define PERL_EXPORT_C extern
501 #  endif
502 #endif
503 #ifndef PERL_XS_EXPORT_C
504 #  ifdef __cplusplus
505 #    define PERL_XS_EXPORT_C extern "C"
506 #  else
507 #    define PERL_XS_EXPORT_C
508 #  endif
509 #endif
510
511 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
512 #  ifndef PERL_USE_GCC_BRACE_GROUPS
513 #    define PERL_USE_GCC_BRACE_GROUPS
514 #  endif
515 #endif
516
517 /*
518  * STMT_START { statements; } STMT_END;
519  * can be used as a single statement, as in
520  * if (x) STMT_START { ... } STMT_END; else ...
521  *
522  * Trying to select a version that gives no warnings...
523  */
524 #if !(defined(STMT_START) && defined(STMT_END))
525 # ifdef PERL_USE_GCC_BRACE_GROUPS
526 #   define STMT_START   (void)( /* gcc supports "({ STATEMENTS; })" */
527 #   define STMT_END     )
528 # else
529 #   define STMT_START   do
530 #   define STMT_END     while (0)
531 # endif
532 #endif
533
534 #ifndef BYTEORDER  /* Should never happen -- byteorder is in config.h */
535 #   define BYTEORDER 0x1234
536 #endif
537
538 /* Overall memory policy? */
539 #ifndef CONSERVATIVE
540 #   define LIBERAL 1
541 #endif
542
543 #if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
544 #define ASCIIish
545 #else
546 #undef  ASCIIish
547 #endif
548
549 /*
550  * The following contortions are brought to you on behalf of all the
551  * standards, semi-standards, de facto standards, not-so-de-facto standards
552  * of the world, as well as all the other botches anyone ever thought of.
553  * The basic theory is that if we work hard enough here, the rest of the
554  * code can be a lot prettier.  Well, so much for theory.  Sorry, Henry...
555  */
556
557 /* define this once if either system, instead of cluttering up the src */
558 #if defined(MSDOS) || defined(WIN32) || defined(NETWARE)
559 #define DOSISH 1
560 #endif
561
562 #if defined(__STDC__) || defined(_AIX) || defined(__stdc__) || defined(__cplusplus) || defined(NETWARE) || defined(__SYMBIAN32__)
563 # define STANDARD_C 1
564 #endif
565
566 #if defined(__cplusplus) || defined(WIN32) || defined(__sgi) || defined(__EMX__) || defined(__QNX__) || defined(NETWARE) || defined(PERL_MICRO)
567 # define DONT_DECLARE_STD 1
568 #endif
569
570 #if defined(HASVOLATILE) || defined(STANDARD_C)
571 #       define VOL volatile
572 #else
573 #   define VOL
574 #endif
575
576 /* By compiling a perl with -DNO_TAINT_SUPPORT or -DSILENT_NO_TAINT_SUPPORT,
577  * you get a perl without taint support, but doubtlessly with a lesser
578  * degree of support. Do not do so unless you know exactly what it means
579  * technically, have a good reason to do so, and know exactly how the
580  * perl will be used. perls with -DSILENT_NO_TAINT_SUPPORT are considered
581  * a potential security risk due to flat out ignoring the security-relevant
582  * taint flags. This being said, a perl without taint support compiled in
583  * has marginal run-time performance benefits.
584  * SILENT_NO_TAINT_SUPPORT implies NO_TAINT_SUPPORT.
585  * SILENT_NO_TAINT_SUPPORT is the same as NO_TAINT_SUPPORT except it
586  * silently ignores -t/-T instead of throwing an exception.
587  *
588  * DANGER! Using NO_TAINT_SUPPORT or SILENT_NO_TAINT_SUPPORT
589  *         voids your nonexistent warranty!
590  */
591 #if defined(SILENT_NO_TAINT_SUPPORT) && !defined(NO_TAINT_SUPPORT)
592 #  define NO_TAINT_SUPPORT 1
593 #endif
594
595 /* NO_TAINT_SUPPORT can be set to transform virtually all taint-related
596  * operations into no-ops for a very modest speed-up. Enable only if you
597  * know what you're doing: tests and CPAN modules' tests are bound to fail.
598  */
599 #ifdef NO_TAINT_SUPPORT
600 #   define TAINT                NOOP
601 #   define TAINT_NOT            NOOP
602 #   define TAINT_IF(c)          NOOP
603 #   define TAINT_ENV()          NOOP
604 #   define TAINT_PROPER(s)      NOOP
605 #   define TAINT_set(s)         NOOP
606 #   define TAINT_get            0
607 #   define TAINTING_get         0
608 #   define TAINTING_set(s)      NOOP
609 #   define TAINT_WARN_get       0
610 #   define TAINT_WARN_set(s)    NOOP
611 #else
612 #   define TAINT                (PL_tainted = TRUE)
613 #   define TAINT_NOT    (PL_tainted = FALSE)
614 #   define TAINT_IF(c)  if (UNLIKELY(c)) { PL_tainted = TRUE; }
615 #   define TAINT_ENV()  if (UNLIKELY(PL_tainting)) { taint_env(); }
616 #   define TAINT_PROPER(s)      if (UNLIKELY(PL_tainting)) { taint_proper(NULL, s); }
617 #   define TAINT_set(s)         (PL_tainted = (s))
618 #   define TAINT_get            (PL_tainted)
619 #   define TAINTING_get         (PL_tainting)
620 #   define TAINTING_set(s)      (PL_tainting = (s))
621 #   define TAINT_WARN_get       (PL_taint_warn)
622 #   define TAINT_WARN_set(s)    (PL_taint_warn = (s))
623 #endif
624
625 /* flags used internally only within pp_subst and pp_substcont */
626 #ifdef PERL_CORE
627 #  define SUBST_TAINT_STR      1        /* string tainted */
628 #  define SUBST_TAINT_PAT      2        /* pattern tainted */
629 #  define SUBST_TAINT_REPL     4        /* replacement tainted */
630 #  define SUBST_TAINT_RETAINT  8        /* use re'taint' in scope */
631 #  define SUBST_TAINT_BOOLRET 16        /* return is boolean (don't taint) */
632 #endif
633
634 /* XXX All process group stuff is handled in pp_sys.c.  Should these
635    defines move there?  If so, I could simplify this a lot. --AD  9/96.
636 */
637 /* Process group stuff changed from traditional BSD to POSIX.
638    perlfunc.pod documents the traditional BSD-style syntax, so we'll
639    try to preserve that, if possible.
640 */
641 #ifdef HAS_SETPGID
642 #  define BSD_SETPGRP(pid, pgrp)        setpgid((pid), (pgrp))
643 #else
644 #  if defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
645 #    define BSD_SETPGRP(pid, pgrp)      setpgrp((pid), (pgrp))
646 #  else
647 #    ifdef HAS_SETPGRP2  /* DG/UX */
648 #      define BSD_SETPGRP(pid, pgrp)    setpgrp2((pid), (pgrp))
649 #    endif
650 #  endif
651 #endif
652 #if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
653 #  define HAS_SETPGRP  /* Well, effectively it does . . . */
654 #endif
655
656 /* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
657     our life easier :-) so we'll try it.
658 */
659 #ifdef HAS_GETPGID
660 #  define BSD_GETPGRP(pid)              getpgid((pid))
661 #else
662 #  if defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
663 #    define BSD_GETPGRP(pid)            getpgrp((pid))
664 #  else
665 #    ifdef HAS_GETPGRP2  /* DG/UX */
666 #      define BSD_GETPGRP(pid)          getpgrp2((pid))
667 #    endif
668 #  endif
669 #endif
670 #if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
671 #  define HAS_GETPGRP  /* Well, effectively it does . . . */
672 #endif
673
674 /* These are not exact synonyms, since setpgrp() and getpgrp() may
675    have different behaviors, but perl.h used to define USE_BSDPGRP
676    (prior to 5.003_05) so some extension might depend on it.
677 */
678 #if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
679 #  ifndef USE_BSDPGRP
680 #    define USE_BSDPGRP
681 #  endif
682 #endif
683
684 /* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
685    pthread.h must be included before all other header files.
686 */
687 #if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
688 #  include <pthread.h>
689 #endif
690
691 #include <sys/types.h>
692
693 #ifdef __cplusplus
694 #  ifndef I_STDARG
695 #    define I_STDARG 1
696 #  endif
697 #endif
698
699 #ifdef I_STDARG
700 #  include <stdarg.h>
701 #else
702 #  ifdef I_VARARGS
703 #    include <varargs.h>
704 #  endif
705 #endif
706
707 #ifdef I_STDINT
708 # include <stdint.h>
709 #endif
710
711 #include <ctype.h>
712
713 #ifdef METHOD   /* Defined by OSF/1 v3.0 by ctype.h */
714 #undef METHOD
715 #endif
716
717 #ifdef PERL_MICRO
718 #   define NO_LOCALE
719 #endif
720
721 #ifdef I_LOCALE
722 #   include <locale.h>
723 #endif
724
725 #if !defined(NO_LOCALE) && defined(HAS_SETLOCALE)
726 #   define USE_LOCALE
727 #   define HAS_SKIP_LOCALE_INIT /* Solely for XS code to test for this
728                                    capability */
729 #   if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
730        && defined(HAS_STRXFRM)
731 #       define USE_LOCALE_COLLATE
732 #   endif
733 #   if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
734 #       define USE_LOCALE_CTYPE
735 #   endif
736 #   if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
737 #       define USE_LOCALE_NUMERIC
738 #   endif
739 #   if !defined(NO_LOCALE_MESSAGES) && defined(LC_MESSAGES)
740 #       define USE_LOCALE_MESSAGES
741 #   endif
742 #   if !defined(NO_LOCALE_MONETARY) && defined(LC_MONETARY)
743 #       define USE_LOCALE_MONETARY
744 #   endif
745 #   if !defined(NO_LOCALE_TIME) && defined(LC_TIME)
746 #       define USE_LOCALE_TIME
747 #   endif
748 #   ifndef WIN32    /* No wrapper except on Windows */
749 #       define my_setlocale(a,b) setlocale(a,b)
750 #   endif
751 #endif /* !NO_LOCALE && HAS_SETLOCALE */
752
753 #include <setjmp.h>
754
755 #ifdef I_SYS_PARAM
756 #   ifdef PARAM_NEEDS_TYPES
757 #       include <sys/types.h>
758 #   endif
759 #   include <sys/param.h>
760 #endif
761
762 /* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
763    value something like 199306.  This may be useful if no more-specific
764    feature test is available.
765 */
766 #if defined(BSD)
767 #   ifndef BSDish
768 #       define BSDish
769 #   endif
770 #endif
771
772 /* Use all the "standard" definitions? */
773 #if defined(STANDARD_C) && defined(I_STDLIB)
774 #   include <stdlib.h>
775 #endif
776
777 /* If this causes problems, set i_unistd=undef in the hint file.  */
778 #ifdef I_UNISTD
779 #   include <unistd.h>
780 #endif
781
782 /* for WCOREDUMP */
783 #ifdef I_SYS_WAIT
784 #   include <sys/wait.h>
785 #endif
786
787 #ifdef __SYMBIAN32__
788 #   undef _SC_ARG_MAX /* Symbian has _SC_ARG_MAX but no sysconf() */
789 #endif
790
791 #if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
792 EXTERN_C int syscall(int, ...);
793 #endif
794
795 #if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
796 EXTERN_C int usleep(unsigned int);
797 #endif
798
799 #ifdef PERL_CORE
800
801 /* macros for correct constant construction */
802 # if INTSIZE >= 2
803 #  define U16_CONST(x) ((U16)x##U)
804 # else
805 #  define U16_CONST(x) ((U16)x##UL)
806 # endif
807
808 # if INTSIZE >= 4
809 #  define U32_CONST(x) ((U32)x##U)
810 # else
811 #  define U32_CONST(x) ((U32)x##UL)
812 # endif
813
814 # ifdef HAS_QUAD
815 #  if INTSIZE >= 8
816 #   define U64_CONST(x) ((U64)x##U)
817 #  elif LONGSIZE >= 8
818 #   define U64_CONST(x) ((U64)x##UL)
819 #  elif QUADKIND == QUAD_IS_LONG_LONG
820 #   define U64_CONST(x) ((U64)x##ULL)
821 #  elif QUADKIND == QUAD_IS___INT64
822 #   define U64_CONST(x) ((U64)x##UI64)
823 #  else /* best guess we can make */
824 #   define U64_CONST(x) ((U64)x##UL)
825 #  endif
826 # endif
827
828 /* byte-swapping functions for big-/little-endian conversion */
829 # define _swab_16_(x) ((U16)( \
830          (((U16)(x) & U16_CONST(0x00ff)) << 8) | \
831          (((U16)(x) & U16_CONST(0xff00)) >> 8) ))
832
833 # define _swab_32_(x) ((U32)( \
834          (((U32)(x) & U32_CONST(0x000000ff)) << 24) | \
835          (((U32)(x) & U32_CONST(0x0000ff00)) <<  8) | \
836          (((U32)(x) & U32_CONST(0x00ff0000)) >>  8) | \
837          (((U32)(x) & U32_CONST(0xff000000)) >> 24) ))
838
839 # ifdef HAS_QUAD
840 #  define _swab_64_(x) ((U64)( \
841           (((U64)(x) & U64_CONST(0x00000000000000ff)) << 56) | \
842           (((U64)(x) & U64_CONST(0x000000000000ff00)) << 40) | \
843           (((U64)(x) & U64_CONST(0x0000000000ff0000)) << 24) | \
844           (((U64)(x) & U64_CONST(0x00000000ff000000)) <<  8) | \
845           (((U64)(x) & U64_CONST(0x000000ff00000000)) >>  8) | \
846           (((U64)(x) & U64_CONST(0x0000ff0000000000)) >> 24) | \
847           (((U64)(x) & U64_CONST(0x00ff000000000000)) >> 40) | \
848           (((U64)(x) & U64_CONST(0xff00000000000000)) >> 56) ))
849 # endif
850
851 /* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
852    at least on FreeBSD.  YMMV, so experiment.  */
853 #ifndef PERL_ARENA_SIZE
854 #define PERL_ARENA_SIZE 4080
855 #endif
856
857 /* Maximum level of recursion */
858 #ifndef PERL_SUB_DEPTH_WARN
859 #define PERL_SUB_DEPTH_WARN 100
860 #endif
861
862 #endif /* PERL_CORE */
863
864 /* We no longer default to creating a new SV for GvSV.
865    Do this before embed.  */
866 #ifndef PERL_CREATE_GVSV
867 #  ifndef PERL_DONT_CREATE_GVSV
868 #    define PERL_DONT_CREATE_GVSV
869 #  endif
870 #endif
871
872 #if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
873 #define PERL_USES_PL_PIDSTATUS
874 #endif
875
876 #if !defined(OS2) && !defined(WIN32) && !defined(DJGPP) && !defined(__SYMBIAN32__)
877 #define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
878 #endif
879
880 #define MEM_SIZE Size_t
881
882 /* Round all values passed to malloc up, by default to a multiple of
883    sizeof(size_t)
884 */
885 #ifndef PERL_STRLEN_ROUNDUP_QUANTUM
886 #define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
887 #endif
888
889 /* sv_grow() will expand strings by at least a certain percentage of
890    the previously *used* length to avoid excessive calls to realloc().
891    The default is 25% of the current length.
892 */
893 #ifndef PERL_STRLEN_EXPAND_SHIFT
894 #  define PERL_STRLEN_EXPAND_SHIFT 2
895 #endif
896
897 #if defined(STANDARD_C) && defined(I_STDDEF) && !defined(PERL_GCC_PEDANTIC)
898 #   include <stddef.h>
899 #   define STRUCT_OFFSET(s,m)  offsetof(s,m)
900 #else
901 #   define STRUCT_OFFSET(s,m)  (Size_t)(&(((s *)0)->m))
902 #endif
903
904 /* ptrdiff_t is C11, so undef it under pedantic builds */
905 #ifdef PERL_GCC_PEDANTIC
906 #   undef HAS_PTRDIFF_T
907 #endif
908
909 #ifndef __SYMBIAN32__
910 #  if defined(I_STRING) || defined(__cplusplus)
911 #     include <string.h>
912 #  else
913 #     include <strings.h>
914 #  endif
915 #endif
916
917 /* This comes after <stdlib.h> so we don't try to change the standard
918  * library prototypes; we'll use our own in proto.h instead. */
919
920 #ifdef MYMALLOC
921 #  ifdef PERL_POLLUTE_MALLOC
922 #   ifndef PERL_EXTMALLOC_DEF
923 #    define Perl_malloc         malloc
924 #    define Perl_calloc         calloc
925 #    define Perl_realloc        realloc
926 #    define Perl_mfree          free
927 #   endif
928 #  else
929 #    define EMBEDMYMALLOC       /* for compatibility */
930 #  endif
931
932 #  define safemalloc  Perl_malloc
933 #  define safecalloc  Perl_calloc
934 #  define saferealloc Perl_realloc
935 #  define safefree    Perl_mfree
936 #  define CHECK_MALLOC_TOO_LATE_FOR_(code)      STMT_START {            \
937         if (!PL_tainting && MallocCfg_ptr[MallocCfg_cfg_env_read])      \
938                 code;                                                   \
939     } STMT_END
940 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)                         \
941         CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
942 #  define panic_write2(s)               write(2, s, strlen(s))
943 #  define CHECK_MALLOC_TAINT(newval)                            \
944         CHECK_MALLOC_TOO_LATE_FOR_(                             \
945                 if (newval) {                                   \
946                   PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
947                   exit(1); })
948 #  define MALLOC_CHECK_TAINT(argc,argv,env)     STMT_START {    \
949         if (doing_taint(argc,argv,env)) {                       \
950                 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1;      \
951     }} STMT_END;
952 #else  /* MYMALLOC */
953 #  define safemalloc  safesysmalloc
954 #  define safecalloc  safesyscalloc
955 #  define saferealloc safesysrealloc
956 #  define safefree    safesysfree
957 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)         ((void)0)
958 #  define CHECK_MALLOC_TAINT(newval)            ((void)0)
959 #  define MALLOC_CHECK_TAINT(argc,argv,env)
960 #endif /* MYMALLOC */
961
962 /* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
963 #define TOO_LATE_FOR_(ch,what)  Perl_croak(aTHX_ "\"-%c\" is on the #! line, it must also be used on the command line%s", (char)(ch), what)
964 #define TOO_LATE_FOR(ch)        TOO_LATE_FOR_(ch, "")
965 #define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
966 #define MALLOC_CHECK_TAINT2(argc,argv)  MALLOC_CHECK_TAINT(argc,argv,NULL)
967
968 #if !defined(HAS_STRCHR) && defined(HAS_INDEX) && !defined(strchr)
969 #define strchr index
970 #define strrchr rindex
971 #endif
972
973 #ifdef I_MEMORY
974 #  include <memory.h>
975 #endif
976
977 #ifdef HAS_MEMCPY
978 #  if !defined(STANDARD_C) && !defined(I_STRING) && !defined(I_MEMORY)
979 #    ifndef memcpy
980         extern char * memcpy (char*, char*, int);
981 #    endif
982 #  endif
983 #else
984 #   ifndef memcpy
985 #       ifdef HAS_BCOPY
986 #           define memcpy(d,s,l) bcopy(s,d,l)
987 #       else
988 #           define memcpy(d,s,l) my_bcopy(s,d,l)
989 #       endif
990 #   endif
991 #endif /* HAS_MEMCPY */
992
993 #ifdef HAS_MEMSET
994 #  if !defined(STANDARD_C) && !defined(I_STRING) && !defined(I_MEMORY)
995 #    ifndef memset
996         extern char *memset (char*, int, int);
997 #    endif
998 #  endif
999 #else
1000 #  undef  memset
1001 #  define memset(d,c,l) my_memset(d,c,l)
1002 #endif /* HAS_MEMSET */
1003
1004 #if !defined(HAS_MEMMOVE) && !defined(memmove)
1005 #   if defined(HAS_BCOPY) && defined(HAS_SAFE_BCOPY)
1006 #       define memmove(d,s,l) bcopy(s,d,l)
1007 #   else
1008 #       if defined(HAS_MEMCPY) && defined(HAS_SAFE_MEMCPY)
1009 #           define memmove(d,s,l) memcpy(d,s,l)
1010 #       else
1011 #           define memmove(d,s,l) my_bcopy(s,d,l)
1012 #       endif
1013 #   endif
1014 #endif
1015
1016 #if defined(mips) && defined(ultrix) && !defined(__STDC__)
1017 #   undef HAS_MEMCMP
1018 #endif
1019
1020 #if defined(HAS_MEMCMP) && defined(HAS_SANE_MEMCMP)
1021 #  if !defined(STANDARD_C) && !defined(I_STRING) && !defined(I_MEMORY)
1022 #    ifndef memcmp
1023         extern int memcmp (char*, char*, int);
1024 #    endif
1025 #  endif
1026 #else
1027 #   ifndef memcmp
1028 #       define memcmp   my_memcmp
1029 #   endif
1030 #endif /* HAS_MEMCMP && HAS_SANE_MEMCMP */
1031
1032 #ifndef memzero
1033 #   ifdef HAS_MEMSET
1034 #       define memzero(d,l) memset(d,0,l)
1035 #   else
1036 #       ifdef HAS_BZERO
1037 #           define memzero(d,l) bzero(d,l)
1038 #       else
1039 #           define memzero(d,l) my_bzero(d,l)
1040 #       endif
1041 #   endif
1042 #endif
1043
1044 #ifndef PERL_MICRO
1045 #ifndef memchr
1046 #   ifndef HAS_MEMCHR
1047 #       define memchr(s,c,n) ninstr((char*)(s), ((char*)(s)) + n, &(c), &(c) + 1)
1048 #   endif
1049 #endif
1050 #endif
1051
1052 #ifndef HAS_BCMP
1053 #   ifndef bcmp
1054 #       define bcmp(s1,s2,l) memcmp(s1,s2,l)
1055 #   endif
1056 #endif /* !HAS_BCMP */
1057
1058 #ifdef I_NETINET_IN
1059 #   include <netinet/in.h>
1060 #endif
1061
1062 #ifdef I_ARPA_INET
1063 #   include <arpa/inet.h>
1064 #endif
1065
1066 #ifdef I_SYS_STAT
1067 #   include <sys/stat.h>
1068 #endif
1069
1070 /* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1071    This definition should ideally go into win32/win32.h, but S_IFIFO is
1072    used later here in perl.h before win32/win32.h is being included. */
1073 #if !defined(S_IFIFO) && defined(_S_IFIFO)
1074 #   define S_IFIFO _S_IFIFO
1075 #endif
1076
1077 /* The stat macros for Unisoft System V/88 (and derivatives
1078    like UTekV) are broken, sometimes giving false positives.  Undefine
1079    them here and let the code below set them to proper values.
1080
1081    The ghs macro stands for GreenHills Software C-1.8.5 which
1082    is the C compiler for sysV88 and the various derivatives.
1083    This header file bug is corrected in gcc-2.5.8 and later versions.
1084    --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94.  */
1085
1086 #if defined(m88k) && defined(ghs)
1087 #   undef S_ISDIR
1088 #   undef S_ISCHR
1089 #   undef S_ISBLK
1090 #   undef S_ISREG
1091 #   undef S_ISFIFO
1092 #   undef S_ISLNK
1093 #endif
1094
1095 #ifdef I_TIME
1096 #   include <time.h>
1097 #endif
1098
1099 #ifdef I_SYS_TIME
1100 #   ifdef I_SYS_TIME_KERNEL
1101 #       define KERNEL
1102 #   endif
1103 #   include <sys/time.h>
1104 #   ifdef I_SYS_TIME_KERNEL
1105 #       undef KERNEL
1106 #   endif
1107 #endif
1108
1109 #if defined(HAS_TIMES) && defined(I_SYS_TIMES)
1110 #    include <sys/times.h>
1111 #endif
1112
1113 #if defined(HAS_STRERROR) && (!defined(HAS_MKDIR) || !defined(HAS_RMDIR))
1114 #   undef HAS_STRERROR
1115 #endif
1116
1117 #include <errno.h>
1118
1119 #if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
1120 #  define WIN32SCK_IS_STDSCK            /* don't pull in custom wsock layer */
1121 #endif
1122
1123 /* In Tru64 use the 4.4BSD struct msghdr, not the 4.3 one.
1124  * This is important for using IPv6.
1125  * For OSF/1 3.2, however, defining _SOCKADDR_LEN would be
1126  * a bad idea since it breaks send() and recv(). */
1127 #if defined(__osf__) && defined(__alpha) && !defined(_SOCKADDR_LEN) && !defined(DEC_OSF1_3_X)
1128 #   define _SOCKADDR_LEN
1129 #endif
1130
1131 #if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1132 # include <sys/socket.h>
1133 # if defined(USE_SOCKS) && defined(I_SOCKS)
1134 #   if !defined(INCLUDE_PROTOTYPES)
1135 #       define INCLUDE_PROTOTYPES /* for <socks.h> */
1136 #       define PERL_SOCKS_NEED_PROTOTYPES
1137 #   endif
1138 #   include <socks.h>
1139 #   ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1140 #       undef INCLUDE_PROTOTYPES
1141 #       undef PERL_SOCKS_NEED_PROTOTYPES
1142 #   endif
1143 # endif
1144 # ifdef I_NETDB
1145 #  ifdef NETWARE
1146 #   include<stdio.h>
1147 #  endif
1148 #  include <netdb.h>
1149 # endif
1150 # ifndef ENOTSOCK
1151 #  ifdef I_NET_ERRNO
1152 #   include <net/errno.h>
1153 #  endif
1154 # endif
1155 #endif
1156
1157 /* sockatmark() is so new (2001) that many places might have it hidden
1158  * behind some -D_BLAH_BLAH_SOURCE guard.  The __THROW magic is required
1159  * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
1160 #if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
1161 # if defined(__THROW) && defined(__GLIBC__)
1162 int sockatmark(int) __THROW;
1163 # else
1164 int sockatmark(int);
1165 # endif
1166 #endif
1167
1168 #if defined(__osf__) && defined(__cplusplus) && !defined(_XOPEN_SOURCE_EXTENDED) /* Tru64 "cxx" (C++), see hints/dec_osf.sh for why the _XOPEN_SOURCE_EXTENDED cannot be defined. */
1169 EXTERN_C int fchdir(int);
1170 EXTERN_C int flock(int, int);
1171 EXTERN_C int fseeko(FILE *, off_t, int);
1172 EXTERN_C off_t ftello(FILE *);
1173 #endif
1174
1175 #if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1176 EXTERN_C char *crypt(const char *, const char *);
1177 EXTERN_C char **environ;
1178 #endif
1179
1180 #if defined(__cplusplus)
1181 #  if defined(BSDish)
1182 EXTERN_C char **environ;
1183 #  elif defined(__CYGWIN__)
1184 EXTERN_C char *crypt(const char *, const char *);
1185 #endif
1186 #endif
1187
1188 #ifdef SETERRNO
1189 # undef SETERRNO  /* SOCKS might have defined this */
1190 #endif
1191
1192 #ifdef VMS
1193 #   define SETERRNO(errcode,vmserrcode) \
1194         STMT_START {                    \
1195             set_errno(errcode);         \
1196             set_vaxc_errno(vmserrcode); \
1197         } STMT_END
1198 #   define dSAVEDERRNO    int saved_errno; unsigned saved_vms_errno
1199 #   define dSAVE_ERRNO    int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1200 #   define SAVE_ERRNO     ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1201 #   define RESTORE_ERRNO  SETERRNO(saved_errno, saved_vms_errno)
1202
1203 #   define LIB_INVARG           LIB$_INVARG
1204 #   define RMS_DIR              RMS$_DIR
1205 #   define RMS_FAC              RMS$_FAC
1206 #   define RMS_FEX              RMS$_FEX
1207 #   define RMS_FNF              RMS$_FNF
1208 #   define RMS_IFI              RMS$_IFI
1209 #   define RMS_ISI              RMS$_ISI
1210 #   define RMS_PRV              RMS$_PRV
1211 #   define SS_ACCVIO            SS$_ACCVIO
1212 #   define SS_DEVOFFLINE        SS$_DEVOFFLINE
1213 #   define SS_IVCHAN            SS$_IVCHAN
1214 #   define SS_NORMAL            SS$_NORMAL
1215 #   define SS_NOPRIV            SS$_NOPRIV
1216 #else
1217 #   define LIB_INVARG           0
1218 #   define RMS_DIR              0
1219 #   define RMS_FAC              0
1220 #   define RMS_FEX              0
1221 #   define RMS_FNF              0
1222 #   define RMS_IFI              0
1223 #   define RMS_ISI              0
1224 #   define RMS_PRV              0
1225 #   define SS_ACCVIO            0
1226 #   define SS_DEVOFFLINE        0
1227 #   define SS_IVCHAN            0
1228 #   define SS_NORMAL            0
1229 #   define SS_NOPRIV            0
1230 #endif
1231
1232 #ifdef WIN32
1233 #   define dSAVEDERRNO  int saved_errno; DWORD saved_win32_errno
1234 #   define dSAVE_ERRNO  int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1235 #   define SAVE_ERRNO   ( saved_errno = errno, saved_win32_errno = GetLastError() )
1236 #   define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1237 #endif
1238
1239 #ifdef OS2
1240 #   define dSAVEDERRNO  int saved_errno; unsigned long saved_os2_errno
1241 #   define dSAVE_ERRNO  int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1242 #   define SAVE_ERRNO   ( saved_errno = errno, saved_os2_errno = Perl_rc )
1243 #   define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1244 #endif
1245
1246 #ifndef SETERRNO
1247 #   define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1248 #endif
1249
1250 #ifndef dSAVEDERRNO
1251 #   define dSAVEDERRNO    int saved_errno
1252 #   define dSAVE_ERRNO    int saved_errno = errno
1253 #   define SAVE_ERRNO     (saved_errno = errno)
1254 #   define RESTORE_ERRNO  (errno = saved_errno)
1255 #endif
1256
1257 #define ERRSV GvSVn(PL_errgv)
1258
1259 #define CLEAR_ERRSV() STMT_START {                                      \
1260     if (!GvSV(PL_errgv)) {                                              \
1261         sv_setpvs(GvSV(gv_add_by_type(PL_errgv, SVt_PV)), "");          \
1262     } else if (SvREADONLY(GvSV(PL_errgv))) {                            \
1263         SvREFCNT_dec(GvSV(PL_errgv));                                   \
1264         GvSV(PL_errgv) = newSVpvs("");                                  \
1265     } else {                                                            \
1266         SV *const errsv = GvSV(PL_errgv);                               \
1267         sv_setpvs(errsv, "");                                           \
1268         if (SvMAGICAL(errsv)) {                                         \
1269             mg_free(errsv);                                             \
1270         }                                                               \
1271         SvPOK_only(errsv);                                              \
1272     }                                                                   \
1273     } STMT_END
1274
1275
1276 #ifdef PERL_CORE
1277 # define DEFSV (0 + GvSVn(PL_defgv))
1278 # define DEFSV_set(sv) \
1279     (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1280 # define SAVE_DEFSV                \
1281     (                               \
1282         save_gp(PL_defgv, 0),        \
1283         GvINTRO_off(PL_defgv),        \
1284         SAVEGENERICSV(GvSV(PL_defgv)), \
1285         GvSV(PL_defgv) = NULL           \
1286     )
1287 #else
1288 # define DEFSV GvSVn(PL_defgv)
1289 # define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1290 # define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
1291 #endif
1292
1293 #ifndef errno
1294         extern int errno;     /* ANSI allows errno to be an lvalue expr.
1295                                * For example in multithreaded environments
1296                                * something like this might happen:
1297                                * extern int *_errno(void);
1298                                * #define errno (*_errno()) */
1299 #endif
1300
1301 #define UNKNOWN_ERRNO_MSG "(unknown)"
1302
1303 #ifdef HAS_STRERROR
1304 #   ifndef DONT_DECLARE_STD
1305 #       ifdef VMS
1306         char *strerror (int,...);
1307 #       else
1308         char *strerror (int);
1309 #       endif
1310 #    endif
1311 #    ifndef Strerror
1312 #       define Strerror strerror
1313 #    endif
1314 #else
1315 #    ifdef HAS_SYS_ERRLIST
1316         extern int sys_nerr;
1317         extern char *sys_errlist[];
1318 #       ifndef Strerror
1319 #           define Strerror(e) \
1320                 ((e) < 0 || (e) >= sys_nerr ? UNKNOWN_ERRNO_MSG : sys_errlist[e])
1321 #       endif
1322 #   endif
1323 #endif
1324
1325 #ifdef I_SYS_IOCTL
1326 #   ifndef _IOCTL_
1327 #       include <sys/ioctl.h>
1328 #   endif
1329 #endif
1330
1331 #if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
1332 #   ifdef HAS_SOCKETPAIR
1333 #       undef HAS_SOCKETPAIR
1334 #   endif
1335 #   ifdef I_NDBM
1336 #       undef I_NDBM
1337 #   endif
1338 #endif
1339
1340 #ifndef HAS_SOCKETPAIR
1341 #   ifdef HAS_SOCKET
1342 #       define socketpair Perl_my_socketpair
1343 #   endif
1344 #endif
1345
1346 #if INTSIZE == 2
1347 #   define htoni htons
1348 #   define ntohi ntohs
1349 #else
1350 #   define htoni htonl
1351 #   define ntohi ntohl
1352 #endif
1353
1354 /* Configure already sets Direntry_t */
1355 #if defined(I_DIRENT)
1356 #   include <dirent.h>
1357 #else
1358 #   ifdef I_SYS_NDIR
1359 #       include <sys/ndir.h>
1360 #   else
1361 #       ifdef I_SYS_DIR
1362 #           ifdef hp9000s500
1363 #               include <ndir.h>        /* may be wrong in the future */
1364 #           else
1365 #               include <sys/dir.h>
1366 #           endif
1367 #       endif
1368 #   endif
1369 #endif
1370
1371 /*
1372  * The following gobbledygook brought to you on behalf of __STDC__.
1373  * (I could just use #ifndef __STDC__, but this is more bulletproof
1374  * in the face of half-implementations.)
1375  */
1376
1377 #if defined(I_SYSMODE)
1378 #include <sys/mode.h>
1379 #endif
1380
1381 #ifndef S_IFMT
1382 #   ifdef _S_IFMT
1383 #       define S_IFMT _S_IFMT
1384 #   else
1385 #       define S_IFMT 0170000
1386 #   endif
1387 #endif
1388
1389 #ifndef S_ISDIR
1390 #   define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1391 #endif
1392
1393 #ifndef S_ISCHR
1394 #   define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1395 #endif
1396
1397 #ifndef S_ISBLK
1398 #   ifdef S_IFBLK
1399 #       define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1400 #   else
1401 #       define S_ISBLK(m) (0)
1402 #   endif
1403 #endif
1404
1405 #ifndef S_ISREG
1406 #   define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1407 #endif
1408
1409 #ifndef S_ISFIFO
1410 #   ifdef S_IFIFO
1411 #       define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1412 #   else
1413 #       define S_ISFIFO(m) (0)
1414 #   endif
1415 #endif
1416
1417 #ifndef S_ISLNK
1418 #   ifdef _S_ISLNK
1419 #       define S_ISLNK(m) _S_ISLNK(m)
1420 #   else
1421 #       ifdef _S_IFLNK
1422 #           define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1423 #       else
1424 #           ifdef S_IFLNK
1425 #               define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1426 #           else
1427 #               define S_ISLNK(m) (0)
1428 #           endif
1429 #       endif
1430 #   endif
1431 #endif
1432
1433 #ifndef S_ISSOCK
1434 #   ifdef _S_ISSOCK
1435 #       define S_ISSOCK(m) _S_ISSOCK(m)
1436 #   else
1437 #       ifdef _S_IFSOCK
1438 #           define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1439 #       else
1440 #           ifdef S_IFSOCK
1441 #               define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1442 #           else
1443 #               define S_ISSOCK(m) (0)
1444 #           endif
1445 #       endif
1446 #   endif
1447 #endif
1448
1449 #ifndef S_IRUSR
1450 #   ifdef S_IREAD
1451 #       define S_IRUSR S_IREAD
1452 #       define S_IWUSR S_IWRITE
1453 #       define S_IXUSR S_IEXEC
1454 #   else
1455 #       define S_IRUSR 0400
1456 #       define S_IWUSR 0200
1457 #       define S_IXUSR 0100
1458 #   endif
1459 #endif
1460
1461 #ifndef S_IRGRP
1462 #   ifdef S_IRUSR
1463 #       define S_IRGRP (S_IRUSR>>3)
1464 #       define S_IWGRP (S_IWUSR>>3)
1465 #       define S_IXGRP (S_IXUSR>>3)
1466 #   else
1467 #       define S_IRGRP 0040
1468 #       define S_IWGRP 0020
1469 #       define S_IXGRP 0010
1470 #   endif
1471 #endif
1472
1473 #ifndef S_IROTH
1474 #   ifdef S_IRUSR
1475 #       define S_IROTH (S_IRUSR>>6)
1476 #       define S_IWOTH (S_IWUSR>>6)
1477 #       define S_IXOTH (S_IXUSR>>6)
1478 #   else
1479 #       define S_IROTH 0040
1480 #       define S_IWOTH 0020
1481 #       define S_IXOTH 0010
1482 #   endif
1483 #endif
1484
1485 #ifndef S_ISUID
1486 #   define S_ISUID 04000
1487 #endif
1488
1489 #ifndef S_ISGID
1490 #   define S_ISGID 02000
1491 #endif
1492
1493 #ifndef S_IRWXU
1494 #   define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
1495 #endif
1496
1497 #ifndef S_IRWXG
1498 #   define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
1499 #endif
1500
1501 #ifndef S_IRWXO
1502 #   define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
1503 #endif
1504
1505 /* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
1506  * which would get included through <sys/file.h >, but that is 3000
1507  * lines in the future.  --jhi */
1508
1509 #if !defined(S_IREAD) && !defined(__HAIKU__)
1510 #   define S_IREAD S_IRUSR
1511 #endif
1512
1513 #if !defined(S_IWRITE) && !defined(__HAIKU__)
1514 #   define S_IWRITE S_IWUSR
1515 #endif
1516
1517 #ifndef S_IEXEC
1518 #   define S_IEXEC S_IXUSR
1519 #endif
1520
1521 #if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
1522 #   define SLOPPYDIVIDE
1523 #endif
1524
1525 #ifdef UV
1526 #undef UV
1527 #endif
1528
1529 /* For the times when you want the return value of sprintf, and you want it
1530    to be the length. Can't have a thread variable passed in, because C89 has
1531    no varargs macros.
1532 */
1533 #ifdef SPRINTF_RETURNS_STRLEN
1534 #  define my_sprintf sprintf
1535 #else
1536 #  define my_sprintf Perl_my_sprintf
1537 #endif
1538
1539 /*
1540  * If we have v?snprintf() and the C99 variadic macros, we can just
1541  * use just the v?snprintf().  It is nice to try to trap the buffer
1542  * overflow, however, so if we are DEBUGGING, and we cannot use the
1543  * gcc statement expressions, then use the function wrappers which try
1544  * to trap the overflow.  If we can use the gcc statement expressions,
1545  * we can try that even with the version that uses the C99 variadic
1546  * macros.
1547  */
1548
1549 /* Note that we do not check against snprintf()/vsnprintf() returning
1550  * negative values because that is non-standard behaviour and we use
1551  * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1552  * that should be true only if the snprintf()/vsnprintf() are true
1553  * to the standard. */
1554
1555 #define PERL_SNPRINTF_CHECK(len, max, api) STMT_START { if ((max) > 0 && (Size_t)len >= (max)) Perl_croak_nocontext("panic: %s buffer overflow", STRINGIFY(api)); } STMT_END
1556
1557 #if defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1558 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1559 #      define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1560 #      define PERL_MY_SNPRINTF_GUARDED
1561 #  else
1562 #    define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
1563 #  endif
1564 #else
1565 #  define my_snprintf  Perl_my_snprintf
1566 #  define PERL_MY_SNPRINTF_GUARDED
1567 #endif
1568
1569 #if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1570 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1571 #      define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1572 #      define PERL_MY_VSNPRINTF_GUARDED
1573 #  else
1574 #    define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
1575 #  endif
1576 #else
1577 #  define my_vsnprintf Perl_my_vsnprintf
1578 #  define PERL_MY_VSNPRINTF_GUARDED
1579 #endif
1580
1581 /* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1582  * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1583  * the result of my_snprintf() or my_vsnprintf().  (No, you should not
1584  * completely ignore it: otherwise you cannot know whether your output
1585  * was too long.)
1586  *
1587  * int len = my_sprintf(buf, max, ...);
1588  * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1589  *
1590  * The trick is that in certain platforms [a] the my_sprintf() already
1591  * contains the sanity check, while in certain platforms [b] it needs
1592  * to be done as a separate step.  The POST_GUARD is that step-- in [a]
1593  * platforms the POST_GUARD actually does nothing since the check has
1594  * already been done.  Watch out for the max being the same in both calls.
1595  *
1596  * If you actually use the snprintf/vsnprintf return value already,
1597  * you assumedly are checking its validity somehow.  But you can
1598  * insert the POST_GUARD() also in that case. */
1599
1600 #ifndef PERL_MY_SNPRINTF_GUARDED
1601 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1602 #else
1603 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1604 #endif
1605
1606 #ifndef  PERL_MY_VSNPRINTF_GUARDED
1607 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
1608 #else
1609 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1610 #endif
1611
1612 #ifdef HAS_STRLCAT
1613 #  define my_strlcat    strlcat
1614 #else
1615 #  define my_strlcat    Perl_my_strlcat
1616 #endif
1617
1618 #ifdef HAS_STRLCPY
1619 #  define my_strlcpy    strlcpy
1620 #else
1621 #  define my_strlcpy    Perl_my_strlcpy
1622 #endif
1623
1624 /*
1625     The IV type is supposed to be long enough to hold any integral
1626     value or a pointer.
1627     --Andy Dougherty    August 1996
1628 */
1629
1630 typedef IVTYPE IV;
1631 typedef UVTYPE UV;
1632
1633 #if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
1634 #  if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
1635 #    define IV_MAX INT64_MAX
1636 #    define IV_MIN INT64_MIN
1637 #    define UV_MAX UINT64_MAX
1638 #    ifndef UINT64_MIN
1639 #      define UINT64_MIN 0
1640 #    endif
1641 #    define UV_MIN UINT64_MIN
1642 #  else
1643 #    define IV_MAX PERL_QUAD_MAX
1644 #    define IV_MIN PERL_QUAD_MIN
1645 #    define UV_MAX PERL_UQUAD_MAX
1646 #    define UV_MIN PERL_UQUAD_MIN
1647 #  endif
1648 #  define IV_IS_QUAD
1649 #  define UV_IS_QUAD
1650 #else
1651 #  if defined(INT32_MAX) && IVSIZE == 4
1652 #    define IV_MAX INT32_MAX
1653 #    define IV_MIN INT32_MIN
1654 #    ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
1655 #        define UV_MAX UINT32_MAX
1656 #    else
1657 #        define UV_MAX 4294967295U
1658 #    endif
1659 #    ifndef UINT32_MIN
1660 #      define UINT32_MIN 0
1661 #    endif
1662 #    define UV_MIN UINT32_MIN
1663 #  else
1664 #    define IV_MAX PERL_LONG_MAX
1665 #    define IV_MIN PERL_LONG_MIN
1666 #    define UV_MAX PERL_ULONG_MAX
1667 #    define UV_MIN PERL_ULONG_MIN
1668 #  endif
1669 #  if IVSIZE == 8
1670 #    define IV_IS_QUAD
1671 #    define UV_IS_QUAD
1672 #    ifndef HAS_QUAD
1673 #      define HAS_QUAD
1674 #    endif
1675 #  else
1676 #    undef IV_IS_QUAD
1677 #    undef UV_IS_QUAD
1678 #if !defined(PERL_CORE) || defined(USING_MSVC6)
1679 /* We think that removing this decade-old undef this will cause too much
1680    breakage on CPAN for too little gain. (See RT #119753)
1681    However, we do need HAS_QUAD in the core for use by the drand48 code,
1682    but not for Win32 VC6 because it has poor __int64 support. */
1683 #    undef HAS_QUAD
1684 #endif
1685 #  endif
1686 #endif
1687
1688 #define Size_t_MAX (~(Size_t)0)
1689 #define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
1690
1691 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
1692 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
1693
1694 #ifndef NO_PERL_PRESERVE_IVUV
1695 #define PERL_PRESERVE_IVUV      /* We like our integers to stay integers. */
1696 #endif
1697
1698 /*
1699  *  The macros INT2PTR and NUM2PTR are (despite their names)
1700  *  bi-directional: they will convert int/float to or from pointers.
1701  *  However the conversion to int/float are named explicitly:
1702  *  PTR2IV, PTR2UV, PTR2NV.
1703  *
1704  *  For int conversions we do not need two casts if pointers are
1705  *  the same size as IV and UV.   Otherwise we need an explicit
1706  *  cast (PTRV) to avoid compiler warnings.
1707  */
1708 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1709 #  define PTRV                  UV
1710 #  define INT2PTR(any,d)        (any)(d)
1711 #else
1712 #  if PTRSIZE == LONGSIZE
1713 #    define PTRV                unsigned long
1714 #    define PTR2ul(p)           (unsigned long)(p)
1715 #  else
1716 #    define PTRV                unsigned
1717 #  endif
1718 #endif
1719
1720 #ifndef INT2PTR
1721 #  define INT2PTR(any,d)        (any)(PTRV)(d)
1722 #endif
1723
1724 #ifndef PTR2ul
1725 #  define PTR2ul(p)     INT2PTR(unsigned long,p)        
1726 #endif
1727
1728 #define NUM2PTR(any,d)  (any)(PTRV)(d)
1729 #define PTR2IV(p)       INT2PTR(IV,p)
1730 #define PTR2UV(p)       INT2PTR(UV,p)
1731 #define PTR2NV(p)       NUM2PTR(NV,p)
1732 #define PTR2nat(p)      (PTRV)(p)       /* pointer to integer of PTRSIZE */
1733
1734 /* According to strict ANSI C89 one cannot freely cast between
1735  * data pointers and function (code) pointers.  There are at least
1736  * two ways around this.  One (used below) is to do two casts,
1737  * first the other pointer to an (unsigned) integer, and then
1738  * the integer to the other pointer.  The other way would be
1739  * to use unions to "overlay" the pointers.  For an example of
1740  * the latter technique, see union dirpu in struct xpvio in sv.h.
1741  * The only feasible use is probably temporarily storing
1742  * function pointers in a data pointer (such as a void pointer). */
1743
1744 #define DPTR2FPTR(t,p) ((t)PTR2nat(p))  /* data pointer to function pointer */
1745 #define FPTR2DPTR(t,p) ((t)PTR2nat(p))  /* function pointer to data pointer */
1746
1747 #ifdef USE_LONG_DOUBLE
1748 #  if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE == DOUBLESIZE
1749 #      define LONG_DOUBLE_EQUALS_DOUBLE
1750 #  endif
1751 #  if !(defined(HAS_LONG_DOUBLE) && (LONG_DOUBLESIZE > DOUBLESIZE))
1752 #     undef USE_LONG_DOUBLE /* Ouch! */
1753 #  endif
1754 #endif
1755
1756 #ifdef OVR_DBL_DIG
1757 /* Use an overridden DBL_DIG */
1758 # ifdef DBL_DIG
1759 #  undef DBL_DIG
1760 # endif
1761 # define DBL_DIG OVR_DBL_DIG
1762 #else
1763 /* The following is all to get DBL_DIG, in order to pick a nice
1764    default value for printing floating point numbers in Gconvert
1765    (see config.h). (It also has other uses, such as figuring out if
1766    a given precision of printing can be done with a double instead of
1767    a long double - Allen).
1768 */
1769 #ifdef I_LIMITS
1770 #include <limits.h>
1771 #endif
1772 #ifdef I_FLOAT
1773 #include <float.h>
1774 #endif
1775 #ifndef HAS_DBL_DIG
1776 #define DBL_DIG 15   /* A guess that works lots of places */
1777 #endif
1778 #endif
1779
1780 #ifdef OVR_LDBL_DIG
1781 /* Use an overridden LDBL_DIG */
1782 # ifdef LDBL_DIG
1783 #  undef LDBL_DIG
1784 # endif
1785 # define LDBL_DIG OVR_LDBL_DIG
1786 #else
1787 /* The following is all to get LDBL_DIG, in order to pick a nice
1788    default value for printing floating point numbers in Gconvert.
1789    (see config.h)
1790 */
1791 # ifdef I_LIMITS
1792 #   include <limits.h>
1793 # endif
1794 # ifdef I_FLOAT
1795 #  include <float.h>
1796 # endif
1797 # ifndef HAS_LDBL_DIG
1798 #  if LONG_DOUBLESIZE == 10
1799 #   define LDBL_DIG 18 /* assume IEEE */
1800 #  else
1801 #   if LONG_DOUBLESIZE == 12
1802 #    define LDBL_DIG 18 /* gcc? */
1803 #   else
1804 #    if LONG_DOUBLESIZE == 16
1805 #     define LDBL_DIG 33 /* assume IEEE */
1806 #    else
1807 #     if LONG_DOUBLESIZE == DOUBLESIZE
1808 #      define LDBL_DIG DBL_DIG /* bummer */
1809 #     endif
1810 #    endif
1811 #   endif
1812 #  endif
1813 # endif
1814 #endif
1815
1816 /*
1817  * This is for making sure we have a good DBL_MAX value, if possible,
1818  * either for usage as NV_MAX or for usage in figuring out if we can
1819  * fit a given long double into a double, if bug-fixing makes it
1820  * necessary to do so. - Allen <allens@cpan.org>
1821  */
1822
1823 #ifdef I_LIMITS
1824 #  include <limits.h>
1825 #endif
1826
1827 #ifdef I_VALUES
1828 #  if !(defined(DBL_MIN) && defined(DBL_MAX) && defined(I_LIMITS))
1829 #    include <values.h>
1830 #    if defined(MAXDOUBLE) && !defined(DBL_MAX)
1831 #      define DBL_MAX MAXDOUBLE
1832 #    endif
1833 #    if defined(MINDOUBLE) && !defined(DBL_MIN)
1834 #      define DBL_MIN MINDOUBLE
1835 #    endif
1836 #  endif
1837 #endif /* defined(I_VALUES) */
1838
1839 typedef NVTYPE NV;
1840
1841 #ifdef I_IEEEFP
1842 #   include <ieeefp.h>
1843 #endif
1844
1845 #ifdef USE_LONG_DOUBLE
1846 #   ifdef I_SUNMATH
1847 #       include <sunmath.h>
1848 #   endif
1849 #   define NV_DIG LDBL_DIG
1850 #   ifdef LDBL_MANT_DIG
1851 #       define NV_MANT_DIG LDBL_MANT_DIG
1852 #   endif
1853 #   ifdef LDBL_MIN
1854 #       define NV_MIN LDBL_MIN
1855 #   endif
1856 #   ifdef LDBL_MAX
1857 #       define NV_MAX LDBL_MAX
1858 #   endif
1859 #   ifdef LDBL_MIN_EXP
1860 #       define NV_MIN_EXP LDBL_MIN_EXP
1861 #   endif
1862 #   ifdef LDBL_MAX_EXP
1863 #       define NV_MAX_EXP LDBL_MAX_EXP
1864 #   endif
1865 #   ifdef LDBL_MIN_10_EXP
1866 #       define NV_MIN_10_EXP LDBL_MIN_10_EXP
1867 #   endif
1868 #   ifdef LDBL_MAX_10_EXP
1869 #       define NV_MAX_10_EXP LDBL_MAX_10_EXP
1870 #   endif
1871 #   ifdef LDBL_EPSILON
1872 #       define NV_EPSILON LDBL_EPSILON
1873 #   endif
1874 #   ifdef LDBL_MAX
1875 #       define NV_MAX LDBL_MAX
1876 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
1877 #   else
1878 #       ifdef HUGE_VALL
1879 #           define NV_MAX HUGE_VALL
1880 #       else
1881 #           ifdef HUGE_VAL
1882 #               define NV_MAX ((NV)HUGE_VAL)
1883 #           endif
1884 #       endif
1885 #   endif
1886 #   ifdef HAS_SQRTL
1887 #       define Perl_cos cosl
1888 #       define Perl_sin sinl
1889 #       define Perl_sqrt sqrtl
1890 #       define Perl_exp expl
1891 #       define Perl_log logl
1892 #       define Perl_atan2 atan2l
1893 #       define Perl_pow powl
1894 #       define Perl_floor floorl
1895 #       define Perl_ceil ceill
1896 #       define Perl_fmod fmodl
1897 #   endif
1898 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
1899 #   ifdef HAS_MODFL
1900 #       define Perl_modf(x,y) modfl(x,y)
1901 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
1902    prototype in <math.h> */
1903 #       ifndef HAS_MODFL_PROTO
1904 EXTERN_C long double modfl(long double, long double *);
1905 #       endif
1906 #   else
1907 #       if defined(HAS_AINTL) && defined(HAS_COPYSIGNL)
1908         extern long double Perl_my_modfl(long double x, long double *ip);
1909 #           define Perl_modf(x,y) Perl_my_modfl(x,y)
1910 #       endif
1911 #   endif
1912 #   ifdef HAS_FREXPL
1913 #       define Perl_frexp(x,y) frexpl(x,y)
1914 #   else
1915 #       if defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
1916         extern long double Perl_my_frexpl(long double x, int *e);
1917 #           define Perl_frexp(x,y) Perl_my_frexpl(x,y)
1918 #       endif
1919 #   endif
1920 #   ifdef HAS_LDEXPL
1921 #       define Perl_ldexp(x, y) ldexpl(x,y)
1922 #   else
1923 #       if defined(HAS_SCALBNL) && FLT_RADIX == 2
1924 #           define Perl_ldexp(x,y) scalbnl(x,y)
1925 #       endif
1926 #   endif
1927 #   ifndef Perl_isnan
1928 #       if defined(HAS_ISNANL) && !(defined(isnan) && HAS_C99)
1929 #           define Perl_isnan(x) isnanl(x)
1930 #       endif
1931 #   endif
1932 #   ifndef Perl_isinf
1933 #       if defined(HAS_ISINFL) && !(defined(isinf) && HAS_C99)
1934 #           define Perl_isinf(x) isinfl(x)
1935 #       elif defined(LDBL_MAX)
1936 #           define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
1937 #       endif
1938 #   endif
1939 #   if !defined(Perl_isfinite) && !(defined(isfinite) && HAS_C99)
1940 #     ifdef HAS_ISFINITEL
1941 #       define Perl_isfinite(x) isfinitel(x)
1942 #     elif defined(HAS_FINITEL)
1943 #       define Perl_isfinite(x) finitel(x)
1944 #     elif defined(LDBL_MAX)
1945 #       define Perl_isfinite(x) ((x) <= LDBL_MAX && (x) >= -LDBL_MAX)
1946 #     endif
1947 #   endif
1948 #else
1949 #   define NV_DIG DBL_DIG
1950 #   ifdef DBL_MANT_DIG
1951 #       define NV_MANT_DIG DBL_MANT_DIG
1952 #   endif
1953 #   ifdef DBL_MIN
1954 #       define NV_MIN DBL_MIN
1955 #   endif
1956 #   ifdef DBL_MAX
1957 #       define NV_MAX DBL_MAX
1958 #   endif
1959 #   ifdef DBL_MIN_EXP
1960 #       define NV_MIN_EXP DBL_MIN_EXP
1961 #   endif
1962 #   ifdef DBL_MAX_EXP
1963 #       define NV_MAX_EXP DBL_MAX_EXP
1964 #   endif
1965 #   ifdef DBL_MIN_10_EXP
1966 #       define NV_MIN_10_EXP DBL_MIN_10_EXP
1967 #   endif
1968 #   ifdef DBL_MAX_10_EXP
1969 #       define NV_MAX_10_EXP DBL_MAX_10_EXP
1970 #   endif
1971 #   ifdef DBL_EPSILON
1972 #       define NV_EPSILON DBL_EPSILON
1973 #   endif
1974 #   ifdef DBL_MAX               /* XXX Does DBL_MAX imply having DBL_MIN? */
1975 #       define NV_MAX DBL_MAX
1976 #       define NV_MIN DBL_MIN
1977 #   else
1978 #       ifdef HUGE_VAL
1979 #           define NV_MAX HUGE_VAL
1980 #       endif
1981 #   endif
1982 #   define Perl_cos cos
1983 #   define Perl_sin sin
1984 #   define Perl_sqrt sqrt
1985 #   define Perl_exp exp
1986 #   define Perl_log log
1987 #   define Perl_atan2 atan2
1988 #   define Perl_pow pow
1989 #   define Perl_floor floor
1990 #   define Perl_ceil ceil
1991 #   define Perl_fmod fmod
1992 #   define Perl_modf(x,y) modf(x,y)
1993 #   define Perl_frexp(x,y) frexp(x,y)
1994 #   define Perl_ldexp(x,y) ldexp(x,y)
1995 #   ifndef Perl_isnan
1996 #       ifdef HAS_ISNAN
1997 #           define Perl_isnan(x) isnan(x)
1998 #       endif
1999 #   endif
2000 #   ifndef Perl_isinf
2001 #       if defined(HAS_ISINF)
2002 #           define Perl_isinf(x) isinf(x)
2003 #       elif defined(DBL_MAX)
2004 #           define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
2005 #       endif
2006 #   endif
2007 #   ifndef Perl_isfinite
2008 #     ifdef HAS_ISFINITE
2009 #       define Perl_isfinite(x) isfinite(x)
2010 #     elif defined(HAS_FINITE)
2011 #       define Perl_isfinite(x) finite(x)
2012 #     elif defined(DBL_MAX)
2013 #       define Perl_isfinite(x) ((x) <= DBL_MAX && (x) >= -DBL_MAX)
2014 #     endif
2015 #   endif
2016 #endif
2017
2018 /* fpclassify(): C99.  It is supposed to be a macro that switches on
2019 * the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
2020 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2021 #    include <math.h>
2022 #    if defined(FP_INFINITE) && defined(FP_NAN)
2023 #        define Perl_fp_class(x)        fpclassify(x)
2024 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
2025 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
2026 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
2027 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2028 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
2029 #    elif defined(FP_PLUS_INF) && defined(FP_QNAN)
2030 /* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
2031  * actually not the C99 fpclassify, with its own set of return defines. */
2032 #        define Perl_fp_class(x)        fpclassify(x)
2033 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PLUS_INF)
2034 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_MINUS_INF)
2035 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_QNAN)
2036 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
2037 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PLUS_NORM)
2038 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_MINUS_NORM)
2039 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PLUS_DENORM)
2040 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_MINUS_DENORM)
2041 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PLUS_ZERO)
2042 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_MINUS_ZERO)
2043 #    else
2044 #        undef Perl_fp_class /* Unknown set of defines */
2045 #    endif
2046 #endif
2047
2048 /* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
2049  * are identical to the C99 fpclassify(). */
2050 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
2051 #    include <math.h>
2052 #    ifdef __VMS
2053      /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
2054 #        include <fp.h>
2055      /* oh, and the isnormal macro has a typo in it! */
2056 #    undef isnormal
2057 #    define isnormal(x) Perl_fp_class_norm(x)
2058 #    endif
2059 #    if defined(FP_INFINITE) && defined(FP_NAN)
2060 #        define Perl_fp_class(x)        fp_classify(x)
2061 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
2062 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
2063 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
2064 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2065 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
2066 #    else
2067 #        undef Perl_fp_class /* Unknown set of defines */
2068 #    endif
2069 #endif
2070
2071 /* Feel free to check with me for the SGI manpages, SGI testing,
2072  * etcetera, if you want to try getting this to work with IRIX.
2073  *
2074  * - Allen <allens@cpan.org> */
2075
2076 /* fpclass(): SysV, at least Solaris and some versions of IRIX. */
2077 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
2078 /* Solaris and IRIX have fpclass/fpclassl, but they are using
2079  * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2080  * Define some symbols also as cpp symbols so we can detect them. */
2081 #    if defined(__sun) || defined(__irix__) /* XXX Configure test instead */
2082 #     define FP_PINF FP_PINF
2083 #     define FP_QNAN FP_QNAN
2084 #    endif
2085 #    include <math.h>
2086 #    ifdef I_IEEFP
2087 #        include <ieeefp.h>
2088 #    endif
2089 #    ifdef I_FP
2090 #        include <fp.h>
2091 #    endif
2092 #    if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
2093 #        define Perl_fp_class(x)        fpclassl(x)
2094 #    else
2095 #        define Perl_fp_class(x)        fpclass(x)
2096 #    endif
2097 #    if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
2098 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_CLASS_SNAN)
2099 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_CLASS_QNAN)
2100 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_CLASS_NINF)
2101 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_CLASS_PINF)
2102 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_CLASS_NNORM)
2103 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_CLASS_PNORM)
2104 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_CLASS_NDENORM)
2105 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_CLASS_PDENORM)
2106 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_CLASS_NZERO)
2107 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_CLASS_PZERO)
2108 #    elif defined(FP_PINF) && defined(FP_QNAN)
2109 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
2110 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
2111 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_NINF)
2112 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PINF)
2113 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_NNORM)
2114 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PNORM)
2115 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_NDENORM)
2116 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PDENORM)
2117 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_NZERO)
2118 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PZERO)
2119 #    else
2120 #        undef Perl_fp_class /* Unknown set of defines */
2121 #    endif
2122 #endif
2123
2124 /* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2125 #if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
2126 #    include <math.h>
2127 #    if !defined(FP_SNAN) && defined(I_FP_CLASS)
2128 #        include <fp_class.h>
2129 #    endif
2130 #    if defined(FP_POS_INF) && defined(FP_QNAN)
2131 #        ifdef __irix__ /* XXX Configure test instead */
2132 #            ifdef USE_LONG_DOUBLE
2133 #                define Perl_fp_class(x)        fp_class_l(x)
2134 #            else
2135 #                define Perl_fp_class(x)        fp_class_d(x)
2136 #            endif
2137 #        else
2138 #            if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2139 #                define Perl_fp_class(x)        fp_classl(x)
2140 #            else
2141 #                define Perl_fp_class(x)        fp_class(x)
2142 #            endif
2143 #        endif
2144 #        if defined(FP_POS_INF) && defined(FP_QNAN)
2145 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_SNAN)
2146 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_QNAN)
2147 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_NEG_INF)
2148 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_POS_INF)
2149 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_NEG_NORM)
2150 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_POS_NORM)
2151 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_NEG_DENORM)
2152 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_POS_DENORM)
2153 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_NEG_ZERO)
2154 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_POS_ZERO)
2155 #        else
2156 #            undef Perl_fp_class /* Unknown set of defines */
2157 #        endif
2158 #    endif
2159 #endif
2160
2161 /* class(), _class(): Legacy: AIX. */
2162 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2163 #    include <math.h>
2164 #    if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2165 #        ifndef _cplusplus
2166 #            define Perl_fp_class(x)    class(x)
2167 #        else
2168 #            define Perl_fp_class(x)    _class(x)
2169 #        endif
2170 #        if defined(FP_PLUS_INF) && defined(FP_NANQ)
2171 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_NANS)
2172 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_NANQ)
2173 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_MINUS_INF)
2174 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_PLUS_INF)
2175 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_MINUS_NORM)
2176 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_PLUS_NORM)
2177 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_MINUS_DENORM)
2178 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_PLUS_DENORM)
2179 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_MINUS_ZERO)
2180 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_PLUS_ZERO)
2181 #        else
2182 #            undef Perl_fp_class /* Unknown set of defines */
2183 #        endif
2184 #    endif
2185 #endif
2186
2187 /* Win32: _fpclass(), _isnan(), _finite(). */
2188 #ifdef WIN32
2189 #  ifndef Perl_isnan
2190 #    define Perl_isnan(x) _isnan(x)
2191 #  endif
2192 #  ifndef Perl_isfinite
2193 #    define Perl_isfinite(x) _finite(x)
2194 #  endif
2195 #  ifndef Perl_fp_class_snan
2196 /* No simple way to #define Perl_fp_class because _fpclass()
2197  * returns a set of bits. */
2198 #    define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2199 #    define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
2200 #    define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_QNAN|_FPCLASS_QNAN))
2201 #    define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF))
2202 #    define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF))
2203 #    define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2204 #    define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2205 #    define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2206 #    define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2207 #    define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2208 #    define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2209 #    define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2210 #    define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2211 #    define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2212 #    define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2213 #  endif
2214 #endif
2215
2216 #if !defined(Perl_fp_class_inf) && \
2217   defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2218 #  define Perl_fp_class_inf(x) \
2219     (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2220 #endif
2221
2222 #if !defined(Perl_fp_class_nan) && \
2223   defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2224 #  define Perl_fp_class_nan(x) \
2225     (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2226 #endif
2227
2228 #if !defined(Perl_fp_class_zero) && \
2229   defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2230 #  define Perl_fp_class_zero(x) \
2231     (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2232 #endif
2233
2234 #if !defined(Perl_fp_class_norm) && \
2235   defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2236 #  define Perl_fp_class_norm(x) \
2237     (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2238 #endif
2239
2240 #if !defined(Perl_fp_class_denorm) && \
2241   defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2242 #  define Perl_fp_class_denorm(x) \
2243     (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
2244 #endif
2245
2246 #ifdef UNDER_CE
2247 int isnan(double d);
2248 #endif
2249
2250 #ifndef Perl_isnan
2251 #   ifdef Perl_fp_class_nan
2252 #       define Perl_isnan(x) Perl_fp_class_nan(x)
2253 #   else
2254 #       ifdef HAS_UNORDERED
2255 #           define Perl_isnan(x) unordered((x), 0.0)
2256 #       else
2257 #           define Perl_isnan(x) ((x)!=(x))
2258 #       endif
2259 #   endif
2260 #endif
2261
2262 #ifndef Perl_isinf
2263 #   ifdef Perl_fp_class_inf
2264 #       define Perl_isinf(x) Perl_fp_class_inf(x)
2265 #   endif
2266 #endif
2267
2268 #ifndef Perl_isfinite
2269 #   if defined(HAS_ISFINITE) && !defined(isfinite)
2270 #     define Perl_isfinite(x) isfinite((double)x)
2271 #   elif defined(HAS_FINITE)
2272 #       define Perl_isfinite(x) finite((double)x)
2273 #   elif defined(Perl_fp_class_finite)
2274 #     define Perl_isfinite(x) Perl_fp_class_finite(x)
2275 #   else
2276 /* NaN*0 is NaN, [+-]Inf*0 is NaN, zero for anything else. */
2277 #     define Perl_isfinite(x) (((x) * 0) == 0)
2278 #   endif
2279 #endif
2280
2281 #ifndef Perl_isinf
2282 #   if defined(Perl_isfinite) && defined(Perl_isnan)
2283 #       define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2284 #   endif
2285 #endif
2286
2287 /* The default is to use Perl's own atof() implementation (in numeric.c).
2288  * Usually that is the one to use but for some platforms (e.g. UNICOS)
2289  * it is however best to use the native implementation of atof.
2290  * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2291  * Some good tests to try out with either setting are t/base/num.t,
2292  * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2293  * you may need to be using a different function than atof! */
2294
2295 #ifndef USE_PERL_ATOF
2296 #   ifndef _UNICOS
2297 #       define USE_PERL_ATOF
2298 #   endif
2299 #else
2300 #   if USE_PERL_ATOF == 0
2301 #       undef USE_PERL_ATOF
2302 #   endif
2303 #endif
2304
2305 #ifdef USE_PERL_ATOF
2306 #   define Perl_atof(s) Perl_my_atof(s)
2307 #   define Perl_atof2(s, n) Perl_my_atof2(aTHX_ (s), &(n))
2308 #else
2309 #   define Perl_atof(s) (NV)atof(s)
2310 #   define Perl_atof2(s, n) ((n) = atof(s))
2311 #endif
2312
2313 /* Previously these definitions used hardcoded figures.
2314  * It is hoped these formula are more portable, although
2315  * no data one way or another is presently known to me.
2316  * The "PERL_" names are used because these calculated constants
2317  * do not meet the ANSI requirements for LONG_MAX, etc., which
2318  * need to be constants acceptable to #if - kja
2319  *    define PERL_LONG_MAX        2147483647L
2320  *    define PERL_LONG_MIN        (-LONG_MAX - 1)
2321  *    define PERL ULONG_MAX       4294967295L
2322  */
2323
2324 #ifdef I_LIMITS  /* Needed for cast_xxx() functions below. */
2325 #  include <limits.h>
2326 #endif
2327 /* Included values.h above if necessary; still including limits.h down here,
2328  * despite doing above, because math.h might have overridden... XXX - Allen */
2329
2330 /*
2331  * Try to figure out max and min values for the integral types.  THE CORRECT
2332  * SOLUTION TO THIS MESS: ADAPT enquire.c FROM GCC INTO CONFIGURE.  The
2333  * following hacks are used if neither limits.h or values.h provide them:
2334  * U<TYPE>_MAX: for types >= int: ~(unsigned TYPE)0
2335  *              for types <  int:  (unsigned TYPE)~(unsigned)0
2336  *      The argument to ~ must be unsigned so that later signed->unsigned
2337  *      conversion can't modify the value's bit pattern (e.g. -0 -> +0),
2338  *      and it must not be smaller than int because ~ does integral promotion.
2339  * <type>_MAX: (<type>) (U<type>_MAX >> 1)
2340  * <type>_MIN: -<type>_MAX - <is_twos_complement_architecture: (3 & -1) == 3>.
2341  *      The latter is a hack which happens to work on some machines but
2342  *      does *not* catch any random system, or things like integer types
2343  *      with NaN if that is possible.
2344  *
2345  * All of the types are explicitly cast to prevent accidental loss of
2346  * numeric range, and in the hope that they will be less likely to confuse
2347  * over-eager optimizers.
2348  *
2349  */
2350
2351 #define PERL_UCHAR_MIN ((unsigned char)0)
2352
2353 #ifdef UCHAR_MAX
2354 #  define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2355 #else
2356 #  ifdef MAXUCHAR
2357 #    define PERL_UCHAR_MAX ((unsigned char)MAXUCHAR)
2358 #  else
2359 #    define PERL_UCHAR_MAX       ((unsigned char)~(unsigned)0)
2360 #  endif
2361 #endif
2362
2363 /*
2364  * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2365  * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2366  * depending on local options. Until Configure detects this (or at least
2367  * detects whether the "signed" keyword is available) the CHAR ranges
2368  * will not be included. UCHAR functions normally.
2369  *                                                           - kja
2370  */
2371
2372 #define PERL_USHORT_MIN ((unsigned short)0)
2373
2374 #ifdef USHORT_MAX
2375 #  define PERL_USHORT_MAX ((unsigned short)USHORT_MAX)
2376 #else
2377 #  ifdef MAXUSHORT
2378 #    define PERL_USHORT_MAX ((unsigned short)MAXUSHORT)
2379 #  else
2380 #    ifdef USHRT_MAX
2381 #      define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2382 #    else
2383 #      define PERL_USHORT_MAX       ((unsigned short)~(unsigned)0)
2384 #    endif
2385 #  endif
2386 #endif
2387
2388 #ifdef SHORT_MAX
2389 #  define PERL_SHORT_MAX ((short)SHORT_MAX)
2390 #else
2391 #  ifdef MAXSHORT    /* Often used in <values.h> */
2392 #    define PERL_SHORT_MAX ((short)MAXSHORT)
2393 #  else
2394 #    ifdef SHRT_MAX
2395 #      define PERL_SHORT_MAX ((short)SHRT_MAX)
2396 #    else
2397 #      define PERL_SHORT_MAX      ((short) (PERL_USHORT_MAX >> 1))
2398 #    endif
2399 #  endif
2400 #endif
2401
2402 #ifdef SHORT_MIN
2403 #  define PERL_SHORT_MIN ((short)SHORT_MIN)
2404 #else
2405 #  ifdef MINSHORT
2406 #    define PERL_SHORT_MIN ((short)MINSHORT)
2407 #  else
2408 #    ifdef SHRT_MIN
2409 #      define PERL_SHORT_MIN ((short)SHRT_MIN)
2410 #    else
2411 #      define PERL_SHORT_MIN        (-PERL_SHORT_MAX - ((3 & -1) == 3))
2412 #    endif
2413 #  endif
2414 #endif
2415
2416 #ifdef UINT_MAX
2417 #  define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2418 #else
2419 #  ifdef MAXUINT
2420 #    define PERL_UINT_MAX ((unsigned int)MAXUINT)
2421 #  else
2422 #    define PERL_UINT_MAX       (~(unsigned int)0)
2423 #  endif
2424 #endif
2425
2426 #define PERL_UINT_MIN ((unsigned int)0)
2427
2428 #ifdef INT_MAX
2429 #  define PERL_INT_MAX ((int)INT_MAX)
2430 #else
2431 #  ifdef MAXINT    /* Often used in <values.h> */
2432 #    define PERL_INT_MAX ((int)MAXINT)
2433 #  else
2434 #    define PERL_INT_MAX        ((int)(PERL_UINT_MAX >> 1))
2435 #  endif
2436 #endif
2437
2438 #ifdef INT_MIN
2439 #  define PERL_INT_MIN ((int)INT_MIN)
2440 #else
2441 #  ifdef MININT
2442 #    define PERL_INT_MIN ((int)MININT)
2443 #  else
2444 #    define PERL_INT_MIN        (-PERL_INT_MAX - ((3 & -1) == 3))
2445 #  endif
2446 #endif
2447
2448 #ifdef ULONG_MAX
2449 #  define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2450 #else
2451 #  ifdef MAXULONG
2452 #    define PERL_ULONG_MAX ((unsigned long)MAXULONG)
2453 #  else
2454 #    define PERL_ULONG_MAX       (~(unsigned long)0)
2455 #  endif
2456 #endif
2457
2458 #define PERL_ULONG_MIN ((unsigned long)0L)
2459
2460 #ifdef LONG_MAX
2461 #  define PERL_LONG_MAX ((long)LONG_MAX)
2462 #else
2463 #  ifdef MAXLONG    /* Often used in <values.h> */
2464 #    define PERL_LONG_MAX ((long)MAXLONG)
2465 #  else
2466 #    define PERL_LONG_MAX        ((long) (PERL_ULONG_MAX >> 1))
2467 #  endif
2468 #endif
2469
2470 #ifdef LONG_MIN
2471 #  define PERL_LONG_MIN ((long)LONG_MIN)
2472 #else
2473 #  ifdef MINLONG
2474 #    define PERL_LONG_MIN ((long)MINLONG)
2475 #  else
2476 #    define PERL_LONG_MIN        (-PERL_LONG_MAX - ((3 & -1) == 3))
2477 #  endif
2478 #endif
2479
2480 #ifdef UV_IS_QUAD
2481
2482 #    define PERL_UQUAD_MAX      (~(UV)0)
2483 #    define PERL_UQUAD_MIN      ((UV)0)
2484 #    define PERL_QUAD_MAX       ((IV) (PERL_UQUAD_MAX >> 1))
2485 #    define PERL_QUAD_MIN       (-PERL_QUAD_MAX - ((3 & -1) == 3))
2486
2487 #endif
2488
2489 typedef MEM_SIZE STRLEN;
2490
2491 typedef struct op OP;
2492 typedef struct cop COP;
2493 typedef struct unop UNOP;
2494 typedef struct binop BINOP;
2495 typedef struct listop LISTOP;
2496 typedef struct logop LOGOP;
2497 typedef struct pmop PMOP;
2498 typedef struct svop SVOP;
2499 typedef struct padop PADOP;
2500 typedef struct pvop PVOP;
2501 typedef struct loop LOOP;
2502
2503 #ifdef PERL_CORE
2504 typedef struct opslab OPSLAB;
2505 typedef struct opslot OPSLOT;
2506 #endif
2507
2508 typedef struct block_hooks BHK;
2509 typedef struct custom_op XOP;
2510
2511 typedef struct interpreter PerlInterpreter;
2512
2513 /* SGI's <sys/sema.h> has struct sv */
2514 #if defined(__sgi)
2515 #   define STRUCT_SV perl_sv
2516 #else
2517 #   define STRUCT_SV sv
2518 #endif
2519 typedef struct STRUCT_SV SV;
2520 typedef struct av AV;
2521 typedef struct hv HV;
2522 typedef struct cv CV;
2523 typedef struct p5rx REGEXP;
2524 typedef struct gp GP;
2525 typedef struct gv GV;
2526 typedef struct io IO;
2527 typedef struct context PERL_CONTEXT;
2528 typedef struct block BLOCK;
2529
2530 typedef struct magic MAGIC;
2531 typedef struct xpv XPV;
2532 typedef struct xpviv XPVIV;
2533 typedef struct xpvuv XPVUV;
2534 typedef struct xpvnv XPVNV;
2535 typedef struct xpvmg XPVMG;
2536 typedef struct xpvlv XPVLV;
2537 typedef struct xpvinvlist XINVLIST;
2538 typedef struct xpvav XPVAV;
2539 typedef struct xpvhv XPVHV;
2540 typedef struct xpvgv XPVGV;
2541 typedef struct xpvcv XPVCV;
2542 typedef struct xpvbm XPVBM;
2543 typedef struct xpvfm XPVFM;
2544 typedef struct xpvio XPVIO;
2545 typedef struct mgvtbl MGVTBL;
2546 typedef union any ANY;
2547 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2548 typedef struct ptr_tbl PTR_TBL_t;
2549 typedef struct clone_params CLONE_PARAMS;
2550
2551 /* a pad or name pad is currently just an AV; but that might change,
2552  * so hide the type.  */
2553 typedef struct padlist PADLIST;
2554 typedef AV PAD;
2555 typedef AV PADNAMELIST;
2556 typedef SV PADNAME;
2557
2558 /* enable PERL_NEW_COPY_ON_WRITE by default */
2559 #if !defined(PERL_OLD_COPY_ON_WRITE) && !defined(PERL_NEW_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2560 #  define PERL_NEW_COPY_ON_WRITE
2561 #endif
2562
2563 #if defined(PERL_OLD_COPY_ON_WRITE) || defined(PERL_NEW_COPY_ON_WRITE)
2564 # if defined(PERL_OLD_COPY_ON_WRITE) && defined(PERL_NEW_COPY_ON_WRITE)
2565 #  error PERL_OLD_COPY_ON_WRITE and PERL_NEW_COPY_ON_WRITE are exclusive
2566 # else
2567 #  define PERL_ANY_COW
2568 # endif
2569 #else
2570 # define PERL_SAWAMPERSAND
2571 #endif
2572
2573 #include "handy.h"
2574
2575 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2576 #   if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2577 #       define USE_64_BIT_RAWIO /* implicit */
2578 #   endif
2579 #endif
2580
2581 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2582  * fseeko/ftello if possible.  Don't go #defining ftell to ftello yourself,
2583  * however, because operating systems like to do that themself. */
2584 #ifndef FSEEKSIZE
2585 #   ifdef HAS_FSEEKO
2586 #       define FSEEKSIZE LSEEKSIZE
2587 #   else
2588 #       define FSEEKSIZE LONGSIZE
2589 #   endif
2590 #endif
2591
2592 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2593 #   if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2594 #       define USE_64_BIT_STDIO /* implicit */
2595 #   endif
2596 #endif
2597
2598 #ifdef USE_64_BIT_RAWIO
2599 #   ifdef HAS_OFF64_T
2600 #       undef Off_t
2601 #       define Off_t off64_t
2602 #       undef LSEEKSIZE
2603 #       define LSEEKSIZE 8
2604 #   endif
2605 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2606  * will trigger defines like the ones below.  Some 64-bit environments,
2607  * however, do not.  Therefore we have to explicitly mix and match. */
2608 #   if defined(USE_OPEN64)
2609 #       define open open64
2610 #   endif
2611 #   if defined(USE_LSEEK64)
2612 #       define lseek lseek64
2613 #   else
2614 #       if defined(USE_LLSEEK)
2615 #           define lseek llseek
2616 #       endif
2617 #   endif
2618 #   if defined(USE_STAT64)
2619 #       define stat stat64
2620 #   endif
2621 #   if defined(USE_FSTAT64)
2622 #       define fstat fstat64
2623 #   endif
2624 #   if defined(USE_LSTAT64)
2625 #       define lstat lstat64
2626 #   endif
2627 #   if defined(USE_FLOCK64)
2628 #       define flock flock64
2629 #   endif
2630 #   if defined(USE_LOCKF64)
2631 #       define lockf lockf64
2632 #   endif
2633 #   if defined(USE_FCNTL64)
2634 #       define fcntl fcntl64
2635 #   endif
2636 #   if defined(USE_TRUNCATE64)
2637 #       define truncate truncate64
2638 #   endif
2639 #   if defined(USE_FTRUNCATE64)
2640 #       define ftruncate ftruncate64
2641 #   endif
2642 #endif
2643
2644 #ifdef USE_64_BIT_STDIO
2645 #   ifdef HAS_FPOS64_T
2646 #       undef Fpos_t
2647 #       define Fpos_t fpos64_t
2648 #   endif
2649 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2650  * will trigger defines like the ones below.  Some 64-bit environments,
2651  * however, do not. */
2652 #   if defined(USE_FOPEN64)
2653 #       define fopen fopen64
2654 #   endif
2655 #   if defined(USE_FSEEK64)
2656 #       define fseek fseek64 /* don't do fseeko here, see perlio.c */
2657 #   endif
2658 #   if defined(USE_FTELL64)
2659 #       define ftell ftell64 /* don't do ftello here, see perlio.c */
2660 #   endif
2661 #   if defined(USE_FSETPOS64)
2662 #       define fsetpos fsetpos64
2663 #   endif
2664 #   if defined(USE_FGETPOS64)
2665 #       define fgetpos fgetpos64
2666 #   endif
2667 #   if defined(USE_TMPFILE64)
2668 #       define tmpfile tmpfile64
2669 #   endif
2670 #   if defined(USE_FREOPEN64)
2671 #       define freopen freopen64
2672 #   endif
2673 #endif
2674
2675 #if defined(OS2)
2676 #  include "iperlsys.h"
2677 #endif
2678
2679 #ifdef DOSISH
2680 #   if defined(OS2)
2681 #       include "os2ish.h"
2682 #   else
2683 #       include "dosish.h"
2684 #   endif
2685 #elif defined(VMS)
2686 #   include "vmsish.h"
2687 #elif defined(PLAN9)
2688 #   include "./plan9/plan9ish.h"
2689 #elif defined(__VOS__)
2690 #   ifdef __GNUC__
2691 #     include "./vos/vosish.h"
2692 #   else
2693 #     include "vos/vosish.h"
2694 #   endif
2695 #elif defined(__SYMBIAN32__)
2696 #   include "symbian/symbianish.h"
2697 #elif defined(__HAIKU__)
2698 #   include "haiku/haikuish.h"
2699 #else
2700 #   include "unixish.h"
2701 #endif
2702
2703 /* NSIG logic from Configure --> */
2704 /* Strange style to avoid deeply-nested #if/#else/#endif */
2705 #ifndef NSIG
2706 #  ifdef _NSIG
2707 #    define NSIG (_NSIG)
2708 #  endif
2709 #endif
2710
2711 #ifndef NSIG
2712 #  ifdef SIGMAX
2713 #    define NSIG (SIGMAX+1)
2714 #  endif
2715 #endif
2716
2717 #ifndef NSIG
2718 #  ifdef SIG_MAX
2719 #    define NSIG (SIG_MAX+1)
2720 #  endif
2721 #endif
2722
2723 #ifndef NSIG
2724 #  ifdef _SIG_MAX
2725 #    define NSIG (_SIG_MAX+1)
2726 #  endif
2727 #endif
2728
2729 #ifndef NSIG
2730 #  ifdef MAXSIG
2731 #    define NSIG (MAXSIG+1)
2732 #  endif
2733 #endif
2734
2735 #ifndef NSIG
2736 #  ifdef MAX_SIG
2737 #    define NSIG (MAX_SIG+1)
2738 #  endif
2739 #endif
2740
2741 #ifndef NSIG
2742 #  ifdef SIGARRAYSIZE
2743 #    define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
2744 #  endif
2745 #endif
2746
2747 #ifndef NSIG
2748 #  ifdef _sys_nsig
2749 #    define NSIG (_sys_nsig) /* Solaris 2.5 */
2750 #  endif
2751 #endif
2752
2753 /* Default to some arbitrary number that's big enough to get most
2754    of the common signals.
2755 */
2756 #ifndef NSIG
2757 #    define NSIG 50
2758 #endif
2759 /* <-- NSIG logic from Configure */
2760
2761 #ifndef NO_ENVIRON_ARRAY
2762 #  define USE_ENVIRON_ARRAY
2763 #endif
2764
2765 /*
2766  * initialise to avoid floating-point exceptions from overflow, etc
2767  */
2768 #ifndef PERL_FPU_INIT
2769 #  ifdef HAS_FPSETMASK
2770 #    if HAS_FLOATINGPOINT_H
2771 #      include <floatingpoint.h>
2772 #    endif
2773 /* Some operating systems have this as a macro, which in turn expands to a comma
2774    expression, and the last sub-expression is something that gets calculated,
2775    and then they have the gall to warn that a value computed is not used. Hence
2776    cast to void.  */
2777 #    define PERL_FPU_INIT (void)fpsetmask(0)
2778 #  else
2779 #    if defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2780 #      define PERL_FPU_INIT       PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2781 #      define PERL_FPU_PRE_EXEC   { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2782 #      define PERL_FPU_POST_EXEC    rsignal_restore(SIGFPE, &xfpe); }
2783 #    else
2784 #      define PERL_FPU_INIT
2785
2786 #    endif
2787 #  endif
2788 #endif
2789 #ifndef PERL_FPU_PRE_EXEC
2790 #  define PERL_FPU_PRE_EXEC   {
2791 #  define PERL_FPU_POST_EXEC  }
2792 #endif
2793
2794 #ifndef PERL_SYS_INIT3_BODY
2795 #  define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
2796 #endif
2797
2798 /*
2799 =head1 Miscellaneous Functions
2800
2801 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
2802 Provides system-specific tune up of the C runtime environment necessary to
2803 run Perl interpreters.  This should be called only once, before creating
2804 any Perl interpreters.
2805
2806 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
2807 Provides system-specific tune up of the C runtime environment necessary to
2808 run Perl interpreters.  This should be called only once, before creating
2809 any Perl interpreters.
2810
2811 =for apidoc Am|void|PERL_SYS_TERM|
2812 Provides system-specific clean up of the C runtime environment after
2813 running Perl interpreters.  This should be called only once, after
2814 freeing any remaining Perl interpreters.
2815
2816 =cut
2817  */
2818
2819 #define PERL_SYS_INIT(argc, argv)       Perl_sys_init(argc, argv)
2820 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
2821 #define PERL_SYS_TERM()                 Perl_sys_term()
2822
2823 #ifndef PERL_WRITE_MSG_TO_CONSOLE
2824 #  define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
2825 #endif
2826
2827 #ifndef MAXPATHLEN
2828 #  ifdef PATH_MAX
2829 #    ifdef _POSIX_PATH_MAX
2830 #       if PATH_MAX > _POSIX_PATH_MAX
2831 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
2832  * included the null byte or not.  Later amendments of POSIX,
2833  * XPG4, the Austin Group, and the Single UNIX Specification
2834  * all explicitly include the null byte in the PATH_MAX.
2835  * Ditto for _POSIX_PATH_MAX. */
2836 #         define MAXPATHLEN PATH_MAX
2837 #       else
2838 #         define MAXPATHLEN _POSIX_PATH_MAX
2839 #       endif
2840 #    else
2841 #      define MAXPATHLEN (PATH_MAX+1)
2842 #    endif
2843 #  else
2844 #    define MAXPATHLEN 1024     /* Err on the large side. */
2845 #  endif
2846 #endif
2847
2848 /* In case Configure was not used (we are using a "canned config"
2849  * such as Win32, or a cross-compilation setup, for example) try going
2850  * by the gcc major and minor versions.  One useful URL is
2851  * http://www.ohse.de/uwe/articles/gcc-attributes.html,
2852  * but contrary to this information warn_unused_result seems
2853  * not to be in gcc 3.3.5, at least. --jhi
2854  * Also, when building extensions with an installed perl, this allows
2855  * the user to upgrade gcc and get the right attributes, rather than
2856  * relying on the list generated at Configure time.  --AD
2857  * Set these up now otherwise we get confused when some of the <*thread.h>
2858  * includes below indirectly pull in <perlio.h> (which needs to know if we
2859  * have HASATTRIBUTE_FORMAT).
2860  */
2861
2862 #ifndef PERL_MICRO
2863 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
2864 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
2865 #    define HASATTRIBUTE_DEPRECATED
2866 #  endif
2867 #  if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
2868 #    define HASATTRIBUTE_FORMAT
2869 #    if defined __MINGW32__
2870 #      define PRINTF_FORMAT_NULL_OK
2871 #    endif
2872 #  endif
2873 #  if __GNUC__ >= 3 /* 3.0 -> */
2874 #    define HASATTRIBUTE_MALLOC
2875 #  endif
2876 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
2877 #    define HASATTRIBUTE_NONNULL
2878 #  endif
2879 #  if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
2880 #    define HASATTRIBUTE_NORETURN
2881 #  endif
2882 #  if __GNUC__ >= 3 /* gcc 3.0 -> */
2883 #    define HASATTRIBUTE_PURE
2884 #  endif
2885 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2886 #    define HASATTRIBUTE_UNUSED
2887 #  endif
2888 #  if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
2889 #    define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
2890 #  endif
2891 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2892 #    define HASATTRIBUTE_WARN_UNUSED_RESULT
2893 #  endif
2894 #endif
2895 #endif /* #ifndef PERL_MICRO */
2896
2897 /* USE_5005THREADS needs to be after unixish.h as <pthread.h> includes
2898  * <sys/signal.h> which defines NSIG - which will stop inclusion of <signal.h>
2899  * this results in many functions being undeclared which bothers C++
2900  * May make sense to have threads after "*ish.h" anyway
2901  */
2902
2903 #if defined(USE_ITHREADS)
2904 #  ifdef NETWARE
2905 #   include <nw5thread.h>
2906 #  else
2907 #    ifdef WIN32
2908 #      include <win32thread.h>
2909 #    else
2910 #      ifdef OS2
2911 #        include "os2thread.h"
2912 #      else
2913 #        ifdef I_MACH_CTHREADS
2914 #          include <mach/cthreads.h>
2915 typedef cthread_t       perl_os_thread;
2916 typedef mutex_t         perl_mutex;
2917 typedef condition_t     perl_cond;
2918 typedef void *          perl_key;
2919 #        else /* Posix threads */
2920 #          ifdef I_PTHREAD
2921 #            include <pthread.h>
2922 #          endif
2923 typedef pthread_t       perl_os_thread;
2924 typedef pthread_mutex_t perl_mutex;
2925 typedef pthread_cond_t  perl_cond;
2926 typedef pthread_key_t   perl_key;
2927 #        endif /* I_MACH_CTHREADS */
2928 #      endif /* OS2 */
2929 #    endif /* WIN32 */
2930 #  endif /* NETWARE */
2931 #endif /* USE_ITHREADS */
2932
2933 #if defined(WIN32)
2934 #  include "win32.h"
2935 #endif
2936
2937 #ifdef NETWARE
2938 #  include "netware.h"
2939 #endif
2940
2941 #define STATUS_UNIX     PL_statusvalue
2942 #ifdef VMS
2943 #   define STATUS_NATIVE        PL_statusvalue_vms
2944 /*
2945  * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
2946  * its contents can not be trusted.  Unfortunately, Perl seems to check
2947  * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
2948  * be updated also.
2949  */
2950 #  include <stsdef.h>
2951 #  include <ssdef.h>
2952 /* Presume this because if VMS changes it, it will require a new
2953  * set of APIs for waiting on children for binary compatibility.
2954  */
2955 #  define child_offset_bits (8)
2956 #  ifndef C_FAC_POSIX
2957 #  define C_FAC_POSIX 0x35A000
2958 #  endif
2959
2960 /*  STATUS_EXIT - validates and returns a NATIVE exit status code for the
2961  * platform from the existing UNIX or Native status values.
2962  */
2963
2964 #   define STATUS_EXIT \
2965         (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
2966            (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
2967
2968
2969 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
2970  * exit code and shifts the UNIX value over the correct number of bits to
2971  * be a child status.  Usually the number of bits is 8, but that could be
2972  * platform dependent.  The NATIVE status code is presumed to have either
2973  * from a child process.
2974  */
2975
2976 /* This is complicated.  The child processes return a true native VMS
2977    status which must be saved.  But there is an assumption in Perl that
2978    the UNIX child status has some relationship to errno values, so
2979    Perl tries to translate it to text in some of the tests.
2980    In order to get the string translation correct, for the error, errno
2981    must be EVMSERR, but that generates a different text message
2982    than what the test programs are expecting.  So an errno value must
2983    be derived from the native status value when an error occurs.
2984    That will hide the true native status message.  With this version of
2985    perl, the true native child status can always be retrieved so that
2986    is not a problem.  But in this case, Pl_statusvalue and errno may
2987    have different values in them.
2988  */
2989
2990 #   define STATUS_NATIVE_CHILD_SET(n) \
2991         STMT_START {                                                    \
2992             I32 evalue = (I32)n;                                        \
2993             if (evalue == EVMSERR) {                                    \
2994               PL_statusvalue_vms = vaxc$errno;                          \
2995               PL_statusvalue = evalue;                                  \
2996             } else {                                                    \
2997               PL_statusvalue_vms = evalue;                              \
2998               if (evalue == -1) {                                       \
2999                 PL_statusvalue = -1;                                    \
3000                 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3001               } else                                                    \
3002                 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1);    \
3003               set_vaxc_errno(evalue);                                   \
3004               if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX)    \
3005                   set_errno(EVMSERR);                                   \
3006               else set_errno(Perl_vms_status_to_unix(evalue, 0));       \
3007               PL_statusvalue = PL_statusvalue << child_offset_bits;     \
3008             }                                                           \
3009         } STMT_END
3010
3011 #   ifdef VMSISH_STATUS
3012 #       define STATUS_CURRENT   (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
3013 #   else
3014 #       define STATUS_CURRENT   STATUS_UNIX
3015 #   endif
3016
3017   /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3018    * the NATIVE status to an equivalent value.  Can not be used to translate
3019    * exit code values as exit code values are not guaranteed to have any
3020    * relationship at all to errno values.
3021    * This is used when Perl is forcing errno to have a specific value.
3022    */
3023 #   define STATUS_UNIX_SET(n)                           \
3024         STMT_START {                                    \
3025             I32 evalue = (I32)n;                        \
3026             PL_statusvalue = evalue;                    \
3027             if (PL_statusvalue != -1) {                 \
3028                 if (PL_statusvalue != EVMSERR) {        \
3029                   PL_statusvalue &= 0xFFFF;             \
3030                   if (MY_POSIX_EXIT)                    \
3031                     PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3032                   else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3033                 }                                       \
3034                 else {                                  \
3035                   PL_statusvalue_vms = vaxc$errno;      \
3036                 }                                       \
3037             }                                           \
3038             else PL_statusvalue_vms = SS$_ABORT;        \
3039             set_vaxc_errno(PL_statusvalue_vms);         \
3040         } STMT_END
3041
3042   /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
3043    * the NATIVE error status based on it.
3044    *
3045    * When in the default mode to comply with the Perl VMS documentation,
3046    * 0 is a success and any other code sets the NATIVE status to a failure
3047    * code of SS$_ABORT.
3048    *
3049    * In the new POSIX EXIT mode, native status will be set so that the
3050    * actual exit code will can be retrieved by the calling program or
3051    * shell.
3052    *
3053    * If the exit code is not clearly a UNIX parent or child exit status,
3054    * it will be passed through as a VMS status.
3055    */
3056
3057 #   define STATUS_UNIX_EXIT_SET(n)                      \
3058         STMT_START {                                    \
3059             I32 evalue = (I32)n;                        \
3060             PL_statusvalue = evalue;                    \
3061             if (MY_POSIX_EXIT) { \
3062               if (evalue <= 0xFF00) {           \
3063                   if (evalue > 0xFF)                    \
3064                     evalue = (evalue >> child_offset_bits) & 0xFF; \
3065                   PL_statusvalue_vms =          \
3066                     (C_FAC_POSIX | (evalue << 3 ) |     \
3067                     ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3068               } else /* forgive them Perl, for they have sinned */ \
3069                 PL_statusvalue_vms = evalue; \
3070             } else { \
3071               if (evalue == 0)                  \
3072                 PL_statusvalue_vms = SS$_NORMAL;        \
3073               else if (evalue <= 0xFF00) \
3074                 PL_statusvalue_vms = SS$_ABORT; \
3075               else { /* forgive them Perl, for they have sinned */ \
3076                   if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3077                   else PL_statusvalue_vms = vaxc$errno; \
3078                   /* And obviously used a VMS status value instead of UNIX */ \
3079                   PL_statusvalue = EVMSERR;             \
3080               } \
3081               set_vaxc_errno(PL_statusvalue_vms);       \
3082             }                                           \
3083         } STMT_END
3084
3085
3086   /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3087    * and sets the NATIVE error status based on it.  This special case
3088    * is needed to maintain compatibility with past VMS behavior.
3089    *
3090    * In the default mode on VMS, this number is passed through as
3091    * both the NATIVE and UNIX status.  Which makes it different
3092    * that the STATUS_UNIX_EXIT_SET.
3093    *
3094    * In the new POSIX EXIT mode, native status will be set so that the
3095    * actual exit code will can be retrieved by the calling program or
3096    * shell.
3097    *
3098    * A POSIX exit code is from 0 to 255.  If the exit code is higher
3099    * than this, it needs to be assumed that it is a VMS exit code and
3100    * passed through.
3101    */
3102
3103 #   define STATUS_EXIT_SET(n)                           \
3104         STMT_START {                                    \
3105             I32 evalue = (I32)n;                        \
3106             PL_statusvalue = evalue;                    \
3107             if (MY_POSIX_EXIT)                          \
3108                 if (evalue > 255) PL_statusvalue_vms = evalue; else {   \
3109                   PL_statusvalue_vms = \
3110                     (C_FAC_POSIX | (evalue << 3 ) |     \
3111                      ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
3112             else                                        \
3113                 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3114             set_vaxc_errno(PL_statusvalue_vms);         \
3115         } STMT_END
3116
3117
3118  /* This macro forces a success status */
3119 #   define STATUS_ALL_SUCCESS   \
3120         (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
3121
3122  /* This macro forces a failure status */
3123 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, \
3124      vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3125         (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3126
3127 #else
3128 #   define STATUS_NATIVE        PL_statusvalue_posix
3129 #   if defined(WCOREDUMP)
3130 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3131             STMT_START {                                   \
3132                 PL_statusvalue_posix = (n);                \
3133                 if (PL_statusvalue_posix == -1)            \
3134                     PL_statusvalue = -1;                   \
3135                 else {                                     \
3136                     PL_statusvalue =                       \
3137                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3138                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3139                         (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0);  \
3140                 }                                          \
3141             } STMT_END
3142 #   elif defined(WIFEXITED)
3143 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3144             STMT_START {                                   \
3145                 PL_statusvalue_posix = (n);                \
3146                 if (PL_statusvalue_posix == -1)            \
3147                     PL_statusvalue = -1;                   \
3148                 else {                                     \
3149                     PL_statusvalue =                       \
3150                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3151                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0);  \
3152                 }                                          \
3153             } STMT_END
3154 #   else
3155 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3156             STMT_START {                                   \
3157                 PL_statusvalue_posix = (n);                \
3158                 if (PL_statusvalue_posix == -1)            \
3159                     PL_statusvalue = -1;                   \
3160                 else {                                     \
3161                     PL_statusvalue =                       \
3162                         PL_statusvalue_posix & 0xFFFF;     \
3163                 }                                          \
3164             } STMT_END
3165 #   endif
3166 #   define STATUS_UNIX_SET(n)           \
3167         STMT_START {                    \
3168             PL_statusvalue = (n);               \
3169             if (PL_statusvalue != -1)   \
3170                 PL_statusvalue &= 0xFFFF;       \
3171         } STMT_END
3172 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3173 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3174 #   define STATUS_CURRENT STATUS_UNIX
3175 #   define STATUS_EXIT STATUS_UNIX
3176 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3177 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3178 #endif
3179
3180 /* flags in PL_exit_flags for nature of exit() */
3181 #define PERL_EXIT_EXPECTED      0x01
3182 #define PERL_EXIT_DESTRUCT_END  0x02  /* Run END in perl_destruct */
3183 #define PERL_EXIT_WARN          0x04  /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3184 #define PERL_EXIT_ABORT         0x08  /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3185
3186 #ifndef PERL_CORE
3187 /* format to use for version numbers in file/directory names */
3188 /* XXX move to Configure? */
3189 /* This was only ever used for the current version, and that can be done at
3190    compile time, as PERL_FS_VERSION, so should we just delete it?  */
3191 #  ifndef PERL_FS_VER_FMT
3192 #    define PERL_FS_VER_FMT     "%d.%d.%d"
3193 #  endif
3194 #endif
3195
3196 #ifndef PERL_FS_VERSION
3197 #  define PERL_FS_VERSION       PERL_VERSION_STRING
3198 #endif
3199
3200 /* This defines a way to flush all output buffers.  This may be a
3201  * performance issue, so we allow people to disable it.  Also, if
3202  * we are using stdio, there are broken implementations of fflush(NULL)
3203  * out there, Solaris being the most prominent.
3204  */
3205 #ifndef PERL_FLUSHALL_FOR_CHILD
3206 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3207 #  define PERL_FLUSHALL_FOR_CHILD       PerlIO_flush((PerlIO*)NULL)
3208 # else
3209 #  ifdef FFLUSH_ALL
3210 #   define PERL_FLUSHALL_FOR_CHILD      my_fflush_all()
3211 #  else
3212 #   define PERL_FLUSHALL_FOR_CHILD      NOOP
3213 #  endif
3214 # endif
3215 #endif
3216
3217 #ifndef PERL_WAIT_FOR_CHILDREN
3218 #  define PERL_WAIT_FOR_CHILDREN        NOOP
3219 #endif
3220
3221 /* the traditional thread-unsafe notion of "current interpreter". */
3222 #ifndef PERL_SET_INTERP
3223 #  define PERL_SET_INTERP(i)            (PL_curinterp = (PerlInterpreter*)(i))
3224 #endif
3225
3226 #ifndef PERL_GET_INTERP
3227 #  define PERL_GET_INTERP               (PL_curinterp)
3228 #endif
3229
3230 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3231 #  ifdef MULTIPLICITY
3232 #    define PERL_GET_THX                ((PerlInterpreter *)PERL_GET_CONTEXT)
3233 #  endif
3234 #  define PERL_SET_THX(t)               PERL_SET_CONTEXT(t)
3235 #endif
3236
3237 /*
3238     This replaces the previous %_ "hack" by the "%p" hacks.
3239     All that is required is that the perl source does not
3240     use "%-p" or "%-<number>p" or "%<number>p" formats.
3241     These formats will still work in perl code.
3242     See comments in sv.c for further details.
3243
3244     Robin Barker 2005-07-14
3245
3246     No longer use %1p for VDf = %vd.  RMB 2007-10-19
3247 */
3248
3249 #ifndef SVf_
3250 #  define SVf_(n) "-" STRINGIFY(n) "p"
3251 #endif
3252
3253 #ifndef SVf
3254 #  define SVf "-p"
3255 #endif
3256
3257 #ifndef SVf32
3258 #  define SVf32 SVf_(32)
3259 #endif
3260
3261 #ifndef SVf256
3262 #  define SVf256 SVf_(256)
3263 #endif
3264
3265 #define SVfARG(p) ((void*)(p))
3266
3267 #ifndef HEKf
3268 #  define HEKf "2p"
3269 #endif
3270
3271 /* Not ideal, but we cannot easily include a number in an already-numeric
3272  * format sequence. */
3273 #ifndef HEKf256
3274 #  define HEKf256 "3p"
3275 #endif
3276
3277 #define HEKfARG(p) ((void*)(p))
3278
3279 /* Takes three arguments: is_utf8, length, str */
3280 #ifndef UTF8f
3281 #  define UTF8f "d%" UVuf "%4p"
3282 #endif
3283 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3284
3285 #ifdef PERL_CORE
3286 /* not used; but needed for backward compatibility with XS code? - RMB */
3287 #  undef UVf
3288 #else
3289 #  ifndef UVf
3290 #    define UVf UVuf
3291 #  endif
3292 #endif
3293
3294 #ifdef HASATTRIBUTE_DEPRECATED
3295 #  define __attribute__deprecated__         __attribute__((deprecated))
3296 #endif
3297 #ifdef HASATTRIBUTE_FORMAT
3298 #  define __attribute__format__(x,y,z)      __attribute__((format(x,y,z)))
3299 #endif
3300 #ifdef HASATTRIBUTE_MALLOC
3301 #  define __attribute__malloc__             __attribute__((__malloc__))
3302 #endif
3303 #ifdef HASATTRIBUTE_NONNULL
3304 #  define __attribute__nonnull__(a)         __attribute__((nonnull(a)))
3305 #endif
3306 #ifdef HASATTRIBUTE_NORETURN
3307 #  define __attribute__noreturn__           __attribute__((noreturn))
3308 #endif
3309 #ifdef HASATTRIBUTE_PURE
3310 #  define __attribute__pure__               __attribute__((pure))
3311 #endif
3312 #ifdef HASATTRIBUTE_UNUSED
3313 #  define __attribute__unused__             __attribute__((unused))
3314 #endif
3315 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
3316 #  define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
3317 #endif
3318
3319 /* If we haven't defined the attributes yet, define them to blank. */
3320 #ifndef __attribute__deprecated__
3321 #  define __attribute__deprecated__
3322 #endif
3323 #ifndef __attribute__format__
3324 #  define __attribute__format__(x,y,z)
3325 #endif
3326 #ifndef __attribute__malloc__
3327 #  define __attribute__malloc__
3328 #endif
3329 #ifndef __attribute__nonnull__
3330 #  define __attribute__nonnull__(a)
3331 #endif
3332 #ifndef __attribute__noreturn__
3333 #  define __attribute__noreturn__
3334 #endif
3335 #ifndef __attribute__pure__
3336 #  define __attribute__pure__
3337 #endif
3338 #ifndef __attribute__unused__
3339 #  define __attribute__unused__
3340 #endif
3341 #ifndef __attribute__warn_unused_result__
3342 #  define __attribute__warn_unused_result__
3343 #endif
3344
3345 #if defined(DEBUGGING) && defined(I_ASSERT)
3346 #  include <assert.h>
3347 #endif
3348
3349 /* For functions that are marked as __attribute__noreturn__, it's not
3350    appropriate to call return.  In either case, include the lint directive.
3351  */
3352 #ifdef HASATTRIBUTE_NORETURN
3353 #  define NORETURN_FUNCTION_END NOT_REACHED; /* NOTREACHED */
3354 #else
3355 #  define NORETURN_FUNCTION_END NOT_REACHED; /* NOTREACHED */ return 0
3356 #endif
3357
3358 /* Some OS warn on NULL format to printf */
3359 #ifdef PRINTF_FORMAT_NULL_OK
3360 #  define __attribute__format__null_ok__(x,y,z)  __attribute__format__(x,y,z)
3361 #else
3362 #  define __attribute__format__null_ok__(x,y,z)
3363 #endif
3364
3365 #ifdef HAS_BUILTIN_EXPECT
3366 #  define EXPECT(expr,val)                  __builtin_expect(expr,val)
3367 #else
3368 #  define EXPECT(expr,val)                  (expr)
3369 #endif
3370 #define LIKELY(cond)                        EXPECT(cBOOL(cond),TRUE)
3371 #define UNLIKELY(cond)                      EXPECT(cBOOL(cond),FALSE)
3372 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3373 /* placeholder */
3374 #endif
3375
3376
3377 #ifndef __has_builtin
3378 #  define __has_builtin(x) 0 /* not a clang style compiler */
3379 #endif
3380
3381 /* ASSUME is like assert(), but it has a benefit in a release build. It is a
3382    hint to a compiler about a statement of fact in a function call free
3383    expression, which allows the compiler to generate better machine code.
3384    In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3385    the control path is unreachable. In a for loop, ASSUME can be used to hint
3386    that a loop will run atleast X times. ASSUME is based off MSVC's __assume
3387    intrinsic function, see its documents for more details.
3388 */
3389
3390 #ifndef DEBUGGING
3391 #  if __has_builtin(__builtin_unreachable) \
3392      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 5) /* 4.5 -> */
3393 #    define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3394 #  elif defined(_MSC_VER)
3395 #    define ASSUME(x) __assume(x)
3396 #  elif defined(__ARMCC_VERSION) /* untested */
3397 #    define ASSUME(x) __promise(x)
3398 #  else
3399 /* a random compiler might define assert to its own special optimization token
3400    so pass it through to C lib as a last resort */
3401 #    define ASSUME(x) assert(x)
3402 #  endif
3403 #else
3404 #  define ASSUME(x) assert(x)
3405 #endif
3406
3407 #define NOT_REACHED ASSUME(0)
3408
3409 /* Some unistd.h's give a prototype for pause() even though
3410    HAS_PAUSE ends up undefined.  This causes the #define
3411    below to be rejected by the compiler.  Sigh.
3412 */
3413 #ifdef HAS_PAUSE
3414 #define Pause   pause
3415 #else
3416 #define Pause() sleep((32767<<16)+32767)
3417 #endif
3418
3419 #ifndef IOCPARM_LEN
3420 #   ifdef IOCPARM_MASK
3421         /* on BSDish systems we're safe */
3422 #       define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
3423 #   else
3424 #       if defined(_IOC_SIZE) && defined(__GLIBC__)
3425         /* on Linux systems we're safe; except when we're not [perl #38223] */
3426 #           define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3427 #       else
3428         /* otherwise guess at what's safe */
3429 #           define IOCPARM_LEN(x)       256
3430 #       endif
3431 #   endif
3432 #endif
3433
3434 #if defined(__CYGWIN__)
3435 /* USEMYBINMODE
3436  *   This symbol, if defined, indicates that the program should
3437  *   use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3438  *   that a file is in "binary" mode -- that is, that no translation
3439  *   of bytes occurs on read or write operations.
3440  */
3441 #  define USEMYBINMODE /**/
3442 #  include <io.h> /* for setmode() prototype */
3443 #  define my_binmode(fp, iotype, mode) \
3444             (PerlLIO_setmode(fileno(fp), mode) != -1 ? TRUE : FALSE)
3445 #endif
3446
3447 #ifdef __CYGWIN__
3448 void init_os_extras(void);
3449 #endif
3450
3451 #ifdef UNION_ANY_DEFINITION
3452 UNION_ANY_DEFINITION;
3453 #else
3454 union any {
3455     void*       any_ptr;
3456     I32         any_i32;
3457     U32         any_u32;
3458     IV          any_iv;
3459     UV          any_uv;
3460     long        any_long;
3461     bool        any_bool;
3462     void        (*any_dptr) (void*);
3463     void        (*any_dxptr) (pTHX_ void*);
3464 };
3465 #endif
3466
3467 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3468
3469 #define FILTER_READ(idx, sv, len)  filter_read(idx, sv, len)
3470 #define FILTER_DATA(idx) \
3471             (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3472 #define FILTER_ISREADER(idx) \
3473             (PL_parser && PL_parser->rsfp_filters \
3474                 && idx >= AvFILLp(PL_parser->rsfp_filters))
3475 #define PERL_FILTER_EXISTS(i) \
3476             (PL_parser && PL_parser->rsfp_filters \
3477                 && (i) <= av_tindex(PL_parser->rsfp_filters))
3478
3479 #if defined(_AIX) && !defined(_AIX43)
3480 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3481 /* We cannot include <crypt.h> to get the struct crypt_data
3482  * because of setkey prototype problems when threading */
3483 typedef        struct crypt_data {     /* straight from /usr/include/crypt.h */
3484     /* From OSF, Not needed in AIX
3485        char C[28], D[28];
3486     */
3487     char E[48];
3488     char KS[16][48];
3489     char block[66];
3490     char iobuf[16];
3491 } CRYPTD;
3492 #endif /* threading */
3493 #endif /* AIX */
3494
3495 #if !defined(OS2)
3496 #  include "iperlsys.h"
3497 #endif
3498
3499 #ifdef __LIBCATAMOUNT__
3500 #undef HAS_PASSWD  /* unixish.h but not unixish enough. */
3501 #undef HAS_GROUP
3502 #define FAKE_BIT_BUCKET
3503 #endif
3504
3505 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3506  * Note that the USE_HASH_SEED and USE_HASH_SEED_EXPLICIT are *NOT*
3507  * defined by Configure, despite their names being similar to the
3508  * other defines like USE_ITHREADS.  Configure in fact knows nothing
3509  * about the randomised hashes.  Therefore to enable/disable the hash
3510  * randomisation defines use the Configure -Accflags=... instead. */
3511 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED) && !defined(USE_HASH_SEED_EXPLICIT)
3512 #  define USE_HASH_SEED
3513 #endif
3514
3515 /* Win32 defines a type 'WORD' in windef.h. This conflicts with the enumerator
3516  * 'WORD' defined in perly.h. The yytokentype enum is only a debugging aid, so
3517  * it's not really needed.
3518  */
3519 #if defined(WIN32)
3520 #  define YYTOKENTYPE
3521 #endif
3522 #include "perly.h"
3523
3524
3525 /* macros to define bit-fields in structs. */
3526 #ifndef PERL_BITFIELD8
3527 #  define PERL_BITFIELD8 unsigned
3528 #endif
3529 #ifndef PERL_BITFIELD16
3530 #  define PERL_BITFIELD16 unsigned
3531 #endif
3532 #ifndef PERL_BITFIELD32
3533 #  define PERL_BITFIELD32 unsigned
3534 #endif
3535
3536 #include "sv.h"
3537 #include "regexp.h"
3538 #include "util.h"
3539 #include "form.h"
3540 #include "gv.h"
3541 #include "pad.h"
3542 #include "cv.h"
3543 #include "opnames.h"
3544 #include "op.h"
3545 #include "hv.h"
3546 #include "cop.h"
3547 #include "av.h"
3548 #include "mg.h"
3549 #include "scope.h"
3550 #include "warnings.h"
3551 #include "utf8.h"
3552
3553 /* these would be in doio.h if there was such a file */
3554 #define my_stat()  my_stat_flags(SV_GMAGIC)
3555 #define my_lstat() my_lstat_flags(SV_GMAGIC)
3556
3557 /* defined in sv.c, but also used in [ach]v.c */
3558 #undef _XPV_HEAD
3559 #undef _XPVMG_HEAD
3560 #undef _XPVCV_COMMON
3561
3562 typedef struct _sublex_info SUBLEXINFO;
3563 struct _sublex_info {
3564     U8 super_state;     /* lexer state to save */
3565     U16 sub_inwhat;     /* "lex_inwhat" to use */
3566     OP *sub_op;         /* "lex_op" to use */
3567     SV *repl;           /* replacement of s/// or y/// */
3568 };
3569
3570 #include "parser.h"
3571
3572 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
3573
3574 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3575
3576 /* These have to be predeclared, as they are used in proto.h which is #included
3577  * before their definitions in regcomp.h. */
3578
3579 struct scan_data_t;
3580 typedef struct regnode_charclass regnode_charclass;
3581
3582 struct regnode_charclass_class;
3583
3584 /* A hopefully less confusing name.  The sub-classes are all Posix classes only
3585  * used under /l matching */
3586 typedef struct regnode_charclass_class regnode_charclass_posixl;
3587
3588 typedef struct regnode_ssc regnode_ssc;
3589 typedef struct RExC_state_t RExC_state_t;
3590 struct _reg_trie_data;
3591
3592 #endif
3593
3594 struct ptr_tbl_ent {
3595     struct ptr_tbl_ent*         next;
3596     const void*                 oldval;
3597     void*                       newval;
3598 };
3599
3600 struct ptr_tbl {
3601     struct ptr_tbl_ent**        tbl_ary;
3602     UV                          tbl_max;
3603     UV                          tbl_items;
3604     struct ptr_tbl_arena        *tbl_arena;
3605     struct ptr_tbl_ent          *tbl_arena_next;
3606     struct ptr_tbl_ent          *tbl_arena_end;
3607 };
3608
3609 #if defined(htonl) && !defined(HAS_HTONL)
3610 #define HAS_HTONL
3611 #endif
3612 #if defined(htons) && !defined(HAS_HTONS)
3613 #define HAS_HTONS
3614 #endif
3615 #if defined(ntohl) && !defined(HAS_NTOHL)
3616 #define HAS_NTOHL
3617 #endif
3618 #if defined(ntohs) && !defined(HAS_NTOHS)
3619 #define HAS_NTOHS
3620 #endif
3621 #ifndef HAS_HTONL
3622 #define HAS_HTONS
3623 #define HAS_HTONL
3624 #define HAS_NTOHS
3625 #define HAS_NTOHL
3626 #  if (BYTEORDER & 0xffff) == 0x4321
3627 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
3628    re-order their values. However, to behave identically to the alternative
3629    implementations, they should truncate to the correct size.  */
3630 #    define ntohl(x)    ((x)&0xFFFFFFFF)
3631 #    define htonl(x)    ntohl(x)
3632 #    define ntohs(x)    ((x)&0xFFFF)
3633 #    define htons(x)    ntohs(x)
3634 #  elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3635
3636 /* Note that we can't straight out declare our own htonl and htons because
3637    the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
3638    to avoid the overhead of initialising the socket subsystem, but the headers
3639    that *declare* the various functions are still seen. If we declare our own
3640    htonl etc they will clash with the declarations in the Win32 headers.  */
3641
3642 PERL_STATIC_INLINE U32
3643 my_swap32(const U32 x) {
3644     return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)      
3645         | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
3646 }
3647
3648 PERL_STATIC_INLINE U16
3649 my_swap16(const U16 x) {
3650     return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
3651 }
3652
3653 #    define htonl(x)    my_swap32(x)
3654 #    define ntohl(x)    my_swap32(x)
3655 #    define ntohs(x)    my_swap16(x)
3656 #    define htons(x)    my_swap16(x)
3657 #  else
3658 #    error "Unsupported byteorder"
3659 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
3660    the error message. Please check the value of the macro BYTEORDER, as defined
3661    in config.h. The values of BYTEORDER we expect are
3662
3663             big endian  little endian
3664    32 bit       0x4321  0x1234
3665    64 bit   0x87654321  0x12345678
3666
3667    If you have a system with a different byte order, please see
3668    pod/perlhack.pod for how to submit a patch to add supporting code.
3669 */
3670 #  endif
3671 #endif
3672
3673 /*
3674  * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
3675  * -DWS
3676  */
3677 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3678 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
3679    re-order their values. However, to behave identically to the alternative
3680    implementations, they should truncate to the correct size.  */
3681 #  define vtohl(x)      ((x)&0xFFFFFFFF)
3682 #  define vtohs(x)      ((x)&0xFFFF)
3683 #  define htovl(x)      vtohl(x)
3684 #  define htovs(x)      vtohs(x)
3685 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
3686 #  define vtohl(x)      ((((x)&0xFF)<<24)       \
3687                         +(((x)>>24)&0xFF)       \
3688                         +(((x)&0x0000FF00)<<8)  \
3689                         +(((x)&0x00FF0000)>>8)  )
3690 #  define vtohs(x)      ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
3691 #  define htovl(x)      vtohl(x)
3692 #  define htovs(x)      vtohs(x)
3693 #else
3694 #  error "Unsupported byteorder"
3695 /* If you have need for current perl on PDP-11 or similar, and can help test
3696    that blead keeps working on a mixed-endian system, then see
3697    pod/perlhack.pod for how to submit patches to things working again.  */
3698 #endif
3699
3700 /* *MAX Plus 1. A floating point value.
3701    Hopefully expressed in a way that dodgy floating point can't mess up.
3702    >> 2 rather than 1, so that value is safely less than I32_MAX after 1
3703    is added to it
3704    May find that some broken compiler will want the value cast to I32.
3705    [after the shift, as signed >> may not be as secure as unsigned >>]
3706 */
3707 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
3708 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
3709 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
3710    0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
3711    may be greater than sizeof(IV), so don't assume that half max UV is max IV.
3712 */
3713 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
3714
3715 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
3716 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
3717 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
3718
3719 /* This may look like unnecessary jumping through hoops, but converting
3720    out of range floating point values to integers *is* undefined behaviour,
3721    and it is starting to bite.
3722 */
3723 #ifndef CAST_INLINE
3724 #define I_32(what) (cast_i32((NV)(what)))
3725 #define U_32(what) (cast_ulong((NV)(what)))
3726 #define I_V(what) (cast_iv((NV)(what)))
3727 #define U_V(what) (cast_uv((NV)(what)))
3728 #else
3729 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
3730                   : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
3731                      : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
3732 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
3733                   : ((n) < U32_MAX_P1 ? (U32) (n) \
3734                      : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
3735 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
3736                   : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
3737                      : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
3738 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
3739                   : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
3740                      : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
3741 #endif
3742
3743 #define U_S(what) ((U16)U_32(what))
3744 #define U_I(what) ((unsigned int)U_32(what))
3745 #define U_L(what) U_32(what)
3746
3747 #ifdef HAS_SIGNBIT
3748 #  define Perl_signbit signbit
3749 #endif
3750
3751 /* These do not care about the fractional part, only about the range. */
3752 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
3753 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
3754
3755 /* Used with UV/IV arguments: */
3756                                         /* XXXX: need to speed it up */
3757 #define CLUMP_2UV(iv)   ((iv) < 0 ? 0 : (UV)(iv))
3758 #define CLUMP_2IV(uv)   ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
3759
3760 #ifndef MAXSYSFD
3761 #   define MAXSYSFD 2
3762 #endif
3763
3764 #ifndef __cplusplus
3765 #if !(defined(WIN32) || defined(UNDER_CE) || defined(SYMBIAN))
3766 Uid_t getuid (void);
3767 Uid_t geteuid (void);
3768 Gid_t getgid (void);
3769 Gid_t getegid (void);
3770 #endif
3771 #endif
3772
3773 #ifndef Perl_debug_log
3774 #  define Perl_debug_log        PerlIO_stderr()
3775 #endif
3776
3777 #ifndef Perl_error_log
3778 #  define Perl_error_log        (PL_stderrgv                    \
3779                                  && isGV(PL_stderrgv)           \
3780                                  && GvIOp(PL_stderrgv)          \
3781                                  && IoOFP(GvIOp(PL_stderrgv))   \
3782                                  ? IoOFP(GvIOp(PL_stderrgv))    \
3783                                  : PerlIO_stderr())
3784 #endif
3785
3786
3787 #define DEBUG_p_FLAG            0x00000001 /*      1 */
3788 #define DEBUG_s_FLAG            0x00000002 /*      2 */
3789 #define DEBUG_l_FLAG            0x00000004 /*      4 */
3790 #define DEBUG_t_FLAG            0x00000008 /*      8 */
3791 #define DEBUG_o_FLAG            0x00000010 /*     16 */
3792 #define DEBUG_c_FLAG            0x00000020 /*     32 */
3793 #define DEBUG_P_FLAG            0x00000040 /*     64 */
3794 #define DEBUG_m_FLAG            0x00000080 /*    128 */
3795 #define DEBUG_f_FLAG            0x00000100 /*    256 */
3796 #define DEBUG_r_FLAG            0x00000200 /*    512 */
3797 #define DEBUG_x_FLAG            0x00000400 /*   1024 */
3798 #define DEBUG_u_FLAG            0x00000800 /*   2048 */
3799 /* U is reserved for Unofficial, exploratory hacking */
3800 #define DEBUG_U_FLAG            0x00001000 /*   4096 */
3801 #define DEBUG_H_FLAG            0x00002000 /*   8192 */
3802 #define DEBUG_X_FLAG            0x00004000 /*  16384 */
3803 #define DEBUG_D_FLAG            0x00008000 /*  32768 */
3804 #define DEBUG_S_FLAG            0x00010000 /*  65536 */
3805 #define DEBUG_T_FLAG            0x00020000 /* 131072 */
3806 #define DEBUG_R_FLAG            0x00040000 /* 262144 */
3807 #define DEBUG_J_FLAG            0x00080000 /* 524288 */
3808 #define DEBUG_v_FLAG            0x00100000 /*1048576 */
3809 #define DEBUG_C_FLAG            0x00200000 /*2097152 */
3810 #define DEBUG_A_FLAG            0x00400000 /*4194304 */
3811 #define DEBUG_q_FLAG            0x00800000 /*8388608 */
3812 #define DEBUG_M_FLAG            0x01000000 /*16777216*/
3813 #define DEBUG_B_FLAG            0x02000000 /*33554432*/
3814 #define DEBUG_L_FLAG            0x04000000 /*67108864*/
3815 #define DEBUG_MASK              0x07FFEFFF /* mask of all the standard flags */
3816
3817 #define DEBUG_DB_RECURSE_FLAG   0x40000000
3818 #define DEBUG_TOP_FLAG          0x80000000 /* XXX what's this for ??? Signal
3819                                               that something was done? */
3820
3821 #  define DEBUG_p_TEST_ (PL_debug & DEBUG_p_FLAG)
3822 #  define DEBUG_s_TEST_ (PL_debug & DEBUG_s_FLAG)
3823 #  define DEBUG_l_TEST_ (PL_debug & DEBUG_l_FLAG)
3824 #  define DEBUG_t_TEST_ (PL_debug & DEBUG_t_FLAG)
3825 #  define DEBUG_o_TEST_ (PL_debug & DEBUG_o_FLAG)
3826 #  define DEBUG_c_TEST_ (PL_debug & DEBUG_c_FLAG)
3827 #  define DEBUG_P_TEST_ (PL_debug & DEBUG_P_FLAG)
3828 #  define DEBUG_m_TEST_ (PL_debug & DEBUG_m_FLAG)
3829 #  define DEBUG_f_TEST_ (PL_debug & DEBUG_f_FLAG)
3830 #  define DEBUG_r_TEST_ (PL_debug & DEBUG_r_FLAG)
3831 #  define DEBUG_x_TEST_ (PL_debug & DEBUG_x_FLAG)
3832 #  define DEBUG_u_TEST_ (PL_debug & DEBUG_u_FLAG)
3833 #  define DEBUG_U_TEST_ (PL_debug & DEBUG_U_FLAG)
3834 #  define DEBUG_H_TEST_ (PL_debug & DEBUG_H_FLAG)
3835 #  define DEBUG_X_TEST_ (PL_debug & DEBUG_X_FLAG)
3836 #  define DEBUG_D_TEST_ (PL_debug & DEBUG_D_FLAG)
3837 #  define DEBUG_S_TEST_ (PL_debug & DEBUG_S_FLAG)
3838 #  define DEBUG_T_TEST_ (PL_debug & DEBUG_T_FLAG)
3839 #  define DEBUG_R_TEST_ (PL_debug & DEBUG_R_FLAG)
3840 #  define DEBUG_J_TEST_ (PL_debug & DEBUG_J_FLAG)
3841 #  define DEBUG_v_TEST_ (PL_debug & DEBUG_v_FLAG)
3842 #  define DEBUG_C_TEST_ (PL_debug & DEBUG_C_FLAG)
3843 #  define DEBUG_A_TEST_ (PL_debug & DEBUG_A_FLAG)
3844 #  define DEBUG_q_TEST_ (PL_debug & DEBUG_q_FLAG)
3845 #  define DEBUG_M_TEST_ (PL_debug & DEBUG_M_FLAG)
3846 #  define DEBUG_B_TEST_ (PL_debug & DEBUG_B_FLAG)
3847 #  define DEBUG_L_TEST_ (PL_debug & DEBUG_L_FLAG)
3848 #  define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
3849 #  define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
3850 #  define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
3851
3852 #ifdef DEBUGGING
3853
3854 #  define DEBUG_p_TEST DEBUG_p_TEST_
3855 #  define DEBUG_s_TEST DEBUG_s_TEST_
3856 #  define DEBUG_l_TEST DEBUG_l_TEST_
3857 #  define DEBUG_t_TEST DEBUG_t_TEST_
3858 #  define DEBUG_o_TEST DEBUG_o_TEST_
3859 #  define DEBUG_c_TEST DEBUG_c_TEST_
3860 #  define DEBUG_P_TEST DEBUG_P_TEST_
3861 #  define DEBUG_m_TEST DEBUG_m_TEST_
3862 #  define DEBUG_f_TEST DEBUG_f_TEST_
3863 #  define DEBUG_r_TEST DEBUG_r_TEST_
3864 #  define DEBUG_x_TEST DEBUG_x_TEST_
3865 #  define DEBUG_u_TEST DEBUG_u_TEST_
3866 #  define DEBUG_U_TEST DEBUG_U_TEST_
3867 #  define DEBUG_H_TEST DEBUG_H_TEST_
3868 #  define DEBUG_X_TEST DEBUG_X_TEST_
3869 #  define DEBUG_D_TEST DEBUG_D_TEST_
3870 #  define DEBUG_S_TEST DEBUG_S_TEST_
3871 #  define DEBUG_T_TEST DEBUG_T_TEST_
3872 #  define DEBUG_R_TEST DEBUG_R_TEST_
3873 #  define DEBUG_J_TEST DEBUG_J_TEST_
3874 #  define DEBUG_v_TEST DEBUG_v_TEST_
3875 #  define DEBUG_C_TEST DEBUG_C_TEST_
3876 #  define DEBUG_A_TEST DEBUG_A_TEST_
3877 #  define DEBUG_q_TEST DEBUG_q_TEST_
3878 #  define DEBUG_M_TEST DEBUG_M_TEST_
3879 #  define DEBUG_B_TEST DEBUG_B_TEST_
3880 #  define DEBUG_L_TEST DEBUG_L_TEST_
3881 #  define DEBUG_Xv_TEST DEBUG_Xv_TEST_
3882 #  define DEBUG_Uv_TEST DEBUG_Uv_TEST_
3883 #  define DEBUG_Pv_TEST DEBUG_Pv_TEST_
3884
3885 #  define PERL_DEB(a)                  a
3886 #  define PERL_DEBUG(a) if (PL_debug)  a
3887 #  define DEBUG_p(a) if (DEBUG_p_TEST) a
3888 #  define DEBUG_s(a) if (DEBUG_s_TEST) a
3889 #  define DEBUG_l(a) if (DEBUG_l_TEST) a
3890 #  define DEBUG_t(a) if (DEBUG_t_TEST) a
3891 #  define DEBUG_o(a) if (DEBUG_o_TEST) a
3892 #  define DEBUG_c(a) if (DEBUG_c_TEST) a
3893 #  define DEBUG_P(a) if (DEBUG_P_TEST) a
3894
3895      /* Temporarily turn off memory debugging in case the a
3896       * does memory allocation, either directly or indirectly. */
3897 #  define DEBUG_m(a)  \
3898     STMT_START {                                                        \
3899         if (PERL_GET_INTERP) { dTHX; if (DEBUG_m_TEST) {PL_debug&=~DEBUG_m_FLAG; a; PL_debug|=DEBUG_m_FLAG;} } \
3900     } STMT_END
3901
3902 #  define DEBUG__(t, a) \
3903         STMT_START { \
3904                 if (t) STMT_START {a;} STMT_END; \
3905         } STMT_END
3906
3907 #  define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
3908 #ifndef PERL_EXT_RE_BUILD
3909 #  define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
3910 #else
3911 #  define DEBUG_r(a) STMT_START {a;} STMT_END
3912 #endif /* PERL_EXT_RE_BUILD */
3913 #  define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
3914 #  define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
3915 #  define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
3916 #  define DEBUG_H(a) DEBUG__(DEBUG_H_TEST, a)
3917 #  define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
3918 #  define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
3919 #  define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
3920 #  define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
3921 #  define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
3922
3923 #  define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
3924 #  define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
3925 #  define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
3926 #  define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
3927 #  define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
3928 #  define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
3929 #  define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
3930 #  define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
3931 #  define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
3932 #  define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
3933
3934 #else /* DEBUGGING */
3935
3936 #  define DEBUG_p_TEST (0)
3937 #  define DEBUG_s_TEST (0)
3938 #  define DEBUG_l_TEST (0)
3939 #  define DEBUG_t_TEST (0)
3940 #  define DEBUG_o_TEST (0)
3941 #  define DEBUG_c_TEST (0)
3942 #  define DEBUG_P_TEST (0)
3943 #  define DEBUG_m_TEST (0)
3944 #  define DEBUG_f_TEST (0)
3945 #  define DEBUG_r_TEST (0)
3946 #  define DEBUG_x_TEST (0)
3947 #  define DEBUG_u_TEST (0)
3948 #  define DEBUG_U_TEST (0)
3949 #  define DEBUG_H_TEST (0)
3950 #  define DEBUG_X_TEST (0)
3951 #  define DEBUG_D_TEST (0)
3952 #  define DEBUG_S_TEST (0)
3953 #  define DEBUG_T_TEST (0)
3954 #  define DEBUG_R_TEST (0)
3955 #  define DEBUG_J_TEST (0)
3956 #  define DEBUG_v_TEST (0)
3957 #  define DEBUG_C_TEST (0)
3958 #  define DEBUG_A_TEST (0)
3959 #  define DEBUG_q_TEST (0)
3960 #  define DEBUG_M_TEST (0)
3961 #  define DEBUG_B_TEST (0)
3962 #  define DEBUG_L_TEST (0)
3963 #  define DEBUG_Xv_TEST (0)
3964 #  define DEBUG_Uv_TEST (0)
3965 #  define DEBUG_Pv_TEST (0)
3966
3967 #  define PERL_DEB(a)
3968 #  define PERL_DEBUG(a)
3969 #  define DEBUG_p(a)
3970 #  define DEBUG_s(a)
3971 #  define DEBUG_l(a)
3972 #  define DEBUG_t(a)
3973 #  define DEBUG_o(a)
3974 #  define DEBUG_c(a)
3975 #  define DEBUG_P(a)
3976 #  define DEBUG_m(a)
3977 #  define DEBUG_f(a)
3978 #  define DEBUG_r(a)
3979 #  define DEBUG_x(a)
3980 #  define DEBUG_u(a)
3981 #  define DEBUG_U(a)
3982 #  define DEBUG_H(a)
3983 #  define DEBUG_X(a)
3984 #  define DEBUG_D(a)
3985 #  define DEBUG_S(a)
3986 #  define DEBUG_T(a)
3987 #  define DEBUG_R(a)
3988 #  define DEBUG_v(a)
3989 #  define DEBUG_C(a)
3990 #  define DEBUG_A(a)
3991 #  define DEBUG_q(a)
3992 #  define DEBUG_M(a)
3993 #  define DEBUG_B(a)
3994 #  define DEBUG_L(a)
3995 #  define DEBUG_Xv(a)
3996 #  define DEBUG_Uv(a)
3997 #  define DEBUG_Pv(a)
3998 #endif /* DEBUGGING */
3999
4000
4001 #define DEBUG_SCOPE(where) \
4002     DEBUG_l( \
4003     Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n",   \
4004                     where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
4005                     __FILE__, __LINE__));
4006
4007 /* Keep the old croak based assert for those who want it, and as a fallback if
4008    the platform is so heretically non-ANSI that it can't assert.  */
4009
4010 #define Perl_assert(what)       PERL_DEB(                               \
4011         ((what) ? ((void) 0) :                                          \
4012             (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
4013                         "\", line %d", STRINGIFY(what), __LINE__),      \
4014             (void) 0)))
4015
4016 /* assert() gets defined if DEBUGGING (and I_ASSERT).
4017  * If no DEBUGGING, the <assert.h> has not been included. */
4018 #ifndef assert
4019 #  define assert(what)  Perl_assert(what)
4020 #endif
4021 #ifdef DEBUGGING
4022 #  define assert_(what) assert(what),
4023 #else
4024 #  define assert_(what)
4025 #endif
4026
4027 struct ufuncs {
4028     I32 (*uf_val)(pTHX_ IV, SV*);
4029     I32 (*uf_set)(pTHX_ IV, SV*);
4030     IV uf_index;
4031 };
4032
4033 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4034  * XS code wanting to be backward compatible can do something
4035  * like the following:
4036
4037 #ifndef PERL_MG_UFUNC
4038 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4039 #endif
4040
4041 static PERL_MG_UFUNC(foo_get, index, val)
4042 {
4043     sv_setsv(val, ...);
4044     return TRUE;
4045 }
4046
4047 -- Doug MacEachern
4048
4049 */
4050
4051 #ifndef PERL_MG_UFUNC
4052 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4053 #endif
4054
4055 /* Fix these up for __STDC__ */
4056 #ifndef DONT_DECLARE_STD
4057 char *mktemp (char*);
4058 #ifndef atof
4059 double atof (const char*);
4060 #endif
4061 #endif
4062
4063 #ifndef STANDARD_C
4064 /* All of these are in stdlib.h or time.h for ANSI C */
4065 Time_t time();
4066 struct tm *gmtime(), *localtime();
4067 #if defined(OEMVS)
4068 char *(strchr)(), *(strrchr)();
4069 char *(strcpy)(), *(strcat)();
4070 #else
4071 char *strchr(), *strrchr();
4072 char *strcpy(), *strcat();
4073 #endif
4074 #endif /* ! STANDARD_C */
4075
4076
4077 #ifdef I_MATH
4078 #    include <math.h>
4079 #    ifdef __VMS
4080      /* isfinite and others are here rather than in math.h as C99 stipulates */
4081 #        include <fp.h>
4082 #    endif
4083 #else
4084 START_EXTERN_C
4085             double exp (double);
4086             double log (double);
4087             double log10 (double);
4088             double sqrt (double);
4089             double frexp (double,int*);
4090             double ldexp (double,int);
4091             double modf (double,double*);
4092             double sin (double);
4093             double cos (double);
4094             double atan2 (double,double);
4095             double pow (double,double);
4096 END_EXTERN_C
4097 #endif
4098
4099 #ifdef WIN32
4100 #  if !defined(NV_INF) && defined(HUGE_VAL)
4101 #    define NV_INF HUGE_VAL
4102 #  endif
4103 #  ifndef NV_NAN
4104 #    define NV_NAN (NV_INF-NV_INF)
4105 #  endif
4106 #endif
4107
4108 /* If you are thinking of using HUGE_VAL for infinity, or using
4109  * <math.h> functions to generate NV_INF (e.g. exp(1e9), log(-1.0)),
4110  * stop.  Neither will work portably: HUGE_VAL can be just DBL_MAX,
4111  * and the math functions might be just generating DBL_MAX, or even
4112  * zero.  */
4113
4114 #if !defined(NV_INF) && defined(USE_LONG_DOUBLE) && defined(LDBL_INFINITY)
4115 #  define NV_INF LDBL_INFINITY
4116 #endif
4117 #if !defined(NV_INF) && defined(DBL_INFINITY)
4118 #  define NV_INF (NV)DBL_INFINITY
4119 #endif
4120 #if !defined(NV_INF) && defined(INFINITY)
4121 #  define NV_INF (NV)INFINITY
4122 #endif
4123 #if !defined(NV_INF) && defined(INF)
4124 #  define NV_INF (NV)INF
4125 #endif
4126 #if !defined(NV_INF)
4127 #  define NV_INF ((NV)1.0/0.0) /* Some compilers will warn. */
4128 #endif
4129
4130 #if !defined(NV_NAN) && defined(USE_LONG_DOUBLE)
4131 #   if !defined(NV_NAN) && defined(LDBL_NAN)
4132 #       define NV_NAN LDBL_NAN
4133 #   endif
4134 #   if !defined(NV_NAN) && defined(LDBL_QNAN)
4135 #       define NV_NAN LDBL_QNAN
4136 #   endif
4137 #   if !defined(NV_NAN) && defined(LDBL_SNAN)
4138 #       define NV_NAN LDBL_SNAN
4139 #   endif
4140 #endif
4141 #if !defined(NV_NAN) && defined(DBL_NAN)
4142 #  define NV_NAN (NV)DBL_NAN
4143 #endif
4144 #if !defined(NV_NAN) && defined(DBL_QNAN)
4145 #  define NV_NAN (NV)DBL_QNAN
4146 #endif
4147 #if !defined(NV_NAN) && defined(DBL_SNAN)
4148 #  define NV_NAN (NV)DBL_SNAN
4149 #endif
4150 #if !defined(NV_NAN) && defined(QNAN)
4151 #  define NV_NAN (NV)QNAN
4152 #endif
4153 #if !defined(NV_NAN) && defined(NAN)
4154 #  define NV_NAN (NV)NAN
4155 #endif
4156 #if !defined(NV_NAN) && defined(SNAN)
4157 #  define NV_NAN (NV)SNAN
4158 #endif
4159 #if !defined(NV_NAN) && defined(NV_INF)
4160 #  define NV_NAN ((NV)0.0/0.0) /* Some compilers will warn. */
4161 #endif
4162
4163 #ifndef __cplusplus
4164 #  if !defined(WIN32) && !defined(VMS)
4165 #ifndef crypt
4166 char *crypt (const char*, const char*);
4167 #endif
4168 #  endif /* !WIN32 */
4169 #  ifndef DONT_DECLARE_STD
4170 #    ifndef getenv
4171 char *getenv (const char*);
4172 #    endif /* !getenv */
4173 #    if !defined(HAS_LSEEK_PROTO) && !defined(__hpux)
4174 #      ifdef _FILE_OFFSET_BITS
4175 #        if _FILE_OFFSET_BITS == 64
4176 Off_t lseek (int,Off_t,int);
4177 #        endif
4178 #      endif
4179 #    endif
4180 #  endif /* !DONT_DECLARE_STD */
4181 #  ifndef WIN32
4182 #    ifndef getlogin
4183 char *getlogin (void);
4184 #    endif
4185 #  endif /* !WIN32 */
4186 #endif /* !__cplusplus */
4187
4188 /* Fixme on VMS.  This needs to be a run-time, not build time options */
4189 /* Also rename() is affected by this */
4190 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4191 #define UNLINK unlnk
4192 I32 unlnk (pTHX_ const char*);
4193 #else
4194 #define UNLINK PerlLIO_unlink
4195 #endif
4196
4197 /* some versions of glibc are missing the setresuid() proto */
4198 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4199 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4200 #endif
4201 /* some versions of glibc are missing the setresgid() proto */
4202 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4203 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4204 #endif
4205
4206 #ifndef HAS_SETREUID
4207 #  ifdef HAS_SETRESUID
4208 #    define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4209 #    define HAS_SETREUID
4210 #  endif
4211 #endif
4212 #ifndef HAS_SETREGID
4213 #  ifdef HAS_SETRESGID
4214 #    define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4215 #    define HAS_SETREGID
4216 #  endif
4217 #endif
4218
4219 /* Sighandler_t defined in iperlsys.h */
4220
4221 #ifdef HAS_SIGACTION
4222 typedef struct sigaction Sigsave_t;
4223 #else
4224 typedef Sighandler_t Sigsave_t;
4225 #endif
4226
4227 #define SCAN_DEF 0
4228 #define SCAN_TR 1
4229 #define SCAN_REPL 2
4230
4231 #ifdef DEBUGGING
4232 # ifndef register
4233 #  define register
4234 # endif
4235 # define RUNOPS_DEFAULT Perl_runops_debug
4236 #else
4237 # define RUNOPS_DEFAULT Perl_runops_standard
4238 #endif
4239
4240 #if defined(USE_PERLIO)
4241 EXTERN_C void PerlIO_teardown(void);
4242 # ifdef USE_ITHREADS
4243 #  define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4244 #  define PERLIO_TERM                           \
4245         STMT_START {                            \
4246                 PerlIO_teardown();              \
4247                 MUTEX_DESTROY(&PL_perlio_mutex);\
4248         } STMT_END
4249 # else
4250 #  define PERLIO_INIT
4251 #  define PERLIO_TERM   PerlIO_teardown()
4252 # endif
4253 #else
4254 #  define PERLIO_INIT
4255 #  define PERLIO_TERM
4256 #endif
4257
4258 #ifdef MYMALLOC
4259 #  ifdef MUTEX_INIT_CALLS_MALLOC
4260 #    define MALLOC_INIT                                 \
4261         STMT_START {                                    \
4262                 PL_malloc_mutex = NULL;                 \
4263                 MUTEX_INIT(&PL_malloc_mutex);           \
4264         } STMT_END
4265 #    define MALLOC_TERM                                 \
4266         STMT_START {                                    \
4267                 perl_mutex tmp = PL_malloc_mutex;       \
4268                 PL_malloc_mutex = NULL;                 \
4269                 MUTEX_DESTROY(&tmp);                    \
4270         } STMT_END
4271 #  else
4272 #    define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4273 #    define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4274 #  endif
4275 #else
4276 #  define MALLOC_INIT
4277 #  define MALLOC_TERM
4278 #endif
4279
4280 #if defined(PERL_IMPLICIT_CONTEXT)
4281
4282 struct perl_memory_debug_header;
4283 struct perl_memory_debug_header {
4284   tTHX  interpreter;
4285 #  if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4286   MEM_SIZE size;
4287 #  endif
4288   struct perl_memory_debug_header *prev;
4289   struct perl_memory_debug_header *next;
4290 #  ifdef PERL_DEBUG_READONLY_COW
4291   bool readonly;
4292 #  endif
4293 };
4294
4295 #elif defined(PERL_DEBUG_READONLY_COW)
4296
4297 struct perl_memory_debug_header;
4298 struct perl_memory_debug_header {
4299   MEM_SIZE size;
4300 };
4301
4302 #endif
4303
4304 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4305
4306 #  define PERL_MEMORY_DEBUG_HEADER_SIZE \
4307         (sizeof(struct perl_memory_debug_header) + \
4308         (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4309          %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4310
4311 #else
4312 #  define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4313 #endif
4314
4315 #ifdef PERL_TRACK_MEMPOOL
4316 # ifdef PERL_DEBUG_READONLY_COW
4317 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4318         STMT_START {                                            \
4319                 (header).interpreter = (interp);                \
4320                 (header).prev = (header).next = &(header);      \
4321                 (header).readonly = 0;                          \
4322         } STMT_END
4323 # else
4324 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4325         STMT_START {                                            \
4326                 (header).interpreter = (interp);                \
4327                 (header).prev = (header).next = &(header);      \
4328         } STMT_END
4329 # endif
4330 # else
4331 #  define INIT_TRACK_MEMPOOL(header, interp)
4332 #endif
4333
4334 #ifdef I_MALLOCMALLOC
4335 /* Needed for malloc_size(), malloc_good_size() on some systems */
4336 #  include <malloc/malloc.h>
4337 #endif
4338
4339 #ifdef MYMALLOC
4340 #  define Perl_safesysmalloc_size(where)        Perl_malloced_size(where)
4341 #else
4342 #  if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4343 #    ifdef PERL_TRACK_MEMPOOL
4344 #       define Perl_safesysmalloc_size(where)                   \
4345             (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4346 #    else
4347 #       define Perl_safesysmalloc_size(where) malloc_size(where)
4348 #    endif
4349 #  endif
4350 #  ifdef HAS_MALLOC_GOOD_SIZE
4351 #    ifdef PERL_TRACK_MEMPOOL
4352 #       define Perl_malloc_good_size(how_much)                  \
4353             (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4354 #    else
4355 #       define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4356 #    endif
4357 #  else
4358 /* Having this as the identity operation makes some code simpler.  */
4359 #       define Perl_malloc_good_size(how_much)  (how_much)
4360 #  endif
4361 #endif
4362
4363 typedef int (*runops_proc_t)(pTHX);
4364 typedef void (*share_proc_t) (pTHX_ SV *sv);
4365 typedef int  (*thrhook_proc_t) (pTHX);
4366 typedef OP* (*PPADDR_t[]) (pTHX);
4367 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4368 typedef void (*despatch_signals_proc_t) (pTHX);
4369
4370 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4371 #  include <crt_externs.h>      /* for the env array */
4372 #  define environ (*_NSGetEnviron())
4373 #else
4374    /* VMS and some other platforms don't use the environ array */
4375 #  ifdef USE_ENVIRON_ARRAY
4376 #    if !defined(DONT_DECLARE_STD) || \
4377         (defined(__svr4__) && defined(__GNUC__) && defined(__sun)) || \
4378         defined(__sgi)
4379 extern char **  environ;        /* environment variables supplied via exec */
4380 #    endif
4381 #  endif
4382 #endif
4383
4384 #define PERL_PATCHLEVEL_H_IMPLICIT
4385 #include "patchlevel.h"
4386 #undef PERL_PATCHLEVEL_H_IMPLICIT
4387
4388 #define PERL_VERSION_STRING     STRINGIFY(PERL_REVISION) "." \
4389                                 STRINGIFY(PERL_VERSION) "." \
4390                                 STRINGIFY(PERL_SUBVERSION)
4391
4392 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4393                                 STRINGIFY(PERL_API_VERSION) "." \
4394                                 STRINGIFY(PERL_API_SUBVERSION)
4395
4396 START_EXTERN_C
4397
4398 /* handy constants */
4399 EXTCONST char PL_warn_uninit[]
4400   INIT("Use of uninitialized value%s%s%s");
4401 EXTCONST char PL_warn_uninit_sv[]
4402   INIT("Use of uninitialized value%" SVf "%s%s");
4403 EXTCONST char PL_warn_nosemi[]
4404   INIT("Semicolon seems to be missing");
4405 EXTCONST char PL_warn_reserved[]
4406   INIT("Unquoted string \"%s\" may clash with future reserved word");
4407 EXTCONST char PL_warn_nl[]
4408   INIT("Unsuccessful %s on filename containing newline");
4409 EXTCONST char PL_no_wrongref[]
4410   INIT("Can't use %s ref as %s ref");
4411 /* The core no longer needs these here. If you require the string constant,
4412    please inline a copy into your own code.  */
4413 EXTCONST char PL_no_symref[] __attribute__deprecated__
4414   INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4415 EXTCONST char PL_no_symref_sv[] __attribute__deprecated__
4416   INIT("Can't use string (\"%" SVf32 "\") as %s ref while \"strict refs\" in use");
4417 EXTCONST char PL_no_usym[]
4418   INIT("Can't use an undefined value as %s reference");
4419 EXTCONST char PL_no_aelem[]
4420   INIT("Modification of non-creatable array value attempted, subscript %d");
4421 EXTCONST char PL_no_helem_sv[]
4422   INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4423 EXTCONST char PL_no_modify[]
4424   INIT("Modification of a read-only value attempted");
4425 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4426   INIT("Out of memory!\n");
4427 EXTCONST char PL_no_security[]
4428   INIT("Insecure dependency in %s%s");
4429 EXTCONST char PL_no_sock_func[]
4430   INIT("Unsupported socket function \"%s\" called");
4431 EXTCONST char PL_no_dir_func[]
4432   INIT("Unsupported directory function \"%s\" called");
4433 EXTCONST char PL_no_func[]
4434   INIT("The %s function is unimplemented");
4435 EXTCONST char PL_no_myglob[]
4436   INIT("\"%s\" variable %s can't be in a package");
4437 EXTCONST char PL_no_localize_ref[]
4438   INIT("Can't localize through a reference");
4439 EXTCONST char PL_memory_wrap[]
4440   INIT("panic: memory wrap");
4441
4442 EXTCONST char PL_Yes[]
4443   INIT("1");
4444 EXTCONST char PL_No[]
4445   INIT("");
4446 EXTCONST char PL_hexdigit[]
4447   INIT("0123456789abcdef0123456789ABCDEF");
4448
4449 /* This is constant on most architectures, a global on OS/2 */
4450 #ifndef OS2
4451 EXTCONST char PL_sh_path[]
4452   INIT(SH_PATH); /* full path of shell */
4453 #endif
4454
4455 #ifdef CSH
4456 EXTCONST char PL_cshname[]
4457   INIT(CSH);
4458 #  define PL_cshlen     (sizeof(CSH "") - 1)
4459 #endif
4460
4461 /* These are baked at compile time into any shared perl library.
4462    In future releases this will allow us in main() to sanity test the
4463    library we're linking against.  */
4464
4465 EXTCONST U8 PL_revision
4466   INIT(PERL_REVISION);
4467 EXTCONST U8 PL_version
4468   INIT(PERL_VERSION);
4469 EXTCONST U8 PL_subversion
4470   INIT(PERL_SUBVERSION);
4471
4472 EXTCONST char PL_uuemap[65]
4473   INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4474
4475 #ifdef DOINIT
4476 EXTCONST char PL_uudmap[256] =
4477 #  ifdef PERL_MICRO
4478 #    include "uuudmap.h"
4479 #  else
4480 #    include "uudmap.h"
4481 #  endif
4482 ;
4483 EXTCONST char PL_bitcount[256] =
4484 #  ifdef PERL_MICRO
4485 #    include "ubitcount.h"
4486 #else
4487 #    include "bitcount.h"
4488 #  endif
4489 ;
4490 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4491 EXTCONST int         PL_sig_num[]  = { SIG_NUM };
4492 #else
4493 EXTCONST char PL_uudmap[256];
4494 EXTCONST char PL_bitcount[256];
4495 EXTCONST char* const PL_sig_name[];
4496 EXTCONST int         PL_sig_num[];
4497 #endif
4498
4499 /* fast conversion and case folding tables.  The folding tables complement the
4500  * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4501  * folds such as outside the range or to multiple characters. */
4502
4503 #ifdef DOINIT
4504 #ifndef EBCDIC
4505
4506 /* The EBCDIC fold table depends on the code page, and hence is found in
4507  * utfebcdic.h */
4508
4509 EXTCONST  unsigned char PL_fold[] = {
4510         0,      1,      2,      3,      4,      5,      6,      7,
4511         8,      9,      10,     11,     12,     13,     14,     15,
4512         16,     17,     18,     19,     20,     21,     22,     23,
4513         24,     25,     26,     27,     28,     29,     30,     31,
4514         32,     33,     34,     35,     36,     37,     38,     39,
4515         40,     41,     42,     43,     44,     45,     46,     47,
4516         48,     49,     50,     51,     52,     53,     54,     55,
4517         56,     57,     58,     59,     60,     61,     62,     63,
4518         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4519         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4520         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4521         'x',    'y',    'z',    91,     92,     93,     94,     95,
4522         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4523         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4524         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4525         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4526         128,    129,    130,    131,    132,    133,    134,    135,
4527         136,    137,    138,    139,    140,    141,    142,    143,
4528         144,    145,    146,    147,    148,    149,    150,    151,
4529         152,    153,    154,    155,    156,    157,    158,    159,
4530         160,    161,    162,    163,    164,    165,    166,    167,
4531         168,    169,    170,    171,    172,    173,    174,    175,
4532         176,    177,    178,    179,    180,    181,    182,    183,
4533         184,    185,    186,    187,    188,    189,    190,    191,
4534         192,    193,    194,    195,    196,    197,    198,    199,
4535         200,    201,    202,    203,    204,    205,    206,    207,
4536         208,    209,    210,    211,    212,    213,    214,    215,
4537         216,    217,    218,    219,    220,    221,    222,    223,    
4538         224,    225,    226,    227,    228,    229,    230,    231,
4539         232,    233,    234,    235,    236,    237,    238,    239,
4540         240,    241,    242,    243,    244,    245,    246,    247,
4541         248,    249,    250,    251,    252,    253,    254,    255
4542 };
4543 EXTCONST  unsigned char PL_fold_latin1[] = {
4544     /* Full latin1 complement folding, except for three problematic code points:
4545      *  Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4546      *  fold complements outside the Latin1 range, so can't match something
4547      *  that isn't in utf8.
4548      *  German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4549      *  not one, so can't be represented in this table.
4550      *
4551      * All have to be specially handled */
4552         0,      1,      2,      3,      4,      5,      6,      7,
4553         8,      9,      10,     11,     12,     13,     14,     15,
4554         16,     17,     18,     19,     20,     21,     22,     23,
4555         24,     25,     26,     27,     28,     29,     30,     31,
4556         32,     33,     34,     35,     36,     37,     38,     39,
4557         40,     41,     42,     43,     44,     45,     46,     47,
4558         48,     49,     50,     51,     52,     53,     54,     55,
4559         56,     57,     58,     59,     60,     61,     62,     63,
4560         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4561         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4562         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4563         'x',    'y',    'z',    91,     92,     93,     94,     95,
4564         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4565         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4566         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4567         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4568         128,    129,    130,    131,    132,    133,    134,    135,
4569         136,    137,    138,    139,    140,    141,    142,    143,
4570         144,    145,    146,    147,    148,    149,    150,    151,
4571         152,    153,    154,    155,    156,    157,    158,    159,
4572         160,    161,    162,    163,    164,    165,    166,    167,
4573         168,    169,    170,    171,    172,    173,    174,    175,
4574         176,    177,    178,    179,    180,    181 /*micro */, 182,    183,
4575         184,    185,    186,    187,    188,    189,    190,    191,
4576         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4577         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4578         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4579         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
4580         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4581         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4582         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4583         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
4584         255 /* y with diaeresis */
4585 };
4586
4587 /* If these tables are accessed through ebcdic, the access will be converted to
4588  * latin1 first */
4589 EXTCONST  unsigned char PL_latin1_lc[] = {  /* lowercasing */
4590         0,      1,      2,      3,      4,      5,      6,      7,
4591         8,      9,      10,     11,     12,     13,     14,     15,
4592         16,     17,     18,     19,     20,     21,     22,     23,
4593         24,     25,     26,     27,     28,     29,     30,     31,
4594         32,     33,     34,     35,     36,     37,     38,     39,
4595         40,     41,     42,     43,     44,     45,     46,     47,
4596         48,     49,     50,     51,     52,     53,     54,     55,
4597         56,     57,     58,     59,     60,     61,     62,     63,
4598         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4599         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4600         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4601         'x',    'y',    'z',    91,     92,     93,     94,     95,
4602         96,     97,     98,     99,     100,    101,    102,    103,
4603         104,    105,    106,    107,    108,    109,    110,    111,
4604         112,    113,    114,    115,    116,    117,    118,    119,
4605         120,    121,    122,    123,    124,    125,    126,    127,
4606         128,    129,    130,    131,    132,    133,    134,    135,
4607         136,    137,    138,    139,    140,    141,    142,    143,
4608         144,    145,    146,    147,    148,    149,    150,    151,
4609         152,    153,    154,    155,    156,    157,    158,    159,
4610         160,    161,    162,    163,    164,    165,    166,    167,
4611         168,    169,    170,    171,    172,    173,    174,    175,
4612         176,    177,    178,    179,    180,    181,    182,    183,
4613         184,    185,    186,    187,    188,    189,    190,    191,
4614         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4615         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4616         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4617         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223,    
4618         224,    225,    226,    227,    228,    229,    230,    231,
4619         232,    233,    234,    235,    236,    237,    238,    239,
4620         240,    241,    242,    243,    244,    245,    246,    247,
4621         248,    249,    250,    251,    252,    253,    254,    255
4622 };
4623
4624 /* upper and title case of latin1 characters, modified so that the three tricky
4625  * ones are mapped to 255 (which is one of the three) */
4626 EXTCONST  unsigned char PL_mod_latin1_uc[] = {
4627         0,      1,      2,      3,      4,      5,      6,      7,
4628         8,      9,      10,     11,     12,     13,     14,     15,
4629         16,     17,     18,     19,     20,     21,     22,     23,
4630         24,     25,     26,     27,     28,     29,     30,     31,
4631         32,     33,     34,     35,     36,     37,     38,     39,
4632         40,     41,     42,     43,     44,     45,     46,     47,
4633         48,     49,     50,     51,     52,     53,     54,     55,
4634         56,     57,     58,     59,     60,     61,     62,     63,
4635         64,     65,     66,     67,     68,     69,     70,     71,
4636         72,     73,     74,     75,     76,     77,     78,     79,
4637         80,     81,     82,     83,     84,     85,     86,     87,
4638         88,     89,     90,     91,     92,     93,     94,     95,
4639         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4640         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4641         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4642         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4643         128,    129,    130,    131,    132,    133,    134,    135,
4644         136,    137,    138,    139,    140,    141,    142,    143,
4645         144,    145,    146,    147,    148,    149,    150,    151,
4646         152,    153,    154,    155,    156,    157,    158,    159,
4647         160,    161,    162,    163,    164,    165,    166,    167,
4648         168,    169,    170,    171,    172,    173,    174,    175,
4649         176,    177,    178,    179,    180,    255 /*micro*/,  182,    183,
4650         184,    185,    186,    187,    188,    189,    190,    191,
4651         192,    193,    194,    195,    196,    197,    198,    199,
4652         200,    201,    202,    203,    204,    205,    206,    207,
4653         208,    209,    210,    211,    212,    213,    214,    215,
4654         216,    217,    218,    219,    220,    221,    222,    255 /*sharp s*/,        
4655         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4656         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4657         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4658         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32, 255
4659 };
4660 #endif  /* !EBCDIC, but still in DOINIT */
4661 #else   /* ! DOINIT */
4662 #   ifndef EBCDIC
4663 EXTCONST unsigned char PL_fold[];
4664 EXTCONST unsigned char PL_fold_latin1[];
4665 EXTCONST unsigned char PL_mod_latin1_uc[];
4666 EXTCONST unsigned char PL_latin1_lc[];
4667 #   endif
4668 #endif
4669
4670 #ifndef PERL_GLOBAL_STRUCT /* or perlvars.h */
4671 #ifdef DOINIT
4672 EXT unsigned char PL_fold_locale[] = { /* Unfortunately not EXTCONST. */
4673         0,      1,      2,      3,      4,      5,      6,      7,
4674         8,      9,      10,     11,     12,     13,     14,     15,
4675         16,     17,     18,     19,     20,     21,     22,     23,
4676         24,     25,     26,     27,     28,     29,     30,     31,
4677         32,     33,     34,     35,     36,     37,     38,     39,
4678         40,     41,     42,     43,     44,     45,     46,     47,
4679         48,     49,     50,     51,     52,     53,     54,     55,
4680         56,     57,     58,     59,     60,     61,     62,     63,
4681         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4682         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4683         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4684         'x',    'y',    'z',    91,     92,     93,     94,     95,
4685         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4686         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4687         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4688         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4689         128,    129,    130,    131,    132,    133,    134,    135,
4690         136,    137,    138,    139,    140,    141,    142,    143,
4691         144,    145,    146,    147,    148,    149,    150,    151,
4692         152,    153,    154,    155,    156,    157,    158,    159,
4693         160,    161,    162,    163,    164,    165,    166,    167,
4694         168,    169,    170,    171,    172,    173,    174,    175,
4695         176,    177,    178,    179,    180,    181,    182,    183,
4696         184,    185,    186,    187,    188,    189,    190,    191,
4697         192,    193,    194,    195,    196,    197,    198,    199,
4698         200,    201,    202,    203,    204,    205,    206,    207,
4699         208,    209,    210,    211,    212,    213,    214,    215,
4700         216,    217,    218,    219,    220,    221,    222,    223,    
4701         224,    225,    226,    227,    228,    229,    230,    231,
4702         232,    233,    234,    235,    236,    237,    238,    239,
4703         240,    241,    242,    243,    244,    245,    246,    247,
4704         248,    249,    250,    251,    252,    253,    254,    255
4705 };
4706 #else
4707 EXT unsigned char PL_fold_locale[]; /* Unfortunately not EXTCONST. */
4708 #endif
4709 #endif /* !PERL_GLOBAL_STRUCT */
4710
4711 #ifdef DOINIT
4712 #ifdef EBCDIC
4713 EXTCONST unsigned char PL_freq[] = {/* EBCDIC frequencies for mixed English/C */
4714     1,      2,      84,     151,    154,    155,    156,    157,
4715     165,    246,    250,    3,      158,    7,      18,     29,
4716     40,     51,     62,     73,     85,     96,     107,    118,
4717     129,    140,    147,    148,    149,    150,    152,    153,
4718     255,      6,      8,      9,     10,     11,     12,     13,
4719      14,     15,     24,     25,     26,     27,     28,    226,
4720      29,     30,     31,     32,     33,     43,     44,     45,
4721      46,     47,     48,     49,     50,     76,     77,     78,
4722      79,     80,     81,     82,     83,     84,     85,     86,
4723      87,     94,     95,    234,    181,    233,    187,    190,
4724     180,     96,     97,     98,     99,    100,    101,    102,
4725     104,    112,    182,    174,    236,    232,    229,    103,
4726     228,    226,    114,    115,    116,    117,    118,    119,
4727     120,    121,    122,    235,    176,    230,    194,    162,
4728     130,    131,    132,    133,    134,    135,    136,    137,
4729     138,    139,    201,    205,    163,    217,    220,    224,
4730     5,      248,    227,    244,    242,    255,    241,    231,
4731     240,    253,    16,     197,    19,     20,     21,     187,
4732     23,     169,    210,    245,    237,    249,    247,    239,
4733     168,    252,    34,     196,    36,     37,     38,     39,
4734     41,     42,     251,    254,    238,    223,    221,    213,
4735     225,    177,    52,     53,     54,     55,     56,     57,
4736     58,     59,     60,     61,     63,     64,     65,     66,
4737     67,     68,     69,     70,     71,     72,     74,     75,
4738     205,    208,    186,    202,    200,    218,    198,    179,
4739     178,    214,    88,     89,     90,     91,     92,     93,
4740     217,    166,    170,    207,    199,    209,    206,    204,
4741     160,    212,    105,    106,    108,    109,    110,    111,
4742     203,    113,    216,    215,    192,    175,    193,    243,
4743     172,    161,    123,    124,    125,    126,    127,    128,
4744     222,    219,    211,    195,    188,    193,    185,    184,
4745     191,    183,    141,    142,    143,    144,    145,    146
4746 };
4747 #else  /* ascii rather than ebcdic */
4748 EXTCONST unsigned char PL_freq[] = {    /* letter frequencies for mixed English/C */
4749         1,      2,      84,     151,    154,    155,    156,    157,
4750         165,    246,    250,    3,      158,    7,      18,     29,
4751         40,     51,     62,     73,     85,     96,     107,    118,
4752         129,    140,    147,    148,    149,    150,    152,    153,
4753         255,    182,    224,    205,    174,    176,    180,    217,
4754         233,    232,    236,    187,    235,    228,    234,    226,
4755         222,    219,    211,    195,    188,    193,    185,    184,
4756         191,    183,    201,    229,    181,    220,    194,    162,
4757         163,    208,    186,    202,    200,    218,    198,    179,
4758         178,    214,    166,    170,    207,    199,    209,    206,
4759         204,    160,    212,    216,    215,    192,    175,    173,
4760         243,    172,    161,    190,    203,    189,    164,    230,
4761         167,    248,    227,    244,    242,    255,    241,    231,
4762         240,    253,    169,    210,    245,    237,    249,    247,
4763         239,    168,    252,    251,    254,    238,    223,    221,
4764         213,    225,    177,    197,    171,    196,    159,    4,
4765         5,      6,      8,      9,      10,     11,     12,     13,
4766         14,     15,     16,     17,     19,     20,     21,     22,
4767         23,     24,     25,     26,     27,     28,     30,     31,
4768         32,     33,     34,     35,     36,     37,     38,     39,
4769         41,     42,     43,     44,     45,     46,     47,     48,
4770         49,     50,     52,     53,     54,     55,     56,     57,
4771         58,     59,     60,     61,     63,     64,     65,     66,
4772         67,     68,     69,     70,     71,     72,     74,     75,
4773         76,     77,     78,     79,     80,     81,     82,     83,
4774         86,     87,     88,     89,     90,     91,     92,     93,
4775         94,     95,     97,     98,     99,     100,    101,    102,
4776         103,    104,    105,    106,    108,    109,    110,    111,
4777         112,    113,    114,    115,    116,    117,    119,    120,
4778         121,    122,    123,    124,    125,    126,    127,    128,
4779         130,    131,    132,    133,    134,    135,    136,    137,
4780         138,    139,    141,    142,    143,    144,    145,    146
4781 };
4782 #endif
4783 #else
4784 EXTCONST unsigned char PL_freq[];
4785 #endif
4786
4787 /* Although only used for debugging, these constants must be available in
4788  * non-debugging builds too, since they're used in ext/re/re_exec.c,
4789  * which has DEBUGGING enabled always */
4790 #ifdef DOINIT
4791 EXTCONST char* const PL_block_type[] = {
4792         "NULL",
4793         "WHEN",
4794         "BLOCK",
4795         "GIVEN",
4796         "LOOP_FOR",
4797         "LOOP_PLAIN",
4798         "LOOP_LAZYSV",
4799         "LOOP_LAZYIV",
4800         "SUB",
4801         "FORMAT",
4802         "EVAL",
4803         "SUBST"
4804 };
4805 #else
4806 EXTCONST char* PL_block_type[];
4807 #endif
4808
4809 /* These are all the compile time options that affect binary compatibility.
4810    Other compile time options that are binary compatible are in perl.c
4811    Both are combined for the output of perl -V
4812    However, this string will be embedded in any shared perl library, which will
4813    allow us add a comparison check in perlmain.c in the near future.  */
4814 #ifdef DOINIT
4815 EXTCONST char PL_bincompat_options[] =
4816 #  ifdef DEBUG_LEAKING_SCALARS
4817                              " DEBUG_LEAKING_SCALARS"
4818 #  endif
4819 #  ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4820                              " DEBUG_LEAKING_SCALARS_FORK_DUMP"
4821 #  endif
4822 #  ifdef FCRYPT
4823                              " FCRYPT"
4824 #  endif
4825 #  ifdef HAS_TIMES
4826                              " HAS_TIMES"
4827 #  endif
4828 #  ifdef HAVE_INTERP_INTERN
4829                              " HAVE_INTERP_INTERN"
4830 #  endif
4831 #  ifdef MULTIPLICITY
4832                              " MULTIPLICITY"
4833 #  endif
4834 #  ifdef MYMALLOC
4835                              " MYMALLOC"
4836 #  endif
4837 #  ifdef PERLIO_LAYERS
4838                              " PERLIO_LAYERS"
4839 #  endif
4840 #  ifdef PERL_DEBUG_READONLY_COW
4841                              " PERL_DEBUG_READONLY_COW"
4842 #  endif
4843 #  ifdef PERL_DEBUG_READONLY_OPS
4844                              " PERL_DEBUG_READONLY_OPS"
4845 #  endif
4846 #  ifdef PERL_GLOBAL_STRUCT
4847                              " PERL_GLOBAL_STRUCT"
4848 #  endif
4849 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
4850                              " PERL_GLOBAL_STRUCT_PRIVATE"
4851 #  endif
4852 #  ifdef PERL_IMPLICIT_CONTEXT
4853                              " PERL_IMPLICIT_CONTEXT"
4854 #  endif
4855 #  ifdef PERL_IMPLICIT_SYS
4856                              " PERL_IMPLICIT_SYS"
4857 #  endif
4858 #  ifdef PERL_MICRO
4859                              " PERL_MICRO"
4860 #  endif
4861 #  ifdef PERL_NEED_APPCTX
4862                              " PERL_NEED_APPCTX"
4863 #  endif
4864 #  ifdef PERL_NEED_TIMESBASE
4865                              " PERL_NEED_TIMESBASE"
4866 #  endif
4867 #  ifdef PERL_OLD_COPY_ON_WRITE
4868                              " PERL_OLD_COPY_ON_WRITE"
4869 #  endif
4870 #  ifdef PERL_POISON
4871                              " PERL_POISON"
4872 #  endif
4873 #  ifdef PERL_SAWAMPERSAND
4874                              " PERL_SAWAMPERSAND"
4875 #  endif
4876 #  ifdef PERL_TRACK_MEMPOOL
4877                              " PERL_TRACK_MEMPOOL"
4878 #  endif
4879 #  ifdef PERL_USES_PL_PIDSTATUS
4880                              " PERL_USES_PL_PIDSTATUS"
4881 #  endif
4882 #  ifdef USE_64_BIT_ALL
4883                              " USE_64_BIT_ALL"
4884 #  endif
4885 #  ifdef USE_64_BIT_INT
4886                              " USE_64_BIT_INT"
4887 #  endif
4888 #  ifdef USE_IEEE
4889                              " USE_IEEE"
4890 #  endif
4891 #  ifdef USE_ITHREADS
4892                              " USE_ITHREADS"
4893 #  endif
4894 #  ifdef USE_LARGE_FILES
4895                              " USE_LARGE_FILES"
4896 #  endif
4897 #  ifdef USE_LOCALE_COLLATE
4898                              " USE_LOCALE_COLLATE"
4899 #  endif
4900 #  ifdef USE_LOCALE_NUMERIC
4901                              " USE_LOCALE_NUMERIC"
4902 #  endif
4903 #  ifdef USE_LOCALE_TIME
4904                              " USE_LOCALE_TIME"
4905 #  endif
4906 #  ifdef USE_LONG_DOUBLE
4907                              " USE_LONG_DOUBLE"
4908 #  endif
4909 #  ifdef USE_PERLIO
4910                              " USE_PERLIO"
4911 #  endif
4912 #  ifdef USE_REENTRANT_API
4913                              " USE_REENTRANT_API"
4914 #  endif
4915 #  ifdef USE_SOCKS
4916                              " USE_SOCKS"
4917 #  endif
4918 #  ifdef VMS_DO_SOCKETS
4919                              " VMS_DO_SOCKETS"
4920 #  endif
4921 #  ifdef VMS_SHORTEN_LONG_SYMBOLS
4922                              " VMS_SHORTEN_LONG_SYMBOLS"
4923 #  endif
4924 #  ifdef VMS_WE_ARE_CASE_SENSITIVE
4925                              " VMS_SYMBOL_CASE_AS_IS"
4926 #  endif
4927   "";
4928 #else
4929 EXTCONST char PL_bincompat_options[];
4930 #endif
4931
4932 #ifndef PERL_SET_PHASE
4933 #  define PERL_SET_PHASE(new_phase) \
4934     PHASE_CHANGE_PROBE(PL_phase_names[new_phase], PL_phase_names[PL_phase]); \
4935     PL_phase = new_phase;
4936 #endif
4937
4938 /* The interpreter phases. If these ever change, PL_phase_names right below will
4939  * need to be updated accordingly. */
4940 enum perl_phase {
4941     PERL_PHASE_CONSTRUCT        = 0,
4942     PERL_PHASE_START            = 1,
4943     PERL_PHASE_CHECK            = 2,
4944     PERL_PHASE_INIT             = 3,
4945     PERL_PHASE_RUN              = 4,
4946     PERL_PHASE_END              = 5,
4947     PERL_PHASE_DESTRUCT         = 6
4948 };
4949
4950 #ifdef DOINIT
4951 EXTCONST char *const PL_phase_names[] = {
4952     "CONSTRUCT",
4953     "START",
4954     "CHECK",
4955     "INIT",
4956     "RUN",
4957     "END",
4958     "DESTRUCT"
4959 };
4960 #else
4961 EXTCONST char *const PL_phase_names[];
4962 #endif
4963
4964 #ifndef PERL_CORE
4965 /* Do not use this macro. It only exists for extensions that rely on PL_dirty
4966  * instead of using the newer PL_phase, which provides everything PL_dirty
4967  * provided, and more. */
4968 #  define PL_dirty (PL_phase == PERL_PHASE_DESTRUCT)
4969
4970 #  define PL_amagic_generation PL_na
4971 #endif /* !PERL_CORE */
4972
4973 #define PL_hints PL_compiling.cop_hints
4974
4975 END_EXTERN_C
4976
4977 /*****************************************************************************/
4978 /* This lexer/parser stuff is currently global since yacc is hard to reenter */
4979 /*****************************************************************************/
4980 /* XXX This needs to be revisited, since BEGIN makes yacc re-enter... */
4981
4982 #ifdef __Lynx__
4983 /* LynxOS defines these in scsi.h which is included via ioctl.h */
4984 #ifdef FORMAT
4985 #undef FORMAT
4986 #endif
4987 #ifdef SPACE
4988 #undef SPACE
4989 #endif
4990 #endif
4991
4992 #define LEX_NOTPARSING          11      /* borrowed from toke.c */
4993
4994 typedef enum {
4995     XOPERATOR,
4996     XTERM,
4997     XREF,
4998     XSTATE,
4999     XBLOCK,
5000     XATTRBLOCK,
5001     XATTRTERM,
5002     XTERMBLOCK,
5003     XBLOCKTERM,
5004     XPOSTDEREF,
5005     XTERMORDORDOR /* evil hack */
5006     /* update exp_name[] in toke.c if adding to this enum */
5007 } expectation;
5008
5009 /* Hints are now stored in a dedicated U32, so the bottom 8 bits are no longer
5010    special and there is no need for HINT_PRIVATE_MASK for COPs
5011    However, bitops store HINT_INTEGER in their op_private.
5012
5013     NOTE: The typical module using these has the bit value hard-coded, so don't
5014     blindly change the values of these.
5015
5016    If we run out of bits, the 2 locale ones could be combined.  The PARTIAL one
5017    is for "use locale 'FOO'" which excludes some categories.  It requires going
5018    to %^H to find out which are in and which are out.  This could be extended
5019    for the normal case of a plain HINT_LOCALE, so that %^H would be used for
5020    any locale form. */
5021 #define HINT_INTEGER            0x00000001 /* integer pragma */
5022 #define HINT_STRICT_REFS        0x00000002 /* strict pragma */
5023 #define HINT_LOCALE             0x00000004 /* locale pragma */
5024 #define HINT_BYTES              0x00000008 /* bytes pragma */
5025 #define HINT_LOCALE_PARTIAL     0x00000010 /* locale, but a subset of categories */
5026
5027 #define HINT_EXPLICIT_STRICT_REFS       0x00000020 /* strict.pm */
5028 #define HINT_EXPLICIT_STRICT_SUBS       0x00000040 /* strict.pm */
5029 #define HINT_EXPLICIT_STRICT_VARS       0x00000080 /* strict.pm */
5030
5031 #define HINT_BLOCK_SCOPE        0x00000100
5032 #define HINT_STRICT_SUBS        0x00000200 /* strict pragma */
5033 #define HINT_STRICT_VARS        0x00000400 /* strict pragma */
5034 #define HINT_UNI_8_BIT          0x00000800 /* unicode_strings feature */
5035
5036 /* The HINT_NEW_* constants are used by the overload pragma */
5037 #define HINT_NEW_INTEGER        0x00001000
5038 #define HINT_NEW_FLOAT          0x00002000
5039 #define HINT_NEW_BINARY         0x00004000
5040 #define HINT_NEW_STRING         0x00008000
5041 #define HINT_NEW_RE             0x00010000
5042 #define HINT_LOCALIZE_HH        0x00020000 /* %^H needs to be copied */
5043 #define HINT_LEXICAL_IO_IN      0x00040000 /* ${^OPEN} is set for input */
5044 #define HINT_LEXICAL_IO_OUT     0x00080000 /* ${^OPEN} is set for output */
5045
5046 #define HINT_RE_TAINT           0x00100000 /* re pragma */
5047 #define HINT_RE_EVAL            0x00200000 /* re pragma */
5048
5049 #define HINT_FILETEST_ACCESS    0x00400000 /* filetest pragma */
5050 #define HINT_UTF8               0x00800000 /* utf8 pragma */
5051
5052 #define HINT_NO_AMAGIC          0x01000000 /* overloading pragma */
5053
5054 #define HINT_RE_FLAGS           0x02000000 /* re '/xism' pragma */
5055
5056 #define HINT_FEATURE_MASK       0x1c000000 /* 3 bits for feature bundles */
5057
5058                                 /* Note: Used for NATIVE_HINTS, currently
5059                                    defined by vms/vmsish.h:
5060                                 0x40000000
5061                                 0x80000000
5062                                  */
5063
5064 /* The following are stored in $^H{sort}, not in PL_hints */
5065 #define HINT_SORT_SORT_BITS     0x000000FF /* allow 256 different ones */
5066 #define HINT_SORT_QUICKSORT     0x00000001
5067 #define HINT_SORT_MERGESORT     0x00000002
5068 #define HINT_SORT_STABLE        0x00000100 /* sort styles (currently one) */
5069
5070 /* flags for PL_sawampersand */
5071
5072 #define SAWAMPERSAND_LEFT       1   /* saw $` */
5073 #define SAWAMPERSAND_MIDDLE     2   /* saw $& */
5074 #define SAWAMPERSAND_RIGHT      4   /* saw $' */
5075
5076 #ifndef PERL_SAWAMPERSAND
5077 # define PL_sawampersand \
5078         (SAWAMPERSAND_LEFT|SAWAMPERSAND_MIDDLE|SAWAMPERSAND_RIGHT)
5079 #endif
5080
5081 /* Various states of the input record separator SV (rs) */
5082 #define RsSNARF(sv)   (! SvOK(sv))
5083 #define RsSIMPLE(sv)  (SvOK(sv) && (! SvPOK(sv) || SvCUR(sv)))
5084 #define RsPARA(sv)    (SvPOK(sv) && ! SvCUR(sv))
5085 #define RsRECORD(sv)  (SvROK(sv) && (SvIV(SvRV(sv)) > 0))
5086
5087 /* A struct for keeping various DEBUGGING related stuff,
5088  * neatly packed.  Currently only scratch variables for
5089  * constructing debug output are included.  Needed always,
5090  * not just when DEBUGGING, though, because of the re extension. c*/
5091 struct perl_debug_pad {
5092   SV pad[3];
5093 };
5094
5095 #define PERL_DEBUG_PAD(i)       &(PL_debug_pad.pad[i])
5096 #define PERL_DEBUG_PAD_ZERO(i)  (SvPVX(PERL_DEBUG_PAD(i))[0] = 0, \
5097         (((XPV*) SvANY(PERL_DEBUG_PAD(i)))->xpv_cur = 0), \
5098         PERL_DEBUG_PAD(i))
5099
5100 /* Enable variables which are pointers to functions */
5101 typedef void (*peep_t)(pTHX_ OP* o);
5102 typedef regexp* (*regcomp_t) (pTHX_ char* exp, char* xend, PMOP* pm);
5103 typedef I32     (*regexec_t) (pTHX_ regexp* prog, char* stringarg,
5104                                       char* strend, char* strbeg, I32 minend,
5105                                       SV* screamer, void* data, U32 flags);
5106 typedef char*   (*re_intuit_start_t) (pTHX_ regexp *prog, SV *sv,
5107                                                 char *strpos, char *strend,
5108                                                 U32 flags,
5109                                                 re_scream_pos_data *d);
5110 typedef SV*     (*re_intuit_string_t) (pTHX_ regexp *prog);
5111 typedef void    (*regfree_t) (pTHX_ struct regexp* r);
5112 typedef regexp* (*regdupe_t) (pTHX_ const regexp* r, CLONE_PARAMS *param);
5113 typedef I32     (*re_fold_t)(const char *, char const *, I32);
5114
5115 typedef void (*DESTRUCTORFUNC_NOCONTEXT_t) (void*);
5116 typedef void (*DESTRUCTORFUNC_t) (pTHX_ void*);
5117 typedef void (*SVFUNC_t) (pTHX_ SV* const);
5118 typedef I32  (*SVCOMPARE_t) (pTHX_ SV* const, SV* const);
5119 typedef void (*XSINIT_t) (pTHX);
5120 typedef void (*ATEXIT_t) (pTHX_ void*);
5121 typedef void (*XSUBADDR_t) (pTHX_ CV *);
5122
5123 typedef OP* (*Perl_ppaddr_t)(pTHX);
5124 typedef OP* (*Perl_check_t) (pTHX_ OP*);
5125 typedef void(*Perl_ophook_t)(pTHX_ OP*);
5126 typedef int (*Perl_keyword_plugin_t)(pTHX_ char*, STRLEN, OP**);
5127 typedef void(*Perl_cpeep_t)(pTHX_ OP *, OP *);
5128
5129 typedef void(*globhook_t)(pTHX);
5130
5131 #define KEYWORD_PLUGIN_DECLINE 0
5132 #define KEYWORD_PLUGIN_STMT    1
5133 #define KEYWORD_PLUGIN_EXPR    2
5134
5135 /* Interpreter exitlist entry */
5136 typedef struct exitlistentry {
5137     void (*fn) (pTHX_ void*);
5138     void *ptr;
5139 } PerlExitListEntry;
5140
5141 /* if you only have signal() and it resets on each signal, FAKE_PERSISTENT_SIGNAL_HANDLERS fixes */
5142 /* These have to be before perlvars.h */
5143 #if !defined(HAS_SIGACTION) && defined(VMS)
5144 #  define  FAKE_PERSISTENT_SIGNAL_HANDLERS
5145 #endif
5146 /* if we're doing kill() with sys$sigprc on VMS, FAKE_DEFAULT_SIGNAL_HANDLERS */
5147 #if defined(KILL_BY_SIGPRC)
5148 #  define  FAKE_DEFAULT_SIGNAL_HANDLERS
5149 #endif
5150
5151 #if !defined(MULTIPLICITY)
5152
5153 struct interpreter {
5154     char broiled;
5155 };
5156
5157 #else
5158
5159 /* If we have multiple interpreters define a struct
5160    holding variables which must be per-interpreter
5161    If we don't have threads anything that would have
5162    be per-thread is per-interpreter.
5163 */
5164
5165 /* Set up PERLVAR macros for populating structs */
5166 #  define PERLVAR(prefix,var,type) type prefix##var;
5167
5168 /* 'var' is an array of length 'n' */
5169 #  define PERLVARA(prefix,var,n,type) type prefix##var[n];
5170
5171 /* initialize 'var' to init' */
5172 #  define PERLVARI(prefix,var,type,init) type prefix##var;
5173
5174 /* like PERLVARI, but make 'var' a const */
5175 #  define PERLVARIC(prefix,var,type,init) type prefix##var;
5176
5177 struct interpreter {
5178 #  include "intrpvar.h"
5179 };
5180
5181 EXTCONST U16 PL_interp_size
5182   INIT(sizeof(struct interpreter));
5183
5184 #  define PERL_INTERPRETER_SIZE_UPTO_MEMBER(member)                     \
5185     STRUCT_OFFSET(struct interpreter, member) +                         \
5186     sizeof(((struct interpreter*)0)->member)
5187
5188 /* This will be useful for subsequent releases, because this has to be the
5189    same in your libperl as in main(), else you have a mismatch and must abort.
5190 */
5191 EXTCONST U16 PL_interp_size_5_18_0
5192   INIT(PERL_INTERPRETER_SIZE_UPTO_MEMBER(PERL_LAST_5_18_0_INTERP_MEMBER));
5193
5194
5195 #  ifdef PERL_GLOBAL_STRUCT
5196 /* MULTIPLICITY is automatically defined when PERL_GLOBAL_STRUCT is defined,
5197    hence it's safe and sane to nest this within #ifdef MULTIPLICITY  */
5198
5199 struct perl_vars {
5200 #    include "perlvars.h"
5201 };
5202
5203 EXTCONST U16 PL_global_struct_size
5204   INIT(sizeof(struct perl_vars));
5205
5206 #    ifdef PERL_CORE
5207 #      ifndef PERL_GLOBAL_STRUCT_PRIVATE
5208 EXT struct perl_vars PL_Vars;
5209 EXT struct perl_vars *PL_VarsPtr INIT(&PL_Vars);
5210 #        undef PERL_GET_VARS
5211 #        define PERL_GET_VARS() PL_VarsPtr
5212 #      endif /* !PERL_GLOBAL_STRUCT_PRIVATE */
5213 #    else /* PERL_CORE */
5214 #      if !defined(__GNUC__) || !defined(WIN32)
5215 EXT
5216 #      endif /* WIN32 */
5217 struct perl_vars *PL_VarsPtr;
5218 #      define PL_Vars (*((PL_VarsPtr) \
5219                        ? PL_VarsPtr : (PL_VarsPtr = Perl_GetVars(aTHX))))
5220 #    endif /* PERL_CORE */
5221 #  endif /* PERL_GLOBAL_STRUCT */
5222
5223 /* Done with PERLVAR macros for now ... */
5224 #  undef PERLVAR
5225 #  undef PERLVARA
5226 #  undef PERLVARI
5227 #  undef PERLVARIC
5228
5229 #endif /* MULTIPLICITY */
5230
5231 struct tempsym; /* defined in pp_pack.c */
5232
5233 #include "thread.h"
5234 #include "pp.h"
5235
5236 #ifndef PERL_CALLCONV
5237 #  ifdef __cplusplus
5238 #    define PERL_CALLCONV extern "C"
5239 #  else
5240 #    define PERL_CALLCONV
5241 #  endif
5242 #endif
5243 #ifndef PERL_CALLCONV_NO_RET
5244 #    define PERL_CALLCONV_NO_RET PERL_CALLCONV
5245 #endif
5246
5247 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
5248    dont have a noreturn as a declaration specifier
5249 */
5250 #ifndef PERL_STATIC_NO_RET
5251 #  define PERL_STATIC_NO_RET STATIC
5252 #endif
5253 /* PERL_STATIC_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE on
5254    builds that dont have a noreturn as a declaration specifier
5255 */
5256 #ifndef PERL_STATIC_INLINE_NO_RET
5257 #  define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
5258 #endif
5259
5260
5261 #undef PERL_CKDEF
5262 #undef PERL_PPDEF
5263 #define PERL_CKDEF(s)   PERL_CALLCONV OP *s (pTHX_ OP *o);
5264 #define PERL_PPDEF(s)   PERL_CALLCONV OP *s (pTHX);
5265
5266 #ifdef MYMALLOC
5267 #  include "malloc_ctl.h"
5268 #endif
5269
5270 #include "proto.h"
5271
5272 /* this has structure inits, so it cannot be included before here */
5273 #include "opcode.h"
5274
5275 /* The following must follow proto.h as #defines mess up syntax */
5276
5277 #if !defined(PERL_FOR_X2P)
5278 #  include "embedvar.h"
5279 #endif
5280
5281 /* Now include all the 'global' variables
5282  * If we don't have threads or multiple interpreters
5283  * these include variables that would have been their struct-s
5284  */
5285
5286 #define PERLVAR(prefix,var,type) EXT type PL_##var;
5287 #define PERLVARA(prefix,var,n,type) EXT type PL_##var[n];
5288 #define PERLVARI(prefix,var,type,init) EXT type  PL_##var INIT(init);
5289 #define PERLVARIC(prefix,var,type,init) EXTCONST type PL_##var INIT(init);
5290
5291 #if !defined(MULTIPLICITY)
5292 START_EXTERN_C
5293 #  include "intrpvar.h"
5294 END_EXTERN_C
5295 #endif
5296
5297 #ifdef PERL_CORE
5298 /* All core uses now exterminated. Ensure no zombies can return:  */
5299 #  undef PL_na
5300 #endif
5301
5302 /* Now all the config stuff is setup we can include embed.h
5303    In particular, need the relevant *ish file included already, as it may
5304    define HAVE_INTERP_INTERN  */
5305 #include "embed.h"
5306
5307 #ifndef PERL_GLOBAL_STRUCT
5308 START_EXTERN_C
5309
5310 #  include "perlvars.h"
5311
5312 END_EXTERN_C
5313 #endif
5314
5315 #undef PERLVAR
5316 #undef PERLVARA
5317 #undef PERLVARI
5318 #undef PERLVARIC
5319
5320 START_EXTERN_C
5321
5322 /* dummy variables that hold pointers to both runops functions, thus forcing
5323  * them *both* to get linked in (useful for Peek.xs, debugging etc) */
5324
5325 EXTCONST runops_proc_t PL_runops_std
5326   INIT(Perl_runops_standard);
5327 EXTCONST runops_proc_t PL_runops_dbg
5328   INIT(Perl_runops_debug);
5329
5330 /* PERL_GLOBAL_STRUCT_PRIVATE wants to keep global data like the
5331  * magic vtables const, but this is incompatible with SWIG which
5332  * does want to modify the vtables. */
5333 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
5334 #  define EXT_MGVTBL EXTCONST MGVTBL
5335 #else
5336 #  define EXT_MGVTBL EXT MGVTBL
5337 #endif
5338
5339 #define PERL_MAGIC_READONLY_ACCEPTABLE 0x40
5340 #define PERL_MAGIC_VALUE_MAGIC 0x80
5341 #define PERL_MAGIC_VTABLE_MASK 0x3F
5342 #define PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(t) \
5343     (PL_magic_data[(U8)(t)] & PERL_MAGIC_READONLY_ACCEPTABLE)
5344 #define PERL_MAGIC_TYPE_IS_VALUE_MAGIC(t) \
5345     (PL_magic_data[(U8)(t)] & PERL_MAGIC_VALUE_MAGIC)
5346
5347 #include "mg_vtable.h"
5348
5349 #ifdef DOINIT
5350 EXTCONST U8 PL_magic_data[256] =
5351 #  ifdef PERL_MICRO
5352 #    include "umg_data.h"
5353 #  else
5354 #    include "mg_data.h"
5355 #  endif
5356 ;
5357 #else
5358 EXTCONST U8 PL_magic_data[256];
5359 #endif
5360
5361 #ifdef DOINIT
5362                         /* NL IV NV PV INV PI PN MG RX GV LV AV HV CV FM IO */
5363 EXTCONST bool
5364 PL_valid_types_IVX[]    = { 0, 1, 0, 0, 0, 1, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5365 EXTCONST bool
5366 PL_valid_types_NVX[]    = { 0, 0, 1, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5367 EXTCONST bool
5368 PL_valid_types_PVX[]    = { 0, 0, 0, 1, 1, 1, 1, 1, 0, 1, 1, 0, 0, 1, 1, 1 };
5369 EXTCONST bool
5370 PL_valid_types_RV[]     = { 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1 };
5371 EXTCONST bool
5372 PL_valid_types_IV_set[] = { 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1 };
5373 EXTCONST bool
5374 PL_valid_types_NV_set[] = { 0, 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0 };
5375
5376 #else
5377
5378 EXTCONST bool PL_valid_types_IVX[];
5379 EXTCONST bool PL_valid_types_NVX[];
5380 EXTCONST bool PL_valid_types_PVX[];
5381 EXTCONST bool PL_valid_types_RV[];
5382 EXTCONST bool PL_valid_types_IV_set[];
5383 EXTCONST bool PL_valid_types_NV_set[];
5384
5385 #endif
5386
5387
5388 /* if these never got defined, they need defaults */
5389 #ifndef PERL_SET_CONTEXT
5390 #  define PERL_SET_CONTEXT(i)           PERL_SET_INTERP(i)
5391 #endif
5392
5393 #ifndef PERL_GET_CONTEXT
5394 #  define PERL_GET_CONTEXT              PERL_GET_INTERP
5395 #endif
5396
5397 #ifndef PERL_GET_THX
5398 #  define PERL_GET_THX                  ((void*)NULL)
5399 #endif
5400
5401 #ifndef PERL_SET_THX
5402 #  define PERL_SET_THX(t)               NOOP
5403 #endif
5404
5405
5406 #ifndef PERL_NO_INLINE_FUNCTIONS
5407 /* Static inline funcs that depend on includes and declarations above.
5408    Some of these reference functions in the perl object files, and some
5409    compilers aren't smart enough to eliminate unused static inline
5410    functions, so including this file in source code can cause link errors
5411    even if the source code uses none of the functions. Hence including these
5412    can be be suppressed by setting PERL_NO_INLINE_FUNCTIONS. Doing this will
5413    (obviously) result in unworkable XS code, but allows simple probing code
5414    to continue to work, because it permits tests to include the perl headers
5415    for definitions without creating a link dependency on the perl library
5416    (which may not exist yet).
5417 */
5418
5419 #  include "inline.h"
5420 #endif
5421
5422 #include "overload.h"
5423
5424 END_EXTERN_C
5425
5426 struct am_table {
5427   U8 flags;
5428   U8 fallback;
5429   U16 spare;
5430   U32 was_ok_sub;
5431   CV* table[NofAMmeth];
5432 };
5433 struct am_table_short {
5434   U8 flags;
5435   U8 fallback;
5436   U16 spare;
5437   U32 was_ok_sub;
5438 };
5439 typedef struct am_table AMT;
5440 typedef struct am_table_short AMTS;
5441
5442 #define AMGfallNEVER    1
5443 #define AMGfallNO       2
5444 #define AMGfallYES      3
5445
5446 #define AMTf_AMAGIC             1
5447 #define AMT_AMAGIC(amt)         ((amt)->flags & AMTf_AMAGIC)
5448 #define AMT_AMAGIC_on(amt)      ((amt)->flags |= AMTf_AMAGIC)
5449 #define AMT_AMAGIC_off(amt)     ((amt)->flags &= ~AMTf_AMAGIC)
5450
5451 #define StashHANDLER(stash,meth)        gv_handler((stash),CAT2(meth,_amg))
5452
5453 /*
5454  * some compilers like to redefine cos et alia as faster
5455  * (and less accurate?) versions called F_cos et cetera (Quidquid
5456  * latine dictum sit, altum viditur.)  This trick collides with
5457  * the Perl overloading (amg).  The following #defines fool both.
5458  */
5459
5460 #ifdef _FASTMATH
5461 #   ifdef atan2
5462 #       define F_atan2_amg  atan2_amg
5463 #   endif
5464 #   ifdef cos
5465 #       define F_cos_amg    cos_amg
5466 #   endif
5467 #   ifdef exp
5468 #       define F_exp_amg    exp_amg
5469 #   endif
5470 #   ifdef log
5471 #       define F_log_amg    log_amg
5472 #   endif
5473 #   ifdef pow
5474 #       define F_pow_amg    pow_amg
5475 #   endif
5476 #   ifdef sin
5477 #       define F_sin_amg    sin_amg
5478 #   endif
5479 #   ifdef sqrt
5480 #       define F_sqrt_amg   sqrt_amg
5481 #   endif
5482 #endif /* _FASTMATH */
5483
5484 #define PERLDB_ALL              (PERLDBf_SUB    | PERLDBf_LINE  |       \
5485                                  PERLDBf_NOOPT  | PERLDBf_INTER |       \
5486                                  PERLDBf_SUBLINE| PERLDBf_SINGLE|       \
5487                                  PERLDBf_NAMEEVAL| PERLDBf_NAMEANON |   \
5488                                  PERLDBf_SAVESRC)
5489                                         /* No _NONAME, _GOTO */
5490 #define PERLDBf_SUB             0x01    /* Debug sub enter/exit */
5491 #define PERLDBf_LINE            0x02    /* Keep line # */
5492 #define PERLDBf_NOOPT           0x04    /* Switch off optimizations */
5493 #define PERLDBf_INTER           0x08    /* Preserve more data for
5494                                            later inspections  */
5495 #define PERLDBf_SUBLINE         0x10    /* Keep subr source lines */
5496 #define PERLDBf_SINGLE          0x20    /* Start with single-step on */
5497 #define PERLDBf_NONAME          0x40    /* For _SUB: no name of the subr */
5498 #define PERLDBf_GOTO            0x80    /* Report goto: call DB::goto */
5499 #define PERLDBf_NAMEEVAL        0x100   /* Informative names for evals */
5500 #define PERLDBf_NAMEANON        0x200   /* Informative names for anon subs */
5501 #define PERLDBf_SAVESRC         0x400   /* Save source lines into @{"_<$filename"} */
5502 #define PERLDBf_SAVESRC_NOSUBS  0x800   /* Including evals that generate no subroutines */
5503 #define PERLDBf_SAVESRC_INVALID 0x1000  /* Save source that did not compile */
5504
5505 #define PERLDB_SUB      (PL_perldb && (PL_perldb & PERLDBf_SUB))
5506 #define PERLDB_LINE     (PL_perldb && (PL_perldb & PERLDBf_LINE))
5507 #define PERLDB_NOOPT    (PL_perldb && (PL_perldb & PERLDBf_NOOPT))
5508 #define PERLDB_INTER    (PL_perldb && (PL_perldb & PERLDBf_INTER))
5509 #define PERLDB_SUBLINE  (PL_perldb && (PL_perldb & PERLDBf_SUBLINE))
5510 #define PERLDB_SINGLE   (PL_perldb && (PL_perldb & PERLDBf_SINGLE))
5511 #define PERLDB_SUB_NN   (PL_perldb && (PL_perldb & (PERLDBf_NONAME)))
5512 #define PERLDB_GOTO     (PL_perldb && (PL_perldb & PERLDBf_GOTO))
5513 #define PERLDB_NAMEEVAL (PL_perldb && (PL_perldb & PERLDBf_NAMEEVAL))
5514 #define PERLDB_NAMEANON (PL_perldb && (PL_perldb & PERLDBf_NAMEANON))
5515 #define PERLDB_SAVESRC  (PL_perldb && (PL_perldb & PERLDBf_SAVESRC))
5516 #define PERLDB_SAVESRC_NOSUBS   (PL_perldb && (PL_perldb & PERLDBf_SAVESRC_NOSUBS))
5517 #define PERLDB_SAVESRC_INVALID  (PL_perldb && (PL_perldb & PERLDBf_SAVESRC_INVALID))
5518
5519 #ifdef USE_LOCALE
5520 /* These locale things are all subject to change */
5521 /* Returns TRUE if the plain locale pragma without a parameter is in effect
5522  */
5523 #   define IN_LOCALE_RUNTIME    cBOOL(CopHINTS_get(PL_curcop) & HINT_LOCALE)
5524
5525 /* Returns TRUE if either form of the locale pragma is in effect */
5526 #   define IN_SOME_LOCALE_FORM_RUNTIME   \
5527            cBOOL(CopHINTS_get(PL_curcop) & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
5528
5529 #   define IN_LOCALE_COMPILETIME        cBOOL(PL_hints & HINT_LOCALE)
5530 #   define IN_SOME_LOCALE_FORM_COMPILETIME \
5531                           cBOOL(PL_hints & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
5532
5533 #   define IN_LOCALE \
5534         (IN_PERL_COMPILETIME ? IN_LOCALE_COMPILETIME : IN_LOCALE_RUNTIME)
5535 #   define IN_SOME_LOCALE_FORM \
5536         (IN_PERL_COMPILETIME ? IN_SOME_LOCALE_FORM_COMPILETIME \
5537                              : IN_SOME_LOCALE_FORM_RUNTIME)
5538
5539 #   define IN_LC_ALL_COMPILETIME   IN_LOCALE_COMPILETIME
5540 #   define IN_LC_ALL_RUNTIME       IN_LOCALE_RUNTIME
5541
5542 #   define IN_LC_PARTIAL_COMPILETIME   cBOOL(PL_hints & HINT_LOCALE_PARTIAL)
5543 #   define IN_LC_PARTIAL_RUNTIME  \
5544                         cBOOL(CopHINTS_get(PL_curcop) & HINT_LOCALE_PARTIAL)
5545
5546 #   define IN_LC_COMPILETIME(category)                                       \
5547        (IN_LC_ALL_COMPILETIME || (IN_LC_PARTIAL_COMPILETIME                  \
5548                                   && _is_in_locale_category(TRUE, (category))))
5549 #   define IN_LC_RUNTIME(category)                                           \
5550        (IN_LC_ALL_RUNTIME || (IN_LC_PARTIAL_RUNTIME                          \
5551                               && _is_in_locale_category(FALSE, (category))))
5552 #   define IN_LC(category)  \
5553                     (IN_LC_COMPILETIME(category) || IN_LC_RUNTIME(category))
5554
5555 #else   /* No locale usage */
5556 #   define IN_LOCALE_RUNTIME                0
5557 #   define IN_SOME_LOCALE_FORM_RUNTIME      0
5558 #   define IN_LOCALE_COMPILETIME            0
5559 #   define IN_SOME_LOCALE_FORM_COMPILETIME  0
5560 #   define IN_LOCALE                        0
5561 #   define IN_SOME_LOCALE_FORM              0
5562 #   define IN_LC_ALL_COMPILETIME            0
5563 #   define IN_LC_ALL_RUNTIME                0
5564 #   define IN_LC_PARTIAL_COMPILETIME        0
5565 #   define IN_LC_PARTIAL_RUNTIME            0
5566 #   define IN_LC_COMPILETIME(category)      0
5567 #   define IN_LC_RUNTIME(category)          0
5568 #   define IN_LC(category)                  0
5569 #endif
5570
5571 #ifdef USE_LOCALE_NUMERIC
5572
5573 /* These macros are for toggling between the underlying locale (LOCAL) and the
5574  * C locale. */
5575
5576 /* The first set makes sure that the locale is set to C unless within a 'use
5577  * locale's scope; otherwise to the default locale.  A function pointer is
5578  * used, which can be declared separately by
5579  * DECLARATION_FOR_STORE_LC_NUMERIC_SET_TO_NEEDED, followed by the actual
5580  * setting (using STORE_LC_NUMERIC_SET_TO_NEEDED()), or the two can be combined
5581  * into one call DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED().
5582  * RESTORE_LC_NUMERIC() in all cases restores the locale to what it was before
5583  * these were called */
5584
5585 #define _NOT_IN_NUMERIC_STANDARD (! PL_numeric_standard)
5586
5587 /* We can lock the category to stay in the C locale, making requests to the
5588  * contrary noops, in the dynamic scope by setting PL_numeric_standard to 2 */
5589 #define _NOT_IN_NUMERIC_LOCAL    (! PL_numeric_local && PL_numeric_standard < 2)
5590
5591 #define DECLARATION_FOR_STORE_LC_NUMERIC_SET_TO_NEEDED                       \
5592     void (*_restore_LC_NUMERIC_function)(pTHX) = NULL;
5593
5594 #define STORE_LC_NUMERIC_SET_TO_NEEDED()                                     \
5595     if (IN_LC(LC_NUMERIC)) {                                                 \
5596         if (_NOT_IN_NUMERIC_LOCAL) {                                         \
5597             set_numeric_local();                                             \
5598             _restore_LC_NUMERIC_function = &Perl_set_numeric_standard;       \
5599         }                                                                    \
5600     }                                                                        \
5601     else {                                                                   \
5602         if (_NOT_IN_NUMERIC_STANDARD) {                                      \
5603             SET_NUMERIC_STANDARD();                                          \
5604             _restore_LC_NUMERIC_function = &Perl_set_numeric_local;          \
5605         }                                                                    \
5606     }
5607
5608 #define DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED()                             \
5609     DECLARATION_FOR_STORE_LC_NUMERIC_SET_TO_NEEDED;                          \
5610     STORE_LC_NUMERIC_SET_TO_NEEDED();
5611
5612 #define RESTORE_LC_NUMERIC()                                                 \
5613     if (_restore_LC_NUMERIC_function) {                                      \
5614         _restore_LC_NUMERIC_function(aTHX);                                  \
5615     }
5616
5617 /* The next two macros set unconditionally.  These should be rarely used, and
5618  * only after being sure that this is what is needed */
5619 #define SET_NUMERIC_STANDARD()                                              \
5620         STMT_START { if (_NOT_IN_NUMERIC_STANDARD) set_numeric_standard();  \
5621                                                                  } STMT_END
5622
5623 #define SET_NUMERIC_LOCAL()                                                 \
5624         STMT_START { if (_NOT_IN_NUMERIC_LOCAL)                             \
5625                                             set_numeric_local(); } STMT_END
5626
5627 /* The rest of these LC_NUMERIC macros toggle to one or the other state, with
5628  * the RESTORE_foo ones called to switch back, but only if need be */
5629 #define STORE_NUMERIC_LOCAL_SET_STANDARD()          \
5630         bool _was_local = _NOT_IN_NUMERIC_STANDARD; \
5631         if (_was_local) set_numeric_standard();
5632
5633 /* Doesn't change to underlying locale unless within the scope of some form of
5634  * 'use locale'.  This is the usual desired behavior. */
5635 #define STORE_NUMERIC_STANDARD_SET_LOCAL()              \
5636         bool _was_standard = _NOT_IN_NUMERIC_LOCAL      \
5637                             && IN_LC(LC_NUMERIC);       \
5638         if (_was_standard) set_numeric_local();
5639
5640 /* Rarely, we want to change to the underlying locale even outside of 'use
5641  * locale'.  This is principally in the POSIX:: functions */
5642 #define STORE_NUMERIC_STANDARD_FORCE_LOCAL()            \
5643         bool _was_standard = _NOT_IN_NUMERIC_LOCAL;     \
5644         if (_was_standard) set_numeric_local();
5645
5646 /* Lock to the C locale until unlock is called */
5647 #define LOCK_NUMERIC_STANDARD()                         \
5648         (__ASSERT_(PL_numeric_standard)                 \
5649         PL_numeric_standard = 2)
5650
5651 #define UNLOCK_NUMERIC_STANDARD()                       \
5652         (__ASSERT_(PL_numeric_standard == 2)            \
5653         PL_numeric_standard = 1)
5654
5655 #define RESTORE_NUMERIC_LOCAL() \
5656         if (_was_local) set_numeric_local();
5657
5658 #define RESTORE_NUMERIC_STANDARD() \
5659         if (_was_standard) SET_NUMERIC_STANDARD();
5660
5661 #define Atof                            my_atof
5662
5663 #else /* !USE_LOCALE_NUMERIC */
5664
5665 #define SET_NUMERIC_STANDARD()          /**/
5666 #define SET_NUMERIC_LOCAL()             /**/
5667 #define IS_NUMERIC_RADIX(a, b)          (0)
5668 #define STORE_NUMERIC_LOCAL_SET_STANDARD()      /**/
5669 #define STORE_NUMERIC_STANDARD_SET_LOCAL()      /**/
5670 #define STORE_NUMERIC_STANDARD_FORCE_LOCAL()
5671 #define RESTORE_NUMERIC_LOCAL()         /**/
5672 #define RESTORE_NUMERIC_STANDARD()      /**/
5673 #define DECLARATION_FOR_STORE_LC_NUMERIC_SET_TO_NEEDED
5674 #define STORE_LC_NUMERIC_SET_TO_NEEDED()
5675 #define DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED()
5676 #define RESTORE_LC_NUMERIC()
5677 #define LOCK_NUMERIC_STANDARD()
5678 #define UNLOCK_NUMERIC_STANDARD()
5679
5680 #define Atof                            my_atof
5681
5682 #endif /* !USE_LOCALE_NUMERIC */
5683
5684 #if defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE)
5685 #  if defined(HAS_STRTOLD)
5686 #    define Perl_strtod(s, e) strtold(s, e)
5687 #  elif defined(HAS_STRTOD)
5688 #    define Perl_strtod(s, e) (NV)strtod(s, e) /* Unavoidable loss. */
5689 #  endif
5690 #elif defined(HAS_STRTOD)
5691 #  define Perl_strtod(s, e) strtod(s, e)
5692 #endif
5693
5694 #if !defined(Strtol) && defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && \
5695         (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
5696 #    ifdef __hpux
5697 #        define strtoll __strtoll       /* secret handshake */
5698 #    endif
5699 #    ifdef WIN64
5700 #        define strtoll _strtoi64       /* secret handshake */
5701 #    endif
5702 #   if !defined(Strtol) && defined(HAS_STRTOLL)
5703 #       define Strtol   strtoll
5704 #   endif
5705 #    if !defined(Strtol) && defined(HAS_STRTOQ)
5706 #       define Strtol   strtoq
5707 #    endif
5708 /* is there atoq() anywhere? */
5709 #endif
5710 #if !defined(Strtol) && defined(HAS_STRTOL)
5711 #   define Strtol       strtol
5712 #endif
5713 #ifndef Atol
5714 /* It would be more fashionable to use Strtol() to define atol()
5715  * (as is done for Atoul(), see below) but for backward compatibility
5716  * we just assume atol(). */
5717 #   if defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && defined(HAS_ATOLL) && \
5718         (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
5719 #    ifdef WIN64
5720 #       define atoll    _atoi64         /* secret handshake */
5721 #    endif
5722 #       define Atol     atoll
5723 #   else
5724 #       define Atol     atol
5725 #   endif
5726 #endif
5727
5728 #if !defined(Strtoul) && defined(USE_64_BIT_INT) && defined(UV_IS_QUAD) && \
5729         (QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
5730 #    ifdef __hpux
5731 #        define strtoull __strtoull     /* secret handshake */
5732 #    endif
5733 #    ifdef WIN64
5734 #        define strtoull _strtoui64     /* secret handshake */
5735 #    endif
5736 #    if !defined(Strtoul) && defined(HAS_STRTOULL)
5737 #       define Strtoul  strtoull
5738 #    endif
5739 #    if !defined(Strtoul) && defined(HAS_STRTOUQ)
5740 #       define Strtoul  strtouq
5741 #    endif
5742 /* is there atouq() anywhere? */
5743 #endif
5744 #if !defined(Strtoul) && defined(HAS_STRTOUL)
5745 #   define Strtoul      strtoul
5746 #endif
5747 #if !defined(Strtoul) && defined(HAS_STRTOL) /* Last resort. */
5748 #   define Strtoul(s, e, b)     strchr((s), '-') ? ULONG_MAX : (unsigned long)strtol((s), (e), (b))
5749 #endif
5750 #ifndef Atoul
5751 #   define Atoul(s)     Strtoul(s, NULL, 10)
5752 #endif
5753
5754 #ifndef PERL_SCRIPT_MODE
5755 #define PERL_SCRIPT_MODE "r"
5756 #endif
5757
5758 /*
5759  * Some operating systems are stingy with stack allocation,
5760  * so perl may have to guard against stack overflow.
5761  */
5762 #ifndef PERL_STACK_OVERFLOW_CHECK
5763 #define PERL_STACK_OVERFLOW_CHECK()  NOOP
5764 #endif
5765
5766 /*
5767  * Some nonpreemptive operating systems find it convenient to
5768  * check for asynchronous conditions after each op execution.
5769  * Keep this check simple, or it may slow down execution
5770  * massively.
5771  */
5772
5773 #ifndef PERL_MICRO
5774 #       ifndef PERL_ASYNC_CHECK
5775 #               define PERL_ASYNC_CHECK() if (UNLIKELY(PL_sig_pending)) PL_signalhook(aTHX)
5776 #       endif
5777 #endif
5778
5779 #ifndef PERL_ASYNC_CHECK
5780 #   define PERL_ASYNC_CHECK()  NOOP
5781 #endif
5782
5783 /*
5784  * On some operating systems, a memory allocation may succeed,
5785  * but put the process too close to the system's comfort limit.
5786  * In this case, PERL_ALLOC_CHECK frees the pointer and sets
5787  * it to NULL.
5788  */
5789 #ifndef PERL_ALLOC_CHECK
5790 #define PERL_ALLOC_CHECK(p)  NOOP
5791 #endif
5792
5793 #ifdef HAS_SEM
5794 #   include <sys/ipc.h>
5795 #   include <sys/sem.h>
5796 #   ifndef HAS_UNION_SEMUN      /* Provide the union semun. */
5797     union semun {
5798         int             val;
5799         struct semid_ds *buf;
5800         unsigned short  *array;
5801     };
5802 #   endif
5803 #   ifdef USE_SEMCTL_SEMUN
5804 #       ifdef IRIX32_SEMUN_BROKEN_BY_GCC
5805             union gccbug_semun {
5806                 int             val;
5807                 struct semid_ds *buf;
5808                 unsigned short  *array;
5809                 char            __dummy[5];
5810             };
5811 #           define semun gccbug_semun
5812 #       endif
5813 #       define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun)
5814 #   else
5815 #       ifdef USE_SEMCTL_SEMID_DS
5816 #           ifdef EXTRA_F_IN_SEMUN_BUF
5817 #               define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buff)
5818 #           else
5819 #               define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buf)
5820 #           endif
5821 #       endif
5822 #   endif
5823 #endif
5824
5825 /*
5826  * Boilerplate macros for initializing and accessing interpreter-local
5827  * data from C.  All statics in extensions should be reworked to use
5828  * this, if you want to make the extension thread-safe.  See
5829  * ext/XS/APItest/APItest.xs for an example of the use of these macros,
5830  * and perlxs.pod for more.
5831  *
5832  * Code that uses these macros is responsible for the following:
5833  * 1. #define MY_CXT_KEY to a unique string, e.g.
5834  *    "DynaLoader::_guts" XS_VERSION
5835  *    XXX in the current implementation, this string is ignored.
5836  * 2. Declare a typedef named my_cxt_t that is a structure that contains
5837  *    all the data that needs to be interpreter-local.
5838  * 3. Use the START_MY_CXT macro after the declaration of my_cxt_t.
5839  * 4. Use the MY_CXT_INIT macro such that it is called exactly once
5840  *    (typically put in the BOOT: section).
5841  * 5. Use the members of the my_cxt_t structure everywhere as
5842  *    MY_CXT.member.
5843  * 6. Use the dMY_CXT macro (a declaration) in all the functions that
5844  *    access MY_CXT.
5845  */
5846
5847 #if defined(PERL_IMPLICIT_CONTEXT)
5848
5849 /* START_MY_CXT must appear in all extensions that define a my_cxt_t structure,
5850  * right after the definition (i.e. at file scope).  The non-threads
5851  * case below uses it to declare the data as static. */
5852 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
5853 #    define START_MY_CXT
5854 #    define MY_CXT_INDEX Perl_my_cxt_index(aTHX_ MY_CXT_KEY)
5855 #    define MY_CXT_INIT_ARG MY_CXT_KEY
5856 #  else
5857 #    define START_MY_CXT static int my_cxt_index = -1;
5858 #    define MY_CXT_INDEX my_cxt_index
5859 #    define MY_CXT_INIT_ARG &my_cxt_index
5860 #  endif /* #ifdef PERL_GLOBAL_STRUCT_PRIVATE */
5861
5862 /* Creates and zeroes the per-interpreter data.
5863  * (We allocate my_cxtp in a Perl SV so that it will be released when
5864  * the interpreter goes away.) */
5865 #  define MY_CXT_INIT \
5866         my_cxt_t *my_cxtp = \
5867             (my_cxt_t*)Perl_my_cxt_init(aTHX_ MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
5868         PERL_UNUSED_VAR(my_cxtp)
5869 #  define MY_CXT_INIT_INTERP(my_perl) \
5870         my_cxt_t *my_cxtp = \
5871             (my_cxt_t*)Perl_my_cxt_init(my_perl, MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
5872         PERL_UNUSED_VAR(my_cxtp)
5873
5874 /* This declaration should be used within all functions that use the
5875  * interpreter-local data. */
5876 #  define dMY_CXT       \
5877         my_cxt_t *my_cxtp = (my_cxt_t *)PL_my_cxt_list[MY_CXT_INDEX]
5878 #  define dMY_CXT_INTERP(my_perl)       \
5879         my_cxt_t *my_cxtp = (my_cxt_t *)(my_perl)->Imy_cxt_list[MY_CXT_INDEX]
5880
5881 /* Clones the per-interpreter data. */
5882 #  define MY_CXT_CLONE \
5883         my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1));\
5884         Copy(PL_my_cxt_list[MY_CXT_INDEX], my_cxtp, 1, my_cxt_t);\
5885         PL_my_cxt_list[MY_CXT_INDEX] = my_cxtp                          \
5886
5887
5888 /* This macro must be used to access members of the my_cxt_t structure.
5889  * e.g. MY_CXT.some_data */
5890 #  define MY_CXT                (*my_cxtp)
5891
5892 /* Judicious use of these macros can reduce the number of times dMY_CXT
5893  * is used.  Use is similar to pTHX, aTHX etc. */
5894 #  define pMY_CXT       my_cxt_t *my_cxtp
5895 #  define pMY_CXT_      pMY_CXT,
5896 #  define _pMY_CXT      ,pMY_CXT
5897 #  define aMY_CXT       my_cxtp
5898 #  define aMY_CXT_      aMY_CXT,
5899 #  define _aMY_CXT      ,aMY_CXT
5900
5901 #else /* PERL_IMPLICIT_CONTEXT */
5902
5903 #  define START_MY_CXT          static my_cxt_t my_cxt;
5904 #  define dMY_CXT_SV            dNOOP
5905 #  define dMY_CXT               dNOOP
5906 #  define dMY_CXT_INTERP(my_perl) dNOOP
5907 #  define MY_CXT_INIT           NOOP
5908 #  define MY_CXT_CLONE          NOOP
5909 #  define MY_CXT                my_cxt
5910
5911 #  define pMY_CXT               void
5912 #  define pMY_CXT_
5913 #  define _pMY_CXT
5914 #  define aMY_CXT
5915 #  define aMY_CXT_
5916 #  define _aMY_CXT
5917
5918 #endif /* !defined(PERL_IMPLICIT_CONTEXT) */
5919
5920 #ifdef I_FCNTL
5921 #  include <fcntl.h>
5922 #endif
5923
5924 #ifdef __Lynx__
5925 #  include <fcntl.h>
5926 #endif
5927
5928 #ifdef I_SYS_FILE
5929 #  include <sys/file.h>
5930 #endif
5931
5932 #if defined(HAS_FLOCK) && !defined(HAS_FLOCK_PROTO)
5933 int flock(int fd, int op);
5934 #endif
5935
5936 #ifndef O_RDONLY
5937 /* Assume UNIX defaults */
5938 #    define O_RDONLY    0000
5939 #    define O_WRONLY    0001
5940 #    define O_RDWR      0002
5941 #    define O_CREAT     0100
5942 #endif
5943
5944 #ifndef O_BINARY
5945 #  define O_BINARY 0
5946 #endif
5947
5948 #ifndef O_TEXT
5949 #  define O_TEXT 0
5950 #endif
5951
5952 #if O_TEXT != O_BINARY
5953     /* If you have different O_TEXT and O_BINARY and you are a CRLF shop,
5954      * that is, you are somehow DOSish. */
5955 #   if defined(__HAIKU__) || defined(__VOS__) || defined(__CYGWIN__)
5956     /* Haiku has O_TEXT != O_BINARY but O_TEXT and O_BINARY have no effect;
5957      * Haiku is always UNIXoid (LF), not DOSish (CRLF). */
5958     /* VOS has O_TEXT != O_BINARY, and they have effect,
5959      * but VOS always uses LF, never CRLF. */
5960     /* If you have O_TEXT different from your O_BINARY but you still are
5961      * not a CRLF shop. */
5962 #       undef PERLIO_USING_CRLF
5963 #   else
5964     /* If you really are DOSish. */
5965 #      define PERLIO_USING_CRLF 1
5966 #   endif
5967 #endif
5968
5969 #ifdef I_LIBUTIL
5970 #   include <libutil.h>         /* setproctitle() in some FreeBSDs */
5971 #endif
5972
5973 #ifndef EXEC_ARGV_CAST
5974 #define EXEC_ARGV_CAST(x) (char **)x
5975 #endif
5976
5977 #define IS_NUMBER_IN_UV               0x01 /* number within UV range (maybe not
5978                                               int).  value returned in pointed-
5979                                               to UV */
5980 #define IS_NUMBER_GREATER_THAN_UV_MAX 0x02 /* pointed to UV undefined */
5981 #define IS_NUMBER_NOT_INT             0x04 /* saw . or E notation */
5982 #define IS_NUMBER_NEG                 0x08 /* leading minus sign */
5983 #define IS_NUMBER_INFINITY            0x10 /* this is big */
5984 #define IS_NUMBER_NAN                 0x20 /* this is not */
5985 #define IS_NUMBER_TRAILING            0x40 /* number has trailing trash */
5986
5987 #define GROK_NUMERIC_RADIX(sp, send) grok_numeric_radix(sp, send)
5988
5989 /* Input flags: */
5990 #define PERL_SCAN_ALLOW_UNDERSCORES   0x01 /* grok_??? accept _ in numbers */
5991 #define PERL_SCAN_DISALLOW_PREFIX     0x02 /* grok_??? reject 0x in hex etc */
5992 #define PERL_SCAN_SILENT_ILLDIGIT     0x04 /* grok_??? not warn about illegal digits */
5993 #define PERL_SCAN_SILENT_NON_PORTABLE 0x08 /* grok_??? not warn about very large
5994                                               numbers which are <= UV_MAX */
5995 #define PERL_SCAN_TRAILING            0x10 /* grok_number_flags() allow trailing
5996                                               and set IS_NUMBER_TRAILING */
5997
5998 /* Output flags: */
5999 #define PERL_SCAN_GREATER_THAN_UV_MAX 0x02 /* should this merge with above? */
6000
6001 /* to let user control profiling */
6002 #ifdef PERL_GPROF_CONTROL
6003 extern void moncontrol(int);
6004 #define PERL_GPROF_MONCONTROL(x) moncontrol(x)
6005 #else
6006 #define PERL_GPROF_MONCONTROL(x)
6007 #endif
6008
6009 #ifdef UNDER_CE
6010 #include "wince.h"
6011 #endif
6012
6013 /* ISO 6429 NEL - C1 control NExt Line */
6014 /* See http://www.unicode.org/unicode/reports/tr13/ */
6015 #define NEXT_LINE_CHAR  NEXT_LINE_NATIVE
6016
6017 /* The UTF-8 bytes of the Unicode LS and PS, U+2028 and U+2029 */
6018 #define UNICODE_LINE_SEPA_0     0xE2
6019 #define UNICODE_LINE_SEPA_1     0x80
6020 #define UNICODE_LINE_SEPA_2     0xA8
6021 #define UNICODE_PARA_SEPA_0     0xE2
6022 #define UNICODE_PARA_SEPA_1     0x80
6023 #define UNICODE_PARA_SEPA_2     0xA9
6024
6025 #ifndef PIPESOCK_MODE
6026 #  define PIPESOCK_MODE
6027 #endif
6028
6029 #ifndef SOCKET_OPEN_MODE
6030 #  define SOCKET_OPEN_MODE      PIPESOCK_MODE
6031 #endif
6032
6033 #ifndef PIPE_OPEN_MODE
6034 #  define PIPE_OPEN_MODE        PIPESOCK_MODE
6035 #endif
6036
6037 #define PERL_MAGIC_UTF8_CACHESIZE       2
6038
6039 #define PERL_UNICODE_STDIN_FLAG                 0x0001
6040 #define PERL_UNICODE_STDOUT_FLAG                0x0002
6041 #define PERL_UNICODE_STDERR_FLAG                0x0004
6042 #define PERL_UNICODE_IN_FLAG                    0x0008
6043 #define PERL_UNICODE_OUT_FLAG                   0x0010
6044 #define PERL_UNICODE_ARGV_FLAG                  0x0020
6045 #define PERL_UNICODE_LOCALE_FLAG                0x0040
6046 #define PERL_UNICODE_WIDESYSCALLS_FLAG          0x0080 /* for Sarathy */
6047 #define PERL_UNICODE_UTF8CACHEASSERT_FLAG       0x0100
6048
6049 #define PERL_UNICODE_STD_FLAG           \
6050         (PERL_UNICODE_STDIN_FLAG        | \
6051          PERL_UNICODE_STDOUT_FLAG       | \
6052          PERL_UNICODE_STDERR_FLAG)
6053
6054 #define PERL_UNICODE_INOUT_FLAG         \
6055         (PERL_UNICODE_IN_FLAG   | \
6056          PERL_UNICODE_OUT_FLAG)
6057
6058 #define PERL_UNICODE_DEFAULT_FLAGS      \
6059         (PERL_UNICODE_STD_FLAG          | \
6060          PERL_UNICODE_INOUT_FLAG        | \
6061          PERL_UNICODE_LOCALE_FLAG)
6062
6063 #define PERL_UNICODE_ALL_FLAGS                  0x01ff
6064
6065 #define PERL_UNICODE_STDIN                      'I'
6066 #define PERL_UNICODE_STDOUT                     'O'
6067 #define PERL_UNICODE_STDERR                     'E'
6068 #define PERL_UNICODE_STD                        'S'
6069 #define PERL_UNICODE_IN                         'i'
6070 #define PERL_UNICODE_OUT                        'o'
6071 #define PERL_UNICODE_INOUT                      'D'
6072 #define PERL_UNICODE_ARGV                       'A'
6073 #define PERL_UNICODE_LOCALE                     'L'
6074 #define PERL_UNICODE_WIDESYSCALLS               'W'
6075 #define PERL_UNICODE_UTF8CACHEASSERT            'a'
6076
6077 #define PERL_SIGNALS_UNSAFE_FLAG        0x0001
6078
6079 /* Use instead of abs() since abs() forces its argument to be an int,
6080  * but also beware since this evaluates its argument twice, so no x++. */
6081 #define PERL_ABS(x) ((x) < 0 ? -(x) : (x))
6082
6083 #if defined(__DECC) && defined(__osf__)
6084 #pragma message disable (mainparm) /* Perl uses the envp in main(). */
6085 #endif
6086
6087 #define do_open(g, n, l, a, rm, rp, sf) \
6088         do_openn(g, n, l, a, rm, rp, sf, (SV **) NULL, 0)
6089 #ifdef PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
6090 #  define do_exec(cmd)                  do_exec3(cmd,0,0)
6091 #endif
6092 #ifdef OS2
6093 #  define do_aexec                      Perl_do_aexec
6094 #else
6095 #  define do_aexec(really, mark,sp)     do_aexec5(really, mark, sp, 0, 0)
6096 #endif
6097
6098 /* check embedded \0 characters in pathnames passed to syscalls,
6099    but allow one ending \0 */
6100 #define IS_SAFE_SYSCALL(p, len, what, op_name) (S_is_safe_syscall(aTHX_ (p), (len), (what), (op_name)))
6101
6102 #define IS_SAFE_PATHNAME(p, len, op_name) IS_SAFE_SYSCALL((p), (len), "pathname", (op_name))
6103
6104 #if defined(OEMVS)
6105 #define NO_ENV_ARRAY_IN_MAIN
6106 #endif
6107
6108 /* These are used by Perl_pv_escape() and Perl_pv_pretty()
6109  * are here so that they are available throughout the core
6110  * NOTE that even though some are for _escape and some for _pretty
6111  * there must not be any clashes as the flags from _pretty are
6112  * passed straight through to _escape.
6113  */
6114
6115 #define PERL_PV_ESCAPE_QUOTE        0x0001
6116 #define PERL_PV_PRETTY_QUOTE        PERL_PV_ESCAPE_QUOTE
6117
6118 #define PERL_PV_PRETTY_ELLIPSES     0x0002
6119 #define PERL_PV_PRETTY_LTGT         0x0004
6120
6121 #define PERL_PV_ESCAPE_FIRSTCHAR    0x0008
6122
6123 #define PERL_PV_ESCAPE_UNI          0x0100
6124 #define PERL_PV_ESCAPE_UNI_DETECT   0x0200
6125 #define PERL_PV_ESCAPE_NONASCII     0x0400
6126
6127 #define PERL_PV_ESCAPE_ALL          0x1000
6128 #define PERL_PV_ESCAPE_NOBACKSLASH  0x2000
6129 #define PERL_PV_ESCAPE_NOCLEAR      0x4000
6130 #define PERL_PV_ESCAPE_RE           0x8000
6131
6132 #define PERL_PV_ESCAPE_DWIM         0x10000
6133
6134 #define PERL_PV_PRETTY_NOCLEAR      PERL_PV_ESCAPE_NOCLEAR
6135
6136 /* used by pv_display in dump.c*/
6137 #define PERL_PV_PRETTY_DUMP  PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE
6138 #define PERL_PV_PRETTY_REGPROP PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_LTGT|PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII
6139
6140 /*
6141
6142    (KEEP THIS LAST IN perl.h!)
6143
6144    Mention
6145
6146    NV_PRESERVES_UV
6147
6148    HAS_MKSTEMP
6149    HAS_MKSTEMPS
6150    HAS_MKDTEMP
6151
6152    HAS_GETCWD
6153
6154    HAS_MMAP
6155    HAS_MPROTECT
6156    HAS_MSYNC
6157    HAS_MADVISE
6158    HAS_MUNMAP
6159    I_SYSMMAN
6160    Mmap_t
6161
6162    NVef
6163    NVff
6164    NVgf
6165
6166    HAS_UALARM
6167    HAS_USLEEP
6168
6169    HAS_SETITIMER
6170    HAS_GETITIMER
6171
6172    HAS_SENDMSG
6173    HAS_RECVMSG
6174    HAS_READV
6175    HAS_WRITEV
6176    I_SYSUIO
6177    HAS_STRUCT_MSGHDR
6178    HAS_STRUCT_CMSGHDR
6179
6180    HAS_NL_LANGINFO
6181
6182    HAS_DIRFD
6183
6184    so that Configure picks them up.
6185
6186    (KEEP THIS LAST IN perl.h!)
6187
6188 */
6189
6190 #endif /* Include guard */
6191
6192 /*
6193  * Local variables:
6194  * c-indentation-style: bsd
6195  * c-basic-offset: 4
6196  * indent-tabs-mode: nil
6197  * End:
6198  *
6199  * ex: set ts=8 sts=4 sw=4 et:
6200  */