This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Let embed.fnc define the my_str_foo() fcns
[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 #endif
1679
1680 #if defined(PERL_CORE) || defined(PERL_EXT)
1681 #  ifdef HAS_MEMRCHR
1682 #    define my_memrchr  memrchr
1683 #  else
1684 #    define my_memrchr  S_my_memrchr
1685 #  endif
1686 #endif
1687
1688 #ifdef HAS_STRLCPY
1689 #  define my_strlcpy    strlcpy
1690 #endif
1691
1692 #ifdef HAS_STRNLEN
1693 #  define my_strnlen    strnlen
1694 #endif
1695
1696 /*
1697     The IV type is supposed to be long enough to hold any integral
1698     value or a pointer.
1699     --Andy Dougherty    August 1996
1700 */
1701
1702 typedef IVTYPE IV;
1703 typedef UVTYPE UV;
1704
1705 #if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
1706 #  if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
1707 #    define IV_MAX INT64_MAX
1708 #    define IV_MIN INT64_MIN
1709 #    define UV_MAX UINT64_MAX
1710 #    ifndef UINT64_MIN
1711 #      define UINT64_MIN 0
1712 #    endif
1713 #    define UV_MIN UINT64_MIN
1714 #  else
1715 #    define IV_MAX PERL_QUAD_MAX
1716 #    define IV_MIN PERL_QUAD_MIN
1717 #    define UV_MAX PERL_UQUAD_MAX
1718 #    define UV_MIN PERL_UQUAD_MIN
1719 #  endif
1720 #  define IV_IS_QUAD
1721 #  define UV_IS_QUAD
1722 #else
1723 #  if defined(INT32_MAX) && IVSIZE == 4
1724 #    define IV_MAX INT32_MAX
1725 #    define IV_MIN INT32_MIN
1726 #    ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
1727 #        define UV_MAX UINT32_MAX
1728 #    else
1729 #        define UV_MAX 4294967295U
1730 #    endif
1731 #    ifndef UINT32_MIN
1732 #      define UINT32_MIN 0
1733 #    endif
1734 #    define UV_MIN UINT32_MIN
1735 #  else
1736 #    define IV_MAX PERL_LONG_MAX
1737 #    define IV_MIN PERL_LONG_MIN
1738 #    define UV_MAX PERL_ULONG_MAX
1739 #    define UV_MIN PERL_ULONG_MIN
1740 #  endif
1741 #  if IVSIZE == 8
1742 #    define IV_IS_QUAD
1743 #    define UV_IS_QUAD
1744 #    ifndef HAS_QUAD
1745 #      define HAS_QUAD
1746 #    endif
1747 #  else
1748 #    undef IV_IS_QUAD
1749 #    undef UV_IS_QUAD
1750 #if !defined(PERL_CORE) || defined(USING_MSVC6)
1751 /* We think that removing this decade-old undef this will cause too much
1752    breakage on CPAN for too little gain. (See RT #119753)
1753    However, we do need HAS_QUAD in the core for use by the drand48 code,
1754    but not for Win32 VC6 because it has poor __int64 support. */
1755 #    undef HAS_QUAD
1756 #endif
1757 #  endif
1758 #endif
1759
1760 #define Size_t_MAX (~(Size_t)0)
1761 #define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
1762
1763 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
1764 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
1765
1766 #ifndef NO_PERL_PRESERVE_IVUV
1767 #define PERL_PRESERVE_IVUV      /* We like our integers to stay integers. */
1768 #endif
1769
1770 /*
1771  *  The macros INT2PTR and NUM2PTR are (despite their names)
1772  *  bi-directional: they will convert int/float to or from pointers.
1773  *  However the conversion to int/float are named explicitly:
1774  *  PTR2IV, PTR2UV, PTR2NV.
1775  *
1776  *  For int conversions we do not need two casts if pointers are
1777  *  the same size as IV and UV.   Otherwise we need an explicit
1778  *  cast (PTRV) to avoid compiler warnings.
1779  */
1780 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1781 #  define PTRV                  UV
1782 #  define INT2PTR(any,d)        (any)(d)
1783 #elif PTRSIZE == LONGSIZE
1784 #  define PTRV                  unsigned long
1785 #  define PTR2ul(p)             (unsigned long)(p)
1786 #else
1787 #  define PTRV                  unsigned
1788 #endif
1789
1790 #ifndef INT2PTR
1791 #  define INT2PTR(any,d)        (any)(PTRV)(d)
1792 #endif
1793
1794 #ifndef PTR2ul
1795 #  define PTR2ul(p)     INT2PTR(unsigned long,p)        
1796 #endif
1797
1798 #define NUM2PTR(any,d)  (any)(PTRV)(d)
1799 #define PTR2IV(p)       INT2PTR(IV,p)
1800 #define PTR2UV(p)       INT2PTR(UV,p)
1801 #define PTR2NV(p)       NUM2PTR(NV,p)
1802 #define PTR2nat(p)      (PTRV)(p)       /* pointer to integer of PTRSIZE */
1803
1804 /* According to strict ANSI C89 one cannot freely cast between
1805  * data pointers and function (code) pointers.  There are at least
1806  * two ways around this.  One (used below) is to do two casts,
1807  * first the other pointer to an (unsigned) integer, and then
1808  * the integer to the other pointer.  The other way would be
1809  * to use unions to "overlay" the pointers.  For an example of
1810  * the latter technique, see union dirpu in struct xpvio in sv.h.
1811  * The only feasible use is probably temporarily storing
1812  * function pointers in a data pointer (such as a void pointer). */
1813
1814 #define DPTR2FPTR(t,p) ((t)PTR2nat(p))  /* data pointer to function pointer */
1815 #define FPTR2DPTR(t,p) ((t)PTR2nat(p))  /* function pointer to data pointer */
1816
1817 #ifdef USE_LONG_DOUBLE
1818 #  if LONG_DOUBLESIZE == DOUBLESIZE
1819 #    define LONG_DOUBLE_EQUALS_DOUBLE
1820 #    undef USE_LONG_DOUBLE /* Ouch! */
1821 #  endif
1822 #endif
1823
1824 /* The following is all to get LDBL_DIG, in order to pick a nice
1825    default value for printing floating point numbers in Gconvert.
1826    (see config.h)
1827 */
1828 #ifndef HAS_LDBL_DIG
1829 #  if LONG_DOUBLESIZE == 10
1830 #    define LDBL_DIG 18 /* assume IEEE */
1831 #  elif LONG_DOUBLESIZE == 12
1832 #    define LDBL_DIG 18 /* gcc? */
1833 #  elif LONG_DOUBLESIZE == 16
1834 #    define LDBL_DIG 33 /* assume IEEE */
1835 #  elif LONG_DOUBLESIZE == DOUBLESIZE
1836 #    define LDBL_DIG DBL_DIG /* bummer */
1837 #  endif
1838 #endif
1839
1840 typedef NVTYPE NV;
1841
1842 #ifdef I_IEEEFP
1843 #   include <ieeefp.h>
1844 #endif
1845
1846 #ifdef USING_MSVC6
1847 /* VC6 has broken NaN semantics: NaN == NaN returns true instead of false,
1848  * and for example NaN < IV_MIN. */
1849 #  define NAN_COMPARE_BROKEN
1850 #endif
1851 #if defined(__DECC) && defined(__osf__)
1852 /* Also Tru64 cc has broken NaN comparisons. */
1853 #  define NAN_COMPARE_BROKEN
1854 #endif
1855 #if defined(__sgi)
1856 #  define NAN_COMPARE_BROKEN
1857 #endif
1858
1859 #ifdef USE_LONG_DOUBLE
1860 #   ifdef I_SUNMATH
1861 #       include <sunmath.h>
1862 #   endif
1863 #   if defined(LDBL_DIG)
1864 #       define NV_DIG LDBL_DIG
1865 #       ifdef LDBL_MANT_DIG
1866 #           define NV_MANT_DIG LDBL_MANT_DIG
1867 #       endif
1868 #       ifdef LDBL_MIN
1869 #           define NV_MIN LDBL_MIN
1870 #       endif
1871 #       ifdef LDBL_MAX
1872 #           define NV_MAX LDBL_MAX
1873 #       endif
1874 #       ifdef LDBL_MIN_EXP
1875 #           define NV_MIN_EXP LDBL_MIN_EXP
1876 #       endif
1877 #       ifdef LDBL_MAX_EXP
1878 #           define NV_MAX_EXP LDBL_MAX_EXP
1879 #       endif
1880 #       ifdef LDBL_MIN_10_EXP
1881 #           define NV_MIN_10_EXP LDBL_MIN_10_EXP
1882 #       endif
1883 #       ifdef LDBL_MAX_10_EXP
1884 #           define NV_MAX_10_EXP LDBL_MAX_10_EXP
1885 #       endif
1886 #       ifdef LDBL_EPSILON
1887 #           define NV_EPSILON LDBL_EPSILON
1888 #       endif
1889 #       ifdef LDBL_MAX
1890 #           define NV_MAX LDBL_MAX
1891 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
1892 #       elif defined(HUGE_VALL)
1893 #           define NV_MAX HUGE_VALL
1894 #       endif
1895 #   endif
1896 #   if defined(HAS_SQRTL)
1897 #       define Perl_acos acosl
1898 #       define Perl_asin asinl
1899 #       define Perl_atan atanl
1900 #       define Perl_atan2 atan2l
1901 #       define Perl_ceil ceill
1902 #       define Perl_cos cosl
1903 #       define Perl_cosh coshl
1904 #       define Perl_exp expl
1905 /* no Perl_fabs, but there's PERL_ABS */
1906 #       define Perl_floor floorl
1907 #       define Perl_fmod fmodl
1908 #       define Perl_log logl
1909 #       define Perl_log10 log10l
1910 #       define Perl_pow powl
1911 #       define Perl_sin sinl
1912 #       define Perl_sinh sinhl
1913 #       define Perl_sqrt sqrtl
1914 #       define Perl_tan tanl
1915 #       define Perl_tanh tanhl
1916 #   endif
1917 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
1918 #   ifndef Perl_modf
1919 #       ifdef HAS_MODFL
1920 #           define Perl_modf(x,y) modfl(x,y)
1921 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
1922    prototype in <math.h> */
1923 #           ifndef HAS_MODFL_PROTO
1924 EXTERN_C long double modfl(long double, long double *);
1925 #           endif
1926 #       elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
1927         extern long double Perl_my_modfl(long double x, long double *ip);
1928 #           define Perl_modf(x,y) Perl_my_modfl(x,y)
1929 #       endif
1930 #   endif
1931 #   ifndef Perl_frexp
1932 #       ifdef HAS_FREXPL
1933 #           define Perl_frexp(x,y) frexpl(x,y)
1934 #       elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
1935 extern long double Perl_my_frexpl(long double x, int *e);
1936 #           define Perl_frexp(x,y) Perl_my_frexpl(x,y)
1937 #       endif
1938 #   endif
1939 #   ifndef Perl_ldexp
1940 #       ifdef HAS_LDEXPL
1941 #           define Perl_ldexp(x, y) ldexpl(x,y)
1942 #       elif defined(HAS_SCALBNL) && FLT_RADIX == 2
1943 #           define Perl_ldexp(x,y) scalbnl(x,y)
1944 #       endif
1945 #   endif
1946 #   ifndef Perl_isnan
1947 #       if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
1948 #           define Perl_isnan(x) isnanl(x)
1949 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
1950 #           define Perl_isnan(x) isnan(x)
1951 #       endif
1952 #   endif
1953 #   ifndef Perl_isinf
1954 #       if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
1955 #           define Perl_isinf(x) isinfl(x)
1956 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
1957 #           define Perl_isinf(x) isinf(x)
1958 #       elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
1959 #           define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
1960 #       endif
1961 #   endif
1962 #   ifndef Perl_isfinite
1963 #       define Perl_isfinite(x) Perl_isfinitel(x)
1964 #   endif
1965 #elif defined(USE_QUADMATH) && defined(I_QUADMATH)
1966 #   include <quadmath.h>
1967 #   define NV_DIG FLT128_DIG
1968 #   define NV_MANT_DIG FLT128_MANT_DIG
1969 #   define NV_MIN FLT128_MIN
1970 #   define NV_MAX FLT128_MAX
1971 #   define NV_MIN_EXP FLT128_MIN_EXP
1972 #   define NV_MAX_EXP FLT128_MAX_EXP
1973 #   define NV_EPSILON FLT128_EPSILON
1974 #   define NV_MIN_10_EXP FLT128_MIN_10_EXP
1975 #   define NV_MAX_10_EXP FLT128_MAX_10_EXP
1976 #   define Perl_acos acosq
1977 #   define Perl_asin asinq
1978 #   define Perl_atan atanq
1979 #   define Perl_atan2 atan2q
1980 #   define Perl_ceil ceilq
1981 #   define Perl_cos cosq
1982 #   define Perl_cosh coshq
1983 #   define Perl_exp expq
1984 /* no Perl_fabs, but there's PERL_ABS */
1985 #   define Perl_floor floorq
1986 #   define Perl_fmod fmodq
1987 #   define Perl_log logq
1988 #   define Perl_log10 log10q
1989 #   define Perl_signbit signbitq
1990 #   define Perl_pow powq
1991 #   define Perl_sin sinq
1992 #   define Perl_sinh sinhq
1993 #   define Perl_sqrt sqrtq
1994 #   define Perl_tan tanq
1995 #   define Perl_tanh tanhq
1996 #   define Perl_modf(x,y) modfq(x,y)
1997 #   define Perl_frexp(x,y) frexpq(x,y)
1998 #   define Perl_ldexp(x, y) ldexpq(x,y)
1999 #   define Perl_isinf(x) isinfq(x)
2000 #   define Perl_isnan(x) isnanq(x)
2001 #   define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
2002 #   define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
2003 #   define Perl_fp_class_inf(x)    (Perl_fp_class(x) == 3)
2004 #   define Perl_fp_class_nan(x)    (Perl_fp_class(x) == 4)
2005 #   define Perl_fp_class_norm(x)   (Perl_fp_class(x) == 1)
2006 #   define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
2007 #   define Perl_fp_class_zero(x)   (Perl_fp_class(x) == 0)
2008 #else
2009 #   define NV_DIG DBL_DIG
2010 #   define NV_MANT_DIG DBL_MANT_DIG
2011 #   define NV_MIN DBL_MIN
2012 #   define NV_MAX DBL_MAX
2013 #   define NV_MIN_EXP DBL_MIN_EXP
2014 #   define NV_MAX_EXP DBL_MAX_EXP
2015 #   define NV_MIN_10_EXP DBL_MIN_10_EXP
2016 #   define NV_MAX_10_EXP DBL_MAX_10_EXP
2017 #   define NV_EPSILON DBL_EPSILON
2018 #   define NV_MAX DBL_MAX
2019 #   define NV_MIN DBL_MIN
2020
2021 /* These math interfaces are C89. */
2022 #   define Perl_acos acos
2023 #   define Perl_asin asin
2024 #   define Perl_atan atan
2025 #   define Perl_atan2 atan2
2026 #   define Perl_ceil ceil
2027 #   define Perl_cos cos
2028 #   define Perl_cosh cosh
2029 #   define Perl_exp exp
2030 /* no Perl_fabs, but there's PERL_ABS */
2031 #   define Perl_floor floor
2032 #   define Perl_fmod fmod
2033 #   define Perl_log log
2034 #   define Perl_log10 log10
2035 #   define Perl_pow pow
2036 #   define Perl_sin sin
2037 #   define Perl_sinh sinh
2038 #   define Perl_sqrt sqrt
2039 #   define Perl_tan tan
2040 #   define Perl_tanh tanh
2041
2042 #   define Perl_modf(x,y) modf(x,y)
2043 #   define Perl_frexp(x,y) frexp(x,y)
2044 #   define Perl_ldexp(x,y) ldexp(x,y)
2045
2046 #   ifndef Perl_isnan
2047 #       ifdef HAS_ISNAN
2048 #           define Perl_isnan(x) isnan(x)
2049 #       endif
2050 #   endif
2051 #   ifndef Perl_isinf
2052 #       if defined(HAS_ISINF)
2053 #           define Perl_isinf(x) isinf(x)
2054 #       elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2055 #           define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
2056 #       endif
2057 #   endif
2058 #   ifndef Perl_isfinite
2059 #     ifdef HAS_ISFINITE
2060 #       define Perl_isfinite(x) isfinite(x)
2061 #     elif defined(HAS_FINITE)
2062 #       define Perl_isfinite(x) finite(x)
2063 #     endif
2064 #   endif
2065 #endif
2066
2067 /* fpclassify(): C99.  It is supposed to be a macro that switches on
2068 * the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
2069 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2070 #    include <math.h>
2071 #    if defined(FP_INFINITE) && defined(FP_NAN)
2072 #        define Perl_fp_class(x)        fpclassify(x)
2073 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
2074 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
2075 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
2076 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2077 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
2078 #    elif defined(FP_PLUS_INF) && defined(FP_QNAN)
2079 /* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
2080  * actually not the C99 fpclassify, with its own set of return defines. */
2081 #        define Perl_fp_class(x)        fpclassify(x)
2082 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PLUS_INF)
2083 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_MINUS_INF)
2084 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
2085 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
2086 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PLUS_NORM)
2087 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_MINUS_NORM)
2088 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PLUS_DENORM)
2089 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_MINUS_DENORM)
2090 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PLUS_ZERO)
2091 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_MINUS_ZERO)
2092 #    else
2093 #        undef Perl_fp_class /* Unknown set of defines */
2094 #    endif
2095 #endif
2096
2097 /* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
2098  * are identical to the C99 fpclassify(). */
2099 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
2100 #    include <math.h>
2101 #    ifdef __VMS
2102      /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
2103 #        include <fp.h>
2104      /* oh, and the isnormal macro has a typo in it! */
2105 #    undef isnormal
2106 #    define isnormal(x) Perl_fp_class_norm(x)
2107 #    endif
2108 #    if defined(FP_INFINITE) && defined(FP_NAN)
2109 #        define Perl_fp_class(x)        fp_classify(x)
2110 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
2111 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
2112 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
2113 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2114 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
2115 #    else
2116 #        undef Perl_fp_class /* Unknown set of defines */
2117 #    endif
2118 #endif
2119
2120 /* Feel free to check with me for the SGI manpages, SGI testing,
2121  * etcetera, if you want to try getting this to work with IRIX.
2122  *
2123  * - Allen <allens@cpan.org> */
2124
2125 /* fpclass(): SysV, at least Solaris and some versions of IRIX. */
2126 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
2127 /* Solaris and IRIX have fpclass/fpclassl, but they are using
2128  * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2129  * Define some symbols also as cpp symbols so we can detect them. */
2130 #    if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
2131 #     define FP_PINF FP_PINF
2132 #     define FP_QNAN FP_QNAN
2133 #    endif
2134 #    include <math.h>
2135 #    ifdef I_IEEFP
2136 #        include <ieeefp.h>
2137 #    endif
2138 #    ifdef I_FP
2139 #        include <fp.h>
2140 #    endif
2141 #    if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
2142 #        define Perl_fp_class(x)        fpclassl(x)
2143 #    else
2144 #        define Perl_fp_class(x)        fpclass(x)
2145 #    endif
2146 #    if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
2147 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_CLASS_SNAN)
2148 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_CLASS_QNAN)
2149 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_CLASS_NINF)
2150 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_CLASS_PINF)
2151 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_CLASS_NNORM)
2152 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_CLASS_PNORM)
2153 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_CLASS_NDENORM)
2154 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_CLASS_PDENORM)
2155 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_CLASS_NZERO)
2156 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_CLASS_PZERO)
2157 #    elif defined(FP_PINF) && defined(FP_QNAN)
2158 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
2159 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
2160 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_NINF)
2161 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PINF)
2162 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_NNORM)
2163 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PNORM)
2164 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_NDENORM)
2165 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PDENORM)
2166 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_NZERO)
2167 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PZERO)
2168 #    else
2169 #        undef Perl_fp_class /* Unknown set of defines */
2170 #    endif
2171 #endif
2172
2173 /* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2174 #if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
2175 #    include <math.h>
2176 #    if !defined(FP_SNAN) && defined(I_FP_CLASS)
2177 #        include <fp_class.h>
2178 #    endif
2179 #    if defined(FP_POS_INF) && defined(FP_QNAN)
2180 #        ifdef __sgi /* XXX Configure test instead */
2181 #            ifdef USE_LONG_DOUBLE
2182 #                define Perl_fp_class(x)        fp_class_l(x)
2183 #            else
2184 #                define Perl_fp_class(x)        fp_class_d(x)
2185 #            endif
2186 #        else
2187 #            if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2188 #                define Perl_fp_class(x)        fp_classl(x)
2189 #            else
2190 #                define Perl_fp_class(x)        fp_class(x)
2191 #            endif
2192 #        endif
2193 #        if defined(FP_POS_INF) && defined(FP_QNAN)
2194 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_SNAN)
2195 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_QNAN)
2196 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_NEG_INF)
2197 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_POS_INF)
2198 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_NEG_NORM)
2199 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_POS_NORM)
2200 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_NEG_DENORM)
2201 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_POS_DENORM)
2202 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_NEG_ZERO)
2203 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_POS_ZERO)
2204 #        else
2205 #            undef Perl_fp_class /* Unknown set of defines */
2206 #        endif
2207 #    endif
2208 #endif
2209
2210 /* class(), _class(): Legacy: AIX. */
2211 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2212 #    include <math.h>
2213 #    if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2214 #        ifndef _cplusplus
2215 #            define Perl_fp_class(x)    class(x)
2216 #        else
2217 #            define Perl_fp_class(x)    _class(x)
2218 #        endif
2219 #        if defined(FP_PLUS_INF) && defined(FP_NANQ)
2220 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_NANS)
2221 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_NANQ)
2222 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_MINUS_INF)
2223 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_PLUS_INF)
2224 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_MINUS_NORM)
2225 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_PLUS_NORM)
2226 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_MINUS_DENORM)
2227 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_PLUS_DENORM)
2228 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_MINUS_ZERO)
2229 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_PLUS_ZERO)
2230 #        else
2231 #            undef Perl_fp_class /* Unknown set of defines */
2232 #        endif
2233 #    endif
2234 #endif
2235
2236 /* Win32: _fpclass(), _isnan(), _finite(). */
2237 #ifdef _MSC_VER
2238 #  ifndef Perl_isnan
2239 #    define Perl_isnan(x) _isnan(x)
2240 #  endif
2241 #  ifndef Perl_isfinite
2242 #    define Perl_isfinite(x) _finite(x)
2243 #  endif
2244 #  ifndef Perl_fp_class_snan
2245 /* No simple way to #define Perl_fp_class because _fpclass()
2246  * returns a set of bits. */
2247 #    define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2248 #    define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
2249 #    define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
2250 #    define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF))
2251 #    define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF))
2252 #    define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2253 #    define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2254 #    define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2255 #    define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2256 #    define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2257 #    define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2258 #    define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2259 #    define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2260 #    define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2261 #    define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2262 #  endif
2263 #endif
2264
2265 #if !defined(Perl_fp_class_inf) && \
2266   defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2267 #  define Perl_fp_class_inf(x) \
2268     (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2269 #endif
2270
2271 #if !defined(Perl_fp_class_nan) && \
2272   defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2273 #  define Perl_fp_class_nan(x) \
2274     (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2275 #endif
2276
2277 #if !defined(Perl_fp_class_zero) && \
2278   defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2279 #  define Perl_fp_class_zero(x) \
2280     (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2281 #endif
2282
2283 #if !defined(Perl_fp_class_norm) && \
2284   defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2285 #  define Perl_fp_class_norm(x) \
2286     (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2287 #endif
2288
2289 #if !defined(Perl_fp_class_denorm) && \
2290   defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2291 #  define Perl_fp_class_denorm(x) \
2292     (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
2293 #endif
2294
2295 #ifdef UNDER_CE
2296 int isnan(double d);
2297 #endif
2298
2299 #ifndef Perl_isnan
2300 #   ifdef Perl_fp_class_nan
2301 #       define Perl_isnan(x) Perl_fp_class_nan(x)
2302 #   elif defined(HAS_UNORDERED)
2303 #       define Perl_isnan(x) unordered((x), 0.0)
2304 #   else
2305 #       define Perl_isnan(x) ((x)!=(x))
2306 #   endif
2307 #endif
2308
2309 #ifndef Perl_isinf
2310 #   ifdef Perl_fp_class_inf
2311 #       define Perl_isinf(x) Perl_fp_class_inf(x)
2312 #   endif
2313 #endif
2314
2315 #ifndef Perl_isfinite
2316 #   if defined(HAS_ISFINITE) && !defined(isfinite)
2317 #     define Perl_isfinite(x) isfinite((double)(x))
2318 #   elif defined(HAS_FINITE)
2319 #       define Perl_isfinite(x) finite((double)(x))
2320 #   elif defined(Perl_fp_class_finite)
2321 #     define Perl_isfinite(x) Perl_fp_class_finite(x)
2322 #   else
2323 /* For the infinities the multiplication returns nan,
2324  * for the nan the multiplication also returns nan,
2325  * for everything else (that is, finite) zero should be returned. */
2326 #     define Perl_isfinite(x) (((x) * 0) == 0)
2327 #   endif
2328 #endif
2329
2330 #ifndef Perl_isinf
2331 #   if defined(Perl_isfinite) && defined(Perl_isnan)
2332 #       define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2333 #   endif
2334 #endif
2335
2336 /* We need Perl_isfinitel (ends with ell) (if available) even when
2337  * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2338  * needs that. */
2339 #if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2340 /* If isfinite() is a macro and looks like we have C99,
2341  * we assume it's the type-aware C99 isfinite(). */
2342 #    if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
2343 #        define Perl_isfinitel(x) isfinite(x)
2344 #    elif defined(HAS_ISFINITEL)
2345 #        define Perl_isfinitel(x) isfinitel(x)
2346 #    elif defined(HAS_FINITEL)
2347 #        define Perl_isfinitel(x) finitel(x)
2348 #    elif defined(HAS_INFL) && defined(HAS_NANL)
2349 #        define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
2350 #    else
2351 #        define Perl_isfinitel(x) ((x) * 0 == 0)  /* See Perl_isfinite. */
2352 #    endif
2353 #endif
2354
2355 /* The default is to use Perl's own atof() implementation (in numeric.c).
2356  * Usually that is the one to use but for some platforms (e.g. UNICOS)
2357  * it is however best to use the native implementation of atof.
2358  * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2359  * Some good tests to try out with either setting are t/base/num.t,
2360  * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2361  * you may need to be using a different function than atof! */
2362
2363 #ifndef USE_PERL_ATOF
2364 #   ifndef _UNICOS
2365 #       define USE_PERL_ATOF
2366 #   endif
2367 #else
2368 #   if USE_PERL_ATOF == 0
2369 #       undef USE_PERL_ATOF
2370 #   endif
2371 #endif
2372
2373 #ifdef USE_PERL_ATOF
2374 #   define Perl_atof(s) Perl_my_atof(s)
2375 #   define Perl_atof2(s, n) Perl_my_atof3(aTHX_ (s), &(n), 0)
2376 #else
2377 #   define Perl_atof(s) (NV)atof(s)
2378 #   define Perl_atof2(s, n) ((n) = atof(s))
2379 #endif
2380 #define my_atof2(a,b) my_atof3(a,b,0)
2381
2382 /*
2383  * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2384  * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2385  * depending on local options. Until Configure detects this (or at least
2386  * detects whether the "signed" keyword is available) the CHAR ranges
2387  * will not be included. UCHAR functions normally.
2388  *                                                           - kja
2389  */
2390
2391 #define PERL_UCHAR_MIN ((unsigned char)0)
2392 #define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2393
2394 #define PERL_USHORT_MIN ((unsigned short)0)
2395 #define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2396
2397 #define PERL_SHORT_MAX ((short)SHRT_MAX)
2398 #define PERL_SHORT_MIN ((short)SHRT_MIN)
2399
2400 #define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2401 #define PERL_UINT_MIN ((unsigned int)0)
2402
2403 #define PERL_INT_MAX ((int)INT_MAX)
2404 #define PERL_INT_MIN ((int)INT_MIN)
2405
2406 #define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2407 #define PERL_ULONG_MIN ((unsigned long)0L)
2408
2409 #define PERL_LONG_MAX ((long)LONG_MAX)
2410 #define PERL_LONG_MIN ((long)LONG_MIN)
2411
2412 #ifdef UV_IS_QUAD
2413 #    define PERL_UQUAD_MAX      (~(UV)0)
2414 #    define PERL_UQUAD_MIN      ((UV)0)
2415 #    define PERL_QUAD_MAX       ((IV) (PERL_UQUAD_MAX >> 1))
2416 #    define PERL_QUAD_MIN       (-PERL_QUAD_MAX - ((3 & -1) == 3))
2417 #endif
2418
2419 typedef MEM_SIZE STRLEN;
2420
2421 typedef struct op OP;
2422 typedef struct cop COP;
2423 typedef struct unop UNOP;
2424 typedef struct unop_aux UNOP_AUX;
2425 typedef struct binop BINOP;
2426 typedef struct listop LISTOP;
2427 typedef struct logop LOGOP;
2428 typedef struct pmop PMOP;
2429 typedef struct svop SVOP;
2430 typedef struct padop PADOP;
2431 typedef struct pvop PVOP;
2432 typedef struct loop LOOP;
2433 typedef struct methop METHOP;
2434
2435 #ifdef PERL_CORE
2436 typedef struct opslab OPSLAB;
2437 typedef struct opslot OPSLOT;
2438 #endif
2439
2440 typedef struct block_hooks BHK;
2441 typedef struct custom_op XOP;
2442
2443 typedef struct interpreter PerlInterpreter;
2444
2445 /* SGI's <sys/sema.h> has struct sv */
2446 #if defined(__sgi)
2447 #   define STRUCT_SV perl_sv
2448 #else
2449 #   define STRUCT_SV sv
2450 #endif
2451 typedef struct STRUCT_SV SV;
2452 typedef struct av AV;
2453 typedef struct hv HV;
2454 typedef struct cv CV;
2455 typedef struct p5rx REGEXP;
2456 typedef struct gp GP;
2457 typedef struct gv GV;
2458 typedef struct io IO;
2459 typedef struct context PERL_CONTEXT;
2460 typedef struct block BLOCK;
2461
2462 typedef struct magic MAGIC;
2463 typedef struct xpv XPV;
2464 typedef struct xpviv XPVIV;
2465 typedef struct xpvuv XPVUV;
2466 typedef struct xpvnv XPVNV;
2467 typedef struct xpvmg XPVMG;
2468 typedef struct xpvlv XPVLV;
2469 typedef struct xpvinvlist XINVLIST;
2470 typedef struct xpvav XPVAV;
2471 typedef struct xpvhv XPVHV;
2472 typedef struct xpvgv XPVGV;
2473 typedef struct xpvcv XPVCV;
2474 typedef struct xpvbm XPVBM;
2475 typedef struct xpvfm XPVFM;
2476 typedef struct xpvio XPVIO;
2477 typedef struct mgvtbl MGVTBL;
2478 typedef union any ANY;
2479 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2480 typedef struct ptr_tbl PTR_TBL_t;
2481 typedef struct clone_params CLONE_PARAMS;
2482
2483 /* a pad is currently just an AV; but that might change,
2484  * so hide the type.  */
2485 typedef struct padlist PADLIST;
2486 typedef AV PAD;
2487 typedef struct padnamelist PADNAMELIST;
2488 typedef struct padname PADNAME;
2489
2490 /* always enable PERL_OP_PARENT  */
2491 #if !defined(PERL_OP_PARENT)
2492 #  define PERL_OP_PARENT
2493 #endif
2494
2495 /* enable PERL_COPY_ON_WRITE by default */
2496 #if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2497 #  define PERL_COPY_ON_WRITE
2498 #endif
2499
2500 #ifdef PERL_COPY_ON_WRITE
2501 #  define PERL_ANY_COW
2502 #else
2503 # define PERL_SAWAMPERSAND
2504 #endif
2505
2506 #if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2507 # error PERL_DEBUG_READONLY_OPS only works with ithreads
2508 #endif
2509
2510 #include "handy.h"
2511 #include "charclass_invlists.h"
2512
2513 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2514 #   if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2515 #       define USE_64_BIT_RAWIO /* implicit */
2516 #   endif
2517 #endif
2518
2519 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2520  * fseeko/ftello if possible.  Don't go #defining ftell to ftello yourself,
2521  * however, because operating systems like to do that themself. */
2522 #ifndef FSEEKSIZE
2523 #   ifdef HAS_FSEEKO
2524 #       define FSEEKSIZE LSEEKSIZE
2525 #   else
2526 #       define FSEEKSIZE LONGSIZE
2527 #   endif
2528 #endif
2529
2530 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2531 #   if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2532 #       define USE_64_BIT_STDIO /* implicit */
2533 #   endif
2534 #endif
2535
2536 #ifdef USE_64_BIT_RAWIO
2537 #   ifdef HAS_OFF64_T
2538 #       undef Off_t
2539 #       define Off_t off64_t
2540 #       undef LSEEKSIZE
2541 #       define LSEEKSIZE 8
2542 #   endif
2543 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2544  * will trigger defines like the ones below.  Some 64-bit environments,
2545  * however, do not.  Therefore we have to explicitly mix and match. */
2546 #   if defined(USE_OPEN64)
2547 #       define open open64
2548 #   endif
2549 #   if defined(USE_LSEEK64)
2550 #       define lseek lseek64
2551 #   else
2552 #       if defined(USE_LLSEEK)
2553 #           define lseek llseek
2554 #       endif
2555 #   endif
2556 #   if defined(USE_STAT64)
2557 #       define stat stat64
2558 #   endif
2559 #   if defined(USE_FSTAT64)
2560 #       define fstat fstat64
2561 #   endif
2562 #   if defined(USE_LSTAT64)
2563 #       define lstat lstat64
2564 #   endif
2565 #   if defined(USE_FLOCK64)
2566 #       define flock flock64
2567 #   endif
2568 #   if defined(USE_LOCKF64)
2569 #       define lockf lockf64
2570 #   endif
2571 #   if defined(USE_FCNTL64)
2572 #       define fcntl fcntl64
2573 #   endif
2574 #   if defined(USE_TRUNCATE64)
2575 #       define truncate truncate64
2576 #   endif
2577 #   if defined(USE_FTRUNCATE64)
2578 #       define ftruncate ftruncate64
2579 #   endif
2580 #endif
2581
2582 #ifdef USE_64_BIT_STDIO
2583 #   ifdef HAS_FPOS64_T
2584 #       undef Fpos_t
2585 #       define Fpos_t fpos64_t
2586 #   endif
2587 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2588  * will trigger defines like the ones below.  Some 64-bit environments,
2589  * however, do not. */
2590 #   if defined(USE_FOPEN64)
2591 #       define fopen fopen64
2592 #   endif
2593 #   if defined(USE_FSEEK64)
2594 #       define fseek fseek64 /* don't do fseeko here, see perlio.c */
2595 #   endif
2596 #   if defined(USE_FTELL64)
2597 #       define ftell ftell64 /* don't do ftello here, see perlio.c */
2598 #   endif
2599 #   if defined(USE_FSETPOS64)
2600 #       define fsetpos fsetpos64
2601 #   endif
2602 #   if defined(USE_FGETPOS64)
2603 #       define fgetpos fgetpos64
2604 #   endif
2605 #   if defined(USE_TMPFILE64)
2606 #       define tmpfile tmpfile64
2607 #   endif
2608 #   if defined(USE_FREOPEN64)
2609 #       define freopen freopen64
2610 #   endif
2611 #endif
2612
2613 #if defined(OS2)
2614 #  include "iperlsys.h"
2615 #endif
2616
2617 #ifdef DOSISH
2618 #   if defined(OS2)
2619 #       include "os2ish.h"
2620 #   else
2621 #       include "dosish.h"
2622 #   endif
2623 #elif defined(VMS)
2624 #   include "vmsish.h"
2625 #elif defined(PLAN9)
2626 #   include "./plan9/plan9ish.h"
2627 #elif defined(__VOS__)
2628 #   ifdef __GNUC__
2629 #     include "./vos/vosish.h"
2630 #   else
2631 #     include "vos/vosish.h"
2632 #   endif
2633 #elif defined(__SYMBIAN32__)
2634 #   include "symbian/symbianish.h"
2635 #elif defined(__HAIKU__)
2636 #   include "haiku/haikuish.h"
2637 #else
2638 #   include "unixish.h"
2639 #endif
2640
2641 #ifdef __amigaos4__
2642 #    include "amigaos.h"
2643 #    undef FD_CLOEXEC /* a lie in AmigaOS */
2644 #endif
2645
2646 /* NSIG logic from Configure --> */
2647 #ifndef NSIG
2648 #  ifdef _NSIG
2649 #    define NSIG (_NSIG)
2650 #  elif defined(SIGMAX)
2651 #    define NSIG (SIGMAX+1)
2652 #  elif defined(SIG_MAX)
2653 #    define NSIG (SIG_MAX+1)
2654 #  elif defined(_SIG_MAX)
2655 #    define NSIG (_SIG_MAX+1)
2656 #  elif defined(MAXSIG)
2657 #    define NSIG (MAXSIG+1)
2658 #  elif defined(MAX_SIG)
2659 #    define NSIG (MAX_SIG+1)
2660 #  elif defined(SIGARRAYSIZE)
2661 #    define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
2662 #  elif defined(_sys_nsig)
2663 #    define NSIG (_sys_nsig) /* Solaris 2.5 */
2664 #  else
2665      /* Default to some arbitrary number that's big enough to get most
2666       * of the common signals.  */
2667 #    define NSIG 50
2668 #  endif
2669 #endif
2670 /* <-- NSIG logic from Configure */
2671
2672 #ifndef NO_ENVIRON_ARRAY
2673 #  define USE_ENVIRON_ARRAY
2674 #endif
2675
2676 /*
2677  * initialise to avoid floating-point exceptions from overflow, etc
2678  */
2679 #ifndef PERL_FPU_INIT
2680 #  ifdef HAS_FPSETMASK
2681 #    if HAS_FLOATINGPOINT_H
2682 #      include <floatingpoint.h>
2683 #    endif
2684 /* Some operating systems have this as a macro, which in turn expands to a comma
2685    expression, and the last sub-expression is something that gets calculated,
2686    and then they have the gall to warn that a value computed is not used. Hence
2687    cast to void.  */
2688 #    define PERL_FPU_INIT (void)fpsetmask(0)
2689 #  elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2690 #    define PERL_FPU_INIT       PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2691 #    define PERL_FPU_PRE_EXEC   { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2692 #    define PERL_FPU_POST_EXEC    rsignal_restore(SIGFPE, &xfpe); }
2693 #  else
2694 #    define PERL_FPU_INIT
2695 #  endif
2696 #endif
2697 #ifndef PERL_FPU_PRE_EXEC
2698 #  define PERL_FPU_PRE_EXEC   {
2699 #  define PERL_FPU_POST_EXEC  }
2700 #endif
2701
2702 /* In Tru64 the cc -ieee enables the IEEE math but disables traps.
2703  * We need to reenable the "invalid" trap because otherwise generation
2704  * of NaN values leaves the IEEE fp flags in bad state, leaving any further
2705  * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
2706 #ifdef __osf__
2707 #  include <machine/fpu.h>
2708 #  define PERL_SYS_FPU_INIT \
2709      STMT_START { \
2710          ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
2711          signal(SIGFPE, SIG_IGN); \
2712      } STMT_END
2713 #endif
2714 /* In IRIX the default for Flush to Zero bit is true,
2715  * which means that results going below the minimum of normal
2716  * floating points go to zero, instead of going denormal/subnormal.
2717  * This is unlike almost any other system running Perl, so let's clear it.
2718  * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
2719  * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
2720  *
2721  * XXX The flush-to-zero behaviour should be a Configure scan.
2722  * To change the behaviour usually requires some system-specific
2723  * incantation, though, like the below. */
2724 #ifdef __sgi
2725 #  include <sys/fpu.h>
2726 #  define PERL_SYS_FPU_INIT \
2727      STMT_START { \
2728          union fpc_csr csr; \
2729          csr.fc_word = get_fpc_csr(); \
2730          csr.fc_struct.flush = 0; \
2731          set_fpc_csr(csr.fc_word); \
2732      } STMT_END
2733 #endif
2734
2735 #ifndef PERL_SYS_FPU_INIT
2736 #  define PERL_SYS_FPU_INIT NOOP
2737 #endif
2738
2739 #ifndef PERL_SYS_INIT3_BODY
2740 #  define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
2741 #endif
2742
2743 /*
2744 =head1 Miscellaneous Functions
2745
2746 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
2747 Provides system-specific tune up of the C runtime environment necessary to
2748 run Perl interpreters.  This should be called only once, before creating
2749 any Perl interpreters.
2750
2751 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
2752 Provides system-specific tune up of the C runtime environment necessary to
2753 run Perl interpreters.  This should be called only once, before creating
2754 any Perl interpreters.
2755
2756 =for apidoc Am|void|PERL_SYS_TERM|
2757 Provides system-specific clean up of the C runtime environment after
2758 running Perl interpreters.  This should be called only once, after
2759 freeing any remaining Perl interpreters.
2760
2761 =cut
2762  */
2763
2764 #define PERL_SYS_INIT(argc, argv)       Perl_sys_init(argc, argv)
2765 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
2766 #define PERL_SYS_TERM()                 Perl_sys_term()
2767
2768 #ifndef PERL_WRITE_MSG_TO_CONSOLE
2769 #  define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
2770 #endif
2771
2772 #ifndef MAXPATHLEN
2773 #  ifdef PATH_MAX
2774 #    ifdef _POSIX_PATH_MAX
2775 #       if PATH_MAX > _POSIX_PATH_MAX
2776 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
2777  * included the null byte or not.  Later amendments of POSIX,
2778  * XPG4, the Austin Group, and the Single UNIX Specification
2779  * all explicitly include the null byte in the PATH_MAX.
2780  * Ditto for _POSIX_PATH_MAX. */
2781 #         define MAXPATHLEN PATH_MAX
2782 #       else
2783 #         define MAXPATHLEN _POSIX_PATH_MAX
2784 #       endif
2785 #    else
2786 #      define MAXPATHLEN (PATH_MAX+1)
2787 #    endif
2788 #  else
2789 #    define MAXPATHLEN 1024     /* Err on the large side. */
2790 #  endif
2791 #endif
2792
2793 /* In case Configure was not used (we are using a "canned config"
2794  * such as Win32, or a cross-compilation setup, for example) try going
2795  * by the gcc major and minor versions.  One useful URL is
2796  * http://www.ohse.de/uwe/articles/gcc-attributes.html,
2797  * but contrary to this information warn_unused_result seems
2798  * not to be in gcc 3.3.5, at least. --jhi
2799  * Also, when building extensions with an installed perl, this allows
2800  * the user to upgrade gcc and get the right attributes, rather than
2801  * relying on the list generated at Configure time.  --AD
2802  * Set these up now otherwise we get confused when some of the <*thread.h>
2803  * includes below indirectly pull in <perlio.h> (which needs to know if we
2804  * have HASATTRIBUTE_FORMAT).
2805  */
2806
2807 #ifndef PERL_MICRO
2808 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
2809 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
2810 #    define HASATTRIBUTE_DEPRECATED
2811 #  endif
2812 #  if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
2813 #    define HASATTRIBUTE_FORMAT
2814 #    if defined __MINGW32__
2815 #      define PRINTF_FORMAT_NULL_OK
2816 #    endif
2817 #  endif
2818 #  if __GNUC__ >= 3 /* 3.0 -> */
2819 #    define HASATTRIBUTE_MALLOC
2820 #  endif
2821 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
2822 #    define HASATTRIBUTE_NONNULL
2823 #  endif
2824 #  if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
2825 #    define HASATTRIBUTE_NORETURN
2826 #  endif
2827 #  if __GNUC__ >= 3 /* gcc 3.0 -> */
2828 #    define HASATTRIBUTE_PURE
2829 #  endif
2830 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2831 #    define HASATTRIBUTE_UNUSED
2832 #  endif
2833 #  if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
2834 #    define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
2835 #  endif
2836 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2837 #    define HASATTRIBUTE_WARN_UNUSED_RESULT
2838 #  endif
2839 #endif
2840 #endif /* #ifndef PERL_MICRO */
2841
2842 /* USE_5005THREADS needs to be after unixish.h as <pthread.h> includes
2843  * <sys/signal.h> which defines NSIG - which will stop inclusion of <signal.h>
2844  * this results in many functions being undeclared which bothers C++
2845  * May make sense to have threads after "*ish.h" anyway
2846  */
2847
2848 /* clang Thread Safety Analysis/Annotations/Attributes
2849  * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
2850  *
2851  * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
2852  * Apple XCode hijacks __clang_major__ and __clang_minor__
2853  * (6.1 means really clang 3.6), so needs extra hijinks
2854  * (could probably also test the contents of __apple_build_version__).
2855  */
2856 #if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
2857     defined(__clang__) && \
2858     !defined(PERL_GLOBAL_STRUCT) && \
2859     !defined(PERL_GLOBAL_STRUCT_PRIVATE) && \
2860     !defined(SWIG) && \
2861   ((!defined(__apple_build_version__) &&               \
2862     ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
2863      (__clang_major__ >= 4))) || \
2864    (defined(__apple_build_version__) &&                \
2865     ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
2866      (__clang_major__ >= 7))))
2867 #  define PERL_TSA__(x)   __attribute__((x))
2868 #  define PERL_TSA_ACTIVE
2869 #else
2870 #  define PERL_TSA__(x)   /* No TSA, make TSA attributes no-ops. */
2871 #  undef PERL_TSA_ACTIVE
2872 #endif
2873
2874 /* PERL_TSA_CAPABILITY() is used to annotate typedefs.
2875  * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
2876  */
2877 #define PERL_TSA_CAPABILITY(x) \
2878     PERL_TSA__(capability(x))
2879
2880 /* In the below examples the mutex must be lexically visible, usually
2881  * either as global variables, or as function arguments. */
2882
2883 /* PERL_TSA_GUARDED_BY() is used to annotate global variables.
2884  *
2885  * Foo foo PERL_TSA_GUARDED_BY(mutex);
2886  */
2887 #define PERL_TSA_GUARDED_BY(x) \
2888     PERL_TSA__(guarded_by(x))
2889
2890 /* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
2891  * The data _behind_ the pointer is guarded.
2892  *
2893  * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
2894  */
2895 #define PERL_TSA_PT_GUARDED_BY(x) \
2896     PERL_TSA__(pt_guarded_by(x))
2897
2898 /* PERL_TSA_REQUIRES() is used to annotate functions.
2899  * The caller MUST hold the resource when calling the function.
2900  *
2901  * void Foo() PERL_TSA_REQUIRES(mutex);
2902  */
2903 #define PERL_TSA_REQUIRES(x) \
2904     PERL_TSA__(requires_capability(x))
2905
2906 /* PERL_TSA_EXCLUDES() is used to annotate functions.
2907  * The caller MUST NOT hold resource when calling the function.
2908  *
2909  * EXCLUDES should be used when the function first acquires
2910  * the resource and then releases it.  Use to avoid deadlock.
2911  *
2912  * void Foo() PERL_TSA_EXCLUDES(mutex);
2913  */
2914 #define PERL_TSA_EXCLUDES(x) \
2915     PERL_TSA__(locks_excluded(x))
2916
2917 /* PERL_TSA_ACQUIRE() is used to annotate functions.
2918  * The caller MUST NOT hold the resource when calling the function,
2919  * and the function will acquire the resource.
2920  *
2921  * void Foo() PERL_TSA_ACQUIRE(mutex);
2922  */
2923 #define PERL_TSA_ACQUIRE(x) \
2924     PERL_TSA__(acquire_capability(x))
2925
2926 /* PERL_TSA_RELEASE() is used to annotate functions.
2927  * The caller MUST hold the resource when calling the function,
2928  * and the function will release the resource.
2929  *
2930  * void Foo() PERL_TSA_RELEASE(mutex);
2931  */
2932 #define PERL_TSA_RELEASE(x) \
2933     PERL_TSA__(release_capability(x))
2934
2935 /* PERL_TSA_NO_TSA is used to annotate functions.
2936  * Used when being intentionally unsafe, or when the code is too
2937  * complicated for the analysis.  Use sparingly.
2938  *
2939  * void Foo() PERL_TSA_NO_TSA;
2940  */
2941 #define PERL_TSA_NO_TSA \
2942     PERL_TSA__(no_thread_safety_analysis)
2943
2944 /* There are more annotations/attributes available, see the clang
2945  * documentation for details. */
2946
2947 #if defined(USE_ITHREADS)
2948 #  ifdef NETWARE
2949 #    include <nw5thread.h>
2950 #  elif defined(WIN32)
2951 #    include <win32thread.h>
2952 #  elif defined(OS2)
2953 #    include "os2thread.h"
2954 #  elif defined(I_MACH_CTHREADS)
2955 #    include <mach/cthreads.h>
2956 typedef cthread_t       perl_os_thread;
2957 typedef mutex_t         perl_mutex;
2958 typedef condition_t     perl_cond;
2959 typedef void *          perl_key;
2960 #  elif defined(I_PTHREAD) /* Posix threads */
2961 #    include <pthread.h>
2962 typedef pthread_t       perl_os_thread;
2963 typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
2964 typedef pthread_cond_t  perl_cond;
2965 typedef pthread_key_t   perl_key;
2966 #  endif
2967 #endif /* USE_ITHREADS */
2968
2969 #ifdef PERL_TSA_ACTIVE
2970 /* Since most pthread mutex interfaces have not been annotated, we
2971  * need to have these wrappers. The NO_TSA annotation is quite ugly
2972  * but it cannot be avoided in plain C, unlike in C++, where one could
2973  * e.g. use ACQUIRE() with no arg on a mutex lock method.
2974  *
2975  * The bodies of these wrappers are in util.c
2976  *
2977  * TODO: however, some platforms are starting to get these clang
2978  * thread safety annotations for pthreads, for example FreeBSD.
2979  * Do we need a way to a bypass these wrappers? */
2980 EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
2981   PERL_TSA_ACQUIRE(*mutex)
2982   PERL_TSA_NO_TSA;
2983 EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
2984   PERL_TSA_RELEASE(*mutex)
2985   PERL_TSA_NO_TSA;
2986 #endif
2987
2988 #if defined(WIN32)
2989 #  include "win32.h"
2990 #endif
2991
2992 #ifdef NETWARE
2993 #  include "netware.h"
2994 #endif
2995
2996 #define STATUS_UNIX     PL_statusvalue
2997 #ifdef VMS
2998 #   define STATUS_NATIVE        PL_statusvalue_vms
2999 /*
3000  * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
3001  * its contents can not be trusted.  Unfortunately, Perl seems to check
3002  * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
3003  * be updated also.
3004  */
3005 #  include <stsdef.h>
3006 #  include <ssdef.h>
3007 /* Presume this because if VMS changes it, it will require a new
3008  * set of APIs for waiting on children for binary compatibility.
3009  */
3010 #  define child_offset_bits (8)
3011 #  ifndef C_FAC_POSIX
3012 #  define C_FAC_POSIX 0x35A000
3013 #  endif
3014
3015 /*  STATUS_EXIT - validates and returns a NATIVE exit status code for the
3016  * platform from the existing UNIX or Native status values.
3017  */
3018
3019 #   define STATUS_EXIT \
3020         (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
3021            (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
3022
3023
3024 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
3025  * exit code and shifts the UNIX value over the correct number of bits to
3026  * be a child status.  Usually the number of bits is 8, but that could be
3027  * platform dependent.  The NATIVE status code is presumed to have either
3028  * from a child process.
3029  */
3030
3031 /* This is complicated.  The child processes return a true native VMS
3032    status which must be saved.  But there is an assumption in Perl that
3033    the UNIX child status has some relationship to errno values, so
3034    Perl tries to translate it to text in some of the tests.
3035    In order to get the string translation correct, for the error, errno
3036    must be EVMSERR, but that generates a different text message
3037    than what the test programs are expecting.  So an errno value must
3038    be derived from the native status value when an error occurs.
3039    That will hide the true native status message.  With this version of
3040    perl, the true native child status can always be retrieved so that
3041    is not a problem.  But in this case, Pl_statusvalue and errno may
3042    have different values in them.
3043  */
3044
3045 #   define STATUS_NATIVE_CHILD_SET(n) \
3046         STMT_START {                                                    \
3047             I32 evalue = (I32)n;                                        \
3048             if (evalue == EVMSERR) {                                    \
3049               PL_statusvalue_vms = vaxc$errno;                          \
3050               PL_statusvalue = evalue;                                  \
3051             } else {                                                    \
3052               PL_statusvalue_vms = evalue;                              \
3053               if (evalue == -1) {                                       \
3054                 PL_statusvalue = -1;                                    \
3055                 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3056               } else                                                    \
3057                 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1);    \
3058               set_vaxc_errno(evalue);                                   \
3059               if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX)    \
3060                   set_errno(EVMSERR);                                   \
3061               else set_errno(Perl_vms_status_to_unix(evalue, 0));       \
3062               PL_statusvalue = PL_statusvalue << child_offset_bits;     \
3063             }                                                           \
3064         } STMT_END
3065
3066 #   ifdef VMSISH_STATUS
3067 #       define STATUS_CURRENT   (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
3068 #   else
3069 #       define STATUS_CURRENT   STATUS_UNIX
3070 #   endif
3071
3072   /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3073    * the NATIVE status to an equivalent value.  Can not be used to translate
3074    * exit code values as exit code values are not guaranteed to have any
3075    * relationship at all to errno values.
3076    * This is used when Perl is forcing errno to have a specific value.
3077    */
3078 #   define STATUS_UNIX_SET(n)                           \
3079         STMT_START {                                    \
3080             I32 evalue = (I32)n;                        \
3081             PL_statusvalue = evalue;                    \
3082             if (PL_statusvalue != -1) {                 \
3083                 if (PL_statusvalue != EVMSERR) {        \
3084                   PL_statusvalue &= 0xFFFF;             \
3085                   if (MY_POSIX_EXIT)                    \
3086                     PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3087                   else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3088                 }                                       \
3089                 else {                                  \
3090                   PL_statusvalue_vms = vaxc$errno;      \
3091                 }                                       \
3092             }                                           \
3093             else PL_statusvalue_vms = SS$_ABORT;        \
3094             set_vaxc_errno(PL_statusvalue_vms);         \
3095         } STMT_END
3096
3097   /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
3098    * the NATIVE error status based on it.
3099    *
3100    * When in the default mode to comply with the Perl VMS documentation,
3101    * 0 is a success and any other code sets the NATIVE status to a failure
3102    * code of SS$_ABORT.
3103    *
3104    * In the new POSIX EXIT mode, native status will be set so that the
3105    * actual exit code will can be retrieved by the calling program or
3106    * shell.
3107    *
3108    * If the exit code is not clearly a UNIX parent or child exit status,
3109    * it will be passed through as a VMS status.
3110    */
3111
3112 #   define STATUS_UNIX_EXIT_SET(n)                      \
3113         STMT_START {                                    \
3114             I32 evalue = (I32)n;                        \
3115             PL_statusvalue = evalue;                    \
3116             if (MY_POSIX_EXIT) { \
3117               if (evalue <= 0xFF00) {           \
3118                   if (evalue > 0xFF)                    \
3119                     evalue = (evalue >> child_offset_bits) & 0xFF; \
3120                   PL_statusvalue_vms =          \
3121                     (C_FAC_POSIX | (evalue << 3 ) |     \
3122                     ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3123               } else /* forgive them Perl, for they have sinned */ \
3124                 PL_statusvalue_vms = evalue; \
3125             } else { \
3126               if (evalue == 0)                  \
3127                 PL_statusvalue_vms = SS$_NORMAL;        \
3128               else if (evalue <= 0xFF00) \
3129                 PL_statusvalue_vms = SS$_ABORT; \
3130               else { /* forgive them Perl, for they have sinned */ \
3131                   if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3132                   else PL_statusvalue_vms = vaxc$errno; \
3133                   /* And obviously used a VMS status value instead of UNIX */ \
3134                   PL_statusvalue = EVMSERR;             \
3135               } \
3136               set_vaxc_errno(PL_statusvalue_vms);       \
3137             }                                           \
3138         } STMT_END
3139
3140
3141   /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3142    * and sets the NATIVE error status based on it.  This special case
3143    * is needed to maintain compatibility with past VMS behavior.
3144    *
3145    * In the default mode on VMS, this number is passed through as
3146    * both the NATIVE and UNIX status.  Which makes it different
3147    * that the STATUS_UNIX_EXIT_SET.
3148    *
3149    * In the new POSIX EXIT mode, native status will be set so that the
3150    * actual exit code will can be retrieved by the calling program or
3151    * shell.
3152    *
3153    * A POSIX exit code is from 0 to 255.  If the exit code is higher
3154    * than this, it needs to be assumed that it is a VMS exit code and
3155    * passed through.
3156    */
3157
3158 #   define STATUS_EXIT_SET(n)                           \
3159         STMT_START {                                    \
3160             I32 evalue = (I32)n;                        \
3161             PL_statusvalue = evalue;                    \
3162             if (MY_POSIX_EXIT)                          \
3163                 if (evalue > 255) PL_statusvalue_vms = evalue; else {   \
3164                   PL_statusvalue_vms = \
3165                     (C_FAC_POSIX | (evalue << 3 ) |     \
3166                      ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
3167             else                                        \
3168                 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3169             set_vaxc_errno(PL_statusvalue_vms);         \
3170         } STMT_END
3171
3172
3173  /* This macro forces a success status */
3174 #   define STATUS_ALL_SUCCESS   \
3175         (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
3176
3177  /* This macro forces a failure status */
3178 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, \
3179      vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3180         (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3181
3182 #elif defined(__amigaos4__)
3183  /* A somewhat experimental attempt to simulate posix return code values */
3184 #   define STATUS_NATIVE        PL_statusvalue_posix
3185 #   define STATUS_NATIVE_CHILD_SET(n)                      \
3186         STMT_START {                                       \
3187             PL_statusvalue_posix = (n);                    \
3188             if (PL_statusvalue_posix < 0) {                \
3189                 PL_statusvalue = -1;                       \
3190             }                                              \
3191             else {                                         \
3192                 PL_statusvalue = n << 8;                   \
3193             }                                              \
3194         } STMT_END
3195 #   define STATUS_UNIX_SET(n)           \
3196         STMT_START {                    \
3197             PL_statusvalue = (n);               \
3198             if (PL_statusvalue != -1)   \
3199                 PL_statusvalue &= 0xFFFF;       \
3200         } STMT_END
3201 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3202 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3203 #   define STATUS_CURRENT STATUS_UNIX
3204 #   define STATUS_EXIT STATUS_UNIX
3205 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3206 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3207
3208 #else
3209 #   define STATUS_NATIVE        PL_statusvalue_posix
3210 #   if defined(WCOREDUMP)
3211 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3212             STMT_START {                                   \
3213                 PL_statusvalue_posix = (n);                \
3214                 if (PL_statusvalue_posix == -1)            \
3215                     PL_statusvalue = -1;                   \
3216                 else {                                     \
3217                     PL_statusvalue =                       \
3218                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3219                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3220                         (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0);  \
3221                 }                                          \
3222             } STMT_END
3223 #   elif defined(WIFEXITED)
3224 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3225             STMT_START {                                   \
3226                 PL_statusvalue_posix = (n);                \
3227                 if (PL_statusvalue_posix == -1)            \
3228                     PL_statusvalue = -1;                   \
3229                 else {                                     \
3230                     PL_statusvalue =                       \
3231                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3232                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0);  \
3233                 }                                          \
3234             } STMT_END
3235 #   else
3236 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3237             STMT_START {                                   \
3238                 PL_statusvalue_posix = (n);                \
3239                 if (PL_statusvalue_posix == -1)            \
3240                     PL_statusvalue = -1;                   \
3241                 else {                                     \
3242                     PL_statusvalue =                       \
3243                         PL_statusvalue_posix & 0xFFFF;     \
3244                 }                                          \
3245             } STMT_END
3246 #   endif
3247 #   define STATUS_UNIX_SET(n)           \
3248         STMT_START {                    \
3249             PL_statusvalue = (n);               \
3250             if (PL_statusvalue != -1)   \
3251                 PL_statusvalue &= 0xFFFF;       \
3252         } STMT_END
3253 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3254 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3255 #   define STATUS_CURRENT STATUS_UNIX
3256 #   define STATUS_EXIT STATUS_UNIX
3257 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3258 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3259 #endif
3260
3261 /* flags in PL_exit_flags for nature of exit() */
3262 #define PERL_EXIT_EXPECTED      0x01
3263 #define PERL_EXIT_DESTRUCT_END  0x02  /* Run END in perl_destruct */
3264 #define PERL_EXIT_WARN          0x04  /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3265 #define PERL_EXIT_ABORT         0x08  /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3266
3267 #ifndef PERL_CORE
3268 /* format to use for version numbers in file/directory names */
3269 /* XXX move to Configure? */
3270 /* This was only ever used for the current version, and that can be done at
3271    compile time, as PERL_FS_VERSION, so should we just delete it?  */
3272 #  ifndef PERL_FS_VER_FMT
3273 #    define PERL_FS_VER_FMT     "%d.%d.%d"
3274 #  endif
3275 #endif
3276
3277 #ifndef PERL_FS_VERSION
3278 #  define PERL_FS_VERSION       PERL_VERSION_STRING
3279 #endif
3280
3281 /* This defines a way to flush all output buffers.  This may be a
3282  * performance issue, so we allow people to disable it.  Also, if
3283  * we are using stdio, there are broken implementations of fflush(NULL)
3284  * out there, Solaris being the most prominent.
3285  */
3286 #ifndef PERL_FLUSHALL_FOR_CHILD
3287 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3288 #  define PERL_FLUSHALL_FOR_CHILD       PerlIO_flush((PerlIO*)NULL)
3289 # elif defined(FFLUSH_ALL)
3290 #  define PERL_FLUSHALL_FOR_CHILD       my_fflush_all()
3291 # else
3292 #  define PERL_FLUSHALL_FOR_CHILD       NOOP
3293 # endif
3294 #endif
3295
3296 #ifndef PERL_WAIT_FOR_CHILDREN
3297 #  define PERL_WAIT_FOR_CHILDREN        NOOP
3298 #endif
3299
3300 /* the traditional thread-unsafe notion of "current interpreter". */
3301 #ifndef PERL_SET_INTERP
3302 #  define PERL_SET_INTERP(i)            (PL_curinterp = (PerlInterpreter*)(i))
3303 #endif
3304
3305 #ifndef PERL_GET_INTERP
3306 #  define PERL_GET_INTERP               (PL_curinterp)
3307 #endif
3308
3309 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3310 #  ifdef MULTIPLICITY
3311 #    define PERL_GET_THX                ((PerlInterpreter *)PERL_GET_CONTEXT)
3312 #  endif
3313 #  define PERL_SET_THX(t)               PERL_SET_CONTEXT(t)
3314 #endif
3315
3316 /*
3317     This replaces the previous %_ "hack" by the "%p" hacks.
3318     All that is required is that the perl source does not
3319     use "%-p" or "%-<number>p" or "%<number>p" formats.
3320     These formats will still work in perl code.
3321     See comments in sv.c for further details.
3322
3323     Robin Barker 2005-07-14
3324
3325     No longer use %1p for VDf = %vd.  RMB 2007-10-19
3326 */
3327
3328 #ifndef SVf_
3329 #  define SVf_(n) "-" STRINGIFY(n) "p"
3330 #endif
3331
3332 #ifndef SVf
3333 #  define SVf "-p"
3334 #endif
3335
3336 #ifndef SVf32
3337 #  define SVf32 SVf_(32)
3338 #endif
3339
3340 #ifndef SVf256
3341 #  define SVf256 SVf_(256)
3342 #endif
3343
3344 #define SVfARG(p) ((void*)(p))
3345
3346 #ifndef HEKf
3347 #  define HEKf "2p"
3348 #endif
3349
3350 /* Not ideal, but we cannot easily include a number in an already-numeric
3351  * format sequence. */
3352 #ifndef HEKf256
3353 #  define HEKf256 "3p"
3354 #endif
3355
3356 #define HEKfARG(p) ((void*)(p))
3357
3358 /* Takes three arguments: is_utf8, length, str */
3359 #ifndef UTF8f
3360 #  define UTF8f "d%" UVuf "%4p"
3361 #endif
3362 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3363
3364 #define PNf UTF8f
3365 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
3366
3367 #ifdef PERL_CORE
3368 /* not used; but needed for backward compatibility with XS code? - RMB */
3369 #  undef UVf
3370 #elif !defined(UVf)
3371 #  define UVf UVuf
3372 #endif
3373
3374 #ifdef HASATTRIBUTE_DEPRECATED
3375 #  define __attribute__deprecated__         __attribute__((deprecated))
3376 #endif
3377 #ifdef HASATTRIBUTE_FORMAT
3378 #  define __attribute__format__(x,y,z)      __attribute__((format(x,y,z)))
3379 #endif
3380 #ifdef HASATTRIBUTE_MALLOC
3381 #  define __attribute__malloc__             __attribute__((__malloc__))
3382 #endif
3383 #ifdef HASATTRIBUTE_NONNULL
3384 #  define __attribute__nonnull__(a)         __attribute__((nonnull(a)))
3385 #endif
3386 #ifdef HASATTRIBUTE_NORETURN
3387 #  define __attribute__noreturn__           __attribute__((noreturn))
3388 #endif
3389 #ifdef HASATTRIBUTE_PURE
3390 #  define __attribute__pure__               __attribute__((pure))
3391 #endif
3392 #ifdef HASATTRIBUTE_UNUSED
3393 #  define __attribute__unused__             __attribute__((unused))
3394 #endif
3395 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
3396 #  define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
3397 #endif
3398
3399 /* If we haven't defined the attributes yet, define them to blank. */
3400 #ifndef __attribute__deprecated__
3401 #  define __attribute__deprecated__
3402 #endif
3403 #ifndef __attribute__format__
3404 #  define __attribute__format__(x,y,z)
3405 #endif
3406 #ifndef __attribute__malloc__
3407 #  define __attribute__malloc__
3408 #endif
3409 #ifndef __attribute__nonnull__
3410 #  define __attribute__nonnull__(a)
3411 #endif
3412 #ifndef __attribute__noreturn__
3413 #  define __attribute__noreturn__
3414 #endif
3415 #ifndef __attribute__pure__
3416 #  define __attribute__pure__
3417 #endif
3418 #ifndef __attribute__unused__
3419 #  define __attribute__unused__
3420 #endif
3421 #ifndef __attribute__warn_unused_result__
3422 #  define __attribute__warn_unused_result__
3423 #endif
3424
3425 #if !defined(DEBUGGING) && !defined(NDEBUG)
3426 #  define NDEBUG 1
3427 #endif
3428 #include <assert.h>
3429
3430 /* For functions that are marked as __attribute__noreturn__, it's not
3431    appropriate to call return.  In either case, include the lint directive.
3432  */
3433 #ifdef HASATTRIBUTE_NORETURN
3434 #  define NORETURN_FUNCTION_END NOT_REACHED;
3435 #else
3436 #  define NORETURN_FUNCTION_END NOT_REACHED; return 0
3437 #endif
3438
3439 /* Some OS warn on NULL format to printf */
3440 #ifdef PRINTF_FORMAT_NULL_OK
3441 #  define __attribute__format__null_ok__(x,y,z)  __attribute__format__(x,y,z)
3442 #else
3443 #  define __attribute__format__null_ok__(x,y,z)
3444 #endif
3445
3446 #ifdef HAS_BUILTIN_EXPECT
3447 #  define EXPECT(expr,val)                  __builtin_expect(expr,val)
3448 #else
3449 #  define EXPECT(expr,val)                  (expr)
3450 #endif
3451 #define LIKELY(cond)                        EXPECT(cBOOL(cond),TRUE)
3452 #define UNLIKELY(cond)                      EXPECT(cBOOL(cond),FALSE)
3453 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3454 /* placeholder */
3455 #endif
3456
3457 /* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
3458    time invariants. That is, their argument must be a constant expression that
3459    can be verified by the compiler. This expression can contain anything that's
3460    known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3461    the expression evaluates to 0, compilation fails.
3462    Because they generate no runtime code (i.e.  their use is "free"), they're
3463    always active, even under non-DEBUGGING builds.
3464    STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
3465    file scope (outside of any function).
3466    STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3467    function.
3468 */
3469 #if (defined(static_assert) || (defined(__cplusplus) && __cplusplus >= 201103L)) && (!defined(__IBMC__) || __IBMC__ >= 1210)
3470 /* static_assert is a macro defined in <assert.h> in C11 or a compiler
3471    builtin in C++11.  But IBM XL C V11 does not support _Static_assert, no
3472    matter what <assert.h> says.
3473 */
3474 #  define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
3475 #else
3476 /* We use a bit-field instead of an array because gcc accepts
3477    'typedef char x[n]' where n is not a compile-time constant.
3478    We want to enforce constantness.
3479 */
3480 #  define STATIC_ASSERT_2(COND, SUFFIX) \
3481     typedef struct { \
3482         unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3483     } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3484 #  define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
3485 #  define STATIC_ASSERT_DECL(COND)    STATIC_ASSERT_1(COND, __LINE__)
3486 #endif
3487 /* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3488    error (static_assert is a declaration, and only statements can have labels).
3489 */
3490 #define STATIC_ASSERT_STMT(COND)      STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
3491
3492 #ifndef __has_builtin
3493 #  define __has_builtin(x) 0 /* not a clang style compiler */
3494 #endif
3495
3496 /* ASSUME is like assert(), but it has a benefit in a release build. It is a
3497    hint to a compiler about a statement of fact in a function call free
3498    expression, which allows the compiler to generate better machine code.
3499    In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3500    the control path is unreachable. In a for loop, ASSUME can be used to hint
3501    that a loop will run at least X times. ASSUME is based off MSVC's __assume
3502    intrinsic function, see its documents for more details.
3503 */
3504
3505 #ifndef DEBUGGING
3506 #  if __has_builtin(__builtin_unreachable) \
3507      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4) /* 4.5 -> */
3508 #    define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3509 #  elif defined(_MSC_VER)
3510 #    define ASSUME(x) __assume(x)
3511 #  elif defined(__ARMCC_VERSION) /* untested */
3512 #    define ASSUME(x) __promise(x)
3513 #  else
3514 /* a random compiler might define assert to its own special optimization token
3515    so pass it through to C lib as a last resort */
3516 #    define ASSUME(x) assert(x)
3517 #  endif
3518 #else
3519 #  define ASSUME(x) assert(x)
3520 #endif
3521
3522 #if defined(__sun)      /* ASSUME() generates warnings on Solaris */
3523 #  define NOT_REACHED
3524 #elif defined(DEBUGGING) && (__has_builtin(__builtin_unreachable) \
3525      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4)) /* 4.5 -> */
3526 #  define NOT_REACHED STMT_START { ASSUME(0); __builtin_unreachable(); } STMT_END
3527 #else
3528 #  define NOT_REACHED ASSUME(0)
3529 #endif
3530
3531 /* Some unistd.h's give a prototype for pause() even though
3532    HAS_PAUSE ends up undefined.  This causes the #define
3533    below to be rejected by the compiler.  Sigh.
3534 */
3535 #ifdef HAS_PAUSE
3536 #define Pause   pause
3537 #else
3538 #define Pause() sleep((32767<<16)+32767)
3539 #endif
3540
3541 #ifndef IOCPARM_LEN
3542 #   ifdef IOCPARM_MASK
3543         /* on BSDish systems we're safe */
3544 #       define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
3545 #   elif defined(_IOC_SIZE) && defined(__GLIBC__)
3546         /* on Linux systems we're safe; except when we're not [perl #38223] */
3547 #       define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3548 #   else
3549         /* otherwise guess at what's safe */
3550 #       define IOCPARM_LEN(x)   256
3551 #   endif
3552 #endif
3553
3554 #if defined(__CYGWIN__)
3555 /* USEMYBINMODE
3556  *   This symbol, if defined, indicates that the program should
3557  *   use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3558  *   that a file is in "binary" mode -- that is, that no translation
3559  *   of bytes occurs on read or write operations.
3560  */
3561 #  define USEMYBINMODE /**/
3562 #  include <io.h> /* for setmode() prototype */
3563 #  define my_binmode(fp, iotype, mode) \
3564             cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
3565 #endif
3566
3567 #ifdef __CYGWIN__
3568 void init_os_extras(void);
3569 #endif
3570
3571 #ifdef UNION_ANY_DEFINITION
3572 UNION_ANY_DEFINITION;
3573 #else
3574 union any {
3575     void*       any_ptr;
3576     SV*         any_sv;
3577     SV**        any_svp;
3578     GV*         any_gv;
3579     AV*         any_av;
3580     HV*         any_hv;
3581     OP*         any_op;
3582     char*       any_pv;
3583     char**      any_pvp;
3584     I32         any_i32;
3585     U32         any_u32;
3586     IV          any_iv;
3587     UV          any_uv;
3588     long        any_long;
3589     bool        any_bool;
3590     void        (*any_dptr) (void*);
3591     void        (*any_dxptr) (pTHX_ void*);
3592 };
3593 #endif
3594
3595 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3596
3597 #define FILTER_READ(idx, sv, len)  filter_read(idx, sv, len)
3598 #define FILTER_DATA(idx) \
3599             (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3600 #define FILTER_ISREADER(idx) \
3601             (PL_parser && PL_parser->rsfp_filters \
3602                 && idx >= AvFILLp(PL_parser->rsfp_filters))
3603 #define PERL_FILTER_EXISTS(i) \
3604             (PL_parser && PL_parser->rsfp_filters \
3605                 && (i) <= av_tindex(PL_parser->rsfp_filters))
3606
3607 #if defined(_AIX) && !defined(_AIX43)
3608 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3609 /* We cannot include <crypt.h> to get the struct crypt_data
3610  * because of setkey prototype problems when threading */
3611 typedef        struct crypt_data {     /* straight from /usr/include/crypt.h */
3612     /* From OSF, Not needed in AIX
3613        char C[28], D[28];
3614     */
3615     char E[48];
3616     char KS[16][48];
3617     char block[66];
3618     char iobuf[16];
3619 } CRYPTD;
3620 #endif /* threading */
3621 #endif /* AIX */
3622
3623 #ifndef PERL_CALLCONV
3624 #  ifdef __cplusplus
3625 #    define PERL_CALLCONV extern "C"
3626 #  else
3627 #    define PERL_CALLCONV
3628 #  endif
3629 #endif
3630 #ifndef PERL_CALLCONV_NO_RET
3631 #    define PERL_CALLCONV_NO_RET PERL_CALLCONV
3632 #endif
3633
3634 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
3635    dont have a noreturn as a declaration specifier
3636 */
3637 #ifndef PERL_STATIC_NO_RET
3638 #  define PERL_STATIC_NO_RET STATIC
3639 #endif
3640 /* PERL_STATIC_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE on
3641    builds that dont have a noreturn as a declaration specifier
3642 */
3643 #ifndef PERL_STATIC_INLINE_NO_RET
3644 #  define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
3645 #endif
3646
3647 #if !defined(OS2)
3648 #  include "iperlsys.h"
3649 #endif
3650
3651 #ifdef __LIBCATAMOUNT__
3652 #undef HAS_PASSWD  /* unixish.h but not unixish enough. */
3653 #undef HAS_GROUP
3654 #define FAKE_BIT_BUCKET
3655 #endif
3656
3657 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3658  * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
3659  * Configure, despite their names being similar to other defines like
3660  * USE_ITHREADS.  Configure in fact knows nothing about the randomised
3661  * hashes.  Therefore to enable/disable the hash randomisation defines
3662  * use the Configure -Accflags=... instead. */
3663 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
3664 #  define USE_HASH_SEED
3665 #endif
3666
3667 #include "perly.h"
3668
3669
3670 /* macros to define bit-fields in structs. */
3671 #ifndef PERL_BITFIELD8
3672 #  define PERL_BITFIELD8 unsigned
3673 #endif
3674 #ifndef PERL_BITFIELD16
3675 #  define PERL_BITFIELD16 unsigned
3676 #endif
3677 #ifndef PERL_BITFIELD32
3678 #  define PERL_BITFIELD32 unsigned
3679 #endif
3680
3681 #include "sv.h"
3682 #include "regexp.h"
3683 #include "util.h"
3684 #include "form.h"
3685 #include "gv.h"
3686 #include "pad.h"
3687 #include "cv.h"
3688 #include "opnames.h"
3689 #include "op.h"
3690 #include "hv.h"
3691 #include "cop.h"
3692 #include "av.h"
3693 #include "mg.h"
3694 #include "scope.h"
3695 #include "warnings.h"
3696 #include "utf8.h"
3697
3698 /* these would be in doio.h if there was such a file */
3699 #define my_stat()  my_stat_flags(SV_GMAGIC)
3700 #define my_lstat() my_lstat_flags(SV_GMAGIC)
3701
3702 /* defined in sv.c, but also used in [ach]v.c */
3703 #undef _XPV_HEAD
3704 #undef _XPVMG_HEAD
3705 #undef _XPVCV_COMMON
3706
3707 #include "parser.h"
3708
3709 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
3710
3711 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3712
3713 /* These have to be predeclared, as they are used in proto.h which is #included
3714  * before their definitions in regcomp.h. */
3715
3716 struct scan_data_t;
3717 typedef struct regnode_charclass regnode_charclass;
3718
3719 /* A hopefully less confusing name.  The sub-classes are all Posix classes only
3720  * used under /l matching */
3721 typedef struct regnode_charclass_posixl regnode_charclass_class;
3722 typedef struct regnode_charclass_posixl regnode_charclass_posixl;
3723
3724 typedef struct regnode_ssc regnode_ssc;
3725 typedef struct RExC_state_t RExC_state_t;
3726 struct _reg_trie_data;
3727
3728 #endif
3729
3730 struct ptr_tbl_ent {
3731     struct ptr_tbl_ent*         next;
3732     const void*                 oldval;
3733     void*                       newval;
3734 };
3735
3736 struct ptr_tbl {
3737     struct ptr_tbl_ent**        tbl_ary;
3738     UV                          tbl_max;
3739     UV                          tbl_items;
3740     struct ptr_tbl_arena        *tbl_arena;
3741     struct ptr_tbl_ent          *tbl_arena_next;
3742     struct ptr_tbl_ent          *tbl_arena_end;
3743 };
3744
3745 #if defined(htonl) && !defined(HAS_HTONL)
3746 #define HAS_HTONL
3747 #endif
3748 #if defined(htons) && !defined(HAS_HTONS)
3749 #define HAS_HTONS
3750 #endif
3751 #if defined(ntohl) && !defined(HAS_NTOHL)
3752 #define HAS_NTOHL
3753 #endif
3754 #if defined(ntohs) && !defined(HAS_NTOHS)
3755 #define HAS_NTOHS
3756 #endif
3757 #ifndef HAS_HTONL
3758 #define HAS_HTONS
3759 #define HAS_HTONL
3760 #define HAS_NTOHS
3761 #define HAS_NTOHL
3762 #  if (BYTEORDER & 0xffff) == 0x4321
3763 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
3764    re-order their values. However, to behave identically to the alternative
3765    implementations, they should truncate to the correct size.  */
3766 #    define ntohl(x)    ((x)&0xFFFFFFFF)
3767 #    define htonl(x)    ntohl(x)
3768 #    define ntohs(x)    ((x)&0xFFFF)
3769 #    define htons(x)    ntohs(x)
3770 #  elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3771
3772 /* Note that we can't straight out declare our own htonl and htons because
3773    the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
3774    to avoid the overhead of initialising the socket subsystem, but the headers
3775    that *declare* the various functions are still seen. If we declare our own
3776    htonl etc they will clash with the declarations in the Win32 headers.  */
3777
3778 PERL_STATIC_INLINE U32
3779 my_swap32(const U32 x) {
3780     return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)      
3781         | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
3782 }
3783
3784 PERL_STATIC_INLINE U16
3785 my_swap16(const U16 x) {
3786     return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
3787 }
3788
3789 #    define htonl(x)    my_swap32(x)
3790 #    define ntohl(x)    my_swap32(x)
3791 #    define ntohs(x)    my_swap16(x)
3792 #    define htons(x)    my_swap16(x)
3793 #  else
3794 #    error "Unsupported byteorder"
3795 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
3796    the error message. Please check the value of the macro BYTEORDER, as defined
3797    in config.h. The values of BYTEORDER we expect are
3798
3799             big endian  little endian
3800    32 bit       0x4321  0x1234
3801    64 bit   0x87654321  0x12345678
3802
3803    If you have a system with a different byte order, please see
3804    pod/perlhack.pod for how to submit a patch to add supporting code.
3805 */
3806 #  endif
3807 #endif
3808
3809 /*
3810  * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
3811  * -DWS
3812  */
3813 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3814 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
3815    re-order their values. However, to behave identically to the alternative
3816    implementations, they should truncate to the correct size.  */
3817 #  define vtohl(x)      ((x)&0xFFFFFFFF)
3818 #  define vtohs(x)      ((x)&0xFFFF)
3819 #  define htovl(x)      vtohl(x)
3820 #  define htovs(x)      vtohs(x)
3821 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
3822 #  define vtohl(x)      ((((x)&0xFF)<<24)       \
3823                         +(((x)>>24)&0xFF)       \
3824                         +(((x)&0x0000FF00)<<8)  \
3825                         +(((x)&0x00FF0000)>>8)  )
3826 #  define vtohs(x)      ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
3827 #  define htovl(x)      vtohl(x)
3828 #  define htovs(x)      vtohs(x)
3829 #else
3830 #  error "Unsupported byteorder"
3831 /* If you have need for current perl on PDP-11 or similar, and can help test
3832    that blead keeps working on a mixed-endian system, then see
3833    pod/perlhack.pod for how to submit patches to things working again.  */
3834 #endif
3835
3836 /* *MAX Plus 1. A floating point value.
3837    Hopefully expressed in a way that dodgy floating point can't mess up.
3838    >> 2 rather than 1, so that value is safely less than I32_MAX after 1
3839    is added to it
3840    May find that some broken compiler will want the value cast to I32.
3841    [after the shift, as signed >> may not be as secure as unsigned >>]
3842 */
3843 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
3844 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
3845 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
3846    0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
3847    may be greater than sizeof(IV), so don't assume that half max UV is max IV.
3848 */
3849 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
3850
3851 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
3852 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
3853 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
3854
3855 /* This may look like unnecessary jumping through hoops, but converting
3856    out of range floating point values to integers *is* undefined behaviour,
3857    and it is starting to bite.
3858 */
3859 #ifndef CAST_INLINE
3860 #define I_32(what) (cast_i32((NV)(what)))
3861 #define U_32(what) (cast_ulong((NV)(what)))
3862 #define I_V(what) (cast_iv((NV)(what)))
3863 #define U_V(what) (cast_uv((NV)(what)))
3864 #else
3865 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
3866                   : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
3867                      : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
3868 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
3869                   : ((n) < U32_MAX_P1 ? (U32) (n) \
3870                      : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
3871 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
3872                   : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
3873                      : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
3874 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
3875                   : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
3876                      : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
3877 #endif
3878
3879 #define U_S(what) ((U16)U_32(what))
3880 #define U_I(what) ((unsigned int)U_32(what))
3881 #define U_L(what) U_32(what)
3882
3883 #ifdef HAS_SIGNBIT
3884 #  ifndef Perl_signbit
3885 #    define Perl_signbit signbit
3886 #  endif
3887 #endif
3888
3889 /* These do not care about the fractional part, only about the range. */
3890 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
3891 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
3892
3893 /* Used with UV/IV arguments: */
3894                                         /* XXXX: need to speed it up */
3895 #define CLUMP_2UV(iv)   ((iv) < 0 ? 0 : (UV)(iv))
3896 #define CLUMP_2IV(uv)   ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
3897
3898 #ifndef MAXSYSFD
3899 #   define MAXSYSFD 2
3900 #endif
3901
3902 #ifndef __cplusplus
3903 #if !(defined(WIN32) || defined(UNDER_CE) || defined(SYMBIAN))
3904 Uid_t getuid (void);
3905 Uid_t geteuid (void);
3906 Gid_t getgid (void);
3907 Gid_t getegid (void);
3908 #endif
3909 #endif
3910
3911 #ifndef Perl_debug_log
3912 #  define Perl_debug_log        PerlIO_stderr()
3913 #endif
3914
3915 #ifndef Perl_error_log
3916 #  define Perl_error_log        (PL_stderrgv                    \
3917                                  && isGV(PL_stderrgv)           \
3918                                  && GvIOp(PL_stderrgv)          \
3919                                  && IoOFP(GvIOp(PL_stderrgv))   \
3920                                  ? IoOFP(GvIOp(PL_stderrgv))    \
3921                                  : PerlIO_stderr())
3922 #endif
3923
3924
3925 #define DEBUG_p_FLAG            0x00000001 /*      1 */
3926 #define DEBUG_s_FLAG            0x00000002 /*      2 */
3927 #define DEBUG_l_FLAG            0x00000004 /*      4 */
3928 #define DEBUG_t_FLAG            0x00000008 /*      8 */
3929 #define DEBUG_o_FLAG            0x00000010 /*     16 */
3930 #define DEBUG_c_FLAG            0x00000020 /*     32 */
3931 #define DEBUG_P_FLAG            0x00000040 /*     64 */
3932 #define DEBUG_m_FLAG            0x00000080 /*    128 */
3933 #define DEBUG_f_FLAG            0x00000100 /*    256 */
3934 #define DEBUG_r_FLAG            0x00000200 /*    512 */
3935 #define DEBUG_x_FLAG            0x00000400 /*   1024 */
3936 #define DEBUG_u_FLAG            0x00000800 /*   2048 */
3937 /* U is reserved for Unofficial, exploratory hacking */
3938 #define DEBUG_U_FLAG            0x00001000 /*   4096 */
3939 /* spare                                        8192 */
3940 #define DEBUG_X_FLAG            0x00004000 /*  16384 */
3941 #define DEBUG_D_FLAG            0x00008000 /*  32768 */
3942 #define DEBUG_S_FLAG            0x00010000 /*  65536 */
3943 #define DEBUG_T_FLAG            0x00020000 /* 131072 */
3944 #define DEBUG_R_FLAG            0x00040000 /* 262144 */
3945 #define DEBUG_J_FLAG            0x00080000 /* 524288 */
3946 #define DEBUG_v_FLAG            0x00100000 /*1048576 */
3947 #define DEBUG_C_FLAG            0x00200000 /*2097152 */
3948 #define DEBUG_A_FLAG            0x00400000 /*4194304 */
3949 #define DEBUG_q_FLAG            0x00800000 /*8388608 */
3950 #define DEBUG_M_FLAG            0x01000000 /*16777216*/
3951 #define DEBUG_B_FLAG            0x02000000 /*33554432*/
3952 #define DEBUG_L_FLAG            0x04000000 /*67108864*/
3953 #define DEBUG_i_FLAG            0x08000000 /*134217728*/
3954 #define DEBUG_MASK              0x0FFFEFFF /* mask of all the standard flags */
3955
3956 #define DEBUG_DB_RECURSE_FLAG   0x40000000
3957 #define DEBUG_TOP_FLAG          0x80000000 /* -D was given --> PL_debug |= FLAG */
3958
3959 #  define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
3960 #  define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
3961 #  define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
3962 #  define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
3963 #  define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
3964 #  define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
3965 #  define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
3966 #  define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
3967 #  define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
3968 #  define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
3969 #  define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
3970 #  define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
3971 #  define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
3972 #  define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
3973 #  define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
3974 #  define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
3975 #  define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
3976 #  define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
3977 #  define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
3978 #  define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
3979 #  define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
3980 #  define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
3981 #  define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
3982 #  define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
3983 #  define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
3984 #  define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
3985 #  define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
3986 #  define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
3987 #  define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
3988 #  define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
3989 #  define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
3990
3991 #ifdef DEBUGGING
3992
3993 #  define DEBUG_p_TEST DEBUG_p_TEST_
3994 #  define DEBUG_s_TEST DEBUG_s_TEST_
3995 #  define DEBUG_l_TEST DEBUG_l_TEST_
3996 #  define DEBUG_t_TEST DEBUG_t_TEST_
3997 #  define DEBUG_o_TEST DEBUG_o_TEST_
3998 #  define DEBUG_c_TEST DEBUG_c_TEST_
3999 #  define DEBUG_P_TEST DEBUG_P_TEST_
4000 #  define DEBUG_m_TEST DEBUG_m_TEST_
4001 #  define DEBUG_f_TEST DEBUG_f_TEST_
4002 #  define DEBUG_r_TEST DEBUG_r_TEST_
4003 #  define DEBUG_x_TEST DEBUG_x_TEST_
4004 #  define DEBUG_u_TEST DEBUG_u_TEST_
4005 #  define DEBUG_U_TEST DEBUG_U_TEST_
4006 #  define DEBUG_X_TEST DEBUG_X_TEST_
4007 #  define DEBUG_D_TEST DEBUG_D_TEST_
4008 #  define DEBUG_S_TEST DEBUG_S_TEST_
4009 #  define DEBUG_T_TEST DEBUG_T_TEST_
4010 #  define DEBUG_R_TEST DEBUG_R_TEST_
4011 #  define DEBUG_J_TEST DEBUG_J_TEST_
4012 #  define DEBUG_v_TEST DEBUG_v_TEST_
4013 #  define DEBUG_C_TEST DEBUG_C_TEST_
4014 #  define DEBUG_A_TEST DEBUG_A_TEST_
4015 #  define DEBUG_q_TEST DEBUG_q_TEST_
4016 #  define DEBUG_M_TEST DEBUG_M_TEST_
4017 #  define DEBUG_B_TEST DEBUG_B_TEST_
4018 #  define DEBUG_L_TEST DEBUG_L_TEST_
4019 #  define DEBUG_i_TEST DEBUG_i_TEST_
4020 #  define DEBUG_Xv_TEST DEBUG_Xv_TEST_
4021 #  define DEBUG_Uv_TEST DEBUG_Uv_TEST_
4022 #  define DEBUG_Pv_TEST DEBUG_Pv_TEST_
4023 #  define DEBUG_Lv_TEST DEBUG_Lv_TEST_
4024
4025 #  define PERL_DEB(a)                  a
4026 #  define PERL_DEB2(a,b)               a
4027 #  define PERL_DEBUG(a) if (PL_debug)  a
4028 #  define DEBUG_p(a) if (DEBUG_p_TEST) a
4029 #  define DEBUG_s(a) if (DEBUG_s_TEST) a
4030 #  define DEBUG_l(a) if (DEBUG_l_TEST) a
4031 #  define DEBUG_t(a) if (DEBUG_t_TEST) a
4032 #  define DEBUG_o(a) if (DEBUG_o_TEST) a
4033 #  define DEBUG_c(a) if (DEBUG_c_TEST) a
4034 #  define DEBUG_P(a) if (DEBUG_P_TEST) a
4035
4036      /* Temporarily turn off memory debugging in case the a
4037       * does memory allocation, either directly or indirectly. */
4038 #  define DEBUG_m(a)  \
4039     STMT_START {                                                        \
4040         if (PERL_GET_INTERP) {                                          \
4041                                 dTHX;                                   \
4042                                 if (DEBUG_m_TEST) {                     \
4043                                     PL_debug &= ~DEBUG_m_FLAG;          \
4044                                     a;                                  \
4045                                     PL_debug |= DEBUG_m_FLAG;           \
4046                                 }                                       \
4047                               }                                         \
4048     } STMT_END
4049
4050 #  define DEBUG__(t, a)                                                 \
4051         STMT_START {                                                    \
4052                 if (t) STMT_START {a;} STMT_END;                        \
4053         } STMT_END
4054
4055 #  define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
4056
4057 #  ifndef PERL_EXT_RE_BUILD
4058 #    define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
4059 #  else
4060 #    define DEBUG_r(a) STMT_START {a;} STMT_END
4061 #  endif /* PERL_EXT_RE_BUILD */
4062
4063 #  define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
4064 #  define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
4065 #  define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
4066 #  define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
4067 #  define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
4068 #  define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
4069 #  define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
4070 #  define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
4071 #  define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
4072
4073 #  define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
4074 #  define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
4075 #  define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
4076 #  define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
4077 #  define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
4078 #  define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
4079 #  define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
4080 #  define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
4081 #  define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
4082 #  define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
4083 #  define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
4084
4085 #else /* ! DEBUGGING below */
4086
4087 #  define DEBUG_p_TEST (0)
4088 #  define DEBUG_s_TEST (0)
4089 #  define DEBUG_l_TEST (0)
4090 #  define DEBUG_t_TEST (0)
4091 #  define DEBUG_o_TEST (0)
4092 #  define DEBUG_c_TEST (0)
4093 #  define DEBUG_P_TEST (0)
4094 #  define DEBUG_m_TEST (0)
4095 #  define DEBUG_f_TEST (0)
4096 #  define DEBUG_r_TEST (0)
4097 #  define DEBUG_x_TEST (0)
4098 #  define DEBUG_u_TEST (0)
4099 #  define DEBUG_U_TEST (0)
4100 #  define DEBUG_X_TEST (0)
4101 #  define DEBUG_D_TEST (0)
4102 #  define DEBUG_S_TEST (0)
4103 #  define DEBUG_T_TEST (0)
4104 #  define DEBUG_R_TEST (0)
4105 #  define DEBUG_J_TEST (0)
4106 #  define DEBUG_v_TEST (0)
4107 #  define DEBUG_C_TEST (0)
4108 #  define DEBUG_A_TEST (0)
4109 #  define DEBUG_q_TEST (0)
4110 #  define DEBUG_M_TEST (0)
4111 #  define DEBUG_B_TEST (0)
4112 #  define DEBUG_L_TEST (0)
4113 #  define DEBUG_i_TEST (0)
4114 #  define DEBUG_Xv_TEST (0)
4115 #  define DEBUG_Uv_TEST (0)
4116 #  define DEBUG_Pv_TEST (0)
4117 #  define DEBUG_Lv_TEST (0)
4118
4119 #  define PERL_DEB(a)
4120 #  define PERL_DEB2(a,b)               b
4121 #  define PERL_DEBUG(a)
4122 #  define DEBUG_p(a)
4123 #  define DEBUG_s(a)
4124 #  define DEBUG_l(a)
4125 #  define DEBUG_t(a)
4126 #  define DEBUG_o(a)
4127 #  define DEBUG_c(a)
4128 #  define DEBUG_P(a)
4129 #  define DEBUG_m(a)
4130 #  define DEBUG_f(a)
4131 #  define DEBUG_r(a)
4132 #  define DEBUG_x(a)
4133 #  define DEBUG_u(a)
4134 #  define DEBUG_U(a)
4135 #  define DEBUG_X(a)
4136 #  define DEBUG_D(a)
4137 #  define DEBUG_S(a)
4138 #  define DEBUG_T(a)
4139 #  define DEBUG_R(a)
4140 #  define DEBUG_v(a)
4141 #  define DEBUG_C(a)
4142 #  define DEBUG_A(a)
4143 #  define DEBUG_q(a)
4144 #  define DEBUG_M(a)
4145 #  define DEBUG_B(a)
4146 #  define DEBUG_L(a)
4147 #  define DEBUG_i(a)
4148 #  define DEBUG_Xv(a)
4149 #  define DEBUG_Uv(a)
4150 #  define DEBUG_Pv(a)
4151 #  define DEBUG_Lv(a)
4152 #endif /* DEBUGGING */
4153
4154
4155 #define DEBUG_SCOPE(where) \
4156     DEBUG_l( \
4157     Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n",   \
4158                     where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
4159                     __FILE__, __LINE__));
4160
4161 /* Keep the old croak based assert for those who want it, and as a fallback if
4162    the platform is so heretically non-ANSI that it can't assert.  */
4163
4164 #define Perl_assert(what)       PERL_DEB2(                              \
4165         ((what) ? ((void) 0) :                                          \
4166             (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
4167                         "\", line %d", STRINGIFY(what), __LINE__),      \
4168              (void) 0)), ((void)0))
4169
4170 /* assert() gets defined if DEBUGGING.
4171  * If no DEBUGGING, the <assert.h> has not been included. */
4172 #ifndef assert
4173 #  define assert(what)  Perl_assert(what)
4174 #endif
4175 #ifdef DEBUGGING
4176 #  define assert_(what) assert(what),
4177 #else
4178 #  define assert_(what)
4179 #endif
4180
4181 struct ufuncs {
4182     I32 (*uf_val)(pTHX_ IV, SV*);
4183     I32 (*uf_set)(pTHX_ IV, SV*);
4184     IV uf_index;
4185 };
4186
4187 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4188  * XS code wanting to be backward compatible can do something
4189  * like the following:
4190
4191 #ifndef PERL_MG_UFUNC
4192 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4193 #endif
4194
4195 static PERL_MG_UFUNC(foo_get, index, val)
4196 {
4197     sv_setsv(val, ...);
4198     return TRUE;
4199 }
4200
4201 -- Doug MacEachern
4202
4203 */
4204
4205 #ifndef PERL_MG_UFUNC
4206 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4207 #endif
4208
4209 #include <math.h>
4210 #ifdef __VMS
4211      /* isfinite and others are here rather than in math.h as C99 stipulates */
4212 #    include <fp.h>
4213 #endif
4214
4215 #ifndef __cplusplus
4216 #  if !defined(WIN32) && !defined(VMS)
4217 #ifndef crypt
4218 char *crypt (const char*, const char*);
4219 #endif
4220 #  endif /* !WIN32 */
4221 #  ifndef WIN32
4222 #    ifndef getlogin
4223 char *getlogin (void);
4224 #    endif
4225 #  endif /* !WIN32 */
4226 #endif /* !__cplusplus */
4227
4228 /* Fixme on VMS.  This needs to be a run-time, not build time options */
4229 /* Also rename() is affected by this */
4230 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4231 #define UNLINK unlnk
4232 I32 unlnk (pTHX_ const char*);
4233 #else
4234 #define UNLINK PerlLIO_unlink
4235 #endif
4236
4237 /* some versions of glibc are missing the setresuid() proto */
4238 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4239 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4240 #endif
4241 /* some versions of glibc are missing the setresgid() proto */
4242 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4243 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4244 #endif
4245
4246 #ifndef HAS_SETREUID
4247 #  ifdef HAS_SETRESUID
4248 #    define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4249 #    define HAS_SETREUID
4250 #  endif
4251 #endif
4252 #ifndef HAS_SETREGID
4253 #  ifdef HAS_SETRESGID
4254 #    define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4255 #    define HAS_SETREGID
4256 #  endif
4257 #endif
4258
4259 /* Sighandler_t defined in iperlsys.h */
4260
4261 #ifdef HAS_SIGACTION
4262 typedef struct sigaction Sigsave_t;
4263 #else
4264 typedef Sighandler_t Sigsave_t;
4265 #endif
4266
4267 #define SCAN_DEF 0
4268 #define SCAN_TR 1
4269 #define SCAN_REPL 2
4270
4271 #ifdef DEBUGGING
4272 # ifndef register
4273 #  define register
4274 # endif
4275 # define RUNOPS_DEFAULT Perl_runops_debug
4276 #else
4277 # define RUNOPS_DEFAULT Perl_runops_standard
4278 #endif
4279
4280 #if defined(USE_PERLIO)
4281 EXTERN_C void PerlIO_teardown(void);
4282 # ifdef USE_ITHREADS
4283 #  define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4284 #  define PERLIO_TERM                           \
4285         STMT_START {                            \
4286                 PerlIO_teardown();              \
4287                 MUTEX_DESTROY(&PL_perlio_mutex);\
4288         } STMT_END
4289 # else
4290 #  define PERLIO_INIT
4291 #  define PERLIO_TERM   PerlIO_teardown()
4292 # endif
4293 #else
4294 #  define PERLIO_INIT
4295 #  define PERLIO_TERM
4296 #endif
4297
4298 #ifdef MYMALLOC
4299 #  ifdef MUTEX_INIT_CALLS_MALLOC
4300 #    define MALLOC_INIT                                 \
4301         STMT_START {                                    \
4302                 PL_malloc_mutex = NULL;                 \
4303                 MUTEX_INIT(&PL_malloc_mutex);           \
4304         } STMT_END
4305 #    define MALLOC_TERM                                 \
4306         STMT_START {                                    \
4307                 perl_mutex tmp = PL_malloc_mutex;       \
4308                 PL_malloc_mutex = NULL;                 \
4309                 MUTEX_DESTROY(&tmp);                    \
4310         } STMT_END
4311 #  else
4312 #    define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4313 #    define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4314 #  endif
4315 #else
4316 #  define MALLOC_INIT
4317 #  define MALLOC_TERM
4318 #endif
4319
4320 #if defined(PERL_IMPLICIT_CONTEXT)
4321
4322 struct perl_memory_debug_header;
4323 struct perl_memory_debug_header {
4324   tTHX  interpreter;
4325 #  if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4326   MEM_SIZE size;
4327 #  endif
4328   struct perl_memory_debug_header *prev;
4329   struct perl_memory_debug_header *next;
4330 #  ifdef PERL_DEBUG_READONLY_COW
4331   bool readonly;
4332 #  endif
4333 };
4334
4335 #elif defined(PERL_DEBUG_READONLY_COW)
4336
4337 struct perl_memory_debug_header;
4338 struct perl_memory_debug_header {
4339   MEM_SIZE size;
4340 };
4341
4342 #endif
4343
4344 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4345
4346 #  define PERL_MEMORY_DEBUG_HEADER_SIZE \
4347         (sizeof(struct perl_memory_debug_header) + \
4348         (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4349          %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4350
4351 #else
4352 #  define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4353 #endif
4354
4355 #ifdef PERL_TRACK_MEMPOOL
4356 # ifdef PERL_DEBUG_READONLY_COW
4357 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4358         STMT_START {                                            \
4359                 (header).interpreter = (interp);                \
4360                 (header).prev = (header).next = &(header);      \
4361                 (header).readonly = 0;                          \
4362         } STMT_END
4363 # else
4364 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4365         STMT_START {                                            \
4366                 (header).interpreter = (interp);                \
4367                 (header).prev = (header).next = &(header);      \
4368         } STMT_END
4369 # endif
4370 # else
4371 #  define INIT_TRACK_MEMPOOL(header, interp)
4372 #endif
4373
4374 #ifdef I_MALLOCMALLOC
4375 /* Needed for malloc_size(), malloc_good_size() on some systems */
4376 #  include <malloc/malloc.h>
4377 #endif
4378
4379 #ifdef MYMALLOC
4380 #  define Perl_safesysmalloc_size(where)        Perl_malloced_size(where)
4381 #else
4382 #  if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4383 #    ifdef PERL_TRACK_MEMPOOL
4384 #       define Perl_safesysmalloc_size(where)                   \
4385             (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4386 #    else
4387 #       define Perl_safesysmalloc_size(where) malloc_size(where)
4388 #    endif
4389 #  endif
4390 #  ifdef HAS_MALLOC_GOOD_SIZE
4391 #    ifdef PERL_TRACK_MEMPOOL
4392 #       define Perl_malloc_good_size(how_much)                  \
4393             (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4394 #    else
4395 #       define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4396 #    endif
4397 #  else
4398 /* Having this as the identity operation makes some code simpler.  */
4399 #       define Perl_malloc_good_size(how_much)  (how_much)
4400 #  endif
4401 #endif
4402
4403 typedef int (*runops_proc_t)(pTHX);
4404 typedef void (*share_proc_t) (pTHX_ SV *sv);
4405 typedef int  (*thrhook_proc_t) (pTHX);
4406 typedef OP* (*PPADDR_t[]) (pTHX);
4407 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4408 typedef void (*despatch_signals_proc_t) (pTHX);
4409
4410 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4411 #  include <crt_externs.h>      /* for the env array */
4412 #  define environ (*_NSGetEnviron())
4413 #elif defined(USE_ENVIRON_ARRAY) && !defined(environ)
4414    /* VMS and some other platforms don't use the environ array */
4415 EXTERN_C char **environ;  /* environment variables supplied via exec */
4416 #endif
4417
4418 #define PERL_PATCHLEVEL_H_IMPLICIT
4419 #include "patchlevel.h"
4420 #undef PERL_PATCHLEVEL_H_IMPLICIT
4421
4422 #define PERL_VERSION_STRING     STRINGIFY(PERL_REVISION) "." \
4423                                 STRINGIFY(PERL_VERSION) "." \
4424                                 STRINGIFY(PERL_SUBVERSION)
4425
4426 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4427                                 STRINGIFY(PERL_API_VERSION) "." \
4428                                 STRINGIFY(PERL_API_SUBVERSION)
4429
4430 START_EXTERN_C
4431
4432 /* handy constants */
4433 EXTCONST char PL_warn_uninit[]
4434   INIT("Use of uninitialized value%s%s%s");
4435 EXTCONST char PL_warn_uninit_sv[]
4436   INIT("Use of uninitialized value%" SVf "%s%s");
4437 EXTCONST char PL_warn_nosemi[]
4438   INIT("Semicolon seems to be missing");
4439 EXTCONST char PL_warn_reserved[]
4440   INIT("Unquoted string \"%s\" may clash with future reserved word");
4441 EXTCONST char PL_warn_nl[]
4442   INIT("Unsuccessful %s on filename containing newline");
4443 EXTCONST char PL_no_wrongref[]
4444   INIT("Can't use %s ref as %s ref");
4445 /* The core no longer needs this here. If you require the string constant,
4446    please inline a copy into your own code.  */
4447 EXTCONST char PL_no_symref[] __attribute__deprecated__
4448   INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4449 EXTCONST char PL_no_symref_sv[]
4450   INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4451
4452 EXTCONST char PL_no_usym[]
4453   INIT("Can't use an undefined value as %s reference");
4454 EXTCONST char PL_no_aelem[]
4455   INIT("Modification of non-creatable array value attempted, subscript %d");
4456 EXTCONST char PL_no_helem_sv[]
4457   INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4458 EXTCONST char PL_no_modify[]
4459   INIT("Modification of a read-only value attempted");
4460 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4461   INIT("Out of memory!\n");
4462 EXTCONST char PL_no_security[]
4463   INIT("Insecure dependency in %s%s");
4464 EXTCONST char PL_no_sock_func[]
4465   INIT("Unsupported socket function \"%s\" called");
4466 EXTCONST char PL_no_dir_func[]
4467   INIT("Unsupported directory function \"%s\" called");
4468 EXTCONST char PL_no_func[]
4469   INIT("The %s function is unimplemented");
4470 EXTCONST char PL_no_myglob[]
4471   INIT("\"%s\" %se %s can't be in a package");
4472 EXTCONST char PL_no_localize_ref[]
4473   INIT("Can't localize through a reference");
4474 EXTCONST char PL_memory_wrap[]
4475   INIT("panic: memory wrap");
4476
4477 EXTCONST char PL_Yes[]
4478   INIT("1");
4479 EXTCONST char PL_No[]
4480   INIT("");
4481 EXTCONST char PL_Zero[]
4482   INIT("0");
4483 EXTCONST char PL_hexdigit[]
4484   INIT("0123456789abcdef0123456789ABCDEF");
4485
4486 EXTCONST STRLEN PL_WARN_ALL
4487   INIT(0);
4488 EXTCONST STRLEN PL_WARN_NONE
4489   INIT(0);
4490
4491 /* This is constant on most architectures, a global on OS/2 */
4492 #ifndef OS2
4493 EXTCONST char PL_sh_path[]
4494   INIT(SH_PATH); /* full path of shell */
4495 #endif
4496
4497 #ifdef CSH
4498 EXTCONST char PL_cshname[]
4499   INIT(CSH);
4500 #  define PL_cshlen     (sizeof(CSH "") - 1)
4501 #endif
4502
4503 /* These are baked at compile time into any shared perl library.
4504    In future releases this will allow us in main() to sanity test the
4505    library we're linking against.  */
4506
4507 EXTCONST U8 PL_revision
4508   INIT(PERL_REVISION);
4509 EXTCONST U8 PL_version
4510   INIT(PERL_VERSION);
4511 EXTCONST U8 PL_subversion
4512   INIT(PERL_SUBVERSION);
4513
4514 EXTCONST char PL_uuemap[65]
4515   INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4516
4517 /* a special string address whose value is "isa", but which perl knows
4518  * to treat as if it were really "DOES" when printing the method name in
4519  *  the "Can't call method '%s'" error message */
4520 EXTCONST char PL_isa_DOES[]
4521   INIT("isa");
4522
4523 #ifdef DOINIT
4524 EXTCONST char PL_uudmap[256] =
4525 #  ifdef PERL_MICRO
4526 #    include "uuudmap.h"
4527 #  else
4528 #    include "uudmap.h"
4529 #  endif
4530 ;
4531 EXTCONST char PL_bitcount[256] =
4532 #  ifdef PERL_MICRO
4533 #    include "ubitcount.h"
4534 #else
4535 #    include "bitcount.h"
4536 #  endif
4537 ;
4538 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4539 EXTCONST int         PL_sig_num[]  = { SIG_NUM };
4540 #else
4541 EXTCONST char PL_uudmap[256];
4542 EXTCONST char PL_bitcount[256];
4543 EXTCONST char* const PL_sig_name[];
4544 EXTCONST int         PL_sig_num[];
4545 #endif
4546
4547 /* fast conversion and case folding tables.  The folding tables complement the
4548  * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4549  * folds such as outside the range or to multiple characters. */
4550
4551 #ifdef DOINIT
4552 #ifndef EBCDIC
4553
4554 /* The EBCDIC fold table depends on the code page, and hence is found in
4555  * utfebcdic.h */
4556
4557 EXTCONST  unsigned char PL_fold[] = {
4558         0,      1,      2,      3,      4,      5,      6,      7,
4559         8,      9,      10,     11,     12,     13,     14,     15,
4560         16,     17,     18,     19,     20,     21,     22,     23,
4561         24,     25,     26,     27,     28,     29,     30,     31,
4562         32,     33,     34,     35,     36,     37,     38,     39,
4563         40,     41,     42,     43,     44,     45,     46,     47,
4564         48,     49,     50,     51,     52,     53,     54,     55,
4565         56,     57,     58,     59,     60,     61,     62,     63,
4566         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4567         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4568         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4569         'x',    'y',    'z',    91,     92,     93,     94,     95,
4570         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4571         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4572         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4573         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4574         128,    129,    130,    131,    132,    133,    134,    135,
4575         136,    137,    138,    139,    140,    141,    142,    143,
4576         144,    145,    146,    147,    148,    149,    150,    151,
4577         152,    153,    154,    155,    156,    157,    158,    159,
4578         160,    161,    162,    163,    164,    165,    166,    167,
4579         168,    169,    170,    171,    172,    173,    174,    175,
4580         176,    177,    178,    179,    180,    181,    182,    183,
4581         184,    185,    186,    187,    188,    189,    190,    191,
4582         192,    193,    194,    195,    196,    197,    198,    199,
4583         200,    201,    202,    203,    204,    205,    206,    207,
4584         208,    209,    210,    211,    212,    213,    214,    215,
4585         216,    217,    218,    219,    220,    221,    222,    223,    
4586         224,    225,    226,    227,    228,    229,    230,    231,
4587         232,    233,    234,    235,    236,    237,    238,    239,
4588         240,    241,    242,    243,    244,    245,    246,    247,
4589         248,    249,    250,    251,    252,    253,    254,    255
4590 };
4591 EXTCONST  unsigned char PL_fold_latin1[] = {
4592     /* Full latin1 complement folding, except for three problematic code points:
4593      *  Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4594      *  fold complements outside the Latin1 range, so can't match something
4595      *  that isn't in utf8.
4596      *  German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4597      *  not one, so can't be represented in this table.
4598      *
4599      * All have to be specially handled */
4600         0,      1,      2,      3,      4,      5,      6,      7,
4601         8,      9,      10,     11,     12,     13,     14,     15,
4602         16,     17,     18,     19,     20,     21,     22,     23,
4603         24,     25,     26,     27,     28,     29,     30,     31,
4604         32,     33,     34,     35,     36,     37,     38,     39,
4605         40,     41,     42,     43,     44,     45,     46,     47,
4606         48,     49,     50,     51,     52,     53,     54,     55,
4607         56,     57,     58,     59,     60,     61,     62,     63,
4608         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4609         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4610         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4611         'x',    'y',    'z',    91,     92,     93,     94,     95,
4612         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4613         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4614         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4615         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4616         128,    129,    130,    131,    132,    133,    134,    135,
4617         136,    137,    138,    139,    140,    141,    142,    143,
4618         144,    145,    146,    147,    148,    149,    150,    151,
4619         152,    153,    154,    155,    156,    157,    158,    159,
4620         160,    161,    162,    163,    164,    165,    166,    167,
4621         168,    169,    170,    171,    172,    173,    174,    175,
4622         176,    177,    178,    179,    180,    181 /*micro */, 182,    183,
4623         184,    185,    186,    187,    188,    189,    190,    191,
4624         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4625         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4626         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4627         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
4628         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4629         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4630         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4631         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
4632         255 /* y with diaeresis */
4633 };
4634
4635 /* If these tables are accessed through ebcdic, the access will be converted to
4636  * latin1 first */
4637 EXTCONST  unsigned char PL_latin1_lc[] = {  /* lowercasing */
4638         0,      1,      2,      3,      4,      5,      6,      7,
4639         8,      9,      10,     11,     12,     13,     14,     15,
4640         16,     17,     18,     19,     20,     21,     22,     23,
4641         24,     25,     26,     27,     28,     29,     30,     31,
4642         32,     33,     34,     35,     36,     37,     38,     39,
4643         40,     41,     42,     43,     44,     45,     46,     47,
4644         48,     49,     50,     51,     52,     53,     54,     55,
4645         56,     57,     58,     59,     60,     61,     62,     63,
4646         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4647         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4648         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4649         'x',    'y',    'z',    91,     92,     93,     94,     95,
4650         96,     97,     98,     99,     100,    101,    102,    103,
4651         104,    105,    106,    107,    108,    109,    110,    111,
4652         112,    113,    114,    115,    116,    117,    118,    119,
4653         120,    121,    122,    123,    124,    125,    126,    127,
4654         128,    129,    130,    131,    132,    133,    134,    135,
4655         136,    137,    138,    139,    140,    141,    142,    143,
4656         144,    145,    146,    147,    148,    149,    150,    151,
4657         152,    153,    154,    155,    156,    157,    158,    159,
4658         160,    161,    162,    163,    164,    165,    166,    167,
4659         168,    169,    170,    171,    172,    173,    174,    175,
4660         176,    177,    178,    179,    180,    181,    182,    183,
4661         184,    185,    186,    187,    188,    189,    190,    191,
4662         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4663         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4664         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4665         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223,    
4666         224,    225,    226,    227,    228,    229,    230,    231,
4667         232,    233,    234,    235,    236,    237,    238,    239,
4668         240,    241,    242,    243,    244,    245,    246,    247,
4669         248,    249,    250,    251,    252,    253,    254,    255
4670 };
4671
4672 /* upper and title case of latin1 characters, modified so that the three tricky
4673  * ones are mapped to 255 (which is one of the three) */
4674 EXTCONST  unsigned char PL_mod_latin1_uc[] = {
4675         0,      1,      2,      3,      4,      5,      6,      7,
4676         8,      9,      10,     11,     12,     13,     14,     15,
4677         16,     17,     18,     19,     20,     21,     22,     23,
4678         24,     25,     26,     27,     28,     29,     30,     31,
4679         32,     33,     34,     35,     36,     37,     38,     39,
4680         40,     41,     42,     43,     44,     45,     46,     47,
4681         48,     49,     50,     51,     52,     53,     54,     55,
4682         56,     57,     58,     59,     60,     61,     62,     63,
4683         64,     65,     66,     67,     68,     69,     70,     71,
4684         72,     73,     74,     75,     76,     77,     78,     79,
4685         80,     81,     82,     83,     84,     85,     86,     87,
4686         88,     89,     90,     91,     92,     93,     94,     95,
4687         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4688         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4689         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4690         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4691         128,    129,    130,    131,    132,    133,    134,    135,
4692         136,    137,    138,    139,    140,    141,    142,    143,
4693         144,    145,    146,    147,    148,    149,    150,    151,
4694         152,    153,    154,    155,    156,    157,    158,    159,
4695         160,    161,    162,    163,    164,    165,    166,    167,
4696         168,    169,    170,    171,    172,    173,    174,    175,
4697         176,    177,    178,    179,    180,    255 /*micro*/,  182,    183,
4698         184,    185,    186,    187,    188,    189,    190,    191,
4699         192,    193,    194,    195,    196,    197,    198,    199,
4700         200,    201,    202,    203,    204,    205,    206,    207,
4701         208,    209,    210,    211,    212,    213,    214,    215,
4702         216,    217,    218,    219,    220,    221,    222,
4703 #if    UNICODE_MAJOR_VERSION > 2                                        \
4704    || (UNICODE_MAJOR_VERSION == 2 && UNICODE_DOT_VERSION >= 1           \
4705                                   && UNICODE_DOT_DOT_VERSION >= 8)
4706                                                                 255 /*sharp s*/,
4707 #else   /* uc(sharp s) is 'sharp s' itself in early unicode */
4708                                                                 223,
4709 #endif
4710         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4711         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4712         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4713         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32, 255
4714 };
4715 #endif  /* !EBCDIC, but still in DOINIT */
4716 #else   /* ! DOINIT */
4717 #   ifndef EBCDIC
4718 EXTCONST unsigned char PL_fold[];
4719 EXTCONST unsigned char PL_fold_latin1[];
4720 EXTCONST unsigned char PL_mod_latin1_uc[];
4721 EXTCONST unsigned char PL_latin1_lc[];
4722 #   endif
4723 #endif
4724
4725 #ifndef PERL_GLOBAL_STRUCT /* or perlvars.h */
4726 #ifdef DOINIT
4727 EXT unsigned char PL_fold_locale[256] = { /* Unfortunately not EXTCONST. */
4728         0,      1,      2,      3,      4,      5,      6,      7,
4729         8,      9,      10,     11,     12,     13,     14,     15,
4730         16,     17,     18,     19,     20,     21,     22,     23,
4731         24,     25,     26,     27,     28,     29,     30,     31,
4732         32,     33,     34,     35,     36,     37,     38,     39,
4733         40,     41,     42,     43,     44,     45,     46,     47,
4734         48,     49,     50,     51,     52,     53,     54,     55,
4735         56,     57,     58,     59,     60,     61,     62,     63,
4736         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4737         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4738         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4739         'x',    'y',    'z',    91,     92,     93,     94,     95,
4740         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4741         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4742         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4743         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4744         128,    129,    130,    131,    132,    133,    134,    135,
4745         136,    137,    138,    139,    140,    141,    142,    143,
4746         144,    145,    146,    147,    148,    149,    150,    151,
4747         152,    153,    154,    155,    156,    157,    158,    159,
4748         160,    161,    162,    163,    164,    165,    166,    167,
4749         168,    169,    170,    171,    172,    173,    174,    175,
4750         176,    177,    178,    179,    180,    181,    182,    183,
4751         184,    185,    186,    187,    188,    189,    190,    191,
4752         192,    193,    194,    195,    196,    197,    198,    199,
4753         200,    201,    202,    203,    204,    205,    206,    207,
4754         208,    209,    210,    211,    212,    213,    214,    215,
4755         216,    217,    218,    219,    220,    221,    222,    223,    
4756         224,    225,    226,    227,    228,    229,    230,    231,
4757         232,    233,    234,    235,    236,    237,    238,    239,
4758         240,    241,    242,    243,    244,    245,    246,    247,
4759         248,    249,    250,    251,    252,    253,    254,    255
4760 };
4761 #else
4762 EXT unsigned char PL_fold_locale[256]; /* Unfortunately not EXTCONST. */
4763 #endif
4764 #endif /* !PERL_GLOBAL_STRUCT */
4765
4766 #ifdef DOINIT
4767 #ifdef EBCDIC
4768 EXTCONST unsigned char PL_freq[] = {/* EBCDIC frequencies for mixed English/C */
4769     1,      2,      84,     151,    154,    155,    156,    157,
4770     165,    246,    250,    3,      158,    7,      18,     29,
4771     40,     51,     62,     73,     85,     96,     107,    118,
4772     129,    140,    147,    148,    149,    150,    152,    153,
4773     255,      6,      8,      9,     10,     11,     12,     13,
4774      14,     15,     24,     25,     26,     27,     28,    226,
4775      29,     30,     31,     32,     33,     43,     44,     45,
4776      46,     47,     48,     49,     50,     76,     77,     78,
4777      79,     80,     81,     82,     83,     84,     85,     86,
4778      87,     94,     95,    234,    181,    233,    187,    190,
4779     180,     96,     97,     98,     99,    100,    101,    102,
4780     104,    112,    182,    174,    236,    232,    229,    103,
4781     228,    226,    114,    115,    116,    117,    118,    119,
4782     120,    121,    122,    235,    176,    230,    194,    162,
4783     130,    131,    132,    133,    134,    135,    136,    137,
4784     138,    139,    201,    205,    163,    217,    220,    224,
4785     5,      248,    227,    244,    242,    255,    241,    231,
4786     240,    253,    16,     197,    19,     20,     21,     187,
4787     23,     169,    210,    245,    237,    249,    247,    239,
4788     168,    252,    34,     196,    36,     37,     38,     39,
4789     41,     42,     251,    254,    238,    223,    221,    213,
4790     225,    177,    52,     53,     54,     55,     56,     57,
4791     58,     59,     60,     61,     63,     64,     65,     66,
4792     67,     68,     69,     70,     71,     72,     74,     75,
4793     205,    208,    186,    202,    200,    218,    198,    179,
4794     178,    214,    88,     89,     90,     91,     92,     93,
4795     217,    166,    170,    207,    199,    209,    206,    204,
4796     160,    212,    105,    106,    108,    109,    110,    111,
4797     203,    113,    216,    215,    192,    175,    193,    243,
4798     172,    161,    123,    124,    125,    126,    127,    128,
4799     222,    219,    211,    195,    188,    193,    185,    184,
4800     191,    183,    141,    142,    143,    144,    145,    146
4801 };
4802 #else  /* ascii rather than ebcdic */
4803 EXTCONST unsigned char PL_freq[] = {    /* letter frequencies for mixed English/C */
4804         1,      2,      84,     151,    154,    155,    156,    157,
4805         165,    246,    250,    3,      158,    7,      18,     29,
4806         40,     51,     62,     73,     85,     96,     107,    118,
4807         129,    140,    147,    148,    149,    150,    152,    153,
4808         255,    182,    224,    205,    174,    176,    180,    217,
4809         233,    232,    236,    187,    235,    228,    234,    226,
4810         222,    219,    211,    195,    188,    193,    185,    184,
4811         191,    183,    201,    229,    181,    220,    194,    162,
4812         163,    208,    186,    202,    200,    218,    198,    179,
4813         178,    214,    166,    170,    207,   &nb