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