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