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