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 */
35 # define SIG_ERR ((Sighandler_t) -1)
42 /* Missing protos on LynxOS */
47 # include "amigaos4/amigaio.h"
52 # include <sys/select.h>
56 #ifdef USE_C_BACKTRACE
60 # undef USE_BFD /* BFD is useless in OS X. */
70 # include <execinfo.h>
74 #ifdef PERL_DEBUG_READONLY_COW
75 # include <sys/mman.h>
80 /* NOTE: Do not call the next three routines directly. Use the macros
81 * in handy.h, so that we can easily redefine everything to do tracking of
82 * allocated hunks back to the original New to track down any memory leaks.
83 * XXX This advice seems to be widely ignored :-( --AD August 1996.
86 #if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
87 # define ALWAYS_NEED_THX
90 #if defined(PERL_TRACK_MEMPOOL) && defined(PERL_DEBUG_READONLY_COW)
92 S_maybe_protect_rw(pTHX_ struct perl_memory_debug_header *header)
95 && mprotect(header, header->size, PROT_READ|PROT_WRITE))
96 Perl_warn(aTHX_ "mprotect for COW string %p %lu failed with %d",
97 header, header->size, errno);
101 S_maybe_protect_ro(pTHX_ struct perl_memory_debug_header *header)
104 && mprotect(header, header->size, PROT_READ))
105 Perl_warn(aTHX_ "mprotect RW for COW string %p %lu failed with %d",
106 header, header->size, errno);
108 # define maybe_protect_rw(foo) S_maybe_protect_rw(aTHX_ foo)
109 # define maybe_protect_ro(foo) S_maybe_protect_ro(aTHX_ foo)
111 # define maybe_protect_rw(foo) NOOP
112 # define maybe_protect_ro(foo) NOOP
115 #if defined(PERL_TRACK_MEMPOOL) || defined(PERL_DEBUG_READONLY_COW)
116 /* Use memory_debug_header */
118 # if (defined(PERL_POISON) && defined(PERL_TRACK_MEMPOOL)) \
119 || defined(PERL_DEBUG_READONLY_COW)
120 # define MDH_HAS_SIZE
125 =for apidoc_section $memory
126 =for apidoc safesysmalloc
127 Paranoid version of system's malloc()
133 Perl_safesysmalloc(MEM_SIZE size)
135 #ifdef ALWAYS_NEED_THX
142 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
144 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
147 if ((SSize_t)size < 0)
148 Perl_croak_nocontext("panic: malloc, size=%" UVuf, (UV) size);
150 if (!size) size = 1; /* malloc(0) is NASTY on our system */
152 #ifdef PERL_DEBUG_READONLY_COW
153 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
154 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
155 perror("mmap failed");
159 ptr = (Malloc_t)PerlMem_malloc(size);
161 PERL_ALLOC_CHECK(ptr);
164 struct perl_memory_debug_header *const header
165 = (struct perl_memory_debug_header *)ptr;
169 PoisonNew(((char *)ptr), size, char);
172 #ifdef PERL_TRACK_MEMPOOL
173 header->interpreter = aTHX;
174 /* Link us into the list. */
175 header->prev = &PL_memory_debug_header;
176 header->next = PL_memory_debug_header.next;
177 PL_memory_debug_header.next = header;
178 maybe_protect_rw(header->next);
179 header->next->prev = header;
180 maybe_protect_ro(header->next);
181 # ifdef PERL_DEBUG_READONLY_COW
182 header->readonly = 0;
188 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
189 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
191 /* malloc() can modify errno() even on success, but since someone
192 writing perl code doesn't have any control over when perl calls
193 malloc() we need to hide that.
202 #ifndef ALWAYS_NEED_THX
208 croak_no_mem_ext(STR_WITH_LEN("util:safesysmalloc"));
215 =for apidoc safesysrealloc
216 Paranoid version of system's realloc()
222 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
224 #ifdef ALWAYS_NEED_THX
228 #ifdef PERL_DEBUG_READONLY_COW
229 const MEM_SIZE oldsize = where
230 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
239 ptr = safesysmalloc(size);
243 PERL_DEB(UV was_where = PTR2UV(where)); /* used in diags below */
245 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
246 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
248 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
250 struct perl_memory_debug_header *const header
251 = (struct perl_memory_debug_header *)where;
253 # ifdef PERL_TRACK_MEMPOOL
254 if (header->interpreter != aTHX) {
255 Perl_croak_nocontext("panic: realloc %p from wrong pool, %p!=%p",
256 where, header->interpreter, aTHX);
258 assert(header->next->prev == header);
259 assert(header->prev->next == header);
261 if (header->size > size) {
262 const MEM_SIZE freed_up = header->size - size;
263 char *start_of_freed = ((char *)where) + size;
264 PoisonFree(start_of_freed, freed_up, char);
274 if ((SSize_t)size < 0)
275 Perl_croak_nocontext("panic: realloc %p , size=%" UVuf,
278 #ifdef PERL_DEBUG_READONLY_COW
279 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
280 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
281 perror("mmap failed");
284 Copy(where,ptr,oldsize < size ? oldsize : size,char);
285 if (munmap(where, oldsize)) {
286 perror("munmap failed");
290 ptr = (Malloc_t)PerlMem_realloc(where,size);
292 PERL_ALLOC_CHECK(ptr);
294 /* MUST do this fixup first, before doing ANYTHING else, as anything else
295 might allocate memory/free/move memory, and until we do the fixup, it
296 may well be chasing (and writing to) free memory. */
298 #ifdef PERL_TRACK_MEMPOOL
299 struct perl_memory_debug_header *const header
300 = (struct perl_memory_debug_header *)ptr;
303 if (header->size < size) {
304 const MEM_SIZE fresh = size - header->size;
305 char *start_of_fresh = ((char *)ptr) + size;
306 PoisonNew(start_of_fresh, fresh, char);
310 maybe_protect_rw(header->next);
311 header->next->prev = header;
312 maybe_protect_ro(header->next);
313 maybe_protect_rw(header->prev);
314 header->prev->next = header;
315 maybe_protect_ro(header->prev);
317 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
319 /* realloc() can modify errno() even on success, but since someone
320 writing perl code doesn't have any control over when perl calls
321 realloc() we need to hide that.
326 /* In particular, must do that fixup above before logging anything via
327 *printf(), as it can reallocate memory, which can cause SEGVs. */
329 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) rfree\n",was_where,(long)PL_an++));
330 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
337 #ifndef ALWAYS_NEED_THX
343 croak_no_mem_ext(STR_WITH_LEN("util:safesysrealloc"));
351 =for apidoc safesysfree
352 Safe version of system's free()
358 Perl_safesysfree(Malloc_t where)
360 #ifdef ALWAYS_NEED_THX
363 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
366 Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
368 struct perl_memory_debug_header *const header
369 = (struct perl_memory_debug_header *)where_intrn;
372 const MEM_SIZE size = header->size;
374 # ifdef PERL_TRACK_MEMPOOL
375 if (header->interpreter != aTHX) {
376 Perl_croak_nocontext("panic: free %p from wrong pool, %p!=%p",
377 where, header->interpreter, aTHX);
380 Perl_croak_nocontext("panic: duplicate free");
383 Perl_croak_nocontext("panic: bad free of %p, header->next==NULL",
385 if (header->next->prev != header || header->prev->next != header) {
386 Perl_croak_nocontext("panic: bad free of %p, ->next->prev=%p, "
387 "header=%p, ->prev->next=%p",
388 where, 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
515 croak_no_mem_ext(STR_WITH_LEN("util:safesyscalloc"));
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);
1345 croak_no_mem_ext(STR_WITH_LEN("util:savesharedpv"));
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; */
1368 croak_no_mem_ext(STR_WITH_LEN("util: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_ext(const char *context, STRLEN len)
1977 PERL_ARGS_ASSERT_CROAK_NO_MEM_EXT;
1979 int fd = PerlIO_fileno(Perl_error_log);
1981 SETERRNO(EBADF,RMS_IFI);
1983 /* Can't use PerlIO to write as it allocates memory */
1984 static const char oomp[] = "Out of memory in perl:";
1986 PerlLIO_write(fd, oomp, sizeof oomp - 1) >= 0
1987 && PerlLIO_write(fd, context, len) >= 0
1988 && PerlLIO_write(fd, "\n", 1) >= 0
1997 Perl_croak_no_mem(void)
1999 croak_no_mem_ext(STR_WITH_LEN("???"));
2002 /* does not return, used only in POPSTACK */
2004 Perl_croak_popstack(void)
2007 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
2014 This is an XS interface to Perl's C<warn> function.
2016 C<baseex> is the error message or object. If it is a reference, it
2017 will be used as-is. Otherwise it is used as a string, and if it does
2018 not end with a newline then it will be extended with some indication of
2019 the current location in the code, as described for L</mess_sv>.
2021 The error message or object will by default be written to standard error,
2022 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2024 To warn with a simple string message, the L</warn> function may be
2031 Perl_warn_sv(pTHX_ SV *baseex)
2033 SV *ex = mess_sv(baseex, 0);
2034 PERL_ARGS_ASSERT_WARN_SV;
2035 if (!invoke_exception_hook(ex, TRUE))
2036 write_to_stderr(ex);
2042 This is an XS interface to Perl's C<warn> function.
2044 This is like C<L</warn>>, but C<args> are an encapsulated
2047 Unlike with L</vcroak>, C<pat> is not permitted to be null.
2053 Perl_vwarn(pTHX_ const char* pat, va_list *args)
2055 SV *ex = vmess(pat, args);
2056 PERL_ARGS_ASSERT_VWARN;
2057 if (!invoke_exception_hook(ex, TRUE))
2058 write_to_stderr(ex);
2063 =for apidoc_item warn_nocontext
2065 These are XS interfaces to Perl's C<warn> function.
2067 They take a sprintf-style format pattern and argument list, which are used to
2068 generate a string message. If the message does not end with a newline, then it
2069 will be extended with some indication of the current location in the code, as
2070 described for C<L</mess_sv>>.
2072 The error message or object will by default be written to standard error,
2073 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2075 Unlike with C<L</croak>>, C<pat> is not permitted to be null.
2077 The two forms differ only in that C<warn_nocontext> does not take a thread
2078 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
2079 already have the thread context.
2084 #if defined(MULTIPLICITY)
2086 Perl_warn_nocontext(const char *pat, ...)
2090 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
2091 va_start(args, pat);
2095 #endif /* MULTIPLICITY */
2098 Perl_warn(pTHX_ const char *pat, ...)
2101 PERL_ARGS_ASSERT_WARN;
2102 va_start(args, pat);
2109 =for apidoc_item warner_nocontext
2111 These output a warning of the specified category (or categories) given by
2112 C<err>, using the sprintf-style format pattern C<pat>, and argument list.
2114 C<err> must be one of the C<L</packWARN>>, C<packWARN2>, C<packWARN3>,
2115 C<packWARN4> macros populated with the appropriate number of warning
2116 categories. If any of the warning categories they specify is fatal, a fatal
2117 exception is thrown.
2119 In any event a message is generated by the pattern and arguments. If the
2120 message does not end with a newline, then it will be extended with some
2121 indication of the current location in the code, as described for L</mess_sv>.
2123 The error message or object will by default be written to standard error,
2124 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2126 C<pat> is not permitted to be null.
2128 The two forms differ only in that C<warner_nocontext> does not take a thread
2129 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
2130 already have the thread context.
2132 These functions differ from the similarly named C<L</warn>> functions, in that
2133 the latter are for XS code to unconditionally display a warning, whereas these
2134 are for code that may be compiling a perl program, and does extra checking to
2135 see if the warning should be fatal.
2137 =for apidoc ck_warner
2138 =for apidoc_item ck_warner_d
2139 If none of the warning categories given by C<err> are enabled, do nothing;
2140 otherwise call C<L</warner>> or C<L</warner_nocontext>> with the passed-in
2143 C<err> must be one of the C<L</packWARN>>, C<packWARN2>, C<packWARN3>,
2144 C<packWARN4> macros populated with the appropriate number of warning
2147 The two forms differ only in that C<ck_warner_d> should be used if warnings for
2148 any of the categories are by default enabled.
2151 This is like C<L</warner>>, but C<args> are an encapsulated argument list.
2153 =for apidoc fatal_warner
2155 Like L</warner> except that it acts as if fatal warnings are enabled
2158 If called when there are pending compilation errors this function may
2161 This is currently used to generate "used only once" fatal warnings
2162 since the COP where the name being reported is no longer the current
2163 COP when the warning is generated and may be useful for similar cases.
2165 C<err> must be one of the C<L</packWARN>>, C<packWARN2>, C<packWARN3>,
2166 C<packWARN4> macros populated with the appropriate number of warning
2169 =for apidoc vfatal_warner
2171 This is like C<L</fatal_warner>> but C<args> are an encapsulated
2177 #if defined(MULTIPLICITY)
2179 Perl_warner_nocontext(U32 err, const char *pat, ...)
2183 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
2184 va_start(args, pat);
2185 vwarner(err, pat, &args);
2188 #endif /* MULTIPLICITY */
2191 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
2193 PERL_ARGS_ASSERT_CK_WARNER_D;
2195 if (Perl_ckwarn_d(aTHX_ err)) {
2197 va_start(args, pat);
2198 vwarner(err, pat, &args);
2204 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
2206 PERL_ARGS_ASSERT_CK_WARNER;
2208 if (Perl_ckwarn(aTHX_ err)) {
2210 va_start(args, pat);
2211 vwarner(err, pat, &args);
2217 Perl_warner(pTHX_ U32 err, const char* pat,...)
2220 PERL_ARGS_ASSERT_WARNER;
2221 va_start(args, pat);
2222 vwarner(err, pat, &args);
2227 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
2229 PERL_ARGS_ASSERT_VWARNER;
2231 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
2232 !(PL_in_eval & EVAL_KEEPERR)
2234 vfatal_warner(err, pat, args);
2237 Perl_vwarn(aTHX_ pat, args);
2242 Perl_fatal_warner(pTHX_ U32 err, const char *pat, ...)
2244 PERL_ARGS_ASSERT_FATAL_WARNER;
2247 va_start(args, pat);
2248 vfatal_warner(err, pat, &args);
2253 Perl_vfatal_warner(pTHX_ U32 err, const char *pat, va_list *args)
2255 PERL_ARGS_ASSERT_VFATAL_WARNER;
2257 PERL_UNUSED_ARG(err);
2259 SV * const msv = vmess(pat, args);
2261 if (PL_parser && PL_parser->error_count) {
2265 invoke_exception_hook(msv, FALSE);
2270 /* implements the ckWARN? macros */
2273 Perl_ckwarn(pTHX_ U32 w)
2275 /* If lexical warnings have not been set, use $^W. */
2277 return PL_dowarn & G_WARN_ON;
2279 return ckwarn_common(w);
2282 /* implements the ckWARN?_d macro */
2285 Perl_ckwarn_d(pTHX_ U32 w)
2287 /* If lexical warnings have not been set then default classes warn. */
2291 return ckwarn_common(w);
2295 S_ckwarn_common(pTHX_ U32 w)
2297 if (PL_curcop->cop_warnings == pWARN_ALL)
2300 if (PL_curcop->cop_warnings == pWARN_NONE)
2303 /* Check the assumption that at least the first slot is non-zero. */
2304 assert(unpackWARN1(w));
2306 /* Check the assumption that it is valid to stop as soon as a zero slot is
2308 if (!unpackWARN2(w)) {
2309 assert(!unpackWARN3(w));
2310 assert(!unpackWARN4(w));
2311 } else if (!unpackWARN3(w)) {
2312 assert(!unpackWARN4(w));
2315 /* Right, dealt with all the special cases, which are implemented as non-
2316 pointers, so there is a pointer to a real warnings mask. */
2318 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2320 } while (w >>= WARNshift);
2326 Perl_new_warnings_bitfield(pTHX_ char *buffer, const char *const bits,
2328 const MEM_SIZE len_wanted = (size > WARNsize ? size : WARNsize);
2329 PERL_UNUSED_CONTEXT;
2330 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2332 /* pass in null as the source string as we will do the
2333 * copy ourselves. */
2334 buffer = rcpv_new(NULL, len_wanted, RCPVf_NO_COPY);
2335 Copy(bits, buffer, size, char);
2336 if (size < WARNsize)
2337 Zero(buffer + size, WARNsize - size, char);
2341 /* since we've already done strlen() for both nam and val
2342 * we can use that info to make things faster than
2343 * sprintf(s, "%s=%s", nam, val)
2345 #define my_setenv_format(s, nam, nlen, val, vlen) \
2346 Copy(nam, s, nlen, char); \
2348 Copy(val, s+(nlen+1), vlen, char); \
2349 *(s+(nlen+1+vlen)) = '\0'
2353 #if defined(USE_ENVIRON_ARRAY) || defined(WIN32)
2354 /* NB: VMS' my_setenv() is in vms.c */
2356 /* small wrapper for use by Perl_my_setenv that mallocs, or reallocs if
2357 * 'current' is non-null, with up to three sizes that are added together.
2358 * It handles integer overflow.
2362 S_env_alloc(void *current, Size_t l1, Size_t l2, Size_t l3, Size_t size)
2365 Size_t sl, l = l1 + l2;
2377 ? safesysrealloc(current, sl)
2378 : safesysmalloc(sl);
2383 croak_memory_wrap();
2388 =for apidoc_section $utility
2389 =for apidoc my_setenv
2391 A wrapper for the C library L<setenv(3)>. Don't use the latter, as the perl
2392 version has desirable safeguards
2398 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2400 # if defined(USE_ITHREADS) && !defined(WIN32)
2401 /* only parent thread can modify process environment, so no need to use a
2403 if (PL_curinterp != aTHX)
2407 # if defined(HAS_SETENV) && defined(HAS_UNSETENV)
2411 setenv(nam, val, 1);
2414 # elif defined(HAS_UNSETENV)
2417 if (environ) /* old glibc can crash with null environ */
2420 const Size_t nlen = strlen(nam);
2421 const Size_t vlen = strlen(val);
2422 char * const new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2423 my_setenv_format(new_env, nam, nlen, val, vlen);
2427 # else /* ! HAS_UNSETENV */
2429 const Size_t nlen = strlen(nam);
2433 Size_t vlen = strlen(val);
2434 char *new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2435 /* all that work just for this */
2436 my_setenv_format(new_env, nam, nlen, val, vlen);
2440 PerlEnv_putenv(new_env);
2441 safesysfree(new_env);
2444 # endif /* HAS_SETENV */
2447 #endif /* USE_ENVIRON_ARRAY || WIN32 */
2449 #ifdef UNLINK_ALL_VERSIONS
2451 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2455 PERL_ARGS_ASSERT_UNLNK;
2457 while (PerlLIO_unlink(f) >= 0)
2459 return retries ? 0 : -1;
2464 #if (__CHARSET_LIB == 1)
2465 static int chgfdccsid(int fd, unsigned short ccsid)
2468 memset(&attr, 0, sizeof(attr));
2469 attr.att_filetagchg = 1;
2470 attr.att_filetag.ft_ccsid = ccsid;
2471 if (ccsid != FT_BINARY) {
2472 attr.att_filetag.ft_txtflag = 1;
2474 return __fchattr(fd, &attr, sizeof(attr));
2480 =for apidoc my_popen_list
2482 Implementing function on some systems for PerlProc_popen_list()
2488 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2490 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2498 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2500 PERL_FLUSHALL_FOR_CHILD;
2501 This = (*mode == 'w');
2505 taint_proper("Insecure %s%s", "EXEC");
2507 if (PerlProc_pipe_cloexec(p) < 0)
2509 /* Try for another pipe pair for error return */
2510 if (PerlProc_pipe_cloexec(pp) >= 0)
2512 while ((pid = PerlProc_fork()) < 0) {
2513 if (errno != EAGAIN) {
2514 PerlLIO_close(p[This]);
2515 PerlLIO_close(p[that]);
2517 PerlLIO_close(pp[0]);
2518 PerlLIO_close(pp[1]);
2522 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2531 /* Close parent's end of error status pipe (if any) */
2533 PerlLIO_close(pp[0]);
2535 #if (__CHARSET_LIB == 1)
2536 chgfdccsid(p[THIS], 819);
2537 chgfdccsid(p[THAT], 819);
2540 /* Now dup our end of _the_ pipe to right position */
2541 if (p[THIS] != (*mode == 'r')) {
2542 PerlLIO_dup2(p[THIS], *mode == 'r');
2543 PerlLIO_close(p[THIS]);
2544 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2545 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2548 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2549 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2551 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2552 /* No automatic close - do it by hand */
2559 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2565 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2572 PerlLIO_close(pp[1]);
2573 /* Keep the lower of the two fd numbers */
2574 if (p[that] < p[This]) {
2575 PerlLIO_dup2_cloexec(p[This], p[that]);
2576 PerlLIO_close(p[This]);
2580 PerlLIO_close(p[that]); /* close child's end of pipe */
2582 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2583 SvUPGRADE(sv,SVt_IV);
2585 PL_forkprocess = pid;
2586 /* If we managed to get status pipe check for exec fail */
2587 if (did_pipes && pid > 0) {
2589 unsigned read_total = 0;
2591 while (read_total < sizeof(int)) {
2592 const SSize_t n1 = PerlLIO_read(pp[0],
2593 (void*)(((char*)&errkid)+read_total),
2594 (sizeof(int)) - read_total);
2599 PerlLIO_close(pp[0]);
2601 if (read_total) { /* Error */
2603 PerlLIO_close(p[This]);
2604 if (read_total != sizeof(int))
2605 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", read_total);
2607 pid2 = wait4pid(pid, &status, 0);
2608 } while (pid2 == -1 && errno == EINTR);
2609 errno = errkid; /* Propagate errno from kid */
2614 PerlLIO_close(pp[0]);
2616 #if (__CHARSET_LIB == 1)
2617 PerlIO* io = PerlIO_fdopen(p[This], mode);
2619 chgfdccsid(p[This], 819);
2623 return PerlIO_fdopen(p[This], mode);
2626 return PerlIO_fdopen(p[This], mode);
2630 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2631 return my_syspopen4(aTHX_ NULL, mode, n, args);
2632 # elif defined(WIN32)
2633 return win32_popenlist(mode, n, args);
2635 Perl_croak(aTHX_ "List form of piped open not implemented");
2636 return (PerlIO *) NULL;
2641 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2642 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2645 =for apidoc_section $io
2646 =for apidoc my_popen
2648 A wrapper for the C library L<popen(3)>. Don't use the latter, as the Perl
2649 version knows things that interact with the rest of the perl interpreter.
2655 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2661 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2665 PERL_ARGS_ASSERT_MY_POPEN;
2667 PERL_FLUSHALL_FOR_CHILD;
2670 return my_syspopen(aTHX_ cmd,mode);
2673 This = (*mode == 'w');
2675 if (doexec && TAINTING_get) {
2677 taint_proper("Insecure %s%s", "EXEC");
2679 if (PerlProc_pipe_cloexec(p) < 0)
2681 if (doexec && PerlProc_pipe_cloexec(pp) >= 0)
2683 while ((pid = PerlProc_fork()) < 0) {
2684 if (errno != EAGAIN) {
2685 PerlLIO_close(p[This]);
2686 PerlLIO_close(p[that]);
2688 PerlLIO_close(pp[0]);
2689 PerlLIO_close(pp[1]);
2692 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2695 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2705 PerlLIO_close(pp[0]);
2707 #if (__CHARSET_LIB == 1)
2708 chgfdccsid(p[THIS], 819);
2709 chgfdccsid(p[THAT], 819);
2712 if (p[THIS] != (*mode == 'r')) {
2713 PerlLIO_dup2(p[THIS], *mode == 'r');
2714 PerlLIO_close(p[THIS]);
2715 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2716 PerlLIO_close(p[THAT]);
2719 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2720 PerlLIO_close(p[THAT]);
2724 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2731 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2736 /* may or may not use the shell */
2737 do_exec3(cmd, pp[1], did_pipes);
2740 #endif /* defined OS2 */
2742 #ifdef PERLIO_USING_CRLF
2743 /* Since we circumvent IO layers when we manipulate low-level
2744 filedescriptors directly, need to manually switch to the
2745 default, binary, low-level mode; see PerlIOBuf_open(). */
2746 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2749 #ifdef PERL_USES_PL_PIDSTATUS
2750 hv_clear(PL_pidstatus); /* we have no children */
2757 PerlLIO_close(pp[1]);
2758 if (p[that] < p[This]) {
2759 PerlLIO_dup2_cloexec(p[This], p[that]);
2760 PerlLIO_close(p[This]);
2764 PerlLIO_close(p[that]);
2766 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2767 SvUPGRADE(sv,SVt_IV);
2769 PL_forkprocess = pid;
2770 if (did_pipes && pid > 0) {
2774 while (n < sizeof(int)) {
2775 const SSize_t n1 = PerlLIO_read(pp[0],
2776 (void*)(((char*)&errkid)+n),
2782 PerlLIO_close(pp[0]);
2784 if (n) { /* Error */
2786 PerlLIO_close(p[This]);
2787 if (n != sizeof(int))
2788 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2790 pid2 = wait4pid(pid, &status, 0);
2791 } while (pid2 == -1 && errno == EINTR);
2792 errno = errkid; /* Propagate errno from kid */
2797 PerlLIO_close(pp[0]);
2799 #if (__CHARSET_LIB == 1)
2800 PerlIO* io = PerlIO_fdopen(p[This], mode);
2802 chgfdccsid(p[This], 819);
2806 return PerlIO_fdopen(p[This], mode);
2809 return PerlIO_fdopen(p[This], mode);
2812 #elif defined(__LIBCATAMOUNT__)
2814 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2819 #endif /* !DOSISH */
2821 /* this is called in parent before the fork() */
2823 Perl_atfork_lock(void)
2824 #if defined(USE_ITHREADS)
2826 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2829 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2831 PERL_TSA_ACQUIRE(PL_op_mutex)
2834 #if defined(USE_ITHREADS)
2835 /* locks must be held in locking order (if any) */
2837 MUTEX_LOCK(&PL_perlio_mutex);
2840 MUTEX_LOCK(&PL_malloc_mutex);
2846 /* this is called in both parent and child after the fork() */
2848 Perl_atfork_unlock(void)
2849 #if defined(USE_ITHREADS)
2851 PERL_TSA_RELEASE(PL_perlio_mutex)
2854 PERL_TSA_RELEASE(PL_malloc_mutex)
2856 PERL_TSA_RELEASE(PL_op_mutex)
2859 #if defined(USE_ITHREADS)
2860 /* locks must be released in same order as in atfork_lock() */
2862 MUTEX_UNLOCK(&PL_perlio_mutex);
2865 MUTEX_UNLOCK(&PL_malloc_mutex);
2872 =for apidoc_section $concurrency
2875 This is for the use of C<PerlProc_fork> as a wrapper for the C library
2876 L<fork(2)> on some platforms to hide some platform quirks. It should not be
2877 used except through C<PerlProc_fork>.
2886 #if defined(HAS_FORK)
2888 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2893 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2894 * handlers elsewhere in the code */
2898 #elif defined(__amigaos4__)
2899 return amigaos_fork();
2901 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2902 Perl_croak_nocontext("fork() not available");
2904 #endif /* HAS_FORK */
2909 dup2(int oldfd, int newfd)
2911 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2914 PerlLIO_close(newfd);
2915 return fcntl(oldfd, F_DUPFD, newfd);
2917 #define DUP2_MAX_FDS 256
2918 int fdtmp[DUP2_MAX_FDS];
2924 PerlLIO_close(newfd);
2925 /* good enough for low fd's... */
2926 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2927 if (fdx >= DUP2_MAX_FDS) {
2935 PerlLIO_close(fdtmp[--fdx]);
2941 #ifdef HAS_SIGACTION
2944 =for apidoc_section $signals
2947 A wrapper for the C library functions L<sigaction(2)> or L<signal(2)>.
2948 Use this instead of those libc functions, as the Perl version gives the
2949 safest available implementation, and knows things that interact with the
2950 rest of the perl interpreter.
2956 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2958 struct sigaction act, oact;
2961 /* only "parent" interpreter can diddle signals */
2962 if (PL_curinterp != aTHX)
2963 return (Sighandler_t) SIG_ERR;
2966 act.sa_handler = handler;
2967 sigemptyset(&act.sa_mask);
2970 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2971 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2973 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2974 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2975 act.sa_flags |= SA_NOCLDWAIT;
2977 if (sigaction(signo, &act, &oact) == -1)
2978 return (Sighandler_t) SIG_ERR;
2980 return (Sighandler_t) oact.sa_handler;
2984 =for apidoc_section $signals
2985 =for apidoc rsignal_state
2987 Returns a the current signal handler for signal C<signo>.
2994 Perl_rsignal_state(pTHX_ int signo)
2996 struct sigaction oact;
2997 PERL_UNUSED_CONTEXT;
2999 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
3000 return (Sighandler_t) SIG_ERR;
3002 return (Sighandler_t) oact.sa_handler;
3006 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3008 struct sigaction act;
3010 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
3013 /* only "parent" interpreter can diddle signals */
3014 if (PL_curinterp != aTHX)
3018 act.sa_handler = handler;
3019 sigemptyset(&act.sa_mask);
3022 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
3023 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
3025 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
3026 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
3027 act.sa_flags |= SA_NOCLDWAIT;
3029 return sigaction(signo, &act, save);
3033 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3035 PERL_UNUSED_CONTEXT;
3037 /* only "parent" interpreter can diddle signals */
3038 if (PL_curinterp != aTHX)
3042 return sigaction(signo, save, (struct sigaction *)NULL);
3045 #else /* !HAS_SIGACTION */
3048 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
3050 #if defined(USE_ITHREADS) && !defined(WIN32)
3051 /* only "parent" interpreter can diddle signals */
3052 if (PL_curinterp != aTHX)
3053 return (Sighandler_t) SIG_ERR;
3056 return PerlProc_signal(signo, handler);
3066 Perl_rsignal_state(pTHX_ int signo)
3068 Sighandler_t oldsig;
3070 #if defined(USE_ITHREADS) && !defined(WIN32)
3071 /* only "parent" interpreter can diddle signals */
3072 if (PL_curinterp != aTHX)
3073 return (Sighandler_t) SIG_ERR;
3077 oldsig = PerlProc_signal(signo, sig_trap);
3078 PerlProc_signal(signo, oldsig);
3080 PerlProc_kill(PerlProc_getpid(), signo);
3085 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3087 #if defined(USE_ITHREADS) && !defined(WIN32)
3088 /* only "parent" interpreter can diddle signals */
3089 if (PL_curinterp != aTHX)
3092 *save = PerlProc_signal(signo, handler);
3093 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
3097 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3099 #if defined(USE_ITHREADS) && !defined(WIN32)
3100 /* only "parent" interpreter can diddle signals */
3101 if (PL_curinterp != aTHX)
3104 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
3107 #endif /* !HAS_SIGACTION */
3109 /* VMS' my_pclose() is in VMS.c */
3112 =for apidoc_section $io
3113 =for apidoc my_pclose
3115 A wrapper for the C library L<pclose(3)>. Don't use the latter, as the Perl
3116 version knows things that interact with the rest of the perl interpreter.
3121 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
3123 Perl_my_pclose(pTHX_ PerlIO *ptr)
3131 const int fd = PerlIO_fileno(ptr);
3134 svp = av_fetch(PL_fdpid, fd, FALSE);
3136 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3143 #if defined(USE_PERLIO)
3144 /* Find out whether the refcount is low enough for us to wait for the
3145 child proc without blocking. */
3146 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
3148 should_wait = pid > 0;
3152 if (pid == -2) { /* Opened by popen. */
3153 return my_syspclose(ptr);
3156 close_failed = (PerlIO_close(ptr) == EOF);
3158 if (should_wait) do {
3159 pid2 = wait4pid(pid, &status, 0);
3160 } while (pid2 == -1 && errno == EINTR);
3167 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
3171 #elif defined(__LIBCATAMOUNT__)
3173 Perl_my_pclose(pTHX_ PerlIO *ptr)
3177 #endif /* !DOSISH */
3179 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32)) && !defined(__LIBCATAMOUNT__)
3181 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3184 PERL_ARGS_ASSERT_WAIT4PID;
3185 #ifdef PERL_USES_PL_PIDSTATUS
3187 /* PERL_USES_PL_PIDSTATUS is only defined when neither
3188 waitpid() nor wait4() is available, or on OS/2, which
3189 doesn't appear to support waiting for a progress group
3190 member, so we can only treat a 0 pid as an unknown child.
3197 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3198 pid, rather than a string form. */
3199 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3200 if (svp && *svp != &PL_sv_undef) {
3201 *statusp = SvIVX(*svp);
3202 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3210 hv_iterinit(PL_pidstatus);
3211 if ((entry = hv_iternext(PL_pidstatus))) {
3212 SV * const sv = hv_iterval(PL_pidstatus,entry);
3214 const char * const spid = hv_iterkey(entry,&len);
3216 assert (len == sizeof(Pid_t));
3217 memcpy((char *)&pid, spid, len);
3218 *statusp = SvIVX(sv);
3219 /* The hash iterator is currently on this entry, so simply
3220 calling hv_delete would trigger the lazy delete, which on
3221 aggregate does more work, because next call to hv_iterinit()
3222 would spot the flag, and have to call the delete routine,
3223 while in the meantime any new entries can't re-use that
3225 hv_iterinit(PL_pidstatus);
3226 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3233 # ifdef HAS_WAITPID_RUNTIME
3234 if (!HAS_WAITPID_RUNTIME)
3237 result = PerlProc_waitpid(pid,statusp,flags);
3240 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3241 result = wait4(pid,statusp,flags,NULL);
3244 #ifdef PERL_USES_PL_PIDSTATUS
3245 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3250 Perl_croak(aTHX_ "Can't do waitpid with flags");
3252 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3253 pidgone(result,*statusp);
3259 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3262 if (result < 0 && errno == EINTR) {
3264 errno = EINTR; /* reset in case a signal handler changed $! */
3268 #endif /* !DOSISH || OS2 || WIN32 */
3270 #ifdef PERL_USES_PL_PIDSTATUS
3272 S_pidgone(pTHX_ Pid_t pid, int status)
3276 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3277 SvUPGRADE(sv,SVt_IV);
3278 SvIV_set(sv, status);
3286 int /* Cannot prototype with I32
3288 my_syspclose(PerlIO *ptr)
3291 Perl_my_pclose(pTHX_ PerlIO *ptr)
3294 /* Needs work for PerlIO ! */
3295 FILE * const f = PerlIO_findFILE(ptr);
3296 const I32 result = pclose(f);
3297 PerlIO_releaseFILE(ptr,f);
3303 =for apidoc repeatcpy
3305 Make C<count> copies of the C<len> bytes beginning at C<from>, placing them
3306 into memory beginning at C<to>, which must be big enough to accommodate them
3312 #define PERL_REPEATCPY_LINEAR 4
3314 Perl_repeatcpy(char *to, const char *from, SSize_t len, IV count)
3316 PERL_ARGS_ASSERT_REPEATCPY;
3321 croak_memory_wrap();
3324 memset(to, *from, count);
3327 IV items, linear, half;
3329 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3330 for (items = 0; items < linear; ++items) {
3331 const char *q = from;
3333 for (todo = len; todo > 0; todo--)
3338 while (items <= half) {
3339 IV size = items * len;
3340 memcpy(p, to, size);
3346 memcpy(p, to, (count - items) * len);
3352 Perl_same_dirent(pTHX_ const char *a, const char *b)
3354 char *fa = strrchr(a,'/');
3355 char *fb = strrchr(b,'/');
3358 SV * const tmpsv = sv_newmortal();
3360 PERL_ARGS_ASSERT_SAME_DIRENT;
3373 sv_setpvs(tmpsv, ".");
3375 sv_setpvn(tmpsv, a, fa - a);
3376 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3379 sv_setpvs(tmpsv, ".");
3381 sv_setpvn(tmpsv, b, fb - b);
3382 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3384 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3385 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3387 #endif /* !HAS_RENAME */
3390 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3391 const char *const *const search_ext, I32 flags)
3393 const char *xfound = NULL;
3394 char *xfailed = NULL;
3395 char tmpbuf[MAXPATHLEN];
3400 #if defined(DOSISH) && !defined(OS2)
3401 # define SEARCH_EXTS ".bat", ".cmd", NULL
3402 # define MAX_EXT_LEN 4
3405 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3406 # define MAX_EXT_LEN 4
3409 # define SEARCH_EXTS ".pl", ".com", NULL
3410 # define MAX_EXT_LEN 4
3412 /* additional extensions to try in each dir if scriptname not found */
3414 static const char *const exts[] = { SEARCH_EXTS };
3415 const char *const *const ext = search_ext ? search_ext : exts;
3416 int extidx = 0, i = 0;
3417 const char *curext = NULL;
3419 PERL_UNUSED_ARG(search_ext);
3420 # define MAX_EXT_LEN 0
3423 PERL_ARGS_ASSERT_FIND_SCRIPT;
3426 * If dosearch is true and if scriptname does not contain path
3427 * delimiters, search the PATH for scriptname.
3429 * If SEARCH_EXTS is also defined, will look for each
3430 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3431 * while searching the PATH.
3433 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3434 * proceeds as follows:
3435 * If DOSISH or VMSISH:
3436 * + look for ./scriptname{,.foo,.bar}
3437 * + search the PATH for scriptname{,.foo,.bar}
3440 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3441 * this will not look in '.' if it's not in the PATH)
3446 # ifdef ALWAYS_DEFTYPES
3447 len = strlen(scriptname);
3448 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3449 int idx = 0, deftypes = 1;
3452 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3455 int idx = 0, deftypes = 1;
3458 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3460 /* The first time through, just add SEARCH_EXTS to whatever we
3461 * already have, so we can check for default file types. */
3463 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3470 if ((strlen(tmpbuf) + strlen(scriptname)
3471 + MAX_EXT_LEN) >= sizeof tmpbuf)
3472 continue; /* don't search dir with too-long name */
3473 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3477 if (strEQ(scriptname, "-"))
3479 if (dosearch) { /* Look in '.' first. */
3480 const char *cur = scriptname;
3482 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3484 if (strEQ(ext[i++],curext)) {
3485 extidx = -1; /* already has an ext */
3490 DEBUG_p(PerlIO_printf(Perl_debug_log,
3491 "Looking for %s\n",cur));
3494 if (PerlLIO_stat(cur,&statbuf) >= 0
3495 && !S_ISDIR(statbuf.st_mode)) {
3504 if (cur == scriptname) {
3505 len = strlen(scriptname);
3506 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3508 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3511 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3512 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3517 if (dosearch && !strchr(scriptname, '/')
3519 && !strchr(scriptname, '\\')
3521 && (s = PerlEnv_getenv("PATH")))
3525 bufend = s + strlen(s);
3526 while (s < bufend) {
3530 && *s != ';'; len++, s++) {
3531 if (len < sizeof tmpbuf)
3534 if (len < sizeof tmpbuf)
3537 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3542 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3543 continue; /* don't search dir with too-long name */
3546 && tmpbuf[len - 1] != '/'
3547 && tmpbuf[len - 1] != '\\'
3550 tmpbuf[len++] = '/';
3551 if (len == 2 && tmpbuf[0] == '.')
3553 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3557 len = strlen(tmpbuf);
3558 if (extidx > 0) /* reset after previous loop */
3562 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3563 retval = PerlLIO_stat(tmpbuf,&statbuf);
3564 if (S_ISDIR(statbuf.st_mode)) {
3568 } while ( retval < 0 /* not there */
3569 && extidx>=0 && ext[extidx] /* try an extension? */
3570 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3575 if (S_ISREG(statbuf.st_mode)
3576 && cando(S_IRUSR,TRUE,&statbuf)
3577 #if !defined(DOSISH)
3578 && cando(S_IXUSR,TRUE,&statbuf)
3582 xfound = tmpbuf; /* bingo! */
3586 xfailed = savepv(tmpbuf);
3591 if (!xfound && !seen_dot && !xfailed &&
3592 (PerlLIO_stat(scriptname,&statbuf) < 0
3593 || S_ISDIR(statbuf.st_mode)))
3595 seen_dot = 1; /* Disable message. */
3600 if (flags & 1) { /* do or die? */
3601 /* diag_listed_as: Can't execute %s */
3602 Perl_croak(aTHX_ "Can't %s %s%s%s",
3603 (xfailed ? "execute" : "find"),
3604 (xfailed ? xfailed : scriptname),
3605 (xfailed ? "" : " on PATH"),
3606 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3611 scriptname = xfound;
3613 return (scriptname ? savepv(scriptname) : NULL);
3616 #ifndef PERL_GET_CONTEXT_DEFINED
3619 =for apidoc_section $embedding
3620 =for apidoc set_context
3622 Implements L<perlapi/C<PERL_SET_CONTEXT>>, which you should use instead.
3628 Perl_set_context(void *t)
3630 PERL_ARGS_ASSERT_SET_CONTEXT;
3631 #if defined(USE_ITHREADS)
3632 # ifdef PERL_USE_THREAD_LOCAL
3633 PL_current_context = t;
3635 # ifdef I_MACH_CTHREADS
3636 cthread_set_data(cthread_self(), t);
3638 /* We set thread-specific value always, as C++ code has to read it with
3639 * pthreads, because the declaration syntax for thread local storage for C11
3640 * is incompatible with C++, meaning that we can't expose the thread local
3641 * variable to C++ code. */
3643 const int error = pthread_setspecific(PL_thr_key, t);
3645 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3649 PERL_SET_NON_tTHX_CONTEXT((PerlInterpreter *) t);
3656 #endif /* !PERL_GET_CONTEXT_DEFINED */
3659 =for apidoc get_op_names
3661 Return a pointer to the array of all the names of the various OPs
3662 Given an opcode from the enum in F<opcodes.h>, C<PL_op_name[opcode]> returns a
3663 pointer to a C language string giving its name.
3669 Perl_get_op_names(pTHX)
3671 PERL_UNUSED_CONTEXT;
3672 return (char **)PL_op_name;
3676 =for apidoc get_op_descs
3678 Return a pointer to the array of all the descriptions of the various OPs
3679 Given an opcode from the enum in F<opcodes.h>, C<PL_op_desc[opcode]> returns a
3680 pointer to a C language string giving its description.
3686 Perl_get_op_descs(pTHX)
3688 PERL_UNUSED_CONTEXT;
3689 return (char **)PL_op_desc;
3693 Perl_get_no_modify(pTHX)
3695 PERL_UNUSED_CONTEXT;
3696 return PL_no_modify;
3700 Perl_get_opargs(pTHX)
3702 PERL_UNUSED_CONTEXT;
3703 return (U32 *)PL_opargs;
3707 Perl_get_ppaddr(pTHX)
3709 PERL_UNUSED_CONTEXT;
3710 return (PPADDR_t*)PL_ppaddr;
3713 #ifndef HAS_GETENV_LEN
3715 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3717 char * const env_trans = PerlEnv_getenv(env_elem);
3718 PERL_UNUSED_CONTEXT;
3719 PERL_ARGS_ASSERT_GETENV_LEN;
3721 *len = strlen(env_trans);
3727 =for apidoc_section $io
3728 =for apidoc my_fflush_all
3730 Implements C<PERL_FLUSHALL_FOR_CHILD> on some platforms.
3736 Perl_my_fflush_all(pTHX)
3738 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3739 return PerlIO_flush(NULL);
3741 # if defined(HAS__FWALK)
3742 extern int fflush(FILE *);
3743 /* undocumented, unprototyped, but very useful BSDism */
3744 extern void _fwalk(int (*)(FILE *));
3748 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3750 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3751 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3752 # elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3753 open_max = sysconf(_SC_OPEN_MAX);
3754 # elif defined(FOPEN_MAX)
3755 open_max = FOPEN_MAX;
3756 # elif defined(OPEN_MAX)
3757 open_max = OPEN_MAX;
3758 # elif defined(_NFILE)
3763 for (i = 0; i < open_max; i++)
3764 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3765 STDIO_STREAM_ARRAY[i]._file < open_max &&
3766 STDIO_STREAM_ARRAY[i]._flag)
3767 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3771 SETERRNO(EBADF,RMS_IFI);
3778 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3780 if (ckWARN(WARN_IO)) {
3782 = gv && (isGV_with_GP(gv))
3785 const char * const direction = have == '>' ? "out" : "in";
3787 if (name && HEK_LEN(name))
3788 Perl_warner(aTHX_ packWARN(WARN_IO),
3789 "Filehandle %" HEKf " opened only for %sput",
3790 HEKfARG(name), direction);
3792 Perl_warner(aTHX_ packWARN(WARN_IO),
3793 "Filehandle opened only for %sput", direction);
3798 Perl_report_evil_fh(pTHX_ const GV *gv)
3800 const IO *io = gv ? GvIO(gv) : NULL;
3801 const PERL_BITFIELD16 op = PL_op->op_type;
3805 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3807 warn_type = WARN_CLOSED;
3811 warn_type = WARN_UNOPENED;
3814 if (ckWARN(warn_type)) {
3816 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3817 newSVhek_mortal(GvENAME_HEK(gv)) : NULL;
3818 const char * const pars =
3819 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3820 const char * const func =
3822 (op == OP_READLINE || op == OP_RCATLINE
3823 ? "readline" : /* "<HANDLE>" not nice */
3824 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3826 const char * const type =
3828 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3829 ? "socket" : "filehandle");
3830 const bool have_name = name && SvCUR(name);
3831 Perl_warner(aTHX_ packWARN(warn_type),
3832 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3833 have_name ? " " : "",
3834 SVfARG(have_name ? name : &PL_sv_no));
3835 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3837 aTHX_ packWARN(warn_type),
3838 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3839 func, pars, have_name ? " " : "",
3840 SVfARG(have_name ? name : &PL_sv_no)
3845 /* To workaround core dumps from the uninitialised tm_zone we get the
3846 * system to give us a reasonable struct to copy. This fix means that
3847 * strftime uses the tm_zone and tm_gmtoff values returned by
3848 * localtime(time()). That should give the desired result most of the
3849 * time. But probably not always!
3851 * This does not address tzname aspects of NETaa14816.
3856 # ifndef STRUCT_TM_HASZONE
3857 # define STRUCT_TM_HASZONE
3861 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3862 # ifndef HAS_TM_TM_ZONE
3863 # define HAS_TM_TM_ZONE
3868 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3870 #ifdef HAS_TM_TM_ZONE
3872 const struct tm* my_tm;
3873 PERL_UNUSED_CONTEXT;
3874 PERL_ARGS_ASSERT_INIT_TM;
3878 my_tm = localtime(&now);
3880 Copy(my_tm, ptm, 1, struct tm);
3883 PERL_UNUSED_CONTEXT;
3884 PERL_ARGS_ASSERT_INIT_TM;
3885 PERL_UNUSED_ARG(ptm);
3890 =for apidoc_section $time
3891 =for apidoc mini_mktime
3892 normalise S<C<struct tm>> values without the localtime() semantics (and
3893 overhead) of mktime().
3898 Perl_mini_mktime(struct tm *ptm)
3902 int month, mday, year, jday;
3903 int odd_cent, odd_year;
3905 PERL_ARGS_ASSERT_MINI_MKTIME;
3907 #define DAYS_PER_YEAR 365
3908 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3909 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3910 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3911 #define SECS_PER_HOUR (60*60)
3912 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3913 /* parentheses deliberately absent on these two, otherwise they don't work */
3914 #define MONTH_TO_DAYS 153/5
3915 #define DAYS_TO_MONTH 5/153
3916 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3917 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3918 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3919 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3922 * Year/day algorithm notes:
3924 * With a suitable offset for numeric value of the month, one can find
3925 * an offset into the year by considering months to have 30.6 (153/5) days,
3926 * using integer arithmetic (i.e., with truncation). To avoid too much
3927 * messing about with leap days, we consider January and February to be
3928 * the 13th and 14th month of the previous year. After that transformation,
3929 * we need the month index we use to be high by 1 from 'normal human' usage,
3930 * so the month index values we use run from 4 through 15.
3932 * Given that, and the rules for the Gregorian calendar (leap years are those
3933 * divisible by 4 unless also divisible by 100, when they must be divisible
3934 * by 400 instead), we can simply calculate the number of days since some
3935 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3936 * the days we derive from our month index, and adding in the day of the
3937 * month. The value used here is not adjusted for the actual origin which
3938 * it normally would use (1 January A.D. 1), since we're not exposing it.
3939 * We're only building the value so we can turn around and get the
3940 * normalised values for the year, month, day-of-month, and day-of-year.
3942 * For going backward, we need to bias the value we're using so that we find
3943 * the right year value. (Basically, we don't want the contribution of
3944 * March 1st to the number to apply while deriving the year). Having done
3945 * that, we 'count up' the contribution to the year number by accounting for
3946 * full quadracenturies (400-year periods) with their extra leap days, plus
3947 * the contribution from full centuries (to avoid counting in the lost leap
3948 * days), plus the contribution from full quad-years (to count in the normal
3949 * leap days), plus the leftover contribution from any non-leap years.
3950 * At this point, if we were working with an actual leap day, we'll have 0
3951 * days left over. This is also true for March 1st, however. So, we have
3952 * to special-case that result, and (earlier) keep track of the 'odd'
3953 * century and year contributions. If we got 4 extra centuries in a qcent,
3954 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3955 * Otherwise, we add back in the earlier bias we removed (the 123 from
3956 * figuring in March 1st), find the month index (integer division by 30.6),
3957 * and the remainder is the day-of-month. We then have to convert back to
3958 * 'real' months (including fixing January and February from being 14/15 in
3959 * the previous year to being in the proper year). After that, to get
3960 * tm_yday, we work with the normalised year and get a new yearday value for
3961 * January 1st, which we subtract from the yearday value we had earlier,
3962 * representing the date we've re-built. This is done from January 1
3963 * because tm_yday is 0-origin.
3965 * Since POSIX time routines are only guaranteed to work for times since the
3966 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3967 * applies Gregorian calendar rules even to dates before the 16th century
3968 * doesn't bother me. Besides, you'd need cultural context for a given
3969 * date to know whether it was Julian or Gregorian calendar, and that's
3970 * outside the scope for this routine. Since we convert back based on the
3971 * same rules we used to build the yearday, you'll only get strange results
3972 * for input which needed normalising, or for the 'odd' century years which
3973 * were leap years in the Julian calendar but not in the Gregorian one.
3974 * I can live with that.
3976 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3977 * that's still outside the scope for POSIX time manipulation, so I don't
3983 year = 1900 + ptm->tm_year;
3984 month = ptm->tm_mon;
3985 mday = ptm->tm_mday;
3991 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3992 yearday += month*MONTH_TO_DAYS + mday + jday;
3994 * Note that we don't know when leap-seconds were or will be,
3995 * so we have to trust the user if we get something which looks
3996 * like a sensible leap-second. Wild values for seconds will
3997 * be rationalised, however.
3999 if ((unsigned) ptm->tm_sec <= 60) {
4006 secs += 60 * ptm->tm_min;
4007 secs += SECS_PER_HOUR * ptm->tm_hour;
4009 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
4010 /* got negative remainder, but need positive time */
4011 /* back off an extra day to compensate */
4012 yearday += (secs/SECS_PER_DAY)-1;
4013 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
4016 yearday += (secs/SECS_PER_DAY);
4017 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
4020 else if (secs >= SECS_PER_DAY) {
4021 yearday += (secs/SECS_PER_DAY);
4022 secs %= SECS_PER_DAY;
4024 ptm->tm_hour = secs/SECS_PER_HOUR;
4025 secs %= SECS_PER_HOUR;
4026 ptm->tm_min = secs/60;
4028 ptm->tm_sec += secs;
4029 /* done with time of day effects */
4031 * The algorithm for yearday has (so far) left it high by 428.
4032 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
4033 * bias it by 123 while trying to figure out what year it
4034 * really represents. Even with this tweak, the reverse
4035 * translation fails for years before A.D. 0001.
4036 * It would still fail for Feb 29, but we catch that one below.
4038 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
4039 yearday -= YEAR_ADJUST;
4040 year = (yearday / DAYS_PER_QCENT) * 400;
4041 yearday %= DAYS_PER_QCENT;
4042 odd_cent = yearday / DAYS_PER_CENT;
4043 year += odd_cent * 100;
4044 yearday %= DAYS_PER_CENT;
4045 year += (yearday / DAYS_PER_QYEAR) * 4;
4046 yearday %= DAYS_PER_QYEAR;
4047 odd_year = yearday / DAYS_PER_YEAR;
4049 yearday %= DAYS_PER_YEAR;
4050 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
4055 yearday += YEAR_ADJUST; /* recover March 1st crock */
4056 month = yearday*DAYS_TO_MONTH;
4057 yearday -= month*MONTH_TO_DAYS;
4058 /* recover other leap-year adjustment */
4067 ptm->tm_year = year - 1900;
4069 ptm->tm_mday = yearday;
4070 ptm->tm_mon = month;
4074 ptm->tm_mon = month - 1;
4076 /* re-build yearday based on Jan 1 to get tm_yday */
4078 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
4079 yearday += 14*MONTH_TO_DAYS + 1;
4080 ptm->tm_yday = jday - yearday;
4081 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
4084 #define SV_CWD_RETURN_UNDEF \
4088 #define SV_CWD_ISDOT(dp) \
4089 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4090 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4093 =for apidoc_section $utility
4095 =for apidoc getcwd_sv
4097 Fill C<sv> with current working directory
4102 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4103 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4104 * getcwd(3) if available
4105 * Comments from the original:
4106 * This is a faster version of getcwd. It's also more dangerous
4107 * because you might chdir out of a directory that you can't chdir
4111 Perl_getcwd_sv(pTHX_ SV *sv)
4115 PERL_ARGS_ASSERT_GETCWD_SV;
4119 char buf[MAXPATHLEN];
4121 /* Some getcwd()s automatically allocate a buffer of the given
4122 * size from the heap if they are given a NULL buffer pointer.
4123 * The problem is that this behaviour is not portable. */
4124 if (getcwd(buf, sizeof(buf) - 1)) {
4129 SV_CWD_RETURN_UNDEF;
4136 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4140 SvUPGRADE(sv, SVt_PV);
4142 if (PerlLIO_lstat(".", &statbuf) < 0) {
4143 SV_CWD_RETURN_UNDEF;
4146 orig_cdev = statbuf.st_dev;
4147 orig_cino = statbuf.st_ino;
4157 if (PerlDir_chdir("..") < 0) {
4158 SV_CWD_RETURN_UNDEF;
4160 if (PerlLIO_stat(".", &statbuf) < 0) {
4161 SV_CWD_RETURN_UNDEF;
4164 cdev = statbuf.st_dev;
4165 cino = statbuf.st_ino;
4167 if (odev == cdev && oino == cino) {
4170 if (!(dir = PerlDir_open("."))) {
4171 SV_CWD_RETURN_UNDEF;
4174 while ((dp = PerlDir_read(dir)) != NULL) {
4176 namelen = dp->d_namlen;
4178 namelen = strlen(dp->d_name);
4181 if (SV_CWD_ISDOT(dp)) {
4185 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4186 SV_CWD_RETURN_UNDEF;
4189 tdev = statbuf.st_dev;
4190 tino = statbuf.st_ino;
4191 if (tino == oino && tdev == odev) {
4197 SV_CWD_RETURN_UNDEF;
4200 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4201 SV_CWD_RETURN_UNDEF;
4204 SvGROW(sv, pathlen + namelen + 1);
4208 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4211 /* prepend current directory to the front */
4213 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4214 pathlen += (namelen + 1);
4216 #ifdef VOID_CLOSEDIR
4219 if (PerlDir_close(dir) < 0) {
4220 SV_CWD_RETURN_UNDEF;
4226 SvCUR_set(sv, pathlen);
4230 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4231 SV_CWD_RETURN_UNDEF;
4234 if (PerlLIO_stat(".", &statbuf) < 0) {
4235 SV_CWD_RETURN_UNDEF;
4238 cdev = statbuf.st_dev;
4239 cino = statbuf.st_ino;
4241 if (cdev != orig_cdev || cino != orig_cino) {
4242 Perl_croak(aTHX_ "Unstable directory path, "
4243 "current directory changed unexpectedly");
4253 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4254 # define EMULATE_SOCKETPAIR_UDP
4257 #ifdef EMULATE_SOCKETPAIR_UDP
4259 S_socketpair_udp (int fd[2]) {
4261 /* Fake a datagram socketpair using UDP to localhost. */
4262 int sockets[2] = {-1, -1};
4263 struct sockaddr_in addresses[2];
4265 Sock_size_t size = sizeof(struct sockaddr_in);
4266 unsigned short port;
4269 memset(&addresses, 0, sizeof(addresses));
4272 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4273 if (sockets[i] == -1)
4274 goto tidy_up_and_fail;
4276 addresses[i].sin_family = AF_INET;
4277 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4278 addresses[i].sin_port = 0; /* kernel chooses port. */
4279 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4280 sizeof(struct sockaddr_in)) == -1)
4281 goto tidy_up_and_fail;
4284 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4285 for each connect the other socket to it. */
4288 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4290 goto tidy_up_and_fail;
4291 if (size != sizeof(struct sockaddr_in))
4292 goto abort_tidy_up_and_fail;
4293 /* !1 is 0, !0 is 1 */
4294 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4295 sizeof(struct sockaddr_in)) == -1)
4296 goto tidy_up_and_fail;
4299 /* Now we have 2 sockets connected to each other. I don't trust some other
4300 process not to have already sent a packet to us (by random) so send
4301 a packet from each to the other. */
4304 /* I'm going to send my own port number. As a short.
4305 (Who knows if someone somewhere has sin_port as a bitfield and needs
4306 this routine. (I'm assuming crays have socketpair)) */
4307 port = addresses[i].sin_port;
4308 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4309 if (got != sizeof(port)) {
4311 goto tidy_up_and_fail;
4312 goto abort_tidy_up_and_fail;
4316 /* Packets sent. I don't trust them to have arrived though.
4317 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4318 connect to localhost will use a second kernel thread. In 2.6 the
4319 first thread running the connect() returns before the second completes,
4320 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4321 returns 0. Poor programs have tripped up. One poor program's authors'
4322 had a 50-1 reverse stock split. Not sure how connected these were.)
4323 So I don't trust someone not to have an unpredictable UDP stack.
4327 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4328 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4332 FD_SET((unsigned int)sockets[0], &rset);
4333 FD_SET((unsigned int)sockets[1], &rset);
4335 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4336 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4337 || !FD_ISSET(sockets[1], &rset)) {
4338 /* I hope this is portable and appropriate. */
4340 goto tidy_up_and_fail;
4341 goto abort_tidy_up_and_fail;
4345 /* And the paranoia department even now doesn't trust it to have arrive
4346 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4348 struct sockaddr_in readfrom;
4349 unsigned short buffer[2];
4354 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4355 sizeof(buffer), MSG_DONTWAIT,
4356 (struct sockaddr *) &readfrom, &size);
4358 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4360 (struct sockaddr *) &readfrom, &size);
4364 goto tidy_up_and_fail;
4365 if (got != sizeof(port)
4366 || size != sizeof(struct sockaddr_in)
4367 /* Check other socket sent us its port. */
4368 || buffer[0] != (unsigned short) addresses[!i].sin_port
4369 /* Check kernel says we got the datagram from that socket */
4370 || readfrom.sin_family != addresses[!i].sin_family
4371 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4372 || readfrom.sin_port != addresses[!i].sin_port)
4373 goto abort_tidy_up_and_fail;
4376 /* My caller (my_socketpair) has validated that this is non-NULL */
4379 /* I hereby declare this connection open. May God bless all who cross
4383 abort_tidy_up_and_fail:
4384 errno = ECONNABORTED;
4388 if (sockets[0] != -1)
4389 PerlLIO_close(sockets[0]);
4390 if (sockets[1] != -1)
4391 PerlLIO_close(sockets[1]);
4396 #endif /* EMULATE_SOCKETPAIR_UDP */
4398 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4401 =for apidoc my_socketpair
4403 Emulates L<socketpair(2)> on systems that don't have it, but which do have
4404 enough functionality for the emulation.
4410 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4411 /* Stevens says that family must be AF_LOCAL, protocol 0.
4412 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4417 struct sockaddr_in listen_addr;
4418 struct sockaddr_in connect_addr;
4423 || family != AF_UNIX
4426 errno = EAFNOSUPPORT;
4435 type &= ~SOCK_CLOEXEC;
4438 #ifdef EMULATE_SOCKETPAIR_UDP
4439 if (type == SOCK_DGRAM)
4440 return S_socketpair_udp(fd);
4443 aTHXa(PERL_GET_THX);
4444 listener = PerlSock_socket(AF_INET, type, 0);
4447 memset(&listen_addr, 0, sizeof(listen_addr));
4448 listen_addr.sin_family = AF_INET;
4449 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4450 listen_addr.sin_port = 0; /* kernel chooses port. */
4451 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4452 sizeof(listen_addr)) == -1)
4453 goto tidy_up_and_fail;
4454 if (PerlSock_listen(listener, 1) == -1)
4455 goto tidy_up_and_fail;
4457 connector = PerlSock_socket(AF_INET, type, 0);
4458 if (connector == -1)
4459 goto tidy_up_and_fail;
4460 /* We want to find out the port number to connect to. */
4461 size = sizeof(connect_addr);
4462 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4464 goto tidy_up_and_fail;
4465 if (size != sizeof(connect_addr))
4466 goto abort_tidy_up_and_fail;
4467 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4468 sizeof(connect_addr)) == -1)
4469 goto tidy_up_and_fail;
4471 size = sizeof(listen_addr);
4472 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4475 goto tidy_up_and_fail;
4476 if (size != sizeof(listen_addr))
4477 goto abort_tidy_up_and_fail;
4478 PerlLIO_close(listener);
4479 /* Now check we are talking to ourself by matching port and host on the
4481 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4483 goto tidy_up_and_fail;
4484 if (size != sizeof(connect_addr)
4485 || listen_addr.sin_family != connect_addr.sin_family
4486 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4487 || listen_addr.sin_port != connect_addr.sin_port) {
4488 goto abort_tidy_up_and_fail;
4494 abort_tidy_up_and_fail:
4496 errno = ECONNABORTED; /* This would be the standard thing to do. */
4497 #elif defined(ECONNREFUSED)
4498 errno = ECONNREFUSED; /* some OSes might not have ECONNABORTED. */
4500 errno = ETIMEDOUT; /* Desperation time. */
4506 PerlLIO_close(listener);
4507 if (connector != -1)
4508 PerlLIO_close(connector);
4510 PerlLIO_close(acceptor);
4516 /* In any case have a stub so that there's code corresponding
4517 * to the my_socketpair in embed.fnc. */
4519 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4520 #ifdef HAS_SOCKETPAIR
4521 return socketpair(family, type, protocol, fd);
4530 =for apidoc sv_nosharing
4532 Dummy routine which "shares" an SV when there is no sharing module present.
4533 Or "locks" it. Or "unlocks" it. In other
4534 words, ignores its single SV argument.
4535 Exists to avoid test for a C<NULL> function pointer and because it could
4536 potentially warn under some level of strict-ness.
4542 Perl_sv_nosharing(pTHX_ SV *sv)
4544 PERL_UNUSED_CONTEXT;
4545 PERL_UNUSED_ARG(sv);
4550 =for apidoc sv_destroyable
4552 Dummy routine which reports that object can be destroyed when there is no
4553 sharing module present. It ignores its single SV argument, and returns
4554 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4555 could potentially warn under some level of strict-ness.
4561 Perl_sv_destroyable(pTHX_ SV *sv)
4563 PERL_UNUSED_CONTEXT;
4564 PERL_UNUSED_ARG(sv);
4569 Perl_parse_unicode_opts(pTHX_ const char **popt)
4571 const char *p = *popt;
4574 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4578 const char* endptr = p + strlen(p);
4580 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4583 if (p && *p && *p != '\n' && *p != '\r') {
4585 goto the_end_of_the_opts_parser;
4587 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4591 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4597 case PERL_UNICODE_STDIN:
4598 opt |= PERL_UNICODE_STDIN_FLAG; break;
4599 case PERL_UNICODE_STDOUT:
4600 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4601 case PERL_UNICODE_STDERR:
4602 opt |= PERL_UNICODE_STDERR_FLAG; break;
4603 case PERL_UNICODE_STD:
4604 opt |= PERL_UNICODE_STD_FLAG; break;
4605 case PERL_UNICODE_IN:
4606 opt |= PERL_UNICODE_IN_FLAG; break;
4607 case PERL_UNICODE_OUT:
4608 opt |= PERL_UNICODE_OUT_FLAG; break;
4609 case PERL_UNICODE_INOUT:
4610 opt |= PERL_UNICODE_INOUT_FLAG; break;
4611 case PERL_UNICODE_LOCALE:
4612 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4613 case PERL_UNICODE_ARGV:
4614 opt |= PERL_UNICODE_ARGV_FLAG; break;
4615 case PERL_UNICODE_UTF8CACHEASSERT:
4616 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4618 if (*p != '\n' && *p != '\r') {
4619 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4622 "Unknown Unicode option letter '%c'", *p);
4629 opt = PERL_UNICODE_DEFAULT_FLAGS;
4631 the_end_of_the_opts_parser:
4633 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4634 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4635 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4643 # include <starlet.h>
4646 /* hash a pointer and return a U32
4648 * this code was derived from Sereal, which was derived from autobox.
4651 PERL_STATIC_INLINE U32 S_ptr_hash(PTRV u) {
4654 * This is one of Thomas Wang's hash functions for 64-bit integers from:
4655 * http://www.concentric.net/~Ttwang/tech/inthash.htm
4657 u = (~u) + (u << 18);
4665 * This is one of Bob Jenkins' hash functions for 32-bit integers
4666 * from: https://burtleburtle.net/bob/hash/integer.html
4668 u = (u + 0x7ed55d16) + (u << 12);
4669 u = (u ^ 0xc761c23c) ^ (u >> 19);
4670 u = (u + 0x165667b1) + (u << 5);
4671 u = (u + 0xd3a2646c) ^ (u << 9);
4672 u = (u + 0xfd7046c5) + (u << 3);
4673 u = (u ^ 0xb55a4f09) ^ (u >> 16);
4683 * This is really just a quick hack which grabs various garbage
4684 * values. It really should be a real hash algorithm which
4685 * spreads the effect of every input bit onto every output bit,
4686 * if someone who knows about such things would bother to write it.
4687 * Might be a good idea to add that function to CORE as well.
4688 * No numbers below come from careful analysis or anything here,
4689 * except they are primes and SEED_C1 > 1E6 to get a full-width
4690 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4691 * probably be bigger too.
4694 # define SEED_C1 1000003
4695 #define SEED_C4 73819
4697 # define SEED_C1 25747
4698 #define SEED_C4 20639
4702 #define SEED_C5 26107
4704 #ifndef PERL_NO_DEV_RANDOM
4708 #ifdef HAS_GETTIMEOFDAY
4709 struct timeval when;
4714 /* This test is an escape hatch, this symbol isn't set by Configure. */
4715 #ifndef PERL_NO_DEV_RANDOM
4716 #ifndef PERL_RANDOM_DEVICE
4717 /* /dev/random isn't used by default because reads from it will block
4718 * if there isn't enough entropy available. You can compile with
4719 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4720 * is enough real entropy to fill the seed. */
4721 # ifdef __amigaos4__
4722 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4724 # define PERL_RANDOM_DEVICE "/dev/urandom"
4727 fd = PerlLIO_open_cloexec(PERL_RANDOM_DEVICE, 0);
4729 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4737 #ifdef HAS_GETTIMEOFDAY
4738 PerlProc_gettimeofday(&when,NULL);
4739 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4742 u = (U32)SEED_C1 * when;
4744 u += SEED_C3 * (U32)PerlProc_getpid();
4745 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4746 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4747 UV ptruv = PTR2UV(&when);
4748 u += SEED_C5 * ptr_hash(ptruv);
4754 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4756 #ifndef NO_PERL_HASH_ENV
4761 PERL_ARGS_ASSERT_GET_HASH_SEED;
4763 Zero(seed_buffer, PERL_HASH_SEED_BYTES, U8);
4764 Zero((U8*)PL_hash_state_w, PERL_HASH_STATE_BYTES, U8);
4766 #ifndef NO_PERL_HASH_ENV
4767 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4772 PerlIO_printf(Perl_debug_log,"Got PERL_HASH_SEED=<%s>\n", env_pv);
4773 /* ignore leading spaces */
4774 while (isSPACE(*env_pv))
4776 # ifdef USE_PERL_PERTURB_KEYS
4777 /* if they set it to "0" we disable key traversal randomization completely */
4778 if (strEQ(env_pv,"0")) {
4779 PL_hash_rand_bits_enabled= 0;
4781 /* otherwise switch to deterministic mode */
4782 PL_hash_rand_bits_enabled= 2;
4785 /* ignore a leading 0x... if it is there */
4786 if (env_pv[0] == '0' && env_pv[1] == 'x')
4789 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4790 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4791 if ( isXDIGIT(*env_pv)) {
4792 seed_buffer[i] |= READ_XDIGIT(env_pv);
4795 while (isSPACE(*env_pv))
4798 if (*env_pv && !isXDIGIT(*env_pv)) {
4799 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4801 /* should we check for unparsed crap? */
4802 /* should we warn about unused hex? */
4803 /* should we warn about insufficient hex? */
4806 #endif /* NO_PERL_HASH_ENV */
4808 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4809 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
4812 #ifdef USE_PERL_PERTURB_KEYS
4813 # ifndef NO_PERL_HASH_ENV
4814 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4817 PerlIO_printf(Perl_debug_log,
4818 "Got PERL_PERTURB_KEYS=<%s>\n", env_pv);
4819 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4820 PL_hash_rand_bits_enabled= 0;
4821 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4822 PL_hash_rand_bits_enabled= 1;
4823 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4824 PL_hash_rand_bits_enabled= 2;
4826 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4830 { /* initialize PL_hash_rand_bits from the hash seed.
4831 * This value is highly volatile, it is updated every
4832 * hash insert, and is used as part of hash bucket chain
4833 * randomization and hash iterator randomization. */
4834 if (PL_hash_rand_bits_enabled == 1) {
4835 /* random mode initialize from seed() like we would our RNG() */
4836 PL_hash_rand_bits= seed();
4839 /* Use a constant */
4840 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4841 /* and then mix in the leading bytes of the hash seed */
4842 for( i = 0; i < sizeof(UV) ; i++ ) {
4843 PL_hash_rand_bits ^= seed_buffer[i % PERL_HASH_SEED_BYTES];
4844 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4847 if (!PL_hash_rand_bits) {
4848 /* we use an XORSHIFT RNG to munge PL_hash_rand_bits,
4849 * which means it cannot be 0 or it will stay 0 for the
4850 * lifetime of the process, so if by some insane chance we
4851 * ended up with a 0 after the above initialization
4852 * then set it to this. This really should not happen, or
4853 * very very very rarely.
4855 PL_hash_rand_bits = 0x8110ba9d; /* a randomly chosen prime */
4862 Perl_debug_hash_seed(pTHX_ bool via_debug_h)
4864 PERL_ARGS_ASSERT_DEBUG_HASH_SEED;
4865 #if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
4867 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
4868 bool via_env = cBOOL(s && strNE(s, "0") && strNE(s,""));
4870 if ( via_env != via_debug_h ) {
4871 const unsigned char *seed= PERL_HASH_SEED;
4872 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
4873 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
4874 while (seed < seed_end) {
4875 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
4877 #ifdef PERL_HASH_RANDOMIZE_KEYS
4878 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
4879 PL_HASH_RAND_BITS_ENABLED,
4880 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" :
4881 PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM"
4884 PerlIO_printf(Perl_debug_log,
4885 " RAND_BITS=0x%" UVxf, PL_hash_rand_bits);
4887 PerlIO_printf(Perl_debug_log, "\n");
4890 #endif /* #if (defined(USE_HASH_SEED) ... */
4898 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4899 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4900 * given, and you supply your own implementation.
4902 * The default implementation reads a single env var, PERL_MEM_LOG,
4903 * expecting one or more of the following:
4905 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4906 * 'm' - memlog was PERL_MEM_LOG=1
4907 * 's' - svlog was PERL_SV_LOG=1
4908 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4910 * This makes the logger controllable enough that it can reasonably be
4911 * added to the system perl.
4914 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4915 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4917 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 256
4919 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4920 * writes to. In the default logger, this is settable at runtime.
4922 #ifndef PERL_MEM_LOG_FD
4923 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4926 #ifndef PERL_MEM_LOG_NOIMPL
4928 # ifdef DEBUG_LEAKING_SCALARS
4929 # define SV_LOG_SERIAL_FMT " [%lu]"
4930 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4932 # define SV_LOG_SERIAL_FMT
4933 # define _SV_LOG_SERIAL_ARG(sv)
4937 S_mem_log_common(enum mem_log_type mlt, const UV n,
4938 const UV typesize, const char *type_name, const SV *sv,
4939 Malloc_t oldalloc, Malloc_t newalloc,
4940 const char *filename, const int linenumber,
4941 const char *funcname)
4946 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4948 PL_mem_log[0] |= 0x2; /* Flag that the call is from this code */
4949 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4950 PL_mem_log[0] &= ~0x2;
4953 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4955 /* We can't use SVs or PerlIO for obvious reasons,
4956 * so we'll use stdio and low-level IO instead. */
4957 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4959 # ifdef HAS_GETTIMEOFDAY
4960 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4961 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4963 PerlProc_gettimeofday(&tv, 0);
4965 # define MEM_LOG_TIME_FMT "%10d: "
4966 # define MEM_LOG_TIME_ARG (int)when
4970 /* If there are other OS specific ways of hires time than
4971 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4972 * probably that they would be used to fill in the struct
4976 const char* endptr = pmlenv + strlen(pmlenv);
4979 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4980 && uv && uv <= PERL_INT_MAX
4984 fd = PERL_MEM_LOG_FD;
4987 if (strchr(pmlenv, 't')) {
4988 len = my_snprintf(buf, sizeof(buf),
4989 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4990 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4994 len = my_snprintf(buf, sizeof(buf),
4995 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4996 " %s = %" IVdf ": %" UVxf "\n",
4997 filename, linenumber, funcname, n, typesize,
4998 type_name, n * typesize, PTR2UV(newalloc));
5001 len = my_snprintf(buf, sizeof(buf),
5002 "realloc: %s:%d:%s: %" IVdf " %" UVuf
5003 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
5004 filename, linenumber, funcname, n, typesize,
5005 type_name, n * typesize, PTR2UV(oldalloc),
5009 len = my_snprintf(buf, sizeof(buf),
5010 "free: %s:%d:%s: %" UVxf "\n",
5011 filename, linenumber, funcname,
5016 len = my_snprintf(buf, sizeof(buf),
5017 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
5018 mlt == MLT_NEW_SV ? "new" : "del",
5019 filename, linenumber, funcname,
5020 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
5025 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
5026 #ifdef USE_C_BACKTRACE
5027 if(strchr(pmlenv,'c') && (mlt == MLT_NEW_SV)) {
5028 len = my_snprintf(buf, sizeof(buf),
5029 " caller %s at %s line %" LINE_Tf "\n",
5030 /* CopSTASHPV can crash early on startup; use CopFILE to check */
5031 CopFILE(PL_curcop) ? CopSTASHPV(PL_curcop) : "<unknown>",
5032 CopFILE(PL_curcop), CopLINE(PL_curcop));
5033 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
5035 Perl_c_backtrace *bt = Perl_get_c_backtrace(aTHX_ 3, 3);
5036 Perl_c_backtrace_frame *frame;
5038 for (i = 0, frame = bt->frame_info;
5039 i < bt->header.frame_count;
5041 len = my_snprintf(buf, sizeof(buf),
5042 " frame[%" UVuf "]: %p %s at %s +0x%lx\n",
5045 frame->symbol_name_size && frame->symbol_name_offset ? (char *)bt + frame->symbol_name_offset : "-",
5046 frame->object_name_size && frame->object_name_offset ? (char *)bt + frame->object_name_offset : "?",
5047 (char *)frame->addr - (char *)frame->object_base_addr);
5048 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
5050 Perl_free_c_backtrace(bt);
5052 #endif /* USE_C_BACKTRACE */
5056 #endif /* !PERL_MEM_LOG_NOIMPL */
5058 #ifndef PERL_MEM_LOG_NOIMPL
5060 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
5061 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
5063 /* this is suboptimal, but bug compatible. User is providing their
5064 own implementation, but is getting these functions anyway, and they
5065 do nothing. But _NOIMPL users should be able to cope or fix */
5067 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
5068 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
5072 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
5074 const char *filename, const int linenumber,
5075 const char *funcname)
5077 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
5079 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
5080 NULL, NULL, newalloc,
5081 filename, linenumber, funcname);
5086 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
5087 Malloc_t oldalloc, Malloc_t newalloc,
5088 const char *filename, const int linenumber,
5089 const char *funcname)
5091 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
5093 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
5094 NULL, oldalloc, newalloc,
5095 filename, linenumber, funcname);
5100 Perl_mem_log_free(Malloc_t oldalloc,
5101 const char *filename, const int linenumber,
5102 const char *funcname)
5104 PERL_ARGS_ASSERT_MEM_LOG_FREE;
5106 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
5107 filename, linenumber, funcname);
5112 Perl_mem_log_new_sv(const SV *sv,
5113 const char *filename, const int linenumber,
5114 const char *funcname)
5116 PERL_ARGS_ASSERT_MEM_LOG_NEW_SV;
5118 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
5119 filename, linenumber, funcname);
5123 Perl_mem_log_del_sv(const SV *sv,
5124 const char *filename, const int linenumber,
5125 const char *funcname)
5127 PERL_ARGS_ASSERT_MEM_LOG_DEL_SV;
5129 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
5130 filename, linenumber, funcname);
5133 #endif /* PERL_MEM_LOG */
5136 =for apidoc_section $string
5137 =for apidoc quadmath_format_valid
5139 C<quadmath_snprintf()> is very strict about its C<format> string and will
5140 fail, returning -1, if the format is invalid. It accepts exactly
5143 C<quadmath_format_valid()> checks that the intended single spec looks
5144 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
5145 and has C<Q> before it. This is not a full "printf syntax check",
5148 Returns true if it is valid, false if not.
5150 See also L</quadmath_format_needed>.
5156 Perl_quadmath_format_valid(const char* format)
5160 PERL_ARGS_ASSERT_QUADMATH_FORMAT_VALID;
5162 if (format[0] != '%' || strchr(format + 1, '%'))
5164 len = strlen(format);
5165 /* minimum length three: %Qg */
5166 if (len < 3 || memCHRs("efgaEFGA", format[len - 1]) == NULL)
5168 if (format[len - 2] != 'Q')
5175 =for apidoc quadmath_format_needed
5177 C<quadmath_format_needed()> returns true if the C<format> string seems to
5178 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
5179 or returns false otherwise.
5181 The format specifier detection is not complete printf-syntax detection,
5182 but it should catch most common cases.
5184 If true is returned, those arguments B<should> in theory be processed
5185 with C<quadmath_snprintf()>, but in case there is more than one such
5186 format specifier (see L</quadmath_format_valid>), and if there is
5187 anything else beyond that one (even just a single byte), they
5188 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
5189 accepting only one format spec, and nothing else.
5190 In this case, the code should probably fail.
5196 Perl_quadmath_format_needed(const char* format)
5198 const char *p = format;
5201 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5203 while ((q = strchr(p, '%'))) {
5205 if (*q == '+') /* plus */
5207 if (*q == '#') /* alt */
5209 if (*q == '*') /* width */
5213 while (isDIGIT(*q)) q++;
5216 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5221 while (isDIGIT(*q)) q++;
5223 if (memCHRs("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5232 =for apidoc my_snprintf
5234 The C library C<snprintf> functionality, if available and
5235 standards-compliant (uses C<vsnprintf>, actually). However, if the
5236 C<vsnprintf> is not available, will unfortunately use the unsafe
5237 C<vsprintf> which can overrun the buffer (there is an overrun check,
5238 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5239 getting C<vsnprintf>.
5245 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5251 PERL_ARGS_ASSERT_MY_SNPRINTF;
5252 #ifndef HAS_VSNPRINTF
5253 PERL_UNUSED_VAR(len);
5255 va_start(ap, format);
5258 bool quadmath_valid = FALSE;
5260 if (quadmath_format_valid(format)) {
5261 /* If the format looked promising, use it as quadmath. */
5262 WITH_LC_NUMERIC_SET_TO_NEEDED(
5263 retval = quadmath_snprintf(buffer, len, format, va_arg(ap, NV));
5266 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5268 quadmath_valid = TRUE;
5270 /* quadmath_format_single() will return false for example for
5271 * "foo = %g", or simply "%g". We could handle the %g by
5272 * using quadmath for the NV args. More complex cases of
5273 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5274 * quadmath-valid but has stuff in front).
5276 * Handling the "Q-less" cases right would require walking
5277 * through the va_list and rewriting the format, calling
5278 * quadmath for the NVs, building a new va_list, and then
5279 * letting vsnprintf/vsprintf to take care of the other
5280 * arguments. This may be doable.
5282 * We do not attempt that now. But for paranoia, we here try
5283 * to detect some common (but not all) cases where the
5284 * "Q-less" %[efgaEFGA] formats are present, and die if
5285 * detected. This doesn't fix the problem, but it stops the
5286 * vsnprintf/vsprintf pulling doubles off the va_list when
5287 * __float128 NVs should be pulled off instead.
5289 * If quadmath_format_needed() returns false, we are reasonably
5290 * certain that we can call vnsprintf() or vsprintf() safely. */
5291 if (!quadmath_valid && quadmath_format_needed(format))
5292 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5298 #ifdef HAS_VSNPRINTF
5299 WITH_LC_NUMERIC_SET_TO_NEEDED(
5300 retval = vsnprintf(buffer, len, format, ap);
5303 WITH_LC_NUMERIC_SET_TO_NEEDED(
5304 retval = vsprintf(buffer, format, ap);
5311 /* vsprintf() shows failure with < 0 */
5313 #ifdef HAS_VSNPRINTF
5314 /* vsnprintf() shows failure with >= len */
5316 (len > 0 && (Size_t)retval >= len)
5319 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5324 =for apidoc my_vsnprintf
5326 The C library C<vsnprintf> if available and standards-compliant.
5327 However, if the C<vsnprintf> is not available, will unfortunately
5328 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5329 overrun check, but that may be too late). Consider using
5330 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5336 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5339 PERL_UNUSED_ARG(buffer);
5340 PERL_UNUSED_ARG(len);
5341 PERL_UNUSED_ARG(format);
5342 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5343 PERL_UNUSED_ARG((void*)ap);
5344 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5350 # ifdef NEED_VA_COPY
5353 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5354 Perl_va_copy(ap, apc);
5355 # ifdef HAS_VSNPRINTF
5357 WITH_LC_NUMERIC_SET_TO_NEEDED(
5358 retval = vsnprintf(buffer, len, format, apc);
5361 PERL_UNUSED_ARG(len);
5362 WITH_LC_NUMERIC_SET_TO_NEEDED(
5363 retval = vsprintf(buffer, format, apc);
5369 # ifdef HAS_VSNPRINTF
5370 WITH_LC_NUMERIC_SET_TO_NEEDED(
5371 retval = vsnprintf(buffer, len, format, ap);
5374 PERL_UNUSED_ARG(len);
5375 WITH_LC_NUMERIC_SET_TO_NEEDED(
5376 retval = vsprintf(buffer, format, ap);
5379 # endif /* #ifdef NEED_VA_COPY */
5381 /* vsprintf() shows failure with < 0 */
5383 # ifdef HAS_VSNPRINTF
5384 /* vsnprintf() shows failure with >= len */
5386 (len > 0 && (Size_t)retval >= len)
5389 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5396 Perl_my_clearenv(pTHX)
5398 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5400 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5401 # if defined(USE_ENVIRON_ARRAY)
5402 # if defined(USE_ITHREADS)
5403 /* only the parent thread can clobber the process environment, so no need
5405 if (PL_curinterp != aTHX)
5407 # endif /* USE_ITHREADS */
5408 # if defined(HAS_CLEARENV)
5410 # elif defined(HAS_UNSETENV)
5411 int bsiz = 80; /* Most envvar names will be shorter than this. */
5412 char *buf = (char*)safesysmalloc(bsiz);
5413 while (*environ != NULL) {
5414 char *e = strchr(*environ, '=');
5415 int l = e ? e - *environ : (int)strlen(*environ);
5418 bsiz = l + 1; /* + 1 for the \0. */
5419 buf = (char*)safesysmalloc(bsiz);
5421 memcpy(buf, *environ, l);
5426 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5427 /* Just null environ and accept the leakage. */
5429 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5430 # endif /* USE_ENVIRON_ARRAY */
5431 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5437 =for apidoc my_cxt_init
5439 Implements the L<perlxs/C<MY_CXT_INIT>> macro, which you should use instead.
5441 The first time a module is loaded, the global C<PL_my_cxt_index> is incremented,
5442 and that value is assigned to that module's static C<my_cxt_index> (whose
5443 address is passed as an arg). Then, for each interpreter this function is
5444 called for, it makes sure a C<void*> slot is available to hang the static data
5445 off, by allocating or extending the interpreter's C<PL_my_cxt_list> array
5451 Perl_my_cxt_init(pTHX_ int *indexp, size_t size)
5456 PERL_ARGS_ASSERT_MY_CXT_INIT;
5459 /* do initial check without locking.
5460 * -1: not allocated or another thread currently allocating
5461 * other: already allocated by another thread
5464 MUTEX_LOCK(&PL_my_ctx_mutex);
5465 /*now a stricter check with locking */
5468 /* this module hasn't been allocated an index yet */
5469 *indexp = PL_my_cxt_index++;
5471 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5474 /* make sure the array is big enough */
5475 if (PL_my_cxt_size <= index) {
5476 if (PL_my_cxt_size) {
5477 IV new_size = PL_my_cxt_size;
5478 while (new_size <= index)
5480 Renew(PL_my_cxt_list, new_size, void *);
5481 PL_my_cxt_size = new_size;
5484 PL_my_cxt_size = 16;
5485 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5488 /* newSV() allocates one more than needed */
5489 p = (void*)SvPVX(newSV(size-1));
5490 PL_my_cxt_list[index] = p;
5491 Zero(p, size, char);
5495 #endif /* MULTIPLICITY */
5498 /* Perl_xs_handshake():
5499 implement the various XS_*_BOOTCHECK macros, which are added to .c
5500 files by ExtUtils::ParseXS, to check that the perl the module was built
5501 with is binary compatible with the running perl.
5504 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5505 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5507 The meaning of the varargs is determined the U32 key arg (which is not
5508 a format string). The fields of key are assembled by using HS_KEY().
5510 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5511 "PerlInterpreter *" and represents the callers context; otherwise it is
5512 of type "CV *", and is the boot xsub's CV.
5514 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5515 for example, and IO.dll was linked with threaded perl524.dll, and both
5516 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5517 successfully can load IO.dll into the process but simultaneously it
5518 loaded an interpreter of a different version into the process, and XS
5519 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5520 use through perl526.dll's my_perl->Istack_base.
5522 v_my_perl cannot be the first arg, since then 'key' will be out of
5523 place in a threaded vs non-threaded mixup; and analyzing the key
5524 number's bitfields won't reveal the problem, since it will be a valid
5525 key (unthreaded perl) on interp side, but croak will report the XS mod's
5526 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5527 it's a threaded perl and an unthreaded XS module, threaded perl will
5528 look at an uninit C stack or an uninit register to get 'key'
5529 (remember that it assumes that the 1st arg is the interp cxt).
5531 'file' is the source filename of the caller.
5535 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5542 const char *stage = "first";
5550 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5551 va_start(args, file);
5553 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5554 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5555 if (UNLIKELY(got != need))
5557 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5558 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5559 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5560 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5561 passed to the XS DLL */
5563 xs_interp = (tTHX)v_my_perl;
5567 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5568 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5569 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5570 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5571 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5572 location in the unthreaded perl binary) stored in CV * to figure out if this
5573 Perl_xs_handshake was called by the same pp_entersub */
5574 cv = (CV*)v_my_perl;
5575 xs_spp = (SV***)CvHSCXT(cv);
5577 need = &PL_stack_sp;
5580 if(UNLIKELY(got != need)) {
5581 bad_handshake:/* recycle branch and string from above */
5582 if(got != (void *)HSf_NOCHK)
5583 noperl_die("%s: loadable library and perl binaries are mismatched"
5584 " (got %s handshake key %p, needed %p)\n",
5585 file, stage, got, need);
5588 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5589 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5590 PL_xsubfilename = file; /* so the old name must be restored for
5591 additional XSUBs to register themselves */
5592 /* XSUBs can't be perl lang/perl5db.pl debugged
5593 if (PERLDB_LINE_OR_SAVESRC)
5594 (void)gv_fetchfile(file); */
5597 if(key & HSf_POPMARK) {
5599 { SV **mark = PL_stack_base + ax++;
5601 items = (Stack_off_t)(SP - MARK);
5605 items = va_arg(args, Stack_off_t);
5606 ax = va_arg(args, Stack_off_t);
5612 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5613 if((apiverlen = HS_GETAPIVERLEN(key))) {
5614 char * api_p = va_arg(args, char*);
5615 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5616 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5617 sizeof("v" PERL_API_VERSION_STRING)-1))
5618 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5619 api_p, SVfARG(PL_stack_base[ax + 0]),
5620 "v" PERL_API_VERSION_STRING);
5624 U32 xsverlen = HS_GETXSVERLEN(key);
5625 assert(xsverlen <= UCHAR_MAX && xsverlen <= HS_APIVERLEN_MAX);
5627 S_xs_version_bootcheck(aTHX_
5628 items, ax, va_arg(args, char*), xsverlen);
5636 S_xs_version_bootcheck(pTHX_ SSize_t items, SSize_t ax, const char *xs_p,
5640 const char *vn = NULL;
5641 SV *const module = PL_stack_base[ax];
5643 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5645 if (items >= 2) /* version supplied as bootstrap arg */
5646 sv = PL_stack_base[ax + 1];
5648 /* XXX GV_ADDWARN */
5650 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5651 if (!sv || !SvOK(sv)) {
5653 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5657 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5658 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5659 ? sv : sv_2mortal(new_version(sv));
5660 xssv = upg_version(xssv, 0);
5661 if ( vcmp(pmsv,xssv) ) {
5662 SV *string = vstringify(xssv);
5663 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5664 " does not match ", SVfARG(module), SVfARG(string));
5666 SvREFCNT_dec(string);
5667 string = vstringify(pmsv);
5670 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5673 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5675 SvREFCNT_dec(string);
5677 Perl_sv_2mortal(aTHX_ xpt);
5678 Perl_croak_sv(aTHX_ xpt);
5683 PERL_STATIC_INLINE bool
5684 S_gv_has_usable_name(pTHX_ GV *gv)
5688 && HvHasENAME(GvSTASH(gv))
5689 && (gvp = (GV **)hv_fetchhek(
5690 GvSTASH(gv), GvNAME_HEK(gv), 0
5696 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5698 SV * const dbsv = GvSVn(PL_DBsub);
5699 const bool save_taint = TAINT_get;
5701 /* When we are called from pp_goto (svp is null),
5702 * we do not care about using dbsv to call CV;
5703 * it's for informational purposes only.
5706 PERL_ARGS_ASSERT_GET_DB_SUB;
5710 if (!PERLDB_SUB_NN) {
5713 if (!svp && !CvLEXICAL(cv)) {
5714 gv_efullname3(dbsv, gv, NULL);
5716 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5717 || strEQ(GvNAME(gv), "END")
5718 || ( /* Could be imported, and old sub redefined. */
5719 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5721 !( (SvTYPE(*svp) == SVt_PVGV)
5722 && (GvCV((const GV *)*svp) == cv)
5723 /* Use GV from the stack as a fallback. */
5724 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5728 /* GV is potentially non-unique, or contain different CV. */
5729 SV * const tmp = newRV(MUTABLE_SV(cv));
5730 sv_setsv(dbsv, tmp);
5734 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5735 sv_catpvs(dbsv, "::");
5736 sv_cathek(dbsv, GvNAME_HEK(gv));
5740 const int type = SvTYPE(dbsv);
5741 if (type < SVt_PVIV && type != SVt_IV)
5742 sv_upgrade(dbsv, SVt_PVIV);
5743 (void)SvIOK_on(dbsv);
5744 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5747 TAINT_IF(save_taint);
5748 #ifdef NO_TAINT_SUPPORT
5749 PERL_UNUSED_VAR(save_taint);
5754 =for apidoc_section $io
5755 =for apidoc my_dirfd
5757 The C library C<L<dirfd(3)>> if available, or a Perl implementation of it, or die
5758 if not easily emulatable.
5764 Perl_my_dirfd(DIR * dir) {
5766 /* Most dirfd implementations have problems when passed NULL. */
5771 #elif defined(HAS_DIR_DD_FD)
5774 Perl_croak_nocontext(PL_no_func, "dirfd");
5775 NOT_REACHED; /* NOTREACHED */
5780 #if !defined(HAS_MKOSTEMP) || !defined(HAS_MKSTEMP)
5782 #define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
5783 #define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
5786 S_my_mkostemp(char *templte, int flags) {
5788 STRLEN len = strlen(templte);
5792 int delete_on_close = flags & O_VMS_DELETEONCLOSE;
5794 flags &= ~O_VMS_DELETEONCLOSE;
5798 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
5799 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
5800 SETERRNO(EINVAL, LIB_INVARG);
5806 for (i = 1; i <= 6; ++i) {
5807 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
5810 if (delete_on_close) {
5811 fd = open(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600, "fop=dlt");
5816 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600);
5818 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
5825 #ifndef HAS_MKOSTEMP
5828 =for apidoc my_mkostemp
5830 The C library C<L<mkostemp(3)>> if available, or a Perl implementation of it.
5836 Perl_my_mkostemp(char *templte, int flags)
5838 PERL_ARGS_ASSERT_MY_MKOSTEMP;
5839 return S_my_mkostemp(templte, flags);
5846 =for apidoc my_mkstemp
5848 The C library C<L<mkstemp(3)>> if available, or a Perl implementation of it.
5854 Perl_my_mkstemp(char *templte)
5856 PERL_ARGS_ASSERT_MY_MKSTEMP;
5857 return S_my_mkostemp(templte, 0);
5862 Perl_get_re_arg(pTHX_ SV *sv) {
5868 sv = MUTABLE_SV(SvRV(sv));
5869 if (SvTYPE(sv) == SVt_REGEXP)
5870 return (REGEXP*) sv;
5877 * This code is derived from drand48() implementation from FreeBSD,
5878 * found in lib/libc/gen/_rand48.c.
5880 * The U64 implementation is original, based on the POSIX
5881 * specification for drand48().
5885 * Copyright (c) 1993 Martin Birgmeier
5886 * All rights reserved.
5888 * You may redistribute unmodified or modified versions of this source
5889 * code provided that the above copyright notice and this and the
5890 * following conditions are retained.
5892 * This software is provided ``as is'', and comes with no warranties
5893 * of any kind. I shall in no event be liable for anything that happens
5894 * to anyone/anything when using this software.
5897 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5899 #ifdef PERL_DRAND48_QUAD
5901 #define DRAND48_MULT UINT64_C(0x5deece66d)
5902 #define DRAND48_ADD 0xb
5903 #define DRAND48_MASK UINT64_C(0xffffffffffff)
5907 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5908 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5909 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5910 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5911 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5912 #define FREEBSD_DRAND48_ADD (0x000b)
5914 const unsigned short _rand48_mult[3] = {
5915 FREEBSD_DRAND48_MULT_0,
5916 FREEBSD_DRAND48_MULT_1,
5917 FREEBSD_DRAND48_MULT_2
5919 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5924 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5926 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5928 #ifdef PERL_DRAND48_QUAD
5929 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5931 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5932 random_state->seed[1] = (U16) seed;
5933 random_state->seed[2] = (U16) (seed >> 16);
5938 Perl_drand48_r(perl_drand48_t *random_state)
5940 PERL_ARGS_ASSERT_DRAND48_R;
5942 #ifdef PERL_DRAND48_QUAD
5943 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5946 return ldexp((double)*random_state, -48);
5952 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5953 + (U32) _rand48_add;
5954 temp[0] = (U16) accu; /* lower 16 bits */
5955 accu >>= sizeof(U16) * 8;
5956 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5957 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5958 temp[1] = (U16) accu; /* middle 16 bits */
5959 accu >>= sizeof(U16) * 8;
5960 accu += _rand48_mult[0] * random_state->seed[2]
5961 + _rand48_mult[1] * random_state->seed[1]
5962 + _rand48_mult[2] * random_state->seed[0];
5963 random_state->seed[0] = temp[0];
5964 random_state->seed[1] = temp[1];
5965 random_state->seed[2] = (U16) accu;
5967 return ldexp((double) random_state->seed[0], -48) +
5968 ldexp((double) random_state->seed[1], -32) +
5969 ldexp((double) random_state->seed[2], -16);
5974 #ifdef USE_C_BACKTRACE
5976 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5981 /* abfd is the BFD handle. */
5983 /* bfd_syms is the BFD symbol table. */
5985 /* bfd_text is handle to the ".text" section of the object file. */
5987 /* Since opening the executable and scanning its symbols is quite
5988 * heavy operation, we remember the filename we used the last time,
5989 * and do the opening and scanning only if the filename changes.
5990 * This removes most (but not all) open+scan cycles. */
5991 const char* fname_prev;
5994 /* Given a dl_info, update the BFD context if necessary. */
5995 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5997 /* BFD open and scan only if the filename changed. */
5998 if (ctx->fname_prev == NULL ||
5999 strNE(dl_info->dli_fname, ctx->fname_prev)) {
6001 bfd_close(ctx->abfd);
6003 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
6005 if (bfd_check_format(ctx->abfd, bfd_object)) {
6006 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
6007 if (symbol_size > 0) {
6008 Safefree(ctx->bfd_syms);
6009 Newx(ctx->bfd_syms, symbol_size, asymbol*);
6011 bfd_get_section_by_name(ctx->abfd, ".text");
6019 ctx->fname_prev = dl_info->dli_fname;
6023 /* Given a raw frame, try to symbolize it and store
6024 * symbol information (source file, line number) away. */
6025 static void bfd_symbolize(bfd_context* ctx,
6028 STRLEN* symbol_name_size,
6030 STRLEN* source_name_size,
6031 STRLEN* source_line)
6033 *symbol_name = NULL;
6034 *symbol_name_size = 0;
6036 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
6038 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
6041 unsigned int line = 0;
6042 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
6043 ctx->bfd_syms, offset,
6044 &file, &func, &line) &&
6045 file && func && line > 0) {
6046 /* Size and copy the source file, use only
6047 * the basename of the source file.
6049 * NOTE: the basenames are fine for the
6050 * Perl source files, but may not always
6051 * be the best idea for XS files. */
6052 const char *p, *b = NULL;
6053 /* Look for the last slash. */
6054 for (p = file; *p; p++) {
6058 if (b == NULL || *b == 0) {
6061 *source_name_size = p - b + 1;
6062 Newx(*source_name, *source_name_size + 1, char);
6063 Copy(b, *source_name, *source_name_size + 1, char);
6065 *symbol_name_size = strlen(func);
6066 Newx(*symbol_name, *symbol_name_size + 1, char);
6067 Copy(func, *symbol_name, *symbol_name_size + 1, char);
6069 *source_line = line;
6075 #endif /* #ifdef USE_BFD */
6079 /* OS X has no public API for for 'symbolicating' (Apple official term)
6080 * stack addresses to {function_name, source_file, line_number}.
6081 * Good news: there is command line utility atos(1) which does that.
6082 * Bad news 1: it's a command line utility.
6083 * Bad news 2: one needs to have the Developer Tools installed.
6084 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
6086 * To recap: we need to open a pipe for reading for a utility which
6087 * might not exist, or exists in different locations, and then parse
6088 * the output. And since this is all for a low-level API, we cannot
6089 * use high-level stuff. Thanks, Apple. */
6092 /* tool is set to the absolute pathname of the tool to use:
6095 /* format is set to a printf format string used for building
6096 * the external command to run. */
6098 /* unavail is set if e.g. xcrun cannot be found, or something
6099 * else happens that makes getting the backtrace dubious. Note,
6100 * however, that the context isn't persistent, the next call to
6101 * get_c_backtrace() will start from scratch. */
6103 /* fname is the current object file name. */
6105 /* object_base_addr is the base address of the shared object. */
6106 void* object_base_addr;
6109 /* Given |dl_info|, updates the context. If the context has been
6110 * marked unavailable, return immediately. If not but the tool has
6111 * not been set, set it to either "xcrun atos" or "atos" (also set the
6112 * format to use for creating commands for piping), or if neither is
6113 * unavailable (one needs the Developer Tools installed), mark the context
6114 * an unavailable. Finally, update the filename (object name),
6115 * and its base address. */
6117 static void atos_update(atos_context* ctx,
6122 if (ctx->tool == NULL) {
6123 const char* tools[] = {
6127 const char* formats[] = {
6128 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6129 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6133 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6134 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6135 ctx->tool = tools[i];
6136 ctx->format = formats[i];
6140 if (ctx->tool == NULL) {
6141 ctx->unavail = TRUE;
6145 if (ctx->fname == NULL ||
6146 strNE(dl_info->dli_fname, ctx->fname)) {
6147 ctx->fname = dl_info->dli_fname;
6148 ctx->object_base_addr = dl_info->dli_fbase;
6152 /* Given an output buffer end |p| and its |start|, matches
6153 * for the atos output, extracting the source code location
6154 * and returning non-NULL if possible, returning NULL otherwise. */
6155 static const char* atos_parse(const char* p,
6157 STRLEN* source_name_size,
6158 STRLEN* source_line) {
6159 /* atos() output is something like:
6160 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6161 * We cannot use Perl regular expressions, because we need to
6162 * stay low-level. Therefore here we have a rolled-out version
6163 * of a state machine which matches _backwards_from_the_end_ and
6164 * if there's a success, returns the starts of the filename,
6165 * also setting the filename size and the source line number.
6166 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6167 const char* source_number_start;
6168 const char* source_name_end;
6169 const char* source_line_end = start;
6170 const char* close_paren;
6173 /* Skip trailing whitespace. */
6174 while (p > start && isSPACE(*p)) p--;
6175 /* Now we should be at the close paren. */
6176 if (p == start || *p != ')')
6180 /* Now we should be in the line number. */
6181 if (p == start || !isDIGIT(*p))
6183 /* Skip over the digits. */
6184 while (p > start && isDIGIT(*p))
6186 /* Now we should be at the colon. */
6187 if (p == start || *p != ':')
6189 source_number_start = p + 1;
6190 source_name_end = p; /* Just beyond the end. */
6192 /* Look for the open paren. */
6193 while (p > start && *p != '(')
6198 *source_name_size = source_name_end - p;
6199 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6200 && source_line_end == close_paren
6201 && uv <= PERL_INT_MAX
6203 *source_line = (STRLEN)uv;
6209 /* Given a raw frame, read a pipe from the symbolicator (that's the
6210 * technical term) atos, reads the result, and parses the source code
6211 * location. We must stay low-level, so we use snprintf(), pipe(),
6212 * and fread(), and then also parse the output ourselves. */
6213 static void atos_symbolize(atos_context* ctx,
6216 STRLEN* source_name_size,
6217 STRLEN* source_line)
6225 /* Simple security measure: if there's any funny business with
6226 * the object name (used as "-o '%s'" ), leave since at least
6227 * partially the user controls it. */
6228 for (p = ctx->fname; *p; p++) {
6229 if (*p == '\'' || isCNTRL(*p)) {
6230 ctx->unavail = TRUE;
6236 WITH_LC_NUMERIC_SET_TO_NEEDED(
6237 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6238 ctx->fname, ctx->object_base_addr, raw_frame);
6241 if (cnt < sizeof(cmd)) {
6242 /* Undo nostdio.h #defines that disable stdio.
6243 * This is somewhat naughty, but is used elsewhere
6244 * in the core, and affects only OS X. */
6249 FILE* fp = popen(cmd, "r");
6250 /* At the moment we open a new pipe for each stack frame.
6251 * This is naturally somewhat slow, but hopefully generating
6252 * stack traces is never going to in a performance critical path.
6254 * We could play tricks with atos by batching the stack
6255 * addresses to be resolved: atos can either take multiple
6256 * addresses from the command line, or read addresses from
6257 * a file (though the mess of creating temporary files would
6258 * probably negate much of any possible speedup).
6260 * Normally there are only two objects present in the backtrace:
6261 * perl itself, and the libdyld.dylib. (Note that the object
6262 * filenames contain the full pathname, so perl may not always
6263 * be in the same place.) Whenever the object in the
6264 * backtrace changes, the base address also changes.
6266 * The problem with batching the addresses, though, would be
6267 * matching the results with the addresses: the parsing of
6268 * the results is already painful enough with a single address. */
6271 UV cnt = fread(out, 1, sizeof(out), fp);
6272 if (cnt < sizeof(out)) {
6273 const char* p = atos_parse(out + cnt - 1, out,
6278 *source_name_size, char);
6279 Copy(p, *source_name,
6280 *source_name_size, char);
6288 #endif /* #ifdef PERL_DARWIN */
6291 =for apidoc_section $debugging
6292 =for apidoc get_c_backtrace
6294 Collects the backtrace (aka "stacktrace") into a single linear
6295 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6297 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6298 returning at most C<depth> frames.
6304 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6306 /* Note that here we must stay as low-level as possible: Newx(),
6307 * Copy(), Safefree(); since we may be called from anywhere,
6308 * so we should avoid higher level constructs like SVs or AVs.
6310 * Since we are using safesysmalloc() via Newx(), don't try
6311 * getting backtrace() there, unless you like deep recursion. */
6313 /* Currently only implemented with backtrace() and dladdr(),
6314 * for other platforms NULL is returned. */
6316 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6317 /* backtrace() is available via <execinfo.h> in glibc and in most
6318 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6320 /* We try fetching this many frames total, but then discard
6321 * the |skip| first ones. For the remaining ones we will try
6322 * retrieving more information with dladdr(). */
6323 int try_depth = skip + depth;
6325 /* The addresses (program counters) returned by backtrace(). */
6328 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6331 /* Sizes _including_ the terminating \0 of the object name
6332 * and symbol name strings. */
6333 STRLEN* object_name_sizes;
6334 STRLEN* symbol_name_sizes;
6337 /* The symbol names comes either from dli_sname,
6338 * or if using BFD, they can come from BFD. */
6339 char** symbol_names;
6342 /* The source code location information. Dug out with e.g. BFD. */
6343 char** source_names;
6344 STRLEN* source_name_sizes;
6345 STRLEN* source_lines;
6347 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6348 int got_depth; /* How many frames were returned from backtrace(). */
6349 UV frame_count = 0; /* How many frames we return. */
6350 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6353 bfd_context bfd_ctx;
6356 atos_context atos_ctx;
6359 /* Here are probably possibilities for optimizing. We could for
6360 * example have a struct that contains most of these and then
6361 * allocate |try_depth| of them, saving a bunch of malloc calls.
6362 * Note, however, that |frames| could not be part of that struct
6363 * because backtrace() will want an array of just them. Also be
6364 * careful about the name strings. */
6365 Newx(raw_frames, try_depth, void*);
6366 Newx(dl_infos, try_depth, Dl_info);
6367 Newx(object_name_sizes, try_depth, STRLEN);
6368 Newx(symbol_name_sizes, try_depth, STRLEN);
6369 Newx(source_names, try_depth, char*);
6370 Newx(source_name_sizes, try_depth, STRLEN);
6371 Newx(source_lines, try_depth, STRLEN);
6373 Newx(symbol_names, try_depth, char*);
6376 /* Get the raw frames. */
6377 got_depth = (int)backtrace(raw_frames, try_depth);
6379 /* We use dladdr() instead of backtrace_symbols() because we want
6380 * the full details instead of opaque strings. This is useful for
6381 * two reasons: () the details are needed for further symbolic
6382 * digging, for example in OS X (2) by having the details we fully
6383 * control the output, which in turn is useful when more platforms
6384 * are added: we can keep out output "portable". */
6386 /* We want a single linear allocation, which can then be freed
6387 * with a single swoop. We will do the usual trick of first
6388 * walking over the structure and seeing how much we need to
6389 * allocate, then allocating, and then walking over the structure
6390 * the second time and populating it. */
6392 /* First we must compute the total size of the buffer. */
6393 total_bytes = sizeof(Perl_c_backtrace_header);
6394 if (got_depth > skip) {
6397 bfd_init(); /* Is this safe to call multiple times? */
6398 Zero(&bfd_ctx, 1, bfd_context);
6401 Zero(&atos_ctx, 1, atos_context);
6403 for (i = skip; i < try_depth; i++) {
6404 Dl_info* dl_info = &dl_infos[i];
6406 object_name_sizes[i] = 0;
6407 source_names[i] = NULL;
6408 source_name_sizes[i] = 0;
6409 source_lines[i] = 0;
6411 /* Yes, zero from dladdr() is failure. */
6412 if (dladdr(raw_frames[i], dl_info)) {
6413 total_bytes += sizeof(Perl_c_backtrace_frame);
6415 object_name_sizes[i] =
6416 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6417 symbol_name_sizes[i] =
6418 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6420 bfd_update(&bfd_ctx, dl_info);
6421 bfd_symbolize(&bfd_ctx, raw_frames[i],
6423 &symbol_name_sizes[i],
6425 &source_name_sizes[i],
6429 atos_update(&atos_ctx, dl_info);
6430 atos_symbolize(&atos_ctx,
6433 &source_name_sizes[i],
6437 /* Plus ones for the terminating \0. */
6438 total_bytes += object_name_sizes[i] + 1;
6439 total_bytes += symbol_name_sizes[i] + 1;
6440 total_bytes += source_name_sizes[i] + 1;
6448 Safefree(bfd_ctx.bfd_syms);
6452 /* Now we can allocate and populate the result buffer. */
6453 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6454 Zero(bt, total_bytes, char);
6455 bt->header.frame_count = frame_count;
6456 bt->header.total_bytes = total_bytes;
6457 if (frame_count > 0) {
6458 Perl_c_backtrace_frame* frame = bt->frame_info;
6459 char* name_base = (char *)(frame + frame_count);
6460 char* name_curr = name_base; /* Outputting the name strings here. */
6462 for (i = skip; i < skip + frame_count; i++) {
6463 Dl_info* dl_info = &dl_infos[i];
6465 frame->addr = raw_frames[i];
6466 frame->object_base_addr = dl_info->dli_fbase;
6467 frame->symbol_addr = dl_info->dli_saddr;
6469 /* Copies a string, including the \0, and advances the name_curr.
6470 * Also copies the start and the size to the frame. */
6471 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6473 Copy(src, name_curr, size, char); \
6474 frame->doffset = name_curr - (char*)bt; \
6475 frame->dsize = size; \
6476 name_curr += size; \
6479 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6481 object_name_size, object_name_sizes[i]);
6484 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6486 symbol_name_size, symbol_name_sizes[i]);
6487 Safefree(symbol_names[i]);
6489 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6491 symbol_name_size, symbol_name_sizes[i]);
6494 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6496 source_name_size, source_name_sizes[i]);
6497 Safefree(source_names[i]);
6499 #undef PERL_C_BACKTRACE_STRCPY
6501 frame->source_line_number = source_lines[i];
6505 assert(total_bytes ==
6506 (UV)(sizeof(Perl_c_backtrace_header) +
6507 frame_count * sizeof(Perl_c_backtrace_frame) +
6508 name_curr - name_base));
6511 Safefree(symbol_names);
6513 bfd_close(bfd_ctx.abfd);
6516 Safefree(source_lines);
6517 Safefree(source_name_sizes);
6518 Safefree(source_names);
6519 Safefree(symbol_name_sizes);
6520 Safefree(object_name_sizes);
6521 /* Assuming the strings returned by dladdr() are pointers
6522 * to read-only static memory (the object file), so that
6523 * they do not need freeing (and cannot be). */
6525 Safefree(raw_frames);
6528 PERL_UNUSED_ARG(depth);
6529 PERL_UNUSED_ARG(skip);
6535 =for apidoc free_c_backtrace
6537 Deallocates a backtrace received from get_c_backtrace.
6543 =for apidoc get_c_backtrace_dump
6545 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6546 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6548 The appended output looks like:
6551 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6552 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6555 The fields are tab-separated. The first column is the depth (zero
6556 being the innermost non-skipped frame). In the hex:offset, the hex is
6557 where the program counter was in C<S_parse_body>, and the :offset (might
6558 be missing) tells how much inside the C<S_parse_body> the program counter was.
6560 The C<util.c:1716> is the source code file and line number.
6562 The F</usr/bin/perl> is obvious (hopefully).
6564 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6565 if the platform doesn't support retrieving the information;
6566 if the binary is missing the debug information;
6567 if the optimizer has transformed the code by for example inlining.
6573 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6575 Perl_c_backtrace* bt;
6577 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6579 Perl_c_backtrace_frame* frame;
6580 SV* dsv = newSVpvs("");
6582 for (i = 0, frame = bt->frame_info;
6583 i < bt->header.frame_count; i++, frame++) {
6584 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6585 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6586 /* Symbol (function) names might disappear without debug info.
6588 * The source code location might disappear in case of the
6589 * optimizer inlining or otherwise rearranging the code. */
6590 if (frame->symbol_addr) {
6591 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6593 ((char*)frame->addr - (char*)frame->symbol_addr));
6595 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6596 frame->symbol_name_size &&
6597 frame->symbol_name_offset ?
6598 (char*)bt + frame->symbol_name_offset : "-");
6599 if (frame->source_name_size &&
6600 frame->source_name_offset &&
6601 frame->source_line_number) {
6602 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6603 (char*)bt + frame->source_name_offset,
6604 (UV)frame->source_line_number);
6606 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6608 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6609 frame->object_name_size &&
6610 frame->object_name_offset ?
6611 (char*)bt + frame->object_name_offset : "-");
6612 /* The frame->object_base_addr is not output,
6613 * but it is used for symbolizing/symbolicating. */
6614 sv_catpvs(dsv, "\n");
6617 Perl_free_c_backtrace(bt);
6626 =for apidoc dump_c_backtrace
6628 Dumps the C backtrace to the given C<fp>.
6630 Returns true if a backtrace could be retrieved, false if not.
6636 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6640 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6642 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6645 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6651 #endif /* #ifdef USE_C_BACKTRACE */
6653 #if defined(USE_ITHREADS) && defined(I_PTHREAD)
6655 /* pthread_mutex_t and perl_mutex are typedef equivalent
6656 * so casting the pointers is fine. */
6658 int perl_tsa_mutex_lock(perl_mutex* mutex)
6660 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6663 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6665 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6668 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6670 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6677 /* log a sub call or return */
6680 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6688 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6691 HEK *hek = CvNAME_HEK(cv);
6692 func = HEK_KEY(hek);
6698 start = (const COP *)CvSTART(cv);
6699 file = CopFILE(start);
6700 line = CopLINE(start);
6701 stash = CopSTASHPV(start);
6704 PERL_SUB_ENTRY(func, file, line, stash);
6707 PERL_SUB_RETURN(func, file, line, stash);
6712 /* log a require file loading/loaded */
6715 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6717 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6720 PERL_LOADING_FILE(name);
6723 PERL_LOADED_FILE(name);
6728 /* log an op execution */
6731 Perl_dtrace_probe_op(pTHX_ const OP *op)
6733 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6735 PERL_OP_ENTRY(OP_NAME(op));
6739 /* log a compile/run phase change */
6742 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6744 const char *ph_old = PL_phase_names[PL_phase];
6745 const char *ph_new = PL_phase_names[phase];
6747 PERL_PHASE_CHANGE(ph_new, ph_old);
6753 * ex: set ts=8 sts=4 sw=4 et: