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