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