3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * 'Very useful, no doubt, that was to Saruman; yet it seems that he was
13 * not content.' --Gandalf to Pippin
15 * [p.598 of _The Lord of the Rings_, III/xi: "The PalantÃr"]
18 /* This file contains assorted utility routines.
19 * Which is a polite way of saying any stuff that people couldn't think of
20 * a better place for. Amongst other things, it includes the warning and
21 * dieing stuff, plus wrappers for malloc code.
25 #define PERL_IN_UTIL_C
29 #if defined(USE_PERLIO)
30 #include "perliol.h" /* For PerlIOUnix_refcnt */
36 # define SIG_ERR ((Sighandler_t) -1)
44 /* Missing protos on LynxOS */
49 # include "amigaos4/amigaio.h"
54 # include <sys/select.h>
58 #ifdef USE_C_BACKTRACE
62 # undef USE_BFD /* BFD is useless in OS X. */
72 # include <execinfo.h>
76 #ifdef PERL_DEBUG_READONLY_COW
77 # include <sys/mman.h>
82 /* NOTE: Do not call the next three routines directly. Use the macros
83 * in handy.h, so that we can easily redefine everything to do tracking of
84 * allocated hunks back to the original New to track down any memory leaks.
85 * XXX This advice seems to be widely ignored :-( --AD August 1996.
88 #if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
89 # define ALWAYS_NEED_THX
92 #if defined(PERL_TRACK_MEMPOOL) && defined(PERL_DEBUG_READONLY_COW)
94 S_maybe_protect_rw(pTHX_ struct perl_memory_debug_header *header)
97 && mprotect(header, header->size, PROT_READ|PROT_WRITE))
98 Perl_warn(aTHX_ "mprotect for COW string %p %lu failed with %d",
99 header, header->size, errno);
103 S_maybe_protect_ro(pTHX_ struct perl_memory_debug_header *header)
106 && mprotect(header, header->size, PROT_READ))
107 Perl_warn(aTHX_ "mprotect RW for COW string %p %lu failed with %d",
108 header, header->size, errno);
110 # define maybe_protect_rw(foo) S_maybe_protect_rw(aTHX_ foo)
111 # define maybe_protect_ro(foo) S_maybe_protect_ro(aTHX_ foo)
113 # define maybe_protect_rw(foo) NOOP
114 # define maybe_protect_ro(foo) NOOP
117 #if defined(PERL_TRACK_MEMPOOL) || defined(PERL_DEBUG_READONLY_COW)
118 /* Use memory_debug_header */
120 # if (defined(PERL_POISON) && defined(PERL_TRACK_MEMPOOL)) \
121 || defined(PERL_DEBUG_READONLY_COW)
122 # define MDH_HAS_SIZE
126 /* paranoid version of system's malloc() */
129 Perl_safesysmalloc(MEM_SIZE size)
131 #ifdef ALWAYS_NEED_THX
138 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
140 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
143 if ((SSize_t)size < 0)
144 Perl_croak_nocontext("panic: malloc, size=%" UVuf, (UV) size);
146 if (!size) size = 1; /* malloc(0) is NASTY on our system */
148 #ifdef PERL_DEBUG_READONLY_COW
149 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
150 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
151 perror("mmap failed");
155 ptr = (Malloc_t)PerlMem_malloc(size?size:1);
157 PERL_ALLOC_CHECK(ptr);
160 struct perl_memory_debug_header *const header
161 = (struct perl_memory_debug_header *)ptr;
165 PoisonNew(((char *)ptr), size, char);
168 #ifdef PERL_TRACK_MEMPOOL
169 header->interpreter = aTHX;
170 /* Link us into the list. */
171 header->prev = &PL_memory_debug_header;
172 header->next = PL_memory_debug_header.next;
173 PL_memory_debug_header.next = header;
174 maybe_protect_rw(header->next);
175 header->next->prev = header;
176 maybe_protect_ro(header->next);
177 # ifdef PERL_DEBUG_READONLY_COW
178 header->readonly = 0;
184 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
185 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
187 /* malloc() can modify errno() even on success, but since someone
188 writing perl code doesn't have any control over when perl calls
189 malloc() we need to hide that.
198 #ifndef ALWAYS_NEED_THX
210 /* paranoid version of system's realloc() */
213 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
215 #ifdef ALWAYS_NEED_THX
219 #ifdef PERL_DEBUG_READONLY_COW
220 const MEM_SIZE oldsize = where
221 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
230 ptr = safesysmalloc(size);
235 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
236 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
238 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
240 struct perl_memory_debug_header *const header
241 = (struct perl_memory_debug_header *)where;
243 # ifdef PERL_TRACK_MEMPOOL
244 if (header->interpreter != aTHX) {
245 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
246 header->interpreter, aTHX);
248 assert(header->next->prev == header);
249 assert(header->prev->next == header);
251 if (header->size > size) {
252 const MEM_SIZE freed_up = header->size - size;
253 char *start_of_freed = ((char *)where) + size;
254 PoisonFree(start_of_freed, freed_up, char);
264 if ((SSize_t)size < 0)
265 Perl_croak_nocontext("panic: realloc, size=%" UVuf, (UV)size);
267 #ifdef PERL_DEBUG_READONLY_COW
268 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
269 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
270 perror("mmap failed");
273 Copy(where,ptr,oldsize < size ? oldsize : size,char);
274 if (munmap(where, oldsize)) {
275 perror("munmap failed");
279 ptr = (Malloc_t)PerlMem_realloc(where,size);
281 PERL_ALLOC_CHECK(ptr);
283 /* MUST do this fixup first, before doing ANYTHING else, as anything else
284 might allocate memory/free/move memory, and until we do the fixup, it
285 may well be chasing (and writing to) free memory. */
287 #ifdef PERL_TRACK_MEMPOOL
288 struct perl_memory_debug_header *const header
289 = (struct perl_memory_debug_header *)ptr;
292 if (header->size < size) {
293 const MEM_SIZE fresh = size - header->size;
294 char *start_of_fresh = ((char *)ptr) + size;
295 PoisonNew(start_of_fresh, fresh, char);
299 maybe_protect_rw(header->next);
300 header->next->prev = header;
301 maybe_protect_ro(header->next);
302 maybe_protect_rw(header->prev);
303 header->prev->next = header;
304 maybe_protect_ro(header->prev);
306 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
308 /* realloc() can modify errno() even on success, but since someone
309 writing perl code doesn't have any control over when perl calls
310 realloc() we need to hide that.
315 /* In particular, must do that fixup above before logging anything via
316 *printf(), as it can reallocate memory, which can cause SEGVs. */
318 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
319 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
326 #ifndef ALWAYS_NEED_THX
339 /* safe version of system's free() */
342 Perl_safesysfree(Malloc_t where)
344 #ifdef ALWAYS_NEED_THX
347 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
350 Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
352 struct perl_memory_debug_header *const header
353 = (struct perl_memory_debug_header *)where_intrn;
356 const MEM_SIZE size = header->size;
358 # ifdef PERL_TRACK_MEMPOOL
359 if (header->interpreter != aTHX) {
360 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
361 header->interpreter, aTHX);
364 Perl_croak_nocontext("panic: duplicate free");
367 Perl_croak_nocontext("panic: bad free, header->next==NULL");
368 if (header->next->prev != header || header->prev->next != header) {
369 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
370 "header=%p, ->prev->next=%p",
371 header->next->prev, header,
374 /* Unlink us from the chain. */
375 maybe_protect_rw(header->next);
376 header->next->prev = header->prev;
377 maybe_protect_ro(header->next);
378 maybe_protect_rw(header->prev);
379 header->prev->next = header->next;
380 maybe_protect_ro(header->prev);
381 maybe_protect_rw(header);
383 PoisonNew(where_intrn, size, char);
385 /* Trigger the duplicate free warning. */
388 # ifdef PERL_DEBUG_READONLY_COW
389 if (munmap(where_intrn, size)) {
390 perror("munmap failed");
396 Malloc_t where_intrn = where;
398 #ifndef PERL_DEBUG_READONLY_COW
399 PerlMem_free(where_intrn);
404 /* safe version of system's calloc() */
407 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
409 #ifdef ALWAYS_NEED_THX
413 #if defined(USE_MDH) || defined(DEBUGGING)
414 MEM_SIZE total_size = 0;
417 /* Even though calloc() for zero bytes is strange, be robust. */
418 if (size && (count <= MEM_SIZE_MAX / size)) {
419 #if defined(USE_MDH) || defined(DEBUGGING)
420 total_size = size * count;
426 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
427 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
432 if ((SSize_t)size < 0 || (SSize_t)count < 0)
433 Perl_croak_nocontext("panic: calloc, size=%" UVuf ", count=%" UVuf,
434 (UV)size, (UV)count);
436 #ifdef PERL_DEBUG_READONLY_COW
437 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
438 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
439 perror("mmap failed");
442 #elif defined(PERL_TRACK_MEMPOOL)
443 /* Have to use malloc() because we've added some space for our tracking
445 /* malloc(0) is non-portable. */
446 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
448 /* Use calloc() because it might save a memset() if the memory is fresh
449 and clean from the OS. */
451 ptr = (Malloc_t)PerlMem_calloc(count, size);
452 else /* calloc(0) is non-portable. */
453 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
455 PERL_ALLOC_CHECK(ptr);
456 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) calloc %zu x %zu = %zu bytes\n",PTR2UV(ptr),(long)PL_an++, count, size, total_size));
460 struct perl_memory_debug_header *const header
461 = (struct perl_memory_debug_header *)ptr;
463 # ifndef PERL_DEBUG_READONLY_COW
464 memset((void*)ptr, 0, total_size);
466 # ifdef PERL_TRACK_MEMPOOL
467 header->interpreter = aTHX;
468 /* Link us into the list. */
469 header->prev = &PL_memory_debug_header;
470 header->next = PL_memory_debug_header.next;
471 PL_memory_debug_header.next = header;
472 maybe_protect_rw(header->next);
473 header->next->prev = header;
474 maybe_protect_ro(header->next);
475 # ifdef PERL_DEBUG_READONLY_COW
476 header->readonly = 0;
480 header->size = total_size;
482 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
488 #ifndef ALWAYS_NEED_THX
497 /* These must be defined when not using Perl's malloc for binary
502 Malloc_t Perl_malloc (MEM_SIZE nbytes)
504 #ifdef PERL_IMPLICIT_SYS
507 return (Malloc_t)PerlMem_malloc(nbytes);
510 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
512 #ifdef PERL_IMPLICIT_SYS
515 return (Malloc_t)PerlMem_calloc(elements, size);
518 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
520 #ifdef PERL_IMPLICIT_SYS
523 return (Malloc_t)PerlMem_realloc(where, nbytes);
526 Free_t Perl_mfree (Malloc_t where)
528 #ifdef PERL_IMPLICIT_SYS
536 /* copy a string up to some (non-backslashed) delimiter, if any.
537 * With allow_escape, converts \<delimiter> to <delimiter>, while leaves
538 * \<non-delimiter> as-is.
539 * Returns the position in the src string of the closing delimiter, if
540 * any, or returns fromend otherwise.
541 * This is the internal implementation for Perl_delimcpy and
542 * Perl_delimcpy_no_escape.
546 S_delimcpy_intern(char *to, const char *toend, const char *from,
547 const char *fromend, int delim, I32 *retlen,
548 const bool allow_escape)
552 PERL_ARGS_ASSERT_DELIMCPY;
554 for (tolen = 0; from < fromend; from++, tolen++) {
555 if (allow_escape && *from == '\\' && from + 1 < fromend) {
556 if (from[1] != delim) {
563 else if (*from == delim)
575 Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
577 PERL_ARGS_ASSERT_DELIMCPY;
579 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 1);
583 Perl_delimcpy_no_escape(char *to, const char *toend, const char *from,
584 const char *fromend, int delim, I32 *retlen)
586 PERL_ARGS_ASSERT_DELIMCPY_NO_ESCAPE;
588 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 0);
592 =head1 Miscellaneous Functions
596 Find the first (leftmost) occurrence of a sequence of bytes within another
597 sequence. This is the Perl version of C<strstr()>, extended to handle
598 arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
599 is what the initial C<n> in the function name stands for; some systems have an
600 equivalent, C<memmem()>, but with a somewhat different API).
602 Another way of thinking about this function is finding a needle in a haystack.
603 C<big> points to the first byte in the haystack. C<big_end> points to one byte
604 beyond the final byte in the haystack. C<little> points to the first byte in
605 the needle. C<little_end> points to one byte beyond the final byte in the
606 needle. All the parameters must be non-C<NULL>.
608 The function returns C<NULL> if there is no occurrence of C<little> within
609 C<big>. If C<little> is the empty string, C<big> is returned.
611 Because this function operates at the byte level, and because of the inherent
612 characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
613 needle and the haystack are strings with the same UTF-8ness, but not if the
621 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
623 PERL_ARGS_ASSERT_NINSTR;
626 return ninstr(big, bigend, little, lend);
632 const char first = *little;
633 bigend -= lend - little++;
635 while (big <= bigend) {
636 if (*big++ == first) {
638 for (x=big,s=little; s < lend; x++,s++) {
642 return (char*)(big-1);
653 =head1 Miscellaneous Functions
657 Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
658 sequence of bytes within another sequence, returning C<NULL> if there is no
666 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
669 const I32 first = *little;
670 const char * const littleend = lend;
672 PERL_ARGS_ASSERT_RNINSTR;
674 if (little >= littleend)
675 return (char*)bigend;
677 big = bigend - (littleend - little++);
678 while (big >= bigbeg) {
682 for (x=big+2,s=little; s < littleend; /**/ ) {
691 return (char*)(big+1);
696 /* As a space optimization, we do not compile tables for strings of length
697 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
698 special-cased in fbm_instr().
700 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
703 =head1 Miscellaneous Functions
705 =for apidoc fbm_compile
707 Analyzes the string in order to make fast searches on it using C<fbm_instr()>
708 -- the Boyer-Moore algorithm.
714 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
721 PERL_DEB( STRLEN rarest = 0 );
723 PERL_ARGS_ASSERT_FBM_COMPILE;
725 if (isGV_with_GP(sv) || SvROK(sv))
731 if (flags & FBMcf_TAIL) {
732 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
733 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
734 if (mg && mg->mg_len >= 0)
737 if (!SvPOK(sv) || SvNIOKp(sv))
738 s = (U8*)SvPV_force_mutable(sv, len);
739 else s = (U8 *)SvPV_mutable(sv, len);
740 if (len == 0) /* TAIL might be on a zero-length string. */
742 SvUPGRADE(sv, SVt_PVMG);
746 /* add PERL_MAGIC_bm magic holding the FBM lookup table */
748 assert(!mg_find(sv, PERL_MAGIC_bm));
749 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
753 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
755 const U8 mlen = (len>255) ? 255 : (U8)len;
756 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
759 Newx(table, 256, U8);
760 memset((void*)table, mlen, 256);
761 mg->mg_ptr = (char *)table;
764 s += len - 1; /* last char */
767 if (table[*s] == mlen)
773 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
774 for (i = 0; i < len; i++) {
775 if (PL_freq[s[i]] < frequency) {
776 PERL_DEB( rarest = i );
777 frequency = PL_freq[s[i]];
780 BmUSEFUL(sv) = 100; /* Initial value */
781 ((XPVNV*)SvANY(sv))->xnv_u.xnv_bm_tail = cBOOL(flags & FBMcf_TAIL);
782 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %" UVuf "\n",
783 s[rarest], (UV)rarest));
788 =for apidoc fbm_instr
790 Returns the location of the SV in the string delimited by C<big> and
791 C<bigend> (C<bigend>) is the char following the last char).
792 It returns C<NULL> if the string can't be found. The C<sv>
793 does not have to be C<fbm_compiled>, but the search will not be as fast
798 If SvTAIL(littlestr) is true, a fake "\n" was appended to to the string
799 during FBM compilation due to FBMcf_TAIL in flags. It indicates that
800 the littlestr must be anchored to the end of bigstr (or to any \n if
803 E.g. The regex compiler would compile /abc/ to a littlestr of "abc",
804 while /abc$/ compiles to "abc\n" with SvTAIL() true.
806 A littlestr of "abc", !SvTAIL matches as /abc/;
807 a littlestr of "ab\n", SvTAIL matches as:
808 without FBMrf_MULTILINE: /ab\n?\z/
809 with FBMrf_MULTILINE: /ab\n/ || /ab\z/;
811 (According to Ilya from 1999; I don't know if this is still true, DAPM 2015):
812 "If SvTAIL is actually due to \Z or \z, this gives false positives
818 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
822 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
823 STRLEN littlelen = l;
824 const I32 multiline = flags & FBMrf_MULTILINE;
825 bool valid = SvVALID(littlestr);
826 bool tail = valid ? cBOOL(SvTAIL(littlestr)) : FALSE;
828 PERL_ARGS_ASSERT_FBM_INSTR;
830 assert(bigend >= big);
832 if ((STRLEN)(bigend - big) < littlelen) {
834 && ((STRLEN)(bigend - big) == littlelen - 1)
836 || (*big == *little &&
837 memEQ((char *)big, (char *)little, littlelen - 1))))
842 switch (littlelen) { /* Special cases for 0, 1 and 2 */
844 return (char*)big; /* Cannot be SvTAIL! */
847 if (tail && !multiline) /* Anchor only! */
848 /* [-1] is safe because we know that bigend != big. */
849 return (char *) (bigend - (bigend[-1] == '\n'));
851 s = (unsigned char *)memchr((void*)big, *little, bigend-big);
855 return (char *) bigend;
859 if (tail && !multiline) {
860 /* a littlestr with SvTAIL must be of the form "X\n" (where X
861 * is a single char). It is anchored, and can only match
862 * "....X\n" or "....X" */
863 if (bigend[-2] == *little && bigend[-1] == '\n')
864 return (char*)bigend - 2;
865 if (bigend[-1] == *little)
866 return (char*)bigend - 1;
871 /* memchr() is likely to be very fast, possibly using whatever
872 * hardware support is available, such as checking a whole
873 * cache line in one instruction.
874 * So for a 2 char pattern, calling memchr() is likely to be
875 * faster than running FBM, or rolling our own. The previous
876 * version of this code was roll-your-own which typically
877 * only needed to read every 2nd char, which was good back in
878 * the day, but no longer.
880 unsigned char c1 = little[0];
881 unsigned char c2 = little[1];
883 /* *** for all this case, bigend points to the last char,
884 * not the trailing \0: this makes the conditions slightly
890 /* do a quick test for c1 before calling memchr();
891 * this avoids the expensive fn call overhead when
892 * there are lots of c1's */
893 if (LIKELY(*s != c1)) {
895 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
902 /* failed; try searching for c2 this time; that way
903 * we don't go pathologically slow when the string
904 * consists mostly of c1's or vice versa.
909 s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
917 /* c1, c2 the same */
927 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
928 if (!s || s >= bigend)
935 /* failed to find 2 chars; try anchored match at end without
937 if (tail && bigend[0] == little[0])
938 return (char *)bigend;
943 break; /* Only lengths 0 1 and 2 have special-case code. */
946 if (tail && !multiline) { /* tail anchored? */
947 s = bigend - littlelen;
948 if (s >= big && bigend[-1] == '\n' && *s == *little
949 /* Automatically of length > 2 */
950 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
952 return (char*)s; /* how sweet it is */
955 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
957 return (char*)s + 1; /* how sweet it is */
963 /* not compiled; use Perl_ninstr() instead */
964 char * const b = ninstr((char*)big,(char*)bigend,
965 (char*)little, (char*)little + littlelen);
967 assert(!tail); /* valid => FBM; tail only set on SvVALID SVs */
972 if (littlelen > (STRLEN)(bigend - big))
976 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
977 const unsigned char *oldlittle;
981 --littlelen; /* Last char found by table lookup */
984 little += littlelen; /* last char */
987 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
988 const unsigned char lastc = *little;
992 if ((tmp = table[*s])) {
993 /* *s != lastc; earliest position it could match now is
994 * tmp slots further on */
995 if ((s += tmp) >= bigend)
997 if (LIKELY(*s != lastc)) {
999 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
1009 /* hand-rolled strncmp(): less expensive than calling the
1010 * real function (maybe???) */
1012 unsigned char * const olds = s;
1017 if (*--s == *--little)
1019 s = olds + 1; /* here we pay the price for failure */
1021 if (s < bigend) /* fake up continue to outer loop */
1031 && memEQ((char *)(bigend - littlelen),
1032 (char *)(oldlittle - littlelen), littlelen) )
1033 return (char*)bigend - littlelen;
1038 /* copy a string to a safe spot */
1041 =head1 Memory Management
1045 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1046 string which is a duplicate of C<pv>. The size of the string is
1047 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1048 characters and must have a trailing C<NUL>. The memory allocated for the new
1049 string can be freed with the C<Safefree()> function.
1051 On some platforms, Windows for example, all allocated memory owned by a thread
1052 is deallocated when that thread ends. So if you need that not to happen, you
1053 need to use the shared memory functions, such as C<L</savesharedpv>>.
1059 Perl_savepv(pTHX_ const char *pv)
1061 PERL_UNUSED_CONTEXT;
1066 const STRLEN pvlen = strlen(pv)+1;
1067 Newx(newaddr, pvlen, char);
1068 return (char*)memcpy(newaddr, pv, pvlen);
1072 /* same thing but with a known length */
1077 Perl's version of what C<strndup()> would be if it existed. Returns a
1078 pointer to a newly allocated string which is a duplicate of the first
1079 C<len> bytes from C<pv>, plus a trailing
1080 C<NUL> byte. The memory allocated for
1081 the new string can be freed with the C<Safefree()> function.
1083 On some platforms, Windows for example, all allocated memory owned by a thread
1084 is deallocated when that thread ends. So if you need that not to happen, you
1085 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1091 Perl_savepvn(pTHX_ const char *pv, I32 len)
1094 PERL_UNUSED_CONTEXT;
1098 Newx(newaddr,len+1,char);
1099 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1101 /* might not be null terminated */
1102 newaddr[len] = '\0';
1103 return (char *) CopyD(pv,newaddr,len,char);
1106 return (char *) ZeroD(newaddr,len+1,char);
1111 =for apidoc savesharedpv
1113 A version of C<savepv()> which allocates the duplicate string in memory
1114 which is shared between threads.
1119 Perl_savesharedpv(pTHX_ const char *pv)
1124 PERL_UNUSED_CONTEXT;
1129 pvlen = strlen(pv)+1;
1130 newaddr = (char*)PerlMemShared_malloc(pvlen);
1134 return (char*)memcpy(newaddr, pv, pvlen);
1138 =for apidoc savesharedpvn
1140 A version of C<savepvn()> which allocates the duplicate string in memory
1141 which is shared between threads. (With the specific difference that a C<NULL>
1142 pointer is not acceptable)
1147 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1149 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1151 PERL_UNUSED_CONTEXT;
1152 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1157 newaddr[len] = '\0';
1158 return (char*)memcpy(newaddr, pv, len);
1162 =for apidoc savesvpv
1164 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1165 the passed in SV using C<SvPV()>
1167 On some platforms, Windows for example, all allocated memory owned by a thread
1168 is deallocated when that thread ends. So if you need that not to happen, you
1169 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1175 Perl_savesvpv(pTHX_ SV *sv)
1178 const char * const pv = SvPV_const(sv, len);
1181 PERL_ARGS_ASSERT_SAVESVPV;
1184 Newx(newaddr,len,char);
1185 return (char *) CopyD(pv,newaddr,len,char);
1189 =for apidoc savesharedsvpv
1191 A version of C<savesharedpv()> which allocates the duplicate string in
1192 memory which is shared between threads.
1198 Perl_savesharedsvpv(pTHX_ SV *sv)
1201 const char * const pv = SvPV_const(sv, len);
1203 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1205 return savesharedpvn(pv, len);
1208 /* the SV for Perl_form() and mess() is not kept in an arena */
1216 if (PL_phase != PERL_PHASE_DESTRUCT)
1217 return newSVpvs_flags("", SVs_TEMP);
1222 /* Create as PVMG now, to avoid any upgrading later */
1224 Newxz(any, 1, XPVMG);
1225 SvFLAGS(sv) = SVt_PVMG;
1226 SvANY(sv) = (void*)any;
1228 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1233 #if defined(PERL_IMPLICIT_CONTEXT)
1235 Perl_form_nocontext(const char* pat, ...)
1240 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1241 va_start(args, pat);
1242 retval = vform(pat, &args);
1246 #endif /* PERL_IMPLICIT_CONTEXT */
1249 =head1 Miscellaneous Functions
1252 Takes a sprintf-style format pattern and conventional
1253 (non-SV) arguments and returns the formatted string.
1255 (char *) Perl_form(pTHX_ const char* pat, ...)
1257 can be used any place a string (char *) is required:
1259 char * s = Perl_form("%d.%d",major,minor);
1261 Uses a single private buffer so if you want to format several strings you
1262 must explicitly copy the earlier strings away (and free the copies when you
1269 Perl_form(pTHX_ const char* pat, ...)
1273 PERL_ARGS_ASSERT_FORM;
1274 va_start(args, pat);
1275 retval = vform(pat, &args);
1281 Perl_vform(pTHX_ const char *pat, va_list *args)
1283 SV * const sv = mess_alloc();
1284 PERL_ARGS_ASSERT_VFORM;
1285 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1292 Take a sprintf-style format pattern and argument list. These are used to
1293 generate a string message. If the message does not end with a newline,
1294 then it will be extended with some indication of the current location
1295 in the code, as described for L</mess_sv>.
1297 Normally, the resulting message is returned in a new mortal SV.
1298 During global destruction a single SV may be shared between uses of
1304 #if defined(PERL_IMPLICIT_CONTEXT)
1306 Perl_mess_nocontext(const char *pat, ...)
1311 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1312 va_start(args, pat);
1313 retval = vmess(pat, &args);
1317 #endif /* PERL_IMPLICIT_CONTEXT */
1320 Perl_mess(pTHX_ const char *pat, ...)
1324 PERL_ARGS_ASSERT_MESS;
1325 va_start(args, pat);
1326 retval = vmess(pat, &args);
1332 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1335 /* Look for curop starting from o. cop is the last COP we've seen. */
1336 /* opnext means that curop is actually the ->op_next of the op we are
1339 PERL_ARGS_ASSERT_CLOSEST_COP;
1341 if (!o || !curop || (
1342 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1346 if (o->op_flags & OPf_KIDS) {
1348 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1351 /* If the OP_NEXTSTATE has been optimised away we can still use it
1352 * the get the file and line number. */
1354 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1355 cop = (const COP *)kid;
1357 /* Keep searching, and return when we've found something. */
1359 new_cop = closest_cop(cop, kid, curop, opnext);
1365 /* Nothing found. */
1373 Expands a message, intended for the user, to include an indication of
1374 the current location in the code, if the message does not already appear
1377 C<basemsg> is the initial message or object. If it is a reference, it
1378 will be used as-is and will be the result of this function. Otherwise it
1379 is used as a string, and if it already ends with a newline, it is taken
1380 to be complete, and the result of this function will be the same string.
1381 If the message does not end with a newline, then a segment such as C<at
1382 foo.pl line 37> will be appended, and possibly other clauses indicating
1383 the current state of execution. The resulting message will end with a
1386 Normally, the resulting message is returned in a new mortal SV.
1387 During global destruction a single SV may be shared between uses of this
1388 function. If C<consume> is true, then the function is permitted (but not
1389 required) to modify and return C<basemsg> instead of allocating a new SV.
1395 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1399 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1403 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1404 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1405 && grok_atoUV(ws, &wi, NULL)
1406 && wi <= PERL_INT_MAX
1408 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1413 PERL_ARGS_ASSERT_MESS_SV;
1415 if (SvROK(basemsg)) {
1421 sv_setsv(sv, basemsg);
1426 if (SvPOK(basemsg) && consume) {
1431 sv_copypv(sv, basemsg);
1434 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1436 * Try and find the file and line for PL_op. This will usually be
1437 * PL_curcop, but it might be a cop that has been optimised away. We
1438 * can try to find such a cop by searching through the optree starting
1439 * from the sibling of PL_curcop.
1444 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1449 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1450 OutCopFILE(cop), (IV)CopLINE(cop));
1453 /* Seems that GvIO() can be untrustworthy during global destruction. */
1454 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1455 && IoLINES(GvIOp(PL_last_in_gv)))
1458 const bool line_mode = (RsSIMPLE(PL_rs) &&
1459 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1460 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1461 SVfARG(PL_last_in_gv == PL_argvgv
1463 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1464 line_mode ? "line" : "chunk",
1465 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1467 if (PL_phase == PERL_PHASE_DESTRUCT)
1468 sv_catpvs(sv, " during global destruction");
1469 sv_catpvs(sv, ".\n");
1477 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1478 argument list, respectively. These are used to generate a string message. If
1480 message does not end with a newline, then it will be extended with
1481 some indication of the current location in the code, as described for
1484 Normally, the resulting message is returned in a new mortal SV.
1485 During global destruction a single SV may be shared between uses of
1492 Perl_vmess(pTHX_ const char *pat, va_list *args)
1494 SV * const sv = mess_alloc();
1496 PERL_ARGS_ASSERT_VMESS;
1498 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1499 return mess_sv(sv, 1);
1503 Perl_write_to_stderr(pTHX_ SV* msv)
1508 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1510 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1511 && (io = GvIO(PL_stderrgv))
1512 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1513 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1514 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1516 PerlIO * const serr = Perl_error_log;
1518 do_print(msv, serr);
1519 (void)PerlIO_flush(serr);
1524 =head1 Warning and Dieing
1527 /* Common code used in dieing and warning */
1530 S_with_queued_errors(pTHX_ SV *ex)
1532 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1533 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1534 sv_catsv(PL_errors, ex);
1535 ex = sv_mortalcopy(PL_errors);
1536 SvCUR_set(PL_errors, 0);
1542 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1548 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1549 /* sv_2cv might call Perl_croak() or Perl_warner() */
1550 SV * const oldhook = *hook;
1552 if (!oldhook || oldhook == PERL_WARNHOOK_FATAL)
1558 cv = sv_2cv(oldhook, &stash, &gv, 0);
1560 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1570 exarg = newSVsv(ex);
1571 SvREADONLY_on(exarg);
1574 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1578 call_sv(MUTABLE_SV(cv), G_DISCARD);
1589 Behaves the same as L</croak_sv>, except for the return type.
1590 It should be used only where the C<OP *> return type is required.
1591 The function never actually returns.
1596 /* silence __declspec(noreturn) warnings */
1597 MSVC_DIAG_IGNORE(4646 4645)
1599 Perl_die_sv(pTHX_ SV *baseex)
1601 PERL_ARGS_ASSERT_DIE_SV;
1604 NORETURN_FUNCTION_END;
1611 Behaves the same as L</croak>, except for the return type.
1612 It should be used only where the C<OP *> return type is required.
1613 The function never actually returns.
1618 #if defined(PERL_IMPLICIT_CONTEXT)
1620 /* silence __declspec(noreturn) warnings */
1621 MSVC_DIAG_IGNORE(4646 4645)
1623 Perl_die_nocontext(const char* pat, ...)
1627 va_start(args, pat);
1629 NOT_REACHED; /* NOTREACHED */
1631 NORETURN_FUNCTION_END;
1635 #endif /* PERL_IMPLICIT_CONTEXT */
1637 /* silence __declspec(noreturn) warnings */
1638 MSVC_DIAG_IGNORE(4646 4645)
1640 Perl_die(pTHX_ const char* pat, ...)
1643 va_start(args, pat);
1645 NOT_REACHED; /* NOTREACHED */
1647 NORETURN_FUNCTION_END;
1652 =for apidoc croak_sv
1654 This is an XS interface to Perl's C<die> function.
1656 C<baseex> is the error message or object. If it is a reference, it
1657 will be used as-is. Otherwise it is used as a string, and if it does
1658 not end with a newline then it will be extended with some indication of
1659 the current location in the code, as described for L</mess_sv>.
1661 The error message or object will be used as an exception, by default
1662 returning control to the nearest enclosing C<eval>, but subject to
1663 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1664 function never returns normally.
1666 To die with a simple string message, the L</croak> function may be
1673 Perl_croak_sv(pTHX_ SV *baseex)
1675 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1676 PERL_ARGS_ASSERT_CROAK_SV;
1677 invoke_exception_hook(ex, FALSE);
1684 This is an XS interface to Perl's C<die> function.
1686 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1687 argument list. These are used to generate a string message. If the
1688 message does not end with a newline, then it will be extended with
1689 some indication of the current location in the code, as described for
1692 The error message will be used as an exception, by default
1693 returning control to the nearest enclosing C<eval>, but subject to
1694 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1695 function never returns normally.
1697 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1698 (C<$@>) will be used as an error message or object instead of building an
1699 error message from arguments. If you want to throw a non-string object,
1700 or build an error message in an SV yourself, it is preferable to use
1701 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1707 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1709 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1710 invoke_exception_hook(ex, FALSE);
1717 This is an XS interface to Perl's C<die> function.
1719 Take a sprintf-style format pattern and argument list. These are used to
1720 generate a string message. If the message does not end with a newline,
1721 then it will be extended with some indication of the current location
1722 in the code, as described for L</mess_sv>.
1724 The error message will be used as an exception, by default
1725 returning control to the nearest enclosing C<eval>, but subject to
1726 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1727 function never returns normally.
1729 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1730 (C<$@>) will be used as an error message or object instead of building an
1731 error message from arguments. If you want to throw a non-string object,
1732 or build an error message in an SV yourself, it is preferable to use
1733 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1738 #if defined(PERL_IMPLICIT_CONTEXT)
1740 Perl_croak_nocontext(const char *pat, ...)
1744 va_start(args, pat);
1746 NOT_REACHED; /* NOTREACHED */
1749 #endif /* PERL_IMPLICIT_CONTEXT */
1752 Perl_croak(pTHX_ const char *pat, ...)
1755 va_start(args, pat);
1757 NOT_REACHED; /* NOTREACHED */
1762 =for apidoc croak_no_modify
1764 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1765 terser object code than using C<Perl_croak>. Less code used on exception code
1766 paths reduces CPU cache pressure.
1772 Perl_croak_no_modify(void)
1774 Perl_croak_nocontext( "%s", PL_no_modify);
1777 /* does not return, used in util.c perlio.c and win32.c
1778 This is typically called when malloc returns NULL.
1781 Perl_croak_no_mem(void)
1785 int fd = PerlIO_fileno(Perl_error_log);
1787 SETERRNO(EBADF,RMS_IFI);
1789 /* Can't use PerlIO to write as it allocates memory */
1790 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1795 /* does not return, used only in POPSTACK */
1797 Perl_croak_popstack(void)
1800 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1807 This is an XS interface to Perl's C<warn> function.
1809 C<baseex> is the error message or object. If it is a reference, it
1810 will be used as-is. Otherwise it is used as a string, and if it does
1811 not end with a newline then it will be extended with some indication of
1812 the current location in the code, as described for L</mess_sv>.
1814 The error message or object will by default be written to standard error,
1815 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1817 To warn with a simple string message, the L</warn> function may be
1824 Perl_warn_sv(pTHX_ SV *baseex)
1826 SV *ex = mess_sv(baseex, 0);
1827 PERL_ARGS_ASSERT_WARN_SV;
1828 if (!invoke_exception_hook(ex, TRUE))
1829 write_to_stderr(ex);
1835 This is an XS interface to Perl's C<warn> function.
1837 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1838 argument list. These are used to generate a string message. If the
1839 message does not end with a newline, then it will be extended with
1840 some indication of the current location in the code, as described for
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 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1852 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1854 SV *ex = vmess(pat, args);
1855 PERL_ARGS_ASSERT_VWARN;
1856 if (!invoke_exception_hook(ex, TRUE))
1857 write_to_stderr(ex);
1863 This is an XS interface to Perl's C<warn> function.
1865 Take a sprintf-style format pattern and argument list. These are used to
1866 generate a string message. If the message does not end with a newline,
1867 then it will be extended with some indication of the current location
1868 in the code, as described for L</mess_sv>.
1870 The error message or object will by default be written to standard error,
1871 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1873 Unlike with L</croak>, C<pat> is not permitted to be null.
1878 #if defined(PERL_IMPLICIT_CONTEXT)
1880 Perl_warn_nocontext(const char *pat, ...)
1884 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1885 va_start(args, pat);
1889 #endif /* PERL_IMPLICIT_CONTEXT */
1892 Perl_warn(pTHX_ const char *pat, ...)
1895 PERL_ARGS_ASSERT_WARN;
1896 va_start(args, pat);
1901 #if defined(PERL_IMPLICIT_CONTEXT)
1903 Perl_warner_nocontext(U32 err, const char *pat, ...)
1907 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1908 va_start(args, pat);
1909 vwarner(err, pat, &args);
1912 #endif /* PERL_IMPLICIT_CONTEXT */
1915 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1917 PERL_ARGS_ASSERT_CK_WARNER_D;
1919 if (Perl_ckwarn_d(aTHX_ err)) {
1921 va_start(args, pat);
1922 vwarner(err, pat, &args);
1928 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1930 PERL_ARGS_ASSERT_CK_WARNER;
1932 if (Perl_ckwarn(aTHX_ err)) {
1934 va_start(args, pat);
1935 vwarner(err, pat, &args);
1941 Perl_warner(pTHX_ U32 err, const char* pat,...)
1944 PERL_ARGS_ASSERT_WARNER;
1945 va_start(args, pat);
1946 vwarner(err, pat, &args);
1951 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1954 PERL_ARGS_ASSERT_VWARNER;
1956 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
1957 !(PL_in_eval & EVAL_KEEPERR)
1959 SV * const msv = vmess(pat, args);
1961 if (PL_parser && PL_parser->error_count) {
1965 invoke_exception_hook(msv, FALSE);
1970 Perl_vwarn(aTHX_ pat, args);
1974 /* implements the ckWARN? macros */
1977 Perl_ckwarn(pTHX_ U32 w)
1979 /* If lexical warnings have not been set, use $^W. */
1981 return PL_dowarn & G_WARN_ON;
1983 return ckwarn_common(w);
1986 /* implements the ckWARN?_d macro */
1989 Perl_ckwarn_d(pTHX_ U32 w)
1991 /* If lexical warnings have not been set then default classes warn. */
1995 return ckwarn_common(w);
1999 S_ckwarn_common(pTHX_ U32 w)
2001 if (PL_curcop->cop_warnings == pWARN_ALL)
2004 if (PL_curcop->cop_warnings == pWARN_NONE)
2007 /* Check the assumption that at least the first slot is non-zero. */
2008 assert(unpackWARN1(w));
2010 /* Check the assumption that it is valid to stop as soon as a zero slot is
2012 if (!unpackWARN2(w)) {
2013 assert(!unpackWARN3(w));
2014 assert(!unpackWARN4(w));
2015 } else if (!unpackWARN3(w)) {
2016 assert(!unpackWARN4(w));
2019 /* Right, dealt with all the special cases, which are implemented as non-
2020 pointers, so there is a pointer to a real warnings mask. */
2022 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2024 } while (w >>= WARNshift);
2029 /* Set buffer=NULL to get a new one. */
2031 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2033 const MEM_SIZE len_wanted =
2034 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2035 PERL_UNUSED_CONTEXT;
2036 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2039 (specialWARN(buffer) ?
2040 PerlMemShared_malloc(len_wanted) :
2041 PerlMemShared_realloc(buffer, len_wanted));
2043 Copy(bits, (buffer + 1), size, char);
2044 if (size < WARNsize)
2045 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2049 /* since we've already done strlen() for both nam and val
2050 * we can use that info to make things faster than
2051 * sprintf(s, "%s=%s", nam, val)
2053 #define my_setenv_format(s, nam, nlen, val, vlen) \
2054 Copy(nam, s, nlen, char); \
2056 Copy(val, s+(nlen+1), vlen, char); \
2057 *(s+(nlen+1+vlen)) = '\0'
2061 #ifdef USE_ENVIRON_ARRAY
2062 /* NB: VMS' my_setenv() is in vms.c */
2064 /* Configure doesn't test for HAS_SETENV yet, so decide based on platform.
2065 * For Solaris, setenv() and unsetenv() were introduced in Solaris 9, so
2066 * testing for HAS UNSETENV is sufficient.
2068 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2069 # define MY_HAS_SETENV
2072 /* small wrapper for use by Perl_my_setenv that mallocs, or reallocs if
2073 * 'current' is non-null, with up to three sizes that are added together.
2074 * It handles integer overflow.
2076 # ifndef MY_HAS_SETENV
2078 S_env_alloc(void *current, Size_t l1, Size_t l2, Size_t l3, Size_t size)
2081 Size_t sl, l = l1 + l2;
2093 ? safesysrealloc(current, sl)
2094 : safesysmalloc(sl);
2099 croak_memory_wrap();
2104 # if !defined(WIN32) && !defined(NETWARE)
2107 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2110 # ifdef __amigaos4__
2111 amigaos4_obtain_environ(__FUNCTION__);
2114 # ifdef USE_ITHREADS
2115 /* only parent thread can modify process environment */
2116 if (PL_curinterp == aTHX)
2120 # ifndef PERL_USE_SAFE_PUTENV
2121 if (!PL_use_safe_putenv) {
2122 /* most putenv()s leak, so we manipulate environ directly */
2124 Size_t vlen, nlen = strlen(nam);
2126 /* where does it go? */
2127 for (i = 0; environ[i]; i++) {
2128 if (strnEQ(environ[i], nam, nlen) && environ[i][nlen] == '=')
2132 if (environ == PL_origenviron) { /* need we copy environment? */
2137 while (environ[max])
2140 /* XXX shouldn't that be max+1 rather than max+2 ??? - DAPM */
2141 tmpenv = (char**)S_env_alloc(NULL, max, 2, 0, sizeof(char*));
2143 for (j=0; j<max; j++) { /* copy environment */
2144 const Size_t len = strlen(environ[j]);
2145 tmpenv[j] = S_env_alloc(NULL, len, 1, 0, 1);
2146 Copy(environ[j], tmpenv[j], len+1, char);
2150 environ = tmpenv; /* tell exec where it is now */
2154 safesysfree(environ[i]);
2155 while (environ[i]) {
2156 environ[i] = environ[i+1];
2159 # ifdef __amigaos4__
2166 if (!environ[i]) { /* does not exist yet */
2167 environ = (char**)S_env_alloc(environ, i, 2, 0, sizeof(char*));
2168 environ[i+1] = NULL; /* make sure it's null terminated */
2171 safesysfree(environ[i]);
2175 environ[i] = S_env_alloc(NULL, nlen, vlen, 2, 1);
2176 /* all that work just for this */
2177 my_setenv_format(environ[i], nam, nlen, val, vlen);
2181 # endif /* !PERL_USE_SAFE_PUTENV */
2183 # ifdef MY_HAS_SETENV
2184 # if defined(HAS_UNSETENV)
2186 (void)unsetenv(nam);
2188 (void)setenv(nam, val, 1);
2190 # else /* ! HAS_UNSETENV */
2191 (void)setenv(nam, val, 1);
2192 # endif /* HAS_UNSETENV */
2194 # elif defined(HAS_UNSETENV)
2197 if (environ) /* old glibc can crash with null environ */
2198 (void)unsetenv(nam);
2200 const Size_t nlen = strlen(nam);
2201 const Size_t vlen = strlen(val);
2202 char * const new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2203 my_setenv_format(new_env, nam, nlen, val, vlen);
2204 (void)putenv(new_env);
2207 # else /* ! HAS_UNSETENV */
2210 const Size_t nlen = strlen(nam);
2216 new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2217 /* all that work just for this */
2218 my_setenv_format(new_env, nam, nlen, val, vlen);
2219 (void)putenv(new_env);
2221 # endif /* MY_HAS_SETENV */
2223 # ifndef PERL_USE_SAFE_PUTENV
2228 # ifdef __amigaos4__
2230 amigaos4_release_environ(__FUNCTION__);
2234 # else /* WIN32 || NETWARE */
2237 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2241 const Size_t nlen = strlen(nam);
2248 envstr = S_env_alloc(NULL, nlen, vlen, 2, 1);
2249 my_setenv_format(envstr, nam, nlen, val, vlen);
2250 (void)PerlEnv_putenv(envstr);
2254 # endif /* WIN32 || NETWARE */
2256 #endif /* USE_ENVIRON_ARRAY */
2261 #ifdef UNLINK_ALL_VERSIONS
2263 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2267 PERL_ARGS_ASSERT_UNLNK;
2269 while (PerlLIO_unlink(f) >= 0)
2271 return retries ? 0 : -1;
2276 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2278 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2286 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2288 PERL_FLUSHALL_FOR_CHILD;
2289 This = (*mode == 'w');
2293 taint_proper("Insecure %s%s", "EXEC");
2295 if (PerlProc_pipe_cloexec(p) < 0)
2297 /* Try for another pipe pair for error return */
2298 if (PerlProc_pipe_cloexec(pp) >= 0)
2300 while ((pid = PerlProc_fork()) < 0) {
2301 if (errno != EAGAIN) {
2302 PerlLIO_close(p[This]);
2303 PerlLIO_close(p[that]);
2305 PerlLIO_close(pp[0]);
2306 PerlLIO_close(pp[1]);
2310 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2319 /* Close parent's end of error status pipe (if any) */
2321 PerlLIO_close(pp[0]);
2322 /* Now dup our end of _the_ pipe to right position */
2323 if (p[THIS] != (*mode == 'r')) {
2324 PerlLIO_dup2(p[THIS], *mode == 'r');
2325 PerlLIO_close(p[THIS]);
2326 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2327 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2330 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2331 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2333 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2334 /* No automatic close - do it by hand */
2341 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2347 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2354 PerlLIO_close(pp[1]);
2355 /* Keep the lower of the two fd numbers */
2356 if (p[that] < p[This]) {
2357 PerlLIO_dup2_cloexec(p[This], p[that]);
2358 PerlLIO_close(p[This]);
2362 PerlLIO_close(p[that]); /* close child's end of pipe */
2364 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2365 SvUPGRADE(sv,SVt_IV);
2367 PL_forkprocess = pid;
2368 /* If we managed to get status pipe check for exec fail */
2369 if (did_pipes && pid > 0) {
2373 while (n < sizeof(int)) {
2374 const SSize_t n1 = PerlLIO_read(pp[0],
2375 (void*)(((char*)&errkid)+n),
2381 PerlLIO_close(pp[0]);
2383 if (n) { /* Error */
2385 PerlLIO_close(p[This]);
2386 if (n != sizeof(int))
2387 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2389 pid2 = wait4pid(pid, &status, 0);
2390 } while (pid2 == -1 && errno == EINTR);
2391 errno = errkid; /* Propagate errno from kid */
2396 PerlLIO_close(pp[0]);
2397 return PerlIO_fdopen(p[This], mode);
2399 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2400 return my_syspopen4(aTHX_ NULL, mode, n, args);
2401 # elif defined(WIN32)
2402 return win32_popenlist(mode, n, args);
2404 Perl_croak(aTHX_ "List form of piped open not implemented");
2405 return (PerlIO *) NULL;
2410 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2411 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2413 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2419 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2423 PERL_ARGS_ASSERT_MY_POPEN;
2425 PERL_FLUSHALL_FOR_CHILD;
2428 return my_syspopen(aTHX_ cmd,mode);
2431 This = (*mode == 'w');
2433 if (doexec && TAINTING_get) {
2435 taint_proper("Insecure %s%s", "EXEC");
2437 if (PerlProc_pipe_cloexec(p) < 0)
2439 if (doexec && PerlProc_pipe_cloexec(pp) >= 0)
2441 while ((pid = PerlProc_fork()) < 0) {
2442 if (errno != EAGAIN) {
2443 PerlLIO_close(p[This]);
2444 PerlLIO_close(p[that]);
2446 PerlLIO_close(pp[0]);
2447 PerlLIO_close(pp[1]);
2450 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2453 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2463 PerlLIO_close(pp[0]);
2464 if (p[THIS] != (*mode == 'r')) {
2465 PerlLIO_dup2(p[THIS], *mode == 'r');
2466 PerlLIO_close(p[THIS]);
2467 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2468 PerlLIO_close(p[THAT]);
2471 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2472 PerlLIO_close(p[THAT]);
2476 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2483 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2488 /* may or may not use the shell */
2489 do_exec3(cmd, pp[1], did_pipes);
2492 #endif /* defined OS2 */
2494 #ifdef PERLIO_USING_CRLF
2495 /* Since we circumvent IO layers when we manipulate low-level
2496 filedescriptors directly, need to manually switch to the
2497 default, binary, low-level mode; see PerlIOBuf_open(). */
2498 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2501 #ifdef PERL_USES_PL_PIDSTATUS
2502 hv_clear(PL_pidstatus); /* we have no children */
2509 PerlLIO_close(pp[1]);
2510 if (p[that] < p[This]) {
2511 PerlLIO_dup2_cloexec(p[This], p[that]);
2512 PerlLIO_close(p[This]);
2516 PerlLIO_close(p[that]);
2518 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2519 SvUPGRADE(sv,SVt_IV);
2521 PL_forkprocess = pid;
2522 if (did_pipes && pid > 0) {
2526 while (n < sizeof(int)) {
2527 const SSize_t n1 = PerlLIO_read(pp[0],
2528 (void*)(((char*)&errkid)+n),
2534 PerlLIO_close(pp[0]);
2536 if (n) { /* Error */
2538 PerlLIO_close(p[This]);
2539 if (n != sizeof(int))
2540 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2542 pid2 = wait4pid(pid, &status, 0);
2543 } while (pid2 == -1 && errno == EINTR);
2544 errno = errkid; /* Propagate errno from kid */
2549 PerlLIO_close(pp[0]);
2550 return PerlIO_fdopen(p[This], mode);
2552 #elif defined(DJGPP)
2553 FILE *djgpp_popen();
2555 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2557 PERL_FLUSHALL_FOR_CHILD;
2558 /* Call system's popen() to get a FILE *, then import it.
2559 used 0 for 2nd parameter to PerlIO_importFILE;
2562 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2564 #elif defined(__LIBCATAMOUNT__)
2566 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2571 #endif /* !DOSISH */
2573 /* this is called in parent before the fork() */
2575 Perl_atfork_lock(void)
2576 #if defined(USE_ITHREADS)
2578 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2581 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2583 PERL_TSA_ACQUIRE(PL_op_mutex)
2586 #if defined(USE_ITHREADS)
2588 /* locks must be held in locking order (if any) */
2590 MUTEX_LOCK(&PL_perlio_mutex);
2593 MUTEX_LOCK(&PL_malloc_mutex);
2599 /* this is called in both parent and child after the fork() */
2601 Perl_atfork_unlock(void)
2602 #if defined(USE_ITHREADS)
2604 PERL_TSA_RELEASE(PL_perlio_mutex)
2607 PERL_TSA_RELEASE(PL_malloc_mutex)
2609 PERL_TSA_RELEASE(PL_op_mutex)
2612 #if defined(USE_ITHREADS)
2614 /* locks must be released in same order as in atfork_lock() */
2616 MUTEX_UNLOCK(&PL_perlio_mutex);
2619 MUTEX_UNLOCK(&PL_malloc_mutex);
2628 #if defined(HAS_FORK)
2630 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2635 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2636 * handlers elsewhere in the code */
2640 #elif defined(__amigaos4__)
2641 return amigaos_fork();
2643 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2644 Perl_croak_nocontext("fork() not available");
2646 #endif /* HAS_FORK */
2651 dup2(int oldfd, int newfd)
2653 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2656 PerlLIO_close(newfd);
2657 return fcntl(oldfd, F_DUPFD, newfd);
2659 #define DUP2_MAX_FDS 256
2660 int fdtmp[DUP2_MAX_FDS];
2666 PerlLIO_close(newfd);
2667 /* good enough for low fd's... */
2668 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2669 if (fdx >= DUP2_MAX_FDS) {
2677 PerlLIO_close(fdtmp[--fdx]);
2684 #ifdef HAS_SIGACTION
2687 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2689 struct sigaction act, oact;
2693 /* only "parent" interpreter can diddle signals */
2694 if (PL_curinterp != aTHX)
2695 return (Sighandler_t) SIG_ERR;
2698 act.sa_handler = (void(*)(int))handler;
2699 sigemptyset(&act.sa_mask);
2702 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2703 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2705 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2706 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2707 act.sa_flags |= SA_NOCLDWAIT;
2709 if (sigaction(signo, &act, &oact) == -1)
2710 return (Sighandler_t) SIG_ERR;
2712 return (Sighandler_t) oact.sa_handler;
2716 Perl_rsignal_state(pTHX_ int signo)
2718 struct sigaction oact;
2719 PERL_UNUSED_CONTEXT;
2721 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2722 return (Sighandler_t) SIG_ERR;
2724 return (Sighandler_t) oact.sa_handler;
2728 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2733 struct sigaction act;
2735 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2738 /* only "parent" interpreter can diddle signals */
2739 if (PL_curinterp != aTHX)
2743 act.sa_handler = (void(*)(int))handler;
2744 sigemptyset(&act.sa_mask);
2747 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2748 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2750 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2751 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2752 act.sa_flags |= SA_NOCLDWAIT;
2754 return sigaction(signo, &act, save);
2758 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2763 PERL_UNUSED_CONTEXT;
2765 /* only "parent" interpreter can diddle signals */
2766 if (PL_curinterp != aTHX)
2770 return sigaction(signo, save, (struct sigaction *)NULL);
2773 #else /* !HAS_SIGACTION */
2776 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2778 #if defined(USE_ITHREADS) && !defined(WIN32)
2779 /* only "parent" interpreter can diddle signals */
2780 if (PL_curinterp != aTHX)
2781 return (Sighandler_t) SIG_ERR;
2784 return PerlProc_signal(signo, handler);
2795 Perl_rsignal_state(pTHX_ int signo)
2798 Sighandler_t oldsig;
2800 #if defined(USE_ITHREADS) && !defined(WIN32)
2801 /* only "parent" interpreter can diddle signals */
2802 if (PL_curinterp != aTHX)
2803 return (Sighandler_t) SIG_ERR;
2807 oldsig = PerlProc_signal(signo, sig_trap);
2808 PerlProc_signal(signo, oldsig);
2810 PerlProc_kill(PerlProc_getpid(), signo);
2815 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2817 #if defined(USE_ITHREADS) && !defined(WIN32)
2818 /* only "parent" interpreter can diddle signals */
2819 if (PL_curinterp != aTHX)
2822 *save = PerlProc_signal(signo, handler);
2823 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2827 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2829 #if defined(USE_ITHREADS) && !defined(WIN32)
2830 /* only "parent" interpreter can diddle signals */
2831 if (PL_curinterp != aTHX)
2834 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2837 #endif /* !HAS_SIGACTION */
2838 #endif /* !PERL_MICRO */
2840 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2841 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2843 Perl_my_pclose(pTHX_ PerlIO *ptr)
2851 const int fd = PerlIO_fileno(ptr);
2854 svp = av_fetch(PL_fdpid,fd,TRUE);
2855 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2859 #if defined(USE_PERLIO)
2860 /* Find out whether the refcount is low enough for us to wait for the
2861 child proc without blocking. */
2862 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
2864 should_wait = pid > 0;
2868 if (pid == -1) { /* Opened by popen. */
2869 return my_syspclose(ptr);
2872 close_failed = (PerlIO_close(ptr) == EOF);
2874 if (should_wait) do {
2875 pid2 = wait4pid(pid, &status, 0);
2876 } while (pid2 == -1 && errno == EINTR);
2883 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2887 #elif defined(__LIBCATAMOUNT__)
2889 Perl_my_pclose(pTHX_ PerlIO *ptr)
2893 #endif /* !DOSISH */
2895 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2897 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
2900 PERL_ARGS_ASSERT_WAIT4PID;
2901 #ifdef PERL_USES_PL_PIDSTATUS
2903 /* PERL_USES_PL_PIDSTATUS is only defined when neither
2904 waitpid() nor wait4() is available, or on OS/2, which
2905 doesn't appear to support waiting for a progress group
2906 member, so we can only treat a 0 pid as an unknown child.
2913 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
2914 pid, rather than a string form. */
2915 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
2916 if (svp && *svp != &PL_sv_undef) {
2917 *statusp = SvIVX(*svp);
2918 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
2926 hv_iterinit(PL_pidstatus);
2927 if ((entry = hv_iternext(PL_pidstatus))) {
2928 SV * const sv = hv_iterval(PL_pidstatus,entry);
2930 const char * const spid = hv_iterkey(entry,&len);
2932 assert (len == sizeof(Pid_t));
2933 memcpy((char *)&pid, spid, len);
2934 *statusp = SvIVX(sv);
2935 /* The hash iterator is currently on this entry, so simply
2936 calling hv_delete would trigger the lazy delete, which on
2937 aggregate does more work, because next call to hv_iterinit()
2938 would spot the flag, and have to call the delete routine,
2939 while in the meantime any new entries can't re-use that
2941 hv_iterinit(PL_pidstatus);
2942 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
2949 # ifdef HAS_WAITPID_RUNTIME
2950 if (!HAS_WAITPID_RUNTIME)
2953 result = PerlProc_waitpid(pid,statusp,flags);
2956 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
2957 result = wait4(pid,statusp,flags,NULL);
2960 #ifdef PERL_USES_PL_PIDSTATUS
2961 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
2966 Perl_croak(aTHX_ "Can't do waitpid with flags");
2968 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
2969 pidgone(result,*statusp);
2975 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
2978 if (result < 0 && errno == EINTR) {
2980 errno = EINTR; /* reset in case a signal handler changed $! */
2984 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
2986 #ifdef PERL_USES_PL_PIDSTATUS
2988 S_pidgone(pTHX_ Pid_t pid, int status)
2992 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
2993 SvUPGRADE(sv,SVt_IV);
2994 SvIV_set(sv, status);
3002 int /* Cannot prototype with I32
3004 my_syspclose(PerlIO *ptr)
3007 Perl_my_pclose(pTHX_ PerlIO *ptr)
3010 /* Needs work for PerlIO ! */
3011 FILE * const f = PerlIO_findFILE(ptr);
3012 const I32 result = pclose(f);
3013 PerlIO_releaseFILE(ptr,f);
3021 Perl_my_pclose(pTHX_ PerlIO *ptr)
3023 /* Needs work for PerlIO ! */
3024 FILE * const f = PerlIO_findFILE(ptr);
3025 I32 result = djgpp_pclose(f);
3026 result = (result << 8) & 0xff00;
3027 PerlIO_releaseFILE(ptr,f);
3032 #define PERL_REPEATCPY_LINEAR 4
3034 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3036 PERL_ARGS_ASSERT_REPEATCPY;
3041 croak_memory_wrap();
3044 memset(to, *from, count);
3047 IV items, linear, half;
3049 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3050 for (items = 0; items < linear; ++items) {
3051 const char *q = from;
3053 for (todo = len; todo > 0; todo--)
3058 while (items <= half) {
3059 IV size = items * len;
3060 memcpy(p, to, size);
3066 memcpy(p, to, (count - items) * len);
3072 Perl_same_dirent(pTHX_ const char *a, const char *b)
3074 char *fa = strrchr(a,'/');
3075 char *fb = strrchr(b,'/');
3078 SV * const tmpsv = sv_newmortal();
3080 PERL_ARGS_ASSERT_SAME_DIRENT;
3093 sv_setpvs(tmpsv, ".");
3095 sv_setpvn(tmpsv, a, fa - a);
3096 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3099 sv_setpvs(tmpsv, ".");
3101 sv_setpvn(tmpsv, b, fb - b);
3102 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3104 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3105 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3107 #endif /* !HAS_RENAME */
3110 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3111 const char *const *const search_ext, I32 flags)
3113 const char *xfound = NULL;
3114 char *xfailed = NULL;
3115 char tmpbuf[MAXPATHLEN];
3120 #if defined(DOSISH) && !defined(OS2)
3121 # define SEARCH_EXTS ".bat", ".cmd", NULL
3122 # define MAX_EXT_LEN 4
3125 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3126 # define MAX_EXT_LEN 4
3129 # define SEARCH_EXTS ".pl", ".com", NULL
3130 # define MAX_EXT_LEN 4
3132 /* additional extensions to try in each dir if scriptname not found */
3134 static const char *const exts[] = { SEARCH_EXTS };
3135 const char *const *const ext = search_ext ? search_ext : exts;
3136 int extidx = 0, i = 0;
3137 const char *curext = NULL;
3139 PERL_UNUSED_ARG(search_ext);
3140 # define MAX_EXT_LEN 0
3143 PERL_ARGS_ASSERT_FIND_SCRIPT;
3146 * If dosearch is true and if scriptname does not contain path
3147 * delimiters, search the PATH for scriptname.
3149 * If SEARCH_EXTS is also defined, will look for each
3150 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3151 * while searching the PATH.
3153 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3154 * proceeds as follows:
3155 * If DOSISH or VMSISH:
3156 * + look for ./scriptname{,.foo,.bar}
3157 * + search the PATH for scriptname{,.foo,.bar}
3160 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3161 * this will not look in '.' if it's not in the PATH)
3166 # ifdef ALWAYS_DEFTYPES
3167 len = strlen(scriptname);
3168 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3169 int idx = 0, deftypes = 1;
3172 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3175 int idx = 0, deftypes = 1;
3178 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3180 /* The first time through, just add SEARCH_EXTS to whatever we
3181 * already have, so we can check for default file types. */
3183 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3190 if ((strlen(tmpbuf) + strlen(scriptname)
3191 + MAX_EXT_LEN) >= sizeof tmpbuf)
3192 continue; /* don't search dir with too-long name */
3193 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3197 if (strEQ(scriptname, "-"))
3199 if (dosearch) { /* Look in '.' first. */
3200 const char *cur = scriptname;
3202 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3204 if (strEQ(ext[i++],curext)) {
3205 extidx = -1; /* already has an ext */
3210 DEBUG_p(PerlIO_printf(Perl_debug_log,
3211 "Looking for %s\n",cur));
3214 if (PerlLIO_stat(cur,&statbuf) >= 0
3215 && !S_ISDIR(statbuf.st_mode)) {
3224 if (cur == scriptname) {
3225 len = strlen(scriptname);
3226 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3228 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3231 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3232 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3237 if (dosearch && !strchr(scriptname, '/')
3239 && !strchr(scriptname, '\\')
3241 && (s = PerlEnv_getenv("PATH")))
3245 bufend = s + strlen(s);
3246 while (s < bufend) {
3250 && *s != ';'; len++, s++) {
3251 if (len < sizeof tmpbuf)
3254 if (len < sizeof tmpbuf)
3257 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3262 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3263 continue; /* don't search dir with too-long name */
3266 && tmpbuf[len - 1] != '/'
3267 && tmpbuf[len - 1] != '\\'
3270 tmpbuf[len++] = '/';
3271 if (len == 2 && tmpbuf[0] == '.')
3273 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3277 len = strlen(tmpbuf);
3278 if (extidx > 0) /* reset after previous loop */
3282 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3283 retval = PerlLIO_stat(tmpbuf,&statbuf);
3284 if (S_ISDIR(statbuf.st_mode)) {
3288 } while ( retval < 0 /* not there */
3289 && extidx>=0 && ext[extidx] /* try an extension? */
3290 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3295 if (S_ISREG(statbuf.st_mode)
3296 && cando(S_IRUSR,TRUE,&statbuf)
3297 #if !defined(DOSISH)
3298 && cando(S_IXUSR,TRUE,&statbuf)
3302 xfound = tmpbuf; /* bingo! */
3306 xfailed = savepv(tmpbuf);
3311 if (!xfound && !seen_dot && !xfailed &&
3312 (PerlLIO_stat(scriptname,&statbuf) < 0
3313 || S_ISDIR(statbuf.st_mode)))
3315 seen_dot = 1; /* Disable message. */
3320 if (flags & 1) { /* do or die? */
3321 /* diag_listed_as: Can't execute %s */
3322 Perl_croak(aTHX_ "Can't %s %s%s%s",
3323 (xfailed ? "execute" : "find"),
3324 (xfailed ? xfailed : scriptname),
3325 (xfailed ? "" : " on PATH"),
3326 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3331 scriptname = xfound;
3333 return (scriptname ? savepv(scriptname) : NULL);
3336 #ifndef PERL_GET_CONTEXT_DEFINED
3339 Perl_get_context(void)
3341 #if defined(USE_ITHREADS)
3343 # ifdef OLD_PTHREADS_API
3345 int error = pthread_getspecific(PL_thr_key, &t)
3347 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3349 # elif defined(I_MACH_CTHREADS)
3350 return (void*)cthread_data(cthread_self());
3352 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3360 Perl_set_context(void *t)
3362 #if defined(USE_ITHREADS)
3365 PERL_ARGS_ASSERT_SET_CONTEXT;
3366 #if defined(USE_ITHREADS)
3367 # ifdef I_MACH_CTHREADS
3368 cthread_set_data(cthread_self(), t);
3371 const int error = pthread_setspecific(PL_thr_key, t);
3373 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3381 #endif /* !PERL_GET_CONTEXT_DEFINED */
3383 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3387 PERL_UNUSED_CONTEXT;
3393 Perl_get_op_names(pTHX)
3395 PERL_UNUSED_CONTEXT;
3396 return (char **)PL_op_name;
3400 Perl_get_op_descs(pTHX)
3402 PERL_UNUSED_CONTEXT;
3403 return (char **)PL_op_desc;
3407 Perl_get_no_modify(pTHX)
3409 PERL_UNUSED_CONTEXT;
3410 return PL_no_modify;
3414 Perl_get_opargs(pTHX)
3416 PERL_UNUSED_CONTEXT;
3417 return (U32 *)PL_opargs;
3421 Perl_get_ppaddr(pTHX)
3424 PERL_UNUSED_CONTEXT;
3425 return (PPADDR_t*)PL_ppaddr;
3428 #ifndef HAS_GETENV_LEN
3430 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3432 char * const env_trans = PerlEnv_getenv(env_elem);
3433 PERL_UNUSED_CONTEXT;
3434 PERL_ARGS_ASSERT_GETENV_LEN;
3436 *len = strlen(env_trans);
3443 Perl_get_vtbl(pTHX_ int vtbl_id)
3445 PERL_UNUSED_CONTEXT;
3447 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3448 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3452 Perl_my_fflush_all(pTHX)
3454 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3455 return PerlIO_flush(NULL);
3457 # if defined(HAS__FWALK)
3458 extern int fflush(FILE *);
3459 /* undocumented, unprototyped, but very useful BSDism */
3460 extern void _fwalk(int (*)(FILE *));
3464 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3466 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3467 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3468 # elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3469 open_max = sysconf(_SC_OPEN_MAX);
3470 # elif defined(FOPEN_MAX)
3471 open_max = FOPEN_MAX;
3472 # elif defined(OPEN_MAX)
3473 open_max = OPEN_MAX;
3474 # elif defined(_NFILE)
3479 for (i = 0; i < open_max; i++)
3480 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3481 STDIO_STREAM_ARRAY[i]._file < open_max &&
3482 STDIO_STREAM_ARRAY[i]._flag)
3483 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3487 SETERRNO(EBADF,RMS_IFI);
3494 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3496 if (ckWARN(WARN_IO)) {
3498 = gv && (isGV_with_GP(gv))
3501 const char * const direction = have == '>' ? "out" : "in";
3503 if (name && HEK_LEN(name))
3504 Perl_warner(aTHX_ packWARN(WARN_IO),
3505 "Filehandle %" HEKf " opened only for %sput",
3506 HEKfARG(name), direction);
3508 Perl_warner(aTHX_ packWARN(WARN_IO),
3509 "Filehandle opened only for %sput", direction);
3514 Perl_report_evil_fh(pTHX_ const GV *gv)
3516 const IO *io = gv ? GvIO(gv) : NULL;
3517 const PERL_BITFIELD16 op = PL_op->op_type;
3521 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3523 warn_type = WARN_CLOSED;
3527 warn_type = WARN_UNOPENED;
3530 if (ckWARN(warn_type)) {
3532 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3533 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3534 const char * const pars =
3535 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3536 const char * const func =
3538 (op == OP_READLINE || op == OP_RCATLINE
3539 ? "readline" : /* "<HANDLE>" not nice */
3540 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3542 const char * const type =
3544 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3545 ? "socket" : "filehandle");
3546 const bool have_name = name && SvCUR(name);
3547 Perl_warner(aTHX_ packWARN(warn_type),
3548 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3549 have_name ? " " : "",
3550 SVfARG(have_name ? name : &PL_sv_no));
3551 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3553 aTHX_ packWARN(warn_type),
3554 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3555 func, pars, have_name ? " " : "",
3556 SVfARG(have_name ? name : &PL_sv_no)
3561 /* To workaround core dumps from the uninitialised tm_zone we get the
3562 * system to give us a reasonable struct to copy. This fix means that
3563 * strftime uses the tm_zone and tm_gmtoff values returned by
3564 * localtime(time()). That should give the desired result most of the
3565 * time. But probably not always!
3567 * This does not address tzname aspects of NETaa14816.
3572 # ifndef STRUCT_TM_HASZONE
3573 # define STRUCT_TM_HASZONE
3577 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3578 # ifndef HAS_TM_TM_ZONE
3579 # define HAS_TM_TM_ZONE
3584 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3586 #ifdef HAS_TM_TM_ZONE
3588 const struct tm* my_tm;
3589 PERL_UNUSED_CONTEXT;
3590 PERL_ARGS_ASSERT_INIT_TM;
3592 my_tm = localtime(&now);
3594 Copy(my_tm, ptm, 1, struct tm);
3596 PERL_UNUSED_CONTEXT;
3597 PERL_ARGS_ASSERT_INIT_TM;
3598 PERL_UNUSED_ARG(ptm);
3603 * mini_mktime - normalise struct tm values without the localtime()
3604 * semantics (and overhead) of mktime().
3607 Perl_mini_mktime(struct tm *ptm)
3611 int month, mday, year, jday;
3612 int odd_cent, odd_year;
3614 PERL_ARGS_ASSERT_MINI_MKTIME;
3616 #define DAYS_PER_YEAR 365
3617 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3618 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3619 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3620 #define SECS_PER_HOUR (60*60)
3621 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3622 /* parentheses deliberately absent on these two, otherwise they don't work */
3623 #define MONTH_TO_DAYS 153/5
3624 #define DAYS_TO_MONTH 5/153
3625 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3626 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3627 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3628 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3631 * Year/day algorithm notes:
3633 * With a suitable offset for numeric value of the month, one can find
3634 * an offset into the year by considering months to have 30.6 (153/5) days,
3635 * using integer arithmetic (i.e., with truncation). To avoid too much
3636 * messing about with leap days, we consider January and February to be
3637 * the 13th and 14th month of the previous year. After that transformation,
3638 * we need the month index we use to be high by 1 from 'normal human' usage,
3639 * so the month index values we use run from 4 through 15.
3641 * Given that, and the rules for the Gregorian calendar (leap years are those
3642 * divisible by 4 unless also divisible by 100, when they must be divisible
3643 * by 400 instead), we can simply calculate the number of days since some
3644 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3645 * the days we derive from our month index, and adding in the day of the
3646 * month. The value used here is not adjusted for the actual origin which
3647 * it normally would use (1 January A.D. 1), since we're not exposing it.
3648 * We're only building the value so we can turn around and get the
3649 * normalised values for the year, month, day-of-month, and day-of-year.
3651 * For going backward, we need to bias the value we're using so that we find
3652 * the right year value. (Basically, we don't want the contribution of
3653 * March 1st to the number to apply while deriving the year). Having done
3654 * that, we 'count up' the contribution to the year number by accounting for
3655 * full quadracenturies (400-year periods) with their extra leap days, plus
3656 * the contribution from full centuries (to avoid counting in the lost leap
3657 * days), plus the contribution from full quad-years (to count in the normal
3658 * leap days), plus the leftover contribution from any non-leap years.
3659 * At this point, if we were working with an actual leap day, we'll have 0
3660 * days left over. This is also true for March 1st, however. So, we have
3661 * to special-case that result, and (earlier) keep track of the 'odd'
3662 * century and year contributions. If we got 4 extra centuries in a qcent,
3663 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3664 * Otherwise, we add back in the earlier bias we removed (the 123 from
3665 * figuring in March 1st), find the month index (integer division by 30.6),
3666 * and the remainder is the day-of-month. We then have to convert back to
3667 * 'real' months (including fixing January and February from being 14/15 in
3668 * the previous year to being in the proper year). After that, to get
3669 * tm_yday, we work with the normalised year and get a new yearday value for
3670 * January 1st, which we subtract from the yearday value we had earlier,
3671 * representing the date we've re-built. This is done from January 1
3672 * because tm_yday is 0-origin.
3674 * Since POSIX time routines are only guaranteed to work for times since the
3675 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3676 * applies Gregorian calendar rules even to dates before the 16th century
3677 * doesn't bother me. Besides, you'd need cultural context for a given
3678 * date to know whether it was Julian or Gregorian calendar, and that's
3679 * outside the scope for this routine. Since we convert back based on the
3680 * same rules we used to build the yearday, you'll only get strange results
3681 * for input which needed normalising, or for the 'odd' century years which
3682 * were leap years in the Julian calendar but not in the Gregorian one.
3683 * I can live with that.
3685 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3686 * that's still outside the scope for POSIX time manipulation, so I don't
3692 year = 1900 + ptm->tm_year;
3693 month = ptm->tm_mon;
3694 mday = ptm->tm_mday;
3700 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3701 yearday += month*MONTH_TO_DAYS + mday + jday;
3703 * Note that we don't know when leap-seconds were or will be,
3704 * so we have to trust the user if we get something which looks
3705 * like a sensible leap-second. Wild values for seconds will
3706 * be rationalised, however.
3708 if ((unsigned) ptm->tm_sec <= 60) {
3715 secs += 60 * ptm->tm_min;
3716 secs += SECS_PER_HOUR * ptm->tm_hour;
3718 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3719 /* got negative remainder, but need positive time */
3720 /* back off an extra day to compensate */
3721 yearday += (secs/SECS_PER_DAY)-1;
3722 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3725 yearday += (secs/SECS_PER_DAY);
3726 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3729 else if (secs >= SECS_PER_DAY) {
3730 yearday += (secs/SECS_PER_DAY);
3731 secs %= SECS_PER_DAY;
3733 ptm->tm_hour = secs/SECS_PER_HOUR;
3734 secs %= SECS_PER_HOUR;
3735 ptm->tm_min = secs/60;
3737 ptm->tm_sec += secs;
3738 /* done with time of day effects */
3740 * The algorithm for yearday has (so far) left it high by 428.
3741 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3742 * bias it by 123 while trying to figure out what year it
3743 * really represents. Even with this tweak, the reverse
3744 * translation fails for years before A.D. 0001.
3745 * It would still fail for Feb 29, but we catch that one below.
3747 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3748 yearday -= YEAR_ADJUST;
3749 year = (yearday / DAYS_PER_QCENT) * 400;
3750 yearday %= DAYS_PER_QCENT;
3751 odd_cent = yearday / DAYS_PER_CENT;
3752 year += odd_cent * 100;
3753 yearday %= DAYS_PER_CENT;
3754 year += (yearday / DAYS_PER_QYEAR) * 4;
3755 yearday %= DAYS_PER_QYEAR;
3756 odd_year = yearday / DAYS_PER_YEAR;
3758 yearday %= DAYS_PER_YEAR;
3759 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3764 yearday += YEAR_ADJUST; /* recover March 1st crock */
3765 month = yearday*DAYS_TO_MONTH;
3766 yearday -= month*MONTH_TO_DAYS;
3767 /* recover other leap-year adjustment */
3776 ptm->tm_year = year - 1900;
3778 ptm->tm_mday = yearday;
3779 ptm->tm_mon = month;
3783 ptm->tm_mon = month - 1;
3785 /* re-build yearday based on Jan 1 to get tm_yday */
3787 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3788 yearday += 14*MONTH_TO_DAYS + 1;
3789 ptm->tm_yday = jday - yearday;
3790 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3794 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)
3798 /* strftime(), but with a different API so that the return value is a pointer
3799 * to the formatted result (which MUST be arranged to be FREED BY THE
3800 * CALLER). This allows this function to increase the buffer size as needed,
3801 * so that the caller doesn't have to worry about that.
3803 * Note that yday and wday effectively are ignored by this function, as
3804 * mini_mktime() overwrites them */
3811 PERL_ARGS_ASSERT_MY_STRFTIME;
3813 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3816 mytm.tm_hour = hour;
3817 mytm.tm_mday = mday;
3819 mytm.tm_year = year;
3820 mytm.tm_wday = wday;
3821 mytm.tm_yday = yday;
3822 mytm.tm_isdst = isdst;
3824 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3825 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3830 #ifdef HAS_TM_TM_GMTOFF
3831 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3833 #ifdef HAS_TM_TM_ZONE
3834 mytm.tm_zone = mytm2.tm_zone;
3839 Newx(buf, buflen, char);
3841 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3842 len = strftime(buf, buflen, fmt, &mytm);
3843 GCC_DIAG_RESTORE_STMT;
3846 ** The following is needed to handle to the situation where
3847 ** tmpbuf overflows. Basically we want to allocate a buffer
3848 ** and try repeatedly. The reason why it is so complicated
3849 ** is that getting a return value of 0 from strftime can indicate
3850 ** one of the following:
3851 ** 1. buffer overflowed,
3852 ** 2. illegal conversion specifier, or
3853 ** 3. the format string specifies nothing to be returned(not
3854 ** an error). This could be because format is an empty string
3855 ** or it specifies %p that yields an empty string in some locale.
3856 ** If there is a better way to make it portable, go ahead by
3859 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
3862 /* Possibly buf overflowed - try again with a bigger buf */
3863 const int fmtlen = strlen(fmt);
3864 int bufsize = fmtlen + buflen;
3866 Renew(buf, bufsize, char);
3869 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3870 buflen = strftime(buf, bufsize, fmt, &mytm);
3871 GCC_DIAG_RESTORE_STMT;
3873 if (buflen > 0 && buflen < bufsize)
3875 /* heuristic to prevent out-of-memory errors */
3876 if (bufsize > 100*fmtlen) {
3882 Renew(buf, bufsize, char);
3887 Perl_croak(aTHX_ "panic: no strftime");
3893 #define SV_CWD_RETURN_UNDEF \
3897 #define SV_CWD_ISDOT(dp) \
3898 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
3899 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
3902 =head1 Miscellaneous Functions
3904 =for apidoc getcwd_sv
3906 Fill C<sv> with current working directory
3911 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
3912 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
3913 * getcwd(3) if available
3914 * Comments from the original:
3915 * This is a faster version of getcwd. It's also more dangerous
3916 * because you might chdir out of a directory that you can't chdir
3920 Perl_getcwd_sv(pTHX_ SV *sv)
3925 PERL_ARGS_ASSERT_GETCWD_SV;
3929 char buf[MAXPATHLEN];
3931 /* Some getcwd()s automatically allocate a buffer of the given
3932 * size from the heap if they are given a NULL buffer pointer.
3933 * The problem is that this behaviour is not portable. */
3934 if (getcwd(buf, sizeof(buf) - 1)) {
3939 SV_CWD_RETURN_UNDEF;
3946 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
3950 SvUPGRADE(sv, SVt_PV);
3952 if (PerlLIO_lstat(".", &statbuf) < 0) {
3953 SV_CWD_RETURN_UNDEF;
3956 orig_cdev = statbuf.st_dev;
3957 orig_cino = statbuf.st_ino;
3967 if (PerlDir_chdir("..") < 0) {
3968 SV_CWD_RETURN_UNDEF;
3970 if (PerlLIO_stat(".", &statbuf) < 0) {
3971 SV_CWD_RETURN_UNDEF;
3974 cdev = statbuf.st_dev;
3975 cino = statbuf.st_ino;
3977 if (odev == cdev && oino == cino) {
3980 if (!(dir = PerlDir_open("."))) {
3981 SV_CWD_RETURN_UNDEF;
3984 while ((dp = PerlDir_read(dir)) != NULL) {
3986 namelen = dp->d_namlen;
3988 namelen = strlen(dp->d_name);
3991 if (SV_CWD_ISDOT(dp)) {
3995 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
3996 SV_CWD_RETURN_UNDEF;
3999 tdev = statbuf.st_dev;
4000 tino = statbuf.st_ino;
4001 if (tino == oino && tdev == odev) {
4007 SV_CWD_RETURN_UNDEF;
4010 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4011 SV_CWD_RETURN_UNDEF;
4014 SvGROW(sv, pathlen + namelen + 1);
4018 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4021 /* prepend current directory to the front */
4023 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4024 pathlen += (namelen + 1);
4026 #ifdef VOID_CLOSEDIR
4029 if (PerlDir_close(dir) < 0) {
4030 SV_CWD_RETURN_UNDEF;
4036 SvCUR_set(sv, pathlen);
4040 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4041 SV_CWD_RETURN_UNDEF;
4044 if (PerlLIO_stat(".", &statbuf) < 0) {
4045 SV_CWD_RETURN_UNDEF;
4048 cdev = statbuf.st_dev;
4049 cino = statbuf.st_ino;
4051 if (cdev != orig_cdev || cino != orig_cino) {
4052 Perl_croak(aTHX_ "Unstable directory path, "
4053 "current directory changed unexpectedly");
4066 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4067 # define EMULATE_SOCKETPAIR_UDP
4070 #ifdef EMULATE_SOCKETPAIR_UDP
4072 S_socketpair_udp (int fd[2]) {
4074 /* Fake a datagram socketpair using UDP to localhost. */
4075 int sockets[2] = {-1, -1};
4076 struct sockaddr_in addresses[2];
4078 Sock_size_t size = sizeof(struct sockaddr_in);
4079 unsigned short port;
4082 memset(&addresses, 0, sizeof(addresses));
4085 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4086 if (sockets[i] == -1)
4087 goto tidy_up_and_fail;
4089 addresses[i].sin_family = AF_INET;
4090 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4091 addresses[i].sin_port = 0; /* kernel choses port. */
4092 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4093 sizeof(struct sockaddr_in)) == -1)
4094 goto tidy_up_and_fail;
4097 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4098 for each connect the other socket to it. */
4101 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4103 goto tidy_up_and_fail;
4104 if (size != sizeof(struct sockaddr_in))
4105 goto abort_tidy_up_and_fail;
4106 /* !1 is 0, !0 is 1 */
4107 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4108 sizeof(struct sockaddr_in)) == -1)
4109 goto tidy_up_and_fail;
4112 /* Now we have 2 sockets connected to each other. I don't trust some other
4113 process not to have already sent a packet to us (by random) so send
4114 a packet from each to the other. */
4117 /* I'm going to send my own port number. As a short.
4118 (Who knows if someone somewhere has sin_port as a bitfield and needs
4119 this routine. (I'm assuming crays have socketpair)) */
4120 port = addresses[i].sin_port;
4121 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4122 if (got != sizeof(port)) {
4124 goto tidy_up_and_fail;
4125 goto abort_tidy_up_and_fail;
4129 /* Packets sent. I don't trust them to have arrived though.
4130 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4131 connect to localhost will use a second kernel thread. In 2.6 the
4132 first thread running the connect() returns before the second completes,
4133 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4134 returns 0. Poor programs have tripped up. One poor program's authors'
4135 had a 50-1 reverse stock split. Not sure how connected these were.)
4136 So I don't trust someone not to have an unpredictable UDP stack.
4140 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4141 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4145 FD_SET((unsigned int)sockets[0], &rset);
4146 FD_SET((unsigned int)sockets[1], &rset);
4148 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4149 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4150 || !FD_ISSET(sockets[1], &rset)) {
4151 /* I hope this is portable and appropriate. */
4153 goto tidy_up_and_fail;
4154 goto abort_tidy_up_and_fail;
4158 /* And the paranoia department even now doesn't trust it to have arrive
4159 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4161 struct sockaddr_in readfrom;
4162 unsigned short buffer[2];
4167 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4168 sizeof(buffer), MSG_DONTWAIT,
4169 (struct sockaddr *) &readfrom, &size);
4171 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4173 (struct sockaddr *) &readfrom, &size);
4177 goto tidy_up_and_fail;
4178 if (got != sizeof(port)
4179 || size != sizeof(struct sockaddr_in)
4180 /* Check other socket sent us its port. */
4181 || buffer[0] != (unsigned short) addresses[!i].sin_port
4182 /* Check kernel says we got the datagram from that socket */
4183 || readfrom.sin_family != addresses[!i].sin_family
4184 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4185 || readfrom.sin_port != addresses[!i].sin_port)
4186 goto abort_tidy_up_and_fail;
4189 /* My caller (my_socketpair) has validated that this is non-NULL */
4192 /* I hereby declare this connection open. May God bless all who cross
4196 abort_tidy_up_and_fail:
4197 errno = ECONNABORTED;
4201 if (sockets[0] != -1)
4202 PerlLIO_close(sockets[0]);
4203 if (sockets[1] != -1)
4204 PerlLIO_close(sockets[1]);
4209 #endif /* EMULATE_SOCKETPAIR_UDP */
4211 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4213 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4214 /* Stevens says that family must be AF_LOCAL, protocol 0.
4215 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4220 struct sockaddr_in listen_addr;
4221 struct sockaddr_in connect_addr;
4226 || family != AF_UNIX
4229 errno = EAFNOSUPPORT;
4238 type &= ~SOCK_CLOEXEC;
4241 #ifdef EMULATE_SOCKETPAIR_UDP
4242 if (type == SOCK_DGRAM)
4243 return S_socketpair_udp(fd);
4246 aTHXa(PERL_GET_THX);
4247 listener = PerlSock_socket(AF_INET, type, 0);
4250 memset(&listen_addr, 0, sizeof(listen_addr));
4251 listen_addr.sin_family = AF_INET;
4252 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4253 listen_addr.sin_port = 0; /* kernel choses port. */
4254 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4255 sizeof(listen_addr)) == -1)
4256 goto tidy_up_and_fail;
4257 if (PerlSock_listen(listener, 1) == -1)
4258 goto tidy_up_and_fail;
4260 connector = PerlSock_socket(AF_INET, type, 0);
4261 if (connector == -1)
4262 goto tidy_up_and_fail;
4263 /* We want to find out the port number to connect to. */
4264 size = sizeof(connect_addr);
4265 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4267 goto tidy_up_and_fail;
4268 if (size != sizeof(connect_addr))
4269 goto abort_tidy_up_and_fail;
4270 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4271 sizeof(connect_addr)) == -1)
4272 goto tidy_up_and_fail;
4274 size = sizeof(listen_addr);
4275 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4278 goto tidy_up_and_fail;
4279 if (size != sizeof(listen_addr))
4280 goto abort_tidy_up_and_fail;
4281 PerlLIO_close(listener);
4282 /* Now check we are talking to ourself by matching port and host on the
4284 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4286 goto tidy_up_and_fail;
4287 if (size != sizeof(connect_addr)
4288 || listen_addr.sin_family != connect_addr.sin_family
4289 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4290 || listen_addr.sin_port != connect_addr.sin_port) {
4291 goto abort_tidy_up_and_fail;
4297 abort_tidy_up_and_fail:
4299 errno = ECONNABORTED; /* This would be the standard thing to do. */
4300 #elif defined(ECONNREFUSED)
4301 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4303 errno = ETIMEDOUT; /* Desperation time. */
4309 PerlLIO_close(listener);
4310 if (connector != -1)
4311 PerlLIO_close(connector);
4313 PerlLIO_close(acceptor);
4319 /* In any case have a stub so that there's code corresponding
4320 * to the my_socketpair in embed.fnc. */
4322 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4323 #ifdef HAS_SOCKETPAIR
4324 return socketpair(family, type, protocol, fd);
4333 =for apidoc sv_nosharing
4335 Dummy routine which "shares" an SV when there is no sharing module present.
4336 Or "locks" it. Or "unlocks" it. In other
4337 words, ignores its single SV argument.
4338 Exists to avoid test for a C<NULL> function pointer and because it could
4339 potentially warn under some level of strict-ness.
4345 Perl_sv_nosharing(pTHX_ SV *sv)
4347 PERL_UNUSED_CONTEXT;
4348 PERL_UNUSED_ARG(sv);
4353 =for apidoc sv_destroyable
4355 Dummy routine which reports that object can be destroyed when there is no
4356 sharing module present. It ignores its single SV argument, and returns
4357 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4358 could potentially warn under some level of strict-ness.
4364 Perl_sv_destroyable(pTHX_ SV *sv)
4366 PERL_UNUSED_CONTEXT;
4367 PERL_UNUSED_ARG(sv);
4372 Perl_parse_unicode_opts(pTHX_ const char **popt)
4374 const char *p = *popt;
4377 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4381 const char* endptr = p + strlen(p);
4383 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4386 if (p && *p && *p != '\n' && *p != '\r') {
4388 goto the_end_of_the_opts_parser;
4390 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4394 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4400 case PERL_UNICODE_STDIN:
4401 opt |= PERL_UNICODE_STDIN_FLAG; break;
4402 case PERL_UNICODE_STDOUT:
4403 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4404 case PERL_UNICODE_STDERR:
4405 opt |= PERL_UNICODE_STDERR_FLAG; break;
4406 case PERL_UNICODE_STD:
4407 opt |= PERL_UNICODE_STD_FLAG; break;
4408 case PERL_UNICODE_IN:
4409 opt |= PERL_UNICODE_IN_FLAG; break;
4410 case PERL_UNICODE_OUT:
4411 opt |= PERL_UNICODE_OUT_FLAG; break;
4412 case PERL_UNICODE_INOUT:
4413 opt |= PERL_UNICODE_INOUT_FLAG; break;
4414 case PERL_UNICODE_LOCALE:
4415 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4416 case PERL_UNICODE_ARGV:
4417 opt |= PERL_UNICODE_ARGV_FLAG; break;
4418 case PERL_UNICODE_UTF8CACHEASSERT:
4419 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4421 if (*p != '\n' && *p != '\r') {
4422 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4425 "Unknown Unicode option letter '%c'", *p);
4432 opt = PERL_UNICODE_DEFAULT_FLAGS;
4434 the_end_of_the_opts_parser:
4436 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4437 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4438 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4446 # include <starlet.h>
4453 * This is really just a quick hack which grabs various garbage
4454 * values. It really should be a real hash algorithm which
4455 * spreads the effect of every input bit onto every output bit,
4456 * if someone who knows about such things would bother to write it.
4457 * Might be a good idea to add that function to CORE as well.
4458 * No numbers below come from careful analysis or anything here,
4459 * except they are primes and SEED_C1 > 1E6 to get a full-width
4460 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4461 * probably be bigger too.
4464 # define SEED_C1 1000003
4465 #define SEED_C4 73819
4467 # define SEED_C1 25747
4468 #define SEED_C4 20639
4472 #define SEED_C5 26107
4474 #ifndef PERL_NO_DEV_RANDOM
4478 #ifdef HAS_GETTIMEOFDAY
4479 struct timeval when;
4484 /* This test is an escape hatch, this symbol isn't set by Configure. */
4485 #ifndef PERL_NO_DEV_RANDOM
4486 #ifndef PERL_RANDOM_DEVICE
4487 /* /dev/random isn't used by default because reads from it will block
4488 * if there isn't enough entropy available. You can compile with
4489 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4490 * is enough real entropy to fill the seed. */
4491 # ifdef __amigaos4__
4492 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4494 # define PERL_RANDOM_DEVICE "/dev/urandom"
4497 fd = PerlLIO_open_cloexec(PERL_RANDOM_DEVICE, 0);
4499 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4507 #ifdef HAS_GETTIMEOFDAY
4508 PerlProc_gettimeofday(&when,NULL);
4509 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4512 u = (U32)SEED_C1 * when;
4514 u += SEED_C3 * (U32)PerlProc_getpid();
4515 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4516 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4517 u += SEED_C5 * (U32)PTR2UV(&when);
4523 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4525 #ifndef NO_PERL_HASH_ENV
4530 PERL_ARGS_ASSERT_GET_HASH_SEED;
4532 #ifndef NO_PERL_HASH_ENV
4533 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4537 /* ignore leading spaces */
4538 while (isSPACE(*env_pv))
4540 # ifdef USE_PERL_PERTURB_KEYS
4541 /* if they set it to "0" we disable key traversal randomization completely */
4542 if (strEQ(env_pv,"0")) {
4543 PL_hash_rand_bits_enabled= 0;
4545 /* otherwise switch to deterministic mode */
4546 PL_hash_rand_bits_enabled= 2;
4549 /* ignore a leading 0x... if it is there */
4550 if (env_pv[0] == '0' && env_pv[1] == 'x')
4553 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4554 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4555 if ( isXDIGIT(*env_pv)) {
4556 seed_buffer[i] |= READ_XDIGIT(env_pv);
4559 while (isSPACE(*env_pv))
4562 if (*env_pv && !isXDIGIT(*env_pv)) {
4563 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4565 /* should we check for unparsed crap? */
4566 /* should we warn about unused hex? */
4567 /* should we warn about insufficient hex? */
4570 #endif /* NO_PERL_HASH_ENV */
4572 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4573 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
4576 #ifdef USE_PERL_PERTURB_KEYS
4577 { /* initialize PL_hash_rand_bits from the hash seed.
4578 * This value is highly volatile, it is updated every
4579 * hash insert, and is used as part of hash bucket chain
4580 * randomization and hash iterator randomization. */
4581 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4582 for( i = 0; i < sizeof(UV) ; i++ ) {
4583 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4584 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4587 # ifndef NO_PERL_HASH_ENV
4588 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4590 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4591 PL_hash_rand_bits_enabled= 0;
4592 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4593 PL_hash_rand_bits_enabled= 1;
4594 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4595 PL_hash_rand_bits_enabled= 2;
4597 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4604 #ifdef PERL_GLOBAL_STRUCT
4606 #define PERL_GLOBAL_STRUCT_INIT
4607 #include "opcode.h" /* the ppaddr and check */
4610 Perl_init_global_struct(pTHX)
4612 struct perl_vars *plvarsp = NULL;
4613 # ifdef PERL_GLOBAL_STRUCT
4614 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4615 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4616 PERL_UNUSED_CONTEXT;
4617 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4618 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4619 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4623 plvarsp = PL_VarsPtr;
4624 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4629 # define PERLVAR(prefix,var,type) /**/
4630 # define PERLVARA(prefix,var,n,type) /**/
4631 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4632 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4633 # include "perlvars.h"
4638 # ifdef PERL_GLOBAL_STRUCT
4641 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4642 if (!plvarsp->Gppaddr)
4646 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4647 if (!plvarsp->Gcheck)
4649 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4650 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4652 # ifdef PERL_SET_VARS
4653 PERL_SET_VARS(plvarsp);
4655 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4656 plvarsp->Gsv_placeholder.sv_flags = 0;
4657 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4659 # undef PERL_GLOBAL_STRUCT_INIT
4664 #endif /* PERL_GLOBAL_STRUCT */
4666 #ifdef PERL_GLOBAL_STRUCT
4669 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4671 int veto = plvarsp->Gveto_cleanup;
4673 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4674 PERL_UNUSED_CONTEXT;
4675 # ifdef PERL_GLOBAL_STRUCT
4676 # ifdef PERL_UNSET_VARS
4677 PERL_UNSET_VARS(plvarsp);
4681 free(plvarsp->Gppaddr);
4682 free(plvarsp->Gcheck);
4683 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4689 #endif /* PERL_GLOBAL_STRUCT */
4693 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4694 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4695 * given, and you supply your own implementation.
4697 * The default implementation reads a single env var, PERL_MEM_LOG,
4698 * expecting one or more of the following:
4700 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4701 * 'm' - memlog was PERL_MEM_LOG=1
4702 * 's' - svlog was PERL_SV_LOG=1
4703 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4705 * This makes the logger controllable enough that it can reasonably be
4706 * added to the system perl.
4709 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4710 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4712 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4714 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4715 * writes to. In the default logger, this is settable at runtime.
4717 #ifndef PERL_MEM_LOG_FD
4718 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4721 #ifndef PERL_MEM_LOG_NOIMPL
4723 # ifdef DEBUG_LEAKING_SCALARS
4724 # define SV_LOG_SERIAL_FMT " [%lu]"
4725 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4727 # define SV_LOG_SERIAL_FMT
4728 # define _SV_LOG_SERIAL_ARG(sv)
4732 S_mem_log_common(enum mem_log_type mlt, const UV n,
4733 const UV typesize, const char *type_name, const SV *sv,
4734 Malloc_t oldalloc, Malloc_t newalloc,
4735 const char *filename, const int linenumber,
4736 const char *funcname)
4740 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4742 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4745 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4747 /* We can't use SVs or PerlIO for obvious reasons,
4748 * so we'll use stdio and low-level IO instead. */
4749 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4751 # ifdef HAS_GETTIMEOFDAY
4752 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4753 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4755 gettimeofday(&tv, 0);
4757 # define MEM_LOG_TIME_FMT "%10d: "
4758 # define MEM_LOG_TIME_ARG (int)when
4762 /* If there are other OS specific ways of hires time than
4763 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4764 * probably that they would be used to fill in the struct
4768 const char* endptr = pmlenv + strlen(pmlenv);
4771 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4772 && uv && uv <= PERL_INT_MAX
4776 fd = PERL_MEM_LOG_FD;
4779 if (strchr(pmlenv, 't')) {
4780 len = my_snprintf(buf, sizeof(buf),
4781 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4782 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4786 len = my_snprintf(buf, sizeof(buf),
4787 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4788 " %s = %" IVdf ": %" UVxf "\n",
4789 filename, linenumber, funcname, n, typesize,
4790 type_name, n * typesize, PTR2UV(newalloc));
4793 len = my_snprintf(buf, sizeof(buf),
4794 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4795 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4796 filename, linenumber, funcname, n, typesize,
4797 type_name, n * typesize, PTR2UV(oldalloc),
4801 len = my_snprintf(buf, sizeof(buf),
4802 "free: %s:%d:%s: %" UVxf "\n",
4803 filename, linenumber, funcname,
4808 len = my_snprintf(buf, sizeof(buf),
4809 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
4810 mlt == MLT_NEW_SV ? "new" : "del",
4811 filename, linenumber, funcname,
4812 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4817 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4821 #endif /* !PERL_MEM_LOG_NOIMPL */
4823 #ifndef PERL_MEM_LOG_NOIMPL
4825 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4826 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4828 /* this is suboptimal, but bug compatible. User is providing their
4829 own implementation, but is getting these functions anyway, and they
4830 do nothing. But _NOIMPL users should be able to cope or fix */
4832 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4833 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
4837 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4839 const char *filename, const int linenumber,
4840 const char *funcname)
4842 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
4844 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4845 NULL, NULL, newalloc,
4846 filename, linenumber, funcname);
4851 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4852 Malloc_t oldalloc, Malloc_t newalloc,
4853 const char *filename, const int linenumber,
4854 const char *funcname)
4856 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
4858 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4859 NULL, oldalloc, newalloc,
4860 filename, linenumber, funcname);
4865 Perl_mem_log_free(Malloc_t oldalloc,
4866 const char *filename, const int linenumber,
4867 const char *funcname)
4869 PERL_ARGS_ASSERT_MEM_LOG_FREE;
4871 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4872 filename, linenumber, funcname);
4877 Perl_mem_log_new_sv(const SV *sv,
4878 const char *filename, const int linenumber,
4879 const char *funcname)
4881 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4882 filename, linenumber, funcname);
4886 Perl_mem_log_del_sv(const SV *sv,
4887 const char *filename, const int linenumber,
4888 const char *funcname)
4890 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4891 filename, linenumber, funcname);
4894 #endif /* PERL_MEM_LOG */
4897 =for apidoc quadmath_format_single
4899 C<quadmath_snprintf()> is very strict about its C<format> string and will
4900 fail, returning -1, if the format is invalid. It accepts exactly
4903 C<quadmath_format_single()> checks that the intended single spec looks
4904 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
4905 and has C<Q> before it. This is not a full "printf syntax check",
4908 Returns the format if it is valid, NULL if not.
4910 C<quadmath_format_single()> can and will actually patch in the missing
4911 C<Q>, if necessary. In this case it will return the modified copy of
4912 the format, B<which the caller will need to free.>
4914 See also L</quadmath_format_needed>.
4920 Perl_quadmath_format_single(const char* format)
4924 PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
4926 if (format[0] != '%' || strchr(format + 1, '%'))
4928 len = strlen(format);
4929 /* minimum length three: %Qg */
4930 if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
4932 if (format[len - 2] != 'Q') {
4934 Newx(fixed, len + 1, char);
4935 memcpy(fixed, format, len - 1);
4936 fixed[len - 1] = 'Q';
4937 fixed[len ] = format[len - 1];
4939 return (const char*)fixed;
4946 =for apidoc quadmath_format_needed
4948 C<quadmath_format_needed()> returns true if the C<format> string seems to
4949 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
4950 or returns false otherwise.
4952 The format specifier detection is not complete printf-syntax detection,
4953 but it should catch most common cases.
4955 If true is returned, those arguments B<should> in theory be processed
4956 with C<quadmath_snprintf()>, but in case there is more than one such
4957 format specifier (see L</quadmath_format_single>), and if there is
4958 anything else beyond that one (even just a single byte), they
4959 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
4960 accepting only one format spec, and nothing else.
4961 In this case, the code should probably fail.
4967 Perl_quadmath_format_needed(const char* format)
4969 const char *p = format;
4972 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
4974 while ((q = strchr(p, '%'))) {
4976 if (*q == '+') /* plus */
4978 if (*q == '#') /* alt */
4980 if (*q == '*') /* width */
4984 while (isDIGIT(*q)) q++;
4987 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
4992 while (isDIGIT(*q)) q++;
4994 if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5003 =for apidoc my_snprintf
5005 The C library C<snprintf> functionality, if available and
5006 standards-compliant (uses C<vsnprintf>, actually). However, if the
5007 C<vsnprintf> is not available, will unfortunately use the unsafe
5008 C<vsprintf> which can overrun the buffer (there is an overrun check,
5009 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5010 getting C<vsnprintf>.
5015 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5019 PERL_ARGS_ASSERT_MY_SNPRINTF;
5020 #ifndef HAS_VSNPRINTF
5021 PERL_UNUSED_VAR(len);
5023 va_start(ap, format);
5026 const char* qfmt = quadmath_format_single(format);
5027 bool quadmath_valid = FALSE;
5029 /* If the format looked promising, use it as quadmath. */
5030 retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
5032 if (qfmt != format) {
5036 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
5038 quadmath_valid = TRUE;
5043 assert(qfmt == NULL);
5044 /* quadmath_format_single() will return false for example for
5045 * "foo = %g", or simply "%g". We could handle the %g by
5046 * using quadmath for the NV args. More complex cases of
5047 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5048 * quadmath-valid but has stuff in front).
5050 * Handling the "Q-less" cases right would require walking
5051 * through the va_list and rewriting the format, calling
5052 * quadmath for the NVs, building a new va_list, and then
5053 * letting vsnprintf/vsprintf to take care of the other
5054 * arguments. This may be doable.
5056 * We do not attempt that now. But for paranoia, we here try
5057 * to detect some common (but not all) cases where the
5058 * "Q-less" %[efgaEFGA] formats are present, and die if
5059 * detected. This doesn't fix the problem, but it stops the
5060 * vsnprintf/vsprintf pulling doubles off the va_list when
5061 * __float128 NVs should be pulled off instead.
5063 * If quadmath_format_needed() returns false, we are reasonably
5064 * certain that we can call vnsprintf() or vsprintf() safely. */
5065 if (!quadmath_valid && quadmath_format_needed(format))
5066 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5071 #ifdef HAS_VSNPRINTF
5072 retval = vsnprintf(buffer, len, format, ap);
5074 retval = vsprintf(buffer, format, ap);
5077 /* vsprintf() shows failure with < 0 */
5079 #ifdef HAS_VSNPRINTF
5080 /* vsnprintf() shows failure with >= len */
5082 (len > 0 && (Size_t)retval >= len)
5085 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5090 =for apidoc my_vsnprintf
5092 The C library C<vsnprintf> if available and standards-compliant.
5093 However, if if the C<vsnprintf> is not available, will unfortunately
5094 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5095 overrun check, but that may be too late). Consider using
5096 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5101 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5104 PERL_UNUSED_ARG(buffer);
5105 PERL_UNUSED_ARG(len);
5106 PERL_UNUSED_ARG(format);
5107 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5108 PERL_UNUSED_ARG((void*)ap);
5109 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5116 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5117 Perl_va_copy(ap, apc);
5118 # ifdef HAS_VSNPRINTF
5119 retval = vsnprintf(buffer, len, format, apc);
5121 PERL_UNUSED_ARG(len);
5122 retval = vsprintf(buffer, format, apc);
5126 # ifdef HAS_VSNPRINTF
5127 retval = vsnprintf(buffer, len, format, ap);
5129 PERL_UNUSED_ARG(len);
5130 retval = vsprintf(buffer, format, ap);
5132 #endif /* #ifdef NEED_VA_COPY */
5133 /* vsprintf() shows failure with < 0 */
5135 #ifdef HAS_VSNPRINTF
5136 /* vsnprintf() shows failure with >= len */
5138 (len > 0 && (Size_t)retval >= len)
5141 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5147 Perl_my_clearenv(pTHX)
5150 #if ! defined(PERL_MICRO)
5151 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5153 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5154 # if defined(USE_ENVIRON_ARRAY)
5155 # if defined(USE_ITHREADS)
5156 /* only the parent thread can clobber the process environment */
5157 if (PL_curinterp == aTHX)
5158 # endif /* USE_ITHREADS */
5160 # if ! defined(PERL_USE_SAFE_PUTENV)
5161 if ( !PL_use_safe_putenv) {
5163 if (environ == PL_origenviron)
5164 environ = (char**)safesysmalloc(sizeof(char*));
5166 for (i = 0; environ[i]; i++)
5167 (void)safesysfree(environ[i]);
5170 # else /* PERL_USE_SAFE_PUTENV */
5171 # if defined(HAS_CLEARENV)
5173 # elif defined(HAS_UNSETENV)
5174 int bsiz = 80; /* Most envvar names will be shorter than this. */
5175 char *buf = (char*)safesysmalloc(bsiz);
5176 while (*environ != NULL) {
5177 char *e = strchr(*environ, '=');
5178 int l = e ? e - *environ : (int)strlen(*environ);
5180 (void)safesysfree(buf);
5181 bsiz = l + 1; /* + 1 for the \0. */
5182 buf = (char*)safesysmalloc(bsiz);
5184 memcpy(buf, *environ, l);
5186 (void)unsetenv(buf);
5188 (void)safesysfree(buf);
5189 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5190 /* Just null environ and accept the leakage. */
5192 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5193 # endif /* ! PERL_USE_SAFE_PUTENV */
5195 # endif /* USE_ENVIRON_ARRAY */
5196 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5197 #endif /* PERL_MICRO */
5200 #ifdef PERL_IMPLICIT_CONTEXT
5203 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5205 /* rather than each module having a static var holding its index,
5206 * use a global array of name to index mappings
5209 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5214 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5216 for (index = 0; index < PL_my_cxt_index; index++) {
5217 const char *key = PL_my_cxt_keys[index];
5218 /* try direct pointer compare first - there are chances to success,
5219 * and it's much faster.
5221 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5229 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5230 the global PL_my_cxt_index is incremented, and that value is assigned to
5231 that module's static my_cxt_index (who's address is passed as an arg).
5232 Then, for each interpreter this function is called for, it makes sure a
5233 void* slot is available to hang the static data off, by allocating or
5234 extending the interpreter's PL_my_cxt_list array */
5237 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5238 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5240 Perl_my_cxt_init(pTHX_ int *indexp, size_t size)
5247 PERL_ARGS_ASSERT_MY_CXT_INIT;
5249 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5250 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5254 /* do initial check without locking.
5255 * -1: not allocated or another thread currently allocating
5256 * other: already allocated by another thread
5259 MUTEX_LOCK(&PL_my_ctx_mutex);
5260 /*now a stricter check with locking */
5261 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5262 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5267 /* this module hasn't been allocated an index yet */
5268 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5269 index = PL_my_cxt_index++;
5271 /* Store the index in a global MY_CXT_KEY string to index mapping
5272 * table. This emulates the perl-module static my_cxt_index var on
5273 * builds which don't allow static vars */
5274 if (PL_my_cxt_keys_size <= index) {
5275 int old_size = PL_my_cxt_keys_size;
5277 if (PL_my_cxt_keys_size) {
5278 IV new_size = PL_my_cxt_keys_size;
5279 while (new_size <= index)
5281 PL_my_cxt_keys = (const char **)PerlMemShared_realloc(
5283 new_size * sizeof(const char *));
5284 PL_my_cxt_keys_size = new_size;
5287 PL_my_cxt_keys_size = 16;
5288 PL_my_cxt_keys = (const char **)PerlMemShared_malloc(
5289 PL_my_cxt_keys_size * sizeof(const char *));
5291 for (i = old_size; i < PL_my_cxt_keys_size; i++) {
5292 PL_my_cxt_keys[i] = 0;
5295 PL_my_cxt_keys[index] = my_cxt_key;
5297 *indexp = PL_my_cxt_index++;
5300 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5303 /* make sure the array is big enough */
5304 if (PL_my_cxt_size <= index) {
5305 if (PL_my_cxt_size) {
5306 IV new_size = PL_my_cxt_size;
5307 while (new_size <= index)
5309 Renew(PL_my_cxt_list, new_size, void *);
5310 PL_my_cxt_size = new_size;
5313 PL_my_cxt_size = 16;
5314 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5317 /* newSV() allocates one more than needed */
5318 p = (void*)SvPVX(newSV(size-1));
5319 PL_my_cxt_list[index] = p;
5320 Zero(p, size, char);
5324 #endif /* PERL_IMPLICIT_CONTEXT */
5327 /* Perl_xs_handshake():
5328 implement the various XS_*_BOOTCHECK macros, which are added to .c
5329 files by ExtUtils::ParseXS, to check that the perl the module was built
5330 with is binary compatible with the running perl.
5333 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5334 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5336 The meaning of the varargs is determined the U32 key arg (which is not
5337 a format string). The fields of key are assembled by using HS_KEY().
5339 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5340 "PerlInterpreter *" and represents the callers context; otherwise it is
5341 of type "CV *", and is the boot xsub's CV.
5343 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5344 for example, and IO.dll was linked with threaded perl524.dll, and both
5345 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5346 successfully can load IO.dll into the process but simultaneously it
5347 loaded an interpreter of a different version into the process, and XS
5348 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5349 use through perl526.dll's my_perl->Istack_base.
5351 v_my_perl cannot be the first arg, since then 'key' will be out of
5352 place in a threaded vs non-threaded mixup; and analyzing the key
5353 number's bitfields won't reveal the problem, since it will be a valid
5354 key (unthreaded perl) on interp side, but croak will report the XS mod's
5355 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5356 it's a threaded perl and an unthreaded XS module, threaded perl will
5357 look at an uninit C stack or an uninit register to get 'key'
5358 (remember that it assumes that the 1st arg is the interp cxt).
5360 'file' is the source filename of the caller.
5364 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5370 #ifdef PERL_IMPLICIT_CONTEXT
5377 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5378 va_start(args, file);
5380 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5381 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5382 if (UNLIKELY(got != need))
5384 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5385 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5386 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5387 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5388 passed to the XS DLL */
5389 #ifdef PERL_IMPLICIT_CONTEXT
5390 xs_interp = (tTHX)v_my_perl;
5394 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5395 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5396 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5397 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5398 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5399 location in the unthreaded perl binary) stored in CV * to figure out if this
5400 Perl_xs_handshake was called by the same pp_entersub */
5401 cv = (CV*)v_my_perl;
5402 xs_spp = (SV***)CvHSCXT(cv);
5404 need = &PL_stack_sp;
5406 if(UNLIKELY(got != need)) {
5407 bad_handshake:/* recycle branch and string from above */
5408 if(got != (void *)HSf_NOCHK)
5409 noperl_die("%s: loadable library and perl binaries are mismatched"
5410 " (got handshake key %p, needed %p)\n",
5414 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5415 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5416 PL_xsubfilename = file; /* so the old name must be restored for
5417 additional XSUBs to register themselves */
5418 /* XSUBs can't be perl lang/perl5db.pl debugged
5419 if (PERLDB_LINE_OR_SAVESRC)
5420 (void)gv_fetchfile(file); */
5423 if(key & HSf_POPMARK) {
5425 { SV **mark = PL_stack_base + ax++;
5427 items = (I32)(SP - MARK);
5431 items = va_arg(args, U32);
5432 ax = va_arg(args, U32);
5436 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5437 if((apiverlen = HS_GETAPIVERLEN(key))) {
5438 char * api_p = va_arg(args, char*);
5439 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5440 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5441 sizeof("v" PERL_API_VERSION_STRING)-1))
5442 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5443 api_p, SVfARG(PL_stack_base[ax + 0]),
5444 "v" PERL_API_VERSION_STRING);
5449 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5450 if((xsverlen = HS_GETXSVERLEN(key)))
5451 S_xs_version_bootcheck(aTHX_
5452 items, ax, va_arg(args, char*), xsverlen);
5460 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5464 const char *vn = NULL;
5465 SV *const module = PL_stack_base[ax];
5467 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5469 if (items >= 2) /* version supplied as bootstrap arg */
5470 sv = PL_stack_base[ax + 1];
5472 /* XXX GV_ADDWARN */
5474 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5475 if (!sv || !SvOK(sv)) {
5477 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5481 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5482 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5483 ? sv : sv_2mortal(new_version(sv));
5484 xssv = upg_version(xssv, 0);
5485 if ( vcmp(pmsv,xssv) ) {
5486 SV *string = vstringify(xssv);
5487 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5488 " does not match ", SVfARG(module), SVfARG(string));
5490 SvREFCNT_dec(string);
5491 string = vstringify(pmsv);
5494 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5497 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5499 SvREFCNT_dec(string);
5501 Perl_sv_2mortal(aTHX_ xpt);
5502 Perl_croak_sv(aTHX_ xpt);
5508 =for apidoc my_strlcat
5510 The C library C<strlcat> if available, or a Perl implementation of it.
5511 This operates on C C<NUL>-terminated strings.
5513 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5514 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5515 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5516 practice this should not happen as it means that either C<size> is incorrect or
5517 that C<dst> is not a proper C<NUL>-terminated string).
5519 Note that C<size> is the full size of the destination buffer and
5520 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5521 room for the C<NUL> should be included in C<size>.
5523 The return value is the total length that C<dst> would have if C<size> is
5524 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5525 C<src>. If C<size> is smaller than the return, the excess was not appended.
5529 Description stolen from http://man.openbsd.org/strlcat.3
5533 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5535 Size_t used, length, copy;
5538 length = strlen(src);
5539 if (size > 0 && used < size - 1) {
5540 copy = (length >= size - used) ? size - used - 1 : length;
5541 memcpy(dst + used, src, copy);
5542 dst[used + copy] = '\0';
5544 return used + length;
5550 =for apidoc my_strlcpy
5552 The C library C<strlcpy> if available, or a Perl implementation of it.
5553 This operates on C C<NUL>-terminated strings.
5555 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5556 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5558 The return value is the total length C<src> would be if the copy completely
5559 succeeded. If it is larger than C<size>, the excess was not copied.
5563 Description stolen from http://man.openbsd.org/strlcpy.3
5567 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5569 Size_t length, copy;
5571 length = strlen(src);
5573 copy = (length >= size) ? size - 1 : length;
5574 memcpy(dst, src, copy);
5582 =for apidoc my_strnlen
5584 The C library C<strnlen> if available, or a Perl implementation of it.
5586 C<my_strnlen()> computes the length of the string, up to C<maxlen>
5587 characters. It will will never attempt to address more than C<maxlen>
5588 characters, making it suitable for use with strings that are not
5589 guaranteed to be NUL-terminated.
5593 Description stolen from http://man.openbsd.org/strnlen.3,
5594 implementation stolen from PostgreSQL.
5598 Perl_my_strnlen(const char *str, Size_t maxlen)
5600 const char *p = str;
5602 PERL_ARGS_ASSERT_MY_STRNLEN;
5604 while(maxlen-- && *p)
5611 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5612 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5613 long _ftol( double ); /* Defined by VC6 C libs. */
5614 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5617 PERL_STATIC_INLINE bool
5618 S_gv_has_usable_name(pTHX_ GV *gv)
5622 && HvENAME(GvSTASH(gv))
5623 && (gvp = (GV **)hv_fetchhek(
5624 GvSTASH(gv), GvNAME_HEK(gv), 0
5630 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5632 SV * const dbsv = GvSVn(PL_DBsub);
5633 const bool save_taint = TAINT_get;
5635 /* When we are called from pp_goto (svp is null),
5636 * we do not care about using dbsv to call CV;
5637 * it's for informational purposes only.
5640 PERL_ARGS_ASSERT_GET_DB_SUB;
5644 if (!PERLDB_SUB_NN) {
5647 if (!svp && !CvLEXICAL(cv)) {
5648 gv_efullname3(dbsv, gv, NULL);
5650 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5651 || strEQ(GvNAME(gv), "END")
5652 || ( /* Could be imported, and old sub redefined. */
5653 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5655 !( (SvTYPE(*svp) == SVt_PVGV)
5656 && (GvCV((const GV *)*svp) == cv)
5657 /* Use GV from the stack as a fallback. */
5658 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5662 /* GV is potentially non-unique, or contain different CV. */
5663 SV * const tmp = newRV(MUTABLE_SV(cv));
5664 sv_setsv(dbsv, tmp);
5668 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5669 sv_catpvs(dbsv, "::");
5670 sv_cathek(dbsv, GvNAME_HEK(gv));
5674 const int type = SvTYPE(dbsv);
5675 if (type < SVt_PVIV && type != SVt_IV)
5676 sv_upgrade(dbsv, SVt_PVIV);
5677 (void)SvIOK_on(dbsv);
5678 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5681 TAINT_IF(save_taint);
5682 #ifdef NO_TAINT_SUPPORT
5683 PERL_UNUSED_VAR(save_taint);
5688 Perl_my_dirfd(DIR * dir) {
5690 /* Most dirfd implementations have problems when passed NULL. */
5695 #elif defined(HAS_DIR_DD_FD)
5698 Perl_croak_nocontext(PL_no_func, "dirfd");
5699 NOT_REACHED; /* NOTREACHED */
5704 #if !defined(HAS_MKOSTEMP) || !defined(HAS_MKSTEMP)
5706 #define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
5707 #define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
5710 S_my_mkostemp(char *templte, int flags) {
5712 STRLEN len = strlen(templte);
5716 int delete_on_close = flags & O_VMS_DELETEONCLOSE;
5718 flags &= ~O_VMS_DELETEONCLOSE;
5722 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
5723 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
5724 SETERRNO(EINVAL, LIB_INVARG);
5730 for (i = 1; i <= 6; ++i) {
5731 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
5734 if (delete_on_close) {
5735 fd = open(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600, "fop=dlt");
5740 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600);
5742 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
5749 #ifndef HAS_MKOSTEMP
5751 Perl_my_mkostemp(char *templte, int flags)
5753 PERL_ARGS_ASSERT_MY_MKOSTEMP;
5754 return S_my_mkostemp(templte, flags);
5760 Perl_my_mkstemp(char *templte)
5762 PERL_ARGS_ASSERT_MY_MKSTEMP;
5763 return S_my_mkostemp(templte, 0);
5768 Perl_get_re_arg(pTHX_ SV *sv) {
5774 sv = MUTABLE_SV(SvRV(sv));
5775 if (SvTYPE(sv) == SVt_REGEXP)
5776 return (REGEXP*) sv;
5783 * This code is derived from drand48() implementation from FreeBSD,
5784 * found in lib/libc/gen/_rand48.c.
5786 * The U64 implementation is original, based on the POSIX
5787 * specification for drand48().
5791 * Copyright (c) 1993 Martin Birgmeier
5792 * All rights reserved.
5794 * You may redistribute unmodified or modified versions of this source
5795 * code provided that the above copyright notice and this and the
5796 * following conditions are retained.
5798 * This software is provided ``as is'', and comes with no warranties
5799 * of any kind. I shall in no event be liable for anything that happens
5800 * to anyone/anything when using this software.
5803 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5805 #ifdef PERL_DRAND48_QUAD
5807 #define DRAND48_MULT UINT64_C(0x5deece66d)
5808 #define DRAND48_ADD 0xb
5809 #define DRAND48_MASK UINT64_C(0xffffffffffff)
5813 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5814 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5815 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5816 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5817 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5818 #define FREEBSD_DRAND48_ADD (0x000b)
5820 const unsigned short _rand48_mult[3] = {
5821 FREEBSD_DRAND48_MULT_0,
5822 FREEBSD_DRAND48_MULT_1,
5823 FREEBSD_DRAND48_MULT_2
5825 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5830 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5832 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5834 #ifdef PERL_DRAND48_QUAD
5835 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5837 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5838 random_state->seed[1] = (U16) seed;
5839 random_state->seed[2] = (U16) (seed >> 16);
5844 Perl_drand48_r(perl_drand48_t *random_state)
5846 PERL_ARGS_ASSERT_DRAND48_R;
5848 #ifdef PERL_DRAND48_QUAD
5849 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5852 return ldexp((double)*random_state, -48);
5858 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5859 + (U32) _rand48_add;
5860 temp[0] = (U16) accu; /* lower 16 bits */
5861 accu >>= sizeof(U16) * 8;
5862 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5863 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5864 temp[1] = (U16) accu; /* middle 16 bits */
5865 accu >>= sizeof(U16) * 8;
5866 accu += _rand48_mult[0] * random_state->seed[2]
5867 + _rand48_mult[1] * random_state->seed[1]
5868 + _rand48_mult[2] * random_state->seed[0];
5869 random_state->seed[0] = temp[0];
5870 random_state->seed[1] = temp[1];
5871 random_state->seed[2] = (U16) accu;
5873 return ldexp((double) random_state->seed[0], -48) +
5874 ldexp((double) random_state->seed[1], -32) +
5875 ldexp((double) random_state->seed[2], -16);
5880 #ifdef USE_C_BACKTRACE
5882 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5887 /* abfd is the BFD handle. */
5889 /* bfd_syms is the BFD symbol table. */
5891 /* bfd_text is handle to the the ".text" section of the object file. */
5893 /* Since opening the executable and scanning its symbols is quite
5894 * heavy operation, we remember the filename we used the last time,
5895 * and do the opening and scanning only if the filename changes.
5896 * This removes most (but not all) open+scan cycles. */
5897 const char* fname_prev;
5900 /* Given a dl_info, update the BFD context if necessary. */
5901 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5903 /* BFD open and scan only if the filename changed. */
5904 if (ctx->fname_prev == NULL ||
5905 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5907 bfd_close(ctx->abfd);
5909 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5911 if (bfd_check_format(ctx->abfd, bfd_object)) {
5912 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5913 if (symbol_size > 0) {
5914 Safefree(ctx->bfd_syms);
5915 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5917 bfd_get_section_by_name(ctx->abfd, ".text");
5925 ctx->fname_prev = dl_info->dli_fname;
5929 /* Given a raw frame, try to symbolize it and store
5930 * symbol information (source file, line number) away. */
5931 static void bfd_symbolize(bfd_context* ctx,
5934 STRLEN* symbol_name_size,
5936 STRLEN* source_name_size,
5937 STRLEN* source_line)
5939 *symbol_name = NULL;
5940 *symbol_name_size = 0;
5942 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5944 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5947 unsigned int line = 0;
5948 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5949 ctx->bfd_syms, offset,
5950 &file, &func, &line) &&
5951 file && func && line > 0) {
5952 /* Size and copy the source file, use only
5953 * the basename of the source file.
5955 * NOTE: the basenames are fine for the
5956 * Perl source files, but may not always
5957 * be the best idea for XS files. */
5958 const char *p, *b = NULL;
5959 /* Look for the last slash. */
5960 for (p = file; *p; p++) {
5964 if (b == NULL || *b == 0) {
5967 *source_name_size = p - b + 1;
5968 Newx(*source_name, *source_name_size + 1, char);
5969 Copy(b, *source_name, *source_name_size + 1, char);
5971 *symbol_name_size = strlen(func);
5972 Newx(*symbol_name, *symbol_name_size + 1, char);
5973 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5975 *source_line = line;
5981 #endif /* #ifdef USE_BFD */
5985 /* OS X has no public API for for 'symbolicating' (Apple official term)
5986 * stack addresses to {function_name, source_file, line_number}.
5987 * Good news: there is command line utility atos(1) which does that.
5988 * Bad news 1: it's a command line utility.
5989 * Bad news 2: one needs to have the Developer Tools installed.
5990 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
5992 * To recap: we need to open a pipe for reading for a utility which
5993 * might not exist, or exists in different locations, and then parse
5994 * the output. And since this is all for a low-level API, we cannot
5995 * use high-level stuff. Thanks, Apple. */
5998 /* tool is set to the absolute pathname of the tool to use:
6001 /* format is set to a printf format string used for building
6002 * the external command to run. */
6004 /* unavail is set if e.g. xcrun cannot be found, or something
6005 * else happens that makes getting the backtrace dubious. Note,
6006 * however, that the context isn't persistent, the next call to
6007 * get_c_backtrace() will start from scratch. */
6009 /* fname is the current object file name. */
6011 /* object_base_addr is the base address of the shared object. */
6012 void* object_base_addr;
6015 /* Given |dl_info|, updates the context. If the context has been
6016 * marked unavailable, return immediately. If not but the tool has
6017 * not been set, set it to either "xcrun atos" or "atos" (also set the
6018 * format to use for creating commands for piping), or if neither is
6019 * unavailable (one needs the Developer Tools installed), mark the context
6020 * an unavailable. Finally, update the filename (object name),
6021 * and its base address. */
6023 static void atos_update(atos_context* ctx,
6028 if (ctx->tool == NULL) {
6029 const char* tools[] = {
6033 const char* formats[] = {
6034 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6035 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6039 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6040 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6041 ctx->tool = tools[i];
6042 ctx->format = formats[i];
6046 if (ctx->tool == NULL) {
6047 ctx->unavail = TRUE;
6051 if (ctx->fname == NULL ||
6052 strNE(dl_info->dli_fname, ctx->fname)) {
6053 ctx->fname = dl_info->dli_fname;
6054 ctx->object_base_addr = dl_info->dli_fbase;
6058 /* Given an output buffer end |p| and its |start|, matches
6059 * for the atos output, extracting the source code location
6060 * and returning non-NULL if possible, returning NULL otherwise. */
6061 static const char* atos_parse(const char* p,
6063 STRLEN* source_name_size,
6064 STRLEN* source_line) {
6065 /* atos() output is something like:
6066 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6067 * We cannot use Perl regular expressions, because we need to
6068 * stay low-level. Therefore here we have a rolled-out version
6069 * of a state machine which matches _backwards_from_the_end_ and
6070 * if there's a success, returns the starts of the filename,
6071 * also setting the filename size and the source line number.
6072 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6073 const char* source_number_start;
6074 const char* source_name_end;
6075 const char* source_line_end = start;
6076 const char* close_paren;
6079 /* Skip trailing whitespace. */
6080 while (p > start && isSPACE(*p)) p--;
6081 /* Now we should be at the close paren. */
6082 if (p == start || *p != ')')
6086 /* Now we should be in the line number. */
6087 if (p == start || !isDIGIT(*p))
6089 /* Skip over the digits. */
6090 while (p > start && isDIGIT(*p))
6092 /* Now we should be at the colon. */
6093 if (p == start || *p != ':')
6095 source_number_start = p + 1;
6096 source_name_end = p; /* Just beyond the end. */
6098 /* Look for the open paren. */
6099 while (p > start && *p != '(')
6104 *source_name_size = source_name_end - p;
6105 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6106 && source_line_end == close_paren
6107 && uv <= PERL_INT_MAX
6109 *source_line = (STRLEN)uv;
6115 /* Given a raw frame, read a pipe from the symbolicator (that's the
6116 * technical term) atos, reads the result, and parses the source code
6117 * location. We must stay low-level, so we use snprintf(), pipe(),
6118 * and fread(), and then also parse the output ourselves. */
6119 static void atos_symbolize(atos_context* ctx,
6122 STRLEN* source_name_size,
6123 STRLEN* source_line)
6131 /* Simple security measure: if there's any funny business with
6132 * the object name (used as "-o '%s'" ), leave since at least
6133 * partially the user controls it. */
6134 for (p = ctx->fname; *p; p++) {
6135 if (*p == '\'' || isCNTRL(*p)) {
6136 ctx->unavail = TRUE;
6140 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6141 ctx->fname, ctx->object_base_addr, raw_frame);
6142 if (cnt < sizeof(cmd)) {
6143 /* Undo nostdio.h #defines that disable stdio.
6144 * This is somewhat naughty, but is used elsewhere
6145 * in the core, and affects only OS X. */
6150 FILE* fp = popen(cmd, "r");
6151 /* At the moment we open a new pipe for each stack frame.
6152 * This is naturally somewhat slow, but hopefully generating
6153 * stack traces is never going to in a performance critical path.
6155 * We could play tricks with atos by batching the stack
6156 * addresses to be resolved: atos can either take multiple
6157 * addresses from the command line, or read addresses from
6158 * a file (though the mess of creating temporary files would
6159 * probably negate much of any possible speedup).
6161 * Normally there are only two objects present in the backtrace:
6162 * perl itself, and the libdyld.dylib. (Note that the object
6163 * filenames contain the full pathname, so perl may not always
6164 * be in the same place.) Whenever the object in the
6165 * backtrace changes, the base address also changes.
6167 * The problem with batching the addresses, though, would be
6168 * matching the results with the addresses: the parsing of
6169 * the results is already painful enough with a single address. */
6172 UV cnt = fread(out, 1, sizeof(out), fp);
6173 if (cnt < sizeof(out)) {
6174 const char* p = atos_parse(out + cnt - 1, out,
6179 *source_name_size, char);
6180 Copy(p, *source_name,
6181 *source_name_size, char);
6189 #endif /* #ifdef PERL_DARWIN */
6192 =for apidoc get_c_backtrace
6194 Collects the backtrace (aka "stacktrace") into a single linear
6195 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6197 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6198 returning at most C<depth> frames.
6204 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6206 /* Note that here we must stay as low-level as possible: Newx(),
6207 * Copy(), Safefree(); since we may be called from anywhere,
6208 * so we should avoid higher level constructs like SVs or AVs.
6210 * Since we are using safesysmalloc() via Newx(), don't try
6211 * getting backtrace() there, unless you like deep recursion. */
6213 /* Currently only implemented with backtrace() and dladdr(),
6214 * for other platforms NULL is returned. */
6216 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6217 /* backtrace() is available via <execinfo.h> in glibc and in most
6218 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6220 /* We try fetching this many frames total, but then discard
6221 * the |skip| first ones. For the remaining ones we will try
6222 * retrieving more information with dladdr(). */
6223 int try_depth = skip + depth;
6225 /* The addresses (program counters) returned by backtrace(). */
6228 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6231 /* Sizes _including_ the terminating \0 of the object name
6232 * and symbol name strings. */
6233 STRLEN* object_name_sizes;
6234 STRLEN* symbol_name_sizes;
6237 /* The symbol names comes either from dli_sname,
6238 * or if using BFD, they can come from BFD. */
6239 char** symbol_names;
6242 /* The source code location information. Dug out with e.g. BFD. */
6243 char** source_names;
6244 STRLEN* source_name_sizes;
6245 STRLEN* source_lines;
6247 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6248 int got_depth; /* How many frames were returned from backtrace(). */
6249 UV frame_count = 0; /* How many frames we return. */
6250 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6253 bfd_context bfd_ctx;
6256 atos_context atos_ctx;
6259 /* Here are probably possibilities for optimizing. We could for
6260 * example have a struct that contains most of these and then
6261 * allocate |try_depth| of them, saving a bunch of malloc calls.
6262 * Note, however, that |frames| could not be part of that struct
6263 * because backtrace() will want an array of just them. Also be
6264 * careful about the name strings. */
6265 Newx(raw_frames, try_depth, void*);
6266 Newx(dl_infos, try_depth, Dl_info);
6267 Newx(object_name_sizes, try_depth, STRLEN);
6268 Newx(symbol_name_sizes, try_depth, STRLEN);
6269 Newx(source_names, try_depth, char*);
6270 Newx(source_name_sizes, try_depth, STRLEN);
6271 Newx(source_lines, try_depth, STRLEN);
6273 Newx(symbol_names, try_depth, char*);
6276 /* Get the raw frames. */
6277 got_depth = (int)backtrace(raw_frames, try_depth);
6279 /* We use dladdr() instead of backtrace_symbols() because we want
6280 * the full details instead of opaque strings. This is useful for
6281 * two reasons: () the details are needed for further symbolic
6282 * digging, for example in OS X (2) by having the details we fully
6283 * control the output, which in turn is useful when more platforms
6284 * are added: we can keep out output "portable". */
6286 /* We want a single linear allocation, which can then be freed
6287 * with a single swoop. We will do the usual trick of first
6288 * walking over the structure and seeing how much we need to
6289 * allocate, then allocating, and then walking over the structure
6290 * the second time and populating it. */
6292 /* First we must compute the total size of the buffer. */
6293 total_bytes = sizeof(Perl_c_backtrace_header);
6294 if (got_depth > skip) {
6297 bfd_init(); /* Is this safe to call multiple times? */
6298 Zero(&bfd_ctx, 1, bfd_context);
6301 Zero(&atos_ctx, 1, atos_context);
6303 for (i = skip; i < try_depth; i++) {
6304 Dl_info* dl_info = &dl_infos[i];
6306 object_name_sizes[i] = 0;
6307 source_names[i] = NULL;
6308 source_name_sizes[i] = 0;
6309 source_lines[i] = 0;
6311 /* Yes, zero from dladdr() is failure. */
6312 if (dladdr(raw_frames[i], dl_info)) {
6313 total_bytes += sizeof(Perl_c_backtrace_frame);
6315 object_name_sizes[i] =
6316 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6317 symbol_name_sizes[i] =
6318 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6320 bfd_update(&bfd_ctx, dl_info);
6321 bfd_symbolize(&bfd_ctx, raw_frames[i],
6323 &symbol_name_sizes[i],
6325 &source_name_sizes[i],
6329 atos_update(&atos_ctx, dl_info);
6330 atos_symbolize(&atos_ctx,
6333 &source_name_sizes[i],
6337 /* Plus ones for the terminating \0. */
6338 total_bytes += object_name_sizes[i] + 1;
6339 total_bytes += symbol_name_sizes[i] + 1;
6340 total_bytes += source_name_sizes[i] + 1;
6348 Safefree(bfd_ctx.bfd_syms);
6352 /* Now we can allocate and populate the result buffer. */
6353 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6354 Zero(bt, total_bytes, char);
6355 bt->header.frame_count = frame_count;
6356 bt->header.total_bytes = total_bytes;
6357 if (frame_count > 0) {
6358 Perl_c_backtrace_frame* frame = bt->frame_info;
6359 char* name_base = (char *)(frame + frame_count);
6360 char* name_curr = name_base; /* Outputting the name strings here. */
6362 for (i = skip; i < skip + frame_count; i++) {
6363 Dl_info* dl_info = &dl_infos[i];
6365 frame->addr = raw_frames[i];
6366 frame->object_base_addr = dl_info->dli_fbase;
6367 frame->symbol_addr = dl_info->dli_saddr;
6369 /* Copies a string, including the \0, and advances the name_curr.
6370 * Also copies the start and the size to the frame. */
6371 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6373 Copy(src, name_curr, size, char); \
6374 frame->doffset = name_curr - (char*)bt; \
6375 frame->dsize = size; \
6376 name_curr += size; \
6379 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6381 object_name_size, object_name_sizes[i]);
6384 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6386 symbol_name_size, symbol_name_sizes[i]);
6387 Safefree(symbol_names[i]);
6389 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6391 symbol_name_size, symbol_name_sizes[i]);
6394 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6396 source_name_size, source_name_sizes[i]);
6397 Safefree(source_names[i]);
6399 #undef PERL_C_BACKTRACE_STRCPY
6401 frame->source_line_number = source_lines[i];
6405 assert(total_bytes ==
6406 (UV)(sizeof(Perl_c_backtrace_header) +
6407 frame_count * sizeof(Perl_c_backtrace_frame) +
6408 name_curr - name_base));
6411 Safefree(symbol_names);
6413 bfd_close(bfd_ctx.abfd);
6416 Safefree(source_lines);
6417 Safefree(source_name_sizes);
6418 Safefree(source_names);
6419 Safefree(symbol_name_sizes);
6420 Safefree(object_name_sizes);
6421 /* Assuming the strings returned by dladdr() are pointers
6422 * to read-only static memory (the object file), so that
6423 * they do not need freeing (and cannot be). */
6425 Safefree(raw_frames);
6428 PERL_UNUSED_ARGV(depth);
6429 PERL_UNUSED_ARGV(skip);
6435 =for apidoc free_c_backtrace
6437 Deallocates a backtrace received from get_c_bracktrace.
6443 =for apidoc get_c_backtrace_dump
6445 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6446 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6448 The appended output looks like:
6451 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6452 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6455 The fields are tab-separated. The first column is the depth (zero
6456 being the innermost non-skipped frame). In the hex:offset, the hex is
6457 where the program counter was in C<S_parse_body>, and the :offset (might
6458 be missing) tells how much inside the C<S_parse_body> the program counter was.
6460 The C<util.c:1716> is the source code file and line number.
6462 The F</usr/bin/perl> is obvious (hopefully).
6464 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6465 if the platform doesn't support retrieving the information;
6466 if the binary is missing the debug information;
6467 if the optimizer has transformed the code by for example inlining.
6473 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6475 Perl_c_backtrace* bt;
6477 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6479 Perl_c_backtrace_frame* frame;
6480 SV* dsv = newSVpvs("");
6482 for (i = 0, frame = bt->frame_info;
6483 i < bt->header.frame_count; i++, frame++) {
6484 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6485 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6486 /* Symbol (function) names might disappear without debug info.
6488 * The source code location might disappear in case of the
6489 * optimizer inlining or otherwise rearranging the code. */
6490 if (frame->symbol_addr) {
6491 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6493 ((char*)frame->addr - (char*)frame->symbol_addr));
6495 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6496 frame->symbol_name_size &&
6497 frame->symbol_name_offset ?
6498 (char*)bt + frame->symbol_name_offset : "-");
6499 if (frame->source_name_size &&
6500 frame->source_name_offset &&
6501 frame->source_line_number) {
6502 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6503 (char*)bt + frame->source_name_offset,
6504 (UV)frame->source_line_number);
6506 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6508 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6509 frame->object_name_size &&
6510 frame->object_name_offset ?
6511 (char*)bt + frame->object_name_offset : "-");
6512 /* The frame->object_base_addr is not output,
6513 * but it is used for symbolizing/symbolicating. */
6514 sv_catpvs(dsv, "\n");
6517 Perl_free_c_backtrace(bt);
6526 =for apidoc dump_c_backtrace
6528 Dumps the C backtrace to the given C<fp>.
6530 Returns true if a backtrace could be retrieved, false if not.
6536 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6540 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6542 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6545 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6551 #endif /* #ifdef USE_C_BACKTRACE */
6553 #ifdef PERL_TSA_ACTIVE
6555 /* pthread_mutex_t and perl_mutex are typedef equivalent
6556 * so casting the pointers is fine. */
6558 int perl_tsa_mutex_lock(perl_mutex* mutex)
6560 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6563 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6565 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6568 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6570 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6578 /* log a sub call or return */
6581 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6589 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6592 HEK *hek = CvNAME_HEK(cv);
6593 func = HEK_KEY(hek);
6599 start = (const COP *)CvSTART(cv);
6600 file = CopFILE(start);
6601 line = CopLINE(start);
6602 stash = CopSTASHPV(start);
6605 PERL_SUB_ENTRY(func, file, line, stash);
6608 PERL_SUB_RETURN(func, file, line, stash);
6613 /* log a require file loading/loaded */
6616 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6618 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6621 PERL_LOADING_FILE(name);
6624 PERL_LOADED_FILE(name);
6629 /* log an op execution */
6632 Perl_dtrace_probe_op(pTHX_ const OP *op)
6634 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6636 PERL_OP_ENTRY(OP_NAME(op));
6640 /* log a compile/run phase change */
6643 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6645 const char *ph_old = PL_phase_names[PL_phase];
6646 const char *ph_new = PL_phase_names[phase];
6648 PERL_PHASE_CHANGE(ph_new, ph_old);
6654 * ex: set ts=8 sts=4 sw=4 et: