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)
1533 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1534 /* sv_2cv might call Perl_croak() or Perl_warner() */
1535 SV * const oldhook = *hook;
1537 if (!oldhook || oldhook == PERL_WARNHOOK_FATAL)
1543 cv = sv_2cv(oldhook, &stash, &gv, 0);
1545 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1555 exarg = newSVsv(ex);
1556 SvREADONLY_on(exarg);
1559 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1563 call_sv(MUTABLE_SV(cv), G_DISCARD);
1572 =for apidoc Am|OP *|die_sv|SV *baseex
1574 Behaves the same as L</croak_sv>, except for the return type.
1575 It should be used only where the C<OP *> return type is required.
1576 The function never actually returns.
1582 # pragma warning( push )
1583 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1584 __declspec(noreturn) has non-void return type */
1585 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1586 __declspec(noreturn) has a return statement */
1589 Perl_die_sv(pTHX_ SV *baseex)
1591 PERL_ARGS_ASSERT_DIE_SV;
1594 NORETURN_FUNCTION_END;
1597 # pragma warning( pop )
1601 =for apidoc Am|OP *|die|const char *pat|...
1603 Behaves the same as L</croak>, except for the return type.
1604 It should be used only where the C<OP *> return type is required.
1605 The function never actually returns.
1610 #if defined(PERL_IMPLICIT_CONTEXT)
1612 # pragma warning( push )
1613 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1614 __declspec(noreturn) has non-void return type */
1615 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1616 __declspec(noreturn) has a return statement */
1619 Perl_die_nocontext(const char* pat, ...)
1623 va_start(args, pat);
1625 NOT_REACHED; /* NOTREACHED */
1627 NORETURN_FUNCTION_END;
1630 # pragma warning( pop )
1632 #endif /* PERL_IMPLICIT_CONTEXT */
1635 # pragma warning( push )
1636 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1637 __declspec(noreturn) has non-void return type */
1638 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1639 __declspec(noreturn) has a return statement */
1642 Perl_die(pTHX_ const char* pat, ...)
1645 va_start(args, pat);
1647 NOT_REACHED; /* NOTREACHED */
1649 NORETURN_FUNCTION_END;
1652 # pragma warning( pop )
1656 =for apidoc Am|void|croak_sv|SV *baseex
1658 This is an XS interface to Perl's C<die> function.
1660 C<baseex> is the error message or object. If it is a reference, it
1661 will be used as-is. Otherwise it is used as a string, and if it does
1662 not end with a newline then it will be extended with some indication of
1663 the current location in the code, as described for L</mess_sv>.
1665 The error message or object will be used as an exception, by default
1666 returning control to the nearest enclosing C<eval>, but subject to
1667 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1668 function never returns normally.
1670 To die with a simple string message, the L</croak> function may be
1677 Perl_croak_sv(pTHX_ SV *baseex)
1679 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1680 PERL_ARGS_ASSERT_CROAK_SV;
1681 invoke_exception_hook(ex, FALSE);
1686 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1688 This is an XS interface to Perl's C<die> function.
1690 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1691 argument list. These are used to generate a string message. If the
1692 message does not end with a newline, then it will be extended with
1693 some indication of the current location in the code, as described for
1696 The error message will be used as an exception, by default
1697 returning control to the nearest enclosing C<eval>, but subject to
1698 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1699 function never returns normally.
1701 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1702 (C<$@>) will be used as an error message or object instead of building an
1703 error message from arguments. If you want to throw a non-string object,
1704 or build an error message in an SV yourself, it is preferable to use
1705 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1711 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1713 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1714 invoke_exception_hook(ex, FALSE);
1719 =for apidoc Am|void|croak|const char *pat|...
1721 This is an XS interface to Perl's C<die> function.
1723 Take a sprintf-style format pattern and argument list. These are used to
1724 generate a string message. If the message does not end with a newline,
1725 then it will be extended with some indication of the current location
1726 in the code, as described for L</mess_sv>.
1728 The error message will be used as an exception, by default
1729 returning control to the nearest enclosing C<eval>, but subject to
1730 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1731 function never returns normally.
1733 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1734 (C<$@>) will be used as an error message or object instead of building an
1735 error message from arguments. If you want to throw a non-string object,
1736 or build an error message in an SV yourself, it is preferable to use
1737 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1742 #if defined(PERL_IMPLICIT_CONTEXT)
1744 Perl_croak_nocontext(const char *pat, ...)
1748 va_start(args, pat);
1750 NOT_REACHED; /* NOTREACHED */
1753 #endif /* PERL_IMPLICIT_CONTEXT */
1756 Perl_croak(pTHX_ const char *pat, ...)
1759 va_start(args, pat);
1761 NOT_REACHED; /* NOTREACHED */
1766 =for apidoc Am|void|croak_no_modify
1768 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1769 terser object code than using C<Perl_croak>. Less code used on exception code
1770 paths reduces CPU cache pressure.
1776 Perl_croak_no_modify(void)
1778 Perl_croak_nocontext( "%s", PL_no_modify);
1781 /* does not return, used in util.c perlio.c and win32.c
1782 This is typically called when malloc returns NULL.
1785 Perl_croak_no_mem(void)
1789 int fd = PerlIO_fileno(Perl_error_log);
1791 SETERRNO(EBADF,RMS_IFI);
1793 /* Can't use PerlIO to write as it allocates memory */
1794 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1799 /* does not return, used only in POPSTACK */
1801 Perl_croak_popstack(void)
1804 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1809 =for apidoc Am|void|warn_sv|SV *baseex
1811 This is an XS interface to Perl's C<warn> function.
1813 C<baseex> is the error message or object. If it is a reference, it
1814 will be used as-is. Otherwise it is used as a string, and if it does
1815 not end with a newline then it will be extended with some indication of
1816 the current location in the code, as described for L</mess_sv>.
1818 The error message or object will by default be written to standard error,
1819 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1821 To warn with a simple string message, the L</warn> function may be
1828 Perl_warn_sv(pTHX_ SV *baseex)
1830 SV *ex = mess_sv(baseex, 0);
1831 PERL_ARGS_ASSERT_WARN_SV;
1832 if (!invoke_exception_hook(ex, TRUE))
1833 write_to_stderr(ex);
1837 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1839 This is an XS interface to Perl's C<warn> function.
1841 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1842 argument list. These are used to generate a string message. If the
1843 message does not end with a newline, then it will be extended with
1844 some indication of the current location in the code, as described for
1847 The error message or object will by default be written to standard error,
1848 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1850 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1856 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1858 SV *ex = vmess(pat, args);
1859 PERL_ARGS_ASSERT_VWARN;
1860 if (!invoke_exception_hook(ex, TRUE))
1861 write_to_stderr(ex);
1865 =for apidoc Am|void|warn|const char *pat|...
1867 This is an XS interface to Perl's C<warn> function.
1869 Take a sprintf-style format pattern and argument list. These are used to
1870 generate a string message. If the message does not end with a newline,
1871 then it will be extended with some indication of the current location
1872 in the code, as described for L</mess_sv>.
1874 The error message or object will by default be written to standard error,
1875 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1877 Unlike with L</croak>, C<pat> is not permitted to be null.
1882 #if defined(PERL_IMPLICIT_CONTEXT)
1884 Perl_warn_nocontext(const char *pat, ...)
1888 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1889 va_start(args, pat);
1893 #endif /* PERL_IMPLICIT_CONTEXT */
1896 Perl_warn(pTHX_ const char *pat, ...)
1899 PERL_ARGS_ASSERT_WARN;
1900 va_start(args, pat);
1905 #if defined(PERL_IMPLICIT_CONTEXT)
1907 Perl_warner_nocontext(U32 err, const char *pat, ...)
1911 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1912 va_start(args, pat);
1913 vwarner(err, pat, &args);
1916 #endif /* PERL_IMPLICIT_CONTEXT */
1919 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1921 PERL_ARGS_ASSERT_CK_WARNER_D;
1923 if (Perl_ckwarn_d(aTHX_ err)) {
1925 va_start(args, pat);
1926 vwarner(err, pat, &args);
1932 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1934 PERL_ARGS_ASSERT_CK_WARNER;
1936 if (Perl_ckwarn(aTHX_ err)) {
1938 va_start(args, pat);
1939 vwarner(err, pat, &args);
1945 Perl_warner(pTHX_ U32 err, const char* pat,...)
1948 PERL_ARGS_ASSERT_WARNER;
1949 va_start(args, pat);
1950 vwarner(err, pat, &args);
1955 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1958 PERL_ARGS_ASSERT_VWARNER;
1960 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
1961 !(PL_in_eval & EVAL_KEEPERR)
1963 SV * const msv = vmess(pat, args);
1965 if (PL_parser && PL_parser->error_count) {
1969 invoke_exception_hook(msv, FALSE);
1974 Perl_vwarn(aTHX_ pat, args);
1978 /* implements the ckWARN? macros */
1981 Perl_ckwarn(pTHX_ U32 w)
1983 /* If lexical warnings have not been set, use $^W. */
1985 return PL_dowarn & G_WARN_ON;
1987 return ckwarn_common(w);
1990 /* implements the ckWARN?_d macro */
1993 Perl_ckwarn_d(pTHX_ U32 w)
1995 /* If lexical warnings have not been set then default classes warn. */
1999 return ckwarn_common(w);
2003 S_ckwarn_common(pTHX_ U32 w)
2005 if (PL_curcop->cop_warnings == pWARN_ALL)
2008 if (PL_curcop->cop_warnings == pWARN_NONE)
2011 /* Check the assumption that at least the first slot is non-zero. */
2012 assert(unpackWARN1(w));
2014 /* Check the assumption that it is valid to stop as soon as a zero slot is
2016 if (!unpackWARN2(w)) {
2017 assert(!unpackWARN3(w));
2018 assert(!unpackWARN4(w));
2019 } else if (!unpackWARN3(w)) {
2020 assert(!unpackWARN4(w));
2023 /* Right, dealt with all the special cases, which are implemented as non-
2024 pointers, so there is a pointer to a real warnings mask. */
2026 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2028 } while (w >>= WARNshift);
2033 /* Set buffer=NULL to get a new one. */
2035 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2037 const MEM_SIZE len_wanted =
2038 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2039 PERL_UNUSED_CONTEXT;
2040 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2043 (specialWARN(buffer) ?
2044 PerlMemShared_malloc(len_wanted) :
2045 PerlMemShared_realloc(buffer, len_wanted));
2047 Copy(bits, (buffer + 1), size, char);
2048 if (size < WARNsize)
2049 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2053 /* since we've already done strlen() for both nam and val
2054 * we can use that info to make things faster than
2055 * sprintf(s, "%s=%s", nam, val)
2057 #define my_setenv_format(s, nam, nlen, val, vlen) \
2058 Copy(nam, s, nlen, char); \
2060 Copy(val, s+(nlen+1), vlen, char); \
2061 *(s+(nlen+1+vlen)) = '\0'
2065 #ifdef USE_ENVIRON_ARRAY
2066 /* NB: VMS' my_setenv() is in vms.c */
2068 /* Configure doesn't test for HAS_SETENV yet, so decide based on platform.
2069 * For Solaris, setenv() and unsetenv() were introduced in Solaris 9, so
2070 * testing for HAS UNSETENV is sufficient.
2072 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2073 # define MY_HAS_SETENV
2076 /* small wrapper for use by Perl_my_setenv that mallocs, or reallocs if
2077 * 'current' is non-null, with up to three sizes that are added together.
2078 * It handles integer overflow.
2080 # ifndef MY_HAS_SETENV
2082 S_env_alloc(void *current, Size_t l1, Size_t l2, Size_t l3, Size_t size)
2085 Size_t sl, l = l1 + l2;
2097 ? safesysrealloc(current, sl)
2098 : safesysmalloc(sl);
2103 croak_memory_wrap();
2108 # if !defined(WIN32) && !defined(NETWARE)
2111 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2114 # ifdef __amigaos4__
2115 amigaos4_obtain_environ(__FUNCTION__);
2118 # ifdef USE_ITHREADS
2119 /* only parent thread can modify process environment */
2120 if (PL_curinterp == aTHX)
2124 # ifndef PERL_USE_SAFE_PUTENV
2125 if (!PL_use_safe_putenv) {
2126 /* most putenv()s leak, so we manipulate environ directly */
2128 Size_t vlen, nlen = strlen(nam);
2130 /* where does it go? */
2131 for (i = 0; environ[i]; i++) {
2132 if (strnEQ(environ[i], nam, nlen) && environ[i][nlen] == '=')
2136 if (environ == PL_origenviron) { /* need we copy environment? */
2141 while (environ[max])
2144 /* XXX shouldn't that be max+1 rather than max+2 ??? - DAPM */
2145 tmpenv = (char**)S_env_alloc(NULL, max, 2, 0, sizeof(char*));
2147 for (j=0; j<max; j++) { /* copy environment */
2148 const Size_t len = strlen(environ[j]);
2149 tmpenv[j] = S_env_alloc(NULL, len, 1, 0, 1);
2150 Copy(environ[j], tmpenv[j], len+1, char);
2154 environ = tmpenv; /* tell exec where it is now */
2158 safesysfree(environ[i]);
2159 while (environ[i]) {
2160 environ[i] = environ[i+1];
2163 # ifdef __amigaos4__
2170 if (!environ[i]) { /* does not exist yet */
2171 environ = (char**)S_env_alloc(environ, i, 2, 0, sizeof(char*));
2172 environ[i+1] = NULL; /* make sure it's null terminated */
2175 safesysfree(environ[i]);
2179 environ[i] = S_env_alloc(NULL, nlen, vlen, 2, 1);
2180 /* all that work just for this */
2181 my_setenv_format(environ[i], nam, nlen, val, vlen);
2185 # endif /* !PERL_USE_SAFE_PUTENV */
2187 # ifdef MY_HAS_SETENV
2188 # if defined(HAS_UNSETENV)
2190 (void)unsetenv(nam);
2192 (void)setenv(nam, val, 1);
2194 # else /* ! HAS_UNSETENV */
2195 (void)setenv(nam, val, 1);
2196 # endif /* HAS_UNSETENV */
2198 # elif defined(HAS_UNSETENV)
2201 if (environ) /* old glibc can crash with null environ */
2202 (void)unsetenv(nam);
2204 const Size_t nlen = strlen(nam);
2205 const Size_t vlen = strlen(val);
2206 char * const new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2207 my_setenv_format(new_env, nam, nlen, val, vlen);
2208 (void)putenv(new_env);
2211 # else /* ! HAS_UNSETENV */
2214 const Size_t nlen = strlen(nam);
2220 new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2221 /* all that work just for this */
2222 my_setenv_format(new_env, nam, nlen, val, vlen);
2223 (void)putenv(new_env);
2225 # endif /* MY_HAS_SETENV */
2227 # ifndef PERL_USE_SAFE_PUTENV
2232 # ifdef __amigaos4__
2234 amigaos4_release_environ(__FUNCTION__);
2238 # else /* WIN32 || NETWARE */
2241 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2245 const Size_t nlen = strlen(nam);
2252 envstr = S_env_alloc(NULL, nlen, vlen, 2, 1);
2253 my_setenv_format(envstr, nam, nlen, val, vlen);
2254 (void)PerlEnv_putenv(envstr);
2258 # endif /* WIN32 || NETWARE */
2260 #endif /* USE_ENVIRON_ARRAY */
2265 #ifdef UNLINK_ALL_VERSIONS
2267 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2271 PERL_ARGS_ASSERT_UNLNK;
2273 while (PerlLIO_unlink(f) >= 0)
2275 return retries ? 0 : -1;
2280 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2282 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2290 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2292 PERL_FLUSHALL_FOR_CHILD;
2293 This = (*mode == 'w');
2297 taint_proper("Insecure %s%s", "EXEC");
2299 if (PerlProc_pipe_cloexec(p) < 0)
2301 /* Try for another pipe pair for error return */
2302 if (PerlProc_pipe_cloexec(pp) >= 0)
2304 while ((pid = PerlProc_fork()) < 0) {
2305 if (errno != EAGAIN) {
2306 PerlLIO_close(p[This]);
2307 PerlLIO_close(p[that]);
2309 PerlLIO_close(pp[0]);
2310 PerlLIO_close(pp[1]);
2314 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2323 /* Close parent's end of error status pipe (if any) */
2325 PerlLIO_close(pp[0]);
2326 /* Now dup our end of _the_ pipe to right position */
2327 if (p[THIS] != (*mode == 'r')) {
2328 PerlLIO_dup2(p[THIS], *mode == 'r');
2329 PerlLIO_close(p[THIS]);
2330 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2331 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2334 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2335 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2337 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2338 /* No automatic close - do it by hand */
2345 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2351 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2358 PerlLIO_close(pp[1]);
2359 /* Keep the lower of the two fd numbers */
2360 if (p[that] < p[This]) {
2361 PerlLIO_dup2_cloexec(p[This], p[that]);
2362 PerlLIO_close(p[This]);
2366 PerlLIO_close(p[that]); /* close child's end of pipe */
2368 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2369 SvUPGRADE(sv,SVt_IV);
2371 PL_forkprocess = pid;
2372 /* If we managed to get status pipe check for exec fail */
2373 if (did_pipes && pid > 0) {
2377 while (n < sizeof(int)) {
2378 const SSize_t n1 = PerlLIO_read(pp[0],
2379 (void*)(((char*)&errkid)+n),
2385 PerlLIO_close(pp[0]);
2387 if (n) { /* Error */
2389 PerlLIO_close(p[This]);
2390 if (n != sizeof(int))
2391 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2393 pid2 = wait4pid(pid, &status, 0);
2394 } while (pid2 == -1 && errno == EINTR);
2395 errno = errkid; /* Propagate errno from kid */
2400 PerlLIO_close(pp[0]);
2401 return PerlIO_fdopen(p[This], mode);
2403 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2404 return my_syspopen4(aTHX_ NULL, mode, n, args);
2405 # elif defined(WIN32)
2406 return win32_popenlist(mode, n, args);
2408 Perl_croak(aTHX_ "List form of piped open not implemented");
2409 return (PerlIO *) NULL;
2414 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2415 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2417 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2423 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2427 PERL_ARGS_ASSERT_MY_POPEN;
2429 PERL_FLUSHALL_FOR_CHILD;
2432 return my_syspopen(aTHX_ cmd,mode);
2435 This = (*mode == 'w');
2437 if (doexec && TAINTING_get) {
2439 taint_proper("Insecure %s%s", "EXEC");
2441 if (PerlProc_pipe_cloexec(p) < 0)
2443 if (doexec && PerlProc_pipe_cloexec(pp) >= 0)
2445 while ((pid = PerlProc_fork()) < 0) {
2446 if (errno != EAGAIN) {
2447 PerlLIO_close(p[This]);
2448 PerlLIO_close(p[that]);
2450 PerlLIO_close(pp[0]);
2451 PerlLIO_close(pp[1]);
2454 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2457 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2467 PerlLIO_close(pp[0]);
2468 if (p[THIS] != (*mode == 'r')) {
2469 PerlLIO_dup2(p[THIS], *mode == 'r');
2470 PerlLIO_close(p[THIS]);
2471 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2472 PerlLIO_close(p[THAT]);
2475 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2476 PerlLIO_close(p[THAT]);
2480 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2487 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2492 /* may or may not use the shell */
2493 do_exec3(cmd, pp[1], did_pipes);
2496 #endif /* defined OS2 */
2498 #ifdef PERLIO_USING_CRLF
2499 /* Since we circumvent IO layers when we manipulate low-level
2500 filedescriptors directly, need to manually switch to the
2501 default, binary, low-level mode; see PerlIOBuf_open(). */
2502 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2505 #ifdef PERL_USES_PL_PIDSTATUS
2506 hv_clear(PL_pidstatus); /* we have no children */
2513 PerlLIO_close(pp[1]);
2514 if (p[that] < p[This]) {
2515 PerlLIO_dup2_cloexec(p[This], p[that]);
2516 PerlLIO_close(p[This]);
2520 PerlLIO_close(p[that]);
2522 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2523 SvUPGRADE(sv,SVt_IV);
2525 PL_forkprocess = pid;
2526 if (did_pipes && pid > 0) {
2530 while (n < sizeof(int)) {
2531 const SSize_t n1 = PerlLIO_read(pp[0],
2532 (void*)(((char*)&errkid)+n),
2538 PerlLIO_close(pp[0]);
2540 if (n) { /* Error */
2542 PerlLIO_close(p[This]);
2543 if (n != sizeof(int))
2544 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2546 pid2 = wait4pid(pid, &status, 0);
2547 } while (pid2 == -1 && errno == EINTR);
2548 errno = errkid; /* Propagate errno from kid */
2553 PerlLIO_close(pp[0]);
2554 return PerlIO_fdopen(p[This], mode);
2556 #elif defined(DJGPP)
2557 FILE *djgpp_popen();
2559 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2561 PERL_FLUSHALL_FOR_CHILD;
2562 /* Call system's popen() to get a FILE *, then import it.
2563 used 0 for 2nd parameter to PerlIO_importFILE;
2566 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2568 #elif defined(__LIBCATAMOUNT__)
2570 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2575 #endif /* !DOSISH */
2577 /* this is called in parent before the fork() */
2579 Perl_atfork_lock(void)
2580 #if defined(USE_ITHREADS)
2582 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2585 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2587 PERL_TSA_ACQUIRE(PL_op_mutex)
2590 #if defined(USE_ITHREADS)
2592 /* locks must be held in locking order (if any) */
2594 MUTEX_LOCK(&PL_perlio_mutex);
2597 MUTEX_LOCK(&PL_malloc_mutex);
2603 /* this is called in both parent and child after the fork() */
2605 Perl_atfork_unlock(void)
2606 #if defined(USE_ITHREADS)
2608 PERL_TSA_RELEASE(PL_perlio_mutex)
2611 PERL_TSA_RELEASE(PL_malloc_mutex)
2613 PERL_TSA_RELEASE(PL_op_mutex)
2616 #if defined(USE_ITHREADS)
2618 /* locks must be released in same order as in atfork_lock() */
2620 MUTEX_UNLOCK(&PL_perlio_mutex);
2623 MUTEX_UNLOCK(&PL_malloc_mutex);
2632 #if defined(HAS_FORK)
2634 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2639 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2640 * handlers elsewhere in the code */
2644 #elif defined(__amigaos4__)
2645 return amigaos_fork();
2647 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2648 Perl_croak_nocontext("fork() not available");
2650 #endif /* HAS_FORK */
2655 dup2(int oldfd, int newfd)
2657 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2660 PerlLIO_close(newfd);
2661 return fcntl(oldfd, F_DUPFD, newfd);
2663 #define DUP2_MAX_FDS 256
2664 int fdtmp[DUP2_MAX_FDS];
2670 PerlLIO_close(newfd);
2671 /* good enough for low fd's... */
2672 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2673 if (fdx >= DUP2_MAX_FDS) {
2681 PerlLIO_close(fdtmp[--fdx]);
2688 #ifdef HAS_SIGACTION
2691 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2693 struct sigaction act, oact;
2697 /* only "parent" interpreter can diddle signals */
2698 if (PL_curinterp != aTHX)
2699 return (Sighandler_t) SIG_ERR;
2702 act.sa_handler = (void(*)(int))handler;
2703 sigemptyset(&act.sa_mask);
2706 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2707 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2709 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2710 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2711 act.sa_flags |= SA_NOCLDWAIT;
2713 if (sigaction(signo, &act, &oact) == -1)
2714 return (Sighandler_t) SIG_ERR;
2716 return (Sighandler_t) oact.sa_handler;
2720 Perl_rsignal_state(pTHX_ int signo)
2722 struct sigaction oact;
2723 PERL_UNUSED_CONTEXT;
2725 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2726 return (Sighandler_t) SIG_ERR;
2728 return (Sighandler_t) oact.sa_handler;
2732 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2737 struct sigaction act;
2739 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2742 /* only "parent" interpreter can diddle signals */
2743 if (PL_curinterp != aTHX)
2747 act.sa_handler = (void(*)(int))handler;
2748 sigemptyset(&act.sa_mask);
2751 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2752 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2754 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2755 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2756 act.sa_flags |= SA_NOCLDWAIT;
2758 return sigaction(signo, &act, save);
2762 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2767 PERL_UNUSED_CONTEXT;
2769 /* only "parent" interpreter can diddle signals */
2770 if (PL_curinterp != aTHX)
2774 return sigaction(signo, save, (struct sigaction *)NULL);
2777 #else /* !HAS_SIGACTION */
2780 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2782 #if defined(USE_ITHREADS) && !defined(WIN32)
2783 /* only "parent" interpreter can diddle signals */
2784 if (PL_curinterp != aTHX)
2785 return (Sighandler_t) SIG_ERR;
2788 return PerlProc_signal(signo, handler);
2799 Perl_rsignal_state(pTHX_ int signo)
2802 Sighandler_t oldsig;
2804 #if defined(USE_ITHREADS) && !defined(WIN32)
2805 /* only "parent" interpreter can diddle signals */
2806 if (PL_curinterp != aTHX)
2807 return (Sighandler_t) SIG_ERR;
2811 oldsig = PerlProc_signal(signo, sig_trap);
2812 PerlProc_signal(signo, oldsig);
2814 PerlProc_kill(PerlProc_getpid(), signo);
2819 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2821 #if defined(USE_ITHREADS) && !defined(WIN32)
2822 /* only "parent" interpreter can diddle signals */
2823 if (PL_curinterp != aTHX)
2826 *save = PerlProc_signal(signo, handler);
2827 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2831 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2833 #if defined(USE_ITHREADS) && !defined(WIN32)
2834 /* only "parent" interpreter can diddle signals */
2835 if (PL_curinterp != aTHX)
2838 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2841 #endif /* !HAS_SIGACTION */
2842 #endif /* !PERL_MICRO */
2844 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2845 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2847 Perl_my_pclose(pTHX_ PerlIO *ptr)
2855 const int fd = PerlIO_fileno(ptr);
2858 svp = av_fetch(PL_fdpid,fd,TRUE);
2859 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2863 #if defined(USE_PERLIO)
2864 /* Find out whether the refcount is low enough for us to wait for the
2865 child proc without blocking. */
2866 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
2868 should_wait = pid > 0;
2872 if (pid == -1) { /* Opened by popen. */
2873 return my_syspclose(ptr);
2876 close_failed = (PerlIO_close(ptr) == EOF);
2878 if (should_wait) do {
2879 pid2 = wait4pid(pid, &status, 0);
2880 } while (pid2 == -1 && errno == EINTR);
2887 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2891 #elif defined(__LIBCATAMOUNT__)
2893 Perl_my_pclose(pTHX_ PerlIO *ptr)
2897 #endif /* !DOSISH */
2899 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2901 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
2904 PERL_ARGS_ASSERT_WAIT4PID;
2905 #ifdef PERL_USES_PL_PIDSTATUS
2907 /* PERL_USES_PL_PIDSTATUS is only defined when neither
2908 waitpid() nor wait4() is available, or on OS/2, which
2909 doesn't appear to support waiting for a progress group
2910 member, so we can only treat a 0 pid as an unknown child.
2917 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
2918 pid, rather than a string form. */
2919 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
2920 if (svp && *svp != &PL_sv_undef) {
2921 *statusp = SvIVX(*svp);
2922 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
2930 hv_iterinit(PL_pidstatus);
2931 if ((entry = hv_iternext(PL_pidstatus))) {
2932 SV * const sv = hv_iterval(PL_pidstatus,entry);
2934 const char * const spid = hv_iterkey(entry,&len);
2936 assert (len == sizeof(Pid_t));
2937 memcpy((char *)&pid, spid, len);
2938 *statusp = SvIVX(sv);
2939 /* The hash iterator is currently on this entry, so simply
2940 calling hv_delete would trigger the lazy delete, which on
2941 aggregate does more work, because next call to hv_iterinit()
2942 would spot the flag, and have to call the delete routine,
2943 while in the meantime any new entries can't re-use that
2945 hv_iterinit(PL_pidstatus);
2946 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
2953 # ifdef HAS_WAITPID_RUNTIME
2954 if (!HAS_WAITPID_RUNTIME)
2957 result = PerlProc_waitpid(pid,statusp,flags);
2960 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
2961 result = wait4(pid,statusp,flags,NULL);
2964 #ifdef PERL_USES_PL_PIDSTATUS
2965 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
2970 Perl_croak(aTHX_ "Can't do waitpid with flags");
2972 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
2973 pidgone(result,*statusp);
2979 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
2982 if (result < 0 && errno == EINTR) {
2984 errno = EINTR; /* reset in case a signal handler changed $! */
2988 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
2990 #ifdef PERL_USES_PL_PIDSTATUS
2992 S_pidgone(pTHX_ Pid_t pid, int status)
2996 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
2997 SvUPGRADE(sv,SVt_IV);
2998 SvIV_set(sv, status);
3006 int /* Cannot prototype with I32
3008 my_syspclose(PerlIO *ptr)
3011 Perl_my_pclose(pTHX_ PerlIO *ptr)
3014 /* Needs work for PerlIO ! */
3015 FILE * const f = PerlIO_findFILE(ptr);
3016 const I32 result = pclose(f);
3017 PerlIO_releaseFILE(ptr,f);
3025 Perl_my_pclose(pTHX_ PerlIO *ptr)
3027 /* Needs work for PerlIO ! */
3028 FILE * const f = PerlIO_findFILE(ptr);
3029 I32 result = djgpp_pclose(f);
3030 result = (result << 8) & 0xff00;
3031 PerlIO_releaseFILE(ptr,f);
3036 #define PERL_REPEATCPY_LINEAR 4
3038 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3040 PERL_ARGS_ASSERT_REPEATCPY;
3045 croak_memory_wrap();
3048 memset(to, *from, count);
3051 IV items, linear, half;
3053 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3054 for (items = 0; items < linear; ++items) {
3055 const char *q = from;
3057 for (todo = len; todo > 0; todo--)
3062 while (items <= half) {
3063 IV size = items * len;
3064 memcpy(p, to, size);
3070 memcpy(p, to, (count - items) * len);
3076 Perl_same_dirent(pTHX_ const char *a, const char *b)
3078 char *fa = strrchr(a,'/');
3079 char *fb = strrchr(b,'/');
3082 SV * const tmpsv = sv_newmortal();
3084 PERL_ARGS_ASSERT_SAME_DIRENT;
3097 sv_setpvs(tmpsv, ".");
3099 sv_setpvn(tmpsv, a, fa - a);
3100 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3103 sv_setpvs(tmpsv, ".");
3105 sv_setpvn(tmpsv, b, fb - b);
3106 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3108 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3109 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3111 #endif /* !HAS_RENAME */
3114 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3115 const char *const *const search_ext, I32 flags)
3117 const char *xfound = NULL;
3118 char *xfailed = NULL;
3119 char tmpbuf[MAXPATHLEN];
3124 #if defined(DOSISH) && !defined(OS2)
3125 # define SEARCH_EXTS ".bat", ".cmd", NULL
3126 # define MAX_EXT_LEN 4
3129 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3130 # define MAX_EXT_LEN 4
3133 # define SEARCH_EXTS ".pl", ".com", NULL
3134 # define MAX_EXT_LEN 4
3136 /* additional extensions to try in each dir if scriptname not found */
3138 static const char *const exts[] = { SEARCH_EXTS };
3139 const char *const *const ext = search_ext ? search_ext : exts;
3140 int extidx = 0, i = 0;
3141 const char *curext = NULL;
3143 PERL_UNUSED_ARG(search_ext);
3144 # define MAX_EXT_LEN 0
3147 PERL_ARGS_ASSERT_FIND_SCRIPT;
3150 * If dosearch is true and if scriptname does not contain path
3151 * delimiters, search the PATH for scriptname.
3153 * If SEARCH_EXTS is also defined, will look for each
3154 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3155 * while searching the PATH.
3157 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3158 * proceeds as follows:
3159 * If DOSISH or VMSISH:
3160 * + look for ./scriptname{,.foo,.bar}
3161 * + search the PATH for scriptname{,.foo,.bar}
3164 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3165 * this will not look in '.' if it's not in the PATH)
3170 # ifdef ALWAYS_DEFTYPES
3171 len = strlen(scriptname);
3172 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3173 int idx = 0, deftypes = 1;
3176 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3179 int idx = 0, deftypes = 1;
3182 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3184 /* The first time through, just add SEARCH_EXTS to whatever we
3185 * already have, so we can check for default file types. */
3187 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3194 if ((strlen(tmpbuf) + strlen(scriptname)
3195 + MAX_EXT_LEN) >= sizeof tmpbuf)
3196 continue; /* don't search dir with too-long name */
3197 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3201 if (strEQ(scriptname, "-"))
3203 if (dosearch) { /* Look in '.' first. */
3204 const char *cur = scriptname;
3206 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3208 if (strEQ(ext[i++],curext)) {
3209 extidx = -1; /* already has an ext */
3214 DEBUG_p(PerlIO_printf(Perl_debug_log,
3215 "Looking for %s\n",cur));
3218 if (PerlLIO_stat(cur,&statbuf) >= 0
3219 && !S_ISDIR(statbuf.st_mode)) {
3228 if (cur == scriptname) {
3229 len = strlen(scriptname);
3230 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3232 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3235 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3236 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3241 if (dosearch && !strchr(scriptname, '/')
3243 && !strchr(scriptname, '\\')
3245 && (s = PerlEnv_getenv("PATH")))
3249 bufend = s + strlen(s);
3250 while (s < bufend) {
3254 && *s != ';'; len++, s++) {
3255 if (len < sizeof tmpbuf)
3258 if (len < sizeof tmpbuf)
3261 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3266 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3267 continue; /* don't search dir with too-long name */
3270 && tmpbuf[len - 1] != '/'
3271 && tmpbuf[len - 1] != '\\'
3274 tmpbuf[len++] = '/';
3275 if (len == 2 && tmpbuf[0] == '.')
3277 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3281 len = strlen(tmpbuf);
3282 if (extidx > 0) /* reset after previous loop */
3286 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3287 retval = PerlLIO_stat(tmpbuf,&statbuf);
3288 if (S_ISDIR(statbuf.st_mode)) {
3292 } while ( retval < 0 /* not there */
3293 && extidx>=0 && ext[extidx] /* try an extension? */
3294 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3299 if (S_ISREG(statbuf.st_mode)
3300 && cando(S_IRUSR,TRUE,&statbuf)
3301 #if !defined(DOSISH)
3302 && cando(S_IXUSR,TRUE,&statbuf)
3306 xfound = tmpbuf; /* bingo! */
3310 xfailed = savepv(tmpbuf);
3315 if (!xfound && !seen_dot && !xfailed &&
3316 (PerlLIO_stat(scriptname,&statbuf) < 0
3317 || S_ISDIR(statbuf.st_mode)))
3319 seen_dot = 1; /* Disable message. */
3324 if (flags & 1) { /* do or die? */
3325 /* diag_listed_as: Can't execute %s */
3326 Perl_croak(aTHX_ "Can't %s %s%s%s",
3327 (xfailed ? "execute" : "find"),
3328 (xfailed ? xfailed : scriptname),
3329 (xfailed ? "" : " on PATH"),
3330 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3335 scriptname = xfound;
3337 return (scriptname ? savepv(scriptname) : NULL);
3340 #ifndef PERL_GET_CONTEXT_DEFINED
3343 Perl_get_context(void)
3345 #if defined(USE_ITHREADS)
3347 # ifdef OLD_PTHREADS_API
3349 int error = pthread_getspecific(PL_thr_key, &t)
3351 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3353 # elif defined(I_MACH_CTHREADS)
3354 return (void*)cthread_data(cthread_self());
3356 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3364 Perl_set_context(void *t)
3366 #if defined(USE_ITHREADS)
3369 PERL_ARGS_ASSERT_SET_CONTEXT;
3370 #if defined(USE_ITHREADS)
3371 # ifdef I_MACH_CTHREADS
3372 cthread_set_data(cthread_self(), t);
3375 const int error = pthread_setspecific(PL_thr_key, t);
3377 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3385 #endif /* !PERL_GET_CONTEXT_DEFINED */
3387 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3391 PERL_UNUSED_CONTEXT;
3397 Perl_get_op_names(pTHX)
3399 PERL_UNUSED_CONTEXT;
3400 return (char **)PL_op_name;
3404 Perl_get_op_descs(pTHX)
3406 PERL_UNUSED_CONTEXT;
3407 return (char **)PL_op_desc;
3411 Perl_get_no_modify(pTHX)
3413 PERL_UNUSED_CONTEXT;
3414 return PL_no_modify;
3418 Perl_get_opargs(pTHX)
3420 PERL_UNUSED_CONTEXT;
3421 return (U32 *)PL_opargs;
3425 Perl_get_ppaddr(pTHX)
3428 PERL_UNUSED_CONTEXT;
3429 return (PPADDR_t*)PL_ppaddr;
3432 #ifndef HAS_GETENV_LEN
3434 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3436 char * const env_trans = PerlEnv_getenv(env_elem);
3437 PERL_UNUSED_CONTEXT;
3438 PERL_ARGS_ASSERT_GETENV_LEN;
3440 *len = strlen(env_trans);
3447 Perl_get_vtbl(pTHX_ int vtbl_id)
3449 PERL_UNUSED_CONTEXT;
3451 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3452 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3456 Perl_my_fflush_all(pTHX)
3458 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3459 return PerlIO_flush(NULL);
3461 # if defined(HAS__FWALK)
3462 extern int fflush(FILE *);
3463 /* undocumented, unprototyped, but very useful BSDism */
3464 extern void _fwalk(int (*)(FILE *));
3468 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3470 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3471 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3472 # elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3473 open_max = sysconf(_SC_OPEN_MAX);
3474 # elif defined(FOPEN_MAX)
3475 open_max = FOPEN_MAX;
3476 # elif defined(OPEN_MAX)
3477 open_max = OPEN_MAX;
3478 # elif defined(_NFILE)
3483 for (i = 0; i < open_max; i++)
3484 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3485 STDIO_STREAM_ARRAY[i]._file < open_max &&
3486 STDIO_STREAM_ARRAY[i]._flag)
3487 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3491 SETERRNO(EBADF,RMS_IFI);
3498 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3500 if (ckWARN(WARN_IO)) {
3502 = gv && (isGV_with_GP(gv))
3505 const char * const direction = have == '>' ? "out" : "in";
3507 if (name && HEK_LEN(name))
3508 Perl_warner(aTHX_ packWARN(WARN_IO),
3509 "Filehandle %" HEKf " opened only for %sput",
3510 HEKfARG(name), direction);
3512 Perl_warner(aTHX_ packWARN(WARN_IO),
3513 "Filehandle opened only for %sput", direction);
3518 Perl_report_evil_fh(pTHX_ const GV *gv)
3520 const IO *io = gv ? GvIO(gv) : NULL;
3521 const PERL_BITFIELD16 op = PL_op->op_type;
3525 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3527 warn_type = WARN_CLOSED;
3531 warn_type = WARN_UNOPENED;
3534 if (ckWARN(warn_type)) {
3536 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3537 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3538 const char * const pars =
3539 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3540 const char * const func =
3542 (op == OP_READLINE || op == OP_RCATLINE
3543 ? "readline" : /* "<HANDLE>" not nice */
3544 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3546 const char * const type =
3548 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3549 ? "socket" : "filehandle");
3550 const bool have_name = name && SvCUR(name);
3551 Perl_warner(aTHX_ packWARN(warn_type),
3552 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3553 have_name ? " " : "",
3554 SVfARG(have_name ? name : &PL_sv_no));
3555 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3557 aTHX_ packWARN(warn_type),
3558 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3559 func, pars, have_name ? " " : "",
3560 SVfARG(have_name ? name : &PL_sv_no)
3565 /* To workaround core dumps from the uninitialised tm_zone we get the
3566 * system to give us a reasonable struct to copy. This fix means that
3567 * strftime uses the tm_zone and tm_gmtoff values returned by
3568 * localtime(time()). That should give the desired result most of the
3569 * time. But probably not always!
3571 * This does not address tzname aspects of NETaa14816.
3576 # ifndef STRUCT_TM_HASZONE
3577 # define STRUCT_TM_HASZONE
3581 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3582 # ifndef HAS_TM_TM_ZONE
3583 # define HAS_TM_TM_ZONE
3588 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3590 #ifdef HAS_TM_TM_ZONE
3592 const struct tm* my_tm;
3593 PERL_UNUSED_CONTEXT;
3594 PERL_ARGS_ASSERT_INIT_TM;
3596 my_tm = localtime(&now);
3598 Copy(my_tm, ptm, 1, struct tm);
3600 PERL_UNUSED_CONTEXT;
3601 PERL_ARGS_ASSERT_INIT_TM;
3602 PERL_UNUSED_ARG(ptm);
3607 * mini_mktime - normalise struct tm values without the localtime()
3608 * semantics (and overhead) of mktime().
3611 Perl_mini_mktime(struct tm *ptm)
3615 int month, mday, year, jday;
3616 int odd_cent, odd_year;
3618 PERL_ARGS_ASSERT_MINI_MKTIME;
3620 #define DAYS_PER_YEAR 365
3621 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3622 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3623 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3624 #define SECS_PER_HOUR (60*60)
3625 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3626 /* parentheses deliberately absent on these two, otherwise they don't work */
3627 #define MONTH_TO_DAYS 153/5
3628 #define DAYS_TO_MONTH 5/153
3629 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3630 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3631 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3632 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3635 * Year/day algorithm notes:
3637 * With a suitable offset for numeric value of the month, one can find
3638 * an offset into the year by considering months to have 30.6 (153/5) days,
3639 * using integer arithmetic (i.e., with truncation). To avoid too much
3640 * messing about with leap days, we consider January and February to be
3641 * the 13th and 14th month of the previous year. After that transformation,
3642 * we need the month index we use to be high by 1 from 'normal human' usage,
3643 * so the month index values we use run from 4 through 15.
3645 * Given that, and the rules for the Gregorian calendar (leap years are those
3646 * divisible by 4 unless also divisible by 100, when they must be divisible
3647 * by 400 instead), we can simply calculate the number of days since some
3648 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3649 * the days we derive from our month index, and adding in the day of the
3650 * month. The value used here is not adjusted for the actual origin which
3651 * it normally would use (1 January A.D. 1), since we're not exposing it.
3652 * We're only building the value so we can turn around and get the
3653 * normalised values for the year, month, day-of-month, and day-of-year.
3655 * For going backward, we need to bias the value we're using so that we find
3656 * the right year value. (Basically, we don't want the contribution of
3657 * March 1st to the number to apply while deriving the year). Having done
3658 * that, we 'count up' the contribution to the year number by accounting for
3659 * full quadracenturies (400-year periods) with their extra leap days, plus
3660 * the contribution from full centuries (to avoid counting in the lost leap
3661 * days), plus the contribution from full quad-years (to count in the normal
3662 * leap days), plus the leftover contribution from any non-leap years.
3663 * At this point, if we were working with an actual leap day, we'll have 0
3664 * days left over. This is also true for March 1st, however. So, we have
3665 * to special-case that result, and (earlier) keep track of the 'odd'
3666 * century and year contributions. If we got 4 extra centuries in a qcent,
3667 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3668 * Otherwise, we add back in the earlier bias we removed (the 123 from
3669 * figuring in March 1st), find the month index (integer division by 30.6),
3670 * and the remainder is the day-of-month. We then have to convert back to
3671 * 'real' months (including fixing January and February from being 14/15 in
3672 * the previous year to being in the proper year). After that, to get
3673 * tm_yday, we work with the normalised year and get a new yearday value for
3674 * January 1st, which we subtract from the yearday value we had earlier,
3675 * representing the date we've re-built. This is done from January 1
3676 * because tm_yday is 0-origin.
3678 * Since POSIX time routines are only guaranteed to work for times since the
3679 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3680 * applies Gregorian calendar rules even to dates before the 16th century
3681 * doesn't bother me. Besides, you'd need cultural context for a given
3682 * date to know whether it was Julian or Gregorian calendar, and that's
3683 * outside the scope for this routine. Since we convert back based on the
3684 * same rules we used to build the yearday, you'll only get strange results
3685 * for input which needed normalising, or for the 'odd' century years which
3686 * were leap years in the Julian calendar but not in the Gregorian one.
3687 * I can live with that.
3689 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3690 * that's still outside the scope for POSIX time manipulation, so I don't
3696 year = 1900 + ptm->tm_year;
3697 month = ptm->tm_mon;
3698 mday = ptm->tm_mday;
3704 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3705 yearday += month*MONTH_TO_DAYS + mday + jday;
3707 * Note that we don't know when leap-seconds were or will be,
3708 * so we have to trust the user if we get something which looks
3709 * like a sensible leap-second. Wild values for seconds will
3710 * be rationalised, however.
3712 if ((unsigned) ptm->tm_sec <= 60) {
3719 secs += 60 * ptm->tm_min;
3720 secs += SECS_PER_HOUR * ptm->tm_hour;
3722 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3723 /* got negative remainder, but need positive time */
3724 /* back off an extra day to compensate */
3725 yearday += (secs/SECS_PER_DAY)-1;
3726 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3729 yearday += (secs/SECS_PER_DAY);
3730 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3733 else if (secs >= SECS_PER_DAY) {
3734 yearday += (secs/SECS_PER_DAY);
3735 secs %= SECS_PER_DAY;
3737 ptm->tm_hour = secs/SECS_PER_HOUR;
3738 secs %= SECS_PER_HOUR;
3739 ptm->tm_min = secs/60;
3741 ptm->tm_sec += secs;
3742 /* done with time of day effects */
3744 * The algorithm for yearday has (so far) left it high by 428.
3745 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3746 * bias it by 123 while trying to figure out what year it
3747 * really represents. Even with this tweak, the reverse
3748 * translation fails for years before A.D. 0001.
3749 * It would still fail for Feb 29, but we catch that one below.
3751 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3752 yearday -= YEAR_ADJUST;
3753 year = (yearday / DAYS_PER_QCENT) * 400;
3754 yearday %= DAYS_PER_QCENT;
3755 odd_cent = yearday / DAYS_PER_CENT;
3756 year += odd_cent * 100;
3757 yearday %= DAYS_PER_CENT;
3758 year += (yearday / DAYS_PER_QYEAR) * 4;
3759 yearday %= DAYS_PER_QYEAR;
3760 odd_year = yearday / DAYS_PER_YEAR;
3762 yearday %= DAYS_PER_YEAR;
3763 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3768 yearday += YEAR_ADJUST; /* recover March 1st crock */
3769 month = yearday*DAYS_TO_MONTH;
3770 yearday -= month*MONTH_TO_DAYS;
3771 /* recover other leap-year adjustment */
3780 ptm->tm_year = year - 1900;
3782 ptm->tm_mday = yearday;
3783 ptm->tm_mon = month;
3787 ptm->tm_mon = month - 1;
3789 /* re-build yearday based on Jan 1 to get tm_yday */
3791 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3792 yearday += 14*MONTH_TO_DAYS + 1;
3793 ptm->tm_yday = jday - yearday;
3794 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3798 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)
3802 /* strftime(), but with a different API so that the return value is a pointer
3803 * to the formatted result (which MUST be arranged to be FREED BY THE
3804 * CALLER). This allows this function to increase the buffer size as needed,
3805 * so that the caller doesn't have to worry about that.
3807 * Note that yday and wday effectively are ignored by this function, as
3808 * mini_mktime() overwrites them */
3815 PERL_ARGS_ASSERT_MY_STRFTIME;
3817 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3820 mytm.tm_hour = hour;
3821 mytm.tm_mday = mday;
3823 mytm.tm_year = year;
3824 mytm.tm_wday = wday;
3825 mytm.tm_yday = yday;
3826 mytm.tm_isdst = isdst;
3828 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3829 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3834 #ifdef HAS_TM_TM_GMTOFF
3835 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3837 #ifdef HAS_TM_TM_ZONE
3838 mytm.tm_zone = mytm2.tm_zone;
3843 Newx(buf, buflen, char);
3845 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3846 len = strftime(buf, buflen, fmt, &mytm);
3847 GCC_DIAG_RESTORE_STMT;
3850 ** The following is needed to handle to the situation where
3851 ** tmpbuf overflows. Basically we want to allocate a buffer
3852 ** and try repeatedly. The reason why it is so complicated
3853 ** is that getting a return value of 0 from strftime can indicate
3854 ** one of the following:
3855 ** 1. buffer overflowed,
3856 ** 2. illegal conversion specifier, or
3857 ** 3. the format string specifies nothing to be returned(not
3858 ** an error). This could be because format is an empty string
3859 ** or it specifies %p that yields an empty string in some locale.
3860 ** If there is a better way to make it portable, go ahead by
3863 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
3866 /* Possibly buf overflowed - try again with a bigger buf */
3867 const int fmtlen = strlen(fmt);
3868 int bufsize = fmtlen + buflen;
3870 Renew(buf, bufsize, char);
3873 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3874 buflen = strftime(buf, bufsize, fmt, &mytm);
3875 GCC_DIAG_RESTORE_STMT;
3877 if (buflen > 0 && buflen < bufsize)
3879 /* heuristic to prevent out-of-memory errors */
3880 if (bufsize > 100*fmtlen) {
3886 Renew(buf, bufsize, char);
3891 Perl_croak(aTHX_ "panic: no strftime");
3897 #define SV_CWD_RETURN_UNDEF \
3901 #define SV_CWD_ISDOT(dp) \
3902 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
3903 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
3906 =head1 Miscellaneous Functions
3908 =for apidoc getcwd_sv
3910 Fill C<sv> with current working directory
3915 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
3916 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
3917 * getcwd(3) if available
3918 * Comments from the original:
3919 * This is a faster version of getcwd. It's also more dangerous
3920 * because you might chdir out of a directory that you can't chdir
3924 Perl_getcwd_sv(pTHX_ SV *sv)
3929 PERL_ARGS_ASSERT_GETCWD_SV;
3933 char buf[MAXPATHLEN];
3935 /* Some getcwd()s automatically allocate a buffer of the given
3936 * size from the heap if they are given a NULL buffer pointer.
3937 * The problem is that this behaviour is not portable. */
3938 if (getcwd(buf, sizeof(buf) - 1)) {
3943 SV_CWD_RETURN_UNDEF;
3950 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
3954 SvUPGRADE(sv, SVt_PV);
3956 if (PerlLIO_lstat(".", &statbuf) < 0) {
3957 SV_CWD_RETURN_UNDEF;
3960 orig_cdev = statbuf.st_dev;
3961 orig_cino = statbuf.st_ino;
3971 if (PerlDir_chdir("..") < 0) {
3972 SV_CWD_RETURN_UNDEF;
3974 if (PerlLIO_stat(".", &statbuf) < 0) {
3975 SV_CWD_RETURN_UNDEF;
3978 cdev = statbuf.st_dev;
3979 cino = statbuf.st_ino;
3981 if (odev == cdev && oino == cino) {
3984 if (!(dir = PerlDir_open("."))) {
3985 SV_CWD_RETURN_UNDEF;
3988 while ((dp = PerlDir_read(dir)) != NULL) {
3990 namelen = dp->d_namlen;
3992 namelen = strlen(dp->d_name);
3995 if (SV_CWD_ISDOT(dp)) {
3999 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4000 SV_CWD_RETURN_UNDEF;
4003 tdev = statbuf.st_dev;
4004 tino = statbuf.st_ino;
4005 if (tino == oino && tdev == odev) {
4011 SV_CWD_RETURN_UNDEF;
4014 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4015 SV_CWD_RETURN_UNDEF;
4018 SvGROW(sv, pathlen + namelen + 1);
4022 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4025 /* prepend current directory to the front */
4027 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4028 pathlen += (namelen + 1);
4030 #ifdef VOID_CLOSEDIR
4033 if (PerlDir_close(dir) < 0) {
4034 SV_CWD_RETURN_UNDEF;
4040 SvCUR_set(sv, pathlen);
4044 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4045 SV_CWD_RETURN_UNDEF;
4048 if (PerlLIO_stat(".", &statbuf) < 0) {
4049 SV_CWD_RETURN_UNDEF;
4052 cdev = statbuf.st_dev;
4053 cino = statbuf.st_ino;
4055 if (cdev != orig_cdev || cino != orig_cino) {
4056 Perl_croak(aTHX_ "Unstable directory path, "
4057 "current directory changed unexpectedly");
4070 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4071 # define EMULATE_SOCKETPAIR_UDP
4074 #ifdef EMULATE_SOCKETPAIR_UDP
4076 S_socketpair_udp (int fd[2]) {
4078 /* Fake a datagram socketpair using UDP to localhost. */
4079 int sockets[2] = {-1, -1};
4080 struct sockaddr_in addresses[2];
4082 Sock_size_t size = sizeof(struct sockaddr_in);
4083 unsigned short port;
4086 memset(&addresses, 0, sizeof(addresses));
4089 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4090 if (sockets[i] == -1)
4091 goto tidy_up_and_fail;
4093 addresses[i].sin_family = AF_INET;
4094 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4095 addresses[i].sin_port = 0; /* kernel choses port. */
4096 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4097 sizeof(struct sockaddr_in)) == -1)
4098 goto tidy_up_and_fail;
4101 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4102 for each connect the other socket to it. */
4105 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4107 goto tidy_up_and_fail;
4108 if (size != sizeof(struct sockaddr_in))
4109 goto abort_tidy_up_and_fail;
4110 /* !1 is 0, !0 is 1 */
4111 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4112 sizeof(struct sockaddr_in)) == -1)
4113 goto tidy_up_and_fail;
4116 /* Now we have 2 sockets connected to each other. I don't trust some other
4117 process not to have already sent a packet to us (by random) so send
4118 a packet from each to the other. */
4121 /* I'm going to send my own port number. As a short.
4122 (Who knows if someone somewhere has sin_port as a bitfield and needs
4123 this routine. (I'm assuming crays have socketpair)) */
4124 port = addresses[i].sin_port;
4125 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4126 if (got != sizeof(port)) {
4128 goto tidy_up_and_fail;
4129 goto abort_tidy_up_and_fail;
4133 /* Packets sent. I don't trust them to have arrived though.
4134 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4135 connect to localhost will use a second kernel thread. In 2.6 the
4136 first thread running the connect() returns before the second completes,
4137 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4138 returns 0. Poor programs have tripped up. One poor program's authors'
4139 had a 50-1 reverse stock split. Not sure how connected these were.)
4140 So I don't trust someone not to have an unpredictable UDP stack.
4144 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4145 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4149 FD_SET((unsigned int)sockets[0], &rset);
4150 FD_SET((unsigned int)sockets[1], &rset);
4152 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4153 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4154 || !FD_ISSET(sockets[1], &rset)) {
4155 /* I hope this is portable and appropriate. */
4157 goto tidy_up_and_fail;
4158 goto abort_tidy_up_and_fail;
4162 /* And the paranoia department even now doesn't trust it to have arrive
4163 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4165 struct sockaddr_in readfrom;
4166 unsigned short buffer[2];
4171 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4172 sizeof(buffer), MSG_DONTWAIT,
4173 (struct sockaddr *) &readfrom, &size);
4175 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4177 (struct sockaddr *) &readfrom, &size);
4181 goto tidy_up_and_fail;
4182 if (got != sizeof(port)
4183 || size != sizeof(struct sockaddr_in)
4184 /* Check other socket sent us its port. */
4185 || buffer[0] != (unsigned short) addresses[!i].sin_port
4186 /* Check kernel says we got the datagram from that socket */
4187 || readfrom.sin_family != addresses[!i].sin_family
4188 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4189 || readfrom.sin_port != addresses[!i].sin_port)
4190 goto abort_tidy_up_and_fail;
4193 /* My caller (my_socketpair) has validated that this is non-NULL */
4196 /* I hereby declare this connection open. May God bless all who cross
4200 abort_tidy_up_and_fail:
4201 errno = ECONNABORTED;
4205 if (sockets[0] != -1)
4206 PerlLIO_close(sockets[0]);
4207 if (sockets[1] != -1)
4208 PerlLIO_close(sockets[1]);
4213 #endif /* EMULATE_SOCKETPAIR_UDP */
4215 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4217 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4218 /* Stevens says that family must be AF_LOCAL, protocol 0.
4219 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4224 struct sockaddr_in listen_addr;
4225 struct sockaddr_in connect_addr;
4230 || family != AF_UNIX
4233 errno = EAFNOSUPPORT;
4242 type &= ~SOCK_CLOEXEC;
4245 #ifdef EMULATE_SOCKETPAIR_UDP
4246 if (type == SOCK_DGRAM)
4247 return S_socketpair_udp(fd);
4250 aTHXa(PERL_GET_THX);
4251 listener = PerlSock_socket(AF_INET, type, 0);
4254 memset(&listen_addr, 0, sizeof(listen_addr));
4255 listen_addr.sin_family = AF_INET;
4256 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4257 listen_addr.sin_port = 0; /* kernel choses port. */
4258 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4259 sizeof(listen_addr)) == -1)
4260 goto tidy_up_and_fail;
4261 if (PerlSock_listen(listener, 1) == -1)
4262 goto tidy_up_and_fail;
4264 connector = PerlSock_socket(AF_INET, type, 0);
4265 if (connector == -1)
4266 goto tidy_up_and_fail;
4267 /* We want to find out the port number to connect to. */
4268 size = sizeof(connect_addr);
4269 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4271 goto tidy_up_and_fail;
4272 if (size != sizeof(connect_addr))
4273 goto abort_tidy_up_and_fail;
4274 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4275 sizeof(connect_addr)) == -1)
4276 goto tidy_up_and_fail;
4278 size = sizeof(listen_addr);
4279 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4282 goto tidy_up_and_fail;
4283 if (size != sizeof(listen_addr))
4284 goto abort_tidy_up_and_fail;
4285 PerlLIO_close(listener);
4286 /* Now check we are talking to ourself by matching port and host on the
4288 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4290 goto tidy_up_and_fail;
4291 if (size != sizeof(connect_addr)
4292 || listen_addr.sin_family != connect_addr.sin_family
4293 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4294 || listen_addr.sin_port != connect_addr.sin_port) {
4295 goto abort_tidy_up_and_fail;
4301 abort_tidy_up_and_fail:
4303 errno = ECONNABORTED; /* This would be the standard thing to do. */
4304 #elif defined(ECONNREFUSED)
4305 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4307 errno = ETIMEDOUT; /* Desperation time. */
4313 PerlLIO_close(listener);
4314 if (connector != -1)
4315 PerlLIO_close(connector);
4317 PerlLIO_close(acceptor);
4323 /* In any case have a stub so that there's code corresponding
4324 * to the my_socketpair in embed.fnc. */
4326 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4327 #ifdef HAS_SOCKETPAIR
4328 return socketpair(family, type, protocol, fd);
4337 =for apidoc sv_nosharing
4339 Dummy routine which "shares" an SV when there is no sharing module present.
4340 Or "locks" it. Or "unlocks" it. In other
4341 words, ignores its single SV argument.
4342 Exists to avoid test for a C<NULL> function pointer and because it could
4343 potentially warn under some level of strict-ness.
4349 Perl_sv_nosharing(pTHX_ SV *sv)
4351 PERL_UNUSED_CONTEXT;
4352 PERL_UNUSED_ARG(sv);
4357 =for apidoc sv_destroyable
4359 Dummy routine which reports that object can be destroyed when there is no
4360 sharing module present. It ignores its single SV argument, and returns
4361 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4362 could potentially warn under some level of strict-ness.
4368 Perl_sv_destroyable(pTHX_ SV *sv)
4370 PERL_UNUSED_CONTEXT;
4371 PERL_UNUSED_ARG(sv);
4376 Perl_parse_unicode_opts(pTHX_ const char **popt)
4378 const char *p = *popt;
4381 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4385 const char* endptr = p + strlen(p);
4387 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4390 if (p && *p && *p != '\n' && *p != '\r') {
4392 goto the_end_of_the_opts_parser;
4394 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4398 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4404 case PERL_UNICODE_STDIN:
4405 opt |= PERL_UNICODE_STDIN_FLAG; break;
4406 case PERL_UNICODE_STDOUT:
4407 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4408 case PERL_UNICODE_STDERR:
4409 opt |= PERL_UNICODE_STDERR_FLAG; break;
4410 case PERL_UNICODE_STD:
4411 opt |= PERL_UNICODE_STD_FLAG; break;
4412 case PERL_UNICODE_IN:
4413 opt |= PERL_UNICODE_IN_FLAG; break;
4414 case PERL_UNICODE_OUT:
4415 opt |= PERL_UNICODE_OUT_FLAG; break;
4416 case PERL_UNICODE_INOUT:
4417 opt |= PERL_UNICODE_INOUT_FLAG; break;
4418 case PERL_UNICODE_LOCALE:
4419 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4420 case PERL_UNICODE_ARGV:
4421 opt |= PERL_UNICODE_ARGV_FLAG; break;
4422 case PERL_UNICODE_UTF8CACHEASSERT:
4423 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4425 if (*p != '\n' && *p != '\r') {
4426 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4429 "Unknown Unicode option letter '%c'", *p);
4436 opt = PERL_UNICODE_DEFAULT_FLAGS;
4438 the_end_of_the_opts_parser:
4440 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4441 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4442 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4450 # include <starlet.h>
4457 * This is really just a quick hack which grabs various garbage
4458 * values. It really should be a real hash algorithm which
4459 * spreads the effect of every input bit onto every output bit,
4460 * if someone who knows about such things would bother to write it.
4461 * Might be a good idea to add that function to CORE as well.
4462 * No numbers below come from careful analysis or anything here,
4463 * except they are primes and SEED_C1 > 1E6 to get a full-width
4464 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4465 * probably be bigger too.
4468 # define SEED_C1 1000003
4469 #define SEED_C4 73819
4471 # define SEED_C1 25747
4472 #define SEED_C4 20639
4476 #define SEED_C5 26107
4478 #ifndef PERL_NO_DEV_RANDOM
4482 #ifdef HAS_GETTIMEOFDAY
4483 struct timeval when;
4488 /* This test is an escape hatch, this symbol isn't set by Configure. */
4489 #ifndef PERL_NO_DEV_RANDOM
4490 #ifndef PERL_RANDOM_DEVICE
4491 /* /dev/random isn't used by default because reads from it will block
4492 * if there isn't enough entropy available. You can compile with
4493 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4494 * is enough real entropy to fill the seed. */
4495 # ifdef __amigaos4__
4496 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4498 # define PERL_RANDOM_DEVICE "/dev/urandom"
4501 fd = PerlLIO_open_cloexec(PERL_RANDOM_DEVICE, 0);
4503 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4511 #ifdef HAS_GETTIMEOFDAY
4512 PerlProc_gettimeofday(&when,NULL);
4513 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4516 u = (U32)SEED_C1 * when;
4518 u += SEED_C3 * (U32)PerlProc_getpid();
4519 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4520 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4521 u += SEED_C5 * (U32)PTR2UV(&when);
4527 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4529 #ifndef NO_PERL_HASH_ENV
4534 PERL_ARGS_ASSERT_GET_HASH_SEED;
4536 #ifndef NO_PERL_HASH_ENV
4537 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4541 /* ignore leading spaces */
4542 while (isSPACE(*env_pv))
4544 # ifdef USE_PERL_PERTURB_KEYS
4545 /* if they set it to "0" we disable key traversal randomization completely */
4546 if (strEQ(env_pv,"0")) {
4547 PL_hash_rand_bits_enabled= 0;
4549 /* otherwise switch to deterministic mode */
4550 PL_hash_rand_bits_enabled= 2;
4553 /* ignore a leading 0x... if it is there */
4554 if (env_pv[0] == '0' && env_pv[1] == 'x')
4557 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4558 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4559 if ( isXDIGIT(*env_pv)) {
4560 seed_buffer[i] |= READ_XDIGIT(env_pv);
4563 while (isSPACE(*env_pv))
4566 if (*env_pv && !isXDIGIT(*env_pv)) {
4567 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4569 /* should we check for unparsed crap? */
4570 /* should we warn about unused hex? */
4571 /* should we warn about insufficient hex? */
4574 #endif /* NO_PERL_HASH_ENV */
4576 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4577 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
4580 #ifdef USE_PERL_PERTURB_KEYS
4581 { /* initialize PL_hash_rand_bits from the hash seed.
4582 * This value is highly volatile, it is updated every
4583 * hash insert, and is used as part of hash bucket chain
4584 * randomization and hash iterator randomization. */
4585 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4586 for( i = 0; i < sizeof(UV) ; i++ ) {
4587 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4588 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4591 # ifndef NO_PERL_HASH_ENV
4592 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4594 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4595 PL_hash_rand_bits_enabled= 0;
4596 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4597 PL_hash_rand_bits_enabled= 1;
4598 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4599 PL_hash_rand_bits_enabled= 2;
4601 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4608 #ifdef PERL_GLOBAL_STRUCT
4610 #define PERL_GLOBAL_STRUCT_INIT
4611 #include "opcode.h" /* the ppaddr and check */
4614 Perl_init_global_struct(pTHX)
4616 struct perl_vars *plvarsp = NULL;
4617 # ifdef PERL_GLOBAL_STRUCT
4618 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4619 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4620 PERL_UNUSED_CONTEXT;
4621 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4622 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4623 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4627 plvarsp = PL_VarsPtr;
4628 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4633 # define PERLVAR(prefix,var,type) /**/
4634 # define PERLVARA(prefix,var,n,type) /**/
4635 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4636 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4637 # include "perlvars.h"
4642 # ifdef PERL_GLOBAL_STRUCT
4645 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4646 if (!plvarsp->Gppaddr)
4650 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4651 if (!plvarsp->Gcheck)
4653 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4654 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4656 # ifdef PERL_SET_VARS
4657 PERL_SET_VARS(plvarsp);
4659 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4660 plvarsp->Gsv_placeholder.sv_flags = 0;
4661 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4663 # undef PERL_GLOBAL_STRUCT_INIT
4668 #endif /* PERL_GLOBAL_STRUCT */
4670 #ifdef PERL_GLOBAL_STRUCT
4673 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4675 int veto = plvarsp->Gveto_cleanup;
4677 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4678 PERL_UNUSED_CONTEXT;
4679 # ifdef PERL_GLOBAL_STRUCT
4680 # ifdef PERL_UNSET_VARS
4681 PERL_UNSET_VARS(plvarsp);
4685 free(plvarsp->Gppaddr);
4686 free(plvarsp->Gcheck);
4687 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4693 #endif /* PERL_GLOBAL_STRUCT */
4697 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4698 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4699 * given, and you supply your own implementation.
4701 * The default implementation reads a single env var, PERL_MEM_LOG,
4702 * expecting one or more of the following:
4704 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4705 * 'm' - memlog was PERL_MEM_LOG=1
4706 * 's' - svlog was PERL_SV_LOG=1
4707 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4709 * This makes the logger controllable enough that it can reasonably be
4710 * added to the system perl.
4713 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4714 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4716 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4718 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4719 * writes to. In the default logger, this is settable at runtime.
4721 #ifndef PERL_MEM_LOG_FD
4722 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4725 #ifndef PERL_MEM_LOG_NOIMPL
4727 # ifdef DEBUG_LEAKING_SCALARS
4728 # define SV_LOG_SERIAL_FMT " [%lu]"
4729 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4731 # define SV_LOG_SERIAL_FMT
4732 # define _SV_LOG_SERIAL_ARG(sv)
4736 S_mem_log_common(enum mem_log_type mlt, const UV n,
4737 const UV typesize, const char *type_name, const SV *sv,
4738 Malloc_t oldalloc, Malloc_t newalloc,
4739 const char *filename, const int linenumber,
4740 const char *funcname)
4744 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4746 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4749 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4751 /* We can't use SVs or PerlIO for obvious reasons,
4752 * so we'll use stdio and low-level IO instead. */
4753 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4755 # ifdef HAS_GETTIMEOFDAY
4756 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4757 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4759 gettimeofday(&tv, 0);
4761 # define MEM_LOG_TIME_FMT "%10d: "
4762 # define MEM_LOG_TIME_ARG (int)when
4766 /* If there are other OS specific ways of hires time than
4767 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4768 * probably that they would be used to fill in the struct
4772 const char* endptr = pmlenv + strlen(pmlenv);
4775 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4776 && uv && uv <= PERL_INT_MAX
4780 fd = PERL_MEM_LOG_FD;
4783 if (strchr(pmlenv, 't')) {
4784 len = my_snprintf(buf, sizeof(buf),
4785 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4786 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4790 len = my_snprintf(buf, sizeof(buf),
4791 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4792 " %s = %" IVdf ": %" UVxf "\n",
4793 filename, linenumber, funcname, n, typesize,
4794 type_name, n * typesize, PTR2UV(newalloc));
4797 len = my_snprintf(buf, sizeof(buf),
4798 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4799 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4800 filename, linenumber, funcname, n, typesize,
4801 type_name, n * typesize, PTR2UV(oldalloc),
4805 len = my_snprintf(buf, sizeof(buf),
4806 "free: %s:%d:%s: %" UVxf "\n",
4807 filename, linenumber, funcname,
4812 len = my_snprintf(buf, sizeof(buf),
4813 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
4814 mlt == MLT_NEW_SV ? "new" : "del",
4815 filename, linenumber, funcname,
4816 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4821 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4825 #endif /* !PERL_MEM_LOG_NOIMPL */
4827 #ifndef PERL_MEM_LOG_NOIMPL
4829 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4830 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4832 /* this is suboptimal, but bug compatible. User is providing their
4833 own implementation, but is getting these functions anyway, and they
4834 do nothing. But _NOIMPL users should be able to cope or fix */
4836 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4837 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
4841 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4843 const char *filename, const int linenumber,
4844 const char *funcname)
4846 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
4848 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4849 NULL, NULL, newalloc,
4850 filename, linenumber, funcname);
4855 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4856 Malloc_t oldalloc, Malloc_t newalloc,
4857 const char *filename, const int linenumber,
4858 const char *funcname)
4860 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
4862 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4863 NULL, oldalloc, newalloc,
4864 filename, linenumber, funcname);
4869 Perl_mem_log_free(Malloc_t oldalloc,
4870 const char *filename, const int linenumber,
4871 const char *funcname)
4873 PERL_ARGS_ASSERT_MEM_LOG_FREE;
4875 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4876 filename, linenumber, funcname);
4881 Perl_mem_log_new_sv(const SV *sv,
4882 const char *filename, const int linenumber,
4883 const char *funcname)
4885 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4886 filename, linenumber, funcname);
4890 Perl_mem_log_del_sv(const SV *sv,
4891 const char *filename, const int linenumber,
4892 const char *funcname)
4894 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4895 filename, linenumber, funcname);
4898 #endif /* PERL_MEM_LOG */
4901 =for apidoc quadmath_format_single
4903 C<quadmath_snprintf()> is very strict about its C<format> string and will
4904 fail, returning -1, if the format is invalid. It accepts exactly
4907 C<quadmath_format_single()> checks that the intended single spec looks
4908 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
4909 and has C<Q> before it. This is not a full "printf syntax check",
4912 Returns the format if it is valid, NULL if not.
4914 C<quadmath_format_single()> can and will actually patch in the missing
4915 C<Q>, if necessary. In this case it will return the modified copy of
4916 the format, B<which the caller will need to free.>
4918 See also L</quadmath_format_needed>.
4924 Perl_quadmath_format_single(const char* format)
4928 PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
4930 if (format[0] != '%' || strchr(format + 1, '%'))
4932 len = strlen(format);
4933 /* minimum length three: %Qg */
4934 if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
4936 if (format[len - 2] != 'Q') {
4938 Newx(fixed, len + 1, char);
4939 memcpy(fixed, format, len - 1);
4940 fixed[len - 1] = 'Q';
4941 fixed[len ] = format[len - 1];
4943 return (const char*)fixed;
4950 =for apidoc quadmath_format_needed
4952 C<quadmath_format_needed()> returns true if the C<format> string seems to
4953 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
4954 or returns false otherwise.
4956 The format specifier detection is not complete printf-syntax detection,
4957 but it should catch most common cases.
4959 If true is returned, those arguments B<should> in theory be processed
4960 with C<quadmath_snprintf()>, but in case there is more than one such
4961 format specifier (see L</quadmath_format_single>), and if there is
4962 anything else beyond that one (even just a single byte), they
4963 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
4964 accepting only one format spec, and nothing else.
4965 In this case, the code should probably fail.
4971 Perl_quadmath_format_needed(const char* format)
4973 const char *p = format;
4976 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
4978 while ((q = strchr(p, '%'))) {
4980 if (*q == '+') /* plus */
4982 if (*q == '#') /* alt */
4984 if (*q == '*') /* width */
4988 while (isDIGIT(*q)) q++;
4991 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
4996 while (isDIGIT(*q)) q++;
4998 if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5007 =for apidoc my_snprintf
5009 The C library C<snprintf> functionality, if available and
5010 standards-compliant (uses C<vsnprintf>, actually). However, if the
5011 C<vsnprintf> is not available, will unfortunately use the unsafe
5012 C<vsprintf> which can overrun the buffer (there is an overrun check,
5013 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5014 getting C<vsnprintf>.
5019 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5023 PERL_ARGS_ASSERT_MY_SNPRINTF;
5024 #ifndef HAS_VSNPRINTF
5025 PERL_UNUSED_VAR(len);
5027 va_start(ap, format);
5030 const char* qfmt = quadmath_format_single(format);
5031 bool quadmath_valid = FALSE;
5033 /* If the format looked promising, use it as quadmath. */
5034 retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
5036 if (qfmt != format) {
5040 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
5042 quadmath_valid = TRUE;
5047 assert(qfmt == NULL);
5048 /* quadmath_format_single() will return false for example for
5049 * "foo = %g", or simply "%g". We could handle the %g by
5050 * using quadmath for the NV args. More complex cases of
5051 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5052 * quadmath-valid but has stuff in front).
5054 * Handling the "Q-less" cases right would require walking
5055 * through the va_list and rewriting the format, calling
5056 * quadmath for the NVs, building a new va_list, and then
5057 * letting vsnprintf/vsprintf to take care of the other
5058 * arguments. This may be doable.
5060 * We do not attempt that now. But for paranoia, we here try
5061 * to detect some common (but not all) cases where the
5062 * "Q-less" %[efgaEFGA] formats are present, and die if
5063 * detected. This doesn't fix the problem, but it stops the
5064 * vsnprintf/vsprintf pulling doubles off the va_list when
5065 * __float128 NVs should be pulled off instead.
5067 * If quadmath_format_needed() returns false, we are reasonably
5068 * certain that we can call vnsprintf() or vsprintf() safely. */
5069 if (!quadmath_valid && quadmath_format_needed(format))
5070 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5075 #ifdef HAS_VSNPRINTF
5076 retval = vsnprintf(buffer, len, format, ap);
5078 retval = vsprintf(buffer, format, ap);
5081 /* vsprintf() shows failure with < 0 */
5083 #ifdef HAS_VSNPRINTF
5084 /* vsnprintf() shows failure with >= len */
5086 (len > 0 && (Size_t)retval >= len)
5089 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5094 =for apidoc my_vsnprintf
5096 The C library C<vsnprintf> if available and standards-compliant.
5097 However, if if the C<vsnprintf> is not available, will unfortunately
5098 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5099 overrun check, but that may be too late). Consider using
5100 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5105 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5108 PERL_UNUSED_ARG(buffer);
5109 PERL_UNUSED_ARG(len);
5110 PERL_UNUSED_ARG(format);
5111 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5112 PERL_UNUSED_ARG((void*)ap);
5113 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5120 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5121 Perl_va_copy(ap, apc);
5122 # ifdef HAS_VSNPRINTF
5123 retval = vsnprintf(buffer, len, format, apc);
5125 PERL_UNUSED_ARG(len);
5126 retval = vsprintf(buffer, format, apc);
5130 # ifdef HAS_VSNPRINTF
5131 retval = vsnprintf(buffer, len, format, ap);
5133 PERL_UNUSED_ARG(len);
5134 retval = vsprintf(buffer, format, ap);
5136 #endif /* #ifdef NEED_VA_COPY */
5137 /* vsprintf() shows failure with < 0 */
5139 #ifdef HAS_VSNPRINTF
5140 /* vsnprintf() shows failure with >= len */
5142 (len > 0 && (Size_t)retval >= len)
5145 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5151 Perl_my_clearenv(pTHX)
5154 #if ! defined(PERL_MICRO)
5155 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5157 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5158 # if defined(USE_ENVIRON_ARRAY)
5159 # if defined(USE_ITHREADS)
5160 /* only the parent thread can clobber the process environment */
5161 if (PL_curinterp == aTHX)
5162 # endif /* USE_ITHREADS */
5164 # if ! defined(PERL_USE_SAFE_PUTENV)
5165 if ( !PL_use_safe_putenv) {
5167 if (environ == PL_origenviron)
5168 environ = (char**)safesysmalloc(sizeof(char*));
5170 for (i = 0; environ[i]; i++)
5171 (void)safesysfree(environ[i]);
5174 # else /* PERL_USE_SAFE_PUTENV */
5175 # if defined(HAS_CLEARENV)
5177 # elif defined(HAS_UNSETENV)
5178 int bsiz = 80; /* Most envvar names will be shorter than this. */
5179 char *buf = (char*)safesysmalloc(bsiz);
5180 while (*environ != NULL) {
5181 char *e = strchr(*environ, '=');
5182 int l = e ? e - *environ : (int)strlen(*environ);
5184 (void)safesysfree(buf);
5185 bsiz = l + 1; /* + 1 for the \0. */
5186 buf = (char*)safesysmalloc(bsiz);
5188 memcpy(buf, *environ, l);
5190 (void)unsetenv(buf);
5192 (void)safesysfree(buf);
5193 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5194 /* Just null environ and accept the leakage. */
5196 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5197 # endif /* ! PERL_USE_SAFE_PUTENV */
5199 # endif /* USE_ENVIRON_ARRAY */
5200 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5201 #endif /* PERL_MICRO */
5204 #ifdef PERL_IMPLICIT_CONTEXT
5206 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5207 the global PL_my_cxt_index is incremented, and that value is assigned to
5208 that module's static my_cxt_index (who's address is passed as an arg).
5209 Then, for each interpreter this function is called for, it makes sure a
5210 void* slot is available to hang the static data off, by allocating or
5211 extending the interpreter's PL_my_cxt_list array */
5213 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
5215 Perl_my_cxt_init(pTHX_ int *index, size_t size)
5219 PERL_ARGS_ASSERT_MY_CXT_INIT;
5221 /* this module hasn't been allocated an index yet */
5222 MUTEX_LOCK(&PL_my_ctx_mutex);
5223 *index = PL_my_cxt_index++;
5224 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5227 /* make sure the array is big enough */
5228 if (PL_my_cxt_size <= *index) {
5229 if (PL_my_cxt_size) {
5230 IV new_size = PL_my_cxt_size;
5231 while (new_size <= *index)
5233 Renew(PL_my_cxt_list, new_size, void *);
5234 PL_my_cxt_size = new_size;
5237 PL_my_cxt_size = 16;
5238 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5241 /* newSV() allocates one more than needed */
5242 p = (void*)SvPVX(newSV(size-1));
5243 PL_my_cxt_list[*index] = p;
5244 Zero(p, size, char);
5248 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5251 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5256 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5258 for (index = 0; index < PL_my_cxt_index; index++) {
5259 const char *key = PL_my_cxt_keys[index];
5260 /* try direct pointer compare first - there are chances to success,
5261 * and it's much faster.
5263 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5270 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5276 PERL_ARGS_ASSERT_MY_CXT_INIT;
5278 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5280 /* this module hasn't been allocated an index yet */
5281 MUTEX_LOCK(&PL_my_ctx_mutex);
5282 index = PL_my_cxt_index++;
5283 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5286 /* make sure the array is big enough */
5287 if (PL_my_cxt_size <= index) {
5288 int old_size = PL_my_cxt_size;
5290 if (PL_my_cxt_size) {
5291 IV new_size = PL_my_cxt_size;
5292 while (new_size <= index)
5294 Renew(PL_my_cxt_list, new_size, void *);
5295 Renew(PL_my_cxt_keys, new_size, const char *);
5296 PL_my_cxt_size = new_size;
5299 PL_my_cxt_size = 16;
5300 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5301 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5303 for (i = old_size; i < PL_my_cxt_size; i++) {
5304 PL_my_cxt_keys[i] = 0;
5305 PL_my_cxt_list[i] = 0;
5308 PL_my_cxt_keys[index] = my_cxt_key;
5309 /* newSV() allocates one more than needed */
5310 p = (void*)SvPVX(newSV(size-1));
5311 PL_my_cxt_list[index] = p;
5312 Zero(p, size, char);
5315 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5316 #endif /* PERL_IMPLICIT_CONTEXT */
5319 /* Perl_xs_handshake():
5320 implement the various XS_*_BOOTCHECK macros, which are added to .c
5321 files by ExtUtils::ParseXS, to check that the perl the module was built
5322 with is binary compatible with the running perl.
5325 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5326 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5328 The meaning of the varargs is determined the U32 key arg (which is not
5329 a format string). The fields of key are assembled by using HS_KEY().
5331 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5332 "PerlInterpreter *" and represents the callers context; otherwise it is
5333 of type "CV *", and is the boot xsub's CV.
5335 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5336 for example, and IO.dll was linked with threaded perl524.dll, and both
5337 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5338 successfully can load IO.dll into the process but simultaneously it
5339 loaded an interpreter of a different version into the process, and XS
5340 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5341 use through perl526.dll's my_perl->Istack_base.
5343 v_my_perl cannot be the first arg, since then 'key' will be out of
5344 place in a threaded vs non-threaded mixup; and analyzing the key
5345 number's bitfields won't reveal the problem, since it will be a valid
5346 key (unthreaded perl) on interp side, but croak will report the XS mod's
5347 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5348 it's a threaded perl and an unthreaded XS module, threaded perl will
5349 look at an uninit C stack or an uninit register to get 'key'
5350 (remember that it assumes that the 1st arg is the interp cxt).
5352 'file' is the source filename of the caller.
5356 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5362 #ifdef PERL_IMPLICIT_CONTEXT
5369 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5370 va_start(args, file);
5372 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5373 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5374 if (UNLIKELY(got != need))
5376 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5377 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5378 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5379 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5380 passed to the XS DLL */
5381 #ifdef PERL_IMPLICIT_CONTEXT
5382 xs_interp = (tTHX)v_my_perl;
5386 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5387 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5388 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5389 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5390 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5391 location in the unthreaded perl binary) stored in CV * to figure out if this
5392 Perl_xs_handshake was called by the same pp_entersub */
5393 cv = (CV*)v_my_perl;
5394 xs_spp = (SV***)CvHSCXT(cv);
5396 need = &PL_stack_sp;
5398 if(UNLIKELY(got != need)) {
5399 bad_handshake:/* recycle branch and string from above */
5400 if(got != (void *)HSf_NOCHK)
5401 noperl_die("%s: loadable library and perl binaries are mismatched"
5402 " (got handshake key %p, needed %p)\n",
5406 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5407 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5408 PL_xsubfilename = file; /* so the old name must be restored for
5409 additional XSUBs to register themselves */
5410 /* XSUBs can't be perl lang/perl5db.pl debugged
5411 if (PERLDB_LINE_OR_SAVESRC)
5412 (void)gv_fetchfile(file); */
5415 if(key & HSf_POPMARK) {
5417 { SV **mark = PL_stack_base + ax++;
5419 items = (I32)(SP - MARK);
5423 items = va_arg(args, U32);
5424 ax = va_arg(args, U32);
5428 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5429 if((apiverlen = HS_GETAPIVERLEN(key))) {
5430 char * api_p = va_arg(args, char*);
5431 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5432 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5433 sizeof("v" PERL_API_VERSION_STRING)-1))
5434 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5435 api_p, SVfARG(PL_stack_base[ax + 0]),
5436 "v" PERL_API_VERSION_STRING);
5441 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5442 if((xsverlen = HS_GETXSVERLEN(key)))
5443 S_xs_version_bootcheck(aTHX_
5444 items, ax, va_arg(args, char*), xsverlen);
5452 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5456 const char *vn = NULL;
5457 SV *const module = PL_stack_base[ax];
5459 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5461 if (items >= 2) /* version supplied as bootstrap arg */
5462 sv = PL_stack_base[ax + 1];
5464 /* XXX GV_ADDWARN */
5466 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5467 if (!sv || !SvOK(sv)) {
5469 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5473 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5474 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5475 ? sv : sv_2mortal(new_version(sv));
5476 xssv = upg_version(xssv, 0);
5477 if ( vcmp(pmsv,xssv) ) {
5478 SV *string = vstringify(xssv);
5479 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5480 " does not match ", SVfARG(module), SVfARG(string));
5482 SvREFCNT_dec(string);
5483 string = vstringify(pmsv);
5486 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5489 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5491 SvREFCNT_dec(string);
5493 Perl_sv_2mortal(aTHX_ xpt);
5494 Perl_croak_sv(aTHX_ xpt);
5500 =for apidoc my_strlcat
5502 The C library C<strlcat> if available, or a Perl implementation of it.
5503 This operates on C C<NUL>-terminated strings.
5505 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5506 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5507 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5508 practice this should not happen as it means that either C<size> is incorrect or
5509 that C<dst> is not a proper C<NUL>-terminated string).
5511 Note that C<size> is the full size of the destination buffer and
5512 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5513 room for the C<NUL> should be included in C<size>.
5515 The return value is the total length that C<dst> would have if C<size> is
5516 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5517 C<src>. If C<size> is smaller than the return, the excess was not appended.
5521 Description stolen from http://man.openbsd.org/strlcat.3
5525 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5527 Size_t used, length, copy;
5530 length = strlen(src);
5531 if (size > 0 && used < size - 1) {
5532 copy = (length >= size - used) ? size - used - 1 : length;
5533 memcpy(dst + used, src, copy);
5534 dst[used + copy] = '\0';
5536 return used + length;
5542 =for apidoc my_strlcpy
5544 The C library C<strlcpy> if available, or a Perl implementation of it.
5545 This operates on C C<NUL>-terminated strings.
5547 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5548 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5550 The return value is the total length C<src> would be if the copy completely
5551 succeeded. If it is larger than C<size>, the excess was not copied.
5555 Description stolen from http://man.openbsd.org/strlcpy.3
5559 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5561 Size_t length, copy;
5563 length = strlen(src);
5565 copy = (length >= size) ? size - 1 : length;
5566 memcpy(dst, src, copy);
5574 =for apidoc my_strnlen
5576 The C library C<strnlen> if available, or a Perl implementation of it.
5578 C<my_strnlen()> computes the length of the string, up to C<maxlen>
5579 characters. It will will never attempt to address more than C<maxlen>
5580 characters, making it suitable for use with strings that are not
5581 guaranteed to be NUL-terminated.
5585 Description stolen from http://man.openbsd.org/strnlen.3,
5586 implementation stolen from PostgreSQL.
5590 Perl_my_strnlen(const char *str, Size_t maxlen)
5592 const char *p = str;
5594 PERL_ARGS_ASSERT_MY_STRNLEN;
5596 while(maxlen-- && *p)
5603 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5604 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5605 long _ftol( double ); /* Defined by VC6 C libs. */
5606 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5609 PERL_STATIC_INLINE bool
5610 S_gv_has_usable_name(pTHX_ GV *gv)
5614 && HvENAME(GvSTASH(gv))
5615 && (gvp = (GV **)hv_fetchhek(
5616 GvSTASH(gv), GvNAME_HEK(gv), 0
5622 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5624 SV * const dbsv = GvSVn(PL_DBsub);
5625 const bool save_taint = TAINT_get;
5627 /* When we are called from pp_goto (svp is null),
5628 * we do not care about using dbsv to call CV;
5629 * it's for informational purposes only.
5632 PERL_ARGS_ASSERT_GET_DB_SUB;
5636 if (!PERLDB_SUB_NN) {
5639 if (!svp && !CvLEXICAL(cv)) {
5640 gv_efullname3(dbsv, gv, NULL);
5642 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5643 || strEQ(GvNAME(gv), "END")
5644 || ( /* Could be imported, and old sub redefined. */
5645 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5647 !( (SvTYPE(*svp) == SVt_PVGV)
5648 && (GvCV((const GV *)*svp) == cv)
5649 /* Use GV from the stack as a fallback. */
5650 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5654 /* GV is potentially non-unique, or contain different CV. */
5655 SV * const tmp = newRV(MUTABLE_SV(cv));
5656 sv_setsv(dbsv, tmp);
5660 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5661 sv_catpvs(dbsv, "::");
5662 sv_cathek(dbsv, GvNAME_HEK(gv));
5666 const int type = SvTYPE(dbsv);
5667 if (type < SVt_PVIV && type != SVt_IV)
5668 sv_upgrade(dbsv, SVt_PVIV);
5669 (void)SvIOK_on(dbsv);
5670 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5673 TAINT_IF(save_taint);
5674 #ifdef NO_TAINT_SUPPORT
5675 PERL_UNUSED_VAR(save_taint);
5680 Perl_my_dirfd(DIR * dir) {
5682 /* Most dirfd implementations have problems when passed NULL. */
5687 #elif defined(HAS_DIR_DD_FD)
5690 Perl_croak_nocontext(PL_no_func, "dirfd");
5691 NOT_REACHED; /* NOTREACHED */
5696 #if !defined(HAS_MKOSTEMP) || !defined(HAS_MKSTEMP)
5698 #define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
5699 #define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
5702 S_my_mkostemp(char *templte, int flags) {
5704 STRLEN len = strlen(templte);
5709 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
5710 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
5711 SETERRNO(EINVAL, LIB_INVARG);
5717 for (i = 1; i <= 6; ++i) {
5718 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
5720 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600);
5721 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
5728 #ifndef HAS_MKOSTEMP
5730 Perl_my_mkostemp(char *templte, int flags)
5732 PERL_ARGS_ASSERT_MY_MKOSTEMP;
5733 return S_my_mkostemp(templte, flags);
5739 Perl_my_mkstemp(char *templte)
5741 PERL_ARGS_ASSERT_MY_MKSTEMP;
5742 return S_my_mkostemp(templte, 0);
5747 Perl_get_re_arg(pTHX_ SV *sv) {
5753 sv = MUTABLE_SV(SvRV(sv));
5754 if (SvTYPE(sv) == SVt_REGEXP)
5755 return (REGEXP*) sv;
5762 * This code is derived from drand48() implementation from FreeBSD,
5763 * found in lib/libc/gen/_rand48.c.
5765 * The U64 implementation is original, based on the POSIX
5766 * specification for drand48().
5770 * Copyright (c) 1993 Martin Birgmeier
5771 * All rights reserved.
5773 * You may redistribute unmodified or modified versions of this source
5774 * code provided that the above copyright notice and this and the
5775 * following conditions are retained.
5777 * This software is provided ``as is'', and comes with no warranties
5778 * of any kind. I shall in no event be liable for anything that happens
5779 * to anyone/anything when using this software.
5782 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5784 #ifdef PERL_DRAND48_QUAD
5786 #define DRAND48_MULT UINT64_C(0x5deece66d)
5787 #define DRAND48_ADD 0xb
5788 #define DRAND48_MASK UINT64_C(0xffffffffffff)
5792 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5793 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5794 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5795 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5796 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5797 #define FREEBSD_DRAND48_ADD (0x000b)
5799 const unsigned short _rand48_mult[3] = {
5800 FREEBSD_DRAND48_MULT_0,
5801 FREEBSD_DRAND48_MULT_1,
5802 FREEBSD_DRAND48_MULT_2
5804 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5809 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5811 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5813 #ifdef PERL_DRAND48_QUAD
5814 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5816 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5817 random_state->seed[1] = (U16) seed;
5818 random_state->seed[2] = (U16) (seed >> 16);
5823 Perl_drand48_r(perl_drand48_t *random_state)
5825 PERL_ARGS_ASSERT_DRAND48_R;
5827 #ifdef PERL_DRAND48_QUAD
5828 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5831 return ldexp((double)*random_state, -48);
5837 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5838 + (U32) _rand48_add;
5839 temp[0] = (U16) accu; /* lower 16 bits */
5840 accu >>= sizeof(U16) * 8;
5841 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5842 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5843 temp[1] = (U16) accu; /* middle 16 bits */
5844 accu >>= sizeof(U16) * 8;
5845 accu += _rand48_mult[0] * random_state->seed[2]
5846 + _rand48_mult[1] * random_state->seed[1]
5847 + _rand48_mult[2] * random_state->seed[0];
5848 random_state->seed[0] = temp[0];
5849 random_state->seed[1] = temp[1];
5850 random_state->seed[2] = (U16) accu;
5852 return ldexp((double) random_state->seed[0], -48) +
5853 ldexp((double) random_state->seed[1], -32) +
5854 ldexp((double) random_state->seed[2], -16);
5859 #ifdef USE_C_BACKTRACE
5861 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5866 /* abfd is the BFD handle. */
5868 /* bfd_syms is the BFD symbol table. */
5870 /* bfd_text is handle to the the ".text" section of the object file. */
5872 /* Since opening the executable and scanning its symbols is quite
5873 * heavy operation, we remember the filename we used the last time,
5874 * and do the opening and scanning only if the filename changes.
5875 * This removes most (but not all) open+scan cycles. */
5876 const char* fname_prev;
5879 /* Given a dl_info, update the BFD context if necessary. */
5880 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5882 /* BFD open and scan only if the filename changed. */
5883 if (ctx->fname_prev == NULL ||
5884 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5886 bfd_close(ctx->abfd);
5888 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5890 if (bfd_check_format(ctx->abfd, bfd_object)) {
5891 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5892 if (symbol_size > 0) {
5893 Safefree(ctx->bfd_syms);
5894 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5896 bfd_get_section_by_name(ctx->abfd, ".text");
5904 ctx->fname_prev = dl_info->dli_fname;
5908 /* Given a raw frame, try to symbolize it and store
5909 * symbol information (source file, line number) away. */
5910 static void bfd_symbolize(bfd_context* ctx,
5913 STRLEN* symbol_name_size,
5915 STRLEN* source_name_size,
5916 STRLEN* source_line)
5918 *symbol_name = NULL;
5919 *symbol_name_size = 0;
5921 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5923 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5926 unsigned int line = 0;
5927 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5928 ctx->bfd_syms, offset,
5929 &file, &func, &line) &&
5930 file && func && line > 0) {
5931 /* Size and copy the source file, use only
5932 * the basename of the source file.
5934 * NOTE: the basenames are fine for the
5935 * Perl source files, but may not always
5936 * be the best idea for XS files. */
5937 const char *p, *b = NULL;
5938 /* Look for the last slash. */
5939 for (p = file; *p; p++) {
5943 if (b == NULL || *b == 0) {
5946 *source_name_size = p - b + 1;
5947 Newx(*source_name, *source_name_size + 1, char);
5948 Copy(b, *source_name, *source_name_size + 1, char);
5950 *symbol_name_size = strlen(func);
5951 Newx(*symbol_name, *symbol_name_size + 1, char);
5952 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5954 *source_line = line;
5960 #endif /* #ifdef USE_BFD */
5964 /* OS X has no public API for for 'symbolicating' (Apple official term)
5965 * stack addresses to {function_name, source_file, line_number}.
5966 * Good news: there is command line utility atos(1) which does that.
5967 * Bad news 1: it's a command line utility.
5968 * Bad news 2: one needs to have the Developer Tools installed.
5969 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
5971 * To recap: we need to open a pipe for reading for a utility which
5972 * might not exist, or exists in different locations, and then parse
5973 * the output. And since this is all for a low-level API, we cannot
5974 * use high-level stuff. Thanks, Apple. */
5977 /* tool is set to the absolute pathname of the tool to use:
5980 /* format is set to a printf format string used for building
5981 * the external command to run. */
5983 /* unavail is set if e.g. xcrun cannot be found, or something
5984 * else happens that makes getting the backtrace dubious. Note,
5985 * however, that the context isn't persistent, the next call to
5986 * get_c_backtrace() will start from scratch. */
5988 /* fname is the current object file name. */
5990 /* object_base_addr is the base address of the shared object. */
5991 void* object_base_addr;
5994 /* Given |dl_info|, updates the context. If the context has been
5995 * marked unavailable, return immediately. If not but the tool has
5996 * not been set, set it to either "xcrun atos" or "atos" (also set the
5997 * format to use for creating commands for piping), or if neither is
5998 * unavailable (one needs the Developer Tools installed), mark the context
5999 * an unavailable. Finally, update the filename (object name),
6000 * and its base address. */
6002 static void atos_update(atos_context* ctx,
6007 if (ctx->tool == NULL) {
6008 const char* tools[] = {
6012 const char* formats[] = {
6013 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6014 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6018 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6019 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6020 ctx->tool = tools[i];
6021 ctx->format = formats[i];
6025 if (ctx->tool == NULL) {
6026 ctx->unavail = TRUE;
6030 if (ctx->fname == NULL ||
6031 strNE(dl_info->dli_fname, ctx->fname)) {
6032 ctx->fname = dl_info->dli_fname;
6033 ctx->object_base_addr = dl_info->dli_fbase;
6037 /* Given an output buffer end |p| and its |start|, matches
6038 * for the atos output, extracting the source code location
6039 * and returning non-NULL if possible, returning NULL otherwise. */
6040 static const char* atos_parse(const char* p,
6042 STRLEN* source_name_size,
6043 STRLEN* source_line) {
6044 /* atos() output is something like:
6045 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6046 * We cannot use Perl regular expressions, because we need to
6047 * stay low-level. Therefore here we have a rolled-out version
6048 * of a state machine which matches _backwards_from_the_end_ and
6049 * if there's a success, returns the starts of the filename,
6050 * also setting the filename size and the source line number.
6051 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6052 const char* source_number_start;
6053 const char* source_name_end;
6054 const char* source_line_end = start;
6055 const char* close_paren;
6058 /* Skip trailing whitespace. */
6059 while (p > start && isSPACE(*p)) p--;
6060 /* Now we should be at the close paren. */
6061 if (p == start || *p != ')')
6065 /* Now we should be in the line number. */
6066 if (p == start || !isDIGIT(*p))
6068 /* Skip over the digits. */
6069 while (p > start && isDIGIT(*p))
6071 /* Now we should be at the colon. */
6072 if (p == start || *p != ':')
6074 source_number_start = p + 1;
6075 source_name_end = p; /* Just beyond the end. */
6077 /* Look for the open paren. */
6078 while (p > start && *p != '(')
6083 *source_name_size = source_name_end - p;
6084 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6085 && source_line_end == close_paren
6086 && uv <= PERL_INT_MAX
6088 *source_line = (STRLEN)uv;
6094 /* Given a raw frame, read a pipe from the symbolicator (that's the
6095 * technical term) atos, reads the result, and parses the source code
6096 * location. We must stay low-level, so we use snprintf(), pipe(),
6097 * and fread(), and then also parse the output ourselves. */
6098 static void atos_symbolize(atos_context* ctx,
6101 STRLEN* source_name_size,
6102 STRLEN* source_line)
6110 /* Simple security measure: if there's any funny business with
6111 * the object name (used as "-o '%s'" ), leave since at least
6112 * partially the user controls it. */
6113 for (p = ctx->fname; *p; p++) {
6114 if (*p == '\'' || isCNTRL(*p)) {
6115 ctx->unavail = TRUE;
6119 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6120 ctx->fname, ctx->object_base_addr, raw_frame);
6121 if (cnt < sizeof(cmd)) {
6122 /* Undo nostdio.h #defines that disable stdio.
6123 * This is somewhat naughty, but is used elsewhere
6124 * in the core, and affects only OS X. */
6129 FILE* fp = popen(cmd, "r");
6130 /* At the moment we open a new pipe for each stack frame.
6131 * This is naturally somewhat slow, but hopefully generating
6132 * stack traces is never going to in a performance critical path.
6134 * We could play tricks with atos by batching the stack
6135 * addresses to be resolved: atos can either take multiple
6136 * addresses from the command line, or read addresses from
6137 * a file (though the mess of creating temporary files would
6138 * probably negate much of any possible speedup).
6140 * Normally there are only two objects present in the backtrace:
6141 * perl itself, and the libdyld.dylib. (Note that the object
6142 * filenames contain the full pathname, so perl may not always
6143 * be in the same place.) Whenever the object in the
6144 * backtrace changes, the base address also changes.
6146 * The problem with batching the addresses, though, would be
6147 * matching the results with the addresses: the parsing of
6148 * the results is already painful enough with a single address. */
6151 UV cnt = fread(out, 1, sizeof(out), fp);
6152 if (cnt < sizeof(out)) {
6153 const char* p = atos_parse(out + cnt - 1, out,
6158 *source_name_size, char);
6159 Copy(p, *source_name,
6160 *source_name_size, char);
6168 #endif /* #ifdef PERL_DARWIN */
6171 =for apidoc get_c_backtrace
6173 Collects the backtrace (aka "stacktrace") into a single linear
6174 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6176 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6177 returning at most C<depth> frames.
6183 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6185 /* Note that here we must stay as low-level as possible: Newx(),
6186 * Copy(), Safefree(); since we may be called from anywhere,
6187 * so we should avoid higher level constructs like SVs or AVs.
6189 * Since we are using safesysmalloc() via Newx(), don't try
6190 * getting backtrace() there, unless you like deep recursion. */
6192 /* Currently only implemented with backtrace() and dladdr(),
6193 * for other platforms NULL is returned. */
6195 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6196 /* backtrace() is available via <execinfo.h> in glibc and in most
6197 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6199 /* We try fetching this many frames total, but then discard
6200 * the |skip| first ones. For the remaining ones we will try
6201 * retrieving more information with dladdr(). */
6202 int try_depth = skip + depth;
6204 /* The addresses (program counters) returned by backtrace(). */
6207 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6210 /* Sizes _including_ the terminating \0 of the object name
6211 * and symbol name strings. */
6212 STRLEN* object_name_sizes;
6213 STRLEN* symbol_name_sizes;
6216 /* The symbol names comes either from dli_sname,
6217 * or if using BFD, they can come from BFD. */
6218 char** symbol_names;
6221 /* The source code location information. Dug out with e.g. BFD. */
6222 char** source_names;
6223 STRLEN* source_name_sizes;
6224 STRLEN* source_lines;
6226 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6227 int got_depth; /* How many frames were returned from backtrace(). */
6228 UV frame_count = 0; /* How many frames we return. */
6229 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6232 bfd_context bfd_ctx;
6235 atos_context atos_ctx;
6238 /* Here are probably possibilities for optimizing. We could for
6239 * example have a struct that contains most of these and then
6240 * allocate |try_depth| of them, saving a bunch of malloc calls.
6241 * Note, however, that |frames| could not be part of that struct
6242 * because backtrace() will want an array of just them. Also be
6243 * careful about the name strings. */
6244 Newx(raw_frames, try_depth, void*);
6245 Newx(dl_infos, try_depth, Dl_info);
6246 Newx(object_name_sizes, try_depth, STRLEN);
6247 Newx(symbol_name_sizes, try_depth, STRLEN);
6248 Newx(source_names, try_depth, char*);
6249 Newx(source_name_sizes, try_depth, STRLEN);
6250 Newx(source_lines, try_depth, STRLEN);
6252 Newx(symbol_names, try_depth, char*);
6255 /* Get the raw frames. */
6256 got_depth = (int)backtrace(raw_frames, try_depth);
6258 /* We use dladdr() instead of backtrace_symbols() because we want
6259 * the full details instead of opaque strings. This is useful for
6260 * two reasons: () the details are needed for further symbolic
6261 * digging, for example in OS X (2) by having the details we fully
6262 * control the output, which in turn is useful when more platforms
6263 * are added: we can keep out output "portable". */
6265 /* We want a single linear allocation, which can then be freed
6266 * with a single swoop. We will do the usual trick of first
6267 * walking over the structure and seeing how much we need to
6268 * allocate, then allocating, and then walking over the structure
6269 * the second time and populating it. */
6271 /* First we must compute the total size of the buffer. */
6272 total_bytes = sizeof(Perl_c_backtrace_header);
6273 if (got_depth > skip) {
6276 bfd_init(); /* Is this safe to call multiple times? */
6277 Zero(&bfd_ctx, 1, bfd_context);
6280 Zero(&atos_ctx, 1, atos_context);
6282 for (i = skip; i < try_depth; i++) {
6283 Dl_info* dl_info = &dl_infos[i];
6285 object_name_sizes[i] = 0;
6286 source_names[i] = NULL;
6287 source_name_sizes[i] = 0;
6288 source_lines[i] = 0;
6290 /* Yes, zero from dladdr() is failure. */
6291 if (dladdr(raw_frames[i], dl_info)) {
6292 total_bytes += sizeof(Perl_c_backtrace_frame);
6294 object_name_sizes[i] =
6295 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6296 symbol_name_sizes[i] =
6297 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6299 bfd_update(&bfd_ctx, dl_info);
6300 bfd_symbolize(&bfd_ctx, raw_frames[i],
6302 &symbol_name_sizes[i],
6304 &source_name_sizes[i],
6308 atos_update(&atos_ctx, dl_info);
6309 atos_symbolize(&atos_ctx,
6312 &source_name_sizes[i],
6316 /* Plus ones for the terminating \0. */
6317 total_bytes += object_name_sizes[i] + 1;
6318 total_bytes += symbol_name_sizes[i] + 1;
6319 total_bytes += source_name_sizes[i] + 1;
6327 Safefree(bfd_ctx.bfd_syms);
6331 /* Now we can allocate and populate the result buffer. */
6332 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6333 Zero(bt, total_bytes, char);
6334 bt->header.frame_count = frame_count;
6335 bt->header.total_bytes = total_bytes;
6336 if (frame_count > 0) {
6337 Perl_c_backtrace_frame* frame = bt->frame_info;
6338 char* name_base = (char *)(frame + frame_count);
6339 char* name_curr = name_base; /* Outputting the name strings here. */
6341 for (i = skip; i < skip + frame_count; i++) {
6342 Dl_info* dl_info = &dl_infos[i];
6344 frame->addr = raw_frames[i];
6345 frame->object_base_addr = dl_info->dli_fbase;
6346 frame->symbol_addr = dl_info->dli_saddr;
6348 /* Copies a string, including the \0, and advances the name_curr.
6349 * Also copies the start and the size to the frame. */
6350 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6352 Copy(src, name_curr, size, char); \
6353 frame->doffset = name_curr - (char*)bt; \
6354 frame->dsize = size; \
6355 name_curr += size; \
6358 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6360 object_name_size, object_name_sizes[i]);
6363 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6365 symbol_name_size, symbol_name_sizes[i]);
6366 Safefree(symbol_names[i]);
6368 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6370 symbol_name_size, symbol_name_sizes[i]);
6373 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6375 source_name_size, source_name_sizes[i]);
6376 Safefree(source_names[i]);
6378 #undef PERL_C_BACKTRACE_STRCPY
6380 frame->source_line_number = source_lines[i];
6384 assert(total_bytes ==
6385 (UV)(sizeof(Perl_c_backtrace_header) +
6386 frame_count * sizeof(Perl_c_backtrace_frame) +
6387 name_curr - name_base));
6390 Safefree(symbol_names);
6392 bfd_close(bfd_ctx.abfd);
6395 Safefree(source_lines);
6396 Safefree(source_name_sizes);
6397 Safefree(source_names);
6398 Safefree(symbol_name_sizes);
6399 Safefree(object_name_sizes);
6400 /* Assuming the strings returned by dladdr() are pointers
6401 * to read-only static memory (the object file), so that
6402 * they do not need freeing (and cannot be). */
6404 Safefree(raw_frames);
6407 PERL_UNUSED_ARGV(depth);
6408 PERL_UNUSED_ARGV(skip);
6414 =for apidoc free_c_backtrace
6416 Deallocates a backtrace received from get_c_bracktrace.
6422 =for apidoc get_c_backtrace_dump
6424 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6425 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6427 The appended output looks like:
6430 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6431 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6434 The fields are tab-separated. The first column is the depth (zero
6435 being the innermost non-skipped frame). In the hex:offset, the hex is
6436 where the program counter was in C<S_parse_body>, and the :offset (might
6437 be missing) tells how much inside the C<S_parse_body> the program counter was.
6439 The C<util.c:1716> is the source code file and line number.
6441 The F</usr/bin/perl> is obvious (hopefully).
6443 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6444 if the platform doesn't support retrieving the information;
6445 if the binary is missing the debug information;
6446 if the optimizer has transformed the code by for example inlining.
6452 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6454 Perl_c_backtrace* bt;
6456 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6458 Perl_c_backtrace_frame* frame;
6459 SV* dsv = newSVpvs("");
6461 for (i = 0, frame = bt->frame_info;
6462 i < bt->header.frame_count; i++, frame++) {
6463 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6464 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6465 /* Symbol (function) names might disappear without debug info.
6467 * The source code location might disappear in case of the
6468 * optimizer inlining or otherwise rearranging the code. */
6469 if (frame->symbol_addr) {
6470 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6472 ((char*)frame->addr - (char*)frame->symbol_addr));
6474 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6475 frame->symbol_name_size &&
6476 frame->symbol_name_offset ?
6477 (char*)bt + frame->symbol_name_offset : "-");
6478 if (frame->source_name_size &&
6479 frame->source_name_offset &&
6480 frame->source_line_number) {
6481 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6482 (char*)bt + frame->source_name_offset,
6483 (UV)frame->source_line_number);
6485 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6487 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6488 frame->object_name_size &&
6489 frame->object_name_offset ?
6490 (char*)bt + frame->object_name_offset : "-");
6491 /* The frame->object_base_addr is not output,
6492 * but it is used for symbolizing/symbolicating. */
6493 sv_catpvs(dsv, "\n");
6496 Perl_free_c_backtrace(bt);
6505 =for apidoc dump_c_backtrace
6507 Dumps the C backtrace to the given C<fp>.
6509 Returns true if a backtrace could be retrieved, false if not.
6515 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6519 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6521 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6524 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6530 #endif /* #ifdef USE_C_BACKTRACE */
6532 #ifdef PERL_TSA_ACTIVE
6534 /* pthread_mutex_t and perl_mutex are typedef equivalent
6535 * so casting the pointers is fine. */
6537 int perl_tsa_mutex_lock(perl_mutex* mutex)
6539 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6542 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6544 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6547 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6549 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6557 /* log a sub call or return */
6560 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6568 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6571 HEK *hek = CvNAME_HEK(cv);
6572 func = HEK_KEY(hek);
6578 start = (const COP *)CvSTART(cv);
6579 file = CopFILE(start);
6580 line = CopLINE(start);
6581 stash = CopSTASHPV(start);
6584 PERL_SUB_ENTRY(func, file, line, stash);
6587 PERL_SUB_RETURN(func, file, line, stash);
6592 /* log a require file loading/loaded */
6595 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6597 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6600 PERL_LOADING_FILE(name);
6603 PERL_LOADED_FILE(name);
6608 /* log an op execution */
6611 Perl_dtrace_probe_op(pTHX_ const OP *op)
6613 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6615 PERL_OP_ENTRY(OP_NAME(op));
6619 /* log a compile/run phase change */
6622 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6624 const char *ph_old = PL_phase_names[PL_phase];
6625 const char *ph_new = PL_phase_names[phase];
6627 PERL_PHASE_CHANGE(ph_new, ph_old);
6633 * ex: set ts=8 sts=4 sw=4 et: