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);
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 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>. To prevent memory leaks, the
1069 memory allocated for the new string needs to be freed when no longer needed.
1070 This can be done with the L</C<Safefree>> function, or
1071 L<C<SAVEFREEPV>|perlguts/SAVEFREEPV(p)>.
1073 On some platforms, Windows for example, all allocated memory owned by a thread
1074 is deallocated when that thread ends. So if you need that not to happen, you
1075 need to use the shared memory functions, such as C<L</savesharedpv>>.
1081 Perl_savepv(pTHX_ const char *pv)
1083 PERL_UNUSED_CONTEXT;
1088 const STRLEN pvlen = strlen(pv)+1;
1089 Newx(newaddr, pvlen, char);
1090 return (char*)memcpy(newaddr, pv, pvlen);
1094 /* same thing but with a known length */
1099 Perl's version of what C<strndup()> would be if it existed. Returns a
1100 pointer to a newly allocated string which is a duplicate of the first
1101 C<len> bytes from C<pv>, plus a trailing
1102 C<NUL> byte. The memory allocated for
1103 the new string can be freed with the C<Safefree()> function.
1105 On some platforms, Windows for example, all allocated memory owned by a thread
1106 is deallocated when that thread ends. So if you need that not to happen, you
1107 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1113 Perl_savepvn(pTHX_ const char *pv, Size_t len)
1116 PERL_UNUSED_CONTEXT;
1118 Newx(newaddr,len+1,char);
1119 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1121 /* might not be null terminated */
1122 newaddr[len] = '\0';
1123 return (char *) CopyD(pv,newaddr,len,char);
1126 return (char *) ZeroD(newaddr,len+1,char);
1131 =for apidoc savesharedpv
1133 A version of C<savepv()> which allocates the duplicate string in memory
1134 which is shared between threads.
1139 Perl_savesharedpv(pTHX_ const char *pv)
1144 PERL_UNUSED_CONTEXT;
1149 pvlen = strlen(pv)+1;
1150 newaddr = (char*)PerlMemShared_malloc(pvlen);
1154 return (char*)memcpy(newaddr, pv, pvlen);
1158 =for apidoc savesharedpvn
1160 A version of C<savepvn()> which allocates the duplicate string in memory
1161 which is shared between threads. (With the specific difference that a C<NULL>
1162 pointer is not acceptable)
1167 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1169 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1171 PERL_UNUSED_CONTEXT;
1172 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1177 newaddr[len] = '\0';
1178 return (char*)memcpy(newaddr, pv, len);
1182 =for apidoc savesvpv
1184 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1185 the passed in SV using C<SvPV()>
1187 On some platforms, Windows for example, all allocated memory owned by a thread
1188 is deallocated when that thread ends. So if you need that not to happen, you
1189 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1195 Perl_savesvpv(pTHX_ SV *sv)
1198 const char * const pv = SvPV_const(sv, len);
1201 PERL_ARGS_ASSERT_SAVESVPV;
1204 Newx(newaddr,len,char);
1205 return (char *) CopyD(pv,newaddr,len,char);
1209 =for apidoc savesharedsvpv
1211 A version of C<savesharedpv()> which allocates the duplicate string in
1212 memory which is shared between threads.
1218 Perl_savesharedsvpv(pTHX_ SV *sv)
1221 const char * const pv = SvPV_const(sv, len);
1223 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1225 return savesharedpvn(pv, len);
1228 /* the SV for Perl_form() and mess() is not kept in an arena */
1236 if (PL_phase != PERL_PHASE_DESTRUCT)
1237 return newSVpvs_flags("", SVs_TEMP);
1242 /* Create as PVMG now, to avoid any upgrading later */
1244 Newxz(any, 1, XPVMG);
1245 SvFLAGS(sv) = SVt_PVMG;
1246 SvANY(sv) = (void*)any;
1248 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1253 #if defined(PERL_IMPLICIT_CONTEXT)
1255 Perl_form_nocontext(const char* pat, ...)
1260 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1261 va_start(args, pat);
1262 retval = vform(pat, &args);
1266 #endif /* PERL_IMPLICIT_CONTEXT */
1269 =head1 Miscellaneous Functions
1272 Takes a sprintf-style format pattern and conventional
1273 (non-SV) arguments and returns the formatted string.
1275 (char *) Perl_form(pTHX_ const char* pat, ...)
1277 can be used any place a string (char *) is required:
1279 char * s = Perl_form("%d.%d",major,minor);
1281 Uses a single private buffer so if you want to format several strings you
1282 must explicitly copy the earlier strings away (and free the copies when you
1289 Perl_form(pTHX_ const char* pat, ...)
1293 PERL_ARGS_ASSERT_FORM;
1294 va_start(args, pat);
1295 retval = vform(pat, &args);
1301 Perl_vform(pTHX_ const char *pat, va_list *args)
1303 SV * const sv = mess_alloc();
1304 PERL_ARGS_ASSERT_VFORM;
1305 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1312 Take a sprintf-style format pattern and argument list. These are used to
1313 generate a string message. If the message does not end with a newline,
1314 then it will be extended with some indication of the current location
1315 in the code, as described for L</mess_sv>.
1317 Normally, the resulting message is returned in a new mortal SV.
1318 During global destruction a single SV may be shared between uses of
1324 #if defined(PERL_IMPLICIT_CONTEXT)
1326 Perl_mess_nocontext(const char *pat, ...)
1331 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1332 va_start(args, pat);
1333 retval = vmess(pat, &args);
1337 #endif /* PERL_IMPLICIT_CONTEXT */
1340 Perl_mess(pTHX_ const char *pat, ...)
1344 PERL_ARGS_ASSERT_MESS;
1345 va_start(args, pat);
1346 retval = vmess(pat, &args);
1352 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1355 /* Look for curop starting from o. cop is the last COP we've seen. */
1356 /* opnext means that curop is actually the ->op_next of the op we are
1359 PERL_ARGS_ASSERT_CLOSEST_COP;
1361 if (!o || !curop || (
1362 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1366 if (o->op_flags & OPf_KIDS) {
1368 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1371 /* If the OP_NEXTSTATE has been optimised away we can still use it
1372 * the get the file and line number. */
1374 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1375 cop = (const COP *)kid;
1377 /* Keep searching, and return when we've found something. */
1379 new_cop = closest_cop(cop, kid, curop, opnext);
1385 /* Nothing found. */
1393 Expands a message, intended for the user, to include an indication of
1394 the current location in the code, if the message does not already appear
1397 C<basemsg> is the initial message or object. If it is a reference, it
1398 will be used as-is and will be the result of this function. Otherwise it
1399 is used as a string, and if it already ends with a newline, it is taken
1400 to be complete, and the result of this function will be the same string.
1401 If the message does not end with a newline, then a segment such as C<at
1402 foo.pl line 37> will be appended, and possibly other clauses indicating
1403 the current state of execution. The resulting message will end with a
1406 Normally, the resulting message is returned in a new mortal SV.
1407 During global destruction a single SV may be shared between uses of this
1408 function. If C<consume> is true, then the function is permitted (but not
1409 required) to modify and return C<basemsg> instead of allocating a new SV.
1415 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1419 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1423 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1424 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1425 && grok_atoUV(ws, &wi, NULL)
1426 && wi <= PERL_INT_MAX
1428 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1433 PERL_ARGS_ASSERT_MESS_SV;
1435 if (SvROK(basemsg)) {
1441 sv_setsv(sv, basemsg);
1446 if (SvPOK(basemsg) && consume) {
1451 sv_copypv(sv, basemsg);
1454 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1456 * Try and find the file and line for PL_op. This will usually be
1457 * PL_curcop, but it might be a cop that has been optimised away. We
1458 * can try to find such a cop by searching through the optree starting
1459 * from the sibling of PL_curcop.
1464 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1469 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1470 OutCopFILE(cop), (IV)CopLINE(cop));
1473 /* Seems that GvIO() can be untrustworthy during global destruction. */
1474 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1475 && IoLINES(GvIOp(PL_last_in_gv)))
1478 const bool line_mode = (RsSIMPLE(PL_rs) &&
1479 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1480 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1481 SVfARG(PL_last_in_gv == PL_argvgv
1483 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1484 line_mode ? "line" : "chunk",
1485 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1487 if (PL_phase == PERL_PHASE_DESTRUCT)
1488 sv_catpvs(sv, " during global destruction");
1489 sv_catpvs(sv, ".\n");
1497 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1498 argument list, respectively. These are used to generate a string message. If
1500 message does not end with a newline, then it will be extended with
1501 some indication of the current location in the code, as described for
1504 Normally, the resulting message is returned in a new mortal SV.
1505 During global destruction a single SV may be shared between uses of
1512 Perl_vmess(pTHX_ const char *pat, va_list *args)
1514 SV * const sv = mess_alloc();
1516 PERL_ARGS_ASSERT_VMESS;
1518 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1519 return mess_sv(sv, 1);
1523 Perl_write_to_stderr(pTHX_ SV* msv)
1528 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1530 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1531 && (io = GvIO(PL_stderrgv))
1532 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1533 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1534 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1536 PerlIO * const serr = Perl_error_log;
1538 do_print(msv, serr);
1539 (void)PerlIO_flush(serr);
1544 =head1 Warning and Dieing
1547 /* Common code used in dieing and warning */
1550 S_with_queued_errors(pTHX_ SV *ex)
1552 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1553 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1554 sv_catsv(PL_errors, ex);
1555 ex = sv_mortalcopy(PL_errors);
1556 SvCUR_set(PL_errors, 0);
1562 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1568 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1569 /* sv_2cv might call Perl_croak() or Perl_warner() */
1570 SV * const oldhook = *hook;
1572 if (!oldhook || oldhook == PERL_WARNHOOK_FATAL)
1578 cv = sv_2cv(oldhook, &stash, &gv, 0);
1580 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1590 exarg = newSVsv(ex);
1591 SvREADONLY_on(exarg);
1594 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1598 call_sv(MUTABLE_SV(cv), G_DISCARD);
1609 Behaves the same as L</croak_sv>, except for the return type.
1610 It should be used only where the C<OP *> return type is required.
1611 The function never actually returns.
1616 /* silence __declspec(noreturn) warnings */
1617 MSVC_DIAG_IGNORE(4646 4645)
1619 Perl_die_sv(pTHX_ SV *baseex)
1621 PERL_ARGS_ASSERT_DIE_SV;
1624 NORETURN_FUNCTION_END;
1631 Behaves the same as L</croak>, except for the return type.
1632 It should be used only where the C<OP *> return type is required.
1633 The function never actually returns.
1638 #if defined(PERL_IMPLICIT_CONTEXT)
1640 /* silence __declspec(noreturn) warnings */
1641 MSVC_DIAG_IGNORE(4646 4645)
1643 Perl_die_nocontext(const char* pat, ...)
1647 va_start(args, pat);
1649 NOT_REACHED; /* NOTREACHED */
1651 NORETURN_FUNCTION_END;
1655 #endif /* PERL_IMPLICIT_CONTEXT */
1657 /* silence __declspec(noreturn) warnings */
1658 MSVC_DIAG_IGNORE(4646 4645)
1660 Perl_die(pTHX_ const char* pat, ...)
1663 va_start(args, pat);
1665 NOT_REACHED; /* NOTREACHED */
1667 NORETURN_FUNCTION_END;
1672 =for apidoc croak_sv
1674 This is an XS interface to Perl's C<die> function.
1676 C<baseex> is the error message or object. If it is a reference, it
1677 will be used as-is. Otherwise it is used as a string, and if it does
1678 not end with a newline then it will be extended with some indication of
1679 the current location in the code, as described for L</mess_sv>.
1681 The error message or object will be used as an exception, by default
1682 returning control to the nearest enclosing C<eval>, but subject to
1683 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1684 function never returns normally.
1686 To die with a simple string message, the L</croak> function may be
1693 Perl_croak_sv(pTHX_ SV *baseex)
1695 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1696 PERL_ARGS_ASSERT_CROAK_SV;
1697 invoke_exception_hook(ex, FALSE);
1704 This is an XS interface to Perl's C<die> function.
1706 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1707 argument list. These are used to generate a string message. If the
1708 message does not end with a newline, then it will be extended with
1709 some indication of the current location in the code, as described for
1712 The error message will be used as an exception, by default
1713 returning control to the nearest enclosing C<eval>, but subject to
1714 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1715 function never returns normally.
1717 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1718 (C<$@>) will be used as an error message or object instead of building an
1719 error message from arguments. If you want to throw a non-string object,
1720 or build an error message in an SV yourself, it is preferable to use
1721 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1727 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1729 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1730 invoke_exception_hook(ex, FALSE);
1737 This is an XS interface to Perl's C<die> function.
1739 Take a sprintf-style format pattern and argument list. These are used to
1740 generate a string message. If the message does not end with a newline,
1741 then it will be extended with some indication of the current location
1742 in the code, as described for L</mess_sv>.
1744 The error message will be used as an exception, by default
1745 returning control to the nearest enclosing C<eval>, but subject to
1746 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1747 function never returns normally.
1749 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1750 (C<$@>) will be used as an error message or object instead of building an
1751 error message from arguments. If you want to throw a non-string object,
1752 or build an error message in an SV yourself, it is preferable to use
1753 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1758 #if defined(PERL_IMPLICIT_CONTEXT)
1760 Perl_croak_nocontext(const char *pat, ...)
1764 va_start(args, pat);
1766 NOT_REACHED; /* NOTREACHED */
1769 #endif /* PERL_IMPLICIT_CONTEXT */
1771 /* saves machine code for a common noreturn idiom typically used in Newx*() */
1772 GCC_DIAG_IGNORE_DECL(-Wunused-function);
1774 Perl_croak_memory_wrap(void)
1776 Perl_croak_nocontext("%s",PL_memory_wrap);
1778 GCC_DIAG_RESTORE_DECL;
1781 Perl_croak(pTHX_ const char *pat, ...)
1784 va_start(args, pat);
1786 NOT_REACHED; /* NOTREACHED */
1791 =for apidoc croak_no_modify
1793 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1794 terser object code than using C<Perl_croak>. Less code used on exception code
1795 paths reduces CPU cache pressure.
1801 Perl_croak_no_modify(void)
1803 Perl_croak_nocontext( "%s", PL_no_modify);
1806 /* does not return, used in util.c perlio.c and win32.c
1807 This is typically called when malloc returns NULL.
1810 Perl_croak_no_mem(void)
1814 int fd = PerlIO_fileno(Perl_error_log);
1816 SETERRNO(EBADF,RMS_IFI);
1818 /* Can't use PerlIO to write as it allocates memory */
1819 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1824 /* does not return, used only in POPSTACK */
1826 Perl_croak_popstack(void)
1829 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1836 This is an XS interface to Perl's C<warn> function.
1838 C<baseex> is the error message or object. If it is a reference, it
1839 will be used as-is. Otherwise it is used as a string, and if it does
1840 not end with a newline then it will be extended with some indication of
1841 the current location in the code, as described for L</mess_sv>.
1843 The error message or object will by default be written to standard error,
1844 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1846 To warn with a simple string message, the L</warn> function may be
1853 Perl_warn_sv(pTHX_ SV *baseex)
1855 SV *ex = mess_sv(baseex, 0);
1856 PERL_ARGS_ASSERT_WARN_SV;
1857 if (!invoke_exception_hook(ex, TRUE))
1858 write_to_stderr(ex);
1864 This is an XS interface to Perl's C<warn> function.
1866 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1867 argument list. These are used to generate a string message. If the
1868 message does not end with a newline, then it will be extended with
1869 some indication of the current location in the code, as described for
1872 The error message or object will by default be written to standard error,
1873 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1875 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1881 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1883 SV *ex = vmess(pat, args);
1884 PERL_ARGS_ASSERT_VWARN;
1885 if (!invoke_exception_hook(ex, TRUE))
1886 write_to_stderr(ex);
1892 This is an XS interface to Perl's C<warn> function.
1894 Take a sprintf-style format pattern and argument list. These are used to
1895 generate a string message. If the message does not end with a newline,
1896 then it will be extended with some indication of the current location
1897 in the code, as described for L</mess_sv>.
1899 The error message or object will by default be written to standard error,
1900 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1902 Unlike with L</croak>, C<pat> is not permitted to be null.
1907 #if defined(PERL_IMPLICIT_CONTEXT)
1909 Perl_warn_nocontext(const char *pat, ...)
1913 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1914 va_start(args, pat);
1918 #endif /* PERL_IMPLICIT_CONTEXT */
1921 Perl_warn(pTHX_ const char *pat, ...)
1924 PERL_ARGS_ASSERT_WARN;
1925 va_start(args, pat);
1930 #if defined(PERL_IMPLICIT_CONTEXT)
1932 Perl_warner_nocontext(U32 err, const char *pat, ...)
1936 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1937 va_start(args, pat);
1938 vwarner(err, pat, &args);
1941 #endif /* PERL_IMPLICIT_CONTEXT */
1944 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1946 PERL_ARGS_ASSERT_CK_WARNER_D;
1948 if (Perl_ckwarn_d(aTHX_ err)) {
1950 va_start(args, pat);
1951 vwarner(err, pat, &args);
1957 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1959 PERL_ARGS_ASSERT_CK_WARNER;
1961 if (Perl_ckwarn(aTHX_ err)) {
1963 va_start(args, pat);
1964 vwarner(err, pat, &args);
1970 Perl_warner(pTHX_ U32 err, const char* pat,...)
1973 PERL_ARGS_ASSERT_WARNER;
1974 va_start(args, pat);
1975 vwarner(err, pat, &args);
1980 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1983 PERL_ARGS_ASSERT_VWARNER;
1985 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
1986 !(PL_in_eval & EVAL_KEEPERR)
1988 SV * const msv = vmess(pat, args);
1990 if (PL_parser && PL_parser->error_count) {
1994 invoke_exception_hook(msv, FALSE);
1999 Perl_vwarn(aTHX_ pat, args);
2003 /* implements the ckWARN? macros */
2006 Perl_ckwarn(pTHX_ U32 w)
2008 /* If lexical warnings have not been set, use $^W. */
2010 return PL_dowarn & G_WARN_ON;
2012 return ckwarn_common(w);
2015 /* implements the ckWARN?_d macro */
2018 Perl_ckwarn_d(pTHX_ U32 w)
2020 /* If lexical warnings have not been set then default classes warn. */
2024 return ckwarn_common(w);
2028 S_ckwarn_common(pTHX_ U32 w)
2030 if (PL_curcop->cop_warnings == pWARN_ALL)
2033 if (PL_curcop->cop_warnings == pWARN_NONE)
2036 /* Check the assumption that at least the first slot is non-zero. */
2037 assert(unpackWARN1(w));
2039 /* Check the assumption that it is valid to stop as soon as a zero slot is
2041 if (!unpackWARN2(w)) {
2042 assert(!unpackWARN3(w));
2043 assert(!unpackWARN4(w));
2044 } else if (!unpackWARN3(w)) {
2045 assert(!unpackWARN4(w));
2048 /* Right, dealt with all the special cases, which are implemented as non-
2049 pointers, so there is a pointer to a real warnings mask. */
2051 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2053 } while (w >>= WARNshift);
2058 /* Set buffer=NULL to get a new one. */
2060 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2062 const MEM_SIZE len_wanted =
2063 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2064 PERL_UNUSED_CONTEXT;
2065 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2068 (specialWARN(buffer) ?
2069 PerlMemShared_malloc(len_wanted) :
2070 PerlMemShared_realloc(buffer, len_wanted));
2072 Copy(bits, (buffer + 1), size, char);
2073 if (size < WARNsize)
2074 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2078 /* since we've already done strlen() for both nam and val
2079 * we can use that info to make things faster than
2080 * sprintf(s, "%s=%s", nam, val)
2082 #define my_setenv_format(s, nam, nlen, val, vlen) \
2083 Copy(nam, s, nlen, char); \
2085 Copy(val, s+(nlen+1), vlen, char); \
2086 *(s+(nlen+1+vlen)) = '\0'
2090 #ifdef USE_ENVIRON_ARRAY
2091 /* NB: VMS' my_setenv() is in vms.c */
2093 /* Configure doesn't test for HAS_SETENV yet, so decide based on platform.
2094 * For Solaris, setenv() and unsetenv() were introduced in Solaris 9, so
2095 * testing for HAS UNSETENV is sufficient.
2097 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2098 # define MY_HAS_SETENV
2101 /* small wrapper for use by Perl_my_setenv that mallocs, or reallocs if
2102 * 'current' is non-null, with up to three sizes that are added together.
2103 * It handles integer overflow.
2105 # ifndef MY_HAS_SETENV
2107 S_env_alloc(void *current, Size_t l1, Size_t l2, Size_t l3, Size_t size)
2110 Size_t sl, l = l1 + l2;
2122 ? safesysrealloc(current, sl)
2123 : safesysmalloc(sl);
2128 croak_memory_wrap();
2133 # if !defined(WIN32) && !defined(NETWARE)
2136 =for apidoc my_setenv
2138 A wrapper for the C library L<setenv(3)>. Don't use the latter, as the perl
2139 version has desirable safeguards
2145 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2148 # ifdef __amigaos4__
2149 amigaos4_obtain_environ(__FUNCTION__);
2152 # ifdef USE_ITHREADS
2153 /* only parent thread can modify process environment, so no need to use a
2155 if (PL_curinterp == aTHX)
2159 # ifndef PERL_USE_SAFE_PUTENV
2160 if (!PL_use_safe_putenv) {
2161 /* most putenv()s leak, so we manipulate environ directly */
2163 Size_t vlen, nlen = strlen(nam);
2165 /* where does it go? */
2166 for (i = 0; environ[i]; i++) {
2167 if (strnEQ(environ[i], nam, nlen) && environ[i][nlen] == '=')
2171 if (environ == PL_origenviron) { /* need we copy environment? */
2176 while (environ[max])
2179 /* XXX shouldn't that be max+1 rather than max+2 ??? - DAPM */
2180 tmpenv = (char**)S_env_alloc(NULL, max, 2, 0, sizeof(char*));
2182 for (j=0; j<max; j++) { /* copy environment */
2183 const Size_t len = strlen(environ[j]);
2184 tmpenv[j] = S_env_alloc(NULL, len, 1, 0, 1);
2185 Copy(environ[j], tmpenv[j], len+1, char);
2189 environ = tmpenv; /* tell exec where it is now */
2193 safesysfree(environ[i]);
2194 while (environ[i]) {
2195 environ[i] = environ[i+1];
2198 # ifdef __amigaos4__
2205 if (!environ[i]) { /* does not exist yet */
2206 environ = (char**)S_env_alloc(environ, i, 2, 0, sizeof(char*));
2207 environ[i+1] = NULL; /* make sure it's null terminated */
2210 safesysfree(environ[i]);
2214 environ[i] = S_env_alloc(NULL, nlen, vlen, 2, 1);
2215 /* all that work just for this */
2216 my_setenv_format(environ[i], nam, nlen, val, vlen);
2220 # endif /* !PERL_USE_SAFE_PUTENV */
2222 # ifdef MY_HAS_SETENV
2223 # if defined(HAS_UNSETENV)
2225 (void)unsetenv(nam);
2227 (void)setenv(nam, val, 1);
2229 # else /* ! HAS_UNSETENV */
2230 (void)setenv(nam, val, 1);
2231 # endif /* HAS_UNSETENV */
2233 # elif defined(HAS_UNSETENV)
2236 if (environ) /* old glibc can crash with null environ */
2237 (void)unsetenv(nam);
2239 const Size_t nlen = strlen(nam);
2240 const Size_t vlen = strlen(val);
2241 char * const new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2242 my_setenv_format(new_env, nam, nlen, val, vlen);
2243 (void)putenv(new_env);
2246 # else /* ! HAS_UNSETENV */
2249 const Size_t nlen = strlen(nam);
2255 new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2256 /* all that work just for this */
2257 my_setenv_format(new_env, nam, nlen, val, vlen);
2258 (void)putenv(new_env);
2260 # endif /* MY_HAS_SETENV */
2262 # ifndef PERL_USE_SAFE_PUTENV
2267 # ifdef __amigaos4__
2269 amigaos4_release_environ(__FUNCTION__);
2273 # else /* WIN32 || NETWARE */
2276 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2280 const Size_t nlen = strlen(nam);
2287 envstr = S_env_alloc(NULL, nlen, vlen, 2, 1);
2288 my_setenv_format(envstr, nam, nlen, val, vlen);
2289 (void)PerlEnv_putenv(envstr);
2290 safesysfree(envstr);
2293 # endif /* WIN32 || NETWARE */
2295 #endif /* USE_ENVIRON_ARRAY */
2300 #ifdef UNLINK_ALL_VERSIONS
2302 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2306 PERL_ARGS_ASSERT_UNLNK;
2308 while (PerlLIO_unlink(f) >= 0)
2310 return retries ? 0 : -1;
2315 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2317 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2325 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2327 PERL_FLUSHALL_FOR_CHILD;
2328 This = (*mode == 'w');
2332 taint_proper("Insecure %s%s", "EXEC");
2334 if (PerlProc_pipe_cloexec(p) < 0)
2336 /* Try for another pipe pair for error return */
2337 if (PerlProc_pipe_cloexec(pp) >= 0)
2339 while ((pid = PerlProc_fork()) < 0) {
2340 if (errno != EAGAIN) {
2341 PerlLIO_close(p[This]);
2342 PerlLIO_close(p[that]);
2344 PerlLIO_close(pp[0]);
2345 PerlLIO_close(pp[1]);
2349 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2358 /* Close parent's end of error status pipe (if any) */
2360 PerlLIO_close(pp[0]);
2361 /* Now dup our end of _the_ pipe to right position */
2362 if (p[THIS] != (*mode == 'r')) {
2363 PerlLIO_dup2(p[THIS], *mode == 'r');
2364 PerlLIO_close(p[THIS]);
2365 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2366 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2369 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2370 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2372 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2373 /* No automatic close - do it by hand */
2380 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2386 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2393 PerlLIO_close(pp[1]);
2394 /* Keep the lower of the two fd numbers */
2395 if (p[that] < p[This]) {
2396 PerlLIO_dup2_cloexec(p[This], p[that]);
2397 PerlLIO_close(p[This]);
2401 PerlLIO_close(p[that]); /* close child's end of pipe */
2403 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2404 SvUPGRADE(sv,SVt_IV);
2406 PL_forkprocess = pid;
2407 /* If we managed to get status pipe check for exec fail */
2408 if (did_pipes && pid > 0) {
2410 unsigned read_total = 0;
2412 while (read_total < sizeof(int)) {
2413 const SSize_t n1 = PerlLIO_read(pp[0],
2414 (void*)(((char*)&errkid)+read_total),
2415 (sizeof(int)) - read_total);
2420 PerlLIO_close(pp[0]);
2422 if (read_total) { /* Error */
2424 PerlLIO_close(p[This]);
2425 if (read_total != sizeof(int))
2426 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", read_total);
2428 pid2 = wait4pid(pid, &status, 0);
2429 } while (pid2 == -1 && errno == EINTR);
2430 errno = errkid; /* Propagate errno from kid */
2435 PerlLIO_close(pp[0]);
2436 return PerlIO_fdopen(p[This], mode);
2438 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2439 return my_syspopen4(aTHX_ NULL, mode, n, args);
2440 # elif defined(WIN32)
2441 return win32_popenlist(mode, n, args);
2443 Perl_croak(aTHX_ "List form of piped open not implemented");
2444 return (PerlIO *) NULL;
2449 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2450 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2452 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2458 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2462 PERL_ARGS_ASSERT_MY_POPEN;
2464 PERL_FLUSHALL_FOR_CHILD;
2467 return my_syspopen(aTHX_ cmd,mode);
2470 This = (*mode == 'w');
2472 if (doexec && TAINTING_get) {
2474 taint_proper("Insecure %s%s", "EXEC");
2476 if (PerlProc_pipe_cloexec(p) < 0)
2478 if (doexec && PerlProc_pipe_cloexec(pp) >= 0)
2480 while ((pid = PerlProc_fork()) < 0) {
2481 if (errno != EAGAIN) {
2482 PerlLIO_close(p[This]);
2483 PerlLIO_close(p[that]);
2485 PerlLIO_close(pp[0]);
2486 PerlLIO_close(pp[1]);
2489 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2492 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2502 PerlLIO_close(pp[0]);
2503 if (p[THIS] != (*mode == 'r')) {
2504 PerlLIO_dup2(p[THIS], *mode == 'r');
2505 PerlLIO_close(p[THIS]);
2506 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2507 PerlLIO_close(p[THAT]);
2510 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2511 PerlLIO_close(p[THAT]);
2515 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2522 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2527 /* may or may not use the shell */
2528 do_exec3(cmd, pp[1], did_pipes);
2531 #endif /* defined OS2 */
2533 #ifdef PERLIO_USING_CRLF
2534 /* Since we circumvent IO layers when we manipulate low-level
2535 filedescriptors directly, need to manually switch to the
2536 default, binary, low-level mode; see PerlIOBuf_open(). */
2537 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2540 #ifdef PERL_USES_PL_PIDSTATUS
2541 hv_clear(PL_pidstatus); /* we have no children */
2548 PerlLIO_close(pp[1]);
2549 if (p[that] < p[This]) {
2550 PerlLIO_dup2_cloexec(p[This], p[that]);
2551 PerlLIO_close(p[This]);
2555 PerlLIO_close(p[that]);
2557 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2558 SvUPGRADE(sv,SVt_IV);
2560 PL_forkprocess = pid;
2561 if (did_pipes && pid > 0) {
2565 while (n < sizeof(int)) {
2566 const SSize_t n1 = PerlLIO_read(pp[0],
2567 (void*)(((char*)&errkid)+n),
2573 PerlLIO_close(pp[0]);
2575 if (n) { /* Error */
2577 PerlLIO_close(p[This]);
2578 if (n != sizeof(int))
2579 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2581 pid2 = wait4pid(pid, &status, 0);
2582 } while (pid2 == -1 && errno == EINTR);
2583 errno = errkid; /* Propagate errno from kid */
2588 PerlLIO_close(pp[0]);
2589 return PerlIO_fdopen(p[This], mode);
2591 #elif defined(DJGPP)
2592 FILE *djgpp_popen();
2594 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2596 PERL_FLUSHALL_FOR_CHILD;
2597 /* Call system's popen() to get a FILE *, then import it.
2598 used 0 for 2nd parameter to PerlIO_importFILE;
2601 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2603 #elif defined(__LIBCATAMOUNT__)
2605 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2610 #endif /* !DOSISH */
2612 /* this is called in parent before the fork() */
2614 Perl_atfork_lock(void)
2615 #if defined(USE_ITHREADS)
2617 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2620 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2622 PERL_TSA_ACQUIRE(PL_op_mutex)
2625 #if defined(USE_ITHREADS)
2627 /* locks must be held in locking order (if any) */
2629 MUTEX_LOCK(&PL_perlio_mutex);
2632 MUTEX_LOCK(&PL_malloc_mutex);
2638 /* this is called in both parent and child after the fork() */
2640 Perl_atfork_unlock(void)
2641 #if defined(USE_ITHREADS)
2643 PERL_TSA_RELEASE(PL_perlio_mutex)
2646 PERL_TSA_RELEASE(PL_malloc_mutex)
2648 PERL_TSA_RELEASE(PL_op_mutex)
2651 #if defined(USE_ITHREADS)
2653 /* locks must be released in same order as in atfork_lock() */
2655 MUTEX_UNLOCK(&PL_perlio_mutex);
2658 MUTEX_UNLOCK(&PL_malloc_mutex);
2667 #if defined(HAS_FORK)
2669 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2674 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2675 * handlers elsewhere in the code */
2679 #elif defined(__amigaos4__)
2680 return amigaos_fork();
2682 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2683 Perl_croak_nocontext("fork() not available");
2685 #endif /* HAS_FORK */
2690 dup2(int oldfd, int newfd)
2692 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2695 PerlLIO_close(newfd);
2696 return fcntl(oldfd, F_DUPFD, newfd);
2698 #define DUP2_MAX_FDS 256
2699 int fdtmp[DUP2_MAX_FDS];
2705 PerlLIO_close(newfd);
2706 /* good enough for low fd's... */
2707 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2708 if (fdx >= DUP2_MAX_FDS) {
2716 PerlLIO_close(fdtmp[--fdx]);
2723 #ifdef HAS_SIGACTION
2728 A wrapper for the C library L<signal(2)>. Don't use the latter, as the Perl
2729 version knows things that interact with the rest of the perl interpreter.
2735 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2737 struct sigaction act, oact;
2741 /* only "parent" interpreter can diddle signals */
2742 if (PL_curinterp != aTHX)
2743 return (Sighandler_t) SIG_ERR;
2746 act.sa_handler = handler;
2747 sigemptyset(&act.sa_mask);
2750 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2751 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2753 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2754 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2755 act.sa_flags |= SA_NOCLDWAIT;
2757 if (sigaction(signo, &act, &oact) == -1)
2758 return (Sighandler_t) SIG_ERR;
2760 return (Sighandler_t) oact.sa_handler;
2764 Perl_rsignal_state(pTHX_ int signo)
2766 struct sigaction oact;
2767 PERL_UNUSED_CONTEXT;
2769 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2770 return (Sighandler_t) SIG_ERR;
2772 return (Sighandler_t) oact.sa_handler;
2776 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2781 struct sigaction act;
2783 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2786 /* only "parent" interpreter can diddle signals */
2787 if (PL_curinterp != aTHX)
2791 act.sa_handler = handler;
2792 sigemptyset(&act.sa_mask);
2795 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2796 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2798 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2799 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2800 act.sa_flags |= SA_NOCLDWAIT;
2802 return sigaction(signo, &act, save);
2806 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2811 PERL_UNUSED_CONTEXT;
2813 /* only "parent" interpreter can diddle signals */
2814 if (PL_curinterp != aTHX)
2818 return sigaction(signo, save, (struct sigaction *)NULL);
2821 #else /* !HAS_SIGACTION */
2824 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2826 #if defined(USE_ITHREADS) && !defined(WIN32)
2827 /* only "parent" interpreter can diddle signals */
2828 if (PL_curinterp != aTHX)
2829 return (Sighandler_t) SIG_ERR;
2832 return PerlProc_signal(signo, handler);
2843 Perl_rsignal_state(pTHX_ int signo)
2846 Sighandler_t oldsig;
2848 #if defined(USE_ITHREADS) && !defined(WIN32)
2849 /* only "parent" interpreter can diddle signals */
2850 if (PL_curinterp != aTHX)
2851 return (Sighandler_t) SIG_ERR;
2855 oldsig = PerlProc_signal(signo, sig_trap);
2856 PerlProc_signal(signo, oldsig);
2858 PerlProc_kill(PerlProc_getpid(), signo);
2863 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2865 #if defined(USE_ITHREADS) && !defined(WIN32)
2866 /* only "parent" interpreter can diddle signals */
2867 if (PL_curinterp != aTHX)
2870 *save = PerlProc_signal(signo, handler);
2871 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2875 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2877 #if defined(USE_ITHREADS) && !defined(WIN32)
2878 /* only "parent" interpreter can diddle signals */
2879 if (PL_curinterp != aTHX)
2882 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2885 #endif /* !HAS_SIGACTION */
2886 #endif /* !PERL_MICRO */
2888 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2889 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2891 Perl_my_pclose(pTHX_ PerlIO *ptr)
2899 const int fd = PerlIO_fileno(ptr);
2902 svp = av_fetch(PL_fdpid,fd,TRUE);
2903 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2907 #if defined(USE_PERLIO)
2908 /* Find out whether the refcount is low enough for us to wait for the
2909 child proc without blocking. */
2910 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
2912 should_wait = pid > 0;
2916 if (pid == -1) { /* Opened by popen. */
2917 return my_syspclose(ptr);
2920 close_failed = (PerlIO_close(ptr) == EOF);
2922 if (should_wait) do {
2923 pid2 = wait4pid(pid, &status, 0);
2924 } while (pid2 == -1 && errno == EINTR);
2931 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2935 #elif defined(__LIBCATAMOUNT__)
2937 Perl_my_pclose(pTHX_ PerlIO *ptr)
2941 #endif /* !DOSISH */
2943 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2945 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
2948 PERL_ARGS_ASSERT_WAIT4PID;
2949 #ifdef PERL_USES_PL_PIDSTATUS
2951 /* PERL_USES_PL_PIDSTATUS is only defined when neither
2952 waitpid() nor wait4() is available, or on OS/2, which
2953 doesn't appear to support waiting for a progress group
2954 member, so we can only treat a 0 pid as an unknown child.
2961 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
2962 pid, rather than a string form. */
2963 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
2964 if (svp && *svp != &PL_sv_undef) {
2965 *statusp = SvIVX(*svp);
2966 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
2974 hv_iterinit(PL_pidstatus);
2975 if ((entry = hv_iternext(PL_pidstatus))) {
2976 SV * const sv = hv_iterval(PL_pidstatus,entry);
2978 const char * const spid = hv_iterkey(entry,&len);
2980 assert (len == sizeof(Pid_t));
2981 memcpy((char *)&pid, spid, len);
2982 *statusp = SvIVX(sv);
2983 /* The hash iterator is currently on this entry, so simply
2984 calling hv_delete would trigger the lazy delete, which on
2985 aggregate does more work, because next call to hv_iterinit()
2986 would spot the flag, and have to call the delete routine,
2987 while in the meantime any new entries can't re-use that
2989 hv_iterinit(PL_pidstatus);
2990 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
2997 # ifdef HAS_WAITPID_RUNTIME
2998 if (!HAS_WAITPID_RUNTIME)
3001 result = PerlProc_waitpid(pid,statusp,flags);
3004 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3005 result = wait4(pid,statusp,flags,NULL);
3008 #ifdef PERL_USES_PL_PIDSTATUS
3009 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3014 Perl_croak(aTHX_ "Can't do waitpid with flags");
3016 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3017 pidgone(result,*statusp);
3023 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3026 if (result < 0 && errno == EINTR) {
3028 errno = EINTR; /* reset in case a signal handler changed $! */
3032 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3034 #ifdef PERL_USES_PL_PIDSTATUS
3036 S_pidgone(pTHX_ Pid_t pid, int status)
3040 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3041 SvUPGRADE(sv,SVt_IV);
3042 SvIV_set(sv, status);
3050 int /* Cannot prototype with I32
3052 my_syspclose(PerlIO *ptr)
3055 Perl_my_pclose(pTHX_ PerlIO *ptr)
3058 /* Needs work for PerlIO ! */
3059 FILE * const f = PerlIO_findFILE(ptr);
3060 const I32 result = pclose(f);
3061 PerlIO_releaseFILE(ptr,f);
3069 Perl_my_pclose(pTHX_ PerlIO *ptr)
3071 /* Needs work for PerlIO ! */
3072 FILE * const f = PerlIO_findFILE(ptr);
3073 I32 result = djgpp_pclose(f);
3074 result = (result << 8) & 0xff00;
3075 PerlIO_releaseFILE(ptr,f);
3080 #define PERL_REPEATCPY_LINEAR 4
3082 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3084 PERL_ARGS_ASSERT_REPEATCPY;
3089 croak_memory_wrap();
3092 memset(to, *from, count);
3095 IV items, linear, half;
3097 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3098 for (items = 0; items < linear; ++items) {
3099 const char *q = from;
3101 for (todo = len; todo > 0; todo--)
3106 while (items <= half) {
3107 IV size = items * len;
3108 memcpy(p, to, size);
3114 memcpy(p, to, (count - items) * len);
3120 Perl_same_dirent(pTHX_ const char *a, const char *b)
3122 char *fa = strrchr(a,'/');
3123 char *fb = strrchr(b,'/');
3126 SV * const tmpsv = sv_newmortal();
3128 PERL_ARGS_ASSERT_SAME_DIRENT;
3141 sv_setpvs(tmpsv, ".");
3143 sv_setpvn(tmpsv, a, fa - a);
3144 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3147 sv_setpvs(tmpsv, ".");
3149 sv_setpvn(tmpsv, b, fb - b);
3150 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3152 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3153 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3155 #endif /* !HAS_RENAME */
3158 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3159 const char *const *const search_ext, I32 flags)
3161 const char *xfound = NULL;
3162 char *xfailed = NULL;
3163 char tmpbuf[MAXPATHLEN];
3168 #if defined(DOSISH) && !defined(OS2)
3169 # define SEARCH_EXTS ".bat", ".cmd", NULL
3170 # define MAX_EXT_LEN 4
3173 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3174 # define MAX_EXT_LEN 4
3177 # define SEARCH_EXTS ".pl", ".com", NULL
3178 # define MAX_EXT_LEN 4
3180 /* additional extensions to try in each dir if scriptname not found */
3182 static const char *const exts[] = { SEARCH_EXTS };
3183 const char *const *const ext = search_ext ? search_ext : exts;
3184 int extidx = 0, i = 0;
3185 const char *curext = NULL;
3187 PERL_UNUSED_ARG(search_ext);
3188 # define MAX_EXT_LEN 0
3191 PERL_ARGS_ASSERT_FIND_SCRIPT;
3194 * If dosearch is true and if scriptname does not contain path
3195 * delimiters, search the PATH for scriptname.
3197 * If SEARCH_EXTS is also defined, will look for each
3198 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3199 * while searching the PATH.
3201 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3202 * proceeds as follows:
3203 * If DOSISH or VMSISH:
3204 * + look for ./scriptname{,.foo,.bar}
3205 * + search the PATH for scriptname{,.foo,.bar}
3208 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3209 * this will not look in '.' if it's not in the PATH)
3214 # ifdef ALWAYS_DEFTYPES
3215 len = strlen(scriptname);
3216 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3217 int idx = 0, deftypes = 1;
3220 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3223 int idx = 0, deftypes = 1;
3226 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3228 /* The first time through, just add SEARCH_EXTS to whatever we
3229 * already have, so we can check for default file types. */
3231 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3238 if ((strlen(tmpbuf) + strlen(scriptname)
3239 + MAX_EXT_LEN) >= sizeof tmpbuf)
3240 continue; /* don't search dir with too-long name */
3241 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3245 if (strEQ(scriptname, "-"))
3247 if (dosearch) { /* Look in '.' first. */
3248 const char *cur = scriptname;
3250 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3252 if (strEQ(ext[i++],curext)) {
3253 extidx = -1; /* already has an ext */
3258 DEBUG_p(PerlIO_printf(Perl_debug_log,
3259 "Looking for %s\n",cur));
3262 if (PerlLIO_stat(cur,&statbuf) >= 0
3263 && !S_ISDIR(statbuf.st_mode)) {
3272 if (cur == scriptname) {
3273 len = strlen(scriptname);
3274 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3276 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3279 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3280 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3285 if (dosearch && !strchr(scriptname, '/')
3287 && !strchr(scriptname, '\\')
3289 && (s = PerlEnv_getenv("PATH")))
3293 bufend = s + strlen(s);
3294 while (s < bufend) {
3298 && *s != ';'; len++, s++) {
3299 if (len < sizeof tmpbuf)
3302 if (len < sizeof tmpbuf)
3305 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3310 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3311 continue; /* don't search dir with too-long name */
3314 && tmpbuf[len - 1] != '/'
3315 && tmpbuf[len - 1] != '\\'
3318 tmpbuf[len++] = '/';
3319 if (len == 2 && tmpbuf[0] == '.')
3321 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3325 len = strlen(tmpbuf);
3326 if (extidx > 0) /* reset after previous loop */
3330 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3331 retval = PerlLIO_stat(tmpbuf,&statbuf);
3332 if (S_ISDIR(statbuf.st_mode)) {
3336 } while ( retval < 0 /* not there */
3337 && extidx>=0 && ext[extidx] /* try an extension? */
3338 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3343 if (S_ISREG(statbuf.st_mode)
3344 && cando(S_IRUSR,TRUE,&statbuf)
3345 #if !defined(DOSISH)
3346 && cando(S_IXUSR,TRUE,&statbuf)
3350 xfound = tmpbuf; /* bingo! */
3354 xfailed = savepv(tmpbuf);
3359 if (!xfound && !seen_dot && !xfailed &&
3360 (PerlLIO_stat(scriptname,&statbuf) < 0
3361 || S_ISDIR(statbuf.st_mode)))
3363 seen_dot = 1; /* Disable message. */
3368 if (flags & 1) { /* do or die? */
3369 /* diag_listed_as: Can't execute %s */
3370 Perl_croak(aTHX_ "Can't %s %s%s%s",
3371 (xfailed ? "execute" : "find"),
3372 (xfailed ? xfailed : scriptname),
3373 (xfailed ? "" : " on PATH"),
3374 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3379 scriptname = xfound;
3381 return (scriptname ? savepv(scriptname) : NULL);
3384 #ifndef PERL_GET_CONTEXT_DEFINED
3387 Perl_get_context(void)
3389 #if defined(USE_ITHREADS)
3391 # ifdef OLD_PTHREADS_API
3393 int error = pthread_getspecific(PL_thr_key, &t);
3395 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3397 # elif defined(I_MACH_CTHREADS)
3398 return (void*)cthread_data(cthread_self());
3400 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3408 Perl_set_context(void *t)
3410 #if defined(USE_ITHREADS)
3413 PERL_ARGS_ASSERT_SET_CONTEXT;
3414 #if defined(USE_ITHREADS)
3415 # ifdef I_MACH_CTHREADS
3416 cthread_set_data(cthread_self(), t);
3419 const int error = pthread_setspecific(PL_thr_key, t);
3421 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3429 #endif /* !PERL_GET_CONTEXT_DEFINED */
3431 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3435 PERL_UNUSED_CONTEXT;
3441 Perl_get_op_names(pTHX)
3443 PERL_UNUSED_CONTEXT;
3444 return (char **)PL_op_name;
3448 Perl_get_op_descs(pTHX)
3450 PERL_UNUSED_CONTEXT;
3451 return (char **)PL_op_desc;
3455 Perl_get_no_modify(pTHX)
3457 PERL_UNUSED_CONTEXT;
3458 return PL_no_modify;
3462 Perl_get_opargs(pTHX)
3464 PERL_UNUSED_CONTEXT;
3465 return (U32 *)PL_opargs;
3469 Perl_get_ppaddr(pTHX)
3472 PERL_UNUSED_CONTEXT;
3473 return (PPADDR_t*)PL_ppaddr;
3476 #ifndef HAS_GETENV_LEN
3478 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3480 char * const env_trans = PerlEnv_getenv(env_elem);
3481 PERL_UNUSED_CONTEXT;
3482 PERL_ARGS_ASSERT_GETENV_LEN;
3484 *len = strlen(env_trans);
3491 Perl_get_vtbl(pTHX_ int vtbl_id)
3493 PERL_UNUSED_CONTEXT;
3495 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3496 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3500 Perl_my_fflush_all(pTHX)
3502 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3503 return PerlIO_flush(NULL);
3505 # if defined(HAS__FWALK)
3506 extern int fflush(FILE *);
3507 /* undocumented, unprototyped, but very useful BSDism */
3508 extern void _fwalk(int (*)(FILE *));
3512 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3514 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3515 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3516 # elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3517 open_max = sysconf(_SC_OPEN_MAX);
3518 # elif defined(FOPEN_MAX)
3519 open_max = FOPEN_MAX;
3520 # elif defined(OPEN_MAX)
3521 open_max = OPEN_MAX;
3522 # elif defined(_NFILE)
3527 for (i = 0; i < open_max; i++)
3528 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3529 STDIO_STREAM_ARRAY[i]._file < open_max &&
3530 STDIO_STREAM_ARRAY[i]._flag)
3531 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3535 SETERRNO(EBADF,RMS_IFI);
3542 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3544 if (ckWARN(WARN_IO)) {
3546 = gv && (isGV_with_GP(gv))
3549 const char * const direction = have == '>' ? "out" : "in";
3551 if (name && HEK_LEN(name))
3552 Perl_warner(aTHX_ packWARN(WARN_IO),
3553 "Filehandle %" HEKf " opened only for %sput",
3554 HEKfARG(name), direction);
3556 Perl_warner(aTHX_ packWARN(WARN_IO),
3557 "Filehandle opened only for %sput", direction);
3562 Perl_report_evil_fh(pTHX_ const GV *gv)
3564 const IO *io = gv ? GvIO(gv) : NULL;
3565 const PERL_BITFIELD16 op = PL_op->op_type;
3569 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3571 warn_type = WARN_CLOSED;
3575 warn_type = WARN_UNOPENED;
3578 if (ckWARN(warn_type)) {
3580 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3581 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3582 const char * const pars =
3583 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3584 const char * const func =
3586 (op == OP_READLINE || op == OP_RCATLINE
3587 ? "readline" : /* "<HANDLE>" not nice */
3588 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3590 const char * const type =
3592 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3593 ? "socket" : "filehandle");
3594 const bool have_name = name && SvCUR(name);
3595 Perl_warner(aTHX_ packWARN(warn_type),
3596 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3597 have_name ? " " : "",
3598 SVfARG(have_name ? name : &PL_sv_no));
3599 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3601 aTHX_ packWARN(warn_type),
3602 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3603 func, pars, have_name ? " " : "",
3604 SVfARG(have_name ? name : &PL_sv_no)
3609 /* To workaround core dumps from the uninitialised tm_zone we get the
3610 * system to give us a reasonable struct to copy. This fix means that
3611 * strftime uses the tm_zone and tm_gmtoff values returned by
3612 * localtime(time()). That should give the desired result most of the
3613 * time. But probably not always!
3615 * This does not address tzname aspects of NETaa14816.
3620 # ifndef STRUCT_TM_HASZONE
3621 # define STRUCT_TM_HASZONE
3625 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3626 # ifndef HAS_TM_TM_ZONE
3627 # define HAS_TM_TM_ZONE
3632 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3634 #ifdef HAS_TM_TM_ZONE
3637 const struct tm* my_tm;
3638 PERL_UNUSED_CONTEXT;
3639 PERL_ARGS_ASSERT_INIT_TM;
3641 ENV_LOCALE_READ_LOCK;
3642 my_tm = localtime(&now);
3644 Copy(my_tm, ptm, 1, struct tm);
3645 ENV_LOCALE_READ_UNLOCK;
3647 PERL_UNUSED_CONTEXT;
3648 PERL_ARGS_ASSERT_INIT_TM;
3649 PERL_UNUSED_ARG(ptm);
3654 * mini_mktime - normalise struct tm values without the localtime()
3655 * semantics (and overhead) of mktime().
3658 Perl_mini_mktime(struct tm *ptm)
3662 int month, mday, year, jday;
3663 int odd_cent, odd_year;
3665 PERL_ARGS_ASSERT_MINI_MKTIME;
3667 #define DAYS_PER_YEAR 365
3668 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3669 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3670 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3671 #define SECS_PER_HOUR (60*60)
3672 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3673 /* parentheses deliberately absent on these two, otherwise they don't work */
3674 #define MONTH_TO_DAYS 153/5
3675 #define DAYS_TO_MONTH 5/153
3676 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3677 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3678 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3679 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3682 * Year/day algorithm notes:
3684 * With a suitable offset for numeric value of the month, one can find
3685 * an offset into the year by considering months to have 30.6 (153/5) days,
3686 * using integer arithmetic (i.e., with truncation). To avoid too much
3687 * messing about with leap days, we consider January and February to be
3688 * the 13th and 14th month of the previous year. After that transformation,
3689 * we need the month index we use to be high by 1 from 'normal human' usage,
3690 * so the month index values we use run from 4 through 15.
3692 * Given that, and the rules for the Gregorian calendar (leap years are those
3693 * divisible by 4 unless also divisible by 100, when they must be divisible
3694 * by 400 instead), we can simply calculate the number of days since some
3695 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3696 * the days we derive from our month index, and adding in the day of the
3697 * month. The value used here is not adjusted for the actual origin which
3698 * it normally would use (1 January A.D. 1), since we're not exposing it.
3699 * We're only building the value so we can turn around and get the
3700 * normalised values for the year, month, day-of-month, and day-of-year.
3702 * For going backward, we need to bias the value we're using so that we find
3703 * the right year value. (Basically, we don't want the contribution of
3704 * March 1st to the number to apply while deriving the year). Having done
3705 * that, we 'count up' the contribution to the year number by accounting for
3706 * full quadracenturies (400-year periods) with their extra leap days, plus
3707 * the contribution from full centuries (to avoid counting in the lost leap
3708 * days), plus the contribution from full quad-years (to count in the normal
3709 * leap days), plus the leftover contribution from any non-leap years.
3710 * At this point, if we were working with an actual leap day, we'll have 0
3711 * days left over. This is also true for March 1st, however. So, we have
3712 * to special-case that result, and (earlier) keep track of the 'odd'
3713 * century and year contributions. If we got 4 extra centuries in a qcent,
3714 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3715 * Otherwise, we add back in the earlier bias we removed (the 123 from
3716 * figuring in March 1st), find the month index (integer division by 30.6),
3717 * and the remainder is the day-of-month. We then have to convert back to
3718 * 'real' months (including fixing January and February from being 14/15 in
3719 * the previous year to being in the proper year). After that, to get
3720 * tm_yday, we work with the normalised year and get a new yearday value for
3721 * January 1st, which we subtract from the yearday value we had earlier,
3722 * representing the date we've re-built. This is done from January 1
3723 * because tm_yday is 0-origin.
3725 * Since POSIX time routines are only guaranteed to work for times since the
3726 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3727 * applies Gregorian calendar rules even to dates before the 16th century
3728 * doesn't bother me. Besides, you'd need cultural context for a given
3729 * date to know whether it was Julian or Gregorian calendar, and that's
3730 * outside the scope for this routine. Since we convert back based on the
3731 * same rules we used to build the yearday, you'll only get strange results
3732 * for input which needed normalising, or for the 'odd' century years which
3733 * were leap years in the Julian calendar but not in the Gregorian one.
3734 * I can live with that.
3736 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3737 * that's still outside the scope for POSIX time manipulation, so I don't
3743 year = 1900 + ptm->tm_year;
3744 month = ptm->tm_mon;
3745 mday = ptm->tm_mday;
3751 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3752 yearday += month*MONTH_TO_DAYS + mday + jday;
3754 * Note that we don't know when leap-seconds were or will be,
3755 * so we have to trust the user if we get something which looks
3756 * like a sensible leap-second. Wild values for seconds will
3757 * be rationalised, however.
3759 if ((unsigned) ptm->tm_sec <= 60) {
3766 secs += 60 * ptm->tm_min;
3767 secs += SECS_PER_HOUR * ptm->tm_hour;
3769 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3770 /* got negative remainder, but need positive time */
3771 /* back off an extra day to compensate */
3772 yearday += (secs/SECS_PER_DAY)-1;
3773 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3776 yearday += (secs/SECS_PER_DAY);
3777 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3780 else if (secs >= SECS_PER_DAY) {
3781 yearday += (secs/SECS_PER_DAY);
3782 secs %= SECS_PER_DAY;
3784 ptm->tm_hour = secs/SECS_PER_HOUR;
3785 secs %= SECS_PER_HOUR;
3786 ptm->tm_min = secs/60;
3788 ptm->tm_sec += secs;
3789 /* done with time of day effects */
3791 * The algorithm for yearday has (so far) left it high by 428.
3792 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3793 * bias it by 123 while trying to figure out what year it
3794 * really represents. Even with this tweak, the reverse
3795 * translation fails for years before A.D. 0001.
3796 * It would still fail for Feb 29, but we catch that one below.
3798 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3799 yearday -= YEAR_ADJUST;
3800 year = (yearday / DAYS_PER_QCENT) * 400;
3801 yearday %= DAYS_PER_QCENT;
3802 odd_cent = yearday / DAYS_PER_CENT;
3803 year += odd_cent * 100;
3804 yearday %= DAYS_PER_CENT;
3805 year += (yearday / DAYS_PER_QYEAR) * 4;
3806 yearday %= DAYS_PER_QYEAR;
3807 odd_year = yearday / DAYS_PER_YEAR;
3809 yearday %= DAYS_PER_YEAR;
3810 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3815 yearday += YEAR_ADJUST; /* recover March 1st crock */
3816 month = yearday*DAYS_TO_MONTH;
3817 yearday -= month*MONTH_TO_DAYS;
3818 /* recover other leap-year adjustment */
3827 ptm->tm_year = year - 1900;
3829 ptm->tm_mday = yearday;
3830 ptm->tm_mon = month;
3834 ptm->tm_mon = month - 1;
3836 /* re-build yearday based on Jan 1 to get tm_yday */
3838 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3839 yearday += 14*MONTH_TO_DAYS + 1;
3840 ptm->tm_yday = jday - yearday;
3841 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3845 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)
3849 /* strftime(), but with a different API so that the return value is a pointer
3850 * to the formatted result (which MUST be arranged to be FREED BY THE
3851 * CALLER). This allows this function to increase the buffer size as needed,
3852 * so that the caller doesn't have to worry about that.
3854 * Note that yday and wday effectively are ignored by this function, as
3855 * mini_mktime() overwrites them */
3862 PERL_ARGS_ASSERT_MY_STRFTIME;
3864 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3867 mytm.tm_hour = hour;
3868 mytm.tm_mday = mday;
3870 mytm.tm_year = year;
3871 mytm.tm_wday = wday;
3872 mytm.tm_yday = yday;
3873 mytm.tm_isdst = isdst;
3875 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3876 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3881 #ifdef HAS_TM_TM_GMTOFF
3882 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3884 #ifdef HAS_TM_TM_ZONE
3885 mytm.tm_zone = mytm2.tm_zone;
3890 Newx(buf, buflen, char);
3892 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3893 len = strftime(buf, buflen, fmt, &mytm);
3894 GCC_DIAG_RESTORE_STMT;
3897 ** The following is needed to handle to the situation where
3898 ** tmpbuf overflows. Basically we want to allocate a buffer
3899 ** and try repeatedly. The reason why it is so complicated
3900 ** is that getting a return value of 0 from strftime can indicate
3901 ** one of the following:
3902 ** 1. buffer overflowed,
3903 ** 2. illegal conversion specifier, or
3904 ** 3. the format string specifies nothing to be returned(not
3905 ** an error). This could be because format is an empty string
3906 ** or it specifies %p that yields an empty string in some locale.
3907 ** If there is a better way to make it portable, go ahead by
3910 if (inRANGE(len, 1, buflen - 1) || (len == 0 && *fmt == '\0'))
3913 /* Possibly buf overflowed - try again with a bigger buf */
3914 const int fmtlen = strlen(fmt);
3915 int bufsize = fmtlen + buflen;
3917 Renew(buf, bufsize, char);
3920 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3921 buflen = strftime(buf, bufsize, fmt, &mytm);
3922 GCC_DIAG_RESTORE_STMT;
3924 if (inRANGE(buflen, 1, bufsize - 1))
3926 /* heuristic to prevent out-of-memory errors */
3927 if (bufsize > 100*fmtlen) {
3933 Renew(buf, bufsize, char);
3938 Perl_croak(aTHX_ "panic: no strftime");
3944 #define SV_CWD_RETURN_UNDEF \
3948 #define SV_CWD_ISDOT(dp) \
3949 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
3950 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
3953 =head1 Miscellaneous Functions
3955 =for apidoc getcwd_sv
3957 Fill C<sv> with current working directory
3962 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
3963 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
3964 * getcwd(3) if available
3965 * Comments from the original:
3966 * This is a faster version of getcwd. It's also more dangerous
3967 * because you might chdir out of a directory that you can't chdir
3971 Perl_getcwd_sv(pTHX_ SV *sv)
3976 PERL_ARGS_ASSERT_GETCWD_SV;
3980 char buf[MAXPATHLEN];
3982 /* Some getcwd()s automatically allocate a buffer of the given
3983 * size from the heap if they are given a NULL buffer pointer.
3984 * The problem is that this behaviour is not portable. */
3985 if (getcwd(buf, sizeof(buf) - 1)) {
3990 SV_CWD_RETURN_UNDEF;
3997 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4001 SvUPGRADE(sv, SVt_PV);
4003 if (PerlLIO_lstat(".", &statbuf) < 0) {
4004 SV_CWD_RETURN_UNDEF;
4007 orig_cdev = statbuf.st_dev;
4008 orig_cino = statbuf.st_ino;
4018 if (PerlDir_chdir("..") < 0) {
4019 SV_CWD_RETURN_UNDEF;
4021 if (PerlLIO_stat(".", &statbuf) < 0) {
4022 SV_CWD_RETURN_UNDEF;
4025 cdev = statbuf.st_dev;
4026 cino = statbuf.st_ino;
4028 if (odev == cdev && oino == cino) {
4031 if (!(dir = PerlDir_open("."))) {
4032 SV_CWD_RETURN_UNDEF;
4035 while ((dp = PerlDir_read(dir)) != NULL) {
4037 namelen = dp->d_namlen;
4039 namelen = strlen(dp->d_name);
4042 if (SV_CWD_ISDOT(dp)) {
4046 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4047 SV_CWD_RETURN_UNDEF;
4050 tdev = statbuf.st_dev;
4051 tino = statbuf.st_ino;
4052 if (tino == oino && tdev == odev) {
4058 SV_CWD_RETURN_UNDEF;
4061 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4062 SV_CWD_RETURN_UNDEF;
4065 SvGROW(sv, pathlen + namelen + 1);
4069 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4072 /* prepend current directory to the front */
4074 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4075 pathlen += (namelen + 1);
4077 #ifdef VOID_CLOSEDIR
4080 if (PerlDir_close(dir) < 0) {
4081 SV_CWD_RETURN_UNDEF;
4087 SvCUR_set(sv, pathlen);
4091 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4092 SV_CWD_RETURN_UNDEF;
4095 if (PerlLIO_stat(".", &statbuf) < 0) {
4096 SV_CWD_RETURN_UNDEF;
4099 cdev = statbuf.st_dev;
4100 cino = statbuf.st_ino;
4102 if (cdev != orig_cdev || cino != orig_cino) {
4103 Perl_croak(aTHX_ "Unstable directory path, "
4104 "current directory changed unexpectedly");
4117 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4118 # define EMULATE_SOCKETPAIR_UDP
4121 #ifdef EMULATE_SOCKETPAIR_UDP
4123 S_socketpair_udp (int fd[2]) {
4125 /* Fake a datagram socketpair using UDP to localhost. */
4126 int sockets[2] = {-1, -1};
4127 struct sockaddr_in addresses[2];
4129 Sock_size_t size = sizeof(struct sockaddr_in);
4130 unsigned short port;
4133 memset(&addresses, 0, sizeof(addresses));
4136 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4137 if (sockets[i] == -1)
4138 goto tidy_up_and_fail;
4140 addresses[i].sin_family = AF_INET;
4141 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4142 addresses[i].sin_port = 0; /* kernel choses port. */
4143 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4144 sizeof(struct sockaddr_in)) == -1)
4145 goto tidy_up_and_fail;
4148 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4149 for each connect the other socket to it. */
4152 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4154 goto tidy_up_and_fail;
4155 if (size != sizeof(struct sockaddr_in))
4156 goto abort_tidy_up_and_fail;
4157 /* !1 is 0, !0 is 1 */
4158 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4159 sizeof(struct sockaddr_in)) == -1)
4160 goto tidy_up_and_fail;
4163 /* Now we have 2 sockets connected to each other. I don't trust some other
4164 process not to have already sent a packet to us (by random) so send
4165 a packet from each to the other. */
4168 /* I'm going to send my own port number. As a short.
4169 (Who knows if someone somewhere has sin_port as a bitfield and needs
4170 this routine. (I'm assuming crays have socketpair)) */
4171 port = addresses[i].sin_port;
4172 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4173 if (got != sizeof(port)) {
4175 goto tidy_up_and_fail;
4176 goto abort_tidy_up_and_fail;
4180 /* Packets sent. I don't trust them to have arrived though.
4181 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4182 connect to localhost will use a second kernel thread. In 2.6 the
4183 first thread running the connect() returns before the second completes,
4184 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4185 returns 0. Poor programs have tripped up. One poor program's authors'
4186 had a 50-1 reverse stock split. Not sure how connected these were.)
4187 So I don't trust someone not to have an unpredictable UDP stack.
4191 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4192 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4196 FD_SET((unsigned int)sockets[0], &rset);
4197 FD_SET((unsigned int)sockets[1], &rset);
4199 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4200 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4201 || !FD_ISSET(sockets[1], &rset)) {
4202 /* I hope this is portable and appropriate. */
4204 goto tidy_up_and_fail;
4205 goto abort_tidy_up_and_fail;
4209 /* And the paranoia department even now doesn't trust it to have arrive
4210 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4212 struct sockaddr_in readfrom;
4213 unsigned short buffer[2];
4218 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4219 sizeof(buffer), MSG_DONTWAIT,
4220 (struct sockaddr *) &readfrom, &size);
4222 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4224 (struct sockaddr *) &readfrom, &size);
4228 goto tidy_up_and_fail;
4229 if (got != sizeof(port)
4230 || size != sizeof(struct sockaddr_in)
4231 /* Check other socket sent us its port. */
4232 || buffer[0] != (unsigned short) addresses[!i].sin_port
4233 /* Check kernel says we got the datagram from that socket */
4234 || readfrom.sin_family != addresses[!i].sin_family
4235 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4236 || readfrom.sin_port != addresses[!i].sin_port)
4237 goto abort_tidy_up_and_fail;
4240 /* My caller (my_socketpair) has validated that this is non-NULL */
4243 /* I hereby declare this connection open. May God bless all who cross
4247 abort_tidy_up_and_fail:
4248 errno = ECONNABORTED;
4252 if (sockets[0] != -1)
4253 PerlLIO_close(sockets[0]);
4254 if (sockets[1] != -1)
4255 PerlLIO_close(sockets[1]);
4260 #endif /* EMULATE_SOCKETPAIR_UDP */
4262 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4264 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4265 /* Stevens says that family must be AF_LOCAL, protocol 0.
4266 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4271 struct sockaddr_in listen_addr;
4272 struct sockaddr_in connect_addr;
4277 || family != AF_UNIX
4280 errno = EAFNOSUPPORT;
4289 type &= ~SOCK_CLOEXEC;
4292 #ifdef EMULATE_SOCKETPAIR_UDP
4293 if (type == SOCK_DGRAM)
4294 return S_socketpair_udp(fd);
4297 aTHXa(PERL_GET_THX);
4298 listener = PerlSock_socket(AF_INET, type, 0);
4301 memset(&listen_addr, 0, sizeof(listen_addr));
4302 listen_addr.sin_family = AF_INET;
4303 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4304 listen_addr.sin_port = 0; /* kernel choses port. */
4305 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4306 sizeof(listen_addr)) == -1)
4307 goto tidy_up_and_fail;
4308 if (PerlSock_listen(listener, 1) == -1)
4309 goto tidy_up_and_fail;
4311 connector = PerlSock_socket(AF_INET, type, 0);
4312 if (connector == -1)
4313 goto tidy_up_and_fail;
4314 /* We want to find out the port number to connect to. */
4315 size = sizeof(connect_addr);
4316 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4318 goto tidy_up_and_fail;
4319 if (size != sizeof(connect_addr))
4320 goto abort_tidy_up_and_fail;
4321 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4322 sizeof(connect_addr)) == -1)
4323 goto tidy_up_and_fail;
4325 size = sizeof(listen_addr);
4326 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4329 goto tidy_up_and_fail;
4330 if (size != sizeof(listen_addr))
4331 goto abort_tidy_up_and_fail;
4332 PerlLIO_close(listener);
4333 /* Now check we are talking to ourself by matching port and host on the
4335 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4337 goto tidy_up_and_fail;
4338 if (size != sizeof(connect_addr)
4339 || listen_addr.sin_family != connect_addr.sin_family
4340 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4341 || listen_addr.sin_port != connect_addr.sin_port) {
4342 goto abort_tidy_up_and_fail;
4348 abort_tidy_up_and_fail:
4350 errno = ECONNABORTED; /* This would be the standard thing to do. */
4351 #elif defined(ECONNREFUSED)
4352 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4354 errno = ETIMEDOUT; /* Desperation time. */
4360 PerlLIO_close(listener);
4361 if (connector != -1)
4362 PerlLIO_close(connector);
4364 PerlLIO_close(acceptor);
4370 /* In any case have a stub so that there's code corresponding
4371 * to the my_socketpair in embed.fnc. */
4373 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4374 #ifdef HAS_SOCKETPAIR
4375 return socketpair(family, type, protocol, fd);
4384 =for apidoc sv_nosharing
4386 Dummy routine which "shares" an SV when there is no sharing module present.
4387 Or "locks" it. Or "unlocks" it. In other
4388 words, ignores its single SV argument.
4389 Exists to avoid test for a C<NULL> function pointer and because it could
4390 potentially warn under some level of strict-ness.
4396 Perl_sv_nosharing(pTHX_ SV *sv)
4398 PERL_UNUSED_CONTEXT;
4399 PERL_UNUSED_ARG(sv);
4404 =for apidoc sv_destroyable
4406 Dummy routine which reports that object can be destroyed when there is no
4407 sharing module present. It ignores its single SV argument, and returns
4408 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4409 could potentially warn under some level of strict-ness.
4415 Perl_sv_destroyable(pTHX_ SV *sv)
4417 PERL_UNUSED_CONTEXT;
4418 PERL_UNUSED_ARG(sv);
4423 Perl_parse_unicode_opts(pTHX_ const char **popt)
4425 const char *p = *popt;
4428 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4432 const char* endptr = p + strlen(p);
4434 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4437 if (p && *p && *p != '\n' && *p != '\r') {
4439 goto the_end_of_the_opts_parser;
4441 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4445 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4451 case PERL_UNICODE_STDIN:
4452 opt |= PERL_UNICODE_STDIN_FLAG; break;
4453 case PERL_UNICODE_STDOUT:
4454 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4455 case PERL_UNICODE_STDERR:
4456 opt |= PERL_UNICODE_STDERR_FLAG; break;
4457 case PERL_UNICODE_STD:
4458 opt |= PERL_UNICODE_STD_FLAG; break;
4459 case PERL_UNICODE_IN:
4460 opt |= PERL_UNICODE_IN_FLAG; break;
4461 case PERL_UNICODE_OUT:
4462 opt |= PERL_UNICODE_OUT_FLAG; break;
4463 case PERL_UNICODE_INOUT:
4464 opt |= PERL_UNICODE_INOUT_FLAG; break;
4465 case PERL_UNICODE_LOCALE:
4466 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4467 case PERL_UNICODE_ARGV:
4468 opt |= PERL_UNICODE_ARGV_FLAG; break;
4469 case PERL_UNICODE_UTF8CACHEASSERT:
4470 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4472 if (*p != '\n' && *p != '\r') {
4473 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4476 "Unknown Unicode option letter '%c'", *p);
4483 opt = PERL_UNICODE_DEFAULT_FLAGS;
4485 the_end_of_the_opts_parser:
4487 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4488 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4489 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4497 # include <starlet.h>
4504 * This is really just a quick hack which grabs various garbage
4505 * values. It really should be a real hash algorithm which
4506 * spreads the effect of every input bit onto every output bit,
4507 * if someone who knows about such things would bother to write it.
4508 * Might be a good idea to add that function to CORE as well.
4509 * No numbers below come from careful analysis or anything here,
4510 * except they are primes and SEED_C1 > 1E6 to get a full-width
4511 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4512 * probably be bigger too.
4515 # define SEED_C1 1000003
4516 #define SEED_C4 73819
4518 # define SEED_C1 25747
4519 #define SEED_C4 20639
4523 #define SEED_C5 26107
4525 #ifndef PERL_NO_DEV_RANDOM
4529 #ifdef HAS_GETTIMEOFDAY
4530 struct timeval when;
4535 /* This test is an escape hatch, this symbol isn't set by Configure. */
4536 #ifndef PERL_NO_DEV_RANDOM
4537 #ifndef PERL_RANDOM_DEVICE
4538 /* /dev/random isn't used by default because reads from it will block
4539 * if there isn't enough entropy available. You can compile with
4540 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4541 * is enough real entropy to fill the seed. */
4542 # ifdef __amigaos4__
4543 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4545 # define PERL_RANDOM_DEVICE "/dev/urandom"
4548 fd = PerlLIO_open_cloexec(PERL_RANDOM_DEVICE, 0);
4550 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4558 #ifdef HAS_GETTIMEOFDAY
4559 PerlProc_gettimeofday(&when,NULL);
4560 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4563 u = (U32)SEED_C1 * when;
4565 u += SEED_C3 * (U32)PerlProc_getpid();
4566 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4567 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4568 u += SEED_C5 * (U32)PTR2UV(&when);
4574 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4576 #ifndef NO_PERL_HASH_ENV
4581 PERL_ARGS_ASSERT_GET_HASH_SEED;
4583 #ifndef NO_PERL_HASH_ENV
4584 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4588 /* ignore leading spaces */
4589 while (isSPACE(*env_pv))
4591 # ifdef USE_PERL_PERTURB_KEYS
4592 /* if they set it to "0" we disable key traversal randomization completely */
4593 if (strEQ(env_pv,"0")) {
4594 PL_hash_rand_bits_enabled= 0;
4596 /* otherwise switch to deterministic mode */
4597 PL_hash_rand_bits_enabled= 2;
4600 /* ignore a leading 0x... if it is there */
4601 if (env_pv[0] == '0' && env_pv[1] == 'x')
4604 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4605 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4606 if ( isXDIGIT(*env_pv)) {
4607 seed_buffer[i] |= READ_XDIGIT(env_pv);
4610 while (isSPACE(*env_pv))
4613 if (*env_pv && !isXDIGIT(*env_pv)) {
4614 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4616 /* should we check for unparsed crap? */
4617 /* should we warn about unused hex? */
4618 /* should we warn about insufficient hex? */
4621 #endif /* NO_PERL_HASH_ENV */
4623 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4624 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
4627 #ifdef USE_PERL_PERTURB_KEYS
4628 { /* initialize PL_hash_rand_bits from the hash seed.
4629 * This value is highly volatile, it is updated every
4630 * hash insert, and is used as part of hash bucket chain
4631 * randomization and hash iterator randomization. */
4632 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4633 for( i = 0; i < sizeof(UV) ; i++ ) {
4634 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4635 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4638 # ifndef NO_PERL_HASH_ENV
4639 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4641 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4642 PL_hash_rand_bits_enabled= 0;
4643 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4644 PL_hash_rand_bits_enabled= 1;
4645 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4646 PL_hash_rand_bits_enabled= 2;
4648 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4655 #ifdef PERL_GLOBAL_STRUCT
4657 #define PERL_GLOBAL_STRUCT_INIT
4658 #include "opcode.h" /* the ppaddr and check */
4661 Perl_init_global_struct(pTHX)
4663 struct perl_vars *plvarsp = NULL;
4664 # ifdef PERL_GLOBAL_STRUCT
4665 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4666 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4667 PERL_UNUSED_CONTEXT;
4668 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4669 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4670 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4674 plvarsp = PL_VarsPtr;
4675 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4680 # define PERLVAR(prefix,var,type) /**/
4681 # define PERLVARA(prefix,var,n,type) /**/
4682 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4683 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4684 # include "perlvars.h"
4689 # ifdef PERL_GLOBAL_STRUCT
4692 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4693 if (!plvarsp->Gppaddr)
4697 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4698 if (!plvarsp->Gcheck)
4700 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4701 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4703 # ifdef PERL_SET_VARS
4704 PERL_SET_VARS(plvarsp);
4706 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4707 plvarsp->Gsv_placeholder.sv_flags = 0;
4708 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4710 # undef PERL_GLOBAL_STRUCT_INIT
4715 #endif /* PERL_GLOBAL_STRUCT */
4717 #ifdef PERL_GLOBAL_STRUCT
4720 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4722 int veto = plvarsp->Gveto_cleanup;
4724 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4725 PERL_UNUSED_CONTEXT;
4726 # ifdef PERL_GLOBAL_STRUCT
4727 # ifdef PERL_UNSET_VARS
4728 PERL_UNSET_VARS(plvarsp);
4732 free(plvarsp->Gppaddr);
4733 free(plvarsp->Gcheck);
4734 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4740 #endif /* PERL_GLOBAL_STRUCT */
4744 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4745 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4746 * given, and you supply your own implementation.
4748 * The default implementation reads a single env var, PERL_MEM_LOG,
4749 * expecting one or more of the following:
4751 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4752 * 'm' - memlog was PERL_MEM_LOG=1
4753 * 's' - svlog was PERL_SV_LOG=1
4754 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4756 * This makes the logger controllable enough that it can reasonably be
4757 * added to the system perl.
4760 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4761 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4763 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4765 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4766 * writes to. In the default logger, this is settable at runtime.
4768 #ifndef PERL_MEM_LOG_FD
4769 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4772 #ifndef PERL_MEM_LOG_NOIMPL
4774 # ifdef DEBUG_LEAKING_SCALARS
4775 # define SV_LOG_SERIAL_FMT " [%lu]"
4776 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4778 # define SV_LOG_SERIAL_FMT
4779 # define _SV_LOG_SERIAL_ARG(sv)
4783 S_mem_log_common(enum mem_log_type mlt, const UV n,
4784 const UV typesize, const char *type_name, const SV *sv,
4785 Malloc_t oldalloc, Malloc_t newalloc,
4786 const char *filename, const int linenumber,
4787 const char *funcname)
4791 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4793 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4796 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4798 /* We can't use SVs or PerlIO for obvious reasons,
4799 * so we'll use stdio and low-level IO instead. */
4800 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4802 # ifdef HAS_GETTIMEOFDAY
4803 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4804 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4806 gettimeofday(&tv, 0);
4808 # define MEM_LOG_TIME_FMT "%10d: "
4809 # define MEM_LOG_TIME_ARG (int)when
4813 /* If there are other OS specific ways of hires time than
4814 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4815 * probably that they would be used to fill in the struct
4819 const char* endptr = pmlenv + strlen(pmlenv);
4822 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4823 && uv && uv <= PERL_INT_MAX
4827 fd = PERL_MEM_LOG_FD;
4830 if (strchr(pmlenv, 't')) {
4831 len = my_snprintf(buf, sizeof(buf),
4832 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4833 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4837 len = my_snprintf(buf, sizeof(buf),
4838 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4839 " %s = %" IVdf ": %" UVxf "\n",
4840 filename, linenumber, funcname, n, typesize,
4841 type_name, n * typesize, PTR2UV(newalloc));
4844 len = my_snprintf(buf, sizeof(buf),
4845 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4846 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4847 filename, linenumber, funcname, n, typesize,
4848 type_name, n * typesize, PTR2UV(oldalloc),
4852 len = my_snprintf(buf, sizeof(buf),
4853 "free: %s:%d:%s: %" UVxf "\n",
4854 filename, linenumber, funcname,
4859 len = my_snprintf(buf, sizeof(buf),
4860 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
4861 mlt == MLT_NEW_SV ? "new" : "del",
4862 filename, linenumber, funcname,
4863 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4868 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4872 #endif /* !PERL_MEM_LOG_NOIMPL */
4874 #ifndef PERL_MEM_LOG_NOIMPL
4876 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4877 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4879 /* this is suboptimal, but bug compatible. User is providing their
4880 own implementation, but is getting these functions anyway, and they
4881 do nothing. But _NOIMPL users should be able to cope or fix */
4883 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4884 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
4888 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4890 const char *filename, const int linenumber,
4891 const char *funcname)
4893 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
4895 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4896 NULL, NULL, newalloc,
4897 filename, linenumber, funcname);
4902 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4903 Malloc_t oldalloc, Malloc_t newalloc,
4904 const char *filename, const int linenumber,
4905 const char *funcname)
4907 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
4909 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4910 NULL, oldalloc, newalloc,
4911 filename, linenumber, funcname);
4916 Perl_mem_log_free(Malloc_t oldalloc,
4917 const char *filename, const int linenumber,
4918 const char *funcname)
4920 PERL_ARGS_ASSERT_MEM_LOG_FREE;
4922 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4923 filename, linenumber, funcname);
4928 Perl_mem_log_new_sv(const SV *sv,
4929 const char *filename, const int linenumber,
4930 const char *funcname)
4932 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4933 filename, linenumber, funcname);
4937 Perl_mem_log_del_sv(const SV *sv,
4938 const char *filename, const int linenumber,
4939 const char *funcname)
4941 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4942 filename, linenumber, funcname);
4945 #endif /* PERL_MEM_LOG */
4948 =for apidoc quadmath_format_valid
4950 C<quadmath_snprintf()> is very strict about its C<format> string and will
4951 fail, returning -1, if the format is invalid. It accepts exactly
4954 C<quadmath_format_valid()> checks that the intended single spec looks
4955 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
4956 and has C<Q> before it. This is not a full "printf syntax check",
4959 Returns true if it is valid, false if not.
4961 See also L</quadmath_format_needed>.
4967 Perl_quadmath_format_valid(const char* format)
4971 PERL_ARGS_ASSERT_QUADMATH_FORMAT_VALID;
4973 if (format[0] != '%' || strchr(format + 1, '%'))
4975 len = strlen(format);
4976 /* minimum length three: %Qg */
4977 if (len < 3 || memCHRs("efgaEFGA", format[len - 1]) == NULL)
4979 if (format[len - 2] != 'Q')
4986 =for apidoc quadmath_format_needed
4988 C<quadmath_format_needed()> returns true if the C<format> string seems to
4989 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
4990 or returns false otherwise.
4992 The format specifier detection is not complete printf-syntax detection,
4993 but it should catch most common cases.
4995 If true is returned, those arguments B<should> in theory be processed
4996 with C<quadmath_snprintf()>, but in case there is more than one such
4997 format specifier (see L</quadmath_format_valid>), and if there is
4998 anything else beyond that one (even just a single byte), they
4999 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
5000 accepting only one format spec, and nothing else.
5001 In this case, the code should probably fail.
5007 Perl_quadmath_format_needed(const char* format)
5009 const char *p = format;
5012 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5014 while ((q = strchr(p, '%'))) {
5016 if (*q == '+') /* plus */
5018 if (*q == '#') /* alt */
5020 if (*q == '*') /* width */
5024 while (isDIGIT(*q)) q++;
5027 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5032 while (isDIGIT(*q)) q++;
5034 if (memCHRs("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5043 =for apidoc my_snprintf
5045 The C library C<snprintf> functionality, if available and
5046 standards-compliant (uses C<vsnprintf>, actually). However, if the
5047 C<vsnprintf> is not available, will unfortunately use the unsafe
5048 C<vsprintf> which can overrun the buffer (there is an overrun check,
5049 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5050 getting C<vsnprintf>.
5055 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5059 PERL_ARGS_ASSERT_MY_SNPRINTF;
5060 #ifndef HAS_VSNPRINTF
5061 PERL_UNUSED_VAR(len);
5063 va_start(ap, format);
5066 bool quadmath_valid = FALSE;
5067 if (quadmath_format_valid(format)) {
5068 /* If the format looked promising, use it as quadmath. */
5069 retval = quadmath_snprintf(buffer, len, format, va_arg(ap, NV));
5071 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5073 quadmath_valid = TRUE;
5075 /* quadmath_format_single() will return false for example for
5076 * "foo = %g", or simply "%g". We could handle the %g by
5077 * using quadmath for the NV args. More complex cases of
5078 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5079 * quadmath-valid but has stuff in front).
5081 * Handling the "Q-less" cases right would require walking
5082 * through the va_list and rewriting the format, calling
5083 * quadmath for the NVs, building a new va_list, and then
5084 * letting vsnprintf/vsprintf to take care of the other
5085 * arguments. This may be doable.
5087 * We do not attempt that now. But for paranoia, we here try
5088 * to detect some common (but not all) cases where the
5089 * "Q-less" %[efgaEFGA] formats are present, and die if
5090 * detected. This doesn't fix the problem, but it stops the
5091 * vsnprintf/vsprintf pulling doubles off the va_list when
5092 * __float128 NVs should be pulled off instead.
5094 * If quadmath_format_needed() returns false, we are reasonably
5095 * certain that we can call vnsprintf() or vsprintf() safely. */
5096 if (!quadmath_valid && quadmath_format_needed(format))
5097 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5102 #ifdef HAS_VSNPRINTF
5103 retval = vsnprintf(buffer, len, format, ap);
5105 retval = vsprintf(buffer, format, ap);
5108 /* vsprintf() shows failure with < 0 */
5110 #ifdef HAS_VSNPRINTF
5111 /* vsnprintf() shows failure with >= len */
5113 (len > 0 && (Size_t)retval >= len)
5116 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5121 =for apidoc my_vsnprintf
5123 The C library C<vsnprintf> if available and standards-compliant.
5124 However, if the C<vsnprintf> is not available, will unfortunately
5125 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5126 overrun check, but that may be too late). Consider using
5127 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5132 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5135 PERL_UNUSED_ARG(buffer);
5136 PERL_UNUSED_ARG(len);
5137 PERL_UNUSED_ARG(format);
5138 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5139 PERL_UNUSED_ARG((void*)ap);
5140 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5147 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5148 Perl_va_copy(ap, apc);
5149 # ifdef HAS_VSNPRINTF
5150 retval = vsnprintf(buffer, len, format, apc);
5152 PERL_UNUSED_ARG(len);
5153 retval = vsprintf(buffer, format, apc);
5157 # ifdef HAS_VSNPRINTF
5158 retval = vsnprintf(buffer, len, format, ap);
5160 PERL_UNUSED_ARG(len);
5161 retval = vsprintf(buffer, format, ap);
5163 #endif /* #ifdef NEED_VA_COPY */
5164 /* vsprintf() shows failure with < 0 */
5166 #ifdef HAS_VSNPRINTF
5167 /* vsnprintf() shows failure with >= len */
5169 (len > 0 && (Size_t)retval >= len)
5172 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5178 Perl_my_clearenv(pTHX)
5181 #if ! defined(PERL_MICRO)
5182 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5184 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5185 # if defined(USE_ENVIRON_ARRAY)
5186 # if defined(USE_ITHREADS)
5187 /* only the parent thread can clobber the process environment, so no need
5189 if (PL_curinterp == aTHX)
5190 # endif /* USE_ITHREADS */
5192 # if ! defined(PERL_USE_SAFE_PUTENV)
5193 if ( !PL_use_safe_putenv) {
5195 if (environ == PL_origenviron)
5196 environ = (char**)safesysmalloc(sizeof(char*));
5198 for (i = 0; environ[i]; i++)
5199 (void)safesysfree(environ[i]);
5202 # else /* PERL_USE_SAFE_PUTENV */
5203 # if defined(HAS_CLEARENV)
5205 # elif defined(HAS_UNSETENV)
5206 int bsiz = 80; /* Most envvar names will be shorter than this. */
5207 char *buf = (char*)safesysmalloc(bsiz);
5208 while (*environ != NULL) {
5209 char *e = strchr(*environ, '=');
5210 int l = e ? e - *environ : (int)strlen(*environ);
5212 (void)safesysfree(buf);
5213 bsiz = l + 1; /* + 1 for the \0. */
5214 buf = (char*)safesysmalloc(bsiz);
5216 memcpy(buf, *environ, l);
5218 (void)unsetenv(buf);
5220 (void)safesysfree(buf);
5221 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5222 /* Just null environ and accept the leakage. */
5224 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5225 # endif /* ! PERL_USE_SAFE_PUTENV */
5227 # endif /* USE_ENVIRON_ARRAY */
5228 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5229 #endif /* PERL_MICRO */
5232 #ifdef PERL_IMPLICIT_CONTEXT
5235 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5237 /* rather than each module having a static var holding its index,
5238 * use a global array of name to index mappings
5241 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5246 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5248 for (index = 0; index < PL_my_cxt_index; index++) {
5249 const char *key = PL_my_cxt_keys[index];
5250 /* try direct pointer compare first - there are chances to success,
5251 * and it's much faster.
5253 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5261 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5262 the global PL_my_cxt_index is incremented, and that value is assigned to
5263 that module's static my_cxt_index (who's address is passed as an arg).
5264 Then, for each interpreter this function is called for, it makes sure a
5265 void* slot is available to hang the static data off, by allocating or
5266 extending the interpreter's PL_my_cxt_list array */
5269 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5270 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5272 Perl_my_cxt_init(pTHX_ int *indexp, size_t size)
5279 PERL_ARGS_ASSERT_MY_CXT_INIT;
5281 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5282 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5286 /* do initial check without locking.
5287 * -1: not allocated or another thread currently allocating
5288 * other: already allocated by another thread
5291 MUTEX_LOCK(&PL_my_ctx_mutex);
5292 /*now a stricter check with locking */
5293 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5294 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5299 /* this module hasn't been allocated an index yet */
5300 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5301 index = PL_my_cxt_index++;
5303 /* Store the index in a global MY_CXT_KEY string to index mapping
5304 * table. This emulates the perl-module static my_cxt_index var on
5305 * builds which don't allow static vars */
5306 if (PL_my_cxt_keys_size <= index) {
5307 int old_size = PL_my_cxt_keys_size;
5309 if (PL_my_cxt_keys_size) {
5310 IV new_size = PL_my_cxt_keys_size;
5311 while (new_size <= index)
5313 PL_my_cxt_keys = (const char **)PerlMemShared_realloc(
5315 new_size * sizeof(const char *));
5316 PL_my_cxt_keys_size = new_size;
5319 PL_my_cxt_keys_size = 16;
5320 PL_my_cxt_keys = (const char **)PerlMemShared_malloc(
5321 PL_my_cxt_keys_size * sizeof(const char *));
5323 for (i = old_size; i < PL_my_cxt_keys_size; i++) {
5324 PL_my_cxt_keys[i] = 0;
5327 PL_my_cxt_keys[index] = my_cxt_key;
5329 *indexp = PL_my_cxt_index++;
5332 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5335 /* make sure the array is big enough */
5336 if (PL_my_cxt_size <= index) {
5337 if (PL_my_cxt_size) {
5338 IV new_size = PL_my_cxt_size;
5339 while (new_size <= index)
5341 Renew(PL_my_cxt_list, new_size, void *);
5342 PL_my_cxt_size = new_size;
5345 PL_my_cxt_size = 16;
5346 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5349 /* newSV() allocates one more than needed */
5350 p = (void*)SvPVX(newSV(size-1));
5351 PL_my_cxt_list[index] = p;
5352 Zero(p, size, char);
5356 #endif /* PERL_IMPLICIT_CONTEXT */
5359 /* Perl_xs_handshake():
5360 implement the various XS_*_BOOTCHECK macros, which are added to .c
5361 files by ExtUtils::ParseXS, to check that the perl the module was built
5362 with is binary compatible with the running perl.
5365 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5366 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5368 The meaning of the varargs is determined the U32 key arg (which is not
5369 a format string). The fields of key are assembled by using HS_KEY().
5371 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5372 "PerlInterpreter *" and represents the callers context; otherwise it is
5373 of type "CV *", and is the boot xsub's CV.
5375 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5376 for example, and IO.dll was linked with threaded perl524.dll, and both
5377 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5378 successfully can load IO.dll into the process but simultaneously it
5379 loaded an interpreter of a different version into the process, and XS
5380 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5381 use through perl526.dll's my_perl->Istack_base.
5383 v_my_perl cannot be the first arg, since then 'key' will be out of
5384 place in a threaded vs non-threaded mixup; and analyzing the key
5385 number's bitfields won't reveal the problem, since it will be a valid
5386 key (unthreaded perl) on interp side, but croak will report the XS mod's
5387 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5388 it's a threaded perl and an unthreaded XS module, threaded perl will
5389 look at an uninit C stack or an uninit register to get 'key'
5390 (remember that it assumes that the 1st arg is the interp cxt).
5392 'file' is the source filename of the caller.
5396 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5402 #ifdef PERL_IMPLICIT_CONTEXT
5409 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5410 va_start(args, file);
5412 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5413 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5414 if (UNLIKELY(got != need))
5416 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5417 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5418 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5419 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5420 passed to the XS DLL */
5421 #ifdef PERL_IMPLICIT_CONTEXT
5422 xs_interp = (tTHX)v_my_perl;
5426 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5427 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5428 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5429 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5430 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5431 location in the unthreaded perl binary) stored in CV * to figure out if this
5432 Perl_xs_handshake was called by the same pp_entersub */
5433 cv = (CV*)v_my_perl;
5434 xs_spp = (SV***)CvHSCXT(cv);
5436 need = &PL_stack_sp;
5438 if(UNLIKELY(got != need)) {
5439 bad_handshake:/* recycle branch and string from above */
5440 if(got != (void *)HSf_NOCHK)
5441 noperl_die("%s: loadable library and perl binaries are mismatched"
5442 " (got handshake key %p, needed %p)\n",
5446 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5447 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5448 PL_xsubfilename = file; /* so the old name must be restored for
5449 additional XSUBs to register themselves */
5450 /* XSUBs can't be perl lang/perl5db.pl debugged
5451 if (PERLDB_LINE_OR_SAVESRC)
5452 (void)gv_fetchfile(file); */
5455 if(key & HSf_POPMARK) {
5457 { SV **mark = PL_stack_base + ax++;
5459 items = (I32)(SP - MARK);
5463 items = va_arg(args, U32);
5464 ax = va_arg(args, U32);
5468 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5469 if((apiverlen = HS_GETAPIVERLEN(key))) {
5470 char * api_p = va_arg(args, char*);
5471 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5472 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5473 sizeof("v" PERL_API_VERSION_STRING)-1))
5474 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5475 api_p, SVfARG(PL_stack_base[ax + 0]),
5476 "v" PERL_API_VERSION_STRING);
5481 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5482 if((xsverlen = HS_GETXSVERLEN(key)))
5483 S_xs_version_bootcheck(aTHX_
5484 items, ax, va_arg(args, char*), xsverlen);
5492 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5496 const char *vn = NULL;
5497 SV *const module = PL_stack_base[ax];
5499 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5501 if (items >= 2) /* version supplied as bootstrap arg */
5502 sv = PL_stack_base[ax + 1];
5504 /* XXX GV_ADDWARN */
5506 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5507 if (!sv || !SvOK(sv)) {
5509 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5513 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5514 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5515 ? sv : sv_2mortal(new_version(sv));
5516 xssv = upg_version(xssv, 0);
5517 if ( vcmp(pmsv,xssv) ) {
5518 SV *string = vstringify(xssv);
5519 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5520 " does not match ", SVfARG(module), SVfARG(string));
5522 SvREFCNT_dec(string);
5523 string = vstringify(pmsv);
5526 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5529 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5531 SvREFCNT_dec(string);
5533 Perl_sv_2mortal(aTHX_ xpt);
5534 Perl_croak_sv(aTHX_ xpt);
5540 =for apidoc my_strlcat
5542 The C library C<strlcat> if available, or a Perl implementation of it.
5543 This operates on C C<NUL>-terminated strings.
5545 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5546 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5547 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5548 practice this should not happen as it means that either C<size> is incorrect or
5549 that C<dst> is not a proper C<NUL>-terminated string).
5551 Note that C<size> is the full size of the destination buffer and
5552 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5553 room for the C<NUL> should be included in C<size>.
5555 The return value is the total length that C<dst> would have if C<size> is
5556 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5557 C<src>. If C<size> is smaller than the return, the excess was not appended.
5561 Description stolen from http://man.openbsd.org/strlcat.3
5565 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5567 Size_t used, length, copy;
5570 length = strlen(src);
5571 if (size > 0 && used < size - 1) {
5572 copy = (length >= size - used) ? size - used - 1 : length;
5573 memcpy(dst + used, src, copy);
5574 dst[used + copy] = '\0';
5576 return used + length;
5582 =for apidoc my_strlcpy
5584 The C library C<strlcpy> if available, or a Perl implementation of it.
5585 This operates on C C<NUL>-terminated strings.
5587 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5588 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5590 The return value is the total length C<src> would be if the copy completely
5591 succeeded. If it is larger than C<size>, the excess was not copied.
5595 Description stolen from http://man.openbsd.org/strlcpy.3
5599 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5601 Size_t length, copy;
5603 length = strlen(src);
5605 copy = (length >= size) ? size - 1 : length;
5606 memcpy(dst, src, copy);
5613 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5614 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5615 long _ftol( double ); /* Defined by VC6 C libs. */
5616 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5619 PERL_STATIC_INLINE bool
5620 S_gv_has_usable_name(pTHX_ GV *gv)
5624 && HvENAME(GvSTASH(gv))
5625 && (gvp = (GV **)hv_fetchhek(
5626 GvSTASH(gv), GvNAME_HEK(gv), 0
5632 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5634 SV * const dbsv = GvSVn(PL_DBsub);
5635 const bool save_taint = TAINT_get;
5637 /* When we are called from pp_goto (svp is null),
5638 * we do not care about using dbsv to call CV;
5639 * it's for informational purposes only.
5642 PERL_ARGS_ASSERT_GET_DB_SUB;
5646 if (!PERLDB_SUB_NN) {
5649 if (!svp && !CvLEXICAL(cv)) {
5650 gv_efullname3(dbsv, gv, NULL);
5652 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5653 || strEQ(GvNAME(gv), "END")
5654 || ( /* Could be imported, and old sub redefined. */
5655 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5657 !( (SvTYPE(*svp) == SVt_PVGV)
5658 && (GvCV((const GV *)*svp) == cv)
5659 /* Use GV from the stack as a fallback. */
5660 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5664 /* GV is potentially non-unique, or contain different CV. */
5665 SV * const tmp = newRV(MUTABLE_SV(cv));
5666 sv_setsv(dbsv, tmp);
5670 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5671 sv_catpvs(dbsv, "::");
5672 sv_cathek(dbsv, GvNAME_HEK(gv));
5676 const int type = SvTYPE(dbsv);
5677 if (type < SVt_PVIV && type != SVt_IV)
5678 sv_upgrade(dbsv, SVt_PVIV);
5679 (void)SvIOK_on(dbsv);
5680 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5683 TAINT_IF(save_taint);
5684 #ifdef NO_TAINT_SUPPORT
5685 PERL_UNUSED_VAR(save_taint);
5690 Perl_my_dirfd(DIR * dir) {
5692 /* Most dirfd implementations have problems when passed NULL. */
5697 #elif defined(HAS_DIR_DD_FD)
5700 Perl_croak_nocontext(PL_no_func, "dirfd");
5701 NOT_REACHED; /* NOTREACHED */
5706 #if !defined(HAS_MKOSTEMP) || !defined(HAS_MKSTEMP)
5708 #define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
5709 #define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
5712 S_my_mkostemp(char *templte, int flags) {
5714 STRLEN len = strlen(templte);
5718 int delete_on_close = flags & O_VMS_DELETEONCLOSE;
5720 flags &= ~O_VMS_DELETEONCLOSE;
5724 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
5725 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
5726 SETERRNO(EINVAL, LIB_INVARG);
5732 for (i = 1; i <= 6; ++i) {
5733 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
5736 if (delete_on_close) {
5737 fd = open(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600, "fop=dlt");
5742 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600);
5744 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
5751 #ifndef HAS_MKOSTEMP
5753 Perl_my_mkostemp(char *templte, int flags)
5755 PERL_ARGS_ASSERT_MY_MKOSTEMP;
5756 return S_my_mkostemp(templte, flags);
5762 Perl_my_mkstemp(char *templte)
5764 PERL_ARGS_ASSERT_MY_MKSTEMP;
5765 return S_my_mkostemp(templte, 0);
5770 Perl_get_re_arg(pTHX_ SV *sv) {
5776 sv = MUTABLE_SV(SvRV(sv));
5777 if (SvTYPE(sv) == SVt_REGEXP)
5778 return (REGEXP*) sv;
5785 * This code is derived from drand48() implementation from FreeBSD,
5786 * found in lib/libc/gen/_rand48.c.
5788 * The U64 implementation is original, based on the POSIX
5789 * specification for drand48().
5793 * Copyright (c) 1993 Martin Birgmeier
5794 * All rights reserved.
5796 * You may redistribute unmodified or modified versions of this source
5797 * code provided that the above copyright notice and this and the
5798 * following conditions are retained.
5800 * This software is provided ``as is'', and comes with no warranties
5801 * of any kind. I shall in no event be liable for anything that happens
5802 * to anyone/anything when using this software.
5805 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5807 #ifdef PERL_DRAND48_QUAD
5809 #define DRAND48_MULT UINT64_C(0x5deece66d)
5810 #define DRAND48_ADD 0xb
5811 #define DRAND48_MASK UINT64_C(0xffffffffffff)
5815 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5816 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5817 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5818 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5819 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5820 #define FREEBSD_DRAND48_ADD (0x000b)
5822 const unsigned short _rand48_mult[3] = {
5823 FREEBSD_DRAND48_MULT_0,
5824 FREEBSD_DRAND48_MULT_1,
5825 FREEBSD_DRAND48_MULT_2
5827 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5832 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5834 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5836 #ifdef PERL_DRAND48_QUAD
5837 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5839 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5840 random_state->seed[1] = (U16) seed;
5841 random_state->seed[2] = (U16) (seed >> 16);
5846 Perl_drand48_r(perl_drand48_t *random_state)
5848 PERL_ARGS_ASSERT_DRAND48_R;
5850 #ifdef PERL_DRAND48_QUAD
5851 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5854 return ldexp((double)*random_state, -48);
5860 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5861 + (U32) _rand48_add;
5862 temp[0] = (U16) accu; /* lower 16 bits */
5863 accu >>= sizeof(U16) * 8;
5864 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5865 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5866 temp[1] = (U16) accu; /* middle 16 bits */
5867 accu >>= sizeof(U16) * 8;
5868 accu += _rand48_mult[0] * random_state->seed[2]
5869 + _rand48_mult[1] * random_state->seed[1]
5870 + _rand48_mult[2] * random_state->seed[0];
5871 random_state->seed[0] = temp[0];
5872 random_state->seed[1] = temp[1];
5873 random_state->seed[2] = (U16) accu;
5875 return ldexp((double) random_state->seed[0], -48) +
5876 ldexp((double) random_state->seed[1], -32) +
5877 ldexp((double) random_state->seed[2], -16);
5882 #ifdef USE_C_BACKTRACE
5884 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5889 /* abfd is the BFD handle. */
5891 /* bfd_syms is the BFD symbol table. */
5893 /* bfd_text is handle to the the ".text" section of the object file. */
5895 /* Since opening the executable and scanning its symbols is quite
5896 * heavy operation, we remember the filename we used the last time,
5897 * and do the opening and scanning only if the filename changes.
5898 * This removes most (but not all) open+scan cycles. */
5899 const char* fname_prev;
5902 /* Given a dl_info, update the BFD context if necessary. */
5903 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5905 /* BFD open and scan only if the filename changed. */
5906 if (ctx->fname_prev == NULL ||
5907 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5909 bfd_close(ctx->abfd);
5911 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5913 if (bfd_check_format(ctx->abfd, bfd_object)) {
5914 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5915 if (symbol_size > 0) {
5916 Safefree(ctx->bfd_syms);
5917 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5919 bfd_get_section_by_name(ctx->abfd, ".text");
5927 ctx->fname_prev = dl_info->dli_fname;
5931 /* Given a raw frame, try to symbolize it and store
5932 * symbol information (source file, line number) away. */
5933 static void bfd_symbolize(bfd_context* ctx,
5936 STRLEN* symbol_name_size,
5938 STRLEN* source_name_size,
5939 STRLEN* source_line)
5941 *symbol_name = NULL;
5942 *symbol_name_size = 0;
5944 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5946 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5949 unsigned int line = 0;
5950 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5951 ctx->bfd_syms, offset,
5952 &file, &func, &line) &&
5953 file && func && line > 0) {
5954 /* Size and copy the source file, use only
5955 * the basename of the source file.
5957 * NOTE: the basenames are fine for the
5958 * Perl source files, but may not always
5959 * be the best idea for XS files. */
5960 const char *p, *b = NULL;
5961 /* Look for the last slash. */
5962 for (p = file; *p; p++) {
5966 if (b == NULL || *b == 0) {
5969 *source_name_size = p - b + 1;
5970 Newx(*source_name, *source_name_size + 1, char);
5971 Copy(b, *source_name, *source_name_size + 1, char);
5973 *symbol_name_size = strlen(func);
5974 Newx(*symbol_name, *symbol_name_size + 1, char);
5975 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5977 *source_line = line;
5983 #endif /* #ifdef USE_BFD */
5987 /* OS X has no public API for for 'symbolicating' (Apple official term)
5988 * stack addresses to {function_name, source_file, line_number}.
5989 * Good news: there is command line utility atos(1) which does that.
5990 * Bad news 1: it's a command line utility.
5991 * Bad news 2: one needs to have the Developer Tools installed.
5992 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
5994 * To recap: we need to open a pipe for reading for a utility which
5995 * might not exist, or exists in different locations, and then parse
5996 * the output. And since this is all for a low-level API, we cannot
5997 * use high-level stuff. Thanks, Apple. */
6000 /* tool is set to the absolute pathname of the tool to use:
6003 /* format is set to a printf format string used for building
6004 * the external command to run. */
6006 /* unavail is set if e.g. xcrun cannot be found, or something
6007 * else happens that makes getting the backtrace dubious. Note,
6008 * however, that the context isn't persistent, the next call to
6009 * get_c_backtrace() will start from scratch. */
6011 /* fname is the current object file name. */
6013 /* object_base_addr is the base address of the shared object. */
6014 void* object_base_addr;
6017 /* Given |dl_info|, updates the context. If the context has been
6018 * marked unavailable, return immediately. If not but the tool has
6019 * not been set, set it to either "xcrun atos" or "atos" (also set the
6020 * format to use for creating commands for piping), or if neither is
6021 * unavailable (one needs the Developer Tools installed), mark the context
6022 * an unavailable. Finally, update the filename (object name),
6023 * and its base address. */
6025 static void atos_update(atos_context* ctx,
6030 if (ctx->tool == NULL) {
6031 const char* tools[] = {
6035 const char* formats[] = {
6036 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6037 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6041 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6042 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6043 ctx->tool = tools[i];
6044 ctx->format = formats[i];
6048 if (ctx->tool == NULL) {
6049 ctx->unavail = TRUE;
6053 if (ctx->fname == NULL ||
6054 strNE(dl_info->dli_fname, ctx->fname)) {
6055 ctx->fname = dl_info->dli_fname;
6056 ctx->object_base_addr = dl_info->dli_fbase;
6060 /* Given an output buffer end |p| and its |start|, matches
6061 * for the atos output, extracting the source code location
6062 * and returning non-NULL if possible, returning NULL otherwise. */
6063 static const char* atos_parse(const char* p,
6065 STRLEN* source_name_size,
6066 STRLEN* source_line) {
6067 /* atos() output is something like:
6068 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6069 * We cannot use Perl regular expressions, because we need to
6070 * stay low-level. Therefore here we have a rolled-out version
6071 * of a state machine which matches _backwards_from_the_end_ and
6072 * if there's a success, returns the starts of the filename,
6073 * also setting the filename size and the source line number.
6074 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6075 const char* source_number_start;
6076 const char* source_name_end;
6077 const char* source_line_end = start;
6078 const char* close_paren;
6081 /* Skip trailing whitespace. */
6082 while (p > start && isSPACE(*p)) p--;
6083 /* Now we should be at the close paren. */
6084 if (p == start || *p != ')')
6088 /* Now we should be in the line number. */
6089 if (p == start || !isDIGIT(*p))
6091 /* Skip over the digits. */
6092 while (p > start && isDIGIT(*p))
6094 /* Now we should be at the colon. */
6095 if (p == start || *p != ':')
6097 source_number_start = p + 1;
6098 source_name_end = p; /* Just beyond the end. */
6100 /* Look for the open paren. */
6101 while (p > start && *p != '(')
6106 *source_name_size = source_name_end - p;
6107 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6108 && source_line_end == close_paren
6109 && uv <= PERL_INT_MAX
6111 *source_line = (STRLEN)uv;
6117 /* Given a raw frame, read a pipe from the symbolicator (that's the
6118 * technical term) atos, reads the result, and parses the source code
6119 * location. We must stay low-level, so we use snprintf(), pipe(),
6120 * and fread(), and then also parse the output ourselves. */
6121 static void atos_symbolize(atos_context* ctx,
6124 STRLEN* source_name_size,
6125 STRLEN* source_line)
6133 /* Simple security measure: if there's any funny business with
6134 * the object name (used as "-o '%s'" ), leave since at least
6135 * partially the user controls it. */
6136 for (p = ctx->fname; *p; p++) {
6137 if (*p == '\'' || isCNTRL(*p)) {
6138 ctx->unavail = TRUE;
6142 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6143 ctx->fname, ctx->object_base_addr, raw_frame);
6144 if (cnt < sizeof(cmd)) {
6145 /* Undo nostdio.h #defines that disable stdio.
6146 * This is somewhat naughty, but is used elsewhere
6147 * in the core, and affects only OS X. */
6152 FILE* fp = popen(cmd, "r");
6153 /* At the moment we open a new pipe for each stack frame.
6154 * This is naturally somewhat slow, but hopefully generating
6155 * stack traces is never going to in a performance critical path.
6157 * We could play tricks with atos by batching the stack
6158 * addresses to be resolved: atos can either take multiple
6159 * addresses from the command line, or read addresses from
6160 * a file (though the mess of creating temporary files would
6161 * probably negate much of any possible speedup).
6163 * Normally there are only two objects present in the backtrace:
6164 * perl itself, and the libdyld.dylib. (Note that the object
6165 * filenames contain the full pathname, so perl may not always
6166 * be in the same place.) Whenever the object in the
6167 * backtrace changes, the base address also changes.
6169 * The problem with batching the addresses, though, would be
6170 * matching the results with the addresses: the parsing of
6171 * the results is already painful enough with a single address. */
6174 UV cnt = fread(out, 1, sizeof(out), fp);
6175 if (cnt < sizeof(out)) {
6176 const char* p = atos_parse(out + cnt - 1, out,
6181 *source_name_size, char);
6182 Copy(p, *source_name,
6183 *source_name_size, char);
6191 #endif /* #ifdef PERL_DARWIN */
6194 =for apidoc get_c_backtrace
6196 Collects the backtrace (aka "stacktrace") into a single linear
6197 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6199 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6200 returning at most C<depth> frames.
6206 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6208 /* Note that here we must stay as low-level as possible: Newx(),
6209 * Copy(), Safefree(); since we may be called from anywhere,
6210 * so we should avoid higher level constructs like SVs or AVs.
6212 * Since we are using safesysmalloc() via Newx(), don't try
6213 * getting backtrace() there, unless you like deep recursion. */
6215 /* Currently only implemented with backtrace() and dladdr(),
6216 * for other platforms NULL is returned. */
6218 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6219 /* backtrace() is available via <execinfo.h> in glibc and in most
6220 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6222 /* We try fetching this many frames total, but then discard
6223 * the |skip| first ones. For the remaining ones we will try
6224 * retrieving more information with dladdr(). */
6225 int try_depth = skip + depth;
6227 /* The addresses (program counters) returned by backtrace(). */
6230 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6233 /* Sizes _including_ the terminating \0 of the object name
6234 * and symbol name strings. */
6235 STRLEN* object_name_sizes;
6236 STRLEN* symbol_name_sizes;
6239 /* The symbol names comes either from dli_sname,
6240 * or if using BFD, they can come from BFD. */
6241 char** symbol_names;
6244 /* The source code location information. Dug out with e.g. BFD. */
6245 char** source_names;
6246 STRLEN* source_name_sizes;
6247 STRLEN* source_lines;
6249 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6250 int got_depth; /* How many frames were returned from backtrace(). */
6251 UV frame_count = 0; /* How many frames we return. */
6252 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6255 bfd_context bfd_ctx;
6258 atos_context atos_ctx;
6261 /* Here are probably possibilities for optimizing. We could for
6262 * example have a struct that contains most of these and then
6263 * allocate |try_depth| of them, saving a bunch of malloc calls.
6264 * Note, however, that |frames| could not be part of that struct
6265 * because backtrace() will want an array of just them. Also be
6266 * careful about the name strings. */
6267 Newx(raw_frames, try_depth, void*);
6268 Newx(dl_infos, try_depth, Dl_info);
6269 Newx(object_name_sizes, try_depth, STRLEN);
6270 Newx(symbol_name_sizes, try_depth, STRLEN);
6271 Newx(source_names, try_depth, char*);
6272 Newx(source_name_sizes, try_depth, STRLEN);
6273 Newx(source_lines, try_depth, STRLEN);
6275 Newx(symbol_names, try_depth, char*);
6278 /* Get the raw frames. */
6279 got_depth = (int)backtrace(raw_frames, try_depth);
6281 /* We use dladdr() instead of backtrace_symbols() because we want
6282 * the full details instead of opaque strings. This is useful for
6283 * two reasons: () the details are needed for further symbolic
6284 * digging, for example in OS X (2) by having the details we fully
6285 * control the output, which in turn is useful when more platforms
6286 * are added: we can keep out output "portable". */
6288 /* We want a single linear allocation, which can then be freed
6289 * with a single swoop. We will do the usual trick of first
6290 * walking over the structure and seeing how much we need to
6291 * allocate, then allocating, and then walking over the structure
6292 * the second time and populating it. */
6294 /* First we must compute the total size of the buffer. */
6295 total_bytes = sizeof(Perl_c_backtrace_header);
6296 if (got_depth > skip) {
6299 bfd_init(); /* Is this safe to call multiple times? */
6300 Zero(&bfd_ctx, 1, bfd_context);
6303 Zero(&atos_ctx, 1, atos_context);
6305 for (i = skip; i < try_depth; i++) {
6306 Dl_info* dl_info = &dl_infos[i];
6308 object_name_sizes[i] = 0;
6309 source_names[i] = NULL;
6310 source_name_sizes[i] = 0;
6311 source_lines[i] = 0;
6313 /* Yes, zero from dladdr() is failure. */
6314 if (dladdr(raw_frames[i], dl_info)) {
6315 total_bytes += sizeof(Perl_c_backtrace_frame);
6317 object_name_sizes[i] =
6318 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6319 symbol_name_sizes[i] =
6320 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6322 bfd_update(&bfd_ctx, dl_info);
6323 bfd_symbolize(&bfd_ctx, raw_frames[i],
6325 &symbol_name_sizes[i],
6327 &source_name_sizes[i],
6331 atos_update(&atos_ctx, dl_info);
6332 atos_symbolize(&atos_ctx,
6335 &source_name_sizes[i],
6339 /* Plus ones for the terminating \0. */
6340 total_bytes += object_name_sizes[i] + 1;
6341 total_bytes += symbol_name_sizes[i] + 1;
6342 total_bytes += source_name_sizes[i] + 1;
6350 Safefree(bfd_ctx.bfd_syms);
6354 /* Now we can allocate and populate the result buffer. */
6355 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6356 Zero(bt, total_bytes, char);
6357 bt->header.frame_count = frame_count;
6358 bt->header.total_bytes = total_bytes;
6359 if (frame_count > 0) {
6360 Perl_c_backtrace_frame* frame = bt->frame_info;
6361 char* name_base = (char *)(frame + frame_count);
6362 char* name_curr = name_base; /* Outputting the name strings here. */
6364 for (i = skip; i < skip + frame_count; i++) {
6365 Dl_info* dl_info = &dl_infos[i];
6367 frame->addr = raw_frames[i];
6368 frame->object_base_addr = dl_info->dli_fbase;
6369 frame->symbol_addr = dl_info->dli_saddr;
6371 /* Copies a string, including the \0, and advances the name_curr.
6372 * Also copies the start and the size to the frame. */
6373 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6375 Copy(src, name_curr, size, char); \
6376 frame->doffset = name_curr - (char*)bt; \
6377 frame->dsize = size; \
6378 name_curr += size; \
6381 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6383 object_name_size, object_name_sizes[i]);
6386 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6388 symbol_name_size, symbol_name_sizes[i]);
6389 Safefree(symbol_names[i]);
6391 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6393 symbol_name_size, symbol_name_sizes[i]);
6396 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6398 source_name_size, source_name_sizes[i]);
6399 Safefree(source_names[i]);
6401 #undef PERL_C_BACKTRACE_STRCPY
6403 frame->source_line_number = source_lines[i];
6407 assert(total_bytes ==
6408 (UV)(sizeof(Perl_c_backtrace_header) +
6409 frame_count * sizeof(Perl_c_backtrace_frame) +
6410 name_curr - name_base));
6413 Safefree(symbol_names);
6415 bfd_close(bfd_ctx.abfd);
6418 Safefree(source_lines);
6419 Safefree(source_name_sizes);
6420 Safefree(source_names);
6421 Safefree(symbol_name_sizes);
6422 Safefree(object_name_sizes);
6423 /* Assuming the strings returned by dladdr() are pointers
6424 * to read-only static memory (the object file), so that
6425 * they do not need freeing (and cannot be). */
6427 Safefree(raw_frames);
6430 PERL_UNUSED_ARG(depth);
6431 PERL_UNUSED_ARG(skip);
6437 =for apidoc free_c_backtrace
6439 Deallocates a backtrace received from get_c_bracktrace.
6445 =for apidoc get_c_backtrace_dump
6447 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6448 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6450 The appended output looks like:
6453 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6454 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6457 The fields are tab-separated. The first column is the depth (zero
6458 being the innermost non-skipped frame). In the hex:offset, the hex is
6459 where the program counter was in C<S_parse_body>, and the :offset (might
6460 be missing) tells how much inside the C<S_parse_body> the program counter was.
6462 The C<util.c:1716> is the source code file and line number.
6464 The F</usr/bin/perl> is obvious (hopefully).
6466 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6467 if the platform doesn't support retrieving the information;
6468 if the binary is missing the debug information;
6469 if the optimizer has transformed the code by for example inlining.
6475 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6477 Perl_c_backtrace* bt;
6479 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6481 Perl_c_backtrace_frame* frame;
6482 SV* dsv = newSVpvs("");
6484 for (i = 0, frame = bt->frame_info;
6485 i < bt->header.frame_count; i++, frame++) {
6486 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6487 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6488 /* Symbol (function) names might disappear without debug info.
6490 * The source code location might disappear in case of the
6491 * optimizer inlining or otherwise rearranging the code. */
6492 if (frame->symbol_addr) {
6493 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6495 ((char*)frame->addr - (char*)frame->symbol_addr));
6497 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6498 frame->symbol_name_size &&
6499 frame->symbol_name_offset ?
6500 (char*)bt + frame->symbol_name_offset : "-");
6501 if (frame->source_name_size &&
6502 frame->source_name_offset &&
6503 frame->source_line_number) {
6504 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6505 (char*)bt + frame->source_name_offset,
6506 (UV)frame->source_line_number);
6508 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6510 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6511 frame->object_name_size &&
6512 frame->object_name_offset ?
6513 (char*)bt + frame->object_name_offset : "-");
6514 /* The frame->object_base_addr is not output,
6515 * but it is used for symbolizing/symbolicating. */
6516 sv_catpvs(dsv, "\n");
6519 Perl_free_c_backtrace(bt);
6528 =for apidoc dump_c_backtrace
6530 Dumps the C backtrace to the given C<fp>.
6532 Returns true if a backtrace could be retrieved, false if not.
6538 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6542 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6544 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6547 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6553 #endif /* #ifdef USE_C_BACKTRACE */
6555 #ifdef PERL_TSA_ACTIVE
6557 /* pthread_mutex_t and perl_mutex are typedef equivalent
6558 * so casting the pointers is fine. */
6560 int perl_tsa_mutex_lock(perl_mutex* mutex)
6562 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6565 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6567 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6570 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6572 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6580 /* log a sub call or return */
6583 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6591 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6594 HEK *hek = CvNAME_HEK(cv);
6595 func = HEK_KEY(hek);
6601 start = (const COP *)CvSTART(cv);
6602 file = CopFILE(start);
6603 line = CopLINE(start);
6604 stash = CopSTASHPV(start);
6607 PERL_SUB_ENTRY(func, file, line, stash);
6610 PERL_SUB_RETURN(func, file, line, stash);
6615 /* log a require file loading/loaded */
6618 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6620 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6623 PERL_LOADING_FILE(name);
6626 PERL_LOADED_FILE(name);
6631 /* log an op execution */
6634 Perl_dtrace_probe_op(pTHX_ const OP *op)
6636 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6638 PERL_OP_ENTRY(OP_NAME(op));
6642 /* log a compile/run phase change */
6645 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6647 const char *ph_old = PL_phase_names[PL_phase];
6648 const char *ph_new = PL_phase_names[phase];
6650 PERL_PHASE_CHANGE(ph_new, ph_old);
6656 * ex: set ts=8 sts=4 sw=4 et: