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