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