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