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