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