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