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