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 assert(bigend >= big);
821 if ((STRLEN)(bigend - big) < littlelen) {
823 && ((STRLEN)(bigend - big) == littlelen - 1)
825 || (*big == *little &&
826 memEQ((char *)big, (char *)little, littlelen - 1))))
831 switch (littlelen) { /* Special cases for 0, 1 and 2 */
833 return (char*)big; /* Cannot be SvTAIL! */
836 if (tail && !multiline) /* Anchor only! */
837 /* [-1] is safe because we know that bigend != big. */
838 return (char *) (bigend - (bigend[-1] == '\n'));
840 s = (unsigned char *)memchr((void*)big, *little, bigend-big);
844 return (char *) bigend;
848 if (tail && !multiline) {
849 /* a littlestr with SvTAIL must be of the form "X\n" (where X
850 * is a single char). It is anchored, and can only match
851 * "....X\n" or "....X" */
852 if (bigend[-2] == *little && bigend[-1] == '\n')
853 return (char*)bigend - 2;
854 if (bigend[-1] == *little)
855 return (char*)bigend - 1;
860 /* memchr() is likely to be very fast, possibly using whatever
861 * hardware support is available, such as checking a whole
862 * cache line in one instruction.
863 * So for a 2 char pattern, calling memchr() is likely to be
864 * faster than running FBM, or rolling our own. The previous
865 * version of this code was roll-your-own which typically
866 * only needed to read every 2nd char, which was good back in
867 * the day, but no longer.
869 unsigned char c1 = little[0];
870 unsigned char c2 = little[1];
872 /* *** for all this case, bigend points to the last char,
873 * not the trailing \0: this makes the conditions slightly
879 /* do a quick test for c1 before calling memchr();
880 * this avoids the expensive fn call overhead when
881 * there are lots of c1's */
882 if (LIKELY(*s != c1)) {
884 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
891 /* failed; try searching for c2 this time; that way
892 * we don't go pathologically slow when the string
893 * consists mostly of c1's or vice versa.
898 s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
906 /* c1, c2 the same */
916 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
917 if (!s || s >= bigend)
924 /* failed to find 2 chars; try anchored match at end without
926 if (tail && bigend[0] == little[0])
927 return (char *)bigend;
932 break; /* Only lengths 0 1 and 2 have special-case code. */
935 if (tail && !multiline) { /* tail anchored? */
936 s = bigend - littlelen;
937 if (s >= big && bigend[-1] == '\n' && *s == *little
938 /* Automatically of length > 2 */
939 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
941 return (char*)s; /* how sweet it is */
944 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
946 return (char*)s + 1; /* how sweet it is */
952 /* not compiled; use Perl_ninstr() instead */
953 char * const b = ninstr((char*)big,(char*)bigend,
954 (char*)little, (char*)little + littlelen);
956 assert(!tail); /* valid => FBM; tail only set on SvVALID SVs */
961 if (littlelen > (STRLEN)(bigend - big))
965 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
966 const unsigned char *oldlittle;
970 --littlelen; /* Last char found by table lookup */
973 little += littlelen; /* last char */
976 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
977 const unsigned char lastc = *little;
981 if ((tmp = table[*s])) {
982 /* *s != lastc; earliest position it could match now is
983 * tmp slots further on */
984 if ((s += tmp) >= bigend)
986 if (LIKELY(*s != lastc)) {
988 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
998 /* hand-rolled strncmp(): less expensive than calling the
999 * real function (maybe???) */
1001 unsigned char * const olds = s;
1006 if (*--s == *--little)
1008 s = olds + 1; /* here we pay the price for failure */
1010 if (s < bigend) /* fake up continue to outer loop */
1020 && memEQ((char *)(bigend - littlelen),
1021 (char *)(oldlittle - littlelen), littlelen) )
1022 return (char*)bigend - littlelen;
1027 /* copy a string to a safe spot */
1030 =head1 Memory Management
1034 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1035 string which is a duplicate of C<pv>. The size of the string is
1036 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1037 characters and must have a trailing C<NUL>. The memory allocated for the new
1038 string can be freed with the C<Safefree()> function.
1040 On some platforms, Windows for example, all allocated memory owned by a thread
1041 is deallocated when that thread ends. So if you need that not to happen, you
1042 need to use the shared memory functions, such as C<L</savesharedpv>>.
1048 Perl_savepv(pTHX_ const char *pv)
1050 PERL_UNUSED_CONTEXT;
1055 const STRLEN pvlen = strlen(pv)+1;
1056 Newx(newaddr, pvlen, char);
1057 return (char*)memcpy(newaddr, pv, pvlen);
1061 /* same thing but with a known length */
1066 Perl's version of what C<strndup()> would be if it existed. Returns a
1067 pointer to a newly allocated string which is a duplicate of the first
1068 C<len> bytes from C<pv>, plus a trailing
1069 C<NUL> byte. The memory allocated for
1070 the new string can be freed with the C<Safefree()> function.
1072 On some platforms, Windows for example, all allocated memory owned by a thread
1073 is deallocated when that thread ends. So if you need that not to happen, you
1074 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1080 Perl_savepvn(pTHX_ const char *pv, I32 len)
1083 PERL_UNUSED_CONTEXT;
1087 Newx(newaddr,len+1,char);
1088 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1090 /* might not be null terminated */
1091 newaddr[len] = '\0';
1092 return (char *) CopyD(pv,newaddr,len,char);
1095 return (char *) ZeroD(newaddr,len+1,char);
1100 =for apidoc savesharedpv
1102 A version of C<savepv()> which allocates the duplicate string in memory
1103 which is shared between threads.
1108 Perl_savesharedpv(pTHX_ const char *pv)
1113 PERL_UNUSED_CONTEXT;
1118 pvlen = strlen(pv)+1;
1119 newaddr = (char*)PerlMemShared_malloc(pvlen);
1123 return (char*)memcpy(newaddr, pv, pvlen);
1127 =for apidoc savesharedpvn
1129 A version of C<savepvn()> which allocates the duplicate string in memory
1130 which is shared between threads. (With the specific difference that a C<NULL>
1131 pointer is not acceptable)
1136 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1138 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1140 PERL_UNUSED_CONTEXT;
1141 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1146 newaddr[len] = '\0';
1147 return (char*)memcpy(newaddr, pv, len);
1151 =for apidoc savesvpv
1153 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1154 the passed in SV using C<SvPV()>
1156 On some platforms, Windows for example, all allocated memory owned by a thread
1157 is deallocated when that thread ends. So if you need that not to happen, you
1158 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1164 Perl_savesvpv(pTHX_ SV *sv)
1167 const char * const pv = SvPV_const(sv, len);
1170 PERL_ARGS_ASSERT_SAVESVPV;
1173 Newx(newaddr,len,char);
1174 return (char *) CopyD(pv,newaddr,len,char);
1178 =for apidoc savesharedsvpv
1180 A version of C<savesharedpv()> which allocates the duplicate string in
1181 memory which is shared between threads.
1187 Perl_savesharedsvpv(pTHX_ SV *sv)
1190 const char * const pv = SvPV_const(sv, len);
1192 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1194 return savesharedpvn(pv, len);
1197 /* the SV for Perl_form() and mess() is not kept in an arena */
1205 if (PL_phase != PERL_PHASE_DESTRUCT)
1206 return newSVpvs_flags("", SVs_TEMP);
1211 /* Create as PVMG now, to avoid any upgrading later */
1213 Newxz(any, 1, XPVMG);
1214 SvFLAGS(sv) = SVt_PVMG;
1215 SvANY(sv) = (void*)any;
1217 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1222 #if defined(PERL_IMPLICIT_CONTEXT)
1224 Perl_form_nocontext(const char* pat, ...)
1229 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1230 va_start(args, pat);
1231 retval = vform(pat, &args);
1235 #endif /* PERL_IMPLICIT_CONTEXT */
1238 =head1 Miscellaneous Functions
1241 Takes a sprintf-style format pattern and conventional
1242 (non-SV) arguments and returns the formatted string.
1244 (char *) Perl_form(pTHX_ const char* pat, ...)
1246 can be used any place a string (char *) is required:
1248 char * s = Perl_form("%d.%d",major,minor);
1250 Uses a single private buffer so if you want to format several strings you
1251 must explicitly copy the earlier strings away (and free the copies when you
1258 Perl_form(pTHX_ const char* pat, ...)
1262 PERL_ARGS_ASSERT_FORM;
1263 va_start(args, pat);
1264 retval = vform(pat, &args);
1270 Perl_vform(pTHX_ const char *pat, va_list *args)
1272 SV * const sv = mess_alloc();
1273 PERL_ARGS_ASSERT_VFORM;
1274 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1279 =for apidoc Am|SV *|mess|const char *pat|...
1281 Take a sprintf-style format pattern and argument list. These are used to
1282 generate a string message. If the message does not end with a newline,
1283 then it will be extended with some indication of the current location
1284 in the code, as described for L</mess_sv>.
1286 Normally, the resulting message is returned in a new mortal SV.
1287 During global destruction a single SV may be shared between uses of
1293 #if defined(PERL_IMPLICIT_CONTEXT)
1295 Perl_mess_nocontext(const char *pat, ...)
1300 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1301 va_start(args, pat);
1302 retval = vmess(pat, &args);
1306 #endif /* PERL_IMPLICIT_CONTEXT */
1309 Perl_mess(pTHX_ const char *pat, ...)
1313 PERL_ARGS_ASSERT_MESS;
1314 va_start(args, pat);
1315 retval = vmess(pat, &args);
1321 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1324 /* Look for curop starting from o. cop is the last COP we've seen. */
1325 /* opnext means that curop is actually the ->op_next of the op we are
1328 PERL_ARGS_ASSERT_CLOSEST_COP;
1330 if (!o || !curop || (
1331 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1335 if (o->op_flags & OPf_KIDS) {
1337 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1340 /* If the OP_NEXTSTATE has been optimised away we can still use it
1341 * the get the file and line number. */
1343 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1344 cop = (const COP *)kid;
1346 /* Keep searching, and return when we've found something. */
1348 new_cop = closest_cop(cop, kid, curop, opnext);
1354 /* Nothing found. */
1360 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1362 Expands a message, intended for the user, to include an indication of
1363 the current location in the code, if the message does not already appear
1366 C<basemsg> is the initial message or object. If it is a reference, it
1367 will be used as-is and will be the result of this function. Otherwise it
1368 is used as a string, and if it already ends with a newline, it is taken
1369 to be complete, and the result of this function will be the same string.
1370 If the message does not end with a newline, then a segment such as C<at
1371 foo.pl line 37> will be appended, and possibly other clauses indicating
1372 the current state of execution. The resulting message will end with a
1375 Normally, the resulting message is returned in a new mortal SV.
1376 During global destruction a single SV may be shared between uses of this
1377 function. If C<consume> is true, then the function is permitted (but not
1378 required) to modify and return C<basemsg> instead of allocating a new SV.
1384 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1388 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1392 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1393 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1394 && grok_atoUV(ws, &wi, NULL)
1395 && wi <= PERL_INT_MAX
1397 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1402 PERL_ARGS_ASSERT_MESS_SV;
1404 if (SvROK(basemsg)) {
1410 sv_setsv(sv, basemsg);
1415 if (SvPOK(basemsg) && consume) {
1420 sv_copypv(sv, basemsg);
1423 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1425 * Try and find the file and line for PL_op. This will usually be
1426 * PL_curcop, but it might be a cop that has been optimised away. We
1427 * can try to find such a cop by searching through the optree starting
1428 * from the sibling of PL_curcop.
1433 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1438 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1439 OutCopFILE(cop), (IV)CopLINE(cop));
1442 /* Seems that GvIO() can be untrustworthy during global destruction. */
1443 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1444 && IoLINES(GvIOp(PL_last_in_gv)))
1447 const bool line_mode = (RsSIMPLE(PL_rs) &&
1448 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1449 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1450 SVfARG(PL_last_in_gv == PL_argvgv
1452 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1453 line_mode ? "line" : "chunk",
1454 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1456 if (PL_phase == PERL_PHASE_DESTRUCT)
1457 sv_catpvs(sv, " during global destruction");
1458 sv_catpvs(sv, ".\n");
1464 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1466 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1467 argument list, respectively. These are used to generate a string message. If
1469 message does not end with a newline, then it will be extended with
1470 some indication of the current location in the code, as described for
1473 Normally, the resulting message is returned in a new mortal SV.
1474 During global destruction a single SV may be shared between uses of
1481 Perl_vmess(pTHX_ const char *pat, va_list *args)
1483 SV * const sv = mess_alloc();
1485 PERL_ARGS_ASSERT_VMESS;
1487 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1488 return mess_sv(sv, 1);
1492 Perl_write_to_stderr(pTHX_ SV* msv)
1497 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1499 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1500 && (io = GvIO(PL_stderrgv))
1501 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1502 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1503 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1505 PerlIO * const serr = Perl_error_log;
1507 do_print(msv, serr);
1508 (void)PerlIO_flush(serr);
1513 =head1 Warning and Dieing
1516 /* Common code used in dieing and warning */
1519 S_with_queued_errors(pTHX_ SV *ex)
1521 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1522 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1523 sv_catsv(PL_errors, ex);
1524 ex = sv_mortalcopy(PL_errors);
1525 SvCUR_set(PL_errors, 0);
1531 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1536 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1537 /* sv_2cv might call Perl_croak() or Perl_warner() */
1538 SV * const oldhook = *hook;
1546 cv = sv_2cv(oldhook, &stash, &gv, 0);
1548 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1558 exarg = newSVsv(ex);
1559 SvREADONLY_on(exarg);
1562 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1566 call_sv(MUTABLE_SV(cv), G_DISCARD);
1575 =for apidoc Am|OP *|die_sv|SV *baseex
1577 Behaves the same as L</croak_sv>, except for the return type.
1578 It should be used only where the C<OP *> return type is required.
1579 The function never actually returns.
1585 # pragma warning( push )
1586 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1587 __declspec(noreturn) has non-void return type */
1588 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1589 __declspec(noreturn) has a return statement */
1592 Perl_die_sv(pTHX_ SV *baseex)
1594 PERL_ARGS_ASSERT_DIE_SV;
1597 NORETURN_FUNCTION_END;
1600 # pragma warning( pop )
1604 =for apidoc Am|OP *|die|const char *pat|...
1606 Behaves the same as L</croak>, except for the return type.
1607 It should be used only where the C<OP *> return type is required.
1608 The function never actually returns.
1613 #if defined(PERL_IMPLICIT_CONTEXT)
1615 # pragma warning( push )
1616 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1617 __declspec(noreturn) has non-void return type */
1618 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1619 __declspec(noreturn) has a return statement */
1622 Perl_die_nocontext(const char* pat, ...)
1626 va_start(args, pat);
1628 NOT_REACHED; /* NOTREACHED */
1630 NORETURN_FUNCTION_END;
1633 # pragma warning( pop )
1635 #endif /* PERL_IMPLICIT_CONTEXT */
1638 # pragma warning( push )
1639 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1640 __declspec(noreturn) has non-void return type */
1641 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1642 __declspec(noreturn) has a return statement */
1645 Perl_die(pTHX_ const char* pat, ...)
1648 va_start(args, pat);
1650 NOT_REACHED; /* NOTREACHED */
1652 NORETURN_FUNCTION_END;
1655 # pragma warning( pop )
1659 =for apidoc Am|void|croak_sv|SV *baseex
1661 This is an XS interface to Perl's C<die> function.
1663 C<baseex> is the error message or object. If it is a reference, it
1664 will be used as-is. Otherwise it is used as a string, and if it does
1665 not end with a newline then it will be extended with some indication of
1666 the current location in the code, as described for L</mess_sv>.
1668 The error message or object will be used as an exception, by default
1669 returning control to the nearest enclosing C<eval>, but subject to
1670 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1671 function never returns normally.
1673 To die with a simple string message, the L</croak> function may be
1680 Perl_croak_sv(pTHX_ SV *baseex)
1682 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1683 PERL_ARGS_ASSERT_CROAK_SV;
1684 invoke_exception_hook(ex, FALSE);
1689 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1691 This is an XS interface to Perl's C<die> function.
1693 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1694 argument list. These are used to generate a string message. If the
1695 message does not end with a newline, then it will be extended with
1696 some indication of the current location in the code, as described for
1699 The error message will be used as an exception, by default
1700 returning control to the nearest enclosing C<eval>, but subject to
1701 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1702 function never returns normally.
1704 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1705 (C<$@>) will be used as an error message or object instead of building an
1706 error message from arguments. If you want to throw a non-string object,
1707 or build an error message in an SV yourself, it is preferable to use
1708 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1714 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1716 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1717 invoke_exception_hook(ex, FALSE);
1722 =for apidoc Am|void|croak|const char *pat|...
1724 This is an XS interface to Perl's C<die> function.
1726 Take a sprintf-style format pattern and argument list. These are used to
1727 generate a string message. If the message does not end with a newline,
1728 then it will be extended with some indication of the current location
1729 in the code, as described for L</mess_sv>.
1731 The error message will be used as an exception, by default
1732 returning control to the nearest enclosing C<eval>, but subject to
1733 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1734 function never returns normally.
1736 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1737 (C<$@>) will be used as an error message or object instead of building an
1738 error message from arguments. If you want to throw a non-string object,
1739 or build an error message in an SV yourself, it is preferable to use
1740 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1745 #if defined(PERL_IMPLICIT_CONTEXT)
1747 Perl_croak_nocontext(const char *pat, ...)
1751 va_start(args, pat);
1753 NOT_REACHED; /* NOTREACHED */
1756 #endif /* PERL_IMPLICIT_CONTEXT */
1759 Perl_croak(pTHX_ const char *pat, ...)
1762 va_start(args, pat);
1764 NOT_REACHED; /* NOTREACHED */
1769 =for apidoc Am|void|croak_no_modify
1771 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1772 terser object code than using C<Perl_croak>. Less code used on exception code
1773 paths reduces CPU cache pressure.
1779 Perl_croak_no_modify(void)
1781 Perl_croak_nocontext( "%s", PL_no_modify);
1784 /* does not return, used in util.c perlio.c and win32.c
1785 This is typically called when malloc returns NULL.
1788 Perl_croak_no_mem(void)
1792 int fd = PerlIO_fileno(Perl_error_log);
1794 SETERRNO(EBADF,RMS_IFI);
1796 /* Can't use PerlIO to write as it allocates memory */
1797 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1802 /* does not return, used only in POPSTACK */
1804 Perl_croak_popstack(void)
1807 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1812 =for apidoc Am|void|warn_sv|SV *baseex
1814 This is an XS interface to Perl's C<warn> function.
1816 C<baseex> is the error message or object. If it is a reference, it
1817 will be used as-is. Otherwise it is used as a string, and if it does
1818 not end with a newline then it will be extended with some indication of
1819 the current location in the code, as described for L</mess_sv>.
1821 The error message or object will by default be written to standard error,
1822 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1824 To warn with a simple string message, the L</warn> function may be
1831 Perl_warn_sv(pTHX_ SV *baseex)
1833 SV *ex = mess_sv(baseex, 0);
1834 PERL_ARGS_ASSERT_WARN_SV;
1835 if (!invoke_exception_hook(ex, TRUE))
1836 write_to_stderr(ex);
1840 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1842 This is an XS interface to Perl's C<warn> function.
1844 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1845 argument list. These are used to generate a string message. If the
1846 message does not end with a newline, then it will be extended with
1847 some indication of the current location in the code, as described for
1850 The error message or object will by default be written to standard error,
1851 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1853 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1859 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1861 SV *ex = vmess(pat, args);
1862 PERL_ARGS_ASSERT_VWARN;
1863 if (!invoke_exception_hook(ex, TRUE))
1864 write_to_stderr(ex);
1868 =for apidoc Am|void|warn|const char *pat|...
1870 This is an XS interface to Perl's C<warn> function.
1872 Take a sprintf-style format pattern and argument list. These are used to
1873 generate a string message. If the message does not end with a newline,
1874 then it will be extended with some indication of the current location
1875 in the code, as described for L</mess_sv>.
1877 The error message or object will by default be written to standard error,
1878 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1880 Unlike with L</croak>, C<pat> is not permitted to be null.
1885 #if defined(PERL_IMPLICIT_CONTEXT)
1887 Perl_warn_nocontext(const char *pat, ...)
1891 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1892 va_start(args, pat);
1896 #endif /* PERL_IMPLICIT_CONTEXT */
1899 Perl_warn(pTHX_ const char *pat, ...)
1902 PERL_ARGS_ASSERT_WARN;
1903 va_start(args, pat);
1908 #if defined(PERL_IMPLICIT_CONTEXT)
1910 Perl_warner_nocontext(U32 err, const char *pat, ...)
1914 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1915 va_start(args, pat);
1916 vwarner(err, pat, &args);
1919 #endif /* PERL_IMPLICIT_CONTEXT */
1922 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1924 PERL_ARGS_ASSERT_CK_WARNER_D;
1926 if (Perl_ckwarn_d(aTHX_ err)) {
1928 va_start(args, pat);
1929 vwarner(err, pat, &args);
1935 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1937 PERL_ARGS_ASSERT_CK_WARNER;
1939 if (Perl_ckwarn(aTHX_ err)) {
1941 va_start(args, pat);
1942 vwarner(err, pat, &args);
1948 Perl_warner(pTHX_ U32 err, const char* pat,...)
1951 PERL_ARGS_ASSERT_WARNER;
1952 va_start(args, pat);
1953 vwarner(err, pat, &args);
1958 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1961 PERL_ARGS_ASSERT_VWARNER;
1963 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
1964 !(PL_in_eval & EVAL_KEEPERR)
1966 SV * const msv = vmess(pat, args);
1968 if (PL_parser && PL_parser->error_count) {
1972 invoke_exception_hook(msv, FALSE);
1977 Perl_vwarn(aTHX_ pat, args);
1981 /* implements the ckWARN? macros */
1984 Perl_ckwarn(pTHX_ U32 w)
1986 /* If lexical warnings have not been set, use $^W. */
1988 return PL_dowarn & G_WARN_ON;
1990 return ckwarn_common(w);
1993 /* implements the ckWARN?_d macro */
1996 Perl_ckwarn_d(pTHX_ U32 w)
1998 /* If lexical warnings have not been set then default classes warn. */
2002 return ckwarn_common(w);
2006 S_ckwarn_common(pTHX_ U32 w)
2008 if (PL_curcop->cop_warnings == pWARN_ALL)
2011 if (PL_curcop->cop_warnings == pWARN_NONE)
2014 /* Check the assumption that at least the first slot is non-zero. */
2015 assert(unpackWARN1(w));
2017 /* Check the assumption that it is valid to stop as soon as a zero slot is
2019 if (!unpackWARN2(w)) {
2020 assert(!unpackWARN3(w));
2021 assert(!unpackWARN4(w));
2022 } else if (!unpackWARN3(w)) {
2023 assert(!unpackWARN4(w));
2026 /* Right, dealt with all the special cases, which are implemented as non-
2027 pointers, so there is a pointer to a real warnings mask. */
2029 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2031 } while (w >>= WARNshift);
2036 /* Set buffer=NULL to get a new one. */
2038 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2040 const MEM_SIZE len_wanted =
2041 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2042 PERL_UNUSED_CONTEXT;
2043 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2046 (specialWARN(buffer) ?
2047 PerlMemShared_malloc(len_wanted) :
2048 PerlMemShared_realloc(buffer, len_wanted));
2050 Copy(bits, (buffer + 1), size, char);
2051 if (size < WARNsize)
2052 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2056 /* since we've already done strlen() for both nam and val
2057 * we can use that info to make things faster than
2058 * sprintf(s, "%s=%s", nam, val)
2060 #define my_setenv_format(s, nam, nlen, val, vlen) \
2061 Copy(nam, s, nlen, char); \
2063 Copy(val, s+(nlen+1), vlen, char); \
2064 *(s+(nlen+1+vlen)) = '\0'
2066 #ifdef USE_ENVIRON_ARRAY
2067 /* VMS' my_setenv() is in vms.c */
2068 #if !defined(WIN32) && !defined(NETWARE)
2070 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2074 amigaos4_obtain_environ(__FUNCTION__);
2077 /* only parent thread can modify process environment */
2078 if (PL_curinterp == aTHX)
2081 #ifndef PERL_USE_SAFE_PUTENV
2082 if (!PL_use_safe_putenv) {
2083 /* most putenv()s leak, so we manipulate environ directly */
2085 const I32 len = strlen(nam);
2088 /* where does it go? */
2089 for (i = 0; environ[i]; i++) {
2090 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
2094 if (environ == PL_origenviron) { /* need we copy environment? */
2100 while (environ[max])
2102 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
2103 for (j=0; j<max; j++) { /* copy environment */
2104 const int len = strlen(environ[j]);
2105 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
2106 Copy(environ[j], tmpenv[j], len+1, char);
2109 environ = tmpenv; /* tell exec where it is now */
2112 safesysfree(environ[i]);
2113 while (environ[i]) {
2114 environ[i] = environ[i+1];
2123 if (!environ[i]) { /* does not exist yet */
2124 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
2125 environ[i+1] = NULL; /* make sure it's null terminated */
2128 safesysfree(environ[i]);
2132 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
2133 /* all that work just for this */
2134 my_setenv_format(environ[i], nam, nlen, val, vlen);
2137 /* This next branch should only be called #if defined(HAS_SETENV), but
2138 Configure doesn't test for that yet. For Solaris, setenv() and unsetenv()
2139 were introduced in Solaris 9, so testing for HAS UNSETENV is sufficient.
2141 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2142 # if defined(HAS_UNSETENV)
2144 (void)unsetenv(nam);
2146 (void)setenv(nam, val, 1);
2148 # else /* ! HAS_UNSETENV */
2149 (void)setenv(nam, val, 1);
2150 # endif /* HAS_UNSETENV */
2152 # if defined(HAS_UNSETENV)
2154 if (environ) /* old glibc can crash with null environ */
2155 (void)unsetenv(nam);
2157 const int nlen = strlen(nam);
2158 const int vlen = strlen(val);
2159 char * const new_env =
2160 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2161 my_setenv_format(new_env, nam, nlen, val, vlen);
2162 (void)putenv(new_env);
2164 # else /* ! HAS_UNSETENV */
2166 const int nlen = strlen(nam);
2172 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2173 /* all that work just for this */
2174 my_setenv_format(new_env, nam, nlen, val, vlen);
2175 (void)putenv(new_env);
2176 # endif /* HAS_UNSETENV */
2177 # endif /* __CYGWIN__ */
2178 #ifndef PERL_USE_SAFE_PUTENV
2184 amigaos4_release_environ(__FUNCTION__);
2188 #else /* WIN32 || NETWARE */
2191 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2195 const int nlen = strlen(nam);
2202 Newx(envstr, nlen+vlen+2, char);
2203 my_setenv_format(envstr, nam, nlen, val, vlen);
2204 (void)PerlEnv_putenv(envstr);
2208 #endif /* WIN32 || NETWARE */
2212 #ifdef UNLINK_ALL_VERSIONS
2214 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2218 PERL_ARGS_ASSERT_UNLNK;
2220 while (PerlLIO_unlink(f) >= 0)
2222 return retries ? 0 : -1;
2226 /* this is a drop-in replacement for bcopy(), except for the return
2227 * value, which we need to be able to emulate memcpy() */
2228 #if !defined(HAS_MEMCPY) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY))
2230 Perl_my_bcopy(const void *vfrom, void *vto, size_t len)
2232 #if defined(HAS_BCOPY) && defined(HAS_SAFE_BCOPY)
2233 bcopy(vfrom, vto, len);
2235 const unsigned char *from = (const unsigned char *)vfrom;
2236 unsigned char *to = (unsigned char *)vto;
2238 PERL_ARGS_ASSERT_MY_BCOPY;
2240 if (from - to >= 0) {
2248 *(--to) = *(--from);
2256 /* this is a drop-in replacement for memset() */
2259 Perl_my_memset(void *vloc, int ch, size_t len)
2261 unsigned char *loc = (unsigned char *)vloc;
2263 PERL_ARGS_ASSERT_MY_MEMSET;
2271 /* this is a drop-in replacement for bzero() */
2272 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2274 Perl_my_bzero(void *vloc, size_t len)
2276 unsigned char *loc = (unsigned char *)vloc;
2278 PERL_ARGS_ASSERT_MY_BZERO;
2286 /* this is a drop-in replacement for memcmp() */
2287 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2289 Perl_my_memcmp(const void *vs1, const void *vs2, size_t len)
2291 const U8 *a = (const U8 *)vs1;
2292 const U8 *b = (const U8 *)vs2;
2295 PERL_ARGS_ASSERT_MY_MEMCMP;
2298 if ((tmp = *a++ - *b++))
2303 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2306 /* This vsprintf replacement should generally never get used, since
2307 vsprintf was available in both System V and BSD 2.11. (There may
2308 be some cross-compilation or embedded set-ups where it is needed,
2311 If you encounter a problem in this function, it's probably a symptom
2312 that Configure failed to detect your system's vprintf() function.
2313 See the section on "item vsprintf" in the INSTALL file.
2315 This version may compile on systems with BSD-ish <stdio.h>,
2316 but probably won't on others.
2319 #ifdef USE_CHAR_VSPRINTF
2324 vsprintf(char *dest, const char *pat, void *args)
2328 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2329 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2330 FILE_cnt(&fakebuf) = 32767;
2332 /* These probably won't compile -- If you really need
2333 this, you'll have to figure out some other method. */
2334 fakebuf._ptr = dest;
2335 fakebuf._cnt = 32767;
2340 fakebuf._flag = _IOWRT|_IOSTRG;
2341 _doprnt(pat, args, &fakebuf); /* what a kludge */
2342 #if defined(STDIO_PTR_LVALUE)
2343 *(FILE_ptr(&fakebuf)++) = '\0';
2345 /* PerlIO has probably #defined away fputc, but we want it here. */
2347 # undef fputc /* XXX Should really restore it later */
2349 (void)fputc('\0', &fakebuf);
2351 #ifdef USE_CHAR_VSPRINTF
2354 return 0; /* perl doesn't use return value */
2358 #endif /* HAS_VPRINTF */
2361 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2363 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2371 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2373 PERL_FLUSHALL_FOR_CHILD;
2374 This = (*mode == 'w');
2378 taint_proper("Insecure %s%s", "EXEC");
2380 if (PerlProc_pipe(p) < 0)
2382 /* Try for another pipe pair for error return */
2383 if (PerlProc_pipe(pp) >= 0)
2385 while ((pid = PerlProc_fork()) < 0) {
2386 if (errno != EAGAIN) {
2387 PerlLIO_close(p[This]);
2388 PerlLIO_close(p[that]);
2390 PerlLIO_close(pp[0]);
2391 PerlLIO_close(pp[1]);
2395 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2404 /* Close parent's end of error status pipe (if any) */
2406 PerlLIO_close(pp[0]);
2407 #if defined(HAS_FCNTL) && defined(F_SETFD) && defined(FD_CLOEXEC)
2408 /* Close error pipe automatically if exec works */
2409 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2413 /* Now dup our end of _the_ pipe to right position */
2414 if (p[THIS] != (*mode == 'r')) {
2415 PerlLIO_dup2(p[THIS], *mode == 'r');
2416 PerlLIO_close(p[THIS]);
2417 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2418 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2421 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2422 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2423 /* No automatic close - do it by hand */
2430 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2436 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2442 do_execfree(); /* free any memory malloced by child on fork */
2444 PerlLIO_close(pp[1]);
2445 /* Keep the lower of the two fd numbers */
2446 if (p[that] < p[This]) {
2447 PerlLIO_dup2(p[This], p[that]);
2448 PerlLIO_close(p[This]);
2452 PerlLIO_close(p[that]); /* close child's end of pipe */
2454 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2455 SvUPGRADE(sv,SVt_IV);
2457 PL_forkprocess = pid;
2458 /* If we managed to get status pipe check for exec fail */
2459 if (did_pipes && pid > 0) {
2463 while (n < sizeof(int)) {
2464 const SSize_t n1 = PerlLIO_read(pp[0],
2465 (void*)(((char*)&errkid)+n),
2471 PerlLIO_close(pp[0]);
2473 if (n) { /* Error */
2475 PerlLIO_close(p[This]);
2476 if (n != sizeof(int))
2477 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2479 pid2 = wait4pid(pid, &status, 0);
2480 } while (pid2 == -1 && errno == EINTR);
2481 errno = errkid; /* Propagate errno from kid */
2486 PerlLIO_close(pp[0]);
2487 return PerlIO_fdopen(p[This], mode);
2489 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2490 return my_syspopen4(aTHX_ NULL, mode, n, args);
2491 # elif defined(WIN32)
2492 return win32_popenlist(mode, n, args);
2494 Perl_croak(aTHX_ "List form of piped open not implemented");
2495 return (PerlIO *) NULL;
2500 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2501 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2503 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2509 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2513 PERL_ARGS_ASSERT_MY_POPEN;
2515 PERL_FLUSHALL_FOR_CHILD;
2518 return my_syspopen(aTHX_ cmd,mode);
2521 This = (*mode == 'w');
2523 if (doexec && TAINTING_get) {
2525 taint_proper("Insecure %s%s", "EXEC");
2527 if (PerlProc_pipe(p) < 0)
2529 if (doexec && PerlProc_pipe(pp) >= 0)
2531 while ((pid = PerlProc_fork()) < 0) {
2532 if (errno != EAGAIN) {
2533 PerlLIO_close(p[This]);
2534 PerlLIO_close(p[that]);
2536 PerlLIO_close(pp[0]);
2537 PerlLIO_close(pp[1]);
2540 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2543 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2553 PerlLIO_close(pp[0]);
2554 #if defined(HAS_FCNTL) && defined(F_SETFD)
2555 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2559 if (p[THIS] != (*mode == 'r')) {
2560 PerlLIO_dup2(p[THIS], *mode == 'r');
2561 PerlLIO_close(p[THIS]);
2562 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2563 PerlLIO_close(p[THAT]);
2566 PerlLIO_close(p[THAT]);
2569 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2576 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2581 /* may or may not use the shell */
2582 do_exec3(cmd, pp[1], did_pipes);
2585 #endif /* defined OS2 */
2587 #ifdef PERLIO_USING_CRLF
2588 /* Since we circumvent IO layers when we manipulate low-level
2589 filedescriptors directly, need to manually switch to the
2590 default, binary, low-level mode; see PerlIOBuf_open(). */
2591 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2594 #ifdef PERL_USES_PL_PIDSTATUS
2595 hv_clear(PL_pidstatus); /* we have no children */
2601 do_execfree(); /* free any memory malloced by child on vfork */
2603 PerlLIO_close(pp[1]);
2604 if (p[that] < p[This]) {
2605 PerlLIO_dup2(p[This], p[that]);
2606 PerlLIO_close(p[This]);
2610 PerlLIO_close(p[that]);
2612 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2613 SvUPGRADE(sv,SVt_IV);
2615 PL_forkprocess = pid;
2616 if (did_pipes && pid > 0) {
2620 while (n < sizeof(int)) {
2621 const SSize_t n1 = PerlLIO_read(pp[0],
2622 (void*)(((char*)&errkid)+n),
2628 PerlLIO_close(pp[0]);
2630 if (n) { /* Error */
2632 PerlLIO_close(p[This]);
2633 if (n != sizeof(int))
2634 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2636 pid2 = wait4pid(pid, &status, 0);
2637 } while (pid2 == -1 && errno == EINTR);
2638 errno = errkid; /* Propagate errno from kid */
2643 PerlLIO_close(pp[0]);
2644 return PerlIO_fdopen(p[This], mode);
2648 FILE *djgpp_popen();
2650 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2652 PERL_FLUSHALL_FOR_CHILD;
2653 /* Call system's popen() to get a FILE *, then import it.
2654 used 0 for 2nd parameter to PerlIO_importFILE;
2657 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2660 #if defined(__LIBCATAMOUNT__)
2662 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2669 #endif /* !DOSISH */
2671 /* this is called in parent before the fork() */
2673 Perl_atfork_lock(void)
2674 #if defined(USE_ITHREADS)
2676 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2679 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2681 PERL_TSA_ACQUIRE(PL_op_mutex)
2684 #if defined(USE_ITHREADS)
2686 /* locks must be held in locking order (if any) */
2688 MUTEX_LOCK(&PL_perlio_mutex);
2691 MUTEX_LOCK(&PL_malloc_mutex);
2697 /* this is called in both parent and child after the fork() */
2699 Perl_atfork_unlock(void)
2700 #if defined(USE_ITHREADS)
2702 PERL_TSA_RELEASE(PL_perlio_mutex)
2705 PERL_TSA_RELEASE(PL_malloc_mutex)
2707 PERL_TSA_RELEASE(PL_op_mutex)
2710 #if defined(USE_ITHREADS)
2712 /* locks must be released in same order as in atfork_lock() */
2714 MUTEX_UNLOCK(&PL_perlio_mutex);
2717 MUTEX_UNLOCK(&PL_malloc_mutex);
2726 #if defined(HAS_FORK)
2728 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2733 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2734 * handlers elsewhere in the code */
2738 #elif defined(__amigaos4__)
2739 return amigaos_fork();
2741 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2742 Perl_croak_nocontext("fork() not available");
2744 #endif /* HAS_FORK */
2749 dup2(int oldfd, int newfd)
2751 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2754 PerlLIO_close(newfd);
2755 return fcntl(oldfd, F_DUPFD, newfd);
2757 #define DUP2_MAX_FDS 256
2758 int fdtmp[DUP2_MAX_FDS];
2764 PerlLIO_close(newfd);
2765 /* good enough for low fd's... */
2766 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2767 if (fdx >= DUP2_MAX_FDS) {
2775 PerlLIO_close(fdtmp[--fdx]);
2782 #ifdef HAS_SIGACTION
2785 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2787 struct sigaction act, oact;
2791 /* only "parent" interpreter can diddle signals */
2792 if (PL_curinterp != aTHX)
2793 return (Sighandler_t) SIG_ERR;
2796 act.sa_handler = (void(*)(int))handler;
2797 sigemptyset(&act.sa_mask);
2800 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2801 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2803 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2804 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2805 act.sa_flags |= SA_NOCLDWAIT;
2807 if (sigaction(signo, &act, &oact) == -1)
2808 return (Sighandler_t) SIG_ERR;
2810 return (Sighandler_t) oact.sa_handler;
2814 Perl_rsignal_state(pTHX_ int signo)
2816 struct sigaction oact;
2817 PERL_UNUSED_CONTEXT;
2819 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2820 return (Sighandler_t) SIG_ERR;
2822 return (Sighandler_t) oact.sa_handler;
2826 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2831 struct sigaction act;
2833 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2836 /* only "parent" interpreter can diddle signals */
2837 if (PL_curinterp != aTHX)
2841 act.sa_handler = (void(*)(int))handler;
2842 sigemptyset(&act.sa_mask);
2845 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2846 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2848 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2849 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2850 act.sa_flags |= SA_NOCLDWAIT;
2852 return sigaction(signo, &act, save);
2856 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2861 PERL_UNUSED_CONTEXT;
2863 /* only "parent" interpreter can diddle signals */
2864 if (PL_curinterp != aTHX)
2868 return sigaction(signo, save, (struct sigaction *)NULL);
2871 #else /* !HAS_SIGACTION */
2874 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2876 #if defined(USE_ITHREADS) && !defined(WIN32)
2877 /* only "parent" interpreter can diddle signals */
2878 if (PL_curinterp != aTHX)
2879 return (Sighandler_t) SIG_ERR;
2882 return PerlProc_signal(signo, handler);
2893 Perl_rsignal_state(pTHX_ int signo)
2896 Sighandler_t oldsig;
2898 #if defined(USE_ITHREADS) && !defined(WIN32)
2899 /* only "parent" interpreter can diddle signals */
2900 if (PL_curinterp != aTHX)
2901 return (Sighandler_t) SIG_ERR;
2905 oldsig = PerlProc_signal(signo, sig_trap);
2906 PerlProc_signal(signo, oldsig);
2908 PerlProc_kill(PerlProc_getpid(), signo);
2913 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2915 #if defined(USE_ITHREADS) && !defined(WIN32)
2916 /* only "parent" interpreter can diddle signals */
2917 if (PL_curinterp != aTHX)
2920 *save = PerlProc_signal(signo, handler);
2921 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2925 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2927 #if defined(USE_ITHREADS) && !defined(WIN32)
2928 /* only "parent" interpreter can diddle signals */
2929 if (PL_curinterp != aTHX)
2932 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2935 #endif /* !HAS_SIGACTION */
2936 #endif /* !PERL_MICRO */
2938 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2939 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2941 Perl_my_pclose(pTHX_ PerlIO *ptr)
2949 const int fd = PerlIO_fileno(ptr);
2952 svp = av_fetch(PL_fdpid,fd,TRUE);
2953 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2957 #if defined(USE_PERLIO)
2958 /* Find out whether the refcount is low enough for us to wait for the
2959 child proc without blocking. */
2960 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
2962 should_wait = pid > 0;
2966 if (pid == -1) { /* Opened by popen. */
2967 return my_syspclose(ptr);
2970 close_failed = (PerlIO_close(ptr) == EOF);
2972 if (should_wait) do {
2973 pid2 = wait4pid(pid, &status, 0);
2974 } while (pid2 == -1 && errno == EINTR);
2981 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2986 #if defined(__LIBCATAMOUNT__)
2988 Perl_my_pclose(pTHX_ PerlIO *ptr)
2993 #endif /* !DOSISH */
2995 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2997 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3000 PERL_ARGS_ASSERT_WAIT4PID;
3001 #ifdef PERL_USES_PL_PIDSTATUS
3003 /* PERL_USES_PL_PIDSTATUS is only defined when neither
3004 waitpid() nor wait4() is available, or on OS/2, which
3005 doesn't appear to support waiting for a progress group
3006 member, so we can only treat a 0 pid as an unknown child.
3013 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3014 pid, rather than a string form. */
3015 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3016 if (svp && *svp != &PL_sv_undef) {
3017 *statusp = SvIVX(*svp);
3018 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3026 hv_iterinit(PL_pidstatus);
3027 if ((entry = hv_iternext(PL_pidstatus))) {
3028 SV * const sv = hv_iterval(PL_pidstatus,entry);
3030 const char * const spid = hv_iterkey(entry,&len);
3032 assert (len == sizeof(Pid_t));
3033 memcpy((char *)&pid, spid, len);
3034 *statusp = SvIVX(sv);
3035 /* The hash iterator is currently on this entry, so simply
3036 calling hv_delete would trigger the lazy delete, which on
3037 aggregate does more work, because next call to hv_iterinit()
3038 would spot the flag, and have to call the delete routine,
3039 while in the meantime any new entries can't re-use that
3041 hv_iterinit(PL_pidstatus);
3042 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3049 # ifdef HAS_WAITPID_RUNTIME
3050 if (!HAS_WAITPID_RUNTIME)
3053 result = PerlProc_waitpid(pid,statusp,flags);
3056 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3057 result = wait4(pid,statusp,flags,NULL);
3060 #ifdef PERL_USES_PL_PIDSTATUS
3061 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3066 Perl_croak(aTHX_ "Can't do waitpid with flags");
3068 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3069 pidgone(result,*statusp);
3075 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3078 if (result < 0 && errno == EINTR) {
3080 errno = EINTR; /* reset in case a signal handler changed $! */
3084 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3086 #ifdef PERL_USES_PL_PIDSTATUS
3088 S_pidgone(pTHX_ Pid_t pid, int status)
3092 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3093 SvUPGRADE(sv,SVt_IV);
3094 SvIV_set(sv, status);
3102 int /* Cannot prototype with I32
3104 my_syspclose(PerlIO *ptr)
3107 Perl_my_pclose(pTHX_ PerlIO *ptr)
3110 /* Needs work for PerlIO ! */
3111 FILE * const f = PerlIO_findFILE(ptr);
3112 const I32 result = pclose(f);
3113 PerlIO_releaseFILE(ptr,f);
3121 Perl_my_pclose(pTHX_ PerlIO *ptr)
3123 /* Needs work for PerlIO ! */
3124 FILE * const f = PerlIO_findFILE(ptr);
3125 I32 result = djgpp_pclose(f);
3126 result = (result << 8) & 0xff00;
3127 PerlIO_releaseFILE(ptr,f);
3132 #define PERL_REPEATCPY_LINEAR 4
3134 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3136 PERL_ARGS_ASSERT_REPEATCPY;
3141 croak_memory_wrap();
3144 memset(to, *from, count);
3147 IV items, linear, half;
3149 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3150 for (items = 0; items < linear; ++items) {
3151 const char *q = from;
3153 for (todo = len; todo > 0; todo--)
3158 while (items <= half) {
3159 IV size = items * len;
3160 memcpy(p, to, size);
3166 memcpy(p, to, (count - items) * len);
3172 Perl_same_dirent(pTHX_ const char *a, const char *b)
3174 char *fa = strrchr(a,'/');
3175 char *fb = strrchr(b,'/');
3178 SV * const tmpsv = sv_newmortal();
3180 PERL_ARGS_ASSERT_SAME_DIRENT;
3193 sv_setpvs(tmpsv, ".");
3195 sv_setpvn(tmpsv, a, fa - a);
3196 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3199 sv_setpvs(tmpsv, ".");
3201 sv_setpvn(tmpsv, b, fb - b);
3202 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3204 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3205 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3207 #endif /* !HAS_RENAME */
3210 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3211 const char *const *const search_ext, I32 flags)
3213 const char *xfound = NULL;
3214 char *xfailed = NULL;
3215 char tmpbuf[MAXPATHLEN];
3220 #if defined(DOSISH) && !defined(OS2)
3221 # define SEARCH_EXTS ".bat", ".cmd", NULL
3222 # define MAX_EXT_LEN 4
3225 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3226 # define MAX_EXT_LEN 4
3229 # define SEARCH_EXTS ".pl", ".com", NULL
3230 # define MAX_EXT_LEN 4
3232 /* additional extensions to try in each dir if scriptname not found */
3234 static const char *const exts[] = { SEARCH_EXTS };
3235 const char *const *const ext = search_ext ? search_ext : exts;
3236 int extidx = 0, i = 0;
3237 const char *curext = NULL;
3239 PERL_UNUSED_ARG(search_ext);
3240 # define MAX_EXT_LEN 0
3243 PERL_ARGS_ASSERT_FIND_SCRIPT;
3246 * If dosearch is true and if scriptname does not contain path
3247 * delimiters, search the PATH for scriptname.
3249 * If SEARCH_EXTS is also defined, will look for each
3250 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3251 * while searching the PATH.
3253 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3254 * proceeds as follows:
3255 * If DOSISH or VMSISH:
3256 * + look for ./scriptname{,.foo,.bar}
3257 * + search the PATH for scriptname{,.foo,.bar}
3260 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3261 * this will not look in '.' if it's not in the PATH)
3266 # ifdef ALWAYS_DEFTYPES
3267 len = strlen(scriptname);
3268 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3269 int idx = 0, deftypes = 1;
3272 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3275 int idx = 0, deftypes = 1;
3278 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3280 /* The first time through, just add SEARCH_EXTS to whatever we
3281 * already have, so we can check for default file types. */
3283 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3290 if ((strlen(tmpbuf) + strlen(scriptname)
3291 + MAX_EXT_LEN) >= sizeof tmpbuf)
3292 continue; /* don't search dir with too-long name */
3293 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3297 if (strEQ(scriptname, "-"))
3299 if (dosearch) { /* Look in '.' first. */
3300 const char *cur = scriptname;
3302 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3304 if (strEQ(ext[i++],curext)) {
3305 extidx = -1; /* already has an ext */
3310 DEBUG_p(PerlIO_printf(Perl_debug_log,
3311 "Looking for %s\n",cur));
3314 if (PerlLIO_stat(cur,&statbuf) >= 0
3315 && !S_ISDIR(statbuf.st_mode)) {
3324 if (cur == scriptname) {
3325 len = strlen(scriptname);
3326 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3328 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3331 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3332 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3337 if (dosearch && !strchr(scriptname, '/')
3339 && !strchr(scriptname, '\\')
3341 && (s = PerlEnv_getenv("PATH")))
3345 bufend = s + strlen(s);
3346 while (s < bufend) {
3350 && *s != ';'; len++, s++) {
3351 if (len < sizeof tmpbuf)
3354 if (len < sizeof tmpbuf)
3357 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3362 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3363 continue; /* don't search dir with too-long name */
3366 && tmpbuf[len - 1] != '/'
3367 && tmpbuf[len - 1] != '\\'
3370 tmpbuf[len++] = '/';
3371 if (len == 2 && tmpbuf[0] == '.')
3373 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3377 len = strlen(tmpbuf);
3378 if (extidx > 0) /* reset after previous loop */
3382 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3383 retval = PerlLIO_stat(tmpbuf,&statbuf);
3384 if (S_ISDIR(statbuf.st_mode)) {
3388 } while ( retval < 0 /* not there */
3389 && extidx>=0 && ext[extidx] /* try an extension? */
3390 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3395 if (S_ISREG(statbuf.st_mode)
3396 && cando(S_IRUSR,TRUE,&statbuf)
3397 #if !defined(DOSISH)
3398 && cando(S_IXUSR,TRUE,&statbuf)
3402 xfound = tmpbuf; /* bingo! */
3406 xfailed = savepv(tmpbuf);
3411 if (!xfound && !seen_dot && !xfailed &&
3412 (PerlLIO_stat(scriptname,&statbuf) < 0
3413 || S_ISDIR(statbuf.st_mode)))
3415 seen_dot = 1; /* Disable message. */
3420 if (flags & 1) { /* do or die? */
3421 /* diag_listed_as: Can't execute %s */
3422 Perl_croak(aTHX_ "Can't %s %s%s%s",
3423 (xfailed ? "execute" : "find"),
3424 (xfailed ? xfailed : scriptname),
3425 (xfailed ? "" : " on PATH"),
3426 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3431 scriptname = xfound;
3433 return (scriptname ? savepv(scriptname) : NULL);
3436 #ifndef PERL_GET_CONTEXT_DEFINED
3439 Perl_get_context(void)
3441 #if defined(USE_ITHREADS)
3443 # ifdef OLD_PTHREADS_API
3445 int error = pthread_getspecific(PL_thr_key, &t)
3447 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3450 # ifdef I_MACH_CTHREADS
3451 return (void*)cthread_data(cthread_self());
3453 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3462 Perl_set_context(void *t)
3464 #if defined(USE_ITHREADS)
3467 PERL_ARGS_ASSERT_SET_CONTEXT;
3468 #if defined(USE_ITHREADS)
3469 # ifdef I_MACH_CTHREADS
3470 cthread_set_data(cthread_self(), t);
3473 const int error = pthread_setspecific(PL_thr_key, t);
3475 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3483 #endif /* !PERL_GET_CONTEXT_DEFINED */
3485 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3489 PERL_UNUSED_CONTEXT;
3495 Perl_get_op_names(pTHX)
3497 PERL_UNUSED_CONTEXT;
3498 return (char **)PL_op_name;
3502 Perl_get_op_descs(pTHX)
3504 PERL_UNUSED_CONTEXT;
3505 return (char **)PL_op_desc;
3509 Perl_get_no_modify(pTHX)
3511 PERL_UNUSED_CONTEXT;
3512 return PL_no_modify;
3516 Perl_get_opargs(pTHX)
3518 PERL_UNUSED_CONTEXT;
3519 return (U32 *)PL_opargs;
3523 Perl_get_ppaddr(pTHX)
3526 PERL_UNUSED_CONTEXT;
3527 return (PPADDR_t*)PL_ppaddr;
3530 #ifndef HAS_GETENV_LEN
3532 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3534 char * const env_trans = PerlEnv_getenv(env_elem);
3535 PERL_UNUSED_CONTEXT;
3536 PERL_ARGS_ASSERT_GETENV_LEN;
3538 *len = strlen(env_trans);
3545 Perl_get_vtbl(pTHX_ int vtbl_id)
3547 PERL_UNUSED_CONTEXT;
3549 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3550 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3554 Perl_my_fflush_all(pTHX)
3556 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3557 return PerlIO_flush(NULL);
3559 # if defined(HAS__FWALK)
3560 extern int fflush(FILE *);
3561 /* undocumented, unprototyped, but very useful BSDism */
3562 extern void _fwalk(int (*)(FILE *));
3566 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3568 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3569 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3571 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3572 open_max = sysconf(_SC_OPEN_MAX);
3575 open_max = FOPEN_MAX;
3578 open_max = OPEN_MAX;
3589 for (i = 0; i < open_max; i++)
3590 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3591 STDIO_STREAM_ARRAY[i]._file < open_max &&
3592 STDIO_STREAM_ARRAY[i]._flag)
3593 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3597 SETERRNO(EBADF,RMS_IFI);
3604 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3606 if (ckWARN(WARN_IO)) {
3608 = gv && (isGV_with_GP(gv))
3611 const char * const direction = have == '>' ? "out" : "in";
3613 if (name && HEK_LEN(name))
3614 Perl_warner(aTHX_ packWARN(WARN_IO),
3615 "Filehandle %" HEKf " opened only for %sput",
3616 HEKfARG(name), direction);
3618 Perl_warner(aTHX_ packWARN(WARN_IO),
3619 "Filehandle opened only for %sput", direction);
3624 Perl_report_evil_fh(pTHX_ const GV *gv)
3626 const IO *io = gv ? GvIO(gv) : NULL;
3627 const PERL_BITFIELD16 op = PL_op->op_type;
3631 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3633 warn_type = WARN_CLOSED;
3637 warn_type = WARN_UNOPENED;
3640 if (ckWARN(warn_type)) {
3642 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3643 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3644 const char * const pars =
3645 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3646 const char * const func =
3648 (op == OP_READLINE || op == OP_RCATLINE
3649 ? "readline" : /* "<HANDLE>" not nice */
3650 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3652 const char * const type =
3654 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3655 ? "socket" : "filehandle");
3656 const bool have_name = name && SvCUR(name);
3657 Perl_warner(aTHX_ packWARN(warn_type),
3658 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3659 have_name ? " " : "",
3660 SVfARG(have_name ? name : &PL_sv_no));
3661 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3663 aTHX_ packWARN(warn_type),
3664 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3665 func, pars, have_name ? " " : "",
3666 SVfARG(have_name ? name : &PL_sv_no)
3671 /* To workaround core dumps from the uninitialised tm_zone we get the
3672 * system to give us a reasonable struct to copy. This fix means that
3673 * strftime uses the tm_zone and tm_gmtoff values returned by
3674 * localtime(time()). That should give the desired result most of the
3675 * time. But probably not always!
3677 * This does not address tzname aspects of NETaa14816.
3682 # ifndef STRUCT_TM_HASZONE
3683 # define STRUCT_TM_HASZONE
3687 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3688 # ifndef HAS_TM_TM_ZONE
3689 # define HAS_TM_TM_ZONE
3694 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3696 #ifdef HAS_TM_TM_ZONE
3698 const struct tm* my_tm;
3699 PERL_UNUSED_CONTEXT;
3700 PERL_ARGS_ASSERT_INIT_TM;
3702 my_tm = localtime(&now);
3704 Copy(my_tm, ptm, 1, struct tm);
3706 PERL_UNUSED_CONTEXT;
3707 PERL_ARGS_ASSERT_INIT_TM;
3708 PERL_UNUSED_ARG(ptm);
3713 * mini_mktime - normalise struct tm values without the localtime()
3714 * semantics (and overhead) of mktime().
3717 Perl_mini_mktime(struct tm *ptm)
3721 int month, mday, year, jday;
3722 int odd_cent, odd_year;
3724 PERL_ARGS_ASSERT_MINI_MKTIME;
3726 #define DAYS_PER_YEAR 365
3727 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3728 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3729 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3730 #define SECS_PER_HOUR (60*60)
3731 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3732 /* parentheses deliberately absent on these two, otherwise they don't work */
3733 #define MONTH_TO_DAYS 153/5
3734 #define DAYS_TO_MONTH 5/153
3735 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3736 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3737 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3738 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3741 * Year/day algorithm notes:
3743 * With a suitable offset for numeric value of the month, one can find
3744 * an offset into the year by considering months to have 30.6 (153/5) days,
3745 * using integer arithmetic (i.e., with truncation). To avoid too much
3746 * messing about with leap days, we consider January and February to be
3747 * the 13th and 14th month of the previous year. After that transformation,
3748 * we need the month index we use to be high by 1 from 'normal human' usage,
3749 * so the month index values we use run from 4 through 15.
3751 * Given that, and the rules for the Gregorian calendar (leap years are those
3752 * divisible by 4 unless also divisible by 100, when they must be divisible
3753 * by 400 instead), we can simply calculate the number of days since some
3754 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3755 * the days we derive from our month index, and adding in the day of the
3756 * month. The value used here is not adjusted for the actual origin which
3757 * it normally would use (1 January A.D. 1), since we're not exposing it.
3758 * We're only building the value so we can turn around and get the
3759 * normalised values for the year, month, day-of-month, and day-of-year.
3761 * For going backward, we need to bias the value we're using so that we find
3762 * the right year value. (Basically, we don't want the contribution of
3763 * March 1st to the number to apply while deriving the year). Having done
3764 * that, we 'count up' the contribution to the year number by accounting for
3765 * full quadracenturies (400-year periods) with their extra leap days, plus
3766 * the contribution from full centuries (to avoid counting in the lost leap
3767 * days), plus the contribution from full quad-years (to count in the normal
3768 * leap days), plus the leftover contribution from any non-leap years.
3769 * At this point, if we were working with an actual leap day, we'll have 0
3770 * days left over. This is also true for March 1st, however. So, we have
3771 * to special-case that result, and (earlier) keep track of the 'odd'
3772 * century and year contributions. If we got 4 extra centuries in a qcent,
3773 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3774 * Otherwise, we add back in the earlier bias we removed (the 123 from
3775 * figuring in March 1st), find the month index (integer division by 30.6),
3776 * and the remainder is the day-of-month. We then have to convert back to
3777 * 'real' months (including fixing January and February from being 14/15 in
3778 * the previous year to being in the proper year). After that, to get
3779 * tm_yday, we work with the normalised year and get a new yearday value for
3780 * January 1st, which we subtract from the yearday value we had earlier,
3781 * representing the date we've re-built. This is done from January 1
3782 * because tm_yday is 0-origin.
3784 * Since POSIX time routines are only guaranteed to work for times since the
3785 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3786 * applies Gregorian calendar rules even to dates before the 16th century
3787 * doesn't bother me. Besides, you'd need cultural context for a given
3788 * date to know whether it was Julian or Gregorian calendar, and that's
3789 * outside the scope for this routine. Since we convert back based on the
3790 * same rules we used to build the yearday, you'll only get strange results
3791 * for input which needed normalising, or for the 'odd' century years which
3792 * were leap years in the Julian calendar but not in the Gregorian one.
3793 * I can live with that.
3795 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3796 * that's still outside the scope for POSIX time manipulation, so I don't
3802 year = 1900 + ptm->tm_year;
3803 month = ptm->tm_mon;
3804 mday = ptm->tm_mday;
3810 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3811 yearday += month*MONTH_TO_DAYS + mday + jday;
3813 * Note that we don't know when leap-seconds were or will be,
3814 * so we have to trust the user if we get something which looks
3815 * like a sensible leap-second. Wild values for seconds will
3816 * be rationalised, however.
3818 if ((unsigned) ptm->tm_sec <= 60) {
3825 secs += 60 * ptm->tm_min;
3826 secs += SECS_PER_HOUR * ptm->tm_hour;
3828 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3829 /* got negative remainder, but need positive time */
3830 /* back off an extra day to compensate */
3831 yearday += (secs/SECS_PER_DAY)-1;
3832 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3835 yearday += (secs/SECS_PER_DAY);
3836 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3839 else if (secs >= SECS_PER_DAY) {
3840 yearday += (secs/SECS_PER_DAY);
3841 secs %= SECS_PER_DAY;
3843 ptm->tm_hour = secs/SECS_PER_HOUR;
3844 secs %= SECS_PER_HOUR;
3845 ptm->tm_min = secs/60;
3847 ptm->tm_sec += secs;
3848 /* done with time of day effects */
3850 * The algorithm for yearday has (so far) left it high by 428.
3851 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3852 * bias it by 123 while trying to figure out what year it
3853 * really represents. Even with this tweak, the reverse
3854 * translation fails for years before A.D. 0001.
3855 * It would still fail for Feb 29, but we catch that one below.
3857 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3858 yearday -= YEAR_ADJUST;
3859 year = (yearday / DAYS_PER_QCENT) * 400;
3860 yearday %= DAYS_PER_QCENT;
3861 odd_cent = yearday / DAYS_PER_CENT;
3862 year += odd_cent * 100;
3863 yearday %= DAYS_PER_CENT;
3864 year += (yearday / DAYS_PER_QYEAR) * 4;
3865 yearday %= DAYS_PER_QYEAR;
3866 odd_year = yearday / DAYS_PER_YEAR;
3868 yearday %= DAYS_PER_YEAR;
3869 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3874 yearday += YEAR_ADJUST; /* recover March 1st crock */
3875 month = yearday*DAYS_TO_MONTH;
3876 yearday -= month*MONTH_TO_DAYS;
3877 /* recover other leap-year adjustment */
3886 ptm->tm_year = year - 1900;
3888 ptm->tm_mday = yearday;
3889 ptm->tm_mon = month;
3893 ptm->tm_mon = month - 1;
3895 /* re-build yearday based on Jan 1 to get tm_yday */
3897 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3898 yearday += 14*MONTH_TO_DAYS + 1;
3899 ptm->tm_yday = jday - yearday;
3900 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3904 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)
3908 /* strftime(), but with a different API so that the return value is a pointer
3909 * to the formatted result (which MUST be arranged to be FREED BY THE
3910 * CALLER). This allows this function to increase the buffer size as needed,
3911 * so that the caller doesn't have to worry about that.
3913 * Note that yday and wday effectively are ignored by this function, as
3914 * mini_mktime() overwrites them */
3921 PERL_ARGS_ASSERT_MY_STRFTIME;
3923 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3926 mytm.tm_hour = hour;
3927 mytm.tm_mday = mday;
3929 mytm.tm_year = year;
3930 mytm.tm_wday = wday;
3931 mytm.tm_yday = yday;
3932 mytm.tm_isdst = isdst;
3934 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3935 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3940 #ifdef HAS_TM_TM_GMTOFF
3941 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3943 #ifdef HAS_TM_TM_ZONE
3944 mytm.tm_zone = mytm2.tm_zone;
3949 Newx(buf, buflen, char);
3951 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
3952 len = strftime(buf, buflen, fmt, &mytm);
3956 ** The following is needed to handle to the situation where
3957 ** tmpbuf overflows. Basically we want to allocate a buffer
3958 ** and try repeatedly. The reason why it is so complicated
3959 ** is that getting a return value of 0 from strftime can indicate
3960 ** one of the following:
3961 ** 1. buffer overflowed,
3962 ** 2. illegal conversion specifier, or
3963 ** 3. the format string specifies nothing to be returned(not
3964 ** an error). This could be because format is an empty string
3965 ** or it specifies %p that yields an empty string in some locale.
3966 ** If there is a better way to make it portable, go ahead by
3969 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
3972 /* Possibly buf overflowed - try again with a bigger buf */
3973 const int fmtlen = strlen(fmt);
3974 int bufsize = fmtlen + buflen;
3976 Renew(buf, bufsize, char);
3979 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
3980 buflen = strftime(buf, bufsize, fmt, &mytm);
3983 if (buflen > 0 && buflen < bufsize)
3985 /* heuristic to prevent out-of-memory errors */
3986 if (bufsize > 100*fmtlen) {
3992 Renew(buf, bufsize, char);
3997 Perl_croak(aTHX_ "panic: no strftime");
4003 #define SV_CWD_RETURN_UNDEF \
4007 #define SV_CWD_ISDOT(dp) \
4008 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4009 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4012 =head1 Miscellaneous Functions
4014 =for apidoc getcwd_sv
4016 Fill C<sv> with current working directory
4021 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4022 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4023 * getcwd(3) if available
4024 * Comments from the original:
4025 * This is a faster version of getcwd. It's also more dangerous
4026 * because you might chdir out of a directory that you can't chdir
4030 Perl_getcwd_sv(pTHX_ SV *sv)
4035 PERL_ARGS_ASSERT_GETCWD_SV;
4039 char buf[MAXPATHLEN];
4041 /* Some getcwd()s automatically allocate a buffer of the given
4042 * size from the heap if they are given a NULL buffer pointer.
4043 * The problem is that this behaviour is not portable. */
4044 if (getcwd(buf, sizeof(buf) - 1)) {
4049 SV_CWD_RETURN_UNDEF;
4056 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4060 SvUPGRADE(sv, SVt_PV);
4062 if (PerlLIO_lstat(".", &statbuf) < 0) {
4063 SV_CWD_RETURN_UNDEF;
4066 orig_cdev = statbuf.st_dev;
4067 orig_cino = statbuf.st_ino;
4077 if (PerlDir_chdir("..") < 0) {
4078 SV_CWD_RETURN_UNDEF;
4080 if (PerlLIO_stat(".", &statbuf) < 0) {
4081 SV_CWD_RETURN_UNDEF;
4084 cdev = statbuf.st_dev;
4085 cino = statbuf.st_ino;
4087 if (odev == cdev && oino == cino) {
4090 if (!(dir = PerlDir_open("."))) {
4091 SV_CWD_RETURN_UNDEF;
4094 while ((dp = PerlDir_read(dir)) != NULL) {
4096 namelen = dp->d_namlen;
4098 namelen = strlen(dp->d_name);
4101 if (SV_CWD_ISDOT(dp)) {
4105 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4106 SV_CWD_RETURN_UNDEF;
4109 tdev = statbuf.st_dev;
4110 tino = statbuf.st_ino;
4111 if (tino == oino && tdev == odev) {
4117 SV_CWD_RETURN_UNDEF;
4120 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4121 SV_CWD_RETURN_UNDEF;
4124 SvGROW(sv, pathlen + namelen + 1);
4128 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4131 /* prepend current directory to the front */
4133 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4134 pathlen += (namelen + 1);
4136 #ifdef VOID_CLOSEDIR
4139 if (PerlDir_close(dir) < 0) {
4140 SV_CWD_RETURN_UNDEF;
4146 SvCUR_set(sv, pathlen);
4150 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4151 SV_CWD_RETURN_UNDEF;
4154 if (PerlLIO_stat(".", &statbuf) < 0) {
4155 SV_CWD_RETURN_UNDEF;
4158 cdev = statbuf.st_dev;
4159 cino = statbuf.st_ino;
4161 if (cdev != orig_cdev || cino != orig_cino) {
4162 Perl_croak(aTHX_ "Unstable directory path, "
4163 "current directory changed unexpectedly");
4176 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4177 # define EMULATE_SOCKETPAIR_UDP
4180 #ifdef EMULATE_SOCKETPAIR_UDP
4182 S_socketpair_udp (int fd[2]) {
4184 /* Fake a datagram socketpair using UDP to localhost. */
4185 int sockets[2] = {-1, -1};
4186 struct sockaddr_in addresses[2];
4188 Sock_size_t size = sizeof(struct sockaddr_in);
4189 unsigned short port;
4192 memset(&addresses, 0, sizeof(addresses));
4195 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4196 if (sockets[i] == -1)
4197 goto tidy_up_and_fail;
4199 addresses[i].sin_family = AF_INET;
4200 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4201 addresses[i].sin_port = 0; /* kernel choses port. */
4202 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4203 sizeof(struct sockaddr_in)) == -1)
4204 goto tidy_up_and_fail;
4207 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4208 for each connect the other socket to it. */
4211 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4213 goto tidy_up_and_fail;
4214 if (size != sizeof(struct sockaddr_in))
4215 goto abort_tidy_up_and_fail;
4216 /* !1 is 0, !0 is 1 */
4217 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4218 sizeof(struct sockaddr_in)) == -1)
4219 goto tidy_up_and_fail;
4222 /* Now we have 2 sockets connected to each other. I don't trust some other
4223 process not to have already sent a packet to us (by random) so send
4224 a packet from each to the other. */
4227 /* I'm going to send my own port number. As a short.
4228 (Who knows if someone somewhere has sin_port as a bitfield and needs
4229 this routine. (I'm assuming crays have socketpair)) */
4230 port = addresses[i].sin_port;
4231 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4232 if (got != sizeof(port)) {
4234 goto tidy_up_and_fail;
4235 goto abort_tidy_up_and_fail;
4239 /* Packets sent. I don't trust them to have arrived though.
4240 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4241 connect to localhost will use a second kernel thread. In 2.6 the
4242 first thread running the connect() returns before the second completes,
4243 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4244 returns 0. Poor programs have tripped up. One poor program's authors'
4245 had a 50-1 reverse stock split. Not sure how connected these were.)
4246 So I don't trust someone not to have an unpredictable UDP stack.
4250 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4251 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4255 FD_SET((unsigned int)sockets[0], &rset);
4256 FD_SET((unsigned int)sockets[1], &rset);
4258 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4259 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4260 || !FD_ISSET(sockets[1], &rset)) {
4261 /* I hope this is portable and appropriate. */
4263 goto tidy_up_and_fail;
4264 goto abort_tidy_up_and_fail;
4268 /* And the paranoia department even now doesn't trust it to have arrive
4269 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4271 struct sockaddr_in readfrom;
4272 unsigned short buffer[2];
4277 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4278 sizeof(buffer), MSG_DONTWAIT,
4279 (struct sockaddr *) &readfrom, &size);
4281 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4283 (struct sockaddr *) &readfrom, &size);
4287 goto tidy_up_and_fail;
4288 if (got != sizeof(port)
4289 || size != sizeof(struct sockaddr_in)
4290 /* Check other socket sent us its port. */
4291 || buffer[0] != (unsigned short) addresses[!i].sin_port
4292 /* Check kernel says we got the datagram from that socket */
4293 || readfrom.sin_family != addresses[!i].sin_family
4294 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4295 || readfrom.sin_port != addresses[!i].sin_port)
4296 goto abort_tidy_up_and_fail;
4299 /* My caller (my_socketpair) has validated that this is non-NULL */
4302 /* I hereby declare this connection open. May God bless all who cross
4306 abort_tidy_up_and_fail:
4307 errno = ECONNABORTED;
4311 if (sockets[0] != -1)
4312 PerlLIO_close(sockets[0]);
4313 if (sockets[1] != -1)
4314 PerlLIO_close(sockets[1]);
4319 #endif /* EMULATE_SOCKETPAIR_UDP */
4321 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4323 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4324 /* Stevens says that family must be AF_LOCAL, protocol 0.
4325 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4330 struct sockaddr_in listen_addr;
4331 struct sockaddr_in connect_addr;
4336 || family != AF_UNIX
4339 errno = EAFNOSUPPORT;
4347 #ifdef EMULATE_SOCKETPAIR_UDP
4348 if (type == SOCK_DGRAM)
4349 return S_socketpair_udp(fd);
4352 aTHXa(PERL_GET_THX);
4353 listener = PerlSock_socket(AF_INET, type, 0);
4356 memset(&listen_addr, 0, sizeof(listen_addr));
4357 listen_addr.sin_family = AF_INET;
4358 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4359 listen_addr.sin_port = 0; /* kernel choses port. */
4360 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4361 sizeof(listen_addr)) == -1)
4362 goto tidy_up_and_fail;
4363 if (PerlSock_listen(listener, 1) == -1)
4364 goto tidy_up_and_fail;
4366 connector = PerlSock_socket(AF_INET, type, 0);
4367 if (connector == -1)
4368 goto tidy_up_and_fail;
4369 /* We want to find out the port number to connect to. */
4370 size = sizeof(connect_addr);
4371 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4373 goto tidy_up_and_fail;
4374 if (size != sizeof(connect_addr))
4375 goto abort_tidy_up_and_fail;
4376 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4377 sizeof(connect_addr)) == -1)
4378 goto tidy_up_and_fail;
4380 size = sizeof(listen_addr);
4381 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4384 goto tidy_up_and_fail;
4385 if (size != sizeof(listen_addr))
4386 goto abort_tidy_up_and_fail;
4387 PerlLIO_close(listener);
4388 /* Now check we are talking to ourself by matching port and host on the
4390 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4392 goto tidy_up_and_fail;
4393 if (size != sizeof(connect_addr)
4394 || listen_addr.sin_family != connect_addr.sin_family
4395 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4396 || listen_addr.sin_port != connect_addr.sin_port) {
4397 goto abort_tidy_up_and_fail;
4403 abort_tidy_up_and_fail:
4405 errno = ECONNABORTED; /* This would be the standard thing to do. */
4407 # ifdef ECONNREFUSED
4408 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4410 errno = ETIMEDOUT; /* Desperation time. */
4417 PerlLIO_close(listener);
4418 if (connector != -1)
4419 PerlLIO_close(connector);
4421 PerlLIO_close(acceptor);
4427 /* In any case have a stub so that there's code corresponding
4428 * to the my_socketpair in embed.fnc. */
4430 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4431 #ifdef HAS_SOCKETPAIR
4432 return socketpair(family, type, protocol, fd);
4441 =for apidoc sv_nosharing
4443 Dummy routine which "shares" an SV when there is no sharing module present.
4444 Or "locks" it. Or "unlocks" it. In other
4445 words, ignores its single SV argument.
4446 Exists to avoid test for a C<NULL> function pointer and because it could
4447 potentially warn under some level of strict-ness.
4453 Perl_sv_nosharing(pTHX_ SV *sv)
4455 PERL_UNUSED_CONTEXT;
4456 PERL_UNUSED_ARG(sv);
4461 =for apidoc sv_destroyable
4463 Dummy routine which reports that object can be destroyed when there is no
4464 sharing module present. It ignores its single SV argument, and returns
4465 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4466 could potentially warn under some level of strict-ness.
4472 Perl_sv_destroyable(pTHX_ SV *sv)
4474 PERL_UNUSED_CONTEXT;
4475 PERL_UNUSED_ARG(sv);
4480 Perl_parse_unicode_opts(pTHX_ const char **popt)
4482 const char *p = *popt;
4485 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4491 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4494 if (p && *p && *p != '\n' && *p != '\r') {
4496 goto the_end_of_the_opts_parser;
4498 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4502 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4508 case PERL_UNICODE_STDIN:
4509 opt |= PERL_UNICODE_STDIN_FLAG; break;
4510 case PERL_UNICODE_STDOUT:
4511 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4512 case PERL_UNICODE_STDERR:
4513 opt |= PERL_UNICODE_STDERR_FLAG; break;
4514 case PERL_UNICODE_STD:
4515 opt |= PERL_UNICODE_STD_FLAG; break;
4516 case PERL_UNICODE_IN:
4517 opt |= PERL_UNICODE_IN_FLAG; break;
4518 case PERL_UNICODE_OUT:
4519 opt |= PERL_UNICODE_OUT_FLAG; break;
4520 case PERL_UNICODE_INOUT:
4521 opt |= PERL_UNICODE_INOUT_FLAG; break;
4522 case PERL_UNICODE_LOCALE:
4523 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4524 case PERL_UNICODE_ARGV:
4525 opt |= PERL_UNICODE_ARGV_FLAG; break;
4526 case PERL_UNICODE_UTF8CACHEASSERT:
4527 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4529 if (*p != '\n' && *p != '\r') {
4530 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4533 "Unknown Unicode option letter '%c'", *p);
4540 opt = PERL_UNICODE_DEFAULT_FLAGS;
4542 the_end_of_the_opts_parser:
4544 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4545 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4546 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4554 # include <starlet.h>
4561 * This is really just a quick hack which grabs various garbage
4562 * values. It really should be a real hash algorithm which
4563 * spreads the effect of every input bit onto every output bit,
4564 * if someone who knows about such things would bother to write it.
4565 * Might be a good idea to add that function to CORE as well.
4566 * No numbers below come from careful analysis or anything here,
4567 * except they are primes and SEED_C1 > 1E6 to get a full-width
4568 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4569 * probably be bigger too.
4572 # define SEED_C1 1000003
4573 #define SEED_C4 73819
4575 # define SEED_C1 25747
4576 #define SEED_C4 20639
4580 #define SEED_C5 26107
4582 #ifndef PERL_NO_DEV_RANDOM
4586 #ifdef HAS_GETTIMEOFDAY
4587 struct timeval when;
4592 /* This test is an escape hatch, this symbol isn't set by Configure. */
4593 #ifndef PERL_NO_DEV_RANDOM
4594 #ifndef PERL_RANDOM_DEVICE
4595 /* /dev/random isn't used by default because reads from it will block
4596 * if there isn't enough entropy available. You can compile with
4597 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4598 * is enough real entropy to fill the seed. */
4599 # ifdef __amigaos4__
4600 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4602 # define PERL_RANDOM_DEVICE "/dev/urandom"
4605 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
4607 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4615 #ifdef HAS_GETTIMEOFDAY
4616 PerlProc_gettimeofday(&when,NULL);
4617 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4620 u = (U32)SEED_C1 * when;
4622 u += SEED_C3 * (U32)PerlProc_getpid();
4623 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4624 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4625 u += SEED_C5 * (U32)PTR2UV(&when);
4631 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4633 #ifndef NO_PERL_HASH_ENV
4638 PERL_ARGS_ASSERT_GET_HASH_SEED;
4640 #ifndef NO_PERL_HASH_ENV
4641 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4645 /* ignore leading spaces */
4646 while (isSPACE(*env_pv))
4648 # ifdef USE_PERL_PERTURB_KEYS
4649 /* if they set it to "0" we disable key traversal randomization completely */
4650 if (strEQ(env_pv,"0")) {
4651 PL_hash_rand_bits_enabled= 0;
4653 /* otherwise switch to deterministic mode */
4654 PL_hash_rand_bits_enabled= 2;
4657 /* ignore a leading 0x... if it is there */
4658 if (env_pv[0] == '0' && env_pv[1] == 'x')
4661 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4662 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4663 if ( isXDIGIT(*env_pv)) {
4664 seed_buffer[i] |= READ_XDIGIT(env_pv);
4667 while (isSPACE(*env_pv))
4670 if (*env_pv && !isXDIGIT(*env_pv)) {
4671 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4673 /* should we check for unparsed crap? */
4674 /* should we warn about unused hex? */
4675 /* should we warn about insufficient hex? */
4678 #endif /* NO_PERL_HASH_ENV */
4680 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4681 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
4684 #ifdef USE_PERL_PERTURB_KEYS
4685 { /* initialize PL_hash_rand_bits from the hash seed.
4686 * This value is highly volatile, it is updated every
4687 * hash insert, and is used as part of hash bucket chain
4688 * randomization and hash iterator randomization. */
4689 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4690 for( i = 0; i < sizeof(UV) ; i++ ) {
4691 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4692 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4695 # ifndef NO_PERL_HASH_ENV
4696 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4698 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4699 PL_hash_rand_bits_enabled= 0;
4700 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4701 PL_hash_rand_bits_enabled= 1;
4702 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4703 PL_hash_rand_bits_enabled= 2;
4705 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4712 #ifdef PERL_GLOBAL_STRUCT
4714 #define PERL_GLOBAL_STRUCT_INIT
4715 #include "opcode.h" /* the ppaddr and check */
4718 Perl_init_global_struct(pTHX)
4720 struct perl_vars *plvarsp = NULL;
4721 # ifdef PERL_GLOBAL_STRUCT
4722 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4723 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4724 PERL_UNUSED_CONTEXT;
4725 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4726 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4727 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4731 plvarsp = PL_VarsPtr;
4732 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4737 # define PERLVAR(prefix,var,type) /**/
4738 # define PERLVARA(prefix,var,n,type) /**/
4739 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4740 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4741 # include "perlvars.h"
4746 # ifdef PERL_GLOBAL_STRUCT
4749 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4750 if (!plvarsp->Gppaddr)
4754 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4755 if (!plvarsp->Gcheck)
4757 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4758 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4760 # ifdef PERL_SET_VARS
4761 PERL_SET_VARS(plvarsp);
4763 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4764 plvarsp->Gsv_placeholder.sv_flags = 0;
4765 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4767 # undef PERL_GLOBAL_STRUCT_INIT
4772 #endif /* PERL_GLOBAL_STRUCT */
4774 #ifdef PERL_GLOBAL_STRUCT
4777 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4779 int veto = plvarsp->Gveto_cleanup;
4781 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4782 PERL_UNUSED_CONTEXT;
4783 # ifdef PERL_GLOBAL_STRUCT
4784 # ifdef PERL_UNSET_VARS
4785 PERL_UNSET_VARS(plvarsp);
4789 free(plvarsp->Gppaddr);
4790 free(plvarsp->Gcheck);
4791 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4797 #endif /* PERL_GLOBAL_STRUCT */
4801 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4802 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4803 * given, and you supply your own implementation.
4805 * The default implementation reads a single env var, PERL_MEM_LOG,
4806 * expecting one or more of the following:
4808 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4809 * 'm' - memlog was PERL_MEM_LOG=1
4810 * 's' - svlog was PERL_SV_LOG=1
4811 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4813 * This makes the logger controllable enough that it can reasonably be
4814 * added to the system perl.
4817 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4818 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4820 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4822 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4823 * writes to. In the default logger, this is settable at runtime.
4825 #ifndef PERL_MEM_LOG_FD
4826 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4829 #ifndef PERL_MEM_LOG_NOIMPL
4831 # ifdef DEBUG_LEAKING_SCALARS
4832 # define SV_LOG_SERIAL_FMT " [%lu]"
4833 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4835 # define SV_LOG_SERIAL_FMT
4836 # define _SV_LOG_SERIAL_ARG(sv)
4840 S_mem_log_common(enum mem_log_type mlt, const UV n,
4841 const UV typesize, const char *type_name, const SV *sv,
4842 Malloc_t oldalloc, Malloc_t newalloc,
4843 const char *filename, const int linenumber,
4844 const char *funcname)
4848 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4850 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4853 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4855 /* We can't use SVs or PerlIO for obvious reasons,
4856 * so we'll use stdio and low-level IO instead. */
4857 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4859 # ifdef HAS_GETTIMEOFDAY
4860 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4861 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4863 gettimeofday(&tv, 0);
4865 # define MEM_LOG_TIME_FMT "%10d: "
4866 # define MEM_LOG_TIME_ARG (int)when
4870 /* If there are other OS specific ways of hires time than
4871 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4872 * probably that they would be used to fill in the struct
4879 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4880 && uv && uv <= PERL_INT_MAX
4884 fd = PERL_MEM_LOG_FD;
4887 if (strchr(pmlenv, 't')) {
4888 len = my_snprintf(buf, sizeof(buf),
4889 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4890 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4894 len = my_snprintf(buf, sizeof(buf),
4895 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4896 " %s = %" IVdf ": %" UVxf "\n",
4897 filename, linenumber, funcname, n, typesize,
4898 type_name, n * typesize, PTR2UV(newalloc));
4901 len = my_snprintf(buf, sizeof(buf),
4902 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4903 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4904 filename, linenumber, funcname, n, typesize,
4905 type_name, n * typesize, PTR2UV(oldalloc),
4909 len = my_snprintf(buf, sizeof(buf),
4910 "free: %s:%d:%s: %" UVxf "\n",
4911 filename, linenumber, funcname,
4916 len = my_snprintf(buf, sizeof(buf),
4917 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
4918 mlt == MLT_NEW_SV ? "new" : "del",
4919 filename, linenumber, funcname,
4920 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4925 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4929 #endif /* !PERL_MEM_LOG_NOIMPL */
4931 #ifndef PERL_MEM_LOG_NOIMPL
4933 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4934 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4936 /* this is suboptimal, but bug compatible. User is providing their
4937 own implementation, but is getting these functions anyway, and they
4938 do nothing. But _NOIMPL users should be able to cope or fix */
4940 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4941 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
4945 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4947 const char *filename, const int linenumber,
4948 const char *funcname)
4950 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
4952 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4953 NULL, NULL, newalloc,
4954 filename, linenumber, funcname);
4959 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4960 Malloc_t oldalloc, Malloc_t newalloc,
4961 const char *filename, const int linenumber,
4962 const char *funcname)
4964 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
4966 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4967 NULL, oldalloc, newalloc,
4968 filename, linenumber, funcname);
4973 Perl_mem_log_free(Malloc_t oldalloc,
4974 const char *filename, const int linenumber,
4975 const char *funcname)
4977 PERL_ARGS_ASSERT_MEM_LOG_FREE;
4979 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4980 filename, linenumber, funcname);
4985 Perl_mem_log_new_sv(const SV *sv,
4986 const char *filename, const int linenumber,
4987 const char *funcname)
4989 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4990 filename, linenumber, funcname);
4994 Perl_mem_log_del_sv(const SV *sv,
4995 const char *filename, const int linenumber,
4996 const char *funcname)
4998 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4999 filename, linenumber, funcname);
5002 #endif /* PERL_MEM_LOG */
5005 =for apidoc my_sprintf
5007 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
5008 the length of the string written to the buffer. Only rare pre-ANSI systems
5009 need the wrapper function - usually this is a direct call to C<sprintf>.
5013 #ifndef SPRINTF_RETURNS_STRLEN
5015 Perl_my_sprintf(char *buffer, const char* pat, ...)
5018 PERL_ARGS_ASSERT_MY_SPRINTF;
5019 va_start(args, pat);
5020 vsprintf(buffer, pat, args);
5022 return strlen(buffer);
5027 =for apidoc quadmath_format_single
5029 C<quadmath_snprintf()> is very strict about its C<format> string and will
5030 fail, returning -1, if the format is invalid. It accepts exactly
5033 C<quadmath_format_single()> checks that the intended single spec looks
5034 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
5035 and has C<Q> before it. This is not a full "printf syntax check",
5038 Returns the format if it is valid, NULL if not.
5040 C<quadmath_format_single()> can and will actually patch in the missing
5041 C<Q>, if necessary. In this case it will return the modified copy of
5042 the format, B<which the caller will need to free.>
5044 See also L</quadmath_format_needed>.
5050 Perl_quadmath_format_single(const char* format)
5054 PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
5056 if (format[0] != '%' || strchr(format + 1, '%'))
5058 len = strlen(format);
5059 /* minimum length three: %Qg */
5060 if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
5062 if (format[len - 2] != 'Q') {
5064 Newx(fixed, len + 1, char);
5065 memcpy(fixed, format, len - 1);
5066 fixed[len - 1] = 'Q';
5067 fixed[len ] = format[len - 1];
5069 return (const char*)fixed;
5076 =for apidoc quadmath_format_needed
5078 C<quadmath_format_needed()> returns true if the C<format> string seems to
5079 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
5080 or returns false otherwise.
5082 The format specifier detection is not complete printf-syntax detection,
5083 but it should catch most common cases.
5085 If true is returned, those arguments B<should> in theory be processed
5086 with C<quadmath_snprintf()>, but in case there is more than one such
5087 format specifier (see L</quadmath_format_single>), and if there is
5088 anything else beyond that one (even just a single byte), they
5089 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
5090 accepting only one format spec, and nothing else.
5091 In this case, the code should probably fail.
5097 Perl_quadmath_format_needed(const char* format)
5099 const char *p = format;
5102 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5104 while ((q = strchr(p, '%'))) {
5106 if (*q == '+') /* plus */
5108 if (*q == '#') /* alt */
5110 if (*q == '*') /* width */
5114 while (isDIGIT(*q)) q++;
5117 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5122 while (isDIGIT(*q)) q++;
5124 if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5133 =for apidoc my_snprintf
5135 The C library C<snprintf> functionality, if available and
5136 standards-compliant (uses C<vsnprintf>, actually). However, if the
5137 C<vsnprintf> is not available, will unfortunately use the unsafe
5138 C<vsprintf> which can overrun the buffer (there is an overrun check,
5139 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5140 getting C<vsnprintf>.
5145 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5149 PERL_ARGS_ASSERT_MY_SNPRINTF;
5150 #ifndef HAS_VSNPRINTF
5151 PERL_UNUSED_VAR(len);
5153 va_start(ap, format);
5156 const char* qfmt = quadmath_format_single(format);
5157 bool quadmath_valid = FALSE;
5159 /* If the format looked promising, use it as quadmath. */
5160 retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
5162 if (qfmt != format) {
5166 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
5168 quadmath_valid = TRUE;
5173 assert(qfmt == NULL);
5174 /* quadmath_format_single() will return false for example for
5175 * "foo = %g", or simply "%g". We could handle the %g by
5176 * using quadmath for the NV args. More complex cases of
5177 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5178 * quadmath-valid but has stuff in front).
5180 * Handling the "Q-less" cases right would require walking
5181 * through the va_list and rewriting the format, calling
5182 * quadmath for the NVs, building a new va_list, and then
5183 * letting vsnprintf/vsprintf to take care of the other
5184 * arguments. This may be doable.
5186 * We do not attempt that now. But for paranoia, we here try
5187 * to detect some common (but not all) cases where the
5188 * "Q-less" %[efgaEFGA] formats are present, and die if
5189 * detected. This doesn't fix the problem, but it stops the
5190 * vsnprintf/vsprintf pulling doubles off the va_list when
5191 * __float128 NVs should be pulled off instead.
5193 * If quadmath_format_needed() returns false, we are reasonably
5194 * certain that we can call vnsprintf() or vsprintf() safely. */
5195 if (!quadmath_valid && quadmath_format_needed(format))
5196 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5201 #ifdef HAS_VSNPRINTF
5202 retval = vsnprintf(buffer, len, format, ap);
5204 retval = vsprintf(buffer, format, ap);
5207 /* vsprintf() shows failure with < 0 */
5209 #ifdef HAS_VSNPRINTF
5210 /* vsnprintf() shows failure with >= len */
5212 (len > 0 && (Size_t)retval >= len)
5215 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5220 =for apidoc my_vsnprintf
5222 The C library C<vsnprintf> if available and standards-compliant.
5223 However, if if the C<vsnprintf> is not available, will unfortunately
5224 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5225 overrun check, but that may be too late). Consider using
5226 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5231 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5234 PERL_UNUSED_ARG(buffer);
5235 PERL_UNUSED_ARG(len);
5236 PERL_UNUSED_ARG(format);
5237 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5238 PERL_UNUSED_ARG((void*)ap);
5239 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5246 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5247 Perl_va_copy(ap, apc);
5248 # ifdef HAS_VSNPRINTF
5249 retval = vsnprintf(buffer, len, format, apc);
5251 PERL_UNUSED_ARG(len);
5252 retval = vsprintf(buffer, format, apc);
5256 # ifdef HAS_VSNPRINTF
5257 retval = vsnprintf(buffer, len, format, ap);
5259 PERL_UNUSED_ARG(len);
5260 retval = vsprintf(buffer, format, ap);
5262 #endif /* #ifdef NEED_VA_COPY */
5263 /* vsprintf() shows failure with < 0 */
5265 #ifdef HAS_VSNPRINTF
5266 /* vsnprintf() shows failure with >= len */
5268 (len > 0 && (Size_t)retval >= len)
5271 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5277 Perl_my_clearenv(pTHX)
5280 #if ! defined(PERL_MICRO)
5281 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5283 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5284 # if defined(USE_ENVIRON_ARRAY)
5285 # if defined(USE_ITHREADS)
5286 /* only the parent thread can clobber the process environment */
5287 if (PL_curinterp == aTHX)
5288 # endif /* USE_ITHREADS */
5290 # if ! defined(PERL_USE_SAFE_PUTENV)
5291 if ( !PL_use_safe_putenv) {
5293 if (environ == PL_origenviron)
5294 environ = (char**)safesysmalloc(sizeof(char*));
5296 for (i = 0; environ[i]; i++)
5297 (void)safesysfree(environ[i]);
5300 # else /* PERL_USE_SAFE_PUTENV */
5301 # if defined(HAS_CLEARENV)
5303 # elif defined(HAS_UNSETENV)
5304 int bsiz = 80; /* Most envvar names will be shorter than this. */
5305 char *buf = (char*)safesysmalloc(bsiz);
5306 while (*environ != NULL) {
5307 char *e = strchr(*environ, '=');
5308 int l = e ? e - *environ : (int)strlen(*environ);
5310 (void)safesysfree(buf);
5311 bsiz = l + 1; /* + 1 for the \0. */
5312 buf = (char*)safesysmalloc(bsiz);
5314 memcpy(buf, *environ, l);
5316 (void)unsetenv(buf);
5318 (void)safesysfree(buf);
5319 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5320 /* Just null environ and accept the leakage. */
5322 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5323 # endif /* ! PERL_USE_SAFE_PUTENV */
5325 # endif /* USE_ENVIRON_ARRAY */
5326 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5327 #endif /* PERL_MICRO */
5330 #ifdef PERL_IMPLICIT_CONTEXT
5332 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5333 the global PL_my_cxt_index is incremented, and that value is assigned to
5334 that module's static my_cxt_index (who's address is passed as an arg).
5335 Then, for each interpreter this function is called for, it makes sure a
5336 void* slot is available to hang the static data off, by allocating or
5337 extending the interpreter's PL_my_cxt_list array */
5339 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
5341 Perl_my_cxt_init(pTHX_ int *index, size_t size)
5345 PERL_ARGS_ASSERT_MY_CXT_INIT;
5347 /* this module hasn't been allocated an index yet */
5348 MUTEX_LOCK(&PL_my_ctx_mutex);
5349 *index = PL_my_cxt_index++;
5350 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5353 /* make sure the array is big enough */
5354 if (PL_my_cxt_size <= *index) {
5355 if (PL_my_cxt_size) {
5356 IV new_size = PL_my_cxt_size;
5357 while (new_size <= *index)
5359 Renew(PL_my_cxt_list, new_size, void *);
5360 PL_my_cxt_size = new_size;
5363 PL_my_cxt_size = 16;
5364 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5367 /* newSV() allocates one more than needed */
5368 p = (void*)SvPVX(newSV(size-1));
5369 PL_my_cxt_list[*index] = p;
5370 Zero(p, size, char);
5374 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5377 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5382 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5384 for (index = 0; index < PL_my_cxt_index; index++) {
5385 const char *key = PL_my_cxt_keys[index];
5386 /* try direct pointer compare first - there are chances to success,
5387 * and it's much faster.
5389 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5396 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5402 PERL_ARGS_ASSERT_MY_CXT_INIT;
5404 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5406 /* this module hasn't been allocated an index yet */
5407 MUTEX_LOCK(&PL_my_ctx_mutex);
5408 index = PL_my_cxt_index++;
5409 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5412 /* make sure the array is big enough */
5413 if (PL_my_cxt_size <= index) {
5414 int old_size = PL_my_cxt_size;
5416 if (PL_my_cxt_size) {
5417 IV new_size = PL_my_cxt_size;
5418 while (new_size <= index)
5420 Renew(PL_my_cxt_list, new_size, void *);
5421 Renew(PL_my_cxt_keys, new_size, const char *);
5422 PL_my_cxt_size = new_size;
5425 PL_my_cxt_size = 16;
5426 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5427 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5429 for (i = old_size; i < PL_my_cxt_size; i++) {
5430 PL_my_cxt_keys[i] = 0;
5431 PL_my_cxt_list[i] = 0;
5434 PL_my_cxt_keys[index] = my_cxt_key;
5435 /* newSV() allocates one more than needed */
5436 p = (void*)SvPVX(newSV(size-1));
5437 PL_my_cxt_list[index] = p;
5438 Zero(p, size, char);
5441 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5442 #endif /* PERL_IMPLICIT_CONTEXT */
5445 /* Perl_xs_handshake():
5446 implement the various XS_*_BOOTCHECK macros, which are added to .c
5447 files by ExtUtils::ParseXS, to check that the perl the module was built
5448 with is binary compatible with the running perl.
5451 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5452 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5454 The meaning of the varargs is determined the U32 key arg (which is not
5455 a format string). The fields of key are assembled by using HS_KEY().
5457 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5458 "PerlInterpreter *" and represents the callers context; otherwise it is
5459 of type "CV *", and is the boot xsub's CV.
5461 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5462 for example, and IO.dll was linked with threaded perl524.dll, and both
5463 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5464 successfully can load IO.dll into the process but simultaneously it
5465 loaded an interpreter of a different version into the process, and XS
5466 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5467 use through perl526.dll's my_perl->Istack_base.
5469 v_my_perl cannot be the first arg, since then 'key' will be out of
5470 place in a threaded vs non-threaded mixup; and analyzing the key
5471 number's bitfields won't reveal the problem, since it will be a valid
5472 key (unthreaded perl) on interp side, but croak will report the XS mod's
5473 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5474 it's a threaded perl and an unthreaded XS module, threaded perl will
5475 look at an uninit C stack or an uninit register to get 'key'
5476 (remember that it assumes that the 1st arg is the interp cxt).
5478 'file' is the source filename of the caller.
5482 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5488 #ifdef PERL_IMPLICIT_CONTEXT
5495 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5496 va_start(args, file);
5498 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5499 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5500 if (UNLIKELY(got != need))
5502 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5503 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5504 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5505 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5506 passed to the XS DLL */
5507 #ifdef PERL_IMPLICIT_CONTEXT
5508 xs_interp = (tTHX)v_my_perl;
5512 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5513 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5514 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5515 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5516 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5517 location in the unthreaded perl binary) stored in CV * to figure out if this
5518 Perl_xs_handshake was called by the same pp_entersub */
5519 cv = (CV*)v_my_perl;
5520 xs_spp = (SV***)CvHSCXT(cv);
5522 need = &PL_stack_sp;
5524 if(UNLIKELY(got != need)) {
5525 bad_handshake:/* recycle branch and string from above */
5526 if(got != (void *)HSf_NOCHK)
5527 noperl_die("%s: loadable library and perl binaries are mismatched"
5528 " (got handshake key %p, needed %p)\n",
5532 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5533 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5534 PL_xsubfilename = file; /* so the old name must be restored for
5535 additional XSUBs to register themselves */
5536 /* XSUBs can't be perl lang/perl5db.pl debugged
5537 if (PERLDB_LINE_OR_SAVESRC)
5538 (void)gv_fetchfile(file); */
5541 if(key & HSf_POPMARK) {
5543 { SV **mark = PL_stack_base + ax++;
5545 items = (I32)(SP - MARK);
5549 items = va_arg(args, U32);
5550 ax = va_arg(args, U32);
5554 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5555 if((apiverlen = HS_GETAPIVERLEN(key))) {
5556 char * api_p = va_arg(args, char*);
5557 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5558 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5559 sizeof("v" PERL_API_VERSION_STRING)-1))
5560 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5561 api_p, SVfARG(PL_stack_base[ax + 0]),
5562 "v" PERL_API_VERSION_STRING);
5567 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5568 if((xsverlen = HS_GETXSVERLEN(key)))
5569 S_xs_version_bootcheck(aTHX_
5570 items, ax, va_arg(args, char*), xsverlen);
5578 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5582 const char *vn = NULL;
5583 SV *const module = PL_stack_base[ax];
5585 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5587 if (items >= 2) /* version supplied as bootstrap arg */
5588 sv = PL_stack_base[ax + 1];
5590 /* XXX GV_ADDWARN */
5592 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5593 if (!sv || !SvOK(sv)) {
5595 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5599 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5600 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5601 ? sv : sv_2mortal(new_version(sv));
5602 xssv = upg_version(xssv, 0);
5603 if ( vcmp(pmsv,xssv) ) {
5604 SV *string = vstringify(xssv);
5605 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5606 " does not match ", SVfARG(module), SVfARG(string));
5608 SvREFCNT_dec(string);
5609 string = vstringify(pmsv);
5612 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5615 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5617 SvREFCNT_dec(string);
5619 Perl_sv_2mortal(aTHX_ xpt);
5620 Perl_croak_sv(aTHX_ xpt);
5626 =for apidoc my_strlcat
5628 The C library C<strlcat> if available, or a Perl implementation of it.
5629 This operates on C C<NUL>-terminated strings.
5631 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5632 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5633 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5634 practice this should not happen as it means that either C<size> is incorrect or
5635 that C<dst> is not a proper C<NUL>-terminated string).
5637 Note that C<size> is the full size of the destination buffer and
5638 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5639 room for the C<NUL> should be included in C<size>.
5641 The return value is the total length that C<dst> would have if C<size> is
5642 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5643 C<src>. If C<size> is smaller than the return, the excess was not appended.
5647 Description stolen from http://man.openbsd.org/strlcat.3
5651 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5653 Size_t used, length, copy;
5656 length = strlen(src);
5657 if (size > 0 && used < size - 1) {
5658 copy = (length >= size - used) ? size - used - 1 : length;
5659 memcpy(dst + used, src, copy);
5660 dst[used + copy] = '\0';
5662 return used + length;
5668 =for apidoc my_strlcpy
5670 The C library C<strlcpy> if available, or a Perl implementation of it.
5671 This operates on C C<NUL>-terminated strings.
5673 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5674 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5676 The return value is the total length C<src> would be if the copy completely
5677 succeeded. If it is larger than C<size>, the excess was not copied.
5681 Description stolen from http://man.openbsd.org/strlcpy.3
5685 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5687 Size_t length, copy;
5689 length = strlen(src);
5691 copy = (length >= size) ? size - 1 : length;
5692 memcpy(dst, src, copy);
5699 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5700 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5701 long _ftol( double ); /* Defined by VC6 C libs. */
5702 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5705 PERL_STATIC_INLINE bool
5706 S_gv_has_usable_name(pTHX_ GV *gv)
5710 && HvENAME(GvSTASH(gv))
5711 && (gvp = (GV **)hv_fetchhek(
5712 GvSTASH(gv), GvNAME_HEK(gv), 0
5718 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5720 SV * const dbsv = GvSVn(PL_DBsub);
5721 const bool save_taint = TAINT_get;
5723 /* When we are called from pp_goto (svp is null),
5724 * we do not care about using dbsv to call CV;
5725 * it's for informational purposes only.
5728 PERL_ARGS_ASSERT_GET_DB_SUB;
5732 if (!PERLDB_SUB_NN) {
5735 if (!svp && !CvLEXICAL(cv)) {
5736 gv_efullname3(dbsv, gv, NULL);
5738 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5739 || strEQ(GvNAME(gv), "END")
5740 || ( /* Could be imported, and old sub redefined. */
5741 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5743 !( (SvTYPE(*svp) == SVt_PVGV)
5744 && (GvCV((const GV *)*svp) == cv)
5745 /* Use GV from the stack as a fallback. */
5746 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5750 /* GV is potentially non-unique, or contain different CV. */
5751 SV * const tmp = newRV(MUTABLE_SV(cv));
5752 sv_setsv(dbsv, tmp);
5756 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5757 sv_catpvs(dbsv, "::");
5758 sv_cathek(dbsv, GvNAME_HEK(gv));
5762 const int type = SvTYPE(dbsv);
5763 if (type < SVt_PVIV && type != SVt_IV)
5764 sv_upgrade(dbsv, SVt_PVIV);
5765 (void)SvIOK_on(dbsv);
5766 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5769 TAINT_IF(save_taint);
5770 #ifdef NO_TAINT_SUPPORT
5771 PERL_UNUSED_VAR(save_taint);
5776 Perl_my_dirfd(DIR * dir) {
5778 /* Most dirfd implementations have problems when passed NULL. */
5783 #elif defined(HAS_DIR_DD_FD)
5786 Perl_croak_nocontext(PL_no_func, "dirfd");
5787 NOT_REACHED; /* NOTREACHED */
5794 #define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
5795 #define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
5798 Perl_my_mkstemp(char *templte) {
5800 STRLEN len = strlen(templte);
5804 PERL_ARGS_ASSERT_MY_MKSTEMP;
5807 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
5808 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
5815 for (i = 1; i <= 6; ++i) {
5816 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
5818 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL, 0600);
5819 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
5827 Perl_get_re_arg(pTHX_ SV *sv) {
5833 sv = MUTABLE_SV(SvRV(sv));
5834 if (SvTYPE(sv) == SVt_REGEXP)
5835 return (REGEXP*) sv;
5842 * This code is derived from drand48() implementation from FreeBSD,
5843 * found in lib/libc/gen/_rand48.c.
5845 * The U64 implementation is original, based on the POSIX
5846 * specification for drand48().
5850 * Copyright (c) 1993 Martin Birgmeier
5851 * All rights reserved.
5853 * You may redistribute unmodified or modified versions of this source
5854 * code provided that the above copyright notice and this and the
5855 * following conditions are retained.
5857 * This software is provided ``as is'', and comes with no warranties
5858 * of any kind. I shall in no event be liable for anything that happens
5859 * to anyone/anything when using this software.
5862 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5864 #ifdef PERL_DRAND48_QUAD
5866 #define DRAND48_MULT U64_CONST(0x5deece66d)
5867 #define DRAND48_ADD 0xb
5868 #define DRAND48_MASK U64_CONST(0xffffffffffff)
5872 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5873 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5874 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5875 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5876 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5877 #define FREEBSD_DRAND48_ADD (0x000b)
5879 const unsigned short _rand48_mult[3] = {
5880 FREEBSD_DRAND48_MULT_0,
5881 FREEBSD_DRAND48_MULT_1,
5882 FREEBSD_DRAND48_MULT_2
5884 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5889 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5891 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5893 #ifdef PERL_DRAND48_QUAD
5894 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5896 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5897 random_state->seed[1] = (U16) seed;
5898 random_state->seed[2] = (U16) (seed >> 16);
5903 Perl_drand48_r(perl_drand48_t *random_state)
5905 PERL_ARGS_ASSERT_DRAND48_R;
5907 #ifdef PERL_DRAND48_QUAD
5908 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5911 return ldexp((double)*random_state, -48);
5917 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5918 + (U32) _rand48_add;
5919 temp[0] = (U16) accu; /* lower 16 bits */
5920 accu >>= sizeof(U16) * 8;
5921 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5922 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5923 temp[1] = (U16) accu; /* middle 16 bits */
5924 accu >>= sizeof(U16) * 8;
5925 accu += _rand48_mult[0] * random_state->seed[2]
5926 + _rand48_mult[1] * random_state->seed[1]
5927 + _rand48_mult[2] * random_state->seed[0];
5928 random_state->seed[0] = temp[0];
5929 random_state->seed[1] = temp[1];
5930 random_state->seed[2] = (U16) accu;
5932 return ldexp((double) random_state->seed[0], -48) +
5933 ldexp((double) random_state->seed[1], -32) +
5934 ldexp((double) random_state->seed[2], -16);
5939 #ifdef USE_C_BACKTRACE
5941 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5946 /* abfd is the BFD handle. */
5948 /* bfd_syms is the BFD symbol table. */
5950 /* bfd_text is handle to the the ".text" section of the object file. */
5952 /* Since opening the executable and scanning its symbols is quite
5953 * heavy operation, we remember the filename we used the last time,
5954 * and do the opening and scanning only if the filename changes.
5955 * This removes most (but not all) open+scan cycles. */
5956 const char* fname_prev;
5959 /* Given a dl_info, update the BFD context if necessary. */
5960 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5962 /* BFD open and scan only if the filename changed. */
5963 if (ctx->fname_prev == NULL ||
5964 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5966 bfd_close(ctx->abfd);
5968 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5970 if (bfd_check_format(ctx->abfd, bfd_object)) {
5971 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5972 if (symbol_size > 0) {
5973 Safefree(ctx->bfd_syms);
5974 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5976 bfd_get_section_by_name(ctx->abfd, ".text");
5984 ctx->fname_prev = dl_info->dli_fname;
5988 /* Given a raw frame, try to symbolize it and store
5989 * symbol information (source file, line number) away. */
5990 static void bfd_symbolize(bfd_context* ctx,
5993 STRLEN* symbol_name_size,
5995 STRLEN* source_name_size,
5996 STRLEN* source_line)
5998 *symbol_name = NULL;
5999 *symbol_name_size = 0;
6001 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
6003 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
6006 unsigned int line = 0;
6007 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
6008 ctx->bfd_syms, offset,
6009 &file, &func, &line) &&
6010 file && func && line > 0) {
6011 /* Size and copy the source file, use only
6012 * the basename of the source file.
6014 * NOTE: the basenames are fine for the
6015 * Perl source files, but may not always
6016 * be the best idea for XS files. */
6017 const char *p, *b = NULL;
6018 /* Look for the last slash. */
6019 for (p = file; *p; p++) {
6023 if (b == NULL || *b == 0) {
6026 *source_name_size = p - b + 1;
6027 Newx(*source_name, *source_name_size + 1, char);
6028 Copy(b, *source_name, *source_name_size + 1, char);
6030 *symbol_name_size = strlen(func);
6031 Newx(*symbol_name, *symbol_name_size + 1, char);
6032 Copy(func, *symbol_name, *symbol_name_size + 1, char);
6034 *source_line = line;
6040 #endif /* #ifdef USE_BFD */
6044 /* OS X has no public API for for 'symbolicating' (Apple official term)
6045 * stack addresses to {function_name, source_file, line_number}.
6046 * Good news: there is command line utility atos(1) which does that.
6047 * Bad news 1: it's a command line utility.
6048 * Bad news 2: one needs to have the Developer Tools installed.
6049 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
6051 * To recap: we need to open a pipe for reading for a utility which
6052 * might not exist, or exists in different locations, and then parse
6053 * the output. And since this is all for a low-level API, we cannot
6054 * use high-level stuff. Thanks, Apple. */
6057 /* tool is set to the absolute pathname of the tool to use:
6060 /* format is set to a printf format string used for building
6061 * the external command to run. */
6063 /* unavail is set if e.g. xcrun cannot be found, or something
6064 * else happens that makes getting the backtrace dubious. Note,
6065 * however, that the context isn't persistent, the next call to
6066 * get_c_backtrace() will start from scratch. */
6068 /* fname is the current object file name. */
6070 /* object_base_addr is the base address of the shared object. */
6071 void* object_base_addr;
6074 /* Given |dl_info|, updates the context. If the context has been
6075 * marked unavailable, return immediately. If not but the tool has
6076 * not been set, set it to either "xcrun atos" or "atos" (also set the
6077 * format to use for creating commands for piping), or if neither is
6078 * unavailable (one needs the Developer Tools installed), mark the context
6079 * an unavailable. Finally, update the filename (object name),
6080 * and its base address. */
6082 static void atos_update(atos_context* ctx,
6087 if (ctx->tool == NULL) {
6088 const char* tools[] = {
6092 const char* formats[] = {
6093 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6094 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6098 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6099 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6100 ctx->tool = tools[i];
6101 ctx->format = formats[i];
6105 if (ctx->tool == NULL) {
6106 ctx->unavail = TRUE;
6110 if (ctx->fname == NULL ||
6111 strNE(dl_info->dli_fname, ctx->fname)) {
6112 ctx->fname = dl_info->dli_fname;
6113 ctx->object_base_addr = dl_info->dli_fbase;
6117 /* Given an output buffer end |p| and its |start|, matches
6118 * for the atos output, extracting the source code location
6119 * and returning non-NULL if possible, returning NULL otherwise. */
6120 static const char* atos_parse(const char* p,
6122 STRLEN* source_name_size,
6123 STRLEN* source_line) {
6124 /* atos() output is something like:
6125 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6126 * We cannot use Perl regular expressions, because we need to
6127 * stay low-level. Therefore here we have a rolled-out version
6128 * of a state machine which matches _backwards_from_the_end_ and
6129 * if there's a success, returns the starts of the filename,
6130 * also setting the filename size and the source line number.
6131 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6132 const char* source_number_start;
6133 const char* source_name_end;
6134 const char* source_line_end;
6135 const char* close_paren;
6138 /* Skip trailing whitespace. */
6139 while (p > start && isSPACE(*p)) p--;
6140 /* Now we should be at the close paren. */
6141 if (p == start || *p != ')')
6145 /* Now we should be in the line number. */
6146 if (p == start || !isDIGIT(*p))
6148 /* Skip over the digits. */
6149 while (p > start && isDIGIT(*p))
6151 /* Now we should be at the colon. */
6152 if (p == start || *p != ':')
6154 source_number_start = p + 1;
6155 source_name_end = p; /* Just beyond the end. */
6157 /* Look for the open paren. */
6158 while (p > start && *p != '(')
6163 *source_name_size = source_name_end - p;
6164 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6165 && source_line_end == close_paren
6166 && uv <= PERL_INT_MAX
6168 *source_line = (STRLEN)uv;
6174 /* Given a raw frame, read a pipe from the symbolicator (that's the
6175 * technical term) atos, reads the result, and parses the source code
6176 * location. We must stay low-level, so we use snprintf(), pipe(),
6177 * and fread(), and then also parse the output ourselves. */
6178 static void atos_symbolize(atos_context* ctx,
6181 STRLEN* source_name_size,
6182 STRLEN* source_line)
6190 /* Simple security measure: if there's any funny business with
6191 * the object name (used as "-o '%s'" ), leave since at least
6192 * partially the user controls it. */
6193 for (p = ctx->fname; *p; p++) {
6194 if (*p == '\'' || isCNTRL(*p)) {
6195 ctx->unavail = TRUE;
6199 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6200 ctx->fname, ctx->object_base_addr, raw_frame);
6201 if (cnt < sizeof(cmd)) {
6202 /* Undo nostdio.h #defines that disable stdio.
6203 * This is somewhat naughty, but is used elsewhere
6204 * in the core, and affects only OS X. */
6209 FILE* fp = popen(cmd, "r");
6210 /* At the moment we open a new pipe for each stack frame.
6211 * This is naturally somewhat slow, but hopefully generating
6212 * stack traces is never going to in a performance critical path.
6214 * We could play tricks with atos by batching the stack
6215 * addresses to be resolved: atos can either take multiple
6216 * addresses from the command line, or read addresses from
6217 * a file (though the mess of creating temporary files would
6218 * probably negate much of any possible speedup).
6220 * Normally there are only two objects present in the backtrace:
6221 * perl itself, and the libdyld.dylib. (Note that the object
6222 * filenames contain the full pathname, so perl may not always
6223 * be in the same place.) Whenever the object in the
6224 * backtrace changes, the base address also changes.
6226 * The problem with batching the addresses, though, would be
6227 * matching the results with the addresses: the parsing of
6228 * the results is already painful enough with a single address. */
6231 UV cnt = fread(out, 1, sizeof(out), fp);
6232 if (cnt < sizeof(out)) {
6233 const char* p = atos_parse(out + cnt - 1, out,
6238 *source_name_size, char);
6239 Copy(p, *source_name,
6240 *source_name_size, char);
6248 #endif /* #ifdef PERL_DARWIN */
6251 =for apidoc get_c_backtrace
6253 Collects the backtrace (aka "stacktrace") into a single linear
6254 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6256 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6257 returning at most C<depth> frames.
6263 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6265 /* Note that here we must stay as low-level as possible: Newx(),
6266 * Copy(), Safefree(); since we may be called from anywhere,
6267 * so we should avoid higher level constructs like SVs or AVs.
6269 * Since we are using safesysmalloc() via Newx(), don't try
6270 * getting backtrace() there, unless you like deep recursion. */
6272 /* Currently only implemented with backtrace() and dladdr(),
6273 * for other platforms NULL is returned. */
6275 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6276 /* backtrace() is available via <execinfo.h> in glibc and in most
6277 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6279 /* We try fetching this many frames total, but then discard
6280 * the |skip| first ones. For the remaining ones we will try
6281 * retrieving more information with dladdr(). */
6282 int try_depth = skip + depth;
6284 /* The addresses (program counters) returned by backtrace(). */
6287 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6290 /* Sizes _including_ the terminating \0 of the object name
6291 * and symbol name strings. */
6292 STRLEN* object_name_sizes;
6293 STRLEN* symbol_name_sizes;
6296 /* The symbol names comes either from dli_sname,
6297 * or if using BFD, they can come from BFD. */
6298 char** symbol_names;
6301 /* The source code location information. Dug out with e.g. BFD. */
6302 char** source_names;
6303 STRLEN* source_name_sizes;
6304 STRLEN* source_lines;
6306 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6307 int got_depth; /* How many frames were returned from backtrace(). */
6308 UV frame_count = 0; /* How many frames we return. */
6309 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6312 bfd_context bfd_ctx;
6315 atos_context atos_ctx;
6318 /* Here are probably possibilities for optimizing. We could for
6319 * example have a struct that contains most of these and then
6320 * allocate |try_depth| of them, saving a bunch of malloc calls.
6321 * Note, however, that |frames| could not be part of that struct
6322 * because backtrace() will want an array of just them. Also be
6323 * careful about the name strings. */
6324 Newx(raw_frames, try_depth, void*);
6325 Newx(dl_infos, try_depth, Dl_info);
6326 Newx(object_name_sizes, try_depth, STRLEN);
6327 Newx(symbol_name_sizes, try_depth, STRLEN);
6328 Newx(source_names, try_depth, char*);
6329 Newx(source_name_sizes, try_depth, STRLEN);
6330 Newx(source_lines, try_depth, STRLEN);
6332 Newx(symbol_names, try_depth, char*);
6335 /* Get the raw frames. */
6336 got_depth = (int)backtrace(raw_frames, try_depth);
6338 /* We use dladdr() instead of backtrace_symbols() because we want
6339 * the full details instead of opaque strings. This is useful for
6340 * two reasons: () the details are needed for further symbolic
6341 * digging, for example in OS X (2) by having the details we fully
6342 * control the output, which in turn is useful when more platforms
6343 * are added: we can keep out output "portable". */
6345 /* We want a single linear allocation, which can then be freed
6346 * with a single swoop. We will do the usual trick of first
6347 * walking over the structure and seeing how much we need to
6348 * allocate, then allocating, and then walking over the structure
6349 * the second time and populating it. */
6351 /* First we must compute the total size of the buffer. */
6352 total_bytes = sizeof(Perl_c_backtrace_header);
6353 if (got_depth > skip) {
6356 bfd_init(); /* Is this safe to call multiple times? */
6357 Zero(&bfd_ctx, 1, bfd_context);
6360 Zero(&atos_ctx, 1, atos_context);
6362 for (i = skip; i < try_depth; i++) {
6363 Dl_info* dl_info = &dl_infos[i];
6365 object_name_sizes[i] = 0;
6366 source_names[i] = NULL;
6367 source_name_sizes[i] = 0;
6368 source_lines[i] = 0;
6370 /* Yes, zero from dladdr() is failure. */
6371 if (dladdr(raw_frames[i], dl_info)) {
6372 total_bytes += sizeof(Perl_c_backtrace_frame);
6374 object_name_sizes[i] =
6375 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6376 symbol_name_sizes[i] =
6377 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6379 bfd_update(&bfd_ctx, dl_info);
6380 bfd_symbolize(&bfd_ctx, raw_frames[i],
6382 &symbol_name_sizes[i],
6384 &source_name_sizes[i],
6388 atos_update(&atos_ctx, dl_info);
6389 atos_symbolize(&atos_ctx,
6392 &source_name_sizes[i],
6396 /* Plus ones for the terminating \0. */
6397 total_bytes += object_name_sizes[i] + 1;
6398 total_bytes += symbol_name_sizes[i] + 1;
6399 total_bytes += source_name_sizes[i] + 1;
6407 Safefree(bfd_ctx.bfd_syms);
6411 /* Now we can allocate and populate the result buffer. */
6412 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6413 Zero(bt, total_bytes, char);
6414 bt->header.frame_count = frame_count;
6415 bt->header.total_bytes = total_bytes;
6416 if (frame_count > 0) {
6417 Perl_c_backtrace_frame* frame = bt->frame_info;
6418 char* name_base = (char *)(frame + frame_count);
6419 char* name_curr = name_base; /* Outputting the name strings here. */
6421 for (i = skip; i < skip + frame_count; i++) {
6422 Dl_info* dl_info = &dl_infos[i];
6424 frame->addr = raw_frames[i];
6425 frame->object_base_addr = dl_info->dli_fbase;
6426 frame->symbol_addr = dl_info->dli_saddr;
6428 /* Copies a string, including the \0, and advances the name_curr.
6429 * Also copies the start and the size to the frame. */
6430 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6432 Copy(src, name_curr, size, char); \
6433 frame->doffset = name_curr - (char*)bt; \
6434 frame->dsize = size; \
6435 name_curr += size; \
6438 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6440 object_name_size, object_name_sizes[i]);
6443 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6445 symbol_name_size, symbol_name_sizes[i]);
6446 Safefree(symbol_names[i]);
6448 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6450 symbol_name_size, symbol_name_sizes[i]);
6453 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6455 source_name_size, source_name_sizes[i]);
6456 Safefree(source_names[i]);
6458 #undef PERL_C_BACKTRACE_STRCPY
6460 frame->source_line_number = source_lines[i];
6464 assert(total_bytes ==
6465 (UV)(sizeof(Perl_c_backtrace_header) +
6466 frame_count * sizeof(Perl_c_backtrace_frame) +
6467 name_curr - name_base));
6470 Safefree(symbol_names);
6472 bfd_close(bfd_ctx.abfd);
6475 Safefree(source_lines);
6476 Safefree(source_name_sizes);
6477 Safefree(source_names);
6478 Safefree(symbol_name_sizes);
6479 Safefree(object_name_sizes);
6480 /* Assuming the strings returned by dladdr() are pointers
6481 * to read-only static memory (the object file), so that
6482 * they do not need freeing (and cannot be). */
6484 Safefree(raw_frames);
6487 PERL_UNUSED_ARGV(depth);
6488 PERL_UNUSED_ARGV(skip);
6494 =for apidoc free_c_backtrace
6496 Deallocates a backtrace received from get_c_bracktrace.
6502 =for apidoc get_c_backtrace_dump
6504 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6505 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6507 The appended output looks like:
6510 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6511 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6514 The fields are tab-separated. The first column is the depth (zero
6515 being the innermost non-skipped frame). In the hex:offset, the hex is
6516 where the program counter was in C<S_parse_body>, and the :offset (might
6517 be missing) tells how much inside the C<S_parse_body> the program counter was.
6519 The C<util.c:1716> is the source code file and line number.
6521 The F</usr/bin/perl> is obvious (hopefully).
6523 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6524 if the platform doesn't support retrieving the information;
6525 if the binary is missing the debug information;
6526 if the optimizer has transformed the code by for example inlining.
6532 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6534 Perl_c_backtrace* bt;
6536 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6538 Perl_c_backtrace_frame* frame;
6539 SV* dsv = newSVpvs("");
6541 for (i = 0, frame = bt->frame_info;
6542 i < bt->header.frame_count; i++, frame++) {
6543 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6544 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6545 /* Symbol (function) names might disappear without debug info.
6547 * The source code location might disappear in case of the
6548 * optimizer inlining or otherwise rearranging the code. */
6549 if (frame->symbol_addr) {
6550 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6552 ((char*)frame->addr - (char*)frame->symbol_addr));
6554 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6555 frame->symbol_name_size &&
6556 frame->symbol_name_offset ?
6557 (char*)bt + frame->symbol_name_offset : "-");
6558 if (frame->source_name_size &&
6559 frame->source_name_offset &&
6560 frame->source_line_number) {
6561 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6562 (char*)bt + frame->source_name_offset,
6563 (UV)frame->source_line_number);
6565 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6567 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6568 frame->object_name_size &&
6569 frame->object_name_offset ?
6570 (char*)bt + frame->object_name_offset : "-");
6571 /* The frame->object_base_addr is not output,
6572 * but it is used for symbolizing/symbolicating. */
6573 sv_catpvs(dsv, "\n");
6576 Perl_free_c_backtrace(bt);
6585 =for apidoc dump_c_backtrace
6587 Dumps the C backtrace to the given C<fp>.
6589 Returns true if a backtrace could be retrieved, false if not.
6595 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6599 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6601 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6604 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6610 #endif /* #ifdef USE_C_BACKTRACE */
6612 #ifdef PERL_TSA_ACTIVE
6614 /* pthread_mutex_t and perl_mutex are typedef equivalent
6615 * so casting the pointers is fine. */
6617 int perl_tsa_mutex_lock(perl_mutex* mutex)
6619 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6622 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6624 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6627 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6629 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6637 /* log a sub call or return */
6640 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6648 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6651 HEK *hek = CvNAME_HEK(cv);
6652 func = HEK_KEY(hek);
6658 start = (const COP *)CvSTART(cv);
6659 file = CopFILE(start);
6660 line = CopLINE(start);
6661 stash = CopSTASHPV(start);
6664 PERL_SUB_ENTRY(func, file, line, stash);
6667 PERL_SUB_RETURN(func, file, line, stash);
6672 /* log a require file loading/loaded */
6675 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6677 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6680 PERL_LOADING_FILE(name);
6683 PERL_LOADED_FILE(name);
6688 /* log an op execution */
6691 Perl_dtrace_probe_op(pTHX_ const OP *op)
6693 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6695 PERL_OP_ENTRY(OP_NAME(op));
6699 /* log a compile/run phase change */
6702 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6704 const char *ph_old = PL_phase_names[PL_phase];
6705 const char *ph_new = PL_phase_names[phase];
6707 PERL_PHASE_CHANGE(ph_new, ph_old);
6713 * ex: set ts=8 sts=4 sw=4 et: