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