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