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