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