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