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