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