3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * 'Very useful, no doubt, that was to Saruman; yet it seems that he was
13 * not content.' --Gandalf to Pippin
15 * [p.598 of _The Lord of the Rings_, III/xi: "The PalantÃr"]
18 /* This file contains assorted utility routines.
19 * Which is a polite way of saying any stuff that people couldn't think of
20 * a better place for. Amongst other things, it includes the warning and
21 * dieing stuff, plus wrappers for malloc code.
25 #define PERL_IN_UTIL_C
29 #if defined(USE_PERLIO)
30 #include "perliol.h" /* For PerlIOUnix_refcnt */
36 # define SIG_ERR ((Sighandler_t) -1)
44 /* Missing protos on LynxOS */
49 # include "amigaos4/amigaio.h"
54 # include <sys/select.h>
58 #ifdef USE_C_BACKTRACE
62 # undef USE_BFD /* BFD is useless in OS X. */
72 # include <execinfo.h>
76 #ifdef PERL_DEBUG_READONLY_COW
77 # include <sys/mman.h>
82 /* NOTE: Do not call the next three routines directly. Use the macros
83 * in handy.h, so that we can easily redefine everything to do tracking of
84 * allocated hunks back to the original New to track down any memory leaks.
85 * XXX This advice seems to be widely ignored :-( --AD August 1996.
88 #if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
89 # define ALWAYS_NEED_THX
92 #if defined(PERL_TRACK_MEMPOOL) && defined(PERL_DEBUG_READONLY_COW)
94 S_maybe_protect_rw(pTHX_ struct perl_memory_debug_header *header)
97 && mprotect(header, header->size, PROT_READ|PROT_WRITE))
98 Perl_warn(aTHX_ "mprotect for COW string %p %lu failed with %d",
99 header, header->size, errno);
103 S_maybe_protect_ro(pTHX_ struct perl_memory_debug_header *header)
106 && mprotect(header, header->size, PROT_READ))
107 Perl_warn(aTHX_ "mprotect RW for COW string %p %lu failed with %d",
108 header, header->size, errno);
110 # define maybe_protect_rw(foo) S_maybe_protect_rw(aTHX_ foo)
111 # define maybe_protect_ro(foo) S_maybe_protect_ro(aTHX_ foo)
113 # define maybe_protect_rw(foo) NOOP
114 # define maybe_protect_ro(foo) NOOP
117 #if defined(PERL_TRACK_MEMPOOL) || defined(PERL_DEBUG_READONLY_COW)
118 /* Use memory_debug_header */
120 # if (defined(PERL_POISON) && defined(PERL_TRACK_MEMPOOL)) \
121 || defined(PERL_DEBUG_READONLY_COW)
122 # define MDH_HAS_SIZE
127 =for apidoc_section $memory
128 =for apidoc safesysmalloc
129 Paranoid version of system's malloc()
135 Perl_safesysmalloc(MEM_SIZE size)
137 #ifdef ALWAYS_NEED_THX
144 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
146 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
149 if ((SSize_t)size < 0)
150 Perl_croak_nocontext("panic: malloc, size=%" UVuf, (UV) size);
152 if (!size) size = 1; /* malloc(0) is NASTY on our system */
154 #ifdef PERL_DEBUG_READONLY_COW
155 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
156 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
157 perror("mmap failed");
161 ptr = (Malloc_t)PerlMem_malloc(size);
163 PERL_ALLOC_CHECK(ptr);
166 struct perl_memory_debug_header *const header
167 = (struct perl_memory_debug_header *)ptr;
171 PoisonNew(((char *)ptr), size, char);
174 #ifdef PERL_TRACK_MEMPOOL
175 header->interpreter = aTHX;
176 /* Link us into the list. */
177 header->prev = &PL_memory_debug_header;
178 header->next = PL_memory_debug_header.next;
179 PL_memory_debug_header.next = header;
180 maybe_protect_rw(header->next);
181 header->next->prev = header;
182 maybe_protect_ro(header->next);
183 # ifdef PERL_DEBUG_READONLY_COW
184 header->readonly = 0;
190 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
191 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
193 /* malloc() can modify errno() even on success, but since someone
194 writing perl code doesn't have any control over when perl calls
195 malloc() we need to hide that.
204 #ifndef ALWAYS_NEED_THX
217 =for apidoc safesysrealloc
218 Paranoid version of system's realloc()
224 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
226 #ifdef ALWAYS_NEED_THX
230 #ifdef PERL_DEBUG_READONLY_COW
231 const MEM_SIZE oldsize = where
232 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
241 ptr = safesysmalloc(size);
246 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
247 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
249 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
251 struct perl_memory_debug_header *const header
252 = (struct perl_memory_debug_header *)where;
254 # ifdef PERL_TRACK_MEMPOOL
255 if (header->interpreter != aTHX) {
256 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
257 header->interpreter, aTHX);
259 assert(header->next->prev == header);
260 assert(header->prev->next == header);
262 if (header->size > size) {
263 const MEM_SIZE freed_up = header->size - size;
264 char *start_of_freed = ((char *)where) + size;
265 PoisonFree(start_of_freed, freed_up, char);
275 if ((SSize_t)size < 0)
276 Perl_croak_nocontext("panic: realloc, size=%" UVuf, (UV)size);
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",PTR2UV(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
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 from wrong pool, %p!=%p",
377 header->interpreter, aTHX);
380 Perl_croak_nocontext("panic: duplicate free");
383 Perl_croak_nocontext("panic: bad free, header->next==NULL");
384 if (header->next->prev != header || header->prev->next != header) {
385 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
386 "header=%p, ->prev->next=%p",
387 header->next->prev, header,
390 /* Unlink us from the chain. */
391 maybe_protect_rw(header->next);
392 header->next->prev = header->prev;
393 maybe_protect_ro(header->next);
394 maybe_protect_rw(header->prev);
395 header->prev->next = header->next;
396 maybe_protect_ro(header->prev);
397 maybe_protect_rw(header);
399 PoisonNew(where_intrn, size, char);
401 /* Trigger the duplicate free warning. */
404 # ifdef PERL_DEBUG_READONLY_COW
405 if (munmap(where_intrn, size)) {
406 perror("munmap failed");
412 Malloc_t where_intrn = where;
414 #ifndef PERL_DEBUG_READONLY_COW
415 PerlMem_free(where_intrn);
421 =for apidoc safesyscalloc
422 Safe version of system's calloc()
428 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
430 #ifdef ALWAYS_NEED_THX
434 #if defined(USE_MDH) || defined(DEBUGGING)
435 MEM_SIZE total_size = 0;
438 /* Even though calloc() for zero bytes is strange, be robust. */
439 if (size && (count <= MEM_SIZE_MAX / size)) {
440 #if defined(USE_MDH) || defined(DEBUGGING)
441 total_size = size * count;
447 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
448 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
453 if ((SSize_t)size < 0 || (SSize_t)count < 0)
454 Perl_croak_nocontext("panic: calloc, size=%" UVuf ", count=%" UVuf,
455 (UV)size, (UV)count);
457 #ifdef PERL_DEBUG_READONLY_COW
458 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
459 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
460 perror("mmap failed");
463 #elif defined(PERL_TRACK_MEMPOOL)
464 /* Have to use malloc() because we've added some space for our tracking
466 /* malloc(0) is non-portable. */
467 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
469 /* Use calloc() because it might save a memset() if the memory is fresh
470 and clean from the OS. */
472 ptr = (Malloc_t)PerlMem_calloc(count, size);
473 else /* calloc(0) is non-portable. */
474 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
476 PERL_ALLOC_CHECK(ptr);
477 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));
481 struct perl_memory_debug_header *const header
482 = (struct perl_memory_debug_header *)ptr;
484 # ifndef PERL_DEBUG_READONLY_COW
485 memset((void*)ptr, 0, total_size);
487 # ifdef PERL_TRACK_MEMPOOL
488 header->interpreter = aTHX;
489 /* Link us into the list. */
490 header->prev = &PL_memory_debug_header;
491 header->next = PL_memory_debug_header.next;
492 PL_memory_debug_header.next = header;
493 maybe_protect_rw(header->next);
494 header->next->prev = header;
495 maybe_protect_ro(header->next);
496 # ifdef PERL_DEBUG_READONLY_COW
497 header->readonly = 0;
501 header->size = total_size;
503 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
509 #ifndef ALWAYS_NEED_THX
518 /* These must be defined when not using Perl's malloc for binary
523 Malloc_t Perl_malloc (MEM_SIZE nbytes)
525 #ifdef PERL_IMPLICIT_SYS
528 return (Malloc_t)PerlMem_malloc(nbytes);
531 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
533 #ifdef PERL_IMPLICIT_SYS
536 return (Malloc_t)PerlMem_calloc(elements, size);
539 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
541 #ifdef PERL_IMPLICIT_SYS
544 return (Malloc_t)PerlMem_realloc(where, nbytes);
547 Free_t Perl_mfree (Malloc_t where)
549 #ifdef PERL_IMPLICIT_SYS
557 /* This is the value stored in *retlen in the two delimcpy routines below when
558 * there wasn't enough room in the destination to store everything it was asked
559 * to. The value is deliberately very large so that hopefully if code uses it
560 * unquestioningly to access memory, it will likely segfault. And it is small
561 * enough that if the caller does some arithmetic on it before accessing, it
562 * won't overflow into a small legal number. */
563 #define DELIMCPY_OUT_OF_BOUNDS_RET I32_MAX
566 =for apidoc_section $string
567 =for apidoc delimcpy_no_escape
569 Copy a source buffer to a destination buffer, stopping at (but not including)
570 the first occurrence in the source of the delimiter byte, C<delim>. The source
571 is the bytes between S<C<from> and C<from_end> - 1>. Similarly, the dest is
572 C<to> up to C<to_end>.
574 The number of bytes copied is written to C<*retlen>.
576 Returns the position of C<delim> in the C<from> buffer, but if there is no
577 such occurrence before C<from_end>, then C<from_end> is returned, and the entire
578 buffer S<C<from> .. C<from_end> - 1> is copied.
580 If there is room in the destination available after the copy, an extra
581 terminating safety C<NUL> byte is appended (not included in the returned
584 The error case is if the destination buffer is not large enough to accommodate
585 everything that should be copied. In this situation, a value larger than
586 S<C<to_end> - C<to>> is written to C<*retlen>, and as much of the source as
587 fits will be written to the destination. Not having room for the safety C<NUL>
588 is not considered an error.
593 Perl_delimcpy_no_escape(char *to, const char *to_end,
594 const char *from, const char *from_end,
595 const int delim, I32 *retlen)
597 const char * delim_pos;
598 Ptrdiff_t from_len = from_end - from;
599 Ptrdiff_t to_len = to_end - to;
602 PERL_ARGS_ASSERT_DELIMCPY_NO_ESCAPE;
604 assert(from_len >= 0);
607 /* Look for the first delimiter in the source */
608 delim_pos = (const char *) memchr(from, delim, from_len);
610 /* Copy up to where the delimiter was found, or the entire buffer if not
612 copy_len = (delim_pos) ? delim_pos - from : from_len;
614 /* If not enough room, copy as much as can fit, and set error return */
615 if (copy_len > to_len) {
616 Copy(from, to, to_len, char);
617 *retlen = DELIMCPY_OUT_OF_BOUNDS_RET;
620 Copy(from, to, copy_len, char);
622 /* If there is extra space available, add a trailing NUL */
623 if (copy_len < to_len) {
630 return (char *) from + copy_len;
636 Copy a source buffer to a destination buffer, stopping at (but not including)
637 the first occurrence in the source of an unescaped (defined below) delimiter
638 byte, C<delim>. The source is the bytes between S<C<from> and C<from_end> -
639 1>. Similarly, the dest is C<to> up to C<to_end>.
641 The number of bytes copied is written to C<*retlen>.
643 Returns the position of the first uncopied C<delim> in the C<from> buffer, but
644 if there is no such occurrence before C<from_end>, then C<from_end> is returned,
645 and the entire buffer S<C<from> .. C<from_end> - 1> is copied.
647 If there is room in the destination available after the copy, an extra
648 terminating safety C<NUL> byte is appended (not included in the returned
651 The error case is if the destination buffer is not large enough to accommodate
652 everything that should be copied. In this situation, a value larger than
653 S<C<to_end> - C<to>> is written to C<*retlen>, and as much of the source as
654 fits will be written to the destination. Not having room for the safety C<NUL>
655 is not considered an error.
657 In the following examples, let C<x> be the delimiter, and C<0> represent a C<NUL>
658 byte (B<NOT> the digit C<0>). Then we would have
663 provided the destination buffer is at least 4 bytes long.
665 An escaped delimiter is one which is immediately preceded by a single
666 backslash. Escaped delimiters are copied, and the copy continues past the
667 delimiter; the backslash is not copied:
672 (provided the destination buffer is at least 8 bytes long).
674 It's actually somewhat more complicated than that. A sequence of any odd number
675 of backslashes escapes the following delimiter, and the copy continues with
676 exactly one of the backslashes stripped.
680 abc\\\xdef abc\\xdef0
681 abc\\\\\xdef abc\\\\xdef0
683 (as always, if the destination is large enough)
685 An even number of preceding backslashes does not escape the delimiter, so that
686 the copy stops just before it, and includes all the backslashes (no stripping;
687 zero is considered even):
698 Perl_delimcpy(char *to, const char *to_end,
699 const char *from, const char *from_end,
700 const int delim, I32 *retlen)
702 const char * const orig_to = to;
703 Ptrdiff_t copy_len = 0;
704 bool stopped_early = FALSE; /* Ran out of room to copy to */
706 PERL_ARGS_ASSERT_DELIMCPY;
707 assert(from_end >= from);
708 assert(to_end >= to);
710 /* Don't use the loop for the trivial case of the first character being the
711 * delimiter; otherwise would have to worry inside the loop about backing
712 * up before the start of 'from' */
713 if (LIKELY(from_end > from && *from != delim)) {
714 while ((copy_len = from_end - from) > 0) {
715 const char * backslash_pos;
716 const char * delim_pos;
718 /* Look for the next delimiter in the remaining portion of the
719 * source. A loop invariant is that we already know that the copy
720 * should include *from; this comes from the conditional before the
721 * loop, and how we set things up at the end of each iteration */
722 delim_pos = (const char *) memchr(from + 1, delim, copy_len - 1);
724 /* If didn't find it, done looking; set up so copies all of the
727 copy_len = from_end - from;
731 /* Look for a backslash immediately before the delimiter */
732 backslash_pos = delim_pos - 1;
734 /* If the delimiter is not escaped, this ends the copy */
735 if (*backslash_pos != '\\') {
736 copy_len = delim_pos - from;
740 /* Here there is a backslash just before the delimiter, but it
741 * could be the final backslash in a sequence of them. Backup to
742 * find the first one in it. */
746 while (backslash_pos >= from && *backslash_pos == '\\');
748 /* If the number of backslashes is even, they just escape one
749 * another, leaving the delimiter unescaped, and stopping the copy.
751 if (! ((delim_pos - (backslash_pos + 1)) & 1)) {
752 copy_len = delim_pos - from; /* even, copy up to delimiter */
756 /* Here is odd, so the delimiter is escaped. We will try to copy
757 * all but the final backslash in the sequence */
758 copy_len = delim_pos - 1 - from;
760 /* Do the copy, but not beyond the end of the destination */
761 if (copy_len >= to_end - to) {
762 Copy(from, to, to_end - to, char);
763 stopped_early = TRUE;
764 to = (char *) to_end;
767 Copy(from, to, copy_len, char);
771 /* Set up so next iteration will include the delimiter */
776 /* Here, have found the final segment to copy. Copy that, but not beyond
777 * the size of the destination. If not enough room, copy as much as can
778 * fit, and set error return */
779 if (stopped_early || copy_len > to_end - to) {
780 Copy(from, to, to_end - to, char);
781 *retlen = DELIMCPY_OUT_OF_BOUNDS_RET;
784 Copy(from, to, copy_len, char);
788 /* If there is extra space available, add a trailing NUL */
793 *retlen = to - orig_to;
796 return (char *) from + copy_len;
802 Find the first (leftmost) occurrence of a sequence of bytes within another
803 sequence. This is the Perl version of C<strstr()>, extended to handle
804 arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
805 is what the initial C<n> in the function name stands for; some systems have an
806 equivalent, C<memmem()>, but with a somewhat different API).
808 Another way of thinking about this function is finding a needle in a haystack.
809 C<big> points to the first byte in the haystack. C<big_end> points to one byte
810 beyond the final byte in the haystack. C<little> points to the first byte in
811 the needle. C<little_end> points to one byte beyond the final byte in the
812 needle. All the parameters must be non-C<NULL>.
814 The function returns C<NULL> if there is no occurrence of C<little> within
815 C<big>. If C<little> is the empty string, C<big> is returned.
817 Because this function operates at the byte level, and because of the inherent
818 characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
819 needle and the haystack are strings with the same UTF-8ness, but not if the
827 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
829 PERL_ARGS_ASSERT_NINSTR;
832 return ninstr(big, bigend, little, lend);
835 if (little >= lend) {
839 const U8 first = *little;
842 /* No match can start closer to the end of the haystack than the length
844 bigend -= lend - little;
845 little++; /* Look for 'first', then the remainder is in here */
846 lsize = lend - little;
848 while (big <= bigend) {
849 big = (char *) memchr((U8 *) big, first, bigend - big + 1);
850 if (big == NULL || big > bigend) {
854 if (memEQ(big + 1, little, lsize)) {
870 Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
871 sequence of bytes within another sequence, returning C<NULL> if there is no
879 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
881 const Ptrdiff_t little_len = lend - little;
882 const Ptrdiff_t big_len = bigend - big;
884 PERL_ARGS_ASSERT_RNINSTR;
886 /* A non-existent needle trivially matches the rightmost possible position
888 if (UNLIKELY(little_len <= 0)) {
889 return (char*)bigend;
892 /* If the needle is larger than the haystack, the needle can't possibly fit
893 * inside the haystack. */
894 if (UNLIKELY(little_len > big_len)) {
898 /* Special case length 1 needles. It's trivial if we have memrchr();
899 * and otherwise we just do a per-byte search backwards.
901 * XXX When we don't have memrchr, we could use something like
902 * S_find_next_masked( or S_find_span_end() to do per-word searches */
903 if (little_len == 1) {
904 const char final = *little;
908 return (char *) memrchr(big, final, big_len);
910 const char * cur = bigend - 1;
916 } while (--cur >= big);
922 else { /* Below, the needle is longer than a single byte */
924 /* We search backwards in the haystack for the final character of the
925 * needle. Each time one is found, we see if the characters just
926 * before it in the haystack match the rest of the needle. */
927 const char final = *(lend - 1);
929 /* What matches consists of 'little_len'-1 characters, then the final
931 const Size_t prefix_len = little_len - 1;
933 /* If the final character in the needle is any closer than this to the
934 * left edge, there wouldn't be enough room for all of it to fit in the
936 const char * const left_fence = big + prefix_len;
938 /* Start at the right edge */
939 char * cur = (char *) bigend;
941 /* memrchr() makes the search easy (and fast); otherwise, look
942 * backwards byte-by-byte. */
947 cur = (char *) memrchr(left_fence, final, cur - left_fence);
954 if (cur < left_fence) {
958 while (*cur != final);
961 /* Here, we know that *cur is 'final'; see if the preceding bytes
962 * of the needle also match the corresponding haystack bytes */
963 if memEQ(cur - prefix_len, little, prefix_len) {
964 return cur - prefix_len;
966 } while (cur > left_fence);
972 /* As a space optimization, we do not compile tables for strings of length
973 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
974 special-cased in fbm_instr().
976 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
980 =for apidoc fbm_compile
982 Analyzes the string in order to make fast searches on it using C<fbm_instr()>
983 -- the Boyer-Moore algorithm.
989 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
996 PERL_ARGS_ASSERT_FBM_COMPILE;
998 if (isGV_with_GP(sv) || SvROK(sv))
1004 if (flags & FBMcf_TAIL) {
1005 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
1006 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
1007 if (mg && mg->mg_len >= 0)
1010 if (!SvPOK(sv) || SvNIOKp(sv))
1011 s = (U8*)SvPV_force_mutable(sv, len);
1012 else s = (U8 *)SvPV_mutable(sv, len);
1013 if (len == 0) /* TAIL might be on a zero-length string. */
1015 SvUPGRADE(sv, SVt_PVMG);
1019 /* add PERL_MAGIC_bm magic holding the FBM lookup table */
1021 assert(!mg_find(sv, PERL_MAGIC_bm));
1022 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
1026 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
1028 const U8 mlen = (len>255) ? 255 : (U8)len;
1029 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
1032 Newx(table, 256, U8);
1033 memset((void*)table, mlen, 256);
1034 mg->mg_ptr = (char *)table;
1037 s += len - 1; /* last char */
1040 if (table[*s] == mlen)
1046 BmUSEFUL(sv) = 100; /* Initial value */
1047 ((XPVNV*)SvANY(sv))->xnv_u.xnv_bm_tail = cBOOL(flags & FBMcf_TAIL);
1052 =for apidoc fbm_instr
1054 Returns the location of the SV in the string delimited by C<big> and
1055 C<bigend> (C<bigend>) is the char following the last char).
1056 It returns C<NULL> if the string can't be found. The C<sv>
1057 does not have to be C<fbm_compiled>, but the search will not be as fast
1062 If SvTAIL(littlestr) is true, a fake "\n" was appended to the string
1063 during FBM compilation due to FBMcf_TAIL in flags. It indicates that
1064 the littlestr must be anchored to the end of bigstr (or to any \n if
1067 E.g. The regex compiler would compile /abc/ to a littlestr of "abc",
1068 while /abc$/ compiles to "abc\n" with SvTAIL() true.
1070 A littlestr of "abc", !SvTAIL matches as /abc/;
1071 a littlestr of "ab\n", SvTAIL matches as:
1072 without FBMrf_MULTILINE: /ab\n?\z/
1073 with FBMrf_MULTILINE: /ab\n/ || /ab\z/;
1075 (According to Ilya from 1999; I don't know if this is still true, DAPM 2015):
1076 "If SvTAIL is actually due to \Z or \z, this gives false positives
1082 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
1086 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
1087 STRLEN littlelen = l;
1088 const I32 multiline = flags & FBMrf_MULTILINE;
1089 bool valid = SvVALID(littlestr);
1090 bool tail = valid ? cBOOL(SvTAIL(littlestr)) : FALSE;
1092 PERL_ARGS_ASSERT_FBM_INSTR;
1094 assert(bigend >= big);
1096 if ((STRLEN)(bigend - big) < littlelen) {
1098 && ((STRLEN)(bigend - big) == littlelen - 1)
1100 || (*big == *little &&
1101 memEQ((char *)big, (char *)little, littlelen - 1))))
1106 switch (littlelen) { /* Special cases for 0, 1 and 2 */
1108 return (char*)big; /* Cannot be SvTAIL! */
1111 if (tail && !multiline) /* Anchor only! */
1112 /* [-1] is safe because we know that bigend != big. */
1113 return (char *) (bigend - (bigend[-1] == '\n'));
1115 s = (unsigned char *)memchr((void*)big, *little, bigend-big);
1119 return (char *) bigend;
1123 if (tail && !multiline) {
1124 /* a littlestr with SvTAIL must be of the form "X\n" (where X
1125 * is a single char). It is anchored, and can only match
1126 * "....X\n" or "....X" */
1127 if (bigend[-2] == *little && bigend[-1] == '\n')
1128 return (char*)bigend - 2;
1129 if (bigend[-1] == *little)
1130 return (char*)bigend - 1;
1135 /* memchr() is likely to be very fast, possibly using whatever
1136 * hardware support is available, such as checking a whole
1137 * cache line in one instruction.
1138 * So for a 2 char pattern, calling memchr() is likely to be
1139 * faster than running FBM, or rolling our own. The previous
1140 * version of this code was roll-your-own which typically
1141 * only needed to read every 2nd char, which was good back in
1142 * the day, but no longer.
1144 unsigned char c1 = little[0];
1145 unsigned char c2 = little[1];
1147 /* *** for all this case, bigend points to the last char,
1148 * not the trailing \0: this makes the conditions slightly
1153 while (s < bigend) {
1154 /* do a quick test for c1 before calling memchr();
1155 * this avoids the expensive fn call overhead when
1156 * there are lots of c1's */
1157 if (LIKELY(*s != c1)) {
1159 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
1166 /* failed; try searching for c2 this time; that way
1167 * we don't go pathologically slow when the string
1168 * consists mostly of c1's or vice versa.
1173 s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
1177 return (char*)s - 1;
1181 /* c1, c2 the same */
1182 while (s < bigend) {
1191 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
1192 if (!s || s >= bigend)
1199 /* failed to find 2 chars; try anchored match at end without
1201 if (tail && bigend[0] == little[0])
1202 return (char *)bigend;
1207 break; /* Only lengths 0 1 and 2 have special-case code. */
1210 if (tail && !multiline) { /* tail anchored? */
1211 s = bigend - littlelen;
1212 if (s >= big && bigend[-1] == '\n' && *s == *little
1213 /* Automatically of length > 2 */
1214 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
1216 return (char*)s; /* how sweet it is */
1219 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
1221 return (char*)s + 1; /* how sweet it is */
1227 /* not compiled; use Perl_ninstr() instead */
1228 char * const b = ninstr((char*)big,(char*)bigend,
1229 (char*)little, (char*)little + littlelen);
1231 assert(!tail); /* valid => FBM; tail only set on SvVALID SVs */
1235 /* Do actual FBM. */
1236 if (littlelen > (STRLEN)(bigend - big))
1240 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
1241 const unsigned char *oldlittle;
1245 --littlelen; /* Last char found by table lookup */
1247 s = big + littlelen;
1248 little += littlelen; /* last char */
1251 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
1252 const unsigned char lastc = *little;
1256 if ((tmp = table[*s])) {
1257 /* *s != lastc; earliest position it could match now is
1258 * tmp slots further on */
1259 if ((s += tmp) >= bigend)
1261 if (LIKELY(*s != lastc)) {
1263 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
1273 /* hand-rolled strncmp(): less expensive than calling the
1274 * real function (maybe???) */
1276 unsigned char * const olds = s;
1281 if (*--s == *--little)
1283 s = olds + 1; /* here we pay the price for failure */
1285 if (s < bigend) /* fake up continue to outer loop */
1295 && memEQ((char *)(bigend - littlelen),
1296 (char *)(oldlittle - littlelen), littlelen) )
1297 return (char*)bigend - littlelen;
1303 Perl_cntrl_to_mnemonic(const U8 c)
1305 /* Returns the mnemonic string that represents character 'c', if one
1306 * exists; NULL otherwise. The only ones that exist for the purposes of
1307 * this routine are a few control characters */
1310 case '\a': return "\\a";
1311 case '\b': return "\\b";
1312 case ESC_NATIVE: return "\\e";
1313 case '\f': return "\\f";
1314 case '\n': return "\\n";
1315 case '\r': return "\\r";
1316 case '\t': return "\\t";
1323 =for apidoc savesharedpv
1325 A version of C<savepv()> which allocates the duplicate string in memory
1326 which is shared between threads.
1331 Perl_savesharedpv(pTHX_ const char *pv)
1336 PERL_UNUSED_CONTEXT;
1341 pvlen = strlen(pv)+1;
1342 newaddr = (char*)PerlMemShared_malloc(pvlen);
1346 return (char*)memcpy(newaddr, pv, pvlen);
1350 =for apidoc savesharedpvn
1352 A version of C<savepvn()> which allocates the duplicate string in memory
1353 which is shared between threads. (With the specific difference that a C<NULL>
1354 pointer is not acceptable)
1359 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1361 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1363 PERL_UNUSED_CONTEXT;
1364 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1369 newaddr[len] = '\0';
1370 return (char*)memcpy(newaddr, pv, len);
1373 /* the SV for Perl_form() and mess() is not kept in an arena */
1381 if (PL_phase != PERL_PHASE_DESTRUCT)
1382 return newSVpvs_flags("", SVs_TEMP);
1387 /* Create as PVMG now, to avoid any upgrading later */
1389 Newxz(any, 1, XPVMG);
1390 SvFLAGS(sv) = SVt_PVMG;
1391 SvANY(sv) = (void*)any;
1393 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1398 #if defined(MULTIPLICITY)
1400 Perl_form_nocontext(const char* pat, ...)
1405 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1406 va_start(args, pat);
1407 retval = vform(pat, &args);
1411 #endif /* MULTIPLICITY */
1414 =for apidoc_section $display
1416 =for apidoc_item form_nocontext
1418 These take a sprintf-style format pattern and conventional
1419 (non-SV) arguments and return the formatted string.
1421 (char *) Perl_form(pTHX_ const char* pat, ...)
1423 can be used any place a string (char *) is required:
1425 char * s = Perl_form("%d.%d",major,minor);
1427 They use a single (per-thread) private buffer so if you want to format several
1428 strings you must explicitly copy the earlier strings away (and free the copies
1431 The two forms differ only in that C<form_nocontext> does not take a thread
1432 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
1433 already have the thread context.
1436 Like C<L</form>> but but the arguments are an encapsulated argument list.
1442 Perl_form(pTHX_ const char* pat, ...)
1446 PERL_ARGS_ASSERT_FORM;
1447 va_start(args, pat);
1448 retval = vform(pat, &args);
1454 Perl_vform(pTHX_ const char *pat, va_list *args)
1456 SV * const sv = mess_alloc();
1457 PERL_ARGS_ASSERT_VFORM;
1458 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1464 =for apidoc_item mess_nocontext
1466 These take a sprintf-style format pattern and argument list, which are used to
1467 generate a string message. If the message does not end with a newline, then it
1468 will be extended with some indication of the current location in the code, as
1469 described for C<L</mess_sv>>.
1471 Normally, the resulting message is returned in a new mortal SV.
1472 But during global destruction a single SV may be shared between uses of
1475 The two forms differ only in that C<mess_nocontext> does not take a thread
1476 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
1477 already have the thread context.
1482 #if defined(MULTIPLICITY)
1484 Perl_mess_nocontext(const char *pat, ...)
1489 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1490 va_start(args, pat);
1491 retval = vmess(pat, &args);
1495 #endif /* MULTIPLICITY */
1498 Perl_mess(pTHX_ const char *pat, ...)
1502 PERL_ARGS_ASSERT_MESS;
1503 va_start(args, pat);
1504 retval = vmess(pat, &args);
1510 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1513 /* Look for curop starting from o. cop is the last COP we've seen. */
1514 /* opnext means that curop is actually the ->op_next of the op we are
1517 PERL_ARGS_ASSERT_CLOSEST_COP;
1519 if (!o || !curop || (
1520 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1524 if (o->op_flags & OPf_KIDS) {
1526 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1529 /* If the OP_NEXTSTATE has been optimised away we can still use it
1530 * the get the file and line number. */
1532 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1533 cop = (const COP *)kid;
1535 /* Keep searching, and return when we've found something. */
1537 new_cop = closest_cop(cop, kid, curop, opnext);
1543 /* Nothing found. */
1551 Expands a message, intended for the user, to include an indication of
1552 the current location in the code, if the message does not already appear
1555 C<basemsg> is the initial message or object. If it is a reference, it
1556 will be used as-is and will be the result of this function. Otherwise it
1557 is used as a string, and if it already ends with a newline, it is taken
1558 to be complete, and the result of this function will be the same string.
1559 If the message does not end with a newline, then a segment such as C<at
1560 foo.pl line 37> will be appended, and possibly other clauses indicating
1561 the current state of execution. The resulting message will end with a
1564 Normally, the resulting message is returned in a new mortal SV.
1565 During global destruction a single SV may be shared between uses of this
1566 function. If C<consume> is true, then the function is permitted (but not
1567 required) to modify and return C<basemsg> instead of allocating a new SV.
1573 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1577 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1581 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1582 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1583 && grok_atoUV(ws, &wi, NULL)
1584 && wi <= PERL_INT_MAX
1586 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1591 PERL_ARGS_ASSERT_MESS_SV;
1593 if (SvROK(basemsg)) {
1599 sv_setsv(sv, basemsg);
1604 if (SvPOK(basemsg) && consume) {
1609 sv_copypv(sv, basemsg);
1612 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1614 * Try and find the file and line for PL_op. This will usually be
1615 * PL_curcop, but it might be a cop that has been optimised away. We
1616 * can try to find such a cop by searching through the optree starting
1617 * from the sibling of PL_curcop.
1622 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1627 Perl_sv_catpvf(aTHX_ sv, " at %s line %" LINE_Tf,
1628 OutCopFILE(cop), CopLINE(cop));
1631 /* Seems that GvIO() can be untrustworthy during global destruction. */
1632 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1633 && IoLINES(GvIOp(PL_last_in_gv)))
1636 const bool line_mode = (RsSIMPLE(PL_rs) &&
1637 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1638 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1639 SVfARG(PL_last_in_gv == PL_argvgv
1641 : newSVhek_mortal(GvNAME_HEK(PL_last_in_gv))),
1642 line_mode ? "line" : "chunk",
1643 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1645 if (PL_phase == PERL_PHASE_DESTRUCT)
1646 sv_catpvs(sv, " during global destruction");
1647 sv_catpvs(sv, ".\n");
1655 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1656 argument list, respectively. These are used to generate a string message. If
1658 message does not end with a newline, then it will be extended with
1659 some indication of the current location in the code, as described for
1662 Normally, the resulting message is returned in a new mortal SV.
1663 During global destruction a single SV may be shared between uses of
1670 Perl_vmess(pTHX_ const char *pat, va_list *args)
1672 SV * const sv = mess_alloc();
1674 PERL_ARGS_ASSERT_VMESS;
1676 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1677 return mess_sv(sv, 1);
1681 Perl_write_to_stderr(pTHX_ SV* msv)
1686 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1688 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1689 && (io = GvIO(PL_stderrgv))
1690 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1691 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1692 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1694 PerlIO * const serr = Perl_error_log;
1696 do_print(msv, serr);
1697 (void)PerlIO_flush(serr);
1702 =for apidoc_section $warning
1705 /* Common code used in dieing and warning */
1708 S_with_queued_errors(pTHX_ SV *ex)
1710 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1711 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1712 sv_catsv(PL_errors, ex);
1713 ex = sv_mortalcopy(PL_errors);
1714 SvCUR_set(PL_errors, 0);
1720 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1725 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1726 /* sv_2cv might call Perl_croak() or Perl_warner() */
1727 SV * const oldhook = *hook;
1729 if (!oldhook || oldhook == PERL_WARNHOOK_FATAL)
1735 cv = sv_2cv(oldhook, &stash, &gv, 0);
1737 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1747 exarg = newSVsv(ex);
1748 SvREADONLY_on(exarg);
1751 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1755 call_sv(MUTABLE_SV(cv), G_DISCARD);
1766 This behaves the same as L</croak_sv>, except for the return type.
1767 It should be used only where the C<OP *> return type is required.
1768 The function never actually returns.
1773 /* silence __declspec(noreturn) warnings */
1774 MSVC_DIAG_IGNORE(4646 4645)
1776 Perl_die_sv(pTHX_ SV *baseex)
1778 PERL_ARGS_ASSERT_DIE_SV;
1781 NORETURN_FUNCTION_END;
1787 =for apidoc_item die_nocontext
1789 These behave the same as L</croak>, except for the return type.
1790 They should be used only where the C<OP *> return type is required.
1791 They never actually return.
1793 The two forms differ only in that C<die_nocontext> does not take a thread
1794 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
1795 already have the thread context.
1800 #if defined(MULTIPLICITY)
1802 /* silence __declspec(noreturn) warnings */
1803 MSVC_DIAG_IGNORE(4646 4645)
1805 Perl_die_nocontext(const char* pat, ...)
1809 va_start(args, pat);
1811 NOT_REACHED; /* NOTREACHED */
1813 NORETURN_FUNCTION_END;
1817 #endif /* MULTIPLICITY */
1819 /* silence __declspec(noreturn) warnings */
1820 MSVC_DIAG_IGNORE(4646 4645)
1822 Perl_die(pTHX_ const char* pat, ...)
1825 va_start(args, pat);
1827 NOT_REACHED; /* NOTREACHED */
1829 NORETURN_FUNCTION_END;
1834 =for apidoc croak_sv
1836 This is an XS interface to Perl's C<die> function.
1838 C<baseex> is the error message or object. If it is a reference, it
1839 will be used as-is. Otherwise it is used as a string, and if it does
1840 not end with a newline then it will be extended with some indication of
1841 the current location in the code, as described for L</mess_sv>.
1843 The error message or object will be used as an exception, by default
1844 returning control to the nearest enclosing C<eval>, but subject to
1845 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1846 function never returns normally.
1848 To die with a simple string message, the L</croak> function may be
1855 Perl_croak_sv(pTHX_ SV *baseex)
1857 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1858 PERL_ARGS_ASSERT_CROAK_SV;
1859 invoke_exception_hook(ex, FALSE);
1866 This is an XS interface to Perl's C<die> function.
1868 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1869 argument list. These are used to generate a string message. If the
1870 message does not end with a newline, then it will be extended with
1871 some indication of the current location in the code, as described for
1874 The error message will be used as an exception, by default
1875 returning control to the nearest enclosing C<eval>, but subject to
1876 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1877 function never returns normally.
1879 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1880 (C<$@>) will be used as an error message or object instead of building an
1881 error message from arguments. If you want to throw a non-string object,
1882 or build an error message in an SV yourself, it is preferable to use
1883 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1889 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1891 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1892 invoke_exception_hook(ex, FALSE);
1898 =for apidoc_item croak_nocontext
1900 These are XS interfaces to Perl's C<die> function.
1902 They take a sprintf-style format pattern and argument list, which are used to
1903 generate a string message. If the message does not end with a newline, then it
1904 will be extended with some indication of the current location in the code, as
1905 described for C<L</mess_sv>>.
1907 The error message will be used as an exception, by default
1908 returning control to the nearest enclosing C<eval>, but subject to
1909 modification by a C<$SIG{__DIE__}> handler. In any case, these croak
1910 functions never return normally.
1912 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1913 (C<$@>) will be used as an error message or object instead of building an
1914 error message from arguments. If you want to throw a non-string object,
1915 or build an error message in an SV yourself, it is preferable to use
1916 the C<L</croak_sv>> function, which does not involve clobbering C<ERRSV>.
1918 The two forms differ only in that C<croak_nocontext> does not take a thread
1919 context (C<aTHX>) parameter. It is usually preferred as it takes up fewer
1920 bytes of code than plain C<Perl_croak>, and time is rarely a critical resource
1921 when you are about to throw an exception.
1926 #if defined(MULTIPLICITY)
1928 Perl_croak_nocontext(const char *pat, ...)
1932 va_start(args, pat);
1934 NOT_REACHED; /* NOTREACHED */
1937 #endif /* MULTIPLICITY */
1940 Perl_croak(pTHX_ const char *pat, ...)
1943 va_start(args, pat);
1945 NOT_REACHED; /* NOTREACHED */
1950 =for apidoc croak_no_modify
1952 This encapsulates a common reason for dying, generating terser object code than
1953 using the generic C<Perl_croak>. It is exactly equivalent to
1954 C<Perl_croak(aTHX_ "%s", PL_no_modify)> (which expands to something like
1955 "Modification of a read-only value attempted").
1957 Less code used on exception code paths reduces CPU cache pressure.
1963 Perl_croak_no_modify(void)
1965 Perl_croak_nocontext( "%s", PL_no_modify);
1968 /* does not return, used in util.c perlio.c and win32.c
1969 This is typically called when malloc returns NULL.
1972 Perl_croak_no_mem(void)
1976 int fd = PerlIO_fileno(Perl_error_log);
1978 SETERRNO(EBADF,RMS_IFI);
1980 /* Can't use PerlIO to write as it allocates memory */
1981 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1986 /* does not return, used only in POPSTACK */
1988 Perl_croak_popstack(void)
1991 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1998 This is an XS interface to Perl's C<warn> function.
2000 C<baseex> is the error message or object. If it is a reference, it
2001 will be used as-is. Otherwise it is used as a string, and if it does
2002 not end with a newline then it will be extended with some indication of
2003 the current location in the code, as described for L</mess_sv>.
2005 The error message or object will by default be written to standard error,
2006 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2008 To warn with a simple string message, the L</warn> function may be
2015 Perl_warn_sv(pTHX_ SV *baseex)
2017 SV *ex = mess_sv(baseex, 0);
2018 PERL_ARGS_ASSERT_WARN_SV;
2019 if (!invoke_exception_hook(ex, TRUE))
2020 write_to_stderr(ex);
2026 This is an XS interface to Perl's C<warn> function.
2028 This is like C<L</warn>>, but C<args> are an encapsulated
2031 Unlike with L</vcroak>, C<pat> is not permitted to be null.
2037 Perl_vwarn(pTHX_ const char* pat, va_list *args)
2039 SV *ex = vmess(pat, args);
2040 PERL_ARGS_ASSERT_VWARN;
2041 if (!invoke_exception_hook(ex, TRUE))
2042 write_to_stderr(ex);
2047 =for apidoc_item warn_nocontext
2049 These are XS interfaces to Perl's C<warn> function.
2051 They take a sprintf-style format pattern and argument list, which are used to
2052 generate a string message. If the message does not end with a newline, then it
2053 will be extended with some indication of the current location in the code, as
2054 described for C<L</mess_sv>>.
2056 The error message or object will by default be written to standard error,
2057 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2059 Unlike with C<L</croak>>, C<pat> is not permitted to be null.
2061 The two forms differ only in that C<warn_nocontext> does not take a thread
2062 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
2063 already have the thread context.
2068 #if defined(MULTIPLICITY)
2070 Perl_warn_nocontext(const char *pat, ...)
2074 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
2075 va_start(args, pat);
2079 #endif /* MULTIPLICITY */
2082 Perl_warn(pTHX_ const char *pat, ...)
2085 PERL_ARGS_ASSERT_WARN;
2086 va_start(args, pat);
2093 =for apidoc_item warner_nocontext
2095 These output a warning of the specified category (or categories) given by
2096 C<err>, using the sprintf-style format pattern C<pat>, and argument list.
2098 C<err> must be one of the C<L</packWARN>>, C<packWARN2>, C<packWARN3>,
2099 C<packWARN4> macros populated with the appropriate number of warning
2100 categories. If any of the warning categories they specify is fatal, a fatal
2101 exception is thrown.
2103 In any event a message is generated by the pattern and arguments. If the
2104 message does not end with a newline, then it will be extended with some
2105 indication of the current location in the code, as described for L</mess_sv>.
2107 The error message or object will by default be written to standard error,
2108 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2110 C<pat> is not permitted to be null.
2112 The two forms differ only in that C<warner_nocontext> does not take a thread
2113 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
2114 already have the thread context.
2116 These functions differ from the similarly named C<L</warn>> functions, in that
2117 the latter are for XS code to unconditionally display a warning, whereas these
2118 are for code that may be compiling a perl program, and does extra checking to
2119 see if the warning should be fatal.
2121 =for apidoc ck_warner
2122 =for apidoc_item ck_warner_d
2123 If none of the warning categories given by C<err> are enabled, do nothing;
2124 otherwise call C<L</warner>> or C<L</warner_nocontext>> with the passed-in
2127 C<err> must be one of the C<L</packWARN>>, C<packWARN2>, C<packWARN3>,
2128 C<packWARN4> macros populated with the appropriate number of warning
2131 The two forms differ only in that C<ck_warner_d> should be used if warnings for
2132 any of the categories are by default enabled.
2135 This is like C<L</warner>>, but C<args> are an encapsulated argument list.
2140 #if defined(MULTIPLICITY)
2142 Perl_warner_nocontext(U32 err, const char *pat, ...)
2146 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
2147 va_start(args, pat);
2148 vwarner(err, pat, &args);
2151 #endif /* MULTIPLICITY */
2154 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
2156 PERL_ARGS_ASSERT_CK_WARNER_D;
2158 if (Perl_ckwarn_d(aTHX_ err)) {
2160 va_start(args, pat);
2161 vwarner(err, pat, &args);
2167 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
2169 PERL_ARGS_ASSERT_CK_WARNER;
2171 if (Perl_ckwarn(aTHX_ err)) {
2173 va_start(args, pat);
2174 vwarner(err, pat, &args);
2180 Perl_warner(pTHX_ U32 err, const char* pat,...)
2183 PERL_ARGS_ASSERT_WARNER;
2184 va_start(args, pat);
2185 vwarner(err, pat, &args);
2190 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
2192 PERL_ARGS_ASSERT_VWARNER;
2194 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
2195 !(PL_in_eval & EVAL_KEEPERR)
2197 SV * const msv = vmess(pat, args);
2199 if (PL_parser && PL_parser->error_count) {
2203 invoke_exception_hook(msv, FALSE);
2208 Perl_vwarn(aTHX_ pat, args);
2212 /* implements the ckWARN? macros */
2215 Perl_ckwarn(pTHX_ U32 w)
2217 /* If lexical warnings have not been set, use $^W. */
2219 return PL_dowarn & G_WARN_ON;
2221 return ckwarn_common(w);
2224 /* implements the ckWARN?_d macro */
2227 Perl_ckwarn_d(pTHX_ U32 w)
2229 /* If lexical warnings have not been set then default classes warn. */
2233 return ckwarn_common(w);
2237 S_ckwarn_common(pTHX_ U32 w)
2239 if (PL_curcop->cop_warnings == pWARN_ALL)
2242 if (PL_curcop->cop_warnings == pWARN_NONE)
2245 /* Check the assumption that at least the first slot is non-zero. */
2246 assert(unpackWARN1(w));
2248 /* Check the assumption that it is valid to stop as soon as a zero slot is
2250 if (!unpackWARN2(w)) {
2251 assert(!unpackWARN3(w));
2252 assert(!unpackWARN4(w));
2253 } else if (!unpackWARN3(w)) {
2254 assert(!unpackWARN4(w));
2257 /* Right, dealt with all the special cases, which are implemented as non-
2258 pointers, so there is a pointer to a real warnings mask. */
2260 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2262 } while (w >>= WARNshift);
2268 Perl_new_warnings_bitfield(pTHX_ char *buffer, const char *const bits,
2270 const MEM_SIZE len_wanted = (size > WARNsize ? size : WARNsize);
2271 PERL_UNUSED_CONTEXT;
2272 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2274 /* pass in null as the source string as we will do the
2275 * copy ourselves. */
2276 buffer = rcpv_new(NULL, len_wanted, RCPVf_NO_COPY);
2277 Copy(bits, buffer, size, char);
2278 if (size < WARNsize)
2279 Zero(buffer + size, WARNsize - size, char);
2283 /* since we've already done strlen() for both nam and val
2284 * we can use that info to make things faster than
2285 * sprintf(s, "%s=%s", nam, val)
2287 #define my_setenv_format(s, nam, nlen, val, vlen) \
2288 Copy(nam, s, nlen, char); \
2290 Copy(val, s+(nlen+1), vlen, char); \
2291 *(s+(nlen+1+vlen)) = '\0'
2295 #if defined(USE_ENVIRON_ARRAY) || defined(WIN32)
2296 /* NB: VMS' my_setenv() is in vms.c */
2298 /* small wrapper for use by Perl_my_setenv that mallocs, or reallocs if
2299 * 'current' is non-null, with up to three sizes that are added together.
2300 * It handles integer overflow.
2304 S_env_alloc(void *current, Size_t l1, Size_t l2, Size_t l3, Size_t size)
2307 Size_t sl, l = l1 + l2;
2319 ? safesysrealloc(current, sl)
2320 : safesysmalloc(sl);
2325 croak_memory_wrap();
2330 =for apidoc_section $utility
2331 =for apidoc my_setenv
2333 A wrapper for the C library L<setenv(3)>. Don't use the latter, as the perl
2334 version has desirable safeguards
2340 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2342 # if defined(USE_ITHREADS) && !defined(WIN32)
2343 /* only parent thread can modify process environment, so no need to use a
2345 if (PL_curinterp != aTHX)
2349 # if defined(HAS_SETENV) && defined(HAS_UNSETENV)
2353 setenv(nam, val, 1);
2356 # elif defined(HAS_UNSETENV)
2359 if (environ) /* old glibc can crash with null environ */
2362 const Size_t nlen = strlen(nam);
2363 const Size_t vlen = strlen(val);
2364 char * const new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2365 my_setenv_format(new_env, nam, nlen, val, vlen);
2369 # else /* ! HAS_UNSETENV */
2371 const Size_t nlen = strlen(nam);
2375 Size_t vlen = strlen(val);
2376 char *new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2377 /* all that work just for this */
2378 my_setenv_format(new_env, nam, nlen, val, vlen);
2382 PerlEnv_putenv(new_env);
2383 safesysfree(new_env);
2386 # endif /* HAS_SETENV */
2389 #endif /* USE_ENVIRON_ARRAY || WIN32 */
2391 #ifdef UNLINK_ALL_VERSIONS
2393 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2397 PERL_ARGS_ASSERT_UNLNK;
2399 while (PerlLIO_unlink(f) >= 0)
2401 return retries ? 0 : -1;
2406 #if (__CHARSET_LIB == 1)
2407 static int chgfdccsid(int fd, unsigned short ccsid)
2410 memset(&attr, 0, sizeof(attr));
2411 attr.att_filetagchg = 1;
2412 attr.att_filetag.ft_ccsid = ccsid;
2413 if (ccsid != FT_BINARY) {
2414 attr.att_filetag.ft_txtflag = 1;
2416 return __fchattr(fd, &attr, sizeof(attr));
2422 =for apidoc my_popen_list
2424 Implementing function on some systems for PerlProc_popen_list()
2430 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2432 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2440 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2442 PERL_FLUSHALL_FOR_CHILD;
2443 This = (*mode == 'w');
2447 taint_proper("Insecure %s%s", "EXEC");
2449 if (PerlProc_pipe_cloexec(p) < 0)
2451 /* Try for another pipe pair for error return */
2452 if (PerlProc_pipe_cloexec(pp) >= 0)
2454 while ((pid = PerlProc_fork()) < 0) {
2455 if (errno != EAGAIN) {
2456 PerlLIO_close(p[This]);
2457 PerlLIO_close(p[that]);
2459 PerlLIO_close(pp[0]);
2460 PerlLIO_close(pp[1]);
2464 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2473 /* Close parent's end of error status pipe (if any) */
2475 PerlLIO_close(pp[0]);
2477 #if (__CHARSET_LIB == 1)
2478 chgfdccsid(p[THIS], 819);
2479 chgfdccsid(p[THAT], 819);
2482 /* Now dup our end of _the_ pipe to right position */
2483 if (p[THIS] != (*mode == 'r')) {
2484 PerlLIO_dup2(p[THIS], *mode == 'r');
2485 PerlLIO_close(p[THIS]);
2486 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2487 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2490 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2491 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2493 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2494 /* No automatic close - do it by hand */
2501 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2507 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2514 PerlLIO_close(pp[1]);
2515 /* Keep the lower of the two fd numbers */
2516 if (p[that] < p[This]) {
2517 PerlLIO_dup2_cloexec(p[This], p[that]);
2518 PerlLIO_close(p[This]);
2522 PerlLIO_close(p[that]); /* close child's end of pipe */
2524 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2525 SvUPGRADE(sv,SVt_IV);
2527 PL_forkprocess = pid;
2528 /* If we managed to get status pipe check for exec fail */
2529 if (did_pipes && pid > 0) {
2531 unsigned read_total = 0;
2533 while (read_total < sizeof(int)) {
2534 const SSize_t n1 = PerlLIO_read(pp[0],
2535 (void*)(((char*)&errkid)+read_total),
2536 (sizeof(int)) - read_total);
2541 PerlLIO_close(pp[0]);
2543 if (read_total) { /* Error */
2545 PerlLIO_close(p[This]);
2546 if (read_total != sizeof(int))
2547 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", read_total);
2549 pid2 = wait4pid(pid, &status, 0);
2550 } while (pid2 == -1 && errno == EINTR);
2551 errno = errkid; /* Propagate errno from kid */
2556 PerlLIO_close(pp[0]);
2558 #if (__CHARSET_LIB == 1)
2559 PerlIO* io = PerlIO_fdopen(p[This], mode);
2561 chgfdccsid(p[This], 819);
2565 return PerlIO_fdopen(p[This], mode);
2568 return PerlIO_fdopen(p[This], mode);
2572 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2573 return my_syspopen4(aTHX_ NULL, mode, n, args);
2574 # elif defined(WIN32)
2575 return win32_popenlist(mode, n, args);
2577 Perl_croak(aTHX_ "List form of piped open not implemented");
2578 return (PerlIO *) NULL;
2583 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2584 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2587 =for apidoc_section $io
2588 =for apidoc my_popen
2590 A wrapper for the C library L<popen(3)>. Don't use the latter, as the Perl
2591 version knows things that interact with the rest of the perl interpreter.
2597 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2603 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2607 PERL_ARGS_ASSERT_MY_POPEN;
2609 PERL_FLUSHALL_FOR_CHILD;
2612 return my_syspopen(aTHX_ cmd,mode);
2615 This = (*mode == 'w');
2617 if (doexec && TAINTING_get) {
2619 taint_proper("Insecure %s%s", "EXEC");
2621 if (PerlProc_pipe_cloexec(p) < 0)
2623 if (doexec && PerlProc_pipe_cloexec(pp) >= 0)
2625 while ((pid = PerlProc_fork()) < 0) {
2626 if (errno != EAGAIN) {
2627 PerlLIO_close(p[This]);
2628 PerlLIO_close(p[that]);
2630 PerlLIO_close(pp[0]);
2631 PerlLIO_close(pp[1]);
2634 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2637 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2647 PerlLIO_close(pp[0]);
2649 #if (__CHARSET_LIB == 1)
2650 chgfdccsid(p[THIS], 819);
2651 chgfdccsid(p[THAT], 819);
2654 if (p[THIS] != (*mode == 'r')) {
2655 PerlLIO_dup2(p[THIS], *mode == 'r');
2656 PerlLIO_close(p[THIS]);
2657 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2658 PerlLIO_close(p[THAT]);
2661 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2662 PerlLIO_close(p[THAT]);
2666 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2673 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2678 /* may or may not use the shell */
2679 do_exec3(cmd, pp[1], did_pipes);
2682 #endif /* defined OS2 */
2684 #ifdef PERLIO_USING_CRLF
2685 /* Since we circumvent IO layers when we manipulate low-level
2686 filedescriptors directly, need to manually switch to the
2687 default, binary, low-level mode; see PerlIOBuf_open(). */
2688 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2691 #ifdef PERL_USES_PL_PIDSTATUS
2692 hv_clear(PL_pidstatus); /* we have no children */
2699 PerlLIO_close(pp[1]);
2700 if (p[that] < p[This]) {
2701 PerlLIO_dup2_cloexec(p[This], p[that]);
2702 PerlLIO_close(p[This]);
2706 PerlLIO_close(p[that]);
2708 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2709 SvUPGRADE(sv,SVt_IV);
2711 PL_forkprocess = pid;
2712 if (did_pipes && pid > 0) {
2716 while (n < sizeof(int)) {
2717 const SSize_t n1 = PerlLIO_read(pp[0],
2718 (void*)(((char*)&errkid)+n),
2724 PerlLIO_close(pp[0]);
2726 if (n) { /* Error */
2728 PerlLIO_close(p[This]);
2729 if (n != sizeof(int))
2730 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2732 pid2 = wait4pid(pid, &status, 0);
2733 } while (pid2 == -1 && errno == EINTR);
2734 errno = errkid; /* Propagate errno from kid */
2739 PerlLIO_close(pp[0]);
2741 #if (__CHARSET_LIB == 1)
2742 PerlIO* io = PerlIO_fdopen(p[This], mode);
2744 chgfdccsid(p[This], 819);
2748 return PerlIO_fdopen(p[This], mode);
2751 return PerlIO_fdopen(p[This], mode);
2754 #elif defined(__LIBCATAMOUNT__)
2756 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2761 #endif /* !DOSISH */
2763 /* this is called in parent before the fork() */
2765 Perl_atfork_lock(void)
2766 #if defined(USE_ITHREADS)
2768 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2771 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2773 PERL_TSA_ACQUIRE(PL_op_mutex)
2776 #if defined(USE_ITHREADS)
2777 /* locks must be held in locking order (if any) */
2779 MUTEX_LOCK(&PL_perlio_mutex);
2782 MUTEX_LOCK(&PL_malloc_mutex);
2788 /* this is called in both parent and child after the fork() */
2790 Perl_atfork_unlock(void)
2791 #if defined(USE_ITHREADS)
2793 PERL_TSA_RELEASE(PL_perlio_mutex)
2796 PERL_TSA_RELEASE(PL_malloc_mutex)
2798 PERL_TSA_RELEASE(PL_op_mutex)
2801 #if defined(USE_ITHREADS)
2802 /* locks must be released in same order as in atfork_lock() */
2804 MUTEX_UNLOCK(&PL_perlio_mutex);
2807 MUTEX_UNLOCK(&PL_malloc_mutex);
2814 =for apidoc_section $concurrency
2817 This is for the use of C<PerlProc_fork> as a wrapper for the C library
2818 L<fork(2)> on some platforms to hide some platform quirks. It should not be
2819 used except through C<PerlProc_fork>.
2828 #if defined(HAS_FORK)
2830 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2835 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2836 * handlers elsewhere in the code */
2840 #elif defined(__amigaos4__)
2841 return amigaos_fork();
2843 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2844 Perl_croak_nocontext("fork() not available");
2846 #endif /* HAS_FORK */
2851 dup2(int oldfd, int newfd)
2853 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2856 PerlLIO_close(newfd);
2857 return fcntl(oldfd, F_DUPFD, newfd);
2859 #define DUP2_MAX_FDS 256
2860 int fdtmp[DUP2_MAX_FDS];
2866 PerlLIO_close(newfd);
2867 /* good enough for low fd's... */
2868 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2869 if (fdx >= DUP2_MAX_FDS) {
2877 PerlLIO_close(fdtmp[--fdx]);
2884 #ifdef HAS_SIGACTION
2887 =for apidoc_section $signals
2890 A wrapper for the C library functions L<sigaction(2)> or L<signal(2)>.
2891 Use this instead of those libc functions, as the Perl version gives the
2892 safest available implementation, and knows things that interact with the
2893 rest of the perl interpreter.
2899 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2901 struct sigaction act, oact;
2904 /* only "parent" interpreter can diddle signals */
2905 if (PL_curinterp != aTHX)
2906 return (Sighandler_t) SIG_ERR;
2909 act.sa_handler = handler;
2910 sigemptyset(&act.sa_mask);
2913 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2914 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2916 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2917 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2918 act.sa_flags |= SA_NOCLDWAIT;
2920 if (sigaction(signo, &act, &oact) == -1)
2921 return (Sighandler_t) SIG_ERR;
2923 return (Sighandler_t) oact.sa_handler;
2927 =for apidoc_section $signals
2928 =for apidoc rsignal_state
2930 Returns a the current signal handler for signal C<signo>.
2937 Perl_rsignal_state(pTHX_ int signo)
2939 struct sigaction oact;
2940 PERL_UNUSED_CONTEXT;
2942 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2943 return (Sighandler_t) SIG_ERR;
2945 return (Sighandler_t) oact.sa_handler;
2949 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2951 struct sigaction act;
2953 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2956 /* only "parent" interpreter can diddle signals */
2957 if (PL_curinterp != aTHX)
2961 act.sa_handler = handler;
2962 sigemptyset(&act.sa_mask);
2965 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2966 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2968 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2969 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2970 act.sa_flags |= SA_NOCLDWAIT;
2972 return sigaction(signo, &act, save);
2976 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2978 PERL_UNUSED_CONTEXT;
2980 /* only "parent" interpreter can diddle signals */
2981 if (PL_curinterp != aTHX)
2985 return sigaction(signo, save, (struct sigaction *)NULL);
2988 #else /* !HAS_SIGACTION */
2991 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2993 #if defined(USE_ITHREADS) && !defined(WIN32)
2994 /* only "parent" interpreter can diddle signals */
2995 if (PL_curinterp != aTHX)
2996 return (Sighandler_t) SIG_ERR;
2999 return PerlProc_signal(signo, handler);
3009 Perl_rsignal_state(pTHX_ int signo)
3011 Sighandler_t oldsig;
3013 #if defined(USE_ITHREADS) && !defined(WIN32)
3014 /* only "parent" interpreter can diddle signals */
3015 if (PL_curinterp != aTHX)
3016 return (Sighandler_t) SIG_ERR;
3020 oldsig = PerlProc_signal(signo, sig_trap);
3021 PerlProc_signal(signo, oldsig);
3023 PerlProc_kill(PerlProc_getpid(), signo);
3028 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3030 #if defined(USE_ITHREADS) && !defined(WIN32)
3031 /* only "parent" interpreter can diddle signals */
3032 if (PL_curinterp != aTHX)
3035 *save = PerlProc_signal(signo, handler);
3036 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
3040 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3042 #if defined(USE_ITHREADS) && !defined(WIN32)
3043 /* only "parent" interpreter can diddle signals */
3044 if (PL_curinterp != aTHX)
3047 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
3050 #endif /* !HAS_SIGACTION */
3051 #endif /* !PERL_MICRO */
3053 /* VMS' my_pclose() is in VMS.c */
3056 =for apidoc_section $io
3057 =for apidoc my_pclose
3059 A wrapper for the C library L<pclose(3)>. Don't use the latter, as the Perl
3060 version knows things that interact with the rest of the perl interpreter.
3065 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
3067 Perl_my_pclose(pTHX_ PerlIO *ptr)
3075 const int fd = PerlIO_fileno(ptr);
3078 svp = av_fetch(PL_fdpid, fd, FALSE);
3080 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3087 #if defined(USE_PERLIO)
3088 /* Find out whether the refcount is low enough for us to wait for the
3089 child proc without blocking. */
3090 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
3092 should_wait = pid > 0;
3096 if (pid == -2) { /* Opened by popen. */
3097 return my_syspclose(ptr);
3100 close_failed = (PerlIO_close(ptr) == EOF);
3102 if (should_wait) do {
3103 pid2 = wait4pid(pid, &status, 0);
3104 } while (pid2 == -1 && errno == EINTR);
3111 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
3115 #elif defined(__LIBCATAMOUNT__)
3117 Perl_my_pclose(pTHX_ PerlIO *ptr)
3121 #endif /* !DOSISH */
3123 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32)) && !defined(__LIBCATAMOUNT__)
3125 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3128 PERL_ARGS_ASSERT_WAIT4PID;
3129 #ifdef PERL_USES_PL_PIDSTATUS
3131 /* PERL_USES_PL_PIDSTATUS is only defined when neither
3132 waitpid() nor wait4() is available, or on OS/2, which
3133 doesn't appear to support waiting for a progress group
3134 member, so we can only treat a 0 pid as an unknown child.
3141 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3142 pid, rather than a string form. */
3143 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3144 if (svp && *svp != &PL_sv_undef) {
3145 *statusp = SvIVX(*svp);
3146 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3154 hv_iterinit(PL_pidstatus);
3155 if ((entry = hv_iternext(PL_pidstatus))) {
3156 SV * const sv = hv_iterval(PL_pidstatus,entry);
3158 const char * const spid = hv_iterkey(entry,&len);
3160 assert (len == sizeof(Pid_t));
3161 memcpy((char *)&pid, spid, len);
3162 *statusp = SvIVX(sv);
3163 /* The hash iterator is currently on this entry, so simply
3164 calling hv_delete would trigger the lazy delete, which on
3165 aggregate does more work, because next call to hv_iterinit()
3166 would spot the flag, and have to call the delete routine,
3167 while in the meantime any new entries can't re-use that
3169 hv_iterinit(PL_pidstatus);
3170 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3177 # ifdef HAS_WAITPID_RUNTIME
3178 if (!HAS_WAITPID_RUNTIME)
3181 result = PerlProc_waitpid(pid,statusp,flags);
3184 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3185 result = wait4(pid,statusp,flags,NULL);
3188 #ifdef PERL_USES_PL_PIDSTATUS
3189 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3194 Perl_croak(aTHX_ "Can't do waitpid with flags");
3196 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3197 pidgone(result,*statusp);
3203 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3206 if (result < 0 && errno == EINTR) {
3208 errno = EINTR; /* reset in case a signal handler changed $! */
3212 #endif /* !DOSISH || OS2 || WIN32 */
3214 #ifdef PERL_USES_PL_PIDSTATUS
3216 S_pidgone(pTHX_ Pid_t pid, int status)
3220 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3221 SvUPGRADE(sv,SVt_IV);
3222 SvIV_set(sv, status);
3230 int /* Cannot prototype with I32
3232 my_syspclose(PerlIO *ptr)
3235 Perl_my_pclose(pTHX_ PerlIO *ptr)
3238 /* Needs work for PerlIO ! */
3239 FILE * const f = PerlIO_findFILE(ptr);
3240 const I32 result = pclose(f);
3241 PerlIO_releaseFILE(ptr,f);
3247 =for apidoc repeatcpy
3249 Make C<count> copies of the C<len> bytes beginning at C<from>, placing them
3250 into memory beginning at C<to>, which must be big enough to accommodate them
3256 #define PERL_REPEATCPY_LINEAR 4
3258 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3260 PERL_ARGS_ASSERT_REPEATCPY;
3265 croak_memory_wrap();
3268 memset(to, *from, count);
3271 IV items, linear, half;
3273 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3274 for (items = 0; items < linear; ++items) {
3275 const char *q = from;
3277 for (todo = len; todo > 0; todo--)
3282 while (items <= half) {
3283 IV size = items * len;
3284 memcpy(p, to, size);
3290 memcpy(p, to, (count - items) * len);
3296 Perl_same_dirent(pTHX_ const char *a, const char *b)
3298 char *fa = strrchr(a,'/');
3299 char *fb = strrchr(b,'/');
3302 SV * const tmpsv = sv_newmortal();
3304 PERL_ARGS_ASSERT_SAME_DIRENT;
3317 sv_setpvs(tmpsv, ".");
3319 sv_setpvn(tmpsv, a, fa - a);
3320 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3323 sv_setpvs(tmpsv, ".");
3325 sv_setpvn(tmpsv, b, fb - b);
3326 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3328 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3329 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3331 #endif /* !HAS_RENAME */
3334 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3335 const char *const *const search_ext, I32 flags)
3337 const char *xfound = NULL;
3338 char *xfailed = NULL;
3339 char tmpbuf[MAXPATHLEN];
3344 #if defined(DOSISH) && !defined(OS2)
3345 # define SEARCH_EXTS ".bat", ".cmd", NULL
3346 # define MAX_EXT_LEN 4
3349 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3350 # define MAX_EXT_LEN 4
3353 # define SEARCH_EXTS ".pl", ".com", NULL
3354 # define MAX_EXT_LEN 4
3356 /* additional extensions to try in each dir if scriptname not found */
3358 static const char *const exts[] = { SEARCH_EXTS };
3359 const char *const *const ext = search_ext ? search_ext : exts;
3360 int extidx = 0, i = 0;
3361 const char *curext = NULL;
3363 PERL_UNUSED_ARG(search_ext);
3364 # define MAX_EXT_LEN 0
3367 PERL_ARGS_ASSERT_FIND_SCRIPT;
3370 * If dosearch is true and if scriptname does not contain path
3371 * delimiters, search the PATH for scriptname.
3373 * If SEARCH_EXTS is also defined, will look for each
3374 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3375 * while searching the PATH.
3377 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3378 * proceeds as follows:
3379 * If DOSISH or VMSISH:
3380 * + look for ./scriptname{,.foo,.bar}
3381 * + search the PATH for scriptname{,.foo,.bar}
3384 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3385 * this will not look in '.' if it's not in the PATH)
3390 # ifdef ALWAYS_DEFTYPES
3391 len = strlen(scriptname);
3392 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3393 int idx = 0, deftypes = 1;
3396 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3399 int idx = 0, deftypes = 1;
3402 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3404 /* The first time through, just add SEARCH_EXTS to whatever we
3405 * already have, so we can check for default file types. */
3407 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3414 if ((strlen(tmpbuf) + strlen(scriptname)
3415 + MAX_EXT_LEN) >= sizeof tmpbuf)
3416 continue; /* don't search dir with too-long name */
3417 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3421 if (strEQ(scriptname, "-"))
3423 if (dosearch) { /* Look in '.' first. */
3424 const char *cur = scriptname;
3426 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3428 if (strEQ(ext[i++],curext)) {
3429 extidx = -1; /* already has an ext */
3434 DEBUG_p(PerlIO_printf(Perl_debug_log,
3435 "Looking for %s\n",cur));
3438 if (PerlLIO_stat(cur,&statbuf) >= 0
3439 && !S_ISDIR(statbuf.st_mode)) {
3448 if (cur == scriptname) {
3449 len = strlen(scriptname);
3450 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3452 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3455 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3456 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3461 if (dosearch && !strchr(scriptname, '/')
3463 && !strchr(scriptname, '\\')
3465 && (s = PerlEnv_getenv("PATH")))
3469 bufend = s + strlen(s);
3470 while (s < bufend) {
3474 && *s != ';'; len++, s++) {
3475 if (len < sizeof tmpbuf)
3478 if (len < sizeof tmpbuf)
3481 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3486 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3487 continue; /* don't search dir with too-long name */
3490 && tmpbuf[len - 1] != '/'
3491 && tmpbuf[len - 1] != '\\'
3494 tmpbuf[len++] = '/';
3495 if (len == 2 && tmpbuf[0] == '.')
3497 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3501 len = strlen(tmpbuf);
3502 if (extidx > 0) /* reset after previous loop */
3506 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3507 retval = PerlLIO_stat(tmpbuf,&statbuf);
3508 if (S_ISDIR(statbuf.st_mode)) {
3512 } while ( retval < 0 /* not there */
3513 && extidx>=0 && ext[extidx] /* try an extension? */
3514 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3519 if (S_ISREG(statbuf.st_mode)
3520 && cando(S_IRUSR,TRUE,&statbuf)
3521 #if !defined(DOSISH)
3522 && cando(S_IXUSR,TRUE,&statbuf)
3526 xfound = tmpbuf; /* bingo! */
3530 xfailed = savepv(tmpbuf);
3535 if (!xfound && !seen_dot && !xfailed &&
3536 (PerlLIO_stat(scriptname,&statbuf) < 0
3537 || S_ISDIR(statbuf.st_mode)))
3539 seen_dot = 1; /* Disable message. */
3544 if (flags & 1) { /* do or die? */
3545 /* diag_listed_as: Can't execute %s */
3546 Perl_croak(aTHX_ "Can't %s %s%s%s",
3547 (xfailed ? "execute" : "find"),
3548 (xfailed ? xfailed : scriptname),
3549 (xfailed ? "" : " on PATH"),
3550 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3555 scriptname = xfound;
3557 return (scriptname ? savepv(scriptname) : NULL);
3560 #ifndef PERL_GET_CONTEXT_DEFINED
3563 =for apidoc_section $embedding
3564 =for apidoc get_context
3566 Implements L<perlapi/C<PERL_GET_CONTEXT>>, which you should use instead.
3572 Perl_get_context(void)
3574 #if defined(USE_ITHREADS)
3575 # ifdef OLD_PTHREADS_API
3577 int error = pthread_getspecific(PL_thr_key, &t);
3579 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3581 # elif defined(I_MACH_CTHREADS)
3582 return (void*)cthread_data(cthread_self());
3584 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3592 =for apidoc_section $embedding
3593 =for apidoc set_context
3595 Implements L<perlapi/C<PERL_SET_CONTEXT>>, which you should use instead.
3601 Perl_set_context(void *t)
3603 PERL_ARGS_ASSERT_SET_CONTEXT;
3604 #if defined(USE_ITHREADS)
3605 # ifdef PERL_USE_THREAD_LOCAL
3606 PL_current_context = t;
3608 # ifdef I_MACH_CTHREADS
3609 cthread_set_data(cthread_self(), t);
3611 /* We set thread-specific value always, as C++ code has to read it with
3612 * pthreads, because the declaration syntax for thread local storage for C11
3613 * is incompatible with C++, meaning that we can't expose the thread local
3614 * variable to C++ code. */
3616 const int error = pthread_setspecific(PL_thr_key, t);
3618 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3622 PERL_SET_NON_tTHX_CONTEXT(t);
3629 #endif /* !PERL_GET_CONTEXT_DEFINED */
3632 =for apidoc get_op_names
3634 Return a pointer to the array of all the names of the various OPs
3635 Given an opcode from the enum in F<opcodes.h>, C<PL_op_name[opcode]> returns a
3636 pointer to a C language string giving its name.
3642 Perl_get_op_names(pTHX)
3644 PERL_UNUSED_CONTEXT;
3645 return (char **)PL_op_name;
3649 =for apidoc get_op_descs
3651 Return a pointer to the array of all the descriptions of the various OPs
3652 Given an opcode from the enum in F<opcodes.h>, C<PL_op_desc[opcode]> returns a
3653 pointer to a C language string giving its description.
3659 Perl_get_op_descs(pTHX)
3661 PERL_UNUSED_CONTEXT;
3662 return (char **)PL_op_desc;
3666 Perl_get_no_modify(pTHX)
3668 PERL_UNUSED_CONTEXT;
3669 return PL_no_modify;
3673 Perl_get_opargs(pTHX)
3675 PERL_UNUSED_CONTEXT;
3676 return (U32 *)PL_opargs;
3680 Perl_get_ppaddr(pTHX)
3682 PERL_UNUSED_CONTEXT;
3683 return (PPADDR_t*)PL_ppaddr;
3686 #ifndef HAS_GETENV_LEN
3688 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3690 char * const env_trans = PerlEnv_getenv(env_elem);
3691 PERL_UNUSED_CONTEXT;
3692 PERL_ARGS_ASSERT_GETENV_LEN;
3694 *len = strlen(env_trans);
3701 Perl_get_vtbl(pTHX_ int vtbl_id)
3703 PERL_UNUSED_CONTEXT;
3705 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3706 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3710 =for apidoc_section $io
3711 =for apidoc my_fflush_all
3713 Implements C<PERL_FLUSHALL_FOR_CHILD> on some platforms.
3719 Perl_my_fflush_all(pTHX)
3721 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3722 return PerlIO_flush(NULL);
3724 # if defined(HAS__FWALK)
3725 extern int fflush(FILE *);
3726 /* undocumented, unprototyped, but very useful BSDism */
3727 extern void _fwalk(int (*)(FILE *));
3731 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3733 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3734 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3735 # elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3736 open_max = sysconf(_SC_OPEN_MAX);
3737 # elif defined(FOPEN_MAX)
3738 open_max = FOPEN_MAX;
3739 # elif defined(OPEN_MAX)
3740 open_max = OPEN_MAX;
3741 # elif defined(_NFILE)
3746 for (i = 0; i < open_max; i++)
3747 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3748 STDIO_STREAM_ARRAY[i]._file < open_max &&
3749 STDIO_STREAM_ARRAY[i]._flag)
3750 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3754 SETERRNO(EBADF,RMS_IFI);
3761 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3763 if (ckWARN(WARN_IO)) {
3765 = gv && (isGV_with_GP(gv))
3768 const char * const direction = have == '>' ? "out" : "in";
3770 if (name && HEK_LEN(name))
3771 Perl_warner(aTHX_ packWARN(WARN_IO),
3772 "Filehandle %" HEKf " opened only for %sput",
3773 HEKfARG(name), direction);
3775 Perl_warner(aTHX_ packWARN(WARN_IO),
3776 "Filehandle opened only for %sput", direction);
3781 Perl_report_evil_fh(pTHX_ const GV *gv)
3783 const IO *io = gv ? GvIO(gv) : NULL;
3784 const PERL_BITFIELD16 op = PL_op->op_type;
3788 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3790 warn_type = WARN_CLOSED;
3794 warn_type = WARN_UNOPENED;
3797 if (ckWARN(warn_type)) {
3799 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3800 newSVhek_mortal(GvENAME_HEK(gv)) : NULL;
3801 const char * const pars =
3802 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3803 const char * const func =
3805 (op == OP_READLINE || op == OP_RCATLINE
3806 ? "readline" : /* "<HANDLE>" not nice */
3807 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3809 const char * const type =
3811 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3812 ? "socket" : "filehandle");
3813 const bool have_name = name && SvCUR(name);
3814 Perl_warner(aTHX_ packWARN(warn_type),
3815 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3816 have_name ? " " : "",
3817 SVfARG(have_name ? name : &PL_sv_no));
3818 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3820 aTHX_ packWARN(warn_type),
3821 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3822 func, pars, have_name ? " " : "",
3823 SVfARG(have_name ? name : &PL_sv_no)
3828 /* To workaround core dumps from the uninitialised tm_zone we get the
3829 * system to give us a reasonable struct to copy. This fix means that
3830 * strftime uses the tm_zone and tm_gmtoff values returned by
3831 * localtime(time()). That should give the desired result most of the
3832 * time. But probably not always!
3834 * This does not address tzname aspects of NETaa14816.
3839 # ifndef STRUCT_TM_HASZONE
3840 # define STRUCT_TM_HASZONE
3844 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3845 # ifndef HAS_TM_TM_ZONE
3846 # define HAS_TM_TM_ZONE
3851 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3853 #ifdef HAS_TM_TM_ZONE
3855 const struct tm* my_tm;
3856 PERL_UNUSED_CONTEXT;
3857 PERL_ARGS_ASSERT_INIT_TM;
3861 my_tm = localtime(&now);
3863 Copy(my_tm, ptm, 1, struct tm);
3866 PERL_UNUSED_CONTEXT;
3867 PERL_ARGS_ASSERT_INIT_TM;
3868 PERL_UNUSED_ARG(ptm);
3873 =for apidoc_section $time
3874 =for apidoc mini_mktime
3875 normalise S<C<struct tm>> values without the localtime() semantics (and
3876 overhead) of mktime().
3881 Perl_mini_mktime(struct tm *ptm)
3885 int month, mday, year, jday;
3886 int odd_cent, odd_year;
3888 PERL_ARGS_ASSERT_MINI_MKTIME;
3890 #define DAYS_PER_YEAR 365
3891 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3892 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3893 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3894 #define SECS_PER_HOUR (60*60)
3895 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3896 /* parentheses deliberately absent on these two, otherwise they don't work */
3897 #define MONTH_TO_DAYS 153/5
3898 #define DAYS_TO_MONTH 5/153
3899 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3900 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3901 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3902 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3905 * Year/day algorithm notes:
3907 * With a suitable offset for numeric value of the month, one can find
3908 * an offset into the year by considering months to have 30.6 (153/5) days,
3909 * using integer arithmetic (i.e., with truncation). To avoid too much
3910 * messing about with leap days, we consider January and February to be
3911 * the 13th and 14th month of the previous year. After that transformation,
3912 * we need the month index we use to be high by 1 from 'normal human' usage,
3913 * so the month index values we use run from 4 through 15.
3915 * Given that, and the rules for the Gregorian calendar (leap years are those
3916 * divisible by 4 unless also divisible by 100, when they must be divisible
3917 * by 400 instead), we can simply calculate the number of days since some
3918 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3919 * the days we derive from our month index, and adding in the day of the
3920 * month. The value used here is not adjusted for the actual origin which
3921 * it normally would use (1 January A.D. 1), since we're not exposing it.
3922 * We're only building the value so we can turn around and get the
3923 * normalised values for the year, month, day-of-month, and day-of-year.
3925 * For going backward, we need to bias the value we're using so that we find
3926 * the right year value. (Basically, we don't want the contribution of
3927 * March 1st to the number to apply while deriving the year). Having done
3928 * that, we 'count up' the contribution to the year number by accounting for
3929 * full quadracenturies (400-year periods) with their extra leap days, plus
3930 * the contribution from full centuries (to avoid counting in the lost leap
3931 * days), plus the contribution from full quad-years (to count in the normal
3932 * leap days), plus the leftover contribution from any non-leap years.
3933 * At this point, if we were working with an actual leap day, we'll have 0
3934 * days left over. This is also true for March 1st, however. So, we have
3935 * to special-case that result, and (earlier) keep track of the 'odd'
3936 * century and year contributions. If we got 4 extra centuries in a qcent,
3937 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3938 * Otherwise, we add back in the earlier bias we removed (the 123 from
3939 * figuring in March 1st), find the month index (integer division by 30.6),
3940 * and the remainder is the day-of-month. We then have to convert back to
3941 * 'real' months (including fixing January and February from being 14/15 in
3942 * the previous year to being in the proper year). After that, to get
3943 * tm_yday, we work with the normalised year and get a new yearday value for
3944 * January 1st, which we subtract from the yearday value we had earlier,
3945 * representing the date we've re-built. This is done from January 1
3946 * because tm_yday is 0-origin.
3948 * Since POSIX time routines are only guaranteed to work for times since the
3949 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3950 * applies Gregorian calendar rules even to dates before the 16th century
3951 * doesn't bother me. Besides, you'd need cultural context for a given
3952 * date to know whether it was Julian or Gregorian calendar, and that's
3953 * outside the scope for this routine. Since we convert back based on the
3954 * same rules we used to build the yearday, you'll only get strange results
3955 * for input which needed normalising, or for the 'odd' century years which
3956 * were leap years in the Julian calendar but not in the Gregorian one.
3957 * I can live with that.
3959 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3960 * that's still outside the scope for POSIX time manipulation, so I don't
3966 year = 1900 + ptm->tm_year;
3967 month = ptm->tm_mon;
3968 mday = ptm->tm_mday;
3974 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3975 yearday += month*MONTH_TO_DAYS + mday + jday;
3977 * Note that we don't know when leap-seconds were or will be,
3978 * so we have to trust the user if we get something which looks
3979 * like a sensible leap-second. Wild values for seconds will
3980 * be rationalised, however.
3982 if ((unsigned) ptm->tm_sec <= 60) {
3989 secs += 60 * ptm->tm_min;
3990 secs += SECS_PER_HOUR * ptm->tm_hour;
3992 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3993 /* got negative remainder, but need positive time */
3994 /* back off an extra day to compensate */
3995 yearday += (secs/SECS_PER_DAY)-1;
3996 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3999 yearday += (secs/SECS_PER_DAY);
4000 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
4003 else if (secs >= SECS_PER_DAY) {
4004 yearday += (secs/SECS_PER_DAY);
4005 secs %= SECS_PER_DAY;
4007 ptm->tm_hour = secs/SECS_PER_HOUR;
4008 secs %= SECS_PER_HOUR;
4009 ptm->tm_min = secs/60;
4011 ptm->tm_sec += secs;
4012 /* done with time of day effects */
4014 * The algorithm for yearday has (so far) left it high by 428.
4015 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
4016 * bias it by 123 while trying to figure out what year it
4017 * really represents. Even with this tweak, the reverse
4018 * translation fails for years before A.D. 0001.
4019 * It would still fail for Feb 29, but we catch that one below.
4021 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
4022 yearday -= YEAR_ADJUST;
4023 year = (yearday / DAYS_PER_QCENT) * 400;
4024 yearday %= DAYS_PER_QCENT;
4025 odd_cent = yearday / DAYS_PER_CENT;
4026 year += odd_cent * 100;
4027 yearday %= DAYS_PER_CENT;
4028 year += (yearday / DAYS_PER_QYEAR) * 4;
4029 yearday %= DAYS_PER_QYEAR;
4030 odd_year = yearday / DAYS_PER_YEAR;
4032 yearday %= DAYS_PER_YEAR;
4033 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
4038 yearday += YEAR_ADJUST; /* recover March 1st crock */
4039 month = yearday*DAYS_TO_MONTH;
4040 yearday -= month*MONTH_TO_DAYS;
4041 /* recover other leap-year adjustment */
4050 ptm->tm_year = year - 1900;
4052 ptm->tm_mday = yearday;
4053 ptm->tm_mon = month;
4057 ptm->tm_mon = month - 1;
4059 /* re-build yearday based on Jan 1 to get tm_yday */
4061 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
4062 yearday += 14*MONTH_TO_DAYS + 1;
4063 ptm->tm_yday = jday - yearday;
4064 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
4067 #define SV_CWD_RETURN_UNDEF \
4071 #define SV_CWD_ISDOT(dp) \
4072 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4073 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4076 =for apidoc_section $utility
4078 =for apidoc getcwd_sv
4080 Fill C<sv> with current working directory
4085 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4086 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4087 * getcwd(3) if available
4088 * Comments from the original:
4089 * This is a faster version of getcwd. It's also more dangerous
4090 * because you might chdir out of a directory that you can't chdir
4094 Perl_getcwd_sv(pTHX_ SV *sv)
4099 PERL_ARGS_ASSERT_GETCWD_SV;
4103 char buf[MAXPATHLEN];
4105 /* Some getcwd()s automatically allocate a buffer of the given
4106 * size from the heap if they are given a NULL buffer pointer.
4107 * The problem is that this behaviour is not portable. */
4108 if (getcwd(buf, sizeof(buf) - 1)) {
4113 SV_CWD_RETURN_UNDEF;
4120 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4124 SvUPGRADE(sv, SVt_PV);
4126 if (PerlLIO_lstat(".", &statbuf) < 0) {
4127 SV_CWD_RETURN_UNDEF;
4130 orig_cdev = statbuf.st_dev;
4131 orig_cino = statbuf.st_ino;
4141 if (PerlDir_chdir("..") < 0) {
4142 SV_CWD_RETURN_UNDEF;
4144 if (PerlLIO_stat(".", &statbuf) < 0) {
4145 SV_CWD_RETURN_UNDEF;
4148 cdev = statbuf.st_dev;
4149 cino = statbuf.st_ino;
4151 if (odev == cdev && oino == cino) {
4154 if (!(dir = PerlDir_open("."))) {
4155 SV_CWD_RETURN_UNDEF;
4158 while ((dp = PerlDir_read(dir)) != NULL) {
4160 namelen = dp->d_namlen;
4162 namelen = strlen(dp->d_name);
4165 if (SV_CWD_ISDOT(dp)) {
4169 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4170 SV_CWD_RETURN_UNDEF;
4173 tdev = statbuf.st_dev;
4174 tino = statbuf.st_ino;
4175 if (tino == oino && tdev == odev) {
4181 SV_CWD_RETURN_UNDEF;
4184 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4185 SV_CWD_RETURN_UNDEF;
4188 SvGROW(sv, pathlen + namelen + 1);
4192 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4195 /* prepend current directory to the front */
4197 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4198 pathlen += (namelen + 1);
4200 #ifdef VOID_CLOSEDIR
4203 if (PerlDir_close(dir) < 0) {
4204 SV_CWD_RETURN_UNDEF;
4210 SvCUR_set(sv, pathlen);
4214 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4215 SV_CWD_RETURN_UNDEF;
4218 if (PerlLIO_stat(".", &statbuf) < 0) {
4219 SV_CWD_RETURN_UNDEF;
4222 cdev = statbuf.st_dev;
4223 cino = statbuf.st_ino;
4225 if (cdev != orig_cdev || cino != orig_cino) {
4226 Perl_croak(aTHX_ "Unstable directory path, "
4227 "current directory changed unexpectedly");
4240 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4241 # define EMULATE_SOCKETPAIR_UDP
4244 #ifdef EMULATE_SOCKETPAIR_UDP
4246 S_socketpair_udp (int fd[2]) {
4248 /* Fake a datagram socketpair using UDP to localhost. */
4249 int sockets[2] = {-1, -1};
4250 struct sockaddr_in addresses[2];
4252 Sock_size_t size = sizeof(struct sockaddr_in);
4253 unsigned short port;
4256 memset(&addresses, 0, sizeof(addresses));
4259 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4260 if (sockets[i] == -1)
4261 goto tidy_up_and_fail;
4263 addresses[i].sin_family = AF_INET;
4264 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4265 addresses[i].sin_port = 0; /* kernel chooses port. */
4266 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4267 sizeof(struct sockaddr_in)) == -1)
4268 goto tidy_up_and_fail;
4271 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4272 for each connect the other socket to it. */
4275 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4277 goto tidy_up_and_fail;
4278 if (size != sizeof(struct sockaddr_in))
4279 goto abort_tidy_up_and_fail;
4280 /* !1 is 0, !0 is 1 */
4281 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4282 sizeof(struct sockaddr_in)) == -1)
4283 goto tidy_up_and_fail;
4286 /* Now we have 2 sockets connected to each other. I don't trust some other
4287 process not to have already sent a packet to us (by random) so send
4288 a packet from each to the other. */
4291 /* I'm going to send my own port number. As a short.
4292 (Who knows if someone somewhere has sin_port as a bitfield and needs
4293 this routine. (I'm assuming crays have socketpair)) */
4294 port = addresses[i].sin_port;
4295 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4296 if (got != sizeof(port)) {
4298 goto tidy_up_and_fail;
4299 goto abort_tidy_up_and_fail;
4303 /* Packets sent. I don't trust them to have arrived though.
4304 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4305 connect to localhost will use a second kernel thread. In 2.6 the
4306 first thread running the connect() returns before the second completes,
4307 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4308 returns 0. Poor programs have tripped up. One poor program's authors'
4309 had a 50-1 reverse stock split. Not sure how connected these were.)
4310 So I don't trust someone not to have an unpredictable UDP stack.
4314 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4315 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4319 FD_SET((unsigned int)sockets[0], &rset);
4320 FD_SET((unsigned int)sockets[1], &rset);
4322 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4323 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4324 || !FD_ISSET(sockets[1], &rset)) {
4325 /* I hope this is portable and appropriate. */
4327 goto tidy_up_and_fail;
4328 goto abort_tidy_up_and_fail;
4332 /* And the paranoia department even now doesn't trust it to have arrive
4333 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4335 struct sockaddr_in readfrom;
4336 unsigned short buffer[2];
4341 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4342 sizeof(buffer), MSG_DONTWAIT,
4343 (struct sockaddr *) &readfrom, &size);
4345 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4347 (struct sockaddr *) &readfrom, &size);
4351 goto tidy_up_and_fail;
4352 if (got != sizeof(port)
4353 || size != sizeof(struct sockaddr_in)
4354 /* Check other socket sent us its port. */
4355 || buffer[0] != (unsigned short) addresses[!i].sin_port
4356 /* Check kernel says we got the datagram from that socket */
4357 || readfrom.sin_family != addresses[!i].sin_family
4358 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4359 || readfrom.sin_port != addresses[!i].sin_port)
4360 goto abort_tidy_up_and_fail;
4363 /* My caller (my_socketpair) has validated that this is non-NULL */
4366 /* I hereby declare this connection open. May God bless all who cross
4370 abort_tidy_up_and_fail:
4371 errno = ECONNABORTED;
4375 if (sockets[0] != -1)
4376 PerlLIO_close(sockets[0]);
4377 if (sockets[1] != -1)
4378 PerlLIO_close(sockets[1]);
4383 #endif /* EMULATE_SOCKETPAIR_UDP */
4385 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4388 =for apidoc my_socketpair
4390 Emulates L<socketpair(2)> on systems that don't have it, but which do have
4391 enough functionality for the emulation.
4397 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4398 /* Stevens says that family must be AF_LOCAL, protocol 0.
4399 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4404 struct sockaddr_in listen_addr;
4405 struct sockaddr_in connect_addr;
4410 || family != AF_UNIX
4413 errno = EAFNOSUPPORT;
4422 type &= ~SOCK_CLOEXEC;
4425 #ifdef EMULATE_SOCKETPAIR_UDP
4426 if (type == SOCK_DGRAM)
4427 return S_socketpair_udp(fd);
4430 aTHXa(PERL_GET_THX);
4431 listener = PerlSock_socket(AF_INET, type, 0);
4434 memset(&listen_addr, 0, sizeof(listen_addr));
4435 listen_addr.sin_family = AF_INET;
4436 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4437 listen_addr.sin_port = 0; /* kernel chooses port. */
4438 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4439 sizeof(listen_addr)) == -1)
4440 goto tidy_up_and_fail;
4441 if (PerlSock_listen(listener, 1) == -1)
4442 goto tidy_up_and_fail;
4444 connector = PerlSock_socket(AF_INET, type, 0);
4445 if (connector == -1)
4446 goto tidy_up_and_fail;
4447 /* We want to find out the port number to connect to. */
4448 size = sizeof(connect_addr);
4449 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4451 goto tidy_up_and_fail;
4452 if (size != sizeof(connect_addr))
4453 goto abort_tidy_up_and_fail;
4454 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4455 sizeof(connect_addr)) == -1)
4456 goto tidy_up_and_fail;
4458 size = sizeof(listen_addr);
4459 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4462 goto tidy_up_and_fail;
4463 if (size != sizeof(listen_addr))
4464 goto abort_tidy_up_and_fail;
4465 PerlLIO_close(listener);
4466 /* Now check we are talking to ourself by matching port and host on the
4468 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4470 goto tidy_up_and_fail;
4471 if (size != sizeof(connect_addr)
4472 || listen_addr.sin_family != connect_addr.sin_family
4473 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4474 || listen_addr.sin_port != connect_addr.sin_port) {
4475 goto abort_tidy_up_and_fail;
4481 abort_tidy_up_and_fail:
4483 errno = ECONNABORTED; /* This would be the standard thing to do. */
4484 #elif defined(ECONNREFUSED)
4485 errno = ECONNREFUSED; /* some OSes might not have ECONNABORTED. */
4487 errno = ETIMEDOUT; /* Desperation time. */
4493 PerlLIO_close(listener);
4494 if (connector != -1)
4495 PerlLIO_close(connector);
4497 PerlLIO_close(acceptor);
4503 /* In any case have a stub so that there's code corresponding
4504 * to the my_socketpair in embed.fnc. */
4506 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4507 #ifdef HAS_SOCKETPAIR
4508 return socketpair(family, type, protocol, fd);
4517 =for apidoc sv_nosharing
4519 Dummy routine which "shares" an SV when there is no sharing module present.
4520 Or "locks" it. Or "unlocks" it. In other
4521 words, ignores its single SV argument.
4522 Exists to avoid test for a C<NULL> function pointer and because it could
4523 potentially warn under some level of strict-ness.
4529 Perl_sv_nosharing(pTHX_ SV *sv)
4531 PERL_UNUSED_CONTEXT;
4532 PERL_UNUSED_ARG(sv);
4537 =for apidoc sv_destroyable
4539 Dummy routine which reports that object can be destroyed when there is no
4540 sharing module present. It ignores its single SV argument, and returns
4541 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4542 could potentially warn under some level of strict-ness.
4548 Perl_sv_destroyable(pTHX_ SV *sv)
4550 PERL_UNUSED_CONTEXT;
4551 PERL_UNUSED_ARG(sv);
4556 Perl_parse_unicode_opts(pTHX_ const char **popt)
4558 const char *p = *popt;
4561 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4565 const char* endptr = p + strlen(p);
4567 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4570 if (p && *p && *p != '\n' && *p != '\r') {
4572 goto the_end_of_the_opts_parser;
4574 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4578 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4584 case PERL_UNICODE_STDIN:
4585 opt |= PERL_UNICODE_STDIN_FLAG; break;
4586 case PERL_UNICODE_STDOUT:
4587 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4588 case PERL_UNICODE_STDERR:
4589 opt |= PERL_UNICODE_STDERR_FLAG; break;
4590 case PERL_UNICODE_STD:
4591 opt |= PERL_UNICODE_STD_FLAG; break;
4592 case PERL_UNICODE_IN:
4593 opt |= PERL_UNICODE_IN_FLAG; break;
4594 case PERL_UNICODE_OUT:
4595 opt |= PERL_UNICODE_OUT_FLAG; break;
4596 case PERL_UNICODE_INOUT:
4597 opt |= PERL_UNICODE_INOUT_FLAG; break;
4598 case PERL_UNICODE_LOCALE:
4599 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4600 case PERL_UNICODE_ARGV:
4601 opt |= PERL_UNICODE_ARGV_FLAG; break;
4602 case PERL_UNICODE_UTF8CACHEASSERT:
4603 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4605 if (*p != '\n' && *p != '\r') {
4606 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4609 "Unknown Unicode option letter '%c'", *p);
4616 opt = PERL_UNICODE_DEFAULT_FLAGS;
4618 the_end_of_the_opts_parser:
4620 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4621 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4622 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4630 # include <starlet.h>
4637 * This is really just a quick hack which grabs various garbage
4638 * values. It really should be a real hash algorithm which
4639 * spreads the effect of every input bit onto every output bit,
4640 * if someone who knows about such things would bother to write it.
4641 * Might be a good idea to add that function to CORE as well.
4642 * No numbers below come from careful analysis or anything here,
4643 * except they are primes and SEED_C1 > 1E6 to get a full-width
4644 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4645 * probably be bigger too.
4648 # define SEED_C1 1000003
4649 #define SEED_C4 73819
4651 # define SEED_C1 25747
4652 #define SEED_C4 20639
4656 #define SEED_C5 26107
4658 #ifndef PERL_NO_DEV_RANDOM
4662 #ifdef HAS_GETTIMEOFDAY
4663 struct timeval when;
4668 /* This test is an escape hatch, this symbol isn't set by Configure. */
4669 #ifndef PERL_NO_DEV_RANDOM
4670 #ifndef PERL_RANDOM_DEVICE
4671 /* /dev/random isn't used by default because reads from it will block
4672 * if there isn't enough entropy available. You can compile with
4673 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4674 * is enough real entropy to fill the seed. */
4675 # ifdef __amigaos4__
4676 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4678 # define PERL_RANDOM_DEVICE "/dev/urandom"
4681 fd = PerlLIO_open_cloexec(PERL_RANDOM_DEVICE, 0);
4683 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4691 #ifdef HAS_GETTIMEOFDAY
4692 PerlProc_gettimeofday(&when,NULL);
4693 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4696 u = (U32)SEED_C1 * when;
4698 u += SEED_C3 * (U32)PerlProc_getpid();
4699 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4700 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4701 u += SEED_C5 * (U32)PTR2UV(&when);
4707 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4709 #ifndef NO_PERL_HASH_ENV
4714 PERL_ARGS_ASSERT_GET_HASH_SEED;
4716 Zero(seed_buffer, PERL_HASH_SEED_BYTES, U8);
4717 Zero((U8*)PL_hash_state_w, PERL_HASH_STATE_BYTES, U8);
4719 #ifndef NO_PERL_HASH_ENV
4720 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4725 PerlIO_printf(Perl_debug_log,"Got PERL_HASH_SEED=<%s>\n", env_pv);
4726 /* ignore leading spaces */
4727 while (isSPACE(*env_pv))
4729 # ifdef USE_PERL_PERTURB_KEYS
4730 /* if they set it to "0" we disable key traversal randomization completely */
4731 if (strEQ(env_pv,"0")) {
4732 PL_hash_rand_bits_enabled= 0;
4734 /* otherwise switch to deterministic mode */
4735 PL_hash_rand_bits_enabled= 2;
4738 /* ignore a leading 0x... if it is there */
4739 if (env_pv[0] == '0' && env_pv[1] == 'x')
4742 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4743 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4744 if ( isXDIGIT(*env_pv)) {
4745 seed_buffer[i] |= READ_XDIGIT(env_pv);
4748 while (isSPACE(*env_pv))
4751 if (*env_pv && !isXDIGIT(*env_pv)) {
4752 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4754 /* should we check for unparsed crap? */
4755 /* should we warn about unused hex? */
4756 /* should we warn about insufficient hex? */
4759 #endif /* NO_PERL_HASH_ENV */
4761 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4762 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
4765 #ifdef USE_PERL_PERTURB_KEYS
4766 # ifndef NO_PERL_HASH_ENV
4767 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4770 PerlIO_printf(Perl_debug_log,
4771 "Got PERL_PERTURB_KEYS=<%s>\n", env_pv);
4772 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4773 PL_hash_rand_bits_enabled= 0;
4774 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4775 PL_hash_rand_bits_enabled= 1;
4776 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4777 PL_hash_rand_bits_enabled= 2;
4779 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4783 { /* initialize PL_hash_rand_bits from the hash seed.
4784 * This value is highly volatile, it is updated every
4785 * hash insert, and is used as part of hash bucket chain
4786 * randomization and hash iterator randomization. */
4787 if (PL_hash_rand_bits_enabled == 1) {
4788 /* random mode initialize from seed() like we would our RNG() */
4789 PL_hash_rand_bits= seed();
4792 /* Use a constant */
4793 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4794 /* and then mix in the leading bytes of the hash seed */
4795 for( i = 0; i < sizeof(UV) ; i++ ) {
4796 PL_hash_rand_bits ^= seed_buffer[i % PERL_HASH_SEED_BYTES];
4797 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4800 if (!PL_hash_rand_bits) {
4801 /* we use an XORSHIFT RNG to munge PL_hash_rand_bits,
4802 * which means it cannot be 0 or it will stay 0 for the
4803 * lifetime of the process, so if by some insane chance we
4804 * ended up with a 0 after the above initialization
4805 * then set it to this. This really should not happen, or
4806 * very very very rarely.
4808 PL_hash_rand_bits = 0x8110ba9d; /* a randomly chosen prime */
4815 Perl_debug_hash_seed(pTHX_ bool via_debug_h)
4817 PERL_ARGS_ASSERT_DEBUG_HASH_SEED;
4818 #if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
4820 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
4821 bool via_env = cBOOL(s && strNE(s, "0") && strNE(s,""));
4823 if ( via_env != via_debug_h ) {
4824 const unsigned char *seed= PERL_HASH_SEED;
4825 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
4826 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
4827 while (seed < seed_end) {
4828 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
4830 #ifdef PERL_HASH_RANDOMIZE_KEYS
4831 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
4832 PL_HASH_RAND_BITS_ENABLED,
4833 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" :
4834 PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM"
4837 PerlIO_printf(Perl_debug_log,
4838 " RAND_BITS=0x%" UVxf, PL_hash_rand_bits);
4840 PerlIO_printf(Perl_debug_log, "\n");
4843 #endif /* #if (defined(USE_HASH_SEED) ... */
4851 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4852 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4853 * given, and you supply your own implementation.
4855 * The default implementation reads a single env var, PERL_MEM_LOG,
4856 * expecting one or more of the following:
4858 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4859 * 'm' - memlog was PERL_MEM_LOG=1
4860 * 's' - svlog was PERL_SV_LOG=1
4861 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4863 * This makes the logger controllable enough that it can reasonably be
4864 * added to the system perl.
4867 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4868 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4870 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 256
4872 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4873 * writes to. In the default logger, this is settable at runtime.
4875 #ifndef PERL_MEM_LOG_FD
4876 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4879 #ifndef PERL_MEM_LOG_NOIMPL
4881 # ifdef DEBUG_LEAKING_SCALARS
4882 # define SV_LOG_SERIAL_FMT " [%lu]"
4883 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4885 # define SV_LOG_SERIAL_FMT
4886 # define _SV_LOG_SERIAL_ARG(sv)
4890 S_mem_log_common(enum mem_log_type mlt, const UV n,
4891 const UV typesize, const char *type_name, const SV *sv,
4892 Malloc_t oldalloc, Malloc_t newalloc,
4893 const char *filename, const int linenumber,
4894 const char *funcname)
4899 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4901 PL_mem_log[0] |= 0x2; /* Flag that the call is from this code */
4902 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4903 PL_mem_log[0] &= ~0x2;
4906 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4908 /* We can't use SVs or PerlIO for obvious reasons,
4909 * so we'll use stdio and low-level IO instead. */
4910 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4912 # ifdef HAS_GETTIMEOFDAY
4913 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4914 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4916 PerlProc_gettimeofday(&tv, 0);
4918 # define MEM_LOG_TIME_FMT "%10d: "
4919 # define MEM_LOG_TIME_ARG (int)when
4923 /* If there are other OS specific ways of hires time than
4924 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4925 * probably that they would be used to fill in the struct
4929 const char* endptr = pmlenv + strlen(pmlenv);
4932 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4933 && uv && uv <= PERL_INT_MAX
4937 fd = PERL_MEM_LOG_FD;
4940 if (strchr(pmlenv, 't')) {
4941 len = my_snprintf(buf, sizeof(buf),
4942 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4943 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4947 len = my_snprintf(buf, sizeof(buf),
4948 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4949 " %s = %" IVdf ": %" UVxf "\n",
4950 filename, linenumber, funcname, n, typesize,
4951 type_name, n * typesize, PTR2UV(newalloc));
4954 len = my_snprintf(buf, sizeof(buf),
4955 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4956 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4957 filename, linenumber, funcname, n, typesize,
4958 type_name, n * typesize, PTR2UV(oldalloc),
4962 len = my_snprintf(buf, sizeof(buf),
4963 "free: %s:%d:%s: %" UVxf "\n",
4964 filename, linenumber, funcname,
4969 len = my_snprintf(buf, sizeof(buf),
4970 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
4971 mlt == MLT_NEW_SV ? "new" : "del",
4972 filename, linenumber, funcname,
4973 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4978 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4979 #ifdef USE_C_BACKTRACE
4980 if(strchr(pmlenv,'c') && (mlt == MLT_NEW_SV)) {
4981 len = my_snprintf(buf, sizeof(buf),
4982 " caller %s at %s line %" LINE_Tf "\n",
4983 /* CopSTASHPV can crash early on startup; use CopFILE to check */
4984 CopFILE(PL_curcop) ? CopSTASHPV(PL_curcop) : "<unknown>",
4985 CopFILE(PL_curcop), CopLINE(PL_curcop));
4986 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4988 Perl_c_backtrace *bt = Perl_get_c_backtrace(aTHX_ 3, 3);
4989 Perl_c_backtrace_frame *frame;
4991 for (i = 0, frame = bt->frame_info;
4992 i < bt->header.frame_count;
4994 len = my_snprintf(buf, sizeof(buf),
4995 " frame[%" UVuf "]: %p %s at %s +0x%lx\n",
4998 frame->symbol_name_size && frame->symbol_name_offset ? (char *)bt + frame->symbol_name_offset : "-",
4999 frame->object_name_size && frame->object_name_offset ? (char *)bt + frame->object_name_offset : "?",
5000 (char *)frame->addr - (char *)frame->object_base_addr);
5001 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
5003 Perl_free_c_backtrace(bt);
5005 #endif /* USE_C_BACKTRACE */
5009 #endif /* !PERL_MEM_LOG_NOIMPL */
5011 #ifndef PERL_MEM_LOG_NOIMPL
5013 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
5014 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
5016 /* this is suboptimal, but bug compatible. User is providing their
5017 own implementation, but is getting these functions anyway, and they
5018 do nothing. But _NOIMPL users should be able to cope or fix */
5020 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
5021 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
5025 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
5027 const char *filename, const int linenumber,
5028 const char *funcname)
5030 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
5032 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
5033 NULL, NULL, newalloc,
5034 filename, linenumber, funcname);
5039 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
5040 Malloc_t oldalloc, Malloc_t newalloc,
5041 const char *filename, const int linenumber,
5042 const char *funcname)
5044 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
5046 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
5047 NULL, oldalloc, newalloc,
5048 filename, linenumber, funcname);
5053 Perl_mem_log_free(Malloc_t oldalloc,
5054 const char *filename, const int linenumber,
5055 const char *funcname)
5057 PERL_ARGS_ASSERT_MEM_LOG_FREE;
5059 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
5060 filename, linenumber, funcname);
5065 Perl_mem_log_new_sv(const SV *sv,
5066 const char *filename, const int linenumber,
5067 const char *funcname)
5069 PERL_ARGS_ASSERT_MEM_LOG_NEW_SV;
5071 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
5072 filename, linenumber, funcname);
5076 Perl_mem_log_del_sv(const SV *sv,
5077 const char *filename, const int linenumber,
5078 const char *funcname)
5080 PERL_ARGS_ASSERT_MEM_LOG_DEL_SV;
5082 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
5083 filename, linenumber, funcname);
5086 #endif /* PERL_MEM_LOG */
5089 =for apidoc_section $string
5090 =for apidoc quadmath_format_valid
5092 C<quadmath_snprintf()> is very strict about its C<format> string and will
5093 fail, returning -1, if the format is invalid. It accepts exactly
5096 C<quadmath_format_valid()> checks that the intended single spec looks
5097 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
5098 and has C<Q> before it. This is not a full "printf syntax check",
5101 Returns true if it is valid, false if not.
5103 See also L</quadmath_format_needed>.
5109 Perl_quadmath_format_valid(const char* format)
5113 PERL_ARGS_ASSERT_QUADMATH_FORMAT_VALID;
5115 if (format[0] != '%' || strchr(format + 1, '%'))
5117 len = strlen(format);
5118 /* minimum length three: %Qg */
5119 if (len < 3 || memCHRs("efgaEFGA", format[len - 1]) == NULL)
5121 if (format[len - 2] != 'Q')
5128 =for apidoc quadmath_format_needed
5130 C<quadmath_format_needed()> returns true if the C<format> string seems to
5131 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
5132 or returns false otherwise.
5134 The format specifier detection is not complete printf-syntax detection,
5135 but it should catch most common cases.
5137 If true is returned, those arguments B<should> in theory be processed
5138 with C<quadmath_snprintf()>, but in case there is more than one such
5139 format specifier (see L</quadmath_format_valid>), and if there is
5140 anything else beyond that one (even just a single byte), they
5141 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
5142 accepting only one format spec, and nothing else.
5143 In this case, the code should probably fail.
5149 Perl_quadmath_format_needed(const char* format)
5151 const char *p = format;
5154 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5156 while ((q = strchr(p, '%'))) {
5158 if (*q == '+') /* plus */
5160 if (*q == '#') /* alt */
5162 if (*q == '*') /* width */
5166 while (isDIGIT(*q)) q++;
5169 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5174 while (isDIGIT(*q)) q++;
5176 if (memCHRs("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5185 =for apidoc my_snprintf
5187 The C library C<snprintf> functionality, if available and
5188 standards-compliant (uses C<vsnprintf>, actually). However, if the
5189 C<vsnprintf> is not available, will unfortunately use the unsafe
5190 C<vsprintf> which can overrun the buffer (there is an overrun check,
5191 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5192 getting C<vsnprintf>.
5197 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5201 PERL_ARGS_ASSERT_MY_SNPRINTF;
5202 #ifndef HAS_VSNPRINTF
5203 PERL_UNUSED_VAR(len);
5205 va_start(ap, format);
5208 bool quadmath_valid = FALSE;
5209 if (quadmath_format_valid(format)) {
5210 /* If the format looked promising, use it as quadmath. */
5211 retval = quadmath_snprintf(buffer, len, format, va_arg(ap, NV));
5213 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5215 quadmath_valid = TRUE;
5217 /* quadmath_format_single() will return false for example for
5218 * "foo = %g", or simply "%g". We could handle the %g by
5219 * using quadmath for the NV args. More complex cases of
5220 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5221 * quadmath-valid but has stuff in front).
5223 * Handling the "Q-less" cases right would require walking
5224 * through the va_list and rewriting the format, calling
5225 * quadmath for the NVs, building a new va_list, and then
5226 * letting vsnprintf/vsprintf to take care of the other
5227 * arguments. This may be doable.
5229 * We do not attempt that now. But for paranoia, we here try
5230 * to detect some common (but not all) cases where the
5231 * "Q-less" %[efgaEFGA] formats are present, and die if
5232 * detected. This doesn't fix the problem, but it stops the
5233 * vsnprintf/vsprintf pulling doubles off the va_list when
5234 * __float128 NVs should be pulled off instead.
5236 * If quadmath_format_needed() returns false, we are reasonably
5237 * certain that we can call vnsprintf() or vsprintf() safely. */
5238 if (!quadmath_valid && quadmath_format_needed(format))
5239 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5244 #ifdef HAS_VSNPRINTF
5245 retval = vsnprintf(buffer, len, format, ap);
5247 retval = vsprintf(buffer, format, ap);
5250 /* vsprintf() shows failure with < 0 */
5252 #ifdef HAS_VSNPRINTF
5253 /* vsnprintf() shows failure with >= len */
5255 (len > 0 && (Size_t)retval >= len)
5258 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5263 =for apidoc my_vsnprintf
5265 The C library C<vsnprintf> if available and standards-compliant.
5266 However, if the C<vsnprintf> is not available, will unfortunately
5267 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5268 overrun check, but that may be too late). Consider using
5269 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5274 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5277 PERL_UNUSED_ARG(buffer);
5278 PERL_UNUSED_ARG(len);
5279 PERL_UNUSED_ARG(format);
5280 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5281 PERL_UNUSED_ARG((void*)ap);
5282 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5289 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5290 Perl_va_copy(ap, apc);
5291 # ifdef HAS_VSNPRINTF
5292 retval = vsnprintf(buffer, len, format, apc);
5294 PERL_UNUSED_ARG(len);
5295 retval = vsprintf(buffer, format, apc);
5299 # ifdef HAS_VSNPRINTF
5300 retval = vsnprintf(buffer, len, format, ap);
5302 PERL_UNUSED_ARG(len);
5303 retval = vsprintf(buffer, format, ap);
5305 #endif /* #ifdef NEED_VA_COPY */
5306 /* vsprintf() shows failure with < 0 */
5308 #ifdef HAS_VSNPRINTF
5309 /* vsnprintf() shows failure with >= len */
5311 (len > 0 && (Size_t)retval >= len)
5314 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5320 Perl_my_clearenv(pTHX)
5322 #if ! defined(PERL_MICRO)
5323 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5325 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5326 # if defined(USE_ENVIRON_ARRAY)
5327 # if defined(USE_ITHREADS)
5328 /* only the parent thread can clobber the process environment, so no need
5330 if (PL_curinterp != aTHX)
5332 # endif /* USE_ITHREADS */
5333 # if defined(HAS_CLEARENV)
5335 # elif defined(HAS_UNSETENV)
5336 int bsiz = 80; /* Most envvar names will be shorter than this. */
5337 char *buf = (char*)safesysmalloc(bsiz);
5338 while (*environ != NULL) {
5339 char *e = strchr(*environ, '=');
5340 int l = e ? e - *environ : (int)strlen(*environ);
5343 bsiz = l + 1; /* + 1 for the \0. */
5344 buf = (char*)safesysmalloc(bsiz);
5346 memcpy(buf, *environ, l);
5351 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5352 /* Just null environ and accept the leakage. */
5354 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5355 # endif /* USE_ENVIRON_ARRAY */
5356 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5357 #endif /* PERL_MICRO */
5363 =for apidoc my_cxt_init
5365 Implements the L<perlxs/C<MY_CXT_INIT>> macro, which you should use instead.
5367 The first time a module is loaded, the global C<PL_my_cxt_index> is incremented,
5368 and that value is assigned to that module's static C<my_cxt_index> (whose
5369 address is passed as an arg). Then, for each interpreter this function is
5370 called for, it makes sure a C<void*> slot is available to hang the static data
5371 off, by allocating or extending the interpreter's C<PL_my_cxt_list> array
5377 Perl_my_cxt_init(pTHX_ int *indexp, size_t size)
5382 PERL_ARGS_ASSERT_MY_CXT_INIT;
5385 /* do initial check without locking.
5386 * -1: not allocated or another thread currently allocating
5387 * other: already allocated by another thread
5390 MUTEX_LOCK(&PL_my_ctx_mutex);
5391 /*now a stricter check with locking */
5394 /* this module hasn't been allocated an index yet */
5395 *indexp = PL_my_cxt_index++;
5397 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5400 /* make sure the array is big enough */
5401 if (PL_my_cxt_size <= index) {
5402 if (PL_my_cxt_size) {
5403 IV new_size = PL_my_cxt_size;
5404 while (new_size <= index)
5406 Renew(PL_my_cxt_list, new_size, void *);
5407 PL_my_cxt_size = new_size;
5410 PL_my_cxt_size = 16;
5411 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5414 /* newSV() allocates one more than needed */
5415 p = (void*)SvPVX(newSV(size-1));
5416 PL_my_cxt_list[index] = p;
5417 Zero(p, size, char);
5421 #endif /* MULTIPLICITY */
5424 /* Perl_xs_handshake():
5425 implement the various XS_*_BOOTCHECK macros, which are added to .c
5426 files by ExtUtils::ParseXS, to check that the perl the module was built
5427 with is binary compatible with the running perl.
5430 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5431 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5433 The meaning of the varargs is determined the U32 key arg (which is not
5434 a format string). The fields of key are assembled by using HS_KEY().
5436 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5437 "PerlInterpreter *" and represents the callers context; otherwise it is
5438 of type "CV *", and is the boot xsub's CV.
5440 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5441 for example, and IO.dll was linked with threaded perl524.dll, and both
5442 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5443 successfully can load IO.dll into the process but simultaneously it
5444 loaded an interpreter of a different version into the process, and XS
5445 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5446 use through perl526.dll's my_perl->Istack_base.
5448 v_my_perl cannot be the first arg, since then 'key' will be out of
5449 place in a threaded vs non-threaded mixup; and analyzing the key
5450 number's bitfields won't reveal the problem, since it will be a valid
5451 key (unthreaded perl) on interp side, but croak will report the XS mod's
5452 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5453 it's a threaded perl and an unthreaded XS module, threaded perl will
5454 look at an uninit C stack or an uninit register to get 'key'
5455 (remember that it assumes that the 1st arg is the interp cxt).
5457 'file' is the source filename of the caller.
5461 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5467 const char *stage = "first";
5475 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5476 va_start(args, file);
5478 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5479 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5480 if (UNLIKELY(got != need))
5482 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5483 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5484 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5485 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5486 passed to the XS DLL */
5488 xs_interp = (tTHX)v_my_perl;
5492 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5493 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5494 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5495 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5496 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5497 location in the unthreaded perl binary) stored in CV * to figure out if this
5498 Perl_xs_handshake was called by the same pp_entersub */
5499 cv = (CV*)v_my_perl;
5500 xs_spp = (SV***)CvHSCXT(cv);
5502 need = &PL_stack_sp;
5505 if(UNLIKELY(got != need)) {
5506 bad_handshake:/* recycle branch and string from above */
5507 if(got != (void *)HSf_NOCHK)
5508 noperl_die("%s: loadable library and perl binaries are mismatched"
5509 " (got %s handshake key %p, needed %p)\n",
5510 file, stage, got, need);
5513 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5514 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5515 PL_xsubfilename = file; /* so the old name must be restored for
5516 additional XSUBs to register themselves */
5517 /* XSUBs can't be perl lang/perl5db.pl debugged
5518 if (PERLDB_LINE_OR_SAVESRC)
5519 (void)gv_fetchfile(file); */
5522 if(key & HSf_POPMARK) {
5524 { SV **mark = PL_stack_base + ax++;
5526 items = (I32)(SP - MARK);
5530 items = va_arg(args, U32);
5531 ax = va_arg(args, U32);
5535 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5536 if((apiverlen = HS_GETAPIVERLEN(key))) {
5537 char * api_p = va_arg(args, char*);
5538 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5539 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5540 sizeof("v" PERL_API_VERSION_STRING)-1))
5541 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5542 api_p, SVfARG(PL_stack_base[ax + 0]),
5543 "v" PERL_API_VERSION_STRING);
5548 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5549 if((xsverlen = HS_GETXSVERLEN(key)))
5550 S_xs_version_bootcheck(aTHX_
5551 items, ax, va_arg(args, char*), xsverlen);
5559 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5563 const char *vn = NULL;
5564 SV *const module = PL_stack_base[ax];
5566 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5568 if (items >= 2) /* version supplied as bootstrap arg */
5569 sv = PL_stack_base[ax + 1];
5571 /* XXX GV_ADDWARN */
5573 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5574 if (!sv || !SvOK(sv)) {
5576 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5580 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5581 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5582 ? sv : sv_2mortal(new_version(sv));
5583 xssv = upg_version(xssv, 0);
5584 if ( vcmp(pmsv,xssv) ) {
5585 SV *string = vstringify(xssv);
5586 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5587 " does not match ", SVfARG(module), SVfARG(string));
5589 SvREFCNT_dec(string);
5590 string = vstringify(pmsv);
5593 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5596 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5598 SvREFCNT_dec(string);
5600 Perl_sv_2mortal(aTHX_ xpt);
5601 Perl_croak_sv(aTHX_ xpt);
5606 PERL_STATIC_INLINE bool
5607 S_gv_has_usable_name(pTHX_ GV *gv)
5611 && HvHasENAME(GvSTASH(gv))
5612 && (gvp = (GV **)hv_fetchhek(
5613 GvSTASH(gv), GvNAME_HEK(gv), 0
5619 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5621 SV * const dbsv = GvSVn(PL_DBsub);
5622 const bool save_taint = TAINT_get;
5624 /* When we are called from pp_goto (svp is null),
5625 * we do not care about using dbsv to call CV;
5626 * it's for informational purposes only.
5629 PERL_ARGS_ASSERT_GET_DB_SUB;
5633 if (!PERLDB_SUB_NN) {
5636 if (!svp && !CvLEXICAL(cv)) {
5637 gv_efullname3(dbsv, gv, NULL);
5639 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5640 || strEQ(GvNAME(gv), "END")
5641 || ( /* Could be imported, and old sub redefined. */
5642 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5644 !( (SvTYPE(*svp) == SVt_PVGV)
5645 && (GvCV((const GV *)*svp) == cv)
5646 /* Use GV from the stack as a fallback. */
5647 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5651 /* GV is potentially non-unique, or contain different CV. */
5652 SV * const tmp = newRV(MUTABLE_SV(cv));
5653 sv_setsv(dbsv, tmp);
5657 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5658 sv_catpvs(dbsv, "::");
5659 sv_cathek(dbsv, GvNAME_HEK(gv));
5663 const int type = SvTYPE(dbsv);
5664 if (type < SVt_PVIV && type != SVt_IV)
5665 sv_upgrade(dbsv, SVt_PVIV);
5666 (void)SvIOK_on(dbsv);
5667 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5670 TAINT_IF(save_taint);
5671 #ifdef NO_TAINT_SUPPORT
5672 PERL_UNUSED_VAR(save_taint);
5677 =for apidoc_section $io
5678 =for apidoc my_dirfd
5680 The C library C<L<dirfd(3)>> if available, or a Perl implementation of it, or die
5681 if not easily emulatable.
5687 Perl_my_dirfd(DIR * dir) {
5689 /* Most dirfd implementations have problems when passed NULL. */
5694 #elif defined(HAS_DIR_DD_FD)
5697 Perl_croak_nocontext(PL_no_func, "dirfd");
5698 NOT_REACHED; /* NOTREACHED */
5703 #if !defined(HAS_MKOSTEMP) || !defined(HAS_MKSTEMP)
5705 #define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
5706 #define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
5709 S_my_mkostemp(char *templte, int flags) {
5711 STRLEN len = strlen(templte);
5715 int delete_on_close = flags & O_VMS_DELETEONCLOSE;
5717 flags &= ~O_VMS_DELETEONCLOSE;
5721 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
5722 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
5723 SETERRNO(EINVAL, LIB_INVARG);
5729 for (i = 1; i <= 6; ++i) {
5730 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
5733 if (delete_on_close) {
5734 fd = open(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600, "fop=dlt");
5739 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600);
5741 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
5748 #ifndef HAS_MKOSTEMP
5751 =for apidoc my_mkostemp
5753 The C library C<L<mkostemp(3)>> if available, or a Perl implementation of it.
5759 Perl_my_mkostemp(char *templte, int flags)
5761 PERL_ARGS_ASSERT_MY_MKOSTEMP;
5762 return S_my_mkostemp(templte, flags);
5769 =for apidoc my_mkstemp
5771 The C library C<L<mkstemp(3)>> if available, or a Perl implementation of it.
5777 Perl_my_mkstemp(char *templte)
5779 PERL_ARGS_ASSERT_MY_MKSTEMP;
5780 return S_my_mkostemp(templte, 0);
5785 Perl_get_re_arg(pTHX_ SV *sv) {
5791 sv = MUTABLE_SV(SvRV(sv));
5792 if (SvTYPE(sv) == SVt_REGEXP)
5793 return (REGEXP*) sv;
5800 * This code is derived from drand48() implementation from FreeBSD,
5801 * found in lib/libc/gen/_rand48.c.
5803 * The U64 implementation is original, based on the POSIX
5804 * specification for drand48().
5808 * Copyright (c) 1993 Martin Birgmeier
5809 * All rights reserved.
5811 * You may redistribute unmodified or modified versions of this source
5812 * code provided that the above copyright notice and this and the
5813 * following conditions are retained.
5815 * This software is provided ``as is'', and comes with no warranties
5816 * of any kind. I shall in no event be liable for anything that happens
5817 * to anyone/anything when using this software.
5820 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5822 #ifdef PERL_DRAND48_QUAD
5824 #define DRAND48_MULT UINT64_C(0x5deece66d)
5825 #define DRAND48_ADD 0xb
5826 #define DRAND48_MASK UINT64_C(0xffffffffffff)
5830 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5831 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5832 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5833 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5834 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5835 #define FREEBSD_DRAND48_ADD (0x000b)
5837 const unsigned short _rand48_mult[3] = {
5838 FREEBSD_DRAND48_MULT_0,
5839 FREEBSD_DRAND48_MULT_1,
5840 FREEBSD_DRAND48_MULT_2
5842 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5847 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5849 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5851 #ifdef PERL_DRAND48_QUAD
5852 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5854 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5855 random_state->seed[1] = (U16) seed;
5856 random_state->seed[2] = (U16) (seed >> 16);
5861 Perl_drand48_r(perl_drand48_t *random_state)
5863 PERL_ARGS_ASSERT_DRAND48_R;
5865 #ifdef PERL_DRAND48_QUAD
5866 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5869 return ldexp((double)*random_state, -48);
5875 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5876 + (U32) _rand48_add;
5877 temp[0] = (U16) accu; /* lower 16 bits */
5878 accu >>= sizeof(U16) * 8;
5879 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5880 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5881 temp[1] = (U16) accu; /* middle 16 bits */
5882 accu >>= sizeof(U16) * 8;
5883 accu += _rand48_mult[0] * random_state->seed[2]
5884 + _rand48_mult[1] * random_state->seed[1]
5885 + _rand48_mult[2] * random_state->seed[0];
5886 random_state->seed[0] = temp[0];
5887 random_state->seed[1] = temp[1];
5888 random_state->seed[2] = (U16) accu;
5890 return ldexp((double) random_state->seed[0], -48) +
5891 ldexp((double) random_state->seed[1], -32) +
5892 ldexp((double) random_state->seed[2], -16);
5897 #ifdef USE_C_BACKTRACE
5899 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5904 /* abfd is the BFD handle. */
5906 /* bfd_syms is the BFD symbol table. */
5908 /* bfd_text is handle to the the ".text" section of the object file. */
5910 /* Since opening the executable and scanning its symbols is quite
5911 * heavy operation, we remember the filename we used the last time,
5912 * and do the opening and scanning only if the filename changes.
5913 * This removes most (but not all) open+scan cycles. */
5914 const char* fname_prev;
5917 /* Given a dl_info, update the BFD context if necessary. */
5918 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5920 /* BFD open and scan only if the filename changed. */
5921 if (ctx->fname_prev == NULL ||
5922 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5924 bfd_close(ctx->abfd);
5926 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5928 if (bfd_check_format(ctx->abfd, bfd_object)) {
5929 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5930 if (symbol_size > 0) {
5931 Safefree(ctx->bfd_syms);
5932 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5934 bfd_get_section_by_name(ctx->abfd, ".text");
5942 ctx->fname_prev = dl_info->dli_fname;
5946 /* Given a raw frame, try to symbolize it and store
5947 * symbol information (source file, line number) away. */
5948 static void bfd_symbolize(bfd_context* ctx,
5951 STRLEN* symbol_name_size,
5953 STRLEN* source_name_size,
5954 STRLEN* source_line)
5956 *symbol_name = NULL;
5957 *symbol_name_size = 0;
5959 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5961 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5964 unsigned int line = 0;
5965 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5966 ctx->bfd_syms, offset,
5967 &file, &func, &line) &&
5968 file && func && line > 0) {
5969 /* Size and copy the source file, use only
5970 * the basename of the source file.
5972 * NOTE: the basenames are fine for the
5973 * Perl source files, but may not always
5974 * be the best idea for XS files. */
5975 const char *p, *b = NULL;
5976 /* Look for the last slash. */
5977 for (p = file; *p; p++) {
5981 if (b == NULL || *b == 0) {
5984 *source_name_size = p - b + 1;
5985 Newx(*source_name, *source_name_size + 1, char);
5986 Copy(b, *source_name, *source_name_size + 1, char);
5988 *symbol_name_size = strlen(func);
5989 Newx(*symbol_name, *symbol_name_size + 1, char);
5990 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5992 *source_line = line;
5998 #endif /* #ifdef USE_BFD */
6002 /* OS X has no public API for for 'symbolicating' (Apple official term)
6003 * stack addresses to {function_name, source_file, line_number}.
6004 * Good news: there is command line utility atos(1) which does that.
6005 * Bad news 1: it's a command line utility.
6006 * Bad news 2: one needs to have the Developer Tools installed.
6007 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
6009 * To recap: we need to open a pipe for reading for a utility which
6010 * might not exist, or exists in different locations, and then parse
6011 * the output. And since this is all for a low-level API, we cannot
6012 * use high-level stuff. Thanks, Apple. */
6015 /* tool is set to the absolute pathname of the tool to use:
6018 /* format is set to a printf format string used for building
6019 * the external command to run. */
6021 /* unavail is set if e.g. xcrun cannot be found, or something
6022 * else happens that makes getting the backtrace dubious. Note,
6023 * however, that the context isn't persistent, the next call to
6024 * get_c_backtrace() will start from scratch. */
6026 /* fname is the current object file name. */
6028 /* object_base_addr is the base address of the shared object. */
6029 void* object_base_addr;
6032 /* Given |dl_info|, updates the context. If the context has been
6033 * marked unavailable, return immediately. If not but the tool has
6034 * not been set, set it to either "xcrun atos" or "atos" (also set the
6035 * format to use for creating commands for piping), or if neither is
6036 * unavailable (one needs the Developer Tools installed), mark the context
6037 * an unavailable. Finally, update the filename (object name),
6038 * and its base address. */
6040 static void atos_update(atos_context* ctx,
6045 if (ctx->tool == NULL) {
6046 const char* tools[] = {
6050 const char* formats[] = {
6051 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6052 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6056 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6057 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6058 ctx->tool = tools[i];
6059 ctx->format = formats[i];
6063 if (ctx->tool == NULL) {
6064 ctx->unavail = TRUE;
6068 if (ctx->fname == NULL ||
6069 strNE(dl_info->dli_fname, ctx->fname)) {
6070 ctx->fname = dl_info->dli_fname;
6071 ctx->object_base_addr = dl_info->dli_fbase;
6075 /* Given an output buffer end |p| and its |start|, matches
6076 * for the atos output, extracting the source code location
6077 * and returning non-NULL if possible, returning NULL otherwise. */
6078 static const char* atos_parse(const char* p,
6080 STRLEN* source_name_size,
6081 STRLEN* source_line) {
6082 /* atos() output is something like:
6083 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6084 * We cannot use Perl regular expressions, because we need to
6085 * stay low-level. Therefore here we have a rolled-out version
6086 * of a state machine which matches _backwards_from_the_end_ and
6087 * if there's a success, returns the starts of the filename,
6088 * also setting the filename size and the source line number.
6089 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6090 const char* source_number_start;
6091 const char* source_name_end;
6092 const char* source_line_end = start;
6093 const char* close_paren;
6096 /* Skip trailing whitespace. */
6097 while (p > start && isSPACE(*p)) p--;
6098 /* Now we should be at the close paren. */
6099 if (p == start || *p != ')')
6103 /* Now we should be in the line number. */
6104 if (p == start || !isDIGIT(*p))
6106 /* Skip over the digits. */
6107 while (p > start && isDIGIT(*p))
6109 /* Now we should be at the colon. */
6110 if (p == start || *p != ':')
6112 source_number_start = p + 1;
6113 source_name_end = p; /* Just beyond the end. */
6115 /* Look for the open paren. */
6116 while (p > start && *p != '(')
6121 *source_name_size = source_name_end - p;
6122 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6123 && source_line_end == close_paren
6124 && uv <= PERL_INT_MAX
6126 *source_line = (STRLEN)uv;
6132 /* Given a raw frame, read a pipe from the symbolicator (that's the
6133 * technical term) atos, reads the result, and parses the source code
6134 * location. We must stay low-level, so we use snprintf(), pipe(),
6135 * and fread(), and then also parse the output ourselves. */
6136 static void atos_symbolize(atos_context* ctx,
6139 STRLEN* source_name_size,
6140 STRLEN* source_line)
6148 /* Simple security measure: if there's any funny business with
6149 * the object name (used as "-o '%s'" ), leave since at least
6150 * partially the user controls it. */
6151 for (p = ctx->fname; *p; p++) {
6152 if (*p == '\'' || isCNTRL(*p)) {
6153 ctx->unavail = TRUE;
6157 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6158 ctx->fname, ctx->object_base_addr, raw_frame);
6159 if (cnt < sizeof(cmd)) {
6160 /* Undo nostdio.h #defines that disable stdio.
6161 * This is somewhat naughty, but is used elsewhere
6162 * in the core, and affects only OS X. */
6167 FILE* fp = popen(cmd, "r");
6168 /* At the moment we open a new pipe for each stack frame.
6169 * This is naturally somewhat slow, but hopefully generating
6170 * stack traces is never going to in a performance critical path.
6172 * We could play tricks with atos by batching the stack
6173 * addresses to be resolved: atos can either take multiple
6174 * addresses from the command line, or read addresses from
6175 * a file (though the mess of creating temporary files would
6176 * probably negate much of any possible speedup).
6178 * Normally there are only two objects present in the backtrace:
6179 * perl itself, and the libdyld.dylib. (Note that the object
6180 * filenames contain the full pathname, so perl may not always
6181 * be in the same place.) Whenever the object in the
6182 * backtrace changes, the base address also changes.
6184 * The problem with batching the addresses, though, would be
6185 * matching the results with the addresses: the parsing of
6186 * the results is already painful enough with a single address. */
6189 UV cnt = fread(out, 1, sizeof(out), fp);
6190 if (cnt < sizeof(out)) {
6191 const char* p = atos_parse(out + cnt - 1, out,
6196 *source_name_size, char);
6197 Copy(p, *source_name,
6198 *source_name_size, char);
6206 #endif /* #ifdef PERL_DARWIN */
6209 =for apidoc_section $debugging
6210 =for apidoc get_c_backtrace
6212 Collects the backtrace (aka "stacktrace") into a single linear
6213 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6215 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6216 returning at most C<depth> frames.
6222 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6224 /* Note that here we must stay as low-level as possible: Newx(),
6225 * Copy(), Safefree(); since we may be called from anywhere,
6226 * so we should avoid higher level constructs like SVs or AVs.
6228 * Since we are using safesysmalloc() via Newx(), don't try
6229 * getting backtrace() there, unless you like deep recursion. */
6231 /* Currently only implemented with backtrace() and dladdr(),
6232 * for other platforms NULL is returned. */
6234 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6235 /* backtrace() is available via <execinfo.h> in glibc and in most
6236 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6238 /* We try fetching this many frames total, but then discard
6239 * the |skip| first ones. For the remaining ones we will try
6240 * retrieving more information with dladdr(). */
6241 int try_depth = skip + depth;
6243 /* The addresses (program counters) returned by backtrace(). */
6246 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6249 /* Sizes _including_ the terminating \0 of the object name
6250 * and symbol name strings. */
6251 STRLEN* object_name_sizes;
6252 STRLEN* symbol_name_sizes;
6255 /* The symbol names comes either from dli_sname,
6256 * or if using BFD, they can come from BFD. */
6257 char** symbol_names;
6260 /* The source code location information. Dug out with e.g. BFD. */
6261 char** source_names;
6262 STRLEN* source_name_sizes;
6263 STRLEN* source_lines;
6265 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6266 int got_depth; /* How many frames were returned from backtrace(). */
6267 UV frame_count = 0; /* How many frames we return. */
6268 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6271 bfd_context bfd_ctx;
6274 atos_context atos_ctx;
6277 /* Here are probably possibilities for optimizing. We could for
6278 * example have a struct that contains most of these and then
6279 * allocate |try_depth| of them, saving a bunch of malloc calls.
6280 * Note, however, that |frames| could not be part of that struct
6281 * because backtrace() will want an array of just them. Also be
6282 * careful about the name strings. */
6283 Newx(raw_frames, try_depth, void*);
6284 Newx(dl_infos, try_depth, Dl_info);
6285 Newx(object_name_sizes, try_depth, STRLEN);
6286 Newx(symbol_name_sizes, try_depth, STRLEN);
6287 Newx(source_names, try_depth, char*);
6288 Newx(source_name_sizes, try_depth, STRLEN);
6289 Newx(source_lines, try_depth, STRLEN);
6291 Newx(symbol_names, try_depth, char*);
6294 /* Get the raw frames. */
6295 got_depth = (int)backtrace(raw_frames, try_depth);
6297 /* We use dladdr() instead of backtrace_symbols() because we want
6298 * the full details instead of opaque strings. This is useful for
6299 * two reasons: () the details are needed for further symbolic
6300 * digging, for example in OS X (2) by having the details we fully
6301 * control the output, which in turn is useful when more platforms
6302 * are added: we can keep out output "portable". */
6304 /* We want a single linear allocation, which can then be freed
6305 * with a single swoop. We will do the usual trick of first
6306 * walking over the structure and seeing how much we need to
6307 * allocate, then allocating, and then walking over the structure
6308 * the second time and populating it. */
6310 /* First we must compute the total size of the buffer. */
6311 total_bytes = sizeof(Perl_c_backtrace_header);
6312 if (got_depth > skip) {
6315 bfd_init(); /* Is this safe to call multiple times? */
6316 Zero(&bfd_ctx, 1, bfd_context);
6319 Zero(&atos_ctx, 1, atos_context);
6321 for (i = skip; i < try_depth; i++) {
6322 Dl_info* dl_info = &dl_infos[i];
6324 object_name_sizes[i] = 0;
6325 source_names[i] = NULL;
6326 source_name_sizes[i] = 0;
6327 source_lines[i] = 0;
6329 /* Yes, zero from dladdr() is failure. */
6330 if (dladdr(raw_frames[i], dl_info)) {
6331 total_bytes += sizeof(Perl_c_backtrace_frame);
6333 object_name_sizes[i] =
6334 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6335 symbol_name_sizes[i] =
6336 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6338 bfd_update(&bfd_ctx, dl_info);
6339 bfd_symbolize(&bfd_ctx, raw_frames[i],
6341 &symbol_name_sizes[i],
6343 &source_name_sizes[i],
6347 atos_update(&atos_ctx, dl_info);
6348 atos_symbolize(&atos_ctx,
6351 &source_name_sizes[i],
6355 /* Plus ones for the terminating \0. */
6356 total_bytes += object_name_sizes[i] + 1;
6357 total_bytes += symbol_name_sizes[i] + 1;
6358 total_bytes += source_name_sizes[i] + 1;
6366 Safefree(bfd_ctx.bfd_syms);
6370 /* Now we can allocate and populate the result buffer. */
6371 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6372 Zero(bt, total_bytes, char);
6373 bt->header.frame_count = frame_count;
6374 bt->header.total_bytes = total_bytes;
6375 if (frame_count > 0) {
6376 Perl_c_backtrace_frame* frame = bt->frame_info;
6377 char* name_base = (char *)(frame + frame_count);
6378 char* name_curr = name_base; /* Outputting the name strings here. */
6380 for (i = skip; i < skip + frame_count; i++) {
6381 Dl_info* dl_info = &dl_infos[i];
6383 frame->addr = raw_frames[i];
6384 frame->object_base_addr = dl_info->dli_fbase;
6385 frame->symbol_addr = dl_info->dli_saddr;
6387 /* Copies a string, including the \0, and advances the name_curr.
6388 * Also copies the start and the size to the frame. */
6389 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6391 Copy(src, name_curr, size, char); \
6392 frame->doffset = name_curr - (char*)bt; \
6393 frame->dsize = size; \
6394 name_curr += size; \
6397 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6399 object_name_size, object_name_sizes[i]);
6402 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6404 symbol_name_size, symbol_name_sizes[i]);
6405 Safefree(symbol_names[i]);
6407 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6409 symbol_name_size, symbol_name_sizes[i]);
6412 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6414 source_name_size, source_name_sizes[i]);
6415 Safefree(source_names[i]);
6417 #undef PERL_C_BACKTRACE_STRCPY
6419 frame->source_line_number = source_lines[i];
6423 assert(total_bytes ==
6424 (UV)(sizeof(Perl_c_backtrace_header) +
6425 frame_count * sizeof(Perl_c_backtrace_frame) +
6426 name_curr - name_base));
6429 Safefree(symbol_names);
6431 bfd_close(bfd_ctx.abfd);
6434 Safefree(source_lines);
6435 Safefree(source_name_sizes);
6436 Safefree(source_names);
6437 Safefree(symbol_name_sizes);
6438 Safefree(object_name_sizes);
6439 /* Assuming the strings returned by dladdr() are pointers
6440 * to read-only static memory (the object file), so that
6441 * they do not need freeing (and cannot be). */
6443 Safefree(raw_frames);
6446 PERL_UNUSED_ARG(depth);
6447 PERL_UNUSED_ARG(skip);
6453 =for apidoc free_c_backtrace
6455 Deallocates a backtrace received from get_c_backtrace.
6461 =for apidoc get_c_backtrace_dump
6463 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6464 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6466 The appended output looks like:
6469 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6470 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6473 The fields are tab-separated. The first column is the depth (zero
6474 being the innermost non-skipped frame). In the hex:offset, the hex is
6475 where the program counter was in C<S_parse_body>, and the :offset (might
6476 be missing) tells how much inside the C<S_parse_body> the program counter was.
6478 The C<util.c:1716> is the source code file and line number.
6480 The F</usr/bin/perl> is obvious (hopefully).
6482 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6483 if the platform doesn't support retrieving the information;
6484 if the binary is missing the debug information;
6485 if the optimizer has transformed the code by for example inlining.
6491 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6493 Perl_c_backtrace* bt;
6495 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6497 Perl_c_backtrace_frame* frame;
6498 SV* dsv = newSVpvs("");
6500 for (i = 0, frame = bt->frame_info;
6501 i < bt->header.frame_count; i++, frame++) {
6502 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6503 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6504 /* Symbol (function) names might disappear without debug info.
6506 * The source code location might disappear in case of the
6507 * optimizer inlining or otherwise rearranging the code. */
6508 if (frame->symbol_addr) {
6509 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6511 ((char*)frame->addr - (char*)frame->symbol_addr));
6513 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6514 frame->symbol_name_size &&
6515 frame->symbol_name_offset ?
6516 (char*)bt + frame->symbol_name_offset : "-");
6517 if (frame->source_name_size &&
6518 frame->source_name_offset &&
6519 frame->source_line_number) {
6520 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6521 (char*)bt + frame->source_name_offset,
6522 (UV)frame->source_line_number);
6524 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6526 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6527 frame->object_name_size &&
6528 frame->object_name_offset ?
6529 (char*)bt + frame->object_name_offset : "-");
6530 /* The frame->object_base_addr is not output,
6531 * but it is used for symbolizing/symbolicating. */
6532 sv_catpvs(dsv, "\n");
6535 Perl_free_c_backtrace(bt);
6544 =for apidoc dump_c_backtrace
6546 Dumps the C backtrace to the given C<fp>.
6548 Returns true if a backtrace could be retrieved, false if not.
6554 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6558 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6560 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6563 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6569 #endif /* #ifdef USE_C_BACKTRACE */
6571 #if defined(USE_ITHREADS) && defined(I_PTHREAD)
6573 /* pthread_mutex_t and perl_mutex are typedef equivalent
6574 * so casting the pointers is fine. */
6576 int perl_tsa_mutex_lock(perl_mutex* mutex)
6578 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6581 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6583 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6586 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6588 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6595 /* log a sub call or return */
6598 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6606 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6609 HEK *hek = CvNAME_HEK(cv);
6610 func = HEK_KEY(hek);
6616 start = (const COP *)CvSTART(cv);
6617 file = CopFILE(start);
6618 line = CopLINE(start);
6619 stash = CopSTASHPV(start);
6622 PERL_SUB_ENTRY(func, file, line, stash);
6625 PERL_SUB_RETURN(func, file, line, stash);
6630 /* log a require file loading/loaded */
6633 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6635 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6638 PERL_LOADING_FILE(name);
6641 PERL_LOADED_FILE(name);
6646 /* log an op execution */
6649 Perl_dtrace_probe_op(pTHX_ const OP *op)
6651 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6653 PERL_OP_ENTRY(OP_NAME(op));
6657 /* log a compile/run phase change */
6660 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6662 const char *ph_old = PL_phase_names[PL_phase];
6663 const char *ph_new = PL_phase_names[phase];
6665 PERL_PHASE_CHANGE(ph_new, ph_old);
6671 * ex: set ts=8 sts=4 sw=4 et: