This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perl.h: Actually #define USE_LOCALE_TIME
[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 SSize_t_MAX (SSize_t)(~(size_t)0 >> 1)
1681
1682 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
1683 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
1684
1685 #ifndef NO_PERL_PRESERVE_IVUV
1686 #define PERL_PRESERVE_IVUV      /* We like our integers to stay integers. */
1687 #endif
1688
1689 /*
1690  *  The macros INT2PTR and NUM2PTR are (despite their names)
1691  *  bi-directional: they will convert int/float to or from pointers.
1692  *  However the conversion to int/float are named explicitly:
1693  *  PTR2IV, PTR2UV, PTR2NV.
1694  *
1695  *  For int conversions we do not need two casts if pointers are
1696  *  the same size as IV and UV.   Otherwise we need an explicit
1697  *  cast (PTRV) to avoid compiler warnings.
1698  */
1699 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1700 #  define PTRV                  UV
1701 #  define INT2PTR(any,d)        (any)(d)
1702 #else
1703 #  if PTRSIZE == LONGSIZE
1704 #    define PTRV                unsigned long
1705 #    define PTR2ul(p)           (unsigned long)(p)
1706 #  else
1707 #    define PTRV                unsigned
1708 #  endif
1709 #endif
1710
1711 #ifndef INT2PTR
1712 #  define INT2PTR(any,d)        (any)(PTRV)(d)
1713 #endif
1714
1715 #ifndef PTR2ul
1716 #  define PTR2ul(p)     INT2PTR(unsigned long,p)        
1717 #endif
1718
1719 #define NUM2PTR(any,d)  (any)(PTRV)(d)
1720 #define PTR2IV(p)       INT2PTR(IV,p)
1721 #define PTR2UV(p)       INT2PTR(UV,p)
1722 #define PTR2NV(p)       NUM2PTR(NV,p)
1723 #define PTR2nat(p)      (PTRV)(p)       /* pointer to integer of PTRSIZE */
1724
1725 /* According to strict ANSI C89 one cannot freely cast between
1726  * data pointers and function (code) pointers.  There are at least
1727  * two ways around this.  One (used below) is to do two casts,
1728  * first the other pointer to an (unsigned) integer, and then
1729  * the integer to the other pointer.  The other way would be
1730  * to use unions to "overlay" the pointers.  For an example of
1731  * the latter technique, see union dirpu in struct xpvio in sv.h.
1732  * The only feasible use is probably temporarily storing
1733  * function pointers in a data pointer (such as a void pointer). */
1734
1735 #define DPTR2FPTR(t,p) ((t)PTR2nat(p))  /* data pointer to function pointer */
1736 #define FPTR2DPTR(t,p) ((t)PTR2nat(p))  /* function pointer to data pointer */
1737
1738 #ifdef USE_LONG_DOUBLE
1739 #  if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE == DOUBLESIZE
1740 #      define LONG_DOUBLE_EQUALS_DOUBLE
1741 #  endif
1742 #  if !(defined(HAS_LONG_DOUBLE) && (LONG_DOUBLESIZE > DOUBLESIZE))
1743 #     undef USE_LONG_DOUBLE /* Ouch! */
1744 #  endif
1745 #endif
1746
1747 #ifdef OVR_DBL_DIG
1748 /* Use an overridden DBL_DIG */
1749 # ifdef DBL_DIG
1750 #  undef DBL_DIG
1751 # endif
1752 # define DBL_DIG OVR_DBL_DIG
1753 #else
1754 /* The following is all to get DBL_DIG, in order to pick a nice
1755    default value for printing floating point numbers in Gconvert
1756    (see config.h). (It also has other uses, such as figuring out if
1757    a given precision of printing can be done with a double instead of
1758    a long double - Allen).
1759 */
1760 #ifdef I_LIMITS
1761 #include <limits.h>
1762 #endif
1763 #ifdef I_FLOAT
1764 #include <float.h>
1765 #endif
1766 #ifndef HAS_DBL_DIG
1767 #define DBL_DIG 15   /* A guess that works lots of places */
1768 #endif
1769 #endif
1770
1771 #ifdef OVR_LDBL_DIG
1772 /* Use an overridden LDBL_DIG */
1773 # ifdef LDBL_DIG
1774 #  undef LDBL_DIG
1775 # endif
1776 # define LDBL_DIG OVR_LDBL_DIG
1777 #else
1778 /* The following is all to get LDBL_DIG, in order to pick a nice
1779    default value for printing floating point numbers in Gconvert.
1780    (see config.h)
1781 */
1782 # ifdef I_LIMITS
1783 #   include <limits.h>
1784 # endif
1785 # ifdef I_FLOAT
1786 #  include <float.h>
1787 # endif
1788 # ifndef HAS_LDBL_DIG
1789 #  if LONG_DOUBLESIZE == 10
1790 #   define LDBL_DIG 18 /* assume IEEE */
1791 #  else
1792 #   if LONG_DOUBLESIZE == 12
1793 #    define LDBL_DIG 18 /* gcc? */
1794 #   else
1795 #    if LONG_DOUBLESIZE == 16
1796 #     define LDBL_DIG 33 /* assume IEEE */
1797 #    else
1798 #     if LONG_DOUBLESIZE == DOUBLESIZE
1799 #      define LDBL_DIG DBL_DIG /* bummer */
1800 #     endif
1801 #    endif
1802 #   endif
1803 #  endif
1804 # endif
1805 #endif
1806
1807 /*
1808  * This is for making sure we have a good DBL_MAX value, if possible,
1809  * either for usage as NV_MAX or for usage in figuring out if we can
1810  * fit a given long double into a double, if bug-fixing makes it
1811  * necessary to do so. - Allen <allens@cpan.org>
1812  */
1813
1814 #ifdef I_LIMITS
1815 #  include <limits.h>
1816 #endif
1817
1818 #ifdef I_VALUES
1819 #  if !(defined(DBL_MIN) && defined(DBL_MAX) && defined(I_LIMITS))
1820 #    include <values.h>
1821 #    if defined(MAXDOUBLE) && !defined(DBL_MAX)
1822 #      define DBL_MAX MAXDOUBLE
1823 #    endif
1824 #    if defined(MINDOUBLE) && !defined(DBL_MIN)
1825 #      define DBL_MIN MINDOUBLE
1826 #    endif
1827 #  endif
1828 #endif /* defined(I_VALUES) */
1829
1830 typedef NVTYPE NV;
1831
1832 #ifdef I_IEEEFP
1833 #   include <ieeefp.h>
1834 #endif
1835
1836 #ifdef USE_LONG_DOUBLE
1837 #   ifdef I_SUNMATH
1838 #       include <sunmath.h>
1839 #   endif
1840 #   define NV_DIG LDBL_DIG
1841 #   ifdef LDBL_MANT_DIG
1842 #       define NV_MANT_DIG LDBL_MANT_DIG
1843 #   endif
1844 #   ifdef LDBL_MIN
1845 #       define NV_MIN LDBL_MIN
1846 #   endif
1847 #   ifdef LDBL_MAX
1848 #       define NV_MAX LDBL_MAX
1849 #   endif
1850 #   ifdef LDBL_MIN_10_EXP
1851 #       define NV_MIN_10_EXP LDBL_MIN_10_EXP
1852 #   endif
1853 #   ifdef LDBL_MAX_10_EXP
1854 #       define NV_MAX_10_EXP LDBL_MAX_10_EXP
1855 #   endif
1856 #   ifdef LDBL_EPSILON
1857 #       define NV_EPSILON LDBL_EPSILON
1858 #   endif
1859 #   ifdef LDBL_MAX
1860 #       define NV_MAX LDBL_MAX
1861 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
1862 #   else
1863 #       ifdef HUGE_VALL
1864 #           define NV_MAX HUGE_VALL
1865 #       else
1866 #           ifdef HUGE_VAL
1867 #               define NV_MAX ((NV)HUGE_VAL)
1868 #           endif
1869 #       endif
1870 #   endif
1871 #   ifdef HAS_SQRTL
1872 #       define Perl_cos cosl
1873 #       define Perl_sin sinl
1874 #       define Perl_sqrt sqrtl
1875 #       define Perl_exp expl
1876 #       define Perl_log logl
1877 #       define Perl_atan2 atan2l
1878 #       define Perl_pow powl
1879 #       define Perl_floor floorl
1880 #       define Perl_ceil ceill
1881 #       define Perl_fmod fmodl
1882 #   endif
1883 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
1884 #   ifdef HAS_MODFL
1885 #       define Perl_modf(x,y) modfl(x,y)
1886 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
1887    prototype in <math.h> */
1888 #       ifndef HAS_MODFL_PROTO
1889 EXTERN_C long double modfl(long double, long double *);
1890 #       endif
1891 #   else
1892 #       if defined(HAS_AINTL) && defined(HAS_COPYSIGNL)
1893         extern long double Perl_my_modfl(long double x, long double *ip);
1894 #           define Perl_modf(x,y) Perl_my_modfl(x,y)
1895 #       endif
1896 #   endif
1897 #   ifdef HAS_FREXPL
1898 #       define Perl_frexp(x,y) frexpl(x,y)
1899 #   else
1900 #       if defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
1901         extern long double Perl_my_frexpl(long double x, int *e);
1902 #           define Perl_frexp(x,y) Perl_my_frexpl(x,y)
1903 #       endif
1904 #   endif
1905 #   ifndef Perl_isnan
1906 #       ifdef HAS_ISNANL
1907 #           define Perl_isnan(x) isnanl(x)
1908 #       endif
1909 #   endif
1910 #   ifndef Perl_isinf
1911 #       ifdef HAS_FINITEL
1912 #           define Perl_isinf(x) !(finitel(x)||Perl_isnan(x))
1913 #       endif
1914 #   endif
1915 #else
1916 #   define NV_DIG DBL_DIG
1917 #   ifdef DBL_MANT_DIG
1918 #       define NV_MANT_DIG DBL_MANT_DIG
1919 #   endif
1920 #   ifdef DBL_MIN
1921 #       define NV_MIN DBL_MIN
1922 #   endif
1923 #   ifdef DBL_MAX
1924 #       define NV_MAX DBL_MAX
1925 #   endif
1926 #   ifdef DBL_MIN_10_EXP
1927 #       define NV_MIN_10_EXP DBL_MIN_10_EXP
1928 #   endif
1929 #   ifdef DBL_MAX_10_EXP
1930 #       define NV_MAX_10_EXP DBL_MAX_10_EXP
1931 #   endif
1932 #   ifdef DBL_EPSILON
1933 #       define NV_EPSILON DBL_EPSILON
1934 #   endif
1935 #   ifdef DBL_MAX               /* XXX Does DBL_MAX imply having DBL_MIN? */
1936 #       define NV_MAX DBL_MAX
1937 #       define NV_MIN DBL_MIN
1938 #   else
1939 #       ifdef HUGE_VAL
1940 #           define NV_MAX HUGE_VAL
1941 #       endif
1942 #   endif
1943 #   define Perl_cos cos
1944 #   define Perl_sin sin
1945 #   define Perl_sqrt sqrt
1946 #   define Perl_exp exp
1947 #   define Perl_log log
1948 #   define Perl_atan2 atan2
1949 #   define Perl_pow pow
1950 #   define Perl_floor floor
1951 #   define Perl_ceil ceil
1952 #   define Perl_fmod fmod
1953 #   define Perl_modf(x,y) modf(x,y)
1954 #   define Perl_frexp(x,y) frexp(x,y)
1955 #endif
1956
1957 /* rumor has it that Win32 has _fpclass() */
1958
1959 /* SGI has fpclassl... but not with the same result values,
1960  * and it's via a typedef (not via #define), so will need to redo Configure
1961  * to use. Not worth the trouble, IMO, at least until the below is used
1962  * more places. Also has fp_class_l, BTW, via fp_class.h. Feel free to check
1963  * with me for the SGI manpages, SGI testing, etcetera, if you want to
1964  * try getting this to work with IRIX. - Allen <allens@cpan.org> */
1965
1966 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
1967 #    ifdef I_IEEFP
1968 #        include <ieeefp.h>
1969 #    endif
1970 #    ifdef I_FP
1971 #        include <fp.h>
1972 #    endif
1973 #    if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
1974 #        define Perl_fp_class()         fpclassl(x)
1975 #    else
1976 #        define Perl_fp_class()         fpclass(x)
1977 #    endif
1978 #    define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_CLASS_SNAN)
1979 #    define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_CLASS_QNAN)
1980 #    define Perl_fp_class_nan(x)        (Perl_fp_class(x)==FP_CLASS_SNAN||Perl_fp_class(x)==FP_CLASS_QNAN)
1981 #    define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_CLASS_NINF)
1982 #    define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_CLASS_PINF)
1983 #    define Perl_fp_class_inf(x)        (Perl_fp_class(x)==FP_CLASS_NINF||Perl_fp_class(x)==FP_CLASS_PINF)
1984 #    define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_CLASS_NNORM)
1985 #    define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_CLASS_PNORM)
1986 #    define Perl_fp_class_norm(x)       (Perl_fp_class(x)==FP_CLASS_NNORM||Perl_fp_class(x)==FP_CLASS_PNORM)
1987 #    define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_CLASS_NDENORM)
1988 #    define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_CLASS_PDENORM)
1989 #    define Perl_fp_class_denorm(x)     (Perl_fp_class(x)==FP_CLASS_NDENORM||Perl_fp_class(x)==FP_CLASS_PDENORM)
1990 #    define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_CLASS_NZERO)
1991 #    define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_CLASS_PZERO)
1992 #    define Perl_fp_class_zero(x)       (Perl_fp_class(x)==FP_CLASS_NZERO||Perl_fp_class(x)==FP_CLASS_PZERO)
1993 #endif
1994
1995 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASS)
1996 #    include <math.h>
1997 #    if !defined(FP_SNAN) && defined(I_FP_CLASS)
1998 #        include <fp_class.h>
1999 #    endif
2000 #    define Perl_fp_class(x)            fp_class(x)
2001 #    define Perl_fp_class_snan(x)       (fp_class(x)==FP_SNAN)
2002 #    define Perl_fp_class_qnan(x)       (fp_class(x)==FP_QNAN)
2003 #    define Perl_fp_class_nan(x)        (fp_class(x)==FP_SNAN||fp_class(x)==FP_QNAN)
2004 #    define Perl_fp_class_ninf(x)       (fp_class(x)==FP_NEG_INF)
2005 #    define Perl_fp_class_pinf(x)       (fp_class(x)==FP_POS_INF)
2006 #    define Perl_fp_class_inf(x)        (fp_class(x)==FP_NEG_INF||fp_class(x)==FP_POS_INF)
2007 #    define Perl_fp_class_nnorm(x)      (fp_class(x)==FP_NEG_NORM)
2008 #    define Perl_fp_class_pnorm(x)      (fp_class(x)==FP_POS_NORM)
2009 #    define Perl_fp_class_norm(x)       (fp_class(x)==FP_NEG_NORM||fp_class(x)==FP_POS_NORM)
2010 #    define Perl_fp_class_ndenorm(x)    (fp_class(x)==FP_NEG_DENORM)
2011 #    define Perl_fp_class_pdenorm(x)    (fp_class(x)==FP_POS_DENORM)
2012 #    define Perl_fp_class_denorm(x)     (fp_class(x)==FP_NEG_DENORM||fp_class(x)==FP_POS_DENORM)
2013 #    define Perl_fp_class_nzero(x)      (fp_class(x)==FP_NEG_ZERO)
2014 #    define Perl_fp_class_pzero(x)      (fp_class(x)==FP_POS_ZERO)
2015 #    define Perl_fp_class_zero(x)       (fp_class(x)==FP_NEG_ZERO||fp_class(x)==FP_POS_ZERO)
2016 #endif
2017
2018 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2019 #    include <math.h>
2020 #    define Perl_fp_class(x)            fpclassify(x)
2021 #    define Perl_fp_class_nan(x)        (fp_classify(x)==FP_SNAN||fp_classify(x)==FP_QNAN)
2022 #    define Perl_fp_class_inf(x)        (fp_classify(x)==FP_INFINITE)
2023 #    define Perl_fp_class_norm(x)       (fp_classify(x)==FP_NORMAL)
2024 #    define Perl_fp_class_denorm(x)     (fp_classify(x)==FP_SUBNORMAL)
2025 #    define Perl_fp_class_zero(x)       (fp_classify(x)==FP_ZERO)
2026 #endif
2027
2028 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2029 #    include <math.h>
2030 #    ifndef _cplusplus
2031 #        define Perl_fp_class(x)        class(x)
2032 #    else
2033 #        define Perl_fp_class(x)        _class(x)
2034 #    endif
2035 #    define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_NANS)
2036 #    define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_NANQ)
2037 #    define Perl_fp_class_nan(x)        (Perl_fp_class(x)==FP_SNAN||Perl_fp_class(x)==FP_QNAN)
2038 #    define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_MINUS_INF)
2039 #    define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_PLUS_INF)
2040 #    define Perl_fp_class_inf(x)        (Perl_fp_class(x)==FP_MINUS_INF||Perl_fp_class(x)==FP_PLUS_INF)
2041 #    define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_MINUS_NORM)
2042 #    define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_PLUS_NORM)
2043 #    define Perl_fp_class_norm(x)       (Perl_fp_class(x)==FP_MINUS_NORM||Perl_fp_class(x)==FP_PLUS_NORM)
2044 #    define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_MINUS_DENORM)
2045 #    define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_PLUS_DENORM)
2046 #    define Perl_fp_class_denorm(x)     (Perl_fp_class(x)==FP_MINUS_DENORM||Perl_fp_class(x)==FP_PLUS_DENORM)
2047 #    define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_MINUS_ZERO)
2048 #    define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_PLUS_ZERO)
2049 #    define Perl_fp_class_zero(x)       (Perl_fp_class(x)==FP_MINUS_ZERO||Perl_fp_class(x)==FP_PLUS_ZERO)
2050 #endif
2051
2052 /* rumor has it that Win32 has _isnan() */
2053
2054 #ifndef Perl_isnan
2055 #   ifdef HAS_ISNAN
2056 #       define Perl_isnan(x) isnan((NV)x)
2057 #   else
2058 #       ifdef Perl_fp_class_nan
2059 #           define Perl_isnan(x) Perl_fp_class_nan(x)
2060 #       else
2061 #           ifdef HAS_UNORDERED
2062 #               define Perl_isnan(x) unordered((x), 0.0)
2063 #           else
2064 #               define Perl_isnan(x) ((x)!=(x))
2065 #           endif
2066 #       endif
2067 #   endif
2068 #endif
2069
2070 #ifdef UNDER_CE
2071 int isnan(double d);
2072 #endif
2073
2074 #ifndef Perl_isinf
2075 #   ifdef HAS_ISINF
2076 #       define Perl_isinf(x) isinf((NV)x)
2077 #   else
2078 #       ifdef Perl_fp_class_inf
2079 #           define Perl_isinf(x) Perl_fp_class_inf(x)
2080 #       else
2081 #           define Perl_isinf(x) ((x)==NV_INF)
2082 #       endif
2083 #   endif
2084 #endif
2085
2086 #ifndef Perl_isfinite
2087 #   ifdef HAS_FINITE
2088 #       define Perl_isfinite(x) finite((NV)x)
2089 #   else
2090 #       ifdef HAS_ISFINITE
2091 #           define Perl_isfinite(x) isfinite(x)
2092 #       else
2093 #           ifdef Perl_fp_class_finite
2094 #               define Perl_isfinite(x) Perl_fp_class_finite(x)
2095 #           else
2096 #               define Perl_isfinite(x) !(Perl_is_inf(x)||Perl_is_nan(x))
2097 #           endif
2098 #       endif
2099 #   endif
2100 #endif
2101
2102 /* The default is to use Perl's own atof() implementation (in numeric.c).
2103  * Usually that is the one to use but for some platforms (e.g. UNICOS)
2104  * it is however best to use the native implementation of atof.
2105  * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2106  * Some good tests to try out with either setting are t/base/num.t,
2107  * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2108  * you may need to be using a different function than atof! */
2109
2110 #ifndef USE_PERL_ATOF
2111 #   ifndef _UNICOS
2112 #       define USE_PERL_ATOF
2113 #   endif
2114 #else
2115 #   if USE_PERL_ATOF == 0
2116 #       undef USE_PERL_ATOF
2117 #   endif
2118 #endif
2119
2120 #ifdef USE_PERL_ATOF
2121 #   define Perl_atof(s) Perl_my_atof(s)
2122 #   define Perl_atof2(s, n) Perl_my_atof2(aTHX_ (s), &(n))
2123 #else
2124 #   define Perl_atof(s) (NV)atof(s)
2125 #   define Perl_atof2(s, n) ((n) = atof(s))
2126 #endif
2127
2128 /* Previously these definitions used hardcoded figures.
2129  * It is hoped these formula are more portable, although
2130  * no data one way or another is presently known to me.
2131  * The "PERL_" names are used because these calculated constants
2132  * do not meet the ANSI requirements for LONG_MAX, etc., which
2133  * need to be constants acceptable to #if - kja
2134  *    define PERL_LONG_MAX        2147483647L
2135  *    define PERL_LONG_MIN        (-LONG_MAX - 1)
2136  *    define PERL ULONG_MAX       4294967295L
2137  */
2138
2139 #ifdef I_LIMITS  /* Needed for cast_xxx() functions below. */
2140 #  include <limits.h>
2141 #endif
2142 /* Included values.h above if necessary; still including limits.h down here,
2143  * despite doing above, because math.h might have overridden... XXX - Allen */
2144
2145 /*
2146  * Try to figure out max and min values for the integral types.  THE CORRECT
2147  * SOLUTION TO THIS MESS: ADAPT enquire.c FROM GCC INTO CONFIGURE.  The
2148  * following hacks are used if neither limits.h or values.h provide them:
2149  * U<TYPE>_MAX: for types >= int: ~(unsigned TYPE)0
2150  *              for types <  int:  (unsigned TYPE)~(unsigned)0
2151  *      The argument to ~ must be unsigned so that later signed->unsigned
2152  *      conversion can't modify the value's bit pattern (e.g. -0 -> +0),
2153  *      and it must not be smaller than int because ~ does integral promotion.
2154  * <type>_MAX: (<type>) (U<type>_MAX >> 1)
2155  * <type>_MIN: -<type>_MAX - <is_twos_complement_architecture: (3 & -1) == 3>.
2156  *      The latter is a hack which happens to work on some machines but
2157  *      does *not* catch any random system, or things like integer types
2158  *      with NaN if that is possible.
2159  *
2160  * All of the types are explicitly cast to prevent accidental loss of
2161  * numeric range, and in the hope that they will be less likely to confuse
2162  * over-eager optimizers.
2163  *
2164  */
2165
2166 #define PERL_UCHAR_MIN ((unsigned char)0)
2167
2168 #ifdef UCHAR_MAX
2169 #  define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2170 #else
2171 #  ifdef MAXUCHAR
2172 #    define PERL_UCHAR_MAX ((unsigned char)MAXUCHAR)
2173 #  else
2174 #    define PERL_UCHAR_MAX       ((unsigned char)~(unsigned)0)
2175 #  endif
2176 #endif
2177
2178 /*
2179  * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2180  * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2181  * depending on local options. Until Configure detects this (or at least
2182  * detects whether the "signed" keyword is available) the CHAR ranges
2183  * will not be included. UCHAR functions normally.
2184  *                                                           - kja
2185  */
2186
2187 #define PERL_USHORT_MIN ((unsigned short)0)
2188
2189 #ifdef USHORT_MAX
2190 #  define PERL_USHORT_MAX ((unsigned short)USHORT_MAX)
2191 #else
2192 #  ifdef MAXUSHORT
2193 #    define PERL_USHORT_MAX ((unsigned short)MAXUSHORT)
2194 #  else
2195 #    ifdef USHRT_MAX
2196 #      define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2197 #    else
2198 #      define PERL_USHORT_MAX       ((unsigned short)~(unsigned)0)
2199 #    endif
2200 #  endif
2201 #endif
2202
2203 #ifdef SHORT_MAX
2204 #  define PERL_SHORT_MAX ((short)SHORT_MAX)
2205 #else
2206 #  ifdef MAXSHORT    /* Often used in <values.h> */
2207 #    define PERL_SHORT_MAX ((short)MAXSHORT)
2208 #  else
2209 #    ifdef SHRT_MAX
2210 #      define PERL_SHORT_MAX ((short)SHRT_MAX)
2211 #    else
2212 #      define PERL_SHORT_MAX      ((short) (PERL_USHORT_MAX >> 1))
2213 #    endif
2214 #  endif
2215 #endif
2216
2217 #ifdef SHORT_MIN
2218 #  define PERL_SHORT_MIN ((short)SHORT_MIN)
2219 #else
2220 #  ifdef MINSHORT
2221 #    define PERL_SHORT_MIN ((short)MINSHORT)
2222 #  else
2223 #    ifdef SHRT_MIN
2224 #      define PERL_SHORT_MIN ((short)SHRT_MIN)
2225 #    else
2226 #      define PERL_SHORT_MIN        (-PERL_SHORT_MAX - ((3 & -1) == 3))
2227 #    endif
2228 #  endif
2229 #endif
2230
2231 #ifdef UINT_MAX
2232 #  define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2233 #else
2234 #  ifdef MAXUINT
2235 #    define PERL_UINT_MAX ((unsigned int)MAXUINT)
2236 #  else
2237 #    define PERL_UINT_MAX       (~(unsigned int)0)
2238 #  endif
2239 #endif
2240
2241 #define PERL_UINT_MIN ((unsigned int)0)
2242
2243 #ifdef INT_MAX
2244 #  define PERL_INT_MAX ((int)INT_MAX)
2245 #else
2246 #  ifdef MAXINT    /* Often used in <values.h> */
2247 #    define PERL_INT_MAX ((int)MAXINT)
2248 #  else
2249 #    define PERL_INT_MAX        ((int)(PERL_UINT_MAX >> 1))
2250 #  endif
2251 #endif
2252
2253 #ifdef INT_MIN
2254 #  define PERL_INT_MIN ((int)INT_MIN)
2255 #else
2256 #  ifdef MININT
2257 #    define PERL_INT_MIN ((int)MININT)
2258 #  else
2259 #    define PERL_INT_MIN        (-PERL_INT_MAX - ((3 & -1) == 3))
2260 #  endif
2261 #endif
2262
2263 #ifdef ULONG_MAX
2264 #  define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2265 #else
2266 #  ifdef MAXULONG
2267 #    define PERL_ULONG_MAX ((unsigned long)MAXULONG)
2268 #  else
2269 #    define PERL_ULONG_MAX       (~(unsigned long)0)
2270 #  endif
2271 #endif
2272
2273 #define PERL_ULONG_MIN ((unsigned long)0L)
2274
2275 #ifdef LONG_MAX
2276 #  define PERL_LONG_MAX ((long)LONG_MAX)
2277 #else
2278 #  ifdef MAXLONG    /* Often used in <values.h> */
2279 #    define PERL_LONG_MAX ((long)MAXLONG)
2280 #  else
2281 #    define PERL_LONG_MAX        ((long) (PERL_ULONG_MAX >> 1))
2282 #  endif
2283 #endif
2284
2285 #ifdef LONG_MIN
2286 #  define PERL_LONG_MIN ((long)LONG_MIN)
2287 #else
2288 #  ifdef MINLONG
2289 #    define PERL_LONG_MIN ((long)MINLONG)
2290 #  else
2291 #    define PERL_LONG_MIN        (-PERL_LONG_MAX - ((3 & -1) == 3))
2292 #  endif
2293 #endif
2294
2295 #ifdef UV_IS_QUAD
2296
2297 #    define PERL_UQUAD_MAX      (~(UV)0)
2298 #    define PERL_UQUAD_MIN      ((UV)0)
2299 #    define PERL_QUAD_MAX       ((IV) (PERL_UQUAD_MAX >> 1))
2300 #    define PERL_QUAD_MIN       (-PERL_QUAD_MAX - ((3 & -1) == 3))
2301
2302 #endif
2303
2304 typedef MEM_SIZE STRLEN;
2305
2306 typedef struct op OP;
2307 typedef struct cop COP;
2308 typedef struct unop UNOP;
2309 typedef struct binop BINOP;
2310 typedef struct listop LISTOP;
2311 typedef struct logop LOGOP;
2312 typedef struct pmop PMOP;
2313 typedef struct svop SVOP;
2314 typedef struct padop PADOP;
2315 typedef struct pvop PVOP;
2316 typedef struct loop LOOP;
2317
2318 #ifdef PERL_CORE
2319 typedef struct opslab OPSLAB;
2320 typedef struct opslot OPSLOT;
2321 #endif
2322
2323 typedef struct block_hooks BHK;
2324 typedef struct custom_op XOP;
2325
2326 typedef struct interpreter PerlInterpreter;
2327
2328 /* SGI's <sys/sema.h> has struct sv */
2329 #if defined(__sgi)
2330 #   define STRUCT_SV perl_sv
2331 #else
2332 #   define STRUCT_SV sv
2333 #endif
2334 typedef struct STRUCT_SV SV;
2335 typedef struct av AV;
2336 typedef struct hv HV;
2337 typedef struct cv CV;
2338 typedef struct p5rx REGEXP;
2339 typedef struct gp GP;
2340 typedef struct gv GV;
2341 typedef struct io IO;
2342 typedef struct context PERL_CONTEXT;
2343 typedef struct block BLOCK;
2344
2345 typedef struct magic MAGIC;
2346 typedef struct xpv XPV;
2347 typedef struct xpviv XPVIV;
2348 typedef struct xpvuv XPVUV;
2349 typedef struct xpvnv XPVNV;
2350 typedef struct xpvmg XPVMG;
2351 typedef struct xpvlv XPVLV;
2352 typedef struct xpvinvlist XINVLIST;
2353 typedef struct xpvav XPVAV;
2354 typedef struct xpvhv XPVHV;
2355 typedef struct xpvgv XPVGV;
2356 typedef struct xpvcv XPVCV;
2357 typedef struct xpvbm XPVBM;
2358 typedef struct xpvfm XPVFM;
2359 typedef struct xpvio XPVIO;
2360 typedef struct mgvtbl MGVTBL;
2361 typedef union any ANY;
2362 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2363 typedef struct ptr_tbl PTR_TBL_t;
2364 typedef struct clone_params CLONE_PARAMS;
2365
2366 /* a pad or name pad is currently just an AV; but that might change,
2367  * so hide the type.  */
2368 typedef struct padlist PADLIST;
2369 typedef AV PAD;
2370 typedef AV PADNAMELIST;
2371 typedef SV PADNAME;
2372
2373 /* enable PERL_NEW_COPY_ON_WRITE by default */
2374 #if !defined(PERL_OLD_COPY_ON_WRITE) && !defined(PERL_NEW_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2375 #  define PERL_NEW_COPY_ON_WRITE
2376 #endif
2377
2378 #if defined(PERL_OLD_COPY_ON_WRITE) || defined(PERL_NEW_COPY_ON_WRITE)
2379 # if defined(PERL_OLD_COPY_ON_WRITE) && defined(PERL_NEW_COPY_ON_WRITE)
2380 #  error PERL_OLD_COPY_ON_WRITE and PERL_NEW_COPY_ON_WRITE are exclusive
2381 # else
2382 #  define PERL_ANY_COW
2383 # endif
2384 #else
2385 # define PERL_SAWAMPERSAND
2386 #endif
2387
2388 #include "handy.h"
2389
2390 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2391 #   if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2392 #       define USE_64_BIT_RAWIO /* implicit */
2393 #   endif
2394 #endif
2395
2396 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2397  * fseeko/ftello if possible.  Don't go #defining ftell to ftello yourself,
2398  * however, because operating systems like to do that themself. */
2399 #ifndef FSEEKSIZE
2400 #   ifdef HAS_FSEEKO
2401 #       define FSEEKSIZE LSEEKSIZE
2402 #   else
2403 #       define FSEEKSIZE LONGSIZE
2404 #   endif
2405 #endif
2406
2407 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2408 #   if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2409 #       define USE_64_BIT_STDIO /* implicit */
2410 #   endif
2411 #endif
2412
2413 #ifdef USE_64_BIT_RAWIO
2414 #   ifdef HAS_OFF64_T
2415 #       undef Off_t
2416 #       define Off_t off64_t
2417 #       undef LSEEKSIZE
2418 #       define LSEEKSIZE 8
2419 #   endif
2420 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2421  * will trigger defines like the ones below.  Some 64-bit environments,
2422  * however, do not.  Therefore we have to explicitly mix and match. */
2423 #   if defined(USE_OPEN64)
2424 #       define open open64
2425 #   endif
2426 #   if defined(USE_LSEEK64)
2427 #       define lseek lseek64
2428 #   else
2429 #       if defined(USE_LLSEEK)
2430 #           define lseek llseek
2431 #       endif
2432 #   endif
2433 #   if defined(USE_STAT64)
2434 #       define stat stat64
2435 #   endif
2436 #   if defined(USE_FSTAT64)
2437 #       define fstat fstat64
2438 #   endif
2439 #   if defined(USE_LSTAT64)
2440 #       define lstat lstat64
2441 #   endif
2442 #   if defined(USE_FLOCK64)
2443 #       define flock flock64
2444 #   endif
2445 #   if defined(USE_LOCKF64)
2446 #       define lockf lockf64
2447 #   endif
2448 #   if defined(USE_FCNTL64)
2449 #       define fcntl fcntl64
2450 #   endif
2451 #   if defined(USE_TRUNCATE64)
2452 #       define truncate truncate64
2453 #   endif
2454 #   if defined(USE_FTRUNCATE64)
2455 #       define ftruncate ftruncate64
2456 #   endif
2457 #endif
2458
2459 #ifdef USE_64_BIT_STDIO
2460 #   ifdef HAS_FPOS64_T
2461 #       undef Fpos_t
2462 #       define Fpos_t fpos64_t
2463 #   endif
2464 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2465  * will trigger defines like the ones below.  Some 64-bit environments,
2466  * however, do not. */
2467 #   if defined(USE_FOPEN64)
2468 #       define fopen fopen64
2469 #   endif
2470 #   if defined(USE_FSEEK64)
2471 #       define fseek fseek64 /* don't do fseeko here, see perlio.c */
2472 #   endif
2473 #   if defined(USE_FTELL64)
2474 #       define ftell ftell64 /* don't do ftello here, see perlio.c */
2475 #   endif
2476 #   if defined(USE_FSETPOS64)
2477 #       define fsetpos fsetpos64
2478 #   endif
2479 #   if defined(USE_FGETPOS64)
2480 #       define fgetpos fgetpos64
2481 #   endif
2482 #   if defined(USE_TMPFILE64)
2483 #       define tmpfile tmpfile64
2484 #   endif
2485 #   if defined(USE_FREOPEN64)
2486 #       define freopen freopen64
2487 #   endif
2488 #endif
2489
2490 #if defined(OS2)
2491 #  include "iperlsys.h"
2492 #endif
2493
2494 #ifdef DOSISH
2495 #   if defined(OS2)
2496 #       include "os2ish.h"
2497 #   else
2498 #       include "dosish.h"
2499 #   endif
2500 #elif defined(VMS)
2501 #   include "vmsish.h"
2502 #elif defined(PLAN9)
2503 #   include "./plan9/plan9ish.h"
2504 #elif defined(__VOS__)
2505 #   ifdef __GNUC__
2506 #     include "./vos/vosish.h"
2507 #   else
2508 #     include "vos/vosish.h"
2509 #   endif
2510 #elif defined(__SYMBIAN32__)
2511 #   include "symbian/symbianish.h"
2512 #elif defined(__HAIKU__)
2513 #   include "haiku/haikuish.h"
2514 #else
2515 #   include "unixish.h"
2516 #endif
2517
2518 /* NSIG logic from Configure --> */
2519 /* Strange style to avoid deeply-nested #if/#else/#endif */
2520 #ifndef NSIG
2521 #  ifdef _NSIG
2522 #    define NSIG (_NSIG)
2523 #  endif
2524 #endif
2525
2526 #ifndef NSIG
2527 #  ifdef SIGMAX
2528 #    define NSIG (SIGMAX+1)
2529 #  endif
2530 #endif
2531
2532 #ifndef NSIG
2533 #  ifdef SIG_MAX
2534 #    define NSIG (SIG_MAX+1)
2535 #  endif
2536 #endif
2537
2538 #ifndef NSIG
2539 #  ifdef _SIG_MAX
2540 #    define NSIG (_SIG_MAX+1)
2541 #  endif
2542 #endif
2543
2544 #ifndef NSIG
2545 #  ifdef MAXSIG
2546 #    define NSIG (MAXSIG+1)
2547 #  endif
2548 #endif
2549
2550 #ifndef NSIG
2551 #  ifdef MAX_SIG
2552 #    define NSIG (MAX_SIG+1)
2553 #  endif
2554 #endif
2555
2556 #ifndef NSIG
2557 #  ifdef SIGARRAYSIZE
2558 #    define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
2559 #  endif
2560 #endif
2561
2562 #ifndef NSIG
2563 #  ifdef _sys_nsig
2564 #    define NSIG (_sys_nsig) /* Solaris 2.5 */
2565 #  endif
2566 #endif
2567
2568 /* Default to some arbitrary number that's big enough to get most
2569    of the common signals.
2570 */
2571 #ifndef NSIG
2572 #    define NSIG 50
2573 #endif
2574 /* <-- NSIG logic from Configure */
2575
2576 #ifndef NO_ENVIRON_ARRAY
2577 #  define USE_ENVIRON_ARRAY
2578 #endif
2579
2580 /*
2581  * initialise to avoid floating-point exceptions from overflow, etc
2582  */
2583 #ifndef PERL_FPU_INIT
2584 #  ifdef HAS_FPSETMASK
2585 #    if HAS_FLOATINGPOINT_H
2586 #      include <floatingpoint.h>
2587 #    endif
2588 /* Some operating systems have this as a macro, which in turn expands to a comma
2589    expression, and the last sub-expression is something that gets calculated,
2590    and then they have the gall to warn that a value computed is not used. Hence
2591    cast to void.  */
2592 #    define PERL_FPU_INIT (void)fpsetmask(0)
2593 #  else
2594 #    if defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2595 #      define PERL_FPU_INIT       PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2596 #      define PERL_FPU_PRE_EXEC   { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2597 #      define PERL_FPU_POST_EXEC    rsignal_restore(SIGFPE, &xfpe); }
2598 #    else
2599 #      define PERL_FPU_INIT
2600
2601 #    endif
2602 #  endif
2603 #endif
2604 #ifndef PERL_FPU_PRE_EXEC
2605 #  define PERL_FPU_PRE_EXEC   {
2606 #  define PERL_FPU_POST_EXEC  }
2607 #endif
2608
2609 #ifndef PERL_SYS_INIT3_BODY
2610 #  define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
2611 #endif
2612
2613 /*
2614 =head1 Miscellaneous Functions
2615
2616 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
2617 Provides system-specific tune up of the C runtime environment necessary to
2618 run Perl interpreters.  This should be called only once, before creating
2619 any Perl interpreters.
2620
2621 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
2622 Provides system-specific tune up of the C runtime environment necessary to
2623 run Perl interpreters.  This should be called only once, before creating
2624 any Perl interpreters.
2625
2626 =for apidoc Am|void|PERL_SYS_TERM|
2627 Provides system-specific clean up of the C runtime environment after
2628 running Perl interpreters.  This should be called only once, after
2629 freeing any remaining Perl interpreters.
2630
2631 =cut
2632  */
2633
2634 #define PERL_SYS_INIT(argc, argv)       Perl_sys_init(argc, argv)
2635 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
2636 #define PERL_SYS_TERM()                 Perl_sys_term()
2637
2638 #ifndef PERL_WRITE_MSG_TO_CONSOLE
2639 #  define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
2640 #endif
2641
2642 #ifndef MAXPATHLEN
2643 #  ifdef PATH_MAX
2644 #    ifdef _POSIX_PATH_MAX
2645 #       if PATH_MAX > _POSIX_PATH_MAX
2646 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
2647  * included the null byte or not.  Later amendments of POSIX,
2648  * XPG4, the Austin Group, and the Single UNIX Specification
2649  * all explicitly include the null byte in the PATH_MAX.
2650  * Ditto for _POSIX_PATH_MAX. */
2651 #         define MAXPATHLEN PATH_MAX
2652 #       else
2653 #         define MAXPATHLEN _POSIX_PATH_MAX
2654 #       endif
2655 #    else
2656 #      define MAXPATHLEN (PATH_MAX+1)
2657 #    endif
2658 #  else
2659 #    define MAXPATHLEN 1024     /* Err on the large side. */
2660 #  endif
2661 #endif
2662
2663 /* In case Configure was not used (we are using a "canned config"
2664  * such as Win32, or a cross-compilation setup, for example) try going
2665  * by the gcc major and minor versions.  One useful URL is
2666  * http://www.ohse.de/uwe/articles/gcc-attributes.html,
2667  * but contrary to this information warn_unused_result seems
2668  * not to be in gcc 3.3.5, at least. --jhi
2669  * Also, when building extensions with an installed perl, this allows
2670  * the user to upgrade gcc and get the right attributes, rather than
2671  * relying on the list generated at Configure time.  --AD
2672  * Set these up now otherwise we get confused when some of the <*thread.h>
2673  * includes below indirectly pull in <perlio.h> (which needs to know if we
2674  * have HASATTRIBUTE_FORMAT).
2675  */
2676
2677 #ifndef PERL_MICRO
2678 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
2679 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
2680 #    define HASATTRIBUTE_DEPRECATED
2681 #  endif
2682 #  if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
2683 #    define HASATTRIBUTE_FORMAT
2684 #    if defined __MINGW32__
2685 #      define PRINTF_FORMAT_NULL_OK
2686 #    endif
2687 #  endif
2688 #  if __GNUC__ >= 3 /* 3.0 -> */
2689 #    define HASATTRIBUTE_MALLOC
2690 #  endif
2691 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
2692 #    define HASATTRIBUTE_NONNULL
2693 #  endif
2694 #  if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
2695 #    define HASATTRIBUTE_NORETURN
2696 #  endif
2697 #  if __GNUC__ >= 3 /* gcc 3.0 -> */
2698 #    define HASATTRIBUTE_PURE
2699 #  endif
2700 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2701 #    define HASATTRIBUTE_UNUSED
2702 #  endif
2703 #  if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
2704 #    define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
2705 #  endif
2706 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2707 #    define HASATTRIBUTE_WARN_UNUSED_RESULT
2708 #  endif
2709 #endif
2710 #endif /* #ifndef PERL_MICRO */
2711
2712 /* USE_5005THREADS needs to be after unixish.h as <pthread.h> includes
2713  * <sys/signal.h> which defines NSIG - which will stop inclusion of <signal.h>
2714  * this results in many functions being undeclared which bothers C++
2715  * May make sense to have threads after "*ish.h" anyway
2716  */
2717
2718 #if defined(USE_ITHREADS)
2719 #  ifdef NETWARE
2720 #   include <nw5thread.h>
2721 #  else
2722 #    ifdef WIN32
2723 #      include <win32thread.h>
2724 #    else
2725 #      ifdef OS2
2726 #        include "os2thread.h"
2727 #      else
2728 #        ifdef I_MACH_CTHREADS
2729 #          include <mach/cthreads.h>
2730 typedef cthread_t       perl_os_thread;
2731 typedef mutex_t         perl_mutex;
2732 typedef condition_t     perl_cond;
2733 typedef void *          perl_key;
2734 #        else /* Posix threads */
2735 #          ifdef I_PTHREAD
2736 #            include <pthread.h>
2737 #          endif
2738 typedef pthread_t       perl_os_thread;
2739 typedef pthread_mutex_t perl_mutex;
2740 typedef pthread_cond_t  perl_cond;
2741 typedef pthread_key_t   perl_key;
2742 #        endif /* I_MACH_CTHREADS */
2743 #      endif /* OS2 */
2744 #    endif /* WIN32 */
2745 #  endif /* NETWARE */
2746 #endif /* USE_ITHREADS */
2747
2748 #if defined(WIN32)
2749 #  include "win32.h"
2750 #endif
2751
2752 #ifdef NETWARE
2753 #  include "netware.h"
2754 #endif
2755
2756 #define STATUS_UNIX     PL_statusvalue
2757 #ifdef VMS
2758 #   define STATUS_NATIVE        PL_statusvalue_vms
2759 /*
2760  * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
2761  * its contents can not be trusted.  Unfortunately, Perl seems to check
2762  * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
2763  * be updated also.
2764  */
2765 #  include <stsdef.h>
2766 #  include <ssdef.h>
2767 /* Presume this because if VMS changes it, it will require a new
2768  * set of APIs for waiting on children for binary compatibility.
2769  */
2770 #  define child_offset_bits (8)
2771 #  ifndef C_FAC_POSIX
2772 #  define C_FAC_POSIX 0x35A000
2773 #  endif
2774
2775 /*  STATUS_EXIT - validates and returns a NATIVE exit status code for the
2776  * platform from the existing UNIX or Native status values.
2777  */
2778
2779 #   define STATUS_EXIT \
2780         (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
2781            (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
2782
2783
2784 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
2785  * exit code and shifts the UNIX value over the correct number of bits to
2786  * be a child status.  Usually the number of bits is 8, but that could be
2787  * platform dependent.  The NATIVE status code is presumed to have either
2788  * from a child process.
2789  */
2790
2791 /* This is complicated.  The child processes return a true native VMS
2792    status which must be saved.  But there is an assumption in Perl that
2793    the UNIX child status has some relationship to errno values, so
2794    Perl tries to translate it to text in some of the tests.
2795    In order to get the string translation correct, for the error, errno
2796    must be EVMSERR, but that generates a different text message
2797    than what the test programs are expecting.  So an errno value must
2798    be derived from the native status value when an error occurs.
2799    That will hide the true native status message.  With this version of
2800    perl, the true native child status can always be retrieved so that
2801    is not a problem.  But in this case, Pl_statusvalue and errno may
2802    have different values in them.
2803  */
2804
2805 #   define STATUS_NATIVE_CHILD_SET(n) \
2806         STMT_START {                                                    \
2807             I32 evalue = (I32)n;                                        \
2808             if (evalue == EVMSERR) {                                    \
2809               PL_statusvalue_vms = vaxc$errno;                          \
2810               PL_statusvalue = evalue;                                  \
2811             } else {                                                    \
2812               PL_statusvalue_vms = evalue;                              \
2813               if (evalue == -1) {                                       \
2814                 PL_statusvalue = -1;                                    \
2815                 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
2816               } else                                                    \
2817                 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1);    \
2818               set_vaxc_errno(evalue);                                   \
2819               if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX)    \
2820                   set_errno(EVMSERR);                                   \
2821               else set_errno(Perl_vms_status_to_unix(evalue, 0));       \
2822               PL_statusvalue = PL_statusvalue << child_offset_bits;     \
2823             }                                                           \
2824         } STMT_END
2825
2826 #   ifdef VMSISH_STATUS
2827 #       define STATUS_CURRENT   (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
2828 #   else
2829 #       define STATUS_CURRENT   STATUS_UNIX
2830 #   endif
2831
2832   /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
2833    * the NATIVE status to an equivalent value.  Can not be used to translate
2834    * exit code values as exit code values are not guaranteed to have any
2835    * relationship at all to errno values.
2836    * This is used when Perl is forcing errno to have a specific value.
2837    */
2838 #   define STATUS_UNIX_SET(n)                           \
2839         STMT_START {                                    \
2840             I32 evalue = (I32)n;                        \
2841             PL_statusvalue = evalue;                    \
2842             if (PL_statusvalue != -1) {                 \
2843                 if (PL_statusvalue != EVMSERR) {        \
2844                   PL_statusvalue &= 0xFFFF;             \
2845                   if (MY_POSIX_EXIT)                    \
2846                     PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
2847                   else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
2848                 }                                       \
2849                 else {                                  \
2850                   PL_statusvalue_vms = vaxc$errno;      \
2851                 }                                       \
2852             }                                           \
2853             else PL_statusvalue_vms = SS$_ABORT;        \
2854             set_vaxc_errno(PL_statusvalue_vms);         \
2855         } STMT_END
2856
2857   /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
2858    * the NATIVE error status based on it.
2859    *
2860    * When in the default mode to comply with the Perl VMS documentation,
2861    * 0 is a success and any other code sets the NATIVE status to a failure
2862    * code of SS$_ABORT.
2863    *
2864    * In the new POSIX EXIT mode, native status will be set so that the
2865    * actual exit code will can be retrieved by the calling program or
2866    * shell.
2867    *
2868    * If the exit code is not clearly a UNIX parent or child exit status,
2869    * it will be passed through as a VMS status.
2870    */
2871
2872 #   define STATUS_UNIX_EXIT_SET(n)                      \
2873         STMT_START {                                    \
2874             I32 evalue = (I32)n;                        \
2875             PL_statusvalue = evalue;                    \
2876             if (MY_POSIX_EXIT) { \
2877               if (evalue <= 0xFF00) {           \
2878                   if (evalue > 0xFF)                    \
2879                     evalue = (evalue >> child_offset_bits) & 0xFF; \
2880                   PL_statusvalue_vms =          \
2881                     (C_FAC_POSIX | (evalue << 3 ) |     \
2882                     ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
2883               } else /* forgive them Perl, for they have sinned */ \
2884                 PL_statusvalue_vms = evalue; \
2885             } else { \
2886               if (evalue == 0)                  \
2887                 PL_statusvalue_vms = SS$_NORMAL;        \
2888               else if (evalue <= 0xFF00) \
2889                 PL_statusvalue_vms = SS$_ABORT; \
2890               else { /* forgive them Perl, for they have sinned */ \
2891                   if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
2892                   else PL_statusvalue_vms = vaxc$errno; \
2893                   /* And obviously used a VMS status value instead of UNIX */ \
2894                   PL_statusvalue = EVMSERR;             \
2895               } \
2896               set_vaxc_errno(PL_statusvalue_vms);       \
2897             }                                           \
2898         } STMT_END
2899
2900
2901   /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
2902    * and sets the NATIVE error status based on it.  This special case
2903    * is needed to maintain compatibility with past VMS behavior.
2904    *
2905    * In the default mode on VMS, this number is passed through as
2906    * both the NATIVE and UNIX status.  Which makes it different
2907    * that the STATUS_UNIX_EXIT_SET.
2908    *
2909    * In the new POSIX EXIT mode, native status will be set so that the
2910    * actual exit code will can be retrieved by the calling program or
2911    * shell.
2912    *
2913    * A POSIX exit code is from 0 to 255.  If the exit code is higher
2914    * than this, it needs to be assumed that it is a VMS exit code and
2915    * passed through.
2916    */
2917
2918 #   define STATUS_EXIT_SET(n)                           \
2919         STMT_START {                                    \
2920             I32 evalue = (I32)n;                        \
2921             PL_statusvalue = evalue;                    \
2922             if (MY_POSIX_EXIT)                          \
2923                 if (evalue > 255) PL_statusvalue_vms = evalue; else {   \
2924                   PL_statusvalue_vms = \
2925                     (C_FAC_POSIX | (evalue << 3 ) |     \
2926                      ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
2927             else                                        \
2928                 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
2929             set_vaxc_errno(PL_statusvalue_vms);         \
2930         } STMT_END
2931
2932
2933  /* This macro forces a success status */
2934 #   define STATUS_ALL_SUCCESS   \
2935         (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
2936
2937  /* This macro forces a failure status */
2938 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, \
2939      vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
2940         (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
2941
2942 #else
2943 #   define STATUS_NATIVE        PL_statusvalue_posix
2944 #   if defined(WCOREDUMP)
2945 #       define STATUS_NATIVE_CHILD_SET(n)                  \
2946             STMT_START {                                   \
2947                 PL_statusvalue_posix = (n);                \
2948                 if (PL_statusvalue_posix == -1)            \
2949                     PL_statusvalue = -1;                   \
2950                 else {                                     \
2951                     PL_statusvalue =                       \
2952                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
2953                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
2954                         (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0);  \
2955                 }                                          \
2956             } STMT_END
2957 #   elif defined(WIFEXITED)
2958 #       define STATUS_NATIVE_CHILD_SET(n)                  \
2959             STMT_START {                                   \
2960                 PL_statusvalue_posix = (n);                \
2961                 if (PL_statusvalue_posix == -1)            \
2962                     PL_statusvalue = -1;                   \
2963                 else {                                     \
2964                     PL_statusvalue =                       \
2965                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
2966                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0);  \
2967                 }                                          \
2968             } STMT_END
2969 #   else
2970 #       define STATUS_NATIVE_CHILD_SET(n)                  \
2971             STMT_START {                                   \
2972                 PL_statusvalue_posix = (n);                \
2973                 if (PL_statusvalue_posix == -1)            \
2974                     PL_statusvalue = -1;                   \
2975                 else {                                     \
2976                     PL_statusvalue =                       \
2977                         PL_statusvalue_posix & 0xFFFF;     \
2978                 }                                          \
2979             } STMT_END
2980 #   endif
2981 #   define STATUS_UNIX_SET(n)           \
2982         STMT_START {                    \
2983             PL_statusvalue = (n);               \
2984             if (PL_statusvalue != -1)   \
2985                 PL_statusvalue &= 0xFFFF;       \
2986         } STMT_END
2987 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
2988 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
2989 #   define STATUS_CURRENT STATUS_UNIX
2990 #   define STATUS_EXIT STATUS_UNIX
2991 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
2992 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
2993 #endif
2994
2995 /* flags in PL_exit_flags for nature of exit() */
2996 #define PERL_EXIT_EXPECTED      0x01
2997 #define PERL_EXIT_DESTRUCT_END  0x02  /* Run END in perl_destruct */
2998 #define PERL_EXIT_WARN          0x04  /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
2999 #define PERL_EXIT_ABORT         0x08  /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3000
3001 #ifndef PERL_CORE
3002 /* format to use for version numbers in file/directory names */
3003 /* XXX move to Configure? */
3004 /* This was only ever used for the current version, and that can be done at
3005    compile time, as PERL_FS_VERSION, so should we just delete it?  */
3006 #  ifndef PERL_FS_VER_FMT
3007 #    define PERL_FS_VER_FMT     "%d.%d.%d"
3008 #  endif
3009 #endif
3010
3011 #ifndef PERL_FS_VERSION
3012 #  define PERL_FS_VERSION       PERL_VERSION_STRING
3013 #endif
3014
3015 /* This defines a way to flush all output buffers.  This may be a
3016  * performance issue, so we allow people to disable it.  Also, if
3017  * we are using stdio, there are broken implementations of fflush(NULL)
3018  * out there, Solaris being the most prominent.
3019  */
3020 #ifndef PERL_FLUSHALL_FOR_CHILD
3021 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3022 #  define PERL_FLUSHALL_FOR_CHILD       PerlIO_flush((PerlIO*)NULL)
3023 # else
3024 #  ifdef FFLUSH_ALL
3025 #   define PERL_FLUSHALL_FOR_CHILD      my_fflush_all()
3026 #  else
3027 #   define PERL_FLUSHALL_FOR_CHILD      NOOP
3028 #  endif
3029 # endif
3030 #endif
3031
3032 #ifndef PERL_WAIT_FOR_CHILDREN
3033 #  define PERL_WAIT_FOR_CHILDREN        NOOP
3034 #endif
3035
3036 /* the traditional thread-unsafe notion of "current interpreter". */
3037 #ifndef PERL_SET_INTERP
3038 #  define PERL_SET_INTERP(i)            (PL_curinterp = (PerlInterpreter*)(i))
3039 #endif
3040
3041 #ifndef PERL_GET_INTERP
3042 #  define PERL_GET_INTERP               (PL_curinterp)
3043 #endif
3044
3045 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3046 #  ifdef MULTIPLICITY
3047 #    define PERL_GET_THX                ((PerlInterpreter *)PERL_GET_CONTEXT)
3048 #  endif
3049 #  define PERL_SET_THX(t)               PERL_SET_CONTEXT(t)
3050 #endif
3051
3052 /*
3053     This replaces the previous %_ "hack" by the "%p" hacks.
3054     All that is required is that the perl source does not
3055     use "%-p" or "%-<number>p" or "%<number>p" formats.
3056     These formats will still work in perl code.
3057     See comments in sv.c for further details.
3058
3059     Robin Barker 2005-07-14
3060
3061     No longer use %1p for VDf = %vd.  RMB 2007-10-19
3062 */
3063
3064 #ifndef SVf_
3065 #  define SVf_(n) "-" STRINGIFY(n) "p"
3066 #endif
3067
3068 #ifndef SVf
3069 #  define SVf "-p"
3070 #endif
3071
3072 #ifndef SVf32
3073 #  define SVf32 SVf_(32)
3074 #endif
3075
3076 #ifndef SVf256
3077 #  define SVf256 SVf_(256)
3078 #endif
3079
3080 #define SVfARG(p) ((void*)(p))
3081
3082 #ifndef HEKf
3083 #  define HEKf "2p"
3084 #endif
3085
3086 /* Not ideal, but we cannot easily include a number in an already-numeric
3087  * format sequence. */
3088 #ifndef HEKf256
3089 #  define HEKf256 "3p"
3090 #endif
3091
3092 #define HEKfARG(p) ((void*)(p))
3093
3094 /* Takes three arguments: is_utf8, length, str */
3095 #ifndef UTF8f
3096 #  define UTF8f "d%" UVuf "%4p"
3097 #endif
3098 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3099
3100 #ifdef PERL_CORE
3101 /* not used; but needed for backward compatibility with XS code? - RMB */
3102 #  undef UVf
3103 #else
3104 #  ifndef UVf
3105 #    define UVf UVuf
3106 #  endif
3107 #endif
3108
3109 #ifdef HASATTRIBUTE_DEPRECATED
3110 #  define __attribute__deprecated__         __attribute__((deprecated))
3111 #endif
3112 #ifdef HASATTRIBUTE_FORMAT
3113 #  define __attribute__format__(x,y,z)      __attribute__((format(x,y,z)))
3114 #endif
3115 #ifdef HASATTRIBUTE_MALLOC
3116 #  define __attribute__malloc__             __attribute__((__malloc__))
3117 #endif
3118 #ifdef HASATTRIBUTE_NONNULL
3119 #  define __attribute__nonnull__(a)         __attribute__((nonnull(a)))
3120 #endif
3121 #ifdef HASATTRIBUTE_NORETURN
3122 #  define __attribute__noreturn__           __attribute__((noreturn))
3123 #endif
3124 #ifdef HASATTRIBUTE_PURE
3125 #  define __attribute__pure__               __attribute__((pure))
3126 #endif
3127 #ifdef HASATTRIBUTE_UNUSED
3128 #  define __attribute__unused__             __attribute__((unused))
3129 #endif
3130 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
3131 #  define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
3132 #endif
3133
3134 /* If we haven't defined the attributes yet, define them to blank. */
3135 #ifndef __attribute__deprecated__
3136 #  define __attribute__deprecated__
3137 #endif
3138 #ifndef __attribute__format__
3139 #  define __attribute__format__(x,y,z)
3140 #endif
3141 #ifndef __attribute__malloc__
3142 #  define __attribute__malloc__
3143 #endif
3144 #ifndef __attribute__nonnull__
3145 #  define __attribute__nonnull__(a)
3146 #endif
3147 #ifndef __attribute__noreturn__
3148 #  define __attribute__noreturn__
3149 #endif
3150 #ifndef __attribute__pure__
3151 #  define __attribute__pure__
3152 #endif
3153 #ifndef __attribute__unused__
3154 #  define __attribute__unused__
3155 #endif
3156 #ifndef __attribute__warn_unused_result__
3157 #  define __attribute__warn_unused_result__
3158 #endif
3159
3160 #if defined(DEBUGGING) && defined(I_ASSERT)
3161 #  include <assert.h>
3162 #endif
3163
3164 /* For functions that are marked as __attribute__noreturn__, it's not
3165    appropriate to call return.  In either case, include the lint directive.
3166  */
3167 #ifdef HASATTRIBUTE_NORETURN
3168 #  define NORETURN_FUNCTION_END NOT_REACHED; /* NOTREACHED */
3169 #else
3170 #  define NORETURN_FUNCTION_END NOT_REACHED; /* NOTREACHED */ return 0
3171 #endif
3172
3173 /* Some OS warn on NULL format to printf */
3174 #ifdef PRINTF_FORMAT_NULL_OK
3175 #  define __attribute__format__null_ok__(x,y,z)  __attribute__format__(x,y,z)
3176 #else
3177 #  define __attribute__format__null_ok__(x,y,z)
3178 #endif
3179
3180 #ifdef HAS_BUILTIN_EXPECT
3181 #  define EXPECT(expr,val)                  __builtin_expect(expr,val)
3182 #else
3183 #  define EXPECT(expr,val)                  (expr)
3184 #endif
3185 #define LIKELY(cond)                        EXPECT(cBOOL(cond),TRUE)
3186 #define UNLIKELY(cond)                      EXPECT(cBOOL(cond),FALSE)
3187 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3188 /* placeholder */
3189 #endif
3190
3191
3192 #ifndef __has_builtin
3193 #  define __has_builtin(x) 0 /* not a clang style compiler */
3194 #endif
3195
3196 /* ASSUME is like assert(), but it has a benefit in a release build. It is a
3197    hint to a compiler about a statement of fact in a function call free
3198    expression, which allows the compiler to generate better machine code.
3199    In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3200    the control path is unreachable. In a for loop, ASSUME can be used to hint
3201    that a loop will run atleast X times. ASSUME is based off MSVC's __assume
3202    intrinsic function, see its documents for more details.
3203 */
3204
3205 #ifndef DEBUGGING
3206 #  if __has_builtin(__builtin_unreachable) \
3207      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 5) /* 4.5 -> */
3208 #    define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3209 #  elif defined(_MSC_VER)
3210 #    define ASSUME(x) __assume(x)
3211 #  elif defined(__ARMCC_VERSION) /* untested */
3212 #    define ASSUME(x) __promise(x)
3213 #  else
3214 /* a random compiler might define assert to its own special optimization token
3215    so pass it through to C lib as a last resort */
3216 #    define ASSUME(x) assert(x)
3217 #  endif
3218 #else
3219 #  define ASSUME(x) assert(x)
3220 #endif
3221
3222 #define NOT_REACHED ASSUME(0)
3223
3224 /* Some unistd.h's give a prototype for pause() even though
3225    HAS_PAUSE ends up undefined.  This causes the #define
3226    below to be rejected by the compiler.  Sigh.
3227 */
3228 #ifdef HAS_PAUSE
3229 #define Pause   pause
3230 #else
3231 #define Pause() sleep((32767<<16)+32767)
3232 #endif
3233
3234 #ifndef IOCPARM_LEN
3235 #   ifdef IOCPARM_MASK
3236         /* on BSDish systems we're safe */
3237 #       define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
3238 #   else
3239 #       if defined(_IOC_SIZE) && defined(__GLIBC__)
3240         /* on Linux systems we're safe; except when we're not [perl #38223] */
3241 #           define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3242 #       else
3243         /* otherwise guess at what's safe */
3244 #           define IOCPARM_LEN(x)       256
3245 #       endif
3246 #   endif
3247 #endif
3248
3249 #if defined(__CYGWIN__)
3250 /* USEMYBINMODE
3251  *   This symbol, if defined, indicates that the program should
3252  *   use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3253  *   that a file is in "binary" mode -- that is, that no translation
3254  *   of bytes occurs on read or write operations.
3255  */
3256 #  define USEMYBINMODE /**/
3257 #  include <io.h> /* for setmode() prototype */
3258 #  define my_binmode(fp, iotype, mode) \
3259             (PerlLIO_setmode(fileno(fp), mode) != -1 ? TRUE : FALSE)
3260 #endif
3261
3262 #ifdef __CYGWIN__
3263 void init_os_extras(void);
3264 #endif
3265
3266 #ifdef UNION_ANY_DEFINITION
3267 UNION_ANY_DEFINITION;
3268 #else
3269 union any {
3270     void*       any_ptr;
3271     I32         any_i32;
3272     U32         any_u32;
3273     IV          any_iv;
3274     UV          any_uv;
3275     long        any_long;
3276     bool        any_bool;
3277     void        (*any_dptr) (void*);
3278     void        (*any_dxptr) (pTHX_ void*);
3279 };
3280 #endif
3281
3282 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3283
3284 #define FILTER_READ(idx, sv, len)  filter_read(idx, sv, len)
3285 #define FILTER_DATA(idx) \
3286             (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3287 #define FILTER_ISREADER(idx) \
3288             (PL_parser && PL_parser->rsfp_filters \
3289                 && idx >= AvFILLp(PL_parser->rsfp_filters))
3290 #define PERL_FILTER_EXISTS(i) \
3291             (PL_parser && PL_parser->rsfp_filters \
3292                 && (i) <= av_tindex(PL_parser->rsfp_filters))
3293
3294 #if defined(_AIX) && !defined(_AIX43)
3295 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3296 /* We cannot include <crypt.h> to get the struct crypt_data
3297  * because of setkey prototype problems when threading */
3298 typedef        struct crypt_data {     /* straight from /usr/include/crypt.h */
3299     /* From OSF, Not needed in AIX
3300        char C[28], D[28];
3301     */
3302     char E[48];
3303     char KS[16][48];
3304     char block[66];
3305     char iobuf[16];
3306 } CRYPTD;
3307 #endif /* threading */
3308 #endif /* AIX */
3309
3310 #if !defined(OS2)
3311 #  include "iperlsys.h"
3312 #endif
3313
3314 #ifdef __LIBCATAMOUNT__
3315 #undef HAS_PASSWD  /* unixish.h but not unixish enough. */
3316 #undef HAS_GROUP
3317 #define FAKE_BIT_BUCKET
3318 #endif
3319
3320 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3321  * Note that the USE_HASH_SEED and USE_HASH_SEED_EXPLICIT are *NOT*
3322  * defined by Configure, despite their names being similar to the
3323  * other defines like USE_ITHREADS.  Configure in fact knows nothing
3324  * about the randomised hashes.  Therefore to enable/disable the hash
3325  * randomisation defines use the Configure -Accflags=... instead. */
3326 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED) && !defined(USE_HASH_SEED_EXPLICIT)
3327 #  define USE_HASH_SEED
3328 #endif
3329
3330 /* Win32 defines a type 'WORD' in windef.h. This conflicts with the enumerator
3331  * 'WORD' defined in perly.h. The yytokentype enum is only a debugging aid, so
3332  * it's not really needed.
3333  */
3334 #if defined(WIN32)
3335 #  define YYTOKENTYPE
3336 #endif
3337 #include "perly.h"
3338
3339
3340 /* macros to define bit-fields in structs. */
3341 #ifndef PERL_BITFIELD8
3342 #  define PERL_BITFIELD8 unsigned
3343 #endif
3344 #ifndef PERL_BITFIELD16
3345 #  define PERL_BITFIELD16 unsigned
3346 #endif
3347 #ifndef PERL_BITFIELD32
3348 #  define PERL_BITFIELD32 unsigned
3349 #endif
3350
3351 #include "sv.h"
3352 #include "regexp.h"
3353 #include "util.h"
3354 #include "form.h"
3355 #include "gv.h"
3356 #include "pad.h"
3357 #include "cv.h"
3358 #include "opnames.h"
3359 #include "op.h"
3360 #include "hv.h"
3361 #include "cop.h"
3362 #include "av.h"
3363 #include "mg.h"
3364 #include "scope.h"
3365 #include "warnings.h"
3366 #include "utf8.h"
3367
3368 /* these would be in doio.h if there was such a file */
3369 #define my_stat()  my_stat_flags(SV_GMAGIC)
3370 #define my_lstat() my_lstat_flags(SV_GMAGIC)
3371
3372 /* defined in sv.c, but also used in [ach]v.c */
3373 #undef _XPV_HEAD
3374 #undef _XPVMG_HEAD
3375 #undef _XPVCV_COMMON
3376
3377 typedef struct _sublex_info SUBLEXINFO;
3378 struct _sublex_info {
3379     U8 super_state;     /* lexer state to save */
3380     U16 sub_inwhat;     /* "lex_inwhat" to use */
3381     OP *sub_op;         /* "lex_op" to use */
3382     SV *repl;           /* replacement of s/// or y/// */
3383 };
3384
3385 #include "parser.h"
3386
3387 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
3388
3389 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3390
3391 /* These have to be predeclared, as they are used in proto.h which is #included
3392  * before their definitions in regcomp.h. */
3393
3394 struct scan_data_t;
3395 typedef struct regnode_charclass regnode_charclass;
3396
3397 struct regnode_charclass_class;
3398
3399 /* A hopefully less confusing name.  The sub-classes are all Posix classes only
3400  * used under /l matching */
3401 typedef struct regnode_charclass_class regnode_charclass_posixl;
3402
3403 typedef struct regnode_ssc regnode_ssc;
3404 typedef struct RExC_state_t RExC_state_t;
3405 struct _reg_trie_data;
3406
3407 #endif
3408
3409 struct ptr_tbl_ent {
3410     struct ptr_tbl_ent*         next;
3411     const void*                 oldval;
3412     void*                       newval;
3413 };
3414
3415 struct ptr_tbl {
3416     struct ptr_tbl_ent**        tbl_ary;
3417     UV                          tbl_max;
3418     UV                          tbl_items;
3419     struct ptr_tbl_arena        *tbl_arena;
3420     struct ptr_tbl_ent          *tbl_arena_next;
3421     struct ptr_tbl_ent          *tbl_arena_end;
3422 };
3423
3424 #if defined(htonl) && !defined(HAS_HTONL)
3425 #define HAS_HTONL
3426 #endif
3427 #if defined(htons) && !defined(HAS_HTONS)
3428 #define HAS_HTONS
3429 #endif
3430 #if defined(ntohl) && !defined(HAS_NTOHL)
3431 #define HAS_NTOHL
3432 #endif
3433 #if defined(ntohs) && !defined(HAS_NTOHS)
3434 #define HAS_NTOHS
3435 #endif
3436 #ifndef HAS_HTONL
3437 #define HAS_HTONS
3438 #define HAS_HTONL
3439 #define HAS_NTOHS
3440 #define HAS_NTOHL
3441 #  if (BYTEORDER & 0xffff) == 0x4321
3442 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
3443    re-order their values. However, to behave identically to the alternative
3444    implementations, they should truncate to the correct size.  */
3445 #    define ntohl(x)    ((x)&0xFFFFFFFF)
3446 #    define htonl(x)    ntohl(x)
3447 #    define ntohs(x)    ((x)&0xFFFF)
3448 #    define htons(x)    ntohs(x)
3449 #  elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3450
3451 /* Note that we can't straight out declare our own htonl and htons because
3452    the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
3453    to avoid the overhead of initialising the socket subsystem, but the headers
3454    that *declare* the various functions are still seen. If we declare our own
3455    htonl etc they will clash with the declarations in the Win32 headers.  */
3456
3457 PERL_STATIC_INLINE U32
3458 my_swap32(const U32 x) {
3459     return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)      
3460         | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
3461 }
3462
3463 PERL_STATIC_INLINE U16
3464 my_swap16(const U16 x) {
3465     return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
3466 }
3467
3468 #    define htonl(x)    my_swap32(x)
3469 #    define ntohl(x)    my_swap32(x)
3470 #    define ntohs(x)    my_swap16(x)
3471 #    define htons(x)    my_swap16(x)
3472 #  else
3473 #    error "Unsupported byteorder"
3474 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
3475    the error message. Please check the value of the macro BYTEORDER, as defined
3476    in config.h. The values of BYTEORDER we expect are
3477
3478             big endian  little endian
3479    32 bit       0x4321  0x1234
3480    64 bit   0x87654321  0x12345678
3481
3482    If you have a system with a different byte order, please see
3483    pod/perlhack.pod for how to submit a patch to add supporting code.
3484 */
3485 #  endif
3486 #endif
3487
3488 /*
3489  * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
3490  * -DWS
3491  */
3492 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3493 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
3494    re-order their values. However, to behave identically to the alternative
3495    implementations, they should truncate to the correct size.  */
3496 #  define vtohl(x)      ((x)&0xFFFFFFFF)
3497 #  define vtohs(x)      ((x)&0xFFFF)
3498 #  define htovl(x)      vtohl(x)
3499 #  define htovs(x)      vtohs(x)
3500 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
3501 #  define vtohl(x)      ((((x)&0xFF)<<24)       \
3502                         +(((x)>>24)&0xFF)       \
3503                         +(((x)&0x0000FF00)<<8)  \
3504                         +(((x)&0x00FF0000)>>8)  )
3505 #  define vtohs(x)      ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
3506 #  define htovl(x)      vtohl(x)
3507 #  define htovs(x)      vtohs(x)
3508 #else
3509 #  error "Unsupported byteorder"
3510 /* If you have need for current perl on PDP-11 or similar, and can help test
3511    that blead keeps working on a mixed-endian system, then see
3512    pod/perlhack.pod for how to submit patches to things working again.  */
3513 #endif
3514
3515 /* *MAX Plus 1. A floating point value.
3516    Hopefully expressed in a way that dodgy floating point can't mess up.
3517    >> 2 rather than 1, so that value is safely less than I32_MAX after 1
3518    is added to it
3519    May find that some broken compiler will want the value cast to I32.
3520    [after the shift, as signed >> may not be as secure as unsigned >>]
3521 */
3522 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
3523 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
3524 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
3525    0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
3526    may be greater than sizeof(IV), so don't assume that half max UV is max IV.
3527 */
3528 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
3529
3530 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
3531 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
3532 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
3533
3534 /* This may look like unnecessary jumping through hoops, but converting
3535    out of range floating point values to integers *is* undefined behaviour,
3536    and it is starting to bite.
3537 */
3538 #ifndef CAST_INLINE
3539 #define I_32(what) (cast_i32((NV)(what)))
3540 #define U_32(what) (cast_ulong((NV)(what)))
3541 #define I_V(what) (cast_iv((NV)(what)))
3542 #define U_V(what) (cast_uv((NV)(what)))
3543 #else
3544 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
3545                   : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
3546                      : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
3547 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
3548                   : ((n) < U32_MAX_P1 ? (U32) (n) \
3549                      : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
3550 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
3551                   : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
3552                      : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
3553 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
3554                   : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
3555                      : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
3556 #endif
3557
3558 #define U_S(what) ((U16)U_32(what))
3559 #define U_I(what) ((unsigned int)U_32(what))
3560 #define U_L(what) U_32(what)
3561
3562 #ifdef HAS_SIGNBIT
3563 #  define Perl_signbit signbit
3564 #endif
3565
3566 /* These do not care about the fractional part, only about the range. */
3567 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
3568 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
3569
3570 /* Used with UV/IV arguments: */
3571                                         /* XXXX: need to speed it up */
3572 #define CLUMP_2UV(iv)   ((iv) < 0 ? 0 : (UV)(iv))
3573 #define CLUMP_2IV(uv)   ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
3574
3575 #ifndef MAXSYSFD
3576 #   define MAXSYSFD 2
3577 #endif
3578
3579 #ifndef __cplusplus
3580 #if !(defined(WIN32) || defined(UNDER_CE) || defined(SYMBIAN))
3581 Uid_t getuid (void);
3582 Uid_t geteuid (void);
3583 Gid_t getgid (void);
3584 Gid_t getegid (void);
3585 #endif
3586 #endif
3587
3588 #ifndef Perl_debug_log
3589 #  define Perl_debug_log        PerlIO_stderr()
3590 #endif
3591
3592 #ifndef Perl_error_log
3593 #  define Perl_error_log        (PL_stderrgv                    \
3594                                  && isGV(PL_stderrgv)           \
3595                                  && GvIOp(PL_stderrgv)          \
3596                                  && IoOFP(GvIOp(PL_stderrgv))   \
3597                                  ? IoOFP(GvIOp(PL_stderrgv))    \
3598                                  : PerlIO_stderr())
3599 #endif
3600
3601
3602 #define DEBUG_p_FLAG            0x00000001 /*      1 */
3603 #define DEBUG_s_FLAG            0x00000002 /*      2 */
3604 #define DEBUG_l_FLAG            0x00000004 /*      4 */
3605 #define DEBUG_t_FLAG            0x00000008 /*      8 */
3606 #define DEBUG_o_FLAG            0x00000010 /*     16 */
3607 #define DEBUG_c_FLAG            0x00000020 /*     32 */
3608 #define DEBUG_P_FLAG            0x00000040 /*     64 */
3609 #define DEBUG_m_FLAG            0x00000080 /*    128 */
3610 #define DEBUG_f_FLAG            0x00000100 /*    256 */
3611 #define DEBUG_r_FLAG            0x00000200 /*    512 */
3612 #define DEBUG_x_FLAG            0x00000400 /*   1024 */
3613 #define DEBUG_u_FLAG            0x00000800 /*   2048 */
3614 /* U is reserved for Unofficial, exploratory hacking */
3615 #define DEBUG_U_FLAG            0x00001000 /*   4096 */
3616 #define DEBUG_H_FLAG            0x00002000 /*   8192 */
3617 #define DEBUG_X_FLAG            0x00004000 /*  16384 */
3618 #define DEBUG_D_FLAG            0x00008000 /*  32768 */
3619 #define DEBUG_S_FLAG            0x00010000 /*  65536 */
3620 #define DEBUG_T_FLAG            0x00020000 /* 131072 */
3621 #define DEBUG_R_FLAG            0x00040000 /* 262144 */
3622 #define DEBUG_J_FLAG            0x00080000 /* 524288 */
3623 #define DEBUG_v_FLAG            0x00100000 /*1048576 */
3624 #define DEBUG_C_FLAG            0x00200000 /*2097152 */
3625 #define DEBUG_A_FLAG            0x00400000 /*4194304 */
3626 #define DEBUG_q_FLAG            0x00800000 /*8388608 */
3627 #define DEBUG_M_FLAG            0x01000000 /*16777216*/
3628 #define DEBUG_B_FLAG            0x02000000 /*33554432*/
3629 #define DEBUG_L_FLAG            0x04000000 /*67108864*/
3630 #define DEBUG_MASK              0x07FFEFFF /* mask of all the standard flags */
3631
3632 #define DEBUG_DB_RECURSE_FLAG   0x40000000
3633 #define DEBUG_TOP_FLAG          0x80000000 /* XXX what's this for ??? Signal
3634                                               that something was done? */
3635
3636 #  define DEBUG_p_TEST_ (PL_debug & DEBUG_p_FLAG)
3637 #  define DEBUG_s_TEST_ (PL_debug & DEBUG_s_FLAG)
3638 #  define DEBUG_l_TEST_ (PL_debug & DEBUG_l_FLAG)
3639 #  define DEBUG_t_TEST_ (PL_debug & DEBUG_t_FLAG)
3640 #  define DEBUG_o_TEST_ (PL_debug & DEBUG_o_FLAG)
3641 #  define DEBUG_c_TEST_ (PL_debug & DEBUG_c_FLAG)
3642 #  define DEBUG_P_TEST_ (PL_debug & DEBUG_P_FLAG)
3643 #  define DEBUG_m_TEST_ (PL_debug & DEBUG_m_FLAG)
3644 #  define DEBUG_f_TEST_ (PL_debug & DEBUG_f_FLAG)
3645 #  define DEBUG_r_TEST_ (PL_debug & DEBUG_r_FLAG)
3646 #  define DEBUG_x_TEST_ (PL_debug & DEBUG_x_FLAG)
3647 #  define DEBUG_u_TEST_ (PL_debug & DEBUG_u_FLAG)
3648 #  define DEBUG_U_TEST_ (PL_debug & DEBUG_U_FLAG)
3649 #  define DEBUG_H_TEST_ (PL_debug & DEBUG_H_FLAG)
3650 #  define DEBUG_X_TEST_ (PL_debug & DEBUG_X_FLAG)
3651 #  define DEBUG_D_TEST_ (PL_debug & DEBUG_D_FLAG)
3652 #  define DEBUG_S_TEST_ (PL_debug & DEBUG_S_FLAG)
3653 #  define DEBUG_T_TEST_ (PL_debug & DEBUG_T_FLAG)
3654 #  define DEBUG_R_TEST_ (PL_debug & DEBUG_R_FLAG)
3655 #  define DEBUG_J_TEST_ (PL_debug & DEBUG_J_FLAG)
3656 #  define DEBUG_v_TEST_ (PL_debug & DEBUG_v_FLAG)
3657 #  define DEBUG_C_TEST_ (PL_debug & DEBUG_C_FLAG)
3658 #  define DEBUG_A_TEST_ (PL_debug & DEBUG_A_FLAG)
3659 #  define DEBUG_q_TEST_ (PL_debug & DEBUG_q_FLAG)
3660 #  define DEBUG_M_TEST_ (PL_debug & DEBUG_M_FLAG)
3661 #  define DEBUG_B_TEST_ (PL_debug & DEBUG_B_FLAG)
3662 #  define DEBUG_L_TEST_ (PL_debug & DEBUG_L_FLAG)
3663 #  define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
3664 #  define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
3665 #  define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
3666
3667 #ifdef DEBUGGING
3668
3669 #  define DEBUG_p_TEST DEBUG_p_TEST_
3670 #  define DEBUG_s_TEST DEBUG_s_TEST_
3671 #  define DEBUG_l_TEST DEBUG_l_TEST_
3672 #  define DEBUG_t_TEST DEBUG_t_TEST_
3673 #  define DEBUG_o_TEST DEBUG_o_TEST_
3674 #  define DEBUG_c_TEST DEBUG_c_TEST_
3675 #  define DEBUG_P_TEST DEBUG_P_TEST_
3676 #  define DEBUG_m_TEST DEBUG_m_TEST_
3677 #  define DEBUG_f_TEST DEBUG_f_TEST_
3678 #  define DEBUG_r_TEST DEBUG_r_TEST_
3679 #  define DEBUG_x_TEST DEBUG_x_TEST_
3680 #  define DEBUG_u_TEST DEBUG_u_TEST_
3681 #  define DEBUG_U_TEST DEBUG_U_TEST_
3682 #  define DEBUG_H_TEST DEBUG_H_TEST_
3683 #  define DEBUG_X_TEST DEBUG_X_TEST_
3684 #  define DEBUG_D_TEST DEBUG_D_TEST_
3685 #  define DEBUG_S_TEST DEBUG_S_TEST_
3686 #  define DEBUG_T_TEST DEBUG_T_TEST_
3687 #  define DEBUG_R_TEST DEBUG_R_TEST_
3688 #  define DEBUG_J_TEST DEBUG_J_TEST_
3689 #  define DEBUG_v_TEST DEBUG_v_TEST_
3690 #  define DEBUG_C_TEST DEBUG_C_TEST_
3691 #  define DEBUG_A_TEST DEBUG_A_TEST_
3692 #  define DEBUG_q_TEST DEBUG_q_TEST_
3693 #  define DEBUG_M_TEST DEBUG_M_TEST_
3694 #  define DEBUG_B_TEST DEBUG_B_TEST_
3695 #  define DEBUG_L_TEST DEBUG_L_TEST_
3696 #  define DEBUG_Xv_TEST DEBUG_Xv_TEST_
3697 #  define DEBUG_Uv_TEST DEBUG_Uv_TEST_
3698 #  define DEBUG_Pv_TEST DEBUG_Pv_TEST_
3699
3700 #  define PERL_DEB(a)                  a
3701 #  define PERL_DEBUG(a) if (PL_debug)  a
3702 #  define DEBUG_p(a) if (DEBUG_p_TEST) a
3703 #  define DEBUG_s(a) if (DEBUG_s_TEST) a
3704 #  define DEBUG_l(a) if (DEBUG_l_TEST) a
3705 #  define DEBUG_t(a) if (DEBUG_t_TEST) a
3706 #  define DEBUG_o(a) if (DEBUG_o_TEST) a
3707 #  define DEBUG_c(a) if (DEBUG_c_TEST) a
3708 #  define DEBUG_P(a) if (DEBUG_P_TEST) a
3709
3710      /* Temporarily turn off memory debugging in case the a
3711       * does memory allocation, either directly or indirectly. */
3712 #  define DEBUG_m(a)  \
3713     STMT_START {                                                        \
3714         if (PERL_GET_INTERP) { dTHX; if (DEBUG_m_TEST) {PL_debug&=~DEBUG_m_FLAG; a; PL_debug|=DEBUG_m_FLAG;} } \
3715     } STMT_END
3716
3717 #  define DEBUG__(t, a) \
3718         STMT_START { \
3719                 if (t) STMT_START {a;} STMT_END; \
3720         } STMT_END
3721
3722 #  define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
3723 #ifndef PERL_EXT_RE_BUILD
3724 #  define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
3725 #else
3726 #  define DEBUG_r(a) STMT_START {a;} STMT_END
3727 #endif /* PERL_EXT_RE_BUILD */
3728 #  define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
3729 #  define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
3730 #  define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
3731 #  define DEBUG_H(a) DEBUG__(DEBUG_H_TEST, a)
3732 #  define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
3733 #  define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
3734 #  define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
3735 #  define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
3736 #  define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
3737
3738 #  define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
3739 #  define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
3740 #  define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
3741 #  define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
3742 #  define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
3743 #  define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
3744 #  define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
3745 #  define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
3746 #  define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
3747 #  define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
3748
3749 #else /* DEBUGGING */
3750
3751 #  define DEBUG_p_TEST (0)
3752 #  define DEBUG_s_TEST (0)
3753 #  define DEBUG_l_TEST (0)
3754 #  define DEBUG_t_TEST (0)
3755 #  define DEBUG_o_TEST (0)
3756 #  define DEBUG_c_TEST (0)
3757 #  define DEBUG_P_TEST (0)
3758 #  define DEBUG_m_TEST (0)
3759 #  define DEBUG_f_TEST (0)
3760 #  define DEBUG_r_TEST (0)
3761 #  define DEBUG_x_TEST (0)
3762 #  define DEBUG_u_TEST (0)
3763 #  define DEBUG_U_TEST (0)
3764 #  define DEBUG_H_TEST (0)
3765 #  define DEBUG_X_TEST (0)
3766 #  define DEBUG_D_TEST (0)
3767 #  define DEBUG_S_TEST (0)
3768 #  define DEBUG_T_TEST (0)
3769 #  define DEBUG_R_TEST (0)
3770 #  define DEBUG_J_TEST (0)
3771 #  define DEBUG_v_TEST (0)
3772 #  define DEBUG_C_TEST (0)
3773 #  define DEBUG_A_TEST (0)
3774 #  define DEBUG_q_TEST (0)
3775 #  define DEBUG_M_TEST (0)
3776 #  define DEBUG_B_TEST (0)
3777 #  define DEBUG_L_TEST (0)
3778 #  define DEBUG_Xv_TEST (0)
3779 #  define DEBUG_Uv_TEST (0)
3780 #  define DEBUG_Pv_TEST (0)
3781
3782 #  define PERL_DEB(a)
3783 #  define PERL_DEBUG(a)
3784 #  define DEBUG_p(a)
3785 #  define DEBUG_s(a)
3786 #  define DEBUG_l(a)
3787 #  define DEBUG_t(a)
3788 #  define DEBUG_o(a)
3789 #  define DEBUG_c(a)
3790 #  define DEBUG_P(a)
3791 #  define DEBUG_m(a)
3792 #  define DEBUG_f(a)
3793 #  define DEBUG_r(a)
3794 #  define DEBUG_x(a)
3795 #  define DEBUG_u(a)
3796 #  define DEBUG_U(a)
3797 #  define DEBUG_H(a)
3798 #  define DEBUG_X(a)
3799 #  define DEBUG_D(a)
3800 #  define DEBUG_S(a)
3801 #  define DEBUG_T(a)
3802 #  define DEBUG_R(a)
3803 #  define DEBUG_v(a)
3804 #  define DEBUG_C(a)
3805 #  define DEBUG_A(a)
3806 #  define DEBUG_q(a)
3807 #  define DEBUG_M(a)
3808 #  define DEBUG_B(a)
3809 #  define DEBUG_L(a)
3810 #  define DEBUG_Xv(a)
3811 #  define DEBUG_Uv(a)
3812 #  define DEBUG_Pv(a)
3813 #endif /* DEBUGGING */
3814
3815
3816 #define DEBUG_SCOPE(where) \
3817     DEBUG_l( \
3818     Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n",   \
3819                     where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
3820                     __FILE__, __LINE__));
3821
3822 /* Keep the old croak based assert for those who want it, and as a fallback if
3823    the platform is so heretically non-ANSI that it can't assert.  */
3824
3825 #define Perl_assert(what)       PERL_DEB(                               \
3826         ((what) ? ((void) 0) :                                          \
3827             (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
3828                         "\", line %d", STRINGIFY(what), __LINE__),      \
3829             (void) 0)))
3830
3831 /* assert() gets defined if DEBUGGING (and I_ASSERT).
3832  * If no DEBUGGING, the <assert.h> has not been included. */
3833 #ifndef assert
3834 #  define assert(what)  Perl_assert(what)
3835 #endif
3836 #ifdef DEBUGGING
3837 #  define assert_(what) assert(what),
3838 #else
3839 #  define assert_(what)
3840 #endif
3841
3842 struct ufuncs {
3843     I32 (*uf_val)(pTHX_ IV, SV*);
3844     I32 (*uf_set)(pTHX_ IV, SV*);
3845     IV uf_index;
3846 };
3847
3848 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
3849  * XS code wanting to be backward compatible can do something
3850  * like the following:
3851
3852 #ifndef PERL_MG_UFUNC
3853 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
3854 #endif
3855
3856 static PERL_MG_UFUNC(foo_get, index, val)
3857 {
3858     sv_setsv(val, ...);
3859     return TRUE;
3860 }
3861
3862 -- Doug MacEachern
3863
3864 */
3865
3866 #ifndef PERL_MG_UFUNC
3867 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
3868 #endif
3869
3870 /* Fix these up for __STDC__ */
3871 #ifndef DONT_DECLARE_STD
3872 char *mktemp (char*);
3873 #ifndef atof
3874 double atof (const char*);
3875 #endif
3876 #endif
3877
3878 #ifndef STANDARD_C
3879 /* All of these are in stdlib.h or time.h for ANSI C */
3880 Time_t time();
3881 struct tm *gmtime(), *localtime();
3882 #if defined(OEMVS)
3883 char *(strchr)(), *(strrchr)();
3884 char *(strcpy)(), *(strcat)();
3885 #else
3886 char *strchr(), *strrchr();
3887 char *strcpy(), *strcat();
3888 #endif
3889 #endif /* ! STANDARD_C */
3890
3891
3892 #ifdef I_MATH
3893 #    include <math.h>
3894 #else
3895 START_EXTERN_C
3896             double exp (double);
3897             double log (double);
3898             double log10 (double);
3899             double sqrt (double);
3900             double frexp (double,int*);
3901             double ldexp (double,int);
3902             double modf (double,double*);
3903             double sin (double);
3904             double cos (double);
3905             double atan2 (double,double);
3906             double pow (double,double);
3907 END_EXTERN_C
3908 #endif
3909
3910 #if !defined(NV_INF) && defined(USE_LONG_DOUBLE) && defined(LDBL_INFINITY)
3911 #  define NV_INF LDBL_INFINITY
3912 #endif
3913 #if !defined(NV_INF) && defined(DBL_INFINITY)
3914 #  define NV_INF (NV)DBL_INFINITY
3915 #endif
3916 #if !defined(NV_INF) && defined(INFINITY)
3917 #  define NV_INF (NV)INFINITY
3918 #endif
3919 #if !defined(NV_INF) && defined(INF)
3920 #  define NV_INF (NV)INF
3921 #endif
3922 #if !defined(NV_INF) && defined(USE_LONG_DOUBLE) && defined(HUGE_VALL)
3923 #  define NV_INF (NV)HUGE_VALL
3924 #endif
3925 #if !defined(NV_INF) && defined(HUGE_VAL)
3926 #  define NV_INF (NV)HUGE_VAL
3927 #endif
3928
3929 #if !defined(NV_NAN) && defined(USE_LONG_DOUBLE)
3930 #   if !defined(NV_NAN) && defined(LDBL_NAN)
3931 #       define NV_NAN LDBL_NAN
3932 #   endif
3933 #   if !defined(NV_NAN) && defined(LDBL_QNAN)
3934 #       define NV_NAN LDBL_QNAN
3935 #   endif
3936 #   if !defined(NV_NAN) && defined(LDBL_SNAN)
3937 #       define NV_NAN LDBL_SNAN
3938 #   endif
3939 #endif
3940 #if !defined(NV_NAN) && defined(DBL_NAN)
3941 #  define NV_NAN (NV)DBL_NAN
3942 #endif
3943 #if !defined(NV_NAN) && defined(DBL_QNAN)
3944 #  define NV_NAN (NV)DBL_QNAN
3945 #endif
3946 #if !defined(NV_NAN) && defined(DBL_SNAN)
3947 #  define NV_NAN (NV)DBL_SNAN
3948 #endif
3949 #if !defined(NV_NAN) && defined(QNAN)
3950 #  define NV_NAN (NV)QNAN
3951 #endif
3952 #if !defined(NV_NAN) && defined(SNAN)
3953 #  define NV_NAN (NV)SNAN
3954 #endif
3955 #if !defined(NV_NAN) && defined(NAN)
3956 #  define NV_NAN (NV)NAN
3957 #endif
3958
3959 #ifndef __cplusplus
3960 #  if !defined(WIN32) && !defined(VMS)
3961 #ifndef crypt
3962 char *crypt (const char*, const char*);
3963 #endif
3964 #  endif /* !WIN32 */
3965 #  ifndef DONT_DECLARE_STD
3966 #    ifndef getenv
3967 char *getenv (const char*);
3968 #    endif /* !getenv */
3969 #    if !defined(HAS_LSEEK_PROTO) && !defined(__hpux)
3970 #      ifdef _FILE_OFFSET_BITS
3971 #        if _FILE_OFFSET_BITS == 64
3972 Off_t lseek (int,Off_t,int);
3973 #        endif
3974 #      endif
3975 #    endif
3976 #  endif /* !DONT_DECLARE_STD */
3977 #  ifndef WIN32
3978 #    ifndef getlogin
3979 char *getlogin (void);
3980 #    endif
3981 #  endif /* !WIN32 */
3982 #endif /* !__cplusplus */
3983
3984 /* Fixme on VMS.  This needs to be a run-time, not build time options */
3985 /* Also rename() is affected by this */
3986 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
3987 #define UNLINK unlnk
3988 I32 unlnk (pTHX_ const char*);
3989 #else
3990 #define UNLINK PerlLIO_unlink
3991 #endif
3992
3993 /* some versions of glibc are missing the setresuid() proto */
3994 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
3995 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
3996 #endif
3997 /* some versions of glibc are missing the setresgid() proto */
3998 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
3999 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4000 #endif
4001
4002 #ifndef HAS_SETREUID
4003 #  ifdef HAS_SETRESUID
4004 #    define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4005 #    define HAS_SETREUID
4006 #  endif
4007 #endif
4008 #ifndef HAS_SETREGID
4009 #  ifdef HAS_SETRESGID
4010 #    define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4011 #    define HAS_SETREGID
4012 #  endif
4013 #endif
4014
4015 /* Sighandler_t defined in iperlsys.h */
4016
4017 #ifdef HAS_SIGACTION
4018 typedef struct sigaction Sigsave_t;
4019 #else
4020 typedef Sighandler_t Sigsave_t;
4021 #endif
4022
4023 #define SCAN_DEF 0
4024 #define SCAN_TR 1
4025 #define SCAN_REPL 2
4026
4027 #ifdef DEBUGGING
4028 # ifndef register
4029 #  define register
4030 # endif
4031 # define RUNOPS_DEFAULT Perl_runops_debug
4032 #else
4033 # define RUNOPS_DEFAULT Perl_runops_standard
4034 #endif
4035
4036 #if defined(USE_PERLIO)
4037 EXTERN_C void PerlIO_teardown(void);
4038 # ifdef USE_ITHREADS
4039 #  define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4040 #  define PERLIO_TERM                           \
4041         STMT_START {                            \
4042                 PerlIO_teardown();              \
4043                 MUTEX_DESTROY(&PL_perlio_mutex);\
4044         } STMT_END
4045 # else
4046 #  define PERLIO_INIT
4047 #  define PERLIO_TERM   PerlIO_teardown()
4048 # endif
4049 #else
4050 #  define PERLIO_INIT
4051 #  define PERLIO_TERM
4052 #endif
4053
4054 #ifdef MYMALLOC
4055 #  ifdef MUTEX_INIT_CALLS_MALLOC
4056 #    define MALLOC_INIT                                 \
4057         STMT_START {                                    \
4058                 PL_malloc_mutex = NULL;                 \
4059                 MUTEX_INIT(&PL_malloc_mutex);           \
4060         } STMT_END
4061 #    define MALLOC_TERM                                 \
4062         STMT_START {                                    \
4063                 perl_mutex tmp = PL_malloc_mutex;       \
4064                 PL_malloc_mutex = NULL;                 \
4065                 MUTEX_DESTROY(&tmp);                    \
4066         } STMT_END
4067 #  else
4068 #    define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4069 #    define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4070 #  endif
4071 #else
4072 #  define MALLOC_INIT
4073 #  define MALLOC_TERM
4074 #endif
4075
4076 #if defined(PERL_IMPLICIT_CONTEXT)
4077
4078 struct perl_memory_debug_header;
4079 struct perl_memory_debug_header {
4080   tTHX  interpreter;
4081 #  if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4082   MEM_SIZE size;
4083 #  endif
4084   struct perl_memory_debug_header *prev;
4085   struct perl_memory_debug_header *next;
4086 #  ifdef PERL_DEBUG_READONLY_COW
4087   bool readonly;
4088 #  endif
4089 };
4090
4091 #elif defined(PERL_DEBUG_READONLY_COW)
4092
4093 struct perl_memory_debug_header;
4094 struct perl_memory_debug_header {
4095   MEM_SIZE size;
4096 };
4097
4098 #endif
4099
4100 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4101
4102 #  define PERL_MEMORY_DEBUG_HEADER_SIZE \
4103         (sizeof(struct perl_memory_debug_header) + \
4104         (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4105          %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4106
4107 #else
4108 #  define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4109 #endif
4110
4111 #ifdef PERL_TRACK_MEMPOOL
4112 # ifdef PERL_DEBUG_READONLY_COW
4113 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4114         STMT_START {                                            \
4115                 (header).interpreter = (interp);                \
4116                 (header).prev = (header).next = &(header);      \
4117                 (header).readonly = 0;                          \
4118         } STMT_END
4119 # else
4120 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4121         STMT_START {                                            \
4122                 (header).interpreter = (interp);                \
4123                 (header).prev = (header).next = &(header);      \
4124         } STMT_END
4125 # endif
4126 # else
4127 #  define INIT_TRACK_MEMPOOL(header, interp)
4128 #endif
4129
4130 #ifdef I_MALLOCMALLOC
4131 /* Needed for malloc_size(), malloc_good_size() on some systems */
4132 #  include <malloc/malloc.h>
4133 #endif
4134
4135 #ifdef MYMALLOC
4136 #  define Perl_safesysmalloc_size(where)        Perl_malloced_size(where)
4137 #else
4138 #  if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4139 #    ifdef PERL_TRACK_MEMPOOL
4140 #       define Perl_safesysmalloc_size(where)                   \
4141             (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4142 #    else
4143 #       define Perl_safesysmalloc_size(where) malloc_size(where)
4144 #    endif
4145 #  endif
4146 #  ifdef HAS_MALLOC_GOOD_SIZE
4147 #    ifdef PERL_TRACK_MEMPOOL
4148 #       define Perl_malloc_good_size(how_much)                  \
4149             (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4150 #    else
4151 #       define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4152 #    endif
4153 #  else
4154 /* Having this as the identity operation makes some code simpler.  */
4155 #       define Perl_malloc_good_size(how_much)  (how_much)
4156 #  endif
4157 #endif
4158
4159 typedef int (*runops_proc_t)(pTHX);
4160 typedef void (*share_proc_t) (pTHX_ SV *sv);
4161 typedef int  (*thrhook_proc_t) (pTHX);
4162 typedef OP* (*PPADDR_t[]) (pTHX);
4163 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4164 typedef void (*despatch_signals_proc_t) (pTHX);
4165
4166 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4167 #  include <crt_externs.h>      /* for the env array */
4168 #  define environ (*_NSGetEnviron())
4169 #else
4170    /* VMS and some other platforms don't use the environ array */
4171 #  ifdef USE_ENVIRON_ARRAY
4172 #    if !defined(DONT_DECLARE_STD) || \
4173         (defined(__svr4__) && defined(__GNUC__) && defined(__sun)) || \
4174         defined(__sgi)
4175 extern char **  environ;        /* environment variables supplied via exec */
4176 #    endif
4177 #  endif
4178 #endif
4179
4180 #define PERL_PATCHLEVEL_H_IMPLICIT
4181 #include "patchlevel.h"
4182 #undef PERL_PATCHLEVEL_H_IMPLICIT
4183
4184 #define PERL_VERSION_STRING     STRINGIFY(PERL_REVISION) "." \
4185                                 STRINGIFY(PERL_VERSION) "." \
4186                                 STRINGIFY(PERL_SUBVERSION)
4187
4188 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4189                                 STRINGIFY(PERL_API_VERSION) "." \
4190                                 STRINGIFY(PERL_API_SUBVERSION)
4191
4192 START_EXTERN_C
4193
4194 /* handy constants */
4195 EXTCONST char PL_warn_uninit[]
4196   INIT("Use of uninitialized value%s%s%s");
4197 EXTCONST char PL_warn_uninit_sv[]
4198   INIT("Use of uninitialized value%" SVf "%s%s");
4199 EXTCONST char PL_warn_nosemi[]
4200   INIT("Semicolon seems to be missing");
4201 EXTCONST char PL_warn_reserved[]
4202   INIT("Unquoted string \"%s\" may clash with future reserved word");
4203 EXTCONST char PL_warn_nl[]
4204   INIT("Unsuccessful %s on filename containing newline");
4205 EXTCONST char PL_no_wrongref[]
4206   INIT("Can't use %s ref as %s ref");
4207 /* The core no longer needs these here. If you require the string constant,
4208    please inline a copy into your own code.  */
4209 EXTCONST char PL_no_symref[] __attribute__deprecated__
4210   INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4211 EXTCONST char PL_no_symref_sv[] __attribute__deprecated__
4212   INIT("Can't use string (\"%" SVf32 "\") as %s ref while \"strict refs\" in use");
4213 EXTCONST char PL_no_usym[]
4214   INIT("Can't use an undefined value as %s reference");
4215 EXTCONST char PL_no_aelem[]
4216   INIT("Modification of non-creatable array value attempted, subscript %d");
4217 EXTCONST char PL_no_helem_sv[]
4218   INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4219 EXTCONST char PL_no_modify[]
4220   INIT("Modification of a read-only value attempted");
4221 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4222   INIT("Out of memory!\n");
4223 EXTCONST char PL_no_security[]
4224   INIT("Insecure dependency in %s%s");
4225 EXTCONST char PL_no_sock_func[]
4226   INIT("Unsupported socket function \"%s\" called");
4227 EXTCONST char PL_no_dir_func[]
4228   INIT("Unsupported directory function \"%s\" called");
4229 EXTCONST char PL_no_func[]
4230   INIT("The %s function is unimplemented");
4231 EXTCONST char PL_no_myglob[]
4232   INIT("\"%s\" variable %s can't be in a package");
4233 EXTCONST char PL_no_localize_ref[]
4234   INIT("Can't localize through a reference");
4235 EXTCONST char PL_memory_wrap[]
4236   INIT("panic: memory wrap");
4237
4238 EXTCONST char PL_Yes[]
4239   INIT("1");
4240 EXTCONST char PL_No[]
4241   INIT("");
4242 EXTCONST char PL_hexdigit[]
4243   INIT("0123456789abcdef0123456789ABCDEF");
4244
4245 /* This is constant on most architectures, a global on OS/2 */
4246 #ifndef OS2
4247 EXTCONST char PL_sh_path[]
4248   INIT(SH_PATH); /* full path of shell */
4249 #endif
4250
4251 #ifdef CSH
4252 EXTCONST char PL_cshname[]
4253   INIT(CSH);
4254 #  define PL_cshlen     (sizeof(CSH "") - 1)
4255 #endif
4256
4257 /* These are baked at compile time into any shared perl library.
4258    In future releases this will allow us in main() to sanity test the
4259    library we're linking against.  */
4260
4261 EXTCONST U8 PL_revision
4262   INIT(PERL_REVISION);
4263 EXTCONST U8 PL_version
4264   INIT(PERL_VERSION);
4265 EXTCONST U8 PL_subversion
4266   INIT(PERL_SUBVERSION);
4267
4268 EXTCONST char PL_uuemap[65]
4269   INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4270
4271 #ifdef DOINIT
4272 EXTCONST char PL_uudmap[256] =
4273 #  ifdef PERL_MICRO
4274 #    include "uuudmap.h"
4275 #  else
4276 #    include "uudmap.h"
4277 #  endif
4278 ;
4279 EXTCONST char PL_bitcount[256] =
4280 #  ifdef PERL_MICRO
4281 #    include "ubitcount.h"
4282 #else
4283 #    include "bitcount.h"
4284 #  endif
4285 ;
4286 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4287 EXTCONST int         PL_sig_num[]  = { SIG_NUM };
4288 #else
4289 EXTCONST char PL_uudmap[256];
4290 EXTCONST char PL_bitcount[256];
4291 EXTCONST char* const PL_sig_name[];
4292 EXTCONST int         PL_sig_num[];
4293 #endif
4294
4295 /* fast conversion and case folding tables.  The folding tables complement the
4296  * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4297  * folds such as outside the range or to multiple characters. */
4298
4299 #ifdef DOINIT
4300 #ifndef EBCDIC
4301
4302 /* The EBCDIC fold table depends on the code page, and hence is found in
4303  * utfebcdic.h */
4304
4305 EXTCONST  unsigned char PL_fold[] = {
4306         0,      1,      2,      3,      4,      5,      6,      7,
4307         8,      9,      10,     11,     12,     13,     14,     15,
4308         16,     17,     18,     19,     20,     21,     22,     23,
4309         24,     25,     26,     27,     28,     29,     30,     31,
4310         32,     33,     34,     35,     36,     37,     38,     39,
4311         40,     41,     42,     43,     44,     45,     46,     47,
4312         48,     49,     50,     51,     52,     53,     54,     55,
4313         56,     57,     58,     59,     60,     61,     62,     63,
4314         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4315         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4316         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4317         'x',    'y',    'z',    91,     92,     93,     94,     95,
4318         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4319         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4320         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4321         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4322         128,    129,    130,    131,    132,    133,    134,    135,
4323         136,    137,    138,    139,    140,    141,    142,    143,
4324         144,    145,    146,    147,    148,    149,    150,    151,
4325         152,    153,    154,    155,    156,    157,    158,    159,
4326         160,    161,    162,    163,    164,    165,    166,    167,
4327         168,    169,    170,    171,    172,    173,    174,    175,
4328         176,    177,    178,    179,    180,    181,    182,    183,
4329         184,    185,    186,    187,    188,    189,    190,    191,
4330         192,    193,    194,    195,    196,    197,    198,    199,
4331         200,    201,    202,    203,    204,    205,    206,    207,
4332         208,    209,    210,    211,    212,    213,    214,    215,
4333         216,    217,    218,    219,    220,    221,    222,    223,    
4334         224,    225,    226,    227,    228,    229,    230,    231,
4335         232,    233,    234,    235,    236,    237,    238,    239,
4336         240,    241,    242,    243,    244,    245,    246,    247,
4337         248,    249,    250,    251,    252,    253,    254,    255
4338 };
4339 EXTCONST  unsigned char PL_fold_latin1[] = {
4340     /* Full latin1 complement folding, except for three problematic code points:
4341      *  Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4342      *  fold complements outside the Latin1 range, so can't match something
4343      *  that isn't in utf8.
4344      *  German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4345      *  not one, so can't be represented in this table.
4346      *
4347      * All have to be specially handled */
4348         0,      1,      2,      3,      4,      5,      6,      7,
4349         8,      9,      10,     11,     12,     13,     14,     15,
4350         16,     17,     18,     19,     20,     21,     22,     23,
4351         24,     25,     26,     27,     28,     29,     30,     31,
4352         32,     33,     34,     35,     36,     37,     38,     39,
4353         40,     41,     42,     43,     44,     45,     46,     47,
4354         48,     49,     50,     51,     52,     53,     54,     55,
4355         56,     57,     58,     59,     60,     61,     62,     63,
4356         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4357         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4358         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4359         'x',    'y',    'z',    91,     92,     93,     94,     95,
4360         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4361         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4362         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4363         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4364         128,    129,    130,    131,    132,    133,    134,    135,
4365         136,    137,    138,    139,    140,    141,    142,    143,
4366         144,    145,    146,    147,    148,    149,    150,    151,
4367         152,    153,    154,    155,    156,    157,    158,    159,
4368         160,    161,    162,    163,    164,    165,    166,    167,
4369         168,    169,    170,    171,    172,    173,    174,    175,
4370         176,    177,    178,    179,    180,    181 /*micro */, 182,    183,
4371         184,    185,    186,    187,    188,    189,    190,    191,
4372         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4373         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4374         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4375         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
4376         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4377         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4378         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4379         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
4380         255 /* y with diaeresis */
4381 };
4382
4383 /* If these tables are accessed through ebcdic, the access will be converted to
4384  * latin1 first */
4385 EXTCONST  unsigned char PL_latin1_lc[] = {  /* lowercasing */
4386         0,      1,      2,      3,      4,      5,      6,      7,
4387         8,      9,      10,     11,     12,     13,     14,     15,
4388         16,     17,     18,     19,     20,     21,     22,     23,
4389         24,     25,     26,     27,     28,     29,     30,     31,
4390         32,     33,     34,     35,     36,     37,     38,     39,
4391         40,     41,     42,     43,     44,     45,     46,     47,
4392         48,     49,     50,     51,     52,     53,     54,     55,
4393         56,     57,     58,     59,     60,     61,     62,     63,
4394         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4395         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4396         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4397         'x',    'y',    'z',    91,     92,     93,     94,     95,
4398         96,     97,     98,     99,     100,    101,    102,    103,
4399         104,    105,    106,    107,    108,    109,    110,    111,
4400         112,    113,    114,    115,    116,    117,    118,    119,
4401         120,    121,    122,    123,    124,    125,    126,    127,
4402         128,    129,    130,    131,    132,    133,    134,    135,
4403         136,    137,    138,    139,    140,    141,    142,    143,
4404         144,    145,    146,    147,    148,    149,    150,    151,
4405         152,    153,    154,    155,    156,    157,    158,    159,
4406         160,    161,    162,    163,    164,    165,    166,    167,
4407         168,    169,    170,    171,    172,    173,    174,    175,
4408         176,    177,    178,    179,    180,    181,    182,    183,
4409         184,    185,    186,    187,    188,    189,    190,    191,
4410         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4411         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4412         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4413         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223,    
4414         224,    225,    226,    227,    228,    229,    230,    231,
4415         232,    233,    234,    235,    236,    237,    238,    239,
4416         240,    241,    242,    243,    244,    245,    246,    247,
4417         248,    249,    250,    251,    252,    253,    254,    255
4418 };
4419
4420 /* upper and title case of latin1 characters, modified so that the three tricky
4421  * ones are mapped to 255 (which is one of the three) */
4422 EXTCONST  unsigned char PL_mod_latin1_uc[] = {
4423         0,      1,      2,      3,      4,      5,      6,      7,
4424         8,      9,      10,     11,     12,     13,     14,     15,
4425         16,     17,     18,     19,     20,     21,     22,     23,
4426         24,     25,     26,     27,     28,     29,     30,     31,
4427         32,     33,     34,     35,     36,     37,     38,     39,
4428         40,     41,     42,     43,     44,     45,     46,     47,
4429         48,     49,     50,     51,     52,     53,     54,     55,
4430         56,     57,     58,     59,     60,     61,     62,     63,
4431         64,     65,     66,     67,     68,     69,     70,     71,
4432         72,     73,     74,     75,     76,     77,     78,     79,
4433         80,     81,     82,     83,     84,     85,     86,     87,
4434         88,     89,     90,     91,     92,     93,     94,     95,
4435         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4436         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4437         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4438         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4439         128,    129,    130,    131,    132,    133,    134,    135,
4440         136,    137,    138,    139,    140,    141,    142,    143,
4441         144,    145,    146,    147,    148,    149,    150,    151,
4442         152,    153,    154,    155,    156,    157,    158,    159,
4443         160,    161,    162,    163,    164,    165,    166,    167,
4444         168,    169,    170,    171,    172,    173,    174,    175,
4445         176,    177,    178,    179,    180,    255 /*micro*/,  182,    183,
4446         184,    185,    186,    187,    188,    189,    190,    191,
4447         192,    193,    194,    195,    196,    197,    198,    199,
4448         200,    201,    202,    203,    204,    205,    206,    207,
4449         208,    209,    210,    211,    212,    213,    214,    215,
4450         216,    217,    218,    219,    220,    221,    222,    255 /*sharp s*/,        
4451         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4452         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4453         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4454         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32, 255
4455 };
4456 #endif  /* !EBCDIC, but still in DOINIT */
4457 #else   /* ! DOINIT */
4458 #   ifndef EBCDIC
4459 EXTCONST unsigned char PL_fold[];
4460 EXTCONST unsigned char PL_fold_latin1[];
4461 EXTCONST unsigned char PL_mod_latin1_uc[];
4462 EXTCONST unsigned char PL_latin1_lc[];
4463 #   endif
4464 #endif
4465
4466 #ifndef PERL_GLOBAL_STRUCT /* or perlvars.h */
4467 #ifdef DOINIT
4468 EXT unsigned char PL_fold_locale[] = { /* Unfortunately not EXTCONST. */
4469         0,      1,      2,      3,      4,      5,      6,      7,
4470         8,      9,      10,     11,     12,     13,     14,     15,
4471         16,     17,     18,     19,     20,     21,     22,     23,
4472         24,     25,     26,     27,     28,     29,     30,     31,
4473         32,     33,     34,     35,     36,     37,     38,     39,
4474         40,     41,     42,     43,     44,     45,     46,     47,
4475         48,     49,     50,     51,     52,     53,     54,     55,
4476         56,     57,     58,     59,     60,     61,     62,     63,
4477         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4478         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4479         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4480         'x',    'y',    'z',    91,     92,     93,     94,     95,
4481         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4482         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4483         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4484         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4485         128,    129,    130,    131,    132,    133,    134,    135,
4486         136,    137,    138,    139,    140,    141,    142,    143,
4487         144,    145,    146,    147,    148,    149,    150,    151,
4488         152,    153,    154,    155,    156,    157,    158,    159,
4489         160,    161,    162,    163,    164,    165,    166,    167,
4490         168,    169,    170,    171,    172,    173,    174,    175,
4491         176,    177,    178,    179,    180,    181,    182,    183,
4492         184,    185,    186,    187,    188,    189,    190,    191,
4493         192,    193,    194,    195,    196,    197,    198,    199,
4494         200,    201,    202,    203,    204,    205,    206,    207,
4495         208,    209,    210,    211,    212,    213,    214,    215,
4496         216,    217,    218,    219,    220,    221,    222,    223,    
4497         224,    225,    226,    227,    228,    229,    230,    231,
4498         232,    233,    234,    235,    236,    237,    238,    239,
4499         240,    241,    242,    243,    244,    245,    246,    247,
4500         248,    249,    250,    251,    252,    253,    254,    255
4501 };
4502 #else
4503 EXT unsigned char PL_fold_locale[]; /* Unfortunately not EXTCONST. */
4504 #endif
4505 #endif /* !PERL_GLOBAL_STRUCT */
4506
4507 #ifdef DOINIT
4508 #ifdef EBCDIC
4509 EXTCONST unsigned char PL_freq[] = {/* EBCDIC frequencies for mixed English/C */
4510     1,      2,      84,     151,    154,    155,    156,    157,
4511     165,    246,    250,    3,      158,    7,      18,     29,
4512     40,     51,     62,     73,     85,     96,     107,    118,
4513     129,    140,    147,    148,    149,    150,    152,    153,
4514     255,      6,      8,      9,     10,     11,     12,     13,
4515      14,     15,     24,     25,     26,     27,     28,    226,
4516      29,     30,     31,     32,     33,     43,     44,     45,
4517      46,     47,     48,     49,     50,     76,     77,     78,
4518      79,     80,     81,     82,     83,     84,     85,     86,
4519      87,     94,     95,    234,    181,    233,    187,    190,
4520     180,     96,     97,     98,     99,    100,    101,    102,
4521     104,    112,    182,    174,    236,    232,    229,    103,
4522     228,    226,    114,    115,    116,    117,    118,    119,
4523     120,    121,    122,    235,    176,    230,    194,    162,
4524     130,    131,    132,    133,    134,    135,    136,    137,
4525     138,    139,    201,    205,    163,    217,    220,    224,
4526     5,      248,    227,    244,    242,    255,    241,    231,
4527     240,    253,    16,     197,    19,     20,     21,     187,
4528     23,     169,    210,    245,    237,    249,    247,    239,
4529     168,    252,    34,     196,    36,     37,     38,     39,
4530     41,     42,     251,    254,    238,    223,    221,    213,
4531     225,    177,    52,     53,     54,     55,     56,     57,
4532     58,     59,     60,     61,     63,     64,     65,     66,
4533     67,     68,     69,     70,     71,     72,     74,     75,
4534     205,    208,    186,    202,    200,    218,    198,    179,
4535     178,    214,    88,     89,     90,     91,     92,     93,
4536     217,    166,    170,    207,    199,    209,    206,    204,
4537     160,    212,    105,    106,    108,    109,    110,    111,
4538     203,    113,    216,    215,    192,    175,    193,    243,
4539     172,    161,    123,    124,    125,    126,    127,    128,
4540     222,    219,    211,    195,    188,    193,    185,    184,
4541     191,    183,    141,    142,    143,    144,    145,    146
4542 };
4543 #else  /* ascii rather than ebcdic */
4544 EXTCONST unsigned char PL_freq[] = {    /* letter frequencies for mixed English/C */
4545         1,      2,      84,     151,    154,    155,    156,    157,
4546         165,    246,    250,    3,      158,    7,      18,     29,
4547         40,     51,     62,     73,     85,     96,     107,    118,
4548         129,    140,    147,    148,    149,    150,    152,    153,
4549         255,    182,    224,    205,    174,    176,    180,    217,
4550         233,    232,    236,    187,    235,    228,    234,    226,
4551         222,    219,    211,    195,    188,    193,    185,    184,
4552         191,    183,    201,    229,    181,    220,    194,    162,
4553         163,    208,    186,    202,    200,    218,    198,    179,
4554         178,    214,    166,    170,    207,    199,    209,    206,
4555         204,    160,    212,    216,    215,    192,    175,    173,
4556         243,    172,    161,    190,    203,    189,    164,    230,
4557         167,    248,    227,    244,    242,    255,    241,    231,
4558         240,    253,    169,    210,    245,    237,    249,    247,
4559         239,    168,    252,    251,    254,    238,    223,    221,
4560         213,    225,    177,    197,    171,    196,    159,    4,
4561         5,      6,      8,      9,      10,     11,     12,     13,
4562         14,     15,     16,     17,     19,     20,     21,     22,
4563         23,     24,     25,     26,     27,     28,     30,     31,
4564         32,     33,     34,     35,     36,     37,     38,     39,
4565         41,     42,     43,     44,     45,     46,     47,     48,
4566         49,     50,     52,     53,     54,     55,     56,     57,
4567         58,     59,     60,     61,     63,     64,     65,     66,
4568         67,     68,     69,     70,     71,     72,     74,     75,
4569         76,     77,     78,     79,     80,     81,     82,     83,
4570         86,     87,     88,     89,     90,     91,     92,     93,
4571         94,     95,     97,     98,     99,     100,    101,    102,
4572         103,    104,    105,    106,    108,    109,    110,    111,
4573         112,    113,    114,    115,    116,    117,    119,    120,
4574         121,    122,    123,    124,    125,    126,    127,    128,
4575         130,    131,    132,    133,    134,    135,    136,    137,
4576         138,    139,    141,    142,    143,    144,    145,    146
4577 };
4578 #endif
4579 #else
4580 EXTCONST unsigned char PL_freq[];
4581 #endif
4582
4583 /* Although only used for debugging, these constants must be available in
4584  * non-debugging builds too, since they're used in ext/re/re_exec.c,
4585  * which has DEBUGGING enabled always */
4586 #ifdef DOINIT
4587 EXTCONST char* const PL_block_type[] = {
4588         "NULL",
4589         "WHEN",
4590         "BLOCK",
4591         "GIVEN",
4592         "LOOP_FOR",
4593         "LOOP_PLAIN",
4594         "LOOP_LAZYSV",
4595         "LOOP_LAZYIV",
4596         "SUB",
4597         "FORMAT",
4598         "EVAL",
4599         "SUBST"
4600 };
4601 #else
4602 EXTCONST char* PL_block_type[];
4603 #endif
4604
4605 /* These are all the compile time options that affect binary compatibility.
4606    Other compile time options that are binary compatible are in perl.c
4607    Both are combined for the output of perl -V
4608    However, this string will be embedded in any shared perl library, which will
4609    allow us add a comparison check in perlmain.c in the near future.  */
4610 #ifdef DOINIT
4611 EXTCONST char PL_bincompat_options[] =
4612 #  ifdef DEBUG_LEAKING_SCALARS
4613                              " DEBUG_LEAKING_SCALARS"
4614 #  endif
4615 #  ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4616                              " DEBUG_LEAKING_SCALARS_FORK_DUMP"
4617 #  endif
4618 #  ifdef FCRYPT
4619                              " FCRYPT"
4620 #  endif
4621 #  ifdef HAS_TIMES
4622                              " HAS_TIMES"
4623 #  endif
4624 #  ifdef HAVE_INTERP_INTERN
4625                              " HAVE_INTERP_INTERN"
4626 #  endif
4627 #  ifdef MULTIPLICITY
4628                              " MULTIPLICITY"
4629 #  endif
4630 #  ifdef MYMALLOC
4631                              " MYMALLOC"
4632 #  endif
4633 #  ifdef PERLIO_LAYERS
4634                              " PERLIO_LAYERS"
4635 #  endif
4636 #  ifdef PERL_DEBUG_READONLY_COW
4637                              " PERL_DEBUG_READONLY_COW"
4638 #  endif
4639 #  ifdef PERL_DEBUG_READONLY_OPS
4640                              " PERL_DEBUG_READONLY_OPS"
4641 #  endif
4642 #  ifdef PERL_GLOBAL_STRUCT
4643                              " PERL_GLOBAL_STRUCT"
4644 #  endif
4645 #  ifdef PERL_IMPLICIT_CONTEXT
4646                              " PERL_IMPLICIT_CONTEXT"
4647 #  endif
4648 #  ifdef PERL_IMPLICIT_SYS
4649                              " PERL_IMPLICIT_SYS"
4650 #  endif
4651 #  ifdef PERL_MICRO
4652                              " PERL_MICRO"
4653 #  endif
4654 #  ifdef PERL_NEED_APPCTX
4655                              " PERL_NEED_APPCTX"
4656 #  endif
4657 #  ifdef PERL_NEED_TIMESBASE
4658                              " PERL_NEED_TIMESBASE"
4659 #  endif
4660 #  ifdef PERL_OLD_COPY_ON_WRITE
4661                              " PERL_OLD_COPY_ON_WRITE"
4662 #  endif
4663 #  ifdef PERL_POISON
4664                              " PERL_POISON"
4665 #  endif
4666 #  ifdef PERL_SAWAMPERSAND
4667                              " PERL_SAWAMPERSAND"
4668 #  endif
4669 #  ifdef PERL_TRACK_MEMPOOL
4670                              " PERL_TRACK_MEMPOOL"
4671 #  endif
4672 #  ifdef PERL_USES_PL_PIDSTATUS
4673                              " PERL_USES_PL_PIDSTATUS"
4674 #  endif
4675 #  ifdef USE_64_BIT_ALL
4676                              " USE_64_BIT_ALL"
4677 #  endif
4678 #  ifdef USE_64_BIT_INT
4679                              " USE_64_BIT_INT"
4680 #  endif
4681 #  ifdef USE_IEEE
4682                              " USE_IEEE"
4683 #  endif
4684 #  ifdef USE_ITHREADS
4685                              " USE_ITHREADS"
4686 #  endif
4687 #  ifdef USE_LARGE_FILES
4688                              " USE_LARGE_FILES"
4689 #  endif
4690 #  ifdef USE_LOCALE_COLLATE
4691                              " USE_LOCALE_COLLATE"
4692 #  endif
4693 #  ifdef USE_LOCALE_NUMERIC
4694                              " USE_LOCALE_NUMERIC"
4695 #  endif
4696 #  ifdef USE_LOCALE_TIME
4697                              " USE_LOCALE_TIME"
4698 #  endif
4699 #  ifdef USE_LONG_DOUBLE
4700                              " USE_LONG_DOUBLE"
4701 #  endif
4702 #  ifdef USE_PERLIO
4703                              " USE_PERLIO"
4704 #  endif
4705 #  ifdef USE_REENTRANT_API
4706                              " USE_REENTRANT_API"
4707 #  endif
4708 #  ifdef USE_SOCKS
4709                              " USE_SOCKS"
4710 #  endif
4711 #  ifdef VMS_DO_SOCKETS
4712                              " VMS_DO_SOCKETS"
4713 #  endif
4714 #  ifdef VMS_SHORTEN_LONG_SYMBOLS
4715                              " VMS_SHORTEN_LONG_SYMBOLS"
4716 #  endif
4717 #  ifdef VMS_WE_ARE_CASE_SENSITIVE
4718                              " VMS_SYMBOL_CASE_AS_IS"
4719 #  endif
4720   "";
4721 #else
4722 EXTCONST char PL_bincompat_options[];
4723 #endif
4724
4725 #ifndef PERL_SET_PHASE
4726 #  define PERL_SET_PHASE(new_phase) \
4727     PHASE_CHANGE_PROBE(PL_phase_names[new_phase], PL_phase_names[PL_phase]); \
4728     PL_phase = new_phase;
4729 #endif
4730
4731 /* The interpreter phases. If these ever change, PL_phase_names right below will
4732  * need to be updated accordingly. */
4733 enum perl_phase {
4734     PERL_PHASE_CONSTRUCT        = 0,
4735     PERL_PHASE_START            = 1,
4736     PERL_PHASE_CHECK            = 2,
4737     PERL_PHASE_INIT             = 3,
4738     PERL_PHASE_RUN              = 4,
4739     PERL_PHASE_END              = 5,
4740     PERL_PHASE_DESTRUCT         = 6
4741 };
4742
4743 #ifdef DOINIT
4744 EXTCONST char *const PL_phase_names[] = {
4745     "CONSTRUCT",
4746     "START",
4747     "CHECK",
4748     "INIT",
4749     "RUN",
4750     "END",
4751     "DESTRUCT"
4752 };
4753 #else
4754 EXTCONST char *const PL_phase_names[];
4755 #endif
4756
4757 #ifndef PERL_CORE
4758 /* Do not use this macro. It only exists for extensions that rely on PL_dirty
4759  * instead of using the newer PL_phase, which provides everything PL_dirty
4760  * provided, and more. */
4761 #  define PL_dirty (PL_phase == PERL_PHASE_DESTRUCT)
4762
4763 #  define PL_amagic_generation PL_na
4764 #endif /* !PERL_CORE */
4765
4766 #define PL_hints PL_compiling.cop_hints
4767
4768 END_EXTERN_C
4769
4770 /*****************************************************************************/
4771 /* This lexer/parser stuff is currently global since yacc is hard to reenter */
4772 /*****************************************************************************/
4773 /* XXX This needs to be revisited, since BEGIN makes yacc re-enter... */
4774
4775 #ifdef __Lynx__
4776 /* LynxOS defines these in scsi.h which is included via ioctl.h */
4777 #ifdef FORMAT
4778 #undef FORMAT
4779 #endif
4780 #ifdef SPACE
4781 #undef SPACE
4782 #endif
4783 #endif
4784
4785 #define LEX_NOTPARSING          11      /* borrowed from toke.c */
4786
4787 typedef enum {
4788     XOPERATOR,
4789     XTERM,
4790     XREF,
4791     XSTATE,
4792     XBLOCK,
4793     XATTRBLOCK,
4794     XATTRTERM,
4795     XTERMBLOCK,
4796     XPOSTDEREF,
4797     XTERMORDORDOR /* evil hack */
4798     /* update exp_name[] in toke.c if adding to this enum */
4799 } expectation;
4800
4801 /* Hints are now stored in a dedicated U32, so the bottom 8 bits are no longer
4802    special and there is no need for HINT_PRIVATE_MASK for COPs
4803    However, bitops store HINT_INTEGER in their op_private.
4804
4805     NOTE: The typical module using these has the bit value hard-coded, so don't
4806     blindly change the values of these.
4807
4808    If we run out of bits, the 2 locale ones could be combined.  The PARTIAL one
4809    is for "use locale 'FOO'" which excludes some categories.  It requires going
4810    to %^H to find out which are in and which are out.  This could be extended
4811    for the normal case of a plain HINT_LOCALE, so that %^H would be used for
4812    any locale form. */
4813 #define HINT_INTEGER            0x00000001 /* integer pragma */
4814 #define HINT_STRICT_REFS        0x00000002 /* strict pragma */
4815 #define HINT_LOCALE             0x00000004 /* locale pragma */
4816 #define HINT_BYTES              0x00000008 /* bytes pragma */
4817 #define HINT_LOCALE_PARTIAL     0x00000010 /* locale, but a subset of categories */
4818
4819 #define HINT_EXPLICIT_STRICT_REFS       0x00000020 /* strict.pm */
4820 #define HINT_EXPLICIT_STRICT_SUBS       0x00000040 /* strict.pm */
4821 #define HINT_EXPLICIT_STRICT_VARS       0x00000080 /* strict.pm */
4822
4823 #define HINT_BLOCK_SCOPE        0x00000100
4824 #define HINT_STRICT_SUBS        0x00000200 /* strict pragma */
4825 #define HINT_STRICT_VARS        0x00000400 /* strict pragma */
4826 #define HINT_UNI_8_BIT          0x00000800 /* unicode_strings feature */
4827
4828 /* The HINT_NEW_* constants are used by the overload pragma */
4829 #define HINT_NEW_INTEGER        0x00001000
4830 #define HINT_NEW_FLOAT          0x00002000
4831 #define HINT_NEW_BINARY         0x00004000
4832 #define HINT_NEW_STRING         0x00008000
4833 #define HINT_NEW_RE             0x00010000
4834 #define HINT_LOCALIZE_HH        0x00020000 /* %^H needs to be copied */
4835 #define HINT_LEXICAL_IO_IN      0x00040000 /* ${^OPEN} is set for input */
4836 #define HINT_LEXICAL_IO_OUT     0x00080000 /* ${^OPEN} is set for output */
4837
4838 #define HINT_RE_TAINT           0x00100000 /* re pragma */
4839 #define HINT_RE_EVAL            0x00200000 /* re pragma */
4840
4841 #define HINT_FILETEST_ACCESS    0x00400000 /* filetest pragma */
4842 #define HINT_UTF8               0x00800000 /* utf8 pragma */
4843
4844 #define HINT_NO_AMAGIC          0x01000000 /* overloading pragma */
4845
4846 #define HINT_RE_FLAGS           0x02000000 /* re '/xism' pragma */
4847
4848 #define HINT_FEATURE_MASK       0x1c000000 /* 3 bits for feature bundles */
4849
4850                                 /* Note: Used for NATIVE_HINTS, currently
4851                                    defined by vms/vmsish.h:
4852                                 0x40000000
4853                                 0x80000000
4854                                  */
4855
4856 /* The following are stored in $^H{sort}, not in PL_hints */
4857 #define HINT_SORT_SORT_BITS     0x000000FF /* allow 256 different ones */
4858 #define HINT_SORT_QUICKSORT     0x00000001
4859 #define HINT_SORT_MERGESORT     0x00000002
4860 #define HINT_SORT_STABLE        0x00000100 /* sort styles (currently one) */
4861
4862 /* flags for PL_sawampersand */
4863
4864 #define SAWAMPERSAND_LEFT       1   /* saw $` */
4865 #define SAWAMPERSAND_MIDDLE     2   /* saw $& */
4866 #define SAWAMPERSAND_RIGHT      4   /* saw $' */
4867
4868 #ifndef PERL_SAWAMPERSAND
4869 # define PL_sawampersand \
4870         (SAWAMPERSAND_LEFT|SAWAMPERSAND_MIDDLE|SAWAMPERSAND_RIGHT)
4871 #endif
4872
4873 /* Various states of the input record separator SV (rs) */
4874 #define RsSNARF(sv)   (! SvOK(sv))
4875 #define RsSIMPLE(sv)  (SvOK(sv) && (! SvPOK(sv) || SvCUR(sv)))
4876 #define RsPARA(sv)    (SvPOK(sv) && ! SvCUR(sv))
4877 #define RsRECORD(sv)  (SvROK(sv) && (SvIV(SvRV(sv)) > 0))
4878
4879 /* A struct for keeping various DEBUGGING related stuff,
4880  * neatly packed.  Currently only scratch variables for
4881  * constructing debug output are included.  Needed always,
4882  * not just when DEBUGGING, though, because of the re extension. c*/
4883 struct perl_debug_pad {