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, Size_t len)
1094 PERL_UNUSED_CONTEXT;
1096 Newx(newaddr,len+1,char);
1097 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1099 /* might not be null terminated */
1100 newaddr[len] = '\0';
1101 return (char *) CopyD(pv,newaddr,len,char);
1104 return (char *) ZeroD(newaddr,len+1,char);
1109 =for apidoc savesharedpv
1111 A version of C<savepv()> which allocates the duplicate string in memory
1112 which is shared between threads.
1117 Perl_savesharedpv(pTHX_ const char *pv)
1122 PERL_UNUSED_CONTEXT;
1127 pvlen = strlen(pv)+1;
1128 newaddr = (char*)PerlMemShared_malloc(pvlen);
1132 return (char*)memcpy(newaddr, pv, pvlen);
1136 =for apidoc savesharedpvn
1138 A version of C<savepvn()> which allocates the duplicate string in memory
1139 which is shared between threads. (With the specific difference that a C<NULL>
1140 pointer is not acceptable)
1145 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1147 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1149 PERL_UNUSED_CONTEXT;
1150 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1155 newaddr[len] = '\0';
1156 return (char*)memcpy(newaddr, pv, len);
1160 =for apidoc savesvpv
1162 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1163 the passed in SV using C<SvPV()>
1165 On some platforms, Windows for example, all allocated memory owned by a thread
1166 is deallocated when that thread ends. So if you need that not to happen, you
1167 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1173 Perl_savesvpv(pTHX_ SV *sv)
1176 const char * const pv = SvPV_const(sv, len);
1179 PERL_ARGS_ASSERT_SAVESVPV;
1182 Newx(newaddr,len,char);
1183 return (char *) CopyD(pv,newaddr,len,char);
1187 =for apidoc savesharedsvpv
1189 A version of C<savesharedpv()> which allocates the duplicate string in
1190 memory which is shared between threads.
1196 Perl_savesharedsvpv(pTHX_ SV *sv)
1199 const char * const pv = SvPV_const(sv, len);
1201 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1203 return savesharedpvn(pv, len);
1206 /* the SV for Perl_form() and mess() is not kept in an arena */
1214 if (PL_phase != PERL_PHASE_DESTRUCT)
1215 return newSVpvs_flags("", SVs_TEMP);
1220 /* Create as PVMG now, to avoid any upgrading later */
1222 Newxz(any, 1, XPVMG);
1223 SvFLAGS(sv) = SVt_PVMG;
1224 SvANY(sv) = (void*)any;
1226 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1231 #if defined(PERL_IMPLICIT_CONTEXT)
1233 Perl_form_nocontext(const char* pat, ...)
1238 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1239 va_start(args, pat);
1240 retval = vform(pat, &args);
1244 #endif /* PERL_IMPLICIT_CONTEXT */
1247 =head1 Miscellaneous Functions
1250 Takes a sprintf-style format pattern and conventional
1251 (non-SV) arguments and returns the formatted string.
1253 (char *) Perl_form(pTHX_ const char* pat, ...)
1255 can be used any place a string (char *) is required:
1257 char * s = Perl_form("%d.%d",major,minor);
1259 Uses a single private buffer so if you want to format several strings you
1260 must explicitly copy the earlier strings away (and free the copies when you
1267 Perl_form(pTHX_ const char* pat, ...)
1271 PERL_ARGS_ASSERT_FORM;
1272 va_start(args, pat);
1273 retval = vform(pat, &args);
1279 Perl_vform(pTHX_ const char *pat, va_list *args)
1281 SV * const sv = mess_alloc();
1282 PERL_ARGS_ASSERT_VFORM;
1283 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1290 Take a sprintf-style format pattern and argument list. These are used to
1291 generate a string message. If the message does not end with a newline,
1292 then it will be extended with some indication of the current location
1293 in the code, as described for L</mess_sv>.
1295 Normally, the resulting message is returned in a new mortal SV.
1296 During global destruction a single SV may be shared between uses of
1302 #if defined(PERL_IMPLICIT_CONTEXT)
1304 Perl_mess_nocontext(const char *pat, ...)
1309 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1310 va_start(args, pat);
1311 retval = vmess(pat, &args);
1315 #endif /* PERL_IMPLICIT_CONTEXT */
1318 Perl_mess(pTHX_ const char *pat, ...)
1322 PERL_ARGS_ASSERT_MESS;
1323 va_start(args, pat);
1324 retval = vmess(pat, &args);
1330 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1333 /* Look for curop starting from o. cop is the last COP we've seen. */
1334 /* opnext means that curop is actually the ->op_next of the op we are
1337 PERL_ARGS_ASSERT_CLOSEST_COP;
1339 if (!o || !curop || (
1340 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1344 if (o->op_flags & OPf_KIDS) {
1346 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1349 /* If the OP_NEXTSTATE has been optimised away we can still use it
1350 * the get the file and line number. */
1352 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1353 cop = (const COP *)kid;
1355 /* Keep searching, and return when we've found something. */
1357 new_cop = closest_cop(cop, kid, curop, opnext);
1363 /* Nothing found. */
1371 Expands a message, intended for the user, to include an indication of
1372 the current location in the code, if the message does not already appear
1375 C<basemsg> is the initial message or object. If it is a reference, it
1376 will be used as-is and will be the result of this function. Otherwise it
1377 is used as a string, and if it already ends with a newline, it is taken
1378 to be complete, and the result of this function will be the same string.
1379 If the message does not end with a newline, then a segment such as C<at
1380 foo.pl line 37> will be appended, and possibly other clauses indicating
1381 the current state of execution. The resulting message will end with a
1384 Normally, the resulting message is returned in a new mortal SV.
1385 During global destruction a single SV may be shared between uses of this
1386 function. If C<consume> is true, then the function is permitted (but not
1387 required) to modify and return C<basemsg> instead of allocating a new SV.
1393 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1397 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1401 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1402 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1403 && grok_atoUV(ws, &wi, NULL)
1404 && wi <= PERL_INT_MAX
1406 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1411 PERL_ARGS_ASSERT_MESS_SV;
1413 if (SvROK(basemsg)) {
1419 sv_setsv(sv, basemsg);
1424 if (SvPOK(basemsg) && consume) {
1429 sv_copypv(sv, basemsg);
1432 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1434 * Try and find the file and line for PL_op. This will usually be
1435 * PL_curcop, but it might be a cop that has been optimised away. We
1436 * can try to find such a cop by searching through the optree starting
1437 * from the sibling of PL_curcop.
1442 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1447 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1448 OutCopFILE(cop), (IV)CopLINE(cop));
1451 /* Seems that GvIO() can be untrustworthy during global destruction. */
1452 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1453 && IoLINES(GvIOp(PL_last_in_gv)))
1456 const bool line_mode = (RsSIMPLE(PL_rs) &&
1457 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1458 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1459 SVfARG(PL_last_in_gv == PL_argvgv
1461 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1462 line_mode ? "line" : "chunk",
1463 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1465 if (PL_phase == PERL_PHASE_DESTRUCT)
1466 sv_catpvs(sv, " during global destruction");
1467 sv_catpvs(sv, ".\n");
1475 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1476 argument list, respectively. These are used to generate a string message. If
1478 message does not end with a newline, then it will be extended with
1479 some indication of the current location in the code, as described for
1482 Normally, the resulting message is returned in a new mortal SV.
1483 During global destruction a single SV may be shared between uses of
1490 Perl_vmess(pTHX_ const char *pat, va_list *args)
1492 SV * const sv = mess_alloc();
1494 PERL_ARGS_ASSERT_VMESS;
1496 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1497 return mess_sv(sv, 1);
1501 Perl_write_to_stderr(pTHX_ SV* msv)
1506 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1508 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1509 && (io = GvIO(PL_stderrgv))
1510 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1511 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1512 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1514 PerlIO * const serr = Perl_error_log;
1516 do_print(msv, serr);
1517 (void)PerlIO_flush(serr);
1522 =head1 Warning and Dieing
1525 /* Common code used in dieing and warning */
1528 S_with_queued_errors(pTHX_ SV *ex)
1530 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1531 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1532 sv_catsv(PL_errors, ex);
1533 ex = sv_mortalcopy(PL_errors);
1534 SvCUR_set(PL_errors, 0);
1540 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1546 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1547 /* sv_2cv might call Perl_croak() or Perl_warner() */
1548 SV * const oldhook = *hook;
1550 if (!oldhook || oldhook == PERL_WARNHOOK_FATAL)
1556 cv = sv_2cv(oldhook, &stash, &gv, 0);
1558 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1568 exarg = newSVsv(ex);
1569 SvREADONLY_on(exarg);
1572 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1576 call_sv(MUTABLE_SV(cv), G_DISCARD);
1587 Behaves the same as L</croak_sv>, except for the return type.
1588 It should be used only where the C<OP *> return type is required.
1589 The function never actually returns.
1594 /* silence __declspec(noreturn) warnings */
1595 MSVC_DIAG_IGNORE(4646 4645)
1597 Perl_die_sv(pTHX_ SV *baseex)
1599 PERL_ARGS_ASSERT_DIE_SV;
1602 NORETURN_FUNCTION_END;
1609 Behaves the same as L</croak>, except for the return type.
1610 It should be used only where the C<OP *> return type is required.
1611 The function never actually returns.
1616 #if defined(PERL_IMPLICIT_CONTEXT)
1618 /* silence __declspec(noreturn) warnings */
1619 MSVC_DIAG_IGNORE(4646 4645)
1621 Perl_die_nocontext(const char* pat, ...)
1625 va_start(args, pat);
1627 NOT_REACHED; /* NOTREACHED */
1629 NORETURN_FUNCTION_END;
1633 #endif /* PERL_IMPLICIT_CONTEXT */
1635 /* silence __declspec(noreturn) warnings */
1636 MSVC_DIAG_IGNORE(4646 4645)
1638 Perl_die(pTHX_ const char* pat, ...)
1641 va_start(args, pat);
1643 NOT_REACHED; /* NOTREACHED */
1645 NORETURN_FUNCTION_END;
1650 =for apidoc croak_sv
1652 This is an XS interface to Perl's C<die> function.
1654 C<baseex> is the error message or object. If it is a reference, it
1655 will be used as-is. Otherwise it is used as a string, and if it does
1656 not end with a newline then it will be extended with some indication of
1657 the current location in the code, as described for L</mess_sv>.
1659 The error message or object will be used as an exception, by default
1660 returning control to the nearest enclosing C<eval>, but subject to
1661 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1662 function never returns normally.
1664 To die with a simple string message, the L</croak> function may be
1671 Perl_croak_sv(pTHX_ SV *baseex)
1673 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1674 PERL_ARGS_ASSERT_CROAK_SV;
1675 invoke_exception_hook(ex, FALSE);
1682 This is an XS interface to Perl's C<die> function.
1684 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1685 argument list. These are used to generate a string message. If the
1686 message does not end with a newline, then it will be extended with
1687 some indication of the current location in the code, as described for
1690 The error message will be used as an exception, by default
1691 returning control to the nearest enclosing C<eval>, but subject to
1692 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1693 function never returns normally.
1695 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1696 (C<$@>) will be used as an error message or object instead of building an
1697 error message from arguments. If you want to throw a non-string object,
1698 or build an error message in an SV yourself, it is preferable to use
1699 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1705 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1707 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1708 invoke_exception_hook(ex, FALSE);
1715 This is an XS interface to Perl's C<die> function.
1717 Take a sprintf-style format pattern and argument list. These are used to
1718 generate a string message. If the message does not end with a newline,
1719 then it will be extended with some indication of the current location
1720 in the code, as described for L</mess_sv>.
1722 The error message will be used as an exception, by default
1723 returning control to the nearest enclosing C<eval>, but subject to
1724 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1725 function never returns normally.
1727 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1728 (C<$@>) will be used as an error message or object instead of building an
1729 error message from arguments. If you want to throw a non-string object,
1730 or build an error message in an SV yourself, it is preferable to use
1731 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1736 #if defined(PERL_IMPLICIT_CONTEXT)
1738 Perl_croak_nocontext(const char *pat, ...)
1742 va_start(args, pat);
1744 NOT_REACHED; /* NOTREACHED */
1747 #endif /* PERL_IMPLICIT_CONTEXT */
1750 Perl_croak(pTHX_ const char *pat, ...)
1753 va_start(args, pat);
1755 NOT_REACHED; /* NOTREACHED */
1760 =for apidoc croak_no_modify
1762 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1763 terser object code than using C<Perl_croak>. Less code used on exception code
1764 paths reduces CPU cache pressure.
1770 Perl_croak_no_modify(void)
1772 Perl_croak_nocontext( "%s", PL_no_modify);
1775 /* does not return, used in util.c perlio.c and win32.c
1776 This is typically called when malloc returns NULL.
1779 Perl_croak_no_mem(void)
1783 int fd = PerlIO_fileno(Perl_error_log);
1785 SETERRNO(EBADF,RMS_IFI);
1787 /* Can't use PerlIO to write as it allocates memory */
1788 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1793 /* does not return, used only in POPSTACK */
1795 Perl_croak_popstack(void)
1798 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1805 This is an XS interface to Perl's C<warn> function.
1807 C<baseex> is the error message or object. If it is a reference, it
1808 will be used as-is. Otherwise it is used as a string, and if it does
1809 not end with a newline then it will be extended with some indication of
1810 the current location in the code, as described for L</mess_sv>.
1812 The error message or object will by default be written to standard error,
1813 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1815 To warn with a simple string message, the L</warn> function may be
1822 Perl_warn_sv(pTHX_ SV *baseex)
1824 SV *ex = mess_sv(baseex, 0);
1825 PERL_ARGS_ASSERT_WARN_SV;
1826 if (!invoke_exception_hook(ex, TRUE))
1827 write_to_stderr(ex);
1833 This is an XS interface to Perl's C<warn> function.
1835 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1836 argument list. These are used to generate a string message. If the
1837 message does not end with a newline, then it will be extended with
1838 some indication of the current location in the code, as described for
1841 The error message or object will by default be written to standard error,
1842 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1844 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1850 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1852 SV *ex = vmess(pat, args);
1853 PERL_ARGS_ASSERT_VWARN;
1854 if (!invoke_exception_hook(ex, TRUE))
1855 write_to_stderr(ex);
1861 This is an XS interface to Perl's C<warn> function.
1863 Take a sprintf-style format pattern and argument list. These are used to
1864 generate a string message. If the message does not end with a newline,
1865 then it will be extended with some indication of the current location
1866 in the code, as described for L</mess_sv>.
1868 The error message or object will by default be written to standard error,
1869 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1871 Unlike with L</croak>, C<pat> is not permitted to be null.
1876 #if defined(PERL_IMPLICIT_CONTEXT)
1878 Perl_warn_nocontext(const char *pat, ...)
1882 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1883 va_start(args, pat);
1887 #endif /* PERL_IMPLICIT_CONTEXT */
1890 Perl_warn(pTHX_ const char *pat, ...)
1893 PERL_ARGS_ASSERT_WARN;
1894 va_start(args, pat);
1899 #if defined(PERL_IMPLICIT_CONTEXT)
1901 Perl_warner_nocontext(U32 err, const char *pat, ...)
1905 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1906 va_start(args, pat);
1907 vwarner(err, pat, &args);
1910 #endif /* PERL_IMPLICIT_CONTEXT */
1913 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1915 PERL_ARGS_ASSERT_CK_WARNER_D;
1917 if (Perl_ckwarn_d(aTHX_ err)) {
1919 va_start(args, pat);
1920 vwarner(err, pat, &args);
1926 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1928 PERL_ARGS_ASSERT_CK_WARNER;
1930 if (Perl_ckwarn(aTHX_ err)) {
1932 va_start(args, pat);
1933 vwarner(err, pat, &args);
1939 Perl_warner(pTHX_ U32 err, const char* pat,...)
1942 PERL_ARGS_ASSERT_WARNER;
1943 va_start(args, pat);
1944 vwarner(err, pat, &args);
1949 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1952 PERL_ARGS_ASSERT_VWARNER;
1954 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
1955 !(PL_in_eval & EVAL_KEEPERR)
1957 SV * const msv = vmess(pat, args);
1959 if (PL_parser && PL_parser->error_count) {
1963 invoke_exception_hook(msv, FALSE);
1968 Perl_vwarn(aTHX_ pat, args);
1972 /* implements the ckWARN? macros */
1975 Perl_ckwarn(pTHX_ U32 w)
1977 /* If lexical warnings have not been set, use $^W. */
1979 return PL_dowarn & G_WARN_ON;
1981 return ckwarn_common(w);
1984 /* implements the ckWARN?_d macro */
1987 Perl_ckwarn_d(pTHX_ U32 w)
1989 /* If lexical warnings have not been set then default classes warn. */
1993 return ckwarn_common(w);
1997 S_ckwarn_common(pTHX_ U32 w)
1999 if (PL_curcop->cop_warnings == pWARN_ALL)
2002 if (PL_curcop->cop_warnings == pWARN_NONE)
2005 /* Check the assumption that at least the first slot is non-zero. */
2006 assert(unpackWARN1(w));
2008 /* Check the assumption that it is valid to stop as soon as a zero slot is
2010 if (!unpackWARN2(w)) {
2011 assert(!unpackWARN3(w));
2012 assert(!unpackWARN4(w));
2013 } else if (!unpackWARN3(w)) {
2014 assert(!unpackWARN4(w));
2017 /* Right, dealt with all the special cases, which are implemented as non-
2018 pointers, so there is a pointer to a real warnings mask. */
2020 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2022 } while (w >>= WARNshift);
2027 /* Set buffer=NULL to get a new one. */
2029 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2031 const MEM_SIZE len_wanted =
2032 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2033 PERL_UNUSED_CONTEXT;
2034 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2037 (specialWARN(buffer) ?
2038 PerlMemShared_malloc(len_wanted) :
2039 PerlMemShared_realloc(buffer, len_wanted));
2041 Copy(bits, (buffer + 1), size, char);
2042 if (size < WARNsize)
2043 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2047 /* since we've already done strlen() for both nam and val
2048 * we can use that info to make things faster than
2049 * sprintf(s, "%s=%s", nam, val)
2051 #define my_setenv_format(s, nam, nlen, val, vlen) \
2052 Copy(nam, s, nlen, char); \
2054 Copy(val, s+(nlen+1), vlen, char); \
2055 *(s+(nlen+1+vlen)) = '\0'
2059 #ifdef USE_ENVIRON_ARRAY
2060 /* NB: VMS' my_setenv() is in vms.c */
2062 /* Configure doesn't test for HAS_SETENV yet, so decide based on platform.
2063 * For Solaris, setenv() and unsetenv() were introduced in Solaris 9, so
2064 * testing for HAS UNSETENV is sufficient.
2066 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2067 # define MY_HAS_SETENV
2070 /* small wrapper for use by Perl_my_setenv that mallocs, or reallocs if
2071 * 'current' is non-null, with up to three sizes that are added together.
2072 * It handles integer overflow.
2074 # ifndef MY_HAS_SETENV
2076 S_env_alloc(void *current, Size_t l1, Size_t l2, Size_t l3, Size_t size)
2079 Size_t sl, l = l1 + l2;
2091 ? safesysrealloc(current, sl)
2092 : safesysmalloc(sl);
2097 croak_memory_wrap();
2102 # if !defined(WIN32) && !defined(NETWARE)
2105 =for apidoc my_setenv
2107 A wrapper for the C library L<setenv(3)>. Don't use the latter, as the perl
2108 version has desirable safeguards
2114 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2117 # ifdef __amigaos4__
2118 amigaos4_obtain_environ(__FUNCTION__);
2121 # ifdef USE_ITHREADS
2122 /* only parent thread can modify process environment */
2123 if (PL_curinterp == aTHX)
2127 # ifndef PERL_USE_SAFE_PUTENV
2128 if (!PL_use_safe_putenv) {
2129 /* most putenv()s leak, so we manipulate environ directly */
2131 Size_t vlen, nlen = strlen(nam);
2133 /* where does it go? */
2134 for (i = 0; environ[i]; i++) {
2135 if (strnEQ(environ[i], nam, nlen) && environ[i][nlen] == '=')
2139 if (environ == PL_origenviron) { /* need we copy environment? */
2144 while (environ[max])
2147 /* XXX shouldn't that be max+1 rather than max+2 ??? - DAPM */
2148 tmpenv = (char**)S_env_alloc(NULL, max, 2, 0, sizeof(char*));
2150 for (j=0; j<max; j++) { /* copy environment */
2151 const Size_t len = strlen(environ[j]);
2152 tmpenv[j] = S_env_alloc(NULL, len, 1, 0, 1);
2153 Copy(environ[j], tmpenv[j], len+1, char);
2157 environ = tmpenv; /* tell exec where it is now */
2161 safesysfree(environ[i]);
2162 while (environ[i]) {
2163 environ[i] = environ[i+1];
2166 # ifdef __amigaos4__
2173 if (!environ[i]) { /* does not exist yet */
2174 environ = (char**)S_env_alloc(environ, i, 2, 0, sizeof(char*));
2175 environ[i+1] = NULL; /* make sure it's null terminated */
2178 safesysfree(environ[i]);
2182 environ[i] = S_env_alloc(NULL, nlen, vlen, 2, 1);
2183 /* all that work just for this */
2184 my_setenv_format(environ[i], nam, nlen, val, vlen);
2188 # endif /* !PERL_USE_SAFE_PUTENV */
2190 # ifdef MY_HAS_SETENV
2191 # if defined(HAS_UNSETENV)
2193 (void)unsetenv(nam);
2195 (void)setenv(nam, val, 1);
2197 # else /* ! HAS_UNSETENV */
2198 (void)setenv(nam, val, 1);
2199 # endif /* HAS_UNSETENV */
2201 # elif defined(HAS_UNSETENV)
2204 if (environ) /* old glibc can crash with null environ */
2205 (void)unsetenv(nam);
2207 const Size_t nlen = strlen(nam);
2208 const Size_t vlen = strlen(val);
2209 char * const new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2210 my_setenv_format(new_env, nam, nlen, val, vlen);
2211 (void)putenv(new_env);
2214 # else /* ! HAS_UNSETENV */
2217 const Size_t nlen = strlen(nam);
2223 new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2224 /* all that work just for this */
2225 my_setenv_format(new_env, nam, nlen, val, vlen);
2226 (void)putenv(new_env);
2228 # endif /* MY_HAS_SETENV */
2230 # ifndef PERL_USE_SAFE_PUTENV
2235 # ifdef __amigaos4__
2237 amigaos4_release_environ(__FUNCTION__);
2241 # else /* WIN32 || NETWARE */
2244 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2248 const Size_t nlen = strlen(nam);
2255 envstr = S_env_alloc(NULL, nlen, vlen, 2, 1);
2256 my_setenv_format(envstr, nam, nlen, val, vlen);
2257 (void)PerlEnv_putenv(envstr);
2258 safesysfree(envstr);
2261 # endif /* WIN32 || NETWARE */
2263 #endif /* USE_ENVIRON_ARRAY */
2268 #ifdef UNLINK_ALL_VERSIONS
2270 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2274 PERL_ARGS_ASSERT_UNLNK;
2276 while (PerlLIO_unlink(f) >= 0)
2278 return retries ? 0 : -1;
2283 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2285 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2293 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2295 PERL_FLUSHALL_FOR_CHILD;
2296 This = (*mode == 'w');
2300 taint_proper("Insecure %s%s", "EXEC");
2302 if (PerlProc_pipe_cloexec(p) < 0)
2304 /* Try for another pipe pair for error return */
2305 if (PerlProc_pipe_cloexec(pp) >= 0)
2307 while ((pid = PerlProc_fork()) < 0) {
2308 if (errno != EAGAIN) {
2309 PerlLIO_close(p[This]);
2310 PerlLIO_close(p[that]);
2312 PerlLIO_close(pp[0]);
2313 PerlLIO_close(pp[1]);
2317 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2326 /* Close parent's end of error status pipe (if any) */
2328 PerlLIO_close(pp[0]);
2329 /* Now dup our end of _the_ pipe to right position */
2330 if (p[THIS] != (*mode == 'r')) {
2331 PerlLIO_dup2(p[THIS], *mode == 'r');
2332 PerlLIO_close(p[THIS]);
2333 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2334 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2337 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2338 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2340 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2341 /* No automatic close - do it by hand */
2348 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2354 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2361 PerlLIO_close(pp[1]);
2362 /* Keep the lower of the two fd numbers */
2363 if (p[that] < p[This]) {
2364 PerlLIO_dup2_cloexec(p[This], p[that]);
2365 PerlLIO_close(p[This]);
2369 PerlLIO_close(p[that]); /* close child's end of pipe */
2371 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2372 SvUPGRADE(sv,SVt_IV);
2374 PL_forkprocess = pid;
2375 /* If we managed to get status pipe check for exec fail */
2376 if (did_pipes && pid > 0) {
2378 unsigned read_total = 0;
2380 while (read_total < sizeof(int)) {
2381 const SSize_t n1 = PerlLIO_read(pp[0],
2382 (void*)(((char*)&errkid)+read_total),
2383 (sizeof(int)) - read_total);
2388 PerlLIO_close(pp[0]);
2390 if (read_total) { /* Error */
2392 PerlLIO_close(p[This]);
2393 if (read_total != sizeof(int))
2394 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", read_total);
2396 pid2 = wait4pid(pid, &status, 0);
2397 } while (pid2 == -1 && errno == EINTR);
2398 errno = errkid; /* Propagate errno from kid */
2403 PerlLIO_close(pp[0]);
2404 return PerlIO_fdopen(p[This], mode);
2406 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2407 return my_syspopen4(aTHX_ NULL, mode, n, args);
2408 # elif defined(WIN32)
2409 return win32_popenlist(mode, n, args);
2411 Perl_croak(aTHX_ "List form of piped open not implemented");
2412 return (PerlIO *) NULL;
2417 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2418 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2420 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2426 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2430 PERL_ARGS_ASSERT_MY_POPEN;
2432 PERL_FLUSHALL_FOR_CHILD;
2435 return my_syspopen(aTHX_ cmd,mode);
2438 This = (*mode == 'w');
2440 if (doexec && TAINTING_get) {
2442 taint_proper("Insecure %s%s", "EXEC");
2444 if (PerlProc_pipe_cloexec(p) < 0)
2446 if (doexec && PerlProc_pipe_cloexec(pp) >= 0)
2448 while ((pid = PerlProc_fork()) < 0) {
2449 if (errno != EAGAIN) {
2450 PerlLIO_close(p[This]);
2451 PerlLIO_close(p[that]);
2453 PerlLIO_close(pp[0]);
2454 PerlLIO_close(pp[1]);
2457 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2460 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2470 PerlLIO_close(pp[0]);
2471 if (p[THIS] != (*mode == 'r')) {
2472 PerlLIO_dup2(p[THIS], *mode == 'r');
2473 PerlLIO_close(p[THIS]);
2474 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2475 PerlLIO_close(p[THAT]);
2478 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2479 PerlLIO_close(p[THAT]);
2483 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2490 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2495 /* may or may not use the shell */
2496 do_exec3(cmd, pp[1], did_pipes);
2499 #endif /* defined OS2 */
2501 #ifdef PERLIO_USING_CRLF
2502 /* Since we circumvent IO layers when we manipulate low-level
2503 filedescriptors directly, need to manually switch to the
2504 default, binary, low-level mode; see PerlIOBuf_open(). */
2505 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2508 #ifdef PERL_USES_PL_PIDSTATUS
2509 hv_clear(PL_pidstatus); /* we have no children */
2516 PerlLIO_close(pp[1]);
2517 if (p[that] < p[This]) {
2518 PerlLIO_dup2_cloexec(p[This], p[that]);
2519 PerlLIO_close(p[This]);
2523 PerlLIO_close(p[that]);
2525 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2526 SvUPGRADE(sv,SVt_IV);
2528 PL_forkprocess = pid;
2529 if (did_pipes && pid > 0) {
2533 while (n < sizeof(int)) {
2534 const SSize_t n1 = PerlLIO_read(pp[0],
2535 (void*)(((char*)&errkid)+n),
2541 PerlLIO_close(pp[0]);
2543 if (n) { /* Error */
2545 PerlLIO_close(p[This]);
2546 if (n != sizeof(int))
2547 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2549 pid2 = wait4pid(pid, &status, 0);
2550 } while (pid2 == -1 && errno == EINTR);
2551 errno = errkid; /* Propagate errno from kid */
2556 PerlLIO_close(pp[0]);
2557 return PerlIO_fdopen(p[This], mode);
2559 #elif defined(DJGPP)
2560 FILE *djgpp_popen();
2562 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2564 PERL_FLUSHALL_FOR_CHILD;
2565 /* Call system's popen() to get a FILE *, then import it.
2566 used 0 for 2nd parameter to PerlIO_importFILE;
2569 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2571 #elif defined(__LIBCATAMOUNT__)
2573 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2578 #endif /* !DOSISH */
2580 /* this is called in parent before the fork() */
2582 Perl_atfork_lock(void)
2583 #if defined(USE_ITHREADS)
2585 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2588 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2590 PERL_TSA_ACQUIRE(PL_op_mutex)
2593 #if defined(USE_ITHREADS)
2595 /* locks must be held in locking order (if any) */
2597 MUTEX_LOCK(&PL_perlio_mutex);
2600 MUTEX_LOCK(&PL_malloc_mutex);
2606 /* this is called in both parent and child after the fork() */
2608 Perl_atfork_unlock(void)
2609 #if defined(USE_ITHREADS)
2611 PERL_TSA_RELEASE(PL_perlio_mutex)
2614 PERL_TSA_RELEASE(PL_malloc_mutex)
2616 PERL_TSA_RELEASE(PL_op_mutex)
2619 #if defined(USE_ITHREADS)
2621 /* locks must be released in same order as in atfork_lock() */
2623 MUTEX_UNLOCK(&PL_perlio_mutex);
2626 MUTEX_UNLOCK(&PL_malloc_mutex);
2635 #if defined(HAS_FORK)
2637 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2642 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2643 * handlers elsewhere in the code */
2647 #elif defined(__amigaos4__)
2648 return amigaos_fork();
2650 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2651 Perl_croak_nocontext("fork() not available");
2653 #endif /* HAS_FORK */
2658 dup2(int oldfd, int newfd)
2660 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2663 PerlLIO_close(newfd);
2664 return fcntl(oldfd, F_DUPFD, newfd);
2666 #define DUP2_MAX_FDS 256
2667 int fdtmp[DUP2_MAX_FDS];
2673 PerlLIO_close(newfd);
2674 /* good enough for low fd's... */
2675 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2676 if (fdx >= DUP2_MAX_FDS) {
2684 PerlLIO_close(fdtmp[--fdx]);
2691 #ifdef HAS_SIGACTION
2696 A wrapper for the C library L<signal(2)>. Don't use the latter, as the Perl
2697 version knows things that interact with the rest of the perl interpreter.
2703 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2705 struct sigaction act, oact;
2709 /* only "parent" interpreter can diddle signals */
2710 if (PL_curinterp != aTHX)
2711 return (Sighandler_t) SIG_ERR;
2714 act.sa_handler = handler;
2715 sigemptyset(&act.sa_mask);
2718 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2719 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2721 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2722 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2723 act.sa_flags |= SA_NOCLDWAIT;
2725 if (sigaction(signo, &act, &oact) == -1)
2726 return (Sighandler_t) SIG_ERR;
2728 return (Sighandler_t) oact.sa_handler;
2732 Perl_rsignal_state(pTHX_ int signo)
2734 struct sigaction oact;
2735 PERL_UNUSED_CONTEXT;
2737 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2738 return (Sighandler_t) SIG_ERR;
2740 return (Sighandler_t) oact.sa_handler;
2744 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2749 struct sigaction act;
2751 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2754 /* only "parent" interpreter can diddle signals */
2755 if (PL_curinterp != aTHX)
2759 act.sa_handler = handler;
2760 sigemptyset(&act.sa_mask);
2763 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2764 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2766 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2767 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2768 act.sa_flags |= SA_NOCLDWAIT;
2770 return sigaction(signo, &act, save);
2774 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2779 PERL_UNUSED_CONTEXT;
2781 /* only "parent" interpreter can diddle signals */
2782 if (PL_curinterp != aTHX)
2786 return sigaction(signo, save, (struct sigaction *)NULL);
2789 #else /* !HAS_SIGACTION */
2792 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2794 #if defined(USE_ITHREADS) && !defined(WIN32)
2795 /* only "parent" interpreter can diddle signals */
2796 if (PL_curinterp != aTHX)
2797 return (Sighandler_t) SIG_ERR;
2800 return PerlProc_signal(signo, handler);
2811 Perl_rsignal_state(pTHX_ int signo)
2814 Sighandler_t oldsig;
2816 #if defined(USE_ITHREADS) && !defined(WIN32)
2817 /* only "parent" interpreter can diddle signals */
2818 if (PL_curinterp != aTHX)
2819 return (Sighandler_t) SIG_ERR;
2823 oldsig = PerlProc_signal(signo, sig_trap);
2824 PerlProc_signal(signo, oldsig);
2826 PerlProc_kill(PerlProc_getpid(), signo);
2831 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2833 #if defined(USE_ITHREADS) && !defined(WIN32)
2834 /* only "parent" interpreter can diddle signals */
2835 if (PL_curinterp != aTHX)
2838 *save = PerlProc_signal(signo, handler);
2839 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2843 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2845 #if defined(USE_ITHREADS) && !defined(WIN32)
2846 /* only "parent" interpreter can diddle signals */
2847 if (PL_curinterp != aTHX)
2850 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2853 #endif /* !HAS_SIGACTION */
2854 #endif /* !PERL_MICRO */
2856 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2857 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2859 Perl_my_pclose(pTHX_ PerlIO *ptr)
2867 const int fd = PerlIO_fileno(ptr);
2870 svp = av_fetch(PL_fdpid,fd,TRUE);
2871 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2875 #if defined(USE_PERLIO)
2876 /* Find out whether the refcount is low enough for us to wait for the
2877 child proc without blocking. */
2878 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
2880 should_wait = pid > 0;
2884 if (pid == -1) { /* Opened by popen. */
2885 return my_syspclose(ptr);
2888 close_failed = (PerlIO_close(ptr) == EOF);
2890 if (should_wait) do {
2891 pid2 = wait4pid(pid, &status, 0);
2892 } while (pid2 == -1 && errno == EINTR);
2899 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2903 #elif defined(__LIBCATAMOUNT__)
2905 Perl_my_pclose(pTHX_ PerlIO *ptr)
2909 #endif /* !DOSISH */
2911 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2913 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
2916 PERL_ARGS_ASSERT_WAIT4PID;
2917 #ifdef PERL_USES_PL_PIDSTATUS
2919 /* PERL_USES_PL_PIDSTATUS is only defined when neither
2920 waitpid() nor wait4() is available, or on OS/2, which
2921 doesn't appear to support waiting for a progress group
2922 member, so we can only treat a 0 pid as an unknown child.
2929 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
2930 pid, rather than a string form. */
2931 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
2932 if (svp && *svp != &PL_sv_undef) {
2933 *statusp = SvIVX(*svp);
2934 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
2942 hv_iterinit(PL_pidstatus);
2943 if ((entry = hv_iternext(PL_pidstatus))) {
2944 SV * const sv = hv_iterval(PL_pidstatus,entry);
2946 const char * const spid = hv_iterkey(entry,&len);
2948 assert (len == sizeof(Pid_t));
2949 memcpy((char *)&pid, spid, len);
2950 *statusp = SvIVX(sv);
2951 /* The hash iterator is currently on this entry, so simply
2952 calling hv_delete would trigger the lazy delete, which on
2953 aggregate does more work, because next call to hv_iterinit()
2954 would spot the flag, and have to call the delete routine,
2955 while in the meantime any new entries can't re-use that
2957 hv_iterinit(PL_pidstatus);
2958 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
2965 # ifdef HAS_WAITPID_RUNTIME
2966 if (!HAS_WAITPID_RUNTIME)
2969 result = PerlProc_waitpid(pid,statusp,flags);
2972 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
2973 result = wait4(pid,statusp,flags,NULL);
2976 #ifdef PERL_USES_PL_PIDSTATUS
2977 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
2982 Perl_croak(aTHX_ "Can't do waitpid with flags");
2984 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
2985 pidgone(result,*statusp);
2991 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
2994 if (result < 0 && errno == EINTR) {
2996 errno = EINTR; /* reset in case a signal handler changed $! */
3000 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3002 #ifdef PERL_USES_PL_PIDSTATUS
3004 S_pidgone(pTHX_ Pid_t pid, int status)
3008 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3009 SvUPGRADE(sv,SVt_IV);
3010 SvIV_set(sv, status);
3018 int /* Cannot prototype with I32
3020 my_syspclose(PerlIO *ptr)
3023 Perl_my_pclose(pTHX_ PerlIO *ptr)
3026 /* Needs work for PerlIO ! */
3027 FILE * const f = PerlIO_findFILE(ptr);
3028 const I32 result = pclose(f);
3029 PerlIO_releaseFILE(ptr,f);
3037 Perl_my_pclose(pTHX_ PerlIO *ptr)
3039 /* Needs work for PerlIO ! */
3040 FILE * const f = PerlIO_findFILE(ptr);
3041 I32 result = djgpp_pclose(f);
3042 result = (result << 8) & 0xff00;
3043 PerlIO_releaseFILE(ptr,f);
3048 #define PERL_REPEATCPY_LINEAR 4
3050 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3052 PERL_ARGS_ASSERT_REPEATCPY;
3057 croak_memory_wrap();
3060 memset(to, *from, count);
3063 IV items, linear, half;
3065 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3066 for (items = 0; items < linear; ++items) {
3067 const char *q = from;
3069 for (todo = len; todo > 0; todo--)
3074 while (items <= half) {
3075 IV size = items * len;
3076 memcpy(p, to, size);
3082 memcpy(p, to, (count - items) * len);
3088 Perl_same_dirent(pTHX_ const char *a, const char *b)
3090 char *fa = strrchr(a,'/');
3091 char *fb = strrchr(b,'/');
3094 SV * const tmpsv = sv_newmortal();
3096 PERL_ARGS_ASSERT_SAME_DIRENT;
3109 sv_setpvs(tmpsv, ".");
3111 sv_setpvn(tmpsv, a, fa - a);
3112 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3115 sv_setpvs(tmpsv, ".");
3117 sv_setpvn(tmpsv, b, fb - b);
3118 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3120 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3121 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3123 #endif /* !HAS_RENAME */
3126 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3127 const char *const *const search_ext, I32 flags)
3129 const char *xfound = NULL;
3130 char *xfailed = NULL;
3131 char tmpbuf[MAXPATHLEN];
3136 #if defined(DOSISH) && !defined(OS2)
3137 # define SEARCH_EXTS ".bat", ".cmd", NULL
3138 # define MAX_EXT_LEN 4
3141 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3142 # define MAX_EXT_LEN 4
3145 # define SEARCH_EXTS ".pl", ".com", NULL
3146 # define MAX_EXT_LEN 4
3148 /* additional extensions to try in each dir if scriptname not found */
3150 static const char *const exts[] = { SEARCH_EXTS };
3151 const char *const *const ext = search_ext ? search_ext : exts;
3152 int extidx = 0, i = 0;
3153 const char *curext = NULL;
3155 PERL_UNUSED_ARG(search_ext);
3156 # define MAX_EXT_LEN 0
3159 PERL_ARGS_ASSERT_FIND_SCRIPT;
3162 * If dosearch is true and if scriptname does not contain path
3163 * delimiters, search the PATH for scriptname.
3165 * If SEARCH_EXTS is also defined, will look for each
3166 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3167 * while searching the PATH.
3169 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3170 * proceeds as follows:
3171 * If DOSISH or VMSISH:
3172 * + look for ./scriptname{,.foo,.bar}
3173 * + search the PATH for scriptname{,.foo,.bar}
3176 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3177 * this will not look in '.' if it's not in the PATH)
3182 # ifdef ALWAYS_DEFTYPES
3183 len = strlen(scriptname);
3184 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3185 int idx = 0, deftypes = 1;
3188 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3191 int idx = 0, deftypes = 1;
3194 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3196 /* The first time through, just add SEARCH_EXTS to whatever we
3197 * already have, so we can check for default file types. */
3199 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3206 if ((strlen(tmpbuf) + strlen(scriptname)
3207 + MAX_EXT_LEN) >= sizeof tmpbuf)
3208 continue; /* don't search dir with too-long name */
3209 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3213 if (strEQ(scriptname, "-"))
3215 if (dosearch) { /* Look in '.' first. */
3216 const char *cur = scriptname;
3218 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3220 if (strEQ(ext[i++],curext)) {
3221 extidx = -1; /* already has an ext */
3226 DEBUG_p(PerlIO_printf(Perl_debug_log,
3227 "Looking for %s\n",cur));
3230 if (PerlLIO_stat(cur,&statbuf) >= 0
3231 && !S_ISDIR(statbuf.st_mode)) {
3240 if (cur == scriptname) {
3241 len = strlen(scriptname);
3242 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3244 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3247 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3248 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3253 if (dosearch && !strchr(scriptname, '/')
3255 && !strchr(scriptname, '\\')
3257 && (s = PerlEnv_getenv("PATH")))
3261 bufend = s + strlen(s);
3262 while (s < bufend) {
3266 && *s != ';'; len++, s++) {
3267 if (len < sizeof tmpbuf)
3270 if (len < sizeof tmpbuf)
3273 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3278 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3279 continue; /* don't search dir with too-long name */
3282 && tmpbuf[len - 1] != '/'
3283 && tmpbuf[len - 1] != '\\'
3286 tmpbuf[len++] = '/';
3287 if (len == 2 && tmpbuf[0] == '.')
3289 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3293 len = strlen(tmpbuf);
3294 if (extidx > 0) /* reset after previous loop */
3298 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3299 retval = PerlLIO_stat(tmpbuf,&statbuf);
3300 if (S_ISDIR(statbuf.st_mode)) {
3304 } while ( retval < 0 /* not there */
3305 && extidx>=0 && ext[extidx] /* try an extension? */
3306 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3311 if (S_ISREG(statbuf.st_mode)
3312 && cando(S_IRUSR,TRUE,&statbuf)
3313 #if !defined(DOSISH)
3314 && cando(S_IXUSR,TRUE,&statbuf)
3318 xfound = tmpbuf; /* bingo! */
3322 xfailed = savepv(tmpbuf);
3327 if (!xfound && !seen_dot && !xfailed &&
3328 (PerlLIO_stat(scriptname,&statbuf) < 0
3329 || S_ISDIR(statbuf.st_mode)))
3331 seen_dot = 1; /* Disable message. */
3336 if (flags & 1) { /* do or die? */
3337 /* diag_listed_as: Can't execute %s */
3338 Perl_croak(aTHX_ "Can't %s %s%s%s",
3339 (xfailed ? "execute" : "find"),
3340 (xfailed ? xfailed : scriptname),
3341 (xfailed ? "" : " on PATH"),
3342 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3347 scriptname = xfound;
3349 return (scriptname ? savepv(scriptname) : NULL);
3352 #ifndef PERL_GET_CONTEXT_DEFINED
3355 Perl_get_context(void)
3357 #if defined(USE_ITHREADS)
3359 # ifdef OLD_PTHREADS_API
3361 int error = pthread_getspecific(PL_thr_key, &t);
3363 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3365 # elif defined(I_MACH_CTHREADS)
3366 return (void*)cthread_data(cthread_self());
3368 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3376 Perl_set_context(void *t)
3378 #if defined(USE_ITHREADS)
3381 PERL_ARGS_ASSERT_SET_CONTEXT;
3382 #if defined(USE_ITHREADS)
3383 # ifdef I_MACH_CTHREADS
3384 cthread_set_data(cthread_self(), t);
3387 const int error = pthread_setspecific(PL_thr_key, t);
3389 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3397 #endif /* !PERL_GET_CONTEXT_DEFINED */
3399 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3403 PERL_UNUSED_CONTEXT;
3409 Perl_get_op_names(pTHX)
3411 PERL_UNUSED_CONTEXT;
3412 return (char **)PL_op_name;
3416 Perl_get_op_descs(pTHX)
3418 PERL_UNUSED_CONTEXT;
3419 return (char **)PL_op_desc;
3423 Perl_get_no_modify(pTHX)
3425 PERL_UNUSED_CONTEXT;
3426 return PL_no_modify;
3430 Perl_get_opargs(pTHX)
3432 PERL_UNUSED_CONTEXT;
3433 return (U32 *)PL_opargs;
3437 Perl_get_ppaddr(pTHX)
3440 PERL_UNUSED_CONTEXT;
3441 return (PPADDR_t*)PL_ppaddr;
3444 #ifndef HAS_GETENV_LEN
3446 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3448 char * const env_trans = PerlEnv_getenv(env_elem);
3449 PERL_UNUSED_CONTEXT;
3450 PERL_ARGS_ASSERT_GETENV_LEN;
3452 *len = strlen(env_trans);
3459 Perl_get_vtbl(pTHX_ int vtbl_id)
3461 PERL_UNUSED_CONTEXT;
3463 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3464 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3468 Perl_my_fflush_all(pTHX)
3470 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3471 return PerlIO_flush(NULL);
3473 # if defined(HAS__FWALK)
3474 extern int fflush(FILE *);
3475 /* undocumented, unprototyped, but very useful BSDism */
3476 extern void _fwalk(int (*)(FILE *));
3480 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3482 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3483 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3484 # elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3485 open_max = sysconf(_SC_OPEN_MAX);
3486 # elif defined(FOPEN_MAX)
3487 open_max = FOPEN_MAX;
3488 # elif defined(OPEN_MAX)
3489 open_max = OPEN_MAX;
3490 # elif defined(_NFILE)
3495 for (i = 0; i < open_max; i++)
3496 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3497 STDIO_STREAM_ARRAY[i]._file < open_max &&
3498 STDIO_STREAM_ARRAY[i]._flag)
3499 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3503 SETERRNO(EBADF,RMS_IFI);
3510 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3512 if (ckWARN(WARN_IO)) {
3514 = gv && (isGV_with_GP(gv))
3517 const char * const direction = have == '>' ? "out" : "in";
3519 if (name && HEK_LEN(name))
3520 Perl_warner(aTHX_ packWARN(WARN_IO),
3521 "Filehandle %" HEKf " opened only for %sput",
3522 HEKfARG(name), direction);
3524 Perl_warner(aTHX_ packWARN(WARN_IO),
3525 "Filehandle opened only for %sput", direction);
3530 Perl_report_evil_fh(pTHX_ const GV *gv)
3532 const IO *io = gv ? GvIO(gv) : NULL;
3533 const PERL_BITFIELD16 op = PL_op->op_type;
3537 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3539 warn_type = WARN_CLOSED;
3543 warn_type = WARN_UNOPENED;
3546 if (ckWARN(warn_type)) {
3548 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3549 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3550 const char * const pars =
3551 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3552 const char * const func =
3554 (op == OP_READLINE || op == OP_RCATLINE
3555 ? "readline" : /* "<HANDLE>" not nice */
3556 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3558 const char * const type =
3560 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3561 ? "socket" : "filehandle");
3562 const bool have_name = name && SvCUR(name);
3563 Perl_warner(aTHX_ packWARN(warn_type),
3564 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3565 have_name ? " " : "",
3566 SVfARG(have_name ? name : &PL_sv_no));
3567 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3569 aTHX_ packWARN(warn_type),
3570 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3571 func, pars, have_name ? " " : "",
3572 SVfARG(have_name ? name : &PL_sv_no)
3577 /* To workaround core dumps from the uninitialised tm_zone we get the
3578 * system to give us a reasonable struct to copy. This fix means that
3579 * strftime uses the tm_zone and tm_gmtoff values returned by
3580 * localtime(time()). That should give the desired result most of the
3581 * time. But probably not always!
3583 * This does not address tzname aspects of NETaa14816.
3588 # ifndef STRUCT_TM_HASZONE
3589 # define STRUCT_TM_HASZONE
3593 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3594 # ifndef HAS_TM_TM_ZONE
3595 # define HAS_TM_TM_ZONE
3600 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3602 #ifdef HAS_TM_TM_ZONE
3604 const struct tm* my_tm;
3605 PERL_UNUSED_CONTEXT;
3606 PERL_ARGS_ASSERT_INIT_TM;
3608 my_tm = localtime(&now);
3610 Copy(my_tm, ptm, 1, struct tm);
3612 PERL_UNUSED_CONTEXT;
3613 PERL_ARGS_ASSERT_INIT_TM;
3614 PERL_UNUSED_ARG(ptm);
3619 * mini_mktime - normalise struct tm values without the localtime()
3620 * semantics (and overhead) of mktime().
3623 Perl_mini_mktime(struct tm *ptm)
3627 int month, mday, year, jday;
3628 int odd_cent, odd_year;
3630 PERL_ARGS_ASSERT_MINI_MKTIME;
3632 #define DAYS_PER_YEAR 365
3633 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3634 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3635 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3636 #define SECS_PER_HOUR (60*60)
3637 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3638 /* parentheses deliberately absent on these two, otherwise they don't work */
3639 #define MONTH_TO_DAYS 153/5
3640 #define DAYS_TO_MONTH 5/153
3641 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3642 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3643 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3644 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3647 * Year/day algorithm notes:
3649 * With a suitable offset for numeric value of the month, one can find
3650 * an offset into the year by considering months to have 30.6 (153/5) days,
3651 * using integer arithmetic (i.e., with truncation). To avoid too much
3652 * messing about with leap days, we consider January and February to be
3653 * the 13th and 14th month of the previous year. After that transformation,
3654 * we need the month index we use to be high by 1 from 'normal human' usage,
3655 * so the month index values we use run from 4 through 15.
3657 * Given that, and the rules for the Gregorian calendar (leap years are those
3658 * divisible by 4 unless also divisible by 100, when they must be divisible
3659 * by 400 instead), we can simply calculate the number of days since some
3660 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3661 * the days we derive from our month index, and adding in the day of the
3662 * month. The value used here is not adjusted for the actual origin which
3663 * it normally would use (1 January A.D. 1), since we're not exposing it.
3664 * We're only building the value so we can turn around and get the
3665 * normalised values for the year, month, day-of-month, and day-of-year.
3667 * For going backward, we need to bias the value we're using so that we find
3668 * the right year value. (Basically, we don't want the contribution of
3669 * March 1st to the number to apply while deriving the year). Having done
3670 * that, we 'count up' the contribution to the year number by accounting for
3671 * full quadracenturies (400-year periods) with their extra leap days, plus
3672 * the contribution from full centuries (to avoid counting in the lost leap
3673 * days), plus the contribution from full quad-years (to count in the normal
3674 * leap days), plus the leftover contribution from any non-leap years.
3675 * At this point, if we were working with an actual leap day, we'll have 0
3676 * days left over. This is also true for March 1st, however. So, we have
3677 * to special-case that result, and (earlier) keep track of the 'odd'
3678 * century and year contributions. If we got 4 extra centuries in a qcent,
3679 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3680 * Otherwise, we add back in the earlier bias we removed (the 123 from
3681 * figuring in March 1st), find the month index (integer division by 30.6),
3682 * and the remainder is the day-of-month. We then have to convert back to
3683 * 'real' months (including fixing January and February from being 14/15 in
3684 * the previous year to being in the proper year). After that, to get
3685 * tm_yday, we work with the normalised year and get a new yearday value for
3686 * January 1st, which we subtract from the yearday value we had earlier,
3687 * representing the date we've re-built. This is done from January 1
3688 * because tm_yday is 0-origin.
3690 * Since POSIX time routines are only guaranteed to work for times since the
3691 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3692 * applies Gregorian calendar rules even to dates before the 16th century
3693 * doesn't bother me. Besides, you'd need cultural context for a given
3694 * date to know whether it was Julian or Gregorian calendar, and that's
3695 * outside the scope for this routine. Since we convert back based on the
3696 * same rules we used to build the yearday, you'll only get strange results
3697 * for input which needed normalising, or for the 'odd' century years which
3698 * were leap years in the Julian calendar but not in the Gregorian one.
3699 * I can live with that.
3701 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3702 * that's still outside the scope for POSIX time manipulation, so I don't
3708 year = 1900 + ptm->tm_year;
3709 month = ptm->tm_mon;
3710 mday = ptm->tm_mday;
3716 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3717 yearday += month*MONTH_TO_DAYS + mday + jday;
3719 * Note that we don't know when leap-seconds were or will be,
3720 * so we have to trust the user if we get something which looks
3721 * like a sensible leap-second. Wild values for seconds will
3722 * be rationalised, however.
3724 if ((unsigned) ptm->tm_sec <= 60) {
3731 secs += 60 * ptm->tm_min;
3732 secs += SECS_PER_HOUR * ptm->tm_hour;
3734 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3735 /* got negative remainder, but need positive time */
3736 /* back off an extra day to compensate */
3737 yearday += (secs/SECS_PER_DAY)-1;
3738 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3741 yearday += (secs/SECS_PER_DAY);
3742 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3745 else if (secs >= SECS_PER_DAY) {
3746 yearday += (secs/SECS_PER_DAY);
3747 secs %= SECS_PER_DAY;
3749 ptm->tm_hour = secs/SECS_PER_HOUR;
3750 secs %= SECS_PER_HOUR;
3751 ptm->tm_min = secs/60;
3753 ptm->tm_sec += secs;
3754 /* done with time of day effects */
3756 * The algorithm for yearday has (so far) left it high by 428.
3757 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3758 * bias it by 123 while trying to figure out what year it
3759 * really represents. Even with this tweak, the reverse
3760 * translation fails for years before A.D. 0001.
3761 * It would still fail for Feb 29, but we catch that one below.
3763 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3764 yearday -= YEAR_ADJUST;
3765 year = (yearday / DAYS_PER_QCENT) * 400;
3766 yearday %= DAYS_PER_QCENT;
3767 odd_cent = yearday / DAYS_PER_CENT;
3768 year += odd_cent * 100;
3769 yearday %= DAYS_PER_CENT;
3770 year += (yearday / DAYS_PER_QYEAR) * 4;
3771 yearday %= DAYS_PER_QYEAR;
3772 odd_year = yearday / DAYS_PER_YEAR;
3774 yearday %= DAYS_PER_YEAR;
3775 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3780 yearday += YEAR_ADJUST; /* recover March 1st crock */
3781 month = yearday*DAYS_TO_MONTH;
3782 yearday -= month*MONTH_TO_DAYS;
3783 /* recover other leap-year adjustment */
3792 ptm->tm_year = year - 1900;
3794 ptm->tm_mday = yearday;
3795 ptm->tm_mon = month;
3799 ptm->tm_mon = month - 1;
3801 /* re-build yearday based on Jan 1 to get tm_yday */
3803 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3804 yearday += 14*MONTH_TO_DAYS + 1;
3805 ptm->tm_yday = jday - yearday;
3806 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3810 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)
3814 /* strftime(), but with a different API so that the return value is a pointer
3815 * to the formatted result (which MUST be arranged to be FREED BY THE
3816 * CALLER). This allows this function to increase the buffer size as needed,
3817 * so that the caller doesn't have to worry about that.
3819 * Note that yday and wday effectively are ignored by this function, as
3820 * mini_mktime() overwrites them */
3827 PERL_ARGS_ASSERT_MY_STRFTIME;
3829 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3832 mytm.tm_hour = hour;
3833 mytm.tm_mday = mday;
3835 mytm.tm_year = year;
3836 mytm.tm_wday = wday;
3837 mytm.tm_yday = yday;
3838 mytm.tm_isdst = isdst;
3840 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3841 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3846 #ifdef HAS_TM_TM_GMTOFF
3847 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3849 #ifdef HAS_TM_TM_ZONE
3850 mytm.tm_zone = mytm2.tm_zone;
3855 Newx(buf, buflen, char);
3857 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3858 len = strftime(buf, buflen, fmt, &mytm);
3859 GCC_DIAG_RESTORE_STMT;
3862 ** The following is needed to handle to the situation where
3863 ** tmpbuf overflows. Basically we want to allocate a buffer
3864 ** and try repeatedly. The reason why it is so complicated
3865 ** is that getting a return value of 0 from strftime can indicate
3866 ** one of the following:
3867 ** 1. buffer overflowed,
3868 ** 2. illegal conversion specifier, or
3869 ** 3. the format string specifies nothing to be returned(not
3870 ** an error). This could be because format is an empty string
3871 ** or it specifies %p that yields an empty string in some locale.
3872 ** If there is a better way to make it portable, go ahead by
3875 if (inRANGE(len, 1, buflen - 1) || (len == 0 && *fmt == '\0'))
3878 /* Possibly buf overflowed - try again with a bigger buf */
3879 const int fmtlen = strlen(fmt);
3880 int bufsize = fmtlen + buflen;
3882 Renew(buf, bufsize, char);
3885 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
3886 buflen = strftime(buf, bufsize, fmt, &mytm);
3887 GCC_DIAG_RESTORE_STMT;
3889 if (inRANGE(buflen, 1, bufsize - 1))
3891 /* heuristic to prevent out-of-memory errors */
3892 if (bufsize > 100*fmtlen) {
3898 Renew(buf, bufsize, char);
3903 Perl_croak(aTHX_ "panic: no strftime");
3909 #define SV_CWD_RETURN_UNDEF \
3913 #define SV_CWD_ISDOT(dp) \
3914 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
3915 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
3918 =head1 Miscellaneous Functions
3920 =for apidoc getcwd_sv
3922 Fill C<sv> with current working directory
3927 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
3928 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
3929 * getcwd(3) if available
3930 * Comments from the original:
3931 * This is a faster version of getcwd. It's also more dangerous
3932 * because you might chdir out of a directory that you can't chdir
3936 Perl_getcwd_sv(pTHX_ SV *sv)
3941 PERL_ARGS_ASSERT_GETCWD_SV;
3945 char buf[MAXPATHLEN];
3947 /* Some getcwd()s automatically allocate a buffer of the given
3948 * size from the heap if they are given a NULL buffer pointer.
3949 * The problem is that this behaviour is not portable. */
3950 if (getcwd(buf, sizeof(buf) - 1)) {
3955 SV_CWD_RETURN_UNDEF;
3962 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
3966 SvUPGRADE(sv, SVt_PV);
3968 if (PerlLIO_lstat(".", &statbuf) < 0) {
3969 SV_CWD_RETURN_UNDEF;
3972 orig_cdev = statbuf.st_dev;
3973 orig_cino = statbuf.st_ino;
3983 if (PerlDir_chdir("..") < 0) {
3984 SV_CWD_RETURN_UNDEF;
3986 if (PerlLIO_stat(".", &statbuf) < 0) {
3987 SV_CWD_RETURN_UNDEF;
3990 cdev = statbuf.st_dev;
3991 cino = statbuf.st_ino;
3993 if (odev == cdev && oino == cino) {
3996 if (!(dir = PerlDir_open("."))) {
3997 SV_CWD_RETURN_UNDEF;
4000 while ((dp = PerlDir_read(dir)) != NULL) {
4002 namelen = dp->d_namlen;
4004 namelen = strlen(dp->d_name);
4007 if (SV_CWD_ISDOT(dp)) {
4011 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4012 SV_CWD_RETURN_UNDEF;
4015 tdev = statbuf.st_dev;
4016 tino = statbuf.st_ino;
4017 if (tino == oino && tdev == odev) {
4023 SV_CWD_RETURN_UNDEF;
4026 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4027 SV_CWD_RETURN_UNDEF;
4030 SvGROW(sv, pathlen + namelen + 1);
4034 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4037 /* prepend current directory to the front */
4039 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4040 pathlen += (namelen + 1);
4042 #ifdef VOID_CLOSEDIR
4045 if (PerlDir_close(dir) < 0) {
4046 SV_CWD_RETURN_UNDEF;
4052 SvCUR_set(sv, pathlen);
4056 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4057 SV_CWD_RETURN_UNDEF;
4060 if (PerlLIO_stat(".", &statbuf) < 0) {
4061 SV_CWD_RETURN_UNDEF;
4064 cdev = statbuf.st_dev;
4065 cino = statbuf.st_ino;
4067 if (cdev != orig_cdev || cino != orig_cino) {
4068 Perl_croak(aTHX_ "Unstable directory path, "
4069 "current directory changed unexpectedly");
4082 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4083 # define EMULATE_SOCKETPAIR_UDP
4086 #ifdef EMULATE_SOCKETPAIR_UDP
4088 S_socketpair_udp (int fd[2]) {
4090 /* Fake a datagram socketpair using UDP to localhost. */
4091 int sockets[2] = {-1, -1};
4092 struct sockaddr_in addresses[2];
4094 Sock_size_t size = sizeof(struct sockaddr_in);
4095 unsigned short port;
4098 memset(&addresses, 0, sizeof(addresses));
4101 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4102 if (sockets[i] == -1)
4103 goto tidy_up_and_fail;
4105 addresses[i].sin_family = AF_INET;
4106 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4107 addresses[i].sin_port = 0; /* kernel choses port. */
4108 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4109 sizeof(struct sockaddr_in)) == -1)
4110 goto tidy_up_and_fail;
4113 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4114 for each connect the other socket to it. */
4117 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4119 goto tidy_up_and_fail;
4120 if (size != sizeof(struct sockaddr_in))
4121 goto abort_tidy_up_and_fail;
4122 /* !1 is 0, !0 is 1 */
4123 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4124 sizeof(struct sockaddr_in)) == -1)
4125 goto tidy_up_and_fail;
4128 /* Now we have 2 sockets connected to each other. I don't trust some other
4129 process not to have already sent a packet to us (by random) so send
4130 a packet from each to the other. */
4133 /* I'm going to send my own port number. As a short.
4134 (Who knows if someone somewhere has sin_port as a bitfield and needs
4135 this routine. (I'm assuming crays have socketpair)) */
4136 port = addresses[i].sin_port;
4137 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4138 if (got != sizeof(port)) {
4140 goto tidy_up_and_fail;
4141 goto abort_tidy_up_and_fail;
4145 /* Packets sent. I don't trust them to have arrived though.
4146 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4147 connect to localhost will use a second kernel thread. In 2.6 the
4148 first thread running the connect() returns before the second completes,
4149 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4150 returns 0. Poor programs have tripped up. One poor program's authors'
4151 had a 50-1 reverse stock split. Not sure how connected these were.)
4152 So I don't trust someone not to have an unpredictable UDP stack.
4156 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4157 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4161 FD_SET((unsigned int)sockets[0], &rset);
4162 FD_SET((unsigned int)sockets[1], &rset);
4164 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4165 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4166 || !FD_ISSET(sockets[1], &rset)) {
4167 /* I hope this is portable and appropriate. */
4169 goto tidy_up_and_fail;
4170 goto abort_tidy_up_and_fail;
4174 /* And the paranoia department even now doesn't trust it to have arrive
4175 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4177 struct sockaddr_in readfrom;
4178 unsigned short buffer[2];
4183 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4184 sizeof(buffer), MSG_DONTWAIT,
4185 (struct sockaddr *) &readfrom, &size);
4187 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4189 (struct sockaddr *) &readfrom, &size);
4193 goto tidy_up_and_fail;
4194 if (got != sizeof(port)
4195 || size != sizeof(struct sockaddr_in)
4196 /* Check other socket sent us its port. */
4197 || buffer[0] != (unsigned short) addresses[!i].sin_port
4198 /* Check kernel says we got the datagram from that socket */
4199 || readfrom.sin_family != addresses[!i].sin_family
4200 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4201 || readfrom.sin_port != addresses[!i].sin_port)
4202 goto abort_tidy_up_and_fail;
4205 /* My caller (my_socketpair) has validated that this is non-NULL */
4208 /* I hereby declare this connection open. May God bless all who cross
4212 abort_tidy_up_and_fail:
4213 errno = ECONNABORTED;
4217 if (sockets[0] != -1)
4218 PerlLIO_close(sockets[0]);
4219 if (sockets[1] != -1)
4220 PerlLIO_close(sockets[1]);
4225 #endif /* EMULATE_SOCKETPAIR_UDP */
4227 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4229 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4230 /* Stevens says that family must be AF_LOCAL, protocol 0.
4231 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4236 struct sockaddr_in listen_addr;
4237 struct sockaddr_in connect_addr;
4242 || family != AF_UNIX
4245 errno = EAFNOSUPPORT;
4254 type &= ~SOCK_CLOEXEC;
4257 #ifdef EMULATE_SOCKETPAIR_UDP
4258 if (type == SOCK_DGRAM)
4259 return S_socketpair_udp(fd);
4262 aTHXa(PERL_GET_THX);
4263 listener = PerlSock_socket(AF_INET, type, 0);
4266 memset(&listen_addr, 0, sizeof(listen_addr));
4267 listen_addr.sin_family = AF_INET;
4268 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4269 listen_addr.sin_port = 0; /* kernel choses port. */
4270 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4271 sizeof(listen_addr)) == -1)
4272 goto tidy_up_and_fail;
4273 if (PerlSock_listen(listener, 1) == -1)
4274 goto tidy_up_and_fail;
4276 connector = PerlSock_socket(AF_INET, type, 0);
4277 if (connector == -1)
4278 goto tidy_up_and_fail;
4279 /* We want to find out the port number to connect to. */
4280 size = sizeof(connect_addr);
4281 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4283 goto tidy_up_and_fail;
4284 if (size != sizeof(connect_addr))
4285 goto abort_tidy_up_and_fail;
4286 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4287 sizeof(connect_addr)) == -1)
4288 goto tidy_up_and_fail;
4290 size = sizeof(listen_addr);
4291 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4294 goto tidy_up_and_fail;
4295 if (size != sizeof(listen_addr))
4296 goto abort_tidy_up_and_fail;
4297 PerlLIO_close(listener);
4298 /* Now check we are talking to ourself by matching port and host on the
4300 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4302 goto tidy_up_and_fail;
4303 if (size != sizeof(connect_addr)
4304 || listen_addr.sin_family != connect_addr.sin_family
4305 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4306 || listen_addr.sin_port != connect_addr.sin_port) {
4307 goto abort_tidy_up_and_fail;
4313 abort_tidy_up_and_fail:
4315 errno = ECONNABORTED; /* This would be the standard thing to do. */
4316 #elif defined(ECONNREFUSED)
4317 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4319 errno = ETIMEDOUT; /* Desperation time. */
4325 PerlLIO_close(listener);
4326 if (connector != -1)
4327 PerlLIO_close(connector);
4329 PerlLIO_close(acceptor);
4335 /* In any case have a stub so that there's code corresponding
4336 * to the my_socketpair in embed.fnc. */
4338 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4339 #ifdef HAS_SOCKETPAIR
4340 return socketpair(family, type, protocol, fd);
4349 =for apidoc sv_nosharing
4351 Dummy routine which "shares" an SV when there is no sharing module present.
4352 Or "locks" it. Or "unlocks" it. In other
4353 words, ignores its single SV argument.
4354 Exists to avoid test for a C<NULL> function pointer and because it could
4355 potentially warn under some level of strict-ness.
4361 Perl_sv_nosharing(pTHX_ SV *sv)
4363 PERL_UNUSED_CONTEXT;
4364 PERL_UNUSED_ARG(sv);
4369 =for apidoc sv_destroyable
4371 Dummy routine which reports that object can be destroyed when there is no
4372 sharing module present. It ignores its single SV argument, and returns
4373 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4374 could potentially warn under some level of strict-ness.
4380 Perl_sv_destroyable(pTHX_ SV *sv)
4382 PERL_UNUSED_CONTEXT;
4383 PERL_UNUSED_ARG(sv);
4388 Perl_parse_unicode_opts(pTHX_ const char **popt)
4390 const char *p = *popt;
4393 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4397 const char* endptr = p + strlen(p);
4399 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4402 if (p && *p && *p != '\n' && *p != '\r') {
4404 goto the_end_of_the_opts_parser;
4406 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4410 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4416 case PERL_UNICODE_STDIN:
4417 opt |= PERL_UNICODE_STDIN_FLAG; break;
4418 case PERL_UNICODE_STDOUT:
4419 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4420 case PERL_UNICODE_STDERR:
4421 opt |= PERL_UNICODE_STDERR_FLAG; break;
4422 case PERL_UNICODE_STD:
4423 opt |= PERL_UNICODE_STD_FLAG; break;
4424 case PERL_UNICODE_IN:
4425 opt |= PERL_UNICODE_IN_FLAG; break;
4426 case PERL_UNICODE_OUT:
4427 opt |= PERL_UNICODE_OUT_FLAG; break;
4428 case PERL_UNICODE_INOUT:
4429 opt |= PERL_UNICODE_INOUT_FLAG; break;
4430 case PERL_UNICODE_LOCALE:
4431 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4432 case PERL_UNICODE_ARGV:
4433 opt |= PERL_UNICODE_ARGV_FLAG; break;
4434 case PERL_UNICODE_UTF8CACHEASSERT:
4435 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4437 if (*p != '\n' && *p != '\r') {
4438 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4441 "Unknown Unicode option letter '%c'", *p);
4448 opt = PERL_UNICODE_DEFAULT_FLAGS;
4450 the_end_of_the_opts_parser:
4452 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4453 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4454 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4462 # include <starlet.h>
4469 * This is really just a quick hack which grabs various garbage
4470 * values. It really should be a real hash algorithm which
4471 * spreads the effect of every input bit onto every output bit,
4472 * if someone who knows about such things would bother to write it.
4473 * Might be a good idea to add that function to CORE as well.
4474 * No numbers below come from careful analysis or anything here,
4475 * except they are primes and SEED_C1 > 1E6 to get a full-width
4476 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4477 * probably be bigger too.
4480 # define SEED_C1 1000003
4481 #define SEED_C4 73819
4483 # define SEED_C1 25747
4484 #define SEED_C4 20639
4488 #define SEED_C5 26107
4490 #ifndef PERL_NO_DEV_RANDOM
4494 #ifdef HAS_GETTIMEOFDAY
4495 struct timeval when;
4500 /* This test is an escape hatch, this symbol isn't set by Configure. */
4501 #ifndef PERL_NO_DEV_RANDOM
4502 #ifndef PERL_RANDOM_DEVICE
4503 /* /dev/random isn't used by default because reads from it will block
4504 * if there isn't enough entropy available. You can compile with
4505 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4506 * is enough real entropy to fill the seed. */
4507 # ifdef __amigaos4__
4508 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4510 # define PERL_RANDOM_DEVICE "/dev/urandom"
4513 fd = PerlLIO_open_cloexec(PERL_RANDOM_DEVICE, 0);
4515 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4523 #ifdef HAS_GETTIMEOFDAY
4524 PerlProc_gettimeofday(&when,NULL);
4525 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4528 u = (U32)SEED_C1 * when;
4530 u += SEED_C3 * (U32)PerlProc_getpid();
4531 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4532 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4533 u += SEED_C5 * (U32)PTR2UV(&when);
4539 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4541 #ifndef NO_PERL_HASH_ENV
4546 PERL_ARGS_ASSERT_GET_HASH_SEED;
4548 #ifndef NO_PERL_HASH_ENV
4549 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4553 /* ignore leading spaces */
4554 while (isSPACE(*env_pv))
4556 # ifdef USE_PERL_PERTURB_KEYS
4557 /* if they set it to "0" we disable key traversal randomization completely */
4558 if (strEQ(env_pv,"0")) {
4559 PL_hash_rand_bits_enabled= 0;
4561 /* otherwise switch to deterministic mode */
4562 PL_hash_rand_bits_enabled= 2;
4565 /* ignore a leading 0x... if it is there */
4566 if (env_pv[0] == '0' && env_pv[1] == 'x')
4569 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4570 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4571 if ( isXDIGIT(*env_pv)) {
4572 seed_buffer[i] |= READ_XDIGIT(env_pv);
4575 while (isSPACE(*env_pv))
4578 if (*env_pv && !isXDIGIT(*env_pv)) {
4579 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4581 /* should we check for unparsed crap? */
4582 /* should we warn about unused hex? */
4583 /* should we warn about insufficient hex? */
4586 #endif /* NO_PERL_HASH_ENV */
4588 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4589 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
4592 #ifdef USE_PERL_PERTURB_KEYS
4593 { /* initialize PL_hash_rand_bits from the hash seed.
4594 * This value is highly volatile, it is updated every
4595 * hash insert, and is used as part of hash bucket chain
4596 * randomization and hash iterator randomization. */
4597 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4598 for( i = 0; i < sizeof(UV) ; i++ ) {
4599 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4600 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4603 # ifndef NO_PERL_HASH_ENV
4604 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4606 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4607 PL_hash_rand_bits_enabled= 0;
4608 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4609 PL_hash_rand_bits_enabled= 1;
4610 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4611 PL_hash_rand_bits_enabled= 2;
4613 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4620 #ifdef PERL_GLOBAL_STRUCT
4622 #define PERL_GLOBAL_STRUCT_INIT
4623 #include "opcode.h" /* the ppaddr and check */
4626 Perl_init_global_struct(pTHX)
4628 struct perl_vars *plvarsp = NULL;
4629 # ifdef PERL_GLOBAL_STRUCT
4630 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4631 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4632 PERL_UNUSED_CONTEXT;
4633 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4634 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4635 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4639 plvarsp = PL_VarsPtr;
4640 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4645 # define PERLVAR(prefix,var,type) /**/
4646 # define PERLVARA(prefix,var,n,type) /**/
4647 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4648 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4649 # include "perlvars.h"
4654 # ifdef PERL_GLOBAL_STRUCT
4657 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4658 if (!plvarsp->Gppaddr)
4662 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4663 if (!plvarsp->Gcheck)
4665 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4666 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4668 # ifdef PERL_SET_VARS
4669 PERL_SET_VARS(plvarsp);
4671 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4672 plvarsp->Gsv_placeholder.sv_flags = 0;
4673 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4675 # undef PERL_GLOBAL_STRUCT_INIT
4680 #endif /* PERL_GLOBAL_STRUCT */
4682 #ifdef PERL_GLOBAL_STRUCT
4685 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4687 int veto = plvarsp->Gveto_cleanup;
4689 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4690 PERL_UNUSED_CONTEXT;
4691 # ifdef PERL_GLOBAL_STRUCT
4692 # ifdef PERL_UNSET_VARS
4693 PERL_UNSET_VARS(plvarsp);
4697 free(plvarsp->Gppaddr);
4698 free(plvarsp->Gcheck);
4699 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4705 #endif /* PERL_GLOBAL_STRUCT */
4709 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4710 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4711 * given, and you supply your own implementation.
4713 * The default implementation reads a single env var, PERL_MEM_LOG,
4714 * expecting one or more of the following:
4716 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4717 * 'm' - memlog was PERL_MEM_LOG=1
4718 * 's' - svlog was PERL_SV_LOG=1
4719 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4721 * This makes the logger controllable enough that it can reasonably be
4722 * added to the system perl.
4725 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4726 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4728 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4730 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4731 * writes to. In the default logger, this is settable at runtime.
4733 #ifndef PERL_MEM_LOG_FD
4734 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4737 #ifndef PERL_MEM_LOG_NOIMPL
4739 # ifdef DEBUG_LEAKING_SCALARS
4740 # define SV_LOG_SERIAL_FMT " [%lu]"
4741 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4743 # define SV_LOG_SERIAL_FMT
4744 # define _SV_LOG_SERIAL_ARG(sv)
4748 S_mem_log_common(enum mem_log_type mlt, const UV n,
4749 const UV typesize, const char *type_name, const SV *sv,
4750 Malloc_t oldalloc, Malloc_t newalloc,
4751 const char *filename, const int linenumber,
4752 const char *funcname)
4756 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4758 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4761 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4763 /* We can't use SVs or PerlIO for obvious reasons,
4764 * so we'll use stdio and low-level IO instead. */
4765 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4767 # ifdef HAS_GETTIMEOFDAY
4768 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4769 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4771 gettimeofday(&tv, 0);
4773 # define MEM_LOG_TIME_FMT "%10d: "
4774 # define MEM_LOG_TIME_ARG (int)when
4778 /* If there are other OS specific ways of hires time than
4779 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4780 * probably that they would be used to fill in the struct
4784 const char* endptr = pmlenv + strlen(pmlenv);
4787 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4788 && uv && uv <= PERL_INT_MAX
4792 fd = PERL_MEM_LOG_FD;
4795 if (strchr(pmlenv, 't')) {
4796 len = my_snprintf(buf, sizeof(buf),
4797 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4798 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4802 len = my_snprintf(buf, sizeof(buf),
4803 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4804 " %s = %" IVdf ": %" UVxf "\n",
4805 filename, linenumber, funcname, n, typesize,
4806 type_name, n * typesize, PTR2UV(newalloc));
4809 len = my_snprintf(buf, sizeof(buf),
4810 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4811 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4812 filename, linenumber, funcname, n, typesize,
4813 type_name, n * typesize, PTR2UV(oldalloc),
4817 len = my_snprintf(buf, sizeof(buf),
4818 "free: %s:%d:%s: %" UVxf "\n",
4819 filename, linenumber, funcname,
4824 len = my_snprintf(buf, sizeof(buf),
4825 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
4826 mlt == MLT_NEW_SV ? "new" : "del",
4827 filename, linenumber, funcname,
4828 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4833 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4837 #endif /* !PERL_MEM_LOG_NOIMPL */
4839 #ifndef PERL_MEM_LOG_NOIMPL
4841 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4842 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4844 /* this is suboptimal, but bug compatible. User is providing their
4845 own implementation, but is getting these functions anyway, and they
4846 do nothing. But _NOIMPL users should be able to cope or fix */
4848 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4849 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
4853 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4855 const char *filename, const int linenumber,
4856 const char *funcname)
4858 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
4860 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4861 NULL, NULL, newalloc,
4862 filename, linenumber, funcname);
4867 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4868 Malloc_t oldalloc, Malloc_t newalloc,
4869 const char *filename, const int linenumber,
4870 const char *funcname)
4872 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
4874 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4875 NULL, oldalloc, newalloc,
4876 filename, linenumber, funcname);
4881 Perl_mem_log_free(Malloc_t oldalloc,
4882 const char *filename, const int linenumber,
4883 const char *funcname)
4885 PERL_ARGS_ASSERT_MEM_LOG_FREE;
4887 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4888 filename, linenumber, funcname);
4893 Perl_mem_log_new_sv(const SV *sv,
4894 const char *filename, const int linenumber,
4895 const char *funcname)
4897 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4898 filename, linenumber, funcname);
4902 Perl_mem_log_del_sv(const SV *sv,
4903 const char *filename, const int linenumber,
4904 const char *funcname)
4906 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4907 filename, linenumber, funcname);
4910 #endif /* PERL_MEM_LOG */
4913 =for apidoc quadmath_format_valid
4915 C<quadmath_snprintf()> is very strict about its C<format> string and will
4916 fail, returning -1, if the format is invalid. It accepts exactly
4919 C<quadmath_format_valid()> checks that the intended single spec looks
4920 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
4921 and has C<Q> before it. This is not a full "printf syntax check",
4924 Returns true if it is valid, false if not.
4926 See also L</quadmath_format_needed>.
4932 Perl_quadmath_format_valid(const char* format)
4936 PERL_ARGS_ASSERT_QUADMATH_FORMAT_VALID;
4938 if (format[0] != '%' || strchr(format + 1, '%'))
4940 len = strlen(format);
4941 /* minimum length three: %Qg */
4942 if (len < 3 || memCHRs("efgaEFGA", format[len - 1]) == NULL)
4944 if (format[len - 2] != 'Q')
4951 =for apidoc quadmath_format_needed
4953 C<quadmath_format_needed()> returns true if the C<format> string seems to
4954 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
4955 or returns false otherwise.
4957 The format specifier detection is not complete printf-syntax detection,
4958 but it should catch most common cases.
4960 If true is returned, those arguments B<should> in theory be processed
4961 with C<quadmath_snprintf()>, but in case there is more than one such
4962 format specifier (see L</quadmath_format_valid>), and if there is
4963 anything else beyond that one (even just a single byte), they
4964 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
4965 accepting only one format spec, and nothing else.
4966 In this case, the code should probably fail.
4972 Perl_quadmath_format_needed(const char* format)
4974 const char *p = format;
4977 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
4979 while ((q = strchr(p, '%'))) {
4981 if (*q == '+') /* plus */
4983 if (*q == '#') /* alt */
4985 if (*q == '*') /* width */
4989 while (isDIGIT(*q)) q++;
4992 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
4997 while (isDIGIT(*q)) q++;
4999 if (memCHRs("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5008 =for apidoc my_snprintf
5010 The C library C<snprintf> functionality, if available and
5011 standards-compliant (uses C<vsnprintf>, actually). However, if the
5012 C<vsnprintf> is not available, will unfortunately use the unsafe
5013 C<vsprintf> which can overrun the buffer (there is an overrun check,
5014 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5015 getting C<vsnprintf>.
5020 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5024 PERL_ARGS_ASSERT_MY_SNPRINTF;
5025 #ifndef HAS_VSNPRINTF
5026 PERL_UNUSED_VAR(len);
5028 va_start(ap, format);
5031 bool quadmath_valid = FALSE;
5032 if (quadmath_format_valid(format)) {
5033 /* If the format looked promising, use it as quadmath. */
5034 retval = quadmath_snprintf(buffer, len, format, va_arg(ap, NV));
5036 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5038 quadmath_valid = TRUE;
5040 /* quadmath_format_single() will return false for example for
5041 * "foo = %g", or simply "%g". We could handle the %g by
5042 * using quadmath for the NV args. More complex cases of
5043 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5044 * quadmath-valid but has stuff in front).
5046 * Handling the "Q-less" cases right would require walking
5047 * through the va_list and rewriting the format, calling
5048 * quadmath for the NVs, building a new va_list, and then
5049 * letting vsnprintf/vsprintf to take care of the other
5050 * arguments. This may be doable.
5052 * We do not attempt that now. But for paranoia, we here try
5053 * to detect some common (but not all) cases where the
5054 * "Q-less" %[efgaEFGA] formats are present, and die if
5055 * detected. This doesn't fix the problem, but it stops the
5056 * vsnprintf/vsprintf pulling doubles off the va_list when
5057 * __float128 NVs should be pulled off instead.
5059 * If quadmath_format_needed() returns false, we are reasonably
5060 * certain that we can call vnsprintf() or vsprintf() safely. */
5061 if (!quadmath_valid && quadmath_format_needed(format))
5062 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5067 #ifdef HAS_VSNPRINTF
5068 retval = vsnprintf(buffer, len, format, ap);
5070 retval = vsprintf(buffer, format, ap);
5073 /* vsprintf() shows failure with < 0 */
5075 #ifdef HAS_VSNPRINTF
5076 /* vsnprintf() shows failure with >= len */
5078 (len > 0 && (Size_t)retval >= len)
5081 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5086 =for apidoc my_vsnprintf
5088 The C library C<vsnprintf> if available and standards-compliant.
5089 However, if if the C<vsnprintf> is not available, will unfortunately
5090 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5091 overrun check, but that may be too late). Consider using
5092 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5097 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5100 PERL_UNUSED_ARG(buffer);
5101 PERL_UNUSED_ARG(len);
5102 PERL_UNUSED_ARG(format);
5103 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5104 PERL_UNUSED_ARG((void*)ap);
5105 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5112 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5113 Perl_va_copy(ap, apc);
5114 # ifdef HAS_VSNPRINTF
5115 retval = vsnprintf(buffer, len, format, apc);
5117 PERL_UNUSED_ARG(len);
5118 retval = vsprintf(buffer, format, apc);
5122 # ifdef HAS_VSNPRINTF
5123 retval = vsnprintf(buffer, len, format, ap);
5125 PERL_UNUSED_ARG(len);
5126 retval = vsprintf(buffer, format, ap);
5128 #endif /* #ifdef NEED_VA_COPY */
5129 /* vsprintf() shows failure with < 0 */
5131 #ifdef HAS_VSNPRINTF
5132 /* vsnprintf() shows failure with >= len */
5134 (len > 0 && (Size_t)retval >= len)
5137 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5143 Perl_my_clearenv(pTHX)
5146 #if ! defined(PERL_MICRO)
5147 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5149 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5150 # if defined(USE_ENVIRON_ARRAY)
5151 # if defined(USE_ITHREADS)
5152 /* only the parent thread can clobber the process environment */
5153 if (PL_curinterp == aTHX)
5154 # endif /* USE_ITHREADS */
5156 # if ! defined(PERL_USE_SAFE_PUTENV)
5157 if ( !PL_use_safe_putenv) {
5159 if (environ == PL_origenviron)
5160 environ = (char**)safesysmalloc(sizeof(char*));
5162 for (i = 0; environ[i]; i++)
5163 (void)safesysfree(environ[i]);
5166 # else /* PERL_USE_SAFE_PUTENV */
5167 # if defined(HAS_CLEARENV)
5169 # elif defined(HAS_UNSETENV)
5170 int bsiz = 80; /* Most envvar names will be shorter than this. */
5171 char *buf = (char*)safesysmalloc(bsiz);
5172 while (*environ != NULL) {
5173 char *e = strchr(*environ, '=');
5174 int l = e ? e - *environ : (int)strlen(*environ);
5176 (void)safesysfree(buf);
5177 bsiz = l + 1; /* + 1 for the \0. */
5178 buf = (char*)safesysmalloc(bsiz);
5180 memcpy(buf, *environ, l);
5182 (void)unsetenv(buf);
5184 (void)safesysfree(buf);
5185 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5186 /* Just null environ and accept the leakage. */
5188 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5189 # endif /* ! PERL_USE_SAFE_PUTENV */
5191 # endif /* USE_ENVIRON_ARRAY */
5192 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5193 #endif /* PERL_MICRO */
5196 #ifdef PERL_IMPLICIT_CONTEXT
5199 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5201 /* rather than each module having a static var holding its index,
5202 * use a global array of name to index mappings
5205 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5210 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5212 for (index = 0; index < PL_my_cxt_index; index++) {
5213 const char *key = PL_my_cxt_keys[index];
5214 /* try direct pointer compare first - there are chances to success,
5215 * and it's much faster.
5217 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5225 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5226 the global PL_my_cxt_index is incremented, and that value is assigned to
5227 that module's static my_cxt_index (who's address is passed as an arg).
5228 Then, for each interpreter this function is called for, it makes sure a
5229 void* slot is available to hang the static data off, by allocating or
5230 extending the interpreter's PL_my_cxt_list array */
5233 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5234 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5236 Perl_my_cxt_init(pTHX_ int *indexp, size_t size)
5243 PERL_ARGS_ASSERT_MY_CXT_INIT;
5245 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5246 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5250 /* do initial check without locking.
5251 * -1: not allocated or another thread currently allocating
5252 * other: already allocated by another thread
5255 MUTEX_LOCK(&PL_my_ctx_mutex);
5256 /*now a stricter check with locking */
5257 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5258 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5263 /* this module hasn't been allocated an index yet */
5264 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5265 index = PL_my_cxt_index++;
5267 /* Store the index in a global MY_CXT_KEY string to index mapping
5268 * table. This emulates the perl-module static my_cxt_index var on
5269 * builds which don't allow static vars */
5270 if (PL_my_cxt_keys_size <= index) {
5271 int old_size = PL_my_cxt_keys_size;
5273 if (PL_my_cxt_keys_size) {
5274 IV new_size = PL_my_cxt_keys_size;
5275 while (new_size <= index)
5277 PL_my_cxt_keys = (const char **)PerlMemShared_realloc(
5279 new_size * sizeof(const char *));
5280 PL_my_cxt_keys_size = new_size;
5283 PL_my_cxt_keys_size = 16;
5284 PL_my_cxt_keys = (const char **)PerlMemShared_malloc(
5285 PL_my_cxt_keys_size * sizeof(const char *));
5287 for (i = old_size; i < PL_my_cxt_keys_size; i++) {
5288 PL_my_cxt_keys[i] = 0;
5291 PL_my_cxt_keys[index] = my_cxt_key;
5293 *indexp = PL_my_cxt_index++;
5296 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5299 /* make sure the array is big enough */
5300 if (PL_my_cxt_size <= index) {
5301 if (PL_my_cxt_size) {
5302 IV new_size = PL_my_cxt_size;
5303 while (new_size <= index)
5305 Renew(PL_my_cxt_list, new_size, void *);
5306 PL_my_cxt_size = new_size;
5309 PL_my_cxt_size = 16;
5310 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5313 /* newSV() allocates one more than needed */
5314 p = (void*)SvPVX(newSV(size-1));
5315 PL_my_cxt_list[index] = p;
5316 Zero(p, size, char);
5320 #endif /* PERL_IMPLICIT_CONTEXT */
5323 /* Perl_xs_handshake():
5324 implement the various XS_*_BOOTCHECK macros, which are added to .c
5325 files by ExtUtils::ParseXS, to check that the perl the module was built
5326 with is binary compatible with the running perl.
5329 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5330 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5332 The meaning of the varargs is determined the U32 key arg (which is not
5333 a format string). The fields of key are assembled by using HS_KEY().
5335 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5336 "PerlInterpreter *" and represents the callers context; otherwise it is
5337 of type "CV *", and is the boot xsub's CV.
5339 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5340 for example, and IO.dll was linked with threaded perl524.dll, and both
5341 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5342 successfully can load IO.dll into the process but simultaneously it
5343 loaded an interpreter of a different version into the process, and XS
5344 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5345 use through perl526.dll's my_perl->Istack_base.
5347 v_my_perl cannot be the first arg, since then 'key' will be out of
5348 place in a threaded vs non-threaded mixup; and analyzing the key
5349 number's bitfields won't reveal the problem, since it will be a valid
5350 key (unthreaded perl) on interp side, but croak will report the XS mod's
5351 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5352 it's a threaded perl and an unthreaded XS module, threaded perl will
5353 look at an uninit C stack or an uninit register to get 'key'
5354 (remember that it assumes that the 1st arg is the interp cxt).
5356 'file' is the source filename of the caller.
5360 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5366 #ifdef PERL_IMPLICIT_CONTEXT
5373 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5374 va_start(args, file);
5376 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5377 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5378 if (UNLIKELY(got != need))
5380 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5381 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5382 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5383 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5384 passed to the XS DLL */
5385 #ifdef PERL_IMPLICIT_CONTEXT
5386 xs_interp = (tTHX)v_my_perl;
5390 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5391 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5392 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5393 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5394 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5395 location in the unthreaded perl binary) stored in CV * to figure out if this
5396 Perl_xs_handshake was called by the same pp_entersub */
5397 cv = (CV*)v_my_perl;
5398 xs_spp = (SV***)CvHSCXT(cv);
5400 need = &PL_stack_sp;
5402 if(UNLIKELY(got != need)) {
5403 bad_handshake:/* recycle branch and string from above */
5404 if(got != (void *)HSf_NOCHK)
5405 noperl_die("%s: loadable library and perl binaries are mismatched"
5406 " (got handshake key %p, needed %p)\n",
5410 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5411 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5412 PL_xsubfilename = file; /* so the old name must be restored for
5413 additional XSUBs to register themselves */
5414 /* XSUBs can't be perl lang/perl5db.pl debugged
5415 if (PERLDB_LINE_OR_SAVESRC)
5416 (void)gv_fetchfile(file); */
5419 if(key & HSf_POPMARK) {
5421 { SV **mark = PL_stack_base + ax++;
5423 items = (I32)(SP - MARK);
5427 items = va_arg(args, U32);
5428 ax = va_arg(args, U32);
5432 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5433 if((apiverlen = HS_GETAPIVERLEN(key))) {
5434 char * api_p = va_arg(args, char*);
5435 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5436 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5437 sizeof("v" PERL_API_VERSION_STRING)-1))
5438 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5439 api_p, SVfARG(PL_stack_base[ax + 0]),
5440 "v" PERL_API_VERSION_STRING);
5445 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5446 if((xsverlen = HS_GETXSVERLEN(key)))
5447 S_xs_version_bootcheck(aTHX_
5448 items, ax, va_arg(args, char*), xsverlen);
5456 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5460 const char *vn = NULL;
5461 SV *const module = PL_stack_base[ax];
5463 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5465 if (items >= 2) /* version supplied as bootstrap arg */
5466 sv = PL_stack_base[ax + 1];
5468 /* XXX GV_ADDWARN */
5470 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5471 if (!sv || !SvOK(sv)) {
5473 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5477 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5478 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5479 ? sv : sv_2mortal(new_version(sv));
5480 xssv = upg_version(xssv, 0);
5481 if ( vcmp(pmsv,xssv) ) {
5482 SV *string = vstringify(xssv);
5483 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5484 " does not match ", SVfARG(module), SVfARG(string));
5486 SvREFCNT_dec(string);
5487 string = vstringify(pmsv);
5490 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5493 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5495 SvREFCNT_dec(string);
5497 Perl_sv_2mortal(aTHX_ xpt);
5498 Perl_croak_sv(aTHX_ xpt);
5504 =for apidoc my_strlcat
5506 The C library C<strlcat> if available, or a Perl implementation of it.
5507 This operates on C C<NUL>-terminated strings.
5509 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5510 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5511 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5512 practice this should not happen as it means that either C<size> is incorrect or
5513 that C<dst> is not a proper C<NUL>-terminated string).
5515 Note that C<size> is the full size of the destination buffer and
5516 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5517 room for the C<NUL> should be included in C<size>.
5519 The return value is the total length that C<dst> would have if C<size> is
5520 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5521 C<src>. If C<size> is smaller than the return, the excess was not appended.
5525 Description stolen from http://man.openbsd.org/strlcat.3
5529 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5531 Size_t used, length, copy;
5534 length = strlen(src);
5535 if (size > 0 && used < size - 1) {
5536 copy = (length >= size - used) ? size - used - 1 : length;
5537 memcpy(dst + used, src, copy);
5538 dst[used + copy] = '\0';
5540 return used + length;
5546 =for apidoc my_strlcpy
5548 The C library C<strlcpy> if available, or a Perl implementation of it.
5549 This operates on C C<NUL>-terminated strings.
5551 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5552 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5554 The return value is the total length C<src> would be if the copy completely
5555 succeeded. If it is larger than C<size>, the excess was not copied.
5559 Description stolen from http://man.openbsd.org/strlcpy.3
5563 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5565 Size_t length, copy;
5567 length = strlen(src);
5569 copy = (length >= size) ? size - 1 : length;
5570 memcpy(dst, src, copy);
5577 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5578 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5579 long _ftol( double ); /* Defined by VC6 C libs. */
5580 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5583 PERL_STATIC_INLINE bool
5584 S_gv_has_usable_name(pTHX_ GV *gv)
5588 && HvENAME(GvSTASH(gv))
5589 && (gvp = (GV **)hv_fetchhek(
5590 GvSTASH(gv), GvNAME_HEK(gv), 0
5596 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5598 SV * const dbsv = GvSVn(PL_DBsub);
5599 const bool save_taint = TAINT_get;
5601 /* When we are called from pp_goto (svp is null),
5602 * we do not care about using dbsv to call CV;
5603 * it's for informational purposes only.
5606 PERL_ARGS_ASSERT_GET_DB_SUB;
5610 if (!PERLDB_SUB_NN) {
5613 if (!svp && !CvLEXICAL(cv)) {
5614 gv_efullname3(dbsv, gv, NULL);
5616 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5617 || strEQ(GvNAME(gv), "END")
5618 || ( /* Could be imported, and old sub redefined. */
5619 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5621 !( (SvTYPE(*svp) == SVt_PVGV)
5622 && (GvCV((const GV *)*svp) == cv)
5623 /* Use GV from the stack as a fallback. */
5624 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5628 /* GV is potentially non-unique, or contain different CV. */
5629 SV * const tmp = newRV(MUTABLE_SV(cv));
5630 sv_setsv(dbsv, tmp);
5634 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5635 sv_catpvs(dbsv, "::");
5636 sv_cathek(dbsv, GvNAME_HEK(gv));
5640 const int type = SvTYPE(dbsv);
5641 if (type < SVt_PVIV && type != SVt_IV)
5642 sv_upgrade(dbsv, SVt_PVIV);
5643 (void)SvIOK_on(dbsv);
5644 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5647 TAINT_IF(save_taint);
5648 #ifdef NO_TAINT_SUPPORT
5649 PERL_UNUSED_VAR(save_taint);
5654 Perl_my_dirfd(DIR * dir) {
5656 /* Most dirfd implementations have problems when passed NULL. */
5661 #elif defined(HAS_DIR_DD_FD)
5664 Perl_croak_nocontext(PL_no_func, "dirfd");
5665 NOT_REACHED; /* NOTREACHED */
5670 #if !defined(HAS_MKOSTEMP) || !defined(HAS_MKSTEMP)
5672 #define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
5673 #define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
5676 S_my_mkostemp(char *templte, int flags) {
5678 STRLEN len = strlen(templte);
5682 int delete_on_close = flags & O_VMS_DELETEONCLOSE;
5684 flags &= ~O_VMS_DELETEONCLOSE;
5688 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
5689 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
5690 SETERRNO(EINVAL, LIB_INVARG);
5696 for (i = 1; i <= 6; ++i) {
5697 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
5700 if (delete_on_close) {
5701 fd = open(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600, "fop=dlt");
5706 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600);
5708 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
5715 #ifndef HAS_MKOSTEMP
5717 Perl_my_mkostemp(char *templte, int flags)
5719 PERL_ARGS_ASSERT_MY_MKOSTEMP;
5720 return S_my_mkostemp(templte, flags);
5726 Perl_my_mkstemp(char *templte)
5728 PERL_ARGS_ASSERT_MY_MKSTEMP;
5729 return S_my_mkostemp(templte, 0);
5734 Perl_get_re_arg(pTHX_ SV *sv) {
5740 sv = MUTABLE_SV(SvRV(sv));
5741 if (SvTYPE(sv) == SVt_REGEXP)
5742 return (REGEXP*) sv;
5749 * This code is derived from drand48() implementation from FreeBSD,
5750 * found in lib/libc/gen/_rand48.c.
5752 * The U64 implementation is original, based on the POSIX
5753 * specification for drand48().
5757 * Copyright (c) 1993 Martin Birgmeier
5758 * All rights reserved.
5760 * You may redistribute unmodified or modified versions of this source
5761 * code provided that the above copyright notice and this and the
5762 * following conditions are retained.
5764 * This software is provided ``as is'', and comes with no warranties
5765 * of any kind. I shall in no event be liable for anything that happens
5766 * to anyone/anything when using this software.
5769 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5771 #ifdef PERL_DRAND48_QUAD
5773 #define DRAND48_MULT UINT64_C(0x5deece66d)
5774 #define DRAND48_ADD 0xb
5775 #define DRAND48_MASK UINT64_C(0xffffffffffff)
5779 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5780 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5781 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5782 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5783 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5784 #define FREEBSD_DRAND48_ADD (0x000b)
5786 const unsigned short _rand48_mult[3] = {
5787 FREEBSD_DRAND48_MULT_0,
5788 FREEBSD_DRAND48_MULT_1,
5789 FREEBSD_DRAND48_MULT_2
5791 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5796 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5798 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5800 #ifdef PERL_DRAND48_QUAD
5801 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5803 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5804 random_state->seed[1] = (U16) seed;
5805 random_state->seed[2] = (U16) (seed >> 16);
5810 Perl_drand48_r(perl_drand48_t *random_state)
5812 PERL_ARGS_ASSERT_DRAND48_R;
5814 #ifdef PERL_DRAND48_QUAD
5815 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5818 return ldexp((double)*random_state, -48);
5824 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5825 + (U32) _rand48_add;
5826 temp[0] = (U16) accu; /* lower 16 bits */
5827 accu >>= sizeof(U16) * 8;
5828 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5829 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5830 temp[1] = (U16) accu; /* middle 16 bits */
5831 accu >>= sizeof(U16) * 8;
5832 accu += _rand48_mult[0] * random_state->seed[2]
5833 + _rand48_mult[1] * random_state->seed[1]
5834 + _rand48_mult[2] * random_state->seed[0];
5835 random_state->seed[0] = temp[0];
5836 random_state->seed[1] = temp[1];
5837 random_state->seed[2] = (U16) accu;
5839 return ldexp((double) random_state->seed[0], -48) +
5840 ldexp((double) random_state->seed[1], -32) +
5841 ldexp((double) random_state->seed[2], -16);
5846 #ifdef USE_C_BACKTRACE
5848 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5853 /* abfd is the BFD handle. */
5855 /* bfd_syms is the BFD symbol table. */
5857 /* bfd_text is handle to the the ".text" section of the object file. */
5859 /* Since opening the executable and scanning its symbols is quite
5860 * heavy operation, we remember the filename we used the last time,
5861 * and do the opening and scanning only if the filename changes.
5862 * This removes most (but not all) open+scan cycles. */
5863 const char* fname_prev;
5866 /* Given a dl_info, update the BFD context if necessary. */
5867 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5869 /* BFD open and scan only if the filename changed. */
5870 if (ctx->fname_prev == NULL ||
5871 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5873 bfd_close(ctx->abfd);
5875 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5877 if (bfd_check_format(ctx->abfd, bfd_object)) {
5878 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5879 if (symbol_size > 0) {
5880 Safefree(ctx->bfd_syms);
5881 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5883 bfd_get_section_by_name(ctx->abfd, ".text");
5891 ctx->fname_prev = dl_info->dli_fname;
5895 /* Given a raw frame, try to symbolize it and store
5896 * symbol information (source file, line number) away. */
5897 static void bfd_symbolize(bfd_context* ctx,
5900 STRLEN* symbol_name_size,
5902 STRLEN* source_name_size,
5903 STRLEN* source_line)
5905 *symbol_name = NULL;
5906 *symbol_name_size = 0;
5908 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5910 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5913 unsigned int line = 0;
5914 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5915 ctx->bfd_syms, offset,
5916 &file, &func, &line) &&
5917 file && func && line > 0) {
5918 /* Size and copy the source file, use only
5919 * the basename of the source file.
5921 * NOTE: the basenames are fine for the
5922 * Perl source files, but may not always
5923 * be the best idea for XS files. */
5924 const char *p, *b = NULL;
5925 /* Look for the last slash. */
5926 for (p = file; *p; p++) {
5930 if (b == NULL || *b == 0) {
5933 *source_name_size = p - b + 1;
5934 Newx(*source_name, *source_name_size + 1, char);
5935 Copy(b, *source_name, *source_name_size + 1, char);
5937 *symbol_name_size = strlen(func);
5938 Newx(*symbol_name, *symbol_name_size + 1, char);
5939 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5941 *source_line = line;
5947 #endif /* #ifdef USE_BFD */
5951 /* OS X has no public API for for 'symbolicating' (Apple official term)
5952 * stack addresses to {function_name, source_file, line_number}.
5953 * Good news: there is command line utility atos(1) which does that.
5954 * Bad news 1: it's a command line utility.
5955 * Bad news 2: one needs to have the Developer Tools installed.
5956 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
5958 * To recap: we need to open a pipe for reading for a utility which
5959 * might not exist, or exists in different locations, and then parse
5960 * the output. And since this is all for a low-level API, we cannot
5961 * use high-level stuff. Thanks, Apple. */
5964 /* tool is set to the absolute pathname of the tool to use:
5967 /* format is set to a printf format string used for building
5968 * the external command to run. */
5970 /* unavail is set if e.g. xcrun cannot be found, or something
5971 * else happens that makes getting the backtrace dubious. Note,
5972 * however, that the context isn't persistent, the next call to
5973 * get_c_backtrace() will start from scratch. */
5975 /* fname is the current object file name. */
5977 /* object_base_addr is the base address of the shared object. */
5978 void* object_base_addr;
5981 /* Given |dl_info|, updates the context. If the context has been
5982 * marked unavailable, return immediately. If not but the tool has
5983 * not been set, set it to either "xcrun atos" or "atos" (also set the
5984 * format to use for creating commands for piping), or if neither is
5985 * unavailable (one needs the Developer Tools installed), mark the context
5986 * an unavailable. Finally, update the filename (object name),
5987 * and its base address. */
5989 static void atos_update(atos_context* ctx,
5994 if (ctx->tool == NULL) {
5995 const char* tools[] = {
5999 const char* formats[] = {
6000 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6001 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6005 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6006 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6007 ctx->tool = tools[i];
6008 ctx->format = formats[i];
6012 if (ctx->tool == NULL) {
6013 ctx->unavail = TRUE;
6017 if (ctx->fname == NULL ||
6018 strNE(dl_info->dli_fname, ctx->fname)) {
6019 ctx->fname = dl_info->dli_fname;
6020 ctx->object_base_addr = dl_info->dli_fbase;
6024 /* Given an output buffer end |p| and its |start|, matches
6025 * for the atos output, extracting the source code location
6026 * and returning non-NULL if possible, returning NULL otherwise. */
6027 static const char* atos_parse(const char* p,
6029 STRLEN* source_name_size,
6030 STRLEN* source_line) {
6031 /* atos() output is something like:
6032 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6033 * We cannot use Perl regular expressions, because we need to
6034 * stay low-level. Therefore here we have a rolled-out version
6035 * of a state machine which matches _backwards_from_the_end_ and
6036 * if there's a success, returns the starts of the filename,
6037 * also setting the filename size and the source line number.
6038 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6039 const char* source_number_start;
6040 const char* source_name_end;
6041 const char* source_line_end = start;
6042 const char* close_paren;
6045 /* Skip trailing whitespace. */
6046 while (p > start && isSPACE(*p)) p--;
6047 /* Now we should be at the close paren. */
6048 if (p == start || *p != ')')
6052 /* Now we should be in the line number. */
6053 if (p == start || !isDIGIT(*p))
6055 /* Skip over the digits. */
6056 while (p > start && isDIGIT(*p))
6058 /* Now we should be at the colon. */
6059 if (p == start || *p != ':')
6061 source_number_start = p + 1;
6062 source_name_end = p; /* Just beyond the end. */
6064 /* Look for the open paren. */
6065 while (p > start && *p != '(')
6070 *source_name_size = source_name_end - p;
6071 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6072 && source_line_end == close_paren
6073 && uv <= PERL_INT_MAX
6075 *source_line = (STRLEN)uv;
6081 /* Given a raw frame, read a pipe from the symbolicator (that's the
6082 * technical term) atos, reads the result, and parses the source code
6083 * location. We must stay low-level, so we use snprintf(), pipe(),
6084 * and fread(), and then also parse the output ourselves. */
6085 static void atos_symbolize(atos_context* ctx,
6088 STRLEN* source_name_size,
6089 STRLEN* source_line)
6097 /* Simple security measure: if there's any funny business with
6098 * the object name (used as "-o '%s'" ), leave since at least
6099 * partially the user controls it. */
6100 for (p = ctx->fname; *p; p++) {
6101 if (*p == '\'' || isCNTRL(*p)) {
6102 ctx->unavail = TRUE;
6106 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6107 ctx->fname, ctx->object_base_addr, raw_frame);
6108 if (cnt < sizeof(cmd)) {
6109 /* Undo nostdio.h #defines that disable stdio.
6110 * This is somewhat naughty, but is used elsewhere
6111 * in the core, and affects only OS X. */
6116 FILE* fp = popen(cmd, "r");
6117 /* At the moment we open a new pipe for each stack frame.
6118 * This is naturally somewhat slow, but hopefully generating
6119 * stack traces is never going to in a performance critical path.
6121 * We could play tricks with atos by batching the stack
6122 * addresses to be resolved: atos can either take multiple
6123 * addresses from the command line, or read addresses from
6124 * a file (though the mess of creating temporary files would
6125 * probably negate much of any possible speedup).
6127 * Normally there are only two objects present in the backtrace:
6128 * perl itself, and the libdyld.dylib. (Note that the object
6129 * filenames contain the full pathname, so perl may not always
6130 * be in the same place.) Whenever the object in the
6131 * backtrace changes, the base address also changes.
6133 * The problem with batching the addresses, though, would be
6134 * matching the results with the addresses: the parsing of
6135 * the results is already painful enough with a single address. */
6138 UV cnt = fread(out, 1, sizeof(out), fp);
6139 if (cnt < sizeof(out)) {
6140 const char* p = atos_parse(out + cnt - 1, out,
6145 *source_name_size, char);
6146 Copy(p, *source_name,
6147 *source_name_size, char);
6155 #endif /* #ifdef PERL_DARWIN */
6158 =for apidoc get_c_backtrace
6160 Collects the backtrace (aka "stacktrace") into a single linear
6161 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6163 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6164 returning at most C<depth> frames.
6170 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6172 /* Note that here we must stay as low-level as possible: Newx(),
6173 * Copy(), Safefree(); since we may be called from anywhere,
6174 * so we should avoid higher level constructs like SVs or AVs.
6176 * Since we are using safesysmalloc() via Newx(), don't try
6177 * getting backtrace() there, unless you like deep recursion. */
6179 /* Currently only implemented with backtrace() and dladdr(),
6180 * for other platforms NULL is returned. */
6182 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6183 /* backtrace() is available via <execinfo.h> in glibc and in most
6184 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6186 /* We try fetching this many frames total, but then discard
6187 * the |skip| first ones. For the remaining ones we will try
6188 * retrieving more information with dladdr(). */
6189 int try_depth = skip + depth;
6191 /* The addresses (program counters) returned by backtrace(). */
6194 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6197 /* Sizes _including_ the terminating \0 of the object name
6198 * and symbol name strings. */
6199 STRLEN* object_name_sizes;
6200 STRLEN* symbol_name_sizes;
6203 /* The symbol names comes either from dli_sname,
6204 * or if using BFD, they can come from BFD. */
6205 char** symbol_names;
6208 /* The source code location information. Dug out with e.g. BFD. */
6209 char** source_names;
6210 STRLEN* source_name_sizes;
6211 STRLEN* source_lines;
6213 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6214 int got_depth; /* How many frames were returned from backtrace(). */
6215 UV frame_count = 0; /* How many frames we return. */
6216 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6219 bfd_context bfd_ctx;
6222 atos_context atos_ctx;
6225 /* Here are probably possibilities for optimizing. We could for
6226 * example have a struct that contains most of these and then
6227 * allocate |try_depth| of them, saving a bunch of malloc calls.
6228 * Note, however, that |frames| could not be part of that struct
6229 * because backtrace() will want an array of just them. Also be
6230 * careful about the name strings. */
6231 Newx(raw_frames, try_depth, void*);
6232 Newx(dl_infos, try_depth, Dl_info);
6233 Newx(object_name_sizes, try_depth, STRLEN);
6234 Newx(symbol_name_sizes, try_depth, STRLEN);
6235 Newx(source_names, try_depth, char*);
6236 Newx(source_name_sizes, try_depth, STRLEN);
6237 Newx(source_lines, try_depth, STRLEN);
6239 Newx(symbol_names, try_depth, char*);
6242 /* Get the raw frames. */
6243 got_depth = (int)backtrace(raw_frames, try_depth);
6245 /* We use dladdr() instead of backtrace_symbols() because we want
6246 * the full details instead of opaque strings. This is useful for
6247 * two reasons: () the details are needed for further symbolic
6248 * digging, for example in OS X (2) by having the details we fully
6249 * control the output, which in turn is useful when more platforms
6250 * are added: we can keep out output "portable". */
6252 /* We want a single linear allocation, which can then be freed
6253 * with a single swoop. We will do the usual trick of first
6254 * walking over the structure and seeing how much we need to
6255 * allocate, then allocating, and then walking over the structure
6256 * the second time and populating it. */
6258 /* First we must compute the total size of the buffer. */
6259 total_bytes = sizeof(Perl_c_backtrace_header);
6260 if (got_depth > skip) {
6263 bfd_init(); /* Is this safe to call multiple times? */
6264 Zero(&bfd_ctx, 1, bfd_context);
6267 Zero(&atos_ctx, 1, atos_context);
6269 for (i = skip; i < try_depth; i++) {
6270 Dl_info* dl_info = &dl_infos[i];
6272 object_name_sizes[i] = 0;
6273 source_names[i] = NULL;
6274 source_name_sizes[i] = 0;
6275 source_lines[i] = 0;
6277 /* Yes, zero from dladdr() is failure. */
6278 if (dladdr(raw_frames[i], dl_info)) {
6279 total_bytes += sizeof(Perl_c_backtrace_frame);
6281 object_name_sizes[i] =
6282 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6283 symbol_name_sizes[i] =
6284 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6286 bfd_update(&bfd_ctx, dl_info);
6287 bfd_symbolize(&bfd_ctx, raw_frames[i],
6289 &symbol_name_sizes[i],
6291 &source_name_sizes[i],
6295 atos_update(&atos_ctx, dl_info);
6296 atos_symbolize(&atos_ctx,
6299 &source_name_sizes[i],
6303 /* Plus ones for the terminating \0. */
6304 total_bytes += object_name_sizes[i] + 1;
6305 total_bytes += symbol_name_sizes[i] + 1;
6306 total_bytes += source_name_sizes[i] + 1;
6314 Safefree(bfd_ctx.bfd_syms);
6318 /* Now we can allocate and populate the result buffer. */
6319 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6320 Zero(bt, total_bytes, char);
6321 bt->header.frame_count = frame_count;
6322 bt->header.total_bytes = total_bytes;
6323 if (frame_count > 0) {
6324 Perl_c_backtrace_frame* frame = bt->frame_info;
6325 char* name_base = (char *)(frame + frame_count);
6326 char* name_curr = name_base; /* Outputting the name strings here. */
6328 for (i = skip; i < skip + frame_count; i++) {
6329 Dl_info* dl_info = &dl_infos[i];
6331 frame->addr = raw_frames[i];
6332 frame->object_base_addr = dl_info->dli_fbase;
6333 frame->symbol_addr = dl_info->dli_saddr;
6335 /* Copies a string, including the \0, and advances the name_curr.
6336 * Also copies the start and the size to the frame. */
6337 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6339 Copy(src, name_curr, size, char); \
6340 frame->doffset = name_curr - (char*)bt; \
6341 frame->dsize = size; \
6342 name_curr += size; \
6345 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6347 object_name_size, object_name_sizes[i]);
6350 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6352 symbol_name_size, symbol_name_sizes[i]);
6353 Safefree(symbol_names[i]);
6355 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6357 symbol_name_size, symbol_name_sizes[i]);
6360 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6362 source_name_size, source_name_sizes[i]);
6363 Safefree(source_names[i]);
6365 #undef PERL_C_BACKTRACE_STRCPY
6367 frame->source_line_number = source_lines[i];
6371 assert(total_bytes ==
6372 (UV)(sizeof(Perl_c_backtrace_header) +
6373 frame_count * sizeof(Perl_c_backtrace_frame) +
6374 name_curr - name_base));
6377 Safefree(symbol_names);
6379 bfd_close(bfd_ctx.abfd);
6382 Safefree(source_lines);
6383 Safefree(source_name_sizes);
6384 Safefree(source_names);
6385 Safefree(symbol_name_sizes);
6386 Safefree(object_name_sizes);
6387 /* Assuming the strings returned by dladdr() are pointers
6388 * to read-only static memory (the object file), so that
6389 * they do not need freeing (and cannot be). */
6391 Safefree(raw_frames);
6394 PERL_UNUSED_ARG(depth);
6395 PERL_UNUSED_ARG(skip);
6401 =for apidoc free_c_backtrace
6403 Deallocates a backtrace received from get_c_bracktrace.
6409 =for apidoc get_c_backtrace_dump
6411 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6412 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6414 The appended output looks like:
6417 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6418 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6421 The fields are tab-separated. The first column is the depth (zero
6422 being the innermost non-skipped frame). In the hex:offset, the hex is
6423 where the program counter was in C<S_parse_body>, and the :offset (might
6424 be missing) tells how much inside the C<S_parse_body> the program counter was.
6426 The C<util.c:1716> is the source code file and line number.
6428 The F</usr/bin/perl> is obvious (hopefully).
6430 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6431 if the platform doesn't support retrieving the information;
6432 if the binary is missing the debug information;
6433 if the optimizer has transformed the code by for example inlining.
6439 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6441 Perl_c_backtrace* bt;
6443 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6445 Perl_c_backtrace_frame* frame;
6446 SV* dsv = newSVpvs("");
6448 for (i = 0, frame = bt->frame_info;
6449 i < bt->header.frame_count; i++, frame++) {
6450 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6451 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6452 /* Symbol (function) names might disappear without debug info.
6454 * The source code location might disappear in case of the
6455 * optimizer inlining or otherwise rearranging the code. */
6456 if (frame->symbol_addr) {
6457 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6459 ((char*)frame->addr - (char*)frame->symbol_addr));
6461 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6462 frame->symbol_name_size &&
6463 frame->symbol_name_offset ?
6464 (char*)bt + frame->symbol_name_offset : "-");
6465 if (frame->source_name_size &&
6466 frame->source_name_offset &&
6467 frame->source_line_number) {
6468 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6469 (char*)bt + frame->source_name_offset,
6470 (UV)frame->source_line_number);
6472 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6474 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6475 frame->object_name_size &&
6476 frame->object_name_offset ?
6477 (char*)bt + frame->object_name_offset : "-");
6478 /* The frame->object_base_addr is not output,
6479 * but it is used for symbolizing/symbolicating. */
6480 sv_catpvs(dsv, "\n");
6483 Perl_free_c_backtrace(bt);
6492 =for apidoc dump_c_backtrace
6494 Dumps the C backtrace to the given C<fp>.
6496 Returns true if a backtrace could be retrieved, false if not.
6502 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6506 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6508 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6511 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6517 #endif /* #ifdef USE_C_BACKTRACE */
6519 #ifdef PERL_TSA_ACTIVE
6521 /* pthread_mutex_t and perl_mutex are typedef equivalent
6522 * so casting the pointers is fine. */
6524 int perl_tsa_mutex_lock(perl_mutex* mutex)
6526 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6529 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6531 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6534 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6536 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6544 /* log a sub call or return */
6547 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6555 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6558 HEK *hek = CvNAME_HEK(cv);
6559 func = HEK_KEY(hek);
6565 start = (const COP *)CvSTART(cv);
6566 file = CopFILE(start);
6567 line = CopLINE(start);
6568 stash = CopSTASHPV(start);
6571 PERL_SUB_ENTRY(func, file, line, stash);
6574 PERL_SUB_RETURN(func, file, line, stash);
6579 /* log a require file loading/loaded */
6582 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6584 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6587 PERL_LOADING_FILE(name);
6590 PERL_LOADED_FILE(name);
6595 /* log an op execution */
6598 Perl_dtrace_probe_op(pTHX_ const OP *op)
6600 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6602 PERL_OP_ENTRY(OP_NAME(op));
6606 /* log a compile/run phase change */
6609 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6611 const char *ph_old = PL_phase_names[PL_phase];
6612 const char *ph_new = PL_phase_names[phase];
6614 PERL_PHASE_CHANGE(ph_new, ph_old);
6620 * ex: set ts=8 sts=4 sw=4 et: