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