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