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