This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document NUM2PTR
[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 /*
1380 =for apidoc Am|void|memzero|void * d|Size_t l
1381 Set the C<l> bytes starting at C<*d> to all zeroes.
1382
1383 =cut
1384 */
1385 #ifndef memzero
1386 #   define memzero(d,l) memset(d,0,l)
1387 #endif
1388
1389 #ifdef I_NETINET_IN
1390 #   include <netinet/in.h>
1391 #endif
1392
1393 #ifdef I_ARPA_INET
1394 #   include <arpa/inet.h>
1395 #endif
1396
1397 #ifdef I_SYS_STAT
1398 #   include <sys/stat.h>
1399 #endif
1400
1401 /* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1402    This definition should ideally go into win32/win32.h, but S_IFIFO is
1403    used later here in perl.h before win32/win32.h is being included. */
1404 #if !defined(S_IFIFO) && defined(_S_IFIFO)
1405 #   define S_IFIFO _S_IFIFO
1406 #endif
1407
1408 /* The stat macros for Unisoft System V/88 (and derivatives
1409    like UTekV) are broken, sometimes giving false positives.  Undefine
1410    them here and let the code below set them to proper values.
1411
1412    The ghs macro stands for GreenHills Software C-1.8.5 which
1413    is the C compiler for sysV88 and the various derivatives.
1414    This header file bug is corrected in gcc-2.5.8 and later versions.
1415    --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94.  */
1416
1417 #if defined(m88k) && defined(ghs)
1418 #   undef S_ISDIR
1419 #   undef S_ISCHR
1420 #   undef S_ISBLK
1421 #   undef S_ISREG
1422 #   undef S_ISFIFO
1423 #   undef S_ISLNK
1424 #endif
1425
1426 #include <time.h>
1427
1428 #ifdef I_SYS_TIME
1429 #   ifdef I_SYS_TIME_KERNEL
1430 #       define KERNEL
1431 #   endif
1432 #   include <sys/time.h>
1433 #   ifdef I_SYS_TIME_KERNEL
1434 #       undef KERNEL
1435 #   endif
1436 #endif
1437
1438 #if defined(HAS_TIMES) && defined(I_SYS_TIMES)
1439 #    include <sys/times.h>
1440 #endif
1441
1442 #include <errno.h>
1443
1444 #if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
1445 #  define WIN32SCK_IS_STDSCK            /* don't pull in custom wsock layer */
1446 #endif
1447
1448 #if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1449 # include <sys/socket.h>
1450 # if defined(USE_SOCKS) && defined(I_SOCKS)
1451 #   if !defined(INCLUDE_PROTOTYPES)
1452 #       define INCLUDE_PROTOTYPES /* for <socks.h> */
1453 #       define PERL_SOCKS_NEED_PROTOTYPES
1454 #   endif
1455 #   include <socks.h>
1456 #   ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1457 #       undef INCLUDE_PROTOTYPES
1458 #       undef PERL_SOCKS_NEED_PROTOTYPES
1459 #   endif
1460 # endif
1461 # ifdef I_NETDB
1462 #  ifdef NETWARE
1463 #   include<stdio.h>
1464 #  endif
1465 #  include <netdb.h>
1466 # endif
1467 # ifndef ENOTSOCK
1468 #  ifdef I_NET_ERRNO
1469 #   include <net/errno.h>
1470 #  endif
1471 # endif
1472 #endif
1473
1474 /* sockatmark() is so new (2001) that many places might have it hidden
1475  * behind some -D_BLAH_BLAH_SOURCE guard.  The __THROW magic is required
1476  * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
1477 #if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
1478 # if defined(__THROW) && defined(__GLIBC__)
1479 int sockatmark(int) __THROW;
1480 # else
1481 int sockatmark(int);
1482 # endif
1483 #endif
1484
1485 #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. */
1486 EXTERN_C int fchdir(int);
1487 EXTERN_C int flock(int, int);
1488 EXTERN_C int fseeko(FILE *, off_t, int);
1489 EXTERN_C off_t ftello(FILE *);
1490 #endif
1491
1492 #if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1493 EXTERN_C char *crypt(const char *, const char *);
1494 #endif
1495
1496 #if defined(__cplusplus) && defined(__CYGWIN__)
1497 EXTERN_C char *crypt(const char *, const char *);
1498 #endif
1499
1500 /*
1501 =for apidoc_section $errno
1502
1503 =for apidoc m|void|SETERRNO|int errcode|int vmserrcode
1504
1505 Set C<errno>, and on VMS set C<vaxc$errno>.
1506
1507 =for apidoc mn|void|dSAVEDERRNO
1508
1509 Declare variables needed to save C<errno> and any operating system
1510 specific error number.
1511
1512 =for apidoc mn|void|dSAVE_ERRNO
1513
1514 Declare variables needed to save C<errno> and any operating system
1515 specific error number, and save them for optional later restoration
1516 by C<RESTORE_ERRNO>.
1517
1518 =for apidoc mn|void|SAVE_ERRNO
1519
1520 Save C<errno> and any operating system specific error number for
1521 optional later restoration by C<RESTORE_ERRNO>.  Requires
1522 C<dSAVEDERRNO> or C<dSAVE_ERRNO> in scope.
1523
1524 =for apidoc mn|void|RESTORE_ERRNO
1525
1526 Restore C<errno> and any operating system specific error number that
1527 was saved by C<dSAVE_ERRNO> or C<RESTORE_ERRNO>.
1528
1529 =cut
1530 */
1531
1532 #ifdef SETERRNO
1533 # undef SETERRNO  /* SOCKS might have defined this */
1534 #endif
1535
1536 #ifdef VMS
1537 #   define SETERRNO(errcode,vmserrcode) \
1538         STMT_START {                    \
1539             set_errno(errcode);         \
1540             set_vaxc_errno(vmserrcode); \
1541         } STMT_END
1542 #   define dSAVEDERRNO    int saved_errno; unsigned saved_vms_errno
1543 #   define dSAVE_ERRNO    int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1544 #   define SAVE_ERRNO     ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1545 #   define RESTORE_ERRNO  SETERRNO(saved_errno, saved_vms_errno)
1546
1547 #   define LIB_INVARG           LIB$_INVARG
1548 #   define RMS_DIR              RMS$_DIR
1549 #   define RMS_FAC              RMS$_FAC
1550 #   define RMS_FEX              RMS$_FEX
1551 #   define RMS_FNF              RMS$_FNF
1552 #   define RMS_IFI              RMS$_IFI
1553 #   define RMS_ISI              RMS$_ISI
1554 #   define RMS_PRV              RMS$_PRV
1555 #   define SS_ACCVIO            SS$_ACCVIO
1556 #   define SS_DEVOFFLINE        SS$_DEVOFFLINE
1557 #   define SS_IVCHAN            SS$_IVCHAN
1558 #   define SS_NORMAL            SS$_NORMAL
1559 #   define SS_NOPRIV            SS$_NOPRIV
1560 #   define SS_BUFFEROVF         SS$_BUFFEROVF
1561 #else
1562 #   define LIB_INVARG           0
1563 #   define RMS_DIR              0
1564 #   define RMS_FAC              0
1565 #   define RMS_FEX              0
1566 #   define RMS_FNF              0
1567 #   define RMS_IFI              0
1568 #   define RMS_ISI              0
1569 #   define RMS_PRV              0
1570 #   define SS_ACCVIO            0
1571 #   define SS_DEVOFFLINE        0
1572 #   define SS_IVCHAN            0
1573 #   define SS_NORMAL            0
1574 #   define SS_NOPRIV            0
1575 #   define SS_BUFFEROVF         0
1576 #endif
1577
1578 #ifdef WIN32
1579 #   define dSAVEDERRNO  int saved_errno; DWORD saved_win32_errno
1580 #   define dSAVE_ERRNO  int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1581 #   define SAVE_ERRNO   ( saved_errno = errno, saved_win32_errno = GetLastError() )
1582 #   define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1583 #endif
1584
1585 #ifdef OS2
1586 #   define dSAVEDERRNO  int saved_errno; unsigned long saved_os2_errno
1587 #   define dSAVE_ERRNO  int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1588 #   define SAVE_ERRNO   ( saved_errno = errno, saved_os2_errno = Perl_rc )
1589 #   define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1590 #endif
1591
1592 #ifndef SETERRNO
1593 #   define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1594 #endif
1595
1596 #ifndef dSAVEDERRNO
1597 #   define dSAVEDERRNO    int saved_errno
1598 #   define dSAVE_ERRNO    int saved_errno = errno
1599 #   define SAVE_ERRNO     (saved_errno = errno)
1600 #   define RESTORE_ERRNO  (errno = saved_errno)
1601 #endif
1602
1603 /*
1604 =for apidoc_section $warning
1605
1606 =for apidoc Amn|SV *|ERRSV
1607
1608 Returns the SV for C<$@>, creating it if needed.
1609
1610 =for apidoc Am|void|CLEAR_ERRSV
1611
1612 Clear the contents of C<$@>, setting it to the empty string.
1613
1614 This replaces any read-only SV with a fresh SV and removes any magic.
1615
1616 =for apidoc Am|void|SANE_ERRSV
1617
1618 Clean up ERRSV so we can safely set it.
1619
1620 This replaces any read-only SV with a fresh writable copy and removes
1621 any magic.
1622
1623 =cut
1624 */
1625
1626 #define ERRSV GvSVn(PL_errgv)
1627
1628 /* contains inlined gv_add_by_type */
1629 #define CLEAR_ERRSV() STMT_START {                                      \
1630     SV ** const svp = &GvSV(PL_errgv);                                  \
1631     if (!*svp) {                                                        \
1632         *svp = newSVpvs("");                                            \
1633     } else if (SvREADONLY(*svp)) {                                      \
1634         SvREFCNT_dec_NN(*svp);                                          \
1635         *svp = newSVpvs("");                                            \
1636     } else {                                                            \
1637         SV *const errsv = *svp;                                         \
1638         SvPVCLEAR(errsv);                                               \
1639         SvPOK_only(errsv);                                              \
1640         if (SvMAGICAL(errsv)) {                                         \
1641             mg_free(errsv);                                             \
1642         }                                                               \
1643     }                                                                   \
1644     } STMT_END
1645
1646 /* contains inlined gv_add_by_type */
1647 #define SANE_ERRSV() STMT_START {                                       \
1648     SV ** const svp = &GvSV(PL_errgv);                                  \
1649     if (!*svp) {                                                        \
1650         *svp = newSVpvs("");                                            \
1651     } else if (SvREADONLY(*svp)) {                                      \
1652         SV *dupsv = newSVsv(*svp);                                      \
1653         SvREFCNT_dec_NN(*svp);                                          \
1654         *svp = dupsv;                                                   \
1655     } else {                                                            \
1656         SV *const errsv = *svp;                                         \
1657         if (SvMAGICAL(errsv)) {                                         \
1658             mg_free(errsv);                                             \
1659         }                                                               \
1660     }                                                                   \
1661     } STMT_END
1662
1663
1664 #ifdef PERL_CORE
1665 # define DEFSV (0 + GvSVn(PL_defgv))
1666 # define DEFSV_set(sv) \
1667     (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1668 # define SAVE_DEFSV                \
1669     (                               \
1670         save_gp(PL_defgv, 0),        \
1671         GvINTRO_off(PL_defgv),        \
1672         SAVEGENERICSV(GvSV(PL_defgv)), \
1673         GvSV(PL_defgv) = NULL           \
1674     )
1675 #else
1676 # define DEFSV GvSVn(PL_defgv)
1677 # define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1678 # define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
1679 #endif
1680
1681 /*
1682 =for apidoc_section $SV
1683 =for apidoc Amn|SV *|DEFSV
1684 Returns the SV associated with C<$_>
1685
1686 =for apidoc Am|void|DEFSV_set|SV * sv
1687 Associate C<sv> with C<$_>
1688
1689 =for apidoc Amn|void|SAVE_DEFSV
1690 Localize C<$_>.  See L<perlguts/Localizing changes>.
1691
1692 =cut
1693 */
1694
1695 #ifndef errno
1696         extern int errno;     /* ANSI allows errno to be an lvalue expr.
1697                                * For example in multithreaded environments
1698                                * something like this might happen:
1699                                * extern int *_errno(void);
1700                                * #define errno (*_errno()) */
1701 #endif
1702
1703 #define UNKNOWN_ERRNO_MSG "(unknown)"
1704
1705 #ifdef VMS
1706 #define Strerror(e) strerror((e), vaxc$errno)
1707 #else
1708 #define Strerror(e) strerror(e)
1709 #endif
1710
1711 #ifdef I_SYS_IOCTL
1712 #   ifndef _IOCTL_
1713 #       include <sys/ioctl.h>
1714 #   endif
1715 #endif
1716
1717 #if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
1718 #   ifdef HAS_SOCKETPAIR
1719 #       undef HAS_SOCKETPAIR
1720 #   endif
1721 #   ifdef I_NDBM
1722 #       undef I_NDBM
1723 #   endif
1724 #endif
1725
1726 #ifndef HAS_SOCKETPAIR
1727 #   ifdef HAS_SOCKET
1728 #       define socketpair Perl_my_socketpair
1729 #   endif
1730 #endif
1731
1732 #if INTSIZE == 2
1733 #   define htoni htons
1734 #   define ntohi ntohs
1735 #else
1736 #   define htoni htonl
1737 #   define ntohi ntohl
1738 #endif
1739
1740 /* Configure already sets Direntry_t */
1741 #if defined(I_DIRENT)
1742 #  include <dirent.h>
1743 #elif defined(I_SYS_NDIR)
1744 #  include <sys/ndir.h>
1745 #elif defined(I_SYS_DIR)
1746 #  include <sys/dir.h>
1747 #endif
1748
1749 /*
1750  * The following gobbledygook brought to you on behalf of __STDC__.
1751  * (I could just use #ifndef __STDC__, but this is more bulletproof
1752  * in the face of half-implementations.)
1753  */
1754
1755 #if defined(I_SYSMODE)
1756 #include <sys/mode.h>
1757 #endif
1758
1759 #ifndef S_IFMT
1760 #   ifdef _S_IFMT
1761 #       define S_IFMT _S_IFMT
1762 #   else
1763 #       define S_IFMT 0170000
1764 #   endif
1765 #endif
1766
1767 #ifndef S_ISDIR
1768 #   define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1769 #endif
1770
1771 #ifndef S_ISCHR
1772 #   define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1773 #endif
1774
1775 #ifndef S_ISBLK
1776 #   ifdef S_IFBLK
1777 #       define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1778 #   else
1779 #       define S_ISBLK(m) (0)
1780 #   endif
1781 #endif
1782
1783 #ifndef S_ISREG
1784 #   define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1785 #endif
1786
1787 #ifndef S_ISFIFO
1788 #   ifdef S_IFIFO
1789 #       define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1790 #   else
1791 #       define S_ISFIFO(m) (0)
1792 #   endif
1793 #endif
1794
1795 #ifndef S_ISLNK
1796 #  ifdef _S_ISLNK
1797 #    define S_ISLNK(m) _S_ISLNK(m)
1798 #  elif defined(_S_IFLNK)
1799 #    define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1800 #  elif defined(S_IFLNK)
1801 #    define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1802 #  else
1803 #    define S_ISLNK(m) (0)
1804 #  endif
1805 #endif
1806
1807 #ifndef S_ISSOCK
1808 #  ifdef _S_ISSOCK
1809 #    define S_ISSOCK(m) _S_ISSOCK(m)
1810 #  elif defined(_S_IFSOCK)
1811 #    define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1812 #  elif defined(S_IFSOCK)
1813 #    define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1814 #  else
1815 #    define S_ISSOCK(m) (0)
1816 #  endif
1817 #endif
1818
1819 #ifndef S_IRUSR
1820 #   ifdef S_IREAD
1821 #       define S_IRUSR S_IREAD
1822 #       define S_IWUSR S_IWRITE
1823 #       define S_IXUSR S_IEXEC
1824 #   else
1825 #       define S_IRUSR 0400
1826 #       define S_IWUSR 0200
1827 #       define S_IXUSR 0100
1828 #   endif
1829 #endif
1830
1831 #ifndef S_IRGRP
1832 #   ifdef S_IRUSR
1833 #       define S_IRGRP (S_IRUSR>>3)
1834 #       define S_IWGRP (S_IWUSR>>3)
1835 #       define S_IXGRP (S_IXUSR>>3)
1836 #   else
1837 #       define S_IRGRP 0040
1838 #       define S_IWGRP 0020
1839 #       define S_IXGRP 0010
1840 #   endif
1841 #endif
1842
1843 #ifndef S_IROTH
1844 #   ifdef S_IRUSR
1845 #       define S_IROTH (S_IRUSR>>6)
1846 #       define S_IWOTH (S_IWUSR>>6)
1847 #       define S_IXOTH (S_IXUSR>>6)
1848 #   else
1849 #       define S_IROTH 0040
1850 #       define S_IWOTH 0020
1851 #       define S_IXOTH 0010
1852 #   endif
1853 #endif
1854
1855 #ifndef S_ISUID
1856 #   define S_ISUID 04000
1857 #endif
1858
1859 #ifndef S_ISGID
1860 #   define S_ISGID 02000
1861 #endif
1862
1863 #ifndef S_IRWXU
1864 #   define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
1865 #endif
1866
1867 #ifndef S_IRWXG
1868 #   define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
1869 #endif
1870
1871 #ifndef S_IRWXO
1872 #   define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
1873 #endif
1874
1875 /* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
1876  * which would get included through <sys/file.h >, but that is 3000
1877  * lines in the future.  --jhi */
1878
1879 #if !defined(S_IREAD) && !defined(__HAIKU__)
1880 #   define S_IREAD S_IRUSR
1881 #endif
1882
1883 #if !defined(S_IWRITE) && !defined(__HAIKU__)
1884 #   define S_IWRITE S_IWUSR
1885 #endif
1886
1887 #ifndef S_IEXEC
1888 #   define S_IEXEC S_IXUSR
1889 #endif
1890
1891 #if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
1892 #   define SLOPPYDIVIDE
1893 #endif
1894
1895 #ifdef UV
1896 #undef UV
1897 #endif
1898
1899 /* This used to be conditionally defined based on whether we had a sprintf()
1900  * that correctly returns the string length (as required by C89), but we no
1901  * longer need that. XS modules can (and do) use this name, so it must remain
1902  * a part of the API that's visible to modules.
1903
1904 =for apidoc_section $string
1905 =for apidoc ATmD|int|my_sprintf|NN char *buffer|NN const char *pat|...
1906
1907 Do NOT use this due to the possibility of overflowing C<buffer>.  Instead use
1908 my_snprintf()
1909
1910 =cut
1911 */
1912 #define my_sprintf sprintf
1913
1914 /*
1915  * If we have v?snprintf() and the C99 variadic macros, we can just
1916  * use just the v?snprintf().  It is nice to try to trap the buffer
1917  * overflow, however, so if we are DEBUGGING, and we cannot use the
1918  * gcc statement expressions, then use the function wrappers which try
1919  * to trap the overflow.  If we can use the gcc statement expressions,
1920  * we can try that even with the version that uses the C99 variadic
1921  * macros.
1922  */
1923
1924 /* Note that we do not check against snprintf()/vsnprintf() returning
1925  * negative values because that is non-standard behaviour and we use
1926  * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1927  * that should be true only if the snprintf()/vsnprintf() are true
1928  * to the standard. */
1929
1930 #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
1931
1932 #ifdef USE_QUADMATH
1933 #  define my_snprintf Perl_my_snprintf
1934 #  define PERL_MY_SNPRINTF_GUARDED
1935 #elif defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1936 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1937 #      define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1938 #      define PERL_MY_SNPRINTF_GUARDED
1939 #  else
1940 #    define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
1941 #  endif
1942 #else
1943 #  define my_snprintf  Perl_my_snprintf
1944 #  define PERL_MY_SNPRINTF_GUARDED
1945 #endif
1946
1947 /* There is no quadmath_vsnprintf, and therefore my_vsnprintf()
1948  * dies if called under USE_QUADMATH. */
1949 #if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1950 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1951 #      define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1952 #      define PERL_MY_VSNPRINTF_GUARDED
1953 #  else
1954 #    define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
1955 #  endif
1956 #else
1957 #  define my_vsnprintf Perl_my_vsnprintf
1958 #  define PERL_MY_VSNPRINTF_GUARDED
1959 #endif
1960
1961 /* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1962  * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1963  * the result of my_snprintf() or my_vsnprintf().  (No, you should not
1964  * completely ignore it: otherwise you cannot know whether your output
1965  * was too long.)
1966  *
1967  * int len = my_sprintf(buf, max, ...);
1968  * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1969  *
1970  * The trick is that in certain platforms [a] the my_sprintf() already
1971  * contains the sanity check, while in certain platforms [b] it needs
1972  * to be done as a separate step.  The POST_GUARD is that step-- in [a]
1973  * platforms the POST_GUARD actually does nothing since the check has
1974  * already been done.  Watch out for the max being the same in both calls.
1975  *
1976  * If you actually use the snprintf/vsnprintf return value already,
1977  * you assumedly are checking its validity somehow.  But you can
1978  * insert the POST_GUARD() also in that case. */
1979
1980 #ifndef PERL_MY_SNPRINTF_GUARDED
1981 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1982 #else
1983 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1984 #endif
1985
1986 #ifndef  PERL_MY_VSNPRINTF_GUARDED
1987 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
1988 #else
1989 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1990 #endif
1991
1992 #ifdef HAS_STRLCAT
1993 #  define my_strlcat    strlcat
1994 #endif
1995
1996 #if defined(PERL_CORE) || defined(PERL_EXT)
1997 #  ifdef HAS_MEMRCHR
1998 #    define my_memrchr  memrchr
1999 #  else
2000 #    define my_memrchr  S_my_memrchr
2001 #  endif
2002 #endif
2003
2004 #ifdef HAS_STRLCPY
2005 #  define my_strlcpy    strlcpy
2006 #endif
2007
2008 #ifdef HAS_STRNLEN
2009 #  define my_strnlen    strnlen
2010 #endif
2011
2012 /*
2013     The IV type is supposed to be long enough to hold any integral
2014     value or a pointer.
2015     --Andy Dougherty    August 1996
2016 */
2017
2018 typedef IVTYPE IV;
2019 typedef UVTYPE UV;
2020
2021 #if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
2022 #  if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
2023 #    define IV_MAX ((IV)INT64_MAX)
2024 #    define IV_MIN ((IV)INT64_MIN)
2025 #    define UV_MAX ((UV)UINT64_MAX)
2026 #    ifndef UINT64_MIN
2027 #      define UINT64_MIN 0
2028 #    endif
2029 #    define UV_MIN ((UV)UINT64_MIN)
2030 #  else
2031 #    define IV_MAX PERL_QUAD_MAX
2032 #    define IV_MIN PERL_QUAD_MIN
2033 #    define UV_MAX PERL_UQUAD_MAX
2034 #    define UV_MIN PERL_UQUAD_MIN
2035 #  endif
2036 #  define IV_IS_QUAD
2037 #  define UV_IS_QUAD
2038 #else
2039 #  if defined(INT32_MAX) && IVSIZE == 4
2040 #    define IV_MAX ((IV)INT32_MAX)
2041 #    define IV_MIN ((IV)INT32_MIN)
2042 #    ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
2043 #        define UV_MAX ((UV)UINT32_MAX)
2044 #    else
2045 #        define UV_MAX ((UV)4294967295U)
2046 #    endif
2047 #    ifndef UINT32_MIN
2048 #      define UINT32_MIN 0
2049 #    endif
2050 #    define UV_MIN ((UV)UINT32_MIN)
2051 #  else
2052 #    define IV_MAX PERL_LONG_MAX
2053 #    define IV_MIN PERL_LONG_MIN
2054 #    define UV_MAX PERL_ULONG_MAX
2055 #    define UV_MIN PERL_ULONG_MIN
2056 #  endif
2057 #  if IVSIZE == 8
2058 #    define IV_IS_QUAD
2059 #    define UV_IS_QUAD
2060 #    ifndef HAS_QUAD
2061 #      define HAS_QUAD
2062 #    endif
2063 #  else
2064 #    undef IV_IS_QUAD
2065 #    undef UV_IS_QUAD
2066 #if !defined(PERL_CORE)
2067 /* We think that removing this decade-old undef this will cause too much
2068    breakage on CPAN for too little gain. (See RT #119753)
2069    However, we do need HAS_QUAD in the core for use by the drand48 code. */
2070 #    undef HAS_QUAD
2071 #endif
2072 #  endif
2073 #endif
2074
2075 #define Size_t_MAX (~(Size_t)0)
2076 #define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
2077
2078 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
2079 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
2080
2081 #ifndef NO_PERL_PRESERVE_IVUV
2082 #define PERL_PRESERVE_IVUV      /* We like our integers to stay integers. */
2083 #endif
2084
2085 /*
2086  *  The macros INT2PTR and NUM2PTR are (despite their names)
2087  *  bi-directional: they will convert int/float to or from pointers.
2088  *  However the conversion to int/float are named explicitly:
2089  *  PTR2IV, PTR2UV, PTR2NV.
2090  *
2091  *  For int conversions we do not need two casts if pointers are
2092  *  the same size as IV and UV.   Otherwise we need an explicit
2093  *  cast (PTRV) to avoid compiler warnings.
2094  *
2095  *  These are mentioned in perlguts
2096  */
2097 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
2098 #  define PTRV                  UV
2099 #  define INT2PTR(any,d)        (any)(d)
2100 #elif PTRSIZE == LONGSIZE
2101 #  define PTRV                  unsigned long
2102 #  define PTR2ul(p)             (unsigned long)(p)
2103 #else
2104 #  define PTRV                  unsigned
2105 #endif
2106
2107 #ifndef INT2PTR
2108 #  define INT2PTR(any,d)        (any)(PTRV)(d)
2109 #endif
2110
2111 #ifndef PTR2ul
2112 #  define PTR2ul(p)     INT2PTR(unsigned long,p)        
2113 #endif
2114
2115 /*
2116 =for apidoc_section Casting
2117 =for apidoc Cyh|type|NUM2PTR|type|int value
2118 You probably want to be using L<C</INT2PTR>> instead.
2119
2120 =cut
2121 */
2122
2123 #define NUM2PTR(any,d)  (any)(PTRV)(d)
2124 #define PTR2IV(p)       INT2PTR(IV,p)
2125 #define PTR2UV(p)       INT2PTR(UV,p)
2126 #define PTR2NV(p)       NUM2PTR(NV,p)
2127 #define PTR2nat(p)      (PTRV)(p)       /* pointer to integer of PTRSIZE */
2128
2129 /* According to strict ANSI C89 one cannot freely cast between
2130  * data pointers and function (code) pointers.  There are at least
2131  * two ways around this.  One (used below) is to do two casts,
2132  * first the other pointer to an (unsigned) integer, and then
2133  * the integer to the other pointer.  The other way would be
2134  * to use unions to "overlay" the pointers.  For an example of
2135  * the latter technique, see union dirpu in struct xpvio in sv.h.
2136  * The only feasible use is probably temporarily storing
2137  * function pointers in a data pointer (such as a void pointer). */
2138
2139 #define DPTR2FPTR(t,p) ((t)PTR2nat(p))  /* data pointer to function pointer */
2140 #define FPTR2DPTR(t,p) ((t)PTR2nat(p))  /* function pointer to data pointer */
2141
2142 #ifdef USE_LONG_DOUBLE
2143 #  if LONG_DOUBLESIZE == DOUBLESIZE
2144 #    define LONG_DOUBLE_EQUALS_DOUBLE
2145 #    undef USE_LONG_DOUBLE /* Ouch! */
2146 #  endif
2147 #endif
2148
2149 /* The following is all to get LDBL_DIG, in order to pick a nice
2150    default value for printing floating point numbers in Gconvert.
2151    (see config.h)
2152 */
2153 #ifndef HAS_LDBL_DIG
2154 #  if LONG_DOUBLESIZE == 10
2155 #    define LDBL_DIG 18 /* assume IEEE */
2156 #  elif LONG_DOUBLESIZE == 12
2157 #    define LDBL_DIG 18 /* gcc? */
2158 #  elif LONG_DOUBLESIZE == 16
2159 #    define LDBL_DIG 33 /* assume IEEE */
2160 #  elif LONG_DOUBLESIZE == DOUBLESIZE
2161 #    define LDBL_DIG DBL_DIG /* bummer */
2162 #  endif
2163 #endif
2164
2165 typedef NVTYPE NV;
2166
2167 #ifdef I_IEEEFP
2168 #   include <ieeefp.h>
2169 #endif
2170
2171 #if defined(__DECC) && defined(__osf__)
2172 /* Also Tru64 cc has broken NaN comparisons. */
2173 #  define NAN_COMPARE_BROKEN
2174 #endif
2175 #if defined(__sgi)
2176 #  define NAN_COMPARE_BROKEN
2177 #endif
2178
2179 #ifdef USE_LONG_DOUBLE
2180 #   ifdef I_SUNMATH
2181 #       include <sunmath.h>
2182 #   endif
2183 #   if defined(LDBL_DIG)
2184 #       define NV_DIG LDBL_DIG
2185 #       ifdef LDBL_MANT_DIG
2186 #           define NV_MANT_DIG LDBL_MANT_DIG
2187 #       endif
2188 #       ifdef LDBL_MIN
2189 #           define NV_MIN LDBL_MIN
2190 #       endif
2191 #       ifdef LDBL_MAX
2192 #           define NV_MAX LDBL_MAX
2193 #       endif
2194 #       ifdef LDBL_MIN_EXP
2195 #           define NV_MIN_EXP LDBL_MIN_EXP
2196 #       endif
2197 #       ifdef LDBL_MAX_EXP
2198 #           define NV_MAX_EXP LDBL_MAX_EXP
2199 #       endif
2200 #       ifdef LDBL_MIN_10_EXP
2201 #           define NV_MIN_10_EXP LDBL_MIN_10_EXP
2202 #       endif
2203 #       ifdef LDBL_MAX_10_EXP
2204 #           define NV_MAX_10_EXP LDBL_MAX_10_EXP
2205 #       endif
2206 #       ifdef LDBL_EPSILON
2207 #           define NV_EPSILON LDBL_EPSILON
2208 #       endif
2209 #       ifdef LDBL_MAX
2210 #           define NV_MAX LDBL_MAX
2211 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
2212 #       elif defined(HUGE_VALL)
2213 #           define NV_MAX HUGE_VALL
2214 #       endif
2215 #   endif
2216 #   if defined(HAS_SQRTL)
2217 #       define Perl_acos acosl
2218 #       define Perl_asin asinl
2219 #       define Perl_atan atanl
2220 #       define Perl_atan2 atan2l
2221 #       define Perl_ceil ceill
2222 #       define Perl_cos cosl
2223 #       define Perl_cosh coshl
2224 #       define Perl_exp expl
2225 /* no Perl_fabs, but there's PERL_ABS */
2226 #       define Perl_floor floorl
2227 #       define Perl_fmod fmodl
2228 #       define Perl_log logl
2229 #       define Perl_log10 log10l
2230 #       define Perl_pow powl
2231 #       define Perl_sin sinl
2232 #       define Perl_sinh sinhl
2233 #       define Perl_sqrt sqrtl
2234 #       define Perl_tan tanl
2235 #       define Perl_tanh tanhl
2236 #   endif
2237 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
2238 #   ifndef Perl_modf
2239 #       ifdef HAS_MODFL
2240 #           define Perl_modf(x,y) modfl(x,y)
2241 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
2242    prototype in <math.h> */
2243 #           ifndef HAS_MODFL_PROTO
2244 EXTERN_C long double modfl(long double, long double *);
2245 #           endif
2246 #       elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
2247         extern long double Perl_my_modfl(long double x, long double *ip);
2248 #           define Perl_modf(x,y) Perl_my_modfl(x,y)
2249 #       endif
2250 #   endif
2251 #   ifndef Perl_frexp
2252 #       ifdef HAS_FREXPL
2253 #           define Perl_frexp(x,y) frexpl(x,y)
2254 #       elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
2255 extern long double Perl_my_frexpl(long double x, int *e);
2256 #           define Perl_frexp(x,y) Perl_my_frexpl(x,y)
2257 #       endif
2258 #   endif
2259 #   ifndef Perl_ldexp
2260 #       ifdef HAS_LDEXPL
2261 #           define Perl_ldexp(x, y) ldexpl(x,y)
2262 #       elif defined(HAS_SCALBNL) && FLT_RADIX == 2
2263 #           define Perl_ldexp(x,y) scalbnl(x,y)
2264 #       endif
2265 #   endif
2266 #   ifndef Perl_isnan
2267 #       if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
2268 #           define Perl_isnan(x) isnanl(x)
2269 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
2270 #           define Perl_isnan(x) isnan(x)
2271 #       endif
2272 #   endif
2273 #   ifndef Perl_isinf
2274 #       if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
2275 #           define Perl_isinf(x) isinfl(x)
2276 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
2277 #           define Perl_isinf(x) isinf(x)
2278 #       elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2279 #           define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
2280 #       endif
2281 #   endif
2282 #   ifndef Perl_isfinite
2283 #       define Perl_isfinite(x) Perl_isfinitel(x)
2284 #   endif
2285 #elif defined(USE_QUADMATH) && defined(I_QUADMATH)
2286 #   include <quadmath.h>
2287 #   define NV_DIG FLT128_DIG
2288 #   define NV_MANT_DIG FLT128_MANT_DIG
2289 #   define NV_MIN FLT128_MIN
2290 #   define NV_MAX FLT128_MAX
2291 #   define NV_MIN_EXP FLT128_MIN_EXP
2292 #   define NV_MAX_EXP FLT128_MAX_EXP
2293 #   define NV_EPSILON FLT128_EPSILON
2294 #   define NV_MIN_10_EXP FLT128_MIN_10_EXP
2295 #   define NV_MAX_10_EXP FLT128_MAX_10_EXP
2296 #   define Perl_acos acosq
2297 #   define Perl_asin asinq
2298 #   define Perl_atan atanq
2299 #   define Perl_atan2 atan2q
2300 #   define Perl_ceil ceilq
2301 #   define Perl_cos cosq
2302 #   define Perl_cosh coshq
2303 #   define Perl_exp expq
2304 /* no Perl_fabs, but there's PERL_ABS */
2305 #   define Perl_floor floorq
2306 #   define Perl_fmod fmodq
2307 #   define Perl_log logq
2308 #   define Perl_log10 log10q
2309 #   define Perl_signbit signbitq
2310 #   define Perl_pow powq
2311 #   define Perl_sin sinq
2312 #   define Perl_sinh sinhq
2313 #   define Perl_sqrt sqrtq
2314 #   define Perl_tan tanq
2315 #   define Perl_tanh tanhq
2316 #   define Perl_modf(x,y) modfq(x,y)
2317 #   define Perl_frexp(x,y) frexpq(x,y)
2318 #   define Perl_ldexp(x, y) ldexpq(x,y)
2319 #   define Perl_isinf(x) isinfq(x)
2320 #   define Perl_isnan(x) isnanq(x)
2321 #   define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
2322 #   define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
2323 #   define Perl_fp_class_inf(x)    (Perl_fp_class(x) == 3)
2324 #   define Perl_fp_class_nan(x)    (Perl_fp_class(x) == 4)
2325 #   define Perl_fp_class_norm(x)   (Perl_fp_class(x) == 1)
2326 #   define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
2327 #   define Perl_fp_class_zero(x)   (Perl_fp_class(x) == 0)
2328 #else
2329 #   define NV_DIG DBL_DIG
2330 #   define NV_MANT_DIG DBL_MANT_DIG
2331 #   define NV_MIN DBL_MIN
2332 #   define NV_MAX DBL_MAX
2333 #   define NV_MIN_EXP DBL_MIN_EXP
2334 #   define NV_MAX_EXP DBL_MAX_EXP
2335 #   define NV_MIN_10_EXP DBL_MIN_10_EXP
2336 #   define NV_MAX_10_EXP DBL_MAX_10_EXP
2337 #   define NV_EPSILON DBL_EPSILON
2338 #   define NV_MAX DBL_MAX
2339 #   define NV_MIN DBL_MIN
2340
2341 /* These math interfaces are C89. */
2342 #   define Perl_acos acos
2343 #   define Perl_asin asin
2344 #   define Perl_atan atan
2345 #   define Perl_atan2 atan2
2346 #   define Perl_ceil ceil
2347 #   define Perl_cos cos
2348 #   define Perl_cosh cosh
2349 #   define Perl_exp exp
2350 /* no Perl_fabs, but there's PERL_ABS */
2351 #   define Perl_floor floor
2352 #   define Perl_fmod fmod
2353 #   define Perl_log log
2354 #   define Perl_log10 log10
2355 #   define Perl_pow pow
2356 #   define Perl_sin sin
2357 #   define Perl_sinh sinh
2358 #   define Perl_sqrt sqrt
2359 #   define Perl_tan tan
2360 #   define Perl_tanh tanh
2361
2362 #   define Perl_modf(x,y) modf(x,y)
2363 #   define Perl_frexp(x,y) frexp(x,y)
2364 #   define Perl_ldexp(x,y) ldexp(x,y)
2365
2366 #   ifndef Perl_isnan
2367 #       ifdef HAS_ISNAN
2368 #           define Perl_isnan(x) isnan(x)
2369 #       endif
2370 #   endif
2371 #   ifndef Perl_isinf
2372 #       if defined(HAS_ISINF)
2373 #           define Perl_isinf(x) isinf(x)
2374 #       elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2375 #           define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
2376 #       endif
2377 #   endif
2378 #   ifndef Perl_isfinite
2379 #     ifdef HAS_ISFINITE
2380 #       define Perl_isfinite(x) isfinite(x)
2381 #     elif defined(HAS_FINITE)
2382 #       define Perl_isfinite(x) finite(x)
2383 #     endif
2384 #   endif
2385 #endif
2386
2387 /* fpclassify(): C99.  It is supposed to be a macro that switches on
2388 * the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
2389 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2390 #    include <math.h>
2391 #    if defined(FP_INFINITE) && defined(FP_NAN)
2392 #        define Perl_fp_class(x)        fpclassify(x)
2393 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
2394 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
2395 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
2396 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2397 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
2398 #    elif defined(FP_PLUS_INF) && defined(FP_QNAN)
2399 /* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
2400  * actually not the C99 fpclassify, with its own set of return defines. */
2401 #        define Perl_fp_class(x)        fpclassify(x)
2402 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PLUS_INF)
2403 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_MINUS_INF)
2404 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
2405 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
2406 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PLUS_NORM)
2407 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_MINUS_NORM)
2408 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PLUS_DENORM)
2409 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_MINUS_DENORM)
2410 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PLUS_ZERO)
2411 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_MINUS_ZERO)
2412 #    else
2413 #        undef Perl_fp_class /* Unknown set of defines */
2414 #    endif
2415 #endif
2416
2417 /* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
2418  * are identical to the C99 fpclassify(). */
2419 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
2420 #    include <math.h>
2421 #    ifdef __VMS
2422      /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
2423 #        include <fp.h>
2424      /* oh, and the isnormal macro has a typo in it! */
2425 #    undef isnormal
2426 #    define isnormal(x) Perl_fp_class_norm(x)
2427 #    endif
2428 #    if defined(FP_INFINITE) && defined(FP_NAN)
2429 #        define Perl_fp_class(x)        fp_classify(x)
2430 #        define Perl_fp_class_inf(x)    (Perl_fp_class(x)==FP_INFINITE)
2431 #        define Perl_fp_class_nan(x)    (Perl_fp_class(x)==FP_NAN)
2432 #        define Perl_fp_class_norm(x)   (Perl_fp_class(x)==FP_NORMAL)
2433 #        define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_SUBNORMAL)
2434 #        define Perl_fp_class_zero(x)   (Perl_fp_class(x)==FP_ZERO)
2435 #    else
2436 #        undef Perl_fp_class /* Unknown set of defines */
2437 #    endif
2438 #endif
2439
2440 /* Feel free to check with me for the SGI manpages, SGI testing,
2441  * etcetera, if you want to try getting this to work with IRIX.
2442  *
2443  * - Allen <allens@cpan.org> */
2444
2445 /* fpclass(): SysV, at least Solaris and some versions of IRIX. */
2446 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
2447 /* Solaris and IRIX have fpclass/fpclassl, but they are using
2448  * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2449  * Define some symbols also as cpp symbols so we can detect them. */
2450 #    if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
2451 #     define FP_PINF FP_PINF
2452 #     define FP_QNAN FP_QNAN
2453 #    endif
2454 #    include <math.h>
2455 #    ifdef I_IEEFP
2456 #        include <ieeefp.h>
2457 #    endif
2458 #    ifdef I_FP
2459 #        include <fp.h>
2460 #    endif
2461 #    if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
2462 #        define Perl_fp_class(x)        fpclassl(x)
2463 #    else
2464 #        define Perl_fp_class(x)        fpclass(x)
2465 #    endif
2466 #    if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
2467 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_CLASS_SNAN)
2468 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_CLASS_QNAN)
2469 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_CLASS_NINF)
2470 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_CLASS_PINF)
2471 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_CLASS_NNORM)
2472 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_CLASS_PNORM)
2473 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_CLASS_NDENORM)
2474 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_CLASS_PDENORM)
2475 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_CLASS_NZERO)
2476 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_CLASS_PZERO)
2477 #    elif defined(FP_PINF) && defined(FP_QNAN)
2478 #        define Perl_fp_class_snan(x)   (Perl_fp_class(x)==FP_SNAN)
2479 #        define Perl_fp_class_qnan(x)   (Perl_fp_class(x)==FP_QNAN)
2480 #        define Perl_fp_class_ninf(x)   (Perl_fp_class(x)==FP_NINF)
2481 #        define Perl_fp_class_pinf(x)   (Perl_fp_class(x)==FP_PINF)
2482 #        define Perl_fp_class_nnorm(x)  (Perl_fp_class(x)==FP_NNORM)
2483 #        define Perl_fp_class_pnorm(x)  (Perl_fp_class(x)==FP_PNORM)
2484 #        define Perl_fp_class_ndenorm(x)        (Perl_fp_class(x)==FP_NDENORM)
2485 #        define Perl_fp_class_pdenorm(x)        (Perl_fp_class(x)==FP_PDENORM)
2486 #        define Perl_fp_class_nzero(x)  (Perl_fp_class(x)==FP_NZERO)
2487 #        define Perl_fp_class_pzero(x)  (Perl_fp_class(x)==FP_PZERO)
2488 #    else
2489 #        undef Perl_fp_class /* Unknown set of defines */
2490 #    endif
2491 #endif
2492
2493 /* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2494 #if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
2495 #    include <math.h>
2496 #    if !defined(FP_SNAN) && defined(I_FP_CLASS)
2497 #        include <fp_class.h>
2498 #    endif
2499 #    if defined(FP_POS_INF) && defined(FP_QNAN)
2500 #        ifdef __sgi /* XXX Configure test instead */
2501 #            ifdef USE_LONG_DOUBLE
2502 #                define Perl_fp_class(x)        fp_class_l(x)
2503 #            else
2504 #                define Perl_fp_class(x)        fp_class_d(x)
2505 #            endif
2506 #        else
2507 #            if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2508 #                define Perl_fp_class(x)        fp_classl(x)
2509 #            else
2510 #                define Perl_fp_class(x)        fp_class(x)
2511 #            endif
2512 #        endif
2513 #        if defined(FP_POS_INF) && defined(FP_QNAN)
2514 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_SNAN)
2515 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_QNAN)
2516 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_NEG_INF)
2517 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_POS_INF)
2518 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_NEG_NORM)
2519 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_POS_NORM)
2520 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_NEG_DENORM)
2521 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_POS_DENORM)
2522 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_NEG_ZERO)
2523 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_POS_ZERO)
2524 #        else
2525 #            undef Perl_fp_class /* Unknown set of defines */
2526 #        endif
2527 #    endif
2528 #endif
2529
2530 /* class(), _class(): Legacy: AIX. */
2531 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2532 #    include <math.h>
2533 #    if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2534 #        ifndef _cplusplus
2535 #            define Perl_fp_class(x)    class(x)
2536 #        else
2537 #            define Perl_fp_class(x)    _class(x)
2538 #        endif
2539 #        if defined(FP_PLUS_INF) && defined(FP_NANQ)
2540 #            define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_NANS)
2541 #            define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_NANQ)
2542 #            define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_MINUS_INF)
2543 #            define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_PLUS_INF)
2544 #            define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_MINUS_NORM)
2545 #            define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_PLUS_NORM)
2546 #            define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_MINUS_DENORM)
2547 #            define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_PLUS_DENORM)
2548 #            define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_MINUS_ZERO)
2549 #            define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_PLUS_ZERO)
2550 #        else
2551 #            undef Perl_fp_class /* Unknown set of defines */
2552 #        endif
2553 #    endif
2554 #endif
2555
2556 /* Win32: _fpclass(), _isnan(), _finite(). */
2557 #ifdef _MSC_VER
2558 #  ifndef Perl_isnan
2559 #    define Perl_isnan(x) _isnan(x)
2560 #  endif
2561 #  ifndef Perl_isfinite
2562 #    define Perl_isfinite(x) _finite(x)
2563 #  endif
2564 #  ifndef Perl_fp_class_snan
2565 /* No simple way to #define Perl_fp_class because _fpclass()
2566  * returns a set of bits. */
2567 #    define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2568 #    define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
2569 #    define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
2570 #    define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF)
2571 #    define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF)
2572 #    define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2573 #    define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2574 #    define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2575 #    define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2576 #    define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2577 #    define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2578 #    define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2579 #    define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2580 #    define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2581 #    define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2582 #  endif
2583 #endif
2584
2585 #if !defined(Perl_fp_class_inf) && \
2586   defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2587 #  define Perl_fp_class_inf(x) \
2588     (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2589 #endif
2590
2591 #if !defined(Perl_fp_class_nan) && \
2592   defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2593 #  define Perl_fp_class_nan(x) \
2594     (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2595 #endif
2596
2597 #if !defined(Perl_fp_class_zero) && \
2598   defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2599 #  define Perl_fp_class_zero(x) \
2600     (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2601 #endif
2602
2603 #if !defined(Perl_fp_class_norm) && \
2604   defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2605 #  define Perl_fp_class_norm(x) \
2606     (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2607 #endif
2608
2609 #if !defined(Perl_fp_class_denorm) && \
2610   defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2611 #  define Perl_fp_class_denorm(x) \
2612     (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
2613 #endif
2614
2615 #ifndef Perl_isnan
2616 #   ifdef Perl_fp_class_nan
2617 #       define Perl_isnan(x) Perl_fp_class_nan(x)
2618 #   elif defined(HAS_UNORDERED)
2619 #       define Perl_isnan(x) unordered((x), 0.0)
2620 #   else
2621 #       define Perl_isnan(x) ((x)!=(x))
2622 #   endif
2623 #endif
2624
2625 #ifndef Perl_isinf
2626 #   ifdef Perl_fp_class_inf
2627 #       define Perl_isinf(x) Perl_fp_class_inf(x)
2628 #   endif
2629 #endif
2630
2631 #ifndef Perl_isfinite
2632 #   if defined(HAS_ISFINITE) && !defined(isfinite)
2633 #     define Perl_isfinite(x) isfinite((double)(x))
2634 #   elif defined(HAS_FINITE)
2635 #       define Perl_isfinite(x) finite((double)(x))
2636 #   elif defined(Perl_fp_class_finite)
2637 #     define Perl_isfinite(x) Perl_fp_class_finite(x)
2638 #   else
2639 /* For the infinities the multiplication returns nan,
2640  * for the nan the multiplication also returns nan,
2641  * for everything else (that is, finite) zero should be returned. */
2642 #     define Perl_isfinite(x) (((x) * 0) == 0)
2643 #   endif
2644 #endif
2645
2646 #ifndef Perl_isinf
2647 #   if defined(Perl_isfinite) && defined(Perl_isnan)
2648 #       define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2649 #   endif
2650 #endif
2651
2652 /* We need Perl_isfinitel (ends with ell) (if available) even when
2653  * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2654  * needs that. */
2655 #if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2656 /* If isfinite() is a macro and looks like we have C99,
2657  * we assume it's the type-aware C99 isfinite(). */
2658 #    if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
2659 #        define Perl_isfinitel(x) isfinite(x)
2660 #    elif defined(HAS_ISFINITEL)
2661 #        define Perl_isfinitel(x) isfinitel(x)
2662 #    elif defined(HAS_FINITEL)
2663 #        define Perl_isfinitel(x) finitel(x)
2664 #    elif defined(HAS_INFL) && defined(HAS_NANL)
2665 #        define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
2666 #    else
2667 #        define Perl_isfinitel(x) ((x) * 0 == 0)  /* See Perl_isfinite. */
2668 #    endif
2669 #endif
2670
2671 /* The default is to use Perl's own atof() implementation (in numeric.c).
2672  * Usually that is the one to use but for some platforms (e.g. UNICOS)
2673  * it is however best to use the native implementation of atof.
2674  * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2675  * Some good tests to try out with either setting are t/base/num.t,
2676  * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2677  * you may need to be using a different function than atof! */
2678
2679 #ifndef USE_PERL_ATOF
2680 #   ifndef _UNICOS
2681 #       define USE_PERL_ATOF
2682 #   endif
2683 #else
2684 #   if USE_PERL_ATOF == 0
2685 #       undef USE_PERL_ATOF
2686 #   endif
2687 #endif
2688
2689 #ifdef USE_PERL_ATOF
2690 #   define Perl_atof(s) Perl_my_atof(s)
2691 #   define Perl_atof2(s, n) Perl_my_atof3(aTHX_ (s), &(n), 0)
2692 #else
2693 #   define Perl_atof(s) (NV)atof(s)
2694 #   define Perl_atof2(s, n) ((n) = atof(s))
2695 #endif
2696 #define my_atof2(a,b) my_atof3(a,b,0)
2697
2698 /*
2699 =for apidoc_section $numeric
2700 =for apidoc   AmT|NV|Perl_acos|NV x
2701 =for apidoc_item |NV|Perl_asin|NV x
2702 =for apidoc_item |NV|Perl_atan|NV x
2703 =for apidoc_item |NV|Perl_atan2|NV x|NV y
2704 =for apidoc_item |NV|Perl_ceil|NV x
2705 =for apidoc_item |NV|Perl_cos|NV x
2706 =for apidoc_item |NV|Perl_cosh|NV x
2707 =for apidoc_item |NV|Perl_exp|NV x
2708 =for apidoc_item |NV|Perl_floor|NV x
2709 =for apidoc_item |NV|Perl_fmod|NV x|NV y
2710 =for apidoc_item |NV|Perl_frexp|NV x|int *exp
2711 =for apidoc_item |IV|Perl_isfinite|NV x
2712 =for apidoc_item |IV|Perl_isinf|NV x
2713 =for apidoc_item |IV|Perl_isnan|NV x
2714 =for apidoc_item |NV|Perl_ldexp|NV x|int exp
2715 =for apidoc_item |NV|Perl_log|NV x
2716 =for apidoc_item |NV|Perl_log10|NV x
2717 =for apidoc_item |NV|Perl_modf|NV x|NV *iptr
2718 =for apidoc_item |NV|Perl_pow|NV x|NV y
2719 =for apidoc_item |NV|Perl_sin|NV x
2720 =for apidoc_item |NV|Perl_sinh|NV x
2721 =for apidoc_item |NV|Perl_sqrt|NV x
2722 =for apidoc_item |NV|Perl_tan|NV x
2723 =for apidoc_item |NV|Perl_tanh|NV x
2724
2725 These perform the corresponding mathematical operation on the operand(s), using
2726 the libc function designed for the task that has just enough precision for an
2727 NV on this platform.  If no such function with sufficient precision exists,
2728 the highest precision one available is used.
2729
2730 =cut
2731 */
2732
2733 /*
2734  * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2735  * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2736  * depending on local options. Until Configure detects this (or at least
2737  * detects whether the "signed" keyword is available) the CHAR ranges
2738  * will not be included. UCHAR functions normally.
2739  *                                                           - kja
2740  */
2741
2742 #define PERL_UCHAR_MIN ((unsigned char)0)
2743 #define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2744
2745 #define PERL_USHORT_MIN ((unsigned short)0)
2746 #define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2747
2748 #define PERL_SHORT_MAX ((short)SHRT_MAX)
2749 #define PERL_SHORT_MIN ((short)SHRT_MIN)
2750
2751 #define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2752 #define PERL_UINT_MIN ((unsigned int)0)
2753
2754 #define PERL_INT_MAX ((int)INT_MAX)
2755 #define PERL_INT_MIN ((int)INT_MIN)
2756
2757 #define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2758 #define PERL_ULONG_MIN ((unsigned long)0L)
2759
2760 #define PERL_LONG_MAX ((long)LONG_MAX)
2761 #define PERL_LONG_MIN ((long)LONG_MIN)
2762
2763 #ifdef UV_IS_QUAD
2764 #    define PERL_UQUAD_MAX      (~(UV)0)
2765 #    define PERL_UQUAD_MIN      ((UV)0)
2766 #    define PERL_QUAD_MAX       ((IV) (PERL_UQUAD_MAX >> 1))
2767 #    define PERL_QUAD_MIN       (-PERL_QUAD_MAX - ((3 & -1) == 3))
2768 #endif
2769
2770 /*
2771 =for apidoc_section $integer
2772
2773 =for apidoc AmnU||PERL_INT_MAX
2774 =for apidoc_item ||PERL_INT_MIN
2775 =for apidoc_item ||PERL_LONG_MAX
2776 =for apidoc_item ||PERL_LONG_MIN
2777 =for apidoc_item ||PERL_SHORT_MAX
2778 =for apidoc_item ||PERL_SHORT_MIN
2779 =for apidoc_item ||PERL_UCHAR_MAX
2780 =for apidoc_item ||PERL_UCHAR_MIN
2781 =for apidoc_item ||PERL_UINT_MAX
2782 =for apidoc_item ||PERL_UINT_MIN
2783 =for apidoc_item ||PERL_ULONG_MAX
2784 =for apidoc_item ||PERL_ULONG_MIN
2785 =for apidoc_item ||PERL_USHORT_MAX
2786 =for apidoc_item ||PERL_USHORT_MIN
2787 =for apidoc_item ||PERL_QUAD_MAX
2788 =for apidoc_item ||PERL_QUAD_MIN
2789 =for apidoc_item ||PERL_UQUAD_MAX
2790 =for apidoc_item ||PERL_UQUAD_MIN
2791
2792 These give the largest and smallest number representable in the current
2793 platform in variables of the corresponding types.
2794
2795 For signed types, the smallest representable number is the most negative
2796 number, the one furthest away from zero.
2797
2798 For C99 and later compilers, these correspond to things like C<INT_MAX>, which
2799 are available to the C code.  But these constants, furnished by Perl,
2800 allow code compiled on earlier compilers to portably have access to the same
2801 constants.
2802
2803 =cut
2804
2805 */
2806
2807 typedef MEM_SIZE STRLEN;
2808
2809 typedef struct op OP;
2810 typedef struct cop COP;
2811 typedef struct unop UNOP;
2812 typedef struct unop_aux UNOP_AUX;
2813 typedef struct binop BINOP;
2814 typedef struct listop LISTOP;
2815 typedef struct logop LOGOP;
2816 typedef struct pmop PMOP;
2817 typedef struct svop SVOP;
2818 typedef struct padop PADOP;
2819 typedef struct pvop PVOP;
2820 typedef struct loop LOOP;
2821 typedef struct methop METHOP;
2822
2823 #ifdef PERL_CORE
2824 typedef struct opslab OPSLAB;
2825 typedef struct opslot OPSLOT;
2826 #endif
2827
2828 typedef struct block_hooks BHK;
2829 typedef struct custom_op XOP;
2830
2831 typedef struct interpreter PerlInterpreter;
2832
2833 /* SGI's <sys/sema.h> has struct sv */
2834 #if defined(__sgi)
2835 #   define STRUCT_SV perl_sv
2836 #else
2837 #   define STRUCT_SV sv
2838 #endif
2839 typedef struct STRUCT_SV SV;
2840 typedef struct av AV;
2841 typedef struct hv HV;
2842 typedef struct cv CV;
2843 typedef struct p5rx REGEXP;
2844 typedef struct gp GP;
2845 typedef struct gv GV;
2846 typedef struct io IO;
2847 typedef struct context PERL_CONTEXT;
2848 typedef struct block BLOCK;
2849 typedef struct invlist INVLIST;
2850
2851 typedef struct magic MAGIC;
2852 typedef struct xpv XPV;
2853 typedef struct xpviv XPVIV;
2854 typedef struct xpvuv XPVUV;
2855 typedef struct xpvnv XPVNV;
2856 typedef struct xpvmg XPVMG;
2857 typedef struct xpvlv XPVLV;
2858 typedef struct xpvinvlist XINVLIST;
2859 typedef struct xpvav XPVAV;
2860 typedef struct xpvhv XPVHV;
2861 typedef struct xpvgv XPVGV;
2862 typedef struct xpvcv XPVCV;
2863 typedef struct xpvbm XPVBM;
2864 typedef struct xpvfm XPVFM;
2865 typedef struct xpvio XPVIO;
2866 typedef struct mgvtbl MGVTBL;
2867 typedef union any ANY;
2868 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2869 typedef struct ptr_tbl PTR_TBL_t;
2870 typedef struct clone_params CLONE_PARAMS;
2871
2872 /* a pad is currently just an AV; but that might change,
2873  * so hide the type.  */
2874 typedef struct padlist PADLIST;
2875 typedef AV PAD;
2876 typedef struct padnamelist PADNAMELIST;
2877 typedef struct padname PADNAME;
2878
2879 /* always enable PERL_OP_PARENT  */
2880 #if !defined(PERL_OP_PARENT)
2881 #  define PERL_OP_PARENT
2882 #endif
2883
2884 /* enable PERL_COPY_ON_WRITE by default */
2885 #if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2886 #  define PERL_COPY_ON_WRITE
2887 #endif
2888
2889 #ifdef PERL_COPY_ON_WRITE
2890 #  define PERL_ANY_COW
2891 #else
2892 # define PERL_SAWAMPERSAND
2893 #endif
2894
2895 #if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2896 # error PERL_DEBUG_READONLY_OPS only works with ithreads
2897 #endif
2898
2899 #include "handy.h"
2900 #include "charclass_invlists.h"
2901
2902 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2903 #   if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2904 #       define USE_64_BIT_RAWIO /* implicit */
2905 #   endif
2906 #endif
2907
2908 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2909  * fseeko/ftello if possible.  Don't go #defining ftell to ftello yourself,
2910  * however, because operating systems like to do that themself. */
2911 #ifndef FSEEKSIZE
2912 #   ifdef HAS_FSEEKO
2913 #       define FSEEKSIZE LSEEKSIZE
2914 #   else
2915 #       define FSEEKSIZE LONGSIZE
2916 #   endif
2917 #endif
2918
2919 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2920 #   if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2921 #       define USE_64_BIT_STDIO /* implicit */
2922 #   endif
2923 #endif
2924
2925 #ifdef USE_64_BIT_RAWIO
2926 #   ifdef HAS_OFF64_T
2927 #       undef Off_t
2928 #       define Off_t off64_t
2929 #       undef LSEEKSIZE
2930 #       define LSEEKSIZE 8
2931 #   endif
2932 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2933  * will trigger defines like the ones below.  Some 64-bit environments,
2934  * however, do not.  Therefore we have to explicitly mix and match. */
2935 #   if defined(USE_OPEN64)
2936 #       define open open64
2937 #   endif
2938 #   if defined(USE_LSEEK64)
2939 #       define lseek lseek64
2940 #   else
2941 #       if defined(USE_LLSEEK)
2942 #           define lseek llseek
2943 #       endif
2944 #   endif
2945 #   if defined(USE_STAT64)
2946 #       define stat stat64
2947 #   endif
2948 #   if defined(USE_FSTAT64)
2949 #       define fstat fstat64
2950 #   endif
2951 #   if defined(USE_LSTAT64)
2952 #       define lstat lstat64
2953 #   endif
2954 #   if defined(USE_FLOCK64)
2955 #       define flock flock64
2956 #   endif
2957 #   if defined(USE_LOCKF64)
2958 #       define lockf lockf64
2959 #   endif
2960 #   if defined(USE_FCNTL64)
2961 #       define fcntl fcntl64
2962 #   endif
2963 #   if defined(USE_TRUNCATE64)
2964 #       define truncate truncate64
2965 #   endif
2966 #   if defined(USE_FTRUNCATE64)
2967 #       define ftruncate ftruncate64
2968 #   endif
2969 #endif
2970
2971 #ifdef USE_64_BIT_STDIO
2972 #   ifdef HAS_FPOS64_T
2973 #       undef Fpos_t
2974 #       define Fpos_t fpos64_t
2975 #   endif
2976 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2977  * will trigger defines like the ones below.  Some 64-bit environments,
2978  * however, do not. */
2979 #   if defined(USE_FOPEN64)
2980 #       define fopen fopen64
2981 #   endif
2982 #   if defined(USE_FSEEK64)
2983 #       define fseek fseek64 /* don't do fseeko here, see perlio.c */
2984 #   endif
2985 #   if defined(USE_FTELL64)
2986 #       define ftell ftell64 /* don't do ftello here, see perlio.c */
2987 #   endif
2988 #   if defined(USE_FSETPOS64)
2989 #       define fsetpos fsetpos64
2990 #   endif
2991 #   if defined(USE_FGETPOS64)
2992 #       define fgetpos fgetpos64
2993 #   endif
2994 #   if defined(USE_TMPFILE64)
2995 #       define tmpfile tmpfile64
2996 #   endif
2997 #   if defined(USE_FREOPEN64)
2998 #       define freopen freopen64
2999 #   endif
3000 #endif
3001
3002 #if defined(OS2)
3003 #  include "iperlsys.h"
3004 #endif
3005
3006 #ifdef DOSISH
3007 #   if defined(OS2)
3008 #       include "os2ish.h"
3009 #   else
3010 #       include "dosish.h"
3011 #   endif
3012 #elif defined(VMS)
3013 #   include "vmsish.h"
3014 #elif defined(PLAN9)
3015 #   include "./plan9/plan9ish.h"
3016 #elif defined(__VOS__)
3017 #   ifdef __GNUC__
3018 #     include "./vos/vosish.h"
3019 #   else
3020 #     include "vos/vosish.h"
3021 #   endif
3022 #elif defined(__HAIKU__)
3023 #   include "haiku/haikuish.h"
3024 #else
3025 #   include "unixish.h"
3026 #endif
3027
3028 #ifdef __amigaos4__
3029 #    include "amigaos.h"
3030 #    undef FD_CLOEXEC /* a lie in AmigaOS */
3031 #endif
3032
3033 /* NSIG logic from Configure --> */
3034 #ifndef NSIG
3035 #  ifdef _NSIG
3036 #    define NSIG (_NSIG)
3037 #  elif defined(SIGMAX)
3038 #    define NSIG (SIGMAX+1)
3039 #  elif defined(SIG_MAX)
3040 #    define NSIG (SIG_MAX+1)
3041 #  elif defined(_SIG_MAX)
3042 #    define NSIG (_SIG_MAX+1)
3043 #  elif defined(MAXSIG)
3044 #    define NSIG (MAXSIG+1)
3045 #  elif defined(MAX_SIG)
3046 #    define NSIG (MAX_SIG+1)
3047 #  elif defined(SIGARRAYSIZE)
3048 #    define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
3049 #  elif defined(_sys_nsig)
3050 #    define NSIG (_sys_nsig) /* Solaris 2.5 */
3051 #  else
3052      /* Default to some arbitrary number that's big enough to get most
3053       * of the common signals.  */
3054 #    define NSIG 50
3055 #  endif
3056 #endif
3057 /* <-- NSIG logic from Configure */
3058
3059 #ifndef NO_ENVIRON_ARRAY
3060 #  define USE_ENVIRON_ARRAY
3061 #endif
3062
3063 #ifdef USE_ITHREADS
3064    /* On some platforms it would be safe to use a read/write mutex with many
3065     * readers possible at the same time.  On other platforms, notably IBM ones,
3066     * subsequent getenv calls destroy earlier ones.  Those platforms would not
3067     * be able to handle simultaneous getenv calls */
3068 #  define ENV_LOCK            MUTEX_LOCK(&PL_env_mutex)
3069 #  define ENV_UNLOCK          MUTEX_UNLOCK(&PL_env_mutex)
3070 #  define ENV_INIT            MUTEX_INIT(&PL_env_mutex);
3071 #  define ENV_TERM            MUTEX_DESTROY(&PL_env_mutex);
3072 #else
3073 #  define ENV_LOCK       NOOP;
3074 #  define ENV_UNLOCK     NOOP;
3075 #  define ENV_INIT       NOOP;
3076 #  define ENV_TERM       NOOP;
3077 #endif
3078
3079 /* Some critical sections need to lock both the locale and the environment.
3080  * XXX khw intends to change this to lock both mutexes, but that brings up
3081  * issues of potential deadlock, so should be done at the beginning of a
3082  * development cycle.  So for now, it just locks the environment.  Note that
3083  * many modern platforms are locale-thread-safe anyway, so locking the locale
3084  * mutex is a no-op anyway */
3085 #define ENV_LOCALE_LOCK     ENV_LOCK
3086 #define ENV_LOCALE_UNLOCK   ENV_UNLOCK
3087
3088 /* And some critical sections care only that no one else is writing either the
3089  * locale nor the environment.  XXX Again this is for the future.  This can be
3090  * simulated with using COND_WAIT in thread.h */
3091 #define ENV_LOCALE_READ_LOCK     ENV_LOCALE_LOCK
3092 #define ENV_LOCALE_READ_UNLOCK   ENV_LOCALE_UNLOCK
3093
3094 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3095     /* having sigaction(2) means that the OS supports both 1-arg and 3-arg
3096      * signal handlers. But the perl core itself only fully supports 1-arg
3097      * handlers, so don't enable for now.
3098      * NB: POSIX::sigaction() supports both.
3099      *
3100      * # define PERL_USE_3ARG_SIGHANDLER
3101      */
3102 #endif
3103
3104 /* Siginfo_t:
3105  * This is an alias for the OS's siginfo_t, except that where the OS
3106  * doesn't support it, declare a dummy version instead. This allows us to
3107  * have signal handler functions which always have a Siginfo_t parameter
3108  * regardless of platform, (and which will just be passed a NULL value
3109  * where the OS doesn't support HAS_SIGACTION).
3110  */
3111
3112 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
3113     typedef siginfo_t Siginfo_t;
3114 #else
3115 #ifdef si_signo /* minix */
3116 #undef si_signo
3117 #endif
3118     typedef struct {
3119         int si_signo;
3120     } Siginfo_t;
3121 #endif
3122
3123
3124 /*
3125  * initialise to avoid floating-point exceptions from overflow, etc
3126  */
3127 #ifndef PERL_FPU_INIT
3128 #  ifdef HAS_FPSETMASK
3129 #    if HAS_FLOATINGPOINT_H
3130 #      include <floatingpoint.h>
3131 #    endif
3132 /* Some operating systems have this as a macro, which in turn expands to a comma
3133    expression, and the last sub-expression is something that gets calculated,
3134    and then they have the gall to warn that a value computed is not used. Hence
3135    cast to void.  */
3136 #    define PERL_FPU_INIT (void)fpsetmask(0)
3137 #  elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
3138 #    define PERL_FPU_INIT       PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
3139 #    define PERL_FPU_PRE_EXEC   { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
3140 #    define PERL_FPU_POST_EXEC    rsignal_restore(SIGFPE, &xfpe); }
3141 #  else
3142 #    define PERL_FPU_INIT
3143 #  endif
3144 #endif
3145 #ifndef PERL_FPU_PRE_EXEC
3146 #  define PERL_FPU_PRE_EXEC   {
3147 #  define PERL_FPU_POST_EXEC  }
3148 #endif
3149
3150 /* In Tru64 the cc -ieee enables the IEEE math but disables traps.
3151  * We need to reenable the "invalid" trap because otherwise generation
3152  * of NaN values leaves the IEEE fp flags in bad state, leaving any further
3153  * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
3154 #ifdef __osf__
3155 #  include <machine/fpu.h>
3156 #  define PERL_SYS_FPU_INIT \
3157      STMT_START { \
3158          ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
3159          signal(SIGFPE, SIG_IGN); \
3160      } STMT_END
3161 #endif
3162 /* In IRIX the default for Flush to Zero bit is true,
3163  * which means that results going below the minimum of normal
3164  * floating points go to zero, instead of going denormal/subnormal.
3165  * This is unlike almost any other system running Perl, so let's clear it.
3166  * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
3167  * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
3168  *
3169  * XXX The flush-to-zero behaviour should be a Configure scan.
3170  * To change the behaviour usually requires some system-specific
3171  * incantation, though, like the below. */
3172 #ifdef __sgi
3173 #  include <sys/fpu.h>
3174 #  define PERL_SYS_FPU_INIT \
3175      STMT_START { \
3176          union fpc_csr csr; \
3177          csr.fc_word = get_fpc_csr(); \
3178          csr.fc_struct.flush = 0; \
3179          set_fpc_csr(csr.fc_word); \
3180      } STMT_END
3181 #endif
3182
3183 #ifndef PERL_SYS_FPU_INIT
3184 #  define PERL_SYS_FPU_INIT NOOP
3185 #endif
3186
3187 #ifndef PERL_SYS_INIT3_BODY
3188 #  define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
3189 #endif
3190
3191 /*
3192 =for apidoc_section $embedding
3193
3194 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
3195 Provides system-specific tune up of the C runtime environment necessary to
3196 run Perl interpreters.  This should be called only once, before creating
3197 any Perl interpreters.
3198
3199 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
3200 Provides system-specific tune up of the C runtime environment necessary to
3201 run Perl interpreters.  This should be called only once, before creating
3202 any Perl interpreters.
3203
3204 =for apidoc Am|void|PERL_SYS_TERM|
3205 Provides system-specific clean up of the C runtime environment after
3206 running Perl interpreters.  This should be called only once, after
3207 freeing any remaining Perl interpreters.
3208
3209 =cut
3210  */
3211
3212 #define PERL_SYS_INIT(argc, argv)       Perl_sys_init(argc, argv)
3213 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
3214 #define PERL_SYS_TERM()                 Perl_sys_term()
3215
3216 #ifndef PERL_WRITE_MSG_TO_CONSOLE
3217 #  define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
3218 #endif
3219
3220 #ifndef MAXPATHLEN
3221 #  ifdef PATH_MAX
3222 #    ifdef _POSIX_PATH_MAX
3223 #       if PATH_MAX > _POSIX_PATH_MAX
3224 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
3225  * included the null byte or not.  Later amendments of POSIX,
3226  * XPG4, the Austin Group, and the Single UNIX Specification
3227  * all explicitly include the null byte in the PATH_MAX.
3228  * Ditto for _POSIX_PATH_MAX. */
3229 #         define MAXPATHLEN PATH_MAX
3230 #       else
3231 #         define MAXPATHLEN _POSIX_PATH_MAX
3232 #       endif
3233 #    else
3234 #      define MAXPATHLEN (PATH_MAX+1)
3235 #    endif
3236 #  else
3237 #    define MAXPATHLEN 1024     /* Err on the large side. */
3238 #  endif
3239 #endif
3240
3241 /* clang Thread Safety Analysis/Annotations/Attributes
3242  * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
3243  *
3244  * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
3245  * Apple XCode hijacks __clang_major__ and __clang_minor__
3246  * (6.1 means really clang 3.6), so needs extra hijinks
3247  * (could probably also test the contents of __apple_build_version__).
3248  */
3249 #if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
3250     defined(__clang__) && \
3251     !defined(SWIG) && \
3252   ((!defined(__apple_build_version__) &&               \
3253     ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
3254      (__clang_major__ >= 4))) || \
3255    (defined(__apple_build_version__) &&                \
3256     ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
3257      (__clang_major__ >= 7))))
3258 #  define PERL_TSA__(x)   __attribute__((x))
3259 #  define PERL_TSA_ACTIVE
3260 #else
3261 #  define PERL_TSA__(x)   /* No TSA, make TSA attributes no-ops. */
3262 #  undef PERL_TSA_ACTIVE
3263 #endif
3264
3265 /* PERL_TSA_CAPABILITY() is used to annotate typedefs.
3266  * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
3267  */
3268 #define PERL_TSA_CAPABILITY(x) \
3269     PERL_TSA__(capability(x))
3270
3271 /* In the below examples the mutex must be lexically visible, usually
3272  * either as global variables, or as function arguments. */
3273
3274 /* PERL_TSA_GUARDED_BY() is used to annotate global variables.
3275  *
3276  * Foo foo PERL_TSA_GUARDED_BY(mutex);
3277  */
3278 #define PERL_TSA_GUARDED_BY(x) \
3279     PERL_TSA__(guarded_by(x))
3280
3281 /* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
3282  * The data _behind_ the pointer is guarded.
3283  *
3284  * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
3285  */
3286 #define PERL_TSA_PT_GUARDED_BY(x) \
3287     PERL_TSA__(pt_guarded_by(x))
3288
3289 /* PERL_TSA_REQUIRES() is used to annotate functions.
3290  * The caller MUST hold the resource when calling the function.
3291  *
3292  * void Foo() PERL_TSA_REQUIRES(mutex);
3293  */
3294 #define PERL_TSA_REQUIRES(x) \
3295     PERL_TSA__(requires_capability(x))
3296
3297 /* PERL_TSA_EXCLUDES() is used to annotate functions.
3298  * The caller MUST NOT hold resource when calling the function.
3299  *
3300  * EXCLUDES should be used when the function first acquires
3301  * the resource and then releases it.  Use to avoid deadlock.
3302  *
3303  * void Foo() PERL_TSA_EXCLUDES(mutex);
3304  */
3305 #define PERL_TSA_EXCLUDES(x) \
3306     PERL_TSA__(locks_excluded(x))
3307
3308 /* PERL_TSA_ACQUIRE() is used to annotate functions.
3309  * The caller MUST NOT hold the resource when calling the function,
3310  * and the function will acquire the resource.
3311  *
3312  * void Foo() PERL_TSA_ACQUIRE(mutex);
3313  */
3314 #define PERL_TSA_ACQUIRE(x) \
3315     PERL_TSA__(acquire_capability(x))
3316
3317 /* PERL_TSA_RELEASE() is used to annotate functions.
3318  * The caller MUST hold the resource when calling the function,
3319  * and the function will release the resource.
3320  *
3321  * void Foo() PERL_TSA_RELEASE(mutex);
3322  */
3323 #define PERL_TSA_RELEASE(x) \
3324     PERL_TSA__(release_capability(x))
3325
3326 /* PERL_TSA_NO_TSA is used to annotate functions.
3327  * Used when being intentionally unsafe, or when the code is too
3328  * complicated for the analysis.  Use sparingly.
3329  *
3330  * void Foo() PERL_TSA_NO_TSA;
3331  */
3332 #define PERL_TSA_NO_TSA \
3333     PERL_TSA__(no_thread_safety_analysis)
3334
3335 /* There are more annotations/attributes available, see the clang
3336  * documentation for details. */
3337
3338 #if defined(USE_ITHREADS)
3339 #  ifdef NETWARE
3340 #    include <nw5thread.h>
3341 #  elif defined(WIN32)
3342 #    include <win32thread.h>
3343 #  elif defined(OS2)
3344 #    include "os2thread.h"
3345 #  elif defined(I_MACH_CTHREADS)
3346 #    include <mach/cthreads.h>
3347 typedef cthread_t       perl_os_thread;
3348 typedef mutex_t         perl_mutex;
3349 typedef condition_t     perl_cond;
3350 typedef void *          perl_key;
3351 #  elif defined(I_PTHREAD) /* Posix threads */
3352 #    include <pthread.h>
3353 typedef pthread_t       perl_os_thread;
3354 typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
3355 typedef pthread_cond_t  perl_cond;
3356 typedef pthread_key_t   perl_key;
3357 #  endif
3358 #endif /* USE_ITHREADS */
3359
3360 #ifdef PERL_TSA_ACTIVE
3361 /* Since most pthread mutex interfaces have not been annotated, we
3362  * need to have these wrappers. The NO_TSA annotation is quite ugly
3363  * but it cannot be avoided in plain C, unlike in C++, where one could
3364  * e.g. use ACQUIRE() with no arg on a mutex lock method.
3365  *
3366  * The bodies of these wrappers are in util.c
3367  *
3368  * TODO: however, some platforms are starting to get these clang
3369  * thread safety annotations for pthreads, for example FreeBSD.
3370  * Do we need a way to a bypass these wrappers? */
3371 EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
3372   PERL_TSA_ACQUIRE(*mutex)
3373   PERL_TSA_NO_TSA;
3374 EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
3375   PERL_TSA_RELEASE(*mutex)
3376   PERL_TSA_NO_TSA;
3377 #endif
3378
3379 #if defined(WIN32)
3380 #  include "win32.h"
3381 #endif
3382
3383 #ifdef NETWARE
3384 #  include "netware.h"
3385 #endif
3386
3387 #define STATUS_UNIX     PL_statusvalue
3388 #ifdef VMS
3389 #   define STATUS_NATIVE        PL_statusvalue_vms
3390 /*
3391  * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
3392  * its contents can not be trusted.  Unfortunately, Perl seems to check
3393  * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
3394  * be updated also.
3395  */
3396 #  include <stsdef.h>
3397 #  include <ssdef.h>
3398 /* Presume this because if VMS changes it, it will require a new
3399  * set of APIs for waiting on children for binary compatibility.
3400  */
3401 #  define child_offset_bits (8)
3402 #  ifndef C_FAC_POSIX
3403 #  define C_FAC_POSIX 0x35A000
3404 #  endif
3405
3406 /*  STATUS_EXIT - validates and returns a NATIVE exit status code for the
3407  * platform from the existing UNIX or Native status values.
3408  */
3409
3410 #   define STATUS_EXIT \
3411         (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
3412            (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
3413
3414
3415 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
3416  * exit code and shifts the UNIX value over the correct number of bits to
3417  * be a child status.  Usually the number of bits is 8, but that could be
3418  * platform dependent.  The NATIVE status code is presumed to have either
3419  * from a child process.
3420  */
3421
3422 /* This is complicated.  The child processes return a true native VMS
3423    status which must be saved.  But there is an assumption in Perl that
3424    the UNIX child status has some relationship to errno values, so
3425    Perl tries to translate it to text in some of the tests.
3426    In order to get the string translation correct, for the error, errno
3427    must be EVMSERR, but that generates a different text message
3428    than what the test programs are expecting.  So an errno value must
3429    be derived from the native status value when an error occurs.
3430    That will hide the true native status message.  With this version of
3431    perl, the true native child status can always be retrieved so that
3432    is not a problem.  But in this case, Pl_statusvalue and errno may
3433    have different values in them.
3434  */
3435
3436 #   define STATUS_NATIVE_CHILD_SET(n) \
3437         STMT_START {                                                    \
3438             I32 evalue = (I32)n;                                        \
3439             if (evalue == EVMSERR) {                                    \
3440               PL_statusvalue_vms = vaxc$errno;                          \
3441               PL_statusvalue = evalue;                                  \
3442             } else {                                                    \
3443               PL_statusvalue_vms = evalue;                              \
3444               if (evalue == -1) {                                       \
3445                 PL_statusvalue = -1;                                    \
3446                 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3447               } else                                                    \
3448                 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1);    \
3449               set_vaxc_errno(evalue);                                   \
3450               if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX)    \
3451                   set_errno(EVMSERR);                                   \
3452               else set_errno(Perl_vms_status_to_unix(evalue, 0));       \
3453               PL_statusvalue = PL_statusvalue << child_offset_bits;     \
3454             }                                                           \
3455         } STMT_END
3456
3457 #   ifdef VMSISH_STATUS
3458 #       define STATUS_CURRENT   (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
3459 #   else
3460 #       define STATUS_CURRENT   STATUS_UNIX
3461 #   endif
3462
3463   /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3464    * the NATIVE status to an equivalent value.  Can not be used to translate
3465    * exit code values as exit code values are not guaranteed to have any
3466    * relationship at all to errno values.
3467    * This is used when Perl is forcing errno to have a specific value.
3468    */
3469 #   define STATUS_UNIX_SET(n)                           \
3470         STMT_START {                                    \
3471             I32 evalue = (I32)n;                        \
3472             PL_statusvalue = evalue;                    \
3473             if (PL_statusvalue != -1) {                 \
3474                 if (PL_statusvalue != EVMSERR) {        \
3475                   PL_statusvalue &= 0xFFFF;             \
3476                   if (MY_POSIX_EXIT)                    \
3477                     PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3478                   else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3479                 }                                       \
3480                 else {                                  \
3481                   PL_statusvalue_vms = vaxc$errno;      \
3482                 }                                       \
3483             }                                           \
3484             else PL_statusvalue_vms = SS$_ABORT;        \
3485             set_vaxc_errno(PL_statusvalue_vms);         \
3486         } STMT_END
3487
3488   /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
3489    * the NATIVE error status based on it.
3490    *
3491    * When in the default mode to comply with the Perl VMS documentation,
3492    * 0 is a success and any other code sets the NATIVE status to a failure
3493    * code of SS$_ABORT.
3494    *
3495    * In the new POSIX EXIT mode, native status will be set so that the
3496    * actual exit code will can be retrieved by the calling program or
3497    * shell.
3498    *
3499    * If the exit code is not clearly a UNIX parent or child exit status,
3500    * it will be passed through as a VMS status.
3501    */
3502
3503 #   define STATUS_UNIX_EXIT_SET(n)                      \
3504         STMT_START {                                    \
3505             I32 evalue = (I32)n;                        \
3506             PL_statusvalue = evalue;                    \
3507             if (MY_POSIX_EXIT) { \
3508               if (evalue <= 0xFF00) {           \
3509                   if (evalue > 0xFF)                    \
3510                     evalue = (evalue >> child_offset_bits) & 0xFF; \
3511                   PL_statusvalue_vms =          \
3512                     (C_FAC_POSIX | (evalue << 3 ) |     \
3513                     ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3514               } else /* forgive them Perl, for they have sinned */ \
3515                 PL_statusvalue_vms = evalue; \
3516             } else { \
3517               if (evalue == 0)                  \
3518                 PL_statusvalue_vms = SS$_NORMAL;        \
3519               else if (evalue <= 0xFF00) \
3520                 PL_statusvalue_vms = SS$_ABORT; \
3521               else { /* forgive them Perl, for they have sinned */ \
3522                   if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3523                   else PL_statusvalue_vms = vaxc$errno; \
3524                   /* And obviously used a VMS status value instead of UNIX */ \
3525                   PL_statusvalue = EVMSERR;             \
3526               } \
3527               set_vaxc_errno(PL_statusvalue_vms);       \
3528             }                                           \
3529         } STMT_END
3530
3531
3532   /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3533    * and sets the NATIVE error status based on it.  This special case
3534    * is needed to maintain compatibility with past VMS behavior.
3535    *
3536    * In the default mode on VMS, this number is passed through as
3537    * both the NATIVE and UNIX status.  Which makes it different
3538    * that the STATUS_UNIX_EXIT_SET.
3539    *
3540    * In the new POSIX EXIT mode, native status will be set so that the
3541    * actual exit code will can be retrieved by the calling program or
3542    * shell.
3543    *
3544    * A POSIX exit code is from 0 to 255.  If the exit code is higher
3545    * than this, it needs to be assumed that it is a VMS exit code and
3546    * passed through.
3547    */
3548
3549 #   define STATUS_EXIT_SET(n)                           \
3550         STMT_START {                                    \
3551             I32 evalue = (I32)n;                        \
3552             PL_statusvalue = evalue;                    \
3553             if (MY_POSIX_EXIT)                          \
3554                 if (evalue > 255) PL_statusvalue_vms = evalue; else {   \
3555                   PL_statusvalue_vms = \
3556                     (C_FAC_POSIX | (evalue << 3 ) |     \
3557                      ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
3558             else                                        \
3559                 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3560             set_vaxc_errno(PL_statusvalue_vms);         \
3561         } STMT_END
3562
3563
3564  /* This macro forces a success status */
3565 #   define STATUS_ALL_SUCCESS   \
3566         (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
3567
3568  /* This macro forces a failure status */
3569 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, \
3570      vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3571         (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3572
3573 #elif defined(__amigaos4__)
3574  /* A somewhat experimental attempt to simulate posix return code values */
3575 #   define STATUS_NATIVE        PL_statusvalue_posix
3576 #   define STATUS_NATIVE_CHILD_SET(n)                      \
3577         STMT_START {                                       \
3578             PL_statusvalue_posix = (n);                    \
3579             if (PL_statusvalue_posix < 0) {                \
3580                 PL_statusvalue = -1;                       \
3581             }                                              \
3582             else {                                         \
3583                 PL_statusvalue = n << 8;                   \
3584             }                                              \
3585         } STMT_END
3586 #   define STATUS_UNIX_SET(n)           \
3587         STMT_START {                    \
3588             PL_statusvalue = (n);               \
3589             if (PL_statusvalue != -1)   \
3590                 PL_statusvalue &= 0xFFFF;       \
3591         } STMT_END
3592 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3593 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3594 #   define STATUS_CURRENT STATUS_UNIX
3595 #   define STATUS_EXIT STATUS_UNIX
3596 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3597 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3598
3599 #else
3600 #   define STATUS_NATIVE        PL_statusvalue_posix
3601 #   if defined(WCOREDUMP)
3602 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3603             STMT_START {                                   \
3604                 PL_statusvalue_posix = (n);                \
3605                 if (PL_statusvalue_posix == -1)            \
3606                     PL_statusvalue = -1;                   \
3607                 else {                                     \
3608                     PL_statusvalue =                       \
3609                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3610                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3611                         (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0);  \
3612                 }                                          \
3613             } STMT_END
3614 #   elif defined(WIFEXITED)
3615 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3616             STMT_START {                                   \
3617                 PL_statusvalue_posix = (n);                \
3618                 if (PL_statusvalue_posix == -1)            \
3619                     PL_statusvalue = -1;                   \
3620                 else {                                     \
3621                     PL_statusvalue =                       \
3622                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3623                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0);  \
3624                 }                                          \
3625             } STMT_END
3626 #   else
3627 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3628             STMT_START {                                   \
3629                 PL_statusvalue_posix = (n);                \
3630                 if (PL_statusvalue_posix == -1)            \
3631                     PL_statusvalue = -1;                   \
3632                 else {                                     \
3633                     PL_statusvalue =                       \
3634                         PL_statusvalue_posix & 0xFFFF;     \
3635                 }                                          \
3636             } STMT_END
3637 #   endif
3638 #   define STATUS_UNIX_SET(n)           \
3639         STMT_START {                    \
3640             PL_statusvalue = (n);               \
3641             if (PL_statusvalue != -1)   \
3642                 PL_statusvalue &= 0xFFFF;       \
3643         } STMT_END
3644 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3645 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3646 #   define STATUS_CURRENT STATUS_UNIX
3647 #   define STATUS_EXIT STATUS_UNIX
3648 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3649 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3650 #endif
3651
3652 /* flags in PL_exit_flags for nature of exit() */
3653 #define PERL_EXIT_EXPECTED      0x01
3654 #define PERL_EXIT_DESTRUCT_END  0x02  /* Run END in perl_destruct */
3655 #define PERL_EXIT_WARN          0x04  /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3656 #define PERL_EXIT_ABORT         0x08  /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3657
3658 #ifndef PERL_CORE
3659 /* format to use for version numbers in file/directory names */
3660 /* XXX move to Configure? */
3661 /* This was only ever used for the current version, and that can be done at
3662    compile time, as PERL_FS_VERSION, so should we just delete it?  */
3663 #  ifndef PERL_FS_VER_FMT
3664 #    define PERL_FS_VER_FMT     "%d.%d.%d"
3665 #  endif
3666 #endif
3667
3668 #ifndef PERL_FS_VERSION
3669 #  define PERL_FS_VERSION       PERL_VERSION_STRING
3670 #endif
3671
3672 /* This defines a way to flush all output buffers.  This may be a
3673  * performance issue, so we allow people to disable it.  Also, if
3674  * we are using stdio, there are broken implementations of fflush(NULL)
3675  * out there, Solaris being the most prominent.
3676  */
3677 #ifndef PERL_FLUSHALL_FOR_CHILD
3678 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3679 #  define PERL_FLUSHALL_FOR_CHILD       PerlIO_flush((PerlIO*)NULL)
3680 # elif defined(FFLUSH_ALL)
3681 #  define PERL_FLUSHALL_FOR_CHILD       my_fflush_all()
3682 # else
3683 #  define PERL_FLUSHALL_FOR_CHILD       NOOP
3684 # endif
3685 #endif
3686
3687 #ifndef PERL_WAIT_FOR_CHILDREN
3688 #  define PERL_WAIT_FOR_CHILDREN        NOOP
3689 #endif
3690
3691 /* the traditional thread-unsafe notion of "current interpreter". */
3692 #ifndef PERL_SET_INTERP
3693 #  define PERL_SET_INTERP(i)            (PL_curinterp = (PerlInterpreter*)(i))
3694 #endif
3695
3696 #ifndef PERL_GET_INTERP
3697 #  define PERL_GET_INTERP               (PL_curinterp)
3698 #endif
3699
3700 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3701 #  ifdef MULTIPLICITY
3702 #    define PERL_GET_THX                ((PerlInterpreter *)PERL_GET_CONTEXT)
3703 #  endif
3704 #  define PERL_SET_THX(t)               PERL_SET_CONTEXT(t)
3705 #endif
3706
3707 /*
3708     This replaces the previous %_ "hack" by the "%p" hacks.
3709     All that is required is that the perl source does not
3710     use "%-p" or "%-<number>p" or "%<number>p" formats.
3711     These formats will still work in perl code.
3712     See comments in sv.c for further details.
3713
3714     Robin Barker 2005-07-14
3715
3716     No longer use %1p for VDf = %vd.  RMB 2007-10-19
3717 */
3718
3719 #ifndef SVf_
3720 #  define SVf_(n) "-" STRINGIFY(n) "p"
3721 #endif
3722
3723 #ifndef SVf
3724 #  define SVf "-p"
3725 #endif
3726
3727 #ifndef SVf32
3728 #  define SVf32 SVf_(32)
3729 #endif
3730
3731 #ifndef SVf256
3732 #  define SVf256 SVf_(256)
3733 #endif
3734
3735 #define SVfARG(p) ((void*)(p))
3736
3737 #ifndef HEKf
3738 #  define HEKf "2p"
3739 #endif
3740
3741 /* Not ideal, but we cannot easily include a number in an already-numeric
3742  * format sequence. */
3743 #ifndef HEKf256
3744 #  define HEKf256 "3p"
3745 #endif
3746
3747 #define HEKfARG(p) ((void*)(p))
3748
3749 /* Documented in perlguts
3750  *
3751  * %4p is a custom format
3752  */
3753 #ifndef UTF8f
3754 #  define UTF8f "d%" UVuf "%4p"
3755 #endif
3756 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3757
3758 #define PNf UTF8f
3759 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
3760
3761 #ifdef PERL_CORE
3762 /* not used; but needed for backward compatibility with XS code? - RMB */
3763 #  undef UVf
3764 #elif !defined(UVf)
3765 #  define UVf UVuf
3766 #endif
3767
3768 #if !defined(DEBUGGING) && !defined(NDEBUG)
3769 #  define NDEBUG 1
3770 #endif
3771 #include <assert.h>
3772
3773 /* For functions that are marked as __attribute__noreturn__, it's not
3774    appropriate to call return.  In either case, include the lint directive.
3775  */
3776 #ifdef HASATTRIBUTE_NORETURN
3777 #  define NORETURN_FUNCTION_END NOT_REACHED;
3778 #else
3779 #  define NORETURN_FUNCTION_END NOT_REACHED; return 0
3780 #endif
3781
3782 #ifdef HAS_BUILTIN_EXPECT
3783 #  define EXPECT(expr,val)                  __builtin_expect(expr,val)
3784 #else
3785 #  define EXPECT(expr,val)                  (expr)
3786 #endif
3787
3788 /*
3789 =for apidoc_section $directives
3790
3791 =for apidoc Am||LIKELY|bool expr
3792
3793 Returns the input unchanged, but at the same time it gives a branch prediction
3794 hint to the compiler that this condition is likely to be true.
3795
3796 =for apidoc Am||UNLIKELY|bool expr
3797
3798 Returns the input unchanged, but at the same time it gives a branch prediction
3799 hint to the compiler that this condition is likely to be false.
3800
3801 =cut
3802 */
3803 #define LIKELY(cond)                        EXPECT(cBOOL(cond),TRUE)
3804 #define UNLIKELY(cond)                      EXPECT(cBOOL(cond),FALSE)
3805
3806 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3807 /* placeholder */
3808 #endif
3809
3810 /* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
3811    time invariants. That is, their argument must be a constant expression that
3812    can be verified by the compiler. This expression can contain anything that's
3813    known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3814    the expression evaluates to 0, compilation fails.
3815    Because they generate no runtime code (i.e.  their use is "free"), they're
3816    always active, even under non-DEBUGGING builds.
3817    STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
3818    file scope (outside of any function).
3819    STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3820    function.
3821 */
3822 #if (! defined(__IBMC__) || __IBMC__ >= 1210)                               \
3823  && ((   defined(static_assert) && (   defined(_ISOC11_SOURCE)              \
3824                                     || (__STDC_VERSION__ - 0) >= 201101L))  \
3825      || (defined(__cplusplus) && __cplusplus >= 201103L))
3826 /* XXX static_assert is a macro defined in <assert.h> in C11 or a compiler
3827    builtin in C++11.  But IBM XL C V11 does not support _Static_assert, no
3828    matter what <assert.h> says.
3829 */
3830 #  define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
3831 #else
3832 /* We use a bit-field instead of an array because gcc accepts
3833    'typedef char x[n]' where n is not a compile-time constant.
3834    We want to enforce constantness.
3835 */
3836 #  define STATIC_ASSERT_2(COND, SUFFIX) \
3837     typedef struct { \
3838         unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3839     } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3840 #  define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
3841 #  define STATIC_ASSERT_DECL(COND)    STATIC_ASSERT_1(COND, __LINE__)
3842 #endif
3843 /* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3844    error (static_assert is a declaration, and only statements can have labels).
3845 */
3846 #define STATIC_ASSERT_STMT(COND)      STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
3847
3848 #ifndef __has_builtin
3849 #  define __has_builtin(x) 0 /* not a clang style compiler */
3850 #endif
3851
3852 /*
3853 =for apidoc Am||ASSUME|bool expr
3854 C<ASSUME> is like C<assert()>, but it has a benefit in a release build. It is a
3855 hint to a compiler about a statement of fact in a function call free
3856 expression, which allows the compiler to generate better machine code.  In a
3857 debug build, C<ASSUME(x)> is a synonym for C<assert(x)>. C<ASSUME(0)> means the
3858 control path is unreachable. In a for loop, C<ASSUME> can be used to hint that
3859 a loop will run at least X times. C<ASSUME> is based off MSVC's C<__assume>
3860 intrinsic function, see its documents for more details.
3861
3862 =cut
3863 */
3864
3865 #ifdef DEBUGGING
3866 #  define ASSUME(x) assert(x)
3867 #  if __has_builtin(__builtin_unreachable)
3868 #    define HAS_BUILTIN_UNREACHABLE
3869 #  elif (defined(__GNUC__) && (   __GNUC__ > 4                              \
3870                                || __GNUC__ == 4 && __GNUC_MINOR__ >= 5))
3871 #    define HAS_BUILTIN_UNREACHABLE
3872 #  endif
3873 #endif
3874
3875 #if defined(__sun) || (defined(__hpux) && !defined(__GNUC__))
3876 #  ifndef ASSUME
3877 #    define ASSUME(x)      /* ASSUME() generates warnings on Solaris */
3878 #  endif
3879 #  define NOT_REACHED
3880 #elif defined(HAS_BUILTIN_UNREACHABLE)
3881 #  ifndef ASSUME
3882 #    define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3883 #  endif
3884 #  define NOT_REACHED                                                       \
3885         STMT_START {                                                        \
3886             ASSUME(!"UNREACHABLE"); __builtin_unreachable();                \
3887         } STMT_END
3888 #else
3889 #  if defined(_MSC_VER)
3890 #    define ASSUME(x) __assume(x)
3891 #  elif defined(__ARMCC_VERSION) /* untested */
3892 #    define ASSUME(x) __promise(x)
3893 #  else
3894     /* a random compiler might define assert to its own special optimization
3895      * token so pass it through to C lib as a last resort */
3896 #    define ASSUME(x) assert(x)
3897 #  endif
3898 #  define NOT_REACHED ASSUME(!"UNREACHABLE")
3899 #endif
3900 #undef HAS_BUILTIN_UNREACHABLE
3901
3902 /* Some unistd.h's give a prototype for pause() even though
3903    HAS_PAUSE ends up undefined.  This causes the #define
3904    below to be rejected by the compiler.  Sigh.
3905 */
3906 #ifdef HAS_PAUSE
3907 #define Pause   pause
3908 #else
3909 #define Pause() sleep((32767<<16)+32767)
3910 #endif
3911
3912 #ifndef IOCPARM_LEN
3913 #   ifdef IOCPARM_MASK
3914         /* on BSDish systems we're safe */
3915 #       define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
3916 #   elif defined(_IOC_SIZE) && defined(__GLIBC__)
3917         /* on Linux systems we're safe; except when we're not [perl #38223] */
3918 #       define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3919 #   else
3920         /* otherwise guess at what's safe */
3921 #       define IOCPARM_LEN(x)   256
3922 #   endif
3923 #endif
3924
3925 #if defined(__CYGWIN__)
3926 /* USEMYBINMODE
3927  *   This symbol, if defined, indicates that the program should
3928  *   use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3929  *   that a file is in "binary" mode -- that is, that no translation
3930  *   of bytes occurs on read or write operations.
3931  */
3932 #  define USEMYBINMODE /**/
3933 #  include <io.h> /* for setmode() prototype */
3934 #  define my_binmode(fp, iotype, mode) \
3935             cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
3936 #endif
3937
3938 #ifdef __CYGWIN__
3939 void init_os_extras(void);
3940 #endif
3941
3942 #ifdef UNION_ANY_DEFINITION
3943 UNION_ANY_DEFINITION;
3944 #else
3945 union any {
3946     void*       any_ptr;
3947     SV*         any_sv;
3948     SV**        any_svp;
3949     GV*         any_gv;
3950     AV*         any_av;
3951     HV*         any_hv;
3952     OP*         any_op;
3953     char*       any_pv;
3954     char**      any_pvp;
3955     I32         any_i32;
3956     U32         any_u32;
3957     IV          any_iv;
3958     UV          any_uv;
3959     long        any_long;
3960     bool        any_bool;
3961     void        (*any_dptr) (void*);
3962     void        (*any_dxptr) (pTHX_ void*);
3963 };
3964 #endif
3965
3966 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3967
3968 #define FILTER_READ(idx, sv, len)  filter_read(idx, sv, len)
3969 #define FILTER_DATA(idx) \
3970             (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3971 #define FILTER_ISREADER(idx) \
3972             (PL_parser && PL_parser->rsfp_filters \
3973                 && idx >= AvFILLp(PL_parser->rsfp_filters))
3974 #define PERL_FILTER_EXISTS(i) \
3975             (PL_parser && PL_parser->rsfp_filters \
3976                 && (Size_t) (i) < av_count(PL_parser->rsfp_filters))
3977
3978 #if defined(_AIX) && !defined(_AIX43)
3979 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3980 /* We cannot include <crypt.h> to get the struct crypt_data
3981  * because of setkey prototype problems when threading */
3982 typedef        struct crypt_data {     /* straight from /usr/include/crypt.h */
3983     /* From OSF, Not needed in AIX
3984        char C[28], D[28];
3985     */
3986     char E[48];
3987     char KS[16][48];
3988     char block[66];
3989     char iobuf[16];
3990 } CRYPTD;
3991 #endif /* threading */
3992 #endif /* AIX */
3993
3994 #ifndef PERL_CALLCONV
3995 #  ifdef __cplusplus
3996 #    define PERL_CALLCONV  EXTERN_C
3997 #  else
3998 #    define PERL_CALLCONV
3999 #  endif
4000 #endif
4001 #ifndef PERL_CALLCONV_NO_RET
4002 #    define PERL_CALLCONV_NO_RET PERL_CALLCONV
4003 #endif
4004
4005 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
4006    dont have a noreturn as a declaration specifier
4007 */
4008 #ifndef PERL_STATIC_NO_RET
4009 #  define PERL_STATIC_NO_RET STATIC
4010 #endif
4011
4012 /* PERL_STATIC_INLINE_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE
4013  * on builds that dont have a noreturn as a declaration specifier
4014 */
4015 #ifndef PERL_STATIC_INLINE_NO_RET
4016 #  define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
4017 #endif
4018
4019 #ifndef PERL_STATIC_FORCE_INLINE
4020 #  define PERL_STATIC_FORCE_INLINE PERL_STATIC_INLINE
4021 #endif
4022
4023 #ifndef PERL_STATIC_FORCE_INLINE_NO_RET
4024 #  define PERL_STATIC_FORCE_INLINE_NO_RET PERL_STATIC_INLINE
4025 #endif
4026
4027 #if !defined(OS2)
4028 #  include "iperlsys.h"
4029 #endif
4030
4031 #ifdef __LIBCATAMOUNT__
4032 #undef HAS_PASSWD  /* unixish.h but not unixish enough. */
4033 #undef HAS_GROUP
4034 #define FAKE_BIT_BUCKET
4035 #endif
4036
4037 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
4038  * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
4039  * Configure, despite their names being similar to other defines like
4040  * USE_ITHREADS.  Configure in fact knows nothing about the randomised
4041  * hashes.  Therefore to enable/disable the hash randomisation defines
4042  * use the Configure -Accflags=... instead. */
4043 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
4044 #  define USE_HASH_SEED
4045 #endif
4046
4047 #include "perly.h"
4048
4049
4050 /* macros to define bit-fields in structs. */
4051 #ifndef PERL_BITFIELD8
4052 #  define PERL_BITFIELD8 U8
4053 #endif
4054 #ifndef PERL_BITFIELD16
4055 #  define PERL_BITFIELD16 U16
4056 #endif
4057 #ifndef PERL_BITFIELD32
4058 #  define PERL_BITFIELD32 U32
4059 #endif
4060
4061 #include "sv.h"
4062 #include "regexp.h"
4063 #include "util.h"
4064 #include "form.h"
4065 #include "gv.h"
4066 #include "pad.h"
4067 #include "cv.h"
4068 #include "opnames.h"
4069 #include "op.h"
4070 #include "hv.h"
4071 #include "cop.h"
4072 #include "av.h"
4073 #include "mg.h"
4074 #include "scope.h"
4075 #include "warnings.h"
4076 #include "utf8.h"
4077
4078 /* these would be in doio.h if there was such a file */
4079 #define my_stat()  my_stat_flags(SV_GMAGIC)
4080 #define my_lstat() my_lstat_flags(SV_GMAGIC)
4081
4082 /* defined in sv.c, but also used in [ach]v.c */
4083 #undef _XPV_HEAD
4084 #undef _XPVMG_HEAD
4085 #undef _XPVCV_COMMON
4086
4087 #include "parser.h"
4088
4089 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
4090
4091 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C) \
4092  || defined(PERL_EXT_RE_BUILD)
4093
4094 /* These have to be predeclared, as they are used in proto.h which is #included
4095  * before their definitions in regcomp.h. */
4096
4097 struct scan_data_t;
4098 typedef struct regnode_charclass regnode_charclass;
4099
4100 /* A hopefully less confusing name.  The sub-classes are all Posix classes only
4101  * used under /l matching */
4102 typedef struct regnode_charclass_posixl regnode_charclass_class;
4103 typedef struct regnode_charclass_posixl regnode_charclass_posixl;
4104
4105 typedef struct regnode_ssc regnode_ssc;
4106 typedef struct RExC_state_t RExC_state_t;
4107 struct _reg_trie_data;
4108
4109 #endif
4110
4111 struct ptr_tbl_ent {
4112     struct ptr_tbl_ent*         next;
4113     const void*                 oldval;
4114     void*                       newval;
4115 };
4116
4117 struct ptr_tbl {
4118     struct ptr_tbl_ent**        tbl_ary;
4119     UV                          tbl_max;
4120     UV                          tbl_items;
4121     struct ptr_tbl_arena        *tbl_arena;
4122     struct ptr_tbl_ent          *tbl_arena_next;
4123     struct ptr_tbl_ent          *tbl_arena_end;
4124 };
4125
4126 #if defined(htonl) && !defined(HAS_HTONL)
4127 #define HAS_HTONL
4128 #endif
4129 #if defined(htons) && !defined(HAS_HTONS)
4130 #define HAS_HTONS
4131 #endif
4132 #if defined(ntohl) && !defined(HAS_NTOHL)
4133 #define HAS_NTOHL
4134 #endif
4135 #if defined(ntohs) && !defined(HAS_NTOHS)
4136 #define HAS_NTOHS
4137 #endif
4138 #ifndef HAS_HTONL
4139 #define HAS_HTONS
4140 #define HAS_HTONL
4141 #define HAS_NTOHS
4142 #define HAS_NTOHL
4143 #  if (BYTEORDER & 0xffff) == 0x4321
4144 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
4145    re-order their values. However, to behave identically to the alternative
4146    implementations, they should truncate to the correct size.  */
4147 #    define ntohl(x)    ((x)&0xFFFFFFFF)
4148 #    define htonl(x)    ntohl(x)
4149 #    define ntohs(x)    ((x)&0xFFFF)
4150 #    define htons(x)    ntohs(x)
4151 #  elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
4152
4153 /* Note that we can't straight out declare our own htonl and htons because
4154    the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
4155    to avoid the overhead of initialising the socket subsystem, but the headers
4156    that *declare* the various functions are still seen. If we declare our own
4157    htonl etc they will clash with the declarations in the Win32 headers.  */
4158
4159 PERL_STATIC_INLINE U32
4160 my_swap32(const U32 x) {
4161     return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)      
4162         | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
4163 }
4164
4165 PERL_STATIC_INLINE U16
4166 my_swap16(const U16 x) {
4167     return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
4168 }
4169
4170 #    define htonl(x)    my_swap32(x)
4171 #    define ntohl(x)    my_swap32(x)
4172 #    define ntohs(x)    my_swap16(x)
4173 #    define htons(x)    my_swap16(x)
4174 #  else
4175 #    error "Unsupported byteorder"
4176 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
4177    the error message. Please check the value of the macro BYTEORDER, as defined
4178    in config.h. The values of BYTEORDER we expect are
4179
4180             big endian  little endian
4181    32 bit       0x4321  0x1234
4182    64 bit   0x87654321  0x12345678
4183
4184    If you have a system with a different byte order, please see
4185    pod/perlhack.pod for how to submit a patch to add supporting code.
4186 */
4187 #  endif
4188 #endif
4189
4190 /*
4191  * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
4192  * -DWS
4193  */
4194 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
4195 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
4196    re-order their values. However, to behave identically to the alternative
4197    implementations, they should truncate to the correct size.  */
4198 #  define vtohl(x)      ((x)&0xFFFFFFFF)
4199 #  define vtohs(x)      ((x)&0xFFFF)
4200 #  define htovl(x)      vtohl(x)
4201 #  define htovs(x)      vtohs(x)
4202 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
4203 #  define vtohl(x)      ((((x)&0xFF)<<24)       \
4204                         +(((x)>>24)&0xFF)       \
4205                         +(((x)&0x0000FF00)<<8)  \
4206                         +(((x)&0x00FF0000)>>8)  )
4207 #  define vtohs(x)      ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
4208 #  define htovl(x)      vtohl(x)
4209 #  define htovs(x)      vtohs(x)
4210 #else
4211 #  error "Unsupported byteorder"
4212 /* If you have need for current perl on PDP-11 or similar, and can help test
4213    that blead keeps working on a mixed-endian system, then see
4214    pod/perlhack.pod for how to submit patches to things working again.  */
4215 #endif
4216
4217 /* *MAX Plus 1. A floating point value.
4218    Hopefully expressed in a way that dodgy floating point can't mess up.
4219    >> 2 rather than 1, so that value is safely less than I32_MAX after 1
4220    is added to it
4221    May find that some broken compiler will want the value cast to I32.
4222    [after the shift, as signed >> may not be as secure as unsigned >>]
4223 */
4224 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
4225 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
4226 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
4227    0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
4228    may be greater than sizeof(IV), so don't assume that half max UV is max IV.
4229 */
4230 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
4231
4232 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
4233 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
4234 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
4235
4236 /* This may look like unnecessary jumping through hoops, but converting
4237    out of range floating point values to integers *is* undefined behaviour,
4238    and it is starting to bite.
4239
4240 =for apidoc_section $casting
4241 =for apidoc Am|I32|I_32|NV what
4242 Cast an NV to I32 while avoiding undefined C behavior
4243
4244 =for apidoc Am|U32|U_32|NV what
4245 Cast an NV to U32 while avoiding undefined C behavior
4246
4247 =for apidoc Am|IV|I_V|NV what
4248 Cast an NV to IV while avoiding undefined C behavior
4249
4250 =for apidoc Am|UV|U_V|NV what
4251 Cast an NV to UV while avoiding undefined C behavior
4252
4253 =cut
4254 */
4255 #ifndef CAST_INLINE
4256 #define I_32(what) (cast_i32((NV)(what)))
4257 #define U_32(what) (cast_ulong((NV)(what)))
4258 #define I_V(what) (cast_iv((NV)(what)))
4259 #define U_V(what) (cast_uv((NV)(what)))
4260 #else
4261 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
4262                   : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
4263                      : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
4264 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
4265                   : ((n) < U32_MAX_P1 ? (U32) (n) \
4266                      : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
4267 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
4268                   : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
4269                      : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
4270 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
4271                   : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
4272                      : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
4273 #endif
4274
4275 #define U_S(what) ((U16)U_32(what))
4276 #define U_I(what) ((unsigned int)U_32(what))
4277 #define U_L(what) U_32(what)
4278
4279 /*
4280 =for apidoc_section $integer
4281 =for apidoc Amn|IV|IV_MAX
4282 The largest signed integer that fits in an IV on this platform.
4283
4284 =for apidoc Amn|IV|IV_MIN
4285 The negative signed integer furthest away from 0 that fits in an IV on this
4286 platform.
4287
4288 =for apidoc Amn|UV|UV_MAX
4289 The largest unsigned integer that fits in a UV on this platform.
4290
4291 =for apidoc Amn|UV|UV_MIN
4292 The smallest unsigned integer that fits in a UV on this platform.  It should
4293 equal zero.
4294
4295 =cut
4296 */
4297
4298 #ifdef HAS_SIGNBIT
4299 #  ifndef Perl_signbit
4300 #    define Perl_signbit signbit
4301 #  endif
4302 #endif
4303
4304 /* These do not care about the fractional part, only about the range. */
4305 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
4306 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
4307
4308 /* Used with UV/IV arguments: */
4309                                         /* XXXX: need to speed it up */
4310 #define CLUMP_2UV(iv)   ((iv) < 0 ? 0 : (UV)(iv))
4311 #define CLUMP_2IV(uv)   ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
4312
4313 #ifndef MAXSYSFD
4314 #   define MAXSYSFD 2
4315 #endif
4316
4317 #ifndef __cplusplus
4318 #if !defined(WIN32)
4319 Uid_t getuid (void);
4320 Uid_t geteuid (void);
4321 Gid_t getgid (void);
4322 Gid_t getegid (void);
4323 #endif
4324 #endif
4325
4326 #ifndef Perl_debug_log
4327 #  define Perl_debug_log        PerlIO_stderr()
4328 #endif
4329
4330 #ifndef Perl_error_log
4331 #  define Perl_error_log        (PL_stderrgv                    \
4332                                  && isGV(PL_stderrgv)           \
4333                                  && GvIOp(PL_stderrgv)          \
4334                                  && IoOFP(GvIOp(PL_stderrgv))   \
4335                                  ? IoOFP(GvIOp(PL_stderrgv))    \
4336                                  : PerlIO_stderr())
4337 #endif
4338
4339
4340 #define DEBUG_p_FLAG            0x00000001 /*      1 */
4341 #define DEBUG_s_FLAG            0x00000002 /*      2 */
4342 #define DEBUG_l_FLAG            0x00000004 /*      4 */
4343 #define DEBUG_t_FLAG            0x00000008 /*      8 */
4344 #define DEBUG_o_FLAG            0x00000010 /*     16 */
4345 #define DEBUG_c_FLAG            0x00000020 /*     32 */
4346 #define DEBUG_P_FLAG            0x00000040 /*     64 */
4347 #define DEBUG_m_FLAG            0x00000080 /*    128 */
4348 #define DEBUG_f_FLAG            0x00000100 /*    256 */
4349 #define DEBUG_r_FLAG            0x00000200 /*    512 */
4350 #define DEBUG_x_FLAG            0x00000400 /*   1024 */
4351 #define DEBUG_u_FLAG            0x00000800 /*   2048 */
4352 /* U is reserved for Unofficial, exploratory hacking */
4353 #define DEBUG_U_FLAG            0x00001000 /*   4096 */
4354 /* spare                                        8192 */
4355 #define DEBUG_X_FLAG            0x00004000 /*  16384 */
4356 #define DEBUG_D_FLAG            0x00008000 /*  32768 */
4357 #define DEBUG_S_FLAG            0x00010000 /*  65536 */
4358 #define DEBUG_T_FLAG            0x00020000 /* 131072 */
4359 #define DEBUG_R_FLAG            0x00040000 /* 262144 */
4360 #define DEBUG_J_FLAG            0x00080000 /* 524288 */
4361 #define DEBUG_v_FLAG            0x00100000 /*1048576 */
4362 #define DEBUG_C_FLAG            0x00200000 /*2097152 */
4363 #define DEBUG_A_FLAG            0x00400000 /*4194304 */
4364 #define DEBUG_q_FLAG            0x00800000 /*8388608 */
4365 #define DEBUG_M_FLAG            0x01000000 /*16777216*/
4366 #define DEBUG_B_FLAG            0x02000000 /*33554432*/
4367 #define DEBUG_L_FLAG            0x04000000 /*67108864*/
4368 #define DEBUG_i_FLAG            0x08000000 /*134217728*/
4369 #define DEBUG_y_FLAG            0x10000000 /*268435456*/
4370 #define DEBUG_MASK              0x1FFFEFFF /* mask of all the standard flags */
4371
4372 #define DEBUG_DB_RECURSE_FLAG   0x40000000
4373 #define DEBUG_TOP_FLAG          0x80000000 /* -D was given --> PL_debug |= FLAG */
4374
4375 #  define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
4376 #  define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
4377 #  define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
4378 #  define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
4379 #  define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
4380 #  define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
4381 #  define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
4382 #  define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
4383 #  define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
4384 #  define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
4385 #  define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
4386 #  define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
4387 #  define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
4388 #  define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
4389 #  define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
4390 #  define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
4391 #  define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
4392 #  define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
4393 #  define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
4394 #  define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
4395 #  define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
4396 #  define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
4397 #  define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
4398 #  define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
4399 #  define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
4400 #  define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
4401 #  define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
4402 #  define DEBUG_y_TEST_ UNLIKELY(PL_debug & DEBUG_y_FLAG)
4403 #  define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
4404 #  define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
4405 #  define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
4406 #  define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
4407 #  define DEBUG_yv_TEST_ (DEBUG_y_TEST_ && DEBUG_v_TEST_)
4408
4409 #ifdef DEBUGGING
4410
4411 #  define DEBUG_p_TEST DEBUG_p_TEST_
4412 #  define DEBUG_s_TEST DEBUG_s_TEST_
4413 #  define DEBUG_l_TEST DEBUG_l_TEST_
4414 #  define DEBUG_t_TEST DEBUG_t_TEST_
4415 #  define DEBUG_o_TEST DEBUG_o_TEST_
4416 #  define DEBUG_c_TEST DEBUG_c_TEST_
4417 #  define DEBUG_P_TEST DEBUG_P_TEST_
4418 #  define DEBUG_m_TEST DEBUG_m_TEST_
4419 #  define DEBUG_f_TEST DEBUG_f_TEST_
4420 #  define DEBUG_r_TEST DEBUG_r_TEST_
4421 #  define DEBUG_x_TEST DEBUG_x_TEST_
4422 #  define DEBUG_u_TEST DEBUG_u_TEST_
4423 #  define DEBUG_U_TEST DEBUG_U_TEST_
4424 #  define DEBUG_X_TEST DEBUG_X_TEST_
4425 #  define DEBUG_D_TEST DEBUG_D_TEST_
4426 #  define DEBUG_S_TEST DEBUG_S_TEST_
4427 #  define DEBUG_T_TEST DEBUG_T_TEST_
4428 #  define DEBUG_R_TEST DEBUG_R_TEST_
4429 #  define DEBUG_J_TEST DEBUG_J_TEST_
4430 #  define DEBUG_v_TEST DEBUG_v_TEST_
4431 #  define DEBUG_C_TEST DEBUG_C_TEST_
4432 #  define DEBUG_A_TEST DEBUG_A_TEST_
4433 #  define DEBUG_q_TEST DEBUG_q_TEST_
4434 #  define DEBUG_M_TEST DEBUG_M_TEST_
4435 #  define DEBUG_B_TEST DEBUG_B_TEST_
4436 #  define DEBUG_L_TEST DEBUG_L_TEST_
4437 #  define DEBUG_i_TEST DEBUG_i_TEST_
4438 #  define DEBUG_y_TEST DEBUG_y_TEST_
4439 #  define DEBUG_Xv_TEST DEBUG_Xv_TEST_
4440 #  define DEBUG_Uv_TEST DEBUG_Uv_TEST_
4441 #  define DEBUG_Pv_TEST DEBUG_Pv_TEST_
4442 #  define DEBUG_Lv_TEST DEBUG_Lv_TEST_
4443 #  define DEBUG_yv_TEST DEBUG_yv_TEST_
4444
4445 #  define PERL_DEB(a)                  a
4446 #  define PERL_DEB2(a,b)               a
4447 #  define PERL_DEBUG(a) if (PL_debug)  a
4448 #  define DEBUG_p(a) if (DEBUG_p_TEST) a
4449 #  define DEBUG_s(a) if (DEBUG_s_TEST) a
4450 #  define DEBUG_l(a) if (DEBUG_l_TEST) a
4451 #  define DEBUG_t(a) if (DEBUG_t_TEST) a
4452 #  define DEBUG_o(a) if (DEBUG_o_TEST) a
4453 #  define DEBUG_c(a) if (DEBUG_c_TEST) a
4454 #  define DEBUG_P(a) if (DEBUG_P_TEST) a
4455
4456      /* Temporarily turn off memory debugging in case the a
4457       * does memory allocation, either directly or indirectly. */
4458 #  define DEBUG_m(a)  \
4459     STMT_START {                                                        \
4460         if (PERL_GET_INTERP) {                                          \
4461                                 dTHX;                                   \
4462                                 if (DEBUG_m_TEST) {                     \
4463                                     PL_debug &= ~DEBUG_m_FLAG;          \
4464                                     a;                                  \
4465                                     PL_debug |= DEBUG_m_FLAG;           \
4466                                 }                                       \
4467                               }                                         \
4468     } STMT_END
4469
4470 #  define DEBUG__(t, a)                                                 \
4471         STMT_START {                                                    \
4472                 if (t) STMT_START {a;} STMT_END;                        \
4473         } STMT_END
4474
4475 #  define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
4476
4477 /* For re_comp.c, re_exec.c, assume -Dr has been specified */
4478 #  ifdef PERL_EXT_RE_BUILD
4479 #    define DEBUG_r(a) STMT_START {a;} STMT_END
4480 #  else
4481 #    define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
4482 #  endif /* PERL_EXT_RE_BUILD */
4483
4484 #  define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
4485 #  define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
4486 #  define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
4487 #  define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
4488 #  define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
4489 #  define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
4490 #  define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
4491 #  define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
4492 #  define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
4493 #  define DEBUG_yv(a) DEBUG__(DEBUG_yv_TEST, a)
4494
4495 #  define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
4496 #  define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
4497 #  define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
4498 #  define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
4499 #  define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
4500 #  define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
4501 #  define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
4502 #  define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
4503 #  define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
4504 #  define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
4505 #  define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
4506 #  define DEBUG_y(a) DEBUG__(DEBUG_y_TEST, a)
4507
4508 #else /* ! DEBUGGING below */
4509
4510 #  define DEBUG_p_TEST (0)
4511 #  define DEBUG_s_TEST (0)
4512 #  define DEBUG_l_TEST (0)
4513 #  define DEBUG_t_TEST (0)
4514 #  define DEBUG_o_TEST (0)
4515 #  define DEBUG_c_TEST (0)
4516 #  define DEBUG_P_TEST (0)
4517 #  define DEBUG_m_TEST (0)
4518 #  define DEBUG_f_TEST (0)
4519 #  define DEBUG_r_TEST (0)
4520 #  define DEBUG_x_TEST (0)
4521 #  define DEBUG_u_TEST (0)
4522 #  define DEBUG_U_TEST (0)
4523 #  define DEBUG_X_TEST (0)
4524 #  define DEBUG_D_TEST (0)
4525 #  define DEBUG_S_TEST (0)
4526 #  define DEBUG_T_TEST (0)
4527 #  define DEBUG_R_TEST (0)
4528 #  define DEBUG_J_TEST (0)
4529 #  define DEBUG_v_TEST (0)
4530 #  define DEBUG_C_TEST (0)
4531 #  define DEBUG_A_TEST (0)
4532 #  define DEBUG_q_TEST (0)
4533 #  define DEBUG_M_TEST (0)
4534 #  define DEBUG_B_TEST (0)
4535 #  define DEBUG_L_TEST (0)
4536 #  define DEBUG_i_TEST (0)
4537 #  define DEBUG_y_TEST (0)
4538 #  define DEBUG_Xv_TEST (0)
4539 #  define DEBUG_Uv_TEST (0)
4540 #  define DEBUG_Pv_TEST (0)
4541 #  define DEBUG_Lv_TEST (0)
4542 #  define DEBUG_yv_TEST (0)
4543
4544 #  define PERL_DEB(a)
4545 #  define PERL_DEB2(a,b)               b
4546 #  define PERL_DEBUG(a)
4547 #  define DEBUG_p(a)
4548 #  define DEBUG_s(a)
4549 #  define DEBUG_l(a)
4550 #  define DEBUG_t(a)
4551 #  define DEBUG_o(a)
4552 #  define DEBUG_c(a)
4553 #  define DEBUG_P(a)
4554 #  define DEBUG_m(a)
4555 #  define DEBUG_f(a)
4556 #  define DEBUG_r(a)
4557 #  define DEBUG_x(a)
4558 #  define DEBUG_u(a)
4559 #  define DEBUG_U(a)
4560 #  define DEBUG_X(a)
4561 #  define DEBUG_D(a)
4562 #  define DEBUG_S(a)
4563 #  define DEBUG_T(a)
4564 #  define DEBUG_R(a)
4565 #  define DEBUG_v(a)
4566 #  define DEBUG_C(a)
4567 #  define DEBUG_A(a)
4568 #  define DEBUG_q(a)
4569 #  define DEBUG_M(a)
4570 #  define DEBUG_B(a)
4571 #  define DEBUG_L(a)
4572 #  define DEBUG_i(a)
4573 #  define DEBUG_y(a)
4574 #  define DEBUG_Xv(a)
4575 #  define DEBUG_Uv(a)
4576 #  define DEBUG_Pv(a)
4577 #  define DEBUG_Lv(a)
4578 #  define DEBUG_yv(a)
4579 #endif /* DEBUGGING */
4580
4581
4582 #define DEBUG_SCOPE(where) \
4583     DEBUG_l( \
4584     Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n",   \
4585                     where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
4586                     __FILE__, __LINE__));
4587
4588 /* Keep the old croak based assert for those who want it, and as a fallback if
4589    the platform is so heretically non-ANSI that it can't assert.  */
4590
4591 #define Perl_assert(what)       PERL_DEB2(                              \
4592         ((what) ? ((void) 0) :                                          \
4593             (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
4594                         "\", line %d", STRINGIFY(what), __LINE__),      \
4595              (void) 0)), ((void)0))
4596
4597 /* assert() gets defined if DEBUGGING.
4598  * If no DEBUGGING, the <assert.h> has not been included. */
4599 #ifndef assert
4600 #  define assert(what)  Perl_assert(what)
4601 #endif
4602 #ifdef DEBUGGING
4603 #  define assert_(what) assert(what),
4604 #else
4605 #  define assert_(what)
4606 #endif
4607
4608 struct ufuncs {
4609     I32 (*uf_val)(pTHX_ IV, SV*);
4610     I32 (*uf_set)(pTHX_ IV, SV*);
4611     IV uf_index;
4612 };
4613
4614 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4615  * XS code wanting to be backward compatible can do something
4616  * like the following:
4617
4618 #ifndef PERL_MG_UFUNC
4619 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4620 #endif
4621
4622 static PERL_MG_UFUNC(foo_get, index, val)
4623 {
4624     sv_setsv(val, ...);
4625     return TRUE;
4626 }
4627
4628 -- Doug MacEachern
4629
4630 */
4631
4632 #ifndef PERL_MG_UFUNC
4633 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4634 #endif
4635
4636 #include <math.h>
4637 #ifdef __VMS
4638      /* isfinite and others are here rather than in math.h as C99 stipulates */
4639 #    include <fp.h>
4640 #endif
4641
4642 #ifndef __cplusplus
4643 #  if !defined(WIN32) && !defined(VMS)
4644 #ifndef crypt
4645 char *crypt (const char*, const char*);
4646 #endif
4647 #  endif /* !WIN32 */
4648 #  ifndef WIN32
4649 #    ifndef getlogin
4650 char *getlogin (void);
4651 #    endif
4652 #  endif /* !WIN32 */
4653 #endif /* !__cplusplus */
4654
4655 /* Fixme on VMS.  This needs to be a run-time, not build time options */
4656 /* Also rename() is affected by this */
4657 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4658 #define UNLINK unlnk
4659 I32 unlnk (pTHX_ const char*);
4660 #else
4661 #define UNLINK PerlLIO_unlink
4662 #endif
4663
4664 /* some versions of glibc are missing the setresuid() proto */
4665 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4666 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4667 #endif
4668 /* some versions of glibc are missing the setresgid() proto */
4669 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4670 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4671 #endif
4672
4673 #ifndef HAS_SETREUID
4674 #  ifdef HAS_SETRESUID
4675 #    define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4676 #    define HAS_SETREUID
4677 #  endif
4678 #endif
4679 #ifndef HAS_SETREGID
4680 #  ifdef HAS_SETRESGID
4681 #    define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4682 #    define HAS_SETREGID
4683 #  endif
4684 #endif
4685
4686 /* Sighandler_t defined in iperlsys.h */
4687
4688 #ifdef HAS_SIGACTION
4689 typedef struct sigaction Sigsave_t;
4690 #else
4691 typedef Sighandler_t Sigsave_t;
4692 #endif
4693
4694 #define SCAN_DEF 0
4695 #define SCAN_TR 1
4696 #define SCAN_REPL 2
4697
4698 #ifdef DEBUGGING
4699 # ifndef register
4700 #  define register
4701 # endif
4702 # define RUNOPS_DEFAULT Perl_runops_debug
4703 #else
4704 # define RUNOPS_DEFAULT Perl_runops_standard
4705 #endif
4706
4707 #if defined(USE_PERLIO)
4708 EXTERN_C void PerlIO_teardown(void);
4709 # ifdef USE_ITHREADS
4710 #  define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4711 #  define PERLIO_TERM                           \
4712         STMT_START {                            \
4713                 PerlIO_teardown();              \
4714                 MUTEX_DESTROY(&PL_perlio_mutex);\
4715         } STMT_END
4716 # else
4717 #  define PERLIO_INIT
4718 #  define PERLIO_TERM   PerlIO_teardown()
4719 # endif
4720 #else
4721 #  define PERLIO_INIT
4722 #  define PERLIO_TERM
4723 #endif
4724
4725 #ifdef MYMALLOC
4726 #  ifdef MUTEX_INIT_CALLS_MALLOC
4727 #    define MALLOC_INIT                                 \
4728         STMT_START {                                    \
4729                 PL_malloc_mutex = NULL;                 \
4730                 MUTEX_INIT(&PL_malloc_mutex);           \
4731         } STMT_END
4732 #    define MALLOC_TERM                                 \
4733         STMT_START {                                    \
4734                 perl_mutex tmp = PL_malloc_mutex;       \
4735                 PL_malloc_mutex = NULL;                 \
4736                 MUTEX_DESTROY(&tmp);                    \
4737         } STMT_END
4738 #  else
4739 #    define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4740 #    define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4741 #  endif
4742 #else
4743 #  define MALLOC_INIT
4744 #  define MALLOC_TERM
4745 #endif
4746
4747 #if defined(PERL_IMPLICIT_CONTEXT)
4748
4749 struct perl_memory_debug_header;
4750 struct perl_memory_debug_header {
4751   tTHX  interpreter;
4752 #  if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4753   MEM_SIZE size;
4754 #  endif
4755   struct perl_memory_debug_header *prev;
4756   struct perl_memory_debug_header *next;
4757 #  ifdef PERL_DEBUG_READONLY_COW
4758   bool readonly;
4759 #  endif
4760 };
4761
4762 #elif defined(PERL_DEBUG_READONLY_COW)
4763
4764 struct perl_memory_debug_header;
4765 struct perl_memory_debug_header {
4766   MEM_SIZE size;
4767 };
4768
4769 #endif
4770
4771 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4772
4773 #  define PERL_MEMORY_DEBUG_HEADER_SIZE \
4774         (sizeof(struct perl_memory_debug_header) + \
4775         (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4776          %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4777
4778 #else
4779 #  define PERL_MEMORY_DEBUG_HEADER_SIZE 0
4780 #endif
4781
4782 #ifdef PERL_TRACK_MEMPOOL
4783 # ifdef PERL_DEBUG_READONLY_COW
4784 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4785         STMT_START {                                            \
4786                 (header).interpreter = (interp);                \
4787                 (header).prev = (header).next = &(header);      \
4788                 (header).readonly = 0;                          \
4789         } STMT_END
4790 # else
4791 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4792         STMT_START {                                            \
4793                 (header).interpreter = (interp);                \
4794                 (header).prev = (header).next = &(header);      \
4795         } STMT_END
4796 # endif
4797 # else
4798 #  define INIT_TRACK_MEMPOOL(header, interp)
4799 #endif
4800
4801 #ifdef I_MALLOCMALLOC
4802 /* Needed for malloc_size(), malloc_good_size() on some systems */
4803 #  include <malloc/malloc.h>
4804 #endif
4805
4806 #ifdef MYMALLOC
4807 #  define Perl_safesysmalloc_size(where)        Perl_malloced_size(where)
4808 #else
4809 #  if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4810 #    ifdef PERL_TRACK_MEMPOOL
4811 #       define Perl_safesysmalloc_size(where)                   \
4812             (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4813 #    else
4814 #       define Perl_safesysmalloc_size(where) malloc_size(where)
4815 #    endif
4816 #  endif
4817 #  ifdef HAS_MALLOC_GOOD_SIZE
4818 #    ifdef PERL_TRACK_MEMPOOL
4819 #       define Perl_malloc_good_size(how_much)                  \
4820             (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4821 #    else
4822 #       define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4823 #    endif
4824 #  else
4825 /* Having this as the identity operation makes some code simpler.  */
4826 #       define Perl_malloc_good_size(how_much)  (how_much)
4827 #  endif
4828 #endif
4829
4830 typedef int (*runops_proc_t)(pTHX);
4831 typedef void (*share_proc_t) (pTHX_ SV *sv);
4832 typedef int  (*thrhook_proc_t) (pTHX);
4833 typedef OP* (*PPADDR_t[]) (pTHX);
4834 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4835 typedef void (*despatch_signals_proc_t) (pTHX);
4836
4837 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4838 #  include <crt_externs.h>      /* for the env array */
4839 #  define environ (*_NSGetEnviron())
4840 #elif defined(USE_ENVIRON_ARRAY) && !defined(environ)
4841    /* VMS and some other platforms don't use the environ array */
4842 EXTERN_C char **environ;  /* environment variables supplied via exec */
4843 #endif
4844
4845 #define PERL_PATCHLEVEL_H_IMPLICIT
4846 #include "patchlevel.h"
4847 #undef PERL_PATCHLEVEL_H_IMPLICIT
4848
4849 #define PERL_VERSION_STRING     STRINGIFY(PERL_REVISION) "." \
4850                                 STRINGIFY(PERL_VERSION) "." \
4851                                 STRINGIFY(PERL_SUBVERSION)
4852
4853 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4854                                 STRINGIFY(PERL_API_VERSION) "." \
4855                                 STRINGIFY(PERL_API_SUBVERSION)
4856
4857 START_EXTERN_C
4858
4859 /* handy constants */
4860 EXTCONST char PL_warn_uninit[]
4861   INIT("Use of uninitialized value%s%s%s");
4862 EXTCONST char PL_warn_uninit_sv[]
4863   INIT("Use of uninitialized value%" SVf "%s%s");
4864 EXTCONST char PL_warn_nosemi[]
4865   INIT("Semicolon seems to be missing");
4866 EXTCONST char PL_warn_reserved[]
4867   INIT("Unquoted string \"%s\" may clash with future reserved word");
4868 EXTCONST char PL_warn_nl[]
4869   INIT("Unsuccessful %s on filename containing newline");
4870 EXTCONST char PL_no_wrongref[]
4871   INIT("Can't use %s ref as %s ref");
4872 /* The core no longer needs this here. If you require the string constant,
4873    please inline a copy into your own code.  */
4874 EXTCONST char PL_no_symref[] __attribute__deprecated__
4875   INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4876 EXTCONST char PL_no_symref_sv[]
4877   INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4878
4879 EXTCONST char PL_no_usym[]
4880   INIT("Can't use an undefined value as %s reference");
4881 EXTCONST char PL_no_aelem[]
4882   INIT("Modification of non-creatable array value attempted, subscript %d");
4883 EXTCONST char PL_no_helem_sv[]
4884   INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4885 EXTCONST char PL_no_modify[]
4886   INIT("Modification of a read-only value attempted");
4887 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4888   INIT("Out of memory!\n");
4889 EXTCONST char PL_no_security[]
4890   INIT("Insecure dependency in %s%s");
4891 EXTCONST char PL_no_sock_func[]
4892   INIT("Unsupported socket function \"%s\" called");
4893 EXTCONST char PL_no_dir_func[]
4894   INIT("Unsupported directory function \"%s\" called");
4895 EXTCONST char PL_no_func[]
4896   INIT("The %s function is unimplemented");
4897 EXTCONST char PL_no_myglob[]
4898   INIT("\"%s\" %s %s can't be in a package");
4899 EXTCONST char PL_no_localize_ref[]
4900   INIT("Can't localize through a reference");
4901 EXTCONST char PL_memory_wrap[]
4902   INIT("panic: memory wrap");
4903 EXTCONST char PL_extended_cp_format[]
4904   INIT("Code point 0x%" UVXf " is not Unicode, requires a Perl extension,"
4905                              " and so is not portable");
4906 EXTCONST char PL_Yes[]
4907   INIT("1");
4908 EXTCONST char PL_No[]
4909   INIT("");
4910 EXTCONST char PL_Zero[]
4911   INIT("0");
4912
4913 /*
4914 =for apidoc_section $numeric
4915 =for apidoc AmTuU|const char *|PL_hexdigit|U8 value
4916
4917 This array, indexed by an integer, converts that value into the character that
4918 represents it.  For example, if the input is 8, the return will be a string
4919 whose first character is '8'.  What is actually returned is a pointer into a
4920 string.  All you are interested in is the first character of that string.  To
4921 get uppercase letters (for the values 10..15), add 16 to the index.  Hence,
4922 C<PL_hexdigit[11]> is C<'b'>, and C<PL_hexdigit[11+16]> is C<'B'>.  Adding 16
4923 to an index whose representation is '0'..'9' yields the same as not adding 16.
4924 Indices outside the range 0..31 result in (bad) undedefined behavior.
4925
4926 =cut
4927 */
4928 EXTCONST char PL_hexdigit[]
4929   INIT("0123456789abcdef0123456789ABCDEF");
4930
4931 EXTCONST STRLEN PL_WARN_ALL
4932   INIT(0);
4933 EXTCONST STRLEN PL_WARN_NONE
4934   INIT(0);
4935
4936 /* This is constant on most architectures, a global on OS/2 */
4937 #ifndef OS2
4938 EXTCONST char PL_sh_path[]
4939   INIT(SH_PATH); /* full path of shell */
4940 #endif
4941
4942 #ifdef CSH
4943 EXTCONST char PL_cshname[]
4944   INIT(CSH);
4945 #  define PL_cshlen     (sizeof(CSH "") - 1)
4946 #endif
4947
4948 /* These are baked at compile time into any shared perl library.
4949    In future releases this will allow us in main() to sanity test the
4950    library we're linking against.  */
4951
4952 EXTCONST U8 PL_revision
4953   INIT(PERL_REVISION);
4954 EXTCONST U8 PL_version
4955   INIT(PERL_VERSION);
4956 EXTCONST U8 PL_subversion
4957   INIT(PERL_SUBVERSION);
4958
4959 EXTCONST char PL_uuemap[65]
4960   INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4961
4962 /* a special string address whose value is "isa", but which perl knows
4963  * to treat as if it were really "DOES" when printing the method name in
4964  *  the "Can't call method '%s'" error message */
4965 EXTCONST char PL_isa_DOES[]
4966   INIT("isa");
4967
4968 #ifdef DOINIT
4969 EXTCONST char PL_uudmap[256] =
4970 #  ifdef PERL_MICRO
4971 #    include "uuudmap.h"
4972 #  else
4973 #    include "uudmap.h"
4974 #  endif
4975 ;
4976 EXTCONST char PL_bitcount[256] =
4977 #  ifdef PERL_MICRO
4978 #    include "ubitcount.h"
4979 #else
4980 #    include "bitcount.h"
4981 #  endif
4982 ;
4983 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4984 EXTCONST int         PL_sig_num[]  = { SIG_NUM };
4985 #else
4986 EXTCONST char PL_uudmap[256];
4987 EXTCONST char PL_bitcount[256];
4988 EXTCONST char* const PL_sig_name[];
4989 EXTCONST int         PL_sig_num[];
4990 #endif
4991
4992 /* fast conversion and case folding tables.  The folding tables complement the
4993  * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4994  * folds such as outside the range or to multiple characters. */
4995
4996 #ifdef DOINIT
4997 #  ifndef EBCDIC
4998
4999 /* The EBCDIC fold table depends on the code page, and hence is found in
5000  * ebcdic_tables.h */
5001
5002 EXTCONST  unsigned char PL_fold[] = {
5003         0,      1,      2,      3,      4,      5,      6,      7,
5004         8,      9,      10,     11,     12,     13,     14,     15,
5005         16,     17,     18,     19,     20,     21,