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