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