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 * unquestioninly 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";
1322 /* copy a string to a safe spot */
1325 =for apidoc_section $string
1328 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1329 string which is a duplicate of C<pv>. The size of the string is
1330 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1331 characters and must have a trailing C<NUL>. To prevent memory leaks, the
1332 memory allocated for the new string needs to be freed when no longer needed.
1333 This can be done with the C<L</Safefree>> function, or
1334 L<C<SAVEFREEPV>|perlguts/SAVEFREEPV(p)>.
1336 On some platforms, Windows for example, all allocated memory owned by a thread
1337 is deallocated when that thread ends. So if you need that not to happen, you
1338 need to use the shared memory functions, such as C<L</savesharedpv>>.
1344 Perl_savepv(pTHX_ const char *pv)
1346 PERL_UNUSED_CONTEXT;
1351 const STRLEN pvlen = strlen(pv)+1;
1352 Newx(newaddr, pvlen, char);
1353 return (char*)memcpy(newaddr, pv, pvlen);
1357 /* same thing but with a known length */
1362 Perl's version of what C<strndup()> would be if it existed. Returns a
1363 pointer to a newly allocated string which is a duplicate of the first
1364 C<len> bytes from C<pv>, plus a trailing
1365 C<NUL> byte. The memory allocated for
1366 the new string can be freed with the C<Safefree()> function.
1368 On some platforms, Windows for example, all allocated memory owned by a thread
1369 is deallocated when that thread ends. So if you need that not to happen, you
1370 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1376 Perl_savepvn(pTHX_ const char *pv, Size_t len)
1379 PERL_UNUSED_CONTEXT;
1381 Newx(newaddr,len+1,char);
1382 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1384 /* might not be null terminated */
1385 newaddr[len] = '\0';
1386 return (char *) CopyD(pv,newaddr,len,char);
1389 return (char *) ZeroD(newaddr,len+1,char);
1394 =for apidoc savesharedpv
1396 A version of C<savepv()> which allocates the duplicate string in memory
1397 which is shared between threads.
1402 Perl_savesharedpv(pTHX_ const char *pv)
1407 PERL_UNUSED_CONTEXT;
1412 pvlen = strlen(pv)+1;
1413 newaddr = (char*)PerlMemShared_malloc(pvlen);
1417 return (char*)memcpy(newaddr, pv, pvlen);
1421 =for apidoc savesharedpvn
1423 A version of C<savepvn()> which allocates the duplicate string in memory
1424 which is shared between threads. (With the specific difference that a C<NULL>
1425 pointer is not acceptable)
1430 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1432 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1434 PERL_UNUSED_CONTEXT;
1435 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1440 newaddr[len] = '\0';
1441 return (char*)memcpy(newaddr, pv, len);
1445 =for apidoc savesvpv
1447 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1448 the passed in SV using C<SvPV()>
1450 On some platforms, Windows for example, all allocated memory owned by a thread
1451 is deallocated when that thread ends. So if you need that not to happen, you
1452 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1458 Perl_savesvpv(pTHX_ SV *sv)
1461 const char * const pv = SvPV_const(sv, len);
1464 PERL_ARGS_ASSERT_SAVESVPV;
1467 Newx(newaddr,len,char);
1468 return (char *) CopyD(pv,newaddr,len,char);
1472 =for apidoc savesharedsvpv
1474 A version of C<savesharedpv()> which allocates the duplicate string in
1475 memory which is shared between threads.
1481 Perl_savesharedsvpv(pTHX_ SV *sv)
1484 const char * const pv = SvPV_const(sv, len);
1486 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1488 return savesharedpvn(pv, len);
1491 /* the SV for Perl_form() and mess() is not kept in an arena */
1499 if (PL_phase != PERL_PHASE_DESTRUCT)
1500 return newSVpvs_flags("", SVs_TEMP);
1505 /* Create as PVMG now, to avoid any upgrading later */
1507 Newxz(any, 1, XPVMG);
1508 SvFLAGS(sv) = SVt_PVMG;
1509 SvANY(sv) = (void*)any;
1511 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1516 #if defined(MULTIPLICITY)
1518 Perl_form_nocontext(const char* pat, ...)
1523 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1524 va_start(args, pat);
1525 retval = vform(pat, &args);
1529 #endif /* MULTIPLICITY */
1532 =for apidoc_section $display
1534 =for apidoc_item form_nocontext
1536 These take a sprintf-style format pattern and conventional
1537 (non-SV) arguments and return the formatted string.
1539 (char *) Perl_form(pTHX_ const char* pat, ...)
1541 can be used any place a string (char *) is required:
1543 char * s = Perl_form("%d.%d",major,minor);
1545 They use a single (per-thread) private buffer so if you want to format several
1546 strings you must explicitly copy the earlier strings away (and free the copies
1549 The two forms differ only in that C<form_nocontext> does not take a thread
1550 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
1551 already have the thread context.
1554 Like C<L</form>> but but the arguments are an encapsulated argument list.
1560 Perl_form(pTHX_ const char* pat, ...)
1564 PERL_ARGS_ASSERT_FORM;
1565 va_start(args, pat);
1566 retval = vform(pat, &args);
1572 Perl_vform(pTHX_ const char *pat, va_list *args)
1574 SV * const sv = mess_alloc();
1575 PERL_ARGS_ASSERT_VFORM;
1576 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1582 =for apidoc_item mess_nocontext
1584 These take a sprintf-style format pattern and argument list, which are used to
1585 generate a string message. If the message does not end with a newline, then it
1586 will be extended with some indication of the current location in the code, as
1587 described for C<L</mess_sv>>.
1589 Normally, the resulting message is returned in a new mortal SV.
1590 But during global destruction a single SV may be shared between uses of
1593 The two forms differ only in that C<mess_nocontext> does not take a thread
1594 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
1595 already have the thread context.
1600 #if defined(MULTIPLICITY)
1602 Perl_mess_nocontext(const char *pat, ...)
1607 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1608 va_start(args, pat);
1609 retval = vmess(pat, &args);
1613 #endif /* MULTIPLICITY */
1616 Perl_mess(pTHX_ const char *pat, ...)
1620 PERL_ARGS_ASSERT_MESS;
1621 va_start(args, pat);
1622 retval = vmess(pat, &args);
1628 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1631 /* Look for curop starting from o. cop is the last COP we've seen. */
1632 /* opnext means that curop is actually the ->op_next of the op we are
1635 PERL_ARGS_ASSERT_CLOSEST_COP;
1637 if (!o || !curop || (
1638 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1642 if (o->op_flags & OPf_KIDS) {
1644 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1647 /* If the OP_NEXTSTATE has been optimised away we can still use it
1648 * the get the file and line number. */
1650 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1651 cop = (const COP *)kid;
1653 /* Keep searching, and return when we've found something. */
1655 new_cop = closest_cop(cop, kid, curop, opnext);
1661 /* Nothing found. */
1669 Expands a message, intended for the user, to include an indication of
1670 the current location in the code, if the message does not already appear
1673 C<basemsg> is the initial message or object. If it is a reference, it
1674 will be used as-is and will be the result of this function. Otherwise it
1675 is used as a string, and if it already ends with a newline, it is taken
1676 to be complete, and the result of this function will be the same string.
1677 If the message does not end with a newline, then a segment such as C<at
1678 foo.pl line 37> will be appended, and possibly other clauses indicating
1679 the current state of execution. The resulting message will end with a
1682 Normally, the resulting message is returned in a new mortal SV.
1683 During global destruction a single SV may be shared between uses of this
1684 function. If C<consume> is true, then the function is permitted (but not
1685 required) to modify and return C<basemsg> instead of allocating a new SV.
1691 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1695 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1699 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1700 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1701 && grok_atoUV(ws, &wi, NULL)
1702 && wi <= PERL_INT_MAX
1704 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1709 PERL_ARGS_ASSERT_MESS_SV;
1711 if (SvROK(basemsg)) {
1717 sv_setsv(sv, basemsg);
1722 if (SvPOK(basemsg) && consume) {
1727 sv_copypv(sv, basemsg);
1730 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1732 * Try and find the file and line for PL_op. This will usually be
1733 * PL_curcop, but it might be a cop that has been optimised away. We
1734 * can try to find such a cop by searching through the optree starting
1735 * from the sibling of PL_curcop.
1740 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1745 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1746 OutCopFILE(cop), (IV)CopLINE(cop));
1749 /* Seems that GvIO() can be untrustworthy during global destruction. */
1750 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1751 && IoLINES(GvIOp(PL_last_in_gv)))
1754 const bool line_mode = (RsSIMPLE(PL_rs) &&
1755 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1756 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1757 SVfARG(PL_last_in_gv == PL_argvgv
1759 : newSVhek_mortal(GvNAME_HEK(PL_last_in_gv))),
1760 line_mode ? "line" : "chunk",
1761 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1763 if (PL_phase == PERL_PHASE_DESTRUCT)
1764 sv_catpvs(sv, " during global destruction");
1765 sv_catpvs(sv, ".\n");
1773 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1774 argument list, respectively. These are used to generate a string message. If
1776 message does not end with a newline, then it will be extended with
1777 some indication of the current location in the code, as described for
1780 Normally, the resulting message is returned in a new mortal SV.
1781 During global destruction a single SV may be shared between uses of
1788 Perl_vmess(pTHX_ const char *pat, va_list *args)
1790 SV * const sv = mess_alloc();
1792 PERL_ARGS_ASSERT_VMESS;
1794 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1795 return mess_sv(sv, 1);
1799 Perl_write_to_stderr(pTHX_ SV* msv)
1804 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1806 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1807 && (io = GvIO(PL_stderrgv))
1808 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1809 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1810 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1812 PerlIO * const serr = Perl_error_log;
1814 do_print(msv, serr);
1815 (void)PerlIO_flush(serr);
1820 =for apidoc_section $warning
1823 /* Common code used in dieing and warning */
1826 S_with_queued_errors(pTHX_ SV *ex)
1828 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1829 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1830 sv_catsv(PL_errors, ex);
1831 ex = sv_mortalcopy(PL_errors);
1832 SvCUR_set(PL_errors, 0);
1838 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1843 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1844 /* sv_2cv might call Perl_croak() or Perl_warner() */
1845 SV * const oldhook = *hook;
1847 if (!oldhook || oldhook == PERL_WARNHOOK_FATAL)
1853 cv = sv_2cv(oldhook, &stash, &gv, 0);
1855 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1865 exarg = newSVsv(ex);
1866 SvREADONLY_on(exarg);
1869 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1873 call_sv(MUTABLE_SV(cv), G_DISCARD);
1884 This behaves the same as L</croak_sv>, except for the return type.
1885 It should be used only where the C<OP *> return type is required.
1886 The function never actually returns.
1891 /* silence __declspec(noreturn) warnings */
1892 MSVC_DIAG_IGNORE(4646 4645)
1894 Perl_die_sv(pTHX_ SV *baseex)
1896 PERL_ARGS_ASSERT_DIE_SV;
1899 NORETURN_FUNCTION_END;
1905 =for apidoc_item die_nocontext
1907 These behave the same as L</croak>, except for the return type.
1908 They should be used only where the C<OP *> return type is required.
1909 They never actually return.
1911 The two forms differ only in that C<die_nocontext> does not take a thread
1912 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
1913 already have the thread context.
1918 #if defined(MULTIPLICITY)
1920 /* silence __declspec(noreturn) warnings */
1921 MSVC_DIAG_IGNORE(4646 4645)
1923 Perl_die_nocontext(const char* pat, ...)
1927 va_start(args, pat);
1929 NOT_REACHED; /* NOTREACHED */
1931 NORETURN_FUNCTION_END;
1935 #endif /* MULTIPLICITY */
1937 /* silence __declspec(noreturn) warnings */
1938 MSVC_DIAG_IGNORE(4646 4645)
1940 Perl_die(pTHX_ const char* pat, ...)
1943 va_start(args, pat);
1945 NOT_REACHED; /* NOTREACHED */
1947 NORETURN_FUNCTION_END;
1952 =for apidoc croak_sv
1954 This is an XS interface to Perl's C<die> function.
1956 C<baseex> is the error message or object. If it is a reference, it
1957 will be used as-is. Otherwise it is used as a string, and if it does
1958 not end with a newline then it will be extended with some indication of
1959 the current location in the code, as described for L</mess_sv>.
1961 The error message or object will be used as an exception, by default
1962 returning control to the nearest enclosing C<eval>, but subject to
1963 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1964 function never returns normally.
1966 To die with a simple string message, the L</croak> function may be
1973 Perl_croak_sv(pTHX_ SV *baseex)
1975 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1976 PERL_ARGS_ASSERT_CROAK_SV;
1977 invoke_exception_hook(ex, FALSE);
1984 This is an XS interface to Perl's C<die> function.
1986 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1987 argument list. These are used to generate a string message. If the
1988 message does not end with a newline, then it will be extended with
1989 some indication of the current location in the code, as described for
1992 The error message will be used as an exception, by default
1993 returning control to the nearest enclosing C<eval>, but subject to
1994 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1995 function never returns normally.
1997 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1998 (C<$@>) will be used as an error message or object instead of building an
1999 error message from arguments. If you want to throw a non-string object,
2000 or build an error message in an SV yourself, it is preferable to use
2001 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
2007 Perl_vcroak(pTHX_ const char* pat, va_list *args)
2009 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
2010 invoke_exception_hook(ex, FALSE);
2016 =for apidoc_item croak_nocontext
2018 These are XS interfaces to Perl's C<die> function.
2020 They take a sprintf-style format pattern and argument list, which are used to
2021 generate a string message. If the message does not end with a newline, then it
2022 will be extended with some indication of the current location in the code, as
2023 described for C<L</mess_sv>>.
2025 The error message will be used as an exception, by default
2026 returning control to the nearest enclosing C<eval>, but subject to
2027 modification by a C<$SIG{__DIE__}> handler. In any case, these croak
2028 functions never return normally.
2030 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
2031 (C<$@>) will be used as an error message or object instead of building an
2032 error message from arguments. If you want to throw a non-string object,
2033 or build an error message in an SV yourself, it is preferable to use
2034 the C<L</croak_sv>> function, which does not involve clobbering C<ERRSV>.
2036 The two forms differ only in that C<croak_nocontext> does not take a thread
2037 context (C<aTHX>) parameter. It is usually preferred as it takes up fewer
2038 bytes of code than plain C<Perl_croak>, and time is rarely a critical resource
2039 when you are about to throw an exception.
2044 #if defined(MULTIPLICITY)
2046 Perl_croak_nocontext(const char *pat, ...)
2050 va_start(args, pat);
2052 NOT_REACHED; /* NOTREACHED */
2055 #endif /* MULTIPLICITY */
2058 Perl_croak(pTHX_ const char *pat, ...)
2061 va_start(args, pat);
2063 NOT_REACHED; /* NOTREACHED */
2068 =for apidoc croak_no_modify
2070 This encapsulates a common reason for dying, generating terser object code than
2071 using the generic C<Perl_croak>. It is exactly equivalent to
2072 C<Perl_croak(aTHX_ "%s", PL_no_modify)> (which expands to something like
2073 "Modification of a read-only value attempted").
2075 Less code used on exception code paths reduces CPU cache pressure.
2081 Perl_croak_no_modify(void)
2083 Perl_croak_nocontext( "%s", PL_no_modify);
2086 /* does not return, used in util.c perlio.c and win32.c
2087 This is typically called when malloc returns NULL.
2090 Perl_croak_no_mem(void)
2094 int fd = PerlIO_fileno(Perl_error_log);
2096 SETERRNO(EBADF,RMS_IFI);
2098 /* Can't use PerlIO to write as it allocates memory */
2099 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
2104 /* does not return, used only in POPSTACK */
2106 Perl_croak_popstack(void)
2109 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
2116 This is an XS interface to Perl's C<warn> function.
2118 C<baseex> is the error message or object. If it is a reference, it
2119 will be used as-is. Otherwise it is used as a string, and if it does
2120 not end with a newline then it will be extended with some indication of
2121 the current location in the code, as described for L</mess_sv>.
2123 The error message or object will by default be written to standard error,
2124 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2126 To warn with a simple string message, the L</warn> function may be
2133 Perl_warn_sv(pTHX_ SV *baseex)
2135 SV *ex = mess_sv(baseex, 0);
2136 PERL_ARGS_ASSERT_WARN_SV;
2137 if (!invoke_exception_hook(ex, TRUE))
2138 write_to_stderr(ex);
2144 This is an XS interface to Perl's C<warn> function.
2146 This is like C<L</warn>>, but C<args> are an encapsulated
2149 Unlike with L</vcroak>, C<pat> is not permitted to be null.
2155 Perl_vwarn(pTHX_ const char* pat, va_list *args)
2157 SV *ex = vmess(pat, args);
2158 PERL_ARGS_ASSERT_VWARN;
2159 if (!invoke_exception_hook(ex, TRUE))
2160 write_to_stderr(ex);
2165 =for apidoc_item warn_nocontext
2167 These are XS interfaces to Perl's C<warn> function.
2169 They take a sprintf-style format pattern and argument list, which are used to
2170 generate a string message. If the message does not end with a newline, then it
2171 will be extended with some indication of the current location in the code, as
2172 described for C<L</mess_sv>>.
2174 The error message or object will by default be written to standard error,
2175 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2177 Unlike with C<L</croak>>, C<pat> is not permitted to be null.
2179 The two forms differ only in that C<warn_nocontext> does not take a thread
2180 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
2181 already have the thread context.
2186 #if defined(MULTIPLICITY)
2188 Perl_warn_nocontext(const char *pat, ...)
2192 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
2193 va_start(args, pat);
2197 #endif /* MULTIPLICITY */
2200 Perl_warn(pTHX_ const char *pat, ...)
2203 PERL_ARGS_ASSERT_WARN;
2204 va_start(args, pat);
2211 =for apidoc_item warner_nocontext
2213 These output a warning of the specified category (or categories) given by
2214 C<err>, using the sprintf-style format pattern C<pat>, and argument list.
2216 C<err> must be one of the C<L</packWARN>>, C<packWARN2>, C<packWARN3>,
2217 C<packWARN4> macros populated with the appropriate number of warning
2218 categories. If any of the warning categories they specify is fatal, a fatal
2219 exception is thrown.
2221 In any event a message is generated by the pattern and arguments. If the
2222 message does not end with a newline, then it will be extended with some
2223 indication of the current location in the code, as described for L</mess_sv>.
2225 The error message or object will by default be written to standard error,
2226 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2228 C<pat> is not permitted to be null.
2230 The two forms differ only in that C<warner_nocontext> does not take a thread
2231 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
2232 already have the thread context.
2234 These functions differ from the similarly named C<L</warn>> functions, in that
2235 the latter are for XS code to unconditionally display a warning, whereas these
2236 are for code that may be compiling a perl program, and does extra checking to
2237 see if the warning should be fatal.
2239 =for apidoc ck_warner
2240 =for apidoc_item ck_warner_d
2241 If none of the warning categories given by C<err> are enabled, do nothing;
2242 otherwise call C<L</warner>> or C<L</warner_nocontext>> with the passed-in
2245 C<err> must be one of the C<L</packWARN>>, C<packWARN2>, C<packWARN3>,
2246 C<packWARN4> macros populated with the appropriate number of warning
2249 The two forms differ only in that C<ck_warner_d> should be used if warnings for
2250 any of the categories are by default enabled.
2253 This is like C<L</warner>>, but C<args> are an encapsulated argument list.
2258 #if defined(MULTIPLICITY)
2260 Perl_warner_nocontext(U32 err, const char *pat, ...)
2264 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
2265 va_start(args, pat);
2266 vwarner(err, pat, &args);
2269 #endif /* MULTIPLICITY */
2272 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
2274 PERL_ARGS_ASSERT_CK_WARNER_D;
2276 if (Perl_ckwarn_d(aTHX_ err)) {
2278 va_start(args, pat);
2279 vwarner(err, pat, &args);
2285 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
2287 PERL_ARGS_ASSERT_CK_WARNER;
2289 if (Perl_ckwarn(aTHX_ err)) {
2291 va_start(args, pat);
2292 vwarner(err, pat, &args);
2298 Perl_warner(pTHX_ U32 err, const char* pat,...)
2301 PERL_ARGS_ASSERT_WARNER;
2302 va_start(args, pat);
2303 vwarner(err, pat, &args);
2308 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
2310 PERL_ARGS_ASSERT_VWARNER;
2312 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
2313 !(PL_in_eval & EVAL_KEEPERR)
2315 SV * const msv = vmess(pat, args);
2317 if (PL_parser && PL_parser->error_count) {
2321 invoke_exception_hook(msv, FALSE);
2326 Perl_vwarn(aTHX_ pat, args);
2330 /* implements the ckWARN? macros */
2333 Perl_ckwarn(pTHX_ U32 w)
2335 /* If lexical warnings have not been set, use $^W. */
2337 return PL_dowarn & G_WARN_ON;
2339 return ckwarn_common(w);
2342 /* implements the ckWARN?_d macro */
2345 Perl_ckwarn_d(pTHX_ U32 w)
2347 /* If lexical warnings have not been set then default classes warn. */
2351 return ckwarn_common(w);
2355 S_ckwarn_common(pTHX_ U32 w)
2357 if (PL_curcop->cop_warnings == pWARN_ALL)
2360 if (PL_curcop->cop_warnings == pWARN_NONE)
2363 /* Check the assumption that at least the first slot is non-zero. */
2364 assert(unpackWARN1(w));
2366 /* Check the assumption that it is valid to stop as soon as a zero slot is
2368 if (!unpackWARN2(w)) {
2369 assert(!unpackWARN3(w));
2370 assert(!unpackWARN4(w));
2371 } else if (!unpackWARN3(w)) {
2372 assert(!unpackWARN4(w));
2375 /* Right, dealt with all the special cases, which are implemented as non-
2376 pointers, so there is a pointer to a real warnings mask. */
2378 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2380 } while (w >>= WARNshift);
2385 /* Set buffer=NULL to get a new one. */
2387 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2389 const MEM_SIZE len_wanted =
2390 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2391 PERL_UNUSED_CONTEXT;
2392 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2395 (specialWARN(buffer) ?
2396 PerlMemShared_malloc(len_wanted) :
2397 PerlMemShared_realloc(buffer, len_wanted));
2399 Copy(bits, (buffer + 1), size, char);
2400 if (size < WARNsize)
2401 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2405 /* since we've already done strlen() for both nam and val
2406 * we can use that info to make things faster than
2407 * sprintf(s, "%s=%s", nam, val)
2409 #define my_setenv_format(s, nam, nlen, val, vlen) \
2410 Copy(nam, s, nlen, char); \
2412 Copy(val, s+(nlen+1), vlen, char); \
2413 *(s+(nlen+1+vlen)) = '\0'
2417 #if defined(USE_ENVIRON_ARRAY) || defined(WIN32)
2418 /* NB: VMS' my_setenv() is in vms.c */
2420 /* small wrapper for use by Perl_my_setenv that mallocs, or reallocs if
2421 * 'current' is non-null, with up to three sizes that are added together.
2422 * It handles integer overflow.
2426 S_env_alloc(void *current, Size_t l1, Size_t l2, Size_t l3, Size_t size)
2429 Size_t sl, l = l1 + l2;
2441 ? safesysrealloc(current, sl)
2442 : safesysmalloc(sl);
2447 croak_memory_wrap();
2452 =for apidoc_section $utility
2453 =for apidoc my_setenv
2455 A wrapper for the C library L<setenv(3)>. Don't use the latter, as the perl
2456 version has desirable safeguards
2462 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2464 # if defined(USE_ITHREADS) && !defined(WIN32)
2465 /* only parent thread can modify process environment, so no need to use a
2467 if (PL_curinterp != aTHX)
2471 # if defined(HAS_SETENV) && defined(HAS_UNSETENV)
2475 setenv(nam, val, 1);
2478 # elif defined(HAS_UNSETENV)
2481 if (environ) /* old glibc can crash with null environ */
2484 const Size_t nlen = strlen(nam);
2485 const Size_t vlen = strlen(val);
2486 char * const new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2487 my_setenv_format(new_env, nam, nlen, val, vlen);
2491 # else /* ! HAS_UNSETENV */
2493 const Size_t nlen = strlen(nam);
2497 Size_t vlen = strlen(val);
2498 char *new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2499 /* all that work just for this */
2500 my_setenv_format(new_env, nam, nlen, val, vlen);
2504 PerlEnv_putenv(new_env);
2505 safesysfree(new_env);
2508 # endif /* HAS_SETENV */
2511 #endif /* USE_ENVIRON_ARRAY || WIN32 */
2513 #ifdef UNLINK_ALL_VERSIONS
2515 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2519 PERL_ARGS_ASSERT_UNLNK;
2521 while (PerlLIO_unlink(f) >= 0)
2523 return retries ? 0 : -1;
2528 #if (__CHARSET_LIB == 1)
2529 static int chgfdccsid(int fd, unsigned short ccsid)
2532 memset(&attr, 0, sizeof(attr));
2533 attr.att_filetagchg = 1;
2534 attr.att_filetag.ft_ccsid = ccsid;
2535 if (ccsid != FT_BINARY) {
2536 attr.att_filetag.ft_txtflag = 1;
2538 return __fchattr(fd, &attr, sizeof(attr));
2544 =for apidoc my_popen_list
2546 Implementing function on some systems for PerlProc_popen_list()
2552 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2554 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2562 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2564 PERL_FLUSHALL_FOR_CHILD;
2565 This = (*mode == 'w');
2569 taint_proper("Insecure %s%s", "EXEC");
2571 if (PerlProc_pipe_cloexec(p) < 0)
2573 /* Try for another pipe pair for error return */
2574 if (PerlProc_pipe_cloexec(pp) >= 0)
2576 while ((pid = PerlProc_fork()) < 0) {
2577 if (errno != EAGAIN) {
2578 PerlLIO_close(p[This]);
2579 PerlLIO_close(p[that]);
2581 PerlLIO_close(pp[0]);
2582 PerlLIO_close(pp[1]);
2586 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2595 /* Close parent's end of error status pipe (if any) */
2597 PerlLIO_close(pp[0]);
2599 #if (__CHARSET_LIB == 1)
2600 chgfdccsid(p[THIS], 819);
2601 chgfdccsid(p[THAT], 819);
2604 /* Now dup our end of _the_ pipe to right position */
2605 if (p[THIS] != (*mode == 'r')) {
2606 PerlLIO_dup2(p[THIS], *mode == 'r');
2607 PerlLIO_close(p[THIS]);
2608 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2609 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2612 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2613 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2615 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2616 /* No automatic close - do it by hand */
2623 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2629 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2636 PerlLIO_close(pp[1]);
2637 /* Keep the lower of the two fd numbers */
2638 if (p[that] < p[This]) {
2639 PerlLIO_dup2_cloexec(p[This], p[that]);
2640 PerlLIO_close(p[This]);
2644 PerlLIO_close(p[that]); /* close child's end of pipe */
2646 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2647 SvUPGRADE(sv,SVt_IV);
2649 PL_forkprocess = pid;
2650 /* If we managed to get status pipe check for exec fail */
2651 if (did_pipes && pid > 0) {
2653 unsigned read_total = 0;
2655 while (read_total < sizeof(int)) {
2656 const SSize_t n1 = PerlLIO_read(pp[0],
2657 (void*)(((char*)&errkid)+read_total),
2658 (sizeof(int)) - read_total);
2663 PerlLIO_close(pp[0]);
2665 if (read_total) { /* Error */
2667 PerlLIO_close(p[This]);
2668 if (read_total != sizeof(int))
2669 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", read_total);
2671 pid2 = wait4pid(pid, &status, 0);
2672 } while (pid2 == -1 && errno == EINTR);
2673 errno = errkid; /* Propagate errno from kid */
2678 PerlLIO_close(pp[0]);
2680 #if (__CHARSET_LIB == 1)
2681 PerlIO* io = PerlIO_fdopen(p[This], mode);
2683 chgfdccsid(p[This], 819);
2687 return PerlIO_fdopen(p[This], mode);
2690 return PerlIO_fdopen(p[This], mode);
2694 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2695 return my_syspopen4(aTHX_ NULL, mode, n, args);
2696 # elif defined(WIN32)
2697 return win32_popenlist(mode, n, args);
2699 Perl_croak(aTHX_ "List form of piped open not implemented");
2700 return (PerlIO *) NULL;
2705 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2706 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2709 =for apidoc_section $io
2710 =for apidoc my_popen
2712 A wrapper for the C library L<popen(3)>. Don't use the latter, as the Perl
2713 version knows things that interact with the rest of the perl interpreter.
2719 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2725 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2729 PERL_ARGS_ASSERT_MY_POPEN;
2731 PERL_FLUSHALL_FOR_CHILD;
2734 return my_syspopen(aTHX_ cmd,mode);
2737 This = (*mode == 'w');
2739 if (doexec && TAINTING_get) {
2741 taint_proper("Insecure %s%s", "EXEC");
2743 if (PerlProc_pipe_cloexec(p) < 0)
2745 if (doexec && PerlProc_pipe_cloexec(pp) >= 0)
2747 while ((pid = PerlProc_fork()) < 0) {
2748 if (errno != EAGAIN) {
2749 PerlLIO_close(p[This]);
2750 PerlLIO_close(p[that]);
2752 PerlLIO_close(pp[0]);
2753 PerlLIO_close(pp[1]);
2756 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2759 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2769 PerlLIO_close(pp[0]);
2771 #if (__CHARSET_LIB == 1)
2772 chgfdccsid(p[THIS], 819);
2773 chgfdccsid(p[THAT], 819);
2776 if (p[THIS] != (*mode == 'r')) {
2777 PerlLIO_dup2(p[THIS], *mode == 'r');
2778 PerlLIO_close(p[THIS]);
2779 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2780 PerlLIO_close(p[THAT]);
2783 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2784 PerlLIO_close(p[THAT]);
2788 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2795 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2800 /* may or may not use the shell */
2801 do_exec3(cmd, pp[1], did_pipes);
2804 #endif /* defined OS2 */
2806 #ifdef PERLIO_USING_CRLF
2807 /* Since we circumvent IO layers when we manipulate low-level
2808 filedescriptors directly, need to manually switch to the
2809 default, binary, low-level mode; see PerlIOBuf_open(). */
2810 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2813 #ifdef PERL_USES_PL_PIDSTATUS
2814 hv_clear(PL_pidstatus); /* we have no children */
2821 PerlLIO_close(pp[1]);
2822 if (p[that] < p[This]) {
2823 PerlLIO_dup2_cloexec(p[This], p[that]);
2824 PerlLIO_close(p[This]);
2828 PerlLIO_close(p[that]);
2830 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2831 SvUPGRADE(sv,SVt_IV);
2833 PL_forkprocess = pid;
2834 if (did_pipes && pid > 0) {
2838 while (n < sizeof(int)) {
2839 const SSize_t n1 = PerlLIO_read(pp[0],
2840 (void*)(((char*)&errkid)+n),
2846 PerlLIO_close(pp[0]);
2848 if (n) { /* Error */
2850 PerlLIO_close(p[This]);
2851 if (n != sizeof(int))
2852 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2854 pid2 = wait4pid(pid, &status, 0);
2855 } while (pid2 == -1 && errno == EINTR);
2856 errno = errkid; /* Propagate errno from kid */
2861 PerlLIO_close(pp[0]);
2863 #if (__CHARSET_LIB == 1)
2864 PerlIO* io = PerlIO_fdopen(p[This], mode);
2866 chgfdccsid(p[This], 819);
2870 return PerlIO_fdopen(p[This], mode);
2873 return PerlIO_fdopen(p[This], mode);
2876 #elif defined(__LIBCATAMOUNT__)
2878 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2883 #endif /* !DOSISH */
2885 /* this is called in parent before the fork() */
2887 Perl_atfork_lock(void)
2888 #if defined(USE_ITHREADS)
2890 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2893 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2895 PERL_TSA_ACQUIRE(PL_op_mutex)
2898 #if defined(USE_ITHREADS)
2899 /* locks must be held in locking order (if any) */
2901 MUTEX_LOCK(&PL_perlio_mutex);
2904 MUTEX_LOCK(&PL_malloc_mutex);
2910 /* this is called in both parent and child after the fork() */
2912 Perl_atfork_unlock(void)
2913 #if defined(USE_ITHREADS)
2915 PERL_TSA_RELEASE(PL_perlio_mutex)
2918 PERL_TSA_RELEASE(PL_malloc_mutex)
2920 PERL_TSA_RELEASE(PL_op_mutex)
2923 #if defined(USE_ITHREADS)
2924 /* locks must be released in same order as in atfork_lock() */
2926 MUTEX_UNLOCK(&PL_perlio_mutex);
2929 MUTEX_UNLOCK(&PL_malloc_mutex);
2936 =for apidoc_section $concurrency
2939 This is for the use of C<PerlProc_fork> as a wrapper for the C library
2940 L<fork(2)> on some platforms to hide some platform quirks. It should not be
2941 used except through C<PerlProc_fork>.
2950 #if defined(HAS_FORK)
2952 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2957 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2958 * handlers elsewhere in the code */
2962 #elif defined(__amigaos4__)
2963 return amigaos_fork();
2965 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2966 Perl_croak_nocontext("fork() not available");
2968 #endif /* HAS_FORK */
2973 dup2(int oldfd, int newfd)
2975 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2978 PerlLIO_close(newfd);
2979 return fcntl(oldfd, F_DUPFD, newfd);
2981 #define DUP2_MAX_FDS 256
2982 int fdtmp[DUP2_MAX_FDS];
2988 PerlLIO_close(newfd);
2989 /* good enough for low fd's... */
2990 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2991 if (fdx >= DUP2_MAX_FDS) {
2999 PerlLIO_close(fdtmp[--fdx]);
3006 #ifdef HAS_SIGACTION
3009 =for apidoc_section $signals
3012 A wrapper for the C library functions L<sigaction(2)> or L<signal(2)>.
3013 Use this instead of those libc functions, as the Perl version gives the
3014 safest available implementation, and knows things that interact with the
3015 rest of the perl interpreter.
3021 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
3023 struct sigaction act, oact;
3026 /* only "parent" interpreter can diddle signals */
3027 if (PL_curinterp != aTHX)
3028 return (Sighandler_t) SIG_ERR;
3031 act.sa_handler = handler;
3032 sigemptyset(&act.sa_mask);
3035 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
3036 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
3038 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
3039 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
3040 act.sa_flags |= SA_NOCLDWAIT;
3042 if (sigaction(signo, &act, &oact) == -1)
3043 return (Sighandler_t) SIG_ERR;
3045 return (Sighandler_t) oact.sa_handler;
3049 =for apidoc_section $signals
3050 =for apidoc rsignal_state
3052 Returns a the current signal handler for signal C<signo>.
3059 Perl_rsignal_state(pTHX_ int signo)
3061 struct sigaction oact;
3062 PERL_UNUSED_CONTEXT;
3064 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
3065 return (Sighandler_t) SIG_ERR;
3067 return (Sighandler_t) oact.sa_handler;
3071 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3073 struct sigaction act;
3075 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
3078 /* only "parent" interpreter can diddle signals */
3079 if (PL_curinterp != aTHX)
3083 act.sa_handler = handler;
3084 sigemptyset(&act.sa_mask);
3087 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
3088 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
3090 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
3091 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
3092 act.sa_flags |= SA_NOCLDWAIT;
3094 return sigaction(signo, &act, save);
3098 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3100 PERL_UNUSED_CONTEXT;
3102 /* only "parent" interpreter can diddle signals */
3103 if (PL_curinterp != aTHX)
3107 return sigaction(signo, save, (struct sigaction *)NULL);
3110 #else /* !HAS_SIGACTION */
3113 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
3115 #if defined(USE_ITHREADS) && !defined(WIN32)
3116 /* only "parent" interpreter can diddle signals */
3117 if (PL_curinterp != aTHX)
3118 return (Sighandler_t) SIG_ERR;
3121 return PerlProc_signal(signo, handler);
3131 Perl_rsignal_state(pTHX_ int signo)
3133 Sighandler_t oldsig;
3135 #if defined(USE_ITHREADS) && !defined(WIN32)
3136 /* only "parent" interpreter can diddle signals */
3137 if (PL_curinterp != aTHX)
3138 return (Sighandler_t) SIG_ERR;
3142 oldsig = PerlProc_signal(signo, sig_trap);
3143 PerlProc_signal(signo, oldsig);
3145 PerlProc_kill(PerlProc_getpid(), signo);
3150 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3152 #if defined(USE_ITHREADS) && !defined(WIN32)
3153 /* only "parent" interpreter can diddle signals */
3154 if (PL_curinterp != aTHX)
3157 *save = PerlProc_signal(signo, handler);
3158 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
3162 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3164 #if defined(USE_ITHREADS) && !defined(WIN32)
3165 /* only "parent" interpreter can diddle signals */
3166 if (PL_curinterp != aTHX)
3169 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
3172 #endif /* !HAS_SIGACTION */
3173 #endif /* !PERL_MICRO */
3175 /* VMS' my_pclose() is in VMS.c */
3178 =for apidoc_section $io
3179 =for apidoc my_pclose
3181 A wrapper for the C library L<pclose(3)>. Don't use the latter, as the Perl
3182 version knows things that interact with the rest of the perl interpreter.
3187 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
3189 Perl_my_pclose(pTHX_ PerlIO *ptr)
3197 const int fd = PerlIO_fileno(ptr);
3200 svp = av_fetch(PL_fdpid, fd, FALSE);
3202 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3209 #if defined(USE_PERLIO)
3210 /* Find out whether the refcount is low enough for us to wait for the
3211 child proc without blocking. */
3212 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
3214 should_wait = pid > 0;
3218 if (pid == -2) { /* Opened by popen. */
3219 return my_syspclose(ptr);
3222 close_failed = (PerlIO_close(ptr) == EOF);
3224 if (should_wait) do {
3225 pid2 = wait4pid(pid, &status, 0);
3226 } while (pid2 == -1 && errno == EINTR);
3233 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
3237 #elif defined(__LIBCATAMOUNT__)
3239 Perl_my_pclose(pTHX_ PerlIO *ptr)
3243 #endif /* !DOSISH */
3245 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32)) && !defined(__LIBCATAMOUNT__)
3247 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3250 PERL_ARGS_ASSERT_WAIT4PID;
3251 #ifdef PERL_USES_PL_PIDSTATUS
3253 /* PERL_USES_PL_PIDSTATUS is only defined when neither
3254 waitpid() nor wait4() is available, or on OS/2, which
3255 doesn't appear to support waiting for a progress group
3256 member, so we can only treat a 0 pid as an unknown child.
3263 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3264 pid, rather than a string form. */
3265 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3266 if (svp && *svp != &PL_sv_undef) {
3267 *statusp = SvIVX(*svp);
3268 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3276 hv_iterinit(PL_pidstatus);
3277 if ((entry = hv_iternext(PL_pidstatus))) {
3278 SV * const sv = hv_iterval(PL_pidstatus,entry);
3280 const char * const spid = hv_iterkey(entry,&len);
3282 assert (len == sizeof(Pid_t));
3283 memcpy((char *)&pid, spid, len);
3284 *statusp = SvIVX(sv);
3285 /* The hash iterator is currently on this entry, so simply
3286 calling hv_delete would trigger the lazy delete, which on
3287 aggregate does more work, because next call to hv_iterinit()
3288 would spot the flag, and have to call the delete routine,
3289 while in the meantime any new entries can't re-use that
3291 hv_iterinit(PL_pidstatus);
3292 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3299 # ifdef HAS_WAITPID_RUNTIME
3300 if (!HAS_WAITPID_RUNTIME)
3303 result = PerlProc_waitpid(pid,statusp,flags);
3306 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3307 result = wait4(pid,statusp,flags,NULL);
3310 #ifdef PERL_USES_PL_PIDSTATUS
3311 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3316 Perl_croak(aTHX_ "Can't do waitpid with flags");
3318 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3319 pidgone(result,*statusp);
3325 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3328 if (result < 0 && errno == EINTR) {
3330 errno = EINTR; /* reset in case a signal handler changed $! */
3334 #endif /* !DOSISH || OS2 || WIN32 */
3336 #ifdef PERL_USES_PL_PIDSTATUS
3338 S_pidgone(pTHX_ Pid_t pid, int status)
3342 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3343 SvUPGRADE(sv,SVt_IV);
3344 SvIV_set(sv, status);
3352 int /* Cannot prototype with I32
3354 my_syspclose(PerlIO *ptr)
3357 Perl_my_pclose(pTHX_ PerlIO *ptr)
3360 /* Needs work for PerlIO ! */
3361 FILE * const f = PerlIO_findFILE(ptr);
3362 const I32 result = pclose(f);
3363 PerlIO_releaseFILE(ptr,f);
3369 =for apidoc repeatcpy
3371 Make C<count> copies of the C<len> bytes beginning at C<from>, placing them
3372 into memory beginning at C<to>, which must be big enough to accommodate them
3378 #define PERL_REPEATCPY_LINEAR 4
3380 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3382 PERL_ARGS_ASSERT_REPEATCPY;
3387 croak_memory_wrap();
3390 memset(to, *from, count);
3393 IV items, linear, half;
3395 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3396 for (items = 0; items < linear; ++items) {
3397 const char *q = from;
3399 for (todo = len; todo > 0; todo--)
3404 while (items <= half) {
3405 IV size = items * len;
3406 memcpy(p, to, size);
3412 memcpy(p, to, (count - items) * len);
3418 Perl_same_dirent(pTHX_ const char *a, const char *b)
3420 char *fa = strrchr(a,'/');
3421 char *fb = strrchr(b,'/');
3424 SV * const tmpsv = sv_newmortal();
3426 PERL_ARGS_ASSERT_SAME_DIRENT;
3439 sv_setpvs(tmpsv, ".");
3441 sv_setpvn(tmpsv, a, fa - a);
3442 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3445 sv_setpvs(tmpsv, ".");
3447 sv_setpvn(tmpsv, b, fb - b);
3448 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3450 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3451 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3453 #endif /* !HAS_RENAME */
3456 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3457 const char *const *const search_ext, I32 flags)
3459 const char *xfound = NULL;
3460 char *xfailed = NULL;
3461 char tmpbuf[MAXPATHLEN];
3466 #if defined(DOSISH) && !defined(OS2)
3467 # define SEARCH_EXTS ".bat", ".cmd", NULL
3468 # define MAX_EXT_LEN 4
3471 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3472 # define MAX_EXT_LEN 4
3475 # define SEARCH_EXTS ".pl", ".com", NULL
3476 # define MAX_EXT_LEN 4
3478 /* additional extensions to try in each dir if scriptname not found */
3480 static const char *const exts[] = { SEARCH_EXTS };
3481 const char *const *const ext = search_ext ? search_ext : exts;
3482 int extidx = 0, i = 0;
3483 const char *curext = NULL;
3485 PERL_UNUSED_ARG(search_ext);
3486 # define MAX_EXT_LEN 0
3489 PERL_ARGS_ASSERT_FIND_SCRIPT;
3492 * If dosearch is true and if scriptname does not contain path
3493 * delimiters, search the PATH for scriptname.
3495 * If SEARCH_EXTS is also defined, will look for each
3496 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3497 * while searching the PATH.
3499 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3500 * proceeds as follows:
3501 * If DOSISH or VMSISH:
3502 * + look for ./scriptname{,.foo,.bar}
3503 * + search the PATH for scriptname{,.foo,.bar}
3506 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3507 * this will not look in '.' if it's not in the PATH)
3512 # ifdef ALWAYS_DEFTYPES
3513 len = strlen(scriptname);
3514 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3515 int idx = 0, deftypes = 1;
3518 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3521 int idx = 0, deftypes = 1;
3524 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3526 /* The first time through, just add SEARCH_EXTS to whatever we
3527 * already have, so we can check for default file types. */
3529 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3536 if ((strlen(tmpbuf) + strlen(scriptname)
3537 + MAX_EXT_LEN) >= sizeof tmpbuf)
3538 continue; /* don't search dir with too-long name */
3539 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3543 if (strEQ(scriptname, "-"))
3545 if (dosearch) { /* Look in '.' first. */
3546 const char *cur = scriptname;
3548 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3550 if (strEQ(ext[i++],curext)) {
3551 extidx = -1; /* already has an ext */
3556 DEBUG_p(PerlIO_printf(Perl_debug_log,
3557 "Looking for %s\n",cur));
3560 if (PerlLIO_stat(cur,&statbuf) >= 0
3561 && !S_ISDIR(statbuf.st_mode)) {
3570 if (cur == scriptname) {
3571 len = strlen(scriptname);
3572 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3574 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3577 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3578 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3583 if (dosearch && !strchr(scriptname, '/')
3585 && !strchr(scriptname, '\\')
3587 && (s = PerlEnv_getenv("PATH")))
3591 bufend = s + strlen(s);
3592 while (s < bufend) {
3596 && *s != ';'; len++, s++) {
3597 if (len < sizeof tmpbuf)
3600 if (len < sizeof tmpbuf)
3603 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3608 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3609 continue; /* don't search dir with too-long name */
3612 && tmpbuf[len - 1] != '/'
3613 && tmpbuf[len - 1] != '\\'
3616 tmpbuf[len++] = '/';
3617 if (len == 2 && tmpbuf[0] == '.')
3619 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3623 len = strlen(tmpbuf);
3624 if (extidx > 0) /* reset after previous loop */
3628 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3629 retval = PerlLIO_stat(tmpbuf,&statbuf);
3630 if (S_ISDIR(statbuf.st_mode)) {
3634 } while ( retval < 0 /* not there */
3635 && extidx>=0 && ext[extidx] /* try an extension? */
3636 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3641 if (S_ISREG(statbuf.st_mode)
3642 && cando(S_IRUSR,TRUE,&statbuf)
3643 #if !defined(DOSISH)
3644 && cando(S_IXUSR,TRUE,&statbuf)
3648 xfound = tmpbuf; /* bingo! */
3652 xfailed = savepv(tmpbuf);
3657 if (!xfound && !seen_dot && !xfailed &&
3658 (PerlLIO_stat(scriptname,&statbuf) < 0
3659 || S_ISDIR(statbuf.st_mode)))
3661 seen_dot = 1; /* Disable message. */
3666 if (flags & 1) { /* do or die? */
3667 /* diag_listed_as: Can't execute %s */
3668 Perl_croak(aTHX_ "Can't %s %s%s%s",
3669 (xfailed ? "execute" : "find"),
3670 (xfailed ? xfailed : scriptname),
3671 (xfailed ? "" : " on PATH"),
3672 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3677 scriptname = xfound;
3679 return (scriptname ? savepv(scriptname) : NULL);
3682 #ifndef PERL_GET_CONTEXT_DEFINED
3685 =for apidoc_section $embedding
3686 =for apidoc get_context
3688 Implements L<perlapi/C<PERL_GET_CONTEXT>>, which you should use instead.
3694 Perl_get_context(void)
3696 #if defined(USE_ITHREADS)
3697 # ifdef OLD_PTHREADS_API
3699 int error = pthread_getspecific(PL_thr_key, &t);
3701 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3703 # elif defined(I_MACH_CTHREADS)
3704 return (void*)cthread_data(cthread_self());
3706 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3714 =for apidoc_section $embedding
3715 =for apidoc set_context
3717 Implements L<perlapi/C<PERL_SET_CONTEXT>>, which you should use instead.
3723 Perl_set_context(void *t)
3725 PERL_ARGS_ASSERT_SET_CONTEXT;
3726 #if defined(USE_ITHREADS)
3727 # ifdef PERL_USE_THREAD_LOCAL
3728 PL_current_context = t;
3730 # ifdef I_MACH_CTHREADS
3731 cthread_set_data(cthread_self(), t);
3733 /* We set thread-specific value always, as C++ code has to read it with
3734 * pthreads, beacuse the declaration syntax for thread local storage for C11
3735 * is incompatible with C++, meaning that we can't expose the thread local
3736 * variable to C++ code. */
3738 const int error = pthread_setspecific(PL_thr_key, t);
3740 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3748 #endif /* !PERL_GET_CONTEXT_DEFINED */
3751 =for apidoc get_op_names
3753 Return a pointer to the array of all the names of the various OPs
3754 Given an opcode from the enum in F<opcodes.h>, C<PL_op_name[opcode]> returns a
3755 pointer to a C language string giving its name.
3761 Perl_get_op_names(pTHX)
3763 PERL_UNUSED_CONTEXT;
3764 return (char **)PL_op_name;
3768 =for apidoc get_op_descs
3770 Return a pointer to the array of all the descriptions of the various OPs
3771 Given an opcode from the enum in F<opcodes.h>, C<PL_op_desc[opcode]> returns a
3772 pointer to a C language string giving its description.
3778 Perl_get_op_descs(pTHX)
3780 PERL_UNUSED_CONTEXT;
3781 return (char **)PL_op_desc;
3785 Perl_get_no_modify(pTHX)
3787 PERL_UNUSED_CONTEXT;
3788 return PL_no_modify;
3792 Perl_get_opargs(pTHX)
3794 PERL_UNUSED_CONTEXT;
3795 return (U32 *)PL_opargs;
3799 Perl_get_ppaddr(pTHX)
3801 PERL_UNUSED_CONTEXT;
3802 return (PPADDR_t*)PL_ppaddr;
3805 #ifndef HAS_GETENV_LEN
3807 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3809 char * const env_trans = PerlEnv_getenv(env_elem);
3810 PERL_UNUSED_CONTEXT;
3811 PERL_ARGS_ASSERT_GETENV_LEN;
3813 *len = strlen(env_trans);
3820 Perl_get_vtbl(pTHX_ int vtbl_id)
3822 PERL_UNUSED_CONTEXT;
3824 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3825 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3829 =for apidoc_section $io
3830 =for apidoc my_fflush_all
3832 Implements C<PERL_FLUSHALL_FOR_CHILD> on some platforms.
3838 Perl_my_fflush_all(pTHX)
3840 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3841 return PerlIO_flush(NULL);
3843 # if defined(HAS__FWALK)
3844 extern int fflush(FILE *);
3845 /* undocumented, unprototyped, but very useful BSDism */
3846 extern void _fwalk(int (*)(FILE *));
3850 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3852 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3853 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3854 # elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3855 open_max = sysconf(_SC_OPEN_MAX);
3856 # elif defined(FOPEN_MAX)
3857 open_max = FOPEN_MAX;
3858 # elif defined(OPEN_MAX)
3859 open_max = OPEN_MAX;
3860 # elif defined(_NFILE)
3865 for (i = 0; i < open_max; i++)
3866 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3867 STDIO_STREAM_ARRAY[i]._file < open_max &&
3868 STDIO_STREAM_ARRAY[i]._flag)
3869 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3873 SETERRNO(EBADF,RMS_IFI);
3880 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3882 if (ckWARN(WARN_IO)) {
3884 = gv && (isGV_with_GP(gv))
3887 const char * const direction = have == '>' ? "out" : "in";
3889 if (name && HEK_LEN(name))
3890 Perl_warner(aTHX_ packWARN(WARN_IO),
3891 "Filehandle %" HEKf " opened only for %sput",
3892 HEKfARG(name), direction);
3894 Perl_warner(aTHX_ packWARN(WARN_IO),
3895 "Filehandle opened only for %sput", direction);
3900 Perl_report_evil_fh(pTHX_ const GV *gv)
3902 const IO *io = gv ? GvIO(gv) : NULL;
3903 const PERL_BITFIELD16 op = PL_op->op_type;
3907 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3909 warn_type = WARN_CLOSED;
3913 warn_type = WARN_UNOPENED;
3916 if (ckWARN(warn_type)) {
3918 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3919 newSVhek_mortal(GvENAME_HEK(gv)) : NULL;
3920 const char * const pars =
3921 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3922 const char * const func =
3924 (op == OP_READLINE || op == OP_RCATLINE
3925 ? "readline" : /* "<HANDLE>" not nice */
3926 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3928 const char * const type =
3930 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3931 ? "socket" : "filehandle");
3932 const bool have_name = name && SvCUR(name);
3933 Perl_warner(aTHX_ packWARN(warn_type),
3934 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3935 have_name ? " " : "",
3936 SVfARG(have_name ? name : &PL_sv_no));
3937 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3939 aTHX_ packWARN(warn_type),
3940 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3941 func, pars, have_name ? " " : "",
3942 SVfARG(have_name ? name : &PL_sv_no)
3947 /* To workaround core dumps from the uninitialised tm_zone we get the
3948 * system to give us a reasonable struct to copy. This fix means that
3949 * strftime uses the tm_zone and tm_gmtoff values returned by
3950 * localtime(time()). That should give the desired result most of the
3951 * time. But probably not always!
3953 * This does not address tzname aspects of NETaa14816.
3958 # ifndef STRUCT_TM_HASZONE
3959 # define STRUCT_TM_HASZONE
3963 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3964 # ifndef HAS_TM_TM_ZONE
3965 # define HAS_TM_TM_ZONE
3970 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3972 #ifdef HAS_TM_TM_ZONE
3974 const struct tm* my_tm;
3975 PERL_UNUSED_CONTEXT;
3976 PERL_ARGS_ASSERT_INIT_TM;
3978 ENV_LOCALE_READ_LOCK;
3979 my_tm = localtime(&now);
3981 Copy(my_tm, ptm, 1, struct tm);
3982 ENV_LOCALE_READ_UNLOCK;
3984 PERL_UNUSED_CONTEXT;
3985 PERL_ARGS_ASSERT_INIT_TM;
3986 PERL_UNUSED_ARG(ptm);
3991 =for apidoc_section $time
3992 =for apidoc mini_mktime
3993 normalise S<C<struct tm>> values without the localtime() semantics (and
3994 overhead) of mktime().
3999 Perl_mini_mktime(struct tm *ptm)
4003 int month, mday, year, jday;
4004 int odd_cent, odd_year;
4006 PERL_ARGS_ASSERT_MINI_MKTIME;
4008 #define DAYS_PER_YEAR 365
4009 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
4010 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
4011 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
4012 #define SECS_PER_HOUR (60*60)
4013 #define SECS_PER_DAY (24*SECS_PER_HOUR)
4014 /* parentheses deliberately absent on these two, otherwise they don't work */
4015 #define MONTH_TO_DAYS 153/5
4016 #define DAYS_TO_MONTH 5/153
4017 /* offset to bias by March (month 4) 1st between month/mday & year finding */
4018 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
4019 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
4020 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
4023 * Year/day algorithm notes:
4025 * With a suitable offset for numeric value of the month, one can find
4026 * an offset into the year by considering months to have 30.6 (153/5) days,
4027 * using integer arithmetic (i.e., with truncation). To avoid too much
4028 * messing about with leap days, we consider January and February to be
4029 * the 13th and 14th month of the previous year. After that transformation,
4030 * we need the month index we use to be high by 1 from 'normal human' usage,
4031 * so the month index values we use run from 4 through 15.
4033 * Given that, and the rules for the Gregorian calendar (leap years are those
4034 * divisible by 4 unless also divisible by 100, when they must be divisible
4035 * by 400 instead), we can simply calculate the number of days since some
4036 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
4037 * the days we derive from our month index, and adding in the day of the
4038 * month. The value used here is not adjusted for the actual origin which
4039 * it normally would use (1 January A.D. 1), since we're not exposing it.
4040 * We're only building the value so we can turn around and get the
4041 * normalised values for the year, month, day-of-month, and day-of-year.
4043 * For going backward, we need to bias the value we're using so that we find
4044 * the right year value. (Basically, we don't want the contribution of
4045 * March 1st to the number to apply while deriving the year). Having done
4046 * that, we 'count up' the contribution to the year number by accounting for
4047 * full quadracenturies (400-year periods) with their extra leap days, plus
4048 * the contribution from full centuries (to avoid counting in the lost leap
4049 * days), plus the contribution from full quad-years (to count in the normal
4050 * leap days), plus the leftover contribution from any non-leap years.
4051 * At this point, if we were working with an actual leap day, we'll have 0
4052 * days left over. This is also true for March 1st, however. So, we have
4053 * to special-case that result, and (earlier) keep track of the 'odd'
4054 * century and year contributions. If we got 4 extra centuries in a qcent,
4055 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
4056 * Otherwise, we add back in the earlier bias we removed (the 123 from
4057 * figuring in March 1st), find the month index (integer division by 30.6),
4058 * and the remainder is the day-of-month. We then have to convert back to
4059 * 'real' months (including fixing January and February from being 14/15 in
4060 * the previous year to being in the proper year). After that, to get
4061 * tm_yday, we work with the normalised year and get a new yearday value for
4062 * January 1st, which we subtract from the yearday value we had earlier,
4063 * representing the date we've re-built. This is done from January 1
4064 * because tm_yday is 0-origin.
4066 * Since POSIX time routines are only guaranteed to work for times since the
4067 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
4068 * applies Gregorian calendar rules even to dates before the 16th century
4069 * doesn't bother me. Besides, you'd need cultural context for a given
4070 * date to know whether it was Julian or Gregorian calendar, and that's
4071 * outside the scope for this routine. Since we convert back based on the
4072 * same rules we used to build the yearday, you'll only get strange results
4073 * for input which needed normalising, or for the 'odd' century years which
4074 * were leap years in the Julian calendar but not in the Gregorian one.
4075 * I can live with that.
4077 * This algorithm also fails to handle years before A.D. 1 gracefully, but
4078 * that's still outside the scope for POSIX time manipulation, so I don't
4084 year = 1900 + ptm->tm_year;
4085 month = ptm->tm_mon;
4086 mday = ptm->tm_mday;
4092 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
4093 yearday += month*MONTH_TO_DAYS + mday + jday;
4095 * Note that we don't know when leap-seconds were or will be,
4096 * so we have to trust the user if we get something which looks
4097 * like a sensible leap-second. Wild values for seconds will
4098 * be rationalised, however.
4100 if ((unsigned) ptm->tm_sec <= 60) {
4107 secs += 60 * ptm->tm_min;
4108 secs += SECS_PER_HOUR * ptm->tm_hour;
4110 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
4111 /* got negative remainder, but need positive time */
4112 /* back off an extra day to compensate */
4113 yearday += (secs/SECS_PER_DAY)-1;
4114 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
4117 yearday += (secs/SECS_PER_DAY);
4118 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
4121 else if (secs >= SECS_PER_DAY) {
4122 yearday += (secs/SECS_PER_DAY);
4123 secs %= SECS_PER_DAY;
4125 ptm->tm_hour = secs/SECS_PER_HOUR;
4126 secs %= SECS_PER_HOUR;
4127 ptm->tm_min = secs/60;
4129 ptm->tm_sec += secs;
4130 /* done with time of day effects */
4132 * The algorithm for yearday has (so far) left it high by 428.
4133 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
4134 * bias it by 123 while trying to figure out what year it
4135 * really represents. Even with this tweak, the reverse
4136 * translation fails for years before A.D. 0001.
4137 * It would still fail for Feb 29, but we catch that one below.
4139 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
4140 yearday -= YEAR_ADJUST;
4141 year = (yearday / DAYS_PER_QCENT) * 400;
4142 yearday %= DAYS_PER_QCENT;
4143 odd_cent = yearday / DAYS_PER_CENT;
4144 year += odd_cent * 100;
4145 yearday %= DAYS_PER_CENT;
4146 year += (yearday / DAYS_PER_QYEAR) * 4;
4147 yearday %= DAYS_PER_QYEAR;
4148 odd_year = yearday / DAYS_PER_YEAR;
4150 yearday %= DAYS_PER_YEAR;
4151 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
4156 yearday += YEAR_ADJUST; /* recover March 1st crock */
4157 month = yearday*DAYS_TO_MONTH;
4158 yearday -= month*MONTH_TO_DAYS;
4159 /* recover other leap-year adjustment */
4168 ptm->tm_year = year - 1900;
4170 ptm->tm_mday = yearday;
4171 ptm->tm_mon = month;
4175 ptm->tm_mon = month - 1;
4177 /* re-build yearday based on Jan 1 to get tm_yday */
4179 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
4180 yearday += 14*MONTH_TO_DAYS + 1;
4181 ptm->tm_yday = jday - yearday;
4182 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
4186 Perl_my_strftime(pTHX_ const char *fmt, int sec, int min, int hour, int mday, int mon, int year, int wday, int yday, int isdst)
4191 =for apidoc_section $time
4192 =for apidoc my_strftime
4193 =for apidoc_item my_strftime8
4195 strftime(), but with a different API so that the return value is a pointer
4196 to the formatted result (which MUST be arranged to be FREED BY THE
4197 CALLER). This allows these functions to increase the buffer size as needed,
4198 so that the caller doesn't have to worry about that.
4200 C<my_strftime8> is the same as plain C<my_strftime>, but has an extra
4201 parameter, a pointer to a variable declared as L</C<utf8ness_t>>.
4202 Upon return, its variable will be set to indicate how the resultant string
4203 should be treated with regards to its UTF-8ness.
4205 Note that yday and wday effectively are ignored by these functions, as
4206 mini_mktime() overwrites them
4208 Also note that they are always executed in the underlying locale of the program,
4209 giving localized results.
4219 PERL_ARGS_ASSERT_MY_STRFTIME;
4221 init_tm(&mytm); /* XXX workaround - see init_tm() above */
4224 mytm.tm_hour = hour;
4225 mytm.tm_mday = mday;
4227 mytm.tm_year = year;
4228 mytm.tm_wday = wday;
4229 mytm.tm_yday = yday;
4230 mytm.tm_isdst = isdst;
4232 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
4233 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
4238 #ifdef HAS_TM_TM_GMTOFF
4239 mytm.tm_gmtoff = mytm2.tm_gmtoff;
4241 #ifdef HAS_TM_TM_ZONE
4242 mytm.tm_zone = mytm2.tm_zone;
4247 Newx(buf, buflen, char);
4249 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
4251 len = strftime(buf, buflen, fmt, &mytm);
4253 GCC_DIAG_RESTORE_STMT;
4256 ** The following is needed to handle the situation where
4257 ** tmpbuf overflows. Basically we want to allocate a buffer
4258 ** and try repeatedly, until it's large enough. The reason why it is so
4259 ** complicated ** is that getting a return value of 0 from strftime can
4260 ** indicate one of the following:
4261 ** 1. buffer overflowed,
4262 ** 2. illegal conversion specifier, or
4263 ** 3. the format string specifies nothing to be returned (which isn't an
4264 ** an error). This could be because the format is an empty string
4265 ** or it specifies %p which yields an empty string in some locales.
4266 ** If there is a better way to make it portable, go ahead by
4269 if (inRANGE(len, 1, buflen - 1) || (len == 0 && *fmt == '\0'))
4272 /* Possibly buf overflowed - try again with a bigger buf */
4273 const int fmtlen = strlen(fmt);
4274 int bufsize = fmtlen + buflen;
4276 Renew(buf, bufsize, char);
4279 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
4280 buflen = strftime(buf, bufsize, fmt, &mytm);
4281 GCC_DIAG_RESTORE_STMT;
4283 if (inRANGE(buflen, 1, bufsize - 1))
4285 /* heuristic to prevent out-of-memory errors */
4286 if (bufsize > 100*fmtlen) {
4288 /* "%p" can legally return nothing, assume that was the case if we
4289 * can't make the buffer large enough to get a non-zero return. For
4290 * any other formats, assume it is an error (probably it is an illegal
4291 * conversion specifier.) */
4292 if (strEQ(fmt, "%p")) {
4293 Renew(buf, 1, char);
4303 Renew(buf, bufsize, char);
4308 Perl_croak(aTHX_ "panic: no strftime");
4314 #define SV_CWD_RETURN_UNDEF \
4318 #define SV_CWD_ISDOT(dp) \
4319 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4320 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4323 =for apidoc_section $utility
4325 =for apidoc getcwd_sv
4327 Fill C<sv> with current working directory
4332 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4333 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4334 * getcwd(3) if available
4335 * Comments from the original:
4336 * This is a faster version of getcwd. It's also more dangerous
4337 * because you might chdir out of a directory that you can't chdir
4341 Perl_getcwd_sv(pTHX_ SV *sv)
4346 PERL_ARGS_ASSERT_GETCWD_SV;
4350 char buf[MAXPATHLEN];
4352 /* Some getcwd()s automatically allocate a buffer of the given
4353 * size from the heap if they are given a NULL buffer pointer.
4354 * The problem is that this behaviour is not portable. */
4355 if (getcwd(buf, sizeof(buf) - 1)) {
4360 SV_CWD_RETURN_UNDEF;
4367 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4371 SvUPGRADE(sv, SVt_PV);
4373 if (PerlLIO_lstat(".", &statbuf) < 0) {
4374 SV_CWD_RETURN_UNDEF;
4377 orig_cdev = statbuf.st_dev;
4378 orig_cino = statbuf.st_ino;
4388 if (PerlDir_chdir("..") < 0) {
4389 SV_CWD_RETURN_UNDEF;
4391 if (PerlLIO_stat(".", &statbuf) < 0) {
4392 SV_CWD_RETURN_UNDEF;
4395 cdev = statbuf.st_dev;
4396 cino = statbuf.st_ino;
4398 if (odev == cdev && oino == cino) {
4401 if (!(dir = PerlDir_open("."))) {
4402 SV_CWD_RETURN_UNDEF;
4405 while ((dp = PerlDir_read(dir)) != NULL) {
4407 namelen = dp->d_namlen;
4409 namelen = strlen(dp->d_name);
4412 if (SV_CWD_ISDOT(dp)) {
4416 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4417 SV_CWD_RETURN_UNDEF;
4420 tdev = statbuf.st_dev;
4421 tino = statbuf.st_ino;
4422 if (tino == oino && tdev == odev) {
4428 SV_CWD_RETURN_UNDEF;
4431 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4432 SV_CWD_RETURN_UNDEF;
4435 SvGROW(sv, pathlen + namelen + 1);
4439 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4442 /* prepend current directory to the front */
4444 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4445 pathlen += (namelen + 1);
4447 #ifdef VOID_CLOSEDIR
4450 if (PerlDir_close(dir) < 0) {
4451 SV_CWD_RETURN_UNDEF;
4457 SvCUR_set(sv, pathlen);
4461 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4462 SV_CWD_RETURN_UNDEF;
4465 if (PerlLIO_stat(".", &statbuf) < 0) {
4466 SV_CWD_RETURN_UNDEF;
4469 cdev = statbuf.st_dev;
4470 cino = statbuf.st_ino;
4472 if (cdev != orig_cdev || cino != orig_cino) {
4473 Perl_croak(aTHX_ "Unstable directory path, "
4474 "current directory changed unexpectedly");
4487 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4488 # define EMULATE_SOCKETPAIR_UDP
4491 #ifdef EMULATE_SOCKETPAIR_UDP
4493 S_socketpair_udp (int fd[2]) {
4495 /* Fake a datagram socketpair using UDP to localhost. */
4496 int sockets[2] = {-1, -1};
4497 struct sockaddr_in addresses[2];
4499 Sock_size_t size = sizeof(struct sockaddr_in);
4500 unsigned short port;
4503 memset(&addresses, 0, sizeof(addresses));
4506 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4507 if (sockets[i] == -1)
4508 goto tidy_up_and_fail;
4510 addresses[i].sin_family = AF_INET;
4511 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4512 addresses[i].sin_port = 0; /* kernel choses port. */
4513 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4514 sizeof(struct sockaddr_in)) == -1)
4515 goto tidy_up_and_fail;
4518 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4519 for each connect the other socket to it. */
4522 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4524 goto tidy_up_and_fail;
4525 if (size != sizeof(struct sockaddr_in))
4526 goto abort_tidy_up_and_fail;
4527 /* !1 is 0, !0 is 1 */
4528 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4529 sizeof(struct sockaddr_in)) == -1)
4530 goto tidy_up_and_fail;
4533 /* Now we have 2 sockets connected to each other. I don't trust some other
4534 process not to have already sent a packet to us (by random) so send
4535 a packet from each to the other. */
4538 /* I'm going to send my own port number. As a short.
4539 (Who knows if someone somewhere has sin_port as a bitfield and needs
4540 this routine. (I'm assuming crays have socketpair)) */
4541 port = addresses[i].sin_port;
4542 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4543 if (got != sizeof(port)) {
4545 goto tidy_up_and_fail;
4546 goto abort_tidy_up_and_fail;
4550 /* Packets sent. I don't trust them to have arrived though.
4551 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4552 connect to localhost will use a second kernel thread. In 2.6 the
4553 first thread running the connect() returns before the second completes,
4554 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4555 returns 0. Poor programs have tripped up. One poor program's authors'
4556 had a 50-1 reverse stock split. Not sure how connected these were.)
4557 So I don't trust someone not to have an unpredictable UDP stack.
4561 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4562 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4566 FD_SET((unsigned int)sockets[0], &rset);
4567 FD_SET((unsigned int)sockets[1], &rset);
4569 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4570 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4571 || !FD_ISSET(sockets[1], &rset)) {
4572 /* I hope this is portable and appropriate. */
4574 goto tidy_up_and_fail;
4575 goto abort_tidy_up_and_fail;
4579 /* And the paranoia department even now doesn't trust it to have arrive
4580 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4582 struct sockaddr_in readfrom;
4583 unsigned short buffer[2];
4588 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4589 sizeof(buffer), MSG_DONTWAIT,
4590 (struct sockaddr *) &readfrom, &size);
4592 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4594 (struct sockaddr *) &readfrom, &size);
4598 goto tidy_up_and_fail;
4599 if (got != sizeof(port)
4600 || size != sizeof(struct sockaddr_in)
4601 /* Check other socket sent us its port. */
4602 || buffer[0] != (unsigned short) addresses[!i].sin_port
4603 /* Check kernel says we got the datagram from that socket */
4604 || readfrom.sin_family != addresses[!i].sin_family
4605 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4606 || readfrom.sin_port != addresses[!i].sin_port)
4607 goto abort_tidy_up_and_fail;
4610 /* My caller (my_socketpair) has validated that this is non-NULL */
4613 /* I hereby declare this connection open. May God bless all who cross
4617 abort_tidy_up_and_fail:
4618 errno = ECONNABORTED;
4622 if (sockets[0] != -1)
4623 PerlLIO_close(sockets[0]);
4624 if (sockets[1] != -1)
4625 PerlLIO_close(sockets[1]);
4630 #endif /* EMULATE_SOCKETPAIR_UDP */
4632 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4635 =for apidoc my_socketpair
4637 Emulates L<socketpair(2)> on systems that don't have it, but which do have
4638 enough functionality for the emulation.
4644 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4645 /* Stevens says that family must be AF_LOCAL, protocol 0.
4646 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4651 struct sockaddr_in listen_addr;
4652 struct sockaddr_in connect_addr;
4657 || family != AF_UNIX
4660 errno = EAFNOSUPPORT;
4669 type &= ~SOCK_CLOEXEC;
4672 #ifdef EMULATE_SOCKETPAIR_UDP
4673 if (type == SOCK_DGRAM)
4674 return S_socketpair_udp(fd);
4677 aTHXa(PERL_GET_THX);
4678 listener = PerlSock_socket(AF_INET, type, 0);
4681 memset(&listen_addr, 0, sizeof(listen_addr));
4682 listen_addr.sin_family = AF_INET;
4683 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4684 listen_addr.sin_port = 0; /* kernel choses port. */
4685 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4686 sizeof(listen_addr)) == -1)
4687 goto tidy_up_and_fail;
4688 if (PerlSock_listen(listener, 1) == -1)
4689 goto tidy_up_and_fail;
4691 connector = PerlSock_socket(AF_INET, type, 0);
4692 if (connector == -1)
4693 goto tidy_up_and_fail;
4694 /* We want to find out the port number to connect to. */
4695 size = sizeof(connect_addr);
4696 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4698 goto tidy_up_and_fail;
4699 if (size != sizeof(connect_addr))
4700 goto abort_tidy_up_and_fail;
4701 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4702 sizeof(connect_addr)) == -1)
4703 goto tidy_up_and_fail;
4705 size = sizeof(listen_addr);
4706 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4709 goto tidy_up_and_fail;
4710 if (size != sizeof(listen_addr))
4711 goto abort_tidy_up_and_fail;
4712 PerlLIO_close(listener);
4713 /* Now check we are talking to ourself by matching port and host on the
4715 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4717 goto tidy_up_and_fail;
4718 if (size != sizeof(connect_addr)
4719 || listen_addr.sin_family != connect_addr.sin_family
4720 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4721 || listen_addr.sin_port != connect_addr.sin_port) {
4722 goto abort_tidy_up_and_fail;
4728 abort_tidy_up_and_fail:
4730 errno = ECONNABORTED; /* This would be the standard thing to do. */
4731 #elif defined(ECONNREFUSED)
4732 errno = ECONNREFUSED; /* some OSes might not have ECONNABORTED. */
4734 errno = ETIMEDOUT; /* Desperation time. */
4740 PerlLIO_close(listener);
4741 if (connector != -1)
4742 PerlLIO_close(connector);
4744 PerlLIO_close(acceptor);
4750 /* In any case have a stub so that there's code corresponding
4751 * to the my_socketpair in embed.fnc. */
4753 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4754 #ifdef HAS_SOCKETPAIR
4755 return socketpair(family, type, protocol, fd);
4764 =for apidoc sv_nosharing
4766 Dummy routine which "shares" an SV when there is no sharing module present.
4767 Or "locks" it. Or "unlocks" it. In other
4768 words, ignores its single SV argument.
4769 Exists to avoid test for a C<NULL> function pointer and because it could
4770 potentially warn under some level of strict-ness.
4776 Perl_sv_nosharing(pTHX_ SV *sv)
4778 PERL_UNUSED_CONTEXT;
4779 PERL_UNUSED_ARG(sv);
4784 =for apidoc sv_destroyable
4786 Dummy routine which reports that object can be destroyed when there is no
4787 sharing module present. It ignores its single SV argument, and returns
4788 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4789 could potentially warn under some level of strict-ness.
4795 Perl_sv_destroyable(pTHX_ SV *sv)
4797 PERL_UNUSED_CONTEXT;
4798 PERL_UNUSED_ARG(sv);
4803 Perl_parse_unicode_opts(pTHX_ const char **popt)
4805 const char *p = *popt;
4808 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4812 const char* endptr = p + strlen(p);
4814 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4817 if (p && *p && *p != '\n' && *p != '\r') {
4819 goto the_end_of_the_opts_parser;
4821 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4825 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4831 case PERL_UNICODE_STDIN:
4832 opt |= PERL_UNICODE_STDIN_FLAG; break;
4833 case PERL_UNICODE_STDOUT:
4834 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4835 case PERL_UNICODE_STDERR:
4836 opt |= PERL_UNICODE_STDERR_FLAG; break;
4837 case PERL_UNICODE_STD:
4838 opt |= PERL_UNICODE_STD_FLAG; break;
4839 case PERL_UNICODE_IN:
4840 opt |= PERL_UNICODE_IN_FLAG; break;
4841 case PERL_UNICODE_OUT:
4842 opt |= PERL_UNICODE_OUT_FLAG; break;
4843 case PERL_UNICODE_INOUT:
4844 opt |= PERL_UNICODE_INOUT_FLAG; break;
4845 case PERL_UNICODE_LOCALE:
4846 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4847 case PERL_UNICODE_ARGV:
4848 opt |= PERL_UNICODE_ARGV_FLAG; break;
4849 case PERL_UNICODE_UTF8CACHEASSERT:
4850 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4852 if (*p != '\n' && *p != '\r') {
4853 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4856 "Unknown Unicode option letter '%c'", *p);
4863 opt = PERL_UNICODE_DEFAULT_FLAGS;
4865 the_end_of_the_opts_parser:
4867 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4868 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4869 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4877 # include <starlet.h>
4884 * This is really just a quick hack which grabs various garbage
4885 * values. It really should be a real hash algorithm which
4886 * spreads the effect of every input bit onto every output bit,
4887 * if someone who knows about such things would bother to write it.
4888 * Might be a good idea to add that function to CORE as well.
4889 * No numbers below come from careful analysis or anything here,
4890 * except they are primes and SEED_C1 > 1E6 to get a full-width
4891 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4892 * probably be bigger too.
4895 # define SEED_C1 1000003
4896 #define SEED_C4 73819
4898 # define SEED_C1 25747
4899 #define SEED_C4 20639
4903 #define SEED_C5 26107
4905 #ifndef PERL_NO_DEV_RANDOM
4909 #ifdef HAS_GETTIMEOFDAY
4910 struct timeval when;
4915 /* This test is an escape hatch, this symbol isn't set by Configure. */
4916 #ifndef PERL_NO_DEV_RANDOM
4917 #ifndef PERL_RANDOM_DEVICE
4918 /* /dev/random isn't used by default because reads from it will block
4919 * if there isn't enough entropy available. You can compile with
4920 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4921 * is enough real entropy to fill the seed. */
4922 # ifdef __amigaos4__
4923 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4925 # define PERL_RANDOM_DEVICE "/dev/urandom"
4928 fd = PerlLIO_open_cloexec(PERL_RANDOM_DEVICE, 0);
4930 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4938 #ifdef HAS_GETTIMEOFDAY
4939 PerlProc_gettimeofday(&when,NULL);
4940 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4943 u = (U32)SEED_C1 * when;
4945 u += SEED_C3 * (U32)PerlProc_getpid();
4946 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4947 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4948 u += SEED_C5 * (U32)PTR2UV(&when);
4954 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4956 #ifndef NO_PERL_HASH_ENV
4961 PERL_ARGS_ASSERT_GET_HASH_SEED;
4963 Zero(seed_buffer, PERL_HASH_SEED_BYTES, U8);
4964 Zero((U8*)PL_hash_state_w, PERL_HASH_STATE_BYTES, U8);
4966 #ifndef NO_PERL_HASH_ENV
4967 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4972 PerlIO_printf(Perl_debug_log,"Got PERL_HASH_SEED=<%s>\n", env_pv);
4973 /* ignore leading spaces */
4974 while (isSPACE(*env_pv))
4976 # ifdef USE_PERL_PERTURB_KEYS
4977 /* if they set it to "0" we disable key traversal randomization completely */
4978 if (strEQ(env_pv,"0")) {
4979 PL_hash_rand_bits_enabled= 0;
4981 /* otherwise switch to deterministic mode */
4982 PL_hash_rand_bits_enabled= 2;
4985 /* ignore a leading 0x... if it is there */
4986 if (env_pv[0] == '0' && env_pv[1] == 'x')
4989 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4990 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4991 if ( isXDIGIT(*env_pv)) {
4992 seed_buffer[i] |= READ_XDIGIT(env_pv);
4995 while (isSPACE(*env_pv))
4998 if (*env_pv && !isXDIGIT(*env_pv)) {
4999 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
5001 /* should we check for unparsed crap? */
5002 /* should we warn about unused hex? */
5003 /* should we warn about insufficient hex? */
5006 #endif /* NO_PERL_HASH_ENV */
5008 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
5009 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
5012 #ifdef USE_PERL_PERTURB_KEYS
5013 # ifndef NO_PERL_HASH_ENV
5014 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
5017 PerlIO_printf(Perl_debug_log,
5018 "Got PERL_PERTURB_KEYS=<%s>\n", env_pv);
5019 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
5020 PL_hash_rand_bits_enabled= 0;
5021 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
5022 PL_hash_rand_bits_enabled= 1;
5023 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
5024 PL_hash_rand_bits_enabled= 2;
5026 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
5030 { /* initialize PL_hash_rand_bits from the hash seed.
5031 * This value is highly volatile, it is updated every
5032 * hash insert, and is used as part of hash bucket chain
5033 * randomization and hash iterator randomization. */
5034 if (PL_hash_rand_bits_enabled == 1) {
5035 /* random mode initialize from seed() like we would our RNG() */
5036 PL_hash_rand_bits= seed();
5039 /* Use a constant */
5040 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
5041 /* and then mix in the leading bytes of the hash seed */
5042 for( i = 0; i < sizeof(UV) ; i++ ) {
5043 PL_hash_rand_bits ^= seed_buffer[i % PERL_HASH_SEED_BYTES];
5044 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
5047 if (!PL_hash_rand_bits) {
5048 /* we use an XORSHIFT RNG to munge PL_hash_rand_bits,
5049 * which means it cannot be 0 or it will stay 0 for the
5050 * lifetime of the process, so if by some insane chance we
5051 * ended up with a 0 after the above initialization
5052 * then set it to this. This really should not happen, or
5053 * very very very rarely.
5055 PL_hash_rand_bits = 0x8110ba9d; /* a randomly chosen prime */
5062 Perl_debug_hash_seed(pTHX_ bool via_debug_h)
5064 PERL_ARGS_ASSERT_DEBUG_HASH_SEED;
5065 #if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
5067 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
5068 bool via_env = cBOOL(s && strNE(s, "0") && strNE(s,""));
5070 if ( via_env != via_debug_h ) {
5071 const unsigned char *seed= PERL_HASH_SEED;
5072 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
5073 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
5074 while (seed < seed_end) {
5075 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
5077 #ifdef PERL_HASH_RANDOMIZE_KEYS
5078 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
5079 PL_HASH_RAND_BITS_ENABLED,
5080 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" :
5081 PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM"
5084 PerlIO_printf(Perl_debug_log,
5085 " RAND_BITS=0x%" UVxf, PL_hash_rand_bits);
5087 PerlIO_printf(Perl_debug_log, "\n");
5090 #endif /* #if (defined(USE_HASH_SEED) ... */
5098 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
5099 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
5100 * given, and you supply your own implementation.
5102 * The default implementation reads a single env var, PERL_MEM_LOG,
5103 * expecting one or more of the following:
5105 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
5106 * 'm' - memlog was PERL_MEM_LOG=1
5107 * 's' - svlog was PERL_SV_LOG=1
5108 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
5110 * This makes the logger controllable enough that it can reasonably be
5111 * added to the system perl.
5114 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
5115 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
5117 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 256
5119 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
5120 * writes to. In the default logger, this is settable at runtime.
5122 #ifndef PERL_MEM_LOG_FD
5123 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
5126 #ifndef PERL_MEM_LOG_NOIMPL
5128 # ifdef DEBUG_LEAKING_SCALARS
5129 # define SV_LOG_SERIAL_FMT " [%lu]"
5130 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
5132 # define SV_LOG_SERIAL_FMT
5133 # define _SV_LOG_SERIAL_ARG(sv)
5137 S_mem_log_common(enum mem_log_type mlt, const UV n,
5138 const UV typesize, const char *type_name, const SV *sv,
5139 Malloc_t oldalloc, Malloc_t newalloc,
5140 const char *filename, const int linenumber,
5141 const char *funcname)
5146 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
5148 PL_mem_log[0] |= 0x2; /* Flag that the call is from this code */
5149 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
5150 PL_mem_log[0] &= ~0x2;
5153 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
5155 /* We can't use SVs or PerlIO for obvious reasons,
5156 * so we'll use stdio and low-level IO instead. */
5157 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
5159 # ifdef HAS_GETTIMEOFDAY
5160 # define MEM_LOG_TIME_FMT "%10d.%06d: "
5161 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
5163 PerlProc_gettimeofday(&tv, 0);
5165 # define MEM_LOG_TIME_FMT "%10d: "
5166 # define MEM_LOG_TIME_ARG (int)when
5170 /* If there are other OS specific ways of hires time than
5171 * gettimeofday() (see dist/Time-HiRes), the easiest way is
5172 * probably that they would be used to fill in the struct
5176 const char* endptr = pmlenv + strlen(pmlenv);
5179 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
5180 && uv && uv <= PERL_INT_MAX
5184 fd = PERL_MEM_LOG_FD;
5187 if (strchr(pmlenv, 't')) {
5188 len = my_snprintf(buf, sizeof(buf),
5189 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
5190 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
5194 len = my_snprintf(buf, sizeof(buf),
5195 "alloc: %s:%d:%s: %" IVdf " %" UVuf
5196 " %s = %" IVdf ": %" UVxf "\n",
5197 filename, linenumber, funcname, n, typesize,
5198 type_name, n * typesize, PTR2UV(newalloc));
5201 len = my_snprintf(buf, sizeof(buf),
5202 "realloc: %s:%d:%s: %" IVdf " %" UVuf
5203 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
5204 filename, linenumber, funcname, n, typesize,
5205 type_name, n * typesize, PTR2UV(oldalloc),
5209 len = my_snprintf(buf, sizeof(buf),
5210 "free: %s:%d:%s: %" UVxf "\n",
5211 filename, linenumber, funcname,
5216 len = my_snprintf(buf, sizeof(buf),
5217 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
5218 mlt == MLT_NEW_SV ? "new" : "del",
5219 filename, linenumber, funcname,
5220 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
5225 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
5226 #ifdef USE_C_BACKTRACE
5227 if(strchr(pmlenv,'c') && (mlt == MLT_NEW_SV)) {
5228 len = my_snprintf(buf, sizeof(buf),
5229 " caller %s at %s line %d\n",
5230 /* CopSTASHPV can crash early on startup; use CopFILE to check */
5231 CopFILE(PL_curcop) ? CopSTASHPV(PL_curcop) : "<unknown>",
5232 CopFILE(PL_curcop), CopLINE(PL_curcop));
5233 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
5235 Perl_c_backtrace *bt = Perl_get_c_backtrace(aTHX_ 3, 3);
5236 Perl_c_backtrace_frame *frame;
5238 for (i = 0, frame = bt->frame_info;
5239 i < bt->header.frame_count;
5241 len = my_snprintf(buf, sizeof(buf),
5242 " frame[%" UVuf "]: %p %s at %s +0x%lx\n",
5245 frame->symbol_name_size && frame->symbol_name_offset ? (char *)bt + frame->symbol_name_offset : "-",
5246 frame->object_name_size && frame->object_name_offset ? (char *)bt + frame->object_name_offset : "?",
5247 (char *)frame->addr - (char *)frame->object_base_addr);
5248 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
5250 Perl_free_c_backtrace(bt);
5252 #endif /* USE_C_BACKTRACE */
5256 #endif /* !PERL_MEM_LOG_NOIMPL */
5258 #ifndef PERL_MEM_LOG_NOIMPL
5260 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
5261 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
5263 /* this is suboptimal, but bug compatible. User is providing their
5264 own implementation, but is getting these functions anyway, and they
5265 do nothing. But _NOIMPL users should be able to cope or fix */
5267 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
5268 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
5272 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
5274 const char *filename, const int linenumber,
5275 const char *funcname)
5277 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
5279 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
5280 NULL, NULL, newalloc,
5281 filename, linenumber, funcname);
5286 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
5287 Malloc_t oldalloc, Malloc_t newalloc,
5288 const char *filename, const int linenumber,
5289 const char *funcname)
5291 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
5293 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
5294 NULL, oldalloc, newalloc,
5295 filename, linenumber, funcname);
5300 Perl_mem_log_free(Malloc_t oldalloc,
5301 const char *filename, const int linenumber,
5302 const char *funcname)
5304 PERL_ARGS_ASSERT_MEM_LOG_FREE;
5306 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
5307 filename, linenumber, funcname);
5312 Perl_mem_log_new_sv(const SV *sv,
5313 const char *filename, const int linenumber,
5314 const char *funcname)
5316 PERL_ARGS_ASSERT_MEM_LOG_NEW_SV;
5318 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
5319 filename, linenumber, funcname);
5323 Perl_mem_log_del_sv(const SV *sv,
5324 const char *filename, const int linenumber,
5325 const char *funcname)
5327 PERL_ARGS_ASSERT_MEM_LOG_DEL_SV;
5329 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
5330 filename, linenumber, funcname);
5333 #endif /* PERL_MEM_LOG */
5336 =for apidoc_section $string
5337 =for apidoc quadmath_format_valid
5339 C<quadmath_snprintf()> is very strict about its C<format> string and will
5340 fail, returning -1, if the format is invalid. It accepts exactly
5343 C<quadmath_format_valid()> checks that the intended single spec looks
5344 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
5345 and has C<Q> before it. This is not a full "printf syntax check",
5348 Returns true if it is valid, false if not.
5350 See also L</quadmath_format_needed>.
5356 Perl_quadmath_format_valid(const char* format)
5360 PERL_ARGS_ASSERT_QUADMATH_FORMAT_VALID;
5362 if (format[0] != '%' || strchr(format + 1, '%'))
5364 len = strlen(format);
5365 /* minimum length three: %Qg */
5366 if (len < 3 || memCHRs("efgaEFGA", format[len - 1]) == NULL)
5368 if (format[len - 2] != 'Q')
5375 =for apidoc quadmath_format_needed
5377 C<quadmath_format_needed()> returns true if the C<format> string seems to
5378 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
5379 or returns false otherwise.
5381 The format specifier detection is not complete printf-syntax detection,
5382 but it should catch most common cases.
5384 If true is returned, those arguments B<should> in theory be processed
5385 with C<quadmath_snprintf()>, but in case there is more than one such
5386 format specifier (see L</quadmath_format_valid>), and if there is
5387 anything else beyond that one (even just a single byte), they
5388 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
5389 accepting only one format spec, and nothing else.
5390 In this case, the code should probably fail.
5396 Perl_quadmath_format_needed(const char* format)
5398 const char *p = format;
5401 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5403 while ((q = strchr(p, '%'))) {
5405 if (*q == '+') /* plus */
5407 if (*q == '#') /* alt */
5409 if (*q == '*') /* width */
5413 while (isDIGIT(*q)) q++;
5416 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5421 while (isDIGIT(*q)) q++;
5423 if (memCHRs("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5432 =for apidoc my_snprintf
5434 The C library C<snprintf> functionality, if available and
5435 standards-compliant (uses C<vsnprintf>, actually). However, if the
5436 C<vsnprintf> is not available, will unfortunately use the unsafe
5437 C<vsprintf> which can overrun the buffer (there is an overrun check,
5438 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5439 getting C<vsnprintf>.
5444 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5448 PERL_ARGS_ASSERT_MY_SNPRINTF;
5449 #ifndef HAS_VSNPRINTF
5450 PERL_UNUSED_VAR(len);
5452 va_start(ap, format);
5455 bool quadmath_valid = FALSE;
5456 if (quadmath_format_valid(format)) {
5457 /* If the format looked promising, use it as quadmath. */
5458 retval = quadmath_snprintf(buffer, len, format, va_arg(ap, NV));
5460 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5462 quadmath_valid = TRUE;
5464 /* quadmath_format_single() will return false for example for
5465 * "foo = %g", or simply "%g". We could handle the %g by
5466 * using quadmath for the NV args. More complex cases of
5467 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5468 * quadmath-valid but has stuff in front).
5470 * Handling the "Q-less" cases right would require walking
5471 * through the va_list and rewriting the format, calling
5472 * quadmath for the NVs, building a new va_list, and then
5473 * letting vsnprintf/vsprintf to take care of the other
5474 * arguments. This may be doable.
5476 * We do not attempt that now. But for paranoia, we here try
5477 * to detect some common (but not all) cases where the
5478 * "Q-less" %[efgaEFGA] formats are present, and die if
5479 * detected. This doesn't fix the problem, but it stops the
5480 * vsnprintf/vsprintf pulling doubles off the va_list when
5481 * __float128 NVs should be pulled off instead.
5483 * If quadmath_format_needed() returns false, we are reasonably
5484 * certain that we can call vnsprintf() or vsprintf() safely. */
5485 if (!quadmath_valid && quadmath_format_needed(format))
5486 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5491 #ifdef HAS_VSNPRINTF
5492 retval = vsnprintf(buffer, len, format, ap);
5494 retval = vsprintf(buffer, format, ap);
5497 /* vsprintf() shows failure with < 0 */
5499 #ifdef HAS_VSNPRINTF
5500 /* vsnprintf() shows failure with >= len */
5502 (len > 0 && (Size_t)retval >= len)
5505 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5510 =for apidoc my_vsnprintf
5512 The C library C<vsnprintf> if available and standards-compliant.
5513 However, if the C<vsnprintf> is not available, will unfortunately
5514 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5515 overrun check, but that may be too late). Consider using
5516 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5521 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5524 PERL_UNUSED_ARG(buffer);
5525 PERL_UNUSED_ARG(len);
5526 PERL_UNUSED_ARG(format);
5527 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5528 PERL_UNUSED_ARG((void*)ap);
5529 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5536 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5537 Perl_va_copy(ap, apc);
5538 # ifdef HAS_VSNPRINTF
5539 retval = vsnprintf(buffer, len, format, apc);
5541 PERL_UNUSED_ARG(len);
5542 retval = vsprintf(buffer, format, apc);
5546 # ifdef HAS_VSNPRINTF
5547 retval = vsnprintf(buffer, len, format, ap);
5549 PERL_UNUSED_ARG(len);
5550 retval = vsprintf(buffer, format, ap);
5552 #endif /* #ifdef NEED_VA_COPY */
5553 /* vsprintf() shows failure with < 0 */
5555 #ifdef HAS_VSNPRINTF
5556 /* vsnprintf() shows failure with >= len */
5558 (len > 0 && (Size_t)retval >= len)
5561 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5567 Perl_my_clearenv(pTHX)
5569 #if ! defined(PERL_MICRO)
5570 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5572 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5573 # if defined(USE_ENVIRON_ARRAY)
5574 # if defined(USE_ITHREADS)
5575 /* only the parent thread can clobber the process environment, so no need
5577 if (PL_curinterp != aTHX)
5579 # endif /* USE_ITHREADS */
5580 # if defined(HAS_CLEARENV)
5582 # elif defined(HAS_UNSETENV)
5583 int bsiz = 80; /* Most envvar names will be shorter than this. */
5584 char *buf = (char*)safesysmalloc(bsiz);
5585 while (*environ != NULL) {
5586 char *e = strchr(*environ, '=');
5587 int l = e ? e - *environ : (int)strlen(*environ);
5590 bsiz = l + 1; /* + 1 for the \0. */
5591 buf = (char*)safesysmalloc(bsiz);
5593 memcpy(buf, *environ, l);
5598 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5599 /* Just null environ and accept the leakage. */
5601 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5602 # endif /* USE_ENVIRON_ARRAY */
5603 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5604 #endif /* PERL_MICRO */
5610 =for apidoc my_cxt_init
5612 Implements the L<perlxs/C<MY_CXT_INIT>> macro, which you should use instead.
5614 The first time a module is loaded, the global C<PL_my_cxt_index> is incremented,
5615 and that value is assigned to that module's static C<my_cxt_index> (whose
5616 address is passed as an arg). Then, for each interpreter this function is
5617 called for, it makes sure a C<void*> slot is available to hang the static data
5618 off, by allocating or extending the interpreter's C<PL_my_cxt_list> array
5624 Perl_my_cxt_init(pTHX_ int *indexp, size_t size)
5629 PERL_ARGS_ASSERT_MY_CXT_INIT;
5632 /* do initial check without locking.
5633 * -1: not allocated or another thread currently allocating
5634 * other: already allocated by another thread
5637 MUTEX_LOCK(&PL_my_ctx_mutex);
5638 /*now a stricter check with locking */
5641 /* this module hasn't been allocated an index yet */
5642 *indexp = PL_my_cxt_index++;
5644 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5647 /* make sure the array is big enough */
5648 if (PL_my_cxt_size <= index) {
5649 if (PL_my_cxt_size) {
5650 IV new_size = PL_my_cxt_size;
5651 while (new_size <= index)
5653 Renew(PL_my_cxt_list, new_size, void *);
5654 PL_my_cxt_size = new_size;
5657 PL_my_cxt_size = 16;
5658 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5661 /* newSV() allocates one more than needed */
5662 p = (void*)SvPVX(newSV(size-1));
5663 PL_my_cxt_list[index] = p;
5664 Zero(p, size, char);
5668 #endif /* MULTIPLICITY */
5671 /* Perl_xs_handshake():
5672 implement the various XS_*_BOOTCHECK macros, which are added to .c
5673 files by ExtUtils::ParseXS, to check that the perl the module was built
5674 with is binary compatible with the running perl.
5677 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5678 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5680 The meaning of the varargs is determined the U32 key arg (which is not
5681 a format string). The fields of key are assembled by using HS_KEY().
5683 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5684 "PerlInterpreter *" and represents the callers context; otherwise it is
5685 of type "CV *", and is the boot xsub's CV.
5687 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5688 for example, and IO.dll was linked with threaded perl524.dll, and both
5689 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5690 successfully can load IO.dll into the process but simultaneously it
5691 loaded an interpreter of a different version into the process, and XS
5692 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5693 use through perl526.dll's my_perl->Istack_base.
5695 v_my_perl cannot be the first arg, since then 'key' will be out of
5696 place in a threaded vs non-threaded mixup; and analyzing the key
5697 number's bitfields won't reveal the problem, since it will be a valid
5698 key (unthreaded perl) on interp side, but croak will report the XS mod's
5699 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5700 it's a threaded perl and an unthreaded XS module, threaded perl will
5701 look at an uninit C stack or an uninit register to get 'key'
5702 (remember that it assumes that the 1st arg is the interp cxt).
5704 'file' is the source filename of the caller.
5708 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5714 const char *stage = "first";
5722 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5723 va_start(args, file);
5725 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5726 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5727 if (UNLIKELY(got != need))
5729 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5730 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5731 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5732 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5733 passed to the XS DLL */
5735 xs_interp = (tTHX)v_my_perl;
5739 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5740 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5741 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5742 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5743 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5744 location in the unthreaded perl binary) stored in CV * to figure out if this
5745 Perl_xs_handshake was called by the same pp_entersub */
5746 cv = (CV*)v_my_perl;
5747 xs_spp = (SV***)CvHSCXT(cv);
5749 need = &PL_stack_sp;
5752 if(UNLIKELY(got != need)) {
5753 bad_handshake:/* recycle branch and string from above */
5754 if(got != (void *)HSf_NOCHK)
5755 noperl_die("%s: loadable library and perl binaries are mismatched"
5756 " (got %s handshake key %p, needed %p)\n",
5757 file, stage, got, need);
5760 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5761 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5762 PL_xsubfilename = file; /* so the old name must be restored for
5763 additional XSUBs to register themselves */
5764 /* XSUBs can't be perl lang/perl5db.pl debugged
5765 if (PERLDB_LINE_OR_SAVESRC)
5766 (void)gv_fetchfile(file); */
5769 if(key & HSf_POPMARK) {
5771 { SV **mark = PL_stack_base + ax++;
5773 items = (I32)(SP - MARK);
5777 items = va_arg(args, U32);
5778 ax = va_arg(args, U32);
5782 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5783 if((apiverlen = HS_GETAPIVERLEN(key))) {
5784 char * api_p = va_arg(args, char*);
5785 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5786 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5787 sizeof("v" PERL_API_VERSION_STRING)-1))
5788 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5789 api_p, SVfARG(PL_stack_base[ax + 0]),
5790 "v" PERL_API_VERSION_STRING);
5795 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5796 if((xsverlen = HS_GETXSVERLEN(key)))
5797 S_xs_version_bootcheck(aTHX_
5798 items, ax, va_arg(args, char*), xsverlen);
5806 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5810 const char *vn = NULL;
5811 SV *const module = PL_stack_base[ax];
5813 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5815 if (items >= 2) /* version supplied as bootstrap arg */
5816 sv = PL_stack_base[ax + 1];
5818 /* XXX GV_ADDWARN */
5820 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5821 if (!sv || !SvOK(sv)) {
5823 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5827 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5828 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5829 ? sv : sv_2mortal(new_version(sv));
5830 xssv = upg_version(xssv, 0);
5831 if ( vcmp(pmsv,xssv) ) {
5832 SV *string = vstringify(xssv);
5833 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5834 " does not match ", SVfARG(module), SVfARG(string));
5836 SvREFCNT_dec(string);
5837 string = vstringify(pmsv);
5840 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5843 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5845 SvREFCNT_dec(string);
5847 Perl_sv_2mortal(aTHX_ xpt);
5848 Perl_croak_sv(aTHX_ xpt);
5854 =for apidoc my_strlcat
5856 The C library C<strlcat> if available, or a Perl implementation of it.
5857 This operates on C C<NUL>-terminated strings.
5859 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5860 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5861 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5862 practice this should not happen as it means that either C<size> is incorrect or
5863 that C<dst> is not a proper C<NUL>-terminated string).
5865 Note that C<size> is the full size of the destination buffer and
5866 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5867 room for the C<NUL> should be included in C<size>.
5869 The return value is the total length that C<dst> would have if C<size> is
5870 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5871 C<src>. If C<size> is smaller than the return, the excess was not appended.
5875 Description stolen from http://man.openbsd.org/strlcat.3
5879 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5881 Size_t used, length, copy;
5884 length = strlen(src);
5885 if (size > 0 && used < size - 1) {
5886 copy = (length >= size - used) ? size - used - 1 : length;
5887 memcpy(dst + used, src, copy);
5888 dst[used + copy] = '\0';
5890 return used + length;
5896 =for apidoc my_strlcpy
5898 The C library C<strlcpy> if available, or a Perl implementation of it.
5899 This operates on C C<NUL>-terminated strings.
5901 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5902 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5904 The return value is the total length C<src> would be if the copy completely
5905 succeeded. If it is larger than C<size>, the excess was not copied.
5909 Description stolen from http://man.openbsd.org/strlcpy.3
5913 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5915 Size_t length, copy;
5917 length = strlen(src);
5919 copy = (length >= size) ? size - 1 : length;
5920 memcpy(dst, src, copy);
5927 PERL_STATIC_INLINE bool
5928 S_gv_has_usable_name(pTHX_ GV *gv)
5932 && HvENAME(GvSTASH(gv))
5933 && (gvp = (GV **)hv_fetchhek(
5934 GvSTASH(gv), GvNAME_HEK(gv), 0
5940 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5942 SV * const dbsv = GvSVn(PL_DBsub);
5943 const bool save_taint = TAINT_get;
5945 /* When we are called from pp_goto (svp is null),
5946 * we do not care about using dbsv to call CV;
5947 * it's for informational purposes only.
5950 PERL_ARGS_ASSERT_GET_DB_SUB;
5954 if (!PERLDB_SUB_NN) {
5957 if (!svp && !CvLEXICAL(cv)) {
5958 gv_efullname3(dbsv, gv, NULL);
5960 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5961 || strEQ(GvNAME(gv), "END")
5962 || ( /* Could be imported, and old sub redefined. */
5963 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5965 !( (SvTYPE(*svp) == SVt_PVGV)
5966 && (GvCV((const GV *)*svp) == cv)
5967 /* Use GV from the stack as a fallback. */
5968 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5972 /* GV is potentially non-unique, or contain different CV. */
5973 SV * const tmp = newRV(MUTABLE_SV(cv));
5974 sv_setsv(dbsv, tmp);
5978 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5979 sv_catpvs(dbsv, "::");
5980 sv_cathek(dbsv, GvNAME_HEK(gv));
5984 const int type = SvTYPE(dbsv);
5985 if (type < SVt_PVIV && type != SVt_IV)
5986 sv_upgrade(dbsv, SVt_PVIV);
5987 (void)SvIOK_on(dbsv);
5988 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5991 TAINT_IF(save_taint);
5992 #ifdef NO_TAINT_SUPPORT
5993 PERL_UNUSED_VAR(save_taint);
5998 =for apidoc_section $io
5999 =for apidoc my_dirfd
6001 The C library C<L<dirfd(3)>> if available, or a Perl implementation of it, or die
6002 if not easily emulatable.
6008 Perl_my_dirfd(DIR * dir) {
6010 /* Most dirfd implementations have problems when passed NULL. */
6015 #elif defined(HAS_DIR_DD_FD)
6018 Perl_croak_nocontext(PL_no_func, "dirfd");
6019 NOT_REACHED; /* NOTREACHED */
6024 #if !defined(HAS_MKOSTEMP) || !defined(HAS_MKSTEMP)
6026 #define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
6027 #define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
6030 S_my_mkostemp(char *templte, int flags) {
6032 STRLEN len = strlen(templte);
6036 int delete_on_close = flags & O_VMS_DELETEONCLOSE;
6038 flags &= ~O_VMS_DELETEONCLOSE;
6042 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
6043 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
6044 SETERRNO(EINVAL, LIB_INVARG);
6050 for (i = 1; i <= 6; ++i) {
6051 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
6054 if (delete_on_close) {
6055 fd = open(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600, "fop=dlt");
6060 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600);
6062 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
6069 #ifndef HAS_MKOSTEMP
6072 =for apidoc my_mkostemp
6074 The C library C<L<mkostemp(3)>> if available, or a Perl implementation of it.
6080 Perl_my_mkostemp(char *templte, int flags)
6082 PERL_ARGS_ASSERT_MY_MKOSTEMP;
6083 return S_my_mkostemp(templte, flags);
6090 =for apidoc my_mkstemp
6092 The C library C<L<mkstemp(3)>> if available, or a Perl implementation of it.
6098 Perl_my_mkstemp(char *templte)
6100 PERL_ARGS_ASSERT_MY_MKSTEMP;
6101 return S_my_mkostemp(templte, 0);
6106 Perl_get_re_arg(pTHX_ SV *sv) {
6112 sv = MUTABLE_SV(SvRV(sv));
6113 if (SvTYPE(sv) == SVt_REGEXP)
6114 return (REGEXP*) sv;
6121 * This code is derived from drand48() implementation from FreeBSD,
6122 * found in lib/libc/gen/_rand48.c.
6124 * The U64 implementation is original, based on the POSIX
6125 * specification for drand48().
6129 * Copyright (c) 1993 Martin Birgmeier
6130 * All rights reserved.
6132 * You may redistribute unmodified or modified versions of this source
6133 * code provided that the above copyright notice and this and the
6134 * following conditions are retained.
6136 * This software is provided ``as is'', and comes with no warranties
6137 * of any kind. I shall in no event be liable for anything that happens
6138 * to anyone/anything when using this software.
6141 #define FREEBSD_DRAND48_SEED_0 (0x330e)
6143 #ifdef PERL_DRAND48_QUAD
6145 #define DRAND48_MULT UINT64_C(0x5deece66d)
6146 #define DRAND48_ADD 0xb
6147 #define DRAND48_MASK UINT64_C(0xffffffffffff)
6151 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
6152 #define FREEBSD_DRAND48_SEED_2 (0x1234)
6153 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
6154 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
6155 #define FREEBSD_DRAND48_MULT_2 (0x0005)
6156 #define FREEBSD_DRAND48_ADD (0x000b)
6158 const unsigned short _rand48_mult[3] = {
6159 FREEBSD_DRAND48_MULT_0,
6160 FREEBSD_DRAND48_MULT_1,
6161 FREEBSD_DRAND48_MULT_2
6163 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
6168 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
6170 PERL_ARGS_ASSERT_DRAND48_INIT_R;
6172 #ifdef PERL_DRAND48_QUAD
6173 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
6175 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
6176 random_state->seed[1] = (U16) seed;
6177 random_state->seed[2] = (U16) (seed >> 16);
6182 Perl_drand48_r(perl_drand48_t *random_state)
6184 PERL_ARGS_ASSERT_DRAND48_R;
6186 #ifdef PERL_DRAND48_QUAD
6187 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
6190 return ldexp((double)*random_state, -48);
6196 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
6197 + (U32) _rand48_add;
6198 temp[0] = (U16) accu; /* lower 16 bits */
6199 accu >>= sizeof(U16) * 8;
6200 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
6201 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
6202 temp[1] = (U16) accu; /* middle 16 bits */
6203 accu >>= sizeof(U16) * 8;
6204 accu += _rand48_mult[0] * random_state->seed[2]
6205 + _rand48_mult[1] * random_state->seed[1]
6206 + _rand48_mult[2] * random_state->seed[0];
6207 random_state->seed[0] = temp[0];
6208 random_state->seed[1] = temp[1];
6209 random_state->seed[2] = (U16) accu;
6211 return ldexp((double) random_state->seed[0], -48) +
6212 ldexp((double) random_state->seed[1], -32) +
6213 ldexp((double) random_state->seed[2], -16);
6218 #ifdef USE_C_BACKTRACE
6220 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
6225 /* abfd is the BFD handle. */
6227 /* bfd_syms is the BFD symbol table. */
6229 /* bfd_text is handle to the the ".text" section of the object file. */
6231 /* Since opening the executable and scanning its symbols is quite
6232 * heavy operation, we remember the filename we used the last time,
6233 * and do the opening and scanning only if the filename changes.
6234 * This removes most (but not all) open+scan cycles. */
6235 const char* fname_prev;
6238 /* Given a dl_info, update the BFD context if necessary. */
6239 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
6241 /* BFD open and scan only if the filename changed. */
6242 if (ctx->fname_prev == NULL ||
6243 strNE(dl_info->dli_fname, ctx->fname_prev)) {
6245 bfd_close(ctx->abfd);
6247 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
6249 if (bfd_check_format(ctx->abfd, bfd_object)) {
6250 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
6251 if (symbol_size > 0) {
6252 Safefree(ctx->bfd_syms);
6253 Newx(ctx->bfd_syms, symbol_size, asymbol*);
6255 bfd_get_section_by_name(ctx->abfd, ".text");
6263 ctx->fname_prev = dl_info->dli_fname;
6267 /* Given a raw frame, try to symbolize it and store
6268 * symbol information (source file, line number) away. */
6269 static void bfd_symbolize(bfd_context* ctx,
6272 STRLEN* symbol_name_size,
6274 STRLEN* source_name_size,
6275 STRLEN* source_line)
6277 *symbol_name = NULL;
6278 *symbol_name_size = 0;
6280 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
6282 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
6285 unsigned int line = 0;
6286 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
6287 ctx->bfd_syms, offset,
6288 &file, &func, &line) &&
6289 file && func && line > 0) {
6290 /* Size and copy the source file, use only
6291 * the basename of the source file.
6293 * NOTE: the basenames are fine for the
6294 * Perl source files, but may not always
6295 * be the best idea for XS files. */
6296 const char *p, *b = NULL;
6297 /* Look for the last slash. */
6298 for (p = file; *p; p++) {
6302 if (b == NULL || *b == 0) {
6305 *source_name_size = p - b + 1;
6306 Newx(*source_name, *source_name_size + 1, char);
6307 Copy(b, *source_name, *source_name_size + 1, char);
6309 *symbol_name_size = strlen(func);
6310 Newx(*symbol_name, *symbol_name_size + 1, char);
6311 Copy(func, *symbol_name, *symbol_name_size + 1, char);
6313 *source_line = line;
6319 #endif /* #ifdef USE_BFD */
6323 /* OS X has no public API for for 'symbolicating' (Apple official term)
6324 * stack addresses to {function_name, source_file, line_number}.
6325 * Good news: there is command line utility atos(1) which does that.
6326 * Bad news 1: it's a command line utility.
6327 * Bad news 2: one needs to have the Developer Tools installed.
6328 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
6330 * To recap: we need to open a pipe for reading for a utility which
6331 * might not exist, or exists in different locations, and then parse
6332 * the output. And since this is all for a low-level API, we cannot
6333 * use high-level stuff. Thanks, Apple. */
6336 /* tool is set to the absolute pathname of the tool to use:
6339 /* format is set to a printf format string used for building
6340 * the external command to run. */
6342 /* unavail is set if e.g. xcrun cannot be found, or something
6343 * else happens that makes getting the backtrace dubious. Note,
6344 * however, that the context isn't persistent, the next call to
6345 * get_c_backtrace() will start from scratch. */
6347 /* fname is the current object file name. */
6349 /* object_base_addr is the base address of the shared object. */
6350 void* object_base_addr;
6353 /* Given |dl_info|, updates the context. If the context has been
6354 * marked unavailable, return immediately. If not but the tool has
6355 * not been set, set it to either "xcrun atos" or "atos" (also set the
6356 * format to use for creating commands for piping), or if neither is
6357 * unavailable (one needs the Developer Tools installed), mark the context
6358 * an unavailable. Finally, update the filename (object name),
6359 * and its base address. */
6361 static void atos_update(atos_context* ctx,
6366 if (ctx->tool == NULL) {
6367 const char* tools[] = {
6371 const char* formats[] = {
6372 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6373 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6377 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6378 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6379 ctx->tool = tools[i];
6380 ctx->format = formats[i];
6384 if (ctx->tool == NULL) {
6385 ctx->unavail = TRUE;
6389 if (ctx->fname == NULL ||
6390 strNE(dl_info->dli_fname, ctx->fname)) {
6391 ctx->fname = dl_info->dli_fname;
6392 ctx->object_base_addr = dl_info->dli_fbase;
6396 /* Given an output buffer end |p| and its |start|, matches
6397 * for the atos output, extracting the source code location
6398 * and returning non-NULL if possible, returning NULL otherwise. */
6399 static const char* atos_parse(const char* p,
6401 STRLEN* source_name_size,
6402 STRLEN* source_line) {
6403 /* atos() output is something like:
6404 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6405 * We cannot use Perl regular expressions, because we need to
6406 * stay low-level. Therefore here we have a rolled-out version
6407 * of a state machine which matches _backwards_from_the_end_ and
6408 * if there's a success, returns the starts of the filename,
6409 * also setting the filename size and the source line number.
6410 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6411 const char* source_number_start;
6412 const char* source_name_end;
6413 const char* source_line_end = start;
6414 const char* close_paren;
6417 /* Skip trailing whitespace. */
6418 while (p > start && isSPACE(*p)) p--;
6419 /* Now we should be at the close paren. */
6420 if (p == start || *p != ')')
6424 /* Now we should be in the line number. */
6425 if (p == start || !isDIGIT(*p))
6427 /* Skip over the digits. */
6428 while (p > start && isDIGIT(*p))
6430 /* Now we should be at the colon. */
6431 if (p == start || *p != ':')
6433 source_number_start = p + 1;
6434 source_name_end = p; /* Just beyond the end. */
6436 /* Look for the open paren. */
6437 while (p > start && *p != '(')
6442 *source_name_size = source_name_end - p;
6443 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6444 && source_line_end == close_paren
6445 && uv <= PERL_INT_MAX
6447 *source_line = (STRLEN)uv;
6453 /* Given a raw frame, read a pipe from the symbolicator (that's the
6454 * technical term) atos, reads the result, and parses the source code
6455 * location. We must stay low-level, so we use snprintf(), pipe(),
6456 * and fread(), and then also parse the output ourselves. */
6457 static void atos_symbolize(atos_context* ctx,
6460 STRLEN* source_name_size,
6461 STRLEN* source_line)
6469 /* Simple security measure: if there's any funny business with
6470 * the object name (used as "-o '%s'" ), leave since at least
6471 * partially the user controls it. */
6472 for (p = ctx->fname; *p; p++) {
6473 if (*p == '\'' || isCNTRL(*p)) {
6474 ctx->unavail = TRUE;
6478 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6479 ctx->fname, ctx->object_base_addr, raw_frame);
6480 if (cnt < sizeof(cmd)) {
6481 /* Undo nostdio.h #defines that disable stdio.
6482 * This is somewhat naughty, but is used elsewhere
6483 * in the core, and affects only OS X. */
6488 FILE* fp = popen(cmd, "r");
6489 /* At the moment we open a new pipe for each stack frame.
6490 * This is naturally somewhat slow, but hopefully generating
6491 * stack traces is never going to in a performance critical path.
6493 * We could play tricks with atos by batching the stack
6494 * addresses to be resolved: atos can either take multiple
6495 * addresses from the command line, or read addresses from
6496 * a file (though the mess of creating temporary files would
6497 * probably negate much of any possible speedup).
6499 * Normally there are only two objects present in the backtrace:
6500 * perl itself, and the libdyld.dylib. (Note that the object
6501 * filenames contain the full pathname, so perl may not always
6502 * be in the same place.) Whenever the object in the
6503 * backtrace changes, the base address also changes.
6505 * The problem with batching the addresses, though, would be
6506 * matching the results with the addresses: the parsing of
6507 * the results is already painful enough with a single address. */
6510 UV cnt = fread(out, 1, sizeof(out), fp);
6511 if (cnt < sizeof(out)) {
6512 const char* p = atos_parse(out + cnt - 1, out,
6517 *source_name_size, char);
6518 Copy(p, *source_name,
6519 *source_name_size, char);
6527 #endif /* #ifdef PERL_DARWIN */
6530 =for apidoc_section $debugging
6531 =for apidoc get_c_backtrace
6533 Collects the backtrace (aka "stacktrace") into a single linear
6534 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6536 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6537 returning at most C<depth> frames.
6543 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6545 /* Note that here we must stay as low-level as possible: Newx(),
6546 * Copy(), Safefree(); since we may be called from anywhere,
6547 * so we should avoid higher level constructs like SVs or AVs.
6549 * Since we are using safesysmalloc() via Newx(), don't try
6550 * getting backtrace() there, unless you like deep recursion. */
6552 /* Currently only implemented with backtrace() and dladdr(),
6553 * for other platforms NULL is returned. */
6555 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6556 /* backtrace() is available via <execinfo.h> in glibc and in most
6557 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6559 /* We try fetching this many frames total, but then discard
6560 * the |skip| first ones. For the remaining ones we will try
6561 * retrieving more information with dladdr(). */
6562 int try_depth = skip + depth;
6564 /* The addresses (program counters) returned by backtrace(). */
6567 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6570 /* Sizes _including_ the terminating \0 of the object name
6571 * and symbol name strings. */
6572 STRLEN* object_name_sizes;
6573 STRLEN* symbol_name_sizes;
6576 /* The symbol names comes either from dli_sname,
6577 * or if using BFD, they can come from BFD. */
6578 char** symbol_names;
6581 /* The source code location information. Dug out with e.g. BFD. */
6582 char** source_names;
6583 STRLEN* source_name_sizes;
6584 STRLEN* source_lines;
6586 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6587 int got_depth; /* How many frames were returned from backtrace(). */
6588 UV frame_count = 0; /* How many frames we return. */
6589 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6592 bfd_context bfd_ctx;
6595 atos_context atos_ctx;
6598 /* Here are probably possibilities for optimizing. We could for
6599 * example have a struct that contains most of these and then
6600 * allocate |try_depth| of them, saving a bunch of malloc calls.
6601 * Note, however, that |frames| could not be part of that struct
6602 * because backtrace() will want an array of just them. Also be
6603 * careful about the name strings. */
6604 Newx(raw_frames, try_depth, void*);
6605 Newx(dl_infos, try_depth, Dl_info);
6606 Newx(object_name_sizes, try_depth, STRLEN);
6607 Newx(symbol_name_sizes, try_depth, STRLEN);
6608 Newx(source_names, try_depth, char*);
6609 Newx(source_name_sizes, try_depth, STRLEN);
6610 Newx(source_lines, try_depth, STRLEN);
6612 Newx(symbol_names, try_depth, char*);
6615 /* Get the raw frames. */
6616 got_depth = (int)backtrace(raw_frames, try_depth);
6618 /* We use dladdr() instead of backtrace_symbols() because we want
6619 * the full details instead of opaque strings. This is useful for
6620 * two reasons: () the details are needed for further symbolic
6621 * digging, for example in OS X (2) by having the details we fully
6622 * control the output, which in turn is useful when more platforms
6623 * are added: we can keep out output "portable". */
6625 /* We want a single linear allocation, which can then be freed
6626 * with a single swoop. We will do the usual trick of first
6627 * walking over the structure and seeing how much we need to
6628 * allocate, then allocating, and then walking over the structure
6629 * the second time and populating it. */
6631 /* First we must compute the total size of the buffer. */
6632 total_bytes = sizeof(Perl_c_backtrace_header);
6633 if (got_depth > skip) {
6636 bfd_init(); /* Is this safe to call multiple times? */
6637 Zero(&bfd_ctx, 1, bfd_context);
6640 Zero(&atos_ctx, 1, atos_context);
6642 for (i = skip; i < try_depth; i++) {
6643 Dl_info* dl_info = &dl_infos[i];
6645 object_name_sizes[i] = 0;
6646 source_names[i] = NULL;
6647 source_name_sizes[i] = 0;
6648 source_lines[i] = 0;
6650 /* Yes, zero from dladdr() is failure. */
6651 if (dladdr(raw_frames[i], dl_info)) {
6652 total_bytes += sizeof(Perl_c_backtrace_frame);
6654 object_name_sizes[i] =
6655 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6656 symbol_name_sizes[i] =
6657 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6659 bfd_update(&bfd_ctx, dl_info);
6660 bfd_symbolize(&bfd_ctx, raw_frames[i],
6662 &symbol_name_sizes[i],
6664 &source_name_sizes[i],
6668 atos_update(&atos_ctx, dl_info);
6669 atos_symbolize(&atos_ctx,
6672 &source_name_sizes[i],
6676 /* Plus ones for the terminating \0. */
6677 total_bytes += object_name_sizes[i] + 1;
6678 total_bytes += symbol_name_sizes[i] + 1;
6679 total_bytes += source_name_sizes[i] + 1;
6687 Safefree(bfd_ctx.bfd_syms);
6691 /* Now we can allocate and populate the result buffer. */
6692 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6693 Zero(bt, total_bytes, char);
6694 bt->header.frame_count = frame_count;
6695 bt->header.total_bytes = total_bytes;
6696 if (frame_count > 0) {
6697 Perl_c_backtrace_frame* frame = bt->frame_info;
6698 char* name_base = (char *)(frame + frame_count);
6699 char* name_curr = name_base; /* Outputting the name strings here. */
6701 for (i = skip; i < skip + frame_count; i++) {
6702 Dl_info* dl_info = &dl_infos[i];
6704 frame->addr = raw_frames[i];
6705 frame->object_base_addr = dl_info->dli_fbase;
6706 frame->symbol_addr = dl_info->dli_saddr;
6708 /* Copies a string, including the \0, and advances the name_curr.
6709 * Also copies the start and the size to the frame. */
6710 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6712 Copy(src, name_curr, size, char); \
6713 frame->doffset = name_curr - (char*)bt; \
6714 frame->dsize = size; \
6715 name_curr += size; \
6718 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6720 object_name_size, object_name_sizes[i]);
6723 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6725 symbol_name_size, symbol_name_sizes[i]);
6726 Safefree(symbol_names[i]);
6728 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6730 symbol_name_size, symbol_name_sizes[i]);
6733 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6735 source_name_size, source_name_sizes[i]);
6736 Safefree(source_names[i]);
6738 #undef PERL_C_BACKTRACE_STRCPY
6740 frame->source_line_number = source_lines[i];
6744 assert(total_bytes ==
6745 (UV)(sizeof(Perl_c_backtrace_header) +
6746 frame_count * sizeof(Perl_c_backtrace_frame) +
6747 name_curr - name_base));
6750 Safefree(symbol_names);
6752 bfd_close(bfd_ctx.abfd);
6755 Safefree(source_lines);
6756 Safefree(source_name_sizes);
6757 Safefree(source_names);
6758 Safefree(symbol_name_sizes);
6759 Safefree(object_name_sizes);
6760 /* Assuming the strings returned by dladdr() are pointers
6761 * to read-only static memory (the object file), so that
6762 * they do not need freeing (and cannot be). */
6764 Safefree(raw_frames);
6767 PERL_UNUSED_ARG(depth);
6768 PERL_UNUSED_ARG(skip);
6774 =for apidoc free_c_backtrace
6776 Deallocates a backtrace received from get_c_backtrace.
6782 =for apidoc get_c_backtrace_dump
6784 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6785 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6787 The appended output looks like:
6790 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6791 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6794 The fields are tab-separated. The first column is the depth (zero
6795 being the innermost non-skipped frame). In the hex:offset, the hex is
6796 where the program counter was in C<S_parse_body>, and the :offset (might
6797 be missing) tells how much inside the C<S_parse_body> the program counter was.
6799 The C<util.c:1716> is the source code file and line number.
6801 The F</usr/bin/perl> is obvious (hopefully).
6803 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6804 if the platform doesn't support retrieving the information;
6805 if the binary is missing the debug information;
6806 if the optimizer has transformed the code by for example inlining.
6812 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6814 Perl_c_backtrace* bt;
6816 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6818 Perl_c_backtrace_frame* frame;
6819 SV* dsv = newSVpvs("");
6821 for (i = 0, frame = bt->frame_info;
6822 i < bt->header.frame_count; i++, frame++) {
6823 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6824 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6825 /* Symbol (function) names might disappear without debug info.
6827 * The source code location might disappear in case of the
6828 * optimizer inlining or otherwise rearranging the code. */
6829 if (frame->symbol_addr) {
6830 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6832 ((char*)frame->addr - (char*)frame->symbol_addr));
6834 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6835 frame->symbol_name_size &&
6836 frame->symbol_name_offset ?
6837 (char*)bt + frame->symbol_name_offset : "-");
6838 if (frame->source_name_size &&
6839 frame->source_name_offset &&
6840 frame->source_line_number) {
6841 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6842 (char*)bt + frame->source_name_offset,
6843 (UV)frame->source_line_number);
6845 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6847 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6848 frame->object_name_size &&
6849 frame->object_name_offset ?
6850 (char*)bt + frame->object_name_offset : "-");
6851 /* The frame->object_base_addr is not output,
6852 * but it is used for symbolizing/symbolicating. */
6853 sv_catpvs(dsv, "\n");
6856 Perl_free_c_backtrace(bt);
6865 =for apidoc dump_c_backtrace
6867 Dumps the C backtrace to the given C<fp>.
6869 Returns true if a backtrace could be retrieved, false if not.
6875 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6879 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6881 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6884 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6890 #endif /* #ifdef USE_C_BACKTRACE */
6892 #if defined(USE_ITHREADS) && defined(I_PTHREAD)
6894 /* pthread_mutex_t and perl_mutex are typedef equivalent
6895 * so casting the pointers is fine. */
6897 int perl_tsa_mutex_lock(perl_mutex* mutex)
6899 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6902 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6904 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6907 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6909 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6916 /* log a sub call or return */
6919 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6927 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6930 HEK *hek = CvNAME_HEK(cv);
6931 func = HEK_KEY(hek);
6937 start = (const COP *)CvSTART(cv);
6938 file = CopFILE(start);
6939 line = CopLINE(start);
6940 stash = CopSTASHPV(start);
6943 PERL_SUB_ENTRY(func, file, line, stash);
6946 PERL_SUB_RETURN(func, file, line, stash);
6951 /* log a require file loading/loaded */
6954 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6956 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6959 PERL_LOADING_FILE(name);
6962 PERL_LOADED_FILE(name);
6967 /* log an op execution */
6970 Perl_dtrace_probe_op(pTHX_ const OP *op)
6972 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6974 PERL_OP_ENTRY(OP_NAME(op));
6978 /* log a compile/run phase change */
6981 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6983 const char *ph_old = PL_phase_names[PL_phase];
6984 const char *ph_new = PL_phase_names[phase];
6986 PERL_PHASE_CHANGE(ph_new, ph_old);
6992 * ex: set ts=8 sts=4 sw=4 et: