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