xref: /openbsd-src/gnu/usr.bin/perl/perl.h (revision 5a38ef86d0b61900239c7913d24a05e7b88a58f0)
1 /*    perl.h
2  *
3  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
4  *    2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10 
11 #ifndef H_PERL
12 #define H_PERL 1
13 
14 #ifdef PERL_FOR_X2P
15 /*
16  * This file is being used for x2p stuff.
17  * Above symbol is defined via -D in 'x2p/Makefile.SH'
18  * Decouple x2p stuff from some of perls more extreme eccentricities.
19  */
20 #undef MULTIPLICITY
21 #undef USE_STDIO
22 #define USE_STDIO
23 #endif /* PERL_FOR_X2P */
24 
25 #ifdef PERL_MICRO
26 #   include "uconfig.h"
27 #else
28 #   include "config.h"
29 #endif
30 
31 /* this is used for functions which take a depth trailing
32  * argument under debugging */
33 #ifdef DEBUGGING
34 #define _pDEPTH ,U32 depth
35 #define _aDEPTH ,depth
36 #else
37 #define _pDEPTH
38 #define _aDEPTH
39 #endif
40 
41 /* NOTE 1: that with gcc -std=c89 the __STDC_VERSION__ is *not* defined
42  * because the __STDC_VERSION__ became a thing only with C90.  Therefore,
43  * with gcc, HAS_C99 will never become true as long as we use -std=c89.
44 
45  * NOTE 2: headers lie.  Do not expect that if HAS_C99 gets to be true,
46  * all the C99 features are there and are correct. */
47 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || \
48     defined(_STDC_C99) || defined(__c99)
49 #  define HAS_C99 1
50 #endif
51 
52 /* See L<perlguts/"The Perl API"> for detailed notes on
53  * PERL_IMPLICIT_CONTEXT and PERL_IMPLICIT_SYS */
54 
55 /* XXX NOTE that from here --> to <-- the same logic is
56  * repeated in makedef.pl, so be certain to update
57  * both places when editing. */
58 
59 #ifdef USE_ITHREADS
60 #  if !defined(MULTIPLICITY)
61 #    define MULTIPLICITY
62 #  endif
63 #endif
64 
65 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
66 #  ifndef PERL_GLOBAL_STRUCT
67 #    define PERL_GLOBAL_STRUCT
68 #  endif
69 #endif
70 
71 #ifdef PERL_GLOBAL_STRUCT
72 #  ifndef MULTIPLICITY
73 #    define MULTIPLICITY
74 #  endif
75 #endif
76 
77 #ifdef MULTIPLICITY
78 #  ifndef PERL_IMPLICIT_CONTEXT
79 #    define PERL_IMPLICIT_CONTEXT
80 #  endif
81 #endif
82 
83 /* undef WIN32 when building on Cygwin (for libwin32) - gph */
84 #ifdef __CYGWIN__
85 #   undef WIN32
86 #   undef _WIN32
87 #endif
88 
89 #if defined(__SYMBIAN32__) || (defined(__VC32__) && defined(WINS))
90 #   ifndef SYMBIAN
91 #       define SYMBIAN
92 #   endif
93 #endif
94 
95 #ifdef __SYMBIAN32__
96 #  include "symbian/symbian_proto.h"
97 #endif
98 
99 /* Any stack-challenged places.  The limit varies (and often
100  * is configurable), but using more than a kilobyte of stack
101  * is usually dubious in these systems. */
102 #if defined(__SYMBIAN32__)
103 /* Symbian: need to work around the SDK features. *
104  * On WINS: MS VC5 generates calls to _chkstk,         *
105  * if a "large" stack frame is allocated.              *
106  * gcc on MARM does not generate calls like these.     */
107 #   define USE_HEAP_INSTEAD_OF_STACK
108 #endif
109 
110 /* Use the reentrant APIs like localtime_r and getpwent_r */
111 /* Win32 has naturally threadsafe libraries, no need to use any _r variants.
112  * XXX KEEP makedef.pl copy of this code in sync */
113 #if defined(USE_ITHREADS) && !defined(USE_REENTRANT_API) && !defined(NETWARE) && !defined(WIN32)
114 #   define USE_REENTRANT_API
115 #endif
116 
117 /* <--- here ends the logic shared by perl.h and makedef.pl */
118 
119 #undef START_EXTERN_C
120 #undef END_EXTERN_C
121 #undef EXTERN_C
122 #ifdef __cplusplus
123 #  define START_EXTERN_C extern "C" {
124 #  define END_EXTERN_C }
125 #  define EXTERN_C extern "C"
126 #else
127 #  define START_EXTERN_C
128 #  define END_EXTERN_C
129 #  define EXTERN_C extern
130 #endif
131 
132 /* Fallback definitions in case we don't have definitions from config.h.
133    This should only matter for systems that don't use Configure and
134    haven't been modified to define PERL_STATIC_INLINE yet.
135 */
136 #if !defined(PERL_STATIC_INLINE)
137 #  ifdef HAS_STATIC_INLINE
138 #    define PERL_STATIC_INLINE static inline
139 #  else
140 #    define PERL_STATIC_INLINE static
141 #  endif
142 #endif
143 
144 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GET_VARS)
145 #    ifdef PERL_GLOBAL_STRUCT_PRIVATE
146        EXTERN_C struct perl_vars* Perl_GetVarsPrivate();
147 #      define PERL_GET_VARS() Perl_GetVarsPrivate() /* see miniperlmain.c */
148 #    else
149 #      define PERL_GET_VARS() PL_VarsPtr
150 #    endif
151 #endif
152 
153 /* this used to be off by default, now its on, see perlio.h */
154 #define PERLIO_FUNCS_CONST
155 
156 #define pVAR    struct perl_vars* my_vars PERL_UNUSED_DECL
157 
158 #ifdef PERL_GLOBAL_STRUCT
159 #  define dVAR		pVAR    = (struct perl_vars*)PERL_GET_VARS()
160 #else
161 #  define dVAR		dNOOP
162 #endif
163 
164 #ifdef PERL_IMPLICIT_CONTEXT
165 #  ifndef MULTIPLICITY
166 #    define MULTIPLICITY
167 #  endif
168 #  define tTHX	PerlInterpreter*
169 #  define pTHX  tTHX my_perl PERL_UNUSED_DECL
170 #  define aTHX	my_perl
171 #  define aTHXa(a) aTHX = (tTHX)a
172 #  ifdef PERL_GLOBAL_STRUCT
173 #    define dTHXa(a)	dVAR; pTHX = (tTHX)a
174 #  else
175 #    define dTHXa(a)	pTHX = (tTHX)a
176 #  endif
177 #  ifdef PERL_GLOBAL_STRUCT
178 #    define dTHX		dVAR; pTHX = PERL_GET_THX
179 #  else
180 #    define dTHX		pTHX = PERL_GET_THX
181 #  endif
182 #  define pTHX_		pTHX,
183 #  define aTHX_		aTHX,
184 #  define pTHX_1	2
185 #  define pTHX_2	3
186 #  define pTHX_3	4
187 #  define pTHX_4	5
188 #  define pTHX_5	6
189 #  define pTHX_6	7
190 #  define pTHX_7	8
191 #  define pTHX_8	9
192 #  define pTHX_9	10
193 #  define pTHX_12	13
194 #  if defined(DEBUGGING) && !defined(PERL_TRACK_MEMPOOL)
195 #    define PERL_TRACK_MEMPOOL
196 #  endif
197 #else
198 #  undef PERL_TRACK_MEMPOOL
199 #endif
200 
201 #ifdef DEBUGGING
202 #  define dTHX_DEBUGGING dTHX
203 #else
204 #  define dTHX_DEBUGGING dNOOP
205 #endif
206 
207 #define STATIC static
208 
209 #ifndef PERL_CORE
210 /* Do not use these macros. They were part of PERL_OBJECT, which was an
211  * implementation of multiplicity using C++ objects. They have been left
212  * here solely for the sake of XS code which has incorrectly
213  * cargo-culted them.
214  */
215 #define CPERLscope(x) x
216 #define CPERLarg void
217 #define CPERLarg_
218 #define _CPERLarg
219 #define PERL_OBJECT_THIS
220 #define _PERL_OBJECT_THIS
221 #define PERL_OBJECT_THIS_
222 #define CALL_FPTR(fptr) (*fptr)
223 #define MEMBER_TO_FPTR(name) name
224 #endif /* !PERL_CORE */
225 
226 #define CALLRUNOPS  PL_runops
227 
228 #define CALLREGCOMP(sv, flags) Perl_pregcomp(aTHX_ (sv),(flags))
229 
230 #define CALLREGCOMP_ENG(prog, sv, flags) (prog)->comp(aTHX_ sv, flags)
231 #define CALLREGEXEC(prog,stringarg,strend,strbeg,minend,sv,data,flags) \
232     RX_ENGINE(prog)->exec(aTHX_ (prog),(stringarg),(strend), \
233         (strbeg),(minend),(sv),(data),(flags))
234 #define CALLREG_INTUIT_START(prog,sv,strbeg,strpos,strend,flags,data) \
235     RX_ENGINE(prog)->intuit(aTHX_ (prog), (sv), (strbeg), (strpos), \
236         (strend),(flags),(data))
237 #define CALLREG_INTUIT_STRING(prog) \
238     RX_ENGINE(prog)->checkstr(aTHX_ (prog))
239 
240 #define CALLREGFREE(prog) \
241     Perl_pregfree(aTHX_ (prog))
242 
243 #define CALLREGFREE_PVT(prog) \
244     if(prog && RX_ENGINE(prog)) RX_ENGINE(prog)->rxfree(aTHX_ (prog))
245 
246 #define CALLREG_NUMBUF_FETCH(rx,paren,usesv)                                \
247     RX_ENGINE(rx)->numbered_buff_FETCH(aTHX_ (rx),(paren),(usesv))
248 
249 #define CALLREG_NUMBUF_STORE(rx,paren,value) \
250     RX_ENGINE(rx)->numbered_buff_STORE(aTHX_ (rx),(paren),(value))
251 
252 #define CALLREG_NUMBUF_LENGTH(rx,sv,paren)                              \
253     RX_ENGINE(rx)->numbered_buff_LENGTH(aTHX_ (rx),(sv),(paren))
254 
255 #define CALLREG_NAMED_BUFF_FETCH(rx, key, flags) \
256     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_FETCH))
257 
258 #define CALLREG_NAMED_BUFF_STORE(rx, key, value, flags) \
259     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), (value), ((flags) | RXapif_STORE))
260 
261 #define CALLREG_NAMED_BUFF_DELETE(rx, key, flags) \
262     RX_ENGINE(rx)->named_buff(aTHX_ (rx),(key), NULL, ((flags) | RXapif_DELETE))
263 
264 #define CALLREG_NAMED_BUFF_CLEAR(rx, flags) \
265     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_CLEAR))
266 
267 #define CALLREG_NAMED_BUFF_EXISTS(rx, key, flags) \
268     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_EXISTS))
269 
270 #define CALLREG_NAMED_BUFF_FIRSTKEY(rx, flags) \
271     RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), NULL, ((flags) | RXapif_FIRSTKEY))
272 
273 #define CALLREG_NAMED_BUFF_NEXTKEY(rx, lastkey, flags) \
274     RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), (lastkey), ((flags) | RXapif_NEXTKEY))
275 
276 #define CALLREG_NAMED_BUFF_SCALAR(rx, flags) \
277     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_SCALAR))
278 
279 #define CALLREG_NAMED_BUFF_COUNT(rx) \
280     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, RXapif_REGNAMES_COUNT)
281 
282 #define CALLREG_NAMED_BUFF_ALL(rx, flags) \
283     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, flags)
284 
285 #define CALLREG_PACKAGE(rx) \
286     RX_ENGINE(rx)->qr_package(aTHX_ (rx))
287 
288 #if defined(USE_ITHREADS)
289 #define CALLREGDUPE(prog,param) \
290     Perl_re_dup(aTHX_ (prog),(param))
291 
292 #define CALLREGDUPE_PVT(prog,param) \
293     (prog ? RX_ENGINE(prog)->dupe(aTHX_ (prog),(param)) \
294           : (REGEXP *)NULL)
295 #endif
296 
297 /* some compilers impersonate gcc */
298 #if defined(__GNUC__) && !defined(__clang__) && !defined(__INTEL_COMPILER)
299 #  define PERL_IS_GCC 1
300 #endif
301 
302 /* In case Configure was not used (we are using a "canned config"
303  * such as Win32, or a cross-compilation setup, for example) try going
304  * by the gcc major and minor versions.  One useful URL is
305  * http://www.ohse.de/uwe/articles/gcc-attributes.html,
306  * but contrary to this information warn_unused_result seems
307  * not to be in gcc 3.3.5, at least. --jhi
308  * Also, when building extensions with an installed perl, this allows
309  * the user to upgrade gcc and get the right attributes, rather than
310  * relying on the list generated at Configure time.  --AD
311  * Set these up now otherwise we get confused when some of the <*thread.h>
312  * includes below indirectly pull in <perlio.h> (which needs to know if we
313  * have HASATTRIBUTE_FORMAT).
314  */
315 
316 #ifndef PERL_MICRO
317 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
318 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
319 #    define HASATTRIBUTE_DEPRECATED
320 #  endif
321 #  if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
322 #    define HASATTRIBUTE_FORMAT
323 #    if defined __MINGW32__
324 #      define PRINTF_FORMAT_NULL_OK
325 #    endif
326 #  endif
327 #  if __GNUC__ >= 3 /* 3.0 -> */
328 #    define HASATTRIBUTE_MALLOC
329 #  endif
330 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
331 #    define HASATTRIBUTE_NONNULL
332 #  endif
333 #  if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
334 #    define HASATTRIBUTE_NORETURN
335 #  endif
336 #  if __GNUC__ >= 3 /* gcc 3.0 -> */
337 #    define HASATTRIBUTE_PURE
338 #  endif
339 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
340 #    define HASATTRIBUTE_UNUSED
341 #  endif
342 #  if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
343 #    define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
344 #  endif
345 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
346 #    define HASATTRIBUTE_WARN_UNUSED_RESULT
347 #  endif
348 /* always_inline is buggy in gcc <= 4.6 and causes compilation errors */
349 #  if __GNUC__ == 4 && __GNUC_MINOR__ >= 7 || __GNUC__ > 4 /* 4.7 -> */
350 #    define HASATTRIBUTE_ALWAYS_INLINE
351 #  endif
352 #endif
353 #endif /* #ifndef PERL_MICRO */
354 
355 #ifdef HASATTRIBUTE_DEPRECATED
356 #  define __attribute__deprecated__         __attribute__((deprecated))
357 #endif
358 #ifdef HASATTRIBUTE_FORMAT
359 #  define __attribute__format__(x,y,z)      __attribute__((format(x,y,z)))
360 #endif
361 #ifdef HASATTRIBUTE_MALLOC
362 #  define __attribute__malloc__             __attribute__((__malloc__))
363 #endif
364 #ifdef HASATTRIBUTE_NONNULL
365 #  define __attribute__nonnull__(a)         __attribute__((nonnull(a)))
366 #endif
367 #ifdef HASATTRIBUTE_NORETURN
368 #  define __attribute__noreturn__           __attribute__((noreturn))
369 #endif
370 #ifdef HASATTRIBUTE_PURE
371 #  define __attribute__pure__               __attribute__((pure))
372 #endif
373 #ifdef HASATTRIBUTE_UNUSED
374 #  define __attribute__unused__             __attribute__((unused))
375 #endif
376 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
377 #  define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
378 #endif
379 #ifdef HASATTRIBUTE_ALWAYS_INLINE
380 /* always_inline is buggy in gcc <= 4.6 and causes compilation errors */
381 #  if !defined(PERL_IS_GCC) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7 || __GNUC__ > 4)
382 #    define __attribute__always_inline__      __attribute__((always_inline))
383 #  endif
384 #endif
385 
386 /* If we haven't defined the attributes yet, define them to blank. */
387 #ifndef __attribute__deprecated__
388 #  define __attribute__deprecated__
389 #endif
390 #ifndef __attribute__format__
391 #  define __attribute__format__(x,y,z)
392 #endif
393 #ifndef __attribute__malloc__
394 #  define __attribute__malloc__
395 #endif
396 #ifndef __attribute__nonnull__
397 #  define __attribute__nonnull__(a)
398 #endif
399 #ifndef __attribute__noreturn__
400 #  define __attribute__noreturn__
401 #endif
402 #ifndef __attribute__pure__
403 #  define __attribute__pure__
404 #endif
405 #ifndef __attribute__unused__
406 #  define __attribute__unused__
407 #endif
408 #ifndef __attribute__warn_unused_result__
409 #  define __attribute__warn_unused_result__
410 #endif
411 #ifndef __attribute__always_inline__
412 #  define __attribute__always_inline__
413 #endif
414 
415 /* Some OS warn on NULL format to printf */
416 #ifdef PRINTF_FORMAT_NULL_OK
417 #  define __attribute__format__null_ok__(x,y,z)  __attribute__format__(x,y,z)
418 #else
419 #  define __attribute__format__null_ok__(x,y,z)
420 #endif
421 
422 /*
423  * Because of backward compatibility reasons the PERL_UNUSED_DECL
424  * cannot be changed from postfix to PERL_UNUSED_DECL(x).  Sigh.
425  *
426  * Note that there are C compilers such as MetroWerks CodeWarrior
427  * which do not have an "inlined" way (like the gcc __attribute__) of
428  * marking unused variables (they need e.g. a #pragma) and therefore
429  * cpp macros like PERL_UNUSED_DECL cannot work for this purpose, even
430  * if it were PERL_UNUSED_DECL(x), which it cannot be (see above).
431  *
432  */
433 
434 #ifndef PERL_UNUSED_DECL
435 #  define PERL_UNUSED_DECL __attribute__unused__
436 #endif
437 
438 /* gcc -Wall:
439  * for silencing unused variables that are actually used most of the time,
440  * but we cannot quite get rid of, such as "ax" in PPCODE+noargs xsubs,
441  * or variables/arguments that are used only in certain configurations.
442  */
443 #ifndef PERL_UNUSED_ARG
444 #  define PERL_UNUSED_ARG(x) ((void)sizeof(x))
445 #endif
446 #ifndef PERL_UNUSED_VAR
447 #  define PERL_UNUSED_VAR(x) ((void)sizeof(x))
448 #endif
449 
450 #if defined(USE_ITHREADS) || defined(PERL_GLOBAL_STRUCT)
451 #  define PERL_UNUSED_CONTEXT PERL_UNUSED_ARG(my_perl)
452 #else
453 #  define PERL_UNUSED_CONTEXT
454 #endif
455 
456 /* gcc (-ansi) -pedantic doesn't allow gcc statement expressions,
457  * g++ allows them but seems to have problems with them
458  * (insane errors ensue).
459  * g++ does not give insane errors now (RMB 2008-01-30, gcc 4.2.2).
460  */
461 #if defined(PERL_GCC_PEDANTIC) || \
462     (defined(__GNUC__) && defined(__cplusplus) && \
463 	((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2))))
464 #  ifndef PERL_GCC_BRACE_GROUPS_FORBIDDEN
465 #    define PERL_GCC_BRACE_GROUPS_FORBIDDEN
466 #  endif
467 #endif
468 
469 /* Use PERL_UNUSED_RESULT() to suppress the warnings about unused results
470  * of function calls, e.g. PERL_UNUSED_RESULT(foo(a, b)).
471  *
472  * The main reason for this is that the combination of gcc -Wunused-result
473  * (part of -Wall) and the __attribute__((warn_unused_result)) cannot
474  * be silenced with casting to void.  This causes trouble when the system
475  * header files use the attribute.
476  *
477  * Use PERL_UNUSED_RESULT sparingly, though, since usually the warning
478  * is there for a good reason: you might lose success/failure information,
479  * or leak resources, or changes in resources.
480  *
481  * But sometimes you just want to ignore the return value, e.g. on
482  * codepaths soon ending up in abort, or in "best effort" attempts,
483  * or in situations where there is no good way to handle failures.
484  *
485  * Sometimes PERL_UNUSED_RESULT might not be the most natural way:
486  * another possibility is that you can capture the return value
487  * and use PERL_UNUSED_VAR on that.
488  *
489  * The __typeof__() is used instead of typeof() since typeof() is not
490  * available under strict C89, and because of compilers masquerading
491  * as gcc (clang and icc), we want exactly the gcc extension
492  * __typeof__ and nothing else.
493  */
494 #ifndef PERL_UNUSED_RESULT
495 #  if defined(__GNUC__) && defined(HASATTRIBUTE_WARN_UNUSED_RESULT)
496 #    define PERL_UNUSED_RESULT(v) STMT_START { __typeof__(v) z = (v); (void)sizeof(z); } STMT_END
497 #  else
498 #    define PERL_UNUSED_RESULT(v) ((void)(v))
499 #  endif
500 #endif
501 
502 #if defined(_MSC_VER)
503 /* XXX older MSVC versions have a smallish macro buffer */
504 #define PERL_SMALL_MACRO_BUFFER
505 #endif
506 
507 /* on gcc (and clang), specify that a warning should be temporarily
508  * ignored; e.g.
509  *
510  *    GCC_DIAG_IGNORE_DECL(-Wmultichar);
511  *    char b = 'ab';
512  *    GCC_DIAG_RESTORE_DECL;
513  *
514  * based on http://dbp-consulting.com/tutorials/SuppressingGCCWarnings.html
515  *
516  * Note that "pragma GCC diagnostic push/pop" was added in GCC 4.6, Mar 2011;
517  * clang only pretends to be GCC 4.2, but still supports push/pop.
518  *
519  * Note on usage: all macros must be used at a place where a declaration
520  * or statement can occur, i.e., not in the middle of an expression.
521  * *_DIAG_IGNORE() and *_DIAG_RESTORE can be used in any such place, but
522  * must be used without a following semicolon.  *_DIAG_IGNORE_DECL() and
523  * *_DIAG_RESTORE_DECL must be used with a following semicolon, and behave
524  * syntactically as declarations (like dNOOP).  *_DIAG_IGNORE_STMT()
525  * and *_DIAG_RESTORE_STMT must be used with a following semicolon,
526  * and behave syntactically as statements (like NOOP).
527  *
528  */
529 
530 #if defined(__clang__) || defined(__clang) || \
531        (defined( __GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406)
532 #  define GCC_DIAG_PRAGMA(x) _Pragma (#x)
533 /* clang has "clang diagnostic" pragmas, but also understands gcc. */
534 #  define GCC_DIAG_IGNORE(x) _Pragma("GCC diagnostic push") \
535                              GCC_DIAG_PRAGMA(GCC diagnostic ignored #x)
536 #  define GCC_DIAG_RESTORE   _Pragma("GCC diagnostic pop")
537 #else
538 #  define GCC_DIAG_IGNORE(w)
539 #  define GCC_DIAG_RESTORE
540 #endif
541 #define GCC_DIAG_IGNORE_DECL(x) GCC_DIAG_IGNORE(x) dNOOP
542 #define GCC_DIAG_RESTORE_DECL GCC_DIAG_RESTORE dNOOP
543 #define GCC_DIAG_IGNORE_STMT(x) GCC_DIAG_IGNORE(x) NOOP
544 #define GCC_DIAG_RESTORE_STMT GCC_DIAG_RESTORE NOOP
545 /* for clang specific pragmas */
546 #if defined(__clang__) || defined(__clang)
547 #  define CLANG_DIAG_PRAGMA(x) _Pragma (#x)
548 #  define CLANG_DIAG_IGNORE(x) _Pragma("clang diagnostic push") \
549                                CLANG_DIAG_PRAGMA(clang diagnostic ignored #x)
550 #  define CLANG_DIAG_RESTORE   _Pragma("clang diagnostic pop")
551 #else
552 #  define CLANG_DIAG_IGNORE(w)
553 #  define CLANG_DIAG_RESTORE
554 #endif
555 #define CLANG_DIAG_IGNORE_DECL(x) CLANG_DIAG_IGNORE(x) dNOOP
556 #define CLANG_DIAG_RESTORE_DECL CLANG_DIAG_RESTORE dNOOP
557 #define CLANG_DIAG_IGNORE_STMT(x) CLANG_DIAG_IGNORE(x) NOOP
558 #define CLANG_DIAG_RESTORE_STMT CLANG_DIAG_RESTORE NOOP
559 
560 #if defined(_MSC_VER) && (_MSC_VER >= 1300)
561 #  define MSVC_DIAG_IGNORE(x) __pragma(warning(push)) \
562                               __pragma(warning(disable : x))
563 #  define MSVC_DIAG_RESTORE   __pragma(warning(pop))
564 #else
565 #  define MSVC_DIAG_IGNORE(x)
566 #  define MSVC_DIAG_RESTORE
567 #endif
568 #define MSVC_DIAG_IGNORE_DECL(x) MSVC_DIAG_IGNORE(x) dNOOP
569 #define MSVC_DIAG_RESTORE_DECL MSVC_DIAG_RESTORE dNOOP
570 #define MSVC_DIAG_IGNORE_STMT(x) MSVC_DIAG_IGNORE(x) NOOP
571 #define MSVC_DIAG_RESTORE_STMT MSVC_DIAG_RESTORE NOOP
572 
573 #define NOOP /*EMPTY*/(void)0
574 #define dNOOP struct Perl___notused_struct
575 
576 #ifndef pTHX
577 /* Don't bother defining tTHX ; using it outside
578  * code guarded by PERL_IMPLICIT_CONTEXT is an error.
579  */
580 #  define pTHX		void
581 #  define pTHX_
582 #  define aTHX
583 #  define aTHX_
584 #  define aTHXa(a)      NOOP
585 #  define dTHXa(a)	dNOOP
586 #  define dTHX		dNOOP
587 #  define pTHX_1	1
588 #  define pTHX_2	2
589 #  define pTHX_3	3
590 #  define pTHX_4	4
591 #  define pTHX_5	5
592 #  define pTHX_6	6
593 #  define pTHX_7	7
594 #  define pTHX_8	8
595 #  define pTHX_9	9
596 #  define pTHX_12	12
597 #endif
598 
599 #ifndef dVAR
600 #  define dVAR		dNOOP
601 #endif
602 
603 /* these are only defined for compatibility; should not be used internally */
604 #if !defined(pTHXo) && !defined(PERL_CORE)
605 #  define pTHXo		pTHX
606 #  define pTHXo_	pTHX_
607 #  define aTHXo		aTHX
608 #  define aTHXo_	aTHX_
609 #  define dTHXo		dTHX
610 #  define dTHXoa(x)	dTHXa(x)
611 #endif
612 
613 #ifndef pTHXx
614 #  define pTHXx		PerlInterpreter *my_perl
615 #  define pTHXx_	pTHXx,
616 #  define aTHXx		my_perl
617 #  define aTHXx_	aTHXx,
618 #  define dTHXx		dTHX
619 #endif
620 
621 /* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
622  * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
623  * dTHXs is therefore needed for all functions using PerlIO_foo(). */
624 #ifdef PERL_IMPLICIT_SYS
625 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
626 #    define dTHXs		dVAR; dTHX
627 #  else
628 #    define dTHXs		dTHX
629 #  endif
630 #else
631 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
632 #    define dTHXs		dVAR
633 #  else
634 #    define dTHXs		dNOOP
635 #  endif
636 #endif
637 
638 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
639 #  ifndef PERL_USE_GCC_BRACE_GROUPS
640 #    define PERL_USE_GCC_BRACE_GROUPS
641 #  endif
642 #endif
643 
644 /*
645 =head1 Miscellaneous Functions
646 
647 =for apidoc AmnUu|void|STMT_START
648 
649  STMT_START { statements; } STMT_END;
650 
651 can be used as a single statement, as in
652 
653  if (x) STMT_START { ... } STMT_END; else ...
654 
655 These are often used in macro definitions.  Note that you can't return a value
656 out of them.
657 
658 =for apidoc AmnUhu|void|STMT_END
659 
660 =cut
661 
662  Trying to select a version that gives no warnings...
663 */
664 #if !(defined(STMT_START) && defined(STMT_END))
665 #   define STMT_START	do
666 #   define STMT_END	while (0)
667 #endif
668 
669 #ifndef BYTEORDER  /* Should never happen -- byteorder is in config.h */
670 #   define BYTEORDER 0x1234
671 #endif
672 
673 #if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
674 #define ASCIIish
675 #else
676 #undef  ASCIIish
677 #endif
678 
679 /*
680  * The following contortions are brought to you on behalf of all the
681  * standards, semi-standards, de facto standards, not-so-de-facto standards
682  * of the world, as well as all the other botches anyone ever thought of.
683  * The basic theory is that if we work hard enough here, the rest of the
684  * code can be a lot prettier.  Well, so much for theory.  Sorry, Henry...
685  */
686 
687 /* define this once if either system, instead of cluttering up the src */
688 #if defined(MSDOS) || defined(WIN32) || defined(NETWARE)
689 #define DOSISH 1
690 #endif
691 
692 /* These exist only for back-compat with XS modules. */
693 #ifndef PERL_CORE
694 #define VOL volatile
695 #define CAN_PROTOTYPE
696 #define _(args) args
697 #define I_LIMITS
698 #define I_STDARG
699 #define STANDARD_C
700 #endif
701 
702 /* By compiling a perl with -DNO_TAINT_SUPPORT or -DSILENT_NO_TAINT_SUPPORT,
703  * you get a perl without taint support, but doubtlessly with a lesser
704  * degree of support. Do not do so unless you know exactly what it means
705  * technically, have a good reason to do so, and know exactly how the
706  * perl will be used. perls with -DSILENT_NO_TAINT_SUPPORT are considered
707  * a potential security risk due to flat out ignoring the security-relevant
708  * taint flags. This being said, a perl without taint support compiled in
709  * has marginal run-time performance benefits.
710  * SILENT_NO_TAINT_SUPPORT implies NO_TAINT_SUPPORT.
711  * SILENT_NO_TAINT_SUPPORT is the same as NO_TAINT_SUPPORT except it
712  * silently ignores -t/-T instead of throwing an exception.
713  *
714  * DANGER! Using NO_TAINT_SUPPORT or SILENT_NO_TAINT_SUPPORT
715  *         voids your nonexistent warranty!
716  */
717 #if defined(SILENT_NO_TAINT_SUPPORT) && !defined(NO_TAINT_SUPPORT)
718 #  define NO_TAINT_SUPPORT 1
719 #endif
720 
721 /* NO_TAINT_SUPPORT can be set to transform virtually all taint-related
722  * operations into no-ops for a very modest speed-up. Enable only if you
723  * know what you're doing: tests and CPAN modules' tests are bound to fail.
724  */
725 #ifdef NO_TAINT_SUPPORT
726 #   define TAINT		NOOP
727 #   define TAINT_NOT		NOOP
728 #   define TAINT_IF(c)		NOOP
729 #   define TAINT_ENV()		NOOP
730 #   define TAINT_PROPER(s)	NOOP
731 #   define TAINT_set(s)		NOOP
732 #   define TAINT_get		0
733 #   define TAINTING_get		0
734 #   define TAINTING_set(s)	NOOP
735 #   define TAINT_WARN_get       0
736 #   define TAINT_WARN_set(s)    NOOP
737 #else
738     /* Set to tainted if we are running under tainting mode */
739 #   define TAINT		(PL_tainted = PL_tainting)
740 
741 #   define TAINT_NOT	(PL_tainted = FALSE)        /* Untaint */
742 #   define TAINT_IF(c)	if (UNLIKELY(c)) { TAINT; } /* Conditionally taint */
743 #   define TAINT_ENV()	if (UNLIKELY(PL_tainting)) { taint_env(); }
744                                 /* croak or warn if tainting */
745 #   define TAINT_PROPER(s)	if (UNLIKELY(PL_tainting)) {                \
746                                     taint_proper(NULL, s);                  \
747                                 }
748 #   define TAINT_set(s)		(PL_tainted = (s))
749 #   define TAINT_get		(cBOOL(UNLIKELY(PL_tainted)))    /* Is something tainted? */
750 #   define TAINTING_get		(cBOOL(UNLIKELY(PL_tainting)))   /* Is taint checking enabled? */
751 #   define TAINTING_set(s)	(PL_tainting = (s))
752 #   define TAINT_WARN_get       (PL_taint_warn) /* FALSE => tainting violations
753                                                             are fatal
754                                                    TRUE =>  they're just
755                                                             warnings */
756 #   define TAINT_WARN_set(s)    (PL_taint_warn = (s))
757 #endif
758 
759 /* flags used internally only within pp_subst and pp_substcont */
760 #ifdef PERL_CORE
761 #  define SUBST_TAINT_STR      1	/* string tainted */
762 #  define SUBST_TAINT_PAT      2	/* pattern tainted */
763 #  define SUBST_TAINT_REPL     4	/* replacement tainted */
764 #  define SUBST_TAINT_RETAINT  8	/* use re'taint' in scope */
765 #  define SUBST_TAINT_BOOLRET 16	/* return is boolean (don't taint) */
766 #endif
767 
768 /* XXX All process group stuff is handled in pp_sys.c.  Should these
769    defines move there?  If so, I could simplify this a lot. --AD  9/96.
770 */
771 /* Process group stuff changed from traditional BSD to POSIX.
772    perlfunc.pod documents the traditional BSD-style syntax, so we'll
773    try to preserve that, if possible.
774 */
775 #ifdef HAS_SETPGID
776 #  define BSD_SETPGRP(pid, pgrp)	setpgid((pid), (pgrp))
777 #elif defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
778 #  define BSD_SETPGRP(pid, pgrp)	setpgrp((pid), (pgrp))
779 #elif defined(HAS_SETPGRP2)
780 #  define BSD_SETPGRP(pid, pgrp)	setpgrp2((pid), (pgrp))
781 #endif
782 #if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
783 #  define HAS_SETPGRP  /* Well, effectively it does . . . */
784 #endif
785 
786 /* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
787     our life easier :-) so we'll try it.
788 */
789 #ifdef HAS_GETPGID
790 #  define BSD_GETPGRP(pid)		getpgid((pid))
791 #elif defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
792 #  define BSD_GETPGRP(pid)		getpgrp((pid))
793 #elif defined(HAS_GETPGRP2)
794 #  define BSD_GETPGRP(pid)		getpgrp2((pid))
795 #endif
796 #if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
797 #  define HAS_GETPGRP  /* Well, effectively it does . . . */
798 #endif
799 
800 /* These are not exact synonyms, since setpgrp() and getpgrp() may
801    have different behaviors, but perl.h used to define USE_BSDPGRP
802    (prior to 5.003_05) so some extension might depend on it.
803 */
804 #if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
805 #  ifndef USE_BSDPGRP
806 #    define USE_BSDPGRP
807 #  endif
808 #endif
809 
810 /* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
811    pthread.h must be included before all other header files.
812 */
813 #if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
814 #  include <pthread.h>
815 #endif
816 
817 #include <sys/types.h>
818 
819 /* EVC 4 SDK headers includes a bad definition of MB_CUR_MAX in stdlib.h
820   which is included from stdarg.h. Bad definition not present in SD 2008
821   SDK headers. wince.h is not yet included, so we cant fix this from there
822   since by then MB_CUR_MAX will be defined from stdlib.h.
823   cewchar.h includes a correct definition of MB_CUR_MAX and it is copied here
824   since cewchar.h can't be included this early */
825 #if defined(UNDER_CE) && (_MSC_VER < 1300)
826 #  define MB_CUR_MAX 1uL
827 #endif
828 
829 #  ifdef I_WCHAR
830 #    include <wchar.h>
831 #  endif
832 
833 # include <stdarg.h>
834 
835 #ifdef I_STDINT
836 # include <stdint.h>
837 #endif
838 
839 #include <ctype.h>
840 #include <float.h>
841 #include <limits.h>
842 
843 #ifdef METHOD 	/* Defined by OSF/1 v3.0 by ctype.h */
844 #undef METHOD
845 #endif
846 
847 #ifdef PERL_MICRO
848 #   define NO_LOCALE
849 #endif
850 
851 #ifdef I_LOCALE
852 #   include <locale.h>
853 #endif
854 
855 #ifdef I_XLOCALE
856 #   include <xlocale.h>
857 #endif
858 
859 /* If not forbidden, we enable locale handling if either 1) the POSIX 2008
860  * functions are available, or 2) just the setlocale() function.  This logic is
861  * repeated in t/loc_tools.pl and makedef.pl;  The three should be kept in
862  * sync. */
863 #if   ! defined(NO_LOCALE)
864 
865 #  if ! defined(NO_POSIX_2008_LOCALE)           \
866    &&   defined(HAS_NEWLOCALE)                  \
867    &&   defined(HAS_USELOCALE)                  \
868    &&   defined(HAS_DUPLOCALE)                  \
869    &&   defined(HAS_FREELOCALE)                 \
870    &&   defined(LC_ALL_MASK)
871 
872     /* For simplicity, the code is written to assume that any platform advanced
873      * enough to have the Posix 2008 locale functions has LC_ALL.  The final
874      * test above makes sure that assumption is valid */
875 
876 #    define HAS_POSIX_2008_LOCALE
877 #    define USE_LOCALE
878 #  elif defined(HAS_SETLOCALE)
879 #    define USE_LOCALE
880 #  endif
881 #endif
882 
883 #ifdef USE_LOCALE
884 #   define HAS_SKIP_LOCALE_INIT /* Solely for XS code to test for this
885                                    #define */
886 #   if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
887        && defined(HAS_STRXFRM)
888 #	define USE_LOCALE_COLLATE
889 #   endif
890 #   if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
891 #	define USE_LOCALE_CTYPE
892 #   endif
893 #   if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
894 #	define USE_LOCALE_NUMERIC
895 #   endif
896 #   if !defined(NO_LOCALE_MESSAGES) && defined(LC_MESSAGES)
897 #	define USE_LOCALE_MESSAGES
898 #   endif
899 #   if !defined(NO_LOCALE_MONETARY) && defined(LC_MONETARY)
900 #	define USE_LOCALE_MONETARY
901 #   endif
902 #   if !defined(NO_LOCALE_TIME) && defined(LC_TIME)
903 #	define USE_LOCALE_TIME
904 #   endif
905 #   if !defined(NO_LOCALE_ADDRESS) && defined(LC_ADDRESS)
906 #	define USE_LOCALE_ADDRESS
907 #   endif
908 #   if !defined(NO_LOCALE_IDENTIFICATION) && defined(LC_IDENTIFICATION)
909 #	define USE_LOCALE_IDENTIFICATION
910 #   endif
911 #   if !defined(NO_LOCALE_MEASUREMENT) && defined(LC_MEASUREMENT)
912 #	define USE_LOCALE_MEASUREMENT
913 #   endif
914 #   if !defined(NO_LOCALE_PAPER) && defined(LC_PAPER)
915 #	define USE_LOCALE_PAPER
916 #   endif
917 #   if !defined(NO_LOCALE_TELEPHONE) && defined(LC_TELEPHONE)
918 #	define USE_LOCALE_TELEPHONE
919 #   endif
920 
921 /* XXX The next few defines are unfortunately duplicated in makedef.pl, and
922  * changes here MUST also be made there */
923 
924 #  if ! defined(HAS_SETLOCALE) && defined(HAS_POSIX_2008_LOCALE)
925 #      define USE_POSIX_2008_LOCALE
926 #      ifndef USE_THREAD_SAFE_LOCALE
927 #        define USE_THREAD_SAFE_LOCALE
928 #      endif
929                                    /* If compiled with
930                                     * -DUSE_THREAD_SAFE_LOCALE, will do so even
931                                     * on unthreaded builds */
932 #  elif   (defined(USE_ITHREADS) || defined(USE_THREAD_SAFE_LOCALE))         \
933        && (    defined(HAS_POSIX_2008_LOCALE)                                \
934            || (defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1400))     \
935        && ! defined(NO_THREAD_SAFE_LOCALE)
936 #    ifndef USE_THREAD_SAFE_LOCALE
937 #      define USE_THREAD_SAFE_LOCALE
938 #    endif
939 #    ifdef HAS_POSIX_2008_LOCALE
940 #      define USE_POSIX_2008_LOCALE
941 #    endif
942 #  endif
943 #endif
944 
945 /*  Microsoft documentation reads in the change log for VS 2015:
946  *     "The localeconv function declared in locale.h now works correctly when
947  *     per-thread locale is enabled. In previous versions of the library, this
948  *     function would return the lconv data for the global locale, not the
949  *     thread's locale."
950  */
951 #if defined(WIN32) && defined(USE_THREAD_SAFE_LOCALE) && _MSC_VER < 1900
952 #  define TS_W32_BROKEN_LOCALECONV
953 #endif
954 
955 #include <setjmp.h>
956 
957 #ifdef I_SYS_PARAM
958 #   ifdef PARAM_NEEDS_TYPES
959 #	include <sys/types.h>
960 #   endif
961 #   include <sys/param.h>
962 #endif
963 
964 /* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
965    value something like 199306.  This may be useful if no more-specific
966    feature test is available.
967 */
968 #if defined(BSD)
969 #   ifndef BSDish
970 #       define BSDish
971 #   endif
972 #endif
973 
974 /* Use all the "standard" definitions */
975 #include <stdlib.h>
976 
977 /* If this causes problems, set i_unistd=undef in the hint file.  */
978 #ifdef I_UNISTD
979 #    if defined(__amigaos4__)
980 #        ifdef I_NETINET_IN
981 #            include <netinet/in.h>
982 #        endif
983 #   endif
984 #   include <unistd.h>
985 #   if defined(__amigaos4__)
986 /* Under AmigaOS 4 newlib.library provides an environ.  However using
987  * it doesn't give us enough control over inheritance of variables by
988  * subshells etc. so replace with custom version based on abc-shell
989  * code. */
990 extern char **myenviron;
991 #       undef environ
992 #       define environ myenviron
993 #   endif
994 #endif
995 
996 /* for WCOREDUMP */
997 #ifdef I_SYS_WAIT
998 #   include <sys/wait.h>
999 #endif
1000 
1001 #ifdef __SYMBIAN32__
1002 #   undef _SC_ARG_MAX /* Symbian has _SC_ARG_MAX but no sysconf() */
1003 #endif
1004 
1005 #if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
1006 EXTERN_C int syscall(int, ...);
1007 #endif
1008 
1009 #if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
1010 EXTERN_C int usleep(unsigned int);
1011 #endif
1012 
1013 /* macros for correct constant construction.  These are in C99 <stdint.h>
1014  * (so they will not be available in strict C89 mode), but they are nice, so
1015  * let's define them if necessary. */
1016 #ifndef UINT16_C
1017 #  if INTSIZE >= 2
1018 #    define UINT16_C(x) ((U16_TYPE)x##U)
1019 #  else
1020 #    define UINT16_C(x) ((U16_TYPE)x##UL)
1021 #  endif
1022 #endif
1023 
1024 #ifndef UINT32_C
1025 #  if INTSIZE >= 4
1026 #    define UINT32_C(x) ((U32_TYPE)x##U)
1027 #  else
1028 #    define UINT32_C(x) ((U32_TYPE)x##UL)
1029 #  endif
1030 #endif
1031 
1032 #ifdef I_STDINT
1033     typedef intmax_t  PERL_INTMAX_T;
1034     typedef uintmax_t PERL_UINTMAX_T;
1035 #endif
1036 
1037 /* N.B.  We use QUADKIND here instead of HAS_QUAD here, because that doesn't
1038  * actually mean what it has always been documented to mean (see RT #119753)
1039  * and is explicitly turned off outside of core with dire warnings about
1040  * removing the undef. */
1041 
1042 #if defined(QUADKIND)
1043 #  undef PeRl_INT64_C
1044 #  undef PeRl_UINT64_C
1045 /* Prefer the native integer types (int and long) over long long
1046  * (which is not C89) and Win32-specific __int64. */
1047 #  if QUADKIND == QUAD_IS_INT && INTSIZE == 8
1048 #    define PeRl_INT64_C(c)	(c)
1049 #    define PeRl_UINT64_C(c)	CAT2(c,U)
1050 #  endif
1051 #  if QUADKIND == QUAD_IS_LONG && LONGSIZE == 8
1052 #    define PeRl_INT64_C(c)	CAT2(c,L)
1053 #    define PeRl_UINT64_C(c)	CAT2(c,UL)
1054 #  endif
1055 #  if QUADKIND == QUAD_IS_LONG_LONG && defined(HAS_LONG_LONG)
1056 #    define PeRl_INT64_C(c)	CAT2(c,LL)
1057 #    define PeRl_UINT64_C(c)	CAT2(c,ULL)
1058 #  endif
1059 #  if QUADKIND == QUAD_IS___INT64
1060 #    define PeRl_INT64_C(c)	CAT2(c,I64)
1061 #    define PeRl_UINT64_C(c)	CAT2(c,UI64)
1062 #  endif
1063 #  ifndef PeRl_INT64_C
1064 #    define PeRl_INT64_C(c)	((I64)(c)) /* last resort */
1065 #    define PeRl_UINT64_C(c)	((U64TYPE)(c))
1066 #  endif
1067 /* In OS X the INT64_C/UINT64_C are defined with LL/ULL, which will
1068  * not fly with C89-pedantic gcc, so let's undefine them first so that
1069  * we can redefine them with our native integer preferring versions. */
1070 #  if defined(PERL_DARWIN) && defined(PERL_GCC_PEDANTIC)
1071 #    undef INT64_C
1072 #    undef UINT64_C
1073 #  endif
1074 #  ifndef INT64_C
1075 #    define INT64_C(c) PeRl_INT64_C(c)
1076 #  endif
1077 #  ifndef UINT64_C
1078 #    define UINT64_C(c) PeRl_UINT64_C(c)
1079 #  endif
1080 
1081 #  ifndef I_STDINT
1082     typedef I64TYPE PERL_INTMAX_T;
1083     typedef U64TYPE PERL_UINTMAX_T;
1084 #  endif
1085 #  ifndef INTMAX_C
1086 #    define INTMAX_C(c) INT64_C(c)
1087 #  endif
1088 #  ifndef UINTMAX_C
1089 #    define UINTMAX_C(c) UINT64_C(c)
1090 #  endif
1091 
1092 #else  /* below QUADKIND is undefined */
1093 
1094 /* Perl doesn't work on 16 bit systems, so must be 32 bit */
1095 #  ifndef I_STDINT
1096     typedef I32TYPE PERL_INTMAX_T;
1097     typedef U32TYPE PERL_UINTMAX_T;
1098 #  endif
1099 #  ifndef INTMAX_C
1100 #    define INTMAX_C(c) INT32_C(c)
1101 #  endif
1102 #  ifndef UINTMAX_C
1103 #    define UINTMAX_C(c) UINT32_C(c)
1104 #  endif
1105 
1106 #endif  /* no QUADKIND */
1107 
1108 #ifdef PERL_CORE
1109 
1110 /* byte-swapping functions for big-/little-endian conversion */
1111 # define _swab_16_(x) ((U16)( \
1112          (((U16)(x) & UINT16_C(0x00ff)) << 8) | \
1113          (((U16)(x) & UINT16_C(0xff00)) >> 8) ))
1114 
1115 # define _swab_32_(x) ((U32)( \
1116          (((U32)(x) & UINT32_C(0x000000ff)) << 24) | \
1117          (((U32)(x) & UINT32_C(0x0000ff00)) <<  8) | \
1118          (((U32)(x) & UINT32_C(0x00ff0000)) >>  8) | \
1119          (((U32)(x) & UINT32_C(0xff000000)) >> 24) ))
1120 
1121 # ifdef HAS_QUAD
1122 #  define _swab_64_(x) ((U64)( \
1123           (((U64)(x) & UINT64_C(0x00000000000000ff)) << 56) | \
1124           (((U64)(x) & UINT64_C(0x000000000000ff00)) << 40) | \
1125           (((U64)(x) & UINT64_C(0x0000000000ff0000)) << 24) | \
1126           (((U64)(x) & UINT64_C(0x00000000ff000000)) <<  8) | \
1127           (((U64)(x) & UINT64_C(0x000000ff00000000)) >>  8) | \
1128           (((U64)(x) & UINT64_C(0x0000ff0000000000)) >> 24) | \
1129           (((U64)(x) & UINT64_C(0x00ff000000000000)) >> 40) | \
1130           (((U64)(x) & UINT64_C(0xff00000000000000)) >> 56) ))
1131 # endif
1132 
1133 /* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
1134    at least on FreeBSD.  YMMV, so experiment.  */
1135 #ifndef PERL_ARENA_SIZE
1136 #define PERL_ARENA_SIZE 4080
1137 #endif
1138 
1139 /* Maximum level of recursion */
1140 #ifndef PERL_SUB_DEPTH_WARN
1141 #define PERL_SUB_DEPTH_WARN 100
1142 #endif
1143 
1144 #endif /* PERL_CORE */
1145 
1146 /* Maximum number of args that may be passed to an OP_MULTICONCAT op.
1147  * It determines the size of local arrays in S_maybe_multiconcat() and
1148  * pp_multiconcat().
1149  */
1150 #define PERL_MULTICONCAT_MAXARG 64
1151 
1152 /* The indexes of fields of a multiconcat aux struct.
1153  * The fixed fields are followed by nargs+1 const segment lengths,
1154  * and if utf8 and non-utf8 differ, a second nargs+1 set for utf8.
1155  */
1156 
1157 #define PERL_MULTICONCAT_IX_NARGS     0 /* number of arguments */
1158 #define PERL_MULTICONCAT_IX_PLAIN_PV  1 /* non-utf8 constant string */
1159 #define PERL_MULTICONCAT_IX_PLAIN_LEN 2 /* non-utf8 constant string length */
1160 #define PERL_MULTICONCAT_IX_UTF8_PV   3 /* utf8 constant string */
1161 #define PERL_MULTICONCAT_IX_UTF8_LEN  4 /* utf8 constant string length */
1162 #define PERL_MULTICONCAT_IX_LENGTHS   5 /* first of nargs+1 const segment lens */
1163 #define PERL_MULTICONCAT_HEADER_SIZE 5 /* The number of fields of a
1164                                            multiconcat header */
1165 
1166 /* We no longer default to creating a new SV for GvSV.
1167    Do this before embed.  */
1168 #ifndef PERL_CREATE_GVSV
1169 #  ifndef PERL_DONT_CREATE_GVSV
1170 #    define PERL_DONT_CREATE_GVSV
1171 #  endif
1172 #endif
1173 
1174 #if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
1175 #define PERL_USES_PL_PIDSTATUS
1176 #endif
1177 
1178 #if !defined(OS2) && !defined(WIN32) && !defined(DJGPP) && !defined(__SYMBIAN32__)
1179 #define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
1180 #endif
1181 
1182 #define MEM_SIZE Size_t
1183 
1184 /* Round all values passed to malloc up, by default to a multiple of
1185    sizeof(size_t)
1186 */
1187 #ifndef PERL_STRLEN_ROUNDUP_QUANTUM
1188 #define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
1189 #endif
1190 
1191 /* sv_grow() will expand strings by at least a certain percentage of
1192    the previously *used* length to avoid excessive calls to realloc().
1193    The default is 25% of the current length.
1194 */
1195 #ifndef PERL_STRLEN_EXPAND_SHIFT
1196 #  define PERL_STRLEN_EXPAND_SHIFT 2
1197 #endif
1198 
1199 /* This use of offsetof() requires /Zc:offsetof- for VS2017 (and presumably
1200  * onwards) when building Socket.xs, but we can just use a different definition
1201  * for STRUCT_OFFSET instead. */
1202 #if defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1910
1203 #  define STRUCT_OFFSET(s,m)  (Size_t)(&(((s *)0)->m))
1204 #else
1205 #  include <stddef.h>
1206 #  define STRUCT_OFFSET(s,m)  offsetof(s,m)
1207 #endif
1208 
1209 /* ptrdiff_t is C11, so undef it under pedantic builds.  (Actually it is
1210  * in C89, but apparently there are platforms where it doesn't exist.  See
1211  * thread beginning at http://nntp.perl.org/group/perl.perl5.porters/251541.)
1212  * */
1213 #ifdef PERL_GCC_PEDANTIC
1214 #   undef HAS_PTRDIFF_T
1215 #endif
1216 
1217 #ifdef HAS_PTRDIFF_T
1218 #  define Ptrdiff_t ptrdiff_t
1219 #else
1220 #  define Ptrdiff_t SSize_t
1221 #endif
1222 
1223 #ifndef __SYMBIAN32__
1224 #  include <string.h>
1225 #endif
1226 
1227 /* This comes after <stdlib.h> so we don't try to change the standard
1228  * library prototypes; we'll use our own in proto.h instead. */
1229 
1230 #ifdef MYMALLOC
1231 #  ifdef PERL_POLLUTE_MALLOC
1232 #   ifndef PERL_EXTMALLOC_DEF
1233 #    define Perl_malloc		malloc
1234 #    define Perl_calloc		calloc
1235 #    define Perl_realloc	realloc
1236 #    define Perl_mfree		free
1237 #   endif
1238 #  else
1239 #    define EMBEDMYMALLOC	/* for compatibility */
1240 #  endif
1241 
1242 #  define safemalloc  Perl_malloc
1243 #  define safecalloc  Perl_calloc
1244 #  define saferealloc Perl_realloc
1245 #  define safefree    Perl_mfree
1246 #  define CHECK_MALLOC_TOO_LATE_FOR_(code)	STMT_START {		\
1247 	if (!TAINTING_get && MallocCfg_ptr[MallocCfg_cfg_env_read])	\
1248 		code;							\
1249     } STMT_END
1250 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)				\
1251 	CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
1252 #  define panic_write2(s)		write(2, s, strlen(s))
1253 #  define CHECK_MALLOC_TAINT(newval)				\
1254 	CHECK_MALLOC_TOO_LATE_FOR_(				\
1255 		if (newval) {					\
1256 		  PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
1257 		  exit(1); })
1258 #  define MALLOC_CHECK_TAINT(argc,argv,env)	STMT_START {	\
1259 	if (doing_taint(argc,argv,env)) {			\
1260 		MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1;	\
1261     }} STMT_END;
1262 #else  /* MYMALLOC */
1263 #  define safemalloc  safesysmalloc
1264 #  define safecalloc  safesyscalloc
1265 #  define saferealloc safesysrealloc
1266 #  define safefree    safesysfree
1267 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)		((void)0)
1268 #  define CHECK_MALLOC_TAINT(newval)		((void)0)
1269 #  define MALLOC_CHECK_TAINT(argc,argv,env)
1270 #endif /* MYMALLOC */
1271 
1272 /* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
1273 #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)
1274 #define TOO_LATE_FOR(ch)	TOO_LATE_FOR_(ch, "")
1275 #define MALLOC_TOO_LATE_FOR(ch)	TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
1276 #define MALLOC_CHECK_TAINT2(argc,argv)	MALLOC_CHECK_TAINT(argc,argv,NULL)
1277 
1278 #ifndef memzero
1279 #   define memzero(d,l) memset(d,0,l)
1280 #endif
1281 
1282 #ifdef I_NETINET_IN
1283 #   include <netinet/in.h>
1284 #endif
1285 
1286 #ifdef I_ARPA_INET
1287 #   include <arpa/inet.h>
1288 #endif
1289 
1290 #ifdef I_SYS_STAT
1291 #   include <sys/stat.h>
1292 #endif
1293 
1294 /* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1295    This definition should ideally go into win32/win32.h, but S_IFIFO is
1296    used later here in perl.h before win32/win32.h is being included. */
1297 #if !defined(S_IFIFO) && defined(_S_IFIFO)
1298 #   define S_IFIFO _S_IFIFO
1299 #endif
1300 
1301 /* The stat macros for Unisoft System V/88 (and derivatives
1302    like UTekV) are broken, sometimes giving false positives.  Undefine
1303    them here and let the code below set them to proper values.
1304 
1305    The ghs macro stands for GreenHills Software C-1.8.5 which
1306    is the C compiler for sysV88 and the various derivatives.
1307    This header file bug is corrected in gcc-2.5.8 and later versions.
1308    --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94.  */
1309 
1310 #if defined(m88k) && defined(ghs)
1311 #   undef S_ISDIR
1312 #   undef S_ISCHR
1313 #   undef S_ISBLK
1314 #   undef S_ISREG
1315 #   undef S_ISFIFO
1316 #   undef S_ISLNK
1317 #endif
1318 
1319 #include <time.h>
1320 
1321 #ifdef I_SYS_TIME
1322 #   ifdef I_SYS_TIME_KERNEL
1323 #	define KERNEL
1324 #   endif
1325 #   include <sys/time.h>
1326 #   ifdef I_SYS_TIME_KERNEL
1327 #	undef KERNEL
1328 #   endif
1329 #endif
1330 
1331 #if defined(HAS_TIMES) && defined(I_SYS_TIMES)
1332 #    include <sys/times.h>
1333 #endif
1334 
1335 #include <errno.h>
1336 
1337 #if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
1338 #  define WIN32SCK_IS_STDSCK		/* don't pull in custom wsock layer */
1339 #endif
1340 
1341 #if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1342 # include <sys/socket.h>
1343 # if defined(USE_SOCKS) && defined(I_SOCKS)
1344 #   if !defined(INCLUDE_PROTOTYPES)
1345 #       define INCLUDE_PROTOTYPES /* for <socks.h> */
1346 #       define PERL_SOCKS_NEED_PROTOTYPES
1347 #   endif
1348 #   include <socks.h>
1349 #   ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1350 #       undef INCLUDE_PROTOTYPES
1351 #       undef PERL_SOCKS_NEED_PROTOTYPES
1352 #   endif
1353 # endif
1354 # ifdef I_NETDB
1355 #  ifdef NETWARE
1356 #   include<stdio.h>
1357 #  endif
1358 #  include <netdb.h>
1359 # endif
1360 # ifndef ENOTSOCK
1361 #  ifdef I_NET_ERRNO
1362 #   include <net/errno.h>
1363 #  endif
1364 # endif
1365 #endif
1366 
1367 /* sockatmark() is so new (2001) that many places might have it hidden
1368  * behind some -D_BLAH_BLAH_SOURCE guard.  The __THROW magic is required
1369  * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
1370 #if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
1371 # if defined(__THROW) && defined(__GLIBC__)
1372 int sockatmark(int) __THROW;
1373 # else
1374 int sockatmark(int);
1375 # endif
1376 #endif
1377 
1378 #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. */
1379 EXTERN_C int fchdir(int);
1380 EXTERN_C int flock(int, int);
1381 EXTERN_C int fseeko(FILE *, off_t, int);
1382 EXTERN_C off_t ftello(FILE *);
1383 #endif
1384 
1385 #if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1386 EXTERN_C char *crypt(const char *, const char *);
1387 #endif
1388 
1389 #if defined(__cplusplus) && defined(__CYGWIN__)
1390 EXTERN_C char *crypt(const char *, const char *);
1391 #endif
1392 
1393 /*
1394 =head1 Errno
1395 
1396 =for apidoc m|void|SETERRNO|int errcode|int vmserrcode
1397 
1398 Set C<errno>, and on VMS set C<vaxc$errno>.
1399 
1400 =for apidoc mn|void|dSAVEDERRNO
1401 
1402 Declare variables needed to save C<errno> and any operating system
1403 specific error number.
1404 
1405 =for apidoc mn|void|dSAVE_ERRNO
1406 
1407 Declare variables needed to save C<errno> and any operating system
1408 specific error number, and save them for optional later restoration
1409 by C<RESTORE_ERRNO>.
1410 
1411 =for apidoc mn|void|SAVE_ERRNO
1412 
1413 Save C<errno> and any operating system specific error number for
1414 optional later restoration by C<RESTORE_ERRNO>.  Requires
1415 C<dSAVEDERRNO> or C<dSAVE_ERRNO> in scope.
1416 
1417 =for apidoc mn|void|RESTORE_ERRNO
1418 
1419 Restore C<errno> and any operating system specific error number that
1420 was saved by C<dSAVE_ERRNO> or C<RESTORE_ERRNO>.
1421 
1422 =cut
1423 */
1424 
1425 #ifdef SETERRNO
1426 # undef SETERRNO  /* SOCKS might have defined this */
1427 #endif
1428 
1429 #ifdef VMS
1430 #   define SETERRNO(errcode,vmserrcode) \
1431 	STMT_START {			\
1432 	    set_errno(errcode);		\
1433 	    set_vaxc_errno(vmserrcode);	\
1434 	} STMT_END
1435 #   define dSAVEDERRNO    int saved_errno; unsigned saved_vms_errno
1436 #   define dSAVE_ERRNO    int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1437 #   define SAVE_ERRNO     ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1438 #   define RESTORE_ERRNO  SETERRNO(saved_errno, saved_vms_errno)
1439 
1440 #   define LIB_INVARG 		LIB$_INVARG
1441 #   define RMS_DIR    		RMS$_DIR
1442 #   define RMS_FAC    		RMS$_FAC
1443 #   define RMS_FEX    		RMS$_FEX
1444 #   define RMS_FNF    		RMS$_FNF
1445 #   define RMS_IFI    		RMS$_IFI
1446 #   define RMS_ISI    		RMS$_ISI
1447 #   define RMS_PRV    		RMS$_PRV
1448 #   define SS_ACCVIO      	SS$_ACCVIO
1449 #   define SS_DEVOFFLINE	SS$_DEVOFFLINE
1450 #   define SS_IVCHAN  		SS$_IVCHAN
1451 #   define SS_NORMAL  		SS$_NORMAL
1452 #   define SS_NOPRIV  		SS$_NOPRIV
1453 #   define SS_BUFFEROVF		SS$_BUFFEROVF
1454 #else
1455 #   define LIB_INVARG 		0
1456 #   define RMS_DIR    		0
1457 #   define RMS_FAC    		0
1458 #   define RMS_FEX    		0
1459 #   define RMS_FNF    		0
1460 #   define RMS_IFI    		0
1461 #   define RMS_ISI    		0
1462 #   define RMS_PRV    		0
1463 #   define SS_ACCVIO      	0
1464 #   define SS_DEVOFFLINE	0
1465 #   define SS_IVCHAN  		0
1466 #   define SS_NORMAL  		0
1467 #   define SS_NOPRIV  		0
1468 #   define SS_BUFFEROVF		0
1469 #endif
1470 
1471 #ifdef WIN32
1472 #   define dSAVEDERRNO  int saved_errno; DWORD saved_win32_errno
1473 #   define dSAVE_ERRNO  int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1474 #   define SAVE_ERRNO   ( saved_errno = errno, saved_win32_errno = GetLastError() )
1475 #   define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1476 #endif
1477 
1478 #ifdef OS2
1479 #   define dSAVEDERRNO  int saved_errno; unsigned long saved_os2_errno
1480 #   define dSAVE_ERRNO  int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1481 #   define SAVE_ERRNO   ( saved_errno = errno, saved_os2_errno = Perl_rc )
1482 #   define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1483 #endif
1484 
1485 #ifndef SETERRNO
1486 #   define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1487 #endif
1488 
1489 #ifndef dSAVEDERRNO
1490 #   define dSAVEDERRNO    int saved_errno
1491 #   define dSAVE_ERRNO    int saved_errno = errno
1492 #   define SAVE_ERRNO     (saved_errno = errno)
1493 #   define RESTORE_ERRNO  (errno = saved_errno)
1494 #endif
1495 
1496 /*
1497 =head1 Warning and Dieing
1498 
1499 =for apidoc Amn|SV *|ERRSV
1500 
1501 Returns the SV for C<$@>, creating it if needed.
1502 
1503 =for apidoc Am|void|CLEAR_ERRSV
1504 
1505 Clear the contents of C<$@>, setting it to the empty string.
1506 
1507 This replaces any read-only SV with a fresh SV and removes any magic.
1508 
1509 =for apidoc Am|void|SANE_ERRSV
1510 
1511 Clean up ERRSV so we can safely set it.
1512 
1513 This replaces any read-only SV with a fresh writable copy and removes
1514 any magic.
1515 
1516 =cut
1517 */
1518 
1519 #define ERRSV GvSVn(PL_errgv)
1520 
1521 /* contains inlined gv_add_by_type */
1522 #define CLEAR_ERRSV() STMT_START {					\
1523     SV ** const svp = &GvSV(PL_errgv);					\
1524     if (!*svp) {							\
1525         *svp = newSVpvs("");                                            \
1526     } else if (SvREADONLY(*svp)) {					\
1527 	SvREFCNT_dec_NN(*svp);						\
1528 	*svp = newSVpvs("");						\
1529     } else {								\
1530 	SV *const errsv = *svp;						\
1531         SvPVCLEAR(errsv);                                               \
1532 	SvPOK_only(errsv);						\
1533 	if (SvMAGICAL(errsv)) {						\
1534 	    mg_free(errsv);						\
1535 	}								\
1536     }									\
1537     } STMT_END
1538 
1539 /* contains inlined gv_add_by_type */
1540 #define SANE_ERRSV() STMT_START {					\
1541     SV ** const svp = &GvSV(PL_errgv);					\
1542     if (!*svp) {							\
1543         *svp = newSVpvs("");                                            \
1544     } else if (SvREADONLY(*svp)) {					\
1545         SV *dupsv = newSVsv(*svp);					\
1546 	SvREFCNT_dec_NN(*svp);						\
1547 	*svp = dupsv;							\
1548     } else {								\
1549 	SV *const errsv = *svp;						\
1550 	if (SvMAGICAL(errsv)) {						\
1551 	    mg_free(errsv);						\
1552 	}								\
1553     }									\
1554     } STMT_END
1555 
1556 
1557 #ifdef PERL_CORE
1558 # define DEFSV (0 + GvSVn(PL_defgv))
1559 # define DEFSV_set(sv) \
1560     (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1561 # define SAVE_DEFSV                \
1562     (                               \
1563 	save_gp(PL_defgv, 0),        \
1564 	GvINTRO_off(PL_defgv),        \
1565 	SAVEGENERICSV(GvSV(PL_defgv)), \
1566 	GvSV(PL_defgv) = NULL           \
1567     )
1568 #else
1569 # define DEFSV GvSVn(PL_defgv)
1570 # define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1571 # define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
1572 #endif
1573 
1574 #ifndef errno
1575 	extern int errno;     /* ANSI allows errno to be an lvalue expr.
1576 			       * For example in multithreaded environments
1577 			       * something like this might happen:
1578 			       * extern int *_errno(void);
1579 			       * #define errno (*_errno()) */
1580 #endif
1581 
1582 #define UNKNOWN_ERRNO_MSG "(unknown)"
1583 
1584 #ifdef VMS
1585 #define Strerror(e) strerror((e), vaxc$errno)
1586 #else
1587 #define Strerror(e) strerror(e)
1588 #endif
1589 
1590 #ifdef I_SYS_IOCTL
1591 #   ifndef _IOCTL_
1592 #	include <sys/ioctl.h>
1593 #   endif
1594 #endif
1595 
1596 #if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
1597 #   ifdef HAS_SOCKETPAIR
1598 #	undef HAS_SOCKETPAIR
1599 #   endif
1600 #   ifdef I_NDBM
1601 #	undef I_NDBM
1602 #   endif
1603 #endif
1604 
1605 #ifndef HAS_SOCKETPAIR
1606 #   ifdef HAS_SOCKET
1607 #	define socketpair Perl_my_socketpair
1608 #   endif
1609 #endif
1610 
1611 #if INTSIZE == 2
1612 #   define htoni htons
1613 #   define ntohi ntohs
1614 #else
1615 #   define htoni htonl
1616 #   define ntohi ntohl
1617 #endif
1618 
1619 /* Configure already sets Direntry_t */
1620 #if defined(I_DIRENT)
1621 #  include <dirent.h>
1622 #elif defined(I_SYS_NDIR)
1623 #  include <sys/ndir.h>
1624 #elif defined(I_SYS_DIR)
1625 #  include <sys/dir.h>
1626 #endif
1627 
1628 /*
1629  * The following gobbledygook brought to you on behalf of __STDC__.
1630  * (I could just use #ifndef __STDC__, but this is more bulletproof
1631  * in the face of half-implementations.)
1632  */
1633 
1634 #if defined(I_SYSMODE)
1635 #include <sys/mode.h>
1636 #endif
1637 
1638 #ifndef S_IFMT
1639 #   ifdef _S_IFMT
1640 #	define S_IFMT _S_IFMT
1641 #   else
1642 #	define S_IFMT 0170000
1643 #   endif
1644 #endif
1645 
1646 #ifndef S_ISDIR
1647 #   define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1648 #endif
1649 
1650 #ifndef S_ISCHR
1651 #   define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1652 #endif
1653 
1654 #ifndef S_ISBLK
1655 #   ifdef S_IFBLK
1656 #	define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1657 #   else
1658 #	define S_ISBLK(m) (0)
1659 #   endif
1660 #endif
1661 
1662 #ifndef S_ISREG
1663 #   define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1664 #endif
1665 
1666 #ifndef S_ISFIFO
1667 #   ifdef S_IFIFO
1668 #	define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1669 #   else
1670 #	define S_ISFIFO(m) (0)
1671 #   endif
1672 #endif
1673 
1674 #ifndef S_ISLNK
1675 #  ifdef _S_ISLNK
1676 #    define S_ISLNK(m) _S_ISLNK(m)
1677 #  elif defined(_S_IFLNK)
1678 #    define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1679 #  elif defined(S_IFLNK)
1680 #    define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1681 #  else
1682 #    define S_ISLNK(m) (0)
1683 #  endif
1684 #endif
1685 
1686 #ifndef S_ISSOCK
1687 #  ifdef _S_ISSOCK
1688 #    define S_ISSOCK(m) _S_ISSOCK(m)
1689 #  elif defined(_S_IFSOCK)
1690 #    define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1691 #  elif defined(S_IFSOCK)
1692 #    define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1693 #  else
1694 #    define S_ISSOCK(m) (0)
1695 #  endif
1696 #endif
1697 
1698 #ifndef S_IRUSR
1699 #   ifdef S_IREAD
1700 #	define S_IRUSR S_IREAD
1701 #	define S_IWUSR S_IWRITE
1702 #	define S_IXUSR S_IEXEC
1703 #   else
1704 #	define S_IRUSR 0400
1705 #	define S_IWUSR 0200
1706 #	define S_IXUSR 0100
1707 #   endif
1708 #endif
1709 
1710 #ifndef S_IRGRP
1711 #   ifdef S_IRUSR
1712 #       define S_IRGRP (S_IRUSR>>3)
1713 #       define S_IWGRP (S_IWUSR>>3)
1714 #       define S_IXGRP (S_IXUSR>>3)
1715 #   else
1716 #       define S_IRGRP 0040
1717 #       define S_IWGRP 0020
1718 #       define S_IXGRP 0010
1719 #   endif
1720 #endif
1721 
1722 #ifndef S_IROTH
1723 #   ifdef S_IRUSR
1724 #       define S_IROTH (S_IRUSR>>6)
1725 #       define S_IWOTH (S_IWUSR>>6)
1726 #       define S_IXOTH (S_IXUSR>>6)
1727 #   else
1728 #       define S_IROTH 0040
1729 #       define S_IWOTH 0020
1730 #       define S_IXOTH 0010
1731 #   endif
1732 #endif
1733 
1734 #ifndef S_ISUID
1735 #   define S_ISUID 04000
1736 #endif
1737 
1738 #ifndef S_ISGID
1739 #   define S_ISGID 02000
1740 #endif
1741 
1742 #ifndef S_IRWXU
1743 #   define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
1744 #endif
1745 
1746 #ifndef S_IRWXG
1747 #   define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
1748 #endif
1749 
1750 #ifndef S_IRWXO
1751 #   define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
1752 #endif
1753 
1754 /* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
1755  * which would get included through <sys/file.h >, but that is 3000
1756  * lines in the future.  --jhi */
1757 
1758 #if !defined(S_IREAD) && !defined(__HAIKU__)
1759 #   define S_IREAD S_IRUSR
1760 #endif
1761 
1762 #if !defined(S_IWRITE) && !defined(__HAIKU__)
1763 #   define S_IWRITE S_IWUSR
1764 #endif
1765 
1766 #ifndef S_IEXEC
1767 #   define S_IEXEC S_IXUSR
1768 #endif
1769 
1770 #if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
1771 #   define SLOPPYDIVIDE
1772 #endif
1773 
1774 #ifdef UV
1775 #undef UV
1776 #endif
1777 
1778 /* This used to be conditionally defined based on whether we had a sprintf()
1779  * that correctly returns the string length (as required by C89), but we no
1780  * longer need that. XS modules can (and do) use this name, so it must remain
1781  * a part of the API that's visible to modules.
1782 
1783 =head1 Miscellaneous Functions
1784 
1785 =for apidoc ATmD|int|my_sprintf|NN char *buffer|NN const char *pat|...
1786 
1787 Do NOT use this due to the possibility of overflowing C<buffer>.  Instead use
1788 my_snprintf()
1789 
1790 =cut
1791 */
1792 #define my_sprintf sprintf
1793 
1794 /*
1795  * If we have v?snprintf() and the C99 variadic macros, we can just
1796  * use just the v?snprintf().  It is nice to try to trap the buffer
1797  * overflow, however, so if we are DEBUGGING, and we cannot use the
1798  * gcc statement expressions, then use the function wrappers which try
1799  * to trap the overflow.  If we can use the gcc statement expressions,
1800  * we can try that even with the version that uses the C99 variadic
1801  * macros.
1802  */
1803 
1804 /* Note that we do not check against snprintf()/vsnprintf() returning
1805  * negative values because that is non-standard behaviour and we use
1806  * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1807  * that should be true only if the snprintf()/vsnprintf() are true
1808  * to the standard. */
1809 
1810 #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
1811 
1812 #ifdef USE_QUADMATH
1813 #  define my_snprintf Perl_my_snprintf
1814 #  define PERL_MY_SNPRINTF_GUARDED
1815 #elif defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1816 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1817 #      define my_snprintf(buffer, max, ...) ({ int len = snprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, snprintf); len; })
1818 #      define PERL_MY_SNPRINTF_GUARDED
1819 #  else
1820 #    define my_snprintf(buffer, max, ...) snprintf(buffer, max, __VA_ARGS__)
1821 #  endif
1822 #else
1823 #  define my_snprintf  Perl_my_snprintf
1824 #  define PERL_MY_SNPRINTF_GUARDED
1825 #endif
1826 
1827 /* There is no quadmath_vsnprintf, and therefore my_vsnprintf()
1828  * dies if called under USE_QUADMATH. */
1829 #if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1830 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1831 #      define my_vsnprintf(buffer, max, ...) ({ int len = vsnprintf(buffer, max, __VA_ARGS__); PERL_SNPRINTF_CHECK(len, max, vsnprintf); len; })
1832 #      define PERL_MY_VSNPRINTF_GUARDED
1833 #  else
1834 #    define my_vsnprintf(buffer, max, ...) vsnprintf(buffer, max, __VA_ARGS__)
1835 #  endif
1836 #else
1837 #  define my_vsnprintf Perl_my_vsnprintf
1838 #  define PERL_MY_VSNPRINTF_GUARDED
1839 #endif
1840 
1841 /* You will definitely need to use the PERL_MY_SNPRINTF_POST_GUARD()
1842  * or PERL_MY_VSNPRINTF_POST_GUARD() if you otherwise decide to ignore
1843  * the result of my_snprintf() or my_vsnprintf().  (No, you should not
1844  * completely ignore it: otherwise you cannot know whether your output
1845  * was too long.)
1846  *
1847  * int len = my_sprintf(buf, max, ...);
1848  * PERL_MY_SNPRINTF_POST_GUARD(len, max);
1849  *
1850  * The trick is that in certain platforms [a] the my_sprintf() already
1851  * contains the sanity check, while in certain platforms [b] it needs
1852  * to be done as a separate step.  The POST_GUARD is that step-- in [a]
1853  * platforms the POST_GUARD actually does nothing since the check has
1854  * already been done.  Watch out for the max being the same in both calls.
1855  *
1856  * If you actually use the snprintf/vsnprintf return value already,
1857  * you assumedly are checking its validity somehow.  But you can
1858  * insert the POST_GUARD() also in that case. */
1859 
1860 #ifndef PERL_MY_SNPRINTF_GUARDED
1861 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, snprintf)
1862 #else
1863 #  define PERL_MY_SNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1864 #endif
1865 
1866 #ifndef  PERL_MY_VSNPRINTF_GUARDED
1867 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_SNPRINTF_CHECK(len, max, vsnprintf)
1868 #else
1869 #  define PERL_MY_VSNPRINTF_POST_GUARD(len, max) PERL_UNUSED_VAR(len)
1870 #endif
1871 
1872 #ifdef HAS_STRLCAT
1873 #  define my_strlcat    strlcat
1874 #endif
1875 
1876 #if defined(PERL_CORE) || defined(PERL_EXT)
1877 #  ifdef HAS_MEMRCHR
1878 #    define my_memrchr	memrchr
1879 #  else
1880 #    define my_memrchr	S_my_memrchr
1881 #  endif
1882 #endif
1883 
1884 #ifdef HAS_STRLCPY
1885 #  define my_strlcpy	strlcpy
1886 #endif
1887 
1888 #ifdef HAS_STRNLEN
1889 #  define my_strnlen	strnlen
1890 #endif
1891 
1892 /*
1893     The IV type is supposed to be long enough to hold any integral
1894     value or a pointer.
1895     --Andy Dougherty	August 1996
1896 */
1897 
1898 typedef IVTYPE IV;
1899 typedef UVTYPE UV;
1900 
1901 #if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
1902 #  if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
1903 #    define IV_MAX ((IV)INT64_MAX)
1904 #    define IV_MIN ((IV)INT64_MIN)
1905 #    define UV_MAX ((UV)UINT64_MAX)
1906 #    ifndef UINT64_MIN
1907 #      define UINT64_MIN 0
1908 #    endif
1909 #    define UV_MIN ((UV)UINT64_MIN)
1910 #  else
1911 #    define IV_MAX PERL_QUAD_MAX
1912 #    define IV_MIN PERL_QUAD_MIN
1913 #    define UV_MAX PERL_UQUAD_MAX
1914 #    define UV_MIN PERL_UQUAD_MIN
1915 #  endif
1916 #  define IV_IS_QUAD
1917 #  define UV_IS_QUAD
1918 #else
1919 #  if defined(INT32_MAX) && IVSIZE == 4
1920 #    define IV_MAX ((IV)INT32_MAX)
1921 #    define IV_MIN ((IV)INT32_MIN)
1922 #    ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
1923 #        define UV_MAX ((UV)UINT32_MAX)
1924 #    else
1925 #        define UV_MAX ((UV)4294967295U)
1926 #    endif
1927 #    ifndef UINT32_MIN
1928 #      define UINT32_MIN 0
1929 #    endif
1930 #    define UV_MIN ((UV)UINT32_MIN)
1931 #  else
1932 #    define IV_MAX PERL_LONG_MAX
1933 #    define IV_MIN PERL_LONG_MIN
1934 #    define UV_MAX PERL_ULONG_MAX
1935 #    define UV_MIN PERL_ULONG_MIN
1936 #  endif
1937 #  if IVSIZE == 8
1938 #    define IV_IS_QUAD
1939 #    define UV_IS_QUAD
1940 #    ifndef HAS_QUAD
1941 #      define HAS_QUAD
1942 #    endif
1943 #  else
1944 #    undef IV_IS_QUAD
1945 #    undef UV_IS_QUAD
1946 #if !defined(PERL_CORE)
1947 /* We think that removing this decade-old undef this will cause too much
1948    breakage on CPAN for too little gain. (See RT #119753)
1949    However, we do need HAS_QUAD in the core for use by the drand48 code. */
1950 #    undef HAS_QUAD
1951 #endif
1952 #  endif
1953 #endif
1954 
1955 #define Size_t_MAX (~(Size_t)0)
1956 #define SSize_t_MAX (SSize_t)(~(Size_t)0 >> 1)
1957 
1958 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
1959 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
1960 
1961 #ifndef NO_PERL_PRESERVE_IVUV
1962 #define PERL_PRESERVE_IVUV	/* We like our integers to stay integers. */
1963 #endif
1964 
1965 /*
1966  *  The macros INT2PTR and NUM2PTR are (despite their names)
1967  *  bi-directional: they will convert int/float to or from pointers.
1968  *  However the conversion to int/float are named explicitly:
1969  *  PTR2IV, PTR2UV, PTR2NV.
1970  *
1971  *  For int conversions we do not need two casts if pointers are
1972  *  the same size as IV and UV.   Otherwise we need an explicit
1973  *  cast (PTRV) to avoid compiler warnings.
1974  */
1975 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1976 #  define PTRV			UV
1977 #  define INT2PTR(any,d)	(any)(d)
1978 #elif PTRSIZE == LONGSIZE
1979 #  define PTRV			unsigned long
1980 #  define PTR2ul(p)		(unsigned long)(p)
1981 #else
1982 #  define PTRV			unsigned
1983 #endif
1984 
1985 #ifndef INT2PTR
1986 #  define INT2PTR(any,d)	(any)(PTRV)(d)
1987 #endif
1988 
1989 #ifndef PTR2ul
1990 #  define PTR2ul(p)	INT2PTR(unsigned long,p)
1991 #endif
1992 
1993 #define NUM2PTR(any,d)	(any)(PTRV)(d)
1994 #define PTR2IV(p)	INT2PTR(IV,p)
1995 #define PTR2UV(p)	INT2PTR(UV,p)
1996 #define PTR2NV(p)	NUM2PTR(NV,p)
1997 #define PTR2nat(p)	(PTRV)(p)	/* pointer to integer of PTRSIZE */
1998 
1999 /* According to strict ANSI C89 one cannot freely cast between
2000  * data pointers and function (code) pointers.  There are at least
2001  * two ways around this.  One (used below) is to do two casts,
2002  * first the other pointer to an (unsigned) integer, and then
2003  * the integer to the other pointer.  The other way would be
2004  * to use unions to "overlay" the pointers.  For an example of
2005  * the latter technique, see union dirpu in struct xpvio in sv.h.
2006  * The only feasible use is probably temporarily storing
2007  * function pointers in a data pointer (such as a void pointer). */
2008 
2009 #define DPTR2FPTR(t,p) ((t)PTR2nat(p))	/* data pointer to function pointer */
2010 #define FPTR2DPTR(t,p) ((t)PTR2nat(p))	/* function pointer to data pointer */
2011 
2012 #ifdef USE_LONG_DOUBLE
2013 #  if LONG_DOUBLESIZE == DOUBLESIZE
2014 #    define LONG_DOUBLE_EQUALS_DOUBLE
2015 #    undef USE_LONG_DOUBLE /* Ouch! */
2016 #  endif
2017 #endif
2018 
2019 /* The following is all to get LDBL_DIG, in order to pick a nice
2020    default value for printing floating point numbers in Gconvert.
2021    (see config.h)
2022 */
2023 #ifndef HAS_LDBL_DIG
2024 #  if LONG_DOUBLESIZE == 10
2025 #    define LDBL_DIG 18 /* assume IEEE */
2026 #  elif LONG_DOUBLESIZE == 12
2027 #    define LDBL_DIG 18 /* gcc? */
2028 #  elif LONG_DOUBLESIZE == 16
2029 #    define LDBL_DIG 33 /* assume IEEE */
2030 #  elif LONG_DOUBLESIZE == DOUBLESIZE
2031 #    define LDBL_DIG DBL_DIG /* bummer */
2032 #  endif
2033 #endif
2034 
2035 typedef NVTYPE NV;
2036 
2037 #ifdef I_IEEEFP
2038 #   include <ieeefp.h>
2039 #endif
2040 
2041 #if defined(__DECC) && defined(__osf__)
2042 /* Also Tru64 cc has broken NaN comparisons. */
2043 #  define NAN_COMPARE_BROKEN
2044 #endif
2045 #if defined(__sgi)
2046 #  define NAN_COMPARE_BROKEN
2047 #endif
2048 
2049 #ifdef USE_LONG_DOUBLE
2050 #   ifdef I_SUNMATH
2051 #       include <sunmath.h>
2052 #   endif
2053 #   if defined(LDBL_DIG)
2054 #       define NV_DIG LDBL_DIG
2055 #       ifdef LDBL_MANT_DIG
2056 #           define NV_MANT_DIG LDBL_MANT_DIG
2057 #       endif
2058 #       ifdef LDBL_MIN
2059 #           define NV_MIN LDBL_MIN
2060 #       endif
2061 #       ifdef LDBL_MAX
2062 #           define NV_MAX LDBL_MAX
2063 #       endif
2064 #       ifdef LDBL_MIN_EXP
2065 #           define NV_MIN_EXP LDBL_MIN_EXP
2066 #       endif
2067 #       ifdef LDBL_MAX_EXP
2068 #           define NV_MAX_EXP LDBL_MAX_EXP
2069 #       endif
2070 #       ifdef LDBL_MIN_10_EXP
2071 #           define NV_MIN_10_EXP LDBL_MIN_10_EXP
2072 #       endif
2073 #       ifdef LDBL_MAX_10_EXP
2074 #           define NV_MAX_10_EXP LDBL_MAX_10_EXP
2075 #       endif
2076 #       ifdef LDBL_EPSILON
2077 #           define NV_EPSILON LDBL_EPSILON
2078 #       endif
2079 #       ifdef LDBL_MAX
2080 #           define NV_MAX LDBL_MAX
2081 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
2082 #       elif defined(HUGE_VALL)
2083 #           define NV_MAX HUGE_VALL
2084 #       endif
2085 #   endif
2086 #   if defined(HAS_SQRTL)
2087 #       define Perl_acos acosl
2088 #       define Perl_asin asinl
2089 #       define Perl_atan atanl
2090 #       define Perl_atan2 atan2l
2091 #       define Perl_ceil ceill
2092 #       define Perl_cos cosl
2093 #       define Perl_cosh coshl
2094 #       define Perl_exp expl
2095 /* no Perl_fabs, but there's PERL_ABS */
2096 #       define Perl_floor floorl
2097 #       define Perl_fmod fmodl
2098 #       define Perl_log logl
2099 #       define Perl_log10 log10l
2100 #       define Perl_pow powl
2101 #       define Perl_sin sinl
2102 #       define Perl_sinh sinhl
2103 #       define Perl_sqrt sqrtl
2104 #       define Perl_tan tanl
2105 #       define Perl_tanh tanhl
2106 #   endif
2107 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
2108 #   ifndef Perl_modf
2109 #       ifdef HAS_MODFL
2110 #           define Perl_modf(x,y) modfl(x,y)
2111 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
2112    prototype in <math.h> */
2113 #           ifndef HAS_MODFL_PROTO
2114 EXTERN_C long double modfl(long double, long double *);
2115 #	    endif
2116 #       elif (defined(HAS_TRUNCL) || defined(HAS_AINTL)) && defined(HAS_COPYSIGNL)
2117         extern long double Perl_my_modfl(long double x, long double *ip);
2118 #           define Perl_modf(x,y) Perl_my_modfl(x,y)
2119 #       endif
2120 #   endif
2121 #   ifndef Perl_frexp
2122 #       ifdef HAS_FREXPL
2123 #           define Perl_frexp(x,y) frexpl(x,y)
2124 #       elif defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
2125 extern long double Perl_my_frexpl(long double x, int *e);
2126 #           define Perl_frexp(x,y) Perl_my_frexpl(x,y)
2127 #       endif
2128 #   endif
2129 #   ifndef Perl_ldexp
2130 #       ifdef HAS_LDEXPL
2131 #           define Perl_ldexp(x, y) ldexpl(x,y)
2132 #       elif defined(HAS_SCALBNL) && FLT_RADIX == 2
2133 #           define Perl_ldexp(x,y) scalbnl(x,y)
2134 #       endif
2135 #   endif
2136 #   ifndef Perl_isnan
2137 #       if defined(HAS_ISNANL) && !(defined(isnan) && defined(HAS_C99))
2138 #           define Perl_isnan(x) isnanl(x)
2139 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
2140 #           define Perl_isnan(x) isnan(x)
2141 #       endif
2142 #   endif
2143 #   ifndef Perl_isinf
2144 #       if defined(HAS_ISINFL) && !(defined(isinf) && defined(HAS_C99))
2145 #           define Perl_isinf(x) isinfl(x)
2146 #       elif defined(__sgi) && defined(__c99)  /* XXX Configure test needed */
2147 #           define Perl_isinf(x) isinf(x)
2148 #       elif defined(LDBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2149 #           define Perl_isinf(x) ((x) > LDBL_MAX || (x) < -LDBL_MAX)
2150 #       endif
2151 #   endif
2152 #   ifndef Perl_isfinite
2153 #       define Perl_isfinite(x) Perl_isfinitel(x)
2154 #   endif
2155 #elif defined(USE_QUADMATH) && defined(I_QUADMATH)
2156 #   include <quadmath.h>
2157 #   define NV_DIG FLT128_DIG
2158 #   define NV_MANT_DIG FLT128_MANT_DIG
2159 #   define NV_MIN FLT128_MIN
2160 #   define NV_MAX FLT128_MAX
2161 #   define NV_MIN_EXP FLT128_MIN_EXP
2162 #   define NV_MAX_EXP FLT128_MAX_EXP
2163 #   define NV_EPSILON FLT128_EPSILON
2164 #   define NV_MIN_10_EXP FLT128_MIN_10_EXP
2165 #   define NV_MAX_10_EXP FLT128_MAX_10_EXP
2166 #   define Perl_acos acosq
2167 #   define Perl_asin asinq
2168 #   define Perl_atan atanq
2169 #   define Perl_atan2 atan2q
2170 #   define Perl_ceil ceilq
2171 #   define Perl_cos cosq
2172 #   define Perl_cosh coshq
2173 #   define Perl_exp expq
2174 /* no Perl_fabs, but there's PERL_ABS */
2175 #   define Perl_floor floorq
2176 #   define Perl_fmod fmodq
2177 #   define Perl_log logq
2178 #   define Perl_log10 log10q
2179 #   define Perl_signbit signbitq
2180 #   define Perl_pow powq
2181 #   define Perl_sin sinq
2182 #   define Perl_sinh sinhq
2183 #   define Perl_sqrt sqrtq
2184 #   define Perl_tan tanq
2185 #   define Perl_tanh tanhq
2186 #   define Perl_modf(x,y) modfq(x,y)
2187 #   define Perl_frexp(x,y) frexpq(x,y)
2188 #   define Perl_ldexp(x, y) ldexpq(x,y)
2189 #   define Perl_isinf(x) isinfq(x)
2190 #   define Perl_isnan(x) isnanq(x)
2191 #   define Perl_isfinite(x) !(isnanq(x) || isinfq(x))
2192 #   define Perl_fp_class(x) ((x) == 0.0Q ? 0 : isinfq(x) ? 3 : isnanq(x) ? 4 : PERL_ABS(x) < FLT128_MIN ? 2 : 1)
2193 #   define Perl_fp_class_inf(x)    (Perl_fp_class(x) == 3)
2194 #   define Perl_fp_class_nan(x)    (Perl_fp_class(x) == 4)
2195 #   define Perl_fp_class_norm(x)   (Perl_fp_class(x) == 1)
2196 #   define Perl_fp_class_denorm(x) (Perl_fp_class(x) == 2)
2197 #   define Perl_fp_class_zero(x)   (Perl_fp_class(x) == 0)
2198 #else
2199 #   define NV_DIG DBL_DIG
2200 #   define NV_MANT_DIG DBL_MANT_DIG
2201 #   define NV_MIN DBL_MIN
2202 #   define NV_MAX DBL_MAX
2203 #   define NV_MIN_EXP DBL_MIN_EXP
2204 #   define NV_MAX_EXP DBL_MAX_EXP
2205 #   define NV_MIN_10_EXP DBL_MIN_10_EXP
2206 #   define NV_MAX_10_EXP DBL_MAX_10_EXP
2207 #   define NV_EPSILON DBL_EPSILON
2208 #   define NV_MAX DBL_MAX
2209 #   define NV_MIN DBL_MIN
2210 
2211 /* These math interfaces are C89. */
2212 #   define Perl_acos acos
2213 #   define Perl_asin asin
2214 #   define Perl_atan atan
2215 #   define Perl_atan2 atan2
2216 #   define Perl_ceil ceil
2217 #   define Perl_cos cos
2218 #   define Perl_cosh cosh
2219 #   define Perl_exp exp
2220 /* no Perl_fabs, but there's PERL_ABS */
2221 #   define Perl_floor floor
2222 #   define Perl_fmod fmod
2223 #   define Perl_log log
2224 #   define Perl_log10 log10
2225 #   define Perl_pow pow
2226 #   define Perl_sin sin
2227 #   define Perl_sinh sinh
2228 #   define Perl_sqrt sqrt
2229 #   define Perl_tan tan
2230 #   define Perl_tanh tanh
2231 
2232 #   define Perl_modf(x,y) modf(x,y)
2233 #   define Perl_frexp(x,y) frexp(x,y)
2234 #   define Perl_ldexp(x,y) ldexp(x,y)
2235 
2236 #   ifndef Perl_isnan
2237 #       ifdef HAS_ISNAN
2238 #           define Perl_isnan(x) isnan(x)
2239 #       endif
2240 #   endif
2241 #   ifndef Perl_isinf
2242 #       if defined(HAS_ISINF)
2243 #           define Perl_isinf(x) isinf(x)
2244 #       elif defined(DBL_MAX) && !defined(NAN_COMPARE_BROKEN)
2245 #           define Perl_isinf(x) ((x) > DBL_MAX || (x) < -DBL_MAX)
2246 #       endif
2247 #   endif
2248 #   ifndef Perl_isfinite
2249 #     ifdef HAS_ISFINITE
2250 #       define Perl_isfinite(x) isfinite(x)
2251 #     elif defined(HAS_FINITE)
2252 #       define Perl_isfinite(x) finite(x)
2253 #     endif
2254 #   endif
2255 #endif
2256 
2257 /* fpclassify(): C99.  It is supposed to be a macro that switches on
2258 * the sizeof() of its argument, so there's no need for e.g. fpclassifyl().*/
2259 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2260 #    include <math.h>
2261 #    if defined(FP_INFINITE) && defined(FP_NAN)
2262 #        define Perl_fp_class(x)	fpclassify(x)
2263 #        define Perl_fp_class_inf(x)	(Perl_fp_class(x)==FP_INFINITE)
2264 #        define Perl_fp_class_nan(x)	(Perl_fp_class(x)==FP_NAN)
2265 #        define Perl_fp_class_norm(x)	(Perl_fp_class(x)==FP_NORMAL)
2266 #        define Perl_fp_class_denorm(x)	(Perl_fp_class(x)==FP_SUBNORMAL)
2267 #        define Perl_fp_class_zero(x)	(Perl_fp_class(x)==FP_ZERO)
2268 #    elif defined(FP_PLUS_INF) && defined(FP_QNAN)
2269 /* Some versions of HP-UX (10.20) have (only) fpclassify() but which is
2270  * actually not the C99 fpclassify, with its own set of return defines. */
2271 #        define Perl_fp_class(x)	fpclassify(x)
2272 #        define Perl_fp_class_pinf(x)	(Perl_fp_class(x)==FP_PLUS_INF)
2273 #        define Perl_fp_class_ninf(x)	(Perl_fp_class(x)==FP_MINUS_INF)
2274 #        define Perl_fp_class_snan(x)	(Perl_fp_class(x)==FP_SNAN)
2275 #        define Perl_fp_class_qnan(x)	(Perl_fp_class(x)==FP_QNAN)
2276 #        define Perl_fp_class_pnorm(x)	(Perl_fp_class(x)==FP_PLUS_NORM)
2277 #        define Perl_fp_class_nnorm(x)	(Perl_fp_class(x)==FP_MINUS_NORM)
2278 #        define Perl_fp_class_pdenorm(x)	(Perl_fp_class(x)==FP_PLUS_DENORM)
2279 #        define Perl_fp_class_ndenorm(x)	(Perl_fp_class(x)==FP_MINUS_DENORM)
2280 #        define Perl_fp_class_pzero(x)	(Perl_fp_class(x)==FP_PLUS_ZERO)
2281 #        define Perl_fp_class_nzero(x)	(Perl_fp_class(x)==FP_MINUS_ZERO)
2282 #    else
2283 #        undef Perl_fp_class /* Unknown set of defines */
2284 #    endif
2285 #endif
2286 
2287 /* fp_classify(): Legacy: VMS, maybe Unicos? The values, however,
2288  * are identical to the C99 fpclassify(). */
2289 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASSIFY)
2290 #    include <math.h>
2291 #    ifdef __VMS
2292      /* FP_INFINITE and others are here rather than in math.h as C99 stipulates */
2293 #        include <fp.h>
2294      /* oh, and the isnormal macro has a typo in it! */
2295 #    undef isnormal
2296 #    define isnormal(x) Perl_fp_class_norm(x)
2297 #    endif
2298 #    if defined(FP_INFINITE) && defined(FP_NAN)
2299 #        define Perl_fp_class(x)	fp_classify(x)
2300 #        define Perl_fp_class_inf(x)	(Perl_fp_class(x)==FP_INFINITE)
2301 #        define Perl_fp_class_nan(x)	(Perl_fp_class(x)==FP_NAN)
2302 #        define Perl_fp_class_norm(x)	(Perl_fp_class(x)==FP_NORMAL)
2303 #        define Perl_fp_class_denorm(x)	(Perl_fp_class(x)==FP_SUBNORMAL)
2304 #        define Perl_fp_class_zero(x)	(Perl_fp_class(x)==FP_ZERO)
2305 #    else
2306 #        undef Perl_fp_class /* Unknown set of defines */
2307 #    endif
2308 #endif
2309 
2310 /* Feel free to check with me for the SGI manpages, SGI testing,
2311  * etcetera, if you want to try getting this to work with IRIX.
2312  *
2313  * - Allen <allens@cpan.org> */
2314 
2315 /* fpclass(): SysV, at least Solaris and some versions of IRIX. */
2316 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
2317 /* Solaris and IRIX have fpclass/fpclassl, but they are using
2318  * an enum typedef, not cpp symbols, and Configure doesn't detect that.
2319  * Define some symbols also as cpp symbols so we can detect them. */
2320 #    if defined(__sun) || defined(__sgi) /* XXX Configure test instead */
2321 #     define FP_PINF FP_PINF
2322 #     define FP_QNAN FP_QNAN
2323 #    endif
2324 #    include <math.h>
2325 #    ifdef I_IEEFP
2326 #        include <ieeefp.h>
2327 #    endif
2328 #    ifdef I_FP
2329 #        include <fp.h>
2330 #    endif
2331 #    if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
2332 #        define Perl_fp_class(x)	fpclassl(x)
2333 #    else
2334 #        define Perl_fp_class(x)	fpclass(x)
2335 #    endif
2336 #    if defined(FP_CLASS_PINF) && defined(FP_CLASS_SNAN)
2337 #        define Perl_fp_class_snan(x)	(Perl_fp_class(x)==FP_CLASS_SNAN)
2338 #        define Perl_fp_class_qnan(x)	(Perl_fp_class(x)==FP_CLASS_QNAN)
2339 #        define Perl_fp_class_ninf(x)	(Perl_fp_class(x)==FP_CLASS_NINF)
2340 #        define Perl_fp_class_pinf(x)	(Perl_fp_class(x)==FP_CLASS_PINF)
2341 #        define Perl_fp_class_nnorm(x)	(Perl_fp_class(x)==FP_CLASS_NNORM)
2342 #        define Perl_fp_class_pnorm(x)	(Perl_fp_class(x)==FP_CLASS_PNORM)
2343 #        define Perl_fp_class_ndenorm(x)	(Perl_fp_class(x)==FP_CLASS_NDENORM)
2344 #        define Perl_fp_class_pdenorm(x)	(Perl_fp_class(x)==FP_CLASS_PDENORM)
2345 #        define Perl_fp_class_nzero(x)	(Perl_fp_class(x)==FP_CLASS_NZERO)
2346 #        define Perl_fp_class_pzero(x)	(Perl_fp_class(x)==FP_CLASS_PZERO)
2347 #    elif defined(FP_PINF) && defined(FP_QNAN)
2348 #        define Perl_fp_class_snan(x)	(Perl_fp_class(x)==FP_SNAN)
2349 #        define Perl_fp_class_qnan(x)	(Perl_fp_class(x)==FP_QNAN)
2350 #        define Perl_fp_class_ninf(x)	(Perl_fp_class(x)==FP_NINF)
2351 #        define Perl_fp_class_pinf(x)	(Perl_fp_class(x)==FP_PINF)
2352 #        define Perl_fp_class_nnorm(x)	(Perl_fp_class(x)==FP_NNORM)
2353 #        define Perl_fp_class_pnorm(x)	(Perl_fp_class(x)==FP_PNORM)
2354 #        define Perl_fp_class_ndenorm(x)	(Perl_fp_class(x)==FP_NDENORM)
2355 #        define Perl_fp_class_pdenorm(x)	(Perl_fp_class(x)==FP_PDENORM)
2356 #        define Perl_fp_class_nzero(x)	(Perl_fp_class(x)==FP_NZERO)
2357 #        define Perl_fp_class_pzero(x)	(Perl_fp_class(x)==FP_PZERO)
2358 #    else
2359 #        undef Perl_fp_class /* Unknown set of defines */
2360 #    endif
2361 #endif
2362 
2363 /* fp_class(): Legacy: at least Tru64, some versions of IRIX. */
2364 #if !defined(Perl_fp_class) && (defined(HAS_FP_CLASS)||defined(HAS_FP_CLASSL))
2365 #    include <math.h>
2366 #    if !defined(FP_SNAN) && defined(I_FP_CLASS)
2367 #        include <fp_class.h>
2368 #    endif
2369 #    if defined(FP_POS_INF) && defined(FP_QNAN)
2370 #        ifdef __sgi /* XXX Configure test instead */
2371 #            ifdef USE_LONG_DOUBLE
2372 #                define Perl_fp_class(x)	fp_class_l(x)
2373 #            else
2374 #                define Perl_fp_class(x)	fp_class_d(x)
2375 #            endif
2376 #        else
2377 #            if defined(USE_LONG_DOUBLE) && defined(HAS_FP_CLASSL)
2378 #                define Perl_fp_class(x)	fp_classl(x)
2379 #            else
2380 #                define Perl_fp_class(x)	fp_class(x)
2381 #            endif
2382 #        endif
2383 #        if defined(FP_POS_INF) && defined(FP_QNAN)
2384 #            define Perl_fp_class_snan(x)	(Perl_fp_class(x)==FP_SNAN)
2385 #            define Perl_fp_class_qnan(x)	(Perl_fp_class(x)==FP_QNAN)
2386 #            define Perl_fp_class_ninf(x)	(Perl_fp_class(x)==FP_NEG_INF)
2387 #            define Perl_fp_class_pinf(x)	(Perl_fp_class(x)==FP_POS_INF)
2388 #            define Perl_fp_class_nnorm(x)	(Perl_fp_class(x)==FP_NEG_NORM)
2389 #            define Perl_fp_class_pnorm(x)	(Perl_fp_class(x)==FP_POS_NORM)
2390 #            define Perl_fp_class_ndenorm(x)	(Perl_fp_class(x)==FP_NEG_DENORM)
2391 #            define Perl_fp_class_pdenorm(x)	(Perl_fp_class(x)==FP_POS_DENORM)
2392 #            define Perl_fp_class_nzero(x)	(Perl_fp_class(x)==FP_NEG_ZERO)
2393 #            define Perl_fp_class_pzero(x)	(Perl_fp_class(x)==FP_POS_ZERO)
2394 #        else
2395 #            undef Perl_fp_class /* Unknown set of defines */
2396 #        endif
2397 #    endif
2398 #endif
2399 
2400 /* class(), _class(): Legacy: AIX. */
2401 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2402 #    include <math.h>
2403 #    if defined(FP_PLUS_NORM) && defined(FP_PLUS_INF)
2404 #        ifndef _cplusplus
2405 #            define Perl_fp_class(x)	class(x)
2406 #        else
2407 #            define Perl_fp_class(x)	_class(x)
2408 #        endif
2409 #        if defined(FP_PLUS_INF) && defined(FP_NANQ)
2410 #            define Perl_fp_class_snan(x)	(Perl_fp_class(x)==FP_NANS)
2411 #            define Perl_fp_class_qnan(x)	(Perl_fp_class(x)==FP_NANQ)
2412 #            define Perl_fp_class_ninf(x)	(Perl_fp_class(x)==FP_MINUS_INF)
2413 #            define Perl_fp_class_pinf(x)	(Perl_fp_class(x)==FP_PLUS_INF)
2414 #            define Perl_fp_class_nnorm(x)	(Perl_fp_class(x)==FP_MINUS_NORM)
2415 #            define Perl_fp_class_pnorm(x)	(Perl_fp_class(x)==FP_PLUS_NORM)
2416 #            define Perl_fp_class_ndenorm(x)	(Perl_fp_class(x)==FP_MINUS_DENORM)
2417 #            define Perl_fp_class_pdenorm(x)	(Perl_fp_class(x)==FP_PLUS_DENORM)
2418 #            define Perl_fp_class_nzero(x)	(Perl_fp_class(x)==FP_MINUS_ZERO)
2419 #            define Perl_fp_class_pzero(x)	(Perl_fp_class(x)==FP_PLUS_ZERO)
2420 #        else
2421 #            undef Perl_fp_class /* Unknown set of defines */
2422 #        endif
2423 #    endif
2424 #endif
2425 
2426 /* Win32: _fpclass(), _isnan(), _finite(). */
2427 #ifdef _MSC_VER
2428 #  ifndef Perl_isnan
2429 #    define Perl_isnan(x) _isnan(x)
2430 #  endif
2431 #  ifndef Perl_isfinite
2432 #    define Perl_isfinite(x) _finite(x)
2433 #  endif
2434 #  ifndef Perl_fp_class_snan
2435 /* No simple way to #define Perl_fp_class because _fpclass()
2436  * returns a set of bits. */
2437 #    define Perl_fp_class_snan(x) (_fpclass(x) & _FPCLASS_SNAN)
2438 #    define Perl_fp_class_qnan(x) (_fpclass(x) & _FPCLASS_QNAN)
2439 #    define Perl_fp_class_nan(x) (_fpclass(x) & (_FPCLASS_SNAN|_FPCLASS_QNAN))
2440 #    define Perl_fp_class_ninf(x) (_fpclass(x) & _FPCLASS_NINF))
2441 #    define Perl_fp_class_pinf(x) (_fpclass(x) & _FPCLASS_PINF))
2442 #    define Perl_fp_class_inf(x) (_fpclass(x) & (_FPCLASS_NINF|_FPCLASS_PINF))
2443 #    define Perl_fp_class_nnorm(x) (_fpclass(x) & _FPCLASS_NN)
2444 #    define Perl_fp_class_pnorm(x) (_fpclass(x) & _FPCLASS_PN)
2445 #    define Perl_fp_class_norm(x) (_fpclass(x) & (_FPCLASS_NN|_FPCLASS_PN))
2446 #    define Perl_fp_class_ndenorm(x) (_fpclass(x) & _FPCLASS_ND)
2447 #    define Perl_fp_class_pdenorm(x) (_fpclass(x) & _FPCLASS_PD)
2448 #    define Perl_fp_class_denorm(x) (_fpclass(x) & (_FPCLASS_ND|_FPCLASS_PD))
2449 #    define Perl_fp_class_nzero(x) (_fpclass(x) & _FPCLASS_NZ)
2450 #    define Perl_fp_class_pzero(x) (_fpclass(x) & _FPCLASS_PZ)
2451 #    define Perl_fp_class_zero(x) (_fpclass(x) & (_FPCLASS_NZ|_FPCLASS_PZ))
2452 #  endif
2453 #endif
2454 
2455 #if !defined(Perl_fp_class_inf) && \
2456   defined(Perl_fp_class_pinf) && defined(Perl_fp_class_ninf)
2457 #  define Perl_fp_class_inf(x) \
2458     (Perl_fp_class_pinf(x) || Perl_fp_class_ninf(x))
2459 #endif
2460 
2461 #if !defined(Perl_fp_class_nan) && \
2462   defined(Perl_fp_class_snan) && defined(Perl_fp_class_qnan)
2463 #  define Perl_fp_class_nan(x) \
2464     (Perl_fp_class_snan(x) || Perl_fp_class_qnan(x))
2465 #endif
2466 
2467 #if !defined(Perl_fp_class_zero) && \
2468   defined(Perl_fp_class_pzero) && defined(Perl_fp_class_nzero)
2469 #  define Perl_fp_class_zero(x) \
2470     (Perl_fp_class_pzero(x) || Perl_fp_class_nzero(x))
2471 #endif
2472 
2473 #if !defined(Perl_fp_class_norm) && \
2474   defined(Perl_fp_class_pnorm) && defined(Perl_fp_class_nnorm)
2475 #  define Perl_fp_class_norm(x) \
2476     (Perl_fp_class_pnorm(x) || Perl_fp_class_nnorm(x))
2477 #endif
2478 
2479 #if !defined(Perl_fp_class_denorm) && \
2480   defined(Perl_fp_class_pdenorm) && defined(Perl_fp_class_ndenorm)
2481 #  define Perl_fp_class_denorm(x) \
2482     (Perl_fp_class_pdenorm(x) || Perl_fp_class_ndenorm(x))
2483 #endif
2484 
2485 #ifndef Perl_isnan
2486 #   ifdef Perl_fp_class_nan
2487 #       define Perl_isnan(x) Perl_fp_class_nan(x)
2488 #   elif defined(HAS_UNORDERED)
2489 #       define Perl_isnan(x) unordered((x), 0.0)
2490 #   else
2491 #       define Perl_isnan(x) ((x)!=(x))
2492 #   endif
2493 #endif
2494 
2495 #ifndef Perl_isinf
2496 #   ifdef Perl_fp_class_inf
2497 #       define Perl_isinf(x) Perl_fp_class_inf(x)
2498 #   endif
2499 #endif
2500 
2501 #ifndef Perl_isfinite
2502 #   if defined(HAS_ISFINITE) && !defined(isfinite)
2503 #     define Perl_isfinite(x) isfinite((double)(x))
2504 #   elif defined(HAS_FINITE)
2505 #       define Perl_isfinite(x) finite((double)(x))
2506 #   elif defined(Perl_fp_class_finite)
2507 #     define Perl_isfinite(x) Perl_fp_class_finite(x)
2508 #   else
2509 /* For the infinities the multiplication returns nan,
2510  * for the nan the multiplication also returns nan,
2511  * for everything else (that is, finite) zero should be returned. */
2512 #     define Perl_isfinite(x) (((x) * 0) == 0)
2513 #   endif
2514 #endif
2515 
2516 #ifndef Perl_isinf
2517 #   if defined(Perl_isfinite) && defined(Perl_isnan)
2518 #       define Perl_isinf(x) !(Perl_isfinite(x)||Perl_isnan(x))
2519 #   endif
2520 #endif
2521 
2522 /* We need Perl_isfinitel (ends with ell) (if available) even when
2523  * not USE_LONG_DOUBLE because the printf code (sv_catpvfn_flags)
2524  * needs that. */
2525 #if defined(HAS_LONG_DOUBLE) && !defined(Perl_isfinitel)
2526 /* If isfinite() is a macro and looks like we have C99,
2527  * we assume it's the type-aware C99 isfinite(). */
2528 #    if defined(HAS_ISFINITE) && defined(isfinite) && defined(HAS_C99)
2529 #        define Perl_isfinitel(x) isfinite(x)
2530 #    elif defined(HAS_ISFINITEL)
2531 #        define Perl_isfinitel(x) isfinitel(x)
2532 #    elif defined(HAS_FINITEL)
2533 #        define Perl_isfinitel(x) finitel(x)
2534 #    elif defined(HAS_INFL) && defined(HAS_NANL)
2535 #        define Perl_isfinitel(x) !(isinfl(x)||isnanl(x))
2536 #    else
2537 #        define Perl_isfinitel(x) ((x) * 0 == 0)  /* See Perl_isfinite. */
2538 #    endif
2539 #endif
2540 
2541 /* The default is to use Perl's own atof() implementation (in numeric.c).
2542  * Usually that is the one to use but for some platforms (e.g. UNICOS)
2543  * it is however best to use the native implementation of atof.
2544  * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2545  * Some good tests to try out with either setting are t/base/num.t,
2546  * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2547  * you may need to be using a different function than atof! */
2548 
2549 #ifndef USE_PERL_ATOF
2550 #   ifndef _UNICOS
2551 #       define USE_PERL_ATOF
2552 #   endif
2553 #else
2554 #   if USE_PERL_ATOF == 0
2555 #       undef USE_PERL_ATOF
2556 #   endif
2557 #endif
2558 
2559 #ifdef USE_PERL_ATOF
2560 #   define Perl_atof(s) Perl_my_atof(s)
2561 #   define Perl_atof2(s, n) Perl_my_atof3(aTHX_ (s), &(n), 0)
2562 #else
2563 #   define Perl_atof(s) (NV)atof(s)
2564 #   define Perl_atof2(s, n) ((n) = atof(s))
2565 #endif
2566 #define my_atof2(a,b) my_atof3(a,b,0)
2567 
2568 /*
2569  * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2570  * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2571  * depending on local options. Until Configure detects this (or at least
2572  * detects whether the "signed" keyword is available) the CHAR ranges
2573  * will not be included. UCHAR functions normally.
2574  *                                                           - kja
2575  */
2576 
2577 #define PERL_UCHAR_MIN ((unsigned char)0)
2578 #define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2579 
2580 #define PERL_USHORT_MIN ((unsigned short)0)
2581 #define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2582 
2583 #define PERL_SHORT_MAX ((short)SHRT_MAX)
2584 #define PERL_SHORT_MIN ((short)SHRT_MIN)
2585 
2586 #define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2587 #define PERL_UINT_MIN ((unsigned int)0)
2588 
2589 #define PERL_INT_MAX ((int)INT_MAX)
2590 #define PERL_INT_MIN ((int)INT_MIN)
2591 
2592 #define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2593 #define PERL_ULONG_MIN ((unsigned long)0L)
2594 
2595 #define PERL_LONG_MAX ((long)LONG_MAX)
2596 #define PERL_LONG_MIN ((long)LONG_MIN)
2597 
2598 #ifdef UV_IS_QUAD
2599 #    define PERL_UQUAD_MAX	(~(UV)0)
2600 #    define PERL_UQUAD_MIN	((UV)0)
2601 #    define PERL_QUAD_MAX 	((IV) (PERL_UQUAD_MAX >> 1))
2602 #    define PERL_QUAD_MIN 	(-PERL_QUAD_MAX - ((3 & -1) == 3))
2603 #endif
2604 
2605 /*
2606 =head1 Numeric functions
2607 
2608 =for apidoc AmnUh||PERL_INT_MIN
2609 =for apidoc AmnUh||PERL_LONG_MAX
2610 =for apidoc AmnUh||PERL_LONG_MIN
2611 =for apidoc AmnUh||PERL_QUAD_MAX
2612 =for apidoc AmnUh||PERL_SHORT_MAX
2613 =for apidoc AmnUh||PERL_SHORT_MIN
2614 =for apidoc AmnUh||PERL_UCHAR_MAX
2615 =for apidoc AmnUh||PERL_UCHAR_MIN
2616 =for apidoc AmnUh||PERL_UINT_MAX
2617 =for apidoc AmnUh||PERL_ULONG_MAX
2618 =for apidoc AmnUh||PERL_ULONG_MIN
2619 =for apidoc AmnUh||PERL_UQUAD_MAX
2620 =for apidoc AmnUh||PERL_UQUAD_MIN
2621 =for apidoc AmnUh||PERL_USHORT_MAX
2622 =for apidoc AmnUh||PERL_USHORT_MIN
2623 =for apidoc AmnUh||PERL_QUAD_MIN
2624 =for apidoc AmnU||PERL_INT_MAX
2625 This and
2626 C<PERL_INT_MIN>,
2627 C<PERL_LONG_MAX>,
2628 C<PERL_LONG_MIN>,
2629 C<PERL_QUAD_MAX>,
2630 C<PERL_SHORT_MAX>,
2631 C<PERL_SHORT_MIN>,
2632 C<PERL_UCHAR_MAX>,
2633 C<PERL_UCHAR_MIN>,
2634 C<PERL_UINT_MAX>,
2635 C<PERL_ULONG_MAX>,
2636 C<PERL_ULONG_MIN>,
2637 C<PERL_UQUAD_MAX>,
2638 C<PERL_UQUAD_MIN>,
2639 C<PERL_USHORT_MAX>,
2640 C<PERL_USHORT_MIN>,
2641 C<PERL_QUAD_MIN>
2642 give the largest and smallest number representable in the current
2643 platform in variables of the corresponding types.
2644 
2645 For signed types, the smallest representable number is the most negative
2646 number, the one furthest away from zero.
2647 
2648 For C99 and later compilers, these correspond to things like C<INT_MAX>, which
2649 are available to the C code.  But these constants, furnished by Perl,
2650 allow code compiled on earlier compilers to portably have access to the same
2651 constants.
2652 
2653 =cut
2654 
2655 */
2656 
2657 typedef MEM_SIZE STRLEN;
2658 
2659 typedef struct op OP;
2660 typedef struct cop COP;
2661 typedef struct unop UNOP;
2662 typedef struct unop_aux UNOP_AUX;
2663 typedef struct binop BINOP;
2664 typedef struct listop LISTOP;
2665 typedef struct logop LOGOP;
2666 typedef struct pmop PMOP;
2667 typedef struct svop SVOP;
2668 typedef struct padop PADOP;
2669 typedef struct pvop PVOP;
2670 typedef struct loop LOOP;
2671 typedef struct methop METHOP;
2672 
2673 #ifdef PERL_CORE
2674 typedef struct opslab OPSLAB;
2675 typedef struct opslot OPSLOT;
2676 #endif
2677 
2678 typedef struct block_hooks BHK;
2679 typedef struct custom_op XOP;
2680 
2681 typedef struct interpreter PerlInterpreter;
2682 
2683 /* SGI's <sys/sema.h> has struct sv */
2684 #if defined(__sgi)
2685 #   define STRUCT_SV perl_sv
2686 #else
2687 #   define STRUCT_SV sv
2688 #endif
2689 typedef struct STRUCT_SV SV;
2690 typedef struct av AV;
2691 typedef struct hv HV;
2692 typedef struct cv CV;
2693 typedef struct p5rx REGEXP;
2694 typedef struct gp GP;
2695 typedef struct gv GV;
2696 typedef struct io IO;
2697 typedef struct context PERL_CONTEXT;
2698 typedef struct block BLOCK;
2699 
2700 typedef struct magic MAGIC;
2701 typedef struct xpv XPV;
2702 typedef struct xpviv XPVIV;
2703 typedef struct xpvuv XPVUV;
2704 typedef struct xpvnv XPVNV;
2705 typedef struct xpvmg XPVMG;
2706 typedef struct xpvlv XPVLV;
2707 typedef struct xpvinvlist XINVLIST;
2708 typedef struct xpvav XPVAV;
2709 typedef struct xpvhv XPVHV;
2710 typedef struct xpvgv XPVGV;
2711 typedef struct xpvcv XPVCV;
2712 typedef struct xpvbm XPVBM;
2713 typedef struct xpvfm XPVFM;
2714 typedef struct xpvio XPVIO;
2715 typedef struct mgvtbl MGVTBL;
2716 typedef union any ANY;
2717 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2718 typedef struct ptr_tbl PTR_TBL_t;
2719 typedef struct clone_params CLONE_PARAMS;
2720 
2721 /* a pad is currently just an AV; but that might change,
2722  * so hide the type.  */
2723 typedef struct padlist PADLIST;
2724 typedef AV PAD;
2725 typedef struct padnamelist PADNAMELIST;
2726 typedef struct padname PADNAME;
2727 
2728 /* always enable PERL_OP_PARENT  */
2729 #if !defined(PERL_OP_PARENT)
2730 #  define PERL_OP_PARENT
2731 #endif
2732 
2733 /* enable PERL_COPY_ON_WRITE by default */
2734 #if !defined(PERL_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2735 #  define PERL_COPY_ON_WRITE
2736 #endif
2737 
2738 #ifdef PERL_COPY_ON_WRITE
2739 #  define PERL_ANY_COW
2740 #else
2741 # define PERL_SAWAMPERSAND
2742 #endif
2743 
2744 #if defined(PERL_DEBUG_READONLY_OPS) && !defined(USE_ITHREADS)
2745 # error PERL_DEBUG_READONLY_OPS only works with ithreads
2746 #endif
2747 
2748 #include "handy.h"
2749 #include "charclass_invlists.h"
2750 
2751 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2752 #   if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2753 #       define USE_64_BIT_RAWIO	/* implicit */
2754 #   endif
2755 #endif
2756 
2757 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2758  * fseeko/ftello if possible.  Don't go #defining ftell to ftello yourself,
2759  * however, because operating systems like to do that themself. */
2760 #ifndef FSEEKSIZE
2761 #   ifdef HAS_FSEEKO
2762 #       define FSEEKSIZE LSEEKSIZE
2763 #   else
2764 #       define FSEEKSIZE LONGSIZE
2765 #   endif
2766 #endif
2767 
2768 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2769 #   if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2770 #       define USE_64_BIT_STDIO /* implicit */
2771 #   endif
2772 #endif
2773 
2774 #ifdef USE_64_BIT_RAWIO
2775 #   ifdef HAS_OFF64_T
2776 #       undef Off_t
2777 #       define Off_t off64_t
2778 #       undef LSEEKSIZE
2779 #       define LSEEKSIZE 8
2780 #   endif
2781 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2782  * will trigger defines like the ones below.  Some 64-bit environments,
2783  * however, do not.  Therefore we have to explicitly mix and match. */
2784 #   if defined(USE_OPEN64)
2785 #       define open open64
2786 #   endif
2787 #   if defined(USE_LSEEK64)
2788 #       define lseek lseek64
2789 #   else
2790 #       if defined(USE_LLSEEK)
2791 #           define lseek llseek
2792 #       endif
2793 #   endif
2794 #   if defined(USE_STAT64)
2795 #       define stat stat64
2796 #   endif
2797 #   if defined(USE_FSTAT64)
2798 #       define fstat fstat64
2799 #   endif
2800 #   if defined(USE_LSTAT64)
2801 #       define lstat lstat64
2802 #   endif
2803 #   if defined(USE_FLOCK64)
2804 #       define flock flock64
2805 #   endif
2806 #   if defined(USE_LOCKF64)
2807 #       define lockf lockf64
2808 #   endif
2809 #   if defined(USE_FCNTL64)
2810 #       define fcntl fcntl64
2811 #   endif
2812 #   if defined(USE_TRUNCATE64)
2813 #       define truncate truncate64
2814 #   endif
2815 #   if defined(USE_FTRUNCATE64)
2816 #       define ftruncate ftruncate64
2817 #   endif
2818 #endif
2819 
2820 #ifdef USE_64_BIT_STDIO
2821 #   ifdef HAS_FPOS64_T
2822 #       undef Fpos_t
2823 #       define Fpos_t fpos64_t
2824 #   endif
2825 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2826  * will trigger defines like the ones below.  Some 64-bit environments,
2827  * however, do not. */
2828 #   if defined(USE_FOPEN64)
2829 #       define fopen fopen64
2830 #   endif
2831 #   if defined(USE_FSEEK64)
2832 #       define fseek fseek64 /* don't do fseeko here, see perlio.c */
2833 #   endif
2834 #   if defined(USE_FTELL64)
2835 #       define ftell ftell64 /* don't do ftello here, see perlio.c */
2836 #   endif
2837 #   if defined(USE_FSETPOS64)
2838 #       define fsetpos fsetpos64
2839 #   endif
2840 #   if defined(USE_FGETPOS64)
2841 #       define fgetpos fgetpos64
2842 #   endif
2843 #   if defined(USE_TMPFILE64)
2844 #       define tmpfile tmpfile64
2845 #   endif
2846 #   if defined(USE_FREOPEN64)
2847 #       define freopen freopen64
2848 #   endif
2849 #endif
2850 
2851 #if defined(OS2)
2852 #  include "iperlsys.h"
2853 #endif
2854 
2855 #ifdef DOSISH
2856 #   if defined(OS2)
2857 #       include "os2ish.h"
2858 #   else
2859 #       include "dosish.h"
2860 #   endif
2861 #elif defined(VMS)
2862 #   include "vmsish.h"
2863 #elif defined(PLAN9)
2864 #   include "./plan9/plan9ish.h"
2865 #elif defined(__VOS__)
2866 #   ifdef __GNUC__
2867 #     include "./vos/vosish.h"
2868 #   else
2869 #     include "vos/vosish.h"
2870 #   endif
2871 #elif defined(__SYMBIAN32__)
2872 #   include "symbian/symbianish.h"
2873 #elif defined(__HAIKU__)
2874 #   include "haiku/haikuish.h"
2875 #else
2876 #   include "unixish.h"
2877 #endif
2878 
2879 #ifdef __amigaos4__
2880 #    include "amigaos.h"
2881 #    undef FD_CLOEXEC /* a lie in AmigaOS */
2882 #endif
2883 
2884 /* NSIG logic from Configure --> */
2885 #ifndef NSIG
2886 #  ifdef _NSIG
2887 #    define NSIG (_NSIG)
2888 #  elif defined(SIGMAX)
2889 #    define NSIG (SIGMAX+1)
2890 #  elif defined(SIG_MAX)
2891 #    define NSIG (SIG_MAX+1)
2892 #  elif defined(_SIG_MAX)
2893 #    define NSIG (_SIG_MAX+1)
2894 #  elif defined(MAXSIG)
2895 #    define NSIG (MAXSIG+1)
2896 #  elif defined(MAX_SIG)
2897 #    define NSIG (MAX_SIG+1)
2898 #  elif defined(SIGARRAYSIZE)
2899 #    define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
2900 #  elif defined(_sys_nsig)
2901 #    define NSIG (_sys_nsig) /* Solaris 2.5 */
2902 #  else
2903      /* Default to some arbitrary number that's big enough to get most
2904       * of the common signals.  */
2905 #    define NSIG 50
2906 #  endif
2907 #endif
2908 /* <-- NSIG logic from Configure */
2909 
2910 #ifndef NO_ENVIRON_ARRAY
2911 #  define USE_ENVIRON_ARRAY
2912 #endif
2913 
2914 #ifdef USE_ITHREADS
2915    /* On some platforms it would be safe to use a read/write mutex with many
2916     * readers possible at the same time.  On other platforms, notably IBM ones,
2917     * subsequent getenv calls destroy earlier ones.  Those platforms would not
2918     * be able to handle simultaneous getenv calls */
2919 #  define ENV_LOCK            MUTEX_LOCK(&PL_env_mutex)
2920 #  define ENV_UNLOCK          MUTEX_UNLOCK(&PL_env_mutex)
2921 #  define ENV_INIT            MUTEX_INIT(&PL_env_mutex);
2922 #  define ENV_TERM            MUTEX_DESTROY(&PL_env_mutex);
2923 #else
2924 #  define ENV_LOCK       NOOP;
2925 #  define ENV_UNLOCK     NOOP;
2926 #  define ENV_INIT       NOOP;
2927 #  define ENV_TERM       NOOP;
2928 #endif
2929 
2930 /* Some critical sections need to lock both the locale and the environment.
2931  * XXX khw intends to change this to lock both mutexes, but that brings up
2932  * issues of potential deadlock, so should be done at the beginning of a
2933  * development cycle.  So for now, it just locks the environment.  Note that
2934  * many modern platforms are locale-thread-safe anyway, so locking the locale
2935  * mutex is a no-op anyway */
2936 #define ENV_LOCALE_LOCK     ENV_LOCK
2937 #define ENV_LOCALE_UNLOCK   ENV_UNLOCK
2938 
2939 /* And some critical sections care only that no one else is writing either the
2940  * locale nor the environment.  XXX Again this is for the future.  This can be
2941  * simulated with using COND_WAIT in thread.h */
2942 #define ENV_LOCALE_READ_LOCK     ENV_LOCALE_LOCK
2943 #define ENV_LOCALE_READ_UNLOCK   ENV_LOCALE_UNLOCK
2944 
2945 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
2946     /* having sigaction(2) means that the OS supports both 1-arg and 3-arg
2947      * signal handlers. But the perl core itself only fully supports 1-arg
2948      * handlers, so don't enable for now.
2949      * NB: POSIX::sigaction() supports both.
2950      *
2951      * # define PERL_USE_3ARG_SIGHANDLER
2952      */
2953 #endif
2954 
2955 /* Siginfo_t:
2956  * This is an alias for the OS's siginfo_t, except that where the OS
2957  * doesn't support it, declare a dummy version instead. This allows us to
2958  * have signal handler functions which always have a Siginfo_t parameter
2959  * regardless of platform, (and which will just be passed a NULL value
2960  * where the OS doesn't support HAS_SIGACTION).
2961  */
2962 
2963 #if defined(HAS_SIGACTION) && defined(SA_SIGINFO)
2964     typedef siginfo_t Siginfo_t;
2965 #else
2966 #ifdef si_signo /* minix */
2967 #undef si_signo
2968 #endif
2969     typedef struct {
2970         int si_signo;
2971     } Siginfo_t;
2972 #endif
2973 
2974 
2975 /*
2976  * initialise to avoid floating-point exceptions from overflow, etc
2977  */
2978 #ifndef PERL_FPU_INIT
2979 #  ifdef HAS_FPSETMASK
2980 #    if HAS_FLOATINGPOINT_H
2981 #      include <floatingpoint.h>
2982 #    endif
2983 /* Some operating systems have this as a macro, which in turn expands to a comma
2984    expression, and the last sub-expression is something that gets calculated,
2985    and then they have the gall to warn that a value computed is not used. Hence
2986    cast to void.  */
2987 #    define PERL_FPU_INIT (void)fpsetmask(0)
2988 #  elif defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2989 #    define PERL_FPU_INIT       PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2990 #    define PERL_FPU_PRE_EXEC   { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2991 #    define PERL_FPU_POST_EXEC    rsignal_restore(SIGFPE, &xfpe); }
2992 #  else
2993 #    define PERL_FPU_INIT
2994 #  endif
2995 #endif
2996 #ifndef PERL_FPU_PRE_EXEC
2997 #  define PERL_FPU_PRE_EXEC   {
2998 #  define PERL_FPU_POST_EXEC  }
2999 #endif
3000 
3001 /* In Tru64 the cc -ieee enables the IEEE math but disables traps.
3002  * We need to reenable the "invalid" trap because otherwise generation
3003  * of NaN values leaves the IEEE fp flags in bad state, leaving any further
3004  * fp ops behaving strangely (Inf + 1 resulting in zero, for example). */
3005 #ifdef __osf__
3006 #  include <machine/fpu.h>
3007 #  define PERL_SYS_FPU_INIT \
3008      STMT_START { \
3009          ieee_set_fp_control(IEEE_TRAP_ENABLE_INV); \
3010          signal(SIGFPE, SIG_IGN); \
3011      } STMT_END
3012 #endif
3013 /* In IRIX the default for Flush to Zero bit is true,
3014  * which means that results going below the minimum of normal
3015  * floating points go to zero, instead of going denormal/subnormal.
3016  * This is unlike almost any other system running Perl, so let's clear it.
3017  * [perl #123767] IRIX64 blead (ddce084a) opbasic/arith.t failure, originally
3018  * [perl #120426] small numbers shouldn't round to zero if they have extra floating digits
3019  *
3020  * XXX The flush-to-zero behaviour should be a Configure scan.
3021  * To change the behaviour usually requires some system-specific
3022  * incantation, though, like the below. */
3023 #ifdef __sgi
3024 #  include <sys/fpu.h>
3025 #  define PERL_SYS_FPU_INIT \
3026      STMT_START { \
3027          union fpc_csr csr; \
3028          csr.fc_word = get_fpc_csr(); \
3029          csr.fc_struct.flush = 0; \
3030          set_fpc_csr(csr.fc_word); \
3031      } STMT_END
3032 #endif
3033 
3034 #ifndef PERL_SYS_FPU_INIT
3035 #  define PERL_SYS_FPU_INIT NOOP
3036 #endif
3037 
3038 #ifndef PERL_SYS_INIT3_BODY
3039 #  define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
3040 #endif
3041 
3042 /*
3043 =head1 Miscellaneous Functions
3044 
3045 =for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
3046 Provides system-specific tune up of the C runtime environment necessary to
3047 run Perl interpreters.  This should be called only once, before creating
3048 any Perl interpreters.
3049 
3050 =for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
3051 Provides system-specific tune up of the C runtime environment necessary to
3052 run Perl interpreters.  This should be called only once, before creating
3053 any Perl interpreters.
3054 
3055 =for apidoc Am|void|PERL_SYS_TERM|
3056 Provides system-specific clean up of the C runtime environment after
3057 running Perl interpreters.  This should be called only once, after
3058 freeing any remaining Perl interpreters.
3059 
3060 =cut
3061  */
3062 
3063 #define PERL_SYS_INIT(argc, argv)	Perl_sys_init(argc, argv)
3064 #define PERL_SYS_INIT3(argc, argv, env)	Perl_sys_init3(argc, argv, env)
3065 #define PERL_SYS_TERM()			Perl_sys_term()
3066 
3067 #ifndef PERL_WRITE_MSG_TO_CONSOLE
3068 #  define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
3069 #endif
3070 
3071 #ifndef MAXPATHLEN
3072 #  ifdef PATH_MAX
3073 #    ifdef _POSIX_PATH_MAX
3074 #       if PATH_MAX > _POSIX_PATH_MAX
3075 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
3076  * included the null byte or not.  Later amendments of POSIX,
3077  * XPG4, the Austin Group, and the Single UNIX Specification
3078  * all explicitly include the null byte in the PATH_MAX.
3079  * Ditto for _POSIX_PATH_MAX. */
3080 #         define MAXPATHLEN PATH_MAX
3081 #       else
3082 #         define MAXPATHLEN _POSIX_PATH_MAX
3083 #       endif
3084 #    else
3085 #      define MAXPATHLEN (PATH_MAX+1)
3086 #    endif
3087 #  else
3088 #    define MAXPATHLEN 1024	/* Err on the large side. */
3089 #  endif
3090 #endif
3091 
3092 /* USE_5005THREADS needs to be after unixish.h as <pthread.h> includes
3093  * <sys/signal.h> which defines NSIG - which will stop inclusion of <signal.h>
3094  * this results in many functions being undeclared which bothers C++
3095  * May make sense to have threads after "*ish.h" anyway
3096  */
3097 
3098 /* clang Thread Safety Analysis/Annotations/Attributes
3099  * http://clang.llvm.org/docs/ThreadSafetyAnalysis.html
3100  *
3101  * Available since clang 3.6-ish (appeared in 3.4, but shaky still in 3.5).
3102  * Apple XCode hijacks __clang_major__ and __clang_minor__
3103  * (6.1 means really clang 3.6), so needs extra hijinks
3104  * (could probably also test the contents of __apple_build_version__).
3105  */
3106 #if defined(USE_ITHREADS) && defined(I_PTHREAD) && \
3107     defined(__clang__) && \
3108     !defined(PERL_GLOBAL_STRUCT) && \
3109     !defined(PERL_GLOBAL_STRUCT_PRIVATE) && \
3110     !defined(SWIG) && \
3111   ((!defined(__apple_build_version__) &&               \
3112     ((__clang_major__ == 3 && __clang_minor__ >= 6) || \
3113      (__clang_major__ >= 4))) || \
3114    (defined(__apple_build_version__) &&                \
3115     ((__clang_major__ == 6 && __clang_minor__ >= 1) || \
3116      (__clang_major__ >= 7))))
3117 #  define PERL_TSA__(x)   __attribute__((x))
3118 #  define PERL_TSA_ACTIVE
3119 #else
3120 #  define PERL_TSA__(x)   /* No TSA, make TSA attributes no-ops. */
3121 #  undef PERL_TSA_ACTIVE
3122 #endif
3123 
3124 /* PERL_TSA_CAPABILITY() is used to annotate typedefs.
3125  * typedef old_type PERL_TSA_CAPABILITY("mutex") new_type;
3126  */
3127 #define PERL_TSA_CAPABILITY(x) \
3128     PERL_TSA__(capability(x))
3129 
3130 /* In the below examples the mutex must be lexically visible, usually
3131  * either as global variables, or as function arguments. */
3132 
3133 /* PERL_TSA_GUARDED_BY() is used to annotate global variables.
3134  *
3135  * Foo foo PERL_TSA_GUARDED_BY(mutex);
3136  */
3137 #define PERL_TSA_GUARDED_BY(x) \
3138     PERL_TSA__(guarded_by(x))
3139 
3140 /* PERL_TSA_PT_GUARDED_BY() is used to annotate global pointers.
3141  * The data _behind_ the pointer is guarded.
3142  *
3143  * Foo* ptr PERL_TSA_PT_GUARDED_BY(mutex);
3144  */
3145 #define PERL_TSA_PT_GUARDED_BY(x) \
3146     PERL_TSA__(pt_guarded_by(x))
3147 
3148 /* PERL_TSA_REQUIRES() is used to annotate functions.
3149  * The caller MUST hold the resource when calling the function.
3150  *
3151  * void Foo() PERL_TSA_REQUIRES(mutex);
3152  */
3153 #define PERL_TSA_REQUIRES(x) \
3154     PERL_TSA__(requires_capability(x))
3155 
3156 /* PERL_TSA_EXCLUDES() is used to annotate functions.
3157  * The caller MUST NOT hold resource when calling the function.
3158  *
3159  * EXCLUDES should be used when the function first acquires
3160  * the resource and then releases it.  Use to avoid deadlock.
3161  *
3162  * void Foo() PERL_TSA_EXCLUDES(mutex);
3163  */
3164 #define PERL_TSA_EXCLUDES(x) \
3165     PERL_TSA__(locks_excluded(x))
3166 
3167 /* PERL_TSA_ACQUIRE() is used to annotate functions.
3168  * The caller MUST NOT hold the resource when calling the function,
3169  * and the function will acquire the resource.
3170  *
3171  * void Foo() PERL_TSA_ACQUIRE(mutex);
3172  */
3173 #define PERL_TSA_ACQUIRE(x) \
3174     PERL_TSA__(acquire_capability(x))
3175 
3176 /* PERL_TSA_RELEASE() is used to annotate functions.
3177  * The caller MUST hold the resource when calling the function,
3178  * and the function will release the resource.
3179  *
3180  * void Foo() PERL_TSA_RELEASE(mutex);
3181  */
3182 #define PERL_TSA_RELEASE(x) \
3183     PERL_TSA__(release_capability(x))
3184 
3185 /* PERL_TSA_NO_TSA is used to annotate functions.
3186  * Used when being intentionally unsafe, or when the code is too
3187  * complicated for the analysis.  Use sparingly.
3188  *
3189  * void Foo() PERL_TSA_NO_TSA;
3190  */
3191 #define PERL_TSA_NO_TSA \
3192     PERL_TSA__(no_thread_safety_analysis)
3193 
3194 /* There are more annotations/attributes available, see the clang
3195  * documentation for details. */
3196 
3197 #if defined(USE_ITHREADS)
3198 #  ifdef NETWARE
3199 #    include <nw5thread.h>
3200 #  elif defined(WIN32)
3201 #    include <win32thread.h>
3202 #  elif defined(OS2)
3203 #    include "os2thread.h"
3204 #  elif defined(I_MACH_CTHREADS)
3205 #    include <mach/cthreads.h>
3206 typedef cthread_t	perl_os_thread;
3207 typedef mutex_t		perl_mutex;
3208 typedef condition_t	perl_cond;
3209 typedef void *		perl_key;
3210 #  elif defined(I_PTHREAD) /* Posix threads */
3211 #    include <pthread.h>
3212 typedef pthread_t	perl_os_thread;
3213 typedef pthread_mutex_t PERL_TSA_CAPABILITY("mutex") perl_mutex;
3214 typedef pthread_cond_t	perl_cond;
3215 typedef pthread_key_t	perl_key;
3216 #  endif
3217 #endif /* USE_ITHREADS */
3218 
3219 #ifdef PERL_TSA_ACTIVE
3220 /* Since most pthread mutex interfaces have not been annotated, we
3221  * need to have these wrappers. The NO_TSA annotation is quite ugly
3222  * but it cannot be avoided in plain C, unlike in C++, where one could
3223  * e.g. use ACQUIRE() with no arg on a mutex lock method.
3224  *
3225  * The bodies of these wrappers are in util.c
3226  *
3227  * TODO: however, some platforms are starting to get these clang
3228  * thread safety annotations for pthreads, for example FreeBSD.
3229  * Do we need a way to a bypass these wrappers? */
3230 EXTERN_C int perl_tsa_mutex_lock(perl_mutex* mutex)
3231   PERL_TSA_ACQUIRE(*mutex)
3232   PERL_TSA_NO_TSA;
3233 EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
3234   PERL_TSA_RELEASE(*mutex)
3235   PERL_TSA_NO_TSA;
3236 #endif
3237 
3238 #if defined(WIN32)
3239 #  include "win32.h"
3240 #endif
3241 
3242 #ifdef NETWARE
3243 #  include "netware.h"
3244 #endif
3245 
3246 #define STATUS_UNIX	PL_statusvalue
3247 #ifdef VMS
3248 #   define STATUS_NATIVE	PL_statusvalue_vms
3249 /*
3250  * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
3251  * its contents can not be trusted.  Unfortunately, Perl seems to check
3252  * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
3253  * be updated also.
3254  */
3255 #  include <stsdef.h>
3256 #  include <ssdef.h>
3257 /* Presume this because if VMS changes it, it will require a new
3258  * set of APIs for waiting on children for binary compatibility.
3259  */
3260 #  define child_offset_bits (8)
3261 #  ifndef C_FAC_POSIX
3262 #  define C_FAC_POSIX 0x35A000
3263 #  endif
3264 
3265 /*  STATUS_EXIT - validates and returns a NATIVE exit status code for the
3266  * platform from the existing UNIX or Native status values.
3267  */
3268 
3269 #   define STATUS_EXIT \
3270 	(((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
3271 	   (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
3272 
3273 
3274 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
3275  * exit code and shifts the UNIX value over the correct number of bits to
3276  * be a child status.  Usually the number of bits is 8, but that could be
3277  * platform dependent.  The NATIVE status code is presumed to have either
3278  * from a child process.
3279  */
3280 
3281 /* This is complicated.  The child processes return a true native VMS
3282    status which must be saved.  But there is an assumption in Perl that
3283    the UNIX child status has some relationship to errno values, so
3284    Perl tries to translate it to text in some of the tests.
3285    In order to get the string translation correct, for the error, errno
3286    must be EVMSERR, but that generates a different text message
3287    than what the test programs are expecting.  So an errno value must
3288    be derived from the native status value when an error occurs.
3289    That will hide the true native status message.  With this version of
3290    perl, the true native child status can always be retrieved so that
3291    is not a problem.  But in this case, Pl_statusvalue and errno may
3292    have different values in them.
3293  */
3294 
3295 #   define STATUS_NATIVE_CHILD_SET(n) \
3296 	STMT_START {							\
3297 	    I32 evalue = (I32)n;					\
3298 	    if (evalue == EVMSERR) {					\
3299 	      PL_statusvalue_vms = vaxc$errno;				\
3300 	      PL_statusvalue = evalue;					\
3301 	    } else {							\
3302 	      PL_statusvalue_vms = evalue;				\
3303 	      if (evalue == -1) {					\
3304 		PL_statusvalue = -1;					\
3305 		PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
3306 	      } else							\
3307 		PL_statusvalue = Perl_vms_status_to_unix(evalue, 1);	\
3308 	      set_vaxc_errno(evalue);					\
3309 	      if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX)	\
3310 		  set_errno(EVMSERR);					\
3311 	      else set_errno(Perl_vms_status_to_unix(evalue, 0));	\
3312 	      PL_statusvalue = PL_statusvalue << child_offset_bits;	\
3313 	    }								\
3314 	} STMT_END
3315 
3316 #   ifdef VMSISH_STATUS
3317 #	define STATUS_CURRENT	(VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
3318 #   else
3319 #	define STATUS_CURRENT	STATUS_UNIX
3320 #   endif
3321 
3322   /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
3323    * the NATIVE status to an equivalent value.  Can not be used to translate
3324    * exit code values as exit code values are not guaranteed to have any
3325    * relationship at all to errno values.
3326    * This is used when Perl is forcing errno to have a specific value.
3327    */
3328 #   define STATUS_UNIX_SET(n)				\
3329 	STMT_START {					\
3330 	    I32 evalue = (I32)n;			\
3331 	    PL_statusvalue = evalue;			\
3332 	    if (PL_statusvalue != -1) {			\
3333 		if (PL_statusvalue != EVMSERR) {	\
3334 		  PL_statusvalue &= 0xFFFF;		\
3335 		  if (MY_POSIX_EXIT)			\
3336 		    PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
3337 		  else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
3338 		}					\
3339 		else {					\
3340 		  PL_statusvalue_vms = vaxc$errno;	\
3341 		}					\
3342 	    }						\
3343 	    else PL_statusvalue_vms = SS$_ABORT;	\
3344 	    set_vaxc_errno(PL_statusvalue_vms);		\
3345 	} STMT_END
3346 
3347   /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
3348    * the NATIVE error status based on it.
3349    *
3350    * When in the default mode to comply with the Perl VMS documentation,
3351    * 0 is a success and any other code sets the NATIVE status to a failure
3352    * code of SS$_ABORT.
3353    *
3354    * In the new POSIX EXIT mode, native status will be set so that the
3355    * actual exit code will can be retrieved by the calling program or
3356    * shell.
3357    *
3358    * If the exit code is not clearly a UNIX parent or child exit status,
3359    * it will be passed through as a VMS status.
3360    */
3361 
3362 #   define STATUS_UNIX_EXIT_SET(n)			\
3363 	STMT_START {					\
3364 	    I32 evalue = (I32)n;			\
3365 	    PL_statusvalue = evalue;			\
3366 	    if (MY_POSIX_EXIT) { \
3367 	      if (evalue <= 0xFF00) {		\
3368 		  if (evalue > 0xFF)			\
3369 		    evalue = (evalue >> child_offset_bits) & 0xFF; \
3370 		  PL_statusvalue_vms =		\
3371 		    (C_FAC_POSIX | (evalue << 3 ) |	\
3372 		    ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3373 	      } else /* forgive them Perl, for they have sinned */ \
3374 		PL_statusvalue_vms = evalue; \
3375 	    } else { \
3376 	      if (evalue == 0)			\
3377 		PL_statusvalue_vms = SS$_NORMAL;	\
3378 	      else if (evalue <= 0xFF00) \
3379 		PL_statusvalue_vms = SS$_ABORT; \
3380 	      else { /* forgive them Perl, for they have sinned */ \
3381 		  if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3382 		  else PL_statusvalue_vms = vaxc$errno;	\
3383 		  /* And obviously used a VMS status value instead of UNIX */ \
3384 		  PL_statusvalue = EVMSERR;		\
3385 	      } \
3386 	      set_vaxc_errno(PL_statusvalue_vms);	\
3387 	    }						\
3388 	} STMT_END
3389 
3390 
3391   /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3392    * and sets the NATIVE error status based on it.  This special case
3393    * is needed to maintain compatibility with past VMS behavior.
3394    *
3395    * In the default mode on VMS, this number is passed through as
3396    * both the NATIVE and UNIX status.  Which makes it different
3397    * that the STATUS_UNIX_EXIT_SET.
3398    *
3399    * In the new POSIX EXIT mode, native status will be set so that the
3400    * actual exit code will can be retrieved by the calling program or
3401    * shell.
3402    *
3403    * A POSIX exit code is from 0 to 255.  If the exit code is higher
3404    * than this, it needs to be assumed that it is a VMS exit code and
3405    * passed through.
3406    */
3407 
3408 #   define STATUS_EXIT_SET(n)				\
3409 	STMT_START {					\
3410 	    I32 evalue = (I32)n;			\
3411 	    PL_statusvalue = evalue;			\
3412 	    if (MY_POSIX_EXIT)				\
3413 		if (evalue > 255) PL_statusvalue_vms = evalue; else {	\
3414 		  PL_statusvalue_vms = \
3415 		    (C_FAC_POSIX | (evalue << 3 ) |	\
3416 		     ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
3417 	    else					\
3418 		PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3419 	    set_vaxc_errno(PL_statusvalue_vms);		\
3420 	} STMT_END
3421 
3422 
3423  /* This macro forces a success status */
3424 #   define STATUS_ALL_SUCCESS	\
3425 	(PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
3426 
3427  /* This macro forces a failure status */
3428 #   define STATUS_ALL_FAILURE	(PL_statusvalue = 1, \
3429      vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3430 	(C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3431 
3432 #elif defined(__amigaos4__)
3433  /* A somewhat experimental attempt to simulate posix return code values */
3434 #   define STATUS_NATIVE	PL_statusvalue_posix
3435 #   define STATUS_NATIVE_CHILD_SET(n)                      \
3436         STMT_START {                                       \
3437             PL_statusvalue_posix = (n);                    \
3438             if (PL_statusvalue_posix < 0) {                \
3439                 PL_statusvalue = -1;                       \
3440             }                                              \
3441             else {                                         \
3442                 PL_statusvalue = n << 8;                   \
3443             }                                              \
3444         } STMT_END
3445 #   define STATUS_UNIX_SET(n)		\
3446 	STMT_START {			\
3447 	    PL_statusvalue = (n);		\
3448 	    if (PL_statusvalue != -1)	\
3449 		PL_statusvalue &= 0xFFFF;	\
3450 	} STMT_END
3451 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3452 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3453 #   define STATUS_CURRENT STATUS_UNIX
3454 #   define STATUS_EXIT STATUS_UNIX
3455 #   define STATUS_ALL_SUCCESS	(PL_statusvalue = 0, PL_statusvalue_posix = 0)
3456 #   define STATUS_ALL_FAILURE	(PL_statusvalue = 1, PL_statusvalue_posix = 1)
3457 
3458 #else
3459 #   define STATUS_NATIVE	PL_statusvalue_posix
3460 #   if defined(WCOREDUMP)
3461 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3462             STMT_START {                                   \
3463                 PL_statusvalue_posix = (n);                \
3464                 if (PL_statusvalue_posix == -1)            \
3465                     PL_statusvalue = -1;                   \
3466                 else {                                     \
3467                     PL_statusvalue =                       \
3468                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3469                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3470                         (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0);  \
3471                 }                                          \
3472             } STMT_END
3473 #   elif defined(WIFEXITED)
3474 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3475             STMT_START {                                   \
3476                 PL_statusvalue_posix = (n);                \
3477                 if (PL_statusvalue_posix == -1)            \
3478                     PL_statusvalue = -1;                   \
3479                 else {                                     \
3480                     PL_statusvalue =                       \
3481                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3482                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0);  \
3483                 }                                          \
3484             } STMT_END
3485 #   else
3486 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3487             STMT_START {                                   \
3488                 PL_statusvalue_posix = (n);                \
3489                 if (PL_statusvalue_posix == -1)            \
3490                     PL_statusvalue = -1;                   \
3491                 else {                                     \
3492                     PL_statusvalue =                       \
3493                         PL_statusvalue_posix & 0xFFFF;     \
3494                 }                                          \
3495             } STMT_END
3496 #   endif
3497 #   define STATUS_UNIX_SET(n)		\
3498 	STMT_START {			\
3499 	    PL_statusvalue = (n);		\
3500 	    if (PL_statusvalue != -1)	\
3501 		PL_statusvalue &= 0xFFFF;	\
3502 	} STMT_END
3503 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3504 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3505 #   define STATUS_CURRENT STATUS_UNIX
3506 #   define STATUS_EXIT STATUS_UNIX
3507 #   define STATUS_ALL_SUCCESS	(PL_statusvalue = 0, PL_statusvalue_posix = 0)
3508 #   define STATUS_ALL_FAILURE	(PL_statusvalue = 1, PL_statusvalue_posix = 1)
3509 #endif
3510 
3511 /* flags in PL_exit_flags for nature of exit() */
3512 #define PERL_EXIT_EXPECTED	0x01
3513 #define PERL_EXIT_DESTRUCT_END  0x02  /* Run END in perl_destruct */
3514 #define PERL_EXIT_WARN		0x04  /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
3515 #define PERL_EXIT_ABORT		0x08  /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
3516 
3517 #ifndef PERL_CORE
3518 /* format to use for version numbers in file/directory names */
3519 /* XXX move to Configure? */
3520 /* This was only ever used for the current version, and that can be done at
3521    compile time, as PERL_FS_VERSION, so should we just delete it?  */
3522 #  ifndef PERL_FS_VER_FMT
3523 #    define PERL_FS_VER_FMT	"%d.%d.%d"
3524 #  endif
3525 #endif
3526 
3527 #ifndef PERL_FS_VERSION
3528 #  define PERL_FS_VERSION	PERL_VERSION_STRING
3529 #endif
3530 
3531 /* This defines a way to flush all output buffers.  This may be a
3532  * performance issue, so we allow people to disable it.  Also, if
3533  * we are using stdio, there are broken implementations of fflush(NULL)
3534  * out there, Solaris being the most prominent.
3535  */
3536 #ifndef PERL_FLUSHALL_FOR_CHILD
3537 # if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3538 #  define PERL_FLUSHALL_FOR_CHILD	PerlIO_flush((PerlIO*)NULL)
3539 # elif defined(FFLUSH_ALL)
3540 #  define PERL_FLUSHALL_FOR_CHILD	my_fflush_all()
3541 # else
3542 #  define PERL_FLUSHALL_FOR_CHILD	NOOP
3543 # endif
3544 #endif
3545 
3546 #ifndef PERL_WAIT_FOR_CHILDREN
3547 #  define PERL_WAIT_FOR_CHILDREN	NOOP
3548 #endif
3549 
3550 /* the traditional thread-unsafe notion of "current interpreter". */
3551 #ifndef PERL_SET_INTERP
3552 #  define PERL_SET_INTERP(i)		(PL_curinterp = (PerlInterpreter*)(i))
3553 #endif
3554 
3555 #ifndef PERL_GET_INTERP
3556 #  define PERL_GET_INTERP		(PL_curinterp)
3557 #endif
3558 
3559 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3560 #  ifdef MULTIPLICITY
3561 #    define PERL_GET_THX		((PerlInterpreter *)PERL_GET_CONTEXT)
3562 #  endif
3563 #  define PERL_SET_THX(t)		PERL_SET_CONTEXT(t)
3564 #endif
3565 
3566 /*
3567     This replaces the previous %_ "hack" by the "%p" hacks.
3568     All that is required is that the perl source does not
3569     use "%-p" or "%-<number>p" or "%<number>p" formats.
3570     These formats will still work in perl code.
3571     See comments in sv.c for further details.
3572 
3573     Robin Barker 2005-07-14
3574 
3575     No longer use %1p for VDf = %vd.  RMB 2007-10-19
3576 */
3577 
3578 #ifndef SVf_
3579 #  define SVf_(n) "-" STRINGIFY(n) "p"
3580 #endif
3581 
3582 #ifndef SVf
3583 #  define SVf "-p"
3584 #endif
3585 
3586 #ifndef SVf32
3587 #  define SVf32 SVf_(32)
3588 #endif
3589 
3590 #ifndef SVf256
3591 #  define SVf256 SVf_(256)
3592 #endif
3593 
3594 #define SVfARG(p) ((void*)(p))
3595 
3596 #ifndef HEKf
3597 #  define HEKf "2p"
3598 #endif
3599 
3600 /* Not ideal, but we cannot easily include a number in an already-numeric
3601  * format sequence. */
3602 #ifndef HEKf256
3603 #  define HEKf256 "3p"
3604 #endif
3605 
3606 #define HEKfARG(p) ((void*)(p))
3607 
3608 /*
3609 =for apidoc Amnh||UTF8f
3610 =for apidoc Amh||UTF8fARG|bool is_utf8|Size_t byte_len|char *str
3611 
3612 =cut
3613  * %4p is a custom format
3614  */
3615 #ifndef UTF8f
3616 #  define UTF8f "d%" UVuf "%4p"
3617 #endif
3618 #define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3619 
3620 #define PNf UTF8f
3621 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
3622 
3623 #ifdef PERL_CORE
3624 /* not used; but needed for backward compatibility with XS code? - RMB */
3625 #  undef UVf
3626 #elif !defined(UVf)
3627 #  define UVf UVuf
3628 #endif
3629 
3630 #if !defined(DEBUGGING) && !defined(NDEBUG)
3631 #  define NDEBUG 1
3632 #endif
3633 #include <assert.h>
3634 
3635 /* For functions that are marked as __attribute__noreturn__, it's not
3636    appropriate to call return.  In either case, include the lint directive.
3637  */
3638 #ifdef HASATTRIBUTE_NORETURN
3639 #  define NORETURN_FUNCTION_END NOT_REACHED;
3640 #else
3641 #  define NORETURN_FUNCTION_END NOT_REACHED; return 0
3642 #endif
3643 
3644 #ifdef HAS_BUILTIN_EXPECT
3645 #  define EXPECT(expr,val)                  __builtin_expect(expr,val)
3646 #else
3647 #  define EXPECT(expr,val)                  (expr)
3648 #endif
3649 
3650 /*
3651 =head1 Miscellaneous Functions
3652 
3653 =for apidoc AmU|bool|LIKELY|const bool expr
3654 
3655 Returns the input unchanged, but at the same time it gives a branch prediction
3656 hint to the compiler that this condition is likely to be true.
3657 
3658 =for apidoc AmU|bool|UNLIKELY|const bool expr
3659 
3660 Returns the input unchanged, but at the same time it gives a branch prediction
3661 hint to the compiler that this condition is likely to be false.
3662 
3663 =cut
3664 */
3665 #define LIKELY(cond)                        EXPECT(cBOOL(cond),TRUE)
3666 #define UNLIKELY(cond)                      EXPECT(cBOOL(cond),FALSE)
3667 
3668 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3669 /* placeholder */
3670 #endif
3671 
3672 /* STATIC_ASSERT_DECL/STATIC_ASSERT_STMT are like assert(), but for compile
3673    time invariants. That is, their argument must be a constant expression that
3674    can be verified by the compiler. This expression can contain anything that's
3675    known to the compiler, e.g. #define constants, enums, or sizeof (...). If
3676    the expression evaluates to 0, compilation fails.
3677    Because they generate no runtime code (i.e.  their use is "free"), they're
3678    always active, even under non-DEBUGGING builds.
3679    STATIC_ASSERT_DECL expands to a declaration and is suitable for use at
3680    file scope (outside of any function).
3681    STATIC_ASSERT_STMT expands to a statement and is suitable for use inside a
3682    function.
3683 */
3684 #if (! defined(__IBMC__) || __IBMC__ >= 1210)                               \
3685  && ((   defined(static_assert) && (   defined(_ISOC11_SOURCE)              \
3686                                     || (__STDC_VERSION__ - 0) >= 201101L))  \
3687      || (defined(__cplusplus) && __cplusplus >= 201103L))
3688 /* XXX static_assert is a macro defined in <assert.h> in C11 or a compiler
3689    builtin in C++11.  But IBM XL C V11 does not support _Static_assert, no
3690    matter what <assert.h> says.
3691 */
3692 #  define STATIC_ASSERT_DECL(COND) static_assert(COND, #COND)
3693 #else
3694 /* We use a bit-field instead of an array because gcc accepts
3695    'typedef char x[n]' where n is not a compile-time constant.
3696    We want to enforce constantness.
3697 */
3698 #  define STATIC_ASSERT_2(COND, SUFFIX) \
3699     typedef struct { \
3700         unsigned int _static_assertion_failed_##SUFFIX : (COND) ? 1 : -1; \
3701     } _static_assertion_failed_##SUFFIX PERL_UNUSED_DECL
3702 #  define STATIC_ASSERT_1(COND, SUFFIX) STATIC_ASSERT_2(COND, SUFFIX)
3703 #  define STATIC_ASSERT_DECL(COND)    STATIC_ASSERT_1(COND, __LINE__)
3704 #endif
3705 /* We need this wrapper even in C11 because 'case X: static_assert(...);' is an
3706    error (static_assert is a declaration, and only statements can have labels).
3707 */
3708 #define STATIC_ASSERT_STMT(COND)      STMT_START { STATIC_ASSERT_DECL(COND); } STMT_END
3709 
3710 #ifndef __has_builtin
3711 #  define __has_builtin(x) 0 /* not a clang style compiler */
3712 #endif
3713 
3714 /* ASSUME is like assert(), but it has a benefit in a release build. It is a
3715    hint to a compiler about a statement of fact in a function call free
3716    expression, which allows the compiler to generate better machine code.
3717    In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3718    the control path is unreachable. In a for loop, ASSUME can be used to hint
3719    that a loop will run at least X times. ASSUME is based off MSVC's __assume
3720    intrinsic function, see its documents for more details.
3721 */
3722 
3723 #ifndef DEBUGGING
3724 #  if __has_builtin(__builtin_unreachable) \
3725      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4) /* 4.5 -> */
3726 #    define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3727 #  elif defined(_MSC_VER)
3728 #    define ASSUME(x) __assume(x)
3729 #  elif defined(__ARMCC_VERSION) /* untested */
3730 #    define ASSUME(x) __promise(x)
3731 #  else
3732 /* a random compiler might define assert to its own special optimization token
3733    so pass it through to C lib as a last resort */
3734 #    define ASSUME(x) assert(x)
3735 #  endif
3736 #else
3737 #  define ASSUME(x) assert(x)
3738 #endif
3739 
3740 #if defined(__sun)      /* ASSUME() generates warnings on Solaris */
3741 #  define NOT_REACHED
3742 #elif defined(DEBUGGING) && (__has_builtin(__builtin_unreachable) \
3743      || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 4)) /* 4.5 -> */
3744 #  define NOT_REACHED STMT_START { ASSUME(!"UNREACHABLE"); __builtin_unreachable(); } STMT_END
3745 #else
3746 #  define NOT_REACHED ASSUME(!"UNREACHABLE")
3747 #endif
3748 
3749 /* Some unistd.h's give a prototype for pause() even though
3750    HAS_PAUSE ends up undefined.  This causes the #define
3751    below to be rejected by the compiler.  Sigh.
3752 */
3753 #ifdef HAS_PAUSE
3754 #define Pause	pause
3755 #else
3756 #define Pause() sleep((32767<<16)+32767)
3757 #endif
3758 
3759 #ifndef IOCPARM_LEN
3760 #   ifdef IOCPARM_MASK
3761 	/* on BSDish systems we're safe */
3762 #	define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
3763 #   elif defined(_IOC_SIZE) && defined(__GLIBC__)
3764 	/* on Linux systems we're safe; except when we're not [perl #38223] */
3765 #	define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3766 #   else
3767 	/* otherwise guess at what's safe */
3768 #	define IOCPARM_LEN(x)	256
3769 #   endif
3770 #endif
3771 
3772 #if defined(__CYGWIN__)
3773 /* USEMYBINMODE
3774  *   This symbol, if defined, indicates that the program should
3775  *   use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3776  *   that a file is in "binary" mode -- that is, that no translation
3777  *   of bytes occurs on read or write operations.
3778  */
3779 #  define USEMYBINMODE /**/
3780 #  include <io.h> /* for setmode() prototype */
3781 #  define my_binmode(fp, iotype, mode) \
3782             cBOOL(PerlLIO_setmode(fileno(fp), mode) != -1)
3783 #endif
3784 
3785 #ifdef __CYGWIN__
3786 void init_os_extras(void);
3787 #endif
3788 
3789 #ifdef UNION_ANY_DEFINITION
3790 UNION_ANY_DEFINITION;
3791 #else
3792 union any {
3793     void*	any_ptr;
3794     SV*         any_sv;
3795     SV**        any_svp;
3796     GV*         any_gv;
3797     AV*         any_av;
3798     HV*         any_hv;
3799     OP*         any_op;
3800     char*       any_pv;
3801     char**      any_pvp;
3802     I32		any_i32;
3803     U32		any_u32;
3804     IV		any_iv;
3805     UV		any_uv;
3806     long	any_long;
3807     bool	any_bool;
3808     void	(*any_dptr) (void*);
3809     void	(*any_dxptr) (pTHX_ void*);
3810 };
3811 #endif
3812 
3813 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3814 
3815 #define FILTER_READ(idx, sv, len)  filter_read(idx, sv, len)
3816 #define FILTER_DATA(idx) \
3817 	    (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3818 #define FILTER_ISREADER(idx) \
3819 	    (PL_parser && PL_parser->rsfp_filters \
3820 		&& idx >= AvFILLp(PL_parser->rsfp_filters))
3821 #define PERL_FILTER_EXISTS(i) \
3822 	    (PL_parser && PL_parser->rsfp_filters \
3823 		&& (i) <= av_tindex(PL_parser->rsfp_filters))
3824 
3825 #if defined(_AIX) && !defined(_AIX43)
3826 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3827 /* We cannot include <crypt.h> to get the struct crypt_data
3828  * because of setkey prototype problems when threading */
3829 typedef        struct crypt_data {     /* straight from /usr/include/crypt.h */
3830     /* From OSF, Not needed in AIX
3831        char C[28], D[28];
3832     */
3833     char E[48];
3834     char KS[16][48];
3835     char block[66];
3836     char iobuf[16];
3837 } CRYPTD;
3838 #endif /* threading */
3839 #endif /* AIX */
3840 
3841 #ifndef PERL_CALLCONV
3842 #  ifdef __cplusplus
3843 #    define PERL_CALLCONV extern "C"
3844 #  else
3845 #    define PERL_CALLCONV
3846 #  endif
3847 #endif
3848 #ifndef PERL_CALLCONV_NO_RET
3849 #    define PERL_CALLCONV_NO_RET PERL_CALLCONV
3850 #endif
3851 
3852 /* PERL_STATIC_NO_RET is supposed to be equivalent to STATIC on builds that
3853    dont have a noreturn as a declaration specifier
3854 */
3855 #ifndef PERL_STATIC_NO_RET
3856 #  define PERL_STATIC_NO_RET STATIC
3857 #endif
3858 /* PERL_STATIC_NO_RET is supposed to be equivalent to PERL_STATIC_INLINE on
3859    builds that dont have a noreturn as a declaration specifier
3860 */
3861 #ifndef PERL_STATIC_INLINE_NO_RET
3862 #  define PERL_STATIC_INLINE_NO_RET PERL_STATIC_INLINE
3863 #endif
3864 
3865 #ifndef PERL_STATIC_FORCE_INLINE
3866 #  define PERL_STATIC_FORCE_INLINE PERL_STATIC_INLINE
3867 #endif
3868 
3869 #ifndef PERL_STATIC_FORCE_INLINE_NO_RET
3870 #  define PERL_STATIC_FORCE_INLINE_NO_RET PERL_STATIC_INLINE
3871 #endif
3872 
3873 #if !defined(OS2)
3874 #  include "iperlsys.h"
3875 #endif
3876 
3877 #ifdef __LIBCATAMOUNT__
3878 #undef HAS_PASSWD  /* unixish.h but not unixish enough. */
3879 #undef HAS_GROUP
3880 #define FAKE_BIT_BUCKET
3881 #endif
3882 
3883 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3884  * Note that the USE_HASH_SEED and similar defines are *NOT* defined by
3885  * Configure, despite their names being similar to other defines like
3886  * USE_ITHREADS.  Configure in fact knows nothing about the randomised
3887  * hashes.  Therefore to enable/disable the hash randomisation defines
3888  * use the Configure -Accflags=... instead. */
3889 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED)
3890 #  define USE_HASH_SEED
3891 #endif
3892 
3893 #include "perly.h"
3894 
3895 
3896 /* macros to define bit-fields in structs. */
3897 #ifndef PERL_BITFIELD8
3898 #  define PERL_BITFIELD8 U8
3899 #endif
3900 #ifndef PERL_BITFIELD16
3901 #  define PERL_BITFIELD16 U16
3902 #endif
3903 #ifndef PERL_BITFIELD32
3904 #  define PERL_BITFIELD32 U32
3905 #endif
3906 
3907 #include "sv.h"
3908 #include "regexp.h"
3909 #include "util.h"
3910 #include "form.h"
3911 #include "gv.h"
3912 #include "pad.h"
3913 #include "cv.h"
3914 #include "opnames.h"
3915 #include "op.h"
3916 #include "hv.h"
3917 #include "cop.h"
3918 #include "av.h"
3919 #include "mg.h"
3920 #include "scope.h"
3921 #include "warnings.h"
3922 #include "utf8.h"
3923 
3924 /* these would be in doio.h if there was such a file */
3925 #define my_stat()  my_stat_flags(SV_GMAGIC)
3926 #define my_lstat() my_lstat_flags(SV_GMAGIC)
3927 
3928 /* defined in sv.c, but also used in [ach]v.c */
3929 #undef _XPV_HEAD
3930 #undef _XPVMG_HEAD
3931 #undef _XPVCV_COMMON
3932 
3933 #include "parser.h"
3934 
3935 typedef struct magic_state MGS;	/* struct magic_state defined in mg.c */
3936 
3937 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3938 
3939 /* These have to be predeclared, as they are used in proto.h which is #included
3940  * before their definitions in regcomp.h. */
3941 
3942 struct scan_data_t;
3943 typedef struct regnode_charclass regnode_charclass;
3944 
3945 /* A hopefully less confusing name.  The sub-classes are all Posix classes only
3946  * used under /l matching */
3947 typedef struct regnode_charclass_posixl regnode_charclass_class;
3948 typedef struct regnode_charclass_posixl regnode_charclass_posixl;
3949 
3950 typedef struct regnode_ssc regnode_ssc;
3951 typedef struct RExC_state_t RExC_state_t;
3952 struct _reg_trie_data;
3953 
3954 #endif
3955 
3956 struct ptr_tbl_ent {
3957     struct ptr_tbl_ent*		next;
3958     const void*			oldval;
3959     void*			newval;
3960 };
3961 
3962 struct ptr_tbl {
3963     struct ptr_tbl_ent**	tbl_ary;
3964     UV				tbl_max;
3965     UV				tbl_items;
3966     struct ptr_tbl_arena	*tbl_arena;
3967     struct ptr_tbl_ent		*tbl_arena_next;
3968     struct ptr_tbl_ent		*tbl_arena_end;
3969 };
3970 
3971 #if defined(htonl) && !defined(HAS_HTONL)
3972 #define HAS_HTONL
3973 #endif
3974 #if defined(htons) && !defined(HAS_HTONS)
3975 #define HAS_HTONS
3976 #endif
3977 #if defined(ntohl) && !defined(HAS_NTOHL)
3978 #define HAS_NTOHL
3979 #endif
3980 #if defined(ntohs) && !defined(HAS_NTOHS)
3981 #define HAS_NTOHS
3982 #endif
3983 #ifndef HAS_HTONL
3984 #define HAS_HTONS
3985 #define HAS_HTONL
3986 #define HAS_NTOHS
3987 #define HAS_NTOHL
3988 #  if (BYTEORDER & 0xffff) == 0x4321
3989 /* Big endian system, so ntohl, ntohs, htonl and htons do not need to
3990    re-order their values. However, to behave identically to the alternative
3991    implementations, they should truncate to the correct size.  */
3992 #    define ntohl(x)    ((x)&0xFFFFFFFF)
3993 #    define htonl(x)    ntohl(x)
3994 #    define ntohs(x)    ((x)&0xFFFF)
3995 #    define htons(x)    ntohs(x)
3996 #  elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3997 
3998 /* Note that we can't straight out declare our own htonl and htons because
3999    the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
4000    to avoid the overhead of initialising the socket subsystem, but the headers
4001    that *declare* the various functions are still seen. If we declare our own
4002    htonl etc they will clash with the declarations in the Win32 headers.  */
4003 
4004 PERL_STATIC_INLINE U32
4005 my_swap32(const U32 x) {
4006     return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)
4007         | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
4008 }
4009 
4010 PERL_STATIC_INLINE U16
4011 my_swap16(const U16 x) {
4012     return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
4013 }
4014 
4015 #    define htonl(x)    my_swap32(x)
4016 #    define ntohl(x)    my_swap32(x)
4017 #    define ntohs(x)    my_swap16(x)
4018 #    define htons(x)    my_swap16(x)
4019 #  else
4020 #    error "Unsupported byteorder"
4021 /* The C pre-processor doesn't let us return the value of BYTEORDER as part of
4022    the error message. Please check the value of the macro BYTEORDER, as defined
4023    in config.h. The values of BYTEORDER we expect are
4024 
4025 	    big endian  little endian
4026    32 bit       0x4321  0x1234
4027    64 bit   0x87654321  0x12345678
4028 
4029    If you have a system with a different byte order, please see
4030    pod/perlhack.pod for how to submit a patch to add supporting code.
4031 */
4032 #  endif
4033 #endif
4034 
4035 /*
4036  * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
4037  * -DWS
4038  */
4039 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
4040 /* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
4041    re-order their values. However, to behave identically to the alternative
4042    implementations, they should truncate to the correct size.  */
4043 #  define vtohl(x)      ((x)&0xFFFFFFFF)
4044 #  define vtohs(x)      ((x)&0xFFFF)
4045 #  define htovl(x)      vtohl(x)
4046 #  define htovs(x)      vtohs(x)
4047 #elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
4048 #  define vtohl(x)	((((x)&0xFF)<<24)	\
4049 			+(((x)>>24)&0xFF)	\
4050 			+(((x)&0x0000FF00)<<8)	\
4051 			+(((x)&0x00FF0000)>>8)	)
4052 #  define vtohs(x)	((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
4053 #  define htovl(x)	vtohl(x)
4054 #  define htovs(x)	vtohs(x)
4055 #else
4056 #  error "Unsupported byteorder"
4057 /* If you have need for current perl on PDP-11 or similar, and can help test
4058    that blead keeps working on a mixed-endian system, then see
4059    pod/perlhack.pod for how to submit patches to things working again.  */
4060 #endif
4061 
4062 /* *MAX Plus 1. A floating point value.
4063    Hopefully expressed in a way that dodgy floating point can't mess up.
4064    >> 2 rather than 1, so that value is safely less than I32_MAX after 1
4065    is added to it
4066    May find that some broken compiler will want the value cast to I32.
4067    [after the shift, as signed >> may not be as secure as unsigned >>]
4068 */
4069 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
4070 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
4071 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
4072    0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
4073    may be greater than sizeof(IV), so don't assume that half max UV is max IV.
4074 */
4075 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
4076 
4077 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
4078 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
4079 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
4080 
4081 /* This may look like unnecessary jumping through hoops, but converting
4082    out of range floating point values to integers *is* undefined behaviour,
4083    and it is starting to bite.
4084 */
4085 #ifndef CAST_INLINE
4086 #define I_32(what) (cast_i32((NV)(what)))
4087 #define U_32(what) (cast_ulong((NV)(what)))
4088 #define I_V(what) (cast_iv((NV)(what)))
4089 #define U_V(what) (cast_uv((NV)(what)))
4090 #else
4091 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
4092                   : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
4093                      : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
4094 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
4095                   : ((n) < U32_MAX_P1 ? (U32) (n) \
4096                      : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
4097 #define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
4098                   : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
4099                      : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
4100 #define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
4101                   : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
4102                      : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
4103 #endif
4104 
4105 #define U_S(what) ((U16)U_32(what))
4106 #define U_I(what) ((unsigned int)U_32(what))
4107 #define U_L(what) U_32(what)
4108 
4109 #ifdef HAS_SIGNBIT
4110 #  ifndef Perl_signbit
4111 #    define Perl_signbit signbit
4112 #  endif
4113 #endif
4114 
4115 /* These do not care about the fractional part, only about the range. */
4116 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
4117 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
4118 
4119 /* Used with UV/IV arguments: */
4120 					/* XXXX: need to speed it up */
4121 #define CLUMP_2UV(iv)	((iv) < 0 ? 0 : (UV)(iv))
4122 #define CLUMP_2IV(uv)	((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
4123 
4124 #ifndef MAXSYSFD
4125 #   define MAXSYSFD 2
4126 #endif
4127 
4128 #ifndef __cplusplus
4129 #if !(defined(WIN32) || defined(SYMBIAN))
4130 Uid_t getuid (void);
4131 Uid_t geteuid (void);
4132 Gid_t getgid (void);
4133 Gid_t getegid (void);
4134 #endif
4135 #endif
4136 
4137 #ifndef Perl_debug_log
4138 #  define Perl_debug_log	PerlIO_stderr()
4139 #endif
4140 
4141 #ifndef Perl_error_log
4142 #  define Perl_error_log	(PL_stderrgv			\
4143 				 && isGV(PL_stderrgv)		\
4144 				 && GvIOp(PL_stderrgv)          \
4145 				 && IoOFP(GvIOp(PL_stderrgv))	\
4146 				 ? IoOFP(GvIOp(PL_stderrgv))	\
4147 				 : PerlIO_stderr())
4148 #endif
4149 
4150 
4151 #define DEBUG_p_FLAG		0x00000001 /*      1 */
4152 #define DEBUG_s_FLAG		0x00000002 /*      2 */
4153 #define DEBUG_l_FLAG		0x00000004 /*      4 */
4154 #define DEBUG_t_FLAG		0x00000008 /*      8 */
4155 #define DEBUG_o_FLAG		0x00000010 /*     16 */
4156 #define DEBUG_c_FLAG		0x00000020 /*     32 */
4157 #define DEBUG_P_FLAG		0x00000040 /*     64 */
4158 #define DEBUG_m_FLAG		0x00000080 /*    128 */
4159 #define DEBUG_f_FLAG		0x00000100 /*    256 */
4160 #define DEBUG_r_FLAG		0x00000200 /*    512 */
4161 #define DEBUG_x_FLAG		0x00000400 /*   1024 */
4162 #define DEBUG_u_FLAG		0x00000800 /*   2048 */
4163 /* U is reserved for Unofficial, exploratory hacking */
4164 #define DEBUG_U_FLAG		0x00001000 /*   4096 */
4165 /* spare                                        8192 */
4166 #define DEBUG_X_FLAG		0x00004000 /*  16384 */
4167 #define DEBUG_D_FLAG		0x00008000 /*  32768 */
4168 #define DEBUG_S_FLAG		0x00010000 /*  65536 */
4169 #define DEBUG_T_FLAG		0x00020000 /* 131072 */
4170 #define DEBUG_R_FLAG		0x00040000 /* 262144 */
4171 #define DEBUG_J_FLAG		0x00080000 /* 524288 */
4172 #define DEBUG_v_FLAG		0x00100000 /*1048576 */
4173 #define DEBUG_C_FLAG		0x00200000 /*2097152 */
4174 #define DEBUG_A_FLAG		0x00400000 /*4194304 */
4175 #define DEBUG_q_FLAG		0x00800000 /*8388608 */
4176 #define DEBUG_M_FLAG		0x01000000 /*16777216*/
4177 #define DEBUG_B_FLAG		0x02000000 /*33554432*/
4178 #define DEBUG_L_FLAG		0x04000000 /*67108864*/
4179 #define DEBUG_i_FLAG		0x08000000 /*134217728*/
4180 #define DEBUG_y_FLAG		0x10000000 /*268435456*/
4181 #define DEBUG_MASK		0x1FFFEFFF /* mask of all the standard flags */
4182 
4183 #define DEBUG_DB_RECURSE_FLAG	0x40000000
4184 #define DEBUG_TOP_FLAG		0x80000000 /* -D was given --> PL_debug |= FLAG */
4185 
4186 #  define DEBUG_p_TEST_ UNLIKELY(PL_debug & DEBUG_p_FLAG)
4187 #  define DEBUG_s_TEST_ UNLIKELY(PL_debug & DEBUG_s_FLAG)
4188 #  define DEBUG_l_TEST_ UNLIKELY(PL_debug & DEBUG_l_FLAG)
4189 #  define DEBUG_t_TEST_ UNLIKELY(PL_debug & DEBUG_t_FLAG)
4190 #  define DEBUG_o_TEST_ UNLIKELY(PL_debug & DEBUG_o_FLAG)
4191 #  define DEBUG_c_TEST_ UNLIKELY(PL_debug & DEBUG_c_FLAG)
4192 #  define DEBUG_P_TEST_ UNLIKELY(PL_debug & DEBUG_P_FLAG)
4193 #  define DEBUG_m_TEST_ UNLIKELY(PL_debug & DEBUG_m_FLAG)
4194 #  define DEBUG_f_TEST_ UNLIKELY(PL_debug & DEBUG_f_FLAG)
4195 #  define DEBUG_r_TEST_ UNLIKELY(PL_debug & DEBUG_r_FLAG)
4196 #  define DEBUG_x_TEST_ UNLIKELY(PL_debug & DEBUG_x_FLAG)
4197 #  define DEBUG_u_TEST_ UNLIKELY(PL_debug & DEBUG_u_FLAG)
4198 #  define DEBUG_U_TEST_ UNLIKELY(PL_debug & DEBUG_U_FLAG)
4199 #  define DEBUG_X_TEST_ UNLIKELY(PL_debug & DEBUG_X_FLAG)
4200 #  define DEBUG_D_TEST_ UNLIKELY(PL_debug & DEBUG_D_FLAG)
4201 #  define DEBUG_S_TEST_ UNLIKELY(PL_debug & DEBUG_S_FLAG)
4202 #  define DEBUG_T_TEST_ UNLIKELY(PL_debug & DEBUG_T_FLAG)
4203 #  define DEBUG_R_TEST_ UNLIKELY(PL_debug & DEBUG_R_FLAG)
4204 #  define DEBUG_J_TEST_ UNLIKELY(PL_debug & DEBUG_J_FLAG)
4205 #  define DEBUG_v_TEST_ UNLIKELY(PL_debug & DEBUG_v_FLAG)
4206 #  define DEBUG_C_TEST_ UNLIKELY(PL_debug & DEBUG_C_FLAG)
4207 #  define DEBUG_A_TEST_ UNLIKELY(PL_debug & DEBUG_A_FLAG)
4208 #  define DEBUG_q_TEST_ UNLIKELY(PL_debug & DEBUG_q_FLAG)
4209 #  define DEBUG_M_TEST_ UNLIKELY(PL_debug & DEBUG_M_FLAG)
4210 #  define DEBUG_B_TEST_ UNLIKELY(PL_debug & DEBUG_B_FLAG)
4211 #  define DEBUG_L_TEST_ UNLIKELY(PL_debug & DEBUG_L_FLAG)
4212 #  define DEBUG_i_TEST_ UNLIKELY(PL_debug & DEBUG_i_FLAG)
4213 #  define DEBUG_y_TEST_ UNLIKELY(PL_debug & DEBUG_y_FLAG)
4214 #  define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
4215 #  define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
4216 #  define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
4217 #  define DEBUG_Lv_TEST_ (DEBUG_L_TEST_ && DEBUG_v_TEST_)
4218 #  define DEBUG_yv_TEST_ (DEBUG_y_TEST_ && DEBUG_v_TEST_)
4219 
4220 #ifdef DEBUGGING
4221 
4222 #  define DEBUG_p_TEST DEBUG_p_TEST_
4223 #  define DEBUG_s_TEST DEBUG_s_TEST_
4224 #  define DEBUG_l_TEST DEBUG_l_TEST_
4225 #  define DEBUG_t_TEST DEBUG_t_TEST_
4226 #  define DEBUG_o_TEST DEBUG_o_TEST_
4227 #  define DEBUG_c_TEST DEBUG_c_TEST_
4228 #  define DEBUG_P_TEST DEBUG_P_TEST_
4229 #  define DEBUG_m_TEST DEBUG_m_TEST_
4230 #  define DEBUG_f_TEST DEBUG_f_TEST_
4231 #  define DEBUG_r_TEST DEBUG_r_TEST_
4232 #  define DEBUG_x_TEST DEBUG_x_TEST_
4233 #  define DEBUG_u_TEST DEBUG_u_TEST_
4234 #  define DEBUG_U_TEST DEBUG_U_TEST_
4235 #  define DEBUG_X_TEST DEBUG_X_TEST_
4236 #  define DEBUG_D_TEST DEBUG_D_TEST_
4237 #  define DEBUG_S_TEST DEBUG_S_TEST_
4238 #  define DEBUG_T_TEST DEBUG_T_TEST_
4239 #  define DEBUG_R_TEST DEBUG_R_TEST_
4240 #  define DEBUG_J_TEST DEBUG_J_TEST_
4241 #  define DEBUG_v_TEST DEBUG_v_TEST_
4242 #  define DEBUG_C_TEST DEBUG_C_TEST_
4243 #  define DEBUG_A_TEST DEBUG_A_TEST_
4244 #  define DEBUG_q_TEST DEBUG_q_TEST_
4245 #  define DEBUG_M_TEST DEBUG_M_TEST_
4246 #  define DEBUG_B_TEST DEBUG_B_TEST_
4247 #  define DEBUG_L_TEST DEBUG_L_TEST_
4248 #  define DEBUG_i_TEST DEBUG_i_TEST_
4249 #  define DEBUG_y_TEST DEBUG_y_TEST_
4250 #  define DEBUG_Xv_TEST DEBUG_Xv_TEST_
4251 #  define DEBUG_Uv_TEST DEBUG_Uv_TEST_
4252 #  define DEBUG_Pv_TEST DEBUG_Pv_TEST_
4253 #  define DEBUG_Lv_TEST DEBUG_Lv_TEST_
4254 #  define DEBUG_yv_TEST DEBUG_yv_TEST_
4255 
4256 #  define PERL_DEB(a)                  a
4257 #  define PERL_DEB2(a,b)               a
4258 #  define PERL_DEBUG(a) if (PL_debug)  a
4259 #  define DEBUG_p(a) if (DEBUG_p_TEST) a
4260 #  define DEBUG_s(a) if (DEBUG_s_TEST) a
4261 #  define DEBUG_l(a) if (DEBUG_l_TEST) a
4262 #  define DEBUG_t(a) if (DEBUG_t_TEST) a
4263 #  define DEBUG_o(a) if (DEBUG_o_TEST) a
4264 #  define DEBUG_c(a) if (DEBUG_c_TEST) a
4265 #  define DEBUG_P(a) if (DEBUG_P_TEST) a
4266 
4267      /* Temporarily turn off memory debugging in case the a
4268       * does memory allocation, either directly or indirectly. */
4269 #  define DEBUG_m(a)  \
4270     STMT_START {					                \
4271         if (PERL_GET_INTERP) {                                          \
4272                                 dTHX;                                   \
4273                                 if (DEBUG_m_TEST) {                     \
4274                                     PL_debug &= ~DEBUG_m_FLAG;          \
4275                                     a;                                  \
4276                                     PL_debug |= DEBUG_m_FLAG;           \
4277                                 }                                       \
4278                               }                                         \
4279     } STMT_END
4280 
4281 #  define DEBUG__(t, a)                                                 \
4282         STMT_START {                                                    \
4283                 if (t) STMT_START {a;} STMT_END;                        \
4284         } STMT_END
4285 
4286 #  define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
4287 
4288 /* For re_comp.c, re_exec.c, assume -Dr has been specified */
4289 #  ifdef PERL_EXT_RE_BUILD
4290 #    define DEBUG_r(a) STMT_START {a;} STMT_END
4291 #  else
4292 #    define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
4293 #  endif /* PERL_EXT_RE_BUILD */
4294 
4295 #  define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
4296 #  define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
4297 #  define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
4298 #  define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
4299 #  define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
4300 #  define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
4301 #  define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
4302 #  define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
4303 #  define DEBUG_Lv(a) DEBUG__(DEBUG_Lv_TEST, a)
4304 #  define DEBUG_yv(a) DEBUG__(DEBUG_yv_TEST, a)
4305 
4306 #  define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
4307 #  define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
4308 #  define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
4309 #  define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
4310 #  define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
4311 #  define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
4312 #  define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
4313 #  define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
4314 #  define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
4315 #  define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
4316 #  define DEBUG_i(a) DEBUG__(DEBUG_i_TEST, a)
4317 #  define DEBUG_y(a) DEBUG__(DEBUG_y_TEST, a)
4318 
4319 #else /* ! DEBUGGING below */
4320 
4321 #  define DEBUG_p_TEST (0)
4322 #  define DEBUG_s_TEST (0)
4323 #  define DEBUG_l_TEST (0)
4324 #  define DEBUG_t_TEST (0)
4325 #  define DEBUG_o_TEST (0)
4326 #  define DEBUG_c_TEST (0)
4327 #  define DEBUG_P_TEST (0)
4328 #  define DEBUG_m_TEST (0)
4329 #  define DEBUG_f_TEST (0)
4330 #  define DEBUG_r_TEST (0)
4331 #  define DEBUG_x_TEST (0)
4332 #  define DEBUG_u_TEST (0)
4333 #  define DEBUG_U_TEST (0)
4334 #  define DEBUG_X_TEST (0)
4335 #  define DEBUG_D_TEST (0)
4336 #  define DEBUG_S_TEST (0)
4337 #  define DEBUG_T_TEST (0)
4338 #  define DEBUG_R_TEST (0)
4339 #  define DEBUG_J_TEST (0)
4340 #  define DEBUG_v_TEST (0)
4341 #  define DEBUG_C_TEST (0)
4342 #  define DEBUG_A_TEST (0)
4343 #  define DEBUG_q_TEST (0)
4344 #  define DEBUG_M_TEST (0)
4345 #  define DEBUG_B_TEST (0)
4346 #  define DEBUG_L_TEST (0)
4347 #  define DEBUG_i_TEST (0)
4348 #  define DEBUG_y_TEST (0)
4349 #  define DEBUG_Xv_TEST (0)
4350 #  define DEBUG_Uv_TEST (0)
4351 #  define DEBUG_Pv_TEST (0)
4352 #  define DEBUG_Lv_TEST (0)
4353 #  define DEBUG_yv_TEST (0)
4354 
4355 #  define PERL_DEB(a)
4356 #  define PERL_DEB2(a,b)               b
4357 #  define PERL_DEBUG(a)
4358 #  define DEBUG_p(a)
4359 #  define DEBUG_s(a)
4360 #  define DEBUG_l(a)
4361 #  define DEBUG_t(a)
4362 #  define DEBUG_o(a)
4363 #  define DEBUG_c(a)
4364 #  define DEBUG_P(a)
4365 #  define DEBUG_m(a)
4366 #  define DEBUG_f(a)
4367 #  define DEBUG_r(a)
4368 #  define DEBUG_x(a)
4369 #  define DEBUG_u(a)
4370 #  define DEBUG_U(a)
4371 #  define DEBUG_X(a)
4372 #  define DEBUG_D(a)
4373 #  define DEBUG_S(a)
4374 #  define DEBUG_T(a)
4375 #  define DEBUG_R(a)
4376 #  define DEBUG_v(a)
4377 #  define DEBUG_C(a)
4378 #  define DEBUG_A(a)
4379 #  define DEBUG_q(a)
4380 #  define DEBUG_M(a)
4381 #  define DEBUG_B(a)
4382 #  define DEBUG_L(a)
4383 #  define DEBUG_i(a)
4384 #  define DEBUG_y(a)
4385 #  define DEBUG_Xv(a)
4386 #  define DEBUG_Uv(a)
4387 #  define DEBUG_Pv(a)
4388 #  define DEBUG_Lv(a)
4389 #  define DEBUG_yv(a)
4390 #endif /* DEBUGGING */
4391 
4392 
4393 #define DEBUG_SCOPE(where) \
4394     DEBUG_l( \
4395     Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n",	\
4396 		    where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
4397 		    __FILE__, __LINE__));
4398 
4399 /* Keep the old croak based assert for those who want it, and as a fallback if
4400    the platform is so heretically non-ANSI that it can't assert.  */
4401 
4402 #define Perl_assert(what)	PERL_DEB2( 				\
4403 	((what) ? ((void) 0) :						\
4404 	    (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
4405 			"\", line %d", STRINGIFY(what), __LINE__),	\
4406              (void) 0)), ((void)0))
4407 
4408 /* assert() gets defined if DEBUGGING.
4409  * If no DEBUGGING, the <assert.h> has not been included. */
4410 #ifndef assert
4411 #  define assert(what)	Perl_assert(what)
4412 #endif
4413 #ifdef DEBUGGING
4414 #  define assert_(what)	assert(what),
4415 #else
4416 #  define assert_(what)
4417 #endif
4418 
4419 struct ufuncs {
4420     I32 (*uf_val)(pTHX_ IV, SV*);
4421     I32 (*uf_set)(pTHX_ IV, SV*);
4422     IV uf_index;
4423 };
4424 
4425 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
4426  * XS code wanting to be backward compatible can do something
4427  * like the following:
4428 
4429 #ifndef PERL_MG_UFUNC
4430 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
4431 #endif
4432 
4433 static PERL_MG_UFUNC(foo_get, index, val)
4434 {
4435     sv_setsv(val, ...);
4436     return TRUE;
4437 }
4438 
4439 -- Doug MacEachern
4440 
4441 */
4442 
4443 #ifndef PERL_MG_UFUNC
4444 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
4445 #endif
4446 
4447 #include <math.h>
4448 #ifdef __VMS
4449      /* isfinite and others are here rather than in math.h as C99 stipulates */
4450 #    include <fp.h>
4451 #endif
4452 
4453 #ifndef __cplusplus
4454 #  if !defined(WIN32) && !defined(VMS)
4455 #ifndef crypt
4456 char *crypt (const char*, const char*);
4457 #endif
4458 #  endif /* !WIN32 */
4459 #  ifndef WIN32
4460 #    ifndef getlogin
4461 char *getlogin (void);
4462 #    endif
4463 #  endif /* !WIN32 */
4464 #endif /* !__cplusplus */
4465 
4466 /* Fixme on VMS.  This needs to be a run-time, not build time options */
4467 /* Also rename() is affected by this */
4468 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4469 #define UNLINK unlnk
4470 I32 unlnk (pTHX_ const char*);
4471 #else
4472 #define UNLINK PerlLIO_unlink
4473 #endif
4474 
4475 /* some versions of glibc are missing the setresuid() proto */
4476 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4477 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4478 #endif
4479 /* some versions of glibc are missing the setresgid() proto */
4480 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4481 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4482 #endif
4483 
4484 #ifndef HAS_SETREUID
4485 #  ifdef HAS_SETRESUID
4486 #    define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4487 #    define HAS_SETREUID
4488 #  endif
4489 #endif
4490 #ifndef HAS_SETREGID
4491 #  ifdef HAS_SETRESGID
4492 #    define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4493 #    define HAS_SETREGID
4494 #  endif
4495 #endif
4496 
4497 /* Sighandler_t defined in iperlsys.h */
4498 
4499 #ifdef HAS_SIGACTION
4500 typedef struct sigaction Sigsave_t;
4501 #else
4502 typedef Sighandler_t Sigsave_t;
4503 #endif
4504 
4505 #define SCAN_DEF 0
4506 #define SCAN_TR 1
4507 #define SCAN_REPL 2
4508 
4509 #ifdef DEBUGGING
4510 # ifndef register
4511 #  define register
4512 # endif
4513 # define RUNOPS_DEFAULT Perl_runops_debug
4514 #else
4515 # define RUNOPS_DEFAULT Perl_runops_standard
4516 #endif
4517 
4518 #if defined(USE_PERLIO)
4519 EXTERN_C void PerlIO_teardown(void);
4520 # ifdef USE_ITHREADS
4521 #  define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4522 #  define PERLIO_TERM 				\
4523 	STMT_START {				\
4524 		PerlIO_teardown();		\
4525 		MUTEX_DESTROY(&PL_perlio_mutex);\
4526 	} STMT_END
4527 # else
4528 #  define PERLIO_INIT
4529 #  define PERLIO_TERM	PerlIO_teardown()
4530 # endif
4531 #else
4532 #  define PERLIO_INIT
4533 #  define PERLIO_TERM
4534 #endif
4535 
4536 #ifdef MYMALLOC
4537 #  ifdef MUTEX_INIT_CALLS_MALLOC
4538 #    define MALLOC_INIT					\
4539 	STMT_START {					\
4540 		PL_malloc_mutex = NULL;			\
4541 		MUTEX_INIT(&PL_malloc_mutex);		\
4542 	} STMT_END
4543 #    define MALLOC_TERM					\
4544 	STMT_START {					\
4545 		perl_mutex tmp = PL_malloc_mutex;	\
4546 		PL_malloc_mutex = NULL;			\
4547 		MUTEX_DESTROY(&tmp);			\
4548 	} STMT_END
4549 #  else
4550 #    define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4551 #    define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4552 #  endif
4553 #else
4554 #  define MALLOC_INIT
4555 #  define MALLOC_TERM
4556 #endif
4557 
4558 #if defined(PERL_IMPLICIT_CONTEXT)
4559 
4560 struct perl_memory_debug_header;
4561 struct perl_memory_debug_header {
4562   tTHX	interpreter;
4563 #  if defined(PERL_POISON) || defined(PERL_DEBUG_READONLY_COW)
4564   MEM_SIZE size;
4565 #  endif
4566   struct perl_memory_debug_header *prev;
4567   struct perl_memory_debug_header *next;
4568 #  ifdef PERL_DEBUG_READONLY_COW
4569   bool readonly;
4570 #  endif
4571 };
4572 
4573 #elif defined(PERL_DEBUG_READONLY_COW)
4574 
4575 struct perl_memory_debug_header;
4576 struct perl_memory_debug_header {
4577   MEM_SIZE size;
4578 };
4579 
4580 #endif
4581 
4582 #if defined (PERL_TRACK_MEMPOOL) || defined (PERL_DEBUG_READONLY_COW)
4583 
4584 #  define PERL_MEMORY_DEBUG_HEADER_SIZE \
4585         (sizeof(struct perl_memory_debug_header) + \
4586 	(MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4587 	 %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4588 
4589 #else
4590 #  define PERL_MEMORY_DEBUG_HEADER_SIZE	0
4591 #endif
4592 
4593 #ifdef PERL_TRACK_MEMPOOL
4594 # ifdef PERL_DEBUG_READONLY_COW
4595 #  define INIT_TRACK_MEMPOOL(header, interp)			\
4596 	STMT_START {						\
4597 		(header).interpreter = (interp);		\
4598 		(header).prev = (header).next = &(header);	\
4599 		(header).readonly = 0;				\
4600 	} STMT_END
4601 # else
4602 #  define INIT_TRACK_MEMPOOL(header, interp)			\
4603 	STMT_START {						\
4604 		(header).interpreter = (interp);		\
4605 		(header).prev = (header).next = &(header);	\
4606 	} STMT_END
4607 # endif
4608 # else
4609 #  define INIT_TRACK_MEMPOOL(header, interp)
4610 #endif
4611 
4612 #ifdef I_MALLOCMALLOC
4613 /* Needed for malloc_size(), malloc_good_size() on some systems */
4614 #  include <malloc/malloc.h>
4615 #endif
4616 
4617 #ifdef MYMALLOC
4618 #  define Perl_safesysmalloc_size(where)	Perl_malloced_size(where)
4619 #else
4620 #  if defined(HAS_MALLOC_SIZE) && !defined(PERL_DEBUG_READONLY_COW)
4621 #    ifdef PERL_TRACK_MEMPOOL
4622 #	define Perl_safesysmalloc_size(where)			\
4623 	    (malloc_size(((char *)(where)) - PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4624 #    else
4625 #	define Perl_safesysmalloc_size(where) malloc_size(where)
4626 #    endif
4627 #  endif
4628 #  ifdef HAS_MALLOC_GOOD_SIZE
4629 #    ifdef PERL_TRACK_MEMPOOL
4630 #	define Perl_malloc_good_size(how_much)			\
4631 	    (malloc_good_size((how_much) + PERL_MEMORY_DEBUG_HEADER_SIZE) - PERL_MEMORY_DEBUG_HEADER_SIZE)
4632 #    else
4633 #	define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4634 #    endif
4635 #  else
4636 /* Having this as the identity operation makes some code simpler.  */
4637 #	define Perl_malloc_good_size(how_much)	(how_much)
4638 #  endif
4639 #endif
4640 
4641 typedef int (*runops_proc_t)(pTHX);
4642 typedef void (*share_proc_t) (pTHX_ SV *sv);
4643 typedef int  (*thrhook_proc_t) (pTHX);
4644 typedef OP* (*PPADDR_t[]) (pTHX);
4645 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4646 typedef void (*despatch_signals_proc_t) (pTHX);
4647 
4648 #if defined(__DYNAMIC__) && defined(PERL_DARWIN) && defined(PERL_CORE)
4649 #  include <crt_externs.h>	/* for the env array */
4650 #  define environ (*_NSGetEnviron())
4651 #elif defined(USE_ENVIRON_ARRAY) && !defined(environ)
4652    /* VMS and some other platforms don't use the environ array */
4653 EXTERN_C char **environ;  /* environment variables supplied via exec */
4654 #endif
4655 
4656 #define PERL_PATCHLEVEL_H_IMPLICIT
4657 #include "patchlevel.h"
4658 #undef PERL_PATCHLEVEL_H_IMPLICIT
4659 
4660 #define PERL_VERSION_STRING	STRINGIFY(PERL_REVISION) "." \
4661 				STRINGIFY(PERL_VERSION) "." \
4662 				STRINGIFY(PERL_SUBVERSION)
4663 
4664 #define PERL_API_VERSION_STRING	STRINGIFY(PERL_API_REVISION) "." \
4665 				STRINGIFY(PERL_API_VERSION) "." \
4666 				STRINGIFY(PERL_API_SUBVERSION)
4667 
4668 START_EXTERN_C
4669 
4670 /* handy constants */
4671 EXTCONST char PL_warn_uninit[]
4672   INIT("Use of uninitialized value%s%s%s");
4673 EXTCONST char PL_warn_uninit_sv[]
4674   INIT("Use of uninitialized value%" SVf "%s%s");
4675 EXTCONST char PL_warn_nosemi[]
4676   INIT("Semicolon seems to be missing");
4677 EXTCONST char PL_warn_reserved[]
4678   INIT("Unquoted string \"%s\" may clash with future reserved word");
4679 EXTCONST char PL_warn_nl[]
4680   INIT("Unsuccessful %s on filename containing newline");
4681 EXTCONST char PL_no_wrongref[]
4682   INIT("Can't use %s ref as %s ref");
4683 /* The core no longer needs this here. If you require the string constant,
4684    please inline a copy into your own code.  */
4685 EXTCONST char PL_no_symref[] __attribute__deprecated__
4686   INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4687 EXTCONST char PL_no_symref_sv[]
4688   INIT("Can't use string (\"%" SVf32 "\"%s) as %s ref while \"strict refs\" in use");
4689 
4690 EXTCONST char PL_no_usym[]
4691   INIT("Can't use an undefined value as %s reference");
4692 EXTCONST char PL_no_aelem[]
4693   INIT("Modification of non-creatable array value attempted, subscript %d");
4694 EXTCONST char PL_no_helem_sv[]
4695   INIT("Modification of non-creatable hash value attempted, subscript \"%" SVf "\"");
4696 EXTCONST char PL_no_modify[]
4697   INIT("Modification of a read-only value attempted");
4698 EXTCONST char PL_no_mem[sizeof("Out of memory!\n")]
4699   INIT("Out of memory!\n");
4700 EXTCONST char PL_no_security[]
4701   INIT("Insecure dependency in %s%s");
4702 EXTCONST char PL_no_sock_func[]
4703   INIT("Unsupported socket function \"%s\" called");
4704 EXTCONST char PL_no_dir_func[]
4705   INIT("Unsupported directory function \"%s\" called");
4706 EXTCONST char PL_no_func[]
4707   INIT("The %s function is unimplemented");
4708 EXTCONST char PL_no_myglob[]
4709   INIT("\"%s\" %s %s can't be in a package");
4710 EXTCONST char PL_no_localize_ref[]
4711   INIT("Can't localize through a reference");
4712 EXTCONST char PL_memory_wrap[]
4713   INIT("panic: memory wrap");
4714 EXTCONST char PL_extended_cp_format[]
4715   INIT("Code point 0x%" UVXf " is not Unicode, requires a Perl extension,"
4716                              " and so is not portable");
4717 EXTCONST char PL_Yes[]
4718   INIT("1");
4719 EXTCONST char PL_No[]
4720   INIT("");
4721 EXTCONST char PL_Zero[]
4722   INIT("0");
4723 EXTCONST char PL_hexdigit[]
4724   INIT("0123456789abcdef0123456789ABCDEF");
4725 
4726 EXTCONST STRLEN PL_WARN_ALL
4727   INIT(0);
4728 EXTCONST STRLEN PL_WARN_NONE
4729   INIT(0);
4730 
4731 /* This is constant on most architectures, a global on OS/2 */
4732 #ifndef OS2
4733 EXTCONST char PL_sh_path[]
4734   INIT(SH_PATH); /* full path of shell */
4735 #endif
4736 
4737 #ifdef CSH
4738 EXTCONST char PL_cshname[]
4739   INIT(CSH);
4740 #  define PL_cshlen	(sizeof(CSH "") - 1)
4741 #endif
4742 
4743 /* These are baked at compile time into any shared perl library.
4744    In future releases this will allow us in main() to sanity test the
4745    library we're linking against.  */
4746 
4747 EXTCONST U8 PL_revision
4748   INIT(PERL_REVISION);
4749 EXTCONST U8 PL_version
4750   INIT(PERL_VERSION);
4751 EXTCONST U8 PL_subversion
4752   INIT(PERL_SUBVERSION);
4753 
4754 EXTCONST char PL_uuemap[65]
4755   INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4756 
4757 /* a special string address whose value is "isa", but which perl knows
4758  * to treat as if it were really "DOES" when printing the method name in
4759  *  the "Can't call method '%s'" error message */
4760 EXTCONST char PL_isa_DOES[]
4761   INIT("isa");
4762 
4763 #ifdef DOINIT
4764 EXTCONST char PL_uudmap[256] =
4765 #  ifdef PERL_MICRO
4766 #    include "uuudmap.h"
4767 #  else
4768 #    include "uudmap.h"
4769 #  endif
4770 ;
4771 EXTCONST char PL_bitcount[256] =
4772 #  ifdef PERL_MICRO
4773 #    include "ubitcount.h"
4774 #else
4775 #    include "bitcount.h"
4776 #  endif
4777 ;
4778 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4779 EXTCONST int         PL_sig_num[]  = { SIG_NUM };
4780 #else
4781 EXTCONST char PL_uudmap[256];
4782 EXTCONST char PL_bitcount[256];
4783 EXTCONST char* const PL_sig_name[];
4784 EXTCONST int         PL_sig_num[];
4785 #endif
4786 
4787 /* fast conversion and case folding tables.  The folding tables complement the
4788  * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4789  * folds such as outside the range or to multiple characters. */
4790 
4791 #ifdef DOINIT
4792 #ifndef EBCDIC
4793 
4794 /* The EBCDIC fold table depends on the code page, and hence is found in
4795  * utfebcdic.h */
4796 
4797 EXTCONST  unsigned char PL_fold[] = {
4798 	0,	1,	2,	3,	4,	5,	6,	7,
4799 	8,	9,	10,	11,	12,	13,	14,	15,
4800 	16,	17,	18,	19,	20,	21,	22,	23,
4801 	24,	25,	26,	27,	28,	29,	30,	31,
4802 	32,	33,	34,	35,	36,	37,	38,	39,
4803 	40,	41,	42,	43,	44,	45,	46,	47,
4804 	48,	49,	50,	51,	52,	53,	54,	55,
4805 	56,	57,	58,	59,	60,	61,	62,	63,
4806 	64,	'a',	'b',	'c',	'd',	'e',	'f',	'g',
4807 	'h',	'i',	'j',	'k',	'l',	'm',	'n',	'o',
4808 	'p',	'q',	'r',	's',	't',	'u',	'v',	'w',
4809 	'x',	'y',	'z',	91,	92,	93,	94,	95,
4810 	96,	'A',	'B',	'C',	'D',	'E',	'F',	'G',
4811 	'H',	'I',	'J',	'K',	'L',	'M',	'N',	'O',
4812 	'P',	'Q',	'R',	'S',	'T',	'U',	'V',	'W',
4813 	'X',	'Y',	'Z',	123,	124,	125,	126,	127,
4814 	128,	129,	130,	131,	132,	133,	134,	135,
4815 	136,	137,	138,	139,	140,	141,	142,	143,
4816 	144,	145,	146,	147,	148,	149,	150,	151,
4817 	152,	153,	154,	155,	156,	157,	158,	159,
4818 	160,	161,	162,	163,	164,	165,	166,	167,
4819 	168,	169,	170,	171,	172,	173,	174,	175,
4820 	176,	177,	178,	179,	180,	181,	182,	183,
4821 	184,	185,	186,	187,	188,	189,	190,	191,
4822 	192,	193,	194,	195,	196,	197,	198,	199,
4823 	200,	201,	202,	203,	204,	205,	206,	207,
4824 	208,	209,	210,	211,	212,	213,	214,	215,
4825 	216,	217,	218,	219,	220,	221,	222,	223,
4826 	224,	225,	226,	227,	228,	229,	230,	231,
4827 	232,	233,	234,	235,	236,	237,	238,	239,
4828 	240,	241,	242,	243,	244,	245,	246,	247,
4829 	248,	249,	250,	251,	252,	253,	254,	255
4830 };
4831 EXTCONST  unsigned char PL_fold_latin1[] = {
4832     /* Full latin1 complement folding, except for three problematic code points:
4833      *	Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4834      *	fold complements outside the Latin1 range, so can't match something
4835      *	that isn't in utf8.
4836      *	German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4837      *	not one, so can't be represented in this table.
4838      *
4839      * All have to be specially handled */
4840 	0,	1,	2,	3,	4,	5,	6,	7,
4841 	8,	9,	10,	11,	12,	13,	14,	15,
4842 	16,	17,	18,	19,	20,	21,	22,	23,
4843 	24,	25,	26,	27,	28,	29,	30,	31,
4844 	32,	33,	34,	35,	36,	37,	38,	39,
4845 	40,	41,	42,	43,	44,	45,	46,	47,
4846 	48,	49,	50,	51,	52,	53,	54,	55,
4847 	56,	57,	58,	59,	60,	61,	62,	63,
4848 	64,	'a',	'b',	'c',	'd',	'e',	'f',	'g',
4849 	'h',	'i',	'j',	'k',	'l',	'm',	'n',	'o',
4850 	'p',	'q',	'r',	's',	't',	'u',	'v',	'w',
4851 	'x',	'y',	'z',	91,	92,	93,	94,	95,
4852 	96,	'A',	'B',	'C',	'D',	'E',	'F',	'G',
4853 	'H',	'I',	'J',	'K',	'L',	'M',	'N',	'O',
4854 	'P',	'Q',	'R',	'S',	'T',	'U',	'V',	'W',
4855 	'X',	'Y',	'Z',	123,	124,	125,	126,	127,
4856 	128,	129,	130,	131,	132,	133,	134,	135,
4857 	136,	137,	138,	139,	140,	141,	142,	143,
4858 	144,	145,	146,	147,	148,	149,	150,	151,
4859 	152,	153,	154,	155,	156,	157,	158,	159,
4860 	160,	161,	162,	163,	164,	165,	166,	167,
4861 	168,	169,	170,	171,	172,	173,	174,	175,
4862 	176,	177,	178,	179,	180,	181 /*micro */,	182,	183,
4863 	184,	185,	186,	187,	188,	189,	190,	191,
4864 	192+32,	193+32,	194+32,	195+32,	196+32,	197+32,	198+32,	199+32,
4865 	200+32,	201+32,	202+32,	203+32,	204+32,	205+32,	206+32,	207+32,
4866 	208+32,	209+32,	210+32,	211+32,	212+32,	213+32,	214+32,	215,
4867 	216+32,	217+32,	218+32,	219+32,	220+32,	221+32,	222+32,	223 /* ss */,
4868 	224-32,	225-32,	226-32,	227-32,	228-32,	229-32,	230-32,	231-32,
4869 	232-32,	233-32,	234-32,	235-32,	236-32,	237-32,	238-32,	239-32,
4870 	240-32,	241-32,	242-32,	243-32,	244-32,	245-32,	246-32,	247,
4871 	248-32,	249-32,	250-32,	251-32,	252-32,	253-32,	254-32,
4872 	255 /* y with diaeresis */
4873 };
4874 
4875 /* If these tables are accessed through ebcdic, the access will be converted to
4876  * latin1 first */
4877 EXTCONST  unsigned char PL_latin1_lc[] = {  /* lowercasing */
4878 	0,	1,	2,	3,	4,	5,	6,	7,
4879 	8,	9,	10,	11,	12,	13,	14,	15,
4880 	16,	17,	18,	19,	20,	21,	22,	23,
4881 	24,	25,	26,	27,	28,	29,	30,	31,
4882 	32,	33,	34,	35,	36,	37,	38,	39,
4883 	40,	41,	42,	43,	44,	45,	46,	47,
4884 	48,	49,	50,	51,	52,	53,	54,	55,
4885 	56,	57,	58,	59,	60,	61,	62,	63,
4886 	64,	'a',	'b',	'c',	'd',	'e',	'f',	'g',
4887 	'h',	'i',	'j',	'k',	'l',	'm',	'n',	'o',
4888 	'p',	'q',	'r',	's',	't',	'u',	'v',	'w',
4889 	'x',	'y',	'z',	91,	92,	93,	94,	95,
4890 	96,	97,	98,	99,	100,	101,	102,	103,
4891 	104,	105,	106,	107,	108,	109,	110,	111,
4892 	112,	113,	114,	115,	116,	117,	118,	119,
4893 	120,	121,	122,	123,	124,	125,	126,	127,
4894 	128,	129,	130,	131,	132,	133,	134,	135,
4895 	136,	137,	138,	139,	140,	141,	142,	143,
4896 	144,	145,	146,	147,	148,	149,	150,	151,
4897 	152,	153,	154,	155,	156,	157,	158,	159,
4898 	160,	161,	162,	163,	164,	165,	166,	167,
4899 	168,	169,	170,	171,	172,	173,	174,	175,
4900 	176,	177,	178,	179,	180,	181,	182,	183,
4901 	184,	185,	186,	187,	188,	189,	190,	191,
4902 	192+32,	193+32,	194+32,	195+32,	196+32,	197+32,	198+32,	199+32,
4903 	200+32,	201+32,	202+32,	203+32,	204+32,	205+32,	206+32,	207+32,
4904 	208+32,	209+32,	210+32,	211+32,	212+32,	213+32,	214+32,	215,
4905 	216+32,	217+32,	218+32,	219+32,	220+32,	221+32,	222+32,	223,
4906 	224,	225,	226,	227,	228,	229,	230,	231,
4907 	232,	233,	234,	235,	236,	237,	238,	239,
4908 	240,	241,	242,	243,	244,	245,	246,	247,
4909 	248,	249,	250,	251,	252,	253,	254,	255
4910 };
4911 
4912 /* upper and title case of latin1 characters, modified so that the three tricky
4913  * ones are mapped to 255 (which is one of the three) */
4914 EXTCONST  unsigned char PL_mod_latin1_uc[] = {
4915 	0,	1,	2,	3,	4,	5,	6,	7,
4916 	8,	9,	10,	11,	12,	13,	14,	15,
4917 	16,	17,	18,	19,	20,	21,	22,	23,
4918 	24,	25,	26,	27,	28,	29,	30,	31,
4919 	32,	33,	34,	35,	36,	37,	38,	39,
4920 	40,	41,	42,	43,	44,	45,	46,	47,
4921 	48,	49,	50,	51,	52,	53,	54,	55,
4922 	56,	57,	58,	59,	60,	61,	62,	63,
4923 	64,	65,	66,	67,	68,	69,	70,	71,
4924 	72,	73,	74,	75,	76,	77,	78,	79,
4925 	80,	81,	82,	83,	84,	85,	86,	87,
4926 	88,	89,	90,	91,	92,	93,	94,	95,
4927 	96,	'A',	'B',	'C',	'D',	'E',	'F',	'G',
4928 	'H',	'I',	'J',	'K',	'L',	'M',	'N',	'O',
4929 	'P',	'Q',	'R',	'S',	'T',	'U',	'V',	'W',
4930 	'X',	'Y',	'Z',	123,	124,	125,	126,	127,
4931 	128,	129,	130,	131,	132,	133,	134,	135,
4932 	136,	137,	138,	139,	140,	141,	142,	143,
4933 	144,	145,	146,	147,	148,	149,	150,	151,
4934 	152,	153,	154,	155,	156,	157,	158,	159,
4935 	160,	161,	162,	163,	164,	165,	166,	167,
4936 	168,	169,	170,	171,	172,	173,	174,	175,
4937 	176,	177,	178,	179,	180,	255 /*micro*/,	182,	183,
4938 	184,	185,	186,	187,	188,	189,	190,	191,
4939 	192,	193,	194,	195,	196,	197,	198,	199,
4940 	200,	201,	202,	203,	204,	205,	206,	207,
4941 	208,	209,	210,	211,	212,	213,	214,	215,
4942 	216,	217,	218,	219,	220,	221,	222,
4943 #if    UNICODE_MAJOR_VERSION > 2                                        \
4944    || (UNICODE_MAJOR_VERSION == 2 && UNICODE_DOT_VERSION >= 1		\
4945                                   && UNICODE_DOT_DOT_VERSION >= 8)
4946 	                                                        255 /*sharp s*/,
4947 #else   /* uc(sharp s) is 'sharp s' itself in early unicode */
4948 	                                                        223,
4949 #endif
4950 	224-32,	225-32,	226-32,	227-32,	228-32,	229-32,	230-32,	231-32,
4951 	232-32,	233-32,	234-32,	235-32,	236-32,	237-32,	238-32,	239-32,
4952 	240-32,	241-32,	242-32,	243-32,	244-32,	245-32,	246-32,	247,
4953 	248-32,	249-32,	250-32,	251-32,	252-32,	253-32,	254-32,	255
4954 };
4955 #endif  /* !EBCDIC, but still in DOINIT */
4956 #else	/* ! DOINIT */
4957 #   ifndef EBCDIC
4958 EXTCONST unsigned char PL_fold[];
4959 EXTCONST unsigned char PL_fold_latin1[];
4960 EXTCONST unsigned char PL_mod_latin1_uc[];
4961 EXTCONST unsigned char PL_latin1_lc[];
4962 #   endif
4963 #endif
4964 
4965 #ifndef PERL_GLOBAL_STRUCT /* or perlvars.h */
4966 #ifdef DOINIT
4967 EXT unsigned char PL_fold_locale[256] = { /* Unfortunately not EXTCONST. */
4968 	0,	1,	2,	3,	4,	5,	6,	7,
4969 	8,	9,	10,	11,	12,	13,	14,	15,
4970 	16,	17,	18,	19,	20,	21,	22,	23,
4971 	24,	25,	26,	27,	28,	29,	30,	31,
4972 	32,	33,	34,	35,	36,	37,	38,	39,
4973 	40,	41,	42,	43,	44,	45,	46,	47,
4974 	48,	49,	50,	51,	52,	53,	54,	55,
4975 	56,	57,	58,	59,	60,	61,	62,	63,
4976 	64,	'a',	'b',	'c',	'd',	'e',	'f',	'g',
4977 	'h',	'i',	'j',	'k',	'l',	'm',	'n',	'o',
4978 	'p',	'q',	'r',	's',	't',	'u',	'v',	'w',
4979 	'x',	'y',	'z',	91,	92,	93,	94,	95,
4980 	96,	'A',	'B',	'C',	'D',	'E',	'F',	'G',
4981 	'H',	'I',	'J',	'K',	'L',	'M',	'N',	'O',
4982 	'P',	'Q',	'R',	'S',	'T',	'U',	'V',	'W',
4983 	'X',	'Y',	'Z',	123,	124,	125,	126,	127,
4984 	128,	129,	130,	131,	132,	133,	134,	135,
4985 	136,	137,	138,	139,	140,	141,	142,	143,
4986 	144,	145,	146,	147,	148,	149,	150,	151,
4987 	152,	153,	154,	155,	156,	157,	158,	159,
4988 	160,	161,	162,	163,	164,	165,	166,	167,
4989 	168,	169,	170,	171,	172,	173,	174,	175,
4990 	176,	177,	178,	179,	180,	181,	182,	183,
4991 	184,	185,	186,	187,	188,	189,	190,	191,
4992 	192,	193,	194,	195,	196,	197,	198,	199,
4993 	200,	201,	202,	203,	204,	205,	206,	207,
4994 	208,	209,	210,	211,	212,	213,	214,	215,
4995 	216,	217,	218,	219,	220,	221,	222,	223,
4996 	224,	225,	226,	227,	228,	229,	230,	231,
4997 	232,	233,	234,	235,	236,	237,	238,	239,
4998 	240,	241,	242,	243,	244,	245,	246,	247,
4999 	248,	249,	250,	251,	252,	253,	254,	255
5000 };
5001 #else
5002 EXT unsigned char PL_fold_locale[256]; /* Unfortunately not EXTCONST. */
5003 #endif
5004 #endif /* !PERL_GLOBAL_STRUCT */
5005 
5006 #ifdef DOINIT
5007 #ifdef EBCDIC
5008 EXTCONST unsigned char PL_freq[] = {/* EBCDIC frequencies for mixed English/C */
5009     1,      2,      84,     151,    154,    155,    156,    157,
5010     165,    246,    250,    3,      158,    7,      18,     29,
5011     40,     51,     62,     73,     85,     96,     107,    118,
5012     129,    140,    147,    148,    149,    150,    152,    153,
5013     255,      6,      8,      9,     10,     11,     12,     13,
5014      14,     15,     24,     25,     26,     27,     28,    226,
5015      29,     30,     31,     32,     33,     43,     44,     45,
5016      46,     47,     48,     49,     50,     76,     77,     78,
5017      79,     80,     81,     82,     83,     84,     85,     86,
5018      87,     94,     95,    234,    181,    233,    187,    190,
5019     180,     96,     97,     98,     99,    100,    101,    102,
5020     104,    112,    182,    174,    236,    232,    229,    103,
5021     228,    226,    114,    115,    116,    117,    118,    119,
5022     120,    121,    122,    235,    176,    230,    194,    162,
5023     130,    131,    132,    133,    134,    135,    136,    137,
5024     138,    139,    201,    205,    163,    217,    220,    224,
5025     5,      248,    227,    244,    242,    255,    241,    231,
5026     240,    253,    16,     197,    19,     20,     21,     187,
5027     23,     169,    210,    245,    237,    249,    247,    239,
5028     168,    252,    34,     196,    36,     37,     38,     39,
5029     41,     42,     251,    254,    238,    223,    221,    213,
5030     225,    177,    52,     53,     54,     55,     56,     57,
5031     58,     59,     60,     61,     63,     64,     65,     66,
5032     67,     68,     69,     70,     71,     72,     74,     75,
5033     205,    208,    186,    202,    200,    218,    198,    179,
5034     178,    214,    88,     89,     90,     91,     92,     93,
5035     217,    166,    170,    207,    199,    209,    206,    204,
5036     160,    212,    105,    106,    108,    109,    110,    111,
5037     203,    113,    216,    215,    192,    175,    193,    243,
5038     172,    161,    123,    124,    125,    126,    127,    128,
5039     222,    219,    211,    195,    188,    193,    185,    184,
5040     191,    183,    141,    142,    143,    144,    145,    146
5041 };
5042 #else  /* ascii rather than ebcdic */
5043 EXTCONST unsigned char PL_freq[] = {	/* letter frequencies for mixed English/C */
5044 	1,	2,	84,	151,	154,	155,	156,	157,
5045 	165,	246,	250,	3,	158,	7,	18,	29,
5046 	40,	51,	62,	73,	85,	96,	107,	118,
5047 	129,	140,	147,	148,	149,	150,	152,	153,
5048 	255,	182,	224,	205,	174,	176,	180,	217,
5049 	233,	232,	236,	187,	235,	228,	234,	226,
5050 	222,	219,	211,	195,	188,	193,	185,	184,
5051 	191,	183,	201,	229,	181,	220,	194,	162,
5052 	163,	208,	186,	202,	200,	218,	198,	179,
5053 	178,	214,	166,	170,	207,	199,	209,	206,
5054 	204,	160,	212,	216,	215,	192,	175,	173,
5055 	243,	172,	161,	190,	203,	189,	164,	230,
5056 	167,	248,	227,	244,	242,	255,	241,	231,
5057 	240,	253,	169,	210,	245,	237,	249,	247,
5058 	239,	168,	252,	251,	254,	238,	223,	221,
5059 	213,	225,	177,	197,	171,	196,	159,	4,
5060 	5,	6,	8,	9,	10,	11,	12,	13,
5061 	14,	15,	16,	17,	19,	20,	21,	22,
5062 	23,	24,	25,	26,	27,	28,	30,	31,
5063 	32,	33,	34,	35,	36,	37,	38,	39,
5064 	41,	42,	43,	44,	45,	46,	47,	48,
5065 	49,	50,	52,	53,	54,	55,	56,	57,
5066 	58,	59,	60,	61,	63,	64,	65,	66,
5067 	67,	68,	69,	70,	71,	72,	74,	75,
5068 	76,	77,	78,	79,	80,	81,	82,	83,
5069 	86,	87,	88,	89,	90,	91,	92,	93,
5070 	94,	95,	97,	98,	99,	100,	101,	102,
5071 	103,	104,	105,	106,	108,	109,	110,	111,
5072 	112,	113,	114,	115,	116,	117,	119,	120,
5073 	121,	122,	123,	124,	125,	126,	127,	128,
5074 	130,	131,	132,	133,	134,	135,	136,	137,
5075 	138,	139,	141,	142,	143,	144,	145,	146
5076 };
5077 #endif
5078 #else
5079 EXTCONST unsigned char PL_freq[];
5080 #endif
5081 
5082 /* Although only used for debugging, these constants must be available in
5083  * non-debugging builds too, since they're used in ext/re/re_exec.c,
5084  * which has DEBUGGING enabled always */
5085 #ifdef DOINIT
5086 EXTCONST char* const PL_block_type[] = {
5087 	"NULL",
5088 	"WHEN",
5089 	"BLOCK",
5090 	"GIVEN",
5091 	"LOOP_ARY",
5092 	"LOOP_LAZYSV",
5093 	"LOOP_LAZYIV",
5094 	"LOOP_LIST",
5095 	"LOOP_PLAIN",
5096 	"SUB",
5097 	"FORMAT",
5098 	"EVAL",
5099 	"SUBST"
5100 };
5101 #else
5102 EXTCONST char* PL_block_type[];
5103 #endif
5104 
5105 /* These are all the compile time options that affect binary compatibility.
5106    Other compile time options that are binary compatible are in perl.c
5107    (in S_Internals_V()). Both are combined for the output of perl -V
5108    However, this string will be embedded in any shared perl library, which will
5109    allow us add a comparison check in perlmain.c in the near future.  */
5110 #ifdef DOINIT
5111 EXTCONST char PL_bincompat_options[] =
5112 #  ifdef DEBUG_LEAKING_SCALARS
5113 			     " DEBUG_LEAKING_SCALARS"
5114 #  endif
5115 #  ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5116 			     " DEBUG_LEAKING_SCALARS_FORK_DUMP"
5117 #  endif
5118 #  ifdef FCRYPT
5119 			     " FCRYPT"
5120 #  endif
5121 #  ifdef HAS_TIMES
5122 			     " HAS_TIMES"
5123 #  endif
5124 #  ifdef HAVE_INTERP_INTERN
5125 			     " HAVE_INTERP_INTERN"
5126 #  endif
5127 #  ifdef MULTIPLICITY
5128 			     " MULTIPLICITY"
5129 #  endif
5130 #  ifdef MYMALLOC
5131 			     " MYMALLOC"
5132 #  endif
5133 #  ifdef PERLIO_LAYERS
5134 			     " PERLIO_LAYERS"
5135 #  endif
5136 #  ifdef PERL_DEBUG_READONLY_COW
5137 			     " PERL_DEBUG_READONLY_COW"
5138 #  endif
5139 #  ifdef PERL_DEBUG_READONLY_OPS
5140 			     " PERL_DEBUG_READONLY_OPS"
5141 #  endif
5142 #  ifdef PERL_GLOBAL_STRUCT
5143 			     " PERL_GLOBAL_STRUCT"
5144 #  endif
5145 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
5146 			     " PERL_GLOBAL_STRUCT_PRIVATE"
5147 #  endif
5148 #  ifdef PERL_IMPLICIT_CONTEXT
5149 			     " PERL_IMPLICIT_CONTEXT"
5150 #  endif
5151 #  ifdef PERL_IMPLICIT_SYS
5152 			     " PERL_IMPLICIT_SYS"
5153 #  endif
5154 #  ifdef PERL_MICRO
5155 			     " PERL_MICRO"
5156 #  endif
5157 #  ifdef PERL_NEED_APPCTX
5158 			     " PERL_NEED_APPCTX"
5159 #  endif
5160 #  ifdef PERL_NEED_TIMESBASE
5161 			     " PERL_NEED_TIMESBASE"
5162 #  endif
5163 #  ifdef PERL_POISON
5164 			     " PERL_POISON"
5165 #  endif
5166 #  ifdef PERL_SAWAMPERSAND
5167 			     " PERL_SAWAMPERSAND"
5168 #  endif
5169 #  ifdef PERL_TRACK_MEMPOOL
5170 			     " PERL_TRACK_MEMPOOL"
5171 #  endif
5172 #  ifdef PERL_USES_PL_PIDSTATUS
5173 			     " PERL_USES_PL_PIDSTATUS"
5174 #  endif
5175 #  ifdef USE_64_BIT_ALL
5176 			     " USE_64_BIT_ALL"
5177 #  endif
5178 #  ifdef USE_64_BIT_INT
5179 			     " USE_64_BIT_INT"
5180 #  endif
5181 #  ifdef USE_IEEE
5182 			     " USE_IEEE"
5183 #  endif
5184 #  ifdef USE_ITHREADS
5185 			     " USE_ITHREADS"
5186 #  endif
5187 #  ifdef USE_LARGE_FILES
5188 			     " USE_LARGE_FILES"
5189 #  endif
5190 #  ifdef USE_LOCALE_COLLATE
5191 			     " USE_LOCALE_COLLATE"
5192 #  endif
5193 #  ifdef USE_LOCALE_NUMERIC
5194 			     " USE_LOCALE_NUMERIC"
5195 #  endif
5196 #  ifdef USE_LOCALE_TIME
5197 			     " USE_LOCALE_TIME"
5198 #  endif
5199 #  ifdef USE_LONG_DOUBLE
5200 			     " USE_LONG_DOUBLE"
5201 #  endif
5202 #  ifdef USE_PERLIO
5203 			     " USE_PERLIO"
5204 #  endif
5205 #  ifdef USE_QUADMATH
5206 			     " USE_QUADMATH"
5207 #  endif
5208 #  ifdef USE_REENTRANT_API
5209 			     " USE_REENTRANT_API"
5210 #  endif
5211 #  ifdef USE_SOCKS
5212 			     " USE_SOCKS"
5213 #  endif
5214 #  ifdef VMS_DO_SOCKETS
5215 			     " VMS_DO_SOCKETS"
5216 #  endif
5217 #  ifdef VMS_SHORTEN_LONG_SYMBOLS
5218 			     " VMS_SHORTEN_LONG_SYMBOLS"
5219 #  endif
5220 #  ifdef VMS_WE_ARE_CASE_SENSITIVE
5221 			     " VMS_SYMBOL_CASE_AS_IS"
5222 #  endif
5223   "";
5224 #else
5225 EXTCONST char PL_bincompat_options[];
5226 #endif
5227 
5228 #ifndef PERL_SET_PHASE
5229 #  define PERL_SET_PHASE(new_phase) \
5230     PERL_DTRACE_PROBE_PHASE(new_phase); \
5231     PL_phase = new_phase;
5232 #endif
5233 
5234 /* The interpreter phases. If these ever change, PL_phase_names right below will
5235  * need to be updated accordingly. */
5236 enum perl_phase {
5237     PERL_PHASE_CONSTRUCT	= 0,
5238     PERL_PHASE_START		= 1,
5239     PERL_PHASE_CHECK		= 2,
5240     PERL_PHASE_INIT		= 3,
5241     PERL_PHASE_RUN		= 4,
5242     PERL_PHASE_END		= 5,
5243     PERL_PHASE_DESTRUCT		= 6
5244 };
5245 
5246 #ifdef DOINIT
5247 EXTCONST char *const PL_phase_names[] = {
5248     "CONSTRUCT",
5249     "START",
5250     "CHECK",
5251     "INIT",
5252     "RUN",
5253     "END",
5254     "DESTRUCT"
5255 };
5256 #else
5257 EXTCONST char *const PL_phase_names[];
5258 #endif
5259 
5260 #ifndef PERL_CORE
5261 /* Do not use this macro. It only exists for extensions that rely on PL_dirty
5262  * instead of using the newer PL_phase, which provides everything PL_dirty
5263  * provided, and more. */
5264 #  define PL_dirty cBOOL(PL_phase == PERL_PHASE_DESTRUCT)
5265 
5266 #  define PL_amagic_generation PL_na
5267 #  define PL_encoding ((SV *)NULL)
5268 #endif /* !PERL_CORE */
5269 
5270 #define PL_hints PL_compiling.cop_hints
5271 #define PL_maxo  MAXO
5272 
5273 END_EXTERN_C
5274 
5275 /*****************************************************************************/
5276 /* This lexer/parser stuff is currently global since yacc is hard to reenter */
5277 /*****************************************************************************/
5278 /* XXX This needs to be revisited, since BEGIN makes yacc re-enter... */
5279 
5280 #ifdef __Lynx__
5281 /* LynxOS defines these in scsi.h which is included via ioctl.h */
5282 #ifdef FORMAT
5283 #undef FORMAT
5284 #endif
5285 #ifdef SPACE
5286 #undef SPACE
5287 #endif
5288 #endif
5289 
5290 #define LEX_NOTPARSING		11	/* borrowed from toke.c */
5291 
5292 typedef enum {
5293     XOPERATOR,
5294     XTERM,
5295     XREF,
5296     XSTATE,
5297     XBLOCK,
5298     XATTRBLOCK, /* next token should be an attribute or block */
5299     XATTRTERM,  /* next token should be an attribute, or block in a term */
5300     XTERMBLOCK,
5301     XBLOCKTERM,
5302     XPOSTDEREF,
5303     XTERMORDORDOR /* evil hack */
5304     /* update exp_name[] in toke.c if adding to this enum */
5305 } expectation;
5306 
5307 #define KEY_sigvar 0xFFFF /* fake keyword representing a signature var */
5308 
5309 /* Hints are now stored in a dedicated U32, so the bottom 8 bits are no longer
5310    special and there is no need for HINT_PRIVATE_MASK for COPs
5311    However, bitops store HINT_INTEGER in their op_private.
5312 
5313     NOTE: The typical module using these has the bit value hard-coded, so don't
5314     blindly change the values of these.
5315 
5316    If we run out of bits, the 2 locale ones could be combined.  The PARTIAL one
5317    is for "use locale 'FOO'" which excludes some categories.  It requires going
5318    to %^H to find out which are in and which are out.  This could be extended
5319    for the normal case of a plain HINT_LOCALE, so that %^H would be used for
5320    any locale form. */
5321 #define HINT_INTEGER		0x00000001 /* integer pragma */
5322 #define HINT_STRICT_REFS	0x00000002 /* strict pragma */
5323 #define HINT_LOCALE		0x00000004 /* locale pragma */
5324 #define HINT_BYTES		0x00000008 /* bytes pragma */
5325 #define HINT_LOCALE_PARTIAL	0x00000010 /* locale, but a subset of categories */
5326 
5327 #define HINT_EXPLICIT_STRICT_REFS	0x00000020 /* strict.pm */
5328 #define HINT_EXPLICIT_STRICT_SUBS	0x00000040 /* strict.pm */
5329 #define HINT_EXPLICIT_STRICT_VARS	0x00000080 /* strict.pm */
5330 
5331 #define HINT_BLOCK_SCOPE	0x00000100
5332 #define HINT_STRICT_SUBS	0x00000200 /* strict pragma */
5333 #define HINT_STRICT_VARS	0x00000400 /* strict pragma */
5334 #define HINT_UNI_8_BIT		0x00000800 /* unicode_strings feature */
5335 
5336 /* The HINT_NEW_* constants are used by the overload pragma */
5337 #define HINT_NEW_INTEGER	0x00001000
5338 #define HINT_NEW_FLOAT		0x00002000
5339 #define HINT_NEW_BINARY		0x00004000
5340 #define HINT_NEW_STRING		0x00008000
5341 #define HINT_NEW_RE		0x00010000
5342 #define HINT_LOCALIZE_HH	0x00020000 /* %^H needs to be copied */
5343 #define HINT_LEXICAL_IO_IN	0x00040000 /* ${^OPEN} is set for input */
5344 #define HINT_LEXICAL_IO_OUT	0x00080000 /* ${^OPEN} is set for output */
5345 
5346 #define HINT_RE_TAINT		0x00100000 /* re pragma */
5347 #define HINT_RE_EVAL		0x00200000 /* re pragma */
5348 
5349 #define HINT_FILETEST_ACCESS	0x00400000 /* filetest pragma */
5350 #define HINT_UTF8		0x00800000 /* utf8 pragma */
5351 
5352 #define HINT_NO_AMAGIC		0x01000000 /* overloading pragma */
5353 
5354 #define HINT_RE_FLAGS		0x02000000 /* re '/xism' pragma */
5355 
5356 #define HINT_FEATURE_MASK	0x1c000000 /* 3 bits for feature bundles */
5357 
5358 				/* Note: Used for HINT_M_VMSISH_*,
5359 				   currently defined by vms/vmsish.h:
5360 				0x40000000
5361 				0x80000000
5362 				 */
5363 
5364 /* The following are stored in $^H{sort}, not in PL_hints */
5365 #define HINT_SORT_STABLE	0x00000100 /* sort styles */
5366 #define HINT_SORT_UNSTABLE	0x00000200
5367 
5368 /* flags for PL_sawampersand */
5369 
5370 #define SAWAMPERSAND_LEFT       1   /* saw $` */
5371 #define SAWAMPERSAND_MIDDLE     2   /* saw $& */
5372 #define SAWAMPERSAND_RIGHT      4   /* saw $' */
5373 
5374 #ifndef PERL_SAWAMPERSAND
5375 # define PL_sawampersand \
5376 	(SAWAMPERSAND_LEFT|SAWAMPERSAND_MIDDLE|SAWAMPERSAND_RIGHT)
5377 #endif
5378 
5379 /* Used for debugvar magic */
5380 #define DBVARMG_SINGLE  0
5381 #define DBVARMG_TRACE   1
5382 #define DBVARMG_SIGNAL  2
5383 #define DBVARMG_COUNT   3
5384 
5385 #define PL_DBsingle_iv  (PL_DBcontrol[DBVARMG_SINGLE])
5386 #define PL_DBtrace_iv   (PL_DBcontrol[DBVARMG_TRACE])
5387 #define PL_DBsignal_iv  (PL_DBcontrol[DBVARMG_SIGNAL])
5388 
5389 /* Various states of the input record separator SV (rs) */
5390 #define RsSNARF(sv)   (! SvOK(sv))
5391 #define RsSIMPLE(sv)  (SvOK(sv) && (! SvPOK(sv) || SvCUR(sv)))
5392 #define RsPARA(sv)    (SvPOK(sv) && ! SvCUR(sv))
5393 #define RsRECORD(sv)  (SvROK(sv) && (SvIV(SvRV(sv)) > 0))
5394 
5395 /* A struct for keeping various DEBUGGING related stuff,
5396  * neatly packed.  Currently only scratch variables for
5397  * constructing debug output are included.  Needed always,
5398  * not just when DEBUGGING, though, because of the re extension. c*/
5399 struct perl_debug_pad {
5400   SV pad[3];
5401 };
5402 
5403 #define PERL_DEBUG_PAD(i)	&(PL_debug_pad.pad[i])
5404 #define PERL_DEBUG_PAD_ZERO(i)	(SvPVX(PERL_DEBUG_PAD(i))[0] = 0, \
5405 	(((XPV*) SvANY(PERL_DEBUG_PAD(i)))->xpv_cur = 0), \
5406 	PERL_DEBUG_PAD(i))
5407 
5408 /* Enable variables which are pointers to functions */
5409 typedef void (*peep_t)(pTHX_ OP* o);
5410 typedef regexp* (*regcomp_t) (pTHX_ char* exp, char* xend, PMOP* pm);
5411 typedef I32     (*regexec_t) (pTHX_ regexp* prog, char* stringarg,
5412 				      char* strend, char* strbeg, I32 minend,
5413 				      SV* screamer, void* data, U32 flags);
5414 typedef char*   (*re_intuit_start_t) (pTHX_ regexp *prog, SV *sv,
5415 						char *strpos, char *strend,
5416 						U32 flags,
5417 						re_scream_pos_data *d);
5418 typedef SV*	(*re_intuit_string_t) (pTHX_ regexp *prog);
5419 typedef void	(*regfree_t) (pTHX_ struct regexp* r);
5420 typedef regexp* (*regdupe_t) (pTHX_ const regexp* r, CLONE_PARAMS *param);
5421 typedef I32     (*re_fold_t)(const char *, char const *, I32);
5422 
5423 typedef void (*DESTRUCTORFUNC_NOCONTEXT_t) (void*);
5424 typedef void (*DESTRUCTORFUNC_t) (pTHX_ void*);
5425 typedef void (*SVFUNC_t) (pTHX_ SV* const);
5426 typedef I32  (*SVCOMPARE_t) (pTHX_ SV* const, SV* const);
5427 typedef void (*XSINIT_t) (pTHX);
5428 typedef void (*ATEXIT_t) (pTHX_ void*);
5429 typedef void (*XSUBADDR_t) (pTHX_ CV *);
5430 
5431 typedef OP* (*Perl_ppaddr_t)(pTHX);
5432 typedef OP* (*Perl_check_t) (pTHX_ OP*);
5433 typedef void(*Perl_ophook_t)(pTHX_ OP*);
5434 typedef int (*Perl_keyword_plugin_t)(pTHX_ char*, STRLEN, OP**);
5435 typedef void(*Perl_cpeep_t)(pTHX_ OP *, OP *);
5436 
5437 typedef void(*globhook_t)(pTHX);
5438 
5439 #define KEYWORD_PLUGIN_DECLINE 0
5440 #define KEYWORD_PLUGIN_STMT    1
5441 #define KEYWORD_PLUGIN_EXPR    2
5442 
5443 /* Interpreter exitlist entry */
5444 typedef struct exitlistentry {
5445     void (*fn) (pTHX_ void*);
5446     void *ptr;
5447 } PerlExitListEntry;
5448 
5449 /* if you only have signal() and it resets on each signal, FAKE_PERSISTENT_SIGNAL_HANDLERS fixes */
5450 /* These have to be before perlvars.h */
5451 #if !defined(HAS_SIGACTION) && defined(VMS)
5452 #  define  FAKE_PERSISTENT_SIGNAL_HANDLERS
5453 #endif
5454 /* if we're doing kill() with sys$sigprc on VMS, FAKE_DEFAULT_SIGNAL_HANDLERS */
5455 #if defined(KILL_BY_SIGPRC)
5456 #  define  FAKE_DEFAULT_SIGNAL_HANDLERS
5457 #endif
5458 
5459 #if !defined(MULTIPLICITY)
5460 
5461 struct interpreter {
5462     char broiled;
5463 };
5464 
5465 #else
5466 
5467 /* If we have multiple interpreters define a struct
5468    holding variables which must be per-interpreter
5469    If we don't have threads anything that would have
5470    be per-thread is per-interpreter.
5471 */
5472 
5473 /* Set up PERLVAR macros for populating structs */
5474 #  define PERLVAR(prefix,var,type) type prefix##var;
5475 
5476 /* 'var' is an array of length 'n' */
5477 #  define PERLVARA(prefix,var,n,type) type prefix##var[n];
5478 
5479 /* initialize 'var' to init' */
5480 #  define PERLVARI(prefix,var,type,init) type prefix##var;
5481 
5482 /* like PERLVARI, but make 'var' a const */
5483 #  define PERLVARIC(prefix,var,type,init) type prefix##var;
5484 
5485 struct interpreter {
5486 #  include "intrpvar.h"
5487 };
5488 
5489 EXTCONST U16 PL_interp_size
5490   INIT(sizeof(struct interpreter));
5491 
5492 #  define PERL_INTERPRETER_SIZE_UPTO_MEMBER(member)			\
5493     STRUCT_OFFSET(struct interpreter, member) +				\
5494     sizeof(((struct interpreter*)0)->member)
5495 
5496 /* This will be useful for subsequent releases, because this has to be the
5497    same in your libperl as in main(), else you have a mismatch and must abort.
5498 */
5499 EXTCONST U16 PL_interp_size_5_18_0
5500   INIT(PERL_INTERPRETER_SIZE_UPTO_MEMBER(PERL_LAST_5_18_0_INTERP_MEMBER));
5501 
5502 
5503 #  ifdef PERL_GLOBAL_STRUCT
5504 /* MULTIPLICITY is automatically defined when PERL_GLOBAL_STRUCT is defined,
5505    hence it's safe and sane to nest this within #ifdef MULTIPLICITY  */
5506 
5507 struct perl_vars {
5508 #    include "perlvars.h"
5509 };
5510 
5511 EXTCONST U16 PL_global_struct_size
5512   INIT(sizeof(struct perl_vars));
5513 
5514 #    ifdef PERL_CORE
5515 #      ifndef PERL_GLOBAL_STRUCT_PRIVATE
5516 EXT struct perl_vars PL_Vars;
5517 EXT struct perl_vars *PL_VarsPtr INIT(&PL_Vars);
5518 #        undef PERL_GET_VARS
5519 #        define PERL_GET_VARS() PL_VarsPtr
5520 #      endif /* !PERL_GLOBAL_STRUCT_PRIVATE */
5521 #    else /* PERL_CORE */
5522 #      if !defined(__GNUC__) || !defined(WIN32)
5523 EXT
5524 #      endif /* WIN32 */
5525 struct perl_vars *PL_VarsPtr;
5526 #      define PL_Vars (*((PL_VarsPtr) \
5527 		       ? PL_VarsPtr : (PL_VarsPtr = Perl_GetVars(aTHX))))
5528 #    endif /* PERL_CORE */
5529 #  endif /* PERL_GLOBAL_STRUCT */
5530 
5531 /* Done with PERLVAR macros for now ... */
5532 #  undef PERLVAR
5533 #  undef PERLVARA
5534 #  undef PERLVARI
5535 #  undef PERLVARIC
5536 
5537 #endif /* MULTIPLICITY */
5538 
5539 struct tempsym; /* defined in pp_pack.c */
5540 
5541 #include "thread.h"
5542 #include "pp.h"
5543 
5544 #undef PERL_CKDEF
5545 #undef PERL_PPDEF
5546 #define PERL_CKDEF(s)	PERL_CALLCONV OP *s (pTHX_ OP *o);
5547 #define PERL_PPDEF(s)	PERL_CALLCONV OP *s (pTHX);
5548 
5549 #ifdef MYMALLOC
5550 #  include "malloc_ctl.h"
5551 #endif
5552 
5553 /*
5554  * This provides a layer of functions and macros to ensure extensions will
5555  * get to use the same RTL functions as the core.
5556  */
5557 #if defined(WIN32)
5558 #  include "win32iop.h"
5559 #endif
5560 
5561 
5562 #include "proto.h"
5563 
5564 /* this has structure inits, so it cannot be included before here */
5565 #include "opcode.h"
5566 
5567 /* The following must follow proto.h as #defines mess up syntax */
5568 
5569 #if !defined(PERL_FOR_X2P)
5570 #  include "embedvar.h"
5571 #endif
5572 
5573 /* Now include all the 'global' variables
5574  * If we don't have threads or multiple interpreters
5575  * these include variables that would have been their struct-s
5576  */
5577 
5578 #define PERLVAR(prefix,var,type) EXT type PL_##var;
5579 #define PERLVARA(prefix,var,n,type) EXT type PL_##var[n];
5580 #define PERLVARI(prefix,var,type,init) EXT type  PL_##var INIT(init);
5581 #define PERLVARIC(prefix,var,type,init) EXTCONST type PL_##var INIT(init);
5582 
5583 #if !defined(MULTIPLICITY)
5584 START_EXTERN_C
5585 #  include "intrpvar.h"
5586 END_EXTERN_C
5587 #  define PL_sv_yes   (PL_sv_immortals[0])
5588 #  define PL_sv_undef (PL_sv_immortals[1])
5589 #  define PL_sv_no    (PL_sv_immortals[2])
5590 #  define PL_sv_zero  (PL_sv_immortals[3])
5591 #endif
5592 
5593 #ifdef PERL_CORE
5594 /* All core uses now exterminated. Ensure no zombies can return:  */
5595 #  undef PL_na
5596 #endif
5597 
5598 /* Now all the config stuff is setup we can include embed.h
5599    In particular, need the relevant *ish file included already, as it may
5600    define HAVE_INTERP_INTERN  */
5601 #include "embed.h"
5602 
5603 #ifndef PERL_GLOBAL_STRUCT
5604 START_EXTERN_C
5605 
5606 #  include "perlvars.h"
5607 
5608 END_EXTERN_C
5609 #endif
5610 
5611 #undef PERLVAR
5612 #undef PERLVARA
5613 #undef PERLVARI
5614 #undef PERLVARIC
5615 
5616 #if !defined(MULTIPLICITY)
5617 /* Set up PERLVAR macros for populating structs */
5618 #  define PERLVAR(prefix,var,type) type prefix##var;
5619 /* 'var' is an array of length 'n' */
5620 #  define PERLVARA(prefix,var,n,type) type prefix##var[n];
5621 /* initialize 'var' to init' */
5622 #  define PERLVARI(prefix,var,type,init) type prefix##var;
5623 /* like PERLVARI, but make 'var' a const */
5624 #  define PERLVARIC(prefix,var,type,init) type prefix##var;
5625 
5626 /* this is never instantiated, is it just used for sizeof(struct PerlHandShakeInterpreter) */
5627 struct PerlHandShakeInterpreter {
5628 #  include "intrpvar.h"
5629 };
5630 #  undef PERLVAR
5631 #  undef PERLVARA
5632 #  undef PERLVARI
5633 #  undef PERLVARIC
5634 #endif
5635 
5636 START_EXTERN_C
5637 
5638 /* dummy variables that hold pointers to both runops functions, thus forcing
5639  * them *both* to get linked in (useful for Peek.xs, debugging etc) */
5640 
5641 EXTCONST runops_proc_t PL_runops_std
5642   INIT(Perl_runops_standard);
5643 EXTCONST runops_proc_t PL_runops_dbg
5644   INIT(Perl_runops_debug);
5645 
5646 #define EXT_MGVTBL EXTCONST MGVTBL
5647 
5648 #define PERL_MAGIC_READONLY_ACCEPTABLE 0x40
5649 #define PERL_MAGIC_VALUE_MAGIC 0x80
5650 #define PERL_MAGIC_VTABLE_MASK 0x3F
5651 #define PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(t) \
5652     (PL_magic_data[(U8)(t)] & PERL_MAGIC_READONLY_ACCEPTABLE)
5653 #define PERL_MAGIC_TYPE_IS_VALUE_MAGIC(t) \
5654     (PL_magic_data[(U8)(t)] & PERL_MAGIC_VALUE_MAGIC)
5655 
5656 #include "mg_vtable.h"
5657 
5658 #ifdef DOINIT
5659 EXTCONST U8 PL_magic_data[256] =
5660 #  ifdef PERL_MICRO
5661 #    include "umg_data.h"
5662 #  else
5663 #    include "mg_data.h"
5664 #  endif
5665 ;
5666 #else
5667 EXTCONST U8 PL_magic_data[256];
5668 #endif
5669 
5670 #ifdef DOINIT
5671 		        /* NL IV NV PV INV PI PN MG RX GV LV AV HV CV FM IO */
5672 EXTCONST bool
5673 PL_valid_types_IVX[]    = { 0, 1, 0, 0, 0, 1, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5674 EXTCONST bool
5675 PL_valid_types_NVX[]    = { 0, 0, 1, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5676 EXTCONST bool
5677 PL_valid_types_PVX[]    = { 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1 };
5678 EXTCONST bool
5679 PL_valid_types_RV[]     = { 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1 };
5680 EXTCONST bool
5681 PL_valid_types_IV_set[] = { 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1 };
5682 EXTCONST bool
5683 PL_valid_types_NV_set[] = { 0, 0, 1, 0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0 };
5684 
5685 #else
5686 
5687 EXTCONST bool PL_valid_types_IVX[];
5688 EXTCONST bool PL_valid_types_NVX[];
5689 EXTCONST bool PL_valid_types_PVX[];
5690 EXTCONST bool PL_valid_types_RV[];
5691 EXTCONST bool PL_valid_types_IV_set[];
5692 EXTCONST bool PL_valid_types_NV_set[];
5693 
5694 #endif
5695 
5696 /* In C99 we could use designated (named field) union initializers.
5697  * In C89 we need to initialize the member declared first.
5698  * In C++ we need extern C initializers.
5699  *
5700  * With the U8_NV version you will want to have inner braces,
5701  * while with the NV_U8 use just the NV. */
5702 
5703 #define INFNAN_U8_NV_DECL EXTCONST union { U8 u8[NVSIZE]; NV nv; }
5704 #define INFNAN_NV_U8_DECL EXTCONST union { NV nv; U8 u8[NVSIZE]; }
5705 
5706 /* if these never got defined, they need defaults */
5707 #ifndef PERL_SET_CONTEXT
5708 #  define PERL_SET_CONTEXT(i)		PERL_SET_INTERP(i)
5709 #endif
5710 
5711 #ifndef PERL_GET_CONTEXT
5712 #  define PERL_GET_CONTEXT		PERL_GET_INTERP
5713 #endif
5714 
5715 #ifndef PERL_GET_THX
5716 #  define PERL_GET_THX			((void*)NULL)
5717 #endif
5718 
5719 #ifndef PERL_SET_THX
5720 #  define PERL_SET_THX(t)		NOOP
5721 #endif
5722 
5723 #ifndef EBCDIC
5724 
5725 /* The tables below are adapted from
5726  * https://bjoern.hoehrmann.de/utf-8/decoder/dfa/, which requires this copyright
5727  * notice:
5728 
5729 Copyright (c) 2008-2009 Bjoern Hoehrmann <bjoern@hoehrmann.de>
5730 
5731 Permission is hereby granted, free of charge, to any person obtaining a copy of
5732 this software and associated documentation files (the "Software"), to deal in
5733 the Software without restriction, including without limitation the rights to
5734 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
5735 of the Software, and to permit persons to whom the Software is furnished to do
5736 so, subject to the following conditions:
5737 
5738 The above copyright notice and this permission notice shall be included in all
5739 copies or substantial portions of the Software.
5740 
5741 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
5742 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
5743 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
5744 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
5745 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
5746 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
5747 SOFTWARE.
5748 
5749 */
5750 
5751 #  ifdef DOINIT
5752 #    if 0       /* This is the original table given in
5753                    https://bjoern.hoehrmann.de/utf-8/decoder/dfa/ */
5754 static U8 utf8d_C9[] = {
5755   /* The first part of the table maps bytes to character classes that
5756    * to reduce the size of the transition table and create bitmasks. */
5757    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*/
5758    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*/
5759    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*/
5760    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*/
5761    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*/
5762    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*/
5763    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*/
5764   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*/
5765 
5766   /* The second part is a transition table that maps a combination
5767    * of a state of the automaton and a character class to a state. */
5768    0,12,24,36,60,96,84,12,12,12,48,72, 12,12,12,12,12,12,12,12,12,12,12,12,
5769   12, 0,12,12,12,12,12, 0,12, 0,12,12, 12,24,12,12,12,12,12,24,12,24,12,12,
5770   12,12,12,12,12,12,12,24,12,12,12,12, 12,24,12,12,12,12,12,12,12,24,12,12,
5771   12,12,12,12,12,12,12,36,12,36,12,12, 12,36,12,12,12,12,12,36,12,36,12,12,
5772   12,36,12,12,12,12,12,12,12,12,12,12
5773 };
5774 
5775 #    endif
5776 
5777 /* This is a version of the above table customized for Perl that doesn't
5778  * exclude surrogates and accepts start bytes up through FD (FE on 64-bit
5779  * machines).  The classes have been renumbered so that the patterns are more
5780  * evident in the table.  The class numbers for start bytes are constrained so
5781  * that they can be used as a shift count for masking off the leading one bits.
5782  * It would make the code simpler if start byte FF could also be handled, but
5783  * doing so would mean adding nodes for each of continuation bytes 6-12
5784  * remaining, and two more nodes for overlong detection (a total of 9), and
5785  * there is room only for 4 more nodes unless we make the array U16 instead of
5786  * U8.
5787  *
5788  * The classes are
5789  *      00-7F           0
5790  *      80-81           7   Not legal immediately after start bytes E0 F0 F8 FC
5791  *                          FE
5792  *      82-83           8   Not legal immediately after start bytes E0 F0 F8 FC
5793  *      84-87           9   Not legal immediately after start bytes E0 F0 F8
5794  *      88-8F          10   Not legal immediately after start bytes E0 F0
5795  *      90-9F          11   Not legal immediately after start byte E0
5796  *      A0-BF          12
5797  *      C0,C1           1
5798  *      C2-DF           2
5799  *      E0             13
5800  *      E1-EF           3
5801  *      F0             14
5802  *      F1-F7           4
5803  *      F8             15
5804  *      F9-FB           5
5805  *      FC             16
5806  *      FD              6
5807  *      FE             17  (or 1 on 32-bit machines, since it overflows)
5808  *      FF              1
5809  */
5810 
5811 EXTCONST U8 PL_extended_utf8_dfa_tab[] = {
5812     /* The first part of the table maps bytes to character classes to reduce
5813      * the size of the transition table and create bitmasks. */
5814    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*00-0F*/
5815    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*10-1F*/
5816    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*20-2F*/
5817    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*30-3F*/
5818    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*40-4F*/
5819    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*50-5F*/
5820    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*60-6F*/
5821    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*70-7F*/
5822    7, 7, 8, 8, 9, 9, 9, 9,10,10,10,10,10,10,10,10, /*80-8F*/
5823   11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11, /*90-9F*/
5824   12,12,12,12,12,12,12,12,12,12,12,12,12,12,12,12, /*A0-AF*/
5825   12,12,12,12,12,12,12,12,12,12,12,12,12,12,12,12, /*B0-BF*/
5826    1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*C0-CF*/
5827    2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*D0-DF*/
5828   13, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, /*E0-EF*/
5829   14, 4, 4, 4, 4, 4, 4, 4,15, 5, 5, 5,16, 6,       /*F0-FD*/
5830 #    ifdef UV_IS_QUAD
5831                                             17,    /*FE*/
5832 #    else
5833                                              1,    /*FE*/
5834 #    endif
5835                                                 1, /*FF*/
5836 
5837 /* The second part is a transition table that maps a combination
5838  * of a state of the automaton and a character class to a new state, called a
5839  * node.  The nodes are:
5840  * N0     The initial state, and final accepting one.
5841  * N1     Any one continuation byte (80-BF) left.  This is transitioned to
5842  *        immediately when the start byte indicates a two-byte sequence
5843  * N2     Any two continuation bytes left.
5844  * N3     Any three continuation bytes left.
5845  * N4     Any four continuation bytes left.
5846  * N5     Any five continuation bytes left.
5847  * N6     Start byte is E0.  Continuation bytes 80-9F are illegal (overlong);
5848  *        the other continuations transition to N1
5849  * N7     Start byte is F0.  Continuation bytes 80-8F are illegal (overlong);
5850  *        the other continuations transition to N2
5851  * N8     Start byte is F8.  Continuation bytes 80-87 are illegal (overlong);
5852  *        the other continuations transition to N3
5853  * N9     Start byte is FC.  Continuation bytes 80-83 are illegal (overlong);
5854  *        the other continuations transition to N4
5855  * N10    Start byte is FE.  Continuation bytes 80-81 are illegal (overlong);
5856  *        the other continuations transition to N5
5857  * 1      Reject.  All transitions not mentioned above (except the single
5858  *        byte ones (as they are always legal) are to this state.
5859  */
5860 
5861 #    define NUM_CLASSES 18
5862 #    define N0 0
5863 #    define N1 ((N0)   + NUM_CLASSES)
5864 #    define N2 ((N1)   + NUM_CLASSES)
5865 #    define N3 ((N2)   + NUM_CLASSES)
5866 #    define N4 ((N3)   + NUM_CLASSES)
5867 #    define N5 ((N4)   + NUM_CLASSES)
5868 #    define N6 ((N5)   + NUM_CLASSES)
5869 #    define N7 ((N6)   + NUM_CLASSES)
5870 #    define N8 ((N7)   + NUM_CLASSES)
5871 #    define N9 ((N8)   + NUM_CLASSES)
5872 #    define N10 ((N9)  + NUM_CLASSES)
5873 
5874 /*Class: 0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17  */
5875 /*N0*/   0, 1,N1,N2,N3,N4,N5, 1, 1, 1, 1, 1, 1,N6,N7,N8,N9,N10,
5876 /*N1*/   1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1,
5877 /*N2*/   1, 1, 1, 1, 1, 1, 1,N1,N1,N1,N1,N1,N1, 1, 1, 1, 1, 1,
5878 /*N3*/   1, 1, 1, 1, 1, 1, 1,N2,N2,N2,N2,N2,N2, 1, 1, 1, 1, 1,
5879 /*N4*/   1, 1, 1, 1, 1, 1, 1,N3,N3,N3,N3,N3,N3, 1, 1, 1, 1, 1,
5880 /*N5*/   1, 1, 1, 1, 1, 1, 1,N4,N4,N4,N4,N4,N4, 1, 1, 1, 1, 1,
5881 
5882 /*N6*/   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,N1, 1, 1, 1, 1, 1,
5883 /*N7*/   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,N2,N2, 1, 1, 1, 1, 1,
5884 /*N8*/   1, 1, 1, 1, 1, 1, 1, 1, 1, 1,N3,N3,N3, 1, 1, 1, 1, 1,
5885 /*N9*/   1, 1, 1, 1, 1, 1, 1, 1, 1,N4,N4,N4,N4, 1, 1, 1, 1, 1,
5886 /*N10*/  1, 1, 1, 1, 1, 1, 1, 1,N5,N5,N5,N5,N5, 1, 1, 1, 1, 1,
5887 };
5888 
5889 /* And below is a version of the above table that accepts only strict UTF-8.
5890  * Hence no surrogates nor non-characters, nor non-Unicode.  Thus, if the input
5891  * passes this dfa, it will be for a well-formed, non-problematic code point
5892  * that can be returned immediately.
5893  *
5894  * The "Implementation details" portion of
5895  * https://bjoern.hoehrmann.de/utf-8/decoder/dfa/ shows how
5896  * the first portion of the table maps each possible byte into a character
5897  * class.  And that the classes for those bytes which are start bytes have been
5898  * carefully chosen so they serve as well to be used as a shift value to mask
5899  * off the leading 1 bits of the start byte.  Unfortunately the addition of
5900  * being able to distinguish non-characters makes this not fully work.  This is
5901  * because, now, the start bytes E1-EF have to be broken into 3 classes instead
5902  * of 2:
5903  *  1) ED because it could be a surrogate
5904  *  2) EF because it could be a non-character
5905  *  3) the rest, which can never evaluate to a problematic code point.
5906  *
5907  * Each of E1-EF has three leading 1 bits, then a 0.  That means we could use a
5908  * shift (and hence class number) of either 3 or 4 to get a mask that works.
5909  * But that only allows two categories, and we need three.  khw made the
5910  * decision to therefore treat the ED start byte as an error, so that the dfa
5911  * drops out immediately for that.  In the dfa, classes 3 and 4 are used to
5912  * distinguish EF vs the rest.  Then special code is used to deal with ED,
5913  * that's executed only when the dfa drops out.  The code points started by ED
5914  * are half surrogates, and half hangul syllables.  This means that 2048 of
5915  * the hangul syllables (about 18%) take longer than all other non-problematic
5916  * code points to handle.
5917  *
5918  * The changes to handle non-characters requires the addition of states and
5919  * classes to the dfa.  (See the section on "Mapping bytes to character
5920  * classes" in the linked-to document for further explanation of the original
5921  * dfa.)
5922  *
5923  * The classes are
5924  *      00-7F           0
5925  *      80-8E           9
5926  *      8F             10
5927  *      90-9E          11
5928  *      9F             12
5929  *      A0-AE          13
5930  *      AF             14
5931  *      B0-B6          15
5932  *      B7             16
5933  *      B8-BD          15
5934  *      BE             17
5935  *      BF             18
5936  *      C0,C1           1
5937  *      C2-DF           2
5938  *      E0              7
5939  *      E1-EC           3
5940  *      ED              1
5941  *      EE              3
5942  *      EF              4
5943  *      F0              8
5944  *      F1-F3           6  (6 bits can be stripped)
5945  *      F4              5  (only 5 can be stripped)
5946  *      F5-FF           1
5947  */
5948 
5949 EXTCONST U8 PL_strict_utf8_dfa_tab[] = {
5950     /* The first part of the table maps bytes to character classes to reduce
5951      * the size of the transition table and create bitmasks. */
5952    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*00-0F*/
5953    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*10-1F*/
5954    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*20-2F*/
5955    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*30-3F*/
5956    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*40-4F*/
5957    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*50-5F*/
5958    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*60-6F*/
5959    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*70-7F*/
5960    9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9,10, /*80-8F*/
5961   11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,12, /*90-9F*/
5962   13,13,13,13,13,13,13,13,13,13,13,13,13,13,13,14, /*A0-AF*/
5963   15,15,15,15,15,15,15,16,15,15,15,15,15,15,17,18, /*B0-BF*/
5964    1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*C0-CF*/
5965    2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*D0-DF*/
5966    7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 1, 3, 4, /*E0-EF*/
5967    8, 6, 6, 6, 5, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /*F0-FF*/
5968 
5969 /* The second part is a transition table that maps a combination
5970  * of a state of the automaton and a character class to a new state, called a
5971  * node.  The nodes are:
5972  * N0     The initial state, and final accepting one.
5973  * N1     Any one continuation byte (80-BF) left.  This is transitioned to
5974  *        immediately when the start byte indicates a two-byte sequence
5975  * N2     Any two continuation bytes left.
5976  * N3     Start byte is E0.  Continuation bytes 80-9F are illegal (overlong);
5977  *        the other continuations transition to state N1
5978  * N4     Start byte is EF.  Continuation byte B7 transitions to N8; BF to N9;
5979  *        the other continuations transitions to N1
5980  * N5     Start byte is F0.  Continuation bytes 80-8F are illegal (overlong);
5981  *        [9AB]F transition to N10; the other continuations to N2.
5982  * N6     Start byte is F[123].  Continuation bytes [89AB]F transition
5983  *        to N10; the other continuations to N2.
5984  * N7     Start byte is F4.  Continuation bytes 90-BF are illegal
5985  *        (non-unicode); 8F transitions to N10; the other continuations to N2
5986  * N8     Initial sequence is EF B7.  Continuation bytes 90-AF are illegal
5987  *        (non-characters); the other continuations transition to N0.
5988  * N9     Initial sequence is EF BF.  Continuation bytes BE and BF are illegal
5989  *        (non-characters); the other continuations transition to N0.
5990  * N10    Initial sequence is one of: F0 [9-B]F; F[123] [8-B]F; or F4 8F.
5991  *        Continuation byte BF transitions to N11; the other continuations to
5992  *        N1
5993  * N11    Initial sequence is the two bytes given in N10 followed by BF.
5994  *        Continuation bytes BE and BF are illegal (non-characters); the other
5995  *        continuations transition to N0.
5996  * 1      Reject.  All transitions not mentioned above (except the single
5997  *        byte ones (as they are always legal) are to this state.
5998  */
5999 
6000 #    undef N0
6001 #    undef N1
6002 #    undef N2
6003 #    undef N3
6004 #    undef N4
6005 #    undef N5
6006 #    undef N6
6007 #    undef N7
6008 #    undef N8
6009 #    undef N9
6010 #    undef NUM_CLASSES
6011 #    define NUM_CLASSES 19
6012 #    define N0 0
6013 #    define N1  ((N0)  + NUM_CLASSES)
6014 #    define N2  ((N1)  + NUM_CLASSES)
6015 #    define N3  ((N2)  + NUM_CLASSES)
6016 #    define N4  ((N3)  + NUM_CLASSES)
6017 #    define N5  ((N4)  + NUM_CLASSES)
6018 #    define N6  ((N5)  + NUM_CLASSES)
6019 #    define N7  ((N6)  + NUM_CLASSES)
6020 #    define N8  ((N7)  + NUM_CLASSES)
6021 #    define N9  ((N8)  + NUM_CLASSES)
6022 #    define N10 ((N9)  + NUM_CLASSES)
6023 #    define N11 ((N10) + NUM_CLASSES)
6024 
6025 /*Class: 0   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18 */
6026 /*N0*/   0,  1, N1, N2, N4, N7, N6, N3, N5,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,
6027 /*N1*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
6028 /*N2*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N1, N1, N1, N1, N1, N1, N1, N1, N1, N1,
6029 
6030 /*N3*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1, N1, N1, N1, N1, N1, N1,
6031 /*N4*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N1, N1, N1, N1, N1, N1, N1, N8, N1, N9,
6032 /*N5*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1, N2,N10, N2,N10, N2, N2, N2,N10,
6033 /*N6*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N2,N10, N2,N10, N2,N10, N2, N2, N2,N10,
6034 /*N7*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N2,N10,  1,  1,  1,  1,  1,  1,  1,  1,
6035 /*N8*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  0,  0,  1,  1,  1,  1,  0,  0,  0,  0,
6036 /*N9*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  0,  0,  0,  0,  0,  0,  0,  0,  1,  1,
6037 /*N10*/  1,  1,  1,  1,  1,  1,  1,  1,  1, N1, N1, N1, N1, N1, N1, N1, N1, N1,N11,
6038 /*N11*/  1,  1,  1,  1,  1,  1,  1,  1,  1,  0,  0,  0,  0,  0,  0,  0,  0,  1,  1,
6039 };
6040 
6041 /* And below is yet another version of the above tables that accepts only UTF-8
6042  * as defined by Corregidum #9.  Hence no surrogates nor non-Unicode, but
6043  * it allows non-characters.  This is isomorphic to the original table
6044  * in https://bjoern.hoehrmann.de/utf-8/decoder/dfa/
6045  *
6046  * The classes are
6047  *      00-7F           0
6048  *      80-8F           9
6049  *      90-9F          10
6050  *      A0-BF          11
6051  *      C0,C1           1
6052  *      C2-DF           2
6053  *      E0              7
6054  *      E1-EC           3
6055  *      ED              4
6056  *      EE-EF           3
6057  *      F0              8
6058  *      F1-F3           6  (6 bits can be stripped)
6059  *      F4              5  (only 5 can be stripped)
6060  *      F5-FF           1
6061  */
6062 
6063 EXTCONST U8 PL_c9_utf8_dfa_tab[] = {
6064     /* The first part of the table maps bytes to character classes to reduce
6065      * the size of the transition table and create bitmasks. */
6066    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*00-0F*/
6067    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*10-1F*/
6068    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*20-2F*/
6069    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*30-3F*/
6070    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*40-4F*/
6071    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*50-5F*/
6072    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*60-6F*/
6073    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /*70-7F*/
6074    9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, /*80-8F*/
6075   10,10,10,10,10,10,10,10,10,10,10,10,10,10,10,10, /*90-9F*/
6076   11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11, /*A0-AF*/
6077   11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11, /*B0-BF*/
6078    1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*C0-CF*/
6079    2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /*D0-DF*/
6080    7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 4, 3, 3, /*E0-EF*/
6081    8, 6, 6, 6, 5, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /*F0-FF*/
6082 
6083 /* The second part is a transition table that maps a combination
6084  * of a state of the automaton and a character class to a new state, called a
6085  * node.  The nodes are:
6086  * N0     The initial state, and final accepting one.
6087  * N1     Any one continuation byte (80-BF) left.  This is transitioned to
6088  *        immediately when the start byte indicates a two-byte sequence
6089  * N2     Any two continuation bytes left.
6090  * N3     Any three continuation bytes left.
6091  * N4     Start byte is E0.  Continuation bytes 80-9F are illegal (overlong);
6092  *        the other continuations transition to state N1
6093  * N5     Start byte is ED.  Continuation bytes A0-BF all lead to surrogates,
6094  *        so are illegal.  The other continuations transition to state N1.
6095  * N6     Start byte is F0.  Continuation bytes 80-8F are illegal (overlong);
6096  *        the other continuations transition to N2
6097  * N7     Start byte is F4.  Continuation bytes 90-BF are illegal
6098  *        (non-unicode); the other continuations transition to N2
6099  * 1      Reject.  All transitions not mentioned above (except the single
6100  *        byte ones (as they are always legal) are to this state.
6101  */
6102 
6103 #    undef N0
6104 #    undef N1
6105 #    undef N2
6106 #    undef N3
6107 #    undef N4
6108 #    undef N5
6109 #    undef N6
6110 #    undef N7
6111 #    undef NUM_CLASSES
6112 #    define NUM_CLASSES 12
6113 #    define N0 0
6114 #    define N1  ((N0)  + NUM_CLASSES)
6115 #    define N2  ((N1)  + NUM_CLASSES)
6116 #    define N3  ((N2)  + NUM_CLASSES)
6117 #    define N4  ((N3)  + NUM_CLASSES)
6118 #    define N5  ((N4)  + NUM_CLASSES)
6119 #    define N6  ((N5)  + NUM_CLASSES)
6120 #    define N7  ((N6)  + NUM_CLASSES)
6121 
6122 /*Class: 0   1   2   3   4   5   6   7   8   9  10  11 */
6123 /*N0*/   0,  1, N1, N2, N5, N7, N3, N4, N6,  1,  1,  1,
6124 /*N1*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  0,  0,  0,
6125 /*N2*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N1, N1, N1,
6126 /*N3*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N2, N2, N2,
6127 
6128 /*N4*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1, N1,
6129 /*N5*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N1, N1,  1,
6130 /*N6*/   1,  1,  1,  1,  1,  1,  1,  1,  1,  1, N2, N2,
6131 /*N7*/   1,  1,  1,  1,  1,  1,  1,  1,  1, N2,  1,  1,
6132 };
6133 
6134 #  else     /* End of is DOINIT */
6135 
6136 EXTCONST U8 PL_extended_utf8_dfa_tab[];
6137 EXTCONST U8 PL_strict_utf8_dfa_tab[];
6138 EXTCONST U8 PL_c9_utf8_dfa_tab[];
6139 
6140 #  endif
6141 #endif    /* end of isn't EBCDIC */
6142 
6143 #ifndef PERL_NO_INLINE_FUNCTIONS
6144 /* Static inline funcs that depend on includes and declarations above.
6145    Some of these reference functions in the perl object files, and some
6146    compilers aren't smart enough to eliminate unused static inline
6147    functions, so including this file in source code can cause link errors
6148    even if the source code uses none of the functions. Hence including these
6149    can be suppressed by setting PERL_NO_INLINE_FUNCTIONS. Doing this will
6150    (obviously) result in unworkable XS code, but allows simple probing code
6151    to continue to work, because it permits tests to include the perl headers
6152    for definitions without creating a link dependency on the perl library
6153    (which may not exist yet).
6154 */
6155 
6156 #  include "inline.h"
6157 #endif
6158 
6159 #include "overload.h"
6160 
6161 END_EXTERN_C
6162 
6163 struct am_table {
6164   U8 flags;
6165   U8 fallback;
6166   U16 spare;
6167   U32 was_ok_sub;
6168   CV* table[NofAMmeth];
6169 };
6170 struct am_table_short {
6171   U8 flags;
6172   U8 fallback;
6173   U16 spare;
6174   U32 was_ok_sub;
6175 };
6176 typedef struct am_table AMT;
6177 typedef struct am_table_short AMTS;
6178 
6179 #define AMGfallNEVER	1
6180 #define AMGfallNO	2
6181 #define AMGfallYES	3
6182 
6183 #define AMTf_AMAGIC		1
6184 #define AMT_AMAGIC(amt)		((amt)->flags & AMTf_AMAGIC)
6185 #define AMT_AMAGIC_on(amt)	((amt)->flags |= AMTf_AMAGIC)
6186 #define AMT_AMAGIC_off(amt)	((amt)->flags &= ~AMTf_AMAGIC)
6187 
6188 #define StashHANDLER(stash,meth)	gv_handler((stash),CAT2(meth,_amg))
6189 
6190 /*
6191  * some compilers like to redefine cos et alia as faster
6192  * (and less accurate?) versions called F_cos et cetera (Quidquid
6193  * latine dictum sit, altum viditur.)  This trick collides with
6194  * the Perl overloading (amg).  The following #defines fool both.
6195  */
6196 
6197 #ifdef _FASTMATH
6198 #   ifdef atan2
6199 #       define F_atan2_amg  atan2_amg
6200 #   endif
6201 #   ifdef cos
6202 #       define F_cos_amg    cos_amg
6203 #   endif
6204 #   ifdef exp
6205 #       define F_exp_amg    exp_amg
6206 #   endif
6207 #   ifdef log
6208 #       define F_log_amg    log_amg
6209 #   endif
6210 #   ifdef pow
6211 #       define F_pow_amg    pow_amg
6212 #   endif
6213 #   ifdef sin
6214 #       define F_sin_amg    sin_amg
6215 #   endif
6216 #   ifdef sqrt
6217 #       define F_sqrt_amg   sqrt_amg
6218 #   endif
6219 #endif /* _FASTMATH */
6220 
6221 #define PERLDB_ALL		(PERLDBf_SUB	| PERLDBf_LINE	|	\
6222 				 PERLDBf_NOOPT	| PERLDBf_INTER	|	\
6223 				 PERLDBf_SUBLINE| PERLDBf_SINGLE|	\
6224 				 PERLDBf_NAMEEVAL| PERLDBf_NAMEANON |   \
6225 				 PERLDBf_SAVESRC)
6226 					/* No _NONAME, _GOTO */
6227 #define PERLDBf_SUB		0x01	/* Debug sub enter/exit */
6228 #define PERLDBf_LINE		0x02	/* Keep line # */
6229 #define PERLDBf_NOOPT		0x04	/* Switch off optimizations */
6230 #define PERLDBf_INTER		0x08	/* Preserve more data for
6231 					   later inspections  */
6232 #define PERLDBf_SUBLINE		0x10	/* Keep subr source lines */
6233 #define PERLDBf_SINGLE		0x20	/* Start with single-step on */
6234 #define PERLDBf_NONAME		0x40	/* For _SUB: no name of the subr */
6235 #define PERLDBf_GOTO		0x80	/* Report goto: call DB::goto */
6236 #define PERLDBf_NAMEEVAL	0x100	/* Informative names for evals */
6237 #define PERLDBf_NAMEANON	0x200	/* Informative names for anon subs */
6238 #define PERLDBf_SAVESRC  	0x400	/* Save source lines into @{"_<$filename"} */
6239 #define PERLDBf_SAVESRC_NOSUBS	0x800	/* Including evals that generate no subroutines */
6240 #define PERLDBf_SAVESRC_INVALID	0x1000	/* Save source that did not compile */
6241 
6242 #define PERLDB_SUB		(PL_perldb & PERLDBf_SUB)
6243 #define PERLDB_LINE		(PL_perldb & PERLDBf_LINE)
6244 #define PERLDB_NOOPT		(PL_perldb & PERLDBf_NOOPT)
6245 #define PERLDB_INTER		(PL_perldb & PERLDBf_INTER)
6246 #define PERLDB_SUBLINE		(PL_perldb & PERLDBf_SUBLINE)
6247 #define PERLDB_SINGLE		(PL_perldb & PERLDBf_SINGLE)
6248 #define PERLDB_SUB_NN		(PL_perldb & PERLDBf_NONAME)
6249 #define PERLDB_GOTO		(PL_perldb & PERLDBf_GOTO)
6250 #define PERLDB_NAMEEVAL 	(PL_perldb & PERLDBf_NAMEEVAL)
6251 #define PERLDB_NAMEANON 	(PL_perldb & PERLDBf_NAMEANON)
6252 #define PERLDB_SAVESRC  	(PL_perldb & PERLDBf_SAVESRC)
6253 #define PERLDB_SAVESRC_NOSUBS	(PL_perldb & PERLDBf_SAVESRC_NOSUBS)
6254 #define PERLDB_SAVESRC_INVALID	(PL_perldb & PERLDBf_SAVESRC_INVALID)
6255 
6256 #define PERLDB_LINE_OR_SAVESRC (PL_perldb & (PERLDBf_LINE | PERLDBf_SAVESRC))
6257 
6258 #ifdef USE_ITHREADS
6259 #  define KEYWORD_PLUGIN_MUTEX_INIT    MUTEX_INIT(&PL_keyword_plugin_mutex)
6260 #  define KEYWORD_PLUGIN_MUTEX_LOCK    MUTEX_LOCK(&PL_keyword_plugin_mutex)
6261 #  define KEYWORD_PLUGIN_MUTEX_UNLOCK  MUTEX_UNLOCK(&PL_keyword_plugin_mutex)
6262 #  define KEYWORD_PLUGIN_MUTEX_TERM    MUTEX_DESTROY(&PL_keyword_plugin_mutex)
6263 #  define USER_PROP_MUTEX_INIT    MUTEX_INIT(&PL_user_prop_mutex)
6264 #  define USER_PROP_MUTEX_LOCK    MUTEX_LOCK(&PL_user_prop_mutex)
6265 #  define USER_PROP_MUTEX_UNLOCK  MUTEX_UNLOCK(&PL_user_prop_mutex)
6266 #  define USER_PROP_MUTEX_TERM    MUTEX_DESTROY(&PL_user_prop_mutex)
6267 #else
6268 #  define KEYWORD_PLUGIN_MUTEX_INIT    NOOP
6269 #  define KEYWORD_PLUGIN_MUTEX_LOCK    NOOP
6270 #  define KEYWORD_PLUGIN_MUTEX_UNLOCK  NOOP
6271 #  define KEYWORD_PLUGIN_MUTEX_TERM    NOOP
6272 #  define USER_PROP_MUTEX_INIT    NOOP
6273 #  define USER_PROP_MUTEX_LOCK    NOOP
6274 #  define USER_PROP_MUTEX_UNLOCK  NOOP
6275 #  define USER_PROP_MUTEX_TERM    NOOP
6276 #endif
6277 
6278 #ifdef USE_LOCALE /* These locale things are all subject to change */
6279 
6280    /* Returns TRUE if the plain locale pragma without a parameter is in effect.
6281     * */
6282 #  define IN_LOCALE_RUNTIME	(PL_curcop                                  \
6283                               && CopHINTS_get(PL_curcop) & HINT_LOCALE)
6284 
6285    /* Returns TRUE if either form of the locale pragma is in effect */
6286 #  define IN_SOME_LOCALE_FORM_RUNTIME                                       \
6287         cBOOL(CopHINTS_get(PL_curcop) & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
6288 
6289 #  define IN_LOCALE_COMPILETIME	cBOOL(PL_hints & HINT_LOCALE)
6290 #  define IN_SOME_LOCALE_FORM_COMPILETIME                                   \
6291                         cBOOL(PL_hints & (HINT_LOCALE|HINT_LOCALE_PARTIAL))
6292 
6293 /*
6294 =head1 Locale-related functions and macros
6295 
6296 =for apidoc Amn|bool|IN_LOCALE
6297 
6298 Evaluates to TRUE if the plain locale pragma without a parameter (S<C<use
6299 locale>>) is in effect.
6300 
6301 =for apidoc Amn|bool|IN_LOCALE_COMPILETIME
6302 
6303 Evaluates to TRUE if, when compiling a perl program (including an C<eval>) if
6304 the plain locale pragma without a parameter (S<C<use locale>>) is in effect.
6305 
6306 =for apidoc Amn|bool|IN_LOCALE_RUNTIME
6307 
6308 Evaluates to TRUE if, when executing a perl program (including an C<eval>) if
6309 the plain locale pragma without a parameter (S<C<use locale>>) is in effect.
6310 
6311 =cut
6312 */
6313 
6314 #  define IN_LOCALE                                                         \
6315         (IN_PERL_COMPILETIME ? IN_LOCALE_COMPILETIME : IN_LOCALE_RUNTIME)
6316 #  define IN_SOME_LOCALE_FORM                                               \
6317                     (IN_PERL_COMPILETIME ? IN_SOME_LOCALE_FORM_COMPILETIME  \
6318                                          : IN_SOME_LOCALE_FORM_RUNTIME)
6319 
6320 #  define IN_LC_ALL_COMPILETIME   IN_LOCALE_COMPILETIME
6321 #  define IN_LC_ALL_RUNTIME       IN_LOCALE_RUNTIME
6322 
6323 #  define IN_LC_PARTIAL_COMPILETIME   cBOOL(PL_hints & HINT_LOCALE_PARTIAL)
6324 #  define IN_LC_PARTIAL_RUNTIME                                             \
6325               (PL_curcop && CopHINTS_get(PL_curcop) & HINT_LOCALE_PARTIAL)
6326 
6327 #  define IN_LC_COMPILETIME(category)                                       \
6328        (       IN_LC_ALL_COMPILETIME                                        \
6329         || (   IN_LC_PARTIAL_COMPILETIME                                    \
6330             && Perl__is_in_locale_category(aTHX_ TRUE, (category))))
6331 #  define IN_LC_RUNTIME(category)                                           \
6332       (IN_LC_ALL_RUNTIME || (IN_LC_PARTIAL_RUNTIME                          \
6333                  && Perl__is_in_locale_category(aTHX_ FALSE, (category))))
6334 #  define IN_LC(category)  \
6335                     (IN_LC_COMPILETIME(category) || IN_LC_RUNTIME(category))
6336 
6337 #  if defined (PERL_CORE) || defined (PERL_IN_XSUB_RE)
6338 
6339      /* This internal macro should be called from places that operate under
6340       * locale rules.  If there is a problem with the current locale that
6341       * hasn't been raised yet, it will output a warning this time.  Because
6342       * this will so rarely  be true, there is no point to optimize for time;
6343       * instead it makes sense to minimize space used and do all the work in
6344       * the rarely called function */
6345 #    ifdef USE_LOCALE_CTYPE
6346 #      define _CHECK_AND_WARN_PROBLEMATIC_LOCALE                              \
6347                 STMT_START {                                                  \
6348                     if (UNLIKELY(PL_warn_locale)) {                           \
6349                         Perl__warn_problematic_locale();                      \
6350                     }                                                         \
6351                 }  STMT_END
6352 #    else
6353 #      define _CHECK_AND_WARN_PROBLEMATIC_LOCALE
6354 #    endif
6355 
6356 
6357      /* These two internal macros are called when a warning should be raised,
6358       * and will do so if enabled.  The first takes a single code point
6359       * argument; the 2nd, is a pointer to the first byte of the UTF-8 encoded
6360       * string, and an end position which it won't try to read past */
6361 #    define _CHECK_AND_OUTPUT_WIDE_LOCALE_CP_MSG(cp)                        \
6362 	STMT_START {                                                        \
6363             if (! PL_in_utf8_CTYPE_locale && ckWARN(WARN_LOCALE)) {         \
6364                 Perl_warner(aTHX_ packWARN(WARN_LOCALE),                    \
6365                                        "Wide character (U+%" UVXf ") in %s",\
6366                                        (UV) cp, OP_DESC(PL_op));            \
6367             }                                                               \
6368         }  STMT_END
6369 
6370 #    define _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(s, send)                 \
6371 	STMT_START { /* Check if to warn before doing the conversion work */\
6372             if (! PL_in_utf8_CTYPE_locale && ckWARN(WARN_LOCALE)) {         \
6373                 UV cp = utf8_to_uvchr_buf((U8 *) (s), (U8 *) (send), NULL); \
6374                 Perl_warner(aTHX_ packWARN(WARN_LOCALE),                    \
6375                     "Wide character (U+%" UVXf ") in %s",                   \
6376                     (cp == 0)                                               \
6377                      ? UNICODE_REPLACEMENT                                  \
6378                      : (UV) cp,                                             \
6379                     OP_DESC(PL_op));                                        \
6380             }                                                               \
6381         }  STMT_END
6382 
6383 #  endif   /* PERL_CORE or PERL_IN_XSUB_RE */
6384 #else   /* No locale usage */
6385 #  define IN_LOCALE_RUNTIME                0
6386 #  define IN_SOME_LOCALE_FORM_RUNTIME      0
6387 #  define IN_LOCALE_COMPILETIME            0
6388 #  define IN_SOME_LOCALE_FORM_COMPILETIME  0
6389 #  define IN_LOCALE                        0
6390 #  define IN_SOME_LOCALE_FORM              0
6391 #  define IN_LC_ALL_COMPILETIME            0
6392 #  define IN_LC_ALL_RUNTIME                0
6393 #  define IN_LC_PARTIAL_COMPILETIME        0
6394 #  define IN_LC_PARTIAL_RUNTIME            0
6395 #  define IN_LC_COMPILETIME(category)      0
6396 #  define IN_LC_RUNTIME(category)          0
6397 #  define IN_LC(category)                  0
6398 #  define _CHECK_AND_WARN_PROBLEMATIC_LOCALE
6399 #  define _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(s, send)
6400 #  define _CHECK_AND_OUTPUT_WIDE_LOCALE_CP_MSG(c)
6401 #endif
6402 
6403 
6404 /* Locale/thread synchronization macros.  These aren't needed if using
6405  * thread-safe locale operations, except if something is broken */
6406 #if    defined(USE_LOCALE)                                                  \
6407  &&    defined(USE_ITHREADS)                                                \
6408  && (! defined(USE_THREAD_SAFE_LOCALE) || defined(TS_W32_BROKEN_LOCALECONV))
6409 
6410 /* We have a locale object holding the 'C' locale for Posix 2008 */
6411 #  ifndef USE_POSIX_2008_LOCALE
6412 #    define _LOCALE_TERM_POSIX_2008  NOOP
6413 #  else
6414 #    define _LOCALE_TERM_POSIX_2008                                         \
6415                     STMT_START {                                            \
6416                         if (PL_C_locale_obj) {                              \
6417                             /* Make sure we aren't using the locale         \
6418                              * space we are about to free */                \
6419                             uselocale(LC_GLOBAL_LOCALE);                    \
6420                             freelocale(PL_C_locale_obj);                    \
6421                             PL_C_locale_obj = (locale_t) NULL;              \
6422                         }                                                   \
6423                     } STMT_END
6424 #  endif
6425 
6426 /* This is used as a generic lock for locale operations.  For example this is
6427  * used when calling nl_langinfo() so that another thread won't zap the
6428  * contents of its buffer before it gets saved; and it's called when changing
6429  * the locale of LC_MESSAGES.  On some systems the latter can cause the
6430  * nl_langinfo buffer to be zapped under a race condition.
6431  *
6432  * If combined with LC_NUMERIC_LOCK, calls to this and its corresponding unlock
6433  * should be contained entirely within the locked portion of LC_NUMERIC.  This
6434  * mutex should be used only in very short sections of code, while
6435  * LC_NUMERIC_LOCK may span more operations.  By always following this
6436  * convention, deadlock should be impossible.  But if necessary, the two
6437  * mutexes could be combined.
6438  *
6439  * Actually, the two macros just below with the '_V' suffixes are used in just
6440  * a few places where there is a broken localeconv(), but otherwise things are
6441  * thread safe, and hence don't need locking.  Just below LOCALE_LOCK and
6442  * LOCALE_UNLOCK are defined in terms of these for use everywhere else */
6443 #  define LOCALE_LOCK_V                                                     \
6444         STMT_START {                                                        \
6445             DEBUG_Lv(PerlIO_printf(Perl_debug_log,                          \
6446                     "%s: %d: locking locale\n", __FILE__, __LINE__));       \
6447             MUTEX_LOCK(&PL_locale_mutex);                                   \
6448         } STMT_END
6449 #  define LOCALE_UNLOCK_V                                                   \
6450         STMT_START {                                                        \
6451             DEBUG_Lv(PerlIO_printf(Perl_debug_log,                          \
6452                    "%s: %d: unlocking locale\n", __FILE__, __LINE__));      \
6453             MUTEX_UNLOCK(&PL_locale_mutex);                                 \
6454         } STMT_END
6455 
6456 /* On windows, we just need the mutex for LOCALE_LOCK */
6457 #  ifdef TS_W32_BROKEN_LOCALECONV
6458 #    define LOCALE_LOCK     NOOP
6459 #    define LOCALE_UNLOCK   NOOP
6460 #    define LOCALE_INIT     MUTEX_INIT(&PL_locale_mutex);
6461 #    define LOCALE_TERM     MUTEX_DESTROY(&PL_locale_mutex)
6462 #    define LC_NUMERIC_LOCK(cond)
6463 #    define LC_NUMERIC_UNLOCK
6464 #  else
6465 #    define LOCALE_LOCK     LOCALE_LOCK_V
6466 #    define LOCALE_UNLOCK   LOCALE_UNLOCK_V
6467 
6468      /* We also need to lock LC_NUMERIC for non-windows (hence Posix 2008)
6469       * systems */
6470 #    define LOCALE_INIT          STMT_START {                               \
6471                                     MUTEX_INIT(&PL_locale_mutex);           \
6472                                     MUTEX_INIT(&PL_lc_numeric_mutex);       \
6473                                 } STMT_END
6474 
6475 #    define LOCALE_TERM         STMT_START {                                \
6476                                     MUTEX_DESTROY(&PL_locale_mutex);        \
6477                                     MUTEX_DESTROY(&PL_lc_numeric_mutex);    \
6478                                     _LOCALE_TERM_POSIX_2008;                \
6479                                 } STMT_END
6480 
6481     /* This mutex is used to create critical sections where we want the
6482      * LC_NUMERIC locale to be locked into either the C (standard) locale, or
6483      * the underlying locale, so that other threads interrupting this one don't
6484      * change it to the wrong state before we've had a chance to complete our
6485      * operation.  It can stay locked over an entire printf operation, for
6486      * example.  And so is made distinct from the LOCALE_LOCK mutex.
6487      *
6488      * This simulates kind of a general semaphore.  The current thread will
6489      * lock the mutex if the per-thread variable is zero, and then increments
6490      * that variable.  Each corresponding UNLOCK decrements the variable until
6491      * it is 0, at which point it actually unlocks the mutex.  Since the
6492      * variable is per-thread, there is no race with other threads.
6493      *
6494      * The single argument is a condition to test for, and if true, to panic,
6495      * as this would be an attempt to complement the LC_NUMERIC state, and
6496      * we're not supposed to because it's locked.
6497      *
6498      * Clang improperly gives warnings for this, if not silenced:
6499      * https://clang.llvm.org/docs/ThreadSafetyAnalysis.html#conditional-locks
6500      * */
6501 #    define LC_NUMERIC_LOCK(cond_to_panic_if_already_locked)                \
6502         CLANG_DIAG_IGNORE(-Wthread-safety)	     	                    \
6503         STMT_START {                                                        \
6504             if (PL_lc_numeric_mutex_depth <= 0) {                           \
6505                 MUTEX_LOCK(&PL_lc_numeric_mutex);                           \
6506                 PL_lc_numeric_mutex_depth = 1;                              \
6507                 DEBUG_Lv(PerlIO_printf(Perl_debug_log,                      \
6508                          "%s: %d: locking lc_numeric; depth=1\n",           \
6509                          __FILE__, __LINE__));                              \
6510             }                                                               \
6511             else {                                                          \
6512                 PL_lc_numeric_mutex_depth++;                                \
6513                 DEBUG_Lv(PerlIO_printf(Perl_debug_log,                      \
6514                         "%s: %d: avoided lc_numeric_lock; new depth=%d\n",  \
6515                         __FILE__, __LINE__, PL_lc_numeric_mutex_depth));    \
6516                 if (cond_to_panic_if_already_locked) {                      \
6517                     Perl_croak_nocontext("panic: %s: %d: Trying to change"  \
6518                                          " LC_NUMERIC incompatibly",        \
6519                                          __FILE__, __LINE__);               \
6520                 }                                                           \
6521             }                                                               \
6522         } STMT_END
6523 
6524 #    define LC_NUMERIC_UNLOCK                                               \
6525         STMT_START {                                                        \
6526             if (PL_lc_numeric_mutex_depth <= 1) {                           \
6527                 MUTEX_UNLOCK(&PL_lc_numeric_mutex);                         \
6528                 PL_lc_numeric_mutex_depth = 0;                              \
6529                 DEBUG_Lv(PerlIO_printf(Perl_debug_log,                      \
6530                          "%s: %d: unlocking lc_numeric; depth=0\n",         \
6531                          __FILE__, __LINE__));                              \
6532             }                                                               \
6533             else {                                                          \
6534                 PL_lc_numeric_mutex_depth--;                                \
6535                 DEBUG_Lv(PerlIO_printf(Perl_debug_log,                      \
6536                         "%s: %d: avoided lc_numeric_unlock; new depth=%d\n",\
6537                         __FILE__, __LINE__, PL_lc_numeric_mutex_depth));    \
6538             }                                                               \
6539         } STMT_END                                                          \
6540         CLANG_DIAG_RESTORE
6541 
6542 #  endif    /* End of needs locking LC_NUMERIC */
6543 #else   /* Below is no locale sync needed */
6544 #  define LOCALE_INIT
6545 #  define LOCALE_LOCK
6546 #  define LOCALE_LOCK_V
6547 #  define LOCALE_UNLOCK
6548 #  define LOCALE_UNLOCK_V
6549 #  define LC_NUMERIC_LOCK(cond)
6550 #  define LC_NUMERIC_UNLOCK
6551 #  define LOCALE_TERM
6552 #endif
6553 
6554 #ifdef USE_LOCALE_NUMERIC
6555 
6556 /* These macros are for toggling between the underlying locale (UNDERLYING or
6557  * LOCAL) and the C locale (STANDARD).  (Actually we don't have to use the C
6558  * locale if the underlying locale is indistinguishable from it in the numeric
6559  * operations used by Perl, namely the decimal point, and even the thousands
6560  * separator.)
6561 
6562 =head1 Locale-related functions and macros
6563 
6564 =for apidoc Amn|void|DECLARATION_FOR_LC_NUMERIC_MANIPULATION
6565 
6566 This macro should be used as a statement.  It declares a private variable
6567 (whose name begins with an underscore) that is needed by the other macros in
6568 this section.  Failing to include this correctly should lead to a syntax error.
6569 For compatibility with C89 C compilers it should be placed in a block before
6570 any executable statements.
6571 
6572 =for apidoc Am|void|STORE_LC_NUMERIC_FORCE_TO_UNDERLYING
6573 
6574 This is used by XS code that is C<LC_NUMERIC> locale-aware to force the
6575 locale for category C<LC_NUMERIC> to be what perl thinks is the current
6576 underlying locale.  (The perl interpreter could be wrong about what the
6577 underlying locale actually is if some C or XS code has called the C library
6578 function L<setlocale(3)> behind its back; calling L</sync_locale> before calling
6579 this macro will update perl's records.)
6580 
6581 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
6582 declare at compile time a private variable used by this macro.  This macro
6583 should be called as a single statement, not an expression, but with an empty
6584 argument list, like this:
6585 
6586  {
6587     DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6588      ...
6589     STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
6590      ...
6591     RESTORE_LC_NUMERIC();
6592      ...
6593  }
6594 
6595 The private variable is used to save the current locale state, so
6596 that the requisite matching call to L</RESTORE_LC_NUMERIC> can restore it.
6597 
6598 On threaded perls not operating with thread-safe functionality, this macro uses
6599 a mutex to force a critical section.  Therefore the matching RESTORE should be
6600 close by, and guaranteed to be called.
6601 
6602 =for apidoc Am|void|STORE_LC_NUMERIC_SET_TO_NEEDED
6603 
6604 This is used to help wrap XS or C code that is C<LC_NUMERIC> locale-aware.
6605 This locale category is generally kept set to a locale where the decimal radix
6606 character is a dot, and the separator between groups of digits is empty.  This
6607 is because most XS code that reads floating point numbers is expecting them to
6608 have this syntax.
6609 
6610 This macro makes sure the current C<LC_NUMERIC> state is set properly, to be
6611 aware of locale if the call to the XS or C code from the Perl program is
6612 from within the scope of a S<C<use locale>>; or to ignore locale if the call is
6613 instead from outside such scope.
6614 
6615 This macro is the start of wrapping the C or XS code; the wrap ending is done
6616 by calling the L</RESTORE_LC_NUMERIC> macro after the operation.  Otherwise
6617 the state can be changed that will adversely affect other XS code.
6618 
6619 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
6620 declare at compile time a private variable used by this macro.  This macro
6621 should be called as a single statement, not an expression, but with an empty
6622 argument list, like this:
6623 
6624  {
6625     DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6626      ...
6627     STORE_LC_NUMERIC_SET_TO_NEEDED();
6628      ...
6629     RESTORE_LC_NUMERIC();
6630      ...
6631  }
6632 
6633 On threaded perls not operating with thread-safe functionality, this macro uses
6634 a mutex to force a critical section.  Therefore the matching RESTORE should be
6635 close by, and guaranteed to be called; see L</WITH_LC_NUMERIC_SET_TO_NEEDED>
6636 for a more contained way to ensure that.
6637 
6638 =for apidoc Am|void|STORE_LC_NUMERIC_SET_TO_NEEDED_IN|bool in_lc_numeric
6639 
6640 Same as L</STORE_LC_NUMERIC_SET_TO_NEEDED> with in_lc_numeric provided
6641 as the precalculated value of C<IN_LC(LC_NUMERIC)>. It is the caller's
6642 responsibility to ensure that the status of C<PL_compiling> and C<PL_hints>
6643 cannot have changed since the precalculation.
6644 
6645 =for apidoc Am|void|RESTORE_LC_NUMERIC
6646 
6647 This is used in conjunction with one of the macros
6648 L</STORE_LC_NUMERIC_SET_TO_NEEDED>
6649 and L</STORE_LC_NUMERIC_FORCE_TO_UNDERLYING> to properly restore the
6650 C<LC_NUMERIC> state.
6651 
6652 A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
6653 declare at compile time a private variable used by this macro and the two
6654 C<STORE> ones.  This macro should be called as a single statement, not an
6655 expression, but with an empty argument list, like this:
6656 
6657  {
6658     DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6659      ...
6660     RESTORE_LC_NUMERIC();
6661      ...
6662  }
6663 
6664 =for apidoc Am|void|WITH_LC_NUMERIC_SET_TO_NEEDED|block
6665 
6666 This macro invokes the supplied statement or block within the context
6667 of a L</STORE_LC_NUMERIC_SET_TO_NEEDED> .. L</RESTORE_LC_NUMERIC> pair
6668 if required, so eg:
6669 
6670   WITH_LC_NUMERIC_SET_TO_NEEDED(
6671     SNPRINTF_G(fv, ebuf, sizeof(ebuf), precis)
6672   );
6673 
6674 is equivalent to:
6675 
6676   {
6677 #ifdef USE_LOCALE_NUMERIC
6678     DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
6679     STORE_LC_NUMERIC_SET_TO_NEEDED();
6680 #endif
6681     SNPRINTF_G(fv, ebuf, sizeof(ebuf), precis);
6682 #ifdef USE_LOCALE_NUMERIC
6683     RESTORE_LC_NUMERIC();
6684 #endif
6685   }
6686 
6687 =for apidoc Am|void|WITH_LC_NUMERIC_SET_TO_NEEDED_IN|bool in_lc_numeric|block
6688 
6689 Same as L</WITH_LC_NUMERIC_SET_TO_NEEDED> with in_lc_numeric provided
6690 as the precalculated value of C<IN_LC(LC_NUMERIC)>. It is the caller's
6691 responsibility to ensure that the status of C<PL_compiling> and C<PL_hints>
6692 cannot have changed since the precalculation.
6693 
6694 =cut
6695 
6696 */
6697 
6698 /* If the underlying numeric locale has a non-dot decimal point or has a
6699  * non-empty floating point thousands separator, the current locale is instead
6700  * generally kept in the C locale instead of that underlying locale.  The
6701  * current status is known by looking at two words.  One is non-zero if the
6702  * current numeric locale is the standard C/POSIX one or is indistinguishable
6703  * from C.  The other is non-zero if the current locale is the underlying
6704  * locale.  Both can be non-zero if, as often happens, the underlying locale is
6705  * C or indistinguishable from it.
6706  *
6707  * khw believes the reason for the variables instead of the bits in a single
6708  * word is to avoid having to have masking instructions. */
6709 
6710 #  define _NOT_IN_NUMERIC_STANDARD (! PL_numeric_standard)
6711 
6712 /* We can lock the category to stay in the C locale, making requests to the
6713  * contrary be noops, in the dynamic scope by setting PL_numeric_standard to 2.
6714  * */
6715 #  define _NOT_IN_NUMERIC_UNDERLYING                                        \
6716                     (! PL_numeric_underlying && PL_numeric_standard < 2)
6717 
6718 #  define DECLARATION_FOR_LC_NUMERIC_MANIPULATION                           \
6719     void (*_restore_LC_NUMERIC_function)(pTHX) = NULL
6720 
6721 #  define STORE_LC_NUMERIC_SET_TO_NEEDED_IN(in)                             \
6722         STMT_START {                                                        \
6723             bool _in_lc_numeric = (in);                                     \
6724             LC_NUMERIC_LOCK(                                                \
6725                     (   (  _in_lc_numeric && _NOT_IN_NUMERIC_UNDERLYING)    \
6726                      || (! _in_lc_numeric && _NOT_IN_NUMERIC_STANDARD)));   \
6727             if (_in_lc_numeric) {                                           \
6728                 if (_NOT_IN_NUMERIC_UNDERLYING) {                           \
6729                     Perl_set_numeric_underlying(aTHX);                      \
6730                     _restore_LC_NUMERIC_function                            \
6731                                             = &Perl_set_numeric_standard;   \
6732                 }                                                           \
6733             }                                                               \
6734             else {                                                          \
6735                 if (_NOT_IN_NUMERIC_STANDARD) {                             \
6736                     Perl_set_numeric_standard(aTHX);                        \
6737                     _restore_LC_NUMERIC_function                            \
6738                                             = &Perl_set_numeric_underlying; \
6739                 }                                                           \
6740             }                                                               \
6741         } STMT_END
6742 
6743 #  define STORE_LC_NUMERIC_SET_TO_NEEDED() \
6744         STORE_LC_NUMERIC_SET_TO_NEEDED_IN(IN_LC(LC_NUMERIC))
6745 
6746 #  define RESTORE_LC_NUMERIC()                                              \
6747         STMT_START {                                                        \
6748             if (_restore_LC_NUMERIC_function) {                             \
6749                 _restore_LC_NUMERIC_function(aTHX);                         \
6750             }                                                               \
6751             LC_NUMERIC_UNLOCK;                                              \
6752         } STMT_END
6753 
6754 /* The next two macros set unconditionally.  These should be rarely used, and
6755  * only after being sure that this is what is needed */
6756 #  define SET_NUMERIC_STANDARD()                                            \
6757 	STMT_START {                                                        \
6758             DEBUG_Lv(PerlIO_printf(Perl_debug_log,                          \
6759                                "%s: %d: lc_numeric standard=%d\n",          \
6760                                 __FILE__, __LINE__, PL_numeric_standard));  \
6761             Perl_set_numeric_standard(aTHX);                                \
6762             DEBUG_Lv(PerlIO_printf(Perl_debug_log,                          \
6763                                  "%s: %d: lc_numeric standard=%d\n",        \
6764                                  __FILE__, __LINE__, PL_numeric_standard)); \
6765         } STMT_END
6766 
6767 #  define SET_NUMERIC_UNDERLYING()                                          \
6768 	STMT_START {                                                        \
6769             if (_NOT_IN_NUMERIC_UNDERLYING) {                               \
6770                 Perl_set_numeric_underlying(aTHX);                          \
6771             }                                                               \
6772         } STMT_END
6773 
6774 /* The rest of these LC_NUMERIC macros toggle to one or the other state, with
6775  * the RESTORE_foo ones called to switch back, but only if need be */
6776 #  define STORE_LC_NUMERIC_SET_STANDARD()                                   \
6777         STMT_START {                                                        \
6778             LC_NUMERIC_LOCK(_NOT_IN_NUMERIC_STANDARD);                      \
6779             if (_NOT_IN_NUMERIC_STANDARD) {                                 \
6780                 _restore_LC_NUMERIC_function = &Perl_set_numeric_underlying;\
6781                 Perl_set_numeric_standard(aTHX);                            \
6782             }                                                               \
6783         } STMT_END
6784 
6785 /* Rarely, we want to change to the underlying locale even outside of 'use
6786  * locale'.  This is principally in the POSIX:: functions */
6787 #  define STORE_LC_NUMERIC_FORCE_TO_UNDERLYING()                            \
6788 	STMT_START {                                                        \
6789             LC_NUMERIC_LOCK(_NOT_IN_NUMERIC_UNDERLYING);                    \
6790             if (_NOT_IN_NUMERIC_UNDERLYING) {                               \
6791                 Perl_set_numeric_underlying(aTHX);                          \
6792                 _restore_LC_NUMERIC_function = &Perl_set_numeric_standard;  \
6793             }                                                               \
6794         } STMT_END
6795 
6796 /* Lock/unlock to the C locale until unlock is called.  This needs to be
6797  * recursively callable.  [perl #128207] */
6798 #  define LOCK_LC_NUMERIC_STANDARD()                                        \
6799         STMT_START {                                                        \
6800             DEBUG_Lv(PerlIO_printf(Perl_debug_log,                          \
6801                       "%s: %d: lock lc_numeric_standard: new depth=%d\n",   \
6802                       __FILE__, __LINE__, PL_numeric_standard + 1));        \
6803             __ASSERT_(PL_numeric_standard)                                  \
6804             PL_numeric_standard++;                                          \
6805         } STMT_END
6806 
6807 #  define UNLOCK_LC_NUMERIC_STANDARD()                                      \
6808         STMT_START {                                                        \
6809             if (PL_numeric_standard > 1) {                                  \
6810                 PL_numeric_standard--;                                      \
6811             }                                                               \
6812             else {                                                          \
6813                 assert(0);                                                  \
6814             }                                                               \
6815             DEBUG_Lv(PerlIO_printf(Perl_debug_log,                          \
6816             "%s: %d: lc_numeric_standard decrement lock, new depth=%d\n",   \
6817             __FILE__, __LINE__, PL_numeric_standard));                      \
6818         } STMT_END
6819 
6820 #  define WITH_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric, block)            \
6821         STMT_START {                                                        \
6822             DECLARATION_FOR_LC_NUMERIC_MANIPULATION;                        \
6823             STORE_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric);               \
6824             block;                                                          \
6825             RESTORE_LC_NUMERIC();                                           \
6826         } STMT_END;
6827 
6828 #  define WITH_LC_NUMERIC_SET_TO_NEEDED(block) \
6829         WITH_LC_NUMERIC_SET_TO_NEEDED_IN(IN_LC(LC_NUMERIC), block)
6830 
6831 #else /* !USE_LOCALE_NUMERIC */
6832 
6833 #  define SET_NUMERIC_STANDARD()
6834 #  define SET_NUMERIC_UNDERLYING()
6835 #  define IS_NUMERIC_RADIX(a, b)		(0)
6836 #  define DECLARATION_FOR_LC_NUMERIC_MANIPULATION  dNOOP
6837 #  define STORE_LC_NUMERIC_SET_STANDARD()
6838 #  define STORE_LC_NUMERIC_FORCE_TO_UNDERLYING()
6839 #  define STORE_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric)
6840 #  define STORE_LC_NUMERIC_SET_TO_NEEDED()
6841 #  define RESTORE_LC_NUMERIC()
6842 #  define LOCK_LC_NUMERIC_STANDARD()
6843 #  define UNLOCK_LC_NUMERIC_STANDARD()
6844 #  define WITH_LC_NUMERIC_SET_TO_NEEDED_IN(in_lc_numeric, block) \
6845     STMT_START { block; } STMT_END
6846 #  define WITH_LC_NUMERIC_SET_TO_NEEDED(block) \
6847     STMT_START { block; } STMT_END
6848 
6849 #endif /* !USE_LOCALE_NUMERIC */
6850 
6851 #define Atof				my_atof
6852 
6853 /*
6854 
6855 =head1 Numeric functions
6856 
6857 =for apidoc AmTR|NV|Strtod|NN const char * const s|NULLOK char ** e
6858 
6859 This is a synonym for L</my_strtod>.
6860 
6861 =for apidoc AmTR|NV|Strtol|NN const char * const s|NULLOK char ** e|int base
6862 
6863 Platform and configuration independent C<strtol>.  This expands to the
6864 appropriate C<strotol>-like function based on the platform and F<Configure>
6865 options>.  For example it could expand to C<strtoll> or C<strtoq> instead of
6866 C<strtol>.
6867 
6868 =for apidoc AmTR|NV|Strtoul|NN const char * const s|NULLOK char ** e|int base
6869 
6870 Platform and configuration independent C<strtoul>.  This expands to the
6871 appropriate C<strotoul>-like function based on the platform and F<Configure>
6872 options>.  For example it could expand to C<strtoull> or C<strtouq> instead of
6873 C<strtoul>.
6874 
6875 =cut
6876 
6877 */
6878 
6879 #define Strtod                          my_strtod
6880 
6881 #if    defined(HAS_STRTOD)                                          \
6882    ||  defined(USE_QUADMATH)                                        \
6883    || (defined(HAS_STRTOLD) && defined(HAS_LONG_DOUBLE)             \
6884                             && defined(USE_LONG_DOUBLE))
6885 #  define Perl_strtod   Strtod
6886 #endif
6887 
6888 #if !defined(Strtol) && defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && \
6889 	(QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
6890 #    ifdef __hpux
6891 #        define strtoll __strtoll	/* secret handshake */
6892 #    endif
6893 #    if defined(WIN64) && defined(_MSC_VER)
6894 #        define strtoll _strtoi64	/* secret handshake */
6895 #    endif
6896 #   if !defined(Strtol) && defined(HAS_STRTOLL)
6897 #       define Strtol	strtoll
6898 #   endif
6899 #    if !defined(Strtol) && defined(HAS_STRTOQ)
6900 #       define Strtol	strtoq
6901 #    endif
6902 /* is there atoq() anywhere? */
6903 #endif
6904 #if !defined(Strtol) && defined(HAS_STRTOL)
6905 #   define Strtol	strtol
6906 #endif
6907 #ifndef Atol
6908 /* It would be more fashionable to use Strtol() to define atol()
6909  * (as is done for Atoul(), see below) but for backward compatibility
6910  * we just assume atol(). */
6911 #   if defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && defined(HAS_ATOLL) && \
6912 	(QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
6913 #    ifdef WIN64
6914 #       define atoll    _atoi64		/* secret handshake */
6915 #    endif
6916 #       define Atol	atoll
6917 #   else
6918 #       define Atol	atol
6919 #   endif
6920 #endif
6921 
6922 #if !defined(Strtoul) && defined(USE_64_BIT_INT) && defined(UV_IS_QUAD) && \
6923 	(QUADKIND == QUAD_IS_LONG_LONG || QUADKIND == QUAD_IS___INT64)
6924 #    ifdef __hpux
6925 #        define strtoull __strtoull	/* secret handshake */
6926 #    endif
6927 #    if defined(WIN64) && defined(_MSC_VER)
6928 #        define strtoull _strtoui64	/* secret handshake */
6929 #    endif
6930 #    if !defined(Strtoul) && defined(HAS_STRTOULL)
6931 #       define Strtoul	strtoull
6932 #    endif
6933 #    if !defined(Strtoul) && defined(HAS_STRTOUQ)
6934 #       define Strtoul	strtouq
6935 #    endif
6936 /* is there atouq() anywhere? */
6937 #endif
6938 #if !defined(Strtoul) && defined(HAS_STRTOUL)
6939 #   define Strtoul	strtoul
6940 #endif
6941 #if !defined(Strtoul) && defined(HAS_STRTOL) /* Last resort. */
6942 #   define Strtoul(s, e, b)	strchr((s), '-') ? ULONG_MAX : (unsigned long)strtol((s), (e), (b))
6943 #endif
6944 #ifndef Atoul
6945 #   define Atoul(s)	Strtoul(s, NULL, 10)
6946 #endif
6947 
6948 #define grok_bin(s,lp,fp,rp)                                                \
6949                     grok_bin_oct_hex(s, lp, fp, rp, 1, _CC_BINDIGIT, 'b')
6950 #define grok_oct(s,lp,fp,rp)                                                \
6951                     (*(fp) |= PERL_SCAN_DISALLOW_PREFIX,                    \
6952                     grok_bin_oct_hex(s, lp, fp, rp, 3, _CC_OCTDIGIT, '\0'))
6953 #define grok_hex(s,lp,fp,rp)                                                \
6954                     grok_bin_oct_hex(s, lp, fp, rp, 4, _CC_XDIGIT, 'x')
6955 
6956 #ifndef PERL_SCRIPT_MODE
6957 #define PERL_SCRIPT_MODE "r"
6958 #endif
6959 
6960 /* not used. Kept as a NOOP for backcompat */
6961 #define PERL_STACK_OVERFLOW_CHECK()  NOOP
6962 
6963 /*
6964  * Some nonpreemptive operating systems find it convenient to
6965  * check for asynchronous conditions after each op execution.
6966  * Keep this check simple, or it may slow down execution
6967  * massively.
6968  */
6969 
6970 #ifndef PERL_MICRO
6971 #	ifndef PERL_ASYNC_CHECK
6972 #		define PERL_ASYNC_CHECK() if (UNLIKELY(PL_sig_pending)) PL_signalhook(aTHX)
6973 #	endif
6974 #endif
6975 
6976 #ifndef PERL_ASYNC_CHECK
6977 #   define PERL_ASYNC_CHECK()  NOOP
6978 #endif
6979 
6980 /*
6981  * On some operating systems, a memory allocation may succeed,
6982  * but put the process too close to the system's comfort limit.
6983  * In this case, PERL_ALLOC_CHECK frees the pointer and sets
6984  * it to NULL.
6985  */
6986 #ifndef PERL_ALLOC_CHECK
6987 #define PERL_ALLOC_CHECK(p)  NOOP
6988 #endif
6989 
6990 #ifdef HAS_SEM
6991 #   include <sys/ipc.h>
6992 #   include <sys/sem.h>
6993 #   ifndef HAS_UNION_SEMUN	/* Provide the union semun. */
6994     union semun {
6995 	int		val;
6996 	struct semid_ds	*buf;
6997 	unsigned short	*array;
6998     };
6999 #   endif
7000 #   ifdef USE_SEMCTL_SEMUN
7001 #	ifdef IRIX32_SEMUN_BROKEN_BY_GCC
7002             union gccbug_semun {
7003 		int             val;
7004 		struct semid_ds *buf;
7005 		unsigned short  *array;
7006 		char            __dummy[5];
7007 	    };
7008 #           define semun gccbug_semun
7009 #	endif
7010 #       define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun)
7011 #   elif defined(USE_SEMCTL_SEMID_DS)
7012 #           ifdef EXTRA_F_IN_SEMUN_BUF
7013 #               define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buff)
7014 #           else
7015 #               define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buf)
7016 #           endif
7017 #   endif
7018 #endif
7019 
7020 /*
7021  * Boilerplate macros for initializing and accessing interpreter-local
7022  * data from C.  All statics in extensions should be reworked to use
7023  * this, if you want to make the extension thread-safe.  See
7024  * ext/XS/APItest/APItest.xs for an example of the use of these macros,
7025  * and perlxs.pod for more.
7026  *
7027  * Code that uses these macros is responsible for the following:
7028  * 1. #define MY_CXT_KEY to a unique string, e.g.
7029  *    "DynaLoader::_guts" XS_VERSION
7030  *    XXX in the current implementation, this string is ignored.
7031  * 2. Declare a typedef named my_cxt_t that is a structure that contains
7032  *    all the data that needs to be interpreter-local.
7033  * 3. Use the START_MY_CXT macro after the declaration of my_cxt_t.
7034  * 4. Use the MY_CXT_INIT macro such that it is called exactly once
7035  *    (typically put in the BOOT: section).
7036  * 5. Use the members of the my_cxt_t structure everywhere as
7037  *    MY_CXT.member.
7038  * 6. Use the dMY_CXT macro (a declaration) in all the functions that
7039  *    access MY_CXT.
7040  */
7041 
7042 #if defined(PERL_IMPLICIT_CONTEXT)
7043 
7044 /* START_MY_CXT must appear in all extensions that define a my_cxt_t structure,
7045  * right after the definition (i.e. at file scope).  The non-threads
7046  * case below uses it to declare the data as static. */
7047 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
7048 #    define START_MY_CXT
7049 #    define MY_CXT_INDEX Perl_my_cxt_index(aTHX_ MY_CXT_KEY)
7050 #    define MY_CXT_INIT_ARG MY_CXT_KEY
7051 #  else
7052 #    define START_MY_CXT static int my_cxt_index = -1;
7053 #    define MY_CXT_INDEX my_cxt_index
7054 #    define MY_CXT_INIT_ARG &my_cxt_index
7055 #  endif /* #ifdef PERL_GLOBAL_STRUCT_PRIVATE */
7056 
7057 /* Creates and zeroes the per-interpreter data.
7058  * (We allocate my_cxtp in a Perl SV so that it will be released when
7059  * the interpreter goes away.) */
7060 #  define MY_CXT_INIT \
7061 	my_cxt_t *my_cxtp = \
7062 	    (my_cxt_t*)Perl_my_cxt_init(aTHX_ MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
7063 	PERL_UNUSED_VAR(my_cxtp)
7064 #  define MY_CXT_INIT_INTERP(my_perl) \
7065 	my_cxt_t *my_cxtp = \
7066 	    (my_cxt_t*)Perl_my_cxt_init(my_perl, MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
7067 	PERL_UNUSED_VAR(my_cxtp)
7068 
7069 /* This declaration should be used within all functions that use the
7070  * interpreter-local data. */
7071 #  define dMY_CXT	\
7072 	my_cxt_t *my_cxtp = (my_cxt_t *)PL_my_cxt_list[MY_CXT_INDEX]
7073 #  define dMY_CXT_INTERP(my_perl)	\
7074 	my_cxt_t *my_cxtp = (my_cxt_t *)(my_perl)->Imy_cxt_list[MY_CXT_INDEX]
7075 
7076 /* Clones the per-interpreter data. */
7077 #  define MY_CXT_CLONE \
7078 	my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1));\
7079 	void * old_my_cxtp = PL_my_cxt_list[MY_CXT_INDEX];		\
7080 	PL_my_cxt_list[MY_CXT_INDEX] = my_cxtp;				\
7081 	Copy(old_my_cxtp, my_cxtp, 1, my_cxt_t);
7082 
7083 
7084 
7085 /* This macro must be used to access members of the my_cxt_t structure.
7086  * e.g. MY_CXT.some_data */
7087 #  define MY_CXT		(*my_cxtp)
7088 
7089 /* Judicious use of these macros can reduce the number of times dMY_CXT
7090  * is used.  Use is similar to pTHX, aTHX etc. */
7091 #  define pMY_CXT	my_cxt_t *my_cxtp
7092 #  define pMY_CXT_	pMY_CXT,
7093 #  define _pMY_CXT	,pMY_CXT
7094 #  define aMY_CXT	my_cxtp
7095 #  define aMY_CXT_	aMY_CXT,
7096 #  define _aMY_CXT	,aMY_CXT
7097 
7098 #else /* PERL_IMPLICIT_CONTEXT */
7099 
7100 #  define START_MY_CXT		static my_cxt_t my_cxt;
7101 #  define dMY_CXT_SV	    	dNOOP
7102 #  define dMY_CXT		dNOOP
7103 #  define dMY_CXT_INTERP(my_perl) dNOOP
7104 #  define MY_CXT_INIT		NOOP
7105 #  define MY_CXT_CLONE		NOOP
7106 #  define MY_CXT		my_cxt
7107 
7108 #  define pMY_CXT		void
7109 #  define pMY_CXT_
7110 #  define _pMY_CXT
7111 #  define aMY_CXT
7112 #  define aMY_CXT_
7113 #  define _aMY_CXT
7114 
7115 #endif /* !defined(PERL_IMPLICIT_CONTEXT) */
7116 
7117 #ifdef I_FCNTL
7118 #  include <fcntl.h>
7119 #endif
7120 
7121 #ifdef __Lynx__
7122 #  include <fcntl.h>
7123 #endif
7124 
7125 #ifdef __amigaos4__
7126 #  undef FD_CLOEXEC /* a lie in AmigaOS */
7127 #endif
7128 
7129 #ifdef I_SYS_FILE
7130 #  include <sys/file.h>
7131 #endif
7132 
7133 #if defined(HAS_FLOCK) && !defined(HAS_FLOCK_PROTO)
7134 EXTERN_C int flock(int fd, int op);
7135 #endif
7136 
7137 #ifndef O_RDONLY
7138 /* Assume UNIX defaults */
7139 #    define O_RDONLY	0000
7140 #    define O_WRONLY	0001
7141 #    define O_RDWR	0002
7142 #    define O_CREAT	0100
7143 #endif
7144 
7145 #ifndef O_BINARY
7146 #  define O_BINARY 0
7147 #endif
7148 
7149 #ifndef O_TEXT
7150 #  define O_TEXT 0
7151 #endif
7152 
7153 #if O_TEXT != O_BINARY
7154     /* If you have different O_TEXT and O_BINARY and you are a CRLF shop,
7155      * that is, you are somehow DOSish. */
7156 #   if defined(__HAIKU__) || defined(__VOS__) || defined(__CYGWIN__)
7157     /* Haiku has O_TEXT != O_BINARY but O_TEXT and O_BINARY have no effect;
7158      * Haiku is always UNIXoid (LF), not DOSish (CRLF). */
7159     /* VOS has O_TEXT != O_BINARY, and they have effect,
7160      * but VOS always uses LF, never CRLF. */
7161     /* If you have O_TEXT different from your O_BINARY but you still are
7162      * not a CRLF shop. */
7163 #       undef PERLIO_USING_CRLF
7164 #   else
7165     /* If you really are DOSish. */
7166 #      define PERLIO_USING_CRLF 1
7167 #   endif
7168 #endif
7169 
7170 #ifdef I_LIBUTIL
7171 #   include <libutil.h>		/* setproctitle() in some FreeBSDs */
7172 #endif
7173 
7174 #ifndef EXEC_ARGV_CAST
7175 #define EXEC_ARGV_CAST(x) (char **)x
7176 #endif
7177 
7178 #define IS_NUMBER_IN_UV		      0x01 /* number within UV range (maybe not
7179 					      int).  value returned in pointed-
7180 					      to UV */
7181 #define IS_NUMBER_GREATER_THAN_UV_MAX 0x02 /* pointed to UV undefined */
7182 #define IS_NUMBER_NOT_INT	      0x04 /* saw . or E notation or infnan */
7183 #define IS_NUMBER_NEG		      0x08 /* leading minus sign */
7184 #define IS_NUMBER_INFINITY	      0x10 /* this is big */
7185 #define IS_NUMBER_NAN                 0x20 /* this is not */
7186 #define IS_NUMBER_TRAILING            0x40 /* number has trailing trash */
7187 
7188 /*
7189 =head1 Numeric functions
7190 
7191 =for apidoc AmdR|bool|GROK_NUMERIC_RADIX|NN const char **sp|NN const char *send
7192 
7193 A synonym for L</grok_numeric_radix>
7194 
7195 =cut
7196 */
7197 #define GROK_NUMERIC_RADIX(sp, send) grok_numeric_radix(sp, send)
7198 
7199 /* Number scan flags.  All are used for input, the ones used for output are so
7200  * marked */
7201 #define PERL_SCAN_ALLOW_UNDERSCORES   0x01 /* grok_??? accept _ in numbers */
7202 #define PERL_SCAN_DISALLOW_PREFIX     0x02 /* grok_??? reject 0x in hex etc */
7203 
7204 /* grok_??? input: ignored; output: found overflow */
7205 #define PERL_SCAN_GREATER_THAN_UV_MAX 0x04
7206 
7207 /* grok_??? don't warn about illegal digits.  To preserve total backcompat,
7208  * this isn't set on output if one is found.  Instead, see
7209  * PERL_SCAN_NOTIFY_ILLDIGIT. */
7210 #define PERL_SCAN_SILENT_ILLDIGIT     0x08
7211 
7212 #define PERL_SCAN_TRAILING            0x10 /* grok_number_flags() allow trailing
7213                                               and set IS_NUMBER_TRAILING */
7214 
7215 /* These are considered experimental, so not exposed publicly */
7216 #if defined(PERL_CORE) || defined(PERL_EXT)
7217 /* grok_??? don't warn about very large numbers which are <= UV_MAX;
7218  * output: found such a number */
7219 #  define PERL_SCAN_SILENT_NON_PORTABLE 0x20
7220 
7221 /* If this is set on input, and no illegal digit is found, it will be cleared
7222  * on output; otherwise unchanged */
7223 #  define PERL_SCAN_NOTIFY_ILLDIGIT 0x40
7224 
7225 /* Don't warn on overflow; output flag still set */
7226 #  define PERL_SCAN_SILENT_OVERFLOW 0x80
7227 
7228 /* Forbid a leading underscore, which the other one doesn't */
7229 #  define PERL_SCAN_ALLOW_MEDIAL_UNDERSCORES (0x100|PERL_SCAN_ALLOW_UNDERSCORES)
7230 #endif
7231 
7232 
7233 /* to let user control profiling */
7234 #ifdef PERL_GPROF_CONTROL
7235 extern void moncontrol(int);
7236 #define PERL_GPROF_MONCONTROL(x) moncontrol(x)
7237 #else
7238 #define PERL_GPROF_MONCONTROL(x)
7239 #endif
7240 
7241 /* ISO 6429 NEL - C1 control NExt Line */
7242 /* See https://www.unicode.org/unicode/reports/tr13/ */
7243 #define NEXT_LINE_CHAR	NEXT_LINE_NATIVE
7244 
7245 #ifndef PIPESOCK_MODE
7246 #  define PIPESOCK_MODE
7247 #endif
7248 
7249 #ifndef SOCKET_OPEN_MODE
7250 #  define SOCKET_OPEN_MODE	PIPESOCK_MODE
7251 #endif
7252 
7253 #ifndef PIPE_OPEN_MODE
7254 #  define PIPE_OPEN_MODE	PIPESOCK_MODE
7255 #endif
7256 
7257 #define PERL_MAGIC_UTF8_CACHESIZE	2
7258 
7259 #define PERL_UNICODE_STDIN_FLAG			0x0001
7260 #define PERL_UNICODE_STDOUT_FLAG		0x0002
7261 #define PERL_UNICODE_STDERR_FLAG		0x0004
7262 #define PERL_UNICODE_IN_FLAG			0x0008
7263 #define PERL_UNICODE_OUT_FLAG			0x0010
7264 #define PERL_UNICODE_ARGV_FLAG			0x0020
7265 #define PERL_UNICODE_LOCALE_FLAG		0x0040
7266 #define PERL_UNICODE_WIDESYSCALLS_FLAG		0x0080 /* for Sarathy */
7267 #define PERL_UNICODE_UTF8CACHEASSERT_FLAG	0x0100
7268 
7269 #define PERL_UNICODE_STD_FLAG		\
7270 	(PERL_UNICODE_STDIN_FLAG	| \
7271 	 PERL_UNICODE_STDOUT_FLAG	| \
7272 	 PERL_UNICODE_STDERR_FLAG)
7273 
7274 #define PERL_UNICODE_INOUT_FLAG		\
7275 	(PERL_UNICODE_IN_FLAG	| \
7276 	 PERL_UNICODE_OUT_FLAG)
7277 
7278 #define PERL_UNICODE_DEFAULT_FLAGS	\
7279 	(PERL_UNICODE_STD_FLAG		| \
7280 	 PERL_UNICODE_INOUT_FLAG	| \
7281 	 PERL_UNICODE_LOCALE_FLAG)
7282 
7283 #define PERL_UNICODE_ALL_FLAGS			0x01ff
7284 
7285 #define PERL_UNICODE_STDIN			'I'
7286 #define PERL_UNICODE_STDOUT			'O'
7287 #define PERL_UNICODE_STDERR			'E'
7288 #define PERL_UNICODE_STD			'S'
7289 #define PERL_UNICODE_IN				'i'
7290 #define PERL_UNICODE_OUT			'o'
7291 #define PERL_UNICODE_INOUT			'D'
7292 #define PERL_UNICODE_ARGV			'A'
7293 #define PERL_UNICODE_LOCALE			'L'
7294 #define PERL_UNICODE_WIDESYSCALLS		'W'
7295 #define PERL_UNICODE_UTF8CACHEASSERT		'a'
7296 
7297 #define PERL_SIGNALS_UNSAFE_FLAG	0x0001
7298 
7299 /*
7300 =head1 Numeric functions
7301 
7302 =for apidoc Am|int|PERL_ABS|int
7303 
7304 Typeless C<abs> or C<fabs>, I<etc>.  (The usage below indicates it is for
7305 integers, but it works for any type.)  Use instead of these, since the C
7306 library ones force their argument to be what it is expecting, potentially
7307 leading to disaster.  But also beware that this evaluates its argument twice,
7308 so no C<x++>.
7309 
7310 =cut
7311 */
7312 
7313 #define PERL_ABS(x) ((x) < 0 ? -(x) : (x))
7314 
7315 #if defined(__DECC) && defined(__osf__)
7316 #pragma message disable (mainparm) /* Perl uses the envp in main(). */
7317 #endif
7318 
7319 #define do_open(g, n, l, a, rm, rp, sf) \
7320 	do_openn(g, n, l, a, rm, rp, sf, (SV **) NULL, 0)
7321 #ifdef PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
7322 #  define do_exec(cmd)			do_exec3(cmd,0,0)
7323 #endif
7324 #ifdef OS2
7325 #  define do_aexec			Perl_do_aexec
7326 #else
7327 #  define do_aexec(really, mark,sp)	do_aexec5(really, mark, sp, 0, 0)
7328 #endif
7329 
7330 
7331 /*
7332 =head1 Miscellaneous Functions
7333 
7334 =for apidoc Am|bool|IS_SAFE_SYSCALL|NN const char *pv|STRLEN len|NN const char *what|NN const char *op_name
7335 
7336 Same as L</is_safe_syscall>.
7337 
7338 =cut
7339 
7340 Allows one ending \0
7341 */
7342 #define IS_SAFE_SYSCALL(p, len, what, op_name) (Perl_is_safe_syscall(aTHX_ (p), (len), (what), (op_name)))
7343 
7344 #define IS_SAFE_PATHNAME(p, len, op_name) IS_SAFE_SYSCALL((p), (len), "pathname", (op_name))
7345 
7346 #if defined(OEMVS) || defined(__amigaos4__)
7347 #define NO_ENV_ARRAY_IN_MAIN
7348 #endif
7349 
7350 /* These are used by Perl_pv_escape() and Perl_pv_pretty()
7351  * are here so that they are available throughout the core
7352  * NOTE that even though some are for _escape and some for _pretty
7353  * there must not be any clashes as the flags from _pretty are
7354  * passed straight through to _escape.
7355  */
7356 
7357 #define PERL_PV_ESCAPE_QUOTE        0x000001
7358 #define PERL_PV_PRETTY_QUOTE        PERL_PV_ESCAPE_QUOTE
7359 
7360 #define PERL_PV_PRETTY_ELLIPSES     0x000002
7361 #define PERL_PV_PRETTY_LTGT         0x000004
7362 #define PERL_PV_PRETTY_EXACTSIZE    0x000008
7363 
7364 #define PERL_PV_ESCAPE_UNI          0x000100
7365 #define PERL_PV_ESCAPE_UNI_DETECT   0x000200
7366 #define PERL_PV_ESCAPE_NONASCII     0x000400
7367 #define PERL_PV_ESCAPE_FIRSTCHAR    0x000800
7368 
7369 #define PERL_PV_ESCAPE_ALL            0x001000
7370 #define PERL_PV_ESCAPE_NOBACKSLASH  0x002000
7371 #define PERL_PV_ESCAPE_NOCLEAR      0x004000
7372 #define PERL_PV_PRETTY_NOCLEAR      PERL_PV_ESCAPE_NOCLEAR
7373 #define PERL_PV_ESCAPE_RE           0x008000
7374 
7375 #define PERL_PV_ESCAPE_DWIM         0x010000
7376 
7377 
7378 /* used by pv_display in dump.c*/
7379 #define PERL_PV_PRETTY_DUMP  PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE
7380 #define PERL_PV_PRETTY_REGPROP PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_LTGT|PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII
7381 
7382 #if DOUBLEKIND == DOUBLE_IS_VAX_F_FLOAT || \
7383     DOUBLEKIND == DOUBLE_IS_VAX_D_FLOAT || \
7384     DOUBLEKIND == DOUBLE_IS_VAX_G_FLOAT
7385 #  define DOUBLE_IS_VAX_FLOAT
7386 #else
7387 #  define DOUBLE_IS_IEEE_FORMAT
7388 #endif
7389 
7390 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN || \
7391     DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN || \
7392     DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
7393 #  define DOUBLE_LITTLE_ENDIAN
7394 #endif
7395 
7396 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN || \
7397     DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN || \
7398     DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
7399 #  define DOUBLE_BIG_ENDIAN
7400 #endif
7401 
7402 #if DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE || \
7403     DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
7404 #  define DOUBLE_MIX_ENDIAN
7405 #endif
7406 
7407 /* The VAX fp formats are neither consistently little-endian nor
7408  * big-endian, and neither are they really IEEE-mixed endian like
7409  * the mixed-endian ARM IEEE formats (with swapped bytes).
7410  * Ultimately, the VAX format came from the PDP-11.
7411  *
7412  * The ordering of the parts in VAX floats is quite vexing.
7413  * In the below the fraction_n are the mantissa bits.
7414  *
7415  * The fraction_1 is the most significant (numbering as by DEC/Digital),
7416  * while the rightmost bit in each fraction is the least significant:
7417  * in other words, big-endian bit order within the fractions.
7418  *
7419  * The fraction segments themselves would be big-endianly, except that
7420  * within 32 bit segments the less significant half comes first, the more
7421  * significant after, except that in the format H (used for long doubles)
7422  * the first fraction segment is alone, because the exponent is wider.
7423  * This means for example that both the most and the least significant
7424  * bits can be in the middle of the floats, not at either end.
7425  *
7426  * References:
7427  * http://nssdc.gsfc.nasa.gov/nssdc/formats/VAXFloatingPoint.htm
7428  * http://www.quadibloc.com/comp/cp0201.htm
7429  * http://h71000.www7.hp.com/doc/82final/6443/6443pro_028.html
7430  * (somebody at HP should be fired for the URLs)
7431  *
7432  * F   fraction_2:16 sign:1 exp:8  fraction_1:7
7433  *     (exponent bias 128, hidden first one-bit)
7434  *
7435  * D   fraction_2:16 sign:1 exp:8  fraction_1:7
7436  *     fraction_4:16               fraction_3:16
7437  *     (exponent bias 128, hidden first one-bit)
7438  *
7439  * G   fraction_2:16 sign:1 exp:11 fraction_1:4
7440  *     fraction_4:16               fraction_3:16
7441  *     (exponent bias 1024, hidden first one-bit)
7442  *
7443  * H   fraction_1:16 sign:1 exp:15
7444  *     fraction_3:16               fraction_2:16
7445  *     fraction_5:16               fraction_4:16
7446  *     fraction_7:16               fraction_6:16
7447  *     (exponent bias 16384, hidden first one-bit)
7448  *     (available only on VAX, and only on Fortran?)
7449  *
7450  * The formats S, T and X are available on the Alpha (and Itanium,
7451  * also known as I64/IA64) and are equivalent with the IEEE-754 formats
7452  * binary32, binary64, and binary128 (commonly: float, double, long double).
7453  *
7454  * S   sign:1 exp:8 mantissa:23
7455  *     (exponent bias 127, hidden first one-bit)
7456  *
7457  * T   sign:1 exp:11 mantissa:52
7458  *     (exponent bias 1022, hidden first one-bit)
7459  *
7460  * X   sign:1 exp:15 mantissa:112
7461  *     (exponent bias 16382, hidden first one-bit)
7462  *
7463  */
7464 
7465 #ifdef DOUBLE_IS_VAX_FLOAT
7466 #  define DOUBLE_VAX_ENDIAN
7467 #endif
7468 
7469 #ifdef DOUBLE_IS_IEEE_FORMAT
7470 /* All the basic IEEE formats have the implicit bit,
7471  * except for the x86 80-bit extended formats, which will undef this.
7472  * Also note that the IEEE 754 subnormals (formerly known as denormals)
7473  * do not have the implicit bit of one. */
7474 #  define NV_IMPLICIT_BIT
7475 #endif
7476 
7477 #if defined(LONG_DOUBLEKIND) && LONG_DOUBLEKIND != LONG_DOUBLE_IS_DOUBLE
7478 
7479 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN || \
7480       LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
7481       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
7482 #    define LONGDOUBLE_LITTLE_ENDIAN
7483 #  endif
7484 
7485 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN || \
7486       LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN || \
7487       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
7488 #    define LONGDOUBLE_BIG_ENDIAN
7489 #  endif
7490 
7491 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
7492       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
7493 #    define LONGDOUBLE_MIX_ENDIAN
7494 #  endif
7495 
7496 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
7497       LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
7498 #    define LONGDOUBLE_X86_80_BIT
7499 #    ifdef USE_LONG_DOUBLE
7500 #      undef NV_IMPLICIT_BIT
7501 #      define NV_X86_80_BIT
7502 #    endif
7503 #  endif
7504 
7505 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE || \
7506       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE || \
7507       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
7508       LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
7509 #    define LONGDOUBLE_DOUBLEDOUBLE
7510 #  endif
7511 
7512 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_VAX_H_FLOAT
7513 #    define LONGDOUBLE_VAX_ENDIAN
7514 #  endif
7515 
7516 #endif /* LONG_DOUBLEKIND */
7517 
7518 #ifdef USE_QUADMATH /* assume quadmath endianness == native double endianness */
7519 #  if defined(DOUBLE_LITTLE_ENDIAN)
7520 #    define NV_LITTLE_ENDIAN
7521 #  elif defined(DOUBLE_BIG_ENDIAN)
7522 #    define NV_BIG_ENDIAN
7523 #  elif defined(DOUBLE_MIX_ENDIAN) /* stretch */
7524 #    define NV_MIX_ENDIAN
7525 #  endif
7526 #elif NVSIZE == DOUBLESIZE
7527 #  ifdef DOUBLE_LITTLE_ENDIAN
7528 #    define NV_LITTLE_ENDIAN
7529 #  endif
7530 #  ifdef DOUBLE_BIG_ENDIAN
7531 #    define NV_BIG_ENDIAN
7532 #  endif
7533 #  ifdef DOUBLE_MIX_ENDIAN
7534 #    define NV_MIX_ENDIAN
7535 #  endif
7536 #  ifdef DOUBLE_VAX_ENDIAN
7537 #    define NV_VAX_ENDIAN
7538 #  endif
7539 #elif NVSIZE == LONG_DOUBLESIZE
7540 #  ifdef LONGDOUBLE_LITTLE_ENDIAN
7541 #    define NV_LITTLE_ENDIAN
7542 #  endif
7543 #  ifdef LONGDOUBLE_BIG_ENDIAN
7544 #    define NV_BIG_ENDIAN
7545 #  endif
7546 #  ifdef LONGDOUBLE_MIX_ENDIAN
7547 #    define NV_MIX_ENDIAN
7548 #  endif
7549 #  ifdef LONGDOUBLE_VAX_ENDIAN
7550 #    define NV_VAX_ENDIAN
7551 #  endif
7552 #endif
7553 
7554 /* We have somehow managed not to define the denormal/subnormal
7555  * detection.
7556  *
7557  * This may happen if the compiler doesn't expose the C99 math like
7558  * the fpclassify() without some special switches.  Perl tries to
7559  * stay C89, so for example -std=c99 is not an option.
7560  *
7561  * The Perl_isinf() and Perl_isnan() should have been defined even if
7562  * the C99 isinf() and isnan() are unavailable, and the NV_MIN becomes
7563  * from the C89 DBL_MIN or moral equivalent. */
7564 #if !defined(Perl_fp_class_denorm) && defined(Perl_isinf) && defined(Perl_isnan) && defined(NV_MIN)
7565 #  define Perl_fp_class_denorm(x) ((x) != 0.0 && !Perl_isinf(x) && !Perl_isnan(x) && PERL_ABS(x) < NV_MIN)
7566 #endif
7567 
7568 /* This is not a great fallback: subnormals tests will fail,
7569  * but at least Perl will link and 99.999% of tests will work. */
7570 #if !defined(Perl_fp_class_denorm)
7571 #  define Perl_fp_class_denorm(x) FALSE
7572 #endif
7573 
7574 #ifdef DOUBLE_IS_IEEE_FORMAT
7575 #  define DOUBLE_HAS_INF
7576 #  define DOUBLE_HAS_NAN
7577 #endif
7578 
7579 #ifdef DOUBLE_HAS_NAN
7580 
7581 START_EXTERN_C
7582 
7583 #ifdef DOINIT
7584 
7585 /* PL_inf and PL_nan initialization.
7586  *
7587  * For inf and nan initialization the ultimate fallback is dividing
7588  * one or zero by zero: however, some compilers will warn or even fail
7589  * on divide-by-zero, but hopefully something earlier will work.
7590  *
7591  * If you are thinking of using HUGE_VAL for infinity, or using
7592  * <math.h> functions to generate NV_INF (e.g. exp(1e9), log(-1.0)),
7593  * stop.  Neither will work portably: HUGE_VAL can be just DBL_MAX,
7594  * and the math functions might be just generating DBL_MAX, or even zero.
7595  *
7596  * Also, do NOT try doing NV_NAN based on NV_INF and trying (NV_INF-NV_INF).
7597  * Though logically correct, some compilers (like Visual C 2003)
7598  * falsely misoptimize that to zero (x-x is always zero, right?)
7599  *
7600  * Finally, note that not all floating point formats define Inf (or NaN).
7601  * For the infinity a large number may be used instead.  Operations that
7602  * under the IEEE floating point would return Inf or NaN may return
7603  * either large numbers (positive or negative), or they may cause
7604  * a floating point exception or some other fault.
7605  */
7606 
7607 /* The quadmath literals are anon structs which -Wc++-compat doesn't like. */
7608 #  ifndef USE_CPLUSPLUS
7609 GCC_DIAG_IGNORE_DECL(-Wc++-compat);
7610 #  endif
7611 
7612 #  ifdef USE_QUADMATH
7613 /* Cannot use HUGE_VALQ for PL_inf because not a compile-time
7614  * constant. */
7615 INFNAN_NV_U8_DECL PL_inf = { 1.0Q/0.0Q };
7616 #  elif NVSIZE == LONG_DOUBLESIZE && defined(LONGDBLINFBYTES)
7617 INFNAN_U8_NV_DECL PL_inf = { { LONGDBLINFBYTES } };
7618 #  elif NVSIZE == DOUBLESIZE && defined(DOUBLEINFBYTES)
7619 INFNAN_U8_NV_DECL PL_inf = { { DOUBLEINFBYTES } };
7620 #  else
7621 #    if NVSIZE == LONG_DOUBLESIZE && defined(USE_LONG_DOUBLE)
7622 #      if defined(LDBL_INFINITY)
7623 INFNAN_NV_U8_DECL PL_inf = { LDBL_INFINITY };
7624 #      elif defined(LDBL_INF)
7625 INFNAN_NV_U8_DECL PL_inf = { LDBL_INF };
7626 #      elif defined(INFINITY)
7627 INFNAN_NV_U8_DECL PL_inf = { (NV)INFINITY };
7628 #      elif defined(INF)
7629 INFNAN_NV_U8_DECL PL_inf = { (NV)INF };
7630 #      else
7631 INFNAN_NV_U8_DECL PL_inf = { 1.0L/0.0L }; /* keep last */
7632 #      endif
7633 #    else
7634 #      if defined(DBL_INFINITY)
7635 INFNAN_NV_U8_DECL PL_inf = { DBL_INFINITY };
7636 #      elif defined(DBL_INF)
7637 INFNAN_NV_U8_DECL PL_inf = { DBL_INF };
7638 #      elif defined(INFINITY) /* C99 */
7639 INFNAN_NV_U8_DECL PL_inf = { (NV)INFINITY };
7640 #      elif defined(INF)
7641 INFNAN_NV_U8_DECL PL_inf = { (NV)INF };
7642 #      else
7643 INFNAN_NV_U8_DECL PL_inf = { 1.0/0.0 }; /* keep last */
7644 #      endif
7645 #    endif
7646 #  endif
7647 
7648 #  ifdef USE_QUADMATH
7649 /* Cannot use nanq("0") for PL_nan because not a compile-time
7650  * constant. */
7651 INFNAN_NV_U8_DECL PL_nan = { 0.0Q/0.0Q };
7652 #  elif NVSIZE == LONG_DOUBLESIZE && defined(LONGDBLNANBYTES)
7653 INFNAN_U8_NV_DECL PL_nan = { { LONGDBLNANBYTES } };
7654 #  elif NVSIZE == DOUBLESIZE && defined(DOUBLENANBYTES)
7655 INFNAN_U8_NV_DECL PL_nan = { { DOUBLENANBYTES } };
7656 #  else
7657 #    if NVSIZE == LONG_DOUBLESIZE && defined(USE_LONG_DOUBLE)
7658 #      if defined(LDBL_NAN)
7659 INFNAN_NV_U8_DECL PL_nan = { LDBL_NAN };
7660 #      elif defined(LDBL_QNAN)
7661 INFNAN_NV_U8_DECL PL_nan = { LDBL_QNAN };
7662 #      elif defined(NAN)
7663 INFNAN_NV_U8_DECL PL_nan = { (NV)NAN };
7664 #      else
7665 INFNAN_NV_U8_DECL PL_nan = { 0.0L/0.0L }; /* keep last */
7666 #      endif
7667 #    else
7668 #      if defined(DBL_NAN)
7669 INFNAN_NV_U8_DECL PL_nan = { DBL_NAN };
7670 #      elif defined(DBL_QNAN)
7671 INFNAN_NV_U8_DECL PL_nan = { DBL_QNAN };
7672 #      elif defined(NAN) /* C99 */
7673 INFNAN_NV_U8_DECL PL_nan = { (NV)NAN };
7674 #      else
7675 INFNAN_NV_U8_DECL PL_nan = { 0.0/0.0 }; /* keep last */
7676 #      endif
7677 #    endif
7678 #  endif
7679 
7680 #  ifndef USE_CPLUSPLUS
7681 GCC_DIAG_RESTORE_DECL;
7682 #  endif
7683 
7684 #else
7685 
7686 INFNAN_NV_U8_DECL PL_inf;
7687 INFNAN_NV_U8_DECL PL_nan;
7688 
7689 #endif
7690 
7691 END_EXTERN_C
7692 
7693 /* If you have not defined NV_INF/NV_NAN (like for example win32/win32.h),
7694  * we will define NV_INF/NV_NAN as the nv part of the global const
7695  * PL_inf/PL_nan.  Note, however, that the preexisting NV_INF/NV_NAN
7696  * might not be a compile-time constant, in which case it cannot be
7697  * used to initialize PL_inf/PL_nan above. */
7698 #ifndef NV_INF
7699 #  define NV_INF PL_inf.nv
7700 #endif
7701 #ifndef NV_NAN
7702 #  define NV_NAN PL_nan.nv
7703 #endif
7704 
7705 /* NaNs (not-a-numbers) can carry payload bits, in addition to
7706  * "nan-ness".  Part of the payload is the quiet/signaling bit.
7707  * To back up a bit (harhar):
7708  *
7709  * For IEEE 754 64-bit formats [1]:
7710  *
7711  * s 000 (mantissa all-zero)  zero
7712  * s 000 (mantissa non-zero)  subnormals (denormals)
7713  * s 001 ... 7fe              normals
7714  * s 7ff q                    nan
7715  *
7716  * For IEEE 754 128-bit formats:
7717  *
7718  * s 0000 (mantissa all-zero)  zero
7719  * s 0000 (mantissa non-zero)  subnormals (denormals)
7720  * s 0001 ... 7ffe             normals
7721  * s 7fff q                    nan
7722  *
7723  * [1] this looks like big-endian, but applies equally to little-endian.
7724  *
7725  * s = Sign bit.  Yes, zeros and nans can have negative sign,
7726  *     the interpretation is application-specific.
7727  *
7728  * q = Quietness bit, the interpretation is platform-specific.
7729  *     Most platforms have the most significant bit being one
7730  *     meaning quiet, but some (older mips, hppa) have the msb
7731  *     being one meaning signaling.  Note that the above means
7732  *     that on most platforms there cannot be signaling nan with
7733  *     zero payload because that is identical with infinity;
7734  *     while conversely on older mips/hppa there cannot be a quiet nan
7735  *     because that is identical with infinity.
7736  *
7737  *     Moreover, whether there is any behavioral difference
7738  *     between quiet and signaling NaNs, depends on the platform.
7739  *
7740  * x86 80-bit extended precision is different, the mantissa bits:
7741  *
7742  * 63 62 61   30387+    pre-387    visual c
7743  * --------   ----      --------   --------
7744  *  0  0  0   invalid   infinity
7745  *  0  0  1   invalid   snan
7746  *  0  1  0   invalid   snan
7747  *  0  1  1   invalid   snan
7748  *  1  0  0   infinity  snan        1.#INF
7749  *  1  0  1   snan                  1.#SNAN
7750  *  1  1  0   qnan                 -1.#IND  (x86 chooses this to negative)
7751  *  1  1  1   qnan                  1.#QNAN
7752  *
7753  * This means that in this format there are 61 bits available
7754  * for the nan payload.
7755  *
7756  * Note that the 32-bit x86 ABI cannot do signaling nans: the x87
7757  * simply cannot preserve the bit.  You can either use the 80-bit
7758  * extended precision (long double, -Duselongdouble), or use x86-64.
7759  *
7760  * In all platforms, the payload bytes (and bits, some of them are
7761  * often in a partial byte) themselves can be either all zero (x86),
7762  * all one (sparc or mips), or a mixture: in IEEE 754 128-bit double
7763  * or in a double-double, the first half of the payload can follow the
7764  * native double, while in the second half the payload can be all
7765  * zeros.  (Therefore the mask for payload bits is not necessarily
7766  * identical to bit complement of the NaN.)  Another way of putting
7767  * this: the payload for the default NaN might not be zero.
7768  *
7769  * For the x86 80-bit long doubles, the trailing bytes (the 80 bits
7770  * being 'packaged' in either 12 or 16 bytes) can be whatever random
7771  * garbage.
7772  *
7773  * Furthermore, the semantics of the sign bit on NaNs are platform-specific.
7774  * On normal floats, the sign bit being on means negative.  But this may,
7775  * or may not, be reverted on NaNs: in other words, the default NaN might
7776  * have the sign bit on, and therefore look like negative if you look
7777  * at it at the bit level.
7778  *
7779  * NaN payloads are not propagated even on copies, or in arithmetics.
7780  * They *might* be, according to some rules, on your particular
7781  * cpu/os/compiler/libraries, but no guarantees.
7782  *
7783  * To summarize, on most platforms, and for 64-bit doubles
7784  * (using big-endian ordering here):
7785  *
7786  * [7FF8000000000000..7FFFFFFFFFFFFFFF] quiet
7787  * [FFF8000000000000..FFFFFFFFFFFFFFFF] quiet
7788  * [7FF0000000000001..7FF7FFFFFFFFFFFF] signaling
7789  * [FFF0000000000001..FFF7FFFFFFFFFFFF] signaling
7790  *
7791  * The C99 nan() is supposed to generate *quiet* NaNs.
7792  *
7793  * Note the asymmetry:
7794  * The 7FF0000000000000 is positive infinity,
7795  * the FFF0000000000000 is negative infinity.
7796  */
7797 
7798 /* NVMANTBITS is the number of _real_ mantissa bits in an NV.
7799  * For the standard IEEE 754 fp this number is usually one less that
7800  * *DBL_MANT_DIG because of the implicit (aka hidden) bit, which isn't
7801  * real.  For the 80-bit extended precision formats (x86*), the number
7802  * of mantissa bits... depends. For normal floats, it's 64.  But for
7803  * the inf/nan, it's different (zero for inf, 61 for nan).
7804  * NVMANTBITS works for normal floats. */
7805 
7806 /* We do not want to include the quiet/signaling bit. */
7807 #define NV_NAN_BITS (NVMANTBITS - 1)
7808 
7809 #if defined(USE_LONG_DOUBLE) && NVSIZE > DOUBLESIZE
7810 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
7811 #    define NV_NAN_QS_BYTE_OFFSET 13
7812 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
7813 #    define NV_NAN_QS_BYTE_OFFSET 2
7814 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN
7815 #    define NV_NAN_QS_BYTE_OFFSET 7
7816 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
7817 #    define NV_NAN_QS_BYTE_OFFSET 2
7818 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
7819 #    define NV_NAN_QS_BYTE_OFFSET 13
7820 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
7821 #    define NV_NAN_QS_BYTE_OFFSET 1
7822 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE
7823 #    define NV_NAN_QS_BYTE_OFFSET 9
7824 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
7825 #    define NV_NAN_QS_BYTE_OFFSET 6
7826 #  else
7827 #    error "Unexpected long double format"
7828 #  endif
7829 #else
7830 #  ifdef USE_QUADMATH
7831 #    ifdef NV_LITTLE_ENDIAN
7832 #      define NV_NAN_QS_BYTE_OFFSET 13
7833 #    elif defined(NV_BIG_ENDIAN)
7834 #      define NV_NAN_QS_BYTE_OFFSET 2
7835 #    else
7836 #      error "Unexpected quadmath format"
7837 #    endif
7838 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN
7839 #    define NV_NAN_QS_BYTE_OFFSET 2
7840 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN
7841 #    define NV_NAN_QS_BYTE_OFFSET 1
7842 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN
7843 #    define NV_NAN_QS_BYTE_OFFSET 6
7844 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN
7845 #    define NV_NAN_QS_BYTE_OFFSET 1
7846 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
7847 #    define NV_NAN_QS_BYTE_OFFSET 13
7848 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
7849 #    define NV_NAN_QS_BYTE_OFFSET 2
7850 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE
7851 #    define NV_NAN_QS_BYTE_OFFSET 2 /* bytes 4 5 6 7 0 1 2 3 (MSB 7) */
7852 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
7853 #    define NV_NAN_QS_BYTE_OFFSET 5 /* bytes 3 2 1 0 7 6 5 4 (MSB 7) */
7854 #  else
7855 /* For example the VAX formats should never
7856  * get here because they do not have NaN. */
7857 #    error "Unexpected double format"
7858 #  endif
7859 #endif
7860 /* NV_NAN_QS_BYTE is the byte to test for the quiet/signaling */
7861 #define NV_NAN_QS_BYTE(nvp) (((U8*)(nvp))[NV_NAN_QS_BYTE_OFFSET])
7862 /* NV_NAN_QS_BIT is the bit to test in the NV_NAN_QS_BYTE_OFFSET
7863  * for the quiet/signaling */
7864 #if defined(USE_LONG_DOUBLE) && \
7865   (LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN || \
7866    LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN)
7867 #  define NV_NAN_QS_BIT_SHIFT 6 /* 0x40 */
7868 #elif defined(USE_LONG_DOUBLE) && \
7869   (LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE || \
7870    LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE || \
7871    LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE || \
7872    LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE)
7873 #  define NV_NAN_QS_BIT_SHIFT 3 /* 0x08, but not via NV_NAN_BITS */
7874 #else
7875 #  define NV_NAN_QS_BIT_SHIFT ((NV_NAN_BITS) % 8) /* usually 3, or 0x08 */
7876 #endif
7877 #define NV_NAN_QS_BIT (1 << (NV_NAN_QS_BIT_SHIFT))
7878 /* NV_NAN_QS_BIT_OFFSET is the bit offset from the beginning of a NV
7879  * (bytes ordered big-endianly) for the quiet/signaling bit
7880  * for the quiet/signaling */
7881 #define NV_NAN_QS_BIT_OFFSET \
7882     (8 * (NV_NAN_QS_BYTE_OFFSET) + (NV_NAN_QS_BIT_SHIFT))
7883 /* NV_NAN_QS_QUIET (always defined) is true if the NV_NAN_QS_QS_BIT being
7884  * on indicates quiet NaN.  NV_NAN_QS_SIGNALING (also always defined)
7885  * is true if the NV_NAN_QS_BIT being on indicates signaling NaN. */
7886 #define NV_NAN_QS_QUIET \
7887     ((NV_NAN_QS_BYTE(PL_nan.u8) & NV_NAN_QS_BIT) == NV_NAN_QS_BIT)
7888 #define NV_NAN_QS_SIGNALING (!(NV_NAN_QS_QUIET))
7889 #define NV_NAN_QS_TEST(nvp) (NV_NAN_QS_BYTE(nvp) & NV_NAN_QS_BIT)
7890 /* NV_NAN_IS_QUIET() returns true if the NV behind nvp is a NaN,
7891  * whether it is a quiet NaN, NV_NAN_IS_SIGNALING() if a signaling NaN.
7892  * Note however that these do not check whether the nvp is a NaN. */
7893 #define NV_NAN_IS_QUIET(nvp) \
7894     (NV_NAN_QS_TEST(nvp) == (NV_NAN_QS_QUIET ? NV_NAN_QS_BIT : 0))
7895 #define NV_NAN_IS_SIGNALING(nvp) \
7896     (NV_NAN_QS_TEST(nvp) == (NV_NAN_QS_QUIET ? 0 : NV_NAN_QS_BIT))
7897 #define NV_NAN_SET_QUIET(nvp) \
7898     (NV_NAN_QS_QUIET ? \
7899      (NV_NAN_QS_BYTE(nvp) |= NV_NAN_QS_BIT) : \
7900      (NV_NAN_QS_BYTE(nvp) &= ~NV_NAN_QS_BIT))
7901 #define NV_NAN_SET_SIGNALING(nvp) \
7902     (NV_NAN_QS_QUIET ? \
7903      (NV_NAN_QS_BYTE(nvp) &= ~NV_NAN_QS_BIT) : \
7904      (NV_NAN_QS_BYTE(nvp) |= NV_NAN_QS_BIT))
7905 #define NV_NAN_QS_XOR(nvp) (NV_NAN_QS_BYTE(nvp) ^= NV_NAN_QS_BIT)
7906 
7907 /* NV_NAN_PAYLOAD_MASK: masking the nan payload bits.
7908  *
7909  * NV_NAN_PAYLOAD_PERM: permuting the nan payload bytes.
7910  * 0xFF means "don't go here".*/
7911 
7912 /* Shorthands to avoid typoses. */
7913 #define NV_NAN_PAYLOAD_MASK_SKIP_EIGHT \
7914   0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0
7915 #define NV_NAN_PAYLOAD_PERM_SKIP_EIGHT \
7916   0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
7917 #define NV_NAN_PAYLOAD_PERM_0_TO_7 \
7918   0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7
7919 #define NV_NAN_PAYLOAD_PERM_7_TO_0 \
7920   0x7, 0x6, 0x5, 0x4, 0x3, 0x2, 0x1, 0x0
7921 #define NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE \
7922   0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
7923   0xff, 0xff, 0xff, 0xff, 0xff, 0x7f, 0x00, 0x00
7924 #define NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE \
7925   NV_NAN_PAYLOAD_PERM_0_TO_7, \
7926   0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xFF, 0xFF
7927 #define NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE \
7928   0x00, 0x00, 0x7f, 0xff, 0xff, 0xff, 0xff, 0xff, \
7929   0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
7930 #define NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE \
7931   0xFF, 0xFF, 0xd, 0xc, 0xb, 0xa, 0x9, 0x8, \
7932   NV_NAN_PAYLOAD_PERM_7_TO_0
7933 #define NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE \
7934   0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x07, 0x00
7935 #define NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE \
7936   0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0xFF
7937 #define NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE \
7938   0x00, 0x07, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
7939 #define NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE \
7940   0xFF, 0x6, 0x5, 0x4, 0x3, 0x2, 0x1, 0x0
7941 
7942 #if defined(USE_LONG_DOUBLE) && NVSIZE > DOUBLESIZE
7943 #  if LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
7944 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
7945 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
7946 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
7947 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
7948 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
7949 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_LITTLE_ENDIAN
7950 #    if LONG_DOUBLESIZE == 10
7951 #      define NV_NAN_PAYLOAD_MASK \
7952          0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
7953          0x00, 0x00
7954 #      define NV_NAN_PAYLOAD_PERM \
7955          NV_NAN_PAYLOAD_PERM_0_TO_7, 0xFF, 0xFF
7956 #    elif LONG_DOUBLESIZE == 12
7957 #      define NV_NAN_PAYLOAD_MASK \
7958          0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
7959          0x00, 0x00, 0x00, 0x00
7960 #      define NV_NAN_PAYLOAD_PERM \
7961          NV_NAN_PAYLOAD_PERM_0_TO_7, 0xFF, 0xFF, 0xFF, 0xFF
7962 #    elif LONG_DOUBLESIZE == 16
7963 #      define NV_NAN_PAYLOAD_MASK \
7964          0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, \
7965          0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
7966 #      define NV_NAN_PAYLOAD_PERM \
7967          NV_NAN_PAYLOAD_PERM_0_TO_7, \
7968          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
7969 #    else
7970 #      error "Unexpected x86 80-bit little-endian long double format"
7971 #    endif
7972 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_X86_80_BIT_BIG_ENDIAN
7973 #    if LONG_DOUBLESIZE == 10
7974 #      define NV_NAN_PAYLOAD_MASK \
7975          0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
7976          0xff, 0xff
7977 #      define NV_NAN_PAYLOAD_PERM \
7978          NV_NAN_PAYLOAD_PERM_7_TO_0, 0xFF, 0xFF
7979 #    elif LONG_DOUBLESIZE == 12
7980 #      define NV_NAN_PAYLOAD_MASK \
7981          0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
7982          0xff, 0xff, 0x00, 0x00
7983 #      define NV_NAN_PAYLOAD_PERM \
7984          NV_NAN_PAYLOAD_PERM_7_TO_0, 0xFF, 0xFF, 0xFF, 0xFF
7985 #    elif LONG_DOUBLESIZE == 16
7986 #      define NV_NAN_PAYLOAD_MASK \
7987          0x00, 0x00, 0x1f, 0xff, 0xff, 0xff, 0xff, 0xff, \
7988          0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
7989 #      define NV_NAN_PAYLOAD_PERM \
7990          NV_NAN_PAYLOAD_PERM_7_TO_0, \
7991          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
7992 #    else
7993 #      error "Unexpected x86 80-bit big-endian long double format"
7994 #    endif
7995 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_LE
7996 /* For double-double we assume only the first double (in LE or BE terms)
7997  * is used for NaN. */
7998 #    define NV_NAN_PAYLOAD_MASK \
7999        NV_NAN_PAYLOAD_MASK_SKIP_EIGHT, NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
8000 #    define NV_NAN_PAYLOAD_PERM \
8001        NV_NAN_PAYLOAD_PERM_SKIP_EIGHT, NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
8002 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_BE
8003 #    define NV_NAN_PAYLOAD_MASK \
8004        NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
8005 #    define NV_NAN_PAYLOAD_PERM \
8006        NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
8007 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_LE_BE
8008 #    define NV_NAN_PAYLOAD_MASK \
8009        NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
8010 #    define NV_NAN_PAYLOAD_PERM \
8011        NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
8012 #  elif LONG_DOUBLEKIND == LONG_DOUBLE_IS_DOUBLEDOUBLE_128_BIT_BE_LE
8013 #    define NV_NAN_PAYLOAD_MASK \
8014        NV_NAN_PAYLOAD_MASK_SKIP_EIGHT, NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
8015 #    define NV_NAN_PAYLOAD_PERM \
8016        NV_NAN_PAYLOAD_PERM_SKIP_EIGHT, NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
8017 #  else
8018 #    error "Unexpected long double format"
8019 #  endif
8020 #else
8021 #  ifdef USE_QUADMATH /* quadmath is not long double */
8022 #    ifdef NV_LITTLE_ENDIAN
8023 #      define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
8024 #      define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
8025 #    elif defined(NV_BIG_ENDIAN)
8026 #      define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
8027 #      define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
8028 #    else
8029 #      error "Unexpected quadmath format"
8030 #    endif
8031 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_LITTLE_ENDIAN
8032 #    define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0x07, 0x00
8033 #    define NV_NAN_PAYLOAD_PERM 0x0, 0x1, 0x2, 0xFF
8034 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_32_BIT_BIG_ENDIAN
8035 #    define NV_NAN_PAYLOAD_MASK 0x00, 0x07, 0xff, 0xff
8036 #    define NV_NAN_PAYLOAD_PERM 0xFF, 0x2, 0x1, 0x0
8037 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_LITTLE_ENDIAN
8038 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_64_LE
8039 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_64_LE
8040 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_BIG_ENDIAN
8041 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_64_BE
8042 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_64_BE
8043 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_LITTLE_ENDIAN
8044 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_LE
8045 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_LE
8046 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_128_BIT_BIG_ENDIAN
8047 #    define NV_NAN_PAYLOAD_MASK NV_NAN_PAYLOAD_MASK_IEEE_754_128_BE
8048 #    define NV_NAN_PAYLOAD_PERM NV_NAN_PAYLOAD_PERM_IEEE_754_128_BE
8049 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_LE_BE
8050 #    define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0x07, 0x00, 0xff, 0xff, 0xff, 0xff
8051 #    define NV_NAN_PAYLOAD_PERM 0x4, 0x5, 0x6, 0xFF, 0x0, 0x1, 0x2, 0x3
8052 #  elif DOUBLEKIND == DOUBLE_IS_IEEE_754_64_BIT_MIXED_ENDIAN_BE_LE
8053 #    define NV_NAN_PAYLOAD_MASK 0xff, 0xff, 0xff, 0xff, 0x00, 0x07, 0xff, 0xff
8054 #    define NV_NAN_PAYLOAD_PERM 0x3, 0x2, 0x1, 0x0, 0xFF, 0x6, 0x5, 0x4
8055 #  else
8056 #    error "Unexpected double format"
8057 #  endif
8058 #endif
8059 
8060 #endif /* DOUBLE_HAS_NAN */
8061 
8062 
8063 /*
8064 
8065    (KEEP THIS LAST IN perl.h!)
8066 
8067    Mention
8068 
8069    NV_PRESERVES_UV
8070 
8071    HAS_MKSTEMP
8072    HAS_MKSTEMPS
8073    HAS_MKDTEMP
8074 
8075    HAS_GETCWD
8076 
8077    HAS_MMAP
8078    HAS_MPROTECT
8079    HAS_MSYNC
8080    HAS_MADVISE
8081    HAS_MUNMAP
8082    I_SYSMMAN
8083    Mmap_t
8084 
8085    NVef
8086    NVff
8087    NVgf
8088 
8089    HAS_UALARM
8090    HAS_USLEEP
8091 
8092    HAS_SETITIMER
8093    HAS_GETITIMER
8094 
8095    HAS_SENDMSG
8096    HAS_RECVMSG
8097    HAS_READV
8098    HAS_WRITEV
8099    I_SYSUIO
8100    HAS_STRUCT_MSGHDR
8101    HAS_STRUCT_CMSGHDR
8102 
8103    HAS_NL_LANGINFO
8104 
8105    HAS_DIRFD
8106 
8107    so that Configure picks them up.
8108 
8109    (KEEP THIS LAST IN perl.h!)
8110 
8111 */
8112 
8113 #endif /* Include guard */
8114 
8115 /*
8116  * ex: set ts=8 sts=4 sw=4 et:
8117  */
8118