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