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