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
127 =for apidoc_section $memory
128 =for apidoc safesysmalloc
129 Paranoid version of system's malloc()
135 Perl_safesysmalloc(MEM_SIZE size)
137 #ifdef ALWAYS_NEED_THX
144 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
146 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
149 if ((SSize_t)size < 0)
150 Perl_croak_nocontext("panic: malloc, size=%" UVuf, (UV) size);
152 if (!size) size = 1; /* malloc(0) is NASTY on our system */
154 #ifdef PERL_DEBUG_READONLY_COW
155 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
156 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
157 perror("mmap failed");
161 ptr = (Malloc_t)PerlMem_malloc(size);
163 PERL_ALLOC_CHECK(ptr);
166 struct perl_memory_debug_header *const header
167 = (struct perl_memory_debug_header *)ptr;
171 PoisonNew(((char *)ptr), size, char);
174 #ifdef PERL_TRACK_MEMPOOL
175 header->interpreter = aTHX;
176 /* Link us into the list. */
177 header->prev = &PL_memory_debug_header;
178 header->next = PL_memory_debug_header.next;
179 PL_memory_debug_header.next = header;
180 maybe_protect_rw(header->next);
181 header->next->prev = header;
182 maybe_protect_ro(header->next);
183 # ifdef PERL_DEBUG_READONLY_COW
184 header->readonly = 0;
190 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
191 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
193 /* malloc() can modify errno() even on success, but since someone
194 writing perl code doesn't have any control over when perl calls
195 malloc() we need to hide that.
204 #ifndef ALWAYS_NEED_THX
217 =for apidoc safesysrealloc
218 Paranoid version of system's realloc()
224 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
226 #ifdef ALWAYS_NEED_THX
230 #ifdef PERL_DEBUG_READONLY_COW
231 const MEM_SIZE oldsize = where
232 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
241 ptr = safesysmalloc(size);
245 PERL_DEB(UV was_where = PTR2UV(where)); /* used in diags below */
247 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
248 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
250 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
252 struct perl_memory_debug_header *const header
253 = (struct perl_memory_debug_header *)where;
255 # ifdef PERL_TRACK_MEMPOOL
256 if (header->interpreter != aTHX) {
257 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
258 header->interpreter, aTHX);
260 assert(header->next->prev == header);
261 assert(header->prev->next == header);
263 if (header->size > size) {
264 const MEM_SIZE freed_up = header->size - size;
265 char *start_of_freed = ((char *)where) + size;
266 PoisonFree(start_of_freed, freed_up, char);
276 if ((SSize_t)size < 0)
277 Perl_croak_nocontext("panic: realloc, size=%" UVuf, (UV)size);
279 #ifdef PERL_DEBUG_READONLY_COW
280 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
281 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
282 perror("mmap failed");
285 Copy(where,ptr,oldsize < size ? oldsize : size,char);
286 if (munmap(where, oldsize)) {
287 perror("munmap failed");
291 ptr = (Malloc_t)PerlMem_realloc(where,size);
293 PERL_ALLOC_CHECK(ptr);
295 /* MUST do this fixup first, before doing ANYTHING else, as anything else
296 might allocate memory/free/move memory, and until we do the fixup, it
297 may well be chasing (and writing to) free memory. */
299 #ifdef PERL_TRACK_MEMPOOL
300 struct perl_memory_debug_header *const header
301 = (struct perl_memory_debug_header *)ptr;
304 if (header->size < size) {
305 const MEM_SIZE fresh = size - header->size;
306 char *start_of_fresh = ((char *)ptr) + size;
307 PoisonNew(start_of_fresh, fresh, char);
311 maybe_protect_rw(header->next);
312 header->next->prev = header;
313 maybe_protect_ro(header->next);
314 maybe_protect_rw(header->prev);
315 header->prev->next = header;
316 maybe_protect_ro(header->prev);
318 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
320 /* realloc() can modify errno() even on success, but since someone
321 writing perl code doesn't have any control over when perl calls
322 realloc() we need to hide that.
327 /* In particular, must do that fixup above before logging anything via
328 *printf(), as it can reallocate memory, which can cause SEGVs. */
330 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) rfree\n",was_where,(long)PL_an++));
331 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
338 #ifndef ALWAYS_NEED_THX
352 =for apidoc safesysfree
353 Safe version of system's free()
359 Perl_safesysfree(Malloc_t where)
361 #ifdef ALWAYS_NEED_THX
364 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
367 Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
369 struct perl_memory_debug_header *const header
370 = (struct perl_memory_debug_header *)where_intrn;
373 const MEM_SIZE size = header->size;
375 # ifdef PERL_TRACK_MEMPOOL
376 if (header->interpreter != aTHX) {
377 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
378 header->interpreter, aTHX);
381 Perl_croak_nocontext("panic: duplicate free");
384 Perl_croak_nocontext("panic: bad free, header->next==NULL");
385 if (header->next->prev != header || header->prev->next != header) {
386 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
387 "header=%p, ->prev->next=%p",
388 header->next->prev, header,
391 /* Unlink us from the chain. */
392 maybe_protect_rw(header->next);
393 header->next->prev = header->prev;
394 maybe_protect_ro(header->next);
395 maybe_protect_rw(header->prev);
396 header->prev->next = header->next;
397 maybe_protect_ro(header->prev);
398 maybe_protect_rw(header);
400 PoisonNew(where_intrn, size, char);
402 /* Trigger the duplicate free warning. */
405 # ifdef PERL_DEBUG_READONLY_COW
406 if (munmap(where_intrn, size)) {
407 perror("munmap failed");
413 Malloc_t where_intrn = where;
415 #ifndef PERL_DEBUG_READONLY_COW
416 PerlMem_free(where_intrn);
422 =for apidoc safesyscalloc
423 Safe version of system's calloc()
429 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
431 #ifdef ALWAYS_NEED_THX
435 #if defined(USE_MDH) || defined(DEBUGGING)
436 MEM_SIZE total_size = 0;
439 /* Even though calloc() for zero bytes is strange, be robust. */
440 if (size && (count <= MEM_SIZE_MAX / size)) {
441 #if defined(USE_MDH) || defined(DEBUGGING)
442 total_size = size * count;
448 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
449 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
454 if ((SSize_t)size < 0 || (SSize_t)count < 0)
455 Perl_croak_nocontext("panic: calloc, size=%" UVuf ", count=%" UVuf,
456 (UV)size, (UV)count);
458 #ifdef PERL_DEBUG_READONLY_COW
459 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
460 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
461 perror("mmap failed");
464 #elif defined(PERL_TRACK_MEMPOOL)
465 /* Have to use malloc() because we've added some space for our tracking
467 /* malloc(0) is non-portable. */
468 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
470 /* Use calloc() because it might save a memset() if the memory is fresh
471 and clean from the OS. */
473 ptr = (Malloc_t)PerlMem_calloc(count, size);
474 else /* calloc(0) is non-portable. */
475 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
477 PERL_ALLOC_CHECK(ptr);
478 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));
482 struct perl_memory_debug_header *const header
483 = (struct perl_memory_debug_header *)ptr;
485 # ifndef PERL_DEBUG_READONLY_COW
486 memset((void*)ptr, 0, total_size);
488 # ifdef PERL_TRACK_MEMPOOL
489 header->interpreter = aTHX;
490 /* Link us into the list. */
491 header->prev = &PL_memory_debug_header;
492 header->next = PL_memory_debug_header.next;
493 PL_memory_debug_header.next = header;
494 maybe_protect_rw(header->next);
495 header->next->prev = header;
496 maybe_protect_ro(header->next);
497 # ifdef PERL_DEBUG_READONLY_COW
498 header->readonly = 0;
502 header->size = total_size;
504 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
510 #ifndef ALWAYS_NEED_THX
519 /* These must be defined when not using Perl's malloc for binary
524 Malloc_t Perl_malloc (MEM_SIZE nbytes)
526 #ifdef PERL_IMPLICIT_SYS
529 return (Malloc_t)PerlMem_malloc(nbytes);
532 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
534 #ifdef PERL_IMPLICIT_SYS
537 return (Malloc_t)PerlMem_calloc(elements, size);
540 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
542 #ifdef PERL_IMPLICIT_SYS
545 return (Malloc_t)PerlMem_realloc(where, nbytes);
548 Free_t Perl_mfree (Malloc_t where)
550 #ifdef PERL_IMPLICIT_SYS
558 /* This is the value stored in *retlen in the two delimcpy routines below when
559 * there wasn't enough room in the destination to store everything it was asked
560 * to. The value is deliberately very large so that hopefully if code uses it
561 * unquestioningly to access memory, it will likely segfault. And it is small
562 * enough that if the caller does some arithmetic on it before accessing, it
563 * won't overflow into a small legal number. */
564 #define DELIMCPY_OUT_OF_BOUNDS_RET I32_MAX
567 =for apidoc_section $string
568 =for apidoc delimcpy_no_escape
570 Copy a source buffer to a destination buffer, stopping at (but not including)
571 the first occurrence in the source of the delimiter byte, C<delim>. The source
572 is the bytes between S<C<from> and C<from_end> - 1>. Similarly, the dest is
573 C<to> up to C<to_end>.
575 The number of bytes copied is written to C<*retlen>.
577 Returns the position of C<delim> in the C<from> buffer, but if there is no
578 such occurrence before C<from_end>, then C<from_end> is returned, and the entire
579 buffer S<C<from> .. C<from_end> - 1> is copied.
581 If there is room in the destination available after the copy, an extra
582 terminating safety C<NUL> byte is appended (not included in the returned
585 The error case is if the destination buffer is not large enough to accommodate
586 everything that should be copied. In this situation, a value larger than
587 S<C<to_end> - C<to>> is written to C<*retlen>, and as much of the source as
588 fits will be written to the destination. Not having room for the safety C<NUL>
589 is not considered an error.
594 Perl_delimcpy_no_escape(char *to, const char *to_end,
595 const char *from, const char *from_end,
596 const int delim, I32 *retlen)
598 const char * delim_pos;
599 Ptrdiff_t from_len = from_end - from;
600 Ptrdiff_t to_len = to_end - to;
603 PERL_ARGS_ASSERT_DELIMCPY_NO_ESCAPE;
605 assert(from_len >= 0);
608 /* Look for the first delimiter in the source */
609 delim_pos = (const char *) memchr(from, delim, from_len);
611 /* Copy up to where the delimiter was found, or the entire buffer if not
613 copy_len = (delim_pos) ? delim_pos - from : from_len;
615 /* If not enough room, copy as much as can fit, and set error return */
616 if (copy_len > to_len) {
617 Copy(from, to, to_len, char);
618 *retlen = DELIMCPY_OUT_OF_BOUNDS_RET;
621 Copy(from, to, copy_len, char);
623 /* If there is extra space available, add a trailing NUL */
624 if (copy_len < to_len) {
631 return (char *) from + copy_len;
637 Copy a source buffer to a destination buffer, stopping at (but not including)
638 the first occurrence in the source of an unescaped (defined below) delimiter
639 byte, C<delim>. The source is the bytes between S<C<from> and C<from_end> -
640 1>. Similarly, the dest is C<to> up to C<to_end>.
642 The number of bytes copied is written to C<*retlen>.
644 Returns the position of the first uncopied C<delim> in the C<from> buffer, but
645 if there is no such occurrence before C<from_end>, then C<from_end> is returned,
646 and the entire buffer S<C<from> .. C<from_end> - 1> is copied.
648 If there is room in the destination available after the copy, an extra
649 terminating safety C<NUL> byte is appended (not included in the returned
652 The error case is if the destination buffer is not large enough to accommodate
653 everything that should be copied. In this situation, a value larger than
654 S<C<to_end> - C<to>> is written to C<*retlen>, and as much of the source as
655 fits will be written to the destination. Not having room for the safety C<NUL>
656 is not considered an error.
658 In the following examples, let C<x> be the delimiter, and C<0> represent a C<NUL>
659 byte (B<NOT> the digit C<0>). Then we would have
664 provided the destination buffer is at least 4 bytes long.
666 An escaped delimiter is one which is immediately preceded by a single
667 backslash. Escaped delimiters are copied, and the copy continues past the
668 delimiter; the backslash is not copied:
673 (provided the destination buffer is at least 8 bytes long).
675 It's actually somewhat more complicated than that. A sequence of any odd number
676 of backslashes escapes the following delimiter, and the copy continues with
677 exactly one of the backslashes stripped.
681 abc\\\xdef abc\\xdef0
682 abc\\\\\xdef abc\\\\xdef0
684 (as always, if the destination is large enough)
686 An even number of preceding backslashes does not escape the delimiter, so that
687 the copy stops just before it, and includes all the backslashes (no stripping;
688 zero is considered even):
699 Perl_delimcpy(char *to, const char *to_end,
700 const char *from, const char *from_end,
701 const int delim, I32 *retlen)
703 const char * const orig_to = to;
704 Ptrdiff_t copy_len = 0;
705 bool stopped_early = FALSE; /* Ran out of room to copy to */
707 PERL_ARGS_ASSERT_DELIMCPY;
708 assert(from_end >= from);
709 assert(to_end >= to);
711 /* Don't use the loop for the trivial case of the first character being the
712 * delimiter; otherwise would have to worry inside the loop about backing
713 * up before the start of 'from' */
714 if (LIKELY(from_end > from && *from != delim)) {
715 while ((copy_len = from_end - from) > 0) {
716 const char * backslash_pos;
717 const char * delim_pos;
719 /* Look for the next delimiter in the remaining portion of the
720 * source. A loop invariant is that we already know that the copy
721 * should include *from; this comes from the conditional before the
722 * loop, and how we set things up at the end of each iteration */
723 delim_pos = (const char *) memchr(from + 1, delim, copy_len - 1);
725 /* If didn't find it, done looking; set up so copies all of the
728 copy_len = from_end - from;
732 /* Look for a backslash immediately before the delimiter */
733 backslash_pos = delim_pos - 1;
735 /* If the delimiter is not escaped, this ends the copy */
736 if (*backslash_pos != '\\') {
737 copy_len = delim_pos - from;
741 /* Here there is a backslash just before the delimiter, but it
742 * could be the final backslash in a sequence of them. Backup to
743 * find the first one in it. */
747 while (backslash_pos >= from && *backslash_pos == '\\');
749 /* If the number of backslashes is even, they just escape one
750 * another, leaving the delimiter unescaped, and stopping the copy.
752 if (! ((delim_pos - (backslash_pos + 1)) & 1)) {
753 copy_len = delim_pos - from; /* even, copy up to delimiter */
757 /* Here is odd, so the delimiter is escaped. We will try to copy
758 * all but the final backslash in the sequence */
759 copy_len = delim_pos - 1 - from;
761 /* Do the copy, but not beyond the end of the destination */
762 if (copy_len >= to_end - to) {
763 Copy(from, to, to_end - to, char);
764 stopped_early = TRUE;
765 to = (char *) to_end;
768 Copy(from, to, copy_len, char);
772 /* Set up so next iteration will include the delimiter */
777 /* Here, have found the final segment to copy. Copy that, but not beyond
778 * the size of the destination. If not enough room, copy as much as can
779 * fit, and set error return */
780 if (stopped_early || copy_len > to_end - to) {
781 Copy(from, to, to_end - to, char);
782 *retlen = DELIMCPY_OUT_OF_BOUNDS_RET;
785 Copy(from, to, copy_len, char);
789 /* If there is extra space available, add a trailing NUL */
794 *retlen = to - orig_to;
797 return (char *) from + copy_len;
803 Find the first (leftmost) occurrence of a sequence of bytes within another
804 sequence. This is the Perl version of C<strstr()>, extended to handle
805 arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
806 is what the initial C<n> in the function name stands for; some systems have an
807 equivalent, C<memmem()>, but with a somewhat different API).
809 Another way of thinking about this function is finding a needle in a haystack.
810 C<big> points to the first byte in the haystack. C<big_end> points to one byte
811 beyond the final byte in the haystack. C<little> points to the first byte in
812 the needle. C<little_end> points to one byte beyond the final byte in the
813 needle. All the parameters must be non-C<NULL>.
815 The function returns C<NULL> if there is no occurrence of C<little> within
816 C<big>. If C<little> is the empty string, C<big> is returned.
818 Because this function operates at the byte level, and because of the inherent
819 characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
820 needle and the haystack are strings with the same UTF-8ness, but not if the
828 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
830 PERL_ARGS_ASSERT_NINSTR;
833 return ninstr(big, bigend, little, lend);
836 if (little >= lend) {
840 const U8 first = *little;
843 /* No match can start closer to the end of the haystack than the length
845 bigend -= lend - little;
846 little++; /* Look for 'first', then the remainder is in here */
847 lsize = lend - little;
849 while (big <= bigend) {
850 big = (char *) memchr((U8 *) big, first, bigend - big + 1);
851 if (big == NULL || big > bigend) {
855 if (memEQ(big + 1, little, lsize)) {
871 Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
872 sequence of bytes within another sequence, returning C<NULL> if there is no
880 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
882 const Ptrdiff_t little_len = lend - little;
883 const Ptrdiff_t big_len = bigend - big;
885 PERL_ARGS_ASSERT_RNINSTR;
887 /* A non-existent needle trivially matches the rightmost possible position
889 if (UNLIKELY(little_len <= 0)) {
890 return (char*)bigend;
893 /* If the needle is larger than the haystack, the needle can't possibly fit
894 * inside the haystack. */
895 if (UNLIKELY(little_len > big_len)) {
899 /* Special case length 1 needles. It's trivial if we have memrchr();
900 * and otherwise we just do a per-byte search backwards.
902 * XXX When we don't have memrchr, we could use something like
903 * S_find_next_masked( or S_find_span_end() to do per-word searches */
904 if (little_len == 1) {
905 const char final = *little;
909 return (char *) memrchr(big, final, big_len);
911 const char * cur = bigend - 1;
917 } while (--cur >= big);
923 else { /* Below, the needle is longer than a single byte */
925 /* We search backwards in the haystack for the final character of the
926 * needle. Each time one is found, we see if the characters just
927 * before it in the haystack match the rest of the needle. */
928 const char final = *(lend - 1);
930 /* What matches consists of 'little_len'-1 characters, then the final
932 const Size_t prefix_len = little_len - 1;
934 /* If the final character in the needle is any closer than this to the
935 * left edge, there wouldn't be enough room for all of it to fit in the
937 const char * const left_fence = big + prefix_len;
939 /* Start at the right edge */
940 char * cur = (char *) bigend;
942 /* memrchr() makes the search easy (and fast); otherwise, look
943 * backwards byte-by-byte. */
948 cur = (char *) memrchr(left_fence, final, cur - left_fence);
955 if (cur < left_fence) {
959 while (*cur != final);
962 /* Here, we know that *cur is 'final'; see if the preceding bytes
963 * of the needle also match the corresponding haystack bytes */
964 if memEQ(cur - prefix_len, little, prefix_len) {
965 return cur - prefix_len;
967 } while (cur > left_fence);
973 /* As a space optimization, we do not compile tables for strings of length
974 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
975 special-cased in fbm_instr().
977 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
981 =for apidoc fbm_compile
983 Analyzes the string in order to make fast searches on it using C<fbm_instr()>
984 -- the Boyer-Moore algorithm.
990 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
997 PERL_ARGS_ASSERT_FBM_COMPILE;
999 if (isGV_with_GP(sv) || SvROK(sv))
1005 if (flags & FBMcf_TAIL) {
1006 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
1007 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
1008 if (mg && mg->mg_len >= 0)
1011 if (!SvPOK(sv) || SvNIOKp(sv))
1012 s = (U8*)SvPV_force_mutable(sv, len);
1013 else s = (U8 *)SvPV_mutable(sv, len);
1014 if (len == 0) /* TAIL might be on a zero-length string. */
1016 SvUPGRADE(sv, SVt_PVMG);
1020 /* add PERL_MAGIC_bm magic holding the FBM lookup table */
1022 assert(!mg_find(sv, PERL_MAGIC_bm));
1023 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
1027 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
1029 const U8 mlen = (len>255) ? 255 : (U8)len;
1030 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
1033 Newx(table, 256, U8);
1034 memset((void*)table, mlen, 256);
1035 mg->mg_ptr = (char *)table;
1038 s += len - 1; /* last char */
1041 if (table[*s] == mlen)
1047 BmUSEFUL(sv) = 100; /* Initial value */
1048 ((XPVNV*)SvANY(sv))->xnv_u.xnv_bm_tail = cBOOL(flags & FBMcf_TAIL);
1053 =for apidoc fbm_instr
1055 Returns the location of the SV in the string delimited by C<big> and
1056 C<bigend> (C<bigend>) is the char following the last char).
1057 It returns C<NULL> if the string can't be found. The C<sv>
1058 does not have to be C<fbm_compiled>, but the search will not be as fast
1063 If SvTAIL(littlestr) is true, a fake "\n" was appended to the string
1064 during FBM compilation due to FBMcf_TAIL in flags. It indicates that
1065 the littlestr must be anchored to the end of bigstr (or to any \n if
1068 E.g. The regex compiler would compile /abc/ to a littlestr of "abc",
1069 while /abc$/ compiles to "abc\n" with SvTAIL() true.
1071 A littlestr of "abc", !SvTAIL matches as /abc/;
1072 a littlestr of "ab\n", SvTAIL matches as:
1073 without FBMrf_MULTILINE: /ab\n?\z/
1074 with FBMrf_MULTILINE: /ab\n/ || /ab\z/;
1076 (According to Ilya from 1999; I don't know if this is still true, DAPM 2015):
1077 "If SvTAIL is actually due to \Z or \z, this gives false positives
1083 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
1087 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
1088 STRLEN littlelen = l;
1089 const I32 multiline = flags & FBMrf_MULTILINE;
1090 bool valid = SvVALID(littlestr);
1091 bool tail = valid ? cBOOL(SvTAIL(littlestr)) : FALSE;
1093 PERL_ARGS_ASSERT_FBM_INSTR;
1095 assert(bigend >= big);
1097 if ((STRLEN)(bigend - big) < littlelen) {
1099 && ((STRLEN)(bigend - big) == littlelen - 1)
1101 || (*big == *little &&
1102 memEQ((char *)big, (char *)little, littlelen - 1))))
1107 switch (littlelen) { /* Special cases for 0, 1 and 2 */
1109 return (char*)big; /* Cannot be SvTAIL! */
1112 if (tail && !multiline) /* Anchor only! */
1113 /* [-1] is safe because we know that bigend != big. */
1114 return (char *) (bigend - (bigend[-1] == '\n'));
1116 s = (unsigned char *)memchr((void*)big, *little, bigend-big);
1120 return (char *) bigend;
1124 if (tail && !multiline) {
1125 /* a littlestr with SvTAIL must be of the form "X\n" (where X
1126 * is a single char). It is anchored, and can only match
1127 * "....X\n" or "....X" */
1128 if (bigend[-2] == *little && bigend[-1] == '\n')
1129 return (char*)bigend - 2;
1130 if (bigend[-1] == *little)
1131 return (char*)bigend - 1;
1136 /* memchr() is likely to be very fast, possibly using whatever
1137 * hardware support is available, such as checking a whole
1138 * cache line in one instruction.
1139 * So for a 2 char pattern, calling memchr() is likely to be
1140 * faster than running FBM, or rolling our own. The previous
1141 * version of this code was roll-your-own which typically
1142 * only needed to read every 2nd char, which was good back in
1143 * the day, but no longer.
1145 unsigned char c1 = little[0];
1146 unsigned char c2 = little[1];
1148 /* *** for all this case, bigend points to the last char,
1149 * not the trailing \0: this makes the conditions slightly
1154 while (s < bigend) {
1155 /* do a quick test for c1 before calling memchr();
1156 * this avoids the expensive fn call overhead when
1157 * there are lots of c1's */
1158 if (LIKELY(*s != c1)) {
1160 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
1167 /* failed; try searching for c2 this time; that way
1168 * we don't go pathologically slow when the string
1169 * consists mostly of c1's or vice versa.
1174 s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
1178 return (char*)s - 1;
1182 /* c1, c2 the same */
1183 while (s < bigend) {
1192 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
1193 if (!s || s >= bigend)
1200 /* failed to find 2 chars; try anchored match at end without
1202 if (tail && bigend[0] == little[0])
1203 return (char *)bigend;
1208 break; /* Only lengths 0 1 and 2 have special-case code. */
1211 if (tail && !multiline) { /* tail anchored? */
1212 s = bigend - littlelen;
1213 if (s >= big && bigend[-1] == '\n' && *s == *little
1214 /* Automatically of length > 2 */
1215 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
1217 return (char*)s; /* how sweet it is */
1220 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
1222 return (char*)s + 1; /* how sweet it is */
1228 /* not compiled; use Perl_ninstr() instead */
1229 char * const b = ninstr((char*)big,(char*)bigend,
1230 (char*)little, (char*)little + littlelen);
1232 assert(!tail); /* valid => FBM; tail only set on SvVALID SVs */
1236 /* Do actual FBM. */
1237 if (littlelen > (STRLEN)(bigend - big))
1241 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
1242 const unsigned char *oldlittle;
1246 --littlelen; /* Last char found by table lookup */
1248 s = big + littlelen;
1249 little += littlelen; /* last char */
1252 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
1253 const unsigned char lastc = *little;
1257 if ((tmp = table[*s])) {
1258 /* *s != lastc; earliest position it could match now is
1259 * tmp slots further on */
1260 if ((s += tmp) >= bigend)
1262 if (LIKELY(*s != lastc)) {
1264 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
1274 /* hand-rolled strncmp(): less expensive than calling the
1275 * real function (maybe???) */
1277 unsigned char * const olds = s;
1282 if (*--s == *--little)
1284 s = olds + 1; /* here we pay the price for failure */
1286 if (s < bigend) /* fake up continue to outer loop */
1296 && memEQ((char *)(bigend - littlelen),
1297 (char *)(oldlittle - littlelen), littlelen) )
1298 return (char*)bigend - littlelen;
1304 Perl_cntrl_to_mnemonic(const U8 c)
1306 /* Returns the mnemonic string that represents character 'c', if one
1307 * exists; NULL otherwise. The only ones that exist for the purposes of
1308 * this routine are a few control characters */
1311 case '\a': return "\\a";
1312 case '\b': return "\\b";
1313 case ESC_NATIVE: return "\\e";
1314 case '\f': return "\\f";
1315 case '\n': return "\\n";
1316 case '\r': return "\\r";
1317 case '\t': return "\\t";
1324 =for apidoc savesharedpv
1326 A version of C<savepv()> which allocates the duplicate string in memory
1327 which is shared between threads.
1332 Perl_savesharedpv(pTHX_ const char *pv)
1337 PERL_UNUSED_CONTEXT;
1342 pvlen = strlen(pv)+1;
1343 newaddr = (char*)PerlMemShared_malloc(pvlen);
1347 return (char*)memcpy(newaddr, pv, pvlen);
1351 =for apidoc savesharedpvn
1353 A version of C<savepvn()> which allocates the duplicate string in memory
1354 which is shared between threads. (With the specific difference that a C<NULL>
1355 pointer is not acceptable)
1360 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1362 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1364 PERL_UNUSED_CONTEXT;
1365 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1370 newaddr[len] = '\0';
1371 return (char*)memcpy(newaddr, pv, len);
1374 /* the SV for Perl_form() and mess() is not kept in an arena */
1382 if (PL_phase != PERL_PHASE_DESTRUCT)
1383 return newSVpvs_flags("", SVs_TEMP);
1388 /* Create as PVMG now, to avoid any upgrading later */
1390 Newxz(any, 1, XPVMG);
1391 SvFLAGS(sv) = SVt_PVMG;
1392 SvANY(sv) = (void*)any;
1394 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1399 #if defined(MULTIPLICITY)
1401 Perl_form_nocontext(const char* pat, ...)
1406 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1407 va_start(args, pat);
1408 retval = vform(pat, &args);
1412 #endif /* MULTIPLICITY */
1415 =for apidoc_section $display
1417 =for apidoc_item form_nocontext
1419 These take a sprintf-style format pattern and conventional
1420 (non-SV) arguments and return the formatted string.
1422 (char *) Perl_form(pTHX_ const char* pat, ...)
1424 can be used any place a string (char *) is required:
1426 char * s = Perl_form("%d.%d",major,minor);
1428 They use a single (per-thread) private buffer so if you want to format several
1429 strings you must explicitly copy the earlier strings away (and free the copies
1432 The two forms differ only in that C<form_nocontext> does not take a thread
1433 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
1434 already have the thread context.
1437 Like C<L</form>> but but the arguments are an encapsulated argument list.
1443 Perl_form(pTHX_ const char* pat, ...)
1447 PERL_ARGS_ASSERT_FORM;
1448 va_start(args, pat);
1449 retval = vform(pat, &args);
1455 Perl_vform(pTHX_ const char *pat, va_list *args)
1457 SV * const sv = mess_alloc();
1458 PERL_ARGS_ASSERT_VFORM;
1459 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1465 =for apidoc_item mess_nocontext
1467 These take a sprintf-style format pattern and argument list, which are used to
1468 generate a string message. If the message does not end with a newline, then it
1469 will be extended with some indication of the current location in the code, as
1470 described for C<L</mess_sv>>.
1472 Normally, the resulting message is returned in a new mortal SV.
1473 But during global destruction a single SV may be shared between uses of
1476 The two forms differ only in that C<mess_nocontext> does not take a thread
1477 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
1478 already have the thread context.
1483 #if defined(MULTIPLICITY)
1485 Perl_mess_nocontext(const char *pat, ...)
1490 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1491 va_start(args, pat);
1492 retval = vmess(pat, &args);
1496 #endif /* MULTIPLICITY */
1499 Perl_mess(pTHX_ const char *pat, ...)
1503 PERL_ARGS_ASSERT_MESS;
1504 va_start(args, pat);
1505 retval = vmess(pat, &args);
1511 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1514 /* Look for curop starting from o. cop is the last COP we've seen. */
1515 /* opnext means that curop is actually the ->op_next of the op we are
1518 PERL_ARGS_ASSERT_CLOSEST_COP;
1520 if (!o || !curop || (
1521 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1525 if (o->op_flags & OPf_KIDS) {
1527 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1530 /* If the OP_NEXTSTATE has been optimised away we can still use it
1531 * the get the file and line number. */
1533 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1534 cop = (const COP *)kid;
1536 /* Keep searching, and return when we've found something. */
1538 new_cop = closest_cop(cop, kid, curop, opnext);
1544 /* Nothing found. */
1552 Expands a message, intended for the user, to include an indication of
1553 the current location in the code, if the message does not already appear
1556 C<basemsg> is the initial message or object. If it is a reference, it
1557 will be used as-is and will be the result of this function. Otherwise it
1558 is used as a string, and if it already ends with a newline, it is taken
1559 to be complete, and the result of this function will be the same string.
1560 If the message does not end with a newline, then a segment such as C<at
1561 foo.pl line 37> will be appended, and possibly other clauses indicating
1562 the current state of execution. The resulting message will end with a
1565 Normally, the resulting message is returned in a new mortal SV.
1566 During global destruction a single SV may be shared between uses of this
1567 function. If C<consume> is true, then the function is permitted (but not
1568 required) to modify and return C<basemsg> instead of allocating a new SV.
1574 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1578 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1582 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1583 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1584 && grok_atoUV(ws, &wi, NULL)
1585 && wi <= PERL_INT_MAX
1587 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1592 PERL_ARGS_ASSERT_MESS_SV;
1594 if (SvROK(basemsg)) {
1600 sv_setsv(sv, basemsg);
1605 if (SvPOK(basemsg) && consume) {
1610 sv_copypv(sv, basemsg);
1613 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1615 * Try and find the file and line for PL_op. This will usually be
1616 * PL_curcop, but it might be a cop that has been optimised away. We
1617 * can try to find such a cop by searching through the optree starting
1618 * from the sibling of PL_curcop.
1623 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1628 Perl_sv_catpvf(aTHX_ sv, " at %s line %" LINE_Tf,
1629 OutCopFILE(cop), CopLINE(cop));
1632 /* Seems that GvIO() can be untrustworthy during global destruction. */
1633 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1634 && IoLINES(GvIOp(PL_last_in_gv)))
1637 const bool line_mode = (RsSIMPLE(PL_rs) &&
1638 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1639 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1640 SVfARG(PL_last_in_gv == PL_argvgv
1642 : newSVhek_mortal(GvNAME_HEK(PL_last_in_gv))),
1643 line_mode ? "line" : "chunk",
1644 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1646 if (PL_phase == PERL_PHASE_DESTRUCT)
1647 sv_catpvs(sv, " during global destruction");
1648 sv_catpvs(sv, ".\n");
1656 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1657 argument list, respectively. These are used to generate a string message. If
1659 message does not end with a newline, then it will be extended with
1660 some indication of the current location in the code, as described for
1663 Normally, the resulting message is returned in a new mortal SV.
1664 During global destruction a single SV may be shared between uses of
1671 Perl_vmess(pTHX_ const char *pat, va_list *args)
1673 SV * const sv = mess_alloc();
1675 PERL_ARGS_ASSERT_VMESS;
1677 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1678 return mess_sv(sv, 1);
1682 Perl_write_to_stderr(pTHX_ SV* msv)
1687 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1689 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1690 && (io = GvIO(PL_stderrgv))
1691 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1692 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1693 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1695 PerlIO * const serr = Perl_error_log;
1697 do_print(msv, serr);
1698 (void)PerlIO_flush(serr);
1703 =for apidoc_section $warning
1706 /* Common code used in dieing and warning */
1709 S_with_queued_errors(pTHX_ SV *ex)
1711 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1712 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1713 sv_catsv(PL_errors, ex);
1714 ex = sv_mortalcopy(PL_errors);
1715 SvCUR_set(PL_errors, 0);
1721 Perl_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1726 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1727 /* sv_2cv might call Perl_croak() or Perl_warner() */
1728 SV * const oldhook = *hook;
1730 if (!oldhook || oldhook == PERL_WARNHOOK_FATAL)
1736 cv = sv_2cv(oldhook, &stash, &gv, 0);
1738 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1748 exarg = newSVsv(ex);
1749 SvREADONLY_on(exarg);
1752 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1756 call_sv(MUTABLE_SV(cv), G_DISCARD);
1767 This behaves the same as L</croak_sv>, except for the return type.
1768 It should be used only where the C<OP *> return type is required.
1769 The function never actually returns.
1774 /* silence __declspec(noreturn) warnings */
1775 MSVC_DIAG_IGNORE(4646 4645)
1777 Perl_die_sv(pTHX_ SV *baseex)
1779 PERL_ARGS_ASSERT_DIE_SV;
1782 NORETURN_FUNCTION_END;
1788 =for apidoc_item die_nocontext
1790 These behave the same as L</croak>, except for the return type.
1791 They should be used only where the C<OP *> return type is required.
1792 They never actually return.
1794 The two forms differ only in that C<die_nocontext> does not take a thread
1795 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
1796 already have the thread context.
1801 #if defined(MULTIPLICITY)
1803 /* silence __declspec(noreturn) warnings */
1804 MSVC_DIAG_IGNORE(4646 4645)
1806 Perl_die_nocontext(const char* pat, ...)
1810 va_start(args, pat);
1812 NOT_REACHED; /* NOTREACHED */
1814 NORETURN_FUNCTION_END;
1818 #endif /* MULTIPLICITY */
1820 /* silence __declspec(noreturn) warnings */
1821 MSVC_DIAG_IGNORE(4646 4645)
1823 Perl_die(pTHX_ const char* pat, ...)
1826 va_start(args, pat);
1828 NOT_REACHED; /* NOTREACHED */
1830 NORETURN_FUNCTION_END;
1835 =for apidoc croak_sv
1837 This is an XS interface to Perl's C<die> function.
1839 C<baseex> is the error message or object. If it is a reference, it
1840 will be used as-is. Otherwise it is used as a string, and if it does
1841 not end with a newline then it will be extended with some indication of
1842 the current location in the code, as described for L</mess_sv>.
1844 The error message or object will be used as an exception, by default
1845 returning control to the nearest enclosing C<eval>, but subject to
1846 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1847 function never returns normally.
1849 To die with a simple string message, the L</croak> function may be
1856 Perl_croak_sv(pTHX_ SV *baseex)
1858 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1859 PERL_ARGS_ASSERT_CROAK_SV;
1860 invoke_exception_hook(ex, FALSE);
1867 This is an XS interface to Perl's C<die> function.
1869 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1870 argument list. These are used to generate a string message. If the
1871 message does not end with a newline, then it will be extended with
1872 some indication of the current location in the code, as described for
1875 The error message will be used as an exception, by default
1876 returning control to the nearest enclosing C<eval>, but subject to
1877 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1878 function never returns normally.
1880 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1881 (C<$@>) will be used as an error message or object instead of building an
1882 error message from arguments. If you want to throw a non-string object,
1883 or build an error message in an SV yourself, it is preferable to use
1884 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1890 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1892 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1893 invoke_exception_hook(ex, FALSE);
1899 =for apidoc_item croak_nocontext
1901 These are XS interfaces to Perl's C<die> function.
1903 They take a sprintf-style format pattern and argument list, which are used to
1904 generate a string message. If the message does not end with a newline, then it
1905 will be extended with some indication of the current location in the code, as
1906 described for C<L</mess_sv>>.
1908 The error message will be used as an exception, by default
1909 returning control to the nearest enclosing C<eval>, but subject to
1910 modification by a C<$SIG{__DIE__}> handler. In any case, these croak
1911 functions never return normally.
1913 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1914 (C<$@>) will be used as an error message or object instead of building an
1915 error message from arguments. If you want to throw a non-string object,
1916 or build an error message in an SV yourself, it is preferable to use
1917 the C<L</croak_sv>> function, which does not involve clobbering C<ERRSV>.
1919 The two forms differ only in that C<croak_nocontext> does not take a thread
1920 context (C<aTHX>) parameter. It is usually preferred as it takes up fewer
1921 bytes of code than plain C<Perl_croak>, and time is rarely a critical resource
1922 when you are about to throw an exception.
1927 #if defined(MULTIPLICITY)
1929 Perl_croak_nocontext(const char *pat, ...)
1933 va_start(args, pat);
1935 NOT_REACHED; /* NOTREACHED */
1938 #endif /* MULTIPLICITY */
1941 Perl_croak(pTHX_ const char *pat, ...)
1944 va_start(args, pat);
1946 NOT_REACHED; /* NOTREACHED */
1951 =for apidoc croak_no_modify
1953 This encapsulates a common reason for dying, generating terser object code than
1954 using the generic C<Perl_croak>. It is exactly equivalent to
1955 C<Perl_croak(aTHX_ "%s", PL_no_modify)> (which expands to something like
1956 "Modification of a read-only value attempted").
1958 Less code used on exception code paths reduces CPU cache pressure.
1964 Perl_croak_no_modify(void)
1966 Perl_croak_nocontext( "%s", PL_no_modify);
1969 /* does not return, used in util.c perlio.c and win32.c
1970 This is typically called when malloc returns NULL.
1973 Perl_croak_no_mem(void)
1977 int fd = PerlIO_fileno(Perl_error_log);
1979 SETERRNO(EBADF,RMS_IFI);
1981 /* Can't use PerlIO to write as it allocates memory */
1982 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1987 /* does not return, used only in POPSTACK */
1989 Perl_croak_popstack(void)
1992 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1999 This is an XS interface to Perl's C<warn> function.
2001 C<baseex> is the error message or object. If it is a reference, it
2002 will be used as-is. Otherwise it is used as a string, and if it does
2003 not end with a newline then it will be extended with some indication of
2004 the current location in the code, as described for L</mess_sv>.
2006 The error message or object will by default be written to standard error,
2007 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2009 To warn with a simple string message, the L</warn> function may be
2016 Perl_warn_sv(pTHX_ SV *baseex)
2018 SV *ex = mess_sv(baseex, 0);
2019 PERL_ARGS_ASSERT_WARN_SV;
2020 if (!invoke_exception_hook(ex, TRUE))
2021 write_to_stderr(ex);
2027 This is an XS interface to Perl's C<warn> function.
2029 This is like C<L</warn>>, but C<args> are an encapsulated
2032 Unlike with L</vcroak>, C<pat> is not permitted to be null.
2038 Perl_vwarn(pTHX_ const char* pat, va_list *args)
2040 SV *ex = vmess(pat, args);
2041 PERL_ARGS_ASSERT_VWARN;
2042 if (!invoke_exception_hook(ex, TRUE))
2043 write_to_stderr(ex);
2048 =for apidoc_item warn_nocontext
2050 These are XS interfaces to Perl's C<warn> function.
2052 They take a sprintf-style format pattern and argument list, which are used to
2053 generate a string message. If the message does not end with a newline, then it
2054 will be extended with some indication of the current location in the code, as
2055 described for C<L</mess_sv>>.
2057 The error message or object will by default be written to standard error,
2058 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2060 Unlike with C<L</croak>>, C<pat> is not permitted to be null.
2062 The two forms differ only in that C<warn_nocontext> does not take a thread
2063 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
2064 already have the thread context.
2069 #if defined(MULTIPLICITY)
2071 Perl_warn_nocontext(const char *pat, ...)
2075 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
2076 va_start(args, pat);
2080 #endif /* MULTIPLICITY */
2083 Perl_warn(pTHX_ const char *pat, ...)
2086 PERL_ARGS_ASSERT_WARN;
2087 va_start(args, pat);
2094 =for apidoc_item warner_nocontext
2096 These output a warning of the specified category (or categories) given by
2097 C<err>, using the sprintf-style format pattern C<pat>, and argument list.
2099 C<err> must be one of the C<L</packWARN>>, C<packWARN2>, C<packWARN3>,
2100 C<packWARN4> macros populated with the appropriate number of warning
2101 categories. If any of the warning categories they specify is fatal, a fatal
2102 exception is thrown.
2104 In any event a message is generated by the pattern and arguments. If the
2105 message does not end with a newline, then it will be extended with some
2106 indication of the current location in the code, as described for L</mess_sv>.
2108 The error message or object will by default be written to standard error,
2109 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2111 C<pat> is not permitted to be null.
2113 The two forms differ only in that C<warner_nocontext> does not take a thread
2114 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
2115 already have the thread context.
2117 These functions differ from the similarly named C<L</warn>> functions, in that
2118 the latter are for XS code to unconditionally display a warning, whereas these
2119 are for code that may be compiling a perl program, and does extra checking to
2120 see if the warning should be fatal.
2122 =for apidoc ck_warner
2123 =for apidoc_item ck_warner_d
2124 If none of the warning categories given by C<err> are enabled, do nothing;
2125 otherwise call C<L</warner>> or C<L</warner_nocontext>> with the passed-in
2128 C<err> must be one of the C<L</packWARN>>, C<packWARN2>, C<packWARN3>,
2129 C<packWARN4> macros populated with the appropriate number of warning
2132 The two forms differ only in that C<ck_warner_d> should be used if warnings for
2133 any of the categories are by default enabled.
2136 This is like C<L</warner>>, but C<args> are an encapsulated argument list.
2141 #if defined(MULTIPLICITY)
2143 Perl_warner_nocontext(U32 err, const char *pat, ...)
2147 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
2148 va_start(args, pat);
2149 vwarner(err, pat, &args);
2152 #endif /* MULTIPLICITY */
2155 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
2157 PERL_ARGS_ASSERT_CK_WARNER_D;
2159 if (Perl_ckwarn_d(aTHX_ err)) {
2161 va_start(args, pat);
2162 vwarner(err, pat, &args);
2168 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
2170 PERL_ARGS_ASSERT_CK_WARNER;
2172 if (Perl_ckwarn(aTHX_ err)) {
2174 va_start(args, pat);
2175 vwarner(err, pat, &args);
2181 Perl_warner(pTHX_ U32 err, const char* pat,...)
2184 PERL_ARGS_ASSERT_WARNER;
2185 va_start(args, pat);
2186 vwarner(err, pat, &args);
2191 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
2193 PERL_ARGS_ASSERT_VWARNER;
2195 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
2196 !(PL_in_eval & EVAL_KEEPERR)
2198 SV * const msv = vmess(pat, args);
2200 if (PL_parser && PL_parser->error_count) {
2204 invoke_exception_hook(msv, FALSE);
2209 Perl_vwarn(aTHX_ pat, args);
2213 /* implements the ckWARN? macros */
2216 Perl_ckwarn(pTHX_ U32 w)
2218 /* If lexical warnings have not been set, use $^W. */
2220 return PL_dowarn & G_WARN_ON;
2222 return ckwarn_common(w);
2225 /* implements the ckWARN?_d macro */
2228 Perl_ckwarn_d(pTHX_ U32 w)
2230 /* If lexical warnings have not been set then default classes warn. */
2234 return ckwarn_common(w);
2238 S_ckwarn_common(pTHX_ U32 w)
2240 if (PL_curcop->cop_warnings == pWARN_ALL)
2243 if (PL_curcop->cop_warnings == pWARN_NONE)
2246 /* Check the assumption that at least the first slot is non-zero. */
2247 assert(unpackWARN1(w));
2249 /* Check the assumption that it is valid to stop as soon as a zero slot is
2251 if (!unpackWARN2(w)) {
2252 assert(!unpackWARN3(w));
2253 assert(!unpackWARN4(w));
2254 } else if (!unpackWARN3(w)) {
2255 assert(!unpackWARN4(w));
2258 /* Right, dealt with all the special cases, which are implemented as non-
2259 pointers, so there is a pointer to a real warnings mask. */
2261 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2263 } while (w >>= WARNshift);
2269 Perl_new_warnings_bitfield(pTHX_ char *buffer, const char *const bits,
2271 const MEM_SIZE len_wanted = (size > WARNsize ? size : WARNsize);
2272 PERL_UNUSED_CONTEXT;
2273 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2275 /* pass in null as the source string as we will do the
2276 * copy ourselves. */
2277 buffer = rcpv_new(NULL, len_wanted, RCPVf_NO_COPY);
2278 Copy(bits, buffer, size, char);
2279 if (size < WARNsize)
2280 Zero(buffer + size, WARNsize - size, char);
2284 /* since we've already done strlen() for both nam and val
2285 * we can use that info to make things faster than
2286 * sprintf(s, "%s=%s", nam, val)
2288 #define my_setenv_format(s, nam, nlen, val, vlen) \
2289 Copy(nam, s, nlen, char); \
2291 Copy(val, s+(nlen+1), vlen, char); \
2292 *(s+(nlen+1+vlen)) = '\0'
2296 #if defined(USE_ENVIRON_ARRAY) || defined(WIN32)
2297 /* NB: VMS' my_setenv() is in vms.c */
2299 /* small wrapper for use by Perl_my_setenv that mallocs, or reallocs if
2300 * 'current' is non-null, with up to three sizes that are added together.
2301 * It handles integer overflow.
2305 S_env_alloc(void *current, Size_t l1, Size_t l2, Size_t l3, Size_t size)
2308 Size_t sl, l = l1 + l2;
2320 ? safesysrealloc(current, sl)
2321 : safesysmalloc(sl);
2326 croak_memory_wrap();
2331 =for apidoc_section $utility
2332 =for apidoc my_setenv
2334 A wrapper for the C library L<setenv(3)>. Don't use the latter, as the perl
2335 version has desirable safeguards
2341 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2343 # if defined(USE_ITHREADS) && !defined(WIN32)
2344 /* only parent thread can modify process environment, so no need to use a
2346 if (PL_curinterp != aTHX)
2350 # if defined(HAS_SETENV) && defined(HAS_UNSETENV)
2354 setenv(nam, val, 1);
2357 # elif defined(HAS_UNSETENV)
2360 if (environ) /* old glibc can crash with null environ */
2363 const Size_t nlen = strlen(nam);
2364 const Size_t vlen = strlen(val);
2365 char * const new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2366 my_setenv_format(new_env, nam, nlen, val, vlen);
2370 # else /* ! HAS_UNSETENV */
2372 const Size_t nlen = strlen(nam);
2376 Size_t vlen = strlen(val);
2377 char *new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2378 /* all that work just for this */
2379 my_setenv_format(new_env, nam, nlen, val, vlen);
2383 PerlEnv_putenv(new_env);
2384 safesysfree(new_env);
2387 # endif /* HAS_SETENV */
2390 #endif /* USE_ENVIRON_ARRAY || WIN32 */
2392 #ifdef UNLINK_ALL_VERSIONS
2394 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2398 PERL_ARGS_ASSERT_UNLNK;
2400 while (PerlLIO_unlink(f) >= 0)
2402 return retries ? 0 : -1;
2407 #if (__CHARSET_LIB == 1)
2408 static int chgfdccsid(int fd, unsigned short ccsid)
2411 memset(&attr, 0, sizeof(attr));
2412 attr.att_filetagchg = 1;
2413 attr.att_filetag.ft_ccsid = ccsid;
2414 if (ccsid != FT_BINARY) {
2415 attr.att_filetag.ft_txtflag = 1;
2417 return __fchattr(fd, &attr, sizeof(attr));
2423 =for apidoc my_popen_list
2425 Implementing function on some systems for PerlProc_popen_list()
2431 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2433 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2441 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2443 PERL_FLUSHALL_FOR_CHILD;
2444 This = (*mode == 'w');
2448 taint_proper("Insecure %s%s", "EXEC");
2450 if (PerlProc_pipe_cloexec(p) < 0)
2452 /* Try for another pipe pair for error return */
2453 if (PerlProc_pipe_cloexec(pp) >= 0)
2455 while ((pid = PerlProc_fork()) < 0) {
2456 if (errno != EAGAIN) {
2457 PerlLIO_close(p[This]);
2458 PerlLIO_close(p[that]);
2460 PerlLIO_close(pp[0]);
2461 PerlLIO_close(pp[1]);
2465 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2474 /* Close parent's end of error status pipe (if any) */
2476 PerlLIO_close(pp[0]);
2478 #if (__CHARSET_LIB == 1)
2479 chgfdccsid(p[THIS], 819);
2480 chgfdccsid(p[THAT], 819);
2483 /* Now dup our end of _the_ pipe to right position */
2484 if (p[THIS] != (*mode == 'r')) {
2485 PerlLIO_dup2(p[THIS], *mode == 'r');
2486 PerlLIO_close(p[THIS]);
2487 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2488 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2491 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2492 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2494 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2495 /* No automatic close - do it by hand */
2502 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2508 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2515 PerlLIO_close(pp[1]);
2516 /* Keep the lower of the two fd numbers */
2517 if (p[that] < p[This]) {
2518 PerlLIO_dup2_cloexec(p[This], p[that]);
2519 PerlLIO_close(p[This]);
2523 PerlLIO_close(p[that]); /* close child's end of pipe */
2525 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2526 SvUPGRADE(sv,SVt_IV);
2528 PL_forkprocess = pid;
2529 /* If we managed to get status pipe check for exec fail */
2530 if (did_pipes && pid > 0) {
2532 unsigned read_total = 0;
2534 while (read_total < sizeof(int)) {
2535 const SSize_t n1 = PerlLIO_read(pp[0],
2536 (void*)(((char*)&errkid)+read_total),
2537 (sizeof(int)) - read_total);
2542 PerlLIO_close(pp[0]);
2544 if (read_total) { /* Error */
2546 PerlLIO_close(p[This]);
2547 if (read_total != sizeof(int))
2548 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", read_total);
2550 pid2 = wait4pid(pid, &status, 0);
2551 } while (pid2 == -1 && errno == EINTR);
2552 errno = errkid; /* Propagate errno from kid */
2557 PerlLIO_close(pp[0]);
2559 #if (__CHARSET_LIB == 1)
2560 PerlIO* io = PerlIO_fdopen(p[This], mode);
2562 chgfdccsid(p[This], 819);
2566 return PerlIO_fdopen(p[This], mode);
2569 return PerlIO_fdopen(p[This], mode);
2573 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2574 return my_syspopen4(aTHX_ NULL, mode, n, args);
2575 # elif defined(WIN32)
2576 return win32_popenlist(mode, n, args);
2578 Perl_croak(aTHX_ "List form of piped open not implemented");
2579 return (PerlIO *) NULL;
2584 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2585 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2588 =for apidoc_section $io
2589 =for apidoc my_popen
2591 A wrapper for the C library L<popen(3)>. Don't use the latter, as the Perl
2592 version knows things that interact with the rest of the perl interpreter.
2598 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2604 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2608 PERL_ARGS_ASSERT_MY_POPEN;
2610 PERL_FLUSHALL_FOR_CHILD;
2613 return my_syspopen(aTHX_ cmd,mode);
2616 This = (*mode == 'w');
2618 if (doexec && TAINTING_get) {
2620 taint_proper("Insecure %s%s", "EXEC");
2622 if (PerlProc_pipe_cloexec(p) < 0)
2624 if (doexec && PerlProc_pipe_cloexec(pp) >= 0)
2626 while ((pid = PerlProc_fork()) < 0) {
2627 if (errno != EAGAIN) {
2628 PerlLIO_close(p[This]);
2629 PerlLIO_close(p[that]);
2631 PerlLIO_close(pp[0]);
2632 PerlLIO_close(pp[1]);
2635 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2638 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2648 PerlLIO_close(pp[0]);
2650 #if (__CHARSET_LIB == 1)
2651 chgfdccsid(p[THIS], 819);
2652 chgfdccsid(p[THAT], 819);
2655 if (p[THIS] != (*mode == 'r')) {
2656 PerlLIO_dup2(p[THIS], *mode == 'r');
2657 PerlLIO_close(p[THIS]);
2658 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2659 PerlLIO_close(p[THAT]);
2662 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2663 PerlLIO_close(p[THAT]);
2667 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2674 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2679 /* may or may not use the shell */
2680 do_exec3(cmd, pp[1], did_pipes);
2683 #endif /* defined OS2 */
2685 #ifdef PERLIO_USING_CRLF
2686 /* Since we circumvent IO layers when we manipulate low-level
2687 filedescriptors directly, need to manually switch to the
2688 default, binary, low-level mode; see PerlIOBuf_open(). */
2689 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2692 #ifdef PERL_USES_PL_PIDSTATUS
2693 hv_clear(PL_pidstatus); /* we have no children */
2700 PerlLIO_close(pp[1]);
2701 if (p[that] < p[This]) {
2702 PerlLIO_dup2_cloexec(p[This], p[that]);
2703 PerlLIO_close(p[This]);
2707 PerlLIO_close(p[that]);
2709 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2710 SvUPGRADE(sv,SVt_IV);
2712 PL_forkprocess = pid;
2713 if (did_pipes && pid > 0) {
2717 while (n < sizeof(int)) {
2718 const SSize_t n1 = PerlLIO_read(pp[0],
2719 (void*)(((char*)&errkid)+n),
2725 PerlLIO_close(pp[0]);
2727 if (n) { /* Error */
2729 PerlLIO_close(p[This]);
2730 if (n != sizeof(int))
2731 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2733 pid2 = wait4pid(pid, &status, 0);
2734 } while (pid2 == -1 && errno == EINTR);
2735 errno = errkid; /* Propagate errno from kid */
2740 PerlLIO_close(pp[0]);
2742 #if (__CHARSET_LIB == 1)
2743 PerlIO* io = PerlIO_fdopen(p[This], mode);
2745 chgfdccsid(p[This], 819);
2749 return PerlIO_fdopen(p[This], mode);
2752 return PerlIO_fdopen(p[This], mode);
2755 #elif defined(__LIBCATAMOUNT__)
2757 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2762 #endif /* !DOSISH */
2764 /* this is called in parent before the fork() */
2766 Perl_atfork_lock(void)
2767 #if defined(USE_ITHREADS)
2769 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2772 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2774 PERL_TSA_ACQUIRE(PL_op_mutex)
2777 #if defined(USE_ITHREADS)
2778 /* locks must be held in locking order (if any) */
2780 MUTEX_LOCK(&PL_perlio_mutex);
2783 MUTEX_LOCK(&PL_malloc_mutex);
2789 /* this is called in both parent and child after the fork() */
2791 Perl_atfork_unlock(void)
2792 #if defined(USE_ITHREADS)
2794 PERL_TSA_RELEASE(PL_perlio_mutex)
2797 PERL_TSA_RELEASE(PL_malloc_mutex)
2799 PERL_TSA_RELEASE(PL_op_mutex)
2802 #if defined(USE_ITHREADS)
2803 /* locks must be released in same order as in atfork_lock() */
2805 MUTEX_UNLOCK(&PL_perlio_mutex);
2808 MUTEX_UNLOCK(&PL_malloc_mutex);
2815 =for apidoc_section $concurrency
2818 This is for the use of C<PerlProc_fork> as a wrapper for the C library
2819 L<fork(2)> on some platforms to hide some platform quirks. It should not be
2820 used except through C<PerlProc_fork>.
2829 #if defined(HAS_FORK)
2831 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2836 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2837 * handlers elsewhere in the code */
2841 #elif defined(__amigaos4__)
2842 return amigaos_fork();
2844 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2845 Perl_croak_nocontext("fork() not available");
2847 #endif /* HAS_FORK */
2852 dup2(int oldfd, int newfd)
2854 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2857 PerlLIO_close(newfd);
2858 return fcntl(oldfd, F_DUPFD, newfd);
2860 #define DUP2_MAX_FDS 256
2861 int fdtmp[DUP2_MAX_FDS];
2867 PerlLIO_close(newfd);
2868 /* good enough for low fd's... */
2869 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2870 if (fdx >= DUP2_MAX_FDS) {
2878 PerlLIO_close(fdtmp[--fdx]);
2885 #ifdef HAS_SIGACTION
2888 =for apidoc_section $signals
2891 A wrapper for the C library functions L<sigaction(2)> or L<signal(2)>.
2892 Use this instead of those libc functions, as the Perl version gives the
2893 safest available implementation, and knows things that interact with the
2894 rest of the perl interpreter.
2900 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2902 struct sigaction act, oact;
2905 /* only "parent" interpreter can diddle signals */
2906 if (PL_curinterp != aTHX)
2907 return (Sighandler_t) SIG_ERR;
2910 act.sa_handler = handler;
2911 sigemptyset(&act.sa_mask);
2914 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2915 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2917 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2918 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2919 act.sa_flags |= SA_NOCLDWAIT;
2921 if (sigaction(signo, &act, &oact) == -1)
2922 return (Sighandler_t) SIG_ERR;
2924 return (Sighandler_t) oact.sa_handler;
2928 =for apidoc_section $signals
2929 =for apidoc rsignal_state
2931 Returns a the current signal handler for signal C<signo>.
2938 Perl_rsignal_state(pTHX_ int signo)
2940 struct sigaction oact;
2941 PERL_UNUSED_CONTEXT;
2943 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2944 return (Sighandler_t) SIG_ERR;
2946 return (Sighandler_t) oact.sa_handler;
2950 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2952 struct sigaction act;
2954 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2957 /* only "parent" interpreter can diddle signals */
2958 if (PL_curinterp != aTHX)
2962 act.sa_handler = handler;
2963 sigemptyset(&act.sa_mask);
2966 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2967 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2969 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2970 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2971 act.sa_flags |= SA_NOCLDWAIT;
2973 return sigaction(signo, &act, save);
2977 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2979 PERL_UNUSED_CONTEXT;
2981 /* only "parent" interpreter can diddle signals */
2982 if (PL_curinterp != aTHX)
2986 return sigaction(signo, save, (struct sigaction *)NULL);
2989 #else /* !HAS_SIGACTION */
2992 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2994 #if defined(USE_ITHREADS) && !defined(WIN32)
2995 /* only "parent" interpreter can diddle signals */
2996 if (PL_curinterp != aTHX)
2997 return (Sighandler_t) SIG_ERR;
3000 return PerlProc_signal(signo, handler);
3010 Perl_rsignal_state(pTHX_ int signo)
3012 Sighandler_t oldsig;
3014 #if defined(USE_ITHREADS) && !defined(WIN32)
3015 /* only "parent" interpreter can diddle signals */
3016 if (PL_curinterp != aTHX)
3017 return (Sighandler_t) SIG_ERR;
3021 oldsig = PerlProc_signal(signo, sig_trap);
3022 PerlProc_signal(signo, oldsig);
3024 PerlProc_kill(PerlProc_getpid(), signo);
3029 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3031 #if defined(USE_ITHREADS) && !defined(WIN32)
3032 /* only "parent" interpreter can diddle signals */
3033 if (PL_curinterp != aTHX)
3036 *save = PerlProc_signal(signo, handler);
3037 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
3041 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3043 #if defined(USE_ITHREADS) && !defined(WIN32)
3044 /* only "parent" interpreter can diddle signals */
3045 if (PL_curinterp != aTHX)
3048 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
3051 #endif /* !HAS_SIGACTION */
3052 #endif /* !PERL_MICRO */
3054 /* VMS' my_pclose() is in VMS.c */
3057 =for apidoc_section $io
3058 =for apidoc my_pclose
3060 A wrapper for the C library L<pclose(3)>. Don't use the latter, as the Perl
3061 version knows things that interact with the rest of the perl interpreter.
3066 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
3068 Perl_my_pclose(pTHX_ PerlIO *ptr)
3076 const int fd = PerlIO_fileno(ptr);
3079 svp = av_fetch(PL_fdpid, fd, FALSE);
3081 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3088 #if defined(USE_PERLIO)
3089 /* Find out whether the refcount is low enough for us to wait for the
3090 child proc without blocking. */
3091 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
3093 should_wait = pid > 0;
3097 if (pid == -2) { /* Opened by popen. */
3098 return my_syspclose(ptr);
3101 close_failed = (PerlIO_close(ptr) == EOF);
3103 if (should_wait) do {
3104 pid2 = wait4pid(pid, &status, 0);
3105 } while (pid2 == -1 && errno == EINTR);
3112 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
3116 #elif defined(__LIBCATAMOUNT__)
3118 Perl_my_pclose(pTHX_ PerlIO *ptr)
3122 #endif /* !DOSISH */
3124 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32)) && !defined(__LIBCATAMOUNT__)
3126 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3129 PERL_ARGS_ASSERT_WAIT4PID;
3130 #ifdef PERL_USES_PL_PIDSTATUS
3132 /* PERL_USES_PL_PIDSTATUS is only defined when neither
3133 waitpid() nor wait4() is available, or on OS/2, which
3134 doesn't appear to support waiting for a progress group
3135 member, so we can only treat a 0 pid as an unknown child.
3142 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3143 pid, rather than a string form. */
3144 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3145 if (svp && *svp != &PL_sv_undef) {
3146 *statusp = SvIVX(*svp);
3147 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3155 hv_iterinit(PL_pidstatus);
3156 if ((entry = hv_iternext(PL_pidstatus))) {
3157 SV * const sv = hv_iterval(PL_pidstatus,entry);
3159 const char * const spid = hv_iterkey(entry,&len);
3161 assert (len == sizeof(Pid_t));
3162 memcpy((char *)&pid, spid, len);
3163 *statusp = SvIVX(sv);
3164 /* The hash iterator is currently on this entry, so simply
3165 calling hv_delete would trigger the lazy delete, which on
3166 aggregate does more work, because next call to hv_iterinit()
3167 would spot the flag, and have to call the delete routine,
3168 while in the meantime any new entries can't re-use that
3170 hv_iterinit(PL_pidstatus);
3171 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3178 # ifdef HAS_WAITPID_RUNTIME
3179 if (!HAS_WAITPID_RUNTIME)
3182 result = PerlProc_waitpid(pid,statusp,flags);
3185 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3186 result = wait4(pid,statusp,flags,NULL);
3189 #ifdef PERL_USES_PL_PIDSTATUS
3190 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3195 Perl_croak(aTHX_ "Can't do waitpid with flags");
3197 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3198 pidgone(result,*statusp);
3204 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3207 if (result < 0 && errno == EINTR) {
3209 errno = EINTR; /* reset in case a signal handler changed $! */
3213 #endif /* !DOSISH || OS2 || WIN32 */
3215 #ifdef PERL_USES_PL_PIDSTATUS
3217 S_pidgone(pTHX_ Pid_t pid, int status)
3221 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3222 SvUPGRADE(sv,SVt_IV);
3223 SvIV_set(sv, status);
3231 int /* Cannot prototype with I32
3233 my_syspclose(PerlIO *ptr)
3236 Perl_my_pclose(pTHX_ PerlIO *ptr)
3239 /* Needs work for PerlIO ! */
3240 FILE * const f = PerlIO_findFILE(ptr);
3241 const I32 result = pclose(f);
3242 PerlIO_releaseFILE(ptr,f);
3248 =for apidoc repeatcpy
3250 Make C<count> copies of the C<len> bytes beginning at C<from>, placing them
3251 into memory beginning at C<to>, which must be big enough to accommodate them
3257 #define PERL_REPEATCPY_LINEAR 4
3259 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3261 PERL_ARGS_ASSERT_REPEATCPY;
3266 croak_memory_wrap();
3269 memset(to, *from, count);
3272 IV items, linear, half;
3274 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3275 for (items = 0; items < linear; ++items) {
3276 const char *q = from;
3278 for (todo = len; todo > 0; todo--)
3283 while (items <= half) {
3284 IV size = items * len;
3285 memcpy(p, to, size);
3291 memcpy(p, to, (count - items) * len);
3297 Perl_same_dirent(pTHX_ const char *a, const char *b)
3299 char *fa = strrchr(a,'/');
3300 char *fb = strrchr(b,'/');
3303 SV * const tmpsv = sv_newmortal();
3305 PERL_ARGS_ASSERT_SAME_DIRENT;
3318 sv_setpvs(tmpsv, ".");
3320 sv_setpvn(tmpsv, a, fa - a);
3321 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3324 sv_setpvs(tmpsv, ".");
3326 sv_setpvn(tmpsv, b, fb - b);
3327 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3329 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3330 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3332 #endif /* !HAS_RENAME */
3335 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3336 const char *const *const search_ext, I32 flags)
3338 const char *xfound = NULL;
3339 char *xfailed = NULL;
3340 char tmpbuf[MAXPATHLEN];
3345 #if defined(DOSISH) && !defined(OS2)
3346 # define SEARCH_EXTS ".bat", ".cmd", NULL
3347 # define MAX_EXT_LEN 4
3350 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3351 # define MAX_EXT_LEN 4
3354 # define SEARCH_EXTS ".pl", ".com", NULL
3355 # define MAX_EXT_LEN 4
3357 /* additional extensions to try in each dir if scriptname not found */
3359 static const char *const exts[] = { SEARCH_EXTS };
3360 const char *const *const ext = search_ext ? search_ext : exts;
3361 int extidx = 0, i = 0;
3362 const char *curext = NULL;
3364 PERL_UNUSED_ARG(search_ext);
3365 # define MAX_EXT_LEN 0
3368 PERL_ARGS_ASSERT_FIND_SCRIPT;
3371 * If dosearch is true and if scriptname does not contain path
3372 * delimiters, search the PATH for scriptname.
3374 * If SEARCH_EXTS is also defined, will look for each
3375 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3376 * while searching the PATH.
3378 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3379 * proceeds as follows:
3380 * If DOSISH or VMSISH:
3381 * + look for ./scriptname{,.foo,.bar}
3382 * + search the PATH for scriptname{,.foo,.bar}
3385 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3386 * this will not look in '.' if it's not in the PATH)
3391 # ifdef ALWAYS_DEFTYPES
3392 len = strlen(scriptname);
3393 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3394 int idx = 0, deftypes = 1;
3397 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3400 int idx = 0, deftypes = 1;
3403 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3405 /* The first time through, just add SEARCH_EXTS to whatever we
3406 * already have, so we can check for default file types. */
3408 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3415 if ((strlen(tmpbuf) + strlen(scriptname)
3416 + MAX_EXT_LEN) >= sizeof tmpbuf)
3417 continue; /* don't search dir with too-long name */
3418 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3422 if (strEQ(scriptname, "-"))
3424 if (dosearch) { /* Look in '.' first. */
3425 const char *cur = scriptname;
3427 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3429 if (strEQ(ext[i++],curext)) {
3430 extidx = -1; /* already has an ext */
3435 DEBUG_p(PerlIO_printf(Perl_debug_log,
3436 "Looking for %s\n",cur));
3439 if (PerlLIO_stat(cur,&statbuf) >= 0
3440 && !S_ISDIR(statbuf.st_mode)) {
3449 if (cur == scriptname) {
3450 len = strlen(scriptname);
3451 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3453 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3456 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3457 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3462 if (dosearch && !strchr(scriptname, '/')
3464 && !strchr(scriptname, '\\')
3466 && (s = PerlEnv_getenv("PATH")))
3470 bufend = s + strlen(s);
3471 while (s < bufend) {
3475 && *s != ';'; len++, s++) {
3476 if (len < sizeof tmpbuf)
3479 if (len < sizeof tmpbuf)
3482 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3487 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3488 continue; /* don't search dir with too-long name */
3491 && tmpbuf[len - 1] != '/'
3492 && tmpbuf[len - 1] != '\\'
3495 tmpbuf[len++] = '/';
3496 if (len == 2 && tmpbuf[0] == '.')
3498 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3502 len = strlen(tmpbuf);
3503 if (extidx > 0) /* reset after previous loop */
3507 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3508 retval = PerlLIO_stat(tmpbuf,&statbuf);
3509 if (S_ISDIR(statbuf.st_mode)) {
3513 } while ( retval < 0 /* not there */
3514 && extidx>=0 && ext[extidx] /* try an extension? */
3515 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3520 if (S_ISREG(statbuf.st_mode)
3521 && cando(S_IRUSR,TRUE,&statbuf)
3522 #if !defined(DOSISH)
3523 && cando(S_IXUSR,TRUE,&statbuf)
3527 xfound = tmpbuf; /* bingo! */
3531 xfailed = savepv(tmpbuf);
3536 if (!xfound && !seen_dot && !xfailed &&
3537 (PerlLIO_stat(scriptname,&statbuf) < 0
3538 || S_ISDIR(statbuf.st_mode)))
3540 seen_dot = 1; /* Disable message. */
3545 if (flags & 1) { /* do or die? */
3546 /* diag_listed_as: Can't execute %s */
3547 Perl_croak(aTHX_ "Can't %s %s%s%s",
3548 (xfailed ? "execute" : "find"),
3549 (xfailed ? xfailed : scriptname),
3550 (xfailed ? "" : " on PATH"),
3551 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3556 scriptname = xfound;
3558 return (scriptname ? savepv(scriptname) : NULL);
3561 #ifndef PERL_GET_CONTEXT_DEFINED
3564 =for apidoc_section $embedding
3565 =for apidoc set_context
3567 Implements L<perlapi/C<PERL_SET_CONTEXT>>, which you should use instead.
3573 Perl_set_context(void *t)
3575 PERL_ARGS_ASSERT_SET_CONTEXT;
3576 #if defined(USE_ITHREADS)
3577 # ifdef PERL_USE_THREAD_LOCAL
3578 PL_current_context = t;
3580 # ifdef I_MACH_CTHREADS
3581 cthread_set_data(cthread_self(), t);
3583 /* We set thread-specific value always, as C++ code has to read it with
3584 * pthreads, because the declaration syntax for thread local storage for C11
3585 * is incompatible with C++, meaning that we can't expose the thread local
3586 * variable to C++ code. */
3588 const int error = pthread_setspecific(PL_thr_key, t);
3590 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3594 PERL_SET_NON_tTHX_CONTEXT(t);
3601 #endif /* !PERL_GET_CONTEXT_DEFINED */
3604 =for apidoc get_op_names
3606 Return a pointer to the array of all the names of the various OPs
3607 Given an opcode from the enum in F<opcodes.h>, C<PL_op_name[opcode]> returns a
3608 pointer to a C language string giving its name.
3614 Perl_get_op_names(pTHX)
3616 PERL_UNUSED_CONTEXT;
3617 return (char **)PL_op_name;
3621 =for apidoc get_op_descs
3623 Return a pointer to the array of all the descriptions of the various OPs
3624 Given an opcode from the enum in F<opcodes.h>, C<PL_op_desc[opcode]> returns a
3625 pointer to a C language string giving its description.
3631 Perl_get_op_descs(pTHX)
3633 PERL_UNUSED_CONTEXT;
3634 return (char **)PL_op_desc;
3638 Perl_get_no_modify(pTHX)
3640 PERL_UNUSED_CONTEXT;
3641 return PL_no_modify;
3645 Perl_get_opargs(pTHX)
3647 PERL_UNUSED_CONTEXT;
3648 return (U32 *)PL_opargs;
3652 Perl_get_ppaddr(pTHX)
3654 PERL_UNUSED_CONTEXT;
3655 return (PPADDR_t*)PL_ppaddr;
3658 #ifndef HAS_GETENV_LEN
3660 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3662 char * const env_trans = PerlEnv_getenv(env_elem);
3663 PERL_UNUSED_CONTEXT;
3664 PERL_ARGS_ASSERT_GETENV_LEN;
3666 *len = strlen(env_trans);
3672 =for apidoc_section $io
3673 =for apidoc my_fflush_all
3675 Implements C<PERL_FLUSHALL_FOR_CHILD> on some platforms.
3681 Perl_my_fflush_all(pTHX)
3683 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3684 return PerlIO_flush(NULL);
3686 # if defined(HAS__FWALK)
3687 extern int fflush(FILE *);
3688 /* undocumented, unprototyped, but very useful BSDism */
3689 extern void _fwalk(int (*)(FILE *));
3693 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3695 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3696 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3697 # elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3698 open_max = sysconf(_SC_OPEN_MAX);
3699 # elif defined(FOPEN_MAX)
3700 open_max = FOPEN_MAX;
3701 # elif defined(OPEN_MAX)
3702 open_max = OPEN_MAX;
3703 # elif defined(_NFILE)
3708 for (i = 0; i < open_max; i++)
3709 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3710 STDIO_STREAM_ARRAY[i]._file < open_max &&
3711 STDIO_STREAM_ARRAY[i]._flag)
3712 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3716 SETERRNO(EBADF,RMS_IFI);
3723 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3725 if (ckWARN(WARN_IO)) {
3727 = gv && (isGV_with_GP(gv))
3730 const char * const direction = have == '>' ? "out" : "in";
3732 if (name && HEK_LEN(name))
3733 Perl_warner(aTHX_ packWARN(WARN_IO),
3734 "Filehandle %" HEKf " opened only for %sput",
3735 HEKfARG(name), direction);
3737 Perl_warner(aTHX_ packWARN(WARN_IO),
3738 "Filehandle opened only for %sput", direction);
3743 Perl_report_evil_fh(pTHX_ const GV *gv)
3745 const IO *io = gv ? GvIO(gv) : NULL;
3746 const PERL_BITFIELD16 op = PL_op->op_type;
3750 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3752 warn_type = WARN_CLOSED;
3756 warn_type = WARN_UNOPENED;
3759 if (ckWARN(warn_type)) {
3761 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3762 newSVhek_mortal(GvENAME_HEK(gv)) : NULL;
3763 const char * const pars =
3764 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3765 const char * const func =
3767 (op == OP_READLINE || op == OP_RCATLINE
3768 ? "readline" : /* "<HANDLE>" not nice */
3769 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3771 const char * const type =
3773 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3774 ? "socket" : "filehandle");
3775 const bool have_name = name && SvCUR(name);
3776 Perl_warner(aTHX_ packWARN(warn_type),
3777 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3778 have_name ? " " : "",
3779 SVfARG(have_name ? name : &PL_sv_no));
3780 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3782 aTHX_ packWARN(warn_type),
3783 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3784 func, pars, have_name ? " " : "",
3785 SVfARG(have_name ? name : &PL_sv_no)
3790 /* To workaround core dumps from the uninitialised tm_zone we get the
3791 * system to give us a reasonable struct to copy. This fix means that
3792 * strftime uses the tm_zone and tm_gmtoff values returned by
3793 * localtime(time()). That should give the desired result most of the
3794 * time. But probably not always!
3796 * This does not address tzname aspects of NETaa14816.
3801 # ifndef STRUCT_TM_HASZONE
3802 # define STRUCT_TM_HASZONE
3806 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3807 # ifndef HAS_TM_TM_ZONE
3808 # define HAS_TM_TM_ZONE
3813 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3815 #ifdef HAS_TM_TM_ZONE
3817 const struct tm* my_tm;
3818 PERL_UNUSED_CONTEXT;
3819 PERL_ARGS_ASSERT_INIT_TM;
3823 my_tm = localtime(&now);
3825 Copy(my_tm, ptm, 1, struct tm);
3828 PERL_UNUSED_CONTEXT;
3829 PERL_ARGS_ASSERT_INIT_TM;
3830 PERL_UNUSED_ARG(ptm);
3835 =for apidoc_section $time
3836 =for apidoc mini_mktime
3837 normalise S<C<struct tm>> values without the localtime() semantics (and
3838 overhead) of mktime().
3843 Perl_mini_mktime(struct tm *ptm)
3847 int month, mday, year, jday;
3848 int odd_cent, odd_year;
3850 PERL_ARGS_ASSERT_MINI_MKTIME;
3852 #define DAYS_PER_YEAR 365
3853 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3854 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3855 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3856 #define SECS_PER_HOUR (60*60)
3857 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3858 /* parentheses deliberately absent on these two, otherwise they don't work */
3859 #define MONTH_TO_DAYS 153/5
3860 #define DAYS_TO_MONTH 5/153
3861 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3862 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3863 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3864 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3867 * Year/day algorithm notes:
3869 * With a suitable offset for numeric value of the month, one can find
3870 * an offset into the year by considering months to have 30.6 (153/5) days,
3871 * using integer arithmetic (i.e., with truncation). To avoid too much
3872 * messing about with leap days, we consider January and February to be
3873 * the 13th and 14th month of the previous year. After that transformation,
3874 * we need the month index we use to be high by 1 from 'normal human' usage,
3875 * so the month index values we use run from 4 through 15.
3877 * Given that, and the rules for the Gregorian calendar (leap years are those
3878 * divisible by 4 unless also divisible by 100, when they must be divisible
3879 * by 400 instead), we can simply calculate the number of days since some
3880 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3881 * the days we derive from our month index, and adding in the day of the
3882 * month. The value used here is not adjusted for the actual origin which
3883 * it normally would use (1 January A.D. 1), since we're not exposing it.
3884 * We're only building the value so we can turn around and get the
3885 * normalised values for the year, month, day-of-month, and day-of-year.
3887 * For going backward, we need to bias the value we're using so that we find
3888 * the right year value. (Basically, we don't want the contribution of
3889 * March 1st to the number to apply while deriving the year). Having done
3890 * that, we 'count up' the contribution to the year number by accounting for
3891 * full quadracenturies (400-year periods) with their extra leap days, plus
3892 * the contribution from full centuries (to avoid counting in the lost leap
3893 * days), plus the contribution from full quad-years (to count in the normal
3894 * leap days), plus the leftover contribution from any non-leap years.
3895 * At this point, if we were working with an actual leap day, we'll have 0
3896 * days left over. This is also true for March 1st, however. So, we have
3897 * to special-case that result, and (earlier) keep track of the 'odd'
3898 * century and year contributions. If we got 4 extra centuries in a qcent,
3899 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3900 * Otherwise, we add back in the earlier bias we removed (the 123 from
3901 * figuring in March 1st), find the month index (integer division by 30.6),
3902 * and the remainder is the day-of-month. We then have to convert back to
3903 * 'real' months (including fixing January and February from being 14/15 in
3904 * the previous year to being in the proper year). After that, to get
3905 * tm_yday, we work with the normalised year and get a new yearday value for
3906 * January 1st, which we subtract from the yearday value we had earlier,
3907 * representing the date we've re-built. This is done from January 1
3908 * because tm_yday is 0-origin.
3910 * Since POSIX time routines are only guaranteed to work for times since the
3911 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3912 * applies Gregorian calendar rules even to dates before the 16th century
3913 * doesn't bother me. Besides, you'd need cultural context for a given
3914 * date to know whether it was Julian or Gregorian calendar, and that's
3915 * outside the scope for this routine. Since we convert back based on the
3916 * same rules we used to build the yearday, you'll only get strange results
3917 * for input which needed normalising, or for the 'odd' century years which
3918 * were leap years in the Julian calendar but not in the Gregorian one.
3919 * I can live with that.
3921 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3922 * that's still outside the scope for POSIX time manipulation, so I don't
3928 year = 1900 + ptm->tm_year;
3929 month = ptm->tm_mon;
3930 mday = ptm->tm_mday;
3936 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3937 yearday += month*MONTH_TO_DAYS + mday + jday;
3939 * Note that we don't know when leap-seconds were or will be,
3940 * so we have to trust the user if we get something which looks
3941 * like a sensible leap-second. Wild values for seconds will
3942 * be rationalised, however.
3944 if ((unsigned) ptm->tm_sec <= 60) {
3951 secs += 60 * ptm->tm_min;
3952 secs += SECS_PER_HOUR * ptm->tm_hour;
3954 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3955 /* got negative remainder, but need positive time */
3956 /* back off an extra day to compensate */
3957 yearday += (secs/SECS_PER_DAY)-1;
3958 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3961 yearday += (secs/SECS_PER_DAY);
3962 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3965 else if (secs >= SECS_PER_DAY) {
3966 yearday += (secs/SECS_PER_DAY);
3967 secs %= SECS_PER_DAY;
3969 ptm->tm_hour = secs/SECS_PER_HOUR;
3970 secs %= SECS_PER_HOUR;
3971 ptm->tm_min = secs/60;
3973 ptm->tm_sec += secs;
3974 /* done with time of day effects */
3976 * The algorithm for yearday has (so far) left it high by 428.
3977 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3978 * bias it by 123 while trying to figure out what year it
3979 * really represents. Even with this tweak, the reverse
3980 * translation fails for years before A.D. 0001.
3981 * It would still fail for Feb 29, but we catch that one below.
3983 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3984 yearday -= YEAR_ADJUST;
3985 year = (yearday / DAYS_PER_QCENT) * 400;
3986 yearday %= DAYS_PER_QCENT;
3987 odd_cent = yearday / DAYS_PER_CENT;
3988 year += odd_cent * 100;
3989 yearday %= DAYS_PER_CENT;
3990 year += (yearday / DAYS_PER_QYEAR) * 4;
3991 yearday %= DAYS_PER_QYEAR;
3992 odd_year = yearday / DAYS_PER_YEAR;
3994 yearday %= DAYS_PER_YEAR;
3995 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
4000 yearday += YEAR_ADJUST; /* recover March 1st crock */
4001 month = yearday*DAYS_TO_MONTH;
4002 yearday -= month*MONTH_TO_DAYS;
4003 /* recover other leap-year adjustment */
4012 ptm->tm_year = year - 1900;
4014 ptm->tm_mday = yearday;
4015 ptm->tm_mon = month;
4019 ptm->tm_mon = month - 1;
4021 /* re-build yearday based on Jan 1 to get tm_yday */
4023 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
4024 yearday += 14*MONTH_TO_DAYS + 1;
4025 ptm->tm_yday = jday - yearday;
4026 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
4029 #define SV_CWD_RETURN_UNDEF \
4033 #define SV_CWD_ISDOT(dp) \
4034 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4035 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4038 =for apidoc_section $utility
4040 =for apidoc getcwd_sv
4042 Fill C<sv> with current working directory
4047 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4048 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4049 * getcwd(3) if available
4050 * Comments from the original:
4051 * This is a faster version of getcwd. It's also more dangerous
4052 * because you might chdir out of a directory that you can't chdir
4056 Perl_getcwd_sv(pTHX_ SV *sv)
4061 PERL_ARGS_ASSERT_GETCWD_SV;
4065 char buf[MAXPATHLEN];
4067 /* Some getcwd()s automatically allocate a buffer of the given
4068 * size from the heap if they are given a NULL buffer pointer.
4069 * The problem is that this behaviour is not portable. */
4070 if (getcwd(buf, sizeof(buf) - 1)) {
4075 SV_CWD_RETURN_UNDEF;
4082 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4086 SvUPGRADE(sv, SVt_PV);
4088 if (PerlLIO_lstat(".", &statbuf) < 0) {
4089 SV_CWD_RETURN_UNDEF;
4092 orig_cdev = statbuf.st_dev;
4093 orig_cino = statbuf.st_ino;
4103 if (PerlDir_chdir("..") < 0) {
4104 SV_CWD_RETURN_UNDEF;
4106 if (PerlLIO_stat(".", &statbuf) < 0) {
4107 SV_CWD_RETURN_UNDEF;
4110 cdev = statbuf.st_dev;
4111 cino = statbuf.st_ino;
4113 if (odev == cdev && oino == cino) {
4116 if (!(dir = PerlDir_open("."))) {
4117 SV_CWD_RETURN_UNDEF;
4120 while ((dp = PerlDir_read(dir)) != NULL) {
4122 namelen = dp->d_namlen;
4124 namelen = strlen(dp->d_name);
4127 if (SV_CWD_ISDOT(dp)) {
4131 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4132 SV_CWD_RETURN_UNDEF;
4135 tdev = statbuf.st_dev;
4136 tino = statbuf.st_ino;
4137 if (tino == oino && tdev == odev) {
4143 SV_CWD_RETURN_UNDEF;
4146 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4147 SV_CWD_RETURN_UNDEF;
4150 SvGROW(sv, pathlen + namelen + 1);
4154 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4157 /* prepend current directory to the front */
4159 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4160 pathlen += (namelen + 1);
4162 #ifdef VOID_CLOSEDIR
4165 if (PerlDir_close(dir) < 0) {
4166 SV_CWD_RETURN_UNDEF;
4172 SvCUR_set(sv, pathlen);
4176 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4177 SV_CWD_RETURN_UNDEF;
4180 if (PerlLIO_stat(".", &statbuf) < 0) {
4181 SV_CWD_RETURN_UNDEF;
4184 cdev = statbuf.st_dev;
4185 cino = statbuf.st_ino;
4187 if (cdev != orig_cdev || cino != orig_cino) {
4188 Perl_croak(aTHX_ "Unstable directory path, "
4189 "current directory changed unexpectedly");
4202 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4203 # define EMULATE_SOCKETPAIR_UDP
4206 #ifdef EMULATE_SOCKETPAIR_UDP
4208 S_socketpair_udp (int fd[2]) {
4210 /* Fake a datagram socketpair using UDP to localhost. */
4211 int sockets[2] = {-1, -1};
4212 struct sockaddr_in addresses[2];
4214 Sock_size_t size = sizeof(struct sockaddr_in);
4215 unsigned short port;
4218 memset(&addresses, 0, sizeof(addresses));
4221 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4222 if (sockets[i] == -1)
4223 goto tidy_up_and_fail;
4225 addresses[i].sin_family = AF_INET;
4226 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4227 addresses[i].sin_port = 0; /* kernel chooses port. */
4228 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4229 sizeof(struct sockaddr_in)) == -1)
4230 goto tidy_up_and_fail;
4233 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4234 for each connect the other socket to it. */
4237 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4239 goto tidy_up_and_fail;
4240 if (size != sizeof(struct sockaddr_in))
4241 goto abort_tidy_up_and_fail;
4242 /* !1 is 0, !0 is 1 */
4243 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4244 sizeof(struct sockaddr_in)) == -1)
4245 goto tidy_up_and_fail;
4248 /* Now we have 2 sockets connected to each other. I don't trust some other
4249 process not to have already sent a packet to us (by random) so send
4250 a packet from each to the other. */
4253 /* I'm going to send my own port number. As a short.
4254 (Who knows if someone somewhere has sin_port as a bitfield and needs
4255 this routine. (I'm assuming crays have socketpair)) */
4256 port = addresses[i].sin_port;
4257 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4258 if (got != sizeof(port)) {
4260 goto tidy_up_and_fail;
4261 goto abort_tidy_up_and_fail;
4265 /* Packets sent. I don't trust them to have arrived though.
4266 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4267 connect to localhost will use a second kernel thread. In 2.6 the
4268 first thread running the connect() returns before the second completes,
4269 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4270 returns 0. Poor programs have tripped up. One poor program's authors'
4271 had a 50-1 reverse stock split. Not sure how connected these were.)
4272 So I don't trust someone not to have an unpredictable UDP stack.
4276 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4277 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4281 FD_SET((unsigned int)sockets[0], &rset);
4282 FD_SET((unsigned int)sockets[1], &rset);
4284 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4285 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4286 || !FD_ISSET(sockets[1], &rset)) {
4287 /* I hope this is portable and appropriate. */
4289 goto tidy_up_and_fail;
4290 goto abort_tidy_up_and_fail;
4294 /* And the paranoia department even now doesn't trust it to have arrive
4295 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4297 struct sockaddr_in readfrom;
4298 unsigned short buffer[2];
4303 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4304 sizeof(buffer), MSG_DONTWAIT,
4305 (struct sockaddr *) &readfrom, &size);
4307 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4309 (struct sockaddr *) &readfrom, &size);
4313 goto tidy_up_and_fail;
4314 if (got != sizeof(port)
4315 || size != sizeof(struct sockaddr_in)
4316 /* Check other socket sent us its port. */
4317 || buffer[0] != (unsigned short) addresses[!i].sin_port
4318 /* Check kernel says we got the datagram from that socket */
4319 || readfrom.sin_family != addresses[!i].sin_family
4320 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4321 || readfrom.sin_port != addresses[!i].sin_port)
4322 goto abort_tidy_up_and_fail;
4325 /* My caller (my_socketpair) has validated that this is non-NULL */
4328 /* I hereby declare this connection open. May God bless all who cross
4332 abort_tidy_up_and_fail:
4333 errno = ECONNABORTED;
4337 if (sockets[0] != -1)
4338 PerlLIO_close(sockets[0]);
4339 if (sockets[1] != -1)
4340 PerlLIO_close(sockets[1]);
4345 #endif /* EMULATE_SOCKETPAIR_UDP */
4347 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4350 =for apidoc my_socketpair
4352 Emulates L<socketpair(2)> on systems that don't have it, but which do have
4353 enough functionality for the emulation.
4359 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4360 /* Stevens says that family must be AF_LOCAL, protocol 0.
4361 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4366 struct sockaddr_in listen_addr;
4367 struct sockaddr_in connect_addr;
4372 || family != AF_UNIX
4375 errno = EAFNOSUPPORT;
4384 type &= ~SOCK_CLOEXEC;
4387 #ifdef EMULATE_SOCKETPAIR_UDP
4388 if (type == SOCK_DGRAM)
4389 return S_socketpair_udp(fd);
4392 aTHXa(PERL_GET_THX);
4393 listener = PerlSock_socket(AF_INET, type, 0);
4396 memset(&listen_addr, 0, sizeof(listen_addr));
4397 listen_addr.sin_family = AF_INET;
4398 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4399 listen_addr.sin_port = 0; /* kernel chooses port. */
4400 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4401 sizeof(listen_addr)) == -1)
4402 goto tidy_up_and_fail;
4403 if (PerlSock_listen(listener, 1) == -1)
4404 goto tidy_up_and_fail;
4406 connector = PerlSock_socket(AF_INET, type, 0);
4407 if (connector == -1)
4408 goto tidy_up_and_fail;
4409 /* We want to find out the port number to connect to. */
4410 size = sizeof(connect_addr);
4411 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4413 goto tidy_up_and_fail;
4414 if (size != sizeof(connect_addr))
4415 goto abort_tidy_up_and_fail;
4416 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4417 sizeof(connect_addr)) == -1)
4418 goto tidy_up_and_fail;
4420 size = sizeof(listen_addr);
4421 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4424 goto tidy_up_and_fail;
4425 if (size != sizeof(listen_addr))
4426 goto abort_tidy_up_and_fail;
4427 PerlLIO_close(listener);
4428 /* Now check we are talking to ourself by matching port and host on the
4430 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4432 goto tidy_up_and_fail;
4433 if (size != sizeof(connect_addr)
4434 || listen_addr.sin_family != connect_addr.sin_family
4435 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4436 || listen_addr.sin_port != connect_addr.sin_port) {
4437 goto abort_tidy_up_and_fail;
4443 abort_tidy_up_and_fail:
4445 errno = ECONNABORTED; /* This would be the standard thing to do. */
4446 #elif defined(ECONNREFUSED)
4447 errno = ECONNREFUSED; /* some OSes might not have ECONNABORTED. */
4449 errno = ETIMEDOUT; /* Desperation time. */
4455 PerlLIO_close(listener);
4456 if (connector != -1)
4457 PerlLIO_close(connector);
4459 PerlLIO_close(acceptor);
4465 /* In any case have a stub so that there's code corresponding
4466 * to the my_socketpair in embed.fnc. */
4468 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4469 #ifdef HAS_SOCKETPAIR
4470 return socketpair(family, type, protocol, fd);
4479 =for apidoc sv_nosharing
4481 Dummy routine which "shares" an SV when there is no sharing module present.
4482 Or "locks" it. Or "unlocks" it. In other
4483 words, ignores its single SV argument.
4484 Exists to avoid test for a C<NULL> function pointer and because it could
4485 potentially warn under some level of strict-ness.
4491 Perl_sv_nosharing(pTHX_ SV *sv)
4493 PERL_UNUSED_CONTEXT;
4494 PERL_UNUSED_ARG(sv);
4499 =for apidoc sv_destroyable
4501 Dummy routine which reports that object can be destroyed when there is no
4502 sharing module present. It ignores its single SV argument, and returns
4503 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4504 could potentially warn under some level of strict-ness.
4510 Perl_sv_destroyable(pTHX_ SV *sv)
4512 PERL_UNUSED_CONTEXT;
4513 PERL_UNUSED_ARG(sv);
4518 Perl_parse_unicode_opts(pTHX_ const char **popt)
4520 const char *p = *popt;
4523 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4527 const char* endptr = p + strlen(p);
4529 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4532 if (p && *p && *p != '\n' && *p != '\r') {
4534 goto the_end_of_the_opts_parser;
4536 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4540 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4546 case PERL_UNICODE_STDIN:
4547 opt |= PERL_UNICODE_STDIN_FLAG; break;
4548 case PERL_UNICODE_STDOUT:
4549 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4550 case PERL_UNICODE_STDERR:
4551 opt |= PERL_UNICODE_STDERR_FLAG; break;
4552 case PERL_UNICODE_STD:
4553 opt |= PERL_UNICODE_STD_FLAG; break;
4554 case PERL_UNICODE_IN:
4555 opt |= PERL_UNICODE_IN_FLAG; break;
4556 case PERL_UNICODE_OUT:
4557 opt |= PERL_UNICODE_OUT_FLAG; break;
4558 case PERL_UNICODE_INOUT:
4559 opt |= PERL_UNICODE_INOUT_FLAG; break;
4560 case PERL_UNICODE_LOCALE:
4561 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4562 case PERL_UNICODE_ARGV:
4563 opt |= PERL_UNICODE_ARGV_FLAG; break;
4564 case PERL_UNICODE_UTF8CACHEASSERT:
4565 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4567 if (*p != '\n' && *p != '\r') {
4568 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4571 "Unknown Unicode option letter '%c'", *p);
4578 opt = PERL_UNICODE_DEFAULT_FLAGS;
4580 the_end_of_the_opts_parser:
4582 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4583 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4584 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4592 # include <starlet.h>
4595 /* hash a pointer and return a U32
4597 * this code was derived from Sereal, which was derived from autobox.
4600 PERL_STATIC_INLINE U32 S_ptr_hash(PTRV u) {
4603 * This is one of Thomas Wang's hash functions for 64-bit integers from:
4604 * http://www.concentric.net/~Ttwang/tech/inthash.htm
4606 u = (~u) + (u << 18);
4614 * This is one of Bob Jenkins' hash functions for 32-bit integers
4615 * from: http://burtleburtle.net/bob/hash/integer.html
4617 u = (u + 0x7ed55d16) + (u << 12);
4618 u = (u ^ 0xc761c23c) ^ (u >> 19);
4619 u = (u + 0x165667b1) + (u << 5);
4620 u = (u + 0xd3a2646c) ^ (u << 9);
4621 u = (u + 0xfd7046c5) + (u << 3);
4622 u = (u ^ 0xb55a4f09) ^ (u >> 16);
4632 * This is really just a quick hack which grabs various garbage
4633 * values. It really should be a real hash algorithm which
4634 * spreads the effect of every input bit onto every output bit,
4635 * if someone who knows about such things would bother to write it.
4636 * Might be a good idea to add that function to CORE as well.
4637 * No numbers below come from careful analysis or anything here,
4638 * except they are primes and SEED_C1 > 1E6 to get a full-width
4639 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4640 * probably be bigger too.
4643 # define SEED_C1 1000003
4644 #define SEED_C4 73819
4646 # define SEED_C1 25747
4647 #define SEED_C4 20639
4651 #define SEED_C5 26107
4653 #ifndef PERL_NO_DEV_RANDOM
4657 #ifdef HAS_GETTIMEOFDAY
4658 struct timeval when;
4663 /* This test is an escape hatch, this symbol isn't set by Configure. */
4664 #ifndef PERL_NO_DEV_RANDOM
4665 #ifndef PERL_RANDOM_DEVICE
4666 /* /dev/random isn't used by default because reads from it will block
4667 * if there isn't enough entropy available. You can compile with
4668 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4669 * is enough real entropy to fill the seed. */
4670 # ifdef __amigaos4__
4671 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4673 # define PERL_RANDOM_DEVICE "/dev/urandom"
4676 fd = PerlLIO_open_cloexec(PERL_RANDOM_DEVICE, 0);
4678 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4686 #ifdef HAS_GETTIMEOFDAY
4687 PerlProc_gettimeofday(&when,NULL);
4688 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4691 u = (U32)SEED_C1 * when;
4693 u += SEED_C3 * (U32)PerlProc_getpid();
4694 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4695 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4696 UV ptruv = PTR2UV(&when);
4697 u += SEED_C5 * ptr_hash(ptruv);
4703 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4705 #ifndef NO_PERL_HASH_ENV
4710 PERL_ARGS_ASSERT_GET_HASH_SEED;
4712 Zero(seed_buffer, PERL_HASH_SEED_BYTES, U8);
4713 Zero((U8*)PL_hash_state_w, PERL_HASH_STATE_BYTES, U8);
4715 #ifndef NO_PERL_HASH_ENV
4716 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4721 PerlIO_printf(Perl_debug_log,"Got PERL_HASH_SEED=<%s>\n", env_pv);
4722 /* ignore leading spaces */
4723 while (isSPACE(*env_pv))
4725 # ifdef USE_PERL_PERTURB_KEYS
4726 /* if they set it to "0" we disable key traversal randomization completely */
4727 if (strEQ(env_pv,"0")) {
4728 PL_hash_rand_bits_enabled= 0;
4730 /* otherwise switch to deterministic mode */
4731 PL_hash_rand_bits_enabled= 2;
4734 /* ignore a leading 0x... if it is there */
4735 if (env_pv[0] == '0' && env_pv[1] == 'x')
4738 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4739 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4740 if ( isXDIGIT(*env_pv)) {
4741 seed_buffer[i] |= READ_XDIGIT(env_pv);
4744 while (isSPACE(*env_pv))
4747 if (*env_pv && !isXDIGIT(*env_pv)) {
4748 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4750 /* should we check for unparsed crap? */
4751 /* should we warn about unused hex? */
4752 /* should we warn about insufficient hex? */
4755 #endif /* NO_PERL_HASH_ENV */
4757 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4758 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
4761 #ifdef USE_PERL_PERTURB_KEYS
4762 # ifndef NO_PERL_HASH_ENV
4763 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4766 PerlIO_printf(Perl_debug_log,
4767 "Got PERL_PERTURB_KEYS=<%s>\n", env_pv);
4768 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4769 PL_hash_rand_bits_enabled= 0;
4770 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4771 PL_hash_rand_bits_enabled= 1;
4772 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4773 PL_hash_rand_bits_enabled= 2;
4775 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4779 { /* initialize PL_hash_rand_bits from the hash seed.
4780 * This value is highly volatile, it is updated every
4781 * hash insert, and is used as part of hash bucket chain
4782 * randomization and hash iterator randomization. */
4783 if (PL_hash_rand_bits_enabled == 1) {
4784 /* random mode initialize from seed() like we would our RNG() */
4785 PL_hash_rand_bits= seed();
4788 /* Use a constant */
4789 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4790 /* and then mix in the leading bytes of the hash seed */
4791 for( i = 0; i < sizeof(UV) ; i++ ) {
4792 PL_hash_rand_bits ^= seed_buffer[i % PERL_HASH_SEED_BYTES];
4793 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4796 if (!PL_hash_rand_bits) {
4797 /* we use an XORSHIFT RNG to munge PL_hash_rand_bits,
4798 * which means it cannot be 0 or it will stay 0 for the
4799 * lifetime of the process, so if by some insane chance we
4800 * ended up with a 0 after the above initialization
4801 * then set it to this. This really should not happen, or
4802 * very very very rarely.
4804 PL_hash_rand_bits = 0x8110ba9d; /* a randomly chosen prime */
4811 Perl_debug_hash_seed(pTHX_ bool via_debug_h)
4813 PERL_ARGS_ASSERT_DEBUG_HASH_SEED;
4814 #if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
4816 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
4817 bool via_env = cBOOL(s && strNE(s, "0") && strNE(s,""));
4819 if ( via_env != via_debug_h ) {
4820 const unsigned char *seed= PERL_HASH_SEED;
4821 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
4822 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
4823 while (seed < seed_end) {
4824 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
4826 #ifdef PERL_HASH_RANDOMIZE_KEYS
4827 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
4828 PL_HASH_RAND_BITS_ENABLED,
4829 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" :
4830 PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM"
4833 PerlIO_printf(Perl_debug_log,
4834 " RAND_BITS=0x%" UVxf, PL_hash_rand_bits);
4836 PerlIO_printf(Perl_debug_log, "\n");
4839 #endif /* #if (defined(USE_HASH_SEED) ... */
4847 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4848 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4849 * given, and you supply your own implementation.
4851 * The default implementation reads a single env var, PERL_MEM_LOG,
4852 * expecting one or more of the following:
4854 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4855 * 'm' - memlog was PERL_MEM_LOG=1
4856 * 's' - svlog was PERL_SV_LOG=1
4857 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4859 * This makes the logger controllable enough that it can reasonably be
4860 * added to the system perl.
4863 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4864 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4866 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 256
4868 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4869 * writes to. In the default logger, this is settable at runtime.
4871 #ifndef PERL_MEM_LOG_FD
4872 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4875 #ifndef PERL_MEM_LOG_NOIMPL
4877 # ifdef DEBUG_LEAKING_SCALARS
4878 # define SV_LOG_SERIAL_FMT " [%lu]"
4879 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4881 # define SV_LOG_SERIAL_FMT
4882 # define _SV_LOG_SERIAL_ARG(sv)
4886 S_mem_log_common(enum mem_log_type mlt, const UV n,
4887 const UV typesize, const char *type_name, const SV *sv,
4888 Malloc_t oldalloc, Malloc_t newalloc,
4889 const char *filename, const int linenumber,
4890 const char *funcname)
4895 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4897 PL_mem_log[0] |= 0x2; /* Flag that the call is from this code */
4898 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4899 PL_mem_log[0] &= ~0x2;
4902 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4904 /* We can't use SVs or PerlIO for obvious reasons,
4905 * so we'll use stdio and low-level IO instead. */
4906 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4908 # ifdef HAS_GETTIMEOFDAY
4909 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4910 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4912 PerlProc_gettimeofday(&tv, 0);
4914 # define MEM_LOG_TIME_FMT "%10d: "
4915 # define MEM_LOG_TIME_ARG (int)when
4919 /* If there are other OS specific ways of hires time than
4920 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4921 * probably that they would be used to fill in the struct
4925 const char* endptr = pmlenv + strlen(pmlenv);
4928 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4929 && uv && uv <= PERL_INT_MAX
4933 fd = PERL_MEM_LOG_FD;
4936 if (strchr(pmlenv, 't')) {
4937 len = my_snprintf(buf, sizeof(buf),
4938 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4939 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4943 len = my_snprintf(buf, sizeof(buf),
4944 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4945 " %s = %" IVdf ": %" UVxf "\n",
4946 filename, linenumber, funcname, n, typesize,
4947 type_name, n * typesize, PTR2UV(newalloc));
4950 len = my_snprintf(buf, sizeof(buf),
4951 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4952 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4953 filename, linenumber, funcname, n, typesize,
4954 type_name, n * typesize, PTR2UV(oldalloc),
4958 len = my_snprintf(buf, sizeof(buf),
4959 "free: %s:%d:%s: %" UVxf "\n",
4960 filename, linenumber, funcname,
4965 len = my_snprintf(buf, sizeof(buf),
4966 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
4967 mlt == MLT_NEW_SV ? "new" : "del",
4968 filename, linenumber, funcname,
4969 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4974 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4975 #ifdef USE_C_BACKTRACE
4976 if(strchr(pmlenv,'c') && (mlt == MLT_NEW_SV)) {
4977 len = my_snprintf(buf, sizeof(buf),
4978 " caller %s at %s line %" LINE_Tf "\n",
4979 /* CopSTASHPV can crash early on startup; use CopFILE to check */
4980 CopFILE(PL_curcop) ? CopSTASHPV(PL_curcop) : "<unknown>",
4981 CopFILE(PL_curcop), CopLINE(PL_curcop));
4982 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4984 Perl_c_backtrace *bt = Perl_get_c_backtrace(aTHX_ 3, 3);
4985 Perl_c_backtrace_frame *frame;
4987 for (i = 0, frame = bt->frame_info;
4988 i < bt->header.frame_count;
4990 len = my_snprintf(buf, sizeof(buf),
4991 " frame[%" UVuf "]: %p %s at %s +0x%lx\n",
4994 frame->symbol_name_size && frame->symbol_name_offset ? (char *)bt + frame->symbol_name_offset : "-",
4995 frame->object_name_size && frame->object_name_offset ? (char *)bt + frame->object_name_offset : "?",
4996 (char *)frame->addr - (char *)frame->object_base_addr);
4997 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4999 Perl_free_c_backtrace(bt);
5001 #endif /* USE_C_BACKTRACE */
5005 #endif /* !PERL_MEM_LOG_NOIMPL */
5007 #ifndef PERL_MEM_LOG_NOIMPL
5009 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
5010 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
5012 /* this is suboptimal, but bug compatible. User is providing their
5013 own implementation, but is getting these functions anyway, and they
5014 do nothing. But _NOIMPL users should be able to cope or fix */
5016 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
5017 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
5021 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
5023 const char *filename, const int linenumber,
5024 const char *funcname)
5026 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
5028 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
5029 NULL, NULL, newalloc,
5030 filename, linenumber, funcname);
5035 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
5036 Malloc_t oldalloc, Malloc_t newalloc,
5037 const char *filename, const int linenumber,
5038 const char *funcname)
5040 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
5042 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
5043 NULL, oldalloc, newalloc,
5044 filename, linenumber, funcname);
5049 Perl_mem_log_free(Malloc_t oldalloc,
5050 const char *filename, const int linenumber,
5051 const char *funcname)
5053 PERL_ARGS_ASSERT_MEM_LOG_FREE;
5055 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
5056 filename, linenumber, funcname);
5061 Perl_mem_log_new_sv(const SV *sv,
5062 const char *filename, const int linenumber,
5063 const char *funcname)
5065 PERL_ARGS_ASSERT_MEM_LOG_NEW_SV;
5067 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
5068 filename, linenumber, funcname);
5072 Perl_mem_log_del_sv(const SV *sv,
5073 const char *filename, const int linenumber,
5074 const char *funcname)
5076 PERL_ARGS_ASSERT_MEM_LOG_DEL_SV;
5078 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
5079 filename, linenumber, funcname);
5082 #endif /* PERL_MEM_LOG */
5085 =for apidoc_section $string
5086 =for apidoc quadmath_format_valid
5088 C<quadmath_snprintf()> is very strict about its C<format> string and will
5089 fail, returning -1, if the format is invalid. It accepts exactly
5092 C<quadmath_format_valid()> checks that the intended single spec looks
5093 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
5094 and has C<Q> before it. This is not a full "printf syntax check",
5097 Returns true if it is valid, false if not.
5099 See also L</quadmath_format_needed>.
5105 Perl_quadmath_format_valid(const char* format)
5109 PERL_ARGS_ASSERT_QUADMATH_FORMAT_VALID;
5111 if (format[0] != '%' || strchr(format + 1, '%'))
5113 len = strlen(format);
5114 /* minimum length three: %Qg */
5115 if (len < 3 || memCHRs("efgaEFGA", format[len - 1]) == NULL)
5117 if (format[len - 2] != 'Q')
5124 =for apidoc quadmath_format_needed
5126 C<quadmath_format_needed()> returns true if the C<format> string seems to
5127 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
5128 or returns false otherwise.
5130 The format specifier detection is not complete printf-syntax detection,
5131 but it should catch most common cases.
5133 If true is returned, those arguments B<should> in theory be processed
5134 with C<quadmath_snprintf()>, but in case there is more than one such
5135 format specifier (see L</quadmath_format_valid>), and if there is
5136 anything else beyond that one (even just a single byte), they
5137 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
5138 accepting only one format spec, and nothing else.
5139 In this case, the code should probably fail.
5145 Perl_quadmath_format_needed(const char* format)
5147 const char *p = format;
5150 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5152 while ((q = strchr(p, '%'))) {
5154 if (*q == '+') /* plus */
5156 if (*q == '#') /* alt */
5158 if (*q == '*') /* width */
5162 while (isDIGIT(*q)) q++;
5165 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5170 while (isDIGIT(*q)) q++;
5172 if (memCHRs("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5181 =for apidoc my_snprintf
5183 The C library C<snprintf> functionality, if available and
5184 standards-compliant (uses C<vsnprintf>, actually). However, if the
5185 C<vsnprintf> is not available, will unfortunately use the unsafe
5186 C<vsprintf> which can overrun the buffer (there is an overrun check,
5187 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5188 getting C<vsnprintf>.
5194 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5200 PERL_ARGS_ASSERT_MY_SNPRINTF;
5201 #ifndef HAS_VSNPRINTF
5202 PERL_UNUSED_VAR(len);
5204 va_start(ap, format);
5207 bool quadmath_valid = FALSE;
5209 if (quadmath_format_valid(format)) {
5210 /* If the format looked promising, use it as quadmath. */
5211 WITH_LC_NUMERIC_SET_TO_NEEDED(
5212 retval = quadmath_snprintf(buffer, len, format, va_arg(ap, NV));
5215 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5217 quadmath_valid = TRUE;
5219 /* quadmath_format_single() will return false for example for
5220 * "foo = %g", or simply "%g". We could handle the %g by
5221 * using quadmath for the NV args. More complex cases of
5222 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5223 * quadmath-valid but has stuff in front).
5225 * Handling the "Q-less" cases right would require walking
5226 * through the va_list and rewriting the format, calling
5227 * quadmath for the NVs, building a new va_list, and then
5228 * letting vsnprintf/vsprintf to take care of the other
5229 * arguments. This may be doable.
5231 * We do not attempt that now. But for paranoia, we here try
5232 * to detect some common (but not all) cases where the
5233 * "Q-less" %[efgaEFGA] formats are present, and die if
5234 * detected. This doesn't fix the problem, but it stops the
5235 * vsnprintf/vsprintf pulling doubles off the va_list when
5236 * __float128 NVs should be pulled off instead.
5238 * If quadmath_format_needed() returns false, we are reasonably
5239 * certain that we can call vnsprintf() or vsprintf() safely. */
5240 if (!quadmath_valid && quadmath_format_needed(format))
5241 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5247 #ifdef HAS_VSNPRINTF
5248 WITH_LC_NUMERIC_SET_TO_NEEDED(
5249 retval = vsnprintf(buffer, len, format, ap);
5252 WITH_LC_NUMERIC_SET_TO_NEEDED(
5253 retval = vsprintf(buffer, format, ap);
5260 /* vsprintf() shows failure with < 0 */
5262 #ifdef HAS_VSNPRINTF
5263 /* vsnprintf() shows failure with >= len */
5265 (len > 0 && (Size_t)retval >= len)
5268 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5273 =for apidoc my_vsnprintf
5275 The C library C<vsnprintf> if available and standards-compliant.
5276 However, if the C<vsnprintf> is not available, will unfortunately
5277 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5278 overrun check, but that may be too late). Consider using
5279 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5285 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5288 PERL_UNUSED_ARG(buffer);
5289 PERL_UNUSED_ARG(len);
5290 PERL_UNUSED_ARG(format);
5291 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5292 PERL_UNUSED_ARG((void*)ap);
5293 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5299 # ifdef NEED_VA_COPY
5302 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5303 Perl_va_copy(ap, apc);
5304 # ifdef HAS_VSNPRINTF
5306 WITH_LC_NUMERIC_SET_TO_NEEDED(
5307 retval = vsnprintf(buffer, len, format, apc);
5310 PERL_UNUSED_ARG(len);
5311 WITH_LC_NUMERIC_SET_TO_NEEDED(
5312 retval = vsprintf(buffer, format, apc);
5318 # ifdef HAS_VSNPRINTF
5319 WITH_LC_NUMERIC_SET_TO_NEEDED(
5320 retval = vsnprintf(buffer, len, format, ap);
5323 PERL_UNUSED_ARG(len);
5324 WITH_LC_NUMERIC_SET_TO_NEEDED(
5325 retval = vsprintf(buffer, format, ap);
5328 # endif /* #ifdef NEED_VA_COPY */
5330 /* vsprintf() shows failure with < 0 */
5332 # ifdef HAS_VSNPRINTF
5333 /* vsnprintf() shows failure with >= len */
5335 (len > 0 && (Size_t)retval >= len)
5338 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5345 Perl_my_clearenv(pTHX)
5347 #if ! defined(PERL_MICRO)
5348 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5350 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5351 # if defined(USE_ENVIRON_ARRAY)
5352 # if defined(USE_ITHREADS)
5353 /* only the parent thread can clobber the process environment, so no need
5355 if (PL_curinterp != aTHX)
5357 # endif /* USE_ITHREADS */
5358 # if defined(HAS_CLEARENV)
5360 # elif defined(HAS_UNSETENV)
5361 int bsiz = 80; /* Most envvar names will be shorter than this. */
5362 char *buf = (char*)safesysmalloc(bsiz);
5363 while (*environ != NULL) {
5364 char *e = strchr(*environ, '=');
5365 int l = e ? e - *environ : (int)strlen(*environ);
5368 bsiz = l + 1; /* + 1 for the \0. */
5369 buf = (char*)safesysmalloc(bsiz);
5371 memcpy(buf, *environ, l);
5376 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5377 /* Just null environ and accept the leakage. */
5379 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5380 # endif /* USE_ENVIRON_ARRAY */
5381 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5382 #endif /* PERL_MICRO */
5388 =for apidoc my_cxt_init
5390 Implements the L<perlxs/C<MY_CXT_INIT>> macro, which you should use instead.
5392 The first time a module is loaded, the global C<PL_my_cxt_index> is incremented,
5393 and that value is assigned to that module's static C<my_cxt_index> (whose
5394 address is passed as an arg). Then, for each interpreter this function is
5395 called for, it makes sure a C<void*> slot is available to hang the static data
5396 off, by allocating or extending the interpreter's C<PL_my_cxt_list> array
5402 Perl_my_cxt_init(pTHX_ int *indexp, size_t size)
5407 PERL_ARGS_ASSERT_MY_CXT_INIT;
5410 /* do initial check without locking.
5411 * -1: not allocated or another thread currently allocating
5412 * other: already allocated by another thread
5415 MUTEX_LOCK(&PL_my_ctx_mutex);
5416 /*now a stricter check with locking */
5419 /* this module hasn't been allocated an index yet */
5420 *indexp = PL_my_cxt_index++;
5422 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5425 /* make sure the array is big enough */
5426 if (PL_my_cxt_size <= index) {
5427 if (PL_my_cxt_size) {
5428 IV new_size = PL_my_cxt_size;
5429 while (new_size <= index)
5431 Renew(PL_my_cxt_list, new_size, void *);
5432 PL_my_cxt_size = new_size;
5435 PL_my_cxt_size = 16;
5436 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5439 /* newSV() allocates one more than needed */
5440 p = (void*)SvPVX(newSV(size-1));
5441 PL_my_cxt_list[index] = p;
5442 Zero(p, size, char);
5446 #endif /* MULTIPLICITY */
5449 /* Perl_xs_handshake():
5450 implement the various XS_*_BOOTCHECK macros, which are added to .c
5451 files by ExtUtils::ParseXS, to check that the perl the module was built
5452 with is binary compatible with the running perl.
5455 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5456 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5458 The meaning of the varargs is determined the U32 key arg (which is not
5459 a format string). The fields of key are assembled by using HS_KEY().
5461 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5462 "PerlInterpreter *" and represents the callers context; otherwise it is
5463 of type "CV *", and is the boot xsub's CV.
5465 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5466 for example, and IO.dll was linked with threaded perl524.dll, and both
5467 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5468 successfully can load IO.dll into the process but simultaneously it
5469 loaded an interpreter of a different version into the process, and XS
5470 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5471 use through perl526.dll's my_perl->Istack_base.
5473 v_my_perl cannot be the first arg, since then 'key' will be out of
5474 place in a threaded vs non-threaded mixup; and analyzing the key
5475 number's bitfields won't reveal the problem, since it will be a valid
5476 key (unthreaded perl) on interp side, but croak will report the XS mod's
5477 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5478 it's a threaded perl and an unthreaded XS module, threaded perl will
5479 look at an uninit C stack or an uninit register to get 'key'
5480 (remember that it assumes that the 1st arg is the interp cxt).
5482 'file' is the source filename of the caller.
5486 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5492 const char *stage = "first";
5500 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5501 va_start(args, file);
5503 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5504 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5505 if (UNLIKELY(got != need))
5507 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5508 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5509 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5510 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5511 passed to the XS DLL */
5513 xs_interp = (tTHX)v_my_perl;
5517 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5518 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5519 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5520 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5521 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5522 location in the unthreaded perl binary) stored in CV * to figure out if this
5523 Perl_xs_handshake was called by the same pp_entersub */
5524 cv = (CV*)v_my_perl;
5525 xs_spp = (SV***)CvHSCXT(cv);
5527 need = &PL_stack_sp;
5530 if(UNLIKELY(got != need)) {
5531 bad_handshake:/* recycle branch and string from above */
5532 if(got != (void *)HSf_NOCHK)
5533 noperl_die("%s: loadable library and perl binaries are mismatched"
5534 " (got %s handshake key %p, needed %p)\n",
5535 file, stage, got, need);
5538 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5539 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5540 PL_xsubfilename = file; /* so the old name must be restored for
5541 additional XSUBs to register themselves */
5542 /* XSUBs can't be perl lang/perl5db.pl debugged
5543 if (PERLDB_LINE_OR_SAVESRC)
5544 (void)gv_fetchfile(file); */
5547 if(key & HSf_POPMARK) {
5549 { SV **mark = PL_stack_base + ax++;
5551 items = (I32)(SP - MARK);
5555 items = va_arg(args, U32);
5556 ax = va_arg(args, U32);
5560 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5561 if((apiverlen = HS_GETAPIVERLEN(key))) {
5562 char * api_p = va_arg(args, char*);
5563 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5564 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5565 sizeof("v" PERL_API_VERSION_STRING)-1))
5566 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5567 api_p, SVfARG(PL_stack_base[ax + 0]),
5568 "v" PERL_API_VERSION_STRING);
5572 U32 xsverlen = HS_GETXSVERLEN(key);
5573 assert(xsverlen <= UCHAR_MAX && xsverlen <= HS_APIVERLEN_MAX);
5575 S_xs_version_bootcheck(aTHX_
5576 items, ax, va_arg(args, char*), xsverlen);
5584 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5588 const char *vn = NULL;
5589 SV *const module = PL_stack_base[ax];
5591 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5593 if (items >= 2) /* version supplied as bootstrap arg */
5594 sv = PL_stack_base[ax + 1];
5596 /* XXX GV_ADDWARN */
5598 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5599 if (!sv || !SvOK(sv)) {
5601 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5605 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5606 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5607 ? sv : sv_2mortal(new_version(sv));
5608 xssv = upg_version(xssv, 0);
5609 if ( vcmp(pmsv,xssv) ) {
5610 SV *string = vstringify(xssv);
5611 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5612 " does not match ", SVfARG(module), SVfARG(string));
5614 SvREFCNT_dec(string);
5615 string = vstringify(pmsv);
5618 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5621 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5623 SvREFCNT_dec(string);
5625 Perl_sv_2mortal(aTHX_ xpt);
5626 Perl_croak_sv(aTHX_ xpt);
5631 PERL_STATIC_INLINE bool
5632 S_gv_has_usable_name(pTHX_ GV *gv)
5636 && HvHasENAME(GvSTASH(gv))
5637 && (gvp = (GV **)hv_fetchhek(
5638 GvSTASH(gv), GvNAME_HEK(gv), 0
5644 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5646 SV * const dbsv = GvSVn(PL_DBsub);
5647 const bool save_taint = TAINT_get;
5649 /* When we are called from pp_goto (svp is null),
5650 * we do not care about using dbsv to call CV;
5651 * it's for informational purposes only.
5654 PERL_ARGS_ASSERT_GET_DB_SUB;
5658 if (!PERLDB_SUB_NN) {
5661 if (!svp && !CvLEXICAL(cv)) {
5662 gv_efullname3(dbsv, gv, NULL);
5664 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5665 || strEQ(GvNAME(gv), "END")
5666 || ( /* Could be imported, and old sub redefined. */
5667 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5669 !( (SvTYPE(*svp) == SVt_PVGV)
5670 && (GvCV((const GV *)*svp) == cv)
5671 /* Use GV from the stack as a fallback. */
5672 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5676 /* GV is potentially non-unique, or contain different CV. */
5677 SV * const tmp = newRV(MUTABLE_SV(cv));
5678 sv_setsv(dbsv, tmp);
5682 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5683 sv_catpvs(dbsv, "::");
5684 sv_cathek(dbsv, GvNAME_HEK(gv));
5688 const int type = SvTYPE(dbsv);
5689 if (type < SVt_PVIV && type != SVt_IV)
5690 sv_upgrade(dbsv, SVt_PVIV);
5691 (void)SvIOK_on(dbsv);
5692 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5695 TAINT_IF(save_taint);
5696 #ifdef NO_TAINT_SUPPORT
5697 PERL_UNUSED_VAR(save_taint);
5702 =for apidoc_section $io
5703 =for apidoc my_dirfd
5705 The C library C<L<dirfd(3)>> if available, or a Perl implementation of it, or die
5706 if not easily emulatable.
5712 Perl_my_dirfd(DIR * dir) {
5714 /* Most dirfd implementations have problems when passed NULL. */
5719 #elif defined(HAS_DIR_DD_FD)
5722 Perl_croak_nocontext(PL_no_func, "dirfd");
5723 NOT_REACHED; /* NOTREACHED */
5728 #if !defined(HAS_MKOSTEMP) || !defined(HAS_MKSTEMP)
5730 #define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
5731 #define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
5734 S_my_mkostemp(char *templte, int flags) {
5736 STRLEN len = strlen(templte);
5740 int delete_on_close = flags & O_VMS_DELETEONCLOSE;
5742 flags &= ~O_VMS_DELETEONCLOSE;
5746 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
5747 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
5748 SETERRNO(EINVAL, LIB_INVARG);
5754 for (i = 1; i <= 6; ++i) {
5755 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
5758 if (delete_on_close) {
5759 fd = open(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600, "fop=dlt");
5764 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600);
5766 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
5773 #ifndef HAS_MKOSTEMP
5776 =for apidoc my_mkostemp
5778 The C library C<L<mkostemp(3)>> if available, or a Perl implementation of it.
5784 Perl_my_mkostemp(char *templte, int flags)
5786 PERL_ARGS_ASSERT_MY_MKOSTEMP;
5787 return S_my_mkostemp(templte, flags);
5794 =for apidoc my_mkstemp
5796 The C library C<L<mkstemp(3)>> if available, or a Perl implementation of it.
5802 Perl_my_mkstemp(char *templte)
5804 PERL_ARGS_ASSERT_MY_MKSTEMP;
5805 return S_my_mkostemp(templte, 0);
5810 Perl_get_re_arg(pTHX_ SV *sv) {
5816 sv = MUTABLE_SV(SvRV(sv));
5817 if (SvTYPE(sv) == SVt_REGEXP)
5818 return (REGEXP*) sv;
5825 * This code is derived from drand48() implementation from FreeBSD,
5826 * found in lib/libc/gen/_rand48.c.
5828 * The U64 implementation is original, based on the POSIX
5829 * specification for drand48().
5833 * Copyright (c) 1993 Martin Birgmeier
5834 * All rights reserved.
5836 * You may redistribute unmodified or modified versions of this source
5837 * code provided that the above copyright notice and this and the
5838 * following conditions are retained.
5840 * This software is provided ``as is'', and comes with no warranties
5841 * of any kind. I shall in no event be liable for anything that happens
5842 * to anyone/anything when using this software.
5845 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5847 #ifdef PERL_DRAND48_QUAD
5849 #define DRAND48_MULT UINT64_C(0x5deece66d)
5850 #define DRAND48_ADD 0xb
5851 #define DRAND48_MASK UINT64_C(0xffffffffffff)
5855 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5856 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5857 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5858 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5859 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5860 #define FREEBSD_DRAND48_ADD (0x000b)
5862 const unsigned short _rand48_mult[3] = {
5863 FREEBSD_DRAND48_MULT_0,
5864 FREEBSD_DRAND48_MULT_1,
5865 FREEBSD_DRAND48_MULT_2
5867 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5872 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5874 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5876 #ifdef PERL_DRAND48_QUAD
5877 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5879 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5880 random_state->seed[1] = (U16) seed;
5881 random_state->seed[2] = (U16) (seed >> 16);
5886 Perl_drand48_r(perl_drand48_t *random_state)
5888 PERL_ARGS_ASSERT_DRAND48_R;
5890 #ifdef PERL_DRAND48_QUAD
5891 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5894 return ldexp((double)*random_state, -48);
5900 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5901 + (U32) _rand48_add;
5902 temp[0] = (U16) accu; /* lower 16 bits */
5903 accu >>= sizeof(U16) * 8;
5904 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5905 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5906 temp[1] = (U16) accu; /* middle 16 bits */
5907 accu >>= sizeof(U16) * 8;
5908 accu += _rand48_mult[0] * random_state->seed[2]
5909 + _rand48_mult[1] * random_state->seed[1]
5910 + _rand48_mult[2] * random_state->seed[0];
5911 random_state->seed[0] = temp[0];
5912 random_state->seed[1] = temp[1];
5913 random_state->seed[2] = (U16) accu;
5915 return ldexp((double) random_state->seed[0], -48) +
5916 ldexp((double) random_state->seed[1], -32) +
5917 ldexp((double) random_state->seed[2], -16);
5922 #ifdef USE_C_BACKTRACE
5924 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5929 /* abfd is the BFD handle. */
5931 /* bfd_syms is the BFD symbol table. */
5933 /* bfd_text is handle to the ".text" section of the object file. */
5935 /* Since opening the executable and scanning its symbols is quite
5936 * heavy operation, we remember the filename we used the last time,
5937 * and do the opening and scanning only if the filename changes.
5938 * This removes most (but not all) open+scan cycles. */
5939 const char* fname_prev;
5942 /* Given a dl_info, update the BFD context if necessary. */
5943 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5945 /* BFD open and scan only if the filename changed. */
5946 if (ctx->fname_prev == NULL ||
5947 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5949 bfd_close(ctx->abfd);
5951 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5953 if (bfd_check_format(ctx->abfd, bfd_object)) {
5954 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5955 if (symbol_size > 0) {
5956 Safefree(ctx->bfd_syms);
5957 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5959 bfd_get_section_by_name(ctx->abfd, ".text");
5967 ctx->fname_prev = dl_info->dli_fname;
5971 /* Given a raw frame, try to symbolize it and store
5972 * symbol information (source file, line number) away. */
5973 static void bfd_symbolize(bfd_context* ctx,
5976 STRLEN* symbol_name_size,
5978 STRLEN* source_name_size,
5979 STRLEN* source_line)
5981 *symbol_name = NULL;
5982 *symbol_name_size = 0;
5984 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5986 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5989 unsigned int line = 0;
5990 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5991 ctx->bfd_syms, offset,
5992 &file, &func, &line) &&
5993 file && func && line > 0) {
5994 /* Size and copy the source file, use only
5995 * the basename of the source file.
5997 * NOTE: the basenames are fine for the
5998 * Perl source files, but may not always
5999 * be the best idea for XS files. */
6000 const char *p, *b = NULL;
6001 /* Look for the last slash. */
6002 for (p = file; *p; p++) {
6006 if (b == NULL || *b == 0) {
6009 *source_name_size = p - b + 1;
6010 Newx(*source_name, *source_name_size + 1, char);
6011 Copy(b, *source_name, *source_name_size + 1, char);
6013 *symbol_name_size = strlen(func);
6014 Newx(*symbol_name, *symbol_name_size + 1, char);
6015 Copy(func, *symbol_name, *symbol_name_size + 1, char);
6017 *source_line = line;
6023 #endif /* #ifdef USE_BFD */
6027 /* OS X has no public API for for 'symbolicating' (Apple official term)
6028 * stack addresses to {function_name, source_file, line_number}.
6029 * Good news: there is command line utility atos(1) which does that.
6030 * Bad news 1: it's a command line utility.
6031 * Bad news 2: one needs to have the Developer Tools installed.
6032 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
6034 * To recap: we need to open a pipe for reading for a utility which
6035 * might not exist, or exists in different locations, and then parse
6036 * the output. And since this is all for a low-level API, we cannot
6037 * use high-level stuff. Thanks, Apple. */
6040 /* tool is set to the absolute pathname of the tool to use:
6043 /* format is set to a printf format string used for building
6044 * the external command to run. */
6046 /* unavail is set if e.g. xcrun cannot be found, or something
6047 * else happens that makes getting the backtrace dubious. Note,
6048 * however, that the context isn't persistent, the next call to
6049 * get_c_backtrace() will start from scratch. */
6051 /* fname is the current object file name. */
6053 /* object_base_addr is the base address of the shared object. */
6054 void* object_base_addr;
6057 /* Given |dl_info|, updates the context. If the context has been
6058 * marked unavailable, return immediately. If not but the tool has
6059 * not been set, set it to either "xcrun atos" or "atos" (also set the
6060 * format to use for creating commands for piping), or if neither is
6061 * unavailable (one needs the Developer Tools installed), mark the context
6062 * an unavailable. Finally, update the filename (object name),
6063 * and its base address. */
6065 static void atos_update(atos_context* ctx,
6070 if (ctx->tool == NULL) {
6071 const char* tools[] = {
6075 const char* formats[] = {
6076 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6077 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6081 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6082 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6083 ctx->tool = tools[i];
6084 ctx->format = formats[i];
6088 if (ctx->tool == NULL) {
6089 ctx->unavail = TRUE;
6093 if (ctx->fname == NULL ||
6094 strNE(dl_info->dli_fname, ctx->fname)) {
6095 ctx->fname = dl_info->dli_fname;
6096 ctx->object_base_addr = dl_info->dli_fbase;
6100 /* Given an output buffer end |p| and its |start|, matches
6101 * for the atos output, extracting the source code location
6102 * and returning non-NULL if possible, returning NULL otherwise. */
6103 static const char* atos_parse(const char* p,
6105 STRLEN* source_name_size,
6106 STRLEN* source_line) {
6107 /* atos() output is something like:
6108 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6109 * We cannot use Perl regular expressions, because we need to
6110 * stay low-level. Therefore here we have a rolled-out version
6111 * of a state machine which matches _backwards_from_the_end_ and
6112 * if there's a success, returns the starts of the filename,
6113 * also setting the filename size and the source line number.
6114 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6115 const char* source_number_start;
6116 const char* source_name_end;
6117 const char* source_line_end = start;
6118 const char* close_paren;
6121 /* Skip trailing whitespace. */
6122 while (p > start && isSPACE(*p)) p--;
6123 /* Now we should be at the close paren. */
6124 if (p == start || *p != ')')
6128 /* Now we should be in the line number. */
6129 if (p == start || !isDIGIT(*p))
6131 /* Skip over the digits. */
6132 while (p > start && isDIGIT(*p))
6134 /* Now we should be at the colon. */
6135 if (p == start || *p != ':')
6137 source_number_start = p + 1;
6138 source_name_end = p; /* Just beyond the end. */
6140 /* Look for the open paren. */
6141 while (p > start && *p != '(')
6146 *source_name_size = source_name_end - p;
6147 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6148 && source_line_end == close_paren
6149 && uv <= PERL_INT_MAX
6151 *source_line = (STRLEN)uv;
6157 /* Given a raw frame, read a pipe from the symbolicator (that's the
6158 * technical term) atos, reads the result, and parses the source code
6159 * location. We must stay low-level, so we use snprintf(), pipe(),
6160 * and fread(), and then also parse the output ourselves. */
6161 static void atos_symbolize(atos_context* ctx,
6164 STRLEN* source_name_size,
6165 STRLEN* source_line)
6173 /* Simple security measure: if there's any funny business with
6174 * the object name (used as "-o '%s'" ), leave since at least
6175 * partially the user controls it. */
6176 for (p = ctx->fname; *p; p++) {
6177 if (*p == '\'' || isCNTRL(*p)) {
6178 ctx->unavail = TRUE;
6184 WITH_LC_NUMERIC_SET_TO_NEEDED(
6185 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6186 ctx->fname, ctx->object_base_addr, raw_frame);
6189 if (cnt < sizeof(cmd)) {
6190 /* Undo nostdio.h #defines that disable stdio.
6191 * This is somewhat naughty, but is used elsewhere
6192 * in the core, and affects only OS X. */
6197 FILE* fp = popen(cmd, "r");
6198 /* At the moment we open a new pipe for each stack frame.
6199 * This is naturally somewhat slow, but hopefully generating
6200 * stack traces is never going to in a performance critical path.
6202 * We could play tricks with atos by batching the stack
6203 * addresses to be resolved: atos can either take multiple
6204 * addresses from the command line, or read addresses from
6205 * a file (though the mess of creating temporary files would
6206 * probably negate much of any possible speedup).
6208 * Normally there are only two objects present in the backtrace:
6209 * perl itself, and the libdyld.dylib. (Note that the object
6210 * filenames contain the full pathname, so perl may not always
6211 * be in the same place.) Whenever the object in the
6212 * backtrace changes, the base address also changes.
6214 * The problem with batching the addresses, though, would be
6215 * matching the results with the addresses: the parsing of
6216 * the results is already painful enough with a single address. */
6219 UV cnt = fread(out, 1, sizeof(out), fp);
6220 if (cnt < sizeof(out)) {
6221 const char* p = atos_parse(out + cnt - 1, out,
6226 *source_name_size, char);
6227 Copy(p, *source_name,
6228 *source_name_size, char);
6236 #endif /* #ifdef PERL_DARWIN */
6239 =for apidoc_section $debugging
6240 =for apidoc get_c_backtrace
6242 Collects the backtrace (aka "stacktrace") into a single linear
6243 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6245 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6246 returning at most C<depth> frames.
6252 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6254 /* Note that here we must stay as low-level as possible: Newx(),
6255 * Copy(), Safefree(); since we may be called from anywhere,
6256 * so we should avoid higher level constructs like SVs or AVs.
6258 * Since we are using safesysmalloc() via Newx(), don't try
6259 * getting backtrace() there, unless you like deep recursion. */
6261 /* Currently only implemented with backtrace() and dladdr(),
6262 * for other platforms NULL is returned. */
6264 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6265 /* backtrace() is available via <execinfo.h> in glibc and in most
6266 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6268 /* We try fetching this many frames total, but then discard
6269 * the |skip| first ones. For the remaining ones we will try
6270 * retrieving more information with dladdr(). */
6271 int try_depth = skip + depth;
6273 /* The addresses (program counters) returned by backtrace(). */
6276 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6279 /* Sizes _including_ the terminating \0 of the object name
6280 * and symbol name strings. */
6281 STRLEN* object_name_sizes;
6282 STRLEN* symbol_name_sizes;
6285 /* The symbol names comes either from dli_sname,
6286 * or if using BFD, they can come from BFD. */
6287 char** symbol_names;
6290 /* The source code location information. Dug out with e.g. BFD. */
6291 char** source_names;
6292 STRLEN* source_name_sizes;
6293 STRLEN* source_lines;
6295 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6296 int got_depth; /* How many frames were returned from backtrace(). */
6297 UV frame_count = 0; /* How many frames we return. */
6298 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6301 bfd_context bfd_ctx;
6304 atos_context atos_ctx;
6307 /* Here are probably possibilities for optimizing. We could for
6308 * example have a struct that contains most of these and then
6309 * allocate |try_depth| of them, saving a bunch of malloc calls.
6310 * Note, however, that |frames| could not be part of that struct
6311 * because backtrace() will want an array of just them. Also be
6312 * careful about the name strings. */
6313 Newx(raw_frames, try_depth, void*);
6314 Newx(dl_infos, try_depth, Dl_info);
6315 Newx(object_name_sizes, try_depth, STRLEN);
6316 Newx(symbol_name_sizes, try_depth, STRLEN);
6317 Newx(source_names, try_depth, char*);
6318 Newx(source_name_sizes, try_depth, STRLEN);
6319 Newx(source_lines, try_depth, STRLEN);
6321 Newx(symbol_names, try_depth, char*);
6324 /* Get the raw frames. */
6325 got_depth = (int)backtrace(raw_frames, try_depth);
6327 /* We use dladdr() instead of backtrace_symbols() because we want
6328 * the full details instead of opaque strings. This is useful for
6329 * two reasons: () the details are needed for further symbolic
6330 * digging, for example in OS X (2) by having the details we fully
6331 * control the output, which in turn is useful when more platforms
6332 * are added: we can keep out output "portable". */
6334 /* We want a single linear allocation, which can then be freed
6335 * with a single swoop. We will do the usual trick of first
6336 * walking over the structure and seeing how much we need to
6337 * allocate, then allocating, and then walking over the structure
6338 * the second time and populating it. */
6340 /* First we must compute the total size of the buffer. */
6341 total_bytes = sizeof(Perl_c_backtrace_header);
6342 if (got_depth > skip) {
6345 bfd_init(); /* Is this safe to call multiple times? */
6346 Zero(&bfd_ctx, 1, bfd_context);
6349 Zero(&atos_ctx, 1, atos_context);
6351 for (i = skip; i < try_depth; i++) {
6352 Dl_info* dl_info = &dl_infos[i];
6354 object_name_sizes[i] = 0;
6355 source_names[i] = NULL;
6356 source_name_sizes[i] = 0;
6357 source_lines[i] = 0;
6359 /* Yes, zero from dladdr() is failure. */
6360 if (dladdr(raw_frames[i], dl_info)) {
6361 total_bytes += sizeof(Perl_c_backtrace_frame);
6363 object_name_sizes[i] =
6364 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6365 symbol_name_sizes[i] =
6366 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6368 bfd_update(&bfd_ctx, dl_info);
6369 bfd_symbolize(&bfd_ctx, raw_frames[i],
6371 &symbol_name_sizes[i],
6373 &source_name_sizes[i],
6377 atos_update(&atos_ctx, dl_info);
6378 atos_symbolize(&atos_ctx,
6381 &source_name_sizes[i],
6385 /* Plus ones for the terminating \0. */
6386 total_bytes += object_name_sizes[i] + 1;
6387 total_bytes += symbol_name_sizes[i] + 1;
6388 total_bytes += source_name_sizes[i] + 1;
6396 Safefree(bfd_ctx.bfd_syms);
6400 /* Now we can allocate and populate the result buffer. */
6401 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6402 Zero(bt, total_bytes, char);
6403 bt->header.frame_count = frame_count;
6404 bt->header.total_bytes = total_bytes;
6405 if (frame_count > 0) {
6406 Perl_c_backtrace_frame* frame = bt->frame_info;
6407 char* name_base = (char *)(frame + frame_count);
6408 char* name_curr = name_base; /* Outputting the name strings here. */
6410 for (i = skip; i < skip + frame_count; i++) {
6411 Dl_info* dl_info = &dl_infos[i];
6413 frame->addr = raw_frames[i];
6414 frame->object_base_addr = dl_info->dli_fbase;
6415 frame->symbol_addr = dl_info->dli_saddr;
6417 /* Copies a string, including the \0, and advances the name_curr.
6418 * Also copies the start and the size to the frame. */
6419 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6421 Copy(src, name_curr, size, char); \
6422 frame->doffset = name_curr - (char*)bt; \
6423 frame->dsize = size; \
6424 name_curr += size; \
6427 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6429 object_name_size, object_name_sizes[i]);
6432 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6434 symbol_name_size, symbol_name_sizes[i]);
6435 Safefree(symbol_names[i]);
6437 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6439 symbol_name_size, symbol_name_sizes[i]);
6442 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6444 source_name_size, source_name_sizes[i]);
6445 Safefree(source_names[i]);
6447 #undef PERL_C_BACKTRACE_STRCPY
6449 frame->source_line_number = source_lines[i];
6453 assert(total_bytes ==
6454 (UV)(sizeof(Perl_c_backtrace_header) +
6455 frame_count * sizeof(Perl_c_backtrace_frame) +
6456 name_curr - name_base));
6459 Safefree(symbol_names);
6461 bfd_close(bfd_ctx.abfd);
6464 Safefree(source_lines);
6465 Safefree(source_name_sizes);
6466 Safefree(source_names);
6467 Safefree(symbol_name_sizes);
6468 Safefree(object_name_sizes);
6469 /* Assuming the strings returned by dladdr() are pointers
6470 * to read-only static memory (the object file), so that
6471 * they do not need freeing (and cannot be). */
6473 Safefree(raw_frames);
6476 PERL_UNUSED_ARG(depth);
6477 PERL_UNUSED_ARG(skip);
6483 =for apidoc free_c_backtrace
6485 Deallocates a backtrace received from get_c_backtrace.
6491 =for apidoc get_c_backtrace_dump
6493 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6494 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6496 The appended output looks like:
6499 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6500 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6503 The fields are tab-separated. The first column is the depth (zero
6504 being the innermost non-skipped frame). In the hex:offset, the hex is
6505 where the program counter was in C<S_parse_body>, and the :offset (might
6506 be missing) tells how much inside the C<S_parse_body> the program counter was.
6508 The C<util.c:1716> is the source code file and line number.
6510 The F</usr/bin/perl> is obvious (hopefully).
6512 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6513 if the platform doesn't support retrieving the information;
6514 if the binary is missing the debug information;
6515 if the optimizer has transformed the code by for example inlining.
6521 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6523 Perl_c_backtrace* bt;
6525 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6527 Perl_c_backtrace_frame* frame;
6528 SV* dsv = newSVpvs("");
6530 for (i = 0, frame = bt->frame_info;
6531 i < bt->header.frame_count; i++, frame++) {
6532 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6533 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6534 /* Symbol (function) names might disappear without debug info.
6536 * The source code location might disappear in case of the
6537 * optimizer inlining or otherwise rearranging the code. */
6538 if (frame->symbol_addr) {
6539 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6541 ((char*)frame->addr - (char*)frame->symbol_addr));
6543 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6544 frame->symbol_name_size &&
6545 frame->symbol_name_offset ?
6546 (char*)bt + frame->symbol_name_offset : "-");
6547 if (frame->source_name_size &&
6548 frame->source_name_offset &&
6549 frame->source_line_number) {
6550 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6551 (char*)bt + frame->source_name_offset,
6552 (UV)frame->source_line_number);
6554 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6556 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6557 frame->object_name_size &&
6558 frame->object_name_offset ?
6559 (char*)bt + frame->object_name_offset : "-");
6560 /* The frame->object_base_addr is not output,
6561 * but it is used for symbolizing/symbolicating. */
6562 sv_catpvs(dsv, "\n");
6565 Perl_free_c_backtrace(bt);
6574 =for apidoc dump_c_backtrace
6576 Dumps the C backtrace to the given C<fp>.
6578 Returns true if a backtrace could be retrieved, false if not.
6584 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6588 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6590 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6593 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6599 #endif /* #ifdef USE_C_BACKTRACE */
6601 #if defined(USE_ITHREADS) && defined(I_PTHREAD)
6603 /* pthread_mutex_t and perl_mutex are typedef equivalent
6604 * so casting the pointers is fine. */
6606 int perl_tsa_mutex_lock(perl_mutex* mutex)
6608 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6611 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6613 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6616 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6618 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6625 /* log a sub call or return */
6628 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6636 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6639 HEK *hek = CvNAME_HEK(cv);
6640 func = HEK_KEY(hek);
6646 start = (const COP *)CvSTART(cv);
6647 file = CopFILE(start);
6648 line = CopLINE(start);
6649 stash = CopSTASHPV(start);
6652 PERL_SUB_ENTRY(func, file, line, stash);
6655 PERL_SUB_RETURN(func, file, line, stash);
6660 /* log a require file loading/loaded */
6663 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6665 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6668 PERL_LOADING_FILE(name);
6671 PERL_LOADED_FILE(name);
6676 /* log an op execution */
6679 Perl_dtrace_probe_op(pTHX_ const OP *op)
6681 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6683 PERL_OP_ENTRY(OP_NAME(op));
6687 /* log a compile/run phase change */
6690 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6692 const char *ph_old = PL_phase_names[PL_phase];
6693 const char *ph_new = PL_phase_names[phase];
6695 PERL_PHASE_CHANGE(ph_new, ph_old);
6701 * ex: set ts=8 sts=4 sw=4 et: