3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
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.
12 * 'Very useful, no doubt, that was to Saruman; yet it seems that he was
13 * not content.' --Gandalf to Pippin
15 * [p.598 of _The Lord of the Rings_, III/xi: "The PalantÃr"]
18 /* This file contains assorted utility routines.
19 * Which is a polite way of saying any stuff that people couldn't think of
20 * a better place for. Amongst other things, it includes the warning and
21 * dieing stuff, plus wrappers for malloc code.
25 #define PERL_IN_UTIL_C
29 #if defined(USE_PERLIO)
30 #include "perliol.h" /* For PerlIOUnix_refcnt */
36 # define SIG_ERR ((Sighandler_t) -1)
44 /* Missing protos on LynxOS */
49 # include "amigaos4/amigaio.h"
54 # include <sys/select.h>
58 #ifdef USE_C_BACKTRACE
62 # undef USE_BFD /* BFD is useless in OS X. */
72 # include <execinfo.h>
76 #ifdef PERL_DEBUG_READONLY_COW
77 # include <sys/mman.h>
82 /* NOTE: Do not call the next three routines directly. Use the macros
83 * in handy.h, so that we can easily redefine everything to do tracking of
84 * allocated hunks back to the original New to track down any memory leaks.
85 * XXX This advice seems to be widely ignored :-( --AD August 1996.
88 #if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
89 # define ALWAYS_NEED_THX
92 #if defined(PERL_TRACK_MEMPOOL) && defined(PERL_DEBUG_READONLY_COW)
94 S_maybe_protect_rw(pTHX_ struct perl_memory_debug_header *header)
97 && mprotect(header, header->size, PROT_READ|PROT_WRITE))
98 Perl_warn(aTHX_ "mprotect for COW string %p %lu failed with %d",
99 header, header->size, errno);
103 S_maybe_protect_ro(pTHX_ struct perl_memory_debug_header *header)
106 && mprotect(header, header->size, PROT_READ))
107 Perl_warn(aTHX_ "mprotect RW for COW string %p %lu failed with %d",
108 header, header->size, errno);
110 # define maybe_protect_rw(foo) S_maybe_protect_rw(aTHX_ foo)
111 # define maybe_protect_ro(foo) S_maybe_protect_ro(aTHX_ foo)
113 # define maybe_protect_rw(foo) NOOP
114 # define maybe_protect_ro(foo) NOOP
117 #if defined(PERL_TRACK_MEMPOOL) || defined(PERL_DEBUG_READONLY_COW)
118 /* Use memory_debug_header */
120 # if (defined(PERL_POISON) && defined(PERL_TRACK_MEMPOOL)) \
121 || defined(PERL_DEBUG_READONLY_COW)
122 # define MDH_HAS_SIZE
126 /* paranoid version of system's malloc() */
129 Perl_safesysmalloc(MEM_SIZE size)
131 #ifdef ALWAYS_NEED_THX
137 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
139 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
142 if ((SSize_t)size < 0)
143 Perl_croak_nocontext("panic: malloc, size=%" UVuf, (UV) size);
145 if (!size) size = 1; /* malloc(0) is NASTY on our system */
146 #ifdef PERL_DEBUG_READONLY_COW
147 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
148 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
149 perror("mmap failed");
153 ptr = (Malloc_t)PerlMem_malloc(size?size:1);
155 PERL_ALLOC_CHECK(ptr);
158 struct perl_memory_debug_header *const header
159 = (struct perl_memory_debug_header *)ptr;
163 PoisonNew(((char *)ptr), size, char);
166 #ifdef PERL_TRACK_MEMPOOL
167 header->interpreter = aTHX;
168 /* Link us into the list. */
169 header->prev = &PL_memory_debug_header;
170 header->next = PL_memory_debug_header.next;
171 PL_memory_debug_header.next = header;
172 maybe_protect_rw(header->next);
173 header->next->prev = header;
174 maybe_protect_ro(header->next);
175 # ifdef PERL_DEBUG_READONLY_COW
176 header->readonly = 0;
182 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
183 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
191 #ifndef ALWAYS_NEED_THX
203 /* paranoid version of system's realloc() */
206 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
208 #ifdef ALWAYS_NEED_THX
212 #ifdef PERL_DEBUG_READONLY_COW
213 const MEM_SIZE oldsize = where
214 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
223 ptr = safesysmalloc(size);
227 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
228 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
230 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
232 struct perl_memory_debug_header *const header
233 = (struct perl_memory_debug_header *)where;
235 # ifdef PERL_TRACK_MEMPOOL
236 if (header->interpreter != aTHX) {
237 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
238 header->interpreter, aTHX);
240 assert(header->next->prev == header);
241 assert(header->prev->next == header);
243 if (header->size > size) {
244 const MEM_SIZE freed_up = header->size - size;
245 char *start_of_freed = ((char *)where) + size;
246 PoisonFree(start_of_freed, freed_up, char);
256 if ((SSize_t)size < 0)
257 Perl_croak_nocontext("panic: realloc, size=%" UVuf, (UV)size);
259 #ifdef PERL_DEBUG_READONLY_COW
260 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
261 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
262 perror("mmap failed");
265 Copy(where,ptr,oldsize < size ? oldsize : size,char);
266 if (munmap(where, oldsize)) {
267 perror("munmap failed");
271 ptr = (Malloc_t)PerlMem_realloc(where,size);
273 PERL_ALLOC_CHECK(ptr);
275 /* MUST do this fixup first, before doing ANYTHING else, as anything else
276 might allocate memory/free/move memory, and until we do the fixup, it
277 may well be chasing (and writing to) free memory. */
279 #ifdef PERL_TRACK_MEMPOOL
280 struct perl_memory_debug_header *const header
281 = (struct perl_memory_debug_header *)ptr;
284 if (header->size < size) {
285 const MEM_SIZE fresh = size - header->size;
286 char *start_of_fresh = ((char *)ptr) + size;
287 PoisonNew(start_of_fresh, fresh, char);
291 maybe_protect_rw(header->next);
292 header->next->prev = header;
293 maybe_protect_ro(header->next);
294 maybe_protect_rw(header->prev);
295 header->prev->next = header;
296 maybe_protect_ro(header->prev);
298 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
301 /* In particular, must do that fixup above before logging anything via
302 *printf(), as it can reallocate memory, which can cause SEGVs. */
304 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
305 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
312 #ifndef ALWAYS_NEED_THX
325 /* safe version of system's free() */
328 Perl_safesysfree(Malloc_t where)
330 #ifdef ALWAYS_NEED_THX
333 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
336 Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
338 struct perl_memory_debug_header *const header
339 = (struct perl_memory_debug_header *)where_intrn;
342 const MEM_SIZE size = header->size;
344 # ifdef PERL_TRACK_MEMPOOL
345 if (header->interpreter != aTHX) {
346 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
347 header->interpreter, aTHX);
350 Perl_croak_nocontext("panic: duplicate free");
353 Perl_croak_nocontext("panic: bad free, header->next==NULL");
354 if (header->next->prev != header || header->prev->next != header) {
355 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
356 "header=%p, ->prev->next=%p",
357 header->next->prev, header,
360 /* Unlink us from the chain. */
361 maybe_protect_rw(header->next);
362 header->next->prev = header->prev;
363 maybe_protect_ro(header->next);
364 maybe_protect_rw(header->prev);
365 header->prev->next = header->next;
366 maybe_protect_ro(header->prev);
367 maybe_protect_rw(header);
369 PoisonNew(where_intrn, size, char);
371 /* Trigger the duplicate free warning. */
374 # ifdef PERL_DEBUG_READONLY_COW
375 if (munmap(where_intrn, size)) {
376 perror("munmap failed");
382 Malloc_t where_intrn = where;
384 #ifndef PERL_DEBUG_READONLY_COW
385 PerlMem_free(where_intrn);
390 /* safe version of system's calloc() */
393 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
395 #ifdef ALWAYS_NEED_THX
399 #if defined(USE_MDH) || defined(DEBUGGING)
400 MEM_SIZE total_size = 0;
403 /* Even though calloc() for zero bytes is strange, be robust. */
404 if (size && (count <= MEM_SIZE_MAX / size)) {
405 #if defined(USE_MDH) || defined(DEBUGGING)
406 total_size = size * count;
412 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
413 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
418 if ((SSize_t)size < 0 || (SSize_t)count < 0)
419 Perl_croak_nocontext("panic: calloc, size=%" UVuf ", count=%" UVuf,
420 (UV)size, (UV)count);
422 #ifdef PERL_DEBUG_READONLY_COW
423 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
424 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
425 perror("mmap failed");
428 #elif defined(PERL_TRACK_MEMPOOL)
429 /* Have to use malloc() because we've added some space for our tracking
431 /* malloc(0) is non-portable. */
432 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
434 /* Use calloc() because it might save a memset() if the memory is fresh
435 and clean from the OS. */
437 ptr = (Malloc_t)PerlMem_calloc(count, size);
438 else /* calloc(0) is non-portable. */
439 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
441 PERL_ALLOC_CHECK(ptr);
442 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) calloc %ld x %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)count,(long)total_size));
446 struct perl_memory_debug_header *const header
447 = (struct perl_memory_debug_header *)ptr;
449 # ifndef PERL_DEBUG_READONLY_COW
450 memset((void*)ptr, 0, total_size);
452 # ifdef PERL_TRACK_MEMPOOL
453 header->interpreter = aTHX;
454 /* Link us into the list. */
455 header->prev = &PL_memory_debug_header;
456 header->next = PL_memory_debug_header.next;
457 PL_memory_debug_header.next = header;
458 maybe_protect_rw(header->next);
459 header->next->prev = header;
460 maybe_protect_ro(header->next);
461 # ifdef PERL_DEBUG_READONLY_COW
462 header->readonly = 0;
466 header->size = total_size;
468 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
474 #ifndef ALWAYS_NEED_THX
483 /* These must be defined when not using Perl's malloc for binary
488 Malloc_t Perl_malloc (MEM_SIZE nbytes)
490 #ifdef PERL_IMPLICIT_SYS
493 return (Malloc_t)PerlMem_malloc(nbytes);
496 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
498 #ifdef PERL_IMPLICIT_SYS
501 return (Malloc_t)PerlMem_calloc(elements, size);
504 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
506 #ifdef PERL_IMPLICIT_SYS
509 return (Malloc_t)PerlMem_realloc(where, nbytes);
512 Free_t Perl_mfree (Malloc_t where)
514 #ifdef PERL_IMPLICIT_SYS
522 /* copy a string up to some (non-backslashed) delimiter, if any.
523 * With allow_escape, converts \<delimiter> to <delimiter>, while leaves
524 * \<non-delimiter> as-is.
525 * Returns the position in the src string of the closing delimiter, if
526 * any, or returns fromend otherwise.
527 * This is the internal implementation for Perl_delimcpy and
528 * Perl_delimcpy_no_escape.
532 S_delimcpy_intern(char *to, const char *toend, const char *from,
533 const char *fromend, int delim, I32 *retlen,
534 const bool allow_escape)
538 PERL_ARGS_ASSERT_DELIMCPY;
540 for (tolen = 0; from < fromend; from++, tolen++) {
541 if (allow_escape && *from == '\\' && from + 1 < fromend) {
542 if (from[1] != delim) {
549 else if (*from == delim)
561 Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
563 PERL_ARGS_ASSERT_DELIMCPY;
565 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 1);
569 Perl_delimcpy_no_escape(char *to, const char *toend, const char *from,
570 const char *fromend, int delim, I32 *retlen)
572 PERL_ARGS_ASSERT_DELIMCPY_NO_ESCAPE;
574 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 0);
578 =head1 Miscellaneous Functions
580 =for apidoc Am|char *|ninstr|char * big|char * bigend|char * little|char * little_end
582 Find the first (leftmost) occurrence of a sequence of bytes within another
583 sequence. This is the Perl version of C<strstr()>, extended to handle
584 arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
585 is what the initial C<n> in the function name stands for; some systems have an
586 equivalent, C<memmem()>, but with a somewhat different API).
588 Another way of thinking about this function is finding a needle in a haystack.
589 C<big> points to the first byte in the haystack. C<big_end> points to one byte
590 beyond the final byte in the haystack. C<little> points to the first byte in
591 the needle. C<little_end> points to one byte beyond the final byte in the
592 needle. All the parameters must be non-C<NULL>.
594 The function returns C<NULL> if there is no occurrence of C<little> within
595 C<big>. If C<little> is the empty string, C<big> is returned.
597 Because this function operates at the byte level, and because of the inherent
598 characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
599 needle and the haystack are strings with the same UTF-8ness, but not if the
607 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
609 PERL_ARGS_ASSERT_NINSTR;
612 return ninstr(big, bigend, little, lend);
618 const char first = *little;
619 bigend -= lend - little++;
621 while (big <= bigend) {
622 if (*big++ == first) {
624 for (x=big,s=little; s < lend; x++,s++) {
628 return (char*)(big-1);
639 =head1 Miscellaneous Functions
641 =for apidoc Am|char *|rninstr|char * big|char * bigend|char * little|char * little_end
643 Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
644 sequence of bytes within another sequence, returning C<NULL> if there is no
652 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
655 const I32 first = *little;
656 const char * const littleend = lend;
658 PERL_ARGS_ASSERT_RNINSTR;
660 if (little >= littleend)
661 return (char*)bigend;
663 big = bigend - (littleend - little++);
664 while (big >= bigbeg) {
668 for (x=big+2,s=little; s < littleend; /**/ ) {
677 return (char*)(big+1);
682 /* As a space optimization, we do not compile tables for strings of length
683 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
684 special-cased in fbm_instr().
686 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
689 =head1 Miscellaneous Functions
691 =for apidoc fbm_compile
693 Analyzes the string in order to make fast searches on it using C<fbm_instr()>
694 -- the Boyer-Moore algorithm.
700 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
707 PERL_DEB( STRLEN rarest = 0 );
709 PERL_ARGS_ASSERT_FBM_COMPILE;
711 if (isGV_with_GP(sv) || SvROK(sv))
717 if (flags & FBMcf_TAIL) {
718 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
719 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
720 if (mg && mg->mg_len >= 0)
723 if (!SvPOK(sv) || SvNIOKp(sv))
724 s = (U8*)SvPV_force_mutable(sv, len);
725 else s = (U8 *)SvPV_mutable(sv, len);
726 if (len == 0) /* TAIL might be on a zero-length string. */
728 SvUPGRADE(sv, SVt_PVMG);
732 /* add PERL_MAGIC_bm magic holding the FBM lookup table */
734 assert(!mg_find(sv, PERL_MAGIC_bm));
735 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
739 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
741 const U8 mlen = (len>255) ? 255 : (U8)len;
742 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
745 Newx(table, 256, U8);
746 memset((void*)table, mlen, 256);
747 mg->mg_ptr = (char *)table;
750 s += len - 1; /* last char */
753 if (table[*s] == mlen)
759 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
760 for (i = 0; i < len; i++) {
761 if (PL_freq[s[i]] < frequency) {
762 PERL_DEB( rarest = i );
763 frequency = PL_freq[s[i]];
766 BmUSEFUL(sv) = 100; /* Initial value */
767 ((XPVNV*)SvANY(sv))->xnv_u.xnv_bm_tail = cBOOL(flags & FBMcf_TAIL);
768 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %" UVuf "\n",
769 s[rarest], (UV)rarest));
774 =for apidoc fbm_instr
776 Returns the location of the SV in the string delimited by C<big> and
777 C<bigend> (C<bigend>) is the char following the last char).
778 It returns C<NULL> if the string can't be found. The C<sv>
779 does not have to be C<fbm_compiled>, but the search will not be as fast
784 If SvTAIL(littlestr) is true, a fake "\n" was appended to to the string
785 during FBM compilation due to FBMcf_TAIL in flags. It indicates that
786 the littlestr must be anchored to the end of bigstr (or to any \n if
789 E.g. The regex compiler would compile /abc/ to a littlestr of "abc",
790 while /abc$/ compiles to "abc\n" with SvTAIL() true.
792 A littlestr of "abc", !SvTAIL matches as /abc/;
793 a littlestr of "ab\n", SvTAIL matches as:
794 without FBMrf_MULTILINE: /ab\n?\z/
795 with FBMrf_MULTILINE: /ab\n/ || /ab\z/;
797 (According to Ilya from 1999; I don't know if this is still true, DAPM 2015):
798 "If SvTAIL is actually due to \Z or \z, this gives false positives
804 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
808 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
809 STRLEN littlelen = l;
810 const I32 multiline = flags & FBMrf_MULTILINE;
811 bool valid = SvVALID(littlestr);
812 bool tail = valid ? cBOOL(SvTAIL(littlestr)) : FALSE;
814 PERL_ARGS_ASSERT_FBM_INSTR;
816 assert(bigend >= big);
818 if ((STRLEN)(bigend - big) < littlelen) {
820 && ((STRLEN)(bigend - big) == littlelen - 1)
822 || (*big == *little &&
823 memEQ((char *)big, (char *)little, littlelen - 1))))
828 switch (littlelen) { /* Special cases for 0, 1 and 2 */
830 return (char*)big; /* Cannot be SvTAIL! */
833 if (tail && !multiline) /* Anchor only! */
834 /* [-1] is safe because we know that bigend != big. */
835 return (char *) (bigend - (bigend[-1] == '\n'));
837 s = (unsigned char *)memchr((void*)big, *little, bigend-big);
841 return (char *) bigend;
845 if (tail && !multiline) {
846 /* a littlestr with SvTAIL must be of the form "X\n" (where X
847 * is a single char). It is anchored, and can only match
848 * "....X\n" or "....X" */
849 if (bigend[-2] == *little && bigend[-1] == '\n')
850 return (char*)bigend - 2;
851 if (bigend[-1] == *little)
852 return (char*)bigend - 1;
857 /* memchr() is likely to be very fast, possibly using whatever
858 * hardware support is available, such as checking a whole
859 * cache line in one instruction.
860 * So for a 2 char pattern, calling memchr() is likely to be
861 * faster than running FBM, or rolling our own. The previous
862 * version of this code was roll-your-own which typically
863 * only needed to read every 2nd char, which was good back in
864 * the day, but no longer.
866 unsigned char c1 = little[0];
867 unsigned char c2 = little[1];
869 /* *** for all this case, bigend points to the last char,
870 * not the trailing \0: this makes the conditions slightly
876 /* do a quick test for c1 before calling memchr();
877 * this avoids the expensive fn call overhead when
878 * there are lots of c1's */
879 if (LIKELY(*s != c1)) {
881 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
888 /* failed; try searching for c2 this time; that way
889 * we don't go pathologically slow when the string
890 * consists mostly of c1's or vice versa.
895 s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
903 /* c1, c2 the same */
913 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
914 if (!s || s >= bigend)
921 /* failed to find 2 chars; try anchored match at end without
923 if (tail && bigend[0] == little[0])
924 return (char *)bigend;
929 break; /* Only lengths 0 1 and 2 have special-case code. */
932 if (tail && !multiline) { /* tail anchored? */
933 s = bigend - littlelen;
934 if (s >= big && bigend[-1] == '\n' && *s == *little
935 /* Automatically of length > 2 */
936 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
938 return (char*)s; /* how sweet it is */
941 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
943 return (char*)s + 1; /* how sweet it is */
949 /* not compiled; use Perl_ninstr() instead */
950 char * const b = ninstr((char*)big,(char*)bigend,
951 (char*)little, (char*)little + littlelen);
953 assert(!tail); /* valid => FBM; tail only set on SvVALID SVs */
958 if (littlelen > (STRLEN)(bigend - big))
962 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
963 const unsigned char *oldlittle;
967 --littlelen; /* Last char found by table lookup */
970 little += littlelen; /* last char */
973 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
974 const unsigned char lastc = *little;
978 if ((tmp = table[*s])) {
979 /* *s != lastc; earliest position it could match now is
980 * tmp slots further on */
981 if ((s += tmp) >= bigend)
983 if (LIKELY(*s != lastc)) {
985 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
995 /* hand-rolled strncmp(): less expensive than calling the
996 * real function (maybe???) */
998 unsigned char * const olds = s;
1003 if (*--s == *--little)
1005 s = olds + 1; /* here we pay the price for failure */
1007 if (s < bigend) /* fake up continue to outer loop */
1017 && memEQ((char *)(bigend - littlelen),
1018 (char *)(oldlittle - littlelen), littlelen) )
1019 return (char*)bigend - littlelen;
1024 /* copy a string to a safe spot */
1027 =head1 Memory Management
1031 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1032 string which is a duplicate of C<pv>. The size of the string is
1033 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1034 characters and must have a trailing C<NUL>. The memory allocated for the new
1035 string can be freed with the C<Safefree()> function.
1037 On some platforms, Windows for example, all allocated memory owned by a thread
1038 is deallocated when that thread ends. So if you need that not to happen, you
1039 need to use the shared memory functions, such as C<L</savesharedpv>>.
1045 Perl_savepv(pTHX_ const char *pv)
1047 PERL_UNUSED_CONTEXT;
1052 const STRLEN pvlen = strlen(pv)+1;
1053 Newx(newaddr, pvlen, char);
1054 return (char*)memcpy(newaddr, pv, pvlen);
1058 /* same thing but with a known length */
1063 Perl's version of what C<strndup()> would be if it existed. Returns a
1064 pointer to a newly allocated string which is a duplicate of the first
1065 C<len> bytes from C<pv>, plus a trailing
1066 C<NUL> byte. The memory allocated for
1067 the new string can be freed with the C<Safefree()> function.
1069 On some platforms, Windows for example, all allocated memory owned by a thread
1070 is deallocated when that thread ends. So if you need that not to happen, you
1071 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1077 Perl_savepvn(pTHX_ const char *pv, I32 len)
1080 PERL_UNUSED_CONTEXT;
1084 Newx(newaddr,len+1,char);
1085 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1087 /* might not be null terminated */
1088 newaddr[len] = '\0';
1089 return (char *) CopyD(pv,newaddr,len,char);
1092 return (char *) ZeroD(newaddr,len+1,char);
1097 =for apidoc savesharedpv
1099 A version of C<savepv()> which allocates the duplicate string in memory
1100 which is shared between threads.
1105 Perl_savesharedpv(pTHX_ const char *pv)
1110 PERL_UNUSED_CONTEXT;
1115 pvlen = strlen(pv)+1;
1116 newaddr = (char*)PerlMemShared_malloc(pvlen);
1120 return (char*)memcpy(newaddr, pv, pvlen);
1124 =for apidoc savesharedpvn
1126 A version of C<savepvn()> which allocates the duplicate string in memory
1127 which is shared between threads. (With the specific difference that a C<NULL>
1128 pointer is not acceptable)
1133 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1135 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1137 PERL_UNUSED_CONTEXT;
1138 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1143 newaddr[len] = '\0';
1144 return (char*)memcpy(newaddr, pv, len);
1148 =for apidoc savesvpv
1150 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1151 the passed in SV using C<SvPV()>
1153 On some platforms, Windows for example, all allocated memory owned by a thread
1154 is deallocated when that thread ends. So if you need that not to happen, you
1155 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1161 Perl_savesvpv(pTHX_ SV *sv)
1164 const char * const pv = SvPV_const(sv, len);
1167 PERL_ARGS_ASSERT_SAVESVPV;
1170 Newx(newaddr,len,char);
1171 return (char *) CopyD(pv,newaddr,len,char);
1175 =for apidoc savesharedsvpv
1177 A version of C<savesharedpv()> which allocates the duplicate string in
1178 memory which is shared between threads.
1184 Perl_savesharedsvpv(pTHX_ SV *sv)
1187 const char * const pv = SvPV_const(sv, len);
1189 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1191 return savesharedpvn(pv, len);
1194 /* the SV for Perl_form() and mess() is not kept in an arena */
1202 if (PL_phase != PERL_PHASE_DESTRUCT)
1203 return newSVpvs_flags("", SVs_TEMP);
1208 /* Create as PVMG now, to avoid any upgrading later */
1210 Newxz(any, 1, XPVMG);
1211 SvFLAGS(sv) = SVt_PVMG;
1212 SvANY(sv) = (void*)any;
1214 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1219 #if defined(PERL_IMPLICIT_CONTEXT)
1221 Perl_form_nocontext(const char* pat, ...)
1226 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1227 va_start(args, pat);
1228 retval = vform(pat, &args);
1232 #endif /* PERL_IMPLICIT_CONTEXT */
1235 =head1 Miscellaneous Functions
1238 Takes a sprintf-style format pattern and conventional
1239 (non-SV) arguments and returns the formatted string.
1241 (char *) Perl_form(pTHX_ const char* pat, ...)
1243 can be used any place a string (char *) is required:
1245 char * s = Perl_form("%d.%d",major,minor);
1247 Uses a single private buffer so if you want to format several strings you
1248 must explicitly copy the earlier strings away (and free the copies when you
1255 Perl_form(pTHX_ const char* pat, ...)
1259 PERL_ARGS_ASSERT_FORM;
1260 va_start(args, pat);
1261 retval = vform(pat, &args);
1267 Perl_vform(pTHX_ const char *pat, va_list *args)
1269 SV * const sv = mess_alloc();
1270 PERL_ARGS_ASSERT_VFORM;
1271 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1276 =for apidoc Am|SV *|mess|const char *pat|...
1278 Take a sprintf-style format pattern and argument list. These are used to
1279 generate a string message. If the message does not end with a newline,
1280 then it will be extended with some indication of the current location
1281 in the code, as described for L</mess_sv>.
1283 Normally, the resulting message is returned in a new mortal SV.
1284 During global destruction a single SV may be shared between uses of
1290 #if defined(PERL_IMPLICIT_CONTEXT)
1292 Perl_mess_nocontext(const char *pat, ...)
1297 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1298 va_start(args, pat);
1299 retval = vmess(pat, &args);
1303 #endif /* PERL_IMPLICIT_CONTEXT */
1306 Perl_mess(pTHX_ const char *pat, ...)
1310 PERL_ARGS_ASSERT_MESS;
1311 va_start(args, pat);
1312 retval = vmess(pat, &args);
1318 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1321 /* Look for curop starting from o. cop is the last COP we've seen. */
1322 /* opnext means that curop is actually the ->op_next of the op we are
1325 PERL_ARGS_ASSERT_CLOSEST_COP;
1327 if (!o || !curop || (
1328 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1332 if (o->op_flags & OPf_KIDS) {
1334 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1337 /* If the OP_NEXTSTATE has been optimised away we can still use it
1338 * the get the file and line number. */
1340 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1341 cop = (const COP *)kid;
1343 /* Keep searching, and return when we've found something. */
1345 new_cop = closest_cop(cop, kid, curop, opnext);
1351 /* Nothing found. */
1357 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1359 Expands a message, intended for the user, to include an indication of
1360 the current location in the code, if the message does not already appear
1363 C<basemsg> is the initial message or object. If it is a reference, it
1364 will be used as-is and will be the result of this function. Otherwise it
1365 is used as a string, and if it already ends with a newline, it is taken
1366 to be complete, and the result of this function will be the same string.
1367 If the message does not end with a newline, then a segment such as C<at
1368 foo.pl line 37> will be appended, and possibly other clauses indicating
1369 the current state of execution. The resulting message will end with a
1372 Normally, the resulting message is returned in a new mortal SV.
1373 During global destruction a single SV may be shared between uses of this
1374 function. If C<consume> is true, then the function is permitted (but not
1375 required) to modify and return C<basemsg> instead of allocating a new SV.
1381 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1385 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1389 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1390 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1391 && grok_atoUV(ws, &wi, NULL)
1392 && wi <= PERL_INT_MAX
1394 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1399 PERL_ARGS_ASSERT_MESS_SV;
1401 if (SvROK(basemsg)) {
1407 sv_setsv(sv, basemsg);
1412 if (SvPOK(basemsg) && consume) {
1417 sv_copypv(sv, basemsg);
1420 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1422 * Try and find the file and line for PL_op. This will usually be
1423 * PL_curcop, but it might be a cop that has been optimised away. We
1424 * can try to find such a cop by searching through the optree starting
1425 * from the sibling of PL_curcop.
1430 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1435 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1436 OutCopFILE(cop), (IV)CopLINE(cop));
1439 /* Seems that GvIO() can be untrustworthy during global destruction. */
1440 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1441 && IoLINES(GvIOp(PL_last_in_gv)))
1444 const bool line_mode = (RsSIMPLE(PL_rs) &&
1445 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1446 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1447 SVfARG(PL_last_in_gv == PL_argvgv
1449 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1450 line_mode ? "line" : "chunk",
1451 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1453 if (PL_phase == PERL_PHASE_DESTRUCT)
1454 sv_catpvs(sv, " during global destruction");
1455 sv_catpvs(sv, ".\n");
1461 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1463 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1464 argument list, respectively. These are used to generate a string message. If
1466 message does not end with a newline, then it will be extended with
1467 some indication of the current location in the code, as described for
1470 Normally, the resulting message is returned in a new mortal SV.
1471 During global destruction a single SV may be shared between uses of
1478 Perl_vmess(pTHX_ const char *pat, va_list *args)
1480 SV * const sv = mess_alloc();
1482 PERL_ARGS_ASSERT_VMESS;
1484 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1485 return mess_sv(sv, 1);
1489 Perl_write_to_stderr(pTHX_ SV* msv)
1494 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1496 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1497 && (io = GvIO(PL_stderrgv))
1498 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1499 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1500 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1502 PerlIO * const serr = Perl_error_log;
1504 do_print(msv, serr);
1505 (void)PerlIO_flush(serr);
1510 =head1 Warning and Dieing
1513 /* Common code used in dieing and warning */
1516 S_with_queued_errors(pTHX_ SV *ex)
1518 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1519 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1520 sv_catsv(PL_errors, ex);
1521 ex = sv_mortalcopy(PL_errors);
1522 SvCUR_set(PL_errors, 0);
1528 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1533 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1534 /* sv_2cv might call Perl_croak() or Perl_warner() */
1535 SV * const oldhook = *hook;
1543 cv = sv_2cv(oldhook, &stash, &gv, 0);
1545 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1555 exarg = newSVsv(ex);
1556 SvREADONLY_on(exarg);
1559 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1563 call_sv(MUTABLE_SV(cv), G_DISCARD);
1572 =for apidoc Am|OP *|die_sv|SV *baseex
1574 Behaves the same as L</croak_sv>, except for the return type.
1575 It should be used only where the C<OP *> return type is required.
1576 The function never actually returns.
1582 # pragma warning( push )
1583 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1584 __declspec(noreturn) has non-void return type */
1585 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1586 __declspec(noreturn) has a return statement */
1589 Perl_die_sv(pTHX_ SV *baseex)
1591 PERL_ARGS_ASSERT_DIE_SV;
1594 NORETURN_FUNCTION_END;
1597 # pragma warning( pop )
1601 =for apidoc Am|OP *|die|const char *pat|...
1603 Behaves the same as L</croak>, except for the return type.
1604 It should be used only where the C<OP *> return type is required.
1605 The function never actually returns.
1610 #if defined(PERL_IMPLICIT_CONTEXT)
1612 # pragma warning( push )
1613 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1614 __declspec(noreturn) has non-void return type */
1615 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1616 __declspec(noreturn) has a return statement */
1619 Perl_die_nocontext(const char* pat, ...)
1623 va_start(args, pat);
1625 NOT_REACHED; /* NOTREACHED */
1627 NORETURN_FUNCTION_END;
1630 # pragma warning( pop )
1632 #endif /* PERL_IMPLICIT_CONTEXT */
1635 # pragma warning( push )
1636 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1637 __declspec(noreturn) has non-void return type */
1638 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1639 __declspec(noreturn) has a return statement */
1642 Perl_die(pTHX_ const char* pat, ...)
1645 va_start(args, pat);
1647 NOT_REACHED; /* NOTREACHED */
1649 NORETURN_FUNCTION_END;
1652 # pragma warning( pop )
1656 =for apidoc Am|void|croak_sv|SV *baseex
1658 This is an XS interface to Perl's C<die> function.
1660 C<baseex> is the error message or object. If it is a reference, it
1661 will be used as-is. Otherwise it is used as a string, and if it does
1662 not end with a newline then it will be extended with some indication of
1663 the current location in the code, as described for L</mess_sv>.
1665 The error message or object will be used as an exception, by default
1666 returning control to the nearest enclosing C<eval>, but subject to
1667 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1668 function never returns normally.
1670 To die with a simple string message, the L</croak> function may be
1677 Perl_croak_sv(pTHX_ SV *baseex)
1679 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1680 PERL_ARGS_ASSERT_CROAK_SV;
1681 invoke_exception_hook(ex, FALSE);
1686 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1688 This is an XS interface to Perl's C<die> function.
1690 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1691 argument list. These are used to generate a string message. If the
1692 message does not end with a newline, then it will be extended with
1693 some indication of the current location in the code, as described for
1696 The error message will be used as an exception, by default
1697 returning control to the nearest enclosing C<eval>, but subject to
1698 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1699 function never returns normally.
1701 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1702 (C<$@>) will be used as an error message or object instead of building an
1703 error message from arguments. If you want to throw a non-string object,
1704 or build an error message in an SV yourself, it is preferable to use
1705 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1711 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1713 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1714 invoke_exception_hook(ex, FALSE);
1719 =for apidoc Am|void|croak|const char *pat|...
1721 This is an XS interface to Perl's C<die> function.
1723 Take a sprintf-style format pattern and argument list. These are used to
1724 generate a string message. If the message does not end with a newline,
1725 then it will be extended with some indication of the current location
1726 in the code, as described for L</mess_sv>.
1728 The error message will be used as an exception, by default
1729 returning control to the nearest enclosing C<eval>, but subject to
1730 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1731 function never returns normally.
1733 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1734 (C<$@>) will be used as an error message or object instead of building an
1735 error message from arguments. If you want to throw a non-string object,
1736 or build an error message in an SV yourself, it is preferable to use
1737 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1742 #if defined(PERL_IMPLICIT_CONTEXT)
1744 Perl_croak_nocontext(const char *pat, ...)
1748 va_start(args, pat);
1750 NOT_REACHED; /* NOTREACHED */
1753 #endif /* PERL_IMPLICIT_CONTEXT */
1756 Perl_croak(pTHX_ const char *pat, ...)
1759 va_start(args, pat);
1761 NOT_REACHED; /* NOTREACHED */
1766 =for apidoc Am|void|croak_no_modify
1768 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1769 terser object code than using C<Perl_croak>. Less code used on exception code
1770 paths reduces CPU cache pressure.
1776 Perl_croak_no_modify(void)
1778 Perl_croak_nocontext( "%s", PL_no_modify);
1781 /* does not return, used in util.c perlio.c and win32.c
1782 This is typically called when malloc returns NULL.
1785 Perl_croak_no_mem(void)
1789 int fd = PerlIO_fileno(Perl_error_log);
1791 SETERRNO(EBADF,RMS_IFI);
1793 /* Can't use PerlIO to write as it allocates memory */
1794 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1799 /* does not return, used only in POPSTACK */
1801 Perl_croak_popstack(void)
1804 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1809 =for apidoc Am|void|warn_sv|SV *baseex
1811 This is an XS interface to Perl's C<warn> function.
1813 C<baseex> is the error message or object. If it is a reference, it
1814 will be used as-is. Otherwise it is used as a string, and if it does
1815 not end with a newline then it will be extended with some indication of
1816 the current location in the code, as described for L</mess_sv>.
1818 The error message or object will by default be written to standard error,
1819 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1821 To warn with a simple string message, the L</warn> function may be
1828 Perl_warn_sv(pTHX_ SV *baseex)
1830 SV *ex = mess_sv(baseex, 0);
1831 PERL_ARGS_ASSERT_WARN_SV;
1832 if (!invoke_exception_hook(ex, TRUE))
1833 write_to_stderr(ex);
1837 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1839 This is an XS interface to Perl's C<warn> function.
1841 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1842 argument list. These are used to generate a string message. If the
1843 message does not end with a newline, then it will be extended with
1844 some indication of the current location in the code, as described for
1847 The error message or object will by default be written to standard error,
1848 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1850 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1856 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1858 SV *ex = vmess(pat, args);
1859 PERL_ARGS_ASSERT_VWARN;
1860 if (!invoke_exception_hook(ex, TRUE))
1861 write_to_stderr(ex);
1865 =for apidoc Am|void|warn|const char *pat|...
1867 This is an XS interface to Perl's C<warn> function.
1869 Take a sprintf-style format pattern and argument list. These are used to
1870 generate a string message. If the message does not end with a newline,
1871 then it will be extended with some indication of the current location
1872 in the code, as described for L</mess_sv>.
1874 The error message or object will by default be written to standard error,
1875 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1877 Unlike with L</croak>, C<pat> is not permitted to be null.
1882 #if defined(PERL_IMPLICIT_CONTEXT)
1884 Perl_warn_nocontext(const char *pat, ...)
1888 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1889 va_start(args, pat);
1893 #endif /* PERL_IMPLICIT_CONTEXT */
1896 Perl_warn(pTHX_ const char *pat, ...)
1899 PERL_ARGS_ASSERT_WARN;
1900 va_start(args, pat);
1905 #if defined(PERL_IMPLICIT_CONTEXT)
1907 Perl_warner_nocontext(U32 err, const char *pat, ...)
1911 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1912 va_start(args, pat);
1913 vwarner(err, pat, &args);
1916 #endif /* PERL_IMPLICIT_CONTEXT */
1919 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1921 PERL_ARGS_ASSERT_CK_WARNER_D;
1923 if (Perl_ckwarn_d(aTHX_ err)) {
1925 va_start(args, pat);
1926 vwarner(err, pat, &args);
1932 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1934 PERL_ARGS_ASSERT_CK_WARNER;
1936 if (Perl_ckwarn(aTHX_ err)) {
1938 va_start(args, pat);
1939 vwarner(err, pat, &args);
1945 Perl_warner(pTHX_ U32 err, const char* pat,...)
1948 PERL_ARGS_ASSERT_WARNER;
1949 va_start(args, pat);
1950 vwarner(err, pat, &args);
1955 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1958 PERL_ARGS_ASSERT_VWARNER;
1960 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
1961 !(PL_in_eval & EVAL_KEEPERR)
1963 SV * const msv = vmess(pat, args);
1965 if (PL_parser && PL_parser->error_count) {
1969 invoke_exception_hook(msv, FALSE);
1974 Perl_vwarn(aTHX_ pat, args);
1978 /* implements the ckWARN? macros */
1981 Perl_ckwarn(pTHX_ U32 w)
1983 /* If lexical warnings have not been set, use $^W. */
1985 return PL_dowarn & G_WARN_ON;
1987 return ckwarn_common(w);
1990 /* implements the ckWARN?_d macro */
1993 Perl_ckwarn_d(pTHX_ U32 w)
1995 /* If lexical warnings have not been set then default classes warn. */
1999 return ckwarn_common(w);
2003 S_ckwarn_common(pTHX_ U32 w)
2005 if (PL_curcop->cop_warnings == pWARN_ALL)
2008 if (PL_curcop->cop_warnings == pWARN_NONE)
2011 /* Check the assumption that at least the first slot is non-zero. */
2012 assert(unpackWARN1(w));
2014 /* Check the assumption that it is valid to stop as soon as a zero slot is
2016 if (!unpackWARN2(w)) {
2017 assert(!unpackWARN3(w));
2018 assert(!unpackWARN4(w));
2019 } else if (!unpackWARN3(w)) {
2020 assert(!unpackWARN4(w));
2023 /* Right, dealt with all the special cases, which are implemented as non-
2024 pointers, so there is a pointer to a real warnings mask. */
2026 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2028 } while (w >>= WARNshift);
2033 /* Set buffer=NULL to get a new one. */
2035 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2037 const MEM_SIZE len_wanted =
2038 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2039 PERL_UNUSED_CONTEXT;
2040 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2043 (specialWARN(buffer) ?
2044 PerlMemShared_malloc(len_wanted) :
2045 PerlMemShared_realloc(buffer, len_wanted));
2047 Copy(bits, (buffer + 1), size, char);
2048 if (size < WARNsize)
2049 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2053 /* since we've already done strlen() for both nam and val
2054 * we can use that info to make things faster than
2055 * sprintf(s, "%s=%s", nam, val)
2057 #define my_setenv_format(s, nam, nlen, val, vlen) \
2058 Copy(nam, s, nlen, char); \
2060 Copy(val, s+(nlen+1), vlen, char); \
2061 *(s+(nlen+1+vlen)) = '\0'
2063 #ifdef USE_ENVIRON_ARRAY
2064 /* VMS' my_setenv() is in vms.c */
2065 #if !defined(WIN32) && !defined(NETWARE)
2067 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2071 amigaos4_obtain_environ(__FUNCTION__);
2074 /* only parent thread can modify process environment */
2075 if (PL_curinterp == aTHX)
2078 #ifndef PERL_USE_SAFE_PUTENV
2079 if (!PL_use_safe_putenv) {
2080 /* most putenv()s leak, so we manipulate environ directly */
2082 const I32 len = strlen(nam);
2085 /* where does it go? */
2086 for (i = 0; environ[i]; i++) {
2087 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
2091 if (environ == PL_origenviron) { /* need we copy environment? */
2097 while (environ[max])
2099 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
2100 for (j=0; j<max; j++) { /* copy environment */
2101 const int len = strlen(environ[j]);
2102 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
2103 Copy(environ[j], tmpenv[j], len+1, char);
2106 environ = tmpenv; /* tell exec where it is now */
2109 safesysfree(environ[i]);
2110 while (environ[i]) {
2111 environ[i] = environ[i+1];
2120 if (!environ[i]) { /* does not exist yet */
2121 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
2122 environ[i+1] = NULL; /* make sure it's null terminated */
2125 safesysfree(environ[i]);
2129 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
2130 /* all that work just for this */
2131 my_setenv_format(environ[i], nam, nlen, val, vlen);
2134 /* This next branch should only be called #if defined(HAS_SETENV), but
2135 Configure doesn't test for that yet. For Solaris, setenv() and unsetenv()
2136 were introduced in Solaris 9, so testing for HAS UNSETENV is sufficient.
2138 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2139 # if defined(HAS_UNSETENV)
2141 (void)unsetenv(nam);
2143 (void)setenv(nam, val, 1);
2145 # else /* ! HAS_UNSETENV */
2146 (void)setenv(nam, val, 1);
2147 # endif /* HAS_UNSETENV */
2148 # elif defined(HAS_UNSETENV)
2150 if (environ) /* old glibc can crash with null environ */
2151 (void)unsetenv(nam);
2153 const int nlen = strlen(nam);
2154 const int vlen = strlen(val);
2155 char * const new_env =
2156 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2157 my_setenv_format(new_env, nam, nlen, val, vlen);
2158 (void)putenv(new_env);
2160 # else /* ! HAS_UNSETENV */
2162 const int nlen = strlen(nam);
2168 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2169 /* all that work just for this */
2170 my_setenv_format(new_env, nam, nlen, val, vlen);
2171 (void)putenv(new_env);
2172 # endif /* __CYGWIN__ */
2173 #ifndef PERL_USE_SAFE_PUTENV
2179 amigaos4_release_environ(__FUNCTION__);
2183 #else /* WIN32 || NETWARE */
2186 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2190 const int nlen = strlen(nam);
2197 Newx(envstr, nlen+vlen+2, char);
2198 my_setenv_format(envstr, nam, nlen, val, vlen);
2199 (void)PerlEnv_putenv(envstr);
2203 #endif /* WIN32 || NETWARE */
2207 #ifdef UNLINK_ALL_VERSIONS
2209 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2213 PERL_ARGS_ASSERT_UNLNK;
2215 while (PerlLIO_unlink(f) >= 0)
2217 return retries ? 0 : -1;
2222 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2224 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2232 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2234 PERL_FLUSHALL_FOR_CHILD;
2235 This = (*mode == 'w');
2239 taint_proper("Insecure %s%s", "EXEC");
2241 if (PerlProc_pipe_cloexec(p) < 0)
2243 /* Try for another pipe pair for error return */
2244 if (PerlProc_pipe_cloexec(pp) >= 0)
2246 while ((pid = PerlProc_fork()) < 0) {
2247 if (errno != EAGAIN) {
2248 PerlLIO_close(p[This]);
2249 PerlLIO_close(p[that]);
2251 PerlLIO_close(pp[0]);
2252 PerlLIO_close(pp[1]);
2256 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2265 /* Close parent's end of error status pipe (if any) */
2267 PerlLIO_close(pp[0]);
2268 /* Now dup our end of _the_ pipe to right position */
2269 if (p[THIS] != (*mode == 'r')) {
2270 PerlLIO_dup2(p[THIS], *mode == 'r');
2271 PerlLIO_close(p[THIS]);
2272 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2273 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2276 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2277 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2278 /* No automatic close - do it by hand */
2285 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2291 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2298 PerlLIO_close(pp[1]);
2299 /* Keep the lower of the two fd numbers */
2300 if (p[that] < p[This]) {
2301 PerlLIO_dup2_cloexec(p[This], p[that]);
2302 PerlLIO_close(p[This]);
2306 PerlLIO_close(p[that]); /* close child's end of pipe */
2308 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2309 SvUPGRADE(sv,SVt_IV);
2311 PL_forkprocess = pid;
2312 /* If we managed to get status pipe check for exec fail */
2313 if (did_pipes && pid > 0) {
2317 while (n < sizeof(int)) {
2318 const SSize_t n1 = PerlLIO_read(pp[0],
2319 (void*)(((char*)&errkid)+n),
2325 PerlLIO_close(pp[0]);
2327 if (n) { /* Error */
2329 PerlLIO_close(p[This]);
2330 if (n != sizeof(int))
2331 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2333 pid2 = wait4pid(pid, &status, 0);
2334 } while (pid2 == -1 && errno == EINTR);
2335 errno = errkid; /* Propagate errno from kid */
2340 PerlLIO_close(pp[0]);
2341 return PerlIO_fdopen(p[This], mode);
2343 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2344 return my_syspopen4(aTHX_ NULL, mode, n, args);
2345 # elif defined(WIN32)
2346 return win32_popenlist(mode, n, args);
2348 Perl_croak(aTHX_ "List form of piped open not implemented");
2349 return (PerlIO *) NULL;
2354 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2355 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2357 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2363 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2367 PERL_ARGS_ASSERT_MY_POPEN;
2369 PERL_FLUSHALL_FOR_CHILD;
2372 return my_syspopen(aTHX_ cmd,mode);
2375 This = (*mode == 'w');
2377 if (doexec && TAINTING_get) {
2379 taint_proper("Insecure %s%s", "EXEC");
2381 if (PerlProc_pipe_cloexec(p) < 0)
2383 if (doexec && PerlProc_pipe_cloexec(pp) >= 0)
2385 while ((pid = PerlProc_fork()) < 0) {
2386 if (errno != EAGAIN) {
2387 PerlLIO_close(p[This]);
2388 PerlLIO_close(p[that]);
2390 PerlLIO_close(pp[0]);
2391 PerlLIO_close(pp[1]);
2394 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2397 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2407 PerlLIO_close(pp[0]);
2408 if (p[THIS] != (*mode == 'r')) {
2409 PerlLIO_dup2(p[THIS], *mode == 'r');
2410 PerlLIO_close(p[THIS]);
2411 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2412 PerlLIO_close(p[THAT]);
2415 PerlLIO_close(p[THAT]);
2418 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2425 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2430 /* may or may not use the shell */
2431 do_exec3(cmd, pp[1], did_pipes);
2434 #endif /* defined OS2 */
2436 #ifdef PERLIO_USING_CRLF
2437 /* Since we circumvent IO layers when we manipulate low-level
2438 filedescriptors directly, need to manually switch to the
2439 default, binary, low-level mode; see PerlIOBuf_open(). */
2440 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2443 #ifdef PERL_USES_PL_PIDSTATUS
2444 hv_clear(PL_pidstatus); /* we have no children */
2451 PerlLIO_close(pp[1]);
2452 if (p[that] < p[This]) {
2453 PerlLIO_dup2_cloexec(p[This], p[that]);
2454 PerlLIO_close(p[This]);
2458 PerlLIO_close(p[that]);
2460 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2461 SvUPGRADE(sv,SVt_IV);
2463 PL_forkprocess = pid;
2464 if (did_pipes && pid > 0) {
2468 while (n < sizeof(int)) {
2469 const SSize_t n1 = PerlLIO_read(pp[0],
2470 (void*)(((char*)&errkid)+n),
2476 PerlLIO_close(pp[0]);
2478 if (n) { /* Error */
2480 PerlLIO_close(p[This]);
2481 if (n != sizeof(int))
2482 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2484 pid2 = wait4pid(pid, &status, 0);
2485 } while (pid2 == -1 && errno == EINTR);
2486 errno = errkid; /* Propagate errno from kid */
2491 PerlLIO_close(pp[0]);
2492 return PerlIO_fdopen(p[This], mode);
2494 #elif defined(DJGPP)
2495 FILE *djgpp_popen();
2497 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2499 PERL_FLUSHALL_FOR_CHILD;
2500 /* Call system's popen() to get a FILE *, then import it.
2501 used 0 for 2nd parameter to PerlIO_importFILE;
2504 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2506 #elif defined(__LIBCATAMOUNT__)
2508 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2513 #endif /* !DOSISH */
2515 /* this is called in parent before the fork() */
2517 Perl_atfork_lock(void)
2518 #if defined(USE_ITHREADS)
2520 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2523 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2525 PERL_TSA_ACQUIRE(PL_op_mutex)
2528 #if defined(USE_ITHREADS)
2530 /* locks must be held in locking order (if any) */
2532 MUTEX_LOCK(&PL_perlio_mutex);
2535 MUTEX_LOCK(&PL_malloc_mutex);
2541 /* this is called in both parent and child after the fork() */
2543 Perl_atfork_unlock(void)
2544 #if defined(USE_ITHREADS)
2546 PERL_TSA_RELEASE(PL_perlio_mutex)
2549 PERL_TSA_RELEASE(PL_malloc_mutex)
2551 PERL_TSA_RELEASE(PL_op_mutex)
2554 #if defined(USE_ITHREADS)
2556 /* locks must be released in same order as in atfork_lock() */
2558 MUTEX_UNLOCK(&PL_perlio_mutex);
2561 MUTEX_UNLOCK(&PL_malloc_mutex);
2570 #if defined(HAS_FORK)
2572 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2577 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2578 * handlers elsewhere in the code */
2582 #elif defined(__amigaos4__)
2583 return amigaos_fork();
2585 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2586 Perl_croak_nocontext("fork() not available");
2588 #endif /* HAS_FORK */
2593 dup2(int oldfd, int newfd)
2595 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2598 PerlLIO_close(newfd);
2599 return fcntl(oldfd, F_DUPFD, newfd);
2601 #define DUP2_MAX_FDS 256
2602 int fdtmp[DUP2_MAX_FDS];
2608 PerlLIO_close(newfd);
2609 /* good enough for low fd's... */
2610 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2611 if (fdx >= DUP2_MAX_FDS) {
2619 PerlLIO_close(fdtmp[--fdx]);
2626 #ifdef HAS_SIGACTION
2629 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2631 struct sigaction act, oact;
2635 /* only "parent" interpreter can diddle signals */
2636 if (PL_curinterp != aTHX)
2637 return (Sighandler_t) SIG_ERR;
2640 act.sa_handler = (void(*)(int))handler;
2641 sigemptyset(&act.sa_mask);
2644 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2645 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2647 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2648 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2649 act.sa_flags |= SA_NOCLDWAIT;
2651 if (sigaction(signo, &act, &oact) == -1)
2652 return (Sighandler_t) SIG_ERR;
2654 return (Sighandler_t) oact.sa_handler;
2658 Perl_rsignal_state(pTHX_ int signo)
2660 struct sigaction oact;
2661 PERL_UNUSED_CONTEXT;
2663 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2664 return (Sighandler_t) SIG_ERR;
2666 return (Sighandler_t) oact.sa_handler;
2670 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2675 struct sigaction act;
2677 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2680 /* only "parent" interpreter can diddle signals */
2681 if (PL_curinterp != aTHX)
2685 act.sa_handler = (void(*)(int))handler;
2686 sigemptyset(&act.sa_mask);
2689 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2690 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2692 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2693 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2694 act.sa_flags |= SA_NOCLDWAIT;
2696 return sigaction(signo, &act, save);
2700 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2705 PERL_UNUSED_CONTEXT;
2707 /* only "parent" interpreter can diddle signals */
2708 if (PL_curinterp != aTHX)
2712 return sigaction(signo, save, (struct sigaction *)NULL);
2715 #else /* !HAS_SIGACTION */
2718 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2720 #if defined(USE_ITHREADS) && !defined(WIN32)
2721 /* only "parent" interpreter can diddle signals */
2722 if (PL_curinterp != aTHX)
2723 return (Sighandler_t) SIG_ERR;
2726 return PerlProc_signal(signo, handler);
2737 Perl_rsignal_state(pTHX_ int signo)
2740 Sighandler_t oldsig;
2742 #if defined(USE_ITHREADS) && !defined(WIN32)
2743 /* only "parent" interpreter can diddle signals */
2744 if (PL_curinterp != aTHX)
2745 return (Sighandler_t) SIG_ERR;
2749 oldsig = PerlProc_signal(signo, sig_trap);
2750 PerlProc_signal(signo, oldsig);
2752 PerlProc_kill(PerlProc_getpid(), signo);
2757 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2759 #if defined(USE_ITHREADS) && !defined(WIN32)
2760 /* only "parent" interpreter can diddle signals */
2761 if (PL_curinterp != aTHX)
2764 *save = PerlProc_signal(signo, handler);
2765 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2769 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2771 #if defined(USE_ITHREADS) && !defined(WIN32)
2772 /* only "parent" interpreter can diddle signals */
2773 if (PL_curinterp != aTHX)
2776 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2779 #endif /* !HAS_SIGACTION */
2780 #endif /* !PERL_MICRO */
2782 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2783 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2785 Perl_my_pclose(pTHX_ PerlIO *ptr)
2793 const int fd = PerlIO_fileno(ptr);
2796 svp = av_fetch(PL_fdpid,fd,TRUE);
2797 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2801 #if defined(USE_PERLIO)
2802 /* Find out whether the refcount is low enough for us to wait for the
2803 child proc without blocking. */
2804 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
2806 should_wait = pid > 0;
2810 if (pid == -1) { /* Opened by popen. */
2811 return my_syspclose(ptr);
2814 close_failed = (PerlIO_close(ptr) == EOF);
2816 if (should_wait) do {
2817 pid2 = wait4pid(pid, &status, 0);
2818 } while (pid2 == -1 && errno == EINTR);
2825 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2829 #elif defined(__LIBCATAMOUNT__)
2831 Perl_my_pclose(pTHX_ PerlIO *ptr)
2835 #endif /* !DOSISH */
2837 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2839 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
2842 PERL_ARGS_ASSERT_WAIT4PID;
2843 #ifdef PERL_USES_PL_PIDSTATUS
2845 /* PERL_USES_PL_PIDSTATUS is only defined when neither
2846 waitpid() nor wait4() is available, or on OS/2, which
2847 doesn't appear to support waiting for a progress group
2848 member, so we can only treat a 0 pid as an unknown child.
2855 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
2856 pid, rather than a string form. */
2857 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
2858 if (svp && *svp != &PL_sv_undef) {
2859 *statusp = SvIVX(*svp);
2860 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
2868 hv_iterinit(PL_pidstatus);
2869 if ((entry = hv_iternext(PL_pidstatus))) {
2870 SV * const sv = hv_iterval(PL_pidstatus,entry);
2872 const char * const spid = hv_iterkey(entry,&len);
2874 assert (len == sizeof(Pid_t));
2875 memcpy((char *)&pid, spid, len);
2876 *statusp = SvIVX(sv);
2877 /* The hash iterator is currently on this entry, so simply
2878 calling hv_delete would trigger the lazy delete, which on
2879 aggregate does more work, because next call to hv_iterinit()
2880 would spot the flag, and have to call the delete routine,
2881 while in the meantime any new entries can't re-use that
2883 hv_iterinit(PL_pidstatus);
2884 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
2891 # ifdef HAS_WAITPID_RUNTIME
2892 if (!HAS_WAITPID_RUNTIME)
2895 result = PerlProc_waitpid(pid,statusp,flags);
2898 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
2899 result = wait4(pid,statusp,flags,NULL);
2902 #ifdef PERL_USES_PL_PIDSTATUS
2903 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
2908 Perl_croak(aTHX_ "Can't do waitpid with flags");
2910 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
2911 pidgone(result,*statusp);
2917 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
2920 if (result < 0 && errno == EINTR) {
2922 errno = EINTR; /* reset in case a signal handler changed $! */
2926 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
2928 #ifdef PERL_USES_PL_PIDSTATUS
2930 S_pidgone(pTHX_ Pid_t pid, int status)
2934 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
2935 SvUPGRADE(sv,SVt_IV);
2936 SvIV_set(sv, status);
2944 int /* Cannot prototype with I32
2946 my_syspclose(PerlIO *ptr)
2949 Perl_my_pclose(pTHX_ PerlIO *ptr)
2952 /* Needs work for PerlIO ! */
2953 FILE * const f = PerlIO_findFILE(ptr);
2954 const I32 result = pclose(f);
2955 PerlIO_releaseFILE(ptr,f);
2963 Perl_my_pclose(pTHX_ PerlIO *ptr)
2965 /* Needs work for PerlIO ! */
2966 FILE * const f = PerlIO_findFILE(ptr);
2967 I32 result = djgpp_pclose(f);
2968 result = (result << 8) & 0xff00;
2969 PerlIO_releaseFILE(ptr,f);
2974 #define PERL_REPEATCPY_LINEAR 4
2976 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
2978 PERL_ARGS_ASSERT_REPEATCPY;
2983 croak_memory_wrap();
2986 memset(to, *from, count);
2989 IV items, linear, half;
2991 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
2992 for (items = 0; items < linear; ++items) {
2993 const char *q = from;
2995 for (todo = len; todo > 0; todo--)
3000 while (items <= half) {
3001 IV size = items * len;
3002 memcpy(p, to, size);
3008 memcpy(p, to, (count - items) * len);
3014 Perl_same_dirent(pTHX_ const char *a, const char *b)
3016 char *fa = strrchr(a,'/');
3017 char *fb = strrchr(b,'/');
3020 SV * const tmpsv = sv_newmortal();
3022 PERL_ARGS_ASSERT_SAME_DIRENT;
3035 sv_setpvs(tmpsv, ".");
3037 sv_setpvn(tmpsv, a, fa - a);
3038 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3041 sv_setpvs(tmpsv, ".");
3043 sv_setpvn(tmpsv, b, fb - b);
3044 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3046 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3047 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3049 #endif /* !HAS_RENAME */
3052 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3053 const char *const *const search_ext, I32 flags)
3055 const char *xfound = NULL;
3056 char *xfailed = NULL;
3057 char tmpbuf[MAXPATHLEN];
3062 #if defined(DOSISH) && !defined(OS2)
3063 # define SEARCH_EXTS ".bat", ".cmd", NULL
3064 # define MAX_EXT_LEN 4
3067 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3068 # define MAX_EXT_LEN 4
3071 # define SEARCH_EXTS ".pl", ".com", NULL
3072 # define MAX_EXT_LEN 4
3074 /* additional extensions to try in each dir if scriptname not found */
3076 static const char *const exts[] = { SEARCH_EXTS };
3077 const char *const *const ext = search_ext ? search_ext : exts;
3078 int extidx = 0, i = 0;
3079 const char *curext = NULL;
3081 PERL_UNUSED_ARG(search_ext);
3082 # define MAX_EXT_LEN 0
3085 PERL_ARGS_ASSERT_FIND_SCRIPT;
3088 * If dosearch is true and if scriptname does not contain path
3089 * delimiters, search the PATH for scriptname.
3091 * If SEARCH_EXTS is also defined, will look for each
3092 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3093 * while searching the PATH.
3095 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3096 * proceeds as follows:
3097 * If DOSISH or VMSISH:
3098 * + look for ./scriptname{,.foo,.bar}
3099 * + search the PATH for scriptname{,.foo,.bar}
3102 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3103 * this will not look in '.' if it's not in the PATH)
3108 # ifdef ALWAYS_DEFTYPES
3109 len = strlen(scriptname);
3110 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3111 int idx = 0, deftypes = 1;
3114 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3117 int idx = 0, deftypes = 1;
3120 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3122 /* The first time through, just add SEARCH_EXTS to whatever we
3123 * already have, so we can check for default file types. */
3125 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3132 if ((strlen(tmpbuf) + strlen(scriptname)
3133 + MAX_EXT_LEN) >= sizeof tmpbuf)
3134 continue; /* don't search dir with too-long name */
3135 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3139 if (strEQ(scriptname, "-"))
3141 if (dosearch) { /* Look in '.' first. */
3142 const char *cur = scriptname;
3144 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3146 if (strEQ(ext[i++],curext)) {
3147 extidx = -1; /* already has an ext */
3152 DEBUG_p(PerlIO_printf(Perl_debug_log,
3153 "Looking for %s\n",cur));
3156 if (PerlLIO_stat(cur,&statbuf) >= 0
3157 && !S_ISDIR(statbuf.st_mode)) {
3166 if (cur == scriptname) {
3167 len = strlen(scriptname);
3168 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3170 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3173 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3174 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3179 if (dosearch && !strchr(scriptname, '/')
3181 && !strchr(scriptname, '\\')
3183 && (s = PerlEnv_getenv("PATH")))
3187 bufend = s + strlen(s);
3188 while (s < bufend) {
3192 && *s != ';'; len++, s++) {
3193 if (len < sizeof tmpbuf)
3196 if (len < sizeof tmpbuf)
3199 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3204 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3205 continue; /* don't search dir with too-long name */
3208 && tmpbuf[len - 1] != '/'
3209 && tmpbuf[len - 1] != '\\'
3212 tmpbuf[len++] = '/';
3213 if (len == 2 && tmpbuf[0] == '.')
3215 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3219 len = strlen(tmpbuf);
3220 if (extidx > 0) /* reset after previous loop */
3224 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3225 retval = PerlLIO_stat(tmpbuf,&statbuf);
3226 if (S_ISDIR(statbuf.st_mode)) {
3230 } while ( retval < 0 /* not there */
3231 && extidx>=0 && ext[extidx] /* try an extension? */
3232 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3237 if (S_ISREG(statbuf.st_mode)
3238 && cando(S_IRUSR,TRUE,&statbuf)
3239 #if !defined(DOSISH)
3240 && cando(S_IXUSR,TRUE,&statbuf)
3244 xfound = tmpbuf; /* bingo! */
3248 xfailed = savepv(tmpbuf);
3253 if (!xfound && !seen_dot && !xfailed &&
3254 (PerlLIO_stat(scriptname,&statbuf) < 0
3255 || S_ISDIR(statbuf.st_mode)))
3257 seen_dot = 1; /* Disable message. */
3262 if (flags & 1) { /* do or die? */
3263 /* diag_listed_as: Can't execute %s */
3264 Perl_croak(aTHX_ "Can't %s %s%s%s",
3265 (xfailed ? "execute" : "find"),
3266 (xfailed ? xfailed : scriptname),
3267 (xfailed ? "" : " on PATH"),
3268 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3273 scriptname = xfound;
3275 return (scriptname ? savepv(scriptname) : NULL);
3278 #ifndef PERL_GET_CONTEXT_DEFINED
3281 Perl_get_context(void)
3283 #if defined(USE_ITHREADS)
3285 # ifdef OLD_PTHREADS_API
3287 int error = pthread_getspecific(PL_thr_key, &t)
3289 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3291 # elif defined(I_MACH_CTHREADS)
3292 return (void*)cthread_data(cthread_self());
3294 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3302 Perl_set_context(void *t)
3304 #if defined(USE_ITHREADS)
3307 PERL_ARGS_ASSERT_SET_CONTEXT;
3308 #if defined(USE_ITHREADS)
3309 # ifdef I_MACH_CTHREADS
3310 cthread_set_data(cthread_self(), t);
3313 const int error = pthread_setspecific(PL_thr_key, t);
3315 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3323 #endif /* !PERL_GET_CONTEXT_DEFINED */
3325 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3329 PERL_UNUSED_CONTEXT;
3335 Perl_get_op_names(pTHX)
3337 PERL_UNUSED_CONTEXT;
3338 return (char **)PL_op_name;
3342 Perl_get_op_descs(pTHX)
3344 PERL_UNUSED_CONTEXT;
3345 return (char **)PL_op_desc;
3349 Perl_get_no_modify(pTHX)
3351 PERL_UNUSED_CONTEXT;
3352 return PL_no_modify;
3356 Perl_get_opargs(pTHX)
3358 PERL_UNUSED_CONTEXT;
3359 return (U32 *)PL_opargs;
3363 Perl_get_ppaddr(pTHX)
3366 PERL_UNUSED_CONTEXT;
3367 return (PPADDR_t*)PL_ppaddr;
3370 #ifndef HAS_GETENV_LEN
3372 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3374 char * const env_trans = PerlEnv_getenv(env_elem);
3375 PERL_UNUSED_CONTEXT;
3376 PERL_ARGS_ASSERT_GETENV_LEN;
3378 *len = strlen(env_trans);
3385 Perl_get_vtbl(pTHX_ int vtbl_id)
3387 PERL_UNUSED_CONTEXT;
3389 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3390 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3394 Perl_my_fflush_all(pTHX)
3396 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3397 return PerlIO_flush(NULL);
3399 # if defined(HAS__FWALK)
3400 extern int fflush(FILE *);
3401 /* undocumented, unprototyped, but very useful BSDism */
3402 extern void _fwalk(int (*)(FILE *));
3406 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3408 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3409 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3410 # elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3411 open_max = sysconf(_SC_OPEN_MAX);
3412 # elif defined(FOPEN_MAX)
3413 open_max = FOPEN_MAX;
3414 # elif defined(OPEN_MAX)
3415 open_max = OPEN_MAX;
3416 # elif defined(_NFILE)
3421 for (i = 0; i < open_max; i++)
3422 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3423 STDIO_STREAM_ARRAY[i]._file < open_max &&
3424 STDIO_STREAM_ARRAY[i]._flag)
3425 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3429 SETERRNO(EBADF,RMS_IFI);
3436 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3438 if (ckWARN(WARN_IO)) {
3440 = gv && (isGV_with_GP(gv))
3443 const char * const direction = have == '>' ? "out" : "in";
3445 if (name && HEK_LEN(name))
3446 Perl_warner(aTHX_ packWARN(WARN_IO),
3447 "Filehandle %" HEKf " opened only for %sput",
3448 HEKfARG(name), direction);
3450 Perl_warner(aTHX_ packWARN(WARN_IO),
3451 "Filehandle opened only for %sput", direction);
3456 Perl_report_evil_fh(pTHX_ const GV *gv)
3458 const IO *io = gv ? GvIO(gv) : NULL;
3459 const PERL_BITFIELD16 op = PL_op->op_type;
3463 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3465 warn_type = WARN_CLOSED;
3469 warn_type = WARN_UNOPENED;
3472 if (ckWARN(warn_type)) {
3474 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3475 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3476 const char * const pars =
3477 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3478 const char * const func =
3480 (op == OP_READLINE || op == OP_RCATLINE
3481 ? "readline" : /* "<HANDLE>" not nice */
3482 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3484 const char * const type =
3486 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3487 ? "socket" : "filehandle");
3488 const bool have_name = name && SvCUR(name);
3489 Perl_warner(aTHX_ packWARN(warn_type),
3490 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3491 have_name ? " " : "",
3492 SVfARG(have_name ? name : &PL_sv_no));
3493 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3495 aTHX_ packWARN(warn_type),
3496 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3497 func, pars, have_name ? " " : "",
3498 SVfARG(have_name ? name : &PL_sv_no)
3503 /* To workaround core dumps from the uninitialised tm_zone we get the
3504 * system to give us a reasonable struct to copy. This fix means that
3505 * strftime uses the tm_zone and tm_gmtoff values returned by
3506 * localtime(time()). That should give the desired result most of the
3507 * time. But probably not always!
3509 * This does not address tzname aspects of NETaa14816.
3514 # ifndef STRUCT_TM_HASZONE
3515 # define STRUCT_TM_HASZONE
3519 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3520 # ifndef HAS_TM_TM_ZONE
3521 # define HAS_TM_TM_ZONE
3526 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3528 #ifdef HAS_TM_TM_ZONE
3530 const struct tm* my_tm;
3531 PERL_UNUSED_CONTEXT;
3532 PERL_ARGS_ASSERT_INIT_TM;
3534 my_tm = localtime(&now);
3536 Copy(my_tm, ptm, 1, struct tm);
3538 PERL_UNUSED_CONTEXT;
3539 PERL_ARGS_ASSERT_INIT_TM;
3540 PERL_UNUSED_ARG(ptm);
3545 * mini_mktime - normalise struct tm values without the localtime()
3546 * semantics (and overhead) of mktime().
3549 Perl_mini_mktime(struct tm *ptm)
3553 int month, mday, year, jday;
3554 int odd_cent, odd_year;
3556 PERL_ARGS_ASSERT_MINI_MKTIME;
3558 #define DAYS_PER_YEAR 365
3559 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3560 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3561 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3562 #define SECS_PER_HOUR (60*60)
3563 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3564 /* parentheses deliberately absent on these two, otherwise they don't work */
3565 #define MONTH_TO_DAYS 153/5
3566 #define DAYS_TO_MONTH 5/153
3567 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3568 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3569 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3570 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3573 * Year/day algorithm notes:
3575 * With a suitable offset for numeric value of the month, one can find
3576 * an offset into the year by considering months to have 30.6 (153/5) days,
3577 * using integer arithmetic (i.e., with truncation). To avoid too much
3578 * messing about with leap days, we consider January and February to be
3579 * the 13th and 14th month of the previous year. After that transformation,
3580 * we need the month index we use to be high by 1 from 'normal human' usage,
3581 * so the month index values we use run from 4 through 15.
3583 * Given that, and the rules for the Gregorian calendar (leap years are those
3584 * divisible by 4 unless also divisible by 100, when they must be divisible
3585 * by 400 instead), we can simply calculate the number of days since some
3586 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3587 * the days we derive from our month index, and adding in the day of the
3588 * month. The value used here is not adjusted for the actual origin which
3589 * it normally would use (1 January A.D. 1), since we're not exposing it.
3590 * We're only building the value so we can turn around and get the
3591 * normalised values for the year, month, day-of-month, and day-of-year.
3593 * For going backward, we need to bias the value we're using so that we find
3594 * the right year value. (Basically, we don't want the contribution of
3595 * March 1st to the number to apply while deriving the year). Having done
3596 * that, we 'count up' the contribution to the year number by accounting for
3597 * full quadracenturies (400-year periods) with their extra leap days, plus
3598 * the contribution from full centuries (to avoid counting in the lost leap
3599 * days), plus the contribution from full quad-years (to count in the normal
3600 * leap days), plus the leftover contribution from any non-leap years.
3601 * At this point, if we were working with an actual leap day, we'll have 0
3602 * days left over. This is also true for March 1st, however. So, we have
3603 * to special-case that result, and (earlier) keep track of the 'odd'
3604 * century and year contributions. If we got 4 extra centuries in a qcent,
3605 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3606 * Otherwise, we add back in the earlier bias we removed (the 123 from
3607 * figuring in March 1st), find the month index (integer division by 30.6),
3608 * and the remainder is the day-of-month. We then have to convert back to
3609 * 'real' months (including fixing January and February from being 14/15 in
3610 * the previous year to being in the proper year). After that, to get
3611 * tm_yday, we work with the normalised year and get a new yearday value for
3612 * January 1st, which we subtract from the yearday value we had earlier,
3613 * representing the date we've re-built. This is done from January 1
3614 * because tm_yday is 0-origin.
3616 * Since POSIX time routines are only guaranteed to work for times since the
3617 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3618 * applies Gregorian calendar rules even to dates before the 16th century
3619 * doesn't bother me. Besides, you'd need cultural context for a given
3620 * date to know whether it was Julian or Gregorian calendar, and that's
3621 * outside the scope for this routine. Since we convert back based on the
3622 * same rules we used to build the yearday, you'll only get strange results
3623 * for input which needed normalising, or for the 'odd' century years which
3624 * were leap years in the Julian calendar but not in the Gregorian one.
3625 * I can live with that.
3627 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3628 * that's still outside the scope for POSIX time manipulation, so I don't
3634 year = 1900 + ptm->tm_year;
3635 month = ptm->tm_mon;
3636 mday = ptm->tm_mday;
3642 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3643 yearday += month*MONTH_TO_DAYS + mday + jday;
3645 * Note that we don't know when leap-seconds were or will be,
3646 * so we have to trust the user if we get something which looks
3647 * like a sensible leap-second. Wild values for seconds will
3648 * be rationalised, however.
3650 if ((unsigned) ptm->tm_sec <= 60) {
3657 secs += 60 * ptm->tm_min;
3658 secs += SECS_PER_HOUR * ptm->tm_hour;
3660 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3661 /* got negative remainder, but need positive time */
3662 /* back off an extra day to compensate */
3663 yearday += (secs/SECS_PER_DAY)-1;
3664 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3667 yearday += (secs/SECS_PER_DAY);
3668 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3671 else if (secs >= SECS_PER_DAY) {
3672 yearday += (secs/SECS_PER_DAY);
3673 secs %= SECS_PER_DAY;
3675 ptm->tm_hour = secs/SECS_PER_HOUR;
3676 secs %= SECS_PER_HOUR;
3677 ptm->tm_min = secs/60;
3679 ptm->tm_sec += secs;
3680 /* done with time of day effects */
3682 * The algorithm for yearday has (so far) left it high by 428.
3683 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3684 * bias it by 123 while trying to figure out what year it
3685 * really represents. Even with this tweak, the reverse
3686 * translation fails for years before A.D. 0001.
3687 * It would still fail for Feb 29, but we catch that one below.
3689 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3690 yearday -= YEAR_ADJUST;
3691 year = (yearday / DAYS_PER_QCENT) * 400;
3692 yearday %= DAYS_PER_QCENT;
3693 odd_cent = yearday / DAYS_PER_CENT;
3694 year += odd_cent * 100;
3695 yearday %= DAYS_PER_CENT;
3696 year += (yearday / DAYS_PER_QYEAR) * 4;
3697 yearday %= DAYS_PER_QYEAR;
3698 odd_year = yearday / DAYS_PER_YEAR;
3700 yearday %= DAYS_PER_YEAR;
3701 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3706 yearday += YEAR_ADJUST; /* recover March 1st crock */
3707 month = yearday*DAYS_TO_MONTH;
3708 yearday -= month*MONTH_TO_DAYS;
3709 /* recover other leap-year adjustment */
3718 ptm->tm_year = year - 1900;
3720 ptm->tm_mday = yearday;
3721 ptm->tm_mon = month;
3725 ptm->tm_mon = month - 1;
3727 /* re-build yearday based on Jan 1 to get tm_yday */
3729 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3730 yearday += 14*MONTH_TO_DAYS + 1;
3731 ptm->tm_yday = jday - yearday;
3732 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3736 Perl_my_strftime(pTHX_ const char *fmt, int sec, int min, int hour, int mday, int mon, int year, int wday, int yday, int isdst)
3740 /* strftime(), but with a different API so that the return value is a pointer
3741 * to the formatted result (which MUST be arranged to be FREED BY THE
3742 * CALLER). This allows this function to increase the buffer size as needed,
3743 * so that the caller doesn't have to worry about that.
3745 * Note that yday and wday effectively are ignored by this function, as
3746 * mini_mktime() overwrites them */
3753 PERL_ARGS_ASSERT_MY_STRFTIME;
3755 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3758 mytm.tm_hour = hour;
3759 mytm.tm_mday = mday;
3761 mytm.tm_year = year;
3762 mytm.tm_wday = wday;
3763 mytm.tm_yday = yday;
3764 mytm.tm_isdst = isdst;
3766 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3767 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3772 #ifdef HAS_TM_TM_GMTOFF
3773 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3775 #ifdef HAS_TM_TM_ZONE
3776 mytm.tm_zone = mytm2.tm_zone;
3781 Newx(buf, buflen, char);
3783 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3784 len = strftime(buf, buflen, fmt, &mytm);
3785 GCC_DIAG_RESTORE_STMT;
3788 ** The following is needed to handle to the situation where
3789 ** tmpbuf overflows. Basically we want to allocate a buffer
3790 ** and try repeatedly. The reason why it is so complicated
3791 ** is that getting a return value of 0 from strftime can indicate
3792 ** one of the following:
3793 ** 1. buffer overflowed,
3794 ** 2. illegal conversion specifier, or
3795 ** 3. the format string specifies nothing to be returned(not
3796 ** an error). This could be because format is an empty string
3797 ** or it specifies %p that yields an empty string in some locale.
3798 ** If there is a better way to make it portable, go ahead by
3801 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
3804 /* Possibly buf overflowed - try again with a bigger buf */
3805 const int fmtlen = strlen(fmt);
3806 int bufsize = fmtlen + buflen;
3808 Renew(buf, bufsize, char);
3811 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3812 buflen = strftime(buf, bufsize, fmt, &mytm);
3813 GCC_DIAG_RESTORE_STMT;
3815 if (buflen > 0 && buflen < bufsize)
3817 /* heuristic to prevent out-of-memory errors */
3818 if (bufsize > 100*fmtlen) {
3824 Renew(buf, bufsize, char);
3829 Perl_croak(aTHX_ "panic: no strftime");
3835 #define SV_CWD_RETURN_UNDEF \
3839 #define SV_CWD_ISDOT(dp) \
3840 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
3841 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
3844 =head1 Miscellaneous Functions
3846 =for apidoc getcwd_sv
3848 Fill C<sv> with current working directory
3853 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
3854 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
3855 * getcwd(3) if available
3856 * Comments from the original:
3857 * This is a faster version of getcwd. It's also more dangerous
3858 * because you might chdir out of a directory that you can't chdir
3862 Perl_getcwd_sv(pTHX_ SV *sv)
3867 PERL_ARGS_ASSERT_GETCWD_SV;
3871 char buf[MAXPATHLEN];
3873 /* Some getcwd()s automatically allocate a buffer of the given
3874 * size from the heap if they are given a NULL buffer pointer.
3875 * The problem is that this behaviour is not portable. */
3876 if (getcwd(buf, sizeof(buf) - 1)) {
3881 SV_CWD_RETURN_UNDEF;
3888 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
3892 SvUPGRADE(sv, SVt_PV);
3894 if (PerlLIO_lstat(".", &statbuf) < 0) {
3895 SV_CWD_RETURN_UNDEF;
3898 orig_cdev = statbuf.st_dev;
3899 orig_cino = statbuf.st_ino;
3909 if (PerlDir_chdir("..") < 0) {
3910 SV_CWD_RETURN_UNDEF;
3912 if (PerlLIO_stat(".", &statbuf) < 0) {
3913 SV_CWD_RETURN_UNDEF;
3916 cdev = statbuf.st_dev;
3917 cino = statbuf.st_ino;
3919 if (odev == cdev && oino == cino) {
3922 if (!(dir = PerlDir_open("."))) {
3923 SV_CWD_RETURN_UNDEF;
3926 while ((dp = PerlDir_read(dir)) != NULL) {
3928 namelen = dp->d_namlen;
3930 namelen = strlen(dp->d_name);
3933 if (SV_CWD_ISDOT(dp)) {
3937 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
3938 SV_CWD_RETURN_UNDEF;
3941 tdev = statbuf.st_dev;
3942 tino = statbuf.st_ino;
3943 if (tino == oino && tdev == odev) {
3949 SV_CWD_RETURN_UNDEF;
3952 if (pathlen + namelen + 1 >= MAXPATHLEN) {
3953 SV_CWD_RETURN_UNDEF;
3956 SvGROW(sv, pathlen + namelen + 1);
3960 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
3963 /* prepend current directory to the front */
3965 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
3966 pathlen += (namelen + 1);
3968 #ifdef VOID_CLOSEDIR
3971 if (PerlDir_close(dir) < 0) {
3972 SV_CWD_RETURN_UNDEF;
3978 SvCUR_set(sv, pathlen);
3982 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
3983 SV_CWD_RETURN_UNDEF;
3986 if (PerlLIO_stat(".", &statbuf) < 0) {
3987 SV_CWD_RETURN_UNDEF;
3990 cdev = statbuf.st_dev;
3991 cino = statbuf.st_ino;
3993 if (cdev != orig_cdev || cino != orig_cino) {
3994 Perl_croak(aTHX_ "Unstable directory path, "
3995 "current directory changed unexpectedly");
4008 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4009 # define EMULATE_SOCKETPAIR_UDP
4012 #ifdef EMULATE_SOCKETPAIR_UDP
4014 S_socketpair_udp (int fd[2]) {
4016 /* Fake a datagram socketpair using UDP to localhost. */
4017 int sockets[2] = {-1, -1};
4018 struct sockaddr_in addresses[2];
4020 Sock_size_t size = sizeof(struct sockaddr_in);
4021 unsigned short port;
4024 memset(&addresses, 0, sizeof(addresses));
4027 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4028 if (sockets[i] == -1)
4029 goto tidy_up_and_fail;
4031 addresses[i].sin_family = AF_INET;
4032 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4033 addresses[i].sin_port = 0; /* kernel choses port. */
4034 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4035 sizeof(struct sockaddr_in)) == -1)
4036 goto tidy_up_and_fail;
4039 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4040 for each connect the other socket to it. */
4043 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4045 goto tidy_up_and_fail;
4046 if (size != sizeof(struct sockaddr_in))
4047 goto abort_tidy_up_and_fail;
4048 /* !1 is 0, !0 is 1 */
4049 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4050 sizeof(struct sockaddr_in)) == -1)
4051 goto tidy_up_and_fail;
4054 /* Now we have 2 sockets connected to each other. I don't trust some other
4055 process not to have already sent a packet to us (by random) so send
4056 a packet from each to the other. */
4059 /* I'm going to send my own port number. As a short.
4060 (Who knows if someone somewhere has sin_port as a bitfield and needs
4061 this routine. (I'm assuming crays have socketpair)) */
4062 port = addresses[i].sin_port;
4063 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4064 if (got != sizeof(port)) {
4066 goto tidy_up_and_fail;
4067 goto abort_tidy_up_and_fail;
4071 /* Packets sent. I don't trust them to have arrived though.
4072 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4073 connect to localhost will use a second kernel thread. In 2.6 the
4074 first thread running the connect() returns before the second completes,
4075 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4076 returns 0. Poor programs have tripped up. One poor program's authors'
4077 had a 50-1 reverse stock split. Not sure how connected these were.)
4078 So I don't trust someone not to have an unpredictable UDP stack.
4082 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4083 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4087 FD_SET((unsigned int)sockets[0], &rset);
4088 FD_SET((unsigned int)sockets[1], &rset);
4090 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4091 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4092 || !FD_ISSET(sockets[1], &rset)) {
4093 /* I hope this is portable and appropriate. */
4095 goto tidy_up_and_fail;
4096 goto abort_tidy_up_and_fail;
4100 /* And the paranoia department even now doesn't trust it to have arrive
4101 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4103 struct sockaddr_in readfrom;
4104 unsigned short buffer[2];
4109 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4110 sizeof(buffer), MSG_DONTWAIT,
4111 (struct sockaddr *) &readfrom, &size);
4113 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4115 (struct sockaddr *) &readfrom, &size);
4119 goto tidy_up_and_fail;
4120 if (got != sizeof(port)
4121 || size != sizeof(struct sockaddr_in)
4122 /* Check other socket sent us its port. */
4123 || buffer[0] != (unsigned short) addresses[!i].sin_port
4124 /* Check kernel says we got the datagram from that socket */
4125 || readfrom.sin_family != addresses[!i].sin_family
4126 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4127 || readfrom.sin_port != addresses[!i].sin_port)
4128 goto abort_tidy_up_and_fail;
4131 /* My caller (my_socketpair) has validated that this is non-NULL */
4134 /* I hereby declare this connection open. May God bless all who cross
4138 abort_tidy_up_and_fail:
4139 errno = ECONNABORTED;
4143 if (sockets[0] != -1)
4144 PerlLIO_close(sockets[0]);
4145 if (sockets[1] != -1)
4146 PerlLIO_close(sockets[1]);
4151 #endif /* EMULATE_SOCKETPAIR_UDP */
4153 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4155 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4156 /* Stevens says that family must be AF_LOCAL, protocol 0.
4157 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4162 struct sockaddr_in listen_addr;
4163 struct sockaddr_in connect_addr;
4168 || family != AF_UNIX
4171 errno = EAFNOSUPPORT;
4180 type &= ~SOCK_CLOEXEC;
4183 #ifdef EMULATE_SOCKETPAIR_UDP
4184 if (type == SOCK_DGRAM)
4185 return S_socketpair_udp(fd);
4188 aTHXa(PERL_GET_THX);
4189 listener = PerlSock_socket(AF_INET, type, 0);
4192 memset(&listen_addr, 0, sizeof(listen_addr));
4193 listen_addr.sin_family = AF_INET;
4194 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4195 listen_addr.sin_port = 0; /* kernel choses port. */
4196 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4197 sizeof(listen_addr)) == -1)
4198 goto tidy_up_and_fail;
4199 if (PerlSock_listen(listener, 1) == -1)
4200 goto tidy_up_and_fail;
4202 connector = PerlSock_socket(AF_INET, type, 0);
4203 if (connector == -1)
4204 goto tidy_up_and_fail;
4205 /* We want to find out the port number to connect to. */
4206 size = sizeof(connect_addr);
4207 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4209 goto tidy_up_and_fail;
4210 if (size != sizeof(connect_addr))
4211 goto abort_tidy_up_and_fail;
4212 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4213 sizeof(connect_addr)) == -1)
4214 goto tidy_up_and_fail;
4216 size = sizeof(listen_addr);
4217 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4220 goto tidy_up_and_fail;
4221 if (size != sizeof(listen_addr))
4222 goto abort_tidy_up_and_fail;
4223 PerlLIO_close(listener);
4224 /* Now check we are talking to ourself by matching port and host on the
4226 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4228 goto tidy_up_and_fail;
4229 if (size != sizeof(connect_addr)
4230 || listen_addr.sin_family != connect_addr.sin_family
4231 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4232 || listen_addr.sin_port != connect_addr.sin_port) {
4233 goto abort_tidy_up_and_fail;
4239 abort_tidy_up_and_fail:
4241 errno = ECONNABORTED; /* This would be the standard thing to do. */
4242 #elif defined(ECONNREFUSED)
4243 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4245 errno = ETIMEDOUT; /* Desperation time. */
4251 PerlLIO_close(listener);
4252 if (connector != -1)
4253 PerlLIO_close(connector);
4255 PerlLIO_close(acceptor);
4261 /* In any case have a stub so that there's code corresponding
4262 * to the my_socketpair in embed.fnc. */
4264 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4265 #ifdef HAS_SOCKETPAIR
4266 return socketpair(family, type, protocol, fd);
4275 =for apidoc sv_nosharing
4277 Dummy routine which "shares" an SV when there is no sharing module present.
4278 Or "locks" it. Or "unlocks" it. In other
4279 words, ignores its single SV argument.
4280 Exists to avoid test for a C<NULL> function pointer and because it could
4281 potentially warn under some level of strict-ness.
4287 Perl_sv_nosharing(pTHX_ SV *sv)
4289 PERL_UNUSED_CONTEXT;
4290 PERL_UNUSED_ARG(sv);
4295 =for apidoc sv_destroyable
4297 Dummy routine which reports that object can be destroyed when there is no
4298 sharing module present. It ignores its single SV argument, and returns
4299 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4300 could potentially warn under some level of strict-ness.
4306 Perl_sv_destroyable(pTHX_ SV *sv)
4308 PERL_UNUSED_CONTEXT;
4309 PERL_UNUSED_ARG(sv);
4314 Perl_parse_unicode_opts(pTHX_ const char **popt)
4316 const char *p = *popt;
4319 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4325 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4328 if (p && *p && *p != '\n' && *p != '\r') {
4330 goto the_end_of_the_opts_parser;
4332 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4336 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4342 case PERL_UNICODE_STDIN:
4343 opt |= PERL_UNICODE_STDIN_FLAG; break;
4344 case PERL_UNICODE_STDOUT:
4345 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4346 case PERL_UNICODE_STDERR:
4347 opt |= PERL_UNICODE_STDERR_FLAG; break;
4348 case PERL_UNICODE_STD:
4349 opt |= PERL_UNICODE_STD_FLAG; break;
4350 case PERL_UNICODE_IN:
4351 opt |= PERL_UNICODE_IN_FLAG; break;
4352 case PERL_UNICODE_OUT:
4353 opt |= PERL_UNICODE_OUT_FLAG; break;
4354 case PERL_UNICODE_INOUT:
4355 opt |= PERL_UNICODE_INOUT_FLAG; break;
4356 case PERL_UNICODE_LOCALE:
4357 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4358 case PERL_UNICODE_ARGV:
4359 opt |= PERL_UNICODE_ARGV_FLAG; break;
4360 case PERL_UNICODE_UTF8CACHEASSERT:
4361 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4363 if (*p != '\n' && *p != '\r') {
4364 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4367 "Unknown Unicode option letter '%c'", *p);
4374 opt = PERL_UNICODE_DEFAULT_FLAGS;
4376 the_end_of_the_opts_parser:
4378 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4379 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4380 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4388 # include <starlet.h>
4395 * This is really just a quick hack which grabs various garbage
4396 * values. It really should be a real hash algorithm which
4397 * spreads the effect of every input bit onto every output bit,
4398 * if someone who knows about such things would bother to write it.
4399 * Might be a good idea to add that function to CORE as well.
4400 * No numbers below come from careful analysis or anything here,
4401 * except they are primes and SEED_C1 > 1E6 to get a full-width
4402 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4403 * probably be bigger too.
4406 # define SEED_C1 1000003
4407 #define SEED_C4 73819
4409 # define SEED_C1 25747
4410 #define SEED_C4 20639
4414 #define SEED_C5 26107
4416 #ifndef PERL_NO_DEV_RANDOM
4420 #ifdef HAS_GETTIMEOFDAY
4421 struct timeval when;
4426 /* This test is an escape hatch, this symbol isn't set by Configure. */
4427 #ifndef PERL_NO_DEV_RANDOM
4428 #ifndef PERL_RANDOM_DEVICE
4429 /* /dev/random isn't used by default because reads from it will block
4430 * if there isn't enough entropy available. You can compile with
4431 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4432 * is enough real entropy to fill the seed. */
4433 # ifdef __amigaos4__
4434 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4436 # define PERL_RANDOM_DEVICE "/dev/urandom"
4439 fd = PerlLIO_open_cloexec(PERL_RANDOM_DEVICE, 0);
4441 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4449 #ifdef HAS_GETTIMEOFDAY
4450 PerlProc_gettimeofday(&when,NULL);
4451 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4454 u = (U32)SEED_C1 * when;
4456 u += SEED_C3 * (U32)PerlProc_getpid();
4457 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4458 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4459 u += SEED_C5 * (U32)PTR2UV(&when);
4465 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4467 #ifndef NO_PERL_HASH_ENV
4472 PERL_ARGS_ASSERT_GET_HASH_SEED;
4474 #ifndef NO_PERL_HASH_ENV
4475 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4479 /* ignore leading spaces */
4480 while (isSPACE(*env_pv))
4482 # ifdef USE_PERL_PERTURB_KEYS
4483 /* if they set it to "0" we disable key traversal randomization completely */
4484 if (strEQ(env_pv,"0")) {
4485 PL_hash_rand_bits_enabled= 0;
4487 /* otherwise switch to deterministic mode */
4488 PL_hash_rand_bits_enabled= 2;
4491 /* ignore a leading 0x... if it is there */
4492 if (env_pv[0] == '0' && env_pv[1] == 'x')
4495 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4496 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4497 if ( isXDIGIT(*env_pv)) {
4498 seed_buffer[i] |= READ_XDIGIT(env_pv);
4501 while (isSPACE(*env_pv))
4504 if (*env_pv && !isXDIGIT(*env_pv)) {
4505 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4507 /* should we check for unparsed crap? */
4508 /* should we warn about unused hex? */
4509 /* should we warn about insufficient hex? */
4512 #endif /* NO_PERL_HASH_ENV */
4514 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4515 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
4518 #ifdef USE_PERL_PERTURB_KEYS
4519 { /* initialize PL_hash_rand_bits from the hash seed.
4520 * This value is highly volatile, it is updated every
4521 * hash insert, and is used as part of hash bucket chain
4522 * randomization and hash iterator randomization. */
4523 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4524 for( i = 0; i < sizeof(UV) ; i++ ) {
4525 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4526 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4529 # ifndef NO_PERL_HASH_ENV
4530 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4532 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4533 PL_hash_rand_bits_enabled= 0;
4534 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4535 PL_hash_rand_bits_enabled= 1;
4536 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4537 PL_hash_rand_bits_enabled= 2;
4539 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4546 #ifdef PERL_GLOBAL_STRUCT
4548 #define PERL_GLOBAL_STRUCT_INIT
4549 #include "opcode.h" /* the ppaddr and check */
4552 Perl_init_global_struct(pTHX)
4554 struct perl_vars *plvarsp = NULL;
4555 # ifdef PERL_GLOBAL_STRUCT
4556 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4557 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4558 PERL_UNUSED_CONTEXT;
4559 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4560 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4561 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4565 plvarsp = PL_VarsPtr;
4566 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4571 # define PERLVAR(prefix,var,type) /**/
4572 # define PERLVARA(prefix,var,n,type) /**/
4573 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4574 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4575 # include "perlvars.h"
4580 # ifdef PERL_GLOBAL_STRUCT
4583 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4584 if (!plvarsp->Gppaddr)
4588 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4589 if (!plvarsp->Gcheck)
4591 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4592 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4594 # ifdef PERL_SET_VARS
4595 PERL_SET_VARS(plvarsp);
4597 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4598 plvarsp->Gsv_placeholder.sv_flags = 0;
4599 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4601 # undef PERL_GLOBAL_STRUCT_INIT
4606 #endif /* PERL_GLOBAL_STRUCT */
4608 #ifdef PERL_GLOBAL_STRUCT
4611 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4613 int veto = plvarsp->Gveto_cleanup;
4615 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4616 PERL_UNUSED_CONTEXT;
4617 # ifdef PERL_GLOBAL_STRUCT
4618 # ifdef PERL_UNSET_VARS
4619 PERL_UNSET_VARS(plvarsp);
4623 free(plvarsp->Gppaddr);
4624 free(plvarsp->Gcheck);
4625 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4631 #endif /* PERL_GLOBAL_STRUCT */
4635 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4636 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4637 * given, and you supply your own implementation.
4639 * The default implementation reads a single env var, PERL_MEM_LOG,
4640 * expecting one or more of the following:
4642 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4643 * 'm' - memlog was PERL_MEM_LOG=1
4644 * 's' - svlog was PERL_SV_LOG=1
4645 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4647 * This makes the logger controllable enough that it can reasonably be
4648 * added to the system perl.
4651 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4652 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4654 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4656 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4657 * writes to. In the default logger, this is settable at runtime.
4659 #ifndef PERL_MEM_LOG_FD
4660 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4663 #ifndef PERL_MEM_LOG_NOIMPL
4665 # ifdef DEBUG_LEAKING_SCALARS
4666 # define SV_LOG_SERIAL_FMT " [%lu]"
4667 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4669 # define SV_LOG_SERIAL_FMT
4670 # define _SV_LOG_SERIAL_ARG(sv)
4674 S_mem_log_common(enum mem_log_type mlt, const UV n,
4675 const UV typesize, const char *type_name, const SV *sv,
4676 Malloc_t oldalloc, Malloc_t newalloc,
4677 const char *filename, const int linenumber,
4678 const char *funcname)
4682 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4684 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4687 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4689 /* We can't use SVs or PerlIO for obvious reasons,
4690 * so we'll use stdio and low-level IO instead. */
4691 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4693 # ifdef HAS_GETTIMEOFDAY
4694 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4695 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4697 gettimeofday(&tv, 0);
4699 # define MEM_LOG_TIME_FMT "%10d: "
4700 # define MEM_LOG_TIME_ARG (int)when
4704 /* If there are other OS specific ways of hires time than
4705 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4706 * probably that they would be used to fill in the struct
4713 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4714 && uv && uv <= PERL_INT_MAX
4718 fd = PERL_MEM_LOG_FD;
4721 if (strchr(pmlenv, 't')) {
4722 len = my_snprintf(buf, sizeof(buf),
4723 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4724 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4728 len = my_snprintf(buf, sizeof(buf),
4729 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4730 " %s = %" IVdf ": %" UVxf "\n",
4731 filename, linenumber, funcname, n, typesize,
4732 type_name, n * typesize, PTR2UV(newalloc));
4735 len = my_snprintf(buf, sizeof(buf),
4736 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4737 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4738 filename, linenumber, funcname, n, typesize,
4739 type_name, n * typesize, PTR2UV(oldalloc),
4743 len = my_snprintf(buf, sizeof(buf),
4744 "free: %s:%d:%s: %" UVxf "\n",
4745 filename, linenumber, funcname,
4750 len = my_snprintf(buf, sizeof(buf),
4751 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
4752 mlt == MLT_NEW_SV ? "new" : "del",
4753 filename, linenumber, funcname,
4754 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4759 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4763 #endif /* !PERL_MEM_LOG_NOIMPL */
4765 #ifndef PERL_MEM_LOG_NOIMPL
4767 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4768 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4770 /* this is suboptimal, but bug compatible. User is providing their
4771 own implementation, but is getting these functions anyway, and they
4772 do nothing. But _NOIMPL users should be able to cope or fix */
4774 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4775 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
4779 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4781 const char *filename, const int linenumber,
4782 const char *funcname)
4784 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
4786 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4787 NULL, NULL, newalloc,
4788 filename, linenumber, funcname);
4793 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4794 Malloc_t oldalloc, Malloc_t newalloc,
4795 const char *filename, const int linenumber,
4796 const char *funcname)
4798 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
4800 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4801 NULL, oldalloc, newalloc,
4802 filename, linenumber, funcname);
4807 Perl_mem_log_free(Malloc_t oldalloc,
4808 const char *filename, const int linenumber,
4809 const char *funcname)
4811 PERL_ARGS_ASSERT_MEM_LOG_FREE;
4813 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4814 filename, linenumber, funcname);
4819 Perl_mem_log_new_sv(const SV *sv,
4820 const char *filename, const int linenumber,
4821 const char *funcname)
4823 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4824 filename, linenumber, funcname);
4828 Perl_mem_log_del_sv(const SV *sv,
4829 const char *filename, const int linenumber,
4830 const char *funcname)
4832 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4833 filename, linenumber, funcname);
4836 #endif /* PERL_MEM_LOG */
4839 =for apidoc quadmath_format_single
4841 C<quadmath_snprintf()> is very strict about its C<format> string and will
4842 fail, returning -1, if the format is invalid. It accepts exactly
4845 C<quadmath_format_single()> checks that the intended single spec looks
4846 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
4847 and has C<Q> before it. This is not a full "printf syntax check",
4850 Returns the format if it is valid, NULL if not.
4852 C<quadmath_format_single()> can and will actually patch in the missing
4853 C<Q>, if necessary. In this case it will return the modified copy of
4854 the format, B<which the caller will need to free.>
4856 See also L</quadmath_format_needed>.
4862 Perl_quadmath_format_single(const char* format)
4866 PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
4868 if (format[0] != '%' || strchr(format + 1, '%'))
4870 len = strlen(format);
4871 /* minimum length three: %Qg */
4872 if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
4874 if (format[len - 2] != 'Q') {
4876 Newx(fixed, len + 1, char);
4877 memcpy(fixed, format, len - 1);
4878 fixed[len - 1] = 'Q';
4879 fixed[len ] = format[len - 1];
4881 return (const char*)fixed;
4888 =for apidoc quadmath_format_needed
4890 C<quadmath_format_needed()> returns true if the C<format> string seems to
4891 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
4892 or returns false otherwise.
4894 The format specifier detection is not complete printf-syntax detection,
4895 but it should catch most common cases.
4897 If true is returned, those arguments B<should> in theory be processed
4898 with C<quadmath_snprintf()>, but in case there is more than one such
4899 format specifier (see L</quadmath_format_single>), and if there is
4900 anything else beyond that one (even just a single byte), they
4901 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
4902 accepting only one format spec, and nothing else.
4903 In this case, the code should probably fail.
4909 Perl_quadmath_format_needed(const char* format)
4911 const char *p = format;
4914 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
4916 while ((q = strchr(p, '%'))) {
4918 if (*q == '+') /* plus */
4920 if (*q == '#') /* alt */
4922 if (*q == '*') /* width */
4926 while (isDIGIT(*q)) q++;
4929 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
4934 while (isDIGIT(*q)) q++;
4936 if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
4945 =for apidoc my_snprintf
4947 The C library C<snprintf> functionality, if available and
4948 standards-compliant (uses C<vsnprintf>, actually). However, if the
4949 C<vsnprintf> is not available, will unfortunately use the unsafe
4950 C<vsprintf> which can overrun the buffer (there is an overrun check,
4951 but that may be too late). Consider using C<sv_vcatpvf> instead, or
4952 getting C<vsnprintf>.
4957 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
4961 PERL_ARGS_ASSERT_MY_SNPRINTF;
4962 #ifndef HAS_VSNPRINTF
4963 PERL_UNUSED_VAR(len);
4965 va_start(ap, format);
4968 const char* qfmt = quadmath_format_single(format);
4969 bool quadmath_valid = FALSE;
4971 /* If the format looked promising, use it as quadmath. */
4972 retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
4974 if (qfmt != format) {
4978 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
4980 quadmath_valid = TRUE;
4985 assert(qfmt == NULL);
4986 /* quadmath_format_single() will return false for example for
4987 * "foo = %g", or simply "%g". We could handle the %g by
4988 * using quadmath for the NV args. More complex cases of
4989 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
4990 * quadmath-valid but has stuff in front).
4992 * Handling the "Q-less" cases right would require walking
4993 * through the va_list and rewriting the format, calling
4994 * quadmath for the NVs, building a new va_list, and then
4995 * letting vsnprintf/vsprintf to take care of the other
4996 * arguments. This may be doable.
4998 * We do not attempt that now. But for paranoia, we here try
4999 * to detect some common (but not all) cases where the
5000 * "Q-less" %[efgaEFGA] formats are present, and die if
5001 * detected. This doesn't fix the problem, but it stops the
5002 * vsnprintf/vsprintf pulling doubles off the va_list when
5003 * __float128 NVs should be pulled off instead.
5005 * If quadmath_format_needed() returns false, we are reasonably
5006 * certain that we can call vnsprintf() or vsprintf() safely. */
5007 if (!quadmath_valid && quadmath_format_needed(format))
5008 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5013 #ifdef HAS_VSNPRINTF
5014 retval = vsnprintf(buffer, len, format, ap);
5016 retval = vsprintf(buffer, format, ap);
5019 /* vsprintf() shows failure with < 0 */
5021 #ifdef HAS_VSNPRINTF
5022 /* vsnprintf() shows failure with >= len */
5024 (len > 0 && (Size_t)retval >= len)
5027 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5032 =for apidoc my_vsnprintf
5034 The C library C<vsnprintf> if available and standards-compliant.
5035 However, if if the C<vsnprintf> is not available, will unfortunately
5036 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5037 overrun check, but that may be too late). Consider using
5038 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5043 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5046 PERL_UNUSED_ARG(buffer);
5047 PERL_UNUSED_ARG(len);
5048 PERL_UNUSED_ARG(format);
5049 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5050 PERL_UNUSED_ARG((void*)ap);
5051 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5058 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5059 Perl_va_copy(ap, apc);
5060 # ifdef HAS_VSNPRINTF
5061 retval = vsnprintf(buffer, len, format, apc);
5063 PERL_UNUSED_ARG(len);
5064 retval = vsprintf(buffer, format, apc);
5068 # ifdef HAS_VSNPRINTF
5069 retval = vsnprintf(buffer, len, format, ap);
5071 PERL_UNUSED_ARG(len);
5072 retval = vsprintf(buffer, format, ap);
5074 #endif /* #ifdef NEED_VA_COPY */
5075 /* vsprintf() shows failure with < 0 */
5077 #ifdef HAS_VSNPRINTF
5078 /* vsnprintf() shows failure with >= len */
5080 (len > 0 && (Size_t)retval >= len)
5083 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5089 Perl_my_clearenv(pTHX)
5092 #if ! defined(PERL_MICRO)
5093 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5095 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5096 # if defined(USE_ENVIRON_ARRAY)
5097 # if defined(USE_ITHREADS)
5098 /* only the parent thread can clobber the process environment */
5099 if (PL_curinterp == aTHX)
5100 # endif /* USE_ITHREADS */
5102 # if ! defined(PERL_USE_SAFE_PUTENV)
5103 if ( !PL_use_safe_putenv) {
5105 if (environ == PL_origenviron)
5106 environ = (char**)safesysmalloc(sizeof(char*));
5108 for (i = 0; environ[i]; i++)
5109 (void)safesysfree(environ[i]);
5112 # else /* PERL_USE_SAFE_PUTENV */
5113 # if defined(HAS_CLEARENV)
5115 # elif defined(HAS_UNSETENV)
5116 int bsiz = 80; /* Most envvar names will be shorter than this. */
5117 char *buf = (char*)safesysmalloc(bsiz);
5118 while (*environ != NULL) {
5119 char *e = strchr(*environ, '=');
5120 int l = e ? e - *environ : (int)strlen(*environ);
5122 (void)safesysfree(buf);
5123 bsiz = l + 1; /* + 1 for the \0. */
5124 buf = (char*)safesysmalloc(bsiz);
5126 memcpy(buf, *environ, l);
5128 (void)unsetenv(buf);
5130 (void)safesysfree(buf);
5131 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5132 /* Just null environ and accept the leakage. */
5134 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5135 # endif /* ! PERL_USE_SAFE_PUTENV */
5137 # endif /* USE_ENVIRON_ARRAY */
5138 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5139 #endif /* PERL_MICRO */
5142 #ifdef PERL_IMPLICIT_CONTEXT
5144 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5145 the global PL_my_cxt_index is incremented, and that value is assigned to
5146 that module's static my_cxt_index (who's address is passed as an arg).
5147 Then, for each interpreter this function is called for, it makes sure a
5148 void* slot is available to hang the static data off, by allocating or
5149 extending the interpreter's PL_my_cxt_list array */
5151 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
5153 Perl_my_cxt_init(pTHX_ int *index, size_t size)
5157 PERL_ARGS_ASSERT_MY_CXT_INIT;
5159 /* this module hasn't been allocated an index yet */
5160 MUTEX_LOCK(&PL_my_ctx_mutex);
5161 *index = PL_my_cxt_index++;
5162 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5165 /* make sure the array is big enough */
5166 if (PL_my_cxt_size <= *index) {
5167 if (PL_my_cxt_size) {
5168 IV new_size = PL_my_cxt_size;
5169 while (new_size <= *index)
5171 Renew(PL_my_cxt_list, new_size, void *);
5172 PL_my_cxt_size = new_size;
5175 PL_my_cxt_size = 16;
5176 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5179 /* newSV() allocates one more than needed */
5180 p = (void*)SvPVX(newSV(size-1));
5181 PL_my_cxt_list[*index] = p;
5182 Zero(p, size, char);
5186 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5189 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5194 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5196 for (index = 0; index < PL_my_cxt_index; index++) {
5197 const char *key = PL_my_cxt_keys[index];
5198 /* try direct pointer compare first - there are chances to success,
5199 * and it's much faster.
5201 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5208 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5214 PERL_ARGS_ASSERT_MY_CXT_INIT;
5216 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5218 /* this module hasn't been allocated an index yet */
5219 MUTEX_LOCK(&PL_my_ctx_mutex);
5220 index = PL_my_cxt_index++;
5221 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5224 /* make sure the array is big enough */
5225 if (PL_my_cxt_size <= index) {
5226 int old_size = PL_my_cxt_size;
5228 if (PL_my_cxt_size) {
5229 IV new_size = PL_my_cxt_size;
5230 while (new_size <= index)
5232 Renew(PL_my_cxt_list, new_size, void *);
5233 Renew(PL_my_cxt_keys, new_size, const char *);
5234 PL_my_cxt_size = new_size;
5237 PL_my_cxt_size = 16;
5238 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5239 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5241 for (i = old_size; i < PL_my_cxt_size; i++) {
5242 PL_my_cxt_keys[i] = 0;
5243 PL_my_cxt_list[i] = 0;
5246 PL_my_cxt_keys[index] = my_cxt_key;
5247 /* newSV() allocates one more than needed */
5248 p = (void*)SvPVX(newSV(size-1));
5249 PL_my_cxt_list[index] = p;
5250 Zero(p, size, char);
5253 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5254 #endif /* PERL_IMPLICIT_CONTEXT */
5257 /* Perl_xs_handshake():
5258 implement the various XS_*_BOOTCHECK macros, which are added to .c
5259 files by ExtUtils::ParseXS, to check that the perl the module was built
5260 with is binary compatible with the running perl.
5263 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5264 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5266 The meaning of the varargs is determined the U32 key arg (which is not
5267 a format string). The fields of key are assembled by using HS_KEY().
5269 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5270 "PerlInterpreter *" and represents the callers context; otherwise it is
5271 of type "CV *", and is the boot xsub's CV.
5273 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5274 for example, and IO.dll was linked with threaded perl524.dll, and both
5275 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5276 successfully can load IO.dll into the process but simultaneously it
5277 loaded an interpreter of a different version into the process, and XS
5278 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5279 use through perl526.dll's my_perl->Istack_base.
5281 v_my_perl cannot be the first arg, since then 'key' will be out of
5282 place in a threaded vs non-threaded mixup; and analyzing the key
5283 number's bitfields won't reveal the problem, since it will be a valid
5284 key (unthreaded perl) on interp side, but croak will report the XS mod's
5285 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5286 it's a threaded perl and an unthreaded XS module, threaded perl will
5287 look at an uninit C stack or an uninit register to get 'key'
5288 (remember that it assumes that the 1st arg is the interp cxt).
5290 'file' is the source filename of the caller.
5294 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5300 #ifdef PERL_IMPLICIT_CONTEXT
5307 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5308 va_start(args, file);
5310 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5311 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5312 if (UNLIKELY(got != need))
5314 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5315 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5316 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5317 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5318 passed to the XS DLL */
5319 #ifdef PERL_IMPLICIT_CONTEXT
5320 xs_interp = (tTHX)v_my_perl;
5324 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5325 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5326 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5327 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5328 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5329 location in the unthreaded perl binary) stored in CV * to figure out if this
5330 Perl_xs_handshake was called by the same pp_entersub */
5331 cv = (CV*)v_my_perl;
5332 xs_spp = (SV***)CvHSCXT(cv);
5334 need = &PL_stack_sp;
5336 if(UNLIKELY(got != need)) {
5337 bad_handshake:/* recycle branch and string from above */
5338 if(got != (void *)HSf_NOCHK)
5339 noperl_die("%s: loadable library and perl binaries are mismatched"
5340 " (got handshake key %p, needed %p)\n",
5344 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5345 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5346 PL_xsubfilename = file; /* so the old name must be restored for
5347 additional XSUBs to register themselves */
5348 /* XSUBs can't be perl lang/perl5db.pl debugged
5349 if (PERLDB_LINE_OR_SAVESRC)
5350 (void)gv_fetchfile(file); */
5353 if(key & HSf_POPMARK) {
5355 { SV **mark = PL_stack_base + ax++;
5357 items = (I32)(SP - MARK);
5361 items = va_arg(args, U32);
5362 ax = va_arg(args, U32);
5366 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5367 if((apiverlen = HS_GETAPIVERLEN(key))) {
5368 char * api_p = va_arg(args, char*);
5369 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5370 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5371 sizeof("v" PERL_API_VERSION_STRING)-1))
5372 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5373 api_p, SVfARG(PL_stack_base[ax + 0]),
5374 "v" PERL_API_VERSION_STRING);
5379 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5380 if((xsverlen = HS_GETXSVERLEN(key)))
5381 S_xs_version_bootcheck(aTHX_
5382 items, ax, va_arg(args, char*), xsverlen);
5390 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5394 const char *vn = NULL;
5395 SV *const module = PL_stack_base[ax];
5397 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5399 if (items >= 2) /* version supplied as bootstrap arg */
5400 sv = PL_stack_base[ax + 1];
5402 /* XXX GV_ADDWARN */
5404 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5405 if (!sv || !SvOK(sv)) {
5407 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5411 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5412 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5413 ? sv : sv_2mortal(new_version(sv));
5414 xssv = upg_version(xssv, 0);
5415 if ( vcmp(pmsv,xssv) ) {
5416 SV *string = vstringify(xssv);
5417 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5418 " does not match ", SVfARG(module), SVfARG(string));
5420 SvREFCNT_dec(string);
5421 string = vstringify(pmsv);
5424 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5427 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5429 SvREFCNT_dec(string);
5431 Perl_sv_2mortal(aTHX_ xpt);
5432 Perl_croak_sv(aTHX_ xpt);
5438 =for apidoc my_strlcat
5440 The C library C<strlcat> if available, or a Perl implementation of it.
5441 This operates on C C<NUL>-terminated strings.
5443 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5444 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5445 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5446 practice this should not happen as it means that either C<size> is incorrect or
5447 that C<dst> is not a proper C<NUL>-terminated string).
5449 Note that C<size> is the full size of the destination buffer and
5450 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5451 room for the C<NUL> should be included in C<size>.
5453 The return value is the total length that C<dst> would have if C<size> is
5454 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5455 C<src>. If C<size> is smaller than the return, the excess was not appended.
5459 Description stolen from http://man.openbsd.org/strlcat.3
5463 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5465 Size_t used, length, copy;
5468 length = strlen(src);
5469 if (size > 0 && used < size - 1) {
5470 copy = (length >= size - used) ? size - used - 1 : length;
5471 memcpy(dst + used, src, copy);
5472 dst[used + copy] = '\0';
5474 return used + length;
5480 =for apidoc my_strlcpy
5482 The C library C<strlcpy> if available, or a Perl implementation of it.
5483 This operates on C C<NUL>-terminated strings.
5485 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5486 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5488 The return value is the total length C<src> would be if the copy completely
5489 succeeded. If it is larger than C<size>, the excess was not copied.
5493 Description stolen from http://man.openbsd.org/strlcpy.3
5497 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5499 Size_t length, copy;
5501 length = strlen(src);
5503 copy = (length >= size) ? size - 1 : length;
5504 memcpy(dst, src, copy);
5512 =for apidoc my_strnlen
5514 The C library C<strnlen> if available, or a Perl implementation of it.
5516 C<my_strnlen()> computes the length of the string, up to C<maxlen>
5517 characters. It will will never attempt to address more than C<maxlen>
5518 characters, making it suitable for use with strings that are not
5519 guaranteed to be NUL-terminated.
5523 Description stolen from http://man.openbsd.org/strnlen.3,
5524 implementation stolen from PostgreSQL.
5528 Perl_my_strnlen(const char *str, Size_t maxlen)
5530 const char *p = str;
5532 PERL_ARGS_ASSERT_MY_STRNLEN;
5534 while(maxlen-- && *p)
5541 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5542 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5543 long _ftol( double ); /* Defined by VC6 C libs. */
5544 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5547 PERL_STATIC_INLINE bool
5548 S_gv_has_usable_name(pTHX_ GV *gv)
5552 && HvENAME(GvSTASH(gv))
5553 && (gvp = (GV **)hv_fetchhek(
5554 GvSTASH(gv), GvNAME_HEK(gv), 0
5560 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5562 SV * const dbsv = GvSVn(PL_DBsub);
5563 const bool save_taint = TAINT_get;
5565 /* When we are called from pp_goto (svp is null),
5566 * we do not care about using dbsv to call CV;
5567 * it's for informational purposes only.
5570 PERL_ARGS_ASSERT_GET_DB_SUB;
5574 if (!PERLDB_SUB_NN) {
5577 if (!svp && !CvLEXICAL(cv)) {
5578 gv_efullname3(dbsv, gv, NULL);
5580 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5581 || strEQ(GvNAME(gv), "END")
5582 || ( /* Could be imported, and old sub redefined. */
5583 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5585 !( (SvTYPE(*svp) == SVt_PVGV)
5586 && (GvCV((const GV *)*svp) == cv)
5587 /* Use GV from the stack as a fallback. */
5588 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5592 /* GV is potentially non-unique, or contain different CV. */
5593 SV * const tmp = newRV(MUTABLE_SV(cv));
5594 sv_setsv(dbsv, tmp);
5598 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5599 sv_catpvs(dbsv, "::");
5600 sv_cathek(dbsv, GvNAME_HEK(gv));
5604 const int type = SvTYPE(dbsv);
5605 if (type < SVt_PVIV && type != SVt_IV)
5606 sv_upgrade(dbsv, SVt_PVIV);
5607 (void)SvIOK_on(dbsv);
5608 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5611 TAINT_IF(save_taint);
5612 #ifdef NO_TAINT_SUPPORT
5613 PERL_UNUSED_VAR(save_taint);
5618 Perl_my_dirfd(DIR * dir) {
5620 /* Most dirfd implementations have problems when passed NULL. */
5625 #elif defined(HAS_DIR_DD_FD)
5628 Perl_croak_nocontext(PL_no_func, "dirfd");
5629 NOT_REACHED; /* NOTREACHED */
5634 #if !defined(HAS_MKOSTEMP) || !defined(HAS_MKSTEMP)
5636 #define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
5637 #define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
5640 S_my_mkostemp(char *templte, int flags) {
5642 STRLEN len = strlen(templte);
5647 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
5648 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
5649 SETERRNO(EINVAL, LIB_INVARG);
5655 for (i = 1; i <= 6; ++i) {
5656 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
5658 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600);
5659 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
5666 #ifndef HAS_MKOSTEMP
5668 Perl_my_mkostemp(char *templte, int flags)
5670 PERL_ARGS_ASSERT_MY_MKOSTEMP;
5671 return S_my_mkostemp(templte, flags);
5677 Perl_my_mkstemp(char *templte)
5679 PERL_ARGS_ASSERT_MY_MKSTEMP;
5680 return S_my_mkostemp(templte, 0);
5685 Perl_get_re_arg(pTHX_ SV *sv) {
5691 sv = MUTABLE_SV(SvRV(sv));
5692 if (SvTYPE(sv) == SVt_REGEXP)
5693 return (REGEXP*) sv;
5700 * This code is derived from drand48() implementation from FreeBSD,
5701 * found in lib/libc/gen/_rand48.c.
5703 * The U64 implementation is original, based on the POSIX
5704 * specification for drand48().
5708 * Copyright (c) 1993 Martin Birgmeier
5709 * All rights reserved.
5711 * You may redistribute unmodified or modified versions of this source
5712 * code provided that the above copyright notice and this and the
5713 * following conditions are retained.
5715 * This software is provided ``as is'', and comes with no warranties
5716 * of any kind. I shall in no event be liable for anything that happens
5717 * to anyone/anything when using this software.
5720 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5722 #ifdef PERL_DRAND48_QUAD
5724 #define DRAND48_MULT UINT64_C(0x5deece66d)
5725 #define DRAND48_ADD 0xb
5726 #define DRAND48_MASK UINT64_C(0xffffffffffff)
5730 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5731 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5732 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5733 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5734 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5735 #define FREEBSD_DRAND48_ADD (0x000b)
5737 const unsigned short _rand48_mult[3] = {
5738 FREEBSD_DRAND48_MULT_0,
5739 FREEBSD_DRAND48_MULT_1,
5740 FREEBSD_DRAND48_MULT_2
5742 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5747 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5749 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5751 #ifdef PERL_DRAND48_QUAD
5752 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5754 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5755 random_state->seed[1] = (U16) seed;
5756 random_state->seed[2] = (U16) (seed >> 16);
5761 Perl_drand48_r(perl_drand48_t *random_state)
5763 PERL_ARGS_ASSERT_DRAND48_R;
5765 #ifdef PERL_DRAND48_QUAD
5766 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5769 return ldexp((double)*random_state, -48);
5775 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5776 + (U32) _rand48_add;
5777 temp[0] = (U16) accu; /* lower 16 bits */
5778 accu >>= sizeof(U16) * 8;
5779 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5780 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5781 temp[1] = (U16) accu; /* middle 16 bits */
5782 accu >>= sizeof(U16) * 8;
5783 accu += _rand48_mult[0] * random_state->seed[2]
5784 + _rand48_mult[1] * random_state->seed[1]
5785 + _rand48_mult[2] * random_state->seed[0];
5786 random_state->seed[0] = temp[0];
5787 random_state->seed[1] = temp[1];
5788 random_state->seed[2] = (U16) accu;
5790 return ldexp((double) random_state->seed[0], -48) +
5791 ldexp((double) random_state->seed[1], -32) +
5792 ldexp((double) random_state->seed[2], -16);
5797 #ifdef USE_C_BACKTRACE
5799 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5804 /* abfd is the BFD handle. */
5806 /* bfd_syms is the BFD symbol table. */
5808 /* bfd_text is handle to the the ".text" section of the object file. */
5810 /* Since opening the executable and scanning its symbols is quite
5811 * heavy operation, we remember the filename we used the last time,
5812 * and do the opening and scanning only if the filename changes.
5813 * This removes most (but not all) open+scan cycles. */
5814 const char* fname_prev;
5817 /* Given a dl_info, update the BFD context if necessary. */
5818 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5820 /* BFD open and scan only if the filename changed. */
5821 if (ctx->fname_prev == NULL ||
5822 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5824 bfd_close(ctx->abfd);
5826 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5828 if (bfd_check_format(ctx->abfd, bfd_object)) {
5829 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5830 if (symbol_size > 0) {
5831 Safefree(ctx->bfd_syms);
5832 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5834 bfd_get_section_by_name(ctx->abfd, ".text");
5842 ctx->fname_prev = dl_info->dli_fname;
5846 /* Given a raw frame, try to symbolize it and store
5847 * symbol information (source file, line number) away. */
5848 static void bfd_symbolize(bfd_context* ctx,
5851 STRLEN* symbol_name_size,
5853 STRLEN* source_name_size,
5854 STRLEN* source_line)
5856 *symbol_name = NULL;
5857 *symbol_name_size = 0;
5859 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5861 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5864 unsigned int line = 0;
5865 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5866 ctx->bfd_syms, offset,
5867 &file, &func, &line) &&
5868 file && func && line > 0) {
5869 /* Size and copy the source file, use only
5870 * the basename of the source file.
5872 * NOTE: the basenames are fine for the
5873 * Perl source files, but may not always
5874 * be the best idea for XS files. */
5875 const char *p, *b = NULL;
5876 /* Look for the last slash. */
5877 for (p = file; *p; p++) {
5881 if (b == NULL || *b == 0) {
5884 *source_name_size = p - b + 1;
5885 Newx(*source_name, *source_name_size + 1, char);
5886 Copy(b, *source_name, *source_name_size + 1, char);
5888 *symbol_name_size = strlen(func);
5889 Newx(*symbol_name, *symbol_name_size + 1, char);
5890 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5892 *source_line = line;
5898 #endif /* #ifdef USE_BFD */
5902 /* OS X has no public API for for 'symbolicating' (Apple official term)
5903 * stack addresses to {function_name, source_file, line_number}.
5904 * Good news: there is command line utility atos(1) which does that.
5905 * Bad news 1: it's a command line utility.
5906 * Bad news 2: one needs to have the Developer Tools installed.
5907 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
5909 * To recap: we need to open a pipe for reading for a utility which
5910 * might not exist, or exists in different locations, and then parse
5911 * the output. And since this is all for a low-level API, we cannot
5912 * use high-level stuff. Thanks, Apple. */
5915 /* tool is set to the absolute pathname of the tool to use:
5918 /* format is set to a printf format string used for building
5919 * the external command to run. */
5921 /* unavail is set if e.g. xcrun cannot be found, or something
5922 * else happens that makes getting the backtrace dubious. Note,
5923 * however, that the context isn't persistent, the next call to
5924 * get_c_backtrace() will start from scratch. */
5926 /* fname is the current object file name. */
5928 /* object_base_addr is the base address of the shared object. */
5929 void* object_base_addr;
5932 /* Given |dl_info|, updates the context. If the context has been
5933 * marked unavailable, return immediately. If not but the tool has
5934 * not been set, set it to either "xcrun atos" or "atos" (also set the
5935 * format to use for creating commands for piping), or if neither is
5936 * unavailable (one needs the Developer Tools installed), mark the context
5937 * an unavailable. Finally, update the filename (object name),
5938 * and its base address. */
5940 static void atos_update(atos_context* ctx,
5945 if (ctx->tool == NULL) {
5946 const char* tools[] = {
5950 const char* formats[] = {
5951 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
5952 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
5956 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
5957 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
5958 ctx->tool = tools[i];
5959 ctx->format = formats[i];
5963 if (ctx->tool == NULL) {
5964 ctx->unavail = TRUE;
5968 if (ctx->fname == NULL ||
5969 strNE(dl_info->dli_fname, ctx->fname)) {
5970 ctx->fname = dl_info->dli_fname;
5971 ctx->object_base_addr = dl_info->dli_fbase;
5975 /* Given an output buffer end |p| and its |start|, matches
5976 * for the atos output, extracting the source code location
5977 * and returning non-NULL if possible, returning NULL otherwise. */
5978 static const char* atos_parse(const char* p,
5980 STRLEN* source_name_size,
5981 STRLEN* source_line) {
5982 /* atos() output is something like:
5983 * perl_parse (in miniperl) (perl.c:2314)\n\n".
5984 * We cannot use Perl regular expressions, because we need to
5985 * stay low-level. Therefore here we have a rolled-out version
5986 * of a state machine which matches _backwards_from_the_end_ and
5987 * if there's a success, returns the starts of the filename,
5988 * also setting the filename size and the source line number.
5989 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
5990 const char* source_number_start;
5991 const char* source_name_end;
5992 const char* source_line_end;
5993 const char* close_paren;
5996 /* Skip trailing whitespace. */
5997 while (p > start && isSPACE(*p)) p--;
5998 /* Now we should be at the close paren. */
5999 if (p == start || *p != ')')
6003 /* Now we should be in the line number. */
6004 if (p == start || !isDIGIT(*p))
6006 /* Skip over the digits. */
6007 while (p > start && isDIGIT(*p))
6009 /* Now we should be at the colon. */
6010 if (p == start || *p != ':')
6012 source_number_start = p + 1;
6013 source_name_end = p; /* Just beyond the end. */
6015 /* Look for the open paren. */
6016 while (p > start && *p != '(')
6021 *source_name_size = source_name_end - p;
6022 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6023 && source_line_end == close_paren
6024 && uv <= PERL_INT_MAX
6026 *source_line = (STRLEN)uv;
6032 /* Given a raw frame, read a pipe from the symbolicator (that's the
6033 * technical term) atos, reads the result, and parses the source code
6034 * location. We must stay low-level, so we use snprintf(), pipe(),
6035 * and fread(), and then also parse the output ourselves. */
6036 static void atos_symbolize(atos_context* ctx,
6039 STRLEN* source_name_size,
6040 STRLEN* source_line)
6048 /* Simple security measure: if there's any funny business with
6049 * the object name (used as "-o '%s'" ), leave since at least
6050 * partially the user controls it. */
6051 for (p = ctx->fname; *p; p++) {
6052 if (*p == '\'' || isCNTRL(*p)) {
6053 ctx->unavail = TRUE;
6057 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6058 ctx->fname, ctx->object_base_addr, raw_frame);
6059 if (cnt < sizeof(cmd)) {
6060 /* Undo nostdio.h #defines that disable stdio.
6061 * This is somewhat naughty, but is used elsewhere
6062 * in the core, and affects only OS X. */
6067 FILE* fp = popen(cmd, "r");
6068 /* At the moment we open a new pipe for each stack frame.
6069 * This is naturally somewhat slow, but hopefully generating
6070 * stack traces is never going to in a performance critical path.
6072 * We could play tricks with atos by batching the stack
6073 * addresses to be resolved: atos can either take multiple
6074 * addresses from the command line, or read addresses from
6075 * a file (though the mess of creating temporary files would
6076 * probably negate much of any possible speedup).
6078 * Normally there are only two objects present in the backtrace:
6079 * perl itself, and the libdyld.dylib. (Note that the object
6080 * filenames contain the full pathname, so perl may not always
6081 * be in the same place.) Whenever the object in the
6082 * backtrace changes, the base address also changes.
6084 * The problem with batching the addresses, though, would be
6085 * matching the results with the addresses: the parsing of
6086 * the results is already painful enough with a single address. */
6089 UV cnt = fread(out, 1, sizeof(out), fp);
6090 if (cnt < sizeof(out)) {
6091 const char* p = atos_parse(out + cnt - 1, out,
6096 *source_name_size, char);
6097 Copy(p, *source_name,
6098 *source_name_size, char);
6106 #endif /* #ifdef PERL_DARWIN */
6109 =for apidoc get_c_backtrace
6111 Collects the backtrace (aka "stacktrace") into a single linear
6112 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6114 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6115 returning at most C<depth> frames.
6121 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6123 /* Note that here we must stay as low-level as possible: Newx(),
6124 * Copy(), Safefree(); since we may be called from anywhere,
6125 * so we should avoid higher level constructs like SVs or AVs.
6127 * Since we are using safesysmalloc() via Newx(), don't try
6128 * getting backtrace() there, unless you like deep recursion. */
6130 /* Currently only implemented with backtrace() and dladdr(),
6131 * for other platforms NULL is returned. */
6133 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6134 /* backtrace() is available via <execinfo.h> in glibc and in most
6135 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6137 /* We try fetching this many frames total, but then discard
6138 * the |skip| first ones. For the remaining ones we will try
6139 * retrieving more information with dladdr(). */
6140 int try_depth = skip + depth;
6142 /* The addresses (program counters) returned by backtrace(). */
6145 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6148 /* Sizes _including_ the terminating \0 of the object name
6149 * and symbol name strings. */
6150 STRLEN* object_name_sizes;
6151 STRLEN* symbol_name_sizes;
6154 /* The symbol names comes either from dli_sname,
6155 * or if using BFD, they can come from BFD. */
6156 char** symbol_names;
6159 /* The source code location information. Dug out with e.g. BFD. */
6160 char** source_names;
6161 STRLEN* source_name_sizes;
6162 STRLEN* source_lines;
6164 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6165 int got_depth; /* How many frames were returned from backtrace(). */
6166 UV frame_count = 0; /* How many frames we return. */
6167 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6170 bfd_context bfd_ctx;
6173 atos_context atos_ctx;
6176 /* Here are probably possibilities for optimizing. We could for
6177 * example have a struct that contains most of these and then
6178 * allocate |try_depth| of them, saving a bunch of malloc calls.
6179 * Note, however, that |frames| could not be part of that struct
6180 * because backtrace() will want an array of just them. Also be
6181 * careful about the name strings. */
6182 Newx(raw_frames, try_depth, void*);
6183 Newx(dl_infos, try_depth, Dl_info);
6184 Newx(object_name_sizes, try_depth, STRLEN);
6185 Newx(symbol_name_sizes, try_depth, STRLEN);
6186 Newx(source_names, try_depth, char*);
6187 Newx(source_name_sizes, try_depth, STRLEN);
6188 Newx(source_lines, try_depth, STRLEN);
6190 Newx(symbol_names, try_depth, char*);
6193 /* Get the raw frames. */
6194 got_depth = (int)backtrace(raw_frames, try_depth);
6196 /* We use dladdr() instead of backtrace_symbols() because we want
6197 * the full details instead of opaque strings. This is useful for
6198 * two reasons: () the details are needed for further symbolic
6199 * digging, for example in OS X (2) by having the details we fully
6200 * control the output, which in turn is useful when more platforms
6201 * are added: we can keep out output "portable". */
6203 /* We want a single linear allocation, which can then be freed
6204 * with a single swoop. We will do the usual trick of first
6205 * walking over the structure and seeing how much we need to
6206 * allocate, then allocating, and then walking over the structure
6207 * the second time and populating it. */
6209 /* First we must compute the total size of the buffer. */
6210 total_bytes = sizeof(Perl_c_backtrace_header);
6211 if (got_depth > skip) {
6214 bfd_init(); /* Is this safe to call multiple times? */
6215 Zero(&bfd_ctx, 1, bfd_context);
6218 Zero(&atos_ctx, 1, atos_context);
6220 for (i = skip; i < try_depth; i++) {
6221 Dl_info* dl_info = &dl_infos[i];
6223 object_name_sizes[i] = 0;
6224 source_names[i] = NULL;
6225 source_name_sizes[i] = 0;
6226 source_lines[i] = 0;
6228 /* Yes, zero from dladdr() is failure. */
6229 if (dladdr(raw_frames[i], dl_info)) {
6230 total_bytes += sizeof(Perl_c_backtrace_frame);
6232 object_name_sizes[i] =
6233 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6234 symbol_name_sizes[i] =
6235 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6237 bfd_update(&bfd_ctx, dl_info);
6238 bfd_symbolize(&bfd_ctx, raw_frames[i],
6240 &symbol_name_sizes[i],
6242 &source_name_sizes[i],
6246 atos_update(&atos_ctx, dl_info);
6247 atos_symbolize(&atos_ctx,
6250 &source_name_sizes[i],
6254 /* Plus ones for the terminating \0. */
6255 total_bytes += object_name_sizes[i] + 1;
6256 total_bytes += symbol_name_sizes[i] + 1;
6257 total_bytes += source_name_sizes[i] + 1;
6265 Safefree(bfd_ctx.bfd_syms);
6269 /* Now we can allocate and populate the result buffer. */
6270 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6271 Zero(bt, total_bytes, char);
6272 bt->header.frame_count = frame_count;
6273 bt->header.total_bytes = total_bytes;
6274 if (frame_count > 0) {
6275 Perl_c_backtrace_frame* frame = bt->frame_info;
6276 char* name_base = (char *)(frame + frame_count);
6277 char* name_curr = name_base; /* Outputting the name strings here. */
6279 for (i = skip; i < skip + frame_count; i++) {
6280 Dl_info* dl_info = &dl_infos[i];
6282 frame->addr = raw_frames[i];
6283 frame->object_base_addr = dl_info->dli_fbase;
6284 frame->symbol_addr = dl_info->dli_saddr;
6286 /* Copies a string, including the \0, and advances the name_curr.
6287 * Also copies the start and the size to the frame. */
6288 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6290 Copy(src, name_curr, size, char); \
6291 frame->doffset = name_curr - (char*)bt; \
6292 frame->dsize = size; \
6293 name_curr += size; \
6296 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6298 object_name_size, object_name_sizes[i]);
6301 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6303 symbol_name_size, symbol_name_sizes[i]);
6304 Safefree(symbol_names[i]);
6306 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6308 symbol_name_size, symbol_name_sizes[i]);
6311 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6313 source_name_size, source_name_sizes[i]);
6314 Safefree(source_names[i]);
6316 #undef PERL_C_BACKTRACE_STRCPY
6318 frame->source_line_number = source_lines[i];
6322 assert(total_bytes ==
6323 (UV)(sizeof(Perl_c_backtrace_header) +
6324 frame_count * sizeof(Perl_c_backtrace_frame) +
6325 name_curr - name_base));
6328 Safefree(symbol_names);
6330 bfd_close(bfd_ctx.abfd);
6333 Safefree(source_lines);
6334 Safefree(source_name_sizes);
6335 Safefree(source_names);
6336 Safefree(symbol_name_sizes);
6337 Safefree(object_name_sizes);
6338 /* Assuming the strings returned by dladdr() are pointers
6339 * to read-only static memory (the object file), so that
6340 * they do not need freeing (and cannot be). */
6342 Safefree(raw_frames);
6345 PERL_UNUSED_ARGV(depth);
6346 PERL_UNUSED_ARGV(skip);
6352 =for apidoc free_c_backtrace
6354 Deallocates a backtrace received from get_c_bracktrace.
6360 =for apidoc get_c_backtrace_dump
6362 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6363 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6365 The appended output looks like:
6368 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6369 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6372 The fields are tab-separated. The first column is the depth (zero
6373 being the innermost non-skipped frame). In the hex:offset, the hex is
6374 where the program counter was in C<S_parse_body>, and the :offset (might
6375 be missing) tells how much inside the C<S_parse_body> the program counter was.
6377 The C<util.c:1716> is the source code file and line number.
6379 The F</usr/bin/perl> is obvious (hopefully).
6381 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6382 if the platform doesn't support retrieving the information;
6383 if the binary is missing the debug information;
6384 if the optimizer has transformed the code by for example inlining.
6390 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6392 Perl_c_backtrace* bt;
6394 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6396 Perl_c_backtrace_frame* frame;
6397 SV* dsv = newSVpvs("");
6399 for (i = 0, frame = bt->frame_info;
6400 i < bt->header.frame_count; i++, frame++) {
6401 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6402 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6403 /* Symbol (function) names might disappear without debug info.
6405 * The source code location might disappear in case of the
6406 * optimizer inlining or otherwise rearranging the code. */
6407 if (frame->symbol_addr) {
6408 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6410 ((char*)frame->addr - (char*)frame->symbol_addr));
6412 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6413 frame->symbol_name_size &&
6414 frame->symbol_name_offset ?
6415 (char*)bt + frame->symbol_name_offset : "-");
6416 if (frame->source_name_size &&
6417 frame->source_name_offset &&
6418 frame->source_line_number) {
6419 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6420 (char*)bt + frame->source_name_offset,
6421 (UV)frame->source_line_number);
6423 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6425 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6426 frame->object_name_size &&
6427 frame->object_name_offset ?
6428 (char*)bt + frame->object_name_offset : "-");
6429 /* The frame->object_base_addr is not output,
6430 * but it is used for symbolizing/symbolicating. */
6431 sv_catpvs(dsv, "\n");
6434 Perl_free_c_backtrace(bt);
6443 =for apidoc dump_c_backtrace
6445 Dumps the C backtrace to the given C<fp>.
6447 Returns true if a backtrace could be retrieved, false if not.
6453 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6457 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6459 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6462 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6468 #endif /* #ifdef USE_C_BACKTRACE */
6470 #ifdef PERL_TSA_ACTIVE
6472 /* pthread_mutex_t and perl_mutex are typedef equivalent
6473 * so casting the pointers is fine. */
6475 int perl_tsa_mutex_lock(perl_mutex* mutex)
6477 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6480 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6482 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6485 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6487 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6495 /* log a sub call or return */
6498 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6506 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6509 HEK *hek = CvNAME_HEK(cv);
6510 func = HEK_KEY(hek);
6516 start = (const COP *)CvSTART(cv);
6517 file = CopFILE(start);
6518 line = CopLINE(start);
6519 stash = CopSTASHPV(start);
6522 PERL_SUB_ENTRY(func, file, line, stash);
6525 PERL_SUB_RETURN(func, file, line, stash);
6530 /* log a require file loading/loaded */
6533 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6535 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6538 PERL_LOADING_FILE(name);
6541 PERL_LOADED_FILE(name);
6546 /* log an op execution */
6549 Perl_dtrace_probe_op(pTHX_ const OP *op)
6551 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6553 PERL_OP_ENTRY(OP_NAME(op));
6557 /* log a compile/run phase change */
6560 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6562 const char *ph_old = PL_phase_names[PL_phase];
6563 const char *ph_new = PL_phase_names[phase];
6565 PERL_PHASE_CHANGE(ph_new, ph_old);
6571 * ex: set ts=8 sts=4 sw=4 et: