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