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