3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * 'Very useful, no doubt, that was to Saruman; yet it seems that he was
13 * not content.' --Gandalf to Pippin
15 * [p.598 of _The Lord of the Rings_, III/xi: "The PalantÃr"]
18 /* This file contains assorted utility routines.
19 * Which is a polite way of saying any stuff that people couldn't think of
20 * a better place for. Amongst other things, it includes the warning and
21 * dieing stuff, plus wrappers for malloc code.
25 #define PERL_IN_UTIL_C
29 #if defined(USE_PERLIO)
30 #include "perliol.h" /* For PerlIOUnix_refcnt */
36 # define SIG_ERR ((Sighandler_t) -1)
44 /* Missing protos on LynxOS */
49 # include "amigaos4/amigaio.h"
54 # include <sys/select.h>
58 #ifdef USE_C_BACKTRACE
62 # undef USE_BFD /* BFD is useless in OS X. */
72 # include <execinfo.h>
76 #ifdef PERL_DEBUG_READONLY_COW
77 # include <sys/mman.h>
82 /* NOTE: Do not call the next three routines directly. Use the macros
83 * in handy.h, so that we can easily redefine everything to do tracking of
84 * allocated hunks back to the original New to track down any memory leaks.
85 * XXX This advice seems to be widely ignored :-( --AD August 1996.
88 #if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
89 # define ALWAYS_NEED_THX
92 #if defined(PERL_TRACK_MEMPOOL) && defined(PERL_DEBUG_READONLY_COW)
94 S_maybe_protect_rw(pTHX_ struct perl_memory_debug_header *header)
97 && mprotect(header, header->size, PROT_READ|PROT_WRITE))
98 Perl_warn(aTHX_ "mprotect for COW string %p %lu failed with %d",
99 header, header->size, errno);
103 S_maybe_protect_ro(pTHX_ struct perl_memory_debug_header *header)
106 && mprotect(header, header->size, PROT_READ))
107 Perl_warn(aTHX_ "mprotect RW for COW string %p %lu failed with %d",
108 header, header->size, errno);
110 # define maybe_protect_rw(foo) S_maybe_protect_rw(aTHX_ foo)
111 # define maybe_protect_ro(foo) S_maybe_protect_ro(aTHX_ foo)
113 # define maybe_protect_rw(foo) NOOP
114 # define maybe_protect_ro(foo) NOOP
117 #if defined(PERL_TRACK_MEMPOOL) || defined(PERL_DEBUG_READONLY_COW)
118 /* Use memory_debug_header */
120 # if (defined(PERL_POISON) && defined(PERL_TRACK_MEMPOOL)) \
121 || defined(PERL_DEBUG_READONLY_COW)
122 # define MDH_HAS_SIZE
126 /* paranoid version of system's malloc() */
129 Perl_safesysmalloc(MEM_SIZE size)
131 #ifdef ALWAYS_NEED_THX
138 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
140 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
143 if ((SSize_t)size < 0)
144 Perl_croak_nocontext("panic: malloc, size=%" UVuf, (UV) size);
146 if (!size) size = 1; /* malloc(0) is NASTY on our system */
148 #ifdef PERL_DEBUG_READONLY_COW
149 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
150 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
151 perror("mmap failed");
155 ptr = (Malloc_t)PerlMem_malloc(size);
157 PERL_ALLOC_CHECK(ptr);
160 struct perl_memory_debug_header *const header
161 = (struct perl_memory_debug_header *)ptr;
165 PoisonNew(((char *)ptr), size, char);
168 #ifdef PERL_TRACK_MEMPOOL
169 header->interpreter = aTHX;
170 /* Link us into the list. */
171 header->prev = &PL_memory_debug_header;
172 header->next = PL_memory_debug_header.next;
173 PL_memory_debug_header.next = header;
174 maybe_protect_rw(header->next);
175 header->next->prev = header;
176 maybe_protect_ro(header->next);
177 # ifdef PERL_DEBUG_READONLY_COW
178 header->readonly = 0;
184 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
185 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
187 /* malloc() can modify errno() even on success, but since someone
188 writing perl code doesn't have any control over when perl calls
189 malloc() we need to hide that.
198 #ifndef ALWAYS_NEED_THX
210 /* paranoid version of system's realloc() */
213 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
215 #ifdef ALWAYS_NEED_THX
219 #ifdef PERL_DEBUG_READONLY_COW
220 const MEM_SIZE oldsize = where
221 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
230 ptr = safesysmalloc(size);
235 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
236 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
238 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
240 struct perl_memory_debug_header *const header
241 = (struct perl_memory_debug_header *)where;
243 # ifdef PERL_TRACK_MEMPOOL
244 if (header->interpreter != aTHX) {
245 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
246 header->interpreter, aTHX);
248 assert(header->next->prev == header);
249 assert(header->prev->next == header);
251 if (header->size > size) {
252 const MEM_SIZE freed_up = header->size - size;
253 char *start_of_freed = ((char *)where) + size;
254 PoisonFree(start_of_freed, freed_up, char);
264 if ((SSize_t)size < 0)
265 Perl_croak_nocontext("panic: realloc, size=%" UVuf, (UV)size);
267 #ifdef PERL_DEBUG_READONLY_COW
268 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
269 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
270 perror("mmap failed");
273 Copy(where,ptr,oldsize < size ? oldsize : size,char);
274 if (munmap(where, oldsize)) {
275 perror("munmap failed");
279 ptr = (Malloc_t)PerlMem_realloc(where,size);
281 PERL_ALLOC_CHECK(ptr);
283 /* MUST do this fixup first, before doing ANYTHING else, as anything else
284 might allocate memory/free/move memory, and until we do the fixup, it
285 may well be chasing (and writing to) free memory. */
287 #ifdef PERL_TRACK_MEMPOOL
288 struct perl_memory_debug_header *const header
289 = (struct perl_memory_debug_header *)ptr;
292 if (header->size < size) {
293 const MEM_SIZE fresh = size - header->size;
294 char *start_of_fresh = ((char *)ptr) + size;
295 PoisonNew(start_of_fresh, fresh, char);
299 maybe_protect_rw(header->next);
300 header->next->prev = header;
301 maybe_protect_ro(header->next);
302 maybe_protect_rw(header->prev);
303 header->prev->next = header;
304 maybe_protect_ro(header->prev);
306 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
308 /* realloc() can modify errno() even on success, but since someone
309 writing perl code doesn't have any control over when perl calls
310 realloc() we need to hide that.
315 /* In particular, must do that fixup above before logging anything via
316 *printf(), as it can reallocate memory, which can cause SEGVs. */
318 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
319 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
326 #ifndef ALWAYS_NEED_THX
339 /* safe version of system's free() */
342 Perl_safesysfree(Malloc_t where)
344 #ifdef ALWAYS_NEED_THX
347 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
350 Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
352 struct perl_memory_debug_header *const header
353 = (struct perl_memory_debug_header *)where_intrn;
356 const MEM_SIZE size = header->size;
358 # ifdef PERL_TRACK_MEMPOOL
359 if (header->interpreter != aTHX) {
360 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
361 header->interpreter, aTHX);
364 Perl_croak_nocontext("panic: duplicate free");
367 Perl_croak_nocontext("panic: bad free, header->next==NULL");
368 if (header->next->prev != header || header->prev->next != header) {
369 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
370 "header=%p, ->prev->next=%p",
371 header->next->prev, header,
374 /* Unlink us from the chain. */
375 maybe_protect_rw(header->next);
376 header->next->prev = header->prev;
377 maybe_protect_ro(header->next);
378 maybe_protect_rw(header->prev);
379 header->prev->next = header->next;
380 maybe_protect_ro(header->prev);
381 maybe_protect_rw(header);
383 PoisonNew(where_intrn, size, char);
385 /* Trigger the duplicate free warning. */
388 # ifdef PERL_DEBUG_READONLY_COW
389 if (munmap(where_intrn, size)) {
390 perror("munmap failed");
396 Malloc_t where_intrn = where;
398 #ifndef PERL_DEBUG_READONLY_COW
399 PerlMem_free(where_intrn);
404 /* safe version of system's calloc() */
407 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
409 #ifdef ALWAYS_NEED_THX
413 #if defined(USE_MDH) || defined(DEBUGGING)
414 MEM_SIZE total_size = 0;
417 /* Even though calloc() for zero bytes is strange, be robust. */
418 if (size && (count <= MEM_SIZE_MAX / size)) {
419 #if defined(USE_MDH) || defined(DEBUGGING)
420 total_size = size * count;
426 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
427 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
432 if ((SSize_t)size < 0 || (SSize_t)count < 0)
433 Perl_croak_nocontext("panic: calloc, size=%" UVuf ", count=%" UVuf,
434 (UV)size, (UV)count);
436 #ifdef PERL_DEBUG_READONLY_COW
437 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
438 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
439 perror("mmap failed");
442 #elif defined(PERL_TRACK_MEMPOOL)
443 /* Have to use malloc() because we've added some space for our tracking
445 /* malloc(0) is non-portable. */
446 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
448 /* Use calloc() because it might save a memset() if the memory is fresh
449 and clean from the OS. */
451 ptr = (Malloc_t)PerlMem_calloc(count, size);
452 else /* calloc(0) is non-portable. */
453 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
455 PERL_ALLOC_CHECK(ptr);
456 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%" UVxf ": (%05ld) calloc %zu x %zu = %zu bytes\n",PTR2UV(ptr),(long)PL_an++, count, size, total_size));
460 struct perl_memory_debug_header *const header
461 = (struct perl_memory_debug_header *)ptr;
463 # ifndef PERL_DEBUG_READONLY_COW
464 memset((void*)ptr, 0, total_size);
466 # ifdef PERL_TRACK_MEMPOOL
467 header->interpreter = aTHX;
468 /* Link us into the list. */
469 header->prev = &PL_memory_debug_header;
470 header->next = PL_memory_debug_header.next;
471 PL_memory_debug_header.next = header;
472 maybe_protect_rw(header->next);
473 header->next->prev = header;
474 maybe_protect_ro(header->next);
475 # ifdef PERL_DEBUG_READONLY_COW
476 header->readonly = 0;
480 header->size = total_size;
482 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
488 #ifndef ALWAYS_NEED_THX
497 /* These must be defined when not using Perl's malloc for binary
502 Malloc_t Perl_malloc (MEM_SIZE nbytes)
504 #ifdef PERL_IMPLICIT_SYS
507 return (Malloc_t)PerlMem_malloc(nbytes);
510 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
512 #ifdef PERL_IMPLICIT_SYS
515 return (Malloc_t)PerlMem_calloc(elements, size);
518 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
520 #ifdef PERL_IMPLICIT_SYS
523 return (Malloc_t)PerlMem_realloc(where, nbytes);
526 Free_t Perl_mfree (Malloc_t where)
528 #ifdef PERL_IMPLICIT_SYS
536 /* This is the value stored in *retlen in the two delimcpy routines below when
537 * there wasn't enough room in the destination to store everything it was asked
538 * to. The value is deliberately very large so that hopefully if code uses it
539 * unquestioninly to access memory, it will likely segfault. And it is small
540 * enough that if the caller does some arithmetic on it before accessing, it
541 * won't overflow into a small legal number. */
542 #define DELIMCPY_OUT_OF_BOUNDS_RET I32_MAX
545 =for apidoc_section $string
546 =for apidoc delimcpy_no_escape
548 Copy a source buffer to a destination buffer, stopping at (but not including)
549 the first occurrence in the source of the delimiter byte, C<delim>. The source
550 is the bytes between S<C<from> and C<from_end> - 1>. Similarly, the dest is
551 C<to> up to C<to_end>.
553 The number of bytes copied is written to C<*retlen>.
555 Returns the position of C<delim> in the C<from> buffer, but if there is no
556 such occurrence before C<from_end>, then C<from_end> is returned, and the entire
557 buffer S<C<from> .. C<from_end> - 1> is copied.
559 If there is room in the destination available after the copy, an extra
560 terminating safety C<NUL> byte is appended (not included in the returned
563 The error case is if the destination buffer is not large enough to accommodate
564 everything that should be copied. In this situation, a value larger than
565 S<C<to_end> - C<to>> is written to C<*retlen>, and as much of the source as
566 fits will be written to the destination. Not having room for the safety C<NUL>
567 is not considered an error.
572 Perl_delimcpy_no_escape(char *to, const char *to_end,
573 const char *from, const char *from_end,
574 const int delim, I32 *retlen)
576 const char * delim_pos;
577 Ptrdiff_t from_len = from_end - from;
578 Ptrdiff_t to_len = to_end - to;
581 PERL_ARGS_ASSERT_DELIMCPY_NO_ESCAPE;
583 assert(from_len >= 0);
586 /* Look for the first delimiter in the source */
587 delim_pos = (const char *) memchr(from, delim, from_len);
589 /* Copy up to where the delimiter was found, or the entire buffer if not
591 copy_len = (delim_pos) ? delim_pos - from : from_len;
593 /* If not enough room, copy as much as can fit, and set error return */
594 if (copy_len > to_len) {
595 Copy(from, to, to_len, char);
596 *retlen = DELIMCPY_OUT_OF_BOUNDS_RET;
599 Copy(from, to, copy_len, char);
601 /* If there is extra space available, add a trailing NUL */
602 if (copy_len < to_len) {
609 return (char *) from + copy_len;
615 Copy a source buffer to a destination buffer, stopping at (but not including)
616 the first occurrence in the source of an unescaped (defined below) delimiter
617 byte, C<delim>. The source is the bytes between S<C<from> and C<from_end> -
618 1>. Similarly, the dest is C<to> up to C<to_end>.
620 The number of bytes copied is written to C<*retlen>.
622 Returns the position of the first uncopied C<delim> in the C<from> buffer, but
623 if there is no such occurrence before C<from_end>, then C<from_end> is returned,
624 and the entire buffer S<C<from> .. C<from_end> - 1> is copied.
626 If there is room in the destination available after the copy, an extra
627 terminating safety C<NUL> byte is appended (not included in the returned
630 The error case is if the destination buffer is not large enough to accommodate
631 everything that should be copied. In this situation, a value larger than
632 S<C<to_end> - C<to>> is written to C<*retlen>, and as much of the source as
633 fits will be written to the destination. Not having room for the safety C<NUL>
634 is not considered an error.
636 In the following examples, let C<x> be the delimiter, and C<0> represent a C<NUL>
637 byte (B<NOT> the digit C<0>). Then we would have
642 provided the destination buffer is at least 4 bytes long.
644 An escaped delimiter is one which is immediately preceded by a single
645 backslash. Escaped delimiters are copied, and the copy continues past the
646 delimiter; the backslash is not copied:
651 (provided the destination buffer is at least 8 bytes long).
653 It's actually somewhat more complicated than that. A sequence of any odd number
654 of backslashes escapes the following delimiter, and the copy continues with
655 exactly one of the backslashes stripped.
659 abc\\\xdef abc\\xdef0
660 abc\\\\\xdef abc\\\\xdef0
662 (as always, if the destination is large enough)
664 An even number of preceding backslashes does not escape the delimiter, so that
665 the copy stops just before it, and includes all the backslashes (no stripping;
666 zero is considered even):
677 Perl_delimcpy(char *to, const char *to_end,
678 const char *from, const char *from_end,
679 const int delim, I32 *retlen)
681 const char * const orig_to = to;
682 Ptrdiff_t copy_len = 0;
683 bool stopped_early = FALSE; /* Ran out of room to copy to */
685 PERL_ARGS_ASSERT_DELIMCPY;
686 assert(from_end >= from);
687 assert(to_end >= to);
689 /* Don't use the loop for the trivial case of the first character being the
690 * delimiter; otherwise would have to worry inside the loop about backing
691 * up before the start of 'from' */
692 if (LIKELY(from_end > from && *from != delim)) {
693 while ((copy_len = from_end - from) > 0) {
694 const char * backslash_pos;
695 const char * delim_pos;
697 /* Look for the next delimiter in the remaining portion of the
698 * source. A loop invariant is that we already know that the copy
699 * should include *from; this comes from the conditional before the
700 * loop, and how we set things up at the end of each iteration */
701 delim_pos = (const char *) memchr(from + 1, delim, copy_len - 1);
703 /* If didn't find it, done looking; set up so copies all of the
706 copy_len = from_end - from;
710 /* Look for a backslash immediately before the delimiter */
711 backslash_pos = delim_pos - 1;
713 /* If the delimiter is not escaped, this ends the copy */
714 if (*backslash_pos != '\\') {
715 copy_len = delim_pos - from;
719 /* Here there is a backslash just before the delimiter, but it
720 * could be the final backslash in a sequence of them. Backup to
721 * find the first one in it. */
725 while (backslash_pos >= from && *backslash_pos == '\\');
727 /* If the number of backslashes is even, they just escape one
728 * another, leaving the delimiter unescaped, and stopping the copy.
730 if (! ((delim_pos - (backslash_pos + 1)) & 1)) {
731 copy_len = delim_pos - from; /* even, copy up to delimiter */
735 /* Here is odd, so the delimiter is escaped. We will try to copy
736 * all but the final backslash in the sequence */
737 copy_len = delim_pos - 1 - from;
739 /* Do the copy, but not beyond the end of the destination */
740 if (copy_len >= to_end - to) {
741 Copy(from, to, to_end - to, char);
742 stopped_early = TRUE;
743 to = (char *) to_end;
746 Copy(from, to, copy_len, char);
750 /* Set up so next iteration will include the delimiter */
755 /* Here, have found the final segment to copy. Copy that, but not beyond
756 * the size of the destination. If not enough room, copy as much as can
757 * fit, and set error return */
758 if (stopped_early || copy_len > to_end - to) {
759 Copy(from, to, to_end - to, char);
760 *retlen = DELIMCPY_OUT_OF_BOUNDS_RET;
763 Copy(from, to, copy_len, char);
767 /* If there is extra space available, add a trailing NUL */
772 *retlen = to - orig_to;
775 return (char *) from + copy_len;
781 Find the first (leftmost) occurrence of a sequence of bytes within another
782 sequence. This is the Perl version of C<strstr()>, extended to handle
783 arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
784 is what the initial C<n> in the function name stands for; some systems have an
785 equivalent, C<memmem()>, but with a somewhat different API).
787 Another way of thinking about this function is finding a needle in a haystack.
788 C<big> points to the first byte in the haystack. C<big_end> points to one byte
789 beyond the final byte in the haystack. C<little> points to the first byte in
790 the needle. C<little_end> points to one byte beyond the final byte in the
791 needle. All the parameters must be non-C<NULL>.
793 The function returns C<NULL> if there is no occurrence of C<little> within
794 C<big>. If C<little> is the empty string, C<big> is returned.
796 Because this function operates at the byte level, and because of the inherent
797 characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
798 needle and the haystack are strings with the same UTF-8ness, but not if the
806 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
808 PERL_ARGS_ASSERT_NINSTR;
811 return ninstr(big, bigend, little, lend);
814 if (little >= lend) {
818 const U8 first = *little;
821 /* No match can start closer to the end of the haystack than the length
823 bigend -= lend - little;
824 little++; /* Look for 'first', then the remainder is in here */
825 lsize = lend - little;
827 while (big <= bigend) {
828 big = (char *) memchr((U8 *) big, first, bigend - big + 1);
829 if (big == NULL || big > bigend) {
833 if (memEQ(big + 1, little, lsize)) {
849 Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
850 sequence of bytes within another sequence, returning C<NULL> if there is no
858 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
860 const Ptrdiff_t little_len = lend - little;
861 const Ptrdiff_t big_len = bigend - big;
863 PERL_ARGS_ASSERT_RNINSTR;
865 /* A non-existent needle trivially matches the rightmost possible position
867 if (UNLIKELY(little_len <= 0)) {
868 return (char*)bigend;
871 /* If the needle is larger than the haystack, the needle can't possibly fit
872 * inside the haystack. */
873 if (UNLIKELY(little_len > big_len)) {
877 /* Special case length 1 needles. It's trivial if we have memrchr();
878 * and otherwise we just do a per-byte search backwards.
880 * XXX When we don't have memrchr, we could use something like
881 * S_find_next_masked( or S_find_span_end() to do per-word searches */
882 if (little_len == 1) {
883 const char final = *little;
887 return (char *) memrchr(big, final, big_len);
889 const char * cur = bigend - 1;
895 } while (--cur >= big);
901 else { /* Below, the needle is longer than a single byte */
903 /* We search backwards in the haystack for the final character of the
904 * needle. Each time one is found, we see if the characters just
905 * before it in the haystack match the rest of the needle. */
906 const char final = *(lend - 1);
908 /* What matches consists of 'little_len'-1 characters, then the final
910 const Size_t prefix_len = little_len - 1;
912 /* If the final character in the needle is any closer than this to the
913 * left edge, there wouldn't be enough room for all of it to fit in the
915 const char * const left_fence = big + prefix_len;
917 /* Start at the right edge */
918 char * cur = (char *) bigend;
920 /* memrchr() makes the search easy (and fast); otherwise, look
921 * backwards byte-by-byte. */
926 cur = (char *) memrchr(left_fence, final, cur - left_fence);
933 if (cur < left_fence) {
937 while (*cur != final);
940 /* Here, we know that *cur is 'final'; see if the preceding bytes
941 * of the needle also match the corresponding haystack bytes */
942 if memEQ(cur - prefix_len, little, prefix_len) {
943 return cur - prefix_len;
945 } while (cur > left_fence);
951 /* As a space optimization, we do not compile tables for strings of length
952 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
953 special-cased in fbm_instr().
955 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
959 =for apidoc fbm_compile
961 Analyzes the string in order to make fast searches on it using C<fbm_instr()>
962 -- the Boyer-Moore algorithm.
968 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
975 PERL_ARGS_ASSERT_FBM_COMPILE;
977 if (isGV_with_GP(sv) || SvROK(sv))
983 if (flags & FBMcf_TAIL) {
984 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
985 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
986 if (mg && mg->mg_len >= 0)
989 if (!SvPOK(sv) || SvNIOKp(sv))
990 s = (U8*)SvPV_force_mutable(sv, len);
991 else s = (U8 *)SvPV_mutable(sv, len);
992 if (len == 0) /* TAIL might be on a zero-length string. */
994 SvUPGRADE(sv, SVt_PVMG);
998 /* add PERL_MAGIC_bm magic holding the FBM lookup table */
1000 assert(!mg_find(sv, PERL_MAGIC_bm));
1001 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
1005 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
1007 const U8 mlen = (len>255) ? 255 : (U8)len;
1008 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
1011 Newx(table, 256, U8);
1012 memset((void*)table, mlen, 256);
1013 mg->mg_ptr = (char *)table;
1016 s += len - 1; /* last char */
1019 if (table[*s] == mlen)
1025 BmUSEFUL(sv) = 100; /* Initial value */
1026 ((XPVNV*)SvANY(sv))->xnv_u.xnv_bm_tail = cBOOL(flags & FBMcf_TAIL);
1031 =for apidoc fbm_instr
1033 Returns the location of the SV in the string delimited by C<big> and
1034 C<bigend> (C<bigend>) is the char following the last char).
1035 It returns C<NULL> if the string can't be found. The C<sv>
1036 does not have to be C<fbm_compiled>, but the search will not be as fast
1041 If SvTAIL(littlestr) is true, a fake "\n" was appended to the string
1042 during FBM compilation due to FBMcf_TAIL in flags. It indicates that
1043 the littlestr must be anchored to the end of bigstr (or to any \n if
1046 E.g. The regex compiler would compile /abc/ to a littlestr of "abc",
1047 while /abc$/ compiles to "abc\n" with SvTAIL() true.
1049 A littlestr of "abc", !SvTAIL matches as /abc/;
1050 a littlestr of "ab\n", SvTAIL matches as:
1051 without FBMrf_MULTILINE: /ab\n?\z/
1052 with FBMrf_MULTILINE: /ab\n/ || /ab\z/;
1054 (According to Ilya from 1999; I don't know if this is still true, DAPM 2015):
1055 "If SvTAIL is actually due to \Z or \z, this gives false positives
1061 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
1065 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
1066 STRLEN littlelen = l;
1067 const I32 multiline = flags & FBMrf_MULTILINE;
1068 bool valid = SvVALID(littlestr);
1069 bool tail = valid ? cBOOL(SvTAIL(littlestr)) : FALSE;
1071 PERL_ARGS_ASSERT_FBM_INSTR;
1073 assert(bigend >= big);
1075 if ((STRLEN)(bigend - big) < littlelen) {
1077 && ((STRLEN)(bigend - big) == littlelen - 1)
1079 || (*big == *little &&
1080 memEQ((char *)big, (char *)little, littlelen - 1))))
1085 switch (littlelen) { /* Special cases for 0, 1 and 2 */
1087 return (char*)big; /* Cannot be SvTAIL! */
1090 if (tail && !multiline) /* Anchor only! */
1091 /* [-1] is safe because we know that bigend != big. */
1092 return (char *) (bigend - (bigend[-1] == '\n'));
1094 s = (unsigned char *)memchr((void*)big, *little, bigend-big);
1098 return (char *) bigend;
1102 if (tail && !multiline) {
1103 /* a littlestr with SvTAIL must be of the form "X\n" (where X
1104 * is a single char). It is anchored, and can only match
1105 * "....X\n" or "....X" */
1106 if (bigend[-2] == *little && bigend[-1] == '\n')
1107 return (char*)bigend - 2;
1108 if (bigend[-1] == *little)
1109 return (char*)bigend - 1;
1114 /* memchr() is likely to be very fast, possibly using whatever
1115 * hardware support is available, such as checking a whole
1116 * cache line in one instruction.
1117 * So for a 2 char pattern, calling memchr() is likely to be
1118 * faster than running FBM, or rolling our own. The previous
1119 * version of this code was roll-your-own which typically
1120 * only needed to read every 2nd char, which was good back in
1121 * the day, but no longer.
1123 unsigned char c1 = little[0];
1124 unsigned char c2 = little[1];
1126 /* *** for all this case, bigend points to the last char,
1127 * not the trailing \0: this makes the conditions slightly
1132 while (s < bigend) {
1133 /* do a quick test for c1 before calling memchr();
1134 * this avoids the expensive fn call overhead when
1135 * there are lots of c1's */
1136 if (LIKELY(*s != c1)) {
1138 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
1145 /* failed; try searching for c2 this time; that way
1146 * we don't go pathologically slow when the string
1147 * consists mostly of c1's or vice versa.
1152 s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
1156 return (char*)s - 1;
1160 /* c1, c2 the same */
1161 while (s < bigend) {
1170 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
1171 if (!s || s >= bigend)
1178 /* failed to find 2 chars; try anchored match at end without
1180 if (tail && bigend[0] == little[0])
1181 return (char *)bigend;
1186 break; /* Only lengths 0 1 and 2 have special-case code. */
1189 if (tail && !multiline) { /* tail anchored? */
1190 s = bigend - littlelen;
1191 if (s >= big && bigend[-1] == '\n' && *s == *little
1192 /* Automatically of length > 2 */
1193 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
1195 return (char*)s; /* how sweet it is */
1198 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
1200 return (char*)s + 1; /* how sweet it is */
1206 /* not compiled; use Perl_ninstr() instead */
1207 char * const b = ninstr((char*)big,(char*)bigend,
1208 (char*)little, (char*)little + littlelen);
1210 assert(!tail); /* valid => FBM; tail only set on SvVALID SVs */
1214 /* Do actual FBM. */
1215 if (littlelen > (STRLEN)(bigend - big))
1219 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
1220 const unsigned char *oldlittle;
1224 --littlelen; /* Last char found by table lookup */
1226 s = big + littlelen;
1227 little += littlelen; /* last char */
1230 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
1231 const unsigned char lastc = *little;
1235 if ((tmp = table[*s])) {
1236 /* *s != lastc; earliest position it could match now is
1237 * tmp slots further on */
1238 if ((s += tmp) >= bigend)
1240 if (LIKELY(*s != lastc)) {
1242 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
1252 /* hand-rolled strncmp(): less expensive than calling the
1253 * real function (maybe???) */
1255 unsigned char * const olds = s;
1260 if (*--s == *--little)
1262 s = olds + 1; /* here we pay the price for failure */
1264 if (s < bigend) /* fake up continue to outer loop */
1274 && memEQ((char *)(bigend - littlelen),
1275 (char *)(oldlittle - littlelen), littlelen) )
1276 return (char*)bigend - littlelen;
1282 Perl_cntrl_to_mnemonic(const U8 c)
1284 /* Returns the mnemonic string that represents character 'c', if one
1285 * exists; NULL otherwise. The only ones that exist for the purposes of
1286 * this routine are a few control characters */
1289 case '\a': return "\\a";
1290 case '\b': return "\\b";
1291 case ESC_NATIVE: return "\\e";
1292 case '\f': return "\\f";
1293 case '\n': return "\\n";
1294 case '\r': return "\\r";
1295 case '\t': return "\\t";
1301 /* copy a string to a safe spot */
1304 =for apidoc_section $string
1307 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1308 string which is a duplicate of C<pv>. The size of the string is
1309 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1310 characters and must have a trailing C<NUL>. To prevent memory leaks, the
1311 memory allocated for the new string needs to be freed when no longer needed.
1312 This can be done with the C<L</Safefree>> function, or
1313 L<C<SAVEFREEPV>|perlguts/SAVEFREEPV(p)>.
1315 On some platforms, Windows for example, all allocated memory owned by a thread
1316 is deallocated when that thread ends. So if you need that not to happen, you
1317 need to use the shared memory functions, such as C<L</savesharedpv>>.
1323 Perl_savepv(pTHX_ const char *pv)
1325 PERL_UNUSED_CONTEXT;
1330 const STRLEN pvlen = strlen(pv)+1;
1331 Newx(newaddr, pvlen, char);
1332 return (char*)memcpy(newaddr, pv, pvlen);
1336 /* same thing but with a known length */
1341 Perl's version of what C<strndup()> would be if it existed. Returns a
1342 pointer to a newly allocated string which is a duplicate of the first
1343 C<len> bytes from C<pv>, plus a trailing
1344 C<NUL> byte. The memory allocated for
1345 the new string can be freed with the C<Safefree()> function.
1347 On some platforms, Windows for example, all allocated memory owned by a thread
1348 is deallocated when that thread ends. So if you need that not to happen, you
1349 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1355 Perl_savepvn(pTHX_ const char *pv, Size_t len)
1358 PERL_UNUSED_CONTEXT;
1360 Newx(newaddr,len+1,char);
1361 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1363 /* might not be null terminated */
1364 newaddr[len] = '\0';
1365 return (char *) CopyD(pv,newaddr,len,char);
1368 return (char *) ZeroD(newaddr,len+1,char);
1373 =for apidoc savesharedpv
1375 A version of C<savepv()> which allocates the duplicate string in memory
1376 which is shared between threads.
1381 Perl_savesharedpv(pTHX_ const char *pv)
1386 PERL_UNUSED_CONTEXT;
1391 pvlen = strlen(pv)+1;
1392 newaddr = (char*)PerlMemShared_malloc(pvlen);
1396 return (char*)memcpy(newaddr, pv, pvlen);
1400 =for apidoc savesharedpvn
1402 A version of C<savepvn()> which allocates the duplicate string in memory
1403 which is shared between threads. (With the specific difference that a C<NULL>
1404 pointer is not acceptable)
1409 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1411 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1413 PERL_UNUSED_CONTEXT;
1414 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1419 newaddr[len] = '\0';
1420 return (char*)memcpy(newaddr, pv, len);
1424 =for apidoc savesvpv
1426 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1427 the passed in SV using C<SvPV()>
1429 On some platforms, Windows for example, all allocated memory owned by a thread
1430 is deallocated when that thread ends. So if you need that not to happen, you
1431 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1437 Perl_savesvpv(pTHX_ SV *sv)
1440 const char * const pv = SvPV_const(sv, len);
1443 PERL_ARGS_ASSERT_SAVESVPV;
1446 Newx(newaddr,len,char);
1447 return (char *) CopyD(pv,newaddr,len,char);
1451 =for apidoc savesharedsvpv
1453 A version of C<savesharedpv()> which allocates the duplicate string in
1454 memory which is shared between threads.
1460 Perl_savesharedsvpv(pTHX_ SV *sv)
1463 const char * const pv = SvPV_const(sv, len);
1465 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1467 return savesharedpvn(pv, len);
1470 /* the SV for Perl_form() and mess() is not kept in an arena */
1478 if (PL_phase != PERL_PHASE_DESTRUCT)
1479 return newSVpvs_flags("", SVs_TEMP);
1484 /* Create as PVMG now, to avoid any upgrading later */
1486 Newxz(any, 1, XPVMG);
1487 SvFLAGS(sv) = SVt_PVMG;
1488 SvANY(sv) = (void*)any;
1490 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1495 #if defined(PERL_IMPLICIT_CONTEXT)
1497 Perl_form_nocontext(const char* pat, ...)
1502 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1503 va_start(args, pat);
1504 retval = vform(pat, &args);
1508 #endif /* PERL_IMPLICIT_CONTEXT */
1511 =for apidoc_section $display
1513 =for apidoc_item form_nocontext
1515 These take a sprintf-style format pattern and conventional
1516 (non-SV) arguments and return the formatted string.
1518 (char *) Perl_form(pTHX_ const char* pat, ...)
1520 can be used any place a string (char *) is required:
1522 char * s = Perl_form("%d.%d",major,minor);
1524 They use a single private buffer so if you want to format several strings you
1525 must explicitly copy the earlier strings away (and free the copies when you
1528 The two forms differ only in that C<form_nocontext> does not take a thread
1529 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
1530 already have the thread context.
1533 Like C<L</form>> but but the arguments are an encapsulated argument list.
1539 Perl_form(pTHX_ const char* pat, ...)
1543 PERL_ARGS_ASSERT_FORM;
1544 va_start(args, pat);
1545 retval = vform(pat, &args);
1551 Perl_vform(pTHX_ const char *pat, va_list *args)
1553 SV * const sv = mess_alloc();
1554 PERL_ARGS_ASSERT_VFORM;
1555 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1561 =for apidoc_item mess_nocontext
1563 These take a sprintf-style format pattern and argument list, which are used to
1564 generate a string message. If the message does not end with a newline, then it
1565 will be extended with some indication of the current location in the code, as
1566 described for C<L</mess_sv>>.
1568 Normally, the resulting message is returned in a new mortal SV.
1569 But during global destruction a single SV may be shared between uses of
1572 The two forms differ only in that C<mess_nocontext> does not take a thread
1573 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
1574 already have the thread context.
1579 #if defined(PERL_IMPLICIT_CONTEXT)
1581 Perl_mess_nocontext(const char *pat, ...)
1586 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1587 va_start(args, pat);
1588 retval = vmess(pat, &args);
1592 #endif /* PERL_IMPLICIT_CONTEXT */
1595 Perl_mess(pTHX_ const char *pat, ...)
1599 PERL_ARGS_ASSERT_MESS;
1600 va_start(args, pat);
1601 retval = vmess(pat, &args);
1607 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1610 /* Look for curop starting from o. cop is the last COP we've seen. */
1611 /* opnext means that curop is actually the ->op_next of the op we are
1614 PERL_ARGS_ASSERT_CLOSEST_COP;
1616 if (!o || !curop || (
1617 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1621 if (o->op_flags & OPf_KIDS) {
1623 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1626 /* If the OP_NEXTSTATE has been optimised away we can still use it
1627 * the get the file and line number. */
1629 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1630 cop = (const COP *)kid;
1632 /* Keep searching, and return when we've found something. */
1634 new_cop = closest_cop(cop, kid, curop, opnext);
1640 /* Nothing found. */
1648 Expands a message, intended for the user, to include an indication of
1649 the current location in the code, if the message does not already appear
1652 C<basemsg> is the initial message or object. If it is a reference, it
1653 will be used as-is and will be the result of this function. Otherwise it
1654 is used as a string, and if it already ends with a newline, it is taken
1655 to be complete, and the result of this function will be the same string.
1656 If the message does not end with a newline, then a segment such as C<at
1657 foo.pl line 37> will be appended, and possibly other clauses indicating
1658 the current state of execution. The resulting message will end with a
1661 Normally, the resulting message is returned in a new mortal SV.
1662 During global destruction a single SV may be shared between uses of this
1663 function. If C<consume> is true, then the function is permitted (but not
1664 required) to modify and return C<basemsg> instead of allocating a new SV.
1670 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1674 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1678 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1679 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1680 && grok_atoUV(ws, &wi, NULL)
1681 && wi <= PERL_INT_MAX
1683 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1688 PERL_ARGS_ASSERT_MESS_SV;
1690 if (SvROK(basemsg)) {
1696 sv_setsv(sv, basemsg);
1701 if (SvPOK(basemsg) && consume) {
1706 sv_copypv(sv, basemsg);
1709 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1711 * Try and find the file and line for PL_op. This will usually be
1712 * PL_curcop, but it might be a cop that has been optimised away. We
1713 * can try to find such a cop by searching through the optree starting
1714 * from the sibling of PL_curcop.
1719 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1724 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1725 OutCopFILE(cop), (IV)CopLINE(cop));
1728 /* Seems that GvIO() can be untrustworthy during global destruction. */
1729 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1730 && IoLINES(GvIOp(PL_last_in_gv)))
1733 const bool line_mode = (RsSIMPLE(PL_rs) &&
1734 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1735 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1736 SVfARG(PL_last_in_gv == PL_argvgv
1738 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1739 line_mode ? "line" : "chunk",
1740 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1742 if (PL_phase == PERL_PHASE_DESTRUCT)
1743 sv_catpvs(sv, " during global destruction");
1744 sv_catpvs(sv, ".\n");
1752 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1753 argument list, respectively. These are used to generate a string message. If
1755 message does not end with a newline, then it will be extended with
1756 some indication of the current location in the code, as described for
1759 Normally, the resulting message is returned in a new mortal SV.
1760 During global destruction a single SV may be shared between uses of
1767 Perl_vmess(pTHX_ const char *pat, va_list *args)
1769 SV * const sv = mess_alloc();
1771 PERL_ARGS_ASSERT_VMESS;
1773 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1774 return mess_sv(sv, 1);
1778 Perl_write_to_stderr(pTHX_ SV* msv)
1783 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1785 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1786 && (io = GvIO(PL_stderrgv))
1787 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1788 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1789 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1791 PerlIO * const serr = Perl_error_log;
1793 do_print(msv, serr);
1794 (void)PerlIO_flush(serr);
1799 =for apidoc_section $warning
1802 /* Common code used in dieing and warning */
1805 S_with_queued_errors(pTHX_ SV *ex)
1807 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1808 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1809 sv_catsv(PL_errors, ex);
1810 ex = sv_mortalcopy(PL_errors);
1811 SvCUR_set(PL_errors, 0);
1817 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1822 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1823 /* sv_2cv might call Perl_croak() or Perl_warner() */
1824 SV * const oldhook = *hook;
1826 if (!oldhook || oldhook == PERL_WARNHOOK_FATAL)
1832 cv = sv_2cv(oldhook, &stash, &gv, 0);
1834 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1844 exarg = newSVsv(ex);
1845 SvREADONLY_on(exarg);
1848 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1852 call_sv(MUTABLE_SV(cv), G_DISCARD);
1862 =for apidoc_item die_nocontext
1864 These ehave the same as L</croak_sv>, except for the return type.
1865 It should be used only where the C<OP *> return type is required.
1866 The functions never actually return.
1868 The two forms differ only in that C<die_nocontext> does not take a thread
1869 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
1870 already have the thread context.
1875 /* silence __declspec(noreturn) warnings */
1876 MSVC_DIAG_IGNORE(4646 4645)
1878 Perl_die_sv(pTHX_ SV *baseex)
1880 PERL_ARGS_ASSERT_DIE_SV;
1883 NORETURN_FUNCTION_END;
1890 Behaves the same as L</croak>, except for the return type.
1891 It should be used only where the C<OP *> return type is required.
1892 The function never actually returns.
1897 #if defined(PERL_IMPLICIT_CONTEXT)
1899 /* silence __declspec(noreturn) warnings */
1900 MSVC_DIAG_IGNORE(4646 4645)
1902 Perl_die_nocontext(const char* pat, ...)
1906 va_start(args, pat);
1908 NOT_REACHED; /* NOTREACHED */
1910 NORETURN_FUNCTION_END;
1914 #endif /* PERL_IMPLICIT_CONTEXT */
1916 /* silence __declspec(noreturn) warnings */
1917 MSVC_DIAG_IGNORE(4646 4645)
1919 Perl_die(pTHX_ const char* pat, ...)
1922 va_start(args, pat);
1924 NOT_REACHED; /* NOTREACHED */
1926 NORETURN_FUNCTION_END;
1931 =for apidoc croak_sv
1933 This is an XS interface to Perl's C<die> function.
1935 C<baseex> is the error message or object. If it is a reference, it
1936 will be used as-is. Otherwise it is used as a string, and if it does
1937 not end with a newline then it will be extended with some indication of
1938 the current location in the code, as described for L</mess_sv>.
1940 The error message or object will be used as an exception, by default
1941 returning control to the nearest enclosing C<eval>, but subject to
1942 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1943 function never returns normally.
1945 To die with a simple string message, the L</croak> function may be
1952 Perl_croak_sv(pTHX_ SV *baseex)
1954 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1955 PERL_ARGS_ASSERT_CROAK_SV;
1956 invoke_exception_hook(ex, FALSE);
1963 This is an XS interface to Perl's C<die> function.
1965 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1966 argument list. These are used to generate a string message. If the
1967 message does not end with a newline, then it will be extended with
1968 some indication of the current location in the code, as described for
1971 The error message will be used as an exception, by default
1972 returning control to the nearest enclosing C<eval>, but subject to
1973 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1974 function never returns normally.
1976 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1977 (C<$@>) will be used as an error message or object instead of building an
1978 error message from arguments. If you want to throw a non-string object,
1979 or build an error message in an SV yourself, it is preferable to use
1980 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1986 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1988 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1989 invoke_exception_hook(ex, FALSE);
1995 =for apidoc_item croak_nocontext
1997 These are XS interfaces to Perl's C<die> function.
1999 They take a sprintf-style format pattern and argument list, which are used to
2000 generate a string message. If the message does not end with a newline, then it
2001 will be extended with some indication of the current location in the code, as
2002 described for C<L</mess_sv>>.
2004 The error message will be used as an exception, by default
2005 returning control to the nearest enclosing C<eval>, but subject to
2006 modification by a C<$SIG{__DIE__}> handler. In any case, these croak
2007 functions never return normally.
2009 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
2010 (C<$@>) will be used as an error message or object instead of building an
2011 error message from arguments. If you want to throw a non-string object,
2012 or build an error message in an SV yourself, it is preferable to use
2013 the C<L</croak_sv>> function, which does not involve clobbering C<ERRSV>.
2015 The two forms differ only in that C<croak_nocontext> does not take a thread
2016 context (C<aTHX>) parameter. It is usually preferred as it takes up fewer
2017 bytes of code than plain C<Perl_croak>, and time is rarely a critical resource
2018 when you are about to throw an exception.
2023 #if defined(PERL_IMPLICIT_CONTEXT)
2025 Perl_croak_nocontext(const char *pat, ...)
2029 va_start(args, pat);
2031 NOT_REACHED; /* NOTREACHED */
2034 #endif /* PERL_IMPLICIT_CONTEXT */
2036 /* saves machine code for a common noreturn idiom typically used in Newx*() */
2037 GCC_DIAG_IGNORE_DECL(-Wunused-function);
2039 Perl_croak_memory_wrap(void)
2041 Perl_croak_nocontext("%s",PL_memory_wrap);
2043 GCC_DIAG_RESTORE_DECL;
2046 Perl_croak(pTHX_ const char *pat, ...)
2049 va_start(args, pat);
2051 NOT_REACHED; /* NOTREACHED */
2056 =for apidoc croak_no_modify
2058 This encapsulates a common reason for dying, generating terser object code than
2059 using the generic C<Perl_croak>. It is exactly equivalent to
2060 C<Perl_croak(aTHX_ "%s", PL_no_modify)> (which expands to something like
2061 "Modification of a read-only value attempted").
2063 Less code used on exception code paths reduces CPU cache pressure.
2069 Perl_croak_no_modify(void)
2071 Perl_croak_nocontext( "%s", PL_no_modify);
2074 /* does not return, used in util.c perlio.c and win32.c
2075 This is typically called when malloc returns NULL.
2078 Perl_croak_no_mem(void)
2082 int fd = PerlIO_fileno(Perl_error_log);
2084 SETERRNO(EBADF,RMS_IFI);
2086 /* Can't use PerlIO to write as it allocates memory */
2087 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
2092 /* does not return, used only in POPSTACK */
2094 Perl_croak_popstack(void)
2097 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
2104 This is an XS interface to Perl's C<warn> function.
2106 C<baseex> is the error message or object. If it is a reference, it
2107 will be used as-is. Otherwise it is used as a string, and if it does
2108 not end with a newline then it will be extended with some indication of
2109 the current location in the code, as described for L</mess_sv>.
2111 The error message or object will by default be written to standard error,
2112 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2114 To warn with a simple string message, the L</warn> function may be
2121 Perl_warn_sv(pTHX_ SV *baseex)
2123 SV *ex = mess_sv(baseex, 0);
2124 PERL_ARGS_ASSERT_WARN_SV;
2125 if (!invoke_exception_hook(ex, TRUE))
2126 write_to_stderr(ex);
2132 This is an XS interface to Perl's C<warn> function.
2134 This is like C<L</warn>>, but C<args> are an encapsulated
2137 Unlike with L</vcroak>, C<pat> is not permitted to be null.
2143 Perl_vwarn(pTHX_ const char* pat, va_list *args)
2145 SV *ex = vmess(pat, args);
2146 PERL_ARGS_ASSERT_VWARN;
2147 if (!invoke_exception_hook(ex, TRUE))
2148 write_to_stderr(ex);
2153 =for apidoc_item warn_nocontext
2155 These are XS interfaces to Perl's C<warn> function.
2157 They take a sprintf-style format pattern and argument list, which are used to
2158 generate a string message. If the message does not end with a newline, then it
2159 will be extended with some indication of the current location in the code, as
2160 described for C<L</mess_sv>>.
2162 The error message or object will by default be written to standard error,
2163 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2165 Unlike with C<L</croak>>, C<pat> is not permitted to be null.
2167 The two forms differ only in that C<warn_nocontext> does not take a thread
2168 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
2169 already have the thread context.
2174 #if defined(PERL_IMPLICIT_CONTEXT)
2176 Perl_warn_nocontext(const char *pat, ...)
2180 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
2181 va_start(args, pat);
2185 #endif /* PERL_IMPLICIT_CONTEXT */
2188 Perl_warn(pTHX_ const char *pat, ...)
2191 PERL_ARGS_ASSERT_WARN;
2192 va_start(args, pat);
2199 =for apidoc_item warner_nocontext
2201 These output a warning of the specified category (or categories) given by
2202 C<err>, using the sprintf-style format pattern C<pat>, and argument list.
2204 C<err> must be one of the C<L</packWARN>>, C<packWARN2>, C<packWARN3>,
2205 C<packWARN4> macros populated with the appropriate number of warning
2206 categories. If any of the warning categories they specify is fatal, a fatal
2207 exception is thrown.
2209 In any event a message is generated by the pattern and arguments. If the
2210 message does not end with a newline, then it will be extended with some
2211 indication of the current location in the code, as described for L</mess_sv>.
2213 The error message or object will by default be written to standard error,
2214 but this is subject to modification by a C<$SIG{__WARN__}> handler.
2216 C<pat> is not permitted to be null.
2218 The two forms differ only in that C<warner_nocontext> does not take a thread
2219 context (C<aTHX>) parameter, so is used in situations where the caller doesn't
2220 already have the thread context.
2222 These functions differ from the similarly named C<L</warn>> functions, in that
2223 the latter are for XS code to unconditionally display a warning, whereas these
2224 are for code that may be compiling a perl program, and does extra checking to
2225 see if the warning should be fatal.
2227 =for apidoc ck_warner
2228 =for apidoc_item ck_warner_d
2229 If none of the warning categories given by C<err> are enabled, do nothing;
2230 otherwise call C<L</warner>> or C<L</warner_nocontext>> with the passed-in
2233 C<err> must be one of the C<L</packWARN>>, C<packWARN2>, C<packWARN3>,
2234 C<packWARN4> macros populated with the appropriate number of warning
2237 The two forms differ only in that C<ck_warner_d> should be used if warnings for
2238 any of the categories are by default enabled.
2241 This is like C<L</warner>>, but C<args> are an encapsulated argument list.
2246 #if defined(PERL_IMPLICIT_CONTEXT)
2248 Perl_warner_nocontext(U32 err, const char *pat, ...)
2252 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
2253 va_start(args, pat);
2254 vwarner(err, pat, &args);
2257 #endif /* PERL_IMPLICIT_CONTEXT */
2260 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
2262 PERL_ARGS_ASSERT_CK_WARNER_D;
2264 if (Perl_ckwarn_d(aTHX_ err)) {
2266 va_start(args, pat);
2267 vwarner(err, pat, &args);
2273 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
2275 PERL_ARGS_ASSERT_CK_WARNER;
2277 if (Perl_ckwarn(aTHX_ err)) {
2279 va_start(args, pat);
2280 vwarner(err, pat, &args);
2286 Perl_warner(pTHX_ U32 err, const char* pat,...)
2289 PERL_ARGS_ASSERT_WARNER;
2290 va_start(args, pat);
2291 vwarner(err, pat, &args);
2296 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
2298 PERL_ARGS_ASSERT_VWARNER;
2300 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
2301 !(PL_in_eval & EVAL_KEEPERR)
2303 SV * const msv = vmess(pat, args);
2305 if (PL_parser && PL_parser->error_count) {
2309 invoke_exception_hook(msv, FALSE);
2314 Perl_vwarn(aTHX_ pat, args);
2318 /* implements the ckWARN? macros */
2321 Perl_ckwarn(pTHX_ U32 w)
2323 /* If lexical warnings have not been set, use $^W. */
2325 return PL_dowarn & G_WARN_ON;
2327 return ckwarn_common(w);
2330 /* implements the ckWARN?_d macro */
2333 Perl_ckwarn_d(pTHX_ U32 w)
2335 /* If lexical warnings have not been set then default classes warn. */
2339 return ckwarn_common(w);
2343 S_ckwarn_common(pTHX_ U32 w)
2345 if (PL_curcop->cop_warnings == pWARN_ALL)
2348 if (PL_curcop->cop_warnings == pWARN_NONE)
2351 /* Check the assumption that at least the first slot is non-zero. */
2352 assert(unpackWARN1(w));
2354 /* Check the assumption that it is valid to stop as soon as a zero slot is
2356 if (!unpackWARN2(w)) {
2357 assert(!unpackWARN3(w));
2358 assert(!unpackWARN4(w));
2359 } else if (!unpackWARN3(w)) {
2360 assert(!unpackWARN4(w));
2363 /* Right, dealt with all the special cases, which are implemented as non-
2364 pointers, so there is a pointer to a real warnings mask. */
2366 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2368 } while (w >>= WARNshift);
2373 /* Set buffer=NULL to get a new one. */
2375 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2377 const MEM_SIZE len_wanted =
2378 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2379 PERL_UNUSED_CONTEXT;
2380 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2383 (specialWARN(buffer) ?
2384 PerlMemShared_malloc(len_wanted) :
2385 PerlMemShared_realloc(buffer, len_wanted));
2387 Copy(bits, (buffer + 1), size, char);
2388 if (size < WARNsize)
2389 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2393 /* since we've already done strlen() for both nam and val
2394 * we can use that info to make things faster than
2395 * sprintf(s, "%s=%s", nam, val)
2397 #define my_setenv_format(s, nam, nlen, val, vlen) \
2398 Copy(nam, s, nlen, char); \
2400 Copy(val, s+(nlen+1), vlen, char); \
2401 *(s+(nlen+1+vlen)) = '\0'
2405 #ifdef USE_ENVIRON_ARRAY
2406 /* NB: VMS' my_setenv() is in vms.c */
2408 /* Configure doesn't test for HAS_SETENV yet, so decide based on platform.
2409 * For Solaris, setenv() and unsetenv() were introduced in Solaris 9, so
2410 * testing for HAS UNSETENV is sufficient.
2412 # if defined(__CYGWIN__)|| defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2413 # define MY_HAS_SETENV
2416 /* small wrapper for use by Perl_my_setenv that mallocs, or reallocs if
2417 * 'current' is non-null, with up to three sizes that are added together.
2418 * It handles integer overflow.
2420 # ifndef MY_HAS_SETENV
2422 S_env_alloc(void *current, Size_t l1, Size_t l2, Size_t l3, Size_t size)
2425 Size_t sl, l = l1 + l2;
2437 ? safesysrealloc(current, sl)
2438 : safesysmalloc(sl);
2443 croak_memory_wrap();
2448 # if !defined(WIN32) && !defined(NETWARE)
2451 =for apidoc_section $utility
2452 =for apidoc my_setenv
2454 A wrapper for the C library L<setenv(3)>. Don't use the latter, as the perl
2455 version has desirable safeguards
2461 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2463 # ifdef __amigaos4__
2464 amigaos4_obtain_environ(__FUNCTION__);
2467 # ifdef USE_ITHREADS
2468 /* only parent thread can modify process environment, so no need to use a
2470 if (PL_curinterp == aTHX)
2474 # ifndef PERL_USE_SAFE_PUTENV
2475 if (!PL_use_safe_putenv) {
2476 /* most putenv()s leak, so we manipulate environ directly */
2478 Size_t vlen, nlen = strlen(nam);
2480 /* where does it go? */
2481 for (i = 0; environ[i]; i++) {
2482 if (strnEQ(environ[i], nam, nlen) && environ[i][nlen] == '=')
2486 if (environ == PL_origenviron) { /* need we copy environment? */
2491 while (environ[max])
2494 /* XXX shouldn't that be max+1 rather than max+2 ??? - DAPM */
2495 tmpenv = (char**)S_env_alloc(NULL, max, 2, 0, sizeof(char*));
2497 for (j=0; j<max; j++) { /* copy environment */
2498 const Size_t len = strlen(environ[j]);
2499 tmpenv[j] = S_env_alloc(NULL, len, 1, 0, 1);
2500 Copy(environ[j], tmpenv[j], len+1, char);
2504 environ = tmpenv; /* tell exec where it is now */
2508 safesysfree(environ[i]);
2509 while (environ[i]) {
2510 environ[i] = environ[i+1];
2513 # ifdef __amigaos4__
2520 if (!environ[i]) { /* does not exist yet */
2521 environ = (char**)S_env_alloc(environ, i, 2, 0, sizeof(char*));
2522 environ[i+1] = NULL; /* make sure it's null terminated */
2525 safesysfree(environ[i]);
2529 environ[i] = S_env_alloc(NULL, nlen, vlen, 2, 1);
2530 /* all that work just for this */
2531 my_setenv_format(environ[i], nam, nlen, val, vlen);
2535 # endif /* !PERL_USE_SAFE_PUTENV */
2537 # ifdef MY_HAS_SETENV
2538 # if defined(HAS_UNSETENV)
2540 (void)unsetenv(nam);
2542 (void)setenv(nam, val, 1);
2544 # else /* ! HAS_UNSETENV */
2545 (void)setenv(nam, val, 1);
2546 # endif /* HAS_UNSETENV */
2548 # elif defined(HAS_UNSETENV)
2551 if (environ) /* old glibc can crash with null environ */
2552 (void)unsetenv(nam);
2554 const Size_t nlen = strlen(nam);
2555 const Size_t vlen = strlen(val);
2556 char * const new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2557 my_setenv_format(new_env, nam, nlen, val, vlen);
2558 (void)putenv(new_env);
2561 # else /* ! HAS_UNSETENV */
2564 const Size_t nlen = strlen(nam);
2570 new_env = S_env_alloc(NULL, nlen, vlen, 2, 1);
2571 /* all that work just for this */
2572 my_setenv_format(new_env, nam, nlen, val, vlen);
2573 (void)putenv(new_env);
2575 # endif /* MY_HAS_SETENV */
2577 # ifndef PERL_USE_SAFE_PUTENV
2582 # ifdef __amigaos4__
2584 amigaos4_release_environ(__FUNCTION__);
2588 # else /* WIN32 || NETWARE */
2591 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2594 const Size_t nlen = strlen(nam);
2601 envstr = S_env_alloc(NULL, nlen, vlen, 2, 1);
2602 my_setenv_format(envstr, nam, nlen, val, vlen);
2603 (void)PerlEnv_putenv(envstr);
2604 safesysfree(envstr);
2607 # endif /* WIN32 || NETWARE */
2609 #endif /* USE_ENVIRON_ARRAY */
2614 #ifdef UNLINK_ALL_VERSIONS
2616 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2620 PERL_ARGS_ASSERT_UNLNK;
2622 while (PerlLIO_unlink(f) >= 0)
2624 return retries ? 0 : -1;
2629 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2631 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2639 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2641 PERL_FLUSHALL_FOR_CHILD;
2642 This = (*mode == 'w');
2646 taint_proper("Insecure %s%s", "EXEC");
2648 if (PerlProc_pipe_cloexec(p) < 0)
2650 /* Try for another pipe pair for error return */
2651 if (PerlProc_pipe_cloexec(pp) >= 0)
2653 while ((pid = PerlProc_fork()) < 0) {
2654 if (errno != EAGAIN) {
2655 PerlLIO_close(p[This]);
2656 PerlLIO_close(p[that]);
2658 PerlLIO_close(pp[0]);
2659 PerlLIO_close(pp[1]);
2663 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2672 /* Close parent's end of error status pipe (if any) */
2674 PerlLIO_close(pp[0]);
2675 /* Now dup our end of _the_ pipe to right position */
2676 if (p[THIS] != (*mode == 'r')) {
2677 PerlLIO_dup2(p[THIS], *mode == 'r');
2678 PerlLIO_close(p[THIS]);
2679 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2680 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2683 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2684 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2686 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2687 /* No automatic close - do it by hand */
2694 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2700 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2707 PerlLIO_close(pp[1]);
2708 /* Keep the lower of the two fd numbers */
2709 if (p[that] < p[This]) {
2710 PerlLIO_dup2_cloexec(p[This], p[that]);
2711 PerlLIO_close(p[This]);
2715 PerlLIO_close(p[that]); /* close child's end of pipe */
2717 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2718 SvUPGRADE(sv,SVt_IV);
2720 PL_forkprocess = pid;
2721 /* If we managed to get status pipe check for exec fail */
2722 if (did_pipes && pid > 0) {
2724 unsigned read_total = 0;
2726 while (read_total < sizeof(int)) {
2727 const SSize_t n1 = PerlLIO_read(pp[0],
2728 (void*)(((char*)&errkid)+read_total),
2729 (sizeof(int)) - read_total);
2734 PerlLIO_close(pp[0]);
2736 if (read_total) { /* Error */
2738 PerlLIO_close(p[This]);
2739 if (read_total != sizeof(int))
2740 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", read_total);
2742 pid2 = wait4pid(pid, &status, 0);
2743 } while (pid2 == -1 && errno == EINTR);
2744 errno = errkid; /* Propagate errno from kid */
2749 PerlLIO_close(pp[0]);
2750 return PerlIO_fdopen(p[This], mode);
2752 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2753 return my_syspopen4(aTHX_ NULL, mode, n, args);
2754 # elif defined(WIN32)
2755 return win32_popenlist(mode, n, args);
2757 Perl_croak(aTHX_ "List form of piped open not implemented");
2758 return (PerlIO *) NULL;
2763 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2764 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2766 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2772 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2776 PERL_ARGS_ASSERT_MY_POPEN;
2778 PERL_FLUSHALL_FOR_CHILD;
2781 return my_syspopen(aTHX_ cmd,mode);
2784 This = (*mode == 'w');
2786 if (doexec && TAINTING_get) {
2788 taint_proper("Insecure %s%s", "EXEC");
2790 if (PerlProc_pipe_cloexec(p) < 0)
2792 if (doexec && PerlProc_pipe_cloexec(pp) >= 0)
2794 while ((pid = PerlProc_fork()) < 0) {
2795 if (errno != EAGAIN) {
2796 PerlLIO_close(p[This]);
2797 PerlLIO_close(p[that]);
2799 PerlLIO_close(pp[0]);
2800 PerlLIO_close(pp[1]);
2803 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2806 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2816 PerlLIO_close(pp[0]);
2817 if (p[THIS] != (*mode == 'r')) {
2818 PerlLIO_dup2(p[THIS], *mode == 'r');
2819 PerlLIO_close(p[THIS]);
2820 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2821 PerlLIO_close(p[THAT]);
2824 setfd_cloexec_or_inhexec_by_sysfdness(p[THIS]);
2825 PerlLIO_close(p[THAT]);
2829 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2836 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2841 /* may or may not use the shell */
2842 do_exec3(cmd, pp[1], did_pipes);
2845 #endif /* defined OS2 */
2847 #ifdef PERLIO_USING_CRLF
2848 /* Since we circumvent IO layers when we manipulate low-level
2849 filedescriptors directly, need to manually switch to the
2850 default, binary, low-level mode; see PerlIOBuf_open(). */
2851 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2854 #ifdef PERL_USES_PL_PIDSTATUS
2855 hv_clear(PL_pidstatus); /* we have no children */
2862 PerlLIO_close(pp[1]);
2863 if (p[that] < p[This]) {
2864 PerlLIO_dup2_cloexec(p[This], p[that]);
2865 PerlLIO_close(p[This]);
2869 PerlLIO_close(p[that]);
2871 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2872 SvUPGRADE(sv,SVt_IV);
2874 PL_forkprocess = pid;
2875 if (did_pipes && pid > 0) {
2879 while (n < sizeof(int)) {
2880 const SSize_t n1 = PerlLIO_read(pp[0],
2881 (void*)(((char*)&errkid)+n),
2887 PerlLIO_close(pp[0]);
2889 if (n) { /* Error */
2891 PerlLIO_close(p[This]);
2892 if (n != sizeof(int))
2893 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2895 pid2 = wait4pid(pid, &status, 0);
2896 } while (pid2 == -1 && errno == EINTR);
2897 errno = errkid; /* Propagate errno from kid */
2902 PerlLIO_close(pp[0]);
2903 return PerlIO_fdopen(p[This], mode);
2905 #elif defined(DJGPP)
2906 FILE *djgpp_popen();
2908 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2910 PERL_FLUSHALL_FOR_CHILD;
2911 /* Call system's popen() to get a FILE *, then import it.
2912 used 0 for 2nd parameter to PerlIO_importFILE;
2915 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2917 #elif defined(__LIBCATAMOUNT__)
2919 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2924 #endif /* !DOSISH */
2926 /* this is called in parent before the fork() */
2928 Perl_atfork_lock(void)
2929 #if defined(USE_ITHREADS)
2931 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2934 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2936 PERL_TSA_ACQUIRE(PL_op_mutex)
2939 #if defined(USE_ITHREADS)
2940 /* locks must be held in locking order (if any) */
2942 MUTEX_LOCK(&PL_perlio_mutex);
2945 MUTEX_LOCK(&PL_malloc_mutex);
2951 /* this is called in both parent and child after the fork() */
2953 Perl_atfork_unlock(void)
2954 #if defined(USE_ITHREADS)
2956 PERL_TSA_RELEASE(PL_perlio_mutex)
2959 PERL_TSA_RELEASE(PL_malloc_mutex)
2961 PERL_TSA_RELEASE(PL_op_mutex)
2964 #if defined(USE_ITHREADS)
2965 /* locks must be released in same order as in atfork_lock() */
2967 MUTEX_UNLOCK(&PL_perlio_mutex);
2970 MUTEX_UNLOCK(&PL_malloc_mutex);
2979 #if defined(HAS_FORK)
2981 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2986 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2987 * handlers elsewhere in the code */
2991 #elif defined(__amigaos4__)
2992 return amigaos_fork();
2994 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2995 Perl_croak_nocontext("fork() not available");
2997 #endif /* HAS_FORK */
3002 dup2(int oldfd, int newfd)
3004 #if defined(HAS_FCNTL) && defined(F_DUPFD)
3007 PerlLIO_close(newfd);
3008 return fcntl(oldfd, F_DUPFD, newfd);
3010 #define DUP2_MAX_FDS 256
3011 int fdtmp[DUP2_MAX_FDS];
3017 PerlLIO_close(newfd);
3018 /* good enough for low fd's... */
3019 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
3020 if (fdx >= DUP2_MAX_FDS) {
3028 PerlLIO_close(fdtmp[--fdx]);
3035 #ifdef HAS_SIGACTION
3038 =for apidoc_section $signals
3041 A wrapper for the C library L<signal(2)>. Don't use the latter, as the Perl
3042 version knows things that interact with the rest of the perl interpreter.
3048 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
3050 struct sigaction act, oact;
3053 /* only "parent" interpreter can diddle signals */
3054 if (PL_curinterp != aTHX)
3055 return (Sighandler_t) SIG_ERR;
3058 act.sa_handler = handler;
3059 sigemptyset(&act.sa_mask);
3062 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
3063 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
3065 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
3066 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
3067 act.sa_flags |= SA_NOCLDWAIT;
3069 if (sigaction(signo, &act, &oact) == -1)
3070 return (Sighandler_t) SIG_ERR;
3072 return (Sighandler_t) oact.sa_handler;
3076 Perl_rsignal_state(pTHX_ int signo)
3078 struct sigaction oact;
3079 PERL_UNUSED_CONTEXT;
3081 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
3082 return (Sighandler_t) SIG_ERR;
3084 return (Sighandler_t) oact.sa_handler;
3088 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3090 struct sigaction act;
3092 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
3095 /* only "parent" interpreter can diddle signals */
3096 if (PL_curinterp != aTHX)
3100 act.sa_handler = handler;
3101 sigemptyset(&act.sa_mask);
3104 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
3105 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
3107 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
3108 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
3109 act.sa_flags |= SA_NOCLDWAIT;
3111 return sigaction(signo, &act, save);
3115 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3117 PERL_UNUSED_CONTEXT;
3119 /* only "parent" interpreter can diddle signals */
3120 if (PL_curinterp != aTHX)
3124 return sigaction(signo, save, (struct sigaction *)NULL);
3127 #else /* !HAS_SIGACTION */
3130 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
3132 #if defined(USE_ITHREADS) && !defined(WIN32)
3133 /* only "parent" interpreter can diddle signals */
3134 if (PL_curinterp != aTHX)
3135 return (Sighandler_t) SIG_ERR;
3138 return PerlProc_signal(signo, handler);
3148 Perl_rsignal_state(pTHX_ int signo)
3150 Sighandler_t oldsig;
3152 #if defined(USE_ITHREADS) && !defined(WIN32)
3153 /* only "parent" interpreter can diddle signals */
3154 if (PL_curinterp != aTHX)
3155 return (Sighandler_t) SIG_ERR;
3159 oldsig = PerlProc_signal(signo, sig_trap);
3160 PerlProc_signal(signo, oldsig);
3162 PerlProc_kill(PerlProc_getpid(), signo);
3167 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3169 #if defined(USE_ITHREADS) && !defined(WIN32)
3170 /* only "parent" interpreter can diddle signals */
3171 if (PL_curinterp != aTHX)
3174 *save = PerlProc_signal(signo, handler);
3175 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
3179 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3181 #if defined(USE_ITHREADS) && !defined(WIN32)
3182 /* only "parent" interpreter can diddle signals */
3183 if (PL_curinterp != aTHX)
3186 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
3189 #endif /* !HAS_SIGACTION */
3190 #endif /* !PERL_MICRO */
3192 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
3193 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
3195 Perl_my_pclose(pTHX_ PerlIO *ptr)
3203 const int fd = PerlIO_fileno(ptr);
3206 svp = av_fetch(PL_fdpid,fd,TRUE);
3207 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3211 #if defined(USE_PERLIO)
3212 /* Find out whether the refcount is low enough for us to wait for the
3213 child proc without blocking. */
3214 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
3216 should_wait = pid > 0;
3220 if (pid == -1) { /* Opened by popen. */
3221 return my_syspclose(ptr);
3224 close_failed = (PerlIO_close(ptr) == EOF);
3226 if (should_wait) do {
3227 pid2 = wait4pid(pid, &status, 0);
3228 } while (pid2 == -1 && errno == EINTR);
3235 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
3239 #elif defined(__LIBCATAMOUNT__)
3241 Perl_my_pclose(pTHX_ PerlIO *ptr)
3245 #endif /* !DOSISH */
3247 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
3249 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3252 PERL_ARGS_ASSERT_WAIT4PID;
3253 #ifdef PERL_USES_PL_PIDSTATUS
3255 /* PERL_USES_PL_PIDSTATUS is only defined when neither
3256 waitpid() nor wait4() is available, or on OS/2, which
3257 doesn't appear to support waiting for a progress group
3258 member, so we can only treat a 0 pid as an unknown child.
3265 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3266 pid, rather than a string form. */
3267 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3268 if (svp && *svp != &PL_sv_undef) {
3269 *statusp = SvIVX(*svp);
3270 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3278 hv_iterinit(PL_pidstatus);
3279 if ((entry = hv_iternext(PL_pidstatus))) {
3280 SV * const sv = hv_iterval(PL_pidstatus,entry);
3282 const char * const spid = hv_iterkey(entry,&len);
3284 assert (len == sizeof(Pid_t));
3285 memcpy((char *)&pid, spid, len);
3286 *statusp = SvIVX(sv);
3287 /* The hash iterator is currently on this entry, so simply
3288 calling hv_delete would trigger the lazy delete, which on
3289 aggregate does more work, because next call to hv_iterinit()
3290 would spot the flag, and have to call the delete routine,
3291 while in the meantime any new entries can't re-use that
3293 hv_iterinit(PL_pidstatus);
3294 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3301 # ifdef HAS_WAITPID_RUNTIME
3302 if (!HAS_WAITPID_RUNTIME)
3305 result = PerlProc_waitpid(pid,statusp,flags);
3308 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3309 result = wait4(pid,statusp,flags,NULL);
3312 #ifdef PERL_USES_PL_PIDSTATUS
3313 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3318 Perl_croak(aTHX_ "Can't do waitpid with flags");
3320 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3321 pidgone(result,*statusp);
3327 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3330 if (result < 0 && errno == EINTR) {
3332 errno = EINTR; /* reset in case a signal handler changed $! */
3336 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3338 #ifdef PERL_USES_PL_PIDSTATUS
3340 S_pidgone(pTHX_ Pid_t pid, int status)
3344 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3345 SvUPGRADE(sv,SVt_IV);
3346 SvIV_set(sv, status);
3354 int /* Cannot prototype with I32
3356 my_syspclose(PerlIO *ptr)
3359 Perl_my_pclose(pTHX_ PerlIO *ptr)
3362 /* Needs work for PerlIO ! */
3363 FILE * const f = PerlIO_findFILE(ptr);
3364 const I32 result = pclose(f);
3365 PerlIO_releaseFILE(ptr,f);
3373 Perl_my_pclose(pTHX_ PerlIO *ptr)
3375 /* Needs work for PerlIO ! */
3376 FILE * const f = PerlIO_findFILE(ptr);
3377 I32 result = djgpp_pclose(f);
3378 result = (result << 8) & 0xff00;
3379 PerlIO_releaseFILE(ptr,f);
3384 #define PERL_REPEATCPY_LINEAR 4
3386 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3388 PERL_ARGS_ASSERT_REPEATCPY;
3393 croak_memory_wrap();
3396 memset(to, *from, count);
3399 IV items, linear, half;
3401 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3402 for (items = 0; items < linear; ++items) {
3403 const char *q = from;
3405 for (todo = len; todo > 0; todo--)
3410 while (items <= half) {
3411 IV size = items * len;
3412 memcpy(p, to, size);
3418 memcpy(p, to, (count - items) * len);
3424 Perl_same_dirent(pTHX_ const char *a, const char *b)
3426 char *fa = strrchr(a,'/');
3427 char *fb = strrchr(b,'/');
3430 SV * const tmpsv = sv_newmortal();
3432 PERL_ARGS_ASSERT_SAME_DIRENT;
3445 sv_setpvs(tmpsv, ".");
3447 sv_setpvn(tmpsv, a, fa - a);
3448 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3451 sv_setpvs(tmpsv, ".");
3453 sv_setpvn(tmpsv, b, fb - b);
3454 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3456 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3457 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3459 #endif /* !HAS_RENAME */
3462 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3463 const char *const *const search_ext, I32 flags)
3465 const char *xfound = NULL;
3466 char *xfailed = NULL;
3467 char tmpbuf[MAXPATHLEN];
3472 #if defined(DOSISH) && !defined(OS2)
3473 # define SEARCH_EXTS ".bat", ".cmd", NULL
3474 # define MAX_EXT_LEN 4
3477 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3478 # define MAX_EXT_LEN 4
3481 # define SEARCH_EXTS ".pl", ".com", NULL
3482 # define MAX_EXT_LEN 4
3484 /* additional extensions to try in each dir if scriptname not found */
3486 static const char *const exts[] = { SEARCH_EXTS };
3487 const char *const *const ext = search_ext ? search_ext : exts;
3488 int extidx = 0, i = 0;
3489 const char *curext = NULL;
3491 PERL_UNUSED_ARG(search_ext);
3492 # define MAX_EXT_LEN 0
3495 PERL_ARGS_ASSERT_FIND_SCRIPT;
3498 * If dosearch is true and if scriptname does not contain path
3499 * delimiters, search the PATH for scriptname.
3501 * If SEARCH_EXTS is also defined, will look for each
3502 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3503 * while searching the PATH.
3505 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3506 * proceeds as follows:
3507 * If DOSISH or VMSISH:
3508 * + look for ./scriptname{,.foo,.bar}
3509 * + search the PATH for scriptname{,.foo,.bar}
3512 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3513 * this will not look in '.' if it's not in the PATH)
3518 # ifdef ALWAYS_DEFTYPES
3519 len = strlen(scriptname);
3520 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3521 int idx = 0, deftypes = 1;
3524 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3527 int idx = 0, deftypes = 1;
3530 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3532 /* The first time through, just add SEARCH_EXTS to whatever we
3533 * already have, so we can check for default file types. */
3535 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3542 if ((strlen(tmpbuf) + strlen(scriptname)
3543 + MAX_EXT_LEN) >= sizeof tmpbuf)
3544 continue; /* don't search dir with too-long name */
3545 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3549 if (strEQ(scriptname, "-"))
3551 if (dosearch) { /* Look in '.' first. */
3552 const char *cur = scriptname;
3554 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3556 if (strEQ(ext[i++],curext)) {
3557 extidx = -1; /* already has an ext */
3562 DEBUG_p(PerlIO_printf(Perl_debug_log,
3563 "Looking for %s\n",cur));
3566 if (PerlLIO_stat(cur,&statbuf) >= 0
3567 && !S_ISDIR(statbuf.st_mode)) {
3576 if (cur == scriptname) {
3577 len = strlen(scriptname);
3578 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3580 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3583 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3584 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3589 if (dosearch && !strchr(scriptname, '/')
3591 && !strchr(scriptname, '\\')
3593 && (s = PerlEnv_getenv("PATH")))
3597 bufend = s + strlen(s);
3598 while (s < bufend) {
3602 && *s != ';'; len++, s++) {
3603 if (len < sizeof tmpbuf)
3606 if (len < sizeof tmpbuf)
3609 s = delimcpy_no_escape(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3614 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3615 continue; /* don't search dir with too-long name */
3618 && tmpbuf[len - 1] != '/'
3619 && tmpbuf[len - 1] != '\\'
3622 tmpbuf[len++] = '/';
3623 if (len == 2 && tmpbuf[0] == '.')
3625 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3629 len = strlen(tmpbuf);
3630 if (extidx > 0) /* reset after previous loop */
3634 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3635 retval = PerlLIO_stat(tmpbuf,&statbuf);
3636 if (S_ISDIR(statbuf.st_mode)) {
3640 } while ( retval < 0 /* not there */
3641 && extidx>=0 && ext[extidx] /* try an extension? */
3642 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3647 if (S_ISREG(statbuf.st_mode)
3648 && cando(S_IRUSR,TRUE,&statbuf)
3649 #if !defined(DOSISH)
3650 && cando(S_IXUSR,TRUE,&statbuf)
3654 xfound = tmpbuf; /* bingo! */
3658 xfailed = savepv(tmpbuf);
3663 if (!xfound && !seen_dot && !xfailed &&
3664 (PerlLIO_stat(scriptname,&statbuf) < 0
3665 || S_ISDIR(statbuf.st_mode)))
3667 seen_dot = 1; /* Disable message. */
3672 if (flags & 1) { /* do or die? */
3673 /* diag_listed_as: Can't execute %s */
3674 Perl_croak(aTHX_ "Can't %s %s%s%s",
3675 (xfailed ? "execute" : "find"),
3676 (xfailed ? xfailed : scriptname),
3677 (xfailed ? "" : " on PATH"),
3678 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3683 scriptname = xfound;
3685 return (scriptname ? savepv(scriptname) : NULL);
3688 #ifndef PERL_GET_CONTEXT_DEFINED
3691 Perl_get_context(void)
3693 #if defined(USE_ITHREADS)
3694 # ifdef OLD_PTHREADS_API
3696 int error = pthread_getspecific(PL_thr_key, &t);
3698 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3700 # elif defined(I_MACH_CTHREADS)
3701 return (void*)cthread_data(cthread_self());
3703 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3711 Perl_set_context(void *t)
3713 #if defined(USE_ITHREADS)
3715 PERL_ARGS_ASSERT_SET_CONTEXT;
3716 #if defined(USE_ITHREADS)
3717 # ifdef I_MACH_CTHREADS
3718 cthread_set_data(cthread_self(), t);
3721 const int error = pthread_setspecific(PL_thr_key, t);
3723 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3731 #endif /* !PERL_GET_CONTEXT_DEFINED */
3734 Perl_get_op_names(pTHX)
3736 PERL_UNUSED_CONTEXT;
3737 return (char **)PL_op_name;
3741 Perl_get_op_descs(pTHX)
3743 PERL_UNUSED_CONTEXT;
3744 return (char **)PL_op_desc;
3748 Perl_get_no_modify(pTHX)
3750 PERL_UNUSED_CONTEXT;
3751 return PL_no_modify;
3755 Perl_get_opargs(pTHX)
3757 PERL_UNUSED_CONTEXT;
3758 return (U32 *)PL_opargs;
3762 Perl_get_ppaddr(pTHX)
3764 PERL_UNUSED_CONTEXT;
3765 return (PPADDR_t*)PL_ppaddr;
3768 #ifndef HAS_GETENV_LEN
3770 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3772 char * const env_trans = PerlEnv_getenv(env_elem);
3773 PERL_UNUSED_CONTEXT;
3774 PERL_ARGS_ASSERT_GETENV_LEN;
3776 *len = strlen(env_trans);
3783 Perl_get_vtbl(pTHX_ int vtbl_id)
3785 PERL_UNUSED_CONTEXT;
3787 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3788 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3792 Perl_my_fflush_all(pTHX)
3794 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3795 return PerlIO_flush(NULL);
3797 # if defined(HAS__FWALK)
3798 extern int fflush(FILE *);
3799 /* undocumented, unprototyped, but very useful BSDism */
3800 extern void _fwalk(int (*)(FILE *));
3804 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3806 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3807 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3808 # elif defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3809 open_max = sysconf(_SC_OPEN_MAX);
3810 # elif defined(FOPEN_MAX)
3811 open_max = FOPEN_MAX;
3812 # elif defined(OPEN_MAX)
3813 open_max = OPEN_MAX;
3814 # elif defined(_NFILE)
3819 for (i = 0; i < open_max; i++)
3820 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3821 STDIO_STREAM_ARRAY[i]._file < open_max &&
3822 STDIO_STREAM_ARRAY[i]._flag)
3823 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3827 SETERRNO(EBADF,RMS_IFI);
3834 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3836 if (ckWARN(WARN_IO)) {
3838 = gv && (isGV_with_GP(gv))
3841 const char * const direction = have == '>' ? "out" : "in";
3843 if (name && HEK_LEN(name))
3844 Perl_warner(aTHX_ packWARN(WARN_IO),
3845 "Filehandle %" HEKf " opened only for %sput",
3846 HEKfARG(name), direction);
3848 Perl_warner(aTHX_ packWARN(WARN_IO),
3849 "Filehandle opened only for %sput", direction);
3854 Perl_report_evil_fh(pTHX_ const GV *gv)
3856 const IO *io = gv ? GvIO(gv) : NULL;
3857 const PERL_BITFIELD16 op = PL_op->op_type;
3861 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3863 warn_type = WARN_CLOSED;
3867 warn_type = WARN_UNOPENED;
3870 if (ckWARN(warn_type)) {
3872 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3873 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3874 const char * const pars =
3875 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3876 const char * const func =
3878 (op == OP_READLINE || op == OP_RCATLINE
3879 ? "readline" : /* "<HANDLE>" not nice */
3880 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3882 const char * const type =
3884 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3885 ? "socket" : "filehandle");
3886 const bool have_name = name && SvCUR(name);
3887 Perl_warner(aTHX_ packWARN(warn_type),
3888 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3889 have_name ? " " : "",
3890 SVfARG(have_name ? name : &PL_sv_no));
3891 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3893 aTHX_ packWARN(warn_type),
3894 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3895 func, pars, have_name ? " " : "",
3896 SVfARG(have_name ? name : &PL_sv_no)
3901 /* To workaround core dumps from the uninitialised tm_zone we get the
3902 * system to give us a reasonable struct to copy. This fix means that
3903 * strftime uses the tm_zone and tm_gmtoff values returned by
3904 * localtime(time()). That should give the desired result most of the
3905 * time. But probably not always!
3907 * This does not address tzname aspects of NETaa14816.
3912 # ifndef STRUCT_TM_HASZONE
3913 # define STRUCT_TM_HASZONE
3917 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3918 # ifndef HAS_TM_TM_ZONE
3919 # define HAS_TM_TM_ZONE
3924 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3926 #ifdef HAS_TM_TM_ZONE
3928 const struct tm* my_tm;
3929 PERL_UNUSED_CONTEXT;
3930 PERL_ARGS_ASSERT_INIT_TM;
3932 ENV_LOCALE_READ_LOCK;
3933 my_tm = localtime(&now);
3935 Copy(my_tm, ptm, 1, struct tm);
3936 ENV_LOCALE_READ_UNLOCK;
3938 PERL_UNUSED_CONTEXT;
3939 PERL_ARGS_ASSERT_INIT_TM;
3940 PERL_UNUSED_ARG(ptm);
3945 =for apidoc_section $time
3946 =for apidoc mini_mktime
3947 normalise S<C<struct tm>> values without the localtime() semantics (and
3948 overhead) of mktime().
3953 Perl_mini_mktime(struct tm *ptm)
3957 int month, mday, year, jday;
3958 int odd_cent, odd_year;
3960 PERL_ARGS_ASSERT_MINI_MKTIME;
3962 #define DAYS_PER_YEAR 365
3963 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3964 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3965 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3966 #define SECS_PER_HOUR (60*60)
3967 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3968 /* parentheses deliberately absent on these two, otherwise they don't work */
3969 #define MONTH_TO_DAYS 153/5
3970 #define DAYS_TO_MONTH 5/153
3971 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3972 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3973 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3974 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3977 * Year/day algorithm notes:
3979 * With a suitable offset for numeric value of the month, one can find
3980 * an offset into the year by considering months to have 30.6 (153/5) days,
3981 * using integer arithmetic (i.e., with truncation). To avoid too much
3982 * messing about with leap days, we consider January and February to be
3983 * the 13th and 14th month of the previous year. After that transformation,
3984 * we need the month index we use to be high by 1 from 'normal human' usage,
3985 * so the month index values we use run from 4 through 15.
3987 * Given that, and the rules for the Gregorian calendar (leap years are those
3988 * divisible by 4 unless also divisible by 100, when they must be divisible
3989 * by 400 instead), we can simply calculate the number of days since some
3990 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3991 * the days we derive from our month index, and adding in the day of the
3992 * month. The value used here is not adjusted for the actual origin which
3993 * it normally would use (1 January A.D. 1), since we're not exposing it.
3994 * We're only building the value so we can turn around and get the
3995 * normalised values for the year, month, day-of-month, and day-of-year.
3997 * For going backward, we need to bias the value we're using so that we find
3998 * the right year value. (Basically, we don't want the contribution of
3999 * March 1st to the number to apply while deriving the year). Having done
4000 * that, we 'count up' the contribution to the year number by accounting for
4001 * full quadracenturies (400-year periods) with their extra leap days, plus
4002 * the contribution from full centuries (to avoid counting in the lost leap
4003 * days), plus the contribution from full quad-years (to count in the normal
4004 * leap days), plus the leftover contribution from any non-leap years.
4005 * At this point, if we were working with an actual leap day, we'll have 0
4006 * days left over. This is also true for March 1st, however. So, we have
4007 * to special-case that result, and (earlier) keep track of the 'odd'
4008 * century and year contributions. If we got 4 extra centuries in a qcent,
4009 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
4010 * Otherwise, we add back in the earlier bias we removed (the 123 from
4011 * figuring in March 1st), find the month index (integer division by 30.6),
4012 * and the remainder is the day-of-month. We then have to convert back to
4013 * 'real' months (including fixing January and February from being 14/15 in
4014 * the previous year to being in the proper year). After that, to get
4015 * tm_yday, we work with the normalised year and get a new yearday value for
4016 * January 1st, which we subtract from the yearday value we had earlier,
4017 * representing the date we've re-built. This is done from January 1
4018 * because tm_yday is 0-origin.
4020 * Since POSIX time routines are only guaranteed to work for times since the
4021 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
4022 * applies Gregorian calendar rules even to dates before the 16th century
4023 * doesn't bother me. Besides, you'd need cultural context for a given
4024 * date to know whether it was Julian or Gregorian calendar, and that's
4025 * outside the scope for this routine. Since we convert back based on the
4026 * same rules we used to build the yearday, you'll only get strange results
4027 * for input which needed normalising, or for the 'odd' century years which
4028 * were leap years in the Julian calendar but not in the Gregorian one.
4029 * I can live with that.
4031 * This algorithm also fails to handle years before A.D. 1 gracefully, but
4032 * that's still outside the scope for POSIX time manipulation, so I don't
4038 year = 1900 + ptm->tm_year;
4039 month = ptm->tm_mon;
4040 mday = ptm->tm_mday;
4046 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
4047 yearday += month*MONTH_TO_DAYS + mday + jday;
4049 * Note that we don't know when leap-seconds were or will be,
4050 * so we have to trust the user if we get something which looks
4051 * like a sensible leap-second. Wild values for seconds will
4052 * be rationalised, however.
4054 if ((unsigned) ptm->tm_sec <= 60) {
4061 secs += 60 * ptm->tm_min;
4062 secs += SECS_PER_HOUR * ptm->tm_hour;
4064 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
4065 /* got negative remainder, but need positive time */
4066 /* back off an extra day to compensate */
4067 yearday += (secs/SECS_PER_DAY)-1;
4068 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
4071 yearday += (secs/SECS_PER_DAY);
4072 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
4075 else if (secs >= SECS_PER_DAY) {
4076 yearday += (secs/SECS_PER_DAY);
4077 secs %= SECS_PER_DAY;
4079 ptm->tm_hour = secs/SECS_PER_HOUR;
4080 secs %= SECS_PER_HOUR;
4081 ptm->tm_min = secs/60;
4083 ptm->tm_sec += secs;
4084 /* done with time of day effects */
4086 * The algorithm for yearday has (so far) left it high by 428.
4087 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
4088 * bias it by 123 while trying to figure out what year it
4089 * really represents. Even with this tweak, the reverse
4090 * translation fails for years before A.D. 0001.
4091 * It would still fail for Feb 29, but we catch that one below.
4093 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
4094 yearday -= YEAR_ADJUST;
4095 year = (yearday / DAYS_PER_QCENT) * 400;
4096 yearday %= DAYS_PER_QCENT;
4097 odd_cent = yearday / DAYS_PER_CENT;
4098 year += odd_cent * 100;
4099 yearday %= DAYS_PER_CENT;
4100 year += (yearday / DAYS_PER_QYEAR) * 4;
4101 yearday %= DAYS_PER_QYEAR;
4102 odd_year = yearday / DAYS_PER_YEAR;
4104 yearday %= DAYS_PER_YEAR;
4105 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
4110 yearday += YEAR_ADJUST; /* recover March 1st crock */
4111 month = yearday*DAYS_TO_MONTH;
4112 yearday -= month*MONTH_TO_DAYS;
4113 /* recover other leap-year adjustment */
4122 ptm->tm_year = year - 1900;
4124 ptm->tm_mday = yearday;
4125 ptm->tm_mon = month;
4129 ptm->tm_mon = month - 1;
4131 /* re-build yearday based on Jan 1 to get tm_yday */
4133 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
4134 yearday += 14*MONTH_TO_DAYS + 1;
4135 ptm->tm_yday = jday - yearday;
4136 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
4140 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)
4145 =for apidoc_section $time
4146 =for apidoc my_strftime
4147 strftime(), but with a different API so that the return value is a pointer
4148 to the formatted result (which MUST be arranged to be FREED BY THE
4149 CALLER). This allows this function to increase the buffer size as needed,
4150 so that the caller doesn't have to worry about that.
4152 Note that yday and wday effectively are ignored by this function, as
4153 mini_mktime() overwrites them
4163 PERL_ARGS_ASSERT_MY_STRFTIME;
4165 init_tm(&mytm); /* XXX workaround - see init_tm() above */
4168 mytm.tm_hour = hour;
4169 mytm.tm_mday = mday;
4171 mytm.tm_year = year;
4172 mytm.tm_wday = wday;
4173 mytm.tm_yday = yday;
4174 mytm.tm_isdst = isdst;
4176 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
4177 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
4182 #ifdef HAS_TM_TM_GMTOFF
4183 mytm.tm_gmtoff = mytm2.tm_gmtoff;
4185 #ifdef HAS_TM_TM_ZONE
4186 mytm.tm_zone = mytm2.tm_zone;
4191 Newx(buf, buflen, char);
4193 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
4194 len = strftime(buf, buflen, fmt, &mytm);
4195 GCC_DIAG_RESTORE_STMT;
4198 ** The following is needed to handle to the situation where
4199 ** tmpbuf overflows. Basically we want to allocate a buffer
4200 ** and try repeatedly. The reason why it is so complicated
4201 ** is that getting a return value of 0 from strftime can indicate
4202 ** one of the following:
4203 ** 1. buffer overflowed,
4204 ** 2. illegal conversion specifier, or
4205 ** 3. the format string specifies nothing to be returned(not
4206 ** an error). This could be because format is an empty string
4207 ** or it specifies %p that yields an empty string in some locale.
4208 ** If there is a better way to make it portable, go ahead by
4211 if (inRANGE(len, 1, buflen - 1) || (len == 0 && *fmt == '\0'))
4214 /* Possibly buf overflowed - try again with a bigger buf */
4215 const int fmtlen = strlen(fmt);
4216 int bufsize = fmtlen + buflen;
4218 Renew(buf, bufsize, char);
4221 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
4222 buflen = strftime(buf, bufsize, fmt, &mytm);
4223 GCC_DIAG_RESTORE_STMT;
4225 if (inRANGE(buflen, 1, bufsize - 1))
4227 /* heuristic to prevent out-of-memory errors */
4228 if (bufsize > 100*fmtlen) {
4234 Renew(buf, bufsize, char);
4239 Perl_croak(aTHX_ "panic: no strftime");
4245 #define SV_CWD_RETURN_UNDEF \
4249 #define SV_CWD_ISDOT(dp) \
4250 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4251 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4254 =for apidoc_section $utility
4256 =for apidoc getcwd_sv
4258 Fill C<sv> with current working directory
4263 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4264 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4265 * getcwd(3) if available
4266 * Comments from the original:
4267 * This is a faster version of getcwd. It's also more dangerous
4268 * because you might chdir out of a directory that you can't chdir
4272 Perl_getcwd_sv(pTHX_ SV *sv)
4277 PERL_ARGS_ASSERT_GETCWD_SV;
4281 char buf[MAXPATHLEN];
4283 /* Some getcwd()s automatically allocate a buffer of the given
4284 * size from the heap if they are given a NULL buffer pointer.
4285 * The problem is that this behaviour is not portable. */
4286 if (getcwd(buf, sizeof(buf) - 1)) {
4291 SV_CWD_RETURN_UNDEF;
4298 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4302 SvUPGRADE(sv, SVt_PV);
4304 if (PerlLIO_lstat(".", &statbuf) < 0) {
4305 SV_CWD_RETURN_UNDEF;
4308 orig_cdev = statbuf.st_dev;
4309 orig_cino = statbuf.st_ino;
4319 if (PerlDir_chdir("..") < 0) {
4320 SV_CWD_RETURN_UNDEF;
4322 if (PerlLIO_stat(".", &statbuf) < 0) {
4323 SV_CWD_RETURN_UNDEF;
4326 cdev = statbuf.st_dev;
4327 cino = statbuf.st_ino;
4329 if (odev == cdev && oino == cino) {
4332 if (!(dir = PerlDir_open("."))) {
4333 SV_CWD_RETURN_UNDEF;
4336 while ((dp = PerlDir_read(dir)) != NULL) {
4338 namelen = dp->d_namlen;
4340 namelen = strlen(dp->d_name);
4343 if (SV_CWD_ISDOT(dp)) {
4347 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4348 SV_CWD_RETURN_UNDEF;
4351 tdev = statbuf.st_dev;
4352 tino = statbuf.st_ino;
4353 if (tino == oino && tdev == odev) {
4359 SV_CWD_RETURN_UNDEF;
4362 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4363 SV_CWD_RETURN_UNDEF;
4366 SvGROW(sv, pathlen + namelen + 1);
4370 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4373 /* prepend current directory to the front */
4375 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4376 pathlen += (namelen + 1);
4378 #ifdef VOID_CLOSEDIR
4381 if (PerlDir_close(dir) < 0) {
4382 SV_CWD_RETURN_UNDEF;
4388 SvCUR_set(sv, pathlen);
4392 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4393 SV_CWD_RETURN_UNDEF;
4396 if (PerlLIO_stat(".", &statbuf) < 0) {
4397 SV_CWD_RETURN_UNDEF;
4400 cdev = statbuf.st_dev;
4401 cino = statbuf.st_ino;
4403 if (cdev != orig_cdev || cino != orig_cino) {
4404 Perl_croak(aTHX_ "Unstable directory path, "
4405 "current directory changed unexpectedly");
4418 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4419 # define EMULATE_SOCKETPAIR_UDP
4422 #ifdef EMULATE_SOCKETPAIR_UDP
4424 S_socketpair_udp (int fd[2]) {
4426 /* Fake a datagram socketpair using UDP to localhost. */
4427 int sockets[2] = {-1, -1};
4428 struct sockaddr_in addresses[2];
4430 Sock_size_t size = sizeof(struct sockaddr_in);
4431 unsigned short port;
4434 memset(&addresses, 0, sizeof(addresses));
4437 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4438 if (sockets[i] == -1)
4439 goto tidy_up_and_fail;
4441 addresses[i].sin_family = AF_INET;
4442 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4443 addresses[i].sin_port = 0; /* kernel choses port. */
4444 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4445 sizeof(struct sockaddr_in)) == -1)
4446 goto tidy_up_and_fail;
4449 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4450 for each connect the other socket to it. */
4453 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4455 goto tidy_up_and_fail;
4456 if (size != sizeof(struct sockaddr_in))
4457 goto abort_tidy_up_and_fail;
4458 /* !1 is 0, !0 is 1 */
4459 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4460 sizeof(struct sockaddr_in)) == -1)
4461 goto tidy_up_and_fail;
4464 /* Now we have 2 sockets connected to each other. I don't trust some other
4465 process not to have already sent a packet to us (by random) so send
4466 a packet from each to the other. */
4469 /* I'm going to send my own port number. As a short.
4470 (Who knows if someone somewhere has sin_port as a bitfield and needs
4471 this routine. (I'm assuming crays have socketpair)) */
4472 port = addresses[i].sin_port;
4473 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4474 if (got != sizeof(port)) {
4476 goto tidy_up_and_fail;
4477 goto abort_tidy_up_and_fail;
4481 /* Packets sent. I don't trust them to have arrived though.
4482 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4483 connect to localhost will use a second kernel thread. In 2.6 the
4484 first thread running the connect() returns before the second completes,
4485 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4486 returns 0. Poor programs have tripped up. One poor program's authors'
4487 had a 50-1 reverse stock split. Not sure how connected these were.)
4488 So I don't trust someone not to have an unpredictable UDP stack.
4492 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4493 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4497 FD_SET((unsigned int)sockets[0], &rset);
4498 FD_SET((unsigned int)sockets[1], &rset);
4500 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4501 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4502 || !FD_ISSET(sockets[1], &rset)) {
4503 /* I hope this is portable and appropriate. */
4505 goto tidy_up_and_fail;
4506 goto abort_tidy_up_and_fail;
4510 /* And the paranoia department even now doesn't trust it to have arrive
4511 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4513 struct sockaddr_in readfrom;
4514 unsigned short buffer[2];
4519 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4520 sizeof(buffer), MSG_DONTWAIT,
4521 (struct sockaddr *) &readfrom, &size);
4523 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4525 (struct sockaddr *) &readfrom, &size);
4529 goto tidy_up_and_fail;
4530 if (got != sizeof(port)
4531 || size != sizeof(struct sockaddr_in)
4532 /* Check other socket sent us its port. */
4533 || buffer[0] != (unsigned short) addresses[!i].sin_port
4534 /* Check kernel says we got the datagram from that socket */
4535 || readfrom.sin_family != addresses[!i].sin_family
4536 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4537 || readfrom.sin_port != addresses[!i].sin_port)
4538 goto abort_tidy_up_and_fail;
4541 /* My caller (my_socketpair) has validated that this is non-NULL */
4544 /* I hereby declare this connection open. May God bless all who cross
4548 abort_tidy_up_and_fail:
4549 errno = ECONNABORTED;
4553 if (sockets[0] != -1)
4554 PerlLIO_close(sockets[0]);
4555 if (sockets[1] != -1)
4556 PerlLIO_close(sockets[1]);
4561 #endif /* EMULATE_SOCKETPAIR_UDP */
4563 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4565 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4566 /* Stevens says that family must be AF_LOCAL, protocol 0.
4567 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4572 struct sockaddr_in listen_addr;
4573 struct sockaddr_in connect_addr;
4578 || family != AF_UNIX
4581 errno = EAFNOSUPPORT;
4590 type &= ~SOCK_CLOEXEC;
4593 #ifdef EMULATE_SOCKETPAIR_UDP
4594 if (type == SOCK_DGRAM)
4595 return S_socketpair_udp(fd);
4598 aTHXa(PERL_GET_THX);
4599 listener = PerlSock_socket(AF_INET, type, 0);
4602 memset(&listen_addr, 0, sizeof(listen_addr));
4603 listen_addr.sin_family = AF_INET;
4604 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4605 listen_addr.sin_port = 0; /* kernel choses port. */
4606 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4607 sizeof(listen_addr)) == -1)
4608 goto tidy_up_and_fail;
4609 if (PerlSock_listen(listener, 1) == -1)
4610 goto tidy_up_and_fail;
4612 connector = PerlSock_socket(AF_INET, type, 0);
4613 if (connector == -1)
4614 goto tidy_up_and_fail;
4615 /* We want to find out the port number to connect to. */
4616 size = sizeof(connect_addr);
4617 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4619 goto tidy_up_and_fail;
4620 if (size != sizeof(connect_addr))
4621 goto abort_tidy_up_and_fail;
4622 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4623 sizeof(connect_addr)) == -1)
4624 goto tidy_up_and_fail;
4626 size = sizeof(listen_addr);
4627 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4630 goto tidy_up_and_fail;
4631 if (size != sizeof(listen_addr))
4632 goto abort_tidy_up_and_fail;
4633 PerlLIO_close(listener);
4634 /* Now check we are talking to ourself by matching port and host on the
4636 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4638 goto tidy_up_and_fail;
4639 if (size != sizeof(connect_addr)
4640 || listen_addr.sin_family != connect_addr.sin_family
4641 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4642 || listen_addr.sin_port != connect_addr.sin_port) {
4643 goto abort_tidy_up_and_fail;
4649 abort_tidy_up_and_fail:
4651 errno = ECONNABORTED; /* This would be the standard thing to do. */
4652 #elif defined(ECONNREFUSED)
4653 errno = ECONNREFUSED; /* some OSes might not have ECONNABORTED. */
4655 errno = ETIMEDOUT; /* Desperation time. */
4661 PerlLIO_close(listener);
4662 if (connector != -1)
4663 PerlLIO_close(connector);
4665 PerlLIO_close(acceptor);
4671 /* In any case have a stub so that there's code corresponding
4672 * to the my_socketpair in embed.fnc. */
4674 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4675 #ifdef HAS_SOCKETPAIR
4676 return socketpair(family, type, protocol, fd);
4685 =for apidoc sv_nosharing
4687 Dummy routine which "shares" an SV when there is no sharing module present.
4688 Or "locks" it. Or "unlocks" it. In other
4689 words, ignores its single SV argument.
4690 Exists to avoid test for a C<NULL> function pointer and because it could
4691 potentially warn under some level of strict-ness.
4697 Perl_sv_nosharing(pTHX_ SV *sv)
4699 PERL_UNUSED_CONTEXT;
4700 PERL_UNUSED_ARG(sv);
4705 =for apidoc sv_destroyable
4707 Dummy routine which reports that object can be destroyed when there is no
4708 sharing module present. It ignores its single SV argument, and returns
4709 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4710 could potentially warn under some level of strict-ness.
4716 Perl_sv_destroyable(pTHX_ SV *sv)
4718 PERL_UNUSED_CONTEXT;
4719 PERL_UNUSED_ARG(sv);
4724 Perl_parse_unicode_opts(pTHX_ const char **popt)
4726 const char *p = *popt;
4729 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4733 const char* endptr = p + strlen(p);
4735 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4738 if (p && *p && *p != '\n' && *p != '\r') {
4740 goto the_end_of_the_opts_parser;
4742 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4746 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4752 case PERL_UNICODE_STDIN:
4753 opt |= PERL_UNICODE_STDIN_FLAG; break;
4754 case PERL_UNICODE_STDOUT:
4755 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4756 case PERL_UNICODE_STDERR:
4757 opt |= PERL_UNICODE_STDERR_FLAG; break;
4758 case PERL_UNICODE_STD:
4759 opt |= PERL_UNICODE_STD_FLAG; break;
4760 case PERL_UNICODE_IN:
4761 opt |= PERL_UNICODE_IN_FLAG; break;
4762 case PERL_UNICODE_OUT:
4763 opt |= PERL_UNICODE_OUT_FLAG; break;
4764 case PERL_UNICODE_INOUT:
4765 opt |= PERL_UNICODE_INOUT_FLAG; break;
4766 case PERL_UNICODE_LOCALE:
4767 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4768 case PERL_UNICODE_ARGV:
4769 opt |= PERL_UNICODE_ARGV_FLAG; break;
4770 case PERL_UNICODE_UTF8CACHEASSERT:
4771 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4773 if (*p != '\n' && *p != '\r') {
4774 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4777 "Unknown Unicode option letter '%c'", *p);
4784 opt = PERL_UNICODE_DEFAULT_FLAGS;
4786 the_end_of_the_opts_parser:
4788 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4789 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4790 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4798 # include <starlet.h>
4805 * This is really just a quick hack which grabs various garbage
4806 * values. It really should be a real hash algorithm which
4807 * spreads the effect of every input bit onto every output bit,
4808 * if someone who knows about such things would bother to write it.
4809 * Might be a good idea to add that function to CORE as well.
4810 * No numbers below come from careful analysis or anything here,
4811 * except they are primes and SEED_C1 > 1E6 to get a full-width
4812 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4813 * probably be bigger too.
4816 # define SEED_C1 1000003
4817 #define SEED_C4 73819
4819 # define SEED_C1 25747
4820 #define SEED_C4 20639
4824 #define SEED_C5 26107
4826 #ifndef PERL_NO_DEV_RANDOM
4830 #ifdef HAS_GETTIMEOFDAY
4831 struct timeval when;
4836 /* This test is an escape hatch, this symbol isn't set by Configure. */
4837 #ifndef PERL_NO_DEV_RANDOM
4838 #ifndef PERL_RANDOM_DEVICE
4839 /* /dev/random isn't used by default because reads from it will block
4840 * if there isn't enough entropy available. You can compile with
4841 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4842 * is enough real entropy to fill the seed. */
4843 # ifdef __amigaos4__
4844 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4846 # define PERL_RANDOM_DEVICE "/dev/urandom"
4849 fd = PerlLIO_open_cloexec(PERL_RANDOM_DEVICE, 0);
4851 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4859 #ifdef HAS_GETTIMEOFDAY
4860 PerlProc_gettimeofday(&when,NULL);
4861 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4864 u = (U32)SEED_C1 * when;
4866 u += SEED_C3 * (U32)PerlProc_getpid();
4867 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4868 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4869 u += SEED_C5 * (U32)PTR2UV(&when);
4875 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4877 #ifndef NO_PERL_HASH_ENV
4882 PERL_ARGS_ASSERT_GET_HASH_SEED;
4884 #ifndef NO_PERL_HASH_ENV
4885 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4889 /* ignore leading spaces */
4890 while (isSPACE(*env_pv))
4892 # ifdef USE_PERL_PERTURB_KEYS
4893 /* if they set it to "0" we disable key traversal randomization completely */
4894 if (strEQ(env_pv,"0")) {
4895 PL_hash_rand_bits_enabled= 0;
4897 /* otherwise switch to deterministic mode */
4898 PL_hash_rand_bits_enabled= 2;
4901 /* ignore a leading 0x... if it is there */
4902 if (env_pv[0] == '0' && env_pv[1] == 'x')
4905 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4906 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4907 if ( isXDIGIT(*env_pv)) {
4908 seed_buffer[i] |= READ_XDIGIT(env_pv);
4911 while (isSPACE(*env_pv))
4914 if (*env_pv && !isXDIGIT(*env_pv)) {
4915 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4917 /* should we check for unparsed crap? */
4918 /* should we warn about unused hex? */
4919 /* should we warn about insufficient hex? */
4922 #endif /* NO_PERL_HASH_ENV */
4924 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4925 seed_buffer[i] = (unsigned char)(Perl_internal_drand48() * (U8_MAX+1));
4928 #ifdef USE_PERL_PERTURB_KEYS
4929 { /* initialize PL_hash_rand_bits from the hash seed.
4930 * This value is highly volatile, it is updated every
4931 * hash insert, and is used as part of hash bucket chain
4932 * randomization and hash iterator randomization. */
4933 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4934 for( i = 0; i < sizeof(UV) ; i++ ) {
4935 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4936 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4939 # ifndef NO_PERL_HASH_ENV
4940 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4942 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4943 PL_hash_rand_bits_enabled= 0;
4944 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4945 PL_hash_rand_bits_enabled= 1;
4946 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4947 PL_hash_rand_bits_enabled= 2;
4949 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4958 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4959 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4960 * given, and you supply your own implementation.
4962 * The default implementation reads a single env var, PERL_MEM_LOG,
4963 * expecting one or more of the following:
4965 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4966 * 'm' - memlog was PERL_MEM_LOG=1
4967 * 's' - svlog was PERL_SV_LOG=1
4968 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4970 * This makes the logger controllable enough that it can reasonably be
4971 * added to the system perl.
4974 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4975 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4977 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4979 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4980 * writes to. In the default logger, this is settable at runtime.
4982 #ifndef PERL_MEM_LOG_FD
4983 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4986 #ifndef PERL_MEM_LOG_NOIMPL
4988 # ifdef DEBUG_LEAKING_SCALARS
4989 # define SV_LOG_SERIAL_FMT " [%lu]"
4990 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4992 # define SV_LOG_SERIAL_FMT
4993 # define _SV_LOG_SERIAL_ARG(sv)
4997 S_mem_log_common(enum mem_log_type mlt, const UV n,
4998 const UV typesize, const char *type_name, const SV *sv,
4999 Malloc_t oldalloc, Malloc_t newalloc,
5000 const char *filename, const int linenumber,
5001 const char *funcname)
5005 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
5007 /* Use plain getenv() to avoid potential deadlock with PerlEnv_getenv().
5008 * This means that 'pmlenv' is not protected from other threads overwriting
5009 * it on platforms where getenv() returns an internal static pointer. See
5011 pmlenv = getenv("PERL_MEM_LOG");
5014 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
5016 /* We can't use SVs or PerlIO for obvious reasons,
5017 * so we'll use stdio and low-level IO instead. */
5018 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
5020 # ifdef HAS_GETTIMEOFDAY
5021 # define MEM_LOG_TIME_FMT "%10d.%06d: "
5022 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
5024 gettimeofday(&tv, 0);
5026 # define MEM_LOG_TIME_FMT "%10d: "
5027 # define MEM_LOG_TIME_ARG (int)when
5031 /* If there are other OS specific ways of hires time than
5032 * gettimeofday() (see dist/Time-HiRes), the easiest way is
5033 * probably that they would be used to fill in the struct
5037 const char* endptr = pmlenv + strlen(pmlenv);
5040 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
5041 && uv && uv <= PERL_INT_MAX
5045 fd = PERL_MEM_LOG_FD;
5048 if (strchr(pmlenv, 't')) {
5049 len = my_snprintf(buf, sizeof(buf),
5050 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
5051 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
5055 len = my_snprintf(buf, sizeof(buf),
5056 "alloc: %s:%d:%s: %" IVdf " %" UVuf
5057 " %s = %" IVdf ": %" UVxf "\n",
5058 filename, linenumber, funcname, n, typesize,
5059 type_name, n * typesize, PTR2UV(newalloc));
5062 len = my_snprintf(buf, sizeof(buf),
5063 "realloc: %s:%d:%s: %" IVdf " %" UVuf
5064 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
5065 filename, linenumber, funcname, n, typesize,
5066 type_name, n * typesize, PTR2UV(oldalloc),
5070 len = my_snprintf(buf, sizeof(buf),
5071 "free: %s:%d:%s: %" UVxf "\n",
5072 filename, linenumber, funcname,
5077 len = my_snprintf(buf, sizeof(buf),
5078 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
5079 mlt == MLT_NEW_SV ? "new" : "del",
5080 filename, linenumber, funcname,
5081 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
5086 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
5090 #endif /* !PERL_MEM_LOG_NOIMPL */
5092 #ifndef PERL_MEM_LOG_NOIMPL
5094 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
5095 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
5097 /* this is suboptimal, but bug compatible. User is providing their
5098 own implementation, but is getting these functions anyway, and they
5099 do nothing. But _NOIMPL users should be able to cope or fix */
5101 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
5102 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
5106 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
5108 const char *filename, const int linenumber,
5109 const char *funcname)
5111 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
5113 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
5114 NULL, NULL, newalloc,
5115 filename, linenumber, funcname);
5120 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
5121 Malloc_t oldalloc, Malloc_t newalloc,
5122 const char *filename, const int linenumber,
5123 const char *funcname)
5125 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
5127 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
5128 NULL, oldalloc, newalloc,
5129 filename, linenumber, funcname);
5134 Perl_mem_log_free(Malloc_t oldalloc,
5135 const char *filename, const int linenumber,
5136 const char *funcname)
5138 PERL_ARGS_ASSERT_MEM_LOG_FREE;
5140 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
5141 filename, linenumber, funcname);
5146 Perl_mem_log_new_sv(const SV *sv,
5147 const char *filename, const int linenumber,
5148 const char *funcname)
5150 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
5151 filename, linenumber, funcname);
5155 Perl_mem_log_del_sv(const SV *sv,
5156 const char *filename, const int linenumber,
5157 const char *funcname)
5159 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
5160 filename, linenumber, funcname);
5163 #endif /* PERL_MEM_LOG */
5166 =for apidoc_section $string
5167 =for apidoc quadmath_format_valid
5169 C<quadmath_snprintf()> is very strict about its C<format> string and will
5170 fail, returning -1, if the format is invalid. It accepts exactly
5173 C<quadmath_format_valid()> checks that the intended single spec looks
5174 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
5175 and has C<Q> before it. This is not a full "printf syntax check",
5178 Returns true if it is valid, false if not.
5180 See also L</quadmath_format_needed>.
5186 Perl_quadmath_format_valid(const char* format)
5190 PERL_ARGS_ASSERT_QUADMATH_FORMAT_VALID;
5192 if (format[0] != '%' || strchr(format + 1, '%'))
5194 len = strlen(format);
5195 /* minimum length three: %Qg */
5196 if (len < 3 || memCHRs("efgaEFGA", format[len - 1]) == NULL)
5198 if (format[len - 2] != 'Q')
5205 =for apidoc quadmath_format_needed
5207 C<quadmath_format_needed()> returns true if the C<format> string seems to
5208 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
5209 or returns false otherwise.
5211 The format specifier detection is not complete printf-syntax detection,
5212 but it should catch most common cases.
5214 If true is returned, those arguments B<should> in theory be processed
5215 with C<quadmath_snprintf()>, but in case there is more than one such
5216 format specifier (see L</quadmath_format_valid>), and if there is
5217 anything else beyond that one (even just a single byte), they
5218 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
5219 accepting only one format spec, and nothing else.
5220 In this case, the code should probably fail.
5226 Perl_quadmath_format_needed(const char* format)
5228 const char *p = format;
5231 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5233 while ((q = strchr(p, '%'))) {
5235 if (*q == '+') /* plus */
5237 if (*q == '#') /* alt */
5239 if (*q == '*') /* width */
5243 while (isDIGIT(*q)) q++;
5246 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5251 while (isDIGIT(*q)) q++;
5253 if (memCHRs("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5262 =for apidoc my_snprintf
5264 The C library C<snprintf> functionality, if available and
5265 standards-compliant (uses C<vsnprintf>, actually). However, if the
5266 C<vsnprintf> is not available, will unfortunately use the unsafe
5267 C<vsprintf> which can overrun the buffer (there is an overrun check,
5268 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5269 getting C<vsnprintf>.
5274 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5278 PERL_ARGS_ASSERT_MY_SNPRINTF;
5279 #ifndef HAS_VSNPRINTF
5280 PERL_UNUSED_VAR(len);
5282 va_start(ap, format);
5285 bool quadmath_valid = FALSE;
5286 if (quadmath_format_valid(format)) {
5287 /* If the format looked promising, use it as quadmath. */
5288 retval = quadmath_snprintf(buffer, len, format, va_arg(ap, NV));
5290 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5292 quadmath_valid = TRUE;
5294 /* quadmath_format_single() will return false for example for
5295 * "foo = %g", or simply "%g". We could handle the %g by
5296 * using quadmath for the NV args. More complex cases of
5297 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5298 * quadmath-valid but has stuff in front).
5300 * Handling the "Q-less" cases right would require walking
5301 * through the va_list and rewriting the format, calling
5302 * quadmath for the NVs, building a new va_list, and then
5303 * letting vsnprintf/vsprintf to take care of the other
5304 * arguments. This may be doable.
5306 * We do not attempt that now. But for paranoia, we here try
5307 * to detect some common (but not all) cases where the
5308 * "Q-less" %[efgaEFGA] formats are present, and die if
5309 * detected. This doesn't fix the problem, but it stops the
5310 * vsnprintf/vsprintf pulling doubles off the va_list when
5311 * __float128 NVs should be pulled off instead.
5313 * If quadmath_format_needed() returns false, we are reasonably
5314 * certain that we can call vnsprintf() or vsprintf() safely. */
5315 if (!quadmath_valid && quadmath_format_needed(format))
5316 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5321 #ifdef HAS_VSNPRINTF
5322 retval = vsnprintf(buffer, len, format, ap);
5324 retval = vsprintf(buffer, format, ap);
5327 /* vsprintf() shows failure with < 0 */
5329 #ifdef HAS_VSNPRINTF
5330 /* vsnprintf() shows failure with >= len */
5332 (len > 0 && (Size_t)retval >= len)
5335 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5340 =for apidoc my_vsnprintf
5342 The C library C<vsnprintf> if available and standards-compliant.
5343 However, if the C<vsnprintf> is not available, will unfortunately
5344 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5345 overrun check, but that may be too late). Consider using
5346 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5351 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5354 PERL_UNUSED_ARG(buffer);
5355 PERL_UNUSED_ARG(len);
5356 PERL_UNUSED_ARG(format);
5357 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5358 PERL_UNUSED_ARG((void*)ap);
5359 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5366 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5367 Perl_va_copy(ap, apc);
5368 # ifdef HAS_VSNPRINTF
5369 retval = vsnprintf(buffer, len, format, apc);
5371 PERL_UNUSED_ARG(len);
5372 retval = vsprintf(buffer, format, apc);
5376 # ifdef HAS_VSNPRINTF
5377 retval = vsnprintf(buffer, len, format, ap);
5379 PERL_UNUSED_ARG(len);
5380 retval = vsprintf(buffer, format, ap);
5382 #endif /* #ifdef NEED_VA_COPY */
5383 /* vsprintf() shows failure with < 0 */
5385 #ifdef HAS_VSNPRINTF
5386 /* vsnprintf() shows failure with >= len */
5388 (len > 0 && (Size_t)retval >= len)
5391 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5397 Perl_my_clearenv(pTHX)
5399 #if ! defined(PERL_MICRO)
5400 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5402 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5403 # if defined(USE_ENVIRON_ARRAY)
5404 # if defined(USE_ITHREADS)
5405 /* only the parent thread can clobber the process environment, so no need
5407 if (PL_curinterp == aTHX)
5408 # endif /* USE_ITHREADS */
5410 # if ! defined(PERL_USE_SAFE_PUTENV)
5411 if ( !PL_use_safe_putenv) {
5413 if (environ == PL_origenviron)
5414 environ = (char**)safesysmalloc(sizeof(char*));
5416 for (i = 0; environ[i]; i++)
5417 (void)safesysfree(environ[i]);
5420 # else /* PERL_USE_SAFE_PUTENV */
5421 # if defined(HAS_CLEARENV)
5423 # elif defined(HAS_UNSETENV)
5424 int bsiz = 80; /* Most envvar names will be shorter than this. */
5425 char *buf = (char*)safesysmalloc(bsiz);
5426 while (*environ != NULL) {
5427 char *e = strchr(*environ, '=');
5428 int l = e ? e - *environ : (int)strlen(*environ);
5430 (void)safesysfree(buf);
5431 bsiz = l + 1; /* + 1 for the \0. */
5432 buf = (char*)safesysmalloc(bsiz);
5434 memcpy(buf, *environ, l);
5436 (void)unsetenv(buf);
5438 (void)safesysfree(buf);
5439 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5440 /* Just null environ and accept the leakage. */
5442 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5443 # endif /* ! PERL_USE_SAFE_PUTENV */
5445 # endif /* USE_ENVIRON_ARRAY */
5446 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5447 #endif /* PERL_MICRO */
5450 #ifdef PERL_IMPLICIT_CONTEXT
5453 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5454 the global PL_my_cxt_index is incremented, and that value is assigned to
5455 that module's static my_cxt_index (who's address is passed as an arg).
5456 Then, for each interpreter this function is called for, it makes sure a
5457 void* slot is available to hang the static data off, by allocating or
5458 extending the interpreter's PL_my_cxt_list array */
5461 Perl_my_cxt_init(pTHX_ int *indexp, size_t size)
5466 PERL_ARGS_ASSERT_MY_CXT_INIT;
5469 /* do initial check without locking.
5470 * -1: not allocated or another thread currently allocating
5471 * other: already allocated by another thread
5474 MUTEX_LOCK(&PL_my_ctx_mutex);
5475 /*now a stricter check with locking */
5478 /* this module hasn't been allocated an index yet */
5479 *indexp = PL_my_cxt_index++;
5481 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5484 /* make sure the array is big enough */
5485 if (PL_my_cxt_size <= index) {
5486 if (PL_my_cxt_size) {
5487 IV new_size = PL_my_cxt_size;
5488 while (new_size <= index)
5490 Renew(PL_my_cxt_list, new_size, void *);
5491 PL_my_cxt_size = new_size;
5494 PL_my_cxt_size = 16;
5495 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5498 /* newSV() allocates one more than needed */
5499 p = (void*)SvPVX(newSV(size-1));
5500 PL_my_cxt_list[index] = p;
5501 Zero(p, size, char);
5505 #endif /* PERL_IMPLICIT_CONTEXT */
5508 /* Perl_xs_handshake():
5509 implement the various XS_*_BOOTCHECK macros, which are added to .c
5510 files by ExtUtils::ParseXS, to check that the perl the module was built
5511 with is binary compatible with the running perl.
5514 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5515 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5517 The meaning of the varargs is determined the U32 key arg (which is not
5518 a format string). The fields of key are assembled by using HS_KEY().
5520 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5521 "PerlInterpreter *" and represents the callers context; otherwise it is
5522 of type "CV *", and is the boot xsub's CV.
5524 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5525 for example, and IO.dll was linked with threaded perl524.dll, and both
5526 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5527 successfully can load IO.dll into the process but simultaneously it
5528 loaded an interpreter of a different version into the process, and XS
5529 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5530 use through perl526.dll's my_perl->Istack_base.
5532 v_my_perl cannot be the first arg, since then 'key' will be out of
5533 place in a threaded vs non-threaded mixup; and analyzing the key
5534 number's bitfields won't reveal the problem, since it will be a valid
5535 key (unthreaded perl) on interp side, but croak will report the XS mod's
5536 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5537 it's a threaded perl and an unthreaded XS module, threaded perl will
5538 look at an uninit C stack or an uninit register to get 'key'
5539 (remember that it assumes that the 1st arg is the interp cxt).
5541 'file' is the source filename of the caller.
5545 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5551 #ifdef PERL_IMPLICIT_CONTEXT
5558 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5559 va_start(args, file);
5561 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5562 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5563 if (UNLIKELY(got != need))
5565 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5566 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5567 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5568 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5569 passed to the XS DLL */
5570 #ifdef PERL_IMPLICIT_CONTEXT
5571 xs_interp = (tTHX)v_my_perl;
5575 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5576 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5577 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5578 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5579 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5580 location in the unthreaded perl binary) stored in CV * to figure out if this
5581 Perl_xs_handshake was called by the same pp_entersub */
5582 cv = (CV*)v_my_perl;
5583 xs_spp = (SV***)CvHSCXT(cv);
5585 need = &PL_stack_sp;
5587 if(UNLIKELY(got != need)) {
5588 bad_handshake:/* recycle branch and string from above */
5589 if(got != (void *)HSf_NOCHK)
5590 noperl_die("%s: loadable library and perl binaries are mismatched"
5591 " (got handshake key %p, needed %p)\n",
5595 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5596 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5597 PL_xsubfilename = file; /* so the old name must be restored for
5598 additional XSUBs to register themselves */
5599 /* XSUBs can't be perl lang/perl5db.pl debugged
5600 if (PERLDB_LINE_OR_SAVESRC)
5601 (void)gv_fetchfile(file); */
5604 if(key & HSf_POPMARK) {
5606 { SV **mark = PL_stack_base + ax++;
5608 items = (I32)(SP - MARK);
5612 items = va_arg(args, U32);
5613 ax = va_arg(args, U32);
5617 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5618 if((apiverlen = HS_GETAPIVERLEN(key))) {
5619 char * api_p = va_arg(args, char*);
5620 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5621 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5622 sizeof("v" PERL_API_VERSION_STRING)-1))
5623 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5624 api_p, SVfARG(PL_stack_base[ax + 0]),
5625 "v" PERL_API_VERSION_STRING);
5630 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5631 if((xsverlen = HS_GETXSVERLEN(key)))
5632 S_xs_version_bootcheck(aTHX_
5633 items, ax, va_arg(args, char*), xsverlen);
5641 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5645 const char *vn = NULL;
5646 SV *const module = PL_stack_base[ax];
5648 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5650 if (items >= 2) /* version supplied as bootstrap arg */
5651 sv = PL_stack_base[ax + 1];
5653 /* XXX GV_ADDWARN */
5655 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5656 if (!sv || !SvOK(sv)) {
5658 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5662 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5663 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5664 ? sv : sv_2mortal(new_version(sv));
5665 xssv = upg_version(xssv, 0);
5666 if ( vcmp(pmsv,xssv) ) {
5667 SV *string = vstringify(xssv);
5668 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5669 " does not match ", SVfARG(module), SVfARG(string));
5671 SvREFCNT_dec(string);
5672 string = vstringify(pmsv);
5675 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5678 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5680 SvREFCNT_dec(string);
5682 Perl_sv_2mortal(aTHX_ xpt);
5683 Perl_croak_sv(aTHX_ xpt);
5689 =for apidoc my_strlcat
5691 The C library C<strlcat> if available, or a Perl implementation of it.
5692 This operates on C C<NUL>-terminated strings.
5694 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5695 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5696 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5697 practice this should not happen as it means that either C<size> is incorrect or
5698 that C<dst> is not a proper C<NUL>-terminated string).
5700 Note that C<size> is the full size of the destination buffer and
5701 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5702 room for the C<NUL> should be included in C<size>.
5704 The return value is the total length that C<dst> would have if C<size> is
5705 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5706 C<src>. If C<size> is smaller than the return, the excess was not appended.
5710 Description stolen from http://man.openbsd.org/strlcat.3
5714 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5716 Size_t used, length, copy;
5719 length = strlen(src);
5720 if (size > 0 && used < size - 1) {
5721 copy = (length >= size - used) ? size - used - 1 : length;
5722 memcpy(dst + used, src, copy);
5723 dst[used + copy] = '\0';
5725 return used + length;
5731 =for apidoc my_strlcpy
5733 The C library C<strlcpy> if available, or a Perl implementation of it.
5734 This operates on C C<NUL>-terminated strings.
5736 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5737 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5739 The return value is the total length C<src> would be if the copy completely
5740 succeeded. If it is larger than C<size>, the excess was not copied.
5744 Description stolen from http://man.openbsd.org/strlcpy.3
5748 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5750 Size_t length, copy;
5752 length = strlen(src);
5754 copy = (length >= size) ? size - 1 : length;
5755 memcpy(dst, src, copy);
5762 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5763 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5764 long _ftol( double ); /* Defined by VC6 C libs. */
5765 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5768 PERL_STATIC_INLINE bool
5769 S_gv_has_usable_name(pTHX_ GV *gv)
5773 && HvENAME(GvSTASH(gv))
5774 && (gvp = (GV **)hv_fetchhek(
5775 GvSTASH(gv), GvNAME_HEK(gv), 0
5781 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5783 SV * const dbsv = GvSVn(PL_DBsub);
5784 const bool save_taint = TAINT_get;
5786 /* When we are called from pp_goto (svp is null),
5787 * we do not care about using dbsv to call CV;
5788 * it's for informational purposes only.
5791 PERL_ARGS_ASSERT_GET_DB_SUB;
5795 if (!PERLDB_SUB_NN) {
5798 if (!svp && !CvLEXICAL(cv)) {
5799 gv_efullname3(dbsv, gv, NULL);
5801 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5802 || strEQ(GvNAME(gv), "END")
5803 || ( /* Could be imported, and old sub redefined. */
5804 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5806 !( (SvTYPE(*svp) == SVt_PVGV)
5807 && (GvCV((const GV *)*svp) == cv)
5808 /* Use GV from the stack as a fallback. */
5809 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5813 /* GV is potentially non-unique, or contain different CV. */
5814 SV * const tmp = newRV(MUTABLE_SV(cv));
5815 sv_setsv(dbsv, tmp);
5819 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5820 sv_catpvs(dbsv, "::");
5821 sv_cathek(dbsv, GvNAME_HEK(gv));
5825 const int type = SvTYPE(dbsv);
5826 if (type < SVt_PVIV && type != SVt_IV)
5827 sv_upgrade(dbsv, SVt_PVIV);
5828 (void)SvIOK_on(dbsv);
5829 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5832 TAINT_IF(save_taint);
5833 #ifdef NO_TAINT_SUPPORT
5834 PERL_UNUSED_VAR(save_taint);
5839 Perl_my_dirfd(DIR * dir) {
5841 /* Most dirfd implementations have problems when passed NULL. */
5846 #elif defined(HAS_DIR_DD_FD)
5849 Perl_croak_nocontext(PL_no_func, "dirfd");
5850 NOT_REACHED; /* NOTREACHED */
5855 #if !defined(HAS_MKOSTEMP) || !defined(HAS_MKSTEMP)
5857 #define TEMP_FILE_CH "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvxyz0123456789"
5858 #define TEMP_FILE_CH_COUNT (sizeof(TEMP_FILE_CH)-1)
5861 S_my_mkostemp(char *templte, int flags) {
5863 STRLEN len = strlen(templte);
5867 int delete_on_close = flags & O_VMS_DELETEONCLOSE;
5869 flags &= ~O_VMS_DELETEONCLOSE;
5873 templte[len-1] != 'X' || templte[len-2] != 'X' || templte[len-3] != 'X' ||
5874 templte[len-4] != 'X' || templte[len-5] != 'X' || templte[len-6] != 'X') {
5875 SETERRNO(EINVAL, LIB_INVARG);
5881 for (i = 1; i <= 6; ++i) {
5882 templte[len-i] = TEMP_FILE_CH[(int)(Perl_internal_drand48() * TEMP_FILE_CH_COUNT)];
5885 if (delete_on_close) {
5886 fd = open(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600, "fop=dlt");
5891 fd = PerlLIO_open3(templte, O_RDWR | O_CREAT | O_EXCL | flags, 0600);
5893 } while (fd == -1 && errno == EEXIST && ++attempts <= 100);
5900 #ifndef HAS_MKOSTEMP
5902 Perl_my_mkostemp(char *templte, int flags)
5904 PERL_ARGS_ASSERT_MY_MKOSTEMP;
5905 return S_my_mkostemp(templte, flags);
5911 Perl_my_mkstemp(char *templte)
5913 PERL_ARGS_ASSERT_MY_MKSTEMP;
5914 return S_my_mkostemp(templte, 0);
5919 Perl_get_re_arg(pTHX_ SV *sv) {
5925 sv = MUTABLE_SV(SvRV(sv));
5926 if (SvTYPE(sv) == SVt_REGEXP)
5927 return (REGEXP*) sv;
5934 * This code is derived from drand48() implementation from FreeBSD,
5935 * found in lib/libc/gen/_rand48.c.
5937 * The U64 implementation is original, based on the POSIX
5938 * specification for drand48().
5942 * Copyright (c) 1993 Martin Birgmeier
5943 * All rights reserved.
5945 * You may redistribute unmodified or modified versions of this source
5946 * code provided that the above copyright notice and this and the
5947 * following conditions are retained.
5949 * This software is provided ``as is'', and comes with no warranties
5950 * of any kind. I shall in no event be liable for anything that happens
5951 * to anyone/anything when using this software.
5954 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5956 #ifdef PERL_DRAND48_QUAD
5958 #define DRAND48_MULT UINT64_C(0x5deece66d)
5959 #define DRAND48_ADD 0xb
5960 #define DRAND48_MASK UINT64_C(0xffffffffffff)
5964 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5965 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5966 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5967 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5968 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5969 #define FREEBSD_DRAND48_ADD (0x000b)
5971 const unsigned short _rand48_mult[3] = {
5972 FREEBSD_DRAND48_MULT_0,
5973 FREEBSD_DRAND48_MULT_1,
5974 FREEBSD_DRAND48_MULT_2
5976 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5981 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5983 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5985 #ifdef PERL_DRAND48_QUAD
5986 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5988 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5989 random_state->seed[1] = (U16) seed;
5990 random_state->seed[2] = (U16) (seed >> 16);
5995 Perl_drand48_r(perl_drand48_t *random_state)
5997 PERL_ARGS_ASSERT_DRAND48_R;
5999 #ifdef PERL_DRAND48_QUAD
6000 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
6003 return ldexp((double)*random_state, -48);
6009 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
6010 + (U32) _rand48_add;
6011 temp[0] = (U16) accu; /* lower 16 bits */
6012 accu >>= sizeof(U16) * 8;
6013 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
6014 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
6015 temp[1] = (U16) accu; /* middle 16 bits */
6016 accu >>= sizeof(U16) * 8;
6017 accu += _rand48_mult[0] * random_state->seed[2]
6018 + _rand48_mult[1] * random_state->seed[1]
6019 + _rand48_mult[2] * random_state->seed[0];
6020 random_state->seed[0] = temp[0];
6021 random_state->seed[1] = temp[1];
6022 random_state->seed[2] = (U16) accu;
6024 return ldexp((double) random_state->seed[0], -48) +
6025 ldexp((double) random_state->seed[1], -32) +
6026 ldexp((double) random_state->seed[2], -16);
6031 #ifdef USE_C_BACKTRACE
6033 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
6038 /* abfd is the BFD handle. */
6040 /* bfd_syms is the BFD symbol table. */
6042 /* bfd_text is handle to the the ".text" section of the object file. */
6044 /* Since opening the executable and scanning its symbols is quite
6045 * heavy operation, we remember the filename we used the last time,
6046 * and do the opening and scanning only if the filename changes.
6047 * This removes most (but not all) open+scan cycles. */
6048 const char* fname_prev;
6051 /* Given a dl_info, update the BFD context if necessary. */
6052 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
6054 /* BFD open and scan only if the filename changed. */
6055 if (ctx->fname_prev == NULL ||
6056 strNE(dl_info->dli_fname, ctx->fname_prev)) {
6058 bfd_close(ctx->abfd);
6060 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
6062 if (bfd_check_format(ctx->abfd, bfd_object)) {
6063 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
6064 if (symbol_size > 0) {
6065 Safefree(ctx->bfd_syms);
6066 Newx(ctx->bfd_syms, symbol_size, asymbol*);
6068 bfd_get_section_by_name(ctx->abfd, ".text");
6076 ctx->fname_prev = dl_info->dli_fname;
6080 /* Given a raw frame, try to symbolize it and store
6081 * symbol information (source file, line number) away. */
6082 static void bfd_symbolize(bfd_context* ctx,
6085 STRLEN* symbol_name_size,
6087 STRLEN* source_name_size,
6088 STRLEN* source_line)
6090 *symbol_name = NULL;
6091 *symbol_name_size = 0;
6093 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
6095 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
6098 unsigned int line = 0;
6099 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
6100 ctx->bfd_syms, offset,
6101 &file, &func, &line) &&
6102 file && func && line > 0) {
6103 /* Size and copy the source file, use only
6104 * the basename of the source file.
6106 * NOTE: the basenames are fine for the
6107 * Perl source files, but may not always
6108 * be the best idea for XS files. */
6109 const char *p, *b = NULL;
6110 /* Look for the last slash. */
6111 for (p = file; *p; p++) {
6115 if (b == NULL || *b == 0) {
6118 *source_name_size = p - b + 1;
6119 Newx(*source_name, *source_name_size + 1, char);
6120 Copy(b, *source_name, *source_name_size + 1, char);
6122 *symbol_name_size = strlen(func);
6123 Newx(*symbol_name, *symbol_name_size + 1, char);
6124 Copy(func, *symbol_name, *symbol_name_size + 1, char);
6126 *source_line = line;
6132 #endif /* #ifdef USE_BFD */
6136 /* OS X has no public API for for 'symbolicating' (Apple official term)
6137 * stack addresses to {function_name, source_file, line_number}.
6138 * Good news: there is command line utility atos(1) which does that.
6139 * Bad news 1: it's a command line utility.
6140 * Bad news 2: one needs to have the Developer Tools installed.
6141 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
6143 * To recap: we need to open a pipe for reading for a utility which
6144 * might not exist, or exists in different locations, and then parse
6145 * the output. And since this is all for a low-level API, we cannot
6146 * use high-level stuff. Thanks, Apple. */
6149 /* tool is set to the absolute pathname of the tool to use:
6152 /* format is set to a printf format string used for building
6153 * the external command to run. */
6155 /* unavail is set if e.g. xcrun cannot be found, or something
6156 * else happens that makes getting the backtrace dubious. Note,
6157 * however, that the context isn't persistent, the next call to
6158 * get_c_backtrace() will start from scratch. */
6160 /* fname is the current object file name. */
6162 /* object_base_addr is the base address of the shared object. */
6163 void* object_base_addr;
6166 /* Given |dl_info|, updates the context. If the context has been
6167 * marked unavailable, return immediately. If not but the tool has
6168 * not been set, set it to either "xcrun atos" or "atos" (also set the
6169 * format to use for creating commands for piping), or if neither is
6170 * unavailable (one needs the Developer Tools installed), mark the context
6171 * an unavailable. Finally, update the filename (object name),
6172 * and its base address. */
6174 static void atos_update(atos_context* ctx,
6179 if (ctx->tool == NULL) {
6180 const char* tools[] = {
6184 const char* formats[] = {
6185 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6186 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6190 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6191 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6192 ctx->tool = tools[i];
6193 ctx->format = formats[i];
6197 if (ctx->tool == NULL) {
6198 ctx->unavail = TRUE;
6202 if (ctx->fname == NULL ||
6203 strNE(dl_info->dli_fname, ctx->fname)) {
6204 ctx->fname = dl_info->dli_fname;
6205 ctx->object_base_addr = dl_info->dli_fbase;
6209 /* Given an output buffer end |p| and its |start|, matches
6210 * for the atos output, extracting the source code location
6211 * and returning non-NULL if possible, returning NULL otherwise. */
6212 static const char* atos_parse(const char* p,
6214 STRLEN* source_name_size,
6215 STRLEN* source_line) {
6216 /* atos() output is something like:
6217 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6218 * We cannot use Perl regular expressions, because we need to
6219 * stay low-level. Therefore here we have a rolled-out version
6220 * of a state machine which matches _backwards_from_the_end_ and
6221 * if there's a success, returns the starts of the filename,
6222 * also setting the filename size and the source line number.
6223 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6224 const char* source_number_start;
6225 const char* source_name_end;
6226 const char* source_line_end = start;
6227 const char* close_paren;
6230 /* Skip trailing whitespace. */
6231 while (p > start && isSPACE(*p)) p--;
6232 /* Now we should be at the close paren. */
6233 if (p == start || *p != ')')
6237 /* Now we should be in the line number. */
6238 if (p == start || !isDIGIT(*p))
6240 /* Skip over the digits. */
6241 while (p > start && isDIGIT(*p))
6243 /* Now we should be at the colon. */
6244 if (p == start || *p != ':')
6246 source_number_start = p + 1;
6247 source_name_end = p; /* Just beyond the end. */
6249 /* Look for the open paren. */
6250 while (p > start && *p != '(')
6255 *source_name_size = source_name_end - p;
6256 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6257 && source_line_end == close_paren
6258 && uv <= PERL_INT_MAX
6260 *source_line = (STRLEN)uv;
6266 /* Given a raw frame, read a pipe from the symbolicator (that's the
6267 * technical term) atos, reads the result, and parses the source code
6268 * location. We must stay low-level, so we use snprintf(), pipe(),
6269 * and fread(), and then also parse the output ourselves. */
6270 static void atos_symbolize(atos_context* ctx,
6273 STRLEN* source_name_size,
6274 STRLEN* source_line)
6282 /* Simple security measure: if there's any funny business with
6283 * the object name (used as "-o '%s'" ), leave since at least
6284 * partially the user controls it. */
6285 for (p = ctx->fname; *p; p++) {
6286 if (*p == '\'' || isCNTRL(*p)) {
6287 ctx->unavail = TRUE;
6291 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6292 ctx->fname, ctx->object_base_addr, raw_frame);
6293 if (cnt < sizeof(cmd)) {
6294 /* Undo nostdio.h #defines that disable stdio.
6295 * This is somewhat naughty, but is used elsewhere
6296 * in the core, and affects only OS X. */
6301 FILE* fp = popen(cmd, "r");
6302 /* At the moment we open a new pipe for each stack frame.
6303 * This is naturally somewhat slow, but hopefully generating
6304 * stack traces is never going to in a performance critical path.
6306 * We could play tricks with atos by batching the stack
6307 * addresses to be resolved: atos can either take multiple
6308 * addresses from the command line, or read addresses from
6309 * a file (though the mess of creating temporary files would
6310 * probably negate much of any possible speedup).
6312 * Normally there are only two objects present in the backtrace:
6313 * perl itself, and the libdyld.dylib. (Note that the object
6314 * filenames contain the full pathname, so perl may not always
6315 * be in the same place.) Whenever the object in the
6316 * backtrace changes, the base address also changes.
6318 * The problem with batching the addresses, though, would be
6319 * matching the results with the addresses: the parsing of
6320 * the results is already painful enough with a single address. */
6323 UV cnt = fread(out, 1, sizeof(out), fp);
6324 if (cnt < sizeof(out)) {
6325 const char* p = atos_parse(out + cnt - 1, out,
6330 *source_name_size, char);
6331 Copy(p, *source_name,
6332 *source_name_size, char);
6340 #endif /* #ifdef PERL_DARWIN */
6343 =for apidoc_section $debugging
6344 =for apidoc get_c_backtrace
6346 Collects the backtrace (aka "stacktrace") into a single linear
6347 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6349 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6350 returning at most C<depth> frames.
6356 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6358 /* Note that here we must stay as low-level as possible: Newx(),
6359 * Copy(), Safefree(); since we may be called from anywhere,
6360 * so we should avoid higher level constructs like SVs or AVs.
6362 * Since we are using safesysmalloc() via Newx(), don't try
6363 * getting backtrace() there, unless you like deep recursion. */
6365 /* Currently only implemented with backtrace() and dladdr(),
6366 * for other platforms NULL is returned. */
6368 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6369 /* backtrace() is available via <execinfo.h> in glibc and in most
6370 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6372 /* We try fetching this many frames total, but then discard
6373 * the |skip| first ones. For the remaining ones we will try
6374 * retrieving more information with dladdr(). */
6375 int try_depth = skip + depth;
6377 /* The addresses (program counters) returned by backtrace(). */
6380 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6383 /* Sizes _including_ the terminating \0 of the object name
6384 * and symbol name strings. */
6385 STRLEN* object_name_sizes;
6386 STRLEN* symbol_name_sizes;
6389 /* The symbol names comes either from dli_sname,
6390 * or if using BFD, they can come from BFD. */
6391 char** symbol_names;
6394 /* The source code location information. Dug out with e.g. BFD. */
6395 char** source_names;
6396 STRLEN* source_name_sizes;
6397 STRLEN* source_lines;
6399 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6400 int got_depth; /* How many frames were returned from backtrace(). */
6401 UV frame_count = 0; /* How many frames we return. */
6402 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6405 bfd_context bfd_ctx;
6408 atos_context atos_ctx;
6411 /* Here are probably possibilities for optimizing. We could for
6412 * example have a struct that contains most of these and then
6413 * allocate |try_depth| of them, saving a bunch of malloc calls.
6414 * Note, however, that |frames| could not be part of that struct
6415 * because backtrace() will want an array of just them. Also be
6416 * careful about the name strings. */
6417 Newx(raw_frames, try_depth, void*);
6418 Newx(dl_infos, try_depth, Dl_info);
6419 Newx(object_name_sizes, try_depth, STRLEN);
6420 Newx(symbol_name_sizes, try_depth, STRLEN);
6421 Newx(source_names, try_depth, char*);
6422 Newx(source_name_sizes, try_depth, STRLEN);
6423 Newx(source_lines, try_depth, STRLEN);
6425 Newx(symbol_names, try_depth, char*);
6428 /* Get the raw frames. */
6429 got_depth = (int)backtrace(raw_frames, try_depth);
6431 /* We use dladdr() instead of backtrace_symbols() because we want
6432 * the full details instead of opaque strings. This is useful for
6433 * two reasons: () the details are needed for further symbolic
6434 * digging, for example in OS X (2) by having the details we fully
6435 * control the output, which in turn is useful when more platforms
6436 * are added: we can keep out output "portable". */
6438 /* We want a single linear allocation, which can then be freed
6439 * with a single swoop. We will do the usual trick of first
6440 * walking over the structure and seeing how much we need to
6441 * allocate, then allocating, and then walking over the structure
6442 * the second time and populating it. */
6444 /* First we must compute the total size of the buffer. */
6445 total_bytes = sizeof(Perl_c_backtrace_header);
6446 if (got_depth > skip) {
6449 bfd_init(); /* Is this safe to call multiple times? */
6450 Zero(&bfd_ctx, 1, bfd_context);
6453 Zero(&atos_ctx, 1, atos_context);
6455 for (i = skip; i < try_depth; i++) {
6456 Dl_info* dl_info = &dl_infos[i];
6458 object_name_sizes[i] = 0;
6459 source_names[i] = NULL;
6460 source_name_sizes[i] = 0;
6461 source_lines[i] = 0;
6463 /* Yes, zero from dladdr() is failure. */
6464 if (dladdr(raw_frames[i], dl_info)) {
6465 total_bytes += sizeof(Perl_c_backtrace_frame);
6467 object_name_sizes[i] =
6468 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6469 symbol_name_sizes[i] =
6470 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6472 bfd_update(&bfd_ctx, dl_info);
6473 bfd_symbolize(&bfd_ctx, raw_frames[i],
6475 &symbol_name_sizes[i],
6477 &source_name_sizes[i],
6481 atos_update(&atos_ctx, dl_info);
6482 atos_symbolize(&atos_ctx,
6485 &source_name_sizes[i],
6489 /* Plus ones for the terminating \0. */
6490 total_bytes += object_name_sizes[i] + 1;
6491 total_bytes += symbol_name_sizes[i] + 1;
6492 total_bytes += source_name_sizes[i] + 1;
6500 Safefree(bfd_ctx.bfd_syms);
6504 /* Now we can allocate and populate the result buffer. */
6505 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6506 Zero(bt, total_bytes, char);
6507 bt->header.frame_count = frame_count;
6508 bt->header.total_bytes = total_bytes;
6509 if (frame_count > 0) {
6510 Perl_c_backtrace_frame* frame = bt->frame_info;
6511 char* name_base = (char *)(frame + frame_count);
6512 char* name_curr = name_base; /* Outputting the name strings here. */
6514 for (i = skip; i < skip + frame_count; i++) {
6515 Dl_info* dl_info = &dl_infos[i];
6517 frame->addr = raw_frames[i];
6518 frame->object_base_addr = dl_info->dli_fbase;
6519 frame->symbol_addr = dl_info->dli_saddr;
6521 /* Copies a string, including the \0, and advances the name_curr.
6522 * Also copies the start and the size to the frame. */
6523 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6525 Copy(src, name_curr, size, char); \
6526 frame->doffset = name_curr - (char*)bt; \
6527 frame->dsize = size; \
6528 name_curr += size; \
6531 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6533 object_name_size, object_name_sizes[i]);
6536 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6538 symbol_name_size, symbol_name_sizes[i]);
6539 Safefree(symbol_names[i]);
6541 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6543 symbol_name_size, symbol_name_sizes[i]);
6546 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6548 source_name_size, source_name_sizes[i]);
6549 Safefree(source_names[i]);
6551 #undef PERL_C_BACKTRACE_STRCPY
6553 frame->source_line_number = source_lines[i];
6557 assert(total_bytes ==
6558 (UV)(sizeof(Perl_c_backtrace_header) +
6559 frame_count * sizeof(Perl_c_backtrace_frame) +
6560 name_curr - name_base));
6563 Safefree(symbol_names);
6565 bfd_close(bfd_ctx.abfd);
6568 Safefree(source_lines);
6569 Safefree(source_name_sizes);
6570 Safefree(source_names);
6571 Safefree(symbol_name_sizes);
6572 Safefree(object_name_sizes);
6573 /* Assuming the strings returned by dladdr() are pointers
6574 * to read-only static memory (the object file), so that
6575 * they do not need freeing (and cannot be). */
6577 Safefree(raw_frames);
6580 PERL_UNUSED_ARG(depth);
6581 PERL_UNUSED_ARG(skip);
6587 =for apidoc free_c_backtrace
6589 Deallocates a backtrace received from get_c_backtrace.
6595 =for apidoc get_c_backtrace_dump
6597 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6598 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6600 The appended output looks like:
6603 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6604 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6607 The fields are tab-separated. The first column is the depth (zero
6608 being the innermost non-skipped frame). In the hex:offset, the hex is
6609 where the program counter was in C<S_parse_body>, and the :offset (might
6610 be missing) tells how much inside the C<S_parse_body> the program counter was.
6612 The C<util.c:1716> is the source code file and line number.
6614 The F</usr/bin/perl> is obvious (hopefully).
6616 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6617 if the platform doesn't support retrieving the information;
6618 if the binary is missing the debug information;
6619 if the optimizer has transformed the code by for example inlining.
6625 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6627 Perl_c_backtrace* bt;
6629 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6631 Perl_c_backtrace_frame* frame;
6632 SV* dsv = newSVpvs("");
6634 for (i = 0, frame = bt->frame_info;
6635 i < bt->header.frame_count; i++, frame++) {
6636 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6637 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6638 /* Symbol (function) names might disappear without debug info.
6640 * The source code location might disappear in case of the
6641 * optimizer inlining or otherwise rearranging the code. */
6642 if (frame->symbol_addr) {
6643 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6645 ((char*)frame->addr - (char*)frame->symbol_addr));
6647 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6648 frame->symbol_name_size &&
6649 frame->symbol_name_offset ?
6650 (char*)bt + frame->symbol_name_offset : "-");
6651 if (frame->source_name_size &&
6652 frame->source_name_offset &&
6653 frame->source_line_number) {
6654 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6655 (char*)bt + frame->source_name_offset,
6656 (UV)frame->source_line_number);
6658 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6660 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6661 frame->object_name_size &&
6662 frame->object_name_offset ?
6663 (char*)bt + frame->object_name_offset : "-");
6664 /* The frame->object_base_addr is not output,
6665 * but it is used for symbolizing/symbolicating. */
6666 sv_catpvs(dsv, "\n");
6669 Perl_free_c_backtrace(bt);
6678 =for apidoc dump_c_backtrace
6680 Dumps the C backtrace to the given C<fp>.
6682 Returns true if a backtrace could be retrieved, false if not.
6688 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6692 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6694 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6697 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6703 #endif /* #ifdef USE_C_BACKTRACE */
6705 #if defined(USE_ITHREADS) && defined(I_PTHREAD)
6707 /* pthread_mutex_t and perl_mutex are typedef equivalent
6708 * so casting the pointers is fine. */
6710 int perl_tsa_mutex_lock(perl_mutex* mutex)
6712 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6715 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6717 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6720 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6722 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6729 /* log a sub call or return */
6732 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6740 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6743 HEK *hek = CvNAME_HEK(cv);
6744 func = HEK_KEY(hek);
6750 start = (const COP *)CvSTART(cv);
6751 file = CopFILE(start);
6752 line = CopLINE(start);
6753 stash = CopSTASHPV(start);
6756 PERL_SUB_ENTRY(func, file, line, stash);
6759 PERL_SUB_RETURN(func, file, line, stash);
6764 /* log a require file loading/loaded */
6767 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6769 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6772 PERL_LOADING_FILE(name);
6775 PERL_LOADED_FILE(name);
6780 /* log an op execution */
6783 Perl_dtrace_probe_op(pTHX_ const OP *op)
6785 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6787 PERL_OP_ENTRY(OP_NAME(op));
6791 /* log a compile/run phase change */
6794 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6796 const char *ph_old = PL_phase_names[PL_phase];
6797 const char *ph_new = PL_phase_names[phase];
6799 PERL_PHASE_CHANGE(ph_new, ph_old);
6805 * ex: set ts=8 sts=4 sw=4 et: