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