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
217 #if !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) && !defined(PERL_MICRO)
218 Malloc_t PerlMem_realloc();
219 #endif /* !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) */
226 ptr = safesysmalloc(size);
230 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
231 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
233 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
235 struct perl_memory_debug_header *const header
236 = (struct perl_memory_debug_header *)where;
238 # ifdef PERL_TRACK_MEMPOOL
239 if (header->interpreter != aTHX) {
240 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
241 header->interpreter, aTHX);
243 assert(header->next->prev == header);
244 assert(header->prev->next == header);
246 if (header->size > size) {
247 const MEM_SIZE freed_up = header->size - size;
248 char *start_of_freed = ((char *)where) + size;
249 PoisonFree(start_of_freed, freed_up, char);
259 if ((SSize_t)size < 0)
260 Perl_croak_nocontext("panic: realloc, size=%" UVuf, (UV)size);
262 #ifdef PERL_DEBUG_READONLY_COW
263 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
264 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
265 perror("mmap failed");
268 Copy(where,ptr,oldsize < size ? oldsize : size,char);
269 if (munmap(where, oldsize)) {
270 perror("munmap failed");
274 ptr = (Malloc_t)PerlMem_realloc(where,size);
276 PERL_ALLOC_CHECK(ptr);
278 /* MUST do this fixup first, before doing ANYTHING else, as anything else
279 might allocate memory/free/move memory, and until we do the fixup, it
280 may well be chasing (and writing to) free memory. */
282 #ifdef PERL_TRACK_MEMPOOL
283 struct perl_memory_debug_header *const header
284 = (struct perl_memory_debug_header *)ptr;
287 if (header->size < size) {
288 const MEM_SIZE fresh = size - header->size;
289 char *start_of_fresh = ((char *)ptr) + size;
290 PoisonNew(start_of_fresh, fresh, char);
294 maybe_protect_rw(header->next);
295 header->next->prev = header;
296 maybe_protect_ro(header->next);
297 maybe_protect_rw(header->prev);
298 header->prev->next = header;
299 maybe_protect_ro(header->prev);
301 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
304 /* In particular, must do that fixup above before logging anything via
305 *printf(), as it can reallocate memory, which can cause SEGVs. */
307 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
308 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
315 #ifndef ALWAYS_NEED_THX
328 /* safe version of system's free() */
331 Perl_safesysfree(Malloc_t where)
333 #ifdef ALWAYS_NEED_THX
336 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
339 Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
341 struct perl_memory_debug_header *const header
342 = (struct perl_memory_debug_header *)where_intrn;
345 const MEM_SIZE size = header->size;
347 # ifdef PERL_TRACK_MEMPOOL
348 if (header->interpreter != aTHX) {
349 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
350 header->interpreter, aTHX);
353 Perl_croak_nocontext("panic: duplicate free");
356 Perl_croak_nocontext("panic: bad free, header->next==NULL");
357 if (header->next->prev != header || header->prev->next != header) {
358 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
359 "header=%p, ->prev->next=%p",
360 header->next->prev, header,
363 /* Unlink us from the chain. */
364 maybe_protect_rw(header->next);
365 header->next->prev = header->prev;
366 maybe_protect_ro(header->next);
367 maybe_protect_rw(header->prev);
368 header->prev->next = header->next;
369 maybe_protect_ro(header->prev);
370 maybe_protect_rw(header);
372 PoisonNew(where_intrn, size, char);
374 /* Trigger the duplicate free warning. */
377 # ifdef PERL_DEBUG_READONLY_COW
378 if (munmap(where_intrn, size)) {
379 perror("munmap failed");
385 Malloc_t where_intrn = where;
387 #ifndef PERL_DEBUG_READONLY_COW
388 PerlMem_free(where_intrn);
393 /* safe version of system's calloc() */
396 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
398 #ifdef ALWAYS_NEED_THX
402 #if defined(USE_MDH) || defined(DEBUGGING)
403 MEM_SIZE total_size = 0;
406 /* Even though calloc() for zero bytes is strange, be robust. */
407 if (size && (count <= MEM_SIZE_MAX / size)) {
408 #if defined(USE_MDH) || defined(DEBUGGING)
409 total_size = size * count;
415 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
416 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
421 if ((SSize_t)size < 0 || (SSize_t)count < 0)
422 Perl_croak_nocontext("panic: calloc, size=%" UVuf ", count=%" UVuf,
423 (UV)size, (UV)count);
425 #ifdef PERL_DEBUG_READONLY_COW
426 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
427 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
428 perror("mmap failed");
431 #elif defined(PERL_TRACK_MEMPOOL)
432 /* Have to use malloc() because we've added some space for our tracking
434 /* malloc(0) is non-portable. */
435 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
437 /* Use calloc() because it might save a memset() if the memory is fresh
438 and clean from the OS. */
440 ptr = (Malloc_t)PerlMem_calloc(count, size);
441 else /* calloc(0) is non-portable. */
442 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
444 PERL_ALLOC_CHECK(ptr);
445 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));
449 struct perl_memory_debug_header *const header
450 = (struct perl_memory_debug_header *)ptr;
452 # ifndef PERL_DEBUG_READONLY_COW
453 memset((void*)ptr, 0, total_size);
455 # ifdef PERL_TRACK_MEMPOOL
456 header->interpreter = aTHX;
457 /* Link us into the list. */
458 header->prev = &PL_memory_debug_header;
459 header->next = PL_memory_debug_header.next;
460 PL_memory_debug_header.next = header;
461 maybe_protect_rw(header->next);
462 header->next->prev = header;
463 maybe_protect_ro(header->next);
464 # ifdef PERL_DEBUG_READONLY_COW
465 header->readonly = 0;
469 header->size = total_size;
471 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
477 #ifndef ALWAYS_NEED_THX
486 /* These must be defined when not using Perl's malloc for binary
491 Malloc_t Perl_malloc (MEM_SIZE nbytes)
493 #ifdef PERL_IMPLICIT_SYS
496 return (Malloc_t)PerlMem_malloc(nbytes);
499 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
501 #ifdef PERL_IMPLICIT_SYS
504 return (Malloc_t)PerlMem_calloc(elements, size);
507 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
509 #ifdef PERL_IMPLICIT_SYS
512 return (Malloc_t)PerlMem_realloc(where, nbytes);
515 Free_t Perl_mfree (Malloc_t where)
517 #ifdef PERL_IMPLICIT_SYS
525 /* copy a string up to some (non-backslashed) delimiter, if any.
526 * With allow_escape, converts \<delimiter> to <delimiter>, while leaves
527 * \<non-delimiter> as-is.
528 * Returns the position in the src string of the closing delimiter, if
529 * any, or returns fromend otherwise.
530 * This is the internal implementation for Perl_delimcpy and
531 * Perl_delimcpy_no_escape.
535 S_delimcpy_intern(char *to, const char *toend, const char *from,
536 const char *fromend, int delim, I32 *retlen,
537 const bool allow_escape)
541 PERL_ARGS_ASSERT_DELIMCPY;
543 for (tolen = 0; from < fromend; from++, tolen++) {
544 if (allow_escape && *from == '\\' && from + 1 < fromend) {
545 if (from[1] != delim) {
552 else if (*from == delim)
564 Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
566 PERL_ARGS_ASSERT_DELIMCPY;
568 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 1);
572 Perl_delimcpy_no_escape(char *to, const char *toend, const char *from,
573 const char *fromend, int delim, I32 *retlen)
575 PERL_ARGS_ASSERT_DELIMCPY_NO_ESCAPE;
577 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 0);
581 =head1 Miscellaneous Functions
583 =for apidoc Am|char *|ninstr|char * big|char * bigend|char * little|char * little_end
585 Find the first (leftmost) occurrence of a sequence of bytes within another
586 sequence. This is the Perl version of C<strstr()>, extended to handle
587 arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
588 is what the initial C<n> in the function name stands for; some systems have an
589 equivalent, C<memmem()>, but with a somewhat different API).
591 Another way of thinking about this function is finding a needle in a haystack.
592 C<big> points to the first byte in the haystack. C<big_end> points to one byte
593 beyond the final byte in the haystack. C<little> points to the first byte in
594 the needle. C<little_end> points to one byte beyond the final byte in the
595 needle. All the parameters must be non-C<NULL>.
597 The function returns C<NULL> if there is no occurrence of C<little> within
598 C<big>. If C<little> is the empty string, C<big> is returned.
600 Because this function operates at the byte level, and because of the inherent
601 characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
602 needle and the haystack are strings with the same UTF-8ness, but not if the
610 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
612 PERL_ARGS_ASSERT_NINSTR;
615 return ninstr(big, bigend, little, lend);
621 const char first = *little;
622 bigend -= lend - little++;
624 while (big <= bigend) {
625 if (*big++ == first) {
627 for (x=big,s=little; s < lend; x++,s++) {
631 return (char*)(big-1);
642 =head1 Miscellaneous Functions
644 =for apidoc Am|char *|rninstr|char * big|char * bigend|char * little|char * little_end
646 Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
647 sequence of bytes within another sequence, returning C<NULL> if there is no
655 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
658 const I32 first = *little;
659 const char * const littleend = lend;
661 PERL_ARGS_ASSERT_RNINSTR;
663 if (little >= littleend)
664 return (char*)bigend;
666 big = bigend - (littleend - little++);
667 while (big >= bigbeg) {
671 for (x=big+2,s=little; s < littleend; /**/ ) {
680 return (char*)(big+1);
685 /* As a space optimization, we do not compile tables for strings of length
686 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
687 special-cased in fbm_instr().
689 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
692 =head1 Miscellaneous Functions
694 =for apidoc fbm_compile
696 Analyses the string in order to make fast searches on it using C<fbm_instr()>
697 -- the Boyer-Moore algorithm.
703 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
710 PERL_DEB( STRLEN rarest = 0 );
712 PERL_ARGS_ASSERT_FBM_COMPILE;
714 if (isGV_with_GP(sv) || SvROK(sv))
720 if (flags & FBMcf_TAIL) {
721 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
722 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
723 if (mg && mg->mg_len >= 0)
726 if (!SvPOK(sv) || SvNIOKp(sv))
727 s = (U8*)SvPV_force_mutable(sv, len);
728 else s = (U8 *)SvPV_mutable(sv, len);
729 if (len == 0) /* TAIL might be on a zero-length string. */
731 SvUPGRADE(sv, SVt_PVMG);
735 /* add PERL_MAGIC_bm magic holding the FBM lookup table */
737 assert(!mg_find(sv, PERL_MAGIC_bm));
738 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
742 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
744 const U8 mlen = (len>255) ? 255 : (U8)len;
745 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
748 Newx(table, 256, U8);
749 memset((void*)table, mlen, 256);
750 mg->mg_ptr = (char *)table;
753 s += len - 1; /* last char */
756 if (table[*s] == mlen)
762 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
763 for (i = 0; i < len; i++) {
764 if (PL_freq[s[i]] < frequency) {
765 PERL_DEB( rarest = i );
766 frequency = PL_freq[s[i]];
769 BmUSEFUL(sv) = 100; /* Initial value */
770 ((XPVNV*)SvANY(sv))->xnv_u.xnv_bm_tail = cBOOL(flags & FBMcf_TAIL);
771 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %" UVuf "\n",
772 s[rarest], (UV)rarest));
777 =for apidoc fbm_instr
779 Returns the location of the SV in the string delimited by C<big> and
780 C<bigend> (C<bigend>) is the char following the last char).
781 It returns C<NULL> if the string can't be found. The C<sv>
782 does not have to be C<fbm_compiled>, but the search will not be as fast
787 If SvTAIL(littlestr) is true, a fake "\n" was appended to to the string
788 during FBM compilation due to FBMcf_TAIL in flags. It indicates that
789 the littlestr must be anchored to the end of bigstr (or to any \n if
792 E.g. The regex compiler would compile /abc/ to a littlestr of "abc",
793 while /abc$/ compiles to "abc\n" with SvTAIL() true.
795 A littlestr of "abc", !SvTAIL matches as /abc/;
796 a littlestr of "ab\n", SvTAIL matches as:
797 without FBMrf_MULTILINE: /ab\n?\z/
798 with FBMrf_MULTILINE: /ab\n/ || /ab\z/;
800 (According to Ilya from 1999; I don't know if this is still true, DAPM 2015):
801 "If SvTAIL is actually due to \Z or \z, this gives false positives
807 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
811 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
812 STRLEN littlelen = l;
813 const I32 multiline = flags & FBMrf_MULTILINE;
814 bool valid = SvVALID(littlestr);
815 bool tail = valid ? cBOOL(SvTAIL(littlestr)) : FALSE;
817 PERL_ARGS_ASSERT_FBM_INSTR;
819 if ((STRLEN)(bigend - big) < littlelen) {
821 && ((STRLEN)(bigend - big) == littlelen - 1)
823 || (*big == *little &&
824 memEQ((char *)big, (char *)little, littlelen - 1))))
829 switch (littlelen) { /* Special cases for 0, 1 and 2 */
831 return (char*)big; /* Cannot be SvTAIL! */
834 if (tail && !multiline) /* Anchor only! */
835 /* [-1] is safe because we know that bigend != big. */
836 return (char *) (bigend - (bigend[-1] == '\n'));
838 s = (unsigned char *)memchr((void*)big, *little, bigend-big);
842 return (char *) bigend;
846 if (tail && !multiline) {
847 /* a littlestr with SvTAIL must be of the form "X\n" (where X
848 * is a single char). It is anchored, and can only match
849 * "....X\n" or "....X" */
850 if (bigend[-2] == *little && bigend[-1] == '\n')
851 return (char*)bigend - 2;
852 if (bigend[-1] == *little)
853 return (char*)bigend - 1;
858 /* memchr() is likely to be very fast, possibly using whatever
859 * hardware support is available, such as checking a whole
860 * cache line in one instruction.
861 * So for a 2 char pattern, calling memchr() is likely to be
862 * faster than running FBM, or rolling our own. The previous
863 * version of this code was roll-your-own which typically
864 * only needed to read every 2nd char, which was good back in
865 * the day, but no longer.
867 unsigned char c1 = little[0];
868 unsigned char c2 = little[1];
870 /* *** for all this case, bigend points to the last char,
871 * not the trailing \0: this makes the conditions slightly
877 /* do a quick test for c1 before calling memchr();
878 * this avoids the expensive fn call overhead when
879 * there are lots of c1's */
880 if (LIKELY(*s != c1)) {
882 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
889 /* failed; try searching for c2 this time; that way
890 * we don't go pathologically slow when the string
891 * consists mostly of c1's or vice versa.
896 s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
904 /* c1, c2 the same */
914 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
915 if (!s || s >= bigend)
922 /* failed to find 2 chars; try anchored match at end without
924 if (tail && bigend[0] == little[0])
925 return (char *)bigend;
930 break; /* Only lengths 0 1 and 2 have special-case code. */
933 if (tail && !multiline) { /* tail anchored? */
934 s = bigend - littlelen;
935 if (s >= big && bigend[-1] == '\n' && *s == *little
936 /* Automatically of length > 2 */
937 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
939 return (char*)s; /* how sweet it is */
942 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
944 return (char*)s + 1; /* how sweet it is */
950 /* not compiled; use Perl_ninstr() instead */
951 char * const b = ninstr((char*)big,(char*)bigend,
952 (char*)little, (char*)little + littlelen);
954 assert(!tail); /* valid => FBM; tail only set on SvVALID SVs */
959 if (littlelen > (STRLEN)(bigend - big))
963 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
964 const unsigned char *oldlittle;
968 --littlelen; /* Last char found by table lookup */
971 little += littlelen; /* last char */
974 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
975 const unsigned char lastc = *little;
979 if ((tmp = table[*s])) {
980 /* *s != lastc; earliest position it could match now is
981 * tmp slots further on */
982 if ((s += tmp) >= bigend)
984 if (LIKELY(*s != lastc)) {
986 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
996 /* hand-rolled strncmp(): less expensive than calling the
997 * real function (maybe???) */
999 unsigned char * const olds = s;
1004 if (*--s == *--little)
1006 s = olds + 1; /* here we pay the price for failure */
1008 if (s < bigend) /* fake up continue to outer loop */
1018 && memEQ((char *)(bigend - littlelen),
1019 (char *)(oldlittle - littlelen), littlelen) )
1020 return (char*)bigend - littlelen;
1025 /* copy a string to a safe spot */
1028 =head1 Memory Management
1032 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1033 string which is a duplicate of C<pv>. The size of the string is
1034 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1035 characters and must have a trailing C<NUL>. The memory allocated for the new
1036 string can be freed with the C<Safefree()> function.
1038 On some platforms, Windows for example, all allocated memory owned by a thread
1039 is deallocated when that thread ends. So if you need that not to happen, you
1040 need to use the shared memory functions, such as C<L</savesharedpv>>.
1046 Perl_savepv(pTHX_ const char *pv)
1048 PERL_UNUSED_CONTEXT;
1053 const STRLEN pvlen = strlen(pv)+1;
1054 Newx(newaddr, pvlen, char);
1055 return (char*)memcpy(newaddr, pv, pvlen);
1059 /* same thing but with a known length */
1064 Perl's version of what C<strndup()> would be if it existed. Returns a
1065 pointer to a newly allocated string which is a duplicate of the first
1066 C<len> bytes from C<pv>, plus a trailing
1067 C<NUL> byte. The memory allocated for
1068 the new string can be freed with the C<Safefree()> function.
1070 On some platforms, Windows for example, all allocated memory owned by a thread
1071 is deallocated when that thread ends. So if you need that not to happen, you
1072 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1078 Perl_savepvn(pTHX_ const char *pv, I32 len)
1081 PERL_UNUSED_CONTEXT;
1085 Newx(newaddr,len+1,char);
1086 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1088 /* might not be null terminated */
1089 newaddr[len] = '\0';
1090 return (char *) CopyD(pv,newaddr,len,char);
1093 return (char *) ZeroD(newaddr,len+1,char);
1098 =for apidoc savesharedpv
1100 A version of C<savepv()> which allocates the duplicate string in memory
1101 which is shared between threads.
1106 Perl_savesharedpv(pTHX_ const char *pv)
1111 PERL_UNUSED_CONTEXT;
1116 pvlen = strlen(pv)+1;
1117 newaddr = (char*)PerlMemShared_malloc(pvlen);
1121 return (char*)memcpy(newaddr, pv, pvlen);
1125 =for apidoc savesharedpvn
1127 A version of C<savepvn()> which allocates the duplicate string in memory
1128 which is shared between threads. (With the specific difference that a C<NULL>
1129 pointer is not acceptable)
1134 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1136 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1138 PERL_UNUSED_CONTEXT;
1139 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1144 newaddr[len] = '\0';
1145 return (char*)memcpy(newaddr, pv, len);
1149 =for apidoc savesvpv
1151 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1152 the passed in SV using C<SvPV()>
1154 On some platforms, Windows for example, all allocated memory owned by a thread
1155 is deallocated when that thread ends. So if you need that not to happen, you
1156 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1162 Perl_savesvpv(pTHX_ SV *sv)
1165 const char * const pv = SvPV_const(sv, len);
1168 PERL_ARGS_ASSERT_SAVESVPV;
1171 Newx(newaddr,len,char);
1172 return (char *) CopyD(pv,newaddr,len,char);
1176 =for apidoc savesharedsvpv
1178 A version of C<savesharedpv()> which allocates the duplicate string in
1179 memory which is shared between threads.
1185 Perl_savesharedsvpv(pTHX_ SV *sv)
1188 const char * const pv = SvPV_const(sv, len);
1190 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1192 return savesharedpvn(pv, len);
1195 /* the SV for Perl_form() and mess() is not kept in an arena */
1203 if (PL_phase != PERL_PHASE_DESTRUCT)
1204 return newSVpvs_flags("", SVs_TEMP);
1209 /* Create as PVMG now, to avoid any upgrading later */
1211 Newxz(any, 1, XPVMG);
1212 SvFLAGS(sv) = SVt_PVMG;
1213 SvANY(sv) = (void*)any;
1215 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1220 #if defined(PERL_IMPLICIT_CONTEXT)
1222 Perl_form_nocontext(const char* pat, ...)
1227 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1228 va_start(args, pat);
1229 retval = vform(pat, &args);
1233 #endif /* PERL_IMPLICIT_CONTEXT */
1236 =head1 Miscellaneous Functions
1239 Takes a sprintf-style format pattern and conventional
1240 (non-SV) arguments and returns the formatted string.
1242 (char *) Perl_form(pTHX_ const char* pat, ...)
1244 can be used any place a string (char *) is required:
1246 char * s = Perl_form("%d.%d",major,minor);
1248 Uses a single private buffer so if you want to format several strings you
1249 must explicitly copy the earlier strings away (and free the copies when you
1256 Perl_form(pTHX_ const char* pat, ...)
1260 PERL_ARGS_ASSERT_FORM;
1261 va_start(args, pat);
1262 retval = vform(pat, &args);
1268 Perl_vform(pTHX_ const char *pat, va_list *args)
1270 SV * const sv = mess_alloc();
1271 PERL_ARGS_ASSERT_VFORM;
1272 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1277 =for apidoc Am|SV *|mess|const char *pat|...
1279 Take a sprintf-style format pattern and argument list. These are used to
1280 generate a string message. If the message does not end with a newline,
1281 then it will be extended with some indication of the current location
1282 in the code, as described for L</mess_sv>.
1284 Normally, the resulting message is returned in a new mortal SV.
1285 During global destruction a single SV may be shared between uses of
1291 #if defined(PERL_IMPLICIT_CONTEXT)
1293 Perl_mess_nocontext(const char *pat, ...)
1298 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1299 va_start(args, pat);
1300 retval = vmess(pat, &args);
1304 #endif /* PERL_IMPLICIT_CONTEXT */
1307 Perl_mess(pTHX_ const char *pat, ...)
1311 PERL_ARGS_ASSERT_MESS;
1312 va_start(args, pat);
1313 retval = vmess(pat, &args);
1319 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1322 /* Look for curop starting from o. cop is the last COP we've seen. */
1323 /* opnext means that curop is actually the ->op_next of the op we are
1326 PERL_ARGS_ASSERT_CLOSEST_COP;
1328 if (!o || !curop || (
1329 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1333 if (o->op_flags & OPf_KIDS) {
1335 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1338 /* If the OP_NEXTSTATE has been optimised away we can still use it
1339 * the get the file and line number. */
1341 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1342 cop = (const COP *)kid;
1344 /* Keep searching, and return when we've found something. */
1346 new_cop = closest_cop(cop, kid, curop, opnext);
1352 /* Nothing found. */
1358 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1360 Expands a message, intended for the user, to include an indication of
1361 the current location in the code, if the message does not already appear
1364 C<basemsg> is the initial message or object. If it is a reference, it
1365 will be used as-is and will be the result of this function. Otherwise it
1366 is used as a string, and if it already ends with a newline, it is taken
1367 to be complete, and the result of this function will be the same string.
1368 If the message does not end with a newline, then a segment such as C<at
1369 foo.pl line 37> will be appended, and possibly other clauses indicating
1370 the current state of execution. The resulting message will end with a
1373 Normally, the resulting message is returned in a new mortal SV.
1374 During global destruction a single SV may be shared between uses of this
1375 function. If C<consume> is true, then the function is permitted (but not
1376 required) to modify and return C<basemsg> instead of allocating a new SV.
1382 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1386 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1390 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1391 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1392 && grok_atoUV(ws, &wi, NULL)
1393 && wi <= PERL_INT_MAX
1395 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1400 PERL_ARGS_ASSERT_MESS_SV;
1402 if (SvROK(basemsg)) {
1408 sv_setsv(sv, basemsg);
1413 if (SvPOK(basemsg) && consume) {
1418 sv_copypv(sv, basemsg);
1421 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1423 * Try and find the file and line for PL_op. This will usually be
1424 * PL_curcop, but it might be a cop that has been optimised away. We
1425 * can try to find such a cop by searching through the optree starting
1426 * from the sibling of PL_curcop.
1431 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1436 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1437 OutCopFILE(cop), (IV)CopLINE(cop));
1440 /* Seems that GvIO() can be untrustworthy during global destruction. */
1441 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1442 && IoLINES(GvIOp(PL_last_in_gv)))
1445 const bool line_mode = (RsSIMPLE(PL_rs) &&
1446 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1447 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1448 SVfARG(PL_last_in_gv == PL_argvgv
1450 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1451 line_mode ? "line" : "chunk",
1452 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1454 if (PL_phase == PERL_PHASE_DESTRUCT)
1455 sv_catpvs(sv, " during global destruction");
1456 sv_catpvs(sv, ".\n");
1462 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1464 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1465 argument list, respectively. These are used to generate a string message. If
1467 message does not end with a newline, then it will be extended with
1468 some indication of the current location in the code, as described for
1471 Normally, the resulting message is returned in a new mortal SV.
1472 During global destruction a single SV may be shared between uses of
1479 Perl_vmess(pTHX_ const char *pat, va_list *args)
1481 SV * const sv = mess_alloc();
1483 PERL_ARGS_ASSERT_VMESS;
1485 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1486 return mess_sv(sv, 1);
1490 Perl_write_to_stderr(pTHX_ SV* msv)
1495 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1497 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1498 && (io = GvIO(PL_stderrgv))
1499 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1500 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1501 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1503 PerlIO * const serr = Perl_error_log;
1505 do_print(msv, serr);
1506 (void)PerlIO_flush(serr);
1511 =head1 Warning and Dieing
1514 /* Common code used in dieing and warning */
1517 S_with_queued_errors(pTHX_ SV *ex)
1519 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1520 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1521 sv_catsv(PL_errors, ex);
1522 ex = sv_mortalcopy(PL_errors);
1523 SvCUR_set(PL_errors, 0);
1529 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1534 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1535 /* sv_2cv might call Perl_croak() or Perl_warner() */
1536 SV * const oldhook = *hook;
1544 cv = sv_2cv(oldhook, &stash, &gv, 0);
1546 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1556 exarg = newSVsv(ex);
1557 SvREADONLY_on(exarg);
1560 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1564 call_sv(MUTABLE_SV(cv), G_DISCARD);
1573 =for apidoc Am|OP *|die_sv|SV *baseex
1575 Behaves the same as L</croak_sv>, except for the return type.
1576 It should be used only where the C<OP *> return type is required.
1577 The function never actually returns.
1583 # pragma warning( push )
1584 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1585 __declspec(noreturn) has non-void return type */
1586 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1587 __declspec(noreturn) has a return statement */
1590 Perl_die_sv(pTHX_ SV *baseex)
1592 PERL_ARGS_ASSERT_DIE_SV;
1595 NORETURN_FUNCTION_END;
1598 # pragma warning( pop )
1602 =for apidoc Am|OP *|die|const char *pat|...
1604 Behaves the same as L</croak>, except for the return type.
1605 It should be used only where the C<OP *> return type is required.
1606 The function never actually returns.
1611 #if defined(PERL_IMPLICIT_CONTEXT)
1613 # pragma warning( push )
1614 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1615 __declspec(noreturn) has non-void return type */
1616 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1617 __declspec(noreturn) has a return statement */
1620 Perl_die_nocontext(const char* pat, ...)
1624 va_start(args, pat);
1626 NOT_REACHED; /* NOTREACHED */
1628 NORETURN_FUNCTION_END;
1631 # pragma warning( pop )
1633 #endif /* PERL_IMPLICIT_CONTEXT */
1636 # pragma warning( push )
1637 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1638 __declspec(noreturn) has non-void return type */
1639 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1640 __declspec(noreturn) has a return statement */
1643 Perl_die(pTHX_ const char* pat, ...)
1646 va_start(args, pat);
1648 NOT_REACHED; /* NOTREACHED */
1650 NORETURN_FUNCTION_END;
1653 # pragma warning( pop )
1657 =for apidoc Am|void|croak_sv|SV *baseex
1659 This is an XS interface to Perl's C<die> function.
1661 C<baseex> is the error message or object. If it is a reference, it
1662 will be used as-is. Otherwise it is used as a string, and if it does
1663 not end with a newline then it will be extended with some indication of
1664 the current location in the code, as described for L</mess_sv>.
1666 The error message or object will be used as an exception, by default
1667 returning control to the nearest enclosing C<eval>, but subject to
1668 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1669 function never returns normally.
1671 To die with a simple string message, the L</croak> function may be
1678 Perl_croak_sv(pTHX_ SV *baseex)
1680 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1681 PERL_ARGS_ASSERT_CROAK_SV;
1682 invoke_exception_hook(ex, FALSE);
1687 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1689 This is an XS interface to Perl's C<die> function.
1691 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1692 argument list. These are used to generate a string message. If the
1693 message does not end with a newline, then it will be extended with
1694 some indication of the current location in the code, as described for
1697 The error message will be used as an exception, by default
1698 returning control to the nearest enclosing C<eval>, but subject to
1699 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1700 function never returns normally.
1702 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1703 (C<$@>) will be used as an error message or object instead of building an
1704 error message from arguments. If you want to throw a non-string object,
1705 or build an error message in an SV yourself, it is preferable to use
1706 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1712 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1714 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1715 invoke_exception_hook(ex, FALSE);
1720 =for apidoc Am|void|croak|const char *pat|...
1722 This is an XS interface to Perl's C<die> function.
1724 Take a sprintf-style format pattern and argument list. These are used to
1725 generate a string message. If the message does not end with a newline,
1726 then it will be extended with some indication of the current location
1727 in the code, as described for L</mess_sv>.
1729 The error message will be used as an exception, by default
1730 returning control to the nearest enclosing C<eval>, but subject to
1731 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1732 function never returns normally.
1734 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1735 (C<$@>) will be used as an error message or object instead of building an
1736 error message from arguments. If you want to throw a non-string object,
1737 or build an error message in an SV yourself, it is preferable to use
1738 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1743 #if defined(PERL_IMPLICIT_CONTEXT)
1745 Perl_croak_nocontext(const char *pat, ...)
1749 va_start(args, pat);
1751 NOT_REACHED; /* NOTREACHED */
1754 #endif /* PERL_IMPLICIT_CONTEXT */
1757 Perl_croak(pTHX_ const char *pat, ...)
1760 va_start(args, pat);
1762 NOT_REACHED; /* NOTREACHED */
1767 =for apidoc Am|void|croak_no_modify
1769 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1770 terser object code than using C<Perl_croak>. Less code used on exception code
1771 paths reduces CPU cache pressure.
1777 Perl_croak_no_modify(void)
1779 Perl_croak_nocontext( "%s", PL_no_modify);
1782 /* does not return, used in util.c perlio.c and win32.c
1783 This is typically called when malloc returns NULL.
1786 Perl_croak_no_mem(void)
1790 int fd = PerlIO_fileno(Perl_error_log);
1792 SETERRNO(EBADF,RMS_IFI);
1794 /* Can't use PerlIO to write as it allocates memory */
1795 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1800 /* does not return, used only in POPSTACK */
1802 Perl_croak_popstack(void)
1805 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1810 =for apidoc Am|void|warn_sv|SV *baseex
1812 This is an XS interface to Perl's C<warn> function.
1814 C<baseex> is the error message or object. If it is a reference, it
1815 will be used as-is. Otherwise it is used as a string, and if it does
1816 not end with a newline then it will be extended with some indication of
1817 the current location in the code, as described for L</mess_sv>.
1819 The error message or object will by default be written to standard error,
1820 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1822 To warn with a simple string message, the L</warn> function may be
1829 Perl_warn_sv(pTHX_ SV *baseex)
1831 SV *ex = mess_sv(baseex, 0);
1832 PERL_ARGS_ASSERT_WARN_SV;
1833 if (!invoke_exception_hook(ex, TRUE))
1834 write_to_stderr(ex);
1838 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1840 This is an XS interface to Perl's C<warn> function.
1842 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1843 argument list. These are used to generate a string message. If the
1844 message does not end with a newline, then it will be extended with
1845 some indication of the current location in the code, as described for
1848 The error message or object will by default be written to standard error,
1849 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1851 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1857 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1859 SV *ex = vmess(pat, args);
1860 PERL_ARGS_ASSERT_VWARN;
1861 if (!invoke_exception_hook(ex, TRUE))
1862 write_to_stderr(ex);
1866 =for apidoc Am|void|warn|const char *pat|...
1868 This is an XS interface to Perl's C<warn> function.
1870 Take a sprintf-style format pattern and argument list. These are used to
1871 generate a string message. If the message does not end with a newline,
1872 then it will be extended with some indication of the current location
1873 in the code, as described for L</mess_sv>.
1875 The error message or object will by default be written to standard error,
1876 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1878 Unlike with L</croak>, C<pat> is not permitted to be null.
1883 #if defined(PERL_IMPLICIT_CONTEXT)
1885 Perl_warn_nocontext(const char *pat, ...)
1889 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1890 va_start(args, pat);
1894 #endif /* PERL_IMPLICIT_CONTEXT */
1897 Perl_warn(pTHX_ const char *pat, ...)
1900 PERL_ARGS_ASSERT_WARN;
1901 va_start(args, pat);
1906 #if defined(PERL_IMPLICIT_CONTEXT)
1908 Perl_warner_nocontext(U32 err, const char *pat, ...)
1912 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1913 va_start(args, pat);
1914 vwarner(err, pat, &args);
1917 #endif /* PERL_IMPLICIT_CONTEXT */
1920 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1922 PERL_ARGS_ASSERT_CK_WARNER_D;
1924 if (Perl_ckwarn_d(aTHX_ err)) {
1926 va_start(args, pat);
1927 vwarner(err, pat, &args);
1933 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1935 PERL_ARGS_ASSERT_CK_WARNER;
1937 if (Perl_ckwarn(aTHX_ err)) {
1939 va_start(args, pat);
1940 vwarner(err, pat, &args);
1946 Perl_warner(pTHX_ U32 err, const char* pat,...)
1949 PERL_ARGS_ASSERT_WARNER;
1950 va_start(args, pat);
1951 vwarner(err, pat, &args);
1956 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1959 PERL_ARGS_ASSERT_VWARNER;
1961 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
1962 !(PL_in_eval & EVAL_KEEPERR)
1964 SV * const msv = vmess(pat, args);
1966 if (PL_parser && PL_parser->error_count) {
1970 invoke_exception_hook(msv, FALSE);
1975 Perl_vwarn(aTHX_ pat, args);
1979 /* implements the ckWARN? macros */
1982 Perl_ckwarn(pTHX_ U32 w)
1984 /* If lexical warnings have not been set, use $^W. */
1986 return PL_dowarn & G_WARN_ON;
1988 return ckwarn_common(w);
1991 /* implements the ckWARN?_d macro */
1994 Perl_ckwarn_d(pTHX_ U32 w)
1996 /* If lexical warnings have not been set then default classes warn. */
2000 return ckwarn_common(w);
2004 S_ckwarn_common(pTHX_ U32 w)
2006 if (PL_curcop->cop_warnings == pWARN_ALL)
2009 if (PL_curcop->cop_warnings == pWARN_NONE)
2012 /* Check the assumption that at least the first slot is non-zero. */
2013 assert(unpackWARN1(w));
2015 /* Check the assumption that it is valid to stop as soon as a zero slot is
2017 if (!unpackWARN2(w)) {
2018 assert(!unpackWARN3(w));
2019 assert(!unpackWARN4(w));
2020 } else if (!unpackWARN3(w)) {
2021 assert(!unpackWARN4(w));
2024 /* Right, dealt with all the special cases, which are implemented as non-
2025 pointers, so there is a pointer to a real warnings mask. */
2027 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2029 } while (w >>= WARNshift);
2034 /* Set buffer=NULL to get a new one. */
2036 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2038 const MEM_SIZE len_wanted =
2039 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2040 PERL_UNUSED_CONTEXT;
2041 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2044 (specialWARN(buffer) ?
2045 PerlMemShared_malloc(len_wanted) :
2046 PerlMemShared_realloc(buffer, len_wanted));
2048 Copy(bits, (buffer + 1), size, char);
2049 if (size < WARNsize)
2050 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2054 /* since we've already done strlen() for both nam and val
2055 * we can use that info to make things faster than
2056 * sprintf(s, "%s=%s", nam, val)
2058 #define my_setenv_format(s, nam, nlen, val, vlen) \
2059 Copy(nam, s, nlen, char); \
2061 Copy(val, s+(nlen+1), vlen, char); \
2062 *(s+(nlen+1+vlen)) = '\0'
2064 #ifdef USE_ENVIRON_ARRAY
2065 /* VMS' my_setenv() is in vms.c */
2066 #if !defined(WIN32) && !defined(NETWARE)
2068 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2072 amigaos4_obtain_environ(__FUNCTION__);
2075 /* only parent thread can modify process environment */
2076 if (PL_curinterp == aTHX)
2079 #ifndef PERL_USE_SAFE_PUTENV
2080 if (!PL_use_safe_putenv) {
2081 /* most putenv()s leak, so we manipulate environ directly */
2083 const I32 len = strlen(nam);
2086 /* where does it go? */
2087 for (i = 0; environ[i]; i++) {
2088 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
2092 if (environ == PL_origenviron) { /* need we copy environment? */
2098 while (environ[max])
2100 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
2101 for (j=0; j<max; j++) { /* copy environment */
2102 const int len = strlen(environ[j]);
2103 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
2104 Copy(environ[j], tmpenv[j], len+1, char);
2107 environ = tmpenv; /* tell exec where it is now */
2110 safesysfree(environ[i]);
2111 while (environ[i]) {
2112 environ[i] = environ[i+1];
2121 if (!environ[i]) { /* does not exist yet */
2122 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
2123 environ[i+1] = NULL; /* make sure it's null terminated */
2126 safesysfree(environ[i]);
2130 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
2131 /* all that work just for this */
2132 my_setenv_format(environ[i], nam, nlen, val, vlen);
2135 /* This next branch should only be called #if defined(HAS_SETENV), but
2136 Configure doesn't test for that yet. For Solaris, setenv() and unsetenv()
2137 were introduced in Solaris 9, so testing for HAS UNSETENV is sufficient.
2139 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2140 # if defined(HAS_UNSETENV)
2142 (void)unsetenv(nam);
2144 (void)setenv(nam, val, 1);
2146 # else /* ! HAS_UNSETENV */
2147 (void)setenv(nam, val, 1);
2148 # endif /* HAS_UNSETENV */
2150 # if defined(HAS_UNSETENV)
2152 if (environ) /* old glibc can crash with null environ */
2153 (void)unsetenv(nam);
2155 const int nlen = strlen(nam);
2156 const int vlen = strlen(val);
2157 char * const new_env =
2158 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2159 my_setenv_format(new_env, nam, nlen, val, vlen);
2160 (void)putenv(new_env);
2162 # else /* ! HAS_UNSETENV */
2164 const int nlen = strlen(nam);
2170 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2171 /* all that work just for this */
2172 my_setenv_format(new_env, nam, nlen, val, vlen);
2173 (void)putenv(new_env);
2174 # endif /* HAS_UNSETENV */
2175 # endif /* __CYGWIN__ */
2176 #ifndef PERL_USE_SAFE_PUTENV
2182 amigaos4_release_environ(__FUNCTION__);
2186 #else /* WIN32 || NETWARE */
2189 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2193 const int nlen = strlen(nam);
2200 Newx(envstr, nlen+vlen+2, char);
2201 my_setenv_format(envstr, nam, nlen, val, vlen);
2202 (void)PerlEnv_putenv(envstr);
2206 #endif /* WIN32 || NETWARE */
2210 #ifdef UNLINK_ALL_VERSIONS
2212 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2216 PERL_ARGS_ASSERT_UNLNK;
2218 while (PerlLIO_unlink(f) >= 0)
2220 return retries ? 0 : -1;
2224 /* this is a drop-in replacement for bcopy(), except for the return
2225 * value, which we need to be able to emulate memcpy() */
2226 #if !defined(HAS_MEMCPY) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY))
2228 Perl_my_bcopy(const void *vfrom, void *vto, size_t len)
2230 #if defined(HAS_BCOPY) && defined(HAS_SAFE_BCOPY)
2231 bcopy(vfrom, vto, len);
2233 const unsigned char *from = (const unsigned char *)vfrom;
2234 unsigned char *to = (unsigned char *)vto;
2236 PERL_ARGS_ASSERT_MY_BCOPY;
2238 if (from - to >= 0) {
2246 *(--to) = *(--from);
2254 /* this is a drop-in replacement for memset() */
2257 Perl_my_memset(void *vloc, int ch, size_t len)
2259 unsigned char *loc = (unsigned char *)vloc;
2261 PERL_ARGS_ASSERT_MY_MEMSET;
2269 /* this is a drop-in replacement for bzero() */
2270 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2272 Perl_my_bzero(void *vloc, size_t len)
2274 unsigned char *loc = (unsigned char *)vloc;
2276 PERL_ARGS_ASSERT_MY_BZERO;
2284 /* this is a drop-in replacement for memcmp() */
2285 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2287 Perl_my_memcmp(const void *vs1, const void *vs2, size_t len)
2289 const U8 *a = (const U8 *)vs1;
2290 const U8 *b = (const U8 *)vs2;
2293 PERL_ARGS_ASSERT_MY_MEMCMP;
2296 if ((tmp = *a++ - *b++))
2301 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2304 /* This vsprintf replacement should generally never get used, since
2305 vsprintf was available in both System V and BSD 2.11. (There may
2306 be some cross-compilation or embedded set-ups where it is needed,
2309 If you encounter a problem in this function, it's probably a symptom
2310 that Configure failed to detect your system's vprintf() function.
2311 See the section on "item vsprintf" in the INSTALL file.
2313 This version may compile on systems with BSD-ish <stdio.h>,
2314 but probably won't on others.
2317 #ifdef USE_CHAR_VSPRINTF
2322 vsprintf(char *dest, const char *pat, void *args)
2326 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2327 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2328 FILE_cnt(&fakebuf) = 32767;
2330 /* These probably won't compile -- If you really need
2331 this, you'll have to figure out some other method. */
2332 fakebuf._ptr = dest;
2333 fakebuf._cnt = 32767;
2338 fakebuf._flag = _IOWRT|_IOSTRG;
2339 _doprnt(pat, args, &fakebuf); /* what a kludge */
2340 #if defined(STDIO_PTR_LVALUE)
2341 *(FILE_ptr(&fakebuf)++) = '\0';
2343 /* PerlIO has probably #defined away fputc, but we want it here. */
2345 # undef fputc /* XXX Should really restore it later */
2347 (void)fputc('\0', &fakebuf);
2349 #ifdef USE_CHAR_VSPRINTF
2352 return 0; /* perl doesn't use return value */
2356 #endif /* HAS_VPRINTF */
2359 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2361 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2369 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2371 PERL_FLUSHALL_FOR_CHILD;
2372 This = (*mode == 'w');
2376 taint_proper("Insecure %s%s", "EXEC");
2378 if (PerlProc_pipe(p) < 0)
2380 /* Try for another pipe pair for error return */
2381 if (PerlProc_pipe(pp) >= 0)
2383 while ((pid = PerlProc_fork()) < 0) {
2384 if (errno != EAGAIN) {
2385 PerlLIO_close(p[This]);
2386 PerlLIO_close(p[that]);
2388 PerlLIO_close(pp[0]);
2389 PerlLIO_close(pp[1]);
2393 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2402 /* Close parent's end of error status pipe (if any) */
2404 PerlLIO_close(pp[0]);
2405 #if defined(HAS_FCNTL) && defined(F_SETFD) && defined(FD_CLOEXEC)
2406 /* Close error pipe automatically if exec works */
2407 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2411 /* Now dup our end of _the_ pipe to right position */
2412 if (p[THIS] != (*mode == 'r')) {
2413 PerlLIO_dup2(p[THIS], *mode == 'r');
2414 PerlLIO_close(p[THIS]);
2415 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2416 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2419 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2420 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2421 /* No automatic close - do it by hand */
2428 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2434 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2440 do_execfree(); /* free any memory malloced by child on fork */
2442 PerlLIO_close(pp[1]);
2443 /* Keep the lower of the two fd numbers */
2444 if (p[that] < p[This]) {
2445 PerlLIO_dup2(p[This], p[that]);
2446 PerlLIO_close(p[This]);
2450 PerlLIO_close(p[that]); /* close child's end of pipe */
2452 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2453 SvUPGRADE(sv,SVt_IV);
2455 PL_forkprocess = pid;
2456 /* If we managed to get status pipe check for exec fail */
2457 if (did_pipes && pid > 0) {
2461 while (n < sizeof(int)) {
2462 const SSize_t n1 = PerlLIO_read(pp[0],
2463 (void*)(((char*)&errkid)+n),
2469 PerlLIO_close(pp[0]);
2471 if (n) { /* Error */
2473 PerlLIO_close(p[This]);
2474 if (n != sizeof(int))
2475 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2477 pid2 = wait4pid(pid, &status, 0);
2478 } while (pid2 == -1 && errno == EINTR);
2479 errno = errkid; /* Propagate errno from kid */
2484 PerlLIO_close(pp[0]);
2485 return PerlIO_fdopen(p[This], mode);
2487 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2488 return my_syspopen4(aTHX_ NULL, mode, n, args);
2489 # elif defined(WIN32)
2490 return win32_popenlist(mode, n, args);
2492 Perl_croak(aTHX_ "List form of piped open not implemented");
2493 return (PerlIO *) NULL;
2498 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2499 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2501 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2507 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2511 PERL_ARGS_ASSERT_MY_POPEN;
2513 PERL_FLUSHALL_FOR_CHILD;
2516 return my_syspopen(aTHX_ cmd,mode);
2519 This = (*mode == 'w');
2521 if (doexec && TAINTING_get) {
2523 taint_proper("Insecure %s%s", "EXEC");
2525 if (PerlProc_pipe(p) < 0)
2527 if (doexec && PerlProc_pipe(pp) >= 0)
2529 while ((pid = PerlProc_fork()) < 0) {
2530 if (errno != EAGAIN) {
2531 PerlLIO_close(p[This]);
2532 PerlLIO_close(p[that]);
2534 PerlLIO_close(pp[0]);
2535 PerlLIO_close(pp[1]);
2538 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2541 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2551 PerlLIO_close(pp[0]);
2552 #if defined(HAS_FCNTL) && defined(F_SETFD)
2553 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2557 if (p[THIS] != (*mode == 'r')) {
2558 PerlLIO_dup2(p[THIS], *mode == 'r');
2559 PerlLIO_close(p[THIS]);
2560 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2561 PerlLIO_close(p[THAT]);
2564 PerlLIO_close(p[THAT]);
2567 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2574 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2579 /* may or may not use the shell */
2580 do_exec3(cmd, pp[1], did_pipes);
2583 #endif /* defined OS2 */
2585 #ifdef PERLIO_USING_CRLF
2586 /* Since we circumvent IO layers when we manipulate low-level
2587 filedescriptors directly, need to manually switch to the
2588 default, binary, low-level mode; see PerlIOBuf_open(). */
2589 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2592 #ifdef PERL_USES_PL_PIDSTATUS
2593 hv_clear(PL_pidstatus); /* we have no children */
2599 do_execfree(); /* free any memory malloced by child on vfork */
2601 PerlLIO_close(pp[1]);
2602 if (p[that] < p[This]) {
2603 PerlLIO_dup2(p[This], p[that]);
2604 PerlLIO_close(p[This]);
2608 PerlLIO_close(p[that]);
2610 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2611 SvUPGRADE(sv,SVt_IV);
2613 PL_forkprocess = pid;
2614 if (did_pipes && pid > 0) {
2618 while (n < sizeof(int)) {
2619 const SSize_t n1 = PerlLIO_read(pp[0],
2620 (void*)(((char*)&errkid)+n),
2626 PerlLIO_close(pp[0]);
2628 if (n) { /* Error */
2630 PerlLIO_close(p[This]);
2631 if (n != sizeof(int))
2632 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2634 pid2 = wait4pid(pid, &status, 0);
2635 } while (pid2 == -1 && errno == EINTR);
2636 errno = errkid; /* Propagate errno from kid */
2641 PerlLIO_close(pp[0]);
2642 return PerlIO_fdopen(p[This], mode);
2646 FILE *djgpp_popen();
2648 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2650 PERL_FLUSHALL_FOR_CHILD;
2651 /* Call system's popen() to get a FILE *, then import it.
2652 used 0 for 2nd parameter to PerlIO_importFILE;
2655 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2658 #if defined(__LIBCATAMOUNT__)
2660 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2667 #endif /* !DOSISH */
2669 /* this is called in parent before the fork() */
2671 Perl_atfork_lock(void)
2672 #if defined(USE_ITHREADS)
2674 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2677 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2679 PERL_TSA_ACQUIRE(PL_op_mutex)
2682 #if defined(USE_ITHREADS)
2684 /* locks must be held in locking order (if any) */
2686 MUTEX_LOCK(&PL_perlio_mutex);
2689 MUTEX_LOCK(&PL_malloc_mutex);
2695 /* this is called in both parent and child after the fork() */
2697 Perl_atfork_unlock(void)
2698 #if defined(USE_ITHREADS)
2700 PERL_TSA_RELEASE(PL_perlio_mutex)
2703 PERL_TSA_RELEASE(PL_malloc_mutex)
2705 PERL_TSA_RELEASE(PL_op_mutex)
2708 #if defined(USE_ITHREADS)
2710 /* locks must be released in same order as in atfork_lock() */
2712 MUTEX_UNLOCK(&PL_perlio_mutex);
2715 MUTEX_UNLOCK(&PL_malloc_mutex);
2724 #if defined(HAS_FORK)
2726 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2731 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2732 * handlers elsewhere in the code */
2736 #elif defined(__amigaos4__)
2737 return amigaos_fork();
2739 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2740 Perl_croak_nocontext("fork() not available");
2742 #endif /* HAS_FORK */
2747 dup2(int oldfd, int newfd)
2749 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2752 PerlLIO_close(newfd);
2753 return fcntl(oldfd, F_DUPFD, newfd);
2755 #define DUP2_MAX_FDS 256
2756 int fdtmp[DUP2_MAX_FDS];
2762 PerlLIO_close(newfd);
2763 /* good enough for low fd's... */
2764 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2765 if (fdx >= DUP2_MAX_FDS) {
2773 PerlLIO_close(fdtmp[--fdx]);
2780 #ifdef HAS_SIGACTION
2783 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2785 struct sigaction act, oact;
2789 /* only "parent" interpreter can diddle signals */
2790 if (PL_curinterp != aTHX)
2791 return (Sighandler_t) SIG_ERR;
2794 act.sa_handler = (void(*)(int))handler;
2795 sigemptyset(&act.sa_mask);
2798 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2799 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2801 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2802 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2803 act.sa_flags |= SA_NOCLDWAIT;
2805 if (sigaction(signo, &act, &oact) == -1)
2806 return (Sighandler_t) SIG_ERR;
2808 return (Sighandler_t) oact.sa_handler;
2812 Perl_rsignal_state(pTHX_ int signo)
2814 struct sigaction oact;
2815 PERL_UNUSED_CONTEXT;
2817 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2818 return (Sighandler_t) SIG_ERR;
2820 return (Sighandler_t) oact.sa_handler;
2824 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2829 struct sigaction act;
2831 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2834 /* only "parent" interpreter can diddle signals */
2835 if (PL_curinterp != aTHX)
2839 act.sa_handler = (void(*)(int))handler;
2840 sigemptyset(&act.sa_mask);
2843 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2844 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2846 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2847 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2848 act.sa_flags |= SA_NOCLDWAIT;
2850 return sigaction(signo, &act, save);
2854 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2859 PERL_UNUSED_CONTEXT;
2861 /* only "parent" interpreter can diddle signals */
2862 if (PL_curinterp != aTHX)
2866 return sigaction(signo, save, (struct sigaction *)NULL);
2869 #else /* !HAS_SIGACTION */
2872 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2874 #if defined(USE_ITHREADS) && !defined(WIN32)
2875 /* only "parent" interpreter can diddle signals */
2876 if (PL_curinterp != aTHX)
2877 return (Sighandler_t) SIG_ERR;
2880 return PerlProc_signal(signo, handler);
2891 Perl_rsignal_state(pTHX_ int signo)
2894 Sighandler_t oldsig;
2896 #if defined(USE_ITHREADS) && !defined(WIN32)
2897 /* only "parent" interpreter can diddle signals */
2898 if (PL_curinterp != aTHX)
2899 return (Sighandler_t) SIG_ERR;
2903 oldsig = PerlProc_signal(signo, sig_trap);
2904 PerlProc_signal(signo, oldsig);
2906 PerlProc_kill(PerlProc_getpid(), signo);
2911 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2913 #if defined(USE_ITHREADS) && !defined(WIN32)
2914 /* only "parent" interpreter can diddle signals */
2915 if (PL_curinterp != aTHX)
2918 *save = PerlProc_signal(signo, handler);
2919 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2923 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2925 #if defined(USE_ITHREADS) && !defined(WIN32)
2926 /* only "parent" interpreter can diddle signals */
2927 if (PL_curinterp != aTHX)
2930 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2933 #endif /* !HAS_SIGACTION */
2934 #endif /* !PERL_MICRO */
2936 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2937 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2939 Perl_my_pclose(pTHX_ PerlIO *ptr)
2947 const int fd = PerlIO_fileno(ptr);
2950 svp = av_fetch(PL_fdpid,fd,TRUE);
2951 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2955 #if defined(USE_PERLIO)
2956 /* Find out whether the refcount is low enough for us to wait for the
2957 child proc without blocking. */
2958 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
2960 should_wait = pid > 0;
2964 if (pid == -1) { /* Opened by popen. */
2965 return my_syspclose(ptr);
2968 close_failed = (PerlIO_close(ptr) == EOF);
2970 if (should_wait) do {
2971 pid2 = wait4pid(pid, &status, 0);
2972 } while (pid2 == -1 && errno == EINTR);
2979 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2984 #if defined(__LIBCATAMOUNT__)
2986 Perl_my_pclose(pTHX_ PerlIO *ptr)
2991 #endif /* !DOSISH */
2993 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2995 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
2998 PERL_ARGS_ASSERT_WAIT4PID;
2999 #ifdef PERL_USES_PL_PIDSTATUS
3001 /* PERL_USES_PL_PIDSTATUS is only defined when neither
3002 waitpid() nor wait4() is available, or on OS/2, which
3003 doesn't appear to support waiting for a progress group
3004 member, so we can only treat a 0 pid as an unknown child.
3011 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3012 pid, rather than a string form. */
3013 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3014 if (svp && *svp != &PL_sv_undef) {
3015 *statusp = SvIVX(*svp);
3016 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3024 hv_iterinit(PL_pidstatus);
3025 if ((entry = hv_iternext(PL_pidstatus))) {
3026 SV * const sv = hv_iterval(PL_pidstatus,entry);
3028 const char * const spid = hv_iterkey(entry,&len);
3030 assert (len == sizeof(Pid_t));
3031 memcpy((char *)&pid, spid, len);
3032 *statusp = SvIVX(sv);
3033 /* The hash iterator is currently on this entry, so simply
3034 calling hv_delete would trigger the lazy delete, which on
3035 aggregate does more work, because next call to hv_iterinit()
3036 would spot the flag, and have to call the delete routine,
3037 while in the meantime any new entries can't re-use that
3039 hv_iterinit(PL_pidstatus);
3040 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3047 # ifdef HAS_WAITPID_RUNTIME
3048 if (!HAS_WAITPID_RUNTIME)
3051 result = PerlProc_waitpid(pid,statusp,flags);
3054 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3055 result = wait4(pid,statusp,flags,NULL);
3058 #ifdef PERL_USES_PL_PIDSTATUS
3059 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3064 Perl_croak(aTHX_ "Can't do waitpid with flags");
3066 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3067 pidgone(result,*statusp);
3073 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3076 if (result < 0 && errno == EINTR) {
3078 errno = EINTR; /* reset in case a signal handler changed $! */
3082 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3084 #ifdef PERL_USES_PL_PIDSTATUS
3086 S_pidgone(pTHX_ Pid_t pid, int status)
3090 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3091 SvUPGRADE(sv,SVt_IV);
3092 SvIV_set(sv, status);
3100 int /* Cannot prototype with I32
3102 my_syspclose(PerlIO *ptr)
3105 Perl_my_pclose(pTHX_ PerlIO *ptr)
3108 /* Needs work for PerlIO ! */
3109 FILE * const f = PerlIO_findFILE(ptr);
3110 const I32 result = pclose(f);
3111 PerlIO_releaseFILE(ptr,f);
3119 Perl_my_pclose(pTHX_ PerlIO *ptr)
3121 /* Needs work for PerlIO ! */
3122 FILE * const f = PerlIO_findFILE(ptr);
3123 I32 result = djgpp_pclose(f);
3124 result = (result << 8) & 0xff00;
3125 PerlIO_releaseFILE(ptr,f);
3130 #define PERL_REPEATCPY_LINEAR 4
3132 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3134 PERL_ARGS_ASSERT_REPEATCPY;
3139 croak_memory_wrap();
3142 memset(to, *from, count);
3145 IV items, linear, half;
3147 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3148 for (items = 0; items < linear; ++items) {
3149 const char *q = from;
3151 for (todo = len; todo > 0; todo--)
3156 while (items <= half) {
3157 IV size = items * len;
3158 memcpy(p, to, size);
3164 memcpy(p, to, (count - items) * len);
3170 Perl_same_dirent(pTHX_ const char *a, const char *b)
3172 char *fa = strrchr(a,'/');
3173 char *fb = strrchr(b,'/');
3176 SV * const tmpsv = sv_newmortal();
3178 PERL_ARGS_ASSERT_SAME_DIRENT;
3191 sv_setpvs(tmpsv, ".");
3193 sv_setpvn(tmpsv, a, fa - a);
3194 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3197 sv_setpvs(tmpsv, ".");
3199 sv_setpvn(tmpsv, b, fb - b);
3200 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3202 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3203 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3205 #endif /* !HAS_RENAME */
3208 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3209 const char *const *const search_ext, I32 flags)
3211 const char *xfound = NULL;
3212 char *xfailed = NULL;
3213 char tmpbuf[MAXPATHLEN];
3218 #if defined(DOSISH) && !defined(OS2)
3219 # define SEARCH_EXTS ".bat", ".cmd", NULL
3220 # define MAX_EXT_LEN 4
3223 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3224 # define MAX_EXT_LEN 4
3227 # define SEARCH_EXTS ".pl", ".com", NULL
3228 # define MAX_EXT_LEN 4
3230 /* additional extensions to try in each dir if scriptname not found */
3232 static const char *const exts[] = { SEARCH_EXTS };
3233 const char *const *const ext = search_ext ? search_ext : exts;
3234 int extidx = 0, i = 0;
3235 const char *curext = NULL;
3237 PERL_UNUSED_ARG(search_ext);
3238 # define MAX_EXT_LEN 0
3241 PERL_ARGS_ASSERT_FIND_SCRIPT;
3244 * If dosearch is true and if scriptname does not contain path
3245 * delimiters, search the PATH for scriptname.
3247 * If SEARCH_EXTS is also defined, will look for each
3248 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3249 * while searching the PATH.
3251 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3252 * proceeds as follows:
3253 * If DOSISH or VMSISH:
3254 * + look for ./scriptname{,.foo,.bar}
3255 * + search the PATH for scriptname{,.foo,.bar}
3258 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3259 * this will not look in '.' if it's not in the PATH)
3264 # ifdef ALWAYS_DEFTYPES
3265 len = strlen(scriptname);
3266 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3267 int idx = 0, deftypes = 1;
3270 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3273 int idx = 0, deftypes = 1;
3276 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3278 /* The first time through, just add SEARCH_EXTS to whatever we
3279 * already have, so we can check for default file types. */
3281 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3288 if ((strlen(tmpbuf) + strlen(scriptname)
3289 + MAX_EXT_LEN) >= sizeof tmpbuf)
3290 continue; /* don't search dir with too-long name */
3291 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3295 if (strEQ(scriptname, "-"))
3297 if (dosearch) { /* Look in '.' first. */
3298 const char *cur = scriptname;
3300 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3302 if (strEQ(ext[i++],curext)) {
3303 extidx = -1; /* already has an ext */
3308 DEBUG_p(PerlIO_printf(Perl_debug_log,
3309 "Looking for %s\n",cur));
3312 if (PerlLIO_stat(cur,&statbuf) >= 0
3313 && !S_ISDIR(statbuf.st_mode)) {
3322 if (cur == scriptname) {
3323 len = strlen(scriptname);
3324 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3326 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3329 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3330 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3335 if (dosearch && !strchr(scriptname, '/')
3337 && !strchr(scriptname, '\\')
3339 && (s = PerlEnv_getenv("PATH")))
3343 bufend = s + strlen(s);
3344 while (s < bufend) {
3348 && *s != ';'; len++, s++) {
3349 if (len < sizeof tmpbuf)
3352 if (len < sizeof tmpbuf)
3355 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3361 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3362 continue; /* don't search dir with too-long name */
3365 && tmpbuf[len - 1] != '/'
3366 && tmpbuf[len - 1] != '\\'
3369 tmpbuf[len++] = '/';
3370 if (len == 2 && tmpbuf[0] == '.')
3372 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3376 len = strlen(tmpbuf);
3377 if (extidx > 0) /* reset after previous loop */
3381 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3382 retval = PerlLIO_stat(tmpbuf,&statbuf);
3383 if (S_ISDIR(statbuf.st_mode)) {
3387 } while ( retval < 0 /* not there */
3388 && extidx>=0 && ext[extidx] /* try an extension? */
3389 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3394 if (S_ISREG(statbuf.st_mode)
3395 && cando(S_IRUSR,TRUE,&statbuf)
3396 #if !defined(DOSISH)
3397 && cando(S_IXUSR,TRUE,&statbuf)
3401 xfound = tmpbuf; /* bingo! */
3405 xfailed = savepv(tmpbuf);
3410 if (!xfound && !seen_dot && !xfailed &&
3411 (PerlLIO_stat(scriptname,&statbuf) < 0
3412 || S_ISDIR(statbuf.st_mode)))
3414 seen_dot = 1; /* Disable message. */
3419 if (flags & 1) { /* do or die? */
3420 /* diag_listed_as: Can't execute %s */
3421 Perl_croak(aTHX_ "Can't %s %s%s%s",
3422 (xfailed ? "execute" : "find"),
3423 (xfailed ? xfailed : scriptname),
3424 (xfailed ? "" : " on PATH"),
3425 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3430 scriptname = xfound;
3432 return (scriptname ? savepv(scriptname) : NULL);
3435 #ifndef PERL_GET_CONTEXT_DEFINED
3438 Perl_get_context(void)
3440 #if defined(USE_ITHREADS)
3442 # ifdef OLD_PTHREADS_API
3444 int error = pthread_getspecific(PL_thr_key, &t)
3446 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3449 # ifdef I_MACH_CTHREADS
3450 return (void*)cthread_data(cthread_self());
3452 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3461 Perl_set_context(void *t)
3463 #if defined(USE_ITHREADS)
3466 PERL_ARGS_ASSERT_SET_CONTEXT;
3467 #if defined(USE_ITHREADS)
3468 # ifdef I_MACH_CTHREADS
3469 cthread_set_data(cthread_self(), t);
3472 const int error = pthread_setspecific(PL_thr_key, t);
3474 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3482 #endif /* !PERL_GET_CONTEXT_DEFINED */
3484 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3488 PERL_UNUSED_CONTEXT;
3494 Perl_get_op_names(pTHX)
3496 PERL_UNUSED_CONTEXT;
3497 return (char **)PL_op_name;
3501 Perl_get_op_descs(pTHX)
3503 PERL_UNUSED_CONTEXT;
3504 return (char **)PL_op_desc;
3508 Perl_get_no_modify(pTHX)
3510 PERL_UNUSED_CONTEXT;
3511 return PL_no_modify;
3515 Perl_get_opargs(pTHX)
3517 PERL_UNUSED_CONTEXT;
3518 return (U32 *)PL_opargs;
3522 Perl_get_ppaddr(pTHX)
3525 PERL_UNUSED_CONTEXT;
3526 return (PPADDR_t*)PL_ppaddr;
3529 #ifndef HAS_GETENV_LEN
3531 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3533 char * const env_trans = PerlEnv_getenv(env_elem);
3534 PERL_UNUSED_CONTEXT;
3535 PERL_ARGS_ASSERT_GETENV_LEN;
3537 *len = strlen(env_trans);
3544 Perl_get_vtbl(pTHX_ int vtbl_id)
3546 PERL_UNUSED_CONTEXT;
3548 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3549 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3553 Perl_my_fflush_all(pTHX)
3555 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3556 return PerlIO_flush(NULL);
3558 # if defined(HAS__FWALK)
3559 extern int fflush(FILE *);
3560 /* undocumented, unprototyped, but very useful BSDism */
3561 extern void _fwalk(int (*)(FILE *));
3565 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3567 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3568 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3570 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3571 open_max = sysconf(_SC_OPEN_MAX);
3574 open_max = FOPEN_MAX;
3577 open_max = OPEN_MAX;
3588 for (i = 0; i < open_max; i++)
3589 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3590 STDIO_STREAM_ARRAY[i]._file < open_max &&
3591 STDIO_STREAM_ARRAY[i]._flag)
3592 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3596 SETERRNO(EBADF,RMS_IFI);
3603 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3605 if (ckWARN(WARN_IO)) {
3607 = gv && (isGV_with_GP(gv))
3610 const char * const direction = have == '>' ? "out" : "in";
3612 if (name && HEK_LEN(name))
3613 Perl_warner(aTHX_ packWARN(WARN_IO),
3614 "Filehandle %" HEKf " opened only for %sput",
3615 HEKfARG(name), direction);
3617 Perl_warner(aTHX_ packWARN(WARN_IO),
3618 "Filehandle opened only for %sput", direction);
3623 Perl_report_evil_fh(pTHX_ const GV *gv)
3625 const IO *io = gv ? GvIO(gv) : NULL;
3626 const PERL_BITFIELD16 op = PL_op->op_type;
3630 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3632 warn_type = WARN_CLOSED;
3636 warn_type = WARN_UNOPENED;
3639 if (ckWARN(warn_type)) {
3641 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3642 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3643 const char * const pars =
3644 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3645 const char * const func =
3647 (op == OP_READLINE || op == OP_RCATLINE
3648 ? "readline" : /* "<HANDLE>" not nice */
3649 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3651 const char * const type =
3653 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3654 ? "socket" : "filehandle");
3655 const bool have_name = name && SvCUR(name);
3656 Perl_warner(aTHX_ packWARN(warn_type),
3657 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3658 have_name ? " " : "",
3659 SVfARG(have_name ? name : &PL_sv_no));
3660 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3662 aTHX_ packWARN(warn_type),
3663 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3664 func, pars, have_name ? " " : "",
3665 SVfARG(have_name ? name : &PL_sv_no)
3670 /* To workaround core dumps from the uninitialised tm_zone we get the
3671 * system to give us a reasonable struct to copy. This fix means that
3672 * strftime uses the tm_zone and tm_gmtoff values returned by
3673 * localtime(time()). That should give the desired result most of the
3674 * time. But probably not always!
3676 * This does not address tzname aspects of NETaa14816.
3681 # ifndef STRUCT_TM_HASZONE
3682 # define STRUCT_TM_HASZONE
3686 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3687 # ifndef HAS_TM_TM_ZONE
3688 # define HAS_TM_TM_ZONE
3693 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3695 #ifdef HAS_TM_TM_ZONE
3697 const struct tm* my_tm;
3698 PERL_UNUSED_CONTEXT;
3699 PERL_ARGS_ASSERT_INIT_TM;
3701 my_tm = localtime(&now);
3703 Copy(my_tm, ptm, 1, struct tm);
3705 PERL_UNUSED_CONTEXT;
3706 PERL_ARGS_ASSERT_INIT_TM;
3707 PERL_UNUSED_ARG(ptm);
3712 * mini_mktime - normalise struct tm values without the localtime()
3713 * semantics (and overhead) of mktime().
3716 Perl_mini_mktime(struct tm *ptm)
3720 int month, mday, year, jday;
3721 int odd_cent, odd_year;
3723 PERL_ARGS_ASSERT_MINI_MKTIME;
3725 #define DAYS_PER_YEAR 365
3726 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3727 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3728 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3729 #define SECS_PER_HOUR (60*60)
3730 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3731 /* parentheses deliberately absent on these two, otherwise they don't work */
3732 #define MONTH_TO_DAYS 153/5
3733 #define DAYS_TO_MONTH 5/153
3734 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3735 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3736 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3737 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3740 * Year/day algorithm notes:
3742 * With a suitable offset for numeric value of the month, one can find
3743 * an offset into the year by considering months to have 30.6 (153/5) days,
3744 * using integer arithmetic (i.e., with truncation). To avoid too much
3745 * messing about with leap days, we consider January and February to be
3746 * the 13th and 14th month of the previous year. After that transformation,
3747 * we need the month index we use to be high by 1 from 'normal human' usage,
3748 * so the month index values we use run from 4 through 15.
3750 * Given that, and the rules for the Gregorian calendar (leap years are those
3751 * divisible by 4 unless also divisible by 100, when they must be divisible
3752 * by 400 instead), we can simply calculate the number of days since some
3753 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3754 * the days we derive from our month index, and adding in the day of the
3755 * month. The value used here is not adjusted for the actual origin which
3756 * it normally would use (1 January A.D. 1), since we're not exposing it.
3757 * We're only building the value so we can turn around and get the
3758 * normalised values for the year, month, day-of-month, and day-of-year.
3760 * For going backward, we need to bias the value we're using so that we find
3761 * the right year value. (Basically, we don't want the contribution of
3762 * March 1st to the number to apply while deriving the year). Having done
3763 * that, we 'count up' the contribution to the year number by accounting for
3764 * full quadracenturies (400-year periods) with their extra leap days, plus
3765 * the contribution from full centuries (to avoid counting in the lost leap
3766 * days), plus the contribution from full quad-years (to count in the normal
3767 * leap days), plus the leftover contribution from any non-leap years.
3768 * At this point, if we were working with an actual leap day, we'll have 0
3769 * days left over. This is also true for March 1st, however. So, we have
3770 * to special-case that result, and (earlier) keep track of the 'odd'
3771 * century and year contributions. If we got 4 extra centuries in a qcent,
3772 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3773 * Otherwise, we add back in the earlier bias we removed (the 123 from
3774 * figuring in March 1st), find the month index (integer division by 30.6),
3775 * and the remainder is the day-of-month. We then have to convert back to
3776 * 'real' months (including fixing January and February from being 14/15 in
3777 * the previous year to being in the proper year). After that, to get
3778 * tm_yday, we work with the normalised year and get a new yearday value for
3779 * January 1st, which we subtract from the yearday value we had earlier,
3780 * representing the date we've re-built. This is done from January 1
3781 * because tm_yday is 0-origin.
3783 * Since POSIX time routines are only guaranteed to work for times since the
3784 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3785 * applies Gregorian calendar rules even to dates before the 16th century
3786 * doesn't bother me. Besides, you'd need cultural context for a given
3787 * date to know whether it was Julian or Gregorian calendar, and that's
3788 * outside the scope for this routine. Since we convert back based on the
3789 * same rules we used to build the yearday, you'll only get strange results
3790 * for input which needed normalising, or for the 'odd' century years which
3791 * were leap years in the Julian calendar but not in the Gregorian one.
3792 * I can live with that.
3794 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3795 * that's still outside the scope for POSIX time manipulation, so I don't
3799 year = 1900 + ptm->tm_year;
3800 month = ptm->tm_mon;
3801 mday = ptm->tm_mday;
3807 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3808 yearday += month*MONTH_TO_DAYS + mday + jday;
3810 * Note that we don't know when leap-seconds were or will be,
3811 * so we have to trust the user if we get something which looks
3812 * like a sensible leap-second. Wild values for seconds will
3813 * be rationalised, however.
3815 if ((unsigned) ptm->tm_sec <= 60) {
3822 secs += 60 * ptm->tm_min;
3823 secs += SECS_PER_HOUR * ptm->tm_hour;
3825 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3826 /* got negative remainder, but need positive time */
3827 /* back off an extra day to compensate */
3828 yearday += (secs/SECS_PER_DAY)-1;
3829 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3832 yearday += (secs/SECS_PER_DAY);
3833 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3836 else if (secs >= SECS_PER_DAY) {
3837 yearday += (secs/SECS_PER_DAY);
3838 secs %= SECS_PER_DAY;
3840 ptm->tm_hour = secs/SECS_PER_HOUR;
3841 secs %= SECS_PER_HOUR;
3842 ptm->tm_min = secs/60;
3844 ptm->tm_sec += secs;
3845 /* done with time of day effects */
3847 * The algorithm for yearday has (so far) left it high by 428.
3848 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3849 * bias it by 123 while trying to figure out what year it
3850 * really represents. Even with this tweak, the reverse
3851 * translation fails for years before A.D. 0001.
3852 * It would still fail for Feb 29, but we catch that one below.
3854 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3855 yearday -= YEAR_ADJUST;
3856 year = (yearday / DAYS_PER_QCENT) * 400;
3857 yearday %= DAYS_PER_QCENT;
3858 odd_cent = yearday / DAYS_PER_CENT;
3859 year += odd_cent * 100;
3860 yearday %= DAYS_PER_CENT;
3861 year += (yearday / DAYS_PER_QYEAR) * 4;
3862 yearday %= DAYS_PER_QYEAR;
3863 odd_year = yearday / DAYS_PER_YEAR;
3865 yearday %= DAYS_PER_YEAR;
3866 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3871 yearday += YEAR_ADJUST; /* recover March 1st crock */
3872 month = yearday*DAYS_TO_MONTH;
3873 yearday -= month*MONTH_TO_DAYS;
3874 /* recover other leap-year adjustment */
3883 ptm->tm_year = year - 1900;
3885 ptm->tm_mday = yearday;
3886 ptm->tm_mon = month;
3890 ptm->tm_mon = month - 1;
3892 /* re-build yearday based on Jan 1 to get tm_yday */
3894 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3895 yearday += 14*MONTH_TO_DAYS + 1;
3896 ptm->tm_yday = jday - yearday;
3897 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3901 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)
3905 /* Note that yday and wday effectively are ignored by this function, as mini_mktime() overwrites them */
3912 PERL_ARGS_ASSERT_MY_STRFTIME;
3914 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3917 mytm.tm_hour = hour;
3918 mytm.tm_mday = mday;
3920 mytm.tm_year = year;
3921 mytm.tm_wday = wday;
3922 mytm.tm_yday = yday;
3923 mytm.tm_isdst = isdst;
3925 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3926 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3931 #ifdef HAS_TM_TM_GMTOFF
3932 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3934 #ifdef HAS_TM_TM_ZONE
3935 mytm.tm_zone = mytm2.tm_zone;
3940 Newx(buf, buflen, char);
3942 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
3943 len = strftime(buf, buflen, fmt, &mytm);
3947 ** The following is needed to handle to the situation where
3948 ** tmpbuf overflows. Basically we want to allocate a buffer
3949 ** and try repeatedly. The reason why it is so complicated
3950 ** is that getting a return value of 0 from strftime can indicate
3951 ** one of the following:
3952 ** 1. buffer overflowed,
3953 ** 2. illegal conversion specifier, or
3954 ** 3. the format string specifies nothing to be returned(not
3955 ** an error). This could be because format is an empty string
3956 ** or it specifies %p that yields an empty string in some locale.
3957 ** If there is a better way to make it portable, go ahead by
3960 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
3963 /* Possibly buf overflowed - try again with a bigger buf */
3964 const int fmtlen = strlen(fmt);
3965 int bufsize = fmtlen + buflen;
3967 Renew(buf, bufsize, char);
3970 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
3971 buflen = strftime(buf, bufsize, fmt, &mytm);
3974 if (buflen > 0 && buflen < bufsize)
3976 /* heuristic to prevent out-of-memory errors */
3977 if (bufsize > 100*fmtlen) {
3983 Renew(buf, bufsize, char);
3988 Perl_croak(aTHX_ "panic: no strftime");
3994 #define SV_CWD_RETURN_UNDEF \
3998 #define SV_CWD_ISDOT(dp) \
3999 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4000 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4003 =head1 Miscellaneous Functions
4005 =for apidoc getcwd_sv
4007 Fill C<sv> with current working directory
4012 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4013 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4014 * getcwd(3) if available
4015 * Comments from the original:
4016 * This is a faster version of getcwd. It's also more dangerous
4017 * because you might chdir out of a directory that you can't chdir
4021 Perl_getcwd_sv(pTHX_ SV *sv)
4026 PERL_ARGS_ASSERT_GETCWD_SV;
4030 char buf[MAXPATHLEN];
4032 /* Some getcwd()s automatically allocate a buffer of the given
4033 * size from the heap if they are given a NULL buffer pointer.
4034 * The problem is that this behaviour is not portable. */
4035 if (getcwd(buf, sizeof(buf) - 1)) {
4040 SV_CWD_RETURN_UNDEF;
4047 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4051 SvUPGRADE(sv, SVt_PV);
4053 if (PerlLIO_lstat(".", &statbuf) < 0) {
4054 SV_CWD_RETURN_UNDEF;
4057 orig_cdev = statbuf.st_dev;
4058 orig_cino = statbuf.st_ino;
4068 if (PerlDir_chdir("..") < 0) {
4069 SV_CWD_RETURN_UNDEF;
4071 if (PerlLIO_stat(".", &statbuf) < 0) {
4072 SV_CWD_RETURN_UNDEF;
4075 cdev = statbuf.st_dev;
4076 cino = statbuf.st_ino;
4078 if (odev == cdev && oino == cino) {
4081 if (!(dir = PerlDir_open("."))) {
4082 SV_CWD_RETURN_UNDEF;
4085 while ((dp = PerlDir_read(dir)) != NULL) {
4087 namelen = dp->d_namlen;
4089 namelen = strlen(dp->d_name);
4092 if (SV_CWD_ISDOT(dp)) {
4096 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4097 SV_CWD_RETURN_UNDEF;
4100 tdev = statbuf.st_dev;
4101 tino = statbuf.st_ino;
4102 if (tino == oino && tdev == odev) {
4108 SV_CWD_RETURN_UNDEF;
4111 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4112 SV_CWD_RETURN_UNDEF;
4115 SvGROW(sv, pathlen + namelen + 1);
4119 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4122 /* prepend current directory to the front */
4124 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4125 pathlen += (namelen + 1);
4127 #ifdef VOID_CLOSEDIR
4130 if (PerlDir_close(dir) < 0) {
4131 SV_CWD_RETURN_UNDEF;
4137 SvCUR_set(sv, pathlen);
4141 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4142 SV_CWD_RETURN_UNDEF;
4145 if (PerlLIO_stat(".", &statbuf) < 0) {
4146 SV_CWD_RETURN_UNDEF;
4149 cdev = statbuf.st_dev;
4150 cino = statbuf.st_ino;
4152 if (cdev != orig_cdev || cino != orig_cino) {
4153 Perl_croak(aTHX_ "Unstable directory path, "
4154 "current directory changed unexpectedly");
4167 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4168 # define EMULATE_SOCKETPAIR_UDP
4171 #ifdef EMULATE_SOCKETPAIR_UDP
4173 S_socketpair_udp (int fd[2]) {
4175 /* Fake a datagram socketpair using UDP to localhost. */
4176 int sockets[2] = {-1, -1};
4177 struct sockaddr_in addresses[2];
4179 Sock_size_t size = sizeof(struct sockaddr_in);
4180 unsigned short port;
4183 memset(&addresses, 0, sizeof(addresses));
4186 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4187 if (sockets[i] == -1)
4188 goto tidy_up_and_fail;
4190 addresses[i].sin_family = AF_INET;
4191 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4192 addresses[i].sin_port = 0; /* kernel choses port. */
4193 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4194 sizeof(struct sockaddr_in)) == -1)
4195 goto tidy_up_and_fail;
4198 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4199 for each connect the other socket to it. */
4202 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4204 goto tidy_up_and_fail;
4205 if (size != sizeof(struct sockaddr_in))
4206 goto abort_tidy_up_and_fail;
4207 /* !1 is 0, !0 is 1 */
4208 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4209 sizeof(struct sockaddr_in)) == -1)
4210 goto tidy_up_and_fail;
4213 /* Now we have 2 sockets connected to each other. I don't trust some other
4214 process not to have already sent a packet to us (by random) so send
4215 a packet from each to the other. */
4218 /* I'm going to send my own port number. As a short.
4219 (Who knows if someone somewhere has sin_port as a bitfield and needs
4220 this routine. (I'm assuming crays have socketpair)) */
4221 port = addresses[i].sin_port;
4222 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4223 if (got != sizeof(port)) {
4225 goto tidy_up_and_fail;
4226 goto abort_tidy_up_and_fail;
4230 /* Packets sent. I don't trust them to have arrived though.
4231 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4232 connect to localhost will use a second kernel thread. In 2.6 the
4233 first thread running the connect() returns before the second completes,
4234 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4235 returns 0. Poor programs have tripped up. One poor program's authors'
4236 had a 50-1 reverse stock split. Not sure how connected these were.)
4237 So I don't trust someone not to have an unpredictable UDP stack.
4241 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4242 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4246 FD_SET((unsigned int)sockets[0], &rset);
4247 FD_SET((unsigned int)sockets[1], &rset);
4249 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4250 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4251 || !FD_ISSET(sockets[1], &rset)) {
4252 /* I hope this is portable and appropriate. */
4254 goto tidy_up_and_fail;
4255 goto abort_tidy_up_and_fail;
4259 /* And the paranoia department even now doesn't trust it to have arrive
4260 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4262 struct sockaddr_in readfrom;
4263 unsigned short buffer[2];
4268 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4269 sizeof(buffer), MSG_DONTWAIT,
4270 (struct sockaddr *) &readfrom, &size);
4272 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4274 (struct sockaddr *) &readfrom, &size);
4278 goto tidy_up_and_fail;
4279 if (got != sizeof(port)
4280 || size != sizeof(struct sockaddr_in)
4281 /* Check other socket sent us its port. */
4282 || buffer[0] != (unsigned short) addresses[!i].sin_port
4283 /* Check kernel says we got the datagram from that socket */
4284 || readfrom.sin_family != addresses[!i].sin_family
4285 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4286 || readfrom.sin_port != addresses[!i].sin_port)
4287 goto abort_tidy_up_and_fail;
4290 /* My caller (my_socketpair) has validated that this is non-NULL */
4293 /* I hereby declare this connection open. May God bless all who cross
4297 abort_tidy_up_and_fail:
4298 errno = ECONNABORTED;
4302 if (sockets[0] != -1)
4303 PerlLIO_close(sockets[0]);
4304 if (sockets[1] != -1)
4305 PerlLIO_close(sockets[1]);
4310 #endif /* EMULATE_SOCKETPAIR_UDP */
4312 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4314 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4315 /* Stevens says that family must be AF_LOCAL, protocol 0.
4316 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4321 struct sockaddr_in listen_addr;
4322 struct sockaddr_in connect_addr;
4327 || family != AF_UNIX
4330 errno = EAFNOSUPPORT;
4338 #ifdef EMULATE_SOCKETPAIR_UDP
4339 if (type == SOCK_DGRAM)
4340 return S_socketpair_udp(fd);
4343 aTHXa(PERL_GET_THX);
4344 listener = PerlSock_socket(AF_INET, type, 0);
4347 memset(&listen_addr, 0, sizeof(listen_addr));
4348 listen_addr.sin_family = AF_INET;
4349 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4350 listen_addr.sin_port = 0; /* kernel choses port. */
4351 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4352 sizeof(listen_addr)) == -1)
4353 goto tidy_up_and_fail;
4354 if (PerlSock_listen(listener, 1) == -1)
4355 goto tidy_up_and_fail;
4357 connector = PerlSock_socket(AF_INET, type, 0);
4358 if (connector == -1)
4359 goto tidy_up_and_fail;
4360 /* We want to find out the port number to connect to. */
4361 size = sizeof(connect_addr);
4362 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4364 goto tidy_up_and_fail;
4365 if (size != sizeof(connect_addr))
4366 goto abort_tidy_up_and_fail;
4367 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4368 sizeof(connect_addr)) == -1)
4369 goto tidy_up_and_fail;
4371 size = sizeof(listen_addr);
4372 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4375 goto tidy_up_and_fail;
4376 if (size != sizeof(listen_addr))
4377 goto abort_tidy_up_and_fail;
4378 PerlLIO_close(listener);
4379 /* Now check we are talking to ourself by matching port and host on the
4381 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4383 goto tidy_up_and_fail;
4384 if (size != sizeof(connect_addr)
4385 || listen_addr.sin_family != connect_addr.sin_family
4386 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4387 || listen_addr.sin_port != connect_addr.sin_port) {
4388 goto abort_tidy_up_and_fail;
4394 abort_tidy_up_and_fail:
4396 errno = ECONNABORTED; /* This would be the standard thing to do. */
4398 # ifdef ECONNREFUSED
4399 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4401 errno = ETIMEDOUT; /* Desperation time. */
4408 PerlLIO_close(listener);
4409 if (connector != -1)
4410 PerlLIO_close(connector);
4412 PerlLIO_close(acceptor);
4418 /* In any case have a stub so that there's code corresponding
4419 * to the my_socketpair in embed.fnc. */
4421 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4422 #ifdef HAS_SOCKETPAIR
4423 return socketpair(family, type, protocol, fd);
4432 =for apidoc sv_nosharing
4434 Dummy routine which "shares" an SV when there is no sharing module present.
4435 Or "locks" it. Or "unlocks" it. In other
4436 words, ignores its single SV argument.
4437 Exists to avoid test for a C<NULL> function pointer and because it could
4438 potentially warn under some level of strict-ness.
4444 Perl_sv_nosharing(pTHX_ SV *sv)
4446 PERL_UNUSED_CONTEXT;
4447 PERL_UNUSED_ARG(sv);
4452 =for apidoc sv_destroyable
4454 Dummy routine which reports that object can be destroyed when there is no
4455 sharing module present. It ignores its single SV argument, and returns
4456 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4457 could potentially warn under some level of strict-ness.
4463 Perl_sv_destroyable(pTHX_ SV *sv)
4465 PERL_UNUSED_CONTEXT;
4466 PERL_UNUSED_ARG(sv);
4471 Perl_parse_unicode_opts(pTHX_ const char **popt)
4473 const char *p = *popt;
4476 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4482 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4485 if (p && *p && *p != '\n' && *p != '\r') {
4487 goto the_end_of_the_opts_parser;
4489 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4493 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4499 case PERL_UNICODE_STDIN:
4500 opt |= PERL_UNICODE_STDIN_FLAG; break;
4501 case PERL_UNICODE_STDOUT:
4502 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4503 case PERL_UNICODE_STDERR:
4504 opt |= PERL_UNICODE_STDERR_FLAG; break;
4505 case PERL_UNICODE_STD:
4506 opt |= PERL_UNICODE_STD_FLAG; break;
4507 case PERL_UNICODE_IN:
4508 opt |= PERL_UNICODE_IN_FLAG; break;
4509 case PERL_UNICODE_OUT:
4510 opt |= PERL_UNICODE_OUT_FLAG; break;
4511 case PERL_UNICODE_INOUT:
4512 opt |= PERL_UNICODE_INOUT_FLAG; break;
4513 case PERL_UNICODE_LOCALE:
4514 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4515 case PERL_UNICODE_ARGV:
4516 opt |= PERL_UNICODE_ARGV_FLAG; break;
4517 case PERL_UNICODE_UTF8CACHEASSERT:
4518 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4520 if (*p != '\n' && *p != '\r') {
4521 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4524 "Unknown Unicode option letter '%c'", *p);
4531 opt = PERL_UNICODE_DEFAULT_FLAGS;
4533 the_end_of_the_opts_parser:
4535 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4536 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4537 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4545 # include <starlet.h>
4552 * This is really just a quick hack which grabs various garbage
4553 * values. It really should be a real hash algorithm which
4554 * spreads the effect of every input bit onto every output bit,
4555 * if someone who knows about such things would bother to write it.
4556 * Might be a good idea to add that function to CORE as well.
4557 * No numbers below come from careful analysis or anything here,
4558 * except they are primes and SEED_C1 > 1E6 to get a full-width
4559 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4560 * probably be bigger too.
4563 # define SEED_C1 1000003
4564 #define SEED_C4 73819
4566 # define SEED_C1 25747
4567 #define SEED_C4 20639
4571 #define SEED_C5 26107
4573 #ifndef PERL_NO_DEV_RANDOM
4577 #ifdef HAS_GETTIMEOFDAY
4578 struct timeval when;
4583 /* This test is an escape hatch, this symbol isn't set by Configure. */
4584 #ifndef PERL_NO_DEV_RANDOM
4585 #ifndef PERL_RANDOM_DEVICE
4586 /* /dev/random isn't used by default because reads from it will block
4587 * if there isn't enough entropy available. You can compile with
4588 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4589 * is enough real entropy to fill the seed. */
4590 # ifdef __amigaos4__
4591 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4593 # define PERL_RANDOM_DEVICE "/dev/urandom"
4596 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
4598 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4606 #ifdef HAS_GETTIMEOFDAY
4607 PerlProc_gettimeofday(&when,NULL);
4608 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4611 u = (U32)SEED_C1 * when;
4613 u += SEED_C3 * (U32)PerlProc_getpid();
4614 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4615 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4616 u += SEED_C5 * (U32)PTR2UV(&when);
4622 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4624 #ifndef NO_PERL_HASH_ENV
4629 PERL_ARGS_ASSERT_GET_HASH_SEED;
4631 #ifndef NO_PERL_HASH_ENV
4632 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4635 # ifndef USE_HASH_SEED_EXPLICIT
4637 /* ignore leading spaces */
4638 while (isSPACE(*env_pv))
4640 # ifdef USE_PERL_PERTURB_KEYS
4641 /* if they set it to "0" we disable key traversal randomization completely */
4642 if (strEQ(env_pv,"0")) {
4643 PL_hash_rand_bits_enabled= 0;
4645 /* otherwise switch to deterministic mode */
4646 PL_hash_rand_bits_enabled= 2;
4649 /* ignore a leading 0x... if it is there */
4650 if (env_pv[0] == '0' && env_pv[1] == 'x')
4653 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4654 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4655 if ( isXDIGIT(*env_pv)) {
4656 seed_buffer[i] |= READ_XDIGIT(env_pv);
4659 while (isSPACE(*env_pv))
4662 if (*env_pv && !isXDIGIT(*env_pv)) {
4663 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4665 /* should we check for unparsed crap? */
4666 /* should we warn about unused hex? */
4667 /* should we warn about insufficient hex? */
4673 (void)seedDrand01((Rand_seed_t)seed());
4675 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4676 seed_buffer[i] = (unsigned char)(Drand01() * (U8_MAX+1));
4679 #ifdef USE_PERL_PERTURB_KEYS
4680 { /* initialize PL_hash_rand_bits from the hash seed.
4681 * This value is highly volatile, it is updated every
4682 * hash insert, and is used as part of hash bucket chain
4683 * randomization and hash iterator randomization. */
4684 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4685 for( i = 0; i < sizeof(UV) ; i++ ) {
4686 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4687 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4690 # ifndef NO_PERL_HASH_ENV
4691 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4693 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4694 PL_hash_rand_bits_enabled= 0;
4695 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4696 PL_hash_rand_bits_enabled= 1;
4697 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4698 PL_hash_rand_bits_enabled= 2;
4700 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4707 #ifdef PERL_GLOBAL_STRUCT
4709 #define PERL_GLOBAL_STRUCT_INIT
4710 #include "opcode.h" /* the ppaddr and check */
4713 Perl_init_global_struct(pTHX)
4715 struct perl_vars *plvarsp = NULL;
4716 # ifdef PERL_GLOBAL_STRUCT
4717 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4718 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4719 PERL_UNUSED_CONTEXT;
4720 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4721 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4722 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4726 plvarsp = PL_VarsPtr;
4727 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4732 # define PERLVAR(prefix,var,type) /**/
4733 # define PERLVARA(prefix,var,n,type) /**/
4734 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4735 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4736 # include "perlvars.h"
4741 # ifdef PERL_GLOBAL_STRUCT
4744 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4745 if (!plvarsp->Gppaddr)
4749 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4750 if (!plvarsp->Gcheck)
4752 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4753 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4755 # ifdef PERL_SET_VARS
4756 PERL_SET_VARS(plvarsp);
4758 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4759 plvarsp->Gsv_placeholder.sv_flags = 0;
4760 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4762 # undef PERL_GLOBAL_STRUCT_INIT
4767 #endif /* PERL_GLOBAL_STRUCT */
4769 #ifdef PERL_GLOBAL_STRUCT
4772 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4774 int veto = plvarsp->Gveto_cleanup;
4776 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4777 PERL_UNUSED_CONTEXT;
4778 # ifdef PERL_GLOBAL_STRUCT
4779 # ifdef PERL_UNSET_VARS
4780 PERL_UNSET_VARS(plvarsp);
4784 free(plvarsp->Gppaddr);
4785 free(plvarsp->Gcheck);
4786 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4792 #endif /* PERL_GLOBAL_STRUCT */
4796 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4797 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4798 * given, and you supply your own implementation.
4800 * The default implementation reads a single env var, PERL_MEM_LOG,
4801 * expecting one or more of the following:
4803 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4804 * 'm' - memlog was PERL_MEM_LOG=1
4805 * 's' - svlog was PERL_SV_LOG=1
4806 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4808 * This makes the logger controllable enough that it can reasonably be
4809 * added to the system perl.
4812 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4813 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4815 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4817 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4818 * writes to. In the default logger, this is settable at runtime.
4820 #ifndef PERL_MEM_LOG_FD
4821 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4824 #ifndef PERL_MEM_LOG_NOIMPL
4826 # ifdef DEBUG_LEAKING_SCALARS
4827 # define SV_LOG_SERIAL_FMT " [%lu]"
4828 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4830 # define SV_LOG_SERIAL_FMT
4831 # define _SV_LOG_SERIAL_ARG(sv)
4835 S_mem_log_common(enum mem_log_type mlt, const UV n,
4836 const UV typesize, const char *type_name, const SV *sv,
4837 Malloc_t oldalloc, Malloc_t newalloc,
4838 const char *filename, const int linenumber,
4839 const char *funcname)
4843 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4845 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4848 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4850 /* We can't use SVs or PerlIO for obvious reasons,
4851 * so we'll use stdio and low-level IO instead. */
4852 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4854 # ifdef HAS_GETTIMEOFDAY
4855 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4856 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4858 gettimeofday(&tv, 0);
4860 # define MEM_LOG_TIME_FMT "%10d: "
4861 # define MEM_LOG_TIME_ARG (int)when
4865 /* If there are other OS specific ways of hires time than
4866 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4867 * probably that they would be used to fill in the struct
4874 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4875 && uv && uv <= PERL_INT_MAX
4879 fd = PERL_MEM_LOG_FD;
4882 if (strchr(pmlenv, 't')) {
4883 len = my_snprintf(buf, sizeof(buf),
4884 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4885 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4889 len = my_snprintf(buf, sizeof(buf),
4890 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4891 " %s = %" IVdf ": %" UVxf "\n",
4892 filename, linenumber, funcname, n, typesize,
4893 type_name, n * typesize, PTR2UV(newalloc));
4896 len = my_snprintf(buf, sizeof(buf),
4897 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4898 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4899 filename, linenumber, funcname, n, typesize,
4900 type_name, n * typesize, PTR2UV(oldalloc),
4904 len = my_snprintf(buf, sizeof(buf),
4905 "free: %s:%d:%s: %" UVxf "\n",
4906 filename, linenumber, funcname,
4911 len = my_snprintf(buf, sizeof(buf),
4912 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
4913 mlt == MLT_NEW_SV ? "new" : "del",
4914 filename, linenumber, funcname,
4915 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4920 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4924 #endif /* !PERL_MEM_LOG_NOIMPL */
4926 #ifndef PERL_MEM_LOG_NOIMPL
4928 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4929 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4931 /* this is suboptimal, but bug compatible. User is providing their
4932 own implementation, but is getting these functions anyway, and they
4933 do nothing. But _NOIMPL users should be able to cope or fix */
4935 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4936 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
4940 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4942 const char *filename, const int linenumber,
4943 const char *funcname)
4945 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
4947 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4948 NULL, NULL, newalloc,
4949 filename, linenumber, funcname);
4954 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4955 Malloc_t oldalloc, Malloc_t newalloc,
4956 const char *filename, const int linenumber,
4957 const char *funcname)
4959 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
4961 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4962 NULL, oldalloc, newalloc,
4963 filename, linenumber, funcname);
4968 Perl_mem_log_free(Malloc_t oldalloc,
4969 const char *filename, const int linenumber,
4970 const char *funcname)
4972 PERL_ARGS_ASSERT_MEM_LOG_FREE;
4974 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4975 filename, linenumber, funcname);
4980 Perl_mem_log_new_sv(const SV *sv,
4981 const char *filename, const int linenumber,
4982 const char *funcname)
4984 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4985 filename, linenumber, funcname);
4989 Perl_mem_log_del_sv(const SV *sv,
4990 const char *filename, const int linenumber,
4991 const char *funcname)
4993 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4994 filename, linenumber, funcname);
4997 #endif /* PERL_MEM_LOG */
5000 =for apidoc my_sprintf
5002 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
5003 the length of the string written to the buffer. Only rare pre-ANSI systems
5004 need the wrapper function - usually this is a direct call to C<sprintf>.
5008 #ifndef SPRINTF_RETURNS_STRLEN
5010 Perl_my_sprintf(char *buffer, const char* pat, ...)
5013 PERL_ARGS_ASSERT_MY_SPRINTF;
5014 va_start(args, pat);
5015 vsprintf(buffer, pat, args);
5017 return strlen(buffer);
5022 =for apidoc quadmath_format_single
5024 C<quadmath_snprintf()> is very strict about its C<format> string and will
5025 fail, returning -1, if the format is invalid. It accepts exactly
5028 C<quadmath_format_single()> checks that the intended single spec looks
5029 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
5030 and has C<Q> before it. This is not a full "printf syntax check",
5033 Returns the format if it is valid, NULL if not.
5035 C<quadmath_format_single()> can and will actually patch in the missing
5036 C<Q>, if necessary. In this case it will return the modified copy of
5037 the format, B<which the caller will need to free.>
5039 See also L</quadmath_format_needed>.
5045 Perl_quadmath_format_single(const char* format)
5049 PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
5051 if (format[0] != '%' || strchr(format + 1, '%'))
5053 len = strlen(format);
5054 /* minimum length three: %Qg */
5055 if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
5057 if (format[len - 2] != 'Q') {
5059 Newx(fixed, len + 1, char);
5060 memcpy(fixed, format, len - 1);
5061 fixed[len - 1] = 'Q';
5062 fixed[len ] = format[len - 1];
5064 return (const char*)fixed;
5071 =for apidoc quadmath_format_needed
5073 C<quadmath_format_needed()> returns true if the C<format> string seems to
5074 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
5075 or returns false otherwise.
5077 The format specifier detection is not complete printf-syntax detection,
5078 but it should catch most common cases.
5080 If true is returned, those arguments B<should> in theory be processed
5081 with C<quadmath_snprintf()>, but in case there is more than one such
5082 format specifier (see L</quadmath_format_single>), and if there is
5083 anything else beyond that one (even just a single byte), they
5084 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
5085 accepting only one format spec, and nothing else.
5086 In this case, the code should probably fail.
5092 Perl_quadmath_format_needed(const char* format)
5094 const char *p = format;
5097 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5099 while ((q = strchr(p, '%'))) {
5101 if (*q == '+') /* plus */
5103 if (*q == '#') /* alt */
5105 if (*q == '*') /* width */
5109 while (isDIGIT(*q)) q++;
5112 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5117 while (isDIGIT(*q)) q++;
5119 if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5128 =for apidoc my_snprintf
5130 The C library C<snprintf> functionality, if available and
5131 standards-compliant (uses C<vsnprintf>, actually). However, if the
5132 C<vsnprintf> is not available, will unfortunately use the unsafe
5133 C<vsprintf> which can overrun the buffer (there is an overrun check,
5134 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5135 getting C<vsnprintf>.
5140 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5144 PERL_ARGS_ASSERT_MY_SNPRINTF;
5145 #ifndef HAS_VSNPRINTF
5146 PERL_UNUSED_VAR(len);
5148 va_start(ap, format);
5151 const char* qfmt = quadmath_format_single(format);
5152 bool quadmath_valid = FALSE;
5154 /* If the format looked promising, use it as quadmath. */
5155 retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
5157 if (qfmt != format) {
5161 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
5163 quadmath_valid = TRUE;
5168 assert(qfmt == NULL);
5169 /* quadmath_format_single() will return false for example for
5170 * "foo = %g", or simply "%g". We could handle the %g by
5171 * using quadmath for the NV args. More complex cases of
5172 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5173 * quadmath-valid but has stuff in front).
5175 * Handling the "Q-less" cases right would require walking
5176 * through the va_list and rewriting the format, calling
5177 * quadmath for the NVs, building a new va_list, and then
5178 * letting vsnprintf/vsprintf to take care of the other
5179 * arguments. This may be doable.
5181 * We do not attempt that now. But for paranoia, we here try
5182 * to detect some common (but not all) cases where the
5183 * "Q-less" %[efgaEFGA] formats are present, and die if
5184 * detected. This doesn't fix the problem, but it stops the
5185 * vsnprintf/vsprintf pulling doubles off the va_list when
5186 * __float128 NVs should be pulled off instead.
5188 * If quadmath_format_needed() returns false, we are reasonably
5189 * certain that we can call vnsprintf() or vsprintf() safely. */
5190 if (!quadmath_valid && quadmath_format_needed(format))
5191 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5196 #ifdef HAS_VSNPRINTF
5197 retval = vsnprintf(buffer, len, format, ap);
5199 retval = vsprintf(buffer, format, ap);
5202 /* vsprintf() shows failure with < 0 */
5204 #ifdef HAS_VSNPRINTF
5205 /* vsnprintf() shows failure with >= len */
5207 (len > 0 && (Size_t)retval >= len)
5210 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5215 =for apidoc my_vsnprintf
5217 The C library C<vsnprintf> if available and standards-compliant.
5218 However, if if the C<vsnprintf> is not available, will unfortunately
5219 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5220 overrun check, but that may be too late). Consider using
5221 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5226 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5229 PERL_UNUSED_ARG(buffer);
5230 PERL_UNUSED_ARG(len);
5231 PERL_UNUSED_ARG(format);
5232 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5233 PERL_UNUSED_ARG((void*)ap);
5234 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5241 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5242 Perl_va_copy(ap, apc);
5243 # ifdef HAS_VSNPRINTF
5244 retval = vsnprintf(buffer, len, format, apc);
5246 PERL_UNUSED_ARG(len);
5247 retval = vsprintf(buffer, format, apc);
5251 # ifdef HAS_VSNPRINTF
5252 retval = vsnprintf(buffer, len, format, ap);
5254 PERL_UNUSED_ARG(len);
5255 retval = vsprintf(buffer, format, ap);
5257 #endif /* #ifdef NEED_VA_COPY */
5258 /* vsprintf() shows failure with < 0 */
5260 #ifdef HAS_VSNPRINTF
5261 /* vsnprintf() shows failure with >= len */
5263 (len > 0 && (Size_t)retval >= len)
5266 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5272 Perl_my_clearenv(pTHX)
5275 #if ! defined(PERL_MICRO)
5276 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5278 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5279 # if defined(USE_ENVIRON_ARRAY)
5280 # if defined(USE_ITHREADS)
5281 /* only the parent thread can clobber the process environment */
5282 if (PL_curinterp == aTHX)
5283 # endif /* USE_ITHREADS */
5285 # if ! defined(PERL_USE_SAFE_PUTENV)
5286 if ( !PL_use_safe_putenv) {
5288 if (environ == PL_origenviron)
5289 environ = (char**)safesysmalloc(sizeof(char*));
5291 for (i = 0; environ[i]; i++)
5292 (void)safesysfree(environ[i]);
5295 # else /* PERL_USE_SAFE_PUTENV */
5296 # if defined(HAS_CLEARENV)
5298 # elif defined(HAS_UNSETENV)
5299 int bsiz = 80; /* Most envvar names will be shorter than this. */
5300 char *buf = (char*)safesysmalloc(bsiz);
5301 while (*environ != NULL) {
5302 char *e = strchr(*environ, '=');
5303 int l = e ? e - *environ : (int)strlen(*environ);
5305 (void)safesysfree(buf);
5306 bsiz = l + 1; /* + 1 for the \0. */
5307 buf = (char*)safesysmalloc(bsiz);
5309 memcpy(buf, *environ, l);
5311 (void)unsetenv(buf);
5313 (void)safesysfree(buf);
5314 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5315 /* Just null environ and accept the leakage. */
5317 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5318 # endif /* ! PERL_USE_SAFE_PUTENV */
5320 # endif /* USE_ENVIRON_ARRAY */
5321 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5322 #endif /* PERL_MICRO */
5325 #ifdef PERL_IMPLICIT_CONTEXT
5327 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5328 the global PL_my_cxt_index is incremented, and that value is assigned to
5329 that module's static my_cxt_index (who's address is passed as an arg).
5330 Then, for each interpreter this function is called for, it makes sure a
5331 void* slot is available to hang the static data off, by allocating or
5332 extending the interpreter's PL_my_cxt_list array */
5334 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
5336 Perl_my_cxt_init(pTHX_ int *index, size_t size)
5340 PERL_ARGS_ASSERT_MY_CXT_INIT;
5342 /* this module hasn't been allocated an index yet */
5343 #if defined(USE_ITHREADS)
5344 MUTEX_LOCK(&PL_my_ctx_mutex);
5346 *index = PL_my_cxt_index++;
5347 #if defined(USE_ITHREADS)
5348 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5352 /* make sure the array is big enough */
5353 if (PL_my_cxt_size <= *index) {
5354 if (PL_my_cxt_size) {
5355 while (PL_my_cxt_size <= *index)
5356 PL_my_cxt_size *= 2;
5357 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5360 PL_my_cxt_size = 16;
5361 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5364 /* newSV() allocates one more than needed */
5365 p = (void*)SvPVX(newSV(size-1));
5366 PL_my_cxt_list[*index] = p;
5367 Zero(p, size, char);
5371 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5374 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5379 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5381 for (index = 0; index < PL_my_cxt_index; index++) {
5382 const char *key = PL_my_cxt_keys[index];
5383 /* try direct pointer compare first - there are chances to success,
5384 * and it's much faster.
5386 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5393 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5399 PERL_ARGS_ASSERT_MY_CXT_INIT;
5401 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5403 /* this module hasn't been allocated an index yet */
5404 #if defined(USE_ITHREADS)
5405 MUTEX_LOCK(&PL_my_ctx_mutex);
5407 index = PL_my_cxt_index++;
5408 #if defined(USE_ITHREADS)
5409 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5413 /* make sure the array is big enough */
5414 if (PL_my_cxt_size <= index) {
5415 int old_size = PL_my_cxt_size;
5417 if (PL_my_cxt_size) {
5418 while (PL_my_cxt_size <= index)
5419 PL_my_cxt_size *= 2;
5420 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5421 Renew(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5424 PL_my_cxt_size = 16;
5425 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5426 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5428 for (i = old_size; i < PL_my_cxt_size; i++) {
5429 PL_my_cxt_keys[i] = 0;
5430 PL_my_cxt_list[i] = 0;
5433 PL_my_cxt_keys[index] = my_cxt_key;
5434 /* newSV() allocates one more than needed */
5435 p = (void*)SvPVX(newSV(size-1));
5436 PL_my_cxt_list[index] = p;
5437 Zero(p, size, char);
5440 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5441 #endif /* PERL_IMPLICIT_CONTEXT */
5444 /* Perl_xs_handshake():
5445 implement the various XS_*_BOOTCHECK macros, which are added to .c
5446 files by ExtUtils::ParseXS, to check that the perl the module was built
5447 with is binary compatible with the running perl.
5450 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5451 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5453 The meaning of the varargs is determined the U32 key arg (which is not
5454 a format string). The fields of key are assembled by using HS_KEY().
5456 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5457 "PerlInterpreter *" and represents the callers context; otherwise it is
5458 of type "CV *", and is the boot xsub's CV.
5460 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5461 for example, and IO.dll was linked with threaded perl524.dll, and both
5462 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5463 successfully can load IO.dll into the process but simultaneously it
5464 loaded an interpreter of a different version into the process, and XS
5465 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5466 use through perl526.dll's my_perl->Istack_base.
5468 v_my_perl cannot be the first arg, since then 'key' will be out of
5469 place in a threaded vs non-threaded mixup; and analyzing the key
5470 number's bitfields won't reveal the problem, since it will be a valid
5471 key (unthreaded perl) on interp side, but croak will report the XS mod's
5472 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5473 it's a threaded perl and an unthreaded XS module, threaded perl will
5474 look at an uninit C stack or an uninit register to get 'key'
5475 (remember that it assumes that the 1st arg is the interp cxt).
5477 'file' is the source filename of the caller.
5481 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5487 #ifdef PERL_IMPLICIT_CONTEXT
5494 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5495 va_start(args, file);
5497 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5498 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5499 if (UNLIKELY(got != need))
5501 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5502 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5503 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5504 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5505 passed to the XS DLL */
5506 #ifdef PERL_IMPLICIT_CONTEXT
5507 xs_interp = (tTHX)v_my_perl;
5511 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5512 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5513 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5514 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5515 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5516 location in the unthreaded perl binary) stored in CV * to figure out if this
5517 Perl_xs_handshake was called by the same pp_entersub */
5518 cv = (CV*)v_my_perl;
5519 xs_spp = (SV***)CvHSCXT(cv);
5521 need = &PL_stack_sp;
5523 if(UNLIKELY(got != need)) {
5524 bad_handshake:/* recycle branch and string from above */
5525 if(got != (void *)HSf_NOCHK)
5526 noperl_die("%s: loadable library and perl binaries are mismatched"
5527 " (got handshake key %p, needed %p)\n",
5531 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5532 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5533 PL_xsubfilename = file; /* so the old name must be restored for
5534 additional XSUBs to register themselves */
5535 /* XSUBs can't be perl lang/perl5db.pl debugged
5536 if (PERLDB_LINE_OR_SAVESRC)
5537 (void)gv_fetchfile(file); */
5540 if(key & HSf_POPMARK) {
5542 { SV **mark = PL_stack_base + ax++;
5544 items = (I32)(SP - MARK);
5548 items = va_arg(args, U32);
5549 ax = va_arg(args, U32);
5553 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5554 if((apiverlen = HS_GETAPIVERLEN(key))) {
5555 char * api_p = va_arg(args, char*);
5556 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5557 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5558 sizeof("v" PERL_API_VERSION_STRING)-1))
5559 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5560 api_p, SVfARG(PL_stack_base[ax + 0]),
5561 "v" PERL_API_VERSION_STRING);
5566 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5567 if((xsverlen = HS_GETXSVERLEN(key)))
5568 S_xs_version_bootcheck(aTHX_
5569 items, ax, va_arg(args, char*), xsverlen);
5577 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5581 const char *vn = NULL;
5582 SV *const module = PL_stack_base[ax];
5584 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5586 if (items >= 2) /* version supplied as bootstrap arg */
5587 sv = PL_stack_base[ax + 1];
5589 /* XXX GV_ADDWARN */
5591 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5592 if (!sv || !SvOK(sv)) {
5594 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5598 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5599 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5600 ? sv : sv_2mortal(new_version(sv));
5601 xssv = upg_version(xssv, 0);
5602 if ( vcmp(pmsv,xssv) ) {
5603 SV *string = vstringify(xssv);
5604 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5605 " does not match ", SVfARG(module), SVfARG(string));
5607 SvREFCNT_dec(string);
5608 string = vstringify(pmsv);
5611 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5614 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5616 SvREFCNT_dec(string);
5618 Perl_sv_2mortal(aTHX_ xpt);
5619 Perl_croak_sv(aTHX_ xpt);
5625 =for apidoc my_strlcat
5627 The C library C<strlcat> if available, or a Perl implementation of it.
5628 This operates on C C<NUL>-terminated strings.
5630 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5631 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5632 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5633 practice this should not happen as it means that either C<size> is incorrect or
5634 that C<dst> is not a proper C<NUL>-terminated string).
5636 Note that C<size> is the full size of the destination buffer and
5637 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5638 room for the C<NUL> should be included in C<size>.
5640 The return value is the total length that C<dst> would have if C<size> is
5641 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5642 C<src>. If C<size> is smaller than the return, the excess was not appended.
5646 Description stolen from http://man.openbsd.org/strlcat.3
5650 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5652 Size_t used, length, copy;
5655 length = strlen(src);
5656 if (size > 0 && used < size - 1) {
5657 copy = (length >= size - used) ? size - used - 1 : length;
5658 memcpy(dst + used, src, copy);
5659 dst[used + copy] = '\0';
5661 return used + length;
5667 =for apidoc my_strlcpy
5669 The C library C<strlcpy> if available, or a Perl implementation of it.
5670 This operates on C C<NUL>-terminated strings.
5672 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5673 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5675 The return value is the total length C<src> would be if the copy completely
5676 succeeded. If it is larger than C<size>, the excess was not copied.
5680 Description stolen from http://man.openbsd.org/strlcpy.3
5684 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5686 Size_t length, copy;
5688 length = strlen(src);
5690 copy = (length >= size) ? size - 1 : length;
5691 memcpy(dst, src, copy);
5698 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5699 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5700 long _ftol( double ); /* Defined by VC6 C libs. */
5701 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5704 PERL_STATIC_INLINE bool
5705 S_gv_has_usable_name(pTHX_ GV *gv)
5709 && HvENAME(GvSTASH(gv))
5710 && (gvp = (GV **)hv_fetchhek(
5711 GvSTASH(gv), GvNAME_HEK(gv), 0
5717 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5719 SV * const dbsv = GvSVn(PL_DBsub);
5720 const bool save_taint = TAINT_get;
5722 /* When we are called from pp_goto (svp is null),
5723 * we do not care about using dbsv to call CV;
5724 * it's for informational purposes only.
5727 PERL_ARGS_ASSERT_GET_DB_SUB;
5731 if (!PERLDB_SUB_NN) {
5734 if (!svp && !CvLEXICAL(cv)) {
5735 gv_efullname3(dbsv, gv, NULL);
5737 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5738 || strEQ(GvNAME(gv), "END")
5739 || ( /* Could be imported, and old sub redefined. */
5740 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5742 !( (SvTYPE(*svp) == SVt_PVGV)
5743 && (GvCV((const GV *)*svp) == cv)
5744 /* Use GV from the stack as a fallback. */
5745 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5749 /* GV is potentially non-unique, or contain different CV. */
5750 SV * const tmp = newRV(MUTABLE_SV(cv));
5751 sv_setsv(dbsv, tmp);
5755 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5756 sv_catpvs(dbsv, "::");
5757 sv_cathek(dbsv, GvNAME_HEK(gv));
5761 const int type = SvTYPE(dbsv);
5762 if (type < SVt_PVIV && type != SVt_IV)
5763 sv_upgrade(dbsv, SVt_PVIV);
5764 (void)SvIOK_on(dbsv);
5765 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5768 TAINT_IF(save_taint);
5769 #ifdef NO_TAINT_SUPPORT
5770 PERL_UNUSED_VAR(save_taint);
5775 Perl_my_dirfd(DIR * dir) {
5777 /* Most dirfd implementations have problems when passed NULL. */
5782 #elif defined(HAS_DIR_DD_FD)
5785 Perl_croak_nocontext(PL_no_func, "dirfd");
5786 NOT_REACHED; /* NOTREACHED */
5792 Perl_get_re_arg(pTHX_ SV *sv) {
5798 sv = MUTABLE_SV(SvRV(sv));
5799 if (SvTYPE(sv) == SVt_REGEXP)
5800 return (REGEXP*) sv;
5807 * This code is derived from drand48() implementation from FreeBSD,
5808 * found in lib/libc/gen/_rand48.c.
5810 * The U64 implementation is original, based on the POSIX
5811 * specification for drand48().
5815 * Copyright (c) 1993 Martin Birgmeier
5816 * All rights reserved.
5818 * You may redistribute unmodified or modified versions of this source
5819 * code provided that the above copyright notice and this and the
5820 * following conditions are retained.
5822 * This software is provided ``as is'', and comes with no warranties
5823 * of any kind. I shall in no event be liable for anything that happens
5824 * to anyone/anything when using this software.
5827 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5829 #ifdef PERL_DRAND48_QUAD
5831 #define DRAND48_MULT U64_CONST(0x5deece66d)
5832 #define DRAND48_ADD 0xb
5833 #define DRAND48_MASK U64_CONST(0xffffffffffff)
5837 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5838 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5839 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5840 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5841 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5842 #define FREEBSD_DRAND48_ADD (0x000b)
5844 const unsigned short _rand48_mult[3] = {
5845 FREEBSD_DRAND48_MULT_0,
5846 FREEBSD_DRAND48_MULT_1,
5847 FREEBSD_DRAND48_MULT_2
5849 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5854 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5856 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5858 #ifdef PERL_DRAND48_QUAD
5859 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5861 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5862 random_state->seed[1] = (U16) seed;
5863 random_state->seed[2] = (U16) (seed >> 16);
5868 Perl_drand48_r(perl_drand48_t *random_state)
5870 PERL_ARGS_ASSERT_DRAND48_R;
5872 #ifdef PERL_DRAND48_QUAD
5873 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5876 return ldexp((double)*random_state, -48);
5882 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5883 + (U32) _rand48_add;
5884 temp[0] = (U16) accu; /* lower 16 bits */
5885 accu >>= sizeof(U16) * 8;
5886 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5887 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5888 temp[1] = (U16) accu; /* middle 16 bits */
5889 accu >>= sizeof(U16) * 8;
5890 accu += _rand48_mult[0] * random_state->seed[2]
5891 + _rand48_mult[1] * random_state->seed[1]
5892 + _rand48_mult[2] * random_state->seed[0];
5893 random_state->seed[0] = temp[0];
5894 random_state->seed[1] = temp[1];
5895 random_state->seed[2] = (U16) accu;
5897 return ldexp((double) random_state->seed[0], -48) +
5898 ldexp((double) random_state->seed[1], -32) +
5899 ldexp((double) random_state->seed[2], -16);
5904 #ifdef USE_C_BACKTRACE
5906 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5911 /* abfd is the BFD handle. */
5913 /* bfd_syms is the BFD symbol table. */
5915 /* bfd_text is handle to the the ".text" section of the object file. */
5917 /* Since opening the executable and scanning its symbols is quite
5918 * heavy operation, we remember the filename we used the last time,
5919 * and do the opening and scanning only if the filename changes.
5920 * This removes most (but not all) open+scan cycles. */
5921 const char* fname_prev;
5924 /* Given a dl_info, update the BFD context if necessary. */
5925 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5927 /* BFD open and scan only if the filename changed. */
5928 if (ctx->fname_prev == NULL ||
5929 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5931 bfd_close(ctx->abfd);
5933 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5935 if (bfd_check_format(ctx->abfd, bfd_object)) {
5936 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5937 if (symbol_size > 0) {
5938 Safefree(ctx->bfd_syms);
5939 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5941 bfd_get_section_by_name(ctx->abfd, ".text");
5949 ctx->fname_prev = dl_info->dli_fname;
5953 /* Given a raw frame, try to symbolize it and store
5954 * symbol information (source file, line number) away. */
5955 static void bfd_symbolize(bfd_context* ctx,
5958 STRLEN* symbol_name_size,
5960 STRLEN* source_name_size,
5961 STRLEN* source_line)
5963 *symbol_name = NULL;
5964 *symbol_name_size = 0;
5966 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5968 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5971 unsigned int line = 0;
5972 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5973 ctx->bfd_syms, offset,
5974 &file, &func, &line) &&
5975 file && func && line > 0) {
5976 /* Size and copy the source file, use only
5977 * the basename of the source file.
5979 * NOTE: the basenames are fine for the
5980 * Perl source files, but may not always
5981 * be the best idea for XS files. */
5982 const char *p, *b = NULL;
5983 /* Look for the last slash. */
5984 for (p = file; *p; p++) {
5988 if (b == NULL || *b == 0) {
5991 *source_name_size = p - b + 1;
5992 Newx(*source_name, *source_name_size + 1, char);
5993 Copy(b, *source_name, *source_name_size + 1, char);
5995 *symbol_name_size = strlen(func);
5996 Newx(*symbol_name, *symbol_name_size + 1, char);
5997 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5999 *source_line = line;
6005 #endif /* #ifdef USE_BFD */
6009 /* OS X has no public API for for 'symbolicating' (Apple official term)
6010 * stack addresses to {function_name, source_file, line_number}.
6011 * Good news: there is command line utility atos(1) which does that.
6012 * Bad news 1: it's a command line utility.
6013 * Bad news 2: one needs to have the Developer Tools installed.
6014 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
6016 * To recap: we need to open a pipe for reading for a utility which
6017 * might not exist, or exists in different locations, and then parse
6018 * the output. And since this is all for a low-level API, we cannot
6019 * use high-level stuff. Thanks, Apple. */
6022 /* tool is set to the absolute pathname of the tool to use:
6025 /* format is set to a printf format string used for building
6026 * the external command to run. */
6028 /* unavail is set if e.g. xcrun cannot be found, or something
6029 * else happens that makes getting the backtrace dubious. Note,
6030 * however, that the context isn't persistent, the next call to
6031 * get_c_backtrace() will start from scratch. */
6033 /* fname is the current object file name. */
6035 /* object_base_addr is the base address of the shared object. */
6036 void* object_base_addr;
6039 /* Given |dl_info|, updates the context. If the context has been
6040 * marked unavailable, return immediately. If not but the tool has
6041 * not been set, set it to either "xcrun atos" or "atos" (also set the
6042 * format to use for creating commands for piping), or if neither is
6043 * unavailable (one needs the Developer Tools installed), mark the context
6044 * an unavailable. Finally, update the filename (object name),
6045 * and its base address. */
6047 static void atos_update(atos_context* ctx,
6052 if (ctx->tool == NULL) {
6053 const char* tools[] = {
6057 const char* formats[] = {
6058 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6059 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6063 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6064 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6065 ctx->tool = tools[i];
6066 ctx->format = formats[i];
6070 if (ctx->tool == NULL) {
6071 ctx->unavail = TRUE;
6075 if (ctx->fname == NULL ||
6076 strNE(dl_info->dli_fname, ctx->fname)) {
6077 ctx->fname = dl_info->dli_fname;
6078 ctx->object_base_addr = dl_info->dli_fbase;
6082 /* Given an output buffer end |p| and its |start|, matches
6083 * for the atos output, extracting the source code location
6084 * and returning non-NULL if possible, returning NULL otherwise. */
6085 static const char* atos_parse(const char* p,
6087 STRLEN* source_name_size,
6088 STRLEN* source_line) {
6089 /* atos() output is something like:
6090 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6091 * We cannot use Perl regular expressions, because we need to
6092 * stay low-level. Therefore here we have a rolled-out version
6093 * of a state machine which matches _backwards_from_the_end_ and
6094 * if there's a success, returns the starts of the filename,
6095 * also setting the filename size and the source line number.
6096 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6097 const char* source_number_start;
6098 const char* source_name_end;
6099 const char* source_line_end;
6100 const char* close_paren;
6103 /* Skip trailing whitespace. */
6104 while (p > start && isspace(*p)) p--;
6105 /* Now we should be at the close paren. */
6106 if (p == start || *p != ')')
6110 /* Now we should be in the line number. */
6111 if (p == start || !isdigit(*p))
6113 /* Skip over the digits. */
6114 while (p > start && isdigit(*p))
6116 /* Now we should be at the colon. */
6117 if (p == start || *p != ':')
6119 source_number_start = p + 1;
6120 source_name_end = p; /* Just beyond the end. */
6122 /* Look for the open paren. */
6123 while (p > start && *p != '(')
6128 *source_name_size = source_name_end - p;
6129 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6130 && source_line_end == close_paren
6131 && uv <= PERL_INT_MAX
6133 *source_line = (STRLEN)uv;
6139 /* Given a raw frame, read a pipe from the symbolicator (that's the
6140 * technical term) atos, reads the result, and parses the source code
6141 * location. We must stay low-level, so we use snprintf(), pipe(),
6142 * and fread(), and then also parse the output ourselves. */
6143 static void atos_symbolize(atos_context* ctx,
6146 STRLEN* source_name_size,
6147 STRLEN* source_line)
6155 /* Simple security measure: if there's any funny business with
6156 * the object name (used as "-o '%s'" ), leave since at least
6157 * partially the user controls it. */
6158 for (p = ctx->fname; *p; p++) {
6159 if (*p == '\'' || iscntrl(*p)) {
6160 ctx->unavail = TRUE;
6164 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6165 ctx->fname, ctx->object_base_addr, raw_frame);
6166 if (cnt < sizeof(cmd)) {
6167 /* Undo nostdio.h #defines that disable stdio.
6168 * This is somewhat naughty, but is used elsewhere
6169 * in the core, and affects only OS X. */
6174 FILE* fp = popen(cmd, "r");
6175 /* At the moment we open a new pipe for each stack frame.
6176 * This is naturally somewhat slow, but hopefully generating
6177 * stack traces is never going to in a performance critical path.
6179 * We could play tricks with atos by batching the stack
6180 * addresses to be resolved: atos can either take multiple
6181 * addresses from the command line, or read addresses from
6182 * a file (though the mess of creating temporary files would
6183 * probably negate much of any possible speedup).
6185 * Normally there are only two objects present in the backtrace:
6186 * perl itself, and the libdyld.dylib. (Note that the object
6187 * filenames contain the full pathname, so perl may not always
6188 * be in the same place.) Whenever the object in the
6189 * backtrace changes, the base address also changes.
6191 * The problem with batching the addresses, though, would be
6192 * matching the results with the addresses: the parsing of
6193 * the results is already painful enough with a single address. */
6196 UV cnt = fread(out, 1, sizeof(out), fp);
6197 if (cnt < sizeof(out)) {
6198 const char* p = atos_parse(out + cnt - 1, out,
6203 *source_name_size, char);
6204 Copy(p, *source_name,
6205 *source_name_size, char);
6213 #endif /* #ifdef PERL_DARWIN */
6216 =for apidoc get_c_backtrace
6218 Collects the backtrace (aka "stacktrace") into a single linear
6219 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6221 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6222 returning at most C<depth> frames.
6228 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6230 /* Note that here we must stay as low-level as possible: Newx(),
6231 * Copy(), Safefree(); since we may be called from anywhere,
6232 * so we should avoid higher level constructs like SVs or AVs.
6234 * Since we are using safesysmalloc() via Newx(), don't try
6235 * getting backtrace() there, unless you like deep recursion. */
6237 /* Currently only implemented with backtrace() and dladdr(),
6238 * for other platforms NULL is returned. */
6240 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6241 /* backtrace() is available via <execinfo.h> in glibc and in most
6242 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6244 /* We try fetching this many frames total, but then discard
6245 * the |skip| first ones. For the remaining ones we will try
6246 * retrieving more information with dladdr(). */
6247 int try_depth = skip + depth;
6249 /* The addresses (program counters) returned by backtrace(). */
6252 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6255 /* Sizes _including_ the terminating \0 of the object name
6256 * and symbol name strings. */
6257 STRLEN* object_name_sizes;
6258 STRLEN* symbol_name_sizes;
6261 /* The symbol names comes either from dli_sname,
6262 * or if using BFD, they can come from BFD. */
6263 char** symbol_names;
6266 /* The source code location information. Dug out with e.g. BFD. */
6267 char** source_names;
6268 STRLEN* source_name_sizes;
6269 STRLEN* source_lines;
6271 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6272 int got_depth; /* How many frames were returned from backtrace(). */
6273 UV frame_count = 0; /* How many frames we return. */
6274 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6277 bfd_context bfd_ctx;
6280 atos_context atos_ctx;
6283 /* Here are probably possibilities for optimizing. We could for
6284 * example have a struct that contains most of these and then
6285 * allocate |try_depth| of them, saving a bunch of malloc calls.
6286 * Note, however, that |frames| could not be part of that struct
6287 * because backtrace() will want an array of just them. Also be
6288 * careful about the name strings. */
6289 Newx(raw_frames, try_depth, void*);
6290 Newx(dl_infos, try_depth, Dl_info);
6291 Newx(object_name_sizes, try_depth, STRLEN);
6292 Newx(symbol_name_sizes, try_depth, STRLEN);
6293 Newx(source_names, try_depth, char*);
6294 Newx(source_name_sizes, try_depth, STRLEN);
6295 Newx(source_lines, try_depth, STRLEN);
6297 Newx(symbol_names, try_depth, char*);
6300 /* Get the raw frames. */
6301 got_depth = (int)backtrace(raw_frames, try_depth);
6303 /* We use dladdr() instead of backtrace_symbols() because we want
6304 * the full details instead of opaque strings. This is useful for
6305 * two reasons: () the details are needed for further symbolic
6306 * digging, for example in OS X (2) by having the details we fully
6307 * control the output, which in turn is useful when more platforms
6308 * are added: we can keep out output "portable". */
6310 /* We want a single linear allocation, which can then be freed
6311 * with a single swoop. We will do the usual trick of first
6312 * walking over the structure and seeing how much we need to
6313 * allocate, then allocating, and then walking over the structure
6314 * the second time and populating it. */
6316 /* First we must compute the total size of the buffer. */
6317 total_bytes = sizeof(Perl_c_backtrace_header);
6318 if (got_depth > skip) {
6321 bfd_init(); /* Is this safe to call multiple times? */
6322 Zero(&bfd_ctx, 1, bfd_context);
6325 Zero(&atos_ctx, 1, atos_context);
6327 for (i = skip; i < try_depth; i++) {
6328 Dl_info* dl_info = &dl_infos[i];
6330 object_name_sizes[i] = 0;
6331 source_names[i] = NULL;
6332 source_name_sizes[i] = 0;
6333 source_lines[i] = 0;
6335 /* Yes, zero from dladdr() is failure. */
6336 if (dladdr(raw_frames[i], dl_info)) {
6337 total_bytes += sizeof(Perl_c_backtrace_frame);
6339 object_name_sizes[i] =
6340 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6341 symbol_name_sizes[i] =
6342 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6344 bfd_update(&bfd_ctx, dl_info);
6345 bfd_symbolize(&bfd_ctx, raw_frames[i],
6347 &symbol_name_sizes[i],
6349 &source_name_sizes[i],
6353 atos_update(&atos_ctx, dl_info);
6354 atos_symbolize(&atos_ctx,
6357 &source_name_sizes[i],
6361 /* Plus ones for the terminating \0. */
6362 total_bytes += object_name_sizes[i] + 1;
6363 total_bytes += symbol_name_sizes[i] + 1;
6364 total_bytes += source_name_sizes[i] + 1;
6372 Safefree(bfd_ctx.bfd_syms);
6376 /* Now we can allocate and populate the result buffer. */
6377 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6378 Zero(bt, total_bytes, char);
6379 bt->header.frame_count = frame_count;
6380 bt->header.total_bytes = total_bytes;
6381 if (frame_count > 0) {
6382 Perl_c_backtrace_frame* frame = bt->frame_info;
6383 char* name_base = (char *)(frame + frame_count);
6384 char* name_curr = name_base; /* Outputting the name strings here. */
6386 for (i = skip; i < skip + frame_count; i++) {
6387 Dl_info* dl_info = &dl_infos[i];
6389 frame->addr = raw_frames[i];
6390 frame->object_base_addr = dl_info->dli_fbase;
6391 frame->symbol_addr = dl_info->dli_saddr;
6393 /* Copies a string, including the \0, and advances the name_curr.
6394 * Also copies the start and the size to the frame. */
6395 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6397 Copy(src, name_curr, size, char); \
6398 frame->doffset = name_curr - (char*)bt; \
6399 frame->dsize = size; \
6400 name_curr += size; \
6403 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6405 object_name_size, object_name_sizes[i]);
6408 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6410 symbol_name_size, symbol_name_sizes[i]);
6411 Safefree(symbol_names[i]);
6413 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6415 symbol_name_size, symbol_name_sizes[i]);
6418 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6420 source_name_size, source_name_sizes[i]);
6421 Safefree(source_names[i]);
6423 #undef PERL_C_BACKTRACE_STRCPY
6425 frame->source_line_number = source_lines[i];
6429 assert(total_bytes ==
6430 (UV)(sizeof(Perl_c_backtrace_header) +
6431 frame_count * sizeof(Perl_c_backtrace_frame) +
6432 name_curr - name_base));
6435 Safefree(symbol_names);
6437 bfd_close(bfd_ctx.abfd);
6440 Safefree(source_lines);
6441 Safefree(source_name_sizes);
6442 Safefree(source_names);
6443 Safefree(symbol_name_sizes);
6444 Safefree(object_name_sizes);
6445 /* Assuming the strings returned by dladdr() are pointers
6446 * to read-only static memory (the object file), so that
6447 * they do not need freeing (and cannot be). */
6449 Safefree(raw_frames);
6452 PERL_UNUSED_ARGV(depth);
6453 PERL_UNUSED_ARGV(skip);
6459 =for apidoc free_c_backtrace
6461 Deallocates a backtrace received from get_c_bracktrace.
6467 =for apidoc get_c_backtrace_dump
6469 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6470 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6472 The appended output looks like:
6475 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6476 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6479 The fields are tab-separated. The first column is the depth (zero
6480 being the innermost non-skipped frame). In the hex:offset, the hex is
6481 where the program counter was in C<S_parse_body>, and the :offset (might
6482 be missing) tells how much inside the C<S_parse_body> the program counter was.
6484 The C<util.c:1716> is the source code file and line number.
6486 The F</usr/bin/perl> is obvious (hopefully).
6488 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6489 if the platform doesn't support retrieving the information;
6490 if the binary is missing the debug information;
6491 if the optimizer has transformed the code by for example inlining.
6497 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6499 Perl_c_backtrace* bt;
6501 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6503 Perl_c_backtrace_frame* frame;
6504 SV* dsv = newSVpvs("");
6506 for (i = 0, frame = bt->frame_info;
6507 i < bt->header.frame_count; i++, frame++) {
6508 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6509 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6510 /* Symbol (function) names might disappear without debug info.
6512 * The source code location might disappear in case of the
6513 * optimizer inlining or otherwise rearranging the code. */
6514 if (frame->symbol_addr) {
6515 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6517 ((char*)frame->addr - (char*)frame->symbol_addr));
6519 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6520 frame->symbol_name_size &&
6521 frame->symbol_name_offset ?
6522 (char*)bt + frame->symbol_name_offset : "-");
6523 if (frame->source_name_size &&
6524 frame->source_name_offset &&
6525 frame->source_line_number) {
6526 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6527 (char*)bt + frame->source_name_offset,
6528 (UV)frame->source_line_number);
6530 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6532 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6533 frame->object_name_size &&
6534 frame->object_name_offset ?
6535 (char*)bt + frame->object_name_offset : "-");
6536 /* The frame->object_base_addr is not output,
6537 * but it is used for symbolizing/symbolicating. */
6538 sv_catpvs(dsv, "\n");
6541 Perl_free_c_backtrace(bt);
6550 =for apidoc dump_c_backtrace
6552 Dumps the C backtrace to the given C<fp>.
6554 Returns true if a backtrace could be retrieved, false if not.
6560 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6564 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6566 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6569 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6575 #endif /* #ifdef USE_C_BACKTRACE */
6577 #ifdef PERL_TSA_ACTIVE
6579 /* pthread_mutex_t and perl_mutex are typedef equivalent
6580 * so casting the pointers is fine. */
6582 int perl_tsa_mutex_lock(perl_mutex* mutex)
6584 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6587 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6589 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6592 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6594 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6602 /* log a sub call or return */
6605 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6613 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6616 HEK *hek = CvNAME_HEK(cv);
6617 func = HEK_KEY(hek);
6623 start = (const COP *)CvSTART(cv);
6624 file = CopFILE(start);
6625 line = CopLINE(start);
6626 stash = CopSTASHPV(start);
6629 PERL_SUB_ENTRY(func, file, line, stash);
6632 PERL_SUB_RETURN(func, file, line, stash);
6637 /* log a require file loading/loaded */
6640 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6642 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6645 PERL_LOADING_FILE(name);
6648 PERL_LOADED_FILE(name);
6653 /* log an op execution */
6656 Perl_dtrace_probe_op(pTHX_ const OP *op)
6658 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6660 PERL_OP_ENTRY(OP_NAME(op));
6664 /* log a compile/run phase change */
6667 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6669 const char *ph_old = PL_phase_names[PL_phase];
6670 const char *ph_new = PL_phase_names[phase];
6672 PERL_PHASE_CHANGE(ph_new, ph_old);
6678 * ex: set ts=8 sts=4 sw=4 et: