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