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 %zu x %zu = %zu bytes\n",PTR2UV(ptr),(long)PL_an++, count, size, 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)
1534 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1535 /* sv_2cv might call Perl_croak() or Perl_warner() */
1536 SV * const oldhook = *hook;
1538 if (!oldhook || oldhook == PERL_WARNHOOK_FATAL)
1544 cv = sv_2cv(oldhook, &stash, &gv, 0);
1546 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1556 exarg = newSVsv(ex);
1557 SvREADONLY_on(exarg);
1560 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1564 call_sv(MUTABLE_SV(cv), G_DISCARD);
1573 =for apidoc Am|OP *|die_sv|SV *baseex
1575 Behaves the same as L</croak_sv>, except for the return type.
1576 It should be used only where the C<OP *> return type is required.
1577 The function never actually returns.
1583 # pragma warning( push )
1584 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1585 __declspec(noreturn) has non-void return type */
1586 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1587 __declspec(noreturn) has a return statement */
1590 Perl_die_sv(pTHX_ SV *baseex)
1592 PERL_ARGS_ASSERT_DIE_SV;
1595 NORETURN_FUNCTION_END;
1598 # pragma warning( pop )
1602 =for apidoc Am|OP *|die|const char *pat|...
1604 Behaves the same as L</croak>, except for the return type.
1605 It should be used only where the C<OP *> return type is required.
1606 The function never actually returns.
1611 #if defined(PERL_IMPLICIT_CONTEXT)
1613 # pragma warning( push )
1614 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1615 __declspec(noreturn) has non-void return type */
1616 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1617 __declspec(noreturn) has a return statement */
1620 Perl_die_nocontext(const char* pat, ...)
1624 va_start(args, pat);
1626 NOT_REACHED; /* NOTREACHED */
1628 NORETURN_FUNCTION_END;
1631 # pragma warning( pop )
1633 #endif /* PERL_IMPLICIT_CONTEXT */
1636 # pragma warning( push )
1637 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1638 __declspec(noreturn) has non-void return type */
1639 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1640 __declspec(noreturn) has a return statement */
1643 Perl_die(pTHX_ const char* pat, ...)
1646 va_start(args, pat);
1648 NOT_REACHED; /* NOTREACHED */
1650 NORETURN_FUNCTION_END;
1653 # pragma warning( pop )
1657 =for apidoc Am|void|croak_sv|SV *baseex
1659 This is an XS interface to Perl's C<die> function.
1661 C<baseex> is the error message or object. If it is a reference, it
1662 will be used as-is. Otherwise it is used as a string, and if it does
1663 not end with a newline then it will be extended with some indication of
1664 the current location in the code, as described for L</mess_sv>.
1666 The error message or object will be used as an exception, by default
1667 returning control to the nearest enclosing C<eval>, but subject to
1668 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1669 function never returns normally.
1671 To die with a simple string message, the L</croak> function may be
1678 Perl_croak_sv(pTHX_ SV *baseex)
1680 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1681 PERL_ARGS_ASSERT_CROAK_SV;
1682 invoke_exception_hook(ex, FALSE);
1687 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1689 This is an XS interface to Perl's C<die> function.
1691 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1692 argument list. These are used to generate a string message. If the
1693 message does not end with a newline, then it will be extended with
1694 some indication of the current location in the code, as described for
1697 The error message will be used as an exception, by default
1698 returning control to the nearest enclosing C<eval>, but subject to
1699 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1700 function never returns normally.
1702 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1703 (C<$@>) will be used as an error message or object instead of building an
1704 error message from arguments. If you want to throw a non-string object,
1705 or build an error message in an SV yourself, it is preferable to use
1706 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1712 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1714 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1715 invoke_exception_hook(ex, FALSE);
1720 =for apidoc Am|void|croak|const char *pat|...
1722 This is an XS interface to Perl's C<die> function.
1724 Take a sprintf-style format pattern and argument list. These are used to
1725 generate a string message. If the message does not end with a newline,
1726 then it will be extended with some indication of the current location
1727 in the code, as described for L</mess_sv>.
1729 The error message will be used as an exception, by default
1730 returning control to the nearest enclosing C<eval>, but subject to
1731 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1732 function never returns normally.
1734 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1735 (C<$@>) will be used as an error message or object instead of building an
1736 error message from arguments. If you want to throw a non-string object,
1737 or build an error message in an SV yourself, it is preferable to use
1738 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1743 #if defined(PERL_IMPLICIT_CONTEXT)
1745 Perl_croak_nocontext(const char *pat, ...)
1749 va_start(args, pat);
1751 NOT_REACHED; /* NOTREACHED */
1754 #endif /* PERL_IMPLICIT_CONTEXT */
1757 Perl_croak(pTHX_ const char *pat, ...)
1760 va_start(args, pat);
1762 NOT_REACHED; /* NOTREACHED */
1767 =for apidoc Am|void|croak_no_modify
1769 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1770 terser object code than using C<Perl_croak>. Less code used on exception code
1771 paths reduces CPU cache pressure.
1777 Perl_croak_no_modify(void)
1779 Perl_croak_nocontext( "%s", PL_no_modify);
1782 /* does not return, used in util.c perlio.c and win32.c
1783 This is typically called when malloc returns NULL.
1786 Perl_croak_no_mem(void)
1790 int fd = PerlIO_fileno(Perl_error_log);
1792 SETERRNO(EBADF,RMS_IFI);
1794 /* Can't use PerlIO to write as it allocates memory */
1795 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1800 /* does not return, used only in POPSTACK */
1802 Perl_croak_popstack(void)
1805 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1810 =for apidoc Am|void|warn_sv|SV *baseex
1812 This is an XS interface to Perl's C<warn> function.
1814 C<baseex> is the error message or object. If it is a reference, it
1815 will be used as-is. Otherwise it is used as a string, and if it does
1816 not end with a newline then it will be extended with some indication of
1817 the current location in the code, as described for L</mess_sv>.
1819 The error message or object will by default be written to standard error,
1820 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1822 To warn with a simple string message, the L</warn> function may be
1829 Perl_warn_sv(pTHX_ SV *baseex)
1831 SV *ex = mess_sv(baseex, 0);
1832 PERL_ARGS_ASSERT_WARN_SV;
1833 if (!invoke_exception_hook(ex, TRUE))
1834 write_to_stderr(ex);
1838 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1840 This is an XS interface to Perl's C<warn> function.
1842 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1843 argument list. These are used to generate a string message. If the
1844 message does not end with a newline, then it will be extended with
1845 some indication of the current location in the code, as described for
1848 The error message or object will by default be written to standard error,
1849 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1851 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1857 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1859 SV *ex = vmess(pat, args);
1860 PERL_ARGS_ASSERT_VWARN;
1861 if (!invoke_exception_hook(ex, TRUE))
1862 write_to_stderr(ex);
1866 =for apidoc Am|void|warn|const char *pat|...
1868 This is an XS interface to Perl's C<warn> function.
1870 Take a sprintf-style format pattern and argument list. These are used to
1871 generate a string message. If the message does not end with a newline,
1872 then it will be extended with some indication of the current location
1873 in the code, as described for L</mess_sv>.
1875 The error message or object will by default be written to standard error,
1876 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1878 Unlike with L</croak>, C<pat> is not permitted to be null.
1883 #if defined(PERL_IMPLICIT_CONTEXT)
1885 Perl_warn_nocontext(const char *pat, ...)
1889 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1890 va_start(args, pat);
1894 #endif /* PERL_IMPLICIT_CONTEXT */
1897 Perl_warn(pTHX_ const char *pat, ...)
1900 PERL_ARGS_ASSERT_WARN;
1901 va_start(args, pat);
1906 #if defined(PERL_IMPLICIT_CONTEXT)
1908 Perl_warner_nocontext(U32 err, const char *pat, ...)
1912 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1913 va_start(args, pat);
1914 vwarner(err, pat, &args);
1917 #endif /* PERL_IMPLICIT_CONTEXT */
1920 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1922 PERL_ARGS_ASSERT_CK_WARNER_D;
1924 if (Perl_ckwarn_d(aTHX_ err)) {
1926 va_start(args, pat);
1927 vwarner(err, pat, &args);
1933 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1935 PERL_ARGS_ASSERT_CK_WARNER;
1937 if (Perl_ckwarn(aTHX_ err)) {
1939 va_start(args, pat);
1940 vwarner(err, pat, &args);
1946 Perl_warner(pTHX_ U32 err, const char* pat,...)
1949 PERL_ARGS_ASSERT_WARNER;
1950 va_start(args, pat);
1951 vwarner(err, pat, &args);
1956 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1959 PERL_ARGS_ASSERT_VWARNER;
1961 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
1962 !(PL_in_eval & EVAL_KEEPERR)
1964 SV * const msv = vmess(pat, args);
1966 if (PL_parser && PL_parser->error_count) {
1970 invoke_exception_hook(msv, FALSE);
1975 Perl_vwarn(aTHX_ pat, args);
1979 /* implements the ckWARN? macros */
1982 Perl_ckwarn(pTHX_ U32 w)
1984 /* If lexical warnings have not been set, use $^W. */
1986 return PL_dowarn & G_WARN_ON;
1988 return ckwarn_common(w);
1991 /* implements the ckWARN?_d macro */
1994 Perl_ckwarn_d(pTHX_ U32 w)
1996 /* If lexical warnings have not been set then default classes warn. */
2000 return ckwarn_common(w);
2004 S_ckwarn_common(pTHX_ U32 w)
2006 if (PL_curcop->cop_warnings == pWARN_ALL)
2009 if (PL_curcop->cop_warnings == pWARN_NONE)
2012 /* Check the assumption that at least the first slot is non-zero. */
2013 assert(unpackWARN1(w));
2015 /* Check the assumption that it is valid to stop as soon as a zero slot is
2017 if (!unpackWARN2(w)) {
2018 assert(!unpackWARN3(w));
2019 assert(!unpackWARN4(w));
2020 } else if (!unpackWARN3(w)) {
2021 assert(!unpackWARN4(w));
2024 /* Right, dealt with all the special cases, which are implemented as non-
2025 pointers, so there is a pointer to a real warnings mask. */
2027 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2029 } while (w >>= WARNshift);
2034 /* Set buffer=NULL to get a new one. */
2036 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2038 const MEM_SIZE len_wanted =
2039 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2040 PERL_UNUSED_CONTEXT;
2041 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2044 (specialWARN(buffer) ?
2045 PerlMemShared_malloc(len_wanted) :
2046 PerlMemShared_realloc(buffer, len_wanted));
2048 Copy(bits, (buffer + 1), size, char);
2049 if (size < WARNsize)
2050 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2054 /* since we've already done strlen() for both nam and val
2055 * we can use that info to make things faster than
2056 * sprintf(s, "%s=%s", nam, val)
2058 #define my_setenv_format(s, nam, nlen, val, vlen) \
2059 Copy(nam, s, nlen, char); \
2061 Copy(val, s+(nlen+1), vlen, char); \
2062 *(s+(nlen+1+vlen)) = '\0'
2066 #ifdef USE_ENVIRON_ARRAY
2067 /* NB: VMS' my_setenv() is in vms.c */
2069 /* Configure doesn't test for HAS_SETENV yet, so decide based on platform.
2070 * For Solaris, setenv() and unsetenv() were introduced in Solaris 9, so
2071 * testing for HAS UNSETENV is sufficient.
2073 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2074 # define MY_HAS_SETENV
2077 /* small wrapper for use by Perl_my_setenv that mallocs, or reallocs if
2078 * 'current' is non-null, with up to three sizes that are added together.
2079 * It handles integer overflow.
2081 # ifndef MY_HAS_SETENV
2083 S_env_alloc(void *current, Size_t l1, Size_t l2, Size_t l3, Size_t size)
2086 Size_t sl, l = l1 + l2;
2098 ? safesysrealloc(current, sl)
2099 : safesysmalloc(sl);
2104 croak_memory_wrap();
2109 # if !defined(WIN32) && !defined(NETWARE)
2112 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2115 # ifdef __amigaos4__
2116 amigaos4_obtain_environ(__FUNCTION__);
2119 # ifdef USE_ITHREADS
2120 /* only parent thread can modify process environment */
2121 if (PL_curinterp == aTHX)
2125 # ifndef PERL_USE_SAFE_PUTENV
2126 if (!PL_use_safe_putenv) {
2127 /* most putenv()s leak, so we manipulate environ directly */
2129 Size_t vlen, nlen = strlen(nam);
2131 /* where does it go? */
2132 for (i = 0; environ[i]; i++) {
2133 if (strnEQ(environ[i], nam, nlen) && environ[i][nlen] == '=')
2137 if (environ == PL_origenviron) { /* need we copy environment? */
2142 while (environ[max])
2145 /* XXX shouldn't that be max+1 rather than max+2 ??? - DAPM */
2146 tmpenv = (char**)S_env_alloc(NULL, max, 2, 0, sizeof(char*));
2148 for (j=0; j<max; j++) { /* copy environment */
2149 const Size_t len = strlen(environ[j]);
2150 tmpenv[j] = S_env_alloc(NULL, len, 1, 0, 1);
2151 Copy(environ[j], tmpenv[j], len+1, char);
2155 environ = tmpenv; /* tell exec where it is now */
2159 safesysfree(environ[i]);
2160 while (environ[i]) {
2161 environ[i] = environ[i+1];
2164 # ifdef __amigaos4__
2171 if (!environ[i]) { /* does not exist yet */
2172 environ = (char**)S_env_alloc(environ, i, 2, 0, sizeof(char*));
2173 environ[i+1] = NULL; /* make sure it's null terminated */
2176 safesysfree(environ[i]);
2180 environ[i] = S_env_alloc(NULL, nlen, vlen, 2, 1);
2181 /* all that work just for this */
2182 my_setenv_format(environ[i], nam, nlen, val, vlen);
2186 # endif /* !PERL_USE_SAFE_PUTENV */
2188 # ifdef MY_HAS_SETENV
2189 # if defined(HAS_UNSETENV)
2191 (void)unsetenv(nam);
2193 (void)setenv(nam, val, 1);
2195 # else /* ! HAS_UNSETENV */
2196 (void)setenv(nam, val, 1);
2197 # endif /* HAS_UNSETENV */
2199 # elif defined(HAS_UNSETENV)
2202 if (environ) /* old glibc can crash with null environ */
2203 (void)unsetenv(nam);
2205 const Size_t nlen = strlen(nam);
2206 const Size_t vlen = strlen(val);
2207 char * const new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2208 my_setenv_format(new_env, nam, nlen, val, vlen);
2209 (void)putenv(new_env);
2212 # else /* ! HAS_UNSETENV */
2215 const Size_t nlen = strlen(nam);
2221 new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2222 /* all that work just for this */
2223 my_setenv_format(new_env, nam, nlen, val, vlen);
2224 (void)putenv(new_env);
2226 # endif /* MY_HAS_SETENV */
2228 # ifndef PERL_USE_SAFE_PUTENV
2233 # ifdef __amigaos4__
2235 amigaos4_release_environ(__FUNCTION__);
2239 # else /* WIN32 || NETWARE */
2242 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2246 const Size_t nlen = strlen(nam);
2253 envstr = S_env_alloc(NULL, nlen, vlen, 2, 1);
2254 my_setenv_format(envstr, nam, nlen, val, vlen);
2255 (void)PerlEnv_putenv(envstr);
2259 # endif /* WIN32 || NETWARE */
2261 #endif /* USE_ENVIRON_ARRAY */
2266 #ifdef UNLINK_ALL_VERSIONS
2268 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2272 PERL_ARGS_ASSERT_UNLNK;
2274 while (PerlLIO_unlink(f) >= 0)
2276 return retries ? 0 : -1;
2281 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2283 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2291 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2293 PERL_FLUSHALL_FOR_CHILD;
2294 This = (*mode == 'w');
2298 taint_proper("Insecure %s%s", "EXEC");
2300 if (PerlProc_pipe_cloexec(p) < 0)
2302 /* Try for another pipe pair for error return */
2303 if (PerlProc_pipe_cloexec(pp) >= 0)
2305 while ((pid = PerlProc_fork()) < 0) {
2306 if (errno != EAGAIN) {
2307 PerlLIO_close(p[This]);
2308 PerlLIO_close(p[that]);
2310 PerlLIO_close(pp[0]);
2311 PerlLIO_close(pp[1]);
2315 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2324 /* Close parent's end of error status pipe (if any) */
2326 PerlLIO_close(pp[0]);
2327 /* Now dup our end of _the_ pipe to right position */
2328 if (p[THIS] != (*mode == 'r')) {
2329 PerlLIO_dup2(p[THIS], *mode == 'r');
2330 PerlLIO_close(p[THIS]);
2331 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2332 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2335 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2336 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2338 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2339 /* No automatic close - do it by hand */
2346 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2352 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2359 PerlLIO_close(pp[1]);
2360 /* Keep the lower of the two fd numbers */
2361 if (p[that] < p[This]) {
2362 PerlLIO_dup2_cloexec(p[This], p[that]);
2363 PerlLIO_close(p[This]);
2367 PerlLIO_close(p[that]); /* close child's end of pipe */
2369 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2370 SvUPGRADE(sv,SVt_IV);
2372 PL_forkprocess = pid;
2373 /* If we managed to get status pipe check for exec fail */
2374 if (did_pipes && pid > 0) {
2378 while (n < sizeof(int)) {
2379 const SSize_t n1 = PerlLIO_read(pp[0],
2380 (void*)(((char*)&errkid)+n),
2386 PerlLIO_close(pp[0]);
2388 if (n) { /* Error */
2390 PerlLIO_close(p[This]);
2391 if (n != sizeof(int))
2392 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2394 pid2 = wait4pid(pid, &status, 0);
2395 } while (pid2 == -1 && errno == EINTR);
2396 errno = errkid; /* Propagate errno from kid */
2401 PerlLIO_close(pp[0]);
2402 return PerlIO_fdopen(p[This], mode);
2404 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2405 return my_syspopen4(aTHX_ NULL, mode, n, args);
2406 # elif defined(WIN32)
2407 return win32_popenlist(mode, n, args);
2409 Perl_croak(aTHX_ "List form of piped open not implemented");
2410 return (PerlIO *) NULL;
2415 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2416 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2418 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2424 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2428 PERL_ARGS_ASSERT_MY_POPEN;
2430 PERL_FLUSHALL_FOR_CHILD;
2433 return my_syspopen(aTHX_ cmd,mode);
2436 This = (*mode == 'w');
2438 if (doexec && TAINTING_get) {
2440 taint_proper("Insecure %s%s", "EXEC");
2442 if (PerlProc_pipe_cloexec(p) < 0)
2444 if (doexec && PerlProc_pipe_cloexec(pp) >= 0)
2446 while ((pid = PerlProc_fork()) < 0) {
2447 if (errno != EAGAIN) {
2448 PerlLIO_close(p[This]);
2449 PerlLIO_close(p[that]);
2451 PerlLIO_close(pp[0]);
2452 PerlLIO_close(pp[1]);
2455 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2458 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2468 PerlLIO_close(pp[0]);
2469 if (p[THIS] != (*mode == 'r')) {
2470 PerlLIO_dup2(p[THIS], *mode == 'r');
2471 PerlLIO_close(p[THIS]);
2472 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2473 PerlLIO_close(p[THAT]);
2476 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2477 PerlLIO_close(p[THAT]);
2481 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2488 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2493 /* may or may not use the shell */
2494 do_exec3(cmd, pp[1], did_pipes);
2497 #endif /* defined OS2 */
2499 #ifdef PERLIO_USING_CRLF
2500 /* Since we circumvent IO layers when we manipulate low-level
2501 filedescriptors directly, need to manually switch to the
2502 default, binary, low-level mode; see PerlIOBuf_open(). */
2503 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2506 #ifdef PERL_USES_PL_PIDSTATUS
2507 hv_clear(PL_pidstatus); /* we have no children */
2514 PerlLIO_close(pp[1]);
2515 if (p[that] < p[This]) {
2516 PerlLIO_dup2_cloexec(p[This], p[that]);
2517 PerlLIO_close(p[This]);
2521 PerlLIO_close(p[that]);
2523 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2524 SvUPGRADE(sv,SVt_IV);
2526 PL_forkprocess = pid;
2527 if (did_pipes && pid > 0) {
2531 while (n < sizeof(int)) {
2532 const SSize_t n1 = PerlLIO_read(pp[0],
2533 (void*)(((char*)&errkid)+n),
2539 PerlLIO_close(pp[0]);
2541 if (n) { /* Error */
2543 PerlLIO_close(p[This]);
2544 if (n != sizeof(int))
2545 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2547 pid2 = wait4pid(pid, &status, 0);
2548 } while (pid2 == -1 && errno == EINTR);
2549 errno = errkid; /* Propagate errno from kid */
2554 PerlLIO_close(pp[0]);
2555 return PerlIO_fdopen(p[This], mode);
2557 #elif defined(DJGPP)
2558 FILE *djgpp_popen();
2560 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2562 PERL_FLUSHALL_FOR_CHILD;
2563 /* Call system's popen() to get a FILE *, then import it.
2564 used 0 for 2nd parameter to PerlIO_importFILE;
2567 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2569 #elif defined(__LIBCATAMOUNT__)
2571 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2576 #endif /* !DOSISH */
2578 /* this is called in parent before the fork() */
2580 Perl_atfork_lock(void)
2581 #if defined(USE_ITHREADS)
2583 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2586 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2588 PERL_TSA_ACQUIRE(PL_op_mutex)
2591 #if defined(USE_ITHREADS)
2593 /* locks must be held in locking order (if any) */
2595 MUTEX_LOCK(&PL_perlio_mutex);
2598 MUTEX_LOCK(&PL_malloc_mutex);
2604 /* this is called in both parent and child after the fork() */
2606 Perl_atfork_unlock(void)
2607 #if defined(USE_ITHREADS)
2609 PERL_TSA_RELEASE(PL_perlio_mutex)
2612 PERL_TSA_RELEASE(PL_malloc_mutex)
2614 PERL_TSA_RELEASE(PL_op_mutex)
2617 #if defined(USE_ITHREADS)
2619 /* locks must be released in same order as in atfork_lock() */
2621 MUTEX_UNLOCK(&PL_perlio_mutex);
2624 MUTEX_UNLOCK(&PL_malloc_mutex);
2633 #if defined(HAS_FORK)
2635 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2640 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2641 * handlers elsewhere in the code */
2645 #elif defined(__amigaos4__)
2646 return amigaos_fork();
2648 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2649 Perl_croak_nocontext("fork() not available");
2651 #endif /* HAS_FORK */
2656 dup2(int oldfd, int newfd)
2658 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2661 PerlLIO_close(newfd);
2662 return fcntl(oldfd, F_DUPFD, newfd);
2664 #define DUP2_MAX_FDS 256
2665 int fdtmp[DUP2_MAX_FDS];
2671 PerlLIO_close(newfd);
2672 /* good enough for low fd's... */
2673 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2674 if (fdx >= DUP2_MAX_FDS) {
2682 PerlLIO_close(fdtmp[--fdx]);
2689 #ifdef HAS_SIGACTION
2692 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2694 struct sigaction act, oact;
2698 /* only "parent" interpreter can diddle signals */
2699 if (PL_curinterp != aTHX)
2700 return (Sighandler_t) SIG_ERR;
2703 act.sa_handler = (void(*)(int))handler;
2704 sigemptyset(&act.sa_mask);
2707 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2708 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2710 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2711 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2712 act.sa_flags |= SA_NOCLDWAIT;
2714 if (sigaction(signo, &act, &oact) == -1)
2715 return (Sighandler_t) SIG_ERR;
2717 return (Sighandler_t) oact.sa_handler;
2721 Perl_rsignal_state(pTHX_ int signo)
2723 struct sigaction oact;
2724 PERL_UNUSED_CONTEXT;
2726 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2727 return (Sighandler_t) SIG_ERR;
2729 return (Sighandler_t) oact.sa_handler;
2733 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2738 struct sigaction act;
2740 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2743 /* only "parent" interpreter can diddle signals */
2744 if (PL_curinterp != aTHX)
2748 act.sa_handler = (void(*)(int))handler;
2749 sigemptyset(&act.sa_mask);
2752 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2753 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2755 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2756 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2757 act.sa_flags |= SA_NOCLDWAIT;
2759 return sigaction(signo, &act, save);
2763 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2768 PERL_UNUSED_CONTEXT;
2770 /* only "parent" interpreter can diddle signals */
2771 if (PL_curinterp != aTHX)
2775 return sigaction(signo, save, (struct sigaction *)NULL);
2778 #else /* !HAS_SIGACTION */
2781 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2783 #if defined(USE_ITHREADS) && !defined(WIN32)
2784 /* only "parent" interpreter can diddle signals */
2785 if (PL_curinterp != aTHX)
2786 return (Sighandler_t) SIG_ERR;
2789 return PerlProc_signal(signo, handler);
2800 Perl_rsignal_state(pTHX_ int signo)
2803 Sighandler_t oldsig;
2805 #if defined(USE_ITHREADS) && !defined(WIN32)
2806 /* only "parent" interpreter can diddle signals */
2807 if (PL_curinterp != aTHX)
2808 return (Sighandler_t) SIG_ERR;
2812 oldsig = PerlProc_signal(signo, sig_trap);
2813 PerlProc_signal(signo, oldsig);
2815 PerlProc_kill(PerlProc_getpid(), signo);
2820 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2822 #if defined(USE_ITHREADS) && !defined(WIN32)
2823 /* only "parent" interpreter can diddle signals */
2824 if (PL_curinterp != aTHX)
2827 *save = PerlProc_signal(signo, handler);
2828 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2832 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2834 #if defined(USE_ITHREADS) && !defined(WIN32)
2835 /* only "parent" interpreter can diddle signals */
2836 if (PL_curinterp != aTHX)
2839 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2842 #endif /* !HAS_SIGACTION */
2843 #endif /* !PERL_MICRO */
2845 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2846 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2848 Perl_my_pclose(pTHX_ PerlIO *ptr)
2856 const int fd = PerlIO_fileno(ptr);
2859 svp = av_fetch(PL_fdpid,fd,TRUE);
2860 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2864 #if defined(USE_PERLIO)
2865 /* Find out whether the refcount is low enough for us to wait for the
2866 child proc without blocking. */
2867 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
2869 should_wait = pid > 0;
2873 if (pid == -1) { /* Opened by popen. */
2874 return my_syspclose(ptr);
2877 close_failed = (PerlIO_close(ptr) == EOF);
2879 if (should_wait) do {
2880 pid2 = wait4pid(pid, &status, 0);
2881 } while (pid2 == -1 && errno == EINTR);
2888 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2892 #elif defined(__LIBCATAMOUNT__)
2894 Perl_my_pclose(pTHX_ PerlIO *ptr)
2898 #endif /* !DOSISH */
2900 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2902 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
2905 PERL_ARGS_ASSERT_WAIT4PID;
2906 #ifdef PERL_USES_PL_PIDSTATUS
2908 /* PERL_USES_PL_PIDSTATUS is only defined when neither
2909 waitpid() nor wait4() is available, or on OS/2, which
2910 doesn't appear to support waiting for a progress group
2911 member, so we can only treat a 0 pid as an unknown child.
2918 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
2919 pid, rather than a string form. */
2920 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
2921 if (svp && *svp != &PL_sv_undef) {
2922 *statusp = SvIVX(*svp);
2923 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
2931 hv_iterinit(PL_pidstatus);
2932 if ((entry = hv_iternext(PL_pidstatus))) {
2933 SV * const sv = hv_iterval(PL_pidstatus,entry);
2935 const char * const spid = hv_iterkey(entry,&len);
2937 assert (len == sizeof(Pid_t));
2938 memcpy((char *)&pid, spid, len);
2939 *statusp = SvIVX(sv);
2940 /* The hash iterator is currently on this entry, so simply
2941 calling hv_delete would trigger the lazy delete, which on
2942 aggregate does more work, because next call to hv_iterinit()
2943 would spot the flag, and have to call the delete routine,
2944 while in the meantime any new entries can't re-use that
2946 hv_iterinit(PL_pidstatus);
2947 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
2954 # ifdef HAS_WAITPID_RUNTIME
2955 if (!HAS_WAITPID_RUNTIME)
2958 result = PerlProc_waitpid(pid,statusp,flags);
2961 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
2962 result = wait4(pid,statusp,flags,NULL);
2965 #ifdef PERL_USES_PL_PIDSTATUS
2966 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
2971 Perl_croak(aTHX_ "Can't do waitpid with flags");
2973 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
2974 pidgone(result,*statusp);
2980 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
2983 if (result < 0 && errno == EINTR) {
2985 errno = EINTR; /* reset in case a signal handler changed $! */
2989 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
2991 #ifdef PERL_USES_PL_PIDSTATUS
2993 S_pidgone(pTHX_ Pid_t pid, int status)
2997 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
2998 SvUPGRADE(sv,SVt_IV);
2999 SvIV_set(sv, status);
3007 int /* Cannot prototype with I32
3009 my_syspclose(PerlIO *ptr)
3012 Perl_my_pclose(pTHX_ PerlIO *ptr)
3015 /* Needs work for PerlIO ! */
3016 FILE * const f = PerlIO_findFILE(ptr);
3017 const I32 result = pclose(f);
3018 PerlIO_releaseFILE(ptr,f);
3026 Perl_my_pclose(pTHX_ PerlIO *ptr)
3028 /* Needs work for PerlIO ! */
3029 FILE * const f = PerlIO_findFILE(ptr);
3030 I32 result = djgpp_pclose(f);
3031 result = (result << 8) & 0xff00;
3032 PerlIO_releaseFILE(ptr,f);
3037 #define PERL_REPEATCPY_LINEAR 4
3039 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3041 PERL_ARGS_ASSERT_REPEATCPY;
3046 croak_memory_wrap();
3049 memset(to, *from, count);
3052 IV items, linear, half;
3054 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3055 for (items = 0; items < linear; ++items) {
3056 const char *q = from;
3058 for (todo = len; todo > 0; todo--)
3063 while (items <= half) {
3064 IV size = items * len;
3065 memcpy(p, to, size);
3071 memcpy(p, to, (count - items) * len);
3077 Perl_same_dirent(pTHX_ const char *a, const char *b)
3079 char *fa = strrchr(a,'/');
3080 char *fb = strrchr(b,'/');
3083 SV * const tmpsv = sv_newmortal();
3085 PERL_ARGS_ASSERT_SAME_DIRENT;
3098 sv_setpvs(tmpsv, ".");
3100 sv_setpvn(tmpsv, a, fa - a);
3101 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3104 sv_setpvs(tmpsv, ".");
3106 sv_setpvn(tmpsv, b, fb - b);
3107 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3109 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3110 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3112 #endif /* !HAS_RENAME */
3115 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3116 const char *const *const search_ext, I32 flags)
3118 const char *xfound = NULL;
3119 char *xfailed = NULL;
3120 char tmpbuf[MAXPATHLEN];
3125 #if defined(DOSISH) && !defined(OS2)
3126 # define SEARCH_EXTS ".bat", ".cmd", NULL
3127 # define MAX_EXT_LEN 4
3130 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3131 # define MAX_EXT_LEN 4
3134 # define SEARCH_EXTS ".pl", ".com", NULL
3135 # define MAX_EXT_LEN 4
3137 /* additional extensions to try in each dir if scriptname not found */
3139 static const char *const exts[] = { SEARCH_EXTS };
3140 const char *const *const ext = search_ext ? search_ext : exts;
3141 int extidx = 0, i = 0;
3142 const char *curext = NULL;
3144 PERL_UNUSED_ARG(search_ext);
3145 # define MAX_EXT_LEN 0
3148 PERL_ARGS_ASSERT_FIND_SCRIPT;
3151 * If dosearch is true and if scriptname does not contain path
3152 * delimiters, search the PATH for scriptname.
3154 * If SEARCH_EXTS is also defined, will look for each
3155 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3156 * while searching the PATH.
3158 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3159 * proceeds as follows:
3160 * If DOSISH or VMSISH:
3161 * + look for ./scriptname{,.foo,.bar}
3162 * + search the PATH for scriptname{,.foo,.bar}
3165 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3166 * this will not look in '.' if it's not in the PATH)
3171 # ifdef ALWAYS_DEFTYPES
3172 len = strlen(scriptname);
3173 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3174 int idx = 0, deftypes = 1;
3177 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3180 int idx = 0, deftypes = 1;
3183 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3185 /* The first time through, just add SEARCH_EXTS to whatever we
3186 * already have, so we can check for default file types. */
3188 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3195 if ((strlen(tmpbuf) + strlen(scriptname)
3196 + MAX_EXT_LEN) >= sizeof tmpbuf)
3197 continue; /* don't search dir with too-long name */
3198 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3202 if (strEQ(scriptname, "-"))
3204 if (dosearch) { /* Look in '.' first. */
3205 const char *cur = scriptname;
3207 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3209 if (strEQ(ext[i++],curext)) {
3210 extidx = -1; /* already has an ext */
3215 DEBUG_p(PerlIO_printf(Perl_debug_log,
3216 "Looking for %s\n",cur));
3219 if (PerlLIO_stat(cur,&statbuf) >= 0
3220 && !S_ISDIR(statbuf.st_mode)) {
3229 if (cur == scriptname) {
3230 len = strlen(scriptname);
3231 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3233 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3236 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3237 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3242 if (dosearch && !strchr(scriptname, '/')
3244 && !strchr(scriptname, '\\')
3246 && (s = PerlEnv_getenv("PATH")))
3250 bufend = s + strlen(s);
3251 while (s < bufend) {
3255 && *s != ';'; len++, s++) {
3256 if (len < sizeof tmpbuf)
3259 if (len < sizeof tmpbuf)
3262 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3267 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3268 continue; /* don't search dir with too-long name */
3271 && tmpbuf[len - 1] != '/'
3272 && tmpbuf[len - 1] != '\\'
3275 tmpbuf[len++] = '/';
3276 if (len == 2 && tmpbuf[0] == '.')
3278 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3282 len = strlen(tmpbuf);
3283 if (extidx > 0) /* reset after previous loop */
3287 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3288 retval = PerlLIO_stat(tmpbuf,&statbuf);
3289 if (S_ISDIR(statbuf.st_mode)) {
3293 } while ( retval < 0 /* not there */
3294 && extidx>=0 && ext[extidx] /* try an extension? */
3295 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3300 if (S_ISREG(statbuf.st_mode)
3301 && cando(S_IRUSR,TRUE,&statbuf)
3302 #if !defined(DOSISH)
3303 && cando(S_IXUSR,TRUE,&statbuf)
3307 xfound = tmpbuf; /* bingo! */
3311 xfailed = savepv(tmpbuf);
3316 if (!xfound && !seen_dot && !xfailed &&
3317 (PerlLIO_stat(scriptname,&statbuf) < 0
3318 || S_ISDIR(statbuf.st_mode)))
3320 seen_dot = 1; /* Disable message. */
3325 if (flags & 1) { /* do or die? */
3326 /* diag_listed_as: Can't execute %s */
3327 Perl_croak(aTHX_ "Can't %s %s%s%s",
3328 (xfailed ? "execute" : "find"),
3329 (xfailed ? xfailed : scriptname),
3330 (xfailed ? "" : " on PATH"),
3331 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3336 scriptname = xfound;
3338 return (scriptname ? savepv(scriptname) : NULL);
3341 #ifndef PERL_GET_CONTEXT_DEFINED
3344 Perl_get_context(void)
3346 #if defined(USE_ITHREADS)
3348 # ifdef OLD_PTHREADS_API
3350 int error = pthread_getspecific(PL_thr_key, &t)
3352 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3354 # elif defined(I_MACH_CTHREADS)
3355 return (void*)cthread_data(cthread_self());
3357 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3365 Perl_set_context(void *t)
3367 #if defined(USE_ITHREADS)
3370 PERL_ARGS_ASSERT_SET_CONTEXT;
3371 #if defined(USE_ITHREADS)
3372 # ifdef I_MACH_CTHREADS
3373 cthread_set_data(cthread_self(), t);
3376 const int error = pthread_setspecific(PL_thr_key, t);
3378 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3386 #endif /* !PERL_GET_CONTEXT_DEFINED */
3388 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3392 PERL_UNUSED_CONTEXT;
3398 Perl_get_op_names(pTHX)
3400 PERL_UNUSED_CONTEXT;
3401 return (char **)PL_op_name;
3405 Perl_get_op_descs(pTHX)
3407 PERL_UNUSED_CONTEXT;
3408 return (char **)PL_op_desc;
3412 Perl_get_no_modify(pTHX)
3414 PERL_UNUSED_CONTEXT;
3415 return PL_no_modify;
3419 Perl_get_opargs(pTHX)
3421 PERL_UNUSED_CONTEXT;
3422 return (U32 *)PL_opargs;
3426 Perl_get_ppaddr(pTHX)
3429 PERL_UNUSED_CONTEXT;
3430 return (PPADDR_t*)PL_ppaddr;
3433 #ifndef HAS_GETENV_LEN
3435 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3437 char * const env_trans = PerlEnv_getenv(env_elem);
3438 PERL_UNUSED_CONTEXT;
3439 PERL_ARGS_ASSERT_GETENV_LEN;
3441 *len = strlen(env_trans);
3448 Perl_get_vtbl(pTHX_ int vtbl_id)
3450 PERL_UNUSED_CONTEXT;
3452 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3453 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3457 Perl_my_fflush_all(pTHX)
3459 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3460 return PerlIO_flush(NULL);
3462 # if defined(HAS__FWALK)
3463 extern int fflush(FILE *);
3464 /* undocumented, unprototyped, but very useful BSDism */
3465 extern void _fwalk(int (*)(FILE *));
3469 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3471 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3472 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3473 # elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3474 open_max = sysconf(_SC_OPEN_MAX);
3475 # elif defined(FOPEN_MAX)
3476 open_max = FOPEN_MAX;
3477 # elif defined(OPEN_MAX)
3478 open_max = OPEN_MAX;
3479 # elif defined(_NFILE)
3484 for (i = 0; i < open_max; i++)
3485 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3486 STDIO_STREAM_ARRAY[i]._file < open_max &&
3487 STDIO_STREAM_ARRAY[i]._flag)
3488 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3492 SETERRNO(EBADF,RMS_IFI);
3499 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3501 if (ckWARN(WARN_IO)) {
3503 = gv && (isGV_with_GP(gv))
3506 const char * const direction = have == '>' ? "out" : "in";
3508 if (name && HEK_LEN(name))
3509 Perl_warner(aTHX_ packWARN(WARN_IO),
3510 "Filehandle %" HEKf " opened only for %sput",
3511 HEKfARG(name), direction);
3513 Perl_warner(aTHX_ packWARN(WARN_IO),
3514 "Filehandle opened only for %sput", direction);
3519 Perl_report_evil_fh(pTHX_ const GV *gv)
3521 const IO *io = gv ? GvIO(gv) : NULL;
3522 const PERL_BITFIELD16 op = PL_op->op_type;
3526 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3528 warn_type = WARN_CLOSED;
3532 warn_type = WARN_UNOPENED;
3535 if (ckWARN(warn_type)) {
3537 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3538 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3539 const char * const pars =
3540 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3541 const char * const func =
3543 (op == OP_READLINE || op == OP_RCATLINE
3544 ? "readline" : /* "<HANDLE>" not nice */
3545 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3547 const char * const type =
3549 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3550 ? "socket" : "filehandle");
3551 const bool have_name = name && SvCUR(name);
3552 Perl_warner(aTHX_ packWARN(warn_type),
3553 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3554 have_name ? " " : "",
3555 SVfARG(have_name ? name : &PL_sv_no));
3556 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3558 aTHX_ packWARN(warn_type),
3559 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3560 func, pars, have_name ? " " : "",
3561 SVfARG(have_name ? name : &PL_sv_no)
3566 /* To workaround core dumps from the uninitialised tm_zone we get the
3567 * system to give us a reasonable struct to copy. This fix means that
3568 * strftime uses the tm_zone and tm_gmtoff values returned by
3569 * localtime(time()). That should give the desired result most of the
3570 * time. But probably not always!
3572 * This does not address tzname aspects of NETaa14816.
3577 # ifndef STRUCT_TM_HASZONE
3578 # define STRUCT_TM_HASZONE
3582 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3583 # ifndef HAS_TM_TM_ZONE
3584 # define HAS_TM_TM_ZONE
3589 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3591 #ifdef HAS_TM_TM_ZONE
3593 const struct tm* my_tm;
3594 PERL_UNUSED_CONTEXT;
3595 PERL_ARGS_ASSERT_INIT_TM;
3597 my_tm = localtime(&now);
3599 Copy(my_tm, ptm, 1, struct tm);
3601 PERL_UNUSED_CONTEXT;
3602 PERL_ARGS_ASSERT_INIT_TM;
3603 PERL_UNUSED_ARG(ptm);
3608 * mini_mktime - normalise struct tm values without the localtime()
3609 * semantics (and overhead) of mktime().
3612 Perl_mini_mktime(struct tm *ptm)
3616 int month, mday, year, jday;
3617 int odd_cent, odd_year;
3619 PERL_ARGS_ASSERT_MINI_MKTIME;
3621 #define DAYS_PER_YEAR 365
3622 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3623 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3624 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3625 #define SECS_PER_HOUR (60*60)
3626 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3627 /* parentheses deliberately absent on these two, otherwise they don't work */
3628 #define MONTH_TO_DAYS 153/5
3629 #define DAYS_TO_MONTH 5/153
3630 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3631 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3632 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3633 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3636 * Year/day algorithm notes:
3638 * With a suitable offset for numeric value of the month, one can find
3639 * an offset into the year by considering months to have 30.6 (153/5) days,
3640 * using integer arithmetic (i.e., with truncation). To avoid too much
3641 * messing about with leap days, we consider January and February to be
3642 * the 13th and 14th month of the previous year. After that transformation,
3643 * we need the month index we use to be high by 1 from 'normal human' usage,
3644 * so the month index values we use run from 4 through 15.
3646 * Given that, and the rules for the Gregorian calendar (leap years are those
3647 * divisible by 4 unless also divisible by 100, when they must be divisible
3648 * by 400 instead), we can simply calculate the number of days since some
3649 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3650 * the days we derive from our month index, and adding in the day of the
3651 * month. The value used here is not adjusted for the actual origin which
3652 * it normally would use (1 January A.D. 1), since we're not exposing it.
3653 * We're only building the value so we can turn around and get the
3654 * normalised values for the year, month, day-of-month, and day-of-year.
3656 * For going backward, we need to bias the value we're using so that we find
3657 * the right year value. (Basically, we don't want the contribution of
3658 * March 1st to the number to apply while deriving the year). Having done
3659 * that, we 'count up' the contribution to the year number by accounting for
3660 * full quadracenturies (400-year periods) with their extra leap days, plus
3661 * the contribution from full centuries (to avoid counting in the lost leap
3662 * days), plus the contribution from full quad-years (to count in the normal
3663 * leap days), plus the leftover contribution from any non-leap years.
3664 * At this point, if we were working with an actual leap day, we'll have 0
3665 * days left over. This is also true for March 1st, however. So, we have
3666 * to special-case that result, and (earlier) keep track of the 'odd'
3667 * century and year contributions. If we got 4 extra centuries in a qcent,
3668 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3669 * Otherwise, we add back in the earlier bias we removed (the 123 from
3670 * figuring in March 1st), find the month index (integer division by 30.6),
3671 * and the remainder is the day-of-month. We then have to convert back to
3672 * 'real' months (including fixing January and February from being 14/15 in
3673 * the previous year to being in the proper year). After that, to get
3674 * tm_yday, we work with the normalised year and get a new yearday value for
3675 * January 1st, which we subtract from the yearday value we had earlier,
3676 * representing the date we've re-built. This is done from January 1
3677 * because tm_yday is 0-origin.
3679 * Since POSIX time routines are only guaranteed to work for times since the
3680 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3681 * applies Gregorian calendar rules even to dates before the 16th century
3682 * doesn't bother me. Besides, you'd need cultural context for a given
3683 * date to know whether it was Julian or Gregorian calendar, and that's
3684 * outside the scope for this routine. Since we convert back based on the
3685 * same rules we used to build the yearday, you'll only get strange results
3686 * for input which needed normalising, or for the 'odd' century years which
3687 * were leap years in the Julian calendar but not in the Gregorian one.
3688 * I can live with that.
3690 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3691 * that's still outside the scope for POSIX time manipulation, so I don't
3697 year = 1900 + ptm->tm_year;
3698 month = ptm->tm_mon;
3699 mday = ptm->tm_mday;
3705 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3706 yearday += month*MONTH_TO_DAYS + mday + jday;
3708 * Note that we don't know when leap-seconds were or will be,
3709 * so we have to trust the user if we get something which looks
3710 * like a sensible leap-second. Wild values for seconds will
3711 * be rationalised, however.
3713 if ((unsigned) ptm->tm_sec <= 60) {
3720 secs += 60 * ptm->tm_min;
3721 secs += SECS_PER_HOUR * ptm->tm_hour;
3723 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3724 /* got negative remainder, but need positive time */
3725 /* back off an extra day to compensate */
3726 yearday += (secs/SECS_PER_DAY)-1;
3727 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3730 yearday += (secs/SECS_PER_DAY);
3731 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3734 else if (secs >= SECS_PER_DAY) {
3735 yearday += (secs/SECS_PER_DAY);
3736 secs %= SECS_PER_DAY;
3738 ptm->tm_hour = secs/SECS_PER_HOUR;
3739 secs %= SECS_PER_HOUR;
3740 ptm->tm_min = secs/60;
3742 ptm->tm_sec += secs;
3743 /* done with time of day effects */
3745 * The algorithm for yearday has (so far) left it high by 428.
3746 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3747 * bias it by 123 while trying to figure out what year it
3748 * really represents. Even with this tweak, the reverse
3749 * translation fails for years before A.D. 0001.
3750 * It would still fail for Feb 29, but we catch that one below.
3752 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3753 yearday -= YEAR_ADJUST;
3754 year = (yearday / DAYS_PER_QCENT) * 400;
3755 yearday %= DAYS_PER_QCENT;
3756 odd_cent = yearday / DAYS_PER_CENT;
3757 year += odd_cent * 100;
3758 yearday %= DAYS_PER_CENT;
3759 year += (yearday / DAYS_PER_QYEAR) * 4;
3760 yearday %= DAYS_PER_QYEAR;
3761 odd_year = yearday / DAYS_PER_YEAR;
3763 yearday %= DAYS_PER_YEAR;
3764 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3769 yearday += YEAR_ADJUST; /* recover March 1st crock */
3770 month = yearday*DAYS_TO_MONTH;
3771 yearday -= month*MONTH_TO_DAYS;
3772 /* recover other leap-year adjustment */
3781 ptm->tm_year = year - 1900;
3783 ptm->tm_mday = yearday;
3784 ptm->tm_mon = month;
3788 ptm->tm_mon = month - 1;
3790 /* re-build yearday based on Jan 1 to get tm_yday */
3792 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3793 yearday += 14*MONTH_TO_DAYS + 1;
3794 ptm->tm_yday = jday - yearday;
3795 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3799 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)
3803 /* strftime(), but with a different API so that the return value is a pointer
3804 * to the formatted result (which MUST be arranged to be FREED BY THE
3805 * CALLER). This allows this function to increase the buffer size as needed,
3806 * so that the caller doesn't have to worry about that.
3808 * Note that yday and wday effectively are ignored by this function, as
3809 * mini_mktime() overwrites them */
3816 PERL_ARGS_ASSERT_MY_STRFTIME;
3818 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3821 mytm.tm_hour = hour;
3822 mytm.tm_mday = mday;
3824 mytm.tm_year = year;
3825 mytm.tm_wday = wday;
3826 mytm.tm_yday = yday;
3827 mytm.tm_isdst = isdst;
3829 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3830 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3835 #ifdef HAS_TM_TM_GMTOFF
3836 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3838 #ifdef HAS_TM_TM_ZONE
3839 mytm.tm_zone = mytm2.tm_zone;
3844 Newx(buf, buflen, char);
3846 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3847 len = strftime(buf, buflen, fmt, &mytm);
3848 GCC_DIAG_RESTORE_STMT;
3851 ** The following is needed to handle to the situation where
3852 ** tmpbuf overflows. Basically we want to allocate a buffer
3853 ** and try repeatedly. The reason why it is so complicated
3854 ** is that getting a return value of 0 from strftime can indicate
3855 ** one of the following:
3856 ** 1. buffer overflowed,
3857 ** 2. illegal conversion specifier, or
3858 ** 3. the format string specifies nothing to be returned(not
3859 ** an error). This could be because format is an empty string
3860 ** or it specifies %p that yields an empty string in some locale.
3861 ** If there is a better way to make it portable, go ahead by
3864 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
3867 /* Possibly buf overflowed - try again with a bigger buf */
3868 const int fmtlen = strlen(fmt);
3869 int bufsize = fmtlen + buflen;
3871 Renew(buf, bufsize, char);
3874 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3875 buflen = strftime(buf, bufsize, fmt, &mytm);
3876 GCC_DIAG_RESTORE_STMT;
3878 if (buflen > 0 && buflen < bufsize)
3880 /* heuristic to prevent out-of-memory errors */
3881 if (bufsize > 100*fmtlen) {
3887 Renew(buf, bufsize, char);
3892 Perl_croak(aTHX_ "panic: no strftime");
3898 #define SV_CWD_RETURN_UNDEF \
3902 #define SV_CWD_ISDOT(dp) \
3903 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
3904 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
3907 =head1 Miscellaneous Functions
3909 =for apidoc getcwd_sv
3911 Fill C<sv> with current working directory
3916 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
3917 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
3918 * getcwd(3) if available
3919 * Comments from the original:
3920 * This is a faster version of getcwd. It's also more dangerous
3921 * because you might chdir out of a directory that you can't chdir
3925 Perl_getcwd_sv(pTHX_ SV *sv)
3930 PERL_ARGS_ASSERT_GETCWD_SV;
3934 char buf[MAXPATHLEN];
3936 /* Some getcwd()s automatically allocate a buffer of the given
3937 * size from the heap if they are given a NULL buffer pointer.
3938 * The problem is that this behaviour is not portable. */
3939 if (getcwd(buf, sizeof(buf) - 1)) {
3944 SV_CWD_RETURN_UNDEF;
3951 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
3955 SvUPGRADE(sv, SVt_PV);
3957 if (PerlLIO_lstat(".", &statbuf) < 0) {
3958 SV_CWD_RETURN_UNDEF;
3961 orig_cdev = statbuf.st_dev;
3962 orig_cino = statbuf.st_ino;
3972 if (PerlDir_chdir("..") < 0) {
3973 SV_CWD_RETURN_UNDEF;
3975 if (PerlLIO_stat(".", &statbuf) < 0) {
3976 SV_CWD_RETURN_UNDEF;
3979 cdev = statbuf.st_dev;
3980 cino = statbuf.st_ino;
3982 if (odev == cdev && oino == cino) {
3985 if (!(dir = PerlDir_open("."))) {
3986 SV_CWD_RETURN_UNDEF;
3989 while ((dp = PerlDir_read(dir)) != NULL) {
3991 namelen = dp->d_namlen;
3993 namelen = strlen(dp->d_name);
3996 if (SV_CWD_ISDOT(dp)) {
4000 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4001 SV_CWD_RETURN_UNDEF;
4004 tdev = statbuf.st_dev;
4005 tino = statbuf.st_ino;
4006 if (tino == oino && tdev == odev) {
4012 SV_CWD_RETURN_UNDEF;
4015 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4016 SV_CWD_RETURN_UNDEF;
4019 SvGROW(sv, pathlen + namelen + 1);
4023 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4026 /* prepend current directory to the front */
4028 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4029 pathlen += (namelen + 1);
4031 #ifdef VOID_CLOSEDIR
4034 if (PerlDir_close(dir) < 0) {
4035 SV_CWD_RETURN_UNDEF;
4041 SvCUR_set(sv, pathlen);
4045 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4046 SV_CWD_RETURN_UNDEF;
4049 if (PerlLIO_stat(".", &statbuf) < 0) {
4050 SV_CWD_RETURN_UNDEF;
4053 cdev = statbuf.st_dev;
4054 cino = statbuf.st_ino;
4056 if (cdev != orig_cdev || cino != orig_cino) {
4057 Perl_croak(aTHX_ "Unstable directory path, "
4058 "current directory changed unexpectedly");
4071 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4072 # define EMULATE_SOCKETPAIR_UDP
4075 #ifdef EMULATE_SOCKETPAIR_UDP
4077 S_socketpair_udp (int fd[2]) {
4079 /* Fake a datagram socketpair using UDP to localhost. */
4080 int sockets[2] = {-1, -1};
4081 struct sockaddr_in addresses[2];
4083 Sock_size_t size = sizeof(struct sockaddr_in);
4084 unsigned short port;
4087 memset(&addresses, 0, sizeof(addresses));
4090 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4091 if (sockets[i] == -1)
4092 goto tidy_up_and_fail;
4094 addresses[i].sin_family = AF_INET;
4095 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4096 addresses[i].sin_port = 0; /* kernel choses port. */
4097 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4098 sizeof(struct sockaddr_in)) == -1)
4099 goto tidy_up_and_fail;
4102 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4103 for each connect the other socket to it. */
4106 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4108 goto tidy_up_and_fail;
4109 if (size != sizeof(struct sockaddr_in))
4110 goto abort_tidy_up_and_fail;
4111 /* !1 is 0, !0 is 1 */
4112 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4113 sizeof(struct sockaddr_in)) == -1)
4114 goto tidy_up_and_fail;
4117 /* Now we have 2 sockets connected to each other. I don't trust some other
4118 process not to have already sent a packet to us (by random) so send
4119 a packet from each to the other. */
4122 /* I'm going to send my own port number. As a short.
4123 (Who knows if someone somewhere has sin_port as a bitfield and needs
4124 this routine. (I'm assuming crays have socketpair)) */
4125 port = addresses[i].sin_port;
4126 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4127 if (got != sizeof(port)) {
4129 goto tidy_up_and_fail;
4130 goto abort_tidy_up_and_fail;
4134 /* Packets sent. I don't trust them to have arrived though.
4135 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4136 connect to localhost will use a second kernel thread. In 2.6 the
4137 first thread running the connect() returns before the second completes,
4138 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4139 returns 0. Poor programs have tripped up. One poor program's authors'
4140 had a 50-1 reverse stock split. Not sure how connected these were.)
4141 So I don't trust someone not to have an unpredictable UDP stack.
4145 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4146 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4150 FD_SET((unsigned int)sockets[0], &rset);
4151 FD_SET((unsigned int)sockets[1], &rset);
4153 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4154 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4155 || !FD_ISSET(sockets[1], &rset)) {
4156 /* I hope this is portable and appropriate. */
4158 goto tidy_up_and_fail;
4159 goto abort_tidy_up_and_fail;
4163 /* And the paranoia department even now doesn't trust it to have arrive
4164 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4166 struct sockaddr_in readfrom;
4167 unsigned short buffer[2];
4172 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4173 sizeof(buffer), MSG_DONTWAIT,
4174 (struct sockaddr *) &readfrom, &size);
4176 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4178 (struct sockaddr *) &readfrom, &size);
4182 goto tidy_up_and_fail;
4183 if (got != sizeof(port)
4184 || size != sizeof(struct sockaddr_in)
4185 /* Check other socket sent us its port. */
4186 || buffer[0] != (unsigned short) addresses[!i].sin_port
4187 /* Check kernel says we got the datagram from that socket */
4188 || readfrom.sin_family != addresses[!i].sin_family
4189 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4190 || readfrom.sin_port != addresses[!i].sin_port)
4191 goto abort_tidy_up_and_fail;
4194 /* My caller (my_socketpair) has validated that this is non-NULL */
4197 /* I hereby declare this connection open. May God bless all who cross
4201 abort_tidy_up_and_fail:
4202 errno = ECONNABORTED;
4206 if (sockets[0] != -1)
4207 PerlLIO_close(sockets[0]);
4208 if (sockets[1] != -1)
4209 PerlLIO_close(sockets[1]);
4214 #endif /* EMULATE_SOCKETPAIR_UDP */
4216 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4218 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4219 /* Stevens says that family must be AF_LOCAL, protocol 0.
4220 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4225 struct sockaddr_in listen_addr;
4226 struct sockaddr_in connect_addr;
4231 || family != AF_UNIX
4234 errno = EAFNOSUPPORT;
4243 type &= ~SOCK_CLOEXEC;
4246 #ifdef EMULATE_SOCKETPAIR_UDP
4247 if (type == SOCK_DGRAM)
4248 return S_socketpair_udp(fd);
4251 aTHXa(PERL_GET_THX);
4252 listener = PerlSock_socket(AF_INET, type, 0);
4255 memset(&listen_addr, 0, sizeof(listen_addr));
4256 listen_addr.sin_family = AF_INET;
4257 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4258 listen_addr.sin_port = 0; /* kernel choses port. */
4259 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4260 sizeof(listen_addr)) == -1)
4261 goto tidy_up_and_fail;
4262 if (PerlSock_listen(listener, 1) == -1)
4263 goto tidy_up_and_fail;
4265 connector = PerlSock_socket(AF_INET, type, 0);
4266 if (connector == -1)
4267 goto tidy_up_and_fail;
4268 /* We want to find out the port number to connect to. */
4269 size = sizeof(connect_addr);
4270 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4272 goto tidy_up_and_fail;
4273 if (size != sizeof(connect_addr))
4274 goto abort_tidy_up_and_fail;
4275 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4276 sizeof(connect_addr)) == -1)
4277 goto tidy_up_and_fail;
4279 size = sizeof(listen_addr);
4280 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4283 goto tidy_up_and_fail;
4284 if (size != sizeof(listen_addr))
4285 goto abort_tidy_up_and_fail;
4286 PerlLIO_close(listener);
4287 /* Now check we are talking to ourself by matching port and host on the
4289 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4291 goto tidy_up_and_fail;
4292 if (size != sizeof(connect_addr)
4293 || listen_addr.sin_family != connect_addr.sin_family
4294 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4295 || listen_addr.sin_port != connect_addr.sin_port) {
4296 goto abort_tidy_up_and_fail;
4302 abort_tidy_up_and_fail:
4304 errno = ECONNABORTED; /* This would be the standard thing to do. */
4305 #elif defined(ECONNREFUSED)
4306 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4308 errno = ETIMEDOUT; /* Desperation time. */
4314 PerlLIO_close(listener);
4315 if (connector != -1)
4316 PerlLIO_close(connector);
4318 PerlLIO_close(acceptor);
4324 /* In any case have a stub so that there's code corresponding
4325 * to the my_socketpair in embed.fnc. */
4327 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4328 #ifdef HAS_SOCKETPAIR
4329 return socketpair(family, type, protocol, fd);
4338 =for apidoc sv_nosharing
4340 Dummy routine which "shares" an SV when there is no sharing module present.
4341 Or "locks" it. Or "unlocks" it. In other
4342 words, ignores its single SV argument.
4343 Exists to avoid test for a C<NULL> function pointer and because it could
4344 potentially warn under some level of strict-ness.
4350 Perl_sv_nosharing(pTHX_ SV *sv)
4352 PERL_UNUSED_CONTEXT;
4353 PERL_UNUSED_ARG(sv);
4358 =for apidoc sv_destroyable
4360 Dummy routine which reports that object can be destroyed when there is no
4361 sharing module present. It ignores its single SV argument, and returns
4362 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4363 could potentially warn under some level of strict-ness.
4369 Perl_sv_destroyable(pTHX_ SV *sv)
4371 PERL_UNUSED_CONTEXT;
4372 PERL_UNUSED_ARG(sv);
4377 Perl_parse_unicode_opts(pTHX_ const char **popt)
4379 const char *p = *popt;
4382 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4386 const char* endptr = p + strlen(p);
4388 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4391 if (p && *p && *p != '\n' && *p != '\r') {
4393 goto the_end_of_the_opts_parser;
4395 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4399 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4405 case PERL_UNICODE_STDIN:
4406 opt |= PERL_UNICODE_STDIN_FLAG; break;
4407 case PERL_UNICODE_STDOUT:
4408 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4409 case PERL_UNICODE_STDERR:
4410 opt |= PERL_UNICODE_STDERR_FLAG; break;
4411 case PERL_UNICODE_STD:
4412 opt |= PERL_UNICODE_STD_FLAG; break;
4413 case PERL_UNICODE_IN:
4414 opt |= PERL_UNICODE_IN_FLAG; break;
4415 case PERL_UNICODE_OUT:
4416 opt |= PERL_UNICODE_OUT_FLAG; break;
4417 case PERL_UNICODE_INOUT:
4418 opt |= PERL_UNICODE_INOUT_FLAG; break;
4419 case PERL_UNICODE_LOCALE:
4420 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4421 case PERL_UNICODE_ARGV:
4422 opt |= PERL_UNICODE_ARGV_FLAG; break;
4423 case PERL_UNICODE_UTF8CACHEASSERT:
4424 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4426 if (*p != '\n' && *p != '\r') {
4427 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4430 "Unknown Unicode option letter '%c'", *p);
4437 opt = PERL_UNICODE_DEFAULT_FLAGS;
4439 the_end_of_the_opts_parser:
4441 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4442 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4443 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4451 # include <starlet.h>
4458 * This is really just a quick hack which grabs various garbage
4459 * values. It really should be a real hash algorithm which
4460 * spreads the effect of every input bit onto every output bit,
4461 * if someone who knows about such things would bother to write it.
4462 * Might be a good idea to add that function to CORE as well.
4463 * No numbers below come from careful analysis or anything here,
4464 * except they are primes and SEED_C1 > 1E6 to get a full-width
4465 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4466 * probably be bigger too.
4469 # define SEED_C1 1000003
4470 #define SEED_C4 73819
4472 # define SEED_C1 25747
4473 #define SEED_C4 20639
4477 #define SEED_C5 26107
4479 #ifndef PERL_NO_DEV_RANDOM
4483 #ifdef HAS_GETTIMEOFDAY
4484 struct timeval when;
4489 /* This test is an escape hatch, this symbol isn't set by Configure. */
4490 #ifndef PERL_NO_DEV_RANDOM
4491 #ifndef PERL_RANDOM_DEVICE
4492 /* /dev/random isn't used by default because reads from it will block
4493 * if there isn't enough entropy available. You can compile with
4494 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4495 * is enough real entropy to fill the seed. */
4496 # ifdef __amigaos4__
4497 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4499 # define PERL_RANDOM_DEVICE "/dev/urandom"
4502 fd = PerlLIO_open_cloexec(PERL_RANDOM_DEVICE, 0);
4504 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4512 #ifdef HAS_GETTIMEOFDAY
4513 PerlProc_gettimeofday(&when,NULL);
4514 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4517 u = (U32)SEED_C1 * when;
4519 u += SEED_C3 * (U32)PerlProc_getpid();
4520 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4521 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4522 u += SEED_C5 * (U32)PTR2UV(&when);
4528 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4530 #ifndef NO_PERL_HASH_ENV
4535 PERL_ARGS_ASSERT_GET_HASH_SEED;
4537 #ifndef NO_PERL_HASH_ENV
4538 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4542 /* ignore leading spaces */
4543 while (isSPACE(*env_pv))
4545 # ifdef USE_PERL_PERTURB_KEYS
4546 /* if they set it to "0" we disable key traversal randomization completely */
4547 if (strEQ(env_pv,"0")) {
4548 PL_hash_rand_bits_enabled= 0;
4550 /* otherwise switch to deterministic mode */
4551 PL_hash_rand_bits_enabled= 2;
4554 /* ignore a leading 0x... if it is there */
4555 if (env_pv[0] == '0' && env_pv[1] == 'x')
4558 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4559 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4560 if ( isXDIGIT(*env_pv)) {
4561 seed_buffer[i] |= READ_XDIGIT(env_pv);
4564 while (isSPACE(*env_pv))
4567 if (*env_pv && !isXDIGIT(*env_pv)) {
4568 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4570 /* should we check for unparsed crap? */
4571 /* should we warn about unused hex? */
4572 /* should we warn about insufficient hex? */
4575 #endif /* NO_PERL_HASH_ENV */
4577 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4578 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
4581 #ifdef USE_PERL_PERTURB_KEYS
4582 { /* initialize PL_hash_rand_bits from the hash seed.
4583 * This value is highly volatile, it is updated every
4584 * hash insert, and is used as part of hash bucket chain
4585 * randomization and hash iterator randomization. */
4586 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4587 for( i = 0; i < sizeof(UV) ; i++ ) {
4588 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4589 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4592 # ifndef NO_PERL_HASH_ENV
4593 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4595 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4596 PL_hash_rand_bits_enabled= 0;
4597 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4598 PL_hash_rand_bits_enabled= 1;
4599 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4600 PL_hash_rand_bits_enabled= 2;
4602 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4609 #ifdef PERL_GLOBAL_STRUCT
4611 #define PERL_GLOBAL_STRUCT_INIT
4612 #include "opcode.h" /* the ppaddr and check */
4615 Perl_init_global_struct(pTHX)
4617 struct perl_vars *plvarsp = NULL;
4618 # ifdef PERL_GLOBAL_STRUCT
4619 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4620 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4621 PERL_UNUSED_CONTEXT;
4622 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4623 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4624 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4628 plvarsp = PL_VarsPtr;
4629 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4634 # define PERLVAR(prefix,var,type) /**/
4635 # define PERLVARA(prefix,var,n,type) /**/
4636 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4637 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4638 # include "perlvars.h"
4643 # ifdef PERL_GLOBAL_STRUCT
4646 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4647 if (!plvarsp->Gppaddr)
4651 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4652 if (!plvarsp->Gcheck)
4654 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4655 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4657 # ifdef PERL_SET_VARS
4658 PERL_SET_VARS(plvarsp);
4660 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4661 plvarsp->Gsv_placeholder.sv_flags = 0;
4662 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4664 # undef PERL_GLOBAL_STRUCT_INIT
4669 #endif /* PERL_GLOBAL_STRUCT */
4671 #ifdef PERL_GLOBAL_STRUCT
4674 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4676 int veto = plvarsp->Gveto_cleanup;
4678 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4679 PERL_UNUSED_CONTEXT;
4680 # ifdef PERL_GLOBAL_STRUCT
4681 # ifdef PERL_UNSET_VARS
4682 PERL_UNSET_VARS(plvarsp);
4686 free(plvarsp->Gppaddr);
4687 free(plvarsp->Gcheck);
4688 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4694 #endif /* PERL_GLOBAL_STRUCT */
4698 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4699 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4700 * given, and you supply your own implementation.
4702 * The default implementation reads a single env var, PERL_MEM_LOG,
4703 * expecting one or more of the following:
4705 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4706 * 'm' - memlog was PERL_MEM_LOG=1
4707 * 's' - svlog was PERL_SV_LOG=1
4708 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4710 * This makes the logger controllable enough that it can reasonably be
4711 * added to the system perl.
4714 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4715 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4717 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4719 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4720 * writes to. In the default logger, this is settable at runtime.
4722 #ifndef PERL_MEM_LOG_FD
4723 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4726 #ifndef PERL_MEM_LOG_NOIMPL
4728 # ifdef DEBUG_LEAKING_SCALARS
4729 # define SV_LOG_SERIAL_FMT " [%lu]"
4730 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4732 # define SV_LOG_SERIAL_FMT
4733 # define _SV_LOG_SERIAL_ARG(sv)
4737 S_mem_log_common(enum mem_log_type mlt, const UV n,
4738 const UV typesize, const char *type_name, const SV *sv,
4739 Malloc_t oldalloc, Malloc_t newalloc,
4740 const char *filename, const int linenumber,
4741 const char *funcname)
4745 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4747 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4750 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4752 /* We can't use SVs or PerlIO for obvious reasons,
4753 * so we'll use stdio and low-level IO instead. */
4754 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4756 # ifdef HAS_GETTIMEOFDAY
4757 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4758 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4760 gettimeofday(&tv, 0);
4762 # define MEM_LOG_TIME_FMT "%10d: "
4763 # define MEM_LOG_TIME_ARG (int)when
4767 /* If there are other OS specific ways of hires time than
4768 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4769 * probably that they would be used to fill in the struct
4773 const char* endptr = pmlenv + strlen(pmlenv);
4776 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4777 && uv && uv <= PERL_INT_MAX
4781 fd = PERL_MEM_LOG_FD;
4784 if (strchr(pmlenv, 't')) {
4785 len = my_snprintf(buf, sizeof(buf),
4786 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4787 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4791 len = my_snprintf(buf, sizeof(buf),
4792 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4793 " %s = %" IVdf ": %" UVxf "\n",
4794 filename, linenumber, funcname, n, typesize,
4795 type_name, n * typesize, PTR2UV(newalloc));
4798 len = my_snprintf(buf, sizeof(buf),
4799 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4800 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4801 filename, linenumber, funcname, n, typesize,
4802 type_name, n * typesize, PTR2UV(oldalloc),
4806 len = my_snprintf(buf, sizeof(buf),
4807 "free: %s:%d:%s: %" UVxf "\n",
4808 filename, linenumber, funcname,
4813 len = my_snprintf(buf, sizeof(buf),
4814 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
4815 mlt == MLT_NEW_SV ? "new" : "del",
4816 filename, linenumber, funcname,
4817 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4822 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4826 #endif /* !PERL_MEM_LOG_NOIMPL */
4828 #ifndef PERL_MEM_LOG_NOIMPL
4830 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4831 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4833 /* this is suboptimal, but bug compatible. User is providing their
4834 own implementation, but is getting these functions anyway, and they
4835 do nothing. But _NOIMPL users should be able to cope or fix */
4837 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4838 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
4842 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4844 const char *filename, const int linenumber,
4845 const char *funcname)
4847 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
4849 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4850 NULL, NULL, newalloc,
4851 filename, linenumber, funcname);
4856 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4857 Malloc_t oldalloc, Malloc_t newalloc,
4858 const char *filename, const int linenumber,
4859 const char *funcname)
4861 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
4863 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4864 NULL, oldalloc, newalloc,
4865 filename, linenumber, funcname);
4870 Perl_mem_log_free(Malloc_t oldalloc,
4871 const char *filename, const int linenumber,
4872 const char *funcname)
4874 PERL_ARGS_ASSERT_MEM_LOG_FREE;
4876 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4877 filename, linenumber, funcname);
4882 Perl_mem_log_new_sv(const SV *sv,
4883 const char *filename, const int linenumber,
4884 const char *funcname)
4886 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4887 filename, linenumber, funcname);
4891 Perl_mem_log_del_sv(const SV *sv,
4892 const char *filename, const int linenumber,
4893 const char *funcname)
4895 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4896 filename, linenumber, funcname);
4899 #endif /* PERL_MEM_LOG */
4902 =for apidoc quadmath_format_single
4904 C<quadmath_snprintf()> is very strict about its C<format> string and will
4905 fail, returning -1, if the format is invalid. It accepts exactly
4908 C<quadmath_format_single()> checks that the intended single spec looks
4909 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
4910 and has C<Q> before it. This is not a full "printf syntax check",
4913 Returns the format if it is valid, NULL if not.
4915 C<quadmath_format_single()> can and will actually patch in the missing
4916 C<Q>, if necessary. In this case it will return the modified copy of
4917 the format, B<which the caller will need to free.>
4919 See also L</quadmath_format_needed>.
4925 Perl_quadmath_format_single(const char* format)
4929 PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
4931 if (format[0] != '%' || strchr(format + 1, '%'))
4933 len = strlen(format);
4934 /* minimum length three: %Qg */
4935 if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
4937 if (format[len - 2] != 'Q') {
4939 Newx(fixed, len + 1, char);
4940 memcpy(fixed, format, len - 1);
4941 fixed[len - 1] = 'Q';
4942 fixed[len ] = format[len - 1];
4944 return (const char*)fixed;
4951 =for apidoc quadmath_format_needed
4953 C<quadmath_format_needed()> returns true if the C<format> string seems to
4954 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
4955 or returns false otherwise.
4957 The format specifier detection is not complete printf-syntax detection,
4958 but it should catch most common cases.
4960 If true is returned, those arguments B<should> in theory be processed
4961 with C<quadmath_snprintf()>, but in case there is more than one such
4962 format specifier (see L</quadmath_format_single>), and if there is
4963 anything else beyond that one (even just a single byte), they
4964 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
4965 accepting only one format spec, and nothing else.
4966 In this case, the code should probably fail.
4972 Perl_quadmath_format_needed(const char* format)
4974 const char *p = format;
4977 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
4979 while ((q = strchr(p, '%'))) {
4981 if (*q == '+') /* plus */
4983 if (*q == '#') /* alt */
4985 if (*q == '*') /* width */
4989 while (isDIGIT(*q)) q++;
4992 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
4997 while (isDIGIT(*q)) q++;
4999 if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5008 =for apidoc my_snprintf
5010 The C library C<snprintf> functionality, if available and
5011 standards-compliant (uses C<vsnprintf>, actually). However, if the
5012 C<vsnprintf> is not available, will unfortunately use the unsafe
5013 C<vsprintf> which can overrun the buffer (there is an overrun check,
5014 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5015 getting C<vsnprintf>.
5020 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5024 PERL_ARGS_ASSERT_MY_SNPRINTF;
5025 #ifndef HAS_VSNPRINTF
5026 PERL_UNUSED_VAR(len);
5028 va_start(ap, format);
5031 const char* qfmt = quadmath_format_single(format);
5032 bool quadmath_valid = FALSE;
5034 /* If the format looked promising, use it as quadmath. */
5035 retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
5037 if (qfmt != format) {
5041 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
5043 quadmath_valid = TRUE;
5048 assert(qfmt == NULL);
5049 /* quadmath_format_single() will return false for example for
5050 * "foo = %g", or simply "%g". We could handle the %g by
5051 * using quadmath for the NV args. More complex cases of
5052 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5053 * quadmath-valid but has stuff in front).
5055 * Handling the "Q-less" cases right would require walking
5056 * through the va_list and rewriting the format, calling
5057 * quadmath for the NVs, building a new va_list, and then
5058 * letting vsnprintf/vsprintf to take care of the other
5059 * arguments. This may be doable.
5061 * We do not attempt that now. But for paranoia, we here try
5062 * to detect some common (but not all) cases where the
5063 * "Q-less" %[efgaEFGA] formats are present, and die if
5064 * detected. This doesn't fix the problem, but it stops the
5065 * vsnprintf/vsprintf pulling doubles off the va_list when
5066 * __float128 NVs should be pulled off instead.
5068 * If quadmath_format_needed() returns false, we are reasonably
5069 * certain that we can call vnsprintf() or vsprintf() safely. */
5070 if (!quadmath_valid && quadmath_format_needed(format))
5071 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5076 #ifdef HAS_VSNPRINTF
5077 retval = vsnprintf(buffer, len, format, ap);
5079 retval = vsprintf(buffer, format, ap);
5082 /* vsprintf() shows failure with < 0 */
5084 #ifdef HAS_VSNPRINTF
5085 /* vsnprintf() shows failure with >= len */
5087 (len > 0 && (Size_t)retval >= len)
5090 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5095 =for apidoc my_vsnprintf
5097 The C library C<vsnprintf> if available and standards-compliant.
5098 However, if if the C<vsnprintf> is not available, will unfortunately
5099 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5100 overrun check, but that may be too late). Consider using
5101 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5106 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5109 PERL_UNUSED_ARG(buffer);
5110 PERL_UNUSED_ARG(len);
5111 PERL_UNUSED_ARG(format);
5112 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5113 PERL_UNUSED_ARG((void*)ap);
5114 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5121 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5122 Perl_va_copy(ap, apc);
5123 # ifdef HAS_VSNPRINTF
5124 retval = vsnprintf(buffer, len, format, apc);
5126 PERL_UNUSED_ARG(len);
5127 retval = vsprintf(buffer, format, apc);
5131 # ifdef HAS_VSNPRINTF
5132 retval = vsnprintf(buffer, len, format, ap);
5134 PERL_UNUSED_ARG(len);
5135 retval = vsprintf(buffer, format, ap);
5137 #endif /* #ifdef NEED_VA_COPY */
5138 /* vsprintf() shows failure with < 0 */
5140 #ifdef HAS_VSNPRINTF
5141 /* vsnprintf() shows failure with >= len */
5143 (len > 0 && (Size_t)retval >= len)
5146 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5152 Perl_my_clearenv(pTHX)
5155 #if ! defined(PERL_MICRO)
5156 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5158 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5159 # if defined(USE_ENVIRON_ARRAY)
5160 # if defined(USE_ITHREADS)
5161 /* only the parent thread can clobber the process environment */
5162 if (PL_curinterp == aTHX)
5163 # endif /* USE_ITHREADS */
5165 # if ! defined(PERL_USE_SAFE_PUTENV)
5166 if ( !PL_use_safe_putenv) {
5168 if (environ == PL_origenviron)
5169 environ = (char**)safesysmalloc(sizeof(char*));
5171 for (i = 0; environ[i]; i++)
5172 (void)safesysfree(environ[i]);
5175 # else /* PERL_USE_SAFE_PUTENV */
5176 # if defined(HAS_CLEARENV)
5178 # elif defined(HAS_UNSETENV)
5179 int bsiz = 80; /* Most envvar names will be shorter than this. */
5180 char *buf = (char*)safesysmalloc(bsiz);
5181 while (*environ != NULL) {
5182 char *e = strchr(*environ, '=');
5183 int l = e ? e - *environ : (int)strlen(*environ);
5185 (void)safesysfree(buf);
5186 bsiz = l + 1; /* + 1 for the \0. */
5187 buf = (char*)safesysmalloc(bsiz);
5189 memcpy(buf, *environ, l);
5191 (void)unsetenv(buf);
5193 (void)safesysfree(buf);
5194 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5195 /* Just null environ and accept the leakage. */
5197 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5198 # endif /* ! PERL_USE_SAFE_PUTENV */
5200 # endif /* USE_ENVIRON_ARRAY */
5201 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5202 #endif /* PERL_MICRO */
5205 #ifdef PERL_IMPLICIT_CONTEXT
5208 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5210 /* rather than each module having a static var holding its index,
5211 * use a global array of name to index mappings
5214 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5219 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5221 for (index = 0; index < PL_my_cxt_index; index++) {
5222 const char *key = PL_my_cxt_keys[index];
5223 /* try direct pointer compare first - there are chances to success,
5224 * and it's much faster.
5226 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5234 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5235 the global PL_my_cxt_index is incremented, and that value is assigned to
5236 that module's static my_cxt_index (who's address is passed as an arg).
5237 Then, for each interpreter this function is called for, it makes sure a
5238 void* slot is available to hang the static data off, by allocating or
5239 extending the interpreter's PL_my_cxt_list array */
5242 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5243 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5245 Perl_my_cxt_init(pTHX_ int *indexp, size_t size)
5252 PERL_ARGS_ASSERT_MY_CXT_INIT;
5254 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5255 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5259 /* do initial check without locking.
5260 * -1: not allocated or another thread currently allocating
5261 * other: already allocated by another thread
5264 MUTEX_LOCK(&PL_my_ctx_mutex);
5265 /*now a stricter check with locking */
5266 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5267 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5272 /* this module hasn't been allocated an index yet */
5273 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5274 index = PL_my_cxt_index++;
5276 /* Store the index in a global MY_CXT_KEY string to index mapping
5277 * table. This emulates the perl-module static my_cxt_index var on
5278 * builds which don't allow static vars */
5279 if (PL_my_cxt_keys_size <= index) {
5280 int old_size = PL_my_cxt_keys_size;
5282 if (PL_my_cxt_keys_size) {
5283 IV new_size = PL_my_cxt_keys_size;
5284 while (new_size <= index)
5286 PL_my_cxt_keys = (const char **)PerlMemShared_realloc(
5288 new_size * sizeof(const char *));
5289 PL_my_cxt_keys_size = new_size;
5292 PL_my_cxt_keys_size = 16;
5293 PL_my_cxt_keys = (const char **)PerlMemShared_malloc(
5294 PL_my_cxt_keys_size * sizeof(const char *));
5296 for (i = old_size; i < PL_my_cxt_keys_size; i++) {
5297 PL_my_cxt_keys[i] = 0;
5300 PL_my_cxt_keys[index] = my_cxt_key;
5302 *indexp = PL_my_cxt_index++;
5305 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5308 /* make sure the array is big enough */
5309 if (PL_my_cxt_size <= index) {
5310 if (PL_my_cxt_size) {
5311 IV new_size = PL_my_cxt_size;
5312 while (new_size <= index)
5314 Renew(PL_my_cxt_list, new_size, void *);
5315 PL_my_cxt_size = new_size;
5318 PL_my_cxt_size = 16;
5319 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5322 /* newSV() allocates one more than needed */
5323 p = (void*)SvPVX(newSV(size-1));
5324 PL_my_cxt_list[index] = p;
5325 Zero(p, size, char);
5329 #endif /* PERL_IMPLICIT_CONTEXT */
5332 /* Perl_xs_handshake():
5333 implement the various XS_*_BOOTCHECK macros, which are added to .c
5334 files by ExtUtils::ParseXS, to check that the perl the module was built
5335 with is binary compatible with the running perl.
5338 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5339 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5341 The meaning of the varargs is determined the U32 key arg (which is not
5342 a format string). The fields of key are assembled by using HS_KEY().
5344 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5345 "PerlInterpreter *" and represents the callers context; otherwise it is
5346 of type "CV *", and is the boot xsub's CV.
5348 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5349 for example, and IO.dll was linked with threaded perl524.dll, and both
5350 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5351 successfully can load IO.dll into the process but simultaneously it
5352 loaded an interpreter of a different version into the process, and XS
5353 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5354 use through perl526.dll's my_perl->Istack_base.
5356 v_my_perl cannot be the first arg, since then 'key' will be out of
5357 place in a threaded vs non-threaded mixup; and analyzing the key
5358 number's bitfields won't reveal the problem, since it will be a valid
5359 key (unthreaded perl) on interp side, but croak will report the XS mod's
5360 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5361 it's a threaded perl and an unthreaded XS module, threaded perl will
5362 look at an uninit C stack or an uninit register to get 'key'
5363 (remember that it assumes that the 1st arg is the interp cxt).
5365 'file' is the source filename of the caller.
5369 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5375 #ifdef PERL_IMPLICIT_CONTEXT
5382 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5383 va_start(args, file);
5385 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5386 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5387 if (UNLIKELY(got != need))
5389 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5390 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5391 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5392 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5393 passed to the XS DLL */
5394 #ifdef PERL_IMPLICIT_CONTEXT
5395 xs_interp = (tTHX)v_my_perl;
5399 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5400 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5401 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5402 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5403 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5404 location in the unthreaded perl binary) stored in CV * to figure out if this
5405 Perl_xs_handshake was called by the same pp_entersub */
5406 cv = (CV*)v_my_perl;
5407 xs_spp = (SV***)CvHSCXT(cv);
5409 need = &PL_stack_sp;
5411 if(UNLIKELY(got != need)) {
5412 bad_handshake:/* recycle branch and string from above */
5413 if(got != (void *)HSf_NOCHK)
5414 noperl_die("%s: loadable library and perl binaries are mismatched"
5415 " (got handshake key %p, needed %p)\n",
5419 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5420 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5421 PL_xsubfilename = file; /* so the old name must be restored for
5422 additional XSUBs to register themselves */
5423 /* XSUBs can't be perl lang/perl5db.pl debugged
5424 if (PERLDB_LINE_OR_SAVESRC)
5425 (void)gv_fetchfile(file); */
5428 if(key & HSf_POPMARK) {
5430 { SV **mark = PL_stack_base + ax++;
5432 items = (I32)(SP - MARK);
5436 items = va_arg(args, U32);
5437 ax = va_arg(args, U32);
5441 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5442 if((apiverlen = HS_GETAPIVERLEN(key))) {
5443 char * api_p = va_arg(args, char*);
5444 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5445 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5446 sizeof("v" PERL_API_VERSION_STRING)-1))
5447 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5448 api_p, SVfARG(PL_stack_base[ax + 0]),
5449 "v" PERL_API_VERSION_STRING);
5454 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5455 if((xsverlen = HS_GETXSVERLEN(key)))
5456 S_xs_version_bootcheck(aTHX_
5457 items, ax, va_arg(args, char*), xsverlen);
5465 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5469 const char *vn = NULL;
5470 SV *const module = PL_stack_base[ax];
5472 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5474 if (items >= 2) /* version supplied as bootstrap arg */
5475 sv = PL_stack_base[ax + 1];
5477 /* XXX GV_ADDWARN */
5479 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5480 if (!sv || !SvOK(sv)) {
5482 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5486 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5487 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5488 ? sv : sv_2mortal(new_version(sv));
5489 xssv = upg_version(xssv, 0);
5490 if ( vcmp(pmsv,xssv) ) {
5491 SV *string = vstringify(xssv);
5492 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5493 " does not match ", SVfARG(module), SVfARG(string));
5495 SvREFCNT_dec(string);
5496 string = vstringify(pmsv);
5499 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5502 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5504 SvREFCNT_dec(string);
5506 Perl_sv_2mortal(aTHX_ xpt);
5507 Perl_croak_sv(aTHX_ xpt);
5513 =for apidoc my_strlcat
5515 The C library C<strlcat> if available, or a Perl implementation of it.
5516 This operates on C C<NUL>-terminated strings.
5518 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5519 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5520 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5521 practice this should not happen as it means that either C<size> is incorrect or
5522 that C<dst> is not a proper C<NUL>-terminated string).
5524 Note that C<size> is the full size of the destination buffer and
5525 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5526 room for the C<NUL> should be included in C<size>.
5528 The return value is the total length that C<dst> would have if C<size> is
5529 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5530 C<src>. If C<size> is smaller than the return, the excess was not appended.
5534 Description stolen from http://man.openbsd.org/strlcat.3
5538 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5540 Size_t used, length, copy;
5543 length = strlen(src);
5544 if (size > 0 && used < size - 1) {
5545 copy = (length >= size - used) ? size - used - 1 : length;
5546 memcpy(dst + used, src, copy);
5547 dst[used + copy] = '\0';
5549 return used + length;
5555 =for apidoc my_strlcpy
5557 The C library C<strlcpy> if available, or a Perl implementation of it.
5558 This operates on C C<NUL>-terminated strings.
5560 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5561 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5563 The return value is the total length C<src> would be if the copy completely
5564 succeeded. If it is larger than C<size>, the excess was not copied.
5568 Description stolen from http://man.openbsd.org/strlcpy.3
5572 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5574 Size_t length, copy;
5576 length = strlen(src);
5578 copy = (length >= size) ? size - 1 : length;
5579 memcpy(dst, src, copy);
5587 =for apidoc my_strnlen
5589 The C library C<strnlen> if available, or a Perl implementation of it.
5591 C<my_strnlen()> computes the length of the string, up to C<maxlen>
5592 characters. It will will never attempt to address more than C<maxlen>
5593 characters, making it suitable for use with strings that are not
5594 guaranteed to be NUL-terminated.
5598 Description stolen from http://man.openbsd.org/strnlen.3,
5599 implementation stolen from PostgreSQL.
5603 Perl_my_strnlen(const char *str, Size_t maxlen)
5605 const char *p = str;
5607 PERL_ARGS_ASSERT_MY_STRNLEN;
5609 while(maxlen-- && *p)
5616 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5617 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5618 long _ftol( double ); /* Defined by VC6 C libs. */
5619 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5622 PERL_STATIC_INLINE bool
5623 S_gv_has_usable_name(pTHX_ GV *gv)
5627 && HvENAME(GvSTASH(gv))
5628 && (gvp = (GV **)hv_fetchhek(
5629 GvSTASH(gv), GvNAME_HEK(gv), 0
5635 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5637 SV * const dbsv = GvSVn(PL_DBsub);
5638 const bool save_taint = TAINT_get;
5640 /* When we are called from pp_goto (svp is null),
5641 * we do not care about using dbsv to call CV;
5642 * it's for informational purposes only.
5645 PERL_ARGS_ASSERT_GET_DB_SUB;
5649 if (!PERLDB_SUB_NN) {
5652 if (!svp && !CvLEXICAL(cv)) {
5653 gv_efullname3(dbsv, gv, NULL);
5655 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5656 || strEQ(GvNAME(gv), "END")
5657 || ( /* Could be imported, and old sub redefined. */
5658 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5660 !( (SvTYPE(*svp) == SVt_PVGV)
5661 && (GvCV((const GV *)*svp) == cv)
5662 /* Use GV from the stack as a fallback. */
5663 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5667 /* GV is potentially non-unique, or contain different CV. */
5668 SV * const tmp = newRV(MUTABLE_SV(cv));
5669 sv_setsv(dbsv, tmp);
5673 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5674 sv_catpvs(dbsv, "::");
5675 sv_cathek(dbsv, GvNAME_HEK(gv));
5679 const int type = SvTYPE(dbsv);
5680 if (type < SVt_PVIV && type != SVt_IV)
5681 sv_upgrade(dbsv, SVt_PVIV);
5682 (void)SvIOK_on(dbsv);
5683 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5686 TAINT_IF(save_taint);
5687 #ifdef NO_TAINT_SUPPORT
5688 PERL_UNUSED_VAR(save_taint);
5693 Perl_my_dirfd(DIR * dir) {
5695 /* Most dirfd implementations have problems when passed NULL. */
5700 #elif defined(HAS_DIR_DD_FD)
5703 Perl_croak_nocontext(PL_no_func, "dirfd");
5704 NOT_REACHED; /* NOTREACHED */
5709 #if !defined(HAS_MKOSTEMP) || !defined(HAS_MKSTEMP)
5711 #define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
5712 #define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
5715 S_my_mkostemp(char *templte, int flags) {
5717 STRLEN len = strlen(templte);
5722 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
5723 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
5724 SETERRNO(EINVAL, LIB_INVARG);
5730 for (i = 1; i <= 6; ++i) {
5731 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
5733 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600);
5734 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
5741 #ifndef HAS_MKOSTEMP
5743 Perl_my_mkostemp(char *templte, int flags)
5745 PERL_ARGS_ASSERT_MY_MKOSTEMP;
5746 return S_my_mkostemp(templte, flags);
5752 Perl_my_mkstemp(char *templte)
5754 PERL_ARGS_ASSERT_MY_MKSTEMP;
5755 return S_my_mkostemp(templte, 0);
5760 Perl_get_re_arg(pTHX_ SV *sv) {
5766 sv = MUTABLE_SV(SvRV(sv));
5767 if (SvTYPE(sv) == SVt_REGEXP)
5768 return (REGEXP*) sv;
5775 * This code is derived from drand48() implementation from FreeBSD,
5776 * found in lib/libc/gen/_rand48.c.
5778 * The U64 implementation is original, based on the POSIX
5779 * specification for drand48().
5783 * Copyright (c) 1993 Martin Birgmeier
5784 * All rights reserved.
5786 * You may redistribute unmodified or modified versions of this source
5787 * code provided that the above copyright notice and this and the
5788 * following conditions are retained.
5790 * This software is provided ``as is'', and comes with no warranties
5791 * of any kind. I shall in no event be liable for anything that happens
5792 * to anyone/anything when using this software.
5795 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5797 #ifdef PERL_DRAND48_QUAD
5799 #define DRAND48_MULT UINT64_C(0x5deece66d)
5800 #define DRAND48_ADD 0xb
5801 #define DRAND48_MASK UINT64_C(0xffffffffffff)
5805 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5806 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5807 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5808 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5809 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5810 #define FREEBSD_DRAND48_ADD (0x000b)
5812 const unsigned short _rand48_mult[3] = {
5813 FREEBSD_DRAND48_MULT_0,
5814 FREEBSD_DRAND48_MULT_1,
5815 FREEBSD_DRAND48_MULT_2
5817 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5822 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5824 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5826 #ifdef PERL_DRAND48_QUAD
5827 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5829 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5830 random_state->seed[1] = (U16) seed;
5831 random_state->seed[2] = (U16) (seed >> 16);
5836 Perl_drand48_r(perl_drand48_t *random_state)
5838 PERL_ARGS_ASSERT_DRAND48_R;
5840 #ifdef PERL_DRAND48_QUAD
5841 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5844 return ldexp((double)*random_state, -48);
5850 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5851 + (U32) _rand48_add;
5852 temp[0] = (U16) accu; /* lower 16 bits */
5853 accu >>= sizeof(U16) * 8;
5854 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5855 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5856 temp[1] = (U16) accu; /* middle 16 bits */
5857 accu >>= sizeof(U16) * 8;
5858 accu += _rand48_mult[0] * random_state->seed[2]
5859 + _rand48_mult[1] * random_state->seed[1]
5860 + _rand48_mult[2] * random_state->seed[0];
5861 random_state->seed[0] = temp[0];
5862 random_state->seed[1] = temp[1];
5863 random_state->seed[2] = (U16) accu;
5865 return ldexp((double) random_state->seed[0], -48) +
5866 ldexp((double) random_state->seed[1], -32) +
5867 ldexp((double) random_state->seed[2], -16);
5872 #ifdef USE_C_BACKTRACE
5874 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5879 /* abfd is the BFD handle. */
5881 /* bfd_syms is the BFD symbol table. */
5883 /* bfd_text is handle to the the ".text" section of the object file. */
5885 /* Since opening the executable and scanning its symbols is quite
5886 * heavy operation, we remember the filename we used the last time,
5887 * and do the opening and scanning only if the filename changes.
5888 * This removes most (but not all) open+scan cycles. */
5889 const char* fname_prev;
5892 /* Given a dl_info, update the BFD context if necessary. */
5893 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5895 /* BFD open and scan only if the filename changed. */
5896 if (ctx->fname_prev == NULL ||
5897 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5899 bfd_close(ctx->abfd);
5901 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5903 if (bfd_check_format(ctx->abfd, bfd_object)) {
5904 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5905 if (symbol_size > 0) {
5906 Safefree(ctx->bfd_syms);
5907 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5909 bfd_get_section_by_name(ctx->abfd, ".text");
5917 ctx->fname_prev = dl_info->dli_fname;
5921 /* Given a raw frame, try to symbolize it and store
5922 * symbol information (source file, line number) away. */
5923 static void bfd_symbolize(bfd_context* ctx,
5926 STRLEN* symbol_name_size,
5928 STRLEN* source_name_size,
5929 STRLEN* source_line)
5931 *symbol_name = NULL;
5932 *symbol_name_size = 0;
5934 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5936 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5939 unsigned int line = 0;
5940 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5941 ctx->bfd_syms, offset,
5942 &file, &func, &line) &&
5943 file && func && line > 0) {
5944 /* Size and copy the source file, use only
5945 * the basename of the source file.
5947 * NOTE: the basenames are fine for the
5948 * Perl source files, but may not always
5949 * be the best idea for XS files. */
5950 const char *p, *b = NULL;
5951 /* Look for the last slash. */
5952 for (p = file; *p; p++) {
5956 if (b == NULL || *b == 0) {
5959 *source_name_size = p - b + 1;
5960 Newx(*source_name, *source_name_size + 1, char);
5961 Copy(b, *source_name, *source_name_size + 1, char);
5963 *symbol_name_size = strlen(func);
5964 Newx(*symbol_name, *symbol_name_size + 1, char);
5965 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5967 *source_line = line;
5973 #endif /* #ifdef USE_BFD */
5977 /* OS X has no public API for for 'symbolicating' (Apple official term)
5978 * stack addresses to {function_name, source_file, line_number}.
5979 * Good news: there is command line utility atos(1) which does that.
5980 * Bad news 1: it's a command line utility.
5981 * Bad news 2: one needs to have the Developer Tools installed.
5982 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
5984 * To recap: we need to open a pipe for reading for a utility which
5985 * might not exist, or exists in different locations, and then parse
5986 * the output. And since this is all for a low-level API, we cannot
5987 * use high-level stuff. Thanks, Apple. */
5990 /* tool is set to the absolute pathname of the tool to use:
5993 /* format is set to a printf format string used for building
5994 * the external command to run. */
5996 /* unavail is set if e.g. xcrun cannot be found, or something
5997 * else happens that makes getting the backtrace dubious. Note,
5998 * however, that the context isn't persistent, the next call to
5999 * get_c_backtrace() will start from scratch. */
6001 /* fname is the current object file name. */
6003 /* object_base_addr is the base address of the shared object. */
6004 void* object_base_addr;
6007 /* Given |dl_info|, updates the context. If the context has been
6008 * marked unavailable, return immediately. If not but the tool has
6009 * not been set, set it to either "xcrun atos" or "atos" (also set the
6010 * format to use for creating commands for piping), or if neither is
6011 * unavailable (one needs the Developer Tools installed), mark the context
6012 * an unavailable. Finally, update the filename (object name),
6013 * and its base address. */
6015 static void atos_update(atos_context* ctx,
6020 if (ctx->tool == NULL) {
6021 const char* tools[] = {
6025 const char* formats[] = {
6026 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6027 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6031 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6032 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6033 ctx->tool = tools[i];
6034 ctx->format = formats[i];
6038 if (ctx->tool == NULL) {
6039 ctx->unavail = TRUE;
6043 if (ctx->fname == NULL ||
6044 strNE(dl_info->dli_fname, ctx->fname)) {
6045 ctx->fname = dl_info->dli_fname;
6046 ctx->object_base_addr = dl_info->dli_fbase;
6050 /* Given an output buffer end |p| and its |start|, matches
6051 * for the atos output, extracting the source code location
6052 * and returning non-NULL if possible, returning NULL otherwise. */
6053 static const char* atos_parse(const char* p,
6055 STRLEN* source_name_size,
6056 STRLEN* source_line) {
6057 /* atos() output is something like:
6058 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6059 * We cannot use Perl regular expressions, because we need to
6060 * stay low-level. Therefore here we have a rolled-out version
6061 * of a state machine which matches _backwards_from_the_end_ and
6062 * if there's a success, returns the starts of the filename,
6063 * also setting the filename size and the source line number.
6064 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6065 const char* source_number_start;
6066 const char* source_name_end;
6067 const char* source_line_end = start;
6068 const char* close_paren;
6071 /* Skip trailing whitespace. */
6072 while (p > start && isSPACE(*p)) p--;
6073 /* Now we should be at the close paren. */
6074 if (p == start || *p != ')')
6078 /* Now we should be in the line number. */
6079 if (p == start || !isDIGIT(*p))
6081 /* Skip over the digits. */
6082 while (p > start && isDIGIT(*p))
6084 /* Now we should be at the colon. */
6085 if (p == start || *p != ':')
6087 source_number_start = p + 1;
6088 source_name_end = p; /* Just beyond the end. */
6090 /* Look for the open paren. */
6091 while (p > start && *p != '(')
6096 *source_name_size = source_name_end - p;
6097 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6098 && source_line_end == close_paren
6099 && uv <= PERL_INT_MAX
6101 *source_line = (STRLEN)uv;
6107 /* Given a raw frame, read a pipe from the symbolicator (that's the
6108 * technical term) atos, reads the result, and parses the source code
6109 * location. We must stay low-level, so we use snprintf(), pipe(),
6110 * and fread(), and then also parse the output ourselves. */
6111 static void atos_symbolize(atos_context* ctx,
6114 STRLEN* source_name_size,
6115 STRLEN* source_line)
6123 /* Simple security measure: if there's any funny business with
6124 * the object name (used as "-o '%s'" ), leave since at least
6125 * partially the user controls it. */
6126 for (p = ctx->fname; *p; p++) {
6127 if (*p == '\'' || isCNTRL(*p)) {
6128 ctx->unavail = TRUE;
6132 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6133 ctx->fname, ctx->object_base_addr, raw_frame);
6134 if (cnt < sizeof(cmd)) {
6135 /* Undo nostdio.h #defines that disable stdio.
6136 * This is somewhat naughty, but is used elsewhere
6137 * in the core, and affects only OS X. */
6142 FILE* fp = popen(cmd, "r");
6143 /* At the moment we open a new pipe for each stack frame.
6144 * This is naturally somewhat slow, but hopefully generating
6145 * stack traces is never going to in a performance critical path.
6147 * We could play tricks with atos by batching the stack
6148 * addresses to be resolved: atos can either take multiple
6149 * addresses from the command line, or read addresses from
6150 * a file (though the mess of creating temporary files would
6151 * probably negate much of any possible speedup).
6153 * Normally there are only two objects present in the backtrace:
6154 * perl itself, and the libdyld.dylib. (Note that the object
6155 * filenames contain the full pathname, so perl may not always
6156 * be in the same place.) Whenever the object in the
6157 * backtrace changes, the base address also changes.
6159 * The problem with batching the addresses, though, would be
6160 * matching the results with the addresses: the parsing of
6161 * the results is already painful enough with a single address. */
6164 UV cnt = fread(out, 1, sizeof(out), fp);
6165 if (cnt < sizeof(out)) {
6166 const char* p = atos_parse(out + cnt - 1, out,
6171 *source_name_size, char);
6172 Copy(p, *source_name,
6173 *source_name_size, char);
6181 #endif /* #ifdef PERL_DARWIN */
6184 =for apidoc get_c_backtrace
6186 Collects the backtrace (aka "stacktrace") into a single linear
6187 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6189 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6190 returning at most C<depth> frames.
6196 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6198 /* Note that here we must stay as low-level as possible: Newx(),
6199 * Copy(), Safefree(); since we may be called from anywhere,
6200 * so we should avoid higher level constructs like SVs or AVs.
6202 * Since we are using safesysmalloc() via Newx(), don't try
6203 * getting backtrace() there, unless you like deep recursion. */
6205 /* Currently only implemented with backtrace() and dladdr(),
6206 * for other platforms NULL is returned. */
6208 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6209 /* backtrace() is available via <execinfo.h> in glibc and in most
6210 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6212 /* We try fetching this many frames total, but then discard
6213 * the |skip| first ones. For the remaining ones we will try
6214 * retrieving more information with dladdr(). */
6215 int try_depth = skip + depth;
6217 /* The addresses (program counters) returned by backtrace(). */
6220 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6223 /* Sizes _including_ the terminating \0 of the object name
6224 * and symbol name strings. */
6225 STRLEN* object_name_sizes;
6226 STRLEN* symbol_name_sizes;
6229 /* The symbol names comes either from dli_sname,
6230 * or if using BFD, they can come from BFD. */
6231 char** symbol_names;
6234 /* The source code location information. Dug out with e.g. BFD. */
6235 char** source_names;
6236 STRLEN* source_name_sizes;
6237 STRLEN* source_lines;
6239 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6240 int got_depth; /* How many frames were returned from backtrace(). */
6241 UV frame_count = 0; /* How many frames we return. */
6242 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6245 bfd_context bfd_ctx;
6248 atos_context atos_ctx;
6251 /* Here are probably possibilities for optimizing. We could for
6252 * example have a struct that contains most of these and then
6253 * allocate |try_depth| of them, saving a bunch of malloc calls.
6254 * Note, however, that |frames| could not be part of that struct
6255 * because backtrace() will want an array of just them. Also be
6256 * careful about the name strings. */
6257 Newx(raw_frames, try_depth, void*);
6258 Newx(dl_infos, try_depth, Dl_info);
6259 Newx(object_name_sizes, try_depth, STRLEN);
6260 Newx(symbol_name_sizes, try_depth, STRLEN);
6261 Newx(source_names, try_depth, char*);
6262 Newx(source_name_sizes, try_depth, STRLEN);
6263 Newx(source_lines, try_depth, STRLEN);
6265 Newx(symbol_names, try_depth, char*);
6268 /* Get the raw frames. */
6269 got_depth = (int)backtrace(raw_frames, try_depth);
6271 /* We use dladdr() instead of backtrace_symbols() because we want
6272 * the full details instead of opaque strings. This is useful for
6273 * two reasons: () the details are needed for further symbolic
6274 * digging, for example in OS X (2) by having the details we fully
6275 * control the output, which in turn is useful when more platforms
6276 * are added: we can keep out output "portable". */
6278 /* We want a single linear allocation, which can then be freed
6279 * with a single swoop. We will do the usual trick of first
6280 * walking over the structure and seeing how much we need to
6281 * allocate, then allocating, and then walking over the structure
6282 * the second time and populating it. */
6284 /* First we must compute the total size of the buffer. */
6285 total_bytes = sizeof(Perl_c_backtrace_header);
6286 if (got_depth > skip) {
6289 bfd_init(); /* Is this safe to call multiple times? */
6290 Zero(&bfd_ctx, 1, bfd_context);
6293 Zero(&atos_ctx, 1, atos_context);
6295 for (i = skip; i < try_depth; i++) {
6296 Dl_info* dl_info = &dl_infos[i];
6298 object_name_sizes[i] = 0;
6299 source_names[i] = NULL;
6300 source_name_sizes[i] = 0;
6301 source_lines[i] = 0;
6303 /* Yes, zero from dladdr() is failure. */
6304 if (dladdr(raw_frames[i], dl_info)) {
6305 total_bytes += sizeof(Perl_c_backtrace_frame);
6307 object_name_sizes[i] =
6308 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6309 symbol_name_sizes[i] =
6310 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6312 bfd_update(&bfd_ctx, dl_info);
6313 bfd_symbolize(&bfd_ctx, raw_frames[i],
6315 &symbol_name_sizes[i],
6317 &source_name_sizes[i],
6321 atos_update(&atos_ctx, dl_info);
6322 atos_symbolize(&atos_ctx,
6325 &source_name_sizes[i],
6329 /* Plus ones for the terminating \0. */
6330 total_bytes += object_name_sizes[i] + 1;
6331 total_bytes += symbol_name_sizes[i] + 1;
6332 total_bytes += source_name_sizes[i] + 1;
6340 Safefree(bfd_ctx.bfd_syms);
6344 /* Now we can allocate and populate the result buffer. */
6345 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6346 Zero(bt, total_bytes, char);
6347 bt->header.frame_count = frame_count;
6348 bt->header.total_bytes = total_bytes;
6349 if (frame_count > 0) {
6350 Perl_c_backtrace_frame* frame = bt->frame_info;
6351 char* name_base = (char *)(frame + frame_count);
6352 char* name_curr = name_base; /* Outputting the name strings here. */
6354 for (i = skip; i < skip + frame_count; i++) {
6355 Dl_info* dl_info = &dl_infos[i];
6357 frame->addr = raw_frames[i];
6358 frame->object_base_addr = dl_info->dli_fbase;
6359 frame->symbol_addr = dl_info->dli_saddr;
6361 /* Copies a string, including the \0, and advances the name_curr.
6362 * Also copies the start and the size to the frame. */
6363 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6365 Copy(src, name_curr, size, char); \
6366 frame->doffset = name_curr - (char*)bt; \
6367 frame->dsize = size; \
6368 name_curr += size; \
6371 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6373 object_name_size, object_name_sizes[i]);
6376 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6378 symbol_name_size, symbol_name_sizes[i]);
6379 Safefree(symbol_names[i]);
6381 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6383 symbol_name_size, symbol_name_sizes[i]);
6386 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6388 source_name_size, source_name_sizes[i]);
6389 Safefree(source_names[i]);
6391 #undef PERL_C_BACKTRACE_STRCPY
6393 frame->source_line_number = source_lines[i];
6397 assert(total_bytes ==
6398 (UV)(sizeof(Perl_c_backtrace_header) +
6399 frame_count * sizeof(Perl_c_backtrace_frame) +
6400 name_curr - name_base));
6403 Safefree(symbol_names);
6405 bfd_close(bfd_ctx.abfd);
6408 Safefree(source_lines);
6409 Safefree(source_name_sizes);
6410 Safefree(source_names);
6411 Safefree(symbol_name_sizes);
6412 Safefree(object_name_sizes);
6413 /* Assuming the strings returned by dladdr() are pointers
6414 * to read-only static memory (the object file), so that
6415 * they do not need freeing (and cannot be). */
6417 Safefree(raw_frames);
6420 PERL_UNUSED_ARGV(depth);
6421 PERL_UNUSED_ARGV(skip);
6427 =for apidoc free_c_backtrace
6429 Deallocates a backtrace received from get_c_bracktrace.
6435 =for apidoc get_c_backtrace_dump
6437 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6438 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6440 The appended output looks like:
6443 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6444 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6447 The fields are tab-separated. The first column is the depth (zero
6448 being the innermost non-skipped frame). In the hex:offset, the hex is
6449 where the program counter was in C<S_parse_body>, and the :offset (might
6450 be missing) tells how much inside the C<S_parse_body> the program counter was.
6452 The C<util.c:1716> is the source code file and line number.
6454 The F</usr/bin/perl> is obvious (hopefully).
6456 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6457 if the platform doesn't support retrieving the information;
6458 if the binary is missing the debug information;
6459 if the optimizer has transformed the code by for example inlining.
6465 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6467 Perl_c_backtrace* bt;
6469 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6471 Perl_c_backtrace_frame* frame;
6472 SV* dsv = newSVpvs("");
6474 for (i = 0, frame = bt->frame_info;
6475 i < bt->header.frame_count; i++, frame++) {
6476 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6477 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6478 /* Symbol (function) names might disappear without debug info.
6480 * The source code location might disappear in case of the
6481 * optimizer inlining or otherwise rearranging the code. */
6482 if (frame->symbol_addr) {
6483 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6485 ((char*)frame->addr - (char*)frame->symbol_addr));
6487 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6488 frame->symbol_name_size &&
6489 frame->symbol_name_offset ?
6490 (char*)bt + frame->symbol_name_offset : "-");
6491 if (frame->source_name_size &&
6492 frame->source_name_offset &&
6493 frame->source_line_number) {
6494 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6495 (char*)bt + frame->source_name_offset,
6496 (UV)frame->source_line_number);
6498 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6500 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6501 frame->object_name_size &&
6502 frame->object_name_offset ?
6503 (char*)bt + frame->object_name_offset : "-");
6504 /* The frame->object_base_addr is not output,
6505 * but it is used for symbolizing/symbolicating. */
6506 sv_catpvs(dsv, "\n");
6509 Perl_free_c_backtrace(bt);
6518 =for apidoc dump_c_backtrace
6520 Dumps the C backtrace to the given C<fp>.
6522 Returns true if a backtrace could be retrieved, false if not.
6528 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6532 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6534 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6537 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6543 #endif /* #ifdef USE_C_BACKTRACE */
6545 #ifdef PERL_TSA_ACTIVE
6547 /* pthread_mutex_t and perl_mutex are typedef equivalent
6548 * so casting the pointers is fine. */
6550 int perl_tsa_mutex_lock(perl_mutex* mutex)
6552 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6555 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6557 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6560 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6562 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6570 /* log a sub call or return */
6573 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6581 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6584 HEK *hek = CvNAME_HEK(cv);
6585 func = HEK_KEY(hek);
6591 start = (const COP *)CvSTART(cv);
6592 file = CopFILE(start);
6593 line = CopLINE(start);
6594 stash = CopSTASHPV(start);
6597 PERL_SUB_ENTRY(func, file, line, stash);
6600 PERL_SUB_RETURN(func, file, line, stash);
6605 /* log a require file loading/loaded */
6608 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6610 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6613 PERL_LOADING_FILE(name);
6616 PERL_LOADED_FILE(name);
6621 /* log an op execution */
6624 Perl_dtrace_probe_op(pTHX_ const OP *op)
6626 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6628 PERL_OP_ENTRY(OP_NAME(op));
6632 /* log a compile/run phase change */
6635 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6637 const char *ph_old = PL_phase_names[PL_phase];
6638 const char *ph_new = PL_phase_names[phase];
6640 PERL_PHASE_CHANGE(ph_new, ph_old);
6646 * ex: set ts=8 sts=4 sw=4 et: