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