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