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