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
138 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
140 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
143 if ((SSize_t)size < 0)
144 Perl_croak_nocontext("panic: malloc, size=%" UVuf, (UV) size);
146 if (!size) size = 1; /* malloc(0) is NASTY on our system */
148 #ifdef PERL_DEBUG_READONLY_COW
149 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
150 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
151 perror("mmap failed");
155 ptr = (Malloc_t)PerlMem_malloc(size?size:1);
157 PERL_ALLOC_CHECK(ptr);
160 struct perl_memory_debug_header *const header
161 = (struct perl_memory_debug_header *)ptr;
165 PoisonNew(((char *)ptr), size, char);
168 #ifdef PERL_TRACK_MEMPOOL
169 header->interpreter = aTHX;
170 /* Link us into the list. */
171 header->prev = &PL_memory_debug_header;
172 header->next = PL_memory_debug_header.next;
173 PL_memory_debug_header.next = header;
174 maybe_protect_rw(header->next);
175 header->next->prev = header;
176 maybe_protect_ro(header->next);
177 # ifdef PERL_DEBUG_READONLY_COW
178 header->readonly = 0;
184 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
185 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
187 /* malloc() can modify errno() even on success, but since someone
188 writing perl code doesn't have any control over when perl calls
189 malloc() we need to hide that.
198 #ifndef ALWAYS_NEED_THX
210 /* paranoid version of system's realloc() */
213 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
215 #ifdef ALWAYS_NEED_THX
219 #ifdef PERL_DEBUG_READONLY_COW
220 const MEM_SIZE oldsize = where
221 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
230 ptr = safesysmalloc(size);
235 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
236 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
238 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
240 struct perl_memory_debug_header *const header
241 = (struct perl_memory_debug_header *)where;
243 # ifdef PERL_TRACK_MEMPOOL
244 if (header->interpreter != aTHX) {
245 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
246 header->interpreter, aTHX);
248 assert(header->next->prev == header);
249 assert(header->prev->next == header);
251 if (header->size > size) {
252 const MEM_SIZE freed_up = header->size - size;
253 char *start_of_freed = ((char *)where) + size;
254 PoisonFree(start_of_freed, freed_up, char);
264 if ((SSize_t)size < 0)
265 Perl_croak_nocontext("panic: realloc, size=%" UVuf, (UV)size);
267 #ifdef PERL_DEBUG_READONLY_COW
268 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
269 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
270 perror("mmap failed");
273 Copy(where,ptr,oldsize < size ? oldsize : size,char);
274 if (munmap(where, oldsize)) {
275 perror("munmap failed");
279 ptr = (Malloc_t)PerlMem_realloc(where,size);
281 PERL_ALLOC_CHECK(ptr);
283 /* MUST do this fixup first, before doing ANYTHING else, as anything else
284 might allocate memory/free/move memory, and until we do the fixup, it
285 may well be chasing (and writing to) free memory. */
287 #ifdef PERL_TRACK_MEMPOOL
288 struct perl_memory_debug_header *const header
289 = (struct perl_memory_debug_header *)ptr;
292 if (header->size < size) {
293 const MEM_SIZE fresh = size - header->size;
294 char *start_of_fresh = ((char *)ptr) + size;
295 PoisonNew(start_of_fresh, fresh, char);
299 maybe_protect_rw(header->next);
300 header->next->prev = header;
301 maybe_protect_ro(header->next);
302 maybe_protect_rw(header->prev);
303 header->prev->next = header;
304 maybe_protect_ro(header->prev);
306 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
308 /* realloc() can modify errno() even on success, but since someone
309 writing perl code doesn't have any control over when perl calls
310 realloc() we need to hide that.
315 /* In particular, must do that fixup above before logging anything via
316 *printf(), as it can reallocate memory, which can cause SEGVs. */
318 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
319 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
326 #ifndef ALWAYS_NEED_THX
339 /* safe version of system's free() */
342 Perl_safesysfree(Malloc_t where)
344 #ifdef ALWAYS_NEED_THX
347 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
350 Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
352 struct perl_memory_debug_header *const header
353 = (struct perl_memory_debug_header *)where_intrn;
356 const MEM_SIZE size = header->size;
358 # ifdef PERL_TRACK_MEMPOOL
359 if (header->interpreter != aTHX) {
360 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
361 header->interpreter, aTHX);
364 Perl_croak_nocontext("panic: duplicate free");
367 Perl_croak_nocontext("panic: bad free, header->next==NULL");
368 if (header->next->prev != header || header->prev->next != header) {
369 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
370 "header=%p, ->prev->next=%p",
371 header->next->prev, header,
374 /* Unlink us from the chain. */
375 maybe_protect_rw(header->next);
376 header->next->prev = header->prev;
377 maybe_protect_ro(header->next);
378 maybe_protect_rw(header->prev);
379 header->prev->next = header->next;
380 maybe_protect_ro(header->prev);
381 maybe_protect_rw(header);
383 PoisonNew(where_intrn, size, char);
385 /* Trigger the duplicate free warning. */
388 # ifdef PERL_DEBUG_READONLY_COW
389 if (munmap(where_intrn, size)) {
390 perror("munmap failed");
396 Malloc_t where_intrn = where;
398 #ifndef PERL_DEBUG_READONLY_COW
399 PerlMem_free(where_intrn);
404 /* safe version of system's calloc() */
407 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
409 #ifdef ALWAYS_NEED_THX
413 #if defined(USE_MDH) || defined(DEBUGGING)
414 MEM_SIZE total_size = 0;
417 /* Even though calloc() for zero bytes is strange, be robust. */
418 if (size && (count <= MEM_SIZE_MAX / size)) {
419 #if defined(USE_MDH) || defined(DEBUGGING)
420 total_size = size * count;
426 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
427 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
432 if ((SSize_t)size < 0 || (SSize_t)count < 0)
433 Perl_croak_nocontext("panic: calloc, size=%" UVuf ", count=%" UVuf,
434 (UV)size, (UV)count);
436 #ifdef PERL_DEBUG_READONLY_COW
437 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
438 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
439 perror("mmap failed");
442 #elif defined(PERL_TRACK_MEMPOOL)
443 /* Have to use malloc() because we've added some space for our tracking
445 /* malloc(0) is non-portable. */
446 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
448 /* Use calloc() because it might save a memset() if the memory is fresh
449 and clean from the OS. */
451 ptr = (Malloc_t)PerlMem_calloc(count, size);
452 else /* calloc(0) is non-portable. */
453 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
455 PERL_ALLOC_CHECK(ptr);
456 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) calloc %zu x %zu = %zu bytes\n",PTR2UV(ptr),(long)PL_an++, count, size, total_size));
460 struct perl_memory_debug_header *const header
461 = (struct perl_memory_debug_header *)ptr;
463 # ifndef PERL_DEBUG_READONLY_COW
464 memset((void*)ptr, 0, total_size);
466 # ifdef PERL_TRACK_MEMPOOL
467 header->interpreter = aTHX;
468 /* Link us into the list. */
469 header->prev = &PL_memory_debug_header;
470 header->next = PL_memory_debug_header.next;
471 PL_memory_debug_header.next = header;
472 maybe_protect_rw(header->next);
473 header->next->prev = header;
474 maybe_protect_ro(header->next);
475 # ifdef PERL_DEBUG_READONLY_COW
476 header->readonly = 0;
480 header->size = total_size;
482 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
488 #ifndef ALWAYS_NEED_THX
497 /* These must be defined when not using Perl's malloc for binary
502 Malloc_t Perl_malloc (MEM_SIZE nbytes)
504 #ifdef PERL_IMPLICIT_SYS
507 return (Malloc_t)PerlMem_malloc(nbytes);
510 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
512 #ifdef PERL_IMPLICIT_SYS
515 return (Malloc_t)PerlMem_calloc(elements, size);
518 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
520 #ifdef PERL_IMPLICIT_SYS
523 return (Malloc_t)PerlMem_realloc(where, nbytes);
526 Free_t Perl_mfree (Malloc_t where)
528 #ifdef PERL_IMPLICIT_SYS
536 /* copy a string up to some (non-backslashed) delimiter, if any.
537 * With allow_escape, converts \<delimiter> to <delimiter>, while leaves
538 * \<non-delimiter> as-is.
539 * Returns the position in the src string of the closing delimiter, if
540 * any, or returns fromend otherwise.
541 * This is the internal implementation for Perl_delimcpy and
542 * Perl_delimcpy_no_escape.
546 S_delimcpy_intern(char *to, const char *toend, const char *from,
547 const char *fromend, int delim, I32 *retlen,
548 const bool allow_escape)
552 PERL_ARGS_ASSERT_DELIMCPY;
554 for (tolen = 0; from < fromend; from++, tolen++) {
555 if (allow_escape && *from == '\\' && from + 1 < fromend) {
556 if (from[1] != delim) {
563 else if (*from == delim)
575 Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
577 PERL_ARGS_ASSERT_DELIMCPY;
579 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 1);
583 Perl_delimcpy_no_escape(char *to, const char *toend, const char *from,
584 const char *fromend, int delim, I32 *retlen)
586 PERL_ARGS_ASSERT_DELIMCPY_NO_ESCAPE;
588 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 0);
592 =head1 Miscellaneous Functions
596 Find the first (leftmost) occurrence of a sequence of bytes within another
597 sequence. This is the Perl version of C<strstr()>, extended to handle
598 arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
599 is what the initial C<n> in the function name stands for; some systems have an
600 equivalent, C<memmem()>, but with a somewhat different API).
602 Another way of thinking about this function is finding a needle in a haystack.
603 C<big> points to the first byte in the haystack. C<big_end> points to one byte
604 beyond the final byte in the haystack. C<little> points to the first byte in
605 the needle. C<little_end> points to one byte beyond the final byte in the
606 needle. All the parameters must be non-C<NULL>.
608 The function returns C<NULL> if there is no occurrence of C<little> within
609 C<big>. If C<little> is the empty string, C<big> is returned.
611 Because this function operates at the byte level, and because of the inherent
612 characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
613 needle and the haystack are strings with the same UTF-8ness, but not if the
621 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
623 PERL_ARGS_ASSERT_NINSTR;
626 return ninstr(big, bigend, little, lend);
632 const char first = *little;
633 bigend -= lend - little++;
635 while (big <= bigend) {
636 if (*big++ == first) {
638 for (x=big,s=little; s < lend; x++,s++) {
642 return (char*)(big-1);
653 =head1 Miscellaneous Functions
657 Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
658 sequence of bytes within another sequence, returning C<NULL> if there is no
666 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
669 const I32 first = *little;
670 const char * const littleend = lend;
672 PERL_ARGS_ASSERT_RNINSTR;
674 if (little >= littleend)
675 return (char*)bigend;
677 big = bigend - (littleend - little++);
678 while (big >= bigbeg) {
682 for (x=big+2,s=little; s < littleend; /**/ ) {
691 return (char*)(big+1);
696 /* As a space optimization, we do not compile tables for strings of length
697 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
698 special-cased in fbm_instr().
700 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
703 =head1 Miscellaneous Functions
705 =for apidoc fbm_compile
707 Analyzes the string in order to make fast searches on it using C<fbm_instr()>
708 -- the Boyer-Moore algorithm.
714 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
721 PERL_DEB( STRLEN rarest = 0 );
723 PERL_ARGS_ASSERT_FBM_COMPILE;
725 if (isGV_with_GP(sv) || SvROK(sv))
731 if (flags & FBMcf_TAIL) {
732 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
733 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
734 if (mg && mg->mg_len >= 0)
737 if (!SvPOK(sv) || SvNIOKp(sv))
738 s = (U8*)SvPV_force_mutable(sv, len);
739 else s = (U8 *)SvPV_mutable(sv, len);
740 if (len == 0) /* TAIL might be on a zero-length string. */
742 SvUPGRADE(sv, SVt_PVMG);
746 /* add PERL_MAGIC_bm magic holding the FBM lookup table */
748 assert(!mg_find(sv, PERL_MAGIC_bm));
749 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
753 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
755 const U8 mlen = (len>255) ? 255 : (U8)len;
756 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
759 Newx(table, 256, U8);
760 memset((void*)table, mlen, 256);
761 mg->mg_ptr = (char *)table;
764 s += len - 1; /* last char */
767 if (table[*s] == mlen)
773 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
774 for (i = 0; i < len; i++) {
775 if (PL_freq[s[i]] < frequency) {
776 PERL_DEB( rarest = i );
777 frequency = PL_freq[s[i]];
780 BmUSEFUL(sv) = 100; /* Initial value */
781 ((XPVNV*)SvANY(sv))->xnv_u.xnv_bm_tail = cBOOL(flags & FBMcf_TAIL);
782 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %" UVuf "\n",
783 s[rarest], (UV)rarest));
788 =for apidoc fbm_instr
790 Returns the location of the SV in the string delimited by C<big> and
791 C<bigend> (C<bigend>) is the char following the last char).
792 It returns C<NULL> if the string can't be found. The C<sv>
793 does not have to be C<fbm_compiled>, but the search will not be as fast
798 If SvTAIL(littlestr) is true, a fake "\n" was appended to to the string
799 during FBM compilation due to FBMcf_TAIL in flags. It indicates that
800 the littlestr must be anchored to the end of bigstr (or to any \n if
803 E.g. The regex compiler would compile /abc/ to a littlestr of "abc",
804 while /abc$/ compiles to "abc\n" with SvTAIL() true.
806 A littlestr of "abc", !SvTAIL matches as /abc/;
807 a littlestr of "ab\n", SvTAIL matches as:
808 without FBMrf_MULTILINE: /ab\n?\z/
809 with FBMrf_MULTILINE: /ab\n/ || /ab\z/;
811 (According to Ilya from 1999; I don't know if this is still true, DAPM 2015):
812 "If SvTAIL is actually due to \Z or \z, this gives false positives
818 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
822 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
823 STRLEN littlelen = l;
824 const I32 multiline = flags & FBMrf_MULTILINE;
825 bool valid = SvVALID(littlestr);
826 bool tail = valid ? cBOOL(SvTAIL(littlestr)) : FALSE;
828 PERL_ARGS_ASSERT_FBM_INSTR;
830 assert(bigend >= big);
832 if ((STRLEN)(bigend - big) < littlelen) {
834 && ((STRLEN)(bigend - big) == littlelen - 1)
836 || (*big == *little &&
837 memEQ((char *)big, (char *)little, littlelen - 1))))
842 switch (littlelen) { /* Special cases for 0, 1 and 2 */
844 return (char*)big; /* Cannot be SvTAIL! */
847 if (tail && !multiline) /* Anchor only! */
848 /* [-1] is safe because we know that bigend != big. */
849 return (char *) (bigend - (bigend[-1] == '\n'));
851 s = (unsigned char *)memchr((void*)big, *little, bigend-big);
855 return (char *) bigend;
859 if (tail && !multiline) {
860 /* a littlestr with SvTAIL must be of the form "X\n" (where X
861 * is a single char). It is anchored, and can only match
862 * "....X\n" or "....X" */
863 if (bigend[-2] == *little && bigend[-1] == '\n')
864 return (char*)bigend - 2;
865 if (bigend[-1] == *little)
866 return (char*)bigend - 1;
871 /* memchr() is likely to be very fast, possibly using whatever
872 * hardware support is available, such as checking a whole
873 * cache line in one instruction.
874 * So for a 2 char pattern, calling memchr() is likely to be
875 * faster than running FBM, or rolling our own. The previous
876 * version of this code was roll-your-own which typically
877 * only needed to read every 2nd char, which was good back in
878 * the day, but no longer.
880 unsigned char c1 = little[0];
881 unsigned char c2 = little[1];
883 /* *** for all this case, bigend points to the last char,
884 * not the trailing \0: this makes the conditions slightly
890 /* do a quick test for c1 before calling memchr();
891 * this avoids the expensive fn call overhead when
892 * there are lots of c1's */
893 if (LIKELY(*s != c1)) {
895 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
902 /* failed; try searching for c2 this time; that way
903 * we don't go pathologically slow when the string
904 * consists mostly of c1's or vice versa.
909 s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
917 /* c1, c2 the same */
927 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
928 if (!s || s >= bigend)
935 /* failed to find 2 chars; try anchored match at end without
937 if (tail && bigend[0] == little[0])
938 return (char *)bigend;
943 break; /* Only lengths 0 1 and 2 have special-case code. */
946 if (tail && !multiline) { /* tail anchored? */
947 s = bigend - littlelen;
948 if (s >= big && bigend[-1] == '\n' && *s == *little
949 /* Automatically of length > 2 */
950 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
952 return (char*)s; /* how sweet it is */
955 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
957 return (char*)s + 1; /* how sweet it is */
963 /* not compiled; use Perl_ninstr() instead */
964 char * const b = ninstr((char*)big,(char*)bigend,
965 (char*)little, (char*)little + littlelen);
967 assert(!tail); /* valid => FBM; tail only set on SvVALID SVs */
972 if (littlelen > (STRLEN)(bigend - big))
976 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
977 const unsigned char *oldlittle;
981 --littlelen; /* Last char found by table lookup */
984 little += littlelen; /* last char */
987 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
988 const unsigned char lastc = *little;
992 if ((tmp = table[*s])) {
993 /* *s != lastc; earliest position it could match now is
994 * tmp slots further on */
995 if ((s += tmp) >= bigend)
997 if (LIKELY(*s != lastc)) {
999 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
1009 /* hand-rolled strncmp(): less expensive than calling the
1010 * real function (maybe???) */
1012 unsigned char * const olds = s;
1017 if (*--s == *--little)
1019 s = olds + 1; /* here we pay the price for failure */
1021 if (s < bigend) /* fake up continue to outer loop */
1031 && memEQ((char *)(bigend - littlelen),
1032 (char *)(oldlittle - littlelen), littlelen) )
1033 return (char*)bigend - littlelen;
1039 Perl_cntrl_to_mnemonic(const U8 c)
1041 /* Returns the mnemonic string that represents character 'c', if one
1042 * exists; NULL otherwise. The only ones that exist for the purposes of
1043 * this routine are a few control characters */
1046 case '\a': return "\\a";
1047 case '\b': return "\\b";
1048 case ESC_NATIVE: return "\\e";
1049 case '\f': return "\\f";
1050 case '\n': return "\\n";
1051 case '\r': return "\\r";
1052 case '\t': return "\\t";
1058 /* copy a string to a safe spot */
1061 =head1 Memory Management
1065 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1066 string which is a duplicate of C<pv>. The size of the string is
1067 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1068 characters and must have a trailing C<NUL>. The memory allocated for the new
1069 string can be freed with the C<Safefree()> function.
1071 On some platforms, Windows for example, all allocated memory owned by a thread
1072 is deallocated when that thread ends. So if you need that not to happen, you
1073 need to use the shared memory functions, such as C<L</savesharedpv>>.
1079 Perl_savepv(pTHX_ const char *pv)
1081 PERL_UNUSED_CONTEXT;
1086 const STRLEN pvlen = strlen(pv)+1;
1087 Newx(newaddr, pvlen, char);
1088 return (char*)memcpy(newaddr, pv, pvlen);
1092 /* same thing but with a known length */
1097 Perl's version of what C<strndup()> would be if it existed. Returns a
1098 pointer to a newly allocated string which is a duplicate of the first
1099 C<len> bytes from C<pv>, plus a trailing
1100 C<NUL> byte. The memory allocated for
1101 the new string can be freed with the C<Safefree()> function.
1103 On some platforms, Windows for example, all allocated memory owned by a thread
1104 is deallocated when that thread ends. So if you need that not to happen, you
1105 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1111 Perl_savepvn(pTHX_ const char *pv, Size_t len)
1114 PERL_UNUSED_CONTEXT;
1116 Newx(newaddr,len+1,char);
1117 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1119 /* might not be null terminated */
1120 newaddr[len] = '\0';
1121 return (char *) CopyD(pv,newaddr,len,char);
1124 return (char *) ZeroD(newaddr,len+1,char);
1129 =for apidoc savesharedpv
1131 A version of C<savepv()> which allocates the duplicate string in memory
1132 which is shared between threads.
1137 Perl_savesharedpv(pTHX_ const char *pv)
1142 PERL_UNUSED_CONTEXT;
1147 pvlen = strlen(pv)+1;
1148 newaddr = (char*)PerlMemShared_malloc(pvlen);
1152 return (char*)memcpy(newaddr, pv, pvlen);
1156 =for apidoc savesharedpvn
1158 A version of C<savepvn()> which allocates the duplicate string in memory
1159 which is shared between threads. (With the specific difference that a C<NULL>
1160 pointer is not acceptable)
1165 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1167 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1169 PERL_UNUSED_CONTEXT;
1170 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1175 newaddr[len] = '\0';
1176 return (char*)memcpy(newaddr, pv, len);
1180 =for apidoc savesvpv
1182 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1183 the passed in SV using C<SvPV()>
1185 On some platforms, Windows for example, all allocated memory owned by a thread
1186 is deallocated when that thread ends. So if you need that not to happen, you
1187 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1193 Perl_savesvpv(pTHX_ SV *sv)
1196 const char * const pv = SvPV_const(sv, len);
1199 PERL_ARGS_ASSERT_SAVESVPV;
1202 Newx(newaddr,len,char);
1203 return (char *) CopyD(pv,newaddr,len,char);
1207 =for apidoc savesharedsvpv
1209 A version of C<savesharedpv()> which allocates the duplicate string in
1210 memory which is shared between threads.
1216 Perl_savesharedsvpv(pTHX_ SV *sv)
1219 const char * const pv = SvPV_const(sv, len);
1221 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1223 return savesharedpvn(pv, len);
1226 /* the SV for Perl_form() and mess() is not kept in an arena */
1234 if (PL_phase != PERL_PHASE_DESTRUCT)
1235 return newSVpvs_flags("", SVs_TEMP);
1240 /* Create as PVMG now, to avoid any upgrading later */
1242 Newxz(any, 1, XPVMG);
1243 SvFLAGS(sv) = SVt_PVMG;
1244 SvANY(sv) = (void*)any;
1246 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1251 #if defined(PERL_IMPLICIT_CONTEXT)
1253 Perl_form_nocontext(const char* pat, ...)
1258 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1259 va_start(args, pat);
1260 retval = vform(pat, &args);
1264 #endif /* PERL_IMPLICIT_CONTEXT */
1267 =head1 Miscellaneous Functions
1270 Takes a sprintf-style format pattern and conventional
1271 (non-SV) arguments and returns the formatted string.
1273 (char *) Perl_form(pTHX_ const char* pat, ...)
1275 can be used any place a string (char *) is required:
1277 char * s = Perl_form("%d.%d",major,minor);
1279 Uses a single private buffer so if you want to format several strings you
1280 must explicitly copy the earlier strings away (and free the copies when you
1287 Perl_form(pTHX_ const char* pat, ...)
1291 PERL_ARGS_ASSERT_FORM;
1292 va_start(args, pat);
1293 retval = vform(pat, &args);
1299 Perl_vform(pTHX_ const char *pat, va_list *args)
1301 SV * const sv = mess_alloc();
1302 PERL_ARGS_ASSERT_VFORM;
1303 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1310 Take a sprintf-style format pattern and argument list. These are used to
1311 generate a string message. If the message does not end with a newline,
1312 then it will be extended with some indication of the current location
1313 in the code, as described for L</mess_sv>.
1315 Normally, the resulting message is returned in a new mortal SV.
1316 During global destruction a single SV may be shared between uses of
1322 #if defined(PERL_IMPLICIT_CONTEXT)
1324 Perl_mess_nocontext(const char *pat, ...)
1329 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1330 va_start(args, pat);
1331 retval = vmess(pat, &args);
1335 #endif /* PERL_IMPLICIT_CONTEXT */
1338 Perl_mess(pTHX_ const char *pat, ...)
1342 PERL_ARGS_ASSERT_MESS;
1343 va_start(args, pat);
1344 retval = vmess(pat, &args);
1350 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1353 /* Look for curop starting from o. cop is the last COP we've seen. */
1354 /* opnext means that curop is actually the ->op_next of the op we are
1357 PERL_ARGS_ASSERT_CLOSEST_COP;
1359 if (!o || !curop || (
1360 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1364 if (o->op_flags & OPf_KIDS) {
1366 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1369 /* If the OP_NEXTSTATE has been optimised away we can still use it
1370 * the get the file and line number. */
1372 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1373 cop = (const COP *)kid;
1375 /* Keep searching, and return when we've found something. */
1377 new_cop = closest_cop(cop, kid, curop, opnext);
1383 /* Nothing found. */
1391 Expands a message, intended for the user, to include an indication of
1392 the current location in the code, if the message does not already appear
1395 C<basemsg> is the initial message or object. If it is a reference, it
1396 will be used as-is and will be the result of this function. Otherwise it
1397 is used as a string, and if it already ends with a newline, it is taken
1398 to be complete, and the result of this function will be the same string.
1399 If the message does not end with a newline, then a segment such as C<at
1400 foo.pl line 37> will be appended, and possibly other clauses indicating
1401 the current state of execution. The resulting message will end with a
1404 Normally, the resulting message is returned in a new mortal SV.
1405 During global destruction a single SV may be shared between uses of this
1406 function. If C<consume> is true, then the function is permitted (but not
1407 required) to modify and return C<basemsg> instead of allocating a new SV.
1413 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1417 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1421 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1422 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1423 && grok_atoUV(ws, &wi, NULL)
1424 && wi <= PERL_INT_MAX
1426 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1431 PERL_ARGS_ASSERT_MESS_SV;
1433 if (SvROK(basemsg)) {
1439 sv_setsv(sv, basemsg);
1444 if (SvPOK(basemsg) && consume) {
1449 sv_copypv(sv, basemsg);
1452 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1454 * Try and find the file and line for PL_op. This will usually be
1455 * PL_curcop, but it might be a cop that has been optimised away. We
1456 * can try to find such a cop by searching through the optree starting
1457 * from the sibling of PL_curcop.
1462 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1467 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1468 OutCopFILE(cop), (IV)CopLINE(cop));
1471 /* Seems that GvIO() can be untrustworthy during global destruction. */
1472 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1473 && IoLINES(GvIOp(PL_last_in_gv)))
1476 const bool line_mode = (RsSIMPLE(PL_rs) &&
1477 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1478 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1479 SVfARG(PL_last_in_gv == PL_argvgv
1481 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1482 line_mode ? "line" : "chunk",
1483 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1485 if (PL_phase == PERL_PHASE_DESTRUCT)
1486 sv_catpvs(sv, " during global destruction");
1487 sv_catpvs(sv, ".\n");
1495 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1496 argument list, respectively. These are used to generate a string message. If
1498 message does not end with a newline, then it will be extended with
1499 some indication of the current location in the code, as described for
1502 Normally, the resulting message is returned in a new mortal SV.
1503 During global destruction a single SV may be shared between uses of
1510 Perl_vmess(pTHX_ const char *pat, va_list *args)
1512 SV * const sv = mess_alloc();
1514 PERL_ARGS_ASSERT_VMESS;
1516 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1517 return mess_sv(sv, 1);
1521 Perl_write_to_stderr(pTHX_ SV* msv)
1526 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1528 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1529 && (io = GvIO(PL_stderrgv))
1530 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1531 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1532 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1534 PerlIO * const serr = Perl_error_log;
1536 do_print(msv, serr);
1537 (void)PerlIO_flush(serr);
1542 =head1 Warning and Dieing
1545 /* Common code used in dieing and warning */
1548 S_with_queued_errors(pTHX_ SV *ex)
1550 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1551 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1552 sv_catsv(PL_errors, ex);
1553 ex = sv_mortalcopy(PL_errors);
1554 SvCUR_set(PL_errors, 0);
1560 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1566 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1567 /* sv_2cv might call Perl_croak() or Perl_warner() */
1568 SV * const oldhook = *hook;
1570 if (!oldhook || oldhook == PERL_WARNHOOK_FATAL)
1576 cv = sv_2cv(oldhook, &stash, &gv, 0);
1578 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1588 exarg = newSVsv(ex);
1589 SvREADONLY_on(exarg);
1592 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1596 call_sv(MUTABLE_SV(cv), G_DISCARD);
1607 Behaves the same as L</croak_sv>, except for the return type.
1608 It should be used only where the C<OP *> return type is required.
1609 The function never actually returns.
1614 /* silence __declspec(noreturn) warnings */
1615 MSVC_DIAG_IGNORE(4646 4645)
1617 Perl_die_sv(pTHX_ SV *baseex)
1619 PERL_ARGS_ASSERT_DIE_SV;
1622 NORETURN_FUNCTION_END;
1629 Behaves the same as L</croak>, except for the return type.
1630 It should be used only where the C<OP *> return type is required.
1631 The function never actually returns.
1636 #if defined(PERL_IMPLICIT_CONTEXT)
1638 /* silence __declspec(noreturn) warnings */
1639 MSVC_DIAG_IGNORE(4646 4645)
1641 Perl_die_nocontext(const char* pat, ...)
1645 va_start(args, pat);
1647 NOT_REACHED; /* NOTREACHED */
1649 NORETURN_FUNCTION_END;
1653 #endif /* PERL_IMPLICIT_CONTEXT */
1655 /* silence __declspec(noreturn) warnings */
1656 MSVC_DIAG_IGNORE(4646 4645)
1658 Perl_die(pTHX_ const char* pat, ...)
1661 va_start(args, pat);
1663 NOT_REACHED; /* NOTREACHED */
1665 NORETURN_FUNCTION_END;
1670 =for apidoc croak_sv
1672 This is an XS interface to Perl's C<die> function.
1674 C<baseex> is the error message or object. If it is a reference, it
1675 will be used as-is. Otherwise it is used as a string, and if it does
1676 not end with a newline then it will be extended with some indication of
1677 the current location in the code, as described for L</mess_sv>.
1679 The error message or object will be used as an exception, by default
1680 returning control to the nearest enclosing C<eval>, but subject to
1681 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1682 function never returns normally.
1684 To die with a simple string message, the L</croak> function may be
1691 Perl_croak_sv(pTHX_ SV *baseex)
1693 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1694 PERL_ARGS_ASSERT_CROAK_SV;
1695 invoke_exception_hook(ex, FALSE);
1702 This is an XS interface to Perl's C<die> function.
1704 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1705 argument list. These are used to generate a string message. If the
1706 message does not end with a newline, then it will be extended with
1707 some indication of the current location in the code, as described for
1710 The error message will be used as an exception, by default
1711 returning control to the nearest enclosing C<eval>, but subject to
1712 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1713 function never returns normally.
1715 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1716 (C<$@>) will be used as an error message or object instead of building an
1717 error message from arguments. If you want to throw a non-string object,
1718 or build an error message in an SV yourself, it is preferable to use
1719 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1725 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1727 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1728 invoke_exception_hook(ex, FALSE);
1735 This is an XS interface to Perl's C<die> function.
1737 Take a sprintf-style format pattern and argument list. These are used to
1738 generate a string message. If the message does not end with a newline,
1739 then it will be extended with some indication of the current location
1740 in the code, as described for L</mess_sv>.
1742 The error message will be used as an exception, by default
1743 returning control to the nearest enclosing C<eval>, but subject to
1744 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1745 function never returns normally.
1747 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1748 (C<$@>) will be used as an error message or object instead of building an
1749 error message from arguments. If you want to throw a non-string object,
1750 or build an error message in an SV yourself, it is preferable to use
1751 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1756 #if defined(PERL_IMPLICIT_CONTEXT)
1758 Perl_croak_nocontext(const char *pat, ...)
1762 va_start(args, pat);
1764 NOT_REACHED; /* NOTREACHED */
1767 #endif /* PERL_IMPLICIT_CONTEXT */
1770 Perl_croak(pTHX_ const char *pat, ...)
1773 va_start(args, pat);
1775 NOT_REACHED; /* NOTREACHED */
1780 =for apidoc croak_no_modify
1782 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1783 terser object code than using C<Perl_croak>. Less code used on exception code
1784 paths reduces CPU cache pressure.
1790 Perl_croak_no_modify(void)
1792 Perl_croak_nocontext( "%s", PL_no_modify);
1795 /* does not return, used in util.c perlio.c and win32.c
1796 This is typically called when malloc returns NULL.
1799 Perl_croak_no_mem(void)
1803 int fd = PerlIO_fileno(Perl_error_log);
1805 SETERRNO(EBADF,RMS_IFI);
1807 /* Can't use PerlIO to write as it allocates memory */
1808 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1813 /* does not return, used only in POPSTACK */
1815 Perl_croak_popstack(void)
1818 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1825 This is an XS interface to Perl's C<warn> function.
1827 C<baseex> is the error message or object. If it is a reference, it
1828 will be used as-is. Otherwise it is used as a string, and if it does
1829 not end with a newline then it will be extended with some indication of
1830 the current location in the code, as described for L</mess_sv>.
1832 The error message or object will by default be written to standard error,
1833 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1835 To warn with a simple string message, the L</warn> function may be
1842 Perl_warn_sv(pTHX_ SV *baseex)
1844 SV *ex = mess_sv(baseex, 0);
1845 PERL_ARGS_ASSERT_WARN_SV;
1846 if (!invoke_exception_hook(ex, TRUE))
1847 write_to_stderr(ex);
1853 This is an XS interface to Perl's C<warn> function.
1855 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1856 argument list. These are used to generate a string message. If the
1857 message does not end with a newline, then it will be extended with
1858 some indication of the current location in the code, as described for
1861 The error message or object will by default be written to standard error,
1862 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1864 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1870 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1872 SV *ex = vmess(pat, args);
1873 PERL_ARGS_ASSERT_VWARN;
1874 if (!invoke_exception_hook(ex, TRUE))
1875 write_to_stderr(ex);
1881 This is an XS interface to Perl's C<warn> function.
1883 Take a sprintf-style format pattern and argument list. These are used to
1884 generate a string message. If the message does not end with a newline,
1885 then it will be extended with some indication of the current location
1886 in the code, as described for L</mess_sv>.
1888 The error message or object will by default be written to standard error,
1889 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1891 Unlike with L</croak>, C<pat> is not permitted to be null.
1896 #if defined(PERL_IMPLICIT_CONTEXT)
1898 Perl_warn_nocontext(const char *pat, ...)
1902 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1903 va_start(args, pat);
1907 #endif /* PERL_IMPLICIT_CONTEXT */
1910 Perl_warn(pTHX_ const char *pat, ...)
1913 PERL_ARGS_ASSERT_WARN;
1914 va_start(args, pat);
1919 #if defined(PERL_IMPLICIT_CONTEXT)
1921 Perl_warner_nocontext(U32 err, const char *pat, ...)
1925 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1926 va_start(args, pat);
1927 vwarner(err, pat, &args);
1930 #endif /* PERL_IMPLICIT_CONTEXT */
1933 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1935 PERL_ARGS_ASSERT_CK_WARNER_D;
1937 if (Perl_ckwarn_d(aTHX_ err)) {
1939 va_start(args, pat);
1940 vwarner(err, pat, &args);
1946 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1948 PERL_ARGS_ASSERT_CK_WARNER;
1950 if (Perl_ckwarn(aTHX_ err)) {
1952 va_start(args, pat);
1953 vwarner(err, pat, &args);
1959 Perl_warner(pTHX_ U32 err, const char* pat,...)
1962 PERL_ARGS_ASSERT_WARNER;
1963 va_start(args, pat);
1964 vwarner(err, pat, &args);
1969 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1972 PERL_ARGS_ASSERT_VWARNER;
1974 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
1975 !(PL_in_eval & EVAL_KEEPERR)
1977 SV * const msv = vmess(pat, args);
1979 if (PL_parser && PL_parser->error_count) {
1983 invoke_exception_hook(msv, FALSE);
1988 Perl_vwarn(aTHX_ pat, args);
1992 /* implements the ckWARN? macros */
1995 Perl_ckwarn(pTHX_ U32 w)
1997 /* If lexical warnings have not been set, use $^W. */
1999 return PL_dowarn & G_WARN_ON;
2001 return ckwarn_common(w);
2004 /* implements the ckWARN?_d macro */
2007 Perl_ckwarn_d(pTHX_ U32 w)
2009 /* If lexical warnings have not been set then default classes warn. */
2013 return ckwarn_common(w);
2017 S_ckwarn_common(pTHX_ U32 w)
2019 if (PL_curcop->cop_warnings == pWARN_ALL)
2022 if (PL_curcop->cop_warnings == pWARN_NONE)
2025 /* Check the assumption that at least the first slot is non-zero. */
2026 assert(unpackWARN1(w));
2028 /* Check the assumption that it is valid to stop as soon as a zero slot is
2030 if (!unpackWARN2(w)) {
2031 assert(!unpackWARN3(w));
2032 assert(!unpackWARN4(w));
2033 } else if (!unpackWARN3(w)) {
2034 assert(!unpackWARN4(w));
2037 /* Right, dealt with all the special cases, which are implemented as non-
2038 pointers, so there is a pointer to a real warnings mask. */
2040 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2042 } while (w >>= WARNshift);
2047 /* Set buffer=NULL to get a new one. */
2049 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2051 const MEM_SIZE len_wanted =
2052 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2053 PERL_UNUSED_CONTEXT;
2054 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2057 (specialWARN(buffer) ?
2058 PerlMemShared_malloc(len_wanted) :
2059 PerlMemShared_realloc(buffer, len_wanted));
2061 Copy(bits, (buffer + 1), size, char);
2062 if (size < WARNsize)
2063 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2067 /* since we've already done strlen() for both nam and val
2068 * we can use that info to make things faster than
2069 * sprintf(s, "%s=%s", nam, val)
2071 #define my_setenv_format(s, nam, nlen, val, vlen) \
2072 Copy(nam, s, nlen, char); \
2074 Copy(val, s+(nlen+1), vlen, char); \
2075 *(s+(nlen+1+vlen)) = '\0'
2079 #ifdef USE_ENVIRON_ARRAY
2080 /* NB: VMS' my_setenv() is in vms.c */
2082 /* Configure doesn't test for HAS_SETENV yet, so decide based on platform.
2083 * For Solaris, setenv() and unsetenv() were introduced in Solaris 9, so
2084 * testing for HAS UNSETENV is sufficient.
2086 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2087 # define MY_HAS_SETENV
2090 /* small wrapper for use by Perl_my_setenv that mallocs, or reallocs if
2091 * 'current' is non-null, with up to three sizes that are added together.
2092 * It handles integer overflow.
2094 # ifndef MY_HAS_SETENV
2096 S_env_alloc(void *current, Size_t l1, Size_t l2, Size_t l3, Size_t size)
2099 Size_t sl, l = l1 + l2;
2111 ? safesysrealloc(current, sl)
2112 : safesysmalloc(sl);
2117 croak_memory_wrap();
2122 # if !defined(WIN32) && !defined(NETWARE)
2125 =for apidoc my_setenv
2127 A wrapper for the C library L<setenv(3)>. Don't use the latter, as the perl
2128 version has desirable safeguards
2134 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2137 # ifdef __amigaos4__
2138 amigaos4_obtain_environ(__FUNCTION__);
2141 # ifdef USE_ITHREADS
2142 /* only parent thread can modify process environment */
2143 if (PL_curinterp == aTHX)
2147 # ifndef PERL_USE_SAFE_PUTENV
2148 if (!PL_use_safe_putenv) {
2149 /* most putenv()s leak, so we manipulate environ directly */
2151 Size_t vlen, nlen = strlen(nam);
2153 /* where does it go? */
2154 for (i = 0; environ[i]; i++) {
2155 if (strnEQ(environ[i], nam, nlen) && environ[i][nlen] == '=')
2159 if (environ == PL_origenviron) { /* need we copy environment? */
2164 while (environ[max])
2167 /* XXX shouldn't that be max+1 rather than max+2 ??? - DAPM */
2168 tmpenv = (char**)S_env_alloc(NULL, max, 2, 0, sizeof(char*));
2170 for (j=0; j<max; j++) { /* copy environment */
2171 const Size_t len = strlen(environ[j]);
2172 tmpenv[j] = S_env_alloc(NULL, len, 1, 0, 1);
2173 Copy(environ[j], tmpenv[j], len+1, char);
2177 environ = tmpenv; /* tell exec where it is now */
2181 safesysfree(environ[i]);
2182 while (environ[i]) {
2183 environ[i] = environ[i+1];
2186 # ifdef __amigaos4__
2193 if (!environ[i]) { /* does not exist yet */
2194 environ = (char**)S_env_alloc(environ, i, 2, 0, sizeof(char*));
2195 environ[i+1] = NULL; /* make sure it's null terminated */
2198 safesysfree(environ[i]);
2202 environ[i] = S_env_alloc(NULL, nlen, vlen, 2, 1);
2203 /* all that work just for this */
2204 my_setenv_format(environ[i], nam, nlen, val, vlen);
2208 # endif /* !PERL_USE_SAFE_PUTENV */
2210 # ifdef MY_HAS_SETENV
2211 # if defined(HAS_UNSETENV)
2213 (void)unsetenv(nam);
2215 (void)setenv(nam, val, 1);
2217 # else /* ! HAS_UNSETENV */
2218 (void)setenv(nam, val, 1);
2219 # endif /* HAS_UNSETENV */
2221 # elif defined(HAS_UNSETENV)
2224 if (environ) /* old glibc can crash with null environ */
2225 (void)unsetenv(nam);
2227 const Size_t nlen = strlen(nam);
2228 const Size_t vlen = strlen(val);
2229 char * const new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2230 my_setenv_format(new_env, nam, nlen, val, vlen);
2231 (void)putenv(new_env);
2234 # else /* ! HAS_UNSETENV */
2237 const Size_t nlen = strlen(nam);
2243 new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2244 /* all that work just for this */
2245 my_setenv_format(new_env, nam, nlen, val, vlen);
2246 (void)putenv(new_env);
2248 # endif /* MY_HAS_SETENV */
2250 # ifndef PERL_USE_SAFE_PUTENV
2255 # ifdef __amigaos4__
2257 amigaos4_release_environ(__FUNCTION__);
2261 # else /* WIN32 || NETWARE */
2264 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2268 const Size_t nlen = strlen(nam);
2275 envstr = S_env_alloc(NULL, nlen, vlen, 2, 1);
2276 my_setenv_format(envstr, nam, nlen, val, vlen);
2277 (void)PerlEnv_putenv(envstr);
2278 safesysfree(envstr);
2281 # endif /* WIN32 || NETWARE */
2283 #endif /* USE_ENVIRON_ARRAY */
2288 #ifdef UNLINK_ALL_VERSIONS
2290 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2294 PERL_ARGS_ASSERT_UNLNK;
2296 while (PerlLIO_unlink(f) >= 0)
2298 return retries ? 0 : -1;
2303 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2305 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2313 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2315 PERL_FLUSHALL_FOR_CHILD;
2316 This = (*mode == 'w');
2320 taint_proper("Insecure %s%s", "EXEC");
2322 if (PerlProc_pipe_cloexec(p) < 0)
2324 /* Try for another pipe pair for error return */
2325 if (PerlProc_pipe_cloexec(pp) >= 0)
2327 while ((pid = PerlProc_fork()) < 0) {
2328 if (errno != EAGAIN) {
2329 PerlLIO_close(p[This]);
2330 PerlLIO_close(p[that]);
2332 PerlLIO_close(pp[0]);
2333 PerlLIO_close(pp[1]);
2337 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2346 /* Close parent's end of error status pipe (if any) */
2348 PerlLIO_close(pp[0]);
2349 /* Now dup our end of _the_ pipe to right position */
2350 if (p[THIS] != (*mode == 'r')) {
2351 PerlLIO_dup2(p[THIS], *mode == 'r');
2352 PerlLIO_close(p[THIS]);
2353 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2354 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2357 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2358 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2360 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2361 /* No automatic close - do it by hand */
2368 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2374 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2381 PerlLIO_close(pp[1]);
2382 /* Keep the lower of the two fd numbers */
2383 if (p[that] < p[This]) {
2384 PerlLIO_dup2_cloexec(p[This], p[that]);
2385 PerlLIO_close(p[This]);
2389 PerlLIO_close(p[that]); /* close child's end of pipe */
2391 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2392 SvUPGRADE(sv,SVt_IV);
2394 PL_forkprocess = pid;
2395 /* If we managed to get status pipe check for exec fail */
2396 if (did_pipes && pid > 0) {
2398 unsigned read_total = 0;
2400 while (read_total < sizeof(int)) {
2401 const SSize_t n1 = PerlLIO_read(pp[0],
2402 (void*)(((char*)&errkid)+read_total),
2403 (sizeof(int)) - read_total);
2408 PerlLIO_close(pp[0]);
2410 if (read_total) { /* Error */
2412 PerlLIO_close(p[This]);
2413 if (read_total != sizeof(int))
2414 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", read_total);
2416 pid2 = wait4pid(pid, &status, 0);
2417 } while (pid2 == -1 && errno == EINTR);
2418 errno = errkid; /* Propagate errno from kid */
2423 PerlLIO_close(pp[0]);
2424 return PerlIO_fdopen(p[This], mode);
2426 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2427 return my_syspopen4(aTHX_ NULL, mode, n, args);
2428 # elif defined(WIN32)
2429 return win32_popenlist(mode, n, args);
2431 Perl_croak(aTHX_ "List form of piped open not implemented");
2432 return (PerlIO *) NULL;
2437 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2438 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2440 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2446 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2450 PERL_ARGS_ASSERT_MY_POPEN;
2452 PERL_FLUSHALL_FOR_CHILD;
2455 return my_syspopen(aTHX_ cmd,mode);
2458 This = (*mode == 'w');
2460 if (doexec && TAINTING_get) {
2462 taint_proper("Insecure %s%s", "EXEC");
2464 if (PerlProc_pipe_cloexec(p) < 0)
2466 if (doexec && PerlProc_pipe_cloexec(pp) >= 0)
2468 while ((pid = PerlProc_fork()) < 0) {
2469 if (errno != EAGAIN) {
2470 PerlLIO_close(p[This]);
2471 PerlLIO_close(p[that]);
2473 PerlLIO_close(pp[0]);
2474 PerlLIO_close(pp[1]);
2477 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2480 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2490 PerlLIO_close(pp[0]);
2491 if (p[THIS] != (*mode == 'r')) {
2492 PerlLIO_dup2(p[THIS], *mode == 'r');
2493 PerlLIO_close(p[THIS]);
2494 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2495 PerlLIO_close(p[THAT]);
2498 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2499 PerlLIO_close(p[THAT]);
2503 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2510 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2515 /* may or may not use the shell */
2516 do_exec3(cmd, pp[1], did_pipes);
2519 #endif /* defined OS2 */
2521 #ifdef PERLIO_USING_CRLF
2522 /* Since we circumvent IO layers when we manipulate low-level
2523 filedescriptors directly, need to manually switch to the
2524 default, binary, low-level mode; see PerlIOBuf_open(). */
2525 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2528 #ifdef PERL_USES_PL_PIDSTATUS
2529 hv_clear(PL_pidstatus); /* we have no children */
2536 PerlLIO_close(pp[1]);
2537 if (p[that] < p[This]) {
2538 PerlLIO_dup2_cloexec(p[This], p[that]);
2539 PerlLIO_close(p[This]);
2543 PerlLIO_close(p[that]);
2545 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2546 SvUPGRADE(sv,SVt_IV);
2548 PL_forkprocess = pid;
2549 if (did_pipes && pid > 0) {
2553 while (n < sizeof(int)) {
2554 const SSize_t n1 = PerlLIO_read(pp[0],
2555 (void*)(((char*)&errkid)+n),
2561 PerlLIO_close(pp[0]);
2563 if (n) { /* Error */
2565 PerlLIO_close(p[This]);
2566 if (n != sizeof(int))
2567 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2569 pid2 = wait4pid(pid, &status, 0);
2570 } while (pid2 == -1 && errno == EINTR);
2571 errno = errkid; /* Propagate errno from kid */
2576 PerlLIO_close(pp[0]);
2577 return PerlIO_fdopen(p[This], mode);
2579 #elif defined(DJGPP)
2580 FILE *djgpp_popen();
2582 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2584 PERL_FLUSHALL_FOR_CHILD;
2585 /* Call system's popen() to get a FILE *, then import it.
2586 used 0 for 2nd parameter to PerlIO_importFILE;
2589 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2591 #elif defined(__LIBCATAMOUNT__)
2593 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2598 #endif /* !DOSISH */
2600 /* this is called in parent before the fork() */
2602 Perl_atfork_lock(void)
2603 #if defined(USE_ITHREADS)
2605 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2608 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2610 PERL_TSA_ACQUIRE(PL_op_mutex)
2613 #if defined(USE_ITHREADS)
2615 /* locks must be held in locking order (if any) */
2617 MUTEX_LOCK(&PL_perlio_mutex);
2620 MUTEX_LOCK(&PL_malloc_mutex);
2626 /* this is called in both parent and child after the fork() */
2628 Perl_atfork_unlock(void)
2629 #if defined(USE_ITHREADS)
2631 PERL_TSA_RELEASE(PL_perlio_mutex)
2634 PERL_TSA_RELEASE(PL_malloc_mutex)
2636 PERL_TSA_RELEASE(PL_op_mutex)
2639 #if defined(USE_ITHREADS)
2641 /* locks must be released in same order as in atfork_lock() */
2643 MUTEX_UNLOCK(&PL_perlio_mutex);
2646 MUTEX_UNLOCK(&PL_malloc_mutex);
2655 #if defined(HAS_FORK)
2657 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2662 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2663 * handlers elsewhere in the code */
2667 #elif defined(__amigaos4__)
2668 return amigaos_fork();
2670 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2671 Perl_croak_nocontext("fork() not available");
2673 #endif /* HAS_FORK */
2678 dup2(int oldfd, int newfd)
2680 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2683 PerlLIO_close(newfd);
2684 return fcntl(oldfd, F_DUPFD, newfd);
2686 #define DUP2_MAX_FDS 256
2687 int fdtmp[DUP2_MAX_FDS];
2693 PerlLIO_close(newfd);
2694 /* good enough for low fd's... */
2695 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2696 if (fdx >= DUP2_MAX_FDS) {
2704 PerlLIO_close(fdtmp[--fdx]);
2711 #ifdef HAS_SIGACTION
2716 A wrapper for the C library L<signal(2)>. Don't use the latter, as the Perl
2717 version knows things that interact with the rest of the perl interpreter.
2723 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2725 struct sigaction act, oact;
2729 /* only "parent" interpreter can diddle signals */
2730 if (PL_curinterp != aTHX)
2731 return (Sighandler_t) SIG_ERR;
2734 act.sa_handler = handler;
2735 sigemptyset(&act.sa_mask);
2738 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2739 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2741 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2742 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2743 act.sa_flags |= SA_NOCLDWAIT;
2745 if (sigaction(signo, &act, &oact) == -1)
2746 return (Sighandler_t) SIG_ERR;
2748 return (Sighandler_t) oact.sa_handler;
2752 Perl_rsignal_state(pTHX_ int signo)
2754 struct sigaction oact;
2755 PERL_UNUSED_CONTEXT;
2757 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2758 return (Sighandler_t) SIG_ERR;
2760 return (Sighandler_t) oact.sa_handler;
2764 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2769 struct sigaction act;
2771 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2774 /* only "parent" interpreter can diddle signals */
2775 if (PL_curinterp != aTHX)
2779 act.sa_handler = handler;
2780 sigemptyset(&act.sa_mask);
2783 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2784 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2786 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2787 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2788 act.sa_flags |= SA_NOCLDWAIT;
2790 return sigaction(signo, &act, save);
2794 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2799 PERL_UNUSED_CONTEXT;
2801 /* only "parent" interpreter can diddle signals */
2802 if (PL_curinterp != aTHX)
2806 return sigaction(signo, save, (struct sigaction *)NULL);
2809 #else /* !HAS_SIGACTION */
2812 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2814 #if defined(USE_ITHREADS) && !defined(WIN32)
2815 /* only "parent" interpreter can diddle signals */
2816 if (PL_curinterp != aTHX)
2817 return (Sighandler_t) SIG_ERR;
2820 return PerlProc_signal(signo, handler);
2831 Perl_rsignal_state(pTHX_ int signo)
2834 Sighandler_t oldsig;
2836 #if defined(USE_ITHREADS) && !defined(WIN32)
2837 /* only "parent" interpreter can diddle signals */
2838 if (PL_curinterp != aTHX)
2839 return (Sighandler_t) SIG_ERR;
2843 oldsig = PerlProc_signal(signo, sig_trap);
2844 PerlProc_signal(signo, oldsig);
2846 PerlProc_kill(PerlProc_getpid(), signo);
2851 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2853 #if defined(USE_ITHREADS) && !defined(WIN32)
2854 /* only "parent" interpreter can diddle signals */
2855 if (PL_curinterp != aTHX)
2858 *save = PerlProc_signal(signo, handler);
2859 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2863 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2865 #if defined(USE_ITHREADS) && !defined(WIN32)
2866 /* only "parent" interpreter can diddle signals */
2867 if (PL_curinterp != aTHX)
2870 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2873 #endif /* !HAS_SIGACTION */
2874 #endif /* !PERL_MICRO */
2876 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2877 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2879 Perl_my_pclose(pTHX_ PerlIO *ptr)
2887 const int fd = PerlIO_fileno(ptr);
2890 svp = av_fetch(PL_fdpid,fd,TRUE);
2891 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2895 #if defined(USE_PERLIO)
2896 /* Find out whether the refcount is low enough for us to wait for the
2897 child proc without blocking. */
2898 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
2900 should_wait = pid > 0;
2904 if (pid == -1) { /* Opened by popen. */
2905 return my_syspclose(ptr);
2908 close_failed = (PerlIO_close(ptr) == EOF);
2910 if (should_wait) do {
2911 pid2 = wait4pid(pid, &status, 0);
2912 } while (pid2 == -1 && errno == EINTR);
2919 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2923 #elif defined(__LIBCATAMOUNT__)
2925 Perl_my_pclose(pTHX_ PerlIO *ptr)
2929 #endif /* !DOSISH */
2931 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2933 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
2936 PERL_ARGS_ASSERT_WAIT4PID;
2937 #ifdef PERL_USES_PL_PIDSTATUS
2939 /* PERL_USES_PL_PIDSTATUS is only defined when neither
2940 waitpid() nor wait4() is available, or on OS/2, which
2941 doesn't appear to support waiting for a progress group
2942 member, so we can only treat a 0 pid as an unknown child.
2949 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
2950 pid, rather than a string form. */
2951 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
2952 if (svp && *svp != &PL_sv_undef) {
2953 *statusp = SvIVX(*svp);
2954 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
2962 hv_iterinit(PL_pidstatus);
2963 if ((entry = hv_iternext(PL_pidstatus))) {
2964 SV * const sv = hv_iterval(PL_pidstatus,entry);
2966 const char * const spid = hv_iterkey(entry,&len);
2968 assert (len == sizeof(Pid_t));
2969 memcpy((char *)&pid, spid, len);
2970 *statusp = SvIVX(sv);
2971 /* The hash iterator is currently on this entry, so simply
2972 calling hv_delete would trigger the lazy delete, which on
2973 aggregate does more work, because next call to hv_iterinit()
2974 would spot the flag, and have to call the delete routine,
2975 while in the meantime any new entries can't re-use that
2977 hv_iterinit(PL_pidstatus);
2978 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
2985 # ifdef HAS_WAITPID_RUNTIME
2986 if (!HAS_WAITPID_RUNTIME)
2989 result = PerlProc_waitpid(pid,statusp,flags);
2992 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
2993 result = wait4(pid,statusp,flags,NULL);
2996 #ifdef PERL_USES_PL_PIDSTATUS
2997 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3002 Perl_croak(aTHX_ "Can't do waitpid with flags");
3004 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3005 pidgone(result,*statusp);
3011 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3014 if (result < 0 && errno == EINTR) {
3016 errno = EINTR; /* reset in case a signal handler changed $! */
3020 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3022 #ifdef PERL_USES_PL_PIDSTATUS
3024 S_pidgone(pTHX_ Pid_t pid, int status)
3028 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3029 SvUPGRADE(sv,SVt_IV);
3030 SvIV_set(sv, status);
3038 int /* Cannot prototype with I32
3040 my_syspclose(PerlIO *ptr)
3043 Perl_my_pclose(pTHX_ PerlIO *ptr)
3046 /* Needs work for PerlIO ! */
3047 FILE * const f = PerlIO_findFILE(ptr);
3048 const I32 result = pclose(f);
3049 PerlIO_releaseFILE(ptr,f);
3057 Perl_my_pclose(pTHX_ PerlIO *ptr)
3059 /* Needs work for PerlIO ! */
3060 FILE * const f = PerlIO_findFILE(ptr);
3061 I32 result = djgpp_pclose(f);
3062 result = (result << 8) & 0xff00;
3063 PerlIO_releaseFILE(ptr,f);
3068 #define PERL_REPEATCPY_LINEAR 4
3070 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3072 PERL_ARGS_ASSERT_REPEATCPY;
3077 croak_memory_wrap();
3080 memset(to, *from, count);
3083 IV items, linear, half;
3085 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3086 for (items = 0; items < linear; ++items) {
3087 const char *q = from;
3089 for (todo = len; todo > 0; todo--)
3094 while (items <= half) {
3095 IV size = items * len;
3096 memcpy(p, to, size);
3102 memcpy(p, to, (count - items) * len);
3108 Perl_same_dirent(pTHX_ const char *a, const char *b)
3110 char *fa = strrchr(a,'/');
3111 char *fb = strrchr(b,'/');
3114 SV * const tmpsv = sv_newmortal();
3116 PERL_ARGS_ASSERT_SAME_DIRENT;
3129 sv_setpvs(tmpsv, ".");
3131 sv_setpvn(tmpsv, a, fa - a);
3132 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3135 sv_setpvs(tmpsv, ".");
3137 sv_setpvn(tmpsv, b, fb - b);
3138 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3140 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3141 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3143 #endif /* !HAS_RENAME */
3146 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3147 const char *const *const search_ext, I32 flags)
3149 const char *xfound = NULL;
3150 char *xfailed = NULL;
3151 char tmpbuf[MAXPATHLEN];
3156 #if defined(DOSISH) && !defined(OS2)
3157 # define SEARCH_EXTS ".bat", ".cmd", NULL
3158 # define MAX_EXT_LEN 4
3161 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3162 # define MAX_EXT_LEN 4
3165 # define SEARCH_EXTS ".pl", ".com", NULL
3166 # define MAX_EXT_LEN 4
3168 /* additional extensions to try in each dir if scriptname not found */
3170 static const char *const exts[] = { SEARCH_EXTS };
3171 const char *const *const ext = search_ext ? search_ext : exts;
3172 int extidx = 0, i = 0;
3173 const char *curext = NULL;
3175 PERL_UNUSED_ARG(search_ext);
3176 # define MAX_EXT_LEN 0
3179 PERL_ARGS_ASSERT_FIND_SCRIPT;
3182 * If dosearch is true and if scriptname does not contain path
3183 * delimiters, search the PATH for scriptname.
3185 * If SEARCH_EXTS is also defined, will look for each
3186 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3187 * while searching the PATH.
3189 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3190 * proceeds as follows:
3191 * If DOSISH or VMSISH:
3192 * + look for ./scriptname{,.foo,.bar}
3193 * + search the PATH for scriptname{,.foo,.bar}
3196 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3197 * this will not look in '.' if it's not in the PATH)
3202 # ifdef ALWAYS_DEFTYPES
3203 len = strlen(scriptname);
3204 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3205 int idx = 0, deftypes = 1;
3208 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3211 int idx = 0, deftypes = 1;
3214 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3216 /* The first time through, just add SEARCH_EXTS to whatever we
3217 * already have, so we can check for default file types. */
3219 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3226 if ((strlen(tmpbuf) + strlen(scriptname)
3227 + MAX_EXT_LEN) >= sizeof tmpbuf)
3228 continue; /* don't search dir with too-long name */
3229 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3233 if (strEQ(scriptname, "-"))
3235 if (dosearch) { /* Look in '.' first. */
3236 const char *cur = scriptname;
3238 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3240 if (strEQ(ext[i++],curext)) {
3241 extidx = -1; /* already has an ext */
3246 DEBUG_p(PerlIO_printf(Perl_debug_log,
3247 "Looking for %s\n",cur));
3250 if (PerlLIO_stat(cur,&statbuf) >= 0
3251 && !S_ISDIR(statbuf.st_mode)) {
3260 if (cur == scriptname) {
3261 len = strlen(scriptname);
3262 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3264 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3267 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3268 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3273 if (dosearch && !strchr(scriptname, '/')
3275 && !strchr(scriptname, '\\')
3277 && (s = PerlEnv_getenv("PATH")))
3281 bufend = s + strlen(s);
3282 while (s < bufend) {
3286 && *s != ';'; len++, s++) {
3287 if (len < sizeof tmpbuf)
3290 if (len < sizeof tmpbuf)
3293 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3298 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3299 continue; /* don't search dir with too-long name */
3302 && tmpbuf[len - 1] != '/'
3303 && tmpbuf[len - 1] != '\\'
3306 tmpbuf[len++] = '/';
3307 if (len == 2 && tmpbuf[0] == '.')
3309 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3313 len = strlen(tmpbuf);
3314 if (extidx > 0) /* reset after previous loop */
3318 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3319 retval = PerlLIO_stat(tmpbuf,&statbuf);
3320 if (S_ISDIR(statbuf.st_mode)) {
3324 } while ( retval < 0 /* not there */
3325 && extidx>=0 && ext[extidx] /* try an extension? */
3326 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3331 if (S_ISREG(statbuf.st_mode)
3332 && cando(S_IRUSR,TRUE,&statbuf)
3333 #if !defined(DOSISH)
3334 && cando(S_IXUSR,TRUE,&statbuf)
3338 xfound = tmpbuf; /* bingo! */
3342 xfailed = savepv(tmpbuf);
3347 if (!xfound && !seen_dot && !xfailed &&
3348 (PerlLIO_stat(scriptname,&statbuf) < 0
3349 || S_ISDIR(statbuf.st_mode)))
3351 seen_dot = 1; /* Disable message. */
3356 if (flags & 1) { /* do or die? */
3357 /* diag_listed_as: Can't execute %s */
3358 Perl_croak(aTHX_ "Can't %s %s%s%s",
3359 (xfailed ? "execute" : "find"),
3360 (xfailed ? xfailed : scriptname),
3361 (xfailed ? "" : " on PATH"),
3362 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3367 scriptname = xfound;
3369 return (scriptname ? savepv(scriptname) : NULL);
3372 #ifndef PERL_GET_CONTEXT_DEFINED
3375 Perl_get_context(void)
3377 #if defined(USE_ITHREADS)
3379 # ifdef OLD_PTHREADS_API
3381 int error = pthread_getspecific(PL_thr_key, &t);
3383 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3385 # elif defined(I_MACH_CTHREADS)
3386 return (void*)cthread_data(cthread_self());
3388 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3396 Perl_set_context(void *t)
3398 #if defined(USE_ITHREADS)
3401 PERL_ARGS_ASSERT_SET_CONTEXT;
3402 #if defined(USE_ITHREADS)
3403 # ifdef I_MACH_CTHREADS
3404 cthread_set_data(cthread_self(), t);
3407 const int error = pthread_setspecific(PL_thr_key, t);
3409 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3417 #endif /* !PERL_GET_CONTEXT_DEFINED */
3419 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3423 PERL_UNUSED_CONTEXT;
3429 Perl_get_op_names(pTHX)
3431 PERL_UNUSED_CONTEXT;
3432 return (char **)PL_op_name;
3436 Perl_get_op_descs(pTHX)
3438 PERL_UNUSED_CONTEXT;
3439 return (char **)PL_op_desc;
3443 Perl_get_no_modify(pTHX)
3445 PERL_UNUSED_CONTEXT;
3446 return PL_no_modify;
3450 Perl_get_opargs(pTHX)
3452 PERL_UNUSED_CONTEXT;
3453 return (U32 *)PL_opargs;
3457 Perl_get_ppaddr(pTHX)
3460 PERL_UNUSED_CONTEXT;
3461 return (PPADDR_t*)PL_ppaddr;
3464 #ifndef HAS_GETENV_LEN
3466 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3468 char * const env_trans = PerlEnv_getenv(env_elem);
3469 PERL_UNUSED_CONTEXT;
3470 PERL_ARGS_ASSERT_GETENV_LEN;
3472 *len = strlen(env_trans);
3479 Perl_get_vtbl(pTHX_ int vtbl_id)
3481 PERL_UNUSED_CONTEXT;
3483 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3484 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3488 Perl_my_fflush_all(pTHX)
3490 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3491 return PerlIO_flush(NULL);
3493 # if defined(HAS__FWALK)
3494 extern int fflush(FILE *);
3495 /* undocumented, unprototyped, but very useful BSDism */
3496 extern void _fwalk(int (*)(FILE *));
3500 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3502 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3503 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3504 # elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3505 open_max = sysconf(_SC_OPEN_MAX);
3506 # elif defined(FOPEN_MAX)
3507 open_max = FOPEN_MAX;
3508 # elif defined(OPEN_MAX)
3509 open_max = OPEN_MAX;
3510 # elif defined(_NFILE)
3515 for (i = 0; i < open_max; i++)
3516 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3517 STDIO_STREAM_ARRAY[i]._file < open_max &&
3518 STDIO_STREAM_ARRAY[i]._flag)
3519 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3523 SETERRNO(EBADF,RMS_IFI);
3530 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3532 if (ckWARN(WARN_IO)) {
3534 = gv && (isGV_with_GP(gv))
3537 const char * const direction = have == '>' ? "out" : "in";
3539 if (name && HEK_LEN(name))
3540 Perl_warner(aTHX_ packWARN(WARN_IO),
3541 "Filehandle %" HEKf " opened only for %sput",
3542 HEKfARG(name), direction);
3544 Perl_warner(aTHX_ packWARN(WARN_IO),
3545 "Filehandle opened only for %sput", direction);
3550 Perl_report_evil_fh(pTHX_ const GV *gv)
3552 const IO *io = gv ? GvIO(gv) : NULL;
3553 const PERL_BITFIELD16 op = PL_op->op_type;
3557 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3559 warn_type = WARN_CLOSED;
3563 warn_type = WARN_UNOPENED;
3566 if (ckWARN(warn_type)) {
3568 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3569 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3570 const char * const pars =
3571 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3572 const char * const func =
3574 (op == OP_READLINE || op == OP_RCATLINE
3575 ? "readline" : /* "<HANDLE>" not nice */
3576 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3578 const char * const type =
3580 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3581 ? "socket" : "filehandle");
3582 const bool have_name = name && SvCUR(name);
3583 Perl_warner(aTHX_ packWARN(warn_type),
3584 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3585 have_name ? " " : "",
3586 SVfARG(have_name ? name : &PL_sv_no));
3587 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3589 aTHX_ packWARN(warn_type),
3590 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3591 func, pars, have_name ? " " : "",
3592 SVfARG(have_name ? name : &PL_sv_no)
3597 /* To workaround core dumps from the uninitialised tm_zone we get the
3598 * system to give us a reasonable struct to copy. This fix means that
3599 * strftime uses the tm_zone and tm_gmtoff values returned by
3600 * localtime(time()). That should give the desired result most of the
3601 * time. But probably not always!
3603 * This does not address tzname aspects of NETaa14816.
3608 # ifndef STRUCT_TM_HASZONE
3609 # define STRUCT_TM_HASZONE
3613 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3614 # ifndef HAS_TM_TM_ZONE
3615 # define HAS_TM_TM_ZONE
3620 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3622 #ifdef HAS_TM_TM_ZONE
3624 const struct tm* my_tm;
3625 PERL_UNUSED_CONTEXT;
3626 PERL_ARGS_ASSERT_INIT_TM;
3628 my_tm = localtime(&now);
3630 Copy(my_tm, ptm, 1, struct tm);
3632 PERL_UNUSED_CONTEXT;
3633 PERL_ARGS_ASSERT_INIT_TM;
3634 PERL_UNUSED_ARG(ptm);
3639 * mini_mktime - normalise struct tm values without the localtime()
3640 * semantics (and overhead) of mktime().
3643 Perl_mini_mktime(struct tm *ptm)
3647 int month, mday, year, jday;
3648 int odd_cent, odd_year;
3650 PERL_ARGS_ASSERT_MINI_MKTIME;
3652 #define DAYS_PER_YEAR 365
3653 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3654 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3655 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3656 #define SECS_PER_HOUR (60*60)
3657 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3658 /* parentheses deliberately absent on these two, otherwise they don't work */
3659 #define MONTH_TO_DAYS 153/5
3660 #define DAYS_TO_MONTH 5/153
3661 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3662 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3663 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3664 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3667 * Year/day algorithm notes:
3669 * With a suitable offset for numeric value of the month, one can find
3670 * an offset into the year by considering months to have 30.6 (153/5) days,
3671 * using integer arithmetic (i.e., with truncation). To avoid too much
3672 * messing about with leap days, we consider January and February to be
3673 * the 13th and 14th month of the previous year. After that transformation,
3674 * we need the month index we use to be high by 1 from 'normal human' usage,
3675 * so the month index values we use run from 4 through 15.
3677 * Given that, and the rules for the Gregorian calendar (leap years are those
3678 * divisible by 4 unless also divisible by 100, when they must be divisible
3679 * by 400 instead), we can simply calculate the number of days since some
3680 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3681 * the days we derive from our month index, and adding in the day of the
3682 * month. The value used here is not adjusted for the actual origin which
3683 * it normally would use (1 January A.D. 1), since we're not exposing it.
3684 * We're only building the value so we can turn around and get the
3685 * normalised values for the year, month, day-of-month, and day-of-year.
3687 * For going backward, we need to bias the value we're using so that we find
3688 * the right year value. (Basically, we don't want the contribution of
3689 * March 1st to the number to apply while deriving the year). Having done
3690 * that, we 'count up' the contribution to the year number by accounting for
3691 * full quadracenturies (400-year periods) with their extra leap days, plus
3692 * the contribution from full centuries (to avoid counting in the lost leap
3693 * days), plus the contribution from full quad-years (to count in the normal
3694 * leap days), plus the leftover contribution from any non-leap years.
3695 * At this point, if we were working with an actual leap day, we'll have 0
3696 * days left over. This is also true for March 1st, however. So, we have
3697 * to special-case that result, and (earlier) keep track of the 'odd'
3698 * century and year contributions. If we got 4 extra centuries in a qcent,
3699 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3700 * Otherwise, we add back in the earlier bias we removed (the 123 from
3701 * figuring in March 1st), find the month index (integer division by 30.6),
3702 * and the remainder is the day-of-month. We then have to convert back to
3703 * 'real' months (including fixing January and February from being 14/15 in
3704 * the previous year to being in the proper year). After that, to get
3705 * tm_yday, we work with the normalised year and get a new yearday value for
3706 * January 1st, which we subtract from the yearday value we had earlier,
3707 * representing the date we've re-built. This is done from January 1
3708 * because tm_yday is 0-origin.
3710 * Since POSIX time routines are only guaranteed to work for times since the
3711 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3712 * applies Gregorian calendar rules even to dates before the 16th century
3713 * doesn't bother me. Besides, you'd need cultural context for a given
3714 * date to know whether it was Julian or Gregorian calendar, and that's
3715 * outside the scope for this routine. Since we convert back based on the
3716 * same rules we used to build the yearday, you'll only get strange results
3717 * for input which needed normalising, or for the 'odd' century years which
3718 * were leap years in the Julian calendar but not in the Gregorian one.
3719 * I can live with that.
3721 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3722 * that's still outside the scope for POSIX time manipulation, so I don't
3728 year = 1900 + ptm->tm_year;
3729 month = ptm->tm_mon;
3730 mday = ptm->tm_mday;
3736 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3737 yearday += month*MONTH_TO_DAYS + mday + jday;
3739 * Note that we don't know when leap-seconds were or will be,
3740 * so we have to trust the user if we get something which looks
3741 * like a sensible leap-second. Wild values for seconds will
3742 * be rationalised, however.
3744 if ((unsigned) ptm->tm_sec <= 60) {
3751 secs += 60 * ptm->tm_min;
3752 secs += SECS_PER_HOUR * ptm->tm_hour;
3754 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3755 /* got negative remainder, but need positive time */
3756 /* back off an extra day to compensate */
3757 yearday += (secs/SECS_PER_DAY)-1;
3758 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3761 yearday += (secs/SECS_PER_DAY);
3762 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3765 else if (secs >= SECS_PER_DAY) {
3766 yearday += (secs/SECS_PER_DAY);
3767 secs %= SECS_PER_DAY;
3769 ptm->tm_hour = secs/SECS_PER_HOUR;
3770 secs %= SECS_PER_HOUR;
3771 ptm->tm_min = secs/60;
3773 ptm->tm_sec += secs;
3774 /* done with time of day effects */
3776 * The algorithm for yearday has (so far) left it high by 428.
3777 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3778 * bias it by 123 while trying to figure out what year it
3779 * really represents. Even with this tweak, the reverse
3780 * translation fails for years before A.D. 0001.
3781 * It would still fail for Feb 29, but we catch that one below.
3783 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3784 yearday -= YEAR_ADJUST;
3785 year = (yearday / DAYS_PER_QCENT) * 400;
3786 yearday %= DAYS_PER_QCENT;
3787 odd_cent = yearday / DAYS_PER_CENT;
3788 year += odd_cent * 100;
3789 yearday %= DAYS_PER_CENT;
3790 year += (yearday / DAYS_PER_QYEAR) * 4;
3791 yearday %= DAYS_PER_QYEAR;
3792 odd_year = yearday / DAYS_PER_YEAR;
3794 yearday %= DAYS_PER_YEAR;
3795 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3800 yearday += YEAR_ADJUST; /* recover March 1st crock */
3801 month = yearday*DAYS_TO_MONTH;
3802 yearday -= month*MONTH_TO_DAYS;
3803 /* recover other leap-year adjustment */
3812 ptm->tm_year = year - 1900;
3814 ptm->tm_mday = yearday;
3815 ptm->tm_mon = month;
3819 ptm->tm_mon = month - 1;
3821 /* re-build yearday based on Jan 1 to get tm_yday */
3823 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3824 yearday += 14*MONTH_TO_DAYS + 1;
3825 ptm->tm_yday = jday - yearday;
3826 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3830 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)
3834 /* strftime(), but with a different API so that the return value is a pointer
3835 * to the formatted result (which MUST be arranged to be FREED BY THE
3836 * CALLER). This allows this function to increase the buffer size as needed,
3837 * so that the caller doesn't have to worry about that.
3839 * Note that yday and wday effectively are ignored by this function, as
3840 * mini_mktime() overwrites them */
3847 PERL_ARGS_ASSERT_MY_STRFTIME;
3849 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3852 mytm.tm_hour = hour;
3853 mytm.tm_mday = mday;
3855 mytm.tm_year = year;
3856 mytm.tm_wday = wday;
3857 mytm.tm_yday = yday;
3858 mytm.tm_isdst = isdst;
3860 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3861 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3866 #ifdef HAS_TM_TM_GMTOFF
3867 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3869 #ifdef HAS_TM_TM_ZONE
3870 mytm.tm_zone = mytm2.tm_zone;
3875 Newx(buf, buflen, char);
3877 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3878 len = strftime(buf, buflen, fmt, &mytm);
3879 GCC_DIAG_RESTORE_STMT;
3882 ** The following is needed to handle to the situation where
3883 ** tmpbuf overflows. Basically we want to allocate a buffer
3884 ** and try repeatedly. The reason why it is so complicated
3885 ** is that getting a return value of 0 from strftime can indicate
3886 ** one of the following:
3887 ** 1. buffer overflowed,
3888 ** 2. illegal conversion specifier, or
3889 ** 3. the format string specifies nothing to be returned(not
3890 ** an error). This could be because format is an empty string
3891 ** or it specifies %p that yields an empty string in some locale.
3892 ** If there is a better way to make it portable, go ahead by
3895 if (inRANGE(len, 1, buflen - 1) || (len == 0 && *fmt == '\0'))
3898 /* Possibly buf overflowed - try again with a bigger buf */
3899 const int fmtlen = strlen(fmt);
3900 int bufsize = fmtlen + buflen;
3902 Renew(buf, bufsize, char);
3905 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3906 buflen = strftime(buf, bufsize, fmt, &mytm);
3907 GCC_DIAG_RESTORE_STMT;
3909 if (inRANGE(buflen, 1, bufsize - 1))
3911 /* heuristic to prevent out-of-memory errors */
3912 if (bufsize > 100*fmtlen) {
3918 Renew(buf, bufsize, char);
3923 Perl_croak(aTHX_ "panic: no strftime");
3929 #define SV_CWD_RETURN_UNDEF \
3933 #define SV_CWD_ISDOT(dp) \
3934 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
3935 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
3938 =head1 Miscellaneous Functions
3940 =for apidoc getcwd_sv
3942 Fill C<sv> with current working directory
3947 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
3948 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
3949 * getcwd(3) if available
3950 * Comments from the original:
3951 * This is a faster version of getcwd. It's also more dangerous
3952 * because you might chdir out of a directory that you can't chdir
3956 Perl_getcwd_sv(pTHX_ SV *sv)
3961 PERL_ARGS_ASSERT_GETCWD_SV;
3965 char buf[MAXPATHLEN];
3967 /* Some getcwd()s automatically allocate a buffer of the given
3968 * size from the heap if they are given a NULL buffer pointer.
3969 * The problem is that this behaviour is not portable. */
3970 if (getcwd(buf, sizeof(buf) - 1)) {
3975 SV_CWD_RETURN_UNDEF;
3982 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
3986 SvUPGRADE(sv, SVt_PV);
3988 if (PerlLIO_lstat(".", &statbuf) < 0) {
3989 SV_CWD_RETURN_UNDEF;
3992 orig_cdev = statbuf.st_dev;
3993 orig_cino = statbuf.st_ino;
4003 if (PerlDir_chdir("..") < 0) {
4004 SV_CWD_RETURN_UNDEF;
4006 if (PerlLIO_stat(".", &statbuf) < 0) {
4007 SV_CWD_RETURN_UNDEF;
4010 cdev = statbuf.st_dev;
4011 cino = statbuf.st_ino;
4013 if (odev == cdev && oino == cino) {
4016 if (!(dir = PerlDir_open("."))) {
4017 SV_CWD_RETURN_UNDEF;
4020 while ((dp = PerlDir_read(dir)) != NULL) {
4022 namelen = dp->d_namlen;
4024 namelen = strlen(dp->d_name);
4027 if (SV_CWD_ISDOT(dp)) {
4031 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4032 SV_CWD_RETURN_UNDEF;
4035 tdev = statbuf.st_dev;
4036 tino = statbuf.st_ino;
4037 if (tino == oino && tdev == odev) {
4043 SV_CWD_RETURN_UNDEF;
4046 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4047 SV_CWD_RETURN_UNDEF;
4050 SvGROW(sv, pathlen + namelen + 1);
4054 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4057 /* prepend current directory to the front */
4059 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4060 pathlen += (namelen + 1);
4062 #ifdef VOID_CLOSEDIR
4065 if (PerlDir_close(dir) < 0) {
4066 SV_CWD_RETURN_UNDEF;
4072 SvCUR_set(sv, pathlen);
4076 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4077 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 (cdev != orig_cdev || cino != orig_cino) {
4088 Perl_croak(aTHX_ "Unstable directory path, "
4089 "current directory changed unexpectedly");
4102 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4103 # define EMULATE_SOCKETPAIR_UDP
4106 #ifdef EMULATE_SOCKETPAIR_UDP
4108 S_socketpair_udp (int fd[2]) {
4110 /* Fake a datagram socketpair using UDP to localhost. */
4111 int sockets[2] = {-1, -1};
4112 struct sockaddr_in addresses[2];
4114 Sock_size_t size = sizeof(struct sockaddr_in);
4115 unsigned short port;
4118 memset(&addresses, 0, sizeof(addresses));
4121 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4122 if (sockets[i] == -1)
4123 goto tidy_up_and_fail;
4125 addresses[i].sin_family = AF_INET;
4126 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4127 addresses[i].sin_port = 0; /* kernel choses port. */
4128 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4129 sizeof(struct sockaddr_in)) == -1)
4130 goto tidy_up_and_fail;
4133 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4134 for each connect the other socket to it. */
4137 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4139 goto tidy_up_and_fail;
4140 if (size != sizeof(struct sockaddr_in))
4141 goto abort_tidy_up_and_fail;
4142 /* !1 is 0, !0 is 1 */
4143 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4144 sizeof(struct sockaddr_in)) == -1)
4145 goto tidy_up_and_fail;
4148 /* Now we have 2 sockets connected to each other. I don't trust some other
4149 process not to have already sent a packet to us (by random) so send
4150 a packet from each to the other. */
4153 /* I'm going to send my own port number. As a short.
4154 (Who knows if someone somewhere has sin_port as a bitfield and needs
4155 this routine. (I'm assuming crays have socketpair)) */
4156 port = addresses[i].sin_port;
4157 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4158 if (got != sizeof(port)) {
4160 goto tidy_up_and_fail;
4161 goto abort_tidy_up_and_fail;
4165 /* Packets sent. I don't trust them to have arrived though.
4166 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4167 connect to localhost will use a second kernel thread. In 2.6 the
4168 first thread running the connect() returns before the second completes,
4169 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4170 returns 0. Poor programs have tripped up. One poor program's authors'
4171 had a 50-1 reverse stock split. Not sure how connected these were.)
4172 So I don't trust someone not to have an unpredictable UDP stack.
4176 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4177 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4181 FD_SET((unsigned int)sockets[0], &rset);
4182 FD_SET((unsigned int)sockets[1], &rset);
4184 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4185 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4186 || !FD_ISSET(sockets[1], &rset)) {
4187 /* I hope this is portable and appropriate. */
4189 goto tidy_up_and_fail;
4190 goto abort_tidy_up_and_fail;
4194 /* And the paranoia department even now doesn't trust it to have arrive
4195 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4197 struct sockaddr_in readfrom;
4198 unsigned short buffer[2];
4203 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4204 sizeof(buffer), MSG_DONTWAIT,
4205 (struct sockaddr *) &readfrom, &size);
4207 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4209 (struct sockaddr *) &readfrom, &size);
4213 goto tidy_up_and_fail;
4214 if (got != sizeof(port)
4215 || size != sizeof(struct sockaddr_in)
4216 /* Check other socket sent us its port. */
4217 || buffer[0] != (unsigned short) addresses[!i].sin_port
4218 /* Check kernel says we got the datagram from that socket */
4219 || readfrom.sin_family != addresses[!i].sin_family
4220 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4221 || readfrom.sin_port != addresses[!i].sin_port)
4222 goto abort_tidy_up_and_fail;
4225 /* My caller (my_socketpair) has validated that this is non-NULL */
4228 /* I hereby declare this connection open. May God bless all who cross
4232 abort_tidy_up_and_fail:
4233 errno = ECONNABORTED;
4237 if (sockets[0] != -1)
4238 PerlLIO_close(sockets[0]);
4239 if (sockets[1] != -1)
4240 PerlLIO_close(sockets[1]);
4245 #endif /* EMULATE_SOCKETPAIR_UDP */
4247 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4249 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4250 /* Stevens says that family must be AF_LOCAL, protocol 0.
4251 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4256 struct sockaddr_in listen_addr;
4257 struct sockaddr_in connect_addr;
4262 || family != AF_UNIX
4265 errno = EAFNOSUPPORT;
4274 type &= ~SOCK_CLOEXEC;
4277 #ifdef EMULATE_SOCKETPAIR_UDP
4278 if (type == SOCK_DGRAM)
4279 return S_socketpair_udp(fd);
4282 aTHXa(PERL_GET_THX);
4283 listener = PerlSock_socket(AF_INET, type, 0);
4286 memset(&listen_addr, 0, sizeof(listen_addr));
4287 listen_addr.sin_family = AF_INET;
4288 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4289 listen_addr.sin_port = 0; /* kernel choses port. */
4290 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4291 sizeof(listen_addr)) == -1)
4292 goto tidy_up_and_fail;
4293 if (PerlSock_listen(listener, 1) == -1)
4294 goto tidy_up_and_fail;
4296 connector = PerlSock_socket(AF_INET, type, 0);
4297 if (connector == -1)
4298 goto tidy_up_and_fail;
4299 /* We want to find out the port number to connect to. */
4300 size = sizeof(connect_addr);
4301 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4303 goto tidy_up_and_fail;
4304 if (size != sizeof(connect_addr))
4305 goto abort_tidy_up_and_fail;
4306 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4307 sizeof(connect_addr)) == -1)
4308 goto tidy_up_and_fail;
4310 size = sizeof(listen_addr);
4311 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4314 goto tidy_up_and_fail;
4315 if (size != sizeof(listen_addr))
4316 goto abort_tidy_up_and_fail;
4317 PerlLIO_close(listener);
4318 /* Now check we are talking to ourself by matching port and host on the
4320 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4322 goto tidy_up_and_fail;
4323 if (size != sizeof(connect_addr)
4324 || listen_addr.sin_family != connect_addr.sin_family
4325 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4326 || listen_addr.sin_port != connect_addr.sin_port) {
4327 goto abort_tidy_up_and_fail;
4333 abort_tidy_up_and_fail:
4335 errno = ECONNABORTED; /* This would be the standard thing to do. */
4336 #elif defined(ECONNREFUSED)
4337 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4339 errno = ETIMEDOUT; /* Desperation time. */
4345 PerlLIO_close(listener);
4346 if (connector != -1)
4347 PerlLIO_close(connector);
4349 PerlLIO_close(acceptor);
4355 /* In any case have a stub so that there's code corresponding
4356 * to the my_socketpair in embed.fnc. */
4358 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4359 #ifdef HAS_SOCKETPAIR
4360 return socketpair(family, type, protocol, fd);
4369 =for apidoc sv_nosharing
4371 Dummy routine which "shares" an SV when there is no sharing module present.
4372 Or "locks" it. Or "unlocks" it. In other
4373 words, ignores its single SV argument.
4374 Exists to avoid test for a C<NULL> function pointer and because it could
4375 potentially warn under some level of strict-ness.
4381 Perl_sv_nosharing(pTHX_ SV *sv)
4383 PERL_UNUSED_CONTEXT;
4384 PERL_UNUSED_ARG(sv);
4389 =for apidoc sv_destroyable
4391 Dummy routine which reports that object can be destroyed when there is no
4392 sharing module present. It ignores its single SV argument, and returns
4393 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4394 could potentially warn under some level of strict-ness.
4400 Perl_sv_destroyable(pTHX_ SV *sv)
4402 PERL_UNUSED_CONTEXT;
4403 PERL_UNUSED_ARG(sv);
4408 Perl_parse_unicode_opts(pTHX_ const char **popt)
4410 const char *p = *popt;
4413 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4417 const char* endptr = p + strlen(p);
4419 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4422 if (p && *p && *p != '\n' && *p != '\r') {
4424 goto the_end_of_the_opts_parser;
4426 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4430 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4436 case PERL_UNICODE_STDIN:
4437 opt |= PERL_UNICODE_STDIN_FLAG; break;
4438 case PERL_UNICODE_STDOUT:
4439 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4440 case PERL_UNICODE_STDERR:
4441 opt |= PERL_UNICODE_STDERR_FLAG; break;
4442 case PERL_UNICODE_STD:
4443 opt |= PERL_UNICODE_STD_FLAG; break;
4444 case PERL_UNICODE_IN:
4445 opt |= PERL_UNICODE_IN_FLAG; break;
4446 case PERL_UNICODE_OUT:
4447 opt |= PERL_UNICODE_OUT_FLAG; break;
4448 case PERL_UNICODE_INOUT:
4449 opt |= PERL_UNICODE_INOUT_FLAG; break;
4450 case PERL_UNICODE_LOCALE:
4451 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4452 case PERL_UNICODE_ARGV:
4453 opt |= PERL_UNICODE_ARGV_FLAG; break;
4454 case PERL_UNICODE_UTF8CACHEASSERT:
4455 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4457 if (*p != '\n' && *p != '\r') {
4458 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4461 "Unknown Unicode option letter '%c'", *p);
4468 opt = PERL_UNICODE_DEFAULT_FLAGS;
4470 the_end_of_the_opts_parser:
4472 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4473 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4474 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4482 # include <starlet.h>
4489 * This is really just a quick hack which grabs various garbage
4490 * values. It really should be a real hash algorithm which
4491 * spreads the effect of every input bit onto every output bit,
4492 * if someone who knows about such things would bother to write it.
4493 * Might be a good idea to add that function to CORE as well.
4494 * No numbers below come from careful analysis or anything here,
4495 * except they are primes and SEED_C1 > 1E6 to get a full-width
4496 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4497 * probably be bigger too.
4500 # define SEED_C1 1000003
4501 #define SEED_C4 73819
4503 # define SEED_C1 25747
4504 #define SEED_C4 20639
4508 #define SEED_C5 26107
4510 #ifndef PERL_NO_DEV_RANDOM
4514 #ifdef HAS_GETTIMEOFDAY
4515 struct timeval when;
4520 /* This test is an escape hatch, this symbol isn't set by Configure. */
4521 #ifndef PERL_NO_DEV_RANDOM
4522 #ifndef PERL_RANDOM_DEVICE
4523 /* /dev/random isn't used by default because reads from it will block
4524 * if there isn't enough entropy available. You can compile with
4525 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4526 * is enough real entropy to fill the seed. */
4527 # ifdef __amigaos4__
4528 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4530 # define PERL_RANDOM_DEVICE "/dev/urandom"
4533 fd = PerlLIO_open_cloexec(PERL_RANDOM_DEVICE, 0);
4535 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4543 #ifdef HAS_GETTIMEOFDAY
4544 PerlProc_gettimeofday(&when,NULL);
4545 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4548 u = (U32)SEED_C1 * when;
4550 u += SEED_C3 * (U32)PerlProc_getpid();
4551 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4552 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4553 u += SEED_C5 * (U32)PTR2UV(&when);
4559 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4561 #ifndef NO_PERL_HASH_ENV
4566 PERL_ARGS_ASSERT_GET_HASH_SEED;
4568 #ifndef NO_PERL_HASH_ENV
4569 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4573 /* ignore leading spaces */
4574 while (isSPACE(*env_pv))
4576 # ifdef USE_PERL_PERTURB_KEYS
4577 /* if they set it to "0" we disable key traversal randomization completely */
4578 if (strEQ(env_pv,"0")) {
4579 PL_hash_rand_bits_enabled= 0;
4581 /* otherwise switch to deterministic mode */
4582 PL_hash_rand_bits_enabled= 2;
4585 /* ignore a leading 0x... if it is there */
4586 if (env_pv[0] == '0' && env_pv[1] == 'x')
4589 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4590 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4591 if ( isXDIGIT(*env_pv)) {
4592 seed_buffer[i] |= READ_XDIGIT(env_pv);
4595 while (isSPACE(*env_pv))
4598 if (*env_pv && !isXDIGIT(*env_pv)) {
4599 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4601 /* should we check for unparsed crap? */
4602 /* should we warn about unused hex? */
4603 /* should we warn about insufficient hex? */
4606 #endif /* NO_PERL_HASH_ENV */
4608 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4609 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
4612 #ifdef USE_PERL_PERTURB_KEYS
4613 { /* initialize PL_hash_rand_bits from the hash seed.
4614 * This value is highly volatile, it is updated every
4615 * hash insert, and is used as part of hash bucket chain
4616 * randomization and hash iterator randomization. */
4617 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4618 for( i = 0; i < sizeof(UV) ; i++ ) {
4619 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4620 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4623 # ifndef NO_PERL_HASH_ENV
4624 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4626 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4627 PL_hash_rand_bits_enabled= 0;
4628 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4629 PL_hash_rand_bits_enabled= 1;
4630 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4631 PL_hash_rand_bits_enabled= 2;
4633 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4640 #ifdef PERL_GLOBAL_STRUCT
4642 #define PERL_GLOBAL_STRUCT_INIT
4643 #include "opcode.h" /* the ppaddr and check */
4646 Perl_init_global_struct(pTHX)
4648 struct perl_vars *plvarsp = NULL;
4649 # ifdef PERL_GLOBAL_STRUCT
4650 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4651 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4652 PERL_UNUSED_CONTEXT;
4653 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4654 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4655 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4659 plvarsp = PL_VarsPtr;
4660 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4665 # define PERLVAR(prefix,var,type) /**/
4666 # define PERLVARA(prefix,var,n,type) /**/
4667 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4668 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4669 # include "perlvars.h"
4674 # ifdef PERL_GLOBAL_STRUCT
4677 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4678 if (!plvarsp->Gppaddr)
4682 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4683 if (!plvarsp->Gcheck)
4685 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4686 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4688 # ifdef PERL_SET_VARS
4689 PERL_SET_VARS(plvarsp);
4691 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4692 plvarsp->Gsv_placeholder.sv_flags = 0;
4693 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4695 # undef PERL_GLOBAL_STRUCT_INIT
4700 #endif /* PERL_GLOBAL_STRUCT */
4702 #ifdef PERL_GLOBAL_STRUCT
4705 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4707 int veto = plvarsp->Gveto_cleanup;
4709 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4710 PERL_UNUSED_CONTEXT;
4711 # ifdef PERL_GLOBAL_STRUCT
4712 # ifdef PERL_UNSET_VARS
4713 PERL_UNSET_VARS(plvarsp);
4717 free(plvarsp->Gppaddr);
4718 free(plvarsp->Gcheck);
4719 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4725 #endif /* PERL_GLOBAL_STRUCT */
4729 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4730 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4731 * given, and you supply your own implementation.
4733 * The default implementation reads a single env var, PERL_MEM_LOG,
4734 * expecting one or more of the following:
4736 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4737 * 'm' - memlog was PERL_MEM_LOG=1
4738 * 's' - svlog was PERL_SV_LOG=1
4739 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4741 * This makes the logger controllable enough that it can reasonably be
4742 * added to the system perl.
4745 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4746 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4748 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4750 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4751 * writes to. In the default logger, this is settable at runtime.
4753 #ifndef PERL_MEM_LOG_FD
4754 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4757 #ifndef PERL_MEM_LOG_NOIMPL
4759 # ifdef DEBUG_LEAKING_SCALARS
4760 # define SV_LOG_SERIAL_FMT " [%lu]"
4761 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4763 # define SV_LOG_SERIAL_FMT
4764 # define _SV_LOG_SERIAL_ARG(sv)
4768 S_mem_log_common(enum mem_log_type mlt, const UV n,
4769 const UV typesize, const char *type_name, const SV *sv,
4770 Malloc_t oldalloc, Malloc_t newalloc,
4771 const char *filename, const int linenumber,
4772 const char *funcname)
4776 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4778 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4781 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4783 /* We can't use SVs or PerlIO for obvious reasons,
4784 * so we'll use stdio and low-level IO instead. */
4785 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4787 # ifdef HAS_GETTIMEOFDAY
4788 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4789 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4791 gettimeofday(&tv, 0);
4793 # define MEM_LOG_TIME_FMT "%10d: "
4794 # define MEM_LOG_TIME_ARG (int)when
4798 /* If there are other OS specific ways of hires time than
4799 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4800 * probably that they would be used to fill in the struct
4804 const char* endptr = pmlenv + strlen(pmlenv);
4807 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4808 && uv && uv <= PERL_INT_MAX
4812 fd = PERL_MEM_LOG_FD;
4815 if (strchr(pmlenv, 't')) {
4816 len = my_snprintf(buf, sizeof(buf),
4817 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4818 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4822 len = my_snprintf(buf, sizeof(buf),
4823 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4824 " %s = %" IVdf ": %" UVxf "\n",
4825 filename, linenumber, funcname, n, typesize,
4826 type_name, n * typesize, PTR2UV(newalloc));
4829 len = my_snprintf(buf, sizeof(buf),
4830 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4831 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4832 filename, linenumber, funcname, n, typesize,
4833 type_name, n * typesize, PTR2UV(oldalloc),
4837 len = my_snprintf(buf, sizeof(buf),
4838 "free: %s:%d:%s: %" UVxf "\n",
4839 filename, linenumber, funcname,
4844 len = my_snprintf(buf, sizeof(buf),
4845 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
4846 mlt == MLT_NEW_SV ? "new" : "del",
4847 filename, linenumber, funcname,
4848 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4853 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4857 #endif /* !PERL_MEM_LOG_NOIMPL */
4859 #ifndef PERL_MEM_LOG_NOIMPL
4861 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4862 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4864 /* this is suboptimal, but bug compatible. User is providing their
4865 own implementation, but is getting these functions anyway, and they
4866 do nothing. But _NOIMPL users should be able to cope or fix */
4868 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4869 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
4873 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4875 const char *filename, const int linenumber,
4876 const char *funcname)
4878 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
4880 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4881 NULL, NULL, newalloc,
4882 filename, linenumber, funcname);
4887 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4888 Malloc_t oldalloc, Malloc_t newalloc,
4889 const char *filename, const int linenumber,
4890 const char *funcname)
4892 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
4894 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4895 NULL, oldalloc, newalloc,
4896 filename, linenumber, funcname);
4901 Perl_mem_log_free(Malloc_t oldalloc,
4902 const char *filename, const int linenumber,
4903 const char *funcname)
4905 PERL_ARGS_ASSERT_MEM_LOG_FREE;
4907 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4908 filename, linenumber, funcname);
4913 Perl_mem_log_new_sv(const SV *sv,
4914 const char *filename, const int linenumber,
4915 const char *funcname)
4917 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4918 filename, linenumber, funcname);
4922 Perl_mem_log_del_sv(const SV *sv,
4923 const char *filename, const int linenumber,
4924 const char *funcname)
4926 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4927 filename, linenumber, funcname);
4930 #endif /* PERL_MEM_LOG */
4933 =for apidoc quadmath_format_valid
4935 C<quadmath_snprintf()> is very strict about its C<format> string and will
4936 fail, returning -1, if the format is invalid. It accepts exactly
4939 C<quadmath_format_valid()> checks that the intended single spec looks
4940 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
4941 and has C<Q> before it. This is not a full "printf syntax check",
4944 Returns true if it is valid, false if not.
4946 See also L</quadmath_format_needed>.
4952 Perl_quadmath_format_valid(const char* format)
4956 PERL_ARGS_ASSERT_QUADMATH_FORMAT_VALID;
4958 if (format[0] != '%' || strchr(format + 1, '%'))
4960 len = strlen(format);
4961 /* minimum length three: %Qg */
4962 if (len < 3 || memCHRs("efgaEFGA", format[len - 1]) == NULL)
4964 if (format[len - 2] != 'Q')
4971 =for apidoc quadmath_format_needed
4973 C<quadmath_format_needed()> returns true if the C<format> string seems to
4974 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
4975 or returns false otherwise.
4977 The format specifier detection is not complete printf-syntax detection,
4978 but it should catch most common cases.
4980 If true is returned, those arguments B<should> in theory be processed
4981 with C<quadmath_snprintf()>, but in case there is more than one such
4982 format specifier (see L</quadmath_format_valid>), and if there is
4983 anything else beyond that one (even just a single byte), they
4984 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
4985 accepting only one format spec, and nothing else.
4986 In this case, the code should probably fail.
4992 Perl_quadmath_format_needed(const char* format)
4994 const char *p = format;
4997 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
4999 while ((q = strchr(p, '%'))) {
5001 if (*q == '+') /* plus */
5003 if (*q == '#') /* alt */
5005 if (*q == '*') /* width */
5009 while (isDIGIT(*q)) q++;
5012 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5017 while (isDIGIT(*q)) q++;
5019 if (memCHRs("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5028 =for apidoc my_snprintf
5030 The C library C<snprintf> functionality, if available and
5031 standards-compliant (uses C<vsnprintf>, actually). However, if the
5032 C<vsnprintf> is not available, will unfortunately use the unsafe
5033 C<vsprintf> which can overrun the buffer (there is an overrun check,
5034 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5035 getting C<vsnprintf>.
5040 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5044 PERL_ARGS_ASSERT_MY_SNPRINTF;
5045 #ifndef HAS_VSNPRINTF
5046 PERL_UNUSED_VAR(len);
5048 va_start(ap, format);
5051 bool quadmath_valid = FALSE;
5052 if (quadmath_format_valid(format)) {
5053 /* If the format looked promising, use it as quadmath. */
5054 retval = quadmath_snprintf(buffer, len, format, va_arg(ap, NV));
5056 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5058 quadmath_valid = TRUE;
5060 /* quadmath_format_single() will return false for example for
5061 * "foo = %g", or simply "%g". We could handle the %g by
5062 * using quadmath for the NV args. More complex cases of
5063 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5064 * quadmath-valid but has stuff in front).
5066 * Handling the "Q-less" cases right would require walking
5067 * through the va_list and rewriting the format, calling
5068 * quadmath for the NVs, building a new va_list, and then
5069 * letting vsnprintf/vsprintf to take care of the other
5070 * arguments. This may be doable.
5072 * We do not attempt that now. But for paranoia, we here try
5073 * to detect some common (but not all) cases where the
5074 * "Q-less" %[efgaEFGA] formats are present, and die if
5075 * detected. This doesn't fix the problem, but it stops the
5076 * vsnprintf/vsprintf pulling doubles off the va_list when
5077 * __float128 NVs should be pulled off instead.
5079 * If quadmath_format_needed() returns false, we are reasonably
5080 * certain that we can call vnsprintf() or vsprintf() safely. */
5081 if (!quadmath_valid && quadmath_format_needed(format))
5082 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5087 #ifdef HAS_VSNPRINTF
5088 retval = vsnprintf(buffer, len, format, ap);
5090 retval = vsprintf(buffer, format, ap);
5093 /* vsprintf() shows failure with < 0 */
5095 #ifdef HAS_VSNPRINTF
5096 /* vsnprintf() shows failure with >= len */
5098 (len > 0 && (Size_t)retval >= len)
5101 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5106 =for apidoc my_vsnprintf
5108 The C library C<vsnprintf> if available and standards-compliant.
5109 However, if if the C<vsnprintf> is not available, will unfortunately
5110 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5111 overrun check, but that may be too late). Consider using
5112 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5117 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5120 PERL_UNUSED_ARG(buffer);
5121 PERL_UNUSED_ARG(len);
5122 PERL_UNUSED_ARG(format);
5123 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5124 PERL_UNUSED_ARG((void*)ap);
5125 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5132 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5133 Perl_va_copy(ap, apc);
5134 # ifdef HAS_VSNPRINTF
5135 retval = vsnprintf(buffer, len, format, apc);
5137 PERL_UNUSED_ARG(len);
5138 retval = vsprintf(buffer, format, apc);
5142 # ifdef HAS_VSNPRINTF
5143 retval = vsnprintf(buffer, len, format, ap);
5145 PERL_UNUSED_ARG(len);
5146 retval = vsprintf(buffer, format, ap);
5148 #endif /* #ifdef NEED_VA_COPY */
5149 /* vsprintf() shows failure with < 0 */
5151 #ifdef HAS_VSNPRINTF
5152 /* vsnprintf() shows failure with >= len */
5154 (len > 0 && (Size_t)retval >= len)
5157 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5163 Perl_my_clearenv(pTHX)
5166 #if ! defined(PERL_MICRO)
5167 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5169 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5170 # if defined(USE_ENVIRON_ARRAY)
5171 # if defined(USE_ITHREADS)
5172 /* only the parent thread can clobber the process environment */
5173 if (PL_curinterp == aTHX)
5174 # endif /* USE_ITHREADS */
5176 # if ! defined(PERL_USE_SAFE_PUTENV)
5177 if ( !PL_use_safe_putenv) {
5179 if (environ == PL_origenviron)
5180 environ = (char**)safesysmalloc(sizeof(char*));
5182 for (i = 0; environ[i]; i++)
5183 (void)safesysfree(environ[i]);
5186 # else /* PERL_USE_SAFE_PUTENV */
5187 # if defined(HAS_CLEARENV)
5189 # elif defined(HAS_UNSETENV)
5190 int bsiz = 80; /* Most envvar names will be shorter than this. */
5191 char *buf = (char*)safesysmalloc(bsiz);
5192 while (*environ != NULL) {
5193 char *e = strchr(*environ, '=');
5194 int l = e ? e - *environ : (int)strlen(*environ);
5196 (void)safesysfree(buf);
5197 bsiz = l + 1; /* + 1 for the \0. */
5198 buf = (char*)safesysmalloc(bsiz);
5200 memcpy(buf, *environ, l);
5202 (void)unsetenv(buf);
5204 (void)safesysfree(buf);
5205 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5206 /* Just null environ and accept the leakage. */
5208 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5209 # endif /* ! PERL_USE_SAFE_PUTENV */
5211 # endif /* USE_ENVIRON_ARRAY */
5212 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5213 #endif /* PERL_MICRO */
5216 #ifdef PERL_IMPLICIT_CONTEXT
5219 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5221 /* rather than each module having a static var holding its index,
5222 * use a global array of name to index mappings
5225 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5230 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5232 for (index = 0; index < PL_my_cxt_index; index++) {
5233 const char *key = PL_my_cxt_keys[index];
5234 /* try direct pointer compare first - there are chances to success,
5235 * and it's much faster.
5237 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5245 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5246 the global PL_my_cxt_index is incremented, and that value is assigned to
5247 that module's static my_cxt_index (who's address is passed as an arg).
5248 Then, for each interpreter this function is called for, it makes sure a
5249 void* slot is available to hang the static data off, by allocating or
5250 extending the interpreter's PL_my_cxt_list array */
5253 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5254 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5256 Perl_my_cxt_init(pTHX_ int *indexp, size_t size)
5263 PERL_ARGS_ASSERT_MY_CXT_INIT;
5265 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5266 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5270 /* do initial check without locking.
5271 * -1: not allocated or another thread currently allocating
5272 * other: already allocated by another thread
5275 MUTEX_LOCK(&PL_my_ctx_mutex);
5276 /*now a stricter check with locking */
5277 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5278 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5283 /* this module hasn't been allocated an index yet */
5284 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5285 index = PL_my_cxt_index++;
5287 /* Store the index in a global MY_CXT_KEY string to index mapping
5288 * table. This emulates the perl-module static my_cxt_index var on
5289 * builds which don't allow static vars */
5290 if (PL_my_cxt_keys_size <= index) {
5291 int old_size = PL_my_cxt_keys_size;
5293 if (PL_my_cxt_keys_size) {
5294 IV new_size = PL_my_cxt_keys_size;
5295 while (new_size <= index)
5297 PL_my_cxt_keys = (const char **)PerlMemShared_realloc(
5299 new_size * sizeof(const char *));
5300 PL_my_cxt_keys_size = new_size;
5303 PL_my_cxt_keys_size = 16;
5304 PL_my_cxt_keys = (const char **)PerlMemShared_malloc(
5305 PL_my_cxt_keys_size * sizeof(const char *));
5307 for (i = old_size; i < PL_my_cxt_keys_size; i++) {
5308 PL_my_cxt_keys[i] = 0;
5311 PL_my_cxt_keys[index] = my_cxt_key;
5313 *indexp = PL_my_cxt_index++;
5316 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5319 /* make sure the array is big enough */
5320 if (PL_my_cxt_size <= index) {
5321 if (PL_my_cxt_size) {
5322 IV new_size = PL_my_cxt_size;
5323 while (new_size <= index)
5325 Renew(PL_my_cxt_list, new_size, void *);
5326 PL_my_cxt_size = new_size;
5329 PL_my_cxt_size = 16;
5330 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5333 /* newSV() allocates one more than needed */
5334 p = (void*)SvPVX(newSV(size-1));
5335 PL_my_cxt_list[index] = p;
5336 Zero(p, size, char);
5340 #endif /* PERL_IMPLICIT_CONTEXT */
5343 /* Perl_xs_handshake():
5344 implement the various XS_*_BOOTCHECK macros, which are added to .c
5345 files by ExtUtils::ParseXS, to check that the perl the module was built
5346 with is binary compatible with the running perl.
5349 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5350 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5352 The meaning of the varargs is determined the U32 key arg (which is not
5353 a format string). The fields of key are assembled by using HS_KEY().
5355 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5356 "PerlInterpreter *" and represents the callers context; otherwise it is
5357 of type "CV *", and is the boot xsub's CV.
5359 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5360 for example, and IO.dll was linked with threaded perl524.dll, and both
5361 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5362 successfully can load IO.dll into the process but simultaneously it
5363 loaded an interpreter of a different version into the process, and XS
5364 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5365 use through perl526.dll's my_perl->Istack_base.
5367 v_my_perl cannot be the first arg, since then 'key' will be out of
5368 place in a threaded vs non-threaded mixup; and analyzing the key
5369 number's bitfields won't reveal the problem, since it will be a valid
5370 key (unthreaded perl) on interp side, but croak will report the XS mod's
5371 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5372 it's a threaded perl and an unthreaded XS module, threaded perl will
5373 look at an uninit C stack or an uninit register to get 'key'
5374 (remember that it assumes that the 1st arg is the interp cxt).
5376 'file' is the source filename of the caller.
5380 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5386 #ifdef PERL_IMPLICIT_CONTEXT
5393 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5394 va_start(args, file);
5396 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5397 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5398 if (UNLIKELY(got != need))
5400 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5401 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5402 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5403 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5404 passed to the XS DLL */
5405 #ifdef PERL_IMPLICIT_CONTEXT
5406 xs_interp = (tTHX)v_my_perl;
5410 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5411 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5412 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5413 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5414 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5415 location in the unthreaded perl binary) stored in CV * to figure out if this
5416 Perl_xs_handshake was called by the same pp_entersub */
5417 cv = (CV*)v_my_perl;
5418 xs_spp = (SV***)CvHSCXT(cv);
5420 need = &PL_stack_sp;
5422 if(UNLIKELY(got != need)) {
5423 bad_handshake:/* recycle branch and string from above */
5424 if(got != (void *)HSf_NOCHK)
5425 noperl_die("%s: loadable library and perl binaries are mismatched"
5426 " (got handshake key %p, needed %p)\n",
5430 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5431 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5432 PL_xsubfilename = file; /* so the old name must be restored for
5433 additional XSUBs to register themselves */
5434 /* XSUBs can't be perl lang/perl5db.pl debugged
5435 if (PERLDB_LINE_OR_SAVESRC)
5436 (void)gv_fetchfile(file); */
5439 if(key & HSf_POPMARK) {
5441 { SV **mark = PL_stack_base + ax++;
5443 items = (I32)(SP - MARK);
5447 items = va_arg(args, U32);
5448 ax = va_arg(args, U32);
5452 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5453 if((apiverlen = HS_GETAPIVERLEN(key))) {
5454 char * api_p = va_arg(args, char*);
5455 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5456 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5457 sizeof("v" PERL_API_VERSION_STRING)-1))
5458 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5459 api_p, SVfARG(PL_stack_base[ax + 0]),
5460 "v" PERL_API_VERSION_STRING);
5465 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5466 if((xsverlen = HS_GETXSVERLEN(key)))
5467 S_xs_version_bootcheck(aTHX_
5468 items, ax, va_arg(args, char*), xsverlen);
5476 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5480 const char *vn = NULL;
5481 SV *const module = PL_stack_base[ax];
5483 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5485 if (items >= 2) /* version supplied as bootstrap arg */
5486 sv = PL_stack_base[ax + 1];
5488 /* XXX GV_ADDWARN */
5490 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5491 if (!sv || !SvOK(sv)) {
5493 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5497 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5498 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5499 ? sv : sv_2mortal(new_version(sv));
5500 xssv = upg_version(xssv, 0);
5501 if ( vcmp(pmsv,xssv) ) {
5502 SV *string = vstringify(xssv);
5503 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5504 " does not match ", SVfARG(module), SVfARG(string));
5506 SvREFCNT_dec(string);
5507 string = vstringify(pmsv);
5510 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5513 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5515 SvREFCNT_dec(string);
5517 Perl_sv_2mortal(aTHX_ xpt);
5518 Perl_croak_sv(aTHX_ xpt);
5524 =for apidoc my_strlcat
5526 The C library C<strlcat> if available, or a Perl implementation of it.
5527 This operates on C C<NUL>-terminated strings.
5529 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5530 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5531 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5532 practice this should not happen as it means that either C<size> is incorrect or
5533 that C<dst> is not a proper C<NUL>-terminated string).
5535 Note that C<size> is the full size of the destination buffer and
5536 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5537 room for the C<NUL> should be included in C<size>.
5539 The return value is the total length that C<dst> would have if C<size> is
5540 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5541 C<src>. If C<size> is smaller than the return, the excess was not appended.
5545 Description stolen from http://man.openbsd.org/strlcat.3
5549 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5551 Size_t used, length, copy;
5554 length = strlen(src);
5555 if (size > 0 && used < size - 1) {
5556 copy = (length >= size - used) ? size - used - 1 : length;
5557 memcpy(dst + used, src, copy);
5558 dst[used + copy] = '\0';
5560 return used + length;
5566 =for apidoc my_strlcpy
5568 The C library C<strlcpy> if available, or a Perl implementation of it.
5569 This operates on C C<NUL>-terminated strings.
5571 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5572 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5574 The return value is the total length C<src> would be if the copy completely
5575 succeeded. If it is larger than C<size>, the excess was not copied.
5579 Description stolen from http://man.openbsd.org/strlcpy.3
5583 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5585 Size_t length, copy;
5587 length = strlen(src);
5589 copy = (length >= size) ? size - 1 : length;
5590 memcpy(dst, src, copy);
5597 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5598 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5599 long _ftol( double ); /* Defined by VC6 C libs. */
5600 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5603 PERL_STATIC_INLINE bool
5604 S_gv_has_usable_name(pTHX_ GV *gv)
5608 && HvENAME(GvSTASH(gv))
5609 && (gvp = (GV **)hv_fetchhek(
5610 GvSTASH(gv), GvNAME_HEK(gv), 0
5616 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5618 SV * const dbsv = GvSVn(PL_DBsub);
5619 const bool save_taint = TAINT_get;
5621 /* When we are called from pp_goto (svp is null),
5622 * we do not care about using dbsv to call CV;
5623 * it's for informational purposes only.
5626 PERL_ARGS_ASSERT_GET_DB_SUB;
5630 if (!PERLDB_SUB_NN) {
5633 if (!svp && !CvLEXICAL(cv)) {
5634 gv_efullname3(dbsv, gv, NULL);
5636 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5637 || strEQ(GvNAME(gv), "END")
5638 || ( /* Could be imported, and old sub redefined. */
5639 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5641 !( (SvTYPE(*svp) == SVt_PVGV)
5642 && (GvCV((const GV *)*svp) == cv)
5643 /* Use GV from the stack as a fallback. */
5644 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5648 /* GV is potentially non-unique, or contain different CV. */
5649 SV * const tmp = newRV(MUTABLE_SV(cv));
5650 sv_setsv(dbsv, tmp);
5654 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5655 sv_catpvs(dbsv, "::");
5656 sv_cathek(dbsv, GvNAME_HEK(gv));
5660 const int type = SvTYPE(dbsv);
5661 if (type < SVt_PVIV && type != SVt_IV)
5662 sv_upgrade(dbsv, SVt_PVIV);
5663 (void)SvIOK_on(dbsv);
5664 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5667 TAINT_IF(save_taint);
5668 #ifdef NO_TAINT_SUPPORT
5669 PERL_UNUSED_VAR(save_taint);
5674 Perl_my_dirfd(DIR * dir) {
5676 /* Most dirfd implementations have problems when passed NULL. */
5681 #elif defined(HAS_DIR_DD_FD)
5684 Perl_croak_nocontext(PL_no_func, "dirfd");
5685 NOT_REACHED; /* NOTREACHED */
5690 #if !defined(HAS_MKOSTEMP) || !defined(HAS_MKSTEMP)
5692 #define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
5693 #define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
5696 S_my_mkostemp(char *templte, int flags) {
5698 STRLEN len = strlen(templte);
5702 int delete_on_close = flags & O_VMS_DELETEONCLOSE;
5704 flags &= ~O_VMS_DELETEONCLOSE;
5708 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
5709 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
5710 SETERRNO(EINVAL, LIB_INVARG);
5716 for (i = 1; i <= 6; ++i) {
5717 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
5720 if (delete_on_close) {
5721 fd = open(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600, "fop=dlt");
5726 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600);
5728 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
5735 #ifndef HAS_MKOSTEMP
5737 Perl_my_mkostemp(char *templte, int flags)
5739 PERL_ARGS_ASSERT_MY_MKOSTEMP;
5740 return S_my_mkostemp(templte, flags);
5746 Perl_my_mkstemp(char *templte)
5748 PERL_ARGS_ASSERT_MY_MKSTEMP;
5749 return S_my_mkostemp(templte, 0);
5754 Perl_get_re_arg(pTHX_ SV *sv) {
5760 sv = MUTABLE_SV(SvRV(sv));
5761 if (SvTYPE(sv) == SVt_REGEXP)
5762 return (REGEXP*) sv;
5769 * This code is derived from drand48() implementation from FreeBSD,
5770 * found in lib/libc/gen/_rand48.c.
5772 * The U64 implementation is original, based on the POSIX
5773 * specification for drand48().
5777 * Copyright (c) 1993 Martin Birgmeier
5778 * All rights reserved.
5780 * You may redistribute unmodified or modified versions of this source
5781 * code provided that the above copyright notice and this and the
5782 * following conditions are retained.
5784 * This software is provided ``as is'', and comes with no warranties
5785 * of any kind. I shall in no event be liable for anything that happens
5786 * to anyone/anything when using this software.
5789 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5791 #ifdef PERL_DRAND48_QUAD
5793 #define DRAND48_MULT UINT64_C(0x5deece66d)
5794 #define DRAND48_ADD 0xb
5795 #define DRAND48_MASK UINT64_C(0xffffffffffff)
5799 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5800 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5801 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5802 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5803 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5804 #define FREEBSD_DRAND48_ADD (0x000b)
5806 const unsigned short _rand48_mult[3] = {
5807 FREEBSD_DRAND48_MULT_0,
5808 FREEBSD_DRAND48_MULT_1,
5809 FREEBSD_DRAND48_MULT_2
5811 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5816 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5818 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5820 #ifdef PERL_DRAND48_QUAD
5821 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5823 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5824 random_state->seed[1] = (U16) seed;
5825 random_state->seed[2] = (U16) (seed >> 16);
5830 Perl_drand48_r(perl_drand48_t *random_state)
5832 PERL_ARGS_ASSERT_DRAND48_R;
5834 #ifdef PERL_DRAND48_QUAD
5835 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5838 return ldexp((double)*random_state, -48);
5844 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5845 + (U32) _rand48_add;
5846 temp[0] = (U16) accu; /* lower 16 bits */
5847 accu >>= sizeof(U16) * 8;
5848 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5849 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5850 temp[1] = (U16) accu; /* middle 16 bits */
5851 accu >>= sizeof(U16) * 8;
5852 accu += _rand48_mult[0] * random_state->seed[2]
5853 + _rand48_mult[1] * random_state->seed[1]
5854 + _rand48_mult[2] * random_state->seed[0];
5855 random_state->seed[0] = temp[0];
5856 random_state->seed[1] = temp[1];
5857 random_state->seed[2] = (U16) accu;
5859 return ldexp((double) random_state->seed[0], -48) +
5860 ldexp((double) random_state->seed[1], -32) +
5861 ldexp((double) random_state->seed[2], -16);
5866 #ifdef USE_C_BACKTRACE
5868 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5873 /* abfd is the BFD handle. */
5875 /* bfd_syms is the BFD symbol table. */
5877 /* bfd_text is handle to the the ".text" section of the object file. */
5879 /* Since opening the executable and scanning its symbols is quite
5880 * heavy operation, we remember the filename we used the last time,
5881 * and do the opening and scanning only if the filename changes.
5882 * This removes most (but not all) open+scan cycles. */
5883 const char* fname_prev;
5886 /* Given a dl_info, update the BFD context if necessary. */
5887 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5889 /* BFD open and scan only if the filename changed. */
5890 if (ctx->fname_prev == NULL ||
5891 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5893 bfd_close(ctx->abfd);
5895 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5897 if (bfd_check_format(ctx->abfd, bfd_object)) {
5898 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5899 if (symbol_size > 0) {
5900 Safefree(ctx->bfd_syms);
5901 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5903 bfd_get_section_by_name(ctx->abfd, ".text");
5911 ctx->fname_prev = dl_info->dli_fname;
5915 /* Given a raw frame, try to symbolize it and store
5916 * symbol information (source file, line number) away. */
5917 static void bfd_symbolize(bfd_context* ctx,
5920 STRLEN* symbol_name_size,
5922 STRLEN* source_name_size,
5923 STRLEN* source_line)
5925 *symbol_name = NULL;
5926 *symbol_name_size = 0;
5928 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5930 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5933 unsigned int line = 0;
5934 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5935 ctx->bfd_syms, offset,
5936 &file, &func, &line) &&
5937 file && func && line > 0) {
5938 /* Size and copy the source file, use only
5939 * the basename of the source file.
5941 * NOTE: the basenames are fine for the
5942 * Perl source files, but may not always
5943 * be the best idea for XS files. */
5944 const char *p, *b = NULL;
5945 /* Look for the last slash. */
5946 for (p = file; *p; p++) {
5950 if (b == NULL || *b == 0) {
5953 *source_name_size = p - b + 1;
5954 Newx(*source_name, *source_name_size + 1, char);
5955 Copy(b, *source_name, *source_name_size + 1, char);
5957 *symbol_name_size = strlen(func);
5958 Newx(*symbol_name, *symbol_name_size + 1, char);
5959 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5961 *source_line = line;
5967 #endif /* #ifdef USE_BFD */
5971 /* OS X has no public API for for 'symbolicating' (Apple official term)
5972 * stack addresses to {function_name, source_file, line_number}.
5973 * Good news: there is command line utility atos(1) which does that.
5974 * Bad news 1: it's a command line utility.
5975 * Bad news 2: one needs to have the Developer Tools installed.
5976 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
5978 * To recap: we need to open a pipe for reading for a utility which
5979 * might not exist, or exists in different locations, and then parse
5980 * the output. And since this is all for a low-level API, we cannot
5981 * use high-level stuff. Thanks, Apple. */
5984 /* tool is set to the absolute pathname of the tool to use:
5987 /* format is set to a printf format string used for building
5988 * the external command to run. */
5990 /* unavail is set if e.g. xcrun cannot be found, or something
5991 * else happens that makes getting the backtrace dubious. Note,
5992 * however, that the context isn't persistent, the next call to
5993 * get_c_backtrace() will start from scratch. */
5995 /* fname is the current object file name. */
5997 /* object_base_addr is the base address of the shared object. */
5998 void* object_base_addr;
6001 /* Given |dl_info|, updates the context. If the context has been
6002 * marked unavailable, return immediately. If not but the tool has
6003 * not been set, set it to either "xcrun atos" or "atos" (also set the
6004 * format to use for creating commands for piping), or if neither is
6005 * unavailable (one needs the Developer Tools installed), mark the context
6006 * an unavailable. Finally, update the filename (object name),
6007 * and its base address. */
6009 static void atos_update(atos_context* ctx,
6014 if (ctx->tool == NULL) {
6015 const char* tools[] = {
6019 const char* formats[] = {
6020 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6021 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6025 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6026 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6027 ctx->tool = tools[i];
6028 ctx->format = formats[i];
6032 if (ctx->tool == NULL) {
6033 ctx->unavail = TRUE;
6037 if (ctx->fname == NULL ||
6038 strNE(dl_info->dli_fname, ctx->fname)) {
6039 ctx->fname = dl_info->dli_fname;
6040 ctx->object_base_addr = dl_info->dli_fbase;
6044 /* Given an output buffer end |p| and its |start|, matches
6045 * for the atos output, extracting the source code location
6046 * and returning non-NULL if possible, returning NULL otherwise. */
6047 static const char* atos_parse(const char* p,
6049 STRLEN* source_name_size,
6050 STRLEN* source_line) {
6051 /* atos() output is something like:
6052 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6053 * We cannot use Perl regular expressions, because we need to
6054 * stay low-level. Therefore here we have a rolled-out version
6055 * of a state machine which matches _backwards_from_the_end_ and
6056 * if there's a success, returns the starts of the filename,
6057 * also setting the filename size and the source line number.
6058 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6059 const char* source_number_start;
6060 const char* source_name_end;
6061 const char* source_line_end = start;
6062 const char* close_paren;
6065 /* Skip trailing whitespace. */
6066 while (p > start && isSPACE(*p)) p--;
6067 /* Now we should be at the close paren. */
6068 if (p == start || *p != ')')
6072 /* Now we should be in the line number. */
6073 if (p == start || !isDIGIT(*p))
6075 /* Skip over the digits. */
6076 while (p > start && isDIGIT(*p))
6078 /* Now we should be at the colon. */
6079 if (p == start || *p != ':')
6081 source_number_start = p + 1;
6082 source_name_end = p; /* Just beyond the end. */
6084 /* Look for the open paren. */
6085 while (p > start && *p != '(')
6090 *source_name_size = source_name_end - p;
6091 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6092 && source_line_end == close_paren
6093 && uv <= PERL_INT_MAX
6095 *source_line = (STRLEN)uv;
6101 /* Given a raw frame, read a pipe from the symbolicator (that's the
6102 * technical term) atos, reads the result, and parses the source code
6103 * location. We must stay low-level, so we use snprintf(), pipe(),
6104 * and fread(), and then also parse the output ourselves. */
6105 static void atos_symbolize(atos_context* ctx,
6108 STRLEN* source_name_size,
6109 STRLEN* source_line)
6117 /* Simple security measure: if there's any funny business with
6118 * the object name (used as "-o '%s'" ), leave since at least
6119 * partially the user controls it. */
6120 for (p = ctx->fname; *p; p++) {
6121 if (*p == '\'' || isCNTRL(*p)) {
6122 ctx->unavail = TRUE;
6126 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6127 ctx->fname, ctx->object_base_addr, raw_frame);
6128 if (cnt < sizeof(cmd)) {
6129 /* Undo nostdio.h #defines that disable stdio.
6130 * This is somewhat naughty, but is used elsewhere
6131 * in the core, and affects only OS X. */
6136 FILE* fp = popen(cmd, "r");
6137 /* At the moment we open a new pipe for each stack frame.
6138 * This is naturally somewhat slow, but hopefully generating
6139 * stack traces is never going to in a performance critical path.
6141 * We could play tricks with atos by batching the stack
6142 * addresses to be resolved: atos can either take multiple
6143 * addresses from the command line, or read addresses from
6144 * a file (though the mess of creating temporary files would
6145 * probably negate much of any possible speedup).
6147 * Normally there are only two objects present in the backtrace:
6148 * perl itself, and the libdyld.dylib. (Note that the object
6149 * filenames contain the full pathname, so perl may not always
6150 * be in the same place.) Whenever the object in the
6151 * backtrace changes, the base address also changes.
6153 * The problem with batching the addresses, though, would be
6154 * matching the results with the addresses: the parsing of
6155 * the results is already painful enough with a single address. */
6158 UV cnt = fread(out, 1, sizeof(out), fp);
6159 if (cnt < sizeof(out)) {
6160 const char* p = atos_parse(out + cnt - 1, out,
6165 *source_name_size, char);
6166 Copy(p, *source_name,
6167 *source_name_size, char);
6175 #endif /* #ifdef PERL_DARWIN */
6178 =for apidoc get_c_backtrace
6180 Collects the backtrace (aka "stacktrace") into a single linear
6181 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6183 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6184 returning at most C<depth> frames.
6190 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6192 /* Note that here we must stay as low-level as possible: Newx(),
6193 * Copy(), Safefree(); since we may be called from anywhere,
6194 * so we should avoid higher level constructs like SVs or AVs.
6196 * Since we are using safesysmalloc() via Newx(), don't try
6197 * getting backtrace() there, unless you like deep recursion. */
6199 /* Currently only implemented with backtrace() and dladdr(),
6200 * for other platforms NULL is returned. */
6202 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6203 /* backtrace() is available via <execinfo.h> in glibc and in most
6204 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6206 /* We try fetching this many frames total, but then discard
6207 * the |skip| first ones. For the remaining ones we will try
6208 * retrieving more information with dladdr(). */
6209 int try_depth = skip + depth;
6211 /* The addresses (program counters) returned by backtrace(). */
6214 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6217 /* Sizes _including_ the terminating \0 of the object name
6218 * and symbol name strings. */
6219 STRLEN* object_name_sizes;
6220 STRLEN* symbol_name_sizes;
6223 /* The symbol names comes either from dli_sname,
6224 * or if using BFD, they can come from BFD. */
6225 char** symbol_names;
6228 /* The source code location information. Dug out with e.g. BFD. */
6229 char** source_names;
6230 STRLEN* source_name_sizes;
6231 STRLEN* source_lines;
6233 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6234 int got_depth; /* How many frames were returned from backtrace(). */
6235 UV frame_count = 0; /* How many frames we return. */
6236 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6239 bfd_context bfd_ctx;
6242 atos_context atos_ctx;
6245 /* Here are probably possibilities for optimizing. We could for
6246 * example have a struct that contains most of these and then
6247 * allocate |try_depth| of them, saving a bunch of malloc calls.
6248 * Note, however, that |frames| could not be part of that struct
6249 * because backtrace() will want an array of just them. Also be
6250 * careful about the name strings. */
6251 Newx(raw_frames, try_depth, void*);
6252 Newx(dl_infos, try_depth, Dl_info);
6253 Newx(object_name_sizes, try_depth, STRLEN);
6254 Newx(symbol_name_sizes, try_depth, STRLEN);
6255 Newx(source_names, try_depth, char*);
6256 Newx(source_name_sizes, try_depth, STRLEN);
6257 Newx(source_lines, try_depth, STRLEN);
6259 Newx(symbol_names, try_depth, char*);
6262 /* Get the raw frames. */
6263 got_depth = (int)backtrace(raw_frames, try_depth);
6265 /* We use dladdr() instead of backtrace_symbols() because we want
6266 * the full details instead of opaque strings. This is useful for
6267 * two reasons: () the details are needed for further symbolic
6268 * digging, for example in OS X (2) by having the details we fully
6269 * control the output, which in turn is useful when more platforms
6270 * are added: we can keep out output "portable". */
6272 /* We want a single linear allocation, which can then be freed
6273 * with a single swoop. We will do the usual trick of first
6274 * walking over the structure and seeing how much we need to
6275 * allocate, then allocating, and then walking over the structure
6276 * the second time and populating it. */
6278 /* First we must compute the total size of the buffer. */
6279 total_bytes = sizeof(Perl_c_backtrace_header);
6280 if (got_depth > skip) {
6283 bfd_init(); /* Is this safe to call multiple times? */
6284 Zero(&bfd_ctx, 1, bfd_context);
6287 Zero(&atos_ctx, 1, atos_context);
6289 for (i = skip; i < try_depth; i++) {
6290 Dl_info* dl_info = &dl_infos[i];
6292 object_name_sizes[i] = 0;
6293 source_names[i] = NULL;
6294 source_name_sizes[i] = 0;
6295 source_lines[i] = 0;
6297 /* Yes, zero from dladdr() is failure. */
6298 if (dladdr(raw_frames[i], dl_info)) {
6299 total_bytes += sizeof(Perl_c_backtrace_frame);
6301 object_name_sizes[i] =
6302 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6303 symbol_name_sizes[i] =
6304 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6306 bfd_update(&bfd_ctx, dl_info);
6307 bfd_symbolize(&bfd_ctx, raw_frames[i],
6309 &symbol_name_sizes[i],
6311 &source_name_sizes[i],
6315 atos_update(&atos_ctx, dl_info);
6316 atos_symbolize(&atos_ctx,
6319 &source_name_sizes[i],
6323 /* Plus ones for the terminating \0. */
6324 total_bytes += object_name_sizes[i] + 1;
6325 total_bytes += symbol_name_sizes[i] + 1;
6326 total_bytes += source_name_sizes[i] + 1;
6334 Safefree(bfd_ctx.bfd_syms);
6338 /* Now we can allocate and populate the result buffer. */
6339 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6340 Zero(bt, total_bytes, char);
6341 bt->header.frame_count = frame_count;
6342 bt->header.total_bytes = total_bytes;
6343 if (frame_count > 0) {
6344 Perl_c_backtrace_frame* frame = bt->frame_info;
6345 char* name_base = (char *)(frame + frame_count);
6346 char* name_curr = name_base; /* Outputting the name strings here. */
6348 for (i = skip; i < skip + frame_count; i++) {
6349 Dl_info* dl_info = &dl_infos[i];
6351 frame->addr = raw_frames[i];
6352 frame->object_base_addr = dl_info->dli_fbase;
6353 frame->symbol_addr = dl_info->dli_saddr;
6355 /* Copies a string, including the \0, and advances the name_curr.
6356 * Also copies the start and the size to the frame. */
6357 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6359 Copy(src, name_curr, size, char); \
6360 frame->doffset = name_curr - (char*)bt; \
6361 frame->dsize = size; \
6362 name_curr += size; \
6365 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6367 object_name_size, object_name_sizes[i]);
6370 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6372 symbol_name_size, symbol_name_sizes[i]);
6373 Safefree(symbol_names[i]);
6375 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6377 symbol_name_size, symbol_name_sizes[i]);
6380 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6382 source_name_size, source_name_sizes[i]);
6383 Safefree(source_names[i]);
6385 #undef PERL_C_BACKTRACE_STRCPY
6387 frame->source_line_number = source_lines[i];
6391 assert(total_bytes ==
6392 (UV)(sizeof(Perl_c_backtrace_header) +
6393 frame_count * sizeof(Perl_c_backtrace_frame) +
6394 name_curr - name_base));
6397 Safefree(symbol_names);
6399 bfd_close(bfd_ctx.abfd);
6402 Safefree(source_lines);
6403 Safefree(source_name_sizes);
6404 Safefree(source_names);
6405 Safefree(symbol_name_sizes);
6406 Safefree(object_name_sizes);
6407 /* Assuming the strings returned by dladdr() are pointers
6408 * to read-only static memory (the object file), so that
6409 * they do not need freeing (and cannot be). */
6411 Safefree(raw_frames);
6414 PERL_UNUSED_ARG(depth);
6415 PERL_UNUSED_ARG(skip);
6421 =for apidoc free_c_backtrace
6423 Deallocates a backtrace received from get_c_bracktrace.
6429 =for apidoc get_c_backtrace_dump
6431 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6432 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6434 The appended output looks like:
6437 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6438 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6441 The fields are tab-separated. The first column is the depth (zero
6442 being the innermost non-skipped frame). In the hex:offset, the hex is
6443 where the program counter was in C<S_parse_body>, and the :offset (might
6444 be missing) tells how much inside the C<S_parse_body> the program counter was.
6446 The C<util.c:1716> is the source code file and line number.
6448 The F</usr/bin/perl> is obvious (hopefully).
6450 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6451 if the platform doesn't support retrieving the information;
6452 if the binary is missing the debug information;
6453 if the optimizer has transformed the code by for example inlining.
6459 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6461 Perl_c_backtrace* bt;
6463 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6465 Perl_c_backtrace_frame* frame;
6466 SV* dsv = newSVpvs("");
6468 for (i = 0, frame = bt->frame_info;
6469 i < bt->header.frame_count; i++, frame++) {
6470 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6471 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6472 /* Symbol (function) names might disappear without debug info.
6474 * The source code location might disappear in case of the
6475 * optimizer inlining or otherwise rearranging the code. */
6476 if (frame->symbol_addr) {
6477 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6479 ((char*)frame->addr - (char*)frame->symbol_addr));
6481 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6482 frame->symbol_name_size &&
6483 frame->symbol_name_offset ?
6484 (char*)bt + frame->symbol_name_offset : "-");
6485 if (frame->source_name_size &&
6486 frame->source_name_offset &&
6487 frame->source_line_number) {
6488 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6489 (char*)bt + frame->source_name_offset,
6490 (UV)frame->source_line_number);
6492 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6494 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6495 frame->object_name_size &&
6496 frame->object_name_offset ?
6497 (char*)bt + frame->object_name_offset : "-");
6498 /* The frame->object_base_addr is not output,
6499 * but it is used for symbolizing/symbolicating. */
6500 sv_catpvs(dsv, "\n");
6503 Perl_free_c_backtrace(bt);
6512 =for apidoc dump_c_backtrace
6514 Dumps the C backtrace to the given C<fp>.
6516 Returns true if a backtrace could be retrieved, false if not.
6522 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6526 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6528 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6531 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6537 #endif /* #ifdef USE_C_BACKTRACE */
6539 #ifdef PERL_TSA_ACTIVE
6541 /* pthread_mutex_t and perl_mutex are typedef equivalent
6542 * so casting the pointers is fine. */
6544 int perl_tsa_mutex_lock(perl_mutex* mutex)
6546 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6549 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6551 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6554 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6556 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6564 /* log a sub call or return */
6567 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6575 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6578 HEK *hek = CvNAME_HEK(cv);
6579 func = HEK_KEY(hek);
6585 start = (const COP *)CvSTART(cv);
6586 file = CopFILE(start);
6587 line = CopLINE(start);
6588 stash = CopSTASHPV(start);
6591 PERL_SUB_ENTRY(func, file, line, stash);
6594 PERL_SUB_RETURN(func, file, line, stash);
6599 /* log a require file loading/loaded */
6602 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6604 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6607 PERL_LOADING_FILE(name);
6610 PERL_LOADED_FILE(name);
6615 /* log an op execution */
6618 Perl_dtrace_probe_op(pTHX_ const OP *op)
6620 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6622 PERL_OP_ENTRY(OP_NAME(op));
6626 /* log a compile/run phase change */
6629 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6631 const char *ph_old = PL_phase_names[PL_phase];
6632 const char *ph_new = PL_phase_names[phase];
6634 PERL_PHASE_CHANGE(ph_new, ph_old);
6640 * ex: set ts=8 sts=4 sw=4 et: