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