3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * 'Very useful, no doubt, that was to Saruman; yet it seems that he was
13 * not content.' --Gandalf to Pippin
15 * [p.598 of _The Lord of the Rings_, III/xi: "The PalantÃr"]
18 /* This file contains assorted utility routines.
19 * Which is a polite way of saying any stuff that people couldn't think of
20 * a better place for. Amongst other things, it includes the warning and
21 * dieing stuff, plus wrappers for malloc code.
25 #define PERL_IN_UTIL_C
29 #if defined(USE_PERLIO)
30 #include "perliol.h" /* For PerlIOUnix_refcnt */
36 # define SIG_ERR ((Sighandler_t) -1)
44 /* Missing protos on LynxOS */
49 # include "amigaos4/amigaio.h"
54 # include <sys/select.h>
58 #ifdef USE_C_BACKTRACE
62 # undef USE_BFD /* BFD is useless in OS X. */
72 # include <execinfo.h>
76 #ifdef PERL_DEBUG_READONLY_COW
77 # include <sys/mman.h>
82 /* NOTE: Do not call the next three routines directly. Use the macros
83 * in handy.h, so that we can easily redefine everything to do tracking of
84 * allocated hunks back to the original New to track down any memory leaks.
85 * XXX This advice seems to be widely ignored :-( --AD August 1996.
88 #if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
89 # define ALWAYS_NEED_THX
92 #if defined(PERL_TRACK_MEMPOOL) && defined(PERL_DEBUG_READONLY_COW)
94 S_maybe_protect_rw(pTHX_ struct perl_memory_debug_header *header)
97 && mprotect(header, header->size, PROT_READ|PROT_WRITE))
98 Perl_warn(aTHX_ "mprotect for COW string %p %lu failed with %d",
99 header, header->size, errno);
103 S_maybe_protect_ro(pTHX_ struct perl_memory_debug_header *header)
106 && mprotect(header, header->size, PROT_READ))
107 Perl_warn(aTHX_ "mprotect RW for COW string %p %lu failed with %d",
108 header, header->size, errno);
110 # define maybe_protect_rw(foo) S_maybe_protect_rw(aTHX_ foo)
111 # define maybe_protect_ro(foo) S_maybe_protect_ro(aTHX_ foo)
113 # define maybe_protect_rw(foo) NOOP
114 # define maybe_protect_ro(foo) NOOP
117 #if defined(PERL_TRACK_MEMPOOL) || defined(PERL_DEBUG_READONLY_COW)
118 /* Use memory_debug_header */
120 # if (defined(PERL_POISON) && defined(PERL_TRACK_MEMPOOL)) \
121 || defined(PERL_DEBUG_READONLY_COW)
122 # define MDH_HAS_SIZE
126 /* paranoid version of system's malloc() */
129 Perl_safesysmalloc(MEM_SIZE size)
131 #ifdef ALWAYS_NEED_THX
137 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
139 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
142 if ((SSize_t)size < 0)
143 Perl_croak_nocontext("panic: malloc, size=%" UVuf, (UV) size);
145 if (!size) size = 1; /* malloc(0) is NASTY on our system */
146 #ifdef PERL_DEBUG_READONLY_COW
147 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
148 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
149 perror("mmap failed");
153 ptr = (Malloc_t)PerlMem_malloc(size?size:1);
155 PERL_ALLOC_CHECK(ptr);
158 struct perl_memory_debug_header *const header
159 = (struct perl_memory_debug_header *)ptr;
163 PoisonNew(((char *)ptr), size, char);
166 #ifdef PERL_TRACK_MEMPOOL
167 header->interpreter = aTHX;
168 /* Link us into the list. */
169 header->prev = &PL_memory_debug_header;
170 header->next = PL_memory_debug_header.next;
171 PL_memory_debug_header.next = header;
172 maybe_protect_rw(header->next);
173 header->next->prev = header;
174 maybe_protect_ro(header->next);
175 # ifdef PERL_DEBUG_READONLY_COW
176 header->readonly = 0;
182 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
183 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
191 #ifndef ALWAYS_NEED_THX
203 /* paranoid version of system's realloc() */
206 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
208 #ifdef ALWAYS_NEED_THX
212 #ifdef PERL_DEBUG_READONLY_COW
213 const MEM_SIZE oldsize = where
214 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
223 ptr = safesysmalloc(size);
227 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
228 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
230 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
232 struct perl_memory_debug_header *const header
233 = (struct perl_memory_debug_header *)where;
235 # ifdef PERL_TRACK_MEMPOOL
236 if (header->interpreter != aTHX) {
237 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
238 header->interpreter, aTHX);
240 assert(header->next->prev == header);
241 assert(header->prev->next == header);
243 if (header->size > size) {
244 const MEM_SIZE freed_up = header->size - size;
245 char *start_of_freed = ((char *)where) + size;
246 PoisonFree(start_of_freed, freed_up, char);
256 if ((SSize_t)size < 0)
257 Perl_croak_nocontext("panic: realloc, size=%" UVuf, (UV)size);
259 #ifdef PERL_DEBUG_READONLY_COW
260 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
261 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
262 perror("mmap failed");
265 Copy(where,ptr,oldsize < size ? oldsize : size,char);
266 if (munmap(where, oldsize)) {
267 perror("munmap failed");
271 ptr = (Malloc_t)PerlMem_realloc(where,size);
273 PERL_ALLOC_CHECK(ptr);
275 /* MUST do this fixup first, before doing ANYTHING else, as anything else
276 might allocate memory/free/move memory, and until we do the fixup, it
277 may well be chasing (and writing to) free memory. */
279 #ifdef PERL_TRACK_MEMPOOL
280 struct perl_memory_debug_header *const header
281 = (struct perl_memory_debug_header *)ptr;
284 if (header->size < size) {
285 const MEM_SIZE fresh = size - header->size;
286 char *start_of_fresh = ((char *)ptr) + size;
287 PoisonNew(start_of_fresh, fresh, char);
291 maybe_protect_rw(header->next);
292 header->next->prev = header;
293 maybe_protect_ro(header->next);
294 maybe_protect_rw(header->prev);
295 header->prev->next = header;
296 maybe_protect_ro(header->prev);
298 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
301 /* In particular, must do that fixup above before logging anything via
302 *printf(), as it can reallocate memory, which can cause SEGVs. */
304 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
305 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
312 #ifndef ALWAYS_NEED_THX
325 /* safe version of system's free() */
328 Perl_safesysfree(Malloc_t where)
330 #ifdef ALWAYS_NEED_THX
333 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
336 Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
338 struct perl_memory_debug_header *const header
339 = (struct perl_memory_debug_header *)where_intrn;
342 const MEM_SIZE size = header->size;
344 # ifdef PERL_TRACK_MEMPOOL
345 if (header->interpreter != aTHX) {
346 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
347 header->interpreter, aTHX);
350 Perl_croak_nocontext("panic: duplicate free");
353 Perl_croak_nocontext("panic: bad free, header->next==NULL");
354 if (header->next->prev != header || header->prev->next != header) {
355 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
356 "header=%p, ->prev->next=%p",
357 header->next->prev, header,
360 /* Unlink us from the chain. */
361 maybe_protect_rw(header->next);
362 header->next->prev = header->prev;
363 maybe_protect_ro(header->next);
364 maybe_protect_rw(header->prev);
365 header->prev->next = header->next;
366 maybe_protect_ro(header->prev);
367 maybe_protect_rw(header);
369 PoisonNew(where_intrn, size, char);
371 /* Trigger the duplicate free warning. */
374 # ifdef PERL_DEBUG_READONLY_COW
375 if (munmap(where_intrn, size)) {
376 perror("munmap failed");
382 Malloc_t where_intrn = where;
384 #ifndef PERL_DEBUG_READONLY_COW
385 PerlMem_free(where_intrn);
390 /* safe version of system's calloc() */
393 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
395 #ifdef ALWAYS_NEED_THX
399 #if defined(USE_MDH) || defined(DEBUGGING)
400 MEM_SIZE total_size = 0;
403 /* Even though calloc() for zero bytes is strange, be robust. */
404 if (size && (count <= MEM_SIZE_MAX / size)) {
405 #if defined(USE_MDH) || defined(DEBUGGING)
406 total_size = size * count;
412 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
413 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
418 if ((SSize_t)size < 0 || (SSize_t)count < 0)
419 Perl_croak_nocontext("panic: calloc, size=%" UVuf ", count=%" UVuf,
420 (UV)size, (UV)count);
422 #ifdef PERL_DEBUG_READONLY_COW
423 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
424 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
425 perror("mmap failed");
428 #elif defined(PERL_TRACK_MEMPOOL)
429 /* Have to use malloc() because we've added some space for our tracking
431 /* malloc(0) is non-portable. */
432 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
434 /* Use calloc() because it might save a memset() if the memory is fresh
435 and clean from the OS. */
437 ptr = (Malloc_t)PerlMem_calloc(count, size);
438 else /* calloc(0) is non-portable. */
439 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
441 PERL_ALLOC_CHECK(ptr);
442 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) calloc %ld x %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)count,(long)total_size));
446 struct perl_memory_debug_header *const header
447 = (struct perl_memory_debug_header *)ptr;
449 # ifndef PERL_DEBUG_READONLY_COW
450 memset((void*)ptr, 0, total_size);
452 # ifdef PERL_TRACK_MEMPOOL
453 header->interpreter = aTHX;
454 /* Link us into the list. */
455 header->prev = &PL_memory_debug_header;
456 header->next = PL_memory_debug_header.next;
457 PL_memory_debug_header.next = header;
458 maybe_protect_rw(header->next);
459 header->next->prev = header;
460 maybe_protect_ro(header->next);
461 # ifdef PERL_DEBUG_READONLY_COW
462 header->readonly = 0;
466 header->size = total_size;
468 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
474 #ifndef ALWAYS_NEED_THX
483 /* These must be defined when not using Perl's malloc for binary
488 Malloc_t Perl_malloc (MEM_SIZE nbytes)
490 #ifdef PERL_IMPLICIT_SYS
493 return (Malloc_t)PerlMem_malloc(nbytes);
496 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
498 #ifdef PERL_IMPLICIT_SYS
501 return (Malloc_t)PerlMem_calloc(elements, size);
504 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
506 #ifdef PERL_IMPLICIT_SYS
509 return (Malloc_t)PerlMem_realloc(where, nbytes);
512 Free_t Perl_mfree (Malloc_t where)
514 #ifdef PERL_IMPLICIT_SYS
522 /* copy a string up to some (non-backslashed) delimiter, if any.
523 * With allow_escape, converts \<delimiter> to <delimiter>, while leaves
524 * \<non-delimiter> as-is.
525 * Returns the position in the src string of the closing delimiter, if
526 * any, or returns fromend otherwise.
527 * This is the internal implementation for Perl_delimcpy and
528 * Perl_delimcpy_no_escape.
532 S_delimcpy_intern(char *to, const char *toend, const char *from,
533 const char *fromend, int delim, I32 *retlen,
534 const bool allow_escape)
538 PERL_ARGS_ASSERT_DELIMCPY;
540 for (tolen = 0; from < fromend; from++, tolen++) {
541 if (allow_escape && *from == '\\' && from + 1 < fromend) {
542 if (from[1] != delim) {
549 else if (*from == delim)
561 Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
563 PERL_ARGS_ASSERT_DELIMCPY;
565 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 1);
569 Perl_delimcpy_no_escape(char *to, const char *toend, const char *from,
570 const char *fromend, int delim, I32 *retlen)
572 PERL_ARGS_ASSERT_DELIMCPY_NO_ESCAPE;
574 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 0);
578 =head1 Miscellaneous Functions
580 =for apidoc Am|char *|ninstr|char * big|char * bigend|char * little|char * little_end
582 Find the first (leftmost) occurrence of a sequence of bytes within another
583 sequence. This is the Perl version of C<strstr()>, extended to handle
584 arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
585 is what the initial C<n> in the function name stands for; some systems have an
586 equivalent, C<memmem()>, but with a somewhat different API).
588 Another way of thinking about this function is finding a needle in a haystack.
589 C<big> points to the first byte in the haystack. C<big_end> points to one byte
590 beyond the final byte in the haystack. C<little> points to the first byte in
591 the needle. C<little_end> points to one byte beyond the final byte in the
592 needle. All the parameters must be non-C<NULL>.
594 The function returns C<NULL> if there is no occurrence of C<little> within
595 C<big>. If C<little> is the empty string, C<big> is returned.
597 Because this function operates at the byte level, and because of the inherent
598 characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
599 needle and the haystack are strings with the same UTF-8ness, but not if the
607 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
609 PERL_ARGS_ASSERT_NINSTR;
612 return ninstr(big, bigend, little, lend);
618 const char first = *little;
619 bigend -= lend - little++;
621 while (big <= bigend) {
622 if (*big++ == first) {
624 for (x=big,s=little; s < lend; x++,s++) {
628 return (char*)(big-1);
639 =head1 Miscellaneous Functions
641 =for apidoc Am|char *|rninstr|char * big|char * bigend|char * little|char * little_end
643 Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
644 sequence of bytes within another sequence, returning C<NULL> if there is no
652 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
655 const I32 first = *little;
656 const char * const littleend = lend;
658 PERL_ARGS_ASSERT_RNINSTR;
660 if (little >= littleend)
661 return (char*)bigend;
663 big = bigend - (littleend - little++);
664 while (big >= bigbeg) {
668 for (x=big+2,s=little; s < littleend; /**/ ) {
677 return (char*)(big+1);
682 /* As a space optimization, we do not compile tables for strings of length
683 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
684 special-cased in fbm_instr().
686 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
689 =head1 Miscellaneous Functions
691 =for apidoc fbm_compile
693 Analyses the string in order to make fast searches on it using C<fbm_instr()>
694 -- the Boyer-Moore algorithm.
700 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
707 PERL_DEB( STRLEN rarest = 0 );
709 PERL_ARGS_ASSERT_FBM_COMPILE;
711 if (isGV_with_GP(sv) || SvROK(sv))
717 if (flags & FBMcf_TAIL) {
718 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
719 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
720 if (mg && mg->mg_len >= 0)
723 if (!SvPOK(sv) || SvNIOKp(sv))
724 s = (U8*)SvPV_force_mutable(sv, len);
725 else s = (U8 *)SvPV_mutable(sv, len);
726 if (len == 0) /* TAIL might be on a zero-length string. */
728 SvUPGRADE(sv, SVt_PVMG);
732 /* add PERL_MAGIC_bm magic holding the FBM lookup table */
734 assert(!mg_find(sv, PERL_MAGIC_bm));
735 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
739 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
741 const U8 mlen = (len>255) ? 255 : (U8)len;
742 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
745 Newx(table, 256, U8);
746 memset((void*)table, mlen, 256);
747 mg->mg_ptr = (char *)table;
750 s += len - 1; /* last char */
753 if (table[*s] == mlen)
759 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
760 for (i = 0; i < len; i++) {
761 if (PL_freq[s[i]] < frequency) {
762 PERL_DEB( rarest = i );
763 frequency = PL_freq[s[i]];
766 BmUSEFUL(sv) = 100; /* Initial value */
767 ((XPVNV*)SvANY(sv))->xnv_u.xnv_bm_tail = cBOOL(flags & FBMcf_TAIL);
768 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %" UVuf "\n",
769 s[rarest], (UV)rarest));
774 =for apidoc fbm_instr
776 Returns the location of the SV in the string delimited by C<big> and
777 C<bigend> (C<bigend>) is the char following the last char).
778 It returns C<NULL> if the string can't be found. The C<sv>
779 does not have to be C<fbm_compiled>, but the search will not be as fast
784 If SvTAIL(littlestr) is true, a fake "\n" was appended to to the string
785 during FBM compilation due to FBMcf_TAIL in flags. It indicates that
786 the littlestr must be anchored to the end of bigstr (or to any \n if
789 E.g. The regex compiler would compile /abc/ to a littlestr of "abc",
790 while /abc$/ compiles to "abc\n" with SvTAIL() true.
792 A littlestr of "abc", !SvTAIL matches as /abc/;
793 a littlestr of "ab\n", SvTAIL matches as:
794 without FBMrf_MULTILINE: /ab\n?\z/
795 with FBMrf_MULTILINE: /ab\n/ || /ab\z/;
797 (According to Ilya from 1999; I don't know if this is still true, DAPM 2015):
798 "If SvTAIL is actually due to \Z or \z, this gives false positives
804 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
808 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
809 STRLEN littlelen = l;
810 const I32 multiline = flags & FBMrf_MULTILINE;
811 bool valid = SvVALID(littlestr);
812 bool tail = valid ? cBOOL(SvTAIL(littlestr)) : FALSE;
814 PERL_ARGS_ASSERT_FBM_INSTR;
816 assert(bigend >= big);
818 if ((STRLEN)(bigend - big) < littlelen) {
820 && ((STRLEN)(bigend - big) == littlelen - 1)
822 || (*big == *little &&
823 memEQ((char *)big, (char *)little, littlelen - 1))))
828 switch (littlelen) { /* Special cases for 0, 1 and 2 */
830 return (char*)big; /* Cannot be SvTAIL! */
833 if (tail && !multiline) /* Anchor only! */
834 /* [-1] is safe because we know that bigend != big. */
835 return (char *) (bigend - (bigend[-1] == '\n'));
837 s = (unsigned char *)memchr((void*)big, *little, bigend-big);
841 return (char *) bigend;
845 if (tail && !multiline) {
846 /* a littlestr with SvTAIL must be of the form "X\n" (where X
847 * is a single char). It is anchored, and can only match
848 * "....X\n" or "....X" */
849 if (bigend[-2] == *little && bigend[-1] == '\n')
850 return (char*)bigend - 2;
851 if (bigend[-1] == *little)
852 return (char*)bigend - 1;
857 /* memchr() is likely to be very fast, possibly using whatever
858 * hardware support is available, such as checking a whole
859 * cache line in one instruction.
860 * So for a 2 char pattern, calling memchr() is likely to be
861 * faster than running FBM, or rolling our own. The previous
862 * version of this code was roll-your-own which typically
863 * only needed to read every 2nd char, which was good back in
864 * the day, but no longer.
866 unsigned char c1 = little[0];
867 unsigned char c2 = little[1];
869 /* *** for all this case, bigend points to the last char,
870 * not the trailing \0: this makes the conditions slightly
876 /* do a quick test for c1 before calling memchr();
877 * this avoids the expensive fn call overhead when
878 * there are lots of c1's */
879 if (LIKELY(*s != c1)) {
881 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
888 /* failed; try searching for c2 this time; that way
889 * we don't go pathologically slow when the string
890 * consists mostly of c1's or vice versa.
895 s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
903 /* c1, c2 the same */
913 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
914 if (!s || s >= bigend)
921 /* failed to find 2 chars; try anchored match at end without
923 if (tail && bigend[0] == little[0])
924 return (char *)bigend;
929 break; /* Only lengths 0 1 and 2 have special-case code. */
932 if (tail && !multiline) { /* tail anchored? */
933 s = bigend - littlelen;
934 if (s >= big && bigend[-1] == '\n' && *s == *little
935 /* Automatically of length > 2 */
936 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
938 return (char*)s; /* how sweet it is */
941 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
943 return (char*)s + 1; /* how sweet it is */
949 /* not compiled; use Perl_ninstr() instead */
950 char * const b = ninstr((char*)big,(char*)bigend,
951 (char*)little, (char*)little + littlelen);
953 assert(!tail); /* valid => FBM; tail only set on SvVALID SVs */
958 if (littlelen > (STRLEN)(bigend - big))
962 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
963 const unsigned char *oldlittle;
967 --littlelen; /* Last char found by table lookup */
970 little += littlelen; /* last char */
973 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
974 const unsigned char lastc = *little;
978 if ((tmp = table[*s])) {
979 /* *s != lastc; earliest position it could match now is
980 * tmp slots further on */
981 if ((s += tmp) >= bigend)
983 if (LIKELY(*s != lastc)) {
985 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
995 /* hand-rolled strncmp(): less expensive than calling the
996 * real function (maybe???) */
998 unsigned char * const olds = s;
1003 if (*--s == *--little)
1005 s = olds + 1; /* here we pay the price for failure */
1007 if (s < bigend) /* fake up continue to outer loop */
1017 && memEQ((char *)(bigend - littlelen),
1018 (char *)(oldlittle - littlelen), littlelen) )
1019 return (char*)bigend - littlelen;
1024 /* copy a string to a safe spot */
1027 =head1 Memory Management
1031 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1032 string which is a duplicate of C<pv>. The size of the string is
1033 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1034 characters and must have a trailing C<NUL>. The memory allocated for the new
1035 string can be freed with the C<Safefree()> function.
1037 On some platforms, Windows for example, all allocated memory owned by a thread
1038 is deallocated when that thread ends. So if you need that not to happen, you
1039 need to use the shared memory functions, such as C<L</savesharedpv>>.
1045 Perl_savepv(pTHX_ const char *pv)
1047 PERL_UNUSED_CONTEXT;
1052 const STRLEN pvlen = strlen(pv)+1;
1053 Newx(newaddr, pvlen, char);
1054 return (char*)memcpy(newaddr, pv, pvlen);
1058 /* same thing but with a known length */
1063 Perl's version of what C<strndup()> would be if it existed. Returns a
1064 pointer to a newly allocated string which is a duplicate of the first
1065 C<len> bytes from C<pv>, plus a trailing
1066 C<NUL> byte. The memory allocated for
1067 the new string can be freed with the C<Safefree()> function.
1069 On some platforms, Windows for example, all allocated memory owned by a thread
1070 is deallocated when that thread ends. So if you need that not to happen, you
1071 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1077 Perl_savepvn(pTHX_ const char *pv, I32 len)
1080 PERL_UNUSED_CONTEXT;
1084 Newx(newaddr,len+1,char);
1085 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1087 /* might not be null terminated */
1088 newaddr[len] = '\0';
1089 return (char *) CopyD(pv,newaddr,len,char);
1092 return (char *) ZeroD(newaddr,len+1,char);
1097 =for apidoc savesharedpv
1099 A version of C<savepv()> which allocates the duplicate string in memory
1100 which is shared between threads.
1105 Perl_savesharedpv(pTHX_ const char *pv)
1110 PERL_UNUSED_CONTEXT;
1115 pvlen = strlen(pv)+1;
1116 newaddr = (char*)PerlMemShared_malloc(pvlen);
1120 return (char*)memcpy(newaddr, pv, pvlen);
1124 =for apidoc savesharedpvn
1126 A version of C<savepvn()> which allocates the duplicate string in memory
1127 which is shared between threads. (With the specific difference that a C<NULL>
1128 pointer is not acceptable)
1133 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1135 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1137 PERL_UNUSED_CONTEXT;
1138 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1143 newaddr[len] = '\0';
1144 return (char*)memcpy(newaddr, pv, len);
1148 =for apidoc savesvpv
1150 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1151 the passed in SV using C<SvPV()>
1153 On some platforms, Windows for example, all allocated memory owned by a thread
1154 is deallocated when that thread ends. So if you need that not to happen, you
1155 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1161 Perl_savesvpv(pTHX_ SV *sv)
1164 const char * const pv = SvPV_const(sv, len);
1167 PERL_ARGS_ASSERT_SAVESVPV;
1170 Newx(newaddr,len,char);
1171 return (char *) CopyD(pv,newaddr,len,char);
1175 =for apidoc savesharedsvpv
1177 A version of C<savesharedpv()> which allocates the duplicate string in
1178 memory which is shared between threads.
1184 Perl_savesharedsvpv(pTHX_ SV *sv)
1187 const char * const pv = SvPV_const(sv, len);
1189 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1191 return savesharedpvn(pv, len);
1194 /* the SV for Perl_form() and mess() is not kept in an arena */
1202 if (PL_phase != PERL_PHASE_DESTRUCT)
1203 return newSVpvs_flags("", SVs_TEMP);
1208 /* Create as PVMG now, to avoid any upgrading later */
1210 Newxz(any, 1, XPVMG);
1211 SvFLAGS(sv) = SVt_PVMG;
1212 SvANY(sv) = (void*)any;
1214 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1219 #if defined(PERL_IMPLICIT_CONTEXT)
1221 Perl_form_nocontext(const char* pat, ...)
1226 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1227 va_start(args, pat);
1228 retval = vform(pat, &args);
1232 #endif /* PERL_IMPLICIT_CONTEXT */
1235 =head1 Miscellaneous Functions
1238 Takes a sprintf-style format pattern and conventional
1239 (non-SV) arguments and returns the formatted string.
1241 (char *) Perl_form(pTHX_ const char* pat, ...)
1243 can be used any place a string (char *) is required:
1245 char * s = Perl_form("%d.%d",major,minor);
1247 Uses a single private buffer so if you want to format several strings you
1248 must explicitly copy the earlier strings away (and free the copies when you
1255 Perl_form(pTHX_ const char* pat, ...)
1259 PERL_ARGS_ASSERT_FORM;
1260 va_start(args, pat);
1261 retval = vform(pat, &args);
1267 Perl_vform(pTHX_ const char *pat, va_list *args)
1269 SV * const sv = mess_alloc();
1270 PERL_ARGS_ASSERT_VFORM;
1271 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1276 =for apidoc Am|SV *|mess|const char *pat|...
1278 Take a sprintf-style format pattern and argument list. These are used to
1279 generate a string message. If the message does not end with a newline,
1280 then it will be extended with some indication of the current location
1281 in the code, as described for L</mess_sv>.
1283 Normally, the resulting message is returned in a new mortal SV.
1284 During global destruction a single SV may be shared between uses of
1290 #if defined(PERL_IMPLICIT_CONTEXT)
1292 Perl_mess_nocontext(const char *pat, ...)
1297 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1298 va_start(args, pat);
1299 retval = vmess(pat, &args);
1303 #endif /* PERL_IMPLICIT_CONTEXT */
1306 Perl_mess(pTHX_ const char *pat, ...)
1310 PERL_ARGS_ASSERT_MESS;
1311 va_start(args, pat);
1312 retval = vmess(pat, &args);
1318 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1321 /* Look for curop starting from o. cop is the last COP we've seen. */
1322 /* opnext means that curop is actually the ->op_next of the op we are
1325 PERL_ARGS_ASSERT_CLOSEST_COP;
1327 if (!o || !curop || (
1328 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1332 if (o->op_flags & OPf_KIDS) {
1334 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1337 /* If the OP_NEXTSTATE has been optimised away we can still use it
1338 * the get the file and line number. */
1340 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1341 cop = (const COP *)kid;
1343 /* Keep searching, and return when we've found something. */
1345 new_cop = closest_cop(cop, kid, curop, opnext);
1351 /* Nothing found. */
1357 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1359 Expands a message, intended for the user, to include an indication of
1360 the current location in the code, if the message does not already appear
1363 C<basemsg> is the initial message or object. If it is a reference, it
1364 will be used as-is and will be the result of this function. Otherwise it
1365 is used as a string, and if it already ends with a newline, it is taken
1366 to be complete, and the result of this function will be the same string.
1367 If the message does not end with a newline, then a segment such as C<at
1368 foo.pl line 37> will be appended, and possibly other clauses indicating
1369 the current state of execution. The resulting message will end with a
1372 Normally, the resulting message is returned in a new mortal SV.
1373 During global destruction a single SV may be shared between uses of this
1374 function. If C<consume> is true, then the function is permitted (but not
1375 required) to modify and return C<basemsg> instead of allocating a new SV.
1381 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1385 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1389 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1390 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1391 && grok_atoUV(ws, &wi, NULL)
1392 && wi <= PERL_INT_MAX
1394 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1399 PERL_ARGS_ASSERT_MESS_SV;
1401 if (SvROK(basemsg)) {
1407 sv_setsv(sv, basemsg);
1412 if (SvPOK(basemsg) && consume) {
1417 sv_copypv(sv, basemsg);
1420 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1422 * Try and find the file and line for PL_op. This will usually be
1423 * PL_curcop, but it might be a cop that has been optimised away. We
1424 * can try to find such a cop by searching through the optree starting
1425 * from the sibling of PL_curcop.
1430 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1435 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1436 OutCopFILE(cop), (IV)CopLINE(cop));
1439 /* Seems that GvIO() can be untrustworthy during global destruction. */
1440 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1441 && IoLINES(GvIOp(PL_last_in_gv)))
1444 const bool line_mode = (RsSIMPLE(PL_rs) &&
1445 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1446 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1447 SVfARG(PL_last_in_gv == PL_argvgv
1449 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1450 line_mode ? "line" : "chunk",
1451 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1453 if (PL_phase == PERL_PHASE_DESTRUCT)
1454 sv_catpvs(sv, " during global destruction");
1455 sv_catpvs(sv, ".\n");
1461 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1463 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1464 argument list, respectively. These are used to generate a string message. If
1466 message does not end with a newline, then it will be extended with
1467 some indication of the current location in the code, as described for
1470 Normally, the resulting message is returned in a new mortal SV.
1471 During global destruction a single SV may be shared between uses of
1478 Perl_vmess(pTHX_ const char *pat, va_list *args)
1480 SV * const sv = mess_alloc();
1482 PERL_ARGS_ASSERT_VMESS;
1484 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1485 return mess_sv(sv, 1);
1489 Perl_write_to_stderr(pTHX_ SV* msv)
1494 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1496 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1497 && (io = GvIO(PL_stderrgv))
1498 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1499 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1500 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1502 PerlIO * const serr = Perl_error_log;
1504 do_print(msv, serr);
1505 (void)PerlIO_flush(serr);
1510 =head1 Warning and Dieing
1513 /* Common code used in dieing and warning */
1516 S_with_queued_errors(pTHX_ SV *ex)
1518 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1519 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1520 sv_catsv(PL_errors, ex);
1521 ex = sv_mortalcopy(PL_errors);
1522 SvCUR_set(PL_errors, 0);
1528 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1533 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1534 /* sv_2cv might call Perl_croak() or Perl_warner() */
1535 SV * const oldhook = *hook;
1543 cv = sv_2cv(oldhook, &stash, &gv, 0);
1545 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1555 exarg = newSVsv(ex);
1556 SvREADONLY_on(exarg);
1559 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1563 call_sv(MUTABLE_SV(cv), G_DISCARD);
1572 =for apidoc Am|OP *|die_sv|SV *baseex
1574 Behaves the same as L</croak_sv>, except for the return type.
1575 It should be used only where the C<OP *> return type is required.
1576 The function never actually returns.
1582 # pragma warning( push )
1583 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1584 __declspec(noreturn) has non-void return type */
1585 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1586 __declspec(noreturn) has a return statement */
1589 Perl_die_sv(pTHX_ SV *baseex)
1591 PERL_ARGS_ASSERT_DIE_SV;
1594 NORETURN_FUNCTION_END;
1597 # pragma warning( pop )
1601 =for apidoc Am|OP *|die|const char *pat|...
1603 Behaves the same as L</croak>, except for the return type.
1604 It should be used only where the C<OP *> return type is required.
1605 The function never actually returns.
1610 #if defined(PERL_IMPLICIT_CONTEXT)
1612 # pragma warning( push )
1613 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1614 __declspec(noreturn) has non-void return type */
1615 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1616 __declspec(noreturn) has a return statement */
1619 Perl_die_nocontext(const char* pat, ...)
1623 va_start(args, pat);
1625 NOT_REACHED; /* NOTREACHED */
1627 NORETURN_FUNCTION_END;
1630 # pragma warning( pop )
1632 #endif /* PERL_IMPLICIT_CONTEXT */
1635 # pragma warning( push )
1636 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1637 __declspec(noreturn) has non-void return type */
1638 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1639 __declspec(noreturn) has a return statement */
1642 Perl_die(pTHX_ const char* pat, ...)
1645 va_start(args, pat);
1647 NOT_REACHED; /* NOTREACHED */
1649 NORETURN_FUNCTION_END;
1652 # pragma warning( pop )
1656 =for apidoc Am|void|croak_sv|SV *baseex
1658 This is an XS interface to Perl's C<die> function.
1660 C<baseex> is the error message or object. If it is a reference, it
1661 will be used as-is. Otherwise it is used as a string, and if it does
1662 not end with a newline then it will be extended with some indication of
1663 the current location in the code, as described for L</mess_sv>.
1665 The error message or object will be used as an exception, by default
1666 returning control to the nearest enclosing C<eval>, but subject to
1667 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1668 function never returns normally.
1670 To die with a simple string message, the L</croak> function may be
1677 Perl_croak_sv(pTHX_ SV *baseex)
1679 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1680 PERL_ARGS_ASSERT_CROAK_SV;
1681 invoke_exception_hook(ex, FALSE);
1686 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1688 This is an XS interface to Perl's C<die> function.
1690 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1691 argument list. These are used to generate a string message. If the
1692 message does not end with a newline, then it will be extended with
1693 some indication of the current location in the code, as described for
1696 The error message will be used as an exception, by default
1697 returning control to the nearest enclosing C<eval>, but subject to
1698 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1699 function never returns normally.
1701 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1702 (C<$@>) will be used as an error message or object instead of building an
1703 error message from arguments. If you want to throw a non-string object,
1704 or build an error message in an SV yourself, it is preferable to use
1705 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1711 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1713 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1714 invoke_exception_hook(ex, FALSE);
1719 =for apidoc Am|void|croak|const char *pat|...
1721 This is an XS interface to Perl's C<die> function.
1723 Take a sprintf-style format pattern and argument list. These are used to
1724 generate a string message. If the message does not end with a newline,
1725 then it will be extended with some indication of the current location
1726 in the code, as described for L</mess_sv>.
1728 The error message will be used as an exception, by default
1729 returning control to the nearest enclosing C<eval>, but subject to
1730 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1731 function never returns normally.
1733 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1734 (C<$@>) will be used as an error message or object instead of building an
1735 error message from arguments. If you want to throw a non-string object,
1736 or build an error message in an SV yourself, it is preferable to use
1737 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1742 #if defined(PERL_IMPLICIT_CONTEXT)
1744 Perl_croak_nocontext(const char *pat, ...)
1748 va_start(args, pat);
1750 NOT_REACHED; /* NOTREACHED */
1753 #endif /* PERL_IMPLICIT_CONTEXT */
1756 Perl_croak(pTHX_ const char *pat, ...)
1759 va_start(args, pat);
1761 NOT_REACHED; /* NOTREACHED */
1766 =for apidoc Am|void|croak_no_modify
1768 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1769 terser object code than using C<Perl_croak>. Less code used on exception code
1770 paths reduces CPU cache pressure.
1776 Perl_croak_no_modify(void)
1778 Perl_croak_nocontext( "%s", PL_no_modify);
1781 /* does not return, used in util.c perlio.c and win32.c
1782 This is typically called when malloc returns NULL.
1785 Perl_croak_no_mem(void)
1789 int fd = PerlIO_fileno(Perl_error_log);
1791 SETERRNO(EBADF,RMS_IFI);
1793 /* Can't use PerlIO to write as it allocates memory */
1794 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1799 /* does not return, used only in POPSTACK */
1801 Perl_croak_popstack(void)
1804 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1809 =for apidoc Am|void|warn_sv|SV *baseex
1811 This is an XS interface to Perl's C<warn> function.
1813 C<baseex> is the error message or object. If it is a reference, it
1814 will be used as-is. Otherwise it is used as a string, and if it does
1815 not end with a newline then it will be extended with some indication of
1816 the current location in the code, as described for L</mess_sv>.
1818 The error message or object will by default be written to standard error,
1819 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1821 To warn with a simple string message, the L</warn> function may be
1828 Perl_warn_sv(pTHX_ SV *baseex)
1830 SV *ex = mess_sv(baseex, 0);
1831 PERL_ARGS_ASSERT_WARN_SV;
1832 if (!invoke_exception_hook(ex, TRUE))
1833 write_to_stderr(ex);
1837 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1839 This is an XS interface to Perl's C<warn> function.
1841 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1842 argument list. These are used to generate a string message. If the
1843 message does not end with a newline, then it will be extended with
1844 some indication of the current location in the code, as described for
1847 The error message or object will by default be written to standard error,
1848 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1850 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1856 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1858 SV *ex = vmess(pat, args);
1859 PERL_ARGS_ASSERT_VWARN;
1860 if (!invoke_exception_hook(ex, TRUE))
1861 write_to_stderr(ex);
1865 =for apidoc Am|void|warn|const char *pat|...
1867 This is an XS interface to Perl's C<warn> function.
1869 Take a sprintf-style format pattern and argument list. These are used to
1870 generate a string message. If the message does not end with a newline,
1871 then it will be extended with some indication of the current location
1872 in the code, as described for L</mess_sv>.
1874 The error message or object will by default be written to standard error,
1875 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1877 Unlike with L</croak>, C<pat> is not permitted to be null.
1882 #if defined(PERL_IMPLICIT_CONTEXT)
1884 Perl_warn_nocontext(const char *pat, ...)
1888 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1889 va_start(args, pat);
1893 #endif /* PERL_IMPLICIT_CONTEXT */
1896 Perl_warn(pTHX_ const char *pat, ...)
1899 PERL_ARGS_ASSERT_WARN;
1900 va_start(args, pat);
1905 #if defined(PERL_IMPLICIT_CONTEXT)
1907 Perl_warner_nocontext(U32 err, const char *pat, ...)
1911 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1912 va_start(args, pat);
1913 vwarner(err, pat, &args);
1916 #endif /* PERL_IMPLICIT_CONTEXT */
1919 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1921 PERL_ARGS_ASSERT_CK_WARNER_D;
1923 if (Perl_ckwarn_d(aTHX_ err)) {
1925 va_start(args, pat);
1926 vwarner(err, pat, &args);
1932 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1934 PERL_ARGS_ASSERT_CK_WARNER;
1936 if (Perl_ckwarn(aTHX_ err)) {
1938 va_start(args, pat);
1939 vwarner(err, pat, &args);
1945 Perl_warner(pTHX_ U32 err, const char* pat,...)
1948 PERL_ARGS_ASSERT_WARNER;
1949 va_start(args, pat);
1950 vwarner(err, pat, &args);
1955 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1958 PERL_ARGS_ASSERT_VWARNER;
1960 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
1961 !(PL_in_eval & EVAL_KEEPERR)
1963 SV * const msv = vmess(pat, args);
1965 if (PL_parser && PL_parser->error_count) {
1969 invoke_exception_hook(msv, FALSE);
1974 Perl_vwarn(aTHX_ pat, args);
1978 /* implements the ckWARN? macros */
1981 Perl_ckwarn(pTHX_ U32 w)
1983 /* If lexical warnings have not been set, use $^W. */
1985 return PL_dowarn & G_WARN_ON;
1987 return ckwarn_common(w);
1990 /* implements the ckWARN?_d macro */
1993 Perl_ckwarn_d(pTHX_ U32 w)
1995 /* If lexical warnings have not been set then default classes warn. */
1999 return ckwarn_common(w);
2003 S_ckwarn_common(pTHX_ U32 w)
2005 if (PL_curcop->cop_warnings == pWARN_ALL)
2008 if (PL_curcop->cop_warnings == pWARN_NONE)
2011 /* Check the assumption that at least the first slot is non-zero. */
2012 assert(unpackWARN1(w));
2014 /* Check the assumption that it is valid to stop as soon as a zero slot is
2016 if (!unpackWARN2(w)) {
2017 assert(!unpackWARN3(w));
2018 assert(!unpackWARN4(w));
2019 } else if (!unpackWARN3(w)) {
2020 assert(!unpackWARN4(w));
2023 /* Right, dealt with all the special cases, which are implemented as non-
2024 pointers, so there is a pointer to a real warnings mask. */
2026 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2028 } while (w >>= WARNshift);
2033 /* Set buffer=NULL to get a new one. */
2035 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2037 const MEM_SIZE len_wanted =
2038 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2039 PERL_UNUSED_CONTEXT;
2040 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2043 (specialWARN(buffer) ?
2044 PerlMemShared_malloc(len_wanted) :
2045 PerlMemShared_realloc(buffer, len_wanted));
2047 Copy(bits, (buffer + 1), size, char);
2048 if (size < WARNsize)
2049 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2053 /* since we've already done strlen() for both nam and val
2054 * we can use that info to make things faster than
2055 * sprintf(s, "%s=%s", nam, val)
2057 #define my_setenv_format(s, nam, nlen, val, vlen) \
2058 Copy(nam, s, nlen, char); \
2060 Copy(val, s+(nlen+1), vlen, char); \
2061 *(s+(nlen+1+vlen)) = '\0'
2063 #ifdef USE_ENVIRON_ARRAY
2064 /* VMS' my_setenv() is in vms.c */
2065 #if !defined(WIN32) && !defined(NETWARE)
2067 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2071 amigaos4_obtain_environ(__FUNCTION__);
2074 /* only parent thread can modify process environment */
2075 if (PL_curinterp == aTHX)
2078 #ifndef PERL_USE_SAFE_PUTENV
2079 if (!PL_use_safe_putenv) {
2080 /* most putenv()s leak, so we manipulate environ directly */
2082 const I32 len = strlen(nam);
2085 /* where does it go? */
2086 for (i = 0; environ[i]; i++) {
2087 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
2091 if (environ == PL_origenviron) { /* need we copy environment? */
2097 while (environ[max])
2099 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
2100 for (j=0; j<max; j++) { /* copy environment */
2101 const int len = strlen(environ[j]);
2102 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
2103 Copy(environ[j], tmpenv[j], len+1, char);
2106 environ = tmpenv; /* tell exec where it is now */
2109 safesysfree(environ[i]);
2110 while (environ[i]) {
2111 environ[i] = environ[i+1];
2120 if (!environ[i]) { /* does not exist yet */
2121 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
2122 environ[i+1] = NULL; /* make sure it's null terminated */
2125 safesysfree(environ[i]);
2129 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
2130 /* all that work just for this */
2131 my_setenv_format(environ[i], nam, nlen, val, vlen);
2134 /* This next branch should only be called #if defined(HAS_SETENV), but
2135 Configure doesn't test for that yet. For Solaris, setenv() and unsetenv()
2136 were introduced in Solaris 9, so testing for HAS UNSETENV is sufficient.
2138 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2139 # if defined(HAS_UNSETENV)
2141 (void)unsetenv(nam);
2143 (void)setenv(nam, val, 1);
2145 # else /* ! HAS_UNSETENV */
2146 (void)setenv(nam, val, 1);
2147 # endif /* HAS_UNSETENV */
2148 # elif defined(HAS_UNSETENV)
2150 if (environ) /* old glibc can crash with null environ */
2151 (void)unsetenv(nam);
2153 const int nlen = strlen(nam);
2154 const int vlen = strlen(val);
2155 char * const new_env =
2156 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2157 my_setenv_format(new_env, nam, nlen, val, vlen);
2158 (void)putenv(new_env);
2160 # else /* ! HAS_UNSETENV */
2162 const int nlen = strlen(nam);
2168 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2169 /* all that work just for this */
2170 my_setenv_format(new_env, nam, nlen, val, vlen);
2171 (void)putenv(new_env);
2172 # endif /* __CYGWIN__ */
2173 #ifndef PERL_USE_SAFE_PUTENV
2179 amigaos4_release_environ(__FUNCTION__);
2183 #else /* WIN32 || NETWARE */
2186 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2190 const int nlen = strlen(nam);
2197 Newx(envstr, nlen+vlen+2, char);
2198 my_setenv_format(envstr, nam, nlen, val, vlen);
2199 (void)PerlEnv_putenv(envstr);
2203 #endif /* WIN32 || NETWARE */
2207 #ifdef UNLINK_ALL_VERSIONS
2209 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2213 PERL_ARGS_ASSERT_UNLNK;
2215 while (PerlLIO_unlink(f) >= 0)
2217 return retries ? 0 : -1;
2222 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2224 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2232 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2234 PERL_FLUSHALL_FOR_CHILD;
2235 This = (*mode == 'w');
2239 taint_proper("Insecure %s%s", "EXEC");
2241 if (PerlProc_pipe(p) < 0)
2243 /* Try for another pipe pair for error return */
2244 if (PerlProc_pipe(pp) >= 0)
2246 while ((pid = PerlProc_fork()) < 0) {
2247 if (errno != EAGAIN) {
2248 PerlLIO_close(p[This]);
2249 PerlLIO_close(p[that]);
2251 PerlLIO_close(pp[0]);
2252 PerlLIO_close(pp[1]);
2256 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2265 /* Close parent's end of error status pipe (if any) */
2267 PerlLIO_close(pp[0]);
2268 #if defined(HAS_FCNTL) && defined(F_SETFD) && defined(FD_CLOEXEC)
2269 /* Close error pipe automatically if exec works */
2270 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2274 /* Now dup our end of _the_ pipe to right position */
2275 if (p[THIS] != (*mode == 'r')) {
2276 PerlLIO_dup2(p[THIS], *mode == 'r');
2277 PerlLIO_close(p[THIS]);
2278 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2279 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2282 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2283 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2284 /* No automatic close - do it by hand */
2291 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2297 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2304 PerlLIO_close(pp[1]);
2305 /* Keep the lower of the two fd numbers */
2306 if (p[that] < p[This]) {
2307 PerlLIO_dup2(p[This], p[that]);
2308 PerlLIO_close(p[This]);
2312 PerlLIO_close(p[that]); /* close child's end of pipe */
2314 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2315 SvUPGRADE(sv,SVt_IV);
2317 PL_forkprocess = pid;
2318 /* If we managed to get status pipe check for exec fail */
2319 if (did_pipes && pid > 0) {
2323 while (n < sizeof(int)) {
2324 const SSize_t n1 = PerlLIO_read(pp[0],
2325 (void*)(((char*)&errkid)+n),
2331 PerlLIO_close(pp[0]);
2333 if (n) { /* Error */
2335 PerlLIO_close(p[This]);
2336 if (n != sizeof(int))
2337 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2339 pid2 = wait4pid(pid, &status, 0);
2340 } while (pid2 == -1 && errno == EINTR);
2341 errno = errkid; /* Propagate errno from kid */
2346 PerlLIO_close(pp[0]);
2347 return PerlIO_fdopen(p[This], mode);
2349 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2350 return my_syspopen4(aTHX_ NULL, mode, n, args);
2351 # elif defined(WIN32)
2352 return win32_popenlist(mode, n, args);
2354 Perl_croak(aTHX_ "List form of piped open not implemented");
2355 return (PerlIO *) NULL;
2360 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2361 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2363 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2369 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2373 PERL_ARGS_ASSERT_MY_POPEN;
2375 PERL_FLUSHALL_FOR_CHILD;
2378 return my_syspopen(aTHX_ cmd,mode);
2381 This = (*mode == 'w');
2383 if (doexec && TAINTING_get) {
2385 taint_proper("Insecure %s%s", "EXEC");
2387 if (PerlProc_pipe(p) < 0)
2389 if (doexec && PerlProc_pipe(pp) >= 0)
2391 while ((pid = PerlProc_fork()) < 0) {
2392 if (errno != EAGAIN) {
2393 PerlLIO_close(p[This]);
2394 PerlLIO_close(p[that]);
2396 PerlLIO_close(pp[0]);
2397 PerlLIO_close(pp[1]);
2400 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2403 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2413 PerlLIO_close(pp[0]);
2414 #if defined(HAS_FCNTL) && defined(F_SETFD)
2415 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2419 if (p[THIS] != (*mode == 'r')) {
2420 PerlLIO_dup2(p[THIS], *mode == 'r');
2421 PerlLIO_close(p[THIS]);
2422 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2423 PerlLIO_close(p[THAT]);
2426 PerlLIO_close(p[THAT]);
2429 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2436 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2441 /* may or may not use the shell */
2442 do_exec3(cmd, pp[1], did_pipes);
2445 #endif /* defined OS2 */
2447 #ifdef PERLIO_USING_CRLF
2448 /* Since we circumvent IO layers when we manipulate low-level
2449 filedescriptors directly, need to manually switch to the
2450 default, binary, low-level mode; see PerlIOBuf_open(). */
2451 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2454 #ifdef PERL_USES_PL_PIDSTATUS
2455 hv_clear(PL_pidstatus); /* we have no children */
2462 PerlLIO_close(pp[1]);
2463 if (p[that] < p[This]) {
2464 PerlLIO_dup2(p[This], p[that]);
2465 PerlLIO_close(p[This]);
2469 PerlLIO_close(p[that]);
2471 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2472 SvUPGRADE(sv,SVt_IV);
2474 PL_forkprocess = pid;
2475 if (did_pipes && pid > 0) {
2479 while (n < sizeof(int)) {
2480 const SSize_t n1 = PerlLIO_read(pp[0],
2481 (void*)(((char*)&errkid)+n),
2487 PerlLIO_close(pp[0]);
2489 if (n) { /* Error */
2491 PerlLIO_close(p[This]);
2492 if (n != sizeof(int))
2493 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2495 pid2 = wait4pid(pid, &status, 0);
2496 } while (pid2 == -1 && errno == EINTR);
2497 errno = errkid; /* Propagate errno from kid */
2502 PerlLIO_close(pp[0]);
2503 return PerlIO_fdopen(p[This], mode);
2505 #elif defined(DJGPP)
2506 FILE *djgpp_popen();
2508 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2510 PERL_FLUSHALL_FOR_CHILD;
2511 /* Call system's popen() to get a FILE *, then import it.
2512 used 0 for 2nd parameter to PerlIO_importFILE;
2515 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2517 #elif defined(__LIBCATAMOUNT__)
2519 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2524 #endif /* !DOSISH */
2526 /* this is called in parent before the fork() */
2528 Perl_atfork_lock(void)
2529 #if defined(USE_ITHREADS)
2531 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2534 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2536 PERL_TSA_ACQUIRE(PL_op_mutex)
2539 #if defined(USE_ITHREADS)
2541 /* locks must be held in locking order (if any) */
2543 MUTEX_LOCK(&PL_perlio_mutex);
2546 MUTEX_LOCK(&PL_malloc_mutex);
2552 /* this is called in both parent and child after the fork() */
2554 Perl_atfork_unlock(void)
2555 #if defined(USE_ITHREADS)
2557 PERL_TSA_RELEASE(PL_perlio_mutex)
2560 PERL_TSA_RELEASE(PL_malloc_mutex)
2562 PERL_TSA_RELEASE(PL_op_mutex)
2565 #if defined(USE_ITHREADS)
2567 /* locks must be released in same order as in atfork_lock() */
2569 MUTEX_UNLOCK(&PL_perlio_mutex);
2572 MUTEX_UNLOCK(&PL_malloc_mutex);
2581 #if defined(HAS_FORK)
2583 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2588 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2589 * handlers elsewhere in the code */
2593 #elif defined(__amigaos4__)
2594 return amigaos_fork();
2596 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2597 Perl_croak_nocontext("fork() not available");
2599 #endif /* HAS_FORK */
2604 dup2(int oldfd, int newfd)
2606 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2609 PerlLIO_close(newfd);
2610 return fcntl(oldfd, F_DUPFD, newfd);
2612 #define DUP2_MAX_FDS 256
2613 int fdtmp[DUP2_MAX_FDS];
2619 PerlLIO_close(newfd);
2620 /* good enough for low fd's... */
2621 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2622 if (fdx >= DUP2_MAX_FDS) {
2630 PerlLIO_close(fdtmp[--fdx]);
2637 #ifdef HAS_SIGACTION
2640 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2642 struct sigaction act, oact;
2646 /* only "parent" interpreter can diddle signals */
2647 if (PL_curinterp != aTHX)
2648 return (Sighandler_t) SIG_ERR;
2651 act.sa_handler = (void(*)(int))handler;
2652 sigemptyset(&act.sa_mask);
2655 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2656 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2658 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2659 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2660 act.sa_flags |= SA_NOCLDWAIT;
2662 if (sigaction(signo, &act, &oact) == -1)
2663 return (Sighandler_t) SIG_ERR;
2665 return (Sighandler_t) oact.sa_handler;
2669 Perl_rsignal_state(pTHX_ int signo)
2671 struct sigaction oact;
2672 PERL_UNUSED_CONTEXT;
2674 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2675 return (Sighandler_t) SIG_ERR;
2677 return (Sighandler_t) oact.sa_handler;
2681 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2686 struct sigaction act;
2688 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2691 /* only "parent" interpreter can diddle signals */
2692 if (PL_curinterp != aTHX)
2696 act.sa_handler = (void(*)(int))handler;
2697 sigemptyset(&act.sa_mask);
2700 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2701 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2703 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2704 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2705 act.sa_flags |= SA_NOCLDWAIT;
2707 return sigaction(signo, &act, save);
2711 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2716 PERL_UNUSED_CONTEXT;
2718 /* only "parent" interpreter can diddle signals */
2719 if (PL_curinterp != aTHX)
2723 return sigaction(signo, save, (struct sigaction *)NULL);
2726 #else /* !HAS_SIGACTION */
2729 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2731 #if defined(USE_ITHREADS) && !defined(WIN32)
2732 /* only "parent" interpreter can diddle signals */
2733 if (PL_curinterp != aTHX)
2734 return (Sighandler_t) SIG_ERR;
2737 return PerlProc_signal(signo, handler);
2748 Perl_rsignal_state(pTHX_ int signo)
2751 Sighandler_t oldsig;
2753 #if defined(USE_ITHREADS) && !defined(WIN32)
2754 /* only "parent" interpreter can diddle signals */
2755 if (PL_curinterp != aTHX)
2756 return (Sighandler_t) SIG_ERR;
2760 oldsig = PerlProc_signal(signo, sig_trap);
2761 PerlProc_signal(signo, oldsig);
2763 PerlProc_kill(PerlProc_getpid(), signo);
2768 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2770 #if defined(USE_ITHREADS) && !defined(WIN32)
2771 /* only "parent" interpreter can diddle signals */
2772 if (PL_curinterp != aTHX)
2775 *save = PerlProc_signal(signo, handler);
2776 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2780 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2782 #if defined(USE_ITHREADS) && !defined(WIN32)
2783 /* only "parent" interpreter can diddle signals */
2784 if (PL_curinterp != aTHX)
2787 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2790 #endif /* !HAS_SIGACTION */
2791 #endif /* !PERL_MICRO */
2793 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2794 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2796 Perl_my_pclose(pTHX_ PerlIO *ptr)
2804 const int fd = PerlIO_fileno(ptr);
2807 svp = av_fetch(PL_fdpid,fd,TRUE);
2808 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2812 #if defined(USE_PERLIO)
2813 /* Find out whether the refcount is low enough for us to wait for the
2814 child proc without blocking. */
2815 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
2817 should_wait = pid > 0;
2821 if (pid == -1) { /* Opened by popen. */
2822 return my_syspclose(ptr);
2825 close_failed = (PerlIO_close(ptr) == EOF);
2827 if (should_wait) do {
2828 pid2 = wait4pid(pid, &status, 0);
2829 } while (pid2 == -1 && errno == EINTR);
2836 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2840 #elif defined(__LIBCATAMOUNT__)
2842 Perl_my_pclose(pTHX_ PerlIO *ptr)
2846 #endif /* !DOSISH */
2848 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2850 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
2853 PERL_ARGS_ASSERT_WAIT4PID;
2854 #ifdef PERL_USES_PL_PIDSTATUS
2856 /* PERL_USES_PL_PIDSTATUS is only defined when neither
2857 waitpid() nor wait4() is available, or on OS/2, which
2858 doesn't appear to support waiting for a progress group
2859 member, so we can only treat a 0 pid as an unknown child.
2866 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
2867 pid, rather than a string form. */
2868 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
2869 if (svp && *svp != &PL_sv_undef) {
2870 *statusp = SvIVX(*svp);
2871 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
2879 hv_iterinit(PL_pidstatus);
2880 if ((entry = hv_iternext(PL_pidstatus))) {
2881 SV * const sv = hv_iterval(PL_pidstatus,entry);
2883 const char * const spid = hv_iterkey(entry,&len);
2885 assert (len == sizeof(Pid_t));
2886 memcpy((char *)&pid, spid, len);
2887 *statusp = SvIVX(sv);
2888 /* The hash iterator is currently on this entry, so simply
2889 calling hv_delete would trigger the lazy delete, which on
2890 aggregate does more work, because next call to hv_iterinit()
2891 would spot the flag, and have to call the delete routine,
2892 while in the meantime any new entries can't re-use that
2894 hv_iterinit(PL_pidstatus);
2895 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
2902 # ifdef HAS_WAITPID_RUNTIME
2903 if (!HAS_WAITPID_RUNTIME)
2906 result = PerlProc_waitpid(pid,statusp,flags);
2909 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
2910 result = wait4(pid,statusp,flags,NULL);
2913 #ifdef PERL_USES_PL_PIDSTATUS
2914 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
2919 Perl_croak(aTHX_ "Can't do waitpid with flags");
2921 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
2922 pidgone(result,*statusp);
2928 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
2931 if (result < 0 && errno == EINTR) {
2933 errno = EINTR; /* reset in case a signal handler changed $! */
2937 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
2939 #ifdef PERL_USES_PL_PIDSTATUS
2941 S_pidgone(pTHX_ Pid_t pid, int status)
2945 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
2946 SvUPGRADE(sv,SVt_IV);
2947 SvIV_set(sv, status);
2955 int /* Cannot prototype with I32
2957 my_syspclose(PerlIO *ptr)
2960 Perl_my_pclose(pTHX_ PerlIO *ptr)
2963 /* Needs work for PerlIO ! */
2964 FILE * const f = PerlIO_findFILE(ptr);
2965 const I32 result = pclose(f);
2966 PerlIO_releaseFILE(ptr,f);
2974 Perl_my_pclose(pTHX_ PerlIO *ptr)
2976 /* Needs work for PerlIO ! */
2977 FILE * const f = PerlIO_findFILE(ptr);
2978 I32 result = djgpp_pclose(f);
2979 result = (result << 8) & 0xff00;
2980 PerlIO_releaseFILE(ptr,f);
2985 #define PERL_REPEATCPY_LINEAR 4
2987 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
2989 PERL_ARGS_ASSERT_REPEATCPY;
2994 croak_memory_wrap();
2997 memset(to, *from, count);
3000 IV items, linear, half;
3002 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3003 for (items = 0; items < linear; ++items) {
3004 const char *q = from;
3006 for (todo = len; todo > 0; todo--)
3011 while (items <= half) {
3012 IV size = items * len;
3013 memcpy(p, to, size);
3019 memcpy(p, to, (count - items) * len);
3025 Perl_same_dirent(pTHX_ const char *a, const char *b)
3027 char *fa = strrchr(a,'/');
3028 char *fb = strrchr(b,'/');
3031 SV * const tmpsv = sv_newmortal();
3033 PERL_ARGS_ASSERT_SAME_DIRENT;
3046 sv_setpvs(tmpsv, ".");
3048 sv_setpvn(tmpsv, a, fa - a);
3049 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3052 sv_setpvs(tmpsv, ".");
3054 sv_setpvn(tmpsv, b, fb - b);
3055 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3057 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3058 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3060 #endif /* !HAS_RENAME */
3063 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3064 const char *const *const search_ext, I32 flags)
3066 const char *xfound = NULL;
3067 char *xfailed = NULL;
3068 char tmpbuf[MAXPATHLEN];
3073 #if defined(DOSISH) && !defined(OS2)
3074 # define SEARCH_EXTS ".bat", ".cmd", NULL
3075 # define MAX_EXT_LEN 4
3078 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3079 # define MAX_EXT_LEN 4
3082 # define SEARCH_EXTS ".pl", ".com", NULL
3083 # define MAX_EXT_LEN 4
3085 /* additional extensions to try in each dir if scriptname not found */
3087 static const char *const exts[] = { SEARCH_EXTS };
3088 const char *const *const ext = search_ext ? search_ext : exts;
3089 int extidx = 0, i = 0;
3090 const char *curext = NULL;
3092 PERL_UNUSED_ARG(search_ext);
3093 # define MAX_EXT_LEN 0
3096 PERL_ARGS_ASSERT_FIND_SCRIPT;
3099 * If dosearch is true and if scriptname does not contain path
3100 * delimiters, search the PATH for scriptname.
3102 * If SEARCH_EXTS is also defined, will look for each
3103 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3104 * while searching the PATH.
3106 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3107 * proceeds as follows:
3108 * If DOSISH or VMSISH:
3109 * + look for ./scriptname{,.foo,.bar}
3110 * + search the PATH for scriptname{,.foo,.bar}
3113 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3114 * this will not look in '.' if it's not in the PATH)
3119 # ifdef ALWAYS_DEFTYPES
3120 len = strlen(scriptname);
3121 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3122 int idx = 0, deftypes = 1;
3125 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3128 int idx = 0, deftypes = 1;
3131 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3133 /* The first time through, just add SEARCH_EXTS to whatever we
3134 * already have, so we can check for default file types. */
3136 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3143 if ((strlen(tmpbuf) + strlen(scriptname)
3144 + MAX_EXT_LEN) >= sizeof tmpbuf)
3145 continue; /* don't search dir with too-long name */
3146 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3150 if (strEQ(scriptname, "-"))
3152 if (dosearch) { /* Look in '.' first. */
3153 const char *cur = scriptname;
3155 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3157 if (strEQ(ext[i++],curext)) {
3158 extidx = -1; /* already has an ext */
3163 DEBUG_p(PerlIO_printf(Perl_debug_log,
3164 "Looking for %s\n",cur));
3167 if (PerlLIO_stat(cur,&statbuf) >= 0
3168 && !S_ISDIR(statbuf.st_mode)) {
3177 if (cur == scriptname) {
3178 len = strlen(scriptname);
3179 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3181 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3184 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3185 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3190 if (dosearch && !strchr(scriptname, '/')
3192 && !strchr(scriptname, '\\')
3194 && (s = PerlEnv_getenv("PATH")))
3198 bufend = s + strlen(s);
3199 while (s < bufend) {
3203 && *s != ';'; len++, s++) {
3204 if (len < sizeof tmpbuf)
3207 if (len < sizeof tmpbuf)
3210 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3215 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3216 continue; /* don't search dir with too-long name */
3219 && tmpbuf[len - 1] != '/'
3220 && tmpbuf[len - 1] != '\\'
3223 tmpbuf[len++] = '/';
3224 if (len == 2 && tmpbuf[0] == '.')
3226 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3230 len = strlen(tmpbuf);
3231 if (extidx > 0) /* reset after previous loop */
3235 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3236 retval = PerlLIO_stat(tmpbuf,&statbuf);
3237 if (S_ISDIR(statbuf.st_mode)) {
3241 } while ( retval < 0 /* not there */
3242 && extidx>=0 && ext[extidx] /* try an extension? */
3243 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3248 if (S_ISREG(statbuf.st_mode)
3249 && cando(S_IRUSR,TRUE,&statbuf)
3250 #if !defined(DOSISH)
3251 && cando(S_IXUSR,TRUE,&statbuf)
3255 xfound = tmpbuf; /* bingo! */
3259 xfailed = savepv(tmpbuf);
3264 if (!xfound && !seen_dot && !xfailed &&
3265 (PerlLIO_stat(scriptname,&statbuf) < 0
3266 || S_ISDIR(statbuf.st_mode)))
3268 seen_dot = 1; /* Disable message. */
3273 if (flags & 1) { /* do or die? */
3274 /* diag_listed_as: Can't execute %s */
3275 Perl_croak(aTHX_ "Can't %s %s%s%s",
3276 (xfailed ? "execute" : "find"),
3277 (xfailed ? xfailed : scriptname),
3278 (xfailed ? "" : " on PATH"),
3279 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3284 scriptname = xfound;
3286 return (scriptname ? savepv(scriptname) : NULL);
3289 #ifndef PERL_GET_CONTEXT_DEFINED
3292 Perl_get_context(void)
3294 #if defined(USE_ITHREADS)
3296 # ifdef OLD_PTHREADS_API
3298 int error = pthread_getspecific(PL_thr_key, &t)
3300 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3302 # elif defined(I_MACH_CTHREADS)
3303 return (void*)cthread_data(cthread_self());
3305 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3313 Perl_set_context(void *t)
3315 #if defined(USE_ITHREADS)
3318 PERL_ARGS_ASSERT_SET_CONTEXT;
3319 #if defined(USE_ITHREADS)
3320 # ifdef I_MACH_CTHREADS
3321 cthread_set_data(cthread_self(), t);
3324 const int error = pthread_setspecific(PL_thr_key, t);
3326 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3334 #endif /* !PERL_GET_CONTEXT_DEFINED */
3336 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3340 PERL_UNUSED_CONTEXT;
3346 Perl_get_op_names(pTHX)
3348 PERL_UNUSED_CONTEXT;
3349 return (char **)PL_op_name;
3353 Perl_get_op_descs(pTHX)
3355 PERL_UNUSED_CONTEXT;
3356 return (char **)PL_op_desc;
3360 Perl_get_no_modify(pTHX)
3362 PERL_UNUSED_CONTEXT;
3363 return PL_no_modify;
3367 Perl_get_opargs(pTHX)
3369 PERL_UNUSED_CONTEXT;
3370 return (U32 *)PL_opargs;
3374 Perl_get_ppaddr(pTHX)
3377 PERL_UNUSED_CONTEXT;
3378 return (PPADDR_t*)PL_ppaddr;
3381 #ifndef HAS_GETENV_LEN
3383 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3385 char * const env_trans = PerlEnv_getenv(env_elem);
3386 PERL_UNUSED_CONTEXT;
3387 PERL_ARGS_ASSERT_GETENV_LEN;
3389 *len = strlen(env_trans);
3396 Perl_get_vtbl(pTHX_ int vtbl_id)
3398 PERL_UNUSED_CONTEXT;
3400 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3401 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3405 Perl_my_fflush_all(pTHX)
3407 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3408 return PerlIO_flush(NULL);
3410 # if defined(HAS__FWALK)
3411 extern int fflush(FILE *);
3412 /* undocumented, unprototyped, but very useful BSDism */
3413 extern void _fwalk(int (*)(FILE *));
3417 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3419 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3420 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3421 # elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3422 open_max = sysconf(_SC_OPEN_MAX);
3423 # elif defined(FOPEN_MAX)
3424 open_max = FOPEN_MAX;
3425 # elif defined(OPEN_MAX)
3426 open_max = OPEN_MAX;
3427 # elif defined(_NFILE)
3432 for (i = 0; i < open_max; i++)
3433 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3434 STDIO_STREAM_ARRAY[i]._file < open_max &&
3435 STDIO_STREAM_ARRAY[i]._flag)
3436 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3440 SETERRNO(EBADF,RMS_IFI);
3447 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3449 if (ckWARN(WARN_IO)) {
3451 = gv && (isGV_with_GP(gv))
3454 const char * const direction = have == '>' ? "out" : "in";
3456 if (name && HEK_LEN(name))
3457 Perl_warner(aTHX_ packWARN(WARN_IO),
3458 "Filehandle %" HEKf " opened only for %sput",
3459 HEKfARG(name), direction);
3461 Perl_warner(aTHX_ packWARN(WARN_IO),
3462 "Filehandle opened only for %sput", direction);
3467 Perl_report_evil_fh(pTHX_ const GV *gv)
3469 const IO *io = gv ? GvIO(gv) : NULL;
3470 const PERL_BITFIELD16 op = PL_op->op_type;
3474 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3476 warn_type = WARN_CLOSED;
3480 warn_type = WARN_UNOPENED;
3483 if (ckWARN(warn_type)) {
3485 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3486 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3487 const char * const pars =
3488 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3489 const char * const func =
3491 (op == OP_READLINE || op == OP_RCATLINE
3492 ? "readline" : /* "<HANDLE>" not nice */
3493 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3495 const char * const type =
3497 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3498 ? "socket" : "filehandle");
3499 const bool have_name = name && SvCUR(name);
3500 Perl_warner(aTHX_ packWARN(warn_type),
3501 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3502 have_name ? " " : "",
3503 SVfARG(have_name ? name : &PL_sv_no));
3504 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3506 aTHX_ packWARN(warn_type),
3507 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3508 func, pars, have_name ? " " : "",
3509 SVfARG(have_name ? name : &PL_sv_no)
3514 /* To workaround core dumps from the uninitialised tm_zone we get the
3515 * system to give us a reasonable struct to copy. This fix means that
3516 * strftime uses the tm_zone and tm_gmtoff values returned by
3517 * localtime(time()). That should give the desired result most of the
3518 * time. But probably not always!
3520 * This does not address tzname aspects of NETaa14816.
3525 # ifndef STRUCT_TM_HASZONE
3526 # define STRUCT_TM_HASZONE
3530 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3531 # ifndef HAS_TM_TM_ZONE
3532 # define HAS_TM_TM_ZONE
3537 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3539 #ifdef HAS_TM_TM_ZONE
3541 const struct tm* my_tm;
3542 PERL_UNUSED_CONTEXT;
3543 PERL_ARGS_ASSERT_INIT_TM;
3545 my_tm = localtime(&now);
3547 Copy(my_tm, ptm, 1, struct tm);
3549 PERL_UNUSED_CONTEXT;
3550 PERL_ARGS_ASSERT_INIT_TM;
3551 PERL_UNUSED_ARG(ptm);
3556 * mini_mktime - normalise struct tm values without the localtime()
3557 * semantics (and overhead) of mktime().
3560 Perl_mini_mktime(struct tm *ptm)
3564 int month, mday, year, jday;
3565 int odd_cent, odd_year;
3567 PERL_ARGS_ASSERT_MINI_MKTIME;
3569 #define DAYS_PER_YEAR 365
3570 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3571 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3572 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3573 #define SECS_PER_HOUR (60*60)
3574 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3575 /* parentheses deliberately absent on these two, otherwise they don't work */
3576 #define MONTH_TO_DAYS 153/5
3577 #define DAYS_TO_MONTH 5/153
3578 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3579 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3580 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3581 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3584 * Year/day algorithm notes:
3586 * With a suitable offset for numeric value of the month, one can find
3587 * an offset into the year by considering months to have 30.6 (153/5) days,
3588 * using integer arithmetic (i.e., with truncation). To avoid too much
3589 * messing about with leap days, we consider January and February to be
3590 * the 13th and 14th month of the previous year. After that transformation,
3591 * we need the month index we use to be high by 1 from 'normal human' usage,
3592 * so the month index values we use run from 4 through 15.
3594 * Given that, and the rules for the Gregorian calendar (leap years are those
3595 * divisible by 4 unless also divisible by 100, when they must be divisible
3596 * by 400 instead), we can simply calculate the number of days since some
3597 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3598 * the days we derive from our month index, and adding in the day of the
3599 * month. The value used here is not adjusted for the actual origin which
3600 * it normally would use (1 January A.D. 1), since we're not exposing it.
3601 * We're only building the value so we can turn around and get the
3602 * normalised values for the year, month, day-of-month, and day-of-year.
3604 * For going backward, we need to bias the value we're using so that we find
3605 * the right year value. (Basically, we don't want the contribution of
3606 * March 1st to the number to apply while deriving the year). Having done
3607 * that, we 'count up' the contribution to the year number by accounting for
3608 * full quadracenturies (400-year periods) with their extra leap days, plus
3609 * the contribution from full centuries (to avoid counting in the lost leap
3610 * days), plus the contribution from full quad-years (to count in the normal
3611 * leap days), plus the leftover contribution from any non-leap years.
3612 * At this point, if we were working with an actual leap day, we'll have 0
3613 * days left over. This is also true for March 1st, however. So, we have
3614 * to special-case that result, and (earlier) keep track of the 'odd'
3615 * century and year contributions. If we got 4 extra centuries in a qcent,
3616 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3617 * Otherwise, we add back in the earlier bias we removed (the 123 from
3618 * figuring in March 1st), find the month index (integer division by 30.6),
3619 * and the remainder is the day-of-month. We then have to convert back to
3620 * 'real' months (including fixing January and February from being 14/15 in
3621 * the previous year to being in the proper year). After that, to get
3622 * tm_yday, we work with the normalised year and get a new yearday value for
3623 * January 1st, which we subtract from the yearday value we had earlier,
3624 * representing the date we've re-built. This is done from January 1
3625 * because tm_yday is 0-origin.
3627 * Since POSIX time routines are only guaranteed to work for times since the
3628 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3629 * applies Gregorian calendar rules even to dates before the 16th century
3630 * doesn't bother me. Besides, you'd need cultural context for a given
3631 * date to know whether it was Julian or Gregorian calendar, and that's
3632 * outside the scope for this routine. Since we convert back based on the
3633 * same rules we used to build the yearday, you'll only get strange results
3634 * for input which needed normalising, or for the 'odd' century years which
3635 * were leap years in the Julian calendar but not in the Gregorian one.
3636 * I can live with that.
3638 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3639 * that's still outside the scope for POSIX time manipulation, so I don't
3645 year = 1900 + ptm->tm_year;
3646 month = ptm->tm_mon;
3647 mday = ptm->tm_mday;
3653 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3654 yearday += month*MONTH_TO_DAYS + mday + jday;
3656 * Note that we don't know when leap-seconds were or will be,
3657 * so we have to trust the user if we get something which looks
3658 * like a sensible leap-second. Wild values for seconds will
3659 * be rationalised, however.
3661 if ((unsigned) ptm->tm_sec <= 60) {
3668 secs += 60 * ptm->tm_min;
3669 secs += SECS_PER_HOUR * ptm->tm_hour;
3671 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3672 /* got negative remainder, but need positive time */
3673 /* back off an extra day to compensate */
3674 yearday += (secs/SECS_PER_DAY)-1;
3675 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3678 yearday += (secs/SECS_PER_DAY);
3679 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3682 else if (secs >= SECS_PER_DAY) {
3683 yearday += (secs/SECS_PER_DAY);
3684 secs %= SECS_PER_DAY;
3686 ptm->tm_hour = secs/SECS_PER_HOUR;
3687 secs %= SECS_PER_HOUR;
3688 ptm->tm_min = secs/60;
3690 ptm->tm_sec += secs;
3691 /* done with time of day effects */
3693 * The algorithm for yearday has (so far) left it high by 428.
3694 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3695 * bias it by 123 while trying to figure out what year it
3696 * really represents. Even with this tweak, the reverse
3697 * translation fails for years before A.D. 0001.
3698 * It would still fail for Feb 29, but we catch that one below.
3700 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3701 yearday -= YEAR_ADJUST;
3702 year = (yearday / DAYS_PER_QCENT) * 400;
3703 yearday %= DAYS_PER_QCENT;
3704 odd_cent = yearday / DAYS_PER_CENT;
3705 year += odd_cent * 100;
3706 yearday %= DAYS_PER_CENT;
3707 year += (yearday / DAYS_PER_QYEAR) * 4;
3708 yearday %= DAYS_PER_QYEAR;
3709 odd_year = yearday / DAYS_PER_YEAR;
3711 yearday %= DAYS_PER_YEAR;
3712 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3717 yearday += YEAR_ADJUST; /* recover March 1st crock */
3718 month = yearday*DAYS_TO_MONTH;
3719 yearday -= month*MONTH_TO_DAYS;
3720 /* recover other leap-year adjustment */
3729 ptm->tm_year = year - 1900;
3731 ptm->tm_mday = yearday;
3732 ptm->tm_mon = month;
3736 ptm->tm_mon = month - 1;
3738 /* re-build yearday based on Jan 1 to get tm_yday */
3740 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3741 yearday += 14*MONTH_TO_DAYS + 1;
3742 ptm->tm_yday = jday - yearday;
3743 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3747 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)
3751 /* strftime(), but with a different API so that the return value is a pointer
3752 * to the formatted result (which MUST be arranged to be FREED BY THE
3753 * CALLER). This allows this function to increase the buffer size as needed,
3754 * so that the caller doesn't have to worry about that.
3756 * Note that yday and wday effectively are ignored by this function, as
3757 * mini_mktime() overwrites them */
3764 PERL_ARGS_ASSERT_MY_STRFTIME;
3766 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3769 mytm.tm_hour = hour;
3770 mytm.tm_mday = mday;
3772 mytm.tm_year = year;
3773 mytm.tm_wday = wday;
3774 mytm.tm_yday = yday;
3775 mytm.tm_isdst = isdst;
3777 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3778 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3783 #ifdef HAS_TM_TM_GMTOFF
3784 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3786 #ifdef HAS_TM_TM_ZONE
3787 mytm.tm_zone = mytm2.tm_zone;
3792 Newx(buf, buflen, char);
3794 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3795 len = strftime(buf, buflen, fmt, &mytm);
3796 GCC_DIAG_RESTORE_STMT;
3799 ** The following is needed to handle to the situation where
3800 ** tmpbuf overflows. Basically we want to allocate a buffer
3801 ** and try repeatedly. The reason why it is so complicated
3802 ** is that getting a return value of 0 from strftime can indicate
3803 ** one of the following:
3804 ** 1. buffer overflowed,
3805 ** 2. illegal conversion specifier, or
3806 ** 3. the format string specifies nothing to be returned(not
3807 ** an error). This could be because format is an empty string
3808 ** or it specifies %p that yields an empty string in some locale.
3809 ** If there is a better way to make it portable, go ahead by
3812 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
3815 /* Possibly buf overflowed - try again with a bigger buf */
3816 const int fmtlen = strlen(fmt);
3817 int bufsize = fmtlen + buflen;
3819 Renew(buf, bufsize, char);
3822 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3823 buflen = strftime(buf, bufsize, fmt, &mytm);
3824 GCC_DIAG_RESTORE_STMT;
3826 if (buflen > 0 && buflen < bufsize)
3828 /* heuristic to prevent out-of-memory errors */
3829 if (bufsize > 100*fmtlen) {
3835 Renew(buf, bufsize, char);
3840 Perl_croak(aTHX_ "panic: no strftime");
3846 #define SV_CWD_RETURN_UNDEF \
3850 #define SV_CWD_ISDOT(dp) \
3851 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
3852 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
3855 =head1 Miscellaneous Functions
3857 =for apidoc getcwd_sv
3859 Fill C<sv> with current working directory
3864 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
3865 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
3866 * getcwd(3) if available
3867 * Comments from the original:
3868 * This is a faster version of getcwd. It's also more dangerous
3869 * because you might chdir out of a directory that you can't chdir
3873 Perl_getcwd_sv(pTHX_ SV *sv)
3878 PERL_ARGS_ASSERT_GETCWD_SV;
3882 char buf[MAXPATHLEN];
3884 /* Some getcwd()s automatically allocate a buffer of the given
3885 * size from the heap if they are given a NULL buffer pointer.
3886 * The problem is that this behaviour is not portable. */
3887 if (getcwd(buf, sizeof(buf) - 1)) {
3892 SV_CWD_RETURN_UNDEF;
3899 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
3903 SvUPGRADE(sv, SVt_PV);
3905 if (PerlLIO_lstat(".", &statbuf) < 0) {
3906 SV_CWD_RETURN_UNDEF;
3909 orig_cdev = statbuf.st_dev;
3910 orig_cino = statbuf.st_ino;
3920 if (PerlDir_chdir("..") < 0) {
3921 SV_CWD_RETURN_UNDEF;
3923 if (PerlLIO_stat(".", &statbuf) < 0) {
3924 SV_CWD_RETURN_UNDEF;
3927 cdev = statbuf.st_dev;
3928 cino = statbuf.st_ino;
3930 if (odev == cdev && oino == cino) {
3933 if (!(dir = PerlDir_open("."))) {
3934 SV_CWD_RETURN_UNDEF;
3937 while ((dp = PerlDir_read(dir)) != NULL) {
3939 namelen = dp->d_namlen;
3941 namelen = strlen(dp->d_name);
3944 if (SV_CWD_ISDOT(dp)) {
3948 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
3949 SV_CWD_RETURN_UNDEF;
3952 tdev = statbuf.st_dev;
3953 tino = statbuf.st_ino;
3954 if (tino == oino && tdev == odev) {
3960 SV_CWD_RETURN_UNDEF;
3963 if (pathlen + namelen + 1 >= MAXPATHLEN) {
3964 SV_CWD_RETURN_UNDEF;
3967 SvGROW(sv, pathlen + namelen + 1);
3971 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
3974 /* prepend current directory to the front */
3976 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
3977 pathlen += (namelen + 1);
3979 #ifdef VOID_CLOSEDIR
3982 if (PerlDir_close(dir) < 0) {
3983 SV_CWD_RETURN_UNDEF;
3989 SvCUR_set(sv, pathlen);
3993 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
3994 SV_CWD_RETURN_UNDEF;
3997 if (PerlLIO_stat(".", &statbuf) < 0) {
3998 SV_CWD_RETURN_UNDEF;
4001 cdev = statbuf.st_dev;
4002 cino = statbuf.st_ino;
4004 if (cdev != orig_cdev || cino != orig_cino) {
4005 Perl_croak(aTHX_ "Unstable directory path, "
4006 "current directory changed unexpectedly");
4019 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4020 # define EMULATE_SOCKETPAIR_UDP
4023 #ifdef EMULATE_SOCKETPAIR_UDP
4025 S_socketpair_udp (int fd[2]) {
4027 /* Fake a datagram socketpair using UDP to localhost. */
4028 int sockets[2] = {-1, -1};
4029 struct sockaddr_in addresses[2];
4031 Sock_size_t size = sizeof(struct sockaddr_in);
4032 unsigned short port;
4035 memset(&addresses, 0, sizeof(addresses));
4038 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4039 if (sockets[i] == -1)
4040 goto tidy_up_and_fail;
4042 addresses[i].sin_family = AF_INET;
4043 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4044 addresses[i].sin_port = 0; /* kernel choses port. */
4045 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4046 sizeof(struct sockaddr_in)) == -1)
4047 goto tidy_up_and_fail;
4050 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4051 for each connect the other socket to it. */
4054 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4056 goto tidy_up_and_fail;
4057 if (size != sizeof(struct sockaddr_in))
4058 goto abort_tidy_up_and_fail;
4059 /* !1 is 0, !0 is 1 */
4060 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4061 sizeof(struct sockaddr_in)) == -1)
4062 goto tidy_up_and_fail;
4065 /* Now we have 2 sockets connected to each other. I don't trust some other
4066 process not to have already sent a packet to us (by random) so send
4067 a packet from each to the other. */
4070 /* I'm going to send my own port number. As a short.
4071 (Who knows if someone somewhere has sin_port as a bitfield and needs
4072 this routine. (I'm assuming crays have socketpair)) */
4073 port = addresses[i].sin_port;
4074 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4075 if (got != sizeof(port)) {
4077 goto tidy_up_and_fail;
4078 goto abort_tidy_up_and_fail;
4082 /* Packets sent. I don't trust them to have arrived though.
4083 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4084 connect to localhost will use a second kernel thread. In 2.6 the
4085 first thread running the connect() returns before the second completes,
4086 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4087 returns 0. Poor programs have tripped up. One poor program's authors'
4088 had a 50-1 reverse stock split. Not sure how connected these were.)
4089 So I don't trust someone not to have an unpredictable UDP stack.
4093 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4094 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4098 FD_SET((unsigned int)sockets[0], &rset);
4099 FD_SET((unsigned int)sockets[1], &rset);
4101 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4102 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4103 || !FD_ISSET(sockets[1], &rset)) {
4104 /* I hope this is portable and appropriate. */
4106 goto tidy_up_and_fail;
4107 goto abort_tidy_up_and_fail;
4111 /* And the paranoia department even now doesn't trust it to have arrive
4112 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4114 struct sockaddr_in readfrom;
4115 unsigned short buffer[2];
4120 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4121 sizeof(buffer), MSG_DONTWAIT,
4122 (struct sockaddr *) &readfrom, &size);
4124 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4126 (struct sockaddr *) &readfrom, &size);
4130 goto tidy_up_and_fail;
4131 if (got != sizeof(port)
4132 || size != sizeof(struct sockaddr_in)
4133 /* Check other socket sent us its port. */
4134 || buffer[0] != (unsigned short) addresses[!i].sin_port
4135 /* Check kernel says we got the datagram from that socket */
4136 || readfrom.sin_family != addresses[!i].sin_family
4137 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4138 || readfrom.sin_port != addresses[!i].sin_port)
4139 goto abort_tidy_up_and_fail;
4142 /* My caller (my_socketpair) has validated that this is non-NULL */
4145 /* I hereby declare this connection open. May God bless all who cross
4149 abort_tidy_up_and_fail:
4150 errno = ECONNABORTED;
4154 if (sockets[0] != -1)
4155 PerlLIO_close(sockets[0]);
4156 if (sockets[1] != -1)
4157 PerlLIO_close(sockets[1]);
4162 #endif /* EMULATE_SOCKETPAIR_UDP */
4164 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4166 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4167 /* Stevens says that family must be AF_LOCAL, protocol 0.
4168 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4173 struct sockaddr_in listen_addr;
4174 struct sockaddr_in connect_addr;
4179 || family != AF_UNIX
4182 errno = EAFNOSUPPORT;
4190 #ifdef EMULATE_SOCKETPAIR_UDP
4191 if (type == SOCK_DGRAM)
4192 return S_socketpair_udp(fd);
4195 aTHXa(PERL_GET_THX);
4196 listener = PerlSock_socket(AF_INET, type, 0);
4199 memset(&listen_addr, 0, sizeof(listen_addr));
4200 listen_addr.sin_family = AF_INET;
4201 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4202 listen_addr.sin_port = 0; /* kernel choses port. */
4203 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4204 sizeof(listen_addr)) == -1)
4205 goto tidy_up_and_fail;
4206 if (PerlSock_listen(listener, 1) == -1)
4207 goto tidy_up_and_fail;
4209 connector = PerlSock_socket(AF_INET, type, 0);
4210 if (connector == -1)
4211 goto tidy_up_and_fail;
4212 /* We want to find out the port number to connect to. */
4213 size = sizeof(connect_addr);
4214 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4216 goto tidy_up_and_fail;
4217 if (size != sizeof(connect_addr))
4218 goto abort_tidy_up_and_fail;
4219 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4220 sizeof(connect_addr)) == -1)
4221 goto tidy_up_and_fail;
4223 size = sizeof(listen_addr);
4224 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4227 goto tidy_up_and_fail;
4228 if (size != sizeof(listen_addr))
4229 goto abort_tidy_up_and_fail;
4230 PerlLIO_close(listener);
4231 /* Now check we are talking to ourself by matching port and host on the
4233 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4235 goto tidy_up_and_fail;
4236 if (size != sizeof(connect_addr)
4237 || listen_addr.sin_family != connect_addr.sin_family
4238 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4239 || listen_addr.sin_port != connect_addr.sin_port) {
4240 goto abort_tidy_up_and_fail;
4246 abort_tidy_up_and_fail:
4248 errno = ECONNABORTED; /* This would be the standard thing to do. */
4249 #elif defined(ECONNREFUSED)
4250 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4252 errno = ETIMEDOUT; /* Desperation time. */
4258 PerlLIO_close(listener);
4259 if (connector != -1)
4260 PerlLIO_close(connector);
4262 PerlLIO_close(acceptor);
4268 /* In any case have a stub so that there's code corresponding
4269 * to the my_socketpair in embed.fnc. */
4271 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4272 #ifdef HAS_SOCKETPAIR
4273 return socketpair(family, type, protocol, fd);
4282 =for apidoc sv_nosharing
4284 Dummy routine which "shares" an SV when there is no sharing module present.
4285 Or "locks" it. Or "unlocks" it. In other
4286 words, ignores its single SV argument.
4287 Exists to avoid test for a C<NULL> function pointer and because it could
4288 potentially warn under some level of strict-ness.
4294 Perl_sv_nosharing(pTHX_ SV *sv)
4296 PERL_UNUSED_CONTEXT;
4297 PERL_UNUSED_ARG(sv);
4302 =for apidoc sv_destroyable
4304 Dummy routine which reports that object can be destroyed when there is no
4305 sharing module present. It ignores its single SV argument, and returns
4306 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4307 could potentially warn under some level of strict-ness.
4313 Perl_sv_destroyable(pTHX_ SV *sv)
4315 PERL_UNUSED_CONTEXT;
4316 PERL_UNUSED_ARG(sv);
4321 Perl_parse_unicode_opts(pTHX_ const char **popt)
4323 const char *p = *popt;
4326 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4332 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4335 if (p && *p && *p != '\n' && *p != '\r') {
4337 goto the_end_of_the_opts_parser;
4339 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4343 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4349 case PERL_UNICODE_STDIN:
4350 opt |= PERL_UNICODE_STDIN_FLAG; break;
4351 case PERL_UNICODE_STDOUT:
4352 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4353 case PERL_UNICODE_STDERR:
4354 opt |= PERL_UNICODE_STDERR_FLAG; break;
4355 case PERL_UNICODE_STD:
4356 opt |= PERL_UNICODE_STD_FLAG; break;
4357 case PERL_UNICODE_IN:
4358 opt |= PERL_UNICODE_IN_FLAG; break;
4359 case PERL_UNICODE_OUT:
4360 opt |= PERL_UNICODE_OUT_FLAG; break;
4361 case PERL_UNICODE_INOUT:
4362 opt |= PERL_UNICODE_INOUT_FLAG; break;
4363 case PERL_UNICODE_LOCALE:
4364 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4365 case PERL_UNICODE_ARGV:
4366 opt |= PERL_UNICODE_ARGV_FLAG; break;
4367 case PERL_UNICODE_UTF8CACHEASSERT:
4368 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4370 if (*p != '\n' && *p != '\r') {
4371 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4374 "Unknown Unicode option letter '%c'", *p);
4381 opt = PERL_UNICODE_DEFAULT_FLAGS;
4383 the_end_of_the_opts_parser:
4385 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4386 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4387 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4395 # include <starlet.h>
4402 * This is really just a quick hack which grabs various garbage
4403 * values. It really should be a real hash algorithm which
4404 * spreads the effect of every input bit onto every output bit,
4405 * if someone who knows about such things would bother to write it.
4406 * Might be a good idea to add that function to CORE as well.
4407 * No numbers below come from careful analysis or anything here,
4408 * except they are primes and SEED_C1 > 1E6 to get a full-width
4409 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4410 * probably be bigger too.
4413 # define SEED_C1 1000003
4414 #define SEED_C4 73819
4416 # define SEED_C1 25747
4417 #define SEED_C4 20639
4421 #define SEED_C5 26107
4423 #ifndef PERL_NO_DEV_RANDOM
4427 #ifdef HAS_GETTIMEOFDAY
4428 struct timeval when;
4433 /* This test is an escape hatch, this symbol isn't set by Configure. */
4434 #ifndef PERL_NO_DEV_RANDOM
4435 #ifndef PERL_RANDOM_DEVICE
4436 /* /dev/random isn't used by default because reads from it will block
4437 * if there isn't enough entropy available. You can compile with
4438 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4439 * is enough real entropy to fill the seed. */
4440 # ifdef __amigaos4__
4441 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4443 # define PERL_RANDOM_DEVICE "/dev/urandom"
4446 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
4448 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4456 #ifdef HAS_GETTIMEOFDAY
4457 PerlProc_gettimeofday(&when,NULL);
4458 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4461 u = (U32)SEED_C1 * when;
4463 u += SEED_C3 * (U32)PerlProc_getpid();
4464 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4465 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4466 u += SEED_C5 * (U32)PTR2UV(&when);
4472 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4474 #ifndef NO_PERL_HASH_ENV
4479 PERL_ARGS_ASSERT_GET_HASH_SEED;
4481 #ifndef NO_PERL_HASH_ENV
4482 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4486 /* ignore leading spaces */
4487 while (isSPACE(*env_pv))
4489 # ifdef USE_PERL_PERTURB_KEYS
4490 /* if they set it to "0" we disable key traversal randomization completely */
4491 if (strEQ(env_pv,"0")) {
4492 PL_hash_rand_bits_enabled= 0;
4494 /* otherwise switch to deterministic mode */
4495 PL_hash_rand_bits_enabled= 2;
4498 /* ignore a leading 0x... if it is there */
4499 if (env_pv[0] == '0' && env_pv[1] == 'x')
4502 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4503 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4504 if ( isXDIGIT(*env_pv)) {
4505 seed_buffer[i] |= READ_XDIGIT(env_pv);
4508 while (isSPACE(*env_pv))
4511 if (*env_pv && !isXDIGIT(*env_pv)) {
4512 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4514 /* should we check for unparsed crap? */
4515 /* should we warn about unused hex? */
4516 /* should we warn about insufficient hex? */
4519 #endif /* NO_PERL_HASH_ENV */
4521 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4522 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
4525 #ifdef USE_PERL_PERTURB_KEYS
4526 { /* initialize PL_hash_rand_bits from the hash seed.
4527 * This value is highly volatile, it is updated every
4528 * hash insert, and is used as part of hash bucket chain
4529 * randomization and hash iterator randomization. */
4530 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4531 for( i = 0; i < sizeof(UV) ; i++ ) {
4532 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4533 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4536 # ifndef NO_PERL_HASH_ENV
4537 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4539 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4540 PL_hash_rand_bits_enabled= 0;
4541 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4542 PL_hash_rand_bits_enabled= 1;
4543 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4544 PL_hash_rand_bits_enabled= 2;
4546 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4553 #ifdef PERL_GLOBAL_STRUCT
4555 #define PERL_GLOBAL_STRUCT_INIT
4556 #include "opcode.h" /* the ppaddr and check */
4559 Perl_init_global_struct(pTHX)
4561 struct perl_vars *plvarsp = NULL;
4562 # ifdef PERL_GLOBAL_STRUCT
4563 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4564 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4565 PERL_UNUSED_CONTEXT;
4566 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4567 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4568 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4572 plvarsp = PL_VarsPtr;
4573 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4578 # define PERLVAR(prefix,var,type) /**/
4579 # define PERLVARA(prefix,var,n,type) /**/
4580 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4581 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4582 # include "perlvars.h"
4587 # ifdef PERL_GLOBAL_STRUCT
4590 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4591 if (!plvarsp->Gppaddr)
4595 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4596 if (!plvarsp->Gcheck)
4598 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4599 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4601 # ifdef PERL_SET_VARS
4602 PERL_SET_VARS(plvarsp);
4604 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4605 plvarsp->Gsv_placeholder.sv_flags = 0;
4606 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4608 # undef PERL_GLOBAL_STRUCT_INIT
4613 #endif /* PERL_GLOBAL_STRUCT */
4615 #ifdef PERL_GLOBAL_STRUCT
4618 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4620 int veto = plvarsp->Gveto_cleanup;
4622 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4623 PERL_UNUSED_CONTEXT;
4624 # ifdef PERL_GLOBAL_STRUCT
4625 # ifdef PERL_UNSET_VARS
4626 PERL_UNSET_VARS(plvarsp);
4630 free(plvarsp->Gppaddr);
4631 free(plvarsp->Gcheck);
4632 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4638 #endif /* PERL_GLOBAL_STRUCT */
4642 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4643 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4644 * given, and you supply your own implementation.
4646 * The default implementation reads a single env var, PERL_MEM_LOG,
4647 * expecting one or more of the following:
4649 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4650 * 'm' - memlog was PERL_MEM_LOG=1
4651 * 's' - svlog was PERL_SV_LOG=1
4652 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4654 * This makes the logger controllable enough that it can reasonably be
4655 * added to the system perl.
4658 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4659 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4661 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4663 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4664 * writes to. In the default logger, this is settable at runtime.
4666 #ifndef PERL_MEM_LOG_FD
4667 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4670 #ifndef PERL_MEM_LOG_NOIMPL
4672 # ifdef DEBUG_LEAKING_SCALARS
4673 # define SV_LOG_SERIAL_FMT " [%lu]"
4674 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4676 # define SV_LOG_SERIAL_FMT
4677 # define _SV_LOG_SERIAL_ARG(sv)
4681 S_mem_log_common(enum mem_log_type mlt, const UV n,
4682 const UV typesize, const char *type_name, const SV *sv,
4683 Malloc_t oldalloc, Malloc_t newalloc,
4684 const char *filename, const int linenumber,
4685 const char *funcname)
4689 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4691 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4694 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4696 /* We can't use SVs or PerlIO for obvious reasons,
4697 * so we'll use stdio and low-level IO instead. */
4698 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4700 # ifdef HAS_GETTIMEOFDAY
4701 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4702 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4704 gettimeofday(&tv, 0);
4706 # define MEM_LOG_TIME_FMT "%10d: "
4707 # define MEM_LOG_TIME_ARG (int)when
4711 /* If there are other OS specific ways of hires time than
4712 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4713 * probably that they would be used to fill in the struct
4720 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4721 && uv && uv <= PERL_INT_MAX
4725 fd = PERL_MEM_LOG_FD;
4728 if (strchr(pmlenv, 't')) {
4729 len = my_snprintf(buf, sizeof(buf),
4730 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4731 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4735 len = my_snprintf(buf, sizeof(buf),
4736 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4737 " %s = %" IVdf ": %" UVxf "\n",
4738 filename, linenumber, funcname, n, typesize,
4739 type_name, n * typesize, PTR2UV(newalloc));
4742 len = my_snprintf(buf, sizeof(buf),
4743 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4744 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4745 filename, linenumber, funcname, n, typesize,
4746 type_name, n * typesize, PTR2UV(oldalloc),
4750 len = my_snprintf(buf, sizeof(buf),
4751 "free: %s:%d:%s: %" UVxf "\n",
4752 filename, linenumber, funcname,
4757 len = my_snprintf(buf, sizeof(buf),
4758 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
4759 mlt == MLT_NEW_SV ? "new" : "del",
4760 filename, linenumber, funcname,
4761 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4766 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4770 #endif /* !PERL_MEM_LOG_NOIMPL */
4772 #ifndef PERL_MEM_LOG_NOIMPL
4774 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4775 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4777 /* this is suboptimal, but bug compatible. User is providing their
4778 own implementation, but is getting these functions anyway, and they
4779 do nothing. But _NOIMPL users should be able to cope or fix */
4781 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4782 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
4786 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4788 const char *filename, const int linenumber,
4789 const char *funcname)
4791 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
4793 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4794 NULL, NULL, newalloc,
4795 filename, linenumber, funcname);
4800 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4801 Malloc_t oldalloc, Malloc_t newalloc,
4802 const char *filename, const int linenumber,
4803 const char *funcname)
4805 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
4807 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4808 NULL, oldalloc, newalloc,
4809 filename, linenumber, funcname);
4814 Perl_mem_log_free(Malloc_t oldalloc,
4815 const char *filename, const int linenumber,
4816 const char *funcname)
4818 PERL_ARGS_ASSERT_MEM_LOG_FREE;
4820 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4821 filename, linenumber, funcname);
4826 Perl_mem_log_new_sv(const SV *sv,
4827 const char *filename, const int linenumber,
4828 const char *funcname)
4830 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4831 filename, linenumber, funcname);
4835 Perl_mem_log_del_sv(const SV *sv,
4836 const char *filename, const int linenumber,
4837 const char *funcname)
4839 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4840 filename, linenumber, funcname);
4843 #endif /* PERL_MEM_LOG */
4846 =for apidoc quadmath_format_single
4848 C<quadmath_snprintf()> is very strict about its C<format> string and will
4849 fail, returning -1, if the format is invalid. It accepts exactly
4852 C<quadmath_format_single()> checks that the intended single spec looks
4853 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
4854 and has C<Q> before it. This is not a full "printf syntax check",
4857 Returns the format if it is valid, NULL if not.
4859 C<quadmath_format_single()> can and will actually patch in the missing
4860 C<Q>, if necessary. In this case it will return the modified copy of
4861 the format, B<which the caller will need to free.>
4863 See also L</quadmath_format_needed>.
4869 Perl_quadmath_format_single(const char* format)
4873 PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
4875 if (format[0] != '%' || strchr(format + 1, '%'))
4877 len = strlen(format);
4878 /* minimum length three: %Qg */
4879 if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
4881 if (format[len - 2] != 'Q') {
4883 Newx(fixed, len + 1, char);
4884 memcpy(fixed, format, len - 1);
4885 fixed[len - 1] = 'Q';
4886 fixed[len ] = format[len - 1];
4888 return (const char*)fixed;
4895 =for apidoc quadmath_format_needed
4897 C<quadmath_format_needed()> returns true if the C<format> string seems to
4898 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
4899 or returns false otherwise.
4901 The format specifier detection is not complete printf-syntax detection,
4902 but it should catch most common cases.
4904 If true is returned, those arguments B<should> in theory be processed
4905 with C<quadmath_snprintf()>, but in case there is more than one such
4906 format specifier (see L</quadmath_format_single>), and if there is
4907 anything else beyond that one (even just a single byte), they
4908 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
4909 accepting only one format spec, and nothing else.
4910 In this case, the code should probably fail.
4916 Perl_quadmath_format_needed(const char* format)
4918 const char *p = format;
4921 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
4923 while ((q = strchr(p, '%'))) {
4925 if (*q == '+') /* plus */
4927 if (*q == '#') /* alt */
4929 if (*q == '*') /* width */
4933 while (isDIGIT(*q)) q++;
4936 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
4941 while (isDIGIT(*q)) q++;
4943 if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
4952 =for apidoc my_snprintf
4954 The C library C<snprintf> functionality, if available and
4955 standards-compliant (uses C<vsnprintf>, actually). However, if the
4956 C<vsnprintf> is not available, will unfortunately use the unsafe
4957 C<vsprintf> which can overrun the buffer (there is an overrun check,
4958 but that may be too late). Consider using C<sv_vcatpvf> instead, or
4959 getting C<vsnprintf>.
4964 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
4968 PERL_ARGS_ASSERT_MY_SNPRINTF;
4969 #ifndef HAS_VSNPRINTF
4970 PERL_UNUSED_VAR(len);
4972 va_start(ap, format);
4975 const char* qfmt = quadmath_format_single(format);
4976 bool quadmath_valid = FALSE;
4978 /* If the format looked promising, use it as quadmath. */
4979 retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
4981 if (qfmt != format) {
4985 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
4987 quadmath_valid = TRUE;
4992 assert(qfmt == NULL);
4993 /* quadmath_format_single() will return false for example for
4994 * "foo = %g", or simply "%g". We could handle the %g by
4995 * using quadmath for the NV args. More complex cases of
4996 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
4997 * quadmath-valid but has stuff in front).
4999 * Handling the "Q-less" cases right would require walking
5000 * through the va_list and rewriting the format, calling
5001 * quadmath for the NVs, building a new va_list, and then
5002 * letting vsnprintf/vsprintf to take care of the other
5003 * arguments. This may be doable.
5005 * We do not attempt that now. But for paranoia, we here try
5006 * to detect some common (but not all) cases where the
5007 * "Q-less" %[efgaEFGA] formats are present, and die if
5008 * detected. This doesn't fix the problem, but it stops the
5009 * vsnprintf/vsprintf pulling doubles off the va_list when
5010 * __float128 NVs should be pulled off instead.
5012 * If quadmath_format_needed() returns false, we are reasonably
5013 * certain that we can call vnsprintf() or vsprintf() safely. */
5014 if (!quadmath_valid && quadmath_format_needed(format))
5015 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5020 #ifdef HAS_VSNPRINTF
5021 retval = vsnprintf(buffer, len, format, ap);
5023 retval = vsprintf(buffer, format, ap);
5026 /* vsprintf() shows failure with < 0 */
5028 #ifdef HAS_VSNPRINTF
5029 /* vsnprintf() shows failure with >= len */
5031 (len > 0 && (Size_t)retval >= len)
5034 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5039 =for apidoc my_vsnprintf
5041 The C library C<vsnprintf> if available and standards-compliant.
5042 However, if if the C<vsnprintf> is not available, will unfortunately
5043 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5044 overrun check, but that may be too late). Consider using
5045 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5050 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5053 PERL_UNUSED_ARG(buffer);
5054 PERL_UNUSED_ARG(len);
5055 PERL_UNUSED_ARG(format);
5056 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5057 PERL_UNUSED_ARG((void*)ap);
5058 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5065 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5066 Perl_va_copy(ap, apc);
5067 # ifdef HAS_VSNPRINTF
5068 retval = vsnprintf(buffer, len, format, apc);
5070 PERL_UNUSED_ARG(len);
5071 retval = vsprintf(buffer, format, apc);
5075 # ifdef HAS_VSNPRINTF
5076 retval = vsnprintf(buffer, len, format, ap);
5078 PERL_UNUSED_ARG(len);
5079 retval = vsprintf(buffer, format, ap);
5081 #endif /* #ifdef NEED_VA_COPY */
5082 /* vsprintf() shows failure with < 0 */
5084 #ifdef HAS_VSNPRINTF
5085 /* vsnprintf() shows failure with >= len */
5087 (len > 0 && (Size_t)retval >= len)
5090 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5096 Perl_my_clearenv(pTHX)
5099 #if ! defined(PERL_MICRO)
5100 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5102 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5103 # if defined(USE_ENVIRON_ARRAY)
5104 # if defined(USE_ITHREADS)
5105 /* only the parent thread can clobber the process environment */
5106 if (PL_curinterp == aTHX)
5107 # endif /* USE_ITHREADS */
5109 # if ! defined(PERL_USE_SAFE_PUTENV)
5110 if ( !PL_use_safe_putenv) {
5112 if (environ == PL_origenviron)
5113 environ = (char**)safesysmalloc(sizeof(char*));
5115 for (i = 0; environ[i]; i++)
5116 (void)safesysfree(environ[i]);
5119 # else /* PERL_USE_SAFE_PUTENV */
5120 # if defined(HAS_CLEARENV)
5122 # elif defined(HAS_UNSETENV)
5123 int bsiz = 80; /* Most envvar names will be shorter than this. */
5124 char *buf = (char*)safesysmalloc(bsiz);
5125 while (*environ != NULL) {
5126 char *e = strchr(*environ, '=');
5127 int l = e ? e - *environ : (int)strlen(*environ);
5129 (void)safesysfree(buf);
5130 bsiz = l + 1; /* + 1 for the \0. */
5131 buf = (char*)safesysmalloc(bsiz);
5133 memcpy(buf, *environ, l);
5135 (void)unsetenv(buf);
5137 (void)safesysfree(buf);
5138 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5139 /* Just null environ and accept the leakage. */
5141 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5142 # endif /* ! PERL_USE_SAFE_PUTENV */
5144 # endif /* USE_ENVIRON_ARRAY */
5145 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5146 #endif /* PERL_MICRO */
5149 #ifdef PERL_IMPLICIT_CONTEXT
5151 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5152 the global PL_my_cxt_index is incremented, and that value is assigned to
5153 that module's static my_cxt_index (who's address is passed as an arg).
5154 Then, for each interpreter this function is called for, it makes sure a
5155 void* slot is available to hang the static data off, by allocating or
5156 extending the interpreter's PL_my_cxt_list array */
5158 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
5160 Perl_my_cxt_init(pTHX_ int *index, size_t size)
5164 PERL_ARGS_ASSERT_MY_CXT_INIT;
5166 /* this module hasn't been allocated an index yet */
5167 MUTEX_LOCK(&PL_my_ctx_mutex);
5168 *index = PL_my_cxt_index++;
5169 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5172 /* make sure the array is big enough */
5173 if (PL_my_cxt_size <= *index) {
5174 if (PL_my_cxt_size) {
5175 IV new_size = PL_my_cxt_size;
5176 while (new_size <= *index)
5178 Renew(PL_my_cxt_list, new_size, void *);
5179 PL_my_cxt_size = new_size;
5182 PL_my_cxt_size = 16;
5183 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5186 /* newSV() allocates one more than needed */
5187 p = (void*)SvPVX(newSV(size-1));
5188 PL_my_cxt_list[*index] = p;
5189 Zero(p, size, char);
5193 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5196 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5201 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5203 for (index = 0; index < PL_my_cxt_index; index++) {
5204 const char *key = PL_my_cxt_keys[index];
5205 /* try direct pointer compare first - there are chances to success,
5206 * and it's much faster.
5208 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5215 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5221 PERL_ARGS_ASSERT_MY_CXT_INIT;
5223 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5225 /* this module hasn't been allocated an index yet */
5226 MUTEX_LOCK(&PL_my_ctx_mutex);
5227 index = PL_my_cxt_index++;
5228 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5231 /* make sure the array is big enough */
5232 if (PL_my_cxt_size <= index) {
5233 int old_size = PL_my_cxt_size;
5235 if (PL_my_cxt_size) {
5236 IV new_size = PL_my_cxt_size;
5237 while (new_size <= index)
5239 Renew(PL_my_cxt_list, new_size, void *);
5240 Renew(PL_my_cxt_keys, new_size, const char *);
5241 PL_my_cxt_size = new_size;
5244 PL_my_cxt_size = 16;
5245 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5246 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5248 for (i = old_size; i < PL_my_cxt_size; i++) {
5249 PL_my_cxt_keys[i] = 0;
5250 PL_my_cxt_list[i] = 0;
5253 PL_my_cxt_keys[index] = my_cxt_key;
5254 /* newSV() allocates one more than needed */
5255 p = (void*)SvPVX(newSV(size-1));
5256 PL_my_cxt_list[index] = p;
5257 Zero(p, size, char);
5260 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5261 #endif /* PERL_IMPLICIT_CONTEXT */
5264 /* Perl_xs_handshake():
5265 implement the various XS_*_BOOTCHECK macros, which are added to .c
5266 files by ExtUtils::ParseXS, to check that the perl the module was built
5267 with is binary compatible with the running perl.
5270 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5271 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5273 The meaning of the varargs is determined the U32 key arg (which is not
5274 a format string). The fields of key are assembled by using HS_KEY().
5276 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5277 "PerlInterpreter *" and represents the callers context; otherwise it is
5278 of type "CV *", and is the boot xsub's CV.
5280 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5281 for example, and IO.dll was linked with threaded perl524.dll, and both
5282 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5283 successfully can load IO.dll into the process but simultaneously it
5284 loaded an interpreter of a different version into the process, and XS
5285 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5286 use through perl526.dll's my_perl->Istack_base.
5288 v_my_perl cannot be the first arg, since then 'key' will be out of
5289 place in a threaded vs non-threaded mixup; and analyzing the key
5290 number's bitfields won't reveal the problem, since it will be a valid
5291 key (unthreaded perl) on interp side, but croak will report the XS mod's
5292 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5293 it's a threaded perl and an unthreaded XS module, threaded perl will
5294 look at an uninit C stack or an uninit register to get 'key'
5295 (remember that it assumes that the 1st arg is the interp cxt).
5297 'file' is the source filename of the caller.
5301 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5307 #ifdef PERL_IMPLICIT_CONTEXT
5314 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5315 va_start(args, file);
5317 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5318 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5319 if (UNLIKELY(got != need))
5321 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5322 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5323 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5324 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5325 passed to the XS DLL */
5326 #ifdef PERL_IMPLICIT_CONTEXT
5327 xs_interp = (tTHX)v_my_perl;
5331 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5332 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5333 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5334 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5335 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5336 location in the unthreaded perl binary) stored in CV * to figure out if this
5337 Perl_xs_handshake was called by the same pp_entersub */
5338 cv = (CV*)v_my_perl;
5339 xs_spp = (SV***)CvHSCXT(cv);
5341 need = &PL_stack_sp;
5343 if(UNLIKELY(got != need)) {
5344 bad_handshake:/* recycle branch and string from above */
5345 if(got != (void *)HSf_NOCHK)
5346 noperl_die("%s: loadable library and perl binaries are mismatched"
5347 " (got handshake key %p, needed %p)\n",
5351 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5352 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5353 PL_xsubfilename = file; /* so the old name must be restored for
5354 additional XSUBs to register themselves */
5355 /* XSUBs can't be perl lang/perl5db.pl debugged
5356 if (PERLDB_LINE_OR_SAVESRC)
5357 (void)gv_fetchfile(file); */
5360 if(key & HSf_POPMARK) {
5362 { SV **mark = PL_stack_base + ax++;
5364 items = (I32)(SP - MARK);
5368 items = va_arg(args, U32);
5369 ax = va_arg(args, U32);
5373 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5374 if((apiverlen = HS_GETAPIVERLEN(key))) {
5375 char * api_p = va_arg(args, char*);
5376 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5377 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5378 sizeof("v" PERL_API_VERSION_STRING)-1))
5379 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5380 api_p, SVfARG(PL_stack_base[ax + 0]),
5381 "v" PERL_API_VERSION_STRING);
5386 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5387 if((xsverlen = HS_GETXSVERLEN(key)))
5388 S_xs_version_bootcheck(aTHX_
5389 items, ax, va_arg(args, char*), xsverlen);
5397 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5401 const char *vn = NULL;
5402 SV *const module = PL_stack_base[ax];
5404 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5406 if (items >= 2) /* version supplied as bootstrap arg */
5407 sv = PL_stack_base[ax + 1];
5409 /* XXX GV_ADDWARN */
5411 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5412 if (!sv || !SvOK(sv)) {
5414 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5418 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5419 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5420 ? sv : sv_2mortal(new_version(sv));
5421 xssv = upg_version(xssv, 0);
5422 if ( vcmp(pmsv,xssv) ) {
5423 SV *string = vstringify(xssv);
5424 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5425 " does not match ", SVfARG(module), SVfARG(string));
5427 SvREFCNT_dec(string);
5428 string = vstringify(pmsv);
5431 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5434 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5436 SvREFCNT_dec(string);
5438 Perl_sv_2mortal(aTHX_ xpt);
5439 Perl_croak_sv(aTHX_ xpt);
5445 =for apidoc my_strlcat
5447 The C library C<strlcat> if available, or a Perl implementation of it.
5448 This operates on C C<NUL>-terminated strings.
5450 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5451 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5452 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5453 practice this should not happen as it means that either C<size> is incorrect or
5454 that C<dst> is not a proper C<NUL>-terminated string).
5456 Note that C<size> is the full size of the destination buffer and
5457 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5458 room for the C<NUL> should be included in C<size>.
5460 The return value is the total length that C<dst> would have if C<size> is
5461 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5462 C<src>. If C<size> is smaller than the return, the excess was not appended.
5466 Description stolen from http://man.openbsd.org/strlcat.3
5470 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5472 Size_t used, length, copy;
5475 length = strlen(src);
5476 if (size > 0 && used < size - 1) {
5477 copy = (length >= size - used) ? size - used - 1 : length;
5478 memcpy(dst + used, src, copy);
5479 dst[used + copy] = '\0';
5481 return used + length;
5487 =for apidoc my_strlcpy
5489 The C library C<strlcpy> if available, or a Perl implementation of it.
5490 This operates on C C<NUL>-terminated strings.
5492 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5493 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5495 The return value is the total length C<src> would be if the copy completely
5496 succeeded. If it is larger than C<size>, the excess was not copied.
5500 Description stolen from http://man.openbsd.org/strlcpy.3
5504 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5506 Size_t length, copy;
5508 length = strlen(src);
5510 copy = (length >= size) ? size - 1 : length;
5511 memcpy(dst, src, copy);
5519 =for apidoc my_strnlen
5521 The C library C<strnlen> if available, or a Perl implementation of it.
5523 C<my_strnlen()> computes the length of the string, up to C<maxlen>
5524 characters. It will will never attempt to address more than C<maxlen>
5525 characters, making it suitable for use with strings that are not
5526 guaranteed to be NUL-terminated.
5530 Description stolen from http://man.openbsd.org/strnlen.3,
5531 implementation stolen from PostgreSQL.
5535 Perl_my_strnlen(const char *str, Size_t maxlen)
5537 const char *p = str;
5539 PERL_ARGS_ASSERT_MY_STRNLEN;
5541 while(maxlen-- && *p)
5548 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5549 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5550 long _ftol( double ); /* Defined by VC6 C libs. */
5551 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5554 PERL_STATIC_INLINE bool
5555 S_gv_has_usable_name(pTHX_ GV *gv)
5559 && HvENAME(GvSTASH(gv))
5560 && (gvp = (GV **)hv_fetchhek(
5561 GvSTASH(gv), GvNAME_HEK(gv), 0
5567 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5569 SV * const dbsv = GvSVn(PL_DBsub);
5570 const bool save_taint = TAINT_get;
5572 /* When we are called from pp_goto (svp is null),
5573 * we do not care about using dbsv to call CV;
5574 * it's for informational purposes only.
5577 PERL_ARGS_ASSERT_GET_DB_SUB;
5581 if (!PERLDB_SUB_NN) {
5584 if (!svp && !CvLEXICAL(cv)) {
5585 gv_efullname3(dbsv, gv, NULL);
5587 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5588 || strEQ(GvNAME(gv), "END")
5589 || ( /* Could be imported, and old sub redefined. */
5590 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5592 !( (SvTYPE(*svp) == SVt_PVGV)
5593 && (GvCV((const GV *)*svp) == cv)
5594 /* Use GV from the stack as a fallback. */
5595 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5599 /* GV is potentially non-unique, or contain different CV. */
5600 SV * const tmp = newRV(MUTABLE_SV(cv));
5601 sv_setsv(dbsv, tmp);
5605 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5606 sv_catpvs(dbsv, "::");
5607 sv_cathek(dbsv, GvNAME_HEK(gv));
5611 const int type = SvTYPE(dbsv);
5612 if (type < SVt_PVIV && type != SVt_IV)
5613 sv_upgrade(dbsv, SVt_PVIV);
5614 (void)SvIOK_on(dbsv);
5615 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5618 TAINT_IF(save_taint);
5619 #ifdef NO_TAINT_SUPPORT
5620 PERL_UNUSED_VAR(save_taint);
5625 Perl_my_dirfd(DIR * dir) {
5627 /* Most dirfd implementations have problems when passed NULL. */
5632 #elif defined(HAS_DIR_DD_FD)
5635 Perl_croak_nocontext(PL_no_func, "dirfd");
5636 NOT_REACHED; /* NOTREACHED */
5643 #define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
5644 #define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
5647 Perl_my_mkstemp(char *templte) {
5649 STRLEN len = strlen(templte);
5653 PERL_ARGS_ASSERT_MY_MKSTEMP;
5656 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
5657 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
5664 for (i = 1; i <= 6; ++i) {
5665 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
5667 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL, 0600);
5668 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
5676 Perl_get_re_arg(pTHX_ SV *sv) {
5682 sv = MUTABLE_SV(SvRV(sv));
5683 if (SvTYPE(sv) == SVt_REGEXP)
5684 return (REGEXP*) sv;
5691 * This code is derived from drand48() implementation from FreeBSD,
5692 * found in lib/libc/gen/_rand48.c.
5694 * The U64 implementation is original, based on the POSIX
5695 * specification for drand48().
5699 * Copyright (c) 1993 Martin Birgmeier
5700 * All rights reserved.
5702 * You may redistribute unmodified or modified versions of this source
5703 * code provided that the above copyright notice and this and the
5704 * following conditions are retained.
5706 * This software is provided ``as is'', and comes with no warranties
5707 * of any kind. I shall in no event be liable for anything that happens
5708 * to anyone/anything when using this software.
5711 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5713 #ifdef PERL_DRAND48_QUAD
5715 #define DRAND48_MULT UINT64_C(0x5deece66d)
5716 #define DRAND48_ADD 0xb
5717 #define DRAND48_MASK UINT64_C(0xffffffffffff)
5721 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5722 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5723 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5724 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5725 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5726 #define FREEBSD_DRAND48_ADD (0x000b)
5728 const unsigned short _rand48_mult[3] = {
5729 FREEBSD_DRAND48_MULT_0,
5730 FREEBSD_DRAND48_MULT_1,
5731 FREEBSD_DRAND48_MULT_2
5733 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5738 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5740 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5742 #ifdef PERL_DRAND48_QUAD
5743 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5745 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5746 random_state->seed[1] = (U16) seed;
5747 random_state->seed[2] = (U16) (seed >> 16);
5752 Perl_drand48_r(perl_drand48_t *random_state)
5754 PERL_ARGS_ASSERT_DRAND48_R;
5756 #ifdef PERL_DRAND48_QUAD
5757 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5760 return ldexp((double)*random_state, -48);
5766 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5767 + (U32) _rand48_add;
5768 temp[0] = (U16) accu; /* lower 16 bits */
5769 accu >>= sizeof(U16) * 8;
5770 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5771 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5772 temp[1] = (U16) accu; /* middle 16 bits */
5773 accu >>= sizeof(U16) * 8;
5774 accu += _rand48_mult[0] * random_state->seed[2]
5775 + _rand48_mult[1] * random_state->seed[1]
5776 + _rand48_mult[2] * random_state->seed[0];
5777 random_state->seed[0] = temp[0];
5778 random_state->seed[1] = temp[1];
5779 random_state->seed[2] = (U16) accu;
5781 return ldexp((double) random_state->seed[0], -48) +
5782 ldexp((double) random_state->seed[1], -32) +
5783 ldexp((double) random_state->seed[2], -16);
5788 #ifdef USE_C_BACKTRACE
5790 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5795 /* abfd is the BFD handle. */
5797 /* bfd_syms is the BFD symbol table. */
5799 /* bfd_text is handle to the the ".text" section of the object file. */
5801 /* Since opening the executable and scanning its symbols is quite
5802 * heavy operation, we remember the filename we used the last time,
5803 * and do the opening and scanning only if the filename changes.
5804 * This removes most (but not all) open+scan cycles. */
5805 const char* fname_prev;
5808 /* Given a dl_info, update the BFD context if necessary. */
5809 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5811 /* BFD open and scan only if the filename changed. */
5812 if (ctx->fname_prev == NULL ||
5813 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5815 bfd_close(ctx->abfd);
5817 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5819 if (bfd_check_format(ctx->abfd, bfd_object)) {
5820 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5821 if (symbol_size > 0) {
5822 Safefree(ctx->bfd_syms);
5823 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5825 bfd_get_section_by_name(ctx->abfd, ".text");
5833 ctx->fname_prev = dl_info->dli_fname;
5837 /* Given a raw frame, try to symbolize it and store
5838 * symbol information (source file, line number) away. */
5839 static void bfd_symbolize(bfd_context* ctx,
5842 STRLEN* symbol_name_size,
5844 STRLEN* source_name_size,
5845 STRLEN* source_line)
5847 *symbol_name = NULL;
5848 *symbol_name_size = 0;
5850 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5852 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5855 unsigned int line = 0;
5856 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5857 ctx->bfd_syms, offset,
5858 &file, &func, &line) &&
5859 file && func && line > 0) {
5860 /* Size and copy the source file, use only
5861 * the basename of the source file.
5863 * NOTE: the basenames are fine for the
5864 * Perl source files, but may not always
5865 * be the best idea for XS files. */
5866 const char *p, *b = NULL;
5867 /* Look for the last slash. */
5868 for (p = file; *p; p++) {
5872 if (b == NULL || *b == 0) {
5875 *source_name_size = p - b + 1;
5876 Newx(*source_name, *source_name_size + 1, char);
5877 Copy(b, *source_name, *source_name_size + 1, char);
5879 *symbol_name_size = strlen(func);
5880 Newx(*symbol_name, *symbol_name_size + 1, char);
5881 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5883 *source_line = line;
5889 #endif /* #ifdef USE_BFD */
5893 /* OS X has no public API for for 'symbolicating' (Apple official term)
5894 * stack addresses to {function_name, source_file, line_number}.
5895 * Good news: there is command line utility atos(1) which does that.
5896 * Bad news 1: it's a command line utility.
5897 * Bad news 2: one needs to have the Developer Tools installed.
5898 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
5900 * To recap: we need to open a pipe for reading for a utility which
5901 * might not exist, or exists in different locations, and then parse
5902 * the output. And since this is all for a low-level API, we cannot
5903 * use high-level stuff. Thanks, Apple. */
5906 /* tool is set to the absolute pathname of the tool to use:
5909 /* format is set to a printf format string used for building
5910 * the external command to run. */
5912 /* unavail is set if e.g. xcrun cannot be found, or something
5913 * else happens that makes getting the backtrace dubious. Note,
5914 * however, that the context isn't persistent, the next call to
5915 * get_c_backtrace() will start from scratch. */
5917 /* fname is the current object file name. */
5919 /* object_base_addr is the base address of the shared object. */
5920 void* object_base_addr;
5923 /* Given |dl_info|, updates the context. If the context has been
5924 * marked unavailable, return immediately. If not but the tool has
5925 * not been set, set it to either "xcrun atos" or "atos" (also set the
5926 * format to use for creating commands for piping), or if neither is
5927 * unavailable (one needs the Developer Tools installed), mark the context
5928 * an unavailable. Finally, update the filename (object name),
5929 * and its base address. */
5931 static void atos_update(atos_context* ctx,
5936 if (ctx->tool == NULL) {
5937 const char* tools[] = {
5941 const char* formats[] = {
5942 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
5943 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
5947 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
5948 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
5949 ctx->tool = tools[i];
5950 ctx->format = formats[i];
5954 if (ctx->tool == NULL) {
5955 ctx->unavail = TRUE;
5959 if (ctx->fname == NULL ||
5960 strNE(dl_info->dli_fname, ctx->fname)) {
5961 ctx->fname = dl_info->dli_fname;
5962 ctx->object_base_addr = dl_info->dli_fbase;
5966 /* Given an output buffer end |p| and its |start|, matches
5967 * for the atos output, extracting the source code location
5968 * and returning non-NULL if possible, returning NULL otherwise. */
5969 static const char* atos_parse(const char* p,
5971 STRLEN* source_name_size,
5972 STRLEN* source_line) {
5973 /* atos() output is something like:
5974 * perl_parse (in miniperl) (perl.c:2314)\n\n".
5975 * We cannot use Perl regular expressions, because we need to
5976 * stay low-level. Therefore here we have a rolled-out version
5977 * of a state machine which matches _backwards_from_the_end_ and
5978 * if there's a success, returns the starts of the filename,
5979 * also setting the filename size and the source line number.
5980 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
5981 const char* source_number_start;
5982 const char* source_name_end;
5983 const char* source_line_end;
5984 const char* close_paren;
5987 /* Skip trailing whitespace. */
5988 while (p > start && isSPACE(*p)) p--;
5989 /* Now we should be at the close paren. */
5990 if (p == start || *p != ')')
5994 /* Now we should be in the line number. */
5995 if (p == start || !isDIGIT(*p))
5997 /* Skip over the digits. */
5998 while (p > start && isDIGIT(*p))
6000 /* Now we should be at the colon. */
6001 if (p == start || *p != ':')
6003 source_number_start = p + 1;
6004 source_name_end = p; /* Just beyond the end. */
6006 /* Look for the open paren. */
6007 while (p > start && *p != '(')
6012 *source_name_size = source_name_end - p;
6013 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6014 && source_line_end == close_paren
6015 && uv <= PERL_INT_MAX
6017 *source_line = (STRLEN)uv;
6023 /* Given a raw frame, read a pipe from the symbolicator (that's the
6024 * technical term) atos, reads the result, and parses the source code
6025 * location. We must stay low-level, so we use snprintf(), pipe(),
6026 * and fread(), and then also parse the output ourselves. */
6027 static void atos_symbolize(atos_context* ctx,
6030 STRLEN* source_name_size,
6031 STRLEN* source_line)
6039 /* Simple security measure: if there's any funny business with
6040 * the object name (used as "-o '%s'" ), leave since at least
6041 * partially the user controls it. */
6042 for (p = ctx->fname; *p; p++) {
6043 if (*p == '\'' || isCNTRL(*p)) {
6044 ctx->unavail = TRUE;
6048 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6049 ctx->fname, ctx->object_base_addr, raw_frame);
6050 if (cnt < sizeof(cmd)) {
6051 /* Undo nostdio.h #defines that disable stdio.
6052 * This is somewhat naughty, but is used elsewhere
6053 * in the core, and affects only OS X. */
6058 FILE* fp = popen(cmd, "r");
6059 /* At the moment we open a new pipe for each stack frame.
6060 * This is naturally somewhat slow, but hopefully generating
6061 * stack traces is never going to in a performance critical path.
6063 * We could play tricks with atos by batching the stack
6064 * addresses to be resolved: atos can either take multiple
6065 * addresses from the command line, or read addresses from
6066 * a file (though the mess of creating temporary files would
6067 * probably negate much of any possible speedup).
6069 * Normally there are only two objects present in the backtrace:
6070 * perl itself, and the libdyld.dylib. (Note that the object
6071 * filenames contain the full pathname, so perl may not always
6072 * be in the same place.) Whenever the object in the
6073 * backtrace changes, the base address also changes.
6075 * The problem with batching the addresses, though, would be
6076 * matching the results with the addresses: the parsing of
6077 * the results is already painful enough with a single address. */
6080 UV cnt = fread(out, 1, sizeof(out), fp);
6081 if (cnt < sizeof(out)) {
6082 const char* p = atos_parse(out + cnt - 1, out,
6087 *source_name_size, char);
6088 Copy(p, *source_name,
6089 *source_name_size, char);
6097 #endif /* #ifdef PERL_DARWIN */
6100 =for apidoc get_c_backtrace
6102 Collects the backtrace (aka "stacktrace") into a single linear
6103 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6105 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6106 returning at most C<depth> frames.
6112 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6114 /* Note that here we must stay as low-level as possible: Newx(),
6115 * Copy(), Safefree(); since we may be called from anywhere,
6116 * so we should avoid higher level constructs like SVs or AVs.
6118 * Since we are using safesysmalloc() via Newx(), don't try
6119 * getting backtrace() there, unless you like deep recursion. */
6121 /* Currently only implemented with backtrace() and dladdr(),
6122 * for other platforms NULL is returned. */
6124 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6125 /* backtrace() is available via <execinfo.h> in glibc and in most
6126 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6128 /* We try fetching this many frames total, but then discard
6129 * the |skip| first ones. For the remaining ones we will try
6130 * retrieving more information with dladdr(). */
6131 int try_depth = skip + depth;
6133 /* The addresses (program counters) returned by backtrace(). */
6136 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6139 /* Sizes _including_ the terminating \0 of the object name
6140 * and symbol name strings. */
6141 STRLEN* object_name_sizes;
6142 STRLEN* symbol_name_sizes;
6145 /* The symbol names comes either from dli_sname,
6146 * or if using BFD, they can come from BFD. */
6147 char** symbol_names;
6150 /* The source code location information. Dug out with e.g. BFD. */
6151 char** source_names;
6152 STRLEN* source_name_sizes;
6153 STRLEN* source_lines;
6155 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6156 int got_depth; /* How many frames were returned from backtrace(). */
6157 UV frame_count = 0; /* How many frames we return. */
6158 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6161 bfd_context bfd_ctx;
6164 atos_context atos_ctx;
6167 /* Here are probably possibilities for optimizing. We could for
6168 * example have a struct that contains most of these and then
6169 * allocate |try_depth| of them, saving a bunch of malloc calls.
6170 * Note, however, that |frames| could not be part of that struct
6171 * because backtrace() will want an array of just them. Also be
6172 * careful about the name strings. */
6173 Newx(raw_frames, try_depth, void*);
6174 Newx(dl_infos, try_depth, Dl_info);
6175 Newx(object_name_sizes, try_depth, STRLEN);
6176 Newx(symbol_name_sizes, try_depth, STRLEN);
6177 Newx(source_names, try_depth, char*);
6178 Newx(source_name_sizes, try_depth, STRLEN);
6179 Newx(source_lines, try_depth, STRLEN);
6181 Newx(symbol_names, try_depth, char*);
6184 /* Get the raw frames. */
6185 got_depth = (int)backtrace(raw_frames, try_depth);
6187 /* We use dladdr() instead of backtrace_symbols() because we want
6188 * the full details instead of opaque strings. This is useful for
6189 * two reasons: () the details are needed for further symbolic
6190 * digging, for example in OS X (2) by having the details we fully
6191 * control the output, which in turn is useful when more platforms
6192 * are added: we can keep out output "portable". */
6194 /* We want a single linear allocation, which can then be freed
6195 * with a single swoop. We will do the usual trick of first
6196 * walking over the structure and seeing how much we need to
6197 * allocate, then allocating, and then walking over the structure
6198 * the second time and populating it. */
6200 /* First we must compute the total size of the buffer. */
6201 total_bytes = sizeof(Perl_c_backtrace_header);
6202 if (got_depth > skip) {
6205 bfd_init(); /* Is this safe to call multiple times? */
6206 Zero(&bfd_ctx, 1, bfd_context);
6209 Zero(&atos_ctx, 1, atos_context);
6211 for (i = skip; i < try_depth; i++) {
6212 Dl_info* dl_info = &dl_infos[i];
6214 object_name_sizes[i] = 0;
6215 source_names[i] = NULL;
6216 source_name_sizes[i] = 0;
6217 source_lines[i] = 0;
6219 /* Yes, zero from dladdr() is failure. */
6220 if (dladdr(raw_frames[i], dl_info)) {
6221 total_bytes += sizeof(Perl_c_backtrace_frame);
6223 object_name_sizes[i] =
6224 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6225 symbol_name_sizes[i] =
6226 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6228 bfd_update(&bfd_ctx, dl_info);
6229 bfd_symbolize(&bfd_ctx, raw_frames[i],
6231 &symbol_name_sizes[i],
6233 &source_name_sizes[i],
6237 atos_update(&atos_ctx, dl_info);
6238 atos_symbolize(&atos_ctx,
6241 &source_name_sizes[i],
6245 /* Plus ones for the terminating \0. */
6246 total_bytes += object_name_sizes[i] + 1;
6247 total_bytes += symbol_name_sizes[i] + 1;
6248 total_bytes += source_name_sizes[i] + 1;
6256 Safefree(bfd_ctx.bfd_syms);
6260 /* Now we can allocate and populate the result buffer. */
6261 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6262 Zero(bt, total_bytes, char);
6263 bt->header.frame_count = frame_count;
6264 bt->header.total_bytes = total_bytes;
6265 if (frame_count > 0) {
6266 Perl_c_backtrace_frame* frame = bt->frame_info;
6267 char* name_base = (char *)(frame + frame_count);
6268 char* name_curr = name_base; /* Outputting the name strings here. */
6270 for (i = skip; i < skip + frame_count; i++) {
6271 Dl_info* dl_info = &dl_infos[i];
6273 frame->addr = raw_frames[i];
6274 frame->object_base_addr = dl_info->dli_fbase;
6275 frame->symbol_addr = dl_info->dli_saddr;
6277 /* Copies a string, including the \0, and advances the name_curr.
6278 * Also copies the start and the size to the frame. */
6279 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6281 Copy(src, name_curr, size, char); \
6282 frame->doffset = name_curr - (char*)bt; \
6283 frame->dsize = size; \
6284 name_curr += size; \
6287 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6289 object_name_size, object_name_sizes[i]);
6292 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6294 symbol_name_size, symbol_name_sizes[i]);
6295 Safefree(symbol_names[i]);
6297 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6299 symbol_name_size, symbol_name_sizes[i]);
6302 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6304 source_name_size, source_name_sizes[i]);
6305 Safefree(source_names[i]);
6307 #undef PERL_C_BACKTRACE_STRCPY
6309 frame->source_line_number = source_lines[i];
6313 assert(total_bytes ==
6314 (UV)(sizeof(Perl_c_backtrace_header) +
6315 frame_count * sizeof(Perl_c_backtrace_frame) +
6316 name_curr - name_base));
6319 Safefree(symbol_names);
6321 bfd_close(bfd_ctx.abfd);
6324 Safefree(source_lines);
6325 Safefree(source_name_sizes);
6326 Safefree(source_names);
6327 Safefree(symbol_name_sizes);
6328 Safefree(object_name_sizes);
6329 /* Assuming the strings returned by dladdr() are pointers
6330 * to read-only static memory (the object file), so that
6331 * they do not need freeing (and cannot be). */
6333 Safefree(raw_frames);
6336 PERL_UNUSED_ARGV(depth);
6337 PERL_UNUSED_ARGV(skip);
6343 =for apidoc free_c_backtrace
6345 Deallocates a backtrace received from get_c_bracktrace.
6351 =for apidoc get_c_backtrace_dump
6353 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6354 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6356 The appended output looks like:
6359 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6360 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6363 The fields are tab-separated. The first column is the depth (zero
6364 being the innermost non-skipped frame). In the hex:offset, the hex is
6365 where the program counter was in C<S_parse_body>, and the :offset (might
6366 be missing) tells how much inside the C<S_parse_body> the program counter was.
6368 The C<util.c:1716> is the source code file and line number.
6370 The F</usr/bin/perl> is obvious (hopefully).
6372 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6373 if the platform doesn't support retrieving the information;
6374 if the binary is missing the debug information;
6375 if the optimizer has transformed the code by for example inlining.
6381 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6383 Perl_c_backtrace* bt;
6385 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6387 Perl_c_backtrace_frame* frame;
6388 SV* dsv = newSVpvs("");
6390 for (i = 0, frame = bt->frame_info;
6391 i < bt->header.frame_count; i++, frame++) {
6392 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6393 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6394 /* Symbol (function) names might disappear without debug info.
6396 * The source code location might disappear in case of the
6397 * optimizer inlining or otherwise rearranging the code. */
6398 if (frame->symbol_addr) {
6399 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6401 ((char*)frame->addr - (char*)frame->symbol_addr));
6403 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6404 frame->symbol_name_size &&
6405 frame->symbol_name_offset ?
6406 (char*)bt + frame->symbol_name_offset : "-");
6407 if (frame->source_name_size &&
6408 frame->source_name_offset &&
6409 frame->source_line_number) {
6410 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6411 (char*)bt + frame->source_name_offset,
6412 (UV)frame->source_line_number);
6414 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6416 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6417 frame->object_name_size &&
6418 frame->object_name_offset ?
6419 (char*)bt + frame->object_name_offset : "-");
6420 /* The frame->object_base_addr is not output,
6421 * but it is used for symbolizing/symbolicating. */
6422 sv_catpvs(dsv, "\n");
6425 Perl_free_c_backtrace(bt);
6434 =for apidoc dump_c_backtrace
6436 Dumps the C backtrace to the given C<fp>.
6438 Returns true if a backtrace could be retrieved, false if not.
6444 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6448 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6450 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6453 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6459 #endif /* #ifdef USE_C_BACKTRACE */
6461 #ifdef PERL_TSA_ACTIVE
6463 /* pthread_mutex_t and perl_mutex are typedef equivalent
6464 * so casting the pointers is fine. */
6466 int perl_tsa_mutex_lock(perl_mutex* mutex)
6468 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6471 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6473 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6476 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6478 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6486 /* log a sub call or return */
6489 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6497 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6500 HEK *hek = CvNAME_HEK(cv);
6501 func = HEK_KEY(hek);
6507 start = (const COP *)CvSTART(cv);
6508 file = CopFILE(start);
6509 line = CopLINE(start);
6510 stash = CopSTASHPV(start);
6513 PERL_SUB_ENTRY(func, file, line, stash);
6516 PERL_SUB_RETURN(func, file, line, stash);
6521 /* log a require file loading/loaded */
6524 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6526 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6529 PERL_LOADING_FILE(name);
6532 PERL_LOADED_FILE(name);
6537 /* log an op execution */
6540 Perl_dtrace_probe_op(pTHX_ const OP *op)
6542 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6544 PERL_OP_ENTRY(OP_NAME(op));
6548 /* log a compile/run phase change */
6551 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6553 const char *ph_old = PL_phase_names[PL_phase];
6554 const char *ph_new = PL_phase_names[phase];
6556 PERL_PHASE_CHANGE(ph_new, ph_old);
6562 * ex: set ts=8 sts=4 sw=4 et: