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