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